WebSVN – HelenOS – Diff – /trunk/kernel/generic/src/ipc/ipc.c


/*
 * 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.
 */
 
/* Lock ordering
 *
 * First the answerbox, then the phone
 */
 
#include <synch/condvar.h>
#include <synch/mutex.h>
#include <ipc/ipc.h>
#include <errno.h>
#include <mm/slab.h>
#include <arch.h>
#include <proc/task.h>
#include <memstr.h>
#include <debug.h>
 
#include <print.h>
#include <proc/thread.h>
 
/* Open channel that is assigned automatically to new tasks */
answerbox_t *ipc_phone_0 = NULL;
 
static slab_cache_t *ipc_call_slab;
 
/** Allocate & initialize call structure
 *
 * The call is initialized, so that the reply will be directed
 * to TASK->answerbox
 */
call_t * ipc_call_alloc(void)
{
    call_t *call;
 
    call = slab_alloc(ipc_call_slab, 0);
    memsetb((__address)call, sizeof(*call), 0);
    call->callerbox = &TASK->answerbox;
    call->sender = TASK;
 
    return call;
}
 
/** Initialize allocated call */
void ipc_call_init(call_t *call)
{
    call->callerbox = &TASK->answerbox;
    call->flags = IPC_CALL_STATIC_ALLOC;
    call->sender = TASK;
}
 
/** Deallocate call stracuture */
void ipc_call_free(call_t *call)
{
    slab_free(ipc_call_slab, call);
}
 
/** Initialize answerbox structure
 */
void ipc_answerbox_init(answerbox_t *box)
{
    mutex_initialize(&box->mutex);
    condvar_initialize(&box->cv);
    list_initialize(&box->connected_phones);
    list_initialize(&box->calls);
    list_initialize(&box->dispatched_calls);
    list_initialize(&box->answers);
    box->task = TASK;
}
 
/** Initialize phone structure and connect phone to naswerbox
 */
void ipc_phone_init(phone_t *phone, answerbox_t *box)
{
    spinlock_initialize(&phone->lock, "phone_lock");
   
    phone->callee = box;
 
    mutex_lock(&box->mutex);
    list_append(&phone->list, &box->connected_phones);
    mutex_unlock(&box->mutex);
}
 
/** Disconnect phone from answerbox */
void ipc_phone_destroy(phone_t *phone)
{
    answerbox_t *box = phone->callee;
   
    ASSERT(box);
 
    mutex_lock(&box->mutex);
    list_remove(&phone->list);
    mutex_unlock(&box->mutex);
}
 
/** Helper function to facilitate synchronous calls */
void ipc_call_sync(phone_t *phone, call_t *request)
{
    answerbox_t sync_box;
 
    ipc_answerbox_init(&sync_box);
 
    /* We will receive data on special box */
    request->callerbox = &sync_box;
 
    ipc_call(phone, request);
    ipc_wait_for_call(&sync_box, 0);
}
 
/** Send a asynchronous request using phone to answerbox
 *
 * @param phone Phone connected to answerbox
 * @param request Request to be sent
 */
void ipc_call(phone_t *phone, call_t *request)
{
    answerbox_t *box = phone->callee;
 
    ASSERT(box);
 
    mutex_lock(&box->mutex);
    list_append(&request->list, &box->calls);
    mutex_unlock(&box->mutex);
    condvar_signal(&box->cv);
}
 
/** Answer message back to phone
 *
 * @param box Answerbox that is answering the message
 * @param request Modified request that is being sent back
 */
void ipc_answer(answerbox_t *box, call_t *request)
{
    answerbox_t *callerbox = request->callerbox;
 
    request->flags |= IPC_CALL_ANSWERED;
 
    mutex_lock(&box->mutex);
    list_remove(&request->list);
    mutex_unlock(&box->mutex);
 
    mutex_lock(&callerbox->mutex);
    list_append(&request->list, &callerbox->answers);
    mutex_unlock(&callerbox->mutex);
    condvar_signal(&callerbox->cv);
}
 
/** Wait for phone call
 *
 * @return Recived message address
 * - to distinguish between call and answer, look at call->flags
 */
