WebSVN – HelenOS-historic – Diff – /kernel/trunk/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.
 */
 
#ifndef __IPC_H__
#define __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 */
#define IPC_MAX_ASYNC_CALLS  4
 
/* Flags for calls */
#define IPC_CALL_ANSWERED      1 /**< This is answer to a call */
#define IPC_CALL_STATIC_ALLOC  2 /**< This call will not be freed on error */
 
/* Flags for ipc_wait_for_call */
#define IPC_WAIT_NONBLOCKING   1
 
/* Flags of callid */
#define IPC_CALLID_ANSWERED  1
 
/* Return values from IPC_ASYNC */
#define IPC_CALLRET_FATAL         -1
#define IPC_CALLRET_TEMPORARY     -2
 
 
/* Macros for manipulating calling data */
#define IPC_SET_RETVAL(data, retval)   ((data)[0] = (retval))
#define IPC_SET_METHOD(data, val)   ((data)[0] = (val))
#define IPC_SET_ARG1(data, val)   ((data)[1] = (val))
#define IPC_SET_ARG2(data, val)   ((data)[2] = (val))
#define IPC_SET_ARG3(data, val)   ((data)[3] = (val))
 
#define IPC_GET_METHOD(data)           ((data)[0])
#define IPC_GET_RETVAL(data)           ((data)[0])
 
#define IPC_GET_ARG1(data)              ((data)[1])
#define IPC_GET_ARG2(data)              ((data)[2])
#define IPC_GET_ARG3(data)              ((data)[3])
 
/* Well known phone descriptors */
#define PHONE_NS              0
 
#ifdef KERNEL
 
#include <synch/mutex.h>
#include <synch/condvar.h>
#include <adt/list.h>
 
#define IPC_MAX_PHONES  16
 
 
typedef struct answerbox answerbox_t;
 
typedef struct {
    link_t list;
    answerbox_t *callerbox;
    int flags;
    task_t *sender;
    __native data[IPC_CALL_LEN];
} call_t;
 
struct answerbox {
    SPINLOCK_DECLARE(lock);
 
    mutex_t mutex;
    condvar_t cv;
 
    link_t connected_phones; /**< Phones connected to this answerbox */
    link_t calls;            /**< Received calls */
    link_t dispatched_calls; /* Should be hash table in the future */
 
    link_t answers;          /**< Answered calls */
};
 
typedef struct {
    SPINLOCK_DECLARE(lock);
    link_t list;
    answerbox_t *callee;
} phone_t;
 
extern void ipc_init(void);
extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
extern void ipc_answer(answerbox_t *box, call_t *request);
extern void ipc_call(phone_t *phone, call_t *request);
extern void ipc_call_sync(phone_t *phone, call_t *request);
extern void ipc_phone_destroy(phone_t *phone);
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
extern void ipc_call_free(call_t *call);
extern call_t * ipc_call_alloc(void);
extern void ipc_answerbox_init(answerbox_t *box);
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
extern void ipc_call_init(call_t *call);
 
extern answerbox_t *ipc_phone_0;
 
#endif
 
#endif
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/ipc/ipc.h – Rev 998 → 1005

