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