Rev 3343 | Rev 3665 | 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) { |
||
2677 | jermar | 115 | case IPC_M_SHARE_OUT: |
116 | case IPC_M_SHARE_IN: |
||
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: |
||
2677 | jermar | 144 | case IPC_M_SHARE_OUT: |
145 | case IPC_M_SHARE_IN: |
||
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 | |||
2745 | decky | 167 | if ((native_t) IPC_GET_RETVAL(answer->data) == EHANGUP) { |
1141 | palkovsky | 168 | /* In case of forward, hangup the forwared phone, |
169 | * not the originator |
||
170 | */ |
||
3020 | jermar | 171 | mutex_lock(&answer->data.phone->lock); |
1141 | palkovsky | 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); |
||
3020 | jermar | 178 | mutex_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 | } |
2677 | jermar | 202 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_OUT) { |
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 | } |
2677 | jermar | 221 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_IN) { |
1428 | palkovsky | 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 | } |
2662 | jermar | 238 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_READ) { |
239 | ASSERT(!answer->buffer); |
||
240 | if (!IPC_GET_RETVAL(answer->data)) { |
||
241 | /* The recipient agreed to send data. */ |
||
242 | uintptr_t src = IPC_GET_ARG1(answer->data); |
||
243 | uintptr_t dst = IPC_GET_ARG1(*olddata); |
||
244 | size_t max_size = IPC_GET_ARG2(*olddata); |
||
245 | size_t size = IPC_GET_ARG2(answer->data); |
||
2934 | jermar | 246 | if (size && size <= max_size) { |
2662 | jermar | 247 | /* |
248 | * Copy the destination VA so that this piece of |
||
249 | * information is not lost. |
||
250 | */ |
||
251 | IPC_SET_ARG1(answer->data, dst); |
||
252 | |||
253 | answer->buffer = malloc(size, 0); |
||
254 | int rc = copy_from_uspace(answer->buffer, |
||
255 | (void *) src, size); |
||
256 | if (rc) { |
||
257 | IPC_SET_RETVAL(answer->data, rc); |
||
258 | free(answer->buffer); |
||
259 | answer->buffer = NULL; |
||
260 | } |
||
2934 | jermar | 261 | } else if (!size) { |
262 | IPC_SET_RETVAL(answer->data, EOK); |
||
2662 | jermar | 263 | } else { |
264 | IPC_SET_RETVAL(answer->data, ELIMIT); |
||
265 | } |
||
266 | } |
||
2660 | jermar | 267 | } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) { |
2661 | jermar | 268 | ASSERT(answer->buffer); |
2494 | jermar | 269 | if (!IPC_GET_RETVAL(answer->data)) { |
2662 | jermar | 270 | /* The recipient agreed to receive data. */ |
2494 | jermar | 271 | int rc; |
272 | uintptr_t dst; |
||
3332 | jermar | 273 | size_t size; |
274 | size_t max_size; |
||
2494 | jermar | 275 | |
3332 | jermar | 276 | dst = (uintptr_t)IPC_GET_ARG1(answer->data); |
277 | size = (size_t)IPC_GET_ARG2(answer->data); |
||
278 | max_size = (size_t)IPC_GET_ARG2(*olddata); |
||
2494 | jermar | 279 | |
2662 | jermar | 280 | if (size <= max_size) { |
281 | rc = copy_to_uspace((void *) dst, |
||
282 | answer->buffer, size); |
||
283 | if (rc) |
||
284 | IPC_SET_RETVAL(answer->data, rc); |
||
285 | } else { |
||
286 | IPC_SET_RETVAL(answer->data, ELIMIT); |
||
287 | } |
||
2494 | jermar | 288 | } |
2661 | jermar | 289 | free(answer->buffer); |
290 | answer->buffer = NULL; |
||
1027 | palkovsky | 291 | } |
1329 | palkovsky | 292 | return 0; |
1027 | palkovsky | 293 | } |
294 | |||
2471 | jermar | 295 | /** Called before the request is sent. |
1090 | palkovsky | 296 | * |
2471 | jermar | 297 | * @param call Call structure with the request. |
298 | * |
||
299 | * @return Return 0 on success, ELIMIT or EPERM on error. |
||
1090 | palkovsky | 300 | */ |
301 | static int request_preprocess(call_t *call) |
||
302 | { |
||
303 | int newphid; |
||
1329 | palkovsky | 304 | size_t size; |
2494 | jermar | 305 | uintptr_t src; |
306 | int rc; |
||
1090 | palkovsky | 307 | |
308 | switch (IPC_GET_METHOD(call->data)) { |
||
309 | case IPC_M_CONNECT_ME_TO: |
||
310 | newphid = phone_alloc(); |
||
311 | if (newphid < 0) |
||
312 | return ELIMIT; |
||
2638 | jermar | 313 | /* Set arg5 for server */ |
2635 | cejka | 314 | IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]); |
1090 | palkovsky | 315 | call->flags |= IPC_CALL_CONN_ME_TO; |
2098 | decky | 316 | call->priv = newphid; |
1090 | palkovsky | 317 | break; |
2677 | jermar | 318 | case IPC_M_SHARE_OUT: |
2556 | jermar | 319 | size = as_area_get_size(IPC_GET_ARG1(call->data)); |
2471 | jermar | 320 | if (!size) |
1329 | palkovsky | 321 | return EPERM; |
1417 | jermar | 322 | IPC_SET_ARG2(call->data, size); |
1329 | palkovsky | 323 | break; |
2662 | jermar | 324 | case IPC_M_DATA_READ: |
325 | size = IPC_GET_ARG2(call->data); |
||
326 | if ((size <= 0 || (size > DATA_XFER_LIMIT))) |
||
327 | return ELIMIT; |
||
328 | break; |
||
2660 | jermar | 329 | case IPC_M_DATA_WRITE: |
2676 | jermar | 330 | src = IPC_GET_ARG1(call->data); |
331 | size = IPC_GET_ARG2(call->data); |
||
2494 | jermar | 332 | |
2660 | jermar | 333 | if ((size <= 0) || (size > DATA_XFER_LIMIT)) |
2494 | jermar | 334 | return ELIMIT; |
335 | |||
336 | call->buffer = (uint8_t *) malloc(size, 0); |
||
337 | rc = copy_from_uspace(call->buffer, (void *) src, size); |
||
338 | if (rc != 0) { |
||
339 | free(call->buffer); |
||
340 | return rc; |
||
341 | } |
||
342 | break; |
||
1090 | palkovsky | 343 | default: |
344 | break; |
||
345 | } |
||
346 | return 0; |
||
347 | } |
||
348 | |||
2471 | jermar | 349 | /******************************************************************************* |
350 | * Functions called to process received call/answer before passing it to uspace. |
||
351 | *******************************************************************************/ |
||
352 | |||
353 | /** Do basic kernel processing of received call answer. |
||
354 | * |
||
355 | * @param call Call structure with the answer. |
||
1027 | palkovsky | 356 | */ |
1090 | palkovsky | 357 | static void process_answer(call_t *call) |
1027 | palkovsky | 358 | { |
2745 | decky | 359 | if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) && |
2359 | jermar | 360 | (call->flags & IPC_CALL_FORWARDED)) |
1088 | palkovsky | 361 | IPC_SET_RETVAL(call->data, EFORWARD); |
1090 | palkovsky | 362 | |
363 | if (call->flags & IPC_CALL_CONN_ME_TO) { |
||
364 | if (IPC_GET_RETVAL(call->data)) |
||
2098 | decky | 365 | phone_dealloc(call->priv); |
1090 | palkovsky | 366 | else |
2635 | cejka | 367 | IPC_SET_ARG5(call->data, call->priv); |
1090 | palkovsky | 368 | } |
2662 | jermar | 369 | |
370 | if (call->buffer) { |
||
371 | /* This must be an affirmative answer to IPC_M_DATA_READ. */ |
||
372 | uintptr_t dst = IPC_GET_ARG1(call->data); |
||
373 | size_t size = IPC_GET_ARG2(call->data); |
||
374 | int rc = copy_to_uspace((void *) dst, call->buffer, size); |
||
375 | if (rc) |
||
376 | IPC_SET_RETVAL(call->data, rc); |
||
377 | free(call->buffer); |
||
378 | call->buffer = NULL; |
||
379 | } |
||
1027 | palkovsky | 380 | } |
381 | |||
2471 | jermar | 382 | /** Do basic kernel processing of received call request. |
1027 | palkovsky | 383 | * |
2471 | jermar | 384 | * @param box Destination answerbox structure. |
385 | * @param call Call structure with the request. |
||
386 | * |
||
387 | * @return Return 0 if the call should be passed to userspace. |
||
388 | * Return -1 if the call should be ignored. |
||
1027 | palkovsky | 389 | */ |
2359 | jermar | 390 | static int process_request(answerbox_t *box, call_t *call) |
1027 | palkovsky | 391 | { |
392 | int phoneid; |
||
393 | |||
1086 | palkovsky | 394 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) { |
1040 | palkovsky | 395 | phoneid = phone_alloc(); |
1027 | palkovsky | 396 | if (phoneid < 0) { /* Failed to allocate phone */ |
397 | IPC_SET_RETVAL(call->data, ELIMIT); |
||
2471 | jermar | 398 | ipc_answer(box, call); |
1027 | palkovsky | 399 | return -1; |
400 | } |
||
2637 | cejka | 401 | IPC_SET_ARG5(call->data, phoneid); |
1027 | palkovsky | 402 | } |
403 | return 0; |
||
404 | } |
||
405 | |||
2471 | jermar | 406 | /** Make a fast call over IPC, wait for reply and return to user. |
1027 | palkovsky | 407 | * |
2615 | jermar | 408 | * This function can handle only three arguments of payload, but is faster than |
409 | * the generic function (i.e. sys_ipc_call_sync_slow()). |
||
2471 | jermar | 410 | * |
411 | * @param phoneid Phone handle for the call. |
||
412 | * @param method Method of the call. |
||
413 | * @param arg1 Service-defined payload argument. |
||
2615 | jermar | 414 | * @param arg2 Service-defined payload argument. |
415 | * @param arg3 Service-defined payload argument. |
||
2471 | jermar | 416 | * @param data Address of userspace structure where the reply call will |
417 | * be stored. |
||
418 | * |
||
419 | * @return Returns 0 on success. |
||
420 | * Return ENOENT if there is no such phone handle. |
||
1027 | palkovsky | 421 | */ |
2359 | jermar | 422 | unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method, |
2615 | jermar | 423 | unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data) |
1027 | palkovsky | 424 | { |
425 | call_t call; |
||
426 | phone_t *phone; |
||
1090 | palkovsky | 427 | int res; |
2617 | jermar | 428 | int rc; |
3054 | decky | 429 | |
1084 | palkovsky | 430 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
1027 | palkovsky | 431 | |
1084 | palkovsky | 432 | ipc_call_static_init(&call); |
1027 | palkovsky | 433 | IPC_SET_METHOD(call.data, method); |
434 | IPC_SET_ARG1(call.data, arg1); |
||
2615 | jermar | 435 | IPC_SET_ARG2(call.data, arg2); |
436 | IPC_SET_ARG3(call.data, arg3); |
||
2620 | jermar | 437 | /* |
438 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
439 | * the limits of the fast version. |
||
440 | */ |
||
441 | IPC_SET_ARG4(call.data, 0); |
||
442 | IPC_SET_ARG5(call.data, 0); |
||
1027 | palkovsky | 443 | |
2471 | jermar | 444 | if (!(res = request_preprocess(&call))) { |
3397 | rimsky | 445 | rc = ipc_call_sync(phone, &call); |
446 | if (rc != EOK) |
||
447 | return rc; |
||
1090 | palkovsky | 448 | process_answer(&call); |
2471 | jermar | 449 | } else { |
1090 | palkovsky | 450 | IPC_SET_RETVAL(call.data, res); |
2471 | jermar | 451 | } |
2617 | jermar | 452 | rc = STRUCT_TO_USPACE(&data->args, &call.data.args); |
453 | if (rc != 0) |
||
454 | return rc; |
||
1027 | palkovsky | 455 | |
456 | return 0; |
||
457 | } |
||
458 | |||
2471 | jermar | 459 | /** Make a synchronous IPC call allowing to transmit the entire payload. |
460 | * |
||
461 | * @param phoneid Phone handle for the call. |
||
462 | * @param question Userspace address of call data with the request. |
||
2494 | jermar | 463 | * @param reply Userspace address of call data where to store the |
464 | * answer. |
||
2471 | jermar | 465 | * |
466 | * @return Zero on success or an error code. |
||
467 | */ |
||
2615 | jermar | 468 | unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question, |
2359 | jermar | 469 | ipc_data_t *reply) |
1027 | palkovsky | 470 | { |
471 | call_t call; |
||
472 | phone_t *phone; |
||
1090 | palkovsky | 473 | int res; |
1288 | jermar | 474 | int rc; |
1027 | palkovsky | 475 | |
1084 | palkovsky | 476 | ipc_call_static_init(&call); |
2359 | jermar | 477 | rc = copy_from_uspace(&call.data.args, &question->args, |
478 | sizeof(call.data.args)); |
||
1288 | jermar | 479 | if (rc != 0) |
1780 | jermar | 480 | return (unative_t) rc; |
1040 | palkovsky | 481 | |
1084 | palkovsky | 482 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
1072 | palkovsky | 483 | |
2471 | jermar | 484 | if (!(res = request_preprocess(&call))) { |
3397 | rimsky | 485 | rc = ipc_call_sync(phone, &call); |
486 | if (rc != EOK) |
||
487 | return rc; |
||
1090 | palkovsky | 488 | process_answer(&call); |
489 | } else |
||
490 | IPC_SET_RETVAL(call.data, res); |
||
1027 | palkovsky | 491 | |
1288 | jermar | 492 | rc = STRUCT_TO_USPACE(&reply->args, &call.data.args); |
493 | if (rc != 0) |
||
494 | return rc; |
||
1027 | palkovsky | 495 | |
496 | return 0; |
||
497 | } |
||
498 | |||
2471 | jermar | 499 | /** Check that the task did not exceed the allowed limit of asynchronous calls. |
1027 | palkovsky | 500 | * |
2471 | jermar | 501 | * @return Return 0 if limit not reached or -1 if limit exceeded. |
1027 | palkovsky | 502 | */ |
503 | static int check_call_limit(void) |
||
504 | { |
||
505 | if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) { |
||
506 | atomic_dec(&TASK->active_calls); |
||
507 | return -1; |
||
508 | } |
||
509 | return 0; |
||
510 | } |
||
511 | |||
2471 | jermar | 512 | /** Make a fast asynchronous call over IPC. |
1027 | palkovsky | 513 | * |
2618 | jermar | 514 | * This function can only handle four arguments of payload, but is faster than |
515 | * the generic function sys_ipc_call_async_slow(). |
||
2471 | jermar | 516 | * |
517 | * @param phoneid Phone handle for the call. |
||
518 | * @param method Method of the call. |
||
519 | * @param arg1 Service-defined payload argument. |
||
520 | * @param arg2 Service-defined payload argument. |
||
2618 | jermar | 521 | * @param arg3 Service-defined payload argument. |
522 | * @param arg4 Service-defined payload argument. |
||
2471 | jermar | 523 | * |
524 | * @return Return call hash on success. |
||
525 | * Return IPC_CALLRET_FATAL in case of a fatal error and |
||
526 | * IPC_CALLRET_TEMPORARY if there are too many pending |
||
527 | * asynchronous requests; answers should be handled first. |
||
1027 | palkovsky | 528 | */ |
2359 | jermar | 529 | unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method, |
2618 | jermar | 530 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
1027 | palkovsky | 531 | { |
532 | call_t *call; |
||
533 | phone_t *phone; |
||
1090 | palkovsky | 534 | int res; |
1027 | palkovsky | 535 | |
536 | if (check_call_limit()) |
||
537 | return IPC_CALLRET_TEMPORARY; |
||
538 | |||
1090 | palkovsky | 539 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
1072 | palkovsky | 540 | |
1258 | palkovsky | 541 | call = ipc_call_alloc(0); |
1027 | palkovsky | 542 | IPC_SET_METHOD(call->data, method); |
543 | IPC_SET_ARG1(call->data, arg1); |
||
544 | IPC_SET_ARG2(call->data, arg2); |
||
2618 | jermar | 545 | IPC_SET_ARG3(call->data, arg3); |
546 | IPC_SET_ARG4(call->data, arg4); |
||
2620 | jermar | 547 | /* |
548 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
549 | * the limits of the fast version. |
||
550 | */ |
||
551 | IPC_SET_ARG5(call->data, 0); |
||
1027 | palkovsky | 552 | |
2359 | jermar | 553 | if (!(res = request_preprocess(call))) |
1090 | palkovsky | 554 | ipc_call(phone, call); |
555 | else |
||
556 | ipc_backsend_err(phone, call, res); |
||
1027 | palkovsky | 557 | |
1780 | jermar | 558 | return (unative_t) call; |
1027 | palkovsky | 559 | } |
560 | |||
2471 | jermar | 561 | /** Make an asynchronous IPC call allowing to transmit the entire payload. |
1027 | palkovsky | 562 | * |
2471 | jermar | 563 | * @param phoneid Phone handle for the call. |
564 | * @param data Userspace address of call data with the request. |
||
565 | * |
||
566 | * @return See sys_ipc_call_async_fast(). |
||
1027 | palkovsky | 567 | */ |
2618 | jermar | 568 | unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data) |
1027 | palkovsky | 569 | { |
570 | call_t *call; |
||
571 | phone_t *phone; |
||
1090 | palkovsky | 572 | int res; |
1288 | jermar | 573 | int rc; |
1027 | palkovsky | 574 | |
1072 | palkovsky | 575 | if (check_call_limit()) |
576 | return IPC_CALLRET_TEMPORARY; |
||
577 | |||
1090 | palkovsky | 578 | GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL); |
1027 | palkovsky | 579 | |
1258 | palkovsky | 580 | call = ipc_call_alloc(0); |
2359 | jermar | 581 | rc = copy_from_uspace(&call->data.args, &data->args, |
582 | sizeof(call->data.args)); |
||
1293 | palkovsky | 583 | if (rc != 0) { |
584 | ipc_call_free(call); |
||
1780 | jermar | 585 | return (unative_t) rc; |
1293 | palkovsky | 586 | } |
2359 | jermar | 587 | if (!(res = request_preprocess(call))) |
1090 | palkovsky | 588 | ipc_call(phone, call); |
589 | else |
||
590 | ipc_backsend_err(phone, call, res); |
||
1040 | palkovsky | 591 | |
1780 | jermar | 592 | return (unative_t) call; |
1027 | palkovsky | 593 | } |
594 | |||
2471 | jermar | 595 | /** Forward a received call to another destination. |
1040 | palkovsky | 596 | * |
2471 | jermar | 597 | * @param callid Hash of the call to forward. |
598 | * @param phoneid Phone handle to use for forwarding. |
||
599 | * @param method New method to use for the forwarded call. |
||
600 | * @param arg1 New value of the first argument for the forwarded call. |
||
2636 | jermar | 601 | * @param arg2 New value of the second argument for the forwarded call. |
2622 | jermar | 602 | * @param mode Flags that specify mode of the forward operation. |
1060 | palkovsky | 603 | * |
2471 | jermar | 604 | * @return Return 0 on succes, otherwise return an error code. |
605 | * |
||
2636 | jermar | 606 | * In case the original method is a system method, ARG1, ARG2 and ARG3 are |
607 | * overwritten in the forwarded message with the new method and the new arg1 and |
||
608 | * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with |
||
609 | * the new method, arg1 and arg2, respectively. Also note there is a set of |
||
610 | * immutable methods, for which the new method and argument is not set and |
||
611 | * these values are ignored. |
||
2471 | jermar | 612 | * |
2622 | jermar | 613 | * Warning: When implementing support for changing additional payload |
2636 | jermar | 614 | * arguments, make sure that ARG5 is not rewritten for certain |
2622 | jermar | 615 | * system IPC |
1040 | palkovsky | 616 | */ |
1780 | jermar | 617 | unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid, |
2635 | cejka | 618 | unative_t method, unative_t arg1, unative_t arg2, int mode) |
1040 | palkovsky | 619 | { |
620 | call_t *call; |
||
621 | phone_t *phone; |
||
622 | |||
623 | call = get_call(callid); |
||
624 | if (!call) |
||
625 | return ENOENT; |
||
626 | |||
1088 | palkovsky | 627 | call->flags |= IPC_CALL_FORWARDED; |
628 | |||
1084 | palkovsky | 629 | GET_CHECK_PHONE(phone, phoneid, { |
1040 | palkovsky | 630 | IPC_SET_RETVAL(call->data, EFORWARD); |
631 | ipc_answer(&TASK->answerbox, call); |
||
632 | return ENOENT; |
||
3054 | decky | 633 | }); |
1040 | palkovsky | 634 | |
2557 | jermar | 635 | if (!method_is_forwardable(IPC_GET_METHOD(call->data))) { |
1040 | palkovsky | 636 | IPC_SET_RETVAL(call->data, EFORWARD); |
637 | ipc_answer(&TASK->answerbox, call); |
||
638 | return EPERM; |
||
639 | } |
||
640 | |||
2557 | jermar | 641 | /* |
642 | * Userspace is not allowed to change method of system methods on |
||
2635 | cejka | 643 | * forward, allow changing ARG1, ARG2 and ARG3 by means of method, |
644 | * arg1 and arg2. |
||
2557 | jermar | 645 | * If the method is immutable, don't change anything. |
1040 | palkovsky | 646 | */ |
2557 | jermar | 647 | if (!method_is_immutable(IPC_GET_METHOD(call->data))) { |
648 | if (method_is_system(IPC_GET_METHOD(call->data))) { |
||
649 | if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) |
||
2635 | cejka | 650 | phone_dealloc(IPC_GET_ARG5(call->data)); |
1090 | palkovsky | 651 | |
2557 | jermar | 652 | IPC_SET_ARG1(call->data, method); |
653 | IPC_SET_ARG2(call->data, arg1); |
||
2635 | cejka | 654 | IPC_SET_ARG3(call->data, arg2); |
2557 | jermar | 655 | } else { |
656 | IPC_SET_METHOD(call->data, method); |
||
657 | IPC_SET_ARG1(call->data, arg1); |
||
2635 | cejka | 658 | IPC_SET_ARG2(call->data, arg2); |
2557 | jermar | 659 | } |
1040 | palkovsky | 660 | } |
661 | |||
2622 | jermar | 662 | return ipc_forward(call, phone, &TASK->answerbox, mode); |
1040 | palkovsky | 663 | } |
664 | |||
2471 | jermar | 665 | /** Answer an IPC call - fast version. |
666 | * |
||
667 | * This function can handle only two return arguments of payload, but is faster |
||
668 | * than the generic sys_ipc_answer(). |
||
669 | * |
||
670 | * @param callid Hash of the call to be answered. |
||
671 | * @param retval Return value of the answer. |
||
672 | * @param arg1 Service-defined return value. |
||
673 | * @param arg2 Service-defined return value. |
||
2619 | jermar | 674 | * @param arg3 Service-defined return value. |
675 | * @param arg4 Service-defined return value. |
||
2471 | jermar | 676 | * |
677 | * @return Return 0 on success, otherwise return an error code. |
||
678 | */ |
||
2359 | jermar | 679 | unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval, |
2619 | jermar | 680 | unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4) |
1027 | palkovsky | 681 | { |
682 | call_t *call; |
||
1040 | palkovsky | 683 | ipc_data_t saved_data; |
1088 | palkovsky | 684 | int saveddata = 0; |
1329 | palkovsky | 685 | int rc; |
1027 | palkovsky | 686 | |
1346 | palkovsky | 687 | /* Do not answer notification callids */ |
688 | if (callid & IPC_CALLID_NOTIFICATION) |
||
689 | return 0; |
||
690 | |||
1040 | palkovsky | 691 | call = get_call(callid); |
692 | if (!call) |
||
693 | return ENOENT; |
||
1027 | palkovsky | 694 | |
1088 | palkovsky | 695 | if (answer_need_old(call)) { |
1040 | palkovsky | 696 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
1088 | palkovsky | 697 | saveddata = 1; |
1027 | palkovsky | 698 | } |
699 | |||
700 | IPC_SET_RETVAL(call->data, retval); |
||
701 | IPC_SET_ARG1(call->data, arg1); |
||
702 | IPC_SET_ARG2(call->data, arg2); |
||
2619 | jermar | 703 | IPC_SET_ARG3(call->data, arg3); |
704 | IPC_SET_ARG4(call->data, arg4); |
||
2620 | jermar | 705 | /* |
706 | * To achieve deterministic behavior, zero out arguments that are beyond |
||
707 | * the limits of the fast version. |
||
708 | */ |
||
709 | IPC_SET_ARG5(call->data, 0); |
||
1329 | palkovsky | 710 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
1040 | palkovsky | 711 | |
1027 | palkovsky | 712 | ipc_answer(&TASK->answerbox, call); |
1329 | palkovsky | 713 | return rc; |
1027 | palkovsky | 714 | } |
715 | |||
2471 | jermar | 716 | /** Answer an IPC call. |
717 | * |
||
718 | * @param callid Hash of the call to be answered. |
||
719 | * @param data Userspace address of call data with the answer. |
||
720 | * |
||
721 | * @return Return 0 on success, otherwise return an error code. |
||
722 | */ |
||
2619 | jermar | 723 | unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data) |
1027 | palkovsky | 724 | { |
725 | call_t *call; |
||
1040 | palkovsky | 726 | ipc_data_t saved_data; |
1088 | palkovsky | 727 | int saveddata = 0; |
1288 | jermar | 728 | int rc; |
1027 | palkovsky | 729 | |
1346 | palkovsky | 730 | /* Do not answer notification callids */ |
731 | if (callid & IPC_CALLID_NOTIFICATION) |
||
732 | return 0; |
||
733 | |||
1040 | palkovsky | 734 | call = get_call(callid); |
735 | if (!call) |
||
736 | return ENOENT; |
||
1027 | palkovsky | 737 | |
1088 | palkovsky | 738 | if (answer_need_old(call)) { |
1040 | palkovsky | 739 | memcpy(&saved_data, &call->data, sizeof(call->data)); |
1088 | palkovsky | 740 | saveddata = 1; |
1027 | palkovsky | 741 | } |
1288 | jermar | 742 | rc = copy_from_uspace(&call->data.args, &data->args, |
2359 | jermar | 743 | sizeof(call->data.args)); |
1288 | jermar | 744 | if (rc != 0) |
745 | return rc; |
||
1027 | palkovsky | 746 | |
1329 | palkovsky | 747 | rc = answer_preprocess(call, saveddata ? &saved_data : NULL); |
1027 | palkovsky | 748 | |
749 | ipc_answer(&TASK->answerbox, call); |
||
750 | |||
1329 | palkovsky | 751 | return rc; |
1027 | palkovsky | 752 | } |
753 | |||
2471 | jermar | 754 | /** Hang up a phone. |
1086 | palkovsky | 755 | * |
2471 | jermar | 756 | * @param Phone handle of the phone to be hung up. |
757 | * |
||
758 | * @return Return 0 on success or an error code. |
||
1086 | palkovsky | 759 | */ |
1780 | jermar | 760 | unative_t sys_ipc_hangup(int phoneid) |
1086 | palkovsky | 761 | { |
762 | phone_t *phone; |
||
763 | |||
764 | GET_CHECK_PHONE(phone, phoneid, return ENOENT); |
||
765 | |||
1591 | palkovsky | 766 | if (ipc_phone_hangup(phone)) |
1086 | palkovsky | 767 | return -1; |
768 | |||
769 | return 0; |
||
770 | } |
||
771 | |||
2471 | jermar | 772 | /** Wait for an incoming IPC call or an answer. |
1027 | palkovsky | 773 | * |
2359 | jermar | 774 | * @param calldata Pointer to buffer where the call/answer data is stored. |
775 | * @param usec Timeout. See waitq_sleep_timeout() for explanation. |
||
776 | * @param flags Select mode of sleep operation. See waitq_sleep_timeout() |
||
777 | * for explanation. |
||
1364 | jermar | 778 | * |
2471 | jermar | 779 | * @return Hash of the call. |
780 | * If IPC_CALLID_NOTIFICATION bit is set in the hash, the |
||
781 | * call is a notification. IPC_CALLID_ANSWERED denotes an |
||
782 | * answer. |
||
1027 | palkovsky | 783 | */ |
1780 | jermar | 784 | unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags) |
1027 | palkovsky | 785 | { |
786 | call_t *call; |
||
787 | |||
788 | restart: |
||
2359 | jermar | 789 | call = ipc_wait_for_call(&TASK->answerbox, usec, |
790 | flags | SYNCH_FLAGS_INTERRUPTIBLE); |
||
1088 | palkovsky | 791 | if (!call) |
792 | return 0; |
||
1027 | palkovsky | 793 | |
1258 | palkovsky | 794 | if (call->flags & IPC_CALL_NOTIF) { |
795 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
||
1693 | palkovsky | 796 | |
797 | /* Set in_phone_hash to the interrupt counter */ |
||
2098 | decky | 798 | call->data.phone = (void *) call->priv; |
1693 | palkovsky | 799 | |
800 | STRUCT_TO_USPACE(calldata, &call->data); |
||
801 | |||
1258 | palkovsky | 802 | ipc_call_free(call); |
803 | |||
2471 | jermar | 804 | return ((unative_t) call) | IPC_CALLID_NOTIFICATION; |
1258 | palkovsky | 805 | } |
806 | |||
1027 | palkovsky | 807 | if (call->flags & IPC_CALL_ANSWERED) { |
1090 | palkovsky | 808 | process_answer(call); |
1027 | palkovsky | 809 | |
1086 | palkovsky | 810 | ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC)); |
811 | |||
1027 | palkovsky | 812 | atomic_dec(&TASK->active_calls); |
1086 | palkovsky | 813 | |
814 | if (call->flags & IPC_CALL_DISCARD_ANSWER) { |
||
815 | ipc_call_free(call); |
||
816 | goto restart; |
||
817 | } |
||
818 | |||
819 | STRUCT_TO_USPACE(&calldata->args, &call->data.args); |
||
1027 | palkovsky | 820 | ipc_call_free(call); |
821 | |||
2471 | jermar | 822 | return ((unative_t) call) | IPC_CALLID_ANSWERED; |
1027 | palkovsky | 823 | } |
1086 | palkovsky | 824 | |
1027 | palkovsky | 825 | if (process_request(&TASK->answerbox, call)) |
826 | goto restart; |
||
1086 | palkovsky | 827 | |
1090 | palkovsky | 828 | /* Include phone address('id') of the caller in the request, |
829 | * copy whole call->data, not only call->data.args */ |
||
1396 | palkovsky | 830 | if (STRUCT_TO_USPACE(calldata, &call->data)) { |
831 | return 0; |
||
832 | } |
||
1780 | jermar | 833 | return (unative_t)call; |
1027 | palkovsky | 834 | } |
1258 | palkovsky | 835 | |
2471 | jermar | 836 | /** Connect an IRQ handler to a task. |
1923 | jermar | 837 | * |
2471 | jermar | 838 | * @param inr IRQ number. |
839 | * @param devno Device number. |
||
840 | * @param method Method to be associated with the notification. |
||
841 | * @param ucode Uspace pointer to the top-half pseudocode. |
||
1923 | jermar | 842 | * |
2471 | jermar | 843 | * @return EPERM or a return code returned by ipc_irq_register(). |
1923 | jermar | 844 | */ |
2359 | jermar | 845 | unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method, |
846 | irq_code_t *ucode) |
||
1258 | palkovsky | 847 | { |
1297 | jermar | 848 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
849 | return EPERM; |
||
850 | |||
1923 | jermar | 851 | return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode); |
1258 | palkovsky | 852 | } |
853 | |||
2471 | jermar | 854 | /** Disconnect an IRQ handler from a task. |
1923 | jermar | 855 | * |
2471 | jermar | 856 | * @param inr IRQ number. |
857 | * @param devno Device number. |
||
858 | * |
||
859 | * @return Zero on success or EPERM on error.. |
||
1923 | jermar | 860 | */ |
861 | unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno) |
||
1258 | palkovsky | 862 | { |
1297 | jermar | 863 | if (!(cap_get(TASK) & CAP_IRQ_REG)) |
864 | return EPERM; |
||
865 | |||
1923 | jermar | 866 | ipc_irq_unregister(&TASK->answerbox, inr, devno); |
1258 | palkovsky | 867 | |
868 | return 0; |
||
869 | } |
||
1702 | cejka | 870 | |
1757 | jermar | 871 | /** @} |
1702 | cejka | 872 | */ |