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: stable/9/sys/sys/callout.h 235220 2012-05-10 10:02:56Z kib $
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 
51 struct callout_handle {
52 	struct callout *callout;
53 };
54 
55 #ifdef _KERNEL
56 extern int ncallout;
57 
58 #define	callout_active(c)	((c)->c_flags & CALLOUT_ACTIVE)
59 #define	callout_deactivate(c)	((c)->c_flags &= ~CALLOUT_ACTIVE)
60 #define	callout_drain(c)	_callout_stop_safe(c, 1)
61 void	callout_init(struct callout *, int);
62 void	_callout_init_lock(struct callout *, struct lock_object *, int);
63 #define	callout_init_mtx(c, mtx, flags)					\
64 	_callout_init_lock((c), ((mtx) != NULL) ? &(mtx)->lock_object :	\
65 	    NULL, (flags))
66 #define	callout_init_rw(c, rw, flags)					\
67 	_callout_init_lock((c), ((rw) != NULL) ? &(rw)->lock_object :	\
68 	   NULL, (flags))
69 #define	callout_pending(c)	((c)->c_flags & CALLOUT_PENDING)
70 int	callout_reset_on(struct callout *, int, void (*)(void *), void *, int);
71 #define	callout_reset(c, on_tick, fn, arg)				\
72     callout_reset_on((c), (on_tick), (fn), (arg), (c)->c_cpu)
73 #define	callout_reset_curcpu(c, on_tick, fn, arg)			\
74     callout_reset_on((c), (on_tick), (fn), (arg), PCPU_GET(cpuid))
75 int	callout_schedule(struct callout *, int);
76 int	callout_schedule_on(struct callout *, int, int);
77 #define	callout_schedule_curcpu(c, on_tick)				\
78     callout_schedule_on((c), (on_tick), PCPU_GET(cpuid))
79 #define	callout_stop(c)		_callout_stop_safe(c, 0)
80 int	_callout_stop_safe(struct callout *, int);
81 void	callout_tick(void);
82 int	callout_tickstofirst(int limit);
83 extern void (*callout_new_inserted)(int cpu, int ticks);
84 
85 #endif
86 
87 #endif /* _SYS_CALLOUT_H_ */
88