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 <string.h>
  35 #include <stdio.h>
  36 #include <stdint.h>
  37 #include <stdarg.h>
  38 #include <sys/types.h>
  39 #include <stdlib.h>
  40 #include <unistd.h>
  41 #include <inttypes.h>
  42 #include <errno.h>
  43 #include <sys/queue.h>
  44
  45 #include <rte_log.h>
  46 #include <rte_memory.h>
  47 #include <rte_memzone.h>
  48 #include <rte_launch.h>
  49 #include <rte_common.h>
  50 #include <rte_cycles.h>
  51 #include <rte_eal.h>
  52 #include <rte_per_lcore.h>
  53 #include <rte_lcore.h>
  54 #include <rte_atomic.h>
  55 #include <rte_debug.h>
  56 #include <rte_spinlock.h>
  57 #include <rte_branch_prediction.h>
  58 #include <rte_ring.h>
  59 #include <rte_mempool.h>
  60
  61 #include "eal_private.h"
  62
  63 #define LOG_ELT_SIZE     2048
  64
  65 #define LOG_HISTORY_MP_NAME "log_history"
  66
  67 STAILQ_HEAD(log_history_list, log_history);
  68
  69 /**
  70  * The structure of a message log in the log history.
  71  */
  72 struct log_history {
  73         STAILQ_ENTRY(log_history) next;
  74         unsigned size;
  75         char buf[0];
  76 };
  77
  78 static struct rte_mempool *log_history_mp = NULL;
  79 static unsigned log_history_size = 0;
  80 static struct log_history_list log_history;
  81
  82 /* global log structure */
  83 struct rte_logs rte_logs = {
  84         .type = ~0,
  85         .level = RTE_LOG_DEBUG,
  86         .file = NULL,
  87 };
  88
  89 static rte_spinlock_t log_dump_lock = RTE_SPINLOCK_INITIALIZER;
  90 static rte_spinlock_t log_list_lock = RTE_SPINLOCK_INITIALIZER;
  91 static FILE *default_log_stream;
  92 static int history_enabled = 1;
  93
  94 /**
  95  * This global structure stores some informations about the message
  96  * that is currently beeing processed by one lcore
  97  */
  98 struct log_cur_msg {
  99         uint32_t loglevel; /**< log level - see rte_log.h */
 100         uint32_t logtype;  /**< log type  - see rte_log.h */
 101 };
 102
 103  /* per core log */
 104 static RTE_DEFINE_PER_LCORE(struct log_cur_msg, log_cur_msg);
 105
 106 /* default logs */
 107
 108 int
 109 rte_log_add_in_history(const char *buf, size_t size)
 110 {
 111         struct log_history *hist_buf = NULL;
 112         static const unsigned hist_buf_size = LOG_ELT_SIZE - sizeof(*hist_buf);
 113         void *obj;
 114
 115         if (history_enabled == 0)
 116                 return 0;
 117
 118         rte_spinlock_lock(&log_list_lock);
 119
 120         /* get a buffer for adding in history */
 121         if (log_history_size > RTE_LOG_HISTORY) {
 122                 hist_buf = STAILQ_FIRST(&log_history);
 123                 if (hist_buf) {
 124                         STAILQ_REMOVE_HEAD(&log_history, next);
 125                         log_history_size--;
 126                 }
 127         }
 128         else {
 129                 if (rte_mempool_mc_get(log_history_mp, &obj) < 0)
 130                         obj = NULL;
 131                 hist_buf = obj;
 132         }
 133
 134         /* no buffer */
 135         if (hist_buf == NULL) {
 136                 rte_spinlock_unlock(&log_list_lock);
 137                 return -ENOBUFS;
 138         }
 139
 140         /* not enough room for msg, buffer go back in mempool */
 141         if (size >= hist_buf_size) {
 142                 rte_mempool_mp_put(log_history_mp, hist_buf);
 143                 rte_spinlock_unlock(&log_list_lock);
 144                 return -ENOBUFS;
 145         }
 146
 147         /* add in history */
 148         memcpy(hist_buf->buf, buf, size);
 149         hist_buf->buf[size] = hist_buf->buf[hist_buf_size-1] = '\0';
 150         hist_buf->size = size;
 151         STAILQ_INSERT_TAIL(&log_history, hist_buf, next);
 152         log_history_size++;
 153         rte_spinlock_unlock(&log_list_lock);
 154
 155         return 0;
 156 }
 157
 158 void
 159 rte_log_set_history(int enable)
 160 {
 161         history_enabled = enable;
 162 }
 163
 164 /* Change the stream that will be used by logging system */
 165 int
 166 rte_openlog_stream(FILE *f)
 167 {
 168         if (f == NULL)
 169                 rte_logs.file = default_log_stream;
 170         else
 171                 rte_logs.file = f;
 172         return 0;
 173 }
 174
 175 /* Set global log level */
 176 void
 177 rte_set_log_level(uint32_t level)
 178 {
 179         rte_logs.level = (uint32_t)level;
 180 }
 181
 182 /* Get global log level */
 183 uint32_t
 184 rte_get_log_level(void)
 185 {
 186         return rte_logs.level;
 187 }
 188
 189 /* Set global log type */
 190 void
 191 rte_set_log_type(uint32_t type, int enable)
 192 {
 193         if (enable)
 194                 rte_logs.type |= type;
 195         else
 196                 rte_logs.type &= (~type);
 197 }
 198
 199 /* Get global log type */
 200 uint32_t
 201 rte_get_log_type(void)
 202 {
 203         return rte_logs.type;
 204 }
 205
 206 /* get the current loglevel for the message beeing processed */
 207 int rte_log_cur_msg_loglevel(void)
 208 {
 209         return RTE_PER_LCORE(log_cur_msg).loglevel;
 210 }
 211
 212 /* get the current logtype for the message beeing processed */
 213 int rte_log_cur_msg_logtype(void)
 214 {
 215         return RTE_PER_LCORE(log_cur_msg).logtype;
 216 }
 217
 218 /* Dump log history to file */
 219 void
 220 rte_log_dump_history(FILE *out)
 221 {
 222         struct log_history_list tmp_log_history;
 223         struct log_history *hist_buf;
 224         unsigned i;
 225
 226         /* only one dump at a time */
 227         rte_spinlock_lock(&log_dump_lock);
 228
 229         /* save list, and re-init to allow logging during dump */
 230         rte_spinlock_lock(&log_list_lock);
 231         tmp_log_history = log_history;
 232         STAILQ_INIT(&log_history);
 233         log_history_size = 0;
 234         rte_spinlock_unlock(&log_list_lock);
 235
 236         for (i=0; i<RTE_LOG_HISTORY; i++) {
 237
 238                 /* remove one message from history list */
 239                 hist_buf = STAILQ_FIRST(&tmp_log_history);
 240
 241                 if (hist_buf == NULL)
 242                         break;
 243
 244                 STAILQ_REMOVE_HEAD(&tmp_log_history, next);
 245
 246                 /* write on stdout */
 247                 if (fwrite(hist_buf->buf, hist_buf->size, 1, out) == 0) {
 248                         rte_mempool_mp_put(log_history_mp, hist_buf);
 249                         break;
 250                 }
 251
 252                 /* put back message structure in pool */
 253                 rte_mempool_mp_put(log_history_mp, hist_buf);
 254         }
 255         fflush(out);
 256
 257         rte_spinlock_unlock(&log_dump_lock);
 258 }
 259
 260 /*
 261  * Generates a log message The message will be sent in the stream
 262  * defined by the previous call to rte_openlog_stream().
 263  */
 264 int
 265 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 266 {
 267         int ret;
 268         FILE *f = rte_logs.file;
 269
 270         if ((level > rte_logs.level) || !(logtype & rte_logs.type))
 271                 return 0;
 272
 273         /* save loglevel and logtype in a global per-lcore variable */
 274         RTE_PER_LCORE(log_cur_msg).loglevel = level;
 275         RTE_PER_LCORE(log_cur_msg).logtype = logtype;
 276
 277         ret = vfprintf(f, format, ap);
 278         fflush(f);
 279         return ret;
 280 }
 281
 282 /*
 283  * Generates a log message The message will be sent in the stream
 284  * defined by the previous call to rte_openlog_stream().
 285  * No need to check level here, done by rte_vlog().
 286  */
 287 int
 288 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 289 {
 290         va_list ap;
 291         int ret;
 292
 293         va_start(ap, format);
 294         ret = rte_vlog(level, logtype, format, ap);
 295         va_end(ap);
 296         return ret;
 297 }
 298
 299 /*
 300  * called by environment-specific log init function to initialize log
 301  * history
 302  */
 303 int
 304 rte_eal_common_log_init(FILE *default_log)
 305 {
 306         STAILQ_INIT(&log_history);
 307
 308         /* reserve RTE_LOG_HISTORY*2 elements, so we can dump and
 309          * keep logging during this time */
 310         log_history_mp = rte_mempool_create(LOG_HISTORY_MP_NAME, RTE_LOG_HISTORY*2,
 311                                 LOG_ELT_SIZE, 0, 0,
 312                                 NULL, NULL,
 313                                 NULL, NULL,
 314                                 SOCKET_ID_ANY, MEMPOOL_F_NO_PHYS_CONTIG);
 315
 316         if ((log_history_mp == NULL) &&
 317             ((log_history_mp = rte_mempool_lookup(LOG_HISTORY_MP_NAME)) == NULL)){
 318                 RTE_LOG(ERR, EAL, "%s(): cannot create log_history mempool\n",
 319                         __func__);
 320                 return -1;
 321         }
 322
 323         default_log_stream = default_log;
 324         rte_openlog_stream(default_log);
 325
 326 #if RTE_LOG_LEVEL >= RTE_LOG_DEBUG
 327         RTE_LOG(NOTICE, EAL, "Debug logs available - lower performance\n");
 328 #endif
 329
 330         return 0;
 331 }