sys/sys/sysctl.h

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