doc: add Meson coding style to contributors guide
[dpdk.git] / lib / librte_eal / common / eal_common_log.c
index 9032621..ec8fe23 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
  */
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <errno.h>
+#include <regex.h>
+#include <fnmatch.h>
 
 #include <rte_eal.h>
 #include <rte_log.h>
+#include <rte_os_shim.h>
 #include <rte_per_lcore.h>
 
-#include "eal_private.h"
+#include "eal_log.h"
 
-/* global log structure */
-struct rte_logs rte_logs = {
-       .type = ~0,
+struct rte_log_dynamic_type {
+       const char *name;
+       uint32_t loglevel;
+};
+
+/** The rte_log structure. */
+static struct rte_logs {
+       uint32_t type;  /**< Bitfield with enabled logs. */
+       uint32_t level; /**< Log level. */
+       FILE *file;     /**< Output file set by rte_openlog_stream, or NULL. */
+       size_t dynamic_types_len;
+       struct rte_log_dynamic_type *dynamic_types;
+} rte_logs = {
+       .type = UINT32_MAX,
        .level = RTE_LOG_DEBUG,
-       .file = NULL,
 };
 
+struct rte_eal_opt_loglevel {
+       /** Next list entry */
+       TAILQ_ENTRY(rte_eal_opt_loglevel) next;
+       /** Compiled regular expression obtained from the option */
+       regex_t re_match;
+       /** Globbing pattern option */
+       char *pattern;
+       /** Log level value obtained from the option */
+       uint32_t level;
+};
+
+TAILQ_HEAD(rte_eal_opt_loglevel_list, rte_eal_opt_loglevel);
+
+/** List of valid EAL log level options */
+static struct rte_eal_opt_loglevel_list opt_loglevel_list =
+       TAILQ_HEAD_INITIALIZER(opt_loglevel_list);
+
 /* Stream to use for logging if rte_logs.file is NULL */
 static FILE *default_log_stream;
 
 /**
- * This global structure stores some informations about the message
+ * This global structure stores some information about the message
  * that is currently being processed by one lcore
  */
 struct log_cur_msg {
@@ -63,11 +64,6 @@ struct log_cur_msg {
        uint32_t logtype;  /**< log type  - see rte_log.h */
 };
 
-struct rte_log_dynamic_type {
-       const char *name;
-       uint32_t loglevel;
-};
-
  /* per core log */
 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
 
@@ -81,42 +77,78 @@ rte_openlog_stream(FILE *f)
        return 0;
 }
 
+FILE *
+rte_log_get_stream(void)
+{
+       FILE *f = rte_logs.file;
+
+       if (f == NULL) {
+               /*
+                * Grab the current value of stderr here, rather than
+                * just initializing default_log_stream to stderr. This
+                * ensures that we will always use the current value
+                * of stderr, even if the application closes and
+                * reopens it.
+                */
+               return default_log_stream ? : stderr;
+       }
+       return f;
+}
+
 /* Set global log level */
 void
-rte_set_log_level(uint32_t level)
+rte_log_set_global_level(uint32_t level)
 {
        rte_logs.level = (uint32_t)level;
 }
 
 /* Get global log level */
 uint32_t
-rte_get_log_level(void)
+rte_log_get_global_level(void)
 {
        return rte_logs.level;
 }
 
-/* Set global log type */
-void
-rte_set_log_type(uint32_t type, int enable)
+int
+rte_log_get_level(uint32_t type)
 {
-       if (type < RTE_LOGTYPE_FIRST_EXT_ID) {
-               if (enable)
-                       rte_logs.type |= type;
-               else
-                       rte_logs.type &= ~type;
-       }
+       if (type >= rte_logs.dynamic_types_len)
+               return -1;
 
-       if (enable)
-               rte_log_set_level(type, 0);
-       else
-               rte_log_set_level(type, RTE_LOG_DEBUG);
+       return rte_logs.dynamic_types[type].loglevel;
 }
 
-/* Get global log type */
-uint32_t
-rte_get_log_type(void)
+bool
+rte_log_can_log(uint32_t logtype, uint32_t level)
 {
-       return rte_logs.type;
+       int log_level;
+
+       if (level > rte_log_get_global_level())
+               return false;
+
+       log_level = rte_log_get_level(logtype);
+       if (log_level < 0)
+               return false;
+
+       if (level > (uint32_t)log_level)
+               return false;
+
+       return true;
+}
+
+static void
+logtype_set_level(uint32_t type, uint32_t level)
+{
+       uint32_t current = rte_logs.dynamic_types[type].loglevel;
+
+       if (current != level) {
+               rte_logs.dynamic_types[type].loglevel = level;
+               RTE_LOG(DEBUG, EAL, "%s log level changed from %s to %s\n",
+                       rte_logs.dynamic_types[type].name == NULL ?
+                               "" : rte_logs.dynamic_types[type].name,
+                       eal_log_level2str(current),
+                       eal_log_level2str(level));
+       }
 }
 
 int
@@ -124,28 +156,119 @@ rte_log_set_level(uint32_t type, uint32_t level)
 {
        if (type >= rte_logs.dynamic_types_len)
                return -1;
-       if (level > RTE_LOG_DEBUG)
+       if (level > RTE_LOG_MAX)
+               return -1;
+
+       logtype_set_level(type, level);
+
+       return 0;
+}
+
+/* set log level by regular expression */
+int
+rte_log_set_level_regexp(const char *regex, uint32_t level)
+{
+       regex_t r;
+       size_t i;
+
+       if (level > RTE_LOG_MAX)
+               return -1;
+
+       if (regcomp(&r, regex, 0) != 0)
+               return -1;
+
+       for (i = 0; i < rte_logs.dynamic_types_len; i++) {
+               if (rte_logs.dynamic_types[i].name == NULL)
+                       continue;
+               if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
+                               NULL, 0) == 0)
+                       logtype_set_level(i, level);
+       }
+
+       regfree(&r);
+
+       return 0;
+}
+
+/*
+ * Save the type string and the loglevel for later dynamic
+ * logtypes which may register later.
+ */
+static int
+log_save_level(uint32_t priority, const char *regex, const char *pattern)
+{
+       struct rte_eal_opt_loglevel *opt_ll = NULL;
+
+       opt_ll = malloc(sizeof(*opt_ll));
+       if (opt_ll == NULL)
+               goto fail;
+
+       opt_ll->level = priority;
+
+       if (regex) {
+               opt_ll->pattern = NULL;
+               if (regcomp(&opt_ll->re_match, regex, 0) != 0)
+                       goto fail;
+       } else if (pattern) {
+               opt_ll->pattern = strdup(pattern);
+               if (opt_ll->pattern == NULL)
+                       goto fail;
+       } else
+               goto fail;
+
+       TAILQ_INSERT_HEAD(&opt_loglevel_list, opt_ll, next);
+       return 0;
+fail:
+       free(opt_ll);
+       return -1;
+}
+
+int
+eal_log_save_regexp(const char *regex, uint32_t level)
+{
+       return log_save_level(level, regex, NULL);
+}
+
+/* set log level based on globbing pattern */
+int
+rte_log_set_level_pattern(const char *pattern, uint32_t level)
+{
+       size_t i;
+
+       if (level > RTE_LOG_MAX)
                return -1;
 
-       rte_logs.dynamic_types[type].loglevel = level;
+       for (i = 0; i < rte_logs.dynamic_types_len; i++) {
+               if (rte_logs.dynamic_types[i].name == NULL)
+                       continue;
+
+               if (fnmatch(pattern, rte_logs.dynamic_types[i].name, 0) == 0)
+                       logtype_set_level(i, level);
+       }
 
        return 0;
 }
 
