WebSVN – HelenOS – Diff – /branches/tracing/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
 * - recipient         - 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 ARG5 of the call.
 */
#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/3 are user specified, arg5 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.
 *
 */
#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_SHARE_OUT     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_SHARE_IN      5   
 
/** Send data to another address space over IPC.
 * - ARG1 - source address space virtual address
 * - ARG2 - 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
 * - ARG2 - final size of data to be copied
 */
#define IPC_M_DATA_WRITE    6
 
/** Receive data from another address space over IPC.
 * - ARG1 - destination virtual address in the source address space
 * - ARG2 - size of data to be received, may be cropped by the recipient
 *
 * on answer, the recipient must set:
 *
 * - ARG1 - source virtual address in the destination address space
 * - ARG2 - final size of data to be copied
 */
#define IPC_M_DATA_READ     7
 
/** Debug the recipient.
 * - ARG1 - specifies the debug method (from udebug_method_t)
 * - other arguments are specific to the debug method
 */
 
 
 
 
 
#define IPC_M_DEBUG_ALL     8
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* 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_WRITE and IPC_M_DATA_READ. */
    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, struct task *task);
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 int ipc_connect_kbox(task_id_t taskid);
 
extern answerbox_t *ipc_phone_0;
 
#endif
 
#endif
 
/** @}
 */
 

