DPDK  25.03.0
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 #include <stdbool.h>
20 #include <stdio.h>
21 
22 #include <rte_branch_prediction.h>
23 #include <rte_common.h>
24 #include <rte_compat.h>
25 #include <rte_cycles.h>
26 #include <rte_per_lcore.h>
27 #include <rte_stdatomic.h>
28 #include <rte_string_fns.h>
29 #include <rte_trace.h>
30 #include <rte_uuid.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
37 typedef RTE_ATOMIC(uint64_t) rte_trace_point_t;
38 
39 #ifndef _RTE_TRACE_POINT_REGISTER_H_
40 
46 #define RTE_TRACE_POINT_ARGS
47 
49 #define __RTE_TRACE_POINT(_mode, _tp, _args, ...) \
50 extern rte_trace_point_t __##_tp; \
51 static __rte_always_inline void \
52 _tp _args \
53 { \
54  __rte_trace_point_emit_header_##_mode(&__##_tp); \
55  __VA_ARGS__ \
56 }
57 
58 #endif /* _RTE_TRACE_POINT_REGISTER_H_ */
59 
84 #define RTE_TRACE_POINT(tp, args, ...) \
85  __RTE_TRACE_POINT(generic, tp, args, __VA_ARGS__)
86 
105 #define RTE_TRACE_POINT_FP(tp, args, ...) \
106  __RTE_TRACE_POINT(fp, tp, args, __VA_ARGS__)
107 
108 #ifdef __DOXYGEN__
109 
121 #define RTE_TRACE_POINT_REGISTER(trace, name)
122 
124 #define rte_trace_point_emit_u64(val)
125 
126 #define rte_trace_point_emit_i64(val)
127 
128 #define rte_trace_point_emit_u32(val)
129 
130 #define rte_trace_point_emit_i32(val)
131 
132 #define rte_trace_point_emit_u16(val)
133 
134 #define rte_trace_point_emit_i16(val)
135 
136 #define rte_trace_point_emit_u8(val)
137 
138 #define rte_trace_point_emit_i8(val)
139 
140 #define rte_trace_point_emit_int(val)
141 
142 #define rte_trace_point_emit_long(val)
143 
144 #define rte_trace_point_emit_size_t(val)
145 
146 #define rte_trace_point_emit_float(val)
147 
148 #define rte_trace_point_emit_double(val)
149 
150 #define rte_trace_point_emit_ptr(val)
151 
152 #define rte_trace_point_emit_string(val)
153 
162 #define rte_trace_point_emit_blob(val, len)
163 
164 #define rte_trace_point_emit_time(val)
165 #define rte_trace_point_emit_nsec(val)
166 
167 #endif /* __DOXYGEN__ */
168 
170 #define __RTE_TRACE_EMIT_STRING_LEN_MAX 32
171 
172 #define __RTE_TRACE_EVENT_HEADER_SZ sizeof(uint64_t)
173 
175 #define RTE_TRACE_BLOB_LEN_MAX 64
176 
186 __rte_experimental
187 int rte_trace_point_enable(rte_trace_point_t *tp);
188 
198 __rte_experimental
199 int rte_trace_point_disable(rte_trace_point_t *tp);
200 
209 __rte_experimental
210 bool rte_trace_point_is_enabled(rte_trace_point_t *tp);
211 
220 __rte_experimental
221 rte_trace_point_t *rte_trace_point_lookup(const char *name);
222 
231 __rte_experimental
232 static __rte_always_inline bool
233 __rte_trace_point_fp_is_enabled(void)
234 {
235 #ifdef RTE_ENABLE_TRACE_FP
236  return true;
237 #else
238  return false;
239 #endif
240 }
241 
247 __rte_experimental
248 void __rte_trace_mem_per_thread_alloc(void);
249 
265 __rte_experimental
266 void __rte_trace_point_emit_field(size_t sz, const char *field,
267  const char *type);
268 
285 __rte_experimental
286 int __rte_trace_point_register(rte_trace_point_t *trace, const char *name,
287  void (*register_fn)(void));
288 
289 #ifndef __DOXYGEN__
290 
291 #ifndef _RTE_TRACE_POINT_REGISTER_H_
292 #ifdef ALLOW_EXPERIMENTAL_API
293 
294 #define __RTE_TRACE_EVENT_HEADER_ID_SHIFT (48)
295 
296 #define __RTE_TRACE_FIELD_SIZE_SHIFT 0
297 #define __RTE_TRACE_FIELD_SIZE_MASK (0xffffULL << __RTE_TRACE_FIELD_SIZE_SHIFT)
298 #define __RTE_TRACE_FIELD_ID_SHIFT (16)
299 #define __RTE_TRACE_FIELD_ID_MASK (0xffffULL << __RTE_TRACE_FIELD_ID_SHIFT)
300 #define __RTE_TRACE_FIELD_ENABLE_MASK (1ULL << 63)
301 #define __RTE_TRACE_FIELD_ENABLE_DISCARD (1ULL << 62)
302 
303 struct __rte_trace_stream_header {
304  uint32_t magic;
305  rte_uuid_t uuid;
306  uint32_t lcore_id;
307  char thread_name[__RTE_TRACE_EMIT_STRING_LEN_MAX];
308 };
309 
310 struct __rte_trace_header {
311  uint32_t offset;
312  uint32_t len;
313  struct __rte_trace_stream_header stream_header;
314  uint8_t mem[];
315 };
316 
317 RTE_DECLARE_PER_LCORE(void *, trace_mem);
318 
319 static __rte_always_inline void *
320 __rte_trace_mem_get(uint64_t in)
321 {
322  struct __rte_trace_header *trace =
323  (struct __rte_trace_header *)(RTE_PER_LCORE(trace_mem));
324  const uint16_t sz = in & __RTE_TRACE_FIELD_SIZE_MASK;
325 
326  /* Trace memory is not initialized for this thread */
327  if (unlikely(trace == NULL)) {
328  __rte_trace_mem_per_thread_alloc();
329  trace = (struct __rte_trace_header *)(RTE_PER_LCORE(trace_mem));
330  if (unlikely(trace == NULL))
331  return NULL;
332  }
333  /* Check the wrap around case */
334  uint32_t offset = trace->offset;
335  if (unlikely((offset + sz) >= trace->len)) {
336  /* Disable the trace event if it in DISCARD mode */
337  if (unlikely(in & __RTE_TRACE_FIELD_ENABLE_DISCARD))
338  return NULL;
339 
340  offset = 0;
341  }
342  /* Align to event header size */
343  offset = RTE_ALIGN_CEIL(offset, __RTE_TRACE_EVENT_HEADER_SZ);
344  void *mem = RTE_PTR_ADD(&trace->mem[0], offset);
345  offset += sz;
346  trace->offset = offset;
347 
348  return mem;
349 }
350 
351 static __rte_always_inline void *
352 __rte_trace_point_emit_ev_header(void *mem, uint64_t in)
353 {
354  uint64_t val;
355 
356  /* Event header [63:0] = id [63:48] | timestamp [47:0] */
357  val = rte_get_tsc_cycles() &
358  ~(0xffffULL << __RTE_TRACE_EVENT_HEADER_ID_SHIFT);
359  val |= ((in & __RTE_TRACE_FIELD_ID_MASK) <<
360  (__RTE_TRACE_EVENT_HEADER_ID_SHIFT -
361  __RTE_TRACE_FIELD_ID_SHIFT));
362 
363  *(uint64_t *)mem = val;
364  return RTE_PTR_ADD(mem, __RTE_TRACE_EVENT_HEADER_SZ);
365 }
366 
367 #define __rte_trace_point_emit_header_generic(t) \
368 void *mem; \
369 do { \
370  if (!rte_trace_feature_is_enabled()) \
371  return; \
372  const uint64_t val = rte_atomic_load_explicit(t, rte_memory_order_acquire); \
373  if (likely(!(val & __RTE_TRACE_FIELD_ENABLE_MASK))) \
374  return; \
375  mem = __rte_trace_mem_get(val); \
376  if (unlikely(mem == NULL)) \
377  return; \
378  mem = __rte_trace_point_emit_ev_header(mem, val); \
379 } while (0)
380 
381 #define __rte_trace_point_emit_header_fp(t) \
382  if (!__rte_trace_point_fp_is_enabled()) \
383  return; \
384  __rte_trace_point_emit_header_generic(t)
385 
386 #define __rte_trace_point_emit(name, in, type) \
387 do { \
388  RTE_BUILD_BUG_ON(sizeof(type) != sizeof(typeof(*in))); \
389  memcpy(mem, in, sizeof(*in)); \
390  mem = RTE_PTR_ADD(mem, sizeof(*in)); \
391 } while (0)
392 
393 #define rte_trace_point_emit_string(in) \
394 do { \
395  if (unlikely(in == NULL)) \
396  return; \
397  rte_strscpy((char *)mem, in, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
398  mem = RTE_PTR_ADD(mem, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
399 } while (0)
400 
401 #define rte_trace_point_emit_blob(in, len) \
402 do { \
403  uint8_t size = len; \
404  if (unlikely(in == NULL)) \
405  return; \
406  if (size > RTE_TRACE_BLOB_LEN_MAX) \
407  size = RTE_TRACE_BLOB_LEN_MAX; \
408  __rte_trace_point_emit("size", &size, uint8_t); \
409  memcpy(mem, in, size); \
410  memset(RTE_PTR_ADD(mem, size), 0, RTE_TRACE_BLOB_LEN_MAX - size); \
411  mem = RTE_PTR_ADD(mem, RTE_TRACE_BLOB_LEN_MAX); \
412 } while (0)
413 
414 #else
415 
416 #define __rte_trace_point_emit_header_generic(t) RTE_SET_USED(t)
417 #define __rte_trace_point_emit_header_fp(t) RTE_SET_USED(t)
418 #define __rte_trace_point_emit(name, in, type) RTE_SET_USED(in)
419 #define rte_trace_point_emit_string(in) RTE_SET_USED(in)
420 #define rte_trace_point_emit_blob(in, len) \
421 do { \
422  RTE_SET_USED(in); \
423  RTE_SET_USED(len); \
424 } while (0)
425 
426 
427 #endif /* ALLOW_EXPERIMENTAL_API */
428 #endif /* _RTE_TRACE_POINT_REGISTER_H_ */
429 
430 #define rte_trace_point_emit_u64(in) __rte_trace_point_emit(RTE_STR(in), &in, uint64_t)
431 #define rte_trace_point_emit_i64(in) __rte_trace_point_emit(RTE_STR(in), &in, int64_t)
432 #define rte_trace_point_emit_u32(in) __rte_trace_point_emit(RTE_STR(in), &in, uint32_t)
433 #define rte_trace_point_emit_i32(in) __rte_trace_point_emit(RTE_STR(in), &in, int32_t)
434 #define rte_trace_point_emit_u16(in) __rte_trace_point_emit(RTE_STR(in), &in, uint16_t)
435 #define rte_trace_point_emit_i16(in) __rte_trace_point_emit(RTE_STR(in), &in, int16_t)
436 #define rte_trace_point_emit_u8(in) __rte_trace_point_emit(RTE_STR(in), &in, uint8_t)
437 #define rte_trace_point_emit_i8(in) __rte_trace_point_emit(RTE_STR(in), &in, int8_t)
438 #define rte_trace_point_emit_int(in) __rte_trace_point_emit(RTE_STR(in), &in, int32_t)
439 #define rte_trace_point_emit_long(in) __rte_trace_point_emit(RTE_STR(in), &in, long)
440 #define rte_trace_point_emit_size_t(in) __rte_trace_point_emit(RTE_STR(in), &in, size_t)
441 #define rte_trace_point_emit_float(in) __rte_trace_point_emit(RTE_STR(in), &in, float)
442 #define rte_trace_point_emit_double(in) __rte_trace_point_emit(RTE_STR(in), &in, double)
443 #define rte_trace_point_emit_ptr(in) __rte_trace_point_emit(RTE_STR(in), &in, uintptr_t)
444 
445 #define rte_trace_point_emit_u64_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint64_t)
446 #define rte_trace_point_emit_i64_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int64_t)
447 #define rte_trace_point_emit_u32_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint32_t)
448 #define rte_trace_point_emit_i32_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int32_t)
449 #define rte_trace_point_emit_u16_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint16_t)
450 #define rte_trace_point_emit_i16_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int16_t)
451 #define rte_trace_point_emit_u8_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint8_t)
452 #define rte_trace_point_emit_i8_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int8_t)
453 #define rte_trace_point_emit_int_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int32_t)
454 #define rte_trace_point_emit_long_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, long)
455 #define rte_trace_point_emit_size_t_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, size_t)
456 #define rte_trace_point_emit_float_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, float)
457 #define rte_trace_point_emit_double_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, double)
458 
459 #if defined(__USE_TIME_BITS64) && !defined(__x86_64__)
460 #define rte_trace_point_emit_time(in) __rte_trace_point_emit(RTE_STR(in), &in, __time64_t)
461 #else
462 #define rte_trace_point_emit_time(in) __rte_trace_point_emit(RTE_STR(in), &in, time_t)
463 #endif
464 #if defined(__x86_64__) && defined(__ILP32__)
465 #define rte_trace_point_emit_nsec(in) __rte_trace_point_emit(RTE_STR(in), &in, int64_t)
466 #else
467 #define rte_trace_point_emit_nsec(in) __rte_trace_point_emit(RTE_STR(in), &in, long)
468 #endif
469 
470 #endif /* __DOXYGEN__ */
471 
472 #ifdef __cplusplus
473 }
474 #endif
475 
476 #endif /* _RTE_TRACE_POINT_H_ */
#define RTE_DECLARE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:39
#define __rte_always_inline
Definition: rte_common.h:456
#define RTE_ALIGN_CEIL(val, align)
Definition: rte_common.h:603
__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:520
#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:46
__rte_experimental bool rte_trace_point_is_enabled(rte_trace_point_t *tp)