:orphan: .. index:: pair: group; DPDK statistics helper functions TAPI .. _doxid-group__tapi__dpdk__stats: DPDK statistics helper functions TAPI ===================================== .. toctree:: :hidden: Overview ~~~~~~~~ TAPI to handle DPDK-related operations with statistics Copyright (C) 2019-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions void :ref:`tapi_dpdk_stats_pps_artifact`(:ref:`te_mi_logger`* logger, int64_t pps, const char* prefix); uint64_t :ref:`tapi_dpdk_stats_calculate_l1_bitrate`(uint64_t pps, unsigned int packet_size); :ref:`te_errno` :ref:`tapi_dpdk_stats_calculate_l1_link_usage`(uint64_t l1_bitrate, unsigned int link_speed, double* l1_link_usage); void :ref:`tapi_dpdk_stats_l1_bitrate_artifact`(:ref:`te_mi_logger`* logger, uint64_t l1_bitrate, const char* prefix); void :ref:`tapi_dpdk_stats_l1_link_usage_artifact`(:ref:`te_mi_logger`* logger, double l1_link_usage, const char* prefix); void :ref:`tapi_dpdk_stats_cv_artifact`(:ref:`te_mi_logger`* logger, double cv, const char* prefix); :ref:`te_errno` :ref:`tapi_dpdk_stats_summary_artifact`(const :ref:`te_meas_stats_t`* meas_stats, const char* prefix); void :ref:`tapi_dpdk_stats_stab_artifact`(:ref:`te_mi_logger`* logger, const :ref:`te_meas_stats_t`* meas_stats, const char* prefix); :ref:`te_errno` :ref:`tapi_dpdk_stats_log_rates`(const char* tool, const :ref:`te_meas_stats_t`* meas_stats, unsigned int packet_size, unsigned int link_speed, const char* prefix); // macros #define :target:`TAPI_DPDK_STATS_GATHERED_RING`(title, N, fmt_str, ...) .. _details-group__tapi__dpdk__stats: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI to handle DPDK-related operations with statistics Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_dpdk_stats_pps_artifact .. _doxid-group__tapi__dpdk__stats_1ga52f731451336d70f59158ecd76750db9: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_stats_pps_artifact(:ref:`te_mi_logger`* logger, int64_t pps, const char* prefix) Report packet per second statistics as a test artifact. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - logger - MI logger entity to add artifact into (may be ``NULL``) * - pps - Packets per second * - prefix - Prefix of the artifact message (may be ``NULL``) .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_calculate_l1_bitrate .. _doxid-group__tapi__dpdk__stats_1gaf11ede07e5522a26484365661ff47a74: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint64_t tapi_dpdk_stats_calculate_l1_bitrate(uint64_t pps, unsigned int packet_size) Calculate layer 1 bits per second from PPS and packet size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pps - Packets per second * - packet_size - Packet size in bytes (without l1 and FCS) .. rubric:: Returns: Layer 1 bits per second .. index:: pair: function; tapi_dpdk_stats_calculate_l1_link_usage .. _doxid-group__tapi__dpdk__stats_1ga48ca2bf72e27df9b51e9aa9207f4241b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_stats_calculate_l1_link_usage(uint64_t l1_bitrate, unsigned int link_speed, double* l1_link_usage) Calculate layer 1 link usage from layer 1 bitrate and link speed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - l1_bitrate - Layer 1 bits per second * - link_speed - Link speed in Mbps * - l1_link_usage - Layer 1 link usage ratio .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_l1_bitrate_artifact .. _doxid-group__tapi__dpdk__stats_1gac70270b98914aa37d7290f7b5796a006: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_stats_l1_bitrate_artifact(:ref:`te_mi_logger`* logger, uint64_t l1_bitrate, const char* prefix) Report packet per second statistics as a test artifact. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - logger - MI logger entity to add artifact into (may be ``NULL``) * - l1_bitrate - Layer 1 bits per second * - prefix - Prefix of the artifact message (may be ``NULL``) .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_l1_link_usage_artifact .. _doxid-group__tapi__dpdk__stats_1gafa829f8db0415d886039aa9708afc58d: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_stats_l1_link_usage_artifact(:ref:`te_mi_logger`* logger, double l1_link_usage, const char* prefix) Report layer 1 link usage statistics as a test artifact. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - logger - MI logger entity to add artifact into (may be ``NULL``) * - l1_link_usage - Layer 1 link usage ratio * - prefix - Prefix of the artifact message (may be ``NULL``) .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_cv_artifact .. _doxid-group__tapi__dpdk__stats_1ga0f230d191fe87a6957ddbdba2074e640: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_stats_cv_artifact(:ref:`te_mi_logger`* logger, double cv, const char* prefix) Report CV of packer per second statistics as a test artifact .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - logger - MI logger entity to add artifact into (may be ``NULL``) * - cv - Coefficient of variation * - prefix - Prefix of the artifact message (may be ``NULL``) .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_summary_artifact .. _doxid-group__tapi__dpdk__stats_1ga185da4c837ca3e7b87c7983acdd487b7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_stats_summary_artifact(const :ref:`te_meas_stats_t`* meas_stats, const char* prefix) Report statistics provided by :ref:`te_meas_stats_summary_t `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - meas_stats - Pointer to :ref:`te_meas_stats_t ` structure * - prefix - Prefix of the artifact message (may be ``NULL``) .. rubric:: Returns: 0 on success .. index:: pair: function; tapi_dpdk_stats_stab_artifact .. _doxid-group__tapi__dpdk__stats_1gae99c7a1df06b25bd1e54f4a4cf40833b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_stats_stab_artifact(:ref:`te_mi_logger`* logger, const :ref:`te_meas_stats_t`* meas_stats, const char* prefix) Report statistics provided by :ref:`te_meas_stats_stab_t `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - logger - MI logger entity to add artifact into (may be ``NULL``) * - meas_stats - Pointer to :ref:`te_meas_stats_t ` structure * - prefix - Prefix of the artifact message (may be ``NULL``) .. index:: pair: function; tapi_dpdk_stats_log_rates .. _doxid-group__tapi__dpdk__stats_1ga551544ce76fcb897e801f60704b4f0d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_stats_log_rates(const char* tool, const :ref:`te_meas_stats_t`* meas_stats, unsigned int packet_size, unsigned int link_speed, const char* prefix) Report rates corresponding to PPS, packet_size and link speed as test artifacts. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tool - Tool used for measurement gathering (must not be ``NULL``) * - meas_stats - Pointer to :ref:`te_meas_stats_t ` structure * - packet_size - Packet size in bytes (without l1 and FCS) * - link_speed - Link speed in Mbps * - prefix - Prefix of artifact messages (may be ``NULL``) .. rubric:: Returns: 0 on success