xref: /freebsd/sys/sys/sysctl.h (revision 48991a368427cadb9cdac39581d1676c29619c52)
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  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)sysctl.h	8.1 (Berkeley) 6/2/93
37  * $Id: sysctl.h,v 1.34 1995/11/16 19:00:27 phk Exp $
38  */
39 
40 #ifndef _SYS_SYSCTL_H_
41 #define	_SYS_SYSCTL_H_
42 
43 /*
44  * Definitions for sysctl call.  The sysctl call uses a hierarchical name
45  * for objects that can be examined or modified.  The name is expressed as
46  * a sequence of integers.  Like a file path name, the meaning of each
47  * component depends on its place in the hierarchy.  The top-level and kern
48  * identifiers are defined here, and other identifiers are defined in the
49  * respective subsystem header files.
50  */
51 
52 #define CTL_MAXNAME	12	/* largest number of components supported */
53 
54 /*
55  * Each subsystem defined by sysctl defines a list of variables
56  * for that subsystem. Each name is either a node with further
57  * levels defined below it, or it is a leaf of some particular
58  * type given below. Each sysctl level defines a set of name/type
59  * pairs to be used by sysctl(1) in manipulating the subsystem.
60  */
61 struct ctlname {
62 	char	*ctl_name;	/* subsystem name */
63 	int	ctl_type;	/* type of name */
64 };
65 
66 #define CTLTYPE		0xf	/* Mask for the type */
67 #define	CTLTYPE_NODE	1	/* name is a node */
68 #define	CTLTYPE_INT	2	/* name describes an integer */
69 #define	CTLTYPE_STRING	3	/* name describes a string */
70 #define	CTLTYPE_QUAD	4	/* name describes a 64-bit number */
71 #define	CTLTYPE_OPAQUE	5	/* name describes a structure */
72 #define	CTLTYPE_STRUCT	CTLTYPE_OPAQUE	/* name describes a structure */
73 
74 #define CTLFLAG_RD	0x80000000	/* Allow reads of variable */
75 #define CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
76 #define CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
77 #define CTLFLAG_NOLOCK	0x20000000	/* XXX Don't Lock */
78 
79 #ifdef KERNEL
80 #define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \
81 	struct sysctl_req *req)
82 
83 /*
84  * This describes the access space for a sysctl request.  This is needed
85  * so that we can use the interface from the kernel or from user-space.
86  */
87 struct sysctl_req {
88 	struct proc	*p;
89 	int		lock;
90 	void		*oldptr;
91 	int		oldlen;
92 	int		oldidx;
93 	int		(*oldfunc)(struct sysctl_req *, void *, int);
94 	void		*newptr;
95 	int		newlen;
96 	int		newidx;
97 	int		(*newfunc)(struct sysctl_req *, void *, int);
98 };
99 
100 /*
101  * This describes one "oid" in the MIB tree.  Potentially more nodes can
102  * be hidden behind it, expanded by the handler.
103  */
104 struct sysctl_oid {
105 	int		oid_number;
106 	int		oid_kind;
107 	void		*oid_arg1;
108 	int		oid_arg2;
109 	char		*oid_name;
110 	int 		(*oid_handler) SYSCTL_HANDLER_ARGS;
111 };
112 
113 #define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
114 #define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
115 
116 int sysctl_handle_int SYSCTL_HANDLER_ARGS;
117 int sysctl_handle_string SYSCTL_HANDLER_ARGS;
118 int sysctl_handle_opaque SYSCTL_HANDLER_ARGS;
119 
120 /* This is the "raw" function for a mib-oid */
121 #define SYSCTL_OID(parent, number, name, kind, arg1, arg2, handler, descr) \
122 	static const struct sysctl_oid sysctl__##parent##_##name = { \
123 		number, kind, arg1, arg2, #name, handler }; \
124 	TEXT_SET(sysctl_##parent, sysctl__##parent##_##name);
125 
126 /* This makes a node from which other oids can hang */
127 #define SYSCTL_NODE(parent, number, name, access, handler, descr) \
128 	extern struct linker_set sysctl_##parent##_##name; \
129 	SYSCTL_OID(parent, number, name, CTLTYPE_NODE|access, \
130 		(void*)&sysctl_##parent##_##name, 0, handler, descr); \
131 	TEXT_SET(sysctl_##parent##_##name, sysctl__##parent##_##name);
132 
133 /* This is a string len can be 0 to indicate '\0' termination */
134 #define SYSCTL_STRING(parent, number, name, access, arg, len, descr) \
135 	SYSCTL_OID(parent, number, name, CTLTYPE_STRING|access, \
136 		arg, len, sysctl_handle_string, descr);
137 
138 /* This is a integer, if ptr is NULL, val is returned */
139 #define SYSCTL_INT(parent, number, name, access, ptr, val, descr) \
140 	SYSCTL_OID(parent, number, name, CTLTYPE_INT|access, \
141 		ptr, val, sysctl_handle_int, descr);
142 
143 /* This is anything, specified by a pointer and a lenth */
144 #define SYSCTL_OPAQUE(parent, number, name, access, ptr, len, descr) \
145 	SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \
146 		ptr, len, sysctl_handle_opaque, descr);
147 
148 /* This is a struct, specified by a pointer and type */
149 #define SYSCTL_STRUCT(parent, number, name, access, ptr, type, descr) \
150 	SYSCTL_OID(parent, number, name, CTLTYPE_OPAQUE|access, \
151 		ptr, sizeof(struct type), sysctl_handle_opaque, descr);
152 
153 /* Needs a proc.  Specify by pointer and arg */
154 #define SYSCTL_PROC(parent, number, name, access, ptr, arg, handler, descr) \
155 	SYSCTL_OID(parent, number, name, access, \
156 		ptr, arg, handler, descr);
157 #endif /* KERNEL */
158 
159 /*
160  * Top-level identifiers
161  */
162 #define	CTL_UNSPEC	0		/* unused */
163 #define	CTL_KERN	1		/* "high kernel": proc, limits */
164 #define	CTL_VM		2		/* virtual memory */
165 #define	CTL_FS		3		/* file system, mount type is next */
166 #define	CTL_NET		4		/* network, see socket.h */
167 #define	CTL_DEBUG	5		/* debugging parameters */
168 #define	CTL_HW		6		/* generic cpu/io */
169 #define	CTL_MACHDEP	7		/* machine dependent */
170 #define	CTL_USER	8		/* user-level */
171 #define	CTL_MAXID	9		/* number of valid top-level ids */
172 
173 #define CTL_NAMES { \
174 	{ 0, 0 }, \
175 	{ "kern", CTLTYPE_NODE }, \
176 	{ "vm", CTLTYPE_NODE }, \
177 	{ "fs", CTLTYPE_NODE }, \
178 	{ "net", CTLTYPE_NODE }, \
179 	{ "debug", CTLTYPE_NODE }, \
180 	{ "hw", CTLTYPE_NODE }, \
181 	{ "machdep", CTLTYPE_NODE }, \
182 	{ "user", CTLTYPE_NODE }, \
183 }
184 
185 /*
186  * CTL_KERN identifiers
187  */
188 #define	KERN_OSTYPE	 	 1	/* string: system version */
189 #define	KERN_OSRELEASE	 	 2	/* string: system release */
190 #define	KERN_OSREV	 	 3	/* int: system revision */
191 #define	KERN_VERSION	 	 4	/* string: compile time info */
192 #define	KERN_MAXVNODES	 	 5	/* int: max vnodes */
193 #define	KERN_MAXPROC	 	 6	/* int: max processes */
194 #define	KERN_MAXFILES	 	 7	/* int: max open files */
195 #define	KERN_ARGMAX	 	 8	/* int: max arguments to exec */
196 #define	KERN_SECURELVL	 	 9	/* int: system security level */
197 #define	KERN_HOSTNAME		10	/* string: hostname */
198 #define	KERN_HOSTID		11	/* int: host identifier */
199 #define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
200 #define	KERN_VNODE		13	/* struct: vnode structures */
201 #define	KERN_PROC		14	/* struct: process entries */
202 #define	KERN_FILE		15	/* struct: file entries */
203 #define	KERN_PROF		16	/* node: kernel profiling info */
204 #define	KERN_POSIX1		17	/* int: POSIX.1 version */
205 #define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
206 #define	KERN_JOB_CONTROL	19	/* int: is job control available */
207 #define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
208 #define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
209 #define KERN_DOMAINNAME		22	/* string: YP domain name */
210 #define KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
211 #define KERN_OSRELDATE		24	/* int: OS release date */
212 #define KERN_NTP_PLL		25	/* node: NTP PLL control */
213 #define	KERN_BOOTFILE		26	/* string: name of booted kernel */
214 #define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
215 #define	KERN_MAXPROCPERUID 	28	/* int: max processes per uid */
216 #define KERN_DUMPDEV		29	/* dev_t: device to dump on */
217 #define	KERN_SOMAXCONN		30	/* int: max connections in listen q */
218 #define	KERN_MAXSOCKBUF		31	/* int: max size of a socket buffer */
219 #define KERN_MAXID		32      /* number of valid kern ids */
220 
221 #define CTL_KERN_NAMES { \
222 	{ 0, 0 }, \
223 	{ "ostype", CTLTYPE_STRING }, \
224 	{ "osrelease", CTLTYPE_STRING }, \
225 	{ "osrevision", CTLTYPE_INT }, \
226 	{ "version", CTLTYPE_STRING }, \
227 	{ "maxvnodes", CTLTYPE_INT }, \
228 	{ "maxproc", CTLTYPE_INT }, \
229 	{ "maxfiles", CTLTYPE_INT }, \
230 	{ "argmax", CTLTYPE_INT }, \
231 	{ "securelevel", CTLTYPE_INT }, \
232 	{ "hostname", CTLTYPE_STRING }, \
233 	{ "hostid", CTLTYPE_INT }, \
234 	{ "clockrate", CTLTYPE_STRUCT }, \
235 	{ "vnode", CTLTYPE_STRUCT }, \
236 	{ "proc", CTLTYPE_STRUCT }, \
237 	{ "file", CTLTYPE_STRUCT }, \
238 	{ "profiling", CTLTYPE_NODE }, \
239 	{ "posix1version", CTLTYPE_INT }, \
240 	{ "ngroups", CTLTYPE_INT }, \
241 	{ "job_control", CTLTYPE_INT }, \
242 	{ "saved_ids", CTLTYPE_INT }, \
243 	{ "boottime", CTLTYPE_STRUCT }, \
244 	{ "domainname", CTLTYPE_STRING }, \
245 	{ "update", CTLTYPE_INT }, \
246 	{ "osreldate", CTLTYPE_INT }, \
247         { "ntp_pll", CTLTYPE_NODE }, \
248 	{ "bootfile", CTLTYPE_STRING }, \
249 	{ "maxfilesperproc", CTLTYPE_INT }, \
250 	{ "maxprocperuid", CTLTYPE_INT }, \
251 	{ "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \
252 	{ "somaxconn", CTLTYPE_INT }, \
253 	{ "maxsockbuf", CTLTYPE_INT }, \
254 }
255 
256 /*
257  * CTL_FS identifiers
258  */
259 #define FS_VFSCONF		0	/* get configured filesystems */
260 #define FS_MAXID		1	/* number of items */
261 
262 #define CTL_FS_NAMES { \
263 	{ "vfsconf", CTLTYPE_STRUCT }, \
264 }
265 
266 /*
267  * KERN_PROC subtypes
268  */
269 #define KERN_PROC_ALL		0	/* everything */
270 #define	KERN_PROC_PID		1	/* by process id */
271 #define	KERN_PROC_PGRP		2	/* by process group id */
272 #define	KERN_PROC_SESSION	3	/* by session of pid */
273 #define	KERN_PROC_TTY		4	/* by controlling tty */
274 #define	KERN_PROC_UID		5	/* by effective uid */
275 #define	KERN_PROC_RUID		6	/* by real uid */
276 
277 /*
278  * CTL_HW identifiers
279  */
280 #define	HW_MACHINE	 1		/* string: machine class */
281 #define	HW_MODEL	 2		/* string: specific machine model */
282 #define	HW_NCPU		 3		/* int: number of cpus */
283 #define	HW_BYTEORDER	 4		/* int: machine byte order */
284 #define	HW_PHYSMEM	 5		/* int: total memory */
285 #define	HW_USERMEM	 6		/* int: non-kernel memory */
286 #define	HW_PAGESIZE	 7		/* int: software page size */
287 #define	HW_DISKNAMES	 8		/* strings: disk drive names */
288 #define	HW_DISKSTATS	 9		/* struct: diskstats[] */
289 #define HW_FLOATINGPT	10		/* int: has HW floating point? */
290 #define HW_DEVCONF	11		/* node: device configuration */
291 #define	HW_MAXID	12		/* number of valid hw ids */
292 
293 #define CTL_HW_NAMES { \
294 	{ 0, 0 }, \
295 	{ "machine", CTLTYPE_STRING }, \
296 	{ "model", CTLTYPE_STRING }, \
297 	{ "ncpu", CTLTYPE_INT }, \
298 	{ "byteorder", CTLTYPE_INT }, \
299 	{ "physmem", CTLTYPE_INT }, \
300 	{ "usermem", CTLTYPE_INT }, \
301 	{ "pagesize", CTLTYPE_INT }, \
302 	{ "disknames", CTLTYPE_STRUCT }, \
303 	{ "diskstats", CTLTYPE_STRUCT }, \
304 	{ "floatingpoint", CTLTYPE_INT }, \
305 	{ "devconf", CTLTYPE_NODE }, \
306 }
307 
308 /*
309  * CTL_USER definitions
310  */
311 #define	USER_CS_PATH		 1	/* string: _CS_PATH */
312 #define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
313 #define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
314 #define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
315 #define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
316 #define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
317 #define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
318 #define	USER_LINE_MAX		 8	/* int: LINE_MAX */
319 #define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
320 #define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
321 #define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
322 #define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
323 #define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
324 #define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
325 #define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
326 #define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
327 #define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
328 #define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
329 #define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
330 #define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
331 #define	USER_MAXID		21	/* number of valid user ids */
332 
333 #define	CTL_USER_NAMES { \
334 	{ 0, 0 }, \
335 	{ "cs_path", CTLTYPE_STRING }, \
336 	{ "bc_base_max", CTLTYPE_INT }, \
337 	{ "bc_dim_max", CTLTYPE_INT }, \
338 	{ "bc_scale_max", CTLTYPE_INT }, \
339 	{ "bc_string_max", CTLTYPE_INT }, \
340 	{ "coll_weights_max", CTLTYPE_INT }, \
341 	{ "expr_nest_max", CTLTYPE_INT }, \
342 	{ "line_max", CTLTYPE_INT }, \
343 	{ "re_dup_max", CTLTYPE_INT }, \
344 	{ "posix2_version", CTLTYPE_INT }, \
345 	{ "posix2_c_bind", CTLTYPE_INT }, \
346 	{ "posix2_c_dev", CTLTYPE_INT }, \
347 	{ "posix2_char_term", CTLTYPE_INT }, \
348 	{ "posix2_fort_dev", CTLTYPE_INT }, \
349 	{ "posix2_fort_run", CTLTYPE_INT }, \
350 	{ "posix2_localedef", CTLTYPE_INT }, \
351 	{ "posix2_sw_dev", CTLTYPE_INT }, \
352 	{ "posix2_upe", CTLTYPE_INT }, \
353 	{ "stream_max", CTLTYPE_INT }, \
354 	{ "tzname_max", CTLTYPE_INT }, \
355 }
356 
357 #ifdef KERNEL
358 
359 extern char	cpu_model[];
360 extern char	machine[];
361 extern char	osrelease[];
362 extern char	ostype[];
363 
364 int userland_sysctl(struct proc *p, int *name, u_int namelen, void *old, size_t *oldlenp, int inkernel, void *new, size_t newlen, int *retval);
365 /*
366 int	sysctl_clockrate __P((char *, size_t*));
367 int	sysctl_file __P((char *, size_t*));
368 int	sysctl_doproc __P((int *, u_int, char *, size_t*));
369 int	sysctl_doprof __P((int *, u_int, void *, size_t *, void *, size_t));
370 */
371 
372 #else	/* !KERNEL */
373 #include <sys/cdefs.h>
374 
375 __BEGIN_DECLS
376 int	sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
377 __END_DECLS
378 #endif	/* KERNEL */
379 
380 #endif	/* !_SYS_SYSCTL_H_ */
381