lib/librte_eal/common/eal_common_log.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdint.h>
   7 #include <stdarg.h>
   8 #include <stdlib.h>
   9 #include <string.h>
  10 #include <errno.h>
  11 #include <regex.h>
  12
  13 #include <rte_eal.h>
  14 #include <rte_log.h>
  15 #include <rte_per_lcore.h>
  16
  17 #include "eal_private.h"
  18
  19 /* global log structure */
  20 struct rte_logs rte_logs = {
  21         .type = ~0,
  22         .level = RTE_LOG_DEBUG,
  23         .file = NULL,
  24 };
  25
  26 /* Stream to use for logging if rte_logs.file is NULL */
  27 static FILE *default_log_stream;
  28
  29 /**
  30  * This global structure stores some informations about the message
  31  * that is currently being processed by one lcore
  32  */
  33 struct log_cur_msg {
  34         uint32_t loglevel; /**< log level - see rte_log.h */
  35         uint32_t logtype;  /**< log type  - see rte_log.h */
  36 };
  37
  38 struct rte_log_dynamic_type {
  39         const char *name;
  40         uint32_t loglevel;
  41 };
  42
  43  /* per core log */
  44 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
  45
  46 /* default logs */
  47
  48 /* Change the stream that will be used by logging system */
  49 int
  50 rte_openlog_stream(FILE *f)
  51 {
  52         rte_logs.file = f;
  53         return 0;
  54 }
  55
  56 /* Set global log level */
  57 void
  58 rte_log_set_global_level(uint32_t level)
  59 {
  60         rte_logs.level = (uint32_t)level;
  61 }
  62
  63 /* Get global log level */
  64 uint32_t
  65 rte_log_get_global_level(void)
  66 {
  67         return rte_logs.level;
  68 }
  69
  70 int
  71 rte_log_get_level(uint32_t type)
  72 {
  73         if (type >= rte_logs.dynamic_types_len)
  74                 return -1;
  75
  76         return rte_logs.dynamic_types[type].loglevel;
  77 }
  78
  79 int
  80 rte_log_set_level(uint32_t type, uint32_t level)
  81 {
  82         if (type >= rte_logs.dynamic_types_len)
  83                 return -1;
  84         if (level > RTE_LOG_DEBUG)
  85                 return -1;
  86
  87         rte_logs.dynamic_types[type].loglevel = level;
  88
  89         return 0;
  90 }
  91
  92 /* set level */
  93 int
  94 rte_log_set_level_regexp(const char *pattern, uint32_t level)
  95 {
  96         regex_t r;
  97         size_t i;
  98
  99         if (level > RTE_LOG_DEBUG)
 100                 return -1;
 101
 102         if (regcomp(&r, pattern, 0) != 0)
 103                 return -1;
 104
 105         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 106                 if (rte_logs.dynamic_types[i].name == NULL)
 107                         continue;
 108                 if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
 109                                 NULL, 0) == 0)
 110                         rte_logs.dynamic_types[i].loglevel = level;
 111         }
 112
 113         regfree(&r);
 114
 115         return 0;
 116 }
 117
 118 /* get the current loglevel for the message being processed */
 119 int rte_log_cur_msg_loglevel(void)
 120 {
 121         return RTE_PER_LCORE(log_cur_msg).loglevel;
 122 }
 123
 124 /* get the current logtype for the message being processed */
 125 int rte_log_cur_msg_logtype(void)
 126 {
 127         return RTE_PER_LCORE(log_cur_msg).logtype;
 128 }
 129
 130 static int
 131 rte_log_lookup(const char *name)
 132 {
 133         size_t i;
 134
 135         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 136                 if (rte_logs.dynamic_types[i].name == NULL)
 137                         continue;
 138                 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
 139                         return i;
 140         }
 141
 142         return -1;
 143 }
 144
 145 /* register an extended log type, assuming table is large enough, and id
 146  * is not yet registered.
 147  */
 148 static int
 149 __rte_log_register(const char *name, int id)
 150 {
 151         char *dup_name = strdup(name);
 152
 153         if (dup_name == NULL)
 154                 return -ENOMEM;
 155
 156         rte_logs.dynamic_types[id].name = dup_name;
 157         rte_logs.dynamic_types[id].loglevel = RTE_LOG_INFO;
 158
 159         return id;
 160 }
 161
 162 /* register an extended log type */
 163 int
 164 rte_log_register(const char *name)
 165 {
 166         struct rte_log_dynamic_type *new_dynamic_types;
 167         int id, ret;
 168
 169         id = rte_log_lookup(name);
 170         if (id >= 0)
 171                 return id;
 172
 173         new_dynamic_types = realloc(rte_logs.dynamic_types,
 174                 sizeof(struct rte_log_dynamic_type) *
 175                 (rte_logs.dynamic_types_len + 1));
 176         if (new_dynamic_types == NULL)
 177                 return -ENOMEM;
 178         rte_logs.dynamic_types = new_dynamic_types;
 179
 180         ret = __rte_log_register(name, rte_logs.dynamic_types_len);
 181         if (ret < 0)
 182                 return ret;
 183
 184         rte_logs.dynamic_types_len++;
 185
 186         return ret;
 187 }
 188
 189 struct logtype {
 190         uint32_t log_id;
 191         const char *logtype;
 192 };
 193
 194 static const struct logtype logtype_strings[] = {
 195         {RTE_LOGTYPE_EAL,        "lib.eal"},
 196         {RTE_LOGTYPE_MALLOC,     "lib.malloc"},
 197         {RTE_LOGTYPE_RING,       "lib.ring"},
 198         {RTE_LOGTYPE_MEMPOOL,    "lib.mempool"},
 199         {RTE_LOGTYPE_TIMER,      "lib.timer"},
 200         {RTE_LOGTYPE_PMD,        "pmd"},
 201         {RTE_LOGTYPE_HASH,       "lib.hash"},
 202         {RTE_LOGTYPE_LPM,        "lib.lpm"},
 203         {RTE_LOGTYPE_KNI,        "lib.kni"},
 204         {RTE_LOGTYPE_ACL,        "lib.acl"},
 205         {RTE_LOGTYPE_POWER,      "lib.power"},
 206         {RTE_LOGTYPE_METER,      "lib.meter"},
 207         {RTE_LOGTYPE_SCHED,      "lib.sched"},
 208         {RTE_LOGTYPE_PORT,       "lib.port"},
 209         {RTE_LOGTYPE_TABLE,      "lib.table"},
 210         {RTE_LOGTYPE_PIPELINE,   "lib.pipeline"},
 211         {RTE_LOGTYPE_MBUF,       "lib.mbuf"},
 212         {RTE_LOGTYPE_CRYPTODEV,  "lib.cryptodev"},
 213         {RTE_LOGTYPE_EFD,        "lib.efd"},
 214         {RTE_LOGTYPE_EVENTDEV,   "lib.eventdev"},
 215         {RTE_LOGTYPE_GSO,        "lib.gso"},
 216         {RTE_LOGTYPE_USER1,      "user1"},
 217         {RTE_LOGTYPE_USER2,      "user2"},
 218         {RTE_LOGTYPE_USER3,      "user3"},
 219         {RTE_LOGTYPE_USER4,      "user4"},
 220         {RTE_LOGTYPE_USER5,      "user5"},
 221         {RTE_LOGTYPE_USER6,      "user6"},
 222         {RTE_LOGTYPE_USER7,      "user7"},
 223         {RTE_LOGTYPE_USER8,      "user8"}
 224 };
 225
 226 /* Logging should be first initializer (before drivers and bus) */
 227 RTE_INIT_PRIO(rte_log_init, 101);
 228 static void
 229 rte_log_init(void)
 230 {
 231         uint32_t i;
 232
 233         rte_log_set_global_level(RTE_LOG_DEBUG);
 234
 235         rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
 236                 sizeof(struct rte_log_dynamic_type));
 237         if (rte_logs.dynamic_types == NULL)
 238                 return;
 239
 240         /* register legacy log types */
 241         for (i = 0; i < RTE_DIM(logtype_strings); i++)
 242                 __rte_log_register(logtype_strings[i].logtype,
 243                                 logtype_strings[i].log_id);
 244
 245         rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
 246 }
 247
 248 static const char *
 249 loglevel_to_string(uint32_t level)
 250 {
 251         switch (level) {
 252         case 0: return "disabled";
 253         case RTE_LOG_EMERG: return "emerg";
 254         case RTE_LOG_ALERT: return "alert";
 255         case RTE_LOG_CRIT: return "critical";
 256         case RTE_LOG_ERR: return "error";
 257         case RTE_LOG_WARNING: return "warning";
 258         case RTE_LOG_NOTICE: return "notice";
 259         case RTE_LOG_INFO: return "info";
 260         case RTE_LOG_DEBUG: return "debug";
 261         default: return "unknown";
 262         }
 263 }
 264
 265 /* dump global level and registered log types */
 266 void
 267 rte_log_dump(FILE *f)
 268 {
 269         size_t i;
 270
 271         fprintf(f, "global log level is %s\n",
 272                 loglevel_to_string(rte_log_get_global_level()));
 273
 274         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 275                 if (rte_logs.dynamic_types[i].name == NULL)
 276                         continue;
 277                 fprintf(f, "id %zu: %s, level is %s\n",
 278                         i, rte_logs.dynamic_types[i].name,
 279                         loglevel_to_string(rte_logs.dynamic_types[i].loglevel));
 280         }
 281 }
 282
 283 /*
 284  * Generates a log message The message will be sent in the stream
 285  * defined by the previous call to rte_openlog_stream().
 286  */
 287 int
 288 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 289 {
 290         int ret;
 291         FILE *f = rte_logs.file;
 292         if (f == NULL) {
 293                 f = default_log_stream;
 294                 if (f == NULL) {
 295                         /*
 296                          * Grab the current value of stderr here, rather than
 297                          * just initializing default_log_stream to stderr. This
 298                          * ensures that we will always use the current value
 299                          * of stderr, even if the application closes and
 300                          * reopens it.
 301                          */
 302                         f = stderr;
 303                 }
 304         }
 305
 306         if (level > rte_logs.level)
 307                 return 0;
 308         if (logtype >= rte_logs.dynamic_types_len)
 309                 return -1;
 310         if (level > rte_logs.dynamic_types[logtype].loglevel)
 311                 return 0;
 312
 313         /* save loglevel and logtype in a global per-lcore variable */
 314         RTE_PER_LCORE(log_cur_msg).loglevel = level;
 315         RTE_PER_LCORE(log_cur_msg).logtype = logtype;
 316
 317         ret = vfprintf(f, format, ap);
 318         fflush(f);
 319         return ret;
 320 }
 321
 322 /*
 323  * Generates a log message The message will be sent in the stream
 324  * defined by the previous call to rte_openlog_stream().
 325  * No need to check level here, done by rte_vlog().
 326  */
 327 int
 328 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 329 {
 330         va_list ap;
 331         int ret;
 332
 333         va_start(ap, format);
 334         ret = rte_vlog(level, logtype, format, ap);
 335         va_end(ap);
 336         return ret;
 337 }
 338
 339 /*
 340  * Called by environment-specific initialization functions.
 341  */
 342 void
 343 eal_log_set_default(FILE *default_log)
 344 {
 345         default_log_stream = default_log;
 346
 347 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
 348         RTE_LOG(NOTICE, EAL,
 349                 "Debug dataplane logs available - lower performance\n");
 350 #endif
 351 }