--- /dev/null
+/*
+ * Copyright (c) 2005-2006 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. 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
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
+ */
+
+#ifndef _DTRACE_GLUE_H
+#define _DTRACE_GLUE_H
+
+#ifdef KERNEL_BUILD
+
+#include <libkern/libkern.h>
+#include <kern/lock.h>
+#include <kern/locks.h>
+#include <kern/thread_call.h>
+#include <machine/machine_routines.h>
+#include <sys/syslog.h>
+#include <sys/ucred.h>
+#include <stdarg.h>
+#include <mach/kmod.h>
+#include <libkern/OSAtomic.h>
+
+#ifdef QUIET_PLEASE
+ #ifndef NULL
+ #define NULL ((void *)0) /* quiets many warnings */
+ #endif
+#endif
+
+/*
+ * cmn_err
+ */
+#define CE_CONT 0 /* continuation */
+#define CE_NOTE 1 /* notice */
+#define CE_WARN 2 /* warning */
+#define CE_PANIC 3 /* panic */
+#define CE_IGNORE 4 /* print nothing */
+
+extern void cmn_err( int, const char *, ... );
+
+/*
+ * pid/proc
+ */
+
+typedef struct proc SUN_PROC_T; /* Solaris proc_t is the struct. Darwin's proc_t is a pointer to it. */
+#define proc_t SUN_PROC_T /* replace all the original uses of (Solaris) proc_t */
+#define curproc ((struct proc *)current_proc()) /* Called from probe context, must blacklist */
+
+proc_t* sprlock(pid_t pid);
+void sprunlock(proc_t *p);
+
+/*
+ * uread/uwrite
+ */
+
+int uread(proc_t *p, void *buf, user_size_t len, user_addr_t a);
+int uwrite(proc_t *p, void *buf, user_size_t len, user_addr_t a);
+
+/*
+ * fuword / suword
+ */
+
+int fuword8(user_addr_t, uint8_t *);
+int fuword16(user_addr_t, uint16_t *);
+int fuword32(user_addr_t, uint32_t *);
+int fuword64(user_addr_t, uint64_t *);
+
+void fuword8_noerr(user_addr_t, uint8_t *);
+void fuword16_noerr(user_addr_t, uint16_t *);
+void fuword32_noerr(user_addr_t, uint32_t *);
+void fuword64_noerr(user_addr_t, uint64_t *);
+
+int suword64(user_addr_t, uint64_t value);
+int suword32(user_addr_t, uint32_t value);
+int suword16(user_addr_t, uint16_t value);
+int suword8(user_addr_t, uint8_t value);
+
+/*
+ * cpuvar
+ */
+extern lck_mtx_t cpu_lock;
+extern lck_mtx_t mod_lock;
+
+/*
+ * Per-CPU data.
+ */
+typedef struct cpu {
+ processorid_t cpu_id; /* CPU number */
+ struct cpu *cpu_next; /* next existing CPU */
+ lck_rw_t cpu_ft_lock; /* DTrace: fasttrap lock */
+ uintptr_t cpu_dtrace_caller; /* DTrace: caller, if any */
+ hrtime_t cpu_dtrace_chillmark; /* DTrace: chill mark time */
+ hrtime_t cpu_dtrace_chilled; /* DTrace: total chill time */
+ boolean_t cpu_dtrace_invop_underway; /* DTrace gaurds against invalid op re-entrancy */
+} cpu_t;
+
+extern cpu_t *cpu_list;
+
+/*
+ * The cpu_core structure consists of per-CPU state available in any context.
+ * On some architectures, this may mean that the page(s) containing the
+ * NCPU-sized array of cpu_core structures must be locked in the TLB -- it
+ * is up to the platform to assure that this is performed properly. Note that
+ * the structure is sized to avoid false sharing.
+ */
+#define CPU_CACHE_COHERENCE_SIZE 64
+#define CPUC_SIZE (sizeof (uint16_t))
+#define CPUC_PADSIZE CPU_CACHE_COHERENCE_SIZE - CPUC_SIZE
+
+typedef struct cpu_core {
+ uint16_t cpuc_dtrace_flags; /* DTrace flags */
+ uint8_t cpuc_pad[CPUC_PADSIZE]; /* padding */
+ uint64_t cpuc_dtrace_illval; /* DTrace illegal value */
+ lck_mtx_t cpuc_pid_lock; /* DTrace pid provider lock */
+} cpu_core_t;
+
+extern cpu_core_t *cpu_core; /* XXX TLB lockdown? */
+extern unsigned int real_ncpus;
+extern int cpu_number(void); /* XXX #include <kern/cpu_number.h>. Called from probe context, must blacklist. */
+
+#define CPU (&(cpu_list[cpu_number()])) /* Pointer to current CPU */
+#define CPU_ON_INTR(cpup) ml_at_interrupt_context() /* always invoked on current cpu */
+#define NCPU real_ncpus
+
+/*
+ * Routines used to register interest in cpu's being added to or removed
+ * from the system.
+ */
+typedef enum {
+ CPU_INIT,
+ CPU_CONFIG,
+ CPU_UNCONFIG,
+ CPU_ON,
+ CPU_OFF,
+ CPU_CPUPART_IN,
+ CPU_CPUPART_OUT
+} cpu_setup_t;
+
+typedef int cpu_setup_func_t(cpu_setup_t, int, void *);
+
+extern void register_cpu_setup_func(cpu_setup_func_t *, void *);
+extern void unregister_cpu_setup_func(cpu_setup_func_t *, void *);
+
+/*
+ * CPU_DTRACE
+ */
+
+/*
+ * DTrace flags.
+ */
+#define CPU_DTRACE_NOFAULT 0x0001 /* Don't fault */
+#define CPU_DTRACE_DROP 0x0002 /* Drop this ECB */
+#define CPU_DTRACE_BADADDR 0x0004 /* DTrace fault: bad address */
+#define CPU_DTRACE_BADALIGN 0x0008 /* DTrace fault: bad alignment */
+#define CPU_DTRACE_DIVZERO 0x0010 /* DTrace fault: divide by zero */
+#define CPU_DTRACE_ILLOP 0x0020 /* DTrace fault: illegal operation */
+#define CPU_DTRACE_NOSCRATCH 0x0040 /* DTrace fault: out of scratch */
+#define CPU_DTRACE_KPRIV 0x0080 /* DTrace fault: bad kernel access */
+#define CPU_DTRACE_UPRIV 0x0100 /* DTrace fault: bad user access */
+#define CPU_DTRACE_TUPOFLOW 0x0200 /* DTrace fault: tuple stack overflow */
+#if defined(__sparc)
+//#define CPU_DTRACE_FAKERESTORE 0x0400 /* pid provider hint to getreg */
+#endif
+#define CPU_DTRACE_USTACK_FP 0x0400 /* pid provider hint to ustack() */
+#define CPU_DTRACE_ENTRY 0x0800 /* pid provider hint to ustack() */
+
+#define CPU_DTRACE_FAULT (CPU_DTRACE_BADADDR | CPU_DTRACE_BADALIGN | \
+ CPU_DTRACE_DIVZERO | CPU_DTRACE_ILLOP | \
+ CPU_DTRACE_NOSCRATCH | CPU_DTRACE_KPRIV | \
+ CPU_DTRACE_UPRIV | CPU_DTRACE_TUPOFLOW)
+#define CPU_DTRACE_ERROR (CPU_DTRACE_FAULT | CPU_DTRACE_DROP)
+
+/*
+ * cred_t
+ */
+/* Privileges */
+#define PRIV_DTRACE_KERNEL 3
+#define PRIV_DTRACE_PROC 4
+#define PRIV_DTRACE_USER 5
+#define PRIV_PROC_OWNER 30
+#define PRIV_PROC_ZONE 35
+#define PRIV_ALL (-1) /* All privileges required */
+
+/* Privilege sets */
+#define PRIV_EFFECTIVE 0
+
+typedef struct ucred cred_t;
+#define cr_suid cr_svuid
+#define cr_sgid cr_svgid
+
+extern cred_t *dtrace_CRED(void); /* Safe to call from probe context. */
+#define CRED() kauth_cred_get() /* Can't be called from probe context! */
+extern int PRIV_POLICY_CHOICE(void *, int, int);
+extern int PRIV_POLICY_ONLY(void *, int, int);
+extern gid_t crgetgid(const cred_t *);
+extern uid_t crgetuid(const cred_t *);
+#define crgetzoneid(x) ((zoneid_t)0)
+
+#define crhold(a) {}
+#define crfree(a) {}
+
+/*
+ * "cyclic"
+ */
+#define CY_LOW_LEVEL 0
+#define CY_LOCK_LEVEL 1
+#define CY_HIGH_LEVEL 2
+#define CY_SOFT_LEVELS 2
+#define CY_LEVELS 3
+
+typedef uintptr_t cyclic_id_t;
+typedef cyclic_id_t *cyclic_id_list_t;
+typedef uint16_t cyc_level_t;
+typedef void (*cyc_func_t)(void *);
+
+#define CYCLIC_NONE ((cyclic_id_t)0)
+
+typedef struct cyc_time {
+ hrtime_t cyt_when;
+ hrtime_t cyt_interval;
+} cyc_time_t;
+
+typedef struct cyc_handler {
+ cyc_func_t cyh_func;
+ void *cyh_arg;
+ cyc_level_t cyh_level;
+} cyc_handler_t;
+
+typedef struct cyc_omni_handler {
+ void (*cyo_online)(void *, cpu_t *, cyc_handler_t *, cyc_time_t *);
+ void (*cyo_offline)(void *, cpu_t *, void *);
+ void *cyo_arg;
+} cyc_omni_handler_t;
+
+extern cyclic_id_t cyclic_add(cyc_handler_t *, cyc_time_t *);
+extern void cyclic_remove(cyclic_id_t);
+
+extern cyclic_id_list_t cyclic_add_omni(cyc_omni_handler_t *);
+extern void cyclic_remove_omni(cyclic_id_list_t);
+
+extern cyclic_id_t cyclic_timer_add(cyc_handler_t *, cyc_time_t *);
+extern void cyclic_timer_remove(cyclic_id_t);
+
+/*
+ * timeout / untimeout (converted to dtrace_timeout / dtrace_untimeout due to name collision)
+ */
+
+thread_call_t dtrace_timeout(void (*func)(void *, void *), void* arg, uint64_t nanos);
+
+/*
+ * ddi
+ */
+
+#define DDI_SUCCESS 0
+#define DDI_FAILURE -1
+
+#define DDI_DEV_T_NONE ((dev_t)-1)
+#define DDI_DEV_T_ANY ((dev_t)-2)
+#define DDI_MAJOR_T_UNKNOWN ((major_t)0)
+
+#define DDI_PSEUDO "ddi_pseudo"
+
+typedef enum {
+ DDI_ATTACH = 0,
+ DDI_RESUME = 1,
+ DDI_PM_RESUME = 2
+} ddi_attach_cmd_t;
+
+typedef enum {
+ DDI_DETACH = 0,
+ DDI_SUSPEND = 1,
+ DDI_PM_SUSPEND = 2,
+ DDI_HOTPLUG_DETACH = 3 /* detach, don't try to auto-unconfig */
+} ddi_detach_cmd_t;
+
+#define DDI_PROP_SUCCESS 0
+
+#define DDI_PROP_DONTPASS 1
+typedef uint_t major_t;
+typedef uint_t minor_t;
+
+typedef struct __dev_info *dev_info_t;
+
+extern void ddi_report_dev(dev_info_t *);
+extern int ddi_soft_state_init(void **, size_t, size_t);
+extern void *ddi_get_soft_state(void *, int);
+extern int ddi_soft_state_free(void *, int);
+extern int ddi_soft_state_zalloc(void *, int);
+extern void ddi_soft_state_fini(void **);
+
+int ddi_getprop(dev_t dev, dev_info_t *dip, int flags, const char *name, int defvalue);
+
+extern int ddi_prop_free(void *);
+extern int ddi_prop_lookup_int_array(dev_t, dev_info_t *, uint_t, char *, int **, uint_t *);
+
+extern int ddi_driver_major(dev_info_t *);
+
+extern int ddi_create_minor_node(dev_info_t *, const char *, int, minor_t, const char *, int);
+extern void ddi_remove_minor_node(dev_info_t *, char *);
+
+extern major_t getemajor(dev_t);
+extern minor_t getminor(dev_t);
+
+extern int _dtrace_dev;
+extern dev_t makedevice(major_t, minor_t);
+
+/*
+ * Kernel Debug Interface
+ */
+
+typedef enum kdi_dtrace_set {
+ KDI_DTSET_DTRACE_ACTIVATE,
+ KDI_DTSET_DTRACE_DEACTIVATE,
+ KDI_DTSET_KMDB_BPT_ACTIVATE,
+ KDI_DTSET_KMDB_BPT_DEACTIVATE
+} kdi_dtrace_set_t;
+
+extern int kdi_dtrace_set(kdi_dtrace_set_t);
+extern void debug_enter(char *);
+
+/*
+ * DTrace specific zone allocation
+ */
+
+/*
+ * To break dtrace memory usage out in a trackable
+ * fashion, uncomment the #define below. This will
+ * enable emulation of the general kalloc.XXX zones
+ * for most dtrace allocations. (kalloc.large is not
+ * emulated)
+ *
+ * #define DTRACE_MEMORY_ZONES 1
+ *
+ */
+
+#if defined(DTRACE_MEMORY_ZONES)
+void dtrace_alloc_init(void);
+void *dtrace_alloc(vm_size_t);
+void dtrace_free(void *, vm_size_t);
+#endif
+
+/*
+ * kmem
+ */
+
+#define KM_SLEEP 0x00000000
+#define KM_NOSLEEP 0x00000001
+
+typedef struct vmem vmem_t;
+typedef struct kmem_cache kmem_cache_t;
+
+#define kmem_alloc dt_kmem_alloc /* Avoid clash with Darwin's kmem_alloc */
+#define kmem_free dt_kmem_free /* Avoid clash with Darwin's kmem_free */
+#define kmem_zalloc dt_kmem_zalloc /* Avoid clash with Darwin's kmem_zalloc */
+extern void *dt_kmem_alloc(size_t, int);
+extern void dt_kmem_free(void *, size_t);
+extern void *dt_kmem_zalloc(size_t, int);
+
+extern void *dt_kmem_alloc_aligned(size_t, size_t, int);
+extern void *dt_kmem_zalloc_aligned(size_t, size_t, int);
+extern void dt_kmem_free_aligned(void*, size_t);
+
+extern kmem_cache_t *
+kmem_cache_create(char *, size_t, size_t, int (*)(void *, void *, int),
+ void (*)(void *, void *), void (*)(void *), void *, vmem_t *, int);
+extern void *kmem_cache_alloc(kmem_cache_t *, int);
+extern void kmem_cache_free(kmem_cache_t *, void *);
+extern void kmem_cache_destroy(kmem_cache_t *);
+
+/*
+ * kthread
+ */
+
+typedef struct _kthread kthread_t; /* For dtrace_vtime_switch(), dtrace_panicked and dtrace_errthread */
+
+/*
+ * Loadable Modules
+ */
+
+decl_simple_lock_data(extern,kmod_lock)
+
+/* Want to use Darwin's kmod_info in place of the Solaris modctl.
+ Can't typedef since the (many) usages in the code are "struct modctl *" */
+extern kmod_info_t *kmod;
+#define modctl kmod_info
+
+#define mod_modname name
+#define mod_loadcnt id
+#define mod_next next
+#define mod_loaded info_version /* XXX Is always > 0, hence TRUE */
+#define modules kmod
+
+/*
+ * proc
+ */
+
+#define DATAMODEL_MASK 0x0FF00000
+
+#define DATAMODEL_ILP32 0x00100000
+#define DATAMODEL_LP64 0x00200000
+
+#define DATAMODEL_NONE 0
+
+#if defined(__LP64__)
+#define DATAMODEL_NATIVE DATAMODEL_LP64
+#else
+#define DATAMODEL_NATIVE DATAMODEL_ILP32
+#endif /* __LP64__ */
+
+typedef unsigned int model_t; /* For dtrace_instr_size_isa() prototype in <sys/dtrace.h> */
+
+/*
+ * taskq
+ */
+
+#define TQ_SLEEP 0x00 /* Can block for memory */
+
+typedef uint_t pri_t;
+typedef struct taskq taskq_t;
+typedef void (task_func_t)(void *);
+typedef uintptr_t taskqid_t;
+
+extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
+extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
+extern void taskq_destroy(taskq_t *);
+
+extern pri_t maxclsyspri;
+
+/*
+ * vmem
+ */
+
+#define VMC_IDENTIFIER 0x00040000 /* not backed by memory */
+#define VM_SLEEP 0x00000000 /* same as KM_SLEEP */
+#define VM_BESTFIT 0x00000100
+
+extern void *vmem_alloc(vmem_t *, size_t, int);
+extern vmem_t *vmem_create(const char *, void *, size_t, size_t, void *,
+ void *, vmem_t *, size_t, int);
+extern void vmem_destroy(vmem_t *);
+extern void vmem_free(vmem_t *vmp, void *vaddr, size_t size);
+
+/*
+ * Atomic
+ */
+
+static inline void atomic_add_32( uint32_t *theValue, int32_t theAmount )
+{
+ (void)OSAddAtomic( theAmount, (SInt32 *)theValue );
+}
+
+/*
+ * Miscellaneous
+ */
+
+typedef uintptr_t pc_t;
+typedef uintptr_t greg_t; /* For dtrace_impl.h prototype of dtrace_getfp() */
+extern struct regs *find_user_regs( thread_t thread);
+extern vm_offset_t dtrace_get_cpu_int_stack_top(void);
+extern vm_offset_t max_valid_stack_address(void); /* kern/thread.h */
+extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va); /* machine/pmap.h */
+
+extern volatile int panicwait; /* kern/debug.c */
+#define panic_quiesce (panicwait)
+
+#define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
+
+extern void delay( int ); /* kern/clock.h */
+
+extern int vuprintf(const char *, va_list);
+
+extern boolean_t dtxnu_is_RAM_page(ppnum_t);
+
+extern hrtime_t dtrace_abs_to_nano(uint64_t);
+
+__private_extern__ char * strstr(const char *, const char *);
+
+#undef proc_t
+
+#endif /* KERNEL_BUILD */
+#endif /* _DTRACE_GLUE_H */
+
projects / apple / xnu.git / blobdiff