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