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