b279a5fede12035b0e49e6db194cb3d19ff76605
[dragonfly.git] / sys / sys / callout.h
1 /*-
2  * Copyright (c) 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)callout.h   8.2 (Berkeley) 1/21/94
39  * $FreeBSD: src/sys/sys/callout.h,v 1.15.2.1 2001/11/13 18:24:52 archie Exp $
40  * $DragonFly: src/sys/sys/callout.h,v 1.5 2004/09/17 09:34:54 dillon Exp $
41  */
42
43 #ifndef _SYS_CALLOUT_H_
44 #define _SYS_CALLOUT_H_
45
46 #include <sys/queue.h>
47
48 SLIST_HEAD(callout_list, callout);
49 TAILQ_HEAD(callout_tailq, callout);
50
51 struct callout {
52         union {
53                 SLIST_ENTRY(callout) sle;
54                 TAILQ_ENTRY(callout) tqe;
55         } c_links;
56         int     c_time;                 /* ticks to the event */
57         void    *c_arg;                 /* function argument */
58         void    (*c_func) (void *);     /* function to call */
59         int     c_flags;                /* state of this entry */
60 #ifdef SMP
61         struct globaldata *c_gd;
62 #else
63         void    *c_gd_reserved;
64 #endif
65 };
66
67 #define CALLOUT_LOCAL_ALLOC     0x0001 /* was allocated from callfree */
68 #define CALLOUT_ACTIVE          0x0002 /* callout is currently active */
69 #define CALLOUT_PENDING         0x0004 /* callout is waiting for timeout */
70 #define CALLOUT_MPSAFE          0x0008 /* callout does not need the BGL */
71 #define CALLOUT_DID_INIT        0x0010 /* safety check */
72 #define CALLOUT_RUNNING         0x0020 /* function execution in progress */
73
74 struct callout_handle {
75         struct callout *callout;
76 };
77
78 /*
79  * WARNING!  These macros may only be used when the state of the callout
80  * structure is stable, meaning from within the callback function or after
81  * the callback function has been called but the timer has not yet been reset.
82  */
83 #define callout_active(c)       ((c)->c_flags & CALLOUT_ACTIVE)
84 #define callout_deactivate(c)   ((c)->c_flags &= ~CALLOUT_ACTIVE)
85 #define callout_pending(c)      ((c)->c_flags & CALLOUT_PENDING)
86
87 #ifdef _KERNEL
88 extern int      ncallout;
89
90 struct globaldata;
91
92 void    hardclock_softtick(struct globaldata *);
93 void    callout_init (struct callout *);
94 void    callout_init_mp (struct callout *);
95 void    callout_reset (struct callout *, int, void (*)(void *), void *);
96 int     callout_stop (struct callout *);
97 void    callout_terminate (struct callout *);
98
99 #endif
100
101 #endif /* _SYS_CALLOUT_H_ */