|
DPDK
21.11.8
|
#include <stdint.h>#include <stdio.h>#include <stdarg.h>#include <stdbool.h>#include <rte_common.h>#include <rte_config.h>#include <rte_compat.h>Go to the source code of this file.
Functions | |
| int | rte_openlog_stream (FILE *f) |
| FILE * | rte_log_get_stream (void) |
| void | rte_log_set_global_level (uint32_t level) |
| uint32_t | rte_log_get_global_level (void) |
| int | rte_log_get_level (uint32_t logtype) |
| __rte_experimental bool | rte_log_can_log (uint32_t logtype, uint32_t loglevel) |
| int | rte_log_set_level_pattern (const char *pattern, uint32_t level) |
| int | rte_log_set_level_regexp (const char *regex, uint32_t level) |
| int | rte_log_set_level (uint32_t logtype, uint32_t level) |
| int | rte_log_cur_msg_loglevel (void) |
| int | rte_log_cur_msg_logtype (void) |
| int | rte_log_register (const char *name) |
| int | rte_log_register_type_and_pick_level (const char *name, uint32_t level_def) |
| __rte_experimental void | rte_log_list_types (FILE *out, const char *prefix) |
| void | rte_log_dump (FILE *f) |
| int | rte_log (uint32_t level, uint32_t logtype, const char *format,...) __rte_format_printf(3 |
| int int | rte_vlog (uint32_t level, uint32_t logtype, const char *format, va_list ap) __rte_format_printf(3 |
| #define RTE_LOGTYPE_SCHED 12 |
| #define RTE_LOGTYPE_FIRST_EXT_ID 32 |
| #define RTE_LOG_NOTICE 6U |
| #define RTE_LOG_MAX RTE_LOG_DEBUG |
| #define RTE_LOG | ( | l, | |
| t, | |||
| ... | |||
| ) |
Generates a log message.
The RTE_LOG() is a helper that prefixes the string with the log level and type, and call rte_log().
| l | Log level. A value between EMERG (1) and DEBUG (8). The short name is expanded by the macro, so it cannot be an integer value. |
| t | The log type, for example, EAL. The short name is expanded by the macro, so it cannot be an integer value. |
| ... | The fmt string, as in printf(3), followed by the variable arguments required by the format. |
| #define RTE_LOG_DP | ( | l, | |
| t, | |||
| ... | |||
| ) |
Generates a log message for data path.
Similar to RTE_LOG(), except that it is removed at compilation time if the RTE_LOG_DP_LEVEL configuration option is lower than the log level argument.
| l | Log level. A value between EMERG (1) and DEBUG (8). The short name is expanded by the macro, so it cannot be an integer value. |
| t | The log type, for example, EAL. The short name is expanded by the macro, so it cannot be an integer value. |
| ... | The fmt string, as in printf(3), followed by the variable arguments required by the format. |
| #define RTE_LOG_REGISTER | ( | type, | |
| name, | |||
| level | |||
| ) | RTE_LOG_REGISTER_IMPL(type, RTE_STR(name), level) |
Register a dynamic log type in constructor context with its name and level.
It is a wrapper macro for declaring the logtype, register the log and sets it's level in the constructor context.
| type | The log type identifier |
| name | Name for the log type to be registered |
| level | Log level. A value between EMERG (1) and DEBUG (8). |
| #define RTE_LOG_REGISTER_DEFAULT | ( | type, | |
| level | |||
| ) | RTE_LOG_REGISTER_IMPL(type, RTE_STR(RTE_LOG_DEFAULT_LOGTYPE), level) |
| #define RTE_LOG_REGISTER_SUFFIX | ( | type, | |
| suffix, | |||
| level | |||
| ) |
This is an equivalent to RTE_LOG_REGISTER, but relying on the build system to select the right prefix for the logtype.
| int rte_openlog_stream | ( | FILE * | f | ) |
Change the stream that will be used by the logging system.
This can be done at any time. The f argument represents the stream to be used to send the logs. If f is NULL, the default output is used (stderr).
| f | Pointer to the stream. |
| FILE* rte_log_get_stream | ( | void | ) |
Retrieve the stream used by the logging system (see rte_openlog_stream() to change it).
| void rte_log_set_global_level | ( | uint32_t | level | ) |
Set the global log level.
After this call, logs with a level lower or equal than the level passed as argument will be displayed.
| level | Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8). |
| uint32_t rte_log_get_global_level | ( | void | ) |
Get the global log level.
| int rte_log_get_level | ( | uint32_t | logtype | ) |
Get the log level for a given type.
| logtype | The log type identifier. |
| __rte_experimental bool rte_log_can_log | ( | uint32_t | logtype, |
| uint32_t | loglevel | ||
| ) |
For a given logtype, check if a log with loglevel can be printed.
| logtype | The log type identifier |
| loglevel | Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8). |
| int rte_log_set_level_pattern | ( | const char * | pattern, |
| uint32_t | level | ||
| ) |
Set the log level for a given type based on globbing pattern.
| pattern | The globbing pattern identifying the log type. |
| level | The level to be set. |
| int rte_log_set_level_regexp | ( | const char * | regex, |
| uint32_t | level | ||
| ) |
Set the log level for a given type based on regular expression.
| regex | The regular expression identifying the log type. |
| level | The level to be set. |
| int rte_log_set_level | ( | uint32_t | logtype, |
| uint32_t | level | ||
| ) |
Set the log level for a given type.
| logtype | The log type identifier. |
| level | The level to be set. |
| int rte_log_cur_msg_loglevel | ( | void | ) |
Get the current loglevel for the message being processed.
Before calling the user-defined stream for logging, the log subsystem sets a per-lcore variable containing the loglevel and the logtype of the message being processed. This information can be accessed by the user-defined log output function through this function.
| int rte_log_cur_msg_logtype | ( | void | ) |
Get the current logtype for the message being processed.
Before calling the user-defined stream for logging, the log subsystem sets a per-lcore variable containing the loglevel and the logtype of the message being processed. This information can be accessed by the user-defined log output function through this function.
| int rte_log_register | ( | const char * | name | ) |
Register a dynamic log type
If a log is already registered with the same type, the returned value is the same than the previous one.
| name | The string identifying the log type. |
| int rte_log_register_type_and_pick_level | ( | const char * | name, |
| uint32_t | level_def | ||
| ) |
Register a dynamic log type and try to pick its level from EAL options
rte_log_register() is called inside. If successful, the function tries to search for matching regexp in the list of EAL log level options and pick the level from the last matching entry. If nothing can be applied from the list, the level will be set to the user-defined default value.
| name | Name for the log type to be registered |
| level_def | Fallback level to be set if the global list has no matching options |
| __rte_experimental void rte_log_list_types | ( | FILE * | out, |
| const char * | prefix | ||
| ) |
Dump name of each logtype, one per line.
| out | Stream where the list is sent. |
| prefix | String preceding each logtype in the output. |
| void rte_log_dump | ( | FILE * | f | ) |
Dump log information.
Dump the global level and the registered log types.
| f | The output stream where the dump should be sent. |
| int rte_log | ( | uint32_t | level, |
| uint32_t | logtype, | ||
| const char * | format, | ||
| ... | |||
| ) |
Generates a log message.
The message will be sent in the stream defined by the previous call to rte_openlog_stream().
The level argument determines if the log should be displayed or not, depending on the loglevel settings.
The preferred alternative is the RTE_LOG() because it adds the level and type in the logged string.
| level | Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8). |
| logtype | The log type, for example, RTE_LOGTYPE_EAL. |
| format | The format string, as in printf(3), followed by the variable arguments required by the format. |
| int int rte_vlog | ( | uint32_t | level, |
| uint32_t | logtype, | ||
| const char * | format, | ||
| va_list | ap | ||
| ) |
Generates a log message.
The message will be sent in the stream defined by the previous call to rte_openlog_stream().
The level argument determines if the log should be displayed or not, depending on the loglevel settings. A trailing newline may be added if needed.
The preferred alternative is the RTE_LOG() because it adds the level and type in the logged string.
| level | Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8). |
| logtype | The log type, for example, RTE_LOGTYPE_EAL. |
| format | The format string, as in printf(3), followed by the variable arguments required by the format. |
| ap | The va_list of the variable arguments required by the format. |
1.8.13