WebSVN – HelenOS-historic – Diff – /kernel/trunk/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 <typedefs.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("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;
 
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);       
        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 1757	Rev 1780
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 <typedefs.h>	39	#include <typedefs.h>
40	#include <arch/types.h>	40	#include <arch/types.h>
41	#include <config.h>	41	#include <config.h>
42	#include <panic.h>	42	#include <panic.h>
43	#include <synch/spinlock.h>	43	#include <synch/spinlock.h>
44	#include <func.h>	44	#include <func.h>
45	#include <cpu.h>	45	#include <cpu.h>
46	#include <arch/asm.h>	46	#include <arch/asm.h>
47	#include <arch.h>	47	#include <arch.h>
48		48
49		49
50	/** Initialize timeouts	50	/** Initialize timeouts
51	*	51	*
52	* Initialize kernel timeouts.	52	* Initialize kernel timeouts.
53	*	53	*
54	*/	54	*/
55	void timeout_init(void)	55	void timeout_init(void)
56	{	56	{
57	spinlock_initialize(&CPU->timeoutlock, "timeout_lock");	57	spinlock_initialize(&CPU->timeoutlock, "timeout_lock");
58	list_initialize(&CPU->timeout_active_head);	58	list_initialize(&CPU->timeout_active_head);
59	}	59	}
60		60
61		61
62	/** Reinitialize timeout	62	/** Reinitialize timeout
63	*	63	*
64	* Initialize all members except the lock.	64	* Initialize all members except the lock.
65	*	65	*
66	* @param t Timeout to be initialized.	66	* @param t Timeout to be initialized.
67	*	67	*
68	*/	68	*/
69	void timeout_reinitialize(timeout_t *t)	69	void timeout_reinitialize(timeout_t *t)
70	{	70	{
71	t->cpu = NULL;	71	t->cpu = NULL;
72	t->ticks = 0;	72	t->ticks = 0;
73	t->handler = NULL;	73	t->handler = NULL;
74	t->arg = NULL;	74	t->arg = NULL;
75	link_initialize(&t->link);	75	link_initialize(&t->link);
76	}	76	}
77		77
78		78
79	/** Initialize timeout	79	/** Initialize timeout
80	*	80	*
81	* Initialize all members including the lock.	81	* Initialize all members including the lock.
82	*	82	*
83	* @param t Timeout to be initialized.	83	* @param t Timeout to be initialized.
84	*	84	*
85	*/	85	*/
86	void timeout_initialize(timeout_t *t)	86	void timeout_initialize(timeout_t *t)
87	{	87	{
88	spinlock_initialize(&t->lock, "timeout_t_lock");	88	spinlock_initialize(&t->lock, "timeout_t_lock");
89	timeout_reinitialize(t);	89	timeout_reinitialize(t);
90	}	90	}
91		91
92		92
93	/** Register timeout	93	/** Register timeout
94	*	94	*
95	* Insert timeout handler f (with argument arg)	95	* Insert timeout handler f (with argument arg)
96	* to timeout list and make it execute in	96	* to timeout list and make it execute in
97	* time microseconds (or slightly more).	97	* time microseconds (or slightly more).
98	*	98	*
99	* @param t Timeout structure.	99	* @param t Timeout structure.
100	* @param time Number of usec in the future to execute	100	* @param time Number of usec in the future to execute
101	* the handler.	101	* the handler.
102	* @param f Timeout handler function.	102	* @param f Timeout handler function.
103	* @param arg Timeout handler argument.	103	* @param arg Timeout handler argument.
104	*	104	*
105	*/	105	*/
106	void timeout_register(timeout_t t, __u64 time, timeout_handler_t f, void arg)	106	void timeout_register(timeout_t t, uint64_t time, timeout_handler_t f, void arg)
107	{	107	{
108	timeout_t *hlp = NULL;	108	timeout_t *hlp = NULL;
109	link_t l, m;	109	link_t l, m;
110	ipl_t ipl;	110	ipl_t ipl;
111	__u64 sum;	111	uint64_t sum;
112		112
113	ipl = interrupts_disable();	113	ipl = interrupts_disable();
114	spinlock_lock(&CPU->timeoutlock);	114	spinlock_lock(&CPU->timeoutlock);
115	spinlock_lock(&t->lock);	115	spinlock_lock(&t->lock);
116		116
117	if (t->cpu)	117	if (t->cpu)
118	panic("t->cpu != 0");	118	panic("t->cpu != 0");
119		119
120	t->cpu = CPU;	120	t->cpu = CPU;
121	t->ticks = us2ticks(time);	121	t->ticks = us2ticks(time);
122		122
123	t->handler = f;	123	t->handler = f;
124	t->arg = arg;	124	t->arg = arg;
125		125
126	/*	126	/*
127	* Insert t into the active timeouts list according to t->ticks.	127	* Insert t into the active timeouts list according to t->ticks.
128	*/	128	*/
129	sum = 0;	129	sum = 0;
130	l = CPU->timeout_active_head.next;	130	l = CPU->timeout_active_head.next;
131	while (l != &CPU->timeout_active_head) {	131	while (l != &CPU->timeout_active_head) {
132	hlp = list_get_instance(l, timeout_t, link);	132	hlp = list_get_instance(l, timeout_t, link);
133	spinlock_lock(&hlp->lock);	133	spinlock_lock(&hlp->lock);
134	if (t->ticks < sum + hlp->ticks) {	134	if (t->ticks < sum + hlp->ticks) {
135	spinlock_unlock(&hlp->lock);	135	spinlock_unlock(&hlp->lock);
136	break;	136	break;
137	}	137	}
138	sum += hlp->ticks;	138	sum += hlp->ticks;
139	spinlock_unlock(&hlp->lock);	139	spinlock_unlock(&hlp->lock);
140	l = l->next;	140	l = l->next;
141	}	141	}
142		142
143	m = l->prev;	143	m = l->prev;
144	list_prepend(&t->link, m); /* avoid using l->prev */	144	list_prepend(&t->link, m); /* avoid using l->prev */
145		145
146	/*	146	/*
147	* Adjust t->ticks according to ticks accumulated in h's predecessors.	147	* Adjust t->ticks according to ticks accumulated in h's predecessors.
148	*/	148	*/
149	t->ticks -= sum;	149	t->ticks -= sum;
150		150
151	/*	151	/*
152	* Decrease ticks of t's immediate succesor by t->ticks.	152	* Decrease ticks of t's immediate succesor by t->ticks.
153	*/	153	*/
154	if (l != &CPU->timeout_active_head) {	154	if (l != &CPU->timeout_active_head) {
155	spinlock_lock(&hlp->lock);	155	spinlock_lock(&hlp->lock);
156	hlp->ticks -= t->ticks;	156	hlp->ticks -= t->ticks;
157	spinlock_unlock(&hlp->lock);	157	spinlock_unlock(&hlp->lock);
158	}	158	}
159		159
160	spinlock_unlock(&t->lock);	160	spinlock_unlock(&t->lock);
161	spinlock_unlock(&CPU->timeoutlock);	161	spinlock_unlock(&CPU->timeoutlock);
162	interrupts_restore(ipl);	162	interrupts_restore(ipl);
163	}	163	}
164		164
165		165
166	/** Unregister timeout	166	/** Unregister timeout
167	*	167	*
168	* Remove timeout from timeout list.	168	* Remove timeout from timeout list.
169	*	169	*
170	* @param t Timeout to unregister.	170	* @param t Timeout to unregister.
171	*	171	*
172	* @return true on success, false on failure.	172	* @return true on success, false on failure.
173	*/	173	*/
174	bool timeout_unregister(timeout_t *t)	174	bool timeout_unregister(timeout_t *t)
175	{	175	{
176	timeout_t *hlp;	176	timeout_t *hlp;
177	link_t *l;	177	link_t *l;
178	ipl_t ipl;	178	ipl_t ipl;
179		179
180	grab_locks:	180	grab_locks:
181	ipl = interrupts_disable();	181	ipl = interrupts_disable();
182	spinlock_lock(&t->lock);	182	spinlock_lock(&t->lock);
183	if (!t->cpu) {	183	if (!t->cpu) {
184	spinlock_unlock(&t->lock);	184	spinlock_unlock(&t->lock);
185	interrupts_restore(ipl);	185	interrupts_restore(ipl);
186	return false;	186	return false;
187	}	187	}
188	if (!spinlock_trylock(&t->cpu->timeoutlock)) {	188	if (!spinlock_trylock(&t->cpu->timeoutlock)) {
189	spinlock_unlock(&t->lock);	189	spinlock_unlock(&t->lock);
190	interrupts_restore(ipl);	190	interrupts_restore(ipl);
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-historic

(root)/kernel/trunk/generic/src/time/timeout.c – Rev 1757 → 1780