Subversion Repositories HelenOS

Rev

Rev 1365 | Rev 1443 | 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 <ipc/ipc.h>
  30. #include <libc.h>
  31. #include <malloc.h>
  32. #include <errno.h>
  33. #include <libadt/list.h>
  34. #include <stdio.h>
  35. #include <unistd.h>
  36. #include <futex.h>
  37. #include <kernel/synch/synch.h>
  38.  
  39. /** Structure used for keeping track of sent async msgs
  40.  * and queing unsent msgs
  41.  *
  42.  */
  43. typedef struct {
  44.     link_t list;
  45.  
  46.     ipc_async_callback_t callback;
  47.     void *private;
  48.     union {
  49.         ipc_callid_t callid;
  50.         struct {
  51.             ipc_call_t data;
  52.             int phoneid;
  53.         } msg;
  54.     }u;
  55. } async_call_t;
  56.  
  57. LIST_INITIALIZE(dispatched_calls);
  58. LIST_INITIALIZE(queued_calls);
  59.  
  60. static atomic_t ipc_futex = FUTEX_INITIALIZER;
  61.  
  62. int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,
  63.           ipcarg_t *result)
  64. {
  65.     ipc_call_t resdata;
  66.     int callres;
  67.    
  68.     callres = __SYSCALL4(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1,
  69.                  (sysarg_t)&resdata);
  70.     if (callres)
  71.         return callres;
  72.     if (result)
  73.         *result = IPC_GET_ARG1(resdata);
  74.     return IPC_GET_RETVAL(resdata);
  75. }
  76.  
  77. int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
  78.             ipcarg_t arg2, ipcarg_t arg3,
  79.             ipcarg_t *result1, ipcarg_t *result2, ipcarg_t *result3)
  80. {
  81.     ipc_call_t data;
  82.     int callres;
  83.  
  84.     IPC_SET_METHOD(data, method);
  85.     IPC_SET_ARG1(data, arg1);
  86.     IPC_SET_ARG2(data, arg2);
  87.     IPC_SET_ARG3(data, arg3);
  88.  
  89.     callres = __SYSCALL3(SYS_IPC_CALL_SYNC, phoneid, (sysarg_t)&data,
  90.                  (sysarg_t)&data);
  91.     if (callres)
  92.         return callres;
  93.  
  94.     if (result1)
  95.         *result1 = IPC_GET_ARG1(data);
  96.     if (result2)
  97.         *result2 = IPC_GET_ARG2(data);
  98.     if (result3)
  99.         *result3 = IPC_GET_ARG3(data);
  100.     return IPC_GET_RETVAL(data);
  101. }
  102.  
  103. /** Syscall to send asynchronous message */
  104. static  ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data)
  105. {
  106.     return __SYSCALL2(SYS_IPC_CALL_ASYNC, phoneid, (sysarg_t)data);
  107. }
  108.  
  109. /** Send asynchronous message
  110.  *
  111.  * - if fatal error, call callback handler with proper error code
  112.  * - if message cannot be temporarily sent, add to queue
  113.  */
  114. void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
  115.               ipcarg_t arg2, void *private,
  116.               ipc_async_callback_t callback)
  117. {
  118.     async_call_t *call;
  119.     ipc_callid_t callid;
  120.  
  121.     call = malloc(sizeof(*call));
  122.     if (!call) {
  123.         callback(private, ENOMEM, NULL);
  124.         return;
  125.     }
  126.        
  127.     callid = __SYSCALL4(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1, arg2);
  128.     if (callid == IPC_CALLRET_FATAL) {
  129.         /* Call asynchronous handler with error code */
  130.         callback(private, ENOENT, NULL);
  131.         free(call);
  132.         return;
  133.     }
  134.  
  135.     call->callback = callback;
  136.     call->private = private;
  137.  
  138.     if (callid == IPC_CALLRET_TEMPORARY) {
  139.         /* Add asynchronous call to queue of non-dispatched async calls */
  140.         call->u.msg.phoneid = phoneid;
  141.         IPC_SET_METHOD(call->u.msg.data, method);
  142.         IPC_SET_ARG1(call->u.msg.data, arg1);
  143.         IPC_SET_ARG2(call->u.msg.data, arg2);
  144.        
  145.         futex_down(&ipc_futex);
  146.         list_append(&call->list, &queued_calls);
  147.         futex_up(&ipc_futex);
  148.         return;
  149.     }
  150.     call->u.callid = callid;
  151.     /* Add call to list of dispatched calls */
  152.     futex_down(&ipc_futex);
  153.     list_append(&call->list, &dispatched_calls);
  154.     futex_up(&ipc_futex);
  155. }
  156.  
  157.  
  158. /** Send a fast answer to a received call.
  159.  *
  160.  * The fast answer makes use of passing retval and first two arguments in registers.
  161.  * If you need to return more, use the ipc_answer() instead.
  162.  *
  163.  * @param callid ID of the call being answered.
  164.  * @param retval Return value.
  165.  * @param arg1 First return argument.
  166.  * @param arg2 Second return argument.
  167.  *
  168.  * @return Zero on success or a value from @ref errno.h on failure.
  169.  */
  170. ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1,
  171.         ipcarg_t arg2)
  172. {
  173.     return __SYSCALL4(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2);
  174. }
  175.  
  176. /** Send a full answer to a received call.
  177.  *
  178.  * @param callid ID of the call being answered.
  179.  * @param call Call data. Must be already initialized by the responder.
  180.  *
  181.  * @return Zero on success or a value from @ref errno.h on failure.
  182.  */
  183. ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call)
  184. {
  185.     return __SYSCALL2(SYS_IPC_ANSWER, callid, (sysarg_t) call);
  186. }
  187.  
  188.  
  189. /** Try to dispatch queed calls from async queue */
  190. static void try_dispatch_queued_calls(void)
  191. {
  192.     async_call_t *call;
  193.     ipc_callid_t callid;
  194.  
  195.     futex_down(&ipc_futex);
  196.     while (!list_empty(&queued_calls)) {
  197.         call = list_get_instance(queued_calls.next, async_call_t,
  198.                      list);
  199.  
  200.         callid = _ipc_call_async(call->u.msg.phoneid,
  201.                      &call->u.msg.data);
  202.         if (callid == IPC_CALLRET_TEMPORARY)
  203.             break;
  204.         list_remove(&call->list);
  205.  
  206.         if (callid == IPC_CALLRET_FATAL) {
  207.             futex_up(&ipc_futex);
  208.             call->callback(call->private, ENOENT, NULL);
  209.             free(call);
  210.             futex_down(&ipc_futex);
  211.         } else {
  212.             call->u.callid = callid;
  213.             list_append(&call->list, &dispatched_calls);
  214.         }
  215.     }
  216.     futex_up(&ipc_futex);
  217. }
  218.  
  219. /** Handle received answer
  220.  *
  221.  * TODO: Make it use hash table
  222.  *
  223.  * @param callid Callid (with first bit set) of the answered call
  224.  */
  225. static void handle_answer(ipc_callid_t callid, ipc_call_t *data)
  226. {
  227.     link_t *item;
  228.     async_call_t *call;
  229.  
  230.     callid &= ~IPC_CALLID_ANSWERED;
  231.    
  232.     futex_down(&ipc_futex);
  233.     for (item = dispatched_calls.next; item != &dispatched_calls;
  234.          item = item->next) {
  235.         call = list_get_instance(item, async_call_t, list);
  236.         if (call->u.callid == callid) {
  237.             list_remove(&call->list);
  238.             futex_up(&ipc_futex);
  239.             call->callback(call->private,
  240.                        IPC_GET_RETVAL(*data),
  241.                        data);
  242.             return;
  243.         }
  244.     }
  245.     futex_up(&ipc_futex);
  246.     printf("Received unidentified answer: %P!!!\n", callid);
  247. }
  248.  
  249.  
  250. /** One cycle of ipc wait for call call
  251.  *
  252.  * - dispatch ASYNC reoutines in the background
  253.  * @param call Space where the message is stored
  254.  * @param usec Timeout in microseconds
  255.  * @param flags Flags passed to SYS_IPC_WAIT (blocking, nonblocking)
  256.  * @return Callid of the answer.
  257.  */
  258. ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags)
  259. {
  260.     ipc_callid_t callid;
  261.  
  262.     try_dispatch_queued_calls();
  263.    
  264.     callid = __SYSCALL3(SYS_IPC_WAIT, (sysarg_t) call, usec, flags);
  265.     /* Handle received answers */
  266.     if (callid & IPC_CALLID_ANSWERED)
  267.         handle_answer(callid, call);
  268.  
  269.     return callid;
  270. }
  271.  
  272. /** Wait some time for an IPC call.
  273.  *
  274.  * - dispatch ASYNC reoutines in the background
  275.  * @param call Space where the message is stored
  276.  * @param usec Timeout in microseconds.
  277.  * @return Callid of the answer.
  278.  */
  279. ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *call, uint32_t usec)
  280. {
  281.     ipc_callid_t callid;
  282.  
  283.     do {
  284.         callid = ipc_wait_cycle(call, usec, SYNCH_BLOCKING);
  285.     } while (callid & IPC_CALLID_ANSWERED);
  286.  
  287.     return callid;
  288. }
  289.  
  290. /** Check if there is an IPC call waiting to be picked up.
  291.  *
  292.  * - dispatch ASYNC reoutines in the background
  293.  * @param call Space where the message is stored
  294.  * @return Callid of the answer.
  295.  */
  296. ipc_callid_t ipc_trywait_for_call(ipc_call_t *call)
  297. {
  298.     ipc_callid_t callid;
  299.  
  300.     do {
  301.         callid = ipc_wait_cycle(call, SYNCH_NO_TIMEOUT, SYNCH_NON_BLOCKING);
  302.     } while (callid & IPC_CALLID_ANSWERED);
  303.  
  304.     return callid;
  305. }
  306.  
  307. /** Ask destination to do a callback connection
  308.  *
  309.  * @return 0 - OK, error code
  310.  */
  311. int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone)
  312. {
  313.     return ipc_call_sync_3(phoneid, IPC_M_CONNECT_TO_ME, arg1,
  314.                    arg2, 0, 0, 0, phone);
  315. }
  316.  
  317. /** Ask through phone for a new connection to some service
  318.  *
  319.  * @return new phoneid - OK, error code
  320.  */
  321. int ipc_connect_me_to(int phoneid, int arg1, int arg2)
  322. {
  323.     ipcarg_t newphid;
  324.     int res;
  325.  
  326.     res =  ipc_call_sync_3(phoneid, IPC_M_CONNECT_ME_TO, arg1,
  327.                    arg2, 0, 0, 0, &newphid);
  328.     if (res)
  329.         return res;
  330.     return newphid;
  331. }
  332.  
  333. /* Hang up specified phone */
  334. int ipc_hangup(int phoneid)
  335. {
  336.     return __SYSCALL1(SYS_IPC_HANGUP, phoneid);
  337. }
  338.  
  339. int ipc_register_irq(int irq, irq_code_t *ucode)
  340. {
  341.     return __SYSCALL2(SYS_IPC_REGISTER_IRQ, irq, (sysarg_t) ucode);
  342. }
  343.  
  344. int ipc_unregister_irq(int irq)
  345. {
  346.     return __SYSCALL1(SYS_IPC_UNREGISTER_IRQ, irq);
  347. }
  348.  
  349. int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method, ipcarg_t arg1)
  350. {
  351.     return __SYSCALL4(SYS_IPC_FORWARD_FAST, callid, phoneid, method, arg1);
  352. }
  353.  
  354.  
  355. /** Open shared memory connection over specified phoneid
  356.  *
  357.  *
  358.  * Allocate as_area, notify the other side about our intention
  359.  * to open the connection
  360.  *
  361.  * @return Connection id identifying this connection
  362.  */
  363. //int ipc_dgr_open(int pohoneid, size_t bufsize)
  364. //{
  365.     /* Find new file descriptor in local descriptor table */
  366.     /* Create AS_area, initialize structures */
  367.     /* Send AS to other side, handle error states */
  368.  
  369. //}
  370. /*
  371. void ipc_dgr_close(int cid)
  372. {
  373. }
  374.  
  375. void * ipc_dgr_alloc(int cid, size_t size)
  376. {
  377. }
  378.  
  379. void ipc_dgr_free(int cid, void *area)
  380. {
  381.  
  382. }
  383.  
  384. int ipc_dgr_send(int cid, void *area)
  385. {
  386. }
  387.  
  388.  
  389. int ipc_dgr_send_data(int cid, void *data, size_t size)
  390. {
  391. }
  392.  
  393. */
  394.