[apple/xnu.git] / bsd / sys / dtrace_glue.h

/*
 * 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 <kern/thread.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>

#if defined(__i386__) || defined(__x86_64__)
#include <i386/mp.h>
#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
 */

/* Solaris proc_t is the struct. Darwin's proc_t is a pointer to it. */
#define proc_t struct proc /* Steer clear of the Darwin typedef for 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 dtrace_cpu {
	processorid_t   cpu_id;                    /* CPU number */
	struct dtrace_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 */
} dtrace_cpu_t;

extern dtrace_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

typedef struct cpu_core {
	uint64_t	cpuc_dtrace_illval;     /* DTrace illegal value */
	lck_mtx_t	cpuc_pid_lock;          /* DTrace pid provider lock */
	uint16_t	cpuc_dtrace_flags;      /* DTrace flags */
        uint64_t	cpuc_missing_tos;	/* Addr. of top most stack frame if missing */
        uint8_t		cpuc_pad[CPU_CACHE_COHERENCE_SIZE - sizeof(uint64_t) - sizeof(lck_mtx_t) - sizeof(uint16_t) - sizeof(uint64_t) ];	/* padding */
} cpu_core_t;

extern cpu_core_t *cpu_core;

extern unsigned int dtrace_max_cpus;		/* max number of enabled cpus */
#define NCPU	    dtrace_max_cpus

extern int cpu_number(void); /* From #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 */

/*
 * 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_BADSTACK 0x1000  /* DTrace fault: bad stack */

#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 | \
				CPU_DTRACE_BADSTACK)
#define	CPU_DTRACE_ERROR	(CPU_DTRACE_FAULT | CPU_DTRACE_DROP)

/*
 * Loadable Modules
 */

/* Keep the compiler happy */
struct dtrace_module_symbols;

/* Solaris' modctl structure, greatly simplified, shadowing parts of xnu kmod structure. */
typedef struct modctl {
	struct modctl	*mod_next;
	struct modctl	*mod_stale;     // stale module chain
	uint32_t	mod_id;		// the kext unique identifier
	char		mod_modname[KMOD_MAX_NAME];
	int		mod_loadcnt;
	char		mod_loaded;
	char		mod_flags;	// See flags below
	int		mod_nenabled;	// # of enabled DTrace probes in module
	vm_address_t	mod_address;	// starting address (of Mach-o header blob)
	vm_size_t	mod_size;	// total size (of blob)
	UUID		mod_uuid;
	struct dtrace_module_symbols* mod_user_symbols;
} modctl_t;

/* Definitions for mod_flags */
#define MODCTL_IS_MACH_KERNEL			0x01 // This module represents /mach_kernel
#define MODCTL_HAS_KERNEL_SYMBOLS		0x02 // Kernel symbols (nlist) are available
#define MODCTL_FBT_PROBES_PROVIDED      	0x04 // fbt probes have been provided
#define MODCTL_FBT_INVALID			0x08 // Module is invalid for fbt probes
#define MODCTL_SDT_PROBES_PROVIDED		0x10 // sdt probes have been provided
#define MODCTL_SDT_INVALID			0x20 // Module is invalid for sdt probes
#define MODCTL_HAS_UUID				0x40 // Module has UUID

/* Simple/singular mod_flags accessors */
#define MOD_IS_MACH_KERNEL(mod)			(mod->mod_flags & MODCTL_IS_MACH_KERNEL)
#define MOD_HAS_KERNEL_SYMBOLS(mod)		(mod->mod_flags & MODCTL_HAS_KERNEL_SYMBOLS)
#define MOD_HAS_USERSPACE_SYMBOLS(mod)		(mod->mod_user_symbols) /* No point in duplicating state in the flags bits */
#define MOD_FBT_PROBES_PROVIDED(mod)   		(mod->mod_flags & MODCTL_FBT_PROBES_PROVIDED)
#define MOD_FBT_INVALID(mod)			(mod->mod_flags & MODCTL_FBT_INVALID)
#define MOD_SDT_PROBES_PROVIDED(mod)   		(mod->mod_flags & MODCTL_SDT_PROBES_PROVIDED)
#define MOD_SDT_INVALID(mod)			(mod->mod_flags & MODCTL_SDT_INVALID)
#define MOD_HAS_UUID(mod)			(mod->mod_flags & MODCTL_HAS_UUID)

