Subversion Repositories HelenOS

Rev

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