Subversion Repositories HelenOS

Rev

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