Subversion Repositories HelenOS

Rev

Rev 2804 | Rev 2807 | 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 int 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", ta->taskid);
  318.  
  319.     if (ta->being_debugged != false) {
  320.         spinlock_unlock(&ta->lock);
  321.         klog_printf("debug_begin(): busy error");
  322.         return EBUSY;
  323.     }
  324.  
  325.     ta->being_debugged = true;
  326.     ta->stop_request = true;
  327.     ta->debug_begin_call = call;
  328.  
  329.     if (ta->not_stoppable_count == 0) {
  330.         ta->debug_begin_call = NULL;
  331.         ta->stop_request = false;
  332.         spinlock_unlock(&ta->lock);
  333.         klog_printf("debug_begin(): immediate backsend");
  334.         return 1; /* actually we need backsend with 0 retval */
  335.     }
  336.  
  337.     spinlock_unlock(&ta->lock);
  338.  
  339.     klog_printf("debug_begin() done (wait for stoppability)");
  340.     return 0;
  341. }
  342.  
  343. static void debug_go(call_t *call, phone_t *phone)
  344. {
  345.     thread_t *t;
  346.     link_t *l;
  347.     task_t *ta;
  348.  
  349.     klog_printf("debug_go()");
  350.     ta = get_lock_callee_task(phone);
  351.  
  352.     ta->debug_go_call = call;
  353.  
  354.     l = ta->th_head.next;
  355.     if (l != &TASK->th_head) {
  356.         t = list_get_instance(l, thread_t, th_link);
  357.         klog_printf("debug_go(): waitq_wakeup");
  358.         waitq_wakeup(&t->go_wq, WAKEUP_FIRST);
  359.     }
  360.  
  361.     spinlock_unlock(&ta->lock);
  362. }
  363.  
  364. static int debug_args_read(call_t *call, phone_t *phone)
  365. {
  366.     thread_t *t;
  367.     link_t *l;
  368.     task_t *ta;
  369.     void *uspace_buffer;
  370.     unative_t to_copy;
  371.     int rc;
  372.  
  373.     klog_printf("debug_args_read()");
  374.     // FIXME: verify task/thread state
  375.  
  376.     ta = get_lock_callee_task(phone);
  377.     klog_printf("task %llu", ta->taskid);
  378.  
  379.     l = ta->th_head.next;
  380.     if (l != &TASK->th_head) {
  381.         t = list_get_instance(l, thread_t, th_link);
  382.         /* t = requested thread */
  383.         uspace_buffer = (void *)IPC_GET_ARG2(call->data);
  384.         to_copy = IPC_GET_ARG3(call->data);
  385.         rc = copy_to_uspace(uspace_buffer, t->syscall_args, to_copy);
  386.         if (rc != 0) {
  387.             spinlock_unlock(&ta->lock);
  388.             klog_printf("debug_args_read() - copy failed");
  389.             return rc;
  390.         }
  391.         IPC_SET_ARG1(call->data, to_copy);
  392.     }
  393.  
  394.     spinlock_unlock(&ta->lock);
  395.  
  396.     klog_printf("debug_args_read() done");
  397.     return 1; /* actually need becksend with retval 0 */
  398. }
  399.  
  400.  
  401. /** Called before the request is sent.
  402.  *
  403.  * @param call      Call structure with the request.
  404.  * @param phone     Phone that the call will be sent through.
  405.  *
  406.  * @return      Return 0 on success, ELIMIT or EPERM on error.
  407.  */
  408. static int request_preprocess(call_t *call, phone_t *phone)
  409. {
  410.     int newphid;
  411.     size_t size;
  412.     uintptr_t src;
  413.     int rc;
  414.  
  415.     switch (IPC_GET_METHOD(call->data)) {
  416.     case IPC_M_CONNECT_ME_TO:
  417.         newphid = phone_alloc();
  418.         if (newphid < 0)
  419.             return ELIMIT;
  420.         /* Set arg5 for server */
  421.         IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]);
  422.         call->flags |= IPC_CALL_CONN_ME_TO;
  423.         call->priv = newphid;
  424.         break;
  425.     case IPC_M_SHARE_OUT:
  426.         size = as_area_get_size(IPC_GET_ARG1(call->data));
  427.         if (!size)
  428.             return EPERM;
  429.         IPC_SET_ARG2(call->data, size);
  430.         break;
  431.     case IPC_M_DATA_READ:
  432.         size = IPC_GET_ARG2(call->data);
  433.         if ((size <= 0 || (size > DATA_XFER_LIMIT)))
  434.             return ELIMIT;
  435.         break;
  436.     case IPC_M_DATA_WRITE:
  437.         src = IPC_GET_ARG1(call->data);
  438.         size = IPC_GET_ARG2(call->data);
  439.        
  440.         if ((size <= 0) || (size > DATA_XFER_LIMIT))
  441.             return ELIMIT;
  442.        
  443.         call->buffer = (uint8_t *) malloc(size, 0);
  444.         rc = copy_from_uspace(call->buffer, (void *) src, size);
  445.         if (rc != 0) {
  446.             free(call->buffer);
  447.             return rc;
  448.         }
  449.         break;
  450.     case IPC_M_DEBUG_BEGIN:
  451.         /* actually need possibility of backsend with 0 result code */
  452.         rc = debug_begin(call, phone);
  453.         return rc;
  454.     case IPC_M_DEBUG_GO:
  455.         debug_go(call, phone);
  456.         break;
  457.     case IPC_M_DEBUG_ARGS_READ:
  458.         rc = debug_args_read(call, phone);
  459.         return rc;
  460.     default:
  461.         break;
  462.     }
  463.     return 0;
  464. }
  465.  
  466. /*******************************************************************************
  467.  * Functions called to process received call/answer before passing it to uspace.
  468.  *******************************************************************************/
  469.  
  470. /** Do basic kernel processing of received call answer.
  471.  *
  472.  * @param call      Call structure with the answer.
  473.  */
  474. static void process_answer(call_t *call)
  475. {
  476.     if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) &&
  477.         (call->flags & IPC_CALL_FORWARDED))
  478.         IPC_SET_RETVAL(call->data, EFORWARD);
  479.  
  480.     if (call->flags & IPC_CALL_CONN_ME_TO) {
  481.         if (IPC_GET_RETVAL(call->data))
  482.             phone_dealloc(call->priv);
  483.         else
  484.             IPC_SET_ARG5(call->data, call->priv);
  485.     }
  486.  
  487.     if (call->buffer) {
  488.         /* This must be an affirmative answer to IPC_M_DATA_READ. */
  489.         uintptr_t dst = IPC_GET_ARG1(call->data);
  490.         size_t size = IPC_GET_ARG2(call->data);
  491.         int rc = copy_to_uspace((void *) dst, call->buffer, size);
  492.         if (rc)
  493.             IPC_SET_RETVAL(call->data, rc);
  494.         free(call->buffer);
  495.         call->buffer = NULL;
  496.     }
  497. }
  498.  
  499. /** Do basic kernel processing of received call request.
  500.  *
  501.  * @param box       Destination answerbox structure.
  502.  * @param call      Call structure with the request.
  503.  *
  504.  * @return      Return 0 if the call should be passed to userspace.
  505.  *          Return -1 if the call should be ignored.
  506.  */
  507. static int process_request(answerbox_t *box, call_t *call)
  508. {
  509.     int phoneid;
  510.  
  511.     if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
  512.         phoneid = phone_alloc();
  513.         if (phoneid < 0) { /* Failed to allocate phone */
  514.             IPC_SET_RETVAL(call->data, ELIMIT);
  515.             ipc_answer(box, call);
  516.             return -1;
  517.         }
  518.         IPC_SET_ARG5(call->data, phoneid);
  519.     }
  520.     switch (IPC_GET_METHOD(call->data)) {
  521.     case IPC_M_DEBUG_BEGIN:
  522.     case IPC_M_DEBUG_END:
  523.     case IPC_M_DEBUG_GO:
  524.     case IPC_M_DEBUG_STOP:
  525.     case IPC_M_DEBUG_GUARD:
  526.         return -1;
  527.     default:
  528.         break;
  529.     }
  530.     return 0;
  531. }
  532.  
  533. /** Make a fast call over IPC, wait for reply and return to user.
  534.  *
  535.  * This function can handle only three arguments of payload, but is faster than
  536.  * the generic function (i.e. sys_ipc_call_sync_slow()).
  537.  *
  538.  * @param phoneid   Phone handle for the call.
  539.  * @param method    Method of the call.
  540.  * @param arg1      Service-defined payload argument.
  541.  * @param arg2      Service-defined payload argument.
  542.  * @param arg3      Service-defined payload argument.
  543.  * @param data      Address of userspace structure where the reply call will
  544.  *          be stored.
  545.  *
  546.  * @return      Returns 0 on success.
  547.  *          Return ENOENT if there is no such phone handle.
  548.  */
  549. unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,
  550.     unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data)
  551. {
  552.     call_t call;
  553.     phone_t *phone;
  554.     int res;
  555.     int rc;
  556.  
  557.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  558.  
  559.     ipc_call_static_init(&call);
  560.     IPC_SET_METHOD(call.data, method);
  561.     IPC_SET_ARG1(call.data, arg1);
  562.     IPC_SET_ARG2(call.data, arg2);
  563.     IPC_SET_ARG3(call.data, arg3);
  564.     /*
  565.      * To achieve deterministic behavior, zero out arguments that are beyond
  566.      * the limits of the fast version.
  567.      */
  568.     IPC_SET_ARG4(call.data, 0);
  569.     IPC_SET_ARG5(call.data, 0);
  570.  
  571.     if (!(res = request_preprocess(&call, phone))) {
  572.         ipc_call_sync(phone, &call);
  573.         process_answer(&call);
  574.     } else {
  575.         IPC_SET_RETVAL(call.data, res);
  576.     }
  577.     rc = STRUCT_TO_USPACE(&data->args, &call.data.args);
  578.     if (rc != 0)
  579.         return rc;
  580.  
  581.     return 0;
  582. }
  583.  
  584. /** Make a synchronous IPC call allowing to transmit the entire payload.
  585.  *
  586.  * @param phoneid   Phone handle for the call.
  587.  * @param question  Userspace address of call data with the request.
  588.  * @param reply     Userspace address of call data where to store the
  589.  *          answer.
  590.  *
  591.  * @return      Zero on success or an error code.
  592.  */
  593. unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question,
  594.     ipc_data_t *reply)
  595. {
  596.     call_t call;
  597.     phone_t *phone;
  598.     int res;
  599.     int rc;
  600.  
  601.     ipc_call_static_init(&call);
  602.     rc = copy_from_uspace(&call.data.args, &question->args,
  603.         sizeof(call.data.args));
  604.     if (rc != 0)
  605.         return (unative_t) rc;
  606.  
  607.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  608.  
  609.     if (!(res = request_preprocess(&call, phone))) {
  610.         ipc_call_sync(phone, &call);
  611.         process_answer(&call);
  612.     } else
  613.         IPC_SET_RETVAL(call.data, res);
  614.  
  615.     rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
  616.     if (rc != 0)
  617.         return rc;
  618.  
  619.     return 0;
  620. }
  621.  
  622. /** Check that the task did not exceed the allowed limit of asynchronous calls.
  623.  *
  624.  * @return      Return 0 if limit not reached or -1 if limit exceeded.
  625.  */
  626. static int check_call_limit(void)
  627. {
  628.     if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
  629.         atomic_dec(&TASK->active_calls);
  630.         return -1;
  631.     }
  632.     return 0;
  633. }
  634.  
  635. /** Make a fast asynchronous call over IPC.
  636.  *
  637.  * This function can only handle four arguments of payload, but is faster than
  638.  * the generic function sys_ipc_call_async_slow().
  639.  *
  640.  * @param phoneid   Phone handle for the call.
  641.  * @param method    Method of the call.
  642.  * @param arg1      Service-defined payload argument.
  643.  * @param arg2      Service-defined payload argument.
  644.  * @param arg3      Service-defined payload argument.
  645.  * @param arg4      Service-defined payload argument.
  646.  *
  647.  * @return      Return call hash on success.
  648.  *          Return IPC_CALLRET_FATAL in case of a fatal error and
  649.  *          IPC_CALLRET_TEMPORARY if there are too many pending
  650.  *          asynchronous requests; answers should be handled first.
  651.  */
  652. unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,
  653.     unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4)
  654. {
  655.     call_t *call;
  656.     phone_t *phone;
  657.     int res;
  658.  
  659.     if (check_call_limit())
  660.         return IPC_CALLRET_TEMPORARY;
  661.  
  662.     GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
  663.  
  664.     call = ipc_call_alloc(0);
  665.     IPC_SET_METHOD(call->data, method);
  666.     IPC_SET_ARG1(call->data, arg1);
  667.     IPC_SET_ARG2(call->data, arg2);
  668.     IPC_SET_ARG3(call->data, arg3);
  669.     IPC_SET_ARG4(call->data, arg4);
  670.     /*
  671.      * To achieve deterministic behavior, zero out arguments that are beyond
  672.      * the limits of the fast version.
  673.      */
  674.     IPC_SET_ARG5(call->data, 0);
  675.  
  676.     if (!(res = request_preprocess(call, phone)))
  677.         ipc_call(phone, call);
  678.     else
  679.         ipc_backsend_err(phone, call, res);
  680.  
  681.     return (unative_t) call;
  682. }
  683.  
  684. /** Make an asynchronous IPC call allowing to transmit the entire payload.
  685.  *
  686.  * @param phoneid   Phone handle for the call.
  687.  * @param data      Userspace address of call data with the request.
  688.  *
  689.  * @return      See sys_ipc_call_async_fast().
  690.  */
  691. unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data)
  692. {
  693.     call_t *call;
  694.     phone_t *phone;
  695.     int res;
  696.     int rc;
  697.  
  698.     if (check_call_limit())
  699.         return IPC_CALLRET_TEMPORARY;
  700.  
  701.     GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
  702.  
  703.     call = ipc_call_alloc(0);
  704.     rc = copy_from_uspace(&call->data.args, &data->args,
  705.         sizeof(call->data.args));
  706.     if (rc != 0) {
  707.         ipc_call_free(call);
  708.         return (unative_t) rc;
  709.     }
  710.     if (!(res = request_preprocess(call, phone)))
  711.         ipc_call(phone, call);
  712.     else
  713.         ipc_backsend_err(phone, call, res);
  714.  
  715.     return (unative_t) call;
  716. }
  717.  
  718. /** Forward a received call to another destination.
  719.  *
  720.  * @param callid    Hash of the call to forward.
  721.  * @param phoneid   Phone handle to use for forwarding.
  722.  * @param method    New method to use for the forwarded call.
  723.  * @param arg1      New value of the first argument for the forwarded call.
  724.  * @param arg2      New value of the second argument for the forwarded call.
  725.  * @param mode      Flags that specify mode of the forward operation.
  726.  *
  727.  * @return      Return 0 on succes, otherwise return an error code.
  728.  *
  729.  * In case the original method is a system method, ARG1, ARG2 and ARG3 are
  730.  * overwritten in the forwarded message with the new method and the new arg1 and
  731.  * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with
  732.  * the new method, arg1 and arg2, respectively. Also note there is a set of
  733.  * immutable methods, for which the new method and argument is not set and
  734.  * these values are ignored.
  735.  *
  736.  * Warning: When implementing support for changing additional payload
  737.  *      arguments, make sure that ARG5 is not rewritten for certain
  738.  *      system IPC
  739.  */
  740. unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid,
  741.     unative_t method, unative_t arg1, unative_t arg2, int mode)
  742. {
  743.     call_t *call;
  744.     phone_t *phone;
  745.  
  746.     call = get_call(callid);
  747.     if (!call)
  748.         return ENOENT;
  749.  
  750.     call->flags |= IPC_CALL_FORWARDED;
  751.  
  752.     GET_CHECK_PHONE(phone, phoneid, {
  753.         IPC_SET_RETVAL(call->data, EFORWARD);
  754.         ipc_answer(&TASK->answerbox, call);
  755.         return ENOENT;
  756.     });    
  757.  
  758.     if (!method_is_forwardable(IPC_GET_METHOD(call->data))) {
  759.         IPC_SET_RETVAL(call->data, EFORWARD);
  760.         ipc_answer(&TASK->answerbox, call);
  761.         return EPERM;
  762.     }
  763.  
  764.     /*
  765.      * Userspace is not allowed to change method of system methods on
  766.      * forward, allow changing ARG1, ARG2 and ARG3 by means of method,
  767.      * arg1 and arg2.
  768.      * If the method is immutable, don't change anything.
  769.      */
  770.     if (!method_is_immutable(IPC_GET_METHOD(call->data))) {
  771.         if (method_is_system(IPC_GET_METHOD(call->data))) {
  772.             if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
  773.                 phone_dealloc(IPC_GET_ARG5(call->data));
  774.  
  775.             IPC_SET_ARG1(call->data, method);
  776.             IPC_SET_ARG2(call->data, arg1);
  777.             IPC_SET_ARG3(call->data, arg2);
  778.         } else {
  779.             IPC_SET_METHOD(call->data, method);
  780.             IPC_SET_ARG1(call->data, arg1);
  781.             IPC_SET_ARG2(call->data, arg2);
  782.         }
  783.     }
  784.  
  785.     return ipc_forward(call, phone, &TASK->answerbox, mode);
  786. }
  787.  
  788. /** Answer an IPC call - fast version.
  789.  *
  790.  * This function can handle only two return arguments of payload, but is faster
  791.  * than the generic sys_ipc_answer().
  792.  *
  793.  * @param callid    Hash of the call to be answered.
  794.  * @param retval    Return value of the answer.
  795.  * @param arg1      Service-defined return value.
  796.  * @param arg2      Service-defined return value.
  797.  * @param arg3      Service-defined return value.
  798.  * @param arg4      Service-defined return value.
  799.  *
  800.  * @return      Return 0 on success, otherwise return an error code.   
  801.  */
  802. unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval,
  803.     unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4)
  804. {
  805.     call_t *call;
  806.     ipc_data_t saved_data;
  807.     int saveddata = 0;
  808.     int rc;
  809.  
  810.     /* Do not answer notification callids */
  811.     if (callid & IPC_CALLID_NOTIFICATION)
  812.         return 0;
  813.  
  814.     call = get_call(callid);
  815.     if (!call)
  816.         return ENOENT;
  817.  
  818.     if (answer_need_old(call)) {
  819.         memcpy(&saved_data, &call->data, sizeof(call->data));
  820.         saveddata = 1;
  821.     }
  822.  
  823.     IPC_SET_RETVAL(call->data, retval);
  824.     IPC_SET_ARG1(call->data, arg1);
  825.     IPC_SET_ARG2(call->data, arg2);
  826.     IPC_SET_ARG3(call->data, arg3);
  827.     IPC_SET_ARG4(call->data, arg4);
  828.     /*
  829.      * To achieve deterministic behavior, zero out arguments that are beyond
  830.      * the limits of the fast version.
  831.      */
  832.     IPC_SET_ARG5(call->data, 0);
  833.     rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
  834.  
  835.     ipc_answer(&TASK->answerbox, call);
  836.     return rc;
  837. }
  838.  
  839. /** Answer an IPC call.
  840.  *
  841.  * @param callid    Hash of the call to be answered.
  842.  * @param data      Userspace address of call data with the answer.
  843.  *
  844.  * @return      Return 0 on success, otherwise return an error code.
  845.  */
  846. unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data)
  847. {
  848.     call_t *call;
  849.     ipc_data_t saved_data;
  850.     int saveddata = 0;
  851.     int rc;
  852.  
  853.     /* Do not answer notification callids */
  854.     if (callid & IPC_CALLID_NOTIFICATION)
  855.         return 0;
  856.  
  857.     call = get_call(callid);
  858.     if (!call)
  859.         return ENOENT;
  860.  
  861.     if (answer_need_old(call)) {
  862.         memcpy(&saved_data, &call->data, sizeof(call->data));
  863.         saveddata = 1;
  864.     }
  865.     rc = copy_from_uspace(&call->data.args, &data->args,
  866.         sizeof(call->data.args));
  867.     if (rc != 0)
  868.         return rc;
  869.  
  870.     rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
  871.    
  872.     ipc_answer(&TASK->answerbox, call);
  873.  
  874.     return rc;
  875. }
  876.  
  877. /** Hang up a phone.
  878.  *
  879.  * @param       Phone handle of the phone to be hung up.
  880.  *
  881.  * @return      Return 0 on success or an error code.
  882.  */
  883. unative_t sys_ipc_hangup(int phoneid)
  884. {
  885.     phone_t *phone;
  886.  
  887.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  888.  
  889.     if (ipc_phone_hangup(phone))
  890.         return -1;
  891.  
  892.     return 0;
  893. }
  894.  
  895. /** Wait for an incoming IPC call or an answer.
  896.  *
  897.  * @param calldata  Pointer to buffer where the call/answer data is stored.
  898.  * @param usec      Timeout. See waitq_sleep_timeout() for explanation.
  899.  * @param flags     Select mode of sleep operation. See waitq_sleep_timeout()
  900.  *          for explanation.
  901.  *
  902.  * @return      Hash of the call.
  903.  *          If IPC_CALLID_NOTIFICATION bit is set in the hash, the
  904.  *          call is a notification. IPC_CALLID_ANSWERED denotes an
  905.  *          answer.
  906.  */
  907. unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags)
  908. {
  909.     call_t *call;
  910.  
  911. restart:   
  912.     call = ipc_wait_for_call(&TASK->answerbox, usec,
  913.         flags | SYNCH_FLAGS_INTERRUPTIBLE);
  914.     if (!call)
  915.         return 0;
  916.  
  917.     if (call->flags & IPC_CALL_NOTIF) {
  918.         ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
  919.  
  920.         /* Set in_phone_hash to the interrupt counter */
  921.         call->data.phone = (void *) call->priv;
  922.        
  923.         STRUCT_TO_USPACE(calldata, &call->data);
  924.  
  925.         ipc_call_free(call);
  926.        
  927.         return ((unative_t) call) | IPC_CALLID_NOTIFICATION;
  928.     }
  929.  
  930.     if (call->flags & IPC_CALL_ANSWERED) {
  931.         process_answer(call);
  932.  
  933.         ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
  934.  
  935.         atomic_dec(&TASK->active_calls);
  936.  
  937.         if (call->flags & IPC_CALL_DISCARD_ANSWER) {
  938.             ipc_call_free(call);
  939.             goto restart;
  940.         }
  941.  
  942.         STRUCT_TO_USPACE(&calldata->args, &call->data.args);
  943.         ipc_call_free(call);
  944.  
  945.         return ((unative_t) call) | IPC_CALLID_ANSWERED;
  946.     }
  947.  
  948.     if (process_request(&TASK->answerbox, call))
  949.         goto restart;
  950.  
  951.     /* Include phone address('id') of the caller in the request,
  952.      * copy whole call->data, not only call->data.args */
  953.     if (STRUCT_TO_USPACE(calldata, &call->data)) {
  954.         return 0;
  955.     }
  956.     return (unative_t)call;
  957. }
  958.  
  959. /** Connect an IRQ handler to a task.
  960.  *
  961.  * @param inr       IRQ number.
  962.  * @param devno     Device number.
  963.  * @param method    Method to be associated with the notification.
  964.  * @param ucode     Uspace pointer to the top-half pseudocode.
  965.  *
  966.  * @return      EPERM or a return code returned by ipc_irq_register().
  967.  */
  968. unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method,
  969.     irq_code_t *ucode)
  970. {
  971.     if (!(cap_get(TASK) & CAP_IRQ_REG))
  972.         return EPERM;
  973.  
  974.     return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode);
  975. }
  976.  
  977. /** Disconnect an IRQ handler from a task.
  978.  *
  979.  * @param inr       IRQ number.
  980.  * @param devno     Device number.
  981.  *
  982.  * @return      Zero on success or EPERM on error..
  983.  */
  984. unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno)
  985. {
  986.     if (!(cap_get(TASK) & CAP_IRQ_REG))
  987.         return EPERM;
  988.  
  989.     ipc_irq_unregister(&TASK->answerbox, inr, devno);
  990.  
  991.     return 0;
  992. }
  993.  
  994. #include <console/klog.h>
  995.  
  996. /**
  997.  * Syscall connect to a task by id.
  998.  *
  999.  * @return      Phone id on success, or negative error code.
  1000.  */
  1001. unative_t sys_ipc_connect_task(sysarg64_t *uspace_taskid_arg)
  1002. {
  1003.     sysarg64_t taskid_arg;
  1004.     int rc;
  1005.    
  1006.     rc = copy_from_uspace(&taskid_arg, uspace_taskid_arg, sizeof(sysarg64_t));
  1007.     if (rc != 0)
  1008.         return (unative_t) rc;
  1009.  
  1010.     klog_printf("sys_ipc_connect_kbox(%lld, %d)", taskid_arg.value);
  1011.  
  1012.     return ipc_connect_task(taskid_arg.value);
  1013. }
  1014.  
  1015. /** @}
  1016.  */
  1017.