4 * Copyright(c) 2010-2017 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.
42 * This file provides a log API to RTE applications.
53 #include <rte_common.h>
55 struct rte_log_dynamic_type;
57 /** The rte_log structure. */
59 uint32_t type; /**< Bitfield with enabled logs. */
60 uint32_t level; /**< Log level. */
61 FILE *file; /**< Output file set by rte_openlog_stream, or NULL. */
62 size_t dynamic_types_len;
63 struct rte_log_dynamic_type *dynamic_types;
66 /** Global log informations */
67 extern struct rte_logs rte_logs;
70 #define RTE_LOGTYPE_EAL 0 /**< Log related to eal. */
71 #define RTE_LOGTYPE_MALLOC 1 /**< Log related to malloc. */
72 #define RTE_LOGTYPE_RING 2 /**< Log related to ring. */
73 #define RTE_LOGTYPE_MEMPOOL 3 /**< Log related to mempool. */
74 #define RTE_LOGTYPE_TIMER 4 /**< Log related to timers. */
75 #define RTE_LOGTYPE_PMD 5 /**< Log related to poll mode driver. */
76 #define RTE_LOGTYPE_HASH 6 /**< Log related to hash table. */
77 #define RTE_LOGTYPE_LPM 7 /**< Log related to LPM. */
78 #define RTE_LOGTYPE_KNI 8 /**< Log related to KNI. */
79 #define RTE_LOGTYPE_ACL 9 /**< Log related to ACL. */
80 #define RTE_LOGTYPE_POWER 10 /**< Log related to power. */
81 #define RTE_LOGTYPE_METER 11 /**< Log related to QoS meter. */
82 #define RTE_LOGTYPE_SCHED 12 /**< Log related to QoS port scheduler. */
83 #define RTE_LOGTYPE_PORT 13 /**< Log related to port. */
84 #define RTE_LOGTYPE_TABLE 14 /**< Log related to table. */
85 #define RTE_LOGTYPE_PIPELINE 15 /**< Log related to pipeline. */
86 #define RTE_LOGTYPE_MBUF 16 /**< Log related to mbuf. */
87 #define RTE_LOGTYPE_CRYPTODEV 17 /**< Log related to cryptodev. */
88 #define RTE_LOGTYPE_EFD 18 /**< Log related to EFD. */
89 #define RTE_LOGTYPE_EVENTDEV 19 /**< Log related to eventdev. */
90 #define RTE_LOGTYPE_GSO 20 /**< Log related to GSO. */
92 /* these log types can be used in an application */
93 #define RTE_LOGTYPE_USER1 24 /**< User-defined log type 1. */
94 #define RTE_LOGTYPE_USER2 25 /**< User-defined log type 2. */
95 #define RTE_LOGTYPE_USER3 26 /**< User-defined log type 3. */
96 #define RTE_LOGTYPE_USER4 27 /**< User-defined log type 4. */
97 #define RTE_LOGTYPE_USER5 28 /**< User-defined log type 5. */
98 #define RTE_LOGTYPE_USER6 29 /**< User-defined log type 6. */
99 #define RTE_LOGTYPE_USER7 30 /**< User-defined log type 7. */
100 #define RTE_LOGTYPE_USER8 31 /**< User-defined log type 8. */
102 /** First identifier for extended logs */
103 #define RTE_LOGTYPE_FIRST_EXT_ID 32
105 /* Can't use 0, as it gives compiler warnings */
106 #define RTE_LOG_EMERG 1U /**< System is unusable. */
107 #define RTE_LOG_ALERT 2U /**< Action must be taken immediately. */
108 #define RTE_LOG_CRIT 3U /**< Critical conditions. */
109 #define RTE_LOG_ERR 4U /**< Error conditions. */
110 #define RTE_LOG_WARNING 5U /**< Warning conditions. */
111 #define RTE_LOG_NOTICE 6U /**< Normal but significant condition. */
112 #define RTE_LOG_INFO 7U /**< Informational. */
113 #define RTE_LOG_DEBUG 8U /**< Debug-level messages. */
116 * Change the stream that will be used by the logging system.
118 * This can be done at any time. The f argument represents the stream
119 * to be used to send the logs. If f is NULL, the default output is
123 * Pointer to the stream.
126 * - Negative on error.
128 int rte_openlog_stream(FILE *f);
131 * Set the global log level.
133 * After this call, logs with a level lower or equal than the level
134 * passed as argument will be displayed.
137 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
139 void rte_log_set_global_level(uint32_t level);
142 * Deprecated, replaced by rte_log_set_global_level().
145 void rte_set_log_level(uint32_t level);
148 * Get the global log level.
151 * The current global log level.
153 uint32_t rte_log_get_global_level(void);
156 * Deprecated, replaced by rte_log_get_global_level().
159 uint32_t rte_get_log_level(void);
162 * Enable or disable the log type.
165 * Log type, for example, RTE_LOGTYPE_EAL.
167 * True for enable; false for disable.
170 void rte_set_log_type(uint32_t type, int enable);
173 * Get the global log type.
176 uint32_t rte_get_log_type(void);
179 * Get the log level for a given type.
182 * The log type identifier.
184 * 0 on success, a negative value if logtype is invalid.
186 int rte_log_get_level(uint32_t logtype);
189 * Set the log level for a given type.
192 * The regexp identifying the log type.
194 * The level to be set.
196 * 0 on success, a negative value if level is invalid.
198 int rte_log_set_level_regexp(const char *pattern, uint32_t level);
201 * Set the log level for a given type.
204 * The log type identifier.
206 * The level to be set.
208 * 0 on success, a negative value if logtype or level is invalid.
210 int rte_log_set_level(uint32_t logtype, uint32_t level);
213 * Get the current loglevel for the message being processed.
215 * Before calling the user-defined stream for logging, the log
216 * subsystem sets a per-lcore variable containing the loglevel and the
217 * logtype of the message being processed. This information can be
218 * accessed by the user-defined log output function through this
222 * The loglevel of the message being processed.
224 int rte_log_cur_msg_loglevel(void);
227 * Get the current logtype for the message being processed.
229 * Before calling the user-defined stream for logging, the log
230 * subsystem sets a per-lcore variable containing the loglevel and the
231 * logtype of the message being processed. This information can be
232 * accessed by the user-defined log output function through this
236 * The logtype of the message being processed.
238 int rte_log_cur_msg_logtype(void);
241 * Register a dynamic log type
243 * If a log is already registered with the same type, the returned value
244 * is the same than the previous one.
247 * The string identifying the log type.
249 * - >0: success, the returned value is the log type identifier.
250 * - (-ENONEM): cannot allocate memory.
252 int rte_log_register(const char *name);
255 * Dump log information.
257 * Dump the global level and the registered log types.
260 * The output stream where the dump should be sent.
262 void rte_log_dump(FILE *f);
265 * Generates a log message.
267 * The message will be sent in the stream defined by the previous call
268 * to rte_openlog_stream().
270 * The level argument determines if the log should be displayed or
271 * not, depending on the global rte_logs variable.
273 * The preferred alternative is the RTE_LOG() because it adds the
274 * level and type in the logged string.
277 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
279 * The log type, for example, RTE_LOGTYPE_EAL.
281 * The format string, as in printf(3), followed by the variable arguments
282 * required by the format.
285 * - Negative on error.
287 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
289 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
290 __attribute__((cold))
293 __attribute__((format(printf, 3, 4)));
296 * Generates a log message.
298 * The message will be sent in the stream defined by the previous call
299 * to rte_openlog_stream().
301 * The level argument determines if the log should be displayed or
302 * not, depending on the global rte_logs variable. A trailing
303 * newline may be added if needed.
305 * The preferred alternative is the RTE_LOG() because it adds the
306 * level and type in the logged string.
309 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
311 * The log type, for example, RTE_LOGTYPE_EAL.
313 * The format string, as in printf(3), followed by the variable arguments
314 * required by the format.
316 * The va_list of the variable arguments required by the format.
319 * - Negative on error.
321 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
322 __attribute__((format(printf,3,0)));
325 * Generates a log message.
327 * The RTE_LOG() is a helper that prefixes the string with the log level
328 * and type, and call rte_log().
331 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
332 * expanded by the macro, so it cannot be an integer value.
334 * The log type, for example, EAL. The short name is expanded by the
335 * macro, so it cannot be an integer value.
337 * The fmt string, as in printf(3), followed by the variable arguments
338 * required by the format.
341 * - Negative on error.
343 #define RTE_LOG(l, t, ...) \
344 rte_log(RTE_LOG_ ## l, \
345 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
348 * Generates a log message for data path.
350 * Similar to RTE_LOG(), except that it is removed at compilation time
351 * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
355 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
356 * expanded by the macro, so it cannot be an integer value.
358 * The log type, for example, EAL. The short name is expanded by the
359 * macro, so it cannot be an integer value.
361 * The fmt string, as in printf(3), followed by the variable arguments
362 * required by the format.
365 * - Negative on error.
367 #define RTE_LOG_DP(l, t, ...) \
368 (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
369 rte_log(RTE_LOG_ ## l, \
370 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
377 #endif /* _RTE_LOG_H_ */