rte_log.h

Go to the documentation of this file.

#ifndef RTE_OS_LOG_H
#define RTE_OS_LOG_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
#include "rte/utils/string/rte_string.h" /* rte_log_fields_t backing store */
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum rte_log_level_e
{
    RTE_LOG_LEVEL_DEBUG   = 0, 
    RTE_LOG_LEVEL_INFO    = 1, 
    RTE_LOG_LEVEL_WARNING = 2, 
    RTE_LOG_LEVEL_ERROR   = 3  
} rte_log_level_t;

rte_status_t rte_log_init(void);

void rte_log_write(rte_log_level_t level, const char *tag, const char *message);

const char *rte_log_level_to_string(rte_log_level_t level);

rte_status_t rte_log_level_from_string(const char *name, rte_log_level_t *out_level);

void rte_log_set_level(rte_log_level_t min_level);

rte_log_level_t rte_log_get_level(void);

#define RTE_LOG_EVENT_LINE_MAX_LEN 256U

void rte_log_write_event(rte_log_level_t level,
                           const char *site,
                           uint32_t cycle,
                           const char *source,
                           const char *destination,
                           const char *type,
                           const char *info,
                           const char *extra_fields);

typedef struct rte_log_fields_s
{
    rte_string_t str;                         
    char          storage[RTE_LOG_EVENT_LINE_MAX_LEN]; 
} rte_log_fields_t;

void rte_log_fields_reset(rte_log_fields_t *fields);

rte_log_fields_t *rte_log_fields_add_str(rte_log_fields_t *fields, const char *key, const char *value);
rte_log_fields_t *rte_log_fields_add_u32(rte_log_fields_t *fields, const char *key, uint32_t value);
rte_log_fields_t *rte_log_fields_add_i32(rte_log_fields_t *fields, const char *key, int32_t value);
rte_log_fields_t *rte_log_fields_add_u64(rte_log_fields_t *fields, const char *key, uint64_t value);
rte_log_fields_t *rte_log_fields_add_i64(rte_log_fields_t *fields, const char *key, int64_t value);
rte_log_fields_t *rte_log_fields_add_hex_u32(rte_log_fields_t *fields, const char *key,
                                               uint32_t value, uint8_t min_digits);
rte_log_fields_t *rte_log_fields_add_bool(rte_log_fields_t *fields, const char *key, bool value);

const char *rte_log_fields_c_str(rte_log_fields_t *fields);

void rte_log_write_event_fields(rte_log_level_t level,
                                  const char *site,
                                  uint32_t cycle,
                                  const char *source,
                                  const char *destination,
                                  const char *type,
                                  const char *info,
                                  rte_log_fields_t *fields);
 
/*
 * The OSAdapter vtable (rte_osadapter_log_t) and rte_osadapter_log_register()
 * live in rte_osadapter/log/rte_osadapter_log.h, not here (ADR-021).
 * This header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_LOG_H */
 /* LOG */