Rev 2660 | Rev 2662 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1027 | palkovsky | 1 | /* |
2071 | jermar | 2 | * Copyright (c) 2006 Ondrej Palkovsky |
1027 | 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 | |||
1757 | jermar | 29 | /** @addtogroup genericipc |
1702 | cejka | 30 | * @{ |
31 | */ |
||
32 | /** @file |
||
33 | */ |
||
34 | |||
1027 | palkovsky | 35 | #include <arch.h> |
36 | #include <proc/task.h> |
||
1288 | jermar | 37 | #include <proc/thread.h> |
1027 | palkovsky | 38 | #include <errno.h> |
39 | #include <memstr.h> |
||
40 | #include <debug.h> |
||
41 | #include <ipc/ipc.h> |
||
42 | #include <ipc/sysipc.h> |
||
1281 | palkovsky | 43 | #include <ipc/irq.h> |
1072 | palkovsky | 44 | #include <ipc/ipcrsc.h> |
1258 | palkovsky | 45 | #include <arch/interrupt.h> |
1027 | palkovsky | 46 | #include <print.h> |
1288 | jermar | 47 | #include <syscall/copy.h> |
1297 | jermar | 48 | #include <security/cap.h> |
1329 | palkovsky | 49 | #include <mm/as.h> |
1875 | jermar | 50 | #include <print.h> |
1027 | palkovsky | 51 | |
2660 | jermar | 52 | /** |
53 | * Maximum buffer size allowed for IPC_M_DATA_WRITE and IPC_M_DATA_READ |
||
54 | * requests. |
||
55 | */ |
||
56 | #define DATA_XFER_LIMIT (64 * 1024) |
||
2494 | jermar | 57 | |
2471 | jermar | 58 | #define GET_CHECK_PHONE(phone, phoneid, err) \ |
59 | { \ |
||
60 | if (phoneid > IPC_MAX_PHONES) { \ |
||
61 | err; \ |
||
62 | } \ |
||
63 | phone = &TASK->phones[phoneid]; \ |
||
1084 | palkovsky | 64 | } |
65 | |||
2471 | jermar | 66 | #define STRUCT_TO_USPACE(dst, src) copy_to_uspace(dst, src, sizeof(*(src))) |
1084 | palkovsky | 67 | |
2471 | jermar | 68 | /** Decide if the method is a system method. |
69 | * |
||
70 | * @param method Method to be decided. |
||
71 | * |
||
72 | * @return Return 1 if the method is a system method. |
||
73 | * Otherwise return 0. |
||
74 | */ |
||
2557 | jermar | 75 | static inline int method_is_system(unative_t method) |
1040 | palkovsky | 76 | { |
77 | if (method <= IPC_M_LAST_SYSTEM) |
||
78 | return 1; |
||
79 | return 0; |
||
80 | } |
||
81 | |||
2471 | jermar | 82 | /** Decide if the message with this method is forwardable. |
1040 | palkovsky | 83 | * |
84 | * - some system messages may be forwarded, for some of them |
||
85 | * it is useless |
||
2471 | jermar | 86 | * |
87 | * @param method Method to be decided. |
||
88 | * |
||
89 | * @return Return 1 if the method is forwardable. |
||
90 | * Otherwise return 0. |
||
1040 | palkovsky | 91 | */ |
2557 | jermar | 92 | static inline int method_is_forwardable(unative_t method) |
1040 | palkovsky | 93 | { |
2494 | jermar | 94 | switch (method) { |
95 | case IPC_M_PHONE_HUNGUP: |
||
96 | /* This message is meant only for the original recipient. */ |
||
97 | return 0; |
||
98 | default: |
||
99 | return 1; |
||
100 | } |
||
1040 | palkovsky | 101 | } |
102 | |||
2557 | jermar | 103 | /** Decide if the message with this method is immutable on forward. |
104 | * |
||
2601 | jermar | 105 | * - some system messages may be forwarded but their content cannot be altered |
2557 | jermar | 106 | * |
107 | * @param method Method to be decided. |
||
108 | * |
||
109 | * @return Return 1 if the method is immutable on forward. |
||
110 | * Otherwise return 0. |
||
111 | */ |
||
112 | static inline int method_is_immutable(unative_t method) |
||
113 | { |
||
114 | switch (method) { |
||
115 | case IPC_M_AS_AREA_SEND: |
||
116 | case IPC_M_AS_AREA_RECV: |
||
2660 | jermar | 117 | case IPC_M_DATA_WRITE: |
118 | case IPC_M_DATA_READ: |
||
2557 | jermar | 119 | return 1; |
120 | break; |
||
121 | default: |
||
122 | return 0; |
||
123 | } |
||
124 | } |
||
1027 | palkovsky | 125 | |
2557 | jermar | 126 | |
2471 | jermar | 127 | /*********************************************************************** |
128 | * Functions that preprocess answer before sending it to the recepient. |
||
129 | ***********************************************************************/ |
||
130 | |||
131 | /** Decide if the caller (e.g. ipc_answer()) should save the old call contents |
||
132 | * for answer_preprocess(). |
||
133 | * |
||
134 | * @param call Call structure to be decided. |
||
135 | * |
||
136 | * @return Return 1 if the old call contents should be saved. |
||
137 | * Return 0 otherwise. |
||
1027 | palkovsky | 138 | */ |
1088 | palkovsky | 139 | static inline int answer_need_old(call_t *call) |
1027 | palkovsky | 140 | { |
2494 | jermar | 141 | switch (IPC_GET_METHOD(call->data)) { |
142 | case IPC_M_CONNECT_TO_ME: |
||
143 | case IPC_M_CONNECT_ME_TO: |
||
144 | case IPC_M_AS_AREA_SEND: |
||
145 | case IPC_M_AS_AREA_RECV: |
||
2660 | jermar | 146 | case IPC_M_DATA_WRITE: |
147 | case IPC_M_DATA_READ: |
||
1027 | palkovsky | 148 | return 1; |
2494 | jermar | 149 | default: |
150 | return 0; |
||
151 | } |
||
1027 | palkovsky | 152 | } |
153 | |||
2471 | jermar | 154 | /** Interpret process answer as control information. |
1428 | palkovsky | 155 | * |
2471 | jermar | 156 | * This function is called directly after sys_ipc_answer(). |
157 | * |
||
158 | * @param answer Call structure with the answer. |
||
159 | * @param olddata Saved data of the request. |
||
160 | * |
||
161 | * @return Return 0 on success or an error code. |
||
1428 | palkovsky | 162 | */ |
1329 | palkovsky | 163 | static inline int answer_preprocess(call_t *answer, ipc_data_t *olddata) |
1027 | palkovsky | 164 | { |
165 | int phoneid; |
||
166 | |||
1088 | palkovsky | 167 | if (IPC_GET_RETVAL(answer->data) == EHANGUP) { |
1141 | palkovsky | 168 | /* In case of forward, hangup the forwared phone, |
169 | * not the originator |
||
170 | */ |
||
171 | spinlock_lock(&answer->data.phone->lock); |
||
172 | spinlock_lock(&TASK->answerbox.lock); |
||
1568 | palkovsky | 173 | if (answer->data.phone->state == IPC_PHONE_CONNECTED) { |
1573 | palkovsky | 174 | list_remove(&answer->data.phone->link); |
1568 | palkovsky | 175 | answer->data.phone->state = IPC_PHONE_SLAMMED; |
1141 | palkovsky | 176 | } |
177 | spinlock_unlock(&TASK->answerbox.lock); |
||
178 | spinlock_unlock(&answer->data.phone->lock); |
||
1088 | palkovsky | 179 | } |
180 | |||
181 | if (!olddata) |
||
1329 | palkovsky | 182 | return 0; |
1088 | palkovsky | 183 | |
1086 | palkovsky | 184 | if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) { |
2637 | cejka | 185 | phoneid = IPC_GET_ARG5(*olddata); |
1027 | palkovsky | 186 | if (IPC_GET_RETVAL(answer->data)) { |
187 | /* The connection was not accepted */ |
||
188 | phone_dealloc(phoneid); |
||
1040 | palkovsky | 189 | } else { |
1090 | palkovsky | 190 | /* The connection was accepted */ |
2359 | jermar | 191 | phone_connect(phoneid, &answer->sender->answerbox); |
2638 | jermar | 192 | /* Set 'phone hash' as arg5 of response */ |
2637 | cejka | 193 | IPC_SET_ARG5(answer->data, |
2359 | jermar | 194 | (unative_t) &TASK->phones[phoneid]); |
1027 | palkovsky | 195 | } |
1086 | palkovsky | 196 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) { |
1060 | palkovsky | 197 | /* If the users accepted call, connect */ |
198 | if (!IPC_GET_RETVAL(answer->data)) { |
||
2635 | cejka | 199 | ipc_phone_connect((phone_t *) IPC_GET_ARG5(*olddata), |
2359 | jermar | 200 | &TASK->answerbox); |
1060 | palkovsky | 201 | } |
1359 | jermar | 202 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) { |
2359 | jermar | 203 | if (!IPC_GET_RETVAL(answer->data)) { |
204 | /* Accepted, handle as_area receipt */ |
||
1413 | jermar | 205 | ipl_t ipl; |
1461 | palkovsky | 206 | int rc; |
1413 | jermar | 207 | as_t *as; |
208 | |||
209 | ipl = interrupts_disable(); |
||
210 | spinlock_lock(&answer->sender->lock); |
||
211 | as = answer->sender->as; |
||
212 | spinlock_unlock(&answer->sender->lock); |
||
213 | interrupts_restore(ipl); |
||
214 | |||
2359 | jermar | 215 | rc = as_area_share(as, IPC_GET_ARG1(*olddata), |
216 | IPC_GET_ARG2(*olddata), AS, |
||
217 | IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata)); |
||
1461 | palkovsky | 218 | IPC_SET_RETVAL(answer->data, rc); |
219 | return rc; |
||
1329 | palkovsky | 220 | } |
1428 | palkovsky | 221 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_RECV) { |
222 | if (!IPC_GET_RETVAL(answer->data)) { |
||
223 | ipl_t ipl; |
||
224 | as_t *as; |
||
1434 | palkovsky | 225 | int rc; |
1428 | palkovsky | 226 | |
227 | ipl = interrupts_disable(); |
||
228 | spinlock_lock(&answer->sender->lock); |
||
229 | as = answer->sender->as; |
||
230 | spinlock_unlock(&answer->sender->lock); |
||
231 | interrupts_restore(ipl); |
||
232 | |||
2359 | jermar | 233 | rc = as_area_share(AS, IPC_GET_ARG1(answer->data), |
234 | IPC_GET_ARG2(*olddata), as, IPC_GET_ARG1(*olddata), |
||
235 | IPC_GET_ARG2(answer->data)); |
||
1434 | palkovsky | 236 | IPC_SET_RETVAL(answer->data, rc); |
1428 | palkovsky | 237 | } |
2660 | jermar | 238 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) { |
2661 | jermar | 239 | ASSERT(answer->buffer); |
2494 | jermar | 240 | if (!IPC_GET_RETVAL(answer->data)) { |
241 | int rc; |
||
242 | uintptr_t dst; |
||
243 | uintptr_t size; |
||
244 | |||
245 | dst = IPC_GET_ARG1(answer->data); |
||
246 | size = IPC_GET_ARG3(answer->data); |
||
247 | |||
248 | rc = copy_to_uspace((void *) dst, answer->buffer, size); |
||
249 | if (rc != 0) |
||
250 | IPC_SET_RETVAL(answer->data, rc); |
||
251 | } |
||
2661 | jermar | 252 | free(answer->buffer); |
253 | answer->buffer = NULL; |
||
1027 | palkovsky | 254 | } |
1329 | palkovsky | 255 | return 0; |
1027 | palkovsky | 256 | } |
257 | |||
2471 | jermar | 258 | /** Called before the request is sent. |
1090 | palkovsky | 259 | * |
2471 | jermar | 260 | * @param call Call structure with the request. |
261 | * |
||
262 | * @return Return 0 on success, ELIMIT or EPERM on error. |
||
1090 | palkovsky | 263 | */ |
264 | static int request_preprocess(call_t *call) |
||
265 | { |
||
266 | int newphid; |
||
1329 | palkovsky | 267 | size_t size; |
2494 | jermar | 268 | uintptr_t src; |
269 | int rc; |
||
1090 | palkovsky | 270 | |
271 | switch (IPC_GET_METHOD(call->data)) { |
||
272 | case IPC_M_CONNECT_ME_TO: |
||
273 | newphid = phone_alloc(); |
||
274 | if (newphid < 0) |
||
275 | return ELIMIT; |
||
2638 | jermar | 276 | /* Set arg5 for server */ |
2635 | cejka | 277 | IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]); |
1090 | palkovsky | 278 | call->flags |= IPC_CALL_CONN_ME_TO; |
2098 | decky | 279 | call->priv = newphid; |
1090 | palkovsky | 280 | break; |
1359 | jermar | 281 | case IPC_M_AS_AREA_SEND: |
2556 | jermar | 282 | size = as_area_get_size(IPC_GET_ARG1(call->data)); |
2471 | jermar | 283 | if (!size) |
1329 | palkovsky | 284 | return EPERM; |
1417 | jermar | 285 | IPC_SET_ARG2(call->data, size); |
1329 | palkovsky | 286 | break; |
2660 | jermar | 287 | case IPC_M_DATA_WRITE: |
2494 | jermar | 288 | src = IPC_GET_ARG2(call->data); |
289 | size = IPC_GET_ARG3(call->data); |
||
290 | |||
2660 | jermar | 291 | if ((size <= 0) || (size > DATA_XFER_LIMIT)) |
2494 | jermar | 292 | return ELIMIT; |
293 | |||
294 | call->buffer = (uint8_t *) malloc(size, 0); |
||
295 | rc = copy_from_uspace(call->buffer, (void *) src, size); |
||
296 | if (rc != 0) { |
||
297 | free(call->buffer); |
||
298 | return rc; |
||
299 | } |
||
300 | break; |
||
1090 | palkovsky | 301 | default: |
302 | break; |
||
303 | } |
||
304 | return 0; |
||
305 | } |
||
306 | |||
2471 | jermar | 307 | /******************************************************************************* |
308 | * Functions called to process received call/answer before passing it to uspace. |
||
309 | *******************************************************************************/ |
||
310 | |||
311 | /** Do basic kernel processing of received call answer. |
||
312 | * |
||
313 | * @param call Call structure with the answer. |
||
1027 | palkovsky | 314 | */ |
1090 | palkovsky | 315 | static void process_answer(call_t *call) |
1027 | palkovsky | 316 | { |
2359 | jermar | 317 | if (IPC_GET_RETVAL(call->data) == EHANGUP && |
318 | (call->flags & IPC_CALL_FORWARDED)) |
||
1088 | palkovsky | 319 | IPC_SET_RETVAL(call->data, EFORWARD); |
1090 | palkovsky | 320 | |
321 | if (call->flags & IPC_CALL_CONN_ME_TO) { |
||
322 | if (IPC_GET_RETVAL(call->data)) |
||
2098 | decky | 323 | phone_dealloc(call->priv); |
1090 | palkovsky | 324 | else |
2635 | cejka | 325 | IPC_SET_ARG5(call->data, call->priv); |
1090 | palkovsky | 326 | } |
1027 | palkovsky | 327 | } |
328 | |||
2471 | jermar | 329 | /** Do basic kernel processing of received call request. |
1027 | palkovsky | 330 | * |
2471 | jermar | 331 | * @param box Destination answerbox structure. |
332 | * @param call Call structure with the request. |
||
333 | * |
||
334 | * @return Return 0 if the call should be passed to userspace. |
||
335 | * Return -1 if the call should be ignored. |
||
1027 | palkovsky | 336 | */ |
2359 | jermar | 337 | static int process_request(answerbox_t *box, call_t *call) |
1027 | palkovsky | 338 | { |
339 | int phoneid; |
||
340 | |||
1086 | palkovsky | 341 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) { |
1040 | palkovsky | 342 | phoneid = phone_alloc(); |
1027 | palkovsky | 343 | if (phoneid < 0) { /* Failed to allocate phone */ |
344 | IPC_SET_RETVAL(call->data, ELIMIT); |
||
2471 | jermar | 345 | ipc_answer(box, call); |
1027 | palkovsky | 346 | return -1; |
347 | } |
||
2637 | cejka | 348 | IPC_SET_ARG5(call->data, phoneid); |
1027 | palkovsky | 349 | } |
350 | return 0; |
||
351 | } |
||
352 | |||
2471 | jermar | 353 | /** Make a fast call over IPC, wait for reply and return to user. |
1027 | palkovsky | 354 | * |
2615 | jermar | 355 | * This function can handle only three arguments of payload, but is faster than |
356 | * the generic function (i.e. sys_ipc_call_sync_slow()). |
||
2471 | jermar | 357 | * |
358 | * @param phoneid Phone handle for the call. |
||
359 | * @param method Method of the call. |
||
360 | * @param arg1 Service-defined payload argument. |
||
2615 | jermar | 361 | * @param arg2 Service-defined payload argument. |
362 | * @param arg3 Service-defined payload argument. |
||
2471 | jermar | 363 | * @param data Address of userspace structure where the reply call will |
364 | * be stored. |
||
365 | * |
||
366 | * @return Returns 0 on success. |
||
367 | * Return ENOENT if there is no such phone handle. |
||
1027 | palkovsky | 368 | */ |
2359 | jermar | 369 | unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method, |
2615 | jermar | 370 | unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data) |
1027 | palkovsky | 371 | { |
372 | call_t call; |
||
373 | phone_t *phone; |
||
1090 | palkovsky | 374 | int res; |
2617 | jermar | 375 | int rc; |
1027 | palkovsky | 376 | |
1084 | palkovsky | 377 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
1027 | palkovsky | 378 | |
1084 | palkovsky | 379 | ipc_call_static_init(&call); |
1027 | palkovsky | 380 | IPC_SET_METHOD(call.data, method); |
381 | IPC_SET_ARG1(call.data, arg1); |
||
2615 | jermar | 382 | IPC_SET_ARG2(call.data, arg2); |
383 | IPC_SET_ARG3(call.data, arg3); |
||
2620 | jermar | 384 | /* |
385 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
386 | * the limits of the fast version. |
||
387 | */ |
||
388 | IPC_SET_ARG4(call.data, 0); |
||
389 | IPC_SET_ARG5(call.data, 0); |
||
1027 | palkovsky | 390 | |
2471 | jermar | 391 | if (!(res = request_preprocess(&call))) { |
1090 | palkovsky | 392 | ipc_call_sync(phone, &call); |
393 | process_answer(&call); |
||
2471 | jermar | 394 | } else { |
1090 | palkovsky | 395 | IPC_SET_RETVAL(call.data, res); |
2471 | jermar | 396 | } |
2617 | jermar | 397 | rc = STRUCT_TO_USPACE(&data->args, &call.data.args); |
398 | if (rc != 0) |
||
399 | return rc; |
||
1027 | palkovsky | 400 | |
401 | return 0; |
||
402 | } |
||
403 | |||
2471 | jermar | 404 | /** Make a synchronous IPC call allowing to transmit the entire payload. |
405 | * |
||
406 | * @param phoneid Phone handle for the call. |
||
407 | * @param question Userspace address of call data with the request. |
||
2494 | jermar | 408 | * @param reply Userspace address of call data where to store the |
409 | * answer. |
||
2471 | jermar | 410 | * |
411 | * @return Zero on success or an error code. |
||
412 | */ |
||
2615 | jermar | 413 | unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question, |
2359 | jermar | 414 | ipc_data_t *reply) |
1027 | palkovsky | 415 | { |
416 | call_t call; |
||
417 | phone_t *phone; |
||
1090 | palkovsky | 418 | int res; |
1288 | jermar | 419 | int rc; |
1027 | palkovsky | 420 | |
1084 | palkovsky | 421 | ipc_call_static_init(&call); |
2359 | jermar | 422 | rc = copy_from_uspace(&call.data.args, &question->args, |
423 | sizeof(call.data.args)); |
||
1288 | jermar | 424 | if (rc != 0) |
1780 | jermar | 425 | return (unative_t) rc; |
1040 | palkovsky | 426 | |
1084 | palkovsky | 427 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
1072 | palkovsky | 428 | |
2471 | jermar | 429 | if (!(res = request_preprocess(&call))) { |
1090 | palkovsky | 430 | ipc_call_sync(phone, &call); |
431 | process_answer(&call); |
||
432 | } else |
||
433 | IPC_SET_RETVAL(call.data, res); |
||
1027 | palkovsky | 434 | |
1288 | jermar | 435 | rc = STRUCT_TO_USPACE(&reply->args, &call.data.args); |
436 | if (rc != 0) |
||
437 | return rc; |
||
1027 | palkovsky | 438 | |
439 | return 0; |
||
440 | } |
||
441 | |||
2471 | jermar | 442 | /** Check that the task did not exceed the allowed limit of asynchronous calls. |
1027 | palkovsky | 443 | * |
2471 | jermar | 444 | * @return Return 0 if limit not reached or -1 if limit exceeded. |
1027 | palkovsky | 445 | */ |
446 | static int check_call_limit(void) |
||
447 | { |
||
448 | if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) { |
||
449 | atomic_dec(&TASK->active_calls); |
||
450 | return -1; |
||
451 | } |
||
452 | return 0; |
||
453 | } |
||
454 | |||
2471 | jermar | 455 | /** Make a fast asynchronous call over IPC. |
1027 | palkovsky | 456 | * |
2618 | jermar | 457 | * This function can only handle four arguments of payload, but is faster than |
458 | * the generic function sys_ipc_call_async_slow(). |
||
2471 | jermar | 459 | * |
460 | * @param phoneid Phone handle for the call. |
||
461 | * @param method Method of the call. |
||
462 | * @param arg1 Service-defined payload argument. |
||
463 | * @param arg2 Service-defined payload argument. |
||
2618 | jermar | 464 | * @param arg3 Service-defined payload argument. |
465 | * @param arg4 Service-defined payload argument. |
||
2471 | jermar | 466 | * |
467 | * @return Return call hash on success. |
||
468 | * Return IPC_CALLRET_FATAL in case of a fatal error and |
||
469 | * IPC_CALLRET_TEMPORARY if there are too many pending |
||
470 | * asynchronous requests; answers should be handled first. |
||
1027 | palkovsky | 471 | */ |
2359 | jermar | 472 | unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method, |
2618 | jermar | 473 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
1027 | palkovsky | 474 | { |
475 | call_t *call; |
||
476 | phone_t *phone; |
||
1090 | palkovsky | 477 | int res; |
1027 | palkovsky | 478 | |
479 | if (check_call_limit()) |
||
480 | return IPC_CALLRET_TEMPORARY; |
||
481 | |||
1090 | palkovsky | 482 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
1072 | palkovsky | 483 | |
1258 | palkovsky | 484 | call = ipc_call_alloc(0); |
1027 | palkovsky | 485 | IPC_SET_METHOD(call->data, method); |
486 | IPC_SET_ARG1(call->data, arg1); |
||
487 | IPC_SET_ARG2(call->data, arg2); |
||
2618 | jermar | 488 | IPC_SET_ARG3(call->data, arg3); |
489 | IPC_SET_ARG4(call->data, arg4); |
||
2620 | jermar | 490 | /* |
491 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
492 | * the limits of the fast version. |
||
493 | */ |
||
494 | IPC_SET_ARG5(call->data, 0); |
||
1027 | palkovsky | 495 | |
2359 | jermar | 496 | if (!(res = request_preprocess(call))) |
1090 | palkovsky | 497 | ipc_call(phone, call); |
498 | else |
||
499 | ipc_backsend_err(phone, call, res); |
||
1027 | palkovsky | 500 | |
1780 | jermar | 501 | return (unative_t) call; |
1027 | palkovsky | 502 | } |
503 | |||
2471 | jermar | 504 | /** Make an asynchronous IPC call allowing to transmit the entire payload. |
1027 | palkovsky | 505 | * |
2471 | jermar | 506 | * @param phoneid Phone handle for the call. |
507 | * @param data Userspace address of call data with the request. |
||
508 | * |
||
509 | * @return See sys_ipc_call_async_fast(). |
||
1027 | palkovsky | 510 | */ |
2618 | jermar | 511 | unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data) |
1027 | palkovsky | 512 | { |
513 | call_t *call; |
||
514 | phone_t *phone; |
||
1090 | palkovsky | 515 | int res; |
1288 | jermar | 516 | int rc; |
1027 | palkovsky | 517 | |
1072 | palkovsky | 518 | if (check_call_limit()) |
519 | return IPC_CALLRET_TEMPORARY; |
||
520 | |||
1090 | palkovsky | 521 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
1027 | palkovsky | 522 | |
1258 | palkovsky | 523 | call = ipc_call_alloc(0); |
2359 | jermar | 524 | rc = copy_from_uspace(&call->data.args, &data->args, |
525 | sizeof(call->data.args)); |
||
1293 | palkovsky | 526 | if (rc != 0) { |
527 | ipc_call_free(call); |
||
1780 | jermar | 528 | return (unative_t) rc; |
1293 | palkovsky | 529 | } |
2359 | jermar | 530 | if (!(res = request_preprocess(call))) |
1090 | palkovsky | 531 | ipc_call(phone, call); |
532 | else |
||
533 | ipc_backsend_err(phone, call, res); |
||
1040 | palkovsky | 534 | |
1780 | jermar | 535 | return (unative_t) call; |
1027 | palkovsky | 536 | } |
537 | |||
2471 | jermar | 538 | /** Forward a received call to another destination. |
1040 | palkovsky | 539 | * |
2471 | jermar | 540 | * @param callid Hash of the call to forward. |
541 | * @param phoneid Phone handle to use for forwarding. |
||
542 | * @param method New method to use for the forwarded call. |
||
543 | * @param arg1 New value of the first argument for the forwarded call. |
||
2636 | jermar | 544 | * @param arg2 New value of the second argument for the forwarded call. |
2622 | jermar | 545 | * @param mode Flags that specify mode of the forward operation. |
1060 | palkovsky | 546 | * |
2471 | jermar | 547 | * @return Return 0 on succes, otherwise return an error code. |
548 | * |
||
2636 | jermar | 549 | * In case the original method is a system method, ARG1, ARG2 and ARG3 are |
550 | * overwritten in the forwarded message with the new method and the new arg1 and |
||
551 | * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with |
||
552 | * the new method, arg1 and arg2, respectively. Also note there is a set of |
||
553 | * immutable methods, for which the new method and argument is not set and |
||
554 | * these values are ignored. |
||
2471 | jermar | 555 | * |
2622 | jermar | 556 | * Warning: When implementing support for changing additional payload |
2636 | jermar | 557 | * arguments, make sure that ARG5 is not rewritten for certain |
2622 | jermar | 558 | * system IPC |
1040 | palkovsky | 559 | */ |
1780 | jermar | 560 | unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid, |
2635 | cejka | 561 | unative_t method, unative_t arg1, unative_t arg2, int mode) |
1040 | palkovsky | 562 | { |
563 | call_t *call; |
||
564 | phone_t *phone; |
||
565 | |||
566 | call = get_call(callid); |
||
567 | if (!call) |
||
568 | return ENOENT; |
||
569 | |||
1088 | palkovsky | 570 | call->flags |= IPC_CALL_FORWARDED; |
571 | |||
1084 | palkovsky | 572 | GET_CHECK_PHONE(phone, phoneid, { |
1040 | palkovsky | 573 | IPC_SET_RETVAL(call->data, EFORWARD); |
574 | ipc_answer(&TASK->answerbox, call); |
||
575 | return ENOENT; |
||
1084 | palkovsky | 576 | }); |
1040 | palkovsky | 577 | |
2557 | jermar | 578 | if (!method_is_forwardable(IPC_GET_METHOD(call->data))) { |
1040 | palkovsky | 579 | IPC_SET_RETVAL(call->data, EFORWARD); |
580 | ipc_answer(&TASK->answerbox, call); |
||
581 | return EPERM; |
||
582 | } |
||
583 | |||
2557 | jermar | 584 | /* |
585 | * Userspace is not allowed to change method of system methods on |
||
2635 | cejka | 586 | * forward, allow changing ARG1, ARG2 and ARG3 by means of method, |
587 | * arg1 and arg2. |
||
2557 | jermar | 588 | * If the method is immutable, don't change anything. |
1040 | palkovsky | 589 | */ |
2557 | jermar | 590 | if (!method_is_immutable(IPC_GET_METHOD(call->data))) { |
591 | if (method_is_system(IPC_GET_METHOD(call->data))) { |
||
592 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) |
||
2635 | cejka | 593 | phone_dealloc(IPC_GET_ARG5(call->data)); |
1090 | palkovsky | 594 | |
2557 | jermar | 595 | IPC_SET_ARG1(call->data, method); |
596 | IPC_SET_ARG2(call->data, arg1); |
||
2635 | cejka | 597 | IPC_SET_ARG3(call->data, arg2); |
2557 | jermar | 598 | } else { |
599 | IPC_SET_METHOD(call->data, method); |
||
600 | IPC_SET_ARG1(call->data, arg1); |
||
2635 | cejka | 601 | IPC_SET_ARG2(call->data, arg2); |
2557 | jermar | 602 | } |
1040 | palkovsky | 603 | } |
604 | |||
2622 | jermar | 605 | return ipc_forward(call, phone, &TASK->answerbox, mode); |
1040 | palkovsky | 606 | } |
607 | |||
2471 | jermar | 608 | /** Answer an IPC call - fast version. |
609 | * |
||
610 | * This function can handle only two return arguments of payload, but is faster |
||
611 | * than the generic sys_ipc_answer(). |
||
612 | * |
||
613 | * @param callid Hash of the call to be answered. |
||
614 | * @param retval Return value of the answer. |
||
615 | * @param arg1 Service-defined return value. |
||
616 | * @param arg2 Service-defined return value. |
||
2619 | jermar | 617 | * @param arg3 Service-defined return value. |
618 | * @param arg4 Service-defined return value. |
||
2471 | jermar | 619 | * |
620 | * @return Return 0 on success, otherwise return an error code. |
||
621 | */ |
||
2359 | jermar | 622 | unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval, |
2619 | jermar | 623 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
1027 | palkovsky | 624 | { |
625 | call_t *call; |
||
1040 | palkovsky | 626 | ipc_data_t saved_data; |
1088 | palkovsky | 627 | int saveddata = 0; |
1329 | palkovsky | 628 | int rc; |
1027 | palkovsky | 629 | |
1346 | palkovsky | 630 | /* Do not answer notification callids */ |
631 | if (callid & IPC_CALLID_NOTIFICATION) |
||
632 | return 0; |
||
633 | |||
1040 | palkovsky | 634 | call = get_call(callid); |
635 | if (!call) |
||
636 | return ENOENT; |
||
1027 | palkovsky | 637 | |
1088 | palkovsky | 638 | if (answer_need_old(call)) { |
1040 | palkovsky | 639 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
1088 | palkovsky | 640 | saveddata = 1; |
1027 | palkovsky | 641 | } |
642 | |||
643 | IPC_SET_RETVAL(call->data, retval); |
||
644 | IPC_SET_ARG1(call->data, arg1); |
||
645 | IPC_SET_ARG2(call->data, arg2); |
||
2619 | jermar | 646 | IPC_SET_ARG3(call->data, arg3); |
647 | IPC_SET_ARG4(call->data, arg4); |
||
2620 | jermar | 648 | /* |
649 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
650 | * the limits of the fast version. |
||
651 | */ |
||
652 | IPC_SET_ARG5(call->data, 0); |
||
1329 | palkovsky | 653 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
1040 | palkovsky | 654 | |
1027 | palkovsky | 655 | ipc_answer(&TASK->answerbox, call); |
1329 | palkovsky | 656 | return rc; |
1027 | palkovsky | 657 | } |
658 | |||
2471 | jermar | 659 | /** Answer an IPC call. |
660 | * |
||
661 | * @param callid Hash of the call to be answered. |
||
662 | * @param data Userspace address of call data with the answer. |
||
663 | * |
||
664 | * @return Return 0 on success, otherwise return an error code. |
||
665 | */ |
||
2619 | jermar | 666 | unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data) |
1027 | palkovsky | 667 | { |
668 | call_t *call; |
||
1040 | palkovsky | 669 | ipc_data_t saved_data; |
1088 | palkovsky | 670 | int saveddata = 0; |
1288 | jermar | 671 | int rc; |
1027 | palkovsky | 672 | |
1346 | palkovsky | 673 | /* Do not answer notification callids */ |
674 | if (callid & IPC_CALLID_NOTIFICATION) |
||
675 | return 0; |
||
676 | |||
1040 | palkovsky | 677 | call = get_call(callid); |
678 | if (!call) |
||
679 | return ENOENT; |
||
1027 | palkovsky | 680 | |
1088 | palkovsky | 681 | if (answer_need_old(call)) { |
1040 | palkovsky | 682 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
1088 | palkovsky | 683 | saveddata = 1; |
1027 | palkovsky | 684 | } |
1288 | jermar | 685 | rc = copy_from_uspace(&call->data.args, &data->args, |
2359 | jermar | 686 | sizeof(call->data.args)); |
1288 | jermar | 687 | if (rc != 0) |
688 | return rc; |
||
1027 | palkovsky | 689 | |
1329 | palkovsky | 690 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
1027 | palkovsky | 691 | |
692 | ipc_answer(&TASK->answerbox, call); |
||
693 | |||
1329 | palkovsky | 694 | return rc; |
1027 | palkovsky | 695 | } |
696 | |||
2471 | jermar | 697 | /** Hang up a phone. |
1086 | palkovsky | 698 | * |
2471 | jermar | 699 | * @param Phone handle of the phone to be hung up. |
700 | * |
||
701 | * @return Return 0 on success or an error code. |
||
1086 | palkovsky | 702 | */ |
1780 | jermar | 703 | unative_t sys_ipc_hangup(int phoneid) |
1086 | palkovsky | 704 | { |
705 | phone_t *phone; |
||
706 | |||
707 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
||
708 | |||
1591 | palkovsky | 709 | if (ipc_phone_hangup(phone)) |
1086 | palkovsky | 710 | return -1; |
711 | |||
712 | return 0; |
||
713 | } |
||
714 | |||
2471 | jermar | 715 | /** Wait for an incoming IPC call or an answer. |
1027 | palkovsky | 716 | * |
2359 | jermar | 717 | * @param calldata Pointer to buffer where the call/answer data is stored. |
718 | * @param usec Timeout. See waitq_sleep_timeout() for explanation. |
||
719 | * @param flags Select mode of sleep operation. See waitq_sleep_timeout() |
||
720 | * for explanation. |
||
1364 | jermar | 721 | * |
2471 | jermar | 722 | * @return Hash of the call. |
723 | * If IPC_CALLID_NOTIFICATION bit is set in the hash, the |
||
724 | * call is a notification. IPC_CALLID_ANSWERED denotes an |
||
725 | * answer. |
||
1027 | palkovsky | 726 | */ |
1780 | jermar | 727 | unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags) |
1027 | palkovsky | 728 | { |
729 | call_t *call; |
||
730 | |||
731 | restart: |
||
2359 | jermar | 732 | call = ipc_wait_for_call(&TASK->answerbox, usec, |
733 | flags | SYNCH_FLAGS_INTERRUPTIBLE); |
||
1088 | palkovsky | 734 | if (!call) |
735 | return 0; |
||
1027 | palkovsky | 736 | |
1258 | palkovsky | 737 | if (call->flags & IPC_CALL_NOTIF) { |
738 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
||
1693 | palkovsky | 739 | |
740 | /* Set in_phone_hash to the interrupt counter */ |
||
2098 | decky | 741 | call->data.phone = (void *) call->priv; |
1693 | palkovsky | 742 | |
743 | STRUCT_TO_USPACE(calldata, &call->data); |
||
744 | |||
1258 | palkovsky | 745 | ipc_call_free(call); |
746 | |||
2471 | jermar | 747 | return ((unative_t) call) | IPC_CALLID_NOTIFICATION; |
1258 | palkovsky | 748 | } |
749 | |||
1027 | palkovsky | 750 | if (call->flags & IPC_CALL_ANSWERED) { |
1090 | palkovsky | 751 | process_answer(call); |
1027 | palkovsky | 752 | |
1086 | palkovsky | 753 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
754 | |||
1027 | palkovsky | 755 | atomic_dec(&TASK->active_calls); |
1086 | palkovsky | 756 | |
757 | if (call->flags & IPC_CALL_DISCARD_ANSWER) { |
||
758 | ipc_call_free(call); |
||
759 | goto restart; |
||
760 | } |
||
761 | |||
762 | STRUCT_TO_USPACE(&calldata->args, &call->data.args); |
||
1027 | palkovsky | 763 | ipc_call_free(call); |
764 | |||
2471 | jermar | 765 | return ((unative_t) call) | IPC_CALLID_ANSWERED; |
1027 | palkovsky | 766 | } |
1086 | palkovsky | 767 | |
1027 | palkovsky | 768 | if (process_request(&TASK->answerbox, call)) |
769 | goto restart; |
||
1086 | palkovsky | 770 | |
1090 | palkovsky | 771 | /* Include phone address('id') of the caller in the request, |
772 | * copy whole call->data, not only call->data.args */ |
||
1396 | palkovsky | 773 | if (STRUCT_TO_USPACE(calldata, &call->data)) { |
774 | return 0; |
||
775 | } |
||
1780 | jermar | 776 | return (unative_t)call; |
1027 | palkovsky | 777 | } |
1258 | palkovsky | 778 | |
2471 | jermar | 779 | /** Connect an IRQ handler to a task. |
1923 | jermar | 780 | * |
2471 | jermar | 781 | * @param inr IRQ number. |
782 | * @param devno Device number. |
||
783 | * @param method Method to be associated with the notification. |
||
784 | * @param ucode Uspace pointer to the top-half pseudocode. |
||
1923 | jermar | 785 | * |
2471 | jermar | 786 | * @return EPERM or a return code returned by ipc_irq_register(). |
1923 | jermar | 787 | */ |
2359 | jermar | 788 | unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method, |
789 | irq_code_t *ucode) |
||
1258 | palkovsky | 790 | { |
1297 | jermar | 791 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
792 | return EPERM; |
||
793 | |||
1923 | jermar | 794 | return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode); |
1258 | palkovsky | 795 | } |
796 | |||
2471 | jermar | 797 | /** Disconnect an IRQ handler from a task. |
1923 | jermar | 798 | * |
2471 | jermar | 799 | * @param inr IRQ number. |
800 | * @param devno Device number. |
||
801 | * |
||
802 | * @return Zero on success or EPERM on error.. |
||
1923 | jermar | 803 | */ |
804 | unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno) |
||
1258 | palkovsky | 805 | { |
1297 | jermar | 806 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
807 | return EPERM; |
||
808 | |||
1923 | jermar | 809 | ipc_irq_unregister(&TASK->answerbox, inr, devno); |
1258 | palkovsky | 810 | |
811 | return 0; |
||
812 | } |
||
1702 | cejka | 813 | |
1757 | jermar | 814 | /** @} |
1702 | cejka | 815 | */ |