source: mainline/kernel/generic/src/ipc/sysipc.c@ ae66564

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ae66564 was ae66564, checked in by Jakub Jermar <jakub@…>, 9 years ago

Add reference to frame only if the action was initiated by the kernel

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