xref: /freebsd/sys/sys/_callout.h (revision 29363fb446372cb3f10bc98664e9767c53fbb457)
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 
37 #ifndef _SYS__CALLOUT_H
38 #define	_SYS__CALLOUT_H
39 
40 #include <sys/_types.h>
41 #include <sys/queue.h>
42 
43 struct lock_object;
44 
45 LIST_HEAD(callout_list, callout);
46 SLIST_HEAD(callout_slist, callout);
47 TAILQ_HEAD(callout_tailq, callout);
48 
49 typedef void callout_func_t(void *);
50 
51 struct callout {
52 	union {
53 		LIST_ENTRY(callout) le;
54 		SLIST_ENTRY(callout) sle;
55 		TAILQ_ENTRY(callout) tqe;
56 	} c_links;
57 	__sbintime_t c_time;			/* ticks to the event */
58 	__sbintime_t c_precision;		/* delta allowed wrt opt */
59 	void	*c_arg;				/* function argument */
60 	callout_func_t *c_func;			/* function to call */
61 	struct lock_object *c_lock;		/* lock to handle */
62 	short	c_flags;			/* User State */
63 	short	c_iflags;			/* Internal State */
64 	volatile int c_cpu;			/* CPU we're scheduled on */
65 };
66 
67 #endif
68