sysctl.h revision 12131
1/* 2 * Copyright (c) 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Mike Karels at Berkeley Software Design, Inc. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)sysctl.h 8.1 (Berkeley) 6/2/93 37 * $Id: sysctl.h,v 1.27 1995/11/03 18:29:44 wollman Exp $ 38 */ 39 40#ifndef _SYS_SYSCTL_H_ 41#define _SYS_SYSCTL_H_ 42 43/* 44 * Definitions for sysctl call. The sysctl call uses a hierarchical name 45 * for objects that can be examined or modified. The name is expressed as 46 * a sequence of integers. Like a file path name, the meaning of each 47 * component depends on its place in the hierarchy. The top-level and kern 48 * identifiers are defined here, and other identifiers are defined in the 49 * respective subsystem header files. 50 */ 51 52#define CTL_MAXNAME 12 /* largest number of components supported */ 53 54/* 55 * Each subsystem defined by sysctl defines a list of variables 56 * for that subsystem. Each name is either a node with further 57 * levels defined below it, or it is a leaf of some particular 58 * type given below. Each sysctl level defines a set of name/type 59 * pairs to be used by sysctl(1) in manipulating the subsystem. 60 */ 61struct ctlname { 62 char *ctl_name; /* subsystem name */ 63 int ctl_type; /* type of name */ 64}; 65 66#define CTLTYPE 0xf /* Mask for the type */ 67#define CTLTYPE_NODE 1 /* name is a node */ 68#define CTLTYPE_INT 2 /* name describes an integer */ 69#define CTLTYPE_STRING 3 /* name describes a string */ 70#define CTLTYPE_QUAD 4 /* name describes a 64-bit number */ 71#define CTLTYPE_OPAQUE 5 /* name describes a structure */ 72#define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */ 73 74#define CTLFLAG_RD 0x80000000 /* Allow reads of variable */ 75#define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */ 76#define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR) 77#define CTLFLAG_NOLOCK 0x20000000 /* XXX Don't Lock */ 78 79#ifdef KERNEL 80#define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \ 81 void *oldp, size_t *oldlenp, void *newp, size_t newlen ) 82 83struct sysctl_oid { 84 int oid_number; 85 int oid_kind; 86 void *oid_arg1; 87 int oid_arg2; 88 char *oid_name; 89 int (*oid_handler) SYSCTL_HANDLER_ARGS; 90}; 91 92int sysctl_handle_int SYSCTL_HANDLER_ARGS; 93int sysctl_handle_string SYSCTL_HANDLER_ARGS; 94int sysctl_handle_opaque SYSCTL_HANDLER_ARGS; 95 96extern int sysctl_dummy; /* make sure all NODEs are there */ 97 98/* This is the "raw" function for a mib-oid */ 99#define SYSCTL_OID(parent, number, name, kind, arg1, arg2, handler, descr) \ 100 static const struct sysctl_oid sysctl__##parent##_##name = { \ 101 number, kind, arg1, arg2, #name, handler }; \ 102 TEXT_SET(sysctl_##parent, sysctl__##parent##_##name); 103 104/* This makes a node from which other oids can hang */ 105#define SYSCTL_NODE(parent, number, name, access, handler, descr) \ 106 extern struct linker_set sysctl_##parent##_##name; \ 107 SYSCTL_OID(parent, number, name, CTLTYPE_NODE|access, \ 108 (void*)&sysctl_##parent##_##name, 0, handler, descr); \ 109 TEXT_SET(sysctl_##parent##_##name, sysctl_dummy); 110 111/* This is a string len can be 0 to indicate '\0' termination */ 112#define SYSCTL_STRING(parent, number, name, access, arg, len, descr) \ 113 SYSCTL_OID(parent, number, name, CTLTYPE_STRING|access, \ 114 arg, len, sysctl_handle_string, descr); 115 116/* This is a integer, if ptr is NULL, val is returned */ 117#define SYSCTL_INT(parent, number, name, access, ptr, val, descr) \ 118 SYSCTL_OID(parent, number, name, CTLTYPE_INT|access, \ 119 ptr, val, sysctl_handle_int, descr); 120 121/* This is anything, specified by a pointer and a lenth */ 122#define SYSCTL_OPAQUE(parent, number, name, access, ptr, len, descr) \ 123 SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \ 124 ptr, len, sysctl_handle_opaque, descr); 125 126/* This is a struct, specified by a pointer and type */ 127#define SYSCTL_STRUCT(parent, number, name, access, ptr, type, descr) \ 128 SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \ 129 ptr, sizeof(struct type), sysctl_handle_opaque, descr); 130 131/* Needs a proc. Specify by pointer and arg */ 132#define SYSCTL_PROC(parent, number, name, access, ptr, arg, handler, descr) \ 133 SYSCTL_OID(parent, number, name, access, \ 134 ptr, arg, handler, descr); 135#endif /* KERNEL */ 136 137/* 138 * Top-level identifiers 139 */ 140#define CTL_UNSPEC 0 /* unused */ 141#define CTL_KERN 1 /* "high kernel": proc, limits */ 142#define CTL_VM 2 /* virtual memory */ 143#define CTL_FS 3 /* file system, mount type is next */ 144#define CTL_NET 4 /* network, see socket.h */ 145#define CTL_DEBUG 5 /* debugging parameters */ 146#define CTL_HW 6 /* generic cpu/io */ 147#define CTL_MACHDEP 7 /* machine dependent */ 148#define CTL_USER 8 /* user-level */ 149#define CTL_MAXID 9 /* number of valid top-level ids */ 150 151#define CTL_NAMES { \ 152 { 0, 0 }, \ 153 { "kern", CTLTYPE_NODE }, \ 154 { "vm", CTLTYPE_NODE }, \ 155 { "fs", CTLTYPE_NODE }, \ 156 { "net", CTLTYPE_NODE }, \ 157 { "debug", CTLTYPE_NODE }, \ 158 { "hw", CTLTYPE_NODE }, \ 159 { "machdep", CTLTYPE_NODE }, \ 160 { "user", CTLTYPE_NODE }, \ 161} 162 163/* 164 * CTL_KERN identifiers 165 */ 166#define KERN_OSTYPE 1 /* string: system version */ 167#define KERN_OSRELEASE 2 /* string: system release */ 168#define KERN_OSREV 3 /* int: system revision */ 169#define KERN_VERSION 4 /* string: compile time info */ 170#define KERN_MAXVNODES 5 /* int: max vnodes */ 171#define KERN_MAXPROC 6 /* int: max processes */ 172#define KERN_MAXFILES 7 /* int: max open files */ 173#define KERN_ARGMAX 8 /* int: max arguments to exec */ 174#define KERN_SECURELVL 9 /* int: system security level */ 175#define KERN_HOSTNAME 10 /* string: hostname */ 176#define KERN_HOSTID 11 /* int: host identifier */ 177#define KERN_CLOCKRATE 12 /* struct: struct clockrate */ 178#define KERN_VNODE 13 /* struct: vnode structures */ 179#define KERN_PROC 14 /* struct: process entries */ 180#define KERN_FILE 15 /* struct: file entries */ 181#define KERN_PROF 16 /* node: kernel profiling info */ 182#define KERN_POSIX1 17 /* int: POSIX.1 version */ 183#define KERN_NGROUPS 18 /* int: # of supplemental group ids */ 184#define KERN_JOB_CONTROL 19 /* int: is job control available */ 185#define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */ 186#define KERN_BOOTTIME 21 /* struct: time kernel was booted */ 187#define KERN_DOMAINNAME 22 /* string: YP domain name */ 188#define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */ 189#define KERN_OSRELDATE 24 /* int: OS release date */ 190#define KERN_NTP_PLL 25 /* node: NTP PLL control */ 191#define KERN_BOOTFILE 26 /* string: name of booted kernel */ 192#define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */ 193#define KERN_MAXPROCPERUID 28 /* int: max processes per uid */ 194#define KERN_DUMPDEV 29 /* dev_t: device to dump on */ 195#define KERN_SOMAXCONN 30 /* int: max connections in listen q */ 196#define KERN_MAXSOCKBUF 31 /* int: max size of a socket buffer */ 197#define KERN_MAXID 32 /* number of valid kern ids */ 198 199#define CTL_KERN_NAMES { \ 200 { 0, 0 }, \ 201 { "ostype", CTLTYPE_STRING }, \ 202 { "osrelease", CTLTYPE_STRING }, \ 203 { "osrevision", CTLTYPE_INT }, \ 204 { "version", CTLTYPE_STRING }, \ 205 { "maxvnodes", CTLTYPE_INT }, \ 206 { "maxproc", CTLTYPE_INT }, \ 207 { "maxfiles", CTLTYPE_INT }, \ 208 { "argmax", CTLTYPE_INT }, \ 209 { "securelevel", CTLTYPE_INT }, \ 210 { "hostname", CTLTYPE_STRING }, \ 211 { "hostid", CTLTYPE_INT }, \ 212 { "clockrate", CTLTYPE_STRUCT }, \ 213 { "vnode", CTLTYPE_STRUCT }, \ 214 { "proc", CTLTYPE_STRUCT }, \ 215 { "file", CTLTYPE_STRUCT }, \ 216 { "profiling", CTLTYPE_NODE }, \ 217 { "posix1version", CTLTYPE_INT }, \ 218 { "ngroups", CTLTYPE_INT }, \ 219 { "job_control", CTLTYPE_INT }, \ 220 { "saved_ids", CTLTYPE_INT }, \ 221 { "boottime", CTLTYPE_STRUCT }, \ 222 { "domainname", CTLTYPE_STRING }, \ 223 { "update", CTLTYPE_INT }, \ 224 { "osreldate", CTLTYPE_INT }, \ 225 { "ntp_pll", CTLTYPE_NODE }, \ 226 { "bootfile", CTLTYPE_STRING }, \ 227 { "maxfilesperproc", CTLTYPE_INT }, \ 228 { "maxprocperuid", CTLTYPE_INT }, \ 229 { "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \ 230 { "somaxconn", CTLTYPE_INT }, \ 231 { "maxsockbuf", CTLTYPE_INT }, \ 232} 233 234/* 235 * CTL_FS identifiers 236 */ 237#define FS_VFSCONF 0 /* get configured filesystems */ 238#define FS_MAXID 1 /* number of items */ 239 240#define CTL_FS_NAMES { \ 241 { "vfsconf", CTLTYPE_STRUCT }, \ 242} 243 244/* 245 * KERN_PROC subtypes 246 */ 247#define KERN_PROC_ALL 0 /* everything */ 248#define KERN_PROC_PID 1 /* by process id */ 249#define KERN_PROC_PGRP 2 /* by process group id */ 250#define KERN_PROC_SESSION 3 /* by session of pid */ 251#define KERN_PROC_TTY 4 /* by controlling tty */ 252#define KERN_PROC_UID 5 /* by effective uid */ 253#define KERN_PROC_RUID 6 /* by real uid */ 254 255/* 256 * CTL_HW identifiers 257 */ 258#define HW_MACHINE 1 /* string: machine class */ 259#define HW_MODEL 2 /* string: specific machine model */ 260#define HW_NCPU 3 /* int: number of cpus */ 261#define HW_BYTEORDER 4 /* int: machine byte order */ 262#define HW_PHYSMEM 5 /* int: total memory */ 263#define HW_USERMEM 6 /* int: non-kernel memory */ 264#define HW_PAGESIZE 7 /* int: software page size */ 265#define HW_DISKNAMES 8 /* strings: disk drive names */ 266#define HW_DISKSTATS 9 /* struct: diskstats[] */ 267#define HW_FLOATINGPT 10 /* int: has HW floating point? */ 268#define HW_DEVCONF 11 /* node: device configuration */ 269#define HW_MAXID 12 /* number of valid hw ids */ 270 271#define CTL_HW_NAMES { \ 272 { 0, 0 }, \ 273 { "machine", CTLTYPE_STRING }, \ 274 { "model", CTLTYPE_STRING }, \ 275 { "ncpu", CTLTYPE_INT }, \ 276 { "byteorder", CTLTYPE_INT }, \ 277 { "physmem", CTLTYPE_INT }, \ 278 { "usermem", CTLTYPE_INT }, \ 279 { "pagesize", CTLTYPE_INT }, \ 280 { "disknames", CTLTYPE_STRUCT }, \ 281 { "diskstats", CTLTYPE_STRUCT }, \ 282 { "floatingpoint", CTLTYPE_INT }, \ 283 { "devconf", CTLTYPE_NODE }, \ 284} 285 286/* 287 * CTL_USER definitions 288 */ 289#define USER_CS_PATH 1 /* string: _CS_PATH */ 290#define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */ 291#define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */ 292#define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */ 293#define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */ 294#define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */ 295#define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */ 296#define USER_LINE_MAX 8 /* int: LINE_MAX */ 297#define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */ 298#define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */ 299#define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */ 300#define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */ 301#define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */ 302#define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */ 303#define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */ 304#define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */ 305#define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */ 306#define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */ 307#define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */ 308#define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */ 309#define USER_MAXID 21 /* number of valid user ids */ 310 311#define CTL_USER_NAMES { \ 312 { 0, 0 }, \ 313 { "cs_path", CTLTYPE_STRING }, \ 314 { "bc_base_max", CTLTYPE_INT }, \ 315 { "bc_dim_max", CTLTYPE_INT }, \ 316 { "bc_scale_max", CTLTYPE_INT }, \ 317 { "bc_string_max", CTLTYPE_INT }, \ 318 { "coll_weights_max", CTLTYPE_INT }, \ 319 { "expr_nest_max", CTLTYPE_INT }, \ 320 { "line_max", CTLTYPE_INT }, \ 321 { "re_dup_max", CTLTYPE_INT }, \ 322 { "posix2_version", CTLTYPE_INT }, \ 323 { "posix2_c_bind", CTLTYPE_INT }, \ 324 { "posix2_c_dev", CTLTYPE_INT }, \ 325 { "posix2_char_term", CTLTYPE_INT }, \ 326 { "posix2_fort_dev", CTLTYPE_INT }, \ 327 { "posix2_fort_run", CTLTYPE_INT }, \ 328 { "posix2_localedef", CTLTYPE_INT }, \ 329 { "posix2_sw_dev", CTLTYPE_INT }, \ 330 { "posix2_upe", CTLTYPE_INT }, \ 331 { "stream_max", CTLTYPE_INT }, \ 332 { "tzname_max", CTLTYPE_INT }, \ 333} 334 335/* 336 * CTL_DEBUG definitions 337 * 338 * Second level identifier specifies which debug variable. 339 * Third level identifier specifies which stucture component. 340 */ 341#define CTL_DEBUG_NAME 0 /* string: variable name */ 342#define CTL_DEBUG_VALUE 1 /* int: variable value */ 343#define CTL_DEBUG_MAXID 20 344 345#ifdef KERNEL 346#if defined(DEBUG) || defined(DIAGNOSTIC) 347/* 348 * CTL_DEBUG variables. 349 * 350 * These are declared as separate variables so that they can be 351 * individually initialized at the location of their associated 352 * variable. The loader prevents multiple use by issuing errors 353 * if a variable is initialized in more than one place. They are 354 * aggregated into an array in debug_sysctl(), so that it can 355 * conveniently locate them when querried. If more debugging 356 * variables are added, they must also be declared here and also 357 * entered into the array. 358 */ 359struct ctldebug { 360 char *debugname; /* name of debugging variable */ 361 int *debugvar; /* pointer to debugging variable */ 362}; 363extern struct ctldebug debug0, debug1, debug2, debug3, debug4; 364extern struct ctldebug debug5, debug6, debug7, debug8, debug9; 365extern struct ctldebug debug10, debug11, debug12, debug13, debug14; 366extern struct ctldebug debug15, debug16, debug17, debug18, debug19; 367#endif /* DEBUG */ 368 369extern char cpu_model[]; 370extern char machine[]; 371extern char osrelease[]; 372extern char ostype[]; 373 374/* 375 * Internal sysctl function calling convention: 376 * 377 * (*sysctlfn)(name, namelen, oldval, oldlenp, newval, newlen, p); 378 * 379 * The name parameter points at the next component of the name to be 380 * interpreted. The namelen parameter is the number of integers in 381 * the name. 382 */ 383typedef int (sysctlfn) 384 __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *)); 385 386sysctlfn cpu_sysctl; 387sysctlfn dev_sysctl; 388sysctlfn fs_sysctl; 389sysctlfn hw_sysctl; 390sysctlfn kern_sysctl; 391sysctlfn net_sysctl; 392sysctlfn ntp_sysctl; 393sysctlfn vm_sysctl; 394 395int sysctl_int __P((void *, size_t *, void *, size_t, int *)); 396int sysctl_rdint __P((void *, size_t *, void *, int)); 397int sysctl_string __P((void *, size_t *, void *, size_t, char *, int)); 398int sysctl_rdstring __P((void *, size_t *, void *, char *)); 399int sysctl_rdstruct __P((void *, size_t *, void *, void *, int)); 400int sysctl_struct __P((void *oldp, size_t *, void *, size_t, void *, int)); 401 402int sysctl_clockrate __P((char *, size_t*)); 403int sysctl_vnode __P((char *, size_t*)); 404int sysctl_file __P((char *, size_t*)); 405int sysctl_doproc __P((int *, u_int, char *, size_t*)); 406int sysctl_doprof __P((int *, u_int, void *, size_t *, void *, size_t)); 407 408#else /* !KERNEL */ 409#include <sys/cdefs.h> 410 411__BEGIN_DECLS 412int sysctl __P((int *, u_int, void *, size_t *, void *, size_t)); 413__END_DECLS 414#endif /* KERNEL */ 415 416#endif /* !_SYS_SYSCTL_H_ */ 417