sys/sys/sysctl.h

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