Subversion Repositories HelenOS

Rev

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