rte_telemetry.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Intel Corporation
 */
 
#ifndef _RTE_TELEMETRY_H_
#define _RTE_TELEMETRY_H_
 
#include <stdint.h>
#include <rte_compat.h>
#include <rte_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RTE_TEL_MAX_STRING_LEN 128
#define RTE_TEL_MAX_SINGLE_STRING_LEN 8192
#define RTE_TEL_MAX_DICT_ENTRIES 256
#define RTE_TEL_MAX_ARRAY_ENTRIES 512
 
struct rte_tel_data;
 
enum rte_tel_value_type {
    RTE_TEL_STRING_VAL, 
    RTE_TEL_INT_VAL,    
    RTE_TEL_UINT_VAL,  
    RTE_TEL_CONTAINER, 
};
 
#define RTE_TEL_U64_VAL RTE_TEL_UINT_VAL
 
int
rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type);
 
int
rte_tel_data_start_dict(struct rte_tel_data *d);
 
int
rte_tel_data_string(struct rte_tel_data *d, const char *str);
 
int
rte_tel_data_add_array_string(struct rte_tel_data *d, const char *str);
 
int
rte_tel_data_add_array_int(struct rte_tel_data *d, int64_t x);
 
int
rte_tel_data_add_array_uint(struct rte_tel_data *d, uint64_t x);
 
int
rte_tel_data_add_array_u64(struct rte_tel_data *d, uint64_t x)
    __rte_deprecated_msg("use 'rte_tel_data_add_array_uint' instead");
 
int
rte_tel_data_add_array_container(struct rte_tel_data *d,
        struct rte_tel_data *val, int keep);
 
__rte_experimental
int
rte_tel_data_add_array_uint_hex(struct rte_tel_data *d, uint64_t val,
        uint8_t display_bitwidth);
 
int
rte_tel_data_add_dict_string(struct rte_tel_data *d, const char *name,
        const char *val);
 
int
rte_tel_data_add_dict_int(struct rte_tel_data *d, const char *name, int64_t val);
 
int
rte_tel_data_add_dict_uint(struct rte_tel_data *d,
        const char *name, uint64_t val);
 
int
rte_tel_data_add_dict_u64(struct rte_tel_data *d,
        const char *name, uint64_t val)
    __rte_deprecated_msg("use 'rte_tel_data_add_dict_uint' instead");
 
int
rte_tel_data_add_dict_container(struct rte_tel_data *d, const char *name,
        struct rte_tel_data *val, int keep);
 
__rte_experimental
int
rte_tel_data_add_dict_uint_hex(struct rte_tel_data *d, const char *name,
        uint64_t val, uint8_t display_bitwidth);
 
typedef int (*telemetry_cb)(const char *cmd, const char *params,
        struct rte_tel_data *info);
 
typedef int (*telemetry_arg_cb)(const char *cmd, const char *params, void *arg,
        struct rte_tel_data *info);
 
typedef void * (*handler)(void *sock_id);
 
int
rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);
 
__rte_experimental
int
rte_telemetry_register_cmd_arg(const char *cmd, telemetry_arg_cb fn, void *arg, const char *help);
 
struct rte_tel_data *
rte_tel_data_alloc(void);
 
void
rte_tel_data_free(struct rte_tel_data *data);
 
#ifdef __cplusplus
}
#endif
 
#endif