Zephyr Project API  3.2.0
A Scalable Open Source RTOS
tracing_macros.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6#ifndef ZEPHYR_INCLUDE_TRACING_TRACING_MACROS_H_
7#define ZEPHYR_INCLUDE_TRACING_TRACING_MACROS_H_
8
9#if !defined(CONFIG_TRACING) && !defined(__DOXYGEN__)
10
11#define SYS_PORT_TRACING_FUNC(type, func, ...) do { } while (false)
12#define SYS_PORT_TRACING_FUNC_ENTER(type, func, ...) do { } while (false)
13#define SYS_PORT_TRACING_FUNC_BLOCKING(type, func, ...) do { } while (false)
14#define SYS_PORT_TRACING_FUNC_EXIT(type, func, ...) do { } while (false)
15#define SYS_PORT_TRACING_OBJ_INIT(obj_type, obj, ...) do { } while (false)
16#define SYS_PORT_TRACING_OBJ_FUNC(obj_type, func, obj, ...) do { } while (false)
17#define SYS_PORT_TRACING_OBJ_FUNC_ENTER(obj_type, func, obj, ...) do { } while (false)
18#define SYS_PORT_TRACING_OBJ_FUNC_BLOCKING(obj_type, func, obj, ...) do { } while (false)
19#define SYS_PORT_TRACING_OBJ_FUNC_EXIT(obj_type, func, obj, ...) do { } while (false)
20
21#define SYS_PORT_TRACING_TRACKING_FIELD(type)
22
23#else
24
34/*
35 * Helper macros used by the extended tracing system
36 */
37
38#define _SYS_PORT_TRACING_TYPE_MASK(type) \
39 sys_port_trace_type_mask_ ## type
40#define _SYS_PORT_TRACING_FUNC(name, func) \
41 sys_port_trace_ ## name ## _ ## func
42#define _SYS_PORT_TRACING_FUNC_ENTER(name, func) \
43 sys_port_trace_ ## name ## _ ## func ## _enter
44#define _SYS_PORT_TRACING_FUNC_BLOCKING(name, func) \
45 sys_port_trace_ ## name ## _ ## func ## _blocking
46#define _SYS_PORT_TRACING_FUNC_EXIT(name, func) \
47 sys_port_trace_ ## name ## _ ## func ## _exit
48#define _SYS_PORT_TRACING_OBJ_INIT(name) \
49 sys_port_trace_ ## name ## _init
50#define _SYS_PORT_TRACING_OBJ_FUNC(name, func) \
51 sys_port_trace_ ## name ## _ ## func
52#define _SYS_PORT_TRACING_OBJ_FUNC_ENTER(name, func) \
53 sys_port_trace_ ## name ## _ ## func ## _enter
54#define _SYS_PORT_TRACING_OBJ_FUNC_BLOCKING(name, func) \
55 sys_port_trace_ ## name ## _ ## func ## _blocking
56#define _SYS_PORT_TRACING_OBJ_FUNC_EXIT(name, func) \
57 sys_port_trace_ ## name ## _ ## func ## _exit
58
59/*
60 * Helper macros for the object tracking system
61 */
62
63#define _SYS_PORT_TRACKING_OBJ_INIT(name) \
64 sys_port_track_ ## name ## _init
65#define _SYS_PORT_TRACKING_OBJ_FUNC(name, func) \
66 sys_port_track_ ## name ## _ ## func
67
68/*
69 * Object trace macros part of the system for checking if certain
70 * objects should be traced or not depending on the tracing configuration.
71 */
72#if defined(CONFIG_TRACING_THREAD)
73 #define sys_port_trace_type_mask_k_thread(trace_call) trace_call
74#else
75 #define sys_port_trace_type_mask_k_thread(trace_call)
76#endif
77
78#if defined(CONFIG_TRACING_WORK)
79 #define sys_port_trace_type_mask_k_work(trace_call) trace_call
80 #define sys_port_trace_type_mask_k_work_queue(trace_call) trace_call
81 #define sys_port_trace_type_mask_k_work_delayable(trace_call) trace_call
82 #define sys_port_trace_type_mask_k_work_poll(trace_call) trace_call
83#else
84 #define sys_port_trace_type_mask_k_work(trace_call)
85 #define sys_port_trace_type_mask_k_work_queue(trace_call)
86 #define sys_port_trace_type_mask_k_work_delayable(trace_call)
87 #define sys_port_trace_type_mask_k_work_poll(trace_call)
88#endif
89
90#if defined(CONFIG_TRACING_SEMAPHORE)
91 #define sys_port_trace_type_mask_k_sem(trace_call) trace_call
92#else
93 #define sys_port_trace_type_mask_k_sem(trace_call)
94#endif
95
96#if defined(CONFIG_TRACING_MUTEX)
97 #define sys_port_trace_type_mask_k_mutex(trace_call) trace_call
98#else
99 #define sys_port_trace_type_mask_k_mutex(trace_call)
100#endif
101
102#if defined(CONFIG_TRACING_CONDVAR)
103 #define sys_port_trace_type_mask_k_condvar(trace_call) trace_call
104#else
105 #define sys_port_trace_type_mask_k_condvar(trace_call)
106#endif
107
108#if defined(CONFIG_TRACING_QUEUE)
109 #define sys_port_trace_type_mask_k_queue(trace_call) trace_call
110#else
111 #define sys_port_trace_type_mask_k_queue(trace_call)
112#endif
113
114#if defined(CONFIG_TRACING_FIFO)
115 #define sys_port_trace_type_mask_k_fifo(trace_call) trace_call
116#else
117 #define sys_port_trace_type_mask_k_fifo(trace_call)
118#endif
119
120#if defined(CONFIG_TRACING_LIFO)
121 #define sys_port_trace_type_mask_k_lifo(trace_call) trace_call
122#else
123 #define sys_port_trace_type_mask_k_lifo(trace_call)
124#endif
125
126#if defined(CONFIG_TRACING_STACK)
127 #define sys_port_trace_type_mask_k_stack(trace_call) trace_call
128#else
129 #define sys_port_trace_type_mask_k_stack(trace_call)
130#endif
131
132#if defined(CONFIG_TRACING_MESSAGE_QUEUE)
133 #define sys_port_trace_type_mask_k_msgq(trace_call) trace_call
134#else
135 #define sys_port_trace_type_mask_k_msgq(trace_call)
136#endif
137
138#if defined(CONFIG_TRACING_MAILBOX)
139 #define sys_port_trace_type_mask_k_mbox(trace_call) trace_call
140#else
141 #define sys_port_trace_type_mask_k_mbox(trace_call)
142#endif
143
144#if defined(CONFIG_TRACING_PIPE)
145 #define sys_port_trace_type_mask_k_pipe(trace_call) trace_call
146#else
147 #define sys_port_trace_type_mask_k_pipe(trace_call)
148#endif
149
150#if defined(CONFIG_TRACING_HEAP)
151 #define sys_port_trace_type_mask_k_heap(trace_call) trace_call
152 #define sys_port_trace_type_mask_k_heap_sys(trace_call) trace_call
153#else
154 #define sys_port_trace_type_mask_k_heap(trace_call)
155 #define sys_port_trace_type_mask_k_heap_sys(trace_call)
156#endif
157
158#if defined(CONFIG_TRACING_MEMORY_SLAB)
159 #define sys_port_trace_type_mask_k_mem_slab(trace_call) trace_call
160#else
161 #define sys_port_trace_type_mask_k_mem_slab(trace_call)
162#endif
163
164#if defined(CONFIG_TRACING_TIMER)
165 #define sys_port_trace_type_mask_k_timer(trace_call) trace_call
166#else
167 #define sys_port_trace_type_mask_k_timer(trace_call)
168#endif
169
170#if defined(CONFIG_TRACING_EVENT)
171 #define sys_port_trace_type_mask_k_event(trace_call) trace_call
172#else
173 #define sys_port_trace_type_mask_k_event(trace_call)
174#endif
175
184#define SYS_PORT_TRACING_TYPE_MASK(type, trace_call) \
185 _SYS_PORT_TRACING_TYPE_MASK(type)(trace_call)
186
197#define SYS_PORT_TRACING_FUNC(type, func, ...) \
198 do { \
199 _SYS_PORT_TRACING_FUNC(type, func)(__VA_ARGS__); \
200 } while (false)
201
212#define SYS_PORT_TRACING_FUNC_ENTER(type, func, ...) \
213 do { \
214 _SYS_PORT_TRACING_FUNC_ENTER(type, func)(__VA_ARGS__); \
215 } while (false)
216
226#define SYS_PORT_TRACING_FUNC_BLOCKING(type, func, ...) \
227 do { \
228 _SYS_PORT_TRACING_FUNC_BLOCKING(type, func)(__VA_ARGS__); \
229 } while (false)
230
241#define SYS_PORT_TRACING_FUNC_EXIT(type, func, ...) \
242 do { \
243 _SYS_PORT_TRACING_FUNC_EXIT(type, func)(__VA_ARGS__); \
244 } while (false)
245
252#define SYS_PORT_TRACING_OBJ_INIT(obj_type, obj, ...) \
253 do { \
254 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
255 _SYS_PORT_TRACING_OBJ_INIT(obj_type)(obj, ##__VA_ARGS__)); \
256 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
257 _SYS_PORT_TRACKING_OBJ_INIT(obj_type)(obj, ##__VA_ARGS__)); \
258 } while (false)
259
270#define SYS_PORT_TRACING_OBJ_FUNC(obj_type, func, obj, ...) \
271 do { \
272 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
273 _SYS_PORT_TRACING_OBJ_FUNC(obj_type, func)(obj, ##__VA_ARGS__)); \
274 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
275 _SYS_PORT_TRACKING_OBJ_FUNC(obj_type, func)(obj, ##__VA_ARGS__)); \
276 } while (false)
277
289#define SYS_PORT_TRACING_OBJ_FUNC_ENTER(obj_type, func, obj, ...) \
290 do { \
291 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
292 _SYS_PORT_TRACING_OBJ_FUNC_ENTER(obj_type, func)(obj, ##__VA_ARGS__)); \
293 } while (false)
294
306#define SYS_PORT_TRACING_OBJ_FUNC_BLOCKING(obj_type, func, obj, timeout, ...) \
307 do { \
308 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
309 _SYS_PORT_TRACING_OBJ_FUNC_BLOCKING(obj_type, func) \
310 (obj, timeout, ##__VA_ARGS__)); \
311 } while (false)
312
324#define SYS_PORT_TRACING_OBJ_FUNC_EXIT(obj_type, func, obj, ...) \
325 do { \
326 SYS_PORT_TRACING_TYPE_MASK(obj_type, \
327 _SYS_PORT_TRACING_OBJ_FUNC_EXIT(obj_type, func)(obj, ##__VA_ARGS__)); \
328 } while (false)
329
335#define SYS_PORT_TRACING_TRACKING_FIELD(type) \
336 SYS_PORT_TRACING_TYPE_MASK(type, struct type *_obj_track_next;)
337 /* end of subsys_tracing_macros */
339
340#endif /* CONFIG_TRACING */
341
342#endif /* ZEPHYR_INCLUDE_TRACING_TRACING_MACROS_H_ */