4 * Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
39 #include <sys/types.h>
44 #include <sys/queue.h>
47 #include <rte_memory.h>
48 #include <rte_memzone.h>
49 #include <rte_launch.h>
50 #include <rte_common.h>
51 #include <rte_cycles.h>
52 #include <rte_tailq.h>
54 #include <rte_per_lcore.h>
55 #include <rte_lcore.h>
56 #include <rte_atomic.h>
57 #include <rte_debug.h>
58 #include <rte_spinlock.h>
59 #include <rte_branch_prediction.h>
61 #include <rte_mempool.h>
63 #include "eal_private.h"
65 #define LOG_ELT_SIZE 2048
67 #define LOG_HISTORY_MP_NAME "log_history"
69 STAILQ_HEAD(log_history_list, log_history);
72 * The structure of a message log in the log history.
75 STAILQ_ENTRY(log_history) next;
80 static struct rte_mempool *log_history_mp = NULL;
81 static unsigned log_history_size = 0;
82 static struct log_history_list log_history;
84 /* global log structure */
85 struct rte_logs rte_logs = {
87 .level = RTE_LOG_DEBUG,
91 static rte_spinlock_t log_dump_lock = RTE_SPINLOCK_INITIALIZER;
92 static rte_spinlock_t log_list_lock = RTE_SPINLOCK_INITIALIZER;
93 static FILE *default_log_stream;
94 static int history_enabled = 1;
97 * This global structure stores some informations about the message
98 * that is currently beeing processed by one lcore
101 uint32_t loglevel; /**< log level - see rte_log.h */
102 uint32_t logtype; /**< log type - see rte_log.h */
103 } __rte_cache_aligned;
104 static struct log_cur_msg log_cur_msg[RTE_MAX_LCORE]; /**< per core log */
109 * early log function, used during boot when mempool (hence log
110 * history) is not available
113 early_log_write(__attribute__((unused)) void *c, const char *buf, size_t size)
116 ret = fwrite(buf, size, 1, stdout);
124 early_log_read(__attribute__((unused)) void *c,
125 __attribute__((unused)) char *buf,
126 __attribute__((unused)) size_t size)
132 * this is needed because cookies_io_functions_t has a different
133 * prototype between newlib and glibc
135 #ifdef RTE_EXEC_ENV_LINUXAPP
137 early_log_seek(__attribute__((unused)) void *c,
138 __attribute__((unused)) off64_t *offset,
139 __attribute__((unused)) int whence)
145 early_log_seek(__attribute__((unused)) void *c,
146 __attribute__((unused)) _off_t *offset,
147 __attribute__((unused)) int whence)
154 early_log_close(__attribute__((unused)) void *c)
159 static cookie_io_functions_t early_log_func = {
160 .read = early_log_read,
161 .write = early_log_write,
162 .seek = early_log_seek,
163 .close = early_log_close
165 static FILE *early_log_stream;
170 rte_log_add_in_history(const char *buf, size_t size)
172 struct log_history *hist_buf = NULL;
173 static const unsigned hist_buf_size = LOG_ELT_SIZE - sizeof(*hist_buf);
176 if (history_enabled == 0)
179 rte_spinlock_lock(&log_list_lock);
181 /* get a buffer for adding in history */
182 if (log_history_size > RTE_LOG_HISTORY) {
183 hist_buf = STAILQ_FIRST(&log_history);
184 STAILQ_REMOVE_HEAD(&log_history, next);
187 if (rte_mempool_mc_get(log_history_mp, &obj) < 0)
193 if (hist_buf == NULL) {
194 rte_spinlock_unlock(&log_list_lock);
198 /* not enough room for msg, buffer go back in mempool */
199 if (size >= hist_buf_size) {
200 rte_mempool_mp_put(log_history_mp, hist_buf);
201 rte_spinlock_unlock(&log_list_lock);
206 memcpy(hist_buf->buf, buf, size);
207 hist_buf->buf[size] = hist_buf->buf[hist_buf_size-1] = '\0';
208 hist_buf->size = size;
209 STAILQ_INSERT_TAIL(&log_history, hist_buf, next);
211 rte_spinlock_unlock(&log_list_lock);
217 rte_log_set_history(int enable)
219 history_enabled = enable;
222 /* Change the stream that will be used by logging system */
224 rte_openlog_stream(FILE *f)
227 rte_logs.file = default_log_stream;
233 /* Set global log level */
235 rte_set_log_level(uint32_t level)
237 rte_logs.level = (uint32_t)level;
240 /* Set global log type */
242 rte_set_log_type(uint32_t type, int enable)
245 rte_logs.type |= type;
247 rte_logs.type &= (~type);
250 /* get the current loglevel for the message beeing processed */
251 int rte_log_cur_msg_loglevel(void)
254 lcore_id = rte_lcore_id();
255 return log_cur_msg[lcore_id].loglevel;
258 /* get the current logtype for the message beeing processed */
259 int rte_log_cur_msg_logtype(void)
262 lcore_id = rte_lcore_id();
263 return log_cur_msg[lcore_id].logtype;
266 /* Dump log history on console */
268 rte_log_dump_history(void)
270 struct log_history_list tmp_log_history;
271 struct log_history *hist_buf;
274 /* only one dump at a time */
275 rte_spinlock_lock(&log_dump_lock);
277 /* save list, and re-init to allow logging during dump */
278 rte_spinlock_lock(&log_list_lock);
279 tmp_log_history = log_history;
280 STAILQ_INIT(&log_history);
281 rte_spinlock_unlock(&log_list_lock);
283 for (i=0; i<RTE_LOG_HISTORY; i++) {
285 /* remove one message from history list */
286 hist_buf = STAILQ_FIRST(&tmp_log_history);
288 if (hist_buf == NULL)
291 STAILQ_REMOVE_HEAD(&tmp_log_history, next);
293 /* write on stdout */
294 if (fwrite(hist_buf->buf, hist_buf->size, 1, stdout) == 0) {
295 rte_mempool_mp_put(log_history_mp, hist_buf);
299 /* put back message structure in pool */
300 rte_mempool_mp_put(log_history_mp, hist_buf);
304 rte_spinlock_unlock(&log_dump_lock);
308 * Generates a log message The message will be sent in the stream
309 * defined by the previous call to rte_openlog_stream().
312 rte_vlog(__attribute__((unused)) uint32_t level,
313 __attribute__((unused)) uint32_t logtype,
314 const char *format, va_list ap)
317 FILE *f = rte_logs.file;
320 /* save loglevel and logtype in a global per-lcore variable */
321 lcore_id = rte_lcore_id();
322 log_cur_msg[lcore_id].loglevel = level;
323 log_cur_msg[lcore_id].logtype = logtype;
325 ret = vfprintf(f, format, ap);
331 * Generates a log message The message will be sent in the stream
332 * defined by the previous call to rte_openlog_stream().
335 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
340 va_start(ap, format);
341 ret = rte_vlog(level, logtype, format, ap);
347 * init the log library, called by rte_eal_init() to enable early
351 rte_eal_log_early_init(void)
353 early_log_stream = fopencookie(NULL, "w+", early_log_func);
354 if (early_log_stream == NULL) {
355 printf("Cannot configure early_log_stream\n");
358 rte_openlog_stream(early_log_stream);
363 * called by environment-specific log init function to initialize log
367 rte_eal_common_log_init(FILE *default_log)
369 STAILQ_INIT(&log_history);
371 /* reserve RTE_LOG_HISTORY*2 elements, so we can dump and
372 * keep logging during this time */
373 log_history_mp = rte_mempool_create(LOG_HISTORY_MP_NAME, RTE_LOG_HISTORY*2,
379 if ((log_history_mp == NULL) &&
380 ((log_history_mp = rte_mempool_lookup(LOG_HISTORY_MP_NAME)) == NULL)){
381 RTE_LOG(ERR, EAL, "%s(): cannot create log_history mempool\n",
386 default_log_stream = default_log;
387 rte_openlog_stream(default_log);