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