WebSVN – HelenOS – Diff – /trunk/kernel/generic/src/time/timeout.c


/*
 * Copyright (c) 2001-2004 Jakub Jermar
 * 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 time
 * @{
 */
 
/**
 * @file
 * @brief       Timeout management functions.
 */
 
#include <time/timeout.h>
#include <arch/types.h>
#include <config.h>
#include <panic.h>
#include <synch/spinlock.h>
#include <func.h>
#include <cpu.h>
#include <arch/asm.h>
#include <arch.h>
 
/** Initialize timeouts
 *
 * Initialize kernel timeouts.
 *
 */
void timeout_init(void)
{
    spinlock_initialize(&CPU->timeoutlock, "timeout_lock");
    list_initialize(&CPU->timeout_active_head);
}
 
 
/** Reinitialize timeout
 *
 * Initialize all members except the lock.
 *
 * @param t     Timeout to be initialized.
 *
 */
void timeout_reinitialize(timeout_t *t)
{
    t->cpu = NULL;
    t->ticks = 0;
    t->handler = NULL;
    t->arg = NULL;
    link_initialize(&t->link);
}
 
 
/** Initialize timeout
 *
 * Initialize all members including the lock.
 *
 * @param t     Timeout to be initialized.
 *
 */
void timeout_initialize(timeout_t *t)
{
    spinlock_initialize(&t->lock, "timeout_t_lock");
    timeout_reinitialize(t);
}
 
 
/** Register timeout
 *
 * Insert timeout handler f (with argument arg)
 * to timeout list and make it execute in
 * time microseconds (or slightly more).
 *
 * @param t     Timeout structure.
 * @param time      Number of usec in the future to execute the handler.
 * @param f     Timeout handler function.
 * @param arg       Timeout handler argument.
 *
 */
void
timeout_register(timeout_t *t, uint64_t time, timeout_handler_t f, void *arg)
{
    timeout_t *hlp = NULL;
    link_t *l, *m;
    ipl_t ipl;
    uint64_t sum;
 
    ipl = interrupts_disable();
    spinlock_lock(&CPU->timeoutlock);
    spinlock_lock(&t->lock);
 
    if (t->cpu)
        panic("Unexpected: t->cpu != 0.");
 
    t->cpu = CPU;
    t->ticks = us2ticks(time);
   
    t->handler = f;
    t->arg = arg;
 
    /*
     * Insert t into the active timeouts list according to t->ticks.
     */
    sum = 0;
    l = CPU->timeout_active_head.next;
    while (l != &CPU->timeout_active_head) {
        hlp = list_get_instance(l, timeout_t, link);
        spinlock_lock(&hlp->lock);
        if (t->ticks < sum + hlp->ticks) {
            spinlock_unlock(&hlp->lock);
            break;
        }
        sum += hlp->ticks;
        spinlock_unlock(&hlp->lock);
        l = l->next;
    }
 
    m = l->prev;
    list_prepend(&t->link, m); /* avoid using l->prev */
 
    /*
     * Adjust t->ticks according to ticks accumulated in h's predecessors.
     */
    t->ticks -= sum;
 
    /*
     * Decrease ticks of t's immediate succesor by t->ticks.
     */
    if (l != &CPU->timeout_active_head) {
        spinlock_lock(&hlp->lock);
        hlp->ticks -= t->ticks;
        spinlock_unlock(&hlp->lock);
    }
 
    spinlock_unlock(&t->lock);
    spinlock_unlock(&CPU->timeoutlock);
    interrupts_restore(ipl);
}
 
 
/** Unregister timeout
 *
 * Remove timeout from timeout list.
 *
 * @param t     Timeout to unregister.
 *
 * @return      True on success, false on failure.
 */
