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