* 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.
+ * When declaring new sysctl names, unless your sysctl is callable
+ * from the paging path, 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 wiring the user process pages and,
+ * if it is a 32 bit legacy KEXT, by the obsolete kernel funnel.
+ *
+ * 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 (highly encouraged) */
+#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
#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
*/
struct sysctl_req {
struct proc *p;
- int lock;
- user_addr_t oldptr;
- size_t oldlen;
- size_t oldidx;
- int (*oldfunc)(struct sysctl_req *, const void *, size_t);
- user_addr_t newptr;
- size_t newlen;
- size_t newidx;
- int (*newfunc)(struct sysctl_req *, void *, size_t);
+ int lock;
+ 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);
+ 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_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 }; \
+ nbr, kind|CTLFLAG_OID2, a1, a2, #name, handler, fmt, descr, SYSCTL_OID_VERSION, 0 }; \
SYSCTL_LINKER_SET_ENTRY(__sysctl_set, sysctl_##parent##_##name)
/* This constructs a node from which other oids can hang. */
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)
+ 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) \
#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 ? */
-#define KERN_PROC_LOW_PRI_IO 55 /* int: set/reset current proc for low priority I/O */
+ /* 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_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 */
+#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
#define KERN_KDPIDEX 14
#define KERN_KDSETRTCDEC 15
#define KERN_KDGETENTROPY 16
+#define KERN_KDWRITETR 17
+#define KERN_KDWRITEMAP 18
+
/* KERN_PANICINFO types */
#define KERN_PANICINFO_MAXSIZE 1 /* quad: panic UI image size limit */
{ "lctx", CTLTYPE_NODE }, \
{ "rage_vnode", CTLTYPE_INT }, \
{ "tty", CTLTYPE_NODE }, \
- { "check_openevt", CTLTYPE_INT } \
+ { "check_openevt", CTLTYPE_INT }, \
+ { "thread_name", CTLTYPE_STRING } \
}
/*
#define KERN_LCTX_ALL 0 /* everything */
#define KERN_LCTX_LCID 1 /* 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 */
int mc; /* Member Count */
};
+#endif /* defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL) */
+
#ifdef BSD_KERNEL_PRIVATE
#include <sys/proc_internal.h>
* WARNING - keep in sync with _pcred
*/
-struct user_pcred {
+struct user32_pcred {
char pc_lock[72]; /* opaque content */
- user_addr_t pc_ucred; /* Current credentials. */
+ 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 __attribute((aligned(8))); /* Number of references. */
+ 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 user_kinfo_proc {
- struct user_extern_proc kp_proc; /* proc structure */
- struct user_eproc {
+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 */
+#if CONFIG_LCTX
+ pid_t e_lcid;
+ int32_t e_spare[3];
+#else
+ int32_t e_spare[4];
+#endif
+ } 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 user_pcred e_pcred; /* process credentials */
+ 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 */
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 __attribute((aligned(8))); /* tty session pointer */
+ 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 */
#endif /* BSD_KERNEL_PRIVATE */
-#endif /* __APPLE_API_UNSTABLE */
-
/*
* KERN_IPC identifiers
*/
#ifdef BSD_KERNEL_PRIVATE
-struct user_loadavg {
+struct user32_loadavg {
+ fixpt_t ldavg[3];
+ user32_long_t fscale;
+};
+
+struct user64_loadavg {
fixpt_t ldavg[3];
- user_long_t fscale __attribute((aligned(8)));
+ user64_long_t fscale;
};
#endif /* BSD_KERNEL_PRIVATE */
#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)
+#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 KERNEL
-#ifdef DEBUG
+#if DEBUG
/*
* CTL_DEBUG variables.
*
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,
- size_t *oldlenp, int inkernel, user_addr_t newp, size_t newlen,
+ size_t *oldlenp, user_addr_t newp, size_t newlen,
size_t *retval);
/*
projects / apple / xnu.git / blobdiff