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