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