xref: /freebsd/sys/sys/sysctl.h (revision 00b6911b7f95bffeff6fdc1843562375d14e9cd8)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Mike Karels at Berkeley Software Design, 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. 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  *	@(#)sysctl.h	8.1 (Berkeley) 6/2/93
35  * $FreeBSD$
36  */
37 
38 #ifndef _SYS_SYSCTL_H_
39 #define	_SYS_SYSCTL_H_
40 
41 #ifdef _KERNEL
42 #include <sys/queue.h>
43 #endif
44 
45 struct thread;
46 /*
47  * Definitions for sysctl call.  The sysctl call uses a hierarchical name
48  * for objects that can be examined or modified.  The name is expressed as
49  * a sequence of integers.  Like a file path name, the meaning of each
50  * component depends on its place in the hierarchy.  The top-level and kern
51  * identifiers are defined here, and other identifiers are defined in the
52  * respective subsystem header files.
53  */
54 
55 #define	CTL_MAXNAME	24	/* largest number of components supported */
56 
57 /*
58  * Each subsystem defined by sysctl defines a list of variables
59  * for that subsystem. Each name is either a node with further
60  * levels defined below it, or it is a leaf of some particular
61  * type given below. Each sysctl level defines a set of name/type
62  * pairs to be used by sysctl(8) in manipulating the subsystem.
63  */
64 struct ctlname {
65 	char	*ctl_name;	/* subsystem name */
66 	int	 ctl_type;	/* type of name */
67 };
68 
69 #define	CTLTYPE		0xf	/* mask for the type */
70 #define	CTLTYPE_NODE	1	/* name is a node */
71 #define	CTLTYPE_INT	2	/* name describes an integer */
72 #define	CTLTYPE_STRING	3	/* name describes a string */
73 #define	CTLTYPE_S64	4	/* name describes a signed 64-bit number */
74 #define	CTLTYPE_OPAQUE	5	/* name describes a structure */
75 #define	CTLTYPE_STRUCT	CTLTYPE_OPAQUE	/* name describes a structure */
76 #define	CTLTYPE_UINT	6	/* name describes an unsigned integer */
77 #define	CTLTYPE_LONG	7	/* name describes a long */
78 #define	CTLTYPE_ULONG	8	/* name describes an unsigned long */
79 #define	CTLTYPE_U64	9	/* name describes an unsigned 64-bit number */
80 #define	CTLTYPE_U8	0xa	/* name describes an unsigned 8-bit number */
81 #define	CTLTYPE_U16	0xb	/* name describes an unsigned 16-bit number */
82 #define	CTLTYPE_S8	0xc	/* name describes a signed 8-bit number */
83 #define	CTLTYPE_S16	0xd	/* name describes a signed 16-bit number */
84 #define	CTLTYPE_S32	0xe	/* name describes a signed 32-bit number */
85 #define	CTLTYPE_U32	0xf	/* name describes an unsigned 32-bit number */
86 
87 #define	CTLFLAG_RD	0x80000000	/* Allow reads of variable */
88 #define	CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
89 #define	CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
90 #define	CTLFLAG_DORMANT	0x20000000	/* This sysctl is not active yet */
91 #define	CTLFLAG_ANYBODY	0x10000000	/* All users can set this var */
92 #define	CTLFLAG_SECURE	0x08000000	/* Permit set only if securelevel<=0 */
93 #define	CTLFLAG_PRISON	0x04000000	/* Prisoned roots can fiddle */
94 #define	CTLFLAG_DYN	0x02000000	/* Dynamic oid - can be freed */
95 #define	CTLFLAG_SKIP	0x01000000	/* Skip this sysctl when listing */
96 #define	CTLMASK_SECURE	0x00F00000	/* Secure level */
97 #define	CTLFLAG_TUN	0x00080000	/* Default value is loaded from getenv() */
98 #define	CTLFLAG_RDTUN	(CTLFLAG_RD|CTLFLAG_TUN)
99 #define	CTLFLAG_RWTUN	(CTLFLAG_RW|CTLFLAG_TUN)
100 #define	CTLFLAG_MPSAFE	0x00040000	/* Handler is MP safe */
101 #define	CTLFLAG_VNET	0x00020000	/* Prisons with vnet can fiddle */
102 #define	CTLFLAG_DYING	0x00010000	/* Oid is being removed */
103 #define	CTLFLAG_CAPRD	0x00008000	/* Can be read in capability mode */
104 #define	CTLFLAG_CAPWR	0x00004000	/* Can be written in capability mode */
105 #define	CTLFLAG_STATS	0x00002000	/* Statistics, not a tuneable */
106 #define	CTLFLAG_NOFETCH	0x00001000	/* Don't fetch tunable from getenv() */
107 #define	CTLFLAG_CAPRW	(CTLFLAG_CAPRD|CTLFLAG_CAPWR)
108 
109 /*
110  * Secure level.   Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
111  *
112  * Secure when the securelevel is raised to at least N.
113  */
114 #define	CTLSHIFT_SECURE	20
115 #define	CTLFLAG_SECURE1	(CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
116 #define	CTLFLAG_SECURE2	(CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
117 #define	CTLFLAG_SECURE3	(CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
118 
119 /*
120  * USE THIS instead of a hardwired number from the categories below
121  * to get dynamically assigned sysctl entries using the linker-set
122  * technology. This is the way nearly all new sysctl variables should
123  * be implemented.
124  * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
125  */
126 #define	OID_AUTO	(-1)
127 
128 /*
129  * The starting number for dynamically-assigned entries.  WARNING!
130  * ALL static sysctl entries should have numbers LESS than this!
131  */
132 #define	CTL_AUTO_START	0x100
133 
134 #ifdef _KERNEL
135 #include <sys/linker_set.h>
136 
137 #ifdef KLD_MODULE
138 /* XXX allow overspecification of type in external kernel modules */
139 #define	SYSCTL_CT_ASSERT_MASK CTLTYPE
140 #else
141 #define	SYSCTL_CT_ASSERT_MASK 0
142 #endif
143 
144 #define	SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1,	\
145 	intmax_t arg2, struct sysctl_req *req
146 
147 /* definitions for sysctl_req 'lock' member */
148 #define	REQ_UNWIRED	1
149 #define	REQ_WIRED	2
150 
151 /* definitions for sysctl_req 'flags' member */
152 #if defined(__aarch64__) || defined(__amd64__) || defined(__powerpc64__) ||\
153     (defined(__mips__) && defined(__mips_n64))
154 #define	SCTL_MASK32	1	/* 32 bit emulation */
155 #endif
156 
157 /*
158  * This describes the access space for a sysctl request.  This is needed
159  * so that we can use the interface from the kernel or from user-space.
160  */
161 struct sysctl_req {
162 	struct thread	*td;		/* used for access checking */
163 	int		 lock;		/* wiring state */
164 	void		*oldptr;
165 	size_t		 oldlen;
166 	size_t		 oldidx;
167 	int		(*oldfunc)(struct sysctl_req *, const void *, size_t);
168 	const void		*newptr;
169 	size_t		 newlen;
170 	size_t		 newidx;
171 	int		(*newfunc)(struct sysctl_req *, void *, size_t);
172 	size_t		 validlen;
173 	int		 flags;
174 };
175 
176 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
177 
178 /*
179  * This describes one "oid" in the MIB tree.  Potentially more nodes can
180  * be hidden behind it, expanded by the handler.
181  */
182 struct sysctl_oid {
183 	struct sysctl_oid_list oid_children;
184 	struct sysctl_oid_list *oid_parent;
185 	SLIST_ENTRY(sysctl_oid) oid_link;
186 	int		 oid_number;
187 	u_int		 oid_kind;
188 	void		*oid_arg1;
189 	intmax_t	 oid_arg2;
190 	const char	*oid_name;
191 	int		(*oid_handler)(SYSCTL_HANDLER_ARGS);
192 	const char	*oid_fmt;
193 	int		 oid_refcnt;
194 	u_int		 oid_running;
195 	const char	*oid_descr;
196 	const char	*oid_label;
197 };
198 
199 #define	SYSCTL_IN(r, p, l)	(r->newfunc)(r, p, l)
200 #define	SYSCTL_OUT(r, p, l)	(r->oldfunc)(r, p, l)
201 #define	SYSCTL_OUT_STR(r, p)	(r->oldfunc)(r, p, strlen(p) + 1)
202 
203 int sysctl_handle_bool(SYSCTL_HANDLER_ARGS);
204 int sysctl_handle_8(SYSCTL_HANDLER_ARGS);
205 int sysctl_handle_16(SYSCTL_HANDLER_ARGS);
206 int sysctl_handle_32(SYSCTL_HANDLER_ARGS);
207 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
208 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
209 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
210 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
211 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
212 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
213 int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
214 int sysctl_handle_counter_u64_array(SYSCTL_HANDLER_ARGS);
215 
216 int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
217 int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
218 
219 int sysctl_msec_to_sbintime(SYSCTL_HANDLER_ARGS);
220 int sysctl_usec_to_sbintime(SYSCTL_HANDLER_ARGS);
221 int sysctl_sec_to_timeval(SYSCTL_HANDLER_ARGS);
222 
223 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
224 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
225 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
226 
227 /*
228  * These functions are used to add/remove an oid from the mib.
229  */
230 void sysctl_register_oid(struct sysctl_oid *oidp);
231 void sysctl_register_disabled_oid(struct sysctl_oid *oidp);
232 void sysctl_enable_oid(struct sysctl_oid *oidp);
233 void sysctl_unregister_oid(struct sysctl_oid *oidp);
234 
235 /* Declare a static oid to allow child oids to be added to it. */
236 #define	SYSCTL_DECL(name)			\
237 	extern struct sysctl_oid sysctl__##name
238 
239 /* Hide these in macros. */
240 #define	SYSCTL_CHILDREN(oid_ptr)		(&(oid_ptr)->oid_children)
241 #define	SYSCTL_PARENT(oid_ptr)					\
242     (((oid_ptr)->oid_parent != &sysctl__children) ?		\
243 	__containerof((oid_ptr)->oid_parent, struct sysctl_oid,	\
244 	oid_children) : (struct sysctl_oid *)NULL)
245 #define	SYSCTL_STATIC_CHILDREN(oid_name)	(&sysctl__##oid_name.oid_children)
246 
247 /* === Structs and macros related to context handling. === */
248 
249 /* All dynamically created sysctls can be tracked in a context list. */
250 struct sysctl_ctx_entry {
251 	struct sysctl_oid *entry;
252 	TAILQ_ENTRY(sysctl_ctx_entry) link;
253 };
254 
255 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
256 
257 #define	SYSCTL_NODE_CHILDREN(parent, name) \
258 	sysctl__##parent##_##name.oid_children
259 
260 #ifndef NO_SYSCTL_DESCR
261 #define	__DESCR(d) d
262 #else
263 #define	__DESCR(d) ""
264 #endif
265 
266 /* This macro is only for internal use */
267 #define	SYSCTL_OID_RAW(id, parent_child_head, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
268 	struct sysctl_oid id = {					\
269 		.oid_parent = (parent_child_head),			\
270 		.oid_children = SLIST_HEAD_INITIALIZER(&id.oid_children), \
271 		.oid_number = (nbr),					\
272 		.oid_kind = (kind),					\
273 		.oid_arg1 = (a1),					\
274 		.oid_arg2 = (a2),					\
275 		.oid_name = (name),					\
276 		.oid_handler = (handler),				\
277 		.oid_fmt = (fmt),					\
278 		.oid_descr = __DESCR(descr),				\
279 		.oid_label = (label),					\
280 	};								\
281 	DATA_SET(sysctl_set, id)
282 
283 /* This constructs a static "raw" MIB oid. */
284 #define	SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
285 	SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2,		\
286 	    handler, fmt, descr, NULL)
287 
288 #define	SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
289     static SYSCTL_OID_RAW(sysctl__##parent##_##name,			\
290 	SYSCTL_CHILDREN(&sysctl__##parent),				\
291 	nbr, #name, kind, a1, a2, handler, fmt, descr, label)
292 
293 /* This constructs a global "raw" MIB oid. */
294 #define	SYSCTL_OID_GLOBAL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
295     SYSCTL_OID_RAW(sysctl__##parent##_##name, \
296 	SYSCTL_CHILDREN(&sysctl__##parent),	\
297 	nbr, #name, kind, a1, a2, handler, fmt, descr, label)
298 
299 #define	SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
300 	sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr), NULL)
301 
302 /* This constructs a root node from which other nodes can hang. */
303 #define	SYSCTL_ROOT_NODE(nbr, name, access, handler, descr)	\
304 	SYSCTL_OID_RAW(sysctl___##name, &sysctl__children,	\
305 	    nbr, #name, CTLTYPE_NODE|(access), NULL, 0,		\
306 	    handler, "N", descr, NULL);				\
307 	CTASSERT(((access) & CTLTYPE) == 0 ||			\
308 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
309 
310 /* This constructs a node from which other oids can hang. */
311 #define	SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
312 	SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, NULL)
313 
314 #define	SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, label) \
315 	SYSCTL_OID_GLOBAL(parent, nbr, name, CTLTYPE_NODE|(access),	\
316 	    NULL, 0, handler, "N", descr, label);			\
317 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
318 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
319 
320 #define	SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)	\
321 	SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, \
322 	    handler, descr, NULL)
323 
324 #define	SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, handler, descr, label) \
325 ({									\
326 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
327 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE);	\
328 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),	\
329 	    NULL, 0, handler, "N", __DESCR(descr), label);		\
330 })
331 
332 #define	SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr)	\
333 ({									\
334 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
335 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE);	\
336 	sysctl_add_oid(ctx, &sysctl__children, nbr, name,		\
337 	    CTLTYPE_NODE|(access),					\
338 	    NULL, 0, handler, "N", __DESCR(descr), NULL);		\
339 })
340 
341 /* Oid for a string.  len can be 0 to indicate '\0' termination. */
342 #define	SYSCTL_STRING(parent, nbr, name, access, arg, len, descr)	\
343 	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access),		\
344 	    arg, len, sysctl_handle_string, "A", descr);		\
345 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
346 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
347 
348 #define	SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
349 ({									\
350 	char *__arg = (arg);						\
351 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
352 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING);	\
353 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),	\
354 	    __arg, len, sysctl_handle_string, "A", __DESCR(descr),	\
355 	    NULL); \
356 })
357 
358 /* Oid for a constant '\0' terminated string. */
359 #define	SYSCTL_CONST_STRING(parent, nbr, name, access, arg, descr)	\
360 	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access),		\
361 	    __DECONST(char *, arg), 0, sysctl_handle_string, "A", descr); \
362 	CTASSERT(!(access & CTLFLAG_WR));				\
363 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
364 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
365 
366 #define	SYSCTL_ADD_CONST_STRING(ctx, parent, nbr, name, access, arg, descr) \
367 ({									\
368 	char *__arg = __DECONST(char *, arg);				\
369 	CTASSERT(!(access & CTLFLAG_WR));				\
370 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
371 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING);	\
372 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),	\
373 	    __arg, 0, sysctl_handle_string, "A", __DESCR(descr),	\
374 	    NULL); \
375 })
376 
377 /* Oid for a bool.  If ptr is NULL, val is returned. */
378 #define	SYSCTL_NULL_BOOL_PTR ((bool *)NULL)
379 #define	SYSCTL_BOOL(parent, nbr, name, access, ptr, val, descr)	\
380 	SYSCTL_OID(parent, nbr, name,				\
381 	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),		\
382 	    ptr, val, sysctl_handle_bool, "CU", descr);		\
383 	CTASSERT(((access) & CTLTYPE) == 0 &&			\
384 	    sizeof(bool) == sizeof(*(ptr)))
385 
386 #define	SYSCTL_ADD_BOOL(ctx, parent, nbr, name, access, ptr, val, descr) \
387 ({									\
388 	bool *__ptr = (ptr);						\
389 	CTASSERT(((access) & CTLTYPE) == 0);				\
390 	sysctl_add_oid(ctx, parent, nbr, name,				\
391 	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),			\
392 	    __ptr, val, sysctl_handle_bool, "CU", __DESCR(descr),	\
393 	    NULL);							\
394 })
395 
396 /* Oid for a signed 8-bit int.  If ptr is NULL, val is returned. */
397 #define	SYSCTL_NULL_S8_PTR ((int8_t *)NULL)
398 #define	SYSCTL_S8(parent, nbr, name, access, ptr, val, descr)	\
399 	SYSCTL_OID(parent, nbr, name,				\
400 	    CTLTYPE_S8 | CTLFLAG_MPSAFE | (access),		\
401 	    ptr, val, sysctl_handle_8, "C", descr);		\
402 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
403 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8) && \
404 	    sizeof(int8_t) == sizeof(*(ptr)))
405 
406 #define	SYSCTL_ADD_S8(ctx, parent, nbr, name, access, ptr, val, descr)	\
407 ({									\
408 	int8_t *__ptr = (ptr);						\
409 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
410 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8);		\
411 	sysctl_add_oid(ctx, parent, nbr, name,				\
412 	    CTLTYPE_S8 | CTLFLAG_MPSAFE | (access),			\
413 	    __ptr, val, sysctl_handle_8, "C", __DESCR(descr), NULL);	\
414 })
415 
416 /* Oid for an unsigned 8-bit int.  If ptr is NULL, val is returned. */
417 #define	SYSCTL_NULL_U8_PTR ((uint8_t *)NULL)
418 #define	SYSCTL_U8(parent, nbr, name, access, ptr, val, descr)	\
419 	SYSCTL_OID(parent, nbr, name,				\
420 	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),		\
421 	    ptr, val, sysctl_handle_8, "CU", descr);		\
422 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
423 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8) && \
424 	    sizeof(uint8_t) == sizeof(*(ptr)))
425 
426 #define	SYSCTL_ADD_U8(ctx, parent, nbr, name, access, ptr, val, descr)	\
427 ({									\
428 	uint8_t *__ptr = (ptr);						\
429 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
430 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8);		\
431 	sysctl_add_oid(ctx, parent, nbr, name,				\
432 	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),			\
433 	    __ptr, val, sysctl_handle_8, "CU", __DESCR(descr), NULL);	\
434 })
435 
436 /* Oid for a signed 16-bit int.  If ptr is NULL, val is returned. */
437 #define	SYSCTL_NULL_S16_PTR ((int16_t *)NULL)
438 #define	SYSCTL_S16(parent, nbr, name, access, ptr, val, descr)	\
439 	SYSCTL_OID(parent, nbr, name,				\
440 	    CTLTYPE_S16 | CTLFLAG_MPSAFE | (access),		\
441 	    ptr, val, sysctl_handle_16, "S", descr);		\
442 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
443 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16) && \
444 	    sizeof(int16_t) == sizeof(*(ptr)))
445 
446 #define	SYSCTL_ADD_S16(ctx, parent, nbr, name, access, ptr, val, descr)	\
447 ({									\
448 	int16_t *__ptr = (ptr);						\
449 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
450 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16);		\
451 	sysctl_add_oid(ctx, parent, nbr, name,				\
452 	    CTLTYPE_S16 | CTLFLAG_MPSAFE | (access),			\
453 	    __ptr, val, sysctl_handle_16, "S", __DESCR(descr), NULL);	\
454 })
455 
456 /* Oid for an unsigned 16-bit int.  If ptr is NULL, val is returned. */
457 #define	SYSCTL_NULL_U16_PTR ((uint16_t *)NULL)
458 #define	SYSCTL_U16(parent, nbr, name, access, ptr, val, descr)	\
459 	SYSCTL_OID(parent, nbr, name,				\
460 	    CTLTYPE_U16 | CTLFLAG_MPSAFE | (access),		\
461 	    ptr, val, sysctl_handle_16, "SU", descr);		\
462 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
463 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16) && \
464 	    sizeof(uint16_t) == sizeof(*(ptr)))
465 
466 #define	SYSCTL_ADD_U16(ctx, parent, nbr, name, access, ptr, val, descr)	\
467 ({									\
468 	uint16_t *__ptr = (ptr);					\
469 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
470 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16);		\
471 	sysctl_add_oid(ctx, parent, nbr, name,				\
472 	    CTLTYPE_U16 | CTLFLAG_MPSAFE | (access),			\
473 	    __ptr, val, sysctl_handle_16, "SU", __DESCR(descr), NULL);	\
474 })
475 
476 /* Oid for a signed 32-bit int.  If ptr is NULL, val is returned. */
477 #define	SYSCTL_NULL_S32_PTR ((int32_t *)NULL)
478 #define	SYSCTL_S32(parent, nbr, name, access, ptr, val, descr)	\
479 	SYSCTL_OID(parent, nbr, name,				\
480 	    CTLTYPE_S32 | CTLFLAG_MPSAFE | (access),		\
481 	    ptr, val, sysctl_handle_32, "I", descr);		\
482 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
483 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32) && \
484 	    sizeof(int32_t) == sizeof(*(ptr)))
485 
486 #define	SYSCTL_ADD_S32(ctx, parent, nbr, name, access, ptr, val, descr)	\
487 ({									\
488 	int32_t *__ptr = (ptr);						\
489 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
490 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32);		\
491 	sysctl_add_oid(ctx, parent, nbr, name,				\
492 	    CTLTYPE_S32 | CTLFLAG_MPSAFE | (access),			\
493 	    __ptr, val, sysctl_handle_32, "I", __DESCR(descr), NULL);	\
494 })
495 
496 /* Oid for an unsigned 32-bit int.  If ptr is NULL, val is returned. */
497 #define	SYSCTL_NULL_U32_PTR ((uint32_t *)NULL)
498 #define	SYSCTL_U32(parent, nbr, name, access, ptr, val, descr)	\
499 	SYSCTL_OID(parent, nbr, name,				\
500 	    CTLTYPE_U32 | CTLFLAG_MPSAFE | (access),		\
501 	    ptr, val, sysctl_handle_32, "IU", descr);		\
502 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
503 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32) && \
504 	    sizeof(uint32_t) == sizeof(*(ptr)))
505 
506 #define	SYSCTL_ADD_U32(ctx, parent, nbr, name, access, ptr, val, descr)	\
507 ({									\
508 	uint32_t *__ptr = (ptr);					\
509 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
510 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32);		\
511 	sysctl_add_oid(ctx, parent, nbr, name,				\
512 	    CTLTYPE_U32 | CTLFLAG_MPSAFE | (access),			\
513 	    __ptr, val, sysctl_handle_32, "IU", __DESCR(descr), NULL);	\
514 })
515 
516 /* Oid for a signed 64-bit int.  If ptr is NULL, val is returned. */
517 #define	SYSCTL_NULL_S64_PTR ((int64_t *)NULL)
518 #define	SYSCTL_S64(parent, nbr, name, access, ptr, val, descr)	\
519 	SYSCTL_OID(parent, nbr, name,				\
520 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),		\
521 	    ptr, val, sysctl_handle_64, "Q", descr);		\
522 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
523 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
524 	    sizeof(int64_t) == sizeof(*(ptr)))
525 
526 #define	SYSCTL_ADD_S64(ctx, parent, nbr, name, access, ptr, val, descr)	\
527 ({									\
528 	int64_t *__ptr = (ptr);						\
529 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
530 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
531 	sysctl_add_oid(ctx, parent, nbr, name,				\
532 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
533 	    __ptr, val, sysctl_handle_64, "Q", __DESCR(descr), NULL);	\
534 })
535 
536 /* Oid for an unsigned 64-bit int.  If ptr is NULL, val is returned. */
537 #define	SYSCTL_NULL_U64_PTR ((uint64_t *)NULL)
538 #define	SYSCTL_U64(parent, nbr, name, access, ptr, val, descr)	\
539 	SYSCTL_OID(parent, nbr, name,				\
540 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),		\
541 	    ptr, val, sysctl_handle_64, "QU", descr);		\
542 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
543 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
544 	    sizeof(uint64_t) == sizeof(*(ptr)))
545 
546 #define	SYSCTL_ADD_U64(ctx, parent, nbr, name, access, ptr, val, descr)	\
547 ({									\
548 	uint64_t *__ptr = (ptr);					\
549 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
550 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
551 	sysctl_add_oid(ctx, parent, nbr, name,				\
552 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
553 	    __ptr, val, sysctl_handle_64, "QU", __DESCR(descr), NULL);	\
554 })
555 
556 /* Oid for an int.  If ptr is SYSCTL_NULL_INT_PTR, val is returned. */
557 #define	SYSCTL_NULL_INT_PTR ((int *)NULL)
558 #define	SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
559 	SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, NULL)
560 
561 #define	SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, label) \
562 	SYSCTL_OID_WITH_LABEL(parent, nbr, name,			\
563 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
564 	    ptr, val, sysctl_handle_int, "I", descr, label);		\
565 	CTASSERT((((access) & CTLTYPE) == 0 ||				\
566 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT) && \
567 	    sizeof(int) == sizeof(*(ptr)))
568 
569 #define	SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr)	\
570 ({									\
571 	int *__ptr = (ptr);						\
572 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
573 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
574 	sysctl_add_oid(ctx, parent, nbr, name,				\
575 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
576 	    __ptr, val, sysctl_handle_int, "I", __DESCR(descr), NULL);	\
577 })
578 
579 /* Oid for an unsigned int.  If ptr is NULL, val is returned. */
580 #define	SYSCTL_NULL_UINT_PTR ((unsigned *)NULL)
581 #define	SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)	\
582 	SYSCTL_OID(parent, nbr, name,				\
583 	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),		\
584 	    ptr, val, sysctl_handle_int, "IU", descr);		\
585 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
586 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT) && \
587 	    sizeof(unsigned) == sizeof(*(ptr)))
588 
589 #define	SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
590 ({									\
591 	unsigned *__ptr = (ptr);					\
592 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
593 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT);	\
594 	sysctl_add_oid(ctx, parent, nbr, name,				\
595 	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),			\
596 	    __ptr, val, sysctl_handle_int, "IU", __DESCR(descr), NULL);	\
597 })
598 
599 /* Oid for a long.  The pointer must be non NULL. */
600 #define	SYSCTL_NULL_LONG_PTR ((long *)NULL)
601 #define	SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)	\
602 	SYSCTL_OID(parent, nbr, name,				\
603 	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),		\
604 	    ptr, val, sysctl_handle_long, "L", descr);		\
605 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
606 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG) && \
607 	    sizeof(long) == sizeof(*(ptr)))
608 
609 #define	SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)	\
610 ({									\
611 	long *__ptr = (ptr);						\
612 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
613 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG);	\
614 	sysctl_add_oid(ctx, parent, nbr, name,				\
615 	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),			\
616 	    __ptr, 0, sysctl_handle_long, "L", __DESCR(descr), NULL);	\
617 })
618 
619 /* Oid for an unsigned long.  The pointer must be non NULL. */
620 #define	SYSCTL_NULL_ULONG_PTR ((unsigned long *)NULL)
621 #define	SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)	\
622 	SYSCTL_OID(parent, nbr, name,					\
623 	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
624 	    ptr, val, sysctl_handle_long, "LU", descr);			\
625 	CTASSERT((((access) & CTLTYPE) == 0 ||				\
626 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG) &&	\
627 	    sizeof(unsigned long) == sizeof(*(ptr)))
628 
629 #define	SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)	\
630 ({									\
631 	unsigned long *__ptr = (ptr);					\
632 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
633 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG);	\
634 	sysctl_add_oid(ctx, parent, nbr, name,				\
635 	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
636 	    __ptr, 0, sysctl_handle_long, "LU", __DESCR(descr), NULL);	\
637 })
638 
639 /* Oid for a quad.  The pointer must be non NULL. */
640 #define	SYSCTL_NULL_QUAD_PTR ((int64_t *)NULL)
641 #define	SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)	\
642 	SYSCTL_OID(parent, nbr, name,				\
643 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),		\
644 	    ptr, val, sysctl_handle_64, "Q", descr);		\
645 	CTASSERT((((access) & CTLTYPE) == 0 ||			\
646 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
647 	    sizeof(int64_t) == sizeof(*(ptr)))
648 
649 #define	SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr)	\
650 ({									\
651 	int64_t *__ptr = (ptr);						\
652 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
653 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
654 	sysctl_add_oid(ctx, parent, nbr, name,				\
655 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
656 	    __ptr, 0, sysctl_handle_64, "Q", __DESCR(descr), NULL);	\
657 })
658 
659 #define	SYSCTL_NULL_UQUAD_PTR ((uint64_t *)NULL)
660 #define	SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)	\
661 	SYSCTL_OID(parent, nbr, name,					\
662 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
663 	     ptr, val, sysctl_handle_64, "QU", descr);			\
664 	CTASSERT((((access) & CTLTYPE) == 0 ||				\
665 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) &&	\
666 	    sizeof(uint64_t) == sizeof(*(ptr)))
667 
668 #define	SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr)	\
669 ({									\
670 	uint64_t *__ptr = (ptr);					\
671 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
672 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
673 	sysctl_add_oid(ctx, parent, nbr, name,				\
674 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
675 	    __ptr, 0, sysctl_handle_64, "QU", __DESCR(descr), NULL);	\
676 })
677 
678 /* Oid for a CPU dependent variable */
679 #define	SYSCTL_ADD_UAUTO(ctx, parent, nbr, name, access, ptr, descr)	\
680 ({									\
681 	struct sysctl_oid *__ret;					\
682 	CTASSERT((sizeof(uint64_t) == sizeof(*(ptr)) ||			\
683 	    sizeof(unsigned) == sizeof(*(ptr))) &&			\
684 	    ((access) & CTLTYPE) == 0);					\
685 	if (sizeof(uint64_t) == sizeof(*(ptr))) {			\
686 		__ret = sysctl_add_oid(ctx, parent, nbr, name,		\
687 		    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),		\
688 		    (ptr), 0, sysctl_handle_64, "QU",			\
689 		    __DESCR(descr), NULL);				\
690 	} else {							\
691 		__ret = sysctl_add_oid(ctx, parent, nbr, name,		\
692 		    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),		\
693 		    (ptr), 0, sysctl_handle_int, "IU",			\
694 		    __DESCR(descr), NULL);				\
695 	}								\
696 	__ret;								\
697 })
698 
699 /* Oid for a 64-bit unsigned counter(9).  The pointer must be non NULL. */
700 #define	SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr)	\
701 	SYSCTL_OID(parent, nbr, name,					\
702 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access),	\
703 	    (ptr), 0, sysctl_handle_counter_u64, "QU", descr);		\
704 	CTASSERT((((access) & CTLTYPE) == 0 ||				\
705 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) &&	\
706 	    sizeof(counter_u64_t) == sizeof(*(ptr)) &&			\
707 	    sizeof(uint64_t) == sizeof(**(ptr)))
708 
709 #define	SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr) \
710 ({									\
711 	counter_u64_t *__ptr = (ptr);					\
712 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
713 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
714 	sysctl_add_oid(ctx, parent, nbr, name,				\
715 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access),	\
716 	    __ptr, 0, sysctl_handle_counter_u64, "QU", __DESCR(descr),	\
717 	    NULL);							\
718 })
719 
720 /* Oid for an array of counter(9)s.  The pointer and length must be non zero. */
721 #define	SYSCTL_COUNTER_U64_ARRAY(parent, nbr, name, access, ptr, len, descr) \
722 	SYSCTL_OID(parent, nbr, name,					\
723 	    CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access),	\
724 	    (ptr), (len), sysctl_handle_counter_u64_array, "S", descr);	\
725 	CTASSERT((((access) & CTLTYPE) == 0 ||				\
726 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE) &&	\
727 	    sizeof(counter_u64_t) == sizeof(*(ptr)) &&			\
728 	    sizeof(uint64_t) == sizeof(**(ptr)))
729 
730 #define	SYSCTL_ADD_COUNTER_U64_ARRAY(ctx, parent, nbr, name, access,	\
731     ptr, len, descr)							\
732 ({									\
733 	counter_u64_t *__ptr = (ptr);					\
734 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
735 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
736 	sysctl_add_oid(ctx, parent, nbr, name,				\
737 	    CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access),	\
738 	    __ptr, len, sysctl_handle_counter_u64_array, "S",		\
739 	    __DESCR(descr), NULL);					\
740 })
741 
742 /* Oid for an opaque object.  Specified by a pointer and a length. */
743 #define	SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)	\
744 	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
745 	    ptr, len, sysctl_handle_opaque, fmt, descr);		\
746 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
747 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
748 
749 #define	SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)	\
750 ({									\
751 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
752 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
753 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
754 	    ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr), NULL);	\
755 })
756 
757 /* Oid for a struct.  Specified by a pointer and a type. */
758 #define	SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)	\
759 	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
760 	    ptr, sizeof(struct type), sysctl_handle_opaque,		\
761 	    "S," #type, descr);						\
762 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
763 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
764 
765 #define	SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
766 ({									\
767 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
768 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
769 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
770 	    (ptr), sizeof(struct type),					\
771 	    sysctl_handle_opaque, "S," #type, __DESCR(descr), NULL);	\
772 })
773 
774 /* Oid for a procedure.  Specified by a pointer and an arg. */
775 #define	SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
776 	SYSCTL_OID(parent, nbr, name, (access),				\
777 	    ptr, arg, handler, fmt, descr);				\
778 	CTASSERT(((access) & CTLTYPE) != 0)
779 
780 #define	SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
781 ({									\
782 	CTASSERT(((access) & CTLTYPE) != 0);				\
783 	sysctl_add_oid(ctx, parent, nbr, name, (access),		\
784 	    (ptr), (arg), (handler), (fmt), __DESCR(descr), NULL);	\
785 })
786 
787 /* Oid to handle limits on uma(9) zone specified by pointer. */
788 #define	SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr)	\
789 	SYSCTL_OID(parent, nbr, name,				\
790 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),		\
791 	    (ptr), 0, sysctl_handle_uma_zone_max, "I", descr);	\
792 	CTASSERT(((access) & CTLTYPE) == 0 ||			\
793 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
794 
795 #define	SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr)	\
796 ({									\
797 	uma_zone_t __ptr = (ptr);					\
798 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
799 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
800 	sysctl_add_oid(ctx, parent, nbr, name,				\
801 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
802 	    __ptr, 0, sysctl_handle_uma_zone_max, "I", __DESCR(descr),	\
803 	    NULL);							\
804 })
805 
806 /* Oid to obtain current use of uma(9) zone specified by pointer. */
807 #define	SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr)		\
808 	SYSCTL_OID(parent, nbr, name,					\
809 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
810 	    (ptr), 0, sysctl_handle_uma_zone_cur, "I", descr);		\
811 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
812 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
813 
814 #define	SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr)	\
815 ({									\
816 	uma_zone_t __ptr = (ptr);					\
817 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
818 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
819 	sysctl_add_oid(ctx, parent, nbr, name,				\
820 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
821 	    __ptr, 0, sysctl_handle_uma_zone_cur, "I", __DESCR(descr),	\
822 	    NULL);							\
823 })
824 
825 /* OID expressing a sbintime_t as microseconds */
826 #define	SYSCTL_SBINTIME_USEC(parent, nbr, name, access, ptr, descr)	\
827 	SYSCTL_OID(parent, nbr, name,					\
828 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
829 	    (ptr), 0, sysctl_usec_to_sbintime, "Q", descr);		\
830 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
831 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
832 #define	SYSCTL_ADD_SBINTIME_USEC(ctx, parent, nbr, name, access, ptr, descr) \
833 ({									\
834 	sbintime_t *__ptr = (ptr);					\
835 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
836 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
837 	sysctl_add_oid(ctx, parent, nbr, name,				\
838 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
839 	    __ptr, 0, sysctl_usec_to_sbintime, "Q", __DESCR(descr),	\
840 	    NULL);							\
841 })
842 
843 /* OID expressing a sbintime_t as milliseconds */
844 #define	SYSCTL_SBINTIME_MSEC(parent, nbr, name, access, ptr, descr)	\
845 	SYSCTL_OID(parent, nbr, name,					\
846 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
847 	    (ptr), 0, sysctl_msec_to_sbintime, "Q", descr);		\
848 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
849 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
850 #define	SYSCTL_ADD_SBINTIME_MSEC(ctx, parent, nbr, name, access, ptr, descr) \
851 ({									\
852 	sbintime_t *__ptr = (ptr);					\
853 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
854 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
855 	sysctl_add_oid(ctx, parent, nbr, name,				\
856 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
857 	    __ptr, 0, sysctl_msec_to_sbintime, "Q", __DESCR(descr),	\
858 	    NULL);							\
859 })
860 
861 /* OID expressing a struct timeval as seconds */
862 #define	SYSCTL_TIMEVAL_SEC(parent, nbr, name, access, ptr, descr)	\
863 	SYSCTL_OID(parent, nbr, name,					\
864 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
865 	    (ptr), 0, sysctl_sec_to_timeval, "I", descr);		\
866 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
867 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
868 #define	SYSCTL_ADD_TIMEVAL_SEC(ctx, parent, nbr, name, access, ptr, descr) \
869 ({									\
870 	struct timeval *__ptr = (ptr);					\
871 	CTASSERT(((access) & CTLTYPE) == 0 ||				\
872 	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
873 	sysctl_add_oid(ctx, parent, nbr, name,				\
874 	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
875 	    __ptr, 0, sysctl_sec_to_timeval, "I", __DESCR(descr),	\
876 	    NULL);							\
877 })
878 
879 /*
880  * A macro to generate a read-only sysctl to indicate the presence of optional
881  * kernel features.
882  */
883 #define	FEATURE(name, desc)						\
884 	SYSCTL_INT_WITH_LABEL(_kern_features, OID_AUTO, name,		\
885 	    CTLFLAG_RD | CTLFLAG_CAPRD, SYSCTL_NULL_INT_PTR, 1, desc, "feature")
886 
887 #endif /* _KERNEL */
888 
889 /*
890  * Top-level identifiers
891  */
892 #define	CTL_SYSCTL	0		/* "magic" numbers */
893 #define	CTL_KERN	1		/* "high kernel": proc, limits */
894 #define	CTL_VM		2		/* virtual memory */
895 #define	CTL_VFS		3		/* filesystem, mount type is next */
896 #define	CTL_NET		4		/* network, see socket.h */
897 #define	CTL_DEBUG	5		/* debugging parameters */
898 #define	CTL_HW		6		/* generic cpu/io */
899 #define	CTL_MACHDEP	7		/* machine dependent */
900 #define	CTL_USER	8		/* user-level */
901 #define	CTL_P1003_1B	9		/* POSIX 1003.1B */
902 
903 /*
904  * CTL_SYSCTL identifiers
905  */
906 #define	CTL_SYSCTL_DEBUG	0	/* printf all nodes */
907 #define	CTL_SYSCTL_NAME		1	/* string name of OID */
908 #define	CTL_SYSCTL_NEXT		2	/* next OID */
909 #define	CTL_SYSCTL_NAME2OID	3	/* int array of name */
910 #define	CTL_SYSCTL_OIDFMT	4	/* OID's kind and format */
911 #define	CTL_SYSCTL_OIDDESCR	5	/* OID's description */
912 #define	CTL_SYSCTL_OIDLABEL	6	/* aggregation label */
913 
914 /*
915  * CTL_KERN identifiers
916  */
917 #define	KERN_OSTYPE		 1	/* string: system version */
918 #define	KERN_OSRELEASE		 2	/* string: system release */
919 #define	KERN_OSREV		 3	/* int: system revision */
920 #define	KERN_VERSION		 4	/* string: compile time info */
921 #define	KERN_MAXVNODES		 5	/* int: max vnodes */
922 #define	KERN_MAXPROC		 6	/* int: max processes */
923 #define	KERN_MAXFILES		 7	/* int: max open files */
924 #define	KERN_ARGMAX		 8	/* int: max arguments to exec */
925 #define	KERN_SECURELVL		 9	/* int: system security level */
926 #define	KERN_HOSTNAME		10	/* string: hostname */
927 #define	KERN_HOSTID		11	/* int: host identifier */
928 #define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
929 #define	KERN_VNODE		13	/* struct: vnode structures */
930 #define	KERN_PROC		14	/* struct: process entries */
931 #define	KERN_FILE		15	/* struct: file entries */
932 #define	KERN_PROF		16	/* node: kernel profiling info */
933 #define	KERN_POSIX1		17	/* int: POSIX.1 version */
934 #define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
935 #define	KERN_JOB_CONTROL	19	/* int: is job control available */
936 #define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
937 #define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
938 #define	KERN_NISDOMAINNAME	22	/* string: YP domain name */
939 #define	KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
940 #define	KERN_OSRELDATE		24	/* int: kernel release date */
941 #define	KERN_NTP_PLL		25	/* node: NTP PLL control */
942 #define	KERN_BOOTFILE		26	/* string: name of booted kernel */
943 #define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
944 #define	KERN_MAXPROCPERUID	28	/* int: max processes per uid */
945 #define	KERN_DUMPDEV		29	/* struct cdev *: device to dump on */
946 #define	KERN_IPC		30	/* node: anything related to IPC */
947 #define	KERN_DUMMY		31	/* unused */
948 #define	KERN_PS_STRINGS		32	/* int: address of PS_STRINGS */
949 #define	KERN_USRSTACK		33	/* int: address of USRSTACK */
950 #define	KERN_LOGSIGEXIT		34	/* int: do we log sigexit procs? */
951 #define	KERN_IOV_MAX		35	/* int: value of UIO_MAXIOV */
952 #define	KERN_HOSTUUID		36	/* string: host UUID identifier */
953 #define	KERN_ARND		37	/* int: from arc4rand() */
954 #define	KERN_MAXPHYS		38	/* int: MAXPHYS value */
955 /*
956  * KERN_PROC subtypes
957  */
958 #define	KERN_PROC_ALL		0	/* everything */
959 #define	KERN_PROC_PID		1	/* by process id */
960 #define	KERN_PROC_PGRP		2	/* by process group id */
961 #define	KERN_PROC_SESSION	3	/* by session of pid */
962 #define	KERN_PROC_TTY		4	/* by controlling tty */
963 #define	KERN_PROC_UID		5	/* by effective uid */
964 #define	KERN_PROC_RUID		6	/* by real uid */
965 #define	KERN_PROC_ARGS		7	/* get/set arguments/proctitle */
966 #define	KERN_PROC_PROC		8	/* only return procs */
967 #define	KERN_PROC_SV_NAME	9	/* get syscall vector name */
968 #define	KERN_PROC_RGID		10	/* by real group id */
969 #define	KERN_PROC_GID		11	/* by effective group id */
970 #define	KERN_PROC_PATHNAME	12	/* path to executable */
971 #define	KERN_PROC_OVMMAP	13	/* Old VM map entries for process */
972 #define	KERN_PROC_OFILEDESC	14	/* Old file descriptors for process */
973 #define	KERN_PROC_KSTACK	15	/* Kernel stacks for process */
974 #define	KERN_PROC_INC_THREAD	0x10	/*
975 					 * modifier for pid, pgrp, tty,
976 					 * uid, ruid, gid, rgid and proc
977 					 * This effectively uses 16-31
978 					 */
979 #define	KERN_PROC_VMMAP		32	/* VM map entries for process */
980 #define	KERN_PROC_FILEDESC	33	/* File descriptors for process */
981 #define	KERN_PROC_GROUPS	34	/* process groups */
982 #define	KERN_PROC_ENV		35	/* get environment */
983 #define	KERN_PROC_AUXV		36	/* get ELF auxiliary vector */
984 #define	KERN_PROC_RLIMIT	37	/* process resource limits */
985 #define	KERN_PROC_PS_STRINGS	38	/* get ps_strings location */
986 #define	KERN_PROC_UMASK		39	/* process umask */
987 #define	KERN_PROC_OSREL		40	/* osreldate for process binary */
988 #define	KERN_PROC_SIGTRAMP	41	/* signal trampoline location */
989 #define	KERN_PROC_CWD		42	/* process current working directory */
990 #define	KERN_PROC_NFDS		43	/* number of open file descriptors */
991 
992 /*
993  * KERN_IPC identifiers
994  */
995 #define	KIPC_MAXSOCKBUF		1	/* int: max size of a socket buffer */
996 #define	KIPC_SOCKBUF_WASTE	2	/* int: wastage factor in sockbuf */
997 #define	KIPC_SOMAXCONN		3	/* int: max length of connection q */
998 #define	KIPC_MAX_LINKHDR	4	/* int: max length of link header */
999 #define	KIPC_MAX_PROTOHDR	5	/* int: max length of network header */
1000 #define	KIPC_MAX_HDR		6	/* int: max total length of headers */
1001 #define	KIPC_MAX_DATALEN	7	/* int: max length of data? */
1002 
1003 /*
1004  * CTL_HW identifiers
1005  */
1006 #define	HW_MACHINE	 1		/* string: machine class */
1007 #define	HW_MODEL	 2		/* string: specific machine model */
1008 #define	HW_NCPU		 3		/* int: number of cpus */
1009 #define	HW_BYTEORDER	 4		/* int: machine byte order */
1010 #define	HW_PHYSMEM	 5		/* int: total memory */
1011 #define	HW_USERMEM	 6		/* int: non-kernel memory */
1012 #define	HW_PAGESIZE	 7		/* int: software page size */
1013 #define	HW_DISKNAMES	 8		/* strings: disk drive names */
1014 #define	HW_DISKSTATS	 9		/* struct: diskstats[] */
1015 #define	HW_FLOATINGPT	10		/* int: has HW floating point? */
1016 #define	HW_MACHINE_ARCH	11		/* string: machine architecture */
1017 #define	HW_REALMEM	12		/* int: 'real' memory */
1018 
1019 /*
1020  * CTL_USER definitions
1021  */
1022 #define	USER_CS_PATH		 1	/* string: _CS_PATH */
1023 #define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
1024 #define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
1025 #define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
1026 #define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
1027 #define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
1028 #define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
1029 #define	USER_LINE_MAX		 8	/* int: LINE_MAX */
1030 #define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
1031 #define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
1032 #define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
1033 #define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
1034 #define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
1035 #define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
1036 #define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
1037 #define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
1038 #define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
1039 #define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
1040 #define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
1041 #define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
1042 
1043 #define	CTL_P1003_1B_ASYNCHRONOUS_IO		1	/* boolean */
1044 #define	CTL_P1003_1B_MAPPED_FILES		2	/* boolean */
1045 #define	CTL_P1003_1B_MEMLOCK			3	/* boolean */
1046 #define	CTL_P1003_1B_MEMLOCK_RANGE		4	/* boolean */
1047 #define	CTL_P1003_1B_MEMORY_PROTECTION		5	/* boolean */
1048 #define	CTL_P1003_1B_MESSAGE_PASSING		6	/* boolean */
1049 #define	CTL_P1003_1B_PRIORITIZED_IO		7	/* boolean */
1050 #define	CTL_P1003_1B_PRIORITY_SCHEDULING	8	/* boolean */
1051 #define	CTL_P1003_1B_REALTIME_SIGNALS		9	/* boolean */
1052 #define	CTL_P1003_1B_SEMAPHORES			10	/* boolean */
1053 #define	CTL_P1003_1B_FSYNC			11	/* boolean */
1054 #define	CTL_P1003_1B_SHARED_MEMORY_OBJECTS	12	/* boolean */
1055 #define	CTL_P1003_1B_SYNCHRONIZED_IO		13	/* boolean */
1056 #define	CTL_P1003_1B_TIMERS			14	/* boolean */
1057 #define	CTL_P1003_1B_AIO_LISTIO_MAX		15	/* int */
1058 #define	CTL_P1003_1B_AIO_MAX			16	/* int */
1059 #define	CTL_P1003_1B_AIO_PRIO_DELTA_MAX		17	/* int */
1060 #define	CTL_P1003_1B_DELAYTIMER_MAX		18	/* int */
1061 #define	CTL_P1003_1B_MQ_OPEN_MAX		19	/* int */
1062 #define	CTL_P1003_1B_PAGESIZE			20	/* int */
1063 #define	CTL_P1003_1B_RTSIG_MAX			21	/* int */
1064 #define	CTL_P1003_1B_SEM_NSEMS_MAX		22	/* int */
1065 #define	CTL_P1003_1B_SEM_VALUE_MAX		23	/* int */
1066 #define	CTL_P1003_1B_SIGQUEUE_MAX		24	/* int */
1067 #define	CTL_P1003_1B_TIMER_MAX			25	/* int */
1068 
1069 #define	CTL_P1003_1B_MAXID		26
1070 
1071 #ifdef _KERNEL
1072 
1073 /*
1074  * Declare some common oids.
1075  */
1076 extern struct sysctl_oid_list sysctl__children;
1077 SYSCTL_DECL(_kern);
1078 SYSCTL_DECL(_kern_features);
1079 SYSCTL_DECL(_kern_ipc);
1080 SYSCTL_DECL(_kern_proc);
1081 SYSCTL_DECL(_kern_sched);
1082 SYSCTL_DECL(_kern_sched_stats);
1083 SYSCTL_DECL(_sysctl);
1084 SYSCTL_DECL(_vm);
1085 SYSCTL_DECL(_vm_stats);
1086 SYSCTL_DECL(_vm_stats_misc);
1087 SYSCTL_DECL(_vfs);
1088 SYSCTL_DECL(_net);
1089 SYSCTL_DECL(_debug);
1090 SYSCTL_DECL(_debug_sizeof);
1091 SYSCTL_DECL(_dev);
1092 SYSCTL_DECL(_hw);
1093 SYSCTL_DECL(_hw_bus);
1094 SYSCTL_DECL(_hw_bus_devices);
1095 SYSCTL_DECL(_hw_bus_info);
1096 SYSCTL_DECL(_machdep);
1097 SYSCTL_DECL(_machdep_mitigations);
1098 SYSCTL_DECL(_user);
1099 SYSCTL_DECL(_compat);
1100 SYSCTL_DECL(_regression);
1101 SYSCTL_DECL(_security);
1102 SYSCTL_DECL(_security_bsd);
1103 
1104 extern char	machine[];
1105 extern char	osrelease[];
1106 extern char	ostype[];
1107 extern char	kern_ident[];
1108 
1109 /* Dynamic oid handling */
1110 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
1111 	    struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
1112 	    void *arg1, intmax_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
1113 	    const char *fmt, const char *descr, const char *label);
1114 int	sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
1115 	    int recurse);
1116 void	sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
1117 int	sysctl_move_oid(struct sysctl_oid *oidp,
1118 	    struct sysctl_oid_list *parent);
1119 int	sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
1120 int	sysctl_ctx_init(struct sysctl_ctx_list *clist);
1121 int	sysctl_ctx_free(struct sysctl_ctx_list *clist);
1122 struct	sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
1123 	    struct sysctl_oid *oidp);
1124 struct	sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
1125 	    struct sysctl_oid *oidp);
1126 int	sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
1127 	    struct sysctl_oid *oidp);
1128 
1129 int	kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1130 	    size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1131 	    int flags);
1132 int	kernel_sysctlbyname(struct thread *td, char *name, void *old,
1133 	    size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1134 	    int flags);
1135 int	userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1136 	    size_t *oldlenp, int inkernel, const void *new, size_t newlen,
1137 	    size_t *retval, int flags);
1138 int	sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
1139 	    int *nindx, struct sysctl_req *req);
1140 void	sysctl_wlock(void);
1141 void	sysctl_wunlock(void);
1142 int	sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
1143 int	kern___sysctlbyname(struct thread *td, const char *name,
1144 	    size_t namelen, void *old, size_t *oldlenp, void *new,
1145 	    size_t newlen, size_t *retval, int flags, bool inkernel);
1146 
1147 struct sbuf;
1148 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
1149 	    struct sysctl_req *);
1150 #else	/* !_KERNEL */
1151 #include <sys/cdefs.h>
1152 
1153 __BEGIN_DECLS
1154 int	sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
1155 int	sysctlbyname(const char *, void *, size_t *, const void *, size_t);
1156 int	sysctlnametomib(const char *, int *, size_t *);
1157 __END_DECLS
1158 #endif	/* _KERNEL */
1159 
1160 #endif	/* !_SYS_SYSCTL_H_ */
1161