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 */
 
/** This is answer to a call */
#define IPC_CALL_ANSWERED   (1 << 0)
/** This call will not be freed on error */
#define IPC_CALL_STATIC_ALLOC   (1 << 1)
/** Answer will not be passed to userspace, will be discarded */
#define IPC_CALL_DISCARD_ANSWER (1 << 2)
/** Call was forwarded */
#define IPC_CALL_FORWARDED  (1 << 3)
/** Identify connect_me_to answer */
#define IPC_CALL_CONN_ME_TO (1 << 4)
/** Interrupt notification */
#define IPC_CALL_NOTIF      (1 << 5)
 
/*
 * Bits used in call hashes.
 * The addresses are aligned at least to 4 that is why we can use the 2 least
 * significant bits of the call address.
 */
/** Type of this call is 'answer' */
#define IPC_CALLID_ANSWERED 1
/** Type of this call is 'notification' */
#define IPC_CALLID_NOTIFICATION 2
 
/* Return values from sys_ipc_call_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_CONNECT_TO_ME
 * - 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 side) 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 - source as_area base address
 * - ARG2 - size of source as_area (filled automatically by kernel)
 * - ARG3 - flags of the as_area being sent
 *
 * on answer, the recipient must set:
 * - ARG1 - dst as_area base adress
 */
#define IPC_M_AS_AREA_SEND  4   
 
/** Receive as_area over IPC.
 * - ARG1 - destination as_area base address
 * - ARG2 - destination as_area size
 * - ARG3 - user defined argument
 *
 * on answer, the recipient must set:
 *
 * - ARG1 - source as_area base address
 * - ARG2 - flags that will be used for sharing
 */
#define IPC_M_AS_AREA_RECV  5   
 
/** Send data to another address space over IPC.
 * - ARG1 - destination address space virtual address, may be overriden by the
 *      recipient
 * - ARG2 - source address space virtual address
 * - ARG3 - size of data to be copied, may be overriden by the recipient
 *
 * on answer, the recipient must set:
 *
 * - ARG1 - final destination address space virtual address
 * - ARG3 - final size of data to be copied
 */
#define IPC_M_DATA_SEND     6
 
/* Well-known methods */
#define IPC_M_LAST_SYSTEM   511
#define IPC_M_PING      512
/* User methods */
#define IPC_FIRST_USER_METHOD   1024
 
#ifdef KERNEL
 
#define IPC_MAX_PHONES  16
 
#include <synch/waitq.h>
 
struct answerbox;
struct task;
 
typedef enum {
    /** Phone is free and can be allocated */
    IPC_PHONE_FREE = 0,
    /** Phone is connecting somewhere */
    IPC_PHONE_CONNECTING,
    /** Phone is connected */
    IPC_PHONE_CONNECTED,
    /** Phone is hung up, waiting for answers to come */
    IPC_PHONE_HUNGUP,
    /** Phone was hungup from server */
    IPC_PHONE_SLAMMED
} ipc_phone_state_t;
 
/** Structure identifying phone (in TASK structure) */
typedef struct {
    SPINLOCK_DECLARE(lock);
    link_t link;
    struct answerbox *callee;
    ipc_phone_state_t state;
    atomic_t active_calls;
} phone_t;
 
typedef struct answerbox {
    SPINLOCK_DECLARE(lock);
 
    struct task *task;
 
    waitq_t wq;
 
    /** Phones connected to this answerbox. */
    link_t connected_phones;
    /** Received calls. */
    link_t calls;          
    link_t dispatched_calls;    /* Should be hash table in the future */
 
    /** Answered calls. */
    link_t answers;
 
    SPINLOCK_DECLARE(irq_lock);
    /** Notifications from IRQ handlers. */
    link_t irq_notifs;
    /** IRQs with notifications to this answerbox. */
    link_t irq_head;
} answerbox_t;
 
typedef struct {
    unative_t args[IPC_CALL_LEN];
    phone_t *phone;
} ipc_data_t;
 
typedef struct {
    link_t link;
 
    int flags;
 
    /** Identification of the caller. */
    struct task *sender;
    /** The caller box is different from sender->answerbox for synchronous
     *  calls. */
    answerbox_t *callerbox;
 
    /** Private data to internal IPC. */
    unative_t priv;
 
    /** Data passed from/to userspace. */
    ipc_data_t data;
 
    /** Buffer for IPC_M_DATA_SEND. */
    uint8_t *buffer;
} 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);
extern void ipc_cleanup(void);
extern 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 2527 → 2550

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