Subversion Repositories HelenOS

Rev

Rev 1923 | Rev 2025 | 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. #define IPC_CALL_ANSWERED       (1<<0) /**< This is answer to a call */
  51. #define IPC_CALL_STATIC_ALLOC   (1<<1) /**< This call will not be freed on error */
  52. #define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to
  53.                     * userspace, will be discarded */
  54. #define IPC_CALL_FORWARDED      (1<<3) /* Call was forwarded */
  55. #define IPC_CALL_CONN_ME_TO     (1<<4) /* Identify connect_me_to answer */
  56. #define IPC_CALL_NOTIF          (1<<5) /* Interrupt notification */
  57.  
  58. /* Flags of callid (the addresses are aligned at least to 4,
  59.  * that is why we can use bottom 2 bits of the call address
  60.  */
  61. #define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
  62. #define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
  63.  
  64. /* Return values from IPC_ASYNC */
  65. #define IPC_CALLRET_FATAL         -1
  66. #define IPC_CALLRET_TEMPORARY     -2
  67.  
  68.  
  69. /* Macros for manipulating calling data */
  70. #define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
  71. #define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
  72. #define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
  73. #define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
  74. #define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
  75.  
  76. #define IPC_GET_METHOD(data)           ((data).args[0])
  77. #define IPC_GET_RETVAL(data)           ((data).args[0])
  78.  
  79. #define IPC_GET_ARG1(data)              ((data).args[1])
  80. #define IPC_GET_ARG2(data)              ((data).args[2])
  81. #define IPC_GET_ARG3(data)              ((data).args[3])
  82.  
  83. /* Well known phone descriptors */
  84. #define PHONE_NS              0
  85.  
  86. /* System-specific methods - only through special syscalls
  87.  * These methods have special behaviour
  88.  */
  89. /** Protocol for CONNECT - TO - ME
  90.  *
  91.  * Calling process asks the callee to create a callback connection,
  92.  * so that it can start initiating new messages.
  93.  *
  94.  * The protocol for negotiating is:
  95.  * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
  96.  * - sys_wait_for_call - upon receipt tries to allocate new phone
  97.  *                       - if it fails, responds with ELIMIT
  98.  *                     - passes call to userspace. If userspace
  99.  *                       responds with error, phone is deallocated and
  100.  *                       error is sent back to caller. Otherwise
  101.  *                       the call is accepted and the response is sent back.
  102.  *                     - the allocated phoneid is passed to userspace
  103.  *                       (on the receiving sid) as ARG3 of the call.
  104.  *                     - the caller obtains taskid of the called thread
  105.  */
  106. #define IPC_M_CONNECT_TO_ME     1
  107. /** Protocol for CONNECT - ME - TO
  108.  *
  109.  * Calling process asks the callee to create for him a new connection.
  110.  * E.g. the caller wants a name server to connect him to print server.
  111.  *
  112.  * The protocol for negotiating is:
  113.  * - sys_connect_me_to - send a synchronous message to name server
  114.  *                       indicating that it wants to be connected to some
  115.  *                       service
  116.  *                     - arg1/2 are user specified, arg3 contains
  117.  *                       address of the phone that should be connected
  118.  *                       (TODO: it leaks to userspace)
  119.  *   recipient         -  if ipc_answer == 0, then accept connection
  120.  *                     -  otherwise connection refused
  121.  *                     -  recepient may forward message. Forwarding
  122.  *                        system message
  123.  *
  124.  */
  125. #define IPC_M_CONNECT_ME_TO     2
  126. /** This message is sent to answerbox when the phone
  127.  * is hung up
  128.  */
  129. #define IPC_M_PHONE_HUNGUP      3
  130.  
  131. /** Send as_area over IPC
  132.  * - ARG1 - src base address
  133.  * - ARG2 - size of src as(filled automatically by kernel)
  134.  * - ARG3 - flags of the area being sent
  135.  * - on answer ARG1 - dst base adress
  136.  */
  137. #define IPC_M_AS_AREA_SEND      5
  138.  
  139. /** Get as_area over IPC
  140.  * - ARG1 - Where the area will be mapped
  141.  * - ARG2 - Expected size of area
  142.  * - ARG3 - User defined argument
  143.  * on answer - the server sets ARG1 as src as address of the as_area
  144.  * to be shared, ARG2 is set to rights that will be used for sharing,
  145.  * which is returned as part of answer back to the receiver
  146.  */
  147. #define IPC_M_AS_AREA_RECV      6
  148.  
  149.  
  150. /* Well-known methods */
  151. #define IPC_M_LAST_SYSTEM     511
  152. #define IPC_M_PING            512
  153. /* User methods */
  154. #define FIRST_USER_METHOD     1024
  155.  
  156. #ifdef KERNEL
  157.  
  158. #include <synch/waitq.h>
  159. #include <adt/list.h>
  160.  
  161. #define IPC_MAX_PHONES  16
  162.  
  163. typedef struct answerbox_s answerbox_t;
  164. typedef struct phone_s phone_t;
  165. typedef struct {
  166.     unative_t args[IPC_CALL_LEN];
  167.     phone_t *phone;
  168. } ipc_data_t;
  169.  
  170. struct answerbox_s {
  171.     SPINLOCK_DECLARE(lock);
  172.  
  173.     task_t *task;
  174.  
  175.     waitq_t wq;
  176.  
  177.     link_t connected_phones;    /**< Phones connected to this answerbox */
  178.     link_t calls;           /**< Received calls */
  179.     link_t dispatched_calls;    /* Should be hash table in the future */
  180.  
  181.     link_t answers;         /**< Answered calls */
  182.  
  183.     SPINLOCK_DECLARE(irq_lock);
  184.     link_t irq_notifs;          /**< Notifications from IRQ handlers */
  185.     link_t irq_head;        /**< IRQs with notifications to this answerbox. */
  186. };
  187.  
  188. typedef enum {
  189.     IPC_PHONE_FREE = 0,     /**< Phone is free and can be allocated */
  190.     IPC_PHONE_CONNECTING,   /**< Phone is connecting somewhere */
  191.     IPC_PHONE_CONNECTED,    /**< Phone is connected */
  192.     IPC_PHONE_HUNGUP,   /**< Phone is hung up, waiting for answers to come */
  193.     IPC_PHONE_SLAMMED       /**< Phone was hungup from server */
  194. } ipc_phone_state_t;
  195.  
  196. /** Structure identifying phone (in TASK structure) */
  197. struct phone_s {
  198.     SPINLOCK_DECLARE(lock);
  199.     link_t link;
  200.     answerbox_t *callee;
  201.     ipc_phone_state_t state;
  202.     atomic_t active_calls;
  203. };
  204.  
  205. typedef struct {
  206.     link_t link;
  207.  
  208.     int flags;
  209.  
  210.     /* Identification of the caller */
  211.     task_t *sender;
  212.     /* The caller box is different from sender->answerbox
  213.      * for synchronous calls
  214.      */
  215.     answerbox_t *callerbox;
  216.  
  217.     unative_t private; /**< Private data to internal IPC */
  218.  
  219.     ipc_data_t data;  /**< Data passed from/to userspace */
  220. } call_t;
  221.  
  222. extern void ipc_init(void);
  223. extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
  224. extern void ipc_answer(answerbox_t *box, call_t *request);
  225. extern int ipc_call(phone_t *phone, call_t *call);
  226. extern void ipc_call_sync(phone_t *phone, call_t *request);
  227. extern void ipc_phone_init(phone_t *phone);
  228. extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
  229. extern void ipc_call_free(call_t *call);
  230. extern call_t * ipc_call_alloc(int flags);
  231. extern void ipc_answerbox_init(answerbox_t *box);
  232. extern void ipc_call_static_init(call_t *call);
  233. extern void task_print_list(void);
  234. extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
  235. void ipc_cleanup(void);
  236. int ipc_phone_hangup(phone_t *phone);
  237. extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err);
  238. extern void ipc_print_task(task_id_t taskid);
  239.  
  240. extern answerbox_t *ipc_phone_0;
  241.  
  242. #endif
  243.  
  244. #endif
  245.  
  246. /** @}
  247.  */
  248.