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 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)sysctl.h 8.1 (Berkeley) 6/2/93 33 * $FreeBSD$ 34 */ 35 36 #ifndef _SYS_SYSCTL_H_ 37 #define _SYS_SYSCTL_H_ 38 39 #include <sys/queue.h> 40 41 struct thread; 42 /* 43 * Definitions for sysctl call. The sysctl call uses a hierarchical name 44 * for objects that can be examined or modified. The name is expressed as 45 * a sequence of integers. Like a file path name, the meaning of each 46 * component depends on its place in the hierarchy. The top-level and kern 47 * identifiers are defined here, and other identifiers are defined in the 48 * respective subsystem header files. 49 */ 50 51 #define CTL_MAXNAME 24 /* largest number of components supported */ 52 53 /* 54 * Each subsystem defined by sysctl defines a list of variables 55 * for that subsystem. Each name is either a node with further 56 * levels defined below it, or it is a leaf of some particular 57 * type given below. Each sysctl level defines a set of name/type 58 * pairs to be used by sysctl(8) in manipulating the subsystem. 59 */ 60 struct ctlname { 61 char *ctl_name; /* subsystem name */ 62 int ctl_type; /* type of name */ 63 }; 64 65 #define CTLTYPE 0xf /* Mask for the type */ 66 #define CTLTYPE_NODE 1 /* name is a node */ 67 #define CTLTYPE_INT 2 /* name describes an integer */ 68 #define CTLTYPE_STRING 3 /* name describes a string */ 69 #define CTLTYPE_QUAD 4 /* name describes a 64-bit number */ 70 #define CTLTYPE_OPAQUE 5 /* name describes a structure */ 71 #define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */ 72 #define CTLTYPE_UINT 6 /* name describes an unsigned integer */ 73 #define CTLTYPE_LONG 7 /* name describes a long */ 74 #define CTLTYPE_ULONG 8 /* name describes an unsigned long */ 75 76 #define CTLFLAG_RD 0x80000000 /* Allow reads of variable */ 77 #define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */ 78 #define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR) 79 #define CTLFLAG_NOLOCK 0x20000000 /* XXX Don't Lock */ 80 #define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */ 81 #define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */ 82 #define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */ 83 #define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */ 84 #define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */ 85 #define CTLMASK_SECURE 0x00F00000 /* Secure level */ 86 #define CTLFLAG_TUN 0x00080000 /* Tunable variable */ 87 #define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN) 88 89 /* 90 * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1. 91 * 92 * Secure when the securelevel is raised to at least N. 93 */ 94 #define CTLSHIFT_SECURE 20 95 #define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE)) 96 #define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE)) 97 #define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE)) 98 99 /* 100 * USE THIS instead of a hardwired number from the categories below 101 * to get dynamically assigned sysctl entries using the linker-set 102 * technology. This is the way nearly all new sysctl variables should 103 * be implemented. 104 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, ""); 105 */ 106 #define OID_AUTO (-1) 107 108 /* 109 * The starting number for dynamically-assigned entries. WARNING! 110 * ALL static sysctl entries should have numbers LESS than this! 111 */ 112 #define CTL_AUTO_START 0x100 113 114 #ifdef _KERNEL 115 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \ 116 struct sysctl_req *req 117 118 /* definitions for sysctl_req 'lock' member */ 119 #define REQ_UNLOCKED 0 /* not locked and not wired */ 120 #define REQ_LOCKED 1 /* locked and not wired */ 121 #define REQ_WIRED 2 /* locked and wired */ 122 123 /* definitions for sysctl_req 'flags' member */ 124 #if defined(__amd64__) || defined(__ia64__) 125 #define SCTL_MASK32 1 /* 32 bit emulation */ 126 #endif 127 128 /* 129 * This describes the access space for a sysctl request. This is needed 130 * so that we can use the interface from the kernel or from user-space. 131 */ 132 struct sysctl_req { 133 struct thread *td; /* used for access checking */ 134 int lock; /* locking/wiring state */ 135 void *oldptr; 136 size_t oldlen; 137 size_t oldidx; 138 int (*oldfunc)(struct sysctl_req *, const void *, size_t); 139 void *newptr; 140 size_t newlen; 141 size_t newidx; 142 int (*newfunc)(struct sysctl_req *, void *, size_t); 143 size_t validlen; 144 int flags; 145 }; 146 147 SLIST_HEAD(sysctl_oid_list, sysctl_oid); 148 149 /* 150 * This describes one "oid" in the MIB tree. Potentially more nodes can 151 * be hidden behind it, expanded by the handler. 152 */ 153 struct sysctl_oid { 154 struct sysctl_oid_list *oid_parent; 155 SLIST_ENTRY(sysctl_oid) oid_link; 156 int oid_number; 157 u_int oid_kind; 158 void *oid_arg1; 159 int oid_arg2; 160 const char *oid_name; 161 int (*oid_handler)(SYSCTL_HANDLER_ARGS); 162 const char *oid_fmt; 163 int oid_refcnt; 164 const char *oid_descr; 165 }; 166 167 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l) 168 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l) 169 170 int sysctl_handle_int(SYSCTL_HANDLER_ARGS); 171 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS); 172 int sysctl_handle_long(SYSCTL_HANDLER_ARGS); 173 int sysctl_handle_quad(SYSCTL_HANDLER_ARGS); 174 int sysctl_handle_intptr(SYSCTL_HANDLER_ARGS); 175 int sysctl_handle_string(SYSCTL_HANDLER_ARGS); 176 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS); 177 178 #ifdef VIMAGE 179 int sysctl_handle_v_int(SYSCTL_HANDLER_ARGS); 180 int sysctl_handle_v_string(SYSCTL_HANDLER_ARGS); 181 int sysctl_handle_v_opaque(SYSCTL_HANDLER_ARGS); 182 #endif 183 184 /* 185 * These functions are used to add/remove an oid from the mib. 186 */ 187 void sysctl_register_oid(struct sysctl_oid *oidp); 188 void sysctl_unregister_oid(struct sysctl_oid *oidp); 189 190 /* Declare a static oid to allow child oids to be added to it. */ 191 #define SYSCTL_DECL(name) \ 192 extern struct sysctl_oid_list sysctl_##name##_children 193 194 /* Hide these in macros */ 195 #define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \ 196 (oid_ptr)->oid_arg1 197 #define SYSCTL_CHILDREN_SET(oid_ptr, val) \ 198 (oid_ptr)->oid_arg1 = (val); 199 #define SYSCTL_STATIC_CHILDREN(oid_name) \ 200 (&sysctl_##oid_name##_children) 201 202 /* === Structs and macros related to context handling === */ 203 204 /* All dynamically created sysctls can be tracked in a context list. */ 205 struct sysctl_ctx_entry { 206 struct sysctl_oid *entry; 207 TAILQ_ENTRY(sysctl_ctx_entry) link; 208 }; 209 210 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry); 211 212 #define SYSCTL_NODE_CHILDREN(parent, name) \ 213 sysctl_##parent##_##name##_children 214 215 #ifndef NO_SYSCTL_DESCR 216 #define __DESCR(d) d 217 #else 218 #define __DESCR(d) "" 219 #endif 220 221 /* This constructs a "raw" MIB oid. */ 222 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 223 static struct sysctl_oid sysctl__##parent##_##name = { \ 224 &sysctl_##parent##_children, { 0 }, nbr, kind, \ 225 a1, a2, #name, handler, fmt, 0, __DESCR(descr) }; \ 226 DATA_SET(sysctl_set, sysctl__##parent##_##name) 227 228 #ifdef VIMAGE 229 #define SYSCTL_V_OID(subs, mod, parent, nbr, name, kind, a1, a2, \ 230 handler, fmt, descr) \ 231 static struct sysctl_oid sysctl__##parent##_##name = { \ 232 &sysctl_##parent##_children, { 0 }, nbr, kind, \ 233 (void *) offsetof(struct mod, _##a1), a2, #name, \ 234 handler, fmt, 0, __DESCR(descr), subs, V_MOD_##mod }; \ 235 DATA_SET(sysctl_set, sysctl__##parent##_##name) 236 #else 237 #ifdef VIMAGE_GLOBALS 238 #define SYSCTL_V_OID(subs, mod, parent, nbr, name, kind, a1, a2, \ 239 handler, fmt, descr) \ 240 SYSCTL_OID(parent, nbr, name, kind, &a1, a2, handler, fmt, descr) 241 #else 242 #define SYSCTL_V_OID(subs, mod, parent, nbr, name, kind, a1, a2, \ 243 handler, fmt, descr) \ 244 SYSCTL_OID(parent, nbr, name, kind, & mod ## _0._ ## a1, a2, \ 245 handler, fmt, descr) 246 #endif 247 #endif 248 249 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \ 250 sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr)) 251 252 /* This constructs a node from which other oids can hang. */ 253 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \ 254 struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name); \ 255 SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access), \ 256 (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, "N", descr) 257 258 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \ 259 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \ 260 0, 0, handler, "N", __DESCR(descr)) 261 262 /* Oid for a string. len can be 0 to indicate '\0' termination. */ 263 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \ 264 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \ 265 arg, len, sysctl_handle_string, "A", descr) 266 267 #ifdef VIMAGE 268 #define SYSCTL_V_STRING(subs, mod, parent, nbr, name, access, sym, len, descr) \ 269 SYSCTL_V_OID(subs, mod, parent, nbr, name, CTLTYPE_STRING|(access), \ 270 sym, len, sysctl_handle_v_string, "A", descr) 271 #else 272 #ifdef VIMAGE_GLOBALS 273 #define SYSCTL_V_STRING(subs, mod, parent, nbr, name, access, sym, len, descr) \ 274 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \ 275 &sym, len, sysctl_handle_string, "A", descr) 276 #else 277 #define SYSCTL_V_STRING(subs, mod, parent, nbr, name, access, sym, len, descr) \ 278 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \ 279 & mod ## _0._ ## sym, len, sysctl_handle_string, "A", descr) 280 #endif 281 #endif 282 283 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \ 284 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access), \ 285 arg, len, sysctl_handle_string, "A", __DESCR(descr)) 286 287 /* Oid for an int. If ptr is NULL, val is returned. */ 288 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \ 289 SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|(access), \ 290 ptr, val, sysctl_handle_int, "I", descr) 291 292 #ifdef VIMAGE 293 #define SYSCTL_V_INT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 294 SYSCTL_V_OID(subs, mod, parent, nbr, name, CTLTYPE_INT|(access), \ 295 sym, val, sysctl_handle_v_int, "I", descr) 296 #else 297 #ifdef VIMAGE_GLOBALS 298 #define SYSCTL_V_INT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 299 SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|(access), \ 300 &sym, val, sysctl_handle_int, "I", descr) 301 #else 302 #define SYSCTL_V_INT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 303 SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|(access), \ 304 & mod ## _0._ ## sym, val, sysctl_handle_int, "I", descr) 305 #endif 306 #endif 307 308 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \ 309 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_INT|(access), \ 310 ptr, val, sysctl_handle_int, "I", __DESCR(descr)) 311 312 /* Oid for an unsigned int. If ptr is NULL, val is returned. */ 313 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \ 314 SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access), \ 315 ptr, val, sysctl_handle_int, "IU", descr) 316 317 #ifdef VIMAGE 318 #define SYSCTL_V_UINT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 319 SYSCTL_V_OID(subs, mod, parent, nbr, name, CTLTYPE_UINT|(access), \ 320 sym, val, sysctl_handle_v_int, "IU", descr) 321 #else 322 #ifdef VIMAGE_GLOBALS 323 #define SYSCTL_V_UINT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 324 SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access), \ 325 &sym, val, sysctl_handle_int, "IU", descr) 326 #else 327 #define SYSCTL_V_UINT(subs, mod, parent, nbr, name, access, sym, val, descr) \ 328 SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access), \ 329 & mod ## _0._ ## sym, val, sysctl_handle_int, "IU", descr) 330 #endif 331 #endif 332 333 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 334 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|(access), \ 335 ptr, val, sysctl_handle_int, "IU", __DESCR(descr)) 336 337 #define SYSCTL_XINT(parent, nbr, name, access, ptr, val, descr) \ 338 SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access), \ 339 ptr, val, sysctl_handle_int, "IX", descr) 340 341 #define SYSCTL_ADD_XINT(ctx, parent, nbr, name, access, ptr, val, descr) \ 342 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|(access), \ 343 ptr, val, sysctl_handle_int, "IX", __DESCR(descr)) 344 345 /* Oid for a long. The pointer must be non NULL. */ 346 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \ 347 SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|(access), \ 348 ptr, val, sysctl_handle_long, "L", descr) 349 350 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \ 351 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|(access), \ 352 ptr, 0, sysctl_handle_long, "L", __DESCR(descr)) 353 354 /* Oid for an unsigned long. The pointer must be non NULL. */ 355 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \ 356 SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|(access), \ 357 ptr, val, sysctl_handle_long, "LU", __DESCR(descr)) 358 359 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \ 360 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|(access), \ 361 ptr, 0, sysctl_handle_long, "LU", __DESCR(descr)) 362 363 #define SYSCTL_XLONG(parent, nbr, name, access, ptr, val, descr) \ 364 SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|(access), \ 365 ptr, val, sysctl_handle_long, "LX", __DESCR(descr)) 366 367 #define SYSCTL_ADD_XLONG(ctx, parent, nbr, name, access, ptr, descr) \ 368 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|(access), \ 369 ptr, 0, sysctl_handle_long, "LX", __DESCR(descr)) 370 371 /* Oid for a quad. The pointer must be non NULL. */ 372 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \ 373 SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|(access), \ 374 ptr, val, sysctl_handle_quad, "Q", __DESCR(descr)) 375 376 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \ 377 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_QUAD|(access), \ 378 ptr, 0, sysctl_handle_quad, "Q", __DESCR(descr)) 379 380 /* Oid for an opaque object. Specified by a pointer and a length. */ 381 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \ 382 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 383 ptr, len, sysctl_handle_opaque, fmt, descr) 384 385 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\ 386 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 387 ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr)) 388 389 /* Oid for a struct. Specified by a pointer and a type. */ 390 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \ 391 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 392 ptr, sizeof(struct type), sysctl_handle_opaque, \ 393 "S," #type, descr) 394 395 #ifdef VIMAGE 396 #define SYSCTL_V_STRUCT(subs, mod, parent, nbr, name, access, sym, \ 397 type, descr) \ 398 SYSCTL_V_OID(subs, mod, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 399 sym, sizeof(struct type), sysctl_handle_v_opaque, \ 400 "S," #type, descr) 401 #else 402 #ifdef VIMAGE_GLOBALS 403 #define SYSCTL_V_STRUCT(subs, mod, parent, nbr, name, access, sym, \ 404 type, descr) \ 405 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 406 &sym, sizeof(struct type), sysctl_handle_opaque, \ 407 "S," #type, descr) 408 #else 409 #define SYSCTL_V_STRUCT(subs, mod, parent, nbr, name, access, sym, \ 410 type, descr) \ 411 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 412 & mod ## _0._ ## sym, sizeof(struct type), \ 413 sysctl_handle_opaque, "S," #type, descr) 414 #endif 415 #endif 416 417 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \ 418 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \ 419 ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr)) 420 421 /* Oid for a procedure. Specified by a pointer and an arg. */ 422 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 423 SYSCTL_OID(parent, nbr, name, (access), \ 424 ptr, arg, handler, fmt, descr) 425 426 #define SYSCTL_V_PROC(subs, mod, parent, nbr, name, access, sym, arg, \ 427 handler, fmt, descr) \ 428 SYSCTL_V_OID(subs, mod, parent, nbr, name, (access), \ 429 sym, arg, handler, fmt, descr) 430 431 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \ 432 sysctl_add_oid(ctx, parent, nbr, name, (access), \ 433 ptr, arg, handler, fmt, __DESCR(descr)) 434 435 /* 436 * A macro to generate a read-only sysctl to indicate the presense of optional 437 * kernel features. 438 */ 439 #define FEATURE(name, desc) \ 440 SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD, 0, 1, desc) 441 442 #endif /* _KERNEL */ 443 444 /* 445 * Top-level identifiers 446 */ 447 #define CTL_UNSPEC 0 /* unused */ 448 #define CTL_KERN 1 /* "high kernel": proc, limits */ 449 #define CTL_VM 2 /* virtual memory */ 450 #define CTL_VFS 3 /* filesystem, mount type is next */ 451 #define CTL_NET 4 /* network, see socket.h */ 452 #define CTL_DEBUG 5 /* debugging parameters */ 453 #define CTL_HW 6 /* generic cpu/io */ 454 #define CTL_MACHDEP 7 /* machine dependent */ 455 #define CTL_USER 8 /* user-level */ 456 #define CTL_P1003_1B 9 /* POSIX 1003.1B */ 457 #define CTL_MAXID 10 /* number of valid top-level ids */ 458 459 #define CTL_NAMES { \ 460 { 0, 0 }, \ 461 { "kern", CTLTYPE_NODE }, \ 462 { "vm", CTLTYPE_NODE }, \ 463 { "vfs", CTLTYPE_NODE }, \ 464 { "net", CTLTYPE_NODE }, \ 465 { "debug", CTLTYPE_NODE }, \ 466 { "hw", CTLTYPE_NODE }, \ 467 { "machdep", CTLTYPE_NODE }, \ 468 { "user", CTLTYPE_NODE }, \ 469 { "p1003_1b", CTLTYPE_NODE }, \ 470 } 471 472 /* 473 * CTL_KERN identifiers 474 */ 475 #define KERN_OSTYPE 1 /* string: system version */ 476 #define KERN_OSRELEASE 2 /* string: system release */ 477 #define KERN_OSREV 3 /* int: system revision */ 478 #define KERN_VERSION 4 /* string: compile time info */ 479 #define KERN_MAXVNODES 5 /* int: max vnodes */ 480 #define KERN_MAXPROC 6 /* int: max processes */ 481 #define KERN_MAXFILES 7 /* int: max open files */ 482 #define KERN_ARGMAX 8 /* int: max arguments to exec */ 483 #define KERN_SECURELVL 9 /* int: system security level */ 484 #define KERN_HOSTNAME 10 /* string: hostname */ 485 #define KERN_HOSTID 11 /* int: host identifier */ 486 #define KERN_CLOCKRATE 12 /* struct: struct clockrate */ 487 #define KERN_VNODE 13 /* struct: vnode structures */ 488 #define KERN_PROC 14 /* struct: process entries */ 489 #define KERN_FILE 15 /* struct: file entries */ 490 #define KERN_PROF 16 /* node: kernel profiling info */ 491 #define KERN_POSIX1 17 /* int: POSIX.1 version */ 492 #define KERN_NGROUPS 18 /* int: # of supplemental group ids */ 493 #define KERN_JOB_CONTROL 19 /* int: is job control available */ 494 #define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */ 495 #define KERN_BOOTTIME 21 /* struct: time kernel was booted */ 496 #define KERN_NISDOMAINNAME 22 /* string: YP domain name */ 497 #define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */ 498 #define KERN_OSRELDATE 24 /* int: kernel release date */ 499 #define KERN_NTP_PLL 25 /* node: NTP PLL control */ 500 #define KERN_BOOTFILE 26 /* string: name of booted kernel */ 501 #define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */ 502 #define KERN_MAXPROCPERUID 28 /* int: max processes per uid */ 503 #define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */ 504 #define KERN_IPC 30 /* node: anything related to IPC */ 505 #define KERN_DUMMY 31 /* unused */ 506 #define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */ 507 #define KERN_USRSTACK 33 /* int: address of USRSTACK */ 508 #define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */ 509 #define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */ 510 #define KERN_HOSTUUID 36 /* string: host UUID identifier */ 511 #define KERN_ARND 37 /* int: from arc4rand() */ 512 #define KERN_MAXID 38 /* number of valid kern ids */ 513 514 #define CTL_KERN_NAMES { \ 515 { 0, 0 }, \ 516 { "ostype", CTLTYPE_STRING }, \ 517 { "osrelease", CTLTYPE_STRING }, \ 518 { "osrevision", CTLTYPE_INT }, \ 519 { "version", CTLTYPE_STRING }, \ 520 { "maxvnodes", CTLTYPE_INT }, \ 521 { "maxproc", CTLTYPE_INT }, \ 522 { "maxfiles", CTLTYPE_INT }, \ 523 { "argmax", CTLTYPE_INT }, \ 524 { "securelevel", CTLTYPE_INT }, \ 525 { "hostname", CTLTYPE_STRING }, \ 526 { "hostid", CTLTYPE_UINT }, \ 527 { "clockrate", CTLTYPE_STRUCT }, \ 528 { "vnode", CTLTYPE_STRUCT }, \ 529 { "proc", CTLTYPE_STRUCT }, \ 530 { "file", CTLTYPE_STRUCT }, \ 531 { "profiling", CTLTYPE_NODE }, \ 532 { "posix1version", CTLTYPE_INT }, \ 533 { "ngroups", CTLTYPE_INT }, \ 534 { "job_control", CTLTYPE_INT }, \ 535 { "saved_ids", CTLTYPE_INT }, \ 536 { "boottime", CTLTYPE_STRUCT }, \ 537 { "nisdomainname", CTLTYPE_STRING }, \ 538 { "update", CTLTYPE_INT }, \ 539 { "osreldate", CTLTYPE_INT }, \ 540 { "ntp_pll", CTLTYPE_NODE }, \ 541 { "bootfile", CTLTYPE_STRING }, \ 542 { "maxfilesperproc", CTLTYPE_INT }, \ 543 { "maxprocperuid", CTLTYPE_INT }, \ 544 { "ipc", CTLTYPE_NODE }, \ 545 { "dummy", CTLTYPE_INT }, \ 546 { "ps_strings", CTLTYPE_INT }, \ 547 { "usrstack", CTLTYPE_INT }, \ 548 { "logsigexit", CTLTYPE_INT }, \ 549 { "iov_max", CTLTYPE_INT }, \ 550 { "hostuuid", CTLTYPE_STRING }, \ 551 } 552 553 /* 554 * CTL_VFS identifiers 555 */ 556 #define CTL_VFS_NAMES { \ 557 { "vfsconf", CTLTYPE_STRUCT }, \ 558 } 559 560 /* 561 * KERN_PROC subtypes 562 */ 563 #define KERN_PROC_ALL 0 /* everything */ 564 #define KERN_PROC_PID 1 /* by process id */ 565 #define KERN_PROC_PGRP 2 /* by process group id */ 566 #define KERN_PROC_SESSION 3 /* by session of pid */ 567 #define KERN_PROC_TTY 4 /* by controlling tty */ 568 #define KERN_PROC_UID 5 /* by effective uid */ 569 #define KERN_PROC_RUID 6 /* by real uid */ 570 #define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */ 571 #define KERN_PROC_PROC 8 /* only return procs */ 572 #define KERN_PROC_SV_NAME 9 /* get syscall vector name */ 573 #define KERN_PROC_RGID 10 /* by real group id */ 574 #define KERN_PROC_GID 11 /* by effective group id */ 575 #define KERN_PROC_PATHNAME 12 /* path to executable */ 576 #define KERN_PROC_OVMMAP 13 /* Old VM map entries for process */ 577 #define KERN_PROC_OFILEDESC 14 /* Old file descriptors for process */ 578 #define KERN_PROC_KSTACK 15 /* Kernel stacks for process */ 579 #define KERN_PROC_INC_THREAD 0x10 /* 580 * modifier for pid, pgrp, tty, 581 * uid, ruid, gid, rgid and proc 582 * This effectively uses 16-31 583 */ 584 #define KERN_PROC_VMMAP 32 /* VM map entries for process */ 585 #define KERN_PROC_FILEDESC 33 /* File descriptors for process */ 586 587 /* 588 * KERN_IPC identifiers 589 */ 590 #define KIPC_MAXSOCKBUF 1 /* int: max size of a socket buffer */ 591 #define KIPC_SOCKBUF_WASTE 2 /* int: wastage factor in sockbuf */ 592 #define KIPC_SOMAXCONN 3 /* int: max length of connection q */ 593 #define KIPC_MAX_LINKHDR 4 /* int: max length of link header */ 594 #define KIPC_MAX_PROTOHDR 5 /* int: max length of network header */ 595 #define KIPC_MAX_HDR 6 /* int: max total length of headers */ 596 #define KIPC_MAX_DATALEN 7 /* int: max length of data? */ 597 598 /* 599 * CTL_HW identifiers 600 */ 601 #define HW_MACHINE 1 /* string: machine class */ 602 #define HW_MODEL 2 /* string: specific machine model */ 603 #define HW_NCPU 3 /* int: number of cpus */ 604 #define HW_BYTEORDER 4 /* int: machine byte order */ 605 #define HW_PHYSMEM 5 /* int: total memory */ 606 #define HW_USERMEM 6 /* int: non-kernel memory */ 607 #define HW_PAGESIZE 7 /* int: software page size */ 608 #define HW_DISKNAMES 8 /* strings: disk drive names */ 609 #define HW_DISKSTATS 9 /* struct: diskstats[] */ 610 #define HW_FLOATINGPT 10 /* int: has HW floating point? */ 611 #define HW_MACHINE_ARCH 11 /* string: machine architecture */ 612 #define HW_REALMEM 12 /* int: 'real' memory */ 613 #define HW_MAXID 13 /* number of valid hw ids */ 614 615 #define CTL_HW_NAMES { \ 616 { 0, 0 }, \ 617 { "machine", CTLTYPE_STRING }, \ 618 { "model", CTLTYPE_STRING }, \ 619 { "ncpu", CTLTYPE_INT }, \ 620 { "byteorder", CTLTYPE_INT }, \ 621 { "physmem", CTLTYPE_ULONG }, \ 622 { "usermem", CTLTYPE_ULONG }, \ 623 { "pagesize", CTLTYPE_INT }, \ 624 { "disknames", CTLTYPE_STRUCT }, \ 625 { "diskstats", CTLTYPE_STRUCT }, \ 626 { "floatingpoint", CTLTYPE_INT }, \ 627 { "machine_arch", CTLTYPE_STRING }, \ 628 { "realmem", CTLTYPE_ULONG }, \ 629 } 630 631 /* 632 * CTL_USER definitions 633 */ 634 #define USER_CS_PATH 1 /* string: _CS_PATH */ 635 #define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */ 636 #define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */ 637 #define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */ 638 #define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */ 639 #define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */ 640 #define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */ 641 #define USER_LINE_MAX 8 /* int: LINE_MAX */ 642 #define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */ 643 #define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */ 644 #define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */ 645 #define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */ 646 #define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */ 647 #define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */ 648 #define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */ 649 #define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */ 650 #define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */ 651 #define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */ 652 #define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */ 653 #define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */ 654 #define USER_MAXID 21 /* number of valid user ids */ 655 656 #define CTL_USER_NAMES { \ 657 { 0, 0 }, \ 658 { "cs_path", CTLTYPE_STRING }, \ 659 { "bc_base_max", CTLTYPE_INT }, \ 660 { "bc_dim_max", CTLTYPE_INT }, \ 661 { "bc_scale_max", CTLTYPE_INT }, \ 662 { "bc_string_max", CTLTYPE_INT }, \ 663 { "coll_weights_max", CTLTYPE_INT }, \ 664 { "expr_nest_max", CTLTYPE_INT }, \ 665 { "line_max", CTLTYPE_INT }, \ 666 { "re_dup_max", CTLTYPE_INT }, \ 667 { "posix2_version", CTLTYPE_INT }, \ 668 { "posix2_c_bind", CTLTYPE_INT }, \ 669 { "posix2_c_dev", CTLTYPE_INT }, \ 670 { "posix2_char_term", CTLTYPE_INT }, \ 671 { "posix2_fort_dev", CTLTYPE_INT }, \ 672 { "posix2_fort_run", CTLTYPE_INT }, \ 673 { "posix2_localedef", CTLTYPE_INT }, \ 674 { "posix2_sw_dev", CTLTYPE_INT }, \ 675 { "posix2_upe", CTLTYPE_INT }, \ 676 { "stream_max", CTLTYPE_INT }, \ 677 { "tzname_max", CTLTYPE_INT }, \ 678 } 679 680 #define CTL_P1003_1B_ASYNCHRONOUS_IO 1 /* boolean */ 681 #define CTL_P1003_1B_MAPPED_FILES 2 /* boolean */ 682 #define CTL_P1003_1B_MEMLOCK 3 /* boolean */ 683 #define CTL_P1003_1B_MEMLOCK_RANGE 4 /* boolean */ 684 #define CTL_P1003_1B_MEMORY_PROTECTION 5 /* boolean */ 685 #define CTL_P1003_1B_MESSAGE_PASSING 6 /* boolean */ 686 #define CTL_P1003_1B_PRIORITIZED_IO 7 /* boolean */ 687 #define CTL_P1003_1B_PRIORITY_SCHEDULING 8 /* boolean */ 688 #define CTL_P1003_1B_REALTIME_SIGNALS 9 /* boolean */ 689 #define CTL_P1003_1B_SEMAPHORES 10 /* boolean */ 690 #define CTL_P1003_1B_FSYNC 11 /* boolean */ 691 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS 12 /* boolean */ 692 #define CTL_P1003_1B_SYNCHRONIZED_IO 13 /* boolean */ 693 #define CTL_P1003_1B_TIMERS 14 /* boolean */ 694 #define CTL_P1003_1B_AIO_LISTIO_MAX 15 /* int */ 695 #define CTL_P1003_1B_AIO_MAX 16 /* int */ 696 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX 17 /* int */ 697 #define CTL_P1003_1B_DELAYTIMER_MAX 18 /* int */ 698 #define CTL_P1003_1B_MQ_OPEN_MAX 19 /* int */ 699 #define CTL_P1003_1B_PAGESIZE 20 /* int */ 700 #define CTL_P1003_1B_RTSIG_MAX 21 /* int */ 701 #define CTL_P1003_1B_SEM_NSEMS_MAX 22 /* int */ 702 #define CTL_P1003_1B_SEM_VALUE_MAX 23 /* int */ 703 #define CTL_P1003_1B_SIGQUEUE_MAX 24 /* int */ 704 #define CTL_P1003_1B_TIMER_MAX 25 /* int */ 705 706 #define CTL_P1003_1B_MAXID 26 707 708 #define CTL_P1003_1B_NAMES { \ 709 { 0, 0 }, \ 710 { "asynchronous_io", CTLTYPE_INT }, \ 711 { "mapped_files", CTLTYPE_INT }, \ 712 { "memlock", CTLTYPE_INT }, \ 713 { "memlock_range", CTLTYPE_INT }, \ 714 { "memory_protection", CTLTYPE_INT }, \ 715 { "message_passing", CTLTYPE_INT }, \ 716 { "prioritized_io", CTLTYPE_INT }, \ 717 { "priority_scheduling", CTLTYPE_INT }, \ 718 { "realtime_signals", CTLTYPE_INT }, \ 719 { "semaphores", CTLTYPE_INT }, \ 720 { "fsync", CTLTYPE_INT }, \ 721 { "shared_memory_objects", CTLTYPE_INT }, \ 722 { "synchronized_io", CTLTYPE_INT }, \ 723 { "timers", CTLTYPE_INT }, \ 724 { "aio_listio_max", CTLTYPE_INT }, \ 725 { "aio_max", CTLTYPE_INT }, \ 726 { "aio_prio_delta_max", CTLTYPE_INT }, \ 727 { "delaytimer_max", CTLTYPE_INT }, \ 728 { "mq_open_max", CTLTYPE_INT }, \ 729 { "pagesize", CTLTYPE_INT }, \ 730 { "rtsig_max", CTLTYPE_INT }, \ 731 { "nsems_max", CTLTYPE_INT }, \ 732 { "sem_value_max", CTLTYPE_INT }, \ 733 { "sigqueue_max", CTLTYPE_INT }, \ 734 { "timer_max", CTLTYPE_INT }, \ 735 } 736 737 #ifdef _KERNEL 738 739 /* 740 * Declare some common oids. 741 */ 742 extern struct sysctl_oid_list sysctl__children; 743 SYSCTL_DECL(_kern); 744 SYSCTL_DECL(_kern_features); 745 SYSCTL_DECL(_kern_ipc); 746 SYSCTL_DECL(_kern_proc); 747 SYSCTL_DECL(_kern_sched); 748 SYSCTL_DECL(_kern_sched_stats); 749 SYSCTL_DECL(_sysctl); 750 SYSCTL_DECL(_vm); 751 SYSCTL_DECL(_vm_stats); 752 SYSCTL_DECL(_vm_stats_misc); 753 SYSCTL_DECL(_vfs); 754 SYSCTL_DECL(_net); 755 SYSCTL_DECL(_debug); 756 SYSCTL_DECL(_debug_sizeof); 757 SYSCTL_DECL(_hw); 758 SYSCTL_DECL(_hw_bus); 759 SYSCTL_DECL(_machdep); 760 SYSCTL_DECL(_user); 761 SYSCTL_DECL(_compat); 762 SYSCTL_DECL(_regression); 763 SYSCTL_DECL(_security); 764 SYSCTL_DECL(_security_bsd); 765 766 extern char machine[]; 767 extern char osrelease[]; 768 extern char ostype[]; 769 extern char kern_ident[]; 770 771 /* Dynamic oid handling */ 772 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist, 773 struct sysctl_oid_list *parent, int nbr, const char *name, 774 int kind, void *arg1, int arg2, 775 int (*handler) (SYSCTL_HANDLER_ARGS), 776 const char *fmt, const char *descr); 777 void sysctl_rename_oid(struct sysctl_oid *oidp, const char *name); 778 int sysctl_move_oid(struct sysctl_oid *oidp, 779 struct sysctl_oid_list *parent); 780 int sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse); 781 int sysctl_ctx_init(struct sysctl_ctx_list *clist); 782 int sysctl_ctx_free(struct sysctl_ctx_list *clist); 783 struct sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist, 784 struct sysctl_oid *oidp); 785 struct sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist, 786 struct sysctl_oid *oidp); 787 int sysctl_ctx_entry_del(struct sysctl_ctx_list *clist, 788 struct sysctl_oid *oidp); 789 790 int kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old, 791 size_t *oldlenp, void *new, size_t newlen, 792 size_t *retval, int flags); 793 int kernel_sysctlbyname(struct thread *td, char *name, 794 void *old, size_t *oldlenp, void *new, size_t newlen, 795 size_t *retval, int flags); 796 int userland_sysctl(struct thread *td, int *name, u_int namelen, void *old, 797 size_t *oldlenp, int inkernel, void *new, size_t newlen, 798 size_t *retval, int flags); 799 int sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid, 800 int *nindx, struct sysctl_req *req); 801 int sysctl_wire_old_buffer(struct sysctl_req *req, size_t len); 802 803 #else /* !_KERNEL */ 804 #include <sys/cdefs.h> 805 806 __BEGIN_DECLS 807 int sysctl(int *, u_int, void *, size_t *, void *, size_t); 808 int sysctlbyname(const char *, void *, size_t *, void *, size_t); 809 int sysctlnametomib(const char *, int *, size_t *); 810 __END_DECLS 811 #endif /* _KERNEL */ 812 813 #endif /* !_SYS_SYSCTL_H_ */ 814