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 #include <fnmatch.h>
  13
  14 #include <rte_eal.h>
  15 #include <rte_log.h>
  16 #include <rte_per_lcore.h>
  17
  18 #include "eal_log.h"
  19
  20 struct rte_log_dynamic_type {
  21         const char *name;
  22         uint32_t loglevel;
  23 };
  24
  25 /** The rte_log structure. */
  26 static struct rte_logs {
  27         uint32_t type;  /**< Bitfield with enabled logs. */
  28         uint32_t level; /**< Log level. */
  29         FILE *file;     /**< Output file set by rte_openlog_stream, or NULL. */
  30         size_t dynamic_types_len;
  31         struct rte_log_dynamic_type *dynamic_types;
  32 } rte_logs = {
  33         .type = ~0,
  34         .level = RTE_LOG_DEBUG,
  35 };
  36
  37 struct rte_eal_opt_loglevel {
  38         /** Next list entry */
  39         TAILQ_ENTRY(rte_eal_opt_loglevel) next;
  40         /** Compiled regular expression obtained from the option */
  41         regex_t re_match;
  42         /** Globbing pattern option */
  43         char *pattern;
  44         /** Log level value obtained from the option */
  45         uint32_t level;
  46 };
  47
  48 TAILQ_HEAD(rte_eal_opt_loglevel_list, rte_eal_opt_loglevel);
  49
  50 /** List of valid EAL log level options */
  51 static struct rte_eal_opt_loglevel_list opt_loglevel_list =
  52         TAILQ_HEAD_INITIALIZER(opt_loglevel_list);
  53
  54 /* Stream to use for logging if rte_logs.file is NULL */
  55 static FILE *default_log_stream;
  56
  57 /**
  58  * This global structure stores some information about the message
  59  * that is currently being processed by one lcore
  60  */
  61 struct log_cur_msg {
  62         uint32_t loglevel; /**< log level - see rte_log.h */
  63         uint32_t logtype;  /**< log type  - see rte_log.h */
  64 };
  65
  66  /* per core log */
  67 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
  68
  69 /* default logs */
  70
  71 /* Change the stream that will be used by logging system */
  72 int
  73 rte_openlog_stream(FILE *f)
  74 {
  75         rte_logs.file = f;
  76         return 0;
  77 }
  78
  79 FILE *
  80 rte_log_get_stream(void)
  81 {
  82         FILE *f = rte_logs.file;
  83
  84         if (f == NULL) {
  85                 /*
  86                  * Grab the current value of stderr here, rather than
  87                  * just initializing default_log_stream to stderr. This
  88                  * ensures that we will always use the current value
  89                  * of stderr, even if the application closes and
  90                  * reopens it.
  91                  */
  92                 return default_log_stream ? : stderr;
  93         }
  94         return f;
  95 }
  96
  97 /* Set global log level */
  98 void
  99 rte_log_set_global_level(uint32_t level)
 100 {
 101         rte_logs.level = (uint32_t)level;
 102 }
 103
 104 /* Get global log level */
 105 uint32_t
 106 rte_log_get_global_level(void)
 107 {
 108         return rte_logs.level;
 109 }
 110
 111 int
 112 rte_log_get_level(uint32_t type)
 113 {
 114         if (type >= rte_logs.dynamic_types_len)
 115                 return -1;
 116
 117         return rte_logs.dynamic_types[type].loglevel;
 118 }
 119
 120 bool
 121 rte_log_can_log(uint32_t logtype, uint32_t level)
 122 {
 123         int log_level;
 124
 125         if (level > rte_log_get_global_level())
 126                 return false;
 127
 128         log_level = rte_log_get_level(logtype);
 129         if (log_level < 0)
 130                 return false;
 131
 132         if (level > (uint32_t)log_level)
 133                 return false;
 134
 135         return true;
 136 }
 137
 138 static void
 139 logtype_set_level(uint32_t type, uint32_t level)
 140 {
 141         uint32_t current = rte_logs.dynamic_types[type].loglevel;
 142
 143         if (current != level) {
 144                 rte_logs.dynamic_types[type].loglevel = level;
 145                 RTE_LOG(DEBUG, EAL, "%s log level changed from %s to %s\n",
 146                         rte_logs.dynamic_types[type].name == NULL ?
 147                                 "" : rte_logs.dynamic_types[type].name,
 148                         eal_log_level2str(current),
 149                         eal_log_level2str(level));
 150         }
 151 }
 152
 153 int
 154 rte_log_set_level(uint32_t type, uint32_t level)
 155 {
 156         if (type >= rte_logs.dynamic_types_len)
 157                 return -1;
 158         if (level > RTE_LOG_MAX)
 159                 return -1;
 160
 161         logtype_set_level(type, level);
 162
 163         return 0;
 164 }
 165
 166 /* set log level by regular expression */
 167 int
 168 rte_log_set_level_regexp(const char *regex, uint32_t level)
 169 {
 170         regex_t r;
 171         size_t i;
 172
 173         if (level > RTE_LOG_MAX)
 174                 return -1;
 175
 176         if (regcomp(&r, regex, 0) != 0)
 177                 return -1;
 178
 179         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 180                 if (rte_logs.dynamic_types[i].name == NULL)
 181                         continue;
 182                 if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
 183                                 NULL, 0) == 0)
 184                         logtype_set_level(i, level);
 185         }
 186
 187         regfree(&r);
 188
 189         return 0;
 190 }
 191
 192 /*
 193  * Save the type string and the loglevel for later dynamic
 194  * logtypes which may register later.
 195  */
 196 static int
 197 log_save_level(uint32_t priority, const char *regex, const char *pattern)
 198 {
 199         struct rte_eal_opt_loglevel *opt_ll = NULL;
 200
 201         opt_ll = malloc(sizeof(*opt_ll));
 202         if (opt_ll == NULL)
 203                 goto fail;
 204
 205         opt_ll->level = priority;
 206
 207         if (regex) {
 208                 opt_ll->pattern = NULL;
 209                 if (regcomp(&opt_ll->re_match, regex, 0) != 0)
 210                         goto fail;
 211         } else if (pattern) {
 212                 opt_ll->pattern = strdup(pattern);
 213                 if (opt_ll->pattern == NULL)
 214                         goto fail;
 215         } else
 216                 goto fail;
 217
 218         TAILQ_INSERT_HEAD(&opt_loglevel_list, opt_ll, next);
 219         return 0;
 220 fail:
 221         free(opt_ll);
 222         return -1;
 223 }
 224
 225 int
 226 eal_log_save_regexp(const char *regex, uint32_t level)
 227 {
 228         return log_save_level(level, regex, NULL);
 229 }
 230
 231 /* set log level based on globbing pattern */
 232 int
 233 rte_log_set_level_pattern(const char *pattern, uint32_t level)
 234 {
 235         size_t i;
 236
 237         if (level > RTE_LOG_MAX)
 238                 return -1;
 239
 240         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 241                 if (rte_logs.dynamic_types[i].name == NULL)
 242                         continue;
 243
 244                 if (fnmatch(pattern, rte_logs.dynamic_types[i].name, 0) == 0)
 245                         logtype_set_level(i, level);
 246         }
 247
 248         return 0;
 249 }
 250
 251 int
 252 eal_log_save_pattern(const char *pattern, uint32_t level)
 253 {
 254         return log_save_level(level, NULL, pattern);
 255 }
 256
 257 /* get the current loglevel for the message being processed */
 258 int rte_log_cur_msg_loglevel(void)
 259 {
 260         return RTE_PER_LCORE(log_cur_msg).loglevel;
 261 }
 262
 263 /* get the current logtype for the message being processed */
 264 int rte_log_cur_msg_logtype(void)
 265 {
 266         return RTE_PER_LCORE(log_cur_msg).logtype;
 267 }
 268
 269 static int
 270 log_lookup(const char *name)
 271 {
 272         size_t i;
 273
 274         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 275                 if (rte_logs.dynamic_types[i].name == NULL)
 276                         continue;
 277                 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
 278                         return i;
 279         }
 280
 281         return -1;
 282 }
 283
 284 static int
 285 log_register(const char *name, uint32_t level)
 286 {
 287         struct rte_log_dynamic_type *new_dynamic_types;
 288         int id;
 289
 290         id = log_lookup(name);
 291         if (id >= 0)
 292                 return id;
 293
 294         new_dynamic_types = realloc(rte_logs.dynamic_types,
 295                 sizeof(struct rte_log_dynamic_type) *
 296                 (rte_logs.dynamic_types_len + 1));
 297         if (new_dynamic_types == NULL)
 298                 return -ENOMEM;
 299         rte_logs.dynamic_types = new_dynamic_types;
 300
 301         id = rte_logs.dynamic_types_len;
 302         memset(&rte_logs.dynamic_types[id], 0,
 303                 sizeof(rte_logs.dynamic_types[id]));
 304         rte_logs.dynamic_types[id].name = strdup(name);
 305         if (rte_logs.dynamic_types[id].name == NULL)
 306                 return -ENOMEM;
 307         logtype_set_level(id, level);
 308
 309         rte_logs.dynamic_types_len++;
 310
 311         return id;
 312 }
 313
 314 /* register an extended log type */
 315 int
 316 rte_log_register(const char *name)
 317 {
 318         return log_register(name, RTE_LOG_INFO);
 319 }
 320
 321 /* Register an extended log type and try to pick its level from EAL options */
 322 int
 323 rte_log_register_type_and_pick_level(const char *name, uint32_t level_def)
 324 {
 325         struct rte_eal_opt_loglevel *opt_ll;
 326         uint32_t level = level_def;
 327
 328         TAILQ_FOREACH(opt_ll, &opt_loglevel_list, next) {
 329                 if (opt_ll->level > RTE_LOG_MAX)
 330                         continue;
 331
 332                 if (opt_ll->pattern) {
 333                         if (fnmatch(opt_ll->pattern, name, 0) == 0)
 334                                 level = opt_ll->level;
 335                 } else {
 336                         if (regexec(&opt_ll->re_match, name, 0, NULL, 0) == 0)
 337                                 level = opt_ll->level;
 338                 }
 339         }
 340
 341         return log_register(name, level);
 342 }
 343
 344 struct logtype {
 345         uint32_t log_id;
 346         const char *logtype;
 347 };
 348
 349 static const struct logtype logtype_strings[] = {
 350         {RTE_LOGTYPE_EAL,        "lib.eal"},
 351         {RTE_LOGTYPE_MALLOC,     "lib.malloc"},
 352         {RTE_LOGTYPE_RING,       "lib.ring"},
 353         {RTE_LOGTYPE_MEMPOOL,    "lib.mempool"},
 354         {RTE_LOGTYPE_TIMER,      "lib.timer"},
 355         {RTE_LOGTYPE_PMD,        "pmd"},
 356         {RTE_LOGTYPE_HASH,       "lib.hash"},
 357         {RTE_LOGTYPE_LPM,        "lib.lpm"},
 358         {RTE_LOGTYPE_KNI,        "lib.kni"},
 359         {RTE_LOGTYPE_ACL,        "lib.acl"},
 360         {RTE_LOGTYPE_POWER,      "lib.power"},
 361         {RTE_LOGTYPE_METER,      "lib.meter"},
 362         {RTE_LOGTYPE_SCHED,      "lib.sched"},
 363         {RTE_LOGTYPE_PORT,       "lib.port"},
 364         {RTE_LOGTYPE_TABLE,      "lib.table"},
 365         {RTE_LOGTYPE_PIPELINE,   "lib.pipeline"},
 366         {RTE_LOGTYPE_MBUF,       "lib.mbuf"},
 367         {RTE_LOGTYPE_CRYPTODEV,  "lib.cryptodev"},
 368         {RTE_LOGTYPE_EFD,        "lib.efd"},
 369         {RTE_LOGTYPE_EVENTDEV,   "lib.eventdev"},
 370         {RTE_LOGTYPE_GSO,        "lib.gso"},
 371         {RTE_LOGTYPE_USER1,      "user1"},
 372         {RTE_LOGTYPE_USER2,      "user2"},
 373         {RTE_LOGTYPE_USER3,      "user3"},
 374         {RTE_LOGTYPE_USER4,      "user4"},
 375         {RTE_LOGTYPE_USER5,      "user5"},
 376         {RTE_LOGTYPE_USER6,      "user6"},
 377         {RTE_LOGTYPE_USER7,      "user7"},
 378         {RTE_LOGTYPE_USER8,      "user8"}
 379 };
 380
 381 /* Logging should be first initializer (before drivers and bus) */
 382 RTE_INIT_PRIO(log_init, LOG)
 383 {
 384         uint32_t i;
 385
 386         rte_log_set_global_level(RTE_LOG_DEBUG);
 387
 388         rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
 389                 sizeof(struct rte_log_dynamic_type));
 390         if (rte_logs.dynamic_types == NULL)
 391                 return;
 392
 393         /* register legacy log types */
 394         for (i = 0; i < RTE_DIM(logtype_strings); i++) {
 395                 rte_logs.dynamic_types[logtype_strings[i].log_id].name =
 396                         strdup(logtype_strings[i].logtype);
 397                 logtype_set_level(logtype_strings[i].log_id, RTE_LOG_INFO);
 398         }
 399
 400         rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
 401 }
 402
 403 const char *
 404 eal_log_level2str(uint32_t level)
 405 {
 406         switch (level) {
 407         case 0: return "disabled";
 408         case RTE_LOG_EMERG: return "emergency";
 409         case RTE_LOG_ALERT: return "alert";
 410         case RTE_LOG_CRIT: return "critical";
 411         case RTE_LOG_ERR: return "error";
 412         case RTE_LOG_WARNING: return "warning";
 413         case RTE_LOG_NOTICE: return "notice";
 414         case RTE_LOG_INFO: return "info";
 415         case RTE_LOG_DEBUG: return "debug";
 416         default: return "unknown";
 417         }
 418 }
 419
 420 static int
 421 log_type_compare(const void *a, const void *b)
 422 {
 423         const struct rte_log_dynamic_type *type_a = a;
 424         const struct rte_log_dynamic_type *type_b = b;
 425
 426         if (type_a->name == NULL && type_b->name == NULL)
 427                 return 0;
 428         if (type_a->name == NULL)
 429                 return -1;
 430         if (type_b->name == NULL)
 431                 return 1;
 432         return strcmp(type_a->name, type_b->name);
 433 }
 434
 435 /* Dump name of each logtype, one per line. */
 436 void
 437 rte_log_list_types(FILE *out, const char *prefix)
 438 {
 439         struct rte_log_dynamic_type *sorted_types;
 440         const size_t type_size = sizeof(rte_logs.dynamic_types[0]);
 441         const size_t type_count = rte_logs.dynamic_types_len;
 442         const size_t total_size = type_size * type_count;
 443         size_t type;
 444
 445         sorted_types = malloc(total_size);
 446         if (sorted_types == NULL) {
 447                 /* no sorting - unlikely */
 448                 sorted_types = rte_logs.dynamic_types;
 449         } else {
 450                 memcpy(sorted_types, rte_logs.dynamic_types, total_size);
 451                 qsort(sorted_types, type_count, type_size, log_type_compare);
 452         }
 453
 454         for (type = 0; type < type_count; ++type) {
 455                 if (sorted_types[type].name == NULL)
 456                         continue;
 457                 fprintf(out, "%s%s\n", prefix, sorted_types[type].name);
 458         }
 459
 460         if (sorted_types != rte_logs.dynamic_types)
 461                 free(sorted_types);
 462 }
 463
 464 /* dump global level and registered log types */
 465 void
 466 rte_log_dump(FILE *f)
 467 {
 468         size_t i;
 469
 470         fprintf(f, "global log level is %s\n",
 471                 eal_log_level2str(rte_log_get_global_level()));
 472
 473         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 474                 if (rte_logs.dynamic_types[i].name == NULL)
 475                         continue;
 476                 fprintf(f, "id %zu: %s, level is %s\n",
 477                         i, rte_logs.dynamic_types[i].name,
 478                         eal_log_level2str(rte_logs.dynamic_types[i].loglevel));
 479         }
 480 }
 481
 482 /*
 483  * Generates a log message The message will be sent in the stream
 484  * defined by the previous call to rte_openlog_stream().
 485  */
 486 int
 487 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 488 {
 489         FILE *f = rte_log_get_stream();
 490         int ret;
 491
 492         if (logtype >= rte_logs.dynamic_types_len)
 493                 return -1;
 494         if (!rte_log_can_log(logtype, level))
 495                 return 0;
 496
 497         /* save loglevel and logtype in a global per-lcore variable */
 498         RTE_PER_LCORE(log_cur_msg).loglevel = level;
 499         RTE_PER_LCORE(log_cur_msg).logtype = logtype;
 500
 501         ret = vfprintf(f, format, ap);
 502         fflush(f);
 503         return ret;
 504 }
 505
 506 /*
 507  * Generates a log message The message will be sent in the stream
 508  * defined by the previous call to rte_openlog_stream().
 509  * No need to check level here, done by rte_vlog().
 510  */
 511 int
 512 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 513 {
 514         va_list ap;
 515         int ret;
 516
 517         va_start(ap, format);
 518         ret = rte_vlog(level, logtype, format, ap);
 519         va_end(ap);
 520         return ret;
 521 }
 522
 523 /*
 524  * Called by environment-specific initialization functions.
 525  */
 526 void
 527 eal_log_set_default(FILE *default_log)
 528 {
 529         default_log_stream = default_log;
 530
 531 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
 532         RTE_LOG(NOTICE, EAL,
 533                 "Debug dataplane logs available - lower performance\n");
 534 #endif
 535 }