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