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