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