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_string_fns.h>
14 #include "eal_filesystem.h"
15 #include "eal_trace.h"
18 trace_mode_to_string(enum rte_trace_mode mode)
21 case RTE_TRACE_MODE_OVERWRITE: return "overwrite";
22 case RTE_TRACE_MODE_DISCARD: return "discard";
23 default: return "unknown";
28 trace_area_to_string(enum trace_area_e area)
31 case TRACE_AREA_HEAP: return "heap";
32 case TRACE_AREA_HUGEPAGE: return "hugepage";
33 default: return "unknown";
38 trace_entry_compare(const char *name)
40 struct trace_point_head *tp_list = trace_list_head_get();
41 struct trace_point *tp;
44 STAILQ_FOREACH(tp, tp_list, next) {
45 if (strncmp(tp->name, name, TRACE_POINT_NAME_SIZE) == 0)
48 trace_err("found duplicate entry %s", name);
57 trace_has_duplicate_entry(void)
59 struct trace_point_head *tp_list = trace_list_head_get();
60 struct trace_point *tp;
62 /* Is duplicate trace name registered */
63 STAILQ_FOREACH(tp, tp_list, next)
64 if (trace_entry_compare(tp->name))
71 trace_uuid_generate(void)
73 struct trace_point_head *tp_list = trace_list_head_get();
74 struct trace *trace = trace_obj_get();
75 struct trace_point *tp;
76 uint64_t sz_total = 0;
78 /* Go over the registered trace points to get total size of events */
79 STAILQ_FOREACH(tp, tp_list, next) {
80 const uint16_t sz = *tp->handle & __RTE_TRACE_FIELD_SIZE_MASK;
84 rte_uuid_t uuid = RTE_UUID_INIT(sz_total, trace->nb_trace_points,
85 0x4370, 0x8f50, 0x222ddd514176ULL);
86 rte_uuid_copy(trace->uuid, uuid);
90 trace_session_name_generate(char *trace_dir)
100 tm_result = localtime(&tm);
101 if (tm_result == NULL)
104 rc = rte_strscpy(trace_dir, eal_get_hugefile_prefix(),
107 rc = TRACE_PREFIX_LEN;
108 trace_dir[rc++] = '-';
110 rc = strftime(trace_dir + rc, TRACE_DIR_STR_LEN - rc,
111 "%Y-%m-%d-%p-%I-%M-%S", tm_result);
122 trace_dir_update(const char *str)
124 struct trace *trace = trace_obj_get();
127 remaining = sizeof(trace->dir) - trace->dir_offset;
128 rc = rte_strscpy(&trace->dir[0] + trace->dir_offset, str, remaining);
132 trace->dir_offset += rc;
138 eal_trace_args_save(const char *val)
140 struct trace *trace = trace_obj_get();
141 struct trace_arg *arg = malloc(sizeof(*arg));
144 trace_err("failed to allocate memory for %s", val);
148 arg->val = strdup(val);
149 if (arg->val == NULL) {
150 trace_err("failed to allocate memory for %s", val);
155 STAILQ_INSERT_TAIL(&trace->args, arg, next);
160 eal_trace_args_free(void)
162 struct trace *trace = trace_obj_get();
163 struct trace_arg *arg;
165 while (!STAILQ_EMPTY(&trace->args)) {
166 arg = STAILQ_FIRST(&trace->args);
167 STAILQ_REMOVE_HEAD(&trace->args, next);
174 trace_args_apply(const char *arg)
176 if (rte_trace_regexp(arg, true) < 0) {
177 trace_err("cannot enable trace for %s", arg);
185 eal_trace_bufsz_args_save(char const *val)
187 struct trace *trace = trace_obj_get();
190 bufsz = rte_str_to_size(val);
192 trace_err("buffer size cannot be zero");
196 trace->buff_len = bufsz;
201 trace_bufsz_args_apply(void)
203 struct trace *trace = trace_obj_get();
205 if (trace->buff_len == 0)
206 trace->buff_len = 1024 * 1024; /* 1MB */
210 eal_trace_mode_args_save(const char *val)
212 struct trace *trace = trace_obj_get();
213 size_t len = strlen(val);
218 trace_err("value is not provided with option");
222 pattern = (char *)calloc(1, len + 2);
223 if (pattern == NULL) {
224 trace_err("fail to allocate memory");
228 sprintf(pattern, "%s*", val);
230 if (fnmatch(pattern, "overwrite", 0) == 0)
231 tmp = RTE_TRACE_MODE_OVERWRITE;
232 else if (fnmatch(pattern, "discard", 0) == 0)
233 tmp = RTE_TRACE_MODE_DISCARD;
245 eal_trace_dir_args_save(char const *val)
247 struct trace *trace = trace_obj_get();
251 if (strlen(val) >= sizeof(trace->dir) - 1) {
252 trace_err("input string is too big");
253 return -ENAMETOOLONG;
256 if (asprintf(&dir_path, "%s/", val) == -1) {
257 trace_err("failed to copy directory: %s", strerror(errno));
261 rc = trace_dir_update(dir_path);
268 trace_epoch_time_save(void)
270 struct trace *trace = trace_obj_get();
271 struct timespec epoch = { 0, 0 };
272 uint64_t avg, start, end;
274 start = rte_get_tsc_cycles();
275 if (clock_gettime(CLOCK_REALTIME, &epoch) < 0) {
276 trace_err("failed to get the epoch time");
279 end = rte_get_tsc_cycles();
280 avg = (start + end) >> 1;
282 trace->epoch_sec = (uint64_t) epoch.tv_sec;
283 trace->epoch_nsec = (uint64_t) epoch.tv_nsec;
284 trace->uptime_ticks = avg;
290 trace_dir_default_path_get(char *dir_path)
292 struct trace *trace = trace_obj_get();
293 uint32_t size = sizeof(trace->dir);
297 /* First check for shell environment variable */
298 home_dir = getenv("HOME");
299 if (home_dir == NULL) {
300 /* Fallback to password file entry */
301 pwd = getpwuid(getuid());
305 home_dir = pwd->pw_dir;
308 /* Append dpdk-traces to directory */
309 if (snprintf(dir_path, size, "%s/dpdk-traces/", home_dir) < 0)
310 return -ENAMETOOLONG;
318 struct trace *trace = trace_obj_get();
319 char session[TRACE_DIR_STR_LEN];
323 if (!trace->dir_offset) {
324 dir_path = calloc(1, sizeof(trace->dir));
325 if (dir_path == NULL) {
326 trace_err("fail to allocate memory");
330 rc = trace_dir_default_path_get(dir_path);
332 trace_err("fail to get default path");
337 rc = trace_dir_update(dir_path);
343 /* Create the path if it t exist, no "mkdir -p" available here */
344 rc = mkdir(trace->dir, 0700);
345 if (rc < 0 && errno != EEXIST) {
346 trace_err("mkdir %s failed [%s]", trace->dir, strerror(errno));
351 rc = trace_session_name_generate(session);
354 rc = trace_dir_update(session);
358 rc = mkdir(trace->dir, 0700);
360 trace_err("mkdir %s failed [%s]", trace->dir, strerror(errno));
365 RTE_LOG(INFO, EAL, "Trace dir: %s\n", trace->dir);
370 trace_meta_save(struct trace *trace)
372 char file_name[PATH_MAX];
376 rc = snprintf(file_name, PATH_MAX, "%s/metadata", trace->dir);
380 f = fopen(file_name, "w");
384 rc = rte_trace_metadata_dump(f);
394 trace_file_sz(struct __rte_trace_header *hdr)
396 return sizeof(struct __rte_trace_stream_header) + hdr->offset;
400 trace_mem_save(struct trace *trace, struct __rte_trace_header *hdr,
403 char file_name[PATH_MAX];
407 rc = snprintf(file_name, PATH_MAX, "%s/channel0_%d", trace->dir, cnt);
411 f = fopen(file_name, "w");
415 rc = fwrite(&hdr->stream_header, trace_file_sz(hdr), 1, f);
416 rc = (rc == 1) ? 0 : -EACCES;
427 struct trace *trace = trace_obj_get();
428 struct __rte_trace_header *header;
432 if (trace->nb_trace_mem_list == 0)
435 rc = trace_meta_save(trace);
439 rte_spinlock_lock(&trace->lock);
440 for (count = 0; count < trace->nb_trace_mem_list; count++) {
441 header = trace->lcore_meta[count].mem;
442 rc = trace_mem_save(trace, header, count);
446 rte_spinlock_unlock(&trace->lock);