⬢ DragonFlyBSD Kernel Audit
sys/sys/callout.h
← back
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 * Copyright (c) 2014,2018,2019 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _SYS_CALLOUT_H_
#define _SYS_CALLOUT_H_

#ifndef _SYS_QUEUE_H_
#include <sys/queue.h>
#endif
#ifndef _SYS_LOCK_H_
#include <sys/lock.h>
#endif
#ifndef _SYS_SPINLOCK_H_
#include <sys/spinlock.h>
#endif
#ifndef _SYS_EXISLOCK_H_
#include <sys/exislock.h>
#endif

struct callout;
struct softclock_pcpu;

struct _callout {
	struct spinlock	spin;		/* typestable spinlock */
	exislock_t	exis;
	TAILQ_ENTRY(_callout) entry;
	struct callout	*verifier;
	uint32_t	flags;
	uint32_t	lineno;
	struct lock	*lk;
	const char	*ident;

	struct softclock_pcpu *rsc;	/* request info */
	void		*rarg;
	void		(*rfunc)(void *);
	int		rtick;
	uint32_t	unused01;

	struct softclock_pcpu *qsc;	/* active info */
	void		*qarg;
	void		(*qfunc)(void *);
	int		qtick;
	int		waiters;
};

struct callout {
	struct _callout *toc;		/* opaque internal pointer */
	struct lock	*lk;		/* callout_init() copy data */
	uint32_t	flags;		/* callout_init() copy data */
	uint32_t	unused01;
};

/*
 * Legacy access/setting of the function and argument.  Used only
 * by netgraph7 and ieee80211_dfs.c.  DO NOT USE FOR NEW CODE!
 */
#define callout_set_arg(cc, _arg)	do {	\
	if ((cc)->toc)				\
		((cc)->toc->qarg = (cc)->toc->rarg = (_arg));	\
} while(0)
#define callout_arg(cc)			((cc)->toc ? (cc)->toc->rarg : NULL)
#define callout_func(cc)		((cc)->toc ? (cc)->toc->rfunc : NULL)

#ifdef _KERNEL

#define CALLOUT_DEBUG
#ifdef CALLOUT_DEBUG
#define CALLOUT_DEBUG_ARGS	, const char *ident, int lineno
#define CALLOUT_DEBUG_PASSTHRU	, ident, lineno
#else
#define CALLOUT_DEBUG_ARGS
#define CALLOUT_DEBUG_PASSTHRU
#endif

struct globaldata;

extern int ncallout;

int	callout_active(struct callout *ext);
int	callout_pending(struct callout *ext);
void	callout_deactivate(struct callout *ext);

void	hardclock_softtick(struct globaldata *);
void	_callout_init (struct callout *cc
			CALLOUT_DEBUG_ARGS);
void	_callout_init_mp (struct callout *cc
			CALLOUT_DEBUG_ARGS);
void	_callout_init_lk (struct callout *cc, struct lock *lk
			CALLOUT_DEBUG_ARGS);

void	_callout_setup_quick(struct callout *cc, struct _callout *c,
			int ticks, void (*)(void *), void *);
void	_callout_cancel_quick(struct _callout *c);

void	callout_reset (struct callout *, int,
			void (*)(void *), void *);
void	callout_reset_bycpu (struct callout *, int,
			void (*)(void *), void *,
			int);
int	callout_stop (struct callout *cc);
int	callout_stop_async (struct callout *cc);
void	callout_terminate (struct callout *cc);
int	callout_cancel (struct callout *cc);
int	callout_drain (struct callout *cc);

#ifdef CALLOUT_DEBUG
#define	callout_init(co)	_callout_init(co, __FILE__, __LINE__)
#define	callout_init_mp(co)	_callout_init_mp(co, __FILE__, __LINE__)
#define	callout_init_lk(co, lk)	_callout_init_lk(co, lk, __FILE__, __LINE__)
#else
#define	callout_init(co)	_callout_init(co)
#define	callout_init_mp(co)	_callout_init_mp(co)
#define	callout_init_lk(co, lk)	_callout_init_lk(co, lk)
#endif

#endif	/* _KERNEL */

#endif	/* _SYS_CALLOUT_H_ */