Subversion Repositories HelenOS

Rev

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