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>
47 * Definitions for sysctl call. The sysctl call uses a hierarchical name
48 * for objects that can be examined or modified. The name is expressed as
49 * a sequence of integers. Like a file path name, the meaning of each
50 * component depends on its place in the hierarchy. The top-level and kern
51 * identifiers are defined here, and other identifiers are defined in the
52 * respective subsystem header files.
55 #define CTL_MAXNAME 24 /* largest number of components supported */
58 * Each subsystem defined by sysctl defines a list of variables
59 * for that subsystem. Each name is either a node with further
60 * levels defined below it, or it is a leaf of some particular
61 * type given below. Each sysctl level defines a set of name/type
62 * pairs to be used by sysctl(8) in manipulating the subsystem.
65 char *ctl_name; /* subsystem name */
66 int ctl_type; /* type of name */
69 #define CTLTYPE 0xf /* mask for the type */
70 #define CTLTYPE_NODE 1 /* name is a node */
71 #define CTLTYPE_INT 2 /* name describes an integer */
72 #define CTLTYPE_STRING 3 /* name describes a string */
73 #define CTLTYPE_S64 4 /* name describes a signed 64-bit number */
74 #define CTLTYPE_OPAQUE 5 /* name describes a structure */
75 #define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */
76 #define CTLTYPE_UINT 6 /* name describes an unsigned integer */
77 #define CTLTYPE_LONG 7 /* name describes a long */
78 #define CTLTYPE_ULONG 8 /* name describes an unsigned long */
79 #define CTLTYPE_U64 9 /* name describes an unsigned 64-bit number */
80 #define CTLTYPE_U8 0xa /* name describes an unsigned 8-bit number */
81 #define CTLTYPE_U16 0xb /* name describes an unsigned 16-bit number */
82 #define CTLTYPE_S8 0xc /* name describes a signed 8-bit number */
83 #define CTLTYPE_S16 0xd /* name describes a signed 16-bit number */
84 #define CTLTYPE_S32 0xe /* name describes a signed 32-bit number */
85 #define CTLTYPE_U32 0xf /* name describes an unsigned 32-bit number */
87 #define CTLFLAG_RD 0x80000000 /* Allow reads of variable */
88 #define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */
89 #define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR)
90 #define CTLFLAG_DORMANT 0x20000000 /* This sysctl is not active yet */
91 #define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */
92 #define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */
93 #define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */
94 #define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */
95 #define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */
96 #define CTLMASK_SECURE 0x00F00000 /* Secure level */
97 #define CTLFLAG_TUN 0x00080000 /* Default value is loaded from getenv() */
98 #define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN)
99 #define CTLFLAG_RWTUN (CTLFLAG_RW|CTLFLAG_TUN)
100 #define CTLFLAG_MPSAFE 0x00040000 /* Handler is MP safe */
101 #define CTLFLAG_VNET 0x00020000 /* Prisons with vnet can fiddle */
102 #define CTLFLAG_DYING 0x00010000 /* Oid is being removed */
103 #define CTLFLAG_CAPRD 0x00008000 /* Can be read in capability mode */
104 #define CTLFLAG_CAPWR 0x00004000 /* Can be written in capability mode */
105 #define CTLFLAG_STATS 0x00002000 /* Statistics, not a tuneable */
106 #define CTLFLAG_NOFETCH 0x00001000 /* Don't fetch tunable from getenv() */
107 #define CTLFLAG_CAPRW (CTLFLAG_CAPRD|CTLFLAG_CAPWR)
109 * This is transient flag to be used until all sysctl handlers are converted
111 * One, and only one of CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT is required
112 * for SYSCTL_PROC and SYSCTL_NODE.
114 #define CTLFLAG_NEEDGIANT 0x00000800 /* Handler require Giant */
117 * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
119 * Secure when the securelevel is raised to at least N.
121 #define CTLSHIFT_SECURE 20
122 #define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
123 #define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
124 #define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
127 * USE THIS instead of a hardwired number from the categories below
128 * to get dynamically assigned sysctl entries using the linker-set
129 * technology. This is the way nearly all new sysctl variables should
131 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
133 #define OID_AUTO (-1)
136 * The starting number for dynamically-assigned entries. WARNING!
137 * ALL static sysctl entries should have numbers LESS than this!
139 #define CTL_AUTO_START 0x100
142 #include <sys/linker_set.h>
145 /* XXX allow overspecification of type in external kernel modules */
146 #define SYSCTL_CT_ASSERT_MASK CTLTYPE
148 #define SYSCTL_CT_ASSERT_MASK 0
151 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, \
152 intmax_t arg2, struct sysctl_req *req
154 /* definitions for sysctl_req 'lock' member */
155 #define REQ_UNWIRED 1
158 /* definitions for sysctl_req 'flags' member */
159 #if defined(__aarch64__) || defined(__amd64__) || defined(__powerpc64__) ||\
160 (defined(__mips__) && defined(__mips_n64))
161 #define SCTL_MASK32 1 /* 32 bit emulation */
165 * This describes the access space for a sysctl request. This is needed
166 * so that we can use the interface from the kernel or from user-space.
169 struct thread *td; /* used for access checking */
170 int lock; /* wiring state */
174 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
178 int (*newfunc)(struct sysctl_req *, void *, size_t);
183 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
186 * This describes one "oid" in the MIB tree. Potentially more nodes can
187 * be hidden behind it, expanded by the handler.
190 struct sysctl_oid_list oid_children;
191 struct sysctl_oid_list *oid_parent;
192 SLIST_ENTRY(sysctl_oid) oid_link;
197 const char *oid_name;
198 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
202 const char *oid_descr;
203 const char *oid_label;
206 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
207 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
208 #define SYSCTL_OUT_STR(r, p) (r->oldfunc)(r, p, strlen(p) + 1)
210 int sysctl_handle_bool(SYSCTL_HANDLER_ARGS);
211 int sysctl_handle_8(SYSCTL_HANDLER_ARGS);
212 int sysctl_handle_16(SYSCTL_HANDLER_ARGS);
213 int sysctl_handle_32(SYSCTL_HANDLER_ARGS);
214 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
215 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
216 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
217 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
218 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
219 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
220 int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
221 int sysctl_handle_counter_u64_array(SYSCTL_HANDLER_ARGS);
223 int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
224 int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
226 int sysctl_msec_to_sbintime(SYSCTL_HANDLER_ARGS);
227 int sysctl_usec_to_sbintime(SYSCTL_HANDLER_ARGS);
228 int sysctl_sec_to_timeval(SYSCTL_HANDLER_ARGS);
230 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
231 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
232 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
235 * These functions are used to add/remove an oid from the mib.
237 void sysctl_register_oid(struct sysctl_oid *oidp);
238 void sysctl_register_disabled_oid(struct sysctl_oid *oidp);
239 void sysctl_enable_oid(struct sysctl_oid *oidp);
240 void sysctl_unregister_oid(struct sysctl_oid *oidp);
242 /* Declare a static oid to allow child oids to be added to it. */
243 #define SYSCTL_DECL(name) \
244 extern struct sysctl_oid sysctl__##name
246 /* Hide these in macros. */
247 #define SYSCTL_CHILDREN(oid_ptr) (&(oid_ptr)->oid_children)
248 #define SYSCTL_PARENT(oid_ptr) \
249 (((oid_ptr)->oid_parent != &sysctl__children) ? \
250 __containerof((oid_ptr)->oid_parent, struct sysctl_oid, \
251 oid_children) : (struct sysctl_oid *)NULL)
252 #define SYSCTL_STATIC_CHILDREN(oid_name) (&sysctl__##oid_name.oid_children)
254 /* === Structs and macros related to context handling. === */
256 /* All dynamically created sysctls can be tracked in a context list. */
257 struct sysctl_ctx_entry {
258 struct sysctl_oid *entry;
259 TAILQ_ENTRY(sysctl_ctx_entry) link;
262 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
264 #define SYSCTL_NODE_CHILDREN(parent, name) \
265 sysctl__##parent##_##name.oid_children
267 #ifndef NO_SYSCTL_DESCR
270 #define __DESCR(d) ""
274 #define SYSCTL_ENFORCE_FLAGS(x) \
275 _Static_assert((((x) & CTLFLAG_MPSAFE) != 0) ^ (((x) & CTLFLAG_NEEDGIANT) != 0), \
276 "Has to be either CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT")
278 #define SYSCTL_ENFORCE_FLAGS(x)
281 /* This macro is only for internal use */
282 #define SYSCTL_OID_RAW(id, parent_child_head, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
283 struct sysctl_oid id = { \
284 .oid_parent = (parent_child_head), \
285 .oid_children = SLIST_HEAD_INITIALIZER(&id.oid_children), \
286 .oid_number = (nbr), \
287 .oid_kind = (kind), \
290 .oid_name = (name), \
291 .oid_handler = (handler), \
293 .oid_descr = __DESCR(descr), \
294 .oid_label = (label), \
296 DATA_SET(sysctl_set, id); \
297 SYSCTL_ENFORCE_FLAGS(kind)
299 /* This constructs a static "raw" MIB oid. */
300 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
301 SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2, \
302 handler, fmt, descr, NULL)
304 #define SYSCTL_OID_WITH_LABEL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
305 static SYSCTL_OID_RAW(sysctl__##parent##_##name, \
306 SYSCTL_CHILDREN(&sysctl__##parent), \
307 nbr, #name, kind, a1, a2, handler, fmt, descr, label)
309 /* This constructs a global "raw" MIB oid. */
310 #define SYSCTL_OID_GLOBAL(parent, nbr, name, kind, a1, a2, handler, fmt, descr, label) \
311 SYSCTL_OID_RAW(sysctl__##parent##_##name, \
312 SYSCTL_CHILDREN(&sysctl__##parent), \
313 nbr, #name, kind, a1, a2, handler, fmt, descr, label)
315 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
317 SYSCTL_ENFORCE_FLAGS(kind); \
318 sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2,handler, \
319 fmt, __DESCR(descr), NULL); \
322 /* This constructs a root node from which other nodes can hang. */
323 #define SYSCTL_ROOT_NODE(nbr, name, access, handler, descr) \
324 SYSCTL_OID_RAW(sysctl___##name, &sysctl__children, \
325 nbr, #name, CTLTYPE_NODE|(access), NULL, 0, \
326 handler, "N", descr, NULL); \
327 CTASSERT(((access) & CTLTYPE) == 0 || \
328 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
330 /* This constructs a node from which other oids can hang. */
331 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
332 SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, NULL)
334 #define SYSCTL_NODE_WITH_LABEL(parent, nbr, name, access, handler, descr, label) \
335 SYSCTL_OID_GLOBAL(parent, nbr, name, CTLTYPE_NODE|(access), \
336 NULL, 0, handler, "N", descr, label); \
337 SYSCTL_ENFORCE_FLAGS(access); \
338 CTASSERT(((access) & CTLTYPE) == 0 || \
339 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE)
341 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \
342 SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, \
343 handler, descr, NULL)
345 #define SYSCTL_ADD_NODE_WITH_LABEL(ctx, parent, nbr, name, access, handler, descr, label) \
347 CTASSERT(((access) & CTLTYPE) == 0 || \
348 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE); \
349 SYSCTL_ENFORCE_FLAGS(access); \
350 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \
351 NULL, 0, handler, "N", __DESCR(descr), label); \
354 #define SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr) \
356 CTASSERT(((access) & CTLTYPE) == 0 || \
357 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_NODE); \
358 SYSCTL_ENFORCE_FLAGS(access); \
359 sysctl_add_oid(ctx, &sysctl__children, nbr, name, \
360 CTLTYPE_NODE|(access), \
361 NULL, 0, handler, "N", __DESCR(descr), NULL); \
364 /* Oid for a string. len can be 0 to indicate '\0' termination. */
365 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
366 SYSCTL_OID(parent, nbr, name, \
367 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), \
368 arg, len, sysctl_handle_string, "A", descr); \
369 CTASSERT(((access) & CTLTYPE) == 0 || \
370 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
372 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
374 char *__arg = (arg); \
375 CTASSERT(((access) & CTLTYPE) == 0 || \
376 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING); \
377 sysctl_add_oid(ctx, parent, nbr, name, \
378 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), \
379 __arg, len, sysctl_handle_string, "A", __DESCR(descr), \
383 /* Oid for a constant '\0' terminated string. */
384 #define SYSCTL_CONST_STRING(parent, nbr, name, access, arg, descr) \
385 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING | CTLFLAG_MPSAFE | (access),\
386 __DECONST(char *, arg), 0, sysctl_handle_string, "A", descr); \
387 CTASSERT(!(access & CTLFLAG_WR)); \
388 CTASSERT(((access) & CTLTYPE) == 0 || \
389 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING)
391 #define SYSCTL_ADD_CONST_STRING(ctx, parent, nbr, name, access, arg, descr) \
393 char *__arg = __DECONST(char *, arg); \
394 CTASSERT(!(access & CTLFLAG_WR)); \
395 CTASSERT(((access) & CTLTYPE) == 0 || \
396 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_STRING); \
397 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING | \
398 CTLFLAG_MPSAFE | (access), __arg, 0, sysctl_handle_string, "A",\
399 __DESCR(descr), NULL); \
402 /* Oid for a bool. If ptr is NULL, val is returned. */
403 #define SYSCTL_NULL_BOOL_PTR ((bool *)NULL)
404 #define SYSCTL_BOOL(parent, nbr, name, access, ptr, val, descr) \
405 SYSCTL_OID(parent, nbr, name, \
406 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
407 ptr, val, sysctl_handle_bool, "CU", descr); \
408 CTASSERT(((access) & CTLTYPE) == 0 && \
409 sizeof(bool) == sizeof(*(ptr)))
411 #define SYSCTL_ADD_BOOL(ctx, parent, nbr, name, access, ptr, val, descr) \
413 bool *__ptr = (ptr); \
414 CTASSERT(((access) & CTLTYPE) == 0); \
415 sysctl_add_oid(ctx, parent, nbr, name, \
416 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
417 __ptr, val, sysctl_handle_bool, "CU", __DESCR(descr), \
421 /* Oid for a signed 8-bit int. If ptr is NULL, val is returned. */
422 #define SYSCTL_NULL_S8_PTR ((int8_t *)NULL)
423 #define SYSCTL_S8(parent, nbr, name, access, ptr, val, descr) \
424 SYSCTL_OID(parent, nbr, name, \
425 CTLTYPE_S8 | CTLFLAG_MPSAFE | (access), \
426 ptr, val, sysctl_handle_8, "C", descr); \
427 CTASSERT((((access) & CTLTYPE) == 0 || \
428 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8) && \
429 sizeof(int8_t) == sizeof(*(ptr)))
431 #define SYSCTL_ADD_S8(ctx, parent, nbr, name, access, ptr, val, descr) \
433 int8_t *__ptr = (ptr); \
434 CTASSERT(((access) & CTLTYPE) == 0 || \
435 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S8); \
436 sysctl_add_oid(ctx, parent, nbr, name, \
437 CTLTYPE_S8 | CTLFLAG_MPSAFE | (access), \
438 __ptr, val, sysctl_handle_8, "C", __DESCR(descr), NULL); \
441 /* Oid for an unsigned 8-bit int. If ptr is NULL, val is returned. */
442 #define SYSCTL_NULL_U8_PTR ((uint8_t *)NULL)
443 #define SYSCTL_U8(parent, nbr, name, access, ptr, val, descr) \
444 SYSCTL_OID(parent, nbr, name, \
445 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
446 ptr, val, sysctl_handle_8, "CU", descr); \
447 CTASSERT((((access) & CTLTYPE) == 0 || \
448 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8) && \
449 sizeof(uint8_t) == sizeof(*(ptr)))
451 #define SYSCTL_ADD_U8(ctx, parent, nbr, name, access, ptr, val, descr) \
453 uint8_t *__ptr = (ptr); \
454 CTASSERT(((access) & CTLTYPE) == 0 || \
455 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U8); \
456 sysctl_add_oid(ctx, parent, nbr, name, \
457 CTLTYPE_U8 | CTLFLAG_MPSAFE | (access), \
458 __ptr, val, sysctl_handle_8, "CU", __DESCR(descr), NULL); \
461 /* Oid for a signed 16-bit int. If ptr is NULL, val is returned. */
462 #define SYSCTL_NULL_S16_PTR ((int16_t *)NULL)
463 #define SYSCTL_S16(parent, nbr, name, access, ptr, val, descr) \
464 SYSCTL_OID(parent, nbr, name, \
465 CTLTYPE_S16 | CTLFLAG_MPSAFE | (access), \
466 ptr, val, sysctl_handle_16, "S", descr); \
467 CTASSERT((((access) & CTLTYPE) == 0 || \
468 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16) && \
469 sizeof(int16_t) == sizeof(*(ptr)))
471 #define SYSCTL_ADD_S16(ctx, parent, nbr, name, access, ptr, val, descr) \
473 int16_t *__ptr = (ptr); \
474 CTASSERT(((access) & CTLTYPE) == 0 || \
475 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S16); \
476 sysctl_add_oid(ctx, parent, nbr, name, \
477 CTLTYPE_S16 | CTLFLAG_MPSAFE | (access), \
478 __ptr, val, sysctl_handle_16, "S", __DESCR(descr), NULL); \
481 /* Oid for an unsigned 16-bit int. If ptr is NULL, val is returned. */
482 #define SYSCTL_NULL_U16_PTR ((uint16_t *)NULL)
483 #define SYSCTL_U16(parent, nbr, name, access, ptr, val, descr) \
484 SYSCTL_OID(parent, nbr, name, \
485 CTLTYPE_U16 | CTLFLAG_MPSAFE | (access), \
486 ptr, val, sysctl_handle_16, "SU", descr); \
487 CTASSERT((((access) & CTLTYPE) == 0 || \
488 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16) && \
489 sizeof(uint16_t) == sizeof(*(ptr)))
491 #define SYSCTL_ADD_U16(ctx, parent, nbr, name, access, ptr, val, descr) \
493 uint16_t *__ptr = (ptr); \
494 CTASSERT(((access) & CTLTYPE) == 0 || \
495 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U16); \
496 sysctl_add_oid(ctx, parent, nbr, name, \
497 CTLTYPE_U16 | CTLFLAG_MPSAFE | (access), \
498 __ptr, val, sysctl_handle_16, "SU", __DESCR(descr), NULL); \
501 /* Oid for a signed 32-bit int. If ptr is NULL, val is returned. */
502 #define SYSCTL_NULL_S32_PTR ((int32_t *)NULL)
503 #define SYSCTL_S32(parent, nbr, name, access, ptr, val, descr) \
504 SYSCTL_OID(parent, nbr, name, \
505 CTLTYPE_S32 | CTLFLAG_MPSAFE | (access), \
506 ptr, val, sysctl_handle_32, "I", descr); \
507 CTASSERT((((access) & CTLTYPE) == 0 || \
508 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32) && \
509 sizeof(int32_t) == sizeof(*(ptr)))
511 #define SYSCTL_ADD_S32(ctx, parent, nbr, name, access, ptr, val, descr) \
513 int32_t *__ptr = (ptr); \
514 CTASSERT(((access) & CTLTYPE) == 0 || \
515 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S32); \
516 sysctl_add_oid(ctx, parent, nbr, name, \
517 CTLTYPE_S32 | CTLFLAG_MPSAFE | (access), \
518 __ptr, val, sysctl_handle_32, "I", __DESCR(descr), NULL); \
521 /* Oid for an unsigned 32-bit int. If ptr is NULL, val is returned. */
522 #define SYSCTL_NULL_U32_PTR ((uint32_t *)NULL)
523 #define SYSCTL_U32(parent, nbr, name, access, ptr, val, descr) \
524 SYSCTL_OID(parent, nbr, name, \
525 CTLTYPE_U32 | CTLFLAG_MPSAFE | (access), \
526 ptr, val, sysctl_handle_32, "IU", descr); \
527 CTASSERT((((access) & CTLTYPE) == 0 || \
528 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32) && \
529 sizeof(uint32_t) == sizeof(*(ptr)))
531 #define SYSCTL_ADD_U32(ctx, parent, nbr, name, access, ptr, val, descr) \
533 uint32_t *__ptr = (ptr); \
534 CTASSERT(((access) & CTLTYPE) == 0 || \
535 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U32); \
536 sysctl_add_oid(ctx, parent, nbr, name, \
537 CTLTYPE_U32 | CTLFLAG_MPSAFE | (access), \
538 __ptr, val, sysctl_handle_32, "IU", __DESCR(descr), NULL); \
541 /* Oid for a signed 64-bit int. If ptr is NULL, val is returned. */
542 #define SYSCTL_NULL_S64_PTR ((int64_t *)NULL)
543 #define SYSCTL_S64(parent, nbr, name, access, ptr, val, descr) \
544 SYSCTL_OID(parent, nbr, name, \
545 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
546 ptr, val, sysctl_handle_64, "Q", descr); \
547 CTASSERT((((access) & CTLTYPE) == 0 || \
548 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
549 sizeof(int64_t) == sizeof(*(ptr)))
551 #define SYSCTL_ADD_S64(ctx, parent, nbr, name, access, ptr, val, descr) \
553 int64_t *__ptr = (ptr); \
554 CTASSERT(((access) & CTLTYPE) == 0 || \
555 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
556 sysctl_add_oid(ctx, parent, nbr, name, \
557 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
558 __ptr, val, sysctl_handle_64, "Q", __DESCR(descr), NULL); \
561 /* Oid for an unsigned 64-bit int. If ptr is NULL, val is returned. */
562 #define SYSCTL_NULL_U64_PTR ((uint64_t *)NULL)
563 #define SYSCTL_U64(parent, nbr, name, access, ptr, val, descr) \
564 SYSCTL_OID(parent, nbr, name, \
565 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
566 ptr, val, sysctl_handle_64, "QU", descr); \
567 CTASSERT((((access) & CTLTYPE) == 0 || \
568 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
569 sizeof(uint64_t) == sizeof(*(ptr)))
571 #define SYSCTL_ADD_U64(ctx, parent, nbr, name, access, ptr, val, descr) \
573 uint64_t *__ptr = (ptr); \
574 CTASSERT(((access) & CTLTYPE) == 0 || \
575 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
576 sysctl_add_oid(ctx, parent, nbr, name, \
577 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
578 __ptr, val, sysctl_handle_64, "QU", __DESCR(descr), NULL); \
581 /* Oid for an int. If ptr is SYSCTL_NULL_INT_PTR, val is returned. */
582 #define SYSCTL_NULL_INT_PTR ((int *)NULL)
583 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
584 SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, NULL)
586 #define SYSCTL_INT_WITH_LABEL(parent, nbr, name, access, ptr, val, descr, label) \
587 SYSCTL_OID_WITH_LABEL(parent, nbr, name, \
588 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
589 ptr, val, sysctl_handle_int, "I", descr, label); \
590 CTASSERT((((access) & CTLTYPE) == 0 || \
591 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT) && \
592 sizeof(int) == sizeof(*(ptr)))
594 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \
596 int *__ptr = (ptr); \
597 CTASSERT(((access) & CTLTYPE) == 0 || \
598 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
599 sysctl_add_oid(ctx, parent, nbr, name, \
600 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
601 __ptr, val, sysctl_handle_int, "I", __DESCR(descr), NULL); \
604 /* Oid for an unsigned int. If ptr is NULL, val is returned. */
605 #define SYSCTL_NULL_UINT_PTR ((unsigned *)NULL)
606 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
607 SYSCTL_OID(parent, nbr, name, \
608 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
609 ptr, val, sysctl_handle_int, "IU", descr); \
610 CTASSERT((((access) & CTLTYPE) == 0 || \
611 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT) && \
612 sizeof(unsigned) == sizeof(*(ptr)))
614 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
616 unsigned *__ptr = (ptr); \
617 CTASSERT(((access) & CTLTYPE) == 0 || \
618 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_UINT); \
619 sysctl_add_oid(ctx, parent, nbr, name, \
620 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
621 __ptr, val, sysctl_handle_int, "IU", __DESCR(descr), NULL); \
624 /* Oid for a long. The pointer must be non NULL. */
625 #define SYSCTL_NULL_LONG_PTR ((long *)NULL)
626 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \
627 SYSCTL_OID(parent, nbr, name, \
628 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
629 ptr, val, sysctl_handle_long, "L", descr); \
630 CTASSERT((((access) & CTLTYPE) == 0 || \
631 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG) && \
632 sizeof(long) == sizeof(*(ptr)))
634 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \
636 long *__ptr = (ptr); \
637 CTASSERT(((access) & CTLTYPE) == 0 || \
638 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_LONG); \
639 sysctl_add_oid(ctx, parent, nbr, name, \
640 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
641 __ptr, 0, sysctl_handle_long, "L", __DESCR(descr), NULL); \
644 /* Oid for an unsigned long. The pointer must be non NULL. */
645 #define SYSCTL_NULL_ULONG_PTR ((unsigned long *)NULL)
646 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \
647 SYSCTL_OID(parent, nbr, name, \
648 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
649 ptr, val, sysctl_handle_long, "LU", descr); \
650 CTASSERT((((access) & CTLTYPE) == 0 || \
651 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG) && \
652 sizeof(unsigned long) == sizeof(*(ptr)))
654 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \
656 unsigned long *__ptr = (ptr); \
657 CTASSERT(((access) & CTLTYPE) == 0 || \
658 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_ULONG); \
659 sysctl_add_oid(ctx, parent, nbr, name, \
660 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
661 __ptr, 0, sysctl_handle_long, "LU", __DESCR(descr), NULL); \
664 /* Oid for a quad. The pointer must be non NULL. */
665 #define SYSCTL_NULL_QUAD_PTR ((int64_t *)NULL)
666 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \
667 SYSCTL_OID(parent, nbr, name, \
668 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
669 ptr, val, sysctl_handle_64, "Q", descr); \
670 CTASSERT((((access) & CTLTYPE) == 0 || \
671 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64) && \
672 sizeof(int64_t) == sizeof(*(ptr)))
674 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \
676 int64_t *__ptr = (ptr); \
677 CTASSERT(((access) & CTLTYPE) == 0 || \
678 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
679 sysctl_add_oid(ctx, parent, nbr, name, \
680 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
681 __ptr, 0, sysctl_handle_64, "Q", __DESCR(descr), NULL); \
684 #define SYSCTL_NULL_UQUAD_PTR ((uint64_t *)NULL)
685 #define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr) \
686 SYSCTL_OID(parent, nbr, name, \
687 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
688 ptr, val, sysctl_handle_64, "QU", descr); \
689 CTASSERT((((access) & CTLTYPE) == 0 || \
690 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
691 sizeof(uint64_t) == sizeof(*(ptr)))
693 #define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr) \
695 uint64_t *__ptr = (ptr); \
696 CTASSERT(((access) & CTLTYPE) == 0 || \
697 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
698 sysctl_add_oid(ctx, parent, nbr, name, \
699 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
700 __ptr, 0, sysctl_handle_64, "QU", __DESCR(descr), NULL); \
703 /* Oid for a CPU dependent variable */
704 #define SYSCTL_ADD_UAUTO(ctx, parent, nbr, name, access, ptr, descr) \
706 struct sysctl_oid *__ret; \
707 CTASSERT((sizeof(uint64_t) == sizeof(*(ptr)) || \
708 sizeof(unsigned) == sizeof(*(ptr))) && \
709 ((access) & CTLTYPE) == 0); \
710 if (sizeof(uint64_t) == sizeof(*(ptr))) { \
711 __ret = sysctl_add_oid(ctx, parent, nbr, name, \
712 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
713 (ptr), 0, sysctl_handle_64, "QU", \
714 __DESCR(descr), NULL); \
716 __ret = sysctl_add_oid(ctx, parent, nbr, name, \
717 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
718 (ptr), 0, sysctl_handle_int, "IU", \
719 __DESCR(descr), NULL); \
724 /* Oid for a 64-bit unsigned counter(9). The pointer must be non NULL. */
725 #define SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr) \
726 SYSCTL_OID(parent, nbr, name, \
727 CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
728 (ptr), 0, sysctl_handle_counter_u64, "QU", descr); \
729 CTASSERT((((access) & CTLTYPE) == 0 || \
730 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64) && \
731 sizeof(counter_u64_t) == sizeof(*(ptr)) && \
732 sizeof(uint64_t) == sizeof(**(ptr)))
734 #define SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr) \
736 counter_u64_t *__ptr = (ptr); \
737 CTASSERT(((access) & CTLTYPE) == 0 || \
738 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_U64); \
739 sysctl_add_oid(ctx, parent, nbr, name, \
740 CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
741 __ptr, 0, sysctl_handle_counter_u64, "QU", __DESCR(descr), \
745 /* Oid for an array of counter(9)s. The pointer and length must be non zero. */
746 #define SYSCTL_COUNTER_U64_ARRAY(parent, nbr, name, access, ptr, len, descr) \
747 SYSCTL_OID(parent, nbr, name, \
748 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
749 (ptr), (len), sysctl_handle_counter_u64_array, "S", descr); \
750 CTASSERT((((access) & CTLTYPE) == 0 || \
751 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE) && \
752 sizeof(counter_u64_t) == sizeof(*(ptr)) && \
753 sizeof(uint64_t) == sizeof(**(ptr)))
755 #define SYSCTL_ADD_COUNTER_U64_ARRAY(ctx, parent, nbr, name, access, \
758 counter_u64_t *__ptr = (ptr); \
759 CTASSERT(((access) & CTLTYPE) == 0 || \
760 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
761 sysctl_add_oid(ctx, parent, nbr, name, \
762 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | CTLFLAG_STATS | (access), \
763 __ptr, len, sysctl_handle_counter_u64_array, "S", \
764 __DESCR(descr), NULL); \
767 /* Oid for an opaque object. Specified by a pointer and a length. */
768 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
769 SYSCTL_OID(parent, nbr, name, \
770 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
771 ptr, len, sysctl_handle_opaque, fmt, descr); \
772 CTASSERT(((access) & CTLTYPE) == 0 || \
773 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
775 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr) \
777 CTASSERT(((access) & CTLTYPE) == 0 || \
778 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
779 sysctl_add_oid(ctx, parent, nbr, name, \
780 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
781 ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr), NULL); \
784 /* Oid for a struct. Specified by a pointer and a type. */
785 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
786 SYSCTL_OID(parent, nbr, name, \
787 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
788 ptr, sizeof(struct type), sysctl_handle_opaque, \
789 "S," #type, descr); \
790 CTASSERT(((access) & CTLTYPE) == 0 || \
791 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE)
793 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
795 CTASSERT(((access) & CTLTYPE) == 0 || \
796 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_OPAQUE); \
797 sysctl_add_oid(ctx, parent, nbr, name, \
798 CTLTYPE_OPAQUE | CTLFLAG_MPSAFE | (access), \
799 (ptr), sizeof(struct type), \
800 sysctl_handle_opaque, "S," #type, __DESCR(descr), NULL); \
803 /* Oid for a procedure. Specified by a pointer and an arg. */
804 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
805 SYSCTL_OID(parent, nbr, name, (access), \
806 ptr, arg, handler, fmt, descr); \
807 CTASSERT(((access) & CTLTYPE) != 0)
809 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
811 CTASSERT(((access) & CTLTYPE) != 0); \
812 SYSCTL_ENFORCE_FLAGS(access); \
813 sysctl_add_oid(ctx, parent, nbr, name, (access), \
814 (ptr), (arg), (handler), (fmt), __DESCR(descr), NULL); \
817 /* Oid to handle limits on uma(9) zone specified by pointer. */
818 #define SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr) \
819 SYSCTL_OID(parent, nbr, name, \
820 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
821 (ptr), 0, sysctl_handle_uma_zone_max, "I", descr); \
822 CTASSERT(((access) & CTLTYPE) == 0 || \
823 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
825 #define SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr) \
827 uma_zone_t __ptr = (ptr); \
828 CTASSERT(((access) & CTLTYPE) == 0 || \
829 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
830 sysctl_add_oid(ctx, parent, nbr, name, \
831 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
832 __ptr, 0, sysctl_handle_uma_zone_max, "I", __DESCR(descr), \
836 /* Oid to obtain current use of uma(9) zone specified by pointer. */
837 #define SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr) \
838 SYSCTL_OID(parent, nbr, name, \
839 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
840 (ptr), 0, sysctl_handle_uma_zone_cur, "I", descr); \
841 CTASSERT(((access) & CTLTYPE) == 0 || \
842 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
844 #define SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr) \
846 uma_zone_t __ptr = (ptr); \
847 CTASSERT(((access) & CTLTYPE) == 0 || \
848 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
849 sysctl_add_oid(ctx, parent, nbr, name, \
850 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
851 __ptr, 0, sysctl_handle_uma_zone_cur, "I", __DESCR(descr), \
855 /* OID expressing a sbintime_t as microseconds */
856 #define SYSCTL_SBINTIME_USEC(parent, nbr, name, access, ptr, descr) \
857 SYSCTL_OID(parent, nbr, name, \
858 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
859 (ptr), 0, sysctl_usec_to_sbintime, "Q", descr); \
860 CTASSERT(((access) & CTLTYPE) == 0 || \
861 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
862 #define SYSCTL_ADD_SBINTIME_USEC(ctx, parent, nbr, name, access, ptr, descr) \
864 sbintime_t *__ptr = (ptr); \
865 CTASSERT(((access) & CTLTYPE) == 0 || \
866 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
867 sysctl_add_oid(ctx, parent, nbr, name, \
868 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
869 __ptr, 0, sysctl_usec_to_sbintime, "Q", __DESCR(descr), \
873 /* OID expressing a sbintime_t as milliseconds */
874 #define SYSCTL_SBINTIME_MSEC(parent, nbr, name, access, ptr, descr) \
875 SYSCTL_OID(parent, nbr, name, \
876 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
877 (ptr), 0, sysctl_msec_to_sbintime, "Q", descr); \
878 CTASSERT(((access) & CTLTYPE) == 0 || \
879 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64)
880 #define SYSCTL_ADD_SBINTIME_MSEC(ctx, parent, nbr, name, access, ptr, descr) \
882 sbintime_t *__ptr = (ptr); \
883 CTASSERT(((access) & CTLTYPE) == 0 || \
884 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_S64); \
885 sysctl_add_oid(ctx, parent, nbr, name, \
886 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
887 __ptr, 0, sysctl_msec_to_sbintime, "Q", __DESCR(descr), \
891 /* OID expressing a struct timeval as seconds */
892 #define SYSCTL_TIMEVAL_SEC(parent, nbr, name, access, ptr, descr) \
893 SYSCTL_OID(parent, nbr, name, \
894 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
895 (ptr), 0, sysctl_sec_to_timeval, "I", descr); \
896 CTASSERT(((access) & CTLTYPE) == 0 || \
897 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT)
898 #define SYSCTL_ADD_TIMEVAL_SEC(ctx, parent, nbr, name, access, ptr, descr) \
900 struct timeval *__ptr = (ptr); \
901 CTASSERT(((access) & CTLTYPE) == 0 || \
902 ((access) & SYSCTL_CT_ASSERT_MASK) == CTLTYPE_INT); \
903 sysctl_add_oid(ctx, parent, nbr, name, \
904 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
905 __ptr, 0, sysctl_sec_to_timeval, "I", __DESCR(descr), \
910 * A macro to generate a read-only sysctl to indicate the presence of optional
913 #define FEATURE(name, desc) \
914 SYSCTL_INT_WITH_LABEL(_kern_features, OID_AUTO, name, \
915 CTLFLAG_RD | CTLFLAG_CAPRD, SYSCTL_NULL_INT_PTR, 1, desc, "feature")
920 * Top-level identifiers
922 #define CTL_SYSCTL 0 /* "magic" numbers */
923 #define CTL_KERN 1 /* "high kernel": proc, limits */
924 #define CTL_VM 2 /* virtual memory */
925 #define CTL_VFS 3 /* filesystem, mount type is next */
926 #define CTL_NET 4 /* network, see socket.h */
927 #define CTL_DEBUG 5 /* debugging parameters */
928 #define CTL_HW 6 /* generic cpu/io */
929 #define CTL_MACHDEP 7 /* machine dependent */
930 #define CTL_USER 8 /* user-level */
931 #define CTL_P1003_1B 9 /* POSIX 1003.1B */
934 * CTL_SYSCTL identifiers
936 #define CTL_SYSCTL_DEBUG 0 /* printf all nodes */
937 #define CTL_SYSCTL_NAME 1 /* string name of OID */
938 #define CTL_SYSCTL_NEXT 2 /* next OID */
939 #define CTL_SYSCTL_NAME2OID 3 /* int array of name */
940 #define CTL_SYSCTL_OIDFMT 4 /* OID's kind and format */
941 #define CTL_SYSCTL_OIDDESCR 5 /* OID's description */
942 #define CTL_SYSCTL_OIDLABEL 6 /* aggregation label */
945 * CTL_KERN identifiers
947 #define KERN_OSTYPE 1 /* string: system version */
948 #define KERN_OSRELEASE 2 /* string: system release */
949 #define KERN_OSREV 3 /* int: system revision */
950 #define KERN_VERSION 4 /* string: compile time info */
951 #define KERN_MAXVNODES 5 /* int: max vnodes */
952 #define KERN_MAXPROC 6 /* int: max processes */
953 #define KERN_MAXFILES 7 /* int: max open files */
954 #define KERN_ARGMAX 8 /* int: max arguments to exec */
955 #define KERN_SECURELVL 9 /* int: system security level */
956 #define KERN_HOSTNAME 10 /* string: hostname */
957 #define KERN_HOSTID 11 /* int: host identifier */
958 #define KERN_CLOCKRATE 12 /* struct: struct clockrate */
959 #define KERN_VNODE 13 /* struct: vnode structures */
960 #define KERN_PROC 14 /* struct: process entries */
961 #define KERN_FILE 15 /* struct: file entries */
962 #define KERN_PROF 16 /* node: kernel profiling info */
963 #define KERN_POSIX1 17 /* int: POSIX.1 version */
964 #define KERN_NGROUPS 18 /* int: # of supplemental group ids */
965 #define KERN_JOB_CONTROL 19 /* int: is job control available */
966 #define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */
967 #define KERN_BOOTTIME 21 /* struct: time kernel was booted */
968 #define KERN_NISDOMAINNAME 22 /* string: YP domain name */
969 #define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */
970 #define KERN_OSRELDATE 24 /* int: kernel release date */
971 #define KERN_NTP_PLL 25 /* node: NTP PLL control */
972 #define KERN_BOOTFILE 26 /* string: name of booted kernel */
973 #define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */
974 #define KERN_MAXPROCPERUID 28 /* int: max processes per uid */
975 #define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */
976 #define KERN_IPC 30 /* node: anything related to IPC */
977 #define KERN_DUMMY 31 /* unused */
978 #define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */
979 #define KERN_USRSTACK 33 /* int: address of USRSTACK */
980 #define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */
981 #define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */
982 #define KERN_HOSTUUID 36 /* string: host UUID identifier */
983 #define KERN_ARND 37 /* int: from arc4rand() */
984 #define KERN_MAXPHYS 38 /* int: MAXPHYS value */
988 #define KERN_PROC_ALL 0 /* everything */
989 #define KERN_PROC_PID 1 /* by process id */
990 #define KERN_PROC_PGRP 2 /* by process group id */
991 #define KERN_PROC_SESSION 3 /* by session of pid */
992 #define KERN_PROC_TTY 4 /* by controlling tty */
993 #define KERN_PROC_UID 5 /* by effective uid */
994 #define KERN_PROC_RUID 6 /* by real uid */
995 #define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */
996 #define KERN_PROC_PROC 8 /* only return procs */
997 #define KERN_PROC_SV_NAME 9 /* get syscall vector name */
998 #define KERN_PROC_RGID 10 /* by real group id */
999 #define KERN_PROC_GID 11 /* by effective group id */
1000 #define KERN_PROC_PATHNAME 12 /* path to executable */
1001 #define KERN_PROC_OVMMAP 13 /* Old VM map entries for process */
1002 #define KERN_PROC_OFILEDESC 14 /* Old file descriptors for process */
1003 #define KERN_PROC_KSTACK 15 /* Kernel stacks for process */
1004 #define KERN_PROC_INC_THREAD 0x10 /*
1005 * modifier for pid, pgrp, tty,
1006 * uid, ruid, gid, rgid and proc
1007 * This effectively uses 16-31
1009 #define KERN_PROC_VMMAP 32 /* VM map entries for process */
1010 #define KERN_PROC_FILEDESC 33 /* File descriptors for process */
1011 #define KERN_PROC_GROUPS 34 /* process groups */
1012 #define KERN_PROC_ENV 35 /* get environment */
1013 #define KERN_PROC_AUXV 36 /* get ELF auxiliary vector */
1014 #define KERN_PROC_RLIMIT 37 /* process resource limits */
1015 #define KERN_PROC_PS_STRINGS 38 /* get ps_strings location */
1016 #define KERN_PROC_UMASK 39 /* process umask */
1017 #define KERN_PROC_OSREL 40 /* osreldate for process binary */
1018 #define KERN_PROC_SIGTRAMP 41 /* signal trampoline location */
1019 #define KERN_PROC_CWD 42 /* process current working directory */
1020 #define KERN_PROC_NFDS 43 /* number of open file descriptors */
1021 #define KERN_PROC_SIGFASTBLK 44 /* address of fastsigblk magic word */
1024 * KERN_IPC identifiers
1026 #define KIPC_MAXSOCKBUF 1 /* int: max size of a socket buffer */
1027 #define KIPC_SOCKBUF_WASTE 2 /* int: wastage factor in sockbuf */
1028 #define KIPC_SOMAXCONN 3 /* int: max length of connection q */
1029 #define KIPC_MAX_LINKHDR 4 /* int: max length of link header */
1030 #define KIPC_MAX_PROTOHDR 5 /* int: max length of network header */
1031 #define KIPC_MAX_HDR 6 /* int: max total length of headers */
1032 #define KIPC_MAX_DATALEN 7 /* int: max length of data? */
1035 * CTL_HW identifiers
1037 #define HW_MACHINE 1 /* string: machine class */
1038 #define HW_MODEL 2 /* string: specific machine model */
1039 #define HW_NCPU 3 /* int: number of cpus */
1040 #define HW_BYTEORDER 4 /* int: machine byte order */
1041 #define HW_PHYSMEM 5 /* int: total memory */
1042 #define HW_USERMEM 6 /* int: non-kernel memory */
1043 #define HW_PAGESIZE 7 /* int: software page size */
1044 #define HW_DISKNAMES 8 /* strings: disk drive names */
1045 #define HW_DISKSTATS 9 /* struct: diskstats[] */
1046 #define HW_FLOATINGPT 10 /* int: has HW floating point? */
1047 #define HW_MACHINE_ARCH 11 /* string: machine architecture */
1048 #define HW_REALMEM 12 /* int: 'real' memory */
1051 * CTL_USER definitions
1053 #define USER_CS_PATH 1 /* string: _CS_PATH */
1054 #define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */
1055 #define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */
1056 #define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */
1057 #define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */
1058 #define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */
1059 #define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */
1060 #define USER_LINE_MAX 8 /* int: LINE_MAX */
1061 #define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */
1062 #define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */
1063 #define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */
1064 #define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */
1065 #define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */
1066 #define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */
1067 #define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */
1068 #define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */
1069 #define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */
1070 #define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */
1071 #define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */
1072 #define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */
1074 #define CTL_P1003_1B_ASYNCHRONOUS_IO 1 /* boolean */
1075 #define CTL_P1003_1B_MAPPED_FILES 2 /* boolean */
1076 #define CTL_P1003_1B_MEMLOCK 3 /* boolean */
1077 #define CTL_P1003_1B_MEMLOCK_RANGE 4 /* boolean */
1078 #define CTL_P1003_1B_MEMORY_PROTECTION 5 /* boolean */
1079 #define CTL_P1003_1B_MESSAGE_PASSING 6 /* boolean */
1080 #define CTL_P1003_1B_PRIORITIZED_IO 7 /* boolean */
1081 #define CTL_P1003_1B_PRIORITY_SCHEDULING 8 /* boolean */
1082 #define CTL_P1003_1B_REALTIME_SIGNALS 9 /* boolean */
1083 #define CTL_P1003_1B_SEMAPHORES 10 /* boolean */
1084 #define CTL_P1003_1B_FSYNC 11 /* boolean */
1085 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS 12 /* boolean */
1086 #define CTL_P1003_1B_SYNCHRONIZED_IO 13 /* boolean */
1087 #define CTL_P1003_1B_TIMERS 14 /* boolean */
1088 #define CTL_P1003_1B_AIO_LISTIO_MAX 15 /* int */
1089 #define CTL_P1003_1B_AIO_MAX 16 /* int */
1090 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX 17 /* int */
1091 #define CTL_P1003_1B_DELAYTIMER_MAX 18 /* int */
1092 #define CTL_P1003_1B_MQ_OPEN_MAX 19 /* int */
1093 #define CTL_P1003_1B_PAGESIZE 20 /* int */
1094 #define CTL_P1003_1B_RTSIG_MAX 21 /* int */
1095 #define CTL_P1003_1B_SEM_NSEMS_MAX 22 /* int */
1096 #define CTL_P1003_1B_SEM_VALUE_MAX 23 /* int */
1097 #define CTL_P1003_1B_SIGQUEUE_MAX 24 /* int */
1098 #define CTL_P1003_1B_TIMER_MAX 25 /* int */
1100 #define CTL_P1003_1B_MAXID 26
1105 * Declare some common oids.
1107 extern struct sysctl_oid_list sysctl__children;
1109 SYSCTL_DECL(_kern_features);
1110 SYSCTL_DECL(_kern_ipc);
1111 SYSCTL_DECL(_kern_proc);
1112 SYSCTL_DECL(_kern_sched);
1113 SYSCTL_DECL(_kern_sched_stats);
1114 SYSCTL_DECL(_sysctl);
1116 SYSCTL_DECL(_vm_stats);
1117 SYSCTL_DECL(_vm_stats_misc);
1120 SYSCTL_DECL(_debug);
1121 SYSCTL_DECL(_debug_sizeof);
1124 SYSCTL_DECL(_hw_bus);
1125 SYSCTL_DECL(_hw_bus_devices);
1126 SYSCTL_DECL(_hw_bus_info);
1127 SYSCTL_DECL(_machdep);
1128 SYSCTL_DECL(_machdep_mitigations);
1130 SYSCTL_DECL(_compat);
1131 SYSCTL_DECL(_regression);
1132 SYSCTL_DECL(_security);
1133 SYSCTL_DECL(_security_bsd);
1135 extern char machine[];
1136 extern char osrelease[];
1137 extern char ostype[];
1138 extern char kern_ident[];
1140 /* Dynamic oid handling */
1141 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
1142 struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
1143 void *arg1, intmax_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
1144 const char *fmt, const char *descr, const char *label);
1145 int sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
1147 void sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
1148 int sysctl_move_oid(struct sysctl_oid *oidp,
1149 struct sysctl_oid_list *parent);
1150 int sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
1151 int sysctl_ctx_init(struct sysctl_ctx_list *clist);
1152 int sysctl_ctx_free(struct sysctl_ctx_list *clist);
1153 struct sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
1154 struct sysctl_oid *oidp);
1155 struct sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
1156 struct sysctl_oid *oidp);
1157 int sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
1158 struct sysctl_oid *oidp);
1160 int kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1161 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1163 int kernel_sysctlbyname(struct thread *td, char *name, void *old,
1164 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
1166 int userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
1167 size_t *oldlenp, int inkernel, const void *new, size_t newlen,
1168 size_t *retval, int flags);
1169 int sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
1170 int *nindx, struct sysctl_req *req);
1171 void sysctl_wlock(void);
1172 void sysctl_wunlock(void);
1173 int sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
1174 int kern___sysctlbyname(struct thread *td, const char *name,
1175 size_t namelen, void *old, size_t *oldlenp, void *new,
1176 size_t newlen, size_t *retval, int flags, bool inkernel);
1179 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
1180 struct sysctl_req *);
1181 #else /* !_KERNEL */
1182 #include <sys/cdefs.h>
1185 int sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
1186 int sysctlbyname(const char *, void *, size_t *, const void *, size_t);
1187 int sysctlnametomib(const char *, int *, size_t *);
1189 #endif /* _KERNEL */
1191 #endif /* !_SYS_SYSCTL_H_ */