xref: /freebsd/sys/sys/sysctl.h (revision 56961fd7949de755f95a60fe8ac936f81e953f5b)
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$
34  */
35 
36 #ifndef _SYS_SYSCTL_H_
37 #define	_SYS_SYSCTL_H_
38 
39 #include <sys/queue.h>
40 
41 struct 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  */
60 struct 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 
77 #define CTLFLAG_RD	0x80000000	/* Allow reads of variable */
78 #define CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
79 #define CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
80 #define CTLFLAG_ANYBODY	0x10000000	/* All users can set this var */
81 #define CTLFLAG_SECURE	0x08000000	/* Permit set only if securelevel<=0 */
82 #define CTLFLAG_PRISON	0x04000000	/* Prisoned roots can fiddle */
83 #define CTLFLAG_DYN	0x02000000	/* Dynamic oid - can be freed */
84 #define CTLFLAG_SKIP	0x01000000	/* Skip this sysctl when listing */
85 #define CTLMASK_SECURE	0x00F00000	/* Secure level */
86 #define CTLFLAG_TUN	0x00080000	/* Tunable variable */
87 #define	CTLFLAG_RDTUN	(CTLFLAG_RD|CTLFLAG_TUN)
88 #define	CTLFLAG_RWTUN	(CTLFLAG_RW|CTLFLAG_TUN)
89 #define CTLFLAG_MPSAFE	0x00040000	/* Handler is MP safe */
90 #define CTLFLAG_VNET	0x00020000	/* Prisons with vnet can fiddle */
91 #define	CTLFLAG_DYING	0x00010000	/* oid is being removed */
92 #define CTLFLAG_CAPRD	0x00008000	/* Can be read in capability mode */
93 #define CTLFLAG_CAPWR	0x00004000	/* Can be written in capability mode */
94 #define CTLFLAG_STATS	0x00002000	/* Statistics, not a tuneable */
95 #define CTLFLAG_CAPRW	(CTLFLAG_CAPRD|CTLFLAG_CAPWR)
96 
97 /*
98  * Secure level.   Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
99  *
100  * Secure when the securelevel is raised to at least N.
101  */
102 #define CTLSHIFT_SECURE	20
103 #define CTLFLAG_SECURE1	(CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
104 #define CTLFLAG_SECURE2	(CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
105 #define CTLFLAG_SECURE3	(CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
106 
107 /*
108  * USE THIS instead of a hardwired number from the categories below
109  * to get dynamically assigned sysctl entries using the linker-set
110  * technology. This is the way nearly all new sysctl variables should
111  * be implemented.
112  * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
113  */
114 #define OID_AUTO	(-1)
115 
116 /*
117  * The starting number for dynamically-assigned entries.  WARNING!
118  * ALL static sysctl entries should have numbers LESS than this!
119  */
120 #define CTL_AUTO_START	0x100
121 
122 #ifdef _KERNEL
123 #include <sys/linker_set.h>
124 
125 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1,	\
126 	intptr_t arg2, struct sysctl_req *req
127 
128 /* definitions for sysctl_req 'lock' member */
129 #define	REQ_UNWIRED	1
130 #define	REQ_WIRED	2
131 
132 /* definitions for sysctl_req 'flags' member */
133 #if defined(__amd64__) || defined(__ia64__) || defined(__powerpc64__) ||	\
134 	(defined(__mips__) && defined(__mips_n64))
135 #define	SCTL_MASK32	1	/* 32 bit emulation */
136 #endif
137 
138 /*
139  * This describes the access space for a sysctl request.  This is needed
140  * so that we can use the interface from the kernel or from user-space.
141  */
142 struct sysctl_req {
143 	struct thread	*td;		/* used for access checking */
144 	int		lock;		/* wiring state */
145 	void		*oldptr;
146 	size_t		oldlen;
147 	size_t		oldidx;
148 	int		(*oldfunc)(struct sysctl_req *, const void *, size_t);
149 	void		*newptr;
150 	size_t		newlen;
151 	size_t		newidx;
152 	int		(*newfunc)(struct sysctl_req *, void *, size_t);
153 	size_t		validlen;
154 	int		flags;
155 };
156 
157 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
158 
159 /*
160  * This describes one "oid" in the MIB tree.  Potentially more nodes can
161  * be hidden behind it, expanded by the handler.
162  */
163 struct sysctl_oid {
164 	struct sysctl_oid_list *oid_parent;
165 	SLIST_ENTRY(sysctl_oid) oid_link;
166 	int		oid_number;
167 	u_int		oid_kind;
168 	void		*oid_arg1;
169 	intptr_t	oid_arg2;
170 	const char	*oid_name;
171 	int 		(*oid_handler)(SYSCTL_HANDLER_ARGS);
172 	const char	*oid_fmt;
173 	int		oid_refcnt;
174 	u_int		oid_running;
175 	const char	*oid_descr;
176 };
177 
178 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
179 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
180 
181 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
182 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
183 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
184 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
185 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
186 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
187 
188 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
189 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
190 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
191 
192 /*
193  * These functions are used to add/remove an oid from the mib.
194  */
195 void sysctl_register_oid(struct sysctl_oid *oidp);
196 void sysctl_unregister_oid(struct sysctl_oid *oidp);
197 
198 /* Declare a static oid to allow child oids to be added to it. */
199 #define SYSCTL_DECL(name)					\
200 	extern struct sysctl_oid_list sysctl_##name##_children
201 
202 /* Hide these in macros */
203 #define	SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \
204 	(oid_ptr)->oid_arg1
205 #define	SYSCTL_CHILDREN_SET(oid_ptr, val) \
206 	(oid_ptr)->oid_arg1 = (val);
207 #define	SYSCTL_STATIC_CHILDREN(oid_name) \
208 	(&sysctl_##oid_name##_children)
209 
210 /* === Structs and macros related to context handling === */
211 
212 /* All dynamically created sysctls can be tracked in a context list. */
213 struct sysctl_ctx_entry {
214 	struct sysctl_oid *entry;
215 	TAILQ_ENTRY(sysctl_ctx_entry) link;
216 };
217 
218 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
219 
220 #define SYSCTL_NODE_CHILDREN(parent, name) \
221 	sysctl_##parent##_##name##_children
222 
223 /*
224  * These macros provide type safety for sysctls.  SYSCTL_ALLOWED_TYPES()
225  * defines a transparent union of the allowed types.  SYSCTL_ASSERT_TYPE()
226  * and SYSCTL_ADD_ASSERT_TYPE() use the transparent union to assert that
227  * the pointer matches the allowed types.
228  *
229  * The allow_0 member allows a literal 0 to be passed for ptr.
230  */
231 #define	SYSCTL_ALLOWED_TYPES(type, decls)			\
232 	union sysctl_##type {					\
233 		long allow_0;					\
234 		decls						\
235 	} __attribute__((__transparent_union__));		\
236 								\
237 	static inline void *					\
238 	__sysctl_assert_##type(union sysctl_##type ptr)		\
239 	{							\
240 		return (ptr.a);					\
241 	}							\
242 	struct __hack
243 
244 SYSCTL_ALLOWED_TYPES(INT, int *a; );
245 SYSCTL_ALLOWED_TYPES(UINT, unsigned int *a; );
246 SYSCTL_ALLOWED_TYPES(LONG, long *a; );
247 SYSCTL_ALLOWED_TYPES(ULONG, unsigned long *a; );
248 SYSCTL_ALLOWED_TYPES(INT64, int64_t *a; long long *b; );
249 SYSCTL_ALLOWED_TYPES(UINT64, uint64_t *a; unsigned long long *b; );
250 
251 #ifdef notyet
252 #define	SYSCTL_ADD_ASSERT_TYPE(type, ptr)	\
253 	__sysctl_assert_ ## type (ptr)
254 #define	SYSCTL_ASSERT_TYPE(type, ptr, parent, name)	\
255 	_SYSCTL_ASSERT_TYPE(type, ptr, __LINE__, parent##_##name)
256 #else
257 #define	SYSCTL_ADD_ASSERT_TYPE(type, ptr)	ptr
258 #define	SYSCTL_ASSERT_TYPE(type, ptr, parent, name)
259 #endif
260 #define	_SYSCTL_ASSERT_TYPE(t, p, l, id)		\
261 	__SYSCTL_ASSERT_TYPE(t, p, l, id)
262 #define	__SYSCTL_ASSERT_TYPE(type, ptr, line, id)			\
263 	static inline void						\
264 	sysctl_assert_##line##_##id(void)				\
265 	{								\
266 		(void)__sysctl_assert_##type(ptr);			\
267 	}								\
268 	struct __hack
269 
270 #ifndef NO_SYSCTL_DESCR
271 #define __DESCR(d) d
272 #else
273 #define __DESCR(d) ""
274 #endif
275 
276 /* This constructs a "raw" MIB oid. */
277 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
278 	static struct sysctl_oid sysctl__##parent##_##name = {		 \
279 		&sysctl_##parent##_children, { NULL }, nbr, kind,	 \
280 		a1, a2, #name, handler, fmt, 0, 0, __DESCR(descr) };	 \
281 	DATA_SET(sysctl_set, sysctl__##parent##_##name)
282 
283 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
284 	sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr))
285 
286 /* This constructs a node from which other oids can hang. */
287 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr)		    \
288 	struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);	    \
289 	SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access),		    \
290 	    (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr)
291 
292 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)	    \
293 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),	    \
294 	NULL, 0, handler, "N", __DESCR(descr))
295 
296 /* Oid for a string.  len can be 0 to indicate '\0' termination. */
297 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
298 	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \
299 		arg, len, sysctl_handle_string, "A", descr)
300 
301 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr)  \
302 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),	    \
303 	arg, len, sysctl_handle_string, "A", __DESCR(descr))
304 
305 /* Oid for an int.  If ptr is NULL, val is returned. */
306 #define	SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)		\
307 	SYSCTL_ASSERT_TYPE(INT, ptr, parent, name);			\
308 	SYSCTL_OID(parent, nbr, name,					\
309 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
310 	    ptr, val, sysctl_handle_int, "I", descr)
311 
312 #define	SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr)	\
313 	sysctl_add_oid(ctx, parent, nbr, name,				\
314 	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
315 	    SYSCTL_ADD_ASSERT_TYPE(INT, ptr), val,			\
316 	    sysctl_handle_int, "I", __DESCR(descr))
317 
318 /* Oid for an unsigned int.  If ptr is NULL, val is returned. */
319 #define	SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)		\
320 	SYSCTL_ASSERT_TYPE(UINT, ptr, parent, name);			\
321 	SYSCTL_OID(parent, nbr, name,					\
322 	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),			\
323 	    ptr, val, sysctl_handle_int, "IU", descr)
324 
325 #define	SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
326 	sysctl_add_oid(ctx, parent, nbr, name,				\
327 	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),			\
328 	    SYSCTL_ADD_ASSERT_TYPE(UINT, ptr), val,			\
329 	    sysctl_handle_int, "IU", __DESCR(descr))
330 
331 /* Oid for a long.  The pointer must be non NULL. */
332 #define	SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)		\
333 	SYSCTL_ASSERT_TYPE(LONG, ptr, parent, name);			\
334 	SYSCTL_OID(parent, nbr, name,					\
335 	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),			\
336 	    ptr, val, sysctl_handle_long, "L", descr)
337 
338 #define	SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)	\
339 	sysctl_add_oid(ctx, parent, nbr, name,				\
340 	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),			\
341 	    SYSCTL_ADD_ASSERT_TYPE(LONG, ptr), 0,			\
342 	    sysctl_handle_long,	"L", __DESCR(descr))
343 
344 /* Oid for an unsigned long.  The pointer must be non NULL. */
345 #define	SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)	\
346 	SYSCTL_ASSERT_TYPE(ULONG, ptr, parent, name);			\
347 	SYSCTL_OID(parent, nbr, name,					\
348 	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
349 	    ptr, val, sysctl_handle_long, "LU", descr)
350 
351 #define	SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)	\
352 	sysctl_add_oid(ctx, parent, nbr, name,				\
353 	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
354 	    SYSCTL_ADD_ASSERT_TYPE(ULONG, ptr), 0,			\
355 	    sysctl_handle_long, "LU", __DESCR(descr))
356 
357 /* Oid for a quad.  The pointer must be non NULL. */
358 #define	SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)		\
359 	SYSCTL_ASSERT_TYPE(INT64, ptr, parent, name);			\
360 	SYSCTL_OID(parent, nbr, name,					\
361 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
362 	    ptr, val, sysctl_handle_64, "Q", descr)
363 
364 #define	SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr)	\
365 	sysctl_add_oid(ctx, parent, nbr, name,				\
366 	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
367 	    SYSCTL_ADD_ASSERT_TYPE(INT64, ptr), 0,			\
368 	    sysctl_handle_64, "Q", __DESCR(descr))
369 
370 #define	SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)	\
371 	SYSCTL_ASSERT_TYPE(UINT64, ptr, parent, name);			\
372 	SYSCTL_OID(parent, nbr, name,					\
373 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
374 	    ptr, val, sysctl_handle_64, "QU", descr)
375 
376 #define	SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr)	\
377 	sysctl_add_oid(ctx, parent, nbr, name,				\
378 	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
379 	    SYSCTL_ADD_ASSERT_TYPE(UINT64, ptr), 0,			\
380 	    sysctl_handle_64, "QU", __DESCR(descr))
381 
382 /* Oid for an opaque object.  Specified by a pointer and a length. */
383 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
384 	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
385 		ptr, len, sysctl_handle_opaque, fmt, descr)
386 
387 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\
388 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	    \
389 	ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr))
390 
391 /* Oid for a struct.  Specified by a pointer and a type. */
392 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
393 	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
394 		ptr, sizeof(struct type), sysctl_handle_opaque, \
395 		"S," #type, descr)
396 
397 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
398 	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	    \
399 	ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr))
400 
401 /* Oid for a procedure.  Specified by a pointer and an arg. */
402 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
403 	CTASSERT(((access) & CTLTYPE) != 0);				\
404 	SYSCTL_OID(parent, nbr, name, (access), \
405 		ptr, arg, handler, fmt, descr)
406 
407 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
408 	sysctl_add_oid(ctx, parent, nbr, name, (access),			    \
409 	ptr, arg, handler, fmt, __DESCR(descr))
410 
411 /*
412  * A macro to generate a read-only sysctl to indicate the presense of optional
413  * kernel features.
414  */
415 #define	FEATURE(name, desc)						\
416 	SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD | CTLFLAG_CAPRD, \
417 	    0, 1, desc)
418 
419 #endif /* _KERNEL */
420 
421 /*
422  * Top-level identifiers
423  */
424 #define	CTL_UNSPEC	0		/* unused */
425 #define	CTL_KERN	1		/* "high kernel": proc, limits */
426 #define	CTL_VM		2		/* virtual memory */
427 #define	CTL_VFS		3		/* filesystem, mount type is next */
428 #define	CTL_NET		4		/* network, see socket.h */
429 #define	CTL_DEBUG	5		/* debugging parameters */
430 #define	CTL_HW		6		/* generic cpu/io */
431 #define	CTL_MACHDEP	7		/* machine dependent */
432 #define	CTL_USER	8		/* user-level */
433 #define	CTL_P1003_1B	9		/* POSIX 1003.1B */
434 #define	CTL_MAXID	10		/* number of valid top-level ids */
435 
436 #define CTL_NAMES { \
437 	{ 0, 0 }, \
438 	{ "kern", CTLTYPE_NODE }, \
439 	{ "vm", CTLTYPE_NODE }, \
440 	{ "vfs", CTLTYPE_NODE }, \
441 	{ "net", CTLTYPE_NODE }, \
442 	{ "debug", CTLTYPE_NODE }, \
443 	{ "hw", CTLTYPE_NODE }, \
444 	{ "machdep", CTLTYPE_NODE }, \
445 	{ "user", CTLTYPE_NODE }, \
446 	{ "p1003_1b", CTLTYPE_NODE }, \
447 }
448 
449 /*
450  * CTL_KERN identifiers
451  */
452 #define	KERN_OSTYPE	 	 1	/* string: system version */
453 #define	KERN_OSRELEASE	 	 2	/* string: system release */
454 #define	KERN_OSREV	 	 3	/* int: system revision */
455 #define	KERN_VERSION	 	 4	/* string: compile time info */
456 #define	KERN_MAXVNODES	 	 5	/* int: max vnodes */
457 #define	KERN_MAXPROC	 	 6	/* int: max processes */
458 #define	KERN_MAXFILES	 	 7	/* int: max open files */
459 #define	KERN_ARGMAX	 	 8	/* int: max arguments to exec */
460 #define	KERN_SECURELVL	 	 9	/* int: system security level */
461 #define	KERN_HOSTNAME		10	/* string: hostname */
462 #define	KERN_HOSTID		11	/* int: host identifier */
463 #define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
464 #define	KERN_VNODE		13	/* struct: vnode structures */
465 #define	KERN_PROC		14	/* struct: process entries */
466 #define	KERN_FILE		15	/* struct: file entries */
467 #define	KERN_PROF		16	/* node: kernel profiling info */
468 #define	KERN_POSIX1		17	/* int: POSIX.1 version */
469 #define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
470 #define	KERN_JOB_CONTROL	19	/* int: is job control available */
471 #define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
472 #define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
473 #define KERN_NISDOMAINNAME	22	/* string: YP domain name */
474 #define KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
475 #define KERN_OSRELDATE		24	/* int: kernel release date */
476 #define KERN_NTP_PLL		25	/* node: NTP PLL control */
477 #define	KERN_BOOTFILE		26	/* string: name of booted kernel */
478 #define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
479 #define	KERN_MAXPROCPERUID 	28	/* int: max processes per uid */
480 #define KERN_DUMPDEV		29	/* struct cdev *: device to dump on */
481 #define	KERN_IPC		30	/* node: anything related to IPC */
482 #define	KERN_DUMMY		31	/* unused */
483 #define	KERN_PS_STRINGS		32	/* int: address of PS_STRINGS */
484 #define	KERN_USRSTACK		33	/* int: address of USRSTACK */
485 #define	KERN_LOGSIGEXIT		34	/* int: do we log sigexit procs? */
486 #define	KERN_IOV_MAX		35	/* int: value of UIO_MAXIOV */
487 #define	KERN_HOSTUUID		36	/* string: host UUID identifier */
488 #define	KERN_ARND		37	/* int: from arc4rand() */
489 #define	KERN_MAXID		38	/* number of valid kern ids */
490 
491 #define CTL_KERN_NAMES { \
492 	{ 0, 0 }, \
493 	{ "ostype", CTLTYPE_STRING }, \
494 	{ "osrelease", CTLTYPE_STRING }, \
495 	{ "osrevision", CTLTYPE_INT }, \
496 	{ "version", CTLTYPE_STRING }, \
497 	{ "maxvnodes", CTLTYPE_INT }, \
498 	{ "maxproc", CTLTYPE_INT }, \
499 	{ "maxfiles", CTLTYPE_INT }, \
500 	{ "argmax", CTLTYPE_INT }, \
501 	{ "securelevel", CTLTYPE_INT }, \
502 	{ "hostname", CTLTYPE_STRING }, \
503 	{ "hostid", CTLTYPE_UINT }, \
504 	{ "clockrate", CTLTYPE_STRUCT }, \
505 	{ "vnode", CTLTYPE_STRUCT }, \
506 	{ "proc", CTLTYPE_STRUCT }, \
507 	{ "file", CTLTYPE_STRUCT }, \
508 	{ "profiling", CTLTYPE_NODE }, \
509 	{ "posix1version", CTLTYPE_INT }, \
510 	{ "ngroups", CTLTYPE_INT }, \
511 	{ "job_control", CTLTYPE_INT }, \
512 	{ "saved_ids", CTLTYPE_INT }, \
513 	{ "boottime", CTLTYPE_STRUCT }, \
514 	{ "nisdomainname", CTLTYPE_STRING }, \
515 	{ "update", CTLTYPE_INT }, \
516 	{ "osreldate", CTLTYPE_INT }, \
517 	{ "ntp_pll", CTLTYPE_NODE }, \
518 	{ "bootfile", CTLTYPE_STRING }, \
519 	{ "maxfilesperproc", CTLTYPE_INT }, \
520 	{ "maxprocperuid", CTLTYPE_INT }, \
521 	{ "ipc", CTLTYPE_NODE }, \
522 	{ "dummy", CTLTYPE_INT }, \
523 	{ "ps_strings", CTLTYPE_INT }, \
524 	{ "usrstack", CTLTYPE_INT }, \
525 	{ "logsigexit", CTLTYPE_INT }, \
526 	{ "iov_max", CTLTYPE_INT }, \
527 	{ "hostuuid", CTLTYPE_STRING }, \
528 	{ "arc4rand", CTLTYPE_OPAQUE }, \
529 }
530 
531 /*
532  * CTL_VFS identifiers
533  */
534 #define CTL_VFS_NAMES { \
535 	{ "vfsconf", CTLTYPE_STRUCT }, \
536 }
537 
538 /*
539  * KERN_PROC subtypes
540  */
541 #define KERN_PROC_ALL		0	/* everything */
542 #define	KERN_PROC_PID		1	/* by process id */
543 #define	KERN_PROC_PGRP		2	/* by process group id */
544 #define	KERN_PROC_SESSION	3	/* by session of pid */
545 #define	KERN_PROC_TTY		4	/* by controlling tty */
546 #define	KERN_PROC_UID		5	/* by effective uid */
547 #define	KERN_PROC_RUID		6	/* by real uid */
548 #define	KERN_PROC_ARGS		7	/* get/set arguments/proctitle */
549 #define	KERN_PROC_PROC		8	/* only return procs */
550 #define	KERN_PROC_SV_NAME	9	/* get syscall vector name */
551 #define	KERN_PROC_RGID		10	/* by real group id */
552 #define	KERN_PROC_GID		11	/* by effective group id */
553 #define	KERN_PROC_PATHNAME	12	/* path to executable */
554 #define	KERN_PROC_OVMMAP	13	/* Old VM map entries for process */
555 #define	KERN_PROC_OFILEDESC	14	/* Old file descriptors for process */
556 #define	KERN_PROC_KSTACK	15	/* Kernel stacks for process */
557 #define	KERN_PROC_INC_THREAD	0x10	/*
558 					 * modifier for pid, pgrp, tty,
559 					 * uid, ruid, gid, rgid and proc
560 					 * This effectively uses 16-31
561 					 */
562 #define	KERN_PROC_VMMAP		32	/* VM map entries for process */
563 #define	KERN_PROC_FILEDESC	33	/* File descriptors for process */
564 #define	KERN_PROC_GROUPS	34	/* process groups */
565 #define	KERN_PROC_ENV		35	/* get environment */
566 #define	KERN_PROC_AUXV		36	/* get ELF auxiliary vector */
567 #define	KERN_PROC_RLIMIT	37	/* process resource limits */
568 #define	KERN_PROC_PS_STRINGS	38	/* get ps_strings location */
569 #define	KERN_PROC_UMASK		39	/* process umask */
570 #define	KERN_PROC_OSREL		40	/* osreldate for process binary */
571 
572 /*
573  * KERN_IPC identifiers
574  */
575 #define KIPC_MAXSOCKBUF		1	/* int: max size of a socket buffer */
576 #define	KIPC_SOCKBUF_WASTE	2	/* int: wastage factor in sockbuf */
577 #define	KIPC_SOMAXCONN		3	/* int: max length of connection q */
578 #define	KIPC_MAX_LINKHDR	4	/* int: max length of link header */
579 #define	KIPC_MAX_PROTOHDR	5	/* int: max length of network header */
580 #define	KIPC_MAX_HDR		6	/* int: max total length of headers */
581 #define	KIPC_MAX_DATALEN	7	/* int: max length of data? */
582 
583 /*
584  * CTL_HW identifiers
585  */
586 #define	HW_MACHINE	 1		/* string: machine class */
587 #define	HW_MODEL	 2		/* string: specific machine model */
588 #define	HW_NCPU		 3		/* int: number of cpus */
589 #define	HW_BYTEORDER	 4		/* int: machine byte order */
590 #define	HW_PHYSMEM	 5		/* int: total memory */
591 #define	HW_USERMEM	 6		/* int: non-kernel memory */
592 #define	HW_PAGESIZE	 7		/* int: software page size */
593 #define	HW_DISKNAMES	 8		/* strings: disk drive names */
594 #define	HW_DISKSTATS	 9		/* struct: diskstats[] */
595 #define HW_FLOATINGPT	10		/* int: has HW floating point? */
596 #define HW_MACHINE_ARCH	11		/* string: machine architecture */
597 #define	HW_REALMEM	12		/* int: 'real' memory */
598 #define	HW_MAXID	13		/* number of valid hw ids */
599 
600 #define CTL_HW_NAMES { \
601 	{ 0, 0 }, \
602 	{ "machine", CTLTYPE_STRING }, \
603 	{ "model", CTLTYPE_STRING }, \
604 	{ "ncpu", CTLTYPE_INT }, \
605 	{ "byteorder", CTLTYPE_INT }, \
606 	{ "physmem", CTLTYPE_ULONG }, \
607 	{ "usermem", CTLTYPE_ULONG }, \
608 	{ "pagesize", CTLTYPE_INT }, \
609 	{ "disknames", CTLTYPE_STRUCT }, \
610 	{ "diskstats", CTLTYPE_STRUCT }, \
611 	{ "floatingpoint", CTLTYPE_INT }, \
612 	{ "machine_arch", CTLTYPE_STRING }, \
613 	{ "realmem", CTLTYPE_ULONG }, \
614 }
615 
616 /*
617  * CTL_USER definitions
618  */
619 #define	USER_CS_PATH		 1	/* string: _CS_PATH */
620 #define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
621 #define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
622 #define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
623 #define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
624 #define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
625 #define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
626 #define	USER_LINE_MAX		 8	/* int: LINE_MAX */
627 #define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
628 #define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
629 #define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
630 #define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
631 #define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
632 #define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
633 #define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
634 #define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
635 #define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
636 #define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
637 #define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
638 #define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
639 #define	USER_MAXID		21	/* number of valid user ids */
640 
641 #define	CTL_USER_NAMES { \
642 	{ 0, 0 }, \
643 	{ "cs_path", CTLTYPE_STRING }, \
644 	{ "bc_base_max", CTLTYPE_INT }, \
645 	{ "bc_dim_max", CTLTYPE_INT }, \
646 	{ "bc_scale_max", CTLTYPE_INT }, \
647 	{ "bc_string_max", CTLTYPE_INT }, \
648 	{ "coll_weights_max", CTLTYPE_INT }, \
649 	{ "expr_nest_max", CTLTYPE_INT }, \
650 	{ "line_max", CTLTYPE_INT }, \
651 	{ "re_dup_max", CTLTYPE_INT }, \
652 	{ "posix2_version", CTLTYPE_INT }, \
653 	{ "posix2_c_bind", CTLTYPE_INT }, \
654 	{ "posix2_c_dev", CTLTYPE_INT }, \
655 	{ "posix2_char_term", CTLTYPE_INT }, \
656 	{ "posix2_fort_dev", CTLTYPE_INT }, \
657 	{ "posix2_fort_run", CTLTYPE_INT }, \
658 	{ "posix2_localedef", CTLTYPE_INT }, \
659 	{ "posix2_sw_dev", CTLTYPE_INT }, \
660 	{ "posix2_upe", CTLTYPE_INT }, \
661 	{ "stream_max", CTLTYPE_INT }, \
662 	{ "tzname_max", CTLTYPE_INT }, \
663 }
664 
665 #define CTL_P1003_1B_ASYNCHRONOUS_IO		1	/* boolean */
666 #define CTL_P1003_1B_MAPPED_FILES		2	/* boolean */
667 #define CTL_P1003_1B_MEMLOCK			3	/* boolean */
668 #define CTL_P1003_1B_MEMLOCK_RANGE		4	/* boolean */
669 #define CTL_P1003_1B_MEMORY_PROTECTION		5	/* boolean */
670 #define CTL_P1003_1B_MESSAGE_PASSING		6	/* boolean */
671 #define CTL_P1003_1B_PRIORITIZED_IO		7	/* boolean */
672 #define CTL_P1003_1B_PRIORITY_SCHEDULING	8	/* boolean */
673 #define CTL_P1003_1B_REALTIME_SIGNALS		9	/* boolean */
674 #define CTL_P1003_1B_SEMAPHORES			10	/* boolean */
675 #define CTL_P1003_1B_FSYNC			11	/* boolean */
676 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS	12	/* boolean */
677 #define CTL_P1003_1B_SYNCHRONIZED_IO		13	/* boolean */
678 #define CTL_P1003_1B_TIMERS			14	/* boolean */
679 #define CTL_P1003_1B_AIO_LISTIO_MAX		15	/* int */
680 #define CTL_P1003_1B_AIO_MAX			16	/* int */
681 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX		17	/* int */
682 #define CTL_P1003_1B_DELAYTIMER_MAX		18	/* int */
683 #define CTL_P1003_1B_MQ_OPEN_MAX		19	/* int */
684 #define CTL_P1003_1B_PAGESIZE			20	/* int */
685 #define CTL_P1003_1B_RTSIG_MAX			21	/* int */
686 #define CTL_P1003_1B_SEM_NSEMS_MAX		22	/* int */
687 #define CTL_P1003_1B_SEM_VALUE_MAX		23	/* int */
688 #define CTL_P1003_1B_SIGQUEUE_MAX		24	/* int */
689 #define CTL_P1003_1B_TIMER_MAX			25	/* int */
690 
691 #define CTL_P1003_1B_MAXID		26
692 
693 #define	CTL_P1003_1B_NAMES { \
694 	{ 0, 0 }, \
695 	{ "asynchronous_io", CTLTYPE_INT }, \
696 	{ "mapped_files", CTLTYPE_INT }, \
697 	{ "memlock", CTLTYPE_INT }, \
698 	{ "memlock_range", CTLTYPE_INT }, \
699 	{ "memory_protection", CTLTYPE_INT }, \
700 	{ "message_passing", CTLTYPE_INT }, \
701 	{ "prioritized_io", CTLTYPE_INT }, \
702 	{ "priority_scheduling", CTLTYPE_INT }, \
703 	{ "realtime_signals", CTLTYPE_INT }, \
704 	{ "semaphores", CTLTYPE_INT }, \
705 	{ "fsync", CTLTYPE_INT }, \
706 	{ "shared_memory_objects", CTLTYPE_INT }, \
707 	{ "synchronized_io", CTLTYPE_INT }, \
708 	{ "timers", CTLTYPE_INT }, \
709 	{ "aio_listio_max", CTLTYPE_INT }, \
710 	{ "aio_max", CTLTYPE_INT }, \
711 	{ "aio_prio_delta_max", CTLTYPE_INT }, \
712 	{ "delaytimer_max", CTLTYPE_INT }, \
713 	{ "mq_open_max", CTLTYPE_INT }, \
714 	{ "pagesize", CTLTYPE_INT }, \
715 	{ "rtsig_max", CTLTYPE_INT }, \
716 	{ "nsems_max", CTLTYPE_INT }, \
717 	{ "sem_value_max", CTLTYPE_INT }, \
718 	{ "sigqueue_max", CTLTYPE_INT }, \
719 	{ "timer_max", CTLTYPE_INT }, \
720 }
721 
722 #ifdef _KERNEL
723 
724 /*
725  * Declare some common oids.
726  */
727 extern struct sysctl_oid_list sysctl__children;
728 SYSCTL_DECL(_kern);
729 SYSCTL_DECL(_kern_features);
730 SYSCTL_DECL(_kern_ipc);
731 SYSCTL_DECL(_kern_proc);
732 SYSCTL_DECL(_kern_sched);
733 SYSCTL_DECL(_kern_sched_stats);
734 SYSCTL_DECL(_sysctl);
735 SYSCTL_DECL(_vm);
736 SYSCTL_DECL(_vm_stats);
737 SYSCTL_DECL(_vm_stats_misc);
738 SYSCTL_DECL(_vfs);
739 SYSCTL_DECL(_net);
740 SYSCTL_DECL(_debug);
741 SYSCTL_DECL(_debug_sizeof);
742 SYSCTL_DECL(_dev);
743 SYSCTL_DECL(_hw);
744 SYSCTL_DECL(_hw_bus);
745 SYSCTL_DECL(_hw_bus_devices);
746 SYSCTL_DECL(_hw_bus_info);
747 SYSCTL_DECL(_machdep);
748 SYSCTL_DECL(_user);
749 SYSCTL_DECL(_compat);
750 SYSCTL_DECL(_regression);
751 SYSCTL_DECL(_security);
752 SYSCTL_DECL(_security_bsd);
753 
754 extern char	machine[];
755 extern char	osrelease[];
756 extern char	ostype[];
757 extern char	kern_ident[];
758 
759 /* Dynamic oid handling */
760 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
761 		struct sysctl_oid_list *parent, int nbr, const char *name,
762 		int kind, void *arg1, intptr_t arg2,
763 		int (*handler) (SYSCTL_HANDLER_ARGS),
764 		const char *fmt, const char *descr);
765 int	sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
766 		int recurse);
767 void	sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
768 int	sysctl_move_oid(struct sysctl_oid *oidp,
769 		struct sysctl_oid_list *parent);
770 int	sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
771 int	sysctl_ctx_init(struct sysctl_ctx_list *clist);
772 int	sysctl_ctx_free(struct sysctl_ctx_list *clist);
773 struct	sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
774 		struct sysctl_oid *oidp);
775 struct	sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
776 		struct sysctl_oid *oidp);
777 int	sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
778 		struct sysctl_oid *oidp);
779 
780 int	kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
781 		      size_t *oldlenp, void *new, size_t newlen,
782 		      size_t *retval, int flags);
783 int	kernel_sysctlbyname(struct thread *td, char *name,
784 		void *old, size_t *oldlenp, void *new, size_t newlen,
785 		size_t *retval, int flags);
786 int	userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
787 			size_t *oldlenp, int inkernel, void *new, size_t newlen,
788 			size_t *retval, int flags);
789 int	sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
790 			int *nindx, struct sysctl_req *req);
791 void	sysctl_lock(void);
792 void	sysctl_unlock(void);
793 int	sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
794 
795 struct sbuf;
796 struct sbuf	*sbuf_new_for_sysctl(struct sbuf *, char *, int,
797 		    struct sysctl_req *);
798 #else	/* !_KERNEL */
799 #include <sys/cdefs.h>
800 
801 __BEGIN_DECLS
802 int	sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
803 int	sysctlbyname(const char *, void *, size_t *, const void *, size_t);
804 int	sysctlnametomib(const char *, int *, size_t *);
805 __END_DECLS
806 #endif	/* _KERNEL */
807 
808 #endif	/* !_SYS_SYSCTL_H_ */
809