-/* get the current loglevel for the message beeing processed */
+int
+eal_log_save_pattern(const char *pattern, uint32_t level)
+{
+       return log_save_level(level, NULL, pattern);
+}
+
+/* get the current loglevel for the message being processed */
 int rte_log_cur_msg_loglevel(void)
 {
        return RTE_PER_LCORE(log_cur_msg).loglevel;
 }
 
-/* get the current logtype for the message beeing processed */
+/* get the current logtype for the message being processed */
 int rte_log_cur_msg_logtype(void)
 {
        return RTE_PER_LCORE(log_cur_msg).logtype;
 }
 
 static int
-rte_log_lookup(const char *name)
+log_lookup(const char *name)
 {
        size_t i;
 
@@ -159,31 +282,13 @@ rte_log_lookup(const char *name)
        return -1;
 }
 
-/* register an extended log type, assuming table is large enough, and id
- * is not yet registered.
- */
 static int
-__rte_log_register(const char *name, int id)
-{
-       char *dup_name = strdup(name);
-
-       if (dup_name == NULL)
-               return -ENOMEM;
-
-       rte_logs.dynamic_types[id].name = dup_name;
-       rte_logs.dynamic_types[id].loglevel = RTE_LOG_DEBUG;
-
-       return id;
-}
-
-/* register an extended log type */
-int
-rte_log_register(const char *name)
+log_register(const char *name, uint32_t level)
 {
        struct rte_log_dynamic_type *new_dynamic_types;
-       int id, ret;
+       int id;
 
-       id = rte_log_lookup(name);
+       id = log_lookup(name);
        if (id >= 0)
                return id;
 
@@ -194,60 +299,114 @@ rte_log_register(const char *name)
                return -ENOMEM;
        rte_logs.dynamic_types = new_dynamic_types;
 
-       ret = __rte_log_register(name, rte_logs.dynamic_types_len);
-       if (ret < 0)
-               return ret;
+       id = rte_logs.dynamic_types_len;
+       memset(&rte_logs.dynamic_types[id], 0,
+               sizeof(rte_logs.dynamic_types[id]));
+       rte_logs.dynamic_types[id].name = strdup(name);
+       if (rte_logs.dynamic_types[id].name == NULL)
+               return -ENOMEM;
+       logtype_set_level(id, level);
 
        rte_logs.dynamic_types_len++;
 
-       return ret;
+       return id;
 }
 