Rev 2809	Rev 2812
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	/**	102	/**
103	* The call will be routed as though it was initially sent via the phone used to	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	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	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	106	* calls that were initially sent by the forwarder to the same destination. This
107	* flag has no imapct on routing replies.	107	* flag has no imapct on routing replies.
108	*/	108	*/
109	#define IPC_FF_ROUTE_FROM_ME (1 << 0)	109	#define IPC_FF_ROUTE_FROM_ME (1 << 0)
110		110
111	/* System-specific methods - only through special syscalls	111	/* System-specific methods - only through special syscalls
112	* These methods have special behaviour	112	* These methods have special behaviour
113	*/	113	*/
114	/** Protocol for CONNECT - TO - ME	114	/** Protocol for CONNECT - TO - ME
115	*	115	*
116	* Calling process asks the callee to create a callback connection,	116	* Calling process asks the callee to create a callback connection,
117	* so that it can start initiating new messages.	117	* so that it can start initiating new messages.
118	*	118	*
119	* The protocol for negotiating is:	119	* The protocol for negotiating is:
120	* - 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
121	* - recipient - upon receipt tries to allocate new phone	121	* - recipient - upon receipt tries to allocate new phone
122	* - if it fails, responds with ELIMIT	122	* - if it fails, responds with ELIMIT
123	* - passes call to userspace. If userspace	123	* - passes call to userspace. If userspace
124	* responds with error, phone is deallocated and	124	* responds with error, phone is deallocated and
125	* error is sent back to caller. Otherwise	125	* error is sent back to caller. Otherwise
126	* the call is accepted and the response is sent back.	126	* the call is accepted and the response is sent back.
127	* - the allocated phoneid is passed to userspace	127	* - the allocated phoneid is passed to userspace
128	* (on the receiving side) as ARG5 of the call.	128	* (on the receiving side) as ARG5 of the call.
129	*/	129	*/
130	#define IPC_M_CONNECT_TO_ME 1	130	#define IPC_M_CONNECT_TO_ME 1
131	/** Protocol for CONNECT - ME - TO	131	/** Protocol for CONNECT - ME - TO
132	*	132	*
133	* Calling process asks the callee to create for him a new connection.	133	* Calling process asks the callee to create for him a new connection.
134	* E.g. the caller wants a name server to connect him to print server.	134	* E.g. the caller wants a name server to connect him to print server.
135	*	135	*
136	* The protocol for negotiating is:	136	* The protocol for negotiating is:
137	* - sys_connect_me_to - send a synchronous message to name server	137	* - sys_connect_me_to - send a synchronous message to name server
138	* indicating that it wants to be connected to some	138	* indicating that it wants to be connected to some
139	* service	139	* service
140	* - arg1/2/3 are user specified, arg5 contains	140	* - arg1/2/3 are user specified, arg5 contains
141	* address of the phone that should be connected	141	* address of the phone that should be connected
142	* (TODO: it leaks to userspace)	142	* (TODO: it leaks to userspace)
143	* - recipient - if ipc_answer == 0, then accept connection	143	* - recipient - if ipc_answer == 0, then accept connection
144	* - otherwise connection refused	144	* - otherwise connection refused
145	* - recepient may forward message.	145	* - recepient may forward message.
146	*	146	*
147	*/	147	*/
148	#define IPC_M_CONNECT_ME_TO 2	148	#define IPC_M_CONNECT_ME_TO 2
149	/** This message is sent to answerbox when the phone	149	/** This message is sent to answerbox when the phone
150	* is hung up	150	* is hung up
151	*/	151	*/
152	#define IPC_M_PHONE_HUNGUP 3	152	#define IPC_M_PHONE_HUNGUP 3
153		153
154	/** Send as_area over IPC.	154	/** Send as_area over IPC.
155	* - ARG1 - source as_area base address	155	* - ARG1 - source as_area base address
156	* - ARG2 - size of source as_area (filled automatically by kernel)	156	* - ARG2 - size of source as_area (filled automatically by kernel)
157	* - ARG3 - flags of the as_area being sent	157	* - ARG3 - flags of the as_area being sent
158	*	158	*
159	* on answer, the recipient must set:	159	* on answer, the recipient must set:
160	* - ARG1 - dst as_area base adress	160	* - ARG1 - dst as_area base adress
161	*/	161	*/
162	#define IPC_M_SHARE_OUT 4	162	#define IPC_M_SHARE_OUT 4
163		163
164	/** Receive as_area over IPC.	164	/** Receive as_area over IPC.
165	* - ARG1 - destination as_area base address	165	* - ARG1 - destination as_area base address
166	* - ARG2 - destination as_area size	166	* - ARG2 - destination as_area size
167	* - ARG3 - user defined argument	167	* - ARG3 - user defined argument
168	*	168	*
169	* on answer, the recipient must set:	169	* on answer, the recipient must set:
170	*	170	*
171	* - ARG1 - source as_area base address	171	* - ARG1 - source as_area base address
172	* - ARG2 - flags that will be used for sharing	172	* - ARG2 - flags that will be used for sharing
173	*/	173	*/
174	#define IPC_M_SHARE_IN 5	174	#define IPC_M_SHARE_IN 5
175		175
176	/** Send data to another address space over IPC.	176	/** Send data to another address space over IPC.
177	* - ARG1 - source address space virtual address	177	* - ARG1 - source address space virtual address
178	* - ARG2 - size of data to be copied, may be overriden by the recipient	178	* - ARG2 - size of data to be copied, may be overriden by the recipient
179	*	179	*
180	* on answer, the recipient must set:	180	* on answer, the recipient must set:
181	*	181	*
182	* - ARG1 - final destination address space virtual address	182	* - ARG1 - final destination address space virtual address
183	* - ARG2 - final size of data to be copied	183	* - ARG2 - final size of data to be copied
184	*/	184	*/
185	#define IPC_M_DATA_WRITE 6	185	#define IPC_M_DATA_WRITE 6
186		186
187	/** Receive data from another address space over IPC.	187	/** Receive data from another address space over IPC.
188	* - ARG1 - destination virtual address in the source address space	188	* - ARG1 - destination virtual address in the source address space
189	* - ARG2 - size of data to be received, may be cropped by the recipient	189	* - ARG2 - size of data to be received, may be cropped by the recipient
190	*	190	*
191	* on answer, the recipient must set:	191	* on answer, the recipient must set:
192	*	192	*
193	* - ARG1 - source virtual address in the destination address space	193	* - ARG1 - source virtual address in the destination address space
194	* - ARG2 - final size of data to be copied	194	* - ARG2 - final size of data to be copied
195	*/	195	*/
196	#define IPC_M_DATA_READ 7	196	#define IPC_M_DATA_READ 7
197		197
198	/** Start debugging the recipient.	198	/** Debug the recipient.
199	* Causes all threads in the receiving task to stop. When they	199	* - ARG1 - specifies the debug method (from udebug_method_t)
200	* are all stoped, an answer with retval 0 is generated.	200	* - other arguments are specific to the debug method
201	*/	201	*/
202	#define IPC_M_DEBUG_BEGIN 8	-
203		-
204	/** Finish debugging the recipient.	-
205	* Answers all pending GO and GUARD messages.	-
206	*/	-
207	#define IPC_M_DEBUG_END 9	202	#define IPC_M_DEBUG_ALL 8
208		-
209	/** Make sure the debugged task is still there.	-
210	* This message is answered when the debugged task dies	-
211	* or the debugging session ends.	-
212	*/	-
213	#define IPC_M_DEBUG_GUARD 10	-
214		-
215	/** Run a thread until a debugging event occurs.	-
216	* This message is answered when the thread stops	-
217	* in a debugging event.	-
218	*	-
219	* - ARG1 - id of the thread to run	-
220	*/	-
221	#define IPC_M_DEBUG_GO 11	-
222		-
223	/** Stop a thread being debugged.	-
224	* Creates a special STOP event in the thread, causing	-
225	* it to answer a pending GO message (if any).	-
226	*/	-
227	#define IPC_M_DEBUG_STOP 12	-
228		-
229	/** Read arguments of a syscall.	-
230	*	-
231	* - ARG1 - thread identification	-
232	* - ARG2 - destination address in the caller's address space	-
233	* - ARG3 - size of receiving buffer in bytes	-
234	*	-
235	* on answer, the kernel will set:	-
236	*	-
237	* - ARG1 - actual size in bytes of data read	-
238	*/	-
239	#define IPC_M_DEBUG_ARGS_READ 12	-
240		-
241	/** Read the list of the debugged tasks's threads.	-
242	*	-
243	* - ARG1 - destination address in the caller's address space	-
244	* - ARG2 - size of receiving buffer in bytes	-
245	*	-
246	* The kernel fills the buffer with a series of sysarg_t values	-
247	* (thread ids). On answer, the kernel will set:	-
248	*	-
249	* - ARG1 - number of bytes that were actually copied	-
250	* - ARG2 - number of bytes of the complete data	-
251	*	-
252	*/	-
253	#define IPC_M_DEBUG_THREAD_READ 13	-
254		-
255	/** Read the list of the debugged tasks's memory.	-
256	*	-
257	* - ARG1 - destination address in the caller's address space	-
258	* - ARG2 - source address in the recipient's address space	-
259	* - ARG3 - size of receiving buffer in bytes	-
260	*	-
261	*/	-
262	#define IPC_M_DEBUG_MEM_READ 14	-
263		203
264	/* Well-known methods */	204	/* Well-known methods */
265	#define IPC_M_LAST_SYSTEM 511	205	#define IPC_M_LAST_SYSTEM 511
266	#define IPC_M_PING 512	206	#define IPC_M_PING 512
267	/* User methods */	207	/* User methods */
268	#define IPC_FIRST_USER_METHOD 1024	208	#define IPC_FIRST_USER_METHOD 1024
269		209
270	#ifdef KERNEL	210	#ifdef KERNEL
271		211
272	#define IPC_MAX_PHONES 16	212	#define IPC_MAX_PHONES 16
273		213
274	#include <synch/waitq.h>	214	#include <synch/waitq.h>
275		215
276	struct answerbox;	216	struct answerbox;
277	struct task;	217	struct task;
278		218
279	typedef enum {	219	typedef enum {
280	/** Phone is free and can be allocated */	220	/** Phone is free and can be allocated */
281	IPC_PHONE_FREE = 0,	221	IPC_PHONE_FREE = 0,
282	/** Phone is connecting somewhere */	222	/** Phone is connecting somewhere */
283	IPC_PHONE_CONNECTING,	223	IPC_PHONE_CONNECTING,
284	/** Phone is connected */	224	/** Phone is connected */
285	IPC_PHONE_CONNECTED,	225	IPC_PHONE_CONNECTED,
286	/** Phone is hung up, waiting for answers to come */	226	/** Phone is hung up, waiting for answers to come */
287	IPC_PHONE_HUNGUP,	227	IPC_PHONE_HUNGUP,
288	/** Phone was hungup from server */	228	/** Phone was hungup from server */
289	IPC_PHONE_SLAMMED	229	IPC_PHONE_SLAMMED
290	} ipc_phone_state_t;	230	} ipc_phone_state_t;
291		231
292	/** Structure identifying phone (in TASK structure) */	232	/** Structure identifying phone (in TASK structure) */
293	typedef struct {	233	typedef struct {
294	SPINLOCK_DECLARE(lock);	234	SPINLOCK_DECLARE(lock);
295	link_t link;	235	link_t link;
296	struct answerbox *callee;	236	struct answerbox *callee;
297	ipc_phone_state_t state;	237	ipc_phone_state_t state;
298	atomic_t active_calls;	238	atomic_t active_calls;
299	} phone_t;	239	} phone_t;
300		240
301	typedef struct answerbox {	241	typedef struct answerbox {
302	SPINLOCK_DECLARE(lock);	242	SPINLOCK_DECLARE(lock);
303		243
304	struct task *task;	244	struct task *task;
305		245
306	waitq_t wq;	246	waitq_t wq;
307		247
308	/** Phones connected to this answerbox. */	248	/** Phones connected to this answerbox. */
309	link_t connected_phones;	249	link_t connected_phones;
310	/** Received calls. */	250	/** Received calls. */
311	link_t calls;	251	link_t calls;
312	link_t dispatched_calls; /* Should be hash table in the future */	252	link_t dispatched_calls; /* Should be hash table in the future */
313		253
314	/** Answered calls. */	254	/** Answered calls. */
315	link_t answers;	255	link_t answers;
316		256
317	SPINLOCK_DECLARE(irq_lock);	257	SPINLOCK_DECLARE(irq_lock);
318	/** Notifications from IRQ handlers. */	258	/** Notifications from IRQ handlers. */
319	link_t irq_notifs;	259	link_t irq_notifs;
320	/** IRQs with notifications to this answerbox. */	260	/** IRQs with notifications to this answerbox. */
321	link_t irq_head;	261	link_t irq_head;
322	} answerbox_t;	262	} answerbox_t;
323		263
324	typedef struct {	264	typedef struct {
325	unative_t args[IPC_CALL_LEN];	265	unative_t args[IPC_CALL_LEN];
326	phone_t *phone;	266	phone_t *phone;
327	} ipc_data_t;	267	} ipc_data_t;
328		268
329	typedef struct {	269	typedef struct {
330	link_t link;	270	link_t link;
331		271
332	int flags;	272	int flags;
333		273
334	/** Identification of the caller. */	274	/** Identification of the caller. */
335	struct task *sender;	275	struct task *sender;
336	/** The caller box is different from sender->answerbox for synchronous	276	/** The caller box is different from sender->answerbox for synchronous
337	* calls. */	277	* calls. */
338	answerbox_t *callerbox;	278	answerbox_t *callerbox;
339		279
340	/** Private data to internal IPC. */	280	/** Private data to internal IPC. */
341	unative_t priv;	281	unative_t priv;
342		282
343	/** Data passed from/to userspace. */	283	/** Data passed from/to userspace. */
344	ipc_data_t data;	284	ipc_data_t data;
345		285
346	/** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */	286	/** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */
347	uint8_t *buffer;	287	uint8_t *buffer;
348	} call_t;	288	} call_t;
349		289
350	extern void ipc_init(void);	290	extern void ipc_init(void);
351	extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);	291	extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
352	extern void ipc_answer(answerbox_t box, call_t request);	292	extern void ipc_answer(answerbox_t box, call_t request);
353	extern int ipc_call(phone_t phone, call_t call);	293	extern int ipc_call(phone_t phone, call_t call);
354	extern void ipc_call_sync(phone_t phone, call_t request);	294	extern void ipc_call_sync(phone_t phone, call_t request);
355	extern void ipc_phone_init(phone_t *phone);	295	extern void ipc_phone_init(phone_t *phone);
356	extern void ipc_phone_connect(phone_t phone, answerbox_t box);	296	extern void ipc_phone_connect(phone_t phone, answerbox_t box);
357	extern void ipc_call_free(call_t *call);	297	extern void ipc_call_free(call_t *call);
358	extern call_t * ipc_call_alloc(int flags);	298	extern call_t * ipc_call_alloc(int flags);
359	extern void ipc_answerbox_init(answerbox_t box, struct task task);	299	extern void ipc_answerbox_init(answerbox_t box, struct task task);
360	extern void ipc_call_static_init(call_t *call);	300	extern void ipc_call_static_init(call_t *call);
361	extern void task_print_list(void);	301	extern void task_print_list(void);
362	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox,	302	extern int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox,
363	int mode);	303	int mode);
364	extern void ipc_cleanup(void);	304	extern void ipc_cleanup(void);
365	extern int ipc_phone_hangup(phone_t *phone);	305	extern int ipc_phone_hangup(phone_t *phone);
366	extern void ipc_backsend_err(phone_t phone, call_t call, unative_t err);	306	extern void ipc_backsend_err(phone_t phone, call_t call, unative_t err);
367	extern void ipc_print_task(task_id_t taskid);	307	extern void ipc_print_task(task_id_t taskid);
368	extern int ipc_connect_kbox(task_id_t taskid);	308	extern int ipc_connect_kbox(task_id_t taskid);
369		309
370	extern answerbox_t *ipc_phone_0;	310	extern answerbox_t *ipc_phone_0;
371		311
372	#endif	312	#endif
373		313
374	#endif	314	#endif
375		315
376	/** @}	316	/** @}
377	*/	317	*/
378		318

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/include/ipc/ipc.h – Rev 2809 → 2812