4 * Copyright(c) 2010-2014 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.
38 #include <sys/types.h>
43 #include <sys/queue.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>
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>
59 #include <rte_mempool.h>
61 #include "eal_private.h"
63 #define LOG_ELT_SIZE 2048
65 #define LOG_HISTORY_MP_NAME "log_history"
67 STAILQ_HEAD(log_history_list, log_history);
70 * The structure of a message log in the log history.
73 STAILQ_ENTRY(log_history) next;
78 static struct rte_mempool *log_history_mp = NULL;
79 static unsigned log_history_size = 0;
80 static struct log_history_list log_history;
82 /* global log structure */
83 struct rte_logs rte_logs = {
85 .level = RTE_LOG_DEBUG,
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;
95 * This global structure stores some informations about the message
96 * that is currently beeing processed by one lcore
99 uint32_t loglevel; /**< log level - see rte_log.h */
100 uint32_t logtype; /**< log type - see rte_log.h */
101 } __rte_cache_aligned;
102 static struct log_cur_msg log_cur_msg[RTE_MAX_LCORE]; /**< per core log */
108 rte_log_add_in_history(const char *buf, size_t size)
110 struct log_history *hist_buf = NULL;
111 static const unsigned hist_buf_size = LOG_ELT_SIZE - sizeof(*hist_buf);
114 if (history_enabled == 0)
117 rte_spinlock_lock(&log_list_lock);
119 /* get a buffer for adding in history */
120 if (log_history_size > RTE_LOG_HISTORY) {
121 hist_buf = STAILQ_FIRST(&log_history);
122 STAILQ_REMOVE_HEAD(&log_history, next);
125 if (rte_mempool_mc_get(log_history_mp, &obj) < 0)
131 if (hist_buf == NULL) {
132 rte_spinlock_unlock(&log_list_lock);
136 /* not enough room for msg, buffer go back in mempool */
137 if (size >= hist_buf_size) {
138 rte_mempool_mp_put(log_history_mp, hist_buf);
139 rte_spinlock_unlock(&log_list_lock);
144 memcpy(hist_buf->buf, buf, size);
145 hist_buf->buf[size] = hist_buf->buf[hist_buf_size-1] = '\0';
146 hist_buf->size = size;
147 STAILQ_INSERT_TAIL(&log_history, hist_buf, next);
149 rte_spinlock_unlock(&log_list_lock);
155 rte_log_set_history(int enable)
157 history_enabled = enable;
160 /* Change the stream that will be used by logging system */
162 rte_openlog_stream(FILE *f)
165 rte_logs.file = default_log_stream;
171 /* Set global log level */
173 rte_set_log_level(uint32_t level)
175 rte_logs.level = (uint32_t)level;
178 /* Get global log level */
180 rte_get_log_level(void)
182 return rte_logs.level;
185 /* Set global log type */
187 rte_set_log_type(uint32_t type, int enable)
190 rte_logs.type |= type;
192 rte_logs.type &= (~type);
195 /* Get global log type */
197 rte_get_log_type(void)
199 return rte_logs.type;
202 /* get the current loglevel for the message beeing processed */
203 int rte_log_cur_msg_loglevel(void)
206 lcore_id = rte_lcore_id();
207 if (lcore_id >= RTE_MAX_LCORE)
208 return rte_get_log_level();
209 return log_cur_msg[lcore_id].loglevel;
212 /* get the current logtype for the message beeing processed */
213 int rte_log_cur_msg_logtype(void)
216 lcore_id = rte_lcore_id();
217 if (lcore_id >= RTE_MAX_LCORE)
218 return rte_get_log_type();
219 return log_cur_msg[lcore_id].logtype;
222 /* Dump log history to file */
224 rte_log_dump_history(FILE *out)
226 struct log_history_list tmp_log_history;
227 struct log_history *hist_buf;
230 /* only one dump at a time */
231 rte_spinlock_lock(&log_dump_lock);
233 /* save list, and re-init to allow logging during dump */
234 rte_spinlock_lock(&log_list_lock);
235 tmp_log_history = log_history;
236 STAILQ_INIT(&log_history);
237 rte_spinlock_unlock(&log_list_lock);
239 for (i=0; i<RTE_LOG_HISTORY; i++) {
241 /* remove one message from history list */
242 hist_buf = STAILQ_FIRST(&tmp_log_history);
244 if (hist_buf == NULL)
247 STAILQ_REMOVE_HEAD(&tmp_log_history, next);
249 /* write on stdout */
250 if (fwrite(hist_buf->buf, hist_buf->size, 1, out) == 0) {
251 rte_mempool_mp_put(log_history_mp, hist_buf);
255 /* put back message structure in pool */
256 rte_mempool_mp_put(log_history_mp, hist_buf);
260 rte_spinlock_unlock(&log_dump_lock);
264 * Generates a log message The message will be sent in the stream
265 * defined by the previous call to rte_openlog_stream().
268 rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
271 FILE *f = rte_logs.file;
274 if ((level > rte_logs.level) || !(logtype & rte_logs.type))
277 /* save loglevel and logtype in a global per-lcore variable */
278 lcore_id = rte_lcore_id();
279 if (lcore_id < RTE_MAX_LCORE) {
280 log_cur_msg[lcore_id].loglevel = level;
281 log_cur_msg[lcore_id].logtype = logtype;
284 ret = vfprintf(f, format, ap);
290 * Generates a log message The message will be sent in the stream
291 * defined by the previous call to rte_openlog_stream().
292 * No need to check level here, done by rte_vlog().
295 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
300 va_start(ap, format);
301 ret = rte_vlog(level, logtype, format, ap);
307 * called by environment-specific log init function to initialize log
311 rte_eal_common_log_init(FILE *default_log)
313 STAILQ_INIT(&log_history);
315 /* reserve RTE_LOG_HISTORY*2 elements, so we can dump and
316 * keep logging during this time */
317 log_history_mp = rte_mempool_create(LOG_HISTORY_MP_NAME, RTE_LOG_HISTORY*2,
323 if ((log_history_mp == NULL) &&
324 ((log_history_mp = rte_mempool_lookup(LOG_HISTORY_MP_NAME)) == NULL)){
325 RTE_LOG(ERR, EAL, "%s(): cannot create log_history mempool\n",
330 default_log_stream = default_log;
331 rte_openlog_stream(default_log);