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