bool timeout_unregister(timeout_t *t)
{
    timeout_t *hlp;
    link_t *l;
    ipl_t ipl;
    DEADLOCK_PROBE_INIT(p_tolock);
 
grab_locks:
    ipl = interrupts_disable();
    spinlock_lock(&t->lock);
    if (!t->cpu) {
        spinlock_unlock(&t->lock);
        interrupts_restore(ipl);
        return false;
    }
    if (!spinlock_trylock(&t->cpu->timeoutlock)) {
        spinlock_unlock(&t->lock);
        interrupts_restore(ipl);
        DEADLOCK_PROBE(p_tolock, DEADLOCK_THRESHOLD);
        goto grab_locks;
    }
   
    /*
     * Now we know for sure that t hasn't been activated yet
     * and is lurking in t->cpu->timeout_active_head queue.
     */
 
    l = t->link.next;
    if (l != &t->cpu->timeout_active_head) {
        hlp = list_get_instance(l, timeout_t, link);
        spinlock_lock(&hlp->lock);
        hlp->ticks += t->ticks;
        spinlock_unlock(&hlp->lock);
    }
   
    list_remove(&t->link);
    spinlock_unlock(&t->cpu->timeoutlock);
 
    timeout_reinitialize(t);
    spinlock_unlock(&t->lock);
 
    interrupts_restore(ipl);
    return true;
}
 
/** @}
 */
 

Rev 2916	Rev 3790
1	/*	1	/*
2	* Copyright (c) 2001-2004 Jakub Jermar	2	* Copyright (c) 2001-2004 Jakub Jermar
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 time	29	/** @addtogroup time
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/**	33	/**
34	* @file	34	* @file
35	* @brief Timeout management functions.	35	* @brief Timeout management functions.
36	*/	36	*/
37		37
38	#include <time/timeout.h>	38	#include <time/timeout.h>
39	#include <arch/types.h>	39	#include <arch/types.h>
40	#include <config.h>	40	#include <config.h>
41	#include <panic.h>	41	#include <panic.h>
42	#include <synch/spinlock.h>	42	#include <synch/spinlock.h>
43	#include <func.h>	43	#include <func.h>
44	#include <cpu.h>	44	#include <cpu.h>
45	#include <arch/asm.h>	45	#include <arch/asm.h>
46	#include <arch.h>	46	#include <arch.h>
47		47
48	/** Initialize timeouts	48	/** Initialize timeouts
49	*	49	*
50	* Initialize kernel timeouts.	50	* Initialize kernel timeouts.
51	*	51	*
52	*/	52	*/
53	void timeout_init(void)	53	void timeout_init(void)
54	{	54	{
55	spinlock_initialize(&CPU->timeoutlock, "timeout_lock");	55	spinlock_initialize(&CPU->timeoutlock, "timeout_lock");
56	list_initialize(&CPU->timeout_active_head);	56	list_initialize(&CPU->timeout_active_head);
57	}	57	}
58		58
59		59
60	/** Reinitialize timeout	60	/** Reinitialize timeout
61	*	61	*
62	* Initialize all members except the lock.	62	* Initialize all members except the lock.
63	*	63	*
64	* @param t Timeout to be initialized.	64	* @param t Timeout to be initialized.
65	*	65	*
66	*/	66	*/
67	void timeout_reinitialize(timeout_t *t)	67	void timeout_reinitialize(timeout_t *t)
68	{	68	{
69	t->cpu = NULL;	69	t->cpu = NULL;
70	t->ticks = 0;	70	t->ticks = 0;
71	t->handler = NULL;	71	t->handler = NULL;
72	t->arg = NULL;	72	t->arg = NULL;
73	link_initialize(&t->link);	73	link_initialize(&t->link);
74	}	74	}
75		75
76		76
77	/** Initialize timeout	77	/** Initialize timeout
78	*	78	*
79	* Initialize all members including the lock.	79	* Initialize all members including the lock.
80	*	80	*
81	* @param t Timeout to be initialized.	81	* @param t Timeout to be initialized.
82	*	82	*
83	*/	83	*/
84	void timeout_initialize(timeout_t *t)	84	void timeout_initialize(timeout_t *t)
85	{	85	{
86	spinlock_initialize(&t->lock, "timeout_t_lock");	86	spinlock_initialize(&t->lock, "timeout_t_lock");
87	timeout_reinitialize(t);	87	timeout_reinitialize(t);
88	}	88	}
89		89
90		90
91	/** Register timeout	91	/** Register timeout
92	*	92	*
93	* Insert timeout handler f (with argument arg)	93	* Insert timeout handler f (with argument arg)
94	* to timeout list and make it execute in	94	* to timeout list and make it execute in
95	* time microseconds (or slightly more).	95	* time microseconds (or slightly more).
96	*	96	*
97	* @param t Timeout structure.	97	* @param t Timeout structure.
98	* @param time Number of usec in the future to execute the handler.	98	* @param time Number of usec in the future to execute the handler.
99	* @param f Timeout handler function.	99	* @param f Timeout handler function.
100	* @param arg Timeout handler argument.	100	* @param arg Timeout handler argument.
101	*	101	*
102	*/	102	*/
103	void	103	void
104	timeout_register(timeout_t t, uint64_t time, timeout_handler_t f, void arg)	104	timeout_register(timeout_t t, uint64_t time, timeout_handler_t f, void arg)
105	{	105	{
106	timeout_t *hlp = NULL;	106	timeout_t *hlp = NULL;
107	link_t l, m;	107	link_t l, m;
108	ipl_t ipl;	108	ipl_t ipl;
109	uint64_t sum;	109	uint64_t sum;
110		110
111	ipl = interrupts_disable();	111	ipl = interrupts_disable();
112	spinlock_lock(&CPU->timeoutlock);	112	spinlock_lock(&CPU->timeoutlock);
113	spinlock_lock(&t->lock);	113	spinlock_lock(&t->lock);
114		114
115	if (t->cpu)	115	if (t->cpu)
116	panic("t->cpu != 0");	116	panic("Unexpected: t->cpu != 0.");
117		117
118	t->cpu = CPU;	118	t->cpu = CPU;
119	t->ticks = us2ticks(time);	119	t->ticks = us2ticks(time);
120		120
121	t->handler = f;	121	t->handler = f;
122	t->arg = arg;	122	t->arg = arg;
123		123
124	/*	124	/*
125	* Insert t into the active timeouts list according to t->ticks.	125	* Insert t into the active timeouts list according to t->ticks.
126	*/	126	*/
127	sum = 0;	127	sum = 0;
128	l = CPU->timeout_active_head.next;	128	l = CPU->timeout_active_head.next;
129	while (l != &CPU->timeout_active_head) {	129	while (l != &CPU->timeout_active_head) {
130	hlp = list_get_instance(l, timeout_t, link);	130	hlp = list_get_instance(l, timeout_t, link);
131	spinlock_lock(&hlp->lock);	131	spinlock_lock(&hlp->lock);
132	if (t->ticks < sum + hlp->ticks) {	132	if (t->ticks < sum + hlp->ticks) {
133	spinlock_unlock(&hlp->lock);	133	spinlock_unlock(&hlp->lock);
134	break;	134	break;
135	}	135	}
136	sum += hlp->ticks;	136	sum += hlp->ticks;
137	spinlock_unlock(&hlp->lock);	137	spinlock_unlock(&hlp->lock);
138	l = l->next;	138	l = l->next;
139	}	139	}
140		140
141	m = l->prev;	141	m = l->prev;
142	list_prepend(&t->link, m); /* avoid using l->prev */	142	list_prepend(&t->link, m); /* avoid using l->prev */
143		143
144	/*	144	/*
145	* Adjust t->ticks according to ticks accumulated in h's predecessors.	145	* Adjust t->ticks according to ticks accumulated in h's predecessors.
146	*/	146	*/
147	t->ticks -= sum;	147	t->ticks -= sum;
148		148
149	/*	149	/*
150	* Decrease ticks of t's immediate succesor by t->ticks.	150	* Decrease ticks of t's immediate succesor by t->ticks.
151	*/	151	*/
152	if (l != &CPU->timeout_active_head) {	152	if (l != &CPU->timeout_active_head) {
153	spinlock_lock(&hlp->lock);	153	spinlock_lock(&hlp->lock);
154	hlp->ticks -= t->ticks;	154	hlp->ticks -= t->ticks;
155	spinlock_unlock(&hlp->lock);	155	spinlock_unlock(&hlp->lock);
156	}	156	}
157		157
158	spinlock_unlock(&t->lock);	158	spinlock_unlock(&t->lock);
159	spinlock_unlock(&CPU->timeoutlock);	159	spinlock_unlock(&CPU->timeoutlock);
160	interrupts_restore(ipl);	160	interrupts_restore(ipl);
161	}	161	}
162		162
163		163
164	/** Unregister timeout	164	/** Unregister timeout
165	*	165	*
166	* Remove timeout from timeout list.	166	* Remove timeout from timeout list.
167	*	167	*
168	* @param t Timeout to unregister.	168	* @param t Timeout to unregister.
169	*	169	*
170	* @return True on success, false on failure.	170	* @return True on success, false on failure.
171	*/	171	*/
172	bool timeout_unregister(timeout_t *t)	172	bool timeout_unregister(timeout_t *t)
173	{	173	{
174	timeout_t *hlp;	174	timeout_t *hlp;
175	link_t *l;	175	link_t *l;
176	ipl_t ipl;	176	ipl_t ipl;
177	DEADLOCK_PROBE_INIT(p_tolock);	177	DEADLOCK_PROBE_INIT(p_tolock);
178		178
179	grab_locks:	179	grab_locks:
180	ipl = interrupts_disable();	180	ipl = interrupts_disable();
181	spinlock_lock(&t->lock);	181	spinlock_lock(&t->lock);
182	if (!t->cpu) {	182	if (!t->cpu) {
183	spinlock_unlock(&t->lock);	183	spinlock_unlock(&t->lock);
184	interrupts_restore(ipl);	184	interrupts_restore(ipl);
185	return false;	185	return false;
186	}	186	}
187	if (!spinlock_trylock(&t->cpu->timeoutlock)) {	187	if (!spinlock_trylock(&t->cpu->timeoutlock)) {
188	spinlock_unlock(&t->lock);	188	spinlock_unlock(&t->lock);
189	interrupts_restore(ipl);	189	interrupts_restore(ipl);
190	DEADLOCK_PROBE(p_tolock, DEADLOCK_THRESHOLD);	190	DEADLOCK_PROBE(p_tolock, DEADLOCK_THRESHOLD);
191	goto grab_locks;	191	goto grab_locks;
192	}	192	}
193		193
194	/*	194	/*
195	* Now we know for sure that t hasn't been activated yet	195	* Now we know for sure that t hasn't been activated yet
196	* and is lurking in t->cpu->timeout_active_head queue.	196	* and is lurking in t->cpu->timeout_active_head queue.
197	*/	197	*/
198		198
199	l = t->link.next;	199	l = t->link.next;
200	if (l != &t->cpu->timeout_active_head) {	200	if (l != &t->cpu->timeout_active_head) {
201	hlp = list_get_instance(l, timeout_t, link);	201	hlp = list_get_instance(l, timeout_t, link);
202	spinlock_lock(&hlp->lock);	202	spinlock_lock(&hlp->lock);
203	hlp->ticks += t->ticks;	203	hlp->ticks += t->ticks;
204	spinlock_unlock(&hlp->lock);	204	spinlock_unlock(&hlp->lock);
205	}	205	}
206		206
207	list_remove(&t->link);	207	list_remove(&t->link);
208	spinlock_unlock(&t->cpu->timeoutlock);	208	spinlock_unlock(&t->cpu->timeoutlock);
209		209
210	timeout_reinitialize(t);	210	timeout_reinitialize(t);
211	spinlock_unlock(&t->lock);	211	spinlock_unlock(&t->lock);
212		212
213	interrupts_restore(ipl);	213	interrupts_restore(ipl);
214	return true;	214	return true;
215	}	215	}
216		216
217	/** @}	217	/** @}
218	*/	218	*/
219		219

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/src/time/timeout.c – Rev 2916 → 3790