-RTE_INIT(rte_log_init);
-static void
-rte_log_init(void)
+/* register an extended log type */
+int
+rte_log_register(const char *name)
+{
+       return log_register(name, RTE_LOG_INFO);
+}
+
+/* Register an extended log type and try to pick its level from EAL options */
+int
+rte_log_register_type_and_pick_level(const char *name, uint32_t level_def)
+{
+       struct rte_eal_opt_loglevel *opt_ll;
+       uint32_t level = level_def;
+
+       TAILQ_FOREACH(opt_ll, &opt_loglevel_list, next) {
+               if (opt_ll->level > RTE_LOG_MAX)
+                       continue;
+
+               if (opt_ll->pattern) {
+                       if (fnmatch(opt_ll->pattern, name, 0) == 0)
+                               level = opt_ll->level;
+               } else {
+                       if (regexec(&opt_ll->re_match, name, 0, NULL, 0) == 0)
+                               level = opt_ll->level;
+               }
+       }
+
+       return log_register(name, level);
+}
+
+struct logtype {
+       uint32_t log_id;
+       const char *logtype;
+};
+
+static const struct logtype logtype_strings[] = {
+       {RTE_LOGTYPE_EAL,        "lib.eal"},
+       {RTE_LOGTYPE_MALLOC,     "lib.malloc"},
+       {RTE_LOGTYPE_RING,       "lib.ring"},
+       {RTE_LOGTYPE_MEMPOOL,    "lib.mempool"},
+       {RTE_LOGTYPE_TIMER,      "lib.timer"},
+       {RTE_LOGTYPE_PMD,        "pmd"},
+       {RTE_LOGTYPE_HASH,       "lib.hash"},
+       {RTE_LOGTYPE_LPM,        "lib.lpm"},
+       {RTE_LOGTYPE_KNI,        "lib.kni"},
+       {RTE_LOGTYPE_ACL,        "lib.acl"},
+       {RTE_LOGTYPE_POWER,      "lib.power"},
+       {RTE_LOGTYPE_METER,      "lib.meter"},
+       {RTE_LOGTYPE_SCHED,      "lib.sched"},
+       {RTE_LOGTYPE_PORT,       "lib.port"},
+       {RTE_LOGTYPE_TABLE,      "lib.table"},
+       {RTE_LOGTYPE_PIPELINE,   "lib.pipeline"},
+       {RTE_LOGTYPE_MBUF,       "lib.mbuf"},
+       {RTE_LOGTYPE_CRYPTODEV,  "lib.cryptodev"},
+       {RTE_LOGTYPE_EFD,        "lib.efd"},
+       {RTE_LOGTYPE_EVENTDEV,   "lib.eventdev"},
+       {RTE_LOGTYPE_GSO,        "lib.gso"},
+       {RTE_LOGTYPE_USER1,      "user1"},
+       {RTE_LOGTYPE_USER2,      "user2"},
+       {RTE_LOGTYPE_USER3,      "user3"},
+       {RTE_LOGTYPE_USER4,      "user4"},
+       {RTE_LOGTYPE_USER5,      "user5"},
+       {RTE_LOGTYPE_USER6,      "user6"},
+       {RTE_LOGTYPE_USER7,      "user7"},
+       {RTE_LOGTYPE_USER8,      "user8"}
+};
+
+/* Logging should be first initializer (before drivers and bus) */
+RTE_INIT_PRIO(log_init, LOG)
 {
+       uint32_t i;
+
+       rte_log_set_global_level(RTE_LOG_DEBUG);
+
        rte_logs.dynamic_types = calloc(RTE_LOGTYPE_FIRST_EXT_ID,
                sizeof(struct rte_log_dynamic_type));
        if (rte_logs.dynamic_types == NULL)
                return;
 
-       /* register legacy log types, keep sync'd with RTE_LOGTYPE_* */
-       __rte_log_register("eal", 0);
-       __rte_log_register("malloc", 1);
-       __rte_log_register("ring", 2);
-       __rte_log_register("mempool", 3);
-       __rte_log_register("timer", 4);
-       __rte_log_register("pmd", 5);
-       __rte_log_register("hash", 6);
-       __rte_log_register("lpm", 7);
-       __rte_log_register("kni", 8);
-       __rte_log_register("acl", 9);
-       __rte_log_register("power", 10);
-       __rte_log_register("meter", 11);
-       __rte_log_register("sched", 12);
-       __rte_log_register("port", 13);
-       __rte_log_register("table", 14);
-       __rte_log_register("pipeline", 15);
-       __rte_log_register("mbuf", 16);
-       __rte_log_register("cryptodev", 17);
-       __rte_log_register("user1", 24);
-       __rte_log_register("user2", 25);
-       __rte_log_register("user3", 26);
-       __rte_log_register("user4", 27);
-       __rte_log_register("user5", 28);
-       __rte_log_register("user6", 29);
-       __rte_log_register("user7", 30);
-       __rte_log_register("user8", 31);
+       /* register legacy log types */
+       for (i = 0; i < RTE_DIM(logtype_strings); i++) {
+               rte_logs.dynamic_types[logtype_strings[i].log_id].name =
+                       strdup(logtype_strings[i].logtype);
+               logtype_set_level(logtype_strings[i].log_id, RTE_LOG_INFO);
+       }
 
        rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
 }
 
