2 * Copyright (C) 2006 Ondrej Palkovsky
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
29 /** @addtogroup genericipc
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
42 /** Maximum active async calls per thread */
44 # define IPC_MAX_ASYNC_CALLS 4
46 # define IPC_MAX_ASYNC_CALLS 4000
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 userspace, will be discarded */
53 #define IPC_CALL_FORWARDED (1<<3) /**< Call was forwarded */
54 #define IPC_CALL_CONN_ME_TO (1<<4) /**< Identify connect_me_to answer */
55 #define IPC_CALL_NOTIF (1<<5) /**< Interrupt notification */
57 /* Flags of callid (the addresses are aligned at least to 4,
58 * that is why we can use bottom 2 bits of the call address
60 #define IPC_CALLID_ANSWERED 1 /**< Type of this msg is 'answer' */
61 #define IPC_CALLID_NOTIFICATION 2 /**< Type of this msg is 'notification' */
63 /* Return values from IPC_ASYNC */
64 #define IPC_CALLRET_FATAL -1
65 #define IPC_CALLRET_TEMPORARY -2
68 /* Macros for manipulating calling data */
69 #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval))
70 #define IPC_SET_METHOD(data, val) ((data).args[0] = (val))
71 #define IPC_SET_ARG1(data, val) ((data).args[1] = (val))
72 #define IPC_SET_ARG2(data, val) ((data).args[2] = (val))
73 #define IPC_SET_ARG3(data, val) ((data).args[3] = (val))
75 #define IPC_GET_METHOD(data) ((data).args[0])
76 #define IPC_GET_RETVAL(data) ((data).args[0])
78 #define IPC_GET_ARG1(data) ((data).args[1])
79 #define IPC_GET_ARG2(data) ((data).args[2])
80 #define IPC_GET_ARG3(data) ((data).args[3])
82 /* Well known phone descriptors */
85 /* System-specific methods - only through special syscalls
86 * These methods have special behaviour
88 /** Protocol for CONNECT - TO - ME
90 * Calling process asks the callee to create a callback connection,
91 * so that it can start initiating new messages.
93 * The protocol for negotiating is:
94 * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
95 * - sys_wait_for_call - upon receipt tries to allocate new phone
96 * - if it fails, responds with ELIMIT
97 * - passes call to userspace. If userspace
98 * responds with error, phone is deallocated and
99 * error is sent back to caller. Otherwise
100 * the call is accepted and the response is sent back.
101 * - the allocated phoneid is passed to userspace
102 * (on the receiving sid) as ARG3 of the call.
103 * - the caller obtains taskid of the called thread
105 #define IPC_M_CONNECT_TO_ME 1
106 /** Protocol for CONNECT - ME - TO
108 * Calling process asks the callee to create for him a new connection.
109 * E.g. the caller wants a name server to connect him to print server.
111 * The protocol for negotiating is:
112 * - sys_connect_me_to - send a synchronous message to name server
113 * indicating that it wants to be connected to some
115 * - arg1/2 are user specified, arg3 contains
116 * address of the phone that should be connected
117 * (TODO: it leaks to userspace)
118 * recipient - if ipc_answer == 0, then accept connection
119 * - otherwise connection refused
120 * - recepient may forward message. Forwarding
124 #define IPC_M_CONNECT_ME_TO 2
125 /** This message is sent to answerbox when the phone
128 #define IPC_M_PHONE_HUNGUP 3
130 /** Send as_area over IPC
131 * - ARG1 - src as_area base address
132 * - ARG2 - size of src as_area (filled automatically by kernel)
133 * - ARG3 - flags of the as_area being sent
136 * - ARG1 - dst as_area base adress
138 #define IPC_M_AS_AREA_SEND 5
140 /** Get as_area over IPC
141 * - ARG1 - dst as_area base address
142 * - ARG2 - dst as_area size
143 * - ARG3 - user defined argument
145 * on answer, the server must set:
147 * - ARG1 - src as_area base address
148 * - ARG2 - flags that will be used for sharing
150 #define IPC_M_AS_AREA_RECV 6
153 /* Well-known methods */
154 #define IPC_M_LAST_SYSTEM 511
155 #define IPC_M_PING 512
157 #define FIRST_USER_METHOD 1024
161 #include <synch/waitq.h>
162 #include <adt/list.h>
164 #define IPC_MAX_PHONES 16
166 typedef struct answerbox_s answerbox_t
;
167 typedef struct phone_s phone_t
;
169 unative_t args
[IPC_CALL_LEN
];
174 SPINLOCK_DECLARE(lock
);
180 link_t connected_phones
; /**< Phones connected to this answerbox */
181 link_t calls
; /**< Received calls */
182 link_t dispatched_calls
; /* Should be hash table in the future */
184 link_t answers
; /**< Answered calls */
186 SPINLOCK_DECLARE(irq_lock
);
187 link_t irq_notifs
; /**< Notifications from IRQ handlers */
188 link_t irq_head
; /**< IRQs with notifications to this answerbox. */
192 IPC_PHONE_FREE
= 0, /**< Phone is free and can be allocated */
193 IPC_PHONE_CONNECTING
, /**< Phone is connecting somewhere */
194 IPC_PHONE_CONNECTED
, /**< Phone is connected */
195 IPC_PHONE_HUNGUP
, /**< Phone is hung up, waiting for answers to come */
196 IPC_PHONE_SLAMMED
/**< Phone was hungup from server */
199 /** Structure identifying phone (in TASK structure) */
201 SPINLOCK_DECLARE(lock
);
204 ipc_phone_state_t state
;
205 atomic_t active_calls
;
213 /* Identification of the caller */
215 /* The caller box is different from sender->answerbox
216 * for synchronous calls
218 answerbox_t
*callerbox
;
220 unative_t
private; /**< Private data to internal IPC */
222 ipc_data_t data
; /**< Data passed from/to userspace */
225 extern void ipc_init(void);
226 extern call_t
* ipc_wait_for_call(answerbox_t
*box
, uint32_t usec
, int flags
);
227 extern void ipc_answer(answerbox_t
*box
, call_t
*request
);
228 extern int ipc_call(phone_t
*phone
, call_t
*call
);
229 extern void ipc_call_sync(phone_t
*phone
, call_t
*request
);
230 extern void ipc_phone_init(phone_t
*phone
);
231 extern void ipc_phone_connect(phone_t
*phone
, answerbox_t
*box
);
232 extern void ipc_call_free(call_t
*call
);
233 extern call_t
* ipc_call_alloc(int flags
);
234 extern void ipc_answerbox_init(answerbox_t
*box
);
235 extern void ipc_call_static_init(call_t
*call
);
236 extern void task_print_list(void);
237 extern int ipc_forward(call_t
*call
, phone_t
*newphone
, answerbox_t
*oldbox
);
238 void ipc_cleanup(void);
239 int ipc_phone_hangup(phone_t
*phone
);
240 extern void ipc_backsend_err(phone_t
*phone
, call_t
*call
, unative_t err
);
241 extern void ipc_print_task(task_id_t taskid
);
243 extern answerbox_t
*ipc_phone_0
;