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/10.1/sys/sys/sysctl.h 269446 2014-08-02 20:58:46Z hselasky $
   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_STATS   0x00002000      /* Statistics, not a tuneable */
   95 #define CTLFLAG_NOFETCH 0x00001000      /* Don't fetch tunable from getenv() */
   96 #define CTLFLAG_CAPRW   (CTLFLAG_CAPRD|CTLFLAG_CAPWR)
   97 
   98 /*
   99  * Secure level.   Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
  100  *
  101  * Secure when the securelevel is raised to at least N.
  102  */
  103 #define CTLSHIFT_SECURE 20
  104 #define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
  105 #define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
  106 #define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
  107 
  108 /*
  109  * USE THIS instead of a hardwired number from the categories below
  110  * to get dynamically assigned sysctl entries using the linker-set
  111  * technology. This is the way nearly all new sysctl variables should
  112  * be implemented.
  113  * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
  114  */
  115 #define OID_AUTO        (-1)
  116 
  117 /*
  118  * The starting number for dynamically-assigned entries.  WARNING!
  119  * ALL static sysctl entries should have numbers LESS than this!
  120  */
  121 #define CTL_AUTO_START  0x100
  122 
  123 #ifdef _KERNEL
  124 #include <sys/linker_set.h>
  125 
  126 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1,        \
  127         intptr_t arg2, struct sysctl_req *req
  128 
  129 /* definitions for sysctl_req 'lock' member */
  130 #define REQ_UNWIRED     1
  131 #define REQ_WIRED       2
  132 
  133 /* definitions for sysctl_req 'flags' member */
  134 #if defined(__amd64__) || defined(__ia64__) || defined(__powerpc64__) ||\
  135     (defined(__mips__) && defined(__mips_n64))
  136 #define SCTL_MASK32     1       /* 32 bit emulation */
  137 #endif
  138 
  139 /*
  140  * This describes the access space for a sysctl request.  This is needed
  141  * so that we can use the interface from the kernel or from user-space.
  142  */
  143 struct sysctl_req {
  144         struct thread   *td;            /* used for access checking */
  145         int              lock;          /* wiring state */
  146         void            *oldptr;
  147         size_t           oldlen;
  148         size_t           oldidx;
  149         int             (*oldfunc)(struct sysctl_req *, const void *, size_t);
  150         void            *newptr;
  151         size_t           newlen;
  152         size_t           newidx;
  153         int             (*newfunc)(struct sysctl_req *, void *, size_t);
  154         size_t           validlen;
  155         int              flags;
  156 };
  157 
  158 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
  159 
  160 /*
  161  * This describes one "oid" in the MIB tree.  Potentially more nodes can
  162  * be hidden behind it, expanded by the handler.
  163  */
  164 struct sysctl_oid {
  165         struct sysctl_oid_list *oid_parent;
  166         SLIST_ENTRY(sysctl_oid) oid_link;
  167         int              oid_number;
  168         u_int            oid_kind;
  169         void            *oid_arg1;
  170         intptr_t         oid_arg2;
  171         const char      *oid_name;
  172         int             (*oid_handler)(SYSCTL_HANDLER_ARGS);
  173         const char      *oid_fmt;
  174         int              oid_refcnt;
  175         u_int            oid_running;
  176         const char      *oid_descr;
  177 };
  178 
  179 #define SYSCTL_IN(r, p, l)      (r->newfunc)(r, p, l)
  180 #define SYSCTL_OUT(r, p, l)     (r->oldfunc)(r, p, l)
  181 
  182 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
  183 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
  184 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
  185 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
  186 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
  187 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
  188 int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
  189 
  190 int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
  191 int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
  192 
  193 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
  194 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
  195 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
  196 
  197 /*
  198  * These functions are used to add/remove an oid from the mib.
  199  */
  200 void sysctl_register_oid(struct sysctl_oid *oidp);
  201 void sysctl_unregister_oid(struct sysctl_oid *oidp);
  202 
  203 /* Declare a static oid to allow child oids to be added to it. */
  204 #define SYSCTL_DECL(name)                                               \
  205         extern struct sysctl_oid_list sysctl_##name##_children
  206 
  207 /* Hide these in macros. */
  208 #define SYSCTL_CHILDREN(oid_ptr)                                        \
  209         (struct sysctl_oid_list *)(oid_ptr)->oid_arg1
  210 #define SYSCTL_PARENT(oid_ptr)                  NULL    /* not supported */
  211 #define SYSCTL_CHILDREN_SET(oid_ptr, val)       (oid_ptr)->oid_arg1 = (val)
  212 #define SYSCTL_STATIC_CHILDREN(oid_name)        (&sysctl_##oid_name##_children)
  213 
  214 /* === Structs and macros related to context handling. === */
  215 
  216 /* All dynamically created sysctls can be tracked in a context list. */
  217 struct sysctl_ctx_entry {
  218         struct sysctl_oid *entry;
  219         TAILQ_ENTRY(sysctl_ctx_entry) link;
  220 };
  221 
  222 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
  223 
  224 #define SYSCTL_NODE_CHILDREN(parent, name) \
  225         sysctl_##parent##_##name##_children
  226 
  227 /*
  228  * These macros provide type safety for sysctls.  SYSCTL_ALLOWED_TYPES()
  229  * defines a transparent union of the allowed types.  SYSCTL_ASSERT_TYPE()
  230  * and SYSCTL_ADD_ASSERT_TYPE() use the transparent union to assert that
  231  * the pointer matches the allowed types.
  232  *
  233  * The allow_0 member allows a literal 0 to be passed for ptr.
  234  */
  235 #define SYSCTL_ALLOWED_TYPES(type, decls)                       \
  236         union sysctl_##type {                                   \
  237                 long allow_0;                                   \
  238                 decls                                           \
  239         } __attribute__((__transparent_union__));               \
  240                                                                 \
  241         static inline void *                                    \
  242         __sysctl_assert_##type(union sysctl_##type ptr)         \
  243         {                                                       \
  244                 return (ptr.a);                                 \
  245         }                                                       \
  246         struct __hack
  247 
  248 SYSCTL_ALLOWED_TYPES(INT, int *a; );
  249 SYSCTL_ALLOWED_TYPES(UINT, unsigned int *a; );
  250 SYSCTL_ALLOWED_TYPES(LONG, long *a; );
  251 SYSCTL_ALLOWED_TYPES(ULONG, unsigned long *a; );
  252 SYSCTL_ALLOWED_TYPES(INT64, int64_t *a; long long *b; );
  253 SYSCTL_ALLOWED_TYPES(UINT64, uint64_t *a; unsigned long long *b; );
  254 
  255 #ifdef notyet
  256 #define SYSCTL_ADD_ASSERT_TYPE(type, ptr)       \
  257         __sysctl_assert_ ## type (ptr)
  258 #define SYSCTL_ASSERT_TYPE(type, ptr, parent, name)     \
  259         _SYSCTL_ASSERT_TYPE(type, ptr, __LINE__, parent##_##name)
  260 #else
  261 #define SYSCTL_ADD_ASSERT_TYPE(type, ptr)       ptr
  262 #define SYSCTL_ASSERT_TYPE(type, ptr, parent, name)
  263 #endif
  264 #define _SYSCTL_ASSERT_TYPE(t, p, l, id)                \
  265         __SYSCTL_ASSERT_TYPE(t, p, l, id)
  266 #define __SYSCTL_ASSERT_TYPE(type, ptr, line, id)                       \
  267         static inline void                                              \
  268         sysctl_assert_##line##_##id(void)                               \
  269         {                                                               \
  270                 (void)__sysctl_assert_##type(ptr);                      \
  271         }                                                               \
  272         struct __hack
  273 
  274 #ifndef NO_SYSCTL_DESCR
  275 #define __DESCR(d) d
  276 #else
  277 #define __DESCR(d) ""
  278 #endif
  279 
  280 /* This constructs a "raw" MIB oid. */
  281 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr)\
  282         static struct sysctl_oid sysctl__##parent##_##name = {          \
  283                 &sysctl_##parent##_children,                            \
  284                 { NULL },                                               \
  285                 nbr,                                                    \
  286                 kind,                                                   \
  287                 a1,                                                     \
  288                 a2,                                                     \
  289                 #name,                                                  \
  290                 handler,                                                \
  291                 fmt,                                                    \
  292                 0,                                                      \
  293                 0,                                                      \
  294                 __DESCR(descr)                                          \
  295                 };                                                      \
  296         DATA_SET(sysctl_set, sysctl__##parent##_##name)
  297 
  298 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
  299         sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr))
  300 
  301 /* This constructs a root node from which other nodes can hang. */
  302 #define SYSCTL_ROOT_NODE(nbr, name, access, handler, descr)             \
  303         SYSCTL_NODE(, nbr, name, access, handler, descr)
  304 
  305 /* This constructs a node from which other oids can hang. */
  306 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr)              \
  307         struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);          \
  308         SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access),                \
  309             (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr)
  310 
  311 #define SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr) \
  312         SYSCTL_ADD_NODE(ctx, SYSCTL_STATIC_CHILDREN(), nbr, name, access, handler, descr)
  313 
  314 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr)     \
  315         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access),       \
  316         NULL, 0, handler, "N", __DESCR(descr))
  317 
  318 /* Oid for a string.  len can be 0 to indicate '\0' termination. */
  319 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
  320         SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \
  321                 arg, len, sysctl_handle_string, "A", descr)
  322 
  323 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr)  \
  324         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access),     \
  325         arg, len, sysctl_handle_string, "A", __DESCR(descr))
  326 
  327 /* Oid for an int.  If ptr is NULL, val is returned. */
  328 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)          \
  329         SYSCTL_ASSERT_TYPE(INT, ptr, parent, name);                     \
  330         SYSCTL_OID(parent, nbr, name,                                   \
  331             CTLTYPE_INT | CTLFLAG_MPSAFE | (access),                    \
  332             ptr, val, sysctl_handle_int, "I", descr)
  333 
  334 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \
  335         sysctl_add_oid(ctx, parent, nbr, name,                          \
  336             CTLTYPE_INT | CTLFLAG_MPSAFE | (access),                    \
  337             SYSCTL_ADD_ASSERT_TYPE(INT, ptr), val,                      \
  338             sysctl_handle_int, "I", __DESCR(descr))
  339 
  340 /* Oid for an unsigned int.  If ptr is NULL, val is returned. */
  341 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)         \
  342         SYSCTL_ASSERT_TYPE(UINT, ptr, parent, name);                    \
  343         SYSCTL_OID(parent, nbr, name,                                   \
  344             CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),                   \
  345             ptr, val, sysctl_handle_int, "IU", descr)
  346 
  347 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
  348         sysctl_add_oid(ctx, parent, nbr, name,                          \
  349             CTLTYPE_UINT | CTLFLAG_MPSAFE | (access),                   \
  350             SYSCTL_ADD_ASSERT_TYPE(UINT, ptr), val,                     \
  351             sysctl_handle_int, "IU", __DESCR(descr))
  352 
  353 /* Oid for a long.  The pointer must be non NULL. */
  354 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr)         \
  355         SYSCTL_ASSERT_TYPE(LONG, ptr, parent, name);                    \
  356         SYSCTL_OID(parent, nbr, name,                                   \
  357             CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),                   \
  358             ptr, val, sysctl_handle_long, "L", descr)
  359 
  360 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr)     \
  361         sysctl_add_oid(ctx, parent, nbr, name,                          \
  362             CTLTYPE_LONG | CTLFLAG_MPSAFE | (access),                   \
  363             SYSCTL_ADD_ASSERT_TYPE(LONG, ptr), 0,                       \
  364             sysctl_handle_long, "L", __DESCR(descr))
  365 
  366 /* Oid for an unsigned long.  The pointer must be non NULL. */
  367 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr)        \
  368         SYSCTL_ASSERT_TYPE(ULONG, ptr, parent, name);                   \
  369         SYSCTL_OID(parent, nbr, name,                                   \
  370             CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),                  \
  371             ptr, val, sysctl_handle_long, "LU", descr)
  372 
  373 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr)    \
  374         sysctl_add_oid(ctx, parent, nbr, name,                          \
  375             CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access),                  \
  376             SYSCTL_ADD_ASSERT_TYPE(ULONG, ptr), 0,                      \
  377             sysctl_handle_long, "LU", __DESCR(descr))
  378 
  379 /* Oid for a quad.  The pointer must be non NULL. */
  380 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr)         \
  381         SYSCTL_ASSERT_TYPE(INT64, ptr, parent, name);                   \
  382         SYSCTL_OID(parent, nbr, name,                                   \
  383             CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),                    \
  384             ptr, val, sysctl_handle_64, "Q", descr)
  385 
  386 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr)     \
  387         sysctl_add_oid(ctx, parent, nbr, name,                          \
  388             CTLTYPE_S64 | CTLFLAG_MPSAFE | (access),                    \
  389             SYSCTL_ADD_ASSERT_TYPE(INT64, ptr), 0,                      \
  390             sysctl_handle_64, "Q", __DESCR(descr))
  391 
  392 #define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr)        \
  393         SYSCTL_ASSERT_TYPE(UINT64, ptr, parent, name);                  \
  394         SYSCTL_OID(parent, nbr, name,                                   \
  395             CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),                    \
  396             ptr, val, sysctl_handle_64, "QU", descr)
  397 
  398 #define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr)    \
  399         sysctl_add_oid(ctx, parent, nbr, name,                          \
  400             CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),                    \
  401             SYSCTL_ADD_ASSERT_TYPE(UINT64, ptr), 0,                     \
  402             sysctl_handle_64, "QU", __DESCR(descr))
  403 
  404 /* Oid for a 64-bit unsigned counter(9).  The pointer must be non NULL. */
  405 #define SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr)       \
  406         SYSCTL_ASSERT_TYPE(UINT64, ptr, parent, name);                  \
  407         SYSCTL_OID(parent, nbr, name,                                   \
  408             CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),                    \
  409             ptr, 0, sysctl_handle_counter_u64, "QU", descr)
  410 
  411 #define SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr)\
  412         sysctl_add_oid(ctx, parent, nbr, name,                          \
  413             CTLTYPE_U64 | CTLFLAG_MPSAFE | (access),                    \
  414             SYSCTL_ADD_ASSERT_TYPE(UINT64, ptr), 0,                     \
  415             sysctl_handle_counter_u64, "QU", __DESCR(descr))
  416 
  417 /* Oid for an opaque object.  Specified by a pointer and a length. */
  418 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
  419         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
  420                 ptr, len, sysctl_handle_opaque, fmt, descr)
  421 
  422 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\
  423         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),     \
  424         ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr))
  425 
  426 /* Oid for a struct.  Specified by a pointer and a type. */
  427 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
  428         SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
  429                 ptr, sizeof(struct type), sysctl_handle_opaque, \
  430                 "S," #type, descr)
  431 
  432 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
  433         sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access),     \
  434         ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr))
  435 
  436 /* Oid for a procedure.  Specified by a pointer and an arg. */
  437 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
  438         CTASSERT(((access) & CTLTYPE) != 0);                            \
  439         SYSCTL_OID(parent, nbr, name, (access), \
  440                 ptr, arg, handler, fmt, descr)
  441 
  442 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
  443         sysctl_add_oid(ctx, parent, nbr, name, (access),                            \
  444         ptr, arg, handler, fmt, __DESCR(descr))
  445 
  446 /* Oid to handle limits on uma(9) zone specified by pointer. */
  447 #define SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr)           \
  448         SYSCTL_ASSERT_TYPE(INT, ptr, parent, name);                     \
  449         SYSCTL_OID(parent, nbr, name,                                   \
  450             CTLTYPE_INT | CTLFLAG_MPSAFE | (access),                    \
  451             ptr, 0, sysctl_handle_uma_zone_max, "I", descr)
  452 #define SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr)\
  453         sysctl_add_oid(ctx, parent, nbr, name,                          \
  454             CTLTYPE_INT | CTLFLAG_MPSAFE | (access),                    \
  455             SYSCTL_ADD_ASSERT_TYPE(INT, ptr), 0,                        \
  456             sysctl_handle_uma_zone_max, "I", __DESCR(descr))
  457 
  458 /* Oid to obtain current use of uma(9) zone specified by pointer. */
  459 #define SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr)           \
  460         SYSCTL_ASSERT_TYPE(INT, ptr, parent, name);                     \
  461         SYSCTL_OID(parent, nbr, name,                                   \
  462             CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),       \
  463             ptr, 0, sysctl_handle_uma_zone_cur, "I", descr)
  464 #define SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr)  \
  465         sysctl_add_oid(ctx, parent, nbr, name,                          \
  466             CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access),       \
  467             SYSCTL_ADD_ASSERT_TYPE(INT, ptr), 0,                        \
  468             sysctl_handle_uma_zone_cur, "I", __DESCR(descr))
  469 
  470 /*
  471  * A macro to generate a read-only sysctl to indicate the presense of optional
  472  * kernel features.
  473  */
  474 #define FEATURE(name, desc)                                             \
  475         SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD | CTLFLAG_CAPRD, \
  476             NULL, 1, desc)
  477 
  478 #endif /* _KERNEL */
  479 
  480 /*
  481  * Top-level identifiers
  482  */
  483 #define CTL_UNSPEC      0               /* unused */
  484 #define CTL_KERN        1               /* "high kernel": proc, limits */
  485 #define CTL_VM          2               /* virtual memory */
  486 #define CTL_VFS         3               /* filesystem, mount type is next */
  487 #define CTL_NET         4               /* network, see socket.h */
  488 #define CTL_DEBUG       5               /* debugging parameters */
  489 #define CTL_HW          6               /* generic cpu/io */
  490 #define CTL_MACHDEP     7               /* machine dependent */
  491 #define CTL_USER        8               /* user-level */
  492 #define CTL_P1003_1B    9               /* POSIX 1003.1B */
  493 #define CTL_MAXID       10              /* number of valid top-level ids */
  494 
  495 /*
  496  * CTL_KERN identifiers
  497  */
  498 #define KERN_OSTYPE              1      /* string: system version */
  499 #define KERN_OSRELEASE           2      /* string: system release */
  500 #define KERN_OSREV               3      /* int: system revision */
  501 #define KERN_VERSION             4      /* string: compile time info */
  502 #define KERN_MAXVNODES           5      /* int: max vnodes */
  503 #define KERN_MAXPROC             6      /* int: max processes */
  504 #define KERN_MAXFILES            7      /* int: max open files */
  505 #define KERN_ARGMAX              8      /* int: max arguments to exec */
  506 #define KERN_SECURELVL           9      /* int: system security level */
  507 #define KERN_HOSTNAME           10      /* string: hostname */
  508 #define KERN_HOSTID             11      /* int: host identifier */
  509 #define KERN_CLOCKRATE          12      /* struct: struct clockrate */
  510 #define KERN_VNODE              13      /* struct: vnode structures */
  511 #define KERN_PROC               14      /* struct: process entries */
  512 #define KERN_FILE               15      /* struct: file entries */
  513 #define KERN_PROF               16      /* node: kernel profiling info */
  514 #define KERN_POSIX1             17      /* int: POSIX.1 version */
  515 #define KERN_NGROUPS            18      /* int: # of supplemental group ids */
  516 #define KERN_JOB_CONTROL        19      /* int: is job control available */
  517 #define KERN_SAVED_IDS          20      /* int: saved set-user/group-ID */
  518 #define KERN_BOOTTIME           21      /* struct: time kernel was booted */
  519 #define KERN_NISDOMAINNAME      22      /* string: YP domain name */
  520 #define KERN_UPDATEINTERVAL     23      /* int: update process sleep time */
  521 #define KERN_OSRELDATE          24      /* int: kernel release date */
  522 #define KERN_NTP_PLL            25      /* node: NTP PLL control */
  523 #define KERN_BOOTFILE           26      /* string: name of booted kernel */
  524 #define KERN_MAXFILESPERPROC    27      /* int: max open files per proc */
  525 #define KERN_MAXPROCPERUID      28      /* int: max processes per uid */
  526 #define KERN_DUMPDEV            29      /* struct cdev *: device to dump on */
  527 #define KERN_IPC                30      /* node: anything related to IPC */
  528 #define KERN_DUMMY              31      /* unused */
  529 #define KERN_PS_STRINGS         32      /* int: address of PS_STRINGS */
  530 #define KERN_USRSTACK           33      /* int: address of USRSTACK */
  531 #define KERN_LOGSIGEXIT         34      /* int: do we log sigexit procs? */
  532 #define KERN_IOV_MAX            35      /* int: value of UIO_MAXIOV */
  533 #define KERN_HOSTUUID           36      /* string: host UUID identifier */
  534 #define KERN_ARND               37      /* int: from arc4rand() */
  535 #define KERN_MAXID              38      /* number of valid kern ids */
  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 #define KERN_PROC_SIGTRAMP      41      /* signal trampoline location */
  570 
  571 /*
  572  * KERN_IPC identifiers
  573  */
  574 #define KIPC_MAXSOCKBUF         1       /* int: max size of a socket buffer */
  575 #define KIPC_SOCKBUF_WASTE      2       /* int: wastage factor in sockbuf */
  576 #define KIPC_SOMAXCONN          3       /* int: max length of connection q */
  577 #define KIPC_MAX_LINKHDR        4       /* int: max length of link header */
  578 #define KIPC_MAX_PROTOHDR       5       /* int: max length of network header */
  579 #define KIPC_MAX_HDR            6       /* int: max total length of headers */
  580 #define KIPC_MAX_DATALEN        7       /* int: max length of data? */
  581 
  582 /*
  583  * CTL_HW identifiers
  584  */
  585 #define HW_MACHINE       1              /* string: machine class */
  586 #define HW_MODEL         2              /* string: specific machine model */
  587 #define HW_NCPU          3              /* int: number of cpus */
  588 #define HW_BYTEORDER     4              /* int: machine byte order */
  589 #define HW_PHYSMEM       5              /* int: total memory */
  590 #define HW_USERMEM       6              /* int: non-kernel memory */
  591 #define HW_PAGESIZE      7              /* int: software page size */
  592 #define HW_DISKNAMES     8              /* strings: disk drive names */
  593 #define HW_DISKSTATS     9              /* struct: diskstats[] */
  594 #define HW_FLOATINGPT   10              /* int: has HW floating point? */
  595 #define HW_MACHINE_ARCH 11              /* string: machine architecture */
  596 #define HW_REALMEM      12              /* int: 'real' memory */
  597 #define HW_MAXID        13              /* number of valid hw ids */
  598 
  599 /*
  600  * CTL_USER definitions
  601  */
  602 #define USER_CS_PATH             1      /* string: _CS_PATH */
  603 #define USER_BC_BASE_MAX         2      /* int: BC_BASE_MAX */
  604 #define USER_BC_DIM_MAX          3      /* int: BC_DIM_MAX */
  605 #define USER_BC_SCALE_MAX        4      /* int: BC_SCALE_MAX */
  606 #define USER_BC_STRING_MAX       5      /* int: BC_STRING_MAX */
  607 #define USER_COLL_WEIGHTS_MAX    6      /* int: COLL_WEIGHTS_MAX */
  608 #define USER_EXPR_NEST_MAX       7      /* int: EXPR_NEST_MAX */
  609 #define USER_LINE_MAX            8      /* int: LINE_MAX */
  610 #define USER_RE_DUP_MAX          9      /* int: RE_DUP_MAX */
  611 #define USER_POSIX2_VERSION     10      /* int: POSIX2_VERSION */
  612 #define USER_POSIX2_C_BIND      11      /* int: POSIX2_C_BIND */
  613 #define USER_POSIX2_C_DEV       12      /* int: POSIX2_C_DEV */
  614 #define USER_POSIX2_CHAR_TERM   13      /* int: POSIX2_CHAR_TERM */
  615 #define USER_POSIX2_FORT_DEV    14      /* int: POSIX2_FORT_DEV */
  616 #define USER_POSIX2_FORT_RUN    15      /* int: POSIX2_FORT_RUN */
  617 #define USER_POSIX2_LOCALEDEF   16      /* int: POSIX2_LOCALEDEF */
  618 #define USER_POSIX2_SW_DEV      17      /* int: POSIX2_SW_DEV */
  619 #define USER_POSIX2_UPE         18      /* int: POSIX2_UPE */
  620 #define USER_STREAM_MAX         19      /* int: POSIX2_STREAM_MAX */
  621 #define USER_TZNAME_MAX         20      /* int: POSIX2_TZNAME_MAX */
  622 #define USER_MAXID              21      /* number of valid user ids */
  623 
  624 #define CTL_P1003_1B_ASYNCHRONOUS_IO            1       /* boolean */
  625 #define CTL_P1003_1B_MAPPED_FILES               2       /* boolean */
  626 #define CTL_P1003_1B_MEMLOCK                    3       /* boolean */
  627 #define CTL_P1003_1B_MEMLOCK_RANGE              4       /* boolean */
  628 #define CTL_P1003_1B_MEMORY_PROTECTION          5       /* boolean */
  629 #define CTL_P1003_1B_MESSAGE_PASSING            6       /* boolean */
  630 #define CTL_P1003_1B_PRIORITIZED_IO             7       /* boolean */
  631 #define CTL_P1003_1B_PRIORITY_SCHEDULING        8       /* boolean */
  632 #define CTL_P1003_1B_REALTIME_SIGNALS           9       /* boolean */
  633 #define CTL_P1003_1B_SEMAPHORES                 10      /* boolean */
  634 #define CTL_P1003_1B_FSYNC                      11      /* boolean */
  635 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS      12      /* boolean */
  636 #define CTL_P1003_1B_SYNCHRONIZED_IO            13      /* boolean */
  637 #define CTL_P1003_1B_TIMERS                     14      /* boolean */
  638 #define CTL_P1003_1B_AIO_LISTIO_MAX             15      /* int */
  639 #define CTL_P1003_1B_AIO_MAX                    16      /* int */
  640 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX         17      /* int */
  641 #define CTL_P1003_1B_DELAYTIMER_MAX             18      /* int */
  642 #define CTL_P1003_1B_MQ_OPEN_MAX                19      /* int */
  643 #define CTL_P1003_1B_PAGESIZE                   20      /* int */
  644 #define CTL_P1003_1B_RTSIG_MAX                  21      /* int */
  645 #define CTL_P1003_1B_SEM_NSEMS_MAX              22      /* int */
  646 #define CTL_P1003_1B_SEM_VALUE_MAX              23      /* int */
  647 #define CTL_P1003_1B_SIGQUEUE_MAX               24      /* int */
  648 #define CTL_P1003_1B_TIMER_MAX                  25      /* int */
  649 
  650 #define CTL_P1003_1B_MAXID              26
  651 
  652 #ifdef _KERNEL
  653 
  654 /*
  655  * Declare some common oids.
  656  */
  657 extern struct sysctl_oid_list sysctl__children;
  658 SYSCTL_DECL(_kern);
  659 SYSCTL_DECL(_kern_features);
  660 SYSCTL_DECL(_kern_ipc);
  661 SYSCTL_DECL(_kern_proc);
  662 SYSCTL_DECL(_kern_sched);
  663 SYSCTL_DECL(_kern_sched_stats);
  664 SYSCTL_DECL(_sysctl);
  665 SYSCTL_DECL(_vm);
  666 SYSCTL_DECL(_vm_stats);
  667 SYSCTL_DECL(_vm_stats_misc);
  668 SYSCTL_DECL(_vfs);
  669 SYSCTL_DECL(_net);
  670 SYSCTL_DECL(_debug);
  671 SYSCTL_DECL(_debug_sizeof);
  672 SYSCTL_DECL(_dev);
  673 SYSCTL_DECL(_hw);
  674 SYSCTL_DECL(_hw_bus);
  675 SYSCTL_DECL(_hw_bus_devices);
  676 SYSCTL_DECL(_hw_bus_info);
  677 SYSCTL_DECL(_machdep);
  678 SYSCTL_DECL(_user);
  679 SYSCTL_DECL(_compat);
  680 SYSCTL_DECL(_regression);
  681 SYSCTL_DECL(_security);
  682 SYSCTL_DECL(_security_bsd);
  683 
  684 extern char     machine[];
  685 extern char     osrelease[];
  686 extern char     ostype[];
  687 extern char     kern_ident[];
  688 
  689 /* Dynamic oid handling */
  690 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
  691             struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
  692             void *arg1, intptr_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
  693             const char *fmt, const char *descr);
  694 int     sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
  695             int recurse);
  696 void    sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
  697 int     sysctl_move_oid(struct sysctl_oid *oidp,
  698             struct sysctl_oid_list *parent);
  699 int     sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
  700 int     sysctl_ctx_init(struct sysctl_ctx_list *clist);
  701 int     sysctl_ctx_free(struct sysctl_ctx_list *clist);
  702 struct  sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
  703             struct sysctl_oid *oidp);
  704 struct  sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
  705             struct sysctl_oid *oidp);
  706 int     sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
  707             struct sysctl_oid *oidp);
  708 
  709 int     kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
  710             size_t *oldlenp, void *new, size_t newlen, size_t *retval,
  711             int flags);
  712 int     kernel_sysctlbyname(struct thread *td, char *name, void *old,
  713             size_t *oldlenp, void *new, size_t newlen, size_t *retval,
  714             int flags);
  715 int     userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
  716             size_t *oldlenp, int inkernel, void *new, size_t newlen,
  717             size_t *retval, int flags);
  718 int     sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
  719             int *nindx, struct sysctl_req *req);
  720 void    sysctl_lock(void);
  721 void    sysctl_unlock(void);
  722 int     sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
  723 
  724 struct sbuf;
  725 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
  726             struct sysctl_req *);
  727 #else   /* !_KERNEL */
  728 #include <sys/cdefs.h>
  729 
  730 __BEGIN_DECLS
  731 int     sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
  732 int     sysctlbyname(const char *, void *, size_t *, const void *, size_t);
  733 int     sysctlnametomib(const char *, int *, size_t *);
  734 __END_DECLS
  735 #endif  /* _KERNEL */
  736 
  737 #endif  /* !_SYS_SYSCTL_H_ */

Cache object: 2c644de1d3eeccd076bdaa47b84813f8


[ 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.