WebSVN – HelenOS-historic – Diff – /kernel/trunk/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/spinlock.h>
#include <synch/waitq.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>
#include <arch/interrupt.h>
#include <ipc/irq.h>
 
/* Open channel that is assigned automatically to new tasks */
answerbox_t *ipc_phone_0 = NULL;
 
static slab_cache_t *ipc_call_slab;
 
 
 
 
 
 
 
 
 
/* Initialize new call */
static void _ipc_call_init(call_t *call)
{
    memsetb((__address)call, sizeof(*call), 0);
    call->callerbox = &TASK->answerbox;
    call->sender = TASK;
}
 
/** Allocate & initialize call structure
 *
 * The call is initialized, so that the reply will be directed
 * to TASK->answerbox
 *
 * @param flags Parameters for slab_alloc (ATOMIC, etc.)
 */
call_t * ipc_call_alloc(int flags)
{
    call_t *call;
 
    call = slab_alloc(ipc_call_slab, flags);
    _ipc_call_init(call);
 
    return call;
}
 
/** Initialize allocated call */
void ipc_call_static_init(call_t *call)
{
    _ipc_call_init(call);
    call->flags |= IPC_CALL_STATIC_ALLOC;
}
 
/** 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)
{
    spinlock_initialize(&box->lock, "ipc_box_lock");
    spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
    waitq_initialize(&box->wq);
    list_initialize(&box->connected_phones);
    list_initialize(&box->calls);
    list_initialize(&box->dispatched_calls);
    list_initialize(&box->answers);
    list_initialize(&box->irq_notifs);
    box->task = TASK;
}
 
/** Connect phone to answerbox */
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
{
    spinlock_lock(&phone->lock);
 
    ASSERT(!phone->callee);
    phone->busy = IPC_BUSY_CONNECTED;
    phone->callee = box;
 
    spinlock_lock(&box->lock);
    list_append(&phone->list, &box->connected_phones);
    spinlock_unlock(&box->lock);
 
    spinlock_unlock(&phone->lock);
}
 
/** Initialize phone structure and connect phone to answerbox
 */
void ipc_phone_init(phone_t *phone)
{
    spinlock_initialize(&phone->lock, "phone_lock");
    phone->callee = NULL;
    phone->busy = IPC_BUSY_FREE;
    atomic_set(&phone->active_calls, 0);
}
 
/** 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);
}
 
/** Answer message that was not dispatched and is not entered in
 * any queue
 */
static void _ipc_answer_free_call(call_t *call)
{
    answerbox_t *callerbox = call->callerbox;
 
    call->flags |= IPC_CALL_ANSWERED;
 
    spinlock_lock(&callerbox->lock);
    list_append(&call->list, &callerbox->answers);
    spinlock_unlock(&callerbox->lock);
    waitq_wakeup(&callerbox->wq, 0);
}
 
/** Answer message, that is in callee queue
 *
 * @param box Answerbox that is answering the message
 * @param call Modified request that is being sent back
 */
void ipc_answer(answerbox_t *box, call_t *call)
{
    /* Remove from active box */
    spinlock_lock(&box->lock);
    list_remove(&call->list);
    spinlock_unlock(&box->lock);
    /* Send back answer */
    _ipc_answer_free_call(call);
}
 
/** Simulate sending back a message
 *
 * Most errors are better handled by forming a normal backward
 * message and sending it as a normal answer.
 */
void ipc_backsend_err(phone_t *phone, call_t *call, __native err)
{
    call->data.phone = phone;
    atomic_inc(&phone->active_calls);
    if (phone->busy == IPC_BUSY_CONNECTED)
        IPC_SET_RETVAL(call->data, EHANGUP);
    else
        IPC_SET_RETVAL(call->data, ENOENT);
 
    _ipc_answer_free_call(call);
}
 
/* Unsafe unchecking ipc_call */
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
{
    if (! (call->flags & IPC_CALL_FORWARDED)) {
        atomic_inc(&phone->active_calls);
        call->data.phone = phone;
    }
 
    spinlock_lock(&box->lock);
    list_append(&call->list, &box->calls);
    spinlock_unlock(&box->lock);
    waitq_wakeup(&box->wq, 0);
}
 
/** Send a asynchronous request using phone to answerbox
 *
 * @param phone Phone connected to answerbox
 * @param request Request to be sent
 */
