cne_log.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation
 */
 
#ifndef _CNE_LOG_H_
#define _CNE_LOG_H_
 
#include <stdio.h>             // for NULL
#include <stdarg.h>            // for va_list
#include <stdint.h>            // for uint32_t
#include <cne_common.h>        // for CNDP_API
#include <cne_stdio.h>
 
#include "cne_build_config.h"        // for CNE_ENABLE_ASSERT
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define foreach_cndp_log_level \
    _(1, EMERG, emerg)         \
    _(2, ALERT, alert)         \
    _(3, CRIT, crit)           \
    _(4, ERR, err)             \
    _(5, WARNING, warn)        \
    _(6, NOTICE, notice)       \
    _(7, INFO, info)           \
    _(8, DEBUG, debug)         \
    _(9, LAST, last)
 
/* Can't use 0, as it gives compiler warnings */
/*
 * The log levels are defined as follows
 *  CNE_LOG_EMERG   System is unusable.
 *  CNE_LOG_ALERT   Action must be taken immediately.
 *  CNE_LOG_CRIT    Critical conditions.
 *  CNE_LOG_ERR     Error conditions.
 *  CNE_LOG_WARNING Warning conditions.
 *  CNE_LOG_NOTICE  Normal but significant condition.
 *  CNE_LOG_INFO    Informational.
 *  CNE_LOG_DEBUG   Debug-level messages.
 *  CNE_LOG_LAST
 */
enum {
#define _(n, uc, lc) CNE_LOG_##uc = n,
    foreach_cndp_log_level
#undef _
};
 
CNDP_API void cne_log_set_level(uint32_t level);
 
CNDP_API int cne_log_set_level_str(char *log_level);
 
CNDP_API uint32_t cne_log_get_level(void);
 
CNDP_API int cne_log(uint32_t level, const char *func, int line, const char *format, ...)
#ifdef __GNUC__
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
    __attribute__((cold))
#endif
#endif
    __attribute__((format(printf, 4, 5)));
 
CNDP_API int cne_print(const char *format, ...)
#ifdef __GNUC__
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
    __attribute__((cold))
#endif
#endif
    __attribute__((format(printf, 1, 2)));
 
CNDP_API int cne_vlog(uint32_t level, const char *func, int line, const char *format, va_list ap)
    __attribute__((format(printf, 4, 0)));
 
#define CNE_LOG(f, ...) cne_log(CNE_LOG_##f, __func__, __LINE__, #f ": " __VA_ARGS__)
 
#define CNE_PRINT(f, args...) cne_print(f, ##args)
 
#define CNE_EMERG(...)  CNE_LOG(EMERG, __VA_ARGS__)
#define CNE_ALERT(...)  CNE_LOG(ALERT, __VA_ARGS__)
#define CNE_CRIT(...)   CNE_LOG(CRIT, __VA_ARGS__)
#define CNE_ERR(...)    CNE_LOG(ERR, __VA_ARGS__)
#define CNE_WARN(...)   CNE_LOG(WARNING, __VA_ARGS__)
#define CNE_NOTICE(...) CNE_LOG(NOTICE, __VA_ARGS__)
#define CNE_INFO(...)   CNE_LOG(INFO, __VA_ARGS__)
#define CNE_DEBUG(...)  CNE_LOG(DEBUG, __VA_ARGS__)
 
#define CNE_ERR_RET_VAL(_val, ...) \
    do {                           \
        CNE_ERR(__VA_ARGS__);      \
        return _val;               \
    } while ((0))
 
#define CNE_RET(...) CNE_ERR_RET_VAL(, __VA_ARGS__)
 
#define CNE_ERR_RET(...) CNE_ERR_RET_VAL(-1, __VA_ARGS__)
 
#define CNE_NULL_RET(...) CNE_ERR_RET_VAL(NULL, __VA_ARGS__)
 
#define CNE_ERR_GOTO(lbl, ...) \
    do {                       \
        CNE_ERR(__VA_ARGS__);  \
        goto lbl;              \
    } while ((0))
 
CNDP_API void cne_dump_stack(void);
 
#define cne_panic(format, args...) __cne_panic(__func__, __LINE__, format "\n", ##args)
 
#define cne_exit(format, args...) __cne_exit(__func__, __LINE__, format "\n", ##args)
 
#if CNE_ENABLE_ASSERT
#define CNE_ASSERT(exp) CNE_VERIFY(exp)
#else
#define CNE_ASSERT(exp) \
    do {                \
    } while (0)
#endif
 
#define CNE_VERIFY(exp)                              \
    do {                                             \
        if (unlikely(!(exp)))                        \
            cne_panic("assert \"%s\" failed", #exp); \
    } while (0)
 
CNDP_API void __cne_panic(const char *funcname, int line, const char *format, ...)
#ifdef __GNUC__
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
    __attribute__((cold))
#endif
#endif
    __attribute__((noreturn)) __attribute__((format(printf, 3, 4)));
 
CNDP_API void __cne_exit(const char *func, int line, const char *format, ...)
#ifdef __GNUC__
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
    __attribute__((cold))
#endif
#endif
    __attribute__((noreturn)) __attribute__((format(printf, 3, 4)));
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_LOG_H_ */