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