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