4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Portions Copyright (c) 2013, 2016, Joyent, Inc. All rights reserved.
24 * Portions Copyright (c) 2013 by Delphix. All rights reserved.
28 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
29 * Use is subject to license terms.
32 /* #pragma ident "@(#)dtrace.c 1.65 08/07/02 SMI" */
35 * DTrace - Dynamic Tracing for Solaris
37 * This is the implementation of the Solaris Dynamic Tracing framework
38 * (DTrace). The user-visible interface to DTrace is described at length in
39 * the "Solaris Dynamic Tracing Guide". The interfaces between the libdtrace
40 * library, the in-kernel DTrace framework, and the DTrace providers are
41 * described in the block comments in the <sys/dtrace.h> header file. The
42 * internal architecture of DTrace is described in the block comments in the
43 * <sys/dtrace_impl.h> header file. The comments contained within the DTrace
44 * implementation very much assume mastery of all of these sources; if one has
45 * an unanswered question about the implementation, one should consult them
48 * The functions here are ordered roughly as follows:
50 * - Probe context functions
51 * - Probe hashing functions
52 * - Non-probe context utility functions
53 * - Matching functions
54 * - Provider-to-Framework API functions
55 * - Probe management functions
56 * - DIF object functions
58 * - Predicate functions
61 * - Enabling functions
63 * - Anonymous enabling functions
65 * - Consumer state functions
68 * - Driver cookbook functions
70 * Each group of functions begins with a block comment labelled the "DTrace
71 * [Group] Functions", allowing one to find each block by searching forward
72 * on capital-f functions.
74 #include <sys/errno.h>
75 #include <sys/types.h>
78 #include <sys/systm.h>
79 #include <sys/dtrace_impl.h>
80 #include <sys/param.h>
81 #include <sys/proc_internal.h>
82 #include <sys/ioctl.h>
83 #include <sys/fcntl.h>
84 #include <miscfs/devfs/devfs.h>
85 #include <sys/malloc.h>
86 #include <sys/kernel_types.h>
87 #include <sys/proc_internal.h>
88 #include <sys/uio_internal.h>
89 #include <sys/kauth.h>
92 #include <mach/exception_types.h>
93 #include <sys/signalvar.h>
94 #include <mach/task.h>
95 #include <kern/zalloc.h>
97 #include <kern/sched_prim.h>
98 #include <kern/task.h>
99 #include <netinet/in.h>
100 #include <libkern/sysctl.h>
101 #include <sys/kdebug.h>
103 #include <kern/cpu_data.h>
104 extern uint32_t pmap_find_phys(void *, uint64_t);
105 extern boolean_t
pmap_valid_page(uint32_t);
106 extern void OSKextRegisterKextsWithDTrace(void);
107 extern kmod_info_t g_kernel_kmod_info
;
109 /* Solaris proc_t is the struct. Darwin's proc_t is a pointer to it. */
110 #define proc_t struct proc /* Steer clear of the Darwin typedef for proc_t */
112 #define t_predcache t_dtrace_predcache /* Cosmetic. Helps readability of thread.h */
114 extern void dtrace_suspend(void);
115 extern void dtrace_resume(void);
116 extern void dtrace_init(void);
117 extern void helper_init(void);
118 extern void fasttrap_init(void);
120 static int dtrace_lazy_dofs_duplicate(proc_t
*, proc_t
*);
121 extern void dtrace_lazy_dofs_destroy(proc_t
*);
122 extern void dtrace_postinit(void);
124 extern void dtrace_proc_fork(proc_t
*, proc_t
*, int);
125 extern void dtrace_proc_exec(proc_t
*);
126 extern void dtrace_proc_exit(proc_t
*);
128 * DTrace Tunable Variables
130 * The following variables may be dynamically tuned by using sysctl(8), the
131 * variables being stored in the kern.dtrace namespace. For example:
132 * sysctl kern.dtrace.dof_maxsize = 1048575 # 1M
134 * In general, the only variables that one should be tuning this way are those
135 * that affect system-wide DTrace behavior, and for which the default behavior
136 * is undesirable. Most of these variables are tunable on a per-consumer
137 * basis using DTrace options, and need not be tuned on a system-wide basis.
138 * When tuning these variables, avoid pathological values; while some attempt
139 * is made to verify the integrity of these variables, they are not considered
140 * part of the supported interface to DTrace, and they are therefore not
141 * checked comprehensively.
143 uint64_t dtrace_buffer_memory_maxsize
= 0; /* initialized in dtrace_init */
144 uint64_t dtrace_buffer_memory_inuse
= 0;
145 int dtrace_destructive_disallow
= 0;
146 dtrace_optval_t dtrace_nonroot_maxsize
= (16 * 1024 * 1024);
147 size_t dtrace_difo_maxsize
= (256 * 1024);
148 dtrace_optval_t dtrace_dof_maxsize
= (384 * 1024);
149 dtrace_optval_t dtrace_statvar_maxsize
= (16 * 1024);
150 dtrace_optval_t dtrace_statvar_maxsize_max
= (16 * 10 * 1024);
151 size_t dtrace_actions_max
= (16 * 1024);
152 size_t dtrace_retain_max
= 1024;
153 dtrace_optval_t dtrace_helper_actions_max
= 32;
154 dtrace_optval_t dtrace_helper_providers_max
= 64;
155 dtrace_optval_t dtrace_dstate_defsize
= (1 * 1024 * 1024);
156 size_t dtrace_strsize_default
= 256;
157 dtrace_optval_t dtrace_strsize_min
= 8;
158 dtrace_optval_t dtrace_strsize_max
= 65536;
159 dtrace_optval_t dtrace_cleanrate_default
= 990099000; /* 1.1 hz */
160 dtrace_optval_t dtrace_cleanrate_min
= 20000000; /* 50 hz */
161 dtrace_optval_t dtrace_cleanrate_max
= (uint64_t)60 * NANOSEC
; /* 1/minute */
162 dtrace_optval_t dtrace_aggrate_default
= NANOSEC
; /* 1 hz */
163 dtrace_optval_t dtrace_statusrate_default
= NANOSEC
; /* 1 hz */
164 dtrace_optval_t dtrace_statusrate_max
= (hrtime_t
)10 * NANOSEC
; /* 6/minute */
165 dtrace_optval_t dtrace_switchrate_default
= NANOSEC
; /* 1 hz */
166 dtrace_optval_t dtrace_nspec_default
= 1;
167 dtrace_optval_t dtrace_specsize_default
= 32 * 1024;
168 dtrace_optval_t dtrace_stackframes_default
= 20;
169 dtrace_optval_t dtrace_ustackframes_default
= 20;
170 dtrace_optval_t dtrace_jstackframes_default
= 50;
171 dtrace_optval_t dtrace_jstackstrsize_default
= 512;
172 dtrace_optval_t dtrace_buflimit_default
= 75;
173 dtrace_optval_t dtrace_buflimit_min
= 1;
174 dtrace_optval_t dtrace_buflimit_max
= 99;
175 int dtrace_msgdsize_max
= 128;
176 hrtime_t dtrace_chill_max
= 500 * (NANOSEC
/ MILLISEC
); /* 500 ms */
177 hrtime_t dtrace_chill_interval
= NANOSEC
; /* 1000 ms */
178 int dtrace_devdepth_max
= 32;
179 int dtrace_err_verbose
;
180 int dtrace_provide_private_probes
= 0;
181 hrtime_t dtrace_deadman_interval
= NANOSEC
;
182 hrtime_t dtrace_deadman_timeout
= (hrtime_t
)10 * NANOSEC
;
183 hrtime_t dtrace_deadman_user
= (hrtime_t
)30 * NANOSEC
;
186 * DTrace External Variables
188 * As dtrace(7D) is a kernel module, any DTrace variables are obviously
189 * available to DTrace consumers via the backtick (`) syntax. One of these,
190 * dtrace_zero, is made deliberately so: it is provided as a source of
191 * well-known, zero-filled memory. While this variable is not documented,
192 * it is used by some translators as an implementation detail.
194 const char dtrace_zero
[256] = { 0 }; /* zero-filled memory */
195 unsigned int dtrace_max_cpus
= 0; /* number of enabled cpus */
197 * DTrace Internal Variables
199 static dev_info_t
*dtrace_devi
; /* device info */
200 static vmem_t
*dtrace_arena
; /* probe ID arena */
201 static taskq_t
*dtrace_taskq
; /* task queue */
202 static dtrace_probe_t
**dtrace_probes
; /* array of all probes */
203 static int dtrace_nprobes
; /* number of probes */
204 static dtrace_provider_t
*dtrace_provider
; /* provider list */
205 static dtrace_meta_t
*dtrace_meta_pid
; /* user-land meta provider */
206 static int dtrace_opens
; /* number of opens */
207 static int dtrace_helpers
; /* number of helpers */
208 static dtrace_hash_t
*dtrace_bymod
; /* probes hashed by module */
209 static dtrace_hash_t
*dtrace_byfunc
; /* probes hashed by function */
210 static dtrace_hash_t
*dtrace_byname
; /* probes hashed by name */
211 static dtrace_toxrange_t
*dtrace_toxrange
; /* toxic range array */
212 static int dtrace_toxranges
; /* number of toxic ranges */
213 static int dtrace_toxranges_max
; /* size of toxic range array */
214 static dtrace_anon_t dtrace_anon
; /* anonymous enabling */
215 static kmem_cache_t
*dtrace_state_cache
; /* cache for dynamic state */
216 static uint64_t dtrace_vtime_references
; /* number of vtimestamp refs */
217 static kthread_t
*dtrace_panicked
; /* panicking thread */
218 static dtrace_ecb_t
*dtrace_ecb_create_cache
; /* cached created ECB */
219 static dtrace_genid_t dtrace_probegen
; /* current probe generation */
220 static dtrace_helpers_t
*dtrace_deferred_pid
; /* deferred helper list */
221 static dtrace_enabling_t
*dtrace_retained
; /* list of retained enablings */
222 static dtrace_genid_t dtrace_retained_gen
; /* current retained enab gen */
223 static dtrace_dynvar_t dtrace_dynhash_sink
; /* end of dynamic hash chains */
225 static int dtrace_dof_mode
; /* See dtrace_impl.h for a description of Darwin's dof modes. */
228 * This does't quite fit as an internal variable, as it must be accessed in
229 * fbt_provide and sdt_provide. Its clearly not a dtrace tunable variable either...
231 int dtrace_kernel_symbol_mode
; /* See dtrace_impl.h for a description of Darwin's kernel symbol modes. */
232 static uint32_t dtrace_wake_clients
;
236 * To save memory, some common memory allocations are given a
237 * unique zone. For example, dtrace_probe_t is 72 bytes in size,
238 * which means it would fall into the kalloc.128 bucket. With
239 * 20k elements allocated, the space saved is substantial.
242 struct zone
*dtrace_probe_t_zone
;
244 static int dtrace_module_unloaded(struct kmod_info
*kmod
);
248 * DTrace is protected by three (relatively coarse-grained) locks:
250 * (1) dtrace_lock is required to manipulate essentially any DTrace state,
251 * including enabling state, probes, ECBs, consumer state, helper state,
252 * etc. Importantly, dtrace_lock is _not_ required when in probe context;
253 * probe context is lock-free -- synchronization is handled via the
254 * dtrace_sync() cross call mechanism.
256 * (2) dtrace_provider_lock is required when manipulating provider state, or
257 * when provider state must be held constant.
259 * (3) dtrace_meta_lock is required when manipulating meta provider state, or
260 * when meta provider state must be held constant.
262 * The lock ordering between these three locks is dtrace_meta_lock before
263 * dtrace_provider_lock before dtrace_lock. (In particular, there are
264 * several places where dtrace_provider_lock is held by the framework as it
265 * calls into the providers -- which then call back into the framework,
266 * grabbing dtrace_lock.)
268 * There are two other locks in the mix: mod_lock and cpu_lock. With respect
269 * to dtrace_provider_lock and dtrace_lock, cpu_lock continues its historical
270 * role as a coarse-grained lock; it is acquired before both of these locks.
271 * With respect to dtrace_meta_lock, its behavior is stranger: cpu_lock must
272 * be acquired _between_ dtrace_meta_lock and any other DTrace locks.
273 * mod_lock is similar with respect to dtrace_provider_lock in that it must be
274 * acquired _between_ dtrace_provider_lock and dtrace_lock.
281 * For porting purposes, all kmutex_t vars have been changed
282 * to lck_mtx_t, which require explicit initialization.
284 * kmutex_t becomes lck_mtx_t
285 * mutex_enter() becomes lck_mtx_lock()
286 * mutex_exit() becomes lck_mtx_unlock()
288 * Lock asserts are changed like this:
290 * ASSERT(MUTEX_HELD(&cpu_lock));
292 * lck_mtx_assert(&cpu_lock, LCK_MTX_ASSERT_OWNED);
295 static lck_mtx_t dtrace_lock
; /* probe state lock */
296 static lck_mtx_t dtrace_provider_lock
; /* provider state lock */
297 static lck_mtx_t dtrace_meta_lock
; /* meta-provider state lock */
298 static lck_rw_t dtrace_dof_mode_lock
; /* dof mode lock */
301 * DTrace Provider Variables
303 * These are the variables relating to DTrace as a provider (that is, the
304 * provider of the BEGIN, END, and ERROR probes).
306 static dtrace_pattr_t dtrace_provider_attr
= {
307 { DTRACE_STABILITY_STABLE
, DTRACE_STABILITY_STABLE
, DTRACE_CLASS_COMMON
},
308 { DTRACE_STABILITY_PRIVATE
, DTRACE_STABILITY_PRIVATE
, DTRACE_CLASS_UNKNOWN
},
309 { DTRACE_STABILITY_PRIVATE
, DTRACE_STABILITY_PRIVATE
, DTRACE_CLASS_UNKNOWN
},
310 { DTRACE_STABILITY_STABLE
, DTRACE_STABILITY_STABLE
, DTRACE_CLASS_COMMON
},
311 { DTRACE_STABILITY_STABLE
, DTRACE_STABILITY_STABLE
, DTRACE_CLASS_COMMON
},
319 dtrace_enable_nullop(void)
324 static dtrace_pops_t dtrace_provider_ops
= {
325 (void (*)(void *, const dtrace_probedesc_t
*))dtrace_nullop
,
326 (void (*)(void *, struct modctl
*))dtrace_nullop
,
327 (int (*)(void *, dtrace_id_t
, void *))dtrace_enable_nullop
,
328 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
,
329 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
,
330 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
,
334 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
337 static dtrace_id_t dtrace_probeid_begin
; /* special BEGIN probe */
338 static dtrace_id_t dtrace_probeid_end
; /* special END probe */
339 dtrace_id_t dtrace_probeid_error
; /* special ERROR probe */
342 * DTrace Helper Tracing Variables
344 uint32_t dtrace_helptrace_next
= 0;
345 uint32_t dtrace_helptrace_nlocals
;
346 char *dtrace_helptrace_buffer
;
347 size_t dtrace_helptrace_bufsize
= 512 * 1024;
350 int dtrace_helptrace_enabled
= 1;
352 int dtrace_helptrace_enabled
= 0;
357 * DTrace Error Hashing
359 * On DEBUG kernels, DTrace will track the errors that has seen in a hash
360 * table. This is very useful for checking coverage of tests that are
361 * expected to induce DIF or DOF processing errors, and may be useful for
362 * debugging problems in the DIF code generator or in DOF generation . The
363 * error hash may be examined with the ::dtrace_errhash MDB dcmd.
366 static dtrace_errhash_t dtrace_errhash
[DTRACE_ERRHASHSZ
];
367 static const char *dtrace_errlast
;
368 static kthread_t
*dtrace_errthread
;
369 static lck_mtx_t dtrace_errlock
;
373 * DTrace Macros and Constants
375 * These are various macros that are useful in various spots in the
376 * implementation, along with a few random constants that have no meaning
377 * outside of the implementation. There is no real structure to this cpp
378 * mishmash -- but is there ever?
380 #define DTRACE_HASHSTR(hash, probe) \
381 dtrace_hash_str(*((char **)((uintptr_t)(probe) + (hash)->dth_stroffs)))
383 #define DTRACE_HASHNEXT(hash, probe) \
384 (dtrace_probe_t **)((uintptr_t)(probe) + (hash)->dth_nextoffs)
386 #define DTRACE_HASHPREV(hash, probe) \
387 (dtrace_probe_t **)((uintptr_t)(probe) + (hash)->dth_prevoffs)
389 #define DTRACE_HASHEQ(hash, lhs, rhs) \
390 (strcmp(*((char **)((uintptr_t)(lhs) + (hash)->dth_stroffs)), \
391 *((char **)((uintptr_t)(rhs) + (hash)->dth_stroffs))) == 0)
393 #define DTRACE_AGGHASHSIZE_SLEW 17
395 #define DTRACE_V4MAPPED_OFFSET (sizeof (uint32_t) * 3)
398 * The key for a thread-local variable consists of the lower 61 bits of the
399 * current_thread(), plus the 3 bits of the highest active interrupt above LOCK_LEVEL.
400 * We add DIF_VARIABLE_MAX to t_did to assure that the thread key is never
401 * equal to a variable identifier. This is necessary (but not sufficient) to
402 * assure that global associative arrays never collide with thread-local
403 * variables. To guarantee that they cannot collide, we must also define the
404 * order for keying dynamic variables. That order is:
406 * [ key0 ] ... [ keyn ] [ variable-key ] [ tls-key ]
408 * Because the variable-key and the tls-key are in orthogonal spaces, there is
409 * no way for a global variable key signature to match a thread-local key
412 #if defined (__x86_64__)
413 /* FIXME: two function calls!! */
414 #define DTRACE_TLS_THRKEY(where) { \
415 uint_t intr = ml_at_interrupt_context(); /* Note: just one measly bit */ \
416 uint64_t thr = (uintptr_t)current_thread(); \
417 ASSERT(intr < (1 << 3)); \
418 (where) = ((thr + DIF_VARIABLE_MAX) & \
419 (((uint64_t)1 << 61) - 1)) | ((uint64_t)intr << 61); \
422 #error Unknown architecture
425 #define DT_BSWAP_8(x) ((x) & 0xff)
426 #define DT_BSWAP_16(x) ((DT_BSWAP_8(x) << 8) | DT_BSWAP_8((x) >> 8))
427 #define DT_BSWAP_32(x) ((DT_BSWAP_16(x) << 16) | DT_BSWAP_16((x) >> 16))
428 #define DT_BSWAP_64(x) ((DT_BSWAP_32(x) << 32) | DT_BSWAP_32((x) >> 32))
430 #define DT_MASK_LO 0x00000000FFFFFFFFULL
432 #define DTRACE_STORE(type, tomax, offset, what) \
433 *((type *)((uintptr_t)(tomax) + (uintptr_t)offset)) = (type)(what);
436 #define DTRACE_ALIGNCHECK(addr, size, flags) \
437 if (addr & (MIN(size,4) - 1)) { \
438 *flags |= CPU_DTRACE_BADALIGN; \
439 cpu_core[CPU->cpu_id].cpuc_dtrace_illval = addr; \
443 #define DTRACE_RANGE_REMAIN(remp, addr, baseaddr, basesz) \
445 if ((remp) != NULL) { \
446 *(remp) = (uintptr_t)(baseaddr) + (basesz) - (addr); \
452 * Test whether a range of memory starting at testaddr of size testsz falls
453 * within the range of memory described by addr, sz. We take care to avoid
454 * problems with overflow and underflow of the unsigned quantities, and
455 * disallow all negative sizes. Ranges of size 0 are allowed.
457 #define DTRACE_INRANGE(testaddr, testsz, baseaddr, basesz) \
458 ((testaddr) - (baseaddr) < (basesz) && \
459 (testaddr) + (testsz) - (baseaddr) <= (basesz) && \
460 (testaddr) + (testsz) >= (testaddr))
463 * Test whether alloc_sz bytes will fit in the scratch region. We isolate
464 * alloc_sz on the righthand side of the comparison in order to avoid overflow
465 * or underflow in the comparison with it. This is simpler than the INRANGE
466 * check above, because we know that the dtms_scratch_ptr is valid in the
467 * range. Allocations of size zero are allowed.
469 #define DTRACE_INSCRATCH(mstate, alloc_sz) \
470 ((mstate)->dtms_scratch_base + (mstate)->dtms_scratch_size - \
471 (mstate)->dtms_scratch_ptr >= (alloc_sz))
473 #define RECOVER_LABEL(bits) dtraceLoadRecover##bits:
475 #if defined (__x86_64__) || (defined (__arm__) || defined (__arm64__))
476 #define DTRACE_LOADFUNC(bits) \
478 uint##bits##_t dtrace_load##bits(uintptr_t addr); \
481 dtrace_load##bits(uintptr_t addr) \
483 size_t size = bits / NBBY; \
485 uint##bits##_t rval = 0; \
487 volatile uint16_t *flags = (volatile uint16_t *) \
488 &cpu_core[CPU->cpu_id].cpuc_dtrace_flags; \
490 DTRACE_ALIGNCHECK(addr, size, flags); \
492 for (i = 0; i < dtrace_toxranges; i++) { \
493 if (addr >= dtrace_toxrange[i].dtt_limit) \
496 if (addr + size <= dtrace_toxrange[i].dtt_base) \
500 * This address falls within a toxic region; return 0. \
502 *flags |= CPU_DTRACE_BADADDR; \
503 cpu_core[CPU->cpu_id].cpuc_dtrace_illval = addr; \
508 volatile vm_offset_t recover = (vm_offset_t)&&dtraceLoadRecover##bits; \
509 *flags |= CPU_DTRACE_NOFAULT; \
510 recover = dtrace_set_thread_recover(current_thread(), recover); \
513 * PR6394061 - avoid device memory that is unpredictably \
514 * mapped and unmapped \
516 if (pmap_valid_page(pmap_find_phys(kernel_pmap, addr))) \
517 rval = *((volatile uint##bits##_t *)addr); \
519 *flags |= CPU_DTRACE_BADADDR; \
520 cpu_core[CPU->cpu_id].cpuc_dtrace_illval = addr; \
524 RECOVER_LABEL(bits); \
525 (void)dtrace_set_thread_recover(current_thread(), recover); \
526 *flags &= ~CPU_DTRACE_NOFAULT; \
531 #else /* all other architectures */
532 #error Unknown Architecture
536 #define dtrace_loadptr dtrace_load64
538 #define dtrace_loadptr dtrace_load32
541 #define DTRACE_DYNHASH_FREE 0
542 #define DTRACE_DYNHASH_SINK 1
543 #define DTRACE_DYNHASH_VALID 2
545 #define DTRACE_MATCH_FAIL -1
546 #define DTRACE_MATCH_NEXT 0
547 #define DTRACE_MATCH_DONE 1
548 #define DTRACE_ANCHORED(probe) ((probe)->dtpr_func[0] != '\0')
549 #define DTRACE_STATE_ALIGN 64
551 #define DTRACE_FLAGS2FLT(flags) \
552 (((flags) & CPU_DTRACE_BADADDR) ? DTRACEFLT_BADADDR : \
553 ((flags) & CPU_DTRACE_ILLOP) ? DTRACEFLT_ILLOP : \
554 ((flags) & CPU_DTRACE_DIVZERO) ? DTRACEFLT_DIVZERO : \
555 ((flags) & CPU_DTRACE_KPRIV) ? DTRACEFLT_KPRIV : \
556 ((flags) & CPU_DTRACE_UPRIV) ? DTRACEFLT_UPRIV : \
557 ((flags) & CPU_DTRACE_TUPOFLOW) ? DTRACEFLT_TUPOFLOW : \
558 ((flags) & CPU_DTRACE_BADALIGN) ? DTRACEFLT_BADALIGN : \
559 ((flags) & CPU_DTRACE_NOSCRATCH) ? DTRACEFLT_NOSCRATCH : \
560 ((flags) & CPU_DTRACE_BADSTACK) ? DTRACEFLT_BADSTACK : \
563 #define DTRACEACT_ISSTRING(act) \
564 ((act)->dta_kind == DTRACEACT_DIFEXPR && \
565 (act)->dta_difo->dtdo_rtype.dtdt_kind == DIF_TYPE_STRING)
568 static size_t dtrace_strlen(const char *, size_t);
569 static dtrace_probe_t
*dtrace_probe_lookup_id(dtrace_id_t id
);
570 static void dtrace_enabling_provide(dtrace_provider_t
*);
571 static int dtrace_enabling_match(dtrace_enabling_t
*, int *, dtrace_match_cond_t
*cond
);
572 static void dtrace_enabling_matchall_with_cond(dtrace_match_cond_t
*cond
);
573 static void dtrace_enabling_matchall(void);
574 static dtrace_state_t
*dtrace_anon_grab(void);
575 static uint64_t dtrace_helper(int, dtrace_mstate_t
*,
576 dtrace_state_t
*, uint64_t, uint64_t);
577 static dtrace_helpers_t
*dtrace_helpers_create(proc_t
*);
578 static void dtrace_buffer_drop(dtrace_buffer_t
*);
579 static intptr_t dtrace_buffer_reserve(dtrace_buffer_t
*, size_t, size_t,
580 dtrace_state_t
*, dtrace_mstate_t
*);
581 static int dtrace_state_option(dtrace_state_t
*, dtrace_optid_t
,
583 static int dtrace_ecb_create_enable(dtrace_probe_t
*, void *);
584 static void dtrace_helper_provider_destroy(dtrace_helper_provider_t
*);
585 static int dtrace_canload_remains(uint64_t, size_t, size_t *,
586 dtrace_mstate_t
*, dtrace_vstate_t
*);
587 static int dtrace_canstore_remains(uint64_t, size_t, size_t *,
588 dtrace_mstate_t
*, dtrace_vstate_t
*);
592 * DTrace sysctl handlers
594 * These declarations and functions are used for a deeper DTrace configuration.
595 * Most of them are not per-consumer basis and may impact the other DTrace
596 * consumers. Correctness may not be supported for all the variables, so you
597 * should be careful about what values you are using.
600 SYSCTL_DECL(_kern_dtrace
);
601 SYSCTL_NODE(_kern
, OID_AUTO
, dtrace
, CTLFLAG_RW
| CTLFLAG_LOCKED
, 0, "dtrace");
604 sysctl_dtrace_err_verbose SYSCTL_HANDLER_ARGS
606 #pragma unused(oidp, arg2)
608 int value
= *(int *) arg1
;
610 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, &changed
);
611 if (error
|| !changed
)
614 if (value
!= 0 && value
!= 1)
617 lck_mtx_lock(&dtrace_lock
);
618 dtrace_err_verbose
= value
;
619 lck_mtx_unlock(&dtrace_lock
);
625 * kern.dtrace.err_verbose
627 * Set DTrace verbosity when an error occured (0 = disabled, 1 = enabld).
628 * Errors are reported when a DIFO or a DOF has been rejected by the kernel.
630 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, err_verbose
,
631 CTLTYPE_INT
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
632 &dtrace_err_verbose
, 0,
633 sysctl_dtrace_err_verbose
, "I", "dtrace error verbose");
636 sysctl_dtrace_buffer_memory_maxsize SYSCTL_HANDLER_ARGS
638 #pragma unused(oidp, arg2, req)
640 uint64_t value
= *(uint64_t *) arg1
;
642 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, &changed
);
643 if (error
|| !changed
)
646 if (value
<= dtrace_buffer_memory_inuse
)
649 lck_mtx_lock(&dtrace_lock
);
650 dtrace_buffer_memory_maxsize
= value
;
651 lck_mtx_unlock(&dtrace_lock
);
657 * kern.dtrace.buffer_memory_maxsize
659 * Set DTrace maximal size in bytes used by all the consumers' state buffers. By default
660 * the limit is PHYS_MEM / 3 for *all* consumers. Attempting to set a null, a negative value
661 * or a value <= to dtrace_buffer_memory_inuse will result in a failure.
663 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, buffer_memory_maxsize
,
664 CTLTYPE_QUAD
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
665 &dtrace_buffer_memory_maxsize
, 0,
666 sysctl_dtrace_buffer_memory_maxsize
, "Q", "dtrace state buffer memory maxsize");
669 * kern.dtrace.buffer_memory_inuse
671 * Current state buffer memory used, in bytes, by all the DTrace consumers.
672 * This value is read-only.
674 SYSCTL_QUAD(_kern_dtrace
, OID_AUTO
, buffer_memory_inuse
, CTLFLAG_RD
| CTLFLAG_LOCKED
,
675 &dtrace_buffer_memory_inuse
, "dtrace state buffer memory in-use");
678 sysctl_dtrace_difo_maxsize SYSCTL_HANDLER_ARGS
680 #pragma unused(oidp, arg2, req)
682 size_t value
= *(size_t*) arg1
;
684 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, &changed
);
685 if (error
|| !changed
)
691 lck_mtx_lock(&dtrace_lock
);
692 dtrace_difo_maxsize
= value
;
693 lck_mtx_unlock(&dtrace_lock
);
699 * kern.dtrace.difo_maxsize
701 * Set the DIFO max size in bytes, check the definition of dtrace_difo_maxsize
702 * to get the default value. Attempting to set a null or negative size will
703 * result in a failure.
705 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, difo_maxsize
,
706 CTLTYPE_QUAD
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
707 &dtrace_difo_maxsize
, 0,
708 sysctl_dtrace_difo_maxsize
, "Q", "dtrace difo maxsize");
711 sysctl_dtrace_dof_maxsize SYSCTL_HANDLER_ARGS
713 #pragma unused(oidp, arg2, req)
715 dtrace_optval_t value
= *(dtrace_optval_t
*) arg1
;
717 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, &changed
);
718 if (error
|| !changed
)
724 lck_mtx_lock(&dtrace_lock
);
725 dtrace_dof_maxsize
= value
;
726 lck_mtx_unlock(&dtrace_lock
);
732 * kern.dtrace.dof_maxsize
734 * Set the DOF max size in bytes, check the definition of dtrace_dof_maxsize to
735 * get the default value. Attempting to set a null or negative size will result
738 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, dof_maxsize
,
739 CTLTYPE_QUAD
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
740 &dtrace_dof_maxsize
, 0,
741 sysctl_dtrace_dof_maxsize
, "Q", "dtrace dof maxsize");
744 sysctl_dtrace_statvar_maxsize SYSCTL_HANDLER_ARGS
746 #pragma unused(oidp, arg2, req)
748 dtrace_optval_t value
= *(dtrace_optval_t
*) arg1
;
750 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, &changed
);
751 if (error
|| !changed
)
756 if (value
> dtrace_statvar_maxsize_max
)
759 lck_mtx_lock(&dtrace_lock
);
760 dtrace_statvar_maxsize
= value
;
761 lck_mtx_unlock(&dtrace_lock
);
767 * kern.dtrace.global_maxsize
769 * Set the variable max size in bytes, check the definition of
770 * dtrace_statvar_maxsize to get the default value. Attempting to set a null,
771 * too high or negative size will result in a failure.
773 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, global_maxsize
,
774 CTLTYPE_QUAD
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
775 &dtrace_statvar_maxsize
, 0,
776 sysctl_dtrace_statvar_maxsize
, "Q", "dtrace statvar maxsize");
779 sysctl_dtrace_provide_private_probes SYSCTL_HANDLER_ARGS
781 #pragma unused(oidp, arg2)
783 int value
= *(int *) arg1
;
785 error
= sysctl_io_number(req
, value
, sizeof(value
), &value
, NULL
);
789 if (value
!= 0 && value
!= 1)
792 lck_mtx_lock(&dtrace_lock
);
793 dtrace_provide_private_probes
= value
;
794 lck_mtx_unlock(&dtrace_lock
);
800 * kern.dtrace.provide_private_probes
802 * Set whether the providers must provide the private probes. This is
803 * mainly used by the FBT provider to request probes for the private/static
806 SYSCTL_PROC(_kern_dtrace
, OID_AUTO
, provide_private_probes
,
807 CTLTYPE_INT
| CTLFLAG_RW
| CTLFLAG_LOCKED
,
808 &dtrace_provide_private_probes
, 0,
809 sysctl_dtrace_provide_private_probes
, "I", "provider must provide the private probes");
812 * DTrace Probe Context Functions
814 * These functions are called from probe context. Because probe context is
815 * any context in which C may be called, arbitrarily locks may be held,
816 * interrupts may be disabled, we may be in arbitrary dispatched state, etc.
817 * As a result, functions called from probe context may only call other DTrace
818 * support functions -- they may not interact at all with the system at large.
819 * (Note that the ASSERT macro is made probe-context safe by redefining it in
820 * terms of dtrace_assfail(), a probe-context safe function.) If arbitrary
821 * loads are to be performed from probe context, they _must_ be in terms of
822 * the safe dtrace_load*() variants.
824 * Some functions in this block are not actually called from probe context;
825 * for these functions, there will be a comment above the function reading
826 * "Note: not called from probe context."
830 dtrace_assfail(const char *a
, const char *f
, int l
)
832 panic("dtrace: assertion failed: %s, file: %s, line: %d", a
, f
, l
);
835 * We just need something here that even the most clever compiler
836 * cannot optimize away.
838 return (a
[(uintptr_t)f
]);
842 * Atomically increment a specified error counter from probe context.
845 dtrace_error(uint32_t *counter
)
848 * Most counters stored to in probe context are per-CPU counters.
849 * However, there are some error conditions that are sufficiently
850 * arcane that they don't merit per-CPU storage. If these counters
851 * are incremented concurrently on different CPUs, scalability will be
852 * adversely affected -- but we don't expect them to be white-hot in a
853 * correctly constructed enabling...
860 if ((nval
= oval
+ 1) == 0) {
862 * If the counter would wrap, set it to 1 -- assuring
863 * that the counter is never zero when we have seen
864 * errors. (The counter must be 32-bits because we
865 * aren't guaranteed a 64-bit compare&swap operation.)
866 * To save this code both the infamy of being fingered
867 * by a priggish news story and the indignity of being
868 * the target of a neo-puritan witch trial, we're
869 * carefully avoiding any colorful description of the
870 * likelihood of this condition -- but suffice it to
871 * say that it is only slightly more likely than the
872 * overflow of predicate cache IDs, as discussed in
873 * dtrace_predicate_create().
877 } while (dtrace_cas32(counter
, oval
, nval
) != oval
);
881 * Use the DTRACE_LOADFUNC macro to define functions for each of loading a
882 * uint8_t, a uint16_t, a uint32_t and a uint64_t.
890 dtrace_inscratch(uintptr_t dest
, size_t size
, dtrace_mstate_t
*mstate
)
892 if (dest
< mstate
->dtms_scratch_base
)
895 if (dest
+ size
< dest
)
898 if (dest
+ size
> mstate
->dtms_scratch_ptr
)
905 dtrace_canstore_statvar(uint64_t addr
, size_t sz
, size_t *remain
,
906 dtrace_statvar_t
**svars
, int nsvars
)
910 size_t maxglobalsize
, maxlocalsize
;
912 maxglobalsize
= dtrace_statvar_maxsize
+ sizeof (uint64_t);
913 maxlocalsize
= (maxglobalsize
) * NCPU
;
918 for (i
= 0; i
< nsvars
; i
++) {
919 dtrace_statvar_t
*svar
= svars
[i
];
923 if (svar
== NULL
|| (size
= svar
->dtsv_size
) == 0)
926 scope
= svar
->dtsv_var
.dtdv_scope
;
929 * We verify that our size is valid in the spirit of providing
930 * defense in depth: we want to prevent attackers from using
931 * DTrace to escalate an orthogonal kernel heap corruption bug
932 * into the ability to store to arbitrary locations in memory.
934 VERIFY((scope
== DIFV_SCOPE_GLOBAL
&& size
<= maxglobalsize
) ||
935 (scope
== DIFV_SCOPE_LOCAL
&& size
<= maxlocalsize
));
937 if (DTRACE_INRANGE(addr
, sz
, svar
->dtsv_data
, svar
->dtsv_size
)) {
938 DTRACE_RANGE_REMAIN(remain
, addr
, svar
->dtsv_data
,
948 * Check to see if the address is within a memory region to which a store may
949 * be issued. This includes the DTrace scratch areas, and any DTrace variable
950 * region. The caller of dtrace_canstore() is responsible for performing any
951 * alignment checks that are needed before stores are actually executed.
954 dtrace_canstore(uint64_t addr
, size_t sz
, dtrace_mstate_t
*mstate
,
955 dtrace_vstate_t
*vstate
)
957 return (dtrace_canstore_remains(addr
, sz
, NULL
, mstate
, vstate
));
960 * Implementation of dtrace_canstore which communicates the upper bound of the
961 * allowed memory region.
964 dtrace_canstore_remains(uint64_t addr
, size_t sz
, size_t *remain
,
965 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
)
968 * First, check to see if the address is in scratch space...
970 if (DTRACE_INRANGE(addr
, sz
, mstate
->dtms_scratch_base
,
971 mstate
->dtms_scratch_size
)) {
972 DTRACE_RANGE_REMAIN(remain
, addr
, mstate
->dtms_scratch_base
,
973 mstate
->dtms_scratch_size
);
977 * Now check to see if it's a dynamic variable. This check will pick
978 * up both thread-local variables and any global dynamically-allocated
981 if (DTRACE_INRANGE(addr
, sz
, (uintptr_t)vstate
->dtvs_dynvars
.dtds_base
,
982 vstate
->dtvs_dynvars
.dtds_size
)) {
983 dtrace_dstate_t
*dstate
= &vstate
->dtvs_dynvars
;
984 uintptr_t base
= (uintptr_t)dstate
->dtds_base
+
985 (dstate
->dtds_hashsize
* sizeof (dtrace_dynhash_t
));
987 dtrace_dynvar_t
*dvar
;
990 * Before we assume that we can store here, we need to make
991 * sure that it isn't in our metadata -- storing to our
992 * dynamic variable metadata would corrupt our state. For
993 * the range to not include any dynamic variable metadata,
996 * (1) Start above the hash table that is at the base of
997 * the dynamic variable space
999 * (2) Have a starting chunk offset that is beyond the
1000 * dtrace_dynvar_t that is at the base of every chunk
1002 * (3) Not span a chunk boundary
1004 * (4) Not be in the tuple space of a dynamic variable
1010 chunkoffs
= (addr
- base
) % dstate
->dtds_chunksize
;
1012 if (chunkoffs
< sizeof (dtrace_dynvar_t
))
1015 if (chunkoffs
+ sz
> dstate
->dtds_chunksize
)
1018 dvar
= (dtrace_dynvar_t
*)((uintptr_t)addr
- chunkoffs
);
1020 if (dvar
->dtdv_hashval
== DTRACE_DYNHASH_FREE
)
1023 if (chunkoffs
< sizeof (dtrace_dynvar_t
) +
1024 ((dvar
->dtdv_tuple
.dtt_nkeys
- 1) * sizeof (dtrace_key_t
)))
1031 * Finally, check the static local and global variables. These checks
1032 * take the longest, so we perform them last.
1034 if (dtrace_canstore_statvar(addr
, sz
, remain
,
1035 vstate
->dtvs_locals
, vstate
->dtvs_nlocals
))
1038 if (dtrace_canstore_statvar(addr
, sz
, remain
,
1039 vstate
->dtvs_globals
, vstate
->dtvs_nglobals
))
1047 * Convenience routine to check to see if the address is within a memory
1048 * region in which a load may be issued given the user's privilege level;
1049 * if not, it sets the appropriate error flags and loads 'addr' into the
1050 * illegal value slot.
1052 * DTrace subroutines (DIF_SUBR_*) should use this helper to implement
1053 * appropriate memory access protection.
1056 dtrace_canload(uint64_t addr
, size_t sz
, dtrace_mstate_t
*mstate
,
1057 dtrace_vstate_t
*vstate
)
1059 return (dtrace_canload_remains(addr
, sz
, NULL
, mstate
, vstate
));
1063 * Implementation of dtrace_canload which communicates the upper bound of the
1064 * allowed memory region.
1067 dtrace_canload_remains(uint64_t addr
, size_t sz
, size_t *remain
,
1068 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
)
1070 volatile uint64_t *illval
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
;
1073 * If we hold the privilege to read from kernel memory, then
1074 * everything is readable.
1076 if ((mstate
->dtms_access
& DTRACE_ACCESS_KERNEL
) != 0) {
1077 DTRACE_RANGE_REMAIN(remain
, addr
, addr
, sz
);
1082 * You can obviously read that which you can store.
1084 if (dtrace_canstore_remains(addr
, sz
, remain
, mstate
, vstate
))
1088 * We're allowed to read from our own string table.
1090 if (DTRACE_INRANGE(addr
, sz
, (uintptr_t)mstate
->dtms_difo
->dtdo_strtab
,
1091 mstate
->dtms_difo
->dtdo_strlen
)) {
1092 DTRACE_RANGE_REMAIN(remain
, addr
,
1093 mstate
->dtms_difo
->dtdo_strtab
,
1094 mstate
->dtms_difo
->dtdo_strlen
);
1098 DTRACE_CPUFLAG_SET(CPU_DTRACE_KPRIV
);
1104 * Convenience routine to check to see if a given string is within a memory
1105 * region in which a load may be issued given the user's privilege level;
1106 * this exists so that we don't need to issue unnecessary dtrace_strlen()
1107 * calls in the event that the user has all privileges.
1110 dtrace_strcanload(uint64_t addr
, size_t sz
, size_t *remain
,
1111 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
)
1116 * If we hold the privilege to read from kernel memory, then
1117 * everything is readable.
1119 if ((mstate
->dtms_access
& DTRACE_ACCESS_KERNEL
) != 0) {
1120 DTRACE_RANGE_REMAIN(remain
, addr
, addr
, sz
);
1125 * Even if the caller is uninterested in querying the remaining valid
1126 * range, it is required to ensure that the access is allowed.
1128 if (remain
== NULL
) {
1131 if (dtrace_canload_remains(addr
, 0, remain
, mstate
, vstate
)) {
1134 * Perform the strlen after determining the length of the
1135 * memory region which is accessible. This prevents timing
1136 * information from being used to find NULs in memory which is
1137 * not accessible to the caller.
1139 strsz
= 1 + dtrace_strlen((char *)(uintptr_t)addr
,
1141 if (strsz
<= *remain
) {
1150 * Convenience routine to check to see if a given variable is within a memory
1151 * region in which a load may be issued given the user's privilege level.
1154 dtrace_vcanload(void *src
, dtrace_diftype_t
*type
, size_t *remain
,
1155 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
)
1158 ASSERT(type
->dtdt_flags
& DIF_TF_BYREF
);
1161 * Calculate the max size before performing any checks since even
1162 * DTRACE_ACCESS_KERNEL-credentialed callers expect that this function
1163 * return the max length via 'remain'.
1165 if (type
->dtdt_kind
== DIF_TYPE_STRING
) {
1166 dtrace_state_t
*state
= vstate
->dtvs_state
;
1168 if (state
!= NULL
) {
1169 sz
= state
->dts_options
[DTRACEOPT_STRSIZE
];
1172 * In helper context, we have a NULL state; fall back
1173 * to using the system-wide default for the string size
1176 sz
= dtrace_strsize_default
;
1179 sz
= type
->dtdt_size
;
1183 * If we hold the privilege to read from kernel memory, then
1184 * everything is readable.
1186 if ((mstate
->dtms_access
& DTRACE_ACCESS_KERNEL
) != 0) {
1187 DTRACE_RANGE_REMAIN(remain
, (uintptr_t)src
, src
, sz
);
1191 if (type
->dtdt_kind
== DIF_TYPE_STRING
) {
1192 return (dtrace_strcanload((uintptr_t)src
, sz
, remain
, mstate
,
1195 return (dtrace_canload_remains((uintptr_t)src
, sz
, remain
, mstate
,
1200 * Compare two strings using safe loads.
1203 dtrace_strncmp(char *s1
, char *s2
, size_t limit
)
1206 volatile uint16_t *flags
;
1208 if (s1
== s2
|| limit
== 0)
1211 flags
= (volatile uint16_t *)&cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
1217 c1
= dtrace_load8((uintptr_t)s1
++);
1223 c2
= dtrace_load8((uintptr_t)s2
++);
1228 } while (--limit
&& c1
!= '\0' && !(*flags
& CPU_DTRACE_FAULT
));
1234 * Compute strlen(s) for a string using safe memory accesses. The additional
1235 * len parameter is used to specify a maximum length to ensure completion.
1238 dtrace_strlen(const char *s
, size_t lim
)
1242 for (len
= 0; len
!= lim
; len
++) {
1243 if (dtrace_load8((uintptr_t)s
++) == '\0')
1251 * Check if an address falls within a toxic region.
1254 dtrace_istoxic(uintptr_t kaddr
, size_t size
)
1256 uintptr_t taddr
, tsize
;
1259 for (i
= 0; i
< dtrace_toxranges
; i
++) {
1260 taddr
= dtrace_toxrange
[i
].dtt_base
;
1261 tsize
= dtrace_toxrange
[i
].dtt_limit
- taddr
;
1263 if (kaddr
- taddr
< tsize
) {
1264 DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR
);
1265 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
= kaddr
;
1269 if (taddr
- kaddr
< size
) {
1270 DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR
);
1271 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
= taddr
;
1280 * Copy src to dst using safe memory accesses. The src is assumed to be unsafe
1281 * memory specified by the DIF program. The dst is assumed to be safe memory
1282 * that we can store to directly because it is managed by DTrace. As with
1283 * standard bcopy, overlapping copies are handled properly.
1286 dtrace_bcopy(const void *src
, void *dst
, size_t len
)
1290 const uint8_t *s2
= src
;
1294 *s1
++ = dtrace_load8((uintptr_t)s2
++);
1295 } while (--len
!= 0);
1301 *--s1
= dtrace_load8((uintptr_t)--s2
);
1302 } while (--len
!= 0);
1308 * Copy src to dst using safe memory accesses, up to either the specified
1309 * length, or the point that a nul byte is encountered. The src is assumed to
1310 * be unsafe memory specified by the DIF program. The dst is assumed to be
1311 * safe memory that we can store to directly because it is managed by DTrace.
1312 * Unlike dtrace_bcopy(), overlapping regions are not handled.
1315 dtrace_strcpy(const void *src
, void *dst
, size_t len
)
1318 uint8_t *s1
= dst
, c
;
1319 const uint8_t *s2
= src
;
1322 *s1
++ = c
= dtrace_load8((uintptr_t)s2
++);
1323 } while (--len
!= 0 && c
!= '\0');
1328 * Copy src to dst, deriving the size and type from the specified (BYREF)
1329 * variable type. The src is assumed to be unsafe memory specified by the DIF
1330 * program. The dst is assumed to be DTrace variable memory that is of the
1331 * specified type; we assume that we can store to directly.
1334 dtrace_vcopy(void *src
, void *dst
, dtrace_diftype_t
*type
, size_t limit
)
1336 ASSERT(type
->dtdt_flags
& DIF_TF_BYREF
);
1338 if (type
->dtdt_kind
== DIF_TYPE_STRING
) {
1339 dtrace_strcpy(src
, dst
, MIN(type
->dtdt_size
, limit
));
1341 dtrace_bcopy(src
, dst
, MIN(type
->dtdt_size
, limit
));
1346 * Compare s1 to s2 using safe memory accesses. The s1 data is assumed to be
1347 * unsafe memory specified by the DIF program. The s2 data is assumed to be
1348 * safe memory that we can access directly because it is managed by DTrace.
1351 dtrace_bcmp(const void *s1
, const void *s2
, size_t len
)
1353 volatile uint16_t *flags
;
1355 flags
= (volatile uint16_t *)&cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
1360 if (s1
== NULL
|| s2
== NULL
)
1363 if (s1
!= s2
&& len
!= 0) {
1364 const uint8_t *ps1
= s1
;
1365 const uint8_t *ps2
= s2
;
1368 if (dtrace_load8((uintptr_t)ps1
++) != *ps2
++)
1370 } while (--len
!= 0 && !(*flags
& CPU_DTRACE_FAULT
));
1376 * Zero the specified region using a simple byte-by-byte loop. Note that this
1377 * is for safe DTrace-managed memory only.
1380 dtrace_bzero(void *dst
, size_t len
)
1384 for (cp
= dst
; len
!= 0; len
--)
1389 dtrace_add_128(uint64_t *addend1
, uint64_t *addend2
, uint64_t *sum
)
1393 result
[0] = addend1
[0] + addend2
[0];
1394 result
[1] = addend1
[1] + addend2
[1] +
1395 (result
[0] < addend1
[0] || result
[0] < addend2
[0] ? 1 : 0);
1402 * Shift the 128-bit value in a by b. If b is positive, shift left.
1403 * If b is negative, shift right.
1406 dtrace_shift_128(uint64_t *a
, int b
)
1416 a
[0] = a
[1] >> (b
- 64);
1420 mask
= 1LL << (64 - b
);
1422 a
[0] |= ((a
[1] & mask
) << (64 - b
));
1427 a
[1] = a
[0] << (b
- 64);
1431 mask
= a
[0] >> (64 - b
);
1439 * The basic idea is to break the 2 64-bit values into 4 32-bit values,
1440 * use native multiplication on those, and then re-combine into the
1441 * resulting 128-bit value.
1443 * (hi1 << 32 + lo1) * (hi2 << 32 + lo2) =
1450 dtrace_multiply_128(uint64_t factor1
, uint64_t factor2
, uint64_t *product
)
1452 uint64_t hi1
, hi2
, lo1
, lo2
;
1455 hi1
= factor1
>> 32;
1456 hi2
= factor2
>> 32;
1458 lo1
= factor1
& DT_MASK_LO
;
1459 lo2
= factor2
& DT_MASK_LO
;
1461 product
[0] = lo1
* lo2
;
1462 product
[1] = hi1
* hi2
;
1466 dtrace_shift_128(tmp
, 32);
1467 dtrace_add_128(product
, tmp
, product
);
1471 dtrace_shift_128(tmp
, 32);
1472 dtrace_add_128(product
, tmp
, product
);
1476 * This privilege check should be used by actions and subroutines to
1477 * verify that the user credentials of the process that enabled the
1478 * invoking ECB match the target credentials
1481 dtrace_priv_proc_common_user(dtrace_state_t
*state
)
1483 cred_t
*cr
, *s_cr
= state
->dts_cred
.dcr_cred
;
1486 * We should always have a non-NULL state cred here, since if cred
1487 * is null (anonymous tracing), we fast-path bypass this routine.
1489 ASSERT(s_cr
!= NULL
);
1491 if ((cr
= dtrace_CRED()) != NULL
&&
1492 posix_cred_get(s_cr
)->cr_uid
== posix_cred_get(cr
)->cr_uid
&&
1493 posix_cred_get(s_cr
)->cr_uid
== posix_cred_get(cr
)->cr_ruid
&&
1494 posix_cred_get(s_cr
)->cr_uid
== posix_cred_get(cr
)->cr_suid
&&
1495 posix_cred_get(s_cr
)->cr_gid
== posix_cred_get(cr
)->cr_gid
&&
1496 posix_cred_get(s_cr
)->cr_gid
== posix_cred_get(cr
)->cr_rgid
&&
1497 posix_cred_get(s_cr
)->cr_gid
== posix_cred_get(cr
)->cr_sgid
)
1504 * This privilege check should be used by actions and subroutines to
1505 * verify that the zone of the process that enabled the invoking ECB
1506 * matches the target credentials
1509 dtrace_priv_proc_common_zone(dtrace_state_t
*state
)
1511 cred_t
*cr
, *s_cr
= state
->dts_cred
.dcr_cred
;
1512 #pragma unused(cr, s_cr, state) /* __APPLE__ */
1515 * We should always have a non-NULL state cred here, since if cred
1516 * is null (anonymous tracing), we fast-path bypass this routine.
1518 ASSERT(s_cr
!= NULL
);
1520 return 1; /* APPLE NOTE: Darwin doesn't do zones. */
1524 * This privilege check should be used by actions and subroutines to
1525 * verify that the process has not setuid or changed credentials.
1528 dtrace_priv_proc_common_nocd(void)
1530 return 1; /* Darwin omits "No Core Dump" flag. */
1534 dtrace_priv_proc_destructive(dtrace_state_t
*state
)
1536 int action
= state
->dts_cred
.dcr_action
;
1538 if (ISSET(current_proc()->p_lflag
, P_LNOATTACH
))
1541 if (dtrace_is_restricted() && !dtrace_can_attach_to_proc(current_proc()))
1544 if (((action
& DTRACE_CRA_PROC_DESTRUCTIVE_ALLZONE
) == 0) &&
1545 dtrace_priv_proc_common_zone(state
) == 0)
1548 if (((action
& DTRACE_CRA_PROC_DESTRUCTIVE_ALLUSER
) == 0) &&
1549 dtrace_priv_proc_common_user(state
) == 0)
1552 if (((action
& DTRACE_CRA_PROC_DESTRUCTIVE_CREDCHG
) == 0) &&
1553 dtrace_priv_proc_common_nocd() == 0)
1559 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_UPRIV
;
1565 dtrace_priv_proc_control(dtrace_state_t
*state
)
1567 if (ISSET(current_proc()->p_lflag
, P_LNOATTACH
))
1570 if (dtrace_is_restricted() && !dtrace_can_attach_to_proc(current_proc()))
1573 if (state
->dts_cred
.dcr_action
& DTRACE_CRA_PROC_CONTROL
)
1576 if (dtrace_priv_proc_common_zone(state
) &&
1577 dtrace_priv_proc_common_user(state
) &&
1578 dtrace_priv_proc_common_nocd())
1582 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_UPRIV
;
1588 dtrace_priv_proc(dtrace_state_t
*state
)
1590 if (ISSET(current_proc()->p_lflag
, P_LNOATTACH
))
1593 if (dtrace_is_restricted() && !dtrace_are_restrictions_relaxed() && !dtrace_can_attach_to_proc(current_proc()))
1596 if (state
->dts_cred
.dcr_action
& DTRACE_CRA_PROC
)
1600 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_UPRIV
;
1606 * The P_LNOATTACH check is an Apple specific check.
1607 * We need a version of dtrace_priv_proc() that omits
1608 * that check for PID and EXECNAME accesses
1611 dtrace_priv_proc_relaxed(dtrace_state_t
*state
)
1614 if (state
->dts_cred
.dcr_action
& DTRACE_CRA_PROC
)
1617 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_UPRIV
;
1623 dtrace_priv_kernel(dtrace_state_t
*state
)
1625 if (dtrace_is_restricted() && !dtrace_are_restrictions_relaxed())
1628 if (state
->dts_cred
.dcr_action
& DTRACE_CRA_KERNEL
)
1632 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_KPRIV
;
1638 dtrace_priv_kernel_destructive(dtrace_state_t
*state
)
1640 if (dtrace_is_restricted())
1643 if (state
->dts_cred
.dcr_action
& DTRACE_CRA_KERNEL_DESTRUCTIVE
)
1647 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
|= CPU_DTRACE_KPRIV
;
1653 * Note: not called from probe context. This function is called
1654 * asynchronously (and at a regular interval) from outside of probe context to
1655 * clean the dirty dynamic variable lists on all CPUs. Dynamic variable
1656 * cleaning is explained in detail in <sys/dtrace_impl.h>.
1659 dtrace_dynvar_clean(dtrace_dstate_t
*dstate
)
1661 dtrace_dynvar_t
*dirty
;
1662 dtrace_dstate_percpu_t
*dcpu
;
1665 for (i
= 0; i
< (int)NCPU
; i
++) {
1666 dcpu
= &dstate
->dtds_percpu
[i
];
1668 ASSERT(dcpu
->dtdsc_rinsing
== NULL
);
1671 * If the dirty list is NULL, there is no dirty work to do.
1673 if (dcpu
->dtdsc_dirty
== NULL
)
1677 * If the clean list is non-NULL, then we're not going to do
1678 * any work for this CPU -- it means that there has not been
1679 * a dtrace_dynvar() allocation on this CPU (or from this CPU)
1680 * since the last time we cleaned house.
1682 if (dcpu
->dtdsc_clean
!= NULL
)
1688 * Atomically move the dirty list aside.
1691 dirty
= dcpu
->dtdsc_dirty
;
1694 * Before we zap the dirty list, set the rinsing list.
1695 * (This allows for a potential assertion in
1696 * dtrace_dynvar(): if a free dynamic variable appears
1697 * on a hash chain, either the dirty list or the
1698 * rinsing list for some CPU must be non-NULL.)
1700 dcpu
->dtdsc_rinsing
= dirty
;
1701 dtrace_membar_producer();
1702 } while (dtrace_casptr(&dcpu
->dtdsc_dirty
,
1703 dirty
, NULL
) != dirty
);
1708 * We have no work to do; we can simply return.
1715 for (i
= 0; i
< (int)NCPU
; i
++) {
1716 dcpu
= &dstate
->dtds_percpu
[i
];
1718 if (dcpu
->dtdsc_rinsing
== NULL
)
1722 * We are now guaranteed that no hash chain contains a pointer
1723 * into this dirty list; we can make it clean.
1725 ASSERT(dcpu
->dtdsc_clean
== NULL
);
1726 dcpu
->dtdsc_clean
= dcpu
->dtdsc_rinsing
;
1727 dcpu
->dtdsc_rinsing
= NULL
;
1731 * Before we actually set the state to be DTRACE_DSTATE_CLEAN, make
1732 * sure that all CPUs have seen all of the dtdsc_clean pointers.
1733 * This prevents a race whereby a CPU incorrectly decides that
1734 * the state should be something other than DTRACE_DSTATE_CLEAN
1735 * after dtrace_dynvar_clean() has completed.
1739 dstate
->dtds_state
= DTRACE_DSTATE_CLEAN
;
1743 * Depending on the value of the op parameter, this function looks-up,
1744 * allocates or deallocates an arbitrarily-keyed dynamic variable. If an
1745 * allocation is requested, this function will return a pointer to a
1746 * dtrace_dynvar_t corresponding to the allocated variable -- or NULL if no
1747 * variable can be allocated. If NULL is returned, the appropriate counter
1748 * will be incremented.
1750 static dtrace_dynvar_t
*
1751 dtrace_dynvar(dtrace_dstate_t
*dstate
, uint_t nkeys
,
1752 dtrace_key_t
*key
, size_t dsize
, dtrace_dynvar_op_t op
,
1753 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
)
1755 uint64_t hashval
= DTRACE_DYNHASH_VALID
;
1756 dtrace_dynhash_t
*hash
= dstate
->dtds_hash
;
1757 dtrace_dynvar_t
*free
, *new_free
, *next
, *dvar
, *start
, *prev
= NULL
;
1758 processorid_t me
= CPU
->cpu_id
, cpu
= me
;
1759 dtrace_dstate_percpu_t
*dcpu
= &dstate
->dtds_percpu
[me
];
1760 size_t bucket
, ksize
;
1761 size_t chunksize
= dstate
->dtds_chunksize
;
1762 uintptr_t kdata
, lock
, nstate
;
1768 * Hash the key. As with aggregations, we use Jenkins' "One-at-a-time"
1769 * algorithm. For the by-value portions, we perform the algorithm in
1770 * 16-bit chunks (as opposed to 8-bit chunks). This speeds things up a
1771 * bit, and seems to have only a minute effect on distribution. For
1772 * the by-reference data, we perform "One-at-a-time" iterating (safely)
1773 * over each referenced byte. It's painful to do this, but it's much
1774 * better than pathological hash distribution. The efficacy of the
1775 * hashing algorithm (and a comparison with other algorithms) may be
1776 * found by running the ::dtrace_dynstat MDB dcmd.
1778 for (i
= 0; i
< nkeys
; i
++) {
1779 if (key
[i
].dttk_size
== 0) {
1780 uint64_t val
= key
[i
].dttk_value
;
1782 hashval
+= (val
>> 48) & 0xffff;
1783 hashval
+= (hashval
<< 10);
1784 hashval
^= (hashval
>> 6);
1786 hashval
+= (val
>> 32) & 0xffff;
1787 hashval
+= (hashval
<< 10);
1788 hashval
^= (hashval
>> 6);
1790 hashval
+= (val
>> 16) & 0xffff;
1791 hashval
+= (hashval
<< 10);
1792 hashval
^= (hashval
>> 6);
1794 hashval
+= val
& 0xffff;
1795 hashval
+= (hashval
<< 10);
1796 hashval
^= (hashval
>> 6);
1799 * This is incredibly painful, but it beats the hell
1800 * out of the alternative.
1802 uint64_t j
, size
= key
[i
].dttk_size
;
1803 uintptr_t base
= (uintptr_t)key
[i
].dttk_value
;
1805 if (!dtrace_canload(base
, size
, mstate
, vstate
))
1808 for (j
= 0; j
< size
; j
++) {
1809 hashval
+= dtrace_load8(base
+ j
);
1810 hashval
+= (hashval
<< 10);
1811 hashval
^= (hashval
>> 6);
1816 if (DTRACE_CPUFLAG_ISSET(CPU_DTRACE_FAULT
))
1819 hashval
+= (hashval
<< 3);
1820 hashval
^= (hashval
>> 11);
1821 hashval
+= (hashval
<< 15);
1824 * There is a remote chance (ideally, 1 in 2^31) that our hashval
1825 * comes out to be one of our two sentinel hash values. If this
1826 * actually happens, we set the hashval to be a value known to be a
1827 * non-sentinel value.
1829 if (hashval
== DTRACE_DYNHASH_FREE
|| hashval
== DTRACE_DYNHASH_SINK
)
1830 hashval
= DTRACE_DYNHASH_VALID
;
1833 * Yes, it's painful to do a divide here. If the cycle count becomes
1834 * important here, tricks can be pulled to reduce it. (However, it's
1835 * critical that hash collisions be kept to an absolute minimum;
1836 * they're much more painful than a divide.) It's better to have a
1837 * solution that generates few collisions and still keeps things
1838 * relatively simple.
1840 bucket
= hashval
% dstate
->dtds_hashsize
;
1842 if (op
== DTRACE_DYNVAR_DEALLOC
) {
1843 volatile uintptr_t *lockp
= &hash
[bucket
].dtdh_lock
;
1846 while ((lock
= *lockp
) & 1)
1849 if (dtrace_casptr((void *)(uintptr_t)lockp
,
1850 (void *)lock
, (void *)(lock
+ 1)) == (void *)lock
)
1854 dtrace_membar_producer();
1859 lock
= hash
[bucket
].dtdh_lock
;
1861 dtrace_membar_consumer();
1863 start
= hash
[bucket
].dtdh_chain
;
1864 ASSERT(start
!= NULL
&& (start
->dtdv_hashval
== DTRACE_DYNHASH_SINK
||
1865 start
->dtdv_hashval
!= DTRACE_DYNHASH_FREE
||
1866 op
!= DTRACE_DYNVAR_DEALLOC
));
1868 for (dvar
= start
; dvar
!= NULL
; dvar
= dvar
->dtdv_next
) {
1869 dtrace_tuple_t
*dtuple
= &dvar
->dtdv_tuple
;
1870 dtrace_key_t
*dkey
= &dtuple
->dtt_key
[0];
1872 if (dvar
->dtdv_hashval
!= hashval
) {
1873 if (dvar
->dtdv_hashval
== DTRACE_DYNHASH_SINK
) {
1875 * We've reached the sink, and therefore the
1876 * end of the hash chain; we can kick out of
1877 * the loop knowing that we have seen a valid
1878 * snapshot of state.
1880 ASSERT(dvar
->dtdv_next
== NULL
);
1881 ASSERT(dvar
== &dtrace_dynhash_sink
);
1885 if (dvar
->dtdv_hashval
== DTRACE_DYNHASH_FREE
) {
1887 * We've gone off the rails: somewhere along
1888 * the line, one of the members of this hash
1889 * chain was deleted. Note that we could also
1890 * detect this by simply letting this loop run
1891 * to completion, as we would eventually hit
1892 * the end of the dirty list. However, we
1893 * want to avoid running the length of the
1894 * dirty list unnecessarily (it might be quite
1895 * long), so we catch this as early as
1896 * possible by detecting the hash marker. In
1897 * this case, we simply set dvar to NULL and
1898 * break; the conditional after the loop will
1899 * send us back to top.
1908 if (dtuple
->dtt_nkeys
!= nkeys
)
1911 for (i
= 0; i
< nkeys
; i
++, dkey
++) {
1912 if (dkey
->dttk_size
!= key
[i
].dttk_size
)
1913 goto next
; /* size or type mismatch */
1915 if (dkey
->dttk_size
!= 0) {
1917 (void *)(uintptr_t)key
[i
].dttk_value
,
1918 (void *)(uintptr_t)dkey
->dttk_value
,
1922 if (dkey
->dttk_value
!= key
[i
].dttk_value
)
1927 if (op
!= DTRACE_DYNVAR_DEALLOC
)
1930 ASSERT(dvar
->dtdv_next
== NULL
||
1931 dvar
->dtdv_next
->dtdv_hashval
!= DTRACE_DYNHASH_FREE
);
1934 ASSERT(hash
[bucket
].dtdh_chain
!= dvar
);
1935 ASSERT(start
!= dvar
);
1936 ASSERT(prev
->dtdv_next
== dvar
);
1937 prev
->dtdv_next
= dvar
->dtdv_next
;
1939 if (dtrace_casptr(&hash
[bucket
].dtdh_chain
,
1940 start
, dvar
->dtdv_next
) != start
) {
1942 * We have failed to atomically swing the
1943 * hash table head pointer, presumably because
1944 * of a conflicting allocation on another CPU.
1945 * We need to reread the hash chain and try
1952 dtrace_membar_producer();
1955 * Now set the hash value to indicate that it's free.
1957 ASSERT(hash
[bucket
].dtdh_chain
!= dvar
);
1958 dvar
->dtdv_hashval
= DTRACE_DYNHASH_FREE
;
1960 dtrace_membar_producer();
1963 * Set the next pointer to point at the dirty list, and
1964 * atomically swing the dirty pointer to the newly freed dvar.
1967 next
= dcpu
->dtdsc_dirty
;
1968 dvar
->dtdv_next
= next
;
1969 } while (dtrace_casptr(&dcpu
->dtdsc_dirty
, next
, dvar
) != next
);
1972 * Finally, unlock this hash bucket.
1974 ASSERT(hash
[bucket
].dtdh_lock
== lock
);
1976 hash
[bucket
].dtdh_lock
++;
1986 * If dvar is NULL, it is because we went off the rails:
1987 * one of the elements that we traversed in the hash chain
1988 * was deleted while we were traversing it. In this case,
1989 * we assert that we aren't doing a dealloc (deallocs lock
1990 * the hash bucket to prevent themselves from racing with
1991 * one another), and retry the hash chain traversal.
1993 ASSERT(op
!= DTRACE_DYNVAR_DEALLOC
);
1997 if (op
!= DTRACE_DYNVAR_ALLOC
) {
1999 * If we are not to allocate a new variable, we want to
2000 * return NULL now. Before we return, check that the value
2001 * of the lock word hasn't changed. If it has, we may have
2002 * seen an inconsistent snapshot.
2004 if (op
== DTRACE_DYNVAR_NOALLOC
) {
2005 if (hash
[bucket
].dtdh_lock
!= lock
)
2008 ASSERT(op
== DTRACE_DYNVAR_DEALLOC
);
2009 ASSERT(hash
[bucket
].dtdh_lock
== lock
);
2011 hash
[bucket
].dtdh_lock
++;
2018 * We need to allocate a new dynamic variable. The size we need is the
2019 * size of dtrace_dynvar plus the size of nkeys dtrace_key_t's plus the
2020 * size of any auxiliary key data (rounded up to 8-byte alignment) plus
2021 * the size of any referred-to data (dsize). We then round the final
2022 * size up to the chunksize for allocation.
2024 for (ksize
= 0, i
= 0; i
< nkeys
; i
++)
2025 ksize
+= P2ROUNDUP(key
[i
].dttk_size
, sizeof (uint64_t));
2028 * This should be pretty much impossible, but could happen if, say,
2029 * strange DIF specified the tuple. Ideally, this should be an
2030 * assertion and not an error condition -- but that requires that the
2031 * chunksize calculation in dtrace_difo_chunksize() be absolutely
2032 * bullet-proof. (That is, it must not be able to be fooled by
2033 * malicious DIF.) Given the lack of backwards branches in DIF,
2034 * solving this would presumably not amount to solving the Halting
2035 * Problem -- but it still seems awfully hard.
2037 if (sizeof (dtrace_dynvar_t
) + sizeof (dtrace_key_t
) * (nkeys
- 1) +
2038 ksize
+ dsize
> chunksize
) {
2039 dcpu
->dtdsc_drops
++;
2043 nstate
= DTRACE_DSTATE_EMPTY
;
2047 free
= dcpu
->dtdsc_free
;
2050 dtrace_dynvar_t
*clean
= dcpu
->dtdsc_clean
;
2053 if (clean
== NULL
) {
2055 * We're out of dynamic variable space on
2056 * this CPU. Unless we have tried all CPUs,
2057 * we'll try to allocate from a different
2060 switch (dstate
->dtds_state
) {
2061 case DTRACE_DSTATE_CLEAN
: {
2062 void *sp
= &dstate
->dtds_state
;
2064 if (++cpu
>= (int)NCPU
)
2067 if (dcpu
->dtdsc_dirty
!= NULL
&&
2068 nstate
== DTRACE_DSTATE_EMPTY
)
2069 nstate
= DTRACE_DSTATE_DIRTY
;
2071 if (dcpu
->dtdsc_rinsing
!= NULL
)
2072 nstate
= DTRACE_DSTATE_RINSING
;
2074 dcpu
= &dstate
->dtds_percpu
[cpu
];
2079 (void) dtrace_cas32(sp
,
2080 DTRACE_DSTATE_CLEAN
, nstate
);
2083 * To increment the correct bean
2084 * counter, take another lap.
2089 case DTRACE_DSTATE_DIRTY
:
2090 dcpu
->dtdsc_dirty_drops
++;
2093 case DTRACE_DSTATE_RINSING
:
2094 dcpu
->dtdsc_rinsing_drops
++;
2097 case DTRACE_DSTATE_EMPTY
:
2098 dcpu
->dtdsc_drops
++;
2102 DTRACE_CPUFLAG_SET(CPU_DTRACE_DROP
);
2107 * The clean list appears to be non-empty. We want to
2108 * move the clean list to the free list; we start by
2109 * moving the clean pointer aside.
2111 if (dtrace_casptr(&dcpu
->dtdsc_clean
,
2112 clean
, NULL
) != clean
) {
2114 * We are in one of two situations:
2116 * (a) The clean list was switched to the
2117 * free list by another CPU.
2119 * (b) The clean list was added to by the
2122 * In either of these situations, we can
2123 * just reattempt the free list allocation.
2128 ASSERT(clean
->dtdv_hashval
== DTRACE_DYNHASH_FREE
);
2131 * Now we'll move the clean list to the free list.
2132 * It's impossible for this to fail: the only way
2133 * the free list can be updated is through this
2134 * code path, and only one CPU can own the clean list.
2135 * Thus, it would only be possible for this to fail if
2136 * this code were racing with dtrace_dynvar_clean().
2137 * (That is, if dtrace_dynvar_clean() updated the clean
2138 * list, and we ended up racing to update the free
2139 * list.) This race is prevented by the dtrace_sync()
2140 * in dtrace_dynvar_clean() -- which flushes the
2141 * owners of the clean lists out before resetting
2144 rval
= dtrace_casptr(&dcpu
->dtdsc_free
, NULL
, clean
);
2145 ASSERT(rval
== NULL
);
2150 new_free
= dvar
->dtdv_next
;
2151 } while (dtrace_casptr(&dcpu
->dtdsc_free
, free
, new_free
) != free
);
2154 * We have now allocated a new chunk. We copy the tuple keys into the
2155 * tuple array and copy any referenced key data into the data space
2156 * following the tuple array. As we do this, we relocate dttk_value
2157 * in the final tuple to point to the key data address in the chunk.
2159 kdata
= (uintptr_t)&dvar
->dtdv_tuple
.dtt_key
[nkeys
];
2160 dvar
->dtdv_data
= (void *)(kdata
+ ksize
);
2161 dvar
->dtdv_tuple
.dtt_nkeys
= nkeys
;
2163 for (i
= 0; i
< nkeys
; i
++) {
2164 dtrace_key_t
*dkey
= &dvar
->dtdv_tuple
.dtt_key
[i
];
2165 size_t kesize
= key
[i
].dttk_size
;
2169 (const void *)(uintptr_t)key
[i
].dttk_value
,
2170 (void *)kdata
, kesize
);
2171 dkey
->dttk_value
= kdata
;
2172 kdata
+= P2ROUNDUP(kesize
, sizeof (uint64_t));
2174 dkey
->dttk_value
= key
[i
].dttk_value
;
2177 dkey
->dttk_size
= kesize
;
2180 ASSERT(dvar
->dtdv_hashval
== DTRACE_DYNHASH_FREE
);
2181 dvar
->dtdv_hashval
= hashval
;
2182 dvar
->dtdv_next
= start
;
2184 if (dtrace_casptr(&hash
[bucket
].dtdh_chain
, start
, dvar
) == start
)
2188 * The cas has failed. Either another CPU is adding an element to
2189 * this hash chain, or another CPU is deleting an element from this
2190 * hash chain. The simplest way to deal with both of these cases
2191 * (though not necessarily the most efficient) is to free our
2192 * allocated block and tail-call ourselves. Note that the free is
2193 * to the dirty list and _not_ to the free list. This is to prevent
2194 * races with allocators, above.
2196 dvar
->dtdv_hashval
= DTRACE_DYNHASH_FREE
;
2198 dtrace_membar_producer();
2201 free
= dcpu
->dtdsc_dirty
;
2202 dvar
->dtdv_next
= free
;
2203 } while (dtrace_casptr(&dcpu
->dtdsc_dirty
, free
, dvar
) != free
);
2205 return (dtrace_dynvar(dstate
, nkeys
, key
, dsize
, op
, mstate
, vstate
));
2210 dtrace_aggregate_min(uint64_t *oval
, uint64_t nval
, uint64_t arg
)
2212 #pragma unused(arg) /* __APPLE__ */
2213 if ((int64_t)nval
< (int64_t)*oval
)
2219 dtrace_aggregate_max(uint64_t *oval
, uint64_t nval
, uint64_t arg
)
2221 #pragma unused(arg) /* __APPLE__ */
2222 if ((int64_t)nval
> (int64_t)*oval
)
2227 dtrace_aggregate_quantize(uint64_t *quanta
, uint64_t nval
, uint64_t incr
)
2229 int i
, zero
= DTRACE_QUANTIZE_ZEROBUCKET
;
2230 int64_t val
= (int64_t)nval
;
2233 for (i
= 0; i
< zero
; i
++) {
2234 if (val
<= DTRACE_QUANTIZE_BUCKETVAL(i
)) {
2240 for (i
= zero
+ 1; i
< DTRACE_QUANTIZE_NBUCKETS
; i
++) {
2241 if (val
< DTRACE_QUANTIZE_BUCKETVAL(i
)) {
2242 quanta
[i
- 1] += incr
;
2247 quanta
[DTRACE_QUANTIZE_NBUCKETS
- 1] += incr
;
2255 dtrace_aggregate_lquantize(uint64_t *lquanta
, uint64_t nval
, uint64_t incr
)
2257 uint64_t arg
= *lquanta
++;
2258 int32_t base
= DTRACE_LQUANTIZE_BASE(arg
);
2259 uint16_t step
= DTRACE_LQUANTIZE_STEP(arg
);
2260 uint16_t levels
= DTRACE_LQUANTIZE_LEVELS(arg
);
2261 int32_t val
= (int32_t)nval
, level
;
2264 ASSERT(levels
!= 0);
2268 * This is an underflow.
2274 level
= (val
- base
) / step
;
2276 if (level
< levels
) {
2277 lquanta
[level
+ 1] += incr
;
2282 * This is an overflow.
2284 lquanta
[levels
+ 1] += incr
;
2288 dtrace_aggregate_llquantize_bucket(int16_t factor
, int16_t low
, int16_t high
,
2289 int16_t nsteps
, int64_t value
)
2291 int64_t this = 1, last
, next
;
2292 int base
= 1, order
;
2294 for (order
= 0; order
< low
; ++order
)
2298 * If our value is less than our factor taken to the power of the
2299 * low order of magnitude, it goes into the zeroth bucket.
2306 for (this *= factor
; order
<= high
; ++order
) {
2307 int nbuckets
= this > nsteps
? nsteps
: this;
2310 * We should not generally get log/linear quantizations
2311 * with a high magnitude that allows 64-bits to
2312 * overflow, but we nonetheless protect against this
2313 * by explicitly checking for overflow, and clamping
2314 * our value accordingly.
2316 next
= this * factor
;
2322 * If our value lies within this order of magnitude,
2323 * determine its position by taking the offset within
2324 * the order of magnitude, dividing by the bucket
2325 * width, and adding to our (accumulated) base.
2328 return (base
+ (value
- last
) / (this / nbuckets
));
2331 base
+= nbuckets
- (nbuckets
/ factor
);
2337 * Our value is greater than or equal to our factor taken to the
2338 * power of one plus the high magnitude -- return the top bucket.
2344 dtrace_aggregate_llquantize(uint64_t *llquanta
, uint64_t nval
, uint64_t incr
)
2346 uint64_t arg
= *llquanta
++;
2347 uint16_t factor
= DTRACE_LLQUANTIZE_FACTOR(arg
);
2348 uint16_t low
= DTRACE_LLQUANTIZE_LOW(arg
);
2349 uint16_t high
= DTRACE_LLQUANTIZE_HIGH(arg
);
2350 uint16_t nsteps
= DTRACE_LLQUANTIZE_NSTEP(arg
);
2352 llquanta
[dtrace_aggregate_llquantize_bucket(factor
, low
, high
, nsteps
, nval
)] += incr
;
2357 dtrace_aggregate_avg(uint64_t *data
, uint64_t nval
, uint64_t arg
)
2359 #pragma unused(arg) /* __APPLE__ */
2366 dtrace_aggregate_stddev(uint64_t *data
, uint64_t nval
, uint64_t arg
)
2368 #pragma unused(arg) /* __APPLE__ */
2369 int64_t snval
= (int64_t)nval
;
2376 * What we want to say here is:
2378 * data[2] += nval * nval;
2380 * But given that nval is 64-bit, we could easily overflow, so
2381 * we do this as 128-bit arithmetic.
2386 dtrace_multiply_128((uint64_t)snval
, (uint64_t)snval
, tmp
);
2387 dtrace_add_128(data
+ 2, tmp
, data
+ 2);
2392 dtrace_aggregate_count(uint64_t *oval
, uint64_t nval
, uint64_t arg
)
2394 #pragma unused(nval, arg) /* __APPLE__ */
2400 dtrace_aggregate_sum(uint64_t *oval
, uint64_t nval
, uint64_t arg
)
2402 #pragma unused(arg) /* __APPLE__ */
2407 * Aggregate given the tuple in the principal data buffer, and the aggregating
2408 * action denoted by the specified dtrace_aggregation_t. The aggregation
2409 * buffer is specified as the buf parameter. This routine does not return
2410 * failure; if there is no space in the aggregation buffer, the data will be
2411 * dropped, and a corresponding counter incremented.
2414 dtrace_aggregate(dtrace_aggregation_t
*agg
, dtrace_buffer_t
*dbuf
,
2415 intptr_t offset
, dtrace_buffer_t
*buf
, uint64_t expr
, uint64_t arg
)
2418 dtrace_recdesc_t
*rec
= &agg
->dtag_action
.dta_rec
;
2419 uint32_t i
, ndx
, size
, fsize
;
2420 uint32_t align
= sizeof (uint64_t) - 1;
2421 dtrace_aggbuffer_t
*agb
;
2422 dtrace_aggkey_t
*key
;
2423 uint32_t hashval
= 0, limit
, isstr
;
2424 caddr_t tomax
, data
, kdata
;
2425 dtrace_actkind_t action
;
2426 dtrace_action_t
*act
;
2432 if (!agg
->dtag_hasarg
) {
2434 * Currently, only quantize() and lquantize() take additional
2435 * arguments, and they have the same semantics: an increment
2436 * value that defaults to 1 when not present. If additional
2437 * aggregating actions take arguments, the setting of the
2438 * default argument value will presumably have to become more
2444 action
= agg
->dtag_action
.dta_kind
- DTRACEACT_AGGREGATION
;
2445 size
= rec
->dtrd_offset
- agg
->dtag_base
;
2446 fsize
= size
+ rec
->dtrd_size
;
2448 ASSERT(dbuf
->dtb_tomax
!= NULL
);
2449 data
= dbuf
->dtb_tomax
+ offset
+ agg
->dtag_base
;
2451 if ((tomax
= buf
->dtb_tomax
) == NULL
) {
2452 dtrace_buffer_drop(buf
);
2457 * The metastructure is always at the bottom of the buffer.
2459 agb
= (dtrace_aggbuffer_t
*)(tomax
+ buf
->dtb_size
-
2460 sizeof (dtrace_aggbuffer_t
));
2462 if (buf
->dtb_offset
== 0) {
2464 * We just kludge up approximately 1/8th of the size to be
2465 * buckets. If this guess ends up being routinely
2466 * off-the-mark, we may need to dynamically readjust this
2467 * based on past performance.
2469 uintptr_t hashsize
= (buf
->dtb_size
>> 3) / sizeof (uintptr_t);
2471 if ((uintptr_t)agb
- hashsize
* sizeof (dtrace_aggkey_t
*) <
2472 (uintptr_t)tomax
|| hashsize
== 0) {
2474 * We've been given a ludicrously small buffer;
2475 * increment our drop count and leave.
2477 dtrace_buffer_drop(buf
);
2482 * And now, a pathetic attempt to try to get a an odd (or
2483 * perchance, a prime) hash size for better hash distribution.
2485 if (hashsize
> (DTRACE_AGGHASHSIZE_SLEW
<< 3))
2486 hashsize
-= DTRACE_AGGHASHSIZE_SLEW
;
2488 agb
->dtagb_hashsize
= hashsize
;
2489 agb
->dtagb_hash
= (dtrace_aggkey_t
**)((uintptr_t)agb
-
2490 agb
->dtagb_hashsize
* sizeof (dtrace_aggkey_t
*));
2491 agb
->dtagb_free
= (uintptr_t)agb
->dtagb_hash
;
2493 for (i
= 0; i
< agb
->dtagb_hashsize
; i
++)
2494 agb
->dtagb_hash
[i
] = NULL
;
2497 ASSERT(agg
->dtag_first
!= NULL
);
2498 ASSERT(agg
->dtag_first
->dta_intuple
);
2501 * Calculate the hash value based on the key. Note that we _don't_
2502 * include the aggid in the hashing (but we will store it as part of
2503 * the key). The hashing algorithm is Bob Jenkins' "One-at-a-time"
2504 * algorithm: a simple, quick algorithm that has no known funnels, and
2505 * gets good distribution in practice. The efficacy of the hashing
2506 * algorithm (and a comparison with other algorithms) may be found by
2507 * running the ::dtrace_aggstat MDB dcmd.
2509 for (act
= agg
->dtag_first
; act
->dta_intuple
; act
= act
->dta_next
) {
2510 i
= act
->dta_rec
.dtrd_offset
- agg
->dtag_base
;
2511 limit
= i
+ act
->dta_rec
.dtrd_size
;
2512 ASSERT(limit
<= size
);
2513 isstr
= DTRACEACT_ISSTRING(act
);
2515 for (; i
< limit
; i
++) {
2517 hashval
+= (hashval
<< 10);
2518 hashval
^= (hashval
>> 6);
2520 if (isstr
&& data
[i
] == '\0')
2525 hashval
+= (hashval
<< 3);
2526 hashval
^= (hashval
>> 11);
2527 hashval
+= (hashval
<< 15);
2530 * Yes, the divide here is expensive -- but it's generally the least
2531 * of the performance issues given the amount of data that we iterate
2532 * over to compute hash values, compare data, etc.
2534 ndx
= hashval
% agb
->dtagb_hashsize
;
2536 for (key
= agb
->dtagb_hash
[ndx
]; key
!= NULL
; key
= key
->dtak_next
) {
2537 ASSERT((caddr_t
)key
>= tomax
);
2538 ASSERT((caddr_t
)key
< tomax
+ buf
->dtb_size
);
2540 if (hashval
!= key
->dtak_hashval
|| key
->dtak_size
!= size
)
2543 kdata
= key
->dtak_data
;
2544 ASSERT(kdata
>= tomax
&& kdata
< tomax
+ buf
->dtb_size
);
2546 for (act
= agg
->dtag_first
; act
->dta_intuple
;
2547 act
= act
->dta_next
) {
2548 i
= act
->dta_rec
.dtrd_offset
- agg
->dtag_base
;
2549 limit
= i
+ act
->dta_rec
.dtrd_size
;
2550 ASSERT(limit
<= size
);
2551 isstr
= DTRACEACT_ISSTRING(act
);
2553 for (; i
< limit
; i
++) {
2554 if (kdata
[i
] != data
[i
])
2557 if (isstr
&& data
[i
] == '\0')
2562 if (action
!= key
->dtak_action
) {
2564 * We are aggregating on the same value in the same
2565 * aggregation with two different aggregating actions.
2566 * (This should have been picked up in the compiler,
2567 * so we may be dealing with errant or devious DIF.)
2568 * This is an error condition; we indicate as much,
2571 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
2576 * This is a hit: we need to apply the aggregator to
2577 * the value at this key.
2579 agg
->dtag_aggregate((uint64_t *)(kdata
+ size
), expr
, arg
);
2586 * We didn't find it. We need to allocate some zero-filled space,
2587 * link it into the hash table appropriately, and apply the aggregator
2588 * to the (zero-filled) value.
2590 offs
= buf
->dtb_offset
;
2591 while (offs
& (align
- 1))
2592 offs
+= sizeof (uint32_t);
2595 * If we don't have enough room to both allocate a new key _and_
2596 * its associated data, increment the drop count and return.
2598 if ((uintptr_t)tomax
+ offs
+ fsize
>
2599 agb
->dtagb_free
- sizeof (dtrace_aggkey_t
)) {
2600 dtrace_buffer_drop(buf
);
2605 ASSERT(!(sizeof (dtrace_aggkey_t
) & (sizeof (uintptr_t) - 1)));
2606 key
= (dtrace_aggkey_t
*)(agb
->dtagb_free
- sizeof (dtrace_aggkey_t
));
2607 agb
->dtagb_free
-= sizeof (dtrace_aggkey_t
);
2609 key
->dtak_data
= kdata
= tomax
+ offs
;
2610 buf
->dtb_offset
= offs
+ fsize
;
2613 * Now copy the data across.
2615 *((dtrace_aggid_t
*)kdata
) = agg
->dtag_id
;
2617 for (i
= sizeof (dtrace_aggid_t
); i
< size
; i
++)
2621 * Because strings are not zeroed out by default, we need to iterate
2622 * looking for actions that store strings, and we need to explicitly
2623 * pad these strings out with zeroes.
2625 for (act
= agg
->dtag_first
; act
->dta_intuple
; act
= act
->dta_next
) {
2628 if (!DTRACEACT_ISSTRING(act
))
2631 i
= act
->dta_rec
.dtrd_offset
- agg
->dtag_base
;
2632 limit
= i
+ act
->dta_rec
.dtrd_size
;
2633 ASSERT(limit
<= size
);
2635 for (nul
= 0; i
< limit
; i
++) {
2641 if (data
[i
] != '\0')
2648 for (i
= size
; i
< fsize
; i
++)
2651 key
->dtak_hashval
= hashval
;
2652 key
->dtak_size
= size
;
2653 key
->dtak_action
= action
;
2654 key
->dtak_next
= agb
->dtagb_hash
[ndx
];
2655 agb
->dtagb_hash
[ndx
] = key
;
2658 * Finally, apply the aggregator.
2660 *((uint64_t *)(key
->dtak_data
+ size
)) = agg
->dtag_initial
;
2661 agg
->dtag_aggregate((uint64_t *)(key
->dtak_data
+ size
), expr
, arg
);
2665 * Given consumer state, this routine finds a speculation in the INACTIVE
2666 * state and transitions it into the ACTIVE state. If there is no speculation
2667 * in the INACTIVE state, 0 is returned. In this case, no error counter is
2668 * incremented -- it is up to the caller to take appropriate action.
2671 dtrace_speculation(dtrace_state_t
*state
)
2674 dtrace_speculation_state_t current
;
2675 uint32_t *stat
= &state
->dts_speculations_unavail
, count
;
2677 while (i
< state
->dts_nspeculations
) {
2678 dtrace_speculation_t
*spec
= &state
->dts_speculations
[i
];
2680 current
= spec
->dtsp_state
;
2682 if (current
!= DTRACESPEC_INACTIVE
) {
2683 if (current
== DTRACESPEC_COMMITTINGMANY
||
2684 current
== DTRACESPEC_COMMITTING
||
2685 current
== DTRACESPEC_DISCARDING
)
2686 stat
= &state
->dts_speculations_busy
;
2691 if (dtrace_cas32((uint32_t *)&spec
->dtsp_state
,
2692 current
, DTRACESPEC_ACTIVE
) == current
)
2697 * We couldn't find a speculation. If we found as much as a single
2698 * busy speculation buffer, we'll attribute this failure as "busy"
2699 * instead of "unavail".
2703 } while (dtrace_cas32(stat
, count
, count
+ 1) != count
);
2709 * This routine commits an active speculation. If the specified speculation
2710 * is not in a valid state to perform a commit(), this routine will silently do
2711 * nothing. The state of the specified speculation is transitioned according
2712 * to the state transition diagram outlined in <sys/dtrace_impl.h>
2715 dtrace_speculation_commit(dtrace_state_t
*state
, processorid_t cpu
,
2716 dtrace_specid_t which
)
2718 dtrace_speculation_t
*spec
;
2719 dtrace_buffer_t
*src
, *dest
;
2720 uintptr_t daddr
, saddr
, dlimit
, slimit
;
2721 dtrace_speculation_state_t current
, new = DTRACESPEC_INACTIVE
;
2728 if (which
> (dtrace_specid_t
)state
->dts_nspeculations
) {
2729 cpu_core
[cpu
].cpuc_dtrace_flags
|= CPU_DTRACE_ILLOP
;
2733 spec
= &state
->dts_speculations
[which
- 1];
2734 src
= &spec
->dtsp_buffer
[cpu
];
2735 dest
= &state
->dts_buffer
[cpu
];
2738 current
= spec
->dtsp_state
;
2740 if (current
== DTRACESPEC_COMMITTINGMANY
)
2744 case DTRACESPEC_INACTIVE
:
2745 case DTRACESPEC_DISCARDING
:
2748 case DTRACESPEC_COMMITTING
:
2750 * This is only possible if we are (a) commit()'ing
2751 * without having done a prior speculate() on this CPU
2752 * and (b) racing with another commit() on a different
2753 * CPU. There's nothing to do -- we just assert that
2756 ASSERT(src
->dtb_offset
== 0);
2759 case DTRACESPEC_ACTIVE
:
2760 new = DTRACESPEC_COMMITTING
;
2763 case DTRACESPEC_ACTIVEONE
:
2765 * This speculation is active on one CPU. If our
2766 * buffer offset is non-zero, we know that the one CPU
2767 * must be us. Otherwise, we are committing on a
2768 * different CPU from the speculate(), and we must
2769 * rely on being asynchronously cleaned.
2771 if (src
->dtb_offset
!= 0) {
2772 new = DTRACESPEC_COMMITTING
;
2777 case DTRACESPEC_ACTIVEMANY
:
2778 new = DTRACESPEC_COMMITTINGMANY
;
2784 } while (dtrace_cas32((uint32_t *)&spec
->dtsp_state
,
2785 current
, new) != current
);
2788 * We have set the state to indicate that we are committing this
2789 * speculation. Now reserve the necessary space in the destination
2792 if ((offs
= dtrace_buffer_reserve(dest
, src
->dtb_offset
,
2793 sizeof (uint64_t), state
, NULL
)) < 0) {
2794 dtrace_buffer_drop(dest
);
2799 * We have sufficient space to copy the speculative buffer into the
2800 * primary buffer. First, modify the speculative buffer, filling
2801 * in the timestamp of all entries with the current time. The data
2802 * must have the commit() time rather than the time it was traced,
2803 * so that all entries in the primary buffer are in timestamp order.
2805 timestamp
= dtrace_gethrtime();
2806 saddr
= (uintptr_t)src
->dtb_tomax
;
2807 slimit
= saddr
+ src
->dtb_offset
;
2808 while (saddr
< slimit
) {
2810 dtrace_rechdr_t
*dtrh
= (dtrace_rechdr_t
*)saddr
;
2812 if (dtrh
->dtrh_epid
== DTRACE_EPIDNONE
) {
2813 saddr
+= sizeof (dtrace_epid_t
);
2817 ASSERT(dtrh
->dtrh_epid
<= ((dtrace_epid_t
) state
->dts_necbs
));
2818 size
= state
->dts_ecbs
[dtrh
->dtrh_epid
- 1]->dte_size
;
2820 ASSERT(saddr
+ size
<= slimit
);
2821 ASSERT(size
>= sizeof(dtrace_rechdr_t
));
2822 ASSERT(DTRACE_RECORD_LOAD_TIMESTAMP(dtrh
) == UINT64_MAX
);
2824 DTRACE_RECORD_STORE_TIMESTAMP(dtrh
, timestamp
);
2830 * Copy the buffer across. (Note that this is a
2831 * highly subobtimal bcopy(); in the unlikely event that this becomes
2832 * a serious performance issue, a high-performance DTrace-specific
2833 * bcopy() should obviously be invented.)
2835 daddr
= (uintptr_t)dest
->dtb_tomax
+ offs
;
2836 dlimit
= daddr
+ src
->dtb_offset
;
2837 saddr
= (uintptr_t)src
->dtb_tomax
;
2840 * First, the aligned portion.
2842 while (dlimit
- daddr
>= sizeof (uint64_t)) {
2843 *((uint64_t *)daddr
) = *((uint64_t *)saddr
);
2845 daddr
+= sizeof (uint64_t);
2846 saddr
+= sizeof (uint64_t);
2850 * Now any left-over bit...
2852 while (dlimit
- daddr
)
2853 *((uint8_t *)daddr
++) = *((uint8_t *)saddr
++);
2856 * Finally, commit the reserved space in the destination buffer.
2858 dest
->dtb_offset
= offs
+ src
->dtb_offset
;
2862 * If we're lucky enough to be the only active CPU on this speculation
2863 * buffer, we can just set the state back to DTRACESPEC_INACTIVE.
2865 if (current
== DTRACESPEC_ACTIVE
||
2866 (current
== DTRACESPEC_ACTIVEONE
&& new == DTRACESPEC_COMMITTING
)) {
2867 uint32_t rval
= dtrace_cas32((uint32_t *)&spec
->dtsp_state
,
2868 DTRACESPEC_COMMITTING
, DTRACESPEC_INACTIVE
);
2869 #pragma unused(rval) /* __APPLE__ */
2871 ASSERT(rval
== DTRACESPEC_COMMITTING
);
2874 src
->dtb_offset
= 0;
2875 src
->dtb_xamot_drops
+= src
->dtb_drops
;
2880 * This routine discards an active speculation. If the specified speculation
2881 * is not in a valid state to perform a discard(), this routine will silently
2882 * do nothing. The state of the specified speculation is transitioned
2883 * according to the state transition diagram outlined in <sys/dtrace_impl.h>
2886 dtrace_speculation_discard(dtrace_state_t
*state
, processorid_t cpu
,
2887 dtrace_specid_t which
)
2889 dtrace_speculation_t
*spec
;
2890 dtrace_speculation_state_t current
, new = DTRACESPEC_INACTIVE
;
2891 dtrace_buffer_t
*buf
;
2896 if (which
> (dtrace_specid_t
)state
->dts_nspeculations
) {
2897 cpu_core
[cpu
].cpuc_dtrace_flags
|= CPU_DTRACE_ILLOP
;
2901 spec
= &state
->dts_speculations
[which
- 1];
2902 buf
= &spec
->dtsp_buffer
[cpu
];
2905 current
= spec
->dtsp_state
;
2908 case DTRACESPEC_INACTIVE
:
2909 case DTRACESPEC_COMMITTINGMANY
:
2910 case DTRACESPEC_COMMITTING
:
2911 case DTRACESPEC_DISCARDING
:
2914 case DTRACESPEC_ACTIVE
:
2915 case DTRACESPEC_ACTIVEMANY
:
2916 new = DTRACESPEC_DISCARDING
;
2919 case DTRACESPEC_ACTIVEONE
:
2920 if (buf
->dtb_offset
!= 0) {
2921 new = DTRACESPEC_INACTIVE
;
2923 new = DTRACESPEC_DISCARDING
;
2930 } while (dtrace_cas32((uint32_t *)&spec
->dtsp_state
,
2931 current
, new) != current
);
2933 buf
->dtb_offset
= 0;
2938 * Note: not called from probe context. This function is called
2939 * asynchronously from cross call context to clean any speculations that are
2940 * in the COMMITTINGMANY or DISCARDING states. These speculations may not be
2941 * transitioned back to the INACTIVE state until all CPUs have cleaned the
2945 dtrace_speculation_clean_here(dtrace_state_t
*state
)
2947 dtrace_icookie_t cookie
;
2948 processorid_t cpu
= CPU
->cpu_id
;
2949 dtrace_buffer_t
*dest
= &state
->dts_buffer
[cpu
];
2952 cookie
= dtrace_interrupt_disable();
2954 if (dest
->dtb_tomax
== NULL
) {
2955 dtrace_interrupt_enable(cookie
);
2959 for (i
= 0; i
< (dtrace_specid_t
)state
->dts_nspeculations
; i
++) {
2960 dtrace_speculation_t
*spec
= &state
->dts_speculations
[i
];
2961 dtrace_buffer_t
*src
= &spec
->dtsp_buffer
[cpu
];
2963 if (src
->dtb_tomax
== NULL
)
2966 if (spec
->dtsp_state
== DTRACESPEC_DISCARDING
) {
2967 src
->dtb_offset
= 0;
2971 if (spec
->dtsp_state
!= DTRACESPEC_COMMITTINGMANY
)
2974 if (src
->dtb_offset
== 0)
2977 dtrace_speculation_commit(state
, cpu
, i
+ 1);
2980 dtrace_interrupt_enable(cookie
);
2984 * Note: not called from probe context. This function is called
2985 * asynchronously (and at a regular interval) to clean any speculations that
2986 * are in the COMMITTINGMANY or DISCARDING states. If it discovers that there
2987 * is work to be done, it cross calls all CPUs to perform that work;
2988 * COMMITMANY and DISCARDING speculations may not be transitioned back to the
2989 * INACTIVE state until they have been cleaned by all CPUs.
2992 dtrace_speculation_clean(dtrace_state_t
*state
)
2998 for (i
= 0; i
< (dtrace_specid_t
)state
->dts_nspeculations
; i
++) {
2999 dtrace_speculation_t
*spec
= &state
->dts_speculations
[i
];
3001 ASSERT(!spec
->dtsp_cleaning
);
3003 if (spec
->dtsp_state
!= DTRACESPEC_DISCARDING
&&
3004 spec
->dtsp_state
!= DTRACESPEC_COMMITTINGMANY
)
3008 spec
->dtsp_cleaning
= 1;
3014 dtrace_xcall(DTRACE_CPUALL
,
3015 (dtrace_xcall_t
)dtrace_speculation_clean_here
, state
);
3018 * We now know that all CPUs have committed or discarded their
3019 * speculation buffers, as appropriate. We can now set the state
3022 for (i
= 0; i
< (dtrace_specid_t
)state
->dts_nspeculations
; i
++) {
3023 dtrace_speculation_t
*spec
= &state
->dts_speculations
[i
];
3024 dtrace_speculation_state_t current
, new;
3026 if (!spec
->dtsp_cleaning
)
3029 current
= spec
->dtsp_state
;
3030 ASSERT(current
== DTRACESPEC_DISCARDING
||
3031 current
== DTRACESPEC_COMMITTINGMANY
);
3033 new = DTRACESPEC_INACTIVE
;
3035 rv
= dtrace_cas32((uint32_t *)&spec
->dtsp_state
, current
, new);
3036 ASSERT(rv
== current
);
3037 spec
->dtsp_cleaning
= 0;
3042 * Called as part of a speculate() to get the speculative buffer associated
3043 * with a given speculation. Returns NULL if the specified speculation is not
3044 * in an ACTIVE state. If the speculation is in the ACTIVEONE state -- and
3045 * the active CPU is not the specified CPU -- the speculation will be
3046 * atomically transitioned into the ACTIVEMANY state.
3048 static dtrace_buffer_t
*
3049 dtrace_speculation_buffer(dtrace_state_t
*state
, processorid_t cpuid
,
3050 dtrace_specid_t which
)
3052 dtrace_speculation_t
*spec
;
3053 dtrace_speculation_state_t current
, new = DTRACESPEC_INACTIVE
;
3054 dtrace_buffer_t
*buf
;
3059 if (which
> (dtrace_specid_t
)state
->dts_nspeculations
) {
3060 cpu_core
[cpuid
].cpuc_dtrace_flags
|= CPU_DTRACE_ILLOP
;
3064 spec
= &state
->dts_speculations
[which
- 1];
3065 buf
= &spec
->dtsp_buffer
[cpuid
];
3068 current
= spec
->dtsp_state
;
3071 case DTRACESPEC_INACTIVE
:
3072 case DTRACESPEC_COMMITTINGMANY
:
3073 case DTRACESPEC_DISCARDING
:
3076 case DTRACESPEC_COMMITTING
:
3077 ASSERT(buf
->dtb_offset
== 0);
3080 case DTRACESPEC_ACTIVEONE
:
3082 * This speculation is currently active on one CPU.
3083 * Check the offset in the buffer; if it's non-zero,
3084 * that CPU must be us (and we leave the state alone).
3085 * If it's zero, assume that we're starting on a new
3086 * CPU -- and change the state to indicate that the
3087 * speculation is active on more than one CPU.
3089 if (buf
->dtb_offset
!= 0)
3092 new = DTRACESPEC_ACTIVEMANY
;
3095 case DTRACESPEC_ACTIVEMANY
:
3098 case DTRACESPEC_ACTIVE
:
3099 new = DTRACESPEC_ACTIVEONE
;
3105 } while (dtrace_cas32((uint32_t *)&spec
->dtsp_state
,
3106 current
, new) != current
);
3108 ASSERT(new == DTRACESPEC_ACTIVEONE
|| new == DTRACESPEC_ACTIVEMANY
);
3113 * Return a string. In the event that the user lacks the privilege to access
3114 * arbitrary kernel memory, we copy the string out to scratch memory so that we
3115 * don't fail access checking.
3117 * dtrace_dif_variable() uses this routine as a helper for various
3118 * builtin values such as 'execname' and 'probefunc.'
3122 dtrace_dif_varstr(uintptr_t addr
, dtrace_state_t
*state
,
3123 dtrace_mstate_t
*mstate
)
3125 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
3130 * The easy case: this probe is allowed to read all of memory, so
3131 * we can just return this as a vanilla pointer.
3133 if ((mstate
->dtms_access
& DTRACE_ACCESS_KERNEL
) != 0)
3137 * This is the tougher case: we copy the string in question from
3138 * kernel memory into scratch memory and return it that way: this
3139 * ensures that we won't trip up when access checking tests the
3140 * BYREF return value.
3142 strsz
= dtrace_strlen((char *)addr
, size
) + 1;
3144 if (mstate
->dtms_scratch_ptr
+ strsz
>
3145 mstate
->dtms_scratch_base
+ mstate
->dtms_scratch_size
) {
3146 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
3150 dtrace_strcpy((const void *)addr
, (void *)mstate
->dtms_scratch_ptr
,
3152 ret
= mstate
->dtms_scratch_ptr
;
3153 mstate
->dtms_scratch_ptr
+= strsz
;
3158 * This function implements the DIF emulator's variable lookups. The emulator
3159 * passes a reserved variable identifier and optional built-in array index.
3162 dtrace_dif_variable(dtrace_mstate_t
*mstate
, dtrace_state_t
*state
, uint64_t v
,
3166 * If we're accessing one of the uncached arguments, we'll turn this
3167 * into a reference in the args array.
3169 if (v
>= DIF_VAR_ARG0
&& v
<= DIF_VAR_ARG9
) {
3170 ndx
= v
- DIF_VAR_ARG0
;
3176 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_ARGS
);
3177 if (ndx
>= sizeof (mstate
->dtms_arg
) /
3178 sizeof (mstate
->dtms_arg
[0])) {
3180 * APPLE NOTE: Account for introduction of __dtrace_probe()
3182 int aframes
= mstate
->dtms_probe
->dtpr_aframes
+ 3;
3183 dtrace_provider_t
*pv
;
3186 pv
= mstate
->dtms_probe
->dtpr_provider
;
3187 if (pv
->dtpv_pops
.dtps_getargval
!= NULL
)
3188 val
= pv
->dtpv_pops
.dtps_getargval(pv
->dtpv_arg
,
3189 mstate
->dtms_probe
->dtpr_id
,
3190 mstate
->dtms_probe
->dtpr_arg
, ndx
, aframes
);
3191 /* Special case access of arg5 as passed to dtrace_probe_error() (which see.) */
3192 else if (mstate
->dtms_probe
->dtpr_id
== dtrace_probeid_error
&& ndx
== 5) {
3193 return ((dtrace_state_t
*)(uintptr_t)(mstate
->dtms_arg
[0]))->dts_arg_error_illval
;
3197 val
= dtrace_getarg(ndx
, aframes
);
3200 * This is regrettably required to keep the compiler
3201 * from tail-optimizing the call to dtrace_getarg().
3202 * The condition always evaluates to true, but the
3203 * compiler has no way of figuring that out a priori.
3204 * (None of this would be necessary if the compiler
3205 * could be relied upon to _always_ tail-optimize
3206 * the call to dtrace_getarg() -- but it can't.)
3208 if (mstate
->dtms_probe
!= NULL
)
3214 return (mstate
->dtms_arg
[ndx
]);
3216 case DIF_VAR_UREGS
: {
3219 if (!dtrace_priv_proc(state
))
3222 if ((thread
= current_thread()) == NULL
) {
3223 DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR
);
3224 cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
= 0;
3228 return (dtrace_getreg(find_user_regs(thread
), ndx
));
3232 case DIF_VAR_CURTHREAD
:
3233 if (!dtrace_priv_kernel(state
))
3236 return ((uint64_t)(uintptr_t)current_thread());
3238 case DIF_VAR_TIMESTAMP
:
3239 if (!(mstate
->dtms_present
& DTRACE_MSTATE_TIMESTAMP
)) {
3240 mstate
->dtms_timestamp
= dtrace_gethrtime();
3241 mstate
->dtms_present
|= DTRACE_MSTATE_TIMESTAMP
;
3243 return (mstate
->dtms_timestamp
);
3245 case DIF_VAR_VTIMESTAMP
:
3246 ASSERT(dtrace_vtime_references
!= 0);
3247 return (dtrace_get_thread_vtime(current_thread()));
3249 case DIF_VAR_WALLTIMESTAMP
:
3250 if (!(mstate
->dtms_present
& DTRACE_MSTATE_WALLTIMESTAMP
)) {
3251 mstate
->dtms_walltimestamp
= dtrace_gethrestime();
3252 mstate
->dtms_present
|= DTRACE_MSTATE_WALLTIMESTAMP
;
3254 return (mstate
->dtms_walltimestamp
);
3256 case DIF_VAR_MACHTIMESTAMP
:
3257 if (!(mstate
->dtms_present
& DTRACE_MSTATE_MACHTIMESTAMP
)) {
3258 mstate
->dtms_machtimestamp
= mach_absolute_time();
3259 mstate
->dtms_present
|= DTRACE_MSTATE_MACHTIMESTAMP
;
3261 return (mstate
->dtms_machtimestamp
);
3264 return ((uint64_t) dtrace_get_thread_last_cpu_id(current_thread()));
3267 if (!dtrace_priv_kernel(state
))
3269 if (!(mstate
->dtms_present
& DTRACE_MSTATE_IPL
)) {
3270 mstate
->dtms_ipl
= dtrace_getipl();
3271 mstate
->dtms_present
|= DTRACE_MSTATE_IPL
;
3273 return (mstate
->dtms_ipl
);
3276 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_EPID
);
3277 return (mstate
->dtms_epid
);
3280 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_PROBE
);
3281 return (mstate
->dtms_probe
->dtpr_id
);
3283 case DIF_VAR_STACKDEPTH
:
3284 if (!dtrace_priv_kernel(state
))
3286 if (!(mstate
->dtms_present
& DTRACE_MSTATE_STACKDEPTH
)) {
3288 * APPLE NOTE: Account for introduction of __dtrace_probe()
3290 int aframes
= mstate
->dtms_probe
->dtpr_aframes
+ 3;
3292 mstate
->dtms_stackdepth
= dtrace_getstackdepth(aframes
);
3293 mstate
->dtms_present
|= DTRACE_MSTATE_STACKDEPTH
;
3295 return (mstate
->dtms_stackdepth
);
3297 case DIF_VAR_USTACKDEPTH
:
3298 if (!dtrace_priv_proc(state
))
3300 if (!(mstate
->dtms_present
& DTRACE_MSTATE_USTACKDEPTH
)) {
3302 * See comment in DIF_VAR_PID.
3304 if (DTRACE_ANCHORED(mstate
->dtms_probe
) &&
3306 mstate
->dtms_ustackdepth
= 0;
3308 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3309 mstate
->dtms_ustackdepth
=
3310 dtrace_getustackdepth();
3311 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3313 mstate
->dtms_present
|= DTRACE_MSTATE_USTACKDEPTH
;
3315 return (mstate
->dtms_ustackdepth
);
3317 case DIF_VAR_CALLER
:
3318 if (!dtrace_priv_kernel(state
))
3320 if (!(mstate
->dtms_present
& DTRACE_MSTATE_CALLER
)) {
3322 * APPLE NOTE: Account for introduction of __dtrace_probe()
3324 int aframes
= mstate
->dtms_probe
->dtpr_aframes
+ 3;
3326 if (!DTRACE_ANCHORED(mstate
->dtms_probe
)) {
3328 * If this is an unanchored probe, we are
3329 * required to go through the slow path:
3330 * dtrace_caller() only guarantees correct
3331 * results for anchored probes.
3335 dtrace_getpcstack(caller
, 2, aframes
,
3336 (uint32_t *)(uintptr_t)mstate
->dtms_arg
[0]);
3337 mstate
->dtms_caller
= caller
[1];
3338 } else if ((mstate
->dtms_caller
=
3339 dtrace_caller(aframes
)) == (uintptr_t)-1) {
3341 * We have failed to do this the quick way;
3342 * we must resort to the slower approach of
3343 * calling dtrace_getpcstack().
3347 dtrace_getpcstack(&caller
, 1, aframes
, NULL
);
3348 mstate
->dtms_caller
= caller
;
3351 mstate
->dtms_present
|= DTRACE_MSTATE_CALLER
;
3353 return (mstate
->dtms_caller
);
3355 case DIF_VAR_UCALLER
:
3356 if (!dtrace_priv_proc(state
))
3359 if (!(mstate
->dtms_present
& DTRACE_MSTATE_UCALLER
)) {
3363 * dtrace_getupcstack() fills in the first uint64_t
3364 * with the current PID. The second uint64_t will
3365 * be the program counter at user-level. The third
3366 * uint64_t will contain the caller, which is what
3370 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3371 dtrace_getupcstack(ustack
, 3);
3372 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3373 mstate
->dtms_ucaller
= ustack
[2];
3374 mstate
->dtms_present
|= DTRACE_MSTATE_UCALLER
;
3377 return (mstate
->dtms_ucaller
);
3379 case DIF_VAR_PROBEPROV
:
3380 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_PROBE
);
3381 return (dtrace_dif_varstr(
3382 (uintptr_t)mstate
->dtms_probe
->dtpr_provider
->dtpv_name
,
3385 case DIF_VAR_PROBEMOD
:
3386 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_PROBE
);
3387 return (dtrace_dif_varstr(
3388 (uintptr_t)mstate
->dtms_probe
->dtpr_mod
,
3391 case DIF_VAR_PROBEFUNC
:
3392 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_PROBE
);
3393 return (dtrace_dif_varstr(
3394 (uintptr_t)mstate
->dtms_probe
->dtpr_func
,
3397 case DIF_VAR_PROBENAME
:
3398 ASSERT(mstate
->dtms_present
& DTRACE_MSTATE_PROBE
);
3399 return (dtrace_dif_varstr(
3400 (uintptr_t)mstate
->dtms_probe
->dtpr_name
,
3404 if (!dtrace_priv_proc_relaxed(state
))
3408 * Note that we are assuming that an unanchored probe is
3409 * always due to a high-level interrupt. (And we're assuming
3410 * that there is only a single high level interrupt.)
3412 if (DTRACE_ANCHORED(mstate
->dtms_probe
) && CPU_ON_INTR(CPU
))
3413 /* Anchored probe that fires while on an interrupt accrues to process 0 */
3416 return ((uint64_t)dtrace_proc_selfpid());
3419 if (!dtrace_priv_proc_relaxed(state
))
3423 * See comment in DIF_VAR_PID.
3425 if (DTRACE_ANCHORED(mstate
->dtms_probe
) && CPU_ON_INTR(CPU
))
3428 return ((uint64_t)dtrace_proc_selfppid());
3431 /* We do not need to check for null current_thread() */
3432 return thread_tid(current_thread()); /* globally unique */
3434 case DIF_VAR_PTHREAD_SELF
:
3435 if (!dtrace_priv_proc(state
))
3438 /* Not currently supported, but we should be able to delta the dispatchqaddr and dispatchqoffset to get pthread_self */
3441 case DIF_VAR_DISPATCHQADDR
:
3442 if (!dtrace_priv_proc(state
))
3445 /* We do not need to check for null current_thread() */
3446 return thread_dispatchqaddr(current_thread());
3448 case DIF_VAR_EXECNAME
:
3450 char *xname
= (char *)mstate
->dtms_scratch_ptr
;
3451 size_t scratch_size
= MAXCOMLEN
+1;
3453 /* The scratch allocation's lifetime is that of the clause. */
3454 if (!DTRACE_INSCRATCH(mstate
, scratch_size
)) {
3455 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
3459 if (!dtrace_priv_proc_relaxed(state
))
3462 mstate
->dtms_scratch_ptr
+= scratch_size
;
3463 proc_selfname( xname
, scratch_size
);
3465 return ((uint64_t)(uintptr_t)xname
);
3469 case DIF_VAR_ZONENAME
:
3471 /* scratch_size is equal to length('global') + 1 for the null-terminator. */
3472 char *zname
= (char *)mstate
->dtms_scratch_ptr
;
3473 size_t scratch_size
= 6 + 1;
3475 if (!dtrace_priv_proc(state
))
3478 /* The scratch allocation's lifetime is that of the clause. */
3479 if (!DTRACE_INSCRATCH(mstate
, scratch_size
)) {
3480 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
3484 mstate
->dtms_scratch_ptr
+= scratch_size
;
3486 /* The kernel does not provide zonename, it will always return 'global'. */
3487 strlcpy(zname
, "global", scratch_size
);
3489 return ((uint64_t)(uintptr_t)zname
);
3493 if (!dtrace_priv_proc_relaxed(state
))
3497 * See comment in DIF_VAR_PID.
3499 if (DTRACE_ANCHORED(mstate
->dtms_probe
) && CPU_ON_INTR(CPU
))
3502 return ((uint64_t) dtrace_proc_selfruid());
3505 if (!dtrace_priv_proc(state
))
3509 * See comment in DIF_VAR_PID.
3511 if (DTRACE_ANCHORED(mstate
->dtms_probe
) && CPU_ON_INTR(CPU
))
3514 if (dtrace_CRED() != NULL
)
3515 /* Credential does not require lazy initialization. */
3516 return ((uint64_t)kauth_getgid());
3518 /* proc_lock would be taken under kauth_cred_proc_ref() in kauth_cred_get(). */
3519 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
3523 case DIF_VAR_ERRNO
: {
3524 uthread_t uthread
= (uthread_t
)get_bsdthread_info(current_thread());
3525 if (!dtrace_priv_proc(state
))
3529 * See comment in DIF_VAR_PID.
3531 if (DTRACE_ANCHORED(mstate
->dtms_probe
) && CPU_ON_INTR(CPU
))
3535 return (uint64_t)uthread
->t_dtrace_errno
;
3537 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
3543 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
3549 * Emulate the execution of DTrace ID subroutines invoked by the call opcode.
3550 * Notice that we don't bother validating the proper number of arguments or
3551 * their types in the tuple stack. This isn't needed because all argument
3552 * interpretation is safe because of our load safety -- the worst that can
3553 * happen is that a bogus program can obtain bogus results.
3556 dtrace_dif_subr(uint_t subr
, uint_t rd
, uint64_t *regs
,
3557 dtrace_key_t
*tupregs
, int nargs
,
3558 dtrace_mstate_t
*mstate
, dtrace_state_t
*state
)
3560 volatile uint16_t *flags
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
3561 volatile uint64_t *illval
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
;
3562 dtrace_vstate_t
*vstate
= &state
->dts_vstate
;
3564 #if !defined(__APPLE__)
3575 /* FIXME: awaits lock/mutex work */
3576 #endif /* __APPLE__ */
3580 regs
[rd
] = (dtrace_gethrtime() * 2416 + 374441) % 1771875;
3583 #if !defined(__APPLE__)
3584 case DIF_SUBR_MUTEX_OWNED
:
3585 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (kmutex_t
),
3591 m
.mx
= dtrace_load64(tupregs
[0].dttk_value
);
3592 if (MUTEX_TYPE_ADAPTIVE(&m
.mi
))
3593 regs
[rd
] = MUTEX_OWNER(&m
.mi
) != MUTEX_NO_OWNER
;
3595 regs
[rd
] = LOCK_HELD(&m
.mi
.m_spin
.m_spinlock
);
3598 case DIF_SUBR_MUTEX_OWNER
:
3599 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (kmutex_t
),
3605 m
.mx
= dtrace_load64(tupregs
[0].dttk_value
);
3606 if (MUTEX_TYPE_ADAPTIVE(&m
.mi
) &&
3607 MUTEX_OWNER(&m
.mi
) != MUTEX_NO_OWNER
)
3608 regs
[rd
] = (uintptr_t)MUTEX_OWNER(&m
.mi
);
3613 case DIF_SUBR_MUTEX_TYPE_ADAPTIVE
:
3614 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (kmutex_t
),
3620 m
.mx
= dtrace_load64(tupregs
[0].dttk_value
);
3621 regs
[rd
] = MUTEX_TYPE_ADAPTIVE(&m
.mi
);
3624 case DIF_SUBR_MUTEX_TYPE_SPIN
:
3625 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (kmutex_t
),
3631 m
.mx
= dtrace_load64(tupregs
[0].dttk_value
);
3632 regs
[rd
] = MUTEX_TYPE_SPIN(&m
.mi
);
3635 case DIF_SUBR_RW_READ_HELD
: {
3638 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (uintptr_t),
3644 r
.rw
= dtrace_loadptr(tupregs
[0].dttk_value
);
3645 regs
[rd
] = _RW_READ_HELD(&r
.ri
, tmp
);
3649 case DIF_SUBR_RW_WRITE_HELD
:
3650 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (krwlock_t
),
3656 r
.rw
= dtrace_loadptr(tupregs
[0].dttk_value
);
3657 regs
[rd
] = _RW_WRITE_HELD(&r
.ri
);
3660 case DIF_SUBR_RW_ISWRITER
:
3661 if (!dtrace_canload(tupregs
[0].dttk_value
, sizeof (krwlock_t
),
3667 r
.rw
= dtrace_loadptr(tupregs
[0].dttk_value
);
3668 regs
[rd
] = _RW_ISWRITER(&r
.ri
);
3671 /* FIXME: awaits lock/mutex work */
3672 #endif /* __APPLE__ */
3674 case DIF_SUBR_BCOPY
: {
3676 * We need to be sure that the destination is in the scratch
3677 * region -- no other region is allowed.
3679 uintptr_t src
= tupregs
[0].dttk_value
;
3680 uintptr_t dest
= tupregs
[1].dttk_value
;
3681 size_t size
= tupregs
[2].dttk_value
;
3683 if (!dtrace_inscratch(dest
, size
, mstate
)) {
3684 *flags
|= CPU_DTRACE_BADADDR
;
3689 if (!dtrace_canload(src
, size
, mstate
, vstate
)) {
3694 dtrace_bcopy((void *)src
, (void *)dest
, size
);
3698 case DIF_SUBR_ALLOCA
:
3699 case DIF_SUBR_COPYIN
: {
3700 uintptr_t dest
= P2ROUNDUP(mstate
->dtms_scratch_ptr
, 8);
3702 tupregs
[subr
== DIF_SUBR_ALLOCA
? 0 : 1].dttk_value
;
3703 size_t scratch_size
= (dest
- mstate
->dtms_scratch_ptr
) + size
;
3706 * Check whether the user can access kernel memory
3708 if (dtrace_priv_kernel(state
) == 0) {
3709 DTRACE_CPUFLAG_SET(CPU_DTRACE_KPRIV
);
3714 * This action doesn't require any credential checks since
3715 * probes will not activate in user contexts to which the
3716 * enabling user does not have permissions.
3720 * Rounding up the user allocation size could have overflowed
3721 * a large, bogus allocation (like -1ULL) to 0.
3723 if (scratch_size
< size
||
3724 !DTRACE_INSCRATCH(mstate
, scratch_size
)) {
3725 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
3730 if (subr
== DIF_SUBR_COPYIN
) {
3731 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3732 if (dtrace_priv_proc(state
))
3733 dtrace_copyin(tupregs
[0].dttk_value
, dest
, size
, flags
);
3734 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3737 mstate
->dtms_scratch_ptr
+= scratch_size
;
3742 case DIF_SUBR_COPYINTO
: {
3743 uint64_t size
= tupregs
[1].dttk_value
;
3744 uintptr_t dest
= tupregs
[2].dttk_value
;
3747 * This action doesn't require any credential checks since
3748 * probes will not activate in user contexts to which the
3749 * enabling user does not have permissions.
3751 if (!dtrace_inscratch(dest
, size
, mstate
)) {
3752 *flags
|= CPU_DTRACE_BADADDR
;
3757 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3758 if (dtrace_priv_proc(state
))
3759 dtrace_copyin(tupregs
[0].dttk_value
, dest
, size
, flags
);
3760 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3764 case DIF_SUBR_COPYINSTR
: {
3765 uintptr_t dest
= mstate
->dtms_scratch_ptr
;
3766 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
3768 if (nargs
> 1 && tupregs
[1].dttk_value
< size
)
3769 size
= tupregs
[1].dttk_value
+ 1;
3772 * This action doesn't require any credential checks since
3773 * probes will not activate in user contexts to which the
3774 * enabling user does not have permissions.
3776 if (!DTRACE_INSCRATCH(mstate
, size
)) {
3777 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
3782 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3783 if (dtrace_priv_proc(state
))
3784 dtrace_copyinstr(tupregs
[0].dttk_value
, dest
, size
, flags
);
3785 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3787 ((char *)dest
)[size
- 1] = '\0';
3788 mstate
->dtms_scratch_ptr
+= size
;
3793 case DIF_SUBR_MSGSIZE
:
3794 case DIF_SUBR_MSGDSIZE
: {
3795 /* Darwin does not implement SysV streams messages */
3796 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
3801 case DIF_SUBR_PROGENYOF
: {
3802 pid_t pid
= tupregs
[0].dttk_value
;
3803 struct proc
*p
= current_proc();
3804 int rval
= 0, lim
= nprocs
;
3806 while(p
&& (lim
-- > 0)) {
3809 ppid
= (pid_t
)dtrace_load32((uintptr_t)&(p
->p_pid
));
3810 if (*flags
& CPU_DTRACE_FAULT
)
3819 break; /* Can't climb process tree any further. */
3821 p
= (struct proc
*)dtrace_loadptr((uintptr_t)&(p
->p_pptr
));
3822 if (*flags
& CPU_DTRACE_FAULT
)
3830 case DIF_SUBR_SPECULATION
:
3831 regs
[rd
] = dtrace_speculation(state
);
3835 case DIF_SUBR_COPYOUT
: {
3836 uintptr_t kaddr
= tupregs
[0].dttk_value
;
3837 user_addr_t uaddr
= tupregs
[1].dttk_value
;
3838 uint64_t size
= tupregs
[2].dttk_value
;
3840 if (!dtrace_destructive_disallow
&&
3841 dtrace_priv_proc_control(state
) &&
3842 !dtrace_istoxic(kaddr
, size
) &&
3843 dtrace_canload(kaddr
, size
, mstate
, vstate
)) {
3844 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3845 dtrace_copyout(kaddr
, uaddr
, size
, flags
);
3846 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3851 case DIF_SUBR_COPYOUTSTR
: {
3852 uintptr_t kaddr
= tupregs
[0].dttk_value
;
3853 user_addr_t uaddr
= tupregs
[1].dttk_value
;
3854 uint64_t size
= tupregs
[2].dttk_value
;
3857 if (!dtrace_destructive_disallow
&&
3858 dtrace_priv_proc_control(state
) &&
3859 !dtrace_istoxic(kaddr
, size
) &&
3860 dtrace_strcanload(kaddr
, size
, &lim
, mstate
, vstate
)) {
3861 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
3862 dtrace_copyoutstr(kaddr
, uaddr
, lim
, flags
);
3863 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
3868 case DIF_SUBR_STRLEN
: {
3869 size_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
3870 uintptr_t addr
= (uintptr_t)tupregs
[0].dttk_value
;
3873 if (!dtrace_strcanload(addr
, size
, &lim
, mstate
, vstate
)) {
3878 regs
[rd
] = dtrace_strlen((char *)addr
, lim
);
3883 case DIF_SUBR_STRCHR
:
3884 case DIF_SUBR_STRRCHR
: {
3886 * We're going to iterate over the string looking for the
3887 * specified character. We will iterate until we have reached
3888 * the string length or we have found the character. If this
3889 * is DIF_SUBR_STRRCHR, we will look for the last occurrence
3890 * of the specified character instead of the first.
3892 uintptr_t addr
= tupregs
[0].dttk_value
;
3893 uintptr_t addr_limit
;
3894 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
3896 char c
, target
= (char)tupregs
[1].dttk_value
;
3898 if (!dtrace_strcanload(addr
, size
, &lim
, mstate
, vstate
)) {
3902 addr_limit
= addr
+ lim
;
3904 for (regs
[rd
] = 0; addr
< addr_limit
; addr
++) {
3905 if ((c
= dtrace_load8(addr
)) == target
) {
3908 if (subr
== DIF_SUBR_STRCHR
)
3919 case DIF_SUBR_STRSTR
:
3920 case DIF_SUBR_INDEX
:
3921 case DIF_SUBR_RINDEX
: {
3923 * We're going to iterate over the string looking for the
3924 * specified string. We will iterate until we have reached
3925 * the string length or we have found the string. (Yes, this
3926 * is done in the most naive way possible -- but considering
3927 * that the string we're searching for is likely to be
3928 * relatively short, the complexity of Rabin-Karp or similar
3929 * hardly seems merited.)
3931 char *addr
= (char *)(uintptr_t)tupregs
[0].dttk_value
;
3932 char *substr
= (char *)(uintptr_t)tupregs
[1].dttk_value
;
3933 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
3934 size_t len
= dtrace_strlen(addr
, size
);
3935 size_t sublen
= dtrace_strlen(substr
, size
);
3936 char *limit
= addr
+ len
, *orig
= addr
;
3937 int notfound
= subr
== DIF_SUBR_STRSTR
? 0 : -1;
3940 regs
[rd
] = notfound
;
3942 if (!dtrace_canload((uintptr_t)addr
, len
+ 1, mstate
, vstate
)) {
3947 if (!dtrace_canload((uintptr_t)substr
, sublen
+ 1, mstate
,
3954 * strstr() and index()/rindex() have similar semantics if
3955 * both strings are the empty string: strstr() returns a
3956 * pointer to the (empty) string, and index() and rindex()
3957 * both return index 0 (regardless of any position argument).
3959 if (sublen
== 0 && len
== 0) {
3960 if (subr
== DIF_SUBR_STRSTR
)
3961 regs
[rd
] = (uintptr_t)addr
;
3967 if (subr
!= DIF_SUBR_STRSTR
) {
3968 if (subr
== DIF_SUBR_RINDEX
) {
3975 * Both index() and rindex() take an optional position
3976 * argument that denotes the starting position.
3979 int64_t pos
= (int64_t)tupregs
[2].dttk_value
;
3982 * If the position argument to index() is
3983 * negative, Perl implicitly clamps it at
3984 * zero. This semantic is a little surprising
3985 * given the special meaning of negative
3986 * positions to similar Perl functions like
3987 * substr(), but it appears to reflect a
3988 * notion that index() can start from a
3989 * negative index and increment its way up to
3990 * the string. Given this notion, Perl's
3991 * rindex() is at least self-consistent in
3992 * that it implicitly clamps positions greater
3993 * than the string length to be the string
3994 * length. Where Perl completely loses
3995 * coherence, however, is when the specified
3996 * substring is the empty string (""). In
3997 * this case, even if the position is
3998 * negative, rindex() returns 0 -- and even if
3999 * the position is greater than the length,
4000 * index() returns the string length. These
4001 * semantics violate the notion that index()
4002 * should never return a value less than the
4003 * specified position and that rindex() should
4004 * never return a value greater than the
4005 * specified position. (One assumes that
4006 * these semantics are artifacts of Perl's
4007 * implementation and not the results of
4008 * deliberate design -- it beggars belief that
4009 * even Larry Wall could desire such oddness.)
4010 * While in the abstract one would wish for
4011 * consistent position semantics across
4012 * substr(), index() and rindex() -- or at the
4013 * very least self-consistent position
4014 * semantics for index() and rindex() -- we
4015 * instead opt to keep with the extant Perl
4016 * semantics, in all their broken glory. (Do
4017 * we have more desire to maintain Perl's
4018 * semantics than Perl does? Probably.)
4020 if (subr
== DIF_SUBR_RINDEX
) {
4027 if ((size_t)pos
> len
)
4033 if ((size_t)pos
>= len
) {
4044 for (regs
[rd
] = notfound
; addr
!= limit
; addr
+= inc
) {
4045 if (dtrace_strncmp(addr
, substr
, sublen
) == 0) {
4046 if (subr
!= DIF_SUBR_STRSTR
) {
4048 * As D index() and rindex() are
4049 * modeled on Perl (and not on awk),
4050 * we return a zero-based (and not a
4051 * one-based) index. (For you Perl
4052 * weenies: no, we're not going to add
4053 * $[ -- and shouldn't you be at a con
4056 regs
[rd
] = (uintptr_t)(addr
- orig
);
4060 ASSERT(subr
== DIF_SUBR_STRSTR
);
4061 regs
[rd
] = (uintptr_t)addr
;
4069 case DIF_SUBR_STRTOK
: {
4070 uintptr_t addr
= tupregs
[0].dttk_value
;
4071 uintptr_t tokaddr
= tupregs
[1].dttk_value
;
4072 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4073 uintptr_t limit
, toklimit
;
4075 char *dest
= (char *)mstate
->dtms_scratch_ptr
;
4076 uint8_t c
='\0', tokmap
[32]; /* 256 / 8 */
4080 * Check both the token buffer and (later) the input buffer,
4081 * since both could be non-scratch addresses.
4083 if (!dtrace_strcanload(tokaddr
, size
, &clim
, mstate
, vstate
)) {
4087 toklimit
= tokaddr
+ clim
;
4089 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4090 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4097 * If the address specified is NULL, we use our saved
4098 * strtok pointer from the mstate. Note that this
4099 * means that the saved strtok pointer is _only_
4100 * valid within multiple enablings of the same probe --
4101 * it behaves like an implicit clause-local variable.
4103 addr
= mstate
->dtms_strtok
;
4104 limit
= mstate
->dtms_strtok_limit
;
4107 * If the user-specified address is non-NULL we must
4108 * access check it. This is the only time we have
4109 * a chance to do so, since this address may reside
4110 * in the string table of this clause-- future calls
4111 * (when we fetch addr from mstate->dtms_strtok)
4112 * would fail this access check.
4114 if (!dtrace_strcanload(addr
, size
, &clim
, mstate
,
4119 limit
= addr
+ clim
;
4123 * First, zero the token map, and then process the token
4124 * string -- setting a bit in the map for every character
4125 * found in the token string.
4127 for (i
= 0; i
< (int)sizeof (tokmap
); i
++)
4130 for (; tokaddr
< toklimit
; tokaddr
++) {
4131 if ((c
= dtrace_load8(tokaddr
)) == '\0')
4134 ASSERT((c
>> 3) < sizeof (tokmap
));
4135 tokmap
[c
>> 3] |= (1 << (c
& 0x7));
4138 for (; addr
< limit
; addr
++) {
4140 * We're looking for a character that is _not_
4141 * contained in the token string.
4143 if ((c
= dtrace_load8(addr
)) == '\0')
4146 if (!(tokmap
[c
>> 3] & (1 << (c
& 0x7))))
4152 * We reached the end of the string without finding
4153 * any character that was not in the token string.
4154 * We return NULL in this case, and we set the saved
4155 * address to NULL as well.
4158 mstate
->dtms_strtok
= 0;
4159 mstate
->dtms_strtok_limit
= NULL
;
4164 * From here on, we're copying into the destination string.
4166 for (i
= 0; addr
< limit
&& i
< size
- 1; addr
++) {
4167 if ((c
= dtrace_load8(addr
)) == '\0')
4170 if (tokmap
[c
>> 3] & (1 << (c
& 0x7)))
4179 regs
[rd
] = (uintptr_t)dest
;
4180 mstate
->dtms_scratch_ptr
+= size
;
4181 mstate
->dtms_strtok
= addr
;
4182 mstate
->dtms_strtok_limit
= limit
;
4186 case DIF_SUBR_SUBSTR
: {
4187 uintptr_t s
= tupregs
[0].dttk_value
;
4188 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4189 char *d
= (char *)mstate
->dtms_scratch_ptr
;
4190 int64_t index
= (int64_t)tupregs
[1].dttk_value
;
4191 int64_t remaining
= (int64_t)tupregs
[2].dttk_value
;
4192 size_t len
= dtrace_strlen((char *)s
, size
);
4195 if (!dtrace_canload(s
, len
+ 1, mstate
, vstate
)) {
4200 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4201 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4207 remaining
= (int64_t)size
;
4212 if (index
< 0 && index
+ remaining
> 0) {
4218 if ((size_t)index
>= len
|| index
< 0) {
4220 } else if (remaining
< 0) {
4221 remaining
+= len
- index
;
4222 } else if ((uint64_t)index
+ (uint64_t)remaining
> size
) {
4223 remaining
= size
- index
;
4226 for (i
= 0; i
< remaining
; i
++) {
4227 if ((d
[i
] = dtrace_load8(s
+ index
+ i
)) == '\0')
4233 mstate
->dtms_scratch_ptr
+= size
;
4234 regs
[rd
] = (uintptr_t)d
;
4238 case DIF_SUBR_GETMAJOR
:
4239 regs
[rd
] = (uintptr_t)major( (dev_t
)tupregs
[0].dttk_value
);
4242 case DIF_SUBR_GETMINOR
:
4243 regs
[rd
] = (uintptr_t)minor( (dev_t
)tupregs
[0].dttk_value
);
4246 case DIF_SUBR_DDI_PATHNAME
: {
4247 /* APPLE NOTE: currently unsupported on Darwin */
4248 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
4253 case DIF_SUBR_STRJOIN
: {
4254 char *d
= (char *)mstate
->dtms_scratch_ptr
;
4255 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4256 uintptr_t s1
= tupregs
[0].dttk_value
;
4257 uintptr_t s2
= tupregs
[1].dttk_value
;
4258 uint64_t i
= 0, j
= 0;
4262 if (!dtrace_strcanload(s1
, size
, &lim1
, mstate
, vstate
) ||
4263 !dtrace_strcanload(s2
, size
, &lim2
, mstate
, vstate
)) {
4268 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4269 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4276 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4280 c
= (i
>= lim1
) ? '\0' : dtrace_load8(s1
++);
4281 if ((d
[i
++] = c
) == '\0') {
4289 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4293 c
= (j
++ >= lim2
) ? '\0' : dtrace_load8(s2
++);
4294 if ((d
[i
++] = c
) == '\0')
4299 mstate
->dtms_scratch_ptr
+= i
;
4300 regs
[rd
] = (uintptr_t)d
;
4306 case DIF_SUBR_LLTOSTR
: {
4307 int64_t i
= (int64_t)tupregs
[0].dttk_value
;
4308 int64_t val
= i
< 0 ? i
* -1 : i
;
4309 uint64_t size
= 22; /* enough room for 2^64 in decimal */
4310 char *end
= (char *)mstate
->dtms_scratch_ptr
+ size
- 1;
4312 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4313 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4318 for (*end
-- = '\0'; val
; val
/= 10)
4319 *end
-- = '0' + (val
% 10);
4327 regs
[rd
] = (uintptr_t)end
+ 1;
4328 mstate
->dtms_scratch_ptr
+= size
;
4332 case DIF_SUBR_HTONS
:
4333 case DIF_SUBR_NTOHS
:
4335 regs
[rd
] = (uint16_t)tupregs
[0].dttk_value
;
4337 regs
[rd
] = DT_BSWAP_16((uint16_t)tupregs
[0].dttk_value
);
4342 case DIF_SUBR_HTONL
:
4343 case DIF_SUBR_NTOHL
:
4345 regs
[rd
] = (uint32_t)tupregs
[0].dttk_value
;
4347 regs
[rd
] = DT_BSWAP_32((uint32_t)tupregs
[0].dttk_value
);
4352 case DIF_SUBR_HTONLL
:
4353 case DIF_SUBR_NTOHLL
:
4355 regs
[rd
] = (uint64_t)tupregs
[0].dttk_value
;
4357 regs
[rd
] = DT_BSWAP_64((uint64_t)tupregs
[0].dttk_value
);
4362 case DIF_SUBR_DIRNAME
:
4363 case DIF_SUBR_BASENAME
: {
4364 char *dest
= (char *)mstate
->dtms_scratch_ptr
;
4365 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4366 uintptr_t src
= tupregs
[0].dttk_value
;
4367 int i
, j
, len
= dtrace_strlen((char *)src
, size
);
4368 int lastbase
= -1, firstbase
= -1, lastdir
= -1;
4371 if (!dtrace_canload(src
, len
+ 1, mstate
, vstate
)) {
4376 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4377 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4383 * The basename and dirname for a zero-length string is
4388 src
= (uintptr_t)".";
4392 * Start from the back of the string, moving back toward the
4393 * front until we see a character that isn't a slash. That
4394 * character is the last character in the basename.
4396 for (i
= len
- 1; i
>= 0; i
--) {
4397 if (dtrace_load8(src
+ i
) != '/')
4405 * Starting from the last character in the basename, move
4406 * towards the front until we find a slash. The character
4407 * that we processed immediately before that is the first
4408 * character in the basename.
4410 for (; i
>= 0; i
--) {
4411 if (dtrace_load8(src
+ i
) == '/')
4419 * Now keep going until we find a non-slash character. That
4420 * character is the last character in the dirname.
4422 for (; i
>= 0; i
--) {
4423 if (dtrace_load8(src
+ i
) != '/')
4430 ASSERT(!(lastbase
== -1 && firstbase
!= -1));
4431 ASSERT(!(firstbase
== -1 && lastdir
!= -1));
4433 if (lastbase
== -1) {
4435 * We didn't find a non-slash character. We know that
4436 * the length is non-zero, so the whole string must be
4437 * slashes. In either the dirname or the basename
4438 * case, we return '/'.
4440 ASSERT(firstbase
== -1);
4441 firstbase
= lastbase
= lastdir
= 0;
4444 if (firstbase
== -1) {
4446 * The entire string consists only of a basename
4447 * component. If we're looking for dirname, we need
4448 * to change our string to be just "."; if we're
4449 * looking for a basename, we'll just set the first
4450 * character of the basename to be 0.
4452 if (subr
== DIF_SUBR_DIRNAME
) {
4453 ASSERT(lastdir
== -1);
4454 src
= (uintptr_t)".";
4461 if (subr
== DIF_SUBR_DIRNAME
) {
4462 if (lastdir
== -1) {
4464 * We know that we have a slash in the name --
4465 * or lastdir would be set to 0, above. And
4466 * because lastdir is -1, we know that this
4467 * slash must be the first character. (That
4468 * is, the full string must be of the form
4469 * "/basename".) In this case, the last
4470 * character of the directory name is 0.
4478 ASSERT(subr
== DIF_SUBR_BASENAME
);
4479 ASSERT(firstbase
!= -1 && lastbase
!= -1);
4484 for (i
= start
, j
= 0; i
<= end
&& (uint64_t)j
< size
- 1; i
++, j
++)
4485 dest
[j
] = dtrace_load8(src
+ i
);
4488 regs
[rd
] = (uintptr_t)dest
;
4489 mstate
->dtms_scratch_ptr
+= size
;
4493 case DIF_SUBR_CLEANPATH
: {
4494 char *dest
= (char *)mstate
->dtms_scratch_ptr
, c
;
4495 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4496 uintptr_t src
= tupregs
[0].dttk_value
;
4498 size_t i
= 0, j
= 0;
4500 if (!dtrace_strcanload(src
, size
, &lim
, mstate
, vstate
)) {
4505 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4506 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4512 * Move forward, loading each character.
4515 c
= (i
>= lim
) ? '\0' : dtrace_load8(src
+ i
++);
4517 if ((uint64_t)(j
+ 5) >= size
) /* 5 = strlen("/..c\0") */
4525 c
= (i
>= lim
) ? '\0' : dtrace_load8(src
+ i
++);
4529 * We have two slashes -- we can just advance
4530 * to the next character.
4537 * This is not "." and it's not ".." -- we can
4538 * just store the "/" and this character and
4546 c
= (i
>= lim
) ? '\0' : dtrace_load8(src
+ i
++);
4550 * This is a "/./" component. We're not going
4551 * to store anything in the destination buffer;
4552 * we're just going to go to the next component.
4559 * This is not ".." -- we can just store the
4560 * "/." and this character and continue
4569 c
= (i
>= lim
) ? '\0' : dtrace_load8(src
+ i
++);
4571 if (c
!= '/' && c
!= '\0') {
4573 * This is not ".." -- it's "..[mumble]".
4574 * We'll store the "/.." and this character
4575 * and continue processing.
4585 * This is "/../" or "/..\0". We need to back up
4586 * our destination pointer until we find a "/".
4589 while (j
!= 0 && dest
[--j
] != '/')
4594 } while (c
!= '\0');
4597 regs
[rd
] = (uintptr_t)dest
;
4598 mstate
->dtms_scratch_ptr
+= size
;
4602 case DIF_SUBR_INET_NTOA
:
4603 case DIF_SUBR_INET_NTOA6
:
4604 case DIF_SUBR_INET_NTOP
: {
4609 if (subr
== DIF_SUBR_INET_NTOP
) {
4610 af
= (int)tupregs
[0].dttk_value
;
4613 af
= subr
== DIF_SUBR_INET_NTOA
? AF_INET
: AF_INET6
;
4617 if (af
== AF_INET
) {
4618 #if !defined(__APPLE__)
4622 #endif /* __APPLE__ */
4626 * Safely load the IPv4 address.
4628 #if !defined(__APPLE__)
4629 ip4
= dtrace_load32(tupregs
[argi
].dttk_value
);
4631 if (!dtrace_canload(tupregs
[argi
].dttk_value
, sizeof(ip4
),
4638 (void *)(uintptr_t)tupregs
[argi
].dttk_value
,
4639 (void *)(uintptr_t)&ip4
, sizeof (ip4
));
4640 #endif /* __APPLE__ */
4642 * Check an IPv4 string will fit in scratch.
4644 #if !defined(__APPLE__)
4645 size
= INET_ADDRSTRLEN
;
4647 size
= MAX_IPv4_STR_LEN
;
4648 #endif /* __APPLE__ */
4649 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4650 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4654 base
= (char *)mstate
->dtms_scratch_ptr
;
4655 end
= (char *)mstate
->dtms_scratch_ptr
+ size
- 1;
4658 * Stringify as a dotted decimal quad.
4661 ptr8
= (uint8_t *)&ip4
;
4662 for (i
= 3; i
>= 0; i
--) {
4668 for (; val
; val
/= 10) {
4669 *end
-- = '0' + (val
% 10);
4676 ASSERT(end
+ 1 >= base
);
4678 } else if (af
== AF_INET6
) {
4679 #if defined(__APPLE__)
4680 #define _S6_un __u6_addr
4681 #define _S6_u8 __u6_addr8
4682 #endif /* __APPLE__ */
4683 struct in6_addr ip6
;
4684 int firstzero
, tryzero
, numzero
, v6end
;
4686 const char digits
[] = "0123456789abcdef";
4689 * Stringify using RFC 1884 convention 2 - 16 bit
4690 * hexadecimal values with a zero-run compression.
4691 * Lower case hexadecimal digits are used.
4692 * eg, fe80::214:4fff:fe0b:76c8.
4693 * The IPv4 embedded form is returned for inet_ntop,
4694 * just the IPv4 string is returned for inet_ntoa6.
4697 if (!dtrace_canload(tupregs
[argi
].dttk_value
,
4698 sizeof(struct in6_addr
), mstate
, vstate
)) {
4704 * Safely load the IPv6 address.
4707 (void *)(uintptr_t)tupregs
[argi
].dttk_value
,
4708 (void *)(uintptr_t)&ip6
, sizeof (struct in6_addr
));
4711 * Check an IPv6 string will fit in scratch.
4713 size
= INET6_ADDRSTRLEN
;
4714 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4715 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4719 base
= (char *)mstate
->dtms_scratch_ptr
;
4720 end
= (char *)mstate
->dtms_scratch_ptr
+ size
- 1;
4724 * Find the longest run of 16 bit zero values
4725 * for the single allowed zero compression - "::".
4730 for (i
= 0; i
< (int)sizeof (struct in6_addr
); i
++) {
4731 if (ip6
._S6_un
._S6_u8
[i
] == 0 &&
4732 tryzero
== -1 && i
% 2 == 0) {
4737 if (tryzero
!= -1 &&
4738 (ip6
._S6_un
._S6_u8
[i
] != 0 ||
4739 i
== sizeof (struct in6_addr
) - 1)) {
4741 if (i
- tryzero
<= numzero
) {
4746 firstzero
= tryzero
;
4747 numzero
= i
- i
% 2 - tryzero
;
4750 if (ip6
._S6_un
._S6_u8
[i
] == 0 &&
4751 i
== sizeof (struct in6_addr
) - 1)
4755 ASSERT(firstzero
+ numzero
<= (int)sizeof (struct in6_addr
));
4758 * Check for an IPv4 embedded address.
4760 v6end
= sizeof (struct in6_addr
) - 2;
4761 if (IN6_IS_ADDR_V4MAPPED(&ip6
) ||
4762 IN6_IS_ADDR_V4COMPAT(&ip6
)) {
4763 for (i
= sizeof (struct in6_addr
) - 1;
4764 i
>= (int)DTRACE_V4MAPPED_OFFSET
; i
--) {
4765 ASSERT(end
>= base
);
4767 val
= ip6
._S6_un
._S6_u8
[i
];
4772 for (; val
; val
/= 10) {
4773 *end
-- = '0' + val
% 10;
4777 if (i
> (int)DTRACE_V4MAPPED_OFFSET
)
4781 if (subr
== DIF_SUBR_INET_NTOA6
)
4785 * Set v6end to skip the IPv4 address that
4786 * we have already stringified.
4792 * Build the IPv6 string by working through the
4793 * address in reverse.
4795 for (i
= v6end
; i
>= 0; i
-= 2) {
4796 ASSERT(end
>= base
);
4798 if (i
== firstzero
+ numzero
- 2) {
4805 if (i
< 14 && i
!= firstzero
- 2)
4808 val
= (ip6
._S6_un
._S6_u8
[i
] << 8) +
4809 ip6
._S6_un
._S6_u8
[i
+ 1];
4814 for (; val
; val
/= 16) {
4815 *end
-- = digits
[val
% 16];
4819 ASSERT(end
+ 1 >= base
);
4821 #if defined(__APPLE__)
4824 #endif /* __APPLE__ */
4827 * The user didn't use AH_INET or AH_INET6.
4829 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
4834 inetout
: regs
[rd
] = (uintptr_t)end
+ 1;
4835 mstate
->dtms_scratch_ptr
+= size
;
4839 case DIF_SUBR_TOUPPER
:
4840 case DIF_SUBR_TOLOWER
: {
4841 uintptr_t src
= tupregs
[0].dttk_value
;
4842 char *dest
= (char *)mstate
->dtms_scratch_ptr
;
4843 char lower
, upper
, base
, c
;
4844 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4845 size_t len
= dtrace_strlen((char*) src
, size
);
4848 lower
= (subr
== DIF_SUBR_TOUPPER
) ? 'a' : 'A';
4849 upper
= (subr
== DIF_SUBR_TOUPPER
) ? 'z' : 'Z';
4850 base
= (subr
== DIF_SUBR_TOUPPER
) ? 'A' : 'a';
4852 if (!dtrace_canload(src
, len
+ 1, mstate
, vstate
)) {
4857 if (!DTRACE_INSCRATCH(mstate
, size
)) {
4858 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
4863 for (i
= 0; i
< size
- 1; ++i
) {
4864 if ((c
= dtrace_load8(src
+ i
)) == '\0')
4866 if (c
>= lower
&& c
<= upper
)
4867 c
= base
+ (c
- lower
);
4874 regs
[rd
] = (uintptr_t) dest
;
4875 mstate
->dtms_scratch_ptr
+= size
;
4880 #if defined(__APPLE__)
4881 case DIF_SUBR_VM_KERNEL_ADDRPERM
: {
4882 if (!dtrace_priv_kernel(state
)) {
4885 regs
[rd
] = VM_KERNEL_ADDRPERM((vm_offset_t
) tupregs
[0].dttk_value
);
4891 case DIF_SUBR_KDEBUG_TRACE
: {
4893 uintptr_t args
[4] = {0};
4896 if (nargs
< 2 || nargs
> 5) {
4897 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
4901 if (dtrace_destructive_disallow
)
4904 debugid
= tupregs
[0].dttk_value
;
4905 for (i
= 0; i
< nargs
- 1; i
++)
4906 args
[i
] = tupregs
[i
+ 1].dttk_value
;
4908 kernel_debug(debugid
, args
[0], args
[1], args
[2], args
[3], 0);
4913 case DIF_SUBR_KDEBUG_TRACE_STRING
: {
4918 if (dtrace_destructive_disallow
)
4921 uint64_t size
= state
->dts_options
[DTRACEOPT_STRSIZE
];
4922 uint32_t debugid
= tupregs
[0].dttk_value
;
4923 uint64_t str_id
= tupregs
[1].dttk_value
;
4924 uintptr_t src
= tupregs
[2].dttk_value
;
4929 if (src
!= (uintptr_t)0) {
4931 if (!dtrace_strcanload(src
, size
, &lim
, mstate
, vstate
)) {
4934 dtrace_strcpy((void*)src
, buf
, size
);
4937 (void)kernel_debug_string(debugid
, &str_id
, str
);
4948 * Emulate the execution of DTrace IR instructions specified by the given
4949 * DIF object. This function is deliberately void of assertions as all of
4950 * the necessary checks are handled by a call to dtrace_difo_validate().
4953 dtrace_dif_emulate(dtrace_difo_t
*difo
, dtrace_mstate_t
*mstate
,
4954 dtrace_vstate_t
*vstate
, dtrace_state_t
*state
)
4956 const dif_instr_t
*text
= difo
->dtdo_buf
;
4957 const uint_t textlen
= difo
->dtdo_len
;
4958 const char *strtab
= difo
->dtdo_strtab
;
4959 const uint64_t *inttab
= difo
->dtdo_inttab
;
4962 dtrace_statvar_t
*svar
;
4963 dtrace_dstate_t
*dstate
= &vstate
->dtvs_dynvars
;
4965 volatile uint16_t *flags
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
4966 volatile uint64_t *illval
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
;
4968 dtrace_key_t tupregs
[DIF_DTR_NREGS
+ 2]; /* +2 for thread and id */
4969 uint64_t regs
[DIF_DIR_NREGS
];
4972 uint8_t cc_n
= 0, cc_z
= 0, cc_v
= 0, cc_c
= 0;
4974 uint_t pc
= 0, id
, opc
= 0;
4980 * We stash the current DIF object into the machine state: we need it
4981 * for subsequent access checking.
4983 mstate
->dtms_difo
= difo
;
4985 regs
[DIF_REG_R0
] = 0; /* %r0 is fixed at zero */
4987 while (pc
< textlen
&& !(*flags
& CPU_DTRACE_FAULT
)) {
4991 r1
= DIF_INSTR_R1(instr
);
4992 r2
= DIF_INSTR_R2(instr
);
4993 rd
= DIF_INSTR_RD(instr
);
4995 switch (DIF_INSTR_OP(instr
)) {
4997 regs
[rd
] = regs
[r1
] | regs
[r2
];
5000 regs
[rd
] = regs
[r1
] ^ regs
[r2
];
5003 regs
[rd
] = regs
[r1
] & regs
[r2
];
5006 regs
[rd
] = regs
[r1
] << regs
[r2
];
5009 regs
[rd
] = regs
[r1
] >> regs
[r2
];
5012 regs
[rd
] = regs
[r1
] - regs
[r2
];
5015 regs
[rd
] = regs
[r1
] + regs
[r2
];
5018 regs
[rd
] = regs
[r1
] * regs
[r2
];
5021 if (regs
[r2
] == 0) {
5023 *flags
|= CPU_DTRACE_DIVZERO
;
5025 regs
[rd
] = (int64_t)regs
[r1
] /
5031 if (regs
[r2
] == 0) {
5033 *flags
|= CPU_DTRACE_DIVZERO
;
5035 regs
[rd
] = regs
[r1
] / regs
[r2
];
5040 if (regs
[r2
] == 0) {
5042 *flags
|= CPU_DTRACE_DIVZERO
;
5044 regs
[rd
] = (int64_t)regs
[r1
] %
5050 if (regs
[r2
] == 0) {
5052 *flags
|= CPU_DTRACE_DIVZERO
;
5054 regs
[rd
] = regs
[r1
] % regs
[r2
];
5059 regs
[rd
] = ~regs
[r1
];
5062 regs
[rd
] = regs
[r1
];
5065 cc_r
= regs
[r1
] - regs
[r2
];
5069 cc_c
= regs
[r1
] < regs
[r2
];
5072 cc_n
= cc_v
= cc_c
= 0;
5073 cc_z
= regs
[r1
] == 0;
5076 pc
= DIF_INSTR_LABEL(instr
);
5080 pc
= DIF_INSTR_LABEL(instr
);
5084 pc
= DIF_INSTR_LABEL(instr
);
5087 if ((cc_z
| (cc_n
^ cc_v
)) == 0)
5088 pc
= DIF_INSTR_LABEL(instr
);
5091 if ((cc_c
| cc_z
) == 0)
5092 pc
= DIF_INSTR_LABEL(instr
);
5095 if ((cc_n
^ cc_v
) == 0)
5096 pc
= DIF_INSTR_LABEL(instr
);
5100 pc
= DIF_INSTR_LABEL(instr
);
5104 pc
= DIF_INSTR_LABEL(instr
);
5108 pc
= DIF_INSTR_LABEL(instr
);
5111 if (cc_z
| (cc_n
^ cc_v
))
5112 pc
= DIF_INSTR_LABEL(instr
);
5116 pc
= DIF_INSTR_LABEL(instr
);
5119 if (!dtrace_canstore(regs
[r1
], 1, mstate
, vstate
)) {
5120 *flags
|= CPU_DTRACE_KPRIV
;
5126 regs
[rd
] = (int8_t)dtrace_load8(regs
[r1
]);
5129 if (!dtrace_canstore(regs
[r1
], 2, mstate
, vstate
)) {
5130 *flags
|= CPU_DTRACE_KPRIV
;
5136 regs
[rd
] = (int16_t)dtrace_load16(regs
[r1
]);
5139 if (!dtrace_canstore(regs
[r1
], 4, mstate
, vstate
)) {
5140 *flags
|= CPU_DTRACE_KPRIV
;
5146 regs
[rd
] = (int32_t)dtrace_load32(regs
[r1
]);
5149 if (!dtrace_canstore(regs
[r1
], 1, mstate
, vstate
)) {
5150 *flags
|= CPU_DTRACE_KPRIV
;
5156 regs
[rd
] = dtrace_load8(regs
[r1
]);
5159 if (!dtrace_canstore(regs
[r1
], 2, mstate
, vstate
)) {
5160 *flags
|= CPU_DTRACE_KPRIV
;
5166 regs
[rd
] = dtrace_load16(regs
[r1
]);
5169 if (!dtrace_canstore(regs
[r1
], 4, mstate
, vstate
)) {
5170 *flags
|= CPU_DTRACE_KPRIV
;
5176 regs
[rd
] = dtrace_load32(regs
[r1
]);
5179 if (!dtrace_canstore(regs
[r1
], 8, mstate
, vstate
)) {
5180 *flags
|= CPU_DTRACE_KPRIV
;
5186 regs
[rd
] = dtrace_load64(regs
[r1
]);
5189 * Darwin 32-bit kernel may fetch from 64-bit user.
5190 * Do not cast regs to uintptr_t
5191 * DIF_OP_ULDSB,DIF_OP_ULDSH, DIF_OP_ULDSW, DIF_OP_ULDUB
5192 * DIF_OP_ULDUH, DIF_OP_ULDUW, DIF_OP_ULDX
5196 dtrace_fuword8(regs
[r1
]);
5199 regs
[rd
] = (int16_t)
5200 dtrace_fuword16(regs
[r1
]);
5203 regs
[rd
] = (int32_t)
5204 dtrace_fuword32(regs
[r1
]);
5208 dtrace_fuword8(regs
[r1
]);
5212 dtrace_fuword16(regs
[r1
]);
5216 dtrace_fuword32(regs
[r1
]);
5220 dtrace_fuword64(regs
[r1
]);
5229 regs
[rd
] = inttab
[DIF_INSTR_INTEGER(instr
)];
5232 regs
[rd
] = (uint64_t)(uintptr_t)
5233 (strtab
+ DIF_INSTR_STRING(instr
));
5236 size_t sz
= state
->dts_options
[DTRACEOPT_STRSIZE
];
5237 uintptr_t s1
= regs
[r1
];
5238 uintptr_t s2
= regs
[r2
];
5239 size_t lim1
= sz
, lim2
= sz
;
5242 !dtrace_strcanload(s1
, sz
, &lim1
, mstate
, vstate
))
5245 !dtrace_strcanload(s2
, sz
, &lim2
, mstate
, vstate
))
5248 cc_r
= dtrace_strncmp((char *)s1
, (char *)s2
,
5257 regs
[rd
] = dtrace_dif_variable(mstate
, state
,
5261 id
= DIF_INSTR_VAR(instr
);
5263 if (id
>= DIF_VAR_OTHER_UBASE
) {
5266 id
-= DIF_VAR_OTHER_UBASE
;
5267 svar
= vstate
->dtvs_globals
[id
];
5268 ASSERT(svar
!= NULL
);
5269 v
= &svar
->dtsv_var
;
5271 if (!(v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
)) {
5272 regs
[rd
] = svar
->dtsv_data
;
5276 a
= (uintptr_t)svar
->dtsv_data
;
5278 if (*(uint8_t *)a
== UINT8_MAX
) {
5280 * If the 0th byte is set to UINT8_MAX
5281 * then this is to be treated as a
5282 * reference to a NULL variable.
5286 regs
[rd
] = a
+ sizeof (uint64_t);
5292 regs
[rd
] = dtrace_dif_variable(mstate
, state
, id
, 0);
5296 id
= DIF_INSTR_VAR(instr
);
5298 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5299 id
-= DIF_VAR_OTHER_UBASE
;
5301 VERIFY(id
< (uint_t
)vstate
->dtvs_nglobals
);
5302 svar
= vstate
->dtvs_globals
[id
];
5303 ASSERT(svar
!= NULL
);
5304 v
= &svar
->dtsv_var
;
5306 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5307 uintptr_t a
= (uintptr_t)svar
->dtsv_data
;
5311 ASSERT(svar
->dtsv_size
!= 0);
5313 if (regs
[rd
] == 0) {
5314 *(uint8_t *)a
= UINT8_MAX
;
5318 a
+= sizeof (uint64_t);
5320 if (!dtrace_vcanload(
5321 (void *)(uintptr_t)regs
[rd
], &v
->dtdv_type
,
5322 &lim
, mstate
, vstate
))
5325 dtrace_vcopy((void *)(uintptr_t)regs
[rd
],
5326 (void *)a
, &v
->dtdv_type
, lim
);
5330 svar
->dtsv_data
= regs
[rd
];
5335 * There are no DTrace built-in thread-local arrays at
5336 * present. This opcode is saved for future work.
5338 *flags
|= CPU_DTRACE_ILLOP
;
5343 id
= DIF_INSTR_VAR(instr
);
5345 if (id
< DIF_VAR_OTHER_UBASE
) {
5347 * For now, this has no meaning.
5353 id
-= DIF_VAR_OTHER_UBASE
;
5355 ASSERT(id
< (uint_t
)vstate
->dtvs_nlocals
);
5356 ASSERT(vstate
->dtvs_locals
!= NULL
);
5357 svar
= vstate
->dtvs_locals
[id
];
5358 ASSERT(svar
!= NULL
);
5359 v
= &svar
->dtsv_var
;
5361 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5362 uintptr_t a
= (uintptr_t)svar
->dtsv_data
;
5363 size_t sz
= v
->dtdv_type
.dtdt_size
;
5365 sz
+= sizeof (uint64_t);
5366 ASSERT(svar
->dtsv_size
== (int)NCPU
* sz
);
5367 a
+= CPU
->cpu_id
* sz
;
5369 if (*(uint8_t *)a
== UINT8_MAX
) {
5371 * If the 0th byte is set to UINT8_MAX
5372 * then this is to be treated as a
5373 * reference to a NULL variable.
5377 regs
[rd
] = a
+ sizeof (uint64_t);
5383 ASSERT(svar
->dtsv_size
== (int)NCPU
* sizeof (uint64_t));
5384 tmp
= (uint64_t *)(uintptr_t)svar
->dtsv_data
;
5385 regs
[rd
] = tmp
[CPU
->cpu_id
];
5389 id
= DIF_INSTR_VAR(instr
);
5391 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5392 id
-= DIF_VAR_OTHER_UBASE
;
5393 VERIFY(id
< (uint_t
)vstate
->dtvs_nlocals
);
5394 ASSERT(vstate
->dtvs_locals
!= NULL
);
5395 svar
= vstate
->dtvs_locals
[id
];
5396 ASSERT(svar
!= NULL
);
5397 v
= &svar
->dtsv_var
;
5399 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5400 uintptr_t a
= (uintptr_t)svar
->dtsv_data
;
5401 size_t sz
= v
->dtdv_type
.dtdt_size
;
5404 sz
+= sizeof (uint64_t);
5405 ASSERT(svar
->dtsv_size
== (int)NCPU
* sz
);
5406 a
+= CPU
->cpu_id
* sz
;
5408 if (regs
[rd
] == 0) {
5409 *(uint8_t *)a
= UINT8_MAX
;
5413 a
+= sizeof (uint64_t);
5416 if (!dtrace_vcanload(
5417 (void *)(uintptr_t)regs
[rd
], &v
->dtdv_type
,
5418 &lim
, mstate
, vstate
))
5421 dtrace_vcopy((void *)(uintptr_t)regs
[rd
],
5422 (void *)a
, &v
->dtdv_type
, lim
);
5426 ASSERT(svar
->dtsv_size
== (int)NCPU
* sizeof (uint64_t));
5427 tmp
= (uint64_t *)(uintptr_t)svar
->dtsv_data
;
5428 tmp
[CPU
->cpu_id
] = regs
[rd
];
5432 dtrace_dynvar_t
*dvar
;
5435 id
= DIF_INSTR_VAR(instr
);
5436 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5437 id
-= DIF_VAR_OTHER_UBASE
;
5438 v
= &vstate
->dtvs_tlocals
[id
];
5440 key
= &tupregs
[DIF_DTR_NREGS
];
5441 key
[0].dttk_value
= (uint64_t)id
;
5442 key
[0].dttk_size
= 0;
5443 DTRACE_TLS_THRKEY(key
[1].dttk_value
);
5444 key
[1].dttk_size
= 0;
5446 dvar
= dtrace_dynvar(dstate
, 2, key
,
5447 sizeof (uint64_t), DTRACE_DYNVAR_NOALLOC
,
5455 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5456 regs
[rd
] = (uint64_t)(uintptr_t)dvar
->dtdv_data
;
5458 regs
[rd
] = *((uint64_t *)dvar
->dtdv_data
);
5465 dtrace_dynvar_t
*dvar
;
5468 id
= DIF_INSTR_VAR(instr
);
5469 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5470 id
-= DIF_VAR_OTHER_UBASE
;
5471 VERIFY(id
< (uint_t
)vstate
->dtvs_ntlocals
);
5473 key
= &tupregs
[DIF_DTR_NREGS
];
5474 key
[0].dttk_value
= (uint64_t)id
;
5475 key
[0].dttk_size
= 0;
5476 DTRACE_TLS_THRKEY(key
[1].dttk_value
);
5477 key
[1].dttk_size
= 0;
5478 v
= &vstate
->dtvs_tlocals
[id
];
5480 dvar
= dtrace_dynvar(dstate
, 2, key
,
5481 v
->dtdv_type
.dtdt_size
> sizeof (uint64_t) ?
5482 v
->dtdv_type
.dtdt_size
: sizeof (uint64_t),
5483 regs
[rd
] ? DTRACE_DYNVAR_ALLOC
:
5484 DTRACE_DYNVAR_DEALLOC
, mstate
, vstate
);
5487 * Given that we're storing to thread-local data,
5488 * we need to flush our predicate cache.
5490 dtrace_set_thread_predcache(current_thread(), 0);
5495 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5498 if (!dtrace_vcanload(
5499 (void *)(uintptr_t)regs
[rd
],
5500 &v
->dtdv_type
, &lim
, mstate
, vstate
))
5503 dtrace_vcopy((void *)(uintptr_t)regs
[rd
],
5504 dvar
->dtdv_data
, &v
->dtdv_type
, lim
);
5506 *((uint64_t *)dvar
->dtdv_data
) = regs
[rd
];
5513 regs
[rd
] = (int64_t)regs
[r1
] >> regs
[r2
];
5517 dtrace_dif_subr(DIF_INSTR_SUBR(instr
), rd
,
5518 regs
, tupregs
, ttop
, mstate
, state
);
5522 if (ttop
== DIF_DTR_NREGS
) {
5523 *flags
|= CPU_DTRACE_TUPOFLOW
;
5527 if (r1
== DIF_TYPE_STRING
) {
5529 * If this is a string type and the size is 0,
5530 * we'll use the system-wide default string
5531 * size. Note that we are _not_ looking at
5532 * the value of the DTRACEOPT_STRSIZE option;
5533 * had this been set, we would expect to have
5534 * a non-zero size value in the "pushtr".
5536 tupregs
[ttop
].dttk_size
=
5537 dtrace_strlen((char *)(uintptr_t)regs
[rd
],
5538 regs
[r2
] ? regs
[r2
] :
5539 dtrace_strsize_default
) + 1;
5541 if (regs
[r2
] > LONG_MAX
) {
5542 *flags
|= CPU_DTRACE_ILLOP
;
5545 tupregs
[ttop
].dttk_size
= regs
[r2
];
5548 tupregs
[ttop
++].dttk_value
= regs
[rd
];
5552 if (ttop
== DIF_DTR_NREGS
) {
5553 *flags
|= CPU_DTRACE_TUPOFLOW
;
5557 tupregs
[ttop
].dttk_value
= regs
[rd
];
5558 tupregs
[ttop
++].dttk_size
= 0;
5566 case DIF_OP_FLUSHTS
:
5571 case DIF_OP_LDTAA
: {
5572 dtrace_dynvar_t
*dvar
;
5573 dtrace_key_t
*key
= tupregs
;
5574 uint_t nkeys
= ttop
;
5576 id
= DIF_INSTR_VAR(instr
);
5577 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5578 id
-= DIF_VAR_OTHER_UBASE
;
5580 key
[nkeys
].dttk_value
= (uint64_t)id
;
5581 key
[nkeys
++].dttk_size
= 0;
5583 if (DIF_INSTR_OP(instr
) == DIF_OP_LDTAA
) {
5584 DTRACE_TLS_THRKEY(key
[nkeys
].dttk_value
);
5585 key
[nkeys
++].dttk_size
= 0;
5586 VERIFY(id
< (uint_t
)vstate
->dtvs_ntlocals
);
5587 v
= &vstate
->dtvs_tlocals
[id
];
5589 VERIFY(id
< (uint_t
)vstate
->dtvs_nglobals
);
5590 v
= &vstate
->dtvs_globals
[id
]->dtsv_var
;
5593 dvar
= dtrace_dynvar(dstate
, nkeys
, key
,
5594 v
->dtdv_type
.dtdt_size
> sizeof (uint64_t) ?
5595 v
->dtdv_type
.dtdt_size
: sizeof (uint64_t),
5596 DTRACE_DYNVAR_NOALLOC
, mstate
, vstate
);
5603 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5604 regs
[rd
] = (uint64_t)(uintptr_t)dvar
->dtdv_data
;
5606 regs
[rd
] = *((uint64_t *)dvar
->dtdv_data
);
5613 case DIF_OP_STTAA
: {
5614 dtrace_dynvar_t
*dvar
;
5615 dtrace_key_t
*key
= tupregs
;
5616 uint_t nkeys
= ttop
;
5618 id
= DIF_INSTR_VAR(instr
);
5619 ASSERT(id
>= DIF_VAR_OTHER_UBASE
);
5620 id
-= DIF_VAR_OTHER_UBASE
;
5622 key
[nkeys
].dttk_value
= (uint64_t)id
;
5623 key
[nkeys
++].dttk_size
= 0;
5625 if (DIF_INSTR_OP(instr
) == DIF_OP_STTAA
) {
5626 DTRACE_TLS_THRKEY(key
[nkeys
].dttk_value
);
5627 key
[nkeys
++].dttk_size
= 0;
5628 VERIFY(id
< (uint_t
)vstate
->dtvs_ntlocals
);
5629 v
= &vstate
->dtvs_tlocals
[id
];
5631 VERIFY(id
< (uint_t
)vstate
->dtvs_nglobals
);
5632 v
= &vstate
->dtvs_globals
[id
]->dtsv_var
;
5635 dvar
= dtrace_dynvar(dstate
, nkeys
, key
,
5636 v
->dtdv_type
.dtdt_size
> sizeof (uint64_t) ?
5637 v
->dtdv_type
.dtdt_size
: sizeof (uint64_t),
5638 regs
[rd
] ? DTRACE_DYNVAR_ALLOC
:
5639 DTRACE_DYNVAR_DEALLOC
, mstate
, vstate
);
5644 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
) {
5647 if (!dtrace_vcanload(
5648 (void *)(uintptr_t)regs
[rd
], &v
->dtdv_type
,
5649 &lim
, mstate
, vstate
))
5652 dtrace_vcopy((void *)(uintptr_t)regs
[rd
],
5653 dvar
->dtdv_data
, &v
->dtdv_type
, lim
);
5655 *((uint64_t *)dvar
->dtdv_data
) = regs
[rd
];
5661 case DIF_OP_ALLOCS
: {
5662 uintptr_t ptr
= P2ROUNDUP(mstate
->dtms_scratch_ptr
, 8);
5663 size_t size
= ptr
- mstate
->dtms_scratch_ptr
+ regs
[r1
];
5666 * Rounding up the user allocation size could have
5667 * overflowed large, bogus allocations (like -1ULL) to
5670 if (size
< regs
[r1
] ||
5671 !DTRACE_INSCRATCH(mstate
, size
)) {
5672 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
5677 dtrace_bzero((void *) mstate
->dtms_scratch_ptr
, size
);
5678 mstate
->dtms_scratch_ptr
+= size
;
5684 if (!dtrace_canstore(regs
[rd
], regs
[r2
],
5686 *flags
|= CPU_DTRACE_BADADDR
;
5691 if (!dtrace_canload(regs
[r1
], regs
[r2
], mstate
, vstate
))
5694 dtrace_bcopy((void *)(uintptr_t)regs
[r1
],
5695 (void *)(uintptr_t)regs
[rd
], (size_t)regs
[r2
]);
5699 if (!dtrace_canstore(regs
[rd
], 1, mstate
, vstate
)) {
5700 *flags
|= CPU_DTRACE_BADADDR
;
5704 *((uint8_t *)(uintptr_t)regs
[rd
]) = (uint8_t)regs
[r1
];
5708 if (!dtrace_canstore(regs
[rd
], 2, mstate
, vstate
)) {
5709 *flags
|= CPU_DTRACE_BADADDR
;
5714 *flags
|= CPU_DTRACE_BADALIGN
;
5718 *((uint16_t *)(uintptr_t)regs
[rd
]) = (uint16_t)regs
[r1
];
5722 if (!dtrace_canstore(regs
[rd
], 4, mstate
, vstate
)) {
5723 *flags
|= CPU_DTRACE_BADADDR
;
5728 *flags
|= CPU_DTRACE_BADALIGN
;
5732 *((uint32_t *)(uintptr_t)regs
[rd
]) = (uint32_t)regs
[r1
];
5736 if (!dtrace_canstore(regs
[rd
], 8, mstate
, vstate
)) {
5737 *flags
|= CPU_DTRACE_BADADDR
;
5743 * Darwin kmem_zalloc() called from
5744 * dtrace_difo_init() is 4-byte aligned.
5747 *flags
|= CPU_DTRACE_BADALIGN
;
5751 *((uint64_t *)(uintptr_t)regs
[rd
]) = regs
[r1
];
5756 if (!(*flags
& CPU_DTRACE_FAULT
))
5759 mstate
->dtms_fltoffs
= opc
* sizeof (dif_instr_t
);
5760 mstate
->dtms_present
|= DTRACE_MSTATE_FLTOFFS
;
5766 dtrace_action_breakpoint(dtrace_ecb_t
*ecb
)
5768 dtrace_probe_t
*probe
= ecb
->dte_probe
;
5769 dtrace_provider_t
*prov
= probe
->dtpr_provider
;
5770 char c
[DTRACE_FULLNAMELEN
+ 80], *str
;
5771 const char *msg
= "dtrace: breakpoint action at probe ";
5772 const char *ecbmsg
= " (ecb ";
5773 uintptr_t mask
= (0xf << (sizeof (uintptr_t) * NBBY
/ 4));
5774 uintptr_t val
= (uintptr_t)ecb
;
5775 int shift
= (sizeof (uintptr_t) * NBBY
) - 4, i
= 0;
5777 if (dtrace_destructive_disallow
)
5781 * It's impossible to be taking action on the NULL probe.
5783 ASSERT(probe
!= NULL
);
5786 * This is a poor man's (destitute man's?) sprintf(): we want to
5787 * print the provider name, module name, function name and name of
5788 * the probe, along with the hex address of the ECB with the breakpoint
5789 * action -- all of which we must place in the character buffer by
5792 while (*msg
!= '\0')
5795 for (str
= prov
->dtpv_name
; *str
!= '\0'; str
++)
5799 for (str
= probe
->dtpr_mod
; *str
!= '\0'; str
++)
5803 for (str
= probe
->dtpr_func
; *str
!= '\0'; str
++)
5807 for (str
= probe
->dtpr_name
; *str
!= '\0'; str
++)
5810 while (*ecbmsg
!= '\0')
5813 while (shift
>= 0) {
5814 mask
= (uintptr_t)0xf << shift
;
5816 if (val
>= ((uintptr_t)1 << shift
))
5817 c
[i
++] = "0123456789abcdef"[(val
& mask
) >> shift
];
5828 dtrace_action_panic(dtrace_ecb_t
*ecb
)
5830 dtrace_probe_t
*probe
= ecb
->dte_probe
;
5833 * It's impossible to be taking action on the NULL probe.
5835 ASSERT(probe
!= NULL
);
5837 if (dtrace_destructive_disallow
)
5840 if (dtrace_panicked
!= NULL
)
5843 if (dtrace_casptr(&dtrace_panicked
, NULL
, current_thread()) != NULL
)
5847 * We won the right to panic. (We want to be sure that only one
5848 * thread calls panic() from dtrace_probe(), and that panic() is
5849 * called exactly once.)
5851 panic("dtrace: panic action at probe %s:%s:%s:%s (ecb %p)",
5852 probe
->dtpr_provider
->dtpv_name
, probe
->dtpr_mod
,
5853 probe
->dtpr_func
, probe
->dtpr_name
, (void *)ecb
);
5856 * APPLE NOTE: this was for an old Mac OS X debug feature
5857 * allowing a return from panic(). Revisit someday.
5859 dtrace_panicked
= NULL
;
5863 dtrace_action_raise(uint64_t sig
)
5865 if (dtrace_destructive_disallow
)
5869 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
5874 * raise() has a queue depth of 1 -- we ignore all subsequent
5875 * invocations of the raise() action.
5878 uthread_t uthread
= (uthread_t
)get_bsdthread_info(current_thread());
5880 if (uthread
&& uthread
->t_dtrace_sig
== 0) {
5881 uthread
->t_dtrace_sig
= sig
;
5882 act_set_astbsd(current_thread());
5887 dtrace_action_stop(void)
5889 if (dtrace_destructive_disallow
)
5892 uthread_t uthread
= (uthread_t
)get_bsdthread_info(current_thread());
5895 * The currently running process will be set to task_suspend
5896 * when it next leaves the kernel.
5898 uthread
->t_dtrace_stop
= 1;
5899 act_set_astbsd(current_thread());
5905 * APPLE NOTE: pidresume works in conjunction with the dtrace stop action.
5906 * Both activate only when the currently running process next leaves the
5910 dtrace_action_pidresume(uint64_t pid
)
5912 if (dtrace_destructive_disallow
)
5915 if (kauth_cred_issuser(kauth_cred_get()) == 0) {
5916 DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP
);
5919 uthread_t uthread
= (uthread_t
)get_bsdthread_info(current_thread());
5922 * When the currently running process leaves the kernel, it attempts to
5923 * task_resume the process (denoted by pid), if that pid appears to have
5924 * been stopped by dtrace_action_stop().
5925 * The currently running process has a pidresume() queue depth of 1 --
5926 * subsequent invocations of the pidresume() action are ignored.
5929 if (pid
!= 0 && uthread
&& uthread
->t_dtrace_resumepid
== 0) {
5930 uthread
->t_dtrace_resumepid
= pid
;
5931 act_set_astbsd(current_thread());
5936 dtrace_action_chill(dtrace_mstate_t
*mstate
, hrtime_t val
)
5939 volatile uint16_t *flags
;
5940 dtrace_cpu_t
*cpu
= CPU
;
5942 if (dtrace_destructive_disallow
)
5945 flags
= (volatile uint16_t *)&cpu_core
[cpu
->cpu_id
].cpuc_dtrace_flags
;
5947 now
= dtrace_gethrtime();
5949 if (now
- cpu
->cpu_dtrace_chillmark
> dtrace_chill_interval
) {
5951 * We need to advance the mark to the current time.
5953 cpu
->cpu_dtrace_chillmark
= now
;
5954 cpu
->cpu_dtrace_chilled
= 0;
5958 * Now check to see if the requested chill time would take us over
5959 * the maximum amount of time allowed in the chill interval. (Or
5960 * worse, if the calculation itself induces overflow.)
5962 if (cpu
->cpu_dtrace_chilled
+ val
> dtrace_chill_max
||
5963 cpu
->cpu_dtrace_chilled
+ val
< cpu
->cpu_dtrace_chilled
) {
5964 *flags
|= CPU_DTRACE_ILLOP
;
5968 while (dtrace_gethrtime() - now
< val
)
5972 * Normally, we assure that the value of the variable "timestamp" does
5973 * not change within an ECB. The presence of chill() represents an
5974 * exception to this rule, however.
5976 mstate
->dtms_present
&= ~DTRACE_MSTATE_TIMESTAMP
;
5977 cpu
->cpu_dtrace_chilled
+= val
;
5981 dtrace_action_ustack(dtrace_mstate_t
*mstate
, dtrace_state_t
*state
,
5982 uint64_t *buf
, uint64_t arg
)
5984 int nframes
= DTRACE_USTACK_NFRAMES(arg
);
5985 int strsize
= DTRACE_USTACK_STRSIZE(arg
);
5986 uint64_t *pcs
= &buf
[1], *fps
;
5987 char *str
= (char *)&pcs
[nframes
];
5988 int size
, offs
= 0, i
, j
;
5989 uintptr_t old
= mstate
->dtms_scratch_ptr
, saved
;
5990 uint16_t *flags
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
5994 * Should be taking a faster path if string space has not been
5997 ASSERT(strsize
!= 0);
6000 * We will first allocate some temporary space for the frame pointers.
6002 fps
= (uint64_t *)P2ROUNDUP(mstate
->dtms_scratch_ptr
, 8);
6003 size
= (uintptr_t)fps
- mstate
->dtms_scratch_ptr
+
6004 (nframes
* sizeof (uint64_t));
6006 if (!DTRACE_INSCRATCH(mstate
, (uintptr_t)size
)) {
6008 * Not enough room for our frame pointers -- need to indicate
6009 * that we ran out of scratch space.
6011 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOSCRATCH
);
6015 mstate
->dtms_scratch_ptr
+= size
;
6016 saved
= mstate
->dtms_scratch_ptr
;
6019 * Now get a stack with both program counters and frame pointers.
6021 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
6022 dtrace_getufpstack(buf
, fps
, nframes
+ 1);
6023 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
6026 * If that faulted, we're cooked.
6028 if (*flags
& CPU_DTRACE_FAULT
)
6032 * Now we want to walk up the stack, calling the USTACK helper. For
6033 * each iteration, we restore the scratch pointer.
6035 for (i
= 0; i
< nframes
; i
++) {
6036 mstate
->dtms_scratch_ptr
= saved
;
6038 if (offs
>= strsize
)
6041 sym
= (char *)(uintptr_t)dtrace_helper(
6042 DTRACE_HELPER_ACTION_USTACK
,
6043 mstate
, state
, pcs
[i
], fps
[i
]);
6046 * If we faulted while running the helper, we're going to
6047 * clear the fault and null out the corresponding string.
6049 if (*flags
& CPU_DTRACE_FAULT
) {
6050 *flags
&= ~CPU_DTRACE_FAULT
;
6060 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
6063 * Now copy in the string that the helper returned to us.
6065 for (j
= 0; offs
+ j
< strsize
; j
++) {
6066 if ((str
[offs
+ j
] = sym
[j
]) == '\0')
6070 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
6075 if (offs
>= strsize
) {
6077 * If we didn't have room for all of the strings, we don't
6078 * abort processing -- this needn't be a fatal error -- but we
6079 * still want to increment a counter (dts_stkstroverflows) to
6080 * allow this condition to be warned about. (If this is from
6081 * a jstack() action, it is easily tuned via jstackstrsize.)
6083 dtrace_error(&state
->dts_stkstroverflows
);
6086 while (offs
< strsize
)
6090 mstate
->dtms_scratch_ptr
= old
;
6094 dtrace_store_by_ref(dtrace_difo_t
*dp
, caddr_t tomax
, size_t size
,
6095 size_t *valoffsp
, uint64_t *valp
, uint64_t end
, int intuple
, int dtkind
)
6097 volatile uint16_t *flags
;
6098 uint64_t val
= *valp
;
6099 size_t valoffs
= *valoffsp
;
6101 flags
= (volatile uint16_t *)&cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
6102 ASSERT(dtkind
== DIF_TF_BYREF
|| dtkind
== DIF_TF_BYUREF
);
6105 * If this is a string, we're going to only load until we find the zero
6106 * byte -- after which we'll store zero bytes.
6108 if (dp
->dtdo_rtype
.dtdt_kind
== DIF_TYPE_STRING
) {
6112 for (s
= 0; s
< size
; s
++) {
6113 if (c
!= '\0' && dtkind
== DIF_TF_BYREF
) {
6114 c
= dtrace_load8(val
++);
6115 } else if (c
!= '\0' && dtkind
== DIF_TF_BYUREF
) {
6116 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
6117 c
= dtrace_fuword8((user_addr_t
)(uintptr_t)val
++);
6118 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
6119 if (*flags
& CPU_DTRACE_FAULT
)
6123 DTRACE_STORE(uint8_t, tomax
, valoffs
++, c
);
6125 if (c
== '\0' && intuple
)
6130 while (valoffs
< end
) {
6131 if (dtkind
== DIF_TF_BYREF
) {
6132 c
= dtrace_load8(val
++);
6133 } else if (dtkind
== DIF_TF_BYUREF
) {
6134 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
6135 c
= dtrace_fuword8((user_addr_t
)(uintptr_t)val
++);
6136 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
6137 if (*flags
& CPU_DTRACE_FAULT
)
6141 DTRACE_STORE(uint8_t, tomax
,
6147 *valoffsp
= valoffs
;
6151 * If you're looking for the epicenter of DTrace, you just found it. This
6152 * is the function called by the provider to fire a probe -- from which all
6153 * subsequent probe-context DTrace activity emanates.
6156 __dtrace_probe(dtrace_id_t id
, uint64_t arg0
, uint64_t arg1
,
6157 uint64_t arg2
, uint64_t arg3
, uint64_t arg4
)
6159 processorid_t cpuid
;
6160 dtrace_icookie_t cookie
;
6161 dtrace_probe_t
*probe
;
6162 dtrace_mstate_t mstate
;
6164 dtrace_action_t
*act
;
6168 volatile uint16_t *flags
;
6171 cookie
= dtrace_interrupt_disable();
6172 probe
= dtrace_probes
[id
- 1];
6173 cpuid
= CPU
->cpu_id
;
6174 onintr
= CPU_ON_INTR(CPU
);
6176 if (!onintr
&& probe
->dtpr_predcache
!= DTRACE_CACHEIDNONE
&&
6177 probe
->dtpr_predcache
== dtrace_get_thread_predcache(current_thread())) {
6179 * We have hit in the predicate cache; we know that
6180 * this predicate would evaluate to be false.
6182 dtrace_interrupt_enable(cookie
);
6186 if (panic_quiesce
) {
6188 * We don't trace anything if we're panicking.
6190 dtrace_interrupt_enable(cookie
);
6194 #if !defined(__APPLE__)
6195 now
= dtrace_gethrtime();
6196 vtime
= dtrace_vtime_references
!= 0;
6198 if (vtime
&& curthread
->t_dtrace_start
)
6199 curthread
->t_dtrace_vtime
+= now
- curthread
->t_dtrace_start
;
6202 * APPLE NOTE: The time spent entering DTrace and arriving
6203 * to this point, is attributed to the current thread.
6204 * Instead it should accrue to DTrace. FIXME
6206 vtime
= dtrace_vtime_references
!= 0;
6210 int64_t dtrace_accum_time
, recent_vtime
;
6211 thread_t thread
= current_thread();
6213 dtrace_accum_time
= dtrace_get_thread_tracing(thread
); /* Time spent inside DTrace so far (nanoseconds) */
6215 if (dtrace_accum_time
>= 0) {
6216 recent_vtime
= dtrace_abs_to_nano(dtrace_calc_thread_recent_vtime(thread
)); /* up to the moment thread vtime */
6218 recent_vtime
= recent_vtime
- dtrace_accum_time
; /* Time without DTrace contribution */
6220 dtrace_set_thread_vtime(thread
, recent_vtime
);
6224 now
= dtrace_gethrtime(); /* must not precede dtrace_calc_thread_recent_vtime() call! */
6225 #endif /* __APPLE__ */
6228 * APPLE NOTE: A provider may call dtrace_probe_error() in lieu of
6229 * dtrace_probe() in some circumstances. See, e.g. fasttrap_isa.c.
6230 * However the provider has no access to ECB context, so passes
6231 * 0 through "arg0" and the probe_id of the overridden probe as arg1.
6232 * Detect that here and cons up a viable state (from the probe_id).
6234 if (dtrace_probeid_error
== id
&& 0 == arg0
) {
6235 dtrace_id_t ftp_id
= (dtrace_id_t
)arg1
;
6236 dtrace_probe_t
*ftp_probe
= dtrace_probes
[ftp_id
- 1];
6237 dtrace_ecb_t
*ftp_ecb
= ftp_probe
->dtpr_ecb
;
6239 if (NULL
!= ftp_ecb
) {
6240 dtrace_state_t
*ftp_state
= ftp_ecb
->dte_state
;
6242 arg0
= (uint64_t)(uintptr_t)ftp_state
;
6243 arg1
= ftp_ecb
->dte_epid
;
6245 * args[2-4] established by caller.
6247 ftp_state
->dts_arg_error_illval
= -1; /* arg5 */
6251 mstate
.dtms_difo
= NULL
;
6252 mstate
.dtms_probe
= probe
;
6253 mstate
.dtms_strtok
= 0;
6254 mstate
.dtms_arg
[0] = arg0
;
6255 mstate
.dtms_arg
[1] = arg1
;
6256 mstate
.dtms_arg
[2] = arg2
;
6257 mstate
.dtms_arg
[3] = arg3
;
6258 mstate
.dtms_arg
[4] = arg4
;
6260 flags
= (volatile uint16_t *)&cpu_core
[cpuid
].cpuc_dtrace_flags
;
6262 for (ecb
= probe
->dtpr_ecb
; ecb
!= NULL
; ecb
= ecb
->dte_next
) {
6263 dtrace_predicate_t
*pred
= ecb
->dte_predicate
;
6264 dtrace_state_t
*state
= ecb
->dte_state
;
6265 dtrace_buffer_t
*buf
= &state
->dts_buffer
[cpuid
];
6266 dtrace_buffer_t
*aggbuf
= &state
->dts_aggbuffer
[cpuid
];
6267 dtrace_vstate_t
*vstate
= &state
->dts_vstate
;
6268 dtrace_provider_t
*prov
= probe
->dtpr_provider
;
6269 uint64_t tracememsize
= 0;
6274 * A little subtlety with the following (seemingly innocuous)
6275 * declaration of the automatic 'val': by looking at the
6276 * code, you might think that it could be declared in the
6277 * action processing loop, below. (That is, it's only used in
6278 * the action processing loop.) However, it must be declared
6279 * out of that scope because in the case of DIF expression
6280 * arguments to aggregating actions, one iteration of the
6281 * action loop will use the last iteration's value.
6289 mstate
.dtms_present
= DTRACE_MSTATE_ARGS
| DTRACE_MSTATE_PROBE
;
6290 *flags
&= ~CPU_DTRACE_ERROR
;
6292 if (prov
== dtrace_provider
) {
6294 * If dtrace itself is the provider of this probe,
6295 * we're only going to continue processing the ECB if
6296 * arg0 (the dtrace_state_t) is equal to the ECB's
6297 * creating state. (This prevents disjoint consumers
6298 * from seeing one another's metaprobes.)
6300 if (arg0
!= (uint64_t)(uintptr_t)state
)
6304 if (state
->dts_activity
!= DTRACE_ACTIVITY_ACTIVE
) {
6306 * We're not currently active. If our provider isn't
6307 * the dtrace pseudo provider, we're not interested.
6309 if (prov
!= dtrace_provider
)
6313 * Now we must further check if we are in the BEGIN
6314 * probe. If we are, we will only continue processing
6315 * if we're still in WARMUP -- if one BEGIN enabling
6316 * has invoked the exit() action, we don't want to
6317 * evaluate subsequent BEGIN enablings.
6319 if (probe
->dtpr_id
== dtrace_probeid_begin
&&
6320 state
->dts_activity
!= DTRACE_ACTIVITY_WARMUP
) {
6321 ASSERT(state
->dts_activity
==
6322 DTRACE_ACTIVITY_DRAINING
);
6327 if (ecb
->dte_cond
) {
6329 * If the dte_cond bits indicate that this
6330 * consumer is only allowed to see user-mode firings
6331 * of this probe, call the provider's dtps_usermode()
6332 * entry point to check that the probe was fired
6333 * while in a user context. Skip this ECB if that's
6336 if ((ecb
->dte_cond
& DTRACE_COND_USERMODE
) &&
6337 prov
->dtpv_pops
.dtps_usermode
&&
6338 prov
->dtpv_pops
.dtps_usermode(prov
->dtpv_arg
,
6339 probe
->dtpr_id
, probe
->dtpr_arg
) == 0)
6343 * This is more subtle than it looks. We have to be
6344 * absolutely certain that CRED() isn't going to
6345 * change out from under us so it's only legit to
6346 * examine that structure if we're in constrained
6347 * situations. Currently, the only times we'll this
6348 * check is if a non-super-user has enabled the
6349 * profile or syscall providers -- providers that
6350 * allow visibility of all processes. For the
6351 * profile case, the check above will ensure that
6352 * we're examining a user context.
6354 if (ecb
->dte_cond
& DTRACE_COND_OWNER
) {
6357 ecb
->dte_state
->dts_cred
.dcr_cred
;
6359 #pragma unused(proc) /* __APPLE__ */
6361 ASSERT(s_cr
!= NULL
);
6364 * XXX this is hackish, but so is setting a variable
6365 * XXX in a McCarthy OR...
6367 if ((cr
= dtrace_CRED()) == NULL
||
6368 posix_cred_get(s_cr
)->cr_uid
!= posix_cred_get(cr
)->cr_uid
||
6369 posix_cred_get(s_cr
)->cr_uid
!= posix_cred_get(cr
)->cr_ruid
||
6370 posix_cred_get(s_cr
)->cr_uid
!= posix_cred_get(cr
)->cr_suid
||
6371 posix_cred_get(s_cr
)->cr_gid
!= posix_cred_get(cr
)->cr_gid
||
6372 posix_cred_get(s_cr
)->cr_gid
!= posix_cred_get(cr
)->cr_rgid
||
6373 posix_cred_get(s_cr
)->cr_gid
!= posix_cred_get(cr
)->cr_sgid
||
6374 #if !defined(__APPLE__)
6375 (proc
= ttoproc(curthread
)) == NULL
||
6376 (proc
->p_flag
& SNOCD
))
6378 1) /* APPLE NOTE: Darwin omits "No Core Dump" flag */
6379 #endif /* __APPLE__ */
6383 if (ecb
->dte_cond
& DTRACE_COND_ZONEOWNER
) {
6386 ecb
->dte_state
->dts_cred
.dcr_cred
;
6387 #pragma unused(cr, s_cr) /* __APPLE__ */
6389 ASSERT(s_cr
!= NULL
);
6391 #if !defined(__APPLE__)
6392 if ((cr
= CRED()) == NULL
||
6393 s_cr
->cr_zone
->zone_id
!=
6394 cr
->cr_zone
->zone_id
)
6397 /* APPLE NOTE: Darwin doesn't do zones. */
6398 #endif /* __APPLE__ */
6402 if (now
- state
->dts_alive
> dtrace_deadman_timeout
) {
6404 * We seem to be dead. Unless we (a) have kernel
6405 * destructive permissions (b) have expicitly enabled
6406 * destructive actions and (c) destructive actions have
6407 * not been disabled, we're going to transition into
6408 * the KILLED state, from which no further processing
6409 * on this state will be performed.
6411 if (!dtrace_priv_kernel_destructive(state
) ||
6412 !state
->dts_cred
.dcr_destructive
||
6413 dtrace_destructive_disallow
) {
6414 void *activity
= &state
->dts_activity
;
6415 dtrace_activity_t current
;
6418 current
= state
->dts_activity
;
6419 } while (dtrace_cas32(activity
, current
,
6420 DTRACE_ACTIVITY_KILLED
) != current
);
6426 if ((offs
= dtrace_buffer_reserve(buf
, ecb
->dte_needed
,
6427 ecb
->dte_alignment
, state
, &mstate
)) < 0)
6430 tomax
= buf
->dtb_tomax
;
6431 ASSERT(tomax
!= NULL
);
6434 * Build and store the record header corresponding to the ECB.
6436 if (ecb
->dte_size
!= 0) {
6437 dtrace_rechdr_t dtrh
;
6439 if (!(mstate
.dtms_present
& DTRACE_MSTATE_TIMESTAMP
)) {
6440 mstate
.dtms_timestamp
= dtrace_gethrtime();
6441 mstate
.dtms_present
|= DTRACE_MSTATE_TIMESTAMP
;
6444 ASSERT(ecb
->dte_size
>= sizeof(dtrace_rechdr_t
));
6446 dtrh
.dtrh_epid
= ecb
->dte_epid
;
6447 DTRACE_RECORD_STORE_TIMESTAMP(&dtrh
, mstate
.dtms_timestamp
);
6448 DTRACE_STORE(dtrace_rechdr_t
, tomax
, offs
, dtrh
);
6451 mstate
.dtms_epid
= ecb
->dte_epid
;
6452 mstate
.dtms_present
|= DTRACE_MSTATE_EPID
;
6454 if (state
->dts_cred
.dcr_visible
& DTRACE_CRV_KERNEL
)
6455 mstate
.dtms_access
= DTRACE_ACCESS_KERNEL
;
6457 mstate
.dtms_access
= 0;
6460 dtrace_difo_t
*dp
= pred
->dtp_difo
;
6463 rval
= dtrace_dif_emulate(dp
, &mstate
, vstate
, state
);
6465 if (!(*flags
& CPU_DTRACE_ERROR
) && !rval
) {
6466 dtrace_cacheid_t cid
= probe
->dtpr_predcache
;
6468 if (cid
!= DTRACE_CACHEIDNONE
&& !onintr
) {
6470 * Update the predicate cache...
6472 ASSERT(cid
== pred
->dtp_cacheid
);
6474 dtrace_set_thread_predcache(current_thread(), cid
);
6481 for (act
= ecb
->dte_action
; !(*flags
& CPU_DTRACE_ERROR
) &&
6482 act
!= NULL
; act
= act
->dta_next
) {
6485 dtrace_recdesc_t
*rec
= &act
->dta_rec
;
6487 size
= rec
->dtrd_size
;
6488 valoffs
= offs
+ rec
->dtrd_offset
;
6490 if (DTRACEACT_ISAGG(act
->dta_kind
)) {
6492 dtrace_aggregation_t
*agg
;
6494 agg
= (dtrace_aggregation_t
*)act
;
6496 if ((dp
= act
->dta_difo
) != NULL
)
6497 v
= dtrace_dif_emulate(dp
,
6498 &mstate
, vstate
, state
);
6500 if (*flags
& CPU_DTRACE_ERROR
)
6504 * Note that we always pass the expression
6505 * value from the previous iteration of the
6506 * action loop. This value will only be used
6507 * if there is an expression argument to the
6508 * aggregating action, denoted by the
6509 * dtag_hasarg field.
6511 dtrace_aggregate(agg
, buf
,
6512 offs
, aggbuf
, v
, val
);
6516 switch (act
->dta_kind
) {
6517 case DTRACEACT_STOP
:
6518 if (dtrace_priv_proc_destructive(state
))
6519 dtrace_action_stop();
6522 case DTRACEACT_BREAKPOINT
:
6523 if (dtrace_priv_kernel_destructive(state
))
6524 dtrace_action_breakpoint(ecb
);
6527 case DTRACEACT_PANIC
:
6528 if (dtrace_priv_kernel_destructive(state
))
6529 dtrace_action_panic(ecb
);
6532 case DTRACEACT_STACK
:
6533 if (!dtrace_priv_kernel(state
))
6536 dtrace_getpcstack((pc_t
*)(tomax
+ valoffs
),
6537 size
/ sizeof (pc_t
), probe
->dtpr_aframes
,
6538 DTRACE_ANCHORED(probe
) ? NULL
:
6539 (uint32_t *)(uintptr_t)arg0
);
6542 case DTRACEACT_JSTACK
:
6543 case DTRACEACT_USTACK
:
6544 if (!dtrace_priv_proc(state
))
6548 * See comment in DIF_VAR_PID.
6550 if (DTRACE_ANCHORED(mstate
.dtms_probe
) &&
6552 int depth
= DTRACE_USTACK_NFRAMES(
6555 dtrace_bzero((void *)(tomax
+ valoffs
),
6556 DTRACE_USTACK_STRSIZE(rec
->dtrd_arg
)
6557 + depth
* sizeof (uint64_t));
6562 if (DTRACE_USTACK_STRSIZE(rec
->dtrd_arg
) != 0 &&
6563 curproc
->p_dtrace_helpers
!= NULL
) {
6565 * This is the slow path -- we have
6566 * allocated string space, and we're
6567 * getting the stack of a process that
6568 * has helpers. Call into a separate
6569 * routine to perform this processing.
6571 dtrace_action_ustack(&mstate
, state
,
6572 (uint64_t *)(tomax
+ valoffs
),
6577 DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT
);
6578 dtrace_getupcstack((uint64_t *)
6580 DTRACE_USTACK_NFRAMES(rec
->dtrd_arg
) + 1);
6581 DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT
);
6591 val
= dtrace_dif_emulate(dp
, &mstate
, vstate
, state
);
6593 if (*flags
& CPU_DTRACE_ERROR
)
6596 switch (act
->dta_kind
) {
6597 case DTRACEACT_SPECULATE
: {
6598 dtrace_rechdr_t
*dtrh
= NULL
;
6600 ASSERT(buf
== &state
->dts_buffer
[cpuid
]);
6601 buf
= dtrace_speculation_buffer(state
,
6605 *flags
|= CPU_DTRACE_DROP
;
6609 offs
= dtrace_buffer_reserve(buf
,
6610 ecb
->dte_needed
, ecb
->dte_alignment
,
6614 *flags
|= CPU_DTRACE_DROP
;
6618 tomax
= buf
->dtb_tomax
;
6619 ASSERT(tomax
!= NULL
);
6621 if (ecb
->dte_size
== 0)
6624 ASSERT(ecb
->dte_size
>= sizeof(dtrace_rechdr_t
));
6625 dtrh
= ((void *)(tomax
+ offs
));
6626 dtrh
->dtrh_epid
= ecb
->dte_epid
;
6629 * When the speculation is committed, all of
6630 * the records in the speculative buffer will
6631 * have their timestamps set to the commit
6632 * time. Until then, it is set to a sentinel
6633 * value, for debugability.
6635 DTRACE_RECORD_STORE_TIMESTAMP(dtrh
, UINT64_MAX
);
6640 case DTRACEACT_CHILL
:
6641 if (dtrace_priv_kernel_destructive(state
))
6642 dtrace_action_chill(&mstate
, val
);
6645 case DTRACEACT_RAISE
:
6646 if (dtrace_priv_proc_destructive(state
))
6647 dtrace_action_raise(val
);
6650 case DTRACEACT_PIDRESUME
: /* __APPLE__ */
6651 if (dtrace_priv_proc_destructive(state
))
6652 dtrace_action_pidresume(val
);
6655 case DTRACEACT_COMMIT
:
6659 * We need to commit our buffer state.
6662 buf
->dtb_offset
= offs
+ ecb
->dte_size
;
6663 buf
= &state
->dts_buffer
[cpuid
];
6664 dtrace_speculation_commit(state
, cpuid
, val
);
6668 case DTRACEACT_DISCARD
:
6669 dtrace_speculation_discard(state
, cpuid
, val
);
6672 case DTRACEACT_DIFEXPR
:
6673 case DTRACEACT_LIBACT
:
6674 case DTRACEACT_PRINTF
:
6675 case DTRACEACT_PRINTA
:
6676 case DTRACEACT_SYSTEM
:
6677 case DTRACEACT_FREOPEN
:
6678 case DTRACEACT_APPLEBINARY
: /* __APPLE__ */
6679 case DTRACEACT_TRACEMEM
:
6682 case DTRACEACT_TRACEMEM_DYNSIZE
:
6688 if (!dtrace_priv_kernel(state
))
6692 case DTRACEACT_USYM
:
6693 case DTRACEACT_UMOD
:
6694 case DTRACEACT_UADDR
: {
6695 if (!dtrace_priv_proc(state
))
6698 DTRACE_STORE(uint64_t, tomax
,
6699 valoffs
, (uint64_t)dtrace_proc_selfpid());
6700 DTRACE_STORE(uint64_t, tomax
,
6701 valoffs
+ sizeof (uint64_t), val
);
6706 case DTRACEACT_EXIT
: {
6708 * For the exit action, we are going to attempt
6709 * to atomically set our activity to be
6710 * draining. If this fails (either because
6711 * another CPU has beat us to the exit action,
6712 * or because our current activity is something
6713 * other than ACTIVE or WARMUP), we will
6714 * continue. This assures that the exit action
6715 * can be successfully recorded at most once
6716 * when we're in the ACTIVE state. If we're
6717 * encountering the exit() action while in
6718 * COOLDOWN, however, we want to honor the new
6719 * status code. (We know that we're the only
6720 * thread in COOLDOWN, so there is no race.)
6722 void *activity
= &state
->dts_activity
;
6723 dtrace_activity_t current
= state
->dts_activity
;
6725 if (current
== DTRACE_ACTIVITY_COOLDOWN
)
6728 if (current
!= DTRACE_ACTIVITY_WARMUP
)
6729 current
= DTRACE_ACTIVITY_ACTIVE
;
6731 if (dtrace_cas32(activity
, current
,
6732 DTRACE_ACTIVITY_DRAINING
) != current
) {
6733 *flags
|= CPU_DTRACE_DROP
;
6744 if (dp
->dtdo_rtype
.dtdt_flags
& (DIF_TF_BYREF
| DIF_TF_BYUREF
)) {
6745 uintptr_t end
= valoffs
+ size
;
6747 if (tracememsize
!= 0 &&
6748 valoffs
+ tracememsize
< end
)
6750 end
= valoffs
+ tracememsize
;
6754 if (dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
&&
6755 !dtrace_vcanload((void *)(uintptr_t)val
,
6756 &dp
->dtdo_rtype
, NULL
, &mstate
, vstate
))
6761 dtrace_store_by_ref(dp
, tomax
, size
, &valoffs
,
6762 &val
, end
, act
->dta_intuple
,
6763 dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
?
6764 DIF_TF_BYREF
: DIF_TF_BYUREF
);
6773 case sizeof (uint8_t):
6774 DTRACE_STORE(uint8_t, tomax
, valoffs
, val
);
6776 case sizeof (uint16_t):
6777 DTRACE_STORE(uint16_t, tomax
, valoffs
, val
);
6779 case sizeof (uint32_t):
6780 DTRACE_STORE(uint32_t, tomax
, valoffs
, val
);
6782 case sizeof (uint64_t):
6783 DTRACE_STORE(uint64_t, tomax
, valoffs
, val
);
6787 * Any other size should have been returned by
6788 * reference, not by value.
6795 if (*flags
& CPU_DTRACE_DROP
)
6798 if (*flags
& CPU_DTRACE_FAULT
) {
6800 dtrace_action_t
*err
;
6804 if (probe
->dtpr_id
== dtrace_probeid_error
) {
6806 * There's nothing we can do -- we had an
6807 * error on the error probe. We bump an
6808 * error counter to at least indicate that
6809 * this condition happened.
6811 dtrace_error(&state
->dts_dblerrors
);
6817 * Before recursing on dtrace_probe(), we
6818 * need to explicitly clear out our start
6819 * time to prevent it from being accumulated
6820 * into t_dtrace_vtime.
6824 * Darwin sets the sign bit on t_dtrace_tracing
6825 * to suspend accumulation to it.
6827 dtrace_set_thread_tracing(current_thread(),
6828 (1ULL<<63) | dtrace_get_thread_tracing(current_thread()));
6833 * Iterate over the actions to figure out which action
6834 * we were processing when we experienced the error.
6835 * Note that act points _past_ the faulting action; if
6836 * act is ecb->dte_action, the fault was in the
6837 * predicate, if it's ecb->dte_action->dta_next it's
6838 * in action #1, and so on.
6840 for (err
= ecb
->dte_action
, ndx
= 0;
6841 err
!= act
; err
= err
->dta_next
, ndx
++)
6844 dtrace_probe_error(state
, ecb
->dte_epid
, ndx
,
6845 (mstate
.dtms_present
& DTRACE_MSTATE_FLTOFFS
) ?
6846 mstate
.dtms_fltoffs
: -1, DTRACE_FLAGS2FLT(*flags
),
6847 cpu_core
[cpuid
].cpuc_dtrace_illval
);
6853 buf
->dtb_offset
= offs
+ ecb
->dte_size
;
6856 /* FIXME: On Darwin the time spent leaving DTrace from this point to the rti is attributed
6857 to the current thread. Instead it should accrue to DTrace. */
6859 thread_t thread
= current_thread();
6860 int64_t t
= dtrace_get_thread_tracing(thread
);
6863 /* Usual case, accumulate time spent here into t_dtrace_tracing */
6864 dtrace_set_thread_tracing(thread
, t
+ (dtrace_gethrtime() - now
));
6866 /* Return from error recursion. No accumulation, just clear the sign bit on t_dtrace_tracing. */
6867 dtrace_set_thread_tracing(thread
, (~(1ULL<<63)) & t
);
6871 dtrace_interrupt_enable(cookie
);
6875 * APPLE NOTE: Don't allow a thread to re-enter dtrace_probe().
6876 * This could occur if a probe is encountered on some function in the
6877 * transitive closure of the call to dtrace_probe().
6878 * Solaris has some strong guarantees that this won't happen.
6879 * The Darwin implementation is not so mature as to make those guarantees.
6880 * Hence, the introduction of __dtrace_probe() on xnu.
6884 dtrace_probe(dtrace_id_t id
, uint64_t arg0
, uint64_t arg1
,
6885 uint64_t arg2
, uint64_t arg3
, uint64_t arg4
)
6887 thread_t thread
= current_thread();
6888 disable_preemption();
6889 if (id
== dtrace_probeid_error
) {
6890 __dtrace_probe(id
, arg0
, arg1
, arg2
, arg3
, arg4
);
6891 dtrace_getipl(); /* Defeat tail-call optimization of __dtrace_probe() */
6892 } else if (!dtrace_get_thread_reentering(thread
)) {
6893 dtrace_set_thread_reentering(thread
, TRUE
);
6894 __dtrace_probe(id
, arg0
, arg1
, arg2
, arg3
, arg4
);
6895 dtrace_set_thread_reentering(thread
, FALSE
);
6898 else __dtrace_probe(dtrace_probeid_error
, 0, id
, 1, -1, DTRACEFLT_UNKNOWN
);
6900 enable_preemption();
6904 * DTrace Probe Hashing Functions
6906 * The functions in this section (and indeed, the functions in remaining
6907 * sections) are not _called_ from probe context. (Any exceptions to this are
6908 * marked with a "Note:".) Rather, they are called from elsewhere in the
6909 * DTrace framework to look-up probes in, add probes to and remove probes from
6910 * the DTrace probe hashes. (Each probe is hashed by each element of the
6911 * probe tuple -- allowing for fast lookups, regardless of what was
6915 dtrace_hash_str(const char *p
)
6921 hval
= (hval
<< 4) + *p
++;
6922 if ((g
= (hval
& 0xf0000000)) != 0)
6929 static dtrace_hash_t
*
6930 dtrace_hash_create(uintptr_t stroffs
, uintptr_t nextoffs
, uintptr_t prevoffs
)
6932 dtrace_hash_t
*hash
= kmem_zalloc(sizeof (dtrace_hash_t
), KM_SLEEP
);
6934 hash
->dth_stroffs
= stroffs
;
6935 hash
->dth_nextoffs
= nextoffs
;
6936 hash
->dth_prevoffs
= prevoffs
;
6939 hash
->dth_mask
= hash
->dth_size
- 1;
6941 hash
->dth_tab
= kmem_zalloc(hash
->dth_size
*
6942 sizeof (dtrace_hashbucket_t
*), KM_SLEEP
);
6948 * APPLE NOTE: dtrace_hash_destroy is not used.
6949 * It is called by dtrace_detach which is not
6950 * currently implemented. Revisit someday.
6952 #if !defined(__APPLE__)
6954 dtrace_hash_destroy(dtrace_hash_t
*hash
)
6959 for (i
= 0; i
< hash
->dth_size
; i
++)
6960 ASSERT(hash
->dth_tab
[i
] == NULL
);
6963 kmem_free(hash
->dth_tab
,
6964 hash
->dth_size
* sizeof (dtrace_hashbucket_t
*));
6965 kmem_free(hash
, sizeof (dtrace_hash_t
));
6967 #endif /* __APPLE__ */
6970 dtrace_hash_resize(dtrace_hash_t
*hash
)
6972 int size
= hash
->dth_size
, i
, ndx
;
6973 int new_size
= hash
->dth_size
<< 1;
6974 int new_mask
= new_size
- 1;
6975 dtrace_hashbucket_t
**new_tab
, *bucket
, *next
;
6977 ASSERT((new_size
& new_mask
) == 0);
6979 new_tab
= kmem_zalloc(new_size
* sizeof (void *), KM_SLEEP
);
6981 for (i
= 0; i
< size
; i
++) {
6982 for (bucket
= hash
->dth_tab
[i
]; bucket
!= NULL
; bucket
= next
) {
6983 dtrace_probe_t
*probe
= bucket
->dthb_chain
;
6985 ASSERT(probe
!= NULL
);
6986 ndx
= DTRACE_HASHSTR(hash
, probe
) & new_mask
;
6988 next
= bucket
->dthb_next
;
6989 bucket
->dthb_next
= new_tab
[ndx
];
6990 new_tab
[ndx
] = bucket
;
6994 kmem_free(hash
->dth_tab
, hash
->dth_size
* sizeof (void *));
6995 hash
->dth_tab
= new_tab
;
6996 hash
->dth_size
= new_size
;
6997 hash
->dth_mask
= new_mask
;
7001 dtrace_hash_add(dtrace_hash_t
*hash
, dtrace_probe_t
*new)
7003 int hashval
= DTRACE_HASHSTR(hash
, new);
7004 int ndx
= hashval
& hash
->dth_mask
;
7005 dtrace_hashbucket_t
*bucket
= hash
->dth_tab
[ndx
];
7006 dtrace_probe_t
**nextp
, **prevp
;
7008 for (; bucket
!= NULL
; bucket
= bucket
->dthb_next
) {
7009 if (DTRACE_HASHEQ(hash
, bucket
->dthb_chain
, new))
7013 if ((hash
->dth_nbuckets
>> 1) > hash
->dth_size
) {
7014 dtrace_hash_resize(hash
);
7015 dtrace_hash_add(hash
, new);
7019 bucket
= kmem_zalloc(sizeof (dtrace_hashbucket_t
), KM_SLEEP
);
7020 bucket
->dthb_next
= hash
->dth_tab
[ndx
];
7021 hash
->dth_tab
[ndx
] = bucket
;
7022 hash
->dth_nbuckets
++;
7025 nextp
= DTRACE_HASHNEXT(hash
, new);
7026 ASSERT(*nextp
== NULL
&& *(DTRACE_HASHPREV(hash
, new)) == NULL
);
7027 *nextp
= bucket
->dthb_chain
;
7029 if (bucket
->dthb_chain
!= NULL
) {
7030 prevp
= DTRACE_HASHPREV(hash
, bucket
->dthb_chain
);
7031 ASSERT(*prevp
== NULL
);
7035 bucket
->dthb_chain
= new;
7039 static dtrace_probe_t
*
7040 dtrace_hash_lookup(dtrace_hash_t
*hash
, dtrace_probe_t
*template)
7042 int hashval
= DTRACE_HASHSTR(hash
, template);
7043 int ndx
= hashval
& hash
->dth_mask
;
7044 dtrace_hashbucket_t
*bucket
= hash
->dth_tab
[ndx
];
7046 for (; bucket
!= NULL
; bucket
= bucket
->dthb_next
) {
7047 if (DTRACE_HASHEQ(hash
, bucket
->dthb_chain
, template))
7048 return (bucket
->dthb_chain
);
7055 dtrace_hash_collisions(dtrace_hash_t
*hash
, dtrace_probe_t
*template)
7057 int hashval
= DTRACE_HASHSTR(hash
, template);
7058 int ndx
= hashval
& hash
->dth_mask
;
7059 dtrace_hashbucket_t
*bucket
= hash
->dth_tab
[ndx
];
7061 for (; bucket
!= NULL
; bucket
= bucket
->dthb_next
) {
7062 if (DTRACE_HASHEQ(hash
, bucket
->dthb_chain
, template))
7063 return (bucket
->dthb_len
);
7070 dtrace_hash_remove(dtrace_hash_t
*hash
, dtrace_probe_t
*probe
)
7072 int ndx
= DTRACE_HASHSTR(hash
, probe
) & hash
->dth_mask
;
7073 dtrace_hashbucket_t
*bucket
= hash
->dth_tab
[ndx
];
7075 dtrace_probe_t
**prevp
= DTRACE_HASHPREV(hash
, probe
);
7076 dtrace_probe_t
**nextp
= DTRACE_HASHNEXT(hash
, probe
);
7079 * Find the bucket that we're removing this probe from.
7081 for (; bucket
!= NULL
; bucket
= bucket
->dthb_next
) {
7082 if (DTRACE_HASHEQ(hash
, bucket
->dthb_chain
, probe
))
7086 ASSERT(bucket
!= NULL
);
7088 if (*prevp
== NULL
) {
7089 if (*nextp
== NULL
) {
7091 * The removed probe was the only probe on this
7092 * bucket; we need to remove the bucket.
7094 dtrace_hashbucket_t
*b
= hash
->dth_tab
[ndx
];
7096 ASSERT(bucket
->dthb_chain
== probe
);
7100 hash
->dth_tab
[ndx
] = bucket
->dthb_next
;
7102 while (b
->dthb_next
!= bucket
)
7104 b
->dthb_next
= bucket
->dthb_next
;
7107 ASSERT(hash
->dth_nbuckets
> 0);
7108 hash
->dth_nbuckets
--;
7109 kmem_free(bucket
, sizeof (dtrace_hashbucket_t
));
7113 bucket
->dthb_chain
= *nextp
;
7115 *(DTRACE_HASHNEXT(hash
, *prevp
)) = *nextp
;
7119 *(DTRACE_HASHPREV(hash
, *nextp
)) = *prevp
;
7123 * DTrace Utility Functions
7125 * These are random utility functions that are _not_ called from probe context.
7128 dtrace_badattr(const dtrace_attribute_t
*a
)
7130 return (a
->dtat_name
> DTRACE_STABILITY_MAX
||
7131 a
->dtat_data
> DTRACE_STABILITY_MAX
||
7132 a
->dtat_class
> DTRACE_CLASS_MAX
);
7136 * Return a duplicate copy of a string. If the specified string is NULL,
7137 * this function returns a zero-length string.
7138 * APPLE NOTE: Darwin employs size bounded string operation.
7141 dtrace_strdup(const char *str
)
7143 size_t bufsize
= (str
!= NULL
? strlen(str
) : 0) + 1;
7144 char *new = kmem_zalloc(bufsize
, KM_SLEEP
);
7147 (void) strlcpy(new, str
, bufsize
);
7152 #define DTRACE_ISALPHA(c) \
7153 (((c) >= 'a' && (c) <= 'z') || ((c) >= 'A' && (c) <= 'Z'))
7156 dtrace_badname(const char *s
)
7160 if (s
== NULL
|| (c
= *s
++) == '\0')
7163 if (!DTRACE_ISALPHA(c
) && c
!= '-' && c
!= '_' && c
!= '.')
7166 while ((c
= *s
++) != '\0') {
7167 if (!DTRACE_ISALPHA(c
) && (c
< '0' || c
> '9') &&
7168 c
!= '-' && c
!= '_' && c
!= '.' && c
!= '`')
7176 dtrace_cred2priv(cred_t
*cr
, uint32_t *privp
, uid_t
*uidp
, zoneid_t
*zoneidp
)
7180 if (cr
== NULL
|| PRIV_POLICY_ONLY(cr
, PRIV_ALL
, B_FALSE
)) {
7181 if (dtrace_is_restricted() && !dtrace_are_restrictions_relaxed()) {
7182 priv
= DTRACE_PRIV_USER
| DTRACE_PRIV_PROC
;
7185 priv
= DTRACE_PRIV_ALL
;
7188 *uidp
= crgetuid(cr
);
7189 *zoneidp
= crgetzoneid(cr
);
7192 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_KERNEL
, B_FALSE
))
7193 priv
|= DTRACE_PRIV_KERNEL
| DTRACE_PRIV_USER
;
7194 else if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_USER
, B_FALSE
))
7195 priv
|= DTRACE_PRIV_USER
;
7196 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_PROC
, B_FALSE
))
7197 priv
|= DTRACE_PRIV_PROC
;
7198 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_OWNER
, B_FALSE
))
7199 priv
|= DTRACE_PRIV_OWNER
;
7200 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_ZONE
, B_FALSE
))
7201 priv
|= DTRACE_PRIV_ZONEOWNER
;
7207 #ifdef DTRACE_ERRDEBUG
7209 dtrace_errdebug(const char *str
)
7211 int hval
= dtrace_hash_str(str
) % DTRACE_ERRHASHSZ
;
7214 lck_mtx_lock(&dtrace_errlock
);
7215 dtrace_errlast
= str
;
7216 dtrace_errthread
= (kthread_t
*)current_thread();
7218 while (occupied
++ < DTRACE_ERRHASHSZ
) {
7219 if (dtrace_errhash
[hval
].dter_msg
== str
) {
7220 dtrace_errhash
[hval
].dter_count
++;
7224 if (dtrace_errhash
[hval
].dter_msg
!= NULL
) {
7225 hval
= (hval
+ 1) % DTRACE_ERRHASHSZ
;
7229 dtrace_errhash
[hval
].dter_msg
= str
;
7230 dtrace_errhash
[hval
].dter_count
= 1;
7234 panic("dtrace: undersized error hash");
7236 lck_mtx_unlock(&dtrace_errlock
);
7241 * DTrace Matching Functions
7243 * These functions are used to match groups of probes, given some elements of
7244 * a probe tuple, or some globbed expressions for elements of a probe tuple.
7247 dtrace_match_priv(const dtrace_probe_t
*prp
, uint32_t priv
, uid_t uid
,
7250 if (priv
!= DTRACE_PRIV_ALL
) {
7251 uint32_t ppriv
= prp
->dtpr_provider
->dtpv_priv
.dtpp_flags
;
7252 uint32_t match
= priv
& ppriv
;
7255 * No PRIV_DTRACE_* privileges...
7257 if ((priv
& (DTRACE_PRIV_PROC
| DTRACE_PRIV_USER
|
7258 DTRACE_PRIV_KERNEL
)) == 0)
7262 * No matching bits, but there were bits to match...
7264 if (match
== 0 && ppriv
!= 0)
7268 * Need to have permissions to the process, but don't...
7270 if (((ppriv
& ~match
) & DTRACE_PRIV_OWNER
) != 0 &&
7271 uid
!= prp
->dtpr_provider
->dtpv_priv
.dtpp_uid
) {
7276 * Need to be in the same zone unless we possess the
7277 * privilege to examine all zones.
7279 if (((ppriv
& ~match
) & DTRACE_PRIV_ZONEOWNER
) != 0 &&
7280 zoneid
!= prp
->dtpr_provider
->dtpv_priv
.dtpp_zoneid
) {
7289 * dtrace_match_probe compares a dtrace_probe_t to a pre-compiled key, which
7290 * consists of input pattern strings and an ops-vector to evaluate them.
7291 * This function returns >0 for match, 0 for no match, and <0 for error.
7294 dtrace_match_probe(const dtrace_probe_t
*prp
, const dtrace_probekey_t
*pkp
,
7295 uint32_t priv
, uid_t uid
, zoneid_t zoneid
)
7297 dtrace_provider_t
*pvp
= prp
->dtpr_provider
;
7300 if (pvp
->dtpv_defunct
)
7303 if ((rv
= pkp
->dtpk_pmatch(pvp
->dtpv_name
, pkp
->dtpk_prov
, 0)) <= 0)
7306 if ((rv
= pkp
->dtpk_mmatch(prp
->dtpr_mod
, pkp
->dtpk_mod
, 0)) <= 0)
7309 if ((rv
= pkp
->dtpk_fmatch(prp
->dtpr_func
, pkp
->dtpk_func
, 0)) <= 0)
7312 if ((rv
= pkp
->dtpk_nmatch(prp
->dtpr_name
, pkp
->dtpk_name
, 0)) <= 0)
7315 if (dtrace_match_priv(prp
, priv
, uid
, zoneid
) == 0)
7322 * dtrace_match_glob() is a safe kernel implementation of the gmatch(3GEN)
7323 * interface for matching a glob pattern 'p' to an input string 's'. Unlike
7324 * libc's version, the kernel version only applies to 8-bit ASCII strings.
7325 * In addition, all of the recursion cases except for '*' matching have been
7326 * unwound. For '*', we still implement recursive evaluation, but a depth
7327 * counter is maintained and matching is aborted if we recurse too deep.
7328 * The function returns 0 if no match, >0 if match, and <0 if recursion error.
7331 dtrace_match_glob(const char *s
, const char *p
, int depth
)
7337 if (depth
> DTRACE_PROBEKEY_MAXDEPTH
)
7341 s
= ""; /* treat NULL as empty string */
7350 if ((c
= *p
++) == '\0')
7351 return (s1
== '\0');
7355 int ok
= 0, notflag
= 0;
7366 if ((c
= *p
++) == '\0')
7370 if (c
== '-' && lc
!= '\0' && *p
!= ']') {
7371 if ((c
= *p
++) == '\0')
7373 if (c
== '\\' && (c
= *p
++) == '\0')
7377 if (s1
< lc
|| s1
> c
)
7381 } else if (lc
<= s1
&& s1
<= c
)
7384 } else if (c
== '\\' && (c
= *p
++) == '\0')
7387 lc
= c
; /* save left-hand 'c' for next iteration */
7397 if ((c
= *p
++) == '\0')
7409 if ((c
= *p
++) == '\0')
7425 p
++; /* consecutive *'s are identical to a single one */
7430 for (s
= olds
; *s
!= '\0'; s
++) {
7431 if ((gs
= dtrace_match_glob(s
, p
, depth
+ 1)) != 0)
7441 dtrace_match_string(const char *s
, const char *p
, int depth
)
7443 #pragma unused(depth) /* __APPLE__ */
7445 /* APPLE NOTE: Darwin employs size bounded string operation. */
7446 return (s
!= NULL
&& strncmp(s
, p
, strlen(s
) + 1) == 0);
7451 dtrace_match_nul(const char *s
, const char *p
, int depth
)
7453 #pragma unused(s, p, depth) /* __APPLE__ */
7454 return (1); /* always match the empty pattern */
7459 dtrace_match_nonzero(const char *s
, const char *p
, int depth
)
7461 #pragma unused(p, depth) /* __APPLE__ */
7462 return (s
!= NULL
&& s
[0] != '\0');
7466 dtrace_match(const dtrace_probekey_t
*pkp
, uint32_t priv
, uid_t uid
,
7467 zoneid_t zoneid
, int (*matched
)(dtrace_probe_t
*, void *), void *arg
)
7469 dtrace_probe_t
template, *probe
;
7470 dtrace_hash_t
*hash
= NULL
;
7471 int len
, rc
, best
= INT_MAX
, nmatched
= 0;
7474 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
7477 * If the probe ID is specified in the key, just lookup by ID and
7478 * invoke the match callback once if a matching probe is found.
7480 if (pkp
->dtpk_id
!= DTRACE_IDNONE
) {
7481 if ((probe
= dtrace_probe_lookup_id(pkp
->dtpk_id
)) != NULL
&&
7482 dtrace_match_probe(probe
, pkp
, priv
, uid
, zoneid
) > 0) {
7483 if ((*matched
)(probe
, arg
) == DTRACE_MATCH_FAIL
)
7484 return (DTRACE_MATCH_FAIL
);
7490 template.dtpr_mod
= (char *)(uintptr_t)pkp
->dtpk_mod
;
7491 template.dtpr_func
= (char *)(uintptr_t)pkp
->dtpk_func
;
7492 template.dtpr_name
= (char *)(uintptr_t)pkp
->dtpk_name
;
7495 * We want to find the most distinct of the module name, function
7496 * name, and name. So for each one that is not a glob pattern or
7497 * empty string, we perform a lookup in the corresponding hash and
7498 * use the hash table with the fewest collisions to do our search.
7500 if (pkp
->dtpk_mmatch
== &dtrace_match_string
&&
7501 (len
= dtrace_hash_collisions(dtrace_bymod
, &template)) < best
) {
7503 hash
= dtrace_bymod
;
7506 if (pkp
->dtpk_fmatch
== &dtrace_match_string
&&
7507 (len
= dtrace_hash_collisions(dtrace_byfunc
, &template)) < best
) {
7509 hash
= dtrace_byfunc
;
7512 if (pkp
->dtpk_nmatch
== &dtrace_match_string
&&
7513 (len
= dtrace_hash_collisions(dtrace_byname
, &template)) < best
) {
7515 hash
= dtrace_byname
;
7519 * If we did not select a hash table, iterate over every probe and
7520 * invoke our callback for each one that matches our input probe key.
7523 for (i
= 0; i
< (dtrace_id_t
)dtrace_nprobes
; i
++) {
7524 if ((probe
= dtrace_probes
[i
]) == NULL
||
7525 dtrace_match_probe(probe
, pkp
, priv
, uid
,
7531 if ((rc
= (*matched
)(probe
, arg
)) != DTRACE_MATCH_NEXT
) {
7532 if (rc
== DTRACE_MATCH_FAIL
)
7533 return (DTRACE_MATCH_FAIL
);
7542 * If we selected a hash table, iterate over each probe of the same key
7543 * name and invoke the callback for every probe that matches the other
7544 * attributes of our input probe key.
7546 for (probe
= dtrace_hash_lookup(hash
, &template); probe
!= NULL
;
7547 probe
= *(DTRACE_HASHNEXT(hash
, probe
))) {
7549 if (dtrace_match_probe(probe
, pkp
, priv
, uid
, zoneid
) <= 0)
7554 if ((rc
= (*matched
)(probe
, arg
)) != DTRACE_MATCH_NEXT
) {
7555 if (rc
== DTRACE_MATCH_FAIL
)
7556 return (DTRACE_MATCH_FAIL
);
7565 * Return the function pointer dtrace_probecmp() should use to compare the
7566 * specified pattern with a string. For NULL or empty patterns, we select
7567 * dtrace_match_nul(). For glob pattern strings, we use dtrace_match_glob().
7568 * For non-empty non-glob strings, we use dtrace_match_string().
7570 static dtrace_probekey_f
*
7571 dtrace_probekey_func(const char *p
)
7575 if (p
== NULL
|| *p
== '\0')
7576 return (&dtrace_match_nul
);
7578 while ((c
= *p
++) != '\0') {
7579 if (c
== '[' || c
== '?' || c
== '*' || c
== '\\')
7580 return (&dtrace_match_glob
);
7583 return (&dtrace_match_string
);
7587 * Build a probe comparison key for use with dtrace_match_probe() from the
7588 * given probe description. By convention, a null key only matches anchored
7589 * probes: if each field is the empty string, reset dtpk_fmatch to
7590 * dtrace_match_nonzero().
7593 dtrace_probekey(const dtrace_probedesc_t
*pdp
, dtrace_probekey_t
*pkp
)
7595 pkp
->dtpk_prov
= pdp
->dtpd_provider
;
7596 pkp
->dtpk_pmatch
= dtrace_probekey_func(pdp
->dtpd_provider
);
7598 pkp
->dtpk_mod
= pdp
->dtpd_mod
;
7599 pkp
->dtpk_mmatch
= dtrace_probekey_func(pdp
->dtpd_mod
);
7601 pkp
->dtpk_func
= pdp
->dtpd_func
;
7602 pkp
->dtpk_fmatch
= dtrace_probekey_func(pdp
->dtpd_func
);
7604 pkp
->dtpk_name
= pdp
->dtpd_name
;
7605 pkp
->dtpk_nmatch
= dtrace_probekey_func(pdp
->dtpd_name
);
7607 pkp
->dtpk_id
= pdp
->dtpd_id
;
7609 if (pkp
->dtpk_id
== DTRACE_IDNONE
&&
7610 pkp
->dtpk_pmatch
== &dtrace_match_nul
&&
7611 pkp
->dtpk_mmatch
== &dtrace_match_nul
&&
7612 pkp
->dtpk_fmatch
== &dtrace_match_nul
&&
7613 pkp
->dtpk_nmatch
== &dtrace_match_nul
)
7614 pkp
->dtpk_fmatch
= &dtrace_match_nonzero
;
7618 dtrace_cond_provider_match(dtrace_probedesc_t
*desc
, void *data
)
7623 dtrace_probekey_f
*func
= dtrace_probekey_func(desc
->dtpd_provider
);
7625 return func(desc
->dtpd_provider
, (char*)data
, 0);
7629 * DTrace Provider-to-Framework API Functions
7631 * These functions implement much of the Provider-to-Framework API, as
7632 * described in <sys/dtrace.h>. The parts of the API not in this section are
7633 * the functions in the API for probe management (found below), and
7634 * dtrace_probe() itself (found above).
7638 * Register the calling provider with the DTrace framework. This should
7639 * generally be called by DTrace providers in their attach(9E) entry point.
7642 dtrace_register(const char *name
, const dtrace_pattr_t
*pap
, uint32_t priv
,
7643 cred_t
*cr
, const dtrace_pops_t
*pops
, void *arg
, dtrace_provider_id_t
*idp
)
7645 dtrace_provider_t
*provider
;
7647 if (name
== NULL
|| pap
== NULL
|| pops
== NULL
|| idp
== NULL
) {
7648 cmn_err(CE_WARN
, "failed to register provider '%s': invalid "
7649 "arguments", name
? name
: "<NULL>");
7653 if (name
[0] == '\0' || dtrace_badname(name
)) {
7654 cmn_err(CE_WARN
, "failed to register provider '%s': invalid "
7655 "provider name", name
);
7659 if ((pops
->dtps_provide
== NULL
&& pops
->dtps_provide_module
== NULL
) ||
7660 pops
->dtps_enable
== NULL
|| pops
->dtps_disable
== NULL
||
7661 pops
->dtps_destroy
== NULL
||
7662 ((pops
->dtps_resume
== NULL
) != (pops
->dtps_suspend
== NULL
))) {
7663 cmn_err(CE_WARN
, "failed to register provider '%s': invalid "
7664 "provider ops", name
);
7668 if (dtrace_badattr(&pap
->dtpa_provider
) ||
7669 dtrace_badattr(&pap
->dtpa_mod
) ||
7670 dtrace_badattr(&pap
->dtpa_func
) ||
7671 dtrace_badattr(&pap
->dtpa_name
) ||
7672 dtrace_badattr(&pap
->dtpa_args
)) {
7673 cmn_err(CE_WARN
, "failed to register provider '%s': invalid "
7674 "provider attributes", name
);
7678 if (priv
& ~DTRACE_PRIV_ALL
) {
7679 cmn_err(CE_WARN
, "failed to register provider '%s': invalid "
7680 "privilege attributes", name
);
7684 if ((priv
& DTRACE_PRIV_KERNEL
) &&
7685 (priv
& (DTRACE_PRIV_USER
| DTRACE_PRIV_OWNER
)) &&
7686 pops
->dtps_usermode
== NULL
) {
7687 cmn_err(CE_WARN
, "failed to register provider '%s': need "
7688 "dtps_usermode() op for given privilege attributes", name
);
7692 provider
= kmem_zalloc(sizeof (dtrace_provider_t
), KM_SLEEP
);
7694 /* APPLE NOTE: Darwin employs size bounded string operation. */
7696 size_t bufsize
= strlen(name
) + 1;
7697 provider
->dtpv_name
= kmem_alloc(bufsize
, KM_SLEEP
);
7698 (void) strlcpy(provider
->dtpv_name
, name
, bufsize
);
7701 provider
->dtpv_attr
= *pap
;
7702 provider
->dtpv_priv
.dtpp_flags
= priv
;
7704 provider
->dtpv_priv
.dtpp_uid
= crgetuid(cr
);
7705 provider
->dtpv_priv
.dtpp_zoneid
= crgetzoneid(cr
);
7707 provider
->dtpv_pops
= *pops
;
7709 if (pops
->dtps_provide
== NULL
) {
7710 ASSERT(pops
->dtps_provide_module
!= NULL
);
7711 provider
->dtpv_pops
.dtps_provide
=
7712 (void (*)(void *, const dtrace_probedesc_t
*))dtrace_nullop
;
7715 if (pops
->dtps_provide_module
== NULL
) {
7716 ASSERT(pops
->dtps_provide
!= NULL
);
7717 provider
->dtpv_pops
.dtps_provide_module
=
7718 (void (*)(void *, struct modctl
*))dtrace_nullop
;
7721 if (pops
->dtps_suspend
== NULL
) {
7722 ASSERT(pops
->dtps_resume
== NULL
);
7723 provider
->dtpv_pops
.dtps_suspend
=
7724 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
;
7725 provider
->dtpv_pops
.dtps_resume
=
7726 (void (*)(void *, dtrace_id_t
, void *))dtrace_nullop
;
7729 provider
->dtpv_arg
= arg
;
7730 *idp
= (dtrace_provider_id_t
)provider
;
7732 if (pops
== &dtrace_provider_ops
) {
7733 lck_mtx_assert(&dtrace_provider_lock
, LCK_MTX_ASSERT_OWNED
);
7734 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
7735 ASSERT(dtrace_anon
.dta_enabling
== NULL
);
7738 * We make sure that the DTrace provider is at the head of
7739 * the provider chain.
7741 provider
->dtpv_next
= dtrace_provider
;
7742 dtrace_provider
= provider
;
7746 lck_mtx_lock(&dtrace_provider_lock
);
7747 lck_mtx_lock(&dtrace_lock
);
7750 * If there is at least one provider registered, we'll add this
7751 * provider after the first provider.
7753 if (dtrace_provider
!= NULL
) {
7754 provider
->dtpv_next
= dtrace_provider
->dtpv_next
;
7755 dtrace_provider
->dtpv_next
= provider
;
7757 dtrace_provider
= provider
;
7760 if (dtrace_retained
!= NULL
) {
7761 dtrace_enabling_provide(provider
);
7764 * Now we need to call dtrace_enabling_matchall_with_cond() --
7765 * with a condition matching the provider name we just added,
7766 * which will acquire cpu_lock and dtrace_lock. We therefore need
7767 * to drop all of our locks before calling into it...
7769 lck_mtx_unlock(&dtrace_lock
);
7770 lck_mtx_unlock(&dtrace_provider_lock
);
7772 dtrace_match_cond_t cond
= {dtrace_cond_provider_match
, provider
->dtpv_name
};
7773 dtrace_enabling_matchall_with_cond(&cond
);
7778 lck_mtx_unlock(&dtrace_lock
);
7779 lck_mtx_unlock(&dtrace_provider_lock
);
7785 * Unregister the specified provider from the DTrace framework. This should
7786 * generally be called by DTrace providers in their detach(9E) entry point.
7789 dtrace_unregister(dtrace_provider_id_t id
)
7791 dtrace_provider_t
*old
= (dtrace_provider_t
*)id
;
7792 dtrace_provider_t
*prev
= NULL
;
7794 dtrace_probe_t
*probe
, *first
= NULL
;
7796 if (old
->dtpv_pops
.dtps_enable
==
7797 (int (*)(void *, dtrace_id_t
, void *))dtrace_enable_nullop
) {
7799 * If DTrace itself is the provider, we're called with locks
7802 ASSERT(old
== dtrace_provider
);
7803 ASSERT(dtrace_devi
!= NULL
);
7804 lck_mtx_assert(&dtrace_provider_lock
, LCK_MTX_ASSERT_OWNED
);
7805 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
7808 if (dtrace_provider
->dtpv_next
!= NULL
) {
7810 * There's another provider here; return failure.
7815 lck_mtx_lock(&dtrace_provider_lock
);
7816 lck_mtx_lock(&mod_lock
);
7817 lck_mtx_lock(&dtrace_lock
);
7821 * If anyone has /dev/dtrace open, or if there are anonymous enabled
7822 * probes, we refuse to let providers slither away, unless this
7823 * provider has already been explicitly invalidated.
7825 if (!old
->dtpv_defunct
&&
7826 (dtrace_opens
|| (dtrace_anon
.dta_state
!= NULL
&&
7827 dtrace_anon
.dta_state
->dts_necbs
> 0))) {
7829 lck_mtx_unlock(&dtrace_lock
);
7830 lck_mtx_unlock(&mod_lock
);
7831 lck_mtx_unlock(&dtrace_provider_lock
);
7837 * Attempt to destroy the probes associated with this provider.
7839 if (old
->dtpv_ecb_count
!=0) {
7841 * We have at least one ECB; we can't remove this provider.
7844 lck_mtx_unlock(&dtrace_lock
);
7845 lck_mtx_unlock(&mod_lock
);
7846 lck_mtx_unlock(&dtrace_provider_lock
);
7852 * All of the probes for this provider are disabled; we can safely
7853 * remove all of them from their hash chains and from the probe array.
7855 for (i
= 0; i
< dtrace_nprobes
&& old
->dtpv_probe_count
!=0; i
++) {
7856 if ((probe
= dtrace_probes
[i
]) == NULL
)
7859 if (probe
->dtpr_provider
!= old
)
7862 dtrace_probes
[i
] = NULL
;
7863 old
->dtpv_probe_count
--;
7865 dtrace_hash_remove(dtrace_bymod
, probe
);
7866 dtrace_hash_remove(dtrace_byfunc
, probe
);
7867 dtrace_hash_remove(dtrace_byname
, probe
);
7869 if (first
== NULL
) {
7871 probe
->dtpr_nextmod
= NULL
;
7873 probe
->dtpr_nextmod
= first
;
7879 * The provider's probes have been removed from the hash chains and
7880 * from the probe array. Now issue a dtrace_sync() to be sure that
7881 * everyone has cleared out from any probe array processing.
7885 for (probe
= first
; probe
!= NULL
; probe
= first
) {
7886 first
= probe
->dtpr_nextmod
;
7888 old
->dtpv_pops
.dtps_destroy(old
->dtpv_arg
, probe
->dtpr_id
,
7890 kmem_free(probe
->dtpr_mod
, strlen(probe
->dtpr_mod
) + 1);
7891 kmem_free(probe
->dtpr_func
, strlen(probe
->dtpr_func
) + 1);
7892 kmem_free(probe
->dtpr_name
, strlen(probe
->dtpr_name
) + 1);
7893 vmem_free(dtrace_arena
, (void *)(uintptr_t)(probe
->dtpr_id
), 1);
7894 zfree(dtrace_probe_t_zone
, probe
);
7897 if ((prev
= dtrace_provider
) == old
) {
7898 ASSERT(self
|| dtrace_devi
== NULL
);
7899 ASSERT(old
->dtpv_next
== NULL
|| dtrace_devi
== NULL
);
7900 dtrace_provider
= old
->dtpv_next
;
7902 while (prev
!= NULL
&& prev
->dtpv_next
!= old
)
7903 prev
= prev
->dtpv_next
;
7906 panic("attempt to unregister non-existent "
7907 "dtrace provider %p\n", (void *)id
);
7910 prev
->dtpv_next
= old
->dtpv_next
;
7914 lck_mtx_unlock(&dtrace_lock
);
7915 lck_mtx_unlock(&mod_lock
);
7916 lck_mtx_unlock(&dtrace_provider_lock
);
7919 kmem_free(old
->dtpv_name
, strlen(old
->dtpv_name
) + 1);
7920 kmem_free(old
, sizeof (dtrace_provider_t
));
7926 * Invalidate the specified provider. All subsequent probe lookups for the
7927 * specified provider will fail, but its probes will not be removed.
7930 dtrace_invalidate(dtrace_provider_id_t id
)
7932 dtrace_provider_t
*pvp
= (dtrace_provider_t
*)id
;
7934 ASSERT(pvp
->dtpv_pops
.dtps_enable
!=
7935 (int (*)(void *, dtrace_id_t
, void *))dtrace_enable_nullop
);
7937 lck_mtx_lock(&dtrace_provider_lock
);
7938 lck_mtx_lock(&dtrace_lock
);
7940 pvp
->dtpv_defunct
= 1;
7942 lck_mtx_unlock(&dtrace_lock
);
7943 lck_mtx_unlock(&dtrace_provider_lock
);
7947 * Indicate whether or not DTrace has attached.
7950 dtrace_attached(void)
7953 * dtrace_provider will be non-NULL iff the DTrace driver has
7954 * attached. (It's non-NULL because DTrace is always itself a
7957 return (dtrace_provider
!= NULL
);
7961 * Remove all the unenabled probes for the given provider. This function is
7962 * not unlike dtrace_unregister(), except that it doesn't remove the provider
7963 * -- just as many of its associated probes as it can.
7966 dtrace_condense(dtrace_provider_id_t id
)
7968 dtrace_provider_t
*prov
= (dtrace_provider_t
*)id
;
7970 dtrace_probe_t
*probe
;
7973 * Make sure this isn't the dtrace provider itself.
7975 ASSERT(prov
->dtpv_pops
.dtps_enable
!=
7976 (int (*)(void *, dtrace_id_t
, void *))dtrace_enable_nullop
);
7978 lck_mtx_lock(&dtrace_provider_lock
);
7979 lck_mtx_lock(&dtrace_lock
);
7982 * Attempt to destroy the probes associated with this provider.
7984 for (i
= 0; i
< dtrace_nprobes
; i
++) {
7985 if ((probe
= dtrace_probes
[i
]) == NULL
)
7988 if (probe
->dtpr_provider
!= prov
)
7991 if (probe
->dtpr_ecb
!= NULL
)
7994 dtrace_probes
[i
] = NULL
;
7995 prov
->dtpv_probe_count
--;
7997 dtrace_hash_remove(dtrace_bymod
, probe
);
7998 dtrace_hash_remove(dtrace_byfunc
, probe
);
7999 dtrace_hash_remove(dtrace_byname
, probe
);
8001 prov
->dtpv_pops
.dtps_destroy(prov
->dtpv_arg
, i
+ 1,
8003 kmem_free(probe
->dtpr_mod
, strlen(probe
->dtpr_mod
) + 1);
8004 kmem_free(probe
->dtpr_func
, strlen(probe
->dtpr_func
) + 1);
8005 kmem_free(probe
->dtpr_name
, strlen(probe
->dtpr_name
) + 1);
8006 zfree(dtrace_probe_t_zone
, probe
);
8007 vmem_free(dtrace_arena
, (void *)((uintptr_t)i
+ 1), 1);
8010 lck_mtx_unlock(&dtrace_lock
);
8011 lck_mtx_unlock(&dtrace_provider_lock
);
8017 * DTrace Probe Management Functions
8019 * The functions in this section perform the DTrace probe management,
8020 * including functions to create probes, look-up probes, and call into the
8021 * providers to request that probes be provided. Some of these functions are
8022 * in the Provider-to-Framework API; these functions can be identified by the
8023 * fact that they are not declared "static".
8027 * Create a probe with the specified module name, function name, and name.
8030 dtrace_probe_create(dtrace_provider_id_t prov
, const char *mod
,
8031 const char *func
, const char *name
, int aframes
, void *arg
)
8033 dtrace_probe_t
*probe
, **probes
;
8034 dtrace_provider_t
*provider
= (dtrace_provider_t
*)prov
;
8037 if (provider
== dtrace_provider
) {
8038 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
8040 lck_mtx_lock(&dtrace_lock
);
8043 id
= (dtrace_id_t
)(uintptr_t)vmem_alloc(dtrace_arena
, 1,
8044 VM_BESTFIT
| VM_SLEEP
);
8046 probe
= zalloc(dtrace_probe_t_zone
);
8047 bzero(probe
, sizeof (dtrace_probe_t
));
8049 probe
->dtpr_id
= id
;
8050 probe
->dtpr_gen
= dtrace_probegen
++;
8051 probe
->dtpr_mod
= dtrace_strdup(mod
);
8052 probe
->dtpr_func
= dtrace_strdup(func
);
8053 probe
->dtpr_name
= dtrace_strdup(name
);
8054 probe
->dtpr_arg
= arg
;
8055 probe
->dtpr_aframes
= aframes
;
8056 probe
->dtpr_provider
= provider
;
8058 dtrace_hash_add(dtrace_bymod
, probe
);
8059 dtrace_hash_add(dtrace_byfunc
, probe
);
8060 dtrace_hash_add(dtrace_byname
, probe
);
8062 if (id
- 1 >= (dtrace_id_t
)dtrace_nprobes
) {
8063 size_t osize
= dtrace_nprobes
* sizeof (dtrace_probe_t
*);
8064 size_t nsize
= osize
<< 1;
8068 ASSERT(dtrace_probes
== NULL
);
8069 nsize
= sizeof (dtrace_probe_t
*);
8072 probes
= kmem_zalloc(nsize
, KM_SLEEP
);
8074 if (dtrace_probes
== NULL
) {
8076 dtrace_probes
= probes
;
8079 dtrace_probe_t
**oprobes
= dtrace_probes
;
8081 bcopy(oprobes
, probes
, osize
);
8082 dtrace_membar_producer();
8083 dtrace_probes
= probes
;
8088 * All CPUs are now seeing the new probes array; we can
8089 * safely free the old array.
8091 kmem_free(oprobes
, osize
);
8092 dtrace_nprobes
<<= 1;
8095 ASSERT(id
- 1 < (dtrace_id_t
)dtrace_nprobes
);
8098 ASSERT(dtrace_probes
[id
- 1] == NULL
);
8099 dtrace_probes
[id
- 1] = probe
;
8100 provider
->dtpv_probe_count
++;
8102 if (provider
!= dtrace_provider
)
8103 lck_mtx_unlock(&dtrace_lock
);
8108 static dtrace_probe_t
*
8109 dtrace_probe_lookup_id(dtrace_id_t id
)
8111 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
8113 if (id
== 0 || id
> (dtrace_id_t
)dtrace_nprobes
)
8116 return (dtrace_probes
[id
- 1]);
8120 dtrace_probe_lookup_match(dtrace_probe_t
*probe
, void *arg
)
8122 *((dtrace_id_t
*)arg
) = probe
->dtpr_id
;
8124 return (DTRACE_MATCH_DONE
);
8128 * Look up a probe based on provider and one or more of module name, function
8129 * name and probe name.
8132 dtrace_probe_lookup(dtrace_provider_id_t prid
, const char *mod
,
8133 const char *func
, const char *name
)
8135 dtrace_probekey_t pkey
;
8139 pkey
.dtpk_prov
= ((dtrace_provider_t
*)prid
)->dtpv_name
;
8140 pkey
.dtpk_pmatch
= &dtrace_match_string
;
8141 pkey
.dtpk_mod
= mod
;
8142 pkey
.dtpk_mmatch
= mod
? &dtrace_match_string
: &dtrace_match_nul
;
8143 pkey
.dtpk_func
= func
;
8144 pkey
.dtpk_fmatch
= func
? &dtrace_match_string
: &dtrace_match_nul
;
8145 pkey
.dtpk_name
= name
;
8146 pkey
.dtpk_nmatch
= name
? &dtrace_match_string
: &dtrace_match_nul
;
8147 pkey
.dtpk_id
= DTRACE_IDNONE
;
8149 lck_mtx_lock(&dtrace_lock
);
8150 match
= dtrace_match(&pkey
, DTRACE_PRIV_ALL
, 0, 0,
8151 dtrace_probe_lookup_match
, &id
);
8152 lck_mtx_unlock(&dtrace_lock
);
8154 ASSERT(match
== 1 || match
== 0);
8155 return (match
? id
: 0);
8159 * Returns the probe argument associated with the specified probe.
8162 dtrace_probe_arg(dtrace_provider_id_t id
, dtrace_id_t pid
)
8164 dtrace_probe_t
*probe
;
8167 lck_mtx_lock(&dtrace_lock
);
8169 if ((probe
= dtrace_probe_lookup_id(pid
)) != NULL
&&
8170 probe
->dtpr_provider
== (dtrace_provider_t
*)id
)
8171 rval
= probe
->dtpr_arg
;
8173 lck_mtx_unlock(&dtrace_lock
);
8179 * Copy a probe into a probe description.
8182 dtrace_probe_description(const dtrace_probe_t
*prp
, dtrace_probedesc_t
*pdp
)
8184 bzero(pdp
, sizeof (dtrace_probedesc_t
));
8185 pdp
->dtpd_id
= prp
->dtpr_id
;
8187 /* APPLE NOTE: Darwin employs size bounded string operation. */
8188 (void) strlcpy(pdp
->dtpd_provider
,
8189 prp
->dtpr_provider
->dtpv_name
, DTRACE_PROVNAMELEN
);
8191 (void) strlcpy(pdp
->dtpd_mod
, prp
->dtpr_mod
, DTRACE_MODNAMELEN
);
8192 (void) strlcpy(pdp
->dtpd_func
, prp
->dtpr_func
, DTRACE_FUNCNAMELEN
);
8193 (void) strlcpy(pdp
->dtpd_name
, prp
->dtpr_name
, DTRACE_NAMELEN
);
8197 * Called to indicate that a probe -- or probes -- should be provided by a
8198 * specfied provider. If the specified description is NULL, the provider will
8199 * be told to provide all of its probes. (This is done whenever a new
8200 * consumer comes along, or whenever a retained enabling is to be matched.) If
8201 * the specified description is non-NULL, the provider is given the
8202 * opportunity to dynamically provide the specified probe, allowing providers
8203 * to support the creation of probes on-the-fly. (So-called _autocreated_
8204 * probes.) If the provider is NULL, the operations will be applied to all
8205 * providers; if the provider is non-NULL the operations will only be applied
8206 * to the specified provider. The dtrace_provider_lock must be held, and the
8207 * dtrace_lock must _not_ be held -- the provider's dtps_provide() operation
8208 * will need to grab the dtrace_lock when it reenters the framework through
8209 * dtrace_probe_lookup(), dtrace_probe_create(), etc.
8212 dtrace_probe_provide(dtrace_probedesc_t
*desc
, dtrace_provider_t
*prv
)
8217 lck_mtx_assert(&dtrace_provider_lock
, LCK_MTX_ASSERT_OWNED
);
8221 prv
= dtrace_provider
;
8226 * First, call the blanket provide operation.
8228 prv
->dtpv_pops
.dtps_provide(prv
->dtpv_arg
, desc
);
8231 * Now call the per-module provide operation. We will grab
8232 * mod_lock to prevent the list from being modified. Note
8233 * that this also prevents the mod_busy bits from changing.
8234 * (mod_busy can only be changed with mod_lock held.)
8236 lck_mtx_lock(&mod_lock
);
8238 ctl
= dtrace_modctl_list
;
8240 prv
->dtpv_pops
.dtps_provide_module(prv
->dtpv_arg
, ctl
);
8241 ctl
= ctl
->mod_next
;
8244 lck_mtx_unlock(&mod_lock
);
8245 } while (all
&& (prv
= prv
->dtpv_next
) != NULL
);
8249 * Iterate over each probe, and call the Framework-to-Provider API function
8253 dtrace_probe_foreach(uintptr_t offs
)
8255 dtrace_provider_t
*prov
;
8256 void (*func
)(void *, dtrace_id_t
, void *);
8257 dtrace_probe_t
*probe
;
8258 dtrace_icookie_t cookie
;
8262 * We disable interrupts to walk through the probe array. This is
8263 * safe -- the dtrace_sync() in dtrace_unregister() assures that we
8264 * won't see stale data.
8266 cookie
= dtrace_interrupt_disable();
8268 for (i
= 0; i
< dtrace_nprobes
; i
++) {
8269 if ((probe
= dtrace_probes
[i
]) == NULL
)
8272 if (probe
->dtpr_ecb
== NULL
) {
8274 * This probe isn't enabled -- don't call the function.
8279 prov
= probe
->dtpr_provider
;
8280 func
= *((void(**)(void *, dtrace_id_t
, void *))
8281 ((uintptr_t)&prov
->dtpv_pops
+ offs
));
8283 func(prov
->dtpv_arg
, i
+ 1, probe
->dtpr_arg
);
8286 dtrace_interrupt_enable(cookie
);
8290 dtrace_probe_enable(const dtrace_probedesc_t
*desc
, dtrace_enabling_t
*enab
)
8292 dtrace_probekey_t pkey
;
8297 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
8299 dtrace_ecb_create_cache
= NULL
;
8303 * If we're passed a NULL description, we're being asked to
8304 * create an ECB with a NULL probe.
8306 (void) dtrace_ecb_create_enable(NULL
, enab
);
8310 dtrace_probekey(desc
, &pkey
);
8311 dtrace_cred2priv(enab
->dten_vstate
->dtvs_state
->dts_cred
.dcr_cred
,
8312 &priv
, &uid
, &zoneid
);
8314 return (dtrace_match(&pkey
, priv
, uid
, zoneid
, dtrace_ecb_create_enable
,
8319 * DTrace Helper Provider Functions
8322 dtrace_dofattr2attr(dtrace_attribute_t
*attr
, const dof_attr_t dofattr
)
8324 attr
->dtat_name
= DOF_ATTR_NAME(dofattr
);
8325 attr
->dtat_data
= DOF_ATTR_DATA(dofattr
);
8326 attr
->dtat_class
= DOF_ATTR_CLASS(dofattr
);
8330 dtrace_dofprov2hprov(dtrace_helper_provdesc_t
*hprov
,
8331 const dof_provider_t
*dofprov
, char *strtab
)
8333 hprov
->dthpv_provname
= strtab
+ dofprov
->dofpv_name
;
8334 dtrace_dofattr2attr(&hprov
->dthpv_pattr
.dtpa_provider
,
8335 dofprov
->dofpv_provattr
);
8336 dtrace_dofattr2attr(&hprov
->dthpv_pattr
.dtpa_mod
,
8337 dofprov
->dofpv_modattr
);
8338 dtrace_dofattr2attr(&hprov
->dthpv_pattr
.dtpa_func
,
8339 dofprov
->dofpv_funcattr
);
8340 dtrace_dofattr2attr(&hprov
->dthpv_pattr
.dtpa_name
,
8341 dofprov
->dofpv_nameattr
);
8342 dtrace_dofattr2attr(&hprov
->dthpv_pattr
.dtpa_args
,
8343 dofprov
->dofpv_argsattr
);
8347 dtrace_helper_provide_one(dof_helper_t
*dhp
, dof_sec_t
*sec
, pid_t pid
)
8349 uintptr_t daddr
= (uintptr_t)dhp
->dofhp_dof
;
8350 dof_hdr_t
*dof
= (dof_hdr_t
*)daddr
;
8351 dof_sec_t
*str_sec
, *prb_sec
, *arg_sec
, *off_sec
, *enoff_sec
;
8352 dof_provider_t
*provider
;
8354 uint32_t *off
, *enoff
;
8358 dtrace_helper_provdesc_t dhpv
;
8359 dtrace_helper_probedesc_t dhpb
;
8360 dtrace_meta_t
*meta
= dtrace_meta_pid
;
8361 dtrace_mops_t
*mops
= &meta
->dtm_mops
;
8364 provider
= (dof_provider_t
*)(uintptr_t)(daddr
+ sec
->dofs_offset
);
8365 str_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8366 provider
->dofpv_strtab
* dof
->dofh_secsize
);
8367 prb_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8368 provider
->dofpv_probes
* dof
->dofh_secsize
);
8369 arg_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8370 provider
->dofpv_prargs
* dof
->dofh_secsize
);
8371 off_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8372 provider
->dofpv_proffs
* dof
->dofh_secsize
);
8374 strtab
= (char *)(uintptr_t)(daddr
+ str_sec
->dofs_offset
);
8375 off
= (uint32_t *)(uintptr_t)(daddr
+ off_sec
->dofs_offset
);
8376 arg
= (uint8_t *)(uintptr_t)(daddr
+ arg_sec
->dofs_offset
);
8380 * See dtrace_helper_provider_validate().
8382 if (dof
->dofh_ident
[DOF_ID_VERSION
] != DOF_VERSION_1
&&
8383 provider
->dofpv_prenoffs
!= DOF_SECT_NONE
) {
8384 enoff_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8385 provider
->dofpv_prenoffs
* dof
->dofh_secsize
);
8386 enoff
= (uint32_t *)(uintptr_t)(daddr
+ enoff_sec
->dofs_offset
);
8389 nprobes
= prb_sec
->dofs_size
/ prb_sec
->dofs_entsize
;
8392 * Create the provider.
8394 dtrace_dofprov2hprov(&dhpv
, provider
, strtab
);
8396 if ((parg
= mops
->dtms_provide_pid(meta
->dtm_arg
, &dhpv
, pid
)) == NULL
)
8402 * Create the probes.
8404 for (i
= 0; i
< nprobes
; i
++) {
8405 probe
= (dof_probe_t
*)(uintptr_t)(daddr
+
8406 prb_sec
->dofs_offset
+ i
* prb_sec
->dofs_entsize
);
8408 dhpb
.dthpb_mod
= dhp
->dofhp_mod
;
8409 dhpb
.dthpb_func
= strtab
+ probe
->dofpr_func
;
8410 dhpb
.dthpb_name
= strtab
+ probe
->dofpr_name
;
8411 #if !defined(__APPLE__)
8412 dhpb
.dthpb_base
= probe
->dofpr_addr
;
8414 dhpb
.dthpb_base
= dhp
->dofhp_addr
; /* FIXME: James, why? */
8416 dhpb
.dthpb_offs
= (int32_t *)(off
+ probe
->dofpr_offidx
);
8417 dhpb
.dthpb_noffs
= probe
->dofpr_noffs
;
8418 if (enoff
!= NULL
) {
8419 dhpb
.dthpb_enoffs
= (int32_t *)(enoff
+ probe
->dofpr_enoffidx
);
8420 dhpb
.dthpb_nenoffs
= probe
->dofpr_nenoffs
;
8422 dhpb
.dthpb_enoffs
= NULL
;
8423 dhpb
.dthpb_nenoffs
= 0;
8425 dhpb
.dthpb_args
= arg
+ probe
->dofpr_argidx
;
8426 dhpb
.dthpb_nargc
= probe
->dofpr_nargc
;
8427 dhpb
.dthpb_xargc
= probe
->dofpr_xargc
;
8428 dhpb
.dthpb_ntypes
= strtab
+ probe
->dofpr_nargv
;
8429 dhpb
.dthpb_xtypes
= strtab
+ probe
->dofpr_xargv
;
8431 mops
->dtms_create_probe(meta
->dtm_arg
, parg
, &dhpb
);
8435 * Since we just created probes, we need to match our enablings
8436 * against those, with a precondition knowing that we have only
8437 * added probes from this provider
8439 char *prov_name
= mops
->dtms_provider_name(parg
);
8440 ASSERT(prov_name
!= NULL
);
8441 dtrace_match_cond_t cond
= {dtrace_cond_provider_match
, (void*)prov_name
};
8443 dtrace_enabling_matchall_with_cond(&cond
);
8447 dtrace_helper_provide(dof_helper_t
*dhp
, pid_t pid
)
8449 uintptr_t daddr
= (uintptr_t)dhp
->dofhp_dof
;
8450 dof_hdr_t
*dof
= (dof_hdr_t
*)daddr
;
8453 lck_mtx_assert(&dtrace_meta_lock
, LCK_MTX_ASSERT_OWNED
);
8455 for (i
= 0; i
< dof
->dofh_secnum
; i
++) {
8456 dof_sec_t
*sec
= (dof_sec_t
*)(uintptr_t)(daddr
+
8457 dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
8459 if (sec
->dofs_type
!= DOF_SECT_PROVIDER
)
8462 dtrace_helper_provide_one(dhp
, sec
, pid
);
8467 dtrace_helper_provider_remove_one(dof_helper_t
*dhp
, dof_sec_t
*sec
, pid_t pid
)
8469 uintptr_t daddr
= (uintptr_t)dhp
->dofhp_dof
;
8470 dof_hdr_t
*dof
= (dof_hdr_t
*)daddr
;
8472 dof_provider_t
*provider
;
8474 dtrace_helper_provdesc_t dhpv
;
8475 dtrace_meta_t
*meta
= dtrace_meta_pid
;
8476 dtrace_mops_t
*mops
= &meta
->dtm_mops
;
8478 provider
= (dof_provider_t
*)(uintptr_t)(daddr
+ sec
->dofs_offset
);
8479 str_sec
= (dof_sec_t
*)(uintptr_t)(daddr
+ dof
->dofh_secoff
+
8480 provider
->dofpv_strtab
* dof
->dofh_secsize
);
8482 strtab
= (char *)(uintptr_t)(daddr
+ str_sec
->dofs_offset
);
8485 * Create the provider.
8487 dtrace_dofprov2hprov(&dhpv
, provider
, strtab
);
8489 mops
->dtms_remove_pid(meta
->dtm_arg
, &dhpv
, pid
);
8495 dtrace_helper_provider_remove(dof_helper_t
*dhp
, pid_t pid
)
8497 uintptr_t daddr
= (uintptr_t)dhp
->dofhp_dof
;
8498 dof_hdr_t
*dof
= (dof_hdr_t
*)daddr
;
8501 lck_mtx_assert(&dtrace_meta_lock
, LCK_MTX_ASSERT_OWNED
);
8503 for (i
= 0; i
< dof
->dofh_secnum
; i
++) {
8504 dof_sec_t
*sec
= (dof_sec_t
*)(uintptr_t)(daddr
+
8505 dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
8507 if (sec
->dofs_type
!= DOF_SECT_PROVIDER
)
8510 dtrace_helper_provider_remove_one(dhp
, sec
, pid
);
8515 * DTrace Meta Provider-to-Framework API Functions
8517 * These functions implement the Meta Provider-to-Framework API, as described
8518 * in <sys/dtrace.h>.
8521 dtrace_meta_register(const char *name
, const dtrace_mops_t
*mops
, void *arg
,
8522 dtrace_meta_provider_id_t
*idp
)
8524 dtrace_meta_t
*meta
;
8525 dtrace_helpers_t
*help
, *next
;
8528 *idp
= DTRACE_METAPROVNONE
;
8531 * We strictly don't need the name, but we hold onto it for
8532 * debuggability. All hail error queues!
8535 cmn_err(CE_WARN
, "failed to register meta-provider: "
8541 mops
->dtms_create_probe
== NULL
||
8542 mops
->dtms_provide_pid
== NULL
||
8543 mops
->dtms_remove_pid
== NULL
) {
8544 cmn_err(CE_WARN
, "failed to register meta-register %s: "
8545 "invalid ops", name
);
8549 meta
= kmem_zalloc(sizeof (dtrace_meta_t
), KM_SLEEP
);
8550 meta
->dtm_mops
= *mops
;
8552 /* APPLE NOTE: Darwin employs size bounded string operation. */
8554 size_t bufsize
= strlen(name
) + 1;
8555 meta
->dtm_name
= kmem_alloc(bufsize
, KM_SLEEP
);
8556 (void) strlcpy(meta
->dtm_name
, name
, bufsize
);
8559 meta
->dtm_arg
= arg
;
8561 lck_mtx_lock(&dtrace_meta_lock
);
8562 lck_mtx_lock(&dtrace_lock
);
8564 if (dtrace_meta_pid
!= NULL
) {
8565 lck_mtx_unlock(&dtrace_lock
);
8566 lck_mtx_unlock(&dtrace_meta_lock
);
8567 cmn_err(CE_WARN
, "failed to register meta-register %s: "
8568 "user-land meta-provider exists", name
);
8569 kmem_free(meta
->dtm_name
, strlen(meta
->dtm_name
) + 1);
8570 kmem_free(meta
, sizeof (dtrace_meta_t
));
8574 dtrace_meta_pid
= meta
;
8575 *idp
= (dtrace_meta_provider_id_t
)meta
;
8578 * If there are providers and probes ready to go, pass them
8579 * off to the new meta provider now.
8582 help
= dtrace_deferred_pid
;
8583 dtrace_deferred_pid
= NULL
;
8585 lck_mtx_unlock(&dtrace_lock
);
8587 while (help
!= NULL
) {
8588 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
8589 dtrace_helper_provide(&help
->dthps_provs
[i
]->dthp_prov
,
8593 next
= help
->dthps_next
;
8594 help
->dthps_next
= NULL
;
8595 help
->dthps_prev
= NULL
;
8596 help
->dthps_deferred
= 0;
8600 lck_mtx_unlock(&dtrace_meta_lock
);
8606 dtrace_meta_unregister(dtrace_meta_provider_id_t id
)
8608 dtrace_meta_t
**pp
, *old
= (dtrace_meta_t
*)id
;
8610 lck_mtx_lock(&dtrace_meta_lock
);
8611 lck_mtx_lock(&dtrace_lock
);
8613 if (old
== dtrace_meta_pid
) {
8614 pp
= &dtrace_meta_pid
;
8616 panic("attempt to unregister non-existent "
8617 "dtrace meta-provider %p\n", (void *)old
);
8620 if (old
->dtm_count
!= 0) {
8621 lck_mtx_unlock(&dtrace_lock
);
8622 lck_mtx_unlock(&dtrace_meta_lock
);
8628 lck_mtx_unlock(&dtrace_lock
);
8629 lck_mtx_unlock(&dtrace_meta_lock
);
8631 kmem_free(old
->dtm_name
, strlen(old
->dtm_name
) + 1);
8632 kmem_free(old
, sizeof (dtrace_meta_t
));
8639 * DTrace DIF Object Functions
8642 dtrace_difo_err(uint_t pc
, const char *format
, ...)
8644 if (dtrace_err_verbose
) {
8647 (void) uprintf("dtrace DIF object error: [%u]: ", pc
);
8648 va_start(alist
, format
);
8649 (void) vuprintf(format
, alist
);
8653 #ifdef DTRACE_ERRDEBUG
8654 dtrace_errdebug(format
);
8660 * Validate a DTrace DIF object by checking the IR instructions. The following
8661 * rules are currently enforced by dtrace_difo_validate():
8663 * 1. Each instruction must have a valid opcode
8664 * 2. Each register, string, variable, or subroutine reference must be valid
8665 * 3. No instruction can modify register %r0 (must be zero)
8666 * 4. All instruction reserved bits must be set to zero
8667 * 5. The last instruction must be a "ret" instruction
8668 * 6. All branch targets must reference a valid instruction _after_ the branch
8671 dtrace_difo_validate(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
, uint_t nregs
,
8677 int (*efunc
)(uint_t pc
, const char *, ...) = dtrace_difo_err
;
8680 int maxglobal
= -1, maxlocal
= -1, maxtlocal
= -1;
8682 kcheckload
= cr
== NULL
||
8683 (vstate
->dtvs_state
->dts_cred
.dcr_visible
& DTRACE_CRV_KERNEL
) == 0;
8685 dp
->dtdo_destructive
= 0;
8687 for (pc
= 0; pc
< dp
->dtdo_len
&& err
== 0; pc
++) {
8688 dif_instr_t instr
= dp
->dtdo_buf
[pc
];
8690 uint_t r1
= DIF_INSTR_R1(instr
);
8691 uint_t r2
= DIF_INSTR_R2(instr
);
8692 uint_t rd
= DIF_INSTR_RD(instr
);
8693 uint_t rs
= DIF_INSTR_RS(instr
);
8694 uint_t label
= DIF_INSTR_LABEL(instr
);
8695 uint_t v
= DIF_INSTR_VAR(instr
);
8696 uint_t subr
= DIF_INSTR_SUBR(instr
);
8697 uint_t type
= DIF_INSTR_TYPE(instr
);
8698 uint_t op
= DIF_INSTR_OP(instr
);
8716 err
+= efunc(pc
, "invalid register %u\n", r1
);
8718 err
+= efunc(pc
, "invalid register %u\n", r2
);
8720 err
+= efunc(pc
, "invalid register %u\n", rd
);
8722 err
+= efunc(pc
, "cannot write to %r0\n");
8728 err
+= efunc(pc
, "invalid register %u\n", r1
);
8730 err
+= efunc(pc
, "non-zero reserved bits\n");
8732 err
+= efunc(pc
, "invalid register %u\n", rd
);
8734 err
+= efunc(pc
, "cannot write to %r0\n");
8744 err
+= efunc(pc
, "invalid register %u\n", r1
);
8746 err
+= efunc(pc
, "non-zero reserved bits\n");
8748 err
+= efunc(pc
, "invalid register %u\n", rd
);
8750 err
+= efunc(pc
, "cannot write to %r0\n");
8752 dp
->dtdo_buf
[pc
] = DIF_INSTR_LOAD(op
+
8753 DIF_OP_RLDSB
- DIF_OP_LDSB
, r1
, rd
);
8763 err
+= efunc(pc
, "invalid register %u\n", r1
);
8765 err
+= efunc(pc
, "non-zero reserved bits\n");
8767 err
+= efunc(pc
, "invalid register %u\n", rd
);
8769 err
+= efunc(pc
, "cannot write to %r0\n");
8779 err
+= efunc(pc
, "invalid register %u\n", r1
);
8781 err
+= efunc(pc
, "non-zero reserved bits\n");
8783 err
+= efunc(pc
, "invalid register %u\n", rd
);
8785 err
+= efunc(pc
, "cannot write to %r0\n");
8792 err
+= efunc(pc
, "invalid register %u\n", r1
);
8794 err
+= efunc(pc
, "non-zero reserved bits\n");
8796 err
+= efunc(pc
, "invalid register %u\n", rd
);
8798 err
+= efunc(pc
, "cannot write to 0 address\n");
8803 err
+= efunc(pc
, "invalid register %u\n", r1
);
8805 err
+= efunc(pc
, "invalid register %u\n", r2
);
8807 err
+= efunc(pc
, "non-zero reserved bits\n");
8811 err
+= efunc(pc
, "invalid register %u\n", r1
);
8812 if (r2
!= 0 || rd
!= 0)
8813 err
+= efunc(pc
, "non-zero reserved bits\n");
8826 if (label
>= dp
->dtdo_len
) {
8827 err
+= efunc(pc
, "invalid branch target %u\n",
8831 err
+= efunc(pc
, "backward branch to %u\n",
8836 if (r1
!= 0 || r2
!= 0)
8837 err
+= efunc(pc
, "non-zero reserved bits\n");
8839 err
+= efunc(pc
, "invalid register %u\n", rd
);
8843 case DIF_OP_FLUSHTS
:
8844 if (r1
!= 0 || r2
!= 0 || rd
!= 0)
8845 err
+= efunc(pc
, "non-zero reserved bits\n");
8848 if (DIF_INSTR_INTEGER(instr
) >= dp
->dtdo_intlen
) {
8849 err
+= efunc(pc
, "invalid integer ref %u\n",
8850 DIF_INSTR_INTEGER(instr
));
8853 err
+= efunc(pc
, "invalid register %u\n", rd
);
8855 err
+= efunc(pc
, "cannot write to %r0\n");
8858 if (DIF_INSTR_STRING(instr
) >= dp
->dtdo_strlen
) {
8859 err
+= efunc(pc
, "invalid string ref %u\n",
8860 DIF_INSTR_STRING(instr
));
8863 err
+= efunc(pc
, "invalid register %u\n", rd
);
8865 err
+= efunc(pc
, "cannot write to %r0\n");
8869 if (r1
> DIF_VAR_ARRAY_MAX
)
8870 err
+= efunc(pc
, "invalid array %u\n", r1
);
8872 err
+= efunc(pc
, "invalid register %u\n", r2
);
8874 err
+= efunc(pc
, "invalid register %u\n", rd
);
8876 err
+= efunc(pc
, "cannot write to %r0\n");
8883 if (v
< DIF_VAR_OTHER_MIN
|| v
> DIF_VAR_OTHER_MAX
)
8884 err
+= efunc(pc
, "invalid variable %u\n", v
);
8886 err
+= efunc(pc
, "invalid register %u\n", rd
);
8888 err
+= efunc(pc
, "cannot write to %r0\n");
8895 if (v
< DIF_VAR_OTHER_UBASE
|| v
> DIF_VAR_OTHER_MAX
)
8896 err
+= efunc(pc
, "invalid variable %u\n", v
);
8898 err
+= efunc(pc
, "invalid register %u\n", rd
);
8901 if (subr
> DIF_SUBR_MAX
&&
8902 !(subr
>= DIF_SUBR_APPLE_MIN
&& subr
<= DIF_SUBR_APPLE_MAX
))
8903 err
+= efunc(pc
, "invalid subr %u\n", subr
);
8905 err
+= efunc(pc
, "invalid register %u\n", rd
);
8907 err
+= efunc(pc
, "cannot write to %r0\n");
8909 if (subr
== DIF_SUBR_COPYOUT
||
8910 subr
== DIF_SUBR_COPYOUTSTR
||
8911 subr
== DIF_SUBR_KDEBUG_TRACE
||
8912 subr
== DIF_SUBR_KDEBUG_TRACE_STRING
) {
8913 dp
->dtdo_destructive
= 1;
8917 if (type
!= DIF_TYPE_STRING
&& type
!= DIF_TYPE_CTF
)
8918 err
+= efunc(pc
, "invalid ref type %u\n", type
);
8920 err
+= efunc(pc
, "invalid register %u\n", r2
);
8922 err
+= efunc(pc
, "invalid register %u\n", rs
);
8925 if (type
!= DIF_TYPE_CTF
)
8926 err
+= efunc(pc
, "invalid val type %u\n", type
);
8928 err
+= efunc(pc
, "invalid register %u\n", r2
);
8930 err
+= efunc(pc
, "invalid register %u\n", rs
);
8933 err
+= efunc(pc
, "invalid opcode %u\n",
8934 DIF_INSTR_OP(instr
));
8938 if (dp
->dtdo_len
!= 0 &&
8939 DIF_INSTR_OP(dp
->dtdo_buf
[dp
->dtdo_len
- 1]) != DIF_OP_RET
) {
8940 err
+= efunc(dp
->dtdo_len
- 1,
8941 "expected 'ret' as last DIF instruction\n");
8944 if (!(dp
->dtdo_rtype
.dtdt_flags
& (DIF_TF_BYREF
| DIF_TF_BYUREF
))) {
8946 * If we're not returning by reference, the size must be either
8947 * 0 or the size of one of the base types.
8949 switch (dp
->dtdo_rtype
.dtdt_size
) {
8951 case sizeof (uint8_t):
8952 case sizeof (uint16_t):
8953 case sizeof (uint32_t):
8954 case sizeof (uint64_t):
8958 err
+= efunc(dp
->dtdo_len
- 1, "bad return size\n");
8962 for (i
= 0; i
< dp
->dtdo_varlen
&& err
== 0; i
++) {
8963 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
], *existing
= NULL
;
8964 dtrace_diftype_t
*vt
, *et
;
8968 if (v
->dtdv_scope
!= DIFV_SCOPE_GLOBAL
&&
8969 v
->dtdv_scope
!= DIFV_SCOPE_THREAD
&&
8970 v
->dtdv_scope
!= DIFV_SCOPE_LOCAL
) {
8971 err
+= efunc(i
, "unrecognized variable scope %d\n",
8976 if (v
->dtdv_kind
!= DIFV_KIND_ARRAY
&&
8977 v
->dtdv_kind
!= DIFV_KIND_SCALAR
) {
8978 err
+= efunc(i
, "unrecognized variable type %d\n",
8983 if ((id
= v
->dtdv_id
) > DIF_VARIABLE_MAX
) {
8984 err
+= efunc(i
, "%d exceeds variable id limit\n", id
);
8988 if (id
< DIF_VAR_OTHER_UBASE
)
8992 * For user-defined variables, we need to check that this
8993 * definition is identical to any previous definition that we
8996 ndx
= id
- DIF_VAR_OTHER_UBASE
;
8998 switch (v
->dtdv_scope
) {
8999 case DIFV_SCOPE_GLOBAL
:
9000 if (maxglobal
== -1 || ndx
> maxglobal
)
9003 if (ndx
< vstate
->dtvs_nglobals
) {
9004 dtrace_statvar_t
*svar
;
9006 if ((svar
= vstate
->dtvs_globals
[ndx
]) != NULL
)
9007 existing
= &svar
->dtsv_var
;
9012 case DIFV_SCOPE_THREAD
:
9013 if (maxtlocal
== -1 || ndx
> maxtlocal
)
9016 if (ndx
< vstate
->dtvs_ntlocals
)
9017 existing
= &vstate
->dtvs_tlocals
[ndx
];
9020 case DIFV_SCOPE_LOCAL
:
9021 if (maxlocal
== -1 || ndx
> maxlocal
)
9023 if (ndx
< vstate
->dtvs_nlocals
) {
9024 dtrace_statvar_t
*svar
;
9026 if ((svar
= vstate
->dtvs_locals
[ndx
]) != NULL
)
9027 existing
= &svar
->dtsv_var
;
9035 if (vt
->dtdt_flags
& DIF_TF_BYREF
) {
9036 if (vt
->dtdt_size
== 0) {
9037 err
+= efunc(i
, "zero-sized variable\n");
9041 if ((v
->dtdv_scope
== DIFV_SCOPE_GLOBAL
||
9042 v
->dtdv_scope
== DIFV_SCOPE_LOCAL
) &&
9043 vt
->dtdt_size
> dtrace_statvar_maxsize
) {
9044 err
+= efunc(i
, "oversized by-ref static\n");
9049 if (existing
== NULL
|| existing
->dtdv_id
== 0)
9052 ASSERT(existing
->dtdv_id
== v
->dtdv_id
);
9053 ASSERT(existing
->dtdv_scope
== v
->dtdv_scope
);
9055 if (existing
->dtdv_kind
!= v
->dtdv_kind
)
9056 err
+= efunc(i
, "%d changed variable kind\n", id
);
9058 et
= &existing
->dtdv_type
;
9060 if (vt
->dtdt_flags
!= et
->dtdt_flags
) {
9061 err
+= efunc(i
, "%d changed variable type flags\n", id
);
9065 if (vt
->dtdt_size
!= 0 && vt
->dtdt_size
!= et
->dtdt_size
) {
9066 err
+= efunc(i
, "%d changed variable type size\n", id
);
9071 for (pc
= 0; pc
< dp
->dtdo_len
&& err
== 0; pc
++) {
9072 dif_instr_t instr
= dp
->dtdo_buf
[pc
];
9074 uint_t v
= DIF_INSTR_VAR(instr
);
9075 uint_t op
= DIF_INSTR_OP(instr
);
9082 if (v
> (uint_t
)(DIF_VAR_OTHER_UBASE
+ maxglobal
))
9083 err
+= efunc(pc
, "invalid variable %u\n", v
);
9089 if (v
> (uint_t
)(DIF_VAR_OTHER_UBASE
+ maxtlocal
))
9090 err
+= efunc(pc
, "invalid variable %u\n", v
);
9094 if (v
> (uint_t
)(DIF_VAR_OTHER_UBASE
+ maxlocal
))
9095 err
+= efunc(pc
, "invalid variable %u\n", v
);
9106 * Validate a DTrace DIF object that it is to be used as a helper. Helpers
9107 * are much more constrained than normal DIFOs. Specifically, they may
9110 * 1. Make calls to subroutines other than copyin(), copyinstr() or
9111 * miscellaneous string routines
9112 * 2. Access DTrace variables other than the args[] array, and the
9113 * curthread, pid, ppid, tid, execname, zonename, uid and gid variables.
9114 * 3. Have thread-local variables.
9115 * 4. Have dynamic variables.
9118 dtrace_difo_validate_helper(dtrace_difo_t
*dp
)
9120 int (*efunc
)(uint_t pc
, const char *, ...) = dtrace_difo_err
;
9124 for (pc
= 0; pc
< dp
->dtdo_len
; pc
++) {
9125 dif_instr_t instr
= dp
->dtdo_buf
[pc
];
9127 uint_t v
= DIF_INSTR_VAR(instr
);
9128 uint_t subr
= DIF_INSTR_SUBR(instr
);
9129 uint_t op
= DIF_INSTR_OP(instr
);
9184 case DIF_OP_FLUSHTS
:
9196 if (v
>= DIF_VAR_OTHER_UBASE
)
9199 if (v
>= DIF_VAR_ARG0
&& v
<= DIF_VAR_ARG9
)
9202 if (v
== DIF_VAR_CURTHREAD
|| v
== DIF_VAR_PID
||
9203 v
== DIF_VAR_PPID
|| v
== DIF_VAR_TID
||
9204 v
== DIF_VAR_EXECNAME
|| v
== DIF_VAR_ZONENAME
||
9205 v
== DIF_VAR_UID
|| v
== DIF_VAR_GID
)
9208 err
+= efunc(pc
, "illegal variable %u\n", v
);
9215 err
+= efunc(pc
, "illegal dynamic variable load\n");
9221 err
+= efunc(pc
, "illegal dynamic variable store\n");
9225 if (subr
== DIF_SUBR_ALLOCA
||
9226 subr
== DIF_SUBR_BCOPY
||
9227 subr
== DIF_SUBR_COPYIN
||
9228 subr
== DIF_SUBR_COPYINTO
||
9229 subr
== DIF_SUBR_COPYINSTR
||
9230 subr
== DIF_SUBR_INDEX
||
9231 subr
== DIF_SUBR_INET_NTOA
||
9232 subr
== DIF_SUBR_INET_NTOA6
||
9233 subr
== DIF_SUBR_INET_NTOP
||
9234 subr
== DIF_SUBR_LLTOSTR
||
9235 subr
== DIF_SUBR_RINDEX
||
9236 subr
== DIF_SUBR_STRCHR
||
9237 subr
== DIF_SUBR_STRJOIN
||
9238 subr
== DIF_SUBR_STRRCHR
||
9239 subr
== DIF_SUBR_STRSTR
||
9240 subr
== DIF_SUBR_KDEBUG_TRACE
||
9241 subr
== DIF_SUBR_KDEBUG_TRACE_STRING
||
9242 subr
== DIF_SUBR_HTONS
||
9243 subr
== DIF_SUBR_HTONL
||
9244 subr
== DIF_SUBR_HTONLL
||
9245 subr
== DIF_SUBR_NTOHS
||
9246 subr
== DIF_SUBR_NTOHL
||
9247 subr
== DIF_SUBR_NTOHLL
)
9250 err
+= efunc(pc
, "invalid subr %u\n", subr
);
9254 err
+= efunc(pc
, "invalid opcode %u\n",
9255 DIF_INSTR_OP(instr
));
9263 * Returns 1 if the expression in the DIF object can be cached on a per-thread
9267 dtrace_difo_cacheable(dtrace_difo_t
*dp
)
9274 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9275 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9277 if (v
->dtdv_scope
!= DIFV_SCOPE_GLOBAL
)
9280 switch (v
->dtdv_id
) {
9281 case DIF_VAR_CURTHREAD
:
9284 case DIF_VAR_EXECNAME
:
9285 case DIF_VAR_ZONENAME
:
9294 * This DIF object may be cacheable. Now we need to look for any
9295 * array loading instructions, any memory loading instructions, or
9296 * any stores to thread-local variables.
9298 for (i
= 0; i
< dp
->dtdo_len
; i
++) {
9299 uint_t op
= DIF_INSTR_OP(dp
->dtdo_buf
[i
]);
9301 if ((op
>= DIF_OP_LDSB
&& op
<= DIF_OP_LDX
) ||
9302 (op
>= DIF_OP_ULDSB
&& op
<= DIF_OP_ULDX
) ||
9303 (op
>= DIF_OP_RLDSB
&& op
<= DIF_OP_RLDX
) ||
9304 op
== DIF_OP_LDGA
|| op
== DIF_OP_STTS
)
9312 dtrace_difo_hold(dtrace_difo_t
*dp
)
9316 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9319 ASSERT(dp
->dtdo_refcnt
!= 0);
9322 * We need to check this DIF object for references to the variable
9323 * DIF_VAR_VTIMESTAMP.
9325 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9326 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9328 if (v
->dtdv_id
!= DIF_VAR_VTIMESTAMP
)
9331 if (dtrace_vtime_references
++ == 0)
9332 dtrace_vtime_enable();
9337 * This routine calculates the dynamic variable chunksize for a given DIF
9338 * object. The calculation is not fool-proof, and can probably be tricked by
9339 * malicious DIF -- but it works for all compiler-generated DIF. Because this
9340 * calculation is likely imperfect, dtrace_dynvar() is able to gracefully fail
9341 * if a dynamic variable size exceeds the chunksize.
9344 dtrace_difo_chunksize(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
)
9347 dtrace_key_t tupregs
[DIF_DTR_NREGS
+ 2]; /* +2 for thread and id */
9348 const dif_instr_t
*text
= dp
->dtdo_buf
;
9354 for (pc
= 0; pc
< dp
->dtdo_len
; pc
++) {
9355 dif_instr_t instr
= text
[pc
];
9356 uint_t op
= DIF_INSTR_OP(instr
);
9357 uint_t rd
= DIF_INSTR_RD(instr
);
9358 uint_t r1
= DIF_INSTR_R1(instr
);
9362 dtrace_key_t
*key
= tupregs
;
9366 sval
= dp
->dtdo_inttab
[DIF_INSTR_INTEGER(instr
)];
9371 key
= &tupregs
[DIF_DTR_NREGS
];
9372 key
[0].dttk_size
= 0;
9373 key
[1].dttk_size
= 0;
9375 scope
= DIFV_SCOPE_THREAD
;
9382 if (DIF_INSTR_OP(instr
) == DIF_OP_STTAA
)
9383 key
[nkeys
++].dttk_size
= 0;
9385 key
[nkeys
++].dttk_size
= 0;
9387 if (op
== DIF_OP_STTAA
) {
9388 scope
= DIFV_SCOPE_THREAD
;
9390 scope
= DIFV_SCOPE_GLOBAL
;
9396 if (ttop
== DIF_DTR_NREGS
)
9399 if ((srd
== 0 || sval
== 0) && r1
== DIF_TYPE_STRING
) {
9401 * If the register for the size of the "pushtr"
9402 * is %r0 (or the value is 0) and the type is
9403 * a string, we'll use the system-wide default
9406 tupregs
[ttop
++].dttk_size
=
9407 dtrace_strsize_default
;
9412 if (sval
> LONG_MAX
)
9415 tupregs
[ttop
++].dttk_size
= sval
;
9421 if (ttop
== DIF_DTR_NREGS
)
9424 tupregs
[ttop
++].dttk_size
= 0;
9427 case DIF_OP_FLUSHTS
:
9444 * We have a dynamic variable allocation; calculate its size.
9446 for (ksize
= 0, i
= 0; i
< nkeys
; i
++)
9447 ksize
+= P2ROUNDUP(key
[i
].dttk_size
, sizeof (uint64_t));
9449 size
= sizeof (dtrace_dynvar_t
);
9450 size
+= sizeof (dtrace_key_t
) * (nkeys
- 1);
9454 * Now we need to determine the size of the stored data.
9456 id
= DIF_INSTR_VAR(instr
);
9458 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9459 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9461 if (v
->dtdv_id
== id
&& v
->dtdv_scope
== scope
) {
9462 size
+= v
->dtdv_type
.dtdt_size
;
9467 if (i
== dp
->dtdo_varlen
)
9471 * We have the size. If this is larger than the chunk size
9472 * for our dynamic variable state, reset the chunk size.
9474 size
= P2ROUNDUP(size
, sizeof (uint64_t));
9477 * Before setting the chunk size, check that we're not going
9478 * to set it to a negative value...
9480 if (size
> LONG_MAX
)
9484 * ...and make certain that we didn't badly overflow.
9486 if (size
< ksize
|| size
< sizeof (dtrace_dynvar_t
))
9489 if (size
> vstate
->dtvs_dynvars
.dtds_chunksize
)
9490 vstate
->dtvs_dynvars
.dtds_chunksize
= size
;
9495 dtrace_difo_init(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
)
9497 int oldsvars
, osz
, nsz
, otlocals
, ntlocals
;
9500 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9501 ASSERT(dp
->dtdo_buf
!= NULL
&& dp
->dtdo_len
!= 0);
9503 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9504 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9505 dtrace_statvar_t
*svar
;
9506 dtrace_statvar_t
***svarp
= NULL
;
9508 uint8_t scope
= v
->dtdv_scope
;
9509 int *np
= (int *)NULL
;
9511 if ((id
= v
->dtdv_id
) < DIF_VAR_OTHER_UBASE
)
9514 id
-= DIF_VAR_OTHER_UBASE
;
9517 case DIFV_SCOPE_THREAD
:
9518 while (id
>= (uint_t
)(otlocals
= vstate
->dtvs_ntlocals
)) {
9519 dtrace_difv_t
*tlocals
;
9521 if ((ntlocals
= (otlocals
<< 1)) == 0)
9524 osz
= otlocals
* sizeof (dtrace_difv_t
);
9525 nsz
= ntlocals
* sizeof (dtrace_difv_t
);
9527 tlocals
= kmem_zalloc(nsz
, KM_SLEEP
);
9530 bcopy(vstate
->dtvs_tlocals
,
9532 kmem_free(vstate
->dtvs_tlocals
, osz
);
9535 vstate
->dtvs_tlocals
= tlocals
;
9536 vstate
->dtvs_ntlocals
= ntlocals
;
9539 vstate
->dtvs_tlocals
[id
] = *v
;
9542 case DIFV_SCOPE_LOCAL
:
9543 np
= &vstate
->dtvs_nlocals
;
9544 svarp
= &vstate
->dtvs_locals
;
9546 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
)
9547 dsize
= (int)NCPU
* (v
->dtdv_type
.dtdt_size
+
9550 dsize
= (int)NCPU
* sizeof (uint64_t);
9554 case DIFV_SCOPE_GLOBAL
:
9555 np
= &vstate
->dtvs_nglobals
;
9556 svarp
= &vstate
->dtvs_globals
;
9558 if (v
->dtdv_type
.dtdt_flags
& DIF_TF_BYREF
)
9559 dsize
= v
->dtdv_type
.dtdt_size
+
9568 while (id
>= (uint_t
)(oldsvars
= *np
)) {
9569 dtrace_statvar_t
**statics
;
9570 int newsvars
, oldsize
, newsize
;
9572 if ((newsvars
= (oldsvars
<< 1)) == 0)
9575 oldsize
= oldsvars
* sizeof (dtrace_statvar_t
*);
9576 newsize
= newsvars
* sizeof (dtrace_statvar_t
*);
9578 statics
= kmem_zalloc(newsize
, KM_SLEEP
);
9581 bcopy(*svarp
, statics
, oldsize
);
9582 kmem_free(*svarp
, oldsize
);
9589 if ((svar
= (*svarp
)[id
]) == NULL
) {
9590 svar
= kmem_zalloc(sizeof (dtrace_statvar_t
), KM_SLEEP
);
9591 svar
->dtsv_var
= *v
;
9593 if ((svar
->dtsv_size
= dsize
) != 0) {
9594 svar
->dtsv_data
= (uint64_t)(uintptr_t)
9595 kmem_zalloc(dsize
, KM_SLEEP
);
9598 (*svarp
)[id
] = svar
;
9601 svar
->dtsv_refcnt
++;
9604 dtrace_difo_chunksize(dp
, vstate
);
9605 dtrace_difo_hold(dp
);
9608 static dtrace_difo_t
*
9609 dtrace_difo_duplicate(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
)
9614 ASSERT(dp
->dtdo_buf
!= NULL
);
9615 ASSERT(dp
->dtdo_refcnt
!= 0);
9617 new = kmem_zalloc(sizeof (dtrace_difo_t
), KM_SLEEP
);
9619 ASSERT(dp
->dtdo_buf
!= NULL
);
9620 sz
= dp
->dtdo_len
* sizeof (dif_instr_t
);
9621 new->dtdo_buf
= kmem_alloc(sz
, KM_SLEEP
);
9622 bcopy(dp
->dtdo_buf
, new->dtdo_buf
, sz
);
9623 new->dtdo_len
= dp
->dtdo_len
;
9625 if (dp
->dtdo_strtab
!= NULL
) {
9626 ASSERT(dp
->dtdo_strlen
!= 0);
9627 new->dtdo_strtab
= kmem_alloc(dp
->dtdo_strlen
, KM_SLEEP
);
9628 bcopy(dp
->dtdo_strtab
, new->dtdo_strtab
, dp
->dtdo_strlen
);
9629 new->dtdo_strlen
= dp
->dtdo_strlen
;
9632 if (dp
->dtdo_inttab
!= NULL
) {
9633 ASSERT(dp
->dtdo_intlen
!= 0);
9634 sz
= dp
->dtdo_intlen
* sizeof (uint64_t);
9635 new->dtdo_inttab
= kmem_alloc(sz
, KM_SLEEP
);
9636 bcopy(dp
->dtdo_inttab
, new->dtdo_inttab
, sz
);
9637 new->dtdo_intlen
= dp
->dtdo_intlen
;
9640 if (dp
->dtdo_vartab
!= NULL
) {
9641 ASSERT(dp
->dtdo_varlen
!= 0);
9642 sz
= dp
->dtdo_varlen
* sizeof (dtrace_difv_t
);
9643 new->dtdo_vartab
= kmem_alloc(sz
, KM_SLEEP
);
9644 bcopy(dp
->dtdo_vartab
, new->dtdo_vartab
, sz
);
9645 new->dtdo_varlen
= dp
->dtdo_varlen
;
9648 dtrace_difo_init(new, vstate
);
9653 dtrace_difo_destroy(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
)
9657 ASSERT(dp
->dtdo_refcnt
== 0);
9659 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9660 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9661 dtrace_statvar_t
*svar
;
9662 dtrace_statvar_t
**svarp
= NULL
;
9664 uint8_t scope
= v
->dtdv_scope
;
9668 case DIFV_SCOPE_THREAD
:
9671 case DIFV_SCOPE_LOCAL
:
9672 np
= &vstate
->dtvs_nlocals
;
9673 svarp
= vstate
->dtvs_locals
;
9676 case DIFV_SCOPE_GLOBAL
:
9677 np
= &vstate
->dtvs_nglobals
;
9678 svarp
= vstate
->dtvs_globals
;
9685 if ((id
= v
->dtdv_id
) < DIF_VAR_OTHER_UBASE
)
9688 id
-= DIF_VAR_OTHER_UBASE
;
9690 ASSERT(id
< (uint_t
)*np
);
9693 ASSERT(svar
!= NULL
);
9694 ASSERT(svar
->dtsv_refcnt
> 0);
9696 if (--svar
->dtsv_refcnt
> 0)
9699 if (svar
->dtsv_size
!= 0) {
9700 ASSERT(svar
->dtsv_data
!= 0);
9701 kmem_free((void *)(uintptr_t)svar
->dtsv_data
,
9705 kmem_free(svar
, sizeof (dtrace_statvar_t
));
9709 kmem_free(dp
->dtdo_buf
, dp
->dtdo_len
* sizeof (dif_instr_t
));
9710 kmem_free(dp
->dtdo_inttab
, dp
->dtdo_intlen
* sizeof (uint64_t));
9711 kmem_free(dp
->dtdo_strtab
, dp
->dtdo_strlen
);
9712 kmem_free(dp
->dtdo_vartab
, dp
->dtdo_varlen
* sizeof (dtrace_difv_t
));
9714 kmem_free(dp
, sizeof (dtrace_difo_t
));
9718 dtrace_difo_release(dtrace_difo_t
*dp
, dtrace_vstate_t
*vstate
)
9722 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9723 ASSERT(dp
->dtdo_refcnt
!= 0);
9725 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
9726 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
9728 if (v
->dtdv_id
!= DIF_VAR_VTIMESTAMP
)
9731 ASSERT(dtrace_vtime_references
> 0);
9732 if (--dtrace_vtime_references
== 0)
9733 dtrace_vtime_disable();
9736 if (--dp
->dtdo_refcnt
== 0)
9737 dtrace_difo_destroy(dp
, vstate
);
9741 * DTrace Format Functions
9744 dtrace_format_add(dtrace_state_t
*state
, char *str
)
9747 uint16_t ndx
, len
= strlen(str
) + 1;
9749 fmt
= kmem_zalloc(len
, KM_SLEEP
);
9750 bcopy(str
, fmt
, len
);
9752 for (ndx
= 0; ndx
< state
->dts_nformats
; ndx
++) {
9753 if (state
->dts_formats
[ndx
] == NULL
) {
9754 state
->dts_formats
[ndx
] = fmt
;
9759 if (state
->dts_nformats
== USHRT_MAX
) {
9761 * This is only likely if a denial-of-service attack is being
9762 * attempted. As such, it's okay to fail silently here.
9764 kmem_free(fmt
, len
);
9769 * For simplicity, we always resize the formats array to be exactly the
9770 * number of formats.
9772 ndx
= state
->dts_nformats
++;
9773 new = kmem_alloc((ndx
+ 1) * sizeof (char *), KM_SLEEP
);
9775 if (state
->dts_formats
!= NULL
) {
9777 bcopy(state
->dts_formats
, new, ndx
* sizeof (char *));
9778 kmem_free(state
->dts_formats
, ndx
* sizeof (char *));
9781 state
->dts_formats
= new;
9782 state
->dts_formats
[ndx
] = fmt
;
9788 dtrace_format_remove(dtrace_state_t
*state
, uint16_t format
)
9792 ASSERT(state
->dts_formats
!= NULL
);
9793 ASSERT(format
<= state
->dts_nformats
);
9794 ASSERT(state
->dts_formats
[format
- 1] != NULL
);
9796 fmt
= state
->dts_formats
[format
- 1];
9797 kmem_free(fmt
, strlen(fmt
) + 1);
9798 state
->dts_formats
[format
- 1] = NULL
;
9802 dtrace_format_destroy(dtrace_state_t
*state
)
9806 if (state
->dts_nformats
== 0) {
9807 ASSERT(state
->dts_formats
== NULL
);
9811 ASSERT(state
->dts_formats
!= NULL
);
9813 for (i
= 0; i
< state
->dts_nformats
; i
++) {
9814 char *fmt
= state
->dts_formats
[i
];
9819 kmem_free(fmt
, strlen(fmt
) + 1);
9822 kmem_free(state
->dts_formats
, state
->dts_nformats
* sizeof (char *));
9823 state
->dts_nformats
= 0;
9824 state
->dts_formats
= NULL
;
9828 * DTrace Predicate Functions
9830 static dtrace_predicate_t
*
9831 dtrace_predicate_create(dtrace_difo_t
*dp
)
9833 dtrace_predicate_t
*pred
;
9835 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9836 ASSERT(dp
->dtdo_refcnt
!= 0);
9838 pred
= kmem_zalloc(sizeof (dtrace_predicate_t
), KM_SLEEP
);
9839 pred
->dtp_difo
= dp
;
9840 pred
->dtp_refcnt
= 1;
9842 if (!dtrace_difo_cacheable(dp
))
9845 if (dtrace_predcache_id
== DTRACE_CACHEIDNONE
) {
9847 * This is only theoretically possible -- we have had 2^32
9848 * cacheable predicates on this machine. We cannot allow any
9849 * more predicates to become cacheable: as unlikely as it is,
9850 * there may be a thread caching a (now stale) predicate cache
9851 * ID. (N.B.: the temptation is being successfully resisted to
9852 * have this cmn_err() "Holy shit -- we executed this code!")
9857 pred
->dtp_cacheid
= dtrace_predcache_id
++;
9863 dtrace_predicate_hold(dtrace_predicate_t
*pred
)
9865 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9866 ASSERT(pred
->dtp_difo
!= NULL
&& pred
->dtp_difo
->dtdo_refcnt
!= 0);
9867 ASSERT(pred
->dtp_refcnt
> 0);
9873 dtrace_predicate_release(dtrace_predicate_t
*pred
, dtrace_vstate_t
*vstate
)
9875 dtrace_difo_t
*dp
= pred
->dtp_difo
;
9876 #pragma unused(dp) /* __APPLE__ */
9878 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9879 ASSERT(dp
!= NULL
&& dp
->dtdo_refcnt
!= 0);
9880 ASSERT(pred
->dtp_refcnt
> 0);
9882 if (--pred
->dtp_refcnt
== 0) {
9883 dtrace_difo_release(pred
->dtp_difo
, vstate
);
9884 kmem_free(pred
, sizeof (dtrace_predicate_t
));
9889 * DTrace Action Description Functions
9891 static dtrace_actdesc_t
*
9892 dtrace_actdesc_create(dtrace_actkind_t kind
, uint32_t ntuple
,
9893 uint64_t uarg
, uint64_t arg
)
9895 dtrace_actdesc_t
*act
;
9897 ASSERT(!DTRACEACT_ISPRINTFLIKE(kind
) || (arg
!= 0 &&
9898 arg
>= KERNELBASE
) || (arg
== 0 && kind
== DTRACEACT_PRINTA
));
9900 act
= kmem_zalloc(sizeof (dtrace_actdesc_t
), KM_SLEEP
);
9901 act
->dtad_kind
= kind
;
9902 act
->dtad_ntuple
= ntuple
;
9903 act
->dtad_uarg
= uarg
;
9904 act
->dtad_arg
= arg
;
9905 act
->dtad_refcnt
= 1;
9911 dtrace_actdesc_hold(dtrace_actdesc_t
*act
)
9913 ASSERT(act
->dtad_refcnt
>= 1);
9918 dtrace_actdesc_release(dtrace_actdesc_t
*act
, dtrace_vstate_t
*vstate
)
9920 dtrace_actkind_t kind
= act
->dtad_kind
;
9923 ASSERT(act
->dtad_refcnt
>= 1);
9925 if (--act
->dtad_refcnt
!= 0)
9928 if ((dp
= act
->dtad_difo
) != NULL
)
9929 dtrace_difo_release(dp
, vstate
);
9931 if (DTRACEACT_ISPRINTFLIKE(kind
)) {
9932 char *str
= (char *)(uintptr_t)act
->dtad_arg
;
9934 ASSERT((str
!= NULL
&& (uintptr_t)str
>= KERNELBASE
) ||
9935 (str
== NULL
&& act
->dtad_kind
== DTRACEACT_PRINTA
));
9938 kmem_free(str
, strlen(str
) + 1);
9941 kmem_free(act
, sizeof (dtrace_actdesc_t
));
9945 * DTrace ECB Functions
9947 static dtrace_ecb_t
*
9948 dtrace_ecb_add(dtrace_state_t
*state
, dtrace_probe_t
*probe
)
9953 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
9955 ecb
= kmem_zalloc(sizeof (dtrace_ecb_t
), KM_SLEEP
);
9956 ecb
->dte_predicate
= NULL
;
9957 ecb
->dte_probe
= probe
;
9960 * The default size is the size of the default action: recording
9963 ecb
->dte_size
= ecb
->dte_needed
= sizeof (dtrace_rechdr_t
);
9964 ecb
->dte_alignment
= sizeof (dtrace_epid_t
);
9966 epid
= state
->dts_epid
++;
9968 if (epid
- 1 >= (dtrace_epid_t
)state
->dts_necbs
) {
9969 dtrace_ecb_t
**oecbs
= state
->dts_ecbs
, **ecbs
;
9970 int necbs
= state
->dts_necbs
<< 1;
9972 ASSERT(epid
== (dtrace_epid_t
)state
->dts_necbs
+ 1);
9975 ASSERT(oecbs
== NULL
);
9979 ecbs
= kmem_zalloc(necbs
* sizeof (*ecbs
), KM_SLEEP
);
9982 bcopy(oecbs
, ecbs
, state
->dts_necbs
* sizeof (*ecbs
));
9984 dtrace_membar_producer();
9985 state
->dts_ecbs
= ecbs
;
9987 if (oecbs
!= NULL
) {
9989 * If this state is active, we must dtrace_sync()
9990 * before we can free the old dts_ecbs array: we're
9991 * coming in hot, and there may be active ring
9992 * buffer processing (which indexes into the dts_ecbs
9993 * array) on another CPU.
9995 if (state
->dts_activity
!= DTRACE_ACTIVITY_INACTIVE
)
9998 kmem_free(oecbs
, state
->dts_necbs
* sizeof (*ecbs
));
10001 dtrace_membar_producer();
10002 state
->dts_necbs
= necbs
;
10005 ecb
->dte_state
= state
;
10007 ASSERT(state
->dts_ecbs
[epid
- 1] == NULL
);
10008 dtrace_membar_producer();
10009 state
->dts_ecbs
[(ecb
->dte_epid
= epid
) - 1] = ecb
;
10015 dtrace_ecb_enable(dtrace_ecb_t
*ecb
)
10017 dtrace_probe_t
*probe
= ecb
->dte_probe
;
10019 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
10020 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10021 ASSERT(ecb
->dte_next
== NULL
);
10023 if (probe
== NULL
) {
10025 * This is the NULL probe -- there's nothing to do.
10030 probe
->dtpr_provider
->dtpv_ecb_count
++;
10031 if (probe
->dtpr_ecb
== NULL
) {
10032 dtrace_provider_t
*prov
= probe
->dtpr_provider
;
10035 * We're the first ECB on this probe.
10037 probe
->dtpr_ecb
= probe
->dtpr_ecb_last
= ecb
;
10039 if (ecb
->dte_predicate
!= NULL
)
10040 probe
->dtpr_predcache
= ecb
->dte_predicate
->dtp_cacheid
;
10042 return (prov
->dtpv_pops
.dtps_enable(prov
->dtpv_arg
,
10043 probe
->dtpr_id
, probe
->dtpr_arg
));
10046 * This probe is already active. Swing the last pointer to
10047 * point to the new ECB, and issue a dtrace_sync() to assure
10048 * that all CPUs have seen the change.
10050 ASSERT(probe
->dtpr_ecb_last
!= NULL
);
10051 probe
->dtpr_ecb_last
->dte_next
= ecb
;
10052 probe
->dtpr_ecb_last
= ecb
;
10053 probe
->dtpr_predcache
= 0;
10061 dtrace_ecb_resize(dtrace_ecb_t
*ecb
)
10063 dtrace_action_t
*act
;
10064 uint32_t curneeded
= UINT32_MAX
;
10065 uint32_t aggbase
= UINT32_MAX
;
10068 * If we record anything, we always record the dtrace_rechdr_t. (And
10069 * we always record it first.)
10071 ecb
->dte_size
= sizeof (dtrace_rechdr_t
);
10072 ecb
->dte_alignment
= sizeof (dtrace_epid_t
);
10074 for (act
= ecb
->dte_action
; act
!= NULL
; act
= act
->dta_next
) {
10075 dtrace_recdesc_t
*rec
= &act
->dta_rec
;
10076 ASSERT(rec
->dtrd_size
> 0 || rec
->dtrd_alignment
== 1);
10078 ecb
->dte_alignment
= MAX(ecb
->dte_alignment
, rec
->dtrd_alignment
);
10080 if (DTRACEACT_ISAGG(act
->dta_kind
)) {
10081 dtrace_aggregation_t
*agg
= (dtrace_aggregation_t
*)act
;
10083 ASSERT(rec
->dtrd_size
!= 0);
10084 ASSERT(agg
->dtag_first
!= NULL
);
10085 ASSERT(act
->dta_prev
->dta_intuple
);
10086 ASSERT(aggbase
!= UINT32_MAX
);
10087 ASSERT(curneeded
!= UINT32_MAX
);
10089 agg
->dtag_base
= aggbase
;
10090 curneeded
= P2ROUNDUP(curneeded
, rec
->dtrd_alignment
);
10091 rec
->dtrd_offset
= curneeded
;
10092 if (curneeded
+ rec
->dtrd_size
< curneeded
)
10094 curneeded
+= rec
->dtrd_size
;
10095 ecb
->dte_needed
= MAX(ecb
->dte_needed
, curneeded
);
10097 aggbase
= UINT32_MAX
;
10098 curneeded
= UINT32_MAX
;
10099 } else if (act
->dta_intuple
) {
10100 if (curneeded
== UINT32_MAX
) {
10102 * This is the first record in a tuple. Align
10103 * curneeded to be at offset 4 in an 8-byte
10106 ASSERT(act
->dta_prev
== NULL
|| !act
->dta_prev
->dta_intuple
);
10107 ASSERT(aggbase
== UINT32_MAX
);
10109 curneeded
= P2PHASEUP(ecb
->dte_size
,
10110 sizeof (uint64_t), sizeof (dtrace_aggid_t
));
10112 aggbase
= curneeded
- sizeof (dtrace_aggid_t
);
10113 ASSERT(IS_P2ALIGNED(aggbase
,
10114 sizeof (uint64_t)));
10117 curneeded
= P2ROUNDUP(curneeded
, rec
->dtrd_alignment
);
10118 rec
->dtrd_offset
= curneeded
;
10119 curneeded
+= rec
->dtrd_size
;
10120 if (curneeded
+ rec
->dtrd_size
< curneeded
)
10123 /* tuples must be followed by an aggregation */
10124 ASSERT(act
->dta_prev
== NULL
|| !act
->dta_prev
->dta_intuple
);
10125 ecb
->dte_size
= P2ROUNDUP(ecb
->dte_size
, rec
->dtrd_alignment
);
10126 rec
->dtrd_offset
= ecb
->dte_size
;
10127 if (ecb
->dte_size
+ rec
->dtrd_size
< ecb
->dte_size
)
10129 ecb
->dte_size
+= rec
->dtrd_size
;
10130 ecb
->dte_needed
= MAX(ecb
->dte_needed
, ecb
->dte_size
);
10134 if ((act
= ecb
->dte_action
) != NULL
&&
10135 !(act
->dta_kind
== DTRACEACT_SPECULATE
&& act
->dta_next
== NULL
) &&
10136 ecb
->dte_size
== sizeof (dtrace_rechdr_t
)) {
10138 * If the size is still sizeof (dtrace_rechdr_t), then all
10139 * actions store no data; set the size to 0.
10144 ecb
->dte_size
= P2ROUNDUP(ecb
->dte_size
, sizeof (dtrace_epid_t
));
10145 ecb
->dte_needed
= P2ROUNDUP(ecb
->dte_needed
, (sizeof (dtrace_epid_t
)));
10146 ecb
->dte_state
->dts_needed
= MAX(ecb
->dte_state
->dts_needed
, ecb
->dte_needed
);
10150 static dtrace_action_t
*
10151 dtrace_ecb_aggregation_create(dtrace_ecb_t
*ecb
, dtrace_actdesc_t
*desc
)
10153 dtrace_aggregation_t
*agg
;
10154 size_t size
= sizeof (uint64_t);
10155 int ntuple
= desc
->dtad_ntuple
;
10156 dtrace_action_t
*act
;
10157 dtrace_recdesc_t
*frec
;
10158 dtrace_aggid_t aggid
;
10159 dtrace_state_t
*state
= ecb
->dte_state
;
10161 agg
= kmem_zalloc(sizeof (dtrace_aggregation_t
), KM_SLEEP
);
10162 agg
->dtag_ecb
= ecb
;
10164 ASSERT(DTRACEACT_ISAGG(desc
->dtad_kind
));
10166 switch (desc
->dtad_kind
) {
10167 case DTRACEAGG_MIN
:
10168 agg
->dtag_initial
= INT64_MAX
;
10169 agg
->dtag_aggregate
= dtrace_aggregate_min
;
10172 case DTRACEAGG_MAX
:
10173 agg
->dtag_initial
= INT64_MIN
;
10174 agg
->dtag_aggregate
= dtrace_aggregate_max
;
10177 case DTRACEAGG_COUNT
:
10178 agg
->dtag_aggregate
= dtrace_aggregate_count
;
10181 case DTRACEAGG_QUANTIZE
:
10182 agg
->dtag_aggregate
= dtrace_aggregate_quantize
;
10183 size
= (((sizeof (uint64_t) * NBBY
) - 1) * 2 + 1) *
10187 case DTRACEAGG_LQUANTIZE
: {
10188 uint16_t step
= DTRACE_LQUANTIZE_STEP(desc
->dtad_arg
);
10189 uint16_t levels
= DTRACE_LQUANTIZE_LEVELS(desc
->dtad_arg
);
10191 agg
->dtag_initial
= desc
->dtad_arg
;
10192 agg
->dtag_aggregate
= dtrace_aggregate_lquantize
;
10194 if (step
== 0 || levels
== 0)
10197 size
= levels
* sizeof (uint64_t) + 3 * sizeof (uint64_t);
10201 case DTRACEAGG_LLQUANTIZE
: {
10202 uint16_t factor
= DTRACE_LLQUANTIZE_FACTOR(desc
->dtad_arg
);
10203 uint16_t low
= DTRACE_LLQUANTIZE_LOW(desc
->dtad_arg
);
10204 uint16_t high
= DTRACE_LLQUANTIZE_HIGH(desc
->dtad_arg
);
10205 uint16_t nsteps
= DTRACE_LLQUANTIZE_NSTEP(desc
->dtad_arg
);
10208 agg
->dtag_initial
= desc
->dtad_arg
;
10209 agg
->dtag_aggregate
= dtrace_aggregate_llquantize
;
10211 if (factor
< 2 || low
>= high
|| nsteps
< factor
)
10215 * Now check that the number of steps evenly divides a power
10216 * of the factor. (This assures both integer bucket size and
10217 * linearity within each magnitude.)
10219 for (v
= factor
; v
< nsteps
; v
*= factor
)
10222 if ((v
% nsteps
) || (nsteps
% factor
))
10225 size
= (dtrace_aggregate_llquantize_bucket(factor
, low
, high
, nsteps
, INT64_MAX
) + 2) * sizeof (uint64_t);
10229 case DTRACEAGG_AVG
:
10230 agg
->dtag_aggregate
= dtrace_aggregate_avg
;
10231 size
= sizeof (uint64_t) * 2;
10234 case DTRACEAGG_STDDEV
:
10235 agg
->dtag_aggregate
= dtrace_aggregate_stddev
;
10236 size
= sizeof (uint64_t) * 4;
10239 case DTRACEAGG_SUM
:
10240 agg
->dtag_aggregate
= dtrace_aggregate_sum
;
10247 agg
->dtag_action
.dta_rec
.dtrd_size
= size
;
10253 * We must make sure that we have enough actions for the n-tuple.
10255 for (act
= ecb
->dte_action_last
; act
!= NULL
; act
= act
->dta_prev
) {
10256 if (DTRACEACT_ISAGG(act
->dta_kind
))
10259 if (--ntuple
== 0) {
10261 * This is the action with which our n-tuple begins.
10263 agg
->dtag_first
= act
;
10269 * This n-tuple is short by ntuple elements. Return failure.
10271 ASSERT(ntuple
!= 0);
10273 kmem_free(agg
, sizeof (dtrace_aggregation_t
));
10278 * If the last action in the tuple has a size of zero, it's actually
10279 * an expression argument for the aggregating action.
10281 ASSERT(ecb
->dte_action_last
!= NULL
);
10282 act
= ecb
->dte_action_last
;
10284 if (act
->dta_kind
== DTRACEACT_DIFEXPR
) {
10285 ASSERT(act
->dta_difo
!= NULL
);
10287 if (act
->dta_difo
->dtdo_rtype
.dtdt_size
== 0)
10288 agg
->dtag_hasarg
= 1;
10292 * We need to allocate an id for this aggregation.
10294 aggid
= (dtrace_aggid_t
)(uintptr_t)vmem_alloc(state
->dts_aggid_arena
, 1,
10295 VM_BESTFIT
| VM_SLEEP
);
10297 if (aggid
- 1 >= (dtrace_aggid_t
)state
->dts_naggregations
) {
10298 dtrace_aggregation_t
**oaggs
= state
->dts_aggregations
;
10299 dtrace_aggregation_t
**aggs
;
10300 int naggs
= state
->dts_naggregations
<< 1;
10301 int onaggs
= state
->dts_naggregations
;
10303 ASSERT(aggid
== (dtrace_aggid_t
)state
->dts_naggregations
+ 1);
10306 ASSERT(oaggs
== NULL
);
10310 aggs
= kmem_zalloc(naggs
* sizeof (*aggs
), KM_SLEEP
);
10312 if (oaggs
!= NULL
) {
10313 bcopy(oaggs
, aggs
, onaggs
* sizeof (*aggs
));
10314 kmem_free(oaggs
, onaggs
* sizeof (*aggs
));
10317 state
->dts_aggregations
= aggs
;
10318 state
->dts_naggregations
= naggs
;
10321 ASSERT(state
->dts_aggregations
[aggid
- 1] == NULL
);
10322 state
->dts_aggregations
[(agg
->dtag_id
= aggid
) - 1] = agg
;
10324 frec
= &agg
->dtag_first
->dta_rec
;
10325 if (frec
->dtrd_alignment
< sizeof (dtrace_aggid_t
))
10326 frec
->dtrd_alignment
= sizeof (dtrace_aggid_t
);
10328 for (act
= agg
->dtag_first
; act
!= NULL
; act
= act
->dta_next
) {
10329 ASSERT(!act
->dta_intuple
);
10330 act
->dta_intuple
= 1;
10333 return (&agg
->dtag_action
);
10337 dtrace_ecb_aggregation_destroy(dtrace_ecb_t
*ecb
, dtrace_action_t
*act
)
10339 dtrace_aggregation_t
*agg
= (dtrace_aggregation_t
*)act
;
10340 dtrace_state_t
*state
= ecb
->dte_state
;
10341 dtrace_aggid_t aggid
= agg
->dtag_id
;
10343 ASSERT(DTRACEACT_ISAGG(act
->dta_kind
));
10344 vmem_free(state
->dts_aggid_arena
, (void *)(uintptr_t)aggid
, 1);
10346 ASSERT(state
->dts_aggregations
[aggid
- 1] == agg
);
10347 state
->dts_aggregations
[aggid
- 1] = NULL
;
10349 kmem_free(agg
, sizeof (dtrace_aggregation_t
));
10353 dtrace_ecb_action_add(dtrace_ecb_t
*ecb
, dtrace_actdesc_t
*desc
)
10355 dtrace_action_t
*action
, *last
;
10356 dtrace_difo_t
*dp
= desc
->dtad_difo
;
10357 uint32_t size
= 0, align
= sizeof (uint8_t), mask
;
10358 uint16_t format
= 0;
10359 dtrace_recdesc_t
*rec
;
10360 dtrace_state_t
*state
= ecb
->dte_state
;
10361 dtrace_optval_t
*opt
= state
->dts_options
;
10362 dtrace_optval_t nframes
=0, strsize
;
10363 uint64_t arg
= desc
->dtad_arg
;
10365 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10366 ASSERT(ecb
->dte_action
== NULL
|| ecb
->dte_action
->dta_refcnt
== 1);
10368 if (DTRACEACT_ISAGG(desc
->dtad_kind
)) {
10370 * If this is an aggregating action, there must be neither
10371 * a speculate nor a commit on the action chain.
10373 dtrace_action_t
*act
;
10375 for (act
= ecb
->dte_action
; act
!= NULL
; act
= act
->dta_next
) {
10376 if (act
->dta_kind
== DTRACEACT_COMMIT
)
10379 if (act
->dta_kind
== DTRACEACT_SPECULATE
)
10383 action
= dtrace_ecb_aggregation_create(ecb
, desc
);
10385 if (action
== NULL
)
10388 if (DTRACEACT_ISDESTRUCTIVE(desc
->dtad_kind
) ||
10389 (desc
->dtad_kind
== DTRACEACT_DIFEXPR
&&
10390 dp
!= NULL
&& dp
->dtdo_destructive
)) {
10391 state
->dts_destructive
= 1;
10394 switch (desc
->dtad_kind
) {
10395 case DTRACEACT_PRINTF
:
10396 case DTRACEACT_PRINTA
:
10397 case DTRACEACT_SYSTEM
:
10398 case DTRACEACT_FREOPEN
:
10399 case DTRACEACT_DIFEXPR
:
10401 * We know that our arg is a string -- turn it into a
10405 ASSERT(desc
->dtad_kind
== DTRACEACT_PRINTA
||
10406 desc
->dtad_kind
== DTRACEACT_DIFEXPR
);
10410 ASSERT(arg
> KERNELBASE
);
10411 format
= dtrace_format_add(state
,
10412 (char *)(uintptr_t)arg
);
10416 case DTRACEACT_LIBACT
:
10417 case DTRACEACT_TRACEMEM
:
10418 case DTRACEACT_TRACEMEM_DYNSIZE
:
10419 case DTRACEACT_APPLEBINARY
: /* __APPLE__ */
10423 if ((size
= dp
->dtdo_rtype
.dtdt_size
) != 0)
10426 if (dp
->dtdo_rtype
.dtdt_kind
== DIF_TYPE_STRING
) {
10427 if (!(dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
))
10430 size
= opt
[DTRACEOPT_STRSIZE
];
10435 case DTRACEACT_STACK
:
10436 if ((nframes
= arg
) == 0) {
10437 nframes
= opt
[DTRACEOPT_STACKFRAMES
];
10438 ASSERT(nframes
> 0);
10442 size
= nframes
* sizeof (pc_t
);
10445 case DTRACEACT_JSTACK
:
10446 if ((strsize
= DTRACE_USTACK_STRSIZE(arg
)) == 0)
10447 strsize
= opt
[DTRACEOPT_JSTACKSTRSIZE
];
10449 if ((nframes
= DTRACE_USTACK_NFRAMES(arg
)) == 0)
10450 nframes
= opt
[DTRACEOPT_JSTACKFRAMES
];
10452 arg
= DTRACE_USTACK_ARG(nframes
, strsize
);
10455 case DTRACEACT_USTACK
:
10456 if (desc
->dtad_kind
!= DTRACEACT_JSTACK
&&
10457 (nframes
= DTRACE_USTACK_NFRAMES(arg
)) == 0) {
10458 strsize
= DTRACE_USTACK_STRSIZE(arg
);
10459 nframes
= opt
[DTRACEOPT_USTACKFRAMES
];
10460 ASSERT(nframes
> 0);
10461 arg
= DTRACE_USTACK_ARG(nframes
, strsize
);
10465 * Save a slot for the pid.
10467 size
= (nframes
+ 1) * sizeof (uint64_t);
10468 size
+= DTRACE_USTACK_STRSIZE(arg
);
10469 size
= P2ROUNDUP(size
, (uint32_t)(sizeof (uintptr_t)));
10473 case DTRACEACT_SYM
:
10474 case DTRACEACT_MOD
:
10475 if (dp
== NULL
|| ((size
= dp
->dtdo_rtype
.dtdt_size
) !=
10476 sizeof (uint64_t)) ||
10477 (dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
))
10481 case DTRACEACT_USYM
:
10482 case DTRACEACT_UMOD
:
10483 case DTRACEACT_UADDR
:
10485 (dp
->dtdo_rtype
.dtdt_size
!= sizeof (uint64_t)) ||
10486 (dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
))
10490 * We have a slot for the pid, plus a slot for the
10491 * argument. To keep things simple (aligned with
10492 * bitness-neutral sizing), we store each as a 64-bit
10495 size
= 2 * sizeof (uint64_t);
10498 case DTRACEACT_STOP
:
10499 case DTRACEACT_BREAKPOINT
:
10500 case DTRACEACT_PANIC
:
10503 case DTRACEACT_CHILL
:
10504 case DTRACEACT_DISCARD
:
10505 case DTRACEACT_RAISE
:
10506 case DTRACEACT_PIDRESUME
: /* __APPLE__ */
10511 case DTRACEACT_EXIT
:
10513 (size
= dp
->dtdo_rtype
.dtdt_size
) != sizeof (int) ||
10514 (dp
->dtdo_rtype
.dtdt_flags
& DIF_TF_BYREF
))
10518 case DTRACEACT_SPECULATE
:
10519 if (ecb
->dte_size
> sizeof (dtrace_rechdr_t
))
10525 state
->dts_speculates
= 1;
10528 case DTRACEACT_COMMIT
: {
10529 dtrace_action_t
*act
= ecb
->dte_action
;
10531 for (; act
!= NULL
; act
= act
->dta_next
) {
10532 if (act
->dta_kind
== DTRACEACT_COMMIT
)
10545 if (size
!= 0 || desc
->dtad_kind
== DTRACEACT_SPECULATE
) {
10547 * If this is a data-storing action or a speculate,
10548 * we must be sure that there isn't a commit on the
10551 dtrace_action_t
*act
= ecb
->dte_action
;
10553 for (; act
!= NULL
; act
= act
->dta_next
) {
10554 if (act
->dta_kind
== DTRACEACT_COMMIT
)
10559 action
= kmem_zalloc(sizeof (dtrace_action_t
), KM_SLEEP
);
10560 action
->dta_rec
.dtrd_size
= size
;
10563 action
->dta_refcnt
= 1;
10564 rec
= &action
->dta_rec
;
10565 size
= rec
->dtrd_size
;
10567 for (mask
= sizeof (uint64_t) - 1; size
!= 0 && mask
> 0; mask
>>= 1) {
10568 if (!(size
& mask
)) {
10574 action
->dta_kind
= desc
->dtad_kind
;
10576 if ((action
->dta_difo
= dp
) != NULL
)
10577 dtrace_difo_hold(dp
);
10579 rec
->dtrd_action
= action
->dta_kind
;
10580 rec
->dtrd_arg
= arg
;
10581 rec
->dtrd_uarg
= desc
->dtad_uarg
;
10582 rec
->dtrd_alignment
= (uint16_t)align
;
10583 rec
->dtrd_format
= format
;
10585 if ((last
= ecb
->dte_action_last
) != NULL
) {
10586 ASSERT(ecb
->dte_action
!= NULL
);
10587 action
->dta_prev
= last
;
10588 last
->dta_next
= action
;
10590 ASSERT(ecb
->dte_action
== NULL
);
10591 ecb
->dte_action
= action
;
10594 ecb
->dte_action_last
= action
;
10600 dtrace_ecb_action_remove(dtrace_ecb_t
*ecb
)
10602 dtrace_action_t
*act
= ecb
->dte_action
, *next
;
10603 dtrace_vstate_t
*vstate
= &ecb
->dte_state
->dts_vstate
;
10607 if (act
!= NULL
&& act
->dta_refcnt
> 1) {
10608 ASSERT(act
->dta_next
== NULL
|| act
->dta_next
->dta_refcnt
== 1);
10611 for (; act
!= NULL
; act
= next
) {
10612 next
= act
->dta_next
;
10613 ASSERT(next
!= NULL
|| act
== ecb
->dte_action_last
);
10614 ASSERT(act
->dta_refcnt
== 1);
10616 if ((format
= act
->dta_rec
.dtrd_format
) != 0)
10617 dtrace_format_remove(ecb
->dte_state
, format
);
10619 if ((dp
= act
->dta_difo
) != NULL
)
10620 dtrace_difo_release(dp
, vstate
);
10622 if (DTRACEACT_ISAGG(act
->dta_kind
)) {
10623 dtrace_ecb_aggregation_destroy(ecb
, act
);
10625 kmem_free(act
, sizeof (dtrace_action_t
));
10630 ecb
->dte_action
= NULL
;
10631 ecb
->dte_action_last
= NULL
;
10636 dtrace_ecb_disable(dtrace_ecb_t
*ecb
)
10639 * We disable the ECB by removing it from its probe.
10641 dtrace_ecb_t
*pecb
, *prev
= NULL
;
10642 dtrace_probe_t
*probe
= ecb
->dte_probe
;
10644 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10646 if (probe
== NULL
) {
10648 * This is the NULL probe; there is nothing to disable.
10653 for (pecb
= probe
->dtpr_ecb
; pecb
!= NULL
; pecb
= pecb
->dte_next
) {
10659 ASSERT(pecb
!= NULL
);
10661 if (prev
== NULL
) {
10662 probe
->dtpr_ecb
= ecb
->dte_next
;
10664 prev
->dte_next
= ecb
->dte_next
;
10667 if (ecb
== probe
->dtpr_ecb_last
) {
10668 ASSERT(ecb
->dte_next
== NULL
);
10669 probe
->dtpr_ecb_last
= prev
;
10672 probe
->dtpr_provider
->dtpv_ecb_count
--;
10674 * The ECB has been disconnected from the probe; now sync to assure
10675 * that all CPUs have seen the change before returning.
10679 if (probe
->dtpr_ecb
== NULL
) {
10681 * That was the last ECB on the probe; clear the predicate
10682 * cache ID for the probe, disable it and sync one more time
10683 * to assure that we'll never hit it again.
10685 dtrace_provider_t
*prov
= probe
->dtpr_provider
;
10687 ASSERT(ecb
->dte_next
== NULL
);
10688 ASSERT(probe
->dtpr_ecb_last
== NULL
);
10689 probe
->dtpr_predcache
= DTRACE_CACHEIDNONE
;
10690 prov
->dtpv_pops
.dtps_disable(prov
->dtpv_arg
,
10691 probe
->dtpr_id
, probe
->dtpr_arg
);
10695 * There is at least one ECB remaining on the probe. If there
10696 * is _exactly_ one, set the probe's predicate cache ID to be
10697 * the predicate cache ID of the remaining ECB.
10699 ASSERT(probe
->dtpr_ecb_last
!= NULL
);
10700 ASSERT(probe
->dtpr_predcache
== DTRACE_CACHEIDNONE
);
10702 if (probe
->dtpr_ecb
== probe
->dtpr_ecb_last
) {
10703 dtrace_predicate_t
*p
= probe
->dtpr_ecb
->dte_predicate
;
10705 ASSERT(probe
->dtpr_ecb
->dte_next
== NULL
);
10708 probe
->dtpr_predcache
= p
->dtp_cacheid
;
10711 ecb
->dte_next
= NULL
;
10716 dtrace_ecb_destroy(dtrace_ecb_t
*ecb
)
10718 dtrace_state_t
*state
= ecb
->dte_state
;
10719 dtrace_vstate_t
*vstate
= &state
->dts_vstate
;
10720 dtrace_predicate_t
*pred
;
10721 dtrace_epid_t epid
= ecb
->dte_epid
;
10723 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10724 ASSERT(ecb
->dte_next
== NULL
);
10725 ASSERT(ecb
->dte_probe
== NULL
|| ecb
->dte_probe
->dtpr_ecb
!= ecb
);
10727 if ((pred
= ecb
->dte_predicate
) != NULL
)
10728 dtrace_predicate_release(pred
, vstate
);
10730 dtrace_ecb_action_remove(ecb
);
10732 ASSERT(state
->dts_ecbs
[epid
- 1] == ecb
);
10733 state
->dts_ecbs
[epid
- 1] = NULL
;
10735 kmem_free(ecb
, sizeof (dtrace_ecb_t
));
10738 static dtrace_ecb_t
*
10739 dtrace_ecb_create(dtrace_state_t
*state
, dtrace_probe_t
*probe
,
10740 dtrace_enabling_t
*enab
)
10743 dtrace_predicate_t
*pred
;
10744 dtrace_actdesc_t
*act
;
10745 dtrace_provider_t
*prov
;
10746 dtrace_ecbdesc_t
*desc
= enab
->dten_current
;
10748 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10749 ASSERT(state
!= NULL
);
10751 ecb
= dtrace_ecb_add(state
, probe
);
10752 ecb
->dte_uarg
= desc
->dted_uarg
;
10754 if ((pred
= desc
->dted_pred
.dtpdd_predicate
) != NULL
) {
10755 dtrace_predicate_hold(pred
);
10756 ecb
->dte_predicate
= pred
;
10759 if (probe
!= NULL
) {
10761 * If the provider shows more leg than the consumer is old
10762 * enough to see, we need to enable the appropriate implicit
10763 * predicate bits to prevent the ecb from activating at
10766 * Providers specifying DTRACE_PRIV_USER at register time
10767 * are stating that they need the /proc-style privilege
10768 * model to be enforced, and this is what DTRACE_COND_OWNER
10769 * and DTRACE_COND_ZONEOWNER will then do at probe time.
10771 prov
= probe
->dtpr_provider
;
10772 if (!(state
->dts_cred
.dcr_visible
& DTRACE_CRV_ALLPROC
) &&
10773 (prov
->dtpv_priv
.dtpp_flags
& DTRACE_PRIV_USER
))
10774 ecb
->dte_cond
|= DTRACE_COND_OWNER
;
10776 if (!(state
->dts_cred
.dcr_visible
& DTRACE_CRV_ALLZONE
) &&
10777 (prov
->dtpv_priv
.dtpp_flags
& DTRACE_PRIV_USER
))
10778 ecb
->dte_cond
|= DTRACE_COND_ZONEOWNER
;
10781 * If the provider shows us kernel innards and the user
10782 * is lacking sufficient privilege, enable the
10783 * DTRACE_COND_USERMODE implicit predicate.
10785 if (!(state
->dts_cred
.dcr_visible
& DTRACE_CRV_KERNEL
) &&
10786 (prov
->dtpv_priv
.dtpp_flags
& DTRACE_PRIV_KERNEL
))
10787 ecb
->dte_cond
|= DTRACE_COND_USERMODE
;
10790 if (dtrace_ecb_create_cache
!= NULL
) {
10792 * If we have a cached ecb, we'll use its action list instead
10793 * of creating our own (saving both time and space).
10795 dtrace_ecb_t
*cached
= dtrace_ecb_create_cache
;
10796 dtrace_action_t
*act_if
= cached
->dte_action
;
10798 if (act_if
!= NULL
) {
10799 ASSERT(act_if
->dta_refcnt
> 0);
10800 act_if
->dta_refcnt
++;
10801 ecb
->dte_action
= act_if
;
10802 ecb
->dte_action_last
= cached
->dte_action_last
;
10803 ecb
->dte_needed
= cached
->dte_needed
;
10804 ecb
->dte_size
= cached
->dte_size
;
10805 ecb
->dte_alignment
= cached
->dte_alignment
;
10811 for (act
= desc
->dted_action
; act
!= NULL
; act
= act
->dtad_next
) {
10812 if ((enab
->dten_error
= dtrace_ecb_action_add(ecb
, act
)) != 0) {
10813 dtrace_ecb_destroy(ecb
);
10818 if ((enab
->dten_error
= dtrace_ecb_resize(ecb
)) != 0) {
10819 dtrace_ecb_destroy(ecb
);
10823 return (dtrace_ecb_create_cache
= ecb
);
10827 dtrace_ecb_create_enable(dtrace_probe_t
*probe
, void *arg
)
10830 dtrace_enabling_t
*enab
= arg
;
10831 dtrace_state_t
*state
= enab
->dten_vstate
->dtvs_state
;
10833 ASSERT(state
!= NULL
);
10835 if (probe
!= NULL
&& probe
->dtpr_gen
< enab
->dten_probegen
) {
10837 * This probe was created in a generation for which this
10838 * enabling has previously created ECBs; we don't want to
10839 * enable it again, so just kick out.
10841 return (DTRACE_MATCH_NEXT
);
10844 if ((ecb
= dtrace_ecb_create(state
, probe
, enab
)) == NULL
)
10845 return (DTRACE_MATCH_DONE
);
10847 if (dtrace_ecb_enable(ecb
) < 0)
10848 return (DTRACE_MATCH_FAIL
);
10850 return (DTRACE_MATCH_NEXT
);
10853 static dtrace_ecb_t
*
10854 dtrace_epid2ecb(dtrace_state_t
*state
, dtrace_epid_t id
)
10857 #pragma unused(ecb) /* __APPLE__ */
10859 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10861 if (id
== 0 || id
> (dtrace_epid_t
)state
->dts_necbs
)
10864 ASSERT(state
->dts_necbs
> 0 && state
->dts_ecbs
!= NULL
);
10865 ASSERT((ecb
= state
->dts_ecbs
[id
- 1]) == NULL
|| ecb
->dte_epid
== id
);
10867 return (state
->dts_ecbs
[id
- 1]);
10870 static dtrace_aggregation_t
*
10871 dtrace_aggid2agg(dtrace_state_t
*state
, dtrace_aggid_t id
)
10873 dtrace_aggregation_t
*agg
;
10874 #pragma unused(agg) /* __APPLE__ */
10876 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10878 if (id
== 0 || id
> (dtrace_aggid_t
)state
->dts_naggregations
)
10881 ASSERT(state
->dts_naggregations
> 0 && state
->dts_aggregations
!= NULL
);
10882 ASSERT((agg
= state
->dts_aggregations
[id
- 1]) == NULL
||
10883 agg
->dtag_id
== id
);
10885 return (state
->dts_aggregations
[id
- 1]);
10889 * DTrace Buffer Functions
10891 * The following functions manipulate DTrace buffers. Most of these functions
10892 * are called in the context of establishing or processing consumer state;
10893 * exceptions are explicitly noted.
10897 * Note: called from cross call context. This function switches the two
10898 * buffers on a given CPU. The atomicity of this operation is assured by
10899 * disabling interrupts while the actual switch takes place; the disabling of
10900 * interrupts serializes the execution with any execution of dtrace_probe() on
10904 dtrace_buffer_switch(dtrace_buffer_t
*buf
)
10906 caddr_t tomax
= buf
->dtb_tomax
;
10907 caddr_t xamot
= buf
->dtb_xamot
;
10908 dtrace_icookie_t cookie
;
10911 ASSERT(!(buf
->dtb_flags
& DTRACEBUF_NOSWITCH
));
10912 ASSERT(!(buf
->dtb_flags
& DTRACEBUF_RING
));
10914 cookie
= dtrace_interrupt_disable();
10915 now
= dtrace_gethrtime();
10916 buf
->dtb_tomax
= xamot
;
10917 buf
->dtb_xamot
= tomax
;
10918 buf
->dtb_xamot_drops
= buf
->dtb_drops
;
10919 buf
->dtb_xamot_offset
= buf
->dtb_offset
;
10920 buf
->dtb_xamot_errors
= buf
->dtb_errors
;
10921 buf
->dtb_xamot_flags
= buf
->dtb_flags
;
10922 buf
->dtb_offset
= 0;
10923 buf
->dtb_drops
= 0;
10924 buf
->dtb_errors
= 0;
10925 buf
->dtb_flags
&= ~(DTRACEBUF_ERROR
| DTRACEBUF_DROPPED
);
10926 buf
->dtb_interval
= now
- buf
->dtb_switched
;
10927 buf
->dtb_switched
= now
;
10928 buf
->dtb_cur_limit
= buf
->dtb_limit
;
10930 dtrace_interrupt_enable(cookie
);
10934 * Note: called from cross call context. This function activates a buffer
10935 * on a CPU. As with dtrace_buffer_switch(), the atomicity of the operation
10936 * is guaranteed by the disabling of interrupts.
10939 dtrace_buffer_activate(dtrace_state_t
*state
)
10941 dtrace_buffer_t
*buf
;
10942 dtrace_icookie_t cookie
= dtrace_interrupt_disable();
10944 buf
= &state
->dts_buffer
[CPU
->cpu_id
];
10946 if (buf
->dtb_tomax
!= NULL
) {
10948 * We might like to assert that the buffer is marked inactive,
10949 * but this isn't necessarily true: the buffer for the CPU
10950 * that processes the BEGIN probe has its buffer activated
10951 * manually. In this case, we take the (harmless) action
10952 * re-clearing the bit INACTIVE bit.
10954 buf
->dtb_flags
&= ~DTRACEBUF_INACTIVE
;
10957 dtrace_interrupt_enable(cookie
);
10961 dtrace_buffer_canalloc(size_t size
)
10963 if (size
> (UINT64_MAX
- dtrace_buffer_memory_inuse
))
10965 if ((size
+ dtrace_buffer_memory_inuse
) > dtrace_buffer_memory_maxsize
)
10972 dtrace_buffer_alloc(dtrace_buffer_t
*bufs
, size_t limit
, size_t size
, int flags
,
10976 dtrace_buffer_t
*buf
;
10977 size_t size_before_alloc
= dtrace_buffer_memory_inuse
;
10979 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
10980 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
10982 if (size
> (size_t)dtrace_nonroot_maxsize
&&
10983 !PRIV_POLICY_CHOICE(CRED(), PRIV_ALL
, B_FALSE
))
10989 if (cpu
!= DTRACE_CPUALL
&& cpu
!= cp
->cpu_id
)
10992 buf
= &bufs
[cp
->cpu_id
];
10995 * If there is already a buffer allocated for this CPU, it
10996 * is only possible that this is a DR event. In this case,
10997 * the buffer size must match our specified size.
10999 if (buf
->dtb_tomax
!= NULL
) {
11000 ASSERT(buf
->dtb_size
== size
);
11004 ASSERT(buf
->dtb_xamot
== NULL
);
11007 /* DTrace, please do not eat all the memory. */
11008 if (dtrace_buffer_canalloc(size
) == B_FALSE
)
11010 if ((buf
->dtb_tomax
= kmem_zalloc(size
, KM_NOSLEEP
)) == NULL
)
11012 dtrace_buffer_memory_inuse
+= size
;
11014 /* Unsure that limit is always lower than size */
11015 limit
= limit
== size
? limit
- 1 : limit
;
11016 buf
->dtb_cur_limit
= limit
;
11017 buf
->dtb_limit
= limit
;
11018 buf
->dtb_size
= size
;
11019 buf
->dtb_flags
= flags
;
11020 buf
->dtb_offset
= 0;
11021 buf
->dtb_drops
= 0;
11023 if (flags
& DTRACEBUF_NOSWITCH
)
11026 /* DTrace, please do not eat all the memory. */
11027 if (dtrace_buffer_canalloc(size
) == B_FALSE
)
11029 if ((buf
->dtb_xamot
= kmem_zalloc(size
, KM_NOSLEEP
)) == NULL
)
11031 dtrace_buffer_memory_inuse
+= size
;
11032 } while ((cp
= cp
->cpu_next
) != cpu_list
);
11034 ASSERT(dtrace_buffer_memory_inuse
<= dtrace_buffer_memory_maxsize
);
11042 if (cpu
!= DTRACE_CPUALL
&& cpu
!= cp
->cpu_id
)
11045 buf
= &bufs
[cp
->cpu_id
];
11047 if (buf
->dtb_xamot
!= NULL
) {
11048 ASSERT(buf
->dtb_tomax
!= NULL
);
11049 ASSERT(buf
->dtb_size
== size
);
11050 kmem_free(buf
->dtb_xamot
, size
);
11053 if (buf
->dtb_tomax
!= NULL
) {
11054 ASSERT(buf
->dtb_size
== size
);
11055 kmem_free(buf
->dtb_tomax
, size
);
11058 buf
->dtb_tomax
= NULL
;
11059 buf
->dtb_xamot
= NULL
;
11061 } while ((cp
= cp
->cpu_next
) != cpu_list
);
11063 /* Restore the size saved before allocating memory */
11064 dtrace_buffer_memory_inuse
= size_before_alloc
;
11070 * Note: called from probe context. This function just increments the drop
11071 * count on a buffer. It has been made a function to allow for the
11072 * possibility of understanding the source of mysterious drop counts. (A
11073 * problem for which one may be particularly disappointed that DTrace cannot
11074 * be used to understand DTrace.)
11077 dtrace_buffer_drop(dtrace_buffer_t
*buf
)
11083 * Note: called from probe context. This function is called to reserve space
11084 * in a buffer. If mstate is non-NULL, sets the scratch base and size in the
11085 * mstate. Returns the new offset in the buffer, or a negative value if an
11086 * error has occurred.
11089 dtrace_buffer_reserve(dtrace_buffer_t
*buf
, size_t needed
, size_t align
,
11090 dtrace_state_t
*state
, dtrace_mstate_t
*mstate
)
11092 intptr_t offs
= buf
->dtb_offset
, soffs
;
11097 if (buf
->dtb_flags
& DTRACEBUF_INACTIVE
)
11100 if ((tomax
= buf
->dtb_tomax
) == NULL
) {
11101 dtrace_buffer_drop(buf
);
11105 if (!(buf
->dtb_flags
& (DTRACEBUF_RING
| DTRACEBUF_FILL
))) {
11106 while (offs
& (align
- 1)) {
11108 * Assert that our alignment is off by a number which
11109 * is itself sizeof (uint32_t) aligned.
11111 ASSERT(!((align
- (offs
& (align
- 1))) &
11112 (sizeof (uint32_t) - 1)));
11113 DTRACE_STORE(uint32_t, tomax
, offs
, DTRACE_EPIDNONE
);
11114 offs
+= sizeof (uint32_t);
11117 if ((uint64_t)(soffs
= offs
+ needed
) > buf
->dtb_cur_limit
) {
11118 if (buf
->dtb_cur_limit
== buf
->dtb_limit
) {
11119 buf
->dtb_cur_limit
= buf
->dtb_size
;
11121 atomic_add_32(&state
->dts_buf_over_limit
, 1);
11123 * Set an AST on the current processor
11124 * so that we can wake up the process
11125 * outside of probe context, when we know
11126 * it is safe to do so
11128 minor_t minor
= getminor(state
->dts_dev
);
11129 ASSERT(minor
< 32);
11131 atomic_or_32(&dtrace_wake_clients
, 1 << minor
);
11134 if ((uint64_t)soffs
> buf
->dtb_size
) {
11135 dtrace_buffer_drop(buf
);
11140 if (mstate
== NULL
)
11143 mstate
->dtms_scratch_base
= (uintptr_t)tomax
+ soffs
;
11144 mstate
->dtms_scratch_size
= buf
->dtb_size
- soffs
;
11145 mstate
->dtms_scratch_ptr
= mstate
->dtms_scratch_base
;
11150 if (buf
->dtb_flags
& DTRACEBUF_FILL
) {
11151 if (state
->dts_activity
!= DTRACE_ACTIVITY_COOLDOWN
&&
11152 (buf
->dtb_flags
& DTRACEBUF_FULL
))
11157 total_off
= needed
+ (offs
& (align
- 1));
11160 * For a ring buffer, life is quite a bit more complicated. Before
11161 * we can store any padding, we need to adjust our wrapping offset.
11162 * (If we've never before wrapped or we're not about to, no adjustment
11165 if ((buf
->dtb_flags
& DTRACEBUF_WRAPPED
) ||
11166 offs
+ total_off
> buf
->dtb_size
) {
11167 woffs
= buf
->dtb_xamot_offset
;
11169 if (offs
+ total_off
> buf
->dtb_size
) {
11171 * We can't fit in the end of the buffer. First, a
11172 * sanity check that we can fit in the buffer at all.
11174 if (total_off
> buf
->dtb_size
) {
11175 dtrace_buffer_drop(buf
);
11180 * We're going to be storing at the top of the buffer,
11181 * so now we need to deal with the wrapped offset. We
11182 * only reset our wrapped offset to 0 if it is
11183 * currently greater than the current offset. If it
11184 * is less than the current offset, it is because a
11185 * previous allocation induced a wrap -- but the
11186 * allocation didn't subsequently take the space due
11187 * to an error or false predicate evaluation. In this
11188 * case, we'll just leave the wrapped offset alone: if
11189 * the wrapped offset hasn't been advanced far enough
11190 * for this allocation, it will be adjusted in the
11193 if (buf
->dtb_flags
& DTRACEBUF_WRAPPED
) {
11201 * Now we know that we're going to be storing to the
11202 * top of the buffer and that there is room for us
11203 * there. We need to clear the buffer from the current
11204 * offset to the end (there may be old gunk there).
11206 while ((uint64_t)offs
< buf
->dtb_size
)
11210 * We need to set our offset to zero. And because we
11211 * are wrapping, we need to set the bit indicating as
11212 * much. We can also adjust our needed space back
11213 * down to the space required by the ECB -- we know
11214 * that the top of the buffer is aligned.
11217 total_off
= needed
;
11218 buf
->dtb_flags
|= DTRACEBUF_WRAPPED
;
11221 * There is room for us in the buffer, so we simply
11222 * need to check the wrapped offset.
11224 if (woffs
< offs
) {
11226 * The wrapped offset is less than the offset.
11227 * This can happen if we allocated buffer space
11228 * that induced a wrap, but then we didn't
11229 * subsequently take the space due to an error
11230 * or false predicate evaluation. This is
11231 * okay; we know that _this_ allocation isn't
11232 * going to induce a wrap. We still can't
11233 * reset the wrapped offset to be zero,
11234 * however: the space may have been trashed in
11235 * the previous failed probe attempt. But at
11236 * least the wrapped offset doesn't need to
11237 * be adjusted at all...
11243 while (offs
+ total_off
> (size_t)woffs
) {
11244 dtrace_epid_t epid
= *(uint32_t *)(tomax
+ woffs
);
11247 if (epid
== DTRACE_EPIDNONE
) {
11248 size
= sizeof (uint32_t);
11250 ASSERT(epid
<= (dtrace_epid_t
)state
->dts_necbs
);
11251 ASSERT(state
->dts_ecbs
[epid
- 1] != NULL
);
11253 size
= state
->dts_ecbs
[epid
- 1]->dte_size
;
11256 ASSERT(woffs
+ size
<= buf
->dtb_size
);
11259 if (woffs
+ size
== buf
->dtb_size
) {
11261 * We've reached the end of the buffer; we want
11262 * to set the wrapped offset to 0 and break
11263 * out. However, if the offs is 0, then we're
11264 * in a strange edge-condition: the amount of
11265 * space that we want to reserve plus the size
11266 * of the record that we're overwriting is
11267 * greater than the size of the buffer. This
11268 * is problematic because if we reserve the
11269 * space but subsequently don't consume it (due
11270 * to a failed predicate or error) the wrapped
11271 * offset will be 0 -- yet the EPID at offset 0
11272 * will not be committed. This situation is
11273 * relatively easy to deal with: if we're in
11274 * this case, the buffer is indistinguishable
11275 * from one that hasn't wrapped; we need only
11276 * finish the job by clearing the wrapped bit,
11277 * explicitly setting the offset to be 0, and
11278 * zero'ing out the old data in the buffer.
11281 buf
->dtb_flags
&= ~DTRACEBUF_WRAPPED
;
11282 buf
->dtb_offset
= 0;
11285 while ((uint64_t)woffs
< buf
->dtb_size
)
11286 tomax
[woffs
++] = 0;
11297 * We have a wrapped offset. It may be that the wrapped offset
11298 * has become zero -- that's okay.
11300 buf
->dtb_xamot_offset
= woffs
;
11305 * Now we can plow the buffer with any necessary padding.
11307 while (offs
& (align
- 1)) {
11309 * Assert that our alignment is off by a number which
11310 * is itself sizeof (uint32_t) aligned.
11312 ASSERT(!((align
- (offs
& (align
- 1))) &
11313 (sizeof (uint32_t) - 1)));
11314 DTRACE_STORE(uint32_t, tomax
, offs
, DTRACE_EPIDNONE
);
11315 offs
+= sizeof (uint32_t);
11318 if (buf
->dtb_flags
& DTRACEBUF_FILL
) {
11319 if (offs
+ needed
> buf
->dtb_size
- state
->dts_reserve
) {
11320 buf
->dtb_flags
|= DTRACEBUF_FULL
;
11325 if (mstate
== NULL
)
11329 * For ring buffers and fill buffers, the scratch space is always
11330 * the inactive buffer.
11332 mstate
->dtms_scratch_base
= (uintptr_t)buf
->dtb_xamot
;
11333 mstate
->dtms_scratch_size
= buf
->dtb_size
;
11334 mstate
->dtms_scratch_ptr
= mstate
->dtms_scratch_base
;
11340 dtrace_buffer_polish(dtrace_buffer_t
*buf
)
11342 ASSERT(buf
->dtb_flags
& DTRACEBUF_RING
);
11343 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11345 if (!(buf
->dtb_flags
& DTRACEBUF_WRAPPED
))
11349 * We need to polish the ring buffer. There are three cases:
11351 * - The first (and presumably most common) is that there is no gap
11352 * between the buffer offset and the wrapped offset. In this case,
11353 * there is nothing in the buffer that isn't valid data; we can
11354 * mark the buffer as polished and return.
11356 * - The second (less common than the first but still more common
11357 * than the third) is that there is a gap between the buffer offset
11358 * and the wrapped offset, and the wrapped offset is larger than the
11359 * buffer offset. This can happen because of an alignment issue, or
11360 * can happen because of a call to dtrace_buffer_reserve() that
11361 * didn't subsequently consume the buffer space. In this case,
11362 * we need to zero the data from the buffer offset to the wrapped
11365 * - The third (and least common) is that there is a gap between the
11366 * buffer offset and the wrapped offset, but the wrapped offset is
11367 * _less_ than the buffer offset. This can only happen because a
11368 * call to dtrace_buffer_reserve() induced a wrap, but the space
11369 * was not subsequently consumed. In this case, we need to zero the
11370 * space from the offset to the end of the buffer _and_ from the
11371 * top of the buffer to the wrapped offset.
11373 if (buf
->dtb_offset
< buf
->dtb_xamot_offset
) {
11374 bzero(buf
->dtb_tomax
+ buf
->dtb_offset
,
11375 buf
->dtb_xamot_offset
- buf
->dtb_offset
);
11378 if (buf
->dtb_offset
> buf
->dtb_xamot_offset
) {
11379 bzero(buf
->dtb_tomax
+ buf
->dtb_offset
,
11380 buf
->dtb_size
- buf
->dtb_offset
);
11381 bzero(buf
->dtb_tomax
, buf
->dtb_xamot_offset
);
11386 dtrace_buffer_free(dtrace_buffer_t
*bufs
)
11390 for (i
= 0; i
< (int)NCPU
; i
++) {
11391 dtrace_buffer_t
*buf
= &bufs
[i
];
11393 if (buf
->dtb_tomax
== NULL
) {
11394 ASSERT(buf
->dtb_xamot
== NULL
);
11395 ASSERT(buf
->dtb_size
== 0);
11399 if (buf
->dtb_xamot
!= NULL
) {
11400 ASSERT(!(buf
->dtb_flags
& DTRACEBUF_NOSWITCH
));
11401 kmem_free(buf
->dtb_xamot
, buf
->dtb_size
);
11403 ASSERT(dtrace_buffer_memory_inuse
>= buf
->dtb_size
);
11404 dtrace_buffer_memory_inuse
-= buf
->dtb_size
;
11407 kmem_free(buf
->dtb_tomax
, buf
->dtb_size
);
11408 ASSERT(dtrace_buffer_memory_inuse
>= buf
->dtb_size
);
11409 dtrace_buffer_memory_inuse
-= buf
->dtb_size
;
11412 buf
->dtb_tomax
= NULL
;
11413 buf
->dtb_xamot
= NULL
;
11418 * DTrace Enabling Functions
11420 static dtrace_enabling_t
*
11421 dtrace_enabling_create(dtrace_vstate_t
*vstate
)
11423 dtrace_enabling_t
*enab
;
11425 enab
= kmem_zalloc(sizeof (dtrace_enabling_t
), KM_SLEEP
);
11426 enab
->dten_vstate
= vstate
;
11432 dtrace_enabling_add(dtrace_enabling_t
*enab
, dtrace_ecbdesc_t
*ecb
)
11434 dtrace_ecbdesc_t
**ndesc
;
11435 size_t osize
, nsize
;
11438 * We can't add to enablings after we've enabled them, or after we've
11441 ASSERT(enab
->dten_probegen
== 0);
11442 ASSERT(enab
->dten_next
== NULL
&& enab
->dten_prev
== NULL
);
11444 /* APPLE NOTE: this protects against gcc 4.0 botch on x86 */
11445 if (ecb
== NULL
) return;
11447 if (enab
->dten_ndesc
< enab
->dten_maxdesc
) {
11448 enab
->dten_desc
[enab
->dten_ndesc
++] = ecb
;
11452 osize
= enab
->dten_maxdesc
* sizeof (dtrace_enabling_t
*);
11454 if (enab
->dten_maxdesc
== 0) {
11455 enab
->dten_maxdesc
= 1;
11457 enab
->dten_maxdesc
<<= 1;
11460 ASSERT(enab
->dten_ndesc
< enab
->dten_maxdesc
);
11462 nsize
= enab
->dten_maxdesc
* sizeof (dtrace_enabling_t
*);
11463 ndesc
= kmem_zalloc(nsize
, KM_SLEEP
);
11464 bcopy(enab
->dten_desc
, ndesc
, osize
);
11465 kmem_free(enab
->dten_desc
, osize
);
11467 enab
->dten_desc
= ndesc
;
11468 enab
->dten_desc
[enab
->dten_ndesc
++] = ecb
;
11472 dtrace_enabling_addlike(dtrace_enabling_t
*enab
, dtrace_ecbdesc_t
*ecb
,
11473 dtrace_probedesc_t
*pd
)
11475 dtrace_ecbdesc_t
*new;
11476 dtrace_predicate_t
*pred
;
11477 dtrace_actdesc_t
*act
;
11480 * We're going to create a new ECB description that matches the
11481 * specified ECB in every way, but has the specified probe description.
11483 new = kmem_zalloc(sizeof (dtrace_ecbdesc_t
), KM_SLEEP
);
11485 if ((pred
= ecb
->dted_pred
.dtpdd_predicate
) != NULL
)
11486 dtrace_predicate_hold(pred
);
11488 for (act
= ecb
->dted_action
; act
!= NULL
; act
= act
->dtad_next
)
11489 dtrace_actdesc_hold(act
);
11491 new->dted_action
= ecb
->dted_action
;
11492 new->dted_pred
= ecb
->dted_pred
;
11493 new->dted_probe
= *pd
;
11494 new->dted_uarg
= ecb
->dted_uarg
;
11496 dtrace_enabling_add(enab
, new);
11500 dtrace_enabling_dump(dtrace_enabling_t
*enab
)
11504 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11505 dtrace_probedesc_t
*desc
= &enab
->dten_desc
[i
]->dted_probe
;
11507 cmn_err(CE_NOTE
, "enabling probe %d (%s:%s:%s:%s)", i
,
11508 desc
->dtpd_provider
, desc
->dtpd_mod
,
11509 desc
->dtpd_func
, desc
->dtpd_name
);
11514 dtrace_enabling_destroy(dtrace_enabling_t
*enab
)
11517 dtrace_ecbdesc_t
*ep
;
11518 dtrace_vstate_t
*vstate
= enab
->dten_vstate
;
11520 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11522 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11523 dtrace_actdesc_t
*act
, *next
;
11524 dtrace_predicate_t
*pred
;
11526 ep
= enab
->dten_desc
[i
];
11528 if ((pred
= ep
->dted_pred
.dtpdd_predicate
) != NULL
)
11529 dtrace_predicate_release(pred
, vstate
);
11531 for (act
= ep
->dted_action
; act
!= NULL
; act
= next
) {
11532 next
= act
->dtad_next
;
11533 dtrace_actdesc_release(act
, vstate
);
11536 kmem_free(ep
, sizeof (dtrace_ecbdesc_t
));
11539 kmem_free(enab
->dten_desc
,
11540 enab
->dten_maxdesc
* sizeof (dtrace_enabling_t
*));
11543 * If this was a retained enabling, decrement the dts_nretained count
11544 * and take it off of the dtrace_retained list.
11546 if (enab
->dten_prev
!= NULL
|| enab
->dten_next
!= NULL
||
11547 dtrace_retained
== enab
) {
11548 ASSERT(enab
->dten_vstate
->dtvs_state
!= NULL
);
11549 ASSERT(enab
->dten_vstate
->dtvs_state
->dts_nretained
> 0);
11550 enab
->dten_vstate
->dtvs_state
->dts_nretained
--;
11551 dtrace_retained_gen
++;
11554 if (enab
->dten_prev
== NULL
) {
11555 if (dtrace_retained
== enab
) {
11556 dtrace_retained
= enab
->dten_next
;
11558 if (dtrace_retained
!= NULL
)
11559 dtrace_retained
->dten_prev
= NULL
;
11562 ASSERT(enab
!= dtrace_retained
);
11563 ASSERT(dtrace_retained
!= NULL
);
11564 enab
->dten_prev
->dten_next
= enab
->dten_next
;
11567 if (enab
->dten_next
!= NULL
) {
11568 ASSERT(dtrace_retained
!= NULL
);
11569 enab
->dten_next
->dten_prev
= enab
->dten_prev
;
11572 kmem_free(enab
, sizeof (dtrace_enabling_t
));
11576 dtrace_enabling_retain(dtrace_enabling_t
*enab
)
11578 dtrace_state_t
*state
;
11580 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11581 ASSERT(enab
->dten_next
== NULL
&& enab
->dten_prev
== NULL
);
11582 ASSERT(enab
->dten_vstate
!= NULL
);
11584 state
= enab
->dten_vstate
->dtvs_state
;
11585 ASSERT(state
!= NULL
);
11588 * We only allow each state to retain dtrace_retain_max enablings.
11590 if (state
->dts_nretained
>= dtrace_retain_max
)
11593 state
->dts_nretained
++;
11594 dtrace_retained_gen
++;
11596 if (dtrace_retained
== NULL
) {
11597 dtrace_retained
= enab
;
11601 enab
->dten_next
= dtrace_retained
;
11602 dtrace_retained
->dten_prev
= enab
;
11603 dtrace_retained
= enab
;
11609 dtrace_enabling_replicate(dtrace_state_t
*state
, dtrace_probedesc_t
*match
,
11610 dtrace_probedesc_t
*create
)
11612 dtrace_enabling_t
*new, *enab
;
11613 int found
= 0, err
= ENOENT
;
11615 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11616 ASSERT(strlen(match
->dtpd_provider
) < DTRACE_PROVNAMELEN
);
11617 ASSERT(strlen(match
->dtpd_mod
) < DTRACE_MODNAMELEN
);
11618 ASSERT(strlen(match
->dtpd_func
) < DTRACE_FUNCNAMELEN
);
11619 ASSERT(strlen(match
->dtpd_name
) < DTRACE_NAMELEN
);
11621 new = dtrace_enabling_create(&state
->dts_vstate
);
11624 * Iterate over all retained enablings, looking for enablings that
11625 * match the specified state.
11627 for (enab
= dtrace_retained
; enab
!= NULL
; enab
= enab
->dten_next
) {
11631 * dtvs_state can only be NULL for helper enablings -- and
11632 * helper enablings can't be retained.
11634 ASSERT(enab
->dten_vstate
->dtvs_state
!= NULL
);
11636 if (enab
->dten_vstate
->dtvs_state
!= state
)
11640 * Now iterate over each probe description; we're looking for
11641 * an exact match to the specified probe description.
11643 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11644 dtrace_ecbdesc_t
*ep
= enab
->dten_desc
[i
];
11645 dtrace_probedesc_t
*pd
= &ep
->dted_probe
;
11647 /* APPLE NOTE: Darwin employs size bounded string operation. */
11648 if (strncmp(pd
->dtpd_provider
, match
->dtpd_provider
, DTRACE_PROVNAMELEN
))
11651 if (strncmp(pd
->dtpd_mod
, match
->dtpd_mod
, DTRACE_MODNAMELEN
))
11654 if (strncmp(pd
->dtpd_func
, match
->dtpd_func
, DTRACE_FUNCNAMELEN
))
11657 if (strncmp(pd
->dtpd_name
, match
->dtpd_name
, DTRACE_NAMELEN
))
11661 * We have a winning probe! Add it to our growing
11665 dtrace_enabling_addlike(new, ep
, create
);
11669 if (!found
|| (err
= dtrace_enabling_retain(new)) != 0) {
11670 dtrace_enabling_destroy(new);
11678 dtrace_enabling_retract(dtrace_state_t
*state
)
11680 dtrace_enabling_t
*enab
, *next
;
11682 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11685 * Iterate over all retained enablings, destroy the enablings retained
11686 * for the specified state.
11688 for (enab
= dtrace_retained
; enab
!= NULL
; enab
= next
) {
11689 next
= enab
->dten_next
;
11692 * dtvs_state can only be NULL for helper enablings -- and
11693 * helper enablings can't be retained.
11695 ASSERT(enab
->dten_vstate
->dtvs_state
!= NULL
);
11697 if (enab
->dten_vstate
->dtvs_state
== state
) {
11698 ASSERT(state
->dts_nretained
> 0);
11699 dtrace_enabling_destroy(enab
);
11703 ASSERT(state
->dts_nretained
== 0);
11707 dtrace_enabling_match(dtrace_enabling_t
*enab
, int *nmatched
, dtrace_match_cond_t
*cond
)
11710 int total_matched
= 0, matched
= 0;
11712 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
11713 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11715 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11716 dtrace_ecbdesc_t
*ep
= enab
->dten_desc
[i
];
11718 enab
->dten_current
= ep
;
11719 enab
->dten_error
= 0;
11722 * Before doing a dtrace_probe_enable, which is really
11723 * expensive, check that this enabling matches the matching precondition
11726 if (cond
&& (cond
->dmc_func(&ep
->dted_probe
, cond
->dmc_data
) == 0)) {
11730 * If a provider failed to enable a probe then get out and
11731 * let the consumer know we failed.
11733 if ((matched
= dtrace_probe_enable(&ep
->dted_probe
, enab
)) < 0)
11736 total_matched
+= matched
;
11738 if (enab
->dten_error
!= 0) {
11740 * If we get an error half-way through enabling the
11741 * probes, we kick out -- perhaps with some number of
11742 * them enabled. Leaving enabled probes enabled may
11743 * be slightly confusing for user-level, but we expect
11744 * that no one will attempt to actually drive on in
11745 * the face of such errors. If this is an anonymous
11746 * enabling (indicated with a NULL nmatched pointer),
11747 * we cmn_err() a message. We aren't expecting to
11748 * get such an error -- such as it can exist at all,
11749 * it would be a result of corrupted DOF in the driver
11752 if (nmatched
== NULL
) {
11753 cmn_err(CE_WARN
, "dtrace_enabling_match() "
11754 "error on %p: %d", (void *)ep
,
11758 return (enab
->dten_error
);
11762 enab
->dten_probegen
= dtrace_probegen
;
11763 if (nmatched
!= NULL
)
11764 *nmatched
= total_matched
;
11770 dtrace_enabling_matchall_with_cond(dtrace_match_cond_t
*cond
)
11772 dtrace_enabling_t
*enab
;
11774 lck_mtx_lock(&cpu_lock
);
11775 lck_mtx_lock(&dtrace_lock
);
11778 * Iterate over all retained enablings to see if any probes match
11779 * against them. We only perform this operation on enablings for which
11780 * we have sufficient permissions by virtue of being in the global zone
11781 * or in the same zone as the DTrace client. Because we can be called
11782 * after dtrace_detach() has been called, we cannot assert that there
11783 * are retained enablings. We can safely load from dtrace_retained,
11784 * however: the taskq_destroy() at the end of dtrace_detach() will
11785 * block pending our completion.
11789 * Darwin doesn't do zones.
11790 * Behave as if always in "global" zone."
11792 for (enab
= dtrace_retained
; enab
!= NULL
; enab
= enab
->dten_next
) {
11793 (void) dtrace_enabling_match(enab
, NULL
, cond
);
11796 lck_mtx_unlock(&dtrace_lock
);
11797 lck_mtx_unlock(&cpu_lock
);
11802 dtrace_enabling_matchall(void)
11804 dtrace_enabling_matchall_with_cond(NULL
);
11810 * If an enabling is to be enabled without having matched probes (that is, if
11811 * dtrace_state_go() is to be called on the underlying dtrace_state_t), the
11812 * enabling must be _primed_ by creating an ECB for every ECB description.
11813 * This must be done to assure that we know the number of speculations, the
11814 * number of aggregations, the minimum buffer size needed, etc. before we
11815 * transition out of DTRACE_ACTIVITY_INACTIVE. To do this without actually
11816 * enabling any probes, we create ECBs for every ECB decription, but with a
11817 * NULL probe -- which is exactly what this function does.
11820 dtrace_enabling_prime(dtrace_state_t
*state
)
11822 dtrace_enabling_t
*enab
;
11825 for (enab
= dtrace_retained
; enab
!= NULL
; enab
= enab
->dten_next
) {
11826 ASSERT(enab
->dten_vstate
->dtvs_state
!= NULL
);
11828 if (enab
->dten_vstate
->dtvs_state
!= state
)
11832 * We don't want to prime an enabling more than once, lest
11833 * we allow a malicious user to induce resource exhaustion.
11834 * (The ECBs that result from priming an enabling aren't
11835 * leaked -- but they also aren't deallocated until the
11836 * consumer state is destroyed.)
11838 if (enab
->dten_primed
)
11841 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11842 enab
->dten_current
= enab
->dten_desc
[i
];
11843 (void) dtrace_probe_enable(NULL
, enab
);
11846 enab
->dten_primed
= 1;
11851 * Called to indicate that probes should be provided due to retained
11852 * enablings. This is implemented in terms of dtrace_probe_provide(), but it
11853 * must take an initial lap through the enabling calling the dtps_provide()
11854 * entry point explicitly to allow for autocreated probes.
11857 dtrace_enabling_provide(dtrace_provider_t
*prv
)
11860 dtrace_probedesc_t desc
;
11861 dtrace_genid_t gen
;
11863 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11864 lck_mtx_assert(&dtrace_provider_lock
, LCK_MTX_ASSERT_OWNED
);
11868 prv
= dtrace_provider
;
11872 dtrace_enabling_t
*enab
;
11873 void *parg
= prv
->dtpv_arg
;
11876 gen
= dtrace_retained_gen
;
11877 for (enab
= dtrace_retained
; enab
!= NULL
;
11878 enab
= enab
->dten_next
) {
11879 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
11880 desc
= enab
->dten_desc
[i
]->dted_probe
;
11881 lck_mtx_unlock(&dtrace_lock
);
11882 prv
->dtpv_pops
.dtps_provide(parg
, &desc
);
11883 lck_mtx_lock(&dtrace_lock
);
11885 * Process the retained enablings again if
11886 * they have changed while we weren't holding
11889 if (gen
!= dtrace_retained_gen
)
11893 } while (all
&& (prv
= prv
->dtpv_next
) != NULL
);
11895 lck_mtx_unlock(&dtrace_lock
);
11896 dtrace_probe_provide(NULL
, all
? NULL
: prv
);
11897 lck_mtx_lock(&dtrace_lock
);
11901 * DTrace DOF Functions
11905 dtrace_dof_error(dof_hdr_t
*dof
, const char *str
)
11907 #pragma unused(dof) /* __APPLE__ */
11908 if (dtrace_err_verbose
)
11909 cmn_err(CE_WARN
, "failed to process DOF: %s", str
);
11911 #ifdef DTRACE_ERRDEBUG
11912 dtrace_errdebug(str
);
11917 * Create DOF out of a currently enabled state. Right now, we only create
11918 * DOF containing the run-time options -- but this could be expanded to create
11919 * complete DOF representing the enabled state.
11922 dtrace_dof_create(dtrace_state_t
*state
)
11926 dof_optdesc_t
*opt
;
11927 int i
, len
= sizeof (dof_hdr_t
) +
11928 roundup(sizeof (dof_sec_t
), sizeof (uint64_t)) +
11929 sizeof (dof_optdesc_t
) * DTRACEOPT_MAX
;
11931 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
11933 dof
= dt_kmem_zalloc_aligned(len
, 8, KM_SLEEP
);
11934 dof
->dofh_ident
[DOF_ID_MAG0
] = DOF_MAG_MAG0
;
11935 dof
->dofh_ident
[DOF_ID_MAG1
] = DOF_MAG_MAG1
;
11936 dof
->dofh_ident
[DOF_ID_MAG2
] = DOF_MAG_MAG2
;
11937 dof
->dofh_ident
[DOF_ID_MAG3
] = DOF_MAG_MAG3
;
11939 dof
->dofh_ident
[DOF_ID_MODEL
] = DOF_MODEL_NATIVE
;
11940 dof
->dofh_ident
[DOF_ID_ENCODING
] = DOF_ENCODE_NATIVE
;
11941 dof
->dofh_ident
[DOF_ID_VERSION
] = DOF_VERSION
;
11942 dof
->dofh_ident
[DOF_ID_DIFVERS
] = DIF_VERSION
;
11943 dof
->dofh_ident
[DOF_ID_DIFIREG
] = DIF_DIR_NREGS
;
11944 dof
->dofh_ident
[DOF_ID_DIFTREG
] = DIF_DTR_NREGS
;
11946 dof
->dofh_flags
= 0;
11947 dof
->dofh_hdrsize
= sizeof (dof_hdr_t
);
11948 dof
->dofh_secsize
= sizeof (dof_sec_t
);
11949 dof
->dofh_secnum
= 1; /* only DOF_SECT_OPTDESC */
11950 dof
->dofh_secoff
= sizeof (dof_hdr_t
);
11951 dof
->dofh_loadsz
= len
;
11952 dof
->dofh_filesz
= len
;
11956 * Fill in the option section header...
11958 sec
= (dof_sec_t
*)((uintptr_t)dof
+ sizeof (dof_hdr_t
));
11959 sec
->dofs_type
= DOF_SECT_OPTDESC
;
11960 sec
->dofs_align
= sizeof (uint64_t);
11961 sec
->dofs_flags
= DOF_SECF_LOAD
;
11962 sec
->dofs_entsize
= sizeof (dof_optdesc_t
);
11964 opt
= (dof_optdesc_t
*)((uintptr_t)sec
+
11965 roundup(sizeof (dof_sec_t
), sizeof (uint64_t)));
11967 sec
->dofs_offset
= (uintptr_t)opt
- (uintptr_t)dof
;
11968 sec
->dofs_size
= sizeof (dof_optdesc_t
) * DTRACEOPT_MAX
;
11970 for (i
= 0; i
< DTRACEOPT_MAX
; i
++) {
11971 opt
[i
].dofo_option
= i
;
11972 opt
[i
].dofo_strtab
= DOF_SECIDX_NONE
;
11973 opt
[i
].dofo_value
= state
->dts_options
[i
];
11980 dtrace_dof_copyin(user_addr_t uarg
, int *errp
)
11982 dof_hdr_t hdr
, *dof
;
11984 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_NOTOWNED
);
11987 * First, we're going to copyin() the sizeof (dof_hdr_t).
11989 if (copyin(uarg
, &hdr
, sizeof (hdr
)) != 0) {
11990 dtrace_dof_error(NULL
, "failed to copyin DOF header");
11996 * Now we'll allocate the entire DOF and copy it in -- provided
11997 * that the length isn't outrageous.
11999 if (hdr
.dofh_loadsz
>= (uint64_t)dtrace_dof_maxsize
) {
12000 dtrace_dof_error(&hdr
, "load size exceeds maximum");
12005 if (hdr
.dofh_loadsz
< sizeof (hdr
)) {
12006 dtrace_dof_error(&hdr
, "invalid load size");
12011 dof
= dt_kmem_alloc_aligned(hdr
.dofh_loadsz
, 8, KM_SLEEP
);
12013 if (copyin(uarg
, dof
, hdr
.dofh_loadsz
) != 0 ||
12014 dof
->dofh_loadsz
!= hdr
.dofh_loadsz
) {
12015 dt_kmem_free_aligned(dof
, hdr
.dofh_loadsz
);
12024 dtrace_dof_copyin_from_proc(proc_t
* p
, user_addr_t uarg
, int *errp
)
12026 dof_hdr_t hdr
, *dof
;
12028 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_NOTOWNED
);
12031 * First, we're going to copyin() the sizeof (dof_hdr_t).
12033 if (uread(p
, &hdr
, sizeof(hdr
), uarg
) != KERN_SUCCESS
) {
12034 dtrace_dof_error(NULL
, "failed to copyin DOF header");
12040 * Now we'll allocate the entire DOF and copy it in -- provided
12041 * that the length isn't outrageous.
12043 if (hdr
.dofh_loadsz
>= (uint64_t)dtrace_dof_maxsize
) {
12044 dtrace_dof_error(&hdr
, "load size exceeds maximum");
12049 if (hdr
.dofh_loadsz
< sizeof (hdr
)) {
12050 dtrace_dof_error(&hdr
, "invalid load size");
12055 dof
= dt_kmem_alloc_aligned(hdr
.dofh_loadsz
, 8, KM_SLEEP
);
12057 if (uread(p
, dof
, hdr
.dofh_loadsz
, uarg
) != KERN_SUCCESS
) {
12058 dt_kmem_free_aligned(dof
, hdr
.dofh_loadsz
);
12067 dtrace_dof_property(const char *name
)
12071 unsigned int len
, i
;
12075 * Unfortunately, array of values in .conf files are always (and
12076 * only) interpreted to be integer arrays. We must read our DOF
12077 * as an integer array, and then squeeze it into a byte array.
12079 if (ddi_prop_lookup_int_array(DDI_DEV_T_ANY
, dtrace_devi
, 0,
12080 name
, (int **)&buf
, &len
) != DDI_PROP_SUCCESS
)
12083 for (i
= 0; i
< len
; i
++)
12084 buf
[i
] = (uchar_t
)(((int *)buf
)[i
]);
12086 if (len
< sizeof (dof_hdr_t
)) {
12087 ddi_prop_free(buf
);
12088 dtrace_dof_error(NULL
, "truncated header");
12092 if (len
< (loadsz
= ((dof_hdr_t
*)buf
)->dofh_loadsz
)) {
12093 ddi_prop_free(buf
);
12094 dtrace_dof_error(NULL
, "truncated DOF");
12098 if (loadsz
>= (uint64_t)dtrace_dof_maxsize
) {
12099 ddi_prop_free(buf
);
12100 dtrace_dof_error(NULL
, "oversized DOF");
12104 dof
= dt_kmem_alloc_aligned(loadsz
, 8, KM_SLEEP
);
12105 bcopy(buf
, dof
, loadsz
);
12106 ddi_prop_free(buf
);
12112 dtrace_dof_destroy(dof_hdr_t
*dof
)
12114 dt_kmem_free_aligned(dof
, dof
->dofh_loadsz
);
12118 * Return the dof_sec_t pointer corresponding to a given section index. If the
12119 * index is not valid, dtrace_dof_error() is called and NULL is returned. If
12120 * a type other than DOF_SECT_NONE is specified, the header is checked against
12121 * this type and NULL is returned if the types do not match.
12124 dtrace_dof_sect(dof_hdr_t
*dof
, uint32_t type
, dof_secidx_t i
)
12126 dof_sec_t
*sec
= (dof_sec_t
*)(uintptr_t)
12127 ((uintptr_t)dof
+ dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
12129 if (i
>= dof
->dofh_secnum
) {
12130 dtrace_dof_error(dof
, "referenced section index is invalid");
12134 if (!(sec
->dofs_flags
& DOF_SECF_LOAD
)) {
12135 dtrace_dof_error(dof
, "referenced section is not loadable");
12139 if (type
!= DOF_SECT_NONE
&& type
!= sec
->dofs_type
) {
12140 dtrace_dof_error(dof
, "referenced section is the wrong type");
12147 static dtrace_probedesc_t
*
12148 dtrace_dof_probedesc(dof_hdr_t
*dof
, dof_sec_t
*sec
, dtrace_probedesc_t
*desc
)
12150 dof_probedesc_t
*probe
;
12152 uintptr_t daddr
= (uintptr_t)dof
;
12156 if (sec
->dofs_type
!= DOF_SECT_PROBEDESC
) {
12157 dtrace_dof_error(dof
, "invalid probe section");
12161 if (sec
->dofs_align
!= sizeof (dof_secidx_t
)) {
12162 dtrace_dof_error(dof
, "bad alignment in probe description");
12166 if (sec
->dofs_offset
+ sizeof (dof_probedesc_t
) > dof
->dofh_loadsz
) {
12167 dtrace_dof_error(dof
, "truncated probe description");
12171 probe
= (dof_probedesc_t
*)(uintptr_t)(daddr
+ sec
->dofs_offset
);
12172 strtab
= dtrace_dof_sect(dof
, DOF_SECT_STRTAB
, probe
->dofp_strtab
);
12174 if (strtab
== NULL
)
12177 str
= daddr
+ strtab
->dofs_offset
;
12178 size
= strtab
->dofs_size
;
12180 if (probe
->dofp_provider
>= strtab
->dofs_size
) {
12181 dtrace_dof_error(dof
, "corrupt probe provider");
12185 (void) strncpy(desc
->dtpd_provider
,
12186 (char *)(str
+ probe
->dofp_provider
),
12187 MIN(DTRACE_PROVNAMELEN
- 1, size
- probe
->dofp_provider
));
12189 /* APPLE NOTE: Darwin employs size bounded string operation. */
12190 desc
->dtpd_provider
[DTRACE_PROVNAMELEN
- 1] = '\0';
12192 if (probe
->dofp_mod
>= strtab
->dofs_size
) {
12193 dtrace_dof_error(dof
, "corrupt probe module");
12197 (void) strncpy(desc
->dtpd_mod
, (char *)(str
+ probe
->dofp_mod
),
12198 MIN(DTRACE_MODNAMELEN
- 1, size
- probe
->dofp_mod
));
12200 /* APPLE NOTE: Darwin employs size bounded string operation. */
12201 desc
->dtpd_mod
[DTRACE_MODNAMELEN
- 1] = '\0';
12203 if (probe
->dofp_func
>= strtab
->dofs_size
) {
12204 dtrace_dof_error(dof
, "corrupt probe function");
12208 (void) strncpy(desc
->dtpd_func
, (char *)(str
+ probe
->dofp_func
),
12209 MIN(DTRACE_FUNCNAMELEN
- 1, size
- probe
->dofp_func
));
12211 /* APPLE NOTE: Darwin employs size bounded string operation. */
12212 desc
->dtpd_func
[DTRACE_FUNCNAMELEN
- 1] = '\0';
12214 if (probe
->dofp_name
>= strtab
->dofs_size
) {
12215 dtrace_dof_error(dof
, "corrupt probe name");
12219 (void) strncpy(desc
->dtpd_name
, (char *)(str
+ probe
->dofp_name
),
12220 MIN(DTRACE_NAMELEN
- 1, size
- probe
->dofp_name
));
12222 /* APPLE NOTE: Darwin employs size bounded string operation. */
12223 desc
->dtpd_name
[DTRACE_NAMELEN
- 1] = '\0';
12228 static dtrace_difo_t
*
12229 dtrace_dof_difo(dof_hdr_t
*dof
, dof_sec_t
*sec
, dtrace_vstate_t
*vstate
,
12234 dof_difohdr_t
*dofd
;
12235 uintptr_t daddr
= (uintptr_t)dof
;
12236 size_t max_size
= dtrace_difo_maxsize
;
12241 static const struct {
12249 { DOF_SECT_DIF
, offsetof(dtrace_difo_t
, dtdo_buf
),
12250 offsetof(dtrace_difo_t
, dtdo_len
), sizeof (dif_instr_t
),
12251 sizeof (dif_instr_t
), "multiple DIF sections" },
12253 { DOF_SECT_INTTAB
, offsetof(dtrace_difo_t
, dtdo_inttab
),
12254 offsetof(dtrace_difo_t
, dtdo_intlen
), sizeof (uint64_t),
12255 sizeof (uint64_t), "multiple integer tables" },
12257 { DOF_SECT_STRTAB
, offsetof(dtrace_difo_t
, dtdo_strtab
),
12258 offsetof(dtrace_difo_t
, dtdo_strlen
), 0,
12259 sizeof (char), "multiple string tables" },
12261 { DOF_SECT_VARTAB
, offsetof(dtrace_difo_t
, dtdo_vartab
),
12262 offsetof(dtrace_difo_t
, dtdo_varlen
), sizeof (dtrace_difv_t
),
12263 sizeof (uint_t
), "multiple variable tables" },
12265 { DOF_SECT_NONE
, 0, 0, 0, 0, NULL
}
12268 if (sec
->dofs_type
!= DOF_SECT_DIFOHDR
) {
12269 dtrace_dof_error(dof
, "invalid DIFO header section");
12273 if (sec
->dofs_align
!= sizeof (dof_secidx_t
)) {
12274 dtrace_dof_error(dof
, "bad alignment in DIFO header");
12278 if (sec
->dofs_size
< sizeof (dof_difohdr_t
) ||
12279 sec
->dofs_size
% sizeof (dof_secidx_t
)) {
12280 dtrace_dof_error(dof
, "bad size in DIFO header");
12284 dofd
= (dof_difohdr_t
*)(uintptr_t)(daddr
+ sec
->dofs_offset
);
12285 n
= (sec
->dofs_size
- sizeof (*dofd
)) / sizeof (dof_secidx_t
) + 1;
12287 dp
= kmem_zalloc(sizeof (dtrace_difo_t
), KM_SLEEP
);
12288 dp
->dtdo_rtype
= dofd
->dofd_rtype
;
12290 for (l
= 0; l
< n
; l
++) {
12295 if ((subsec
= dtrace_dof_sect(dof
, DOF_SECT_NONE
,
12296 dofd
->dofd_links
[l
])) == NULL
)
12297 goto err
; /* invalid section link */
12299 if (ttl
+ subsec
->dofs_size
> max_size
) {
12300 dtrace_dof_error(dof
, "exceeds maximum size");
12304 ttl
+= subsec
->dofs_size
;
12306 for (i
= 0; difo
[i
].section
!= DOF_SECT_NONE
; i
++) {
12308 if (subsec
->dofs_type
!= (uint32_t)difo
[i
].section
)
12311 if (!(subsec
->dofs_flags
& DOF_SECF_LOAD
)) {
12312 dtrace_dof_error(dof
, "section not loaded");
12316 if (subsec
->dofs_align
!= (uint32_t)difo
[i
].align
) {
12317 dtrace_dof_error(dof
, "bad alignment");
12321 bufp
= (void **)((uintptr_t)dp
+ difo
[i
].bufoffs
);
12322 lenp
= (uint32_t *)((uintptr_t)dp
+ difo
[i
].lenoffs
);
12324 if (*bufp
!= NULL
) {
12325 dtrace_dof_error(dof
, difo
[i
].msg
);
12329 if ((uint32_t)difo
[i
].entsize
!= subsec
->dofs_entsize
) {
12330 dtrace_dof_error(dof
, "entry size mismatch");
12334 if (subsec
->dofs_entsize
!= 0 &&
12335 (subsec
->dofs_size
% subsec
->dofs_entsize
) != 0) {
12336 dtrace_dof_error(dof
, "corrupt entry size");
12340 *lenp
= subsec
->dofs_size
;
12341 *bufp
= kmem_alloc(subsec
->dofs_size
, KM_SLEEP
);
12342 bcopy((char *)(uintptr_t)(daddr
+ subsec
->dofs_offset
),
12343 *bufp
, subsec
->dofs_size
);
12345 if (subsec
->dofs_entsize
!= 0)
12346 *lenp
/= subsec
->dofs_entsize
;
12352 * If we encounter a loadable DIFO sub-section that is not
12353 * known to us, assume this is a broken program and fail.
12355 if (difo
[i
].section
== DOF_SECT_NONE
&&
12356 (subsec
->dofs_flags
& DOF_SECF_LOAD
)) {
12357 dtrace_dof_error(dof
, "unrecognized DIFO subsection");
12362 if (dp
->dtdo_buf
== NULL
) {
12364 * We can't have a DIF object without DIF text.
12366 dtrace_dof_error(dof
, "missing DIF text");
12371 * Before we validate the DIF object, run through the variable table
12372 * looking for the strings -- if any of their size are under, we'll set
12373 * their size to be the system-wide default string size. Note that
12374 * this should _not_ happen if the "strsize" option has been set --
12375 * in this case, the compiler should have set the size to reflect the
12376 * setting of the option.
12378 for (i
= 0; i
< dp
->dtdo_varlen
; i
++) {
12379 dtrace_difv_t
*v
= &dp
->dtdo_vartab
[i
];
12380 dtrace_diftype_t
*t
= &v
->dtdv_type
;
12382 if (v
->dtdv_id
< DIF_VAR_OTHER_UBASE
)
12385 if (t
->dtdt_kind
== DIF_TYPE_STRING
&& t
->dtdt_size
== 0)
12386 t
->dtdt_size
= dtrace_strsize_default
;
12389 if (dtrace_difo_validate(dp
, vstate
, DIF_DIR_NREGS
, cr
) != 0)
12392 dtrace_difo_init(dp
, vstate
);
12396 kmem_free(dp
->dtdo_buf
, dp
->dtdo_len
* sizeof (dif_instr_t
));
12397 kmem_free(dp
->dtdo_inttab
, dp
->dtdo_intlen
* sizeof (uint64_t));
12398 kmem_free(dp
->dtdo_strtab
, dp
->dtdo_strlen
);
12399 kmem_free(dp
->dtdo_vartab
, dp
->dtdo_varlen
* sizeof (dtrace_difv_t
));
12401 kmem_free(dp
, sizeof (dtrace_difo_t
));
12405 static dtrace_predicate_t
*
12406 dtrace_dof_predicate(dof_hdr_t
*dof
, dof_sec_t
*sec
, dtrace_vstate_t
*vstate
,
12411 if ((dp
= dtrace_dof_difo(dof
, sec
, vstate
, cr
)) == NULL
)
12414 return (dtrace_predicate_create(dp
));
12417 static dtrace_actdesc_t
*
12418 dtrace_dof_actdesc(dof_hdr_t
*dof
, dof_sec_t
*sec
, dtrace_vstate_t
*vstate
,
12421 dtrace_actdesc_t
*act
, *first
= NULL
, *last
= NULL
, *next
;
12422 dof_actdesc_t
*desc
;
12423 dof_sec_t
*difosec
;
12425 uintptr_t daddr
= (uintptr_t)dof
;
12427 dtrace_actkind_t kind
;
12429 if (sec
->dofs_type
!= DOF_SECT_ACTDESC
) {
12430 dtrace_dof_error(dof
, "invalid action section");
12434 if (sec
->dofs_offset
+ sizeof (dof_actdesc_t
) > dof
->dofh_loadsz
) {
12435 dtrace_dof_error(dof
, "truncated action description");
12439 if (sec
->dofs_align
!= sizeof (uint64_t)) {
12440 dtrace_dof_error(dof
, "bad alignment in action description");
12444 if (sec
->dofs_size
< sec
->dofs_entsize
) {
12445 dtrace_dof_error(dof
, "section entry size exceeds total size");
12449 if (sec
->dofs_entsize
!= sizeof (dof_actdesc_t
)) {
12450 dtrace_dof_error(dof
, "bad entry size in action description");
12454 if (sec
->dofs_size
/ sec
->dofs_entsize
> dtrace_actions_max
) {
12455 dtrace_dof_error(dof
, "actions exceed dtrace_actions_max");
12459 for (offs
= 0; offs
< sec
->dofs_size
; offs
+= sec
->dofs_entsize
) {
12460 desc
= (dof_actdesc_t
*)(daddr
+
12461 (uintptr_t)sec
->dofs_offset
+ offs
);
12462 kind
= (dtrace_actkind_t
)desc
->dofa_kind
;
12464 if ((DTRACEACT_ISPRINTFLIKE(kind
) &&
12465 (kind
!= DTRACEACT_PRINTA
|| desc
->dofa_strtab
!= DOF_SECIDX_NONE
)) ||
12466 (kind
== DTRACEACT_DIFEXPR
&& desc
->dofa_strtab
!= DOF_SECIDX_NONE
))
12473 * The argument to these actions is an index into the
12474 * DOF string table. For printf()-like actions, this
12475 * is the format string. For print(), this is the
12476 * CTF type of the expression result.
12478 if ((strtab
= dtrace_dof_sect(dof
,
12479 DOF_SECT_STRTAB
, desc
->dofa_strtab
)) == NULL
)
12482 str
= (char *)((uintptr_t)dof
+
12483 (uintptr_t)strtab
->dofs_offset
);
12485 for (i
= desc
->dofa_arg
; i
< strtab
->dofs_size
; i
++) {
12486 if (str
[i
] == '\0')
12490 if (i
>= strtab
->dofs_size
) {
12491 dtrace_dof_error(dof
, "bogus format string");
12495 if (i
== desc
->dofa_arg
) {
12496 dtrace_dof_error(dof
, "empty format string");
12500 i
-= desc
->dofa_arg
;
12501 fmt
= kmem_alloc(i
+ 1, KM_SLEEP
);
12502 bcopy(&str
[desc
->dofa_arg
], fmt
, i
+ 1);
12503 arg
= (uint64_t)(uintptr_t)fmt
;
12505 if (kind
== DTRACEACT_PRINTA
) {
12506 ASSERT(desc
->dofa_strtab
== DOF_SECIDX_NONE
);
12509 arg
= desc
->dofa_arg
;
12513 act
= dtrace_actdesc_create(kind
, desc
->dofa_ntuple
,
12514 desc
->dofa_uarg
, arg
);
12516 if (last
!= NULL
) {
12517 last
->dtad_next
= act
;
12524 if (desc
->dofa_difo
== DOF_SECIDX_NONE
)
12527 if ((difosec
= dtrace_dof_sect(dof
,
12528 DOF_SECT_DIFOHDR
, desc
->dofa_difo
)) == NULL
)
12531 act
->dtad_difo
= dtrace_dof_difo(dof
, difosec
, vstate
, cr
);
12533 if (act
->dtad_difo
== NULL
)
12537 ASSERT(first
!= NULL
);
12541 for (act
= first
; act
!= NULL
; act
= next
) {
12542 next
= act
->dtad_next
;
12543 dtrace_actdesc_release(act
, vstate
);
12549 static dtrace_ecbdesc_t
*
12550 dtrace_dof_ecbdesc(dof_hdr_t
*dof
, dof_sec_t
*sec
, dtrace_vstate_t
*vstate
,
12553 dtrace_ecbdesc_t
*ep
;
12554 dof_ecbdesc_t
*ecb
;
12555 dtrace_probedesc_t
*desc
;
12556 dtrace_predicate_t
*pred
= NULL
;
12558 if (sec
->dofs_size
< sizeof (dof_ecbdesc_t
)) {
12559 dtrace_dof_error(dof
, "truncated ECB description");
12563 if (sec
->dofs_align
!= sizeof (uint64_t)) {
12564 dtrace_dof_error(dof
, "bad alignment in ECB description");
12568 ecb
= (dof_ecbdesc_t
*)((uintptr_t)dof
+ (uintptr_t)sec
->dofs_offset
);
12569 sec
= dtrace_dof_sect(dof
, DOF_SECT_PROBEDESC
, ecb
->dofe_probes
);
12574 ep
= kmem_zalloc(sizeof (dtrace_ecbdesc_t
), KM_SLEEP
);
12575 ep
->dted_uarg
= ecb
->dofe_uarg
;
12576 desc
= &ep
->dted_probe
;
12578 if (dtrace_dof_probedesc(dof
, sec
, desc
) == NULL
)
12581 if (ecb
->dofe_pred
!= DOF_SECIDX_NONE
) {
12582 if ((sec
= dtrace_dof_sect(dof
,
12583 DOF_SECT_DIFOHDR
, ecb
->dofe_pred
)) == NULL
)
12586 if ((pred
= dtrace_dof_predicate(dof
, sec
, vstate
, cr
)) == NULL
)
12589 ep
->dted_pred
.dtpdd_predicate
= pred
;
12592 if (ecb
->dofe_actions
!= DOF_SECIDX_NONE
) {
12593 if ((sec
= dtrace_dof_sect(dof
,
12594 DOF_SECT_ACTDESC
, ecb
->dofe_actions
)) == NULL
)
12597 ep
->dted_action
= dtrace_dof_actdesc(dof
, sec
, vstate
, cr
);
12599 if (ep
->dted_action
== NULL
)
12607 dtrace_predicate_release(pred
, vstate
);
12608 kmem_free(ep
, sizeof (dtrace_ecbdesc_t
));
12613 * APPLE NOTE: dyld handles dof relocation.
12614 * Darwin does not need dtrace_dof_relocate()
12618 * The dof_hdr_t passed to dtrace_dof_slurp() should be a partially validated
12619 * header: it should be at the front of a memory region that is at least
12620 * sizeof (dof_hdr_t) in size -- and then at least dof_hdr.dofh_loadsz in
12621 * size. It need not be validated in any other way.
12624 dtrace_dof_slurp(dof_hdr_t
*dof
, dtrace_vstate_t
*vstate
, cred_t
*cr
,
12625 dtrace_enabling_t
**enabp
, uint64_t ubase
, int noprobes
)
12627 #pragma unused(ubase) /* __APPLE__ */
12628 uint64_t len
= dof
->dofh_loadsz
, seclen
;
12629 uintptr_t daddr
= (uintptr_t)dof
;
12630 dtrace_ecbdesc_t
*ep
;
12631 dtrace_enabling_t
*enab
;
12634 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
12635 ASSERT(dof
->dofh_loadsz
>= sizeof (dof_hdr_t
));
12638 * Check the DOF header identification bytes. In addition to checking
12639 * valid settings, we also verify that unused bits/bytes are zeroed so
12640 * we can use them later without fear of regressing existing binaries.
12642 if (bcmp(&dof
->dofh_ident
[DOF_ID_MAG0
],
12643 DOF_MAG_STRING
, DOF_MAG_STRLEN
) != 0) {
12644 dtrace_dof_error(dof
, "DOF magic string mismatch");
12648 if (dof
->dofh_ident
[DOF_ID_MODEL
] != DOF_MODEL_ILP32
&&
12649 dof
->dofh_ident
[DOF_ID_MODEL
] != DOF_MODEL_LP64
) {
12650 dtrace_dof_error(dof
, "DOF has invalid data model");
12654 if (dof
->dofh_ident
[DOF_ID_ENCODING
] != DOF_ENCODE_NATIVE
) {
12655 dtrace_dof_error(dof
, "DOF encoding mismatch");
12660 * APPLE NOTE: Darwin only supports DOF_VERSION_3 for now.
12662 if (dof
->dofh_ident
[DOF_ID_VERSION
] != DOF_VERSION_3
) {
12663 dtrace_dof_error(dof
, "DOF version mismatch");
12667 if (dof
->dofh_ident
[DOF_ID_DIFVERS
] != DIF_VERSION_2
) {
12668 dtrace_dof_error(dof
, "DOF uses unsupported instruction set");
12672 if (dof
->dofh_ident
[DOF_ID_DIFIREG
] > DIF_DIR_NREGS
) {
12673 dtrace_dof_error(dof
, "DOF uses too many integer registers");
12677 if (dof
->dofh_ident
[DOF_ID_DIFTREG
] > DIF_DTR_NREGS
) {
12678 dtrace_dof_error(dof
, "DOF uses too many tuple registers");
12682 for (i
= DOF_ID_PAD
; i
< DOF_ID_SIZE
; i
++) {
12683 if (dof
->dofh_ident
[i
] != 0) {
12684 dtrace_dof_error(dof
, "DOF has invalid ident byte set");
12689 if (dof
->dofh_flags
& ~DOF_FL_VALID
) {
12690 dtrace_dof_error(dof
, "DOF has invalid flag bits set");
12694 if (dof
->dofh_secsize
== 0) {
12695 dtrace_dof_error(dof
, "zero section header size");
12700 * Check that the section headers don't exceed the amount of DOF
12701 * data. Note that we cast the section size and number of sections
12702 * to uint64_t's to prevent possible overflow in the multiplication.
12704 seclen
= (uint64_t)dof
->dofh_secnum
* (uint64_t)dof
->dofh_secsize
;
12706 if (dof
->dofh_secoff
> len
|| seclen
> len
||
12707 dof
->dofh_secoff
+ seclen
> len
) {
12708 dtrace_dof_error(dof
, "truncated section headers");
12712 if (!IS_P2ALIGNED(dof
->dofh_secoff
, sizeof (uint64_t))) {
12713 dtrace_dof_error(dof
, "misaligned section headers");
12717 if (!IS_P2ALIGNED(dof
->dofh_secsize
, sizeof (uint64_t))) {
12718 dtrace_dof_error(dof
, "misaligned section size");
12723 * Take an initial pass through the section headers to be sure that
12724 * the headers don't have stray offsets. If the 'noprobes' flag is
12725 * set, do not permit sections relating to providers, probes, or args.
12727 for (i
= 0; i
< dof
->dofh_secnum
; i
++) {
12728 dof_sec_t
*sec
= (dof_sec_t
*)(daddr
+
12729 (uintptr_t)dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
12732 switch (sec
->dofs_type
) {
12733 case DOF_SECT_PROVIDER
:
12734 case DOF_SECT_PROBES
:
12735 case DOF_SECT_PRARGS
:
12736 case DOF_SECT_PROFFS
:
12737 dtrace_dof_error(dof
, "illegal sections "
12743 if (!(sec
->dofs_flags
& DOF_SECF_LOAD
))
12744 continue; /* just ignore non-loadable sections */
12746 if (sec
->dofs_align
& (sec
->dofs_align
- 1)) {
12747 dtrace_dof_error(dof
, "bad section alignment");
12751 if (sec
->dofs_offset
& (sec
->dofs_align
- 1)) {
12752 dtrace_dof_error(dof
, "misaligned section");
12756 if (sec
->dofs_offset
> len
|| sec
->dofs_size
> len
||
12757 sec
->dofs_offset
+ sec
->dofs_size
> len
) {
12758 dtrace_dof_error(dof
, "corrupt section header");
12762 if (sec
->dofs_type
== DOF_SECT_STRTAB
&& *((char *)daddr
+
12763 sec
->dofs_offset
+ sec
->dofs_size
- 1) != '\0') {
12764 dtrace_dof_error(dof
, "non-terminating string table");
12770 * APPLE NOTE: We have no further relocation to perform.
12771 * All dof values are relative offsets.
12774 if ((enab
= *enabp
) == NULL
)
12775 enab
= *enabp
= dtrace_enabling_create(vstate
);
12777 for (i
= 0; i
< dof
->dofh_secnum
; i
++) {
12778 dof_sec_t
*sec
= (dof_sec_t
*)(daddr
+
12779 (uintptr_t)dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
12781 if (sec
->dofs_type
!= DOF_SECT_ECBDESC
)
12785 * APPLE NOTE: Defend against gcc 4.0 botch on x86.
12786 * not all paths out of inlined dtrace_dof_ecbdesc
12787 * are checked for the NULL return value.
12788 * Check for NULL explicitly here.
12790 ep
= dtrace_dof_ecbdesc(dof
, sec
, vstate
, cr
);
12792 dtrace_enabling_destroy(enab
);
12797 dtrace_enabling_add(enab
, ep
);
12804 * Process DOF for any options. This routine assumes that the DOF has been
12805 * at least processed by dtrace_dof_slurp().
12808 dtrace_dof_options(dof_hdr_t
*dof
, dtrace_state_t
*state
)
12814 dof_optdesc_t
*desc
;
12816 for (i
= 0; i
< dof
->dofh_secnum
; i
++) {
12817 dof_sec_t
*sec
= (dof_sec_t
*)((uintptr_t)dof
+
12818 (uintptr_t)dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
12820 if (sec
->dofs_type
!= DOF_SECT_OPTDESC
)
12823 if (sec
->dofs_align
!= sizeof (uint64_t)) {
12824 dtrace_dof_error(dof
, "bad alignment in "
12825 "option description");
12829 if ((entsize
= sec
->dofs_entsize
) == 0) {
12830 dtrace_dof_error(dof
, "zeroed option entry size");
12834 if (entsize
< sizeof (dof_optdesc_t
)) {
12835 dtrace_dof_error(dof
, "bad option entry size");
12839 for (offs
= 0; offs
< sec
->dofs_size
; offs
+= entsize
) {
12840 desc
= (dof_optdesc_t
*)((uintptr_t)dof
+
12841 (uintptr_t)sec
->dofs_offset
+ offs
);
12843 if (desc
->dofo_strtab
!= DOF_SECIDX_NONE
) {
12844 dtrace_dof_error(dof
, "non-zero option string");
12848 if (desc
->dofo_value
== (uint64_t)DTRACEOPT_UNSET
) {
12849 dtrace_dof_error(dof
, "unset option");
12853 if ((rval
= dtrace_state_option(state
,
12854 desc
->dofo_option
, desc
->dofo_value
)) != 0) {
12855 dtrace_dof_error(dof
, "rejected option");
12865 * DTrace Consumer State Functions
12868 dtrace_dstate_init(dtrace_dstate_t
*dstate
, size_t size
)
12870 size_t hashsize
, maxper
, min_size
, chunksize
= dstate
->dtds_chunksize
;
12873 dtrace_dynvar_t
*dvar
, *next
, *start
;
12876 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
12877 ASSERT(dstate
->dtds_base
== NULL
&& dstate
->dtds_percpu
== NULL
);
12879 bzero(dstate
, sizeof (dtrace_dstate_t
));
12881 if ((dstate
->dtds_chunksize
= chunksize
) == 0)
12882 dstate
->dtds_chunksize
= DTRACE_DYNVAR_CHUNKSIZE
;
12884 VERIFY(dstate
->dtds_chunksize
< (LONG_MAX
- sizeof (dtrace_dynhash_t
)));
12886 if (size
< (min_size
= dstate
->dtds_chunksize
+ sizeof (dtrace_dynhash_t
)))
12889 if ((base
= kmem_zalloc(size
, KM_NOSLEEP
)) == NULL
)
12892 dstate
->dtds_size
= size
;
12893 dstate
->dtds_base
= base
;
12894 dstate
->dtds_percpu
= kmem_cache_alloc(dtrace_state_cache
, KM_SLEEP
);
12895 bzero(dstate
->dtds_percpu
, (int)NCPU
* sizeof (dtrace_dstate_percpu_t
));
12897 hashsize
= size
/ (dstate
->dtds_chunksize
+ sizeof (dtrace_dynhash_t
));
12899 if (hashsize
!= 1 && (hashsize
& 1))
12902 dstate
->dtds_hashsize
= hashsize
;
12903 dstate
->dtds_hash
= dstate
->dtds_base
;
12906 * Set all of our hash buckets to point to the single sink, and (if
12907 * it hasn't already been set), set the sink's hash value to be the
12908 * sink sentinel value. The sink is needed for dynamic variable
12909 * lookups to know that they have iterated over an entire, valid hash
12912 for (i
= 0; i
< hashsize
; i
++)
12913 dstate
->dtds_hash
[i
].dtdh_chain
= &dtrace_dynhash_sink
;
12915 if (dtrace_dynhash_sink
.dtdv_hashval
!= DTRACE_DYNHASH_SINK
)
12916 dtrace_dynhash_sink
.dtdv_hashval
= DTRACE_DYNHASH_SINK
;
12919 * Determine number of active CPUs. Divide free list evenly among
12922 start
= (dtrace_dynvar_t
*)
12923 ((uintptr_t)base
+ hashsize
* sizeof (dtrace_dynhash_t
));
12924 limit
= (uintptr_t)base
+ size
;
12926 VERIFY((uintptr_t)start
< limit
);
12927 VERIFY((uintptr_t)start
>= (uintptr_t)base
);
12929 maxper
= (limit
- (uintptr_t)start
) / (int)NCPU
;
12930 maxper
= (maxper
/ dstate
->dtds_chunksize
) * dstate
->dtds_chunksize
;
12932 for (i
= 0; i
< NCPU
; i
++) {
12933 dstate
->dtds_percpu
[i
].dtdsc_free
= dvar
= start
;
12936 * If we don't even have enough chunks to make it once through
12937 * NCPUs, we're just going to allocate everything to the first
12938 * CPU. And if we're on the last CPU, we're going to allocate
12939 * whatever is left over. In either case, we set the limit to
12940 * be the limit of the dynamic variable space.
12942 if (maxper
== 0 || i
== NCPU
- 1) {
12943 limit
= (uintptr_t)base
+ size
;
12946 limit
= (uintptr_t)start
+ maxper
;
12947 start
= (dtrace_dynvar_t
*)limit
;
12950 VERIFY(limit
<= (uintptr_t)base
+ size
);
12953 next
= (dtrace_dynvar_t
*)((uintptr_t)dvar
+
12954 dstate
->dtds_chunksize
);
12956 if ((uintptr_t)next
+ dstate
->dtds_chunksize
>= limit
)
12959 VERIFY((uintptr_t)dvar
>= (uintptr_t)base
&&
12960 (uintptr_t)dvar
<= (uintptr_t)base
+ size
);
12961 dvar
->dtdv_next
= next
;
12973 dtrace_dstate_fini(dtrace_dstate_t
*dstate
)
12975 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
12977 if (dstate
->dtds_base
== NULL
)
12980 kmem_free(dstate
->dtds_base
, dstate
->dtds_size
);
12981 kmem_cache_free(dtrace_state_cache
, dstate
->dtds_percpu
);
12985 dtrace_vstate_fini(dtrace_vstate_t
*vstate
)
12988 * Logical XOR, where are you?
12990 ASSERT((vstate
->dtvs_nglobals
== 0) ^ (vstate
->dtvs_globals
!= NULL
));
12992 if (vstate
->dtvs_nglobals
> 0) {
12993 kmem_free(vstate
->dtvs_globals
, vstate
->dtvs_nglobals
*
12994 sizeof (dtrace_statvar_t
*));
12997 if (vstate
->dtvs_ntlocals
> 0) {
12998 kmem_free(vstate
->dtvs_tlocals
, vstate
->dtvs_ntlocals
*
12999 sizeof (dtrace_difv_t
));
13002 ASSERT((vstate
->dtvs_nlocals
== 0) ^ (vstate
->dtvs_locals
!= NULL
));
13004 if (vstate
->dtvs_nlocals
> 0) {
13005 kmem_free(vstate
->dtvs_locals
, vstate
->dtvs_nlocals
*
13006 sizeof (dtrace_statvar_t
*));
13011 dtrace_state_clean(dtrace_state_t
*state
)
13013 if (state
->dts_activity
== DTRACE_ACTIVITY_INACTIVE
)
13016 dtrace_dynvar_clean(&state
->dts_vstate
.dtvs_dynvars
);
13017 dtrace_speculation_clean(state
);
13021 dtrace_state_deadman(dtrace_state_t
*state
)
13027 now
= dtrace_gethrtime();
13029 if (state
!= dtrace_anon
.dta_state
&&
13030 now
- state
->dts_laststatus
>= dtrace_deadman_user
)
13034 * We must be sure that dts_alive never appears to be less than the
13035 * value upon entry to dtrace_state_deadman(), and because we lack a
13036 * dtrace_cas64(), we cannot store to it atomically. We thus instead
13037 * store INT64_MAX to it, followed by a memory barrier, followed by
13038 * the new value. This assures that dts_alive never appears to be
13039 * less than its true value, regardless of the order in which the
13040 * stores to the underlying storage are issued.
13042 state
->dts_alive
= INT64_MAX
;
13043 dtrace_membar_producer();
13044 state
->dts_alive
= now
;
13048 dtrace_state_create(dev_t
*devp
, cred_t
*cr
, dtrace_state_t
**new_state
)
13053 dtrace_state_t
*state
;
13054 dtrace_optval_t
*opt
;
13055 int bufsize
= (int)NCPU
* sizeof (dtrace_buffer_t
), i
;
13057 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13058 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
13060 /* Cause restart */
13063 minor
= getminor(*devp
);
13065 state
= dtrace_state_allocate(minor
);
13066 if (NULL
== state
) {
13067 printf("dtrace_open: couldn't acquire minor number %d. This usually means that too many DTrace clients are in use at the moment", minor
);
13068 return (ERESTART
); /* can't reacquire */
13071 state
->dts_epid
= DTRACE_EPIDNONE
+ 1;
13073 (void) snprintf(c
, sizeof (c
), "dtrace_aggid_%d", minor
);
13074 state
->dts_aggid_arena
= vmem_create(c
, (void *)1, UINT32_MAX
, 1,
13075 NULL
, NULL
, NULL
, 0, VM_SLEEP
| VMC_IDENTIFIER
);
13077 if (devp
!= NULL
) {
13078 major
= getemajor(*devp
);
13080 major
= ddi_driver_major(dtrace_devi
);
13083 state
->dts_dev
= makedevice(major
, minor
);
13086 *devp
= state
->dts_dev
;
13089 * We allocate NCPU buffers. On the one hand, this can be quite
13090 * a bit of memory per instance (nearly 36K on a Starcat). On the
13091 * other hand, it saves an additional memory reference in the probe
13094 state
->dts_buffer
= kmem_zalloc(bufsize
, KM_SLEEP
);
13095 state
->dts_aggbuffer
= kmem_zalloc(bufsize
, KM_SLEEP
);
13096 state
->dts_buf_over_limit
= 0;
13097 state
->dts_cleaner
= CYCLIC_NONE
;
13098 state
->dts_deadman
= CYCLIC_NONE
;
13099 state
->dts_vstate
.dtvs_state
= state
;
13101 for (i
= 0; i
< DTRACEOPT_MAX
; i
++)
13102 state
->dts_options
[i
] = DTRACEOPT_UNSET
;
13105 * Set the default options.
13107 opt
= state
->dts_options
;
13108 opt
[DTRACEOPT_BUFPOLICY
] = DTRACEOPT_BUFPOLICY_SWITCH
;
13109 opt
[DTRACEOPT_BUFRESIZE
] = DTRACEOPT_BUFRESIZE_AUTO
;
13110 opt
[DTRACEOPT_NSPEC
] = dtrace_nspec_default
;
13111 opt
[DTRACEOPT_SPECSIZE
] = dtrace_specsize_default
;
13112 opt
[DTRACEOPT_CPU
] = (dtrace_optval_t
)DTRACE_CPUALL
;
13113 opt
[DTRACEOPT_STRSIZE
] = dtrace_strsize_default
;
13114 opt
[DTRACEOPT_STACKFRAMES
] = dtrace_stackframes_default
;
13115 opt
[DTRACEOPT_USTACKFRAMES
] = dtrace_ustackframes_default
;
13116 opt
[DTRACEOPT_CLEANRATE
] = dtrace_cleanrate_default
;
13117 opt
[DTRACEOPT_AGGRATE
] = dtrace_aggrate_default
;
13118 opt
[DTRACEOPT_SWITCHRATE
] = dtrace_switchrate_default
;
13119 opt
[DTRACEOPT_STATUSRATE
] = dtrace_statusrate_default
;
13120 opt
[DTRACEOPT_JSTACKFRAMES
] = dtrace_jstackframes_default
;
13121 opt
[DTRACEOPT_JSTACKSTRSIZE
] = dtrace_jstackstrsize_default
;
13122 opt
[DTRACEOPT_BUFLIMIT
] = dtrace_buflimit_default
;
13125 * Depending on the user credentials, we set flag bits which alter probe
13126 * visibility or the amount of destructiveness allowed. In the case of
13127 * actual anonymous tracing, or the possession of all privileges, all of
13128 * the normal checks are bypassed.
13130 #if defined(__APPLE__)
13131 if (cr
== NULL
|| PRIV_POLICY_ONLY(cr
, PRIV_ALL
, B_FALSE
)) {
13132 if (dtrace_is_restricted() && !dtrace_are_restrictions_relaxed()) {
13134 * Allow only proc credentials when DTrace is
13135 * restricted by the current security policy
13137 state
->dts_cred
.dcr_visible
= DTRACE_CRV_ALLPROC
;
13138 state
->dts_cred
.dcr_action
= DTRACE_CRA_PROC
| DTRACE_CRA_PROC_CONTROL
| DTRACE_CRA_PROC_DESTRUCTIVE_ALLUSER
;
13141 state
->dts_cred
.dcr_visible
= DTRACE_CRV_ALL
;
13142 state
->dts_cred
.dcr_action
= DTRACE_CRA_ALL
;
13147 if (cr
== NULL
|| PRIV_POLICY_ONLY(cr
, PRIV_ALL
, B_FALSE
)) {
13148 state
->dts_cred
.dcr_visible
= DTRACE_CRV_ALL
;
13149 state
->dts_cred
.dcr_action
= DTRACE_CRA_ALL
;
13153 * Set up the credentials for this instantiation. We take a
13154 * hold on the credential to prevent it from disappearing on
13155 * us; this in turn prevents the zone_t referenced by this
13156 * credential from disappearing. This means that we can
13157 * examine the credential and the zone from probe context.
13160 state
->dts_cred
.dcr_cred
= cr
;
13163 * CRA_PROC means "we have *some* privilege for dtrace" and
13164 * unlocks the use of variables like pid, zonename, etc.
13166 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_USER
, B_FALSE
) ||
13167 PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_PROC
, B_FALSE
)) {
13168 state
->dts_cred
.dcr_action
|= DTRACE_CRA_PROC
;
13172 * dtrace_user allows use of syscall and profile providers.
13173 * If the user also has proc_owner and/or proc_zone, we
13174 * extend the scope to include additional visibility and
13175 * destructive power.
13177 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_USER
, B_FALSE
)) {
13178 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_OWNER
, B_FALSE
)) {
13179 state
->dts_cred
.dcr_visible
|=
13180 DTRACE_CRV_ALLPROC
;
13182 state
->dts_cred
.dcr_action
|=
13183 DTRACE_CRA_PROC_DESTRUCTIVE_ALLUSER
;
13186 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_ZONE
, B_FALSE
)) {
13187 state
->dts_cred
.dcr_visible
|=
13188 DTRACE_CRV_ALLZONE
;
13190 state
->dts_cred
.dcr_action
|=
13191 DTRACE_CRA_PROC_DESTRUCTIVE_ALLZONE
;
13195 * If we have all privs in whatever zone this is,
13196 * we can do destructive things to processes which
13197 * have altered credentials.
13199 * APPLE NOTE: Darwin doesn't do zones.
13200 * Behave as if zone always has destructive privs.
13203 state
->dts_cred
.dcr_action
|=
13204 DTRACE_CRA_PROC_DESTRUCTIVE_CREDCHG
;
13208 * Holding the dtrace_kernel privilege also implies that
13209 * the user has the dtrace_user privilege from a visibility
13210 * perspective. But without further privileges, some
13211 * destructive actions are not available.
13213 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_KERNEL
, B_FALSE
)) {
13215 * Make all probes in all zones visible. However,
13216 * this doesn't mean that all actions become available
13219 state
->dts_cred
.dcr_visible
|= DTRACE_CRV_KERNEL
|
13220 DTRACE_CRV_ALLPROC
| DTRACE_CRV_ALLZONE
;
13222 state
->dts_cred
.dcr_action
|= DTRACE_CRA_KERNEL
|
13225 * Holding proc_owner means that destructive actions
13226 * for *this* zone are allowed.
13228 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_OWNER
, B_FALSE
))
13229 state
->dts_cred
.dcr_action
|=
13230 DTRACE_CRA_PROC_DESTRUCTIVE_ALLUSER
;
13233 * Holding proc_zone means that destructive actions
13234 * for this user/group ID in all zones is allowed.
13236 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_ZONE
, B_FALSE
))
13237 state
->dts_cred
.dcr_action
|=
13238 DTRACE_CRA_PROC_DESTRUCTIVE_ALLZONE
;
13241 * If we have all privs in whatever zone this is,
13242 * we can do destructive things to processes which
13243 * have altered credentials.
13245 * APPLE NOTE: Darwin doesn't do zones.
13246 * Behave as if zone always has destructive privs.
13248 state
->dts_cred
.dcr_action
|=
13249 DTRACE_CRA_PROC_DESTRUCTIVE_CREDCHG
;
13253 * Holding the dtrace_proc privilege gives control over fasttrap
13254 * and pid providers. We need to grant wider destructive
13255 * privileges in the event that the user has proc_owner and/or
13258 if (PRIV_POLICY_ONLY(cr
, PRIV_DTRACE_PROC
, B_FALSE
)) {
13259 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_OWNER
, B_FALSE
))
13260 state
->dts_cred
.dcr_action
|=
13261 DTRACE_CRA_PROC_DESTRUCTIVE_ALLUSER
;
13263 if (PRIV_POLICY_ONLY(cr
, PRIV_PROC_ZONE
, B_FALSE
))
13264 state
->dts_cred
.dcr_action
|=
13265 DTRACE_CRA_PROC_DESTRUCTIVE_ALLZONE
;
13270 *new_state
= state
;
13271 return(0); /* Success */
13275 dtrace_state_buffer(dtrace_state_t
*state
, dtrace_buffer_t
*buf
, int which
)
13277 dtrace_optval_t
*opt
= state
->dts_options
, size
;
13278 processorid_t cpu
= 0;
13279 size_t limit
= buf
->dtb_size
;
13280 int flags
= 0, rval
;
13282 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13283 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
13284 ASSERT(which
< DTRACEOPT_MAX
);
13285 ASSERT(state
->dts_activity
== DTRACE_ACTIVITY_INACTIVE
||
13286 (state
== dtrace_anon
.dta_state
&&
13287 state
->dts_activity
== DTRACE_ACTIVITY_ACTIVE
));
13289 if (opt
[which
] == DTRACEOPT_UNSET
|| opt
[which
] == 0)
13292 if (opt
[DTRACEOPT_CPU
] != DTRACEOPT_UNSET
)
13293 cpu
= opt
[DTRACEOPT_CPU
];
13295 if (which
== DTRACEOPT_SPECSIZE
)
13296 flags
|= DTRACEBUF_NOSWITCH
;
13298 if (which
== DTRACEOPT_BUFSIZE
) {
13299 if (opt
[DTRACEOPT_BUFPOLICY
] == DTRACEOPT_BUFPOLICY_RING
)
13300 flags
|= DTRACEBUF_RING
;
13302 if (opt
[DTRACEOPT_BUFPOLICY
] == DTRACEOPT_BUFPOLICY_FILL
)
13303 flags
|= DTRACEBUF_FILL
;
13305 if (state
!= dtrace_anon
.dta_state
||
13306 state
->dts_activity
!= DTRACE_ACTIVITY_ACTIVE
)
13307 flags
|= DTRACEBUF_INACTIVE
;
13310 for (size
= opt
[which
]; (size_t)size
>= sizeof (uint64_t); size
>>= 1) {
13312 * The size must be 8-byte aligned. If the size is not 8-byte
13313 * aligned, drop it down by the difference.
13315 if (size
& (sizeof (uint64_t) - 1))
13316 size
-= size
& (sizeof (uint64_t) - 1);
13318 if (size
< state
->dts_reserve
) {
13320 * Buffers always must be large enough to accommodate
13321 * their prereserved space. We return E2BIG instead
13322 * of ENOMEM in this case to allow for user-level
13323 * software to differentiate the cases.
13327 limit
= opt
[DTRACEOPT_BUFLIMIT
] * size
/ 100;
13328 rval
= dtrace_buffer_alloc(buf
, limit
, size
, flags
, cpu
);
13330 if (rval
!= ENOMEM
) {
13335 if (opt
[DTRACEOPT_BUFRESIZE
] == DTRACEOPT_BUFRESIZE_MANUAL
)
13343 dtrace_state_buffers(dtrace_state_t
*state
)
13345 dtrace_speculation_t
*spec
= state
->dts_speculations
;
13348 if ((rval
= dtrace_state_buffer(state
, state
->dts_buffer
,
13349 DTRACEOPT_BUFSIZE
)) != 0)
13352 if ((rval
= dtrace_state_buffer(state
, state
->dts_aggbuffer
,
13353 DTRACEOPT_AGGSIZE
)) != 0)
13356 for (i
= 0; i
< state
->dts_nspeculations
; i
++) {
13357 if ((rval
= dtrace_state_buffer(state
,
13358 spec
[i
].dtsp_buffer
, DTRACEOPT_SPECSIZE
)) != 0)
13366 dtrace_state_prereserve(dtrace_state_t
*state
)
13369 dtrace_probe_t
*probe
;
13371 state
->dts_reserve
= 0;
13373 if (state
->dts_options
[DTRACEOPT_BUFPOLICY
] != DTRACEOPT_BUFPOLICY_FILL
)
13377 * If our buffer policy is a "fill" buffer policy, we need to set the
13378 * prereserved space to be the space required by the END probes.
13380 probe
= dtrace_probes
[dtrace_probeid_end
- 1];
13381 ASSERT(probe
!= NULL
);
13383 for (ecb
= probe
->dtpr_ecb
; ecb
!= NULL
; ecb
= ecb
->dte_next
) {
13384 if (ecb
->dte_state
!= state
)
13387 state
->dts_reserve
+= ecb
->dte_needed
+ ecb
->dte_alignment
;
13392 dtrace_state_go(dtrace_state_t
*state
, processorid_t
*cpu
)
13394 dtrace_optval_t
*opt
= state
->dts_options
, sz
, nspec
;
13395 dtrace_speculation_t
*spec
;
13396 dtrace_buffer_t
*buf
;
13397 cyc_handler_t hdlr
;
13399 int rval
= 0, i
, bufsize
= (int)NCPU
* sizeof (dtrace_buffer_t
);
13400 dtrace_icookie_t cookie
;
13402 lck_mtx_lock(&cpu_lock
);
13403 lck_mtx_lock(&dtrace_lock
);
13405 if (state
->dts_activity
!= DTRACE_ACTIVITY_INACTIVE
) {
13411 * Before we can perform any checks, we must prime all of the
13412 * retained enablings that correspond to this state.
13414 dtrace_enabling_prime(state
);
13416 if (state
->dts_destructive
&& !state
->dts_cred
.dcr_destructive
) {
13421 dtrace_state_prereserve(state
);
13424 * Now we want to do is try to allocate our speculations.
13425 * We do not automatically resize the number of speculations; if
13426 * this fails, we will fail the operation.
13428 nspec
= opt
[DTRACEOPT_NSPEC
];
13429 ASSERT(nspec
!= DTRACEOPT_UNSET
);
13431 if (nspec
> INT_MAX
) {
13436 spec
= kmem_zalloc(nspec
* sizeof (dtrace_speculation_t
), KM_NOSLEEP
);
13438 if (spec
== NULL
) {
13443 state
->dts_speculations
= spec
;
13444 state
->dts_nspeculations
= (int)nspec
;
13446 for (i
= 0; i
< nspec
; i
++) {
13447 if ((buf
= kmem_zalloc(bufsize
, KM_NOSLEEP
)) == NULL
) {
13452 spec
[i
].dtsp_buffer
= buf
;
13455 if (opt
[DTRACEOPT_GRABANON
] != DTRACEOPT_UNSET
) {
13456 if (dtrace_anon
.dta_state
== NULL
) {
13461 if (state
->dts_necbs
!= 0) {
13466 state
->dts_anon
= dtrace_anon_grab();
13467 ASSERT(state
->dts_anon
!= NULL
);
13468 state
= state
->dts_anon
;
13471 * We want "grabanon" to be set in the grabbed state, so we'll
13472 * copy that option value from the grabbing state into the
13475 state
->dts_options
[DTRACEOPT_GRABANON
] =
13476 opt
[DTRACEOPT_GRABANON
];
13478 *cpu
= dtrace_anon
.dta_beganon
;
13481 * If the anonymous state is active (as it almost certainly
13482 * is if the anonymous enabling ultimately matched anything),
13483 * we don't allow any further option processing -- but we
13484 * don't return failure.
13486 if (state
->dts_activity
!= DTRACE_ACTIVITY_INACTIVE
)
13490 if (opt
[DTRACEOPT_AGGSIZE
] != DTRACEOPT_UNSET
&&
13491 opt
[DTRACEOPT_AGGSIZE
] != 0) {
13492 if (state
->dts_aggregations
== NULL
) {
13494 * We're not going to create an aggregation buffer
13495 * because we don't have any ECBs that contain
13496 * aggregations -- set this option to 0.
13498 opt
[DTRACEOPT_AGGSIZE
] = 0;
13501 * If we have an aggregation buffer, we must also have
13502 * a buffer to use as scratch.
13504 if (opt
[DTRACEOPT_BUFSIZE
] == DTRACEOPT_UNSET
||
13505 (size_t)opt
[DTRACEOPT_BUFSIZE
] < state
->dts_needed
) {
13506 opt
[DTRACEOPT_BUFSIZE
] = state
->dts_needed
;
13511 if (opt
[DTRACEOPT_SPECSIZE
] != DTRACEOPT_UNSET
&&
13512 opt
[DTRACEOPT_SPECSIZE
] != 0) {
13513 if (!state
->dts_speculates
) {
13515 * We're not going to create speculation buffers
13516 * because we don't have any ECBs that actually
13517 * speculate -- set the speculation size to 0.
13519 opt
[DTRACEOPT_SPECSIZE
] = 0;
13524 * The bare minimum size for any buffer that we're actually going to
13525 * do anything to is sizeof (uint64_t).
13527 sz
= sizeof (uint64_t);
13529 if ((state
->dts_needed
!= 0 && opt
[DTRACEOPT_BUFSIZE
] < sz
) ||
13530 (state
->dts_speculates
&& opt
[DTRACEOPT_SPECSIZE
] < sz
) ||
13531 (state
->dts_aggregations
!= NULL
&& opt
[DTRACEOPT_AGGSIZE
] < sz
)) {
13533 * A buffer size has been explicitly set to 0 (or to a size
13534 * that will be adjusted to 0) and we need the space -- we
13535 * need to return failure. We return ENOSPC to differentiate
13536 * it from failing to allocate a buffer due to failure to meet
13537 * the reserve (for which we return E2BIG).
13543 if ((rval
= dtrace_state_buffers(state
)) != 0)
13546 if ((sz
= opt
[DTRACEOPT_DYNVARSIZE
]) == DTRACEOPT_UNSET
)
13547 sz
= dtrace_dstate_defsize
;
13550 rval
= dtrace_dstate_init(&state
->dts_vstate
.dtvs_dynvars
, sz
);
13555 if (opt
[DTRACEOPT_BUFRESIZE
] == DTRACEOPT_BUFRESIZE_MANUAL
)
13557 } while (sz
>>= 1);
13559 opt
[DTRACEOPT_DYNVARSIZE
] = sz
;
13564 if (opt
[DTRACEOPT_STATUSRATE
] > dtrace_statusrate_max
)
13565 opt
[DTRACEOPT_STATUSRATE
] = dtrace_statusrate_max
;
13567 if (opt
[DTRACEOPT_CLEANRATE
] == 0)
13568 opt
[DTRACEOPT_CLEANRATE
] = dtrace_cleanrate_max
;
13570 if (opt
[DTRACEOPT_CLEANRATE
] < dtrace_cleanrate_min
)
13571 opt
[DTRACEOPT_CLEANRATE
] = dtrace_cleanrate_min
;
13573 if (opt
[DTRACEOPT_CLEANRATE
] > dtrace_cleanrate_max
)
13574 opt
[DTRACEOPT_CLEANRATE
] = dtrace_cleanrate_max
;
13576 if (opt
[DTRACEOPT_STRSIZE
] > dtrace_strsize_max
)
13577 opt
[DTRACEOPT_STRSIZE
] = dtrace_strsize_max
;
13579 if (opt
[DTRACEOPT_STRSIZE
] < dtrace_strsize_min
)
13580 opt
[DTRACEOPT_STRSIZE
] = dtrace_strsize_min
;
13582 if (opt
[DTRACEOPT_BUFLIMIT
] > dtrace_buflimit_max
)
13583 opt
[DTRACEOPT_BUFLIMIT
] = dtrace_buflimit_max
;
13585 if (opt
[DTRACEOPT_BUFLIMIT
] < dtrace_buflimit_min
)
13586 opt
[DTRACEOPT_BUFLIMIT
] = dtrace_buflimit_min
;
13588 hdlr
.cyh_func
= (cyc_func_t
)dtrace_state_clean
;
13589 hdlr
.cyh_arg
= state
;
13590 hdlr
.cyh_level
= CY_LOW_LEVEL
;
13593 when
.cyt_interval
= opt
[DTRACEOPT_CLEANRATE
];
13595 state
->dts_cleaner
= cyclic_add(&hdlr
, &when
);
13597 hdlr
.cyh_func
= (cyc_func_t
)dtrace_state_deadman
;
13598 hdlr
.cyh_arg
= state
;
13599 hdlr
.cyh_level
= CY_LOW_LEVEL
;
13602 when
.cyt_interval
= dtrace_deadman_interval
;
13604 state
->dts_alive
= state
->dts_laststatus
= dtrace_gethrtime();
13605 state
->dts_deadman
= cyclic_add(&hdlr
, &when
);
13607 state
->dts_activity
= DTRACE_ACTIVITY_WARMUP
;
13610 * Now it's time to actually fire the BEGIN probe. We need to disable
13611 * interrupts here both to record the CPU on which we fired the BEGIN
13612 * probe (the data from this CPU will be processed first at user
13613 * level) and to manually activate the buffer for this CPU.
13615 cookie
= dtrace_interrupt_disable();
13616 *cpu
= CPU
->cpu_id
;
13617 ASSERT(state
->dts_buffer
[*cpu
].dtb_flags
& DTRACEBUF_INACTIVE
);
13618 state
->dts_buffer
[*cpu
].dtb_flags
&= ~DTRACEBUF_INACTIVE
;
13620 dtrace_probe(dtrace_probeid_begin
,
13621 (uint64_t)(uintptr_t)state
, 0, 0, 0, 0);
13622 dtrace_interrupt_enable(cookie
);
13624 * We may have had an exit action from a BEGIN probe; only change our
13625 * state to ACTIVE if we're still in WARMUP.
13627 ASSERT(state
->dts_activity
== DTRACE_ACTIVITY_WARMUP
||
13628 state
->dts_activity
== DTRACE_ACTIVITY_DRAINING
);
13630 if (state
->dts_activity
== DTRACE_ACTIVITY_WARMUP
)
13631 state
->dts_activity
= DTRACE_ACTIVITY_ACTIVE
;
13634 * Regardless of whether or not now we're in ACTIVE or DRAINING, we
13635 * want each CPU to transition its principal buffer out of the
13636 * INACTIVE state. Doing this assures that no CPU will suddenly begin
13637 * processing an ECB halfway down a probe's ECB chain; all CPUs will
13638 * atomically transition from processing none of a state's ECBs to
13639 * processing all of them.
13641 dtrace_xcall(DTRACE_CPUALL
,
13642 (dtrace_xcall_t
)dtrace_buffer_activate
, state
);
13646 dtrace_buffer_free(state
->dts_buffer
);
13647 dtrace_buffer_free(state
->dts_aggbuffer
);
13649 if ((nspec
= state
->dts_nspeculations
) == 0) {
13650 ASSERT(state
->dts_speculations
== NULL
);
13654 spec
= state
->dts_speculations
;
13655 ASSERT(spec
!= NULL
);
13657 for (i
= 0; i
< state
->dts_nspeculations
; i
++) {
13658 if ((buf
= spec
[i
].dtsp_buffer
) == NULL
)
13661 dtrace_buffer_free(buf
);
13662 kmem_free(buf
, bufsize
);
13665 kmem_free(spec
, nspec
* sizeof (dtrace_speculation_t
));
13666 state
->dts_nspeculations
= 0;
13667 state
->dts_speculations
= NULL
;
13670 lck_mtx_unlock(&dtrace_lock
);
13671 lck_mtx_unlock(&cpu_lock
);
13677 dtrace_state_stop(dtrace_state_t
*state
, processorid_t
*cpu
)
13679 dtrace_icookie_t cookie
;
13681 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13683 if (state
->dts_activity
!= DTRACE_ACTIVITY_ACTIVE
&&
13684 state
->dts_activity
!= DTRACE_ACTIVITY_DRAINING
)
13688 * We'll set the activity to DTRACE_ACTIVITY_DRAINING, and issue a sync
13689 * to be sure that every CPU has seen it. See below for the details
13690 * on why this is done.
13692 state
->dts_activity
= DTRACE_ACTIVITY_DRAINING
;
13696 * By this point, it is impossible for any CPU to be still processing
13697 * with DTRACE_ACTIVITY_ACTIVE. We can thus set our activity to
13698 * DTRACE_ACTIVITY_COOLDOWN and know that we're not racing with any
13699 * other CPU in dtrace_buffer_reserve(). This allows dtrace_probe()
13700 * and callees to know that the activity is DTRACE_ACTIVITY_COOLDOWN
13701 * iff we're in the END probe.
13703 state
->dts_activity
= DTRACE_ACTIVITY_COOLDOWN
;
13705 ASSERT(state
->dts_activity
== DTRACE_ACTIVITY_COOLDOWN
);
13708 * Finally, we can release the reserve and call the END probe. We
13709 * disable interrupts across calling the END probe to allow us to
13710 * return the CPU on which we actually called the END probe. This
13711 * allows user-land to be sure that this CPU's principal buffer is
13714 state
->dts_reserve
= 0;
13716 cookie
= dtrace_interrupt_disable();
13717 *cpu
= CPU
->cpu_id
;
13718 dtrace_probe(dtrace_probeid_end
,
13719 (uint64_t)(uintptr_t)state
, 0, 0, 0, 0);
13720 dtrace_interrupt_enable(cookie
);
13722 state
->dts_activity
= DTRACE_ACTIVITY_STOPPED
;
13729 dtrace_state_option(dtrace_state_t
*state
, dtrace_optid_t option
,
13730 dtrace_optval_t val
)
13732 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13734 if (state
->dts_activity
!= DTRACE_ACTIVITY_INACTIVE
)
13737 if (option
>= DTRACEOPT_MAX
)
13740 if (option
!= DTRACEOPT_CPU
&& val
< 0)
13744 case DTRACEOPT_DESTRUCTIVE
:
13746 * Prevent consumers from enabling destructive actions if DTrace
13747 * is running in a restricted environment, or if actions are
13750 if (dtrace_is_restricted() || dtrace_destructive_disallow
)
13753 state
->dts_cred
.dcr_destructive
= 1;
13756 case DTRACEOPT_BUFSIZE
:
13757 case DTRACEOPT_DYNVARSIZE
:
13758 case DTRACEOPT_AGGSIZE
:
13759 case DTRACEOPT_SPECSIZE
:
13760 case DTRACEOPT_STRSIZE
:
13764 if (val
>= LONG_MAX
) {
13766 * If this is an otherwise negative value, set it to
13767 * the highest multiple of 128m less than LONG_MAX.
13768 * Technically, we're adjusting the size without
13769 * regard to the buffer resizing policy, but in fact,
13770 * this has no effect -- if we set the buffer size to
13771 * ~LONG_MAX and the buffer policy is ultimately set to
13772 * be "manual", the buffer allocation is guaranteed to
13773 * fail, if only because the allocation requires two
13774 * buffers. (We set the the size to the highest
13775 * multiple of 128m because it ensures that the size
13776 * will remain a multiple of a megabyte when
13777 * repeatedly halved -- all the way down to 15m.)
13779 val
= LONG_MAX
- (1 << 27) + 1;
13783 state
->dts_options
[option
] = val
;
13789 dtrace_state_destroy(dtrace_state_t
*state
)
13792 dtrace_vstate_t
*vstate
= &state
->dts_vstate
;
13793 minor_t minor
= getminor(state
->dts_dev
);
13794 int i
, bufsize
= (int)NCPU
* sizeof (dtrace_buffer_t
);
13795 dtrace_speculation_t
*spec
= state
->dts_speculations
;
13796 int nspec
= state
->dts_nspeculations
;
13799 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13800 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
13803 * First, retract any retained enablings for this state.
13805 dtrace_enabling_retract(state
);
13806 ASSERT(state
->dts_nretained
== 0);
13808 if (state
->dts_activity
== DTRACE_ACTIVITY_ACTIVE
||
13809 state
->dts_activity
== DTRACE_ACTIVITY_DRAINING
) {
13811 * We have managed to come into dtrace_state_destroy() on a
13812 * hot enabling -- almost certainly because of a disorderly
13813 * shutdown of a consumer. (That is, a consumer that is
13814 * exiting without having called dtrace_stop().) In this case,
13815 * we're going to set our activity to be KILLED, and then
13816 * issue a sync to be sure that everyone is out of probe
13817 * context before we start blowing away ECBs.
13819 state
->dts_activity
= DTRACE_ACTIVITY_KILLED
;
13824 * Release the credential hold we took in dtrace_state_create().
13826 if (state
->dts_cred
.dcr_cred
!= NULL
)
13827 crfree(state
->dts_cred
.dcr_cred
);
13830 * Now we can safely disable and destroy any enabled probes. Because
13831 * any DTRACE_PRIV_KERNEL probes may actually be slowing our progress
13832 * (especially if they're all enabled), we take two passes through the
13833 * ECBs: in the first, we disable just DTRACE_PRIV_KERNEL probes, and
13834 * in the second we disable whatever is left over.
13836 for (match
= DTRACE_PRIV_KERNEL
; ; match
= 0) {
13837 for (i
= 0; i
< state
->dts_necbs
; i
++) {
13838 if ((ecb
= state
->dts_ecbs
[i
]) == NULL
)
13841 if (match
&& ecb
->dte_probe
!= NULL
) {
13842 dtrace_probe_t
*probe
= ecb
->dte_probe
;
13843 dtrace_provider_t
*prov
= probe
->dtpr_provider
;
13845 if (!(prov
->dtpv_priv
.dtpp_flags
& match
))
13849 dtrace_ecb_disable(ecb
);
13850 dtrace_ecb_destroy(ecb
);
13858 * Before we free the buffers, perform one more sync to assure that
13859 * every CPU is out of probe context.
13863 dtrace_buffer_free(state
->dts_buffer
);
13864 dtrace_buffer_free(state
->dts_aggbuffer
);
13866 for (i
= 0; i
< nspec
; i
++)
13867 dtrace_buffer_free(spec
[i
].dtsp_buffer
);
13869 if (state
->dts_cleaner
!= CYCLIC_NONE
)
13870 cyclic_remove(state
->dts_cleaner
);
13872 if (state
->dts_deadman
!= CYCLIC_NONE
)
13873 cyclic_remove(state
->dts_deadman
);
13875 dtrace_dstate_fini(&vstate
->dtvs_dynvars
);
13876 dtrace_vstate_fini(vstate
);
13877 kmem_free(state
->dts_ecbs
, state
->dts_necbs
* sizeof (dtrace_ecb_t
*));
13879 if (state
->dts_aggregations
!= NULL
) {
13881 for (i
= 0; i
< state
->dts_naggregations
; i
++)
13882 ASSERT(state
->dts_aggregations
[i
] == NULL
);
13884 ASSERT(state
->dts_naggregations
> 0);
13885 kmem_free(state
->dts_aggregations
,
13886 state
->dts_naggregations
* sizeof (dtrace_aggregation_t
*));
13889 kmem_free(state
->dts_buffer
, bufsize
);
13890 kmem_free(state
->dts_aggbuffer
, bufsize
);
13892 for (i
= 0; i
< nspec
; i
++)
13893 kmem_free(spec
[i
].dtsp_buffer
, bufsize
);
13895 kmem_free(spec
, nspec
* sizeof (dtrace_speculation_t
));
13897 dtrace_format_destroy(state
);
13899 vmem_destroy(state
->dts_aggid_arena
);
13900 dtrace_state_free(minor
);
13904 * DTrace Anonymous Enabling Functions
13906 static dtrace_state_t
*
13907 dtrace_anon_grab(void)
13909 dtrace_state_t
*state
;
13911 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13913 if ((state
= dtrace_anon
.dta_state
) == NULL
) {
13914 ASSERT(dtrace_anon
.dta_enabling
== NULL
);
13918 ASSERT(dtrace_anon
.dta_enabling
!= NULL
);
13919 ASSERT(dtrace_retained
!= NULL
);
13921 dtrace_enabling_destroy(dtrace_anon
.dta_enabling
);
13922 dtrace_anon
.dta_enabling
= NULL
;
13923 dtrace_anon
.dta_state
= NULL
;
13929 dtrace_anon_property(void)
13932 dtrace_state_t
*state
;
13934 char c
[32]; /* enough for "dof-data-" + digits */
13936 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
13937 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
13939 for (i
= 0; ; i
++) {
13940 (void) snprintf(c
, sizeof (c
), "dof-data-%d", i
);
13942 dtrace_err_verbose
= 1;
13944 if ((dof
= dtrace_dof_property(c
)) == NULL
) {
13945 dtrace_err_verbose
= 0;
13950 * We want to create anonymous state, so we need to transition
13951 * the kernel debugger to indicate that DTrace is active. If
13952 * this fails (e.g. because the debugger has modified text in
13953 * some way), we won't continue with the processing.
13955 if (kdi_dtrace_set(KDI_DTSET_DTRACE_ACTIVATE
) != 0) {
13956 cmn_err(CE_NOTE
, "kernel debugger active; anonymous "
13957 "enabling ignored.");
13958 dtrace_dof_destroy(dof
);
13963 * If we haven't allocated an anonymous state, we'll do so now.
13965 if ((state
= dtrace_anon
.dta_state
) == NULL
) {
13966 rv
= dtrace_state_create(NULL
, NULL
, &state
);
13967 dtrace_anon
.dta_state
= state
;
13968 if (rv
!= 0 || state
== NULL
) {
13970 * This basically shouldn't happen: the only
13971 * failure mode from dtrace_state_create() is a
13972 * failure of ddi_soft_state_zalloc() that
13973 * itself should never happen. Still, the
13974 * interface allows for a failure mode, and
13975 * we want to fail as gracefully as possible:
13976 * we'll emit an error message and cease
13977 * processing anonymous state in this case.
13979 cmn_err(CE_WARN
, "failed to create "
13980 "anonymous state");
13981 dtrace_dof_destroy(dof
);
13986 rv
= dtrace_dof_slurp(dof
, &state
->dts_vstate
, CRED(),
13987 &dtrace_anon
.dta_enabling
, 0, B_TRUE
);
13990 rv
= dtrace_dof_options(dof
, state
);
13992 dtrace_err_verbose
= 0;
13993 dtrace_dof_destroy(dof
);
13997 * This is malformed DOF; chuck any anonymous state
14000 ASSERT(dtrace_anon
.dta_enabling
== NULL
);
14001 dtrace_state_destroy(state
);
14002 dtrace_anon
.dta_state
= NULL
;
14006 ASSERT(dtrace_anon
.dta_enabling
!= NULL
);
14009 if (dtrace_anon
.dta_enabling
!= NULL
) {
14013 * dtrace_enabling_retain() can only fail because we are
14014 * trying to retain more enablings than are allowed -- but
14015 * we only have one anonymous enabling, and we are guaranteed
14016 * to be allowed at least one retained enabling; we assert
14017 * that dtrace_enabling_retain() returns success.
14019 rval
= dtrace_enabling_retain(dtrace_anon
.dta_enabling
);
14022 dtrace_enabling_dump(dtrace_anon
.dta_enabling
);
14027 * DTrace Helper Functions
14030 dtrace_helper_trace(dtrace_helper_action_t
*helper
,
14031 dtrace_mstate_t
*mstate
, dtrace_vstate_t
*vstate
, int where
)
14033 uint32_t size
, next
, nnext
;
14035 dtrace_helptrace_t
*ent
;
14036 uint16_t flags
= cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
14038 if (!dtrace_helptrace_enabled
)
14041 ASSERT((uint32_t)vstate
->dtvs_nlocals
<= dtrace_helptrace_nlocals
);
14044 * What would a tracing framework be without its own tracing
14045 * framework? (Well, a hell of a lot simpler, for starters...)
14047 size
= sizeof (dtrace_helptrace_t
) + dtrace_helptrace_nlocals
*
14048 sizeof (uint64_t) - sizeof (uint64_t);
14051 * Iterate until we can allocate a slot in the trace buffer.
14054 next
= dtrace_helptrace_next
;
14056 if (next
+ size
< dtrace_helptrace_bufsize
) {
14057 nnext
= next
+ size
;
14061 } while (dtrace_cas32(&dtrace_helptrace_next
, next
, nnext
) != next
);
14064 * We have our slot; fill it in.
14069 ent
= (dtrace_helptrace_t
*)&dtrace_helptrace_buffer
[next
];
14070 ent
->dtht_helper
= helper
;
14071 ent
->dtht_where
= where
;
14072 ent
->dtht_nlocals
= vstate
->dtvs_nlocals
;
14074 ent
->dtht_fltoffs
= (mstate
->dtms_present
& DTRACE_MSTATE_FLTOFFS
) ?
14075 mstate
->dtms_fltoffs
: -1;
14076 ent
->dtht_fault
= DTRACE_FLAGS2FLT(flags
);
14077 ent
->dtht_illval
= cpu_core
[CPU
->cpu_id
].cpuc_dtrace_illval
;
14079 for (i
= 0; i
< vstate
->dtvs_nlocals
; i
++) {
14080 dtrace_statvar_t
*svar
;
14082 if ((svar
= vstate
->dtvs_locals
[i
]) == NULL
)
14085 ASSERT(svar
->dtsv_size
>= (int)NCPU
* sizeof (uint64_t));
14086 ent
->dtht_locals
[i
] =
14087 ((uint64_t *)(uintptr_t)svar
->dtsv_data
)[CPU
->cpu_id
];
14092 dtrace_helper(int which
, dtrace_mstate_t
*mstate
,
14093 dtrace_state_t
*state
, uint64_t arg0
, uint64_t arg1
)
14095 uint16_t *flags
= &cpu_core
[CPU
->cpu_id
].cpuc_dtrace_flags
;
14096 uint64_t sarg0
= mstate
->dtms_arg
[0];
14097 uint64_t sarg1
= mstate
->dtms_arg
[1];
14099 dtrace_helpers_t
*helpers
= curproc
->p_dtrace_helpers
;
14100 dtrace_helper_action_t
*helper
;
14101 dtrace_vstate_t
*vstate
;
14102 dtrace_difo_t
*pred
;
14103 int i
, trace
= dtrace_helptrace_enabled
;
14105 ASSERT(which
>= 0 && which
< DTRACE_NHELPER_ACTIONS
);
14107 if (helpers
== NULL
)
14110 if ((helper
= helpers
->dthps_actions
[which
]) == NULL
)
14113 vstate
= &helpers
->dthps_vstate
;
14114 mstate
->dtms_arg
[0] = arg0
;
14115 mstate
->dtms_arg
[1] = arg1
;
14118 * Now iterate over each helper. If its predicate evaluates to 'true',
14119 * we'll call the corresponding actions. Note that the below calls
14120 * to dtrace_dif_emulate() may set faults in machine state. This is
14121 * okay: our caller (the outer dtrace_dif_emulate()) will simply plow
14122 * the stored DIF offset with its own (which is the desired behavior).
14123 * Also, note the calls to dtrace_dif_emulate() may allocate scratch
14124 * from machine state; this is okay, too.
14126 for (; helper
!= NULL
; helper
= helper
->dtha_next
) {
14127 if ((pred
= helper
->dtha_predicate
) != NULL
) {
14129 dtrace_helper_trace(helper
, mstate
, vstate
, 0);
14131 if (!dtrace_dif_emulate(pred
, mstate
, vstate
, state
))
14134 if (*flags
& CPU_DTRACE_FAULT
)
14138 for (i
= 0; i
< helper
->dtha_nactions
; i
++) {
14140 dtrace_helper_trace(helper
,
14141 mstate
, vstate
, i
+ 1);
14143 rval
= dtrace_dif_emulate(helper
->dtha_actions
[i
],
14144 mstate
, vstate
, state
);
14146 if (*flags
& CPU_DTRACE_FAULT
)
14152 dtrace_helper_trace(helper
, mstate
, vstate
,
14153 DTRACE_HELPTRACE_NEXT
);
14157 dtrace_helper_trace(helper
, mstate
, vstate
,
14158 DTRACE_HELPTRACE_DONE
);
14161 * Restore the arg0 that we saved upon entry.
14163 mstate
->dtms_arg
[0] = sarg0
;
14164 mstate
->dtms_arg
[1] = sarg1
;
14170 dtrace_helper_trace(helper
, mstate
, vstate
,
14171 DTRACE_HELPTRACE_ERR
);
14174 * Restore the arg0 that we saved upon entry.
14176 mstate
->dtms_arg
[0] = sarg0
;
14177 mstate
->dtms_arg
[1] = sarg1
;
14183 dtrace_helper_action_destroy(dtrace_helper_action_t
*helper
,
14184 dtrace_vstate_t
*vstate
)
14188 if (helper
->dtha_predicate
!= NULL
)
14189 dtrace_difo_release(helper
->dtha_predicate
, vstate
);
14191 for (i
= 0; i
< helper
->dtha_nactions
; i
++) {
14192 ASSERT(helper
->dtha_actions
[i
] != NULL
);
14193 dtrace_difo_release(helper
->dtha_actions
[i
], vstate
);
14196 kmem_free(helper
->dtha_actions
,
14197 helper
->dtha_nactions
* sizeof (dtrace_difo_t
*));
14198 kmem_free(helper
, sizeof (dtrace_helper_action_t
));
14202 dtrace_helper_destroygen(proc_t
* p
, int gen
)
14204 dtrace_helpers_t
*help
= p
->p_dtrace_helpers
;
14205 dtrace_vstate_t
*vstate
;
14208 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
14210 if (help
== NULL
|| gen
> help
->dthps_generation
)
14213 vstate
= &help
->dthps_vstate
;
14215 for (i
= 0; i
< DTRACE_NHELPER_ACTIONS
; i
++) {
14216 dtrace_helper_action_t
*last
= NULL
, *h
, *next
;
14218 for (h
= help
->dthps_actions
[i
]; h
!= NULL
; h
= next
) {
14219 next
= h
->dtha_next
;
14221 if (h
->dtha_generation
== gen
) {
14222 if (last
!= NULL
) {
14223 last
->dtha_next
= next
;
14225 help
->dthps_actions
[i
] = next
;
14228 dtrace_helper_action_destroy(h
, vstate
);
14236 * Interate until we've cleared out all helper providers with the
14237 * given generation number.
14240 dtrace_helper_provider_t
*prov
= NULL
;
14243 * Look for a helper provider with the right generation. We
14244 * have to start back at the beginning of the list each time
14245 * because we drop dtrace_lock. It's unlikely that we'll make
14246 * more than two passes.
14248 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
14249 prov
= help
->dthps_provs
[i
];
14251 if (prov
->dthp_generation
== gen
)
14256 * If there were no matches, we're done.
14258 if (i
== help
->dthps_nprovs
)
14262 * Move the last helper provider into this slot.
14264 help
->dthps_nprovs
--;
14265 help
->dthps_provs
[i
] = help
->dthps_provs
[help
->dthps_nprovs
];
14266 help
->dthps_provs
[help
->dthps_nprovs
] = NULL
;
14268 lck_mtx_unlock(&dtrace_lock
);
14271 * If we have a meta provider, remove this helper provider.
14273 lck_mtx_lock(&dtrace_meta_lock
);
14274 if (dtrace_meta_pid
!= NULL
) {
14275 ASSERT(dtrace_deferred_pid
== NULL
);
14276 dtrace_helper_provider_remove(&prov
->dthp_prov
,
14279 lck_mtx_unlock(&dtrace_meta_lock
);
14281 dtrace_helper_provider_destroy(prov
);
14283 lck_mtx_lock(&dtrace_lock
);
14290 dtrace_helper_validate(dtrace_helper_action_t
*helper
)
14295 if ((dp
= helper
->dtha_predicate
) != NULL
)
14296 err
+= dtrace_difo_validate_helper(dp
);
14298 for (i
= 0; i
< helper
->dtha_nactions
; i
++)
14299 err
+= dtrace_difo_validate_helper(helper
->dtha_actions
[i
]);
14305 dtrace_helper_action_add(proc_t
* p
, int which
, dtrace_ecbdesc_t
*ep
)
14307 dtrace_helpers_t
*help
;
14308 dtrace_helper_action_t
*helper
, *last
;
14309 dtrace_actdesc_t
*act
;
14310 dtrace_vstate_t
*vstate
;
14311 dtrace_predicate_t
*pred
;
14312 int count
= 0, nactions
= 0, i
;
14314 if (which
< 0 || which
>= DTRACE_NHELPER_ACTIONS
)
14317 help
= p
->p_dtrace_helpers
;
14318 last
= help
->dthps_actions
[which
];
14319 vstate
= &help
->dthps_vstate
;
14321 for (count
= 0; last
!= NULL
; last
= last
->dtha_next
) {
14323 if (last
->dtha_next
== NULL
)
14328 * If we already have dtrace_helper_actions_max helper actions for this
14329 * helper action type, we'll refuse to add a new one.
14331 if (count
>= dtrace_helper_actions_max
)
14334 helper
= kmem_zalloc(sizeof (dtrace_helper_action_t
), KM_SLEEP
);
14335 helper
->dtha_generation
= help
->dthps_generation
;
14337 if ((pred
= ep
->dted_pred
.dtpdd_predicate
) != NULL
) {
14338 ASSERT(pred
->dtp_difo
!= NULL
);
14339 dtrace_difo_hold(pred
->dtp_difo
);
14340 helper
->dtha_predicate
= pred
->dtp_difo
;
14343 for (act
= ep
->dted_action
; act
!= NULL
; act
= act
->dtad_next
) {
14344 if (act
->dtad_kind
!= DTRACEACT_DIFEXPR
)
14347 if (act
->dtad_difo
== NULL
)
14353 helper
->dtha_actions
= kmem_zalloc(sizeof (dtrace_difo_t
*) *
14354 (helper
->dtha_nactions
= nactions
), KM_SLEEP
);
14356 for (act
= ep
->dted_action
, i
= 0; act
!= NULL
; act
= act
->dtad_next
) {
14357 dtrace_difo_hold(act
->dtad_difo
);
14358 helper
->dtha_actions
[i
++] = act
->dtad_difo
;
14361 if (!dtrace_helper_validate(helper
))
14364 if (last
== NULL
) {
14365 help
->dthps_actions
[which
] = helper
;
14367 last
->dtha_next
= helper
;
14370 if ((uint32_t)vstate
->dtvs_nlocals
> dtrace_helptrace_nlocals
) {
14371 dtrace_helptrace_nlocals
= vstate
->dtvs_nlocals
;
14372 dtrace_helptrace_next
= 0;
14377 dtrace_helper_action_destroy(helper
, vstate
);
14382 dtrace_helper_provider_register(proc_t
*p
, dtrace_helpers_t
*help
,
14383 dof_helper_t
*dofhp
)
14385 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_NOTOWNED
);
14387 lck_mtx_lock(&dtrace_meta_lock
);
14388 lck_mtx_lock(&dtrace_lock
);
14390 if (!dtrace_attached() || dtrace_meta_pid
== NULL
) {
14392 * If the dtrace module is loaded but not attached, or if
14393 * there aren't isn't a meta provider registered to deal with
14394 * these provider descriptions, we need to postpone creating
14395 * the actual providers until later.
14398 if (help
->dthps_next
== NULL
&& help
->dthps_prev
== NULL
&&
14399 dtrace_deferred_pid
!= help
) {
14400 help
->dthps_deferred
= 1;
14401 help
->dthps_pid
= p
->p_pid
;
14402 help
->dthps_next
= dtrace_deferred_pid
;
14403 help
->dthps_prev
= NULL
;
14404 if (dtrace_deferred_pid
!= NULL
)
14405 dtrace_deferred_pid
->dthps_prev
= help
;
14406 dtrace_deferred_pid
= help
;
14409 lck_mtx_unlock(&dtrace_lock
);
14411 } else if (dofhp
!= NULL
) {
14413 * If the dtrace module is loaded and we have a particular
14414 * helper provider description, pass that off to the
14418 lck_mtx_unlock(&dtrace_lock
);
14420 dtrace_helper_provide(dofhp
, p
->p_pid
);
14424 * Otherwise, just pass all the helper provider descriptions
14425 * off to the meta provider.
14429 lck_mtx_unlock(&dtrace_lock
);
14431 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
14432 dtrace_helper_provide(&help
->dthps_provs
[i
]->dthp_prov
,
14437 lck_mtx_unlock(&dtrace_meta_lock
);
14441 dtrace_helper_provider_add(proc_t
* p
, dof_helper_t
*dofhp
, int gen
)
14443 dtrace_helpers_t
*help
;
14444 dtrace_helper_provider_t
*hprov
, **tmp_provs
;
14445 uint_t tmp_maxprovs
, i
;
14447 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
14448 help
= p
->p_dtrace_helpers
;
14449 ASSERT(help
!= NULL
);
14452 * If we already have dtrace_helper_providers_max helper providers,
14453 * we're refuse to add a new one.
14455 if (help
->dthps_nprovs
>= dtrace_helper_providers_max
)
14459 * Check to make sure this isn't a duplicate.
14461 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
14462 if (dofhp
->dofhp_addr
==
14463 help
->dthps_provs
[i
]->dthp_prov
.dofhp_addr
)
14467 hprov
= kmem_zalloc(sizeof (dtrace_helper_provider_t
), KM_SLEEP
);
14468 hprov
->dthp_prov
= *dofhp
;
14469 hprov
->dthp_ref
= 1;
14470 hprov
->dthp_generation
= gen
;
14473 * Allocate a bigger table for helper providers if it's already full.
14475 if (help
->dthps_maxprovs
== help
->dthps_nprovs
) {
14476 tmp_maxprovs
= help
->dthps_maxprovs
;
14477 tmp_provs
= help
->dthps_provs
;
14479 if (help
->dthps_maxprovs
== 0)
14480 help
->dthps_maxprovs
= 2;
14482 help
->dthps_maxprovs
*= 2;
14483 if (help
->dthps_maxprovs
> dtrace_helper_providers_max
)
14484 help
->dthps_maxprovs
= dtrace_helper_providers_max
;
14486 ASSERT(tmp_maxprovs
< help
->dthps_maxprovs
);
14488 help
->dthps_provs
= kmem_zalloc(help
->dthps_maxprovs
*
14489 sizeof (dtrace_helper_provider_t
*), KM_SLEEP
);
14491 if (tmp_provs
!= NULL
) {
14492 bcopy(tmp_provs
, help
->dthps_provs
, tmp_maxprovs
*
14493 sizeof (dtrace_helper_provider_t
*));
14494 kmem_free(tmp_provs
, tmp_maxprovs
*
14495 sizeof (dtrace_helper_provider_t
*));
14499 help
->dthps_provs
[help
->dthps_nprovs
] = hprov
;
14500 help
->dthps_nprovs
++;
14506 dtrace_helper_provider_destroy(dtrace_helper_provider_t
*hprov
)
14508 lck_mtx_lock(&dtrace_lock
);
14510 if (--hprov
->dthp_ref
== 0) {
14512 lck_mtx_unlock(&dtrace_lock
);
14513 dof
= (dof_hdr_t
*)(uintptr_t)hprov
->dthp_prov
.dofhp_dof
;
14514 dtrace_dof_destroy(dof
);
14515 kmem_free(hprov
, sizeof (dtrace_helper_provider_t
));
14517 lck_mtx_unlock(&dtrace_lock
);
14522 dtrace_helper_provider_validate(dof_hdr_t
*dof
, dof_sec_t
*sec
)
14524 uintptr_t daddr
= (uintptr_t)dof
;
14525 dof_sec_t
*str_sec
, *prb_sec
, *arg_sec
, *off_sec
, *enoff_sec
;
14526 dof_provider_t
*provider
;
14527 dof_probe_t
*probe
;
14529 char *strtab
, *typestr
;
14530 dof_stridx_t typeidx
;
14532 uint_t nprobes
, j
, k
;
14534 ASSERT(sec
->dofs_type
== DOF_SECT_PROVIDER
);
14536 if (sec
->dofs_offset
& (sizeof (uint_t
) - 1)) {
14537 dtrace_dof_error(dof
, "misaligned section offset");
14542 * The section needs to be large enough to contain the DOF provider
14543 * structure appropriate for the given version.
14545 if (sec
->dofs_size
<
14546 ((dof
->dofh_ident
[DOF_ID_VERSION
] == DOF_VERSION_1
) ?
14547 offsetof(dof_provider_t
, dofpv_prenoffs
) :
14548 sizeof (dof_provider_t
))) {
14549 dtrace_dof_error(dof
, "provider section too small");
14553 provider
= (dof_provider_t
*)(uintptr_t)(daddr
+ sec
->dofs_offset
);
14554 str_sec
= dtrace_dof_sect(dof
, DOF_SECT_STRTAB
, provider
->dofpv_strtab
);
14555 prb_sec
= dtrace_dof_sect(dof
, DOF_SECT_PROBES
, provider
->dofpv_probes
);
14556 arg_sec
= dtrace_dof_sect(dof
, DOF_SECT_PRARGS
, provider
->dofpv_prargs
);
14557 off_sec
= dtrace_dof_sect(dof
, DOF_SECT_PROFFS
, provider
->dofpv_proffs
);
14559 if (str_sec
== NULL
|| prb_sec
== NULL
||
14560 arg_sec
== NULL
|| off_sec
== NULL
)
14565 if (dof
->dofh_ident
[DOF_ID_VERSION
] != DOF_VERSION_1
&&
14566 provider
->dofpv_prenoffs
!= DOF_SECT_NONE
&&
14567 (enoff_sec
= dtrace_dof_sect(dof
, DOF_SECT_PRENOFFS
,
14568 provider
->dofpv_prenoffs
)) == NULL
)
14571 strtab
= (char *)(uintptr_t)(daddr
+ str_sec
->dofs_offset
);
14573 if (provider
->dofpv_name
>= str_sec
->dofs_size
||
14574 strlen(strtab
+ provider
->dofpv_name
) >= DTRACE_PROVNAMELEN
) {
14575 dtrace_dof_error(dof
, "invalid provider name");
14579 if (prb_sec
->dofs_entsize
== 0 ||
14580 prb_sec
->dofs_entsize
> prb_sec
->dofs_size
) {
14581 dtrace_dof_error(dof
, "invalid entry size");
14585 if (prb_sec
->dofs_entsize
& (sizeof (uintptr_t) - 1)) {
14586 dtrace_dof_error(dof
, "misaligned entry size");
14590 if (off_sec
->dofs_entsize
!= sizeof (uint32_t)) {
14591 dtrace_dof_error(dof
, "invalid entry size");
14595 if (off_sec
->dofs_offset
& (sizeof (uint32_t) - 1)) {
14596 dtrace_dof_error(dof
, "misaligned section offset");
14600 if (arg_sec
->dofs_entsize
!= sizeof (uint8_t)) {
14601 dtrace_dof_error(dof
, "invalid entry size");
14605 arg
= (uint8_t *)(uintptr_t)(daddr
+ arg_sec
->dofs_offset
);
14607 nprobes
= prb_sec
->dofs_size
/ prb_sec
->dofs_entsize
;
14610 * Take a pass through the probes to check for errors.
14612 for (j
= 0; j
< nprobes
; j
++) {
14613 probe
= (dof_probe_t
*)(uintptr_t)(daddr
+
14614 prb_sec
->dofs_offset
+ j
* prb_sec
->dofs_entsize
);
14616 if (probe
->dofpr_func
>= str_sec
->dofs_size
) {
14617 dtrace_dof_error(dof
, "invalid function name");
14621 if (strlen(strtab
+ probe
->dofpr_func
) >= DTRACE_FUNCNAMELEN
) {
14622 dtrace_dof_error(dof
, "function name too long");
14626 if (probe
->dofpr_name
>= str_sec
->dofs_size
||
14627 strlen(strtab
+ probe
->dofpr_name
) >= DTRACE_NAMELEN
) {
14628 dtrace_dof_error(dof
, "invalid probe name");
14633 * The offset count must not wrap the index, and the offsets
14634 * must also not overflow the section's data.
14636 if (probe
->dofpr_offidx
+ probe
->dofpr_noffs
<
14637 probe
->dofpr_offidx
||
14638 (probe
->dofpr_offidx
+ probe
->dofpr_noffs
) *
14639 off_sec
->dofs_entsize
> off_sec
->dofs_size
) {
14640 dtrace_dof_error(dof
, "invalid probe offset");
14644 if (dof
->dofh_ident
[DOF_ID_VERSION
] != DOF_VERSION_1
) {
14646 * If there's no is-enabled offset section, make sure
14647 * there aren't any is-enabled offsets. Otherwise
14648 * perform the same checks as for probe offsets
14649 * (immediately above).
14651 if (enoff_sec
== NULL
) {
14652 if (probe
->dofpr_enoffidx
!= 0 ||
14653 probe
->dofpr_nenoffs
!= 0) {
14654 dtrace_dof_error(dof
, "is-enabled "
14655 "offsets with null section");
14658 } else if (probe
->dofpr_enoffidx
+
14659 probe
->dofpr_nenoffs
< probe
->dofpr_enoffidx
||
14660 (probe
->dofpr_enoffidx
+ probe
->dofpr_nenoffs
) *
14661 enoff_sec
->dofs_entsize
> enoff_sec
->dofs_size
) {
14662 dtrace_dof_error(dof
, "invalid is-enabled "
14667 if (probe
->dofpr_noffs
+ probe
->dofpr_nenoffs
== 0) {
14668 dtrace_dof_error(dof
, "zero probe and "
14669 "is-enabled offsets");
14672 } else if (probe
->dofpr_noffs
== 0) {
14673 dtrace_dof_error(dof
, "zero probe offsets");
14677 if (probe
->dofpr_argidx
+ probe
->dofpr_xargc
<
14678 probe
->dofpr_argidx
||
14679 (probe
->dofpr_argidx
+ probe
->dofpr_xargc
) *
14680 arg_sec
->dofs_entsize
> arg_sec
->dofs_size
) {
14681 dtrace_dof_error(dof
, "invalid args");
14685 typeidx
= probe
->dofpr_nargv
;
14686 typestr
= strtab
+ probe
->dofpr_nargv
;
14687 for (k
= 0; k
< probe
->dofpr_nargc
; k
++) {
14688 if (typeidx
>= str_sec
->dofs_size
) {
14689 dtrace_dof_error(dof
, "bad "
14690 "native argument type");
14694 typesz
= strlen(typestr
) + 1;
14695 if (typesz
> DTRACE_ARGTYPELEN
) {
14696 dtrace_dof_error(dof
, "native "
14697 "argument type too long");
14704 typeidx
= probe
->dofpr_xargv
;
14705 typestr
= strtab
+ probe
->dofpr_xargv
;
14706 for (k
= 0; k
< probe
->dofpr_xargc
; k
++) {
14707 if (arg
[probe
->dofpr_argidx
+ k
] > probe
->dofpr_nargc
) {
14708 dtrace_dof_error(dof
, "bad "
14709 "native argument index");
14713 if (typeidx
>= str_sec
->dofs_size
) {
14714 dtrace_dof_error(dof
, "bad "
14715 "translated argument type");
14719 typesz
= strlen(typestr
) + 1;
14720 if (typesz
> DTRACE_ARGTYPELEN
) {
14721 dtrace_dof_error(dof
, "translated argument "
14735 dtrace_helper_slurp(proc_t
* p
, dof_hdr_t
*dof
, dof_helper_t
*dhp
)
14737 dtrace_helpers_t
*help
;
14738 dtrace_vstate_t
*vstate
;
14739 dtrace_enabling_t
*enab
= NULL
;
14740 int i
, gen
, rv
, nhelpers
= 0, nprovs
= 0, destroy
= 1;
14741 uintptr_t daddr
= (uintptr_t)dof
;
14743 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
14745 if ((help
= p
->p_dtrace_helpers
) == NULL
)
14746 help
= dtrace_helpers_create(p
);
14748 vstate
= &help
->dthps_vstate
;
14750 if ((rv
= dtrace_dof_slurp(dof
, vstate
, NULL
, &enab
,
14751 dhp
!= NULL
? dhp
->dofhp_addr
: 0, B_FALSE
)) != 0) {
14752 dtrace_dof_destroy(dof
);
14757 * Look for helper providers and validate their descriptions.
14760 for (i
= 0; (uint32_t)i
< dof
->dofh_secnum
; i
++) {
14761 dof_sec_t
*sec
= (dof_sec_t
*)(uintptr_t)(daddr
+
14762 dof
->dofh_secoff
+ i
* dof
->dofh_secsize
);
14764 if (sec
->dofs_type
!= DOF_SECT_PROVIDER
)
14767 if (dtrace_helper_provider_validate(dof
, sec
) != 0) {
14768 dtrace_enabling_destroy(enab
);
14769 dtrace_dof_destroy(dof
);
14778 * Now we need to walk through the ECB descriptions in the enabling.
14780 for (i
= 0; i
< enab
->dten_ndesc
; i
++) {
14781 dtrace_ecbdesc_t
*ep
= enab
->dten_desc
[i
];
14782 dtrace_probedesc_t
*desc
= &ep
->dted_probe
;
14784 /* APPLE NOTE: Darwin employs size bounded string operation. */
14785 if (!LIT_STRNEQL(desc
->dtpd_provider
, "dtrace"))
14788 if (!LIT_STRNEQL(desc
->dtpd_mod
, "helper"))
14791 if (!LIT_STRNEQL(desc
->dtpd_func
, "ustack"))
14794 if ((rv
= dtrace_helper_action_add(p
, DTRACE_HELPER_ACTION_USTACK
,
14797 * Adding this helper action failed -- we are now going
14798 * to rip out the entire generation and return failure.
14800 (void) dtrace_helper_destroygen(p
, help
->dthps_generation
);
14801 dtrace_enabling_destroy(enab
);
14802 dtrace_dof_destroy(dof
);
14809 if (nhelpers
< enab
->dten_ndesc
)
14810 dtrace_dof_error(dof
, "unmatched helpers");
14812 gen
= help
->dthps_generation
++;
14813 dtrace_enabling_destroy(enab
);
14815 if (dhp
!= NULL
&& nprovs
> 0) {
14816 dhp
->dofhp_dof
= (uint64_t)(uintptr_t)dof
;
14817 if (dtrace_helper_provider_add(p
, dhp
, gen
) == 0) {
14818 lck_mtx_unlock(&dtrace_lock
);
14819 dtrace_helper_provider_register(p
, help
, dhp
);
14820 lck_mtx_lock(&dtrace_lock
);
14827 dtrace_dof_destroy(dof
);
14833 * APPLE NOTE: DTrace lazy dof implementation
14835 * DTrace user static probes (USDT probes) and helper actions are loaded
14836 * in a process by proccessing dof sections. The dof sections are passed
14837 * into the kernel by dyld, in a dof_ioctl_data_t block. It is rather
14838 * expensive to process dof for a process that will never use it. There
14839 * is a memory cost (allocating the providers/probes), and a cpu cost
14840 * (creating the providers/probes).
14842 * To reduce this cost, we use "lazy dof". The normal proceedure for
14843 * dof processing is to copyin the dof(s) pointed to by the dof_ioctl_data_t
14844 * block, and invoke dof_slurp_helper() on them. When "lazy dof" is
14845 * used, each process retains the dof_ioctl_data_t block, instead of
14846 * copying in the data it points to.
14848 * The dof_ioctl_data_t blocks are managed as if they were the actual
14849 * processed dof; on fork the block is copied to the child, on exec and
14850 * exit the block is freed.
14852 * If the process loads library(s) containing additional dof, the
14853 * new dof_ioctl_data_t is merged with the existing block.
14855 * There are a few catches that make this slightly more difficult.
14856 * When dyld registers dof_ioctl_data_t blocks, it expects a unique
14857 * identifier value for each dof in the block. In non-lazy dof terms,
14858 * this is the generation that dof was loaded in. If we hand back
14859 * a UID for a lazy dof, that same UID must be able to unload the
14860 * dof once it has become non-lazy. To meet this requirement, the
14861 * code that loads lazy dof requires that the UID's for dof(s) in
14862 * the lazy dof be sorted, and in ascending order. It is okay to skip
14863 * UID's, I.E., 1 -> 5 -> 6 is legal.
14865 * Once a process has become non-lazy, it will stay non-lazy. All
14866 * future dof operations for that process will be non-lazy, even
14867 * if the dof mode transitions back to lazy.
14869 * Always do lazy dof checks before non-lazy (I.E. In fork, exit, exec.).
14870 * That way if the lazy check fails due to transitioning to non-lazy, the
14871 * right thing is done with the newly faulted in dof.
14875 * This method is a bit squicky. It must handle:
14877 * dof should not be lazy.
14878 * dof should have been handled lazily, but there was an error
14879 * dof was handled lazily, and needs to be freed.
14880 * dof was handled lazily, and must not be freed.
14883 * Returns EACCESS if dof should be handled non-lazily.
14885 * KERN_SUCCESS and all other return codes indicate lazy handling of dof.
14887 * If the dofs data is claimed by this method, dofs_claimed will be set.
14888 * Callers should not free claimed dofs.
14891 dtrace_lazy_dofs_add(proc_t
*p
, dof_ioctl_data_t
* incoming_dofs
, int *dofs_claimed
)
14894 ASSERT(incoming_dofs
&& incoming_dofs
->dofiod_count
> 0);
14899 lck_rw_lock_shared(&dtrace_dof_mode_lock
);
14901 ASSERT(p
->p_dtrace_lazy_dofs
== NULL
|| p
->p_dtrace_helpers
== NULL
);
14902 ASSERT(dtrace_dof_mode
!= DTRACE_DOF_MODE_NEVER
);
14905 * Any existing helpers force non-lazy behavior.
14907 if (dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_ON
&& (p
->p_dtrace_helpers
== NULL
)) {
14908 lck_mtx_lock(&p
->p_dtrace_sprlock
);
14910 dof_ioctl_data_t
* existing_dofs
= p
->p_dtrace_lazy_dofs
;
14911 unsigned int existing_dofs_count
= (existing_dofs
) ? existing_dofs
->dofiod_count
: 0;
14912 unsigned int i
, merged_dofs_count
= incoming_dofs
->dofiod_count
+ existing_dofs_count
;
14917 if (merged_dofs_count
== 0 || merged_dofs_count
> 1024) {
14918 dtrace_dof_error(NULL
, "lazy_dofs_add merged_dofs_count out of range");
14924 * Each dof being added must be assigned a unique generation.
14926 uint64_t generation
= (existing_dofs
) ? existing_dofs
->dofiod_helpers
[existing_dofs_count
- 1].dofhp_dof
+ 1 : 1;
14927 for (i
=0; i
<incoming_dofs
->dofiod_count
; i
++) {
14929 * We rely on these being the same so we can overwrite dofhp_dof and not lose info.
14931 ASSERT(incoming_dofs
->dofiod_helpers
[i
].dofhp_dof
== incoming_dofs
->dofiod_helpers
[i
].dofhp_addr
);
14932 incoming_dofs
->dofiod_helpers
[i
].dofhp_dof
= generation
++;
14936 if (existing_dofs
) {
14938 * Merge the existing and incoming dofs
14940 size_t merged_dofs_size
= DOF_IOCTL_DATA_T_SIZE(merged_dofs_count
);
14941 dof_ioctl_data_t
* merged_dofs
= kmem_alloc(merged_dofs_size
, KM_SLEEP
);
14943 bcopy(&existing_dofs
->dofiod_helpers
[0],
14944 &merged_dofs
->dofiod_helpers
[0],
14945 sizeof(dof_helper_t
) * existing_dofs_count
);
14946 bcopy(&incoming_dofs
->dofiod_helpers
[0],
14947 &merged_dofs
->dofiod_helpers
[existing_dofs_count
],
14948 sizeof(dof_helper_t
) * incoming_dofs
->dofiod_count
);
14950 merged_dofs
->dofiod_count
= merged_dofs_count
;
14952 kmem_free(existing_dofs
, DOF_IOCTL_DATA_T_SIZE(existing_dofs_count
));
14954 p
->p_dtrace_lazy_dofs
= merged_dofs
;
14957 * Claim the incoming dofs
14960 p
->p_dtrace_lazy_dofs
= incoming_dofs
;
14964 dof_ioctl_data_t
* all_dofs
= p
->p_dtrace_lazy_dofs
;
14965 for (i
=0; i
<all_dofs
->dofiod_count
-1; i
++) {
14966 ASSERT(all_dofs
->dofiod_helpers
[i
].dofhp_dof
< all_dofs
->dofiod_helpers
[i
+1].dofhp_dof
);
14971 lck_mtx_unlock(&p
->p_dtrace_sprlock
);
14976 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
14984 * EINVAL: lazy dof is enabled, but the requested generation was not found.
14985 * EACCES: This removal needs to be handled non-lazily.
14988 dtrace_lazy_dofs_remove(proc_t
*p
, int generation
)
14992 lck_rw_lock_shared(&dtrace_dof_mode_lock
);
14994 ASSERT(p
->p_dtrace_lazy_dofs
== NULL
|| p
->p_dtrace_helpers
== NULL
);
14995 ASSERT(dtrace_dof_mode
!= DTRACE_DOF_MODE_NEVER
);
14998 * Any existing helpers force non-lazy behavior.
15000 if (dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_ON
&& (p
->p_dtrace_helpers
== NULL
)) {
15001 lck_mtx_lock(&p
->p_dtrace_sprlock
);
15003 dof_ioctl_data_t
* existing_dofs
= p
->p_dtrace_lazy_dofs
;
15005 if (existing_dofs
) {
15006 int index
, existing_dofs_count
= existing_dofs
->dofiod_count
;
15007 for (index
=0; index
<existing_dofs_count
; index
++) {
15008 if ((int)existing_dofs
->dofiod_helpers
[index
].dofhp_dof
== generation
) {
15009 dof_ioctl_data_t
* removed_dofs
= NULL
;
15012 * If there is only 1 dof, we'll delete it and swap in NULL.
15014 if (existing_dofs_count
> 1) {
15015 int removed_dofs_count
= existing_dofs_count
- 1;
15016 size_t removed_dofs_size
= DOF_IOCTL_DATA_T_SIZE(removed_dofs_count
);
15018 removed_dofs
= kmem_alloc(removed_dofs_size
, KM_SLEEP
);
15019 removed_dofs
->dofiod_count
= removed_dofs_count
;
15022 * copy the remaining data.
15025 bcopy(&existing_dofs
->dofiod_helpers
[0],
15026 &removed_dofs
->dofiod_helpers
[0],
15027 index
* sizeof(dof_helper_t
));
15030 if (index
< existing_dofs_count
-1) {
15031 bcopy(&existing_dofs
->dofiod_helpers
[index
+1],
15032 &removed_dofs
->dofiod_helpers
[index
],
15033 (existing_dofs_count
- index
- 1) * sizeof(dof_helper_t
));
15037 kmem_free(existing_dofs
, DOF_IOCTL_DATA_T_SIZE(existing_dofs_count
));
15039 p
->p_dtrace_lazy_dofs
= removed_dofs
;
15041 rval
= KERN_SUCCESS
;
15048 dof_ioctl_data_t
* all_dofs
= p
->p_dtrace_lazy_dofs
;
15051 for (i
=0; i
<all_dofs
->dofiod_count
-1; i
++) {
15052 ASSERT(all_dofs
->dofiod_helpers
[i
].dofhp_dof
< all_dofs
->dofiod_helpers
[i
+1].dofhp_dof
);
15059 lck_mtx_unlock(&p
->p_dtrace_sprlock
);
15064 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
15070 dtrace_lazy_dofs_destroy(proc_t
*p
)
15072 lck_rw_lock_shared(&dtrace_dof_mode_lock
);
15073 lck_mtx_lock(&p
->p_dtrace_sprlock
);
15075 ASSERT(p
->p_dtrace_lazy_dofs
== NULL
|| p
->p_dtrace_helpers
== NULL
);
15077 dof_ioctl_data_t
* lazy_dofs
= p
->p_dtrace_lazy_dofs
;
15078 p
->p_dtrace_lazy_dofs
= NULL
;
15080 lck_mtx_unlock(&p
->p_dtrace_sprlock
);
15081 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
15084 kmem_free(lazy_dofs
, DOF_IOCTL_DATA_T_SIZE(lazy_dofs
->dofiod_count
));
15089 dtrace_lazy_dofs_proc_iterate_filter(proc_t
*p
, void* ignored
)
15091 #pragma unused(ignored)
15093 * Okay to NULL test without taking the sprlock.
15095 return p
->p_dtrace_lazy_dofs
!= NULL
;
15099 dtrace_lazy_dofs_process(proc_t
*p
) {
15101 * It is possible this process may exit during our attempt to
15102 * fault in the dof. We could fix this by holding locks longer,
15103 * but the errors are benign.
15105 lck_mtx_lock(&p
->p_dtrace_sprlock
);
15108 ASSERT(p
->p_dtrace_lazy_dofs
== NULL
|| p
->p_dtrace_helpers
== NULL
);
15109 ASSERT(dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_OFF
);
15111 dof_ioctl_data_t
* lazy_dofs
= p
->p_dtrace_lazy_dofs
;
15112 p
->p_dtrace_lazy_dofs
= NULL
;
15114 lck_mtx_unlock(&p
->p_dtrace_sprlock
);
15117 * Process each dof_helper_t
15119 if (lazy_dofs
!= NULL
) {
15123 for (i
=0; i
<lazy_dofs
->dofiod_count
; i
++) {
15125 * When loading lazy dof, we depend on the generations being sorted in ascending order.
15127 ASSERT(i
>= (lazy_dofs
->dofiod_count
- 1) || lazy_dofs
->dofiod_helpers
[i
].dofhp_dof
< lazy_dofs
->dofiod_helpers
[i
+1].dofhp_dof
);
15129 dof_helper_t
*dhp
= &lazy_dofs
->dofiod_helpers
[i
];
15132 * We stored the generation in dofhp_dof. Save it, and restore the original value.
15134 int generation
= dhp
->dofhp_dof
;
15135 dhp
->dofhp_dof
= dhp
->dofhp_addr
;
15137 dof_hdr_t
*dof
= dtrace_dof_copyin_from_proc(p
, dhp
->dofhp_dof
, &rval
);
15140 dtrace_helpers_t
*help
;
15142 lck_mtx_lock(&dtrace_lock
);
15145 * This must be done with the dtrace_lock held
15147 if ((help
= p
->p_dtrace_helpers
) == NULL
)
15148 help
= dtrace_helpers_create(p
);
15151 * If the generation value has been bumped, someone snuck in
15152 * when we released the dtrace lock. We have to dump this generation,
15153 * there is no safe way to load it.
15155 if (help
->dthps_generation
<= generation
) {
15156 help
->dthps_generation
= generation
;
15159 * dtrace_helper_slurp() takes responsibility for the dof --
15160 * it may free it now or it may save it and free it later.
15162 if ((rval
= dtrace_helper_slurp(p
, dof
, dhp
)) != generation
) {
15163 dtrace_dof_error(NULL
, "returned value did not match expected generation");
15167 lck_mtx_unlock(&dtrace_lock
);
15171 kmem_free(lazy_dofs
, DOF_IOCTL_DATA_T_SIZE(lazy_dofs
->dofiod_count
));
15176 dtrace_lazy_dofs_proc_iterate_doit(proc_t
*p
, void* ignored
)
15178 #pragma unused(ignored)
15180 dtrace_lazy_dofs_process(p
);
15182 return PROC_RETURNED
;
15185 #define DTRACE_LAZY_DOFS_DUPLICATED 1
15188 dtrace_lazy_dofs_duplicate(proc_t
*parent
, proc_t
*child
)
15190 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_NOTOWNED
);
15191 lck_mtx_assert(&parent
->p_dtrace_sprlock
, LCK_MTX_ASSERT_NOTOWNED
);
15192 lck_mtx_assert(&child
->p_dtrace_sprlock
, LCK_MTX_ASSERT_NOTOWNED
);
15194 lck_rw_lock_shared(&dtrace_dof_mode_lock
);
15195 lck_mtx_lock(&parent
->p_dtrace_sprlock
);
15198 * We need to make sure that the transition to lazy dofs -> helpers
15199 * was atomic for our parent
15201 ASSERT(parent
->p_dtrace_lazy_dofs
== NULL
|| parent
->p_dtrace_helpers
== NULL
);
15203 * In theory we should hold the child sprlock, but this is safe...
15205 ASSERT(child
->p_dtrace_lazy_dofs
== NULL
&& child
->p_dtrace_helpers
== NULL
);
15207 dof_ioctl_data_t
* parent_dofs
= parent
->p_dtrace_lazy_dofs
;
15208 dof_ioctl_data_t
* child_dofs
= NULL
;
15210 size_t parent_dofs_size
= DOF_IOCTL_DATA_T_SIZE(parent_dofs
->dofiod_count
);
15211 child_dofs
= kmem_alloc(parent_dofs_size
, KM_SLEEP
);
15212 bcopy(parent_dofs
, child_dofs
, parent_dofs_size
);
15215 lck_mtx_unlock(&parent
->p_dtrace_sprlock
);
15218 lck_mtx_lock(&child
->p_dtrace_sprlock
);
15219 child
->p_dtrace_lazy_dofs
= child_dofs
;
15220 lck_mtx_unlock(&child
->p_dtrace_sprlock
);
15222 * We process the DOF at this point if the mode is set to
15223 * LAZY_OFF. This can happen if DTrace is still processing the
15224 * DOF of other process (which can happen because the
15225 * protected pager can have a huge latency)
15226 * but has not processed our parent yet
15228 if (dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_OFF
) {
15229 dtrace_lazy_dofs_process(child
);
15231 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
15233 return DTRACE_LAZY_DOFS_DUPLICATED
;
15235 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
15240 static dtrace_helpers_t
*
15241 dtrace_helpers_create(proc_t
*p
)
15243 dtrace_helpers_t
*help
;
15245 lck_mtx_assert(&dtrace_lock
, LCK_MTX_ASSERT_OWNED
);
15246 ASSERT(p
->p_dtrace_helpers
== NULL
);
15248 help
= kmem_zalloc(sizeof (dtrace_helpers_t
), KM_SLEEP
);
15249 help
->dthps_actions
= kmem_zalloc(sizeof (dtrace_helper_action_t
*) *
15250 DTRACE_NHELPER_ACTIONS
, KM_SLEEP
);
15252 p
->p_dtrace_helpers
= help
;
15259 dtrace_helpers_destroy(proc_t
* p
)
15261 dtrace_helpers_t
*help
;
15262 dtrace_vstate_t
*vstate
;
15265 lck_mtx_lock(&dtrace_lock
);
15267 ASSERT(p
->p_dtrace_helpers
!= NULL
);
15268 ASSERT(dtrace_helpers
> 0);
15270 help
= p
->p_dtrace_helpers
;
15271 vstate
= &help
->dthps_vstate
;
15274 * We're now going to lose the help from this process.
15276 p
->p_dtrace_helpers
= NULL
;
15280 * Destory the helper actions.
15282 for (i
= 0; i
< DTRACE_NHELPER_ACTIONS
; i
++) {
15283 dtrace_helper_action_t
*h
, *next
;
15285 for (h
= help
->dthps_actions
[i
]; h
!= NULL
; h
= next
) {
15286 next
= h
->dtha_next
;
15287 dtrace_helper_action_destroy(h
, vstate
);
15292 lck_mtx_unlock(&dtrace_lock
);
15295 * Destroy the helper providers.
15297 if (help
->dthps_maxprovs
> 0) {
15298 lck_mtx_lock(&dtrace_meta_lock
);
15299 if (dtrace_meta_pid
!= NULL
) {
15300 ASSERT(dtrace_deferred_pid
== NULL
);
15302 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
15303 dtrace_helper_provider_remove(
15304 &help
->dthps_provs
[i
]->dthp_prov
, p
->p_pid
);
15307 lck_mtx_lock(&dtrace_lock
);
15308 ASSERT(help
->dthps_deferred
== 0 ||
15309 help
->dthps_next
!= NULL
||
15310 help
->dthps_prev
!= NULL
||
15311 help
== dtrace_deferred_pid
);
15314 * Remove the helper from the deferred list.
15316 if (help
->dthps_next
!= NULL
)
15317 help
->dthps_next
->dthps_prev
= help
->dthps_prev
;
15318 if (help
->dthps_prev
!= NULL
)
15319 help
->dthps_prev
->dthps_next
= help
->dthps_next
;
15320 if (dtrace_deferred_pid
== help
) {
15321 dtrace_deferred_pid
= help
->dthps_next
;
15322 ASSERT(help
->dthps_prev
== NULL
);
15325 lck_mtx_unlock(&dtrace_lock
);
15328 lck_mtx_unlock(&dtrace_meta_lock
);
15330 for (i
= 0; i
< help
->dthps_nprovs
; i
++) {
15331 dtrace_helper_provider_destroy(help
->dthps_provs
[i
]);
15334 kmem_free(help
->dthps_provs
, help
->dthps_maxprovs
*
15335 sizeof (dtrace_helper_provider_t
*));
15338 lck_mtx_lock(&dtrace_lock
);
15340 dtrace_vstate_fini(&help
->dthps_vstate
);
15341 kmem_free(help
->dthps_actions
,
15342 sizeof (dtrace_helper_action_t
*) * DTRACE_NHELPER_ACTIONS
);
15343 kmem_free(help
, sizeof (dtrace_helpers_t
));
15346 lck_mtx_unlock(&dtrace_lock
);
15350 dtrace_helpers_duplicate(proc_t
*from
, proc_t
*to
)
15352 dtrace_helpers_t
*help
, *newhelp
;
15353 dtrace_helper_action_t
*helper
, *new, *last
;
15355 dtrace_vstate_t
*vstate
;
15357 int j
, sz
, hasprovs
= 0;
15359 lck_mtx_lock(&dtrace_lock
);
15360 ASSERT(from
->p_dtrace_helpers
!= NULL
);
15361 ASSERT(dtrace_helpers
> 0);
15363 help
= from
->p_dtrace_helpers
;
15364 newhelp
= dtrace_helpers_create(to
);
15365 ASSERT(to
->p_dtrace_helpers
!= NULL
);
15367 newhelp
->dthps_generation
= help
->dthps_generation
;
15368 vstate
= &newhelp
->dthps_vstate
;
15371 * Duplicate the helper actions.
15373 for (i
= 0; i
< DTRACE_NHELPER_ACTIONS
; i
++) {
15374 if ((helper
= help
->dthps_actions
[i
]) == NULL
)
15377 for (last
= NULL
; helper
!= NULL
; helper
= helper
->dtha_next
) {
15378 new = kmem_zalloc(sizeof (dtrace_helper_action_t
),
15380 new->dtha_generation
= helper
->dtha_generation
;
15382 if ((dp
= helper
->dtha_predicate
) != NULL
) {
15383 dp
= dtrace_difo_duplicate(dp
, vstate
);
15384 new->dtha_predicate
= dp
;
15387 new->dtha_nactions
= helper
->dtha_nactions
;
15388 sz
= sizeof (dtrace_difo_t
*) * new->dtha_nactions
;
15389 new->dtha_actions
= kmem_alloc(sz
, KM_SLEEP
);
15391 for (j
= 0; j
< new->dtha_nactions
; j
++) {
15392 dtrace_difo_t
*dpj
= helper
->dtha_actions
[j
];
15394 ASSERT(dpj
!= NULL
);
15395 dpj
= dtrace_difo_duplicate(dpj
, vstate
);
15396 new->dtha_actions
[j
] = dpj
;
15399 if (last
!= NULL
) {
15400 last
->dtha_next
= new;
15402 newhelp
->dthps_actions
[i
] = new;
15410 * Duplicate the helper providers and register them with the
15411 * DTrace framework.
15413 if (help
->dthps_nprovs
> 0) {
15414 newhelp
->dthps_nprovs
= help
->dthps_nprovs
;
15415 newhelp
->dthps_maxprovs
= help
->dthps_nprovs
;
15416 newhelp
->dthps_provs
= kmem_alloc(newhelp
->dthps_nprovs
*
15417 sizeof (dtrace_helper_provider_t
*), KM_SLEEP
);
15418 for (i
= 0; i
< newhelp
->dthps_nprovs
; i
++) {
15419 newhelp
->dthps_provs
[i
] = help
->dthps_provs
[i
];
15420 newhelp
->dthps_provs
[i
]->dthp_ref
++;
15426 lck_mtx_unlock(&dtrace_lock
);
15429 dtrace_helper_provider_register(to
, newhelp
, NULL
);
15433 * DTrace Process functions
15437 dtrace_proc_fork(proc_t
*parent_proc
, proc_t
*child_proc
, int spawn
)
15440 * This code applies to new processes who are copying the task
15441 * and thread state and address spaces of their parent process.
15445 * APPLE NOTE: Solaris does a sprlock() and drops the
15446 * proc_lock here. We're cheating a bit and only taking
15447 * the p_dtrace_sprlock lock. A full sprlock would
15448 * task_suspend the parent.
15450 lck_mtx_lock(&parent_proc
->p_dtrace_sprlock
);
15453 * Remove all DTrace tracepoints from the child process. We
15454 * need to do this _before_ duplicating USDT providers since
15455 * any associated probes may be immediately enabled.
15457 if (parent_proc
->p_dtrace_count
> 0) {
15458 dtrace_fasttrap_fork(parent_proc
, child_proc
);
15461 lck_mtx_unlock(&parent_proc
->p_dtrace_sprlock
);
15464 * Duplicate any lazy dof(s). This must be done while NOT
15465 * holding the parent sprlock! Lock ordering is
15466 * dtrace_dof_mode_lock, then sprlock. It is imperative we
15467 * always call dtrace_lazy_dofs_duplicate, rather than null
15468 * check and call if !NULL. If we NULL test, during lazy dof
15469 * faulting we can race with the faulting code and proceed
15470 * from here to beyond the helpers copy. The lazy dof
15471 * faulting will then fail to copy the helpers to the child
15472 * process. We return if we duplicated lazy dofs as a process
15473 * can only have one at the same time to avoid a race between
15474 * a dtrace client and dtrace_proc_fork where a process would
15475 * end up with both lazy dofs and helpers.
15477 if (dtrace_lazy_dofs_duplicate(parent_proc
, child_proc
) == DTRACE_LAZY_DOFS_DUPLICATED
) {
15482 * Duplicate any helper actions and providers if they haven't
15485 #if !defined(__APPLE__)
15488 * we set above informs the code to enable USDT probes that
15489 * sprlock() may fail because the child is being forked.
15493 * APPLE NOTE: As best I can tell, Apple's sprlock() equivalent
15494 * never fails to find the child. We do not set SFORKING.
15496 if (parent_proc
->p_dtrace_helpers
!= NULL
&& dtrace_helpers_fork
) {
15497 (*dtrace_helpers_fork
)(parent_proc
, child_proc
);
15503 dtrace_proc_exec(proc_t
*p
)
15506 * Invalidate any predicate evaluation already cached for this thread by DTrace.
15507 * That's because we've just stored to p_comm and DTrace refers to that when it
15508 * evaluates the "execname" special variable. uid and gid may have changed as well.
15510 dtrace_set_thread_predcache(current_thread(), 0);
15513 * Free any outstanding lazy dof entries. It is imperative we
15514 * always call dtrace_lazy_dofs_destroy, rather than null check
15515 * and call if !NULL. If we NULL test, during lazy dof faulting
15516 * we can race with the faulting code and proceed from here to
15517 * beyond the helpers cleanup. The lazy dof faulting will then
15518 * install new helpers which no longer belong to this process!
15520 dtrace_lazy_dofs_destroy(p
);
15524 * Clean up any DTrace helpers for the process.
15526 if (p
->p_dtrace_helpers
!= NULL
&& dtrace_helpers_cleanup
) {
15527 (*dtrace_helpers_cleanup
)(p
);
15531 * Cleanup the DTrace provider associated with this process.
15534 if (p
->p_dtrace_probes
&& dtrace_fasttrap_exec_ptr
) {
15535 (*dtrace_fasttrap_exec_ptr
)(p
);
15541 dtrace_proc_exit(proc_t
*p
)
15544 * Free any outstanding lazy dof entries. It is imperative we
15545 * always call dtrace_lazy_dofs_destroy, rather than null check
15546 * and call if !NULL. If we NULL test, during lazy dof faulting
15547 * we can race with the faulting code and proceed from here to
15548 * beyond the helpers cleanup. The lazy dof faulting will then
15549 * install new helpers which will never be cleaned up, and leak.
15551 dtrace_lazy_dofs_destroy(p
);
15554 * Clean up any DTrace helper actions or probes for the process.
15556 if (p
->p_dtrace_helpers
!= NULL
) {
15557 (*dtrace_helpers_cleanup
)(p
);
15561 * Clean up any DTrace probes associated with this process.
15564 * APPLE NOTE: We release ptss pages/entries in dtrace_fasttrap_exit_ptr(),
15565 * call this after dtrace_helpers_cleanup()
15568 if (p
->p_dtrace_probes
&& dtrace_fasttrap_exit_ptr
) {
15569 (*dtrace_fasttrap_exit_ptr
)(p
);
15575 * DTrace Hook Functions
15579 * APPLE NOTE: dtrace_modctl_* routines for kext support.
15580 * Used to manipulate the modctl list within dtrace xnu.
15583 modctl_t
*dtrace_modctl_list
;
15586 dtrace_modctl_add(struct modctl
* newctl
)
15588 struct modctl
*nextp
, *prevp
;
15590 ASSERT(newctl
!= NULL
);
15591 lck_mtx_assert(&mod_lock
, LCK_MTX_ASSERT_OWNED
);
15593 // Insert new module at the front of the list,
15595 newctl
->mod_next
= dtrace_modctl_list
;
15596 dtrace_modctl_list
= newctl
;
15599 * If a module exists with the same name, then that module
15600 * must have been unloaded with enabled probes. We will move
15601 * the unloaded module to the new module's stale chain and
15602 * then stop traversing the list.
15606 nextp
= newctl
->mod_next
;
15608 while (nextp
!= NULL
) {
15609 if (nextp
->mod_loaded
) {
15610 /* This is a loaded module. Keep traversing. */
15612 nextp
= nextp
->mod_next
;
15616 /* Found an unloaded module */
15617 if (strncmp (newctl
->mod_modname
, nextp
->mod_modname
, KMOD_MAX_NAME
)) {
15618 /* Names don't match. Keep traversing. */
15620 nextp
= nextp
->mod_next
;
15624 /* We found a stale entry, move it. We're done. */
15625 prevp
->mod_next
= nextp
->mod_next
;
15626 newctl
->mod_stale
= nextp
;
15627 nextp
->mod_next
= NULL
;
15635 dtrace_modctl_lookup(struct kmod_info
* kmod
)
15637 lck_mtx_assert(&mod_lock
, LCK_MTX_ASSERT_OWNED
);
15639 struct modctl
* ctl
;
15641 for (ctl
= dtrace_modctl_list
; ctl
; ctl
=ctl
->mod_next
) {
15642 if (ctl
->mod_id
== kmod
->id
)
15649 * This routine is called from dtrace_module_unloaded().
15650 * It removes a modctl structure and its stale chain
15651 * from the kext shadow list.
15654 dtrace_modctl_remove(struct modctl
* ctl
)
15656 ASSERT(ctl
!= NULL
);
15657 lck_mtx_assert(&mod_lock
, LCK_MTX_ASSERT_OWNED
);
15658 modctl_t
*prevp
, *nextp
, *curp
;
15660 // Remove stale chain first
15661 for (curp
=ctl
->mod_stale
; curp
!= NULL
; curp
=nextp
) {
15662 nextp
= curp
->mod_stale
;
15663 /* There should NEVER be user symbols allocated at this point */
15664 ASSERT(curp
->mod_user_symbols
== NULL
);
15665 kmem_free(curp
, sizeof(modctl_t
));
15669 curp
= dtrace_modctl_list
;
15671 while (curp
!= ctl
) {
15673 curp
= curp
->mod_next
;
15676 if (prevp
!= NULL
) {
15677 prevp
->mod_next
= ctl
->mod_next
;
15680 dtrace_modctl_list
= ctl
->mod_next
;
15683 /* There should NEVER be user symbols allocated at this point */
15684 ASSERT(ctl
->mod_user_symbols
== NULL
);
15686 kmem_free (ctl
, sizeof(modctl_t
));
15690 * APPLE NOTE: The kext loader will call dtrace_module_loaded
15691 * when the kext is loaded in memory, but before calling the
15692 * kext's start routine.
15694 * Return 0 on success
15695 * Return -1 on failure
15699 dtrace_module_loaded(struct kmod_info
*kmod
, uint32_t flag
)
15701 dtrace_provider_t
*prv
;
15704 * If kernel symbols have been disabled, return immediately
15705 * DTRACE_KERNEL_SYMBOLS_NEVER is a permanent mode, it is safe to test without holding locks
15707 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_NEVER
)
15710 struct modctl
*ctl
= NULL
;
15711 if (!kmod
|| kmod
->address
== 0 || kmod
->size
== 0)
15714 lck_mtx_lock(&dtrace_provider_lock
);
15715 lck_mtx_lock(&mod_lock
);
15718 * Have we seen this kext before?
15721 ctl
= dtrace_modctl_lookup(kmod
);
15724 /* bail... we already have this kext in the modctl list */
15725 lck_mtx_unlock(&mod_lock
);
15726 lck_mtx_unlock(&dtrace_provider_lock
);
15727 if (dtrace_err_verbose
)
15728 cmn_err(CE_WARN
, "dtrace load module already exists '%s %u' is failing against '%s %u'", kmod
->name
, (uint_t
)kmod
->id
, ctl
->mod_modname
, ctl
->mod_id
);
15732 ctl
= kmem_alloc(sizeof(struct modctl
), KM_SLEEP
);
15734 if (dtrace_err_verbose
)
15735 cmn_err(CE_WARN
, "dtrace module load '%s %u' is failing ", kmod
->name
, (uint_t
)kmod
->id
);
15736 lck_mtx_unlock(&mod_lock
);
15737 lck_mtx_unlock(&dtrace_provider_lock
);
15740 ctl
->mod_next
= NULL
;
15741 ctl
->mod_stale
= NULL
;
15742 strlcpy (ctl
->mod_modname
, kmod
->name
, sizeof(ctl
->mod_modname
));
15743 ctl
->mod_loadcnt
= kmod
->id
;
15744 ctl
->mod_nenabled
= 0;
15745 ctl
->mod_address
= kmod
->address
;
15746 ctl
->mod_size
= kmod
->size
;
15747 ctl
->mod_id
= kmod
->id
;
15748 ctl
->mod_loaded
= 1;
15749 ctl
->mod_flags
= 0;
15750 ctl
->mod_user_symbols
= NULL
;
15753 * Find the UUID for this module, if it has one
15755 kernel_mach_header_t
* header
= (kernel_mach_header_t
*)ctl
->mod_address
;
15756 struct load_command
* load_cmd
= (struct load_command
*)&header
[1];
15758 for (i
= 0; i
< header
->ncmds
; i
++) {
15759 if (load_cmd
->cmd
== LC_UUID
) {
15760 struct uuid_command
* uuid_cmd
= (struct uuid_command
*)load_cmd
;
15761 memcpy(ctl
->mod_uuid
, uuid_cmd
->uuid
, sizeof(uuid_cmd
->uuid
));
15762 ctl
->mod_flags
|= MODCTL_HAS_UUID
;
15765 load_cmd
= (struct load_command
*)((caddr_t
)load_cmd
+ load_cmd
->cmdsize
);
15768 if (ctl
->mod_address
== g_kernel_kmod_info
.address
) {
15769 ctl
->mod_flags
|= MODCTL_IS_MACH_KERNEL
;
15772 dtrace_modctl_add(ctl
);
15775 * We must hold the dtrace_lock to safely test non permanent dtrace_fbt_symbol_mode(s)
15777 lck_mtx_lock(&dtrace_lock
);
15780 * DTrace must decide if it will instrument modules lazily via
15781 * userspace symbols (default mode), or instrument immediately via
15782 * kernel symbols (non-default mode)
15784 * When in default/lazy mode, DTrace will only support modules
15785 * built with a valid UUID.
15787 * Overriding the default can be done explicitly in one of
15788 * the following two ways.
15790 * A module can force symbols from kernel space using the plist key,
15791 * OSBundleForceDTraceInit (see kmod.h). If this per kext state is set,
15792 * we fall through and instrument this module now.
15794 * Or, the boot-arg, dtrace_kernel_symbol_mode, can be set to force symbols
15795 * from kernel space (see dtrace_impl.h). If this system state is set
15796 * to a non-userspace mode, we fall through and instrument the module now.
15799 if ((dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_FROM_USERSPACE
) &&
15800 (!(flag
& KMOD_DTRACE_FORCE_INIT
)))
15802 /* We will instrument the module lazily -- this is the default */
15803 lck_mtx_unlock(&dtrace_lock
);
15804 lck_mtx_unlock(&mod_lock
);
15805 lck_mtx_unlock(&dtrace_provider_lock
);
15809 /* We will instrument the module immediately using kernel symbols */
15810 ctl
->mod_flags
|= MODCTL_HAS_KERNEL_SYMBOLS
;
15812 lck_mtx_unlock(&dtrace_lock
);
15815 * We're going to call each providers per-module provide operation
15816 * specifying only this module.
15818 for (prv
= dtrace_provider
; prv
!= NULL
; prv
= prv
->dtpv_next
)
15819 prv
->dtpv_pops
.dtps_provide_module(prv
->dtpv_arg
, ctl
);
15822 * APPLE NOTE: The contract with the kext loader is that once this function
15823 * has completed, it may delete kernel symbols at will.
15824 * We must set this while still holding the mod_lock.
15826 ctl
->mod_flags
&= ~MODCTL_HAS_KERNEL_SYMBOLS
;
15828 lck_mtx_unlock(&mod_lock
);
15829 lck_mtx_unlock(&dtrace_provider_lock
);
15832 * If we have any retained enablings, we need to match against them.
15833 * Enabling probes requires that cpu_lock be held, and we cannot hold
15834 * cpu_lock here -- it is legal for cpu_lock to be held when loading a
15835 * module. (In particular, this happens when loading scheduling
15836 * classes.) So if we have any retained enablings, we need to dispatch
15837 * our task queue to do the match for us.
15839 lck_mtx_lock(&dtrace_lock
);
15841 if (dtrace_retained
== NULL
) {
15842 lck_mtx_unlock(&dtrace_lock
);
15848 * The cpu_lock mentioned above is only held by dtrace code, Apple's xnu never actually
15849 * holds it for any reason. Thus the comment above is invalid, we can directly invoke
15850 * dtrace_enabling_matchall without jumping through all the hoops, and we can avoid
15851 * the delay call as well.
15853 lck_mtx_unlock(&dtrace_lock
);
15855 dtrace_enabling_matchall();
15861 * Return 0 on success
15862 * Return -1 on failure
15865 dtrace_module_unloaded(struct kmod_info
*kmod
)
15867 dtrace_probe_t
template, *probe
, *first
, *next
;
15868 dtrace_provider_t
*prov
;
15869 struct modctl
*ctl
= NULL
;
15870 struct modctl
*syncctl
= NULL
;
15871 struct modctl
*nextsyncctl
= NULL
;
15874 lck_mtx_lock(&dtrace_provider_lock
);
15875 lck_mtx_lock(&mod_lock
);
15876 lck_mtx_lock(&dtrace_lock
);
15878 if (kmod
== NULL
) {
15882 ctl
= dtrace_modctl_lookup(kmod
);
15885 lck_mtx_unlock(&dtrace_lock
);
15886 lck_mtx_unlock(&mod_lock
);
15887 lck_mtx_unlock(&dtrace_provider_lock
);
15890 ctl
->mod_loaded
= 0;
15891 ctl
->mod_address
= 0;
15895 if (dtrace_bymod
== NULL
) {
15897 * The DTrace module is loaded (obviously) but not attached;
15898 * we don't have any work to do.
15901 (void)dtrace_modctl_remove(ctl
);
15902 lck_mtx_unlock(&dtrace_lock
);
15903 lck_mtx_unlock(&mod_lock
);
15904 lck_mtx_unlock(&dtrace_provider_lock
);
15908 /* Syncmode set means we target and traverse entire modctl list. */
15910 nextsyncctl
= dtrace_modctl_list
;
15915 /* find a stale modctl struct */
15916 for (syncctl
= nextsyncctl
; syncctl
!= NULL
; syncctl
=syncctl
->mod_next
) {
15917 if (syncctl
->mod_address
== 0)
15922 /* We have no more work to do */
15923 lck_mtx_unlock(&dtrace_lock
);
15924 lck_mtx_unlock(&mod_lock
);
15925 lck_mtx_unlock(&dtrace_provider_lock
);
15929 /* keep track of next syncctl in case this one is removed */
15930 nextsyncctl
= syncctl
->mod_next
;
15935 template.dtpr_mod
= ctl
->mod_modname
;
15937 for (probe
= first
= dtrace_hash_lookup(dtrace_bymod
, &template);
15938 probe
!= NULL
; probe
= probe
->dtpr_nextmod
) {
15939 if (probe
->dtpr_ecb
!= NULL
) {
15941 * This shouldn't _actually_ be possible -- we're
15942 * unloading a module that has an enabled probe in it.
15943 * (It's normally up to the provider to make sure that
15944 * this can't happen.) However, because dtps_enable()
15945 * doesn't have a failure mode, there can be an
15946 * enable/unload race. Upshot: we don't want to
15947 * assert, but we're not going to disable the
15953 /* We're syncing, let's look at next in list */
15957 lck_mtx_unlock(&dtrace_lock
);
15958 lck_mtx_unlock(&mod_lock
);
15959 lck_mtx_unlock(&dtrace_provider_lock
);
15961 if (dtrace_err_verbose
) {
15962 cmn_err(CE_WARN
, "unloaded module '%s' had "
15963 "enabled probes", ctl
->mod_modname
);
15971 for (first
= NULL
; probe
!= NULL
; probe
= next
) {
15972 ASSERT(dtrace_probes
[probe
->dtpr_id
- 1] == probe
);
15974 dtrace_probes
[probe
->dtpr_id
- 1] = NULL
;
15975 probe
->dtpr_provider
->dtpv_probe_count
--;
15977 next
= probe
->dtpr_nextmod
;
15978 dtrace_hash_remove(dtrace_bymod
, probe
);
15979 dtrace_hash_remove(dtrace_byfunc
, probe
);
15980 dtrace_hash_remove(dtrace_byname
, probe
);
15982 if (first
== NULL
) {
15984 probe
->dtpr_nextmod
= NULL
;
15986 probe
->dtpr_nextmod
= first
;
15992 * We've removed all of the module's probes from the hash chains and
15993 * from the probe array. Now issue a dtrace_sync() to be sure that
15994 * everyone has cleared out from any probe array processing.
15998 for (probe
= first
; probe
!= NULL
; probe
= first
) {
15999 first
= probe
->dtpr_nextmod
;
16000 prov
= probe
->dtpr_provider
;
16001 prov
->dtpv_pops
.dtps_destroy(prov
->dtpv_arg
, probe
->dtpr_id
,
16003 kmem_free(probe
->dtpr_mod
, strlen(probe
->dtpr_mod
) + 1);
16004 kmem_free(probe
->dtpr_func
, strlen(probe
->dtpr_func
) + 1);
16005 kmem_free(probe
->dtpr_name
, strlen(probe
->dtpr_name
) + 1);
16006 vmem_free(dtrace_arena
, (void *)(uintptr_t)probe
->dtpr_id
, 1);
16008 zfree(dtrace_probe_t_zone
, probe
);
16011 dtrace_modctl_remove(ctl
);
16016 lck_mtx_unlock(&dtrace_lock
);
16017 lck_mtx_unlock(&mod_lock
);
16018 lck_mtx_unlock(&dtrace_provider_lock
);
16024 dtrace_suspend(void)
16026 dtrace_probe_foreach(offsetof(dtrace_pops_t
, dtps_suspend
));
16030 dtrace_resume(void)
16032 dtrace_probe_foreach(offsetof(dtrace_pops_t
, dtps_resume
));
16036 dtrace_cpu_setup(cpu_setup_t what
, processorid_t cpu
)
16038 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
16039 lck_mtx_lock(&dtrace_lock
);
16043 dtrace_state_t
*state
;
16044 dtrace_optval_t
*opt
, rs
, c
;
16047 * For now, we only allocate a new buffer for anonymous state.
16049 if ((state
= dtrace_anon
.dta_state
) == NULL
)
16052 if (state
->dts_activity
!= DTRACE_ACTIVITY_ACTIVE
)
16055 opt
= state
->dts_options
;
16056 c
= opt
[DTRACEOPT_CPU
];
16058 if (c
!= DTRACE_CPUALL
&& c
!= DTRACEOPT_UNSET
&& c
!= cpu
)
16062 * Regardless of what the actual policy is, we're going to
16063 * temporarily set our resize policy to be manual. We're
16064 * also going to temporarily set our CPU option to denote
16065 * the newly configured CPU.
16067 rs
= opt
[DTRACEOPT_BUFRESIZE
];
16068 opt
[DTRACEOPT_BUFRESIZE
] = DTRACEOPT_BUFRESIZE_MANUAL
;
16069 opt
[DTRACEOPT_CPU
] = (dtrace_optval_t
)cpu
;
16071 (void) dtrace_state_buffers(state
);
16073 opt
[DTRACEOPT_BUFRESIZE
] = rs
;
16074 opt
[DTRACEOPT_CPU
] = c
;
16081 * We don't free the buffer in the CPU_UNCONFIG case. (The
16082 * buffer will be freed when the consumer exits.)
16090 lck_mtx_unlock(&dtrace_lock
);
16095 dtrace_cpu_setup_initial(processorid_t cpu
)
16097 (void) dtrace_cpu_setup(CPU_CONFIG
, cpu
);
16101 dtrace_toxrange_add(uintptr_t base
, uintptr_t limit
)
16103 if (dtrace_toxranges
>= dtrace_toxranges_max
) {
16105 dtrace_toxrange_t
*range
;
16107 osize
= dtrace_toxranges_max
* sizeof (dtrace_toxrange_t
);
16110 ASSERT(dtrace_toxrange
== NULL
);
16111 ASSERT(dtrace_toxranges_max
== 0);
16112 dtrace_toxranges_max
= 1;
16114 dtrace_toxranges_max
<<= 1;
16117 nsize
= dtrace_toxranges_max
* sizeof (dtrace_toxrange_t
);
16118 range
= kmem_zalloc(nsize
, KM_SLEEP
);
16120 if (dtrace_toxrange
!= NULL
) {
16121 ASSERT(osize
!= 0);
16122 bcopy(dtrace_toxrange
, range
, osize
);
16123 kmem_free(dtrace_toxrange
, osize
);
16126 dtrace_toxrange
= range
;
16129 ASSERT(dtrace_toxrange
[dtrace_toxranges
].dtt_base
== 0);
16130 ASSERT(dtrace_toxrange
[dtrace_toxranges
].dtt_limit
== 0);
16132 dtrace_toxrange
[dtrace_toxranges
].dtt_base
= base
;
16133 dtrace_toxrange
[dtrace_toxranges
].dtt_limit
= limit
;
16134 dtrace_toxranges
++;
16138 * DTrace Driver Cookbook Functions
16142 dtrace_attach(dev_info_t
*devi
, ddi_attach_cmd_t cmd
)
16144 #pragma unused(cmd) /* __APPLE__ */
16145 dtrace_provider_id_t id
;
16146 dtrace_state_t
*state
= NULL
;
16147 dtrace_enabling_t
*enab
;
16149 lck_mtx_lock(&cpu_lock
);
16150 lck_mtx_lock(&dtrace_provider_lock
);
16151 lck_mtx_lock(&dtrace_lock
);
16153 /* Darwin uses BSD cloning device driver to automagically obtain minor device number. */
16155 ddi_report_dev(devi
);
16156 dtrace_devi
= devi
;
16158 dtrace_modload
= dtrace_module_loaded
;
16159 dtrace_modunload
= dtrace_module_unloaded
;
16160 dtrace_cpu_init
= dtrace_cpu_setup_initial
;
16161 dtrace_helpers_cleanup
= dtrace_helpers_destroy
;
16162 dtrace_helpers_fork
= dtrace_helpers_duplicate
;
16163 dtrace_cpustart_init
= dtrace_suspend
;
16164 dtrace_cpustart_fini
= dtrace_resume
;
16165 dtrace_debugger_init
= dtrace_suspend
;
16166 dtrace_debugger_fini
= dtrace_resume
;
16168 register_cpu_setup_func((cpu_setup_func_t
*)dtrace_cpu_setup
, NULL
);
16170 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
16172 dtrace_arena
= vmem_create("dtrace", (void *)1, UINT32_MAX
, 1,
16173 NULL
, NULL
, NULL
, 0, VM_SLEEP
| VMC_IDENTIFIER
);
16174 dtrace_taskq
= taskq_create("dtrace_taskq", 1, maxclsyspri
,
16177 dtrace_state_cache
= kmem_cache_create("dtrace_state_cache",
16178 sizeof (dtrace_dstate_percpu_t
) * (int)NCPU
, DTRACE_STATE_ALIGN
,
16179 NULL
, NULL
, NULL
, NULL
, NULL
, 0);
16181 lck_mtx_assert(&cpu_lock
, LCK_MTX_ASSERT_OWNED
);
16183 dtrace_bymod
= dtrace_hash_create(offsetof(dtrace_probe_t
, dtpr_mod
),
16184 offsetof(dtrace_probe_t
, dtpr_nextmod
),
16185 offsetof(dtrace_probe_t
, dtpr_prevmod
));
16187 dtrace_byfunc
= dtrace_hash_create(offsetof(dtrace_probe_t
, dtpr_func
),
16188 offsetof(dtrace_probe_t
, dtpr_nextfunc
),
16189 offsetof(dtrace_probe_t
, dtpr_prevfunc
));
16191 dtrace_byname
= dtrace_hash_create(offsetof(dtrace_probe_t
, dtpr_name
),
16192 offsetof(dtrace_probe_t
, dtpr_nextname
),
16193 offsetof(dtrace_probe_t
, dtpr_prevname
));
16195 if (dtrace_retain_max
< 1) {
16196 cmn_err(CE_WARN
, "illegal value (%lu) for dtrace_retain_max; "
16197 "setting to 1", dtrace_retain_max
);
16198 dtrace_retain_max
= 1;
16202 * Now discover our toxic ranges.
16204 dtrace_toxic_ranges(dtrace_toxrange_add
);
16207 * Before we register ourselves as a provider to our own framework,
16208 * we would like to assert that dtrace_provider is NULL -- but that's
16209 * not true if we were loaded as a dependency of a DTrace provider.
16210 * Once we've registered, we can assert that dtrace_provider is our
16213 (void) dtrace_register("dtrace", &dtrace_provider_attr
,
16214 DTRACE_PRIV_NONE
, 0, &dtrace_provider_ops
, NULL
, &id
);
16216 ASSERT(dtrace_provider
!= NULL
);
16217 ASSERT((dtrace_provider_id_t
)dtrace_provider
== id
);
16219 #if defined (__x86_64__)
16220 dtrace_probeid_begin
= dtrace_probe_create((dtrace_provider_id_t
)
16221 dtrace_provider
, NULL
, NULL
, "BEGIN", 1, NULL
);
16222 dtrace_probeid_end
= dtrace_probe_create((dtrace_provider_id_t
)
16223 dtrace_provider
, NULL
, NULL
, "END", 0, NULL
);
16224 dtrace_probeid_error
= dtrace_probe_create((dtrace_provider_id_t
)
16225 dtrace_provider
, NULL
, NULL
, "ERROR", 3, NULL
);
16227 #error Unknown Architecture
16230 dtrace_anon_property();
16231 lck_mtx_unlock(&cpu_lock
);
16234 * If DTrace helper tracing is enabled, we need to allocate the
16235 * trace buffer and initialize the values.
16237 if (dtrace_helptrace_enabled
) {
16238 ASSERT(dtrace_helptrace_buffer
== NULL
);
16239 dtrace_helptrace_buffer
=
16240 kmem_zalloc(dtrace_helptrace_bufsize
, KM_SLEEP
);
16241 dtrace_helptrace_next
= 0;
16245 * If there are already providers, we must ask them to provide their
16246 * probes, and then match any anonymous enabling against them. Note
16247 * that there should be no other retained enablings at this time:
16248 * the only retained enablings at this time should be the anonymous
16251 if (dtrace_anon
.dta_enabling
!= NULL
) {
16252 ASSERT(dtrace_retained
== dtrace_anon
.dta_enabling
);
16255 * APPLE NOTE: if handling anonymous dof, switch symbol modes.
16257 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_FROM_USERSPACE
) {
16258 dtrace_kernel_symbol_mode
= DTRACE_KERNEL_SYMBOLS_FROM_KERNEL
;
16261 dtrace_enabling_provide(NULL
);
16262 state
= dtrace_anon
.dta_state
;
16265 * We couldn't hold cpu_lock across the above call to
16266 * dtrace_enabling_provide(), but we must hold it to actually
16267 * enable the probes. We have to drop all of our locks, pick
16268 * up cpu_lock, and regain our locks before matching the
16269 * retained anonymous enabling.
16271 lck_mtx_unlock(&dtrace_lock
);
16272 lck_mtx_unlock(&dtrace_provider_lock
);
16274 lck_mtx_lock(&cpu_lock
);
16275 lck_mtx_lock(&dtrace_provider_lock
);
16276 lck_mtx_lock(&dtrace_lock
);
16278 if ((enab
= dtrace_anon
.dta_enabling
) != NULL
)
16279 (void) dtrace_enabling_match(enab
, NULL
, NULL
);
16281 lck_mtx_unlock(&cpu_lock
);
16284 lck_mtx_unlock(&dtrace_lock
);
16285 lck_mtx_unlock(&dtrace_provider_lock
);
16287 if (state
!= NULL
) {
16289 * If we created any anonymous state, set it going now.
16291 (void) dtrace_state_go(state
, &dtrace_anon
.dta_beganon
);
16294 return (DDI_SUCCESS
);
16299 dtrace_open(dev_t
*devp
, int flag
, int otyp
, cred_t
*cred_p
)
16301 #pragma unused(flag, otyp)
16302 dtrace_state_t
*state
;
16308 /* APPLE: Darwin puts Helper on its own major device. */
16311 * If no DTRACE_PRIV_* bits are set in the credential, then the
16312 * caller lacks sufficient permission to do anything with DTrace.
16314 dtrace_cred2priv(cred_p
, &priv
, &uid
, &zoneid
);
16315 if (priv
== DTRACE_PRIV_NONE
)
16319 * APPLE NOTE: We delay the initialization of fasttrap as late as possible.
16320 * It certainly can't be later than now!
16325 * Ask all providers to provide all their probes.
16327 lck_mtx_lock(&dtrace_provider_lock
);
16328 dtrace_probe_provide(NULL
, NULL
);
16329 lck_mtx_unlock(&dtrace_provider_lock
);
16331 lck_mtx_lock(&cpu_lock
);
16332 lck_mtx_lock(&dtrace_lock
);
16334 dtrace_membar_producer();
16337 * If the kernel debugger is active (that is, if the kernel debugger
16338 * modified text in some way), we won't allow the open.
16340 if (kdi_dtrace_set(KDI_DTSET_DTRACE_ACTIVATE
) != 0) {
16342 lck_mtx_unlock(&dtrace_lock
);
16343 lck_mtx_unlock(&cpu_lock
);
16347 rv
= dtrace_state_create(devp
, cred_p
, &state
);
16348 lck_mtx_unlock(&cpu_lock
);
16350 if (rv
!= 0 || state
== NULL
) {
16351 if (--dtrace_opens
== 0 && dtrace_anon
.dta_enabling
== NULL
)
16352 (void) kdi_dtrace_set(KDI_DTSET_DTRACE_DEACTIVATE
);
16353 lck_mtx_unlock(&dtrace_lock
);
16354 /* propagate EAGAIN or ERESTART */
16358 lck_mtx_unlock(&dtrace_lock
);
16360 lck_rw_lock_exclusive(&dtrace_dof_mode_lock
);
16363 * If we are currently lazy, transition states.
16365 * Unlike dtrace_close, we do not need to check the
16366 * value of dtrace_opens, as any positive value (and
16367 * we count as 1) means we transition states.
16369 if (dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_ON
) {
16370 dtrace_dof_mode
= DTRACE_DOF_MODE_LAZY_OFF
;
16372 * We do not need to hold the exclusive lock while processing
16373 * DOF on processes. We do need to make sure the mode does not get
16374 * changed to DTRACE_DOF_MODE_LAZY_ON during that stage though
16375 * (which should not happen anyway since it only happens in
16376 * dtrace_close). There is no way imcomplete USDT probes can be
16377 * activate by any DTrace clients here since they all have to
16378 * call dtrace_open and be blocked on dtrace_dof_mode_lock
16380 lck_rw_lock_exclusive_to_shared(&dtrace_dof_mode_lock
);
16382 * Iterate all existing processes and load lazy dofs.
16384 proc_iterate(PROC_ALLPROCLIST
| PROC_NOWAITTRANS
,
16385 dtrace_lazy_dofs_proc_iterate_doit
,
16387 dtrace_lazy_dofs_proc_iterate_filter
,
16390 lck_rw_unlock_shared(&dtrace_dof_mode_lock
);
16393 lck_rw_unlock_exclusive(&dtrace_dof_mode_lock
);
16398 * Update kernel symbol state.
16400 * We must own the provider and dtrace locks.
16402 * NOTE! It may appear there is a race by setting this value so late
16403 * after dtrace_probe_provide. However, any kext loaded after the
16404 * call to probe provide and before we set LAZY_OFF will be marked as
16405 * eligible for symbols from userspace. The same dtrace that is currently
16406 * calling dtrace_open() (this call!) will get a list of kexts needing
16407 * symbols and fill them in, thus closing the race window.
16409 * We want to set this value only after it certain it will succeed, as
16410 * this significantly reduces the complexity of error exits.
16412 lck_mtx_lock(&dtrace_lock
);
16413 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_FROM_USERSPACE
) {
16414 dtrace_kernel_symbol_mode
= DTRACE_KERNEL_SYMBOLS_FROM_KERNEL
;
16416 lck_mtx_unlock(&dtrace_lock
);
16423 dtrace_close(dev_t dev
, int flag
, int otyp
, cred_t
*cred_p
)
16425 #pragma unused(flag, otyp, cred_p) /* __APPLE__ */
16426 minor_t minor
= getminor(dev
);
16427 dtrace_state_t
*state
;
16429 /* APPLE NOTE: Darwin puts Helper on its own major device. */
16430 state
= dtrace_state_get(minor
);
16432 lck_mtx_lock(&cpu_lock
);
16433 lck_mtx_lock(&dtrace_lock
);
16435 if (state
->dts_anon
) {
16437 * There is anonymous state. Destroy that first.
16439 ASSERT(dtrace_anon
.dta_state
== NULL
);
16440 dtrace_state_destroy(state
->dts_anon
);
16443 dtrace_state_destroy(state
);
16444 ASSERT(dtrace_opens
> 0);
16447 * Only relinquish control of the kernel debugger interface when there
16448 * are no consumers and no anonymous enablings.
16450 if (--dtrace_opens
== 0 && dtrace_anon
.dta_enabling
== NULL
)
16451 (void) kdi_dtrace_set(KDI_DTSET_DTRACE_DEACTIVATE
);
16453 lck_mtx_unlock(&dtrace_lock
);
16454 lck_mtx_unlock(&cpu_lock
);
16457 * Lock ordering requires the dof mode lock be taken before
16460 lck_rw_lock_exclusive(&dtrace_dof_mode_lock
);
16461 lck_mtx_lock(&dtrace_lock
);
16463 if (dtrace_opens
== 0) {
16465 * If we are currently lazy-off, and this is the last close, transition to
16468 if (dtrace_dof_mode
== DTRACE_DOF_MODE_LAZY_OFF
) {
16469 dtrace_dof_mode
= DTRACE_DOF_MODE_LAZY_ON
;
16473 * If we are the last dtrace client, switch back to lazy (from userspace) symbols
16475 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_FROM_KERNEL
) {
16476 dtrace_kernel_symbol_mode
= DTRACE_KERNEL_SYMBOLS_FROM_USERSPACE
;
16480 lck_mtx_unlock(&dtrace_lock
);
16481 lck_rw_unlock_exclusive(&dtrace_dof_mode_lock
);
16484 * Kext probes may be retained past the end of the kext's lifespan. The
16485 * probes are kept until the last reference to them has been removed.
16486 * Since closing an active dtrace context is likely to drop that last reference,
16487 * lets take a shot at cleaning out the orphaned probes now.
16489 dtrace_module_unloaded(NULL
);
16496 dtrace_ioctl_helper(u_long cmd
, caddr_t arg
, int *rv
)
16500 * Safe to check this outside the dof mode lock
16502 if (dtrace_dof_mode
== DTRACE_DOF_MODE_NEVER
)
16503 return KERN_SUCCESS
;
16506 case DTRACEHIOC_ADDDOF
:
16508 dof_helper_t
*dhp
= NULL
;
16509 size_t dof_ioctl_data_size
;
16510 dof_ioctl_data_t
* multi_dof
;
16513 user_addr_t user_address
= *(user_addr_t
*)arg
;
16514 uint64_t dof_count
;
16515 int multi_dof_claimed
= 0;
16516 proc_t
* p
= current_proc();
16519 * Read the number of DOF sections being passed in.
16521 if (copyin(user_address
+ offsetof(dof_ioctl_data_t
, dofiod_count
),
16523 sizeof(dof_count
))) {
16524 dtrace_dof_error(NULL
, "failed to copyin dofiod_count");
16529 * Range check the count.
16531 if (dof_count
== 0 || dof_count
> 1024) {
16532 dtrace_dof_error(NULL
, "dofiod_count is not valid");
16537 * Allocate a correctly sized structure and copyin the data.
16539 dof_ioctl_data_size
= DOF_IOCTL_DATA_T_SIZE(dof_count
);
16540 if ((multi_dof
= kmem_alloc(dof_ioctl_data_size
, KM_SLEEP
)) == NULL
)
16543 /* NOTE! We can no longer exit this method via return */
16544 if (copyin(user_address
, multi_dof
, dof_ioctl_data_size
) != 0) {
16545 dtrace_dof_error(NULL
, "failed copyin of dof_ioctl_data_t");
16551 * Check that the count didn't change between the first copyin and the second.
16553 if (multi_dof
->dofiod_count
!= dof_count
) {
16559 * Try to process lazily first.
16561 rval
= dtrace_lazy_dofs_add(p
, multi_dof
, &multi_dof_claimed
);
16564 * If rval is EACCES, we must be non-lazy.
16566 if (rval
== EACCES
) {
16569 * Process each dof_helper_t
16573 dhp
= &multi_dof
->dofiod_helpers
[i
];
16575 dof_hdr_t
*dof
= dtrace_dof_copyin(dhp
->dofhp_dof
, &rval
);
16578 lck_mtx_lock(&dtrace_lock
);
16581 * dtrace_helper_slurp() takes responsibility for the dof --
16582 * it may free it now or it may save it and free it later.
16584 if ((dhp
->dofhp_dof
= (uint64_t)dtrace_helper_slurp(p
, dof
, dhp
)) == -1ULL) {
16588 lck_mtx_unlock(&dtrace_lock
);
16590 } while (++i
< multi_dof
->dofiod_count
&& rval
== 0);
16594 * We need to copyout the multi_dof struct, because it contains
16595 * the generation (unique id) values needed to call DTRACEHIOC_REMOVE
16597 * This could certainly be better optimized.
16599 if (copyout(multi_dof
, user_address
, dof_ioctl_data_size
) != 0) {
16600 dtrace_dof_error(NULL
, "failed copyout of dof_ioctl_data_t");
16601 /* Don't overwrite pre-existing error code */
16602 if (rval
== 0) rval
= EFAULT
;
16607 * If we had to allocate struct memory, free it.
16609 if (multi_dof
!= NULL
&& !multi_dof_claimed
) {
16610 kmem_free(multi_dof
, dof_ioctl_data_size
);
16616 case DTRACEHIOC_REMOVE
: {
16617 int generation
= *(int*)arg
;
16618 proc_t
* p
= current_proc();
16623 int rval
= dtrace_lazy_dofs_remove(p
, generation
);
16626 * EACCES means non-lazy
16628 if (rval
== EACCES
) {
16629 lck_mtx_lock(&dtrace_lock
);
16630 rval
= dtrace_helper_destroygen(p
, generation
);
16631 lck_mtx_unlock(&dtrace_lock
);
16646 dtrace_ioctl(dev_t dev
, u_long cmd
, user_addr_t arg
, int md
, cred_t
*cr
, int *rv
)
16649 minor_t minor
= getminor(dev
);
16650 dtrace_state_t
*state
;
16653 /* Darwin puts Helper on its own major device. */
16655 state
= dtrace_state_get(minor
);
16657 if (state
->dts_anon
) {
16658 ASSERT(dtrace_anon
.dta_state
== NULL
);
16659 state
= state
->dts_anon
;
16663 case DTRACEIOC_PROVIDER
: {
16664 dtrace_providerdesc_t pvd
;
16665 dtrace_provider_t
*pvp
;
16667 if (copyin(arg
, &pvd
, sizeof (pvd
)) != 0)
16670 pvd
.dtvd_name
[DTRACE_PROVNAMELEN
- 1] = '\0';
16671 lck_mtx_lock(&dtrace_provider_lock
);
16673 for (pvp
= dtrace_provider
; pvp
!= NULL
; pvp
= pvp
->dtpv_next
) {
16674 if (strncmp(pvp
->dtpv_name
, pvd
.dtvd_name
, DTRACE_PROVNAMELEN
) == 0)
16678 lck_mtx_unlock(&dtrace_provider_lock
);
16683 bcopy(&pvp
->dtpv_priv
, &pvd
.dtvd_priv
, sizeof (dtrace_ppriv_t
));
16684 bcopy(&pvp
->dtpv_attr
, &pvd
.dtvd_attr
, sizeof (dtrace_pattr_t
));
16685 if (copyout(&pvd
, arg
, sizeof (pvd
)) != 0)
16691 case DTRACEIOC_EPROBE
: {
16692 dtrace_eprobedesc_t epdesc
;
16694 dtrace_action_t
*act
;
16700 if (copyin(arg
, &epdesc
, sizeof (epdesc
)) != 0)
16703 lck_mtx_lock(&dtrace_lock
);
16705 if ((ecb
= dtrace_epid2ecb(state
, epdesc
.dtepd_epid
)) == NULL
) {
16706 lck_mtx_unlock(&dtrace_lock
);
16710 if (ecb
->dte_probe
== NULL
) {
16711 lck_mtx_unlock(&dtrace_lock
);
16715 epdesc
.dtepd_probeid
= ecb
->dte_probe
->dtpr_id
;
16716 epdesc
.dtepd_uarg
= ecb
->dte_uarg
;
16717 epdesc
.dtepd_size
= ecb
->dte_size
;
16719 nrecs
= epdesc
.dtepd_nrecs
;
16720 epdesc
.dtepd_nrecs
= 0;
16721 for (act
= ecb
->dte_action
; act
!= NULL
; act
= act
->dta_next
) {
16722 if (DTRACEACT_ISAGG(act
->dta_kind
) || act
->dta_intuple
)
16725 epdesc
.dtepd_nrecs
++;
16729 * Now that we have the size, we need to allocate a temporary
16730 * buffer in which to store the complete description. We need
16731 * the temporary buffer to be able to drop dtrace_lock()
16732 * across the copyout(), below.
16734 size
= sizeof (dtrace_eprobedesc_t
) +
16735 (epdesc
.dtepd_nrecs
* sizeof (dtrace_recdesc_t
));
16737 buf
= kmem_alloc(size
, KM_SLEEP
);
16738 dest
= (uintptr_t)buf
;
16740 bcopy(&epdesc
, (void *)dest
, sizeof (epdesc
));
16741 dest
+= offsetof(dtrace_eprobedesc_t
, dtepd_rec
[0]);
16743 for (act
= ecb
->dte_action
; act
!= NULL
; act
= act
->dta_next
) {
16744 if (DTRACEACT_ISAGG(act
->dta_kind
) || act
->dta_intuple
)
16750 bcopy(&act
->dta_rec
, (void *)dest
,
16751 sizeof (dtrace_recdesc_t
));
16752 dest
+= sizeof (dtrace_recdesc_t
);
16755 lck_mtx_unlock(&dtrace_lock
);
16757 if (copyout(buf
, arg
, dest
- (uintptr_t)buf
) != 0) {
16758 kmem_free(buf
, size
);
16762 kmem_free(buf
, size
);
16766 case DTRACEIOC_AGGDESC
: {
16767 dtrace_aggdesc_t aggdesc
;
16768 dtrace_action_t
*act
;
16769 dtrace_aggregation_t
*agg
;
16772 dtrace_recdesc_t
*lrec
;
16777 if (copyin(arg
, &aggdesc
, sizeof (aggdesc
)) != 0)
16780 lck_mtx_lock(&dtrace_lock
);
16782 if ((agg
= dtrace_aggid2agg(state
, aggdesc
.dtagd_id
)) == NULL
) {
16783 lck_mtx_unlock(&dtrace_lock
);
16787 aggdesc
.dtagd_epid
= agg
->dtag_ecb
->dte_epid
;
16789 nrecs
= aggdesc
.dtagd_nrecs
;
16790 aggdesc
.dtagd_nrecs
= 0;
16792 offs
= agg
->dtag_base
;
16793 lrec
= &agg
->dtag_action
.dta_rec
;
16794 aggdesc
.dtagd_size
= lrec
->dtrd_offset
+ lrec
->dtrd_size
- offs
;
16796 for (act
= agg
->dtag_first
; ; act
= act
->dta_next
) {
16797 ASSERT(act
->dta_intuple
||
16798 DTRACEACT_ISAGG(act
->dta_kind
));
16801 * If this action has a record size of zero, it
16802 * denotes an argument to the aggregating action.
16803 * Because the presence of this record doesn't (or
16804 * shouldn't) affect the way the data is interpreted,
16805 * we don't copy it out to save user-level the
16806 * confusion of dealing with a zero-length record.
16808 if (act
->dta_rec
.dtrd_size
== 0) {
16809 ASSERT(agg
->dtag_hasarg
);
16813 aggdesc
.dtagd_nrecs
++;
16815 if (act
== &agg
->dtag_action
)
16820 * Now that we have the size, we need to allocate a temporary
16821 * buffer in which to store the complete description. We need
16822 * the temporary buffer to be able to drop dtrace_lock()
16823 * across the copyout(), below.
16825 size
= sizeof (dtrace_aggdesc_t
) +
16826 (aggdesc
.dtagd_nrecs
* sizeof (dtrace_recdesc_t
));
16828 buf
= kmem_alloc(size
, KM_SLEEP
);
16829 dest
= (uintptr_t)buf
;
16831 bcopy(&aggdesc
, (void *)dest
, sizeof (aggdesc
));
16832 dest
+= offsetof(dtrace_aggdesc_t
, dtagd_rec
[0]);
16834 for (act
= agg
->dtag_first
; ; act
= act
->dta_next
) {
16835 dtrace_recdesc_t rec
= act
->dta_rec
;
16838 * See the comment in the above loop for why we pass
16839 * over zero-length records.
16841 if (rec
.dtrd_size
== 0) {
16842 ASSERT(agg
->dtag_hasarg
);
16849 rec
.dtrd_offset
-= offs
;
16850 bcopy(&rec
, (void *)dest
, sizeof (rec
));
16851 dest
+= sizeof (dtrace_recdesc_t
);
16853 if (act
== &agg
->dtag_action
)
16857 lck_mtx_unlock(&dtrace_lock
);
16859 if (copyout(buf
, arg
, dest
- (uintptr_t)buf
) != 0) {
16860 kmem_free(buf
, size
);
16864 kmem_free(buf
, size
);
16868 case DTRACEIOC_ENABLE
: {
16870 dtrace_enabling_t
*enab
= NULL
;
16871 dtrace_vstate_t
*vstate
;
16877 * If a NULL argument has been passed, we take this as our
16878 * cue to reevaluate our enablings.
16881 dtrace_enabling_matchall();
16886 if ((dof
= dtrace_dof_copyin(arg
, &rval
)) == NULL
)
16889 lck_mtx_lock(&cpu_lock
);
16890 lck_mtx_lock(&dtrace_lock
);
16891 vstate
= &state
->dts_vstate
;
16893 if (state
->dts_activity
!= DTRACE_ACTIVITY_INACTIVE
) {
16894 lck_mtx_unlock(&dtrace_lock
);
16895 lck_mtx_unlock(&cpu_lock
);
16896 dtrace_dof_destroy(dof
);
16900 if (dtrace_dof_slurp(dof
, vstate
, cr
, &enab
, 0, B_TRUE
) != 0) {
16901 lck_mtx_unlock(&dtrace_lock
);
16902 lck_mtx_unlock(&cpu_lock
);
16903 dtrace_dof_destroy(dof
);
16907 if ((rval
= dtrace_dof_options(dof
, state
)) != 0) {
16908 dtrace_enabling_destroy(enab
);
16909 lck_mtx_unlock(&dtrace_lock
);
16910 lck_mtx_unlock(&cpu_lock
);
16911 dtrace_dof_destroy(dof
);
16915 if ((err
= dtrace_enabling_match(enab
, rv
, NULL
)) == 0) {
16916 err
= dtrace_enabling_retain(enab
);
16918 dtrace_enabling_destroy(enab
);
16921 lck_mtx_unlock(&dtrace_lock
);
16922 lck_mtx_unlock(&cpu_lock
);
16923 dtrace_dof_destroy(dof
);
16928 case DTRACEIOC_REPLICATE
: {
16929 dtrace_repldesc_t desc
;
16930 dtrace_probedesc_t
*match
= &desc
.dtrpd_match
;
16931 dtrace_probedesc_t
*create
= &desc
.dtrpd_create
;
16934 if (copyin(arg
, &desc
, sizeof (desc
)) != 0)
16937 match
->dtpd_provider
[DTRACE_PROVNAMELEN
- 1] = '\0';
16938 match
->dtpd_mod
[DTRACE_MODNAMELEN
- 1] = '\0';
16939 match
->dtpd_func
[DTRACE_FUNCNAMELEN
- 1] = '\0';
16940 match
->dtpd_name
[DTRACE_NAMELEN
- 1] = '\0';
16942 create
->dtpd_provider
[DTRACE_PROVNAMELEN
- 1] = '\0';
16943 create
->dtpd_mod
[DTRACE_MODNAMELEN
- 1] = '\0';
16944 create
->dtpd_func
[DTRACE_FUNCNAMELEN
- 1] = '\0';
16945 create
->dtpd_name
[DTRACE_NAMELEN
- 1] = '\0';
16947 lck_mtx_lock(&dtrace_lock
);
16948 err
= dtrace_enabling_replicate(state
, match
, create
);
16949 lck_mtx_unlock(&dtrace_lock
);
16954 case DTRACEIOC_PROBEMATCH
:
16955 case DTRACEIOC_PROBES
: {
16956 dtrace_probe_t
*probe
= NULL
;
16957 dtrace_probedesc_t desc
;
16958 dtrace_probekey_t pkey
;
16965 if (copyin(arg
, &desc
, sizeof (desc
)) != 0)
16968 desc
.dtpd_provider
[DTRACE_PROVNAMELEN
- 1] = '\0';
16969 desc
.dtpd_mod
[DTRACE_MODNAMELEN
- 1] = '\0';
16970 desc
.dtpd_func
[DTRACE_FUNCNAMELEN
- 1] = '\0';
16971 desc
.dtpd_name
[DTRACE_NAMELEN
- 1] = '\0';
16974 * Before we attempt to match this probe, we want to give
16975 * all providers the opportunity to provide it.
16977 if (desc
.dtpd_id
== DTRACE_IDNONE
) {
16978 lck_mtx_lock(&dtrace_provider_lock
);
16979 dtrace_probe_provide(&desc
, NULL
);
16980 lck_mtx_unlock(&dtrace_provider_lock
);
16984 if (cmd
== DTRACEIOC_PROBEMATCH
) {
16985 dtrace_probekey(&desc
, &pkey
);
16986 pkey
.dtpk_id
= DTRACE_IDNONE
;
16989 dtrace_cred2priv(cr
, &priv
, &uid
, &zoneid
);
16991 lck_mtx_lock(&dtrace_lock
);
16993 if (cmd
== DTRACEIOC_PROBEMATCH
) {
16994 /* Quiet compiler warning */
16995 for (i
= desc
.dtpd_id
; i
<= (dtrace_id_t
)dtrace_nprobes
; i
++) {
16996 if ((probe
= dtrace_probes
[i
- 1]) != NULL
&&
16997 (m
= dtrace_match_probe(probe
, &pkey
,
16998 priv
, uid
, zoneid
)) != 0)
17003 lck_mtx_unlock(&dtrace_lock
);
17008 /* Quiet compiler warning */
17009 for (i
= desc
.dtpd_id
; i
<= (dtrace_id_t
)dtrace_nprobes
; i
++) {
17010 if ((probe
= dtrace_probes
[i
- 1]) != NULL
&&
17011 dtrace_match_priv(probe
, priv
, uid
, zoneid
))
17016 if (probe
== NULL
) {
17017 lck_mtx_unlock(&dtrace_lock
);
17021 dtrace_probe_description(probe
, &desc
);
17022 lck_mtx_unlock(&dtrace_lock
);
17024 if (copyout(&desc
, arg
, sizeof (desc
)) != 0)
17030 case DTRACEIOC_PROBEARG
: {
17031 dtrace_argdesc_t desc
;
17032 dtrace_probe_t
*probe
;
17033 dtrace_provider_t
*prov
;
17035 if (copyin(arg
, &desc
, sizeof (desc
)) != 0)
17038 if (desc
.dtargd_id
== DTRACE_IDNONE
)
17041 if (desc
.dtargd_ndx
== DTRACE_ARGNONE
)
17044 lck_mtx_lock(&dtrace_provider_lock
);
17045 lck_mtx_lock(&mod_lock
);
17046 lck_mtx_lock(&dtrace_lock
);
17048 /* Quiet compiler warning */
17049 if (desc
.dtargd_id
> (dtrace_id_t
)dtrace_nprobes
) {
17050 lck_mtx_unlock(&dtrace_lock
);
17051 lck_mtx_unlock(&mod_lock
);
17052 lck_mtx_unlock(&dtrace_provider_lock
);
17056 if ((probe
= dtrace_probes
[desc
.dtargd_id
- 1]) == NULL
) {
17057 lck_mtx_unlock(&dtrace_lock
);
17058 lck_mtx_unlock(&mod_lock
);
17059 lck_mtx_unlock(&dtrace_provider_lock
);
17063 lck_mtx_unlock(&dtrace_lock
);
17065 prov
= probe
->dtpr_provider
;
17067 if (prov
->dtpv_pops
.dtps_getargdesc
== NULL
) {
17069 * There isn't any typed information for this probe.
17070 * Set the argument number to DTRACE_ARGNONE.
17072 desc
.dtargd_ndx
= DTRACE_ARGNONE
;
17074 desc
.dtargd_native
[0] = '\0';
17075 desc
.dtargd_xlate
[0] = '\0';
17076 desc
.dtargd_mapping
= desc
.dtargd_ndx
;
17078 prov
->dtpv_pops
.dtps_getargdesc(prov
->dtpv_arg
,
17079 probe
->dtpr_id
, probe
->dtpr_arg
, &desc
);
17082 lck_mtx_unlock(&mod_lock
);
17083 lck_mtx_unlock(&dtrace_provider_lock
);
17085 if (copyout(&desc
, arg
, sizeof (desc
)) != 0)
17091 case DTRACEIOC_GO
: {
17092 processorid_t cpuid
;
17093 rval
= dtrace_state_go(state
, &cpuid
);
17098 if (copyout(&cpuid
, arg
, sizeof (cpuid
)) != 0)
17104 case DTRACEIOC_STOP
: {
17105 processorid_t cpuid
;
17107 lck_mtx_lock(&dtrace_lock
);
17108 rval
= dtrace_state_stop(state
, &cpuid
);
17109 lck_mtx_unlock(&dtrace_lock
);
17114 if (copyout(&cpuid
, arg
, sizeof (cpuid
)) != 0)
17120 case DTRACEIOC_DOFGET
: {
17121 dof_hdr_t hdr
, *dof
;
17124 if (copyin(arg
, &hdr
, sizeof (hdr
)) != 0)
17127 lck_mtx_lock(&dtrace_lock
);
17128 dof
= dtrace_dof_create(state
);
17129 lck_mtx_unlock(&dtrace_lock
);
17131 len
= MIN(hdr
.dofh_loadsz
, dof
->dofh_loadsz
);
17132 rval
= copyout(dof
, arg
, len
);
17133 dtrace_dof_destroy(dof
);
17135 return (rval
== 0 ? 0 : EFAULT
);
17138 case DTRACEIOC_SLEEP
: {
17141 uint64_t rvalue
= DTRACE_WAKE_TIMEOUT
;
17143 if (copyin(arg
, &time
, sizeof(time
)) != 0)
17146 nanoseconds_to_absolutetime((uint64_t)time
, &abstime
);
17147 clock_absolutetime_interval_to_deadline(abstime
, &abstime
);
17149 if (assert_wait_deadline(state
, THREAD_ABORTSAFE
, abstime
) == THREAD_WAITING
) {
17150 if (state
->dts_buf_over_limit
> 0) {
17151 clear_wait(current_thread(), THREAD_INTERRUPTED
);
17152 rvalue
= DTRACE_WAKE_BUF_LIMIT
;
17154 thread_block(THREAD_CONTINUE_NULL
);
17155 if (state
->dts_buf_over_limit
> 0) {
17156 rvalue
= DTRACE_WAKE_BUF_LIMIT
;
17161 if (copyout(&rvalue
, arg
, sizeof(rvalue
)) != 0)
17167 case DTRACEIOC_SIGNAL
: {
17172 case DTRACEIOC_AGGSNAP
:
17173 case DTRACEIOC_BUFSNAP
: {
17174 dtrace_bufdesc_t desc
;
17176 boolean_t over_limit
;
17177 dtrace_buffer_t
*buf
;
17179 if (copyin(arg
, &desc
, sizeof (desc
)) != 0)
17182 if ((int)desc
.dtbd_cpu
< 0 || desc
.dtbd_cpu
>= NCPU
)
17185 lck_mtx_lock(&dtrace_lock
);
17187 if (cmd
== DTRACEIOC_BUFSNAP
) {
17188 buf
= &state
->dts_buffer
[desc
.dtbd_cpu
];
17190 buf
= &state
->dts_aggbuffer
[desc
.dtbd_cpu
];
17193 if (buf
->dtb_flags
& (DTRACEBUF_RING
| DTRACEBUF_FILL
)) {
17194 size_t sz
= buf
->dtb_offset
;
17196 if (state
->dts_activity
!= DTRACE_ACTIVITY_STOPPED
) {
17197 lck_mtx_unlock(&dtrace_lock
);
17202 * If this buffer has already been consumed, we're
17203 * going to indicate that there's nothing left here
17206 if (buf
->dtb_flags
& DTRACEBUF_CONSUMED
) {
17207 lck_mtx_unlock(&dtrace_lock
);
17209 desc
.dtbd_size
= 0;
17210 desc
.dtbd_drops
= 0;
17211 desc
.dtbd_errors
= 0;
17212 desc
.dtbd_oldest
= 0;
17213 sz
= sizeof (desc
);
17215 if (copyout(&desc
, arg
, sz
) != 0)
17222 * If this is a ring buffer that has wrapped, we want
17223 * to copy the whole thing out.
17225 if (buf
->dtb_flags
& DTRACEBUF_WRAPPED
) {
17226 dtrace_buffer_polish(buf
);
17227 sz
= buf
->dtb_size
;
17230 if (copyout(buf
->dtb_tomax
, (user_addr_t
)desc
.dtbd_data
, sz
) != 0) {
17231 lck_mtx_unlock(&dtrace_lock
);
17235 desc
.dtbd_size
= sz
;
17236 desc
.dtbd_drops
= buf
->dtb_drops
;
17237 desc
.dtbd_errors
= buf
->dtb_errors
;
17238 desc
.dtbd_oldest
= buf
->dtb_xamot_offset
;
17239 desc
.dtbd_timestamp
= dtrace_gethrtime();
17241 lck_mtx_unlock(&dtrace_lock
);
17243 if (copyout(&desc
, arg
, sizeof (desc
)) != 0)
17246 buf
->dtb_flags
|= DTRACEBUF_CONSUMED
;
17251 if (buf
->dtb_tomax
== NULL
) {
17252 ASSERT(buf
->dtb_xamot
== NULL
);
17253 lck_mtx_unlock(&dtrace_lock
);
17257 cached
= buf
->dtb_tomax
;
17258 over_limit
= buf
->dtb_cur_limit
== buf
->dtb_size
;
17260 ASSERT(!(buf
->dtb_flags
& DTRACEBUF_NOSWITCH
));
17262 dtrace_xcall(desc
.dtbd_cpu
,
17263 (dtrace_xcall_t
)dtrace_buffer_switch
, buf
);
17265 state
->dts_errors
+= buf
->dtb_xamot_errors
;
17268 * If the buffers did not actually switch, then the cross call
17269 * did not take place -- presumably because the given CPU is
17270 * not in the ready set. If this is the case, we'll return
17273 if (buf
->dtb_tomax
== cached
) {
17274 ASSERT(buf
->dtb_xamot
!= cached
);
17275 lck_mtx_unlock(&dtrace_lock
);
17279 ASSERT(cached
== buf
->dtb_xamot
);
17281 * At this point we know the buffer have switched, so we
17282 * can decrement the over limit count if the buffer was over
17283 * its limit. The new buffer might already be over its limit
17284 * yet, but we don't care since we're guaranteed not to be
17285 * checking the buffer over limit count at this point.
17288 uint32_t old
= atomic_add_32(&state
->dts_buf_over_limit
, -1);
17289 #pragma unused(old)
17292 * Verify that we didn't underflow the value
17298 * We have our snapshot; now copy it out.
17300 if (copyout(buf
->dtb_xamot
, (user_addr_t
)desc
.dtbd_data
,
17301 buf
->dtb_xamot_offset
) != 0) {
17302 lck_mtx_unlock(&dtrace_lock
);
17306 desc
.dtbd_size
= buf
->dtb_xamot_offset
;
17307 desc
.dtbd_drops
= buf
->dtb_xamot_drops
;
17308 desc
.dtbd_errors
= buf
->dtb_xamot_errors
;
17309 desc
.dtbd_oldest
= 0;
17310 desc
.dtbd_timestamp
= buf
->dtb_switched
;
17312 lck_mtx_unlock(&dtrace_lock
);
17315 * Finally, copy out the buffer description.
17317 if (copyout(&desc
, arg
, sizeof (desc
)) != 0)
17323 case DTRACEIOC_CONF
: {
17324 dtrace_conf_t conf
;
17326 bzero(&conf
, sizeof (conf
));
17327 conf
.dtc_difversion
= DIF_VERSION
;
17328 conf
.dtc_difintregs
= DIF_DIR_NREGS
;
17329 conf
.dtc_diftupregs
= DIF_DTR_NREGS
;
17330 conf
.dtc_ctfmodel
= CTF_MODEL_NATIVE
;
17332 if (copyout(&conf
, arg
, sizeof (conf
)) != 0)
17338 case DTRACEIOC_STATUS
: {
17339 dtrace_status_t stat
;
17340 dtrace_dstate_t
*dstate
;
17345 * See the comment in dtrace_state_deadman() for the reason
17346 * for setting dts_laststatus to INT64_MAX before setting
17347 * it to the correct value.
17349 state
->dts_laststatus
= INT64_MAX
;
17350 dtrace_membar_producer();
17351 state
->dts_laststatus
= dtrace_gethrtime();
17353 bzero(&stat
, sizeof (stat
));
17355 lck_mtx_lock(&dtrace_lock
);
17357 if (state
->dts_activity
== DTRACE_ACTIVITY_INACTIVE
) {
17358 lck_mtx_unlock(&dtrace_lock
);
17362 if (state
->dts_activity
== DTRACE_ACTIVITY_DRAINING
)
17363 stat
.dtst_exiting
= 1;
17365 nerrs
= state
->dts_errors
;
17366 dstate
= &state
->dts_vstate
.dtvs_dynvars
;
17368 for (i
= 0; i
< (int)NCPU
; i
++) {
17369 dtrace_dstate_percpu_t
*dcpu
= &dstate
->dtds_percpu
[i
];
17371 stat
.dtst_dyndrops
+= dcpu
->dtdsc_drops
;
17372 stat
.dtst_dyndrops_dirty
+= dcpu
->dtdsc_dirty_drops
;
17373 stat
.dtst_dyndrops_rinsing
+= dcpu
->dtdsc_rinsing_drops
;
17375 if (state
->dts_buffer
[i
].dtb_flags
& DTRACEBUF_FULL
)
17376 stat
.dtst_filled
++;
17378 nerrs
+= state
->dts_buffer
[i
].dtb_errors
;
17380 for (j
= 0; j
< state
->dts_nspeculations
; j
++) {
17381 dtrace_speculation_t
*spec
;
17382 dtrace_buffer_t
*buf
;
17384 spec
= &state
->dts_speculations
[j
];
17385 buf
= &spec
->dtsp_buffer
[i
];
17386 stat
.dtst_specdrops
+= buf
->dtb_xamot_drops
;
17390 stat
.dtst_specdrops_busy
= state
->dts_speculations_busy
;
17391 stat
.dtst_specdrops_unavail
= state
->dts_speculations_unavail
;
17392 stat
.dtst_stkstroverflows
= state
->dts_stkstroverflows
;
17393 stat
.dtst_dblerrors
= state
->dts_dblerrors
;
17395 (state
->dts_activity
== DTRACE_ACTIVITY_KILLED
);
17396 stat
.dtst_errors
= nerrs
;
17398 lck_mtx_unlock(&dtrace_lock
);
17400 if (copyout(&stat
, arg
, sizeof (stat
)) != 0)
17406 case DTRACEIOC_FORMAT
: {
17407 dtrace_fmtdesc_t fmt
;
17411 if (copyin(arg
, &fmt
, sizeof (fmt
)) != 0)
17414 lck_mtx_lock(&dtrace_lock
);
17416 if (fmt
.dtfd_format
== 0 ||
17417 fmt
.dtfd_format
> state
->dts_nformats
) {
17418 lck_mtx_unlock(&dtrace_lock
);
17423 * Format strings are allocated contiguously and they are
17424 * never freed; if a format index is less than the number
17425 * of formats, we can assert that the format map is non-NULL
17426 * and that the format for the specified index is non-NULL.
17428 ASSERT(state
->dts_formats
!= NULL
);
17429 str
= state
->dts_formats
[fmt
.dtfd_format
- 1];
17430 ASSERT(str
!= NULL
);
17432 len
= strlen(str
) + 1;
17434 if (len
> fmt
.dtfd_length
) {
17435 fmt
.dtfd_length
= len
;
17437 if (copyout(&fmt
, arg
, sizeof (fmt
)) != 0) {
17438 lck_mtx_unlock(&dtrace_lock
);
17442 if (copyout(str
, (user_addr_t
)fmt
.dtfd_string
, len
) != 0) {
17443 lck_mtx_unlock(&dtrace_lock
);
17448 lck_mtx_unlock(&dtrace_lock
);
17452 case DTRACEIOC_MODUUIDSLIST
: {
17453 size_t module_uuids_list_size
;
17454 dtrace_module_uuids_list_t
* uuids_list
;
17455 uint64_t dtmul_count
;
17458 * Security restrictions make this operation illegal, if this is enabled DTrace
17459 * must refuse to provide any fbt probes.
17461 if (dtrace_fbt_probes_restricted()) {
17462 cmn_err(CE_WARN
, "security restrictions disallow DTRACEIOC_MODUUIDSLIST");
17467 * Fail if the kernel symbol mode makes this operation illegal.
17468 * Both NEVER & ALWAYS_FROM_KERNEL are permanent states, it is legal to check
17469 * for them without holding the dtrace_lock.
17471 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_NEVER
||
17472 dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_ALWAYS_FROM_KERNEL
) {
17473 cmn_err(CE_WARN
, "dtrace_kernel_symbol_mode of %u disallows DTRACEIOC_MODUUIDSLIST", dtrace_kernel_symbol_mode
);
17478 * Read the number of symbolsdesc structs being passed in.
17480 if (copyin(arg
+ offsetof(dtrace_module_uuids_list_t
, dtmul_count
),
17482 sizeof(dtmul_count
))) {
17483 cmn_err(CE_WARN
, "failed to copyin dtmul_count");
17488 * Range check the count. More than 2k kexts is probably an error.
17490 if (dtmul_count
> 2048) {
17491 cmn_err(CE_WARN
, "dtmul_count is not valid");
17496 * For all queries, we return EINVAL when the user specified
17497 * count does not match the actual number of modules we find
17500 * If the user specified count is zero, then this serves as a
17501 * simple query to count the available modules in need of symbols.
17506 if (dtmul_count
== 0)
17508 lck_mtx_lock(&mod_lock
);
17509 struct modctl
* ctl
= dtrace_modctl_list
;
17511 /* Update the private probes bit */
17512 if (dtrace_provide_private_probes
)
17513 ctl
->mod_flags
|= MODCTL_FBT_PROVIDE_PRIVATE_PROBES
;
17515 ASSERT(!MOD_HAS_USERSPACE_SYMBOLS(ctl
));
17516 if (!MOD_SYMBOLS_DONE(ctl
)) {
17520 ctl
= ctl
->mod_next
;
17522 lck_mtx_unlock(&mod_lock
);
17524 if (copyout(&dtmul_count
, arg
, sizeof (dtmul_count
)) != 0)
17531 * If we reach this point, then we have a request for full list data.
17532 * Allocate a correctly sized structure and copyin the data.
17534 module_uuids_list_size
= DTRACE_MODULE_UUIDS_LIST_SIZE(dtmul_count
);
17535 if ((uuids_list
= kmem_alloc(module_uuids_list_size
, KM_SLEEP
)) == NULL
)
17538 /* NOTE! We can no longer exit this method via return */
17539 if (copyin(arg
, uuids_list
, module_uuids_list_size
) != 0) {
17540 cmn_err(CE_WARN
, "failed copyin of dtrace_module_uuids_list_t");
17542 goto moduuidslist_cleanup
;
17546 * Check that the count didn't change between the first copyin and the second.
17548 if (uuids_list
->dtmul_count
!= dtmul_count
) {
17550 goto moduuidslist_cleanup
;
17554 * Build the list of UUID's that need symbols
17556 lck_mtx_lock(&mod_lock
);
17560 struct modctl
* ctl
= dtrace_modctl_list
;
17562 /* Update the private probes bit */
17563 if (dtrace_provide_private_probes
)
17564 ctl
->mod_flags
|= MODCTL_FBT_PROVIDE_PRIVATE_PROBES
;
17567 * We assume that userspace symbols will be "better" than kernel level symbols,
17568 * as userspace can search for dSYM(s) and symbol'd binaries. Even if kernel syms
17569 * are available, add user syms if the module might use them.
17571 ASSERT(!MOD_HAS_USERSPACE_SYMBOLS(ctl
));
17572 if (!MOD_SYMBOLS_DONE(ctl
)) {
17573 UUID
* uuid
= &uuids_list
->dtmul_uuid
[dtmul_count
];
17574 if (dtmul_count
++ < uuids_list
->dtmul_count
) {
17575 memcpy(uuid
, ctl
->mod_uuid
, sizeof(UUID
));
17578 ctl
= ctl
->mod_next
;
17581 lck_mtx_unlock(&mod_lock
);
17583 if (uuids_list
->dtmul_count
< dtmul_count
)
17586 uuids_list
->dtmul_count
= dtmul_count
;
17589 * Copyout the symbols list (or at least the count!)
17591 if (copyout(uuids_list
, arg
, module_uuids_list_size
) != 0) {
17592 cmn_err(CE_WARN
, "failed copyout of dtrace_symbolsdesc_list_t");
17596 moduuidslist_cleanup
:
17598 * If we had to allocate struct memory, free it.
17600 if (uuids_list
!= NULL
) {
17601 kmem_free(uuids_list
, module_uuids_list_size
);
17607 case DTRACEIOC_PROVMODSYMS
: {
17608 size_t module_symbols_size
;
17609 dtrace_module_symbols_t
* module_symbols
;
17610 uint64_t dtmodsyms_count
;
17613 * Security restrictions make this operation illegal, if this is enabled DTrace
17614 * must refuse to provide any fbt probes.
17616 if (dtrace_fbt_probes_restricted()) {
17617 cmn_err(CE_WARN
, "security restrictions disallow DTRACEIOC_MODUUIDSLIST");
17622 * Fail if the kernel symbol mode makes this operation illegal.
17623 * Both NEVER & ALWAYS_FROM_KERNEL are permanent states, it is legal to check
17624 * for them without holding the dtrace_lock.
17626 if (dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_NEVER
||
17627 dtrace_kernel_symbol_mode
== DTRACE_KERNEL_SYMBOLS_ALWAYS_FROM_KERNEL
) {
17628 cmn_err(CE_WARN
, "dtrace_kernel_symbol_mode of %u disallows DTRACEIOC_PROVMODSYMS", dtrace_kernel_symbol_mode
);
17633 * Read the number of module symbols structs being passed in.
17635 if (copyin(arg
+ offsetof(dtrace_module_symbols_t
, dtmodsyms_count
),
17637 sizeof(dtmodsyms_count
))) {
17638 cmn_err(CE_WARN
, "failed to copyin dtmodsyms_count");
17643 * Range check the count. How much data can we pass around?
17646 if (dtmodsyms_count
== 0 || (dtmodsyms_count
> 100 * 1024)) {
17647 cmn_err(CE_WARN
, "dtmodsyms_count is not valid");
17652 * Allocate a correctly sized structure and copyin the data.
17654 module_symbols_size
= DTRACE_MODULE_SYMBOLS_SIZE(dtmodsyms_count
);
17655 if ((module_symbols
= kmem_alloc(module_symbols_size
, KM_SLEEP
)) == NULL
)
17660 /* NOTE! We can no longer exit this method via return */
17661 if (copyin(arg
, module_symbols
, module_symbols_size
) != 0) {
17662 cmn_err(CE_WARN
, "failed copyin of dtrace_module_symbols_t");
17664 goto module_symbols_cleanup
;
17668 * Check that the count didn't change between the first copyin and the second.
17670 if (module_symbols
->dtmodsyms_count
!= dtmodsyms_count
) {
17672 goto module_symbols_cleanup
;
17676 * Find the modctl to add symbols to.
17678 lck_mtx_lock(&dtrace_provider_lock
);
17679 lck_mtx_lock(&mod_lock
);
17681 struct modctl
* ctl
= dtrace_modctl_list
;
17683 /* Update the private probes bit */
17684 if (dtrace_provide_private_probes
)
17685 ctl
->mod_flags
|= MODCTL_FBT_PROVIDE_PRIVATE_PROBES
;
17687 ASSERT(!MOD_HAS_USERSPACE_SYMBOLS(ctl
));
17688 if (MOD_HAS_UUID(ctl
) && !MOD_SYMBOLS_DONE(ctl
)) {
17689 if (memcmp(module_symbols
->dtmodsyms_uuid
, ctl
->mod_uuid
, sizeof(UUID
)) == 0) {
17691 ctl
->mod_user_symbols
= module_symbols
;
17695 ctl
= ctl
->mod_next
;
17699 dtrace_provider_t
*prv
;
17702 * We're going to call each providers per-module provide operation
17703 * specifying only this module.
17705 for (prv
= dtrace_provider
; prv
!= NULL
; prv
= prv
->dtpv_next
)
17706 prv
->dtpv_pops
.dtps_provide_module(prv
->dtpv_arg
, ctl
);
17709 * We gave every provider a chance to provide with the user syms, go ahead and clear them
17711 ctl
->mod_user_symbols
= NULL
; /* MUST reset this to clear HAS_USERSPACE_SYMBOLS */
17714 lck_mtx_unlock(&mod_lock
);
17715 lck_mtx_unlock(&dtrace_provider_lock
);
17717 module_symbols_cleanup
:
17719 * If we had to allocate struct memory, free it.
17721 if (module_symbols
!= NULL
) {
17722 kmem_free(module_symbols
, module_symbols_size
);
17728 case DTRACEIOC_PROCWAITFOR
: {
17729 dtrace_procdesc_t pdesc
= {
17734 if ((rval
= copyin(arg
, &pdesc
, sizeof(pdesc
))) != 0)
17735 goto proc_waitfor_error
;
17737 if ((rval
= dtrace_proc_waitfor(&pdesc
)) != 0)
17738 goto proc_waitfor_error
;
17740 if ((rval
= copyout(&pdesc
, arg
, sizeof(pdesc
))) != 0)
17741 goto proc_waitfor_error
;
17745 proc_waitfor_error
:
17746 /* The process was suspended, revert this since the client will not do it. */
17747 if (pdesc
.p_pid
!= -1) {
17748 proc_t
*proc
= proc_find(pdesc
.p_pid
);
17749 if (proc
!= PROC_NULL
) {
17750 task_pidresume(proc
->task
);
17766 * APPLE NOTE: dtrace_detach not implemented
17768 #if !defined(__APPLE__)
17771 dtrace_detach(dev_info_t
*dip
, ddi_detach_cmd_t cmd
)
17773 dtrace_state_t
*state
;
17780 return (DDI_SUCCESS
);
17783 return (DDI_FAILURE
);
17786 lck_mtx_lock(&cpu_lock
);
17787 lck_mtx_lock(&dtrace_provider_lock
);
17788 lck_mtx_lock(&dtrace_lock
);
17790 ASSERT(dtrace_opens
== 0);
17792 if (dtrace_helpers
> 0) {
17793 lck_mtx_unlock(&dtrace_lock
);
17794 lck_mtx_unlock(&dtrace_provider_lock
);
17795 lck_mtx_unlock(&cpu_lock
);
17796 return (DDI_FAILURE
);
17799 if (dtrace_unregister((dtrace_provider_id_t
)dtrace_provider
) != 0) {
17800 lck_mtx_unlock(&dtrace_lock
);
17801 lck_mtx_unlock(&dtrace_provider_lock
);
17802 lck_mtx_unlock(&cpu_lock
);
17803 return (DDI_FAILURE
);
17806 dtrace_provider
= NULL
;
17808 if ((state
= dtrace_anon_grab()) != NULL
) {
17810 * If there were ECBs on this state, the provider should
17811 * have not been allowed to detach; assert that there is
17814 ASSERT(state
->dts_necbs
== 0);
17815 dtrace_state_destroy(state
);
17818 * If we're being detached with anonymous state, we need to
17819 * indicate to the kernel debugger that DTrace is now inactive.
17821 (void) kdi_dtrace_set(KDI_DTSET_DTRACE_DEACTIVATE
);
17824 bzero(&dtrace_anon
, sizeof (dtrace_anon_t
));
17825 unregister_cpu_setup_func((cpu_setup_func_t
*)dtrace_cpu_setup
, NULL
);
17826 dtrace_cpu_init
= NULL
;
17827 dtrace_helpers_cleanup
= NULL
;
17828 dtrace_helpers_fork
= NULL
;
17829 dtrace_cpustart_init
= NULL
;
17830 dtrace_cpustart_fini
= NULL
;
17831 dtrace_debugger_init
= NULL
;
17832 dtrace_debugger_fini
= NULL
;
17833 dtrace_kreloc_init
= NULL
;
17834 dtrace_kreloc_fini
= NULL
;
17835 dtrace_modload
= NULL
;
17836 dtrace_modunload
= NULL
;
17838 lck_mtx_unlock(&cpu_lock
);
17840 if (dtrace_helptrace_enabled
) {
17841 kmem_free(dtrace_helptrace_buffer
, dtrace_helptrace_bufsize
);
17842 dtrace_helptrace_buffer
= NULL
;
17845 kmem_free(dtrace_probes
, dtrace_nprobes
* sizeof (dtrace_probe_t
*));
17846 dtrace_probes
= NULL
;
17847 dtrace_nprobes
= 0;
17849 dtrace_hash_destroy(dtrace_bymod
);
17850 dtrace_hash_destroy(dtrace_byfunc
);
17851 dtrace_hash_destroy(dtrace_byname
);
17852 dtrace_bymod
= NULL
;
17853 dtrace_byfunc
= NULL
;
17854 dtrace_byname
= NULL
;
17856 kmem_cache_destroy(dtrace_state_cache
);
17857 vmem_destroy(dtrace_arena
);
17859 if (dtrace_toxrange
!= NULL
) {
17860 kmem_free(dtrace_toxrange
,
17861 dtrace_toxranges_max
* sizeof (dtrace_toxrange_t
));
17862 dtrace_toxrange
= NULL
;
17863 dtrace_toxranges
= 0;
17864 dtrace_toxranges_max
= 0;
17867 ddi_remove_minor_node(dtrace_devi
, NULL
);
17868 dtrace_devi
= NULL
;
17870 ddi_soft_state_fini(&dtrace_softstate
);
17872 ASSERT(dtrace_vtime_references
== 0);
17873 ASSERT(dtrace_opens
== 0);
17874 ASSERT(dtrace_retained
== NULL
);
17876 lck_mtx_unlock(&dtrace_lock
);
17877 lck_mtx_unlock(&dtrace_provider_lock
);
17880 * We don't destroy the task queue until after we have dropped our
17881 * locks (taskq_destroy() may block on running tasks). To prevent
17882 * attempting to do work after we have effectively detached but before
17883 * the task queue has been destroyed, all tasks dispatched via the
17884 * task queue must check that DTrace is still attached before
17885 * performing any operation.
17887 taskq_destroy(dtrace_taskq
);
17888 dtrace_taskq
= NULL
;
17890 return (DDI_SUCCESS
);
17892 #endif /* __APPLE__ */
17894 d_open_t _dtrace_open
, helper_open
;
17895 d_close_t _dtrace_close
, helper_close
;
17896 d_ioctl_t _dtrace_ioctl
, helper_ioctl
;
17899 _dtrace_open(dev_t dev
, int flags
, int devtype
, struct proc
*p
)
17902 dev_t locdev
= dev
;
17904 return dtrace_open( &locdev
, flags
, devtype
, CRED());
17908 helper_open(dev_t dev
, int flags
, int devtype
, struct proc
*p
)
17910 #pragma unused(dev,flags,devtype,p)
17915 _dtrace_close(dev_t dev
, int flags
, int devtype
, struct proc
*p
)
17918 return dtrace_close( dev
, flags
, devtype
, CRED());
17922 helper_close(dev_t dev
, int flags
, int devtype
, struct proc
*p
)
17924 #pragma unused(dev,flags,devtype,p)
17929 _dtrace_ioctl(dev_t dev
, u_long cmd
, caddr_t data
, int fflag
, struct proc
*p
)
17933 user_addr_t uaddrp
;
17935 if (proc_is64bit(p
))
17936 uaddrp
= *(user_addr_t
*)data
;
17938 uaddrp
= (user_addr_t
) *(uint32_t *)data
;
17940 err
= dtrace_ioctl(dev
, cmd
, uaddrp
, fflag
, CRED(), &rv
);
17942 /* Darwin's BSD ioctls only return -1 or zero. Overload errno to mimic Solaris. 20 bits suffice. */
17944 ASSERT( (err
& 0xfffff000) == 0 );
17945 return (err
& 0xfff); /* ioctl will return -1 and will set errno to an error code < 4096 */
17946 } else if (rv
!= 0) {
17947 ASSERT( (rv
& 0xfff00000) == 0 );
17948 return (((rv
& 0xfffff) << 12)); /* ioctl will return -1 and will set errno to a value >= 4096 */
17954 helper_ioctl(dev_t dev
, u_long cmd
, caddr_t data
, int fflag
, struct proc
*p
)
17956 #pragma unused(dev,fflag,p)
17959 err
= dtrace_ioctl_helper(cmd
, data
, &rv
);
17960 /* Darwin's BSD ioctls only return -1 or zero. Overload errno to mimic Solaris. 20 bits suffice. */
17962 ASSERT( (err
& 0xfffff000) == 0 );
17963 return (err
& 0xfff); /* ioctl will return -1 and will set errno to an error code < 4096 */
17964 } else if (rv
!= 0) {
17965 ASSERT( (rv
& 0xfff00000) == 0 );
17966 return (((rv
& 0xfffff) << 12)); /* ioctl will return -1 and will set errno to a value >= 4096 */
17971 #define HELPER_MAJOR -24 /* let the kernel pick the device number */
17974 * A struct describing which functions will get invoked for certain
17977 static struct cdevsw helper_cdevsw
=
17979 helper_open
, /* open */
17980 helper_close
, /* close */
17981 eno_rdwrt
, /* read */
17982 eno_rdwrt
, /* write */
17983 helper_ioctl
, /* ioctl */
17984 (stop_fcn_t
*)nulldev
, /* stop */
17985 (reset_fcn_t
*)nulldev
, /* reset */
17987 eno_select
, /* select */
17988 eno_mmap
, /* mmap */
17989 eno_strat
, /* strategy */
17990 eno_getc
, /* getc */
17991 eno_putc
, /* putc */
17995 static int helper_majdevno
= 0;
17997 static int gDTraceInited
= 0;
18000 helper_init( void )
18003 * Once the "helper" is initialized, it can take ioctl calls that use locks
18004 * and zones initialized in dtrace_init. Make certain dtrace_init was called
18008 if (!gDTraceInited
) {
18009 panic("helper_init before dtrace_init\n");
18012 if (0 >= helper_majdevno
)
18014 helper_majdevno
= cdevsw_add(HELPER_MAJOR
, &helper_cdevsw
);
18016 if (helper_majdevno
< 0) {
18017 printf("helper_init: failed to allocate a major number!\n");
18021 if (NULL
== devfs_make_node( makedev(helper_majdevno
, 0), DEVFS_CHAR
, UID_ROOT
, GID_WHEEL
, 0666,
18022 DTRACEMNR_HELPER
, 0 )) {
18023 printf("dtrace_init: failed to devfs_make_node for helper!\n");
18027 panic("helper_init: called twice!\n");
18030 #undef HELPER_MAJOR
18033 dtrace_clone_func(dev_t dev
, int action
)
18035 #pragma unused(dev)
18037 if (action
== DEVFS_CLONE_ALLOC
) {
18038 return dtrace_state_reserve();
18040 else if (action
== DEVFS_CLONE_FREE
) {
18046 void dtrace_ast(void);
18052 uint32_t clients
= atomic_and_32(&dtrace_wake_clients
, 0);
18056 * We disable preemption here to be sure that we won't get
18057 * interrupted by a wakeup to a thread that is higher
18058 * priority than us, so that we do issue all wakeups
18060 disable_preemption();
18061 for (i
= 0; i
< DTRACE_NCLIENTS
; i
++) {
18062 if (clients
& (1 << i
)) {
18063 dtrace_state_t
*state
= dtrace_state_get(i
);
18070 enable_preemption();
18074 #define DTRACE_MAJOR -24 /* let the kernel pick the device number */
18076 static struct cdevsw dtrace_cdevsw
=
18078 _dtrace_open
, /* open */
18079 _dtrace_close
, /* close */
18080 eno_rdwrt
, /* read */
18081 eno_rdwrt
, /* write */
18082 _dtrace_ioctl
, /* ioctl */
18083 (stop_fcn_t
*)nulldev
, /* stop */
18084 (reset_fcn_t
*)nulldev
, /* reset */
18086 eno_select
, /* select */
18087 eno_mmap
, /* mmap */
18088 eno_strat
, /* strategy */
18089 eno_getc
, /* getc */
18090 eno_putc
, /* putc */
18094 lck_attr_t
* dtrace_lck_attr
;
18095 lck_grp_attr_t
* dtrace_lck_grp_attr
;
18096 lck_grp_t
* dtrace_lck_grp
;
18098 static int gMajDevNo
;
18101 dtrace_init( void )
18103 if (0 == gDTraceInited
) {
18105 size_t size
= sizeof(dtrace_buffer_memory_maxsize
);
18108 * DTrace allocates buffers based on the maximum number
18109 * of enabled cpus. This call avoids any race when finding
18112 ASSERT(dtrace_max_cpus
== 0);
18113 ncpu
= dtrace_max_cpus
= ml_get_max_cpus();
18116 * Retrieve the size of the physical memory in order to define
18117 * the state buffer memory maximal size. If we cannot retrieve
18118 * this value, we'll consider that we have 1Gb of memory per CPU, that's
18119 * still better than raising a kernel panic.
18121 if (0 != kernel_sysctlbyname("hw.memsize", &dtrace_buffer_memory_maxsize
,
18124 dtrace_buffer_memory_maxsize
= ncpu
* 1024 * 1024 * 1024;
18125 printf("dtrace_init: failed to retrieve the hw.memsize, defaulted to %lld bytes\n",
18126 dtrace_buffer_memory_maxsize
);
18130 * Finally, divide by three to prevent DTrace from eating too
18133 dtrace_buffer_memory_maxsize
/= 3;
18134 ASSERT(dtrace_buffer_memory_maxsize
> 0);
18136 gMajDevNo
= cdevsw_add(DTRACE_MAJOR
, &dtrace_cdevsw
);
18138 if (gMajDevNo
< 0) {
18139 printf("dtrace_init: failed to allocate a major number!\n");
18144 if (NULL
== devfs_make_node_clone( makedev(gMajDevNo
, 0), DEVFS_CHAR
, UID_ROOT
, GID_WHEEL
, 0666,
18145 dtrace_clone_func
, DTRACEMNR_DTRACE
, 0 )) {
18146 printf("dtrace_init: failed to devfs_make_node_clone for dtrace!\n");
18151 #if defined(DTRACE_MEMORY_ZONES)
18153 * Initialize the dtrace kalloc-emulation zones.
18155 dtrace_alloc_init();
18156 #endif /* DTRACE_MEMORY_ZONES */
18159 * Allocate the dtrace_probe_t zone
18161 dtrace_probe_t_zone
= zinit(sizeof(dtrace_probe_t
),
18162 1024 * sizeof(dtrace_probe_t
),
18163 sizeof(dtrace_probe_t
),
18164 "dtrace.dtrace_probe_t");
18167 * Create the dtrace lock group and attrs.
18169 dtrace_lck_attr
= lck_attr_alloc_init();
18170 dtrace_lck_grp_attr
= lck_grp_attr_alloc_init();
18171 dtrace_lck_grp
= lck_grp_alloc_init("dtrace", dtrace_lck_grp_attr
);
18174 * We have to initialize all locks explicitly
18176 lck_mtx_init(&dtrace_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18177 lck_mtx_init(&dtrace_provider_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18178 lck_mtx_init(&dtrace_meta_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18179 lck_mtx_init(&dtrace_procwaitfor_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18181 lck_mtx_init(&dtrace_errlock
, dtrace_lck_grp
, dtrace_lck_attr
);
18183 lck_rw_init(&dtrace_dof_mode_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18186 * The cpu_core structure consists of per-CPU state available in any context.
18187 * On some architectures, this may mean that the page(s) containing the
18188 * NCPU-sized array of cpu_core structures must be locked in the TLB -- it
18189 * is up to the platform to assure that this is performed properly. Note that
18190 * the structure is sized to avoid false sharing.
18192 lck_mtx_init(&cpu_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18193 lck_mtx_init(&cyc_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18194 lck_mtx_init(&mod_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18197 * Initialize the CPU offline/online hooks.
18199 dtrace_install_cpu_hooks();
18201 dtrace_modctl_list
= NULL
;
18203 cpu_core
= (cpu_core_t
*)kmem_zalloc( ncpu
* sizeof(cpu_core_t
), KM_SLEEP
);
18204 for (i
= 0; i
< ncpu
; ++i
) {
18205 lck_mtx_init(&cpu_core
[i
].cpuc_pid_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18208 cpu_list
= (dtrace_cpu_t
*)kmem_zalloc( ncpu
* sizeof(dtrace_cpu_t
), KM_SLEEP
);
18209 for (i
= 0; i
< ncpu
; ++i
) {
18210 cpu_list
[i
].cpu_id
= (processorid_t
)i
;
18211 cpu_list
[i
].cpu_next
= &(cpu_list
[(i
+1) % ncpu
]);
18212 LIST_INIT(&cpu_list
[i
].cpu_cyc_list
);
18213 lck_rw_init(&cpu_list
[i
].cpu_ft_lock
, dtrace_lck_grp
, dtrace_lck_attr
);
18216 lck_mtx_lock(&cpu_lock
);
18217 for (i
= 0; i
< ncpu
; ++i
)
18218 /* FIXME: track CPU configuration */
18219 dtrace_cpu_setup_initial( (processorid_t
)i
); /* In lieu of register_cpu_setup_func() callback */
18220 lck_mtx_unlock(&cpu_lock
);
18222 (void)dtrace_abs_to_nano(0LL); /* Force once only call to clock_timebase_info (which can take a lock) */
18226 * See dtrace_impl.h for a description of dof modes.
18227 * The default is lazy dof.
18229 * FIXME: Warn if state is LAZY_OFF? It won't break anything, but
18230 * makes no sense...
18232 if (!PE_parse_boot_argn("dtrace_dof_mode", &dtrace_dof_mode
, sizeof (dtrace_dof_mode
))) {
18233 dtrace_dof_mode
= DTRACE_DOF_MODE_LAZY_ON
;
18237 * Sanity check of dof mode value.
18239 switch (dtrace_dof_mode
) {
18240 case DTRACE_DOF_MODE_NEVER
:
18241 case DTRACE_DOF_MODE_LAZY_ON
:
18242 /* valid modes, but nothing else we need to do */
18245 case DTRACE_DOF_MODE_LAZY_OFF
:
18246 case DTRACE_DOF_MODE_NON_LAZY
:
18247 /* Cannot wait for a dtrace_open to init fasttrap */
18252 /* Invalid, clamp to non lazy */
18253 dtrace_dof_mode
= DTRACE_DOF_MODE_NON_LAZY
;
18259 * See dtrace_impl.h for a description of kernel symbol modes.
18260 * The default is to wait for symbols from userspace (lazy symbols).
18262 if (!PE_parse_boot_argn("dtrace_kernel_symbol_mode", &dtrace_kernel_symbol_mode
, sizeof (dtrace_kernel_symbol_mode
))) {
18263 dtrace_kernel_symbol_mode
= DTRACE_KERNEL_SYMBOLS_FROM_USERSPACE
;
18266 dtrace_restriction_policy_load();
18271 panic("dtrace_init: called twice!\n");
18275 dtrace_postinit(void)
18278 * Called from bsd_init after all provider's *_init() routines have been
18279 * run. That way, anonymous DOF enabled under dtrace_attach() is safe
18282 dtrace_attach( (dev_info_t
*)(uintptr_t)makedev(gMajDevNo
, 0), 0 ); /* Punning a dev_t to a dev_info_t* */
18285 * Add the mach_kernel to the module list for lazy processing
18287 struct kmod_info fake_kernel_kmod
;
18288 memset(&fake_kernel_kmod
, 0, sizeof(fake_kernel_kmod
));
18290 strlcpy(fake_kernel_kmod
.name
, "mach_kernel", sizeof(fake_kernel_kmod
.name
));
18291 fake_kernel_kmod
.id
= 1;
18292 fake_kernel_kmod
.address
= g_kernel_kmod_info
.address
;
18293 fake_kernel_kmod
.size
= g_kernel_kmod_info
.size
;
18295 if (dtrace_module_loaded(&fake_kernel_kmod
, 0) != 0) {
18296 printf("dtrace_postinit: Could not register mach_kernel modctl\n");
18299 (void)OSKextRegisterKextsWithDTrace();
18301 #undef DTRACE_MAJOR
18304 * Routines used to register interest in cpu's being added to or removed
18308 register_cpu_setup_func(cpu_setup_func_t
*ignore1
, void *ignore2
)
18310 #pragma unused(ignore1,ignore2)
18314 unregister_cpu_setup_func(cpu_setup_func_t
*ignore1
, void *ignore2
)
18316 #pragma unused(ignore1,ignore2)