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