Subversion Repositories HelenOS

Rev

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