1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
13 * This file provides a log API to RTE applications.
24 #include <sys/queue.h>
26 #include <rte_common.h>
27 #include <rte_config.h>
28 #include <rte_compat.h>
31 #define RTE_LOGTYPE_EAL 0 /**< Log related to eal. */
32 #define RTE_LOGTYPE_MALLOC 1 /**< Log related to malloc. */
33 #define RTE_LOGTYPE_RING 2 /**< Log related to ring. */
34 #define RTE_LOGTYPE_MEMPOOL 3 /**< Log related to mempool. */
35 #define RTE_LOGTYPE_TIMER 4 /**< Log related to timers. */
36 #define RTE_LOGTYPE_PMD 5 /**< Log related to poll mode driver. */
37 #define RTE_LOGTYPE_HASH 6 /**< Log related to hash table. */
38 #define RTE_LOGTYPE_LPM 7 /**< Log related to LPM. */
39 #define RTE_LOGTYPE_KNI 8 /**< Log related to KNI. */
40 #define RTE_LOGTYPE_ACL 9 /**< Log related to ACL. */
41 #define RTE_LOGTYPE_POWER 10 /**< Log related to power. */
42 #define RTE_LOGTYPE_METER 11 /**< Log related to QoS meter. */
43 #define RTE_LOGTYPE_SCHED 12 /**< Log related to QoS port scheduler. */
44 #define RTE_LOGTYPE_PORT 13 /**< Log related to port. */
45 #define RTE_LOGTYPE_TABLE 14 /**< Log related to table. */
46 #define RTE_LOGTYPE_PIPELINE 15 /**< Log related to pipeline. */
47 #define RTE_LOGTYPE_MBUF 16 /**< Log related to mbuf. */
48 #define RTE_LOGTYPE_CRYPTODEV 17 /**< Log related to cryptodev. */
49 #define RTE_LOGTYPE_EFD 18 /**< Log related to EFD. */
50 #define RTE_LOGTYPE_EVENTDEV 19 /**< Log related to eventdev. */
51 #define RTE_LOGTYPE_GSO 20 /**< Log related to GSO. */
53 /* these log types can be used in an application */
54 #define RTE_LOGTYPE_USER1 24 /**< User-defined log type 1. */
55 #define RTE_LOGTYPE_USER2 25 /**< User-defined log type 2. */
56 #define RTE_LOGTYPE_USER3 26 /**< User-defined log type 3. */
57 #define RTE_LOGTYPE_USER4 27 /**< User-defined log type 4. */
58 #define RTE_LOGTYPE_USER5 28 /**< User-defined log type 5. */
59 #define RTE_LOGTYPE_USER6 29 /**< User-defined log type 6. */
60 #define RTE_LOGTYPE_USER7 30 /**< User-defined log type 7. */
61 #define RTE_LOGTYPE_USER8 31 /**< User-defined log type 8. */
63 /** First identifier for extended logs */
64 #define RTE_LOGTYPE_FIRST_EXT_ID 32
66 /* Can't use 0, as it gives compiler warnings */
67 #define RTE_LOG_EMERG 1U /**< System is unusable. */
68 #define RTE_LOG_ALERT 2U /**< Action must be taken immediately. */
69 #define RTE_LOG_CRIT 3U /**< Critical conditions. */
70 #define RTE_LOG_ERR 4U /**< Error conditions. */
71 #define RTE_LOG_WARNING 5U /**< Warning conditions. */
72 #define RTE_LOG_NOTICE 6U /**< Normal but significant condition. */
73 #define RTE_LOG_INFO 7U /**< Informational. */
74 #define RTE_LOG_DEBUG 8U /**< Debug-level messages. */
75 #define RTE_LOG_MAX RTE_LOG_DEBUG /**< Most detailed log level. */
78 * Change the stream that will be used by the logging system.
80 * This can be done at any time. The f argument represents the stream
81 * to be used to send the logs. If f is NULL, the default output is
85 * Pointer to the stream.
88 * - Negative on error.
90 int rte_openlog_stream(FILE *f);
93 * Retrieve the stream used by the logging system (see rte_openlog_stream()
97 * Pointer to the stream.
99 FILE *rte_log_get_stream(void);
102 * Set the global log level.
104 * After this call, logs with a level lower or equal than the level
105 * passed as argument will be displayed.
108 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
110 void rte_log_set_global_level(uint32_t level);
113 * Get the global log level.
116 * The current global log level.
118 uint32_t rte_log_get_global_level(void);
121 * Get the log level for a given type.
124 * The log type identifier.
126 * 0 on success, a negative value if logtype is invalid.
128 int rte_log_get_level(uint32_t logtype);
131 * For a given `logtype`, check if a log with `loglevel` can be printed.
134 * The log type identifier
136 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
138 * Returns 'true' if log can be printed and 'false' if it can't.
141 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
144 * Set the log level for a given type based on globbing pattern.
147 * The globbing pattern identifying the log type.
149 * The level to be set.
151 * 0 on success, a negative value if level is invalid.
153 int rte_log_set_level_pattern(const char *pattern, uint32_t level);
156 * Set the log level for a given type based on regular expression.
159 * The regular expression identifying the log type.
161 * The level to be set.
163 * 0 on success, a negative value if level is invalid.
165 int rte_log_set_level_regexp(const char *regex, uint32_t level);
168 * Set the log level for a given type.
171 * The log type identifier.
173 * The level to be set.
175 * 0 on success, a negative value if logtype or level is invalid.
177 int rte_log_set_level(uint32_t logtype, uint32_t level);
180 * Get the current loglevel for the message being processed.
182 * Before calling the user-defined stream for logging, the log
183 * subsystem sets a per-lcore variable containing the loglevel and the
184 * logtype of the message being processed. This information can be
185 * accessed by the user-defined log output function through this
189 * The loglevel of the message being processed.
191 int rte_log_cur_msg_loglevel(void);
194 * Get the current logtype for the message being processed.
196 * Before calling the user-defined stream for logging, the log
197 * subsystem sets a per-lcore variable containing the loglevel and the
198 * logtype of the message being processed. This information can be
199 * accessed by the user-defined log output function through this
203 * The logtype of the message being processed.
205 int rte_log_cur_msg_logtype(void);
208 * Register a dynamic log type
210 * If a log is already registered with the same type, the returned value
211 * is the same than the previous one.
214 * The string identifying the log type.
216 * - >0: success, the returned value is the log type identifier.
217 * - (-ENOMEM): cannot allocate memory.
219 int rte_log_register(const char *name);
223 * @b EXPERIMENTAL: this API may change without prior notice
225 * Register a dynamic log type and try to pick its level from EAL options
227 * rte_log_register() is called inside. If successful, the function tries
228 * to search for matching regexp in the list of EAL log level options and
229 * pick the level from the last matching entry. If nothing can be applied
230 * from the list, the level will be set to the user-defined default value.
233 * Name for the log type to be registered
235 * Fallback level to be set if the global list has no matching options
237 * - >=0: the newly registered log type
238 * - <0: rte_log_register() error value
241 int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);
245 * @b EXPERIMENTAL: this API may change without prior notice
247 * Dump name of each logtype, one per line.
250 * Stream where the list is sent.
252 * String preceding each logtype in the output.
255 void rte_log_list_types(FILE *out, const char *prefix);
258 * Dump log information.
260 * Dump the global level and the registered log types.
263 * The output stream where the dump should be sent.
265 void rte_log_dump(FILE *f);
268 * Generates a log message.
270 * The message will be sent in the stream defined by the previous call
271 * to rte_openlog_stream().
273 * The level argument determines if the log should be displayed or
274 * not, depending on the loglevel settings.
276 * The preferred alternative is the RTE_LOG() because it adds the
277 * level and type in the logged string.
280 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
282 * The log type, for example, RTE_LOGTYPE_EAL.
284 * The format string, as in printf(3), followed by the variable arguments
285 * required by the format.
288 * - Negative on error.
290 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
292 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
296 __rte_format_printf(3, 4);
299 * Generates a log message.
301 * The message will be sent in the stream defined by the previous call
302 * to rte_openlog_stream().
304 * The level argument determines if the log should be displayed or
305 * not, depending on the loglevel settings. A trailing
306 * newline may be added if needed.
308 * The preferred alternative is the RTE_LOG() because it adds the
309 * level and type in the logged string.
312 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
314 * The log type, for example, RTE_LOGTYPE_EAL.
316 * The format string, as in printf(3), followed by the variable arguments
317 * required by the format.
319 * The va_list of the variable arguments required by the format.
322 * - Negative on error.
324 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
325 __rte_format_printf(3, 0);
328 * Generates a log message.
330 * The RTE_LOG() is a helper that prefixes the string with the log level
331 * and type, and call rte_log().
334 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
335 * expanded by the macro, so it cannot be an integer value.
337 * The log type, for example, EAL. The short name is expanded by the
338 * macro, so it cannot be an integer value.
340 * The fmt string, as in printf(3), followed by the variable arguments
341 * required by the format.
344 * - Negative on error.
346 #define RTE_LOG(l, t, ...) \
347 rte_log(RTE_LOG_ ## l, \
348 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
351 * Generates a log message for data path.
353 * Similar to RTE_LOG(), except that it is removed at compilation time
354 * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
358 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
359 * expanded by the macro, so it cannot be an integer value.
361 * The log type, for example, EAL. The short name is expanded by the
362 * macro, so it cannot be an integer value.
364 * The fmt string, as in printf(3), followed by the variable arguments
365 * required by the format.
368 * - Negative on error.
370 #define RTE_LOG_DP(l, t, ...) \
371 (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
372 rte_log(RTE_LOG_ ## l, \
373 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
378 * @b EXPERIMENTAL: this API may change without prior notice
380 * Register a dynamic log type in constructor context with its name and level.
382 * It is a wrapper macro for declaring the logtype, register the log and
383 * sets it's level in the constructor context.
386 * The log type identifier
388 * Name for the log type to be registered
390 * Log level. A value between EMERG (1) and DEBUG (8).
392 #define RTE_LOG_REGISTER(type, name, level) \
396 type = rte_log_register_type_and_pick_level(RTE_STR(name), \
399 type = RTE_LOGTYPE_EAL; \
406 #endif /* _RTE_LOG_H_ */