call_t * ipc_wait_for_call(answerbox_t *box, int flags)
{
    call_t *request;
 
    mutex_lock(&box->mutex);
    while (1) {
        if (!list_empty(&box->answers)) {
            /* Handle asynchronous answers */
            request = list_get_instance(box->answers.next, call_t, list);
            list_remove(&request->list);
        } else if (!list_empty(&box->calls)) {
            /* Handle requests */
            request = list_get_instance(box->calls.next, call_t, list);
            list_remove(&request->list);
            /* Append request to dispatch queue */
            list_append(&request->list, &box->dispatched_calls);
        } else {
            if (!(flags & IPC_WAIT_NONBLOCKING)) {
                /* Wait for event to appear */
                condvar_wait(&box->cv, &box->mutex);
                continue;
            }
            request = NULL;
        }
        break;
    }
    mutex_unlock(&box->mutex);
    return request;
}
 
/** Initilize ipc subsystem */
void ipc_init(void)
{
    ipc_call_slab = slab_cache_create("ipc_call",
                      sizeof(call_t),
                      0,
                      NULL, NULL, 0);
}
 

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/src/ipc/ipc.c @ 2471 – Rev 1005 → 1027

Rev 1005		Rev 1027
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	/* Lock ordering	29	/* Lock ordering
30	*	30	*
31	* First the answerbox, then the phone	31	* First the answerbox, then the phone
32	*/	32	*/
33		33
34	#include <synch/condvar.h>	34	#include <synch/condvar.h>
35	#include <synch/mutex.h>	35	#include <synch/mutex.h>
36	#include <ipc/ipc.h>	36	#include <ipc/ipc.h>
37	#include <errno.h>	37	#include <errno.h>
38	#include <mm/slab.h>	38	#include <mm/slab.h>
39	#include <arch.h>	39	#include <arch.h>
40	#include <proc/task.h>	40	#include <proc/task.h>
41	#include <memstr.h>	41	#include <memstr.h>
42	#include <debug.h>	42	#include <debug.h>
43		43
44	#include <print.h>	44	#include <print.h>
45	#include <proc/thread.h>	45	#include <proc/thread.h>
46		46
47	/* Open channel that is assigned automatically to new tasks */	47	/* Open channel that is assigned automatically to new tasks */
48	answerbox_t *ipc_phone_0 = NULL;	48	answerbox_t *ipc_phone_0 = NULL;
49		49
50	static slab_cache_t *ipc_call_slab;	50	static slab_cache_t *ipc_call_slab;
51		51
52	/** Allocate & initialize call structure	52	/** Allocate & initialize call structure
53	*	53	*
54	* The call is initialized, so that the reply will be directed	54	* The call is initialized, so that the reply will be directed
55	* to TASK->answerbox	55	* to TASK->answerbox
56	*/	56	*/
57	call_t * ipc_call_alloc(void)	57	call_t * ipc_call_alloc(void)
58	{	58	{
59	call_t *call;	59	call_t *call;
60		60
61	call = slab_alloc(ipc_call_slab, 0);	61	call = slab_alloc(ipc_call_slab, 0);
62	memsetb((__address)call, sizeof(*call), 0);	62	memsetb((__address)call, sizeof(*call), 0);
63	call->callerbox = &TASK->answerbox;	63	call->callerbox = &TASK->answerbox;
64	call->sender = TASK;	64	call->sender = TASK;
65		65
66	return call;	66	return call;
67	}	67	}
68		68
69	/** Initialize allocated call */	69	/** Initialize allocated call */
70	void ipc_call_init(call_t *call)	70	void ipc_call_init(call_t *call)
71	{	71	{
72	call->callerbox = &TASK->answerbox;	72	call->callerbox = &TASK->answerbox;
73	call->flags = IPC_CALL_STATIC_ALLOC;	73	call->flags = IPC_CALL_STATIC_ALLOC;
-		74	call->sender = TASK;
74	}	75	}
75		76
76	/** Deallocate call stracuture */	77	/** Deallocate call stracuture */
77	void ipc_call_free(call_t *call)	78	void ipc_call_free(call_t *call)
78	{	79	{
79	slab_free(ipc_call_slab, call);	80	slab_free(ipc_call_slab, call);
80	}	81	}
81		82
82	/** Initialize answerbox structure	83	/** Initialize answerbox structure
83	*/	84	*/
84	void ipc_answerbox_init(answerbox_t *box)	85	void ipc_answerbox_init(answerbox_t *box)
85	{	86	{
86	mutex_initialize(&box->mutex);	87	mutex_initialize(&box->mutex);
87	condvar_initialize(&box->cv);	88	condvar_initialize(&box->cv);
88	list_initialize(&box->connected_phones);	89	list_initialize(&box->connected_phones);
89	list_initialize(&box->calls);	90	list_initialize(&box->calls);
90	list_initialize(&box->dispatched_calls);	91	list_initialize(&box->dispatched_calls);
91	list_initialize(&box->answers);	92	list_initialize(&box->answers);
-		93	box->task = TASK;
92	}	94	}
93		95
94	/** Initialize phone structure and connect phone to naswerbox	96	/** Initialize phone structure and connect phone to naswerbox
95	*/	97	*/
96	void ipc_phone_init(phone_t phone, answerbox_t box)	98	void ipc_phone_init(phone_t phone, answerbox_t box)
97	{	99	{
98	spinlock_initialize(&phone->lock, "phone_lock");	100	spinlock_initialize(&phone->lock, "phone_lock");
99		101
100	phone->callee = box;	102	phone->callee = box;
101		103
102	mutex_lock(&box->mutex);	104	mutex_lock(&box->mutex);
103	list_append(&phone->list, &box->connected_phones);	105	list_append(&phone->list, &box->connected_phones);
104	mutex_unlock(&box->mutex);	106	mutex_unlock(&box->mutex);
105	}	107	}
106		108
107	/** Disconnect phone from answerbox */	109	/** Disconnect phone from answerbox */
108	void ipc_phone_destroy(phone_t *phone)	110	void ipc_phone_destroy(phone_t *phone)
109	{	111	{
110	answerbox_t *box = phone->callee;	112	answerbox_t *box = phone->callee;
111		113
112	ASSERT(box);	114	ASSERT(box);
113		115
114	mutex_lock(&box->mutex);	116	mutex_lock(&box->mutex);
115	list_remove(&phone->list);	117	list_remove(&phone->list);
116	mutex_unlock(&box->mutex);	118	mutex_unlock(&box->mutex);
117	}	119	}
118		120
119	/** Helper function to facilitate synchronous calls */	121	/** Helper function to facilitate synchronous calls */
120	void ipc_call_sync(phone_t phone, call_t request)	122	void ipc_call_sync(phone_t phone, call_t request)
121	{	123	{
122	answerbox_t sync_box;	124	answerbox_t sync_box;
123		125
124	ipc_answerbox_init(&sync_box);	126	ipc_answerbox_init(&sync_box);
125		127
126	/* We will receive data on special box */	128	/* We will receive data on special box */
127	request->callerbox = &sync_box;	129	request->callerbox = &sync_box;
128		130
129	ipc_call(phone, request);	131	ipc_call(phone, request);
130	ipc_wait_for_call(&sync_box, 0);	132	ipc_wait_for_call(&sync_box, 0);
131	}	133	}
132		134
133	/** Send a asynchronous request using phone to answerbox	135	/** Send a asynchronous request using phone to answerbox
134	*	136	*
135	* @param phone Phone connected to answerbox	137	* @param phone Phone connected to answerbox
136	* @param request Request to be sent	138	* @param request Request to be sent
137	*/	139	*/
138	void ipc_call(phone_t phone, call_t request)	140	void ipc_call(phone_t phone, call_t request)
139	{	141	{
140	answerbox_t *box = phone->callee;	142	answerbox_t *box = phone->callee;
141		143
142	ASSERT(box);	144	ASSERT(box);
143		145
144	mutex_lock(&box->mutex);	146	mutex_lock(&box->mutex);
145	list_append(&request->list, &box->calls);	147	list_append(&request->list, &box->calls);
146	mutex_unlock(&box->mutex);	148	mutex_unlock(&box->mutex);
147	condvar_signal(&box->cv);	149	condvar_signal(&box->cv);
148	}	150	}
149		151
150	/** Answer message back to phone	152	/** Answer message back to phone
151	*	153	*
152	* @param box Answerbox that is answering the message	154	* @param box Answerbox that is answering the message
153	* @param request Modified request that is being sent back	155	* @param request Modified request that is being sent back
154	*/	156	*/
155	void ipc_answer(answerbox_t box, call_t request)	157	void ipc_answer(answerbox_t box, call_t request)
156	{	158	{
157	answerbox_t *callerbox = request->callerbox;	159	answerbox_t *callerbox = request->callerbox;
158		160
159	request->flags \|= IPC_CALL_ANSWERED;	161	request->flags \|= IPC_CALL_ANSWERED;
160		162
161	mutex_lock(&box->mutex);	163	mutex_lock(&box->mutex);
162	list_remove(&request->list);	164	list_remove(&request->list);
163	mutex_unlock(&box->mutex);	165	mutex_unlock(&box->mutex);
164		166
165	mutex_lock(&callerbox->mutex);	167	mutex_lock(&callerbox->mutex);
166	list_append(&request->list, &callerbox->answers);	168	list_append(&request->list, &callerbox->answers);
167	mutex_unlock(&callerbox->mutex);	169	mutex_unlock(&callerbox->mutex);
168	condvar_signal(&callerbox->cv);	170	condvar_signal(&callerbox->cv);
169	}	171	}
170		172
171	/** Wait for phone call	173	/** Wait for phone call
172	*	174	*
173	* @return Recived message address	175	* @return Recived message address
174	* - to distinguish between call and answer, look at call->flags	176	* - to distinguish between call and answer, look at call->flags
175	*/	177	*/
176	call_t * ipc_wait_for_call(answerbox_t *box, int flags)	178	call_t * ipc_wait_for_call(answerbox_t *box, int flags)
177	{	179	{
178	call_t *request;	180	call_t *request;
179		181
180	mutex_lock(&box->mutex);	182	mutex_lock(&box->mutex);
181	while (1) {	183	while (1) {
182	if (!list_empty(&box->answers)) {	184	if (!list_empty(&box->answers)) {
183	/* Handle asynchronous answers */	185	/* Handle asynchronous answers */
184	request = list_get_instance(box->answers.next, call_t, list);	186	request = list_get_instance(box->answers.next, call_t, list);
185	list_remove(&request->list);	187	list_remove(&request->list);
186	} else if (!list_empty(&box->calls)) {	188	} else if (!list_empty(&box->calls)) {
187	/* Handle requests */	189	/* Handle requests */
188	request = list_get_instance(box->calls.next, call_t, list);	190	request = list_get_instance(box->calls.next, call_t, list);
189	list_remove(&request->list);	191	list_remove(&request->list);
190	/* Append request to dispatch queue */	192	/* Append request to dispatch queue */
191	list_append(&request->list, &box->dispatched_calls);	193	list_append(&request->list, &box->dispatched_calls);
192	} else {	194	} else {
193	if (!(flags & IPC_WAIT_NONBLOCKING)) {	195	if (!(flags & IPC_WAIT_NONBLOCKING)) {
194	/* Wait for event to appear */	196	/* Wait for event to appear */
195	condvar_wait(&box->cv, &box->mutex);	197	condvar_wait(&box->cv, &box->mutex);
196	continue;	198	continue;
197	}	199	}
198	request = NULL;	200	request = NULL;
199	}	201	}
200	break;	202	break;
201	}	203	}
202	mutex_unlock(&box->mutex);	204	mutex_unlock(&box->mutex);
203	return request;	205	return request;
204	}	206	}
205		207
206	/** Initilize ipc subsystem */	208	/** Initilize ipc subsystem */
207	void ipc_init(void)	209	void ipc_init(void)
208	{	210	{
209	ipc_call_slab = slab_cache_create("ipc_call",	211	ipc_call_slab = slab_cache_create("ipc_call",
210	sizeof(call_t),	212	sizeof(call_t),
211	0,	213	0,
212	NULL, NULL, 0);	214	NULL, NULL, 0);
213	}	215	}
214		216