Subversion Repositories HelenOS

Rev

Rev 1288 | Rev 1297 | 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. #include <arch.h>
  30. #include <proc/task.h>
  31. #include <proc/thread.h>
  32. #include <errno.h>
  33. #include <memstr.h>
  34. #include <debug.h>
  35. #include <ipc/ipc.h>
  36. #include <ipc/sysipc.h>
  37. #include <ipc/irq.h>
  38. #include <ipc/ipcrsc.h>
  39. #include <arch/interrupt.h>
  40. #include <print.h>
  41. #include <syscall/copy.h>
  42.  
  43. #define GET_CHECK_PHONE(phone,phoneid,err) { \
  44.       if (phoneid > IPC_MAX_PHONES) { err; } \
  45.       phone = &TASK->phones[phoneid]; \
  46. }
  47.  
  48. #define STRUCT_TO_USPACE(dst,src) copy_to_uspace(dst,src,sizeof(*(src)))
  49.  
  50. /** Return true if the method is a system method */
  51. static inline int is_system_method(__native method)
  52. {
  53.     if (method <= IPC_M_LAST_SYSTEM)
  54.         return 1;
  55.     return 0;
  56. }
  57.  
  58. /** Return true if the message with this method is forwardable
  59.  *
  60.  * - some system messages may be forwarded, for some of them
  61.  *   it is useless
  62.  */
  63. static inline int is_forwardable(__native method)
  64. {
  65.     if (method == IPC_M_PHONE_HUNGUP)
  66.         return 0; /* This message is meant only for the receiver */
  67.     return 1;
  68. }
  69.  
  70. /****************************************************/
  71. /* Functions that preprocess answer before sending
  72.  * it to the recepient
  73.  */
  74.  
  75. /** Return true if the caller (ipc_answer) should save
  76.  * the old call contents for answer_preprocess
  77.  */
  78. static inline int answer_need_old(call_t *call)
  79. {
  80.     if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
  81.         return 1;
  82.     if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_ME_TO)
  83.         return 1;
  84.     return 0;
  85. }
  86.  
  87. /** Interpret process answer as control information */
  88. static inline void answer_preprocess(call_t *answer, ipc_data_t *olddata)
  89. {
  90.     int phoneid;
  91.  
  92.     if (IPC_GET_RETVAL(answer->data) == EHANGUP) {
  93.         /* In case of forward, hangup the forwared phone,
  94.          * not the originator
  95.          */
  96.         spinlock_lock(&answer->data.phone->lock);
  97.         spinlock_lock(&TASK->answerbox.lock);
  98.         if (answer->data.phone->callee) {
  99.             list_remove(&answer->data.phone->list);
  100.             answer->data.phone->callee = 0;
  101.         }
  102.         spinlock_unlock(&TASK->answerbox.lock);
  103.         spinlock_unlock(&answer->data.phone->lock);
  104.     }
  105.  
  106.     if (!olddata)
  107.         return;
  108.  
  109.     if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {
  110.         phoneid = IPC_GET_ARG3(*olddata);
  111.         if (IPC_GET_RETVAL(answer->data)) {
  112.             /* The connection was not accepted */
  113.             phone_dealloc(phoneid);
  114.         } else {
  115.             /* The connection was accepted */
  116.             phone_connect(phoneid,&answer->sender->answerbox);
  117.             /* Set 'phone identification' as arg3 of response */
  118.             IPC_SET_ARG3(answer->data, (__native)&TASK->phones[phoneid]);
  119.         }
  120.     } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {
  121.         /* If the users accepted call, connect */
  122.         if (!IPC_GET_RETVAL(answer->data)) {
  123.             ipc_phone_connect((phone_t *)IPC_GET_ARG3(*olddata),
  124.                       &TASK->answerbox);
  125.         }
  126.     }
  127. }
  128.  
  129. /** Called before the request is sent
  130.  *
  131.  * @return 0 - no error, -1 - report error to user
  132.  */
  133. static int request_preprocess(call_t *call)
  134. {
  135.     int newphid;
  136.  
  137.     switch (IPC_GET_METHOD(call->data)) {
  138.     case IPC_M_CONNECT_ME_TO:
  139.         newphid = phone_alloc();
  140.         if (newphid < 0)
  141.             return ELIMIT;
  142.         /* Set arg3 for server */
  143.         IPC_SET_ARG3(call->data, (__native)&TASK->phones[newphid]);
  144.         call->flags |= IPC_CALL_CONN_ME_TO;
  145.         call->private = newphid;
  146.         break;
  147.     default:
  148.         break;
  149.     }
  150.     return 0;
  151. }
  152.  
  153. /****************************************************/
  154. /* Functions called to process received call/answer
  155.  * before passing to uspace
  156.  */
  157.  
  158. /** Do basic kernel processing of received call answer */
  159. static void process_answer(call_t *call)
  160. {
  161.     if (IPC_GET_RETVAL(call->data) == EHANGUP && \
  162.         call->flags & IPC_CALL_FORWARDED)
  163.         IPC_SET_RETVAL(call->data, EFORWARD);
  164.  
  165.     if (call->flags & IPC_CALL_CONN_ME_TO) {
  166.         if (IPC_GET_RETVAL(call->data))
  167.             phone_dealloc(call->private);
  168.         else
  169.             IPC_SET_ARG3(call->data, call->private);
  170.     }
  171. }
  172.  
  173. /** Do basic kernel processing of received call request
  174.  *
  175.  * @return 0 - the call should be passed to userspace, 1 - ignore call
  176.  */
  177. static int process_request(answerbox_t *box,call_t *call)
  178. {
  179.     int phoneid;
  180.  
  181.     if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
  182.         phoneid = phone_alloc();
  183.         if (phoneid < 0) { /* Failed to allocate phone */
  184.             IPC_SET_RETVAL(call->data, ELIMIT);
  185.             ipc_answer(box,call);
  186.             return -1;
  187.         }
  188.         IPC_SET_ARG3(call->data, phoneid);
  189.     }
  190.     return 0;
  191. }
  192.  
  193. /** Send a call over IPC, wait for reply, return to user
  194.  *
  195.  * @return Call identification, returns -1 on fatal error,
  196.            -2 on 'Too many async request, handle answers first
  197.  */
  198. __native sys_ipc_call_sync_fast(__native phoneid, __native method,
  199.                 __native arg1, ipc_data_t *data)
  200. {
  201.     call_t call;
  202.     phone_t *phone;
  203.     int res;
  204.  
  205.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  206.  
  207.     ipc_call_static_init(&call);
  208.     IPC_SET_METHOD(call.data, method);
  209.     IPC_SET_ARG1(call.data, arg1);
  210.  
  211.     if (!(res=request_preprocess(&call))) {
  212.         ipc_call_sync(phone, &call);
  213.         process_answer(&call);
  214.     } else
  215.         IPC_SET_RETVAL(call.data, res);
  216.     STRUCT_TO_USPACE(&data->args, &call.data.args);
  217.  
  218.     return 0;
  219. }
  220.  
  221. /** Synchronous IPC call allowing to send whole message */
  222. __native sys_ipc_call_sync(__native phoneid, ipc_data_t *question,
  223.                ipc_data_t *reply)
  224. {
  225.     call_t call;
  226.     phone_t *phone;
  227.     int res;
  228.     int rc;
  229.  
  230.     ipc_call_static_init(&call);
  231.     rc = copy_from_uspace(&call.data.args, &question->args, sizeof(call.data.args));
  232.     if (rc != 0)
  233.         return (__native) rc;
  234.  
  235.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  236.  
  237.     if (!(res=request_preprocess(&call))) {
  238.         ipc_call_sync(phone, &call);
  239.         process_answer(&call);
  240.     } else
  241.         IPC_SET_RETVAL(call.data, res);
  242.  
  243.     rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
  244.     if (rc != 0)
  245.         return rc;
  246.  
  247.     return 0;
  248. }
  249.  
  250. /** Check that the task did not exceed allowed limit
  251.  *
  252.  * @return 0 - Limit OK,   -1 - limit exceeded
  253.  */
  254. static int check_call_limit(void)
  255. {
  256.     if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
  257.         atomic_dec(&TASK->active_calls);
  258.         return -1;
  259.     }
  260.     return 0;
  261. }
  262.  
  263. /** Send an asynchronous call over ipc
  264.  *
  265.  * @return Call identification, returns -1 on fatal error,
  266.            -2 on 'Too many async request, handle answers first
  267.  */
  268. __native sys_ipc_call_async_fast(__native phoneid, __native method,
  269.                  __native arg1, __native arg2)
  270. {
  271.     call_t *call;
  272.     phone_t *phone;
  273.     int res;
  274.  
  275.     if (check_call_limit())
  276.         return IPC_CALLRET_TEMPORARY;
  277.  
  278.     GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
  279.  
  280.     call = ipc_call_alloc(0);
  281.     IPC_SET_METHOD(call->data, method);
  282.     IPC_SET_ARG1(call->data, arg1);
  283.     IPC_SET_ARG2(call->data, arg2);
  284.  
  285.     if (!(res=request_preprocess(call)))
  286.         ipc_call(phone, call);
  287.     else
  288.         ipc_backsend_err(phone, call, res);
  289.  
  290.     return (__native) call;
  291. }
  292.  
  293. /** Synchronous IPC call allowing to send whole message
  294.  *
  295.  * @return The same as sys_ipc_call_async
  296.  */
  297. __native sys_ipc_call_async(__native phoneid, ipc_data_t *data)
  298. {
  299.     call_t *call;
  300.     phone_t *phone;
  301.     int res;
  302.     int rc;
  303.  
  304.     if (check_call_limit())
  305.         return IPC_CALLRET_TEMPORARY;
  306.  
  307.     GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
  308.  
  309.     call = ipc_call_alloc(0);
  310.     rc = copy_from_uspace(&call->data.args, &data->args, sizeof(call->data.args));
  311.     if (rc != 0) {
  312.         ipc_call_free(call);
  313.         return (__native) rc;
  314.     }
  315.     if (!(res=request_preprocess(call)))
  316.         ipc_call(phone, call);
  317.     else
  318.         ipc_backsend_err(phone, call, res);
  319.  
  320.     return (__native) call;
  321. }
  322.  
  323. /** Forward received call to another destination
  324.  *
  325.  * The arg1 and arg2 are changed in the forwarded message
  326.  *
  327.  * Warning: If implementing non-fast version, make sure that
  328.  *          arg3 is not rewritten for certain system IPC
  329.  */
  330. __native sys_ipc_forward_fast(__native callid, __native phoneid,
  331.                   __native method, __native arg1)
  332. {
  333.     call_t *call;
  334.     phone_t *phone;
  335.  
  336.     call = get_call(callid);
  337.     if (!call)
  338.         return ENOENT;
  339.  
  340.     call->flags |= IPC_CALL_FORWARDED;
  341.  
  342.     GET_CHECK_PHONE(phone, phoneid, {
  343.         IPC_SET_RETVAL(call->data, EFORWARD);
  344.         ipc_answer(&TASK->answerbox, call);
  345.         return ENOENT;
  346.     });    
  347.  
  348.     if (!is_forwardable(IPC_GET_METHOD(call->data))) {
  349.         IPC_SET_RETVAL(call->data, EFORWARD);
  350.         ipc_answer(&TASK->answerbox, call);
  351.         return EPERM;
  352.     }
  353.  
  354.     /* Userspace is not allowed to change method of system methods
  355.      * on forward, allow changing ARG1 and ARG2 by means of method and arg1
  356.      */
  357.     if (is_system_method(IPC_GET_METHOD(call->data))) {
  358.         if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
  359.             phone_dealloc(IPC_GET_ARG3(call->data));
  360.  
  361.         IPC_SET_ARG1(call->data, method);
  362.         IPC_SET_ARG2(call->data, arg1);
  363.     } else {
  364.         IPC_SET_METHOD(call->data, method);
  365.         IPC_SET_ARG1(call->data, arg1);
  366.     }
  367.  
  368.     return ipc_forward(call, phone, &TASK->answerbox);
  369. }
  370.  
  371. /** Send IPC answer */
  372. __native sys_ipc_answer_fast(__native callid, __native retval,
  373.                  __native arg1, __native arg2)
  374. {
  375.     call_t *call;
  376.     ipc_data_t saved_data;
  377.     int saveddata = 0;
  378.  
  379.     call = get_call(callid);
  380.     if (!call)
  381.         return ENOENT;
  382.  
  383.     if (answer_need_old(call)) {
  384.         memcpy(&saved_data, &call->data, sizeof(call->data));
  385.         saveddata = 1;
  386.     }
  387.  
  388.     IPC_SET_RETVAL(call->data, retval);
  389.     IPC_SET_ARG1(call->data, arg1);
  390.     IPC_SET_ARG2(call->data, arg2);
  391.     answer_preprocess(call, saveddata ? &saved_data : NULL);
  392.  
  393.     ipc_answer(&TASK->answerbox, call);
  394.     return 0;
  395. }
  396.  
  397. /** Send IPC answer */
  398. __native sys_ipc_answer(__native callid, ipc_data_t *data)
  399. {
  400.     call_t *call;
  401.     ipc_data_t saved_data;
  402.     int saveddata = 0;
  403.     int rc;
  404.  
  405.     call = get_call(callid);
  406.     if (!call)
  407.         return ENOENT;
  408.  
  409.     if (answer_need_old(call)) {
  410.         memcpy(&saved_data, &call->data, sizeof(call->data));
  411.         saveddata = 1;
  412.     }
  413.     rc = copy_from_uspace(&call->data.args, &data->args,
  414.              sizeof(call->data.args));
  415.     if (rc != 0)
  416.         return rc;
  417.  
  418.     answer_preprocess(call, saveddata ? &saved_data : NULL);
  419.    
  420.     ipc_answer(&TASK->answerbox, call);
  421.  
  422.     return 0;
  423. }
  424.  
  425. /** Hang up the phone
  426.  *
  427.  */
  428. __native sys_ipc_hangup(int phoneid)
  429. {
  430.     phone_t *phone;
  431.  
  432.     GET_CHECK_PHONE(phone, phoneid, return ENOENT);
  433.  
  434.     if (ipc_phone_hangup(phone))
  435.         return -1;
  436.  
  437.     return 0;
  438. }
  439.  
  440. /** Wait for incoming ipc call or answer
  441.  *
  442.  * @param calldata Pointer to buffer where the call/answer data is stored
  443.  * @param flags
  444.  * @return Callid, if callid & 1, then the call is answer
  445.  */
  446. __native sys_ipc_wait_for_call(ipc_data_t *calldata, __native flags)
  447. {
  448.     call_t *call;
  449.  
  450. restart:   
  451.     call = ipc_wait_for_call(&TASK->answerbox, flags);
  452.     if (!call)
  453.         return 0;
  454.  
  455.     if (call->flags & IPC_CALL_NOTIF) {
  456.         ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
  457.         STRUCT_TO_USPACE(&calldata->args, &call->data.args);
  458.         ipc_call_free(call);
  459.        
  460.         return ((__native)call) | IPC_CALLID_NOTIFICATION;
  461.     }
  462.  
  463.     if (call->flags & IPC_CALL_ANSWERED) {
  464.         process_answer(call);
  465.  
  466.         ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
  467.  
  468.         atomic_dec(&TASK->active_calls);
  469.  
  470.         if (call->flags & IPC_CALL_DISCARD_ANSWER) {
  471.             ipc_call_free(call);
  472.             goto restart;
  473.         }
  474.  
  475.         STRUCT_TO_USPACE(&calldata->args, &call->data.args);
  476.         ipc_call_free(call);
  477.  
  478.         return ((__native)call) | IPC_CALLID_ANSWERED;
  479.     }
  480.  
  481.     if (process_request(&TASK->answerbox, call))
  482.         goto restart;
  483.  
  484.     /* Include phone address('id') of the caller in the request,
  485.      * copy whole call->data, not only call->data.args */
  486.     STRUCT_TO_USPACE(calldata, &call->data);
  487.     return (__native)call;
  488. }
  489.  
  490. /** Connect irq handler to task */
  491. __native sys_ipc_register_irq(__native irq, irq_code_t *ucode)
  492. {
  493.     if (irq >= IRQ_COUNT)
  494.         return -ELIMIT;
  495.  
  496.     irq_ipc_bind_arch(irq);
  497.  
  498.     return ipc_irq_register(&TASK->answerbox, irq, ucode);
  499. }
  500.  
  501. /* Disconnect irq handler from task */
  502. __native sys_ipc_unregister_irq(__native irq)
  503. {
  504.     if (irq >= IRQ_COUNT)
  505.         return -ELIMIT;
  506.  
  507.     ipc_irq_unregister(&TASK->answerbox, irq);
  508.  
  509.     return 0;
  510. }
  511.