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


/*
 * Copyright (c) 2008 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericipc
 * @{
 */
/** @file
 */
 
#include <synch/synch.h>
#include <synch/spinlock.h>
#include <synch/mutex.h>
#include <ipc/ipc.h>
#include <ipc/ipcrsc.h>
#include <arch.h>
#include <errno.h>
#include <debug.h>
#include <udebug/udebug_ipc.h>
#include <ipc/kbox.h>
 
void ipc_kbox_cleanup(void)
{
    bool have_kb_thread;
 
    /* Only hold kb_cleanup_lock while setting kb_finished - this is enough */
    mutex_lock(&TASK->kb_cleanup_lock);
    TASK->kb_finished = true;
    mutex_unlock(&TASK->kb_cleanup_lock);
 
    have_kb_thread = (TASK->kb_thread != NULL);
 
    /* From now on nobody will try to connect phones or attach kbox threads */
 
    /*
     * Disconnect all phones connected to our kbox. Passing true for
     * notify_box causes a HANGUP message to be inserted for each
     * disconnected phone. This ensures the kbox thread is going to
     * wake up and terminate.
     */
    ipc_answerbox_slam_phones(&TASK->kernel_box, have_kb_thread);
   
    if (have_kb_thread) {
        LOG("join kb_thread..\n");
        thread_join(TASK->kb_thread);
        thread_detach(TASK->kb_thread);
        LOG("join done\n");
        TASK->kb_thread = NULL;
    }
 
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
    spinlock_lock(&TASK->kernel_box.lock);
    ipc_cleanup_call_list(&TASK->kernel_box.dispatched_calls);
    ipc_cleanup_call_list(&TASK->kernel_box.calls);
    spinlock_unlock(&TASK->kernel_box.lock);
}
 
 
static void kbox_thread_proc(void *arg)
{
    call_t *call;
    int method;
    bool done;
    ipl_t ipl;
 
    (void)arg;
    LOG("kbox_thread_proc()\n");
    done = false;
 
    while (!done) {
        call = ipc_wait_for_call(&TASK->kernel_box, SYNCH_NO_TIMEOUT,
            SYNCH_FLAGS_NONE);
 
        if (call != NULL) {
            method = IPC_GET_METHOD(call->data);
 
            if (method == IPC_M_DEBUG_ALL) {
                udebug_call_receive(call);
            }
 
            if (method == IPC_M_PHONE_HUNGUP) {
                LOG("kbox: handle hangup message\n");
 
                /* Was it our debugger, who hung up? */
                if (call->sender == TASK->udebug.debugger) {
                    /* Terminate debugging session (if any) */
                    LOG("kbox: terminate debug session\n");
                    ipl = interrupts_disable();
                    spinlock_lock(&TASK->lock);
                    udebug_task_cleanup(TASK);
                    spinlock_unlock(&TASK->lock);
                    interrupts_restore(ipl);
                } else {
                    LOG("kbox: was not debugger\n");
                }
 
                LOG("kbox: continue with hangup message\n");
                IPC_SET_RETVAL(call->data, 0);
                ipc_answer(&TASK->kernel_box, call);
 
                ipl = interrupts_disable();
                spinlock_lock(&TASK->lock);
                spinlock_lock(&TASK->answerbox.lock);
                if (list_empty(&TASK->answerbox.connected_phones)) {
                    /* Last phone has been disconnected */
                    TASK->kb_thread = NULL;
                    done = true;
                    LOG("phone list is empty\n");
                }
                spinlock_unlock(&TASK->answerbox.lock);
                spinlock_unlock(&TASK->lock);
                interrupts_restore(ipl);
            }
        }
    }
 
    LOG("kbox: finished\n");
}
 
 
/**
 * Connect phone to a task kernel-box specified by id.
 *
 * Note that this is not completely atomic. For optimisation reasons,
 * The task might start cleaning up kbox after the phone has been connected
 * and before a kbox thread has been created. This must be taken into account
 * in the cleanup code.
 *
 * @return      Phone id on success, or negative error code.
 */
