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.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)callout.h 8.2 (Berkeley) 1/21/94
38 #ifndef _SYS_CALLOUT_H_
39 #define _SYS_CALLOUT_H_
41 #include <sys/_callout.h>
43 #define CALLOUT_LOCAL_ALLOC 0x0001 /* was allocated from callfree */
44 #define CALLOUT_ACTIVE 0x0002 /* callout is currently active */
45 #define CALLOUT_PENDING 0x0004 /* callout is waiting for timeout */
46 #define CALLOUT_MPSAFE 0x0008 /* deprecated */
47 #define CALLOUT_RETURNUNLOCKED 0x0010 /* handler returns with mtx unlocked */
48 #define CALLOUT_SHAREDLOCK 0x0020 /* callout lock held in shared mode */
49 #define CALLOUT_DFRMIGRATION 0x0040 /* callout in deferred migration mode */
50 #define CALLOUT_PROCESSED 0x0080 /* callout in wheel or processing list? */
51 #define CALLOUT_DIRECT 0x0100 /* allow exec from hw int context */
53 #define C_DIRECT_EXEC 0x0001 /* direct execution of callout */
55 #define C_PRELRANGE ((1 << C_PRELBITS) - 1)
56 #define C_PREL(x) (((x) + 1) << 1)
57 #define C_PRELGET(x) (int)((((x) >> 1) & C_PRELRANGE) - 1)
58 #define C_HARDCLOCK 0x0100 /* align to hardclock() calls */
59 #define C_ABSOLUTE 0x0200 /* event time is absolute. */
60 #define C_PRECALC 0x0400 /* event time is pre-calculated. */
62 struct callout_handle {
63 struct callout *callout;
66 /* Flags for callout_stop_safe() */
67 #define CS_DRAIN 0x0001 /* callout_drain(), wait allowed */
68 #define CS_MIGRBLOCK 0x0002 /* Block migration, return value
69 indicates that the callout was
74 * Note the flags field is actually *two* fields. The c_flags
75 * field is the one that caller operations that may, or may not have
76 * a lock touches i.e. callout_deactivate(). The other, the c_iflags,
77 * is the internal flags that *must* be kept correct on which the
78 * callout system depend on e.g. callout_pending().
79 * The c_iflag is used internally by the callout system to determine which
80 * list the callout is on and track internal state. Callers *should not*
81 * use the c_flags field directly but should use the macros provided.
83 * The c_iflags field holds internal flags that are protected by internal
84 * locks of the callout subsystem. The c_flags field holds external flags.
85 * The caller must hold its own lock while manipulating or reading external
86 * flags via callout_active(), callout_deactivate(), callout_reset*(), or
87 * callout_stop() to avoid races.
89 #define callout_active(c) ((c)->c_flags & CALLOUT_ACTIVE)
90 #define callout_deactivate(c) ((c)->c_flags &= ~CALLOUT_ACTIVE)
91 #define callout_drain(c) _callout_stop_safe(c, CS_DRAIN)
92 void callout_init(struct callout *, int);
93 void _callout_init_lock(struct callout *, struct lock_object *, int);
94 #define callout_init_mtx(c, mtx, flags) \
95 _callout_init_lock((c), ((mtx) != NULL) ? &(mtx)->lock_object : \
97 #define callout_init_rm(c, rm, flags) \
98 _callout_init_lock((c), ((rm) != NULL) ? &(rm)->lock_object : \
100 #define callout_init_rw(c, rw, flags) \
101 _callout_init_lock((c), ((rw) != NULL) ? &(rw)->lock_object : \
103 #define callout_pending(c) ((c)->c_iflags & CALLOUT_PENDING)
104 int callout_reset_sbt_on(struct callout *, sbintime_t, sbintime_t,
105 void (*)(void *), void *, int, int);
106 #define callout_reset_sbt(c, sbt, pr, fn, arg, flags) \
107 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), -1, (flags))
108 #define callout_reset_sbt_curcpu(c, sbt, pr, fn, arg, flags) \
109 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), PCPU_GET(cpuid),\
111 #define callout_reset_on(c, to_ticks, fn, arg, cpu) \
112 callout_reset_sbt_on((c), tick_sbt * (to_ticks), 0, (fn), (arg), \
114 #define callout_reset(c, on_tick, fn, arg) \
115 callout_reset_on((c), (on_tick), (fn), (arg), -1)
116 #define callout_reset_curcpu(c, on_tick, fn, arg) \
117 callout_reset_on((c), (on_tick), (fn), (arg), PCPU_GET(cpuid))
118 #define callout_schedule_sbt_on(c, sbt, pr, cpu, flags) \
119 callout_reset_sbt_on((c), (sbt), (pr), (c)->c_func, (c)->c_arg, \
121 #define callout_schedule_sbt(c, sbt, pr, flags) \
122 callout_schedule_sbt_on((c), (sbt), (pr), -1, (flags))
123 #define callout_schedule_sbt_curcpu(c, sbt, pr, flags) \
124 callout_schedule_sbt_on((c), (sbt), (pr), PCPU_GET(cpuid), (flags))
125 int callout_schedule(struct callout *, int);
126 int callout_schedule_on(struct callout *, int, int);
127 #define callout_schedule_curcpu(c, on_tick) \
128 callout_schedule_on((c), (on_tick), PCPU_GET(cpuid))
129 #define callout_stop(c) _callout_stop_safe(c, 0)
130 int _callout_stop_safe(struct callout *, int);
131 void callout_process(sbintime_t now);
133 void callout_when(sbintime_t sbt, sbintime_t precision, int flags,
134 sbintime_t *sbt_res, sbintime_t *prec_res);
137 #endif /* _SYS_CALLOUT_H_ */