callout.h revision 248031
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 * 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. 21 * 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 32 * SUCH DAMAGE. 33 * 34 * @(#)callout.h 8.2 (Berkeley) 1/21/94 35 * $FreeBSD: head/sys/sys/callout.h 248031 2013-03-08 10:14:58Z andre $ 36 */ 37 38#ifndef _SYS_CALLOUT_H_ 39#define _SYS_CALLOUT_H_ 40 41#include <sys/_callout.h> 42 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 /* callout handler is mp safe */ 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 */ 52 53#define C_DIRECT_EXEC 0x0001 /* direct execution of callout */ 54#define C_PRELBITS 7 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 61struct callout_handle { 62 struct callout *callout; 63}; 64 65#ifdef _KERNEL 66#define callout_active(c) ((c)->c_flags & CALLOUT_ACTIVE) 67#define callout_deactivate(c) ((c)->c_flags &= ~CALLOUT_ACTIVE) 68#define callout_drain(c) _callout_stop_safe(c, 1) 69void callout_init(struct callout *, int); 70void _callout_init_lock(struct callout *, struct lock_object *, int); 71#define callout_init_mtx(c, mtx, flags) \ 72 _callout_init_lock((c), ((mtx) != NULL) ? &(mtx)->lock_object : \ 73 NULL, (flags)) 74#define callout_init_rw(c, rw, flags) \ 75 _callout_init_lock((c), ((rw) != NULL) ? &(rw)->lock_object : \ 76 NULL, (flags)) 77#define callout_pending(c) ((c)->c_flags & CALLOUT_PENDING) 78int callout_reset_sbt_on(struct callout *, sbintime_t, sbintime_t, 79 void (*)(void *), void *, int, int); 80#define callout_reset_sbt(c, sbt, pr, fn, arg, flags) \ 81 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), (c)->c_cpu, flags) 82#define callout_reset_sbt_curcpu(c, sbt, pr, fn, arg, flags) \ 83 callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), PCPU_GET(cpuid), flags) 84#define callout_reset_on(c, to_ticks, fn, arg, cpu) \ 85 callout_reset_sbt_on((c), (tick_sbt * (to_ticks)), 0, (fn), (arg), \ 86 (cpu), C_HARDCLOCK) 87#define callout_reset(c, on_tick, fn, arg) \ 88 callout_reset_on((c), (on_tick), (fn), (arg), (c)->c_cpu) 89#define callout_reset_curcpu(c, on_tick, fn, arg) \ 90 callout_reset_on((c), (on_tick), (fn), (arg), PCPU_GET(cpuid)) 91int callout_schedule(struct callout *, int); 92int callout_schedule_on(struct callout *, int, int); 93#define callout_schedule_curcpu(c, on_tick) \ 94 callout_schedule_on((c), (on_tick), PCPU_GET(cpuid)) 95#define callout_stop(c) _callout_stop_safe(c, 0) 96int _callout_stop_safe(struct callout *, int); 97void callout_process(sbintime_t now); 98 99#endif 100 101#endif /* _SYS_CALLOUT_H_ */ 102