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