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         return 0;
 114 }
 115
 116 /* get the current loglevel for the message being processed */
 117 int rte_log_cur_msg_loglevel(void)
 118 {
 119         return RTE_PER_LCORE(log_cur_msg).loglevel;
 120 }
 121
 122 /* get the current logtype for the message being processed */
 123 int rte_log_cur_msg_logtype(void)
 124 {
 125         return RTE_PER_LCORE(log_cur_msg).logtype;
 126 }
 127
 128 static int
 129 rte_log_lookup(const char *name)
 130 {
 131         size_t i;
 132
 133         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 134                 if (rte_logs.dynamic_types[i].name == NULL)
 135                         continue;
 136                 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
 137                         return i;
 138         }
 139
 140         return -1;
 141 }
 142
 143 /* register an extended log type, assuming table is large enough, and id
 144  * is not yet registered.
 145  */
 146 static int
 147 __rte_log_register(const char *name, int id)
 148 {
 149         char *dup_name = strdup(name);
 150
 151         if (dup_name == NULL)
 152                 return -ENOMEM;
 153
 154         rte_logs.dynamic_types[id].name = dup_name;
 155         rte_logs.dynamic_types[id].loglevel = RTE_LOG_INFO;
 156
 157         return id;
 158 }
 159
 160 /* register an extended log type */
 161 int
 162 rte_log_register(const char *name)
 163 {
 164         struct rte_log_dynamic_type *new_dynamic_types;
 165         int id, ret;
 166
 167         id = rte_log_lookup(name);
 168         if (id >= 0)
 169                 return id;
 170
 171         new_dynamic_types = realloc(rte_logs.dynamic_types,
 172                 sizeof(struct rte_log_dynamic_type) *
 173                 (rte_logs.dynamic_types_len + 1));
 174         if (new_dynamic_types == NULL)
 175                 return -ENOMEM;
 176         rte_logs.dynamic_types = new_dynamic_types;
 177
 178         ret = __rte_log_register(name, rte_logs.dynamic_types_len);
 179         if (ret < 0)
 180                 return ret;
 181
 182         rte_logs.dynamic_types_len++;
 183
 184         return ret;
 185 }
 186
 187 struct logtype {
 188         uint32_t log_id;
 189         const char *logtype;
 190 };
 191
 192 static const struct logtype logtype_strings[] = {
 193         {RTE_LOGTYPE_EAL,        "lib.eal"},
 194         {RTE_LOGTYPE_MALLOC,     "lib.malloc"},
 195         {RTE_LOGTYPE_RING,       "lib.ring"},
 196         {RTE_LOGTYPE_MEMPOOL,    "lib.mempool"},
 197         {RTE_LOGTYPE_TIMER,      "lib.timer"},
 198         {RTE_LOGTYPE_PMD,        "pmd"},
 199         {RTE_LOGTYPE_HASH,       "lib.hash"},
 200         {RTE_LOGTYPE_LPM,        "lib.lpm"},
 201         {RTE_LOGTYPE_KNI,        "lib.kni"},
 202         {RTE_LOGTYPE_ACL,        "lib.acl"},
 203         {RTE_LOGTYPE_POWER,      "lib.power"},
 204         {RTE_LOGTYPE_METER,      "lib.meter"},
 205         {RTE_LOGTYPE_SCHED,      "lib.sched"},
 206         {RTE_LOGTYPE_PORT,       "lib.port"},
 207         {RTE_LOGTYPE_TABLE,      "lib.table"},
 208         {RTE_LOGTYPE_PIPELINE,   "lib.pipeline"},
 209         {RTE_LOGTYPE_MBUF,       "lib.mbuf"},
 210         {RTE_LOGTYPE_CRYPTODEV,  "lib.cryptodev"},
 211         {RTE_LOGTYPE_EFD,        "lib.efd"},
 212         {RTE_LOGTYPE_EVENTDEV,   "lib.eventdev"},
 213         {RTE_LOGTYPE_GSO,        "lib.gso"},
 214         {RTE_LOGTYPE_USER1,      "user1"},
 215         {RTE_LOGTYPE_USER2,      "user2"},
 216         {RTE_LOGTYPE_USER3,      "user3"},
 217         {RTE_LOGTYPE_USER4,      "user4"},
 218         {RTE_LOGTYPE_USER5,      "user5"},
 219         {RTE_LOGTYPE_USER6,      "user6"},
 220         {RTE_LOGTYPE_USER7,      "user7"},
 221         {RTE_LOGTYPE_USER8,      "user8"}
 222 };
 223
 224 /* Logging should be first initializer (before drivers and bus) */
 225 RTE_INIT_PRIO(rte_log_init, 101);
 226 static void
 227 rte_log_init(void)
 228 {
 229         uint32_t i;
 230
 231         rte_log_set_global_level(RTE_LOG_DEBUG);
 232
 233         rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
 234                 sizeof(struct rte_log_dynamic_type));
 235         if (rte_logs.dynamic_types == NULL)
 236                 return;
 237
 238         /* register legacy log types */
 239         for (i = 0; i < RTE_DIM(logtype_strings); i++)
 240                 __rte_log_register(logtype_strings[i].logtype,
 241                                 logtype_strings[i].log_id);
 242
 243         rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
 244 }
 245
 246 static const char *
 247 loglevel_to_string(uint32_t level)
 248 {
 249         switch (level) {
 250         case 0: return "disabled";
 251         case RTE_LOG_EMERG: return "emerg";
 252         case RTE_LOG_ALERT: return "alert";
 253         case RTE_LOG_CRIT: return "critical";
 254         case RTE_LOG_ERR: return "error";
 255         case RTE_LOG_WARNING: return "warning";
 256         case RTE_LOG_NOTICE: return "notice";
 257         case RTE_LOG_INFO: return "info";
 258         case RTE_LOG_DEBUG: return "debug";
 259         default: return "unknown";
 260         }
 261 }
 262
 263 /* dump global level and registered log types */
 264 void
 265 rte_log_dump(FILE *f)
 266 {
 267         size_t i;
 268
 269         fprintf(f, "global log level is %s\n",
 270                 loglevel_to_string(rte_log_get_global_level()));
 271
 272         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 273                 if (rte_logs.dynamic_types[i].name == NULL)
 274                         continue;
 275                 fprintf(f, "id %zu: %s, level is %s\n",
 276                         i, rte_logs.dynamic_types[i].name,
 277                         loglevel_to_string(rte_logs.dynamic_types[i].loglevel));
 278         }
 279 }
 280
 281 /*
 282  * Generates a log message The message will be sent in the stream
 283  * defined by the previous call to rte_openlog_stream().
 284  */
 285 int
 286 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 287 {
 288         int ret;
 289         FILE *f = rte_logs.file;
 290         if (f == NULL) {
 291                 f = default_log_stream;
 292                 if (f == NULL) {
 293                         /*
 294                          * Grab the current value of stderr here, rather than
 295                          * just initializing default_log_stream to stderr. This
 296                          * ensures that we will always use the current value
 297                          * of stderr, even if the application closes and
 298                          * reopens it.
 299                          */
 300                         f = stderr;
 301                 }
 302         }
 303
 304         if (level > rte_logs.level)
 305                 return 0;
 306         if (logtype >= rte_logs.dynamic_types_len)
 307                 return -1;
 308         if (level > rte_logs.dynamic_types[logtype].loglevel)
 309                 return 0;
 310
 311         /* save loglevel and logtype in a global per-lcore variable */
 312         RTE_PER_LCORE(log_cur_msg).loglevel = level;
 313         RTE_PER_LCORE(log_cur_msg).logtype = logtype;
 314
 315         ret = vfprintf(f, format, ap);
 316         fflush(f);
 317         return ret;
 318 }
 319
 320 /*
 321  * Generates a log message The message will be sent in the stream
 322  * defined by the previous call to rte_openlog_stream().
 323  * No need to check level here, done by rte_vlog().
 324  */
 325 int
 326 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 327 {
 328         va_list ap;
 329         int ret;
 330
 331         va_start(ap, format);
 332         ret = rte_vlog(level, logtype, format, ap);
 333         va_end(ap);
 334         return ret;
 335 }
 336
 337 /*
 338  * Called by environment-specific initialization functions.
 339  */
 340 void
 341 eal_log_set_default(FILE *default_log)
 342 {
 343         default_log_stream = default_log;
 344
 345 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
 346         RTE_LOG(NOTICE, EAL,
 347                 "Debug dataplane logs available - lower performance\n");
 348 #endif
 349 }