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.28 1995/11/06 16:18:29 phk 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 */ 61 struct 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 83 struct 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 92 int sysctl_handle_int SYSCTL_HANDLER_ARGS; 93 int sysctl_handle_string SYSCTL_HANDLER_ARGS; 94 int sysctl_handle_opaque SYSCTL_HANDLER_ARGS; 95 96 /* This is the "raw" function for a mib-oid */ 97 #define SYSCTL_OID(parent, number, name, kind, arg1, arg2, handler, descr) \ 98 static const struct sysctl_oid sysctl__##parent##_##name = { \ 99 number, kind, arg1, arg2, #name, handler }; \ 100 TEXT_SET(sysctl_##parent, sysctl__##parent##_##name); 101 102 /* This makes a node from which other oids can hang */ 103 #define SYSCTL_NODE(parent, number, name, access, handler, descr) \ 104 extern struct linker_set sysctl_##parent##_##name; \ 105 SYSCTL_OID(parent, number, name, CTLTYPE_NODE|access, \ 106 (void*)&sysctl_##parent##_##name, 0, handler, descr); \ 107 TEXT_SET(sysctl_##parent##_##name, sysctl__##parent##_##name); 108 109 /* This is a string len can be 0 to indicate '\0' termination */ 110 #define SYSCTL_STRING(parent, number, name, access, arg, len, descr) \ 111 SYSCTL_OID(parent, number, name, CTLTYPE_STRING|access, \ 112 arg, len, sysctl_handle_string, descr); 113 114 /* This is a integer, if ptr is NULL, val is returned */ 115 #define SYSCTL_INT(parent, number, name, access, ptr, val, descr) \ 116 SYSCTL_OID(parent, number, name, CTLTYPE_INT|access, \ 117 ptr, val, sysctl_handle_int, descr); 118 119 /* This is anything, specified by a pointer and a lenth */ 120 #define SYSCTL_OPAQUE(parent, number, name, access, ptr, len, descr) \ 121 SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \ 122 ptr, len, sysctl_handle_opaque, descr); 123 124 /* This is a struct, specified by a pointer and type */ 125 #define SYSCTL_STRUCT(parent, number, name, access, ptr, type, descr) \ 126 SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \ 127 ptr, sizeof(struct type), sysctl_handle_opaque, descr); 128 129 /* Needs a proc. Specify by pointer and arg */ 130 #define SYSCTL_PROC(parent, number, name, access, ptr, arg, handler, descr) \ 131 SYSCTL_OID(parent, number, name, access, \ 132 ptr, arg, handler, descr); 133 #endif /* KERNEL */ 134 135 /* 136 * Top-level identifiers 137 */ 138 #define CTL_UNSPEC 0 /* unused */ 139 #define CTL_KERN 1 /* "high kernel": proc, limits */ 140 #define CTL_VM 2 /* virtual memory */ 141 #define CTL_FS 3 /* file system, mount type is next */ 142 #define CTL_NET 4 /* network, see socket.h */ 143 #define CTL_DEBUG 5 /* debugging parameters */ 144 #define CTL_HW 6 /* generic cpu/io */ 145 #define CTL_MACHDEP 7 /* machine dependent */ 146 #define CTL_USER 8 /* user-level */ 147 #define CTL_MAXID 9 /* number of valid top-level ids */ 148 149 #define CTL_NAMES { \ 150 { 0, 0 }, \ 151 { "kern", CTLTYPE_NODE }, \ 152 { "vm", CTLTYPE_NODE }, \ 153 { "fs", CTLTYPE_NODE }, \ 154 { "net", CTLTYPE_NODE }, \ 155 { "debug", CTLTYPE_NODE }, \ 156 { "hw", CTLTYPE_NODE }, \ 157 { "machdep", CTLTYPE_NODE }, \ 158 { "user", CTLTYPE_NODE }, \ 159 } 160 161 /* 162 * CTL_KERN identifiers 163 */ 164 #define KERN_OSTYPE 1 /* string: system version */ 165 #define KERN_OSRELEASE 2 /* string: system release */ 166 #define KERN_OSREV 3 /* int: system revision */ 167 #define KERN_VERSION 4 /* string: compile time info */ 168 #define KERN_MAXVNODES 5 /* int: max vnodes */ 169 #define KERN_MAXPROC 6 /* int: max processes */ 170 #define KERN_MAXFILES 7 /* int: max open files */ 171 #define KERN_ARGMAX 8 /* int: max arguments to exec */ 172 #define KERN_SECURELVL 9 /* int: system security level */ 173 #define KERN_HOSTNAME 10 /* string: hostname */ 174 #define KERN_HOSTID 11 /* int: host identifier */ 175 #define KERN_CLOCKRATE 12 /* struct: struct clockrate */ 176 #define KERN_VNODE 13 /* struct: vnode structures */ 177 #define KERN_PROC 14 /* struct: process entries */ 178 #define KERN_FILE 15 /* struct: file entries */ 179 #define KERN_PROF 16 /* node: kernel profiling info */ 180 #define KERN_POSIX1 17 /* int: POSIX.1 version */ 181 #define KERN_NGROUPS 18 /* int: # of supplemental group ids */ 182 #define KERN_JOB_CONTROL 19 /* int: is job control available */ 183 #define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */ 184 #define KERN_BOOTTIME 21 /* struct: time kernel was booted */ 185 #define KERN_DOMAINNAME 22 /* string: YP domain name */ 186 #define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */ 187 #define KERN_OSRELDATE 24 /* int: OS release date */ 188 #define KERN_NTP_PLL 25 /* node: NTP PLL control */ 189 #define KERN_BOOTFILE 26 /* string: name of booted kernel */ 190 #define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */ 191 #define KERN_MAXPROCPERUID 28 /* int: max processes per uid */ 192 #define KERN_DUMPDEV 29 /* dev_t: device to dump on */ 193 #define KERN_SOMAXCONN 30 /* int: max connections in listen q */ 194 #define KERN_MAXSOCKBUF 31 /* int: max size of a socket buffer */ 195 #define KERN_MAXID 32 /* number of valid kern ids */ 196 197 #define CTL_KERN_NAMES { \ 198 { 0, 0 }, \ 199 { "ostype", CTLTYPE_STRING }, \ 200 { "osrelease", CTLTYPE_STRING }, \ 201 { "osrevision", CTLTYPE_INT }, \ 202 { "version", CTLTYPE_STRING }, \ 203 { "maxvnodes", CTLTYPE_INT }, \ 204 { "maxproc", CTLTYPE_INT }, \ 205 { "maxfiles", CTLTYPE_INT }, \ 206 { "argmax", CTLTYPE_INT }, \ 207 { "securelevel", CTLTYPE_INT }, \ 208 { "hostname", CTLTYPE_STRING }, \ 209 { "hostid", CTLTYPE_INT }, \ 210 { "clockrate", CTLTYPE_STRUCT }, \ 211 { "vnode", CTLTYPE_STRUCT }, \ 212 { "proc", CTLTYPE_STRUCT }, \ 213 { "file", CTLTYPE_STRUCT }, \ 214 { "profiling", CTLTYPE_NODE }, \ 215 { "posix1version", CTLTYPE_INT }, \ 216 { "ngroups", CTLTYPE_INT }, \ 217 { "job_control", CTLTYPE_INT }, \ 218 { "saved_ids", CTLTYPE_INT }, \ 219 { "boottime", CTLTYPE_STRUCT }, \ 220 { "domainname", CTLTYPE_STRING }, \ 221 { "update", CTLTYPE_INT }, \ 222 { "osreldate", CTLTYPE_INT }, \ 223 { "ntp_pll", CTLTYPE_NODE }, \ 224 { "bootfile", CTLTYPE_STRING }, \ 225 { "maxfilesperproc", CTLTYPE_INT }, \ 226 { "maxprocperuid", CTLTYPE_INT }, \ 227 { "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \ 228 { "somaxconn", CTLTYPE_INT }, \ 229 { "maxsockbuf", CTLTYPE_INT }, \ 230 } 231 232 /* 233 * CTL_FS identifiers 234 */ 235 #define FS_VFSCONF 0 /* get configured filesystems */ 236 #define FS_MAXID 1 /* number of items */ 237 238 #define CTL_FS_NAMES { \ 239 { "vfsconf", CTLTYPE_STRUCT }, \ 240 } 241 242 /* 243 * KERN_PROC subtypes 244 */ 245 #define KERN_PROC_ALL 0 /* everything */ 246 #define KERN_PROC_PID 1 /* by process id */ 247 #define KERN_PROC_PGRP 2 /* by process group id */ 248 #define KERN_PROC_SESSION 3 /* by session of pid */ 249 #define KERN_PROC_TTY 4 /* by controlling tty */ 250 #define KERN_PROC_UID 5 /* by effective uid */ 251 #define KERN_PROC_RUID 6 /* by real uid */ 252 253 /* 254 * CTL_HW identifiers 255 */ 256 #define HW_MACHINE 1 /* string: machine class */ 257 #define HW_MODEL 2 /* string: specific machine model */ 258 #define HW_NCPU 3 /* int: number of cpus */ 259 #define HW_BYTEORDER 4 /* int: machine byte order */ 260 #define HW_PHYSMEM 5 /* int: total memory */ 261 #define HW_USERMEM 6 /* int: non-kernel memory */ 262 #define HW_PAGESIZE 7 /* int: software page size */ 263 #define HW_DISKNAMES 8 /* strings: disk drive names */ 264 #define HW_DISKSTATS 9 /* struct: diskstats[] */ 265 #define HW_FLOATINGPT 10 /* int: has HW floating point? */ 266 #define HW_DEVCONF 11 /* node: device configuration */ 267 #define HW_MAXID 12 /* number of valid hw ids */ 268 269 #define CTL_HW_NAMES { \ 270 { 0, 0 }, \ 271 { "machine", CTLTYPE_STRING }, \ 272 { "model", CTLTYPE_STRING }, \ 273 { "ncpu", CTLTYPE_INT }, \ 274 { "byteorder", CTLTYPE_INT }, \ 275 { "physmem", CTLTYPE_INT }, \ 276 { "usermem", CTLTYPE_INT }, \ 277 { "pagesize", CTLTYPE_INT }, \ 278 { "disknames", CTLTYPE_STRUCT }, \ 279 { "diskstats", CTLTYPE_STRUCT }, \ 280 { "floatingpoint", CTLTYPE_INT }, \ 281 { "devconf", CTLTYPE_NODE }, \ 282 } 283 284 /* 285 * CTL_USER definitions 286 */ 287 #define USER_CS_PATH 1 /* string: _CS_PATH */ 288 #define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */ 289 #define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */ 290 #define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */ 291 #define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */ 292 #define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */ 293 #define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */ 294 #define USER_LINE_MAX 8 /* int: LINE_MAX */ 295 #define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */ 296 #define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */ 297 #define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */ 298 #define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */ 299 #define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */ 300 #define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */ 301 #define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */ 302 #define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */ 303 #define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */ 304 #define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */ 305 #define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */ 306 #define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */ 307 #define USER_MAXID 21 /* number of valid user ids */ 308 309 #define CTL_USER_NAMES { \ 310 { 0, 0 }, \ 311 { "cs_path", CTLTYPE_STRING }, \ 312 { "bc_base_max", CTLTYPE_INT }, \ 313 { "bc_dim_max", CTLTYPE_INT }, \ 314 { "bc_scale_max", CTLTYPE_INT }, \ 315 { "bc_string_max", CTLTYPE_INT }, \ 316 { "coll_weights_max", CTLTYPE_INT }, \ 317 { "expr_nest_max", CTLTYPE_INT }, \ 318 { "line_max", CTLTYPE_INT }, \ 319 { "re_dup_max", CTLTYPE_INT }, \ 320 { "posix2_version", CTLTYPE_INT }, \ 321 { "posix2_c_bind", CTLTYPE_INT }, \ 322 { "posix2_c_dev", CTLTYPE_INT }, \ 323 { "posix2_char_term", CTLTYPE_INT }, \ 324 { "posix2_fort_dev", CTLTYPE_INT }, \ 325 { "posix2_fort_run", CTLTYPE_INT }, \ 326 { "posix2_localedef", CTLTYPE_INT }, \ 327 { "posix2_sw_dev", CTLTYPE_INT }, \ 328 { "posix2_upe", CTLTYPE_INT }, \ 329 { "stream_max", CTLTYPE_INT }, \ 330 { "tzname_max", CTLTYPE_INT }, \ 331 } 332 333 /* 334 * CTL_DEBUG definitions 335 * 336 * Second level identifier specifies which debug variable. 337 * Third level identifier specifies which stucture component. 338 */ 339 #define CTL_DEBUG_NAME 0 /* string: variable name */ 340 #define CTL_DEBUG_VALUE 1 /* int: variable value */ 341 #define CTL_DEBUG_MAXID 20 342 343 #ifdef KERNEL 344 #if defined(DEBUG) || defined(DIAGNOSTIC) 345 /* 346 * CTL_DEBUG variables. 347 * 348 * These are declared as separate variables so that they can be 349 * individually initialized at the location of their associated 350 * variable. The loader prevents multiple use by issuing errors 351 * if a variable is initialized in more than one place. They are 352 * aggregated into an array in debug_sysctl(), so that it can 353 * conveniently locate them when querried. If more debugging 354 * variables are added, they must also be declared here and also 355 * entered into the array. 356 */ 357 struct ctldebug { 358 char *debugname; /* name of debugging variable */ 359 int *debugvar; /* pointer to debugging variable */ 360 }; 361 extern struct ctldebug debug0, debug1, debug2, debug3, debug4; 362 extern struct ctldebug debug5, debug6, debug7, debug8, debug9; 363 extern struct ctldebug debug10, debug11, debug12, debug13, debug14; 364 extern struct ctldebug debug15, debug16, debug17, debug18, debug19; 365 #endif /* DEBUG */ 366 367 extern char cpu_model[]; 368 extern char machine[]; 369 extern char osrelease[]; 370 extern char ostype[]; 371 372 /* 373 * Internal sysctl function calling convention: 374 * 375 * (*sysctlfn)(name, namelen, oldval, oldlenp, newval, newlen, p); 376 * 377 * The name parameter points at the next component of the name to be 378 * interpreted. The namelen parameter is the number of integers in 379 * the name. 380 */ 381 typedef int (sysctlfn) 382 __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *)); 383 384 sysctlfn cpu_sysctl; 385 sysctlfn dev_sysctl; 386 sysctlfn fs_sysctl; 387 sysctlfn hw_sysctl; 388 sysctlfn kern_sysctl; 389 sysctlfn net_sysctl; 390 sysctlfn ntp_sysctl; 391 sysctlfn vm_sysctl; 392 393 int sysctl_int __P((void *, size_t *, void *, size_t, int *)); 394 int sysctl_rdint __P((void *, size_t *, void *, int)); 395 int sysctl_string __P((void *, size_t *, void *, size_t, char *, int)); 396 int sysctl_rdstring __P((void *, size_t *, void *, char *)); 397 int sysctl_rdstruct __P((void *, size_t *, void *, void *, int)); 398 int sysctl_struct __P((void *oldp, size_t *, void *, size_t, void *, int)); 399 400 int sysctl_clockrate __P((char *, size_t*)); 401 int sysctl_vnode __P((char *, size_t*)); 402 int sysctl_file __P((char *, size_t*)); 403 int sysctl_doproc __P((int *, u_int, char *, size_t*)); 404 int sysctl_doprof __P((int *, u_int, void *, size_t *, void *, size_t)); 405 406 #else /* !KERNEL */ 407 #include <sys/cdefs.h> 408 409 __BEGIN_DECLS 410 int sysctl __P((int *, u_int, void *, size_t *, void *, size_t)); 411 __END_DECLS 412 #endif /* KERNEL */ 413 414 #endif /* !_SYS_SYSCTL_H_ */ 415