2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Mike Karels at Berkeley Software Design, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)sysctl.h 8.1 (Berkeley) 6/2/93
38 #ifndef _SYS_SYSCTL_H_
39 #define _SYS_SYSCTL_H_
42 #include <sys/queue.h>
46 * Definitions for sysctl call. The sysctl call uses a hierarchical name
47 * for objects that can be examined or modified. The name is expressed as
48 * a sequence of integers. Like a file path name, the meaning of each
49 * component depends on its place in the hierarchy. The top-level and kern
50 * identifiers are defined here, and other identifiers are defined in the
51 * respective subsystem header files.
53 * Each subsystem defined by sysctl defines a list of variables for that
54 * subsystem. Each name is either a node with further levels defined below it,
55 * or it is a leaf of some particular type given below. Each sysctl level
56 * defines a set of name/type pairs to be used by sysctl(8) in manipulating the
60 #define CTL_MAXNAME 24 /* largest number of components supported */
62 #define CTLTYPE 0xf /* mask for the type */
63 #define CTLTYPE_NODE 1 /* name is a node */
64 #define CTLTYPE_INT 2 /* name describes an integer */
65 #define CTLTYPE_STRING 3 /* name describes a string */
66 #define CTLTYPE_S64 4 /* name describes a signed 64-bit number */
67 #define CTLTYPE_OPAQUE 5 /* name describes a structure */
68 #define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */
69 #define CTLTYPE_UINT 6 /* name describes an unsigned integer */
70 #define CTLTYPE_LONG 7 /* name describes a long */
71 #define CTLTYPE_ULONG 8 /* name describes an unsigned long */
72 #define CTLTYPE_U64 9 /* name describes an unsigned 64-bit number */
73 #define CTLTYPE_U8 0xa /* name describes an unsigned 8-bit number */
74 #define CTLTYPE_U16 0xb /* name describes an unsigned 16-bit number */
75 #define CTLTYPE_S8 0xc /* name describes a signed 8-bit number */
76 #define CTLTYPE_S16 0xd /* name describes a signed 16-bit number */
77 #define CTLTYPE_S32 0xe /* name describes a signed 32-bit number */
78 #define CTLTYPE_U32 0xf /* name describes an unsigned 32-bit number */
80 #define CTLFLAG_RD 0x80000000 /* Allow reads of variable */
81 #define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */
82 #define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR)
83 #define CTLFLAG_DORMANT 0x20000000 /* This sysctl is not active yet */
84 #define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */
85 #define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */
86 #define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */
87 #define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */
88 #define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */
89 #define CTLMASK_SECURE 0x00F00000 /* Secure level */
90 #define CTLFLAG_TUN 0x00080000 /* Default value is loaded from getenv() */
91 #define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN)
92 #define CTLFLAG_RWTUN (CTLFLAG_RW|CTLFLAG_TUN)
93 #define CTLFLAG_MPSAFE 0x00040000 /* Handler is MP safe */
94 #define CTLFLAG_VNET 0x00020000 /* Prisons with vnet can fiddle */
95 #define CTLFLAG_DYING 0x00010000 /* Oid is being removed */
96 #define CTLFLAG_CAPRD 0x00008000 /* Can be read in capability mode */
97 #define CTLFLAG_CAPWR 0x00004000 /* Can be written in capability mode */
98 #define CTLFLAG_STATS 0x00002000 /* Statistics, not a tuneable */
99 #define CTLFLAG_NOFETCH 0x00001000 /* Don't fetch tunable from getenv() */
100 #define CTLFLAG_CAPRW (CTLFLAG_CAPRD|CTLFLAG_CAPWR)
102 * This is transient flag to be used until all sysctl handlers are converted
104 * One, and only one of CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT is required
105 * for SYSCTL_PROC and SYSCTL_NODE.
107 #define CTLFLAG_NEEDGIANT 0x00000800 /* Handler require Giant */
110 * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
112 * Secure when the securelevel is raised to at least N.
114 #define CTLSHIFT_SECURE 20
115 #define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
116 #define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
117 #define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
120 * USE THIS instead of a hardwired number from the categories below
121 * to get dynamically assigned sysctl entries using the linker-set
122 * technology. This is the way nearly all new sysctl variables should
124 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
126 #define OID_AUTO (-1)
129 * The starting number for dynamically-assigned entries. WARNING!
130 * ALL static sysctl entries should have numbers LESS than this!
132 #define CTL_AUTO_START 0x100
135 #include <sys/linker_set.h>
138 /* XXX allow overspecification of type in external kernel modules */
139 #define SYSCTL_CT_ASSERT_MASK CTLTYPE
141 #define SYSCTL_CT_ASSERT_MASK 0
144 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, \
145 intmax_t arg2, struct sysctl_req *req
147 /* definitions for sysctl_req 'lock' member */
148 #define REQ_UNWIRED 1
151 /* definitions for sysctl_req 'flags' member */
152 #ifdef COMPAT_FREEBSD32
153 #define SCTL_MASK32 1 /* 32 bit emulation */
157 * This describes the access space for a sysctl request. This is needed
158 * so that we can use the interface from the kernel or from user-space.
162 struct thread *td; /* used for access checking */
163 int lock; /* wiring state */
167 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
171 int (*newfunc)(struct sysctl_req *, void *, size_t);
176 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
179 * This describes one "oid" in the MIB tree. Potentially more nodes can
180 * be hidden behind it, expanded by the handler.
183 struct sysctl_oid_list oid_children;
184 struct sysctl_oid_list *oid_parent;
185 SLIST_ENTRY(sysctl_oid) oid_link;
190 const char *oid_name;
191 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
195 const char *oid_descr;
196 const char *oid_label;
199 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
200 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
201 #define SYSCTL_OUT_STR(r, p) (r->oldfunc)(r, p, strlen(p) + 1)
203 int sysctl_handle_bool(SYSCTL_HANDLER_ARGS);
204 int sysctl_handle_8(SYSCTL_HANDLER_ARGS);
205 int sysctl_handle_16(SYSCTL_HANDLER_ARGS);
206 int sysctl_handle_32(SYSCTL_HANDLER_ARGS);
207 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
208 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
209 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
210 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
211 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
212 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
213 int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
214 int sysctl_handle_counter_u64_array(SYSCTL_HANDLER_ARGS);
216 int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
217 int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
219 int sysctl_msec_to_sbintime(SYSCTL_HANDLER_ARGS);
220 int sysctl_usec_to_sbintime(SYSCTL_HANDLER_ARGS);
221 int sysctl_sec_to_timeval(SYSCTL_HANDLER_ARGS);
223 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
224 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
225 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
228 * These functions are used to add/remove an oid from the mib.
230 void sysctl_register_oid(struct sysctl_oid *oidp);
231 void sysctl_register_disabled_oid(struct sysctl_oid *oidp);
232 void sysctl_enable_oid(struct sysctl_oid *oidp);
233 void sysctl_unregister_oid(struct sysctl_oid *oidp);
235 /* Declare a static oid to allow child oids to be added to it. */
236 #define SYSCTL_DECL(name) \
237 extern struct sysctl_oid sysctl__##name
239 /* Hide these in macros. */
240 #define SYSCTL_CHILDREN(oid_ptr) (&(oid_ptr)->oid_children)
241 #define SYSCTL_PARENT(oid_ptr) \
242 (((oid_ptr)->oid_parent != &sysctl__children) ? \
243 __containerof((oid_ptr)->oid_parent, struct sysctl_oid, \
244 oid_children) : (struct sysctl_oid *)NULL)
245 #define SYSCTL_STATIC_CHILDREN(oid_name) (&sysctl__##oid_name.oid_children)
247 /* === Structs and macros related to context handling. === */
249 /* All dynamically created sysctls can be tracked in a context list. */
250 struct sysctl_ctx_entry {
251 struct sysctl_oid *entry;
252 TAILQ_ENTRY(sysctl_ctx_entry) link;
255 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
257 #define SYSCTL_NODE_CHILDREN(parent, name) \
258 sysctl__##parent##_##name.oid_children
260 #ifndef NO_SYSCTL_DESCR
263 #define __DESCR(d) ""
267 #define SYSCTL_ENFORCE_FLAGS(x) \
268 _Static_assert((((x) & CTLFLAG_MPSAFE) != 0) ^ (((x) & CTLFLAG_NEEDGIANT) != 0), \
269 "Has to be either CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT")
271 #define SYSCTL_ENFORCE_FLAGS(x)
274 /* This macro is only for internal use */
275 #define SYSCTL_OID_RAW(id, parent_child_head, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
276 struct sysctl_oid id = { \
277 .oid_parent = (parent_child_head), \
278 .oid_children = SLIST_HEAD_INITIALIZER(&id.oid_children), \
279 .oid_number = (nbr), \
280 .oid_kind = (kind), \
283 .oid_name = (name), \
284 .oid_handler = (handler), \
286 .oid_descr = __DESCR(descr), \
287 .oid_label = (label), \
289 DATA_SET(sysctl_set, id); \
290 SYSCTL_ENFORCE_FLAGS(kind)
292 /* This constructs a static "raw" MIB oid. */
293 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
294 SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2, \
295 handler, fmt, descr, NULL)
297 #define SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
298 static SYSCTL_OID_RAW(sysctl__##parent##_##name, \
299 SYSCTL_CHILDREN(&sysctl__##parent), \
300 nbr, #name, kind, a1, a2, handler, fmt, descr, label)
302 /* This constructs a global "raw" MIB oid. */
303 #define SYSCTL_OID_GLOBAL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
304 SYSCTL_OID_RAW(sysctl__##parent##_##name, \
305 SYSCTL_CHILDREN(&sysctl__##parent), \
306 nbr, #name, kind, a1, a2, handler, fmt, descr, label)
308 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
310 SYSCTL_ENFORCE_FLAGS(kind); \
311 sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2,handler, \
312 fmt, __DESCR(descr), NULL); \
315 /* This constructs a root node from which other nodes can hang. */
316 #define SYSCTL_ROOT_NODE(nbr, name, access, handler, descr) \
317 SYSCTL_OID_RAW(sysctl___##name, &sysctl__children, \
318 nbr, #name, CTLTYPE_NODE|(access), NULL, 0, \
319 handler, "N", descr, NULL); \
320 CTASSERT(((access) & CTLTYPE) == 0 || \
321 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
323 /* This constructs a node from which other oids can hang. */
324 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
325 SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, NULL)
327 #define SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, label) \
328 SYSCTL_OID_GLOBAL(parent, nbr, name, CTLTYPE_NODE|(access), \
329 NULL, 0, handler, "N", descr, label); \
330 SYSCTL_ENFORCE_FLAGS(access); \
331 CTASSERT(((access) & CTLTYPE) == 0 || \
332 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
334 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \
335 SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, \
336 handler, descr, NULL)
338 #define SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, handler, descr, label) \
340 CTASSERT(((access) & CTLTYPE) == 0 || \
341 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE); \
342 SYSCTL_ENFORCE_FLAGS(access); \
343 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \
344 NULL, 0, handler, "N", __DESCR(descr), label); \
347 #define SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr) \
349 CTASSERT(((access) & CTLTYPE) == 0 || \
350 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE); \
351 SYSCTL_ENFORCE_FLAGS(access); \
352 sysctl_add_oid(ctx, &sysctl__children, nbr, name, \
353 CTLTYPE_NODE|(access), \
354 NULL, 0, handler, "N", __DESCR(descr), NULL); \
357 /* Oid for a string. len can be 0 to indicate '\0' termination. */
358 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
359 SYSCTL_OID(parent, nbr, name, \
360 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), \
361 arg, len, sysctl_handle_string, "A", descr); \
362 CTASSERT(((access) & CTLTYPE) == 0 || \
363 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
365 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
367 char *__arg = (arg); \
368 CTASSERT(((access) & CTLTYPE) == 0 || \
369 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING); \
370 sysctl_add_oid(ctx, parent, nbr, name, \
371 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), \
372 __arg, len, sysctl_handle_string, "A", __DESCR(descr), \
376 /* Oid for a constant '\0' terminated string. */
377 #define SYSCTL_CONST_STRING(parent, nbr, name, access, arg, descr) \
378 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING | CTLFLAG_MPSAFE | (access),\
379 __DECONST(char *, arg), 0, sysctl_handle_string, "A", descr); \
380 CTASSERT(!(access & CTLFLAG_WR)); \
381 CTASSERT(((access) & CTLTYPE) == 0 || \
382 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
384 #define SYSCTL_ADD_CONST_STRING(ctx, parent, nbr, name, access, arg, descr) \
386 char *__arg = __DECONST(char *, arg); \
387 CTASSERT(!(access & CTLFLAG_WR)); \
388 CTASSERT(((access) & CTLTYPE) == 0 || \
389 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING); \
390 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING | \
391 CTLFLAG_MPSAFE | (access), __arg, 0, sysctl_handle_string, "A",\
392 __DESCR(descr), NULL); \
395 /* Oid for a bool. If ptr is NULL, val is returned. */
396 #define SYSCTL_NULL_BOOL_PTR ((bool *)NULL)
397 #define SYSCTL_BOOL(parent, nbr, name, access, ptr, val, descr) \
398 SYSCTL_OID(parent, nbr, name, \
399 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
400 ptr, val, sysctl_handle_bool, "CU", descr); \
401 CTASSERT(((access) & CTLTYPE) == 0 && \
402 sizeof(bool) == sizeof(*(ptr)))
404 #define SYSCTL_ADD_BOOL(ctx, parent, nbr, name, access, ptr, val, descr) \
406 bool *__ptr = (ptr); \
407 CTASSERT(((access) & CTLTYPE) == 0); \
408 sysctl_add_oid(ctx, parent, nbr, name, \
409 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
410 __ptr, val, sysctl_handle_bool, "CU", __DESCR(descr), \
414 /* Oid for a signed 8-bit int. If ptr is NULL, val is returned. */
415 #define SYSCTL_NULL_S8_PTR ((int8_t *)NULL)
416 #define SYSCTL_S8(parent, nbr, name, access, ptr, val, descr) \
417 SYSCTL_OID(parent, nbr, name, \
418 CTLTYPE_S8 | CTLFLAG_MPSAFE | (access), \
419 ptr, val, sysctl_handle_8, "C", descr); \
420 CTASSERT((((access) & CTLTYPE) == 0 || \
421 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8) && \
422 sizeof(int8_t) == sizeof(*(ptr)))
424 #define SYSCTL_ADD_S8(ctx, parent, nbr, name, access, ptr, val, descr) \
426 int8_t *__ptr = (ptr); \
427 CTASSERT(((access) & CTLTYPE) == 0 || \
428 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8); \
429 sysctl_add_oid(ctx, parent, nbr, name, \
430 CTLTYPE_S8 | CTLFLAG_MPSAFE | (access), \
431 __ptr, val, sysctl_handle_8, "C", __DESCR(descr), NULL); \
434 /* Oid for an unsigned 8-bit int. If ptr is NULL, val is returned. */
435 #define SYSCTL_NULL_U8_PTR ((uint8_t *)NULL)
436 #define SYSCTL_U8(parent, nbr, name, access, ptr, val, descr) \
437 SYSCTL_OID(parent, nbr, name, \
438 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
439 ptr, val, sysctl_handle_8, "CU", descr); \
440 CTASSERT((((access) & CTLTYPE) == 0 || \
441 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8) && \
442 sizeof(uint8_t) == sizeof(*(ptr)))
444 #define SYSCTL_ADD_U8(ctx, parent, nbr, name, access, ptr, val, descr) \
446 uint8_t *__ptr = (ptr); \
447 CTASSERT(((access) & CTLTYPE) == 0 || \
448 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8); \
449 sysctl_add_oid(ctx, parent, nbr, name, \
450 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
451 __ptr, val, sysctl_handle_8, "CU", __DESCR(descr), NULL); \
454 /* Oid for a signed 16-bit int. If ptr is NULL, val is returned. */
455 #define SYSCTL_NULL_S16_PTR ((int16_t *)NULL)
456 #define SYSCTL_S16(parent, nbr, name, access, ptr, val, descr) \
457 SYSCTL_OID(parent, nbr, name, \
458 CTLTYPE_S16 | CTLFLAG_MPSAFE | (access), \
459 ptr, val, sysctl_handle_16, "S", descr); \
460 CTASSERT((((access) & CTLTYPE) == 0 || \
461 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16) && \
462 sizeof(int16_t) == sizeof(*(ptr)))
464 #define SYSCTL_ADD_S16(ctx, parent, nbr, name, access, ptr, val, descr) \
466 int16_t *__ptr = (ptr); \
467 CTASSERT(((access) & CTLTYPE) == 0 || \
468 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16); \
469 sysctl_add_oid(ctx, parent, nbr, name, \
470 CTLTYPE_S16 | CTLFLAG_MPSAFE | (access), \
471 __ptr, val, sysctl_handle_16, "S", __DESCR(descr), NULL); \
474 /* Oid for an unsigned 16-bit int. If ptr is NULL, val is returned. */
475 #define SYSCTL_NULL_U16_PTR ((uint16_t *)NULL)
476 #define SYSCTL_U16(parent, nbr, name, access, ptr, val, descr) \
477 SYSCTL_OID(parent, nbr, name, \
478 CTLTYPE_U16 | CTLFLAG_MPSAFE | (access), \
479 ptr, val, sysctl_handle_16, "SU", descr); \
480 CTASSERT((((access) & CTLTYPE) == 0 || \
481 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16) && \
482 sizeof(uint16_t) == sizeof(*(ptr)))
484 #define SYSCTL_ADD_U16(ctx, parent, nbr, name, access, ptr, val, descr) \
486 uint16_t *__ptr = (ptr); \
487 CTASSERT(((access) & CTLTYPE) == 0 || \
488 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16); \
489 sysctl_add_oid(ctx, parent, nbr, name, \
490 CTLTYPE_U16 | CTLFLAG_MPSAFE | (access), \
491 __ptr, val, sysctl_handle_16, "SU", __DESCR(descr), NULL); \
494 /* Oid for a signed 32-bit int. If ptr is NULL, val is returned. */
495 #define SYSCTL_NULL_S32_PTR ((int32_t *)NULL)
496 #define SYSCTL_S32(parent, nbr, name, access, ptr, val, descr) \
497 SYSCTL_OID(parent, nbr, name, \
498 CTLTYPE_S32 | CTLFLAG_MPSAFE | (access), \
499 ptr, val, sysctl_handle_32, "I", descr); \
500 CTASSERT((((access) & CTLTYPE) == 0 || \
501 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32) && \
502 sizeof(int32_t) == sizeof(*(ptr)))
504 #define SYSCTL_ADD_S32(ctx, parent, nbr, name, access, ptr, val, descr) \
506 int32_t *__ptr = (ptr); \
507 CTASSERT(((access) & CTLTYPE) == 0 || \
508 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32); \
509 sysctl_add_oid(ctx, parent, nbr, name, \
510 CTLTYPE_S32 | CTLFLAG_MPSAFE | (access), \
511 __ptr, val, sysctl_handle_32, "I", __DESCR(descr), NULL); \
514 /* Oid for an unsigned 32-bit int. If ptr is NULL, val is returned. */
515 #define SYSCTL_NULL_U32_PTR ((uint32_t *)NULL)
516 #define SYSCTL_U32(parent, nbr, name, access, ptr, val, descr) \
517 SYSCTL_OID(parent, nbr, name, \
518 CTLTYPE_U32 | CTLFLAG_MPSAFE | (access), \
519 ptr, val, sysctl_handle_32, "IU", descr); \
520 CTASSERT((((access) & CTLTYPE) == 0 || \
521 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32) && \
522 sizeof(uint32_t) == sizeof(*(ptr)))
524 #define SYSCTL_ADD_U32(ctx, parent, nbr, name, access, ptr, val, descr) \
526 uint32_t *__ptr = (ptr); \
527 CTASSERT(((access) & CTLTYPE) == 0 || \
528 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32); \
529 sysctl_add_oid(ctx, parent, nbr, name, \
530 CTLTYPE_U32 | CTLFLAG_MPSAFE | (access), \
531 __ptr, val, sysctl_handle_32, "IU", __DESCR(descr), NULL); \
534 /* Oid for a signed 64-bit int. If ptr is NULL, val is returned. */
535 #define SYSCTL_NULL_S64_PTR ((int64_t *)NULL)
536 #define SYSCTL_S64(parent, nbr, name, access, ptr, val, descr) \
537 SYSCTL_OID(parent, nbr, name, \
538 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
539 ptr, val, sysctl_handle_64, "Q", descr); \
540 CTASSERT((((access) & CTLTYPE) == 0 || \
541 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
542 sizeof(int64_t) == sizeof(*(ptr)))
544 #define SYSCTL_ADD_S64(ctx, parent, nbr, name, access, ptr, val, descr) \
546 int64_t *__ptr = (ptr); \
547 CTASSERT(((access) & CTLTYPE) == 0 || \
548 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
549 sysctl_add_oid(ctx, parent, nbr, name, \
550 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
551 __ptr, val, sysctl_handle_64, "Q", __DESCR(descr), NULL); \
554 /* Oid for an unsigned 64-bit int. If ptr is NULL, val is returned. */
555 #define SYSCTL_NULL_U64_PTR ((uint64_t *)NULL)
556 #define SYSCTL_U64(parent, nbr, name, access, ptr, val, descr) \
557 SYSCTL_OID(parent, nbr, name, \
558 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
559 ptr, val, sysctl_handle_64, "QU", descr); \
560 CTASSERT((((access) & CTLTYPE) == 0 || \
561 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
562 sizeof(uint64_t) == sizeof(*(ptr)))
564 #define SYSCTL_ADD_U64(ctx, parent, nbr, name, access, ptr, val, descr) \
566 uint64_t *__ptr = (ptr); \
567 CTASSERT(((access) & CTLTYPE) == 0 || \
568 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
569 sysctl_add_oid(ctx, parent, nbr, name, \
570 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
571 __ptr, val, sysctl_handle_64, "QU", __DESCR(descr), NULL); \
574 /* Oid for an int. If ptr is SYSCTL_NULL_INT_PTR, val is returned. */
575 #define SYSCTL_NULL_INT_PTR ((int *)NULL)
576 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
577 SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, NULL)
579 #define SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, label) \
580 SYSCTL_OID_WITH_LABEL(parent, nbr, name, \
581 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
582 ptr, val, sysctl_handle_int, "I", descr, label); \
583 CTASSERT((((access) & CTLTYPE) == 0 || \
584 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT) && \
585 sizeof(int) == sizeof(*(ptr)))
587 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \
589 int *__ptr = (ptr); \
590 CTASSERT(((access) & CTLTYPE) == 0 || \
591 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
592 sysctl_add_oid(ctx, parent, nbr, name, \
593 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
594 __ptr, val, sysctl_handle_int, "I", __DESCR(descr), NULL); \
597 /* Oid for an unsigned int. If ptr is NULL, val is returned. */
598 #define SYSCTL_NULL_UINT_PTR ((unsigned *)NULL)
599 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
600 SYSCTL_OID(parent, nbr, name, \
601 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
602 ptr, val, sysctl_handle_int, "IU", descr); \
603 CTASSERT((((access) & CTLTYPE) == 0 || \
604 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT) && \
605 sizeof(unsigned) == sizeof(*(ptr)))
607 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
609 unsigned *__ptr = (ptr); \
610 CTASSERT(((access) & CTLTYPE) == 0 || \
611 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT); \
612 sysctl_add_oid(ctx, parent, nbr, name, \
613 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
614 __ptr, val, sysctl_handle_int, "IU", __DESCR(descr), NULL); \
617 /* Oid for a long. The pointer must be non NULL. */
618 #define SYSCTL_NULL_LONG_PTR ((long *)NULL)
619 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \
620 SYSCTL_OID(parent, nbr, name, \
621 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
622 ptr, val, sysctl_handle_long, "L", descr); \
623 CTASSERT((((access) & CTLTYPE) == 0 || \
624 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG) && \
625 sizeof(long) == sizeof(*(ptr)))
627 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \
629 long *__ptr = (ptr); \
630 CTASSERT(((access) & CTLTYPE) == 0 || \
631 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG); \
632 sysctl_add_oid(ctx, parent, nbr, name, \
633 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
634 __ptr, 0, sysctl_handle_long, "L", __DESCR(descr), NULL); \
637 /* Oid for an unsigned long. The pointer must be non NULL. */
638 #define SYSCTL_NULL_ULONG_PTR ((unsigned long *)NULL)
639 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \
640 SYSCTL_OID(parent, nbr, name, \
641 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
642 ptr, val, sysctl_handle_long, "LU", descr); \
643 CTASSERT((((access) & CTLTYPE) == 0 || \
644 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG) && \
645 sizeof(unsigned long) == sizeof(*(ptr)))
647 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \
649 unsigned long *__ptr = (ptr); \
650 CTASSERT(((access) & CTLTYPE) == 0 || \
651 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG); \
652 sysctl_add_oid(ctx, parent, nbr, name, \
653 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
654 __ptr, 0, sysctl_handle_long, "LU", __DESCR(descr), NULL); \
657 /* Oid for a quad. The pointer must be non NULL. */
658 #define SYSCTL_NULL_QUAD_PTR ((int64_t *)NULL)
659 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \
660 SYSCTL_OID(parent, nbr, name, \
661 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
662 ptr, val, sysctl_handle_64, "Q", descr); \
663 CTASSERT((((access) & CTLTYPE) == 0 || \
664 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
665 sizeof(int64_t) == sizeof(*(ptr)))
667 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \
669 int64_t *__ptr = (ptr); \
670 CTASSERT(((access) & CTLTYPE) == 0 || \
671 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
672 sysctl_add_oid(ctx, parent, nbr, name, \
673 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
674 __ptr, 0, sysctl_handle_64, "Q", __DESCR(descr), NULL); \
677 #define SYSCTL_NULL_UQUAD_PTR ((uint64_t *)NULL)
678 #define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr) \
679 SYSCTL_OID(parent, nbr, name, \
680 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
681 ptr, val, sysctl_handle_64, "QU", descr); \
682 CTASSERT((((access) & CTLTYPE) == 0 || \
683 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
684 sizeof(uint64_t) == sizeof(*(ptr)))
686 #define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr) \
688 uint64_t *__ptr = (ptr); \
689 CTASSERT(((access) & CTLTYPE) == 0 || \
690 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
691 sysctl_add_oid(ctx, parent, nbr, name, \
692 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
693 __ptr, 0, sysctl_handle_64, "QU", __DESCR(descr), NULL); \
696 /* Oid for a CPU dependent variable */
697 #define SYSCTL_ADD_UAUTO(ctx, parent, nbr, name, access, ptr, descr) \
699 struct sysctl_oid *__ret; \
700 CTASSERT((sizeof(uint64_t) == sizeof(*(ptr)) || \
701 sizeof(unsigned) == sizeof(*(ptr))) && \
702 ((access) & CTLTYPE) == 0); \
703 if (sizeof(uint64_t) == sizeof(*(ptr))) { \
704 __ret = sysctl_add_oid(ctx, parent, nbr, name, \
705 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
706 (ptr), 0, sysctl_handle_64, "QU", \
707 __DESCR(descr), NULL); \
709 __ret = sysctl_add_oid(ctx, parent, nbr, name, \
710 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
711 (ptr), 0, sysctl_handle_int, "IU", \
712 __DESCR(descr), NULL); \
717 /* Oid for a 64-bit unsigned counter(9). The pointer must be non NULL. */
718 #define SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr) \
719 SYSCTL_OID(parent, nbr, name, \
720 CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
721 (ptr), 0, sysctl_handle_counter_u64, "QU", descr); \
722 CTASSERT((((access) & CTLTYPE) == 0 || \
723 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
724 sizeof(counter_u64_t) == sizeof(*(ptr)) && \
725 sizeof(uint64_t) == sizeof(**(ptr)))
727 #define SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr) \
729 counter_u64_t *__ptr = (ptr); \
730 CTASSERT(((access) & CTLTYPE) == 0 || \
731 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
732 sysctl_add_oid(ctx, parent, nbr, name, \
733 CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
734 __ptr, 0, sysctl_handle_counter_u64, "QU", __DESCR(descr), \
738 /* Oid for an array of counter(9)s. The pointer and length must be non zero. */
739 #define SYSCTL_COUNTER_U64_ARRAY(parent, nbr, name, access, ptr, len, descr) \
740 SYSCTL_OID(parent, nbr, name, \
741 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
742 (ptr), (len), sysctl_handle_counter_u64_array, "S", descr); \
743 CTASSERT((((access) & CTLTYPE) == 0 || \
744 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE) && \
745 sizeof(counter_u64_t) == sizeof(*(ptr)) && \
746 sizeof(uint64_t) == sizeof(**(ptr)))
748 #define SYSCTL_ADD_COUNTER_U64_ARRAY(ctx, parent, nbr, name, access, \
751 counter_u64_t *__ptr = (ptr); \
752 CTASSERT(((access) & CTLTYPE) == 0 || \
753 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
754 sysctl_add_oid(ctx, parent, nbr, name, \
755 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
756 __ptr, len, sysctl_handle_counter_u64_array, "S", \
757 __DESCR(descr), NULL); \
760 /* Oid for an opaque object. Specified by a pointer and a length. */
761 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
762 SYSCTL_OID(parent, nbr, name, \
763 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
764 ptr, len, sysctl_handle_opaque, fmt, descr); \
765 CTASSERT(((access) & CTLTYPE) == 0 || \
766 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
768 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr) \
770 CTASSERT(((access) & CTLTYPE) == 0 || \
771 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
772 sysctl_add_oid(ctx, parent, nbr, name, \
773 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
774 ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr), NULL); \
777 /* Oid for a struct. Specified by a pointer and a type. */
778 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
779 SYSCTL_OID(parent, nbr, name, \
780 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
781 ptr, sizeof(struct type), sysctl_handle_opaque, \
782 "S," #type, descr); \
783 CTASSERT(((access) & CTLTYPE) == 0 || \
784 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
786 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
788 CTASSERT(((access) & CTLTYPE) == 0 || \
789 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
790 sysctl_add_oid(ctx, parent, nbr, name, \
791 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
792 (ptr), sizeof(struct type), \
793 sysctl_handle_opaque, "S," #type, __DESCR(descr), NULL); \
796 /* Oid for a procedure. Specified by a pointer and an arg. */
797 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
798 SYSCTL_OID(parent, nbr, name, (access), \
799 ptr, arg, handler, fmt, descr); \
800 CTASSERT(((access) & CTLTYPE) != 0)
802 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
804 CTASSERT(((access) & CTLTYPE) != 0); \
805 SYSCTL_ENFORCE_FLAGS(access); \
806 sysctl_add_oid(ctx, parent, nbr, name, (access), \
807 (ptr), (arg), (handler), (fmt), __DESCR(descr), NULL); \
810 /* Oid to handle limits on uma(9) zone specified by pointer. */
811 #define SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr) \
812 SYSCTL_OID(parent, nbr, name, \
813 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
814 (ptr), 0, sysctl_handle_uma_zone_max, "I", descr); \
815 CTASSERT(((access) & CTLTYPE) == 0 || \
816 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
818 #define SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr) \
820 uma_zone_t __ptr = (ptr); \
821 CTASSERT(((access) & CTLTYPE) == 0 || \
822 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
823 sysctl_add_oid(ctx, parent, nbr, name, \
824 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
825 __ptr, 0, sysctl_handle_uma_zone_max, "I", __DESCR(descr), \
829 /* Oid to obtain current use of uma(9) zone specified by pointer. */
830 #define SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr) \
831 SYSCTL_OID(parent, nbr, name, \
832 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
833 (ptr), 0, sysctl_handle_uma_zone_cur, "I", descr); \
834 CTASSERT(((access) & CTLTYPE) == 0 || \
835 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
837 #define SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr) \
839 uma_zone_t __ptr = (ptr); \
840 CTASSERT(((access) & CTLTYPE) == 0 || \
841 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
842 sysctl_add_oid(ctx, parent, nbr, name, \
843 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
844 __ptr, 0, sysctl_handle_uma_zone_cur, "I", __DESCR(descr), \
848 /* OID expressing a sbintime_t as microseconds */
849 #define SYSCTL_SBINTIME_USEC(parent, nbr, name, access, ptr, descr) \
850 SYSCTL_OID(parent, nbr, name, \
851 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
852 (ptr), 0, sysctl_usec_to_sbintime, "Q", descr); \
853 CTASSERT(((access) & CTLTYPE) == 0 || \
854 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
855 #define SYSCTL_ADD_SBINTIME_USEC(ctx, parent, nbr, name, access, ptr, descr) \
857 sbintime_t *__ptr = (ptr); \
858 CTASSERT(((access) & CTLTYPE) == 0 || \
859 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
860 sysctl_add_oid(ctx, parent, nbr, name, \
861 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
862 __ptr, 0, sysctl_usec_to_sbintime, "Q", __DESCR(descr), \
866 /* OID expressing a sbintime_t as milliseconds */
867 #define SYSCTL_SBINTIME_MSEC(parent, nbr, name, access, ptr, descr) \
868 SYSCTL_OID(parent, nbr, name, \
869 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
870 (ptr), 0, sysctl_msec_to_sbintime, "Q", descr); \
871 CTASSERT(((access) & CTLTYPE) == 0 || \
872 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
873 #define SYSCTL_ADD_SBINTIME_MSEC(ctx, parent, nbr, name, access, ptr, descr) \
875 sbintime_t *__ptr = (ptr); \
876 CTASSERT(((access) & CTLTYPE) == 0 || \
877 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
878 sysctl_add_oid(ctx, parent, nbr, name, \
879 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
880 __ptr, 0, sysctl_msec_to_sbintime, "Q", __DESCR(descr), \
884 /* OID expressing a struct timeval as seconds */
885 #define SYSCTL_TIMEVAL_SEC(parent, nbr, name, access, ptr, descr) \
886 SYSCTL_OID(parent, nbr, name, \
887 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
888 (ptr), 0, sysctl_sec_to_timeval, "I", descr); \
889 CTASSERT(((access) & CTLTYPE) == 0 || \
890 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
891 #define SYSCTL_ADD_TIMEVAL_SEC(ctx, parent, nbr, name, access, ptr, descr) \
893 struct timeval *__ptr = (ptr); \
894 CTASSERT(((access) & CTLTYPE) == 0 || \
895 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
896 sysctl_add_oid(ctx, parent, nbr, name, \
897 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
898 __ptr, 0, sysctl_sec_to_timeval, "I", __DESCR(descr), \
903 * A macro to generate a read-only sysctl to indicate the presence of optional
906 #define FEATURE(name, desc) \
907 SYSCTL_INT_WITH_LABEL(_kern_features, OID_AUTO, name, \
908 CTLFLAG_RD | CTLFLAG_CAPRD, SYSCTL_NULL_INT_PTR, 1, desc, "feature")
913 * Top-level identifiers
915 #define CTL_SYSCTL 0 /* "magic" numbers */
916 #define CTL_KERN 1 /* "high kernel": proc, limits */
917 #define CTL_VM 2 /* virtual memory */
918 #define CTL_VFS 3 /* filesystem, mount type is next */
919 #define CTL_NET 4 /* network, see socket.h */
920 #define CTL_DEBUG 5 /* debugging parameters */
921 #define CTL_HW 6 /* generic cpu/io */
922 #define CTL_MACHDEP 7 /* machine dependent */
923 #define CTL_USER 8 /* user-level */
924 #define CTL_P1003_1B 9 /* POSIX 1003.1B */
927 * CTL_SYSCTL identifiers
929 #define CTL_SYSCTL_DEBUG 0 /* printf all nodes */
930 #define CTL_SYSCTL_NAME 1 /* string name of OID */
931 #define CTL_SYSCTL_NEXT 2 /* next OID, honoring CTLFLAG_SKIP */
932 #define CTL_SYSCTL_NAME2OID 3 /* int array of name */
933 #define CTL_SYSCTL_OIDFMT 4 /* OID's kind and format */
934 #define CTL_SYSCTL_OIDDESCR 5 /* OID's description */
935 #define CTL_SYSCTL_OIDLABEL 6 /* aggregation label */
936 #define CTL_SYSCTL_NEXTNOSKIP 7 /* next OID, ignoring CTLFLAG_SKIP */
939 * CTL_KERN identifiers
941 #define KERN_OSTYPE 1 /* string: system version */
942 #define KERN_OSRELEASE 2 /* string: system release */
943 #define KERN_OSREV 3 /* int: system revision */
944 #define KERN_VERSION 4 /* string: compile time info */
945 #define KERN_MAXVNODES 5 /* int: max vnodes */
946 #define KERN_MAXPROC 6 /* int: max processes */
947 #define KERN_MAXFILES 7 /* int: max open files */
948 #define KERN_ARGMAX 8 /* int: max arguments to exec */
949 #define KERN_SECURELVL 9 /* int: system security level */
950 #define KERN_HOSTNAME 10 /* string: hostname */
951 #define KERN_HOSTID 11 /* int: host identifier */
952 #define KERN_CLOCKRATE 12 /* struct: struct clockrate */
953 #define KERN_VNODE 13 /* struct: vnode structures */
954 #define KERN_PROC 14 /* struct: process entries */
955 #define KERN_FILE 15 /* struct: file entries */
956 #define KERN_PROF 16 /* node: kernel profiling info */
957 #define KERN_POSIX1 17 /* int: POSIX.1 version */
958 #define KERN_NGROUPS 18 /* int: # of supplemental group ids */
959 #define KERN_JOB_CONTROL 19 /* int: is job control available */
960 #define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */
961 #define KERN_BOOTTIME 21 /* struct: time kernel was booted */
962 #define KERN_NISDOMAINNAME 22 /* string: YP domain name */
963 #define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */
964 #define KERN_OSRELDATE 24 /* int: kernel release date */
965 #define KERN_NTP_PLL 25 /* node: NTP PLL control */
966 #define KERN_BOOTFILE 26 /* string: name of booted kernel */
967 #define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */
968 #define KERN_MAXPROCPERUID 28 /* int: max processes per uid */
969 #define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */
970 #define KERN_IPC 30 /* node: anything related to IPC */
971 #define KERN_DUMMY 31 /* unused */
972 #define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */
973 #define KERN_USRSTACK 33 /* int: address of USRSTACK */
974 #define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */
975 #define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */
976 #define KERN_HOSTUUID 36 /* string: host UUID identifier */
977 #define KERN_ARND 37 /* int: from arc4rand() */
978 #define KERN_MAXPHYS 38 /* int: MAXPHYS value */
979 #define KERN_LOCKF 39 /* struct: lockf reports */
983 #define KERN_PROC_ALL 0 /* everything */
984 #define KERN_PROC_PID 1 /* by process id */
985 #define KERN_PROC_PGRP 2 /* by process group id */
986 #define KERN_PROC_SESSION 3 /* by session of pid */
987 #define KERN_PROC_TTY 4 /* by controlling tty */
988 #define KERN_PROC_UID 5 /* by effective uid */
989 #define KERN_PROC_RUID 6 /* by real uid */
990 #define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */
991 #define KERN_PROC_PROC 8 /* only return procs */
992 #define KERN_PROC_SV_NAME 9 /* get syscall vector name */
993 #define KERN_PROC_RGID 10 /* by real group id */
994 #define KERN_PROC_GID 11 /* by effective group id */
995 #define KERN_PROC_PATHNAME 12 /* path to executable */
996 #define KERN_PROC_OVMMAP 13 /* Old VM map entries for process */
997 #define KERN_PROC_OFILEDESC 14 /* Old file descriptors for process */
998 #define KERN_PROC_KSTACK 15 /* Kernel stacks for process */
999 #define KERN_PROC_INC_THREAD 0x10 /*
1000 * modifier for pid, pgrp, tty,
1001 * uid, ruid, gid, rgid and proc
1002 * This effectively uses 16-31
1004 #define KERN_PROC_VMMAP 32 /* VM map entries for process */
1005 #define KERN_PROC_FILEDESC 33 /* File descriptors for process */
1006 #define KERN_PROC_GROUPS 34 /* process groups */
1007 #define KERN_PROC_ENV 35 /* get environment */
1008 #define KERN_PROC_AUXV 36 /* get ELF auxiliary vector */
1009 #define KERN_PROC_RLIMIT 37 /* process resource limits */
1010 #define KERN_PROC_PS_STRINGS 38 /* get ps_strings location */
1011 #define KERN_PROC_UMASK 39 /* process umask */
1012 #define KERN_PROC_OSREL 40 /* osreldate for process binary */
1013 #define KERN_PROC_SIGTRAMP 41 /* signal trampoline location */
1014 #define KERN_PROC_CWD 42 /* process current working directory */
1015 #define KERN_PROC_NFDS 43 /* number of open file descriptors */
1016 #define KERN_PROC_SIGFASTBLK 44 /* address of fastsigblk magic word */
1017 #define KERN_PROC_VM_LAYOUT 45 /* virtual address space layout info */
1020 * KERN_IPC identifiers
1022 #define KIPC_MAXSOCKBUF 1 /* int: max size of a socket buffer */
1023 #define KIPC_SOCKBUF_WASTE 2 /* int: wastage factor in sockbuf */
1024 #define KIPC_SOMAXCONN 3 /* int: max length of connection q */
1025 #define KIPC_MAX_LINKHDR 4 /* int: max length of link header */
1026 #define KIPC_MAX_PROTOHDR 5 /* int: max length of network header */
1027 #define KIPC_MAX_HDR 6 /* int: max total length of headers */
1028 #define KIPC_MAX_DATALEN 7 /* int: max length of data? */
1031 * CTL_HW identifiers
1033 #define HW_MACHINE 1 /* string: machine class */
1034 #define HW_MODEL 2 /* string: specific machine model */
1035 #define HW_NCPU 3 /* int: number of cpus */
1036 #define HW_BYTEORDER 4 /* int: machine byte order */
1037 #define HW_PHYSMEM 5 /* int: total memory */
1038 #define HW_USERMEM 6 /* int: non-kernel memory */
1039 #define HW_PAGESIZE 7 /* int: software page size */
1040 #define HW_DISKNAMES 8 /* strings: disk drive names */
1041 #define HW_DISKSTATS 9 /* struct: diskstats[] */
1042 #define HW_FLOATINGPT 10 /* int: has HW floating point? */
1043 #define HW_MACHINE_ARCH 11 /* string: machine architecture */
1044 #define HW_REALMEM 12 /* int: 'real' memory */
1047 * CTL_USER definitions
1049 #define USER_CS_PATH 1 /* string: _CS_PATH */
1050 #define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */
1051 #define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */
1052 #define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */
1053 #define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */
1054 #define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */
1055 #define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */
1056 #define USER_LINE_MAX 8 /* int: LINE_MAX */
1057 #define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */
1058 #define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */
1059 #define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */
1060 #define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */
1061 #define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */
1062 #define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */
1063 #define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */
1064 #define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */
1065 #define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */
1066 #define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */
1067 #define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */
1068 #define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */
1069 #define USER_LOCALBASE 21 /* string: _PATH_LOCALBASE */
1071 #define CTL_P1003_1B_ASYNCHRONOUS_IO 1 /* boolean */
1072 #define CTL_P1003_1B_MAPPED_FILES 2 /* boolean */
1073 #define CTL_P1003_1B_MEMLOCK 3 /* boolean */
1074 #define CTL_P1003_1B_MEMLOCK_RANGE 4 /* boolean */
1075 #define CTL_P1003_1B_MEMORY_PROTECTION 5 /* boolean */
1076 #define CTL_P1003_1B_MESSAGE_PASSING 6 /* boolean */
1077 #define CTL_P1003_1B_PRIORITIZED_IO 7 /* boolean */
1078 #define CTL_P1003_1B_PRIORITY_SCHEDULING 8 /* boolean */
1079 #define CTL_P1003_1B_REALTIME_SIGNALS 9 /* boolean */
1080 #define CTL_P1003_1B_SEMAPHORES 10 /* boolean */
1081 #define CTL_P1003_1B_FSYNC 11 /* boolean */
1082 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS 12 /* boolean */
1083 #define CTL_P1003_1B_SYNCHRONIZED_IO 13 /* boolean */
1084 #define CTL_P1003_1B_TIMERS 14 /* boolean */
1085 #define CTL_P1003_1B_AIO_LISTIO_MAX 15 /* int */
1086 #define CTL_P1003_1B_AIO_MAX 16 /* int */
1087 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX 17 /* int */
1088 #define CTL_P1003_1B_DELAYTIMER_MAX 18 /* int */
1089 #define CTL_P1003_1B_MQ_OPEN_MAX 19 /* int */
1090 #define CTL_P1003_1B_PAGESIZE 20 /* int */
1091 #define CTL_P1003_1B_RTSIG_MAX 21 /* int */
1092 #define CTL_P1003_1B_SEM_NSEMS_MAX 22 /* int */
1093 #define CTL_P1003_1B_SEM_VALUE_MAX 23 /* int */
1094 #define CTL_P1003_1B_SIGQUEUE_MAX 24 /* int */
1095 #define CTL_P1003_1B_TIMER_MAX 25 /* int */
1099 #define CTL_P1003_1B_MAXID 26
1102 * Declare some common oids.
1104 extern struct sysctl_oid_list sysctl__children;
1106 SYSCTL_DECL(_kern_features);
1107 SYSCTL_DECL(_kern_ipc);
1108 SYSCTL_DECL(_kern_proc);
1109 SYSCTL_DECL(_kern_sched);
1110 SYSCTL_DECL(_kern_sched_stats);
1111 SYSCTL_DECL(_sysctl);
1113 SYSCTL_DECL(_vm_stats);
1114 SYSCTL_DECL(_vm_stats_misc);
1117 SYSCTL_DECL(_debug);
1118 SYSCTL_DECL(_debug_sizeof);
1121 SYSCTL_DECL(_hw_bus);
1122 SYSCTL_DECL(_hw_bus_devices);
1123 SYSCTL_DECL(_machdep);
1124 SYSCTL_DECL(_machdep_mitigations);
1126 SYSCTL_DECL(_compat);
1127 SYSCTL_DECL(_regression);
1128 SYSCTL_DECL(_security);
1129 SYSCTL_DECL(_security_bsd);
1131 extern char machine[];
1132 extern char osrelease[];
1133 extern char ostype[];
1134 extern char kern_ident[];
1136 /* Dynamic oid handling */
1137 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
1138 struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
1139 void *arg1, intmax_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
1140 const char *fmt, const char *descr, const char *label);
1141 int sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
1143 void sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
1144 int sysctl_move_oid(struct sysctl_oid *oidp,
1145 struct sysctl_oid_list *parent);
1146 int sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
1147 int sysctl_ctx_init(struct sysctl_ctx_list *clist);
1148 int sysctl_ctx_free(struct sysctl_ctx_list *clist);
1149 struct sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
1150 struct sysctl_oid *oidp);
1151 struct sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
1152 struct sysctl_oid *oidp);
1153 int sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
1154 struct sysctl_oid *oidp);
1156 int kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1157 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1159 int kernel_sysctlbyname(struct thread *td, char *name, void *old,
1160 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1162 int userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1163 size_t *oldlenp, int inkernel, const void *new, size_t newlen,
1164 size_t *retval, int flags);
1165 int sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
1166 int *nindx, struct sysctl_req *req);
1167 void sysctl_wlock(void);
1168 void sysctl_wunlock(void);
1169 int sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
1170 int kern___sysctlbyname(struct thread *td, const char *name,
1171 size_t namelen, void *old, size_t *oldlenp, void *new,
1172 size_t newlen, size_t *retval, int flags, bool inkernel);
1175 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
1176 struct sysctl_req *);
1177 #else /* !_KERNEL */
1178 #include <sys/cdefs.h>
1179 #include <sys/_types.h>
1180 #ifndef _SIZE_T_DECLARED
1181 typedef __size_t size_t;
1182 #define _SIZE_T_DECLARED
1186 int sysctl(const int *, unsigned int, void *, size_t *, const void *, size_t);
1187 int sysctlbyname(const char *, void *, size_t *, const void *, size_t);
1188 int sysctlnametomib(const char *, int *, size_t *);
1190 #endif /* _KERNEL */
1192 #endif /* !_SYS_SYSCTL_H_ */