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