DPDK 25.07.0-rc3
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#include <time.h>
22
24#include <rte_common.h>
25#include <rte_compat.h>
26#include <rte_cycles.h>
27#include <rte_per_lcore.h>
28#include <rte_stdatomic.h>
29#include <rte_string_fns.h>
30#include <rte_trace.h>
31#include <rte_uuid.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
38typedef RTE_ATOMIC(uint64_t) rte_trace_point_t;
39
40#ifndef _RTE_TRACE_POINT_REGISTER_H_
41
47#define RTE_TRACE_POINT_ARGS
48
50#define __RTE_TRACE_POINT(_mode, _tp, _args, ...) \
51extern rte_trace_point_t __##_tp; \
52static __rte_always_inline void \
53_tp _args \
54{ \
55 __rte_trace_point_emit_header_##_mode(&__##_tp); \
56 __VA_ARGS__ \
57}
58
59#endif /* _RTE_TRACE_POINT_REGISTER_H_ */
60
85#define RTE_TRACE_POINT(tp, args, ...) \
86 __RTE_TRACE_POINT(generic, tp, args, __VA_ARGS__)
87
106#define RTE_TRACE_POINT_FP(tp, args, ...) \
107 __RTE_TRACE_POINT(fp, tp, args, __VA_ARGS__)
108
109#ifdef __DOXYGEN__
110
122#define RTE_TRACE_POINT_REGISTER(trace, name)
123
125#define rte_trace_point_emit_u64(val)
127#define rte_trace_point_emit_i64(val)
129#define rte_trace_point_emit_u32(val)
131#define rte_trace_point_emit_i32(val)
133#define rte_trace_point_emit_u16(val)
135#define rte_trace_point_emit_i16(val)
137#define rte_trace_point_emit_u8(val)
139#define rte_trace_point_emit_i8(val)
141#define rte_trace_point_emit_int(val)
143#define rte_trace_point_emit_long(val)
145#define rte_trace_point_emit_size_t(val)
147#define rte_trace_point_emit_float(val)
149#define rte_trace_point_emit_double(val)
151#define rte_trace_point_emit_ptr(val)
153#define rte_trace_point_emit_string(val)
155#define rte_trace_point_emit_time_t(val)
165#define rte_trace_point_emit_blob(val, len)
166
167#endif /* __DOXYGEN__ */
168
170#define __RTE_TRACE_EMIT_STRING_LEN_MAX 32
172#define __RTE_TRACE_EVENT_HEADER_SZ sizeof(uint64_t)
173
175#define RTE_TRACE_BLOB_LEN_MAX 64
176
186__rte_experimental
187int rte_trace_point_enable(rte_trace_point_t *tp);
188
198__rte_experimental
199int rte_trace_point_disable(rte_trace_point_t *tp);
200
209__rte_experimental
210bool rte_trace_point_is_enabled(rte_trace_point_t *tp);
211
220__rte_experimental
221rte_trace_point_t *rte_trace_point_lookup(const char *name);
222
231__rte_experimental
232static __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
248void __rte_trace_mem_per_thread_alloc(void);
249
265__rte_experimental
266void __rte_trace_point_emit_field(size_t sz, const char *field,
267 const char *type);
268
285__rte_experimental
286int __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
303struct __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
310struct __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
317RTE_DECLARE_PER_LCORE(void *, trace_mem);
318
319static __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 = RTE_ALIGN_CEIL(trace->offset, __RTE_TRACE_EVENT_HEADER_SZ);
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 void *mem = RTE_PTR_ADD(&trace->mem[0], offset);
343 offset += sz;
344 trace->offset = offset;
345
346 return mem;
347}
348
349static __rte_always_inline void *
350__rte_trace_point_emit_ev_header(void *mem, uint64_t in)
351{
352 uint64_t val;
353
354 /* Event header [63:0] = id [63:48] | timestamp [47:0] */
355 val = rte_get_tsc_cycles() &
356 ~(0xffffULL << __RTE_TRACE_EVENT_HEADER_ID_SHIFT);
357 val |= ((in & __RTE_TRACE_FIELD_ID_MASK) <<
358 (__RTE_TRACE_EVENT_HEADER_ID_SHIFT -
359 __RTE_TRACE_FIELD_ID_SHIFT));
360
361 *(uint64_t *)mem = val;
362 return RTE_PTR_ADD(mem, __RTE_TRACE_EVENT_HEADER_SZ);
363}
364
365#define __rte_trace_point_emit_header_generic(t) \
366void *mem; \
367do { \
368 if (!rte_trace_feature_is_enabled()) \
369 return; \
370 const uint64_t val = rte_atomic_load_explicit(t, rte_memory_order_acquire); \
371 if (likely(!(val & __RTE_TRACE_FIELD_ENABLE_MASK))) \
372 return; \
373 mem = __rte_trace_mem_get(val); \
374 if (unlikely(mem == NULL)) \
375 return; \
376 mem = __rte_trace_point_emit_ev_header(mem, val); \
377} while (0)
378
379#define __rte_trace_point_emit_header_fp(t) \
380 if (!__rte_trace_point_fp_is_enabled()) \
381 return; \
382 __rte_trace_point_emit_header_generic(t)
383
384#define __rte_trace_point_emit(name, in, type) \
385do { \
386 RTE_BUILD_BUG_ON(sizeof(type) != sizeof(typeof(*in))); \
387 memcpy(mem, in, sizeof(*in)); \
388 mem = RTE_PTR_ADD(mem, sizeof(*in)); \
389} while (0)
390
391#define rte_trace_point_emit_string(in) \
392do { \
393 if (unlikely(in == NULL)) \
394 return; \
395 rte_strscpy((char *)mem, in, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
396 mem = RTE_PTR_ADD(mem, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
397} while (0)
398
399#define rte_trace_point_emit_blob(in, len) \
400do { \
401 uint8_t size = len; \
402 if (unlikely(in == NULL)) \
403 return; \
404 if (size > RTE_TRACE_BLOB_LEN_MAX) \
405 size = RTE_TRACE_BLOB_LEN_MAX; \
406 __rte_trace_point_emit("size", &size, uint8_t); \
407 memcpy(mem, in, size); \
408 memset(RTE_PTR_ADD(mem, size), 0, RTE_TRACE_BLOB_LEN_MAX - size); \
409 mem = RTE_PTR_ADD(mem, RTE_TRACE_BLOB_LEN_MAX); \
410} while (0)
411
412#else
413
414#define __rte_trace_point_emit_header_generic(t) RTE_SET_USED(t)
415#define __rte_trace_point_emit_header_fp(t) RTE_SET_USED(t)
416#define __rte_trace_point_emit(name, in, type) RTE_SET_USED(in)
417#define rte_trace_point_emit_string(in) RTE_SET_USED(in)
418#define rte_trace_point_emit_blob(in, len) \
419do { \
420 RTE_SET_USED(in); \
421 RTE_SET_USED(len); \
422} while (0)
423
424
425#endif /* ALLOW_EXPERIMENTAL_API */
426#endif /* _RTE_TRACE_POINT_REGISTER_H_ */
427
428#define rte_trace_point_emit_u64(in) __rte_trace_point_emit(RTE_STR(in), &in, uint64_t)
429#define rte_trace_point_emit_i64(in) __rte_trace_point_emit(RTE_STR(in), &in, int64_t)
430#define rte_trace_point_emit_u32(in) __rte_trace_point_emit(RTE_STR(in), &in, uint32_t)
431#define rte_trace_point_emit_i32(in) __rte_trace_point_emit(RTE_STR(in), &in, int32_t)
432#define rte_trace_point_emit_u16(in) __rte_trace_point_emit(RTE_STR(in), &in, uint16_t)
433#define rte_trace_point_emit_i16(in) __rte_trace_point_emit(RTE_STR(in), &in, int16_t)
434#define rte_trace_point_emit_u8(in) __rte_trace_point_emit(RTE_STR(in), &in, uint8_t)
435#define rte_trace_point_emit_i8(in) __rte_trace_point_emit(RTE_STR(in), &in, int8_t)
436#define rte_trace_point_emit_int(in) __rte_trace_point_emit(RTE_STR(in), &in, int32_t)
437#define rte_trace_point_emit_long(in) __rte_trace_point_emit(RTE_STR(in), &in, long)
438#define rte_trace_point_emit_size_t(in) __rte_trace_point_emit(RTE_STR(in), &in, size_t)
439#define rte_trace_point_emit_float(in) __rte_trace_point_emit(RTE_STR(in), &in, float)
440#define rte_trace_point_emit_double(in) __rte_trace_point_emit(RTE_STR(in), &in, double)
441#define rte_trace_point_emit_ptr(in) __rte_trace_point_emit(RTE_STR(in), &in, uintptr_t)
442#define rte_trace_point_emit_time_t(in) __rte_trace_point_emit(RTE_STR(in), &in, time_t)
443
444#define rte_trace_point_emit_u64_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint64_t)
445#define rte_trace_point_emit_i64_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int64_t)
446#define rte_trace_point_emit_u32_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint32_t)
447#define rte_trace_point_emit_i32_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int32_t)
448#define rte_trace_point_emit_u16_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint16_t)
449#define rte_trace_point_emit_i16_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int16_t)
450#define rte_trace_point_emit_u8_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, uint8_t)
451#define rte_trace_point_emit_i8_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int8_t)
452#define rte_trace_point_emit_int_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, int32_t)
453#define rte_trace_point_emit_long_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, long)
454#define rte_trace_point_emit_size_t_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, size_t)
455#define rte_trace_point_emit_float_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, float)
456#define rte_trace_point_emit_double_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, double)
457#define rte_trace_point_emit_time_t_ptr(in) __rte_trace_point_emit(RTE_STR(in)"_val", in, time_t)
458
459#endif /* __DOXYGEN__ */
460
461#ifdef __cplusplus
462}
463#endif
464
465#endif /* _RTE_TRACE_POINT_H_ */
#define unlikely(x)
#define RTE_ALIGN_CEIL(val, align)
Definition: rte_common.h:637
#define RTE_PTR_ADD(ptr, x)
Definition: rte_common.h:554
#define __rte_always_inline
Definition: rte_common.h:490
static uint64_t rte_get_tsc_cycles(void)
#define RTE_PER_LCORE(name)
Definition: rte_per_lcore.h:46
#define RTE_DECLARE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:39
__rte_experimental bool rte_trace_point_is_enabled(rte_trace_point_t *tp)
__rte_experimental int rte_trace_point_disable(rte_trace_point_t *tp)
__rte_experimental int rte_trace_point_enable(rte_trace_point_t *tp)
__rte_experimental rte_trace_point_t * rte_trace_point_lookup(const char *name)
unsigned char rte_uuid_t[16]
Definition: rte_uuid.h:24