-static const char *
-loglevel_to_string(uint32_t level)
+const char *
+eal_log_level2str(uint32_t level)
 {
        switch (level) {
-       case RTE_LOG_EMERG: return "emerg";
+       case 0: return "disabled";
+       case RTE_LOG_EMERG: return "emergency";
        case RTE_LOG_ALERT: return "alert";
        case RTE_LOG_CRIT: return "critical";
        case RTE_LOG_ERR: return "error";
@@ -259,6 +418,50 @@ loglevel_to_string(uint32_t level)
        }
 }
 
+static int
+log_type_compare(const void *a, const void *b)
+{
+       const struct rte_log_dynamic_type *type_a = a;
+       const struct rte_log_dynamic_type *type_b = b;
+
+       if (type_a->name == NULL && type_b->name == NULL)
+               return 0;
+       if (type_a->name == NULL)
+               return -1;
+       if (type_b->name == NULL)
+               return 1;
+       return strcmp(type_a->name, type_b->name);
+}
+
+/* Dump name of each logtype, one per line. */
+void
+rte_log_list_types(FILE *out, const char *prefix)
+{
+       struct rte_log_dynamic_type *sorted_types;
+       const size_t type_size = sizeof(rte_logs.dynamic_types[0]);
+       const size_t type_count = rte_logs.dynamic_types_len;
+       const size_t total_size = type_size * type_count;
+       size_t type;
+
+       sorted_types = malloc(total_size);
+       if (sorted_types == NULL) {
+               /* no sorting - unlikely */
+               sorted_types = rte_logs.dynamic_types;
+       } else {
+               memcpy(sorted_types, rte_logs.dynamic_types, total_size);
+               qsort(sorted_types, type_count, type_size, log_type_compare);
+       }
+
+       for (type = 0; type < type_count; ++type) {
+               if (sorted_types[type].name == NULL)
+                       continue;
+               fprintf(out, "%s%s\n", prefix, sorted_types[type].name);
+       }
+
+       if (sorted_types != rte_logs.dynamic_types)
+               free(sorted_types);
+}
+
 /* dump global level and registered log types */
 void
 rte_log_dump(FILE *f)
@@ -266,14 +469,14 @@ rte_log_dump(FILE *f)
        size_t i;
 
        fprintf(f, "global log level is %s\n",
-               loglevel_to_string(rte_get_log_level()));
+               eal_log_level2str(rte_log_get_global_level()));
 
        for (i = 0; i < rte_logs.dynamic_types_len; i++) {
                if (rte_logs.dynamic_types[i].name == NULL)
                        continue;
                fprintf(f, "id %zu: %s, level is %s\n",
                        i, rte_logs.dynamic_types[i].name,
-                       loglevel_to_string(rte_logs.dynamic_types[i].loglevel));
+                       eal_log_level2str(rte_logs.dynamic_types[i].loglevel));
        }
 }
 
@@ -284,27 +487,12 @@ rte_log_dump(FILE *f)
 int
 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 {
+       FILE *f = rte_log_get_stream();
        int ret;
-       FILE *f = rte_logs.file;
-       if (f == NULL) {
-               f = default_log_stream;
-               if (f == NULL) {
-                       /*
-                        * Grab the current value of stderr here, rather than
-                        * just initializing default_log_stream to stderr. This
-                        * ensures that we will always use the current value
-                        * of stderr, even if the application closes and
-                        * reopens it.
-                        */
-                       f = stderr;
-               }
-       }
 
-       if (level > rte_logs.level)
-               return 0;
        if (logtype >= rte_logs.dynamic_types_len)
                return -1;
-       if (level > rte_logs.dynamic_types[logtype].loglevel)
+       if (!rte_log_can_log(logtype, level))
                return 0;
 
        /* save loglevel and logtype in a global per-lcore variable */