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        6   
 
/** 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_SET_ARG4(data, val)     ((data).args[4] = (val))
#define IPC_SET_ARG5(data, val)     ((data).args[5] = (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])
#define IPC_GET_ARG4(data)      ((data).args[4])
#define IPC_GET_ARG5(data)      ((data).args[5])
 
/* Well known phone descriptors */
#define PHONE_NS    0
 
/* Forwarding flags. */
#define IPC_FF_NONE     0
/**
 * The call will be routed as though it was initially sent via the phone used to
 * forward it. This feature is intended to support the situation in which the
 * forwarded call needs to be handled by the same connection fibril as any other
 * calls that were initially sent by the forwarder to the same destination. This
 * flag has no imapct on routing replies.
 */
#define IPC_FF_ROUTE_FROM_ME    (1 << 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,
    int mode);
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
 
/** @}
 */
 

Rev 2622	Rev 2623
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 6	40	#define IPC_CALL_LEN 6
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	#define IPC_SET_ARG4(data, val) ((data).args[4] = (val))	85	#define IPC_SET_ARG4(data, val) ((data).args[4] = (val))
86	#define IPC_SET_ARG5(data, val) ((data).args[5] = (val))	86	#define IPC_SET_ARG5(data, val) ((data).args[5] = (val))
87		87
88	#define IPC_GET_METHOD(data) ((data).args[0])	88	#define IPC_GET_METHOD(data) ((data).args[0])
89	#define IPC_GET_RETVAL(data) ((data).args[0])	89	#define IPC_GET_RETVAL(data) ((data).args[0])
90		90
91	#define IPC_GET_ARG1(data) ((data).args[1])	91	#define IPC_GET_ARG1(data) ((data).args[1])
92	#define IPC_GET_ARG2(data) ((data).args[2])	92	#define IPC_GET_ARG2(data) ((data).args[2])
93	#define IPC_GET_ARG3(data) ((data).args[3])	93	#define IPC_GET_ARG3(data) ((data).args[3])
94	#define IPC_GET_ARG4(data) ((data).args[4])	94	#define IPC_GET_ARG4(data) ((data).args[4])
95	#define IPC_GET_ARG5(data) ((data).args[5])	95	#define IPC_GET_ARG5(data) ((data).args[5])
96		96
97	/* Well known phone descriptors */	97	/* Well known phone descriptors */
98	#define PHONE_NS 0	98	#define PHONE_NS 0
99		99
100	/* Forwarding flags. */	100	/* Forwarding flags. */
101	#define IPC_FF_NONE 0	101	#define IPC_FF_NONE 0
-		102	/**
-		103	* The call will be routed as though it was initially sent via the phone used to
-		104	* forward it. This feature is intended to support the situation in which the
-		105	* forwarded call needs to be handled by the same connection fibril as any other
-		106	* calls that were initially sent by the forwarder to the same destination. This
-		107	* flag has no imapct on routing replies.
-		108	*/
-		109	#define IPC_FF_ROUTE_FROM_ME (1 << 0)
102		110
103	/* System-specific methods - only through special syscalls	111	/* System-specific methods - only through special syscalls
104	* These methods have special behaviour	112	* These methods have special behaviour
105	*/	113	*/
106	/** Protocol for CONNECT - TO - ME	114	/** Protocol for CONNECT - TO - ME
107	*	115	*
108	* Calling process asks the callee to create a callback connection,	116	* Calling process asks the callee to create a callback connection,
109	* so that it can start initiating new messages.	117	* so that it can start initiating new messages.
110	*	118	*
111	* The protocol for negotiating is:	119	* The protocol for negotiating is:
112	* - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME	120	* - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME
113	* - sys_wait_for_call - upon receipt tries to allocate new phone	121	* - sys_wait_for_call - upon receipt tries to allocate new phone
114	* - if it fails, responds with ELIMIT	122	* - if it fails, responds with ELIMIT
115	* - passes call to userspace. If userspace	123	* - passes call to userspace. If userspace
116	* responds with error, phone is deallocated and	124	* responds with error, phone is deallocated and
117	* error is sent back to caller. Otherwise	125	* error is sent back to caller. Otherwise
118	* the call is accepted and the response is sent back.	126	* the call is accepted and the response is sent back.
119	* - the allocated phoneid is passed to userspace	127	* - the allocated phoneid is passed to userspace
120	* (on the receiving side) as ARG3 of the call.	128	* (on the receiving side) as ARG3 of the call.
121	* - the caller obtains taskid of the called thread	129	* - the caller obtains taskid of the called thread
122	*/	130	*/
123	#define IPC_M_CONNECT_TO_ME 1	131	#define IPC_M_CONNECT_TO_ME 1
124	/** Protocol for CONNECT - ME - TO	132	/** Protocol for CONNECT - ME - TO
125	*	133	*
126	* Calling process asks the callee to create for him a new connection.	134	* Calling process asks the callee to create for him a new connection.
127	* E.g. the caller wants a name server to connect him to print server.	135	* E.g. the caller wants a name server to connect him to print server.
128	*	136	*
129	* The protocol for negotiating is:	137	* The protocol for negotiating is:
130	* - sys_connect_me_to - send a synchronous message to name server	138	* - sys_connect_me_to - send a synchronous message to name server
131	* indicating that it wants to be connected to some	139	* indicating that it wants to be connected to some
132	* service	140	* service
133	* - arg1/2 are user specified, arg3 contains	141	* - arg1/2 are user specified, arg3 contains
134	* address of the phone that should be connected	142	* address of the phone that should be connected
135	* (TODO: it leaks to userspace)	143	* (TODO: it leaks to userspace)
136	* recipient - if ipc_answer == 0, then accept connection	144	* recipient - if ipc_answer == 0, then accept connection
137	* - otherwise connection refused	145	* - otherwise connection refused
138	* - recepient may forward message. Forwarding	146	* - recepient may forward message. Forwarding
139	* system message	147	* system message
140	*	148	*
141	*/	149	*/
142	#define IPC_M_CONNECT_ME_TO 2	150	#define IPC_M_CONNECT_ME_TO 2
143	/** This message is sent to answerbox when the phone	151	/** This message is sent to answerbox when the phone
144	* is hung up	152	* is hung up
145	*/	153	*/
146	#define IPC_M_PHONE_HUNGUP 3	154	#define IPC_M_PHONE_HUNGUP 3
147		155
148	/** Send as_area over IPC.	156	/** Send as_area over IPC.
149	* - ARG1 - source as_area base address	157	* - ARG1 - source as_area base address
150	* - ARG2 - size of source as_area (filled automatically by kernel)	158	* - ARG2 - size of source as_area (filled automatically by kernel)
151	* - ARG3 - flags of the as_area being sent	159	* - ARG3 - flags of the as_area being sent
152	*	160	*
153	* on answer, the recipient must set:	161	* on answer, the recipient must set:
154	* - ARG1 - dst as_area base adress	162	* - ARG1 - dst as_area base adress
155	*/	163	*/
156	#define IPC_M_AS_AREA_SEND 4	164	#define IPC_M_AS_AREA_SEND 4
157		165
158	/** Receive as_area over IPC.	166	/** Receive as_area over IPC.
159	* - ARG1 - destination as_area base address	167	* - ARG1 - destination as_area base address
160	* - ARG2 - destination as_area size	168	* - ARG2 - destination as_area size
161	* - ARG3 - user defined argument	169	* - ARG3 - user defined argument
162	*	170	*
163	* on answer, the recipient must set:	171	* on answer, the recipient must set:
164	*	172	*
165	* - ARG1 - source as_area base address	173	* - ARG1 - source as_area base address
166	* - ARG2 - flags that will be used for sharing	174	* - ARG2 - flags that will be used for sharing
167	*/	175	*/
168	#define IPC_M_AS_AREA_RECV 5	176	#define IPC_M_AS_AREA_RECV 5
169		177
170	/** Send data to another address space over IPC.	178	/** Send data to another address space over IPC.
171	* - ARG1 - destination address space virtual address, may be overriden by the	179	* - ARG1 - destination address space virtual address, may be overriden by the
172	* recipient	180	* recipient
173	* - ARG2 - source address space virtual address	181	* - ARG2 - source address space virtual address
174	* - ARG3 - size of data to be copied, may be overriden by the recipient	182	* - ARG3 - size of data to be copied, may be overriden by the recipient
175	*	183	*
176	* on answer, the recipient must set:	184	* on answer, the recipient must set:
177	*	185	*
178	* - ARG1 - final destination address space virtual address	186	* - ARG1 - final destination address space virtual address
179	* - ARG3 - final size of data to be copied	187	* - ARG3 - final size of data to be copied
180	*/	188	*/
181	#define IPC_M_DATA_SEND 6	189	#define IPC_M_DATA_SEND 6
182		190
183	/* Well-known methods */	191	/* Well-known methods */
184	#define IPC_M_LAST_SYSTEM 511	192	#define IPC_M_LAST_SYSTEM 511
185	#define IPC_M_PING 512	193	#define IPC_M_PING 512
186	/* User methods */	194	/* User methods */
187	#define IPC_FIRST_USER_METHOD 1024	195	#define IPC_FIRST_USER_METHOD 1024
188		196
189	#ifdef KERNEL	197	#ifdef KERNEL
190		198
191	#define IPC_MAX_PHONES 16	199	#define IPC_MAX_PHONES 16
192		200
193	#include <synch/waitq.h>	201	#include <synch/waitq.h>
194		202
195	struct answerbox;	203	struct answerbox;
196	struct task;	204	struct task;
197		205
198	typedef enum {	206	typedef enum {
199	/** Phone is free and can be allocated */	207	/** Phone is free and can be allocated */
200	IPC_PHONE_FREE = 0,	208	IPC_PHONE_FREE = 0,
201	/** Phone is connecting somewhere */	209	/** Phone is connecting somewhere */
202	IPC_PHONE_CONNECTING,	210	IPC_PHONE_CONNECTING,
203	/** Phone is connected */	211	/** Phone is connected */
204	IPC_PHONE_CONNECTED,	212	IPC_PHONE_CONNECTED,
205	/** Phone is hung up, waiting for answers to come */	213	/** Phone is hung up, waiting for answers to come */
206	IPC_PHONE_HUNGUP,	214	IPC_PHONE_HUNGUP,
207	/** Phone was hungup from server */	215	/** Phone was hungup from server */
208	IPC_PHONE_SLAMMED	216	IPC_PHONE_SLAMMED
209	} ipc_phone_state_t;	217	} ipc_phone_state_t;
210		218
211	/** Structure identifying phone (in TASK structure) */	219	/** Structure identifying phone (in TASK structure) */
212	typedef struct {	220	typedef struct {
213	SPINLOCK_DECLARE(lock);	221	SPINLOCK_DECLARE(lock);
214	link_t link;	222	link_t link;
215	struct answerbox *callee;	223	struct answerbox *callee;
216	ipc_phone_state_t state;	224	ipc_phone_state_t state;
217	atomic_t active_calls;	225	atomic_t active_calls;
218	} phone_t;	226	} phone_t;
219		227
220	typedef struct answerbox {	228	typedef struct answerbox {
221	SPINLOCK_DECLARE(lock);	229	SPINLOCK_DECLARE(lock);
222		230
223	struct task *task;	231	struct task *task;
224		232
225	waitq_t wq;	233	waitq_t wq;
226		234
227	/** Phones connected to this answerbox. */	235	/** Phones connected to this answerbox. */
228	link_t connected_phones;	236	link_t connected_phones;
229	/** Received calls. */	237	/** Received calls. */
230	link_t calls;	238	link_t calls;
231	link_t dispatched_calls; /* Should be hash table in the future */	239	link_t dispatched_calls; /* Should be hash table in the future */
232		240
233	/** Answered calls. */	241	/** Answered calls. */
234	link_t answers;	242	link_t answers;
235		243
236	SPINLOCK_DECLARE(irq_lock);	244	SPINLOCK_DECLARE(irq_lock);
237	/** Notifications from IRQ handlers. */	245	/** Notifications from IRQ handlers. */
238	link_t irq_notifs;	246	link_t irq_notifs;
239	/** IRQs with notifications to this answerbox. */	247	/** IRQs with notifications to this answerbox. */
240	link_t irq_head;	248	link_t irq_head;
241	} answerbox_t;	249	} answerbox_t;
242		250
243	typedef struct {	251	typedef struct {
244	unative_t args[IPC_CALL_LEN];	252	unative_t args[IPC_CALL_LEN];
245	phone_t *phone;	253	phone_t *phone;
246	} ipc_data_t;	254	} ipc_data_t;
247		255
248	typedef struct {	256	typedef struct {
249	link_t link;	257	link_t link;
250		258
251	int flags;	259	int flags;
252		260
253	/** Identification of the caller. */	261	/** Identification of the caller. */
254	struct task *sender;	262	struct task *sender;
255	/** The caller box is different from sender->answerbox for synchronous	263	/** The caller box is different from sender->answerbox for synchronous
256	* calls. */	264	* calls. */
257	answerbox_t *callerbox;	265	answerbox_t *callerbox;
258		266
259	/** Private data to internal IPC. */	267	/** Private data to internal IPC. */
260	unative_t priv;	268	unative_t priv;
261		269
262	/** Data passed from/to userspace. */	270	/** Data passed from/to userspace. */
263	ipc_data_t data;	271	ipc_data_t data;
264		272
265	/** Buffer for IPC_M_DATA_SEND. */	273	/** Buffer for IPC_M_DATA_SEND. */
266	uint8_t *buffer;	274	uint8_t *buffer;
267	} call_t;	275	} call_t;
268		276
269	extern void ipc_init(void);	277	extern void ipc_init(void);
270	extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);	278	extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
271	extern void ipc_answer(answerbox_t box, call_t request);	279	extern void ipc_answer(answerbox_t box, call_t request);
272	extern int ipc_call(phone_t phone, call_t call);	280	extern int ipc_call(phone_t phone, call_t call);
273	extern void ipc_call_sync(phone_t phone, call_t request);	281	extern void ipc_call_sync(phone_t phone, call_t request);
274	extern void ipc_phone_init(phone_t *phone);	282	extern void ipc_phone_init(phone_t *phone);
275	extern void ipc_phone_connect(phone_t phone, answerbox_t box);	283	extern void ipc_phone_connect(phone_t phone, answerbox_t box);
276	extern void ipc_call_free(call_t *call);	284	extern void ipc_call_free(call_t *call);
277	extern call_t * ipc_call_alloc(int flags);	285	extern call_t * ipc_call_alloc(int flags);
278	extern void ipc_answerbox_init(answerbox_t *box);	286	extern void ipc_answerbox_init(answerbox_t *box);
279	extern void ipc_call_static_init(call_t *call);	287	extern void ipc_call_static_init(call_t *call);
280	extern void task_print_list(void);	288	extern void task_print_list(void);
281	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox,	289	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox,
282	int mode);	290	int mode);
283	extern void ipc_cleanup(void);	291	extern void ipc_cleanup(void);
284	extern int ipc_phone_hangup(phone_t *phone);	292	extern int ipc_phone_hangup(phone_t *phone);
285	extern void ipc_backsend_err(phone_t phone, call_t call, unative_t err);	293	extern void ipc_backsend_err(phone_t phone, call_t call, unative_t err);
286	extern void ipc_print_task(task_id_t taskid);	294	extern void ipc_print_task(task_id_t taskid);
287		295
288	extern answerbox_t *ipc_phone_0;	296	extern answerbox_t *ipc_phone_0;
289		297
290	#endif	298	#endif
291		299
292	#endif	300	#endif
293		301
294	/** @}	302	/** @}
295	*/	303	*/
296		304

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ipc/ipc.h – Rev 2622 → 2623