int ipc_call(phone_t *phone, call_t *call)
{
    answerbox_t *box;
 
    spinlock_lock(&phone->lock);
 
    box = phone->callee;
    if (!box) {
        /* Trying to send over disconnected phone */
        spinlock_unlock(&phone->lock);
        if (call->flags & IPC_CALL_FORWARDED) {
            IPC_SET_RETVAL(call->data, EFORWARD);
            _ipc_answer_free_call(call);
        } else { /* Simulate sending back a message */
            if (phone->busy == IPC_BUSY_CONNECTED)
                ipc_backsend_err(phone, call, EHANGUP);
            else
                ipc_backsend_err(phone, call, ENOENT);
        }
 
        return ENOENT;
    }
    _ipc_call(phone, box, call);
   
    spinlock_unlock(&phone->lock);
    return 0;
}
 
/** Disconnect phone from answerbox
 *
 * It is allowed to call disconnect on already disconnected phone
 *
 * @return 0 - phone disconnected, -1 - the phone was already disconnected
 */
int ipc_phone_hangup(phone_t *phone)
{
    answerbox_t *box;
    call_t *call;
   
    spinlock_lock(&phone->lock);
    box = phone->callee;
    if (!box) {
        if (phone->busy == IPC_BUSY_CONNECTING) {
            spinlock_unlock(&phone->lock);
            return -1;
        }
        /* Already disconnected phone */
        phone->busy = IPC_BUSY_FREE;
        spinlock_unlock(&phone->lock);
        return 0;
    }
 
    spinlock_lock(&box->lock);
    list_remove(&phone->list);
    phone->callee = NULL;
    spinlock_unlock(&box->lock);
 
    call = ipc_call_alloc(0);
    IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
    call->flags |= IPC_CALL_DISCARD_ANSWER;
    _ipc_call(phone, box, call);
 
    phone->busy = IPC_BUSY_FREE;
 
    spinlock_unlock(&phone->lock);
 
    return 0;
}
 
/** Forwards call from one answerbox to a new one
 *
 * @param request Request to be forwarded
 * @param newbox Target answerbox
 * @param oldbox Old answerbox
 * @return 0 on forward ok, error code, if there was error
 *
 * - the return value serves only as an information for the forwarder,
 *   the original caller is notified automatically with EFORWARD
 */
int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox)
{
    spinlock_lock(&oldbox->lock);
    list_remove(&call->list);
    spinlock_unlock(&oldbox->lock);
 
    return ipc_call(newphone, call);
}
 
 
/** 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;
    ipl_t ipl;
 
restart:      
    if (flags & IPC_WAIT_NONBLOCKING) {
        if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK)
            return NULL;
    } else
        waitq_sleep(&box->wq);
   
    spinlock_lock(&box->lock);
    if (!list_empty(&box->irq_notifs)) {
        ipl = interrupts_disable();
        spinlock_lock(&box->irq_lock);
 
        request = list_get_instance(box->irq_notifs.next, call_t, list);
        list_remove(&request->list);
 
        spinlock_unlock(&box->irq_lock);
        interrupts_restore(ipl);
    } else if (!list_empty(&box->answers)) {
        /* Handle asynchronous answers */
        request = list_get_instance(box->answers.next, call_t, list);
        list_remove(&request->list);
        atomic_dec(&request->data.phone->active_calls);
    } 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 {
        /* This can happen regularly after ipc_cleanup, remove
         * the warning in the future when the IPC is
         * more debugged */
        printf("WARNING: Spurious IPC wakeup.\n");
        spinlock_unlock(&box->lock);
        goto restart;
    }
    spinlock_unlock(&box->lock);
    return request;
}
 
/** Answer all calls from list with EHANGUP msg */
static void ipc_cleanup_call_list(link_t *lst)
{
    call_t *call;
 
    while (!list_empty(lst)) {
        call = list_get_instance(lst->next, call_t, list);
        list_remove(&call->list);
 
        IPC_SET_RETVAL(call->data, EHANGUP);
        _ipc_answer_free_call(call);
    }
}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/** Cleans up all IPC communication of the given task
 *
 *
 */
void ipc_cleanup(task_t *task)
{
    int i;
    call_t *call;
    phone_t *phone;
   
    /* Disconnect all our phones ('ipc_phone_hangup') */
    for (i=0;i < IPC_MAX_PHONES; i++)
        ipc_phone_hangup(&task->phones[i]);
 
    /* Disconnect all connected irqs */
    ipc_irq_cleanup(&task->answerbox);
 
    /* Disconnect all phones connected to our answerbox */
restart_phones:
    spinlock_lock(&task->answerbox.lock);
    while (!list_empty(&task->answerbox.connected_phones)) {
        phone = list_get_instance(task->answerbox.connected_phones.next,
                      phone_t,
                      list);
        if (! spinlock_trylock(&phone->lock)) {
            spinlock_unlock(&task->answerbox.lock);
            goto restart_phones;
        }
       
        /* Disconnect phone */
        phone->callee = NULL;
        list_remove(&phone->list);
 
        spinlock_unlock(&phone->lock);
    }
 
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
    spinlock_lock(&task->answerbox.lock);
    ipc_cleanup_call_list(&task->answerbox.dispatched_calls);
    ipc_cleanup_call_list(&task->answerbox.calls);
    spinlock_unlock(&task->answerbox.lock);
   
    /* Wait for all async answers to arrive */
    while (atomic_get(&task->active_calls)) {
        call = ipc_wait_for_call(&task->answerbox, 0);
        ASSERT((call->flags & IPC_CALL_ANSWERED) || (call->flags & IPC_CALL_NOTIF));
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
       
        atomic_dec(&task->active_calls);
        ipc_call_free(call);
    }
}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/** Initilize ipc subsystem */
void ipc_init(void)
{
    ipc_call_slab = slab_cache_create("ipc_call",
                      sizeof(call_t),
                      0,
                      NULL, NULL, 0);
    ipc_irq_make_table(IRQ_COUNT);
}
 
 

