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