module_khelp.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2010 Lawrence Stewart <lstewart@freebsd.org>
5 * Copyright (c) 2010 The FreeBSD Foundation
6 * All rights reserved.
7 *
8 * This software was developed by Lawrence Stewart while studying at the Centre
9 * for Advanced Internet Architectures, Swinburne University of Technology, made
10 * possible in part by grants from the FreeBSD Foundation and Cisco University
11 * Research Program Fund at Community Foundation Silicon Valley.
12 *
13 * Portions of this software were developed at the Centre for Advanced
14 * Internet Architectures, Swinburne University of Technology, Melbourne,
15 * Australia by Lawrence Stewart under sponsorship from the FreeBSD Foundation.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
19 * are met:
20 * 1. Redistributions of source code must retain the above copyright
21 *    notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 *    notice, this list of conditions and the following disclaimer in the
24 *    documentation and/or other materials provided with the distribution.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 * $FreeBSD: stable/11/sys/sys/module_khelp.h 330897 2018-03-14 03:19:51Z eadler $
39 */
40
41#ifndef _SYS_MODULE_KHELP_H_
42#define _SYS_MODULE_KHELP_H_
43
44/* XXXLAS: Needed for uma related typedefs. */
45#include <vm/uma.h>
46
47/* Helper flags. */
48#define	HELPER_NEEDS_OSD	0x0001
49
50struct helper {
51	int (*mod_init) (void);
52	int (*mod_destroy) (void);
53#define	HELPER_NAME_MAXLEN 16
54	char			h_name[HELPER_NAME_MAXLEN];
55	uma_zone_t		h_zone;
56	struct hookinfo		*h_hooks;
57	uint32_t		h_nhooks;
58	uint32_t		h_classes;
59	int32_t			h_id;
60	volatile uint32_t	h_refcount;
61	uint16_t		h_flags;
62	TAILQ_ENTRY(helper)	h_next;
63};
64
65struct khelp_modevent_data {
66	char			name[HELPER_NAME_MAXLEN];
67	struct helper		*helper;
68	struct hookinfo		*hooks;
69	int			nhooks;
70	int			uma_zsize;
71	uma_ctor		umactor;
72	uma_dtor		umadtor;
73};
74
75#define	KHELP_DECLARE_MOD_UMA(hname, hdata, hhooks, version, size, ctor, dtor) \
76	static struct khelp_modevent_data kmd_##hname = {		\
77		.name = #hname,						\
78		.helper = hdata,					\
79		.hooks = hhooks,					\
80		.nhooks = sizeof(hhooks) / sizeof(hhooks[0]),		\
81		.uma_zsize = size,					\
82		.umactor = ctor,					\
83		.umadtor = dtor						\
84	};								\
85	static moduledata_t h_##hname = {				\
86		.name = #hname,						\
87		.evhand = khelp_modevent,				\
88		.priv = &kmd_##hname					\
89	};								\
90	DECLARE_MODULE(hname, h_##hname, SI_SUB_KLD, SI_ORDER_ANY);	\
91	MODULE_VERSION(hname, version)
92
93#define	KHELP_DECLARE_MOD(hname, hdata, hhooks, version)		\
94	KHELP_DECLARE_MOD_UMA(hname, hdata, hhooks, version, 0, NULL, NULL)
95
96int	khelp_modevent(module_t mod, int type, void *data);
97
98#endif /* _SYS_MODULE_KHELP_H_ */
99