:orphan:

.. index:: pair: group; TAPI functions to support l2fwd
.. _doxid-group__tapi__l2fwd:

TAPI functions to support l2fwd
===============================

.. toctree::
	:hidden:

	struct_tapi_dpdk_l2fwd_job_t.rst

Overview
~~~~~~~~

TAPI to handle DPDK l2fwd operations

Copyright (C) 2020-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__l2fwd>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef struct :ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>` :ref:`tapi_dpdk_l2fwd_job_t<doxid-group__tapi__l2fwd_1gaedb3fa1f5711b2b061f823867228dc01>`;

	// structs

	struct :ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :target:`tapi_dpdk_l2fwd_start<doxid-group__tapi__l2fwd_1ga928a296a77187c863932ea4b10540e51>`(:ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`* l2fwd_job);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :target:`tapi_dpdk_l2fwd_destroy<doxid-group__tapi__l2fwd_1ga71c879b91e6d30f3d5531c918313f9d9>`(:ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`* l2fwd_job);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :target:`tapi_dpdk_l2fwd_get_stats<doxid-group__tapi__l2fwd_1ga8f4c9956c13b486094ca1a8416322c1e>`(:ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`* l2fwd_job, :ref:`te_meas_stats_t<doxid-structte__meas__stats__t>`* tx, :ref:`te_meas_stats_t<doxid-structte__meas__stats__t>`* rx);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dpdk_create_l2fwd_job<doxid-group__tapi__l2fwd_1ga226cf78efdcc61fd7e6383078bd005d8>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`tapi_env<doxid-structtapi__env>`* env, unsigned int n_fwd_cpus, const :ref:`tapi_cpu_prop_t<doxid-structtapi__cpu__prop__t>`* prop, te_kvpair_h* test_args, :ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`* l2fwd_job);

	// macros

	#define :ref:`TAPI_DPDK_L2FWD_RECEIVE_TIMEOUT_MS<doxid-group__tapi__l2fwd_1gaea92b5f6effc2181c87db410e1022e7f>`
	#define :ref:`TAPI_DPDK_L2FWD_TERM_TIMEOUT_MS<doxid-group__tapi__l2fwd_1gae6eaf9d198e17360525a2337a4cc3304>`

.. _details-group__tapi__l2fwd:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

TAPI to handle DPDK l2fwd operations

Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_dpdk_l2fwd_job_t
.. _doxid-group__tapi__l2fwd_1gaedb3fa1f5711b2b061f823867228dc01:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>` tapi_dpdk_l2fwd_job_t

L2fwd job description

Global Functions
----------------

.. index:: pair: function; tapi_dpdk_create_l2fwd_job
.. _doxid-group__tapi__l2fwd_1ga226cf78efdcc61fd7e6383078bd005d8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dpdk_create_l2fwd_job(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`tapi_env<doxid-structtapi__env>`* env, unsigned int n_fwd_cpus, const :ref:`tapi_cpu_prop_t<doxid-structtapi__cpu__prop__t>`* prop, te_kvpair_h* test_args, :ref:`tapi_dpdk_l2fwd_job_t<doxid-structtapi__dpdk__l2fwd__job__t>`* l2fwd_job)

Create a job for l2fwd 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 l2fwd on

	*
		- env

		- Test environment

	*
		- n_fwd_cpus

		- Number of l2fwd forwarding CPUs

	*
		- prop

		- Advisory properties of CPUs

	*
		- test_args

		- Test arguments

	*
		- l2fwd_job

		- Pointer to the l2fwd job



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TAPI_DPDK_L2FWD_RECEIVE_TIMEOUT_MS
.. _doxid-group__tapi__l2fwd_1gaea92b5f6effc2181c87db410e1022e7f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_DPDK_L2FWD_RECEIVE_TIMEOUT_MS

Timeout to wait for job receiving

.. index:: pair: define; TAPI_DPDK_L2FWD_TERM_TIMEOUT_MS
.. _doxid-group__tapi__l2fwd_1gae6eaf9d198e17360525a2337a4cc3304:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_DPDK_L2FWD_TERM_TIMEOUT_MS

Timeout for job termination