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