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