lib/librte_eal/common/eal_common_log.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <stdio.h>
  35 #include <stdint.h>
  36 #include <stdarg.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <errno.h>
  40 #include <regex.h>
  41
  42 #include <rte_eal.h>
  43 #include <rte_log.h>
  44 #include <rte_per_lcore.h>
  45
  46 #include "eal_private.h"
  47
  48 /* global log structure */
  49 struct rte_logs rte_logs = {
  50         .type = ~0,
  51         .level = RTE_LOG_DEBUG,
  52         .file = NULL,
  53 };
  54
  55 /* Stream to use for logging if rte_logs.file is NULL */
  56 static FILE *default_log_stream;
  57
  58 /**
  59  * This global structure stores some informations about the message
  60  * that is currently being processed by one lcore
  61  */
  62 struct log_cur_msg {
  63         uint32_t loglevel; /**< log level - see rte_log.h */
  64         uint32_t logtype;  /**< log type  - see rte_log.h */
  65 };
  66
  67 struct rte_log_dynamic_type {
  68         const char *name;
  69         uint32_t loglevel;
  70 };
  71
  72  /* per core log */
  73 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
  74
  75 /* default logs */
  76
  77 /* Change the stream that will be used by logging system */
  78 int
  79 rte_openlog_stream(FILE *f)
  80 {
  81         rte_logs.file = f;
  82         return 0;
  83 }
  84
  85 /* Set global log level */
  86 void
  87 rte_log_set_global_level(uint32_t level)
  88 {
  89         rte_logs.level = (uint32_t)level;
  90 }
  91
  92 /* Set global log level */
  93 /* replaced by rte_log_set_global_level */
  94 __rte_deprecated void
  95 rte_set_log_level(uint32_t level)
  96 {
  97         rte_log_set_global_level(level);
  98 }
  99
 100 /* Get global log level */
 101 uint32_t
 102 rte_log_get_global_level(void)
 103 {
 104         return rte_logs.level;
 105 }
 106
 107 /* Get global log level */
 108 /* replaced by rte_log_get_global_level */
 109 uint32_t
 110 rte_get_log_level(void)
 111 {
 112         return rte_log_get_global_level();
 113 }
 114
 115 int
 116 rte_log_get_level(uint32_t type)
 117 {
 118         if (type >= rte_logs.dynamic_types_len)
 119                 return -1;
 120
 121         return rte_logs.dynamic_types[type].loglevel;
 122 }
 123
 124 /* Set global log type */
 125 __rte_deprecated void
 126 rte_set_log_type(uint32_t type, int enable)
 127 {
 128         if (type < RTE_LOGTYPE_FIRST_EXT_ID) {
 129                 if (enable)
 130                         rte_logs.type |= 1 << type;
 131                 else
 132                         rte_logs.type &= ~(1 << type);
 133         }
 134
 135         if (enable)
 136                 rte_log_set_level(type, 0);
 137         else
 138                 rte_log_set_level(type, RTE_LOG_DEBUG);
 139 }
 140
 141 /* Get global log type */
 142 __rte_deprecated uint32_t
 143 rte_get_log_type(void)
 144 {
 145         return rte_logs.type;
 146 }
 147
 148 int
 149 rte_log_set_level(uint32_t type, uint32_t level)
 150 {
 151         if (type >= rte_logs.dynamic_types_len)
 152                 return -1;
 153         if (level > RTE_LOG_DEBUG)
 154                 return -1;
 155
 156         rte_logs.dynamic_types[type].loglevel = level;
 157
 158         return 0;
 159 }
 160
 161 /* set level */
 162 int
 163 rte_log_set_level_regexp(const char *pattern, uint32_t level)
 164 {
 165         regex_t r;
 166         size_t i;
 167
 168         if (level > RTE_LOG_DEBUG)
 169                 return -1;
 170
 171         if (regcomp(&r, pattern, 0) != 0)
 172                 return -1;
 173
 174         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 175                 if (rte_logs.dynamic_types[i].name == NULL)
 176                         continue;
 177                 if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
 178                                 NULL, 0) == 0)
 179                         rte_logs.dynamic_types[i].loglevel = level;
 180         }
 181
 182         return 0;
 183 }
 184
 185 /* get the current loglevel for the message being processed */
 186 int rte_log_cur_msg_loglevel(void)
 187 {
 188         return RTE_PER_LCORE(log_cur_msg).loglevel;
 189 }
 190
 191 /* get the current logtype for the message being processed */
 192 int rte_log_cur_msg_logtype(void)
 193 {
 194         return RTE_PER_LCORE(log_cur_msg).logtype;
 195 }
 196
 197 static int
 198 rte_log_lookup(const char *name)
 199 {
 200         size_t i;
 201
 202         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 203                 if (rte_logs.dynamic_types[i].name == NULL)
 204                         continue;
 205                 if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
 206                         return i;
 207         }
 208
 209         return -1;
 210 }
 211
 212 /* register an extended log type, assuming table is large enough, and id
 213  * is not yet registered.
 214  */
 215 static int
 216 __rte_log_register(const char *name, int id)
 217 {
 218         char *dup_name = strdup(name);
 219
 220         if (dup_name == NULL)
 221                 return -ENOMEM;
 222
 223         rte_logs.dynamic_types[id].name = dup_name;
 224         rte_logs.dynamic_types[id].loglevel = RTE_LOG_DEBUG;
 225
 226         return id;
 227 }
 228
 229 /* register an extended log type */
 230 int
 231 rte_log_register(const char *name)
 232 {
 233         struct rte_log_dynamic_type *new_dynamic_types;
 234         int id, ret;
 235
 236         id = rte_log_lookup(name);
 237         if (id >= 0)
 238                 return id;
 239
 240         new_dynamic_types = realloc(rte_logs.dynamic_types,
 241                 sizeof(struct rte_log_dynamic_type) *
 242                 (rte_logs.dynamic_types_len + 1));
 243         if (new_dynamic_types == NULL)
 244                 return -ENOMEM;
 245         rte_logs.dynamic_types = new_dynamic_types;
 246
 247         ret = __rte_log_register(name, rte_logs.dynamic_types_len);
 248         if (ret < 0)
 249                 return ret;
 250
 251         rte_logs.dynamic_types_len++;
 252
 253         return ret;
 254 }
 255
 256 struct logtype {
 257         uint32_t log_id;
 258         const char *logtype;
 259 };
 260
 261 static const struct logtype logtype_strings[] = {
 262         {RTE_LOGTYPE_EAL,        "eal"},
 263         {RTE_LOGTYPE_MALLOC,     "malloc"},
 264         {RTE_LOGTYPE_RING,       "ring"},
 265         {RTE_LOGTYPE_MEMPOOL,    "mempool"},
 266         {RTE_LOGTYPE_TIMER,      "timer"},
 267         {RTE_LOGTYPE_PMD,        "pmd"},
 268         {RTE_LOGTYPE_HASH,       "hash"},
 269         {RTE_LOGTYPE_LPM,        "lpm"},
 270         {RTE_LOGTYPE_KNI,        "kni"},
 271         {RTE_LOGTYPE_ACL,        "acl"},
 272         {RTE_LOGTYPE_POWER,      "power"},
 273         {RTE_LOGTYPE_METER,      "meter"},
 274         {RTE_LOGTYPE_SCHED,      "sched"},
 275         {RTE_LOGTYPE_PORT,       "port"},
 276         {RTE_LOGTYPE_TABLE,      "table"},
 277         {RTE_LOGTYPE_PIPELINE,   "pipeline"},
 278         {RTE_LOGTYPE_MBUF,       "mbuf"},
 279         {RTE_LOGTYPE_CRYPTODEV,  "cryptodev"},
 280         {RTE_LOGTYPE_EFD,        "efd"},
 281         {RTE_LOGTYPE_EVENTDEV,   "eventdev"},
 282         {RTE_LOGTYPE_USER1,      "user1"},
 283         {RTE_LOGTYPE_USER2,      "user2"},
 284         {RTE_LOGTYPE_USER3,      "user3"},
 285         {RTE_LOGTYPE_USER4,      "user4"},
 286         {RTE_LOGTYPE_USER5,      "user5"},
 287         {RTE_LOGTYPE_USER6,      "user6"},
 288         {RTE_LOGTYPE_USER7,      "user7"},
 289         {RTE_LOGTYPE_USER8,      "user8"}
 290 };
 291
 292 RTE_INIT(rte_log_init);
 293 static void
 294 rte_log_init(void)
 295 {
 296         uint32_t i;
 297
 298 #if RTE_LOG_LEVEL >= RTE_LOG_DEBUG
 299         rte_log_set_global_level(RTE_LOG_INFO);
 300 #else
 301         rte_log_set_global_level(RTE_LOG_LEVEL);
 302 #endif
 303
 304         rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
 305                 sizeof(struct rte_log_dynamic_type));
 306         if (rte_logs.dynamic_types == NULL)
 307                 return;
 308
 309         /* register legacy log types */
 310         for (i = 0; i < RTE_DIM(logtype_strings); i++)
 311                 __rte_log_register(logtype_strings[i].logtype,
 312                                 logtype_strings[i].log_id);
 313
 314         rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
 315 }
 316
 317 static const char *
 318 loglevel_to_string(uint32_t level)
 319 {
 320         switch (level) {
 321         case 0: return "disabled";
 322         case RTE_LOG_EMERG: return "emerg";
 323         case RTE_LOG_ALERT: return "alert";
 324         case RTE_LOG_CRIT: return "critical";
 325         case RTE_LOG_ERR: return "error";
 326         case RTE_LOG_WARNING: return "warning";
 327         case RTE_LOG_NOTICE: return "notice";
 328         case RTE_LOG_INFO: return "info";
 329         case RTE_LOG_DEBUG: return "debug";
 330         default: return "unknown";
 331         }
 332 }
 333
 334 /* dump global level and registered log types */
 335 void
 336 rte_log_dump(FILE *f)
 337 {
 338         size_t i;
 339
 340         fprintf(f, "global log level is %s\n",
 341                 loglevel_to_string(rte_log_get_global_level()));
 342
 343         for (i = 0; i < rte_logs.dynamic_types_len; i++) {
 344                 if (rte_logs.dynamic_types[i].name == NULL)
 345                         continue;
 346                 fprintf(f, "id %zu: %s, level is %s\n",
 347                         i, rte_logs.dynamic_types[i].name,
 348                         loglevel_to_string(rte_logs.dynamic_types[i].loglevel));
 349         }
 350 }
 351
 352 /*
 353  * Generates a log message The message will be sent in the stream
 354  * defined by the previous call to rte_openlog_stream().
 355  */
 356 int
 357 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 358 {
 359         int ret;
 360         FILE *f = rte_logs.file;
 361         if (f == NULL) {
 362                 f = default_log_stream;
 363                 if (f == NULL) {
 364                         /*
 365                          * Grab the current value of stderr here, rather than
 366                          * just initializing default_log_stream to stderr. This
 367                          * ensures that we will always use the current value
 368                          * of stderr, even if the application closes and
 369                          * reopens it.
 370                          */
 371                         f = stderr;
 372                 }
 373         }
 374
 375         if (level > rte_logs.level)
 376                 return 0;
 377         if (logtype >= rte_logs.dynamic_types_len)
 378                 return -1;
 379         if (level > rte_logs.dynamic_types[logtype].loglevel)
 380                 return 0;
 381
 382         /* save loglevel and logtype in a global per-lcore variable */
 383         RTE_PER_LCORE(log_cur_msg).loglevel = level;
 384         RTE_PER_LCORE(log_cur_msg).logtype = logtype;
 385
 386         ret = vfprintf(f, format, ap);
 387         fflush(f);
 388         return ret;
 389 }
 390
 391 /*
 392  * Generates a log message The message will be sent in the stream
 393  * defined by the previous call to rte_openlog_stream().
 394  * No need to check level here, done by rte_vlog().
 395  */
 396 int
 397 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 398 {
 399         va_list ap;
 400         int ret;
 401
 402         va_start(ap, format);
 403         ret = rte_vlog(level, logtype, format, ap);
 404         va_end(ap);
 405         return ret;
 406 }
 407
 408 /*
 409  * Called by environment-specific initialization functions.
 410  */
 411 void
 412 eal_log_set_default(FILE *default_log)
 413 {
 414         default_log_stream = default_log;
 415
 416 #if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
 417         RTE_LOG(NOTICE, EAL,
 418                 "Debug dataplane logs available - lower performance\n");
 419 #endif
 420 }