/* Compound accessors */
#define MOD_FBT_DONE(mod)			(MOD_FBT_PROBES_PROVIDED(mod) || MOD_FBT_INVALID(mod))
#define MOD_SDT_DONE(mod)			(MOD_SDT_PROBES_PROVIDED(mod) || MOD_SDT_INVALID(mod))
#define MOD_SYMBOLS_DONE(mod)			(MOD_FBT_DONE(mod) && MOD_SDT_DONE(mod))

extern modctl_t *dtrace_modctl_list;

/*
 * 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 *, dtrace_cpu_t *, cyc_handler_t *, cyc_time_t *);
	void (*cyo_offline)(void *, dtrace_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, const 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 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(const 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 */

/*
 * 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 *theAddress, int32_t theAmount )
{
	(void)OSAddAtomic( theAmount, theAddress );
}

#if defined(__i386__) || defined(__x86_64__)
static inline void atomic_add_64( uint64_t *theAddress, int64_t theAmount )
{
	(void)OSAddAtomic64( theAmount, (SInt64 *)theAddress );
}
#endif

/*
 * 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 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 hrtime_t dtrace_abs_to_nano(uint64_t);

__private_extern__ const char * strstr(const char *, const char *);

#undef proc_t

/*
 * Safe counted string compare against a literal string. The sizeof() intentionally
 * counts the trailing NUL, and so ensures that all the characters in the literal
 * can participate in the comparison.
 */
#define LIT_STRNEQL(s1, lit_s2) (0 == strncmp( (s1), (lit_s2), sizeof((lit_s2)) ))

/*
 * Safe counted string compare of a literal against the beginning of a string. Here
 * the sizeof() is reduced by 1 so that the trailing null of the literal does not
 * participate in the comparison.
 */
#define LIT_STRNSTART(s1, lit_s2) (0 == strncmp( (s1), (lit_s2), sizeof((lit_s2)) - 1 ))

#define KERNELBASE VM_MIN_KERNEL_ADDRESS
#endif /* KERNEL_BUILD */
#endif /* _DTRACE_GLUE_H */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* Copyright (c) 2005-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
	29	#ifndef _DTRACE_GLUE_H
	30	#define _DTRACE_GLUE_H
	31
	32	#ifdef KERNEL_BUILD
	33
	34	#include <libkern/libkern.h>
	35	#include <kern/lock.h>
	36	#include <kern/locks.h>
	37	#include <kern/thread_call.h>
4a3eedf9	38	#include <kern/thread.h>
2d21ac55 A	39	#include <machine/machine_routines.h>
	40	#include <sys/syslog.h>
	41	#include <sys/ucred.h>
	42	#include <stdarg.h>
	43	#include <mach/kmod.h>
	44	#include <libkern/OSAtomic.h>
	45
6d2010ae A	46	#if defined(__i386__) \|\| defined(__x86_64__)
	47	#include <i386/mp.h>
	48	#endif
	49
2d21ac55 A	50	/*
	51	* cmn_err
	52	*/
	53	#define CE_CONT 0 /* continuation */
	54	#define CE_NOTE 1 /* notice */
	55	#define CE_WARN 2 /* warning */
	56	#define CE_PANIC 3 /* panic */
	57	#define CE_IGNORE 4 /* print nothing */
	58
	59	extern void cmn_err( int, const char *, ... );
	60
	61	/*
	62	* pid/proc
	63	*/
	64
