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_QUAD    4       /* name describes a 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
  76 #define CTLFLAG_RD      0x80000000      /* Allow reads of variable */
  77 #define CTLFLAG_WR      0x40000000      /* Allow writes to the variable */
  78 #define CTLFLAG_RW      (CTLFLAG_RD|CTLFLAG_WR)
  79 #define CTLFLAG_NOLOCK  0x20000000      /* XXX Don't Lock */
  80 #define CTLFLAG_ANYBODY 0x10000000      /* All users can set this var */
  81 #define CTLFLAG_SECURE  0x08000000      /* Permit set only if securelevel<=0 */
  82 #define CTLFLAG_PRISON  0x04000000      /* Prisoned roots can fiddle */
  83 #define CTLFLAG_DYN     0x02000000      /* Dynamic oid - can be freed */
  84 #define CTLFLAG_SKIP    0x01000000      /* Skip this sysctl when listing */
  85 #define CTLMASK_SECURE  0x00F00000      /* Secure level */
  86 #define CTLFLAG_TUN     0x00080000      /* Tunable variable */
  87 #define CTLFLAG_MPSAFE  0x00040000      /* Handler is MP safe */
  88 #define CTLFLAG_VNET    0x00020000      /* Prisons with vnet can fiddle */
  89 #define CTLFLAG_RDTUN   (CTLFLAG_RD|CTLFLAG_TUN)
  90 #define CTLFLAG_DYING   0x00010000      /* oid is being removed */
  91
  92 /*
  93  * Secure level.   Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
  94  *
  95  * Secure when the securelevel is raised to at least N.
  96  */
  97 #define CTLSHIFT_SECURE 20
  98 #define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
  99 #define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
 100 #define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
 101
 102 /*
 103  * USE THIS instead of a hardwired number from the categories below
 104  * to get dynamically assigned sysctl entries using the linker-set
 105  * technology. This is the way nearly all new sysctl variables should
 106  * be implemented.
 107  * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
 108  */
 109 #define OID_AUTO        (-1)
 110
 111 /*
 112  * The starting number for dynamically-assigned entries.  WARNING!
 113  * ALL static sysctl entries should have numbers LESS than this!
 114  */
 115 #define CTL_AUTO_START  0x100
 116
 117 #ifdef _KERNEL
 118 #include <sys/linker_set.h>
 119
 120 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \
 121         struct sysctl_req *req
 122
 123 /* definitions for sysctl_req 'lock' member */
 124 #define REQ_UNLOCKED    0       /* not locked and not wired */
 125 #define REQ_LOCKED      1       /* locked and not wired */
 126 #define REQ_WIRED       2       /* locked and wired */
 127
 128 /* definitions for sysctl_req 'flags' member */
 129 #if defined(__amd64__) || defined(__ia64__)
 130 #define SCTL_MASK32     1       /* 32 bit emulation */
 131 #endif
 132
 133 /*
 134  * This describes the access space for a sysctl request.  This is needed
 135  * so that we can use the interface from the kernel or from user-space.
 136  */
 137 struct sysctl_req {
 138         struct thread   *td;            /* used for access checking */
 139         int             lock;           /* locking/wiring state */
 140         void            *oldptr;
 141         size_t          oldlen;
 142         size_t          oldidx;
 143         int             (*oldfunc)(struct sysctl_req *, const void *, size_t);
 144         void            *newptr;
 145         size_t          newlen;
 146         size_t          newidx;
 147         int             (*newfunc)(struct sysctl_req *, void *, size_t);
 148         size_t          validlen;
 149         int             flags;
 150 };
 151
 152 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
 153
 154 /*
 155  * This describes one "oid" in the MIB tree.  Potentially more nodes can
 156  * be hidden behind it, expanded by the handler.
 157  */
 158 struct sysctl_oid {
 159         struct sysctl_oid_list *oid_parent;
 160         SLIST_ENTRY(sysctl_oid) oid_link;
 161         int             oid_number;
 162         u_int           oid_kind;
 163         void            *oid_arg1;
 164         int             oid_arg2;
 165         const char      *oid_name;
 166         int             (*oid_handler)(SYSCTL_HANDLER_ARGS);
 167         const char      *oid_fmt;
 168         int16_t         oid_refcnt;
 169         uint16_t        oid_running;
 170         const char      *oid_descr;
 171 };
 172
 173 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
 174 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
 175
 176 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
 177 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
 178 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
 179 int sysctl_handle_quad(SYSCTL_HANDLER_ARGS);
 180 int sysctl_handle_intptr(SYSCTL_HANDLER_ARGS);
 181 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
 182 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
 183
 184 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
 185 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
 186 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
 187
 188 /*
 189  * These functions are used to add/remove an oid from the mib.
 190  */
 191 void sysctl_register_oid(struct sysctl_oid *oidp);
 192 void sysctl_unregister_oid(struct sysctl_oid *oidp);
 193
 194 /* Declare a static oid to allow child oids to be added to it. */
 195 #define SYSCTL_DECL(name)                                       \
 196         extern struct sysctl_oid_list sysctl_##name##_children
 197
 198 /* Hide these in macros */
 199 #define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \
 200         (oid_ptr)->oid_arg1
 201 #define SYSCTL_CHILDREN_SET(oid_ptr, val) \
 202         (oid_ptr)->oid_arg1 = (val);
 203 #define SYSCTL_STATIC_CHILDREN(oid_name) \
 204         (&sysctl_##oid_name##_children)
 205
 206 /* === Structs and macros related to context handling === */
 207
 208 /* All dynamically created sysctls can be tracked in a context list. */
 209 struct sysctl_ctx_entry {
 210         struct sysctl_oid *entry;
 211         TAILQ_ENTRY(sysctl_ctx_entry) link;
 212 };
 213
 214 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
 215
 216 #define SYSCTL_NODE_CHILDREN(parent, name) \
 217         sysctl_##parent##_##name##_children
 218
 219 #ifndef NO_SYSCTL_DESCR
 220 #define __DESCR(d) d
 221 #else
 222 #define __DESCR(d) ""
 223 #endif
 224
 225 /* This constructs a "raw" MIB oid. */
 226 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
 227         static struct sysctl_oid sysctl__##parent##_##name = {           \
 228                 &sysctl_##parent##_children, { NULL }, nbr, kind,        \
 229                 a1, a2, #name, handler, fmt, 0, 0, __DESCR(descr) };     \
 230         DATA_SET(sysctl_set, sysctl__##parent##_##name)
 231
 232 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
 233         sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr))
 234
 235 /* This constructs a node from which other oids can hang. */
 236 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr)              \
 237         struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);          \
 238         SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access),                \
 239             (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr)
 240
 241 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)     \
 242         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),       \
 243         NULL, 0, handler, "N", __DESCR(descr))
 244
 245 /* Oid for a string.  len can be 0 to indicate '\0' termination. */
 246 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
 247         SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \
 248                 arg, len, sysctl_handle_string, "A", descr)
 249
 250 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr)  \
 251         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),     \
 252         arg, len, sysctl_handle_string, "A", __DESCR(descr))
 253
 254 /* Oid for an int.  If ptr is NULL, val is returned. */
 255 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
 256         SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access), \
 257                 ptr, val, sysctl_handle_int, "I", descr)
 258
 259 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr)     \
 260         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access),         \
 261         ptr, val, sysctl_handle_int, "I", __DESCR(descr))
 262
 263 /* Oid for an unsigned int.  If ptr is NULL, val is returned. */
 264 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
 265         SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \
 266                 ptr, val, sysctl_handle_int, "IU", descr)
 267
 268 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr)    \
 269         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access),        \
 270         ptr, val, sysctl_handle_int, "IU", __DESCR(descr))
 271
 272 #define SYSCTL_XINT(parent, nbr, name, access, ptr, val, descr) \
 273         SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \
 274                 ptr, val, sysctl_handle_int, "IX", descr)
 275
 276 #define SYSCTL_ADD_XINT(ctx, parent, nbr, name, access, ptr, val, descr)    \
 277         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access),        \
 278         ptr, val, sysctl_handle_int, "IX", __DESCR(descr))
 279
 280 /* Oid for a long.  The pointer must be non NULL. */
 281 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \
 282         SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access), \
 283                 ptr, val, sysctl_handle_long, "L", descr)
 284
 285 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)         \
 286         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access),        \
 287         ptr, 0, sysctl_handle_long, "L", __DESCR(descr))
 288
 289 /* Oid for an unsigned long.  The pointer must be non NULL. */
 290 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \
 291         SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \
 292                 ptr, val, sysctl_handle_long, "LU", __DESCR(descr))
 293
 294 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)        \
 295         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access),       \
 296         ptr, 0, sysctl_handle_long, "LU", __DESCR(descr))
 297
 298 #define SYSCTL_XLONG(parent, nbr, name, access, ptr, val, descr) \
 299         SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \
 300                 ptr, val, sysctl_handle_long, "LX", __DESCR(descr))
 301
 302 #define SYSCTL_ADD_XLONG(ctx, parent, nbr, name, access, ptr, descr)        \
 303         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access),       \
 304         ptr, 0, sysctl_handle_long, "LX", __DESCR(descr))
 305
 306 /* Oid for a quad.  The pointer must be non NULL. */
 307 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \
 308         SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access), \
 309                 ptr, val, sysctl_handle_quad, "Q", __DESCR(descr))
 310
 311 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr)         \
 312         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access),        \
 313         ptr, 0, sysctl_handle_quad, "Q", __DESCR(descr))
 314
 315 /* Oid for an opaque object.  Specified by a pointer and a length. */
 316 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
 317         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
 318                 ptr, len, sysctl_handle_opaque, fmt, descr)
 319
 320 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\
 321         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),     \
 322         ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr))
 323
 324 /* Oid for a struct.  Specified by a pointer and a type. */
 325 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
 326         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
 327                 ptr, sizeof(struct type), sysctl_handle_opaque, \
 328                 "S," #type, descr)
 329
 330 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
 331         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),     \
 332         ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr))
 333
 334 /* Oid for a procedure.  Specified by a pointer and an arg. */
 335 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
 336         SYSCTL_OID(parent, nbr, name, (access), \
 337                 ptr, arg, handler, fmt, descr)
 338
 339 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
 340         sysctl_add_oid(ctx, parent, nbr, name, (access),                            \
 341         ptr, arg, handler, fmt, __DESCR(descr))
 342
 343 /*
 344  * A macro to generate a read-only sysctl to indicate the presense of optional
 345  * kernel features.
 346  */
 347 #define FEATURE(name, desc)                                             \
 348         SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD, 0, 1, desc)
 349
 350 #endif /* _KERNEL */
 351
 352 /*
 353  * Top-level identifiers
 354  */
 355 #define CTL_UNSPEC      0               /* unused */
 356 #define CTL_KERN        1               /* "high kernel": proc, limits */
 357 #define CTL_VM          2               /* virtual memory */
 358 #define CTL_VFS         3               /* filesystem, mount type is next */
 359 #define CTL_NET         4               /* network, see socket.h */
 360 #define CTL_DEBUG       5               /* debugging parameters */
 361 #define CTL_HW          6               /* generic cpu/io */
 362 #define CTL_MACHDEP     7               /* machine dependent */
 363 #define CTL_USER        8               /* user-level */
 364 #define CTL_P1003_1B    9               /* POSIX 1003.1B */
 365 #define CTL_MAXID       10              /* number of valid top-level ids */
 366
 367 #define CTL_NAMES { \
 368         { 0, 0 }, \
 369         { "kern", CTLTYPE_NODE }, \
 370         { "vm", CTLTYPE_NODE }, \
 371         { "vfs", CTLTYPE_NODE }, \
 372         { "net", CTLTYPE_NODE }, \
 373         { "debug", CTLTYPE_NODE }, \
 374         { "hw", CTLTYPE_NODE }, \
 375         { "machdep", CTLTYPE_NODE }, \
 376         { "user", CTLTYPE_NODE }, \
 377         { "p1003_1b", CTLTYPE_NODE }, \
 378 }
 379
 380 /*
 381  * CTL_KERN identifiers
 382  */
 383 #define KERN_OSTYPE              1      /* string: system version */
 384 #define KERN_OSRELEASE           2      /* string: system release */
 385 #define KERN_OSREV               3      /* int: system revision */
 386 #define KERN_VERSION             4      /* string: compile time info */
 387 #define KERN_MAXVNODES           5      /* int: max vnodes */
 388 #define KERN_MAXPROC             6      /* int: max processes */
 389 #define KERN_MAXFILES            7      /* int: max open files */
 390 #define KERN_ARGMAX              8      /* int: max arguments to exec */
 391 #define KERN_SECURELVL           9      /* int: system security level */
 392 #define KERN_HOSTNAME           10      /* string: hostname */
 393 #define KERN_HOSTID             11      /* int: host identifier */
 394 #define KERN_CLOCKRATE          12      /* struct: struct clockrate */
 395 #define KERN_VNODE              13      /* struct: vnode structures */
 396 #define KERN_PROC               14      /* struct: process entries */
 397 #define KERN_FILE               15      /* struct: file entries */
 398 #define KERN_PROF               16      /* node: kernel profiling info */
 399 #define KERN_POSIX1             17      /* int: POSIX.1 version */
 400 #define KERN_NGROUPS            18      /* int: # of supplemental group ids */
 401 #define KERN_JOB_CONTROL        19      /* int: is job control available */
 402 #define KERN_SAVED_IDS          20      /* int: saved set-user/group-ID */
 403 #define KERN_BOOTTIME           21      /* struct: time kernel was booted */
 404 #define KERN_NISDOMAINNAME      22      /* string: YP domain name */
 405 #define KERN_UPDATEINTERVAL     23      /* int: update process sleep time */
 406 #define KERN_OSRELDATE          24      /* int: kernel release date */
 407 #define KERN_NTP_PLL            25      /* node: NTP PLL control */
 408 #define KERN_BOOTFILE           26      /* string: name of booted kernel */
 409 #define KERN_MAXFILESPERPROC    27      /* int: max open files per proc */
 410 #define KERN_MAXPROCPERUID      28      /* int: max processes per uid */
 411 #define KERN_DUMPDEV            29      /* struct cdev *: device to dump on */
 412 #define KERN_IPC                30      /* node: anything related to IPC */
 413 #define KERN_DUMMY              31      /* unused */
 414 #define KERN_PS_STRINGS         32      /* int: address of PS_STRINGS */
 415 #define KERN_USRSTACK           33      /* int: address of USRSTACK */
 416 #define KERN_LOGSIGEXIT         34      /* int: do we log sigexit procs? */
 417 #define KERN_IOV_MAX            35      /* int: value of UIO_MAXIOV */
 418 #define KERN_HOSTUUID           36      /* string: host UUID identifier */
 419 #define KERN_ARND               37      /* int: from arc4rand() */
 420 #define KERN_MAXID              38      /* number of valid kern ids */
 421
 422 #define CTL_KERN_NAMES { \
 423         { 0, 0 }, \
 424         { "ostype", CTLTYPE_STRING }, \
 425         { "osrelease", CTLTYPE_STRING }, \
 426         { "osrevision", CTLTYPE_INT }, \
 427         { "version", CTLTYPE_STRING }, \
 428         { "maxvnodes", CTLTYPE_INT }, \
 429         { "maxproc", CTLTYPE_INT }, \
 430         { "maxfiles", CTLTYPE_INT }, \
 431         { "argmax", CTLTYPE_INT }, \
 432         { "securelevel", CTLTYPE_INT }, \
 433         { "hostname", CTLTYPE_STRING }, \
 434         { "hostid", CTLTYPE_UINT }, \
 435         { "clockrate", CTLTYPE_STRUCT }, \
 436         { "vnode", CTLTYPE_STRUCT }, \
 437         { "proc", CTLTYPE_STRUCT }, \
 438         { "file", CTLTYPE_STRUCT }, \
 439         { "profiling", CTLTYPE_NODE }, \
 440         { "posix1version", CTLTYPE_INT }, \
 441         { "ngroups", CTLTYPE_INT }, \
 442         { "job_control", CTLTYPE_INT }, \
 443         { "saved_ids", CTLTYPE_INT }, \
 444         { "boottime", CTLTYPE_STRUCT }, \
 445         { "nisdomainname", CTLTYPE_STRING }, \
 446         { "update", CTLTYPE_INT }, \
 447         { "osreldate", CTLTYPE_INT }, \
 448         { "ntp_pll", CTLTYPE_NODE }, \
 449         { "bootfile", CTLTYPE_STRING }, \
 450         { "maxfilesperproc", CTLTYPE_INT }, \
 451         { "maxprocperuid", CTLTYPE_INT }, \
 452         { "ipc", CTLTYPE_NODE }, \
 453         { "dummy", CTLTYPE_INT }, \
 454         { "ps_strings", CTLTYPE_INT }, \
 455         { "usrstack", CTLTYPE_INT }, \
 456         { "logsigexit", CTLTYPE_INT }, \
 457         { "iov_max", CTLTYPE_INT }, \
 458         { "hostuuid", CTLTYPE_STRING }, \
 459         { "arc4rand", CTLTYPE_OPAQUE }, \
 460 }
 461
 462 /*
 463  * CTL_VFS identifiers
 464  */
 465 #define CTL_VFS_NAMES { \
 466         { "vfsconf", CTLTYPE_STRUCT }, \
 467 }
 468
 469 /*
 470  * KERN_PROC subtypes
 471  */
 472 #define KERN_PROC_ALL           0       /* everything */
 473 #define KERN_PROC_PID           1       /* by process id */
 474 #define KERN_PROC_PGRP          2       /* by process group id */
 475 #define KERN_PROC_SESSION       3       /* by session of pid */
 476 #define KERN_PROC_TTY           4       /* by controlling tty */
 477 #define KERN_PROC_UID           5       /* by effective uid */
 478 #define KERN_PROC_RUID          6       /* by real uid */
 479 #define KERN_PROC_ARGS          7       /* get/set arguments/proctitle */
 480 #define KERN_PROC_PROC          8       /* only return procs */
 481 #define KERN_PROC_SV_NAME       9       /* get syscall vector name */
 482 #define KERN_PROC_RGID          10      /* by real group id */
 483 #define KERN_PROC_GID           11      /* by effective group id */
 484 #define KERN_PROC_PATHNAME      12      /* path to executable */
 485 #define KERN_PROC_OVMMAP        13      /* Old VM map entries for process */
 486 #define KERN_PROC_OFILEDESC     14      /* Old file descriptors for process */
 487 #define KERN_PROC_KSTACK        15      /* Kernel stacks for process */
 488 #define KERN_PROC_INC_THREAD    0x10    /*
 489                                          * modifier for pid, pgrp, tty,
 490                                          * uid, ruid, gid, rgid and proc
 491                                          * This effectively uses 16-31
 492                                          */
 493 #define KERN_PROC_VMMAP         32      /* VM map entries for process */
 494 #define KERN_PROC_FILEDESC      33      /* File descriptors for process */
 495 #define KERN_PROC_GROUPS        34      /* process groups */
 496 #define KERN_PROC_OSREL         40      /* osreldate for process binary */
 497
 498 /*
 499  * KERN_IPC identifiers
 500  */
 501 #define KIPC_MAXSOCKBUF         1       /* int: max size of a socket buffer */
 502 #define KIPC_SOCKBUF_WASTE      2       /* int: wastage factor in sockbuf */
 503 #define KIPC_SOMAXCONN          3       /* int: max length of connection q */
 504 #define KIPC_MAX_LINKHDR        4       /* int: max length of link header */
 505 #define KIPC_MAX_PROTOHDR       5       /* int: max length of network header */
 506 #define KIPC_MAX_HDR            6       /* int: max total length of headers */
 507 #define KIPC_MAX_DATALEN        7       /* int: max length of data? */
 508
 509 /*
 510  * CTL_HW identifiers
 511  */
 512 #define HW_MACHINE       1              /* string: machine class */
 513 #define HW_MODEL         2              /* string: specific machine model */
 514 #define HW_NCPU          3              /* int: number of cpus */
 515 #define HW_BYTEORDER     4              /* int: machine byte order */
 516 #define HW_PHYSMEM       5              /* int: total memory */
 517 #define HW_USERMEM       6              /* int: non-kernel memory */
 518 #define HW_PAGESIZE      7              /* int: software page size */
 519 #define HW_DISKNAMES     8              /* strings: disk drive names */
 520 #define HW_DISKSTATS     9              /* struct: diskstats[] */
 521 #define HW_FLOATINGPT   10              /* int: has HW floating point? */
 522 #define HW_MACHINE_ARCH 11              /* string: machine architecture */
 523 #define HW_REALMEM      12              /* int: 'real' memory */
 524 #define HW_MAXID        13              /* number of valid hw ids */
 525
 526 #define CTL_HW_NAMES { \
 527         { 0, 0 }, \
 528         { "machine", CTLTYPE_STRING }, \
 529         { "model", CTLTYPE_STRING }, \
 530         { "ncpu", CTLTYPE_INT }, \
 531         { "byteorder", CTLTYPE_INT }, \
 532         { "physmem", CTLTYPE_ULONG }, \
 533         { "usermem", CTLTYPE_ULONG }, \
 534         { "pagesize", CTLTYPE_INT }, \
 535         { "disknames", CTLTYPE_STRUCT }, \
 536         { "diskstats", CTLTYPE_STRUCT }, \
 537         { "floatingpoint", CTLTYPE_INT }, \
 538         { "machine_arch", CTLTYPE_STRING }, \
 539         { "realmem", CTLTYPE_ULONG }, \
 540 }
 541
 542 /*
 543  * CTL_USER definitions
 544  */
 545 #define USER_CS_PATH             1      /* string: _CS_PATH */
 546 #define USER_BC_BASE_MAX         2      /* int: BC_BASE_MAX */
 547 #define USER_BC_DIM_MAX          3      /* int: BC_DIM_MAX */
 548 #define USER_BC_SCALE_MAX        4      /* int: BC_SCALE_MAX */
 549 #define USER_BC_STRING_MAX       5      /* int: BC_STRING_MAX */
 550 #define USER_COLL_WEIGHTS_MAX    6      /* int: COLL_WEIGHTS_MAX */
 551 #define USER_EXPR_NEST_MAX       7      /* int: EXPR_NEST_MAX */
 552 #define USER_LINE_MAX            8      /* int: LINE_MAX */
 553 #define USER_RE_DUP_MAX          9      /* int: RE_DUP_MAX */
 554 #define USER_POSIX2_VERSION     10      /* int: POSIX2_VERSION */
 555 #define USER_POSIX2_C_BIND      11      /* int: POSIX2_C_BIND */
 556 #define USER_POSIX2_C_DEV       12      /* int: POSIX2_C_DEV */
 557 #define USER_POSIX2_CHAR_TERM   13      /* int: POSIX2_CHAR_TERM */
 558 #define USER_POSIX2_FORT_DEV    14      /* int: POSIX2_FORT_DEV */
 559 #define USER_POSIX2_FORT_RUN    15      /* int: POSIX2_FORT_RUN */
 560 #define USER_POSIX2_LOCALEDEF   16      /* int: POSIX2_LOCALEDEF */
 561 #define USER_POSIX2_SW_DEV      17      /* int: POSIX2_SW_DEV */
 562 #define USER_POSIX2_UPE         18      /* int: POSIX2_UPE */
 563 #define USER_STREAM_MAX         19      /* int: POSIX2_STREAM_MAX */
 564 #define USER_TZNAME_MAX         20      /* int: POSIX2_TZNAME_MAX */
 565 #define USER_MAXID              21      /* number of valid user ids */
 566
 567 #define CTL_USER_NAMES { \
 568         { 0, 0 }, \
 569         { "cs_path", CTLTYPE_STRING }, \
 570         { "bc_base_max", CTLTYPE_INT }, \
 571         { "bc_dim_max", CTLTYPE_INT }, \
 572         { "bc_scale_max", CTLTYPE_INT }, \
 573         { "bc_string_max", CTLTYPE_INT }, \
 574         { "coll_weights_max", CTLTYPE_INT }, \
 575         { "expr_nest_max", CTLTYPE_INT }, \
 576         { "line_max", CTLTYPE_INT }, \
 577         { "re_dup_max", CTLTYPE_INT }, \
 578         { "posix2_version", CTLTYPE_INT }, \
 579         { "posix2_c_bind", CTLTYPE_INT }, \
 580         { "posix2_c_dev", CTLTYPE_INT }, \
 581         { "posix2_char_term", CTLTYPE_INT }, \
 582         { "posix2_fort_dev", CTLTYPE_INT }, \
 583         { "posix2_fort_run", CTLTYPE_INT }, \
 584         { "posix2_localedef", CTLTYPE_INT }, \
 585         { "posix2_sw_dev", CTLTYPE_INT }, \
 586         { "posix2_upe", CTLTYPE_INT }, \
 587         { "stream_max", CTLTYPE_INT }, \
 588         { "tzname_max", CTLTYPE_INT }, \
 589 }
 590
 591 #define CTL_P1003_1B_ASYNCHRONOUS_IO            1       /* boolean */
 592 #define CTL_P1003_1B_MAPPED_FILES               2       /* boolean */
 593 #define CTL_P1003_1B_MEMLOCK                    3       /* boolean */
 594 #define CTL_P1003_1B_MEMLOCK_RANGE              4       /* boolean */
 595 #define CTL_P1003_1B_MEMORY_PROTECTION          5       /* boolean */
 596 #define CTL_P1003_1B_MESSAGE_PASSING            6       /* boolean */
 597 #define CTL_P1003_1B_PRIORITIZED_IO             7       /* boolean */
 598 #define CTL_P1003_1B_PRIORITY_SCHEDULING        8       /* boolean */
 599 #define CTL_P1003_1B_REALTIME_SIGNALS           9       /* boolean */
 600 #define CTL_P1003_1B_SEMAPHORES                 10      /* boolean */
 601 #define CTL_P1003_1B_FSYNC                      11      /* boolean */
 602 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS      12      /* boolean */
 603 #define CTL_P1003_1B_SYNCHRONIZED_IO            13      /* boolean */
 604 #define CTL_P1003_1B_TIMERS                     14      /* boolean */
 605 #define CTL_P1003_1B_AIO_LISTIO_MAX             15      /* int */
 606 #define CTL_P1003_1B_AIO_MAX                    16      /* int */
 607 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX         17      /* int */
 608 #define CTL_P1003_1B_DELAYTIMER_MAX             18      /* int */
 609 #define CTL_P1003_1B_MQ_OPEN_MAX                19      /* int */
 610 #define CTL_P1003_1B_PAGESIZE                   20      /* int */
 611 #define CTL_P1003_1B_RTSIG_MAX                  21      /* int */
 612 #define CTL_P1003_1B_SEM_NSEMS_MAX              22      /* int */
 613 #define CTL_P1003_1B_SEM_VALUE_MAX              23      /* int */
 614 #define CTL_P1003_1B_SIGQUEUE_MAX               24      /* int */
 615 #define CTL_P1003_1B_TIMER_MAX                  25      /* int */
 616
 617 #define CTL_P1003_1B_MAXID              26
 618
 619 #define CTL_P1003_1B_NAMES { \
 620         { 0, 0 }, \
 621         { "asynchronous_io", CTLTYPE_INT }, \
 622         { "mapped_files", CTLTYPE_INT }, \
 623         { "memlock", CTLTYPE_INT }, \
 624         { "memlock_range", CTLTYPE_INT }, \
 625         { "memory_protection", CTLTYPE_INT }, \
 626         { "message_passing", CTLTYPE_INT }, \
 627         { "prioritized_io", CTLTYPE_INT }, \
 628         { "priority_scheduling", CTLTYPE_INT }, \
 629         { "realtime_signals", CTLTYPE_INT }, \
 630         { "semaphores", CTLTYPE_INT }, \
 631         { "fsync", CTLTYPE_INT }, \
 632         { "shared_memory_objects", CTLTYPE_INT }, \
 633         { "synchronized_io", CTLTYPE_INT }, \
 634         { "timers", CTLTYPE_INT }, \
 635         { "aio_listio_max", CTLTYPE_INT }, \
 636         { "aio_max", CTLTYPE_INT }, \
 637         { "aio_prio_delta_max", CTLTYPE_INT }, \
 638         { "delaytimer_max", CTLTYPE_INT }, \
 639         { "mq_open_max", CTLTYPE_INT }, \
 640         { "pagesize", CTLTYPE_INT }, \
 641         { "rtsig_max", CTLTYPE_INT }, \
 642         { "nsems_max", CTLTYPE_INT }, \
 643         { "sem_value_max", CTLTYPE_INT }, \
 644         { "sigqueue_max", CTLTYPE_INT }, \
 645         { "timer_max", CTLTYPE_INT }, \
 646 }
 647
 648 #ifdef _KERNEL
 649
 650 /*
 651  * Declare some common oids.
 652  */
 653 extern struct sysctl_oid_list sysctl__children;
 654 SYSCTL_DECL(_kern);
 655 SYSCTL_DECL(_kern_features);
 656 SYSCTL_DECL(_kern_ipc);
 657 SYSCTL_DECL(_kern_proc);
 658 SYSCTL_DECL(_kern_sched);
 659 SYSCTL_DECL(_kern_sched_stats);
 660 SYSCTL_DECL(_sysctl);
 661 SYSCTL_DECL(_vm);
 662 SYSCTL_DECL(_vm_stats);
 663 SYSCTL_DECL(_vm_stats_misc);
 664 SYSCTL_DECL(_vfs);
 665 SYSCTL_DECL(_net);
 666 SYSCTL_DECL(_debug);
 667 SYSCTL_DECL(_debug_sizeof);
 668 SYSCTL_DECL(_dev);
 669 SYSCTL_DECL(_hw);
 670 SYSCTL_DECL(_hw_bus);
 671 SYSCTL_DECL(_hw_bus_devices);
 672 SYSCTL_DECL(_hw_bus_info);
 673 SYSCTL_DECL(_machdep);
 674 SYSCTL_DECL(_user);
 675 SYSCTL_DECL(_compat);
 676 SYSCTL_DECL(_regression);
 677 SYSCTL_DECL(_security);
 678 SYSCTL_DECL(_security_bsd);
 679
 680 extern char     machine[];
 681 extern char     osrelease[];
 682 extern char     ostype[];
 683 extern char     kern_ident[];
 684
 685 /* Dynamic oid handling */
 686 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
 687                 struct sysctl_oid_list *parent, int nbr, const char *name,
 688                 int kind, void *arg1, int arg2,
 689                 int (*handler) (SYSCTL_HANDLER_ARGS),
 690                 const char *fmt, const char *descr);
 691 void    sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
 692 int     sysctl_move_oid(struct sysctl_oid *oidp,
 693                 struct sysctl_oid_list *parent);
 694 int     sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
 695 int     sysctl_ctx_init(struct sysctl_ctx_list *clist);
 696 int     sysctl_ctx_free(struct sysctl_ctx_list *clist);
 697 struct  sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
 698                 struct sysctl_oid *oidp);
 699 struct  sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
 700                 struct sysctl_oid *oidp);
 701 int     sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
 702                 struct sysctl_oid *oidp);
 703
 704 int     kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
 705                       size_t *oldlenp, void *new, size_t newlen,
 706                       size_t *retval, int flags);
 707 int     kernel_sysctlbyname(struct thread *td, char *name,
 708                 void *old, size_t *oldlenp, void *new, size_t newlen,
 709                 size_t *retval, int flags);
 710 int     userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
 711                         size_t *oldlenp, int inkernel, void *new, size_t newlen,
 712                         size_t *retval, int flags);
 713 int     sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
 714                         int *nindx, struct sysctl_req *req);
 715 void    sysctl_lock(void);
 716 void    sysctl_unlock(void);
 717 int     sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
 718
 719 struct sbuf;
 720 struct sbuf     *sbuf_new_for_sysctl(struct sbuf *, char *, int,
 721                     struct sysctl_req *);
 722 #else   /* !_KERNEL */
 723 #include <sys/cdefs.h>
 724
 725 __BEGIN_DECLS
 726 int     sysctl(int *, u_int, void *, size_t *, void *, size_t);
 727 int     sysctlbyname(const char *, void *, size_t *, void *, size_t);
 728 int     sysctlnametomib(const char *, int *, size_t *);
 729 __END_DECLS
 730 #endif  /* _KERNEL */
 731
 732 #endif  /* !_SYS_SYSCTL_H_ */