sysctl.h revision 298981
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 298981 2016-05-03 15:14:17Z pfg $
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#define	CTLTYPE_U8	0xa	/* name describes an unsigned 8-bit number */
77#define	CTLTYPE_U16	0xb	/* name describes an unsigned 16-bit number */
78#define	CTLTYPE_S8	0xc	/* name describes a signed 8-bit number */
79#define	CTLTYPE_S16	0xd	/* name describes a signed 16-bit number */
80#define	CTLTYPE_S32	0xe	/* name describes a signed 32-bit number */
81#define	CTLTYPE_U32	0xf	/* name describes an unsigned 32-bit number */
82
83#define	CTLFLAG_RD	0x80000000	/* Allow reads of variable */
84#define	CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
85#define	CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
86#define	CTLFLAG_ANYBODY	0x10000000	/* All users can set this var */
87#define	CTLFLAG_SECURE	0x08000000	/* Permit set only if securelevel<=0 */
88#define	CTLFLAG_PRISON	0x04000000	/* Prisoned roots can fiddle */
89#define	CTLFLAG_DYN	0x02000000	/* Dynamic oid - can be freed */
90#define	CTLFLAG_SKIP	0x01000000	/* Skip this sysctl when listing */
91#define	CTLMASK_SECURE	0x00F00000	/* Secure level */
92#define	CTLFLAG_TUN	0x00080000	/* Default value is loaded from getenv() */
93#define	CTLFLAG_RDTUN	(CTLFLAG_RD|CTLFLAG_TUN)
94#define	CTLFLAG_RWTUN	(CTLFLAG_RW|CTLFLAG_TUN)
95#define	CTLFLAG_MPSAFE	0x00040000	/* Handler is MP safe */
96#define	CTLFLAG_VNET	0x00020000	/* Prisons with vnet can fiddle */
97#define	CTLFLAG_DYING	0x00010000	/* Oid is being removed */
98#define	CTLFLAG_CAPRD	0x00008000	/* Can be read in capability mode */
99#define	CTLFLAG_CAPWR	0x00004000	/* Can be written in capability mode */
100#define	CTLFLAG_STATS	0x00002000	/* Statistics, not a tuneable */
101#define	CTLFLAG_NOFETCH	0x00001000	/* Don't fetch tunable from getenv() */
102#define	CTLFLAG_CAPRW	(CTLFLAG_CAPRD|CTLFLAG_CAPWR)
103
104/*
105 * Secure level.   Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
106 *
107 * Secure when the securelevel is raised to at least N.
108 */
109#define	CTLSHIFT_SECURE	20
110#define	CTLFLAG_SECURE1	(CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
111#define	CTLFLAG_SECURE2	(CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
112#define	CTLFLAG_SECURE3	(CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
113
114/*
115 * USE THIS instead of a hardwired number from the categories below
116 * to get dynamically assigned sysctl entries using the linker-set
117 * technology. This is the way nearly all new sysctl variables should
118 * be implemented.
119 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
120 */
121#define	OID_AUTO	(-1)
122
123/*
124 * The starting number for dynamically-assigned entries.  WARNING!
125 * ALL static sysctl entries should have numbers LESS than this!
126 */
127#define	CTL_AUTO_START	0x100
128
129#ifdef _KERNEL
130#include <sys/linker_set.h>
131
132#ifdef KLD_MODULE
133/* XXX allow overspecification of type in external kernel modules */
134#define	SYSCTL_CT_ASSERT_MASK CTLTYPE
135#else
136#define	SYSCTL_CT_ASSERT_MASK 0
137#endif
138
139#define	SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1,	\
140	intmax_t arg2, struct sysctl_req *req
141
142/* definitions for sysctl_req 'lock' member */
143#define	REQ_UNWIRED	1
144#define	REQ_WIRED	2
145
146/* definitions for sysctl_req 'flags' member */
147#if defined(__amd64__) || defined(__powerpc64__) ||\
148    (defined(__mips__) && defined(__mips_n64))
149#define	SCTL_MASK32	1	/* 32 bit emulation */
150#endif
151
152/*
153 * This describes the access space for a sysctl request.  This is needed
154 * so that we can use the interface from the kernel or from user-space.
155 */
156struct sysctl_req {
157	struct thread	*td;		/* used for access checking */
158	int		 lock;		/* wiring state */
159	void		*oldptr;
160	size_t		 oldlen;
161	size_t		 oldidx;
162	int		(*oldfunc)(struct sysctl_req *, const void *, size_t);
163	void		*newptr;
164	size_t		 newlen;
165	size_t		 newidx;
166	int		(*newfunc)(struct sysctl_req *, void *, size_t);
167	size_t		 validlen;
168	int		 flags;
169};
170
171SLIST_HEAD(sysctl_oid_list, sysctl_oid);
172
173/*
174 * This describes one "oid" in the MIB tree.  Potentially more nodes can
175 * be hidden behind it, expanded by the handler.
176 */
177struct sysctl_oid {
178	struct sysctl_oid_list oid_children;
179	struct sysctl_oid_list *oid_parent;
180	SLIST_ENTRY(sysctl_oid) oid_link;
181	int		 oid_number;
182	u_int		 oid_kind;
183	void		*oid_arg1;
184	intmax_t	 oid_arg2;
185	const char	*oid_name;
186	int		(*oid_handler)(SYSCTL_HANDLER_ARGS);
187	const char	*oid_fmt;
188	int		 oid_refcnt;
189	u_int		 oid_running;
190	const char	*oid_descr;
191};
192
193#define	SYSCTL_IN(r, p, l)	(r->newfunc)(r, p, l)
194#define	SYSCTL_OUT(r, p, l)	(r->oldfunc)(r, p, l)
195#define	SYSCTL_OUT_STR(r, p)	(r->oldfunc)(r, p, strlen(p) + 1)
196
197int sysctl_handle_8(SYSCTL_HANDLER_ARGS);
198int sysctl_handle_16(SYSCTL_HANDLER_ARGS);
199int sysctl_handle_32(SYSCTL_HANDLER_ARGS);
200int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
201int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
202int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
203int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
204int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
205int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
206int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
207int sysctl_handle_counter_u64_array(SYSCTL_HANDLER_ARGS);
208
209int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
210int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
211
212int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
213int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
214int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
215
216/*
217 * These functions are used to add/remove an oid from the mib.
218 */
219void sysctl_register_oid(struct sysctl_oid *oidp);
220void sysctl_unregister_oid(struct sysctl_oid *oidp);
221
222/* Declare a static oid to allow child oids to be added to it. */
223#define	SYSCTL_DECL(name)			\
224	extern struct sysctl_oid sysctl__##name
225
226/* Hide these in macros. */
227#define	SYSCTL_CHILDREN(oid_ptr)		(&(oid_ptr)->oid_children)
228#define	SYSCTL_PARENT(oid_ptr)					\
229    (((oid_ptr)->oid_parent != &sysctl__children) ?		\
230	__containerof((oid_ptr)->oid_parent, struct sysctl_oid,	\
231	oid_children) : (struct sysctl_oid *)NULL)
232#define	SYSCTL_STATIC_CHILDREN(oid_name)	(&sysctl__##oid_name.oid_children)
233
234/* === Structs and macros related to context handling. === */
235
236/* All dynamically created sysctls can be tracked in a context list. */
237struct sysctl_ctx_entry {
238	struct sysctl_oid *entry;
239	TAILQ_ENTRY(sysctl_ctx_entry) link;
240};
241
242TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
243
244#define	SYSCTL_NODE_CHILDREN(parent, name) \
245	sysctl__##parent##_##name.oid_children
246
247#ifndef NO_SYSCTL_DESCR
248#define	__DESCR(d) d
249#else
250#define	__DESCR(d) ""
251#endif
252
253/* This macro is only for internal use */
254#define	SYSCTL_OID_RAW(id, parent_child_head, nbr, name, kind, a1, a2, handler, fmt, descr) \
255	struct sysctl_oid id = {					\
256		.oid_parent = (parent_child_head),			\
257		.oid_children = SLIST_HEAD_INITIALIZER(&id.oid_children), \
258		.oid_number = (nbr),					\
259		.oid_kind = (kind),					\
260		.oid_arg1 = (a1),					\
261		.oid_arg2 = (a2),					\
262		.oid_name = (name),					\
263		.oid_handler = (handler),				\
264		.oid_fmt = (fmt),					\
265		.oid_descr = __DESCR(descr)				\
266	};								\
267	DATA_SET(sysctl_set, id)
268
269/* This constructs a static "raw" MIB oid. */
270#define	SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
271    static SYSCTL_OID_RAW(sysctl__##parent##_##name, \
272	SYSCTL_CHILDREN(&sysctl__##parent), \
273	nbr, #name, kind, a1, a2, handler, fmt, descr)
274
275/* This constructs a global "raw" MIB oid. */
276#define	SYSCTL_OID_GLOBAL(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
277    SYSCTL_OID_RAW(sysctl__##parent##_##name, \
278	SYSCTL_CHILDREN(&sysctl__##parent),	\
279	nbr, #name, kind, a1, a2, handler, fmt, descr)
280
281#define	SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
282	sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr))
283
284/* This constructs a root node from which other nodes can hang. */
285#define	SYSCTL_ROOT_NODE(nbr, name, access, handler, descr)	\
286	SYSCTL_OID_RAW(sysctl___##name, &sysctl__children,	\
287	    nbr, #name, CTLTYPE_NODE|(access), NULL, 0,		\
288	    handler, "N", descr);				\
289	CTASSERT(((access) & CTLTYPE) == 0 ||			\
290	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
291
292/* This constructs a node from which other oids can hang. */
293#define	SYSCTL_NODE(parent, nbr, name, access, handler, descr)		\
294	SYSCTL_OID_GLOBAL(parent, nbr, name, CTLTYPE_NODE|(access),	\
295	    NULL, 0, handler, "N", descr);				\
296	CTASSERT(((access) & CTLTYPE) == 0 ||				\
297	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
298
299#define	SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)	\
300({									\
301	CTASSERT(((access) & CTLTYPE) == 0 ||				\
302	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE);	\
303	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),	\
304	    NULL, 0, handler, "N", __DESCR(descr));			\
305})
306
307#define	SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr)	\
308({									\
309	CTASSERT(((access) & CTLTYPE) == 0 ||				\
310	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE);	\
311	sysctl_add_oid(ctx, &sysctl__children, nbr, name,		\
312	    CTLTYPE_NODE|(access),					\
313	    NULL, 0, handler, "N", __DESCR(descr));			\
314})
315
316/* Oid for a string.  len can be 0 to indicate '\0' termination. */
317#define	SYSCTL_STRING(parent, nbr, name, access, arg, len, descr)	\
318	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access),		\
319	    arg, len, sysctl_handle_string, "A", descr);		\
320	CTASSERT(((access) & CTLTYPE) == 0 ||				\
321	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
322
323#define	SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
324({									\
325	char *__arg = (arg);						\
326	CTASSERT(((access) & CTLTYPE) == 0 ||				\
327	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING);	\
328	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),	\
329	    __arg, len, sysctl_handle_string, "A", __DESCR(descr));	\
330})
331
332/* Oid for a signed 8-bit int.  If ptr is NULL, val is returned. */
333#define	SYSCTL_NULL_S8_PTR ((int8_t *)NULL)
334#define	SYSCTL_S8(parent, nbr, name, access, ptr, val, descr)	\
335	SYSCTL_OID(parent, nbr, name,				\
336	    CTLTYPE_S8 | CTLFLAG_MPSAFE | (access),		\
337	    ptr, val, sysctl_handle_8, "C", descr);		\
338	CTASSERT((((access) & CTLTYPE) == 0 ||			\
339	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8) && \
340	    sizeof(int8_t) == sizeof(*(ptr)))
341
342#define	SYSCTL_ADD_S8(ctx, parent, nbr, name, access, ptr, val, descr)	\
343({									\
344	int8_t *__ptr = (ptr);						\
345	CTASSERT(((access) & CTLTYPE) == 0 ||				\
346	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8);		\
347	sysctl_add_oid(ctx, parent, nbr, name,				\
348	    CTLTYPE_S8 | CTLFLAG_MPSAFE | (access),			\
349	    __ptr, val, sysctl_handle_8, "C", __DESCR(descr));	\
350})
351
352/* Oid for an unsigned 8-bit int.  If ptr is NULL, val is returned. */
353#define	SYSCTL_NULL_U8_PTR ((uint8_t *)NULL)
354#define	SYSCTL_U8(parent, nbr, name, access, ptr, val, descr)	\
355	SYSCTL_OID(parent, nbr, name,				\
356	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),		\
357	    ptr, val, sysctl_handle_8, "CU", descr);		\
358	CTASSERT((((access) & CTLTYPE) == 0 ||			\
359	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8) && \
360	    sizeof(uint8_t) == sizeof(*(ptr)))
361
362#define	SYSCTL_ADD_U8(ctx, parent, nbr, name, access, ptr, val, descr)	\
363({									\
364	uint8_t *__ptr = (ptr);						\
365	CTASSERT(((access) & CTLTYPE) == 0 ||				\
366	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8);		\
367	sysctl_add_oid(ctx, parent, nbr, name,				\
368	    CTLTYPE_U8 | CTLFLAG_MPSAFE | (access),			\
369	    __ptr, val, sysctl_handle_8, "CU", __DESCR(descr));	\
370})
371
372/* Oid for a signed 16-bit int.  If ptr is NULL, val is returned. */
373#define	SYSCTL_NULL_S16_PTR ((int16_t *)NULL)
374#define	SYSCTL_S16(parent, nbr, name, access, ptr, val, descr)	\
375	SYSCTL_OID(parent, nbr, name,				\
376	    CTLTYPE_S16 | CTLFLAG_MPSAFE | (access),		\
377	    ptr, val, sysctl_handle_16, "S", descr);		\
378	CTASSERT((((access) & CTLTYPE) == 0 ||			\
379	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16) && \
380	    sizeof(int16_t) == sizeof(*(ptr)))
381
382#define	SYSCTL_ADD_S16(ctx, parent, nbr, name, access, ptr, val, descr)	\
383({									\
384	int16_t *__ptr = (ptr);						\
385	CTASSERT(((access) & CTLTYPE) == 0 ||				\
386	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16);		\
387	sysctl_add_oid(ctx, parent, nbr, name,				\
388	    CTLTYPE_S16 | CTLFLAG_MPSAFE | (access),			\
389	    __ptr, val, sysctl_handle_16, "S", __DESCR(descr));	\
390})
391
392/* Oid for an unsigned 16-bit int.  If ptr is NULL, val is returned. */
393#define	SYSCTL_NULL_U16_PTR ((uint16_t *)NULL)
394#define	SYSCTL_U16(parent, nbr, name, access, ptr, val, descr)	\
395	SYSCTL_OID(parent, nbr, name,				\
396	    CTLTYPE_U16 | CTLFLAG_MPSAFE | (access),		\
397	    ptr, val, sysctl_handle_16, "SU", descr);		\
398	CTASSERT((((access) & CTLTYPE) == 0 ||			\
399	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16) && \
400	    sizeof(uint16_t) == sizeof(*(ptr)))
401
402#define	SYSCTL_ADD_U16(ctx, parent, nbr, name, access, ptr, val, descr)	\
403({									\
404	uint16_t *__ptr = (ptr);					\
405	CTASSERT(((access) & CTLTYPE) == 0 ||				\
406	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16);		\
407	sysctl_add_oid(ctx, parent, nbr, name,				\
408	    CTLTYPE_U16 | CTLFLAG_MPSAFE | (access),			\
409	    __ptr, val, sysctl_handle_16, "SU", __DESCR(descr));	\
410})
411
412/* Oid for a signed 32-bit int.  If ptr is NULL, val is returned. */
413#define	SYSCTL_NULL_S32_PTR ((int32_t *)NULL)
414#define	SYSCTL_S32(parent, nbr, name, access, ptr, val, descr)	\
415	SYSCTL_OID(parent, nbr, name,				\
416	    CTLTYPE_S32 | CTLFLAG_MPSAFE | (access),		\
417	    ptr, val, sysctl_handle_32, "I", descr);		\
418	CTASSERT((((access) & CTLTYPE) == 0 ||			\
419	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32) && \
420	    sizeof(int32_t) == sizeof(*(ptr)))
421
422#define	SYSCTL_ADD_S32(ctx, parent, nbr, name, access, ptr, val, descr)	\
423({									\
424	int32_t *__ptr = (ptr);						\
425	CTASSERT(((access) & CTLTYPE) == 0 ||				\
426	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32);		\
427	sysctl_add_oid(ctx, parent, nbr, name,				\
428	    CTLTYPE_S32 | CTLFLAG_MPSAFE | (access),			\
429	    __ptr, val, sysctl_handle_32, "I", __DESCR(descr));	\
430})
431
432/* Oid for an unsigned 32-bit int.  If ptr is NULL, val is returned. */
433#define	SYSCTL_NULL_U32_PTR ((uint32_t *)NULL)
434#define	SYSCTL_U32(parent, nbr, name, access, ptr, val, descr)	\
435	SYSCTL_OID(parent, nbr, name,				\
436	    CTLTYPE_U32 | CTLFLAG_MPSAFE | (access),		\
437	    ptr, val, sysctl_handle_32, "IU", descr);		\
438	CTASSERT((((access) & CTLTYPE) == 0 ||			\
439	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32) && \
440	    sizeof(uint32_t) == sizeof(*(ptr)))
441
442#define	SYSCTL_ADD_U32(ctx, parent, nbr, name, access, ptr, val, descr)	\
443({									\
444	uint32_t *__ptr = (ptr);					\
445	CTASSERT(((access) & CTLTYPE) == 0 ||				\
446	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32);		\
447	sysctl_add_oid(ctx, parent, nbr, name,				\
448	    CTLTYPE_U32 | CTLFLAG_MPSAFE | (access),			\
449	    __ptr, val, sysctl_handle_32, "IU", __DESCR(descr));	\
450})
451
452/* Oid for a signed 64-bit int.  If ptr is NULL, val is returned. */
453#define	SYSCTL_NULL_S64_PTR ((int64_t *)NULL)
454#define	SYSCTL_S64(parent, nbr, name, access, ptr, val, descr)	\
455	SYSCTL_OID(parent, nbr, name,				\
456	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),		\
457	    ptr, val, sysctl_handle_64, "Q", descr);		\
458	CTASSERT((((access) & CTLTYPE) == 0 ||			\
459	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
460	    sizeof(int64_t) == sizeof(*(ptr)))
461
462#define	SYSCTL_ADD_S64(ctx, parent, nbr, name, access, ptr, val, descr)	\
463({									\
464	int64_t *__ptr = (ptr);						\
465	CTASSERT(((access) & CTLTYPE) == 0 ||				\
466	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
467	sysctl_add_oid(ctx, parent, nbr, name,				\
468	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
469	    __ptr, val, sysctl_handle_64, "Q", __DESCR(descr));	\
470})
471
472/* Oid for an unsigned 64-bit int.  If ptr is NULL, val is returned. */
473#define	SYSCTL_NULL_U64_PTR ((uint64_t *)NULL)
474#define	SYSCTL_U64(parent, nbr, name, access, ptr, val, descr)	\
475	SYSCTL_OID(parent, nbr, name,				\
476	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),		\
477	    ptr, val, sysctl_handle_64, "QU", descr);		\
478	CTASSERT((((access) & CTLTYPE) == 0 ||			\
479	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
480	    sizeof(uint64_t) == sizeof(*(ptr)))
481
482#define	SYSCTL_ADD_U64(ctx, parent, nbr, name, access, ptr, val, descr)	\
483({									\
484	uint64_t *__ptr = (ptr);					\
485	CTASSERT(((access) & CTLTYPE) == 0 ||				\
486	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
487	sysctl_add_oid(ctx, parent, nbr, name,				\
488	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
489	    __ptr, val, sysctl_handle_64, "QU", __DESCR(descr));	\
490})
491
492/* Oid for an int.  If ptr is SYSCTL_NULL_INT_PTR, val is returned. */
493#define	SYSCTL_NULL_INT_PTR ((int *)NULL)
494#define	SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)	\
495	SYSCTL_OID(parent, nbr, name,				\
496	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),		\
497	    ptr, val, sysctl_handle_int, "I", descr);		\
498	CTASSERT((((access) & CTLTYPE) == 0 ||			\
499	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT) && \
500	    sizeof(int) == sizeof(*(ptr)))
501
502#define	SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr)	\
503({									\
504	int *__ptr = (ptr);						\
505	CTASSERT(((access) & CTLTYPE) == 0 ||				\
506	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
507	sysctl_add_oid(ctx, parent, nbr, name,				\
508	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
509	    __ptr, val, sysctl_handle_int, "I", __DESCR(descr));	\
510})
511
512/* Oid for an unsigned int.  If ptr is NULL, val is returned. */
513#define	SYSCTL_NULL_UINT_PTR ((unsigned *)NULL)
514#define	SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)	\
515	SYSCTL_OID(parent, nbr, name,				\
516	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),		\
517	    ptr, val, sysctl_handle_int, "IU", descr);		\
518	CTASSERT((((access) & CTLTYPE) == 0 ||			\
519	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT) && \
520	    sizeof(unsigned) == sizeof(*(ptr)))
521
522#define	SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
523({									\
524	unsigned *__ptr = (ptr);					\
525	CTASSERT(((access) & CTLTYPE) == 0 ||				\
526	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT);	\
527	sysctl_add_oid(ctx, parent, nbr, name,				\
528	    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),			\
529	    __ptr, val, sysctl_handle_int, "IU", __DESCR(descr));	\
530})
531
532/* Oid for a long.  The pointer must be non NULL. */
533#define	SYSCTL_NULL_LONG_PTR ((long *)NULL)
534#define	SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)	\
535	SYSCTL_OID(parent, nbr, name,				\
536	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),		\
537	    ptr, val, sysctl_handle_long, "L", descr);		\
538	CTASSERT((((access) & CTLTYPE) == 0 ||			\
539	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG) && \
540	    sizeof(long) == sizeof(*(ptr)))
541
542#define	SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)	\
543({									\
544	long *__ptr = (ptr);						\
545	CTASSERT(((access) & CTLTYPE) == 0 ||				\
546	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG);	\
547	sysctl_add_oid(ctx, parent, nbr, name,				\
548	    CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),			\
549	    __ptr, 0, sysctl_handle_long, "L", __DESCR(descr));		\
550})
551
552/* Oid for an unsigned long.  The pointer must be non NULL. */
553#define	SYSCTL_NULL_ULONG_PTR ((unsigned long *)NULL)
554#define	SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)	\
555	SYSCTL_OID(parent, nbr, name,					\
556	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
557	    ptr, val, sysctl_handle_long, "LU", descr);			\
558	CTASSERT((((access) & CTLTYPE) == 0 ||				\
559	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG) &&	\
560	    sizeof(unsigned long) == sizeof(*(ptr)))
561
562#define	SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)	\
563({									\
564	unsigned long *__ptr = (ptr);					\
565	CTASSERT(((access) & CTLTYPE) == 0 ||				\
566	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG);	\
567	sysctl_add_oid(ctx, parent, nbr, name,				\
568	    CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),			\
569	    __ptr, 0, sysctl_handle_long, "LU", __DESCR(descr));	\
570})
571
572/* Oid for a quad.  The pointer must be non NULL. */
573#define	SYSCTL_NULL_QUAD_PTR ((int64_t *)NULL)
574#define	SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)	\
575	SYSCTL_OID(parent, nbr, name,				\
576	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),		\
577	    ptr, val, sysctl_handle_64, "Q", descr);		\
578	CTASSERT((((access) & CTLTYPE) == 0 ||			\
579	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
580	    sizeof(int64_t) == sizeof(*(ptr)))
581
582#define	SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr)	\
583({									\
584	int64_t *__ptr = (ptr);						\
585	CTASSERT(((access) & CTLTYPE) == 0 ||				\
586	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64);		\
587	sysctl_add_oid(ctx, parent, nbr, name,				\
588	    CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),			\
589	    __ptr, 0, sysctl_handle_64, "Q", __DESCR(descr));		\
590})
591
592#define	SYSCTL_NULL_UQUAD_PTR ((uint64_t *)NULL)
593#define	SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)	\
594	SYSCTL_OID(parent, nbr, name,					\
595	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
596	     ptr, val, sysctl_handle_64, "QU", descr);			\
597	CTASSERT((((access) & CTLTYPE) == 0 ||				\
598	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) &&	\
599	    sizeof(uint64_t) == sizeof(*(ptr)))
600
601#define	SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr)	\
602({									\
603	uint64_t *__ptr = (ptr);					\
604	CTASSERT(((access) & CTLTYPE) == 0 ||				\
605	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
606	sysctl_add_oid(ctx, parent, nbr, name,				\
607	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
608	    __ptr, 0, sysctl_handle_64, "QU", __DESCR(descr));		\
609})
610
611/* Oid for a CPU dependent variable */
612#define	SYSCTL_ADD_UAUTO(ctx, parent, nbr, name, access, ptr, descr)	\
613({									\
614	struct sysctl_oid *__ret;					\
615	CTASSERT((sizeof(uint64_t) == sizeof(*(ptr)) ||			\
616	    sizeof(unsigned) == sizeof(*(ptr))) &&			\
617	    ((access) & CTLTYPE) == 0);					\
618	if (sizeof(uint64_t) == sizeof(*(ptr))) {			\
619		__ret = sysctl_add_oid(ctx, parent, nbr, name,		\
620		    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),		\
621		    (ptr), 0, sysctl_handle_64, "QU",			\
622		    __DESCR(descr));					\
623	} else {							\
624		__ret = sysctl_add_oid(ctx, parent, nbr, name,		\
625		    CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),		\
626		    (ptr), 0, sysctl_handle_int, "IU",			\
627		    __DESCR(descr));					\
628	}								\
629	__ret;								\
630})
631
632/* Oid for a 64-bit unsigned counter(9).  The pointer must be non NULL. */
633#define	SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr)	\
634	SYSCTL_OID(parent, nbr, name,					\
635	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
636	    (ptr), 0, sysctl_handle_counter_u64, "QU", descr);		\
637	CTASSERT((((access) & CTLTYPE) == 0 ||				\
638	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) &&	\
639	    sizeof(counter_u64_t) == sizeof(*(ptr)) &&			\
640	    sizeof(uint64_t) == sizeof(**(ptr)))
641
642#define	SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr) \
643({									\
644	counter_u64_t *__ptr = (ptr);					\
645	CTASSERT(((access) & CTLTYPE) == 0 ||				\
646	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64);		\
647	sysctl_add_oid(ctx, parent, nbr, name,				\
648	    CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),			\
649	    __ptr, 0, sysctl_handle_counter_u64, "QU", __DESCR(descr));	\
650})
651
652/* Oid for an array of counter(9)s.  The pointer and length must be non zero. */
653#define	SYSCTL_COUNTER_U64_ARRAY(parent, nbr, name, access, ptr, len, descr) \
654	SYSCTL_OID(parent, nbr, name,					\
655	    CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access),			\
656	    (ptr), (len), sysctl_handle_counter_u64_array, "S", descr);	\
657	CTASSERT((((access) & CTLTYPE) == 0 ||				\
658	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE) &&	\
659	    sizeof(counter_u64_t) == sizeof(*(ptr)) &&			\
660	    sizeof(uint64_t) == sizeof(**(ptr)))
661
662#define	SYSCTL_ADD_COUNTER_U64_ARRAY(ctx, parent, nbr, name, access,	\
663    ptr, len, descr)							\
664({									\
665	counter_u64_t *__ptr = (ptr);					\
666	CTASSERT(((access) & CTLTYPE) == 0 ||				\
667	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
668	sysctl_add_oid(ctx, parent, nbr, name,				\
669	    CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access),			\
670	    __ptr, len, sysctl_handle_counter_u64_array, "S",		\
671	    __DESCR(descr));						\
672})
673
674/* Oid for an opaque object.  Specified by a pointer and a length. */
675#define	SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)	\
676	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
677	    ptr, len, sysctl_handle_opaque, fmt, descr);		\
678	CTASSERT(((access) & CTLTYPE) == 0 ||				\
679	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
680
681#define	SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)	\
682({									\
683	CTASSERT(((access) & CTLTYPE) == 0 ||				\
684	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
685	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
686	    ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr));	\
687})
688
689/* Oid for a struct.  Specified by a pointer and a type. */
690#define	SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)	\
691	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),		\
692	    ptr, sizeof(struct type), sysctl_handle_opaque,		\
693	    "S," #type, descr);						\
694	CTASSERT(((access) & CTLTYPE) == 0 ||				\
695	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
696
697#define	SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
698({									\
699	CTASSERT(((access) & CTLTYPE) == 0 ||				\
700	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE);	\
701	sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),	\
702	    (ptr), sizeof(struct type),					\
703	    sysctl_handle_opaque, "S," #type, __DESCR(descr));		\
704})
705
706/* Oid for a procedure.  Specified by a pointer and an arg. */
707#define	SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
708	SYSCTL_OID(parent, nbr, name, (access),				\
709	    ptr, arg, handler, fmt, descr);				\
710	CTASSERT(((access) & CTLTYPE) != 0)
711
712#define	SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
713({									\
714	CTASSERT(((access) & CTLTYPE) != 0);				\
715	sysctl_add_oid(ctx, parent, nbr, name, (access),		\
716	    (ptr), (arg), (handler), (fmt), __DESCR(descr));		\
717})
718
719/* Oid to handle limits on uma(9) zone specified by pointer. */
720#define	SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr)	\
721	SYSCTL_OID(parent, nbr, name,				\
722	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),		\
723	    (ptr), 0, sysctl_handle_uma_zone_max, "I", descr);	\
724	CTASSERT(((access) & CTLTYPE) == 0 ||			\
725	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
726
727#define	SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr)	\
728({									\
729	uma_zone_t __ptr = (ptr);					\
730	CTASSERT(((access) & CTLTYPE) == 0 ||				\
731	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
732	sysctl_add_oid(ctx, parent, nbr, name,				\
733	    CTLTYPE_INT | CTLFLAG_MPSAFE | (access),			\
734	    __ptr, 0, sysctl_handle_uma_zone_max, "I", __DESCR(descr));	\
735})
736
737/* Oid to obtain current use of uma(9) zone specified by pointer. */
738#define	SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr)		\
739	SYSCTL_OID(parent, nbr, name,					\
740	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
741	    (ptr), 0, sysctl_handle_uma_zone_cur, "I", descr);		\
742	CTASSERT(((access) & CTLTYPE) == 0 ||				\
743	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
744
745#define	SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr)	\
746({									\
747	uma_zone_t __ptr = (ptr);					\
748	CTASSERT(((access) & CTLTYPE) == 0 ||				\
749	    ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT);		\
750	sysctl_add_oid(ctx, parent, nbr, name,				\
751	    CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),	\
752	    __ptr, 0, sysctl_handle_uma_zone_cur, "I", __DESCR(descr));	\
753})
754
755/*
756 * A macro to generate a read-only sysctl to indicate the presence of optional
757 * kernel features.
758 */
759#define	FEATURE(name, desc)						\
760	SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD | CTLFLAG_CAPRD, \
761	    SYSCTL_NULL_INT_PTR, 1, desc)
762
763#endif /* _KERNEL */
764
765/*
766 * Top-level identifiers
767 */
768#define	CTL_UNSPEC	0		/* unused */
769#define	CTL_KERN	1		/* "high kernel": proc, limits */
770#define	CTL_VM		2		/* virtual memory */
771#define	CTL_VFS		3		/* filesystem, mount type is next */
772#define	CTL_NET		4		/* network, see socket.h */
773#define	CTL_DEBUG	5		/* debugging parameters */
774#define	CTL_HW		6		/* generic cpu/io */
775#define	CTL_MACHDEP	7		/* machine dependent */
776#define	CTL_USER	8		/* user-level */
777#define	CTL_P1003_1B	9		/* POSIX 1003.1B */
778
779/*
780 * CTL_KERN identifiers
781 */
782#define	KERN_OSTYPE		 1	/* string: system version */
783#define	KERN_OSRELEASE		 2	/* string: system release */
784#define	KERN_OSREV		 3	/* int: system revision */
785#define	KERN_VERSION		 4	/* string: compile time info */
786#define	KERN_MAXVNODES		 5	/* int: max vnodes */
787#define	KERN_MAXPROC		 6	/* int: max processes */
788#define	KERN_MAXFILES		 7	/* int: max open files */
789#define	KERN_ARGMAX		 8	/* int: max arguments to exec */
790#define	KERN_SECURELVL		 9	/* int: system security level */
791#define	KERN_HOSTNAME		10	/* string: hostname */
792#define	KERN_HOSTID		11	/* int: host identifier */
793#define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
794#define	KERN_VNODE		13	/* struct: vnode structures */
795#define	KERN_PROC		14	/* struct: process entries */
796#define	KERN_FILE		15	/* struct: file entries */
797#define	KERN_PROF		16	/* node: kernel profiling info */
798#define	KERN_POSIX1		17	/* int: POSIX.1 version */
799#define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
800#define	KERN_JOB_CONTROL	19	/* int: is job control available */
801#define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
802#define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
803#define	KERN_NISDOMAINNAME	22	/* string: YP domain name */
804#define	KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
805#define	KERN_OSRELDATE		24	/* int: kernel release date */
806#define	KERN_NTP_PLL		25	/* node: NTP PLL control */
807#define	KERN_BOOTFILE		26	/* string: name of booted kernel */
808#define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
809#define	KERN_MAXPROCPERUID	28	/* int: max processes per uid */
810#define	KERN_DUMPDEV		29	/* struct cdev *: device to dump on */
811#define	KERN_IPC		30	/* node: anything related to IPC */
812#define	KERN_DUMMY		31	/* unused */
813#define	KERN_PS_STRINGS		32	/* int: address of PS_STRINGS */
814#define	KERN_USRSTACK		33	/* int: address of USRSTACK */
815#define	KERN_LOGSIGEXIT		34	/* int: do we log sigexit procs? */
816#define	KERN_IOV_MAX		35	/* int: value of UIO_MAXIOV */
817#define	KERN_HOSTUUID		36	/* string: host UUID identifier */
818#define	KERN_ARND		37	/* int: from arc4rand() */
819/*
820 * KERN_PROC subtypes
821 */
822#define	KERN_PROC_ALL		0	/* everything */
823#define	KERN_PROC_PID		1	/* by process id */
824#define	KERN_PROC_PGRP		2	/* by process group id */
825#define	KERN_PROC_SESSION	3	/* by session of pid */
826#define	KERN_PROC_TTY		4	/* by controlling tty */
827#define	KERN_PROC_UID		5	/* by effective uid */
828#define	KERN_PROC_RUID		6	/* by real uid */
829#define	KERN_PROC_ARGS		7	/* get/set arguments/proctitle */
830#define	KERN_PROC_PROC		8	/* only return procs */
831#define	KERN_PROC_SV_NAME	9	/* get syscall vector name */
832#define	KERN_PROC_RGID		10	/* by real group id */
833#define	KERN_PROC_GID		11	/* by effective group id */
834#define	KERN_PROC_PATHNAME	12	/* path to executable */
835#define	KERN_PROC_OVMMAP	13	/* Old VM map entries for process */
836#define	KERN_PROC_OFILEDESC	14	/* Old file descriptors for process */
837#define	KERN_PROC_KSTACK	15	/* Kernel stacks for process */
838#define	KERN_PROC_INC_THREAD	0x10	/*
839					 * modifier for pid, pgrp, tty,
840					 * uid, ruid, gid, rgid and proc
841					 * This effectively uses 16-31
842					 */
843#define	KERN_PROC_VMMAP		32	/* VM map entries for process */
844#define	KERN_PROC_FILEDESC	33	/* File descriptors for process */
845#define	KERN_PROC_GROUPS	34	/* process groups */
846#define	KERN_PROC_ENV		35	/* get environment */
847#define	KERN_PROC_AUXV		36	/* get ELF auxiliary vector */
848#define	KERN_PROC_RLIMIT	37	/* process resource limits */
849#define	KERN_PROC_PS_STRINGS	38	/* get ps_strings location */
850#define	KERN_PROC_UMASK		39	/* process umask */
851#define	KERN_PROC_OSREL		40	/* osreldate for process binary */
852#define	KERN_PROC_SIGTRAMP	41	/* signal trampoline location */
853#define	KERN_PROC_CWD		42	/* process current working directory */
854#define	KERN_PROC_NFDS		43	/* number of open file descriptors */
855
856/*
857 * KERN_IPC identifiers
858 */
859#define	KIPC_MAXSOCKBUF		1	/* int: max size of a socket buffer */
860#define	KIPC_SOCKBUF_WASTE	2	/* int: wastage factor in sockbuf */
861#define	KIPC_SOMAXCONN		3	/* int: max length of connection q */
862#define	KIPC_MAX_LINKHDR	4	/* int: max length of link header */
863#define	KIPC_MAX_PROTOHDR	5	/* int: max length of network header */
864#define	KIPC_MAX_HDR		6	/* int: max total length of headers */
865#define	KIPC_MAX_DATALEN	7	/* int: max length of data? */
866
867/*
868 * CTL_HW identifiers
869 */
870#define	HW_MACHINE	 1		/* string: machine class */
871#define	HW_MODEL	 2		/* string: specific machine model */
872#define	HW_NCPU		 3		/* int: number of cpus */
873#define	HW_BYTEORDER	 4		/* int: machine byte order */
874#define	HW_PHYSMEM	 5		/* int: total memory */
875#define	HW_USERMEM	 6		/* int: non-kernel memory */
876#define	HW_PAGESIZE	 7		/* int: software page size */
877#define	HW_DISKNAMES	 8		/* strings: disk drive names */
878#define	HW_DISKSTATS	 9		/* struct: diskstats[] */
879#define	HW_FLOATINGPT	10		/* int: has HW floating point? */
880#define	HW_MACHINE_ARCH	11		/* string: machine architecture */
881#define	HW_REALMEM	12		/* int: 'real' memory */
882
883/*
884 * CTL_USER definitions
885 */
886#define	USER_CS_PATH		 1	/* string: _CS_PATH */
887#define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
888#define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
889#define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
890#define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
891#define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
892#define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
893#define	USER_LINE_MAX		 8	/* int: LINE_MAX */
894#define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
895#define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
896#define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
897#define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
898#define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
899#define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
900#define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
901#define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
902#define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
903#define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
904#define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
905#define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
906
907#define	CTL_P1003_1B_ASYNCHRONOUS_IO		1	/* boolean */
908#define	CTL_P1003_1B_MAPPED_FILES		2	/* boolean */
909#define	CTL_P1003_1B_MEMLOCK			3	/* boolean */
910#define	CTL_P1003_1B_MEMLOCK_RANGE		4	/* boolean */
911#define	CTL_P1003_1B_MEMORY_PROTECTION		5	/* boolean */
912#define	CTL_P1003_1B_MESSAGE_PASSING		6	/* boolean */
913#define	CTL_P1003_1B_PRIORITIZED_IO		7	/* boolean */
914#define	CTL_P1003_1B_PRIORITY_SCHEDULING	8	/* boolean */
915#define	CTL_P1003_1B_REALTIME_SIGNALS		9	/* boolean */
916#define	CTL_P1003_1B_SEMAPHORES			10	/* boolean */
917#define	CTL_P1003_1B_FSYNC			11	/* boolean */
918#define	CTL_P1003_1B_SHARED_MEMORY_OBJECTS	12	/* boolean */
919#define	CTL_P1003_1B_SYNCHRONIZED_IO		13	/* boolean */
920#define	CTL_P1003_1B_TIMERS			14	/* boolean */
921#define	CTL_P1003_1B_AIO_LISTIO_MAX		15	/* int */
922#define	CTL_P1003_1B_AIO_MAX			16	/* int */
923#define	CTL_P1003_1B_AIO_PRIO_DELTA_MAX		17	/* int */
924#define	CTL_P1003_1B_DELAYTIMER_MAX		18	/* int */
925#define	CTL_P1003_1B_MQ_OPEN_MAX		19	/* int */
926#define	CTL_P1003_1B_PAGESIZE			20	/* int */
927#define	CTL_P1003_1B_RTSIG_MAX			21	/* int */
928#define	CTL_P1003_1B_SEM_NSEMS_MAX		22	/* int */
929#define	CTL_P1003_1B_SEM_VALUE_MAX		23	/* int */
930#define	CTL_P1003_1B_SIGQUEUE_MAX		24	/* int */
931#define	CTL_P1003_1B_TIMER_MAX			25	/* int */
932
933#define	CTL_P1003_1B_MAXID		26
934
935#ifdef _KERNEL
936
937/*
938 * Declare some common oids.
939 */
940extern struct sysctl_oid_list sysctl__children;
941SYSCTL_DECL(_kern);
942SYSCTL_DECL(_kern_features);
943SYSCTL_DECL(_kern_ipc);
944SYSCTL_DECL(_kern_proc);
945SYSCTL_DECL(_kern_sched);
946SYSCTL_DECL(_kern_sched_stats);
947SYSCTL_DECL(_sysctl);
948SYSCTL_DECL(_vm);
949SYSCTL_DECL(_vm_stats);
950SYSCTL_DECL(_vm_stats_misc);
951SYSCTL_DECL(_vfs);
952SYSCTL_DECL(_net);
953SYSCTL_DECL(_debug);
954SYSCTL_DECL(_debug_sizeof);
955SYSCTL_DECL(_dev);
956SYSCTL_DECL(_hw);
957SYSCTL_DECL(_hw_bus);
958SYSCTL_DECL(_hw_bus_devices);
959SYSCTL_DECL(_hw_bus_info);
960SYSCTL_DECL(_machdep);
961SYSCTL_DECL(_user);
962SYSCTL_DECL(_compat);
963SYSCTL_DECL(_regression);
964SYSCTL_DECL(_security);
965SYSCTL_DECL(_security_bsd);
966
967extern char	machine[];
968extern char	osrelease[];
969extern char	ostype[];
970extern char	kern_ident[];
971
972/* Dynamic oid handling */
973struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
974	    struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
975	    void *arg1, intmax_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
976	    const char *fmt, const char *descr);
977int	sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
978	    int recurse);
979void	sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
980int	sysctl_move_oid(struct sysctl_oid *oidp,
981	    struct sysctl_oid_list *parent);
982int	sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
983int	sysctl_ctx_init(struct sysctl_ctx_list *clist);
984int	sysctl_ctx_free(struct sysctl_ctx_list *clist);
985struct	sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
986	    struct sysctl_oid *oidp);
987struct	sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
988	    struct sysctl_oid *oidp);
989int	sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
990	    struct sysctl_oid *oidp);
991
992int	kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
993	    size_t *oldlenp, void *new, size_t newlen, size_t *retval,
994	    int flags);
995int	kernel_sysctlbyname(struct thread *td, char *name, void *old,
996	    size_t *oldlenp, void *new, size_t newlen, size_t *retval,
997	    int flags);
998int	userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
999	    size_t *oldlenp, int inkernel, void *new, size_t newlen,
1000	    size_t *retval, int flags);
1001int	sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
1002	    int *nindx, struct sysctl_req *req);
1003void	sysctl_wlock(void);
1004void	sysctl_wunlock(void);
1005int	sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
1006
1007struct sbuf;
1008struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
1009	    struct sysctl_req *);
1010#else	/* !_KERNEL */
1011#include <sys/cdefs.h>
1012
1013__BEGIN_DECLS
1014int	sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
1015int	sysctlbyname(const char *, void *, size_t *, const void *, size_t);
1016int	sysctlnametomib(const char *, int *, size_t *);
1017__END_DECLS
1018#endif	/* _KERNEL */
1019
1020#endif	/* !_SYS_SYSCTL_H_ */
1021