Rev 2636 | Rev 2660 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
954 | palkovsky | 1 | /* |
2071 | jermar | 2 | * Copyright (c) 2006 Ondrej Palkovsky |
954 | 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. |
||
1653 | cejka | 27 | */ |
28 | |||
29 | /** @addtogroup libc |
||
30 | * @{ |
||
31 | * @} |
||
32 | */ |
||
33 | |||
1866 | jermar | 34 | /** @addtogroup libcipc IPC |
1653 | cejka | 35 | * @brief HelenOS uspace IPC |
36 | * @{ |
||
37 | * @ingroup libc |
||
38 | */ |
||
39 | /** @file |
||
954 | palkovsky | 40 | */ |
41 | |||
1352 | palkovsky | 42 | #include <ipc/ipc.h> |
954 | palkovsky | 43 | #include <libc.h> |
999 | palkovsky | 44 | #include <malloc.h> |
45 | #include <errno.h> |
||
1352 | palkovsky | 46 | #include <libadt/list.h> |
999 | palkovsky | 47 | #include <stdio.h> |
48 | #include <unistd.h> |
||
1350 | palkovsky | 49 | #include <futex.h> |
1365 | jermar | 50 | #include <kernel/synch/synch.h> |
1463 | palkovsky | 51 | #include <async.h> |
2482 | jermar | 52 | #include <fibril.h> |
2522 | jermar | 53 | #include <assert.h> |
954 | palkovsky | 54 | |
2490 | jermar | 55 | /** |
56 | * Structures of this type are used for keeping track of sent asynchronous calls |
||
57 | * and queing unsent calls. |
||
999 | palkovsky | 58 | */ |
59 | typedef struct { |
||
60 | link_t list; |
||
61 | |||
62 | ipc_async_callback_t callback; |
||
63 | void *private; |
||
64 | union { |
||
65 | ipc_callid_t callid; |
||
66 | struct { |
||
1091 | palkovsky | 67 | ipc_call_t data; |
999 | palkovsky | 68 | int phoneid; |
69 | } msg; |
||
2471 | jermar | 70 | } u; |
2482 | jermar | 71 | fid_t fid; /**< Fibril waiting for sending this call. */ |
999 | palkovsky | 72 | } async_call_t; |
73 | |||
74 | LIST_INITIALIZE(dispatched_calls); |
||
75 | |||
2471 | jermar | 76 | /** List of asynchronous calls that were not accepted by kernel. |
77 | * |
||
78 | * It is protected by async_futex, because if the call cannot be sent into the |
||
79 | * kernel, the async framework is used automatically. |
||
1463 | palkovsky | 80 | */ |
2471 | jermar | 81 | LIST_INITIALIZE(queued_calls); |
1463 | palkovsky | 82 | |
1392 | palkovsky | 83 | static atomic_t ipc_futex = FUTEX_INITIALIZER; |
1350 | palkovsky | 84 | |
2471 | jermar | 85 | /** Make a fast synchronous call. |
86 | * |
||
2615 | jermar | 87 | * Only three payload arguments can be passed using this function. However, this |
88 | * function is faster than the generic ipc_call_sync_slow() because the payload |
||
89 | * is passed directly in registers. |
||
2471 | jermar | 90 | * |
91 | * @param phoneid Phone handle for the call. |
||
92 | * @param method Requested method. |
||
93 | * @param arg1 Service-defined payload argument. |
||
2615 | jermar | 94 | * @param arg2 Service-defined payload argument. |
95 | * @param arg3 Service-defined payload argument. |
||
96 | * @param result1 If non-NULL, the return ARG1 will be stored there. |
||
97 | * @param result2 If non-NULL, the return ARG2 will be stored there. |
||
98 | * @param result3 If non-NULL, the return ARG3 will be stored there. |
||
99 | * @param result4 If non-NULL, the return ARG4 will be stored there. |
||
100 | * @param result5 If non-NULL, the return ARG5 will be stored there. |
||
2471 | jermar | 101 | * |
102 | * @return Negative values represent errors returned by IPC. |
||
103 | * Otherwise the RETVAL of the answer is returned. |
||
104 | */ |
||
2615 | jermar | 105 | int |
106 | ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2, |
||
107 | ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2, ipcarg_t *result3, |
||
108 | ipcarg_t *result4, ipcarg_t *result5) |
||
954 | palkovsky | 109 | { |
1091 | palkovsky | 110 | ipc_call_t resdata; |
966 | palkovsky | 111 | int callres; |
112 | |||
2615 | jermar | 113 | callres = __SYSCALL6(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1, |
114 | arg2, arg3, (sysarg_t) &resdata); |
||
966 | palkovsky | 115 | if (callres) |
116 | return callres; |
||
2615 | jermar | 117 | if (result1) |
118 | *result1 = IPC_GET_ARG1(resdata); |
||
119 | if (result2) |
||
120 | *result2 = IPC_GET_ARG2(resdata); |
||
121 | if (result3) |
||
122 | *result3 = IPC_GET_ARG3(resdata); |
||
123 | if (result4) |
||
124 | *result4 = IPC_GET_ARG4(resdata); |
||
125 | if (result5) |
||
126 | *result5 = IPC_GET_ARG5(resdata); |
||
127 | |||
966 | palkovsky | 128 | return IPC_GET_RETVAL(resdata); |
954 | palkovsky | 129 | } |
130 | |||
2615 | jermar | 131 | /** Make a synchronous call transmitting 5 arguments of payload. |
2471 | jermar | 132 | * |
133 | * @param phoneid Phone handle for the call. |
||
134 | * @param method Requested method. |
||
135 | * @param arg1 Service-defined payload argument. |
||
136 | * @param arg2 Service-defined payload argument. |
||
137 | * @param arg3 Service-defined payload argument. |
||
2615 | jermar | 138 | * @param arg4 Service-defined payload argument. |
139 | * @param arg5 Service-defined payload argument. |
||
2471 | jermar | 140 | * @param result1 If non-NULL, storage for the first return argument. |
141 | * @param result2 If non-NULL, storage for the second return argument. |
||
142 | * @param result3 If non-NULL, storage for the third return argument. |
||
2615 | jermar | 143 | * @param result4 If non-NULL, storage for the fourth return argument. |
144 | * @param result5 If non-NULL, storage for the fifth return argument. |
||
2471 | jermar | 145 | * |
146 | * @return Negative value means IPC error. |
||
147 | * Otherwise the RETVAL of the answer. |
||
148 | */ |
||
2615 | jermar | 149 | int |
150 | ipc_call_sync_slow(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2, |
||
151 | ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *result1, |
||
152 | ipcarg_t *result2, ipcarg_t *result3, ipcarg_t *result4, ipcarg_t *result5) |
||
954 | palkovsky | 153 | { |
1091 | palkovsky | 154 | ipc_call_t data; |
966 | palkovsky | 155 | int callres; |
156 | |||
157 | IPC_SET_METHOD(data, method); |
||
158 | IPC_SET_ARG1(data, arg1); |
||
159 | IPC_SET_ARG2(data, arg2); |
||
160 | IPC_SET_ARG3(data, arg3); |
||
2615 | jermar | 161 | IPC_SET_ARG4(data, arg4); |
162 | IPC_SET_ARG5(data, arg5); |
||
966 | palkovsky | 163 | |
2615 | jermar | 164 | callres = __SYSCALL3(SYS_IPC_CALL_SYNC_SLOW, phoneid, (sysarg_t) &data, |
2471 | jermar | 165 | (sysarg_t) &data); |
966 | palkovsky | 166 | if (callres) |
167 | return callres; |
||
168 | |||
169 | if (result1) |
||
170 | *result1 = IPC_GET_ARG1(data); |
||
171 | if (result2) |
||
172 | *result2 = IPC_GET_ARG2(data); |
||
173 | if (result3) |
||
174 | *result3 = IPC_GET_ARG3(data); |
||
2615 | jermar | 175 | if (result4) |
176 | *result4 = IPC_GET_ARG4(data); |
||
177 | if (result5) |
||
178 | *result5 = IPC_GET_ARG5(data); |
||
179 | |||
966 | palkovsky | 180 | return IPC_GET_RETVAL(data); |
181 | } |
||
182 | |||
2471 | jermar | 183 | /** Syscall to send asynchronous message. |
184 | * |
||
185 | * @param phoneid Phone handle for the call. |
||
186 | * @param data Call data with the request. |
||
187 | * |
||
188 | * @return Hash of the call or an error code. |
||
189 | */ |
||
190 | static ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data) |
||
999 | palkovsky | 191 | { |
2618 | jermar | 192 | return __SYSCALL2(SYS_IPC_CALL_ASYNC_SLOW, phoneid, (sysarg_t) data); |
999 | palkovsky | 193 | } |
194 | |||
2471 | jermar | 195 | /** Prolog to ipc_call_async_*() functions. |
196 | * |
||
197 | * @param private Argument for the answer/error callback. |
||
198 | * @param callback Answer/error callback. |
||
199 | * |
||
200 | * @return New, partially initialized async_call structure or NULL. |
||
201 | */ |
||
202 | static inline async_call_t *ipc_prepare_async(void *private, |
||
203 | ipc_async_callback_t callback) |
||
966 | palkovsky | 204 | { |
999 | palkovsky | 205 | async_call_t *call; |
966 | palkovsky | 206 | |
999 | palkovsky | 207 | call = malloc(sizeof(*call)); |
208 | if (!call) { |
||
1443 | palkovsky | 209 | if (callback) |
210 | callback(private, ENOMEM, NULL); |
||
1489 | palkovsky | 211 | return NULL; |
999 | palkovsky | 212 | } |
1463 | palkovsky | 213 | call->callback = callback; |
214 | call->private = private; |
||
215 | |||
1489 | palkovsky | 216 | return call; |
217 | } |
||
218 | |||
2471 | jermar | 219 | /** Epilogue of ipc_call_async_*() functions. |
220 | * |
||
221 | * @param callid Value returned by the SYS_IPC_CALL_ASYNC_* syscall. |
||
222 | * @param phoneid Phone handle through which the call was made. |
||
223 | * @param call async_call structure returned by ipc_prepare_async(). |
||
2530 | jermar | 224 | * @param can_preempt If non-zero, the current fibril can be preempted in this |
225 | * call. |
||
2471 | jermar | 226 | */ |
227 | static inline void ipc_finish_async(ipc_callid_t callid, int phoneid, |
||
228 | async_call_t *call, int can_preempt) |
||
1489 | palkovsky | 229 | { |
1751 | palkovsky | 230 | if (!call) { /* Nothing to do regardless if failed or not */ |
231 | futex_up(&ipc_futex); |
||
232 | return; |
||
233 | } |
||
234 | |||
966 | palkovsky | 235 | if (callid == IPC_CALLRET_FATAL) { |
1463 | palkovsky | 236 | futex_up(&ipc_futex); |
966 | palkovsky | 237 | /* Call asynchronous handler with error code */ |
1489 | palkovsky | 238 | if (call->callback) |
239 | call->callback(call->private, ENOENT, NULL); |
||
999 | palkovsky | 240 | free(call); |
966 | palkovsky | 241 | return; |
242 | } |
||
999 | palkovsky | 243 | |
1463 | palkovsky | 244 | if (callid == IPC_CALLRET_TEMPORARY) { |
245 | futex_up(&ipc_futex); |
||
999 | palkovsky | 246 | |
247 | call->u.msg.phoneid = phoneid; |
||
1518 | palkovsky | 248 | |
1463 | palkovsky | 249 | futex_down(&async_futex); |
999 | palkovsky | 250 | list_append(&call->list, &queued_calls); |
1463 | palkovsky | 251 | |
1518 | palkovsky | 252 | if (can_preempt) { |
2482 | jermar | 253 | call->fid = fibril_get_id(); |
2568 | jermar | 254 | fibril_switch(FIBRIL_TO_MANAGER); |
1518 | palkovsky | 255 | /* Async futex unlocked by previous call */ |
256 | } else { |
||
2482 | jermar | 257 | call->fid = 0; |
1518 | palkovsky | 258 | futex_up(&async_futex); |
259 | } |
||
966 | palkovsky | 260 | return; |
261 | } |
||
999 | palkovsky | 262 | call->u.callid = callid; |
2471 | jermar | 263 | /* Add call to the list of dispatched calls */ |
999 | palkovsky | 264 | list_append(&call->list, &dispatched_calls); |
1350 | palkovsky | 265 | futex_up(&ipc_futex); |
1489 | palkovsky | 266 | |
954 | palkovsky | 267 | } |
268 | |||
2471 | jermar | 269 | /** Make a fast asynchronous call. |
1489 | palkovsky | 270 | * |
2618 | jermar | 271 | * This function can only handle four arguments of payload. It is, however, |
272 | * faster than the more generic ipc_call_async_slow(). |
||
2471 | jermar | 273 | * |
274 | * Note that this function is a void function. |
||
275 | * During normal opertation, answering this call will trigger the callback. |
||
276 | * In case of fatal error, call the callback handler with the proper error code. |
||
277 | * If the call cannot be temporarily made, queue it. |
||
278 | * |
||
279 | * @param phoneid Phone handle for the call. |
||
280 | * @param method Requested method. |
||
281 | * @param arg1 Service-defined payload argument. |
||
282 | * @param arg2 Service-defined payload argument. |
||
2618 | jermar | 283 | * @param arg3 Service-defined payload argument. |
284 | * @param arg4 Service-defined payload argument. |
||
2471 | jermar | 285 | * @param private Argument to be passed to the answer/error callback. |
286 | * @param callback Answer or error callback. |
||
2530 | jermar | 287 | * @param can_preempt If non-zero, the current fibril will be preempted in |
288 | * case the kernel temporarily refuses to accept more |
||
2471 | jermar | 289 | * asynchronous calls. |
1489 | palkovsky | 290 | */ |
2618 | jermar | 291 | void ipc_call_async_fast(int phoneid, ipcarg_t method, ipcarg_t arg1, |
292 | ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, void *private, |
||
293 | ipc_async_callback_t callback, int can_preempt) |
||
1489 | palkovsky | 294 | { |
1751 | palkovsky | 295 | async_call_t *call = NULL; |
1489 | palkovsky | 296 | ipc_callid_t callid; |
966 | palkovsky | 297 | |
1751 | palkovsky | 298 | if (callback) { |
299 | call = ipc_prepare_async(private, callback); |
||
300 | if (!call) |
||
301 | return; |
||
302 | } |
||
1489 | palkovsky | 303 | |
2471 | jermar | 304 | /* |
305 | * We need to make sure that we get callid before another thread |
||
306 | * accesses the queue again. |
||
307 | */ |
||
1489 | palkovsky | 308 | futex_down(&ipc_futex); |
2618 | jermar | 309 | callid = __SYSCALL6(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1, |
310 | arg2, arg3, arg4); |
||
1489 | palkovsky | 311 | |
312 | if (callid == IPC_CALLRET_TEMPORARY) { |
||
1751 | palkovsky | 313 | if (!call) { |
314 | call = ipc_prepare_async(private, callback); |
||
315 | if (!call) |
||
316 | return; |
||
317 | } |
||
1489 | palkovsky | 318 | IPC_SET_METHOD(call->u.msg.data, method); |
319 | IPC_SET_ARG1(call->u.msg.data, arg1); |
||
320 | IPC_SET_ARG2(call->u.msg.data, arg2); |
||
2618 | jermar | 321 | IPC_SET_ARG3(call->u.msg.data, arg3); |
322 | IPC_SET_ARG4(call->u.msg.data, arg4); |
||
2620 | jermar | 323 | /* |
324 | * To achieve deterministic behavior, we always zero out the |
||
325 | * arguments that are beyond the limits of the fast version. |
||
326 | */ |
||
327 | IPC_SET_ARG5(call->u.msg.data, 0); |
||
1489 | palkovsky | 328 | } |
1518 | palkovsky | 329 | ipc_finish_async(callid, phoneid, call, can_preempt); |
1489 | palkovsky | 330 | } |
331 | |||
2471 | jermar | 332 | /** Make an asynchronous call transmitting the entire payload. |
1489 | palkovsky | 333 | * |
2471 | jermar | 334 | * Note that this function is a void function. |
335 | * During normal opertation, answering this call will trigger the callback. |
||
336 | * In case of fatal error, call the callback handler with the proper error code. |
||
337 | * If the call cannot be temporarily made, queue it. |
||
338 | * |
||
339 | * @param phoneid Phone handle for the call. |
||
340 | * @param method Requested method. |
||
341 | * @param arg1 Service-defined payload argument. |
||
342 | * @param arg2 Service-defined payload argument. |
||
343 | * @param arg3 Service-defined payload argument. |
||
2618 | jermar | 344 | * @param arg4 Service-defined payload argument. |
345 | * @param arg5 Service-defined payload argument. |
||
2471 | jermar | 346 | * @param private Argument to be passed to the answer/error callback. |
347 | * @param callback Answer or error callback. |
||
2530 | jermar | 348 | * @param can_preempt If non-zero, the current fibril will be preempted in |
349 | * case the kernel temporarily refuses to accept more |
||
2471 | jermar | 350 | * asynchronous calls. |
351 | * |
||
1489 | palkovsky | 352 | */ |
2618 | jermar | 353 | void ipc_call_async_slow(int phoneid, ipcarg_t method, ipcarg_t arg1, |
354 | ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, void *private, |
||
355 | ipc_async_callback_t callback, int can_preempt) |
||
1489 | palkovsky | 356 | { |
357 | async_call_t *call; |
||
358 | ipc_callid_t callid; |
||
359 | |||
360 | call = ipc_prepare_async(private, callback); |
||
361 | if (!call) |
||
362 | return; |
||
363 | |||
364 | IPC_SET_METHOD(call->u.msg.data, method); |
||
365 | IPC_SET_ARG1(call->u.msg.data, arg1); |
||
366 | IPC_SET_ARG2(call->u.msg.data, arg2); |
||
367 | IPC_SET_ARG3(call->u.msg.data, arg3); |
||
2618 | jermar | 368 | IPC_SET_ARG4(call->u.msg.data, arg4); |
369 | IPC_SET_ARG5(call->u.msg.data, arg5); |
||
2471 | jermar | 370 | /* |
2618 | jermar | 371 | * We need to make sure that we get callid before another thread |
372 | * accesses the queue again. |
||
2471 | jermar | 373 | */ |
1489 | palkovsky | 374 | futex_down(&ipc_futex); |
375 | callid = _ipc_call_async(phoneid, &call->u.msg.data); |
||
376 | |||
1518 | palkovsky | 377 | ipc_finish_async(callid, phoneid, call, can_preempt); |
1489 | palkovsky | 378 | } |
379 | |||
380 | |||
2471 | jermar | 381 | /** Answer a received call - fast version. |
1343 | jermar | 382 | * |
2619 | jermar | 383 | * The fast answer makes use of passing retval and first four arguments in |
384 | * registers. If you need to return more, use the ipc_answer_slow() instead. |
||
1343 | jermar | 385 | * |
2471 | jermar | 386 | * @param callid Hash of the call being answered. |
387 | * @param retval Return value. |
||
388 | * @param arg1 First return argument. |
||
389 | * @param arg2 Second return argument. |
||
2619 | jermar | 390 | * @param arg3 Third return argument. |
391 | * @param arg4 Fourth return argument. |
||
1343 | jermar | 392 | * |
2471 | jermar | 393 | * @return Zero on success or a value from @ref errno.h on failure. |
1343 | jermar | 394 | */ |
395 | ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1, |
||
2619 | jermar | 396 | ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4) |
954 | palkovsky | 397 | { |
2619 | jermar | 398 | return __SYSCALL6(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2, arg3, |
399 | arg4); |
||
954 | palkovsky | 400 | } |
401 | |||
2619 | jermar | 402 | /** Answer a received call - slow full version. |
1343 | jermar | 403 | * |
2471 | jermar | 404 | * @param callid Hash of the call being answered. |
2619 | jermar | 405 | * @param retval Return value. |
406 | * @param arg1 First return argument. |
||
407 | * @param arg2 Second return argument. |
||
408 | * @param arg3 Third return argument. |
||
409 | * @param arg4 Fourth return argument. |
||
410 | * @param arg5 Fifth return argument. |
||
1343 | jermar | 411 | * |
2471 | jermar | 412 | * @return Zero on success or a value from @ref errno.h on failure. |
1343 | jermar | 413 | */ |
2619 | jermar | 414 | ipcarg_t ipc_answer_slow(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1, |
415 | ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5) |
||
1343 | jermar | 416 | { |
2619 | jermar | 417 | ipc_call_t data; |
418 | |||
419 | IPC_SET_RETVAL(data, retval); |
||
420 | IPC_SET_ARG1(data, arg1); |
||
421 | IPC_SET_ARG2(data, arg2); |
||
422 | IPC_SET_ARG3(data, arg3); |
||
423 | IPC_SET_ARG4(data, arg4); |
||
424 | IPC_SET_ARG5(data, arg5); |
||
425 | |||
426 | return __SYSCALL2(SYS_IPC_ANSWER_SLOW, callid, (sysarg_t) &data); |
||
1343 | jermar | 427 | } |
428 | |||
429 | |||
2471 | jermar | 430 | /** Try to dispatch queued calls from the async queue. */ |
999 | palkovsky | 431 | static void try_dispatch_queued_calls(void) |
432 | { |
||
433 | async_call_t *call; |
||
434 | ipc_callid_t callid; |
||
435 | |||
2471 | jermar | 436 | /** @todo |
437 | * Integrate intelligently ipc_futex, so that it is locked during |
||
438 | * ipc_call_async_*(), until it is added to dispatched_calls. |
||
1463 | palkovsky | 439 | */ |
440 | futex_down(&async_futex); |
||
999 | palkovsky | 441 | while (!list_empty(&queued_calls)) { |
2471 | jermar | 442 | call = list_get_instance(queued_calls.next, async_call_t, list); |
2620 | jermar | 443 | callid = _ipc_call_async(call->u.msg.phoneid, |
444 | &call->u.msg.data); |
||
1463 | palkovsky | 445 | if (callid == IPC_CALLRET_TEMPORARY) { |
999 | palkovsky | 446 | break; |
1463 | palkovsky | 447 | } |
999 | palkovsky | 448 | list_remove(&call->list); |
1350 | palkovsky | 449 | |
1463 | palkovsky | 450 | futex_up(&async_futex); |
2482 | jermar | 451 | if (call->fid) |
452 | fibril_add_ready(call->fid); |
||
1463 | palkovsky | 453 | |
999 | palkovsky | 454 | if (callid == IPC_CALLRET_FATAL) { |
1443 | palkovsky | 455 | if (call->callback) |
456 | call->callback(call->private, ENOENT, NULL); |
||
999 | palkovsky | 457 | free(call); |
458 | } else { |
||
459 | call->u.callid = callid; |
||
1463 | palkovsky | 460 | futex_down(&ipc_futex); |
999 | palkovsky | 461 | list_append(&call->list, &dispatched_calls); |
1463 | palkovsky | 462 | futex_up(&ipc_futex); |
999 | palkovsky | 463 | } |
1463 | palkovsky | 464 | futex_down(&async_futex); |
999 | palkovsky | 465 | } |
1463 | palkovsky | 466 | futex_up(&async_futex); |
999 | palkovsky | 467 | } |
468 | |||
2471 | jermar | 469 | /** Handle a received answer. |
999 | palkovsky | 470 | * |
2471 | jermar | 471 | * Find the hash of the answer and call the answer callback. |
999 | palkovsky | 472 | * |
2471 | jermar | 473 | * @todo Make it use hash table. |
474 | * |
||
475 | * @param callid Hash of the received answer. |
||
476 | * The answer has the same hash as the request OR'ed with |
||
477 | * the IPC_CALLID_ANSWERED bit. |
||
478 | * @param data Call data of the answer. |
||
999 | palkovsky | 479 | */ |
1091 | palkovsky | 480 | static void handle_answer(ipc_callid_t callid, ipc_call_t *data) |
999 | palkovsky | 481 | { |
482 | link_t *item; |
||
483 | async_call_t *call; |
||
484 | |||
485 | callid &= ~IPC_CALLID_ANSWERED; |
||
486 | |||
1350 | palkovsky | 487 | futex_down(&ipc_futex); |
999 | palkovsky | 488 | for (item = dispatched_calls.next; item != &dispatched_calls; |
2471 | jermar | 489 | item = item->next) { |
999 | palkovsky | 490 | call = list_get_instance(item, async_call_t, list); |
491 | if (call->u.callid == callid) { |
||
492 | list_remove(&call->list); |
||
1350 | palkovsky | 493 | futex_up(&ipc_futex); |
1443 | palkovsky | 494 | if (call->callback) |
495 | call->callback(call->private, |
||
2471 | jermar | 496 | IPC_GET_RETVAL(*data), data); |
1443 | palkovsky | 497 | free(call); |
999 | palkovsky | 498 | return; |
499 | } |
||
500 | } |
||
1350 | palkovsky | 501 | futex_up(&ipc_futex); |
999 | palkovsky | 502 | } |
503 | |||
504 | |||
2471 | jermar | 505 | /** Wait for a first call to come. |
954 | palkovsky | 506 | * |
2471 | jermar | 507 | * @param call Storage where the incoming call data will be stored. |
508 | * @param usec Timeout in microseconds |
||
509 | * @param flags Flags passed to SYS_IPC_WAIT (blocking, nonblocking). |
||
510 | * |
||
511 | * @return Hash of the call. Note that certain bits have special |
||
512 | * meaning. IPC_CALLID_ANSWERED will be set in an answer |
||
513 | * and IPC_CALLID_NOTIFICATION is used for notifications. |
||
514 | * |
||
954 | palkovsky | 515 | */ |
1392 | palkovsky | 516 | ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags) |
954 | palkovsky | 517 | { |
518 | ipc_callid_t callid; |
||
519 | |||
1392 | palkovsky | 520 | callid = __SYSCALL3(SYS_IPC_WAIT, (sysarg_t) call, usec, flags); |
521 | /* Handle received answers */ |
||
1463 | palkovsky | 522 | if (callid & IPC_CALLID_ANSWERED) { |
1392 | palkovsky | 523 | handle_answer(callid, call); |
1463 | palkovsky | 524 | try_dispatch_queued_calls(); |
525 | } |
||
999 | palkovsky | 526 | |
954 | palkovsky | 527 | return callid; |
528 | } |
||
1028 | palkovsky | 529 | |
1365 | jermar | 530 | /** Wait some time for an IPC call. |
531 | * |
||
2471 | jermar | 532 | * The call will return after an answer is received. |
1709 | jermar | 533 | * |
2471 | jermar | 534 | * @param call Storage where the incoming call data will be stored. |
535 | * @param usec Timeout in microseconds. |
||
536 | * |
||
537 | * @return Hash of the answer. |
||
1365 | jermar | 538 | */ |
539 | ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *call, uint32_t usec) |
||
540 | { |
||
541 | ipc_callid_t callid; |
||
542 | |||
543 | do { |
||
1503 | jermar | 544 | callid = ipc_wait_cycle(call, usec, SYNCH_FLAGS_NONE); |
1365 | jermar | 545 | } while (callid & IPC_CALLID_ANSWERED); |
546 | |||
547 | return callid; |
||
548 | } |
||
549 | |||
550 | /** Check if there is an IPC call waiting to be picked up. |
||
551 | * |
||
2471 | jermar | 552 | * @param call Storage where the incoming call will be stored. |
553 | * @return Hash of the answer. |
||
1365 | jermar | 554 | */ |
555 | ipc_callid_t ipc_trywait_for_call(ipc_call_t *call) |
||
556 | { |
||
557 | ipc_callid_t callid; |
||
558 | |||
559 | do { |
||
2471 | jermar | 560 | callid = ipc_wait_cycle(call, SYNCH_NO_TIMEOUT, |
561 | SYNCH_FLAGS_NON_BLOCKING); |
||
1365 | jermar | 562 | } while (callid & IPC_CALLID_ANSWERED); |
563 | |||
564 | return callid; |
||
565 | } |
||
566 | |||
2359 | jermar | 567 | /** Ask destination to do a callback connection. |
1091 | palkovsky | 568 | * |
2471 | jermar | 569 | * @param phoneid Phone handle used for contacting the other side. |
570 | * @param arg1 Service-defined argument. |
||
571 | * @param arg2 Service-defined argument. |
||
2637 | cejka | 572 | * @param arg3 Service-defined argument. |
2471 | jermar | 573 | * @param phonehash Storage where the library will store an opaque |
2359 | jermar | 574 | * identifier of the phone that will be used for incoming |
2471 | jermar | 575 | * calls. This identifier can be used for connection |
576 | * tracking. |
||
577 | * |
||
578 | * @return Zero on success or a negative error code. |
||
1091 | palkovsky | 579 | */ |
2637 | cejka | 580 | int ipc_connect_to_me(int phoneid, int arg1, int arg2, int arg3, |
581 | ipcarg_t *phonehash) |
||
1028 | palkovsky | 582 | { |
2637 | cejka | 583 | return ipc_call_sync_3_5(phoneid, IPC_M_CONNECT_TO_ME, arg1, arg2, |
584 | arg3, NULL, NULL, NULL, NULL, phonehash); |
||
1028 | palkovsky | 585 | } |
1061 | palkovsky | 586 | |
2359 | jermar | 587 | /** Ask through phone for a new connection to some service. |
1091 | palkovsky | 588 | * |
2471 | jermar | 589 | * @param phoneid Phone handle used for contacting the other side. |
2359 | jermar | 590 | * @param arg1 User defined argument. |
591 | * @param arg2 User defined argument. |
||
2635 | cejka | 592 | * @param arg3 User defined argument. |
2359 | jermar | 593 | * |
2471 | jermar | 594 | * @return New phone handle on success or a negative error code. |
1091 | palkovsky | 595 | */ |
2635 | cejka | 596 | int ipc_connect_me_to(int phoneid, int arg1, int arg2, int arg3) |
1061 | palkovsky | 597 | { |
1092 | palkovsky | 598 | ipcarg_t newphid; |
1091 | palkovsky | 599 | int res; |
600 | |||
2635 | cejka | 601 | res = ipc_call_sync_3_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3, |
2636 | jermar | 602 | NULL, NULL, NULL, NULL, &newphid); |
1091 | palkovsky | 603 | if (res) |
604 | return res; |
||
605 | return newphid; |
||
1061 | palkovsky | 606 | } |
607 | |||
2471 | jermar | 608 | /** Hang up a phone. |
609 | * |
||
610 | * @param phoneid Handle of the phone to be hung up. |
||
611 | * |
||
612 | * @return Zero on success or a negative error code. |
||
613 | */ |
||
1089 | palkovsky | 614 | int ipc_hangup(int phoneid) |
615 | { |
||
616 | return __SYSCALL1(SYS_IPC_HANGUP, phoneid); |
||
617 | } |
||
1259 | palkovsky | 618 | |
1923 | jermar | 619 | /** Register IRQ notification. |
620 | * |
||
2471 | jermar | 621 | * @param inr IRQ number. |
622 | * @param devno Device number of the device generating inr. |
||
623 | * @param method Use this method for notifying me. |
||
624 | * @param ucode Top-half pseudocode handler. |
||
1923 | jermar | 625 | * |
2471 | jermar | 626 | * @return Value returned by the kernel. |
1923 | jermar | 627 | */ |
628 | int ipc_register_irq(int inr, int devno, int method, irq_code_t *ucode) |
||
1259 | palkovsky | 629 | { |
2471 | jermar | 630 | return __SYSCALL4(SYS_IPC_REGISTER_IRQ, inr, devno, method, |
631 | (sysarg_t) ucode); |
||
1259 | palkovsky | 632 | } |
633 | |||
1923 | jermar | 634 | /** Unregister IRQ notification. |
635 | * |
||
2471 | jermar | 636 | * @param inr IRQ number. |
637 | * @param devno Device number of the device generating inr. |
||
1923 | jermar | 638 | * |
2471 | jermar | 639 | * @return Value returned by the kernel. |
1923 | jermar | 640 | */ |
641 | int ipc_unregister_irq(int inr, int devno) |
||
1259 | palkovsky | 642 | { |
1923 | jermar | 643 | return __SYSCALL2(SYS_IPC_UNREGISTER_IRQ, inr, devno); |
1259 | palkovsky | 644 | } |
1330 | palkovsky | 645 | |
2471 | jermar | 646 | /** Forward a received call to another destination. |
647 | * |
||
648 | * @param callid Hash of the call to forward. |
||
649 | * @param phoneid Phone handle to use for forwarding. |
||
650 | * @param method New method for the forwarded call. |
||
651 | * @param arg1 New value of the first argument for the forwarded call. |
||
2635 | cejka | 652 | * @param arg2 New value of the second argument for the forwarded call. |
2622 | jermar | 653 | * @param mode Flags specifying mode of the forward operation. |
2471 | jermar | 654 | * |
655 | * @return Zero on success or an error code. |
||
656 | * |
||
2636 | jermar | 657 | * For non-system methods, the old method, arg1 and arg2 are rewritten by the |
658 | * new values. For system methods, the new method, arg1 and arg2 are written |
||
2635 | cejka | 659 | * to the old arg1, arg2 and arg3, respectivelly. Calls with immutable |
660 | * methods are forwarded verbatim. |
||
2471 | jermar | 661 | */ |
2620 | jermar | 662 | int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method, |
2635 | cejka | 663 | ipcarg_t arg1, ipcarg_t arg2, int mode) |
1336 | jermar | 664 | { |
2635 | cejka | 665 | return __SYSCALL6(SYS_IPC_FORWARD_FAST, callid, phoneid, method, arg1, |
2636 | jermar | 666 | arg2, mode); |
1336 | jermar | 667 | } |
668 | |||
2531 | jermar | 669 | /** Wrapper for making IPC_M_DATA_SEND calls. |
2522 | jermar | 670 | * |
2531 | jermar | 671 | * @param phoneid Phone that will be used to contact the receiving side. |
672 | * @param src Address of the beginning of the source buffer. |
||
673 | * @param size Size of the source buffer. |
||
674 | * |
||
675 | * @return Zero on success or a negative error code from errno.h. |
||
676 | */ |
||
677 | int ipc_data_send(int phoneid, void *src, size_t size) |
||
678 | { |
||
2615 | jermar | 679 | return ipc_call_sync_3_0(phoneid, IPC_M_DATA_SEND, 0, (ipcarg_t) src, |
680 | (ipcarg_t) size); |
||
2531 | jermar | 681 | } |
682 | |||
683 | /** Wrapper for receiving the IPC_M_DATA_SEND calls. |
||
684 | * |
||
685 | * This wrapper only makes it more comfortable to receive IPC_M_DATA_SEND calls |
||
2522 | jermar | 686 | * so that the user doesn't have to remember the meaning of each IPC argument. |
687 | * |
||
688 | * So far, this wrapper is to be used from within a connection fibril. |
||
689 | * |
||
690 | * @param callid Storage where the hash of the IPC_M_DATA_SEND call will |
||
691 | * be stored. |
||
692 | * @param dst Storage where the suggested destination address will |
||
693 | * be stored. May be NULL. |
||
694 | * @param size Storage where the suggested size will be stored. May be |
||
695 | * NULL |
||
696 | * |
||
697 | * @return Non-zero on success, zero on failure. |
||
698 | */ |
||
2619 | jermar | 699 | int ipc_data_receive(ipc_callid_t *callid, void **dst, size_t *size) |
2522 | jermar | 700 | { |
2619 | jermar | 701 | ipc_call_t data; |
702 | |||
2522 | jermar | 703 | assert(callid); |
704 | |||
2619 | jermar | 705 | *callid = async_get_call(&data); |
706 | if (IPC_GET_METHOD(data) != IPC_M_DATA_SEND) |
||
2522 | jermar | 707 | return 0; |
708 | if (dst) |
||
2619 | jermar | 709 | *dst = (void *) IPC_GET_ARG1(data); |
2522 | jermar | 710 | if (size) |
2619 | jermar | 711 | *size = (size_t) IPC_GET_ARG3(data); |
2522 | jermar | 712 | return 1; |
713 | } |
||
714 | |||
715 | /** Wrapper for answering the IPC_M_DATA_SEND calls. |
||
716 | * |
||
717 | * This wrapper only makes it more comfortable to answer IPC_M_DATA_SEND calls |
||
718 | * so that the user doesn't have to remember the meaning of each IPC argument. |
||
719 | * |
||
720 | * @param callid Hash of the IPC_M_DATA_SEND call to answer. |
||
721 | * @param dst Final destination address for the IPC_M_DATA_SEND call. |
||
722 | * @param size Final size for the IPC_M_DATA_SEND call. |
||
723 | * |
||
724 | * @return Zero on success or a value from @ref errno.h on failure. |
||
725 | */ |
||
2619 | jermar | 726 | ipcarg_t ipc_data_deliver(ipc_callid_t callid, void *dst, size_t size) |
2522 | jermar | 727 | { |
2619 | jermar | 728 | return ipc_answer_3(callid, EOK, (ipcarg_t) dst, 0, (ipcarg_t) size); |
2522 | jermar | 729 | } |
730 | |||
1866 | jermar | 731 | /** @} |
1653 | cejka | 732 | */ |