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