Rev 998		Rev 1005
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	#ifndef __IPC_H__	29	#ifndef __IPC_H__
30	#define __IPC_H__	30	#define __IPC_H__
31		31
32	/* Length of data being transfered with IPC call */	32	/* Length of data being transfered with IPC call */
33	/* - the uspace may not be able to utilize full length */	33	/* - the uspace may not be able to utilize full length */
34	#define IPC_CALL_LEN 4	34	#define IPC_CALL_LEN 4
35		35
36	/** Maximum active async calls per thread */	36	/** Maximum active async calls per thread */
37	#define IPC_MAX_ASYNC_CALLS 4	37	#define IPC_MAX_ASYNC_CALLS 4
38		38
39	/* Flags for calls */	39	/* Flags for calls */
40	#define IPC_CALL_ANSWERED 1 /*< This is answer to a call /	40	#define IPC_CALL_ANSWERED 1 /*< This is answer to a call /
41	#define IPC_CALL_STATIC_ALLOC 2 /*< This call will not be freed on error /	41	#define IPC_CALL_STATIC_ALLOC 2 /*< This call will not be freed on error /
42		42
43	/* Flags for ipc_wait_for_call */	43	/* Flags for ipc_wait_for_call */
44	#define IPC_WAIT_NONBLOCKING 1	44	#define IPC_WAIT_NONBLOCKING 1
45		45
46	/* Flags of callid */	46	/* Flags of callid */
47	#define IPC_CALLID_ANSWERED 1	47	#define IPC_CALLID_ANSWERED 1
48		48
49	/* Return values from IPC_ASYNC */	49	/* Return values from IPC_ASYNC */
50	#define IPC_CALLRET_FATAL -1	50	#define IPC_CALLRET_FATAL -1
51	#define IPC_CALLRET_TEMPORARY -2	51	#define IPC_CALLRET_TEMPORARY -2
52		52
53		53
54	/* Macros for manipulating calling data */	54	/* Macros for manipulating calling data */
55	#define IPC_SET_RETVAL(data, retval) ((data)[0] = (retval))	55	#define IPC_SET_RETVAL(data, retval) ((data)[0] = (retval))
56	#define IPC_SET_METHOD(data, val) ((data)[0] = (val))	56	#define IPC_SET_METHOD(data, val) ((data)[0] = (val))
57	#define IPC_SET_ARG1(data, val) ((data)[1] = (val))	57	#define IPC_SET_ARG1(data, val) ((data)[1] = (val))
58	#define IPC_SET_ARG2(data, val) ((data)[2] = (val))	58	#define IPC_SET_ARG2(data, val) ((data)[2] = (val))
59	#define IPC_SET_ARG3(data, val) ((data)[3] = (val))	59	#define IPC_SET_ARG3(data, val) ((data)[3] = (val))
60		60
61	#define IPC_GET_METHOD(data) ((data)[0])	61	#define IPC_GET_METHOD(data) ((data)[0])
62	#define IPC_GET_RETVAL(data) ((data)[0])	62	#define IPC_GET_RETVAL(data) ((data)[0])
63		63
64	#define IPC_GET_ARG1(data) ((data)[1])	64	#define IPC_GET_ARG1(data) ((data)[1])
65	#define IPC_GET_ARG2(data) ((data)[2])	65	#define IPC_GET_ARG2(data) ((data)[2])
66	#define IPC_GET_ARG3(data) ((data)[3])	66	#define IPC_GET_ARG3(data) ((data)[3])
67		67
68	/* Well known phone descriptors */	68	/* Well known phone descriptors */
69	#define PHONE_NS 0	69	#define PHONE_NS 0
70		70
71	#ifdef KERNEL	71	#ifdef KERNEL
72		72
73	#include <synch/mutex.h>	73	#include <synch/mutex.h>
74	#include <synch/condvar.h>	74	#include <synch/condvar.h>
75	#include <adt/list.h>	75	#include <adt/list.h>
76		76
77	#define IPC_MAX_PHONES 16	77	#define IPC_MAX_PHONES 16
78		78
79		79
80	typedef struct answerbox answerbox_t;	80	typedef struct answerbox answerbox_t;
81		81
82	typedef struct {	82	typedef struct {
83	link_t list;	83	link_t list;
84	answerbox_t *callerbox;	84	answerbox_t *callerbox;
85	int flags;	85	int flags;
-		86	task_t *sender;
86	__native data[IPC_CALL_LEN];	87	__native data[IPC_CALL_LEN];
87	} call_t;	88	} call_t;
88		89
89	struct answerbox {	90	struct answerbox {
90	SPINLOCK_DECLARE(lock);	91	SPINLOCK_DECLARE(lock);
91		92
92	mutex_t mutex;	93	mutex_t mutex;
93	condvar_t cv;	94	condvar_t cv;
94		95
95	link_t connected_phones; /*< Phones connected to this answerbox /	96	link_t connected_phones; /*< Phones connected to this answerbox /
96	link_t calls; /*< Received calls /	97	link_t calls; /*< Received calls /
97	link_t dispatched_calls; /* Should be hash table in the future */	98	link_t dispatched_calls; /* Should be hash table in the future */
98		99
99	link_t answers; /*< Answered calls /	100	link_t answers; /*< Answered calls /
100	};	101	};
101		102
102	typedef struct {	103	typedef struct {
103	SPINLOCK_DECLARE(lock);	104	SPINLOCK_DECLARE(lock);
104	link_t list;	105	link_t list;
105	answerbox_t *callee;	106	answerbox_t *callee;
106	} phone_t;	107	} phone_t;
107		108
108	extern void ipc_init(void);	109	extern void ipc_init(void);
109	extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);	110	extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
110	extern void ipc_answer(answerbox_t box, call_t request);	111	extern void ipc_answer(answerbox_t box, call_t request);
111	extern void ipc_call(phone_t phone, call_t request);	112	extern void ipc_call(phone_t phone, call_t request);
112	extern void ipc_call_sync(phone_t phone, call_t request);	113	extern void ipc_call_sync(phone_t phone, call_t request);
113	extern void ipc_phone_destroy(phone_t *phone);	114	extern void ipc_phone_destroy(phone_t *phone);
114	extern void ipc_phone_init(phone_t phone, answerbox_t box);	115	extern void ipc_phone_init(phone_t phone, answerbox_t box);
115	extern void ipc_call_free(call_t *call);	116	extern void ipc_call_free(call_t *call);
116	extern call_t * ipc_call_alloc(void);	117	extern call_t * ipc_call_alloc(void);
117	extern void ipc_answerbox_init(answerbox_t *box);	118	extern void ipc_answerbox_init(answerbox_t *box);
118	extern void ipc_phone_init(phone_t phone, answerbox_t box);	119	extern void ipc_phone_init(phone_t phone, answerbox_t box);
119	extern void ipc_call_init(call_t *call);	120	extern void ipc_call_init(call_t *call);
120		121
121	extern answerbox_t *ipc_phone_0;	122	extern answerbox_t *ipc_phone_0;
122		123
123	#endif	124	#endif
124		125
125	#endif	126	#endif
126		127