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_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>
#include <sys/queue.h>

#include <rte_common.h>
#include <rte_config.h>
#include <rte_compat.h>

struct rte_log_dynamic_type;

struct rte_logs {
    uint32_t type;  
    uint32_t level; 
    FILE *file;     
    size_t dynamic_types_len;
    struct rte_log_dynamic_type *dynamic_types;
};

extern struct rte_logs rte_logs;

/* SDK log type */
#define RTE_LOGTYPE_EAL        0 
#define RTE_LOGTYPE_MALLOC     1 
#define RTE_LOGTYPE_RING       2 
#define RTE_LOGTYPE_MEMPOOL    3 
#define RTE_LOGTYPE_TIMER      4 
#define RTE_LOGTYPE_PMD        5 
#define RTE_LOGTYPE_HASH       6 
#define RTE_LOGTYPE_LPM        7 
#define RTE_LOGTYPE_KNI        8 
#define RTE_LOGTYPE_ACL        9 
#define RTE_LOGTYPE_POWER     10 
#define RTE_LOGTYPE_METER     11 
#define RTE_LOGTYPE_SCHED     12 
#define RTE_LOGTYPE_PORT      13 
#define RTE_LOGTYPE_TABLE     14 
#define RTE_LOGTYPE_PIPELINE  15 
#define RTE_LOGTYPE_MBUF      16 
#define RTE_LOGTYPE_CRYPTODEV 17 
#define RTE_LOGTYPE_EFD       18 
#define RTE_LOGTYPE_EVENTDEV  19 
#define RTE_LOGTYPE_GSO       20 
/* 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  
int rte_openlog_stream(FILE *f);

__rte_experimental
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);

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);

__rte_experimental
int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);

void rte_log_dump(FILE *f);

int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
#ifdef __GNUC__
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
    __attribute__((cold))
#endif
#endif
    __attribute__((format(printf, 3, 4)));

int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
    __attribute__((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)

#ifdef __cplusplus
}
#endif

#endif /* _RTE_LOG_H_ */