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