1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(C) 2020 Marvell International Ltd.
10 #include <rte_common.h>
11 #include <rte_errno.h>
12 #include <rte_lcore.h>
13 #include <rte_per_lcore.h>
14 #include <rte_string_fns.h>
16 #include "eal_trace.h"
18 RTE_DEFINE_PER_LCORE(volatile int, trace_point_sz);
19 RTE_DEFINE_PER_LCORE(void *, trace_mem);
20 static RTE_DEFINE_PER_LCORE(char *, ctf_field);
22 static struct trace_point_head tp_list = STAILQ_HEAD_INITIALIZER(tp_list);
23 static struct trace trace = { .args = STAILQ_HEAD_INITIALIZER(trace.args), };
31 struct trace_point_head *
32 trace_list_head_get(void)
40 struct trace_arg *arg;
42 /* Trace memory should start with 8B aligned for natural alignment */
43 RTE_BUILD_BUG_ON((offsetof(struct __rte_trace_header, mem) % 8) != 0);
45 /* One of the trace point registration failed */
46 if (trace.register_errno) {
47 rte_errno = trace.register_errno;
51 if (!STAILQ_EMPTY(&trace.args))
54 if (!rte_trace_is_enabled())
57 rte_spinlock_init(&trace.lock);
59 /* Is duplicate trace name registered */
60 if (trace_has_duplicate_entry())
63 /* Generate UUID ver 4 with total size of events and number of
66 trace_uuid_generate();
68 /* Apply buffer size configuration for trace output */
69 trace_bufsz_args_apply();
71 /* Generate CTF TDSL metadata */
72 if (trace_metadata_create() < 0)
75 /* Create trace directory */
79 /* Save current epoch timestamp for future use */
80 if (trace_epoch_time_save() < 0)
83 /* Apply global configurations */
84 STAILQ_FOREACH(arg, &trace.args, next)
85 trace_args_apply(arg->val);
87 rte_trace_mode_set(trace.mode);
92 trace_metadata_destroy();
94 trace_err("failed to initialize trace [%s]", rte_strerror(rte_errno));
101 if (!rte_trace_is_enabled())
104 trace_metadata_destroy();
105 eal_trace_args_free();
109 rte_trace_is_enabled(void)
115 trace_mode_set(rte_trace_point_t *trace, enum rte_trace_mode mode)
117 if (mode == RTE_TRACE_MODE_OVERWRITE)
118 __atomic_and_fetch(trace, ~__RTE_TRACE_FIELD_ENABLE_DISCARD,
121 __atomic_or_fetch(trace, __RTE_TRACE_FIELD_ENABLE_DISCARD,
126 rte_trace_mode_set(enum rte_trace_mode mode)
128 struct trace_point *tp;
130 if (!rte_trace_is_enabled())
133 STAILQ_FOREACH(tp, &tp_list, next)
134 trace_mode_set(tp->handle, mode);
140 rte_trace_mode rte_trace_mode_get(void)
146 trace_point_is_invalid(rte_trace_point_t *t)
148 return (t == NULL) || (trace_id_get(t) >= trace.nb_trace_points);
152 rte_trace_point_is_enabled(rte_trace_point_t *trace)
156 if (trace_point_is_invalid(trace))
159 val = __atomic_load_n(trace, __ATOMIC_ACQUIRE);
160 return (val & __RTE_TRACE_FIELD_ENABLE_MASK) != 0;
164 rte_trace_point_enable(rte_trace_point_t *trace)
166 if (trace_point_is_invalid(trace))
169 __atomic_or_fetch(trace, __RTE_TRACE_FIELD_ENABLE_MASK,
175 rte_trace_point_disable(rte_trace_point_t *trace)
177 if (trace_point_is_invalid(trace))
180 __atomic_and_fetch(trace, ~__RTE_TRACE_FIELD_ENABLE_MASK,
186 rte_trace_pattern(const char *pattern, bool enable)
188 struct trace_point *tp;
189 int rc = 0, found = 0;
191 STAILQ_FOREACH(tp, &tp_list, next) {
192 if (fnmatch(pattern, tp->name, 0) == 0) {
194 rc = rte_trace_point_enable(tp->handle);
196 rc = rte_trace_point_disable(tp->handle);
207 rte_trace_regexp(const char *regex, bool enable)
209 struct trace_point *tp;
210 int rc = 0, found = 0;
213 if (regcomp(&r, regex, 0) != 0)
216 STAILQ_FOREACH(tp, &tp_list, next) {
217 if (regexec(&r, tp->name, 0, NULL, 0) == 0) {
219 rc = rte_trace_point_enable(tp->handle);
221 rc = rte_trace_point_disable(tp->handle);
233 rte_trace_point_lookup(const char *name)
235 struct trace_point *tp;
240 STAILQ_FOREACH(tp, &tp_list, next)
241 if (strncmp(tp->name, name, TRACE_POINT_NAME_SIZE) == 0)
248 trace_point_dump(FILE *f, struct trace_point *tp)
250 rte_trace_point_t *handle = tp->handle;
252 fprintf(f, "\tid %d, %s, size is %d, %s\n",
253 trace_id_get(handle), tp->name,
254 (uint16_t)(*handle & __RTE_TRACE_FIELD_SIZE_MASK),
255 rte_trace_point_is_enabled(handle) ? "enabled" : "disabled");
259 trace_lcore_mem_dump(FILE *f)
261 struct trace *trace = trace_obj_get();
262 struct __rte_trace_header *header;
265 if (trace->nb_trace_mem_list == 0)
268 rte_spinlock_lock(&trace->lock);
269 fprintf(f, "nb_trace_mem_list = %d\n", trace->nb_trace_mem_list);
270 fprintf(f, "\nTrace mem info\n--------------\n");
271 for (count = 0; count < trace->nb_trace_mem_list; count++) {
272 header = trace->lcore_meta[count].mem;
273 fprintf(f, "\tid %d, mem=%p, area=%s, lcore_id=%d, name=%s\n",
275 trace_area_to_string(trace->lcore_meta[count].area),
276 header->stream_header.lcore_id,
277 header->stream_header.thread_name);
279 rte_spinlock_unlock(&trace->lock);
283 rte_trace_dump(FILE *f)
285 struct trace_point_head *tp_list = trace_list_head_get();
286 struct trace *trace = trace_obj_get();
287 struct trace_point *tp;
289 fprintf(f, "\nGlobal info\n-----------\n");
290 fprintf(f, "status = %s\n",
291 rte_trace_is_enabled() ? "enabled" : "disabled");
292 fprintf(f, "mode = %s\n",
293 trace_mode_to_string(rte_trace_mode_get()));
294 fprintf(f, "dir = %s\n", trace->dir);
295 fprintf(f, "buffer len = %d\n", trace->buff_len);
296 fprintf(f, "number of trace points = %d\n", trace->nb_trace_points);
298 trace_lcore_mem_dump(f);
299 fprintf(f, "\nTrace point info\n----------------\n");
300 STAILQ_FOREACH(tp, tp_list, next)
301 trace_point_dump(f, tp);
305 __rte_trace_mem_per_thread_alloc(void)
307 struct trace *trace = trace_obj_get();
308 struct __rte_trace_header *header;
311 if (!rte_trace_is_enabled())
314 if (RTE_PER_LCORE(trace_mem))
317 rte_spinlock_lock(&trace->lock);
319 count = trace->nb_trace_mem_list;
321 /* Allocate room for storing the thread trace mem meta */
322 trace->lcore_meta = realloc(trace->lcore_meta,
323 sizeof(trace->lcore_meta[0]) * (count + 1));
325 /* Provide dummy space for fast path to consume */
326 if (trace->lcore_meta == NULL) {
327 trace_crit("trace mem meta memory realloc failed");
332 /* First attempt from huge page */
333 header = eal_malloc_no_trace(NULL, trace_mem_sz(trace->buff_len), 8);
335 trace->lcore_meta[count].area = TRACE_AREA_HUGEPAGE;
339 /* Second attempt from heap */
340 header = malloc(trace_mem_sz(trace->buff_len));
341 if (header == NULL) {
342 trace_crit("trace mem malloc attempt failed");
348 /* Second attempt from heap is success */
349 trace->lcore_meta[count].area = TRACE_AREA_HEAP;
351 /* Initialize the trace header */
354 header->len = trace->buff_len;
355 header->stream_header.magic = TRACE_CTF_MAGIC;
356 rte_uuid_copy(header->stream_header.uuid, trace->uuid);
357 header->stream_header.lcore_id = rte_lcore_id();
359 /* Store the thread name */
360 char *name = header->stream_header.thread_name;
361 memset(name, 0, __RTE_TRACE_EMIT_STRING_LEN_MAX);
362 rte_thread_getname(pthread_self(), name,
363 __RTE_TRACE_EMIT_STRING_LEN_MAX);
365 trace->lcore_meta[count].mem = header;
366 trace->nb_trace_mem_list++;
368 RTE_PER_LCORE(trace_mem) = header;
369 rte_spinlock_unlock(&trace->lock);
373 trace_mem_per_thread_free_unlocked(struct thread_mem_meta *meta)
375 if (meta->area == TRACE_AREA_HUGEPAGE)
376 eal_free_no_trace(meta->mem);
377 else if (meta->area == TRACE_AREA_HEAP)
382 trace_mem_per_thread_free(void)
384 struct trace *trace = trace_obj_get();
385 struct __rte_trace_header *header;
388 header = RTE_PER_LCORE(trace_mem);
392 rte_spinlock_lock(&trace->lock);
393 for (count = 0; count < trace->nb_trace_mem_list; count++) {
394 if (trace->lcore_meta[count].mem == header)
397 if (count != trace->nb_trace_mem_list) {
398 struct thread_mem_meta *meta = &trace->lcore_meta[count];
400 trace_mem_per_thread_free_unlocked(meta);
401 if (count != trace->nb_trace_mem_list - 1) {
402 memmove(meta, meta + 1,
404 (trace->nb_trace_mem_list - count - 1));
406 trace->nb_trace_mem_list--;
408 rte_spinlock_unlock(&trace->lock);
414 struct trace *trace = trace_obj_get();
417 if (!rte_trace_is_enabled())
420 rte_spinlock_lock(&trace->lock);
421 for (count = 0; count < trace->nb_trace_mem_list; count++) {
422 trace_mem_per_thread_free_unlocked(&trace->lcore_meta[count]);
424 trace->nb_trace_mem_list = 0;
425 rte_spinlock_unlock(&trace->lock);
429 __rte_trace_point_emit_field(size_t sz, const char *in, const char *datatype)
435 fixup = trace_metadata_fixup_field(in);
438 rc = asprintf(&field, "%s %s %s;\n",
439 RTE_PER_LCORE(ctf_field) != NULL ?
440 RTE_PER_LCORE(ctf_field) : "",
442 free(RTE_PER_LCORE(ctf_field));
445 RTE_PER_LCORE(trace_point_sz) = 0;
446 RTE_PER_LCORE(ctf_field) = NULL;
447 trace_crit("could not allocate CTF field");
450 RTE_PER_LCORE(trace_point_sz) += sz;
451 RTE_PER_LCORE(ctf_field) = field;
455 __rte_trace_point_register(rte_trace_point_t *handle, const char *name,
456 void (*register_fn)(void))
458 struct trace_point *tp;
461 /* Sanity checks of arguments */
462 if (name == NULL || register_fn == NULL || handle == NULL) {
463 trace_err("invalid arguments");
468 /* Check the size of the trace point object */
469 RTE_PER_LCORE(trace_point_sz) = 0;
471 if (RTE_PER_LCORE(trace_point_sz) == 0) {
472 trace_err("missing rte_trace_emit_header() in register fn");
477 /* Is size overflowed */
478 if (RTE_PER_LCORE(trace_point_sz) > UINT16_MAX) {
479 trace_err("trace point size overflowed");
484 /* Are we running out of space to store trace points? */
485 if (trace.nb_trace_points > UINT16_MAX) {
486 trace_err("trace point exceeds the max count");
491 /* Get the size of the trace point */
492 sz = RTE_PER_LCORE(trace_point_sz);
493 tp = calloc(1, sizeof(struct trace_point));
495 trace_err("fail to allocate trace point memory");
500 /* Initialize the trace point */
501 if (rte_strscpy(tp->name, name, TRACE_POINT_NAME_SIZE) < 0) {
502 trace_err("name is too long");
506 /* Copy the accumulated fields description and clear it for the next
509 tp->ctf_field = RTE_PER_LCORE(ctf_field);
510 RTE_PER_LCORE(ctf_field) = NULL;
512 /* Form the trace handle */
514 *handle |= trace.nb_trace_points << __RTE_TRACE_FIELD_ID_SHIFT;
516 trace.nb_trace_points++;
519 /* Add the trace point at tail */
520 STAILQ_INSERT_TAIL(&tp_list, tp, next);
521 __atomic_thread_fence(__ATOMIC_RELEASE);
528 if (trace.register_errno == 0)
529 trace.register_errno = rte_errno;