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