DPDK  20.11.3
rte_trace_point.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2020 Marvell International Ltd.
3  */
4 
5 #ifndef _RTE_TRACE_POINT_H_
6 #define _RTE_TRACE_POINT_H_
7 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 #include <stdbool.h>
24 #include <stdio.h>
25 
26 #include <rte_branch_prediction.h>
27 #include <rte_common.h>
28 #include <rte_compat.h>
29 #include <rte_cycles.h>
30 #include <rte_per_lcore.h>
31 #include <rte_string_fns.h>
32 #include <rte_uuid.h>
33 
35 typedef uint64_t rte_trace_point_t;
36 
42 #define RTE_TRACE_POINT_ARGS
43 
45 #define __RTE_TRACE_POINT(_mode, _tp, _args, ...) \
46 extern rte_trace_point_t __##_tp; \
47 static __rte_always_inline void \
48 _tp _args \
49 { \
50  __rte_trace_point_emit_header_##_mode(&__##_tp); \
51  __VA_ARGS__ \
52 }
53 
78 #define RTE_TRACE_POINT(tp, args, ...) \
79  __RTE_TRACE_POINT(generic, tp, args, __VA_ARGS__)
80 
99 #define RTE_TRACE_POINT_FP(tp, args, ...) \
100  __RTE_TRACE_POINT(fp, tp, args, __VA_ARGS__)
101 
102 #ifdef __DOXYGEN__
103 
115 #define RTE_TRACE_POINT_REGISTER(trace, name)
116 
118 #define rte_trace_point_emit_u64(val)
119 
120 #define rte_trace_point_emit_i64(val)
121 
122 #define rte_trace_point_emit_u32(val)
123 
124 #define rte_trace_point_emit_i32(val)
125 
126 #define rte_trace_point_emit_u16(val)
127 
128 #define rte_trace_point_emit_i16(val)
129 
130 #define rte_trace_point_emit_u8(val)
131 
132 #define rte_trace_point_emit_i8(val)
133 
134 #define rte_trace_point_emit_int(val)
135 
136 #define rte_trace_point_emit_long(val)
137 
138 #define rte_trace_point_emit_size_t(val)
139 
140 #define rte_trace_point_emit_float(val)
141 
142 #define rte_trace_point_emit_double(val)
143 
144 #define rte_trace_point_emit_ptr(val)
145 
146 #define rte_trace_point_emit_string(val)
147 
148 #endif /* __DOXYGEN__ */
149 
151 #define __RTE_TRACE_EMIT_STRING_LEN_MAX 32
152 
153 #define __RTE_TRACE_EVENT_HEADER_SZ sizeof(uint64_t)
154 
164 __rte_experimental
165 int rte_trace_point_enable(rte_trace_point_t *tp);
166 
176 __rte_experimental
177 int rte_trace_point_disable(rte_trace_point_t *tp);
178 
187 __rte_experimental
188 bool rte_trace_point_is_enabled(rte_trace_point_t *tp);
189 
198 __rte_experimental
199 rte_trace_point_t *rte_trace_point_lookup(const char *name);
200 
209 __rte_experimental
210 static __rte_always_inline bool
211 __rte_trace_point_fp_is_enabled(void)
212 {
213 #ifdef RTE_ENABLE_TRACE_FP
214  return true;
215 #else
216  return false;
217 #endif
218 }
219 
226 __rte_experimental
227 void __rte_trace_mem_per_thread_alloc(void);
228 
244 __rte_experimental
245 void __rte_trace_point_emit_field(size_t sz, const char *field,
246  const char *type);
247 
264 __rte_experimental
265 int __rte_trace_point_register(rte_trace_point_t *trace, const char *name,
266  void (*register_fn)(void));
267 
268 #ifndef __DOXYGEN__
269 
270 #ifndef _RTE_TRACE_POINT_REGISTER_H_
271 #ifdef ALLOW_EXPERIMENTAL_API
272 
273 #define __RTE_TRACE_EVENT_HEADER_ID_SHIFT (48)
274 
275 #define __RTE_TRACE_FIELD_SIZE_SHIFT 0
276 #define __RTE_TRACE_FIELD_SIZE_MASK (0xffffULL << __RTE_TRACE_FIELD_SIZE_SHIFT)
277 #define __RTE_TRACE_FIELD_ID_SHIFT (16)
278 #define __RTE_TRACE_FIELD_ID_MASK (0xffffULL << __RTE_TRACE_FIELD_ID_SHIFT)
279 #define __RTE_TRACE_FIELD_ENABLE_MASK (1ULL << 63)
280 #define __RTE_TRACE_FIELD_ENABLE_DISCARD (1ULL << 62)
281 
282 struct __rte_trace_stream_header {
283  uint32_t magic;
284  rte_uuid_t uuid;
285  uint32_t lcore_id;
286  char thread_name[__RTE_TRACE_EMIT_STRING_LEN_MAX];
287 } __rte_packed;
288 
289 struct __rte_trace_header {
290  uint32_t offset;
291  uint32_t len;
292  struct __rte_trace_stream_header stream_header;
293  uint8_t mem[];
294 };
295 
296 RTE_DECLARE_PER_LCORE(void *, trace_mem);
297 
298 static __rte_always_inline void *
299 __rte_trace_mem_get(uint64_t in)
300 {
301  struct __rte_trace_header *trace =
302  (struct __rte_trace_header *)(RTE_PER_LCORE(trace_mem));
303  const uint16_t sz = in & __RTE_TRACE_FIELD_SIZE_MASK;
304 
305  /* Trace memory is not initialized for this thread */
306  if (unlikely(trace == NULL)) {
307  __rte_trace_mem_per_thread_alloc();
308  trace = (struct __rte_trace_header *)(RTE_PER_LCORE(trace_mem));
309  if (unlikely(trace == NULL))
310  return NULL;
311  }
312  /* Check the wrap around case */
313  uint32_t offset = trace->offset;
314  if (unlikely((offset + sz) >= trace->len)) {
315  /* Disable the trace event if it in DISCARD mode */
316  if (unlikely(in & __RTE_TRACE_FIELD_ENABLE_DISCARD))
317  return NULL;
318 
319  offset = 0;
320  }
321  /* Align to event header size */
322  offset = RTE_ALIGN_CEIL(offset, __RTE_TRACE_EVENT_HEADER_SZ);
323  void *mem = RTE_PTR_ADD(&trace->mem[0], offset);
324  offset += sz;
325  trace->offset = offset;
326 
327  return mem;
328 }
329 
330 static __rte_always_inline void *
331 __rte_trace_point_emit_ev_header(void *mem, uint64_t in)
332 {
333  uint64_t val;
334 
335  /* Event header [63:0] = id [63:48] | timestamp [47:0] */
336  val = rte_get_tsc_cycles() &
337  ~(0xffffULL << __RTE_TRACE_EVENT_HEADER_ID_SHIFT);
338  val |= ((in & __RTE_TRACE_FIELD_ID_MASK) <<
339  (__RTE_TRACE_EVENT_HEADER_ID_SHIFT -
340  __RTE_TRACE_FIELD_ID_SHIFT));
341 
342  *(uint64_t *)mem = val;
343  return RTE_PTR_ADD(mem, __RTE_TRACE_EVENT_HEADER_SZ);
344 }
345 
346 #define __rte_trace_point_emit_header_generic(t) \
347 void *mem; \
348 do { \
349  const uint64_t val = __atomic_load_n(t, __ATOMIC_ACQUIRE); \
350  if (likely(!(val & __RTE_TRACE_FIELD_ENABLE_MASK))) \
351  return; \
352  mem = __rte_trace_mem_get(val); \
353  if (unlikely(mem == NULL)) \
354  return; \
355  mem = __rte_trace_point_emit_ev_header(mem, val); \
356 } while (0)
357 
358 #define __rte_trace_point_emit_header_fp(t) \
359  if (!__rte_trace_point_fp_is_enabled()) \
360  return; \
361  __rte_trace_point_emit_header_generic(t)
362 
363 #define __rte_trace_point_emit(in, type) \
364 do { \
365  memcpy(mem, &(in), sizeof(in)); \
366  mem = RTE_PTR_ADD(mem, sizeof(in)); \
367 } while (0)
368 
369 #define rte_trace_point_emit_string(in) \
370 do { \
371  if (unlikely(in == NULL)) \
372  return; \
373  rte_strscpy(mem, in, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
374  mem = RTE_PTR_ADD(mem, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
375 } while (0)
376 
377 #else
378 
379 #define __rte_trace_point_emit_header_generic(t) RTE_SET_USED(t)
380 #define __rte_trace_point_emit_header_fp(t) RTE_SET_USED(t)
381 #define __rte_trace_point_emit(in, type) RTE_SET_USED(in)
382 #define rte_trace_point_emit_string(in) RTE_SET_USED(in)
383 
384 #endif /* ALLOW_EXPERIMENTAL_API */
385 #endif /* _RTE_TRACE_POINT_REGISTER_H_ */
386 
387 #define rte_trace_point_emit_u64(in) __rte_trace_point_emit(in, uint64_t)
388 #define rte_trace_point_emit_i64(in) __rte_trace_point_emit(in, int64_t)
389 #define rte_trace_point_emit_u32(in) __rte_trace_point_emit(in, uint32_t)
390 #define rte_trace_point_emit_i32(in) __rte_trace_point_emit(in, int32_t)
391 #define rte_trace_point_emit_u16(in) __rte_trace_point_emit(in, uint16_t)
392 #define rte_trace_point_emit_i16(in) __rte_trace_point_emit(in, int16_t)
393 #define rte_trace_point_emit_u8(in) __rte_trace_point_emit(in, uint8_t)
394 #define rte_trace_point_emit_i8(in) __rte_trace_point_emit(in, int8_t)
395 #define rte_trace_point_emit_int(in) __rte_trace_point_emit(in, int32_t)
396 #define rte_trace_point_emit_long(in) __rte_trace_point_emit(in, long)
397 #define rte_trace_point_emit_size_t(in) __rte_trace_point_emit(in, size_t)
398 #define rte_trace_point_emit_float(in) __rte_trace_point_emit(in, float)
399 #define rte_trace_point_emit_double(in) __rte_trace_point_emit(in, double)
400 #define rte_trace_point_emit_ptr(in) __rte_trace_point_emit(in, uintptr_t)
401 
402 #endif /* __DOXYGEN__ */
403 
404 #ifdef __cplusplus
405 }
406 #endif
407 
408 #endif /* _RTE_TRACE_POINT_H_ */
#define __rte_packed
Definition: rte_common.h:84
#define RTE_DECLARE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:38
#define __rte_always_inline
Definition: rte_common.h:226
#define RTE_ALIGN_CEIL(val, align)
Definition: rte_common.h:304
__rte_experimental int rte_trace_point_disable(rte_trace_point_t *tp)
__rte_experimental rte_trace_point_t * rte_trace_point_lookup(const char *name)
#define RTE_PTR_ADD(ptr, x)
Definition: rte_common.h:248
#define unlikely(x)
unsigned char rte_uuid_t[16]
Definition: rte_uuid.h:24
static uint64_t rte_get_tsc_cycles(void)
__rte_experimental int rte_trace_point_enable(rte_trace_point_t *tp)
#define RTE_PER_LCORE(name)
Definition: rte_per_lcore.h:44
__rte_experimental bool rte_trace_point_is_enabled(rte_trace_point_t *tp)
uint64_t rte_trace_point_t