sysctl.h revision 204170
11638Srgrimes/*- 21638Srgrimes * Copyright (c) 1989, 1993 31638Srgrimes * The Regents of the University of California. All rights reserved. 41638Srgrimes * 51638Srgrimes * This code is derived from software contributed to Berkeley by 61638Srgrimes * Mike Karels at Berkeley Software Design, Inc. 71638Srgrimes * 81638Srgrimes * Redistribution and use in source and binary forms, with or without 91638Srgrimes * modification, are permitted provided that the following conditions 101638Srgrimes * are met: 111638Srgrimes * 1. Redistributions of source code must retain the above copyright 121638Srgrimes * notice, this list of conditions and the following disclaimer. 131638Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 141638Srgrimes * notice, this list of conditions and the following disclaimer in the 151638Srgrimes * documentation and/or other materials provided with the distribution. 161638Srgrimes * 4. Neither the name of the University nor the names of its contributors 171638Srgrimes * may be used to endorse or promote products derived from this software 181638Srgrimes * without specific prior written permission. 191638Srgrimes * 201638Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 211638Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 221638Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 231638Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 241638Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 251638Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 261638Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 271638Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 281638Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 291638Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 301638Srgrimes * SUCH DAMAGE. 311638Srgrimes * 321638Srgrimes * @(#)sysctl.h 8.1 (Berkeley) 6/2/93 3350476Speter * $FreeBSD: head/sys/sys/sysctl.h 204170 2010-02-21 13:57:02Z ed $ 341638Srgrimes */ 35163847Spjd 361638Srgrimes#ifndef _SYS_SYSCTL_H_ 3779538Sru#define _SYS_SYSCTL_H_ 381638Srgrimes 391638Srgrimes#include <sys/queue.h> 401638Srgrimes 41107788Srustruct thread; 421638Srgrimes/* 4384306Sru * Definitions for sysctl call. The sysctl call uses a hierarchical name 4484306Sru * for objects that can be examined or modified. The name is expressed as 4524055Sbde * a sequence of integers. Like a file path name, the meaning of each 4684306Sru * component depends on its place in the hierarchy. The top-level and kern 4784306Sru * identifiers are defined here, and other identifiers are defined in the 48167259Smckusick * respective subsystem header files. 49167259Smckusick */ 5084306Sru 51167259Smckusick#define CTL_MAXNAME 24 /* largest number of components supported */ 52167259Smckusick 531638Srgrimes/* 541638Srgrimes * Each subsystem defined by sysctl defines a list of variables 55119893Sru * for that subsystem. Each name is either a node with further 561638Srgrimes * levels defined below it, or it is a leaf of some particular 57119893Sru * type given below. Each sysctl level defines a set of name/type 581638Srgrimes * pairs to be used by sysctl(8) in manipulating the subsystem. 591638Srgrimes */ 60107788Srustruct ctlname { 611638Srgrimes char *ctl_name; /* subsystem name */ 621638Srgrimes int ctl_type; /* type of name */ 63107788Sru}; 641638Srgrimes 651638Srgrimes#define CTLTYPE 0xf /* Mask for the type */ 661638Srgrimes#define CTLTYPE_NODE 1 /* name is a node */ 671638Srgrimes#define CTLTYPE_INT 2 /* name describes an integer */ 681638Srgrimes#define CTLTYPE_STRING 3 /* name describes a string */ 691638Srgrimes#define CTLTYPE_QUAD 4 /* name describes a 64-bit number */ 701638Srgrimes#define CTLTYPE_OPAQUE 5 /* name describes a structure */ 711638Srgrimes#define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */ 72107788Sru#define CTLTYPE_UINT 6 /* name describes an unsigned integer */ 731638Srgrimes#define CTLTYPE_LONG 7 /* name describes a long */ 741638Srgrimes#define CTLTYPE_ULONG 8 /* name describes an unsigned long */ 751638Srgrimes 761638Srgrimes#define CTLFLAG_RD 0x80000000 /* Allow reads of variable */ 77113858Strhodes#define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */ 7822525Smpp#define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR) 791638Srgrimes#define CTLFLAG_NOLOCK 0x20000000 /* XXX Don't Lock */ 80119893Sru#define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */ 811638Srgrimes#define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */ 8222525Smpp#define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */ 83113858Strhodes#define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */ 8422525Smpp#define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */ 851638Srgrimes#define CTLMASK_SECURE 0x00F00000 /* Secure level */ 86113858Strhodes#define CTLFLAG_TUN 0x00080000 /* Tunable variable */ 87113858Strhodes#define CTLFLAG_MPSAFE 0x00040000 /* Handler is MP safe */ 88113858Strhodes#define CTLFLAG_VNET 0x00020000 /* Prisons with vnet can fiddle */ 89113858Strhodes#define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN) 90113858Strhodes 91113858Strhodes/* 92113858Strhodes * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1. 93113858Strhodes * 94113858Strhodes * Secure when the securelevel is raised to at least N. 95113858Strhodes */ 96113858Strhodes#define CTLSHIFT_SECURE 20 97113858Strhodes#define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE)) 98113858Strhodes#define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE)) 99113858Strhodes#define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE)) 100113858Strhodes 1011638Srgrimes/* 102113858Strhodes * USE THIS instead of a hardwired number from the categories below 103113858Strhodes * to get dynamically assigned sysctl entries using the linker-set 104113858Strhodes * technology. This is the way nearly all new sysctl variables should 1051638Srgrimes * be implemented. 106113858Strhodes * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, ""); 107113858Strhodes */ 108113858Strhodes#define OID_AUTO (-1) 109113858Strhodes 1101638Srgrimes/* 111113858Strhodes * The starting number for dynamically-assigned entries. WARNING! 112113858Strhodes * ALL static sysctl entries should have numbers LESS than this! 1131638Srgrimes */ 114113858Strhodes#define CTL_AUTO_START 0x100 115113858Strhodes 116113858Strhodes#ifdef _KERNEL 117113858Strhodes#define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \ 118113858Strhodes struct sysctl_req *req 119113858Strhodes 120113858Strhodes/* definitions for sysctl_req 'lock' member */ 121113858Strhodes#define REQ_UNLOCKED 0 /* not locked and not wired */ 1221638Srgrimes#define REQ_LOCKED 1 /* locked and not wired */ 123113858Strhodes#define REQ_WIRED 2 /* locked and wired */ 124113858Strhodes 125113858Strhodes/* definitions for sysctl_req 'flags' member */ 126113858Strhodes#if defined(__amd64__) || defined(__ia64__) 127113858Strhodes#define SCTL_MASK32 1 /* 32 bit emulation */ 1281638Srgrimes#endif 129113858Strhodes 130113858Strhodes/* 131113858Strhodes * This describes the access space for a sysctl request. This is needed 132113858Strhodes * so that we can use the interface from the kernel or from user-space. 133113858Strhodes */ 134113858Strhodesstruct sysctl_req { 135113858Strhodes struct thread *td; /* used for access checking */ 136113858Strhodes int lock; /* locking/wiring state */ 137113858Strhodes void *oldptr; 138113858Strhodes size_t oldlen; 1391638Srgrimes size_t oldidx; 140113858Strhodes int (*oldfunc)(struct sysctl_req *, const void *, size_t); 1411638Srgrimes void *newptr; 142113858Strhodes size_t newlen; 143113858Strhodes size_t newidx; 144113858Strhodes int (*newfunc)(struct sysctl_req *, void *, size_t); 145113858Strhodes size_t validlen; 146113858Strhodes int flags; 147113858Strhodes}; 148113858Strhodes 149113858StrhodesSLIST_HEAD(sysctl_oid_list, sysctl_oid); 1501638Srgrimes 151113858Strhodes/* 152113858Strhodes * This describes one "oid" in the MIB tree. Potentially more nodes can 153113858Strhodes * be hidden behind it, expanded by the handler. 154113858Strhodes */ 155113858Strhodesstruct sysctl_oid { 156113858Strhodes struct sysctl_oid_list *oid_parent; 157113858Strhodes SLIST_ENTRY(sysctl_oid) oid_link; 158113858Strhodes int oid_number; 159163847Spjd u_int oid_kind; 160163847Spjd void *oid_arg1; 161113858Strhodes int oid_arg2; 162113858Strhodes const char *oid_name; 163113858Strhodes int (*oid_handler)(SYSCTL_HANDLER_ARGS); 164113858Strhodes const char *oid_fmt; 165113858Strhodes int oid_refcnt; 166113858Strhodes const char *oid_descr; 167113858Strhodes}; 168113858Strhodes 169113858Strhodes#define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l) 170113858Strhodes#define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l) 171113858Strhodes 172113858Strhodesint sysctl_handle_int(SYSCTL_HANDLER_ARGS); 173113858Strhodesint sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS); 174113858Strhodesint sysctl_handle_long(SYSCTL_HANDLER_ARGS); 175115211Sruint sysctl_handle_quad(SYSCTL_HANDLER_ARGS); 176113858Strhodesint sysctl_handle_intptr(SYSCTL_HANDLER_ARGS); 177113858Strhodesint sysctl_handle_string(SYSCTL_HANDLER_ARGS); 178113858Strhodesint sysctl_handle_opaque(SYSCTL_HANDLER_ARGS); 179113858Strhodes 180113858Strhodesint sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS); 181113858Strhodesint sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS); 182113858Strhodesint sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS); 183113858Strhodes 184113858Strhodes/* 185113858Strhodes * These functions are used to add/remove an oid from the mib. 186113858Strhodes */ 1871638Srgrimesvoid sysctl_register_oid(struct sysctl_oid *oidp); 18822525Smppvoid sysctl_unregister_oid(struct sysctl_oid *oidp); 18922060Smpp 190113858Strhodes/* Declare a static oid to allow child oids to be added to it. */ 19122060Smpp#define SYSCTL_DECL(name) \ 192113858Strhodes extern struct sysctl_oid_list sysctl_##name##_children 193113858Strhodes 194113858Strhodes/* Hide these in macros */ 195113858Strhodes#define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \ 196113858Strhodes (oid_ptr)->oid_arg1 197113858Strhodes#define SYSCTL_CHILDREN_SET(oid_ptr, val) \ 19822060Smpp (oid_ptr)->oid_arg1 = (val); 19922060Smpp#define SYSCTL_STATIC_CHILDREN(oid_name) \ 20022060Smpp (&sysctl_##oid_name##_children) 20122525Smpp 20222525Smpp/* === Structs and macros related to context handling === */ 2031638Srgrimes 2041638Srgrimes/* All dynamically created sysctls can be tracked in a context list. */ 205107788Srustruct sysctl_ctx_entry { 206107788Sru struct sysctl_oid *entry; 2071638Srgrimes TAILQ_ENTRY(sysctl_ctx_entry) link; 2081638Srgrimes}; 209107788Sru 210131530SruTAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry); 211131530Sru 2121638Srgrimes#define SYSCTL_NODE_CHILDREN(parent, name) \ 213131530Sru sysctl_##parent##_##name##_children 214131530Sru 2151638Srgrimes#ifndef NO_SYSCTL_DESCR 2161638Srgrimes#define __DESCR(d) d 2171638Srgrimes#else 2181638Srgrimes#define __DESCR(d) "" 2191638Srgrimes#endif 220131530Sru 221131530Sru/* This constructs a "raw" MIB oid. */ 2221638Srgrimes#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 22379727Sschweikh static struct sysctl_oid sysctl__##parent##_##name = { \ 2241638Srgrimes &sysctl_##parent##_children, { NULL }, nbr, kind, \ 2251638Srgrimes a1, a2, #name, handler, fmt, 0, __DESCR(descr) }; \ 2261638Srgrimes DATA_SET(sysctl_set, sysctl__##parent##_##name) 2271638Srgrimes 2281638Srgrimes#define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 2291638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr)) 2301638Srgrimes 2311638Srgrimes/* This constructs a node from which other oids can hang. */ 232131530Sru#define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \ 233131530Sru struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name); \ 2341638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access), \ 2351638Srgrimes (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr) 236131530Sru 237131530Sru#define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \ 2381638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \ 239131530Sru NULL, 0, handler, "N", __DESCR(descr)) 240131530Sru 2411638Srgrimes/* Oid for a string. len can be 0 to indicate '\0' termination. */ 2421638Srgrimes#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \ 2431638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \ 2441638Srgrimes arg, len, sysctl_handle_string, "A", descr) 245107788Sru 2461638Srgrimes#define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \ 2471638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access), \ 248107788Sru arg, len, sysctl_handle_string, "A", __DESCR(descr)) 249141846Sru 2501638Srgrimes/* Oid for an int. If ptr is NULL, val is returned. */ 2511638Srgrimes#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \ 2521638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access), \ 2531638Srgrimes ptr, val, sysctl_handle_int, "I", descr) 2541638Srgrimes 2551638Srgrimes#define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \ 2561638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_INT|CTLFLAG_MPSAFE|(access), \ 257107788Sru ptr, val, sysctl_handle_int, "I", __DESCR(descr)) 25857731Ssheldonh 25957731Ssheldonh/* Oid for an unsigned int. If ptr is NULL, val is returned. */ 2601638Srgrimes#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \ 2611638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 2621638Srgrimes ptr, val, sysctl_handle_int, "IU", descr) 2631638Srgrimes 2641638Srgrimes#define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 2651638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 266107788Sru ptr, val, sysctl_handle_int, "IU", __DESCR(descr)) 2671638Srgrimes 2681638Srgrimes#define SYSCTL_XINT(parent, nbr, name, access, ptr, val, descr) \ 2691638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 2701638Srgrimes ptr, val, sysctl_handle_int, "IX", descr) 2711638Srgrimes 2721638Srgrimes#define SYSCTL_ADD_XINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 2731638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|CTLFLAG_MPSAFE|(access), \ 2741638Srgrimes ptr, val, sysctl_handle_int, "IX", __DESCR(descr)) 2751638Srgrimes 2761638Srgrimes/* Oid for a long. The pointer must be non NULL. */ 2771638Srgrimes#define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \ 278107788Sru SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access), \ 2791638Srgrimes ptr, val, sysctl_handle_long, "L", descr) 2801638Srgrimes 2811638Srgrimes#define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \ 282107788Sru sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|CTLFLAG_MPSAFE|(access), \ 2831638Srgrimes ptr, 0, sysctl_handle_long, "L", __DESCR(descr)) 2841638Srgrimes 2851638Srgrimes/* Oid for an unsigned long. The pointer must be non NULL. */ 286107788Sru#define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \ 2871638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 2881638Srgrimes ptr, val, sysctl_handle_long, "LU", __DESCR(descr)) 2891638Srgrimes 2901638Srgrimes#define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \ 29157731Ssheldonh sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 29257731Ssheldonh ptr, 0, sysctl_handle_long, "LU", __DESCR(descr)) 2931638Srgrimes 2941638Srgrimes#define SYSCTL_XLONG(parent, nbr, name, access, ptr, val, descr) \ 2951638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 2961638Srgrimes ptr, val, sysctl_handle_long, "LX", __DESCR(descr)) 297113858Strhodes 2981638Srgrimes#define SYSCTL_ADD_XLONG(ctx, parent, nbr, name, access, ptr, descr) \ 2991638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|CTLFLAG_MPSAFE|(access), \ 3001638Srgrimes ptr, 0, sysctl_handle_long, "LX", __DESCR(descr)) 3011638Srgrimes 3021638Srgrimes/* Oid for a quad. The pointer must be non NULL. */ 303113858Strhodes#define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \ 3041638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access), \ 3051638Srgrimes ptr, val, sysctl_handle_quad, "Q", __DESCR(descr)) 306107788Sru 3071638Srgrimes#define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \ 3081638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_QUAD|CTLFLAG_MPSAFE|(access), \ 3091638Srgrimes ptr, 0, sysctl_handle_quad, "Q", __DESCR(descr)) 3101638Srgrimes 3111638Srgrimes/* Oid for an opaque object. Specified by a pointer and a length. */ 3121638Srgrimes#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \ 3131638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 3141638Srgrimes ptr, len, sysctl_handle_opaque, fmt, descr) 3151638Srgrimes 3161638Srgrimes#define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\ 3171638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 3181638Srgrimes ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr)) 3191638Srgrimes 3201638Srgrimes/* Oid for a struct. Specified by a pointer and a type. */ 3211638Srgrimes#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \ 3221638Srgrimes SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 3231638Srgrimes ptr, sizeof(struct type), sysctl_handle_opaque, \ 3241638Srgrimes "S," #type, descr) 3251638Srgrimes 326113858Strhodes#define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \ 3271638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 328107788Sru ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr)) 3291638Srgrimes 3301638Srgrimes/* Oid for a procedure. Specified by a pointer and an arg. */ 33179727Sschweikh#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 3321638Srgrimes SYSCTL_OID(parent, nbr, name, (access), \ 333107788Sru ptr, arg, handler, fmt, descr) 3341638Srgrimes 33571895Sru#define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 3361638Srgrimes sysctl_add_oid(ctx, parent, nbr, name, (access), \ 3371638Srgrimes ptr, arg, handler, fmt, __DESCR(descr)) 3381638Srgrimes 3391638Srgrimes/* 34079727Sschweikh * A macro to generate a read-only sysctl to indicate the presense of optional 3411638Srgrimes * kernel features. 3421638Srgrimes */ 3431638Srgrimes#define FEATURE(name, desc) \ 3441638Srgrimes SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD, 0, 1, desc) 3451638Srgrimes 3461638Srgrimes#endif /* _KERNEL */ 34771895Sru 34815135Smpp/* 3491638Srgrimes * Top-level identifiers 3501638Srgrimes */ 3511638Srgrimes#define CTL_UNSPEC 0 /* unused */ 3521638Srgrimes#define CTL_KERN 1 /* "high kernel": proc, limits */ 3531638Srgrimes#define CTL_VM 2 /* virtual memory */ 3541638Srgrimes#define CTL_VFS 3 /* filesystem, mount type is next */ 355107788Sru#define CTL_NET 4 /* network, see socket.h */ 3561638Srgrimes#define CTL_DEBUG 5 /* debugging parameters */ 3571638Srgrimes#define CTL_HW 6 /* generic cpu/io */ 358113858Strhodes#define CTL_MACHDEP 7 /* machine dependent */ 3591638Srgrimes#define CTL_USER 8 /* user-level */ 3601638Srgrimes#define CTL_P1003_1B 9 /* POSIX 1003.1B */ 3611638Srgrimes#define CTL_MAXID 10 /* number of valid top-level ids */ 362107788Sru 36357731Ssheldonh#define CTL_NAMES { \ 3641638Srgrimes { 0, 0 }, \ 3651638Srgrimes { "kern", CTLTYPE_NODE }, \ 3661638Srgrimes { "vm", CTLTYPE_NODE }, \ 3671638Srgrimes { "vfs", CTLTYPE_NODE }, \ 3681638Srgrimes { "net", CTLTYPE_NODE }, \ 3691638Srgrimes { "debug", CTLTYPE_NODE }, \ 3701638Srgrimes { "hw", CTLTYPE_NODE }, \ 3711638Srgrimes { "machdep", CTLTYPE_NODE }, \ 3721638Srgrimes { "user", CTLTYPE_NODE }, \ 3731638Srgrimes { "p1003_1b", CTLTYPE_NODE }, \ 3741638Srgrimes} 3751638Srgrimes 3761638Srgrimes/* 3771638Srgrimes * CTL_KERN identifiers 3781638Srgrimes */ 3791638Srgrimes#define KERN_OSTYPE 1 /* string: system version */ 3801638Srgrimes#define KERN_OSRELEASE 2 /* string: system release */ 3811638Srgrimes#define KERN_OSREV 3 /* int: system revision */ 382107383Sru#define KERN_VERSION 4 /* string: compile time info */ 383107788Sru#define KERN_MAXVNODES 5 /* int: max vnodes */ 3841638Srgrimes#define KERN_MAXPROC 6 /* int: max processes */ 3851638Srgrimes#define KERN_MAXFILES 7 /* int: max open files */ 3861638Srgrimes#define KERN_ARGMAX 8 /* int: max arguments to exec */ 3871638Srgrimes#define KERN_SECURELVL 9 /* int: system security level */ 3881638Srgrimes#define KERN_HOSTNAME 10 /* string: hostname */ 3891638Srgrimes#define KERN_HOSTID 11 /* int: host identifier */ 390119893Sru#define KERN_CLOCKRATE 12 /* struct: struct clockrate */ 391167259Smckusick#define KERN_VNODE 13 /* struct: vnode structures */ 392167259Smckusick#define KERN_PROC 14 /* struct: process entries */ 393167259Smckusick#define KERN_FILE 15 /* struct: file entries */ 394167259Smckusick#define KERN_PROF 16 /* node: kernel profiling info */ 395167259Smckusick#define KERN_POSIX1 17 /* int: POSIX.1 version */ 396167259Smckusick#define KERN_NGROUPS 18 /* int: # of supplemental group ids */ 397167259Smckusick#define KERN_JOB_CONTROL 19 /* int: is job control available */ 398167259Smckusick#define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */ 399167259Smckusick#define KERN_BOOTTIME 21 /* struct: time kernel was booted */ 400167259Smckusick#define KERN_NISDOMAINNAME 22 /* string: YP domain name */ 401167259Smckusick#define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */ 402167259Smckusick#define KERN_OSRELDATE 24 /* int: kernel release date */ 403167259Smckusick#define KERN_NTP_PLL 25 /* node: NTP PLL control */ 404167259Smckusick#define KERN_BOOTFILE 26 /* string: name of booted kernel */ 405167259Smckusick#define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */ 406167259Smckusick#define KERN_MAXPROCPERUID 28 /* int: max processes per uid */ 407167259Smckusick#define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */ 408167259Smckusick#define KERN_IPC 30 /* node: anything related to IPC */ 409167259Smckusick#define KERN_DUMMY 31 /* unused */ 410167259Smckusick#define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */ 411237216Seadler#define KERN_USRSTACK 33 /* int: address of USRSTACK */ 412167259Smckusick#define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */ 413167259Smckusick#define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */ 414237216Seadler#define KERN_HOSTUUID 36 /* string: host UUID identifier */ 415167259Smckusick#define KERN_ARND 37 /* int: from arc4rand() */ 416167259Smckusick#define KERN_MAXID 38 /* number of valid kern ids */ 417167259Smckusick 418167259Smckusick#define CTL_KERN_NAMES { \ 419167259Smckusick { 0, 0 }, \ 420167259Smckusick { "ostype", CTLTYPE_STRING }, \ 421167259Smckusick { "osrelease", CTLTYPE_STRING }, \ 422167259Smckusick { "osrevision", CTLTYPE_INT }, \ 423167259Smckusick { "version", CTLTYPE_STRING }, \ 424167259Smckusick { "maxvnodes", CTLTYPE_INT }, \ 425167259Smckusick { "maxproc", CTLTYPE_INT }, \ 426167259Smckusick { "maxfiles", CTLTYPE_INT }, \ 427167259Smckusick { "argmax", CTLTYPE_INT }, \ 428167259Smckusick { "securelevel", CTLTYPE_INT }, \ 429167259Smckusick { "hostname", CTLTYPE_STRING }, \ 430167259Smckusick { "hostid", CTLTYPE_UINT }, \ 431167259Smckusick { "clockrate", CTLTYPE_STRUCT }, \ 432167259Smckusick { "vnode", CTLTYPE_STRUCT }, \ 433167259Smckusick { "proc", CTLTYPE_STRUCT }, \ 434167259Smckusick { "file", CTLTYPE_STRUCT }, \ 435167259Smckusick { "profiling", CTLTYPE_NODE }, \ 436167259Smckusick { "posix1version", CTLTYPE_INT }, \ 437167259Smckusick { "ngroups", CTLTYPE_INT }, \ 438167259Smckusick { "job_control", CTLTYPE_INT }, \ 439167259Smckusick { "saved_ids", CTLTYPE_INT }, \ 440167259Smckusick { "boottime", CTLTYPE_STRUCT }, \ 441167259Smckusick { "nisdomainname", CTLTYPE_STRING }, \ 442167259Smckusick { "update", CTLTYPE_INT }, \ 443167259Smckusick { "osreldate", CTLTYPE_INT }, \ 444167259Smckusick { "ntp_pll", CTLTYPE_NODE }, \ 4451638Srgrimes { "bootfile", CTLTYPE_STRING }, \ 4461638Srgrimes { "maxfilesperproc", CTLTYPE_INT }, \ 4471638Srgrimes { "maxprocperuid", CTLTYPE_INT }, \ 448107788Sru { "ipc", CTLTYPE_NODE }, \ 4491638Srgrimes { "dummy", CTLTYPE_INT }, \ 4501638Srgrimes { "ps_strings", CTLTYPE_INT }, \ 451 { "usrstack", CTLTYPE_INT }, \ 452 { "logsigexit", CTLTYPE_INT }, \ 453 { "iov_max", CTLTYPE_INT }, \ 454 { "hostuuid", CTLTYPE_STRING }, \ 455} 456 457/* 458 * CTL_VFS identifiers 459 */ 460#define CTL_VFS_NAMES { \ 461 { "vfsconf", CTLTYPE_STRUCT }, \ 462} 463 464/* 465 * KERN_PROC subtypes 466 */ 467#define KERN_PROC_ALL 0 /* everything */ 468#define KERN_PROC_PID 1 /* by process id */ 469#define KERN_PROC_PGRP 2 /* by process group id */ 470#define KERN_PROC_SESSION 3 /* by session of pid */ 471#define KERN_PROC_TTY 4 /* by controlling tty */ 472#define KERN_PROC_UID 5 /* by effective uid */ 473#define KERN_PROC_RUID 6 /* by real uid */ 474#define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */ 475#define KERN_PROC_PROC 8 /* only return procs */ 476#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 713#else /* !_KERNEL */ 714#include <sys/cdefs.h> 715 716__BEGIN_DECLS 717int sysctl(const int *, u_int, void *, size_t *, const void *, size_t); 718int sysctlbyname(const char *, void *, size_t *, const void *, size_t); 719int sysctlnametomib(const char *, int *, size_t *); 720__END_DECLS 721#endif /* _KERNEL */ 722 723#endif /* !_SYS_SYSCTL_H_ */ 724