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