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