Subversion Repositories HelenOS

Rev

Rev 2523 | Rev 2614 | 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        4
  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.  
  86. #define IPC_GET_METHOD(data)        ((data).args[0])
  87. #define IPC_GET_RETVAL(data)        ((data).args[0])
  88.  
  89. #define IPC_GET_ARG1(data)      ((data).args[1])
  90. #define IPC_GET_ARG2(data)      ((data).args[2])
  91. #define IPC_GET_ARG3(data)      ((data).args[3])
  92.  
  93. /* Well known phone descriptors */
  94. #define PHONE_NS    0
  95.  
  96. /* System-specific methods - only through special syscalls
  97.  * These methods have special behaviour
  98.  */
  99. /** Protocol for CONNECT - TO - ME
  100.  *
  101.  * Calling process asks the callee to create a callback connection,
  102.  * so that it can start initiating new messages.
  103.  *
  104.  * The protocol for negotiating is:
  105.  * - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME
  106.  * - sys_wait_for_call - upon receipt tries to allocate new phone
  107.  *                       - if it fails, responds with ELIMIT
  108.  *                     - passes call to userspace. If userspace
  109.  *                       responds with error, phone is deallocated and
  110.  *                       error is sent back to caller. Otherwise
  111.  *                       the call is accepted and the response is sent back.
  112.  *                     - the allocated phoneid is passed to userspace
  113.  *                       (on the receiving side) as ARG3 of the call.
  114.  *                     - the caller obtains taskid of the called thread
  115.  */
  116. #define IPC_M_CONNECT_TO_ME 1
  117. /** Protocol for CONNECT - ME - TO
  118.  *
  119.  * Calling process asks the callee to create for him a new connection.
  120.  * E.g. the caller wants a name server to connect him to print server.
  121.  *
  122.  * The protocol for negotiating is:
  123.  * - sys_connect_me_to - send a synchronous message to name server
  124.  *                       indicating that it wants to be connected to some
  125.  *                       service
  126.  *                     - arg1/2 are user specified, arg3 contains
  127.  *                       address of the phone that should be connected
  128.  *                       (TODO: it leaks to userspace)
  129.  *   recipient         -  if ipc_answer == 0, then accept connection
  130.  *                     -  otherwise connection refused
  131.  *                     -  recepient may forward message. Forwarding
  132.  *                        system message
  133.  *
  134.  */
  135. #define IPC_M_CONNECT_ME_TO 2
  136. /** This message is sent to answerbox when the phone
  137.  * is hung up
  138.  */
  139. #define IPC_M_PHONE_HUNGUP  3
  140.  
  141. /** Send as_area over IPC.
  142.  * - ARG1 - source as_area base address
  143.  * - ARG2 - size of source as_area (filled automatically by kernel)
  144.  * - ARG3 - flags of the as_area being sent
  145.  *
  146.  * on answer, the recipient must set:
  147.  * - ARG1 - dst as_area base adress
  148.  */
  149. #define IPC_M_AS_AREA_SEND  4  
  150.  
  151. /** Receive as_area over IPC.
  152.  * - ARG1 - destination as_area base address
  153.  * - ARG2 - destination as_area size
  154.  * - ARG3 - user defined argument
  155.  *
  156.  * on answer, the recipient must set:
  157.  *
  158.  * - ARG1 - source as_area base address
  159.  * - ARG2 - flags that will be used for sharing
  160.  */
  161. #define IPC_M_AS_AREA_RECV  5  
  162.  
  163. /** Send data to another address space over IPC.
  164.  * - ARG1 - destination address space virtual address, may be overriden by the
  165.  *      recipient
  166.  * - ARG2 - source address space virtual address
  167.  * - ARG3 - size of data to be copied, may be overriden by the recipient
  168.  *
  169.  * on answer, the recipient must set:
  170.  *
  171.  * - ARG1 - final destination address space virtual address
  172.  * - ARG3 - final size of data to be copied
  173.  */
  174. #define IPC_M_DATA_SEND     6
  175.  
  176. /* Well-known methods */
  177. #define IPC_M_LAST_SYSTEM   511
  178. #define IPC_M_PING      512
  179. /* User methods */
  180. #define FIRST_USER_METHOD   1024
  181.  
  182. #ifdef KERNEL
  183.  
  184. #define IPC_MAX_PHONES  16
  185.  
  186. #include <synch/waitq.h>
  187.  
  188. struct answerbox;
  189. struct task;
  190.  
  191. typedef enum {
  192.     /** Phone is free and can be allocated */
  193.     IPC_PHONE_FREE = 0,
  194.     /** Phone is connecting somewhere */
  195.     IPC_PHONE_CONNECTING,
  196.     /** Phone is connected */
  197.     IPC_PHONE_CONNECTED,
  198.     /** Phone is hung up, waiting for answers to come */
  199.     IPC_PHONE_HUNGUP,
  200.     /** Phone was hungup from server */
  201.     IPC_PHONE_SLAMMED
  202. } ipc_phone_state_t;
  203.  
  204. /** Structure identifying phone (in TASK structure) */
  205. typedef struct {
  206.     SPINLOCK_DECLARE(lock);
  207.     link_t link;
  208.     struct answerbox *callee;
  209.     ipc_phone_state_t state;
  210.     atomic_t active_calls;
  211. } phone_t;
  212.  
  213. typedef struct answerbox {
  214.     SPINLOCK_DECLARE(lock);
  215.  
  216.     struct task *task;
  217.  
  218.     waitq_t wq;
  219.  
  220.     /** Phones connected to this answerbox. */
  221.     link_t connected_phones;
  222.     /** Received calls. */
  223.     link_t calls;          
  224.     link_t dispatched_calls;    /* Should be hash table in the future */
  225.  
  226.     /** Answered calls. */
  227.     link_t answers;
  228.  
  229.     SPINLOCK_DECLARE(irq_lock);
  230.     /** Notifications from IRQ handlers. */
  231.     link_t irq_notifs;
  232.     /** IRQs with notifications to this answerbox. */
  233.     link_t irq_head;
  234. } answerbox_t;
  235.  
  236. typedef struct {
  237.     unative_t args[IPC_CALL_LEN];
  238.     phone_t *phone;
  239. } ipc_data_t;
  240.  
  241. typedef struct {
  242.     link_t link;
  243.  
  244.     int flags;
  245.  
  246.     /** Identification of the caller. */
  247.     struct task *sender;
  248.     /** The caller box is different from sender->answerbox for synchronous
  249.      *  calls. */
  250.     answerbox_t *callerbox;
  251.  
  252.     /** Private data to internal IPC. */
  253.     unative_t priv;
  254.  
  255.     /** Data passed from/to userspace. */
  256.     ipc_data_t data;
  257.  
  258.     /** Buffer for IPC_M_DATA_SEND. */
  259.     uint8_t *buffer;
  260. } call_t;
  261.  
  262. extern void ipc_init(void);
  263. extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
  264. extern void ipc_answer(answerbox_t *box, call_t *request);
  265. extern int ipc_call(phone_t *phone, call_t *call);
  266. extern void ipc_call_sync(phone_t *phone, call_t *request);
  267. extern void ipc_phone_init(phone_t *phone);
  268. extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
  269. extern void ipc_call_free(call_t *call);
  270. extern call_t * ipc_call_alloc(int flags);
  271. extern void ipc_answerbox_init(answerbox_t *box);
  272. extern void ipc_call_static_init(call_t *call);
  273. extern void task_print_list(void);
  274. extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
  275. extern void ipc_cleanup(void);
  276. extern int ipc_phone_hangup(phone_t *phone);
  277. extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err);
  278. extern void ipc_print_task(task_id_t taskid);
  279.  
  280. extern answerbox_t *ipc_phone_0;
  281.  
  282. #endif
  283.  
  284. #endif
  285.  
  286. /** @}
  287.  */
  288.