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_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
 
#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;
} 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
 
/** @}
 */
 

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

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ipc/ipc.h – Rev 2106 → 2471