mirror of https://github.com/F-Stack/f-stack.git
67 lines
1.3 KiB
C
67 lines
1.3 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2018 Intel Corporation
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifndef _RTE_TELEMETRY_H_
|
|
#define _RTE_TELEMETRY_H_
|
|
|
|
/**
|
|
* @file
|
|
* RTE Telemetry
|
|
*
|
|
* The telemetry library provides a method to retrieve statistics from
|
|
* DPDK by sending a JSON encoded message over a socket. DPDK will send
|
|
* a JSON encoded response containing telemetry data.
|
|
***/
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Initialize Telemetry
|
|
*
|
|
* @return
|
|
* 0 on successful initialisation.
|
|
* @return
|
|
* -ENOMEM on memory allocation error
|
|
* @return
|
|
* -EPERM on unknown error failure
|
|
* @return
|
|
* -EALREADY if Telemetry is already initialised.
|
|
*/
|
|
int32_t __rte_experimental
|
|
rte_telemetry_init(void);
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Clean up and free memory.
|
|
*
|
|
* @return
|
|
* 0 on success
|
|
* @return
|
|
* -EPERM on failure
|
|
*/
|
|
int32_t __rte_experimental
|
|
rte_telemetry_cleanup(void);
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Runs various tests to ensure telemetry initialisation and register/unregister
|
|
* functions are working correctly.
|
|
*
|
|
* @return
|
|
* 0 on success when all tests have passed
|
|
* @return
|
|
* -1 on failure when the test has failed
|
|
*/
|
|
int32_t __rte_experimental
|
|
rte_telemetry_selftest(void);
|
|
|
|
#endif
|