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