Subversion Repositories HelenOS

Rev

Rev 1090 | Rev 1281 | 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 */
  46. #define IPC_CALL_NOTIF          (1<<5) /* Interrupt notification */
  47.  
  48. /* Flags for ipc_wait_for_call */
  49. #define IPC_WAIT_NONBLOCKING   1
  50.  
  51. /* Flags of callid (the addresses are aligned at least to 4,
  52.  * that is why we can use bottom 2 bits of the call address
  53.  */
  54. #define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
  55. #define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
  56.  
  57. /* Return values from IPC_ASYNC */
  58. #define IPC_CALLRET_FATAL         -1
  59. #define IPC_CALLRET_TEMPORARY     -2
  60.  
  61.  
  62. /* Macros for manipulating calling data */
  63. #define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
  64. #define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
  65. #define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
  66. #define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
  67. #define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
  68.  
  69. #define IPC_GET_METHOD(data)           ((data).args[0])
  70. #define IPC_GET_RETVAL(data)           ((data).args[0])
  71.  
  72. #define IPC_GET_ARG1(data)              ((data).args[1])
  73. #define IPC_GET_ARG2(data)              ((data).args[2])
  74. #define IPC_GET_ARG3(data)              ((data).args[3])
  75.  
  76. /* Well known phone descriptors */
  77. #define PHONE_NS              0
  78.  
  79. /* System-specific methods - only through special syscalls
  80.  * These methods have special behaviour
  81.  */
  82. /** Protocol for CONNECT - TO - ME
  83.  *
  84.  * Calling process asks the callee to create a callback connection,
  85.  * so that it can start initiating new messages.
  86.  *
  87.  * The protocol for negotiating is:
  88.  * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
  89.  * - sys_wait_for_call - upon receipt tries to allocate new phone
  90.  *                       - if it fails, responds with ELIMIT
  91.  *                     - passes call to userspace. If userspace
  92.  *                       responds with error, phone is deallocated and
  93.  *                       error is sent back to caller. Otherwise
  94.  *                       the call is accepted and the response is sent back.
  95.  *                     - the allocated phoneid is passed to userspace
  96.  *                       (on the receiving sid) as ARG3 of the call.
  97.  *                     - the caller obtains taskid of the called thread
  98.  */
  99. #define IPC_M_CONNECT_TO_ME     1
  100. /** Protocol for CONNECT - ME - TO
  101.  *
  102.  * Calling process asks the callee to create for him a new connection.
  103.  * E.g. the caller wants a name server to connect him to print server.
  104.  *
  105.  * The protocol for negotiating is:
  106.  * - sys_connect_me_to - send a synchronous message to name server
  107.  *                       indicating that it wants to be connected to some
  108.  *                       service
  109.  *                     - arg1/2 are user specified, arg3 contains
  110.  *                       address of the phone that should be connected
  111.  *                       (TODO: it leaks to userspace)
  112.  *   recepient         -  if ipc_answer == 0, then accept connection
  113.  *                     -  otherwise connection refused
  114.  *                     -  recepient may forward message. Forwarding
  115.  *                        system message
  116.  *
  117.  */
  118. #define IPC_M_CONNECT_ME_TO     2
  119. /** This message is sent to answerbox when the phone
  120.  * is hung up
  121.  */
  122. #define IPC_M_PHONE_HUNGUP      3
  123. /** Interrupt notification */
  124. #define IPC_M_INTERRUPT         4
  125.  
  126.  
  127. /* Well-known methods */
  128. #define IPC_M_LAST_SYSTEM     511
  129. #define IPC_M_PING            512
  130. /* User methods */
  131. #define FIRST_USER_METHOD     1024
  132.  
  133. #ifdef KERNEL
  134.  
  135. #include <synch/mutex.h>
  136. #include <synch/condvar.h>
  137. #include <adt/list.h>
  138.  
  139. #define IPC_MAX_PHONES  16
  140.  
  141. typedef struct answerbox_s answerbox_t;
  142. typedef struct phone_s phone_t;
  143. typedef struct {
  144.     __native args[IPC_CALL_LEN];
  145.     phone_t *phone;
  146. }ipc_data_t;
  147.  
  148. struct answerbox_s {
  149.     SPINLOCK_DECLARE(lock);
  150.  
  151.     task_t *task;
  152.  
  153.     waitq_t wq;
  154.  
  155.     link_t connected_phones; /**< Phones connected to this answerbox */
  156.     link_t calls;            /**< Received calls */
  157.     link_t dispatched_calls; /* Should be hash table in the future */
  158.  
  159.     link_t answers;          /**< Answered calls */
  160.  
  161.     SPINLOCK_DECLARE(irq_lock);
  162.     link_t irq_notifs;       /**< Notifications from IRQ handlers */
  163. };
  164.  
  165. typedef enum {
  166.     IPC_BUSY_FREE = 0,
  167.     IPC_BUSY_CONNECTING,
  168.     IPC_BUSY_CONNECTED
  169. } ipc_busy_t;
  170.  
  171. struct phone_s {
  172.     SPINLOCK_DECLARE(lock);
  173.     link_t list;
  174.     answerbox_t *callee;
  175.     ipc_busy_t busy;
  176.     atomic_t active_calls;
  177. };
  178.  
  179. typedef struct {
  180.     link_t list;
  181.  
  182.     int flags;
  183.  
  184.     /* Identification of the caller */
  185.     task_t *sender;
  186.     /* The caller box is different from sender->answerbox
  187.      * for synchronous calls
  188.      */
  189.     answerbox_t *callerbox;
  190.  
  191.     __native private; /**< Private data to internal IPC */
  192.  
  193.     ipc_data_t data;  /**< Data passed from/to userspace */
  194. }call_t;
  195.  
  196. extern void ipc_init(void);
  197. extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
  198. extern void ipc_answer(answerbox_t *box, call_t *request);
  199. extern int ipc_call(phone_t *phone, call_t *call);
  200. extern void ipc_call_sync(phone_t *phone, call_t *request);
  201. extern void ipc_phone_init(phone_t *phone);
  202. extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
  203. extern void ipc_call_free(call_t *call);
  204. extern call_t * ipc_call_alloc(int flags);
  205. extern void ipc_answerbox_init(answerbox_t *box);
  206. extern void ipc_call_static_init(call_t *call);
  207. extern void task_print_list(void);
  208. extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
  209. extern void ipc_cleanup(task_t *task);
  210. extern int ipc_phone_hangup(phone_t *phone);
  211. extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err);
  212.  
  213. extern int ipc_irq_register(answerbox_t *box, int irq);
  214. extern void ipc_irq_send_notif(int irq);
  215. extern void ipc_irq_unregister(answerbox_t *box, int irq);
  216.  
  217.  
  218. extern answerbox_t *ipc_phone_0;
  219.  
  220. #endif
  221.  
  222. #endif
  223.