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  * 3. 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: head/sys/sys/sysctl.h 204170 2010-02-21 13:57:02Z ed $
  34  */
  35
  36 #ifndef _SYS_SYSCTL_H_
  37 #define _SYS_SYSCTL_H_
  38
  39 #ifndef _SYS_TYPES_H_
  40 #include <sys/types.h>
  41 #endif
  42 #ifndef _SYS_QUEUE_H_
  43 #include <sys/queue.h>
  44 #endif
  45
  46 /*
  47  * Definitions for sysctl call.  The sysctl call uses a hierarchical name
  48  * for objects that can be examined or modified.  The name is expressed as
  49  * a sequence of integers.  Like a file path name, the meaning of each
  50  * component depends on its place in the hierarchy.  The top-level and kern
  51  * identifiers are defined here, and other identifiers are defined in the
  52  * respective subsystem header files.
  53  */
  54
  55 #define CTL_MAXNAME     12      /* largest number of components supported */
  56
  57 /*
  58  * Each subsystem defined by sysctl defines a list of variables
  59  * for that subsystem. Each name is either a node with further
  60  * levels defined below it, or it is a leaf of some particular
  61  * type given below. Each sysctl level defines a set of name/type
  62  * pairs to be used by sysctl(1) in manipulating the subsystem.
  63  */
  64 struct ctlname {
  65         char    *ctl_name;      /* subsystem name */
  66         int     ctl_type;       /* type of name */
  67 };
  68
  69 #define CTLTYPE         0xf     /* Mask for the type */
  70 #define CTLTYPE_NODE    1       /* name is a node */
  71 #define CTLTYPE_INT     2       /* name describes an integer */
  72 #define CTLTYPE_STRING  3       /* name describes a string */
  73 #define CTLTYPE_QUAD    4       /* name describes a 64-bit number */
  74 #define CTLTYPE_OPAQUE  5       /* name describes a structure */
  75 #define CTLTYPE_STRUCT  CTLTYPE_OPAQUE  /* name describes a structure */
  76 #define CTLTYPE_UINT    6       /* name describes an unsigned integer */
  77 #define CTLTYPE_LONG    7       /* name describes a long */
  78 #define CTLTYPE_ULONG   8       /* name describes an unsigned long */
  79 #define CTLTYPE_UQUAD   9       /* name describes an unsigned 64-bit number */
  80
  81 #define CTLFLAG_RD      0x80000000      /* Allow reads of variable */
  82 #define CTLFLAG_WR      0x40000000      /* Allow writes to the variable */
  83 #define CTLFLAG_RW      (CTLFLAG_RD|CTLFLAG_WR)
  84 #define CTLFLAG_ANYBODY 0x10000000      /* All users can set this var */
  85 #define CTLFLAG_SECURE  0x08000000      /* Permit set only if securelevel<=0 */
  86 #define CTLFLAG_PRISON  0x04000000      /* Prisoned roots can fiddle */
  87 #define CTLFLAG_DYN     0x02000000      /* Dynamic oid - can be freed */
  88 #define CTLFLAG_SKIP    0x01000000      /* Skip this sysctl when listing */
  89 #define CTLMASK_SECURE  0x00F00000      /* Secure level */
  90 #define CTLFLAG_DYING   0x00010000      /* Oid is being removed */
  91 #define CTLFLAG_SHLOCK  0x00008000      /* shlock on write (def is exlock) */
  92 #define CTLFLAG_EXLOCK  0x00004000      /* exlock on read (def is shlock) */
  93 #define CTLFLAG_NOLOCK  0x00002000      /* no lock required */
  94 #define CTLMASK_TYPE    0x0000000F      /* type field */
  95
  96 /*
  97  * USE THIS instead of a hardwired number from the categories below
  98  * to get dynamically assigned sysctl entries using the linker-set
  99  * technology. This is the way nearly all new sysctl variables should
 100  * be implemented.
 101  * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
 102  */
 103 #define OID_AUTO        (-1)
 104
 105 #ifdef _KERNEL
 106
 107 #include <sys/kernel.h>                 /* for DATA_SET */
 108 #ifndef _SYS_LOCK_H_
 109 #include <sys/lock.h>
 110 #endif
 111
 112 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \
 113         struct sysctl_req *req
 114
 115 /*
 116  * This describes the access space for a sysctl request.  This is needed
 117  * so that we can use the interface from the kernel or from user-space.
 118  */
 119 struct sysctl_req {
 120         struct thread   *td;            /* used for access checking */
 121         int              lock;          /* wiring state */
 122         void            *oldptr;
 123         size_t           oldlen;
 124         size_t           oldidx;
 125         int             (*oldfunc)(struct sysctl_req *, const void *, size_t);
 126         void            *newptr;
 127         size_t           newlen;
 128         size_t           newidx;
 129         int             (*newfunc)(struct sysctl_req *, void *, size_t);
 130         size_t           validlen;
 131         int              flags;
 132 };
 133
 134 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
 135
 136 /*
 137  * This describes one "oid" in the MIB tree.  Potentially more nodes can
 138  * be hidden behind it, expanded by the handler.
 139  */
 140 struct sysctl_oid {
 141         struct sysctl_oid_list *oid_parent;
 142         SLIST_ENTRY(sysctl_oid) oid_link;
 143         int             oid_number;
 144         int             oid_kind;
 145         void            *oid_arg1;
 146         int             oid_arg2;
 147         const char      *oid_name;
 148         int             (*oid_handler)(SYSCTL_HANDLER_ARGS);
 149         const char      *oid_fmt;
 150         int             oid_refcnt;
 151         u_int            oid_running;
 152         const char      *oid_descr;
 153         struct lock     oid_lock;       /* per-node lock */
 154 };
 155
 156 #define SYSCTL_IN(r, p, l)      (r->newfunc)(r, p, l)
 157 #define SYSCTL_OUT(r, p, l)     (r->oldfunc)(r, p, l)
 158 #define SYSCTL_OUT_STR(r, p)    (r->oldfunc)(r, p, strlen(p) + 1)
 159
 160 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
 161 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
 162 int sysctl_handle_quad(SYSCTL_HANDLER_ARGS);
 163 int sysctl_handle_intptr(SYSCTL_HANDLER_ARGS);
 164 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
 165 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
 166
 167 extern struct lock sysctllock;
 168
 169 #define SYSCTL_XLOCK()          _sysctl_xlock()
 170 #define SYSCTL_XUNLOCK()        _sysctl_xunlock()
 171 #define SYSCTL_SLOCK()          lockmgr(&mycpu->gd_sysctllock, LK_SHARED)
 172 #define SYSCTL_SUNLOCK()        lockmgr(&mycpu->gd_sysctllock, LK_RELEASE)
 173 #define SYSCTL_ASSERT_LOCKED() \
 174         KKASSERT(lockstatus(&mycpu->gd_sysctllock, curthread) != 0)
 175
 176 /*
 177  * These functions are used to add/remove an oid from the mib.
 178  */
 179 void sysctl_register_oid(struct sysctl_oid *oidp);
 180 void sysctl_unregister_oid(struct sysctl_oid *oidp);
 181
 182 /* Declare a static oid to allow child oids to be added to it. */
 183 #define SYSCTL_DECL(name)                                       \
 184         extern struct sysctl_oid_list sysctl_##name##_children
 185
 186 /* Hide these in macros */
 187 #define SYSCTL_SET_CHILDREN(oid_ptr, children) do {                     \
 188         (oid_ptr)->oid_arg1 = (children);                               \
 189 } while(0)
 190 #define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \
 191         (oid_ptr)->oid_arg1
 192 #define SYSCTL_STATIC_CHILDREN(oid_name) \
 193         (&sysctl_##oid_name##_children)
 194
 195 /* === Structs and macros related to context handling === */
 196
 197 /* All dynamically created sysctls can be tracked in a context list. */
 198 struct sysctl_ctx_entry {
 199         struct sysctl_oid *entry;
 200         TAILQ_ENTRY(sysctl_ctx_entry) link;
 201 };
 202
 203 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
 204
 205 #define SYSCTL_NODE_CHILDREN(parent, name) \
 206         sysctl_##parent##_##name##_children
 207
 208 #ifndef NO_SYSCTL_DESCR
 209 #define __DESCR(d) d
 210 #else
 211 #define __DESCR(d) ""
 212 #endif
 213
 214 /* This constructs a "raw" MIB oid. */
 215 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr)\
 216         static struct sysctl_oid sysctl__##parent##_##name = {          \
 217                 &sysctl_##parent##_children,                            \
 218                 { NULL },                                               \
 219                 nbr,                                                    \
 220                 kind,                                                   \
 221                 a1,                                                     \
 222                 a2,                                                     \
 223                 #name,                                                  \
 224                 handler,                                                \
 225                 fmt,                                                    \
 226                 0,                                                      \
 227                 0,                                                      \
 228                 __DESCR(descr)                                          \
 229                 };                                                      \
 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);
 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         0, 0, handler, "N", 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)
 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|(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|(access),    \
 261         ptr, val, sysctl_handle_int, "I", descr)
 262
 263 /* Oid for a quad.  If ptr is NULL, val is returned. */
 264 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)         \
 265         SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|(access),            \
 266                 ptr, val, sysctl_handle_quad, "Q", descr)
 267
 268 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, val, descr) \
 269         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_QUAD|(access),   \
 270         ptr, val, sysctl_handle_quad, "Q", descr)
 271
 272 /* Oid for an unsigned quad.  If ptr is NULL, val is returned. */
 273 #define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)        \
 274         SYSCTL_OID(parent, nbr, name, CTLTYPE_UQUAD|(access),           \
 275                 ptr, val, sysctl_handle_quad, "QU", descr)
 276
 277 #define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, val, descr) \
 278         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UQUAD|(access),  \
 279         ptr, val, sysctl_handle_quad, "QU", descr)
 280
 281 /* Oid for an unsigned int.  If ptr is NULL, val is returned. */
 282 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)         \
 283         SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access),            \
 284                 ptr, val, sysctl_handle_int, "IU", descr)
 285
 286 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
 287         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|(access),   \
 288         ptr, val, sysctl_handle_int, "IU", descr)
 289
 290 /* Oid for a long.  The pointer must be non NULL. */
 291 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)         \
 292         SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|(access),            \
 293                 ptr, val, sysctl_handle_long, "L", descr)
 294
 295 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)     \
 296         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|(access),   \
 297         ptr, 0, sysctl_handle_long, "L", descr)
 298
 299 /* Oid for a long.  The pointer must be non NULL. */
 300 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)        \
 301         SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|(access),           \
 302                 ptr, val, sysctl_handle_long, "LU", descr)
 303
 304 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)    \
 305         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|(access),  \
 306         ptr, 0, sysctl_handle_long, "LU", descr)
 307
 308 /* Oid for an opaque object.  Specified by a pointer and a length. */
 309 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)  \
 310         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),          \
 311                 ptr, len, sysctl_handle_opaque, fmt, descr)
 312
 313 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr) \
 314         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
 315         ptr, len, sysctl_handle_opaque, fmt, descr)
 316
 317 /* Oid for a struct.  Specified by a pointer and a type. */
 318 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)      \
 319         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access),          \
 320                 ptr, sizeof(struct type), sysctl_handle_opaque,         \
 321                 "S," #type, descr)
 322
 323 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
 324         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
 325         ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, descr)
 326
 327 /* Oid for a procedure.  Specified by a pointer and an arg. */
 328 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
 329         SYSCTL_OID(parent, nbr, name, (access),                         \
 330                 ptr, arg, handler, fmt, descr)
 331
 332 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
 333         sysctl_add_oid(ctx, parent, nbr, name, (access),                \
 334         ptr, arg, handler, fmt, descr)
 335
 336 #endif /* _KERNEL */
 337
 338 /*
 339  * Top-level identifiers
 340  */
 341 #define CTL_UNSPEC      0               /* unused */
 342 #define CTL_KERN        1               /* "high kernel": proc, limits */
 343 #define CTL_VM          2               /* virtual memory */
 344 #define CTL_VFS         3               /* file system, mount type is next */
 345 #define CTL_NET         4               /* network, see socket.h */
 346 #define CTL_DEBUG       5               /* debugging parameters */
 347 #define CTL_HW          6               /* generic cpu/io */
 348 #define CTL_MACHDEP     7               /* machine dependent */
 349 #define CTL_USER        8               /* user-level */
 350 #define CTL_P1003_1B    9               /* POSIX 1003.1B */
 351 #define CTL_LWKT        10              /* light weight kernel threads */
 352 #define CTL_MAXID       11              /* number of valid top-level ids */
 353
 354 #define CTL_NAMES { \
 355         { 0, 0 }, \
 356         { "kern", CTLTYPE_NODE }, \
 357         { "vm", CTLTYPE_NODE }, \
 358         { "vfs", CTLTYPE_NODE }, \
 359         { "net", CTLTYPE_NODE }, \
 360         { "debug", CTLTYPE_NODE }, \
 361         { "hw", CTLTYPE_NODE }, \
 362         { "machdep", CTLTYPE_NODE }, \
 363         { "user", CTLTYPE_NODE }, \
 364         { "p1003_1b", CTLTYPE_NODE }, \
 365         { "lwkt", CTLTYPE_NODE }, \
 366 }
 367
 368 /*
 369  * CTL_KERN identifiers
 370  */
 371 #define KERN_OSTYPE              1      /* string: system version */
 372 #define KERN_OSRELEASE           2      /* string: system release */
 373 #define KERN_OSREV               3      /* int: system revision */
 374 #define KERN_VERSION             4      /* string: compile time info */
 375 #define KERN_MAXVNODES           5      /* int: max vnodes */
 376 #define KERN_MAXPROC             6      /* int: max processes */
 377 #define KERN_MAXFILES            7      /* int: max open files */
 378 #define KERN_ARGMAX              8      /* int: max arguments to exec */
 379 #define KERN_SECURELVL           9      /* int: system security level */
 380 #define KERN_HOSTNAME           10      /* string: hostname */
 381 #define KERN_HOSTID             11      /* int: host identifier */
 382 #define KERN_CLOCKRATE          12      /* struct: struct clockrate */
 383 #define KERN_VNODE              13      /* struct: vnode structures */
 384 #define KERN_PROC               14      /* struct: process entries */
 385 #define KERN_FILE               15      /* struct: file entries */
 386 #define KERN_PROF               16      /* node: kernel profiling info */
 387 #define KERN_POSIX1             17      /* int: POSIX.1 version */
 388 #define KERN_NGROUPS            18      /* int: # of supplemental group ids */
 389 #define KERN_JOB_CONTROL        19      /* int: is job control available */
 390 #define KERN_SAVED_IDS          20      /* int: saved set-user/group-ID */
 391 #define KERN_BOOTTIME           21      /* struct: time kernel was booted */
 392 #define KERN_NISDOMAINNAME      22      /* string: YP domain name */
 393 #define KERN_UPDATEINTERVAL     23      /* int: update process sleep time */
 394 #define KERN_OSRELDATE          24      /* int: OS release date */
 395 #define KERN_NTP_PLL            25      /* node: NTP PLL control */
 396 #define KERN_BOOTFILE           26      /* string: name of booted kernel */
 397 #define KERN_MAXFILESPERPROC    27      /* int: max open files per proc */
 398 #define KERN_MAXPROCPERUID      28      /* int: max processes per uid */
 399 #define KERN_DUMPDEV            29      /* udev_t: device to dump on */
 400 #define KERN_IPC                30      /* node: anything related to IPC */
 401 #define KERN_DUMMY              31      /* unused */
 402 #define KERN_PS_STRINGS         32      /* int: address of PS_STRINGS */
 403 #define KERN_USRSTACK           33      /* int: address of USRSTACK */
 404 #define KERN_LOGSIGEXIT         34      /* int: do we log sigexit procs? */
 405 #define KERN_IOV_MAX            35      /* int: value of UIO_MAXIOV */
 406 #define KERN_MAXPOSIXLOCKSPERUID 36     /* int: max POSIX locks per uid */
 407 #define KERN_MAXID              37      /* number of valid kern ids */
 408
 409 #define CTL_KERN_NAMES { \
 410         { 0, 0 }, \
 411         { "ostype", CTLTYPE_STRING }, \
 412         { "osrelease", CTLTYPE_STRING }, \
 413         { "osrevision", CTLTYPE_INT }, \
 414         { "version", CTLTYPE_STRING }, \
 415         { "maxvnodes", CTLTYPE_INT }, \
 416         { "maxproc", CTLTYPE_INT }, \
 417         { "maxfiles", CTLTYPE_INT }, \
 418         { "argmax", CTLTYPE_INT }, \
 419         { "securelevel", CTLTYPE_INT }, \
 420         { "hostname", CTLTYPE_STRING }, \
 421         { "hostid", CTLTYPE_UINT }, \
 422         { "clockrate", CTLTYPE_STRUCT }, \
 423         { "vnode", CTLTYPE_STRUCT }, \
 424         { "proc", CTLTYPE_STRUCT }, \
 425         { "file", CTLTYPE_STRUCT }, \
 426         { "profiling", CTLTYPE_NODE }, \
 427         { "posix1version", CTLTYPE_INT }, \
 428         { "ngroups", CTLTYPE_INT }, \
 429         { "job_control", CTLTYPE_INT }, \
 430         { "saved_ids", CTLTYPE_INT }, \
 431         { "boottime", CTLTYPE_STRUCT }, \
 432         { "nisdomainname", CTLTYPE_STRING }, \
 433         { "update", CTLTYPE_INT }, \
 434         { "osreldate", CTLTYPE_INT }, \
 435         { "ntp_pll", CTLTYPE_NODE }, \
 436         { "bootfile", CTLTYPE_STRING }, \
 437         { "maxfilesperproc", CTLTYPE_INT }, \
 438         { "maxprocperuid", CTLTYPE_INT }, \
 439         { "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \
 440         { "ipc", CTLTYPE_NODE }, \
 441         { "dummy", CTLTYPE_INT }, \
 442         { "ps_strings", CTLTYPE_INT }, \
 443         { "usrstack", CTLTYPE_INT }, \
 444         { "logsigexit", CTLTYPE_INT }, \
 445         { "iov_max", CTLTYPE_INT }, \
 446         { "maxposixlocksperuid", CTLTYPE_INT }, \
 447 }
 448
 449 /*
 450  * CTL_VFS identifiers
 451  */
 452 #define CTL_VFS_NAMES { \
 453         { "vfsconf", CTLTYPE_STRUCT }, \
 454 }
 455
 456 /*
 457  * KERN_PROC subtypes
 458  */
 459 #define KERN_PROC_ALL           0       /* everything */
 460 #define KERN_PROC_PID           1       /* by process id */
 461 #define KERN_PROC_PGRP          2       /* by process group id */
 462 #define KERN_PROC_SESSION       3       /* by session of pid */
 463 #define KERN_PROC_TTY           4       /* by controlling tty */
 464 #define KERN_PROC_UID           5       /* by effective uid */
 465 #define KERN_PROC_RUID          6       /* by real uid */
 466 #define KERN_PROC_ARGS          7       /* get/set arguments/proctitle */
 467 #define KERN_PROC_CWD           8       /* get cwd */
 468 #define KERN_PROC_PATHNAME      9       /* path to executable */
 469 #define KERN_PROC_SIGTRAMP      10      /* addr[2]: sigtramp addr range */
 470
 471 #define KERN_PROC_FLAGMASK      0x10
 472 #define KERN_PROC_FLAG_LWP      0x10
 473
 474 /*
 475  * KERN_IPC identifiers
 476  */
 477 #define KIPC_MAXSOCKBUF         1       /* int: max size of a socket buffer */
 478 #define KIPC_SOCKBUF_WASTE      2       /* int: wastage factor in sockbuf */
 479 #define KIPC_SOMAXCONN          3       /* int: max length of connection q */
 480 #define KIPC_MAX_LINKHDR        4       /* int: max length of link header */
 481 #define KIPC_MAX_PROTOHDR       5       /* int: max length of network header */
 482 #define KIPC_MAX_HDR            6       /* int: max total length of headers */
 483 #define KIPC_MAX_DATALEN        7       /* int: max length of data? */
 484 #define KIPC_MBSTAT             8       /* struct: mbuf usage statistics */
 485 #define KIPC_NMBCLUSTERS        9       /* int: maximum mbuf clusters */
 486
 487 /*
 488  * CTL_HW identifiers
 489  */
 490 #define HW_MACHINE       1              /* string: machine class */
 491 #define HW_MODEL         2              /* string: specific machine model */
 492 #define HW_NCPU          3              /* int: number of cpus */
 493 #define HW_BYTEORDER     4              /* int: machine byte order */
 494 #define HW_PHYSMEM       5              /* int: total memory */
 495 #define HW_USERMEM       6              /* int: non-kernel memory */
 496 #define HW_PAGESIZE      7              /* int: software page size */
 497 #define HW_DISKNAMES     8              /* strings: disk drive names */
 498 #define HW_DISKSTATS     9              /* struct: diskstats[] */
 499 #define HW_FLOATINGPT   10              /* int: has HW floating point? */
 500 #define HW_MACHINE_ARCH 11              /* string: machine architecture */
 501 #define HW_MACHINE_PLATFORM 12          /* string: platform architecture */
 502 #define HW_SENSORS      13              /* node: hardware sensors */
 503 #define HW_MAXID        14              /* number of valid hw ids */
 504
 505 #define CTL_HW_NAMES { \
 506         { 0, 0 }, \
 507         { "machine", CTLTYPE_STRING }, \
 508         { "model", CTLTYPE_STRING }, \
 509         { "ncpu", CTLTYPE_INT }, \
 510         { "byteorder", CTLTYPE_INT }, \
 511         { "physmem", CTLTYPE_ULONG }, \
 512         { "usermem", CTLTYPE_UINT }, \
 513         { "pagesize", CTLTYPE_INT }, \
 514         { "disknames", CTLTYPE_STRUCT }, \
 515         { "diskstats", CTLTYPE_STRUCT }, \
 516         { "floatingpoint", CTLTYPE_INT }, \
 517         { "arch", CTLTYPE_STRING }, \
 518         { "platform", CTLTYPE_STRING }, \
 519         { "sensors", CTLTYPE_NODE }, \
 520 }
 521
 522 /*
 523  * CTL_USER definitions
 524  */
 525 #define USER_CS_PATH             1      /* string: _CS_PATH */
 526 #define USER_BC_BASE_MAX         2      /* int: BC_BASE_MAX */
 527 #define USER_BC_DIM_MAX          3      /* int: BC_DIM_MAX */
 528 #define USER_BC_SCALE_MAX        4      /* int: BC_SCALE_MAX */
 529 #define USER_BC_STRING_MAX       5      /* int: BC_STRING_MAX */
 530 #define USER_COLL_WEIGHTS_MAX    6      /* int: COLL_WEIGHTS_MAX */
 531 #define USER_EXPR_NEST_MAX       7      /* int: EXPR_NEST_MAX */
 532 #define USER_LINE_MAX            8      /* int: LINE_MAX */
 533 #define USER_RE_DUP_MAX          9      /* int: RE_DUP_MAX */
 534 #define USER_POSIX2_VERSION     10      /* int: _POSIX2_VERSION */
 535 #define USER_POSIX2_C_BIND      11      /* int: _POSIX2_C_BIND */
 536 #define USER_POSIX2_C_DEV       12      /* int: _POSIX2_C_DEV */
 537 #define USER_POSIX2_CHAR_TERM   13      /* int: _POSIX2_CHAR_TERM */
 538 #define USER_POSIX2_FORT_DEV    14      /* int: _POSIX2_FORT_DEV */
 539 #define USER_POSIX2_FORT_RUN    15      /* int: _POSIX2_FORT_RUN */
 540 #define USER_POSIX2_LOCALEDEF   16      /* int: _POSIX2_LOCALEDEF */
 541 #define USER_POSIX2_SW_DEV      17      /* int: _POSIX2_SW_DEV */
 542 #define USER_POSIX2_UPE         18      /* int: _POSIX2_UPE */
 543 #define USER_STREAM_MAX         19      /* int: _POSIX2_STREAM_MAX */
 544 #define USER_TZNAME_MAX         20      /* int: _POSIX2_TZNAME_MAX */
 545 #define USER_MAXID              21      /* number of valid user ids */
 546
 547 #define CTL_USER_NAMES { \
 548         { 0, 0 }, \
 549         { "cs_path", CTLTYPE_STRING }, \
 550         { "bc_base_max", CTLTYPE_INT }, \
 551         { "bc_dim_max", CTLTYPE_INT }, \
 552         { "bc_scale_max", CTLTYPE_INT }, \
 553         { "bc_string_max", CTLTYPE_INT }, \
 554         { "coll_weights_max", CTLTYPE_INT }, \
 555         { "expr_nest_max", CTLTYPE_INT }, \
 556         { "line_max", CTLTYPE_INT }, \
 557         { "re_dup_max", CTLTYPE_INT }, \
 558         { "posix2_version", CTLTYPE_INT }, \
 559         { "posix2_c_bind", CTLTYPE_INT }, \
 560         { "posix2_c_dev", CTLTYPE_INT }, \
 561         { "posix2_char_term", CTLTYPE_INT }, \
 562         { "posix2_fort_dev", CTLTYPE_INT }, \
 563         { "posix2_fort_run", CTLTYPE_INT }, \
 564         { "posix2_localedef", CTLTYPE_INT }, \
 565         { "posix2_sw_dev", CTLTYPE_INT }, \
 566         { "posix2_upe", CTLTYPE_INT }, \
 567         { "stream_max", CTLTYPE_INT }, \
 568         { "tzname_max", CTLTYPE_INT }, \
 569 }
 570
 571 #define CTL_P1003_1B_ASYNCHRONOUS_IO            1       /* boolean */
 572 #define CTL_P1003_1B_MAPPED_FILES               2       /* boolean */
 573 #define CTL_P1003_1B_MEMLOCK                    3       /* boolean */
 574 #define CTL_P1003_1B_MEMLOCK_RANGE              4       /* boolean */
 575 #define CTL_P1003_1B_MEMORY_PROTECTION          5       /* boolean */
 576 #define CTL_P1003_1B_MESSAGE_PASSING            6       /* boolean */
 577 #define CTL_P1003_1B_PRIORITIZED_IO             7       /* boolean */
 578 #define CTL_P1003_1B_PRIORITY_SCHEDULING        8       /* boolean */
 579 #define CTL_P1003_1B_REALTIME_SIGNALS           9       /* boolean */
 580 #define CTL_P1003_1B_SEMAPHORES                 10      /* boolean */
 581 #define CTL_P1003_1B_FSYNC                      11      /* boolean */
 582 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS      12      /* boolean */
 583 #define CTL_P1003_1B_SYNCHRONIZED_IO            13      /* boolean */
 584 #define CTL_P1003_1B_TIMERS                     14      /* boolean */
 585 #define CTL_P1003_1B_AIO_LISTIO_MAX             15      /* int */
 586 #define CTL_P1003_1B_AIO_MAX                    16      /* int */
 587 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX         17      /* int */
 588 #define CTL_P1003_1B_DELAYTIMER_MAX             18      /* int */
 589 #define CTL_P1003_1B_UNUSED1                    19      /* int */
 590 #define CTL_P1003_1B_PAGESIZE                   20      /* int */
 591 #define CTL_P1003_1B_RTSIG_MAX                  21      /* int */
 592 #define CTL_P1003_1B_SEM_NSEMS_MAX              22      /* int */
 593 #define CTL_P1003_1B_SEM_VALUE_MAX              23      /* int */
 594 #define CTL_P1003_1B_SIGQUEUE_MAX               24      /* int */
 595 #define CTL_P1003_1B_TIMER_MAX                  25      /* int */
 596
 597 #define CTL_P1003_1B_MAXID              26
 598
 599 #define CTL_P1003_1B_NAMES { \
 600         { 0, 0 }, \
 601         { "asynchronous_io", CTLTYPE_INT }, \
 602         { "mapped_files", CTLTYPE_INT }, \
 603         { "memlock", CTLTYPE_INT }, \
 604         { "memlock_range", CTLTYPE_INT }, \
 605         { "memory_protection", CTLTYPE_INT }, \
 606         { "message_passing", CTLTYPE_INT }, \
 607         { "prioritized_io", CTLTYPE_INT }, \
 608         { "priority_scheduling", CTLTYPE_INT }, \
 609         { "realtime_signals", CTLTYPE_INT }, \
 610         { "semaphores", CTLTYPE_INT }, \
 611         { "fsync", CTLTYPE_INT }, \
 612         { "shared_memory_objects", CTLTYPE_INT }, \
 613         { "synchronized_io", CTLTYPE_INT }, \
 614         { "timers", CTLTYPE_INT }, \
 615         { "aio_listio_max", CTLTYPE_INT }, \
 616         { "aio_max", CTLTYPE_INT }, \
 617         { "aio_prio_delta_max", CTLTYPE_INT }, \
 618         { "delaytimer_max", CTLTYPE_INT }, \
 619         { "unused1", CTLTYPE_INT }, \
 620         { "pagesize", CTLTYPE_INT }, \
 621         { "rtsig_max", CTLTYPE_INT }, \
 622         { "nsems_max", CTLTYPE_INT }, \
 623         { "sem_value_max", CTLTYPE_INT }, \
 624         { "sigqueue_max", CTLTYPE_INT }, \
 625         { "timer_max", CTLTYPE_INT }, \
 626 }
 627
 628 #ifdef _KERNEL
 629
 630 /*
 631  * Declare some common oids.
 632  */
 633 extern struct sysctl_oid_list sysctl__children;
 634 SYSCTL_DECL(_kern);
 635 SYSCTL_DECL(_sysctl);
 636 SYSCTL_DECL(_vm);
 637 SYSCTL_DECL(_vfs);
 638 SYSCTL_DECL(_net);
 639 SYSCTL_DECL(_debug);
 640 SYSCTL_DECL(_debug_sizeof);
 641 SYSCTL_DECL(_dev);
 642 SYSCTL_DECL(_hw);
 643 SYSCTL_DECL(_hw_bus);
 644 SYSCTL_DECL(_machdep);
 645 SYSCTL_DECL(_user);
 646 SYSCTL_DECL(_compat);
 647 SYSCTL_DECL(_lwkt);
 648 SYSCTL_DECL(_security);
 649
 650 /*
 651  * Common second-level oids.
 652  */
 653 SYSCTL_DECL(_kern_ipc);
 654
 655 extern char     machine[];
 656 extern char     osrelease[];
 657 extern char     ostype[];
 658 extern char     kern_ident[];
 659
 660 /* Dynamic oid handling */
 661 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
 662                 struct sysctl_oid_list *parent, int nbr, const char *name,
 663                 int kind, void *arg1, int arg2,
 664                 int (*handler) (SYSCTL_HANDLER_ARGS),
 665                 const char *fmt, const char *descr);
 666 void    sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
 667 int     sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
 668             int recurse);
 669 int     sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
 670 int     sysctl_ctx_init(struct sysctl_ctx_list *clist);
 671 int     sysctl_ctx_free(struct sysctl_ctx_list *clist);
 672 struct  sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
 673                 struct sysctl_oid *oidp);
 674 struct  sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
 675                 struct sysctl_oid *oidp);
 676 int     sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
 677                 struct sysctl_oid *oidp);
 678
 679 int     kernel_sysctl(int *name, u_int namelen, void *old,
 680                       size_t *oldlenp, void *new, size_t newlen,
 681                       size_t *retval);
 682 int     kernel_sysctlbyname(char *name,
 683                 void *old, size_t *oldlenp, void *new, size_t newlen,
 684                 size_t *retval);
 685 int     userland_sysctl(int *name, u_int namelen, void *old,
 686             size_t *oldlenp, int inkernel, void *new, size_t newlen,
 687             size_t *retval);
 688 int     sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
 689                         int *nindx, struct sysctl_req *req);
 690
 691 int     sysctl_int_range(SYSCTL_HANDLER_ARGS, int low, int high);
 692 void    _sysctl_xlock(void);
 693 void    _sysctl_xunlock(void);
 694
 695 struct sbuf;
 696 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
 697             struct sysctl_req *);
 698
 699 #endif  /* _KERNEL */
 700
 701 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
 702
 703 #include <sys/cdefs.h>
 704
 705 __BEGIN_DECLS
 706 int     sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
 707 int     sysctlbyname(const char *, void *, size_t *, const void *, size_t);
 708 int     sysctlnametomib (const char *, int *, size_t *);
 709 __END_DECLS
 710
 711 #endif  /* _KERNEL && _KERNEL_VIRTUAL */
 712
 713 #endif  /* !_SYS_SYSCTL_H_ */