The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/sysctl.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: cbb219c17a6343435fc0207916a85ca6


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.