Rev 1364 | Rev 1461 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 1364 | Rev 1428 | ||
---|---|---|---|
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<<0) /**< This is answer to a call */ |
40 | #define IPC_CALL_ANSWERED (1<<0) /**< This is answer to a call */ |
41 | #define IPC_CALL_STATIC_ALLOC (1<<1) /**< This call will not be freed on error */ |
41 | #define IPC_CALL_STATIC_ALLOC (1<<1) /**< This call will not be freed on error */ |
42 | #define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to |
42 | #define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to |
43 | * userspace, will be discarded */ |
43 | * userspace, will be discarded */ |
44 | #define IPC_CALL_FORWARDED (1<<3) /* Call was forwarded */ |
44 | #define IPC_CALL_FORWARDED (1<<3) /* Call was forwarded */ |
45 | #define IPC_CALL_CONN_ME_TO (1<<4) /* Identify connect_me_to */ |
45 | #define IPC_CALL_CONN_ME_TO (1<<4) /* Identify connect_me_to answer */ |
46 | #define IPC_CALL_NOTIF (1<<5) /* Interrupt notification */ |
46 | #define IPC_CALL_NOTIF (1<<5) /* Interrupt notification */ |
47 | 47 | ||
48 | /* Flags of callid (the addresses are aligned at least to 4, |
48 | /* Flags of callid (the addresses are aligned at least to 4, |
49 | * that is why we can use bottom 2 bits of the call address |
49 | * that is why we can use bottom 2 bits of the call address |
50 | */ |
50 | */ |
51 | #define IPC_CALLID_ANSWERED 1 /**< Type of this msg is 'answer' */ |
51 | #define IPC_CALLID_ANSWERED 1 /**< Type of this msg is 'answer' */ |
52 | #define IPC_CALLID_NOTIFICATION 2 /**< Type of this msg is 'notification' */ |
52 | #define IPC_CALLID_NOTIFICATION 2 /**< Type of this msg is 'notification' */ |
53 | 53 | ||
54 | /* Return values from IPC_ASYNC */ |
54 | /* Return values from IPC_ASYNC */ |
55 | #define IPC_CALLRET_FATAL -1 |
55 | #define IPC_CALLRET_FATAL -1 |
56 | #define IPC_CALLRET_TEMPORARY -2 |
56 | #define IPC_CALLRET_TEMPORARY -2 |
57 | 57 | ||
58 | 58 | ||
59 | /* Macros for manipulating calling data */ |
59 | /* Macros for manipulating calling data */ |
60 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
60 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
61 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
61 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
62 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
62 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
63 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
63 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
64 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
64 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
65 | 65 | ||
66 | #define IPC_GET_METHOD(data) ((data).args[0]) |
66 | #define IPC_GET_METHOD(data) ((data).args[0]) |
67 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
67 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
68 | 68 | ||
69 | #define IPC_GET_ARG1(data) ((data).args[1]) |
69 | #define IPC_GET_ARG1(data) ((data).args[1]) |
70 | #define IPC_GET_ARG2(data) ((data).args[2]) |
70 | #define IPC_GET_ARG2(data) ((data).args[2]) |
71 | #define IPC_GET_ARG3(data) ((data).args[3]) |
71 | #define IPC_GET_ARG3(data) ((data).args[3]) |
72 | 72 | ||
73 | /* Well known phone descriptors */ |
73 | /* Well known phone descriptors */ |
74 | #define PHONE_NS 0 |
74 | #define PHONE_NS 0 |
75 | 75 | ||
76 | /* System-specific methods - only through special syscalls |
76 | /* System-specific methods - only through special syscalls |
77 | * These methods have special behaviour |
77 | * These methods have special behaviour |
78 | */ |
78 | */ |
79 | /** Protocol for CONNECT - TO - ME |
79 | /** Protocol for CONNECT - TO - ME |
80 | * |
80 | * |
81 | * Calling process asks the callee to create a callback connection, |
81 | * Calling process asks the callee to create a callback connection, |
82 | * so that it can start initiating new messages. |
82 | * so that it can start initiating new messages. |
83 | * |
83 | * |
84 | * The protocol for negotiating is: |
84 | * The protocol for negotiating is: |
85 | * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME |
85 | * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME |
86 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
86 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
87 | * - if it fails, responds with ELIMIT |
87 | * - if it fails, responds with ELIMIT |
88 | * - passes call to userspace. If userspace |
88 | * - passes call to userspace. If userspace |
89 | * responds with error, phone is deallocated and |
89 | * responds with error, phone is deallocated and |
90 | * error is sent back to caller. Otherwise |
90 | * error is sent back to caller. Otherwise |
91 | * the call is accepted and the response is sent back. |
91 | * the call is accepted and the response is sent back. |
92 | * - the allocated phoneid is passed to userspace |
92 | * - the allocated phoneid is passed to userspace |
93 | * (on the receiving sid) as ARG3 of the call. |
93 | * (on the receiving sid) as ARG3 of the call. |
94 | * - the caller obtains taskid of the called thread |
94 | * - the caller obtains taskid of the called thread |
95 | */ |
95 | */ |
96 | #define IPC_M_CONNECT_TO_ME 1 |
96 | #define IPC_M_CONNECT_TO_ME 1 |
97 | /** Protocol for CONNECT - ME - TO |
97 | /** Protocol for CONNECT - ME - TO |
98 | * |
98 | * |
99 | * Calling process asks the callee to create for him a new connection. |
99 | * Calling process asks the callee to create for him a new connection. |
100 | * E.g. the caller wants a name server to connect him to print server. |
100 | * E.g. the caller wants a name server to connect him to print server. |
101 | * |
101 | * |
102 | * The protocol for negotiating is: |
102 | * The protocol for negotiating is: |
103 | * - sys_connect_me_to - send a synchronous message to name server |
103 | * - sys_connect_me_to - send a synchronous message to name server |
104 | * indicating that it wants to be connected to some |
104 | * indicating that it wants to be connected to some |
105 | * service |
105 | * service |
106 | * - arg1/2 are user specified, arg3 contains |
106 | * - arg1/2 are user specified, arg3 contains |
107 | * address of the phone that should be connected |
107 | * address of the phone that should be connected |
108 | * (TODO: it leaks to userspace) |
108 | * (TODO: it leaks to userspace) |
109 | * recipient - if ipc_answer == 0, then accept connection |
109 | * recipient - if ipc_answer == 0, then accept connection |
110 | * - otherwise connection refused |
110 | * - otherwise connection refused |
111 | * - recepient may forward message. Forwarding |
111 | * - recepient may forward message. Forwarding |
112 | * system message |
112 | * system message |
113 | * |
113 | * |
114 | */ |
114 | */ |
115 | #define IPC_M_CONNECT_ME_TO 2 |
115 | #define IPC_M_CONNECT_ME_TO 2 |
116 | /** This message is sent to answerbox when the phone |
116 | /** This message is sent to answerbox when the phone |
117 | * is hung up |
117 | * is hung up |
118 | */ |
118 | */ |
119 | #define IPC_M_PHONE_HUNGUP 3 |
119 | #define IPC_M_PHONE_HUNGUP 3 |
120 | /** Interrupt notification */ |
120 | /** Interrupt notification */ |
121 | #define IPC_M_INTERRUPT 4 |
121 | #define IPC_M_INTERRUPT 4 |
- | 122 | ||
122 | /** Send as_area over IPC |
123 | /** Send as_area over IPC |
123 | * - ARG2 - src base address |
124 | * - ARG1 - src base address |
124 | * - ARG3 - size of src as(filled automatically by kernel) |
125 | * - ARG2 - size of src as(filled automatically by kernel) |
- | 126 | * - ARG3 - flags of the area being sent |
|
125 | * - on answer ARG1 - dst base adress |
127 | * - on answer ARG1 - dst base adress |
126 | */ |
128 | */ |
127 | #define IPC_M_AS_AREA_SEND 5 |
129 | #define IPC_M_AS_AREA_SEND 5 |
128 | 130 | ||
- | 131 | /** Get as_area over IPC |
|
- | 132 | * - ARG1 - Where the area will be mapped |
|
- | 133 | * - ARG2 - Expected size of area |
|
- | 134 | * - ARG3 - Requested rights for the area |
|
- | 135 | * on answer - the server sets ARG1 as src as address of the as_area |
|
- | 136 | * to be shared |
|
- | 137 | * |
|
- | 138 | * |
|
- | 139 | */ |
|
- | 140 | #define IPC_M_AS_AREA_RECV 6 |
|
- | 141 | ||
129 | 142 | ||
130 | /* Well-known methods */ |
143 | /* Well-known methods */ |
131 | #define IPC_M_LAST_SYSTEM 511 |
144 | #define IPC_M_LAST_SYSTEM 511 |
132 | #define IPC_M_PING 512 |
145 | #define IPC_M_PING 512 |
133 | /* User methods */ |
146 | /* User methods */ |
134 | #define FIRST_USER_METHOD 1024 |
147 | #define FIRST_USER_METHOD 1024 |
135 | 148 | ||
136 | #ifdef KERNEL |
149 | #ifdef KERNEL |
137 | 150 | ||
138 | #include <synch/mutex.h> |
151 | #include <synch/mutex.h> |
139 | #include <synch/condvar.h> |
152 | #include <synch/condvar.h> |
140 | #include <adt/list.h> |
153 | #include <adt/list.h> |
141 | 154 | ||
142 | #define IPC_MAX_PHONES 16 |
155 | #define IPC_MAX_PHONES 16 |
143 | 156 | ||
144 | typedef struct answerbox_s answerbox_t; |
157 | typedef struct answerbox_s answerbox_t; |
145 | typedef struct phone_s phone_t; |
158 | typedef struct phone_s phone_t; |
146 | typedef struct { |
159 | typedef struct { |
147 | __native args[IPC_CALL_LEN]; |
160 | __native args[IPC_CALL_LEN]; |
148 | phone_t *phone; |
161 | phone_t *phone; |
149 | }ipc_data_t; |
162 | }ipc_data_t; |
150 | 163 | ||
151 | struct answerbox_s { |
164 | struct answerbox_s { |
152 | SPINLOCK_DECLARE(lock); |
165 | SPINLOCK_DECLARE(lock); |
153 | 166 | ||
154 | task_t *task; |
167 | task_t *task; |
155 | 168 | ||
156 | waitq_t wq; |
169 | waitq_t wq; |
157 | 170 | ||
158 | link_t connected_phones; /**< Phones connected to this answerbox */ |
171 | link_t connected_phones; /**< Phones connected to this answerbox */ |
159 | link_t calls; /**< Received calls */ |
172 | link_t calls; /**< Received calls */ |
160 | link_t dispatched_calls; /* Should be hash table in the future */ |
173 | link_t dispatched_calls; /* Should be hash table in the future */ |
161 | 174 | ||
162 | link_t answers; /**< Answered calls */ |
175 | link_t answers; /**< Answered calls */ |
163 | 176 | ||
164 | SPINLOCK_DECLARE(irq_lock); |
177 | SPINLOCK_DECLARE(irq_lock); |
165 | link_t irq_notifs; /**< Notifications from IRQ handlers */ |
178 | link_t irq_notifs; /**< Notifications from IRQ handlers */ |
166 | }; |
179 | }; |
167 | 180 | ||
168 | typedef enum { |
181 | typedef enum { |
169 | IPC_BUSY_FREE = 0, |
182 | IPC_BUSY_FREE = 0, |
170 | IPC_BUSY_CONNECTING, |
183 | IPC_BUSY_CONNECTING, |
171 | IPC_BUSY_CONNECTED |
184 | IPC_BUSY_CONNECTED |
172 | } ipc_busy_t; |
185 | } ipc_busy_t; |
173 | 186 | ||
174 | struct phone_s { |
187 | struct phone_s { |
175 | SPINLOCK_DECLARE(lock); |
188 | SPINLOCK_DECLARE(lock); |
176 | link_t list; |
189 | link_t list; |
177 | answerbox_t *callee; |
190 | answerbox_t *callee; |
178 | ipc_busy_t busy; |
191 | ipc_busy_t busy; |
179 | atomic_t active_calls; |
192 | atomic_t active_calls; |
180 | }; |
193 | }; |
181 | 194 | ||
182 | typedef struct { |
195 | typedef struct { |
183 | link_t list; |
196 | link_t list; |
184 | 197 | ||
185 | int flags; |
198 | int flags; |
186 | 199 | ||
187 | /* Identification of the caller */ |
200 | /* Identification of the caller */ |
188 | task_t *sender; |
201 | task_t *sender; |
189 | /* The caller box is different from sender->answerbox |
202 | /* The caller box is different from sender->answerbox |
190 | * for synchronous calls |
203 | * for synchronous calls |
191 | */ |
204 | */ |
192 | answerbox_t *callerbox; |
205 | answerbox_t *callerbox; |
193 | 206 | ||
194 | __native private; /**< Private data to internal IPC */ |
207 | __native private; /**< Private data to internal IPC */ |
195 | 208 | ||
196 | ipc_data_t data; /**< Data passed from/to userspace */ |
209 | ipc_data_t data; /**< Data passed from/to userspace */ |
197 | }call_t; |
210 | }call_t; |
198 | 211 | ||
199 | extern void ipc_init(void); |
212 | extern void ipc_init(void); |
200 | extern call_t * ipc_wait_for_call(answerbox_t *box, __u32 usec, int nonblocking); |
213 | extern call_t * ipc_wait_for_call(answerbox_t *box, __u32 usec, int nonblocking); |
201 | extern void ipc_answer(answerbox_t *box, call_t *request); |
214 | extern void ipc_answer(answerbox_t *box, call_t *request); |
202 | extern int ipc_call(phone_t *phone, call_t *call); |
215 | extern int ipc_call(phone_t *phone, call_t *call); |
203 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
216 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
204 | extern void ipc_phone_init(phone_t *phone); |
217 | extern void ipc_phone_init(phone_t *phone); |
205 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
218 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
206 | extern void ipc_call_free(call_t *call); |
219 | extern void ipc_call_free(call_t *call); |
207 | extern call_t * ipc_call_alloc(int flags); |
220 | extern call_t * ipc_call_alloc(int flags); |
208 | extern void ipc_answerbox_init(answerbox_t *box); |
221 | extern void ipc_answerbox_init(answerbox_t *box); |
209 | extern void ipc_call_static_init(call_t *call); |
222 | extern void ipc_call_static_init(call_t *call); |
210 | extern void task_print_list(void); |
223 | extern void task_print_list(void); |
211 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox); |
224 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox); |
212 | extern void ipc_cleanup(task_t *task); |
225 | extern void ipc_cleanup(task_t *task); |
213 | extern int ipc_phone_hangup(phone_t *phone); |
226 | extern int ipc_phone_hangup(phone_t *phone); |
214 | extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err); |
227 | extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err); |
215 | 228 | ||
216 | extern answerbox_t *ipc_phone_0; |
229 | extern answerbox_t *ipc_phone_0; |
217 | 230 | ||
218 | #endif |
231 | #endif |
219 | 232 | ||
220 | #endif |
233 | #endif |
221 | 234 |