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>
51 #include <rte_tailq.h>
53 #include <rte_per_lcore.h>
54 #include <rte_lcore.h>
55 #include <rte_atomic.h>
56 #include <rte_debug.h>
57 #include <rte_spinlock.h>
58 #include <rte_branch_prediction.h>
60 #include <rte_mempool.h>
62 #include "eal_private.h"
64 #define LOG_ELT_SIZE 2048
66 #define LOG_HISTORY_MP_NAME "log_history"
68 STAILQ_HEAD(log_history_list, log_history);
71 * The structure of a message log in the log history.
74 STAILQ_ENTRY(log_history) next;
79 static struct rte_mempool *log_history_mp = NULL;
80 static unsigned log_history_size = 0;
81 static struct log_history_list log_history;
83 /* global log structure */
84 struct rte_logs rte_logs = {
86 .level = RTE_LOG_DEBUG,
90 static rte_spinlock_t log_dump_lock = RTE_SPINLOCK_INITIALIZER;
91 static rte_spinlock_t log_list_lock = RTE_SPINLOCK_INITIALIZER;
92 static FILE *default_log_stream;
93 static int history_enabled = 1;
96 * This global structure stores some informations about the message
97 * that is currently beeing processed by one lcore
100 uint32_t loglevel; /**< log level - see rte_log.h */
101 uint32_t logtype; /**< log type - see rte_log.h */
102 } __rte_cache_aligned;
103 static struct log_cur_msg log_cur_msg[RTE_MAX_LCORE]; /**< per core log */
109 rte_log_add_in_history(const char *buf, size_t size)
111 struct log_history *hist_buf = NULL;
112 static const unsigned hist_buf_size = LOG_ELT_SIZE - sizeof(*hist_buf);
115 if (history_enabled == 0)
118 rte_spinlock_lock(&log_list_lock);
120 /* get a buffer for adding in history */
121 if (log_history_size > RTE_LOG_HISTORY) {
122 hist_buf = STAILQ_FIRST(&log_history);
123 STAILQ_REMOVE_HEAD(&log_history, next);
126 if (rte_mempool_mc_get(log_history_mp, &obj) < 0)
132 if (hist_buf == NULL) {
133 rte_spinlock_unlock(&log_list_lock);
137 /* not enough room for msg, buffer go back in mempool */
138 if (size >= hist_buf_size) {
139 rte_mempool_mp_put(log_history_mp, hist_buf);
140 rte_spinlock_unlock(&log_list_lock);
145 memcpy(hist_buf->buf, buf, size);
146 hist_buf->buf[size] = hist_buf->buf[hist_buf_size-1] = '\0';
147 hist_buf->size = size;
148 STAILQ_INSERT_TAIL(&log_history, hist_buf, next);
150 rte_spinlock_unlock(&log_list_lock);
156 rte_log_set_history(int enable)
158 history_enabled = enable;
161 /* Change the stream that will be used by logging system */
163 rte_openlog_stream(FILE *f)
166 rte_logs.file = default_log_stream;
172 /* Set global log level */
174 rte_set_log_level(uint32_t level)
176 rte_logs.level = (uint32_t)level;
179 /* Get global log level */
181 rte_get_log_level(void)
183 return rte_logs.level;
186 /* Set global log type */
188 rte_set_log_type(uint32_t type, int enable)
191 rte_logs.type |= type;
193 rte_logs.type &= (~type);
196 /* get the current loglevel for the message beeing processed */
197 int rte_log_cur_msg_loglevel(void)
200 lcore_id = rte_lcore_id();
201 return log_cur_msg[lcore_id].loglevel;
204 /* get the current logtype for the message beeing processed */
205 int rte_log_cur_msg_logtype(void)
208 lcore_id = rte_lcore_id();
209 return log_cur_msg[lcore_id].logtype;
212 /* Dump log history to file */
214 rte_log_dump_history(FILE *out)
216 struct log_history_list tmp_log_history;
217 struct log_history *hist_buf;
220 /* only one dump at a time */
221 rte_spinlock_lock(&log_dump_lock);
223 /* save list, and re-init to allow logging during dump */
224 rte_spinlock_lock(&log_list_lock);
225 tmp_log_history = log_history;
226 STAILQ_INIT(&log_history);
227 rte_spinlock_unlock(&log_list_lock);
229 for (i=0; i<RTE_LOG_HISTORY; i++) {
231 /* remove one message from history list */
232 hist_buf = STAILQ_FIRST(&tmp_log_history);
234 if (hist_buf == NULL)
237 STAILQ_REMOVE_HEAD(&tmp_log_history, next);
239 /* write on stdout */
240 if (fwrite(hist_buf->buf, hist_buf->size, 1, out) == 0) {
241 rte_mempool_mp_put(log_history_mp, hist_buf);
245 /* put back message structure in pool */
246 rte_mempool_mp_put(log_history_mp, hist_buf);
250 rte_spinlock_unlock(&log_dump_lock);
254 * Generates a log message The message will be sent in the stream
255 * defined by the previous call to rte_openlog_stream().
258 rte_vlog(__attribute__((unused)) uint32_t level,
259 __attribute__((unused)) uint32_t logtype,
260 const char *format, va_list ap)
263 FILE *f = rte_logs.file;
266 /* save loglevel and logtype in a global per-lcore variable */
267 lcore_id = rte_lcore_id();
268 log_cur_msg[lcore_id].loglevel = level;
269 log_cur_msg[lcore_id].logtype = logtype;
271 ret = vfprintf(f, format, ap);
277 * Generates a log message The message will be sent in the stream
278 * defined by the previous call to rte_openlog_stream().
281 rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
286 va_start(ap, format);
287 ret = rte_vlog(level, logtype, format, ap);
293 * called by environment-specific log init function to initialize log
297 rte_eal_common_log_init(FILE *default_log)
299 STAILQ_INIT(&log_history);
301 /* reserve RTE_LOG_HISTORY*2 elements, so we can dump and
302 * keep logging during this time */
303 log_history_mp = rte_mempool_create(LOG_HISTORY_MP_NAME, RTE_LOG_HISTORY*2,
309 if ((log_history_mp == NULL) &&
310 ((log_history_mp = rte_mempool_lookup(LOG_HISTORY_MP_NAME)) == NULL)){
311 RTE_LOG(ERR, EAL, "%s(): cannot create log_history mempool\n",
316 default_log_stream = default_log;
317 rte_openlog_stream(default_log);