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