Subversion Repositories HelenOS

Rev

Rev 2622 | Rev 2636 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

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