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