lib/librte_eal/include/rte_trace_point_provider.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2020 Marvell International Ltd.
   3  */
   4
   5 #ifndef _RTE_TRACE_POINT_H_
   6 #error do not include this file directly, use <rte_trace_point.h> instead
   7 #endif
   8
   9 #ifndef _RTE_TRACE_POINT_PROVIDER_H_
  10 #define _RTE_TRACE_POINT_PROVIDER_H_
  11
  12 #ifdef ALLOW_EXPERIMENTAL_API
  13
  14 #include <rte_branch_prediction.h>
  15 #include <rte_cycles.h>
  16 #include <rte_per_lcore.h>
  17 #include <rte_string_fns.h>
  18 #include <rte_uuid.h>
  19
  20 #define __RTE_TRACE_EVENT_HEADER_ID_SHIFT (48)
  21
  22 #define __RTE_TRACE_FIELD_SIZE_SHIFT 0
  23 #define __RTE_TRACE_FIELD_SIZE_MASK (0xffffULL << __RTE_TRACE_FIELD_SIZE_SHIFT)
  24 #define __RTE_TRACE_FIELD_ID_SHIFT (16)
  25 #define __RTE_TRACE_FIELD_ID_MASK (0xffffULL << __RTE_TRACE_FIELD_ID_SHIFT)
  26 #define __RTE_TRACE_FIELD_ENABLE_MASK (1ULL << 63)
  27 #define __RTE_TRACE_FIELD_ENABLE_DISCARD (1ULL << 62)
  28
  29 struct __rte_trace_stream_header {
  30         uint32_t magic;
  31         rte_uuid_t uuid;
  32         uint32_t lcore_id;
  33         char thread_name[__RTE_TRACE_EMIT_STRING_LEN_MAX];
  34 } __rte_packed;
  35
  36 struct __rte_trace_header {
  37         uint32_t offset;
  38         uint32_t len;
  39         struct __rte_trace_stream_header stream_header;
  40         uint8_t mem[];
  41 };
  42
  43 RTE_DECLARE_PER_LCORE(void *, trace_mem);
  44
  45 static __rte_always_inline void *
  46 __rte_trace_mem_get(uint64_t in)
  47 {
  48         struct __rte_trace_header *trace = RTE_PER_LCORE(trace_mem);
  49         const uint16_t sz = in & __RTE_TRACE_FIELD_SIZE_MASK;
  50
  51         /* Trace memory is not initialized for this thread */
  52         if (unlikely(trace == NULL)) {
  53                 __rte_trace_mem_per_thread_alloc();
  54                 trace = RTE_PER_LCORE(trace_mem);
  55                 if (unlikely(trace == NULL))
  56                         return NULL;
  57         }
  58         /* Check the wrap around case */
  59         uint32_t offset = trace->offset;
  60         if (unlikely((offset + sz) >= trace->len)) {
  61                 /* Disable the trace event if it in DISCARD mode */
  62                 if (unlikely(in & __RTE_TRACE_FIELD_ENABLE_DISCARD))
  63                         return NULL;
  64
  65                 offset = 0;
  66         }
  67         /* Align to event header size */
  68         offset = RTE_ALIGN_CEIL(offset, __RTE_TRACE_EVENT_HEADER_SZ);
  69         void *mem = RTE_PTR_ADD(&trace->mem[0], offset);
  70         offset += sz;
  71         trace->offset = offset;
  72
  73         return mem;
  74 }
  75
  76 static __rte_always_inline void *
  77 __rte_trace_point_emit_ev_header(void *mem, uint64_t in)
  78 {
  79         uint64_t val;
  80
  81         /* Event header [63:0] = id [63:48] | timestamp [47:0] */
  82         val = rte_get_tsc_cycles() &
  83                 ~(0xffffULL << __RTE_TRACE_EVENT_HEADER_ID_SHIFT);
  84         val |= ((in & __RTE_TRACE_FIELD_ID_MASK) <<
  85                 (__RTE_TRACE_EVENT_HEADER_ID_SHIFT - __RTE_TRACE_FIELD_ID_SHIFT));
  86
  87         *(uint64_t *)mem = val;
  88         return RTE_PTR_ADD(mem, __RTE_TRACE_EVENT_HEADER_SZ);
  89 }
  90
  91 #define __rte_trace_point_emit_header_generic(t) \
  92 void *mem; \
  93 do { \
  94         const uint64_t val = __atomic_load_n(t, __ATOMIC_ACQUIRE); \
  95         if (likely(!(val & __RTE_TRACE_FIELD_ENABLE_MASK))) \
  96                 return; \
  97         mem = __rte_trace_mem_get(val); \
  98         if (unlikely(mem == NULL)) \
  99                 return; \
 100         mem = __rte_trace_point_emit_ev_header(mem, val); \
 101 } while (0)
 102
 103 #define __rte_trace_point_emit_header_fp(t) \
 104         if (!__rte_trace_point_fp_is_enabled()) \
 105                 return; \
 106         __rte_trace_point_emit_header_generic(t)
 107
 108 #define __rte_trace_point_emit(in, type) \
 109 do { \
 110         memcpy(mem, &(in), sizeof(in)); \
 111         mem = RTE_PTR_ADD(mem, sizeof(in)); \
 112 } while (0)
 113
 114 #define rte_trace_point_emit_string(in) \
 115 do { \
 116         if (unlikely(in == NULL)) \
 117                 return; \
 118         rte_strscpy(mem, in, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
 119         mem = RTE_PTR_ADD(mem, __RTE_TRACE_EMIT_STRING_LEN_MAX); \
 120 } while (0)
 121
 122 #else
 123
 124 #define __rte_trace_point_emit_header_generic(t) RTE_SET_USED(t)
 125 #define __rte_trace_point_emit_header_fp(t) RTE_SET_USED(t)
 126 #define __rte_trace_point_emit(in, type) RTE_SET_USED(in)
 127 #define rte_trace_point_emit_string(in) RTE_SET_USED(in)
 128
 129 #endif
 130
 131 #endif /* _RTE_TRACE_POINT_PROVIDER_H_ */