doc: add Meson coding style to contributors guide
[dpdk.git] / lib / librte_eal / common / eal_common_log.c
index a271926..ec8fe23 100644 (file)
@@ -9,29 +9,54 @@
 #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,
 };
 
-/** Global list of valid EAL log level options */
-struct rte_eal_opt_loglevel_list opt_loglevel_list =
+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 {
@@ -39,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);
 
@@ -57,6 +77,24 @@ 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_log_set_global_level(uint32_t level)
@@ -80,30 +118,63 @@ rte_log_get_level(uint32_t type)
        return rte_logs.dynamic_types[type].loglevel;
 }
 
+bool
+rte_log_can_log(uint32_t logtype, uint32_t level)
+{
+       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
 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;
 
-       rte_logs.dynamic_types[type].loglevel = level;
+       logtype_set_level(type, level);
 
        return 0;
 }
 
-/* set level */
+/* set log level by regular expression */
 int
-rte_log_set_level_regexp(const char *pattern, uint32_t level)
+rte_log_set_level_regexp(const char *regex, uint32_t level)
 {
        regex_t r;
        size_t i;
 
-       if (level > RTE_LOG_DEBUG)
+       if (level > RTE_LOG_MAX)
                return -1;
 
-       if (regcomp(&r, pattern, 0) != 0)
+       if (regcomp(&r, regex, 0) != 0)
                return -1;
 
        for (i = 0; i < rte_logs.dynamic_types_len; i++) {
@@ -111,7 +182,7 @@ rte_log_set_level_regexp(const char *pattern, uint32_t level)
                        continue;
                if (regexec(&r, rte_logs.dynamic_types[i].name, 0,
                                NULL, 0) == 0)
-                       rte_logs.dynamic_types[i].loglevel = level;
+                       logtype_set_level(i, level);
        }
 
        regfree(&r);
@@ -119,6 +190,71 @@ rte_log_set_level_regexp(const char *pattern, uint32_t level)
        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;
+
+       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;
+}
+
+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)
 {
@@ -132,7 +268,7 @@ int rte_log_cur_msg_logtype(void)
 }
 
 static int
-rte_log_lookup(const char *name)
+log_lookup(const char *name)
 {
        size_t i;
 
@@ -146,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_INFO;
-
-       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;
 
@@ -181,45 +299,47 @@ 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;
+}
+
+/* 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_experimental
+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;
-       int type;
-
-       type = rte_log_register(name);
-       if (type < 0)
-               return type;
 
        TAILQ_FOREACH(opt_ll, &opt_loglevel_list, next) {
-               regex_t r;
-
-               if (opt_ll->level > RTE_LOG_DEBUG)
+               if (opt_ll->level > RTE_LOG_MAX)
                        continue;
 
-               if (regcomp(&r, opt_ll->re_type, 0) != 0)
-                       continue;
-
-               if (regexec(&r, name, 0, NULL, 0) == 0)
-                       level = opt_ll->level;
-
-               regfree(&r);
+               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;
+               }
        }
 
-       rte_logs.dynamic_types[type].loglevel = level;
-
-       return type;
+       return log_register(name, level);
 }
 
 struct logtype {
@@ -260,9 +380,7 @@ static const struct logtype logtype_strings[] = {
 };
 
 /* Logging should be first initializer (before drivers and bus) */
-RTE_INIT_PRIO(rte_log_init, 101);
-static void
-rte_log_init(void)
+RTE_INIT_PRIO(log_init, LOG)
 {
        uint32_t i;
 
@@ -274,19 +392,21 @@ rte_log_init(void)
                return;
 
        /* register legacy log types */
-       for (i = 0; i < RTE_DIM(logtype_strings); i++)
-               __rte_log_register(logtype_strings[i].logtype,
-                               logtype_strings[i].log_id);
+       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 0: return "disabled";
-       case RTE_LOG_EMERG: return "emerg";
+       case RTE_LOG_EMERG: return "emergency";
        case RTE_LOG_ALERT: return "alert";
        case RTE_LOG_CRIT: return "critical";
        case RTE_LOG_ERR: return "error";
@@ -298,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)
@@ -305,14 +469,14 @@ rte_log_dump(FILE *f)
        size_t i;
 
        fprintf(f, "global log level is %s\n",
-               loglevel_to_string(rte_log_get_global_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));
        }
 }
 
@@ -323,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 */