4ad8807cfc
rte_stats_bitrate_free() has been in DPDK since 20.11. Its signature is very basic as it just frees an opaque data struct allocated in rte_stats_bitrate_create() and returns void. It's unlikely that such a basic signature would need to change so might as well promote it to stable for the next major ABI. Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
73 lines
1.4 KiB
C
73 lines
1.4 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2017 Intel Corporation
|
|
*/
|
|
|
|
#ifndef _RTE_BITRATE_H_
|
|
#define _RTE_BITRATE_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Bitrate statistics data structure.
|
|
* This data structure is intentionally opaque.
|
|
*/
|
|
struct rte_stats_bitrates;
|
|
|
|
|
|
/**
|
|
* Allocate a bitrate statistics structure
|
|
*
|
|
* @return
|
|
* - Pointer to structure on success
|
|
* - NULL on error (zmalloc failure)
|
|
*/
|
|
struct rte_stats_bitrates *rte_stats_bitrate_create(void);
|
|
|
|
/**
|
|
* Free bitrate statistics structure
|
|
*
|
|
* @param bitrate_data
|
|
* Pointer allocated by rte_stats_bitrate_create()
|
|
*/
|
|
void rte_stats_bitrate_free(struct rte_stats_bitrates *bitrate_data);
|
|
|
|
/**
|
|
* Register bitrate statistics with the metric library.
|
|
*
|
|
* @param bitrate_data
|
|
* Pointer allocated by rte_stats_bitrate_create()
|
|
*
|
|
* @return
|
|
* Zero on success
|
|
* Negative on error
|
|
*/
|
|
int rte_stats_bitrate_reg(struct rte_stats_bitrates *bitrate_data);
|
|
|
|
|
|
/**
|
|
* Calculate statistics for current time window. The period with which
|
|
* this function is called should be the intended sampling window width.
|
|
*
|
|
* @param bitrate_data
|
|
* Bitrate statistics data pointer
|
|
*
|
|
* @param port_id
|
|
* Port id to calculate statistics for
|
|
*
|
|
* @return
|
|
* - Zero on success
|
|
* - Negative value on error
|
|
*/
|
|
int rte_stats_bitrate_calc(struct rte_stats_bitrates *bitrate_data,
|
|
uint16_t port_id);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_BITRATE_H_ */
|