callout.h revision 68889 
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: head/sys/sys/callout.h 68889 2000-11-19 06:02:32Z jake $
40 */
41
42#ifndef _SYS_CALLOUT_H_
43#define _SYS_CALLOUT_H_
44
45#include <sys/queue.h>
46
47SLIST_HEAD(callout_list, callout);
48TAILQ_HEAD(callout_tailq, callout);
49
50struct callout {
51	union {
52		SLIST_ENTRY(callout) sle;
53		TAILQ_ENTRY(callout) tqe;
54	} c_links;
55	int	c_time;				/* ticks to the event */
56	void	*c_arg;				/* function argument */
57	void	(*c_func) __P((void *));	/* function to call */
58	int	c_flags;			/* state of this entry */
59};
60
61#define	CALLOUT_LOCAL_ALLOC	0x0001 /* was allocated from callfree */
62#define	CALLOUT_ACTIVE		0x0002 /* callout is currently active */
63#define	CALLOUT_PENDING		0x0004 /* callout is waiting for timeout */
64#define	CALLOUT_MPSAFE		0x0008 /* callout handler is mp safe */
65
66struct callout_handle {
67	struct callout *callout;
68};
69
70#ifdef _KERNEL
71extern struct callout_list callfree;
72extern struct callout *callout;
73extern int	ncallout;
74extern struct callout_tailq *callwheel;
75extern int	callwheelsize, callwheelbits, callwheelmask, softticks;
76extern struct mtx callout_lock;
77
78#define	callout_active(c)	((c)->c_flags & CALLOUT_ACTIVE)
79#define	callout_deactivate(c)	((c)->c_flags &= ~CALLOUT_ACTIVE)
80void	callout_init __P((struct callout *));
81#define	callout_pending(c)	((c)->c_flags & CALLOUT_PENDING)
82void	callout_reset __P((struct callout *, int, void (*)(void *), void *));
83void	callout_stop __P((struct callout *));
84
85#endif
86
87#endif /* _SYS_CALLOUT_H_ */
88