rte_log.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2017 Intel Corporation
 */
 
#ifndef _RTE_LOG_H_
#define _RTE_LOG_H_
 
#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>
#include <stdbool.h>
 
#include <rte_common.h>
#include <rte_config.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* SDK log type */
#define RTE_LOGTYPE_EAL        0 
                 /* was RTE_LOGTYPE_MALLOC */
                 /* was RTE_LOGTYPE_RING */
                 /* was RTE_LOGTYPE_MEMPOOL */
                 /* was RTE_LOGTYPE_TIMER */
                 /* was RTE_LOGTYPE_PMD */
                 /* was RTE_LOGTYPE_HASH */
                 /* was RTE_LOGTYPE_LPM */
                 /* was RTE_LOGTYPE_KNI */
                 /* was RTE_LOGTYPE_ACL */
                 /* was RTE_LOGTYPE_POWER */
                 /* was RTE_LOGTYPE_METER */
                 /* was RTE_LOGTYPE_SCHED */
                 /* was RTE_LOGTYPE_PORT */
                 /* was RTE_LOGTYPE_TABLE */
                 /* was RTE_LOGTYPE_PIPELINE */
                 /* was RTE_LOGTYPE_MBUF */
                 /* was RTE_LOGTYPE_CRYPTODEV */
                 /* was RTE_LOGTYPE_EFD */
                 /* was RTE_LOGTYPE_EVENTDEV */
                 /* was RTE_LOGTYPE_GSO */
 
/* these log types can be used in an application */
#define RTE_LOGTYPE_USER1     24 
#define RTE_LOGTYPE_USER2     25 
#define RTE_LOGTYPE_USER3     26 
#define RTE_LOGTYPE_USER4     27 
#define RTE_LOGTYPE_USER5     28 
#define RTE_LOGTYPE_USER6     29 
#define RTE_LOGTYPE_USER7     30 
#define RTE_LOGTYPE_USER8     31 
#define RTE_LOGTYPE_FIRST_EXT_ID 32
 
/* Can't use 0, as it gives compiler warnings */
#define RTE_LOG_EMERG    1U  
#define RTE_LOG_ALERT    2U  
#define RTE_LOG_CRIT     3U  
#define RTE_LOG_ERR      4U  
#define RTE_LOG_WARNING  5U  
#define RTE_LOG_NOTICE   6U  
#define RTE_LOG_INFO     7U  
#define RTE_LOG_DEBUG    8U  
#define RTE_LOG_MAX RTE_LOG_DEBUG 
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);
 
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);
 
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_cold
    __rte_format_printf(3, 4);
 
int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
    __rte_format_printf(3, 0);
 
#define RTE_LOG(l, t, ...)                  \
     rte_log(RTE_LOG_ ## l,                 \
         RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
 
#define RTE_LOG_DP(l, t, ...)                   \
    (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ?        \
     rte_log(RTE_LOG_ ## l,                 \
         RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
     0)
 
#if defined(RTE_TOOLCHAIN_GCC) && !defined(PEDANTIC)
#define RTE_LOG_CHECK_NO_NEWLINE(fmt) \
    static_assert(!__builtin_strchr(fmt, '\n'), \
        "This log format string contains a \\n")
#else
#define RTE_LOG_CHECK_NO_NEWLINE(...)
#endif
 
#define RTE_LOG_LINE(l, t, ...) do { \
    RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(__VA_ARGS__ ,)); \
    RTE_LOG(l, t, RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
        RTE_FMT_TAIL(__VA_ARGS__ ,))); \
} while (0)
 
#define RTE_LOG_DP_LINE(l, t, ...) do { \
    RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(__VA_ARGS__ ,)); \
    RTE_LOG_DP(l, t, RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
        RTE_FMT_TAIL(__VA_ARGS__ ,))); \
} while (0)
 
#define RTE_LOG_COMMA ,
 
#define RTE_LOG_LINE_PREFIX(l, t, prefix, args, ...) do { \
    RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(prefix __VA_ARGS__ ,)); \
    RTE_LOG(l, t, RTE_FMT(prefix RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
        args RTE_LOG_COMMA RTE_FMT_TAIL(__VA_ARGS__ ,))); \
} while (0)
 
#define RTE_LOG_DP_LINE_PREFIX(l, t, prefix, args, ...) do { \
    RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(prefix __VA_ARGS__ ,)); \
    RTE_LOG_DP(l, t, RTE_FMT(prefix RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
        args RTE_LOG_COMMA RTE_FMT_TAIL(__VA_ARGS__ ,))); \
} while (0)
 
#define RTE_LOG_REGISTER_IMPL(type, name, level)                \
int type;                                   \
RTE_INIT(__##type)                              \
{                                       \
    type = rte_log_register_type_and_pick_level(name, RTE_LOG_##level); \
    if (type < 0)                                                       \
        type = RTE_LOGTYPE_EAL;                                     \
}
 
#define RTE_LOG_REGISTER(type, name, level) \
    RTE_LOG_REGISTER_IMPL(type, RTE_STR(name), level)
 
#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)                  \
    RTE_LOG_REGISTER_IMPL(type,                       \
         RTE_STR(RTE_LOG_DEFAULT_LOGTYPE) "." RTE_STR(suffix), level)
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTE_LOG_H_ */