int ipc_connect_kbox(task_id_t taskid)
{
    int newphid;
    task_t *ta;
    thread_t *kb_thread;
    ipl_t ipl;
 
    ipl = interrupts_disable();
    spinlock_lock(&tasks_lock);
 
    ta = task_find_by_id(taskid);
    if (ta == NULL) {
        spinlock_unlock(&tasks_lock);
        interrupts_restore(ipl);
        return ENOENT;
    }
 
    atomic_inc(&ta->refcount);
 
    spinlock_unlock(&tasks_lock);
    interrupts_restore(ipl);
 
    mutex_lock(&ta->kb_cleanup_lock);
 
    if (atomic_predec(&ta->refcount) == 0) {
        mutex_unlock(&ta->kb_cleanup_lock);
        task_destroy(ta);
        return ENOENT;
    }
 
    if (ta->kb_finished != false) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return EINVAL;
    }
 
    newphid = phone_alloc();
    if (newphid < 0) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return ELIMIT;
    }
 
    /* Connect the newly allocated phone to the kbox */
    ipc_phone_connect(&TASK->phones[newphid], &ta->kernel_box);
 
    if (ta->kb_thread != NULL) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return newphid;
    }
 
    /* Create a kbox thread */
    kb_thread = thread_create(kbox_thread_proc, NULL, ta, 0, "kbox", false);
    if (!kb_thread) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return ENOMEM;
    }
 
    ta->kb_thread = kb_thread;
    thread_ready(kb_thread);
 
    mutex_unlock(&ta->kb_cleanup_lock);
 
    return newphid;
}
 
/** @}
 */
 

