lib: fix typos
[dpdk.git] / lib / librte_eal / common / eal_common_log.c
index b5e37bb..e894b75 100644 (file)
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include <string.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <stdarg.h>
-#include <sys/types.h>
 #include <stdlib.h>
-#include <unistd.h>
-#include <inttypes.h>
+#include <string.h>
 #include <errno.h>
-#include <sys/queue.h>
+#include <regex.h>
 
-#include <rte_log.h>
-#include <rte_memory.h>
-#include <rte_memzone.h>
-#include <rte_launch.h>
-#include <rte_common.h>
-#include <rte_cycles.h>
 #include <rte_eal.h>
+#include <rte_log.h>
 #include <rte_per_lcore.h>
-#include <rte_lcore.h>
-#include <rte_atomic.h>
-#include <rte_debug.h>
-#include <rte_spinlock.h>
-#include <rte_branch_prediction.h>
-#include <rte_ring.h>
-#include <rte_mempool.h>
 
 #include "eal_private.h"
 
-#define LOG_ELT_SIZE     2048
-
-#define LOG_HISTORY_MP_NAME "log_history"
-
-STAILQ_HEAD(log_history_list, log_history);
-
-/**
- * The structure of a message log in the log history.
- */
-struct log_history {
-       STAILQ_ENTRY(log_history) next;
-       unsigned size;
-       char buf[0];
-};
-
-static struct rte_mempool *log_history_mp = NULL;
-static unsigned log_history_size = 0;
-static struct log_history_list log_history;
-
 /* global log structure */
 struct rte_logs rte_logs = {
        .type = ~0,
@@ -86,175 +52,262 @@ struct rte_logs rte_logs = {
        .file = NULL,
 };
 
-static rte_spinlock_t log_dump_lock = RTE_SPINLOCK_INITIALIZER;
-static rte_spinlock_t log_list_lock = RTE_SPINLOCK_INITIALIZER;
+/* Stream to use for logging if rte_logs.file is NULL */
 static FILE *default_log_stream;
-static int history_enabled = 1;
 
 /**
  * This global structure stores some informations about the message
- * that is currently beeing processed by one lcore
+ * that is currently being processed by one lcore
  */
 struct log_cur_msg {
        uint32_t loglevel; /**< log level - see rte_log.h */
        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);
 
 /* default logs */
 
-int
-rte_log_add_in_history(const char *buf, size_t size)
-{
-       struct log_history *hist_buf = NULL;
-       static const unsigned hist_buf_size = LOG_ELT_SIZE - sizeof(*hist_buf);
-       void *obj;
-
-       if (history_enabled == 0)
-               return 0;
-
-       rte_spinlock_lock(&log_list_lock);
-
-       /* get a buffer for adding in history */
-       if (log_history_size > RTE_LOG_HISTORY) {
-               hist_buf = STAILQ_FIRST(&log_history);
-               if (hist_buf) {
-                       STAILQ_REMOVE_HEAD(&log_history, next);
-                       log_history_size--;
-               }
-       }
-       else {
-               if (rte_mempool_mc_get(log_history_mp, &obj) < 0)
-                       obj = NULL;
-               hist_buf = obj;
-       }
-
-       /* no buffer */
-       if (hist_buf == NULL) {
-               rte_spinlock_unlock(&log_list_lock);
-               return -ENOBUFS;
-       }
-
-       /* not enough room for msg, buffer go back in mempool */
-       if (size >= hist_buf_size) {
-               rte_mempool_mp_put(log_history_mp, hist_buf);
-               rte_spinlock_unlock(&log_list_lock);
-               return -ENOBUFS;
-       }
-
-       /* add in history */
-       memcpy(hist_buf->buf, buf, size);
-       hist_buf->buf[size] = hist_buf->buf[hist_buf_size-1] = '\0';
-       hist_buf->size = size;
-       STAILQ_INSERT_TAIL(&log_history, hist_buf, next);
-       log_history_size++;
-       rte_spinlock_unlock(&log_list_lock);
-
-       return 0;
-}
-
-void
-rte_log_set_history(int enable)
-{
-       history_enabled = enable;
-}
-
 /* Change the stream that will be used by logging system */
 int
 rte_openlog_stream(FILE *f)
 {
-       if (f == NULL)
-               rte_logs.file = default_log_stream;
-       else
-               rte_logs.file = f;
+       rte_logs.file = f;
        return 0;
 }
 
 /* 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 (enable)
-               rte_logs.type |= type;
-       else
-               rte_logs.type &= (~type);
+       if (type >= rte_logs.dynamic_types_len)
+               return -1;
+
+       return rte_logs.dynamic_types[type].loglevel;
 }
 
-/* Get global log type */
-uint32_t
-rte_get_log_type(void)
+int
+rte_log_set_level(uint32_t type, uint32_t level)
 {
-       return rte_logs.type;
+       if (type >= rte_logs.dynamic_types_len)
+               return -1;
+       if (level > RTE_LOG_DEBUG)
+               return -1;
+
+       rte_logs.dynamic_types[type].loglevel = level;
+
+       return 0;
 }
 
-/* get the current loglevel for the message beeing processed */
+/* set level */
+int
+rte_log_set_level_regexp(const char *pattern, uint32_t level)
+{
+       regex_t r;
+       size_t i;
+
+       if (level > RTE_LOG_DEBUG)
+               return -1;
+
+       if (regcomp(&r, pattern, 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)
+                       rte_logs.dynamic_types[i].loglevel = level;
+       }
+
+       return 0;
+}
+
+/* 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;
 }
 
-/* Dump log history to file */
-void
-rte_log_dump_history(FILE *out)
+static int
+rte_log_lookup(const char *name)
 {
-       struct log_history_list tmp_log_history;
-       struct log_history *hist_buf;
-       unsigned i;
+       size_t i;
 
-       /* only one dump at a time */
-       rte_spinlock_lock(&log_dump_lock);
+       for (i = 0; i < rte_logs.dynamic_types_len; i++) {
+               if (rte_logs.dynamic_types[i].name == NULL)
+                       continue;
+               if (strcmp(name, rte_logs.dynamic_types[i].name) == 0)
+                       return i;
+       }
 
-       /* save list, and re-init to allow logging during dump */
-       rte_spinlock_lock(&log_list_lock);
-       tmp_log_history = log_history;
-       STAILQ_INIT(&log_history);
-       log_history_size = 0;
-       rte_spinlock_unlock(&log_list_lock);
+       return -1;
+}
 
-       for (i=0; i<RTE_LOG_HISTORY; i++) {
+/* 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);
 
-               /* remove one message from history list */
-               hist_buf = STAILQ_FIRST(&tmp_log_history);
+       if (dup_name == NULL)
+               return -ENOMEM;
 
-               if (hist_buf == NULL)
-                       break;
+       rte_logs.dynamic_types[id].name = dup_name;
+       rte_logs.dynamic_types[id].loglevel = RTE_LOG_DEBUG;
 
-               STAILQ_REMOVE_HEAD(&tmp_log_history, next);
+       return id;
+}
 
-               /* write on stdout */
-               if (fwrite(hist_buf->buf, hist_buf->size, 1, out) == 0) {
-                       rte_mempool_mp_put(log_history_mp, hist_buf);
-                       break;
-               }
+/* register an extended log type */
+int
+rte_log_register(const char *name)
+{
+       struct rte_log_dynamic_type *new_dynamic_types;
+       int id, ret;
+
+       id = rte_log_lookup(name);
+       if (id >= 0)
+               return id;
+
+       new_dynamic_types = realloc(rte_logs.dynamic_types,
+               sizeof(struct rte_log_dynamic_type) *
+               (rte_logs.dynamic_types_len + 1));
+       if (new_dynamic_types == NULL)
+               return -ENOMEM;
+       rte_logs.dynamic_types = new_dynamic_types;
+
+       ret = __rte_log_register(name, rte_logs.dynamic_types_len);
+       if (ret < 0)
+               return ret;
+
+       rte_logs.dynamic_types_len++;
+
+       return ret;
+}
+
+struct logtype {
+       uint32_t log_id;
+       const char *logtype;
+};
+
+static const struct logtype logtype_strings[] = {
+       {RTE_LOGTYPE_EAL,        "eal"},
+       {RTE_LOGTYPE_MALLOC,     "malloc"},
+       {RTE_LOGTYPE_RING,       "ring"},
+       {RTE_LOGTYPE_MEMPOOL,    "mempool"},
+       {RTE_LOGTYPE_TIMER,      "timer"},
+       {RTE_LOGTYPE_PMD,        "pmd"},
+       {RTE_LOGTYPE_HASH,       "hash"},
+       {RTE_LOGTYPE_LPM,        "lpm"},
+       {RTE_LOGTYPE_KNI,        "kni"},
+       {RTE_LOGTYPE_ACL,        "acl"},
+       {RTE_LOGTYPE_POWER,      "power"},
+       {RTE_LOGTYPE_METER,      "meter"},
+       {RTE_LOGTYPE_SCHED,      "sched"},
+       {RTE_LOGTYPE_PORT,       "port"},
+       {RTE_LOGTYPE_TABLE,      "table"},
+       {RTE_LOGTYPE_PIPELINE,   "pipeline"},
+       {RTE_LOGTYPE_MBUF,       "mbuf"},
+       {RTE_LOGTYPE_CRYPTODEV,  "cryptodev"},
+       {RTE_LOGTYPE_EFD,        "efd"},
+       {RTE_LOGTYPE_EVENTDEV,   "eventdev"},
+       {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(rte_log_init, 101);
+static void
+rte_log_init(void)
+{
+       uint32_t i;
 
-               /* put back message structure in pool */
-               rte_mempool_mp_put(log_history_mp, hist_buf);
+#if RTE_LOG_LEVEL >= RTE_LOG_DEBUG
+       rte_log_set_global_level(RTE_LOG_INFO);
+#else
+       rte_log_set_global_level(RTE_LOG_LEVEL);
+#endif
+
+       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 */
+       for (i = 0; i < RTE_DIM(logtype_strings); i++)
+               __rte_log_register(logtype_strings[i].logtype,
+                               logtype_strings[i].log_id);
+
+       rte_logs.dynamic_types_len = RTE_LOGTYPE_FIRST_EXT_ID;
+}
+
+static const char *
+loglevel_to_string(uint32_t level)
+{
+       switch (level) {
+       case 0: return "disabled";
+       case RTE_LOG_EMERG: return "emerg";
+       case RTE_LOG_ALERT: return "alert";
+       case RTE_LOG_CRIT: return "critical";
+       case RTE_LOG_ERR: return "error";
+       case RTE_LOG_WARNING: return "warning";
+       case RTE_LOG_NOTICE: return "notice";
+       case RTE_LOG_INFO: return "info";
+       case RTE_LOG_DEBUG: return "debug";
+       default: return "unknown";
        }
-       fflush(out);
+}
+
+/* dump global level and registered log types */
+void
+rte_log_dump(FILE *f)
+{
+       size_t i;
+
+       fprintf(f, "global log level is %s\n",
+               loglevel_to_string(rte_log_get_global_level()));
 
-       rte_spinlock_unlock(&log_dump_lock);
+       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));
+       }
 }
 
 /*
@@ -266,8 +319,25 @@ rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 {
        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) || !(logtype & rte_logs.type))
+       if (level > rte_logs.level)
+               return 0;
+       if (logtype >= rte_logs.dynamic_types_len)
+               return -1;
+       if (level > rte_logs.dynamic_types[logtype].loglevel)
                return 0;
 
        /* save loglevel and logtype in a global per-lcore variable */
@@ -297,35 +367,15 @@ rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 }
 
 /*
- * called by environment-specific log init function to initialize log
- * history
+ * Called by environment-specific initialization functions.
  */
-int
-rte_eal_common_log_init(FILE *default_log)
+void
+eal_log_set_default(FILE *default_log)
 {
-       STAILQ_INIT(&log_history);
-
-       /* reserve RTE_LOG_HISTORY*2 elements, so we can dump and
-        * keep logging during this time */
-       log_history_mp = rte_mempool_create(LOG_HISTORY_MP_NAME, RTE_LOG_HISTORY*2,
-                               LOG_ELT_SIZE, 0, 0,
-                               NULL, NULL,
-                               NULL, NULL,
-                               SOCKET_ID_ANY, MEMPOOL_F_NO_PHYS_CONTIG);
-
-       if ((log_history_mp == NULL) &&
-           ((log_history_mp = rte_mempool_lookup(LOG_HISTORY_MP_NAME)) == NULL)){
-               RTE_LOG(ERR, EAL, "%s(): cannot create log_history mempool\n",
-                       __func__);
-               return -1;
-       }
-
        default_log_stream = default_log;
-       rte_openlog_stream(default_log);
 
-#if RTE_LOG_LEVEL >= RTE_LOG_DEBUG
-       RTE_LOG(NOTICE, EAL, "Debug logs available - lower performance\n");
+#if RTE_LOG_DP_LEVEL >= RTE_LOG_DEBUG
+       RTE_LOG(NOTICE, EAL,
+               "Debug dataplane logs available - lower performance\n");
 #endif
-
-       return 0;
 }