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

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/ipc/ipc.c – Rev 1342 → 1364