xref: /freebsd/sys/sys/sysctl.h (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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.19 1994/11/14 13:59:09 bde Exp $
38  */
39 
40 #ifndef _SYS_SYSCTL_H_
41 #define	_SYS_SYSCTL_H_
42 
43 /*
44  * These are for the eproc structure defined below.
45  */
46 #ifndef KERNEL
47 #include <sys/time.h>
48 #include <sys/ucred.h>
49 #include <sys/proc.h>
50 #include <vm/vm.h>
51 #endif
52 
53 /*
54  * Definitions for sysctl call.  The sysctl call uses a hierarchical name
55  * for objects that can be examined or modified.  The name is expressed as
56  * a sequence of integers.  Like a file path name, the meaning of each
57  * component depends on its place in the hierarchy.  The top-level and kern
58  * identifiers are defined here, and other identifiers are defined in the
59  * respective subsystem header files.
60  */
61 
62 #define CTL_MAXNAME	12	/* largest number of components supported */
63 
64 /*
65  * Each subsystem defined by sysctl defines a list of variables
66  * for that subsystem. Each name is either a node with further
67  * levels defined below it, or it is a leaf of some particular
68  * type given below. Each sysctl level defines a set of name/type
69  * pairs to be used by sysctl(1) in manipulating the subsystem.
70  */
71 struct ctlname {
72 	char	*ctl_name;	/* subsystem name */
73 	int	ctl_type;	/* type of name */
74 };
75 #define	CTLTYPE_NODE	1	/* name is a node */
76 #define	CTLTYPE_INT	2	/* name describes an integer */
77 #define	CTLTYPE_STRING	3	/* name describes a string */
78 #define	CTLTYPE_QUAD	4	/* name describes a 64-bit number */
79 #define	CTLTYPE_STRUCT	5	/* name describes a structure */
80 
81 /*
82  * Top-level identifiers
83  */
84 #define	CTL_UNSPEC	0		/* unused */
85 #define	CTL_KERN	1		/* "high kernel": proc, limits */
86 #define	CTL_VM		2		/* virtual memory */
87 #define	CTL_FS		3		/* file system, mount type is next */
88 #define	CTL_NET		4		/* network, see socket.h */
89 #define	CTL_DEBUG	5		/* debugging parameters */
90 #define	CTL_HW		6		/* generic cpu/io */
91 #define	CTL_MACHDEP	7		/* machine dependent */
92 #define	CTL_USER	8		/* user-level */
93 #define	CTL_MAXID	9		/* number of valid top-level ids */
94 
95 #define CTL_NAMES { \
96 	{ 0, 0 }, \
97 	{ "kern", CTLTYPE_NODE }, \
98 	{ "vm", CTLTYPE_NODE }, \
99 	{ "fs", CTLTYPE_NODE }, \
100 	{ "net", CTLTYPE_NODE }, \
101 	{ "debug", CTLTYPE_NODE }, \
102 	{ "hw", CTLTYPE_NODE }, \
103 	{ "machdep", CTLTYPE_NODE }, \
104 	{ "user", CTLTYPE_NODE }, \
105 }
106 
107 /*
108  * CTL_KERN identifiers
109  */
110 #define	KERN_OSTYPE	 	 1	/* string: system version */
111 #define	KERN_OSRELEASE	 	 2	/* string: system release */
112 #define	KERN_OSREV	 	 3	/* int: system revision */
113 #define	KERN_VERSION	 	 4	/* string: compile time info */
114 #define	KERN_MAXVNODES	 	 5	/* int: max vnodes */
115 #define	KERN_MAXPROC	 	 6	/* int: max processes */
116 #define	KERN_MAXFILES	 	 7	/* int: max open files */
117 #define	KERN_ARGMAX	 	 8	/* int: max arguments to exec */
118 #define	KERN_SECURELVL	 	 9	/* int: system security level */
119 #define	KERN_HOSTNAME		10	/* string: hostname */
120 #define	KERN_HOSTID		11	/* int: host identifier */
121 #define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
122 #define	KERN_VNODE		13	/* struct: vnode structures */
123 #define	KERN_PROC		14	/* struct: process entries */
124 #define	KERN_FILE		15	/* struct: file entries */
125 #define	KERN_PROF		16	/* node: kernel profiling info */
126 #define	KERN_POSIX1		17	/* int: POSIX.1 version */
127 #define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
128 #define	KERN_JOB_CONTROL	19	/* int: is job control available */
129 #define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
130 #define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
131 #define KERN_DOMAINNAME		22	/* string: YP domain name */
132 #define KERN_UPDATEINTERVAL	23	/* int: update process sleep time */
133 #define KERN_OSRELDATE		24	/* int: OS release date */
134 #define KERN_NTP_PLL		25	/* node: NTP PLL control */
135 #define	KERN_BOOTFILE		26	/* string: name of booted kernel */
136 #define	KERN_MAXFILESPERPROC	27	/* int: max open files per proc */
137 #define	KERN_MAXPROCPERUID 	28	/* int: max processes per uid */
138 #define KERN_MAXID              29      /* number of valid kern ids */
139 
140 #define CTL_KERN_NAMES { \
141 	{ 0, 0 }, \
142 	{ "ostype", CTLTYPE_STRING }, \
143 	{ "osrelease", CTLTYPE_STRING }, \
144 	{ "osrevision", CTLTYPE_INT }, \
145 	{ "version", CTLTYPE_STRING }, \
146 	{ "maxvnodes", CTLTYPE_INT }, \
147 	{ "maxproc", CTLTYPE_INT }, \
148 	{ "maxfiles", CTLTYPE_INT }, \
149 	{ "argmax", CTLTYPE_INT }, \
150 	{ "securelevel", CTLTYPE_INT }, \
151 	{ "hostname", CTLTYPE_STRING }, \
152 	{ "hostid", CTLTYPE_INT }, \
153 	{ "clockrate", CTLTYPE_STRUCT }, \
154 	{ "vnode", CTLTYPE_STRUCT }, \
155 	{ "proc", CTLTYPE_STRUCT }, \
156 	{ "file", CTLTYPE_STRUCT }, \
157 	{ "profiling", CTLTYPE_NODE }, \
158 	{ "posix1version", CTLTYPE_INT }, \
159 	{ "ngroups", CTLTYPE_INT }, \
160 	{ "job_control", CTLTYPE_INT }, \
161 	{ "saved_ids", CTLTYPE_INT }, \
162 	{ "boottime", CTLTYPE_STRUCT }, \
163 	{ "domainname", CTLTYPE_STRING }, \
164 	{ "update", CTLTYPE_INT }, \
165 	{ "osreldate", CTLTYPE_INT }, \
166         { "ntp_pll", CTLTYPE_NODE }, \
167 	{ "bootfile", CTLTYPE_STRING }, \
168 	{ "maxfilesperproc", CTLTYPE_INT }, \
169 	{ "maxprocperuid", CTLTYPE_INT }, \
170 }
171 
172 /*
173  * CTL_FS identifiers
174  */
175 #define FS_VFSCONF		0	/* get configured filesystems */
176 #define FS_MAXID		1	/* number of items */
177 
178 #define CTL_FS_NAMES { \
179 	{ "vfsconf", CTLTYPE_STRUCT }, \
180 }
181 
182 /*
183  * KERN_PROC subtypes
184  */
185 #define KERN_PROC_ALL		0	/* everything */
186 #define	KERN_PROC_PID		1	/* by process id */
187 #define	KERN_PROC_PGRP		2	/* by process group id */
188 #define	KERN_PROC_SESSION	3	/* by session of pid */
189 #define	KERN_PROC_TTY		4	/* by controlling tty */
190 #define	KERN_PROC_UID		5	/* by effective uid */
191 #define	KERN_PROC_RUID		6	/* by real uid */
192 
193 /*
194  * KERN_PROC subtype ops return arrays of augmented proc structures:
195  */
196 struct kinfo_proc {
197 	struct	proc kp_proc;			/* proc structure */
198 	struct	eproc {
199 		struct	proc *e_paddr;		/* address of proc */
200 		struct	session *e_sess;	/* session pointer */
201 		struct	pcred e_pcred;		/* process credentials */
202 		struct	ucred e_ucred;		/* current credentials */
203 #ifdef sparc
204 		struct {
205 			segsz_t	vm_rssize;	/* resident set size */
206 			segsz_t	vm_tsize;	/* text size */
207 			segsz_t	vm_dsize;	/* data size */
208 			segsz_t	vm_ssize;	/* stack size */
209 		} e_vm;
210 #else
211 		struct	vmspace e_vm;		/* address space */
212 #endif
213 		pid_t	e_ppid;			/* parent process id */
214 		pid_t	e_pgid;			/* process group id */
215 		short	e_jobc;			/* job control counter */
216 		dev_t	e_tdev;			/* controlling tty dev */
217 		pid_t	e_tpgid;		/* tty process group id */
218 		struct	session *e_tsess;	/* tty session pointer */
219 #define	WMESGLEN	7
220 		char	e_wmesg[WMESGLEN+1];	/* wchan message */
221 		segsz_t e_xsize;		/* text size */
222 		short	e_xrssize;		/* text rss */
223 		short	e_xccount;		/* text references */
224 		short	e_xswrss;
225 		long	e_flag;
226 #define	EPROC_CTTY	0x01	/* controlling tty vnode active */
227 #define	EPROC_SLEADER	0x02	/* session leader */
228 		char	e_login[MAXLOGNAME];	/* setlogin() name */
229 		long	e_spare[4];
230 	} kp_eproc;
231 };
232 
233 /*
234  * CTL_HW identifiers
235  */
236 #define	HW_MACHINE	 1		/* string: machine class */
237 #define	HW_MODEL	 2		/* string: specific machine model */
238 #define	HW_NCPU		 3		/* int: number of cpus */
239 #define	HW_BYTEORDER	 4		/* int: machine byte order */
240 #define	HW_PHYSMEM	 5		/* int: total memory */
241 #define	HW_USERMEM	 6		/* int: non-kernel memory */
242 #define	HW_PAGESIZE	 7		/* int: software page size */
243 #define	HW_DISKNAMES	 8		/* strings: disk drive names */
244 #define	HW_DISKSTATS	 9		/* struct: diskstats[] */
245 #define HW_FLOATINGPT	10		/* int: has HW floating point? */
246 #define HW_DEVCONF	11		/* node: device configuration */
247 #define	HW_MAXID	12		/* number of valid hw ids */
248 
249 #define CTL_HW_NAMES { \
250 	{ 0, 0 }, \
251 	{ "machine", CTLTYPE_STRING }, \
252 	{ "model", CTLTYPE_STRING }, \
253 	{ "ncpu", CTLTYPE_INT }, \
254 	{ "byteorder", CTLTYPE_INT }, \
255 	{ "physmem", CTLTYPE_INT }, \
256 	{ "usermem", CTLTYPE_INT }, \
257 	{ "pagesize", CTLTYPE_INT }, \
258 	{ "disknames", CTLTYPE_STRUCT }, \
259 	{ "diskstats", CTLTYPE_STRUCT }, \
260 	{ "floatingpoint", CTLTYPE_INT }, \
261 	{ "devconf", CTLTYPE_NODE }, \
262 }
263 
264 /*
265  * CTL_USER definitions
266  */
267 #define	USER_CS_PATH		 1	/* string: _CS_PATH */
268 #define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
269 #define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
270 #define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
271 #define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
272 #define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
273 #define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
274 #define	USER_LINE_MAX		 8	/* int: LINE_MAX */
275 #define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
276 #define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
277 #define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
278 #define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
279 #define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
280 #define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
281 #define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
282 #define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
283 #define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
284 #define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
285 #define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
286 #define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
287 #define	USER_MAXID		21	/* number of valid user ids */
288 
289 #define	CTL_USER_NAMES { \
290 	{ 0, 0 }, \
291 	{ "cs_path", CTLTYPE_STRING }, \
292 	{ "bc_base_max", CTLTYPE_INT }, \
293 	{ "bc_dim_max", CTLTYPE_INT }, \
294 	{ "bc_scale_max", CTLTYPE_INT }, \
295 	{ "bc_string_max", CTLTYPE_INT }, \
296 	{ "coll_weights_max", CTLTYPE_INT }, \
297 	{ "expr_nest_max", CTLTYPE_INT }, \
298 	{ "line_max", CTLTYPE_INT }, \
299 	{ "re_dup_max", CTLTYPE_INT }, \
300 	{ "posix2_version", CTLTYPE_INT }, \
301 	{ "posix2_c_bind", CTLTYPE_INT }, \
302 	{ "posix2_c_dev", CTLTYPE_INT }, \
303 	{ "posix2_char_term", CTLTYPE_INT }, \
304 	{ "posix2_fort_dev", CTLTYPE_INT }, \
305 	{ "posix2_fort_run", CTLTYPE_INT }, \
306 	{ "posix2_localedef", CTLTYPE_INT }, \
307 	{ "posix2_sw_dev", CTLTYPE_INT }, \
308 	{ "posix2_upe", CTLTYPE_INT }, \
309 	{ "stream_max", CTLTYPE_INT }, \
310 	{ "tzname_max", CTLTYPE_INT }, \
311 }
312 
313 /*
314  * CTL_DEBUG definitions
315  *
316  * Second level identifier specifies which debug variable.
317  * Third level identifier specifies which stucture component.
318  */
319 #define	CTL_DEBUG_NAME		0	/* string: variable name */
320 #define	CTL_DEBUG_VALUE		1	/* int: variable value */
321 #define	CTL_DEBUG_MAXID		20
322 
323 #ifdef	KERNEL
324 #if	defined(DEBUG) || defined(DIAGNOSTIC)
325 /*
326  * CTL_DEBUG variables.
327  *
328  * These are declared as separate variables so that they can be
329  * individually initialized at the location of their associated
330  * variable. The loader prevents multiple use by issuing errors
331  * if a variable is initialized in more than one place. They are
332  * aggregated into an array in debug_sysctl(), so that it can
333  * conveniently locate them when querried. If more debugging
334  * variables are added, they must also be declared here and also
335  * entered into the array.
336  */
337 struct ctldebug {
338 	char	*debugname;	/* name of debugging variable */
339 	int	*debugvar;	/* pointer to debugging variable */
340 };
341 extern struct ctldebug debug0, debug1, debug2, debug3, debug4;
342 extern struct ctldebug debug5, debug6, debug7, debug8, debug9;
343 extern struct ctldebug debug10, debug11, debug12, debug13, debug14;
344 extern struct ctldebug debug15, debug16, debug17, debug18, debug19;
345 #endif	/* DEBUG */
346 
347 /*
348  * Internal sysctl function calling convention:
349  *
350  *	(*sysctlfn)(name, namelen, oldval, oldlenp, newval, newlen, p);
351  *
352  * The name parameter points at the next component of the name to be
353  * interpreted.  The namelen parameter is the number of integers in
354  * the name.
355  */
356 typedef int (sysctlfn)
357     __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *));
358 
359 sysctlfn cpu_sysctl;
360 sysctlfn dev_sysctl;
361 sysctlfn fs_sysctl;
362 sysctlfn hw_sysctl;
363 sysctlfn kern_sysctl;
364 sysctlfn net_sysctl;
365 sysctlfn ntp_sysctl;
366 sysctlfn vm_sysctl;
367 
368 int sysctl_int __P((void *, size_t *, void *, size_t, int *));
369 int sysctl_rdint __P((void *, size_t *, void *, int));
370 int sysctl_string __P((void *, size_t *, void *, size_t, char *, int));
371 int sysctl_rdstring __P((void *, size_t *, void *, char *));
372 int sysctl_rdstruct __P((void *, size_t *, void *, void *, int));
373 void fill_eproc __P((struct proc *, struct eproc *));
374 
375 int	sysctl_clockrate __P((char *, size_t*));
376 int	sysctl_vnode __P((char *, size_t*));
377 int	sysctl_file __P((char *, size_t*));
378 int	sysctl_doproc __P((int *, u_int, char *, size_t*));
379 
380 #else	/* !KERNEL */
381 #include <sys/cdefs.h>
382 
383 __BEGIN_DECLS
384 int	sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
385 __END_DECLS
386 #endif	/* KERNEL */
387 
388 #endif	/* !_SYS_SYSCTL_H_ */
389