2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Mike Karels at Berkeley Software Design, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)sysctl.h 8.1 (Berkeley) 6/2/93
36 #ifndef _SYS_SYSCTL_H_
37 #define _SYS_SYSCTL_H_
39 #include <sys/queue.h>
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.
51 #define CTL_MAXNAME 24 /* largest number of components supported */
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.
61 char *ctl_name; /* subsystem name */
62 int ctl_type; /* type of name */
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 */
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 /* Default value is loaded from getenv() */
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)
99 * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
101 * Secure when the securelevel is raised to at least N.
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))
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
113 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
115 #define OID_AUTO (-1)
118 * The starting number for dynamically-assigned entries. WARNING!
119 * ALL static sysctl entries should have numbers LESS than this!
121 #define CTL_AUTO_START 0x100
124 #include <sys/linker_set.h>
126 #define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, \
127 intptr_t arg2, struct sysctl_req *req
129 /* definitions for sysctl_req 'lock' member */
130 #define REQ_UNWIRED 1
133 /* definitions for sysctl_req 'flags' member */
134 #if defined(__amd64__) || defined(__ia64__) || defined(__powerpc64__) ||\
135 (defined(__mips__) && defined(__mips_n64))
136 #define SCTL_MASK32 1 /* 32 bit emulation */
140 * This describes the access space for a sysctl request. This is needed
141 * so that we can use the interface from the kernel or from user-space.
144 struct thread *td; /* used for access checking */
145 int lock; /* wiring state */
149 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
153 int (*newfunc)(struct sysctl_req *, void *, size_t);
158 SLIST_HEAD(sysctl_oid_list, sysctl_oid);
161 * This describes one "oid" in the MIB tree. Potentially more nodes can
162 * be hidden behind it, expanded by the handler.
165 struct sysctl_oid_list oid_children;
166 struct sysctl_oid_list *oid_parent;
167 SLIST_ENTRY(sysctl_oid) oid_link;
172 const char *oid_name;
173 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
177 const char *oid_descr;
180 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
181 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
183 int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
184 int sysctl_msec_to_ticks(SYSCTL_HANDLER_ARGS);
185 int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
186 int sysctl_handle_64(SYSCTL_HANDLER_ARGS);
187 int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
188 int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
189 int sysctl_handle_counter_u64(SYSCTL_HANDLER_ARGS);
191 int sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS);
192 int sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS);
194 int sysctl_dpcpu_int(SYSCTL_HANDLER_ARGS);
195 int sysctl_dpcpu_long(SYSCTL_HANDLER_ARGS);
196 int sysctl_dpcpu_quad(SYSCTL_HANDLER_ARGS);
199 * These functions are used to add/remove an oid from the mib.
201 void sysctl_register_oid(struct sysctl_oid *oidp);
202 void sysctl_unregister_oid(struct sysctl_oid *oidp);
204 /* Declare a static oid to allow child oids to be added to it. */
205 #define SYSCTL_DECL(name) \
206 extern struct sysctl_oid sysctl__##name
208 /* Hide these in macros. */
209 #define SYSCTL_CHILDREN(oid_ptr) (&(oid_ptr)->oid_children)
210 #define SYSCTL_PARENT(oid_ptr) \
211 (((oid_ptr)->oid_parent != &sysctl__children) ? \
212 __containerof((oid_ptr)->oid_parent, struct sysctl_oid, \
213 oid_children) : (struct sysctl_oid *)NULL)
214 #define SYSCTL_STATIC_CHILDREN(oid_name) (&sysctl__##oid_name.oid_children)
216 /* === Structs and macros related to context handling. === */
218 /* All dynamically created sysctls can be tracked in a context list. */
219 struct sysctl_ctx_entry {
220 struct sysctl_oid *entry;
221 TAILQ_ENTRY(sysctl_ctx_entry) link;
224 TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
226 #define SYSCTL_NODE_CHILDREN(parent, name) \
227 sysctl__##parent##_##name.oid_children
230 * These macros provide type safety for sysctls. SYSCTL_ALLOWED_TYPES()
231 * defines a transparent union of the allowed types. SYSCTL_ASSERT_TYPE()
232 * and SYSCTL_ADD_ASSERT_TYPE() use the transparent union to assert that
233 * the pointer matches the allowed types.
235 * The allow_0 member allows a literal 0 to be passed for ptr.
237 #define SYSCTL_ALLOWED_TYPES(type, decls) \
238 union sysctl_##type { \
241 } __attribute__((__transparent_union__)); \
243 static inline void * \
244 __sysctl_assert_##type(union sysctl_##type ptr) \
250 SYSCTL_ALLOWED_TYPES(INT, int *a; );
251 SYSCTL_ALLOWED_TYPES(UINT, unsigned int *a; );
252 SYSCTL_ALLOWED_TYPES(LONG, long *a; );
253 SYSCTL_ALLOWED_TYPES(ULONG, unsigned long *a; );
254 SYSCTL_ALLOWED_TYPES(INT64, int64_t *a; long long *b; );
255 SYSCTL_ALLOWED_TYPES(UINT64, uint64_t *a; unsigned long long *b; );
258 #define SYSCTL_ADD_ASSERT_TYPE(type, ptr) \
259 __sysctl_assert_ ## type (ptr)
260 #define SYSCTL_ASSERT_TYPE(type, ptr, parent, name) \
261 _SYSCTL_ASSERT_TYPE(type, ptr, __LINE__, parent##_##name)
263 #define SYSCTL_ADD_ASSERT_TYPE(type, ptr) ptr
264 #define SYSCTL_ASSERT_TYPE(type, ptr, parent, name)
266 #define _SYSCTL_ASSERT_TYPE(t, p, l, id) \
267 __SYSCTL_ASSERT_TYPE(t, p, l, id)
268 #define __SYSCTL_ASSERT_TYPE(type, ptr, line, id) \
270 sysctl_assert_##line##_##id(void) \
272 (void)__sysctl_assert_##type(ptr); \
276 #ifndef NO_SYSCTL_DESCR
279 #define __DESCR(d) ""
282 /* This macro is only for internal use */
283 #define SYSCTL_OID_RAW(id, parent_child_head, nbr, name, kind, a1, a2, handler, fmt, descr) \
284 struct sysctl_oid id = { \
285 .oid_parent = (parent_child_head), \
286 .oid_children = SLIST_HEAD_INITIALIZER(&id.oid_children), \
287 .oid_number = (nbr), \
288 .oid_kind = (kind), \
291 .oid_name = (name), \
292 .oid_handler = (handler), \
294 .oid_descr = __DESCR(descr) \
296 DATA_SET(sysctl_set, id)
298 /* This constructs a static "raw" MIB oid. */
299 #define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
300 static SYSCTL_OID_RAW(sysctl__##parent##_##name, \
301 SYSCTL_CHILDREN(&sysctl__##parent), \
302 nbr, #name, kind, a1, a2, handler, fmt, descr)
304 /* This constructs a global "raw" MIB oid. */
305 #define SYSCTL_OID_GLOBAL(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
306 SYSCTL_OID_RAW(sysctl__##parent##_##name, \
307 SYSCTL_CHILDREN(&sysctl__##parent), \
308 nbr, #name, kind, a1, a2, handler, fmt, descr)
310 #define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
311 sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, __DESCR(descr))
313 /* This constructs a root node from which other nodes can hang. */
314 #define SYSCTL_ROOT_NODE(nbr, name, access, handler, descr) \
315 SYSCTL_OID_RAW(sysctl___##name, &sysctl__children, \
316 nbr, #name, CTLTYPE_NODE|(access), NULL, 0, \
319 /* This constructs a node from which other oids can hang. */
320 #define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
321 SYSCTL_OID_GLOBAL(parent, nbr, name, CTLTYPE_NODE|(access), \
322 NULL, 0, handler, "N", descr)
324 #define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \
325 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \
326 NULL, 0, handler, "N", __DESCR(descr))
328 #define SYSCTL_ADD_ROOT_NODE(ctx, nbr, name, access, handler, descr) \
329 sysctl_add_oid(ctx, &sysctl__children, nbr, name, \
330 CTLTYPE_NODE|(access), NULL, 0, handler, "N", __DESCR(descr))
332 /* Oid for a string. len can be 0 to indicate '\0' termination. */
333 #define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
334 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \
335 arg, len, sysctl_handle_string, "A", descr)
337 #define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
338 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access), \
339 arg, len, sysctl_handle_string, "A", __DESCR(descr))
341 /* Oid for an int. If ptr is NULL, val is returned. */
342 #define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
343 SYSCTL_ASSERT_TYPE(INT, ptr, parent, name); \
344 SYSCTL_OID(parent, nbr, name, \
345 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
346 ptr, val, sysctl_handle_int, "I", descr)
348 #define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \
349 sysctl_add_oid(ctx, parent, nbr, name, \
350 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
351 SYSCTL_ADD_ASSERT_TYPE(INT, ptr), val, \
352 sysctl_handle_int, "I", __DESCR(descr))
354 /* Oid for an unsigned int. If ptr is NULL, val is returned. */
355 #define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
356 SYSCTL_ASSERT_TYPE(UINT, ptr, parent, name); \
357 SYSCTL_OID(parent, nbr, name, \
358 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
359 ptr, val, sysctl_handle_int, "IU", descr)
361 #define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
362 sysctl_add_oid(ctx, parent, nbr, name, \
363 CTLTYPE_UINT | CTLFLAG_MPSAFE | (access), \
364 SYSCTL_ADD_ASSERT_TYPE(UINT, ptr), val, \
365 sysctl_handle_int, "IU", __DESCR(descr))
367 /* Oid for a long. The pointer must be non NULL. */
368 #define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \
369 SYSCTL_ASSERT_TYPE(LONG, ptr, parent, name); \
370 SYSCTL_OID(parent, nbr, name, \
371 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
372 ptr, val, sysctl_handle_long, "L", descr)
374 #define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \
375 sysctl_add_oid(ctx, parent, nbr, name, \
376 CTLTYPE_LONG | CTLFLAG_MPSAFE | (access), \
377 SYSCTL_ADD_ASSERT_TYPE(LONG, ptr), 0, \
378 sysctl_handle_long, "L", __DESCR(descr))
380 /* Oid for an unsigned long. The pointer must be non NULL. */
381 #define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \
382 SYSCTL_ASSERT_TYPE(ULONG, ptr, parent, name); \
383 SYSCTL_OID(parent, nbr, name, \
384 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
385 ptr, val, sysctl_handle_long, "LU", descr)
387 #define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \
388 sysctl_add_oid(ctx, parent, nbr, name, \
389 CTLTYPE_ULONG | CTLFLAG_MPSAFE | (access), \
390 SYSCTL_ADD_ASSERT_TYPE(ULONG, ptr), 0, \
391 sysctl_handle_long, "LU", __DESCR(descr))
393 /* Oid for a quad. The pointer must be non NULL. */
394 #define SYSCTL_QUAD(parent, nbr, name, access, ptr, val, descr) \
395 SYSCTL_ASSERT_TYPE(INT64, ptr, parent, name); \
396 SYSCTL_OID(parent, nbr, name, \
397 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
398 ptr, val, sysctl_handle_64, "Q", descr)
400 #define SYSCTL_ADD_QUAD(ctx, parent, nbr, name, access, ptr, descr) \
401 sysctl_add_oid(ctx, parent, nbr, name, \
402 CTLTYPE_S64 | CTLFLAG_MPSAFE | (access), \
403 SYSCTL_ADD_ASSERT_TYPE(INT64, ptr), 0, \
404 sysctl_handle_64, "Q", __DESCR(descr))
406 #define SYSCTL_UQUAD(parent, nbr, name, access, ptr, val, descr) \
407 SYSCTL_ASSERT_TYPE(UINT64, ptr, parent, name); \
408 SYSCTL_OID(parent, nbr, name, \
409 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
410 ptr, val, sysctl_handle_64, "QU", descr)
412 #define SYSCTL_ADD_UQUAD(ctx, parent, nbr, name, access, ptr, descr) \
413 sysctl_add_oid(ctx, parent, nbr, name, \
414 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
415 SYSCTL_ADD_ASSERT_TYPE(UINT64, ptr), 0, \
416 sysctl_handle_64, "QU", __DESCR(descr))
418 /* Oid for a 64-bit unsigned counter(9). The pointer must be non NULL. */
419 #define SYSCTL_COUNTER_U64(parent, nbr, name, access, ptr, descr) \
420 SYSCTL_ASSERT_TYPE(UINT64, ptr, parent, name); \
421 SYSCTL_OID(parent, nbr, name, \
422 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
423 ptr, 0, sysctl_handle_counter_u64, "QU", descr)
425 #define SYSCTL_ADD_COUNTER_U64(ctx, parent, nbr, name, access, ptr, descr)\
426 sysctl_add_oid(ctx, parent, nbr, name, \
427 CTLTYPE_U64 | CTLFLAG_MPSAFE | (access), \
428 SYSCTL_ADD_ASSERT_TYPE(UINT64, ptr), 0, \
429 sysctl_handle_counter_u64, "QU", __DESCR(descr))
431 /* Oid for an opaque object. Specified by a pointer and a length. */
432 #define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
433 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
434 ptr, len, sysctl_handle_opaque, fmt, descr)
436 #define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\
437 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
438 ptr, len, sysctl_handle_opaque, fmt, __DESCR(descr))
440 /* Oid for a struct. Specified by a pointer and a type. */
441 #define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
442 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
443 ptr, sizeof(struct type), sysctl_handle_opaque, \
446 #define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
447 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
448 ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, __DESCR(descr))
450 /* Oid for a procedure. Specified by a pointer and an arg. */
451 #define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
452 CTASSERT(((access) & CTLTYPE) != 0); \
453 SYSCTL_OID(parent, nbr, name, (access), \
454 ptr, arg, handler, fmt, descr)
456 #define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
457 sysctl_add_oid(ctx, parent, nbr, name, (access), \
458 ptr, arg, handler, fmt, __DESCR(descr))
460 /* Oid to handle limits on uma(9) zone specified by pointer. */
461 #define SYSCTL_UMA_MAX(parent, nbr, name, access, ptr, descr) \
462 SYSCTL_ASSERT_TYPE(INT, ptr, parent, name); \
463 SYSCTL_OID(parent, nbr, name, \
464 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
465 ptr, 0, sysctl_handle_uma_zone_max, "I", descr)
466 #define SYSCTL_ADD_UMA_MAX(ctx, parent, nbr, name, access, ptr, descr)\
467 sysctl_add_oid(ctx, parent, nbr, name, \
468 CTLTYPE_INT | CTLFLAG_MPSAFE | (access), \
469 SYSCTL_ADD_ASSERT_TYPE(INT, ptr), 0, \
470 sysctl_handle_uma_zone_max, "I", __DESCR(descr))
472 /* Oid to obtain current use of uma(9) zone specified by pointer. */
473 #define SYSCTL_UMA_CUR(parent, nbr, name, access, ptr, descr) \
474 SYSCTL_ASSERT_TYPE(INT, ptr, parent, name); \
475 SYSCTL_OID(parent, nbr, name, \
476 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
477 ptr, 0, sysctl_handle_uma_zone_cur, "I", descr)
478 #define SYSCTL_ADD_UMA_CUR(ctx, parent, nbr, name, access, ptr, descr) \
479 sysctl_add_oid(ctx, parent, nbr, name, \
480 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RD | (access), \
481 SYSCTL_ADD_ASSERT_TYPE(INT, ptr), 0, \
482 sysctl_handle_uma_zone_cur, "I", __DESCR(descr))
485 * A macro to generate a read-only sysctl to indicate the presense of optional
488 #define FEATURE(name, desc) \
489 SYSCTL_INT(_kern_features, OID_AUTO, name, CTLFLAG_RD | CTLFLAG_CAPRD, \
495 * Top-level identifiers
497 #define CTL_UNSPEC 0 /* unused */
498 #define CTL_KERN 1 /* "high kernel": proc, limits */
499 #define CTL_VM 2 /* virtual memory */
500 #define CTL_VFS 3 /* filesystem, mount type is next */
501 #define CTL_NET 4 /* network, see socket.h */
502 #define CTL_DEBUG 5 /* debugging parameters */
503 #define CTL_HW 6 /* generic cpu/io */
504 #define CTL_MACHDEP 7 /* machine dependent */
505 #define CTL_USER 8 /* user-level */
506 #define CTL_P1003_1B 9 /* POSIX 1003.1B */
509 * CTL_KERN identifiers
511 #define KERN_OSTYPE 1 /* string: system version */
512 #define KERN_OSRELEASE 2 /* string: system release */
513 #define KERN_OSREV 3 /* int: system revision */
514 #define KERN_VERSION 4 /* string: compile time info */
515 #define KERN_MAXVNODES 5 /* int: max vnodes */
516 #define KERN_MAXPROC 6 /* int: max processes */
517 #define KERN_MAXFILES 7 /* int: max open files */
518 #define KERN_ARGMAX 8 /* int: max arguments to exec */
519 #define KERN_SECURELVL 9 /* int: system security level */
520 #define KERN_HOSTNAME 10 /* string: hostname */
521 #define KERN_HOSTID 11 /* int: host identifier */
522 #define KERN_CLOCKRATE 12 /* struct: struct clockrate */
523 #define KERN_VNODE 13 /* struct: vnode structures */
524 #define KERN_PROC 14 /* struct: process entries */
525 #define KERN_FILE 15 /* struct: file entries */
526 #define KERN_PROF 16 /* node: kernel profiling info */
527 #define KERN_POSIX1 17 /* int: POSIX.1 version */
528 #define KERN_NGROUPS 18 /* int: # of supplemental group ids */
529 #define KERN_JOB_CONTROL 19 /* int: is job control available */
530 #define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */
531 #define KERN_BOOTTIME 21 /* struct: time kernel was booted */
532 #define KERN_NISDOMAINNAME 22 /* string: YP domain name */
533 #define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */
534 #define KERN_OSRELDATE 24 /* int: kernel release date */
535 #define KERN_NTP_PLL 25 /* node: NTP PLL control */
536 #define KERN_BOOTFILE 26 /* string: name of booted kernel */
537 #define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */
538 #define KERN_MAXPROCPERUID 28 /* int: max processes per uid */
539 #define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */
540 #define KERN_IPC 30 /* node: anything related to IPC */
541 #define KERN_DUMMY 31 /* unused */
542 #define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */
543 #define KERN_USRSTACK 33 /* int: address of USRSTACK */
544 #define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */
545 #define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */
546 #define KERN_HOSTUUID 36 /* string: host UUID identifier */
547 #define KERN_ARND 37 /* int: from arc4rand() */
551 #define KERN_PROC_ALL 0 /* everything */
552 #define KERN_PROC_PID 1 /* by process id */
553 #define KERN_PROC_PGRP 2 /* by process group id */
554 #define KERN_PROC_SESSION 3 /* by session of pid */
555 #define KERN_PROC_TTY 4 /* by controlling tty */
556 #define KERN_PROC_UID 5 /* by effective uid */
557 #define KERN_PROC_RUID 6 /* by real uid */
558 #define KERN_PROC_ARGS 7 /* get/set arguments/proctitle */
559 #define KERN_PROC_PROC 8 /* only return procs */
560 #define KERN_PROC_SV_NAME 9 /* get syscall vector name */
561 #define KERN_PROC_RGID 10 /* by real group id */
562 #define KERN_PROC_GID 11 /* by effective group id */
563 #define KERN_PROC_PATHNAME 12 /* path to executable */
564 #define KERN_PROC_OVMMAP 13 /* Old VM map entries for process */
565 #define KERN_PROC_OFILEDESC 14 /* Old file descriptors for process */
566 #define KERN_PROC_KSTACK 15 /* Kernel stacks for process */
567 #define KERN_PROC_INC_THREAD 0x10 /*
568 * modifier for pid, pgrp, tty,
569 * uid, ruid, gid, rgid and proc
570 * This effectively uses 16-31
572 #define KERN_PROC_VMMAP 32 /* VM map entries for process */
573 #define KERN_PROC_FILEDESC 33 /* File descriptors for process */
574 #define KERN_PROC_GROUPS 34 /* process groups */
575 #define KERN_PROC_ENV 35 /* get environment */
576 #define KERN_PROC_AUXV 36 /* get ELF auxiliary vector */
577 #define KERN_PROC_RLIMIT 37 /* process resource limits */
578 #define KERN_PROC_PS_STRINGS 38 /* get ps_strings location */
579 #define KERN_PROC_UMASK 39 /* process umask */
580 #define KERN_PROC_OSREL 40 /* osreldate for process binary */
581 #define KERN_PROC_SIGTRAMP 41 /* signal trampoline location */
584 * KERN_IPC identifiers
586 #define KIPC_MAXSOCKBUF 1 /* int: max size of a socket buffer */
587 #define KIPC_SOCKBUF_WASTE 2 /* int: wastage factor in sockbuf */
588 #define KIPC_SOMAXCONN 3 /* int: max length of connection q */
589 #define KIPC_MAX_LINKHDR 4 /* int: max length of link header */
590 #define KIPC_MAX_PROTOHDR 5 /* int: max length of network header */
591 #define KIPC_MAX_HDR 6 /* int: max total length of headers */
592 #define KIPC_MAX_DATALEN 7 /* int: max length of data? */
597 #define HW_MACHINE 1 /* string: machine class */
598 #define HW_MODEL 2 /* string: specific machine model */
599 #define HW_NCPU 3 /* int: number of cpus */
600 #define HW_BYTEORDER 4 /* int: machine byte order */
601 #define HW_PHYSMEM 5 /* int: total memory */
602 #define HW_USERMEM 6 /* int: non-kernel memory */
603 #define HW_PAGESIZE 7 /* int: software page size */
604 #define HW_DISKNAMES 8 /* strings: disk drive names */
605 #define HW_DISKSTATS 9 /* struct: diskstats[] */
606 #define HW_FLOATINGPT 10 /* int: has HW floating point? */
607 #define HW_MACHINE_ARCH 11 /* string: machine architecture */
608 #define HW_REALMEM 12 /* int: 'real' memory */
611 * CTL_USER definitions
613 #define USER_CS_PATH 1 /* string: _CS_PATH */
614 #define USER_BC_BASE_MAX 2 /* int: BC_BASE_MAX */
615 #define USER_BC_DIM_MAX 3 /* int: BC_DIM_MAX */
616 #define USER_BC_SCALE_MAX 4 /* int: BC_SCALE_MAX */
617 #define USER_BC_STRING_MAX 5 /* int: BC_STRING_MAX */
618 #define USER_COLL_WEIGHTS_MAX 6 /* int: COLL_WEIGHTS_MAX */
619 #define USER_EXPR_NEST_MAX 7 /* int: EXPR_NEST_MAX */
620 #define USER_LINE_MAX 8 /* int: LINE_MAX */
621 #define USER_RE_DUP_MAX 9 /* int: RE_DUP_MAX */
622 #define USER_POSIX2_VERSION 10 /* int: POSIX2_VERSION */
623 #define USER_POSIX2_C_BIND 11 /* int: POSIX2_C_BIND */
624 #define USER_POSIX2_C_DEV 12 /* int: POSIX2_C_DEV */
625 #define USER_POSIX2_CHAR_TERM 13 /* int: POSIX2_CHAR_TERM */
626 #define USER_POSIX2_FORT_DEV 14 /* int: POSIX2_FORT_DEV */
627 #define USER_POSIX2_FORT_RUN 15 /* int: POSIX2_FORT_RUN */
628 #define USER_POSIX2_LOCALEDEF 16 /* int: POSIX2_LOCALEDEF */
629 #define USER_POSIX2_SW_DEV 17 /* int: POSIX2_SW_DEV */
630 #define USER_POSIX2_UPE 18 /* int: POSIX2_UPE */
631 #define USER_STREAM_MAX 19 /* int: POSIX2_STREAM_MAX */
632 #define USER_TZNAME_MAX 20 /* int: POSIX2_TZNAME_MAX */
634 #define CTL_P1003_1B_ASYNCHRONOUS_IO 1 /* boolean */
635 #define CTL_P1003_1B_MAPPED_FILES 2 /* boolean */
636 #define CTL_P1003_1B_MEMLOCK 3 /* boolean */
637 #define CTL_P1003_1B_MEMLOCK_RANGE 4 /* boolean */
638 #define CTL_P1003_1B_MEMORY_PROTECTION 5 /* boolean */
639 #define CTL_P1003_1B_MESSAGE_PASSING 6 /* boolean */
640 #define CTL_P1003_1B_PRIORITIZED_IO 7 /* boolean */
641 #define CTL_P1003_1B_PRIORITY_SCHEDULING 8 /* boolean */
642 #define CTL_P1003_1B_REALTIME_SIGNALS 9 /* boolean */
643 #define CTL_P1003_1B_SEMAPHORES 10 /* boolean */
644 #define CTL_P1003_1B_FSYNC 11 /* boolean */
645 #define CTL_P1003_1B_SHARED_MEMORY_OBJECTS 12 /* boolean */
646 #define CTL_P1003_1B_SYNCHRONIZED_IO 13 /* boolean */
647 #define CTL_P1003_1B_TIMERS 14 /* boolean */
648 #define CTL_P1003_1B_AIO_LISTIO_MAX 15 /* int */
649 #define CTL_P1003_1B_AIO_MAX 16 /* int */
650 #define CTL_P1003_1B_AIO_PRIO_DELTA_MAX 17 /* int */
651 #define CTL_P1003_1B_DELAYTIMER_MAX 18 /* int */
652 #define CTL_P1003_1B_MQ_OPEN_MAX 19 /* int */
653 #define CTL_P1003_1B_PAGESIZE 20 /* int */
654 #define CTL_P1003_1B_RTSIG_MAX 21 /* int */
655 #define CTL_P1003_1B_SEM_NSEMS_MAX 22 /* int */
656 #define CTL_P1003_1B_SEM_VALUE_MAX 23 /* int */
657 #define CTL_P1003_1B_SIGQUEUE_MAX 24 /* int */
658 #define CTL_P1003_1B_TIMER_MAX 25 /* int */
660 #define CTL_P1003_1B_MAXID 26
665 * Declare some common oids.
667 extern struct sysctl_oid_list sysctl__children;
669 SYSCTL_DECL(_kern_features);
670 SYSCTL_DECL(_kern_ipc);
671 SYSCTL_DECL(_kern_proc);
672 SYSCTL_DECL(_kern_sched);
673 SYSCTL_DECL(_kern_sched_stats);
674 SYSCTL_DECL(_sysctl);
676 SYSCTL_DECL(_vm_stats);
677 SYSCTL_DECL(_vm_stats_misc);
681 SYSCTL_DECL(_debug_sizeof);
684 SYSCTL_DECL(_hw_bus);
685 SYSCTL_DECL(_hw_bus_devices);
686 SYSCTL_DECL(_hw_bus_info);
687 SYSCTL_DECL(_machdep);
689 SYSCTL_DECL(_compat);
690 SYSCTL_DECL(_regression);
691 SYSCTL_DECL(_security);
692 SYSCTL_DECL(_security_bsd);
694 extern char machine[];
695 extern char osrelease[];
696 extern char ostype[];
697 extern char kern_ident[];
699 /* Dynamic oid handling */
700 struct sysctl_oid *sysctl_add_oid(struct sysctl_ctx_list *clist,
701 struct sysctl_oid_list *parent, int nbr, const char *name, int kind,
702 void *arg1, intptr_t arg2, int (*handler)(SYSCTL_HANDLER_ARGS),
703 const char *fmt, const char *descr);
704 int sysctl_remove_name(struct sysctl_oid *parent, const char *name, int del,
706 void sysctl_rename_oid(struct sysctl_oid *oidp, const char *name);
707 int sysctl_move_oid(struct sysctl_oid *oidp,
708 struct sysctl_oid_list *parent);
709 int sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse);
710 int sysctl_ctx_init(struct sysctl_ctx_list *clist);
711 int sysctl_ctx_free(struct sysctl_ctx_list *clist);
712 struct sysctl_ctx_entry *sysctl_ctx_entry_add(struct sysctl_ctx_list *clist,
713 struct sysctl_oid *oidp);
714 struct sysctl_ctx_entry *sysctl_ctx_entry_find(struct sysctl_ctx_list *clist,
715 struct sysctl_oid *oidp);
716 int sysctl_ctx_entry_del(struct sysctl_ctx_list *clist,
717 struct sysctl_oid *oidp);
719 int kernel_sysctl(struct thread *td, int *name, u_int namelen, void *old,
720 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
722 int kernel_sysctlbyname(struct thread *td, char *name, void *old,
723 size_t *oldlenp, void *new, size_t newlen, size_t *retval,
725 int userland_sysctl(struct thread *td, int *name, u_int namelen, void *old,
726 size_t *oldlenp, int inkernel, void *new, size_t newlen,
727 size_t *retval, int flags);
728 int sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
729 int *nindx, struct sysctl_req *req);
730 void sysctl_lock(void);
731 void sysctl_unlock(void);
732 int sysctl_wire_old_buffer(struct sysctl_req *req, size_t len);
735 struct sbuf *sbuf_new_for_sysctl(struct sbuf *, char *, int,
736 struct sysctl_req *);
738 #include <sys/cdefs.h>
741 int sysctl(const int *, u_int, void *, size_t *, const void *, size_t);
742 int sysctlbyname(const char *, void *, size_t *, const void *, size_t);
743 int sysctlnametomib(const char *, int *, size_t *);
747 #endif /* !_SYS_SYSCTL_H_ */