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

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

Factor out dealing with call→buffer from process_answer() to
respective IPC_M_CONNECT_ME_TO and IPC_M_DEBUG ops routines.

  • Property mode set to 100644
File size: 21.3 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>
[162f919]42#include <ipc/irq.h>
[4e49572]43#include <ipc/ipcrsc.h>
[fdd4898]44#include <ipc/event.h>
[e028660]45#include <ipc/kbox.h>
[057d21a]46#include <synch/waitq.h>
[5626277]47#include <arch/interrupt.h>
[e3c762cd]48#include <syscall/copy.h>
[2bb8648]49#include <security/cap.h>
[6b10dab]50#include <console/console.h>
[253f35a1]51#include <print.h>
[e2ab36f1]52#include <macros.h>
[2d5a54f3]53
[da1bafb]54#define STRUCT_TO_USPACE(dst, src) copy_to_uspace((dst), (src), sizeof(*(src)))
[7918fce]55
[228e490]56/** Decide if the interface and method is a system method.
[8b243f2]57 *
[228e490]58 * @param imethod Interface and method to be decided.
[da1bafb]59 *
[228e490]60 * @return True if the interface and method is a system
61 * interface and method.
[8b243f2]62 *
63 */
[228e490]64static inline bool method_is_system(sysarg_t imethod)
[2ba7810]65{
[228e490]66 if (imethod <= IPC_M_LAST_SYSTEM)
[da1bafb]67 return true;
68
69 return false;
[2ba7810]70}
71
[228e490]72/** Decide if the message with this interface and method is forwardable.
[2ba7810]73 *
[228e490]74 * Some system messages may be forwarded, for some of them
75 * it is useless.
[8b243f2]76 *
[228e490]77 * @param imethod Interface and method to be decided.
[da1bafb]78 *
[228e490]79 * @return True if the interface and method is forwardable.
[8b243f2]80 *
[2ba7810]81 */
[228e490]82static inline bool method_is_forwardable(sysarg_t imethod)
[2ba7810]83{
[228e490]84 switch (imethod) {
[2c0e5d2]85 case IPC_M_CONNECTION_CLONE:
[6aae539d]86 case IPC_M_CLONE_ESTABLISH:
[7918fce]87 case IPC_M_PHONE_HUNGUP:
88 /* This message is meant only for the original recipient. */
[da1bafb]89 return false;
[7918fce]90 default:
[da1bafb]91 return true;
[7918fce]92 }
[2ba7810]93}
94
[228e490]95/** Decide if the message with this interface and method is immutable on forward.
[0dc4258]96 *
[228e490]97 * Some system messages may be forwarded but their content cannot be altered.
[0dc4258]98 *
[228e490]99 * @param imethod Interface and method to be decided.
[da1bafb]100 *
[228e490]101 * @return True if the interface and method is immutable on forward.
[0dc4258]102 *
103 */
[228e490]104static inline bool method_is_immutable(sysarg_t imethod)
[0dc4258]105{
[228e490]106 switch (imethod) {
[27d293a]107 case IPC_M_SHARE_OUT:
108 case IPC_M_SHARE_IN:
[36d852c]109 case IPC_M_DATA_WRITE:
110 case IPC_M_DATA_READ:
[fdd4898]111 case IPC_M_STATE_CHANGE_AUTHORIZE:
[da1bafb]112 return true;
[0dc4258]113 default:
[da1bafb]114 return false;
[0dc4258]115 }
116}
117
[2d5a54f3]118
[8b243f2]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 *
[da1bafb]126 * @param call Call structure to be decided.
127 *
128 * @return true if the old call contents should be saved.
[8b243f2]129 *
[2d5a54f3]130 */
[da1bafb]131static inline bool answer_need_old(call_t *call)
[2d5a54f3]132{
[228e490]133 switch (IPC_GET_IMETHOD(call->data)) {
[2c0e5d2]134 case IPC_M_CONNECTION_CLONE:
[6aae539d]135 case IPC_M_CLONE_ESTABLISH:
[7918fce]136 case IPC_M_CONNECT_TO_ME:
137 case IPC_M_CONNECT_ME_TO:
[27d293a]138 case IPC_M_SHARE_OUT:
139 case IPC_M_SHARE_IN:
[36d852c]140 case IPC_M_DATA_WRITE:
141 case IPC_M_DATA_READ:
[fdd4898]142 case IPC_M_STATE_CHANGE_AUTHORIZE:
[da1bafb]143 return true;
[7918fce]144 default:
[da1bafb]145 return false;
[7918fce]146 }
[2d5a54f3]147}
148
[8b243f2]149/** Interpret process answer as control information.
150 *
151 * This function is called directly after sys_ipc_answer().
[46fc2f9]152 *
[da1bafb]153 * @param answer Call structure with the answer.
154 * @param olddata Saved data of the request.
155 *
[9956fad9]156 * @return Return EOK on success or a negative error code.
[8b243f2]157 *
[46fc2f9]158 */
[9956fad9]159static int answer_preprocess(call_t *answer, ipc_data_t *olddata)
[2d5a54f3]160{
[9956fad9]161 int rc = EOK;
162
[2405bb5]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);
[e8039a86]169 /* TODO: cleanup? */
[2405bb5]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
[6c441cf8]180 if ((native_t) IPC_GET_RETVAL(answer->data) == EHANGUP) {
[ca687ad]181 /* In case of forward, hangup the forwared phone,
182 * not the originator
183 */
[ff48a15]184 mutex_lock(&answer->data.phone->lock);
[da1bafb]185 irq_spinlock_lock(&TASK->answerbox.lock, true);
[eb3d379]186 if (answer->data.phone->state == IPC_PHONE_CONNECTED) {
[c4e4507]187 list_remove(&answer->data.phone->link);
[eb3d379]188 answer->data.phone->state = IPC_PHONE_SLAMMED;
[ca687ad]189 }
[da1bafb]190 irq_spinlock_unlock(&TASK->answerbox.lock, true);
[ff48a15]191 mutex_unlock(&answer->data.phone->lock);
[9f22213]192 }
[da1bafb]193
[2405bb5]194 if (!olddata) {
195 task_release(answer->sender);
[9956fad9]196 return rc;
[2405bb5]197 }
[da1bafb]198
[e8039a86]199
[32e4643]200 sysipc_ops_t *ops = sysipc_ops_get(answer->request_method);
[e8039a86]201 if (ops->answer_preprocess)
202 rc = ops->answer_preprocess(answer, olddata);
[da1bafb]203
[2405bb5]204 task_release(answer->sender);
205
[9956fad9]206 return rc;
[2d5a54f3]207}
208
[8b243f2]209/** Called before the request is sent.
210 *
[da1bafb]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.
[7c7aae16]215 *
216 */
[9a1b20c]217static int request_preprocess(call_t *call, phone_t *phone)
[7c7aae16]218{
[924c2530]219 int rc = EOK;
220
[32e4643]221 call->request_method = IPC_GET_IMETHOD(call->data);
222
223 sysipc_ops_t *ops = sysipc_ops_get(call->request_method);
[e8039a86]224 if (ops->request_preprocess)
225 rc = ops->request_preprocess(call, phone);
[da1bafb]226
[924c2530]227 return rc;
[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
[32e4643]245 sysipc_ops_t *ops = sysipc_ops_get(call->request_method);
246 if (ops->answer_process)
247 (void) ops->answer_process(call);
[2d5a54f3]248}
249
[691d8d8]250
[8b243f2]251/** Do basic kernel processing of received call request.
252 *
[da1bafb]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.
[2d5a54f3]258 *
259 */
[51ec40f]260static int process_request(answerbox_t *box, call_t *call)
[2d5a54f3]261{
[691d8d8]262 int rc = EOK;
263
[32e4643]264 sysipc_ops_t *ops = sysipc_ops_get(call->request_method);
[e8039a86]265 if (ops->request_process)
266 rc = ops->request_process(call, box);
[da1bafb]267
[691d8d8]268 return rc;
[2d5a54f3]269}
270
[97d17fe]271/** Check that the task did not exceed the allowed limit of asynchronous calls
272 * made over a phone.
[2d5a54f3]273 *
[228e490]274 * @param phone Phone to check the limit against.
275 *
[da1bafb]276 * @return 0 if limit not reached or -1 if limit exceeded.
277 *
[2d5a54f3]278 */
[97d17fe]279static int check_call_limit(phone_t *phone)
[2d5a54f3]280{
[97d17fe]281 if (atomic_get(&phone->active_calls) >= IPC_MAX_ASYNC_CALLS)
[2d5a54f3]282 return -1;
[da1bafb]283
[2d5a54f3]284 return 0;
285}
286
[8b243f2]287/** Make a fast asynchronous call over IPC.
[2d5a54f3]288 *
[3209923]289 * This function can only handle four arguments of payload, but is faster than
290 * the generic function sys_ipc_call_async_slow().
[8b243f2]291 *
[da1bafb]292 * @param phoneid Phone handle for the call.
[228e490]293 * @param imethod Interface and method of the call.
[da1bafb]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 *
[2d5a54f3]304 */
[228e490]305sysarg_t sys_ipc_call_async_fast(sysarg_t phoneid, sysarg_t imethod,
[96b02eb9]306 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
[2d5a54f3]307{
[da1bafb]308 phone_t *phone;
[c9fff17]309 if (phone_get(phoneid, &phone) != EOK)
310 return IPC_CALLRET_FATAL;
[228e490]311
[97d17fe]312 if (check_call_limit(phone))
313 return IPC_CALLRET_TEMPORARY;
[da1bafb]314
315 call_t *call = ipc_call_alloc(0);
[228e490]316 IPC_SET_IMETHOD(call->data, imethod);
[2d5a54f3]317 IPC_SET_ARG1(call->data, arg1);
318 IPC_SET_ARG2(call->data, arg2);
[3209923]319 IPC_SET_ARG3(call->data, arg3);
320 IPC_SET_ARG4(call->data, arg4);
[da1bafb]321
[8498915]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);
[da1bafb]327
328 int res = request_preprocess(call, phone);
329
330 if (!res)
[7c7aae16]331 ipc_call(phone, call);
332 else
333 ipc_backsend_err(phone, call, res);
[da1bafb]334
[96b02eb9]335 return (sysarg_t) call;
[2d5a54f3]336}
337
[8b243f2]338/** Make an asynchronous IPC call allowing to transmit the entire payload.
339 *
[da1bafb]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().
[2d5a54f3]344 *
345 */
[96b02eb9]346sysarg_t sys_ipc_call_async_slow(sysarg_t phoneid, ipc_data_t *data)
[2d5a54f3]347{
[da1bafb]348 phone_t *phone;
[c9fff17]349 if (phone_get(phoneid, &phone) != EOK)
350 return IPC_CALLRET_FATAL;
[4e49572]351
[97d17fe]352 if (check_call_limit(phone))
353 return IPC_CALLRET_TEMPORARY;
354
[da1bafb]355 call_t *call = ipc_call_alloc(0);
356 int rc = copy_from_uspace(&call->data.args, &data->args,
[51ec40f]357 sizeof(call->data.args));
[f58af46]358 if (rc != 0) {
359 ipc_call_free(call);
[96b02eb9]360 return (sysarg_t) rc;
[f58af46]361 }
[da1bafb]362
363 int res = request_preprocess(call, phone);
364
365 if (!res)
[7c7aae16]366 ipc_call(phone, call);
367 else
368 ipc_backsend_err(phone, call, res);
[da1bafb]369
[96b02eb9]370 return (sysarg_t) call;
[2d5a54f3]371}
372
[da1bafb]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.
[228e490]379 * @param imethod New interface and method to use for the forwarded call.
[da1bafb]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 *
[2ba7810]394 */
[96b02eb9]395static sysarg_t sys_ipc_forward_common(sysarg_t callid, sysarg_t phoneid,
[228e490]396 sysarg_t imethod, sysarg_t arg1, sysarg_t arg2, sysarg_t arg3,
[96b02eb9]397 sysarg_t arg4, sysarg_t arg5, unsigned int mode, bool slow)
[2ba7810]398{
[da1bafb]399 call_t *call = get_call(callid);
[2ba7810]400 if (!call)
401 return ENOENT;
[48daf64]402
[9f22213]403 call->flags |= IPC_CALL_FORWARDED;
[da1bafb]404
405 phone_t *phone;
[c9fff17]406 if (phone_get(phoneid, &phone) != EOK) {
[2ba7810]407 IPC_SET_RETVAL(call->data, EFORWARD);
408 ipc_answer(&TASK->answerbox, call);
409 return ENOENT;
[c9fff17]410 }
[da1bafb]411
[228e490]412 if (!method_is_forwardable(IPC_GET_IMETHOD(call->data))) {
[2ba7810]413 IPC_SET_RETVAL(call->data, EFORWARD);
414 ipc_answer(&TASK->answerbox, call);
415 return EPERM;
416 }
[da1bafb]417
[0dc4258]418 /*
[4e5dabf]419 * User space is not allowed to change interface and method of system
[228e490]420 * methods on forward, allow changing ARG1, ARG2, ARG3 and ARG4 by
[4e5dabf]421 * means of imethod, arg1, arg2 and arg3.
[228e490]422 * If the interface and method is immutable, don't change anything.
[2ba7810]423 */
[228e490]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)
[b61d47d]427 phone_dealloc(IPC_GET_ARG5(call->data));
[da1bafb]428
[228e490]429 IPC_SET_ARG1(call->data, imethod);
[0dc4258]430 IPC_SET_ARG2(call->data, arg1);
[b61d47d]431 IPC_SET_ARG3(call->data, arg2);
[da1bafb]432
[4e5dabf]433 if (slow)
[48daf64]434 IPC_SET_ARG4(call->data, arg3);
[4e5dabf]435
436 /*
437 * For system methods we deliberately don't
438 * overwrite ARG5.
439 */
[0dc4258]440 } else {
[228e490]441 IPC_SET_IMETHOD(call->data, imethod);
[0dc4258]442 IPC_SET_ARG1(call->data, arg1);
[b61d47d]443 IPC_SET_ARG2(call->data, arg2);
[48daf64]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 }
[0dc4258]449 }
[2ba7810]450 }
[da1bafb]451
[d40a8ff]452 return ipc_forward(call, phone, &TASK->answerbox, mode);
[2ba7810]453}
454
[48daf64]455/** Forward a received call to another destination - fast version.
456 *
[228e490]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.
[da1bafb]463 *
464 * @param callid Hash of the call to forward.
465 * @param phoneid Phone handle to use for forwarding.
[228e490]466 * @param imethod New interface and method to use for the forwarded call.
[da1bafb]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 *
[48daf64]473 */
[96b02eb9]474sysarg_t sys_ipc_forward_fast(sysarg_t callid, sysarg_t phoneid,
[228e490]475 sysarg_t imethod, sysarg_t arg1, sysarg_t arg2, unsigned int mode)
[48daf64]476{
[228e490]477 return sys_ipc_forward_common(callid, phoneid, imethod, arg1, arg2, 0, 0,
[48daf64]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.
[228e490]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.
[da1bafb]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 *
[48daf64]497 */
[96b02eb9]498sysarg_t sys_ipc_forward_slow(sysarg_t callid, sysarg_t phoneid,
[da1bafb]499 ipc_data_t *data, unsigned int mode)
[48daf64]500{
501 ipc_data_t newdata;
[da1bafb]502 int rc = copy_from_uspace(&newdata.args, &data->args,
[48daf64]503 sizeof(newdata.args));
[da1bafb]504 if (rc != 0)
[96b02eb9]505 return (sysarg_t) rc;
[da1bafb]506
[48daf64]507 return sys_ipc_forward_common(callid, phoneid,
[228e490]508 IPC_GET_IMETHOD(newdata), IPC_GET_ARG1(newdata),
[48daf64]509 IPC_GET_ARG2(newdata), IPC_GET_ARG3(newdata),
510 IPC_GET_ARG4(newdata), IPC_GET_ARG5(newdata), mode, true);
511}
512
[8b243f2]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 *
[da1bafb]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.
[8b243f2]526 *
527 */
[96b02eb9]528sysarg_t sys_ipc_answer_fast(sysarg_t callid, sysarg_t retval,
529 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
[2d5a54f3]530{
[897f2e76]531 /* Do not answer notification callids */
532 if (callid & IPC_CALLID_NOTIFICATION)
533 return 0;
[da1bafb]534
535 call_t *call = get_call(callid);
[2ba7810]536 if (!call)
537 return ENOENT;
[da1bafb]538
539 ipc_data_t saved_data;
540 bool saved;
541
[9f22213]542 if (answer_need_old(call)) {
[2ba7810]543 memcpy(&saved_data, &call->data, sizeof(call->data));
[da1bafb]544 saved = true;
545 } else
546 saved = false;
547
[2d5a54f3]548 IPC_SET_RETVAL(call->data, retval);
549 IPC_SET_ARG1(call->data, arg1);
550 IPC_SET_ARG2(call->data, arg2);
[b74959bd]551 IPC_SET_ARG3(call->data, arg3);
552 IPC_SET_ARG4(call->data, arg4);
[da1bafb]553
[8498915]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);
[da1bafb]559 int rc = answer_preprocess(call, saved ? &saved_data : NULL);
560
[2d5a54f3]561 ipc_answer(&TASK->answerbox, call);
[7c23af9]562 return rc;
[2d5a54f3]563}
564
[8b243f2]565/** Answer an IPC call.
566 *
[da1bafb]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.
[8b243f2]571 *
572 */
[96b02eb9]573sysarg_t sys_ipc_answer_slow(sysarg_t callid, ipc_data_t *data)
[2d5a54f3]574{
[897f2e76]575 /* Do not answer notification callids */
576 if (callid & IPC_CALLID_NOTIFICATION)
577 return 0;
[da1bafb]578
579 call_t *call = get_call(callid);
[2ba7810]580 if (!call)
581 return ENOENT;
[da1bafb]582
583 ipc_data_t saved_data;
584 bool saved;
585
[9f22213]586 if (answer_need_old(call)) {
[2ba7810]587 memcpy(&saved_data, &call->data, sizeof(call->data));
[da1bafb]588 saved = true;
589 } else
590 saved = false;
591
592 int rc = copy_from_uspace(&call->data.args, &data->args,
[51ec40f]593 sizeof(call->data.args));
[e3c762cd]594 if (rc != 0)
595 return rc;
[da1bafb]596
597 rc = answer_preprocess(call, saved ? &saved_data : NULL);
[2d5a54f3]598
599 ipc_answer(&TASK->answerbox, call);
[7c23af9]600 return rc;
[2d5a54f3]601}
602
[8b243f2]603/** Hang up a phone.
[2d5a54f3]604 *
[da1bafb]605 * @param Phone handle of the phone to be hung up.
606 *
607 * @return 0 on success or an error code.
[8b243f2]608 *
[fbcfd458]609 */
[96b02eb9]610sysarg_t sys_ipc_hangup(sysarg_t phoneid)
[fbcfd458]611{
612 phone_t *phone;
[da1bafb]613
[c9fff17]614 if (phone_get(phoneid, &phone) != EOK)
615 return ENOENT;
[da1bafb]616
[d8f7362]617 if (ipc_phone_hangup(phone))
[fbcfd458]618 return -1;
[da1bafb]619
[fbcfd458]620 return 0;
621}
622
[8b243f2]623/** Wait for an incoming IPC call or an answer.
[fbcfd458]624 *
[da1bafb]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.
[bd5a663]634 *
[2d5a54f3]635 */
[96b02eb9]636sysarg_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec,
[da1bafb]637 unsigned int flags)
[2d5a54f3]638{
639 call_t *call;
[da1bafb]640
[741fd16]641restart:
[da1bafb]642
[741fd16]643#ifdef CONFIG_UDEBUG
644 udebug_stoppable_begin();
[da1bafb]645#endif
646
[51ec40f]647 call = ipc_wait_for_call(&TASK->answerbox, usec,
648 flags | SYNCH_FLAGS_INTERRUPTIBLE);
[da1bafb]649
[741fd16]650#ifdef CONFIG_UDEBUG
651 udebug_stoppable_end();
652#endif
[da1bafb]653
[9f22213]654 if (!call)
655 return 0;
[da1bafb]656
[5626277]657 if (call->flags & IPC_CALL_NOTIF) {
[43752b6]658 /* Set in_phone_hash to the interrupt counter */
[0c1a5d8a]659 call->data.phone = (void *) call->priv;
[43752b6]660
661 STRUCT_TO_USPACE(calldata, &call->data);
[da1bafb]662
[5626277]663 ipc_call_free(call);
664
[96b02eb9]665 return ((sysarg_t) call) | IPC_CALLID_NOTIFICATION;
[5626277]666 }
[da1bafb]667
[2d5a54f3]668 if (call->flags & IPC_CALL_ANSWERED) {
[7c7aae16]669 process_answer(call);
[da1bafb]670
[fbcfd458]671 if (call->flags & IPC_CALL_DISCARD_ANSWER) {
672 ipc_call_free(call);
673 goto restart;
674 }
[da1bafb]675
[fbcfd458]676 STRUCT_TO_USPACE(&calldata->args, &call->data.args);
[2d5a54f3]677 ipc_call_free(call);
[da1bafb]678
[96b02eb9]679 return ((sysarg_t) call) | IPC_CALLID_ANSWERED;
[2d5a54f3]680 }
[da1bafb]681
[2d5a54f3]682 if (process_request(&TASK->answerbox, call))
683 goto restart;
[da1bafb]684
[7c7aae16]685 /* Include phone address('id') of the caller in the request,
686 * copy whole call->data, not only call->data.args */
[bd55bbb]687 if (STRUCT_TO_USPACE(calldata, &call->data)) {
[e06da7e]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.
[b11ee88]691 */
[e06da7e]692 ipc_data_t saved_data;
[da1bafb]693 bool saved;
694
[e06da7e]695 if (answer_need_old(call)) {
696 memcpy(&saved_data, &call->data, sizeof(call->data));
[da1bafb]697 saved = true;
698 } else
699 saved = false;
[e06da7e]700
701 IPC_SET_RETVAL(call->data, EPARTY);
[da1bafb]702 (void) answer_preprocess(call, saved ? &saved_data : NULL);
[e06da7e]703 ipc_answer(&TASK->answerbox, call);
[bd55bbb]704 return 0;
705 }
[da1bafb]706
[96b02eb9]707 return (sysarg_t) call;
[2d5a54f3]708}
[5626277]709
[da1bafb]710/** Interrupt one thread from sys_ipc_wait_for_call().
711 *
712 */
[96b02eb9]713sysarg_t sys_ipc_poke(void)
[057d21a]714{
[da1bafb]715 waitq_unsleep(&TASK->answerbox.wq);
[057d21a]716 return EOK;
717}
718
[8b243f2]719/** Connect an IRQ handler to a task.
[2b017ba]720 *
[228e490]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.
[da1bafb]725 *
726 * @return EPERM or a return code returned by ipc_irq_register().
[2b017ba]727 *
728 */
[f044e96]729sysarg_t sys_irq_register(inr_t inr, devno_t devno, sysarg_t imethod,
[51ec40f]730 irq_code_t *ucode)
[5626277]731{
[2bb8648]732 if (!(cap_get(TASK) & CAP_IRQ_REG))
733 return EPERM;
[da1bafb]734
[228e490]735 return ipc_irq_register(&TASK->answerbox, inr, devno, imethod, ucode);
[5626277]736}
737
[8b243f2]738/** Disconnect an IRQ handler from a task.
739 *
[da1bafb]740 * @param inr IRQ number.
741 * @param devno Device number.
742 *
743 * @return Zero on success or EPERM on error.
[2b017ba]744 *
745 */
[f044e96]746sysarg_t sys_irq_unregister(inr_t inr, devno_t devno)
[5626277]747{
[2bb8648]748 if (!(cap_get(TASK) & CAP_IRQ_REG))
749 return EPERM;
[da1bafb]750
[2b017ba]751 ipc_irq_unregister(&TASK->answerbox, inr, devno);
[da1bafb]752
[5626277]753 return 0;
754}
[b45c443]755
[6b10dab]756#ifdef __32_BITS__
[9a1b20c]757
[6b10dab]758/** Syscall connect to a task by ID (32 bits)
[da1bafb]759 *
760 * @return Phone id on success, or negative error code.
[9a1b20c]761 *
762 */
[6b10dab]763sysarg_t sys_ipc_connect_kbox(sysarg64_t *uspace_taskid)
[9a1b20c]764{
765#ifdef CONFIG_UDEBUG
[6b10dab]766 sysarg64_t taskid;
767 int rc = copy_from_uspace(&taskid, uspace_taskid, sizeof(sysarg64_t));
[9a1b20c]768 if (rc != 0)
[96b02eb9]769 return (sysarg_t) rc;
[da1bafb]770
[6b10dab]771 return ipc_connect_kbox((task_id_t) taskid);
[9a1b20c]772#else
[96b02eb9]773 return (sysarg_t) ENOTSUP;
[9a1b20c]774#endif
775}
776
[6b10dab]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 */
786sysarg_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
[cc73a8a1]797/** @}
[b45c443]798 */
Note: See TracBrowser for help on using the repository browser.