Subversion Repositories HelenOS

Rev

Rev 2812 | Rev 3425 | 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. #ifndef KERN_IPC_H_
  36. #define KERN_IPC_H_
  37.  
  38. /* Length of data being transfered with IPC call */
  39. /* - the uspace may not be able to utilize full length */
  40. #define IPC_CALL_LEN        6  
  41.  
  42. /** Maximum active async calls per thread */
  43. #ifdef CONFIG_DEBUG
  44. #define IPC_MAX_ASYNC_CALLS 4
  45. #else
  46. #define IPC_MAX_ASYNC_CALLS 4000
  47. #endif
  48.  
  49. /* Flags for calls */
  50.  
  51. /** This is answer to a call */
  52. #define IPC_CALL_ANSWERED   (1 << 0)
  53. /** This call will not be freed on error */
  54. #define IPC_CALL_STATIC_ALLOC   (1 << 1)
  55. /** Answer will not be passed to userspace, will be discarded */
  56. #define IPC_CALL_DISCARD_ANSWER (1 << 2)
  57. /** Call was forwarded */
  58. #define IPC_CALL_FORWARDED  (1 << 3)
  59. /** Identify connect_me_to answer */
  60. #define IPC_CALL_CONN_ME_TO (1 << 4)
  61. /** Interrupt notification */
  62. #define IPC_CALL_NOTIF      (1 << 5)
  63.  
  64. /*
  65.  * Bits used in call hashes.
  66.  * The addresses are aligned at least to 4 that is why we can use the 2 least
  67.  * significant bits of the call address.
  68.  */
  69. /** Type of this call is 'answer' */
  70. #define IPC_CALLID_ANSWERED 1
  71. /** Type of this call is 'notification' */
  72. #define IPC_CALLID_NOTIFICATION 2
  73.  
  74. /* Return values from sys_ipc_call_async(). */
  75. #define IPC_CALLRET_FATAL   -1
  76. #define IPC_CALLRET_TEMPORARY   -2
  77.  
  78.  
  79. /* Macros for manipulating calling data */
  80. #define IPC_SET_RETVAL(data, retval)    ((data).args[0] = (retval))
  81. #define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
  82. #define IPC_SET_ARG1(data, val)     ((data).args[1] = (val))
  83. #define IPC_SET_ARG2(data, val)     ((data).args[2] = (val))
  84. #define IPC_SET_ARG3(data, val)     ((data).args[3] = (val))
  85. #define IPC_SET_ARG4(data, val)     ((data).args[4] = (val))
  86. #define IPC_SET_ARG5(data, val)     ((data).args[5] = (val))
  87.  
  88. #define IPC_GET_METHOD(data)        ((data).args[0])
  89. #define IPC_GET_RETVAL(data)        ((data).args[0])
  90.  
  91. #define IPC_GET_ARG1(data)      ((data).args[1])
  92. #define IPC_GET_ARG2(data)      ((data).args[2])
  93. #define IPC_GET_ARG3(data)      ((data).args[3])
  94. #define IPC_GET_ARG4(data)      ((data).args[4])
  95. #define IPC_GET_ARG5(data)      ((data).args[5])
  96.  
  97. /* Well known phone descriptors */
  98. #define PHONE_NS    0
  99.  
  100. /* Forwarding flags. */
  101. #define IPC_FF_NONE     0
  102. /**
  103.  * The call will be routed as though it was initially sent via the phone used to
  104.  * forward it. This feature is intended to support the situation in which the
  105.  * forwarded call needs to be handled by the same connection fibril as any other
  106.  * calls that were initially sent by the forwarder to the same destination. This
  107.  * flag has no imapct on routing replies.
  108.  */
  109. #define IPC_FF_ROUTE_FROM_ME    (1 << 0)
  110.  
  111. /* System-specific methods - only through special syscalls
  112.  * These methods have special behaviour
  113.  */
  114. /** Protocol for CONNECT - TO - ME
  115.  *
  116.  * Calling process asks the callee to create a callback connection,
  117.  * so that it can start initiating new messages.
  118.  *
  119.  * The protocol for negotiating is:
  120.  * - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME
  121.  * - recipient         - upon receipt tries to allocate new phone
  122.  *                       - if it fails, responds with ELIMIT
  123.  *                     - passes call to userspace. If userspace
  124.  *                       responds with error, phone is deallocated and
  125.  *                       error is sent back to caller. Otherwise
  126.  *                       the call is accepted and the response is sent back.
  127.  *                     - the allocated phoneid is passed to userspace
  128.  *                       (on the receiving side) as ARG5 of the call.
  129.  */
  130. #define IPC_M_CONNECT_TO_ME 1
  131. /** Protocol for CONNECT - ME - TO
  132.  *
  133.  * Calling process asks the callee to create for him a new connection.
  134.  * E.g. the caller wants a name server to connect him to print server.
  135.  *
  136.  * The protocol for negotiating is:
  137.  * - sys_connect_me_to - send a synchronous message to name server
  138.  *                       indicating that it wants to be connected to some
  139.  *                       service
  140.  *                     - arg1/2/3 are user specified, arg5 contains
  141.  *                       address of the phone that should be connected
  142.  *                       (TODO: it leaks to userspace)
  143.  *  - recipient        -  if ipc_answer == 0, then accept connection
  144.  *                     -  otherwise connection refused
  145.  *                     -  recepient may forward message.
  146.  *
  147.  */
  148. #define IPC_M_CONNECT_ME_TO 2
  149. /** This message is sent to answerbox when the phone
  150.  * is hung up
  151.  */
  152. #define IPC_M_PHONE_HUNGUP  3
  153.  
  154. /** Send as_area over IPC.
  155.  * - ARG1 - source as_area base address
  156.  * - ARG2 - size of source as_area (filled automatically by kernel)
  157.  * - ARG3 - flags of the as_area being sent
  158.  *
  159.  * on answer, the recipient must set:
  160.  * - ARG1 - dst as_area base adress
  161.  */
  162. #define IPC_M_SHARE_OUT     4  
  163.  
  164. /** Receive as_area over IPC.
  165.  * - ARG1 - destination as_area base address
  166.  * - ARG2 - destination as_area size
  167.  * - ARG3 - user defined argument
  168.  *
  169.  * on answer, the recipient must set:
  170.  *
  171.  * - ARG1 - source as_area base address
  172.  * - ARG2 - flags that will be used for sharing
  173.  */
  174. #define IPC_M_SHARE_IN      5  
  175.  
  176. /** Send data to another address space over IPC.
  177.  * - ARG1 - source address space virtual address
  178.  * - ARG2 - size of data to be copied, may be overriden by the recipient
  179.  *
  180.  * on answer, the recipient must set:
  181.  *
  182.  * - ARG1 - final destination address space virtual address
  183.  * - ARG2 - final size of data to be copied
  184.  */
  185. #define IPC_M_DATA_WRITE    6
  186.  
  187. /** Receive data from another address space over IPC.
  188.  * - ARG1 - destination virtual address in the source address space
  189.  * - ARG2 - size of data to be received, may be cropped by the recipient
  190.  *
  191.  * on answer, the recipient must set:
  192.  *
  193.  * - ARG1 - source virtual address in the destination address space
  194.  * - ARG2 - final size of data to be copied
  195.  */
  196. #define IPC_M_DATA_READ     7
  197.  
  198. /** Debug the recipient.
  199.  * - ARG1 - specifies the debug method (from udebug_method_t)
  200.  * - other arguments are specific to the debug method
  201.  */
  202. #define IPC_M_DEBUG_ALL     8
  203.  
  204. /* Well-known methods */
  205. #define IPC_M_LAST_SYSTEM   511
  206. #define IPC_M_PING      512
  207. /* User methods */
  208. #define IPC_FIRST_USER_METHOD   1024
  209.  
  210. #ifdef KERNEL
  211.  
  212. #define IPC_MAX_PHONES  16
  213.  
  214. #include <synch/spinlock.h>
  215. #include <synch/mutex.h>
  216. #include <synch/waitq.h>
  217.  
  218. struct answerbox;
  219. struct task;
  220.  
  221. typedef enum {
  222.     /** Phone is free and can be allocated */
  223.     IPC_PHONE_FREE = 0,
  224.     /** Phone is connecting somewhere */
  225.     IPC_PHONE_CONNECTING,
  226.     /** Phone is connected */
  227.     IPC_PHONE_CONNECTED,
  228.     /** Phone is hung up, waiting for answers to come */
  229.     IPC_PHONE_HUNGUP,
  230.     /** Phone was hungup from server */
  231.     IPC_PHONE_SLAMMED
  232. } ipc_phone_state_t;
  233.  
  234. /** Structure identifying phone (in TASK structure) */
  235. typedef struct {
  236.     mutex_t lock;
  237.     link_t link;
  238.     struct answerbox *callee;
  239.     ipc_phone_state_t state;
  240.     atomic_t active_calls;
  241. } phone_t;
  242.  
  243. typedef struct answerbox {
  244.     SPINLOCK_DECLARE(lock);
  245.  
  246.     struct task *task;
  247.  
  248.     waitq_t wq;
  249.  
  250.     /** Phones connected to this answerbox. */
  251.     link_t connected_phones;
  252.     /** Received calls. */
  253.     link_t calls;          
  254.     link_t dispatched_calls;    /* Should be hash table in the future */
  255.  
  256.     /** Answered calls. */
  257.     link_t answers;
  258.  
  259.     SPINLOCK_DECLARE(irq_lock);
  260.     /** Notifications from IRQ handlers. */
  261.     link_t irq_notifs;
  262.     /** IRQs with notifications to this answerbox. */
  263.     link_t irq_head;
  264. } answerbox_t;
  265.  
  266. typedef struct {
  267.     unative_t args[IPC_CALL_LEN];
  268.     phone_t *phone;
  269. } ipc_data_t;
  270.  
  271. typedef struct {
  272.     link_t link;
  273.  
  274.     int flags;
  275.  
  276.     /** Identification of the caller. */
  277.     struct task *sender;
  278.     /** The caller box is different from sender->answerbox for synchronous
  279.      *  calls. */
  280.     answerbox_t *callerbox;
  281.  
  282.     /** Private data to internal IPC. */
  283.     unative_t priv;
  284.  
  285.     /** Data passed from/to userspace. */
  286.     ipc_data_t data;
  287.  
  288.     /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */
  289.     uint8_t *buffer;
  290. } call_t;
  291.  
  292. extern void ipc_init(void);
  293. extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
  294. extern void ipc_answer(answerbox_t *box, call_t *request);
  295. extern int ipc_call(phone_t *phone, call_t *call);
  296. extern void ipc_call_sync(phone_t *phone, call_t *request);
  297. extern void ipc_phone_init(phone_t *phone);
  298. extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
  299. extern void ipc_call_free(call_t *call);
  300. extern call_t * ipc_call_alloc(int flags);
  301. extern void ipc_answerbox_init(answerbox_t *box, struct task *task);
  302. extern void ipc_call_static_init(call_t *call);
  303. extern void task_print_list(void);
  304. extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox,
  305.     int mode);
  306. extern void ipc_cleanup(void);
  307. extern int ipc_phone_hangup(phone_t *phone);
  308. extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err);
  309. extern void ipc_print_task(task_id_t taskid);
  310. extern int ipc_connect_kbox(task_id_t taskid);
  311.  
  312. extern answerbox_t *ipc_phone_0;
  313.  
  314. #endif
  315.  
  316. #endif
  317.  
  318. /** @}
  319.  */
  320.