sysctl.h revision 212370
1116518Sphk/*- 2116518Sphk * Copyright (c) 1989, 1993 3116518Sphk * The Regents of the University of California. All rights reserved. 4116518Sphk * 5116518Sphk * This code is derived from software contributed to Berkeley by 6116518Sphk * Mike Karels at Berkeley Software Design, Inc. 7116518Sphk * 8116518Sphk * Redistribution and use in source and binary forms, with or without 9116518Sphk * modification, are permitted provided that the following conditions 10116518Sphk * are met: 11116518Sphk * 1. Redistributions of source code must retain the above copyright 12116518Sphk * notice, this list of conditions and the following disclaimer. 13116518Sphk * 2. Redistributions in binary form must reproduce the above copyright 14116518Sphk * notice, this list of conditions and the following disclaimer in the 15116518Sphk * documentation and/or other materials provided with the distribution. 16116518Sphk * 4. Neither the name of the University nor the names of its contributors 17116518Sphk * may be used to endorse or promote products derived from this software 18116518Sphk * without specific prior written permission. 19116518Sphk * 20116518Sphk * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21116518Sphk * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22116518Sphk * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23116518Sphk * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24116518Sphk * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25116518Sphk * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26116518Sphk * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27116518Sphk * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28116518Sphk * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29116518Sphk * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30139778Simp * SUCH DAMAGE. 31139778Simp * 32139778Simp * @(#)sysctl.h 8.1 (Berkeley) 6/2/93 33116518Sphk * $FreeBSD: head/sys/sys/sysctl.h 212370 2010-09-09 18:33:46Z mdf $ 34116518Sphk */ 35116518Sphk 36116518Sphk#ifndef _SYS_SYSCTL_H_ 37116518Sphk#define _SYS_SYSCTL_H_ 38116518Sphk 39116518Sphk#include <sys/queue.h> 40219029Snetchild 41116518Sphkstruct thread; 42116518Sphk/* 43116518Sphk * Definitions for sysctl call. The sysctl call uses a hierarchical name 44116518Sphk * for objects that can be examined or modified. The name is expressed as 45116518Sphk * a sequence of integers. Like a file path name, the meaning of each 46116518Sphk * component depends on its place in the hierarchy. The top-level and kern 47116518Sphk * identifiers are defined here, and other identifiers are defined in the 48116518Sphk * respective subsystem header files. 49116518Sphk */ 50116518Sphk 51116518Sphk#define CTL_MAXNAME 24 /* largest number of components supported */ 52116518Sphk 53116518Sphk/* 54116518Sphk * Each subsystem defined by sysctl defines a list of variables 55116518Sphk * for that subsystem. Each name is either a node with further 56219029Snetchild * levels defined below it, or it is a leaf of some particular 57219029Snetchild * type given below. Each sysctl level defines a set of name/type 58116518Sphk * pairs to be used by sysctl(8) in manipulating the subsystem. 59116518Sphk */ 60116518Sphkstruct ctlname { 61116518Sphk char *ctl_name; /* subsystem name */ 62116518Sphk int ctl_type; /* type of name */ 63116518Sphk}; 64116518Sphk 65116518Sphk#define CTLTYPE 0xf /* Mask for the type */ 66116518Sphk#define CTLTYPE_NODE 1 /* name is a node */ 67116518Sphk#define CTLTYPE_INT 2 /* name describes an integer */ 68116518Sphk#define CTLTYPE_STRING 3 /* name describes a string */ 69116518Sphk#define CTLTYPE_QUAD 4 /* name describes a 64-bit number */ 70116518Sphk#define CTLTYPE_OPAQUE 5 /* name describes a structure */ 71116518Sphk#define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */ 72116518Sphk#define CTLTYPE_UINT 6 /* name describes an unsigned integer */ 73116518Sphk#define CTLTYPE_LONG 7 /* name describes a long */ 74116518Sphk#define CTLTYPE_ULONG 8 /* name describes an unsigned long */ 75116518Sphk 76116518Sphk#define CTLFLAG_RD 0x80000000 /* Allow reads of variable */ 77116518Sphk#define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */ 78116518Sphk#define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR) 79116518Sphk#define CTLFLAG_NOLOCK 0x20000000 /* XXX Don't Lock */ 80116518Sphk#define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */ 81116518Sphk#define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */ 82116518Sphk#define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */ 83116518Sphk#define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */ 84116518Sphk#define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */ 85116518Sphk#define CTLMASK_SECURE 0x00F00000 /* Secure level */ 86116518Sphk#define CTLFLAG_TUN 0x00080000 /* Tunable variable */ 87116518Sphk#define CTLFLAG_MPSAFE 0x00040000 /* Handler is MP safe */ 88116518Sphk#define CTLFLAG_VNET 0x00020000 /* Prisons with vnet can fiddle */ 89116518Sphk#define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN) 90116518Sphk 91116518Sphk/* 92116518Sphk * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1. 93116518Sphk * 94116518Sphk * Secure when the securelevel is raised to at least N. 95116518Sphk */ 96116518Sphk#define CTLSHIFT_SECURE 20 97125803Sphk#define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE)) 98116518Sphk#define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE)) 99116518Sphk#define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE)) 100116518Sphk 101116518Sphk/* 102125755Sphk * USE THIS instead of a hardwired number from the categories below 103116518Sphk * to get dynamically assigned sysctl entries using the linker-set 104116518Sphk * technology. This is the way nearly all new sysctl variables should 105116518Sphk * be implemented. 106116518Sphk * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, ""); 107116518Sphk */ 108116518Sphk#define OID_AUTO (-1) 109116518Sphk 110116518Sphk/* 111116518Sphk * The starting number for dynamically-assigned entries. WARNING! 112116518Sphk * ALL static sysctl entries should have numbers LESS than this! 113116518Sphk */ 114116518Sphk#define CTL_AUTO_START 0x100 115116518Sphk 116116518Sphk#ifdef _KERNEL 117116518Sphk#define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \ 118116518Sphk struct sysctl_req *req 119116518Sphk 120116518Sphk/* definitions for sysctl_req 'lock' member */ 121116518Sphk#define REQ_UNLOCKED 0 /* not locked and not wired */ 122116518Sphk#define REQ_LOCKED 1 /* locked and not wired */ 123116518Sphk#define REQ_WIRED 2 /* locked and wired */ 124116518Sphk 125116518Sphk/* definitions for sysctl_req 'flags' member */ 126116518Sphk#if defined(__amd64__) || defined(__ia64__) || defined(__powerpc64__) 127116518Sphk#define SCTL_MASK32 1 /* 32 bit emulation */ 128116518Sphk#endif 129116518Sphk 130116518Sphk/* 131116518Sphk * This describes the access space for a sysctl request. This is needed 132116518Sphk * so that we can use the interface from the kernel or from user-space. 133116518Sphk */ 134116518Sphkstruct sysctl_req { 135116518Sphk struct thread *td; /* used for access checking */ 136125755Sphk int lock; /* locking/wiring state */ 137116518Sphk void *oldptr; 138116518Sphk size_t oldlen; 139116518Sphk size_t oldidx; 140116518Sphk int (*oldfunc)(struct sysctl_req *, const void *, size_t); 141116518Sphk void *newptr; 142116518Sphk size_t newlen; 143116518Sphk size_t newidx; 144116518Sphk int (*newfunc)(struct sysctl_req *, void *, size_t); 145116518Sphk size_t validlen; 146116518Sphk int flags; 147116518Sphk}; 148116518Sphk 149116518SphkSLIST_HEAD(sysctl_oid_list, sysctl_oid); 150116518Sphk 151116518Sphk/* 152116518Sphk * This describes one "oid" in the MIB tree. Potentially more nodes can 153116518Sphk * be hidden behind it, expanded by the handler. 154116518Sphk */ 155116518Sphkstruct sysctl_oid { 156116518Sphk struct sysctl_oid_list *oid_parent; 157116518Sphk SLIST_ENTRY(sysctl_oid) oid_link; 158116518Sphk int oid_number; 159116518Sphk u_int oid_kind; 160116518Sphk void *oid_arg1; 161116518Sphk int oid_arg2; 162116518Sphk const char *oid_name; 163116518Sphk int (*oid_handler)(SYSCTL_HANDLER_ARGS); 164116518Sphk const char *oid_fmt; 165116518Sphk int oid_refcnt; 166116518Sphk const char *oid_descr; 167116518Sphk}; 168116518Sphk 169116518Sphk#define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l) 170116518Sphk#define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l) 171116518Sphk 172116518Sphkint sysctl_handle_int(SYSCTL_HANDLER_ARGS); 173116518Sphkint sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS); 174116518Sphkint sysctl_handle_long(SYSCTL_HANDLER_ARGS); 175116518Sphkint sysctl_handle_quad(SYSCTL_HANDLER_ARGS); 176116518Sphkint sysctl_handle_intptr(SYSCTL_HANDLER_ARGS); 177116518Sphkint sysctl_handle_string(SYSCTL_HANDLER_ARGS); 178116518Sphkint sysctl_handle_opaque(SYSCTL_HANDLER_ARGS); 179116518Sphk 180116518Sphkint sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS); 181116518Sphkint sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS); 182116518Sphkint sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS); 183116518Sphk 184116518Sphk/* 185125755Sphk * These functions are used to add/remove an oid from the mib. 186116518Sphk */ 187116518Sphkvoid sysctl_register_oid(struct sysctl_oid *oidp); 188116518Sphkvoid sysctl_unregister_oid(struct sysctl_oid *oidp); 189116518Sphk 190116518Sphk/* Declare a static oid to allow child oids to be added to it. */ 191116518Sphk#define SYSCTL_DECL(name) \ 192116518Sphk extern struct sysctl_oid_list sysctl_##name##_children 193116518Sphk 194116518Sphk/* Hide these in macros */ 195116518Sphk#define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \ 196121366Sphk (oid_ptr)->oid_arg1 197116518Sphk#define SYSCTL_CHILDREN_SET(oid_ptr, val) \ 198116518Sphk (oid_ptr)->oid_arg1 = (val); 199116518Sphk#define SYSCTL_STATIC_CHILDREN(oid_name) \ 200116518Sphk (&sysctl_##oid_name##_children) 201116518Sphk 202116518Sphk/* === Structs and macros related to context handling === */ 203116518Sphk 204116518Sphk/* All dynamically created sysctls can be tracked in a context list. */ 205116518Sphkstruct sysctl_ctx_entry { 206116518Sphk struct sysctl_oid *entry; 207116518Sphk TAILQ_ENTRY(sysctl_ctx_entry) link; 208116518Sphk}; 209116518Sphk 210116518SphkTAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry); 211116518Sphk 212116518Sphk#define SYSCTL_NODE_CHILDREN(parent, name) \ 213116518Sphk sysctl_##parent##_##name##_children 214116518Sphk 215116518Sphk#ifndef NO_SYSCTL_DESCR 216116518Sphk#define __DESCR(d) d 217116518Sphk#else 218116518Sphk#define __DESCR(d) "" 219116518Sphk#endif 220116518Sphk 221116518Sphk/* This constructs a "raw" MIB oid. */ 222116518Sphk#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 223116518Sphk static struct sysctl_oid sysctl__##parent##_##name = { \ 224116518Sphk &sysctl_##parent##_children, { NULL }, nbr, kind, \ 225116518Sphk a1, a2, #name, handler, fmt, 0, __DESCR(descr) }; \ 226116518Sphk DATA_SET(sysctl_set, sysctl__##parent##_##name) 227116518Sphk 228116518Sphk#define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 229116518Sphk sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr)) 230116518Sphk 231116518Sphk/* This constructs a node from which other oids can hang. */ 232116518Sphk#define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \ 233116518Sphk struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name); \ 234116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access), \ 235116518Sphk (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr) 236116518Sphk 237116518Sphk#define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \ 238116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \ 239116518Sphk NULL, 0, handler, "N", __DESCR(descr)) 240116518Sphk 241116518Sphk/* Oid for a string. len can be 0 to indicate '\0' termination. */ 242116518Sphk#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \ 243116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \ 244116518Sphk arg, len, sysctl_handle_string, "A", descr) 245116518Sphk 246116518Sphk#define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \ 247116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access), \ 248116518Sphk arg, len, sysctl_handle_string, "A", __DESCR(descr)) 249116518Sphk 250116518Sphk/* Oid for an int. If ptr is NULL, val is returned. */ 251116518Sphk#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \ 252116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access), \ 253116518Sphk ptr, val, sysctl_handle_int, "I", descr) 254116518Sphk 255116518Sphk#define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \ 256116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access), \ 257116518Sphk ptr, val, sysctl_handle_int, "I", __DESCR(descr)) 258116518Sphk 259116518Sphk/* Oid for an unsigned int. If ptr is NULL, val is returned. */ 260116518Sphk#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \ 261116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 262116518Sphk ptr, val, sysctl_handle_int, "IU", descr) 263116518Sphk 264116518Sphk#define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 265116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 266116518Sphk ptr, val, sysctl_handle_int, "IU", __DESCR(descr)) 267116518Sphk 268116518Sphk#define SYSCTL_XINT(parent, nbr, name, access, ptr, val, descr) \ 269116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 270116518Sphk ptr, val, sysctl_handle_int, "IX", descr) 271116518Sphk 272116518Sphk#define SYSCTL_ADD_XINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 273116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 274116518Sphk ptr, val, sysctl_handle_int, "IX", __DESCR(descr)) 275116518Sphk 276116518Sphk/* Oid for a long. The pointer must be non NULL. */ 277116518Sphk#define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \ 278116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access), \ 279116518Sphk ptr, val, sysctl_handle_long, "L", descr) 280116518Sphk 281116518Sphk#define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \ 282116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access), \ 283116518Sphk ptr, 0, sysctl_handle_long, "L", __DESCR(descr)) 284116518Sphk 285116518Sphk/* Oid for an unsigned long. The pointer must be non NULL. */ 286116518Sphk#define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \ 287116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 288116518Sphk ptr, val, sysctl_handle_long, "LU", __DESCR(descr)) 289116518Sphk 290116518Sphk#define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \ 291116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 292116518Sphk ptr, 0, sysctl_handle_long, "LU", __DESCR(descr)) 293116518Sphk 294116518Sphk#define SYSCTL_XLONG(parent, nbr, name, access, ptr, val, descr) \ 295116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 296125803Sphk ptr, val, sysctl_handle_long, "LX", __DESCR(descr)) 297125803Sphk 298125803Sphk#define SYSCTL_ADD_XLONG(ctx, parent, nbr, name, access, ptr, descr) \ 299125803Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 300125803Sphk ptr, 0, sysctl_handle_long, "LX", __DESCR(descr)) 301125803Sphk 302116518Sphk/* Oid for a quad. The pointer must be non NULL. */ 303116518Sphk#define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \ 304116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access), \ 305116518Sphk ptr, val, sysctl_handle_quad, "Q", __DESCR(descr)) 306116518Sphk 307116518Sphk#define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \ 308116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access), \ 309125755Sphk ptr, 0, sysctl_handle_quad, "Q", __DESCR(descr)) 310116518Sphk 311116518Sphk/* Oid for an opaque object. Specified by a pointer and a length. */ 312116518Sphk#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \ 313116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 314116518Sphk ptr, len, sysctl_handle_opaque, fmt, descr) 315116518Sphk 316116518Sphk#define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\ 317116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 318116518Sphk ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr)) 319125755Sphk 320116518Sphk/* Oid for a struct. Specified by a pointer and a type. */ 321116518Sphk#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \ 322116518Sphk SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 323116518Sphk ptr, sizeof(struct type), sysctl_handle_opaque, \ 324116518Sphk "S," #type, descr) 325116518Sphk 326116518Sphk#define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \ 327116518Sphk sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 328116518Sphk ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr)) 329125755Sphk 330116518Sphk/* Oid for a procedure. Specified by a pointer and an arg. */ 331116518Sphk#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 332116518Sphk SYSCTL_OID(parent, nbr, name, (access), \ 333116518Sphk ptr, arg, handler, fmt, descr) 334116518Sphk 335116518Sphk#define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 336116518Sphk sysctl_add_oid(ctx, parent, nbr, name, (access), \ 337116518Sphk ptr, arg, handler, fmt, __DESCR(descr)) 338116518Sphk 339125755Sphk/* 340116518Sphk * A macro to generate a read-only sysctl to indicate the presense of optional 341116518Sphk * kernel features. 342116518Sphk */ 343116518Sphk#define FEATURE(name, desc) \ 344116518Sphk SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD, 0, 1, desc) 345116518Sphk 346116518Sphk#endif /* _KERNEL */ 347116518Sphk 348116518Sphk/* 349116518Sphk * Top-level identifiers 350116518Sphk */ 351116518Sphk#define CTL_UNSPEC 0 /* unused */ 352116518Sphk#define CTL_KERN 1 /* "high kernel": proc, limits */ 353116518Sphk#define CTL_VM 2 /* virtual memory */ 354116518Sphk#define CTL_VFS 3 /* filesystem, mount type is next */ 355116518Sphk#define CTL_NET 4 /* network, see socket.h */ 356116518Sphk#define CTL_DEBUG 5 /* debugging parameters */ 357116518Sphk#define CTL_HW 6 /* generic cpu/io */ 358116518Sphk#define CTL_MACHDEP 7 /* machine dependent */ 359116518Sphk#define CTL_USER 8 /* user-level */ 360116518Sphk#define CTL_P1003_1B 9 /* POSIX 1003.1B */ 361116518Sphk#define CTL_MAXID 10 /* number of valid top-level ids */ 362116518Sphk 363116518Sphk#define CTL_NAMES { \ 364116518Sphk { 0, 0 }, \ 365116518Sphk { "kern", CTLTYPE_NODE }, \ 366125755Sphk { "vm", CTLTYPE_NODE }, \ 367116518Sphk { "vfs", CTLTYPE_NODE }, \ 368116518Sphk { "net", CTLTYPE_NODE }, \ 369116518Sphk { "debug", CTLTYPE_NODE }, \ 370116518Sphk { "hw", CTLTYPE_NODE }, \ 371116518Sphk { "machdep", CTLTYPE_NODE }, \ 372116518Sphk { "user", CTLTYPE_NODE }, \ 373116518Sphk { "p1003_1b", CTLTYPE_NODE }, \ 374116518Sphk} 375116518Sphk 376116518Sphk/* 377152971Ssobomax * CTL_KERN identifiers 378116518Sphk */ 379152967Ssobomax#define KERN_OSTYPE 1 /* string: system version */ 380116518Sphk#define KERN_OSRELEASE 2 /* string: system release */ 381116518Sphk#define KERN_OSREV 3 /* int: system revision */ 382116518Sphk#define KERN_VERSION 4 /* string: compile time info */ 383116518Sphk#define KERN_MAXVNODES 5 /* int: max vnodes */ 384116518Sphk#define KERN_MAXPROC 6 /* int: max processes */ 385116518Sphk#define KERN_MAXFILES 7 /* int: max open files */ 386116518Sphk#define KERN_ARGMAX 8 /* int: max arguments to exec */ 387116518Sphk#define KERN_SECURELVL 9 /* int: system security level */ 388116518Sphk#define KERN_HOSTNAME 10 /* string: hostname */ 389121475Sphk#define KERN_HOSTID 11 /* int: host identifier */ 390116518Sphk#define KERN_CLOCKRATE 12 /* struct: struct clockrate */ 391116518Sphk#define KERN_VNODE 13 /* struct: vnode structures */ 392116518Sphk#define KERN_PROC 14 /* struct: process entries */ 393116518Sphk#define KERN_FILE 15 /* struct: file entries */ 394116518Sphk#define KERN_PROF 16 /* node: kernel profiling info */ 395116518Sphk#define KERN_POSIX1 17 /* int: POSIX.1 version */ 396116518Sphk#define KERN_NGROUPS 18 /* int: # of supplemental group ids */ 397116518Sphk#define KERN_JOB_CONTROL 19 /* int: is job control available */ 398116518Sphk#define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */ 399116518Sphk#define KERN_BOOTTIME 21 /* struct: time kernel was booted */ 400116518Sphk#define KERN_NISDOMAINNAME 22 /* string: YP domain name */ 401116518Sphk#define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */ 402116518Sphk#define KERN_OSRELDATE 24 /* int: kernel release date */ 403116518Sphk#define KERN_NTP_PLL 25 /* node: NTP PLL control */ 404116518Sphk#define KERN_BOOTFILE 26 /* string: name of booted kernel */ 405116518Sphk#define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */ 406116518Sphk#define KERN_MAXPROCPERUID 28 /* int: max processes per uid */ 407125755Sphk#define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */ 408116518Sphk#define KERN_IPC 30 /* node: anything related to IPC */ 409116518Sphk#define KERN_DUMMY 31 /* unused */ 410116518Sphk#define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */ 411116518Sphk#define KERN_USRSTACK 33 /* int: address of USRSTACK */ 412116518Sphk#define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */ 413116518Sphk#define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */ 414116518Sphk#define KERN_HOSTUUID 36 /* string: host UUID identifier */ 415121475Sphk#define KERN_ARND 37 /* int: from arc4rand() */ 416116518Sphk#define KERN_MAXID 38 /* number of valid kern ids */ 417116518Sphk 418116518Sphk#define CTL_KERN_NAMES { \ 419116518Sphk { 0, 0 }, \ 420116518Sphk { "ostype", CTLTYPE_STRING }, \ 421116518Sphk { "osrelease", CTLTYPE_STRING }, \ 422116518Sphk { "osrevision", CTLTYPE_INT }, \ 423116518Sphk { "version", CTLTYPE_STRING }, \ 424116518Sphk { "maxvnodes", CTLTYPE_INT }, \ 425116518Sphk { "maxproc", CTLTYPE_INT }, \ 426116518Sphk { "maxfiles", CTLTYPE_INT }, \ 427116518Sphk { "argmax", CTLTYPE_INT }, \ 428116518Sphk { "securelevel", CTLTYPE_INT }, \ 429116518Sphk { "hostname", CTLTYPE_STRING }, \ 430116518Sphk { "hostid", CTLTYPE_UINT }, \ 431116518Sphk { "clockrate", CTLTYPE_STRUCT }, \ 432116518Sphk { "vnode", CTLTYPE_STRUCT }, \ 433116518Sphk { "proc", CTLTYPE_STRUCT }, \ 434116518Sphk { "file", CTLTYPE_STRUCT }, \ 435116518Sphk { "profiling", CTLTYPE_NODE }, \ 436116518Sphk { "posix1version", CTLTYPE_INT }, \ 437116518Sphk { "ngroups", CTLTYPE_INT }, \ 438116518Sphk { "job_control", CTLTYPE_INT }, \ 439125755Sphk { "saved_ids", CTLTYPE_INT }, \ 440116518Sphk { "boottime", CTLTYPE_STRUCT }, \ 441116518Sphk { "nisdomainname", CTLTYPE_STRING }, \ 442116518Sphk { "update", CTLTYPE_INT }, \ 443116518Sphk { "osreldate", CTLTYPE_INT }, \ 444116518Sphk { "ntp_pll", CTLTYPE_NODE }, \ 445116518Sphk { "bootfile", CTLTYPE_STRING }, \ 446116518Sphk { "maxfilesperproc", CTLTYPE_INT }, \ 447116518Sphk { "maxprocperuid", CTLTYPE_INT }, \ 448116518Sphk { "ipc", CTLTYPE_NODE }, \ 449116518Sphk { "dummy", CTLTYPE_INT }, \ 450116518Sphk { "ps_strings", CTLTYPE_INT }, \ 451116518Sphk { "usrstack", CTLTYPE_INT }, \ 452116518Sphk { "logsigexit", CTLTYPE_INT }, \ 453116518Sphk { "iov_max", CTLTYPE_INT }, \ 454116518Sphk { "hostuuid", CTLTYPE_STRING }, \ 455116518Sphk} 456116518Sphk 457116518Sphk/* 458116518Sphk * CTL_VFS identifiers 459116518Sphk */ 460125538Sle#define CTL_VFS_NAMES { \ 461116518Sphk { "vfsconf", CTLTYPE_STRUCT }, \ 462116518Sphk} 463116518Sphk 464116518Sphk/* 465116518Sphk * KERN_PROC subtypes 466116518Sphk */ 467133318Sphk#define KERN_PROC_ALL 0 /* everything */ 468116518Sphk#define KERN_PROC_PID 1 /* by process id */ 469116518Sphk#define KERN_PROC_PGRP 2 /* by process group id */ 470133314Sphk#define KERN_PROC_SESSION 3 /* by session of pid */ 471133314Sphk#define KERN_PROC_TTY 4 /* by controlling tty */ 472133314Sphk#define KERN_PROC_UID 5 /* by effective uid */ 473133314Sphk#define KERN_PROC_RUID 6 /* by real uid */ 474116518Sphk#define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */ 475116518Sphk#define KERN_PROC_PROC 8 /* only return procs */ 476116518Sphk#define KERN_PROC_SV_NAME 9 /* get syscall vector name */ 477#define KERN_PROC_RGID 10 /* by real group id */ 478#define KERN_PROC_GID 11 /* by effective group id */ 479#define KERN_PROC_PATHNAME 12 /* path to executable */ 480#define KERN_PROC_OVMMAP 13 /* Old VM map entries for process */ 481#define KERN_PROC_OFILEDESC 14 /* Old file descriptors for process */ 482#define KERN_PROC_KSTACK 15 /* Kernel stacks for process */ 483#define KERN_PROC_INC_THREAD 0x10 /* 484 * modifier for pid, pgrp, tty, 485 * uid, ruid, gid, rgid and proc 486 * This effectively uses 16-31 487 */ 488#define KERN_PROC_VMMAP 32 /* VM map entries for process */ 489#define KERN_PROC_FILEDESC 33 /* File descriptors for process */ 490#define KERN_PROC_GROUPS 34 /* process groups */ 491 492/* 493 * KERN_IPC identifiers 494 */ 495#define KIPC_MAXSOCKBUF 1 /* int: max size of a socket buffer */ 496#define KIPC_SOCKBUF_WASTE 2 /* int: wastage factor in sockbuf */ 497#define KIPC_SOMAXCONN 3 /* int: max length of connection q */ 498#define KIPC_MAX_LINKHDR 4 /* int: max length of link header */ 499#define KIPC_MAX_PROTOHDR 5 /* int: max length of network header */ 500#define KIPC_MAX_HDR 6 /* int: max total length of headers */ 501#define KIPC_MAX_DATALEN 7 /* int: max length of data? */ 502 503/* 504 * CTL_HW identifiers 505 */ 506#define HW_MACHINE 1 /* string: machine class */ 507#define HW_MODEL 2 /* string: specific machine model */ 508#define HW_NCPU 3 /* int: number of cpus */ 509#define HW_BYTEORDER 4 /* int: machine byte order */ 510#define HW_PHYSMEM 5 /* int: total memory */ 511#define HW_USERMEM 6 /* int: non-kernel memory */ 512#define HW_PAGESIZE 7 /* int: software page size */ 513#define HW_DISKNAMES 8 /* strings: disk drive names */ 514#define HW_DISKSTATS 9 /* struct: diskstats[] */ 515#define HW_FLOATINGPT 10 /* int: has HW floating point? */ 516#define HW_MACHINE_ARCH 11 /* string: machine architecture */ 517#define HW_REALMEM 12 /* int: 'real' memory */ 518#define HW_MAXID 13 /* number of valid hw ids */ 519 520#define CTL_HW_NAMES { \ 521 { 0, 0 }, \ 522 { "machine", CTLTYPE_STRING }, \ 523 { "model", CTLTYPE_STRING }, \ 524 { "ncpu", CTLTYPE_INT }, \ 525 { "byteorder", CTLTYPE_INT }, \ 526 { "physmem", CTLTYPE_ULONG }, \ 527 { "usermem", CTLTYPE_ULONG }, \ 528 { "pagesize", CTLTYPE_INT }, \ 529 { "disknames", CTLTYPE_STRUCT }, \ 530 { "diskstats", CTLTYPE_STRUCT }, \ 531 { "floatingpoint", CTLTYPE_INT }, \ 532 { "machine_arch", CTLTYPE_STRING }, \ 533 { "realmem", CTLTYPE_ULONG }, \ 534} 535 536/* 537 * CTL_USER definitions 538 */ 539#define USER_CS_PATH 1 /* string: _CS_PATH */ 540#define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */ 541#define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */ 542#define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */ 543#define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */ 544#define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */ 545#define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */ 546#define USER_LINE_MAX 8 /* int: LINE_MAX */ 547#define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */ 548#define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */ 549#define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */ 550#define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */ 551#define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */ 552#define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */ 553#define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */ 554#define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */ 555#define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */ 556#define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */ 557#define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */ 558#define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */ 559#define USER_MAXID 21 /* number of valid user ids */ 560 561#define CTL_USER_NAMES { \ 562 { 0, 0 }, \ 563 { "cs_path", CTLTYPE_STRING }, \ 564 { "bc_base_max", CTLTYPE_INT }, \ 565 { "bc_dim_max", CTLTYPE_INT }, \ 566 { "bc_scale_max", CTLTYPE_INT }, \ 567 { "bc_string_max", CTLTYPE_INT }, \ 568 { "coll_weights_max", CTLTYPE_INT }, \ 569 { "expr_nest_max", CTLTYPE_INT }, \ 570 { "line_max", CTLTYPE_INT }, \ 571 { "re_dup_max", CTLTYPE_INT }, \ 572 { "posix2_version", CTLTYPE_INT }, \ 573 { "posix2_c_bind", CTLTYPE_INT }, \ 574 { "posix2_c_dev", CTLTYPE_INT }, \ 575 { "posix2_char_term", CTLTYPE_INT }, \ 576 { "posix2_fort_dev", CTLTYPE_INT }, \ 577 { "posix2_fort_run", CTLTYPE_INT }, \ 578 { "posix2_localedef", CTLTYPE_INT }, \ 579 { "posix2_sw_dev", CTLTYPE_INT }, \ 580 { "posix2_upe", CTLTYPE_INT }, \ 581 { "stream_max", CTLTYPE_INT }, \ 582 { "tzname_max", CTLTYPE_INT }, \ 583} 584 585#define CTL_P1003_1B_ASYNCHRONOUS_IO 1 /* boolean */ 586#define CTL_P1003_1B_MAPPED_FILES 2 /* boolean */ 587#define CTL_P1003_1B_MEMLOCK 3 /* boolean */ 588#define CTL_P1003_1B_MEMLOCK_RANGE 4 /* boolean */ 589#define CTL_P1003_1B_MEMORY_PROTECTION 5 /* boolean */ 590#define CTL_P1003_1B_MESSAGE_PASSING 6 /* boolean */ 591#define CTL_P1003_1B_PRIORITIZED_IO 7 /* boolean */ 592#define CTL_P1003_1B_PRIORITY_SCHEDULING 8 /* boolean */ 593#define CTL_P1003_1B_REALTIME_SIGNALS 9 /* boolean */ 594#define CTL_P1003_1B_SEMAPHORES 10 /* boolean */ 595#define CTL_P1003_1B_FSYNC 11 /* boolean */ 596#define CTL_P1003_1B_SHARED_MEMORY_OBJECTS 12 /* boolean */ 597#define CTL_P1003_1B_SYNCHRONIZED_IO 13 /* boolean */ 598#define CTL_P1003_1B_TIMERS 14 /* boolean */ 599#define CTL_P1003_1B_AIO_LISTIO_MAX 15 /* int */ 600#define CTL_P1003_1B_AIO_MAX 16 /* int */ 601#define CTL_P1003_1B_AIO_PRIO_DELTA_MAX 17 /* int */ 602#define CTL_P1003_1B_DELAYTIMER_MAX 18 /* int */ 603#define CTL_P1003_1B_MQ_OPEN_MAX 19 /* int */ 604#define CTL_P1003_1B_PAGESIZE 20 /* int */ 605#define CTL_P1003_1B_RTSIG_MAX 21 /* int */ 606#define CTL_P1003_1B_SEM_NSEMS_MAX 22 /* int */ 607#define CTL_P1003_1B_SEM_VALUE_MAX 23 /* int */ 608#define CTL_P1003_1B_SIGQUEUE_MAX 24 /* int */ 609#define CTL_P1003_1B_TIMER_MAX 25 /* int */ 610 611#define CTL_P1003_1B_MAXID 26 612 613#define CTL_P1003_1B_NAMES { \ 614 { 0, 0 }, \ 615 { "asynchronous_io", CTLTYPE_INT }, \ 616 { "mapped_files", CTLTYPE_INT }, \ 617 { "memlock", CTLTYPE_INT }, \ 618 { "memlock_range", CTLTYPE_INT }, \ 619 { "memory_protection", CTLTYPE_INT }, \ 620 { "message_passing", CTLTYPE_INT }, \ 621 { "prioritized_io", CTLTYPE_INT }, \ 622 { "priority_scheduling", CTLTYPE_INT }, \ 623 { "realtime_signals", CTLTYPE_INT }, \ 624 { "semaphores", CTLTYPE_INT }, \ 625 { "fsync", CTLTYPE_INT }, \ 626 { "shared_memory_objects", CTLTYPE_INT }, \ 627 { "synchronized_io", CTLTYPE_INT }, \ 628 { "timers", CTLTYPE_INT }, \ 629 { "aio_listio_max", CTLTYPE_INT }, \ 630 { "aio_max", CTLTYPE_INT }, \ 631 { "aio_prio_delta_max", CTLTYPE_INT }, \ 632 { "delaytimer_max", CTLTYPE_INT }, \ 633 { "mq_open_max", CTLTYPE_INT }, \ 634 { "pagesize", CTLTYPE_INT }, \ 635 { "rtsig_max", CTLTYPE_INT }, \ 636 { "nsems_max", CTLTYPE_INT }, \ 637 { "sem_value_max", CTLTYPE_INT }, \ 638 { "sigqueue_max", CTLTYPE_INT }, \ 639 { "timer_max", CTLTYPE_INT }, \ 640} 641 642#ifdef _KERNEL 643 644/* 645 * Declare some common oids. 646 */ 647extern struct sysctl_oid_list sysctl__children; 648SYSCTL_DECL(_kern); 649SYSCTL_DECL(_kern_features); 650SYSCTL_DECL(_kern_ipc); 651SYSCTL_DECL(_kern_proc); 652SYSCTL_DECL(_kern_sched); 653SYSCTL_DECL(_kern_sched_stats); 654SYSCTL_DECL(_sysctl); 655SYSCTL_DECL(_vm); 656SYSCTL_DECL(_vm_stats); 657SYSCTL_DECL(_vm_stats_misc); 658SYSCTL_DECL(_vfs); 659SYSCTL_DECL(_net); 660SYSCTL_DECL(_debug); 661SYSCTL_DECL(_debug_sizeof); 662SYSCTL_DECL(_dev); 663SYSCTL_DECL(_hw); 664SYSCTL_DECL(_hw_bus); 665SYSCTL_DECL(_hw_bus_devices); 666SYSCTL_DECL(_hw_bus_info); 667SYSCTL_DECL(_machdep); 668SYSCTL_DECL(_user); 669SYSCTL_DECL(_compat); 670SYSCTL_DECL(_regression); 671SYSCTL_DECL(_security); 672SYSCTL_DECL(_security_bsd); 673 674extern char machine[]; 675extern char osrelease[]; 676extern char ostype[]; 677extern char kern_ident[]; 678 679/* Dynamic oid handling */ 680struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist, 681 struct sysctl_oid_list *parent, int nbr, const char *name, 682 int kind, void *arg1, int arg2, 683 int (*handler) (SYSCTL_HANDLER_ARGS), 684 const char *fmt, const char *descr); 685void sysctl_rename_oid(struct sysctl_oid *oidp, const char *name); 686int sysctl_move_oid(struct sysctl_oid *oidp, 687 struct sysctl_oid_list *parent); 688int sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse); 689int sysctl_ctx_init(struct sysctl_ctx_list *clist); 690int sysctl_ctx_free(struct sysctl_ctx_list *clist); 691struct sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist, 692 struct sysctl_oid *oidp); 693struct sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist, 694 struct sysctl_oid *oidp); 695int sysctl_ctx_entry_del(struct sysctl_ctx_list *clist, 696 struct sysctl_oid *oidp); 697 698int kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old, 699 size_t *oldlenp, void *new, size_t newlen, 700 size_t *retval, int flags); 701int kernel_sysctlbyname(struct thread *td, char *name, 702 void *old, size_t *oldlenp, void *new, size_t newlen, 703 size_t *retval, int flags); 704int userland_sysctl(struct thread *td, int *name, u_int namelen, void *old, 705 size_t *oldlenp, int inkernel, void *new, size_t newlen, 706 size_t *retval, int flags); 707int sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid, 708 int *nindx, struct sysctl_req *req); 709void sysctl_lock(void); 710void sysctl_unlock(void); 711int sysctl_wire_old_buffer(struct sysctl_req *req, size_t len); 712 713struct sbuf; 714struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int, 715 struct sysctl_req *); 716#else /* !_KERNEL */ 717#include <sys/cdefs.h> 718 719__BEGIN_DECLS 720int sysctl(const int *, u_int, void *, size_t *, const void *, size_t); 721int sysctlbyname(const char *, void *, size_t *, const void *, size_t); 722int sysctlnametomib(const char *, int *, size_t *); 723__END_DECLS 724#endif /* _KERNEL */ 725 726#endif /* !_SYS_SYSCTL_H_ */ 727