Rev 3441	Rev 3445
1	/*	1	/*
2	* Copyright (c) 2008 Jiri Svoboda	2	* Copyright (c) 2008 Jiri Svoboda
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericipc	29	/** @addtogroup genericipc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#include <synch/synch.h>	35	#include <synch/synch.h>
36	#include <synch/spinlock.h>	36	#include <synch/spinlock.h>
37	#include <synch/mutex.h>	37	#include <synch/mutex.h>
38	#include <ipc/ipc.h>	38	#include <ipc/ipc.h>
39	#include <ipc/ipcrsc.h>	39	#include <ipc/ipcrsc.h>
40	#include <arch.h>	40	#include <arch.h>
41	#include <errno.h>	41	#include <errno.h>
42	#include <debug.h>	42	#include <debug.h>
43	#include <udebug/udebug_ipc.h>	43	#include <udebug/udebug_ipc.h>
44	#include <ipc/ipc_kbox.h>	44	#include <ipc/kbox.h>
45		45
46	void ipc_kbox_cleanup(void)	46	void ipc_kbox_cleanup(void)
47	{	47	{
48	bool have_kb_thread;	48	bool have_kb_thread;
49		49
50	/* Only hold kb_cleanup_lock while setting kb_finished - this is enough */	50	/* Only hold kb_cleanup_lock while setting kb_finished - this is enough */
51	mutex_lock(&TASK->kb_cleanup_lock);	51	mutex_lock(&TASK->kb_cleanup_lock);
52	TASK->kb_finished = true;	52	TASK->kb_finished = true;
53	mutex_unlock(&TASK->kb_cleanup_lock);	53	mutex_unlock(&TASK->kb_cleanup_lock);
54		54
55	have_kb_thread = (TASK->kb_thread != NULL);	55	have_kb_thread = (TASK->kb_thread != NULL);
56		56
57	/* From now on nobody will try to connect phones or attach kbox threads */	57	/* From now on nobody will try to connect phones or attach kbox threads */
58		58
59	/*	59	/*
60	* Disconnect all phones connected to our kbox. Passing true for	60	* Disconnect all phones connected to our kbox. Passing true for
61	* notify_box causes a HANGUP message to be inserted for each	61	* notify_box causes a HANGUP message to be inserted for each
62	* disconnected phone. This ensures the kbox thread is going to	62	* disconnected phone. This ensures the kbox thread is going to
63	* wake up and terminate.	63	* wake up and terminate.
64	*/	64	*/
65	ipc_answerbox_slam_phones(&TASK->kernel_box, have_kb_thread);	65	ipc_answerbox_slam_phones(&TASK->kernel_box, have_kb_thread);
66		66
67	if (have_kb_thread) {	67	if (have_kb_thread) {
68	LOG("join kb_thread..\n");	68	LOG("join kb_thread..\n");
69	thread_join(TASK->kb_thread);	69	thread_join(TASK->kb_thread);
70	thread_detach(TASK->kb_thread);	70	thread_detach(TASK->kb_thread);
71	LOG("join done\n");	71	LOG("join done\n");
72	TASK->kb_thread = NULL;	72	TASK->kb_thread = NULL;
73	}	73	}
74		74
75	/* Answer all messages in 'calls' and 'dispatched_calls' queues */	75	/* Answer all messages in 'calls' and 'dispatched_calls' queues */
76	spinlock_lock(&TASK->kernel_box.lock);	76	spinlock_lock(&TASK->kernel_box.lock);
77	ipc_cleanup_call_list(&TASK->kernel_box.dispatched_calls);	77	ipc_cleanup_call_list(&TASK->kernel_box.dispatched_calls);
78	ipc_cleanup_call_list(&TASK->kernel_box.calls);	78	ipc_cleanup_call_list(&TASK->kernel_box.calls);
79	spinlock_unlock(&TASK->kernel_box.lock);	79	spinlock_unlock(&TASK->kernel_box.lock);
80	}	80	}
81		81
82		82
83	static void kbox_thread_proc(void *arg)	83	static void kbox_thread_proc(void *arg)
84	{	84	{
85	call_t *call;	85	call_t *call;
86	int method;	86	int method;
87	bool done;	87	bool done;
88	ipl_t ipl;	88	ipl_t ipl;
89		89
90	(void)arg;	90	(void)arg;
91	LOG("kbox_thread_proc()\n");	91	LOG("kbox_thread_proc()\n");
92	done = false;	92	done = false;
93		93
94	while (!done) {	94	while (!done) {
95	call = ipc_wait_for_call(&TASK->kernel_box, SYNCH_NO_TIMEOUT,	95	call = ipc_wait_for_call(&TASK->kernel_box, SYNCH_NO_TIMEOUT,
96	SYNCH_FLAGS_NONE);	96	SYNCH_FLAGS_NONE);
97		97
98	if (call != NULL) {	98	if (call != NULL) {
99	method = IPC_GET_METHOD(call->data);	99	method = IPC_GET_METHOD(call->data);
100		100
101	if (method == IPC_M_DEBUG_ALL) {	101	if (method == IPC_M_DEBUG_ALL) {
102	udebug_call_receive(call);	102	udebug_call_receive(call);
103	}	103	}
104		104
105	if (method == IPC_M_PHONE_HUNGUP) {	105	if (method == IPC_M_PHONE_HUNGUP) {
106	LOG("kbox: handle hangup message\n");	106	LOG("kbox: handle hangup message\n");
107		107
108	/* Was it our debugger, who hung up? */	108	/* Was it our debugger, who hung up? */
109	if (call->sender == TASK->udebug.debugger) {	109	if (call->sender == TASK->udebug.debugger) {
110	/* Terminate debugging session (if any) */	110	/* Terminate debugging session (if any) */
111	LOG("kbox: terminate debug session\n");	111	LOG("kbox: terminate debug session\n");
112	ipl = interrupts_disable();	112	ipl = interrupts_disable();
113	spinlock_lock(&TASK->lock);	113	spinlock_lock(&TASK->lock);
114	udebug_task_cleanup(TASK);	114	udebug_task_cleanup(TASK);
115	spinlock_unlock(&TASK->lock);	115	spinlock_unlock(&TASK->lock);
116	interrupts_restore(ipl);	116	interrupts_restore(ipl);
117	} else {	117	} else {
118	LOG("kbox: was not debugger\n");	118	LOG("kbox: was not debugger\n");
119	}	119	}
120		120
121	LOG("kbox: continue with hangup message\n");	121	LOG("kbox: continue with hangup message\n");
122	IPC_SET_RETVAL(call->data, 0);	122	IPC_SET_RETVAL(call->data, 0);
123	ipc_answer(&TASK->kernel_box, call);	123	ipc_answer(&TASK->kernel_box, call);
124		124
125	ipl = interrupts_disable();	125	ipl = interrupts_disable();
126	spinlock_lock(&TASK->lock);	126	spinlock_lock(&TASK->lock);
127	spinlock_lock(&TASK->answerbox.lock);	127	spinlock_lock(&TASK->answerbox.lock);
128	if (list_empty(&TASK->answerbox.connected_phones)) {	128	if (list_empty(&TASK->answerbox.connected_phones)) {
129	/* Last phone has been disconnected */	129	/* Last phone has been disconnected */
130	TASK->kb_thread = NULL;	130	TASK->kb_thread = NULL;
131	done = true;	131	done = true;
132	LOG("phone list is empty\n");	132	LOG("phone list is empty\n");
133	}	133	}
134	spinlock_unlock(&TASK->answerbox.lock);	134	spinlock_unlock(&TASK->answerbox.lock);
135	spinlock_unlock(&TASK->lock);	135	spinlock_unlock(&TASK->lock);
136	interrupts_restore(ipl);	136	interrupts_restore(ipl);
137	}	137	}
138	}	138	}
139	}	139	}
140		140
141	LOG("kbox: finished\n");	141	LOG("kbox: finished\n");
142	}	142	}
143		143
144		144
145	/**	145	/**
146	* Connect phone to a task kernel-box specified by id.	146	* Connect phone to a task kernel-box specified by id.
147	*	147	*
148	* Note that this is not completely atomic. For optimisation reasons,	148	* Note that this is not completely atomic. For optimisation reasons,
149	* The task might start cleaning up kbox after the phone has been connected	149	* The task might start cleaning up kbox after the phone has been connected
150	* and before a kbox thread has been created. This must be taken into account	150	* and before a kbox thread has been created. This must be taken into account
151	* in the cleanup code.	151	* in the cleanup code.
152	*	152	*
153	* @return Phone id on success, or negative error code.	153	* @return Phone id on success, or negative error code.
154	*/	154	*/
155	int ipc_connect_kbox(task_id_t taskid)	155	int ipc_connect_kbox(task_id_t taskid)
156	{	156	{
157	int newphid;	157	int newphid;
158	task_t *ta;	158	task_t *ta;
159	thread_t *kb_thread;	159	thread_t *kb_thread;
160	ipl_t ipl;	160	ipl_t ipl;
161		161
162	ipl = interrupts_disable();	162	ipl = interrupts_disable();
163	spinlock_lock(&tasks_lock);	163	spinlock_lock(&tasks_lock);
164		164
165	ta = task_find_by_id(taskid);	165	ta = task_find_by_id(taskid);
166	if (ta == NULL) {	166	if (ta == NULL) {
167	spinlock_unlock(&tasks_lock);	167	spinlock_unlock(&tasks_lock);
168	interrupts_restore(ipl);	168	interrupts_restore(ipl);
169	return ENOENT;	169	return ENOENT;
170	}	170	}
171		171
172	atomic_inc(&ta->refcount);	172	atomic_inc(&ta->refcount);
173		173
174	spinlock_unlock(&tasks_lock);	174	spinlock_unlock(&tasks_lock);
175	interrupts_restore(ipl);	175	interrupts_restore(ipl);
176		176
177	mutex_lock(&ta->kb_cleanup_lock);	177	mutex_lock(&ta->kb_cleanup_lock);
178		178
179	if (atomic_predec(&ta->refcount) == 0) {	179	if (atomic_predec(&ta->refcount) == 0) {
180	mutex_unlock(&ta->kb_cleanup_lock);	180	mutex_unlock(&ta->kb_cleanup_lock);
181	task_destroy(ta);	181	task_destroy(ta);
182	return ENOENT;	182	return ENOENT;
183	}	183	}
184		184
185	if (ta->kb_finished != false) {	185	if (ta->kb_finished != false) {
186	mutex_unlock(&ta->kb_cleanup_lock);	186	mutex_unlock(&ta->kb_cleanup_lock);
187	return EINVAL;	187	return EINVAL;
188	}	188	}
189		189
190	newphid = phone_alloc();	190	newphid = phone_alloc();
191	if (newphid < 0) {	191	if (newphid < 0) {
192	mutex_unlock(&ta->kb_cleanup_lock);	192	mutex_unlock(&ta->kb_cleanup_lock);
193	return ELIMIT;	193	return ELIMIT;
194	}	194	}
195		195
196	/* Connect the newly allocated phone to the kbox */	196	/* Connect the newly allocated phone to the kbox */
197	ipc_phone_connect(&TASK->phones[newphid], &ta->kernel_box);	197	ipc_phone_connect(&TASK->phones[newphid], &ta->kernel_box);
198		198
199	if (ta->kb_thread != NULL) {	199	if (ta->kb_thread != NULL) {
200	mutex_unlock(&ta->kb_cleanup_lock);	200	mutex_unlock(&ta->kb_cleanup_lock);
201	return newphid;	201	return newphid;
202	}	202	}
203		203
204	/* Create a kbox thread */	204	/* Create a kbox thread */
205	kb_thread = thread_create(kbox_thread_proc, NULL, ta, 0, "kbox", false);	205	kb_thread = thread_create(kbox_thread_proc, NULL, ta, 0, "kbox", false);
206	if (!kb_thread) {	206	if (!kb_thread) {
207	mutex_unlock(&ta->kb_cleanup_lock);	207	mutex_unlock(&ta->kb_cleanup_lock);
208	return ENOMEM;	208	return ENOMEM;
209	}	209	}
210		210
211	ta->kb_thread = kb_thread;	211	ta->kb_thread = kb_thread;
212	thread_ready(kb_thread);	212	thread_ready(kb_thread);
213		213
214	mutex_unlock(&ta->kb_cleanup_lock);	214	mutex_unlock(&ta->kb_cleanup_lock);
215		215
216	return newphid;	216	return newphid;
217	}	217	}
218		218
219	/** @}	219	/** @}
220	*/	220	*/
221		221

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/src/ipc/kbox.c @ 3870 – Rev 3441 → 3445