Rev 2550 | Rev 2622 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
955 | palkovsky | 1 | /* |
2071 | jermar | 2 | * Copyright (c) 2006 Ondrej Palkovsky |
955 | palkovsky | 3 | * All rights reserved. |
4 | * |
||
5 | * Redistribution and use in source and binary forms, with or without |
||
6 | * modification, are permitted provided that the following conditions |
||
7 | * are met: |
||
8 | * |
||
9 | * - Redistributions of source code must retain the above copyright |
||
10 | * notice, this list of conditions and the following disclaimer. |
||
11 | * - Redistributions in binary form must reproduce the above copyright |
||
12 | * notice, this list of conditions and the following disclaimer in the |
||
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 |
||
15 | * derived from this software without specific prior written permission. |
||
16 | * |
||
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 |
||
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
||
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
||
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||
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 |
||
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 |
||
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
27 | */ |
||
28 | |||
1888 | jermar | 29 | /** @addtogroup genericipc |
1702 | cejka | 30 | * @{ |
31 | */ |
||
32 | /** @file |
||
33 | */ |
||
34 | |||
1877 | jermar | 35 | #ifndef KERN_IPC_H_ |
36 | #define KERN_IPC_H_ |
||
955 | palkovsky | 37 | |
965 | palkovsky | 38 | /* Length of data being transfered with IPC call */ |
39 | /* - the uspace may not be able to utilize full length */ |
||
2614 | jermar | 40 | #define IPC_CALL_LEN 6 |
955 | palkovsky | 41 | |
998 | palkovsky | 42 | /** Maximum active async calls per thread */ |
1643 | palkovsky | 43 | #ifdef CONFIG_DEBUG |
2471 | jermar | 44 | #define IPC_MAX_ASYNC_CALLS 4 |
1643 | palkovsky | 45 | #else |
2471 | jermar | 46 | #define IPC_MAX_ASYNC_CALLS 4000 |
1643 | palkovsky | 47 | #endif |
998 | palkovsky | 48 | |
955 | palkovsky | 49 | /* Flags for calls */ |
965 | palkovsky | 50 | |
2106 | jermar | 51 | /** This is answer to a call */ |
52 | #define IPC_CALL_ANSWERED (1 << 0) |
||
53 | /** This call will not be freed on error */ |
||
54 | #define IPC_CALL_STATIC_ALLOC (1 << 1) |
||
55 | /** Answer will not be passed to userspace, will be discarded */ |
||
56 | #define IPC_CALL_DISCARD_ANSWER (1 << 2) |
||
57 | /** Call was forwarded */ |
||
58 | #define IPC_CALL_FORWARDED (1 << 3) |
||
59 | /** Identify connect_me_to answer */ |
||
60 | #define IPC_CALL_CONN_ME_TO (1 << 4) |
||
61 | /** Interrupt notification */ |
||
62 | #define IPC_CALL_NOTIF (1 << 5) |
||
63 | |||
2471 | jermar | 64 | /* |
65 | * Bits used in call hashes. |
||
66 | * The addresses are aligned at least to 4 that is why we can use the 2 least |
||
67 | * significant bits of the call address. |
||
1086 | palkovsky | 68 | */ |
2471 | jermar | 69 | /** Type of this call is 'answer' */ |
2106 | jermar | 70 | #define IPC_CALLID_ANSWERED 1 |
2471 | jermar | 71 | /** Type of this call is 'notification' */ |
2106 | jermar | 72 | #define IPC_CALLID_NOTIFICATION 2 |
965 | palkovsky | 73 | |
2471 | jermar | 74 | /* Return values from sys_ipc_call_async(). */ |
2106 | jermar | 75 | #define IPC_CALLRET_FATAL -1 |
76 | #define IPC_CALLRET_TEMPORARY -2 |
||
965 | palkovsky | 77 | |
78 | |||
79 | /* Macros for manipulating calling data */ |
||
2106 | jermar | 80 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
81 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
||
82 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
||
83 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
||
84 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
||
2614 | jermar | 85 | #define IPC_SET_ARG4(data, val) ((data).args[4] = (val)) |
86 | #define IPC_SET_ARG5(data, val) ((data).args[5] = (val)) |
||
965 | palkovsky | 87 | |
2106 | jermar | 88 | #define IPC_GET_METHOD(data) ((data).args[0]) |
89 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
||
965 | palkovsky | 90 | |
2106 | jermar | 91 | #define IPC_GET_ARG1(data) ((data).args[1]) |
92 | #define IPC_GET_ARG2(data) ((data).args[2]) |
||
93 | #define IPC_GET_ARG3(data) ((data).args[3]) |
||
2614 | jermar | 94 | #define IPC_GET_ARG4(data) ((data).args[4]) |
95 | #define IPC_GET_ARG5(data) ((data).args[5]) |
||
965 | palkovsky | 96 | |
97 | /* Well known phone descriptors */ |
||
2106 | jermar | 98 | #define PHONE_NS 0 |
965 | palkovsky | 99 | |
1027 | palkovsky | 100 | /* System-specific methods - only through special syscalls |
101 | * These methods have special behaviour |
||
102 | */ |
||
103 | /** Protocol for CONNECT - TO - ME |
||
104 | * |
||
105 | * Calling process asks the callee to create a callback connection, |
||
106 | * so that it can start initiating new messages. |
||
107 | * |
||
1040 | palkovsky | 108 | * The protocol for negotiating is: |
2527 | jermar | 109 | * - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME |
1027 | palkovsky | 110 | * - sys_wait_for_call - upon receipt tries to allocate new phone |
111 | * - if it fails, responds with ELIMIT |
||
112 | * - passes call to userspace. If userspace |
||
113 | * responds with error, phone is deallocated and |
||
114 | * error is sent back to caller. Otherwise |
||
115 | * the call is accepted and the response is sent back. |
||
1040 | palkovsky | 116 | * - the allocated phoneid is passed to userspace |
2527 | jermar | 117 | * (on the receiving side) as ARG3 of the call. |
1027 | palkovsky | 118 | * - the caller obtains taskid of the called thread |
119 | */ |
||
2471 | jermar | 120 | #define IPC_M_CONNECT_TO_ME 1 |
1040 | palkovsky | 121 | /** Protocol for CONNECT - ME - TO |
122 | * |
||
123 | * Calling process asks the callee to create for him a new connection. |
||
124 | * E.g. the caller wants a name server to connect him to print server. |
||
125 | * |
||
126 | * The protocol for negotiating is: |
||
127 | * - sys_connect_me_to - send a synchronous message to name server |
||
128 | * indicating that it wants to be connected to some |
||
129 | * service |
||
1060 | palkovsky | 130 | * - arg1/2 are user specified, arg3 contains |
131 | * address of the phone that should be connected |
||
132 | * (TODO: it leaks to userspace) |
||
1342 | jermar | 133 | * recipient - if ipc_answer == 0, then accept connection |
1040 | palkovsky | 134 | * - otherwise connection refused |
135 | * - recepient may forward message. Forwarding |
||
136 | * system message |
||
137 | * |
||
138 | */ |
||
2471 | jermar | 139 | #define IPC_M_CONNECT_ME_TO 2 |
1086 | palkovsky | 140 | /** This message is sent to answerbox when the phone |
141 | * is hung up |
||
1040 | palkovsky | 142 | */ |
2471 | jermar | 143 | #define IPC_M_PHONE_HUNGUP 3 |
1428 | palkovsky | 144 | |
2494 | jermar | 145 | /** Send as_area over IPC. |
146 | * - ARG1 - source as_area base address |
||
147 | * - ARG2 - size of source as_area (filled automatically by kernel) |
||
2025 | jermar | 148 | * - ARG3 - flags of the as_area being sent |
149 | * |
||
2494 | jermar | 150 | * on answer, the recipient must set: |
2025 | jermar | 151 | * - ARG1 - dst as_area base adress |
1329 | palkovsky | 152 | */ |
2493 | jermar | 153 | #define IPC_M_AS_AREA_SEND 4 |
1027 | palkovsky | 154 | |
2494 | jermar | 155 | /** Receive as_area over IPC. |
156 | * - ARG1 - destination as_area base address |
||
157 | * - ARG2 - destination as_area size |
||
2025 | jermar | 158 | * - ARG3 - user defined argument |
159 | * |
||
2494 | jermar | 160 | * on answer, the recipient must set: |
2025 | jermar | 161 | * |
2494 | jermar | 162 | * - ARG1 - source as_area base address |
2025 | jermar | 163 | * - ARG2 - flags that will be used for sharing |
1428 | palkovsky | 164 | */ |
2493 | jermar | 165 | #define IPC_M_AS_AREA_RECV 5 |
1027 | palkovsky | 166 | |
2494 | jermar | 167 | /** Send data to another address space over IPC. |
168 | * - ARG1 - destination address space virtual address, may be overriden by the |
||
169 | * recipient |
||
170 | * - ARG2 - source address space virtual address |
||
171 | * - ARG3 - size of data to be copied, may be overriden by the recipient |
||
172 | * |
||
173 | * on answer, the recipient must set: |
||
174 | * |
||
175 | * - ARG1 - final destination address space virtual address |
||
176 | * - ARG3 - final size of data to be copied |
||
177 | */ |
||
178 | #define IPC_M_DATA_SEND 6 |
||
1428 | palkovsky | 179 | |
1027 | palkovsky | 180 | /* Well-known methods */ |
2471 | jermar | 181 | #define IPC_M_LAST_SYSTEM 511 |
182 | #define IPC_M_PING 512 |
||
1027 | palkovsky | 183 | /* User methods */ |
2550 | cejka | 184 | #define IPC_FIRST_USER_METHOD 1024 |
1027 | palkovsky | 185 | |
955 | palkovsky | 186 | #ifdef KERNEL |
187 | |||
2105 | decky | 188 | #define IPC_MAX_PHONES 16 |
955 | palkovsky | 189 | |
2105 | decky | 190 | #include <synch/waitq.h> |
191 | |||
192 | struct answerbox; |
||
193 | struct task; |
||
194 | |||
195 | typedef enum { |
||
2106 | jermar | 196 | /** Phone is free and can be allocated */ |
197 | IPC_PHONE_FREE = 0, |
||
198 | /** Phone is connecting somewhere */ |
||
199 | IPC_PHONE_CONNECTING, |
||
200 | /** Phone is connected */ |
||
201 | IPC_PHONE_CONNECTED, |
||
202 | /** Phone is hung up, waiting for answers to come */ |
||
203 | IPC_PHONE_HUNGUP, |
||
204 | /** Phone was hungup from server */ |
||
205 | IPC_PHONE_SLAMMED |
||
2105 | decky | 206 | } ipc_phone_state_t; |
207 | |||
208 | /** Structure identifying phone (in TASK structure) */ |
||
955 | palkovsky | 209 | typedef struct { |
2105 | decky | 210 | SPINLOCK_DECLARE(lock); |
211 | link_t link; |
||
212 | struct answerbox *callee; |
||
213 | ipc_phone_state_t state; |
||
214 | atomic_t active_calls; |
||
215 | } phone_t; |
||
216 | |||
217 | typedef struct answerbox { |
||
218 | SPINLOCK_DECLARE(lock); |
||
219 | |||
220 | struct task *task; |
||
221 | |||
222 | waitq_t wq; |
||
223 | |||
2471 | jermar | 224 | /** Phones connected to this answerbox. */ |
2106 | jermar | 225 | link_t connected_phones; |
2471 | jermar | 226 | /** Received calls. */ |
2106 | jermar | 227 | link_t calls; |
2105 | decky | 228 | link_t dispatched_calls; /* Should be hash table in the future */ |
229 | |||
2471 | jermar | 230 | /** Answered calls. */ |
2106 | jermar | 231 | link_t answers; |
2105 | decky | 232 | |
233 | SPINLOCK_DECLARE(irq_lock); |
||
2471 | jermar | 234 | /** Notifications from IRQ handlers. */ |
2106 | jermar | 235 | link_t irq_notifs; |
236 | /** IRQs with notifications to this answerbox. */ |
||
237 | link_t irq_head; |
||
2105 | decky | 238 | } answerbox_t; |
239 | |||
240 | typedef struct { |
||
1780 | jermar | 241 | unative_t args[IPC_CALL_LEN]; |
1086 | palkovsky | 242 | phone_t *phone; |
1888 | jermar | 243 | } ipc_data_t; |
955 | palkovsky | 244 | |
1086 | palkovsky | 245 | typedef struct { |
1573 | palkovsky | 246 | link_t link; |
1086 | palkovsky | 247 | |
248 | int flags; |
||
249 | |||
2471 | jermar | 250 | /** Identification of the caller. */ |
2105 | decky | 251 | struct task *sender; |
2471 | jermar | 252 | /** The caller box is different from sender->answerbox for synchronous |
253 | * calls. */ |
||
1086 | palkovsky | 254 | answerbox_t *callerbox; |
255 | |||
2471 | jermar | 256 | /** Private data to internal IPC. */ |
2106 | jermar | 257 | unative_t priv; |
1090 | palkovsky | 258 | |
2471 | jermar | 259 | /** Data passed from/to userspace. */ |
2106 | jermar | 260 | ipc_data_t data; |
2494 | jermar | 261 | |
262 | /** Buffer for IPC_M_DATA_SEND. */ |
||
263 | uint8_t *buffer; |
||
1888 | jermar | 264 | } call_t; |
1086 | palkovsky | 265 | |
955 | palkovsky | 266 | extern void ipc_init(void); |
1780 | jermar | 267 | extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags); |
955 | palkovsky | 268 | extern void ipc_answer(answerbox_t *box, call_t *request); |
1088 | palkovsky | 269 | extern int ipc_call(phone_t *phone, call_t *call); |
959 | palkovsky | 270 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
1040 | palkovsky | 271 | extern void ipc_phone_init(phone_t *phone); |
272 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
||
955 | palkovsky | 273 | extern void ipc_call_free(call_t *call); |
1258 | palkovsky | 274 | extern call_t * ipc_call_alloc(int flags); |
965 | palkovsky | 275 | extern void ipc_answerbox_init(answerbox_t *box); |
1084 | palkovsky | 276 | extern void ipc_call_static_init(call_t *call); |
1060 | palkovsky | 277 | extern void task_print_list(void); |
1088 | palkovsky | 278 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox); |
2523 | jermar | 279 | extern void ipc_cleanup(void); |
280 | extern int ipc_phone_hangup(phone_t *phone); |
||
1780 | jermar | 281 | extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err); |
1573 | palkovsky | 282 | extern void ipc_print_task(task_id_t taskid); |
955 | palkovsky | 283 | |
1090 | palkovsky | 284 | extern answerbox_t *ipc_phone_0; |
285 | |||
955 | palkovsky | 286 | #endif |
287 | |||
288 | #endif |
||
1702 | cejka | 289 | |
1877 | jermar | 290 | /** @} |
1702 | cejka | 291 | */ |