/*
- * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
- *
- * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* Please see the License for the specific language governing rights and
* limitations under the License.
*
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
*
* @(#)sysctl.h 8.1 (Berkeley) 6/2/93
*/
+/*
+ * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
+ * support for mandatory and extensible security protections. This notice
+ * is included in support of clause 2.2 (b) of the Apple Public License,
+ * Version 2.0.
+ */
#ifndef _SYS_SYSCTL_H_
#define _SYS_SYSCTL_H_
/*
* These are for the eproc structure defined below.
*/
+#include <sys/cdefs.h>
+
#include <sys/appleapiopts.h>
#ifndef KERNEL
#include <sys/time.h>
#include <sys/ucred.h>
+#else
+#ifndef XNU_KERNEL_PRIVATE
+#include <libkern/sysctl.h>
+#endif
#endif
-
-#include <sys/vm.h>
#include <sys/proc.h>
+#include <sys/vm.h>
+
+#ifdef XNU_KERNEL_PRIVATE
#include <sys/linker_set.h>
+#endif
/*
* Definitions for sysctl call. The sysctl call uses a hierarchical name
* levels defined below it, or it is a leaf of some particular
* type given below. Each sysctl level defines a set of name/type
* pairs to be used by sysctl(1) in manipulating the subsystem.
+ *
+ * When declaring new sysctl names, use the CTLFLAG_LOCKED flag in the
+ * type to indicate that all necessary locking will be handled
+ * within the sysctl.
+ *
+ * Any sysctl defined without CTLFLAG_LOCKED is considered legacy
+ * and will be protected by a global mutex.
+ *
+ * Note: This is not optimal, so it is best to handle locking
+ * yourself, if you are able to do so. A simple design
+ * pattern for use to avoid in a single function known
+ * to potentially be in the paging path ot doing a DMA
+ * to physical memory in a user space process is:
+ *
+ * lock
+ * perform operation vs. local buffer
+ * unlock
+ * SYSCTL_OUT(rey, local buffer, length)
+ *
+ * ...this assumes you are not using a deep call graph
+ * or are unable to pass a local buffer address as a
+ * parameter into your deep call graph.
+ *
+ * Note that very large user buffers can fail the wire
+ * if to do so would require more physical pages than
+ * are available (the caller will get an ENOMEM error,
+ * see sysctl_mem_hold() for details).
*/
struct ctlname {
char *ctl_name; /* subsystem name */
#define CTLFLAG_MASKED 0x04000000 /* deprecated variable, do not display */
#define CTLFLAG_NOAUTO 0x02000000 /* do not auto-register */
#define CTLFLAG_KERN 0x01000000 /* valid inside the kernel */
+#define CTLFLAG_LOCKED 0x00800000 /* node will handle locking itself */
+#define CTLFLAG_OID2 0x00400000 /* struct sysctl_oid has version info */
/*
* USE THIS instead of a hardwired number from the categories below
* to get dynamically assigned sysctl entries using the linker-set
* technology. This is the way nearly all new sysctl variables should
* be implemented.
+ *
* e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
- */
+ *
+ * Note that linker set technology will automatically register all nodes
+ * declared like this on kernel initialization, UNLESS they are defined
+ * in I/O-Kit. In this case, you have to call sysctl_register_oid()
+ * manually - just like in a KEXT.
+ */
#define OID_AUTO (-1)
+#define OID_AUTO_START 100 /* conventional */
#ifdef KERNEL
-#ifdef __APPLE_API_UNSTABLE
#define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \
struct sysctl_req *req)
+
/*
* This describes the access space for a sysctl request. This is needed
* so that we can use the interface from the kernel or from user-space.
struct sysctl_req {
struct proc *p;
int lock;
- void *oldptr;
- size_t oldlen;
- size_t oldidx;
+ user_addr_t oldptr; /* pointer to user supplied buffer */
+ size_t oldlen; /* user buffer length (also returned) */
+ size_t oldidx; /* total data iteratively copied out */
int (*oldfunc)(struct sysctl_req *, const void *, size_t);
- void *newptr;
- size_t newlen;
- size_t newidx;
+ user_addr_t newptr; /* buffer containing new value */
+ size_t newlen; /* length of new value */
+ size_t newidx; /* total data iteratively copied in */
int (*newfunc)(struct sysctl_req *, void *, size_t);
};
SLIST_HEAD(sysctl_oid_list, sysctl_oid);
+#define SYSCTL_OID_VERSION 1 /* current OID structure version */
+
/*
* This describes one "oid" in the MIB tree. Potentially more nodes can
* be hidden behind it, expanded by the handler.
+ *
+ * NOTES: We implement binary comparibility between CTLFLAG_OID2 and
+ * pre-CTLFLAG_OID2 structure in sysctl_register_oid() and in
+ * sysctl_unregister_oid() using the fact that the fields up
+ * to oid_fmt are unchanged, and that the field immediately
+ * following is on an alignment boundary following a pointer
+ * type and is also a pointer. This lets us get the previous
+ * size of the structure, and the copy-cut-off point, using
+ * the offsetof() language primitive, and these values are
+ * used in conjunction with the fact that earlier and future
+ * statically compiled sysctl_oid structures are declared via
+ * macros. This lets us overload the macros so that the addition
+ * of the CTLFLAG_OID2 in newly compiled code containing sysctl
+ * node declarations, subsequently allowing us to to avoid
+ * changing the KPI used for non-static (un)registration in
+ * KEXTs.
+ *
+ * This depends on the fact that people declare SYSCTLs,
+ * rather than declaring sysctl_oid structures. All new code
+ * should avoid declaring struct sysctl_oid's directly without
+ * the macros; the current risk for this is limited to losing
+ * your description field and ending up with a malloc'ed copy,
+ * as if it were a legacy binary static declaration via SYSCTL;
+ * in the future, we may deprecate access to a named structure
+ * type in third party code. Use the macros, or our code will
+ * end up with compile errors when that happens.
+ *
+ * Please try to include a long description of the field in any
+ * new sysctl declarations (all the macros support this). This
+ * field may be the only human readable documentation your users
+ * get for your sysctl.
*/
struct sysctl_oid {
struct sysctl_oid_list *oid_parent;
const char *oid_name;
int (*oid_handler) SYSCTL_HANDLER_ARGS;
const char *oid_fmt;
+ const char *oid_descr; /* offsetof() field / long description */
+ int oid_version;
+ int oid_refcnt;
};
#define SYSCTL_IN(r, p, l) (r->newfunc)(r, p, l)
#define SYSCTL_OUT(r, p, l) (r->oldfunc)(r, p, l)
+typedef int (* sysctl_handler_t) SYSCTL_HANDLER_ARGS;
+
+__BEGIN_DECLS
+
+/* old interface */
int sysctl_handle_int SYSCTL_HANDLER_ARGS;
int sysctl_handle_long SYSCTL_HANDLER_ARGS;
int sysctl_handle_quad SYSCTL_HANDLER_ARGS;
int sysctl_handle_int2quad SYSCTL_HANDLER_ARGS;
-/*int sysctl_handle_intptr SYSCTL_HANDLER_ARGS; XXX not implemented */
int sysctl_handle_string SYSCTL_HANDLER_ARGS;
int sysctl_handle_opaque SYSCTL_HANDLER_ARGS;
+/* new interface */
+int sysctl_io_number(struct sysctl_req *req, long long bigValue, size_t valueSize, void *pValue, int *changed);
+int sysctl_io_string(struct sysctl_req *req, char *pValue, size_t valueSize, int trunc, int *changed);
+int sysctl_io_opaque(struct sysctl_req *req, void *pValue, size_t valueSize, int *changed);
/*
* These functions are used to add/remove an oid from the mib.
void sysctl_register_oid(struct sysctl_oid *oidp);
void sysctl_unregister_oid(struct sysctl_oid *oidp);
+/* Not exported */
+void sysctl_register_fixed(void);
+
+__END_DECLS
+
/* Declare an oid to allow child oids to be added to it. */
#define SYSCTL_DECL(name) \
extern struct sysctl_oid_list sysctl_##name##_children
+#ifdef XNU_KERNEL_PRIVATE
+#define SYSCTL_LINKER_SET_ENTRY LINKER_SET_ENTRY
+#else
+#define SYSCTL_LINKER_SET_ENTRY(a, b)
+#endif
+/*
+ * Macros to define sysctl entries. Which to use? Pure data that are
+ * returned without modification, SYSCTL_<data type> is for you, like
+ * SYSCTL_QUAD for a 64-bit value. When you want to run a handler of your
+ * own, SYSCTL_PROC.
+ *
+ * parent: parent in name hierarchy (e.g. _kern for "kern")
+ * nbr: ID. Almost certainly OID_AUTO ("pick one for me") for you.
+ * name: name for this particular item (e.g. "thesysctl" for "kern.thesysctl")
+ * kind/access: Control flags (CTLFLAG_*). Some notable options include:
+ * CTLFLAG_ANYBODY: non-root users allowed
+ * CTLFLAG_MASKED: don't show in sysctl listing in userland
+ * CTLFLAG_LOCKED: does own locking (no additional protection needed)
+ * CTLFLAG_KERN: valid inside kernel (best avoided generally)
+ * CTLFLAG_WR: "new" value accepted
+ * a1, a2: entry-data, passed to handler (see specific macros)
+ * Format String: Tells "sysctl" tool how to print data from this entry.
+ * "A" - string
+ * "I" - list of integers. "IU" - list of unsigned integers. space-separated.
+ * "-" - do not print
+ * "L" - longs, as ints with I
+ * "P" - pointer
+ * "Q" - quads
+ * "S","T" - clock info, see sysctl.c in system_cmds (you probably don't need this)
+ * Description: unused
+ */
+
+
/* This constructs a "raw" MIB oid. */
-#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
- struct sysctl_oid sysctl_##parent##_##name = { \
- &sysctl_##parent##_children, { 0 }, \
- nbr, kind, a1, a2, #name, handler, fmt };
+#define SYSCTL_STRUCT_INIT(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
+ { \
+ &sysctl_##parent##_children, { 0 }, \
+ nbr, (int)(kind|CTLFLAG_OID2), a1, (int)(a2), #name, handler, fmt, descr, SYSCTL_OID_VERSION, 0 \
+ }
+#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
+ struct sysctl_oid sysctl_##parent##_##name = SYSCTL_STRUCT_INIT(parent, nbr, name, kind, a1, a2, handler, fmt, descr); \
+ SYSCTL_LINKER_SET_ENTRY(__sysctl_set, sysctl_##parent##_##name)
/* This constructs a node from which other oids can hang. */
#define SYSCTL_NODE(parent, nbr, name, access, handler, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_STRING|access, \
arg, len, sysctl_handle_string, "A", descr)
+#define SYSCTL_COMPAT_INT(parent, nbr, name, access, ptr, val, descr) \
+ SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
+ ptr, val, sysctl_handle_int, "I", descr)
+
+#define SYSCTL_COMPAT_UINT(parent, nbr, name, access, ptr, val, descr) \
+ SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
+ ptr, val, sysctl_handle_int, "IU", descr)
+
/* Oid for an int. If ptr is NULL, val is returned. */
#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
- ptr, val, sysctl_handle_int, "I", descr)
+ ptr, val, sysctl_handle_int, "I", descr); \
+ typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(int)) ? 0 : -1];
/* Oid for an unsigned int. If ptr is NULL, val is returned. */
#define SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
- ptr, val, sysctl_handle_int, "IU", descr)
+ ptr, val, sysctl_handle_int, "IU", descr); \
+ typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(unsigned int)) ? 0 : -1];
/* Oid for a long. The pointer must be non NULL. */
#define SYSCTL_LONG(parent, nbr, name, access, ptr, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_INT|access, \
- ptr, 0, sysctl_handle_long, "L", descr)
+ ptr, 0, sysctl_handle_long, "L", descr); \
+ typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(long)) ? 0 : -1];
/* Oid for a quad. The pointer must be non NULL. */
#define SYSCTL_QUAD(parent, nbr, name, access, ptr, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|access, \
- ptr, 0, sysctl_handle_quad, "Q", descr)
-
-/* Oid for a int returned as quad. The pointer must be non NULL. */
-#define SYSCTL_INT2QUAD(parent, nbr, name, access, ptr, descr) \
- SYSCTL_OID(parent, nbr, name, CTLTYPE_QUAD|access, \
- ptr, 0, sysctl_handle_int2quad, "Q", descr)
+ ptr, 0, sysctl_handle_quad, "Q", descr); \
+ typedef char _sysctl_##parent##_##name##_size_check[(__builtin_constant_p(ptr) || sizeof(*(ptr)) == sizeof(long long)) ? 0 : -1];
/* Oid for an opaque object. Specified by a pointer and a length. */
#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
ptr, sizeof(struct type), sysctl_handle_opaque, \
"S," #type, descr)
-/* Oid for a procedure. Specified by a pointer and an arg. */
+/*
+ * Oid for a procedure. Specified by a pointer and an arg.
+ * CTLTYPE_* macros can determine how the "sysctl" tool deals with
+ * input (e.g. converting to int).
+ */
#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr) \
SYSCTL_OID(parent, nbr, name, access, \
ptr, arg, handler, fmt, descr)
-#endif /* __APPLE_API_UNSTABLE */
+
+
+extern struct sysctl_oid_list sysctl__children;
+SYSCTL_DECL(_kern);
+SYSCTL_DECL(_sysctl);
+SYSCTL_DECL(_vm);
+SYSCTL_DECL(_vfs);
+SYSCTL_DECL(_net);
+SYSCTL_DECL(_debug);
+SYSCTL_DECL(_hw);
+SYSCTL_DECL(_machdep);
+SYSCTL_DECL(_user);
+
#endif /* KERNEL */
+#ifdef XNU_KERNEL_PRIVATE
+#define SYSCTL_DEF_ENABLED
+#else
+#ifndef KERNEL
+#define SYSCTL_DEF_ENABLED
+#endif
+#endif
+
+#ifdef SYSCTL_DEF_ENABLED
/*
* Top-level identifiers
*/
#define KERN_MAXFILESPERPROC 29 /* int: max open files per proc */
#define KERN_MAXPROCPERUID 30 /* int: max processes per uid */
#define KERN_DUMPDEV 31 /* dev_t: device to dump on */
-#define KERN_IPC 32 /* node: anything related to IPC */
-#define KERN_DUMMY 33 /* unused */
-#define KERN_PS_STRINGS 34 /* int: address of PS_STRINGS */
-#define KERN_USRSTACK 35 /* int: address of USRSTACK */
-#define KERN_LOGSIGEXIT 36 /* int: do we log sigexit procs? */
+#define KERN_IPC 32 /* node: anything related to IPC */
+#define KERN_DUMMY 33 /* unused */
+#define KERN_PS_STRINGS 34 /* int: address of PS_STRINGS */
+#define KERN_USRSTACK32 35 /* int: address of USRSTACK */
+#define KERN_LOGSIGEXIT 36 /* int: do we log sigexit procs? */
#define KERN_SYMFILE 37 /* string: kernel symbol filename */
#define KERN_PROCARGS 38
-#define KERN_PCSAMPLES 39 /* node: pc sampling */
+ /* 39 was KERN_PCSAMPLES... now deprecated */
#define KERN_NETBOOT 40 /* int: are we netbooted? 1=yes,0=no */
-#define KERN_PANICINFO 41 /* node: panic UI information */
-#define KERN_SYSV 42 /* node: panic UI information */
+ /* 41 was KERN_PANICINFO : panic UI information (deprecated) */
+#define KERN_SYSV 42 /* node: System V IPC information */
#define KERN_AFFINITY 43 /* xxx */
-#define KERN_CLASSIC 44 /* xxx */
-#define KERN_CLASSICHANDLER 45 /* xxx */
-#define KERN_AIOMAX 46 /* int: max aio requests */
+#define KERN_TRANSLATE 44 /* xxx */
+#define KERN_CLASSIC KERN_TRANSLATE /* XXX backwards compat */
+#define KERN_EXEC 45 /* xxx */
+#define KERN_CLASSICHANDLER KERN_EXEC /* XXX backwards compatibility */
+#define KERN_AIOMAX 46 /* int: max aio requests */
#define KERN_AIOPROCMAX 47 /* int: max aio requests per process */
#define KERN_AIOTHREADS 48 /* int: max aio worker threads */
#ifdef __APPLE_API_UNSTABLE
-#define KERN_PROCARGS2 49 /* number of valid kern ids */
+#define KERN_PROCARGS2 49
#endif /* __APPLE_API_UNSTABLE */
-#define KERN_MAXID 50 /* number of valid kern ids */
+#define KERN_COREFILE 50 /* string: corefile format string */
+#define KERN_COREDUMP 51 /* int: whether to coredump at all */
+#define KERN_SUGID_COREDUMP 52 /* int: whether to dump SUGID cores */
+#define KERN_PROCDELAYTERM 53 /* int: set/reset current proc for delayed termination during shutdown */
+#define KERN_SHREG_PRIVATIZABLE 54 /* int: can shared regions be privatized ? */
+ /* 55 was KERN_PROC_LOW_PRI_IO... now deprecated */
+#define KERN_LOW_PRI_WINDOW 56 /* int: set/reset throttle window - milliseconds */
+#define KERN_LOW_PRI_DELAY 57 /* int: set/reset throttle delay - milliseconds */
+#define KERN_POSIX 58 /* node: posix tunables */
+#define KERN_USRSTACK64 59 /* LP64 user stack query */
+#define KERN_NX_PROTECTION 60 /* int: whether no-execute protection is enabled */
+#define KERN_TFP 61 /* Task for pid settings */
+#define KERN_PROCNAME 62 /* setup process program name(2*MAXCOMLEN) */
+#define KERN_THALTSTACK 63 /* for compat with older x86 and does nothing */
+#define KERN_SPECULATIVE_READS 64 /* int: whether speculative reads are disabled */
+#define KERN_OSVERSION 65 /* for build number i.e. 9A127 */
+#define KERN_SAFEBOOT 66 /* are we booted safe? */
+ /* 67 was KERN_LCTX (login context) */
+#define KERN_RAGEVNODE 68
+#define KERN_TTY 69 /* node: tty settings */
+#define KERN_CHECKOPENEVT 70 /* spi: check the VOPENEVT flag on vnodes at open time */
+#define KERN_THREADNAME 71 /* set/get thread name */
+#define KERN_MAXID 72 /* number of valid kern ids */
+/*
+ * Don't add any more sysctls like this. Instead, use the SYSCTL_*() macros
+ * and OID_AUTO. This will have the added benefit of not having to recompile
+ * sysctl(8) to pick up your changes.
+ */
+
+#if COUNT_SYSCALLS && defined(KERNEL)
+#define KERN_COUNT_SYSCALLS (KERN_OSTYPE + 1000) /* keep called count for each bsd syscall */
+#endif
+
+#if defined(__LP64__)
+#define KERN_USRSTACK KERN_USRSTACK64
+#else
+#define KERN_USRSTACK KERN_USRSTACK32
+#endif
+/* KERN_RAGEVNODE types */
+#define KERN_RAGE_PROC 1
+#define KERN_RAGE_THREAD 2
+#define KERN_UNRAGE_PROC 3
+#define KERN_UNRAGE_THREAD 4
+
+/* KERN_OPENEVT types */
+#define KERN_OPENEVT_PROC 1
+#define KERN_UNOPENEVT_PROC 2
+
+/* KERN_TFP types */
+#define KERN_TFP_POLICY 1
+
+/* KERN_TFP_POLICY values . All policies allow task port for self */
+#define KERN_TFP_POLICY_DENY 0 /* Deny Mode: None allowed except privileged */
+#define KERN_TFP_POLICY_DEFAULT 2 /* Default Mode: related ones allowed and upcall authentication */
+
/* KERN_KDEBUG types */
#define KERN_KDEFLAGS 1
#define KERN_KDDFLAGS 2
#define KERN_KDSETREG 8
#define KERN_KDGETREG 9
#define KERN_KDREADTR 10
-#define KERN_KDPIDTR 11
+#define KERN_KDPIDTR 11
#define KERN_KDTHRMAP 12
/* Don't use 13 as it is overloaded with KERN_VNODE */
#define KERN_KDPIDEX 14
#define KERN_KDSETRTCDEC 15
-#define KERN_KDGETENTROPY 16
-
-/* KERN_PCSAMPLES types */
-#define KERN_PCDISABLE 1
-#define KERN_PCSETBUF 2
-#define KERN_PCGETBUF 3
-#define KERN_PCSETUP 4
-#define KERN_PCREMOVE 5
-#define KERN_PCREADBUF 6
-#define KERN_PCSETREG 7
-#define KERN_PCCOMM 8
-
-/* KERN_PANICINFO types */
-#define KERN_PANICINFO_MAXSIZE 1 /* quad: panic UI image size limit */
-#define KERN_PANICINFO_IMAGE16 2 /* string: path to the panic UI (16 bit) */
-#define KERN_PANICINFO_IMAGE32 3 /* string: path to the panic UI (32 bit) */
-
-/*
- * KERN_SYSV identifiers
- */
-#define KSYSV_SHMMAX 1 /* int: max shared memory segment size (bytes) */
-#define KSYSV_SHMMIN 2 /* int: min shared memory segment size (bytes) */
-#define KSYSV_SHMMNI 3 /* int: max number of shared memory identifiers */
-#define KSYSV_SHMSEG 4 /* int: max shared memory segments per process */
-#define KSYSV_SHMALL 5 /* int: max amount of shared memory (pages) */
-#define KSYSV_SEMMNI 6 /* int: max num of semaphore identifiers */
-#define KSYSV_SEMMNS 7 /* int: max num of semaphores in system */
-#define KSYSV_SEMMNU 8 /* int: max num of undo structures in system */
-#define KSYSV_SEMMSL 9 /* int: max num of semaphores per id */
-#define KSYSV_SEMUNE 10 /* int: max num of undo entries per process */
-
+#define KERN_KDGETENTROPY 16 /* Obsolescent */
+#define KERN_KDWRITETR 17
+#define KERN_KDWRITEMAP 18
+#define KERN_KDENABLE_BG_TRACE 19
+#define KERN_KDDISABLE_BG_TRACE 20
+#define KERN_KDREADCURTHRMAP 21
+#define KERN_KDSET_TYPEFILTER 22
+#define KERN_KDBUFWAIT 23
+#define KERN_KDCPUMAP 24
+#define KERN_KDWAIT_BG_TRACE_RESET 25
+#define KERN_KDSET_BG_TYPEFILTER 26
+#define KERN_KDWRITEMAP_V3 27
+#define KERN_KDWRITETR_V3 28
#define CTL_KERN_NAMES { \
{ 0, 0 }, \
{ "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \
{ "ipc", CTLTYPE_NODE }, \
{ "dummy", CTLTYPE_INT }, \
- { "ps_strings", CTLTYPE_INT }, \
+ { "dummy", CTLTYPE_INT }, \
{ "usrstack", CTLTYPE_INT }, \
{ "logsigexit", CTLTYPE_INT }, \
{ "symfile",CTLTYPE_STRING },\
{ "procargs",CTLTYPE_STRUCT },\
- { "pcsamples",CTLTYPE_STRUCT },\
+ { "dummy", CTLTYPE_INT }, /* deprecated pcsamples */ \
{ "netboot", CTLTYPE_INT }, \
- { "panicinfo", CTLTYPE_NODE }, \
+ { "dummy", CTLTYPE_INT }, /* deprecated: panicinfo */ \
{ "sysv", CTLTYPE_NODE }, \
{ "dummy", CTLTYPE_INT }, \
{ "dummy", CTLTYPE_INT }, \
- { "dummy", CTLTYPE_INT }, \
+ { "exec", CTLTYPE_NODE }, \
{ "aiomax", CTLTYPE_INT }, \
{ "aioprocmax", CTLTYPE_INT }, \
{ "aiothreads", CTLTYPE_INT }, \
- { "procargs2",CTLTYPE_STRUCT } \
+ { "procargs2",CTLTYPE_STRUCT }, \
+ { "corefile",CTLTYPE_STRING }, \
+ { "coredump", CTLTYPE_INT }, \
+ { "sugid_coredump", CTLTYPE_INT }, \
+ { "delayterm", CTLTYPE_INT }, \
+ { "shreg_private", CTLTYPE_INT }, \
+ { "proc_low_pri_io", CTLTYPE_INT }, \
+ { "low_pri_window", CTLTYPE_INT }, \
+ { "low_pri_delay", CTLTYPE_INT }, \
+ { "posix", CTLTYPE_NODE }, \
+ { "usrstack64", CTLTYPE_QUAD }, \
+ { "nx", CTLTYPE_INT }, \
+ { "tfp", CTLTYPE_NODE }, \
+ { "procname", CTLTYPE_STRING }, \
+ { "threadsigaltstack", CTLTYPE_INT }, \
+ { "speculative_reads_disabled", CTLTYPE_INT }, \
+ { "osversion", CTLTYPE_STRING }, \
+ { "safeboot", CTLTYPE_INT }, \
+ { "dummy", CTLTYPE_INT }, /* deprecated: lctx */ \
+ { "rage_vnode", CTLTYPE_INT }, \
+ { "tty", CTLTYPE_NODE }, \
+ { "check_openevt", CTLTYPE_INT }, \
+ { "thread_name", CTLTYPE_STRING } \
}
/*
#define KERN_PROC_TTY 4 /* by controlling tty */
#define KERN_PROC_UID 5 /* by effective uid */
#define KERN_PROC_RUID 6 /* by real uid */
+#define KERN_PROC_LCID 7 /* by login context id */
+#if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL)
/*
* KERN_PROC subtype ops return arrays of augmented proc structures:
*/
-#ifdef __APPLE_API_UNSTABLE
+
+struct _pcred {
+ char pc_lock[72]; /* opaque content */
+ struct ucred *pc_ucred; /* Current credentials. */
+ uid_t p_ruid; /* Real user id. */
+ uid_t p_svuid; /* Saved effective user id. */
+ gid_t p_rgid; /* Real group id. */
+ gid_t p_svgid; /* Saved effective group id. */
+ int p_refcnt; /* Number of references. */
+};
+
+struct _ucred {
+ int32_t cr_ref; /* reference count */
+ uid_t cr_uid; /* effective user id */
+ short cr_ngroups; /* number of groups */
+ gid_t cr_groups[NGROUPS]; /* groups */
+};
+
struct kinfo_proc {
struct extern_proc kp_proc; /* proc structure */
struct eproc {
struct proc *e_paddr; /* address of proc */
struct session *e_sess; /* session pointer */
- struct pcred e_pcred; /* process credentials */
- struct ucred e_ucred; /* current credentials */
+ struct _pcred e_pcred; /* process credentials */
+ struct _ucred e_ucred; /* current credentials */
struct vmspace e_vm; /* address space */
pid_t e_ppid; /* parent process id */
pid_t e_pgid; /* process group id */
short e_xrssize; /* text rss */
short e_xccount; /* text references */
short e_xswrss;
- long e_flag;
+ int32_t e_flag;
#define EPROC_CTTY 0x01 /* controlling tty vnode active */
#define EPROC_SLEADER 0x02 /* session leader */
#define COMAPT_MAXLOGNAME 12
char e_login[COMAPT_MAXLOGNAME]; /* short setlogin() name */
- long e_spare[4];
+ int32_t e_spare[4];
} kp_eproc;
};
-#endif /* __APPLE_API_UNSTABLE */
+
+#endif /* defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL) */
+
+#ifdef BSD_KERNEL_PRIVATE
+#include <sys/proc_internal.h>
+
+/* LP64 version of _pcred. all pointers
+ * grow when we're dealing with a 64-bit process.
+ * WARNING - keep in sync with _pcred
+ */
+
+struct user32_pcred {
+ char pc_lock[72]; /* opaque content */
+ user32_addr_t pc_ucred; /* Current credentials. */
+ uid_t p_ruid; /* Real user id. */
+ uid_t p_svuid; /* Saved effective user id. */
+ gid_t p_rgid; /* Real group id. */
+ gid_t p_svgid; /* Saved effective group id. */
+ int p_refcnt; /* Number of references. */
+};
+struct user64_pcred {
+ char pc_lock[72]; /* opaque content */
+ user64_addr_t pc_ucred; /* Current credentials. */
+ uid_t p_ruid; /* Real user id. */
+ uid_t p_svuid; /* Saved effective user id. */
+ gid_t p_rgid; /* Real group id. */
+ gid_t p_svgid; /* Saved effective group id. */
+ int p_refcnt; /* Number of references. */
+};
+
+/* LP64 version of kinfo_proc. all pointers
+ * grow when we're dealing with a 64-bit process.
+ * WARNING - keep in sync with kinfo_proc
+ */
+struct user32_kinfo_proc {
+ struct user32_extern_proc kp_proc; /* proc structure */
+ struct user32_eproc {
+ user32_addr_t e_paddr; /* address of proc */
+ user32_addr_t e_sess; /* session pointer */
+ struct user32_pcred e_pcred; /* process credentials */
+ struct _ucred e_ucred; /* current credentials */
+ struct user32_vmspace e_vm; /* address space */
+ pid_t e_ppid; /* parent process id */
+ pid_t e_pgid; /* process group id */
+ short e_jobc; /* job control counter */
+ dev_t e_tdev; /* controlling tty dev */
+ pid_t e_tpgid; /* tty process group id */
+ user32_addr_t e_tsess; /* tty session pointer */
+ char e_wmesg[WMESGLEN+1]; /* wchan message */
+ segsz_t e_xsize; /* text size */
+ short e_xrssize; /* text rss */
+ short e_xccount; /* text references */
+ short e_xswrss;
+ int32_t e_flag;
+ char e_login[COMAPT_MAXLOGNAME]; /* short setlogin() name */
+ int32_t e_spare[4];
+ } kp_eproc;
+};
+struct user64_kinfo_proc {
+ struct user64_extern_proc kp_proc; /* proc structure */
+ struct user64_eproc {
+ user_addr_t e_paddr; /* address of proc */
+ user_addr_t e_sess; /* session pointer */
+ struct user64_pcred e_pcred; /* process credentials */
+ struct _ucred e_ucred; /* current credentials */
+ struct user_vmspace e_vm; /* address space */
+ pid_t e_ppid; /* parent process id */
+ pid_t e_pgid; /* process group id */
+ short e_jobc; /* job control counter */
+ dev_t e_tdev; /* controlling tty dev */
+ pid_t e_tpgid; /* tty process group id */
+ user64_addr_t e_tsess __attribute((aligned(8))); /* tty session pointer */
+ char e_wmesg[WMESGLEN+1]; /* wchan message */
+ segsz_t e_xsize; /* text size */
+ short e_xrssize; /* text rss */
+ short e_xccount; /* text references */
+ short e_xswrss;
+ int32_t e_flag;
+ char e_login[COMAPT_MAXLOGNAME]; /* short setlogin() name */
+ int32_t e_spare[4];
+ } kp_eproc;
+};
+
+#endif /* BSD_KERNEL_PRIVATE */
/*
* KERN_IPC identifiers
#define KIPC_MAX_DATALEN 7 /* int: max length of data? */
#define KIPC_MBSTAT 8 /* struct: mbuf usage statistics */
#define KIPC_NMBCLUSTERS 9 /* int: maximum mbuf clusters */
+#define KIPC_SOQLIMITCOMPAT 10 /* int: socket queue limit */
/*
* CTL_VM identifiers
*/
#define VM_METER 1 /* struct vmmeter */
#define VM_LOADAVG 2 /* struct loadavg */
-#define VM_MAXID 3 /* number of valid vm ids */
+/*
+ * Note: "3" was skipped sometime ago and should probably remain unused
+ * to avoid any new entry from being accepted by older kernels...
+ */
#define VM_MACHFACTOR 4 /* struct loadavg with mach factor*/
+#define VM_SWAPUSAGE 5 /* total swap usage */
+#define VM_MAXID 6 /* number of valid vm ids */
#define CTL_VM_NAMES { \
{ 0, 0 }, \
{ "vmmeter", CTLTYPE_STRUCT }, \
- { "loadavg", CTLTYPE_STRUCT } \
+ { "loadavg", CTLTYPE_STRUCT }, \
+ { 0, 0 }, /* placeholder for "3" (see comment above) */ \
+ { "dummy", CTLTYPE_INT }, \
+ { "swapusage", CTLTYPE_STRUCT } \
}
+struct xsw_usage {
+ u_int64_t xsu_total;
+ u_int64_t xsu_avail;
+ u_int64_t xsu_used;
+ u_int32_t xsu_pagesize;
+ boolean_t xsu_encrypted;
+};
+
+#ifdef __APPLE_API_PRIVATE
+/* Load average structure. Use of fixpt_t assume <sys/types.h> in scope. */
+/* XXX perhaps we should protect fixpt_t, and define it here (or discard it) */
+struct loadavg {
+ fixpt_t ldavg[3];
+ long fscale;
+};
+extern struct loadavg averunnable;
+#define LSCALE 1000 /* scaling for "fixed point" arithmetic */
+
+#ifdef BSD_KERNEL_PRIVATE
+
+struct user32_loadavg {
+ fixpt_t ldavg[3];
+ user32_long_t fscale;
+};
+
+struct user64_loadavg {
+ fixpt_t ldavg[3];
+ user64_long_t fscale;
+};
+
+#endif /* BSD_KERNEL_PRIVATE */
+#endif /* __APPLE_API_PRIVATE */
+
+
/*
* CTL_HW identifiers
*/
}
/*
- * These are the support HW selectors for sysctlbyname. Parameters that are byte count or frequencies are 64 bit numbers.
+ * XXX This information should be moved to the man page.
+ *
+ * These are the support HW selectors for sysctlbyname. Parameters that are byte counts or frequencies are 64 bit numbers.
* All other parameters are 32 bit numbers.
*
* hw.memsize - The number of bytes of physical memory in the system.
*
- * hw.ncpu - The number maximum number of processor that could be available this boot.
+ * hw.ncpu - The maximum number of processors that could be available this boot.
* Use this value for sizing of static per processor arrays; i.e. processor load statistics.
*
- * hw.activecpu - The number of cpus currently available for executing threads.
+ * hw.activecpu - The number of processors currently available for executing threads.
* Use this number to determine the number threads to create in SMP aware applications.
* This number can change when power management modes are changed.
- *
+ *
+ * hw.physicalcpu - The number of physical processors available in the current power management mode.
+ * hw.physicalcpu_max - The maximum number of physical processors that could be available this boot
+ *
+ * hw.logicalcpu - The number of logical processors available in the current power management mode.
+ * hw.logicalcpu_max - The maximum number of logical processors that could be available this boot
+ *
* hw.tbfrequency - This gives the time base frequency used by the OS and is the basis of all timing services.
* In general is is better to use mach's or higher level timing services, but this value
* is needed to convert the PPC Time Base registers to real time.
* hw.cpusubtype - These values should be used to determine what processor family the running cpu is from so that
* the best binary can be chosen, or the best dynamic code generated. They should not be used
* to determine if a given processor feature is available.
+ * hw.cputhreadtype - This value will be present if the processor supports threads. Like hw.cpusubtype this selector
+ * should not be used to infer features, and only used to name the processors thread architecture.
+ * The values are defined in <mach/machine.h>
*
* hw.byteorder - Gives the byte order of the processor. 4321 for big endian, 1234 for little.
*
* hw.l2cachesize -
* hw.l3cachesize -
*
+ * hw.packages - Gives the number of processor packages.
+ *
+ * These are the selectors for optional processor features for specific processors. Selectors that return errors are not support
+ * on the system. Supported features will return 1 if they are recommended or 0 if they are supported but are not expected to help .
+ * performance. Future versions of these selectors may return larger values as necessary so it is best to test for non zero.
*
- * These are the selectors for optional processor features. Selectors that return errors are not support on the system.
- * Supported features will return 1 if they are recommended or 0 if they are supported but are not expected to help performance.
- * Future versions of these selectors may return larger values as necessary so it is best to test for non zero.
+ * For PowerPC:
*
* hw.optional.floatingpoint - Floating Point Instructions
* hw.optional.altivec - AltiVec Instructions
* hw.optional.datastreams - Data Streams Instructions
* hw.optional.dcbtstreams - Data Cache Block Touch Steams Instruction Form
*
+ * For x86 Architecture:
+ *
+ * hw.optional.floatingpoint - Floating Point Instructions
+ * hw.optional.mmx - Original MMX vector instructions
+ * hw.optional.sse - Streaming SIMD Extensions
+ * hw.optional.sse2 - Streaming SIMD Extensions 2
+ * hw.optional.sse3 - Streaming SIMD Extensions 3
+ * hw.optional.supplementalsse3 - Supplemental Streaming SIMD Extensions 3
+ * hw.optional.x86_64 - 64-bit support
*/
#define CTL_DEBUG_VALUE 1 /* int: variable value */
#define CTL_DEBUG_MAXID 20
-#ifdef KERNEL
-#ifdef __APPLE_API_UNSTABLE
-extern struct sysctl_oid_list sysctl__children;
-SYSCTL_DECL(_kern);
-SYSCTL_DECL(_sysctl);
-SYSCTL_DECL(_vm);
-SYSCTL_DECL(_vfs);
-SYSCTL_DECL(_net);
-SYSCTL_DECL(_debug);
-SYSCTL_DECL(_hw);
-SYSCTL_DECL(_machdep);
-SYSCTL_DECL(_user);
+#if (CTL_MAXID != 9) || (KERN_MAXID != 72) || (VM_MAXID != 6) || (HW_MAXID != 26) || (USER_MAXID != 21) || (CTL_DEBUG_MAXID != 20)
+#error Use the SYSCTL_*() macros and OID_AUTO instead!
+#endif
-#ifdef DEBUG
-/*
- * CTL_DEBUG variables.
- *
- * These are declared as separate variables so that they can be
- * individually initialized at the location of their associated
- * variable. The loader prevents multiple use by issuing errors
- * if a variable is initialized in more than one place. They are
- * aggregated into an array in debug_sysctl(), so that it can
- * conveniently locate them when querried. If more debugging
- * variables are added, they must also be declared here and also
- * entered into the array.
- */
-struct ctldebug {
- char *debugname; /* name of debugging variable */
- int *debugvar; /* pointer to debugging variable */
-};
-extern struct ctldebug debug0, debug1, debug2, debug3, debug4;
-extern struct ctldebug debug5, debug6, debug7, debug8, debug9;
-extern struct ctldebug debug10, debug11, debug12, debug13, debug14;
-extern struct ctldebug debug15, debug16, debug17, debug18, debug19;
-#endif /* DEBUG */
+#ifdef KERNEL
+#ifdef BSD_KERNEL_PRIVATE
extern char machine[];
extern char osrelease[];
extern char ostype[];
+extern char osversion[];
struct linker_set;
-void sysctl_register_set(struct linker_set *lsp);
-void sysctl_unregister_set(struct linker_set *lsp);
+void sysctl_register_set(const char *set);
+void sysctl_unregister_set(const char *set);
void sysctl_mib_init(void);
-int kernel_sysctl(struct proc *p, int *name, u_int namelen, void *old,
- size_t *oldlenp, void *newp, size_t newlen);
-int userland_sysctl(struct proc *p, int *name, u_int namelen, void *old,
- size_t *oldlenp, int inkernel, void *newp, size_t newlen,
- size_t *retval);
-
-/*
- * Sysctl handling within the kernel.
- *
- * May be called with either or no funnel held; will take and
- * switch funnels as required.
- */
-int sysctlbyname __P((const char *, void *, size_t *, void *, size_t));
-/*
- * Internal sysctl function calling convention:
- *
- * (*sysctlfn)(name, namelen, oldval, oldlenp, newval, newlen);
- *
- * The name parameter points at the next component of the name to be
- * interpreted. The namelen parameter is the number of integers in
- * the name.
- */
-typedef int (sysctlfn)
- __P((int *, u_int, void *, size_t *, void *, size_t, struct proc *));
+int sysctl_int(user_addr_t, size_t *, user_addr_t, size_t, int *);
+int sysctl_quad(user_addr_t, size_t *, user_addr_t, size_t, quad_t *);
-int sysctl_int __P((void *, size_t *, void *, size_t, int *));
-int sysctl_rdint __P((void *, size_t *, void *, int));
-int sysctl_quad __P((void *, size_t *, void *, size_t, quad_t *));
-int sysctl_rdquad __P((void *, size_t *, void *, quad_t));
-int sysctl_string __P((void *, size_t *, void *, size_t, char *, int));
-int sysctl_rdstring __P((void *, size_t *, void *, char *));
-int sysctl_rdstruct __P((void *, size_t *, void *, void *, int));
+void sysctl_register_all(void);
-#endif /* __APPLE_API_UNSTABLE */
+#endif /* BSD_KERNEL_PRIVATE */
#else /* !KERNEL */
-#include <sys/cdefs.h>
__BEGIN_DECLS
-int sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
-int sysctlbyname __P((const char *, void *, size_t *, void *, size_t));
-int sysctlnametomib __P((const char *, int *, size_t *));
+int sysctl(int *, u_int, void *, size_t *, void *, size_t);
+int sysctlbyname(const char *, void *, size_t *, void *, size_t);
+int sysctlnametomib(const char *, int *, size_t *);
__END_DECLS
+
#endif /* KERNEL */
+
+
+#endif /* SYSCTL_DEF_ENABLED */
+
+
#endif /* !_SYS_SYSCTL_H_ */
projects / apple / xnu.git / blobdiff