doca_telemetry_exporter.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2022 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_TELEMETRY_EXPORTER_H_
#define DOCA_TELEMETRY_EXPORTER_H_
 
#include <stdint.h>
#include <stddef.h>
 
#include <doca_compat.h>
#include <doca_error.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum doca_telemetry_exporter_ipc_status {
    DOCA_TELEMETRY_EXPORTER_IPC_STATUS_FAILED = -1,
    DOCA_TELEMETRY_EXPORTER_IPC_STATUS_CONNECTED,
    DOCA_TELEMETRY_EXPORTER_IPC_STATUS_DISABLED,
} doca_telemetry_exporter_ipc_status_t;
 
struct doca_telemetry_exporter_schema;
 
struct doca_telemetry_exporter_source;
 
typedef uint8_t doca_telemetry_exporter_type_index_t;
 
typedef uint64_t doca_telemetry_exporter_timestamp_t;
 
struct doca_telemetry_exporter_field;
 
struct doca_telemetry_exporter_type;
 
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_BOOL "bool"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_CHAR "char"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_SHORT "short"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_INT "int"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_LONG "long"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_LONGLONG "long long"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UCHAR "unsigned char"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_USHORT "unsigned short"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT "unsigned int"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_ULONG "unsigned long"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_ULONGLONG "unsigned long long"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_FLOAT "float"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_DOUBLE "double"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_INT8 "int8_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_INT16 "int16_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_INT32 "int32_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_INT64 "int64_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT8 "uint8_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT16 "uint16_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT32 "uint32_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT64 "uint64_t"
#define DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_TIMESTAMP DOCA_TELEMETRY_EXPORTER_FIELD_TYPE_UINT64
 
#define DOCA_GUID_SIZE 16
typedef uint8_t doca_guid_t[DOCA_GUID_SIZE];
 
/* ================================ DOCA SCHEMA ================================ */
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_init(const char *schema_name,
                         struct doca_telemetry_exporter_schema **doca_schema);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_buf_size(struct doca_telemetry_exporter_schema *doca_schema, uint64_t size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_buf_size(struct doca_telemetry_exporter_schema *doca_schema,
                             uint64_t *size);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_buf_data_root(struct doca_telemetry_exporter_schema *doca_schema,
                              const char *path);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_buf_data_root(struct doca_telemetry_exporter_schema *doca_schema,
                                  const char **path);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_file_write_enabled(struct doca_telemetry_exporter_schema *doca_schema);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_file_write_max_size(struct doca_telemetry_exporter_schema *doca_schema,
                                size_t size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_file_write_max_size(struct doca_telemetry_exporter_schema *doca_schema,
                                    size_t *size);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_file_write_max_age(struct doca_telemetry_exporter_schema *doca_schema,
                               doca_telemetry_exporter_timestamp_t max_age);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_file_write_max_age(struct doca_telemetry_exporter_schema *doca_schema,
                                   doca_telemetry_exporter_timestamp_t *max_age);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_ipc_enabled(struct doca_telemetry_exporter_schema *doca_schema);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_ipc_sockets_dir(struct doca_telemetry_exporter_schema *doca_schema,
                            const char *sockets_dir);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_ipc_sockets_dir(struct doca_telemetry_exporter_schema *doca_schema,
                                const char **sockets_dir);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_ipc_reconnect_time(struct doca_telemetry_exporter_schema *doca_schema,
                               uint32_t max_time);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_ipc_reconnect_time(struct doca_telemetry_exporter_schema *doca_schema,
                                   uint32_t *max_time);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_ipc_reconnect_tries(struct doca_telemetry_exporter_schema *doca_schema,
                                uint8_t tries);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_ipc_reconnect_tries(struct doca_telemetry_exporter_schema *doca_schema,
                                    uint8_t *tries);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_ipc_socket_timeout(struct doca_telemetry_exporter_schema *doca_schema,
                               uint32_t timeout);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_get_ipc_socket_timeout(struct doca_telemetry_exporter_schema *doca_schema,
                                   uint32_t *timeout);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_schema_set_opaque_events_enabled(struct doca_telemetry_exporter_schema *doca_schema);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_type_create(struct doca_telemetry_exporter_type **type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_type_add_field(struct doca_telemetry_exporter_type *type,
                            struct doca_telemetry_exporter_field *field);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_type_destroy(struct doca_telemetry_exporter_type *type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_field_create(struct doca_telemetry_exporter_field **field);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_field_destroy(struct doca_telemetry_exporter_field *field);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_field_set_name(struct doca_telemetry_exporter_field *field_info, const char *name);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_field_set_description(struct doca_telemetry_exporter_field *field_info, const char *desc);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_field_set_type_name(struct doca_telemetry_exporter_field *field_info, const char *type);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_field_set_array_len(struct doca_telemetry_exporter_field *field_info, uint16_t len);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_add_type(struct doca_telemetry_exporter_schema *doca_schema,
                             const char *new_type_name,
                             struct doca_telemetry_exporter_type *type,
                             doca_telemetry_exporter_type_index_t *type_index);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_destroy(struct doca_telemetry_exporter_schema *doca_schema);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_schema_start(struct doca_telemetry_exporter_schema *doca_schema);
 
/* ================================ DOCA SOURCE ================================ */
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_create(struct doca_telemetry_exporter_schema *doca_schema,
                           struct doca_telemetry_exporter_source **doca_source);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_source_set_id(struct doca_telemetry_exporter_source *doca_source, const char *source_id);
 
DOCA_EXPERIMENTAL
void doca_telemetry_exporter_source_set_tag(struct doca_telemetry_exporter_source *doca_source, const char *source_tag);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_start(struct doca_telemetry_exporter_source *doca_source);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_report(struct doca_telemetry_exporter_source *doca_source,
                           doca_telemetry_exporter_type_index_t index,
                           void *data,
                           int count);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_opaque_report(struct doca_telemetry_exporter_source *doca_source,
                              const doca_guid_t app_id,
                              uint64_t user_defined1,
                              uint64_t user_defined2,
                              const void *data,
                              uint32_t data_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_get_opaque_report_max_data_size(
    struct doca_telemetry_exporter_source *doca_source,
    uint32_t *max_data_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_flush(struct doca_telemetry_exporter_source *doca_source);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_source_destroy(struct doca_telemetry_exporter_source *doca_source);
 
/* ================================ Utilities ================================ */
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_get_timestamp(doca_telemetry_exporter_timestamp_t *timestamp);
 
DOCA_EXPERIMENTAL
doca_error_t doca_telemetry_exporter_check_ipc_status(struct doca_telemetry_exporter_source *doca_source,
                              doca_telemetry_exporter_ipc_status_t *status);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* DOCA_TELEMETRY_EXPORTER_H_ */