1/*
2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*
30 * Copyright (c) 1989, 1993
31 *	The Regents of the University of California.  All rights reserved.
32 *
33 * This code is derived from software contributed to Berkeley by
34 * Mike Karels at Berkeley Software Design, Inc.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 *    must display the following acknowledgement:
46 *	This product includes software developed by the University of
47 *	California, Berkeley and its contributors.
48 * 4. Neither the name of the University nor the names of its contributors
49 *    may be used to endorse or promote products derived from this software
50 *    without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * SUCH DAMAGE.
63 *
64 *	@(#)sysctl.h	8.1 (Berkeley) 6/2/93
65 */
66/*
67 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
68 * support for mandatory and extensible security protections.  This notice
69 * is included in support of clause 2.2 (b) of the Apple Public License,
70 * Version 2.0.
71 */
72
73#ifndef _SYS_SYSCTL_H_
74#define	_SYS_SYSCTL_H_
75
76/*
77 * These are for the eproc structure defined below.
78 */
79#include <sys/cdefs.h>
80
81#include <sys/appleapiopts.h>
82#ifndef KERNEL
83#include <sys/time.h>
84#include <sys/ucred.h>
85#else
86#ifndef XNU_KERNEL_PRIVATE
87#include <libkern/sysctl.h>
88#endif
89#endif
90#include <sys/proc.h>
91#include <sys/vm.h>
92
93#ifdef XNU_KERNEL_PRIVATE
94#include <sys/linker_set.h>
95#endif
96
97/*
98 * Definitions for sysctl call.  The sysctl call uses a hierarchical name
99 * for objects that can be examined or modified.  The name is expressed as
100 * a sequence of integers.  Like a file path name, the meaning of each
101 * component depends on its place in the hierarchy.  The top-level and kern
102 * identifiers are defined here, and other identifiers are defined in the
103 * respective subsystem header files.
104 */
105
106#define CTL_MAXNAME	12	/* largest number of components supported */
107
108/*
109 * Each subsystem defined by sysctl defines a list of variables
110 * for that subsystem. Each name is either a node with further
111 * levels defined below it, or it is a leaf of some particular
112 * type given below. Each sysctl level defines a set of name/type
113 * pairs to be used by sysctl(1) in manipulating the subsystem.
114 *
115 * When declaring new sysctl names, use the CTLFLAG_LOCKED flag in the
116 * type to indicate that all necessary locking will be handled
117 * within the sysctl.
118 *
119 * Any sysctl defined without CTLFLAG_LOCKED is considered legacy
120 * and will be protected by a global mutex.
121 *
122 * Note:	This is not optimal, so it is best to handle locking
123 *		yourself, if you are able to do so.  A simple design
124 *		pattern for use to avoid in a single function known
125 *		to potentially be in the paging path ot doing a DMA
126 *		to physical memory in a user space process is:
127 *
128 *			lock
129 *			perform operation vs. local buffer
130 *			unlock
131 *			SYSCTL_OUT(rey, local buffer, length)
132 *
133 *		...this assumes you are not using a deep call graph
134 *		or are unable to pass a local buffer address as a
135 *		parameter into your deep call graph.
136 *
137 *		Note that very large user buffers can fail the wire
138 *		if to do so would require more physical pages than
139 *		are available (the caller will get an ENOMEM error,
140 *		see sysctl_mem_hold() for details).
141 */
142struct ctlname {
143	char	*ctl_name;	/* subsystem name */
144	int	ctl_type;	/* type of name */
145};
146
147#define CTLTYPE		0xf	/* Mask for the type */
148#define	CTLTYPE_NODE	1	/* name is a node */
149#define	CTLTYPE_INT	2	/* name describes an integer */
150#define	CTLTYPE_STRING	3	/* name describes a string */
151#define	CTLTYPE_QUAD	4	/* name describes a 64-bit number */
152#define	CTLTYPE_OPAQUE	5	/* name describes a structure */
153#define	CTLTYPE_STRUCT	CTLTYPE_OPAQUE	/* name describes a structure */
154
155#define CTLFLAG_RD	0x80000000	/* Allow reads of variable */
156#define CTLFLAG_WR	0x40000000	/* Allow writes to the variable */
157#define CTLFLAG_RW	(CTLFLAG_RD|CTLFLAG_WR)
158#define CTLFLAG_NOLOCK	0x20000000	/* XXX Don't Lock */
159#define CTLFLAG_ANYBODY	0x10000000	/* All users can set this var */
160#define CTLFLAG_SECURE	0x08000000	/* Permit set only if securelevel<=0 */
161#define CTLFLAG_MASKED	0x04000000	/* deprecated variable, do not display */
162#define CTLFLAG_NOAUTO	0x02000000	/* do not auto-register */
163#define CTLFLAG_KERN	0x01000000	/* valid inside the kernel */
164#define CTLFLAG_LOCKED	0x00800000	/* node will handle locking itself */
165#define CTLFLAG_OID2	0x00400000	/* struct sysctl_oid has version info */
166
167/*
168 * USE THIS instead of a hardwired number from the categories below
169 * to get dynamically assigned sysctl entries using the linker-set
170 * technology. This is the way nearly all new sysctl variables should
171 * be implemented.
172 *
173 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
174 *
175 * Note that linker set technology will automatically register all nodes
176 * declared like this on kernel initialization, UNLESS they are defined
177 * in I/O-Kit. In this case, you have to call sysctl_register_oid()
178 * manually - just like in a KEXT.
179 */
180#define OID_AUTO	(-1)
181#define OID_AUTO_START 100 /* conventional */
182
183#ifdef KERNEL
184#define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \
185	struct sysctl_req *req)
186
187
188/*
189 * This describes the access space for a sysctl request.  This is needed
190 * so that we can use the interface from the kernel or from user-space.
191 */
192struct sysctl_req {
193	struct proc	*p;
194	int		lock;
195	user_addr_t	oldptr;		/* pointer to user supplied buffer */
196	size_t		oldlen;		/* user buffer length (also returned) */
197	size_t		oldidx;		/* total data iteratively copied out */
198	int		(*oldfunc)(struct sysctl_req *, const void *, size_t);
199	user_addr_t	newptr;		/* buffer containing new value */
200	size_t		newlen;		/* length of new value */
201	size_t		newidx;		/* total data iteratively copied in */
202	int		(*newfunc)(struct sysctl_req *, void *, size_t);
203};
204
205SLIST_HEAD(sysctl_oid_list, sysctl_oid);
206
207#define SYSCTL_OID_VERSION	1	/* current OID structure version */
208
209/*
210 * This describes one "oid" in the MIB tree.  Potentially more nodes can
211 * be hidden behind it, expanded by the handler.
212 *
213 * NOTES:	We implement binary comparibility between CTLFLAG_OID2 and
214 *		pre-CTLFLAG_OID2 structure in sysctl_register_oid() and in
215 *		sysctl_unregister_oid() using the fact that the fields up
216 *		to oid_fmt are unchanged, and that the field immediately
217 *		following is on an alignment boundary following a pointer
218 *		type and is also a pointer.  This lets us get the previous
219 *		size of the structure, and the copy-cut-off point, using
220 *		the offsetof() language primitive, and these values  are
221 *		used in conjunction with the fact that earlier and future
222 *		statically compiled sysctl_oid structures are declared via
223 *		macros.  This lets us overload the macros so that the addition
224 *		of the CTLFLAG_OID2 in newly compiled code containing sysctl
225 *		node declarations, subsequently allowing us to to avoid
226 *		changing the KPI used for non-static (un)registration in
227 *		KEXTs.
228 *
229 *		This depends on the fact that people declare SYSCTLs,
230 *		rather than declaring sysctl_oid structures.  All new code
231 *		should avoid declaring struct sysctl_oid's directly without
232 *		the macros; the current risk for this is limited to losing
233 *		your description field and ending up with a malloc'ed copy,
234 *		as if it were a legacy binary static declaration via SYSCTL;
235 *		in the future, we may deprecate access to a named structure
236 *		type in third party code.  Use the macros, or our code will
237 *		end up with compile errors when that happens.
238 *
239 *		Please try to include a long description of the field in any
240 *		new sysctl declarations (all the macros support this).  This
241 *		field may be the only human readable documentation your users
242 *		get for your sysctl.
243 */
244struct sysctl_oid {
245	struct sysctl_oid_list *oid_parent;
246	SLIST_ENTRY(sysctl_oid) oid_link;
247	int		oid_number;
248	int		oid_kind;
249	void		*oid_arg1;
250	int		oid_arg2;
251	const char	*oid_name;
252	int 		(*oid_handler) SYSCTL_HANDLER_ARGS;
253	const char	*oid_fmt;
254	const char	*oid_descr; /* offsetof() field / long description */
255	int		oid_version;
256	int		oid_refcnt;
257};
258
259#define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
260#define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
261
262typedef int (* sysctl_handler_t) SYSCTL_HANDLER_ARGS;
263
264__BEGIN_DECLS
265
266/* old interface */
267int sysctl_handle_int SYSCTL_HANDLER_ARGS;
268int sysctl_handle_long SYSCTL_HANDLER_ARGS;
269int sysctl_handle_quad SYSCTL_HANDLER_ARGS;
270int sysctl_handle_int2quad SYSCTL_HANDLER_ARGS;
271int sysctl_handle_string SYSCTL_HANDLER_ARGS;
272int sysctl_handle_opaque SYSCTL_HANDLER_ARGS;
273/* new interface */
274int sysctl_io_number(struct sysctl_req *req, long long bigValue, size_t valueSize, void *pValue, int *changed);
275int sysctl_io_string(struct sysctl_req *req, char *pValue, size_t valueSize, int trunc, int *changed);
276int sysctl_io_opaque(struct sysctl_req *req, void *pValue, size_t valueSize, int *changed);
277
278/*
279 * These functions are used to add/remove an oid from the mib.
280 */
281void sysctl_register_oid(struct sysctl_oid *oidp);
282void sysctl_unregister_oid(struct sysctl_oid *oidp);
283
284/* Not exported */
285void sysctl_register_fixed(void);
286
287__END_DECLS
288
289/* Declare an oid to allow child oids to be added to it. */
290#define SYSCTL_DECL(name)					\
291	extern struct sysctl_oid_list sysctl_##name##_children
292
293#ifdef XNU_KERNEL_PRIVATE
294#define SYSCTL_LINKER_SET_ENTRY LINKER_SET_ENTRY
295#else
296#define SYSCTL_LINKER_SET_ENTRY(a, b)
297#endif
298/*
299 * Macros to define sysctl entries.  Which to use?  Pure data that are
300 * returned without modification, SYSCTL_<data type> is for you, like
301 * SYSCTL_QUAD for a 64-bit value.  When you want to run a handler of your
302 * own, SYSCTL_PROC.
303 *
304 * parent:	parent in name hierarchy (e.g. _kern for "kern")
305 * nbr:		ID.  Almost certainly OID_AUTO ("pick one for me") for you.
306 * name:	name for this particular item (e.g. "thesysctl" for "kern.thesysctl")
307 * kind/access: Control flags (CTLFLAG_*).  Some notable options include:
308 * 			CTLFLAG_ANYBODY: 	non-root users allowed
309 * 			CTLFLAG_MASKED:	 	don't show in sysctl listing in userland
310 * 			CTLFLAG_LOCKED:		does own locking (no additional protection needed)
311 * 			CTLFLAG_KERN:		valid inside kernel (best avoided generally)
312 * 			CTLFLAG_WR:		"new" value accepted
313 * a1, a2:	entry-data, passed to handler (see specific macros)
314 * Format String: Tells "sysctl" tool how to print data from this entry.
315 *	 		"A" - string
316 *	 		"I" - list of integers. "IU" - list of unsigned integers. space-separated.
317 *	 		"-" - do not print
318 *	 		"L" - longs, as ints with I
319 *			"P" - pointer
320 * 			"Q" - quads
321 * 			"S","T" - clock info, see sysctl.c in system_cmds (you probably don't need this)
322 * Description: unused
323 */
324
325
326/* This constructs a "raw" MIB oid. */
327#define SYSCTL_STRUCT_INIT(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
328	{												\
329		&sysctl_##parent##_children, { 0 },			\
330		nbr, (int)(kind|CTLFLAG_OID2), a1, (int)(a2), #name, handler, fmt, descr, SYSCTL_OID_VERSION, 0 \
331	}
332
333#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
334	struct sysctl_oid sysctl_##parent##_##name = SYSCTL_STRUCT_INIT(parent, nbr, name, kind, a1, a2, handler, fmt, descr); \
335	SYSCTL_LINKER_SET_ENTRY(__sysctl_set, sysctl_##parent##_##name)
336
337/* This constructs a node from which other oids can hang. */
338#define SYSCTL_NODE(parent, nbr, name, access, handler, descr)		    \
339	struct sysctl_oid_list sysctl_##parent##_##name##_children;	    \
340	SYSCTL_OID(parent, nbr, name, CTLTYPE_NODE|access,		    \
341		   (void*)&sysctl_##parent##_##name##_children, 0, handler, \
342		   "N", descr);
343
344/* Oid for a string.  len can be 0 to indicate '\0' termination. */
345#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr) \
346	SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|access, \
347		arg, len, sysctl_handle_string, "A", descr)
348
349#define SYSCTL_COMPAT_INT(parent, nbr, name, access, ptr, val, descr) \
350	SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
351               ptr, val, sysctl_handle_int, "I", descr)
352
353#define SYSCTL_COMPAT_UINT(parent, nbr, name, access, ptr, val, descr) \
354	SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
355		ptr, val, sysctl_handle_int, "IU", descr)
356
357/* Oid for an int.  If ptr is NULL, val is returned. */
358#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
359	SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
360               ptr, val, sysctl_handle_int, "I", descr); \
361	typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(int)) ? 0 : -1];
362
363/* Oid for an unsigned int.  If ptr is NULL, val is returned. */
364#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
365	SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
366		ptr, val, sysctl_handle_int, "IU", descr); \
367	typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(unsigned int)) ? 0 : -1];
368
369/* Oid for a long.  The pointer must be non NULL. */
370#define SYSCTL_LONG(parent, nbr, name, access, ptr, descr) \
371	SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
372		ptr, 0, sysctl_handle_long, "L", descr); \
373	typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(long)) ? 0 : -1];
374
375/* Oid for a quad.  The pointer must be non NULL. */
376#define SYSCTL_QUAD(parent, nbr, name, access, ptr, descr) \
377	SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|access, \
378		ptr, 0, sysctl_handle_quad, "Q", descr); \
379	typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(long long)) ? 0 : -1];
380
381/* Oid for an opaque object.  Specified by a pointer and a length. */
382#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
383	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|access, \
384		ptr, len, sysctl_handle_opaque, fmt, descr)
385
386/* Oid for a struct.  Specified by a pointer and a type. */
387#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr) \
388	SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|access, \
389		ptr, sizeof(struct type), sysctl_handle_opaque, \
390		"S," #type, descr)
391
392/*
393 * Oid for a procedure.  Specified by a pointer and an arg.
394 * CTLTYPE_* macros can determine how the "sysctl" tool deals with
395 * input (e.g. converting to int).
396 */
397#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
398	SYSCTL_OID(parent, nbr, name, access, \
399		ptr, arg, handler, fmt, descr)
400
401
402extern struct sysctl_oid_list sysctl__children;
403SYSCTL_DECL(_kern);
404SYSCTL_DECL(_sysctl);
405SYSCTL_DECL(_vm);
406SYSCTL_DECL(_vfs);
407SYSCTL_DECL(_net);
408SYSCTL_DECL(_debug);
409SYSCTL_DECL(_hw);
410SYSCTL_DECL(_machdep);
411SYSCTL_DECL(_user);
412
413#endif /* KERNEL */
414
415#ifdef XNU_KERNEL_PRIVATE
416#define SYSCTL_DEF_ENABLED
417#else
418#ifndef KERNEL
419#define SYSCTL_DEF_ENABLED
420#endif
421#endif
422
423#ifdef SYSCTL_DEF_ENABLED
424/*
425 * Top-level identifiers
426 */
427#define	CTL_UNSPEC	0		/* unused */
428#define	CTL_KERN	1		/* "high kernel": proc, limits */
429#define	CTL_VM		2		/* virtual memory */
430#define	CTL_VFS		3		/* file system, mount type is next */
431#define	CTL_NET		4		/* network, see socket.h */
432#define	CTL_DEBUG	5		/* debugging parameters */
433#define	CTL_HW		6		/* generic cpu/io */
434#define	CTL_MACHDEP	7		/* machine dependent */
435#define	CTL_USER	8		/* user-level */
436#define	CTL_MAXID	9		/* number of valid top-level ids */
437
438#define CTL_NAMES { \
439	{ 0, 0 }, \
440	{ "kern", CTLTYPE_NODE }, \
441	{ "vm", CTLTYPE_NODE }, \
442	{ "vfs", CTLTYPE_NODE }, \
443	{ "net", CTLTYPE_NODE }, \
444	{ "debug", CTLTYPE_NODE }, \
445	{ "hw", CTLTYPE_NODE }, \
446	{ "machdep", CTLTYPE_NODE }, \
447	{ "user", CTLTYPE_NODE }, \
448}
449
450/*
451 * CTL_KERN identifiers
452 */
453#define	KERN_OSTYPE	 	 1	/* string: system version */
454#define	KERN_OSRELEASE	 	 2	/* string: system release */
455#define	KERN_OSREV	 	 3	/* int: system revision */
456#define	KERN_VERSION	 	 4	/* string: compile time info */
457#define	KERN_MAXVNODES	 	 5	/* int: max vnodes */
458#define	KERN_MAXPROC	 	 6	/* int: max processes */
459#define	KERN_MAXFILES	 	 7	/* int: max open files */
460#define	KERN_ARGMAX	 	 8	/* int: max arguments to exec */
461#define	KERN_SECURELVL	 	 9	/* int: system security level */
462#define	KERN_HOSTNAME		10	/* string: hostname */
463#define	KERN_HOSTID		11	/* int: host identifier */
464#define	KERN_CLOCKRATE		12	/* struct: struct clockrate */
465#define	KERN_VNODE		13	/* struct: vnode structures */
466#define	KERN_PROC		14	/* struct: process entries */
467#define	KERN_FILE		15	/* struct: file entries */
468#define	KERN_PROF		16	/* node: kernel profiling info */
469#define	KERN_POSIX1		17	/* int: POSIX.1 version */
470#define	KERN_NGROUPS		18	/* int: # of supplemental group ids */
471#define	KERN_JOB_CONTROL	19	/* int: is job control available */
472#define	KERN_SAVED_IDS		20	/* int: saved set-user/group-ID */
473#define	KERN_BOOTTIME		21	/* struct: time kernel was booted */
474#define KERN_NISDOMAINNAME	22	/* string: YP domain name */
475#define KERN_DOMAINNAME		KERN_NISDOMAINNAME
476#define	KERN_MAXPARTITIONS	23	/* int: number of partitions/disk */
477#define	KERN_KDEBUG			24	/* int: kernel trace points */
478#define KERN_UPDATEINTERVAL	25	/* int: update process sleep time */
479#define KERN_OSRELDATE		26	/* int: OS release date */
480#define KERN_NTP_PLL		27	/* node: NTP PLL control */
481#define	KERN_BOOTFILE		28	/* string: name of booted kernel */
482#define	KERN_MAXFILESPERPROC	29	/* int: max open files per proc */
483#define	KERN_MAXPROCPERUID 	30	/* int: max processes per uid */
484#define KERN_DUMPDEV		31	/* dev_t: device to dump on */
485#define	KERN_IPC		32	/* node: anything related to IPC */
486#define	KERN_DUMMY		33	/* unused */
487#define	KERN_PS_STRINGS	34	/* int: address of PS_STRINGS */
488#define	KERN_USRSTACK32	35	/* int: address of USRSTACK */
489#define	KERN_LOGSIGEXIT	36	/* int: do we log sigexit procs? */
490#define KERN_SYMFILE		37	/* string: kernel symbol filename */
491#define KERN_PROCARGS		38
492                             /* 39 was KERN_PCSAMPLES... now deprecated */
493#define KERN_NETBOOT		40	/* int: are we netbooted? 1=yes,0=no */
494                             /* 41 was KERN_PANICINFO : panic UI information (deprecated) */
495#define	KERN_SYSV		42	/* node: System V IPC information */
496#define KERN_AFFINITY		43	/* xxx */
497#define KERN_TRANSLATE	   	44	/* xxx */
498#define KERN_CLASSIC	   	KERN_TRANSLATE	/* XXX backwards compat */
499#define KERN_EXEC		45	/* xxx */
500#define KERN_CLASSICHANDLER	KERN_EXEC /* XXX backwards compatibility */
501#define	KERN_AIOMAX		46	/* int: max aio requests */
502#define	KERN_AIOPROCMAX		47	/* int: max aio requests per process */
503#define	KERN_AIOTHREADS		48	/* int: max aio worker threads */
504#ifdef __APPLE_API_UNSTABLE
505#define	KERN_PROCARGS2		49
506#endif /* __APPLE_API_UNSTABLE */
507#define KERN_COREFILE		50	/* string: corefile format string */
508#define KERN_COREDUMP		51	/* int: whether to coredump at all */
509#define	KERN_SUGID_COREDUMP	52	/* int: whether to dump SUGID cores */
510#define	KERN_PROCDELAYTERM	53	/* int: set/reset current proc for delayed termination during shutdown */
511#define KERN_SHREG_PRIVATIZABLE	54	/* int: can shared regions be privatized ? */
512                             /* 55 was KERN_PROC_LOW_PRI_IO... now deprecated */
513#define	KERN_LOW_PRI_WINDOW	56	/* int: set/reset throttle window - milliseconds */
514#define	KERN_LOW_PRI_DELAY	57	/* int: set/reset throttle delay - milliseconds */
515#define	KERN_POSIX		58	/* node: posix tunables */
516#define	KERN_USRSTACK64		59	/* LP64 user stack query */
517#define KERN_NX_PROTECTION	60	/* int: whether no-execute protection is enabled */
518#define	KERN_TFP 		61	/* Task for pid settings */
519#define	KERN_PROCNAME 		62	/* setup process program  name(2*MAXCOMLEN) */
520#define	KERN_THALTSTACK		63	/* for compat with older x86 and does nothing */
521#define	KERN_SPECULATIVE_READS	64	/* int: whether speculative reads are disabled */
522#define	KERN_OSVERSION		65	/* for build number i.e. 9A127 */
523#define	KERN_SAFEBOOT		66	/* are we booted safe? */
524#define	KERN_LCTX		67	/* node: login context */
525#define KERN_RAGEVNODE		68
526#define KERN_TTY		69	/* node: tty settings */
527#define KERN_CHECKOPENEVT       70      /* spi: check the VOPENEVT flag on vnodes at open time */
528#define	KERN_THREADNAME		71	/* set/get thread name */
529#define	KERN_MAXID		72	/* number of valid kern ids */
530/*
531 * Don't add any more sysctls like this.  Instead, use the SYSCTL_*() macros
532 * and OID_AUTO. This will have the added benefit of not having to recompile
533 * sysctl(8) to pick up your changes.
534 */
535
536#if COUNT_SYSCALLS && defined(KERNEL)
537#define	KERN_COUNT_SYSCALLS (KERN_OSTYPE + 1000)	/* keep called count for each bsd syscall */
538#endif
539
540#if defined(__LP64__)
541#define	KERN_USRSTACK KERN_USRSTACK64
542#else
543#define	KERN_USRSTACK KERN_USRSTACK32
544#endif
545
546
547/* KERN_RAGEVNODE types */
548#define KERN_RAGE_PROC		1
549#define KERN_RAGE_THREAD	2
550#define KERN_UNRAGE_PROC	3
551#define KERN_UNRAGE_THREAD	4
552
553/* KERN_OPENEVT types */
554#define KERN_OPENEVT_PROC     1
555#define KERN_UNOPENEVT_PROC   2
556
557/* KERN_TFP types */
558#define KERN_TFP_POLICY 		1
559
560/* KERN_TFP_POLICY values . All policies allow task port for self */
561#define KERN_TFP_POLICY_DENY 		0 	/* Deny Mode: None allowed except privileged */
562#define KERN_TFP_POLICY_DEFAULT 	2	/* Default  Mode: related ones allowed and upcall authentication */
563
564/* KERN_KDEBUG types */
565#define KERN_KDEFLAGS		1
566#define KERN_KDDFLAGS		2
567#define KERN_KDENABLE		3
568#define KERN_KDSETBUF		4
569#define KERN_KDGETBUF		5
570#define KERN_KDSETUP		6
571#define KERN_KDREMOVE		7
572#define KERN_KDSETREG		8
573#define KERN_KDGETREG		9
574#define KERN_KDREADTR		10
575#define KERN_KDPIDTR		11
576#define KERN_KDTHRMAP           12
577/* Don't use 13 as it is overloaded with KERN_VNODE */
578#define KERN_KDPIDEX            14
579#define KERN_KDSETRTCDEC        15
580#define KERN_KDGETENTROPY       16		/* Obsolescent */
581#define KERN_KDWRITETR		17
582#define KERN_KDWRITEMAP		18
583#define KERN_KDENABLE_BG_TRACE	19
584#define KERN_KDDISABLE_BG_TRACE	20
585#define KERN_KDREADCURTHRMAP	21
586#define KERN_KDSET_TYPEFILTER   22
587#define KERN_KDBUFWAIT		23
588#define KERN_KDCPUMAP		24
589
590#define CTL_KERN_NAMES { \
591	{ 0, 0 }, \
592	{ "ostype", CTLTYPE_STRING }, \
593	{ "osrelease", CTLTYPE_STRING }, \
594	{ "osrevision", CTLTYPE_INT }, \
595	{ "version", CTLTYPE_STRING }, \
596	{ "maxvnodes", CTLTYPE_INT }, \
597	{ "maxproc", CTLTYPE_INT }, \
598	{ "maxfiles", CTLTYPE_INT }, \
599	{ "argmax", CTLTYPE_INT }, \
600	{ "securelevel", CTLTYPE_INT }, \
601	{ "hostname", CTLTYPE_STRING }, \
602	{ "hostid", CTLTYPE_INT }, \
603	{ "clockrate", CTLTYPE_STRUCT }, \
604	{ "vnode", CTLTYPE_STRUCT }, \
605	{ "proc", CTLTYPE_STRUCT }, \
606	{ "file", CTLTYPE_STRUCT }, \
607	{ "profiling", CTLTYPE_NODE }, \
608	{ "posix1version", CTLTYPE_INT }, \
609	{ "ngroups", CTLTYPE_INT }, \
610	{ "job_control", CTLTYPE_INT }, \
611	{ "saved_ids", CTLTYPE_INT }, \
612	{ "boottime", CTLTYPE_STRUCT }, \
613	{ "nisdomainname", CTLTYPE_STRING }, \
614	{ "maxpartitions", CTLTYPE_INT }, \
615	{ "kdebug", CTLTYPE_INT }, \
616	{ "update", CTLTYPE_INT }, \
617	{ "osreldate", CTLTYPE_INT }, \
618	{ "ntp_pll", CTLTYPE_NODE }, \
619	{ "bootfile", CTLTYPE_STRING }, \
620	{ "maxfilesperproc", CTLTYPE_INT }, \
621	{ "maxprocperuid", CTLTYPE_INT }, \
622	{ "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \
623	{ "ipc", CTLTYPE_NODE }, \
624	{ "dummy", CTLTYPE_INT }, \
625	{ "dummy", CTLTYPE_INT }, \
626	{ "usrstack", CTLTYPE_INT }, \
627	{ "logsigexit", CTLTYPE_INT }, \
628	{ "symfile",CTLTYPE_STRING },\
629	{ "procargs",CTLTYPE_STRUCT },\
630        { "dummy", CTLTYPE_INT },		/* deprecated pcsamples */ \
631	{ "netboot", CTLTYPE_INT }, \
632	{ "dummy", CTLTYPE_INT }, 		/* deprecated: panicinfo */ \
633	{ "sysv", CTLTYPE_NODE }, \
634	{ "dummy", CTLTYPE_INT }, \
635	{ "dummy", CTLTYPE_INT }, \
636	{ "exec", CTLTYPE_NODE }, \
637	{ "aiomax", CTLTYPE_INT }, \
638	{ "aioprocmax", CTLTYPE_INT }, \
639	{ "aiothreads", CTLTYPE_INT }, \
640	{ "procargs2",CTLTYPE_STRUCT }, \
641	{ "corefile",CTLTYPE_STRING }, \
642	{ "coredump", CTLTYPE_INT }, \
643	{ "sugid_coredump", CTLTYPE_INT }, \
644	{ "delayterm", CTLTYPE_INT }, \
645	{ "shreg_private", CTLTYPE_INT }, \
646	{ "proc_low_pri_io", CTLTYPE_INT }, \
647	{ "low_pri_window", CTLTYPE_INT }, \
648	{ "low_pri_delay", CTLTYPE_INT }, \
649	{ "posix", CTLTYPE_NODE }, \
650	{ "usrstack64", CTLTYPE_QUAD }, \
651	{ "nx", CTLTYPE_INT }, \
652	{ "tfp", CTLTYPE_NODE }, \
653	{ "procname", CTLTYPE_STRING }, \
654	{ "threadsigaltstack", CTLTYPE_INT }, \
655	{ "speculative_reads_disabled", CTLTYPE_INT }, \
656	{ "osversion", CTLTYPE_STRING }, \
657	{ "safeboot", CTLTYPE_INT }, \
658	{ "lctx", CTLTYPE_NODE }, \
659	{ "rage_vnode", CTLTYPE_INT }, \
660	{ "tty", CTLTYPE_NODE },	\
661	{ "check_openevt", CTLTYPE_INT }, \
662	{ "thread_name", CTLTYPE_STRING } \
663}
664
665/*
666 * CTL_VFS identifiers
667 */
668#define CTL_VFS_NAMES { \
669	{ "vfsconf", CTLTYPE_STRUCT } \
670}
671
672/*
673 * KERN_PROC subtypes
674 */
675#define KERN_PROC_ALL		0	/* everything */
676#define	KERN_PROC_PID		1	/* by process id */
677#define	KERN_PROC_PGRP		2	/* by process group id */
678#define	KERN_PROC_SESSION	3	/* by session of pid */
679#define	KERN_PROC_TTY		4	/* by controlling tty */
680#define	KERN_PROC_UID		5	/* by effective uid */
681#define	KERN_PROC_RUID		6	/* by real uid */
682#define	KERN_PROC_LCID		7	/* by login context id */
683
684/*
685 * KERN_LCTX subtypes
686 */
687#define	KERN_LCTX_ALL		0	/* everything */
688#define	KERN_LCTX_LCID		1	/* by login context id */
689
690
691#if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL)
692/*
693 * KERN_PROC subtype ops return arrays of augmented proc structures:
694 */
695
696struct _pcred {
697	char	pc_lock[72];		/* opaque content */
698	struct	ucred *pc_ucred;	/* Current credentials. */
699	uid_t	p_ruid;			/* Real user id. */
700	uid_t	p_svuid;		/* Saved effective user id. */
701	gid_t	p_rgid;			/* Real group id. */
702	gid_t	p_svgid;		/* Saved effective group id. */
703	int	p_refcnt;		/* Number of references. */
704};
705
706struct _ucred {
707	int32_t	cr_ref;			/* reference count */
708	uid_t	cr_uid;			/* effective user id */
709	short	cr_ngroups;		/* number of groups */
710	gid_t	cr_groups[NGROUPS];	/* groups */
711};
712
713struct kinfo_proc {
714	struct	extern_proc kp_proc;			/* proc structure */
715	struct	eproc {
716		struct	proc *e_paddr;		/* address of proc */
717		struct	session *e_sess;	/* session pointer */
718		struct	_pcred e_pcred;		/* process credentials */
719		struct	_ucred e_ucred;		/* current credentials */
720		struct	 vmspace e_vm;		/* address space */
721		pid_t	e_ppid;			/* parent process id */
722		pid_t	e_pgid;			/* process group id */
723		short	e_jobc;			/* job control counter */
724		dev_t	e_tdev;			/* controlling tty dev */
725		pid_t	e_tpgid;		/* tty process group id */
726		struct	session *e_tsess;	/* tty session pointer */
727#define	WMESGLEN	7
728		char	e_wmesg[WMESGLEN+1];	/* wchan message */
729		segsz_t e_xsize;		/* text size */
730		short	e_xrssize;		/* text rss */
731		short	e_xccount;		/* text references */
732		short	e_xswrss;
733		int32_t	e_flag;
734#define	EPROC_CTTY	0x01	/* controlling tty vnode active */
735#define	EPROC_SLEADER	0x02	/* session leader */
736#define	COMAPT_MAXLOGNAME	12
737		char	e_login[COMAPT_MAXLOGNAME];	/* short setlogin() name */
738#if CONFIG_LCTX
739		pid_t	e_lcid;
740		int32_t	e_spare[3];
741#else
742		int32_t	e_spare[4];
743#endif
744	} kp_eproc;
745};
746
747struct kinfo_lctx {
748	pid_t	id;	/* Login Context ID */
749	int	mc;	/* Member Count */
750};
751
752#endif /* defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL) */
753
754#ifdef BSD_KERNEL_PRIVATE
755#include <sys/proc_internal.h>
756
757/* LP64 version of _pcred.  all pointers
758 * grow when we're dealing with a 64-bit process.
759 * WARNING - keep in sync with _pcred
760 */
761
762struct user32_pcred {
763	char	pc_lock[72];		/* opaque content */
764	user32_addr_t	pc_ucred;	/* Current credentials. */
765	uid_t	p_ruid;			/* Real user id. */
766	uid_t	p_svuid;		/* Saved effective user id. */
767	gid_t	p_rgid;			/* Real group id. */
768	gid_t	p_svgid;		/* Saved effective group id. */
769	int	p_refcnt;		/* Number of references. */
770};
771struct user64_pcred {
772	char	pc_lock[72];		/* opaque content */
773	user64_addr_t	pc_ucred;	/* Current credentials. */
774	uid_t	p_ruid;			/* Real user id. */
775	uid_t	p_svuid;		/* Saved effective user id. */
776	gid_t	p_rgid;			/* Real group id. */
777	gid_t	p_svgid;		/* Saved effective group id. */
778	int	p_refcnt;		/* Number of references. */
779};
780
781/* LP64 version of kinfo_proc.  all pointers
782 * grow when we're dealing with a 64-bit process.
783 * WARNING - keep in sync with kinfo_proc
784 */
785struct user32_kinfo_proc {
786	struct	user32_extern_proc kp_proc;	/* proc structure */
787	struct	user32_eproc {
788		user32_addr_t e_paddr;		/* address of proc */
789		user32_addr_t e_sess;			/* session pointer */
790		struct	user32_pcred e_pcred;		/* process credentials */
791		struct	_ucred e_ucred;		/* current credentials */
792		struct	user32_vmspace e_vm; /* address space */
793		pid_t	e_ppid;			/* parent process id */
794		pid_t	e_pgid;			/* process group id */
795		short	e_jobc;			/* job control counter */
796		dev_t	e_tdev;			/* controlling tty dev */
797		pid_t	e_tpgid;		/* tty process group id */
798		user32_addr_t	e_tsess;	/* tty session pointer */
799		char	e_wmesg[WMESGLEN+1];	/* wchan message */
800		segsz_t e_xsize;		/* text size */
801		short	e_xrssize;		/* text rss */
802		short	e_xccount;		/* text references */
803		short	e_xswrss;
804		int32_t	e_flag;
805		char	e_login[COMAPT_MAXLOGNAME];	/* short setlogin() name */
806#if CONFIG_LCTX
807		pid_t	e_lcid;
808		int32_t	e_spare[3];
809#else
810		int32_t	e_spare[4];
811#endif
812	} kp_eproc;
813};
814struct user64_kinfo_proc {
815	struct	user64_extern_proc kp_proc;	/* proc structure */
816	struct	user64_eproc {
817		user_addr_t e_paddr;		/* address of proc */
818		user_addr_t e_sess;			/* session pointer */
819		struct	user64_pcred e_pcred;		/* process credentials */
820		struct	_ucred e_ucred;		/* current credentials */
821		struct	 user_vmspace e_vm; /* address space */
822		pid_t	e_ppid;			/* parent process id */
823		pid_t	e_pgid;			/* process group id */
824		short	e_jobc;			/* job control counter */
825		dev_t	e_tdev;			/* controlling tty dev */
826		pid_t	e_tpgid;		/* tty process group id */
827		user64_addr_t	e_tsess __attribute((aligned(8)));	/* tty session pointer */
828		char	e_wmesg[WMESGLEN+1];	/* wchan message */
829		segsz_t e_xsize;		/* text size */
830		short	e_xrssize;		/* text rss */
831		short	e_xccount;		/* text references */
832		short	e_xswrss;
833		int32_t	e_flag;
834		char	e_login[COMAPT_MAXLOGNAME];	/* short setlogin() name */
835#if CONFIG_LCTX
836		pid_t	e_lcid;
837		int32_t	e_spare[3];
838#else
839		int32_t	e_spare[4];
840#endif
841	} kp_eproc;
842};
843
844#endif	/* BSD_KERNEL_PRIVATE */
845
846/*
847 * KERN_IPC identifiers
848 */
849#define KIPC_MAXSOCKBUF		1	/* int: max size of a socket buffer */
850#define	KIPC_SOCKBUF_WASTE	2	/* int: wastage factor in sockbuf */
851#define	KIPC_SOMAXCONN		3	/* int: max length of connection q */
852#define	KIPC_MAX_LINKHDR	4	/* int: max length of link header */
853#define	KIPC_MAX_PROTOHDR	5	/* int: max length of network header */
854#define	KIPC_MAX_HDR		6	/* int: max total length of headers */
855#define	KIPC_MAX_DATALEN	7	/* int: max length of data? */
856#define	KIPC_MBSTAT		8	/* struct: mbuf usage statistics */
857#define	KIPC_NMBCLUSTERS	9	/* int: maximum mbuf clusters */
858#define KIPC_SOQLIMITCOMPAT	10	/* int: socket queue limit */
859
860/*
861 * CTL_VM identifiers
862 */
863#define	VM_METER	1		/* struct vmmeter */
864#define	VM_LOADAVG	2		/* struct loadavg */
865/*
866 * Note: "3" was skipped sometime ago and should probably remain unused
867 * to avoid any new entry from being accepted by older kernels...
868 */
869#define	VM_MACHFACTOR	4		/* struct loadavg with mach factor*/
870#define VM_SWAPUSAGE	5		/* total swap usage */
871#define	VM_MAXID	6		/* number of valid vm ids */
872
873#define	CTL_VM_NAMES { \
874	{ 0, 0 }, \
875	{ "vmmeter", CTLTYPE_STRUCT }, \
876	{ "loadavg", CTLTYPE_STRUCT }, \
877	{ 0, 0 }, /* placeholder for "3" (see comment above) */ \
878	{ "dummy", CTLTYPE_INT }, \
879	{ "swapusage", CTLTYPE_STRUCT } \
880}
881
882struct xsw_usage {
883	u_int64_t	xsu_total;
884	u_int64_t	xsu_avail;
885	u_int64_t	xsu_used;
886	u_int32_t	xsu_pagesize;
887	boolean_t	xsu_encrypted;
888};
889
890#ifdef __APPLE_API_PRIVATE
891/* Load average structure.  Use of fixpt_t assume <sys/types.h> in scope. */
892/* XXX perhaps we should protect fixpt_t, and define it here (or discard it) */
893struct loadavg {
894	fixpt_t	ldavg[3];
895	long	fscale;
896};
897extern struct loadavg averunnable;
898#define LSCALE	1000		/* scaling for "fixed point" arithmetic */
899
900#ifdef BSD_KERNEL_PRIVATE
901
902struct user32_loadavg {
903	fixpt_t	ldavg[3];
904    user32_long_t	fscale;
905};
906
907struct user64_loadavg {
908	fixpt_t	ldavg[3];
909    user64_long_t	fscale;
910};
911
912#endif	/* BSD_KERNEL_PRIVATE */
913#endif /* __APPLE_API_PRIVATE */
914
915
916/*
917 * CTL_HW identifiers
918 */
919#define	HW_MACHINE	 1		/* string: machine class */
920#define	HW_MODEL	 2		/* string: specific machine model */
921#define	HW_NCPU		 3		/* int: number of cpus */
922#define	HW_BYTEORDER	 4		/* int: machine byte order */
923#define	HW_PHYSMEM	 5		/* int: total memory */
924#define	HW_USERMEM	 6		/* int: non-kernel memory */
925#define	HW_PAGESIZE	 7		/* int: software page size */
926#define	HW_DISKNAMES	 8		/* strings: disk drive names */
927#define	HW_DISKSTATS	 9		/* struct: diskstats[] */
928#define	HW_EPOCH  	10		/* int: 0 for Legacy, else NewWorld */
929#define HW_FLOATINGPT	11		/* int: has HW floating point? */
930#define HW_MACHINE_ARCH	12		/* string: machine architecture */
931#define HW_VECTORUNIT	13		/* int: has HW vector unit? */
932#define HW_BUS_FREQ	14		/* int: Bus Frequency */
933#define HW_CPU_FREQ	15		/* int: CPU Frequency */
934#define HW_CACHELINE	16		/* int: Cache Line Size in Bytes */
935#define HW_L1ICACHESIZE	17		/* int: L1 I Cache Size in Bytes */
936#define HW_L1DCACHESIZE	18		/* int: L1 D Cache Size in Bytes */
937#define HW_L2SETTINGS	19		/* int: L2 Cache Settings */
938#define HW_L2CACHESIZE	20		/* int: L2 Cache Size in Bytes */
939#define HW_L3SETTINGS	21		/* int: L3 Cache Settings */
940#define HW_L3CACHESIZE	22		/* int: L3 Cache Size in Bytes */
941#define HW_TB_FREQ	23		/* int: Bus Frequency */
942#define HW_MEMSIZE	24		/* uint64_t: physical ram size */
943#define HW_AVAILCPU	25		/* int: number of available CPUs */
944#define	HW_MAXID	26		/* number of valid hw ids */
945
946#define CTL_HW_NAMES { \
947	{ 0, 0 }, \
948	{ "machine", CTLTYPE_STRING }, \
949	{ "model", CTLTYPE_STRING }, \
950	{ "ncpu", CTLTYPE_INT }, \
951	{ "byteorder", CTLTYPE_INT }, \
952	{ "physmem", CTLTYPE_INT }, \
953	{ "usermem", CTLTYPE_INT }, \
954	{ "pagesize", CTLTYPE_INT }, \
955	{ "disknames", CTLTYPE_STRUCT }, \
956	{ "diskstats", CTLTYPE_STRUCT }, \
957	{ "epoch", CTLTYPE_INT }, \
958	{ "floatingpoint", CTLTYPE_INT }, \
959	{ "machinearch", CTLTYPE_STRING }, \
960	{ "vectorunit", CTLTYPE_INT }, \
961	{ "busfrequency", CTLTYPE_INT }, \
962	{ "cpufrequency", CTLTYPE_INT }, \
963	{ "cachelinesize", CTLTYPE_INT }, \
964	{ "l1icachesize", CTLTYPE_INT }, \
965	{ "l1dcachesize", CTLTYPE_INT }, \
966	{ "l2settings", CTLTYPE_INT }, \
967	{ "l2cachesize", CTLTYPE_INT }, \
968	{ "l3settings", CTLTYPE_INT }, \
969	{ "l3cachesize", CTLTYPE_INT }, \
970	{ "tbfrequency", CTLTYPE_INT }, \
971	{ "memsize", CTLTYPE_QUAD }, \
972	{ "availcpu", CTLTYPE_INT } \
973}
974
975/*
976 * XXX This information should be moved to the man page.
977 *
978 * These are the support HW selectors for sysctlbyname.  Parameters that are byte counts or frequencies are 64 bit numbers.
979 * All other parameters are 32 bit numbers.
980 *
981 *   hw.memsize                - The number of bytes of physical memory in the system.
982 *
983 *   hw.ncpu                   - The maximum number of processors that could be available this boot.
984 *                               Use this value for sizing of static per processor arrays; i.e. processor load statistics.
985 *
986 *   hw.activecpu              - The number of processors currently available for executing threads.
987 *                               Use this number to determine the number threads to create in SMP aware applications.
988 *                               This number can change when power management modes are changed.
989 *
990 *   hw.physicalcpu            - The number of physical processors available in the current power management mode.
991 *   hw.physicalcpu_max        - The maximum number of physical processors that could be available this boot
992 *
993 *   hw.logicalcpu             - The number of logical processors available in the current power management mode.
994 *   hw.logicalcpu_max         - The maximum number of logical processors that could be available this boot
995 *
996 *   hw.tbfrequency            - This gives the time base frequency used by the OS and is the basis of all timing services.
997 *                               In general is is better to use mach's or higher level timing services, but this value
998 *                               is needed to convert the PPC Time Base registers to real time.
999 *
1000 *   hw.cpufrequency           - These values provide the current, min and max cpu frequency.  The min and max are for
1001 *   hw.cpufrequency_max       - all power management modes.  The current frequency is the max frequency in the current mode.
1002 *   hw.cpufrequency_min       - All frequencies are in Hz.
1003 *
1004 *   hw.busfrequency           - These values provide the current, min and max bus frequency.  The min and max are for
1005 *   hw.busfrequency_max       - all power management modes.  The current frequency is the max frequency in the current mode.
1006 *   hw.busfrequency_min       - All frequencies are in Hz.
1007 *
1008 *   hw.cputype                - These values provide the mach-o cpu type and subtype.  A complete list is in <mach/machine.h>
1009 *   hw.cpusubtype             - These values should be used to determine what processor family the running cpu is from so that
1010 *                               the best binary can be chosen, or the best dynamic code generated.  They should not be used
1011 *                               to determine if a given processor feature is available.
1012 *   hw.cputhreadtype          - This value will be present if the processor supports threads.  Like hw.cpusubtype this selector
1013 *                               should not be used to infer features, and only used to name the processors thread architecture.
1014 *                               The values are defined in <mach/machine.h>
1015 *
1016 *   hw.byteorder              - Gives the byte order of the processor.  4321 for big endian, 1234 for little.
1017 *
1018 *   hw.pagesize               - Gives the size in bytes of the pages used by the processor and VM system.
1019 *
1020 *   hw.cachelinesize          - Gives the size in bytes of the processor's cache lines.
1021 *                               This value should be use to control the strides of loops that use cache control instructions
1022 *                               like dcbz, dcbt or dcbst.
1023 *
1024 *   hw.l1dcachesize           - These values provide the size in bytes of the L1, L2 and L3 caches.  If a cache is not present
1025 *   hw.l1icachesize           - then the selector will return and error.
1026 *   hw.l2cachesize            -
1027 *   hw.l3cachesize            -
1028 *
1029 *   hw.packages               - Gives the number of processor packages.
1030 *
1031 * These are the selectors for optional processor features for specific processors.  Selectors that return errors are not support
1032 * on the system.  Supported features will return 1 if they are recommended or 0 if they are supported but are not expected to help .
1033 * performance.  Future versions of these selectors may return larger values as necessary so it is best to test for non zero.
1034 *
1035 * For PowerPC:
1036 *
1037 *   hw.optional.floatingpoint - Floating Point Instructions
1038 *   hw.optional.altivec       - AltiVec Instructions
1039 *   hw.optional.graphicsops   - Graphics Operations
1040 *   hw.optional.64bitops      - 64-bit Instructions
1041 *   hw.optional.fsqrt         - HW Floating Point Square Root Instruction
1042 *   hw.optional.stfiwx        - Store Floating Point as Integer Word Indexed Instructions
1043 *   hw.optional.dcba          - Data Cache Block Allocate Instruction
1044 *   hw.optional.datastreams   - Data Streams Instructions
1045 *   hw.optional.dcbtstreams   - Data Cache Block Touch Steams Instruction Form
1046 *
1047 * For x86 Architecture:
1048 *
1049 *   hw.optional.floatingpoint     - Floating Point Instructions
1050 *   hw.optional.mmx               - Original MMX vector instructions
1051 *   hw.optional.sse               - Streaming SIMD Extensions
1052 *   hw.optional.sse2              - Streaming SIMD Extensions 2
1053 *   hw.optional.sse3              - Streaming SIMD Extensions 3
1054 *   hw.optional.supplementalsse3  - Supplemental Streaming SIMD Extensions 3
1055 *   hw.optional.x86_64            - 64-bit support
1056 */
1057
1058
1059/*
1060 * CTL_USER definitions
1061 */
1062#define	USER_CS_PATH		 1	/* string: _CS_PATH */
1063#define	USER_BC_BASE_MAX	 2	/* int: BC_BASE_MAX */
1064#define	USER_BC_DIM_MAX		 3	/* int: BC_DIM_MAX */
1065#define	USER_BC_SCALE_MAX	 4	/* int: BC_SCALE_MAX */
1066#define	USER_BC_STRING_MAX	 5	/* int: BC_STRING_MAX */
1067#define	USER_COLL_WEIGHTS_MAX	 6	/* int: COLL_WEIGHTS_MAX */
1068#define	USER_EXPR_NEST_MAX	 7	/* int: EXPR_NEST_MAX */
1069#define	USER_LINE_MAX		 8	/* int: LINE_MAX */
1070#define	USER_RE_DUP_MAX		 9	/* int: RE_DUP_MAX */
1071#define	USER_POSIX2_VERSION	10	/* int: POSIX2_VERSION */
1072#define	USER_POSIX2_C_BIND	11	/* int: POSIX2_C_BIND */
1073#define	USER_POSIX2_C_DEV	12	/* int: POSIX2_C_DEV */
1074#define	USER_POSIX2_CHAR_TERM	13	/* int: POSIX2_CHAR_TERM */
1075#define	USER_POSIX2_FORT_DEV	14	/* int: POSIX2_FORT_DEV */
1076#define	USER_POSIX2_FORT_RUN	15	/* int: POSIX2_FORT_RUN */
1077#define	USER_POSIX2_LOCALEDEF	16	/* int: POSIX2_LOCALEDEF */
1078#define	USER_POSIX2_SW_DEV	17	/* int: POSIX2_SW_DEV */
1079#define	USER_POSIX2_UPE		18	/* int: POSIX2_UPE */
1080#define	USER_STREAM_MAX		19	/* int: POSIX2_STREAM_MAX */
1081#define	USER_TZNAME_MAX		20	/* int: POSIX2_TZNAME_MAX */
1082#define	USER_MAXID		21	/* number of valid user ids */
1083
1084#define	CTL_USER_NAMES { \
1085	{ 0, 0 }, \
1086	{ "cs_path", CTLTYPE_STRING }, \
1087	{ "bc_base_max", CTLTYPE_INT }, \
1088	{ "bc_dim_max", CTLTYPE_INT }, \
1089	{ "bc_scale_max", CTLTYPE_INT }, \
1090	{ "bc_string_max", CTLTYPE_INT }, \
1091	{ "coll_weights_max", CTLTYPE_INT }, \
1092	{ "expr_nest_max", CTLTYPE_INT }, \
1093	{ "line_max", CTLTYPE_INT }, \
1094	{ "re_dup_max", CTLTYPE_INT }, \
1095	{ "posix2_version", CTLTYPE_INT }, \
1096	{ "posix2_c_bind", CTLTYPE_INT }, \
1097	{ "posix2_c_dev", CTLTYPE_INT }, \
1098	{ "posix2_char_term", CTLTYPE_INT }, \
1099	{ "posix2_fort_dev", CTLTYPE_INT }, \
1100	{ "posix2_fort_run", CTLTYPE_INT }, \
1101	{ "posix2_localedef", CTLTYPE_INT }, \
1102	{ "posix2_sw_dev", CTLTYPE_INT }, \
1103	{ "posix2_upe", CTLTYPE_INT }, \
1104	{ "stream_max", CTLTYPE_INT }, \
1105	{ "tzname_max", CTLTYPE_INT } \
1106}
1107
1108
1109
1110/*
1111 * CTL_DEBUG definitions
1112 *
1113 * Second level identifier specifies which debug variable.
1114 * Third level identifier specifies which stucture component.
1115 */
1116#define	CTL_DEBUG_NAME		0	/* string: variable name */
1117#define	CTL_DEBUG_VALUE		1	/* int: variable value */
1118#define	CTL_DEBUG_MAXID		20
1119
1120
1121#if (CTL_MAXID != 9) || (KERN_MAXID != 72) || (VM_MAXID != 6) || (HW_MAXID != 26) || (USER_MAXID != 21) || (CTL_DEBUG_MAXID != 20)
1122#error Use the SYSCTL_*() macros and OID_AUTO instead!
1123#endif
1124
1125
1126#ifdef	KERNEL
1127
1128#ifdef BSD_KERNEL_PRIVATE
1129extern char	machine[];
1130extern char	osrelease[];
1131extern char	ostype[];
1132extern char	osversion[];
1133
1134struct linker_set;
1135
1136void	sysctl_register_set(const char *set);
1137void	sysctl_unregister_set(const char *set);
1138void	sysctl_mib_init(void);
1139
1140int sysctl_int(user_addr_t, size_t *, user_addr_t, size_t, int *);
1141int sysctl_quad(user_addr_t, size_t *, user_addr_t, size_t, quad_t *);
1142
1143void sysctl_register_all(void);
1144
1145#endif /* BSD_KERNEL_PRIVATE */
1146#else	/* !KERNEL */
1147
1148__BEGIN_DECLS
1149int	sysctl(int *, u_int, void *, size_t *, void *, size_t);
1150int	sysctlbyname(const char *, void *, size_t *, void *, size_t);
1151int	sysctlnametomib(const char *, int *, size_t *);
1152__END_DECLS
1153
1154#endif	/* KERNEL */
1155
1156
1157#endif /* SYSCTL_DEF_ENABLED */
1158
1159
1160#endif	/* !_SYS_SYSCTL_H_ */
1161