Rev 1260	Rev 1281
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/spinlock.h>	34	#include <synch/spinlock.h>
35	#include <synch/waitq.h>	35	#include <synch/waitq.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	#include <arch/interrupt.h>	46	#include <arch/interrupt.h>
-		47	#include <ipc/irq.h>
47		48
48	/* Open channel that is assigned automatically to new tasks */	49	/* Open channel that is assigned automatically to new tasks */
49	answerbox_t *ipc_phone_0 = NULL;	50	answerbox_t *ipc_phone_0 = NULL;
50		51
51	static slab_cache_t *ipc_call_slab;	52	static slab_cache_t *ipc_call_slab;
52		53
53	typedef struct {	-
54	SPINLOCK_DECLARE(lock);	-
55	answerbox_t *box;	-
56	} ipc_irq_t;	-
57		-
58	static ipc_irq_t *irq_conns = NULL;	-
59	static int irq_conns_size;	-
60		-
61	/* Initialize new call */	54	/* Initialize new call */
62	static void _ipc_call_init(call_t *call)	55	static void _ipc_call_init(call_t *call)
63	{	56	{
64	memsetb((__address)call, sizeof(*call), 0);	57	memsetb((__address)call, sizeof(*call), 0);
65	call->callerbox = &TASK->answerbox;	58	call->callerbox = &TASK->answerbox;
66	call->sender = TASK;	59	call->sender = TASK;
67	}	60	}
68		61
69	/** Allocate & initialize call structure	62	/** Allocate & initialize call structure
70	*	63	*
71	* The call is initialized, so that the reply will be directed	64	* The call is initialized, so that the reply will be directed
72	* to TASK->answerbox	65	* to TASK->answerbox
73	*	66	*
74	* @param flags Parameters for slab_alloc (ATOMIC, etc.)	67	* @param flags Parameters for slab_alloc (ATOMIC, etc.)
75	*/	68	*/
76	call_t * ipc_call_alloc(int flags)	69	call_t * ipc_call_alloc(int flags)
77	{	70	{
78	call_t *call;	71	call_t *call;
79		72
80	call = slab_alloc(ipc_call_slab, flags);	73	call = slab_alloc(ipc_call_slab, flags);
81	_ipc_call_init(call);	74	_ipc_call_init(call);
82		75
83	return call;	76	return call;
84	}	77	}
85		78
86	/** Initialize allocated call */	79	/** Initialize allocated call */
87	void ipc_call_static_init(call_t *call)	80	void ipc_call_static_init(call_t *call)
88	{	81	{
89	_ipc_call_init(call);	82	_ipc_call_init(call);
90	call->flags \|= IPC_CALL_STATIC_ALLOC;	83	call->flags \|= IPC_CALL_STATIC_ALLOC;
91	}	84	}
92		85
93	/** Deallocate call stracuture */	86	/** Deallocate call stracuture */
94	void ipc_call_free(call_t *call)	87	void ipc_call_free(call_t *call)
95	{	88	{
96	slab_free(ipc_call_slab, call);	89	slab_free(ipc_call_slab, call);
97	}	90	}
98		91
99	/** Initialize answerbox structure	92	/** Initialize answerbox structure
100	*/	93	*/
101	void ipc_answerbox_init(answerbox_t *box)	94	void ipc_answerbox_init(answerbox_t *box)
102	{	95	{
103	spinlock_initialize(&box->lock, "ipc_box_lock");	96	spinlock_initialize(&box->lock, "ipc_box_lock");
104	spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");	97	spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
105	waitq_initialize(&box->wq);	98	waitq_initialize(&box->wq);
106	list_initialize(&box->connected_phones);	99	list_initialize(&box->connected_phones);
107	list_initialize(&box->calls);	100	list_initialize(&box->calls);
108	list_initialize(&box->dispatched_calls);	101	list_initialize(&box->dispatched_calls);
109	list_initialize(&box->answers);	102	list_initialize(&box->answers);
110	list_initialize(&box->irq_notifs);	103	list_initialize(&box->irq_notifs);
111	box->task = TASK;	104	box->task = TASK;
112	}	105	}
113		106
114	/** Connect phone to answerbox */	107	/** Connect phone to answerbox */
115	void ipc_phone_connect(phone_t phone, answerbox_t box)	108	void ipc_phone_connect(phone_t phone, answerbox_t box)
116	{	109	{
117	spinlock_lock(&phone->lock);	110	spinlock_lock(&phone->lock);
118		111
119	ASSERT(!phone->callee);	112	ASSERT(!phone->callee);
120	phone->busy = IPC_BUSY_CONNECTED;	113	phone->busy = IPC_BUSY_CONNECTED;
121	phone->callee = box;	114	phone->callee = box;
122		115
123	spinlock_lock(&box->lock);	116	spinlock_lock(&box->lock);
124	list_append(&phone->list, &box->connected_phones);	117	list_append(&phone->list, &box->connected_phones);
125	spinlock_unlock(&box->lock);	118	spinlock_unlock(&box->lock);
126		119
127	spinlock_unlock(&phone->lock);	120	spinlock_unlock(&phone->lock);
128	}	121	}
129		122
130	/** Initialize phone structure and connect phone to answerbox	123	/** Initialize phone structure and connect phone to answerbox
131	*/	124	*/
132	void ipc_phone_init(phone_t *phone)	125	void ipc_phone_init(phone_t *phone)
133	{	126	{
134	spinlock_initialize(&phone->lock, "phone_lock");	127	spinlock_initialize(&phone->lock, "phone_lock");
135	phone->callee = NULL;	128	phone->callee = NULL;
136	phone->busy = IPC_BUSY_FREE;	129	phone->busy = IPC_BUSY_FREE;
137	atomic_set(&phone->active_calls, 0);	130	atomic_set(&phone->active_calls, 0);
138	}	131	}
139		132
140	/** Helper function to facilitate synchronous calls */	133	/** Helper function to facilitate synchronous calls */
141	void ipc_call_sync(phone_t phone, call_t request)	134	void ipc_call_sync(phone_t phone, call_t request)
142	{	135	{
143	answerbox_t sync_box;	136	answerbox_t sync_box;
144		137
145	ipc_answerbox_init(&sync_box);	138	ipc_answerbox_init(&sync_box);
146		139
147	/* We will receive data on special box */	140	/* We will receive data on special box */
148	request->callerbox = &sync_box;	141	request->callerbox = &sync_box;
149		142
150	ipc_call(phone, request);	143	ipc_call(phone, request);
151	ipc_wait_for_call(&sync_box, 0);	144	ipc_wait_for_call(&sync_box, 0);
152	}	145	}
153		146
154	/** Answer message that was not dispatched and is not entered in	147	/** Answer message that was not dispatched and is not entered in
155	* any queue	148	* any queue
156	*/	149	*/
157	static void _ipc_answer_free_call(call_t *call)	150	static void _ipc_answer_free_call(call_t *call)
158	{	151	{
159	answerbox_t *callerbox = call->callerbox;	152	answerbox_t *callerbox = call->callerbox;
160		153
161	call->flags \|= IPC_CALL_ANSWERED;	154	call->flags \|= IPC_CALL_ANSWERED;
162		155
163	spinlock_lock(&callerbox->lock);	156	spinlock_lock(&callerbox->lock);
164	list_append(&call->list, &callerbox->answers);	157	list_append(&call->list, &callerbox->answers);
165	spinlock_unlock(&callerbox->lock);	158	spinlock_unlock(&callerbox->lock);
166	waitq_wakeup(&callerbox->wq, 0);	159	waitq_wakeup(&callerbox->wq, 0);
167	}	160	}
168		161
169	/** Answer message, that is in callee queue	162	/** Answer message, that is in callee queue
170	*	163	*
171	* @param box Answerbox that is answering the message	164	* @param box Answerbox that is answering the message
172	* @param call Modified request that is being sent back	165	* @param call Modified request that is being sent back
173	*/	166	*/
174	void ipc_answer(answerbox_t box, call_t call)	167	void ipc_answer(answerbox_t box, call_t call)
175	{	168	{
176	/* Remove from active box */	169	/* Remove from active box */
177	spinlock_lock(&box->lock);	170	spinlock_lock(&box->lock);
178	list_remove(&call->list);	171	list_remove(&call->list);
179	spinlock_unlock(&box->lock);	172	spinlock_unlock(&box->lock);
180	/* Send back answer */	173	/* Send back answer */
181	_ipc_answer_free_call(call);	174	_ipc_answer_free_call(call);
182	}	175	}
183		176
184	/** Simulate sending back a message	177	/** Simulate sending back a message
185	*	178	*
186	* Most errors are better handled by forming a normal backward	179	* Most errors are better handled by forming a normal backward
187	* message and sending it as a normal answer.	180	* message and sending it as a normal answer.
188	*/	181	*/
189	void ipc_backsend_err(phone_t phone, call_t call, __native err)	182	void ipc_backsend_err(phone_t phone, call_t call, __native err)
190	{	183	{
191	call->data.phone = phone;	184	call->data.phone = phone;
192	atomic_inc(&phone->active_calls);	185	atomic_inc(&phone->active_calls);
193	if (phone->busy == IPC_BUSY_CONNECTED)	186	if (phone->busy == IPC_BUSY_CONNECTED)
194	IPC_SET_RETVAL(call->data, EHANGUP);	187	IPC_SET_RETVAL(call->data, EHANGUP);
195	else	188	else
196	IPC_SET_RETVAL(call->data, ENOENT);	189	IPC_SET_RETVAL(call->data, ENOENT);
197		190
198	_ipc_answer_free_call(call);	191	_ipc_answer_free_call(call);
199	}	192	}
200		193
201	/* Unsafe unchecking ipc_call */	194	/* Unsafe unchecking ipc_call */
202	static void _ipc_call(phone_t phone, answerbox_t box, call_t *call)	195	static void _ipc_call(phone_t phone, answerbox_t box, call_t *call)
203	{	196	{
204	if (! (call->flags & IPC_CALL_FORWARDED)) {	197	if (! (call->flags & IPC_CALL_FORWARDED)) {
205	atomic_inc(&phone->active_calls);	198	atomic_inc(&phone->active_calls);
206	call->data.phone = phone;	199	call->data.phone = phone;
207	}	200	}
208		201
209	spinlock_lock(&box->lock);	202	spinlock_lock(&box->lock);
210	list_append(&call->list, &box->calls);	203	list_append(&call->list, &box->calls);
211	spinlock_unlock(&box->lock);	204	spinlock_unlock(&box->lock);
212	waitq_wakeup(&box->wq, 0);	205	waitq_wakeup(&box->wq, 0);
213	}	206	}
214		207
215	/** Send a asynchronous request using phone to answerbox	208	/** Send a asynchronous request using phone to answerbox
216	*	209	*
217	* @param phone Phone connected to answerbox	210	* @param phone Phone connected to answerbox
218	* @param request Request to be sent	211	* @param request Request to be sent
219	*/	212	*/
220	int ipc_call(phone_t phone, call_t call)	213	int ipc_call(phone_t phone, call_t call)
221	{	214	{
222	answerbox_t *box;	215	answerbox_t *box;
223		216
224	spinlock_lock(&phone->lock);	217	spinlock_lock(&phone->lock);
225		218
226	box = phone->callee;	219	box = phone->callee;
227	if (!box) {	220	if (!box) {
228	/* Trying to send over disconnected phone */	221	/* Trying to send over disconnected phone */
229	spinlock_unlock(&phone->lock);	222	spinlock_unlock(&phone->lock);
230	if (call->flags & IPC_CALL_FORWARDED) {	223	if (call->flags & IPC_CALL_FORWARDED) {
231	IPC_SET_RETVAL(call->data, EFORWARD);	224	IPC_SET_RETVAL(call->data, EFORWARD);
232	_ipc_answer_free_call(call);	225	_ipc_answer_free_call(call);
233	} else { /* Simulate sending back a message */	226	} else { /* Simulate sending back a message */
234	if (phone->busy == IPC_BUSY_CONNECTED)	227	if (phone->busy == IPC_BUSY_CONNECTED)
235	ipc_backsend_err(phone, call, EHANGUP);	228	ipc_backsend_err(phone, call, EHANGUP);
236	else	229	else
237	ipc_backsend_err(phone, call, ENOENT);	230	ipc_backsend_err(phone, call, ENOENT);
238	}	231	}
239		232
240	return ENOENT;	233	return ENOENT;
241	}	234	}
242	_ipc_call(phone, box, call);	235	_ipc_call(phone, box, call);
243		236
244	spinlock_unlock(&phone->lock);	237	spinlock_unlock(&phone->lock);
245	return 0;	238	return 0;
246	}	239	}
247		240
248	/** Disconnect phone from answerbox	241	/** Disconnect phone from answerbox
249	*	242	*
250	* It is allowed to call disconnect on already disconnected phone	243	* It is allowed to call disconnect on already disconnected phone
251	*	244	*
252	* @return 0 - phone disconnected, -1 - the phone was already disconnected	245	* @return 0 - phone disconnected, -1 - the phone was already disconnected
253	*/	246	*/
254	int ipc_phone_hangup(phone_t *phone)	247	int ipc_phone_hangup(phone_t *phone)
255	{	248	{
256	answerbox_t *box;	249	answerbox_t *box;
257	call_t *call;	250	call_t *call;
258		251
259	spinlock_lock(&phone->lock);	252	spinlock_lock(&phone->lock);
260	box = phone->callee;	253	box = phone->callee;
261	if (!box) {	254	if (!box) {
262	if (phone->busy == IPC_BUSY_CONNECTING) {	255	if (phone->busy == IPC_BUSY_CONNECTING) {
263	spinlock_unlock(&phone->lock);	256	spinlock_unlock(&phone->lock);
264	return -1;	257	return -1;
265	}	258	}
266	/* Already disconnected phone */	259	/* Already disconnected phone */
267	phone->busy = IPC_BUSY_FREE;	260	phone->busy = IPC_BUSY_FREE;
268	spinlock_unlock(&phone->lock);	261	spinlock_unlock(&phone->lock);
269	return 0;	262	return 0;
270	}	263	}
271		264
272	spinlock_lock(&box->lock);	265	spinlock_lock(&box->lock);
273	list_remove(&phone->list);	266	list_remove(&phone->list);
274	phone->callee = NULL;	267	phone->callee = NULL;
275	spinlock_unlock(&box->lock);	268	spinlock_unlock(&box->lock);
276		269
277	call = ipc_call_alloc(0);	270	call = ipc_call_alloc(0);
278	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);	271	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
279	call->flags \|= IPC_CALL_DISCARD_ANSWER;	272	call->flags \|= IPC_CALL_DISCARD_ANSWER;
280	_ipc_call(phone, box, call);	273	_ipc_call(phone, box, call);
281		274
282	phone->busy = IPC_BUSY_FREE;	275	phone->busy = IPC_BUSY_FREE;
283		276
284	spinlock_unlock(&phone->lock);	277	spinlock_unlock(&phone->lock);
285		278
286	return 0;	279	return 0;
287	}	280	}
288		281
289	/** Forwards call from one answerbox to a new one	282	/** Forwards call from one answerbox to a new one
290	*	283	*
291	* @param request Request to be forwarded	284	* @param request Request to be forwarded
292	* @param newbox Target answerbox	285	* @param newbox Target answerbox
293	* @param oldbox Old answerbox	286	* @param oldbox Old answerbox
294	* @return 0 on forward ok, error code, if there was error	287	* @return 0 on forward ok, error code, if there was error
295	*	288	*
296	* - the return value serves only as an information for the forwarder,	289	* - the return value serves only as an information for the forwarder,
297	* the original caller is notified automatically with EFORWARD	290	* the original caller is notified automatically with EFORWARD
298	*/	291	*/
299	int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox)	292	int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox)
300	{	293	{
301	spinlock_lock(&oldbox->lock);	294	spinlock_lock(&oldbox->lock);
302	list_remove(&call->list);	295	list_remove(&call->list);
303	spinlock_unlock(&oldbox->lock);	296	spinlock_unlock(&oldbox->lock);
304		297
305	return ipc_call(newphone, call);	298	return ipc_call(newphone, call);
306	}	299	}
307		300
308		301
309	/** Wait for phone call	302	/** Wait for phone call
310	*	303	*
311	* @return Recived message address	304	* @return Recived message address
312	* - to distinguish between call and answer, look at call->flags	305	* - to distinguish between call and answer, look at call->flags
313	*/	306	*/
314	call_t * ipc_wait_for_call(answerbox_t *box, int flags)	307	call_t * ipc_wait_for_call(answerbox_t *box, int flags)
315	{	308	{
316	call_t *request;	309	call_t *request;
317	ipl_t ipl;	310	ipl_t ipl;
318		311
319	restart:	312	restart:
320	if (flags & IPC_WAIT_NONBLOCKING) {	313	if (flags & IPC_WAIT_NONBLOCKING) {
321	if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK)	314	if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK)
322	return NULL;	315	return NULL;
323	} else	316	} else
324	waitq_sleep(&box->wq);	317	waitq_sleep(&box->wq);
325		318
326	spinlock_lock(&box->lock);	319	spinlock_lock(&box->lock);
327	if (!list_empty(&box->irq_notifs)) {	320	if (!list_empty(&box->irq_notifs)) {
328	ipl = interrupts_disable();	321	ipl = interrupts_disable();
329	spinlock_lock(&box->irq_lock);	322	spinlock_lock(&box->irq_lock);
330		323
331	request = list_get_instance(box->answers.next, call_t, list);	324	request = list_get_instance(box->irq_notifs.next, call_t, list);
332	list_remove(&request->list);	325	list_remove(&request->list);
333		326
334	spinlock_unlock(&box->irq_lock);	327	spinlock_unlock(&box->irq_lock);
335	interrupts_restore(ipl);	328	interrupts_restore(ipl);
336	} else if (!list_empty(&box->answers)) {	329	} else if (!list_empty(&box->answers)) {
337	/* Handle asynchronous answers */	330	/* Handle asynchronous answers */
338	request = list_get_instance(box->answers.next, call_t, list);	331	request = list_get_instance(box->answers.next, call_t, list);
339	list_remove(&request->list);	332	list_remove(&request->list);
340	atomic_dec(&request->data.phone->active_calls);	333	atomic_dec(&request->data.phone->active_calls);
341	} else if (!list_empty(&box->calls)) {	334	} else if (!list_empty(&box->calls)) {
342	/* Handle requests */	335	/* Handle requests */
343	request = list_get_instance(box->calls.next, call_t, list);	336	request = list_get_instance(box->calls.next, call_t, list);
344	list_remove(&request->list);	337	list_remove(&request->list);
345	/* Append request to dispatch queue */	338	/* Append request to dispatch queue */
346	list_append(&request->list, &box->dispatched_calls);	339	list_append(&request->list, &box->dispatched_calls);
347	} else {	340	} else {
348	/* This can happen regularly after ipc_cleanup, remove	341	/* This can happen regularly after ipc_cleanup, remove
349	* the warning in the future when the IPC is	342	* the warning in the future when the IPC is
350	* more debugged */	343	* more debugged */
351	printf("WARNING: Spurious IPC wakeup.\n");	344	printf("WARNING: Spurious IPC wakeup.\n");
352	spinlock_unlock(&box->lock);	345	spinlock_unlock(&box->lock);
353	goto restart;	346	goto restart;
354	}	347	}
355	spinlock_unlock(&box->lock);	348	spinlock_unlock(&box->lock);
356	return request;	349	return request;
357	}	350	}
358		351
359	/** Answer all calls from list with EHANGUP msg */	352	/** Answer all calls from list with EHANGUP msg */
360	static void ipc_cleanup_call_list(link_t *lst)	353	static void ipc_cleanup_call_list(link_t *lst)
361	{	354	{
362	call_t *call;	355	call_t *call;
363		356
364	while (!list_empty(lst)) {	357	while (!list_empty(lst)) {
365	call = list_get_instance(lst->next, call_t, list);	358	call = list_get_instance(lst->next, call_t, list);
366	list_remove(&call->list);	359	list_remove(&call->list);
367		360
368	IPC_SET_RETVAL(call->data, EHANGUP);	361	IPC_SET_RETVAL(call->data, EHANGUP);
369	_ipc_answer_free_call(call);	362	_ipc_answer_free_call(call);
370	}	363	}
371	}	364	}
372		365
373	/** Disconnect all irq's notifications	-
374	*	-
375	* TODO: It may be better to do some linked list, so that	-
376	* we wouldn't need to go through whole array every cleanup	-
377	*/	-
378	static void ipc_irq_cleanup(answerbox_t *box)	-
379	{	-
380	int i;	-
381	ipl_t ipl;	-
382		-
383	for (i=0; i < irq_conns_size; i++) {	-
384	ipl = interrupts_disable();	-
385	spinlock_lock(&irq_conns[i].lock);	-
386	if (irq_conns[i].box == box)	-
387	irq_conns[i].box = NULL;	-
388	spinlock_unlock(&irq_conns[i].lock);	-
389	interrupts_restore(ipl);	-
390	}	-
391	}	-
392		-
393	/** Cleans up all IPC communication of the given task	366	/** Cleans up all IPC communication of the given task
394	*	367	*
395	*	368	*
396	*/	369	*/
397	void ipc_cleanup(task_t *task)	370	void ipc_cleanup(task_t *task)
398	{	371	{
399	int i;	372	int i;
400	call_t *call;	373	call_t *call;
401	phone_t *phone;	374	phone_t *phone;
402		375
403	/* Disconnect all our phones ('ipc_phone_hangup') */	376	/* Disconnect all our phones ('ipc_phone_hangup') */
404	for (i=0;i < IPC_MAX_PHONES; i++)	377	for (i=0;i < IPC_MAX_PHONES; i++)
405	ipc_phone_hangup(&task->phones[i]);	378	ipc_phone_hangup(&task->phones[i]);
406		379
407	/* Disconnect all connected irqs */	380	/* Disconnect all connected irqs */
408	ipc_irq_cleanup(&task->answerbox);	381	ipc_irq_cleanup(&task->answerbox);
409		382
410	/* Disconnect all phones connected to our answerbox */	383	/* Disconnect all phones connected to our answerbox */
411	restart_phones:	384	restart_phones:
412	spinlock_lock(&task->answerbox.lock);	385	spinlock_lock(&task->answerbox.lock);
413	while (!list_empty(&task->answerbox.connected_phones)) {	386	while (!list_empty(&task->answerbox.connected_phones)) {
414	phone = list_get_instance(task->answerbox.connected_phones.next,	387	phone = list_get_instance(task->answerbox.connected_phones.next,
415	phone_t,	388	phone_t,
416	list);	389	list);
417	if (! spinlock_trylock(&phone->lock)) {	390	if (! spinlock_trylock(&phone->lock)) {
418	spinlock_unlock(&task->answerbox.lock);	391	spinlock_unlock(&task->answerbox.lock);
419	goto restart_phones;	392	goto restart_phones;
420	}	393	}
421		394
422	/* Disconnect phone */	395	/* Disconnect phone */
423	phone->callee = NULL;	396	phone->callee = NULL;
424	list_remove(&phone->list);	397	list_remove(&phone->list);
425		398
426	spinlock_unlock(&phone->lock);	399	spinlock_unlock(&phone->lock);
427	}	400	}
428		401
429	/* Answer all messages in 'calls' and 'dispatched_calls' queues */	402	/* Answer all messages in 'calls' and 'dispatched_calls' queues */
430	spinlock_lock(&task->answerbox.lock);	403	spinlock_lock(&task->answerbox.lock);
431	ipc_cleanup_call_list(&task->answerbox.dispatched_calls);	404	ipc_cleanup_call_list(&task->answerbox.dispatched_calls);
432	ipc_cleanup_call_list(&task->answerbox.calls);	405	ipc_cleanup_call_list(&task->answerbox.calls);
433	spinlock_unlock(&task->answerbox.lock);	406	spinlock_unlock(&task->answerbox.lock);
434		407
435	/* Wait for all async answers to arrive */	408	/* Wait for all async answers to arrive */
436	while (atomic_get(&task->active_calls)) {	409	while (atomic_get(&task->active_calls)) {
437	call = ipc_wait_for_call(&task->answerbox, 0);	410	call = ipc_wait_for_call(&task->answerbox, 0);
438	ASSERT((call->flags & IPC_CALL_ANSWERED) \|\| (call->flags & IPC_CALL_NOTIF));	411	ASSERT((call->flags & IPC_CALL_ANSWERED) \|\| (call->flags & IPC_CALL_NOTIF));
439	ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));	412	ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
440		413
441	atomic_dec(&task->active_calls);	414	atomic_dec(&task->active_calls);
442	ipc_call_free(call);	415	ipc_call_free(call);
443	}	416	}
444	}	417	}
445		418
446	/** Initialize table of interrupt handlers */	-
447	static void ipc_irq_make_table(int irqcount)	-
448	{	-
449	int i;	-
450		-
451	irq_conns_size = irqcount;	-
452	irq_conns = malloc(irqcount * (sizeof(*irq_conns)), 0);	-
453	for (i=0; i < irqcount; i++) {	-
454	spinlock_initialize(&irq_conns[i].lock, "irq_ipc_lock");	-
455	irq_conns[i].box = NULL;	-
456	}	-
457	}	-
458		-
459	void ipc_irq_unregister(answerbox_t *box, int irq)	-
460	{	-
461	ipl_t ipl;	-
462		-
463	ipl = interrupts_disable();	-
464	spinlock_lock(&irq_conns[irq].lock);	-
465	if (irq_conns[irq].box == box)	-
466	irq_conns[irq].box = NULL;	-
467		-
468	spinlock_unlock(&irq_conns[irq].lock);	-
469	interrupts_restore(ipl);	-
470	}	-
471		-
472	/** Register an answerbox as a receiving end of interrupts notifications */	-
473	int ipc_irq_register(answerbox_t *box, int irq)	-
474	{	-
475	ipl_t ipl;	-
476		-
477	ASSERT(irq_conns);	-
478		-
479	ipl = interrupts_disable();	-
480	spinlock_lock(&irq_conns[irq].lock);	-
481		-
482	if (irq_conns[irq].box) {	-
483	spinlock_unlock(&irq_conns[irq].lock);	-
484	interrupts_restore(ipl);	-
485	return EEXISTS;	-
486	}	-
487	irq_conns[irq].box = box;	-
488	spinlock_unlock(&irq_conns[irq].lock);	-
489	interrupts_restore(ipl);	-
490		-
491	return 0;	-
492	}	-
493		-
494	/** Notify process that an irq had happend	-
495	*	-
496	* We expect interrupts to be disabled	-
497	*/	-
498	void ipc_irq_send_notif(int irq)	-
499	{	-

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/ipc/ipc.c – Rev 1260 → 1281