DPDK 22.11.5
|
#include <stdint.h>
Go to the source code of this file.
Macros | |
#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 |
Typedefs | |
typedef int(* | telemetry_cb) (const char *cmd, const char *params, struct rte_tel_data *info) |
typedef void *(* | handler) (void *sock_id) |
Enumerations | |
enum | rte_tel_value_type { } |
Functions | |
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, int x) |
int | rte_tel_data_add_array_u64 (struct rte_tel_data *d, uint64_t x) |
int | rte_tel_data_add_array_container (struct rte_tel_data *d, struct rte_tel_data *val, int keep) |
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, int val) |
int | rte_tel_data_add_dict_u64 (struct rte_tel_data *d, const char *name, uint64_t val) |
int | rte_tel_data_add_dict_container (struct rte_tel_data *d, const char *name, struct rte_tel_data *val, int keep) |
int | rte_telemetry_register_cmd (const char *cmd, telemetry_cb fn, const char *help) |
struct rte_tel_data * | rte_tel_data_alloc (void) |
RTE Telemetry.
The telemetry library provides a method to retrieve statistics from DPDK by sending a request message over a socket. DPDK will send a JSON encoded response containing telemetry data.
Definition in file rte_telemetry.h.
#define RTE_TEL_MAX_STRING_LEN 128 |
Maximum length for string used in object.
Definition at line 15 of file rte_telemetry.h.
#define RTE_TEL_MAX_SINGLE_STRING_LEN 8192 |
Maximum length of string.
Definition at line 17 of file rte_telemetry.h.
#define RTE_TEL_MAX_DICT_ENTRIES 256 |
Maximum number of dictionary entries.
Definition at line 19 of file rte_telemetry.h.
#define RTE_TEL_MAX_ARRAY_ENTRIES 512 |
Maximum number of array entries.
Definition at line 21 of file rte_telemetry.h.
typedef int(* telemetry_cb) (const char *cmd, const char *params, struct rte_tel_data *info) |
This telemetry callback is used when registering a telemetry command. It handles getting and formatting information to be returned to telemetry when requested.
cmd | The cmd that was requested by the client. |
params | Contains data required by the callback function. |
info | The information to be returned to the caller. |
Definition at line 251 of file rte_telemetry.h.
typedef void *(* handler) (void *sock_id) |
Used for handling data received over a telemetry socket.
sock_id | ID for the socket to be used by the handler. |
Definition at line 263 of file rte_telemetry.h.
enum rte_tel_value_type |
The types of data that can be managed in arrays or dicts. For arrays, this must be specified at creation time, while for dicts this is specified implicitly each time an element is added via calling a type-specific function.
Enumerator | |
---|---|
RTE_TEL_INT_VAL | a string value |
RTE_TEL_U64_VAL | a signed 32-bit int value |
RTE_TEL_CONTAINER | an unsigned 64-bit int value |
Definition at line 42 of file rte_telemetry.h.
int rte_tel_data_start_array | ( | struct rte_tel_data * | d, |
enum rte_tel_value_type | type | ||
) |
Start an array of the specified type for returning from a callback
d | The data structure passed to the callback |
type | The type of the array of data |
int rte_tel_data_start_dict | ( | struct rte_tel_data * | d | ) |
Start a dictionary of values for returning from a callback
Dictionaries consist of key-values pairs to be returned, where the keys, or names, are strings and the values can be any of the types supported by telemetry. Name strings may only contain alphanumeric characters as well as '_' or '/'
d | The data structure passed to the callback |
int rte_tel_data_string | ( | struct rte_tel_data * | d, |
const char * | str | ||
) |
Set a string for returning from a callback
d | The data structure passed to the callback |
str | The string to be returned in the data structure |
int rte_tel_data_add_array_string | ( | struct rte_tel_data * | d, |
const char * | str | ||
) |
Add a string to an array. The array must have been started by rte_tel_data_start_array() with RTE_TEL_STRING_VAL as the type parameter.
d | The data structure passed to the callback |
str | The string to be returned in the array |
int rte_tel_data_add_array_int | ( | struct rte_tel_data * | d, |
int | x | ||
) |
Add an int to an array. The array must have been started by rte_tel_data_start_array() with RTE_TEL_INT_VAL as the type parameter.
d | The data structure passed to the callback |
x | The number to be returned in the array |
int rte_tel_data_add_array_u64 | ( | struct rte_tel_data * | d, |
uint64_t | x | ||
) |
Add a uint64_t to an array. The array must have been started by rte_tel_data_start_array() with RTE_TEL_U64_VAL as the type parameter.
d | The data structure passed to the callback |
x | The number to be returned in the array |
int rte_tel_data_add_array_container | ( | struct rte_tel_data * | d, |
struct rte_tel_data * | val, | ||
int | keep | ||
) |
Add a container to an array. A container is an existing telemetry data array. The array the container is to be added to must have been started by rte_tel_data_start_array() with RTE_TEL_CONTAINER as the type parameter. The container type must be an array of type uint64_t/int/string.
d | The data structure passed to the callback |
val | The pointer to the container to be stored in the array. |
keep | Flag to indicate that the container memory should not be automatically freed by the telemetry library once it has finished with the data. 1 = keep, 0 = free. |
int rte_tel_data_add_dict_string | ( | struct rte_tel_data * | d, |
const char * | name, | ||
const char * | val | ||
) |
Add a string value to a dictionary. The dict must have been started by rte_tel_data_start_dict().
d | The data structure passed to the callback |
name | The name the value is to be stored under in the dict Must contain only alphanumeric characters or the symbols: '_' or '/' |
val | The string to be stored in the dict |
int rte_tel_data_add_dict_int | ( | struct rte_tel_data * | d, |
const char * | name, | ||
int | val | ||
) |
Add an int value to a dictionary. The dict must have been started by rte_tel_data_start_dict().
d | The data structure passed to the callback |
name | The name the value is to be stored under in the dict Must contain only alphanumeric characters or the symbols: '_' or '/' |
val | The number to be stored in the dict |
int rte_tel_data_add_dict_u64 | ( | struct rte_tel_data * | d, |
const char * | name, | ||
uint64_t | val | ||
) |
Add a uint64_t value to a dictionary. The dict must have been started by rte_tel_data_start_dict().
d | The data structure passed to the callback |
name | The name the value is to be stored under in the dict Must contain only alphanumeric characters or the symbols: '_' or '/' |
val | The number to be stored in the dict |
int rte_tel_data_add_dict_container | ( | struct rte_tel_data * | d, |
const char * | name, | ||
struct rte_tel_data * | val, | ||
int | keep | ||
) |
Add a container to a dictionary. A container is an existing telemetry data array. The dict the container is to be added to must have been started by rte_tel_data_start_dict(). The container must be an array of type uint64_t/int/string.
d | The data structure passed to the callback |
name | The name the value is to be stored under in the dict. Must contain only alphanumeric characters or the symbols: '_' or '/' |
val | The pointer to the container to be stored in the dict. |
keep | Flag to indicate that the container memory should not be automatically freed by the telemetry library once it has finished with the data. 1 = keep, 0 = free. |
int rte_telemetry_register_cmd | ( | const char * | cmd, |
telemetry_cb | fn, | ||
const char * | help | ||
) |
Used when registering a command and callback function with telemetry.
cmd | The command to register with telemetry. |
fn | Callback function to be called when the command is requested. |
help | Help text for the command. |
struct rte_tel_data * rte_tel_data_alloc | ( | void | ) |
Get a pointer to a container with memory allocated. The container is to be used embedded within an existing telemetry dict/array.