b0d623f7 A	65	/* Solaris proc_t is the struct. Darwin's proc_t is a pointer to it. */
b0d623f7 A	66	#define proc_t struct proc /* Steer clear of the Darwin typedef for proc_t */
2d21ac55 A	67	#define curproc ((struct proc )current_proc()) / Called from probe context, must blacklist */
	68
	69	proc_t* sprlock(pid_t pid);
	70	void sprunlock(proc_t *p);
	71
	72	/*
	73	* uread/uwrite
	74	*/
	75
	76	int uread(proc_t p, void buf, user_size_t len, user_addr_t a);
	77	int uwrite(proc_t p, void buf, user_size_t len, user_addr_t a);
	78
	79	/*
	80	* fuword / suword
	81	*/
	82
	83	int fuword8(user_addr_t, uint8_t *);
	84	int fuword16(user_addr_t, uint16_t *);
	85	int fuword32(user_addr_t, uint32_t *);
	86	int fuword64(user_addr_t, uint64_t *);
	87
	88	void fuword8_noerr(user_addr_t, uint8_t *);
	89	void fuword16_noerr(user_addr_t, uint16_t *);
	90	void fuword32_noerr(user_addr_t, uint32_t *);
	91	void fuword64_noerr(user_addr_t, uint64_t *);
	92
	93	int suword64(user_addr_t, uint64_t value);
	94	int suword32(user_addr_t, uint32_t value);
	95	int suword16(user_addr_t, uint16_t value);
	96	int suword8(user_addr_t, uint8_t value);
	97
	98	/*
	99	* cpuvar
	100	*/
	101	extern lck_mtx_t cpu_lock;
	102	extern lck_mtx_t mod_lock;
	103
	104	/*
	105	* Per-CPU data.
	106	*/
6d2010ae	107	typedef struct dtrace_cpu {
2d21ac55	108	processorid_t cpu_id; /* CPU number */
6d2010ae	109	struct dtrace_cpu cpu_next; / next existing CPU */
2d21ac55 A	110	lck_rw_t cpu_ft_lock; /* DTrace: fasttrap lock */
	111	uintptr_t cpu_dtrace_caller; /* DTrace: caller, if any */
	112	hrtime_t cpu_dtrace_chillmark; /* DTrace: chill mark time */
	113	hrtime_t cpu_dtrace_chilled; /* DTrace: total chill time */
	114	boolean_t cpu_dtrace_invop_underway; /* DTrace gaurds against invalid op re-entrancy */
6d2010ae	115	} dtrace_cpu_t;
2d21ac55	116
6d2010ae	117	extern dtrace_cpu_t *cpu_list;
2d21ac55 A	118
	119	/*
	120	* The cpu_core structure consists of per-CPU state available in any context.
	121	* On some architectures, this may mean that the page(s) containing the
	122	* NCPU-sized array of cpu_core structures must be locked in the TLB -- it
	123	* is up to the platform to assure that this is performed properly. Note that
	124	* the structure is sized to avoid false sharing.
	125	*/
	126	#define CPU_CACHE_COHERENCE_SIZE 64
2d21ac55 A	127
2d21ac55 A	128	typedef struct cpu_core {
2d21ac55 A	129	uint64_t cpuc_dtrace_illval; /* DTrace illegal value */
2d21ac55 A	130	lck_mtx_t cpuc_pid_lock; /* DTrace pid provider lock */
b0d623f7 A	131	uint16_t cpuc_dtrace_flags; /* DTrace flags */
	132	uint64_t cpuc_missing_tos; /* Addr. of top most stack frame if missing */
	133	uint8_t cpuc_pad[CPU_CACHE_COHERENCE_SIZE - sizeof(uint64_t) - sizeof(lck_mtx_t) - sizeof(uint16_t) - sizeof(uint64_t) ]; /* padding */
2d21ac55 A	134	} cpu_core_t;
2d21ac55 A	135
b0d623f7	136	extern cpu_core_t *cpu_core;
6d2010ae	137
39236c6e A	138	extern unsigned int dtrace_max_cpus; /* max number of enabled cpus */
39236c6e A	139	#define NCPU dtrace_max_cpus
6d2010ae	140
b0d623f7	141	extern int cpu_number(void); /* From #include <kern/cpu_number.h>. Called from probe context, must blacklist. */
2d21ac55 A	142
	143	#define CPU (&(cpu_list[cpu_number()])) /* Pointer to current CPU */
	144	#define CPU_ON_INTR(cpup) ml_at_interrupt_context() /* always invoked on current cpu */
2d21ac55 A	145
	146	/*
	147	* Routines used to register interest in cpu's being added to or removed
	148	* from the system.
	149	*/
	150	typedef enum {
	151	CPU_INIT,
	152	CPU_CONFIG,
	153	CPU_UNCONFIG,
	154	CPU_ON,
	155	CPU_OFF,
	156	CPU_CPUPART_IN,
	157	CPU_CPUPART_OUT
	158	} cpu_setup_t;
	159
	160	typedef int cpu_setup_func_t(cpu_setup_t, int, void *);
	161
	162	extern void register_cpu_setup_func(cpu_setup_func_t , void );
	163	extern void unregister_cpu_setup_func(cpu_setup_func_t , void );
	164
	165	/*
	166	* CPU_DTRACE
	167	*/
	168
	169	/*
	170	* DTrace flags.
	171	*/
	172	#define CPU_DTRACE_NOFAULT 0x0001 /* Don't fault */
	173	#define CPU_DTRACE_DROP 0x0002 /* Drop this ECB */
	174	#define CPU_DTRACE_BADADDR 0x0004 /* DTrace fault: bad address */
	175	#define CPU_DTRACE_BADALIGN 0x0008 /* DTrace fault: bad alignment */
	176	#define CPU_DTRACE_DIVZERO 0x0010 /* DTrace fault: divide by zero */
	177	#define CPU_DTRACE_ILLOP 0x0020 /* DTrace fault: illegal operation */
	178	#define CPU_DTRACE_NOSCRATCH 0x0040 /* DTrace fault: out of scratch */
	179	#define CPU_DTRACE_KPRIV 0x0080 /* DTrace fault: bad kernel access */
	180	#define CPU_DTRACE_UPRIV 0x0100 /* DTrace fault: bad user access */
	181	#define CPU_DTRACE_TUPOFLOW 0x0200 /* DTrace fault: tuple stack overflow */
	182	#if defined(__sparc)
	183	//#define CPU_DTRACE_FAKERESTORE 0x0400 /* pid provider hint to getreg */
	184	#endif
	185	#define CPU_DTRACE_USTACK_FP 0x0400 /* pid provider hint to ustack() */
	186	#define CPU_DTRACE_ENTRY 0x0800 /* pid provider hint to ustack() */
b0d623f7	187	#define CPU_DTRACE_BADSTACK 0x1000 /* DTrace fault: bad stack */
2d21ac55 A	188
	189	#define CPU_DTRACE_FAULT (CPU_DTRACE_BADADDR \| CPU_DTRACE_BADALIGN \| \
	190	CPU_DTRACE_DIVZERO \| CPU_DTRACE_ILLOP \| \
	191	CPU_DTRACE_NOSCRATCH \| CPU_DTRACE_KPRIV \| \
b0d623f7 A	192	CPU_DTRACE_UPRIV \| CPU_DTRACE_TUPOFLOW \| \
b0d623f7 A	193	CPU_DTRACE_BADSTACK)
2d21ac55 A	194	#define CPU_DTRACE_ERROR (CPU_DTRACE_FAULT \| CPU_DTRACE_DROP)
2d21ac55 A	195
6d2010ae A	196	/*
	197	* Loadable Modules
	198	*/
	199
	200	/* Keep the compiler happy */
	201	struct dtrace_module_symbols;
	202
	203	/* Solaris' modctl structure, greatly simplified, shadowing parts of xnu kmod structure. */
	204	typedef struct modctl {
	205	struct modctl *mod_next;
	206	struct modctl *mod_stale; // stale module chain
	207	uint32_t mod_id; // the kext unique identifier
	208	char mod_modname[KMOD_MAX_NAME];
	209	int mod_loadcnt;
	210	char mod_loaded;
	211	char mod_flags; // See flags below
	212	int mod_nenabled; // # of enabled DTrace probes in module
	213	vm_address_t mod_address; // starting address (of Mach-o header blob)
	214	vm_size_t mod_size; // total size (of blob)
	215	UUID mod_uuid;
	216	struct dtrace_module_symbols* mod_user_symbols;
	217	} modctl_t;
	218
	219	/* Definitions for mod_flags */
	220	#define MODCTL_IS_MACH_KERNEL 0x01 // This module represents /mach_kernel
	221	#define MODCTL_HAS_KERNEL_SYMBOLS 0x02 // Kernel symbols (nlist) are available
	222	#define MODCTL_FBT_PROBES_PROVIDED 0x04 // fbt probes have been provided
	223	#define MODCTL_FBT_INVALID 0x08 // Module is invalid for fbt probes
	224	#define MODCTL_SDT_PROBES_PROVIDED 0x10 // sdt probes have been provided
	225	#define MODCTL_SDT_INVALID 0x20 // Module is invalid for sdt probes
	226	#define MODCTL_HAS_UUID 0x40 // Module has UUID
	227
	228	/* Simple/singular mod_flags accessors */
	229	#define MOD_IS_MACH_KERNEL(mod) (mod->mod_flags & MODCTL_IS_MACH_KERNEL)
	230	#define MOD_HAS_KERNEL_SYMBOLS(mod) (mod->mod_flags & MODCTL_HAS_KERNEL_SYMBOLS)
	231	#define MOD_HAS_USERSPACE_SYMBOLS(mod) (mod->mod_user_symbols) /* No point in duplicating state in the flags bits */
	232	#define MOD_FBT_PROBES_PROVIDED(mod) (mod->mod_flags & MODCTL_FBT_PROBES_PROVIDED)
	233	#define MOD_FBT_INVALID(mod) (mod->mod_flags & MODCTL_FBT_INVALID)
	234	#define MOD_SDT_PROBES_PROVIDED(mod) (mod->mod_flags & MODCTL_SDT_PROBES_PROVIDED)
	235	#define MOD_SDT_INVALID(mod) (mod->mod_flags & MODCTL_SDT_INVALID)
	236	#define MOD_HAS_UUID(mod) (mod->mod_flags & MODCTL_HAS_UUID)
	237
	238	/* Compound accessors */
	239	#define MOD_FBT_DONE(mod) (MOD_FBT_PROBES_PROVIDED(mod) \|\| MOD_FBT_INVALID(mod))
	240	#define MOD_SDT_DONE(mod) (MOD_SDT_PROBES_PROVIDED(mod) \|\| MOD_SDT_INVALID(mod))
	241	#define MOD_SYMBOLS_DONE(mod) (MOD_FBT_DONE(mod) && MOD_SDT_DONE(mod))
	242
	243	extern modctl_t *dtrace_modctl_list;
	244
2d21ac55 A	245	/*
	246	* cred_t
	247	*/
	248	/* Privileges */
	249	#define PRIV_DTRACE_KERNEL 3
	250	#define PRIV_DTRACE_PROC 4
	251	#define PRIV_DTRACE_USER 5
	252	#define PRIV_PROC_OWNER 30
	253	#define PRIV_PROC_ZONE 35
	254	#define PRIV_ALL (-1) /* All privileges required */
	255
	256	/* Privilege sets */
	257	#define PRIV_EFFECTIVE 0
	258
	259	typedef struct ucred cred_t;
	260	#define cr_suid cr_svuid
	261	#define cr_sgid cr_svgid
	262
	263	extern cred_t dtrace_CRED(void); / Safe to call from probe context. */
	264	#define CRED() kauth_cred_get() /* Can't be called from probe context! */
	265	extern int PRIV_POLICY_CHOICE(void *, int, int);
	266	extern int PRIV_POLICY_ONLY(void *, int, int);
	267	extern gid_t crgetgid(const cred_t *);
	268	extern uid_t crgetuid(const cred_t *);
	269	#define crgetzoneid(x) ((zoneid_t)0)
	270
	271	#define crhold(a) {}
	272	#define crfree(a) {}
	273
	274	/*
	275	* "cyclic"
	276	*/
	277	#define CY_LOW_LEVEL 0
	278	#define CY_LOCK_LEVEL 1
	279	#define CY_HIGH_LEVEL 2
	280	#define CY_SOFT_LEVELS 2
	281	#define CY_LEVELS 3
	282
	283	typedef uintptr_t cyclic_id_t;
	284	typedef cyclic_id_t *cyclic_id_list_t;
	285	typedef uint16_t cyc_level_t;
	286	typedef void (cyc_func_t)(void );
	287
	288	#define CYCLIC_NONE ((cyclic_id_t)0)
	289
	290	typedef struct cyc_time {
	291	hrtime_t cyt_when;
	292	hrtime_t cyt_interval;
	293	} cyc_time_t;
	294
	295	typedef struct cyc_handler {
	296	cyc_func_t cyh_func;
	297	void *cyh_arg;
	298	cyc_level_t cyh_level;
	299	} cyc_handler_t;
	300
	301	typedef struct cyc_omni_handler {
6d2010ae A	302	void (cyo_online)(void , dtrace_cpu_t , cyc_handler_t , cyc_time_t *);
6d2010ae A	303	void (cyo_offline)(void , dtrace_cpu_t , void );
2d21ac55 A	304	void *cyo_arg;
	305	} cyc_omni_handler_t;
	306
	307	extern cyclic_id_t cyclic_add(cyc_handler_t , cyc_time_t );
	308	extern void cyclic_remove(cyclic_id_t);
	309
	310	extern cyclic_id_list_t cyclic_add_omni(cyc_omni_handler_t *);
	311	extern void cyclic_remove_omni(cyclic_id_list_t);
	312
	313	extern cyclic_id_t cyclic_timer_add(cyc_handler_t , cyc_time_t );
	314	extern void cyclic_timer_remove(cyclic_id_t);
	315
	316	/*
	317	* timeout / untimeout (converted to dtrace_timeout / dtrace_untimeout due to name collision)
	318	*/
	319
	320	thread_call_t dtrace_timeout(void (func)(void , void ), void arg, uint64_t nanos);
	321
	322	/*
	323	* ddi
	324	*/
	325
	326	#define DDI_SUCCESS 0
	327	#define DDI_FAILURE -1
	328
	329	#define DDI_DEV_T_NONE ((dev_t)-1)
	330	#define DDI_DEV_T_ANY ((dev_t)-2)
	331	#define DDI_MAJOR_T_UNKNOWN ((major_t)0)
	332
	333	#define DDI_PSEUDO "ddi_pseudo"
	334
	335	typedef enum {
	336	DDI_ATTACH = 0,
	337	DDI_RESUME = 1,
	338	DDI_PM_RESUME = 2
	339	} ddi_attach_cmd_t;
	340
	341	typedef enum {
	342	DDI_DETACH = 0,
	343	DDI_SUSPEND = 1,
	344	DDI_PM_SUSPEND = 2,
	345	DDI_HOTPLUG_DETACH = 3 /* detach, don't try to auto-unconfig */
	346	} ddi_detach_cmd_t;
	347
	348	#define DDI_PROP_SUCCESS 0
	349
	350	#define DDI_PROP_DONTPASS 1
	351	typedef uint_t major_t;
	352	typedef uint_t minor_t;
	353
	354	typedef struct __dev_info *dev_info_t;
	355
	356	extern void ddi_report_dev(dev_info_t *);
	357	extern int ddi_soft_state_init(void **, size_t, size_t);
	358	extern void ddi_get_soft_state(void , int);
	359	extern int ddi_soft_state_free(void *, int);
	360	extern int ddi_soft_state_zalloc(void *, int);
	361	extern void ddi_soft_state_fini(void **);
	362
	363	int ddi_getprop(dev_t dev, dev_info_t dip, int flags, const char name, int defvalue);
	364
	365	extern int ddi_prop_free(void *);
b0d623f7	366	extern int ddi_prop_lookup_int_array(dev_t, dev_info_t , uint_t, const char , int *, uint_t );
2d21ac55 A	367
	368	extern int ddi_driver_major(dev_info_t *);
	369
	370	extern int ddi_create_minor_node(dev_info_t , const char , int, minor_t, const char *, int);
	371	extern void ddi_remove_minor_node(dev_info_t , char );
	372
	373	extern major_t getemajor(dev_t);
	374	extern minor_t getminor(dev_t);
	375
2d21ac55 A	376	extern dev_t makedevice(major_t, minor_t);
	377
	378	/*
	379	* Kernel Debug Interface
	380	*/
	381
	382	typedef enum kdi_dtrace_set {
	383	KDI_DTSET_DTRACE_ACTIVATE,
	384	KDI_DTSET_DTRACE_DEACTIVATE,
	385	KDI_DTSET_KMDB_BPT_ACTIVATE,
	386	KDI_DTSET_KMDB_BPT_DEACTIVATE
	387	} kdi_dtrace_set_t;
	388
	389	extern int kdi_dtrace_set(kdi_dtrace_set_t);
	390	extern void debug_enter(char *);
	391
	392	/*
	393	* DTrace specific zone allocation
	394	*/
	395
	396	/*
	397	* To break dtrace memory usage out in a trackable
	398	* fashion, uncomment the #define below. This will
	399	* enable emulation of the general kalloc.XXX zones
	400	* for most dtrace allocations. (kalloc.large is not
	401	* emulated)
	402	*
	403	* #define DTRACE_MEMORY_ZONES 1
	404	*
	405	*/
	406
	407	#if defined(DTRACE_MEMORY_ZONES)
	408	void dtrace_alloc_init(void);
	409	void *dtrace_alloc(vm_size_t);
	410	void dtrace_free(void *, vm_size_t);
	411	#endif
	412
	413	/*
	414	* kmem
	415	*/
	416
	417	#define KM_SLEEP 0x00000000
	418	#define KM_NOSLEEP 0x00000001
	419
	420	typedef struct vmem vmem_t;
	421	typedef struct kmem_cache kmem_cache_t;
	422
	423	#define kmem_alloc dt_kmem_alloc /* Avoid clash with Darwin's kmem_alloc */
	424	#define kmem_free dt_kmem_free /* Avoid clash with Darwin's kmem_free */
	425	#define kmem_zalloc dt_kmem_zalloc /* Avoid clash with Darwin's kmem_zalloc */
	426	extern void *dt_kmem_alloc(size_t, int);
	427	extern void dt_kmem_free(void *, size_t);
	428	extern void *dt_kmem_zalloc(size_t, int);
	429
	430	extern void *dt_kmem_alloc_aligned(size_t, size_t, int);
	431	extern void *dt_kmem_zalloc_aligned(size_t, size_t, int);
	432	extern void dt_kmem_free_aligned(void*, size_t);
	433
	434	extern kmem_cache_t *
b0d623f7	435	kmem_cache_create(const char , size_t, size_t, int ()(void , void , int),
2d21ac55 A	436	void ()(void , void ), void ()(void ), void , vmem_t *, int);
	437	extern void kmem_cache_alloc(kmem_cache_t , int);
	438	extern void kmem_cache_free(kmem_cache_t , void );
	439	extern void kmem_cache_destroy(kmem_cache_t *);
	440
	441	/*
	442	* kthread
	443	*/
	444
	445	typedef struct _kthread kthread_t; /* For dtrace_vtime_switch(), dtrace_panicked and dtrace_errthread */
	446
2d21ac55 A	447	/*
	448	* proc
	449	*/
	450
	451	#define DATAMODEL_MASK 0x0FF00000
	452
	453	#define DATAMODEL_ILP32 0x00100000
	454	#define DATAMODEL_LP64 0x00200000
	455
	456	#define DATAMODEL_NONE 0
	457
	458	#if defined(__LP64__)
	459	#define DATAMODEL_NATIVE DATAMODEL_LP64
	460	#else
	461	#define DATAMODEL_NATIVE DATAMODEL_ILP32
	462	#endif /* __LP64__ */
	463
	464	typedef unsigned int model_t; /* For dtrace_instr_size_isa() prototype in <sys/dtrace.h> */
	465
	466	/*
	467	* taskq
	468	*/
	469
	470	#define TQ_SLEEP 0x00 /* Can block for memory */
	471
	472	typedef uint_t pri_t;
	473	typedef struct taskq taskq_t;
	474	typedef void (task_func_t)(void *);
	475	typedef uintptr_t taskqid_t;
	476
	477	extern taskq_t taskq_create(const char , int, pri_t, int, int, uint_t);
	478	extern taskqid_t taskq_dispatch(taskq_t , task_func_t, void , uint_t);
	479	extern void taskq_destroy(taskq_t *);
	480
	481	extern pri_t maxclsyspri;
	482
	483	/*
	484	* vmem
	485	*/
	486
	487	#define VMC_IDENTIFIER 0x00040000 /* not backed by memory */
	488	#define VM_SLEEP 0x00000000 /* same as KM_SLEEP */
	489	#define VM_BESTFIT 0x00000100
	490
	491	extern void vmem_alloc(vmem_t , size_t, int);
	492	extern vmem_t vmem_create(const char , void , size_t, size_t, void ,
	493	void , vmem_t , size_t, int);
	494	extern void vmem_destroy(vmem_t *);
	495	extern void vmem_free(vmem_t vmp, void vaddr, size_t size);
	496
	497	/*
	498	* Atomic
	499	*/
	500
39236c6e	501	static inline void atomic_add_32( uint32_t *theAddress, int32_t theAmount )
2d21ac55	502	{
39236c6e	503	(void)OSAddAtomic( theAmount, theAddress );
2d21ac55 A	504	}
2d21ac55 A	505
b0d623f7	506	#if defined(__i386__) \|\| defined(__x86_64__)
39236c6e	507	static inline void atomic_add_64( uint64_t *theAddress, int64_t theAmount )
b0d623f7	508	{
39236c6e	509	(void)OSAddAtomic64( theAmount, (SInt64 *)theAddress );
b0d623f7	510	}
b0d623f7 A	511	#endif
b0d623f7 A	512
2d21ac55 A	513	/*
	514	* Miscellaneous
	515	*/
	516
	517	typedef uintptr_t pc_t;
	518	typedef uintptr_t greg_t; /* For dtrace_impl.h prototype of dtrace_getfp() */
	519	extern struct regs *find_user_regs( thread_t thread);
	520	extern vm_offset_t dtrace_get_cpu_int_stack_top(void);
	521	extern vm_offset_t max_valid_stack_address(void); /* kern/thread.h */
2d21ac55 A	522
	523	extern volatile int panicwait; /* kern/debug.c */
	524	#define panic_quiesce (panicwait)
	525
	526	#define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
	527
	528	extern void delay( int ); /* kern/clock.h */
	529
	530	extern int vuprintf(const char *, va_list);
	531
2d21ac55 A	532	extern hrtime_t dtrace_abs_to_nano(uint64_t);
2d21ac55 A	533
b0d623f7	534	__private_extern__ const char * strstr(const char , const char );
2d21ac55 A	535
	536	#undef proc_t
	537
b0d623f7 A	538	/*
	539	* Safe counted string compare against a literal string. The sizeof() intentionally
	540	* counts the trailing NUL, and so ensures that all the characters in the literal
	541	* can participate in the comparison.
	542	*/
	543	#define LIT_STRNEQL(s1, lit_s2) (0 == strncmp( (s1), (lit_s2), sizeof((lit_s2)) ))
	544
	545	/*
	546	* Safe counted string compare of a literal against the beginning of a string. Here
	547	* the sizeof() is reduced by 1 so that the trailing null of the literal does not
	548	* participate in the comparison.
	549	*/
	550	#define LIT_STRNSTART(s1, lit_s2) (0 == strncmp( (s1), (lit_s2), sizeof((lit_s2)) - 1 ))
	551
	552	#define KERNELBASE VM_MIN_KERNEL_ADDRESS
2d21ac55 A	553	#endif /* KERNEL_BUILD */
	554	#endif /* _DTRACE_GLUE_H */
	555