WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/ipc/ipc.h


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericipc
 * @{
 */
/** @file
 */
 
#ifndef KERN_IPC_H_
#define KERN_IPC_H_
 
/* Length of data being transfered with IPC call */
/* - the uspace may not be able to utilize full length */
#define IPC_CALL_LEN    4
 
/** Maximum active async calls per thread */
#ifdef CONFIG_DEBUG
# define IPC_MAX_ASYNC_CALLS  4
#else
# define IPC_MAX_ASYNC_CALLS  4000
#endif
 
/* Flags for calls */
#define IPC_CALL_ANSWERED       (1<<0) /**< This is answer to a call */
#define IPC_CALL_STATIC_ALLOC   (1<<1) /**< This call will not be freed on error */
#define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to userspace, will be discarded */
#define IPC_CALL_FORWARDED      (1<<3) /**< Call was forwarded */
#define IPC_CALL_CONN_ME_TO     (1<<4) /**< Identify connect_me_to answer */
#define IPC_CALL_NOTIF          (1<<5) /**< Interrupt notification */
 
/* Flags of callid (the addresses are aligned at least to 4,
 * that is why we can use bottom 2 bits of the call address
 */
#define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
#define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
 
/* Return values from IPC_ASYNC */
#define IPC_CALLRET_FATAL         -1
#define IPC_CALLRET_TEMPORARY     -2
 
 
/* Macros for manipulating calling data */
#define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
#define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
#define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
#define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
#define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
 
#define IPC_GET_METHOD(data)           ((data).args[0])
#define IPC_GET_RETVAL(data)           ((data).args[0])
 
#define IPC_GET_ARG1(data)              ((data).args[1])
#define IPC_GET_ARG2(data)              ((data).args[2])
#define IPC_GET_ARG3(data)              ((data).args[3])
 
/* Well known phone descriptors */
#define PHONE_NS              0
 
/* System-specific methods - only through special syscalls
 * These methods have special behaviour
 */
/** Protocol for CONNECT - TO - ME
 *
 * Calling process asks the callee to create a callback connection,
 * so that it can start initiating new messages.
 *
 * The protocol for negotiating is:
 * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
 * - sys_wait_for_call - upon receipt tries to allocate new phone
 *                       - if it fails, responds with ELIMIT
 *                     - passes call to userspace. If userspace
 *                       responds with error, phone is deallocated and
 *                       error is sent back to caller. Otherwise
 *                       the call is accepted and the response is sent back.
 *                     - the allocated phoneid is passed to userspace
 *                       (on the receiving sid) as ARG3 of the call.
 *                     - the caller obtains taskid of the called thread
 */
#define IPC_M_CONNECT_TO_ME     1
/** Protocol for CONNECT - ME - TO
 *
 * Calling process asks the callee to create for him a new connection.
 * E.g. the caller wants a name server to connect him to print server.
 *
 * The protocol for negotiating is:
 * - sys_connect_me_to - send a synchronous message to name server
 *                       indicating that it wants to be connected to some
 *                       service
 *                     - arg1/2 are user specified, arg3 contains
 *                       address of the phone that should be connected
 *                       (TODO: it leaks to userspace)
 *   recipient         -  if ipc_answer == 0, then accept connection
 *                     -  otherwise connection refused
 *                     -  recepient may forward message. Forwarding
 *                        system message
 *
 */
#define IPC_M_CONNECT_ME_TO     2
/** This message is sent to answerbox when the phone
 * is hung up
 */
#define IPC_M_PHONE_HUNGUP      3
 
/** Send as_area over IPC
 * - ARG1 - src as_area base address
 * - ARG2 - size of src as_area (filled automatically by kernel)
 * - ARG3 - flags of the as_area being sent
 *
 * on answer:
 * - ARG1 - dst as_area base adress
 */
#define IPC_M_AS_AREA_SEND      5
 
/** Get as_area over IPC
 * - ARG1 - dst as_area base address
 * - ARG2 - dst as_area size
 * - ARG3 - user defined argument
 *
 * on answer, the server must set:
 *
 * - ARG1 - src as_area base address
 * - ARG2 - flags that will be used for sharing
 */
#define IPC_M_AS_AREA_RECV      6
 
 
/* Well-known methods */
#define IPC_M_LAST_SYSTEM     511
#define IPC_M_PING            512
/* User methods */
#define FIRST_USER_METHOD     1024
 
#ifdef KERNEL
 
#include <synch/waitq.h>
#include <adt/list.h>
 
#define IPC_MAX_PHONES  16
 
typedef struct answerbox_s answerbox_t;
typedef struct phone_s phone_t;
typedef struct {
    unative_t args[IPC_CALL_LEN];
    phone_t *phone;
} ipc_data_t;
 
struct answerbox_s {
    SPINLOCK_DECLARE(lock);
 
    task_t *task;
 
    waitq_t wq;
 
    link_t connected_phones;    /**< Phones connected to this answerbox */
    link_t calls;           /**< Received calls */
    link_t dispatched_calls;    /* Should be hash table in the future */
 
    link_t answers;         /**< Answered calls */
 
    SPINLOCK_DECLARE(irq_lock);
    link_t irq_notifs;          /**< Notifications from IRQ handlers */
    link_t irq_head;        /**< IRQs with notifications to this answerbox. */
};
 
typedef enum {
    IPC_PHONE_FREE = 0,     /**< Phone is free and can be allocated */
    IPC_PHONE_CONNECTING,   /**< Phone is connecting somewhere */
    IPC_PHONE_CONNECTED,    /**< Phone is connected */
    IPC_PHONE_HUNGUP,   /**< Phone is hung up, waiting for answers to come */
    IPC_PHONE_SLAMMED       /**< Phone was hungup from server */
} ipc_phone_state_t;
 
/** Structure identifying phone (in TASK structure) */
struct phone_s {
    SPINLOCK_DECLARE(lock);
    link_t link;
    answerbox_t *callee;
    ipc_phone_state_t state;
    atomic_t active_calls;
};
 
typedef struct {
    link_t link;
 
    int flags;
 
    /* Identification of the caller */
    task_t *sender;
    /* The caller box is different from sender->answerbox
     * for synchronous calls
     */
    answerbox_t *callerbox;
 
    unative_t private; /**< Private data to internal IPC */
 
    ipc_data_t data;  /**< Data passed from/to userspace */
} call_t;
 
extern void ipc_init(void);
extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
extern void ipc_answer(answerbox_t *box, call_t *request);
extern int ipc_call(phone_t *phone, call_t *call);
extern void ipc_call_sync(phone_t *phone, call_t *request);
extern void ipc_phone_init(phone_t *phone);
extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
extern void ipc_call_free(call_t *call);
extern call_t * ipc_call_alloc(int flags);
extern void ipc_answerbox_init(answerbox_t *box);
extern void ipc_call_static_init(call_t *call);
extern void task_print_list(void);
extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
void ipc_cleanup(void);
int ipc_phone_hangup(phone_t *phone);
extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err);
extern void ipc_print_task(task_id_t taskid);
 
extern answerbox_t *ipc_phone_0;
 
#endif
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ipc/ipc.h – Rev 2026 → 2071

Rev 2026		Rev 2071
1	/*	1	/*
2	* Copyright (C) 2006 Ondrej Palkovsky	2	* Copyright (c) 2006 Ondrej Palkovsky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericipc	29	/** @addtogroup genericipc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_IPC_H_	35	#ifndef KERN_IPC_H_
36	#define KERN_IPC_H_	36	#define KERN_IPC_H_
37		37
38	/* Length of data being transfered with IPC call */	38	/* Length of data being transfered with IPC call */
39	/* - the uspace may not be able to utilize full length */	39	/* - the uspace may not be able to utilize full length */
40	#define IPC_CALL_LEN 4	40	#define IPC_CALL_LEN 4
41		41
42	/** Maximum active async calls per thread */	42	/** Maximum active async calls per thread */
43	#ifdef CONFIG_DEBUG	43	#ifdef CONFIG_DEBUG
44	# define IPC_MAX_ASYNC_CALLS 4	44	# define IPC_MAX_ASYNC_CALLS 4
45	#else	45	#else
46	# define IPC_MAX_ASYNC_CALLS 4000	46	# define IPC_MAX_ASYNC_CALLS 4000
47	#endif	47	#endif
48		48
49	/* Flags for calls */	49	/* Flags for calls */
50	#define IPC_CALL_ANSWERED (1<<0) /*< This is answer to a call /	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 /	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 /	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 /	53	#define IPC_CALL_FORWARDED (1<<3) /*< Call was forwarded /
54	#define IPC_CALL_CONN_ME_TO (1<<4) /*< Identify connect_me_to answer /	54	#define IPC_CALL_CONN_ME_TO (1<<4) /*< Identify connect_me_to answer /
55	#define IPC_CALL_NOTIF (1<<5) /*< Interrupt notification /	55	#define IPC_CALL_NOTIF (1<<5) /*< Interrupt notification /
56		56
57	/* Flags of callid (the addresses are aligned at least to 4,	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	58	* that is why we can use bottom 2 bits of the call address
59	*/	59	*/
60	#define IPC_CALLID_ANSWERED 1 /*< Type of this msg is 'answer' /	60	#define IPC_CALLID_ANSWERED 1 /*< Type of this msg is 'answer' /
61	#define IPC_CALLID_NOTIFICATION 2 /*< Type of this msg is 'notification' /	61	#define IPC_CALLID_NOTIFICATION 2 /*< Type of this msg is 'notification' /
62		62
63	/* Return values from IPC_ASYNC */	63	/* Return values from IPC_ASYNC */
64	#define IPC_CALLRET_FATAL -1	64	#define IPC_CALLRET_FATAL -1
65	#define IPC_CALLRET_TEMPORARY -2	65	#define IPC_CALLRET_TEMPORARY -2
66		66
67		67
68	/* Macros for manipulating calling data */	68	/* Macros for manipulating calling data */
69	#define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval))	69	#define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval))
70	#define IPC_SET_METHOD(data, val) ((data).args[0] = (val))	70	#define IPC_SET_METHOD(data, val) ((data).args[0] = (val))
71	#define IPC_SET_ARG1(data, val) ((data).args[1] = (val))	71	#define IPC_SET_ARG1(data, val) ((data).args[1] = (val))
72	#define IPC_SET_ARG2(data, val) ((data).args[2] = (val))	72	#define IPC_SET_ARG2(data, val) ((data).args[2] = (val))
73	#define IPC_SET_ARG3(data, val) ((data).args[3] = (val))	73	#define IPC_SET_ARG3(data, val) ((data).args[3] = (val))
74		74
75	#define IPC_GET_METHOD(data) ((data).args[0])	75	#define IPC_GET_METHOD(data) ((data).args[0])
76	#define IPC_GET_RETVAL(data) ((data).args[0])	76	#define IPC_GET_RETVAL(data) ((data).args[0])
77		77
78	#define IPC_GET_ARG1(data) ((data).args[1])	78	#define IPC_GET_ARG1(data) ((data).args[1])
79	#define IPC_GET_ARG2(data) ((data).args[2])	79	#define IPC_GET_ARG2(data) ((data).args[2])
80	#define IPC_GET_ARG3(data) ((data).args[3])	80	#define IPC_GET_ARG3(data) ((data).args[3])
81		81
82	/* Well known phone descriptors */	82	/* Well known phone descriptors */
83	#define PHONE_NS 0	83	#define PHONE_NS 0
84		84
85	/* System-specific methods - only through special syscalls	85	/* System-specific methods - only through special syscalls
86	* These methods have special behaviour	86	* These methods have special behaviour
87	*/	87	*/
88	/** Protocol for CONNECT - TO - ME	88	/** Protocol for CONNECT - TO - ME
89	*	89	*
90	* Calling process asks the callee to create a callback connection,	90	* Calling process asks the callee to create a callback connection,
91	* so that it can start initiating new messages.	91	* so that it can start initiating new messages.
92	*	92	*
93	* The protocol for negotiating is:	93	* The protocol for negotiating is:
94	* - sys_connect_to_me - sends a message IPC_M_CONNECTTOME	94	* - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
95	* - sys_wait_for_call - upon receipt tries to allocate new phone	95	* - sys_wait_for_call - upon receipt tries to allocate new phone
96	* - if it fails, responds with ELIMIT	96	* - if it fails, responds with ELIMIT
97	* - passes call to userspace. If userspace	97	* - passes call to userspace. If userspace
98	* responds with error, phone is deallocated and	98	* responds with error, phone is deallocated and
99	* error is sent back to caller. Otherwise	99	* error is sent back to caller. Otherwise
100	* the call is accepted and the response is sent back.	100	* the call is accepted and the response is sent back.
101	* - the allocated phoneid is passed to userspace	101	* - the allocated phoneid is passed to userspace
102	* (on the receiving sid) as ARG3 of the call.	102	* (on the receiving sid) as ARG3 of the call.
103	* - the caller obtains taskid of the called thread	103	* - the caller obtains taskid of the called thread
104	*/	104	*/
105	#define IPC_M_CONNECT_TO_ME 1	105	#define IPC_M_CONNECT_TO_ME 1
106	/** Protocol for CONNECT - ME - TO	106	/** Protocol for CONNECT - ME - TO
107	*	107	*
108	* Calling process asks the callee to create for him a new connection.	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.	109	* E.g. the caller wants a name server to connect him to print server.
110	*	110	*
111	* The protocol for negotiating is:	111	* The protocol for negotiating is:
112	* - sys_connect_me_to - send a synchronous message to name server	112	* - sys_connect_me_to - send a synchronous message to name server
113	* indicating that it wants to be connected to some	113	* indicating that it wants to be connected to some
114	* service	114	* service
115	* - arg1/2 are user specified, arg3 contains	115	* - arg1/2 are user specified, arg3 contains
116	* address of the phone that should be connected	116	* address of the phone that should be connected
117	* (TODO: it leaks to userspace)	117	* (TODO: it leaks to userspace)
118	* recipient - if ipc_answer == 0, then accept connection	118	* recipient - if ipc_answer == 0, then accept connection
119	* - otherwise connection refused	119	* - otherwise connection refused
120	* - recepient may forward message. Forwarding	120	* - recepient may forward message. Forwarding
121	* system message	121	* system message
122	*	122	*
123	*/	123	*/
124	#define IPC_M_CONNECT_ME_TO 2	124	#define IPC_M_CONNECT_ME_TO 2
125	/** This message is sent to answerbox when the phone	125	/** This message is sent to answerbox when the phone
126	* is hung up	126	* is hung up
127	*/	127	*/
128	#define IPC_M_PHONE_HUNGUP 3	128	#define IPC_M_PHONE_HUNGUP 3
129		129
130	/** Send as_area over IPC	130	/** Send as_area over IPC
131	* - ARG1 - src as_area base address	131	* - ARG1 - src as_area base address
132	* - ARG2 - size of src as_area (filled automatically by kernel)	132	* - ARG2 - size of src as_area (filled automatically by kernel)
133	* - ARG3 - flags of the as_area being sent	133	* - ARG3 - flags of the as_area being sent
134	*	134	*
135	* on answer:	135	* on answer:
136	* - ARG1 - dst as_area base adress	136	* - ARG1 - dst as_area base adress
137	*/	137	*/
138	#define IPC_M_AS_AREA_SEND 5	138	#define IPC_M_AS_AREA_SEND 5
139		139
140	/** Get as_area over IPC	140	/** Get as_area over IPC
141	* - ARG1 - dst as_area base address	141	* - ARG1 - dst as_area base address
142	* - ARG2 - dst as_area size	142	* - ARG2 - dst as_area size
143	* - ARG3 - user defined argument	143	* - ARG3 - user defined argument
144	*	144	*
145	* on answer, the server must set:	145	* on answer, the server must set:
146	*	146	*
147	* - ARG1 - src as_area base address	147	* - ARG1 - src as_area base address
148	* - ARG2 - flags that will be used for sharing	148	* - ARG2 - flags that will be used for sharing
149	*/	149	*/
150	#define IPC_M_AS_AREA_RECV 6	150	#define IPC_M_AS_AREA_RECV 6
151		151
152		152
153	/* Well-known methods */	153	/* Well-known methods */
154	#define IPC_M_LAST_SYSTEM 511	154	#define IPC_M_LAST_SYSTEM 511
155	#define IPC_M_PING 512	155	#define IPC_M_PING 512
156	/* User methods */	156	/* User methods */
157	#define FIRST_USER_METHOD 1024	157	#define FIRST_USER_METHOD 1024
158		158
159	#ifdef KERNEL	159	#ifdef KERNEL
160		160
161	#include <synch/waitq.h>	161	#include <synch/waitq.h>
162	#include <adt/list.h>	162	#include <adt/list.h>
163		163
164	#define IPC_MAX_PHONES 16	164	#define IPC_MAX_PHONES 16
165		165
166	typedef struct answerbox_s answerbox_t;	166	typedef struct answerbox_s answerbox_t;
167	typedef struct phone_s phone_t;	167	typedef struct phone_s phone_t;
168	typedef struct {	168	typedef struct {
169	unative_t args[IPC_CALL_LEN];	169	unative_t args[IPC_CALL_LEN];
170	phone_t *phone;	170	phone_t *phone;
171	} ipc_data_t;	171	} ipc_data_t;
172		172
173	struct answerbox_s {	173	struct answerbox_s {
174	SPINLOCK_DECLARE(lock);	174	SPINLOCK_DECLARE(lock);
175		175
176	task_t *task;	176	task_t *task;
177		177
178	waitq_t wq;	178	waitq_t wq;
179		179
180	link_t connected_phones; /*< Phones connected to this answerbox /	180	link_t connected_phones; /*< Phones connected to this answerbox /
181	link_t calls; /*< Received calls /	181	link_t calls; /*< Received calls /
182	link_t dispatched_calls; /* Should be hash table in the future */	182	link_t dispatched_calls; /* Should be hash table in the future */
183		183
184	link_t answers; /*< Answered calls /	184	link_t answers; /*< Answered calls /
185		185
186	SPINLOCK_DECLARE(irq_lock);	186	SPINLOCK_DECLARE(irq_lock);
187	link_t irq_notifs; /*< Notifications from IRQ handlers /	187	link_t irq_notifs; /*< Notifications from IRQ handlers /
188	link_t irq_head; /*< IRQs with notifications to this answerbox. /	188	link_t irq_head; /*< IRQs with notifications to this answerbox. /
189	};	189	};
190		190
191	typedef enum {	191	typedef enum {
192	IPC_PHONE_FREE = 0, /*< Phone is free and can be allocated /	192	IPC_PHONE_FREE = 0, /*< Phone is free and can be allocated /
193	IPC_PHONE_CONNECTING, /*< Phone is connecting somewhere /	193	IPC_PHONE_CONNECTING, /*< Phone is connecting somewhere /
194	IPC_PHONE_CONNECTED, /*< Phone is connected /	194	IPC_PHONE_CONNECTED, /*< Phone is connected /
195	IPC_PHONE_HUNGUP, /*< Phone is hung up, waiting for answers to come /	195	IPC_PHONE_HUNGUP, /*< Phone is hung up, waiting for answers to come /
196	IPC_PHONE_SLAMMED /*< Phone was hungup from server /	196	IPC_PHONE_SLAMMED /*< Phone was hungup from server /
197	} ipc_phone_state_t;	197	} ipc_phone_state_t;
198		198
199	/** Structure identifying phone (in TASK structure) */	199	/** Structure identifying phone (in TASK structure) */
200	struct phone_s {	200	struct phone_s {
201	SPINLOCK_DECLARE(lock);	201	SPINLOCK_DECLARE(lock);
202	link_t link;	202	link_t link;
203	answerbox_t *callee;	203	answerbox_t *callee;
204	ipc_phone_state_t state;	204	ipc_phone_state_t state;
205	atomic_t active_calls;	205	atomic_t active_calls;
206	};	206	};
207		207
208	typedef struct {	208	typedef struct {
209	link_t link;	209	link_t link;
210		210
211	int flags;	211	int flags;
212		212
213	/* Identification of the caller */	213	/* Identification of the caller */
214	task_t *sender;	214	task_t *sender;
215	/* The caller box is different from sender->answerbox	215	/* The caller box is different from sender->answerbox
216	* for synchronous calls	216	* for synchronous calls
217	*/	217	*/
218	answerbox_t *callerbox;	218	answerbox_t *callerbox;
219		219
220	unative_t private; /*< Private data to internal IPC /	220	unative_t private; /*< Private data to internal IPC /
221		221
222	ipc_data_t data; /*< Data passed from/to userspace /	222	ipc_data_t data; /*< Data passed from/to userspace /
223	} call_t;	223	} call_t;
224		224
225	extern void ipc_init(void);	225	extern void ipc_init(void);
226	extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);	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);	227	extern void ipc_answer(answerbox_t box, call_t request);
228	extern int ipc_call(phone_t phone, call_t call);	228	extern int ipc_call(phone_t phone, call_t call);
229	extern void ipc_call_sync(phone_t phone, call_t request);	229	extern void ipc_call_sync(phone_t phone, call_t request);
230	extern void ipc_phone_init(phone_t *phone);	230	extern void ipc_phone_init(phone_t *phone);
231	extern void ipc_phone_connect(phone_t phone, answerbox_t box);	231	extern void ipc_phone_connect(phone_t phone, answerbox_t box);
232	extern void ipc_call_free(call_t *call);	232	extern void ipc_call_free(call_t *call);
233	extern call_t * ipc_call_alloc(int flags);	233	extern call_t * ipc_call_alloc(int flags);
234	extern void ipc_answerbox_init(answerbox_t *box);	234	extern void ipc_answerbox_init(answerbox_t *box);
235	extern void ipc_call_static_init(call_t *call);	235	extern void ipc_call_static_init(call_t *call);
236	extern void task_print_list(void);	236	extern void task_print_list(void);
237	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox);	237	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox);
238	void ipc_cleanup(void);	238	void ipc_cleanup(void);
239	int ipc_phone_hangup(phone_t *phone);	239	int ipc_phone_hangup(phone_t *phone);
240	extern void ipc_backsend_err(phone_t phone, call_t call, unative_t err);	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);	241	extern void ipc_print_task(task_id_t taskid);
242		242
243	extern answerbox_t *ipc_phone_0;	243	extern answerbox_t *ipc_phone_0;
244		244
245	#endif	245	#endif
246		246
247	#endif	247	#endif
248		248
249	/** @}	249	/** @}
250	*/	250	*/
251		251