Rev 1040 | Rev 1060 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 1040 | Rev 1050 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (C) 2006 Ondrej Palkovsky |
2 | * Copyright (C) 2006 Ondrej Palkovsky |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | #ifndef __IPC_H__ |
29 | #ifndef __IPC_H__ |
30 | #define __IPC_H__ |
30 | #define __IPC_H__ |
31 | 31 | ||
32 | /* Length of data being transfered with IPC call */ |
32 | /* Length of data being transfered with IPC call */ |
33 | /* - the uspace may not be able to utilize full length */ |
33 | /* - the uspace may not be able to utilize full length */ |
34 | #define IPC_CALL_LEN 4 |
34 | #define IPC_CALL_LEN 4 |
35 | 35 | ||
36 | /** Maximum active async calls per thread */ |
36 | /** Maximum active async calls per thread */ |
37 | #define IPC_MAX_ASYNC_CALLS 4 |
37 | #define IPC_MAX_ASYNC_CALLS 4 |
38 | 38 | ||
39 | /* Flags for calls */ |
39 | /* Flags for calls */ |
40 | #define IPC_CALL_ANSWERED 1 /**< This is answer to a call */ |
40 | #define IPC_CALL_ANSWERED 0x1 /**< This is answer to a call */ |
41 | #define IPC_CALL_STATIC_ALLOC 2 /**< This call will not be freed on error */ |
41 | #define IPC_CALL_STATIC_ALLOC 0x2 /**< This call will not be freed on error */ |
- | 42 | #define IPC_CALL_DISPATCHED 0x4 /**< Call is in dispatch queue */ |
|
42 | 43 | ||
43 | /* Flags for ipc_wait_for_call */ |
44 | /* Flags for ipc_wait_for_call */ |
44 | #define IPC_WAIT_NONBLOCKING 1 |
45 | #define IPC_WAIT_NONBLOCKING 1 |
45 | 46 | ||
46 | /* Flags of callid */ |
47 | /* Flags of callid */ |
47 | #define IPC_CALLID_ANSWERED 1 |
48 | #define IPC_CALLID_ANSWERED 1 |
48 | 49 | ||
49 | /* Return values from IPC_ASYNC */ |
50 | /* Return values from IPC_ASYNC */ |
50 | #define IPC_CALLRET_FATAL -1 |
51 | #define IPC_CALLRET_FATAL -1 |
51 | #define IPC_CALLRET_TEMPORARY -2 |
52 | #define IPC_CALLRET_TEMPORARY -2 |
52 | 53 | ||
53 | 54 | ||
54 | /* Macros for manipulating calling data */ |
55 | /* Macros for manipulating calling data */ |
55 | #define IPC_SET_RETVAL(data, retval) ((data)[0] = (retval)) |
56 | #define IPC_SET_RETVAL(data, retval) ((data)[0] = (retval)) |
56 | #define IPC_SET_METHOD(data, val) ((data)[0] = (val)) |
57 | #define IPC_SET_METHOD(data, val) ((data)[0] = (val)) |
57 | #define IPC_SET_ARG1(data, val) ((data)[1] = (val)) |
58 | #define IPC_SET_ARG1(data, val) ((data)[1] = (val)) |
58 | #define IPC_SET_ARG2(data, val) ((data)[2] = (val)) |
59 | #define IPC_SET_ARG2(data, val) ((data)[2] = (val)) |
59 | #define IPC_SET_ARG3(data, val) ((data)[3] = (val)) |
60 | #define IPC_SET_ARG3(data, val) ((data)[3] = (val)) |
60 | 61 | ||
61 | #define IPC_GET_METHOD(data) ((data)[0]) |
62 | #define IPC_GET_METHOD(data) ((data)[0]) |
62 | #define IPC_GET_RETVAL(data) ((data)[0]) |
63 | #define IPC_GET_RETVAL(data) ((data)[0]) |
63 | 64 | ||
64 | #define IPC_GET_ARG1(data) ((data)[1]) |
65 | #define IPC_GET_ARG1(data) ((data)[1]) |
65 | #define IPC_GET_ARG2(data) ((data)[2]) |
66 | #define IPC_GET_ARG2(data) ((data)[2]) |
66 | #define IPC_GET_ARG3(data) ((data)[3]) |
67 | #define IPC_GET_ARG3(data) ((data)[3]) |
67 | 68 | ||
68 | /* Well known phone descriptors */ |
69 | /* Well known phone descriptors */ |
69 | #define PHONE_NS 0 |
70 | #define PHONE_NS 0 |
70 | 71 | ||
71 | /* System-specific methods - only through special syscalls |
72 | /* System-specific methods - only through special syscalls |
72 | * These methods have special behaviour |
73 | * These methods have special behaviour |
73 | */ |
74 | */ |
74 | /** Protocol for CONNECT - TO - ME |
75 | /** Protocol for CONNECT - TO - ME |
75 | * |
76 | * |
76 | * Calling process asks the callee to create a callback connection, |
77 | * Calling process asks the callee to create a callback connection, |
77 | * so that it can start initiating new messages. |
78 | * so that it can start initiating new messages. |
78 | * |
79 | * |
79 | * The protocol for negotiating is: |
80 | * The protocol for negotiating is: |
80 | * - sys_connecttome - sends a message IPC_M_CONNECTTOME |
81 | * - sys_connecttome - sends a message IPC_M_CONNECTTOME |
81 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
82 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
82 | * - if it fails, responds with ELIMIT |
83 | * - if it fails, responds with ELIMIT |
83 | * - passes call to userspace. If userspace |
84 | * - passes call to userspace. If userspace |
84 | * responds with error, phone is deallocated and |
85 | * responds with error, phone is deallocated and |
85 | * error is sent back to caller. Otherwise |
86 | * error is sent back to caller. Otherwise |
86 | * the call is accepted and the response is sent back. |
87 | * the call is accepted and the response is sent back. |
87 | * - the allocated phoneid is passed to userspace |
88 | * - the allocated phoneid is passed to userspace |
88 | * (on the receiving sid) as ARG3 of the call. |
89 | * (on the receiving sid) as ARG3 of the call. |
89 | * - the caller obtains taskid of the called thread |
90 | * - the caller obtains taskid of the called thread |
90 | */ |
91 | */ |
91 | #define IPC_M_CONNECTTOME 1 |
92 | #define IPC_M_CONNECTTOME 1 |
92 | /** Protocol for CONNECT - ME - TO |
93 | /** Protocol for CONNECT - ME - TO |
93 | * |
94 | * |
94 | * Calling process asks the callee to create for him a new connection. |
95 | * Calling process asks the callee to create for him a new connection. |
95 | * E.g. the caller wants a name server to connect him to print server. |
96 | * E.g. the caller wants a name server to connect him to print server. |
96 | * |
97 | * |
97 | * The protocol for negotiating is: |
98 | * The protocol for negotiating is: |
98 | * - sys_connect_me_to - send a synchronous message to name server |
99 | * - sys_connect_me_to - send a synchronous message to name server |
99 | * indicating that it wants to be connected to some |
100 | * indicating that it wants to be connected to some |
100 | * service |
101 | * service |
101 | * recepient - if ipc_answer == 0, then accept connection |
102 | * recepient - if ipc_answer == 0, then accept connection |
102 | * - otherwise connection refused |
103 | * - otherwise connection refused |
103 | * - recepient may forward message. Forwarding |
104 | * - recepient may forward message. Forwarding |
104 | * system message |
105 | * system message |
105 | * |
106 | * |
106 | */ |
107 | */ |
107 | #define IPC_M_CONNECTMETO 2 |
108 | #define IPC_M_CONNECTMETO 2 |
108 | /* Control messages that the server sends to the processes |
109 | /* Control messages that the server sends to the processes |
109 | * about their connections. |
110 | * about their connections. |
110 | */ |
111 | */ |
111 | 112 | ||
112 | 113 | ||
113 | /* Well-known methods */ |
114 | /* Well-known methods */ |
114 | #define IPC_M_LAST_SYSTEM 511 |
115 | #define IPC_M_LAST_SYSTEM 511 |
115 | #define IPC_M_PING 512 |
116 | #define IPC_M_PING 512 |
116 | /* User methods */ |
117 | /* User methods */ |
117 | #define FIRST_USER_METHOD 1024 |
118 | #define FIRST_USER_METHOD 1024 |
118 | 119 | ||
119 | #ifdef KERNEL |
120 | #ifdef KERNEL |
120 | 121 | ||
121 | #include <synch/mutex.h> |
122 | #include <synch/mutex.h> |
122 | #include <synch/condvar.h> |
123 | #include <synch/condvar.h> |
123 | #include <adt/list.h> |
124 | #include <adt/list.h> |
124 | 125 | ||
125 | #define IPC_MAX_PHONES 16 |
126 | #define IPC_MAX_PHONES 16 |
126 | 127 | ||
127 | typedef struct answerbox answerbox_t; |
128 | typedef struct answerbox answerbox_t; |
128 | typedef __native ipc_data_t[IPC_CALL_LEN]; |
129 | typedef __native ipc_data_t[IPC_CALL_LEN]; |
129 | 130 | ||
130 | typedef struct { |
131 | typedef struct { |
131 | link_t list; |
132 | link_t list; |
132 | answerbox_t *callerbox; |
133 | answerbox_t *callerbox; |
133 | int flags; |
134 | int flags; |
134 | task_t *sender; |
135 | task_t *sender; |
135 | ipc_data_t data; |
136 | ipc_data_t data; |
136 | } call_t; |
137 | } call_t; |
137 | 138 | ||
138 | struct answerbox { |
139 | struct answerbox { |
139 | SPINLOCK_DECLARE(lock); |
140 | SPINLOCK_DECLARE(lock); |
140 | 141 | ||
141 | task_t *task; |
142 | task_t *task; |
142 | 143 | ||
143 | waitq_t wq; |
144 | waitq_t wq; |
144 | 145 | ||
145 | link_t connected_phones; /**< Phones connected to this answerbox */ |
146 | link_t connected_phones; /**< Phones connected to this answerbox */ |
146 | link_t calls; /**< Received calls */ |
147 | link_t calls; /**< Received calls */ |
147 | link_t dispatched_calls; /* Should be hash table in the future */ |
148 | link_t dispatched_calls; /* Should be hash table in the future */ |
148 | 149 | ||
149 | link_t answers; /**< Answered calls */ |
150 | link_t answers; /**< Answered calls */ |
150 | }; |
151 | }; |
151 | 152 | ||
152 | typedef struct { |
153 | typedef struct { |
153 | SPINLOCK_DECLARE(lock); |
154 | SPINLOCK_DECLARE(lock); |
154 | link_t list; |
155 | link_t list; |
155 | answerbox_t *callee; |
156 | answerbox_t *callee; |
156 | int busy; |
157 | int busy; |
157 | } phone_t; |
158 | } phone_t; |
158 | 159 | ||
159 | extern void ipc_init(void); |
160 | extern void ipc_init(void); |
160 | extern call_t * ipc_wait_for_call(answerbox_t *box, int flags); |
161 | extern call_t * ipc_wait_for_call(answerbox_t *box, int flags); |
161 | extern void ipc_answer(answerbox_t *box, call_t *request); |
162 | extern void ipc_answer(answerbox_t *box, call_t *request); |
162 | extern void ipc_call(phone_t *phone, call_t *request); |
163 | extern void ipc_call(phone_t *phone, call_t *request); |
163 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
164 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
164 | extern void ipc_phone_destroy(phone_t *phone); |
165 | extern void ipc_phone_destroy(phone_t *phone); |
165 | extern void ipc_phone_init(phone_t *phone); |
166 | extern void ipc_phone_init(phone_t *phone); |
166 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
167 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
167 | extern void ipc_call_free(call_t *call); |
168 | extern void ipc_call_free(call_t *call); |
168 | extern call_t * ipc_call_alloc(void); |
169 | extern call_t * ipc_call_alloc(void); |
169 | extern void ipc_answerbox_init(answerbox_t *box); |
170 | extern void ipc_answerbox_init(answerbox_t *box); |
170 | extern void ipc_call_init(call_t *call); |
171 | extern void ipc_call_init(call_t *call); |
171 | extern void ipc_forward(call_t *call, answerbox_t *newbox,answerbox_t *oldbox); |
172 | extern void ipc_forward(call_t *call, answerbox_t *newbox,answerbox_t *oldbox); |
172 | 173 | ||
173 | extern answerbox_t *ipc_phone_0; |
174 | extern answerbox_t *ipc_phone_0; |
174 | 175 | ||
175 | #endif |
176 | #endif |
176 | 177 | ||
177 | #endif |
178 | #endif |
178 | 179 |