source: trunk/src/emx/include/sys/sysctl.h@ 1915

Last change on this file since 1915 was 1915, checked in by bird, 21 years ago

FreeBSD 5.3 base.
  • Property cvs2svn:cvs-rev set to 1.1
  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 24.2 KB
Line 
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: src/sys/sys/sysctl.h,v 1.132 2004/07/28 07:08:39 kan Exp $
34 */
35
36/** @file
37 * FreeBSD 5.3
38 */
39
40#ifndef _SYS_SYSCTL_H_
41#define _SYS_SYSCTL_H_
42
43#include <sys/queue.h>
44
45struct thread;
46/*
47 * Definitions for sysctl call. The sysctl call uses a hierarchical name
48 * for objects that can be examined or modified. The name is expressed as
49 * a sequence of integers. Like a file path name, the meaning of each
50 * component depends on its place in the hierarchy. The top-level and kern
51 * identifiers are defined here, and other identifiers are defined in the
52 * respective subsystem header files.
53 */
54
55#define CTL_MAXNAME 24 /* largest number of components supported */
56
57/*
58 * Each subsystem defined by sysctl defines a list of variables
59 * for that subsystem. Each name is either a node with further
60 * levels defined below it, or it is a leaf of some particular
61 * type given below. Each sysctl level defines a set of name/type
62 * pairs to be used by sysctl(8) in manipulating the subsystem.
63 */
64struct ctlname {
65 char *ctl_name; /* subsystem name */
66 int ctl_type; /* type of name */
67};
68
69#define CTLTYPE 0xf /* Mask for the type */
70#define CTLTYPE_NODE 1 /* name is a node */
71#define CTLTYPE_INT 2 /* name describes an integer */
72#define CTLTYPE_STRING 3 /* name describes a string */
73#define CTLTYPE_QUAD 4 /* name describes a 64-bit number */
74#define CTLTYPE_OPAQUE 5 /* name describes a structure */
75#define CTLTYPE_STRUCT CTLTYPE_OPAQUE /* name describes a structure */
76#define CTLTYPE_UINT 6 /* name describes an unsigned integer */
77#define CTLTYPE_LONG 7 /* name describes a long */
78#define CTLTYPE_ULONG 8 /* name describes an unsigned long */
79
80#define CTLFLAG_RD 0x80000000 /* Allow reads of variable */
81#define CTLFLAG_WR 0x40000000 /* Allow writes to the variable */
82#define CTLFLAG_RW (CTLFLAG_RD|CTLFLAG_WR)
83#define CTLFLAG_NOLOCK 0x20000000 /* XXX Don't Lock */
84#define CTLFLAG_ANYBODY 0x10000000 /* All users can set this var */
85#define CTLFLAG_SECURE 0x08000000 /* Permit set only if securelevel<=0 */
86#define CTLFLAG_PRISON 0x04000000 /* Prisoned roots can fiddle */
87#define CTLFLAG_DYN 0x02000000 /* Dynamic oid - can be freed */
88#define CTLFLAG_SKIP 0x01000000 /* Skip this sysctl when listing */
89#define CTLMASK_SECURE 0x00F00000 /* Secure level */
90#define CTLFLAG_TUN 0x00080000 /* Tunable variable */
91#define CTLFLAG_RDTUN (CTLFLAG_RD|CTLFLAG_TUN)
92
93/*
94 * Secure level. Note that CTLFLAG_SECURE == CTLFLAG_SECURE1.
95 *
96 * Secure when the securelevel is raised to at least N.
97 */
98#define CTLSHIFT_SECURE 20
99#define CTLFLAG_SECURE1 (CTLFLAG_SECURE | (0 << CTLSHIFT_SECURE))
100#define CTLFLAG_SECURE2 (CTLFLAG_SECURE | (1 << CTLSHIFT_SECURE))
101#define CTLFLAG_SECURE3 (CTLFLAG_SECURE | (2 << CTLSHIFT_SECURE))
102
103/*
104 * USE THIS instead of a hardwired number from the categories below
105 * to get dynamically assigned sysctl entries using the linker-set
106 * technology. This is the way nearly all new sysctl variables should
107 * be implemented.
108 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
109 */
110#define OID_AUTO (-1)
111
112/*
113 * The starting number for dynamically-assigned entries. WARNING!
114 * ALL static sysctl entries should have numbers LESS than this!
115 */
116#define CTL_AUTO_START 0x100
117
118#ifdef _KERNEL
119#define SYSCTL_HANDLER_ARGS struct sysctl_oid *oidp, void *arg1, int arg2, \
120 struct sysctl_req *req
121
122/* definitions for sysctl_req 'lock' member */
123#define REQ_UNLOCKED 0 /* not locked and not wired */
124#define REQ_LOCKED 1 /* locked and not wired */
125#define REQ_WIRED 2 /* locked and wired */
126
127/*
128 * This describes the access space for a sysctl request. This is needed
129 * so that we can use the interface from the kernel or from user-space.
130 */
131struct sysctl_req {
132 struct thread *td; /* used for access checking */
133 int lock; /* locking/wiring state */
134 void *oldptr;
135 size_t oldlen;
136 size_t oldidx;
137 int (*oldfunc)(struct sysctl_req *, const void *, size_t);
138 void *newptr;
139 size_t newlen;
140 size_t newidx;
141 int (*newfunc)(struct sysctl_req *, void *, size_t);
142 size_t validlen;
143};
144
145SLIST_HEAD(sysctl_oid_list, sysctl_oid);
146
147/*
148 * This describes one "oid" in the MIB tree. Potentially more nodes can
149 * be hidden behind it, expanded by the handler.
150 */
151struct sysctl_oid {
152 struct sysctl_oid_list *oid_parent;
153 SLIST_ENTRY(sysctl_oid) oid_link;
154 int oid_number;
155 u_int oid_kind;
156 void *oid_arg1;
157 int oid_arg2;
158 const char *oid_name;
159 int (*oid_handler)(SYSCTL_HANDLER_ARGS);
160 const char *oid_fmt;
161 int oid_refcnt;
162 const char *descr;
163};
164
165#define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
166#define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
167
168int sysctl_handle_int(SYSCTL_HANDLER_ARGS);
169int sysctl_handle_long(SYSCTL_HANDLER_ARGS);
170int sysctl_handle_intptr(SYSCTL_HANDLER_ARGS);
171int sysctl_handle_string(SYSCTL_HANDLER_ARGS);
172int sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
173
174/*
175 * These functions are used to add/remove an oid from the mib.
176 */
177void sysctl_register_oid(struct sysctl_oid *oidp);
178void sysctl_unregister_oid(struct sysctl_oid *oidp);
179
180/* Declare a static oid to allow child oids to be added to it. */
181#define SYSCTL_DECL(name) \
182 extern struct sysctl_oid_list sysctl_##name##_children
183
184/* Hide these in macros */
185#define SYSCTL_CHILDREN(oid_ptr) (struct sysctl_oid_list *) \
186 (oid_ptr)->oid_arg1
187#define SYSCTL_CHILDREN_SET(oid_ptr, val) \
188 (oid_ptr)->oid_arg1 = (val);
189#define SYSCTL_STATIC_CHILDREN(oid_name) \
190 (&sysctl_##oid_name##_children)
191
192/* === Structs and macros related to context handling === */
193
194/* All dynamically created sysctls can be tracked in a context list. */
195struct sysctl_ctx_entry {
196 struct sysctl_oid *entry;
197 TAILQ_ENTRY(sysctl_ctx_entry) link;
198};
199
200TAILQ_HEAD(sysctl_ctx_list, sysctl_ctx_entry);
201
202#define SYSCTL_NODE_CHILDREN(parent, name) \
203 sysctl_##parent##_##name##_children
204
205/* This constructs a "raw" MIB oid. */
206#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
207 static struct sysctl_oid sysctl__##parent##_##name = { \
208 &sysctl_##parent##_children, { 0 }, \
209 nbr, kind, a1, a2, #name, handler, fmt, 0, descr }; \
210 DATA_SET(sysctl_set, sysctl__##parent##_##name)
211
212#define SYSCTL_ADD_OID(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
213 sysctl_add_oid(ctx, parent, nbr, name, kind, a1, a2, handler, fmt, descr)
214
215/* This constructs a node from which other oids can hang. */
216#define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
217 struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name); \
218 SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|(access), \
219 (void*)&SYSCTL_NODE_CHILDREN(parent, name), 0, handler, \
220 "N", descr)
221
222#define SYSCTL_ADD_NODE(ctx, parent, nbr, name, access, handler, descr) \
223 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_NODE|(access), \
224 0, 0, handler, "N", descr)
225
226/* Oid for a string. len can be 0 to indicate '\0' termination. */
227#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
228 SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|(access), \
229 arg, len, sysctl_handle_string, "A", descr)
230
231#define SYSCTL_ADD_STRING(ctx, parent, nbr, name, access, arg, len, descr) \
232 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_STRING|(access), \
233 arg, len, sysctl_handle_string, "A", descr)
234
235/* Oid for an int. If ptr is NULL, val is returned. */
236#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
237 SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|(access), \
238 ptr, val, sysctl_handle_int, "I", descr)
239
240#define SYSCTL_ADD_INT(ctx, parent, nbr, name, access, ptr, val, descr) \
241 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_INT|(access), \
242 ptr, val, sysctl_handle_int, "I", descr)
243
244/* Oid for an unsigned int. If ptr is NULL, val is returned. */
245#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
246 SYSCTL_OID(parent, nbr, name, CTLTYPE_UINT|(access), \
247 ptr, val, sysctl_handle_int, "IU", descr)
248
249#define SYSCTL_ADD_UINT(ctx, parent, nbr, name, access, ptr, val, descr) \
250 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_UINT|(access), \
251 ptr, val, sysctl_handle_int, "IU", descr)
252
253/* Oid for a long. The pointer must be non NULL. */
254#define SYSCTL_LONG(parent, nbr, name, access, ptr, val, descr) \
255 SYSCTL_OID(parent, nbr, name, CTLTYPE_LONG|(access), \
256 ptr, val, sysctl_handle_long, "L", descr)
257
258#define SYSCTL_ADD_LONG(ctx, parent, nbr, name, access, ptr, descr) \
259 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_LONG|(access), \
260 ptr, 0, sysctl_handle_long, "L", descr)
261
262/* Oid for an unsigned long. The pointer must be non NULL. */
263#define SYSCTL_ULONG(parent, nbr, name, access, ptr, val, descr) \
264 SYSCTL_OID(parent, nbr, name, CTLTYPE_ULONG|(access), \
265 ptr, val, sysctl_handle_long, "LU", descr)
266
267#define SYSCTL_ADD_ULONG(ctx, parent, nbr, name, access, ptr, descr) \
268 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_ULONG|(access), \
269 ptr, 0, sysctl_handle_long, "LU", descr)
270
271/* Oid for an opaque object. Specified by a pointer and a length. */
272#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
273 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
274 ptr, len, sysctl_handle_opaque, fmt, descr)
275
276#define SYSCTL_ADD_OPAQUE(ctx, parent, nbr, name, access, ptr, len, fmt, descr)\
277 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
278 ptr, len, sysctl_handle_opaque, fmt, descr)
279
280/* Oid for a struct. Specified by a pointer and a type. */
281#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
282 SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|(access), \
283 ptr, sizeof(struct type), sysctl_handle_opaque, \
284 "S," #type, descr)
285
286#define SYSCTL_ADD_STRUCT(ctx, parent, nbr, name, access, ptr, type, descr) \
287 sysctl_add_oid(ctx, parent, nbr, name, CTLTYPE_OPAQUE|(access), \
288 ptr, sizeof(struct type), sysctl_handle_opaque, "S," #type, descr)
289
290/* Oid for a procedure. Specified by a pointer and an arg. */
291#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
292 SYSCTL_OID(parent, nbr, name, (access), \
293 ptr, arg, handler, fmt, descr)
294
295#define SYSCTL_ADD_PROC(ctx, parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
296 sysctl_add_oid(ctx, parent, nbr, name, (access), \
297 ptr, arg, handler, fmt, descr)
298
299#endif /* _KERNEL */
300
301/*
302 * Top-level identifiers
303 */
304#define CTL_UNSPEC 0 /* unused */
305#define CTL_KERN 1 /* "high kernel": proc, limits */
306#define CTL_VM 2 /* virtual memory */
307#define CTL_VFS 3 /* filesystem, mount type is next */
308#define CTL_NET 4 /* network, see socket.h */
309#define CTL_DEBUG 5 /* debugging parameters */
310#define CTL_HW 6 /* generic cpu/io */
311#define CTL_MACHDEP 7 /* machine dependent */
312#define CTL_USER 8 /* user-level */
313#define CTL_P1003_1B 9 /* POSIX 1003.1B */
314#define CTL_MAXID 10 /* number of valid top-level ids */
315
316#define CTL_NAMES { \
317 { 0, 0 }, \
318 { "kern", CTLTYPE_NODE }, \
319 { "vm", CTLTYPE_NODE }, \
320 { "vfs", CTLTYPE_NODE }, \
321 { "net", CTLTYPE_NODE }, \
322 { "debug", CTLTYPE_NODE }, \
323 { "hw", CTLTYPE_NODE }, \
324 { "machdep", CTLTYPE_NODE }, \
325 { "user", CTLTYPE_NODE }, \
326 { "p1003_1b", CTLTYPE_NODE }, \
327}
328
329/*
330 * CTL_KERN identifiers
331 */
332#define KERN_OSTYPE 1 /* string: system version */
333#define KERN_OSRELEASE 2 /* string: system release */
334#define KERN_OSREV 3 /* int: system revision */
335#define KERN_VERSION 4 /* string: compile time info */
336#define KERN_MAXVNODES 5 /* int: max vnodes */
337#define KERN_MAXPROC 6 /* int: max processes */
338#define KERN_MAXFILES 7 /* int: max open files */
339#define KERN_ARGMAX 8 /* int: max arguments to exec */
340#define KERN_SECURELVL 9 /* int: system security level */
341#define KERN_HOSTNAME 10 /* string: hostname */
342#define KERN_HOSTID 11 /* int: host identifier */
343#define KERN_CLOCKRATE 12 /* struct: struct clockrate */
344#define KERN_VNODE 13 /* struct: vnode structures */
345#define KERN_PROC 14 /* struct: process entries */
346#define KERN_FILE 15 /* struct: file entries */
347#define KERN_PROF 16 /* node: kernel profiling info */
348#define KERN_POSIX1 17 /* int: POSIX.1 version */
349#define KERN_NGROUPS 18 /* int: # of supplemental group ids */
350#define KERN_JOB_CONTROL 19 /* int: is job control available */
351#define KERN_SAVED_IDS 20 /* int: saved set-user/group-ID */
352#define KERN_BOOTTIME 21 /* struct: time kernel was booted */
353#define KERN_NISDOMAINNAME 22 /* string: YP domain name */
354#define KERN_UPDATEINTERVAL 23 /* int: update process sleep time */
355#define KERN_OSRELDATE 24 /* int: kernel release date */
356#define KERN_NTP_PLL 25 /* node: NTP PLL control */
357#define KERN_BOOTFILE 26 /* string: name of booted kernel */
358#define KERN_MAXFILESPERPROC 27 /* int: max open files per proc */
359#define KERN_MAXPROCPERUID 28 /* int: max processes per uid */
360#define KERN_DUMPDEV 29 /* struct cdev *: device to dump on */
361#define KERN_IPC 30 /* node: anything related to IPC */
362#define KERN_DUMMY 31 /* unused */
363#define KERN_PS_STRINGS 32 /* int: address of PS_STRINGS */
364#define KERN_USRSTACK 33 /* int: address of USRSTACK */
365#define KERN_LOGSIGEXIT 34 /* int: do we log sigexit procs? */
366#define KERN_IOV_MAX 35 /* int: value of UIO_MAXIOV */
367#define KERN_MAXID 36 /* number of valid kern ids */
368
369#define CTL_KERN_NAMES { \
370 { 0, 0 }, \
371 { "ostype", CTLTYPE_STRING }, \
372 { "osrelease", CTLTYPE_STRING }, \
373 { "osrevision", CTLTYPE_INT }, \
374 { "version", CTLTYPE_STRING }, \
375 { "maxvnodes", CTLTYPE_INT }, \
376 { "maxproc", CTLTYPE_INT }, \
377 { "maxfiles", CTLTYPE_INT }, \
378 { "argmax", CTLTYPE_INT }, \
379 { "securelevel", CTLTYPE_INT }, \
380 { "hostname", CTLTYPE_STRING }, \
381 { "hostid", CTLTYPE_UINT }, \
382 { "clockrate", CTLTYPE_STRUCT }, \
383 { "vnode", CTLTYPE_STRUCT }, \
384 { "proc", CTLTYPE_STRUCT }, \
385 { "file", CTLTYPE_STRUCT }, \
386 { "profiling", CTLTYPE_NODE }, \
387 { "posix1version", CTLTYPE_INT }, \
388 { "ngroups", CTLTYPE_INT }, \
389 { "job_control", CTLTYPE_INT }, \
390 { "saved_ids", CTLTYPE_INT }, \
391 { "boottime", CTLTYPE_STRUCT }, \
392 { "nisdomainname", CTLTYPE_STRING }, \
393 { "update", CTLTYPE_INT }, \
394 { "osreldate", CTLTYPE_INT }, \
395 { "ntp_pll", CTLTYPE_NODE }, \
396 { "bootfile", CTLTYPE_STRING }, \
397 { "maxfilesperproc", CTLTYPE_INT }, \
398 { "maxprocperuid", CTLTYPE_INT }, \
399 { "ipc", CTLTYPE_NODE }, \
400 { "dummy", CTLTYPE_INT }, \
401 { "ps_strings", CTLTYPE_INT }, \
402 { "usrstack", CTLTYPE_INT }, \
403 { "logsigexit", CTLTYPE_INT }, \
404 { "iov_max", CTLTYPE_INT }, \
405}