1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * (c) UNIX System Laboratories, Inc. 7 * All or some portions of this file are derived from material licensed 8 * to the University of California by American Telephone and Telegraph 9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10 * the permission of UNIX System Laboratories, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)callout.h 8.2 (Berkeley) 1/21/94 37 * $FreeBSD$ 38 */ 39 40 #ifndef _SYS_CALLOUT_H_ 41 #define _SYS_CALLOUT_H_ 42 43 #include <sys/_callout.h> 44 45 #define CALLOUT_LOCAL_ALLOC 0x0001 /* was allocated from callfree */ 46 #define CALLOUT_ACTIVE 0x0002 /* callout is currently active */ 47 #define CALLOUT_PENDING 0x0004 /* callout is waiting for timeout */ 48 #define CALLOUT_MPSAFE 0x0008 /* deprecated */ 49 #define CALLOUT_RETURNUNLOCKED 0x0010 /* handler returns with mtx unlocked */ 50 #define CALLOUT_SHAREDLOCK 0x0020 /* callout lock held in shared mode */ 51 #define CALLOUT_DFRMIGRATION 0x0040 /* callout in deferred migration mode */ 52 #define CALLOUT_PROCESSED 0x0080 /* callout in wheel or processing list? */ 53 #define CALLOUT_DIRECT 0x0100 /* allow exec from hw int context */ 54 55 #define C_DIRECT_EXEC 0x0001 /* direct execution of callout */ 56 #define C_PRELBITS 7 57 #define C_PRELRANGE ((1 << C_PRELBITS) - 1) 58 #define C_PREL(x) (((x) + 1) << 1) 59 #define C_PRELGET(x) (int)((((x) >> 1) & C_PRELRANGE) - 1) 60 #define C_HARDCLOCK 0x0100 /* align to hardclock() calls */ 61 #define C_ABSOLUTE 0x0200 /* event time is absolute. */ 62 #define C_PRECALC 0x0400 /* event time is pre-calculated. */ 63 #define C_CATCH 0x0800 /* catch signals, used by pause_sbt(9) */ 64 65 struct callout_handle { 66 struct callout *callout; 67 }; 68 69 /* Flags for callout_stop_safe() */ 70 #define CS_DRAIN 0x0001 /* callout_drain(), wait allowed */ 71 #define CS_EXECUTING 0x0002 /* Positive return value indicates that 72 the callout was executing */ 73 74 #ifdef _KERNEL 75 /* 76 * Note the flags field is actually *two* fields. The c_flags 77 * field is the one that caller operations that may, or may not have 78 * a lock touches i.e. callout_deactivate(). The other, the c_iflags, 79 * is the internal flags that *must* be kept correct on which the 80 * callout system depend on e.g. callout_pending(). 81 * The c_iflag is used internally by the callout system to determine which 82 * list the callout is on and track internal state. Callers *should not* 83 * use the c_flags field directly but should use the macros provided. 84 * 85 * The c_iflags field holds internal flags that are protected by internal 86 * locks of the callout subsystem. The c_flags field holds external flags. 87 * The caller must hold its own lock while manipulating or reading external 88 * flags via callout_active(), callout_deactivate(), callout_reset*(), or 89 * callout_stop() to avoid races. 90 */ 91 #define callout_active(c) ((c)->c_flags & CALLOUT_ACTIVE) 92 #define callout_deactivate(c) ((c)->c_flags &= ~CALLOUT_ACTIVE) 93 #define callout_drain(c) _callout_stop_safe(c, CS_DRAIN, NULL) 94 void callout_init(struct callout *, int); 95 void _callout_init_lock(struct callout *, struct lock_object *, int); 96 #define callout_init_mtx(c, mtx, flags) \ 97 _callout_init_lock((c), ((mtx) != NULL) ? &(mtx)->lock_object : \ 98 NULL, (flags)) 99 #define callout_init_rm(c, rm, flags) \ 100 _callout_init_lock((c), ((rm) != NULL) ? &(rm)->lock_object : \ 101 NULL, (flags)) 102 #define callout_init_rw(c, rw, flags) \ 103 _callout_init_lock((c), ((rw) != NULL) ? &(rw)->lock_object : \ 104 NULL, (flags)) 105 #define callout_pending(c) ((c)->c_iflags & CALLOUT_PENDING) 106 int callout_reset_sbt_on(struct callout *, sbintime_t, sbintime_t, 107 void (*)(void *), void *, int, int); 108 #define callout_reset_sbt(c, sbt, pr, fn, arg, flags) \ 109 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), -1, (flags)) 110 #define callout_reset_sbt_curcpu(c, sbt, pr, fn, arg, flags) \ 111 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), PCPU_GET(cpuid),\ 112 (flags)) 113 #define callout_reset_on(c, to_ticks, fn, arg, cpu) \ 114 callout_reset_sbt_on((c), tick_sbt * (to_ticks), 0, (fn), (arg), \ 115 (cpu), C_HARDCLOCK) 116 #define callout_reset(c, on_tick, fn, arg) \ 117 callout_reset_on((c), (on_tick), (fn), (arg), -1) 118 #define callout_reset_curcpu(c, on_tick, fn, arg) \ 119 callout_reset_on((c), (on_tick), (fn), (arg), PCPU_GET(cpuid)) 120 #define callout_schedule_sbt_on(c, sbt, pr, cpu, flags) \ 121 callout_reset_sbt_on((c), (sbt), (pr), (c)->c_func, (c)->c_arg, \ 122 (cpu), (flags)) 123 #define callout_schedule_sbt(c, sbt, pr, flags) \ 124 callout_schedule_sbt_on((c), (sbt), (pr), -1, (flags)) 125 #define callout_schedule_sbt_curcpu(c, sbt, pr, flags) \ 126 callout_schedule_sbt_on((c), (sbt), (pr), PCPU_GET(cpuid), (flags)) 127 int callout_schedule(struct callout *, int); 128 int callout_schedule_on(struct callout *, int, int); 129 #define callout_schedule_curcpu(c, on_tick) \ 130 callout_schedule_on((c), (on_tick), PCPU_GET(cpuid)) 131 #define callout_stop(c) _callout_stop_safe(c, 0, NULL) 132 int _callout_stop_safe(struct callout *, int, void (*)(void *)); 133 void callout_process(sbintime_t now); 134 #define callout_async_drain(c, d) \ 135 _callout_stop_safe(c, 0, d) 136 void callout_when(sbintime_t sbt, sbintime_t precision, int flags, 137 sbintime_t *sbt_res, sbintime_t *prec_res); 138 #endif 139 140 #endif /* _SYS_CALLOUT_H_ */ 141