/*
- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @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_
#include <sys/proc.h>
#include <sys/vm.h>
-#ifdef BSD_KERNEL_PRIVATE
+#ifdef XNU_KERNEL_PRIVATE
#include <sys/linker_set.h>
#endif
* 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, please 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
+ * both the kernel funnel and the sysctl memlock. This is not
+ * optimal, so it is best to handle locking yourself.
*/
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 (highly encouraged) */
/*
* 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
#define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \
struct sysctl_req *req)
+/*
+ * Locking and stats
+ */
+struct sysctl_lock {
+ int sl_lock;
+ int sl_want;
+ int sl_locked;
+};
+
+#define MEMLOCK_LOCK() \
+ do { \
+ while (memlock.sl_lock) { \
+ memlock.sl_want = 1; \
+ (void) tsleep((caddr_t)&memlock, PRIBIO+1, "sysctl", 0); \
+ memlock.sl_locked++; \
+ } \
+ memlock.sl_lock = 1; \
+ } while(0)
+
+#define MEMLOCK_UNLOCK() \
+ do { \
+ memlock.sl_lock = 0; \
+ if (memlock.sl_want) { \
+ memlock.sl_want = 0; \
+ wakeup((caddr_t)&memlock); \
+ } \
+ }while(0)
+
/*
* 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.
#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
/* This constructs a "raw" MIB oid. */
#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr) \
- struct sysctl_oid sysctl_##parent##_##name = { \
+ struct sysctl_oid sysctl_##parent##_##name = { \
&sysctl_##parent##_children, { 0 }, \
- nbr, kind, a1, a2, #name, handler, fmt };
-
+ nbr, kind, a1, a2, #name, handler, fmt }; \
+ 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_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)
-
/* Oid for an opaque object. Specified by a pointer and a length. */
#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr) \
SYSCTL_OID(parent, nbr, name, CTLTYPE_OPAQUE|access, \
#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: System V IPC information */
#define KERN_AFFINITY 43 /* xxx */
-#define KERN_CLASSIC 44 /* xxx */
-#define KERN_CLASSICHANDLER 45 /* xxx */
+#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 */
#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_MAXID 60 /* number of valid kern ids */
+#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? */
+#define KERN_LCTX 67 /* node: 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_MAXID 71 /* 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
#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_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_IMAGE 2 /* panic UI in 8-bit kraw format */
-/*
- * 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 CTL_KERN_NAMES { \
{ 0, 0 }, \
{ "ostype", CTLTYPE_STRING }, \
{ "logsigexit", CTLTYPE_INT }, \
{ "symfile",CTLTYPE_STRING },\
{ "procargs",CTLTYPE_STRUCT },\
- { "pcsamples",CTLTYPE_STRUCT },\
+ { "dummy", CTLTYPE_INT }, /* deprecated pcsamples */ \
{ "netboot", CTLTYPE_INT }, \
{ "panicinfo", CTLTYPE_NODE }, \
{ "sysv", CTLTYPE_NODE }, \
{ "dummy", CTLTYPE_INT }, \
{ "dummy", CTLTYPE_INT }, \
- { "dummy", CTLTYPE_INT }, \
+ { "exec", CTLTYPE_NODE }, \
{ "aiomax", CTLTYPE_INT }, \
{ "aioprocmax", CTLTYPE_INT }, \
{ "aiothreads", CTLTYPE_INT }, \
{ "proc_low_pri_io", CTLTYPE_INT }, \
{ "low_pri_window", CTLTYPE_INT }, \
{ "low_pri_delay", CTLTYPE_INT }, \
- { "posix", CTLTYPE_NODE } \
+ { "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 }, \
+ { "lctx", CTLTYPE_NODE }, \
+ { "rage_vnode", CTLTYPE_INT }, \
+ { "tty", CTLTYPE_NODE }, \
+ { "check_openevt", CTLTYPE_INT } \
}
/*
#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 */
+
+/*
+ * KERN_LCTX subtypes
+ */
+#define KERN_LCTX_ALL 0 /* everything */
+#define KERN_LCTX_LCID 1 /* by login context id */
/*
* KERN_PROC subtype ops return arrays of augmented proc structures:
#define EPROC_SLEADER 0x02 /* session leader */
#define COMAPT_MAXLOGNAME 12
char e_login[COMAPT_MAXLOGNAME]; /* short setlogin() name */
+#if CONFIG_LCTX
+ pid_t e_lcid;
+ int32_t e_spare[3];
+#else
int32_t e_spare[4];
+#endif
} kp_eproc;
};
+struct kinfo_lctx {
+ pid_t id; /* Login Context ID */
+ int mc; /* Member Count */
+};
+
#ifdef BSD_KERNEL_PRIVATE
#include <sys/proc_internal.h>
-// LP64todo - should this move?
-
/* LP64 version of _pcred. all pointers
* grow when we're dealing with a 64-bit process.
* WARNING - keep in sync with _pcred
*/
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=natural
-#endif
-
struct user_pcred {
char pc_lock[72]; /* opaque content */
user_addr_t pc_ucred; /* Current credentials. */
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. */
+ int p_refcnt __attribute((aligned(8))); /* Number of references. */
};
/* LP64 version of kinfo_proc. all pointers
short e_jobc; /* job control counter */
dev_t e_tdev; /* controlling tty dev */
pid_t e_tpgid; /* tty process group id */
- user_addr_t e_tsess; /* tty session pointer */
+ user_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_xswrss;
int32_t e_flag;
char e_login[COMAPT_MAXLOGNAME]; /* short setlogin() name */
+#if CONFIG_LCTX
+ pid_t e_lcid;
+ int32_t e_spare[3];
+#else
int32_t e_spare[4];
+#endif
} kp_eproc;
};
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=reset
-#endif
-
#endif /* BSD_KERNEL_PRIVATE */
#endif /* __APPLE_API_UNSTABLE */
#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
{ "vmmeter", CTLTYPE_STRUCT }, \
{ "loadavg", CTLTYPE_STRUCT }, \
{ 0, 0 }, /* placeholder for "3" (see comment above) */ \
- { "machfactor", CTLTYPE_STRUCT }, \
+ { "dummy", CTLTYPE_INT }, \
{ "swapusage", CTLTYPE_STRUCT } \
}
extern struct loadavg averunnable;
#define LSCALE 1000 /* scaling for "fixed point" arithmetic */
-// LP64todo - should this move?
#ifdef BSD_KERNEL_PRIVATE
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=natural
-#endif
struct user_loadavg {
fixpt_t ldavg[3];
- user_long_t fscale;
+ user_long_t fscale __attribute((aligned(8)));
};
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=reset
-#endif
-
#endif /* BSD_KERNEL_PRIVATE */
#endif /* __APPLE_API_PRIVATE */
}
/*
+ * 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.l2cachesize -
* hw.l3cachesize -
*
+ * hw.packages - Gives the number of processor packages.
*
- * 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.
+ * 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.
+ *
+ * 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
+
+#if (CTL_MAXID != 9) || (KERN_MAXID != 71) || (VM_MAXID != 6) || (HW_MAXID != 26) || (USER_MAXID != 21) || (CTL_DEBUG_MAXID != 20)
+#error Use the SYSCTL_*() macros and OID_AUTO instead!
+#endif
+
+
#ifdef KERNEL
#ifdef DEBUG
/*
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_mib_init(void);
+void sysctl_register_set(const char *set);
+void sysctl_unregister_set(const char *set);
+void sysctl_mib_init(void) __attribute__((section("__TEXT, initcode")));
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, user_addr_t old,
int sysctl_int(user_addr_t, size_t *, user_addr_t, size_t, int *);
int sysctl_rdint(user_addr_t, size_t *, user_addr_t, int);
int sysctl_quad(user_addr_t, size_t *, user_addr_t, size_t, quad_t *);
-int sysctl_rdquad(void *, size_t *, void *, quad_t);
+int sysctl_rdquad(user_addr_t, size_t *, user_addr_t, quad_t);
int sysctl_string(user_addr_t, size_t *, user_addr_t, size_t, char *, int);
int sysctl_trstring(user_addr_t, size_t *, user_addr_t, size_t, char *, int);
int sysctl_rdstring(user_addr_t, size_t *, user_addr_t, char *);
int sysctl_rdstruct(user_addr_t, size_t *, user_addr_t, void *, int);
+/* XXX should be in <sys/sysproto.h>, but not a real system call */
+struct sysctl_args;
+int new_sysctl(struct proc *, struct sysctl_args *);
+
+void sysctl_register_all(void);
+
#endif /* BSD_KERNEL_PRIVATE */
#else /* !KERNEL */