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>
27 #include <rte_compat.h>
29 struct rte_log_dynamic_type;
31 /** The rte_log structure. */
33 uint32_t type; /**< Bitfield with enabled logs. */
34 uint32_t level; /**< Log level. */
35 FILE *file; /**< Output file set by rte_openlog_stream, or NULL. */
36 size_t dynamic_types_len;
37 struct rte_log_dynamic_type *dynamic_types;
40 /** Global log information */
41 extern struct rte_logs rte_logs;
44 #define RTE_LOGTYPE_EAL 0 /**< Log related to eal. */
45 #define RTE_LOGTYPE_MALLOC 1 /**< Log related to malloc. */
46 #define RTE_LOGTYPE_RING 2 /**< Log related to ring. */
47 #define RTE_LOGTYPE_MEMPOOL 3 /**< Log related to mempool. */
48 #define RTE_LOGTYPE_TIMER 4 /**< Log related to timers. */
49 #define RTE_LOGTYPE_PMD 5 /**< Log related to poll mode driver. */
50 #define RTE_LOGTYPE_HASH 6 /**< Log related to hash table. */
51 #define RTE_LOGTYPE_LPM 7 /**< Log related to LPM. */
52 #define RTE_LOGTYPE_KNI 8 /**< Log related to KNI. */
53 #define RTE_LOGTYPE_ACL 9 /**< Log related to ACL. */
54 #define RTE_LOGTYPE_POWER 10 /**< Log related to power. */
55 #define RTE_LOGTYPE_METER 11 /**< Log related to QoS meter. */
56 #define RTE_LOGTYPE_SCHED 12 /**< Log related to QoS port scheduler. */
57 #define RTE_LOGTYPE_PORT 13 /**< Log related to port. */
58 #define RTE_LOGTYPE_TABLE 14 /**< Log related to table. */
59 #define RTE_LOGTYPE_PIPELINE 15 /**< Log related to pipeline. */
60 #define RTE_LOGTYPE_MBUF 16 /**< Log related to mbuf. */
61 #define RTE_LOGTYPE_CRYPTODEV 17 /**< Log related to cryptodev. */
62 #define RTE_LOGTYPE_EFD 18 /**< Log related to EFD. */
63 #define RTE_LOGTYPE_EVENTDEV 19 /**< Log related to eventdev. */
64 #define RTE_LOGTYPE_GSO 20 /**< Log related to GSO. */
66 /* these log types can be used in an application */
67 #define RTE_LOGTYPE_USER1 24 /**< User-defined log type 1. */
68 #define RTE_LOGTYPE_USER2 25 /**< User-defined log type 2. */
69 #define RTE_LOGTYPE_USER3 26 /**< User-defined log type 3. */
70 #define RTE_LOGTYPE_USER4 27 /**< User-defined log type 4. */
71 #define RTE_LOGTYPE_USER5 28 /**< User-defined log type 5. */
72 #define RTE_LOGTYPE_USER6 29 /**< User-defined log type 6. */
73 #define RTE_LOGTYPE_USER7 30 /**< User-defined log type 7. */
74 #define RTE_LOGTYPE_USER8 31 /**< User-defined log type 8. */
76 /** First identifier for extended logs */
77 #define RTE_LOGTYPE_FIRST_EXT_ID 32
79 /* Can't use 0, as it gives compiler warnings */
80 #define RTE_LOG_EMERG 1U /**< System is unusable. */
81 #define RTE_LOG_ALERT 2U /**< Action must be taken immediately. */
82 #define RTE_LOG_CRIT 3U /**< Critical conditions. */
83 #define RTE_LOG_ERR 4U /**< Error conditions. */
84 #define RTE_LOG_WARNING 5U /**< Warning conditions. */
85 #define RTE_LOG_NOTICE 6U /**< Normal but significant condition. */
86 #define RTE_LOG_INFO 7U /**< Informational. */
87 #define RTE_LOG_DEBUG 8U /**< Debug-level messages. */
90 * Change the stream that will be used by the logging system.
92 * This can be done at any time. The f argument represents the stream
93 * to be used to send the logs. If f is NULL, the default output is
97 * Pointer to the stream.
100 * - Negative on error.
102 int rte_openlog_stream(FILE *f);
106 * @b EXPERIMENTAL: this API may change without prior notice
108 * Retrieve the stream used by the logging system (see rte_openlog_stream()
112 * Pointer to the stream.
115 FILE *rte_log_get_stream(void);
118 * Set the global log level.
120 * After this call, logs with a level lower or equal than the level
121 * passed as argument will be displayed.
124 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
126 void rte_log_set_global_level(uint32_t level);
129 * Get the global log level.
132 * The current global log level.
134 uint32_t rte_log_get_global_level(void);
137 * Get the log level for a given type.
140 * The log type identifier.
142 * 0 on success, a negative value if logtype is invalid.
144 int rte_log_get_level(uint32_t logtype);
147 * Set the log level for a given type based on shell pattern.
150 * The match pattern identifying the log type.
152 * The level to be set.
154 * 0 on success, a negative value if level is invalid.
156 int rte_log_set_level_pattern(const char *pattern, uint32_t level);
159 * Set the log level for a given type based on regular expression.
162 * The regular expression identifying the log type.
164 * The level to be set.
166 * 0 on success, a negative value if level is invalid.
168 int rte_log_set_level_regexp(const char *regex, uint32_t level);
171 * Set the log level for a given type.
174 * The log type identifier.
176 * The level to be set.
178 * 0 on success, a negative value if logtype or level is invalid.
180 int rte_log_set_level(uint32_t logtype, uint32_t level);
183 * Get the current loglevel for the message being processed.
185 * Before calling the user-defined stream for logging, the log
186 * subsystem sets a per-lcore variable containing the loglevel and the
187 * logtype of the message being processed. This information can be
188 * accessed by the user-defined log output function through this
192 * The loglevel of the message being processed.
194 int rte_log_cur_msg_loglevel(void);
197 * Get the current logtype for the message being processed.
199 * Before calling the user-defined stream for logging, the log
200 * subsystem sets a per-lcore variable containing the loglevel and the
201 * logtype of the message being processed. This information can be
202 * accessed by the user-defined log output function through this
206 * The logtype of the message being processed.
208 int rte_log_cur_msg_logtype(void);
211 * Register a dynamic log type
213 * If a log is already registered with the same type, the returned value
214 * is the same than the previous one.
217 * The string identifying the log type.
219 * - >0: success, the returned value is the log type identifier.
220 * - (-ENOMEM): cannot allocate memory.
222 int rte_log_register(const char *name);
226 * @b EXPERIMENTAL: this API may change without prior notice
228 * Register a dynamic log type and try to pick its level from EAL options
230 * rte_log_register() is called inside. If successful, the function tries
231 * to search for matching regexp in the list of EAL log level options and
232 * pick the level from the last matching entry. If nothing can be applied
233 * from the list, the level will be set to the user-defined default value.
236 * Name for the log type to be registered
238 * Fallback level to be set if the global list has no matching options
240 * - >=0: the newly registered log type
241 * - <0: rte_log_register() error value
244 int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);
247 * Dump log information.
249 * Dump the global level and the registered log types.
252 * The output stream where the dump should be sent.
254 void rte_log_dump(FILE *f);
257 * Generates a log message.
259 * The message will be sent in the stream defined by the previous call
260 * to rte_openlog_stream().
262 * The level argument determines if the log should be displayed or
263 * not, depending on the global rte_logs variable.
265 * The preferred alternative is the RTE_LOG() because it adds the
266 * level and type in the logged string.
269 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
271 * The log type, for example, RTE_LOGTYPE_EAL.
273 * The format string, as in printf(3), followed by the variable arguments
274 * required by the format.
277 * - Negative on error.
279 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
281 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
282 __attribute__((cold))
285 __attribute__((format(printf, 3, 4)));
288 * Generates a log message.
290 * The message will be sent in the stream defined by the previous call
291 * to rte_openlog_stream().
293 * The level argument determines if the log should be displayed or
294 * not, depending on the global rte_logs variable. A trailing
295 * newline may be added if needed.
297 * The preferred alternative is the RTE_LOG() because it adds the
298 * level and type in the logged string.
301 * Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
303 * The log type, for example, RTE_LOGTYPE_EAL.
305 * The format string, as in printf(3), followed by the variable arguments
306 * required by the format.
308 * The va_list of the variable arguments required by the format.
311 * - Negative on error.
313 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
314 __attribute__((format(printf,3,0)));
317 * Generates a log message.
319 * The RTE_LOG() is a helper that prefixes the string with the log level
320 * and type, and call rte_log().
323 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
324 * expanded by the macro, so it cannot be an integer value.
326 * The log type, for example, EAL. The short name is expanded by the
327 * macro, so it cannot be an integer value.
329 * The fmt string, as in printf(3), followed by the variable arguments
330 * required by the format.
333 * - Negative on error.
335 #define RTE_LOG(l, t, ...) \
336 rte_log(RTE_LOG_ ## l, \
337 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
340 * Generates a log message for data path.
342 * Similar to RTE_LOG(), except that it is removed at compilation time
343 * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
347 * Log level. A value between EMERG (1) and DEBUG (8). The short name is
348 * expanded by the macro, so it cannot be an integer value.
350 * The log type, for example, EAL. The short name is expanded by the
351 * macro, so it cannot be an integer value.
353 * The fmt string, as in printf(3), followed by the variable arguments
354 * required by the format.
357 * - Negative on error.
359 #define RTE_LOG_DP(l, t, ...) \
360 (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
361 rte_log(RTE_LOG_ ## l, \
362 RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
369 #endif /* _RTE_LOG_H_ */