2 * Copyright (c) 2010-2013 Apple Inc. All rights reserved.
4 * @APPLE_APACHE_LICENSE_HEADER_START@
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * @APPLE_APACHE_LICENSE_HEADER_END@
22 * IMPORTANT: This header file describes INTERNAL interfaces to libdispatch
23 * which are subject to change in future releases of Mac OS X. Any applications
24 * relying on these interfaces WILL break.
27 #ifndef __DISPATCH_TRACE__
28 #define __DISPATCH_TRACE__
30 #if DISPATCH_USE_DTRACE && !__OBJC2__
32 typedef struct dispatch_trace_timer_params_s
{
33 int64_t deadline
, interval
, leeway
;
34 } *dispatch_trace_timer_params_t
;
38 #if DISPATCH_USE_DTRACE_INTROSPECTION
40 #define _dispatch_trace_callout(_c, _f, _dcc) do { \
41 if (slowpath(DISPATCH_CALLOUT_ENTRY_ENABLED()) || \
42 slowpath(DISPATCH_CALLOUT_RETURN_ENABLED())) { \
43 dispatch_queue_t _dq = _dispatch_queue_get_current(); \
44 const char *_label = _dq && _dq->dq_label ? _dq->dq_label : ""; \
45 dispatch_function_t _func = (dispatch_function_t)(_f); \
47 DISPATCH_CALLOUT_ENTRY(_dq, _label, _func, _ctxt); \
49 DISPATCH_CALLOUT_RETURN(_dq, _label, _func, _ctxt); \
55 DISPATCH_ALWAYS_INLINE
57 _dispatch_trace_client_callout(void *ctxt
, dispatch_function_t f
)
59 dispatch_function_t func
= (f
== _dispatch_call_block_and_release
&&
60 ctxt
? _dispatch_Block_invoke(ctxt
) : f
);
61 _dispatch_introspection_callout_entry(ctxt
, func
);
62 _dispatch_trace_callout(ctxt
, func
, _dispatch_client_callout(ctxt
, f
));
63 _dispatch_introspection_callout_return(ctxt
, func
);
66 DISPATCH_ALWAYS_INLINE
68 _dispatch_trace_client_callout2(void *ctxt
, size_t i
, void (*f
)(void *, size_t))
70 dispatch_function_t func
= (dispatch_function_t
)f
;
71 _dispatch_introspection_callout_entry(ctxt
, func
);
72 _dispatch_trace_callout(ctxt
, func
, _dispatch_client_callout2(ctxt
, i
, f
));
73 _dispatch_introspection_callout_return(ctxt
, func
);
77 DISPATCH_ALWAYS_INLINE
79 _dispatch_trace_client_callout_block(dispatch_block_t b
)
81 dispatch_function_t func
= _dispatch_Block_invoke(b
);
82 _dispatch_introspection_callout_entry(b
, func
);
83 _dispatch_trace_callout(b
, func
, _dispatch_client_callout(b
, func
));
84 _dispatch_introspection_callout_return(b
, func
);
88 #define _dispatch_client_callout _dispatch_trace_client_callout
89 #define _dispatch_client_callout2 _dispatch_trace_client_callout2
90 #define _dispatch_client_callout_block _dispatch_trace_client_callout_block
92 #define _dispatch_trace_continuation(_q, _o, _t) do { \
93 dispatch_queue_t _dq = (_q); \
94 const char *_label = _dq && _dq->dq_label ? _dq->dq_label : ""; \
95 struct dispatch_object_s *_do = (_o); \
97 dispatch_function_t _func; \
99 if (DISPATCH_OBJ_IS_VTABLE(_do)) { \
100 _ctxt = _do->do_ctxt; \
101 _kind = (char*)dx_kind(_do); \
102 if ((dx_type(_do) & _DISPATCH_META_TYPE_MASK) == \
103 _DISPATCH_SOURCE_TYPE && (_dq) != &_dispatch_mgr_q) { \
104 _func = ((dispatch_source_t)_do)->ds_refs->ds_handler_func; \
106 _func = (dispatch_function_t)_dispatch_queue_invoke; \
109 struct dispatch_continuation_s *_dc = (void*)(_do); \
110 _ctxt = _dc->dc_ctxt; \
111 if ((long)_dc->do_vtable & DISPATCH_OBJ_SYNC_SLOW_BIT) { \
112 _kind = "semaphore"; \
113 _func = (dispatch_function_t)dispatch_semaphore_signal; \
114 } else if (_dc->dc_func == _dispatch_call_block_and_release) { \
116 _func = _dispatch_Block_invoke(_dc->dc_ctxt); \
118 _kind = "function"; \
119 _func = _dc->dc_func; \
122 _t(_dq, _label, _do, _kind, _func, _ctxt); \
125 DISPATCH_ALWAYS_INLINE
127 _dispatch_trace_queue_push_list(dispatch_queue_t dq
, dispatch_object_t _head
,
128 dispatch_object_t _tail
, unsigned int n
)
130 if (slowpath(DISPATCH_QUEUE_PUSH_ENABLED())) {
131 struct dispatch_object_s
*dou
= _head
._do
;
133 _dispatch_trace_continuation(dq
, dou
, DISPATCH_QUEUE_PUSH
);
134 } while (dou
!= _tail
._do
&& (dou
= dou
->do_next
));
136 _dispatch_introspection_queue_push_list(dq
, _head
, _tail
);
137 _dispatch_queue_push_list(dq
, _head
, _tail
, n
);
140 DISPATCH_ALWAYS_INLINE
142 _dispatch_trace_queue_push(dispatch_queue_t dq
, dispatch_object_t _tail
)
144 if (slowpath(DISPATCH_QUEUE_PUSH_ENABLED())) {
145 struct dispatch_object_s
*dou
= _tail
._do
;
146 _dispatch_trace_continuation(dq
, dou
, DISPATCH_QUEUE_PUSH
);
148 _dispatch_introspection_queue_push(dq
, _tail
);
149 _dispatch_queue_push(dq
, _tail
);
152 DISPATCH_ALWAYS_INLINE
154 _dispatch_trace_queue_push_wakeup(dispatch_queue_t dq
, dispatch_object_t _tail
,
157 if (slowpath(DISPATCH_QUEUE_PUSH_ENABLED())) {
158 struct dispatch_object_s
*dou
= _tail
._do
;
159 _dispatch_trace_continuation(dq
, dou
, DISPATCH_QUEUE_PUSH
);
161 _dispatch_introspection_queue_push(dq
, _tail
);
162 _dispatch_queue_push_wakeup(dq
, _tail
, wakeup
);
165 DISPATCH_ALWAYS_INLINE
167 _dispatch_queue_push_notrace(dispatch_queue_t dq
, dispatch_object_t dou
)
169 _dispatch_queue_push(dq
, dou
);
172 #define _dispatch_queue_push_list _dispatch_trace_queue_push_list
173 #define _dispatch_queue_push _dispatch_trace_queue_push
174 #define _dispatch_queue_push_wakeup _dispatch_trace_queue_push_wakeup
176 DISPATCH_ALWAYS_INLINE
178 _dispatch_trace_continuation_pop(dispatch_queue_t dq
,
179 dispatch_object_t dou
)
181 if (slowpath(DISPATCH_QUEUE_POP_ENABLED())) {
182 _dispatch_trace_continuation(dq
, dou
._do
, DISPATCH_QUEUE_POP
);
184 _dispatch_introspection_queue_pop(dq
, dou
);
187 #endif // DISPATCH_USE_DTRACE_INTROSPECTION
189 static inline dispatch_function_t
190 _dispatch_trace_timer_function(dispatch_source_t ds
, dispatch_source_refs_t dr
)
192 dispatch_function_t func
= dr
->ds_handler_func
;
193 if (func
== _dispatch_after_timer_callback
&&
194 !(ds
->ds_atomic_flags
& DSF_CANCELED
)) {
195 dispatch_continuation_t dc
= ds
->do_ctxt
;
196 func
= dc
->dc_func
!= _dispatch_call_block_and_release
? dc
->dc_func
:
197 dc
->dc_ctxt
? _dispatch_Block_invoke(dc
->dc_ctxt
) : NULL
;
202 DISPATCH_ALWAYS_INLINE
203 static inline dispatch_trace_timer_params_t
204 _dispatch_trace_timer_params(uintptr_t ident
,
205 struct dispatch_timer_source_s
*values
, uint64_t deadline
,
206 dispatch_trace_timer_params_t params
)
208 #define _dispatch_trace_time2nano3(t) (DISPATCH_TIMER_KIND(ident) \
209 == DISPATCH_TIMER_KIND_MACH ? _dispatch_time_mach2nano(t) : (t))
210 #define _dispatch_trace_time2nano2(v, t) ({ uint64_t _t = (t); \
211 (v) >= INT64_MAX ? -1ll : (int64_t)_dispatch_trace_time2nano3(_t);})
212 #define _dispatch_trace_time2nano(v) ({ uint64_t _t; \
213 _t = _dispatch_trace_time2nano3(v); _t >= INT64_MAX ? -1ll : \
216 params
->deadline
= (int64_t)deadline
;
218 uint64_t now
= (DISPATCH_TIMER_KIND(ident
) ==
219 DISPATCH_TIMER_KIND_MACH
? _dispatch_absolute_time() :
220 _dispatch_get_nanoseconds());
221 params
->deadline
= _dispatch_trace_time2nano2(values
->target
,
222 values
->target
< now
? 0 : values
->target
- now
);
224 params
->interval
= _dispatch_trace_time2nano(values
->interval
);
225 params
->leeway
= _dispatch_trace_time2nano(values
->leeway
);
229 DISPATCH_ALWAYS_INLINE
231 _dispatch_trace_timer_configure_enabled(void)
233 return slowpath(DISPATCH_TIMER_CONFIGURE_ENABLED());
236 DISPATCH_ALWAYS_INLINE
238 _dispatch_trace_timer_configure(dispatch_source_t ds
, uintptr_t ident
,
239 struct dispatch_timer_source_s
*values
)
241 struct dispatch_trace_timer_params_s params
;
242 DISPATCH_TIMER_CONFIGURE(ds
, _dispatch_trace_timer_function(ds
,
243 ds
->ds_refs
), _dispatch_trace_timer_params(ident
, values
, 0,
247 DISPATCH_ALWAYS_INLINE
249 _dispatch_trace_timer_program(dispatch_source_refs_t dr
, uint64_t deadline
)
251 if (slowpath(DISPATCH_TIMER_PROGRAM_ENABLED())) {
252 if (deadline
&& dr
) {
253 dispatch_source_t ds
= _dispatch_source_from_refs(dr
);
254 struct dispatch_trace_timer_params_s params
;
255 DISPATCH_TIMER_PROGRAM(ds
, _dispatch_trace_timer_function(ds
, dr
),
256 _dispatch_trace_timer_params(ds
->ds_ident_hack
,
257 &ds_timer(dr
), deadline
, ¶ms
));
262 DISPATCH_ALWAYS_INLINE
264 _dispatch_trace_timer_wake(dispatch_source_refs_t dr
)
266 if (slowpath(DISPATCH_TIMER_WAKE_ENABLED())) {
268 dispatch_source_t ds
= _dispatch_source_from_refs(dr
);
269 DISPATCH_TIMER_WAKE(ds
, _dispatch_trace_timer_function(ds
, dr
));
274 DISPATCH_ALWAYS_INLINE
276 _dispatch_trace_timer_fire(dispatch_source_refs_t dr
, unsigned long data
,
277 unsigned long missed
)
279 if (slowpath(DISPATCH_TIMER_FIRE_ENABLED())) {
280 if (!(data
- missed
) && dr
) {
281 dispatch_source_t ds
= _dispatch_source_from_refs(dr
);
282 DISPATCH_TIMER_FIRE(ds
, _dispatch_trace_timer_function(ds
, dr
));
289 #define _dispatch_trace_timer_configure_enabled() false
290 #define _dispatch_trace_timer_configure(ds, ident, values) \
291 do { (void)(ds); (void)(ident); (void)(values); } while(0)
292 #define _dispatch_trace_timer_program(dr, deadline) \
293 do { (void)(dr); (void)(deadline); } while(0)
294 #define _dispatch_trace_timer_wake(dr) \
295 do { (void)(dr); } while(0)
296 #define _dispatch_trace_timer_fire(dr, data, missed) \
297 do { (void)(dr); (void)(data); (void)(missed); } while(0)
299 #endif // DISPATCH_USE_DTRACE && !__OBJC2__
301 #if !DISPATCH_USE_DTRACE_INTROSPECTION
303 #define _dispatch_queue_push_notrace _dispatch_queue_push
304 #define _dispatch_trace_continuation_pop(dq, dou) \
305 do { (void)(dq); (void)(dou); } while(0)
307 #endif // !DISPATCH_USE_DTRACE_INTROSPECTION
309 #endif // __DISPATCH_TRACE__