doca_log.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_LOG_H_
#define DOCA_LOG_H_
 
#include <stddef.h>
#include <stdio.h>
#include <stdint.h>
 
#include <doca_compat.h>
#include <doca_error.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
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,   
};
 
struct doca_log_backend;
 
typedef void (*log_flush_callback)(char *buf);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_set_level_lower_limit(struct doca_log_backend *backend, uint32_t level);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_set_level_upper_limit(struct doca_log_backend *backend, uint32_t upper_limit);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_set_level_lower_limit_strict(struct doca_log_backend *backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_set_level_upper_limit_strict(struct doca_log_backend *backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_level_set_global_lower_limit(uint32_t level);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_level_set_global_upper_limit(uint32_t upper_limit);
 
DOCA_EXPERIMENTAL
uint32_t doca_log_level_get_global_lower_limit(void);
 
DOCA_EXPERIMENTAL
uint32_t doca_log_level_get_global_upper_limit(void);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_register_source(const char *source_name, int *source);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_unregister_source(int source);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_file(FILE *fptr, struct doca_log_backend **backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_fd(int fd, struct doca_log_backend **backend);
 
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);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_syslog(const char *name, struct doca_log_backend **backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_set_sdk_level(struct doca_log_backend *backend, uint32_t level);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_file_sdk(FILE *fptr, struct doca_log_backend **backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_fd_sdk(int fd, struct doca_log_backend **backend);
 
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);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_with_syslog_sdk(const char *name, struct doca_log_backend **backend);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_level_set_global_sdk_limit(uint32_t level);
 
DOCA_EXPERIMENTAL
uint32_t doca_log_level_get_global_sdk_limit(void);
 
DOCA_EXPERIMENTAL
doca_error_t doca_log_backend_create_standard(void);
 
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, 6, 7)));
 
#define DOCA_LOG(level, format, ...) doca_log(level, log_source, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
 
#define DOCA_LOG_CRIT(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_CRIT, format, ##__VA_ARGS__)
 
#define DOCA_LOG_ERR(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_ERROR, format, ##__VA_ARGS__)
 
#define DOCA_LOG_WARN(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_WARNING, format, ##__VA_ARGS__)
 
#define DOCA_LOG_INFO(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_INFO, format, ##__VA_ARGS__)
 
#define DOCA_LOG_DBG(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_DEBUG, format, ##__VA_ARGS__)
 
#ifdef DOCA_LOGGING_ALLOW_TRACE
#define DOCA_LOG_TRC(format, ...) DOCA_LOG(DOCA_LOG_LEVEL_TRACE, format, ##__VA_ARGS__)
#else /* DOCA_LOGGING_ALLOW_TRACE */
#define DOCA_LOG_TRC(format, ...) \
    do { \
    } while (0)
#endif /* DOCA_LOGGING_ALLOW_TRACE */
 
#ifdef __linux__
 
#if defined(__INTELLISENSE__)
#pragma diag_suppress 1094 /* attribute "constructor" does not take arguments */
#endif
 
#define DOCA_LOG_REGISTER(source) \
    static int log_source; \
    /* Use the highest priority so other Ctors will be able to use the log */ \
    static void __attribute__((constructor(101), used)) DOCA_LOG_CTOR_##__FILE__(void) \
    { \
        doca_log_register_source(#source, &log_source); \
    }
 
#else /* implicit windows */
 
#ifdef __cplusplus
 
class doca_log_registrator {
public:
    doca_log_registrator(const char *source_name, int &log_source) noexcept
    {
        doca_log_register_source(source_name, &log_source);
        m_log_source = log_source;
    }
 
private:
    int m_log_source{0};
};
 
#define DOCA_LOG_REGISTER(source) \
    static int log_source{0}; \
    static doca_log_registrator g_register_struct(#source, log_source)
 
#else /* __cplusplus */
 
#pragma section(".CRT$XCU", read)
#define DOCA_LOG_REGISTER(source) \
    static int log_source = 0; \
    static void _log_ctor_func(void); \
    __pragma(data_seg(".CRT$XCU")) static void (*__doca_log_initializer)() = _log_ctor_func; \
    __pragma(data_seg()) static void _log_ctor_func(void) \
    { \
        doca_log_register_source(#source, &log_source); \
    }
 
#endif /* __cplusplus */
 
#endif /* __linux__ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* DOCA_LOG_H_ */