NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_log.h File Reference
#include <stddef.h>
#include <stdio.h>
#include <stdint.h>
#include <doca_compat.h>
#include <doca_error.h>
Include dependency graph for doca_log.h:

Go to the source code of this file.

Macros

#define DOCA_LOG(level, format, ...)   doca_log(level, log_source, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
 Generates an application log message. More...
 
#define DOCA_LOG_CRIT(format, ...)   DOCA_LOG(DOCA_LOG_LEVEL_CRIT, format, ##__VA_ARGS__)
 Generates a CRITICAL application log message. More...
 
#define DOCA_LOG_ERR(format, ...)   DOCA_LOG(DOCA_LOG_LEVEL_ERROR, format, ##__VA_ARGS__)
 Generates an ERROR application log message. More...
 
#define DOCA_LOG_WARN(format, ...)   DOCA_LOG(DOCA_LOG_LEVEL_WARNING, format, ##__VA_ARGS__)
 Generates a WARNING application log message. More...
 
#define DOCA_LOG_INFO(format, ...)   DOCA_LOG(DOCA_LOG_LEVEL_INFO, format, ##__VA_ARGS__)
 Generates an INFO application log message. More...
 
#define DOCA_LOG_DBG(format, ...)   DOCA_LOG(DOCA_LOG_LEVEL_DEBUG, format, ##__VA_ARGS__)
 Generates a DEBUG application log message. More...
 
#define DOCA_LOG_TRC(format, ...)
 Generates a TRACE application log message. More...
 
#define DOCA_LOG_REGISTER(source)
 Registers log source on program start. More...
 

Typedefs

typedef void(* log_flush_callback) (char *buf)
 logging backend flush() handler More...
 

Enumerations

enum  doca_log_level {
  DOCA_LOG_LEVEL_DISABLE = 10 , DOCA_LOG_LEVEL_CRIT = 20 , DOCA_LOG_LEVEL_ERROR = 30 , DOCA_LOG_LEVEL_WARNING = 40 ,
  DOCA_LOG_LEVEL_INFO = 50 , DOCA_LOG_LEVEL_DEBUG = 60 , DOCA_LOG_LEVEL_TRACE = 70
}
 log levels, sorted by verbosity level from high to low More...
 

Functions

DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_level_lower_limit (struct doca_log_backend *backend, uint32_t level)
 Set the lower log level of a specific logging backend for application messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_level_upper_limit (struct doca_log_backend *backend, uint32_t upper_limit)
 Set the upper log level limit of a specific logging backend for application messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_level_lower_limit_strict (struct doca_log_backend *backend)
 Mark the lower log level limit of a specific logging backend for application messages as strict. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_level_upper_limit_strict (struct doca_log_backend *backend)
 Mark the upper log level limit of a specific application logging backend for application messages as strict. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_level_set_global_lower_limit (uint32_t level)
 Set the log level of ALL logging backends for application messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_level_set_global_upper_limit (uint32_t upper_limit)
 Set the log upper level limit of ALL logging backends for application messages. More...
 
DOCA_EXPERIMENTAL uint32_t doca_log_level_get_global_lower_limit (void)
 Get the global log level for application messages. More...
 
DOCA_EXPERIMENTAL uint32_t doca_log_level_get_global_upper_limit (void)
 Get the global upper log level for application messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_register_source (const char *source_name, int *source)
 Register a log source. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_unregister_source (int source)
 Unregister a log source. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_file (FILE *fptr, struct doca_log_backend **backend)
 Create a logging backend for application messages with a FILE* stream. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_fd (int fd, struct doca_log_backend **backend)
 Create a logging backend for application messages with an fd stream. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_buf (char *buf, size_t capacity, log_flush_callback handler, struct doca_log_backend **backend)
 Create a logging backend for application messages with a char buffer stream. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_syslog (const char *name, struct doca_log_backend **backend)
 Create a logging backend for application messages with a syslog output. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_set_sdk_level (struct doca_log_backend *backend, uint32_t level)
 Set the log level limit for SDK logging backends. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_file_sdk (FILE *fptr, struct doca_log_backend **backend)
 Create a logging backend with a FILE* stream for SDK messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_fd_sdk (int fd, struct doca_log_backend **backend)
 Create a logging backend with an fd stream for SDK messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_buf_sdk (char *buf, size_t capacity, log_flush_callback handler, struct doca_log_backend **backend)
 Create a logging backend with a char buffer stream for SDK messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_with_syslog_sdk (const char *name, struct doca_log_backend **backend)
 Create a logging backend with a syslog output for SDK messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_level_set_global_sdk_limit (uint32_t level)
 Set the log level of ALL logging backends for SDK messages. More...
 
DOCA_EXPERIMENTAL uint32_t doca_log_level_get_global_sdk_limit (void)
 Get the global log level for SDK messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log_backend_create_standard (void)
 Create default, non configurable backend for application messages. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_log (uint32_t level, int source, const char *fname, int line, const char *func, const char *format,...) __attribute__((format(printf
 Generates an application log message. More...