1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
16 #include <rte_per_lcore.h>
18 #include "eal_private.h"
20 /* global log structure */
21 struct rte_logs rte_logs = {
23 .level = RTE_LOG_DEBUG,
27 struct rte_eal_opt_loglevel {
28 /** Next list entry */
29 TAILQ_ENTRY(rte_eal_opt_loglevel) next;
30 /** Compiled regular expression obtained from the option */
32 /** Globbing pattern option */
34 /** Log level value obtained from the option */
38 TAILQ_HEAD(rte_eal_opt_loglevel_list, rte_eal_opt_loglevel);
40 /** List of valid EAL log level options */
41 static struct rte_eal_opt_loglevel_list opt_loglevel_list =
42 TAILQ_HEAD_INITIALIZER(opt_loglevel_list);
44 /* Stream to use for logging if rte_logs.file is NULL */
45 static FILE *default_log_stream;
48 * This global structure stores some information about the message
49 * that is currently being processed by one lcore
52 uint32_t loglevel; /**< log level - see rte_log.h */
53 uint32_t logtype; /**< log type - see rte_log.h */
56 struct rte_log_dynamic_type {
62 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
66 /* Change the stream that will be used by logging system */
68 rte_openlog_stream(FILE *f)
75 rte_log_get_stream(void)
77 FILE *f = rte_logs.file;
81 * Grab the current value of stderr here, rather than
82 * just initializing default_log_stream to stderr. This
83 * ensures that we will always use the current value
84 * of stderr, even if the application closes and
87 return default_log_stream ? : stderr;
92 /* Set global log level */
94 rte_log_set_global_level(uint32_t level)
96 rte_logs.level = (uint32_t)level;
99 /* Get global log level */
101 rte_log_get_global_level(void)
103 return rte_logs.level;
107 rte_log_get_level(uint32_t type)
109 if (type >= rte_logs.dynamic_types_len)
112 return rte_logs.dynamic_types[type].loglevel;
116 rte_log_can_log(uint32_t logtype, uint32_t level)
120 if (level > rte_log_get_global_level())
123 log_level = rte_log_get_level(logtype);
127 if (level > (uint32_t)log_level)
134 rte_log_set_level(uint32_t type, uint32_t level)
136 if (type >= rte_logs.dynamic_types_len)
138 if (level > RTE_LOG_DEBUG)
141 rte_logs.dynamic_types[type].loglevel = level;
146 /* set log level by regular expression */
148 rte_log_set_level_regexp(const char *regex, uint32_t level)
153 if (level > RTE_LOG_DEBUG)
156 if (regcomp(&r, regex, 0) != 0)
159 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
160 if (rte_logs.dynamic_types[i].name == NULL)
162 if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
164 rte_logs.dynamic_types[i].loglevel = level;
173 * Save the type string and the loglevel for later dynamic
174 * logtypes which may register later.
176 static int rte_log_save_level(int priority,
177 const char *regex, const char *pattern)
179 struct rte_eal_opt_loglevel *opt_ll = NULL;
181 opt_ll = malloc(sizeof(*opt_ll));
185 opt_ll->level = priority;
188 opt_ll->pattern = NULL;
189 if (regcomp(&opt_ll->re_match, regex, 0) != 0)
191 } else if (pattern) {
192 opt_ll->pattern = strdup(pattern);
193 if (opt_ll->pattern == NULL)
198 TAILQ_INSERT_HEAD(&opt_loglevel_list, opt_ll, next);
205 int rte_log_save_regexp(const char *regex, int tmp)
207 return rte_log_save_level(tmp, regex, NULL);
210 /* set log level based on globbing pattern */
212 rte_log_set_level_pattern(const char *pattern, uint32_t level)
216 if (level > RTE_LOG_DEBUG)
219 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
220 if (rte_logs.dynamic_types[i].name == NULL)
223 if (fnmatch(pattern, rte_logs.dynamic_types[i].name, 0) == 0)
224 rte_logs.dynamic_types[i].loglevel = level;
230 int rte_log_save_pattern(const char *pattern, int priority)
232 return rte_log_save_level(priority, NULL, pattern);
235 /* get the current loglevel for the message being processed */
236 int rte_log_cur_msg_loglevel(void)
238 return RTE_PER_LCORE(log_cur_msg).loglevel;
241 /* get the current logtype for the message being processed */
242 int rte_log_cur_msg_logtype(void)
244 return RTE_PER_LCORE(log_cur_msg).logtype;
248 rte_log_lookup(const char *name)
252 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
253 if (rte_logs.dynamic_types[i].name == NULL)
255 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
262 /* register an extended log type, assuming table is large enough, and id
263 * is not yet registered.
266 __rte_log_register(const char *name, int id)
268 char *dup_name = strdup(name);
270 if (dup_name == NULL)
273 rte_logs.dynamic_types[id].name = dup_name;
274 rte_logs.dynamic_types[id].loglevel = RTE_LOG_INFO;
279 /* register an extended log type */
281 rte_log_register(const char *name)
283 struct rte_log_dynamic_type *new_dynamic_types;
286 id = rte_log_lookup(name);
290 new_dynamic_types = realloc(rte_logs.dynamic_types,
291 sizeof(struct rte_log_dynamic_type) *
292 (rte_logs.dynamic_types_len + 1));
293 if (new_dynamic_types == NULL)
295 rte_logs.dynamic_types = new_dynamic_types;
297 ret = __rte_log_register(name, rte_logs.dynamic_types_len);
301 rte_logs.dynamic_types_len++;
306 /* Register an extended log type and try to pick its level from EAL options */
308 rte_log_register_type_and_pick_level(const char *name, uint32_t level_def)
310 struct rte_eal_opt_loglevel *opt_ll;
311 uint32_t level = level_def;
314 type = rte_log_register(name);
318 TAILQ_FOREACH(opt_ll, &opt_loglevel_list, next) {
319 if (opt_ll->level > RTE_LOG_DEBUG)
322 if (opt_ll->pattern) {
323 if (fnmatch(opt_ll->pattern, name, 0) == 0)
324 level = opt_ll->level;
326 if (regexec(&opt_ll->re_match, name, 0, NULL, 0) == 0)
327 level = opt_ll->level;
331 rte_logs.dynamic_types[type].loglevel = level;
341 static const struct logtype logtype_strings[] = {
342 {RTE_LOGTYPE_EAL, "lib.eal"},
343 {RTE_LOGTYPE_MALLOC, "lib.malloc"},
344 {RTE_LOGTYPE_RING, "lib.ring"},
345 {RTE_LOGTYPE_MEMPOOL, "lib.mempool"},
346 {RTE_LOGTYPE_TIMER, "lib.timer"},
347 {RTE_LOGTYPE_PMD, "pmd"},
348 {RTE_LOGTYPE_HASH, "lib.hash"},
349 {RTE_LOGTYPE_LPM, "lib.lpm"},
350 {RTE_LOGTYPE_KNI, "lib.kni"},
351 {RTE_LOGTYPE_ACL, "lib.acl"},
352 {RTE_LOGTYPE_POWER, "lib.power"},
353 {RTE_LOGTYPE_METER, "lib.meter"},
354 {RTE_LOGTYPE_SCHED, "lib.sched"},
355 {RTE_LOGTYPE_PORT, "lib.port"},
356 {RTE_LOGTYPE_TABLE, "lib.table"},
357 {RTE_LOGTYPE_PIPELINE, "lib.pipeline"},
358 {RTE_LOGTYPE_MBUF, "lib.mbuf"},
359 {RTE_LOGTYPE_CRYPTODEV, "lib.cryptodev"},
360 {RTE_LOGTYPE_EFD, "lib.efd"},
361 {RTE_LOGTYPE_EVENTDEV, "lib.eventdev"},
362 {RTE_LOGTYPE_GSO, "lib.gso"},
363 {RTE_LOGTYPE_USER1, "user1"},
364 {RTE_LOGTYPE_USER2, "user2"},
365 {RTE_LOGTYPE_USER3, "user3"},
366 {RTE_LOGTYPE_USER4, "user4"},
367 {RTE_LOGTYPE_USER5, "user5"},
368 {RTE_LOGTYPE_USER6, "user6"},
369 {RTE_LOGTYPE_USER7, "user7"},
370 {RTE_LOGTYPE_USER8, "user8"}
373 /* Logging should be first initializer (before drivers and bus) */
374 RTE_INIT_PRIO(rte_log_init, LOG)
378 rte_log_set_global_level(RTE_LOG_DEBUG);
380 rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
381 sizeof(struct rte_log_dynamic_type));
382 if (rte_logs.dynamic_types == NULL)
385 /* register legacy log types */
386 for (i = 0; i < RTE_DIM(logtype_strings); i++)
387 __rte_log_register(logtype_strings[i].logtype,
388 logtype_strings[i].log_id);
390 rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
394 loglevel_to_string(uint32_t level)
397 case 0: return "disabled";
398 case RTE_LOG_EMERG: return "emerg";
399 case RTE_LOG_ALERT: return "alert";
400 case RTE_LOG_CRIT: return "critical";
401 case RTE_LOG_ERR: return "error";
402 case RTE_LOG_WARNING: return "warning";
403 case RTE_LOG_NOTICE: return "notice";
404 case RTE_LOG_INFO: return "info";
405 case RTE_LOG_DEBUG: return "debug";
406 default: return "unknown";
410 /* dump global level and registered log types */
412 rte_log_dump(FILE *f)
416 fprintf(f, "global log level is %s\n",
417 loglevel_to_string(rte_log_get_global_level()));
419 for (i = 0; i < rte_logs.dynamic_types_len; i++) {
420 if (rte_logs.dynamic_types[i].name == NULL)
422 fprintf(f, "id %zu: %s, level is %s\n",
423 i, rte_logs.dynamic_types[i].name,
424 loglevel_to_string(rte_logs.dynamic_types[i].loglevel));
429 * Generates a log message The message will be sent in the stream
430 * defined by the previous call to rte_openlog_stream().
433 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
435 FILE *f = rte_log_get_stream();
438 if (logtype >= rte_logs.dynamic_types_len)
440 if (!rte_log_can_log(logtype, level))
443 /* save loglevel and logtype in a global per-lcore variable */
444 RTE_PER_LCORE(log_cur_msg).loglevel = level;
445 RTE_PER_LCORE(log_cur_msg).logtype = logtype;
447 ret = vfprintf(f, format, ap);
453 * Generates a log message The message will be sent in the stream
454 * defined by the previous call to rte_openlog_stream().
455 * No need to check level here, done by rte_vlog().
458 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
463 va_start(ap, format);
464 ret = rte_vlog(level, logtype, format, ap);
470 * Called by environment-specific initialization functions.
473 eal_log_set_default(FILE *default_log)
475 default_log_stream = default_log;
477 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
479 "Debug dataplane logs available - lower performance\n");