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