WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/include/time/timeout.h


/*
 * 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.
 */
 
#ifndef __TIMEOUT_H__
#define __TIMEOUT_H__
 
#include <arch/types.h>
#include <typedefs.h>
#include <synch/spinlock.h>
#include <adt/list.h>
 
#define us2ticks(us)    ((__u64)(((__u32) (us)/(1000000/HZ))))
 
typedef void (* timeout_handler_t)(void *arg);
 
struct timeout {
    SPINLOCK_DECLARE(lock);
 
    link_t link;            /**< Link to the list of active timeouts on THE->cpu */
   
    __u64 ticks;            /**< Timeout will be activated in this amount of clock() ticks. */
 
    timeout_handler_t handler;  /**< Function that will be called on timeout activation. */
    void *arg;          /**< Argument to be passed to handler() function. */
   
    cpu_t *cpu;         /**< On which processor is this timeout registered. */
};
 
extern void timeout_init(void);
extern void timeout_initialize(timeout_t *t);
extern void timeout_reinitialize(timeout_t *t);
extern void timeout_register(timeout_t *t, __u64 usec, timeout_handler_t f, void *arg);
extern bool timeout_unregister(timeout_t *t);
 
#endif
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/time/timeout.h @ 1702 – Rev 623 → 788

Rev 623		Rev 788
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	#ifndef __TIMEOUT_H__	29	#ifndef __TIMEOUT_H__
30	#define __TIMEOUT_H__	30	#define __TIMEOUT_H__
31		31
32	#include <arch/types.h>	32	#include <arch/types.h>
33	#include <typedefs.h>	33	#include <typedefs.h>
34	#include <synch/spinlock.h>	34	#include <synch/spinlock.h>
35	#include <list.h>	35	#include <adt/list.h>
36		36
37	#define us2ticks(us) ((__u64)(((__u32) (us)/(1000000/HZ))))	37	#define us2ticks(us) ((__u64)(((__u32) (us)/(1000000/HZ))))
38		38
39	typedef void (* timeout_handler_t)(void *arg);	39	typedef void (* timeout_handler_t)(void *arg);
40		40
41	struct timeout {	41	struct timeout {
42	SPINLOCK_DECLARE(lock);	42	SPINLOCK_DECLARE(lock);
43		43
44	link_t link; /*< Link to the list of active timeouts on THE->cpu /	44	link_t link; /*< Link to the list of active timeouts on THE->cpu /
45		45
46	__u64 ticks; /*< Timeout will be activated in this amount of clock() ticks. /	46	__u64 ticks; /*< Timeout will be activated in this amount of clock() ticks. /
47		47
48	timeout_handler_t handler; /*< Function that will be called on timeout activation. /	48	timeout_handler_t handler; /*< Function that will be called on timeout activation. /
49	void arg; /< Argument to be passed to handler() function. /	49	void arg; /< Argument to be passed to handler() function. /
50		50
51	cpu_t cpu; /< On which processor is this timeout registered. /	51	cpu_t cpu; /< On which processor is this timeout registered. /
52	};	52	};
53		53
54	extern void timeout_init(void);	54	extern void timeout_init(void);
55	extern void timeout_initialize(timeout_t *t);	55	extern void timeout_initialize(timeout_t *t);
56	extern void timeout_reinitialize(timeout_t *t);	56	extern void timeout_reinitialize(timeout_t *t);
57	extern void timeout_register(timeout_t t, __u64 usec, timeout_handler_t f, void arg);	57	extern void timeout_register(timeout_t t, __u64 usec, timeout_handler_t f, void arg);
58	extern bool timeout_unregister(timeout_t *t);	58	extern bool timeout_unregister(timeout_t *t);
59		59
60	#endif	60	#endif
61		61