1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
13 #include <sys/queue.h>
16 #include <rte_os_shim.h>
17 #include <rte_per_lcore.h>
20 #include "eal_private.h"
22 struct rte_log_dynamic_type {
27 /** The rte_log structure. */
28 static struct rte_logs {
29 uint32_t type; /**< Bitfield with enabled logs. */
30 uint32_t level; /**< Log level. */
31 FILE *file; /**< Output file set by rte_openlog_stream, or NULL. */
32 size_t dynamic_types_len;
33 struct rte_log_dynamic_type *dynamic_types;
36 .level = RTE_LOG_DEBUG,
39 struct rte_eal_opt_loglevel {
40 /** Next list entry */
41 TAILQ_ENTRY(rte_eal_opt_loglevel) next;
42 /** Compiled regular expression obtained from the option */
44 /** Globbing pattern option */
46 /** Log level value obtained from the option */
50 TAILQ_HEAD(rte_eal_opt_loglevel_list, rte_eal_opt_loglevel);
52 /** List of valid EAL log level options */
53 static struct rte_eal_opt_loglevel_list opt_loglevel_list =
54 TAILQ_HEAD_INITIALIZER(opt_loglevel_list);
56 /* Stream to use for logging if rte_logs.file is NULL */
57 static FILE *default_log_stream;
60 * This global structure stores some information about the message
61 * that is currently being processed by one lcore
64 uint32_t loglevel; /**< log level - see rte_log.h */
65 uint32_t logtype; /**< log type - see rte_log.h */
69 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
73 /* Change the stream that will be used by logging system */
75 rte_openlog_stream(FILE *f)
82 rte_log_get_stream(void)
84 FILE *f = rte_logs.file;
88 * Grab the current value of stderr here, rather than
89 * just initializing default_log_stream to stderr. This
90 * ensures that we will always use the current value
91 * of stderr, even if the application closes and
94 return default_log_stream ? : stderr;
99 /* Set global log level */
101 rte_log_set_global_level(uint32_t level)
103 rte_logs.level = (uint32_t)level;
106 /* Get global log level */
108 rte_log_get_global_level(void)
110 return rte_logs.level;
114 rte_log_get_level(uint32_t type)
116 if (type >= rte_logs.dynamic_types_len)
119 return rte_logs.dynamic_types[type].loglevel;
123 rte_log_can_log(uint32_t logtype, uint32_t level)
127 if (level > rte_log_get_global_level())
130 log_level = rte_log_get_level(logtype);
134 if (level > (uint32_t)log_level)
141 logtype_set_level(uint32_t type, uint32_t level)
143 uint32_t current = rte_logs.dynamic_types[type].loglevel;
145 if (current != level) {
146 rte_logs.dynamic_types[type].loglevel = level;
147 RTE_LOG(DEBUG, EAL, "%s log level changed from %s to %s\n",
148 rte_logs.dynamic_types[type].name == NULL ?
149 "" : rte_logs.dynamic_types[type].name,
150 eal_log_level2str(current),
151 eal_log_level2str(level));
156 rte_log_set_level(uint32_t type, uint32_t level)
158 if (type >= rte_logs.dynamic_types_len)
160 if (level > RTE_LOG_MAX)
163 logtype_set_level(type, level);
168 /* set log level by regular expression */
170 rte_log_set_level_regexp(const char *regex, uint32_t level)
175 if (level > RTE_LOG_MAX)
178 if (regcomp(&r, regex, 0) != 0)
181 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
182 if (rte_logs.dynamic_types[i].name == NULL)
184 if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
186 logtype_set_level(i, level);
195 * Save the type string and the loglevel for later dynamic
196 * logtypes which may register later.
199 log_save_level(uint32_t priority, const char *regex, const char *pattern)
201 struct rte_eal_opt_loglevel *opt_ll = NULL;
203 opt_ll = malloc(sizeof(*opt_ll));
207 opt_ll->level = priority;
210 opt_ll->pattern = NULL;
211 if (regcomp(&opt_ll->re_match, regex, 0) != 0)
213 } else if (pattern) {
214 opt_ll->pattern = strdup(pattern);
215 if (opt_ll->pattern == NULL)
220 TAILQ_INSERT_HEAD(&opt_loglevel_list, opt_ll, next);
228 eal_log_save_regexp(const char *regex, uint32_t level)
230 return log_save_level(level, regex, NULL);
233 /* set log level based on globbing pattern */
235 rte_log_set_level_pattern(const char *pattern, uint32_t level)
239 if (level > RTE_LOG_MAX)
242 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
243 if (rte_logs.dynamic_types[i].name == NULL)
246 if (fnmatch(pattern, rte_logs.dynamic_types[i].name, 0) == 0)
247 logtype_set_level(i, level);
254 eal_log_save_pattern(const char *pattern, uint32_t level)
256 return log_save_level(level, NULL, pattern);
259 /* get the current loglevel for the message being processed */
260 int rte_log_cur_msg_loglevel(void)
262 return RTE_PER_LCORE(log_cur_msg).loglevel;
265 /* get the current logtype for the message being processed */
266 int rte_log_cur_msg_logtype(void)
268 return RTE_PER_LCORE(log_cur_msg).logtype;
272 log_lookup(const char *name)
276 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
277 if (rte_logs.dynamic_types[i].name == NULL)
279 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
287 log_register(const char *name, uint32_t level)
289 struct rte_log_dynamic_type *new_dynamic_types;
292 id = log_lookup(name);
296 new_dynamic_types = realloc(rte_logs.dynamic_types,
297 sizeof(struct rte_log_dynamic_type) *
298 (rte_logs.dynamic_types_len + 1));
299 if (new_dynamic_types == NULL)
301 rte_logs.dynamic_types = new_dynamic_types;
303 id = rte_logs.dynamic_types_len;
304 memset(&rte_logs.dynamic_types[id], 0,
305 sizeof(rte_logs.dynamic_types[id]));
306 rte_logs.dynamic_types[id].name = strdup(name);
307 if (rte_logs.dynamic_types[id].name == NULL)
309 logtype_set_level(id, level);
311 rte_logs.dynamic_types_len++;
316 /* register an extended log type */
318 rte_log_register(const char *name)
320 return log_register(name, RTE_LOG_INFO);
323 /* Register an extended log type and try to pick its level from EAL options */
325 rte_log_register_type_and_pick_level(const char *name, uint32_t level_def)
327 struct rte_eal_opt_loglevel *opt_ll;
328 uint32_t level = level_def;
330 TAILQ_FOREACH(opt_ll, &opt_loglevel_list, next) {
331 if (opt_ll->level > RTE_LOG_MAX)
334 if (opt_ll->pattern) {
335 if (fnmatch(opt_ll->pattern, name, 0) == 0)
336 level = opt_ll->level;
338 if (regexec(&opt_ll->re_match, name, 0, NULL, 0) == 0)
339 level = opt_ll->level;
343 return log_register(name, level);
351 static const struct logtype logtype_strings[] = {
352 {RTE_LOGTYPE_EAL, "lib.eal"},
353 {RTE_LOGTYPE_MALLOC, "lib.malloc"},
354 {RTE_LOGTYPE_RING, "lib.ring"},
355 {RTE_LOGTYPE_MEMPOOL, "lib.mempool"},
356 {RTE_LOGTYPE_TIMER, "lib.timer"},
357 {RTE_LOGTYPE_PMD, "pmd"},
358 {RTE_LOGTYPE_HASH, "lib.hash"},
359 {RTE_LOGTYPE_LPM, "lib.lpm"},
360 {RTE_LOGTYPE_KNI, "lib.kni"},
361 {RTE_LOGTYPE_ACL, "lib.acl"},
362 {RTE_LOGTYPE_POWER, "lib.power"},
363 {RTE_LOGTYPE_METER, "lib.meter"},
364 {RTE_LOGTYPE_SCHED, "lib.sched"},
365 {RTE_LOGTYPE_PORT, "lib.port"},
366 {RTE_LOGTYPE_TABLE, "lib.table"},
367 {RTE_LOGTYPE_PIPELINE, "lib.pipeline"},
368 {RTE_LOGTYPE_MBUF, "lib.mbuf"},
369 {RTE_LOGTYPE_CRYPTODEV, "lib.cryptodev"},
370 {RTE_LOGTYPE_EFD, "lib.efd"},
371 {RTE_LOGTYPE_EVENTDEV, "lib.eventdev"},
372 {RTE_LOGTYPE_GSO, "lib.gso"},
373 {RTE_LOGTYPE_USER1, "user1"},
374 {RTE_LOGTYPE_USER2, "user2"},
375 {RTE_LOGTYPE_USER3, "user3"},
376 {RTE_LOGTYPE_USER4, "user4"},
377 {RTE_LOGTYPE_USER5, "user5"},
378 {RTE_LOGTYPE_USER6, "user6"},
379 {RTE_LOGTYPE_USER7, "user7"},
380 {RTE_LOGTYPE_USER8, "user8"}
383 /* Logging should be first initializer (before drivers and bus) */
384 RTE_INIT_PRIO(log_init, LOG)
388 rte_log_set_global_level(RTE_LOG_DEBUG);
390 rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
391 sizeof(struct rte_log_dynamic_type));
392 if (rte_logs.dynamic_types == NULL)
395 /* register legacy log types */
396 for (i = 0; i < RTE_DIM(logtype_strings); i++) {
397 rte_logs.dynamic_types[logtype_strings[i].log_id].name =
398 strdup(logtype_strings[i].logtype);
399 logtype_set_level(logtype_strings[i].log_id, RTE_LOG_INFO);
402 rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
406 eal_log_level2str(uint32_t level)
409 case 0: return "disabled";
410 case RTE_LOG_EMERG: return "emergency";
411 case RTE_LOG_ALERT: return "alert";
412 case RTE_LOG_CRIT: return "critical";
413 case RTE_LOG_ERR: return "error";
414 case RTE_LOG_WARNING: return "warning";
415 case RTE_LOG_NOTICE: return "notice";
416 case RTE_LOG_INFO: return "info";
417 case RTE_LOG_DEBUG: return "debug";
418 default: return "unknown";
423 log_type_compare(const void *a, const void *b)
425 const struct rte_log_dynamic_type *type_a = a;
426 const struct rte_log_dynamic_type *type_b = b;
428 if (type_a->name == NULL && type_b->name == NULL)
430 if (type_a->name == NULL)
432 if (type_b->name == NULL)
434 return strcmp(type_a->name, type_b->name);
437 /* Dump name of each logtype, one per line. */
439 rte_log_list_types(FILE *out, const char *prefix)
441 struct rte_log_dynamic_type *sorted_types;
442 const size_t type_size = sizeof(rte_logs.dynamic_types[0]);
443 const size_t type_count = rte_logs.dynamic_types_len;
444 const size_t total_size = type_size * type_count;
447 sorted_types = malloc(total_size);
448 if (sorted_types == NULL) {
449 /* no sorting - unlikely */
450 sorted_types = rte_logs.dynamic_types;
452 memcpy(sorted_types, rte_logs.dynamic_types, total_size);
453 qsort(sorted_types, type_count, type_size, log_type_compare);
456 for (type = 0; type < type_count; ++type) {
457 if (sorted_types[type].name == NULL)
459 fprintf(out, "%s%s\n", prefix, sorted_types[type].name);
462 if (sorted_types != rte_logs.dynamic_types)
466 /* dump global level and registered log types */
468 rte_log_dump(FILE *f)
472 fprintf(f, "global log level is %s\n",
473 eal_log_level2str(rte_log_get_global_level()));
475 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
476 if (rte_logs.dynamic_types[i].name == NULL)
478 fprintf(f, "id %zu: %s, level is %s\n",
479 i, rte_logs.dynamic_types[i].name,
480 eal_log_level2str(rte_logs.dynamic_types[i].loglevel));
485 * Generates a log message The message will be sent in the stream
486 * defined by the previous call to rte_openlog_stream().
489 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
491 FILE *f = rte_log_get_stream();
494 if (logtype >= rte_logs.dynamic_types_len)
496 if (!rte_log_can_log(logtype, level))
499 /* save loglevel and logtype in a global per-lcore variable */
500 RTE_PER_LCORE(log_cur_msg).loglevel = level;
501 RTE_PER_LCORE(log_cur_msg).logtype = logtype;
503 ret = vfprintf(f, format, ap);
509 * Generates a log message The message will be sent in the stream
510 * defined by the previous call to rte_openlog_stream().
511 * No need to check level here, done by rte_vlog().
514 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
519 va_start(ap, format);
520 ret = rte_vlog(level, logtype, format, ap);
526 * Called by environment-specific initialization functions.
529 eal_log_set_default(FILE *default_log)
531 default_log_stream = default_log;
533 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
535 "Debug dataplane logs available - lower performance\n");
540 * Called by eal_cleanup
543 rte_eal_log_cleanup(void)
545 if (default_log_stream) {
546 fclose(default_log_stream);
547 default_log_stream = NULL;