1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
13 * This file provides a log API to RTE applications.
23 #include <sys/queue.h>
25 #include <rte_common.h>
26 #include <rte_config.h>
28 struct rte_log_dynamic_type;
30 /** The rte_log structure. */
32 uint32_t type; /**< Bitfield with enabled logs. */
33 uint32_t level; /**< Log level. */
34 FILE *file; /**< Output file set by rte_openlog_stream, or NULL. */
35 size_t dynamic_types_len;
36 struct rte_log_dynamic_type *dynamic_types;
39 /** Global log informations */
40 extern struct rte_logs rte_logs;
43 #define RTE_LOGTYPE_EAL 0 /**< Log related to eal. */
44 #define RTE_LOGTYPE_MALLOC 1 /**< Log related to malloc. */
45 #define RTE_LOGTYPE_RING 2 /**< Log related to ring. */
46 #define RTE_LOGTYPE_MEMPOOL 3 /**< Log related to mempool. */
47 #define RTE_LOGTYPE_TIMER 4 /**< Log related to timers. */
48 #define RTE_LOGTYPE_PMD 5 /**< Log related to poll mode driver. */
49 #define RTE_LOGTYPE_HASH 6 /**< Log related to hash table. */
50 #define RTE_LOGTYPE_LPM 7 /**< Log related to LPM. */
51 #define RTE_LOGTYPE_KNI 8 /**< Log related to KNI. */
52 #define RTE_LOGTYPE_ACL 9 /**< Log related to ACL. */
53 #define RTE_LOGTYPE_POWER 10 /**< Log related to power. */
54 #define RTE_LOGTYPE_METER 11 /**< Log related to QoS meter. */
55 #define RTE_LOGTYPE_SCHED 12 /**< Log related to QoS port scheduler. */
56 #define RTE_LOGTYPE_PORT 13 /**< Log related to port. */
57 #define RTE_LOGTYPE_TABLE 14 /**< Log related to table. */
58 #define RTE_LOGTYPE_PIPELINE 15 /**< Log related to pipeline. */
59 #define RTE_LOGTYPE_MBUF 16 /**< Log related to mbuf. */
60 #define RTE_LOGTYPE_CRYPTODEV 17 /**< Log related to cryptodev. */
61 #define RTE_LOGTYPE_EFD 18 /**< Log related to EFD. */
62 #define RTE_LOGTYPE_EVENTDEV 19 /**< Log related to eventdev. */
63 #define RTE_LOGTYPE_GSO 20 /**< Log related to GSO. */
65 /* these log types can be used in an application */
66 #define RTE_LOGTYPE_USER1 24 /**< User-defined log type 1. */
67 #define RTE_LOGTYPE_USER2 25 /**< User-defined log type 2. */
68 #define RTE_LOGTYPE_USER3 26 /**< User-defined log type 3. */
69 #define RTE_LOGTYPE_USER4 27 /**< User-defined log type 4. */
70 #define RTE_LOGTYPE_USER5 28 /**< User-defined log type 5. */
71 #define RTE_LOGTYPE_USER6 29 /**< User-defined log type 6. */
72 #define RTE_LOGTYPE_USER7 30 /**< User-defined log type 7. */
73 #define RTE_LOGTYPE_USER8 31 /**< User-defined log type 8. */
75 /** First identifier for extended logs */
76 #define RTE_LOGTYPE_FIRST_EXT_ID 32
78 /* Can't use 0, as it gives compiler warnings */
79 #define RTE_LOG_EMERG 1U /**< System is unusable. */
80 #define RTE_LOG_ALERT 2U /**< Action must be taken immediately. */
81 #define RTE_LOG_CRIT 3U /**< Critical conditions. */
82 #define RTE_LOG_ERR 4U /**< Error conditions. */
83 #define RTE_LOG_WARNING 5U /**< Warning conditions. */
84 #define RTE_LOG_NOTICE 6U /**< Normal but significant condition. */
85 #define RTE_LOG_INFO 7U /**< Informational. */
86 #define RTE_LOG_DEBUG 8U /**< Debug-level messages. */
89 * Change the stream that will be used by the logging system.
91 * This can be done at any time. The f argument represents the stream
92 * to be used to send the logs. If f is NULL, the default output is
96 * Pointer to the stream.
99 * - Negative on error.
101 int rte_openlog_stream(FILE *f);
104 * Set the global log level.
106 * After this call, logs with a level lower or equal than the level
107 * passed as argument will be displayed.
110 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
112 void rte_log_set_global_level(uint32_t level);
115 * Get the global log level.
118 * The current global log level.
120 uint32_t rte_log_get_global_level(void);
123 * Get the log level for a given type.
126 * The log type identifier.
128 * 0 on success, a negative value if logtype is invalid.
130 int rte_log_get_level(uint32_t logtype);
133 * Set the log level for a given type.
136 * The regexp identifying the log type.
138 * The level to be set.
140 * 0 on success, a negative value if level is invalid.
142 int rte_log_set_level_regexp(const char *pattern, uint32_t level);
145 * Set the log level for a given type.
148 * The log type identifier.
150 * The level to be set.
152 * 0 on success, a negative value if logtype or level is invalid.
154 int rte_log_set_level(uint32_t logtype, uint32_t level);
157 * Get the current loglevel for the message being processed.
159 * Before calling the user-defined stream for logging, the log
160 * subsystem sets a per-lcore variable containing the loglevel and the
161 * logtype of the message being processed. This information can be
162 * accessed by the user-defined log output function through this
166 * The loglevel of the message being processed.
168 int rte_log_cur_msg_loglevel(void);
171 * Get the current logtype for the message being processed.
173 * Before calling the user-defined stream for logging, the log
174 * subsystem sets a per-lcore variable containing the loglevel and the
175 * logtype of the message being processed. This information can be
176 * accessed by the user-defined log output function through this
180 * The logtype of the message being processed.
182 int rte_log_cur_msg_logtype(void);
185 * Register a dynamic log type
187 * If a log is already registered with the same type, the returned value
188 * is the same than the previous one.
191 * The string identifying the log type.
193 * - >0: success, the returned value is the log type identifier.
194 * - (-ENOMEM): cannot allocate memory.
196 int rte_log_register(const char *name);
200 * @b EXPERIMENTAL: this API may change without prior notice
202 * Register a dynamic log type and try to pick its level from EAL options
204 * rte_log_register() is called inside. If successful, the function tries
205 * to search for matching regexp in the list of EAL log level options and
206 * pick the level from the last matching entry. If nothing can be applied
207 * from the list, the level will be set to the user-defined default value.
210 * Name for the log type to be registered
212 * Fallback level to be set if the global list has no matching options
214 * - >=0: the newly registered log type
215 * - <0: rte_log_register() error value
217 int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);
220 * Dump log information.
222 * Dump the global level and the registered log types.
225 * The output stream where the dump should be sent.
227 void rte_log_dump(FILE *f);
230 * Generates a log message.
232 * The message will be sent in the stream defined by the previous call
233 * to rte_openlog_stream().
235 * The level argument determines if the log should be displayed or
236 * not, depending on the global rte_logs variable.
238 * The preferred alternative is the RTE_LOG() because it adds the
239 * level and type in the logged string.
242 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
244 * The log type, for example, RTE_LOGTYPE_EAL.
246 * The format string, as in printf(3), followed by the variable arguments
247 * required by the format.
250 * - Negative on error.
252 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
254 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
255 __attribute__((cold))
258 __attribute__((format(printf, 3, 4)));
261 * Generates a log message.
263 * The message will be sent in the stream defined by the previous call
264 * to rte_openlog_stream().
266 * The level argument determines if the log should be displayed or
267 * not, depending on the global rte_logs variable. A trailing
268 * newline may be added if needed.
270 * The preferred alternative is the RTE_LOG() because it adds the
271 * level and type in the logged string.
274 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
276 * The log type, for example, RTE_LOGTYPE_EAL.
278 * The format string, as in printf(3), followed by the variable arguments
279 * required by the format.
281 * The va_list of the variable arguments required by the format.
284 * - Negative on error.
286 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
287 __attribute__((format(printf,3,0)));
290 * Generates a log message.
292 * The RTE_LOG() is a helper that prefixes the string with the log level
293 * and type, and call rte_log().
296 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
297 * expanded by the macro, so it cannot be an integer value.
299 * The log type, for example, EAL. The short name is expanded by the
300 * macro, so it cannot be an integer value.
302 * The fmt string, as in printf(3), followed by the variable arguments
303 * required by the format.
306 * - Negative on error.
308 #define RTE_LOG(l, t, ...) \
309 rte_log(RTE_LOG_ ## l, \
310 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
313 * Generates a log message for data path.
315 * Similar to RTE_LOG(), except that it is removed at compilation time
316 * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
320 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
321 * expanded by the macro, so it cannot be an integer value.
323 * The log type, for example, EAL. The short name is expanded by the
324 * macro, so it cannot be an integer value.
326 * The fmt string, as in printf(3), followed by the variable arguments
327 * required by the format.
330 * - Negative on error.
332 #define RTE_LOG_DP(l, t, ...) \
333 (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
334 rte_log(RTE_LOG_ ## l, \
335 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
342 #endif /* _RTE_LOG_H_ */