:orphan: .. index:: pair: group; DPDK helper functions TAPI .. _doxid-group__tapi__dpdk: DPDK helper functions TAPI ========================== .. toctree:: :hidden: struct_tapi_dpdk_testpmd_job_t.rst Overview ~~~~~~~~ TAPI to handle DPDK-related operations Copyright (C) 2019-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_dpdk_testpmd_job_t` :target:`tapi_dpdk_testpmd_job_t`; // structs struct :ref:`tapi_dpdk_testpmd_job_t`; // global functions :ref:`te_errno` :ref:`tapi_dpdk_create_testpmd_job`(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, unsigned int n_fwd_cpus, const :ref:`tapi_cpu_prop_t`* prop, te_kvpair_h* test_args, :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); :ref:`te_errno` :ref:`tapi_dpdk_testpmd_is_opt_supported`(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, te_kvpair_h* opt, bool* opt_supported); :ref:`te_errno` :ref:`tapi_dpdk_testpmd_start`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); :ref:`te_errno` :ref:`tapi_dpdk_testpmd_get_link_speed`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, unsigned int* link_speed); :ref:`te_errno` :ref:`tapi_dpdk_testpmd_get_stats`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, :ref:`te_meas_stats_t`* tx, :ref:`te_meas_stats_t`* rx); :ref:`te_errno` :ref:`tapi_dpdk_testpmd_destroy`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); bool :ref:`tapi_dpdk_mtu_by_pkt_size`(unsigned int packet_size, unsigned int* mtu); bool :ref:`tapi_dpdk_mbuf_size_by_pkt_size`(unsigned int packet_size, unsigned int* mbuf_size); void :ref:`tapi_dpdk_append_argument`(const char* argument, int* argc_p, char*** argv_out); :ref:`te_errno` :ref:`tapi_dpdk_build_eal_arguments`(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, unsigned int n_cpus, :ref:`tapi_cpu_index_t`* cpu_ids, const char* program_name, int* argc_out, char*** argv_out); :ref:`te_errno` :target:`tapi_dpdk_grab_cpus`(const char* ta, unsigned int n_cpus_preferred, unsigned int n_cpus_required, int numa_node, const :ref:`tapi_cpu_prop_t`* prop, unsigned int* n_cpus_grabbed, :ref:`tapi_cpu_index_t`* cpu_ids); :ref:`te_errno` :target:`tapi_dpdk_grab_cpus_nonstrict_prop`(const char* ta, unsigned int n_cpus_preferred, unsigned int n_cpus_required, int numa_node, const :ref:`tapi_cpu_prop_t`* prop, unsigned int* n_cpus_grabbed, :ref:`tapi_cpu_index_t`* cpu_ids); const char* :target:`tapi_dpdk_get_vdev_eal_argument`(int eal_argc, char** eal_argv); :ref:`te_errno` :target:`tapi_dpdk_get_vdev_port_number`(const char* vdev, unsigned int* port_number); :ref:`te_errno` :ref:`tapi_dpdk_attach_dbells_filter_rx`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); :ref:`te_errno` :ref:`tapi_dpdk_attach_dbells_filter_tx`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); :ref:`te_errno` :ref:`tapi_dpdk_add_rx_dbells_display`(te_kvpair_h* test_params, const char* q_num); :ref:`te_errno` :ref:`tapi_dpdk_add_tx_dbells_display`(te_kvpair_h* test_params, const char* q_num); :ref:`te_errno` :ref:`tapi_dpdk_stats_log_rx_dbells`(const :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, const :ref:`te_meas_stats_t`* meas_stats_pps); :ref:`te_errno` :ref:`tapi_dpdk_stats_log_tx_dbells`(const :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, const :ref:`te_meas_stats_t`* meas_stats_pps); :ref:`te_errno` :ref:`tapi_dpdk_attach_rx_pkts_bytes_filters`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job); :ref:`te_errno` :ref:`tapi_dpdk_get_last_rx_pkts_bytes`(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, unsigned long* pkts, unsigned long* bytes); // macros #define :ref:`TAPI_DPDK_L2FWD_NAME` #define :target:`TAPI_DPDK_TESTPMD_ARG_PREFIX` #define :target:`TAPI_DPDK_TESTPMD_COMMAND_PREFIX` #define :ref:`TAPI_DPDK_TESTPMD_NAME` #define :target:`TAPI_DPDK_TESTPMD_RECEIVE_TIMEOUT_MS` #define :target:`TAPI_DPDK_TESTPMD_TERM_TIMEOUT_MS` #define :target:`TAPI_DPDK_TESTPMD_TSO_MSS_HDRS_LEN` .. _details-group__tapi__dpdk: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI to handle DPDK-related operations Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_dpdk_create_testpmd_job .. _doxid-group__tapi__dpdk_1gaf4382d5e995ec54d271f84b807f55367: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_create_testpmd_job(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, unsigned int n_fwd_cpus, const :ref:`tapi_cpu_prop_t`* prop, te_kvpair_h* test_args, :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Create a job for test-pmd binary execution. The created job can be manipulated with other tapi_dpdk functions as well as passed to generic tapi_job functions. ``prop`` is advisory .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server to run test-pmd on * - env - Test environment * - n_fwd_cpus - Number of test-pmd forwarding CPUs * - prop - Advisory properties of CPUs * - test_args - Test arguments * - testpmd_job - Handle of test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_testpmd_is_opt_supported .. _doxid-group__tapi__dpdk_1ga3f9281a02ce295071075e5ded4dc26ee: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_testpmd_is_opt_supported(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, te_kvpair_h* opt, bool* opt_supported) Check if option specified in ``opt`` is supported by test-pmd. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server to run test-pmd on * - env - Test environment * - opt - Option to check support for * - opt_supported - Result .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_testpmd_start .. _doxid-group__tapi__dpdk_1ga080ab3aeb17cd35adaa4770cecd65c6f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_testpmd_start(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Start test-pmd job .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_testpmd_get_link_speed .. _doxid-group__tapi__dpdk_1gac66c2629287899f45c157dada6cb1b8b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_testpmd_get_link_speed(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, unsigned int* link_speed) Get link speed from running test-pmd job. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of test-pmd job * - link_speed - Link speed in Mbps .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_testpmd_get_stats .. _doxid-group__tapi__dpdk_1gae44e5a0b155d047423e1ca178315ae5a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_testpmd_get_stats(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, :ref:`te_meas_stats_t`* tx, :ref:`te_meas_stats_t`* rx) Get performance statistics from running test-pmd job. The ``testpmd_job`` must be started. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of running test-pmd job * - tx - Evaluated Tx statistics * - rx - Evaluated Rx statistics .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_testpmd_destroy .. _doxid-group__tapi__dpdk_1ga9e8b74a3456ccb69a9672a3221b894d6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_testpmd_destroy(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Destroy test-pmd job .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_mtu_by_pkt_size .. _doxid-group__tapi__dpdk_1gad61298572dd012ec45c2cb348cbc6216: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool tapi_dpdk_mtu_by_pkt_size(unsigned int packet_size, unsigned int* mtu) Calculate required MTU by given packet size and decide whether the MTU should be specified explicitly in the parameters. c true Required MTU is greater than ``ETHER_DATA_LEN`` c false Required MTU is less or equal to ``ETHER_DATA_LEN`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - packet_size - Size of a packet * - mtu - .. rubric:: Returns: If required MTU is greater than ``ETHER_DATA_LEN`` .. index:: pair: function; tapi_dpdk_mbuf_size_by_pkt_size .. _doxid-group__tapi__dpdk_1ga6a3080c65c50c225fe4bd4310885d63d: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool tapi_dpdk_mbuf_size_by_pkt_size(unsigned int packet_size, unsigned int* mbuf_size) Calculate required mbuf size by given packet size and decide whether the mbuf size should be specified explicitly in the parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - packet_size - Size of a packet * - mbuf_size - Required mbuf size (set when the function returns ``true``) .. rubric:: Returns: ``true`` - mbuf size should be set, ``false`` - should not be .. index:: pair: function; tapi_dpdk_append_argument .. _doxid-group__tapi__dpdk_1ga46d82603e0610c4357aac52a1281d3be: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_dpdk_append_argument(const char* argument, int* argc_p, char*** argv_out) Append argument to the arguments storage Jumps out via TEST_FAIL in case of failure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - Argument to add * - argc_p - Pointer to the number of arguments * - argv_out - Pointer to the arguments .. index:: pair: function; tapi_dpdk_build_eal_arguments .. _doxid-group__tapi__dpdk_1ga4818ed95b88b5fc91c630e1d67cb6875: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_build_eal_arguments(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env`* env, unsigned int n_cpus, :ref:`tapi_cpu_index_t`* cpu_ids, const char* program_name, int* argc_out, char*** argv_out) Build EAL arguments for TAPI jobs and store it to the arguments storage .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server to run job on * - env - Test environment * - n_cpus - Number of job forwarding CPUs * - cpu_ids - Indices of job forwarding CPUs * - program_name - Full path to the binary job * - argc_out - Pointer to the number of arguments * - argv_out - Pointer to the arguments .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_attach_dbells_filter_rx .. _doxid-group__tapi__dpdk_1gae4b19ca74b9c00189002bc9ce468c4a5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_attach_dbells_filter_rx(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Attach filters to catch Rx doorbells rate and if they are supported. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of running test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_attach_dbells_filter_tx .. _doxid-group__tapi__dpdk_1gaa668e445476b5cff9b2a2948fa3e6696: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_attach_dbells_filter_tx(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Attach filters to catch Tx doorbells rate and if they are supported. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of running test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_add_rx_dbells_display .. _doxid-group__tapi__dpdk_1gafc5d9e2974950621f4bf73414b9aca2f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_add_rx_dbells_display(te_kvpair_h* test_params, const char* q_num) Add display Rx doorbells xstats to dpdk-testpmd parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - test_params - kvpair storing dpdk-testpmd parameters * - q_num - Number of Rx queues. .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_add_tx_dbells_display .. _doxid-group__tapi__dpdk_1gab3aadb268f89d7c6320a77edabeb33f0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_add_tx_dbells_display(te_kvpair_h* test_params, const char* q_num) Add display Tx doorbells xstats to dpdk-testpmd parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - test_params - kvpair storing dpdk-testpmd parameters * - q_num - Number of Tx queues. .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_log_rx_dbells .. _doxid-group__tapi__dpdk_1gaf21f846d09e03f47812e2d6513b4736a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_stats_log_rx_dbells(const :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, const :ref:`te_meas_stats_t`* meas_stats_pps) Report Rx doorbells rate and packets per doorbell as test artifacts. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of running test-pmd job * - meas_stats_pps - Statistics of packets per second .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_stats_log_tx_dbells .. _doxid-group__tapi__dpdk_1gab7b71cf6110b23cabd2a8c48882b5d4c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_stats_log_tx_dbells(const :ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, const :ref:`te_meas_stats_t`* meas_stats_pps) Report Tx doorbells rate and packets per doorbell as test artifacts. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of running test-pmd job * - meas_stats_pps - Statistics of packets per second .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_attach_rx_pkts_bytes_filters .. _doxid-group__tapi__dpdk_1ga6354f0746fde1fb5cdc0a3dc813f9f62: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_attach_rx_pkts_bytes_filters(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job) Attach Rx packets/bytes filters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Handle of test-pmd job .. rubric:: Returns: Status code .. index:: pair: function; tapi_dpdk_get_last_rx_pkts_bytes .. _doxid-group__tapi__dpdk_1gad5a6d65ac76cebd468a4ec72d7f6eefe: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dpdk_get_last_rx_pkts_bytes(:ref:`tapi_dpdk_testpmd_job_t`* testpmd_job, unsigned long* pkts, unsigned long* bytes) Get latest values of Rx packets and bytes from filters attached by :ref:`tapi_dpdk_attach_rx_pkts_bytes_filters() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - testpmd_job - Rx job channel handle * - pkts - Latest Rx packets * - bytes - Latest Rx bytes .. rubric:: Returns: Status code Macros ------ .. index:: pair: define; TAPI_DPDK_L2FWD_NAME .. _doxid-group__tapi__dpdk_1gaee852f6c983ff4303d3e449a5dfeacce: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_DPDK_L2FWD_NAME Name of l2fwd tool .. index:: pair: define; TAPI_DPDK_TESTPMD_NAME .. _doxid-group__tapi__dpdk_1ga6fe4ba6587f0f856d447740f37efaaa8: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_DPDK_TESTPMD_NAME Name of testpmd tool