:orphan:

.. index:: pair: struct; tapi_trex_opt
.. _doxid-structtapi__trex__opt:

struct tapi_trex_opt
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Specific TRex options. :ref:`More...<details-structtapi__trex__opt>`


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

	#include <tapi_trex.h>
	
	struct tapi_trex_opt {
		// fields
	
		:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` :ref:`stdout_log_level<doxid-structtapi__trex__opt_1ad87b9c80b0e1ecfb29de8ad1a45a5070>`;
		:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` :ref:`stderr_log_level<doxid-structtapi__trex__opt_1aee973882f37409b85b02ca5fc23ef5c4>`;
		bool :ref:`astf_server_only<doxid-structtapi__trex__opt_1ae7cf02e95644d17aa4acf6a227368bf6>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`n_threads<doxid-structtapi__trex__opt_1a0f4f359dea4ddd1c2138d08a2076393b>`;
		bool :ref:`tso_disable<doxid-structtapi__trex__opt_1a6d17a836b68fc058b1c30975c50717b8>`;
		bool :ref:`lro_disable<doxid-structtapi__trex__opt_1a82c6ad69acc3eb8b9e160a922a8233f6>`;
		:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` :ref:`duration<doxid-structtapi__trex__opt_1a576e639a90bf35a0e124774f4b8b4378>`;
		bool :ref:`asymmetric_traffic_flow<doxid-structtapi__trex__opt_1a3cead61a10302281f5c23f3effec036a>`;
		bool :ref:`use_hdr_histograms<doxid-structtapi__trex__opt_1aefc538120e15e844f0d4bb3ea55f4574>`;
		bool :ref:`ipv6<doxid-structtapi__trex__opt_1add80906b27f3a677ba3aa7f5cfd7a471>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`rate_multiplier<doxid-structtapi__trex__opt_1aa853075b07646c3faf24709db27c4ea3>`;
		bool :ref:`force_close_at_end<doxid-structtapi__trex__opt_1a8b463b3b55ae69dd3fbbc4ae1790da05>`;
		bool :ref:`enable_flow_control<doxid-structtapi__trex__opt_1a1455f891963f88c90c3be97a77b08720>`;
		bool :ref:`no_watchdog<doxid-structtapi__trex__opt_1a4c0071250121adcfc607cd1062d9f64b>`;
		bool :ref:`use_realtime_prio<doxid-structtapi__trex__opt_1a56d665c370a3ffd6cbe540e55526eb3c>`;
		bool :ref:`no_monitors<doxid-structtapi__trex__opt_1ae7f69404179c43eac6343635c854a5ce>`;
		bool :ref:`dont_resend_pkts<doxid-structtapi__trex__opt_1a1efdc7dcfad01e11ae73f0e30e80ab8f>`;
		bool :ref:`use_sleep<doxid-structtapi__trex__opt_1a11bc125bce48b5c39c5fb4e1e7c241da>`;
		:ref:`tapi_trex_verbose_t<doxid-group__tapi__trex_1ga9865dca389a795841dd063597c2ff346>` :ref:`verbose<doxid-structtapi__trex__opt_1a94cda7e1dde5a1047905a73fc14d3217>`;
		:ref:`tapi_trex_iom_t<doxid-group__tapi__trex_1gaee6942210a6ded12eccf38e9ab4ab29e>` :ref:`iom<doxid-structtapi__trex__opt_1a2c61a08a2941b28497f44bf0a424e097>`;
		:ref:`tapi_trex_so_t<doxid-group__tapi__trex_1ga62f0ec3fe19f9c6d3a52ba5cba43caa5>` :ref:`so<doxid-structtapi__trex__opt_1a5ea549f158a3024746643e29c6a0c1bb>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`init_wait_sec<doxid-structtapi__trex__opt_1a7d2d07862b5afbd75744dfca511abcf1>`;
		const char* :ref:`instance_prefix<doxid-structtapi__trex__opt_1aa2137f2199a280f1566b07014ace8912>`;
		:ref:`tapi_trex_client_config<doxid-structtapi__trex__client__config>`** :ref:`clients<doxid-structtapi__trex__opt_1a905bef1afdab50373c08be43fc953ea0>`;
		:ref:`tapi_trex_server_config<doxid-structtapi__trex__server__config>`** :ref:`servers<doxid-structtapi__trex__opt_1ae11cbde0f1308c053283c7045d62647b>`;
		const char* :ref:`cfg_template<doxid-structtapi__trex__opt_1ae66f009c1f830571d38039e23f955030>`;
		const te_kvpair_h* :ref:`astf_vars<doxid-structtapi__trex__opt_1afbb6ac713c37f573b218f742fa4ea2ac>`;
		const char* :ref:`driver<doxid-structtapi__trex__opt_1abc4d33919cf3ff82ccd29672981a05a7>`;
		const char* :ref:`astf_template<doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273>`;
		const char* :ref:`trex_exec<doxid-structtapi__trex__opt_1ad38aee06b1a35b35b5a292da13885f58>`;
	};
.. _details-structtapi__trex__opt:

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

Specific TRex options.

Before starting tapi_trex it is necessary to initialize its options ``:ref:`tapi_trex_opt <doxid-structtapi__trex__opt>``` and call :ref:`tapi_trex_create() <doxid-group__tapi__trex_1gaee98b0df07576d461ae7973140d694af>` to create configuration files and properly bind PCI functions (if DPDK is used).

Base ``:ref:`tapi_trex_opt <doxid-structtapi__trex__opt>``` example:

.. ref-code-block:: cpp

	:ref:`tapi_trex_opt <doxid-structtapi__trex__opt>` trex_opt = :ref:`tapi_trex_default_opt <doxid-group__tapi__trex_1gab9472745ea02bde17db3d87282afc17a>`;
	
	trex_opt.:ref:`astf_template <doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273>` = getenv("TE_TREX_ASTF_TEMPLATE");
	trex_opt.:ref:`trex_exec <doxid-structtapi__trex__opt_1ad38aee06b1a35b35b5a292da13885f58>` = getenv("TE_TREX_EXEC");
	trex_opt.:ref:`force_close_at_end <doxid-structtapi__trex__opt_1a8b463b3b55ae69dd3fbbc4ae1790da05>` = true;
	trex_opt.:ref:`no_monitors <doxid-structtapi__trex__opt_1ae7f69404179c43eac6343635c854a5ce>` = true;
	trex_opt.:ref:`lro_disable <doxid-structtapi__trex__opt_1a82c6ad69acc3eb8b9e160a922a8233f6>` = true;
	
	// Setup servers
	trex_opt.:ref:`servers <doxid-structtapi__trex__opt_1ae11cbde0f1308c053283c7045d62647b>` = :ref:`TAPI_TREX_SERVERS <doxid-group__tapi__trex_1ga9830b1dfd263a7a3f892a27f83bfa278>`(
	   :ref:`TAPI_TREX_SERVER <doxid-group__tapi__trex_1ga77264926636621447d4ea480e7e95145>`(
	       .common.interface = :ref:`TAPI_TREX_PCI_BY_IFACE <doxid-group__tapi__trex_1gaa451198d8ebe96a2d68ebcf8fa72c5a7>`("Agt_A", "eth0"),
	       .common.ip = agtA_addr,
	       .common.gw = agtB_addr,
	       .common.ip_range_beg = agtA_addr,
	       .common.ip_range_end = agtA_addr,
	       .common.payload = "HTTP/1.1 200 OK\r\n"
	               "Content-Type: text/html\r\nConnection: keep-alive\r\n"
	               "Content-Length: 18\r\n\r\n<html>Hello</html>"
	));
	
	// Setup clients
	trex_opt.:ref:`clients <doxid-structtapi__trex__opt_1a905bef1afdab50373c08be43fc953ea0>` = ...;

Fields
------

.. index:: pair: variable; stdout_log_level
.. _doxid-structtapi__trex__opt_1ad87b9c80b0e1ecfb29de8ad1a45a5070:

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

	:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` stdout_log_level

Standard output logging level (default is ``TE_LL_RING``).

.. index:: pair: variable; stderr_log_level
.. _doxid-structtapi__trex__opt_1aee973882f37409b85b02ca5fc23ef5c4:

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

	:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` stderr_log_level

Standard error logging level (default is ``TE_LL_WARN``).

.. index:: pair: variable; astf_server_only
.. _doxid-structtapi__trex__opt_1ae7cf02e95644d17aa4acf6a227368bf6:

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

	bool astf_server_only

If set, only server side ports (e.g. ``1``, ``3`` and etc.) are enabled with ASTF service. Traffic won't be transmitted on clients ports.

.. index:: pair: variable; n_threads
.. _doxid-structtapi__trex__opt_1a0f4f359dea4ddd1c2138d08a2076393b:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` n_threads

Number of hardware threads to allocate for each port pair. Overrides the ``'c'`` argument from config file.

.. index:: pair: variable; tso_disable
.. _doxid-structtapi__trex__opt_1a6d17a836b68fc058b1c30975c50717b8:

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

	bool tso_disable

If set, disable TSO (advanced TCP mode).

.. index:: pair: variable; lro_disable
.. _doxid-structtapi__trex__opt_1a82c6ad69acc3eb8b9e160a922a8233f6:

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

	bool lro_disable

If set, disable LRO (advanced TCP mode).

.. index:: pair: variable; duration
.. _doxid-structtapi__trex__opt_1a576e639a90bf35a0e124774f4b8b4378:

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

	:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` duration

Duration of the test, in seconds.



.. rubric:: See also:

:ref:`tapi_trex_opt::force_close_at_end <doxid-structtapi__trex__opt_1a8b463b3b55ae69dd3fbbc4ae1790da05>` option.

.. index:: pair: variable; asymmetric_traffic_flow
.. _doxid-structtapi__trex__opt_1a3cead61a10302281f5c23f3effec036a:

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

	bool asymmetric_traffic_flow

If set, each flow will be sent both from client to server and server to client. It can achieve better port utilization when flow traffic is asymmetric.

.. index:: pair: variable; use_hdr_histograms
.. _doxid-structtapi__trex__opt_1aefc538120e15e844f0d4bb3ea55f4574:

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

	bool use_hdr_histograms

If set, report latency using high dynamic range histograms.

.. index:: pair: variable; ipv6
.. _doxid-structtapi__trex__opt_1add80906b27f3a677ba3aa7f5cfd7a471:

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

	bool ipv6

If set, work in IPv6 mode.

.. index:: pair: variable; rate_multiplier
.. _doxid-structtapi__trex__opt_1aa853075b07646c3faf24709db27c4ea3:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` rate_multiplier

Rate multiplier. Multiply basic rate of templates by this number.

.. index:: pair: variable; force_close_at_end
.. _doxid-structtapi__trex__opt_1a8b463b3b55ae69dd3fbbc4ae1790da05:

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

	bool force_close_at_end

If set, won't wait for all flows to be closed, before terminating.

.. index:: pair: variable; enable_flow_control
.. _doxid-structtapi__trex__opt_1a1455f891963f88c90c3be97a77b08720:

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

	bool enable_flow_control

If set, enable flow-control. By default TRex disables flow-control. If this option is given, it does not touch it

.. index:: pair: variable; no_watchdog
.. _doxid-structtapi__trex__opt_1a4c0071250121adcfc607cd1062d9f64b:

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

	bool no_watchdog

If set, disable watchdog.

.. index:: pair: variable; use_realtime_prio
.. _doxid-structtapi__trex__opt_1a56d665c370a3ffd6cbe540e55526eb3c:

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

	bool use_realtime_prio

If set, run TRex DP/RX cores in realtime priority.

.. index:: pair: variable; no_monitors
.. _doxid-structtapi__trex__opt_1ae7f69404179c43eac6343635c854a5ce:

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

	bool no_monitors

If set, disable monitors publishers.

.. index:: pair: variable; dont_resend_pkts
.. _doxid-structtapi__trex__opt_1a1efdc7dcfad01e11ae73f0e30e80ab8f:

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

	bool dont_resend_pkts

If set, don't retry to send packets on failure (queue full etc.).

.. index:: pair: variable; use_sleep
.. _doxid-structtapi__trex__opt_1a11bc125bce48b5c39c5fb4e1e7c241da:

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

	bool use_sleep

If set, use sleeps instead of busy wait in scheduler. Less accurate, more power saving.

.. index:: pair: variable; verbose
.. _doxid-structtapi__trex__opt_1a94cda7e1dde5a1047905a73fc14d3217:

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

	:ref:`tapi_trex_verbose_t<doxid-group__tapi__trex_1ga9865dca389a795841dd063597c2ff346>` verbose

The higher the value, print more debug information.

.. index:: pair: variable; iom
.. _doxid-structtapi__trex__opt_1a2c61a08a2941b28497f44bf0a424e097:

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

	:ref:`tapi_trex_iom_t<doxid-group__tapi__trex_1gaee6942210a6ded12eccf38e9ab4ab29e>` iom

IO mode for server output.

.. index:: pair: variable; so
.. _doxid-structtapi__trex__opt_1a5ea549f158a3024746643e29c6a0c1bb:

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

	:ref:`tapi_trex_so_t<doxid-group__tapi__trex_1ga62f0ec3fe19f9c6d3a52ba5cba43caa5>` so

Activate one of the \*-so options.

.. index:: pair: variable; init_wait_sec
.. _doxid-structtapi__trex__opt_1a7d2d07862b5afbd75744dfca511abcf1:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` init_wait_sec

Wait a few seconds between init of interfaces and sending traffic.

.. index:: pair: variable; instance_prefix
.. _doxid-structtapi__trex__opt_1aa2137f2199a280f1566b07014ace8912:

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

	const char* instance_prefix

For running multi TRex instances on the same machine. Each instance should have different name.

.. index:: pair: variable; clients
.. _doxid-structtapi__trex__opt_1a905bef1afdab50373c08be43fc953ea0:

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

	:ref:`tapi_trex_client_config<doxid-structtapi__trex__client__config>`** clients

TRex client configurations list. Like ``tapi_trex_client_config*`` []. Should end with ``NULL``.

.. index:: pair: variable; servers
.. _doxid-structtapi__trex__opt_1ae11cbde0f1308c053283c7045d62647b:

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

	:ref:`tapi_trex_server_config<doxid-structtapi__trex__server__config>`** servers

TRex server configurations list. Like ``tapi_trex_server_config*`` []. Should end with ``NULL``.

.. index:: pair: variable; cfg_template
.. _doxid-structtapi__trex__opt_1ae66f009c1f830571d38039e23f955030:

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

	const char* cfg_template

TRex configuration template.

If ``NULL``, the template from this example will be used:

.. ref-code-block:: cpp

	- port_limit      : ${#IFACES}\n"
	  version         : 2\n"
	  interfaces: [${IFACES[, ]}]\n"
	  port_info:\n"
	${PORTINFO_IP*    - ip${COLON} ${PORTINFO_IP[${}]}\n"
	      default_gw${COLON} ${PORTINFO_DEFAULT_GW[${}]}\n}"
	${PORTINFO_DST_MAC*    - dest_mac${COLON} ${PORTINFO_DST_MAC[${}]}\n"
	      src_mac${COLON} ${PORTINFO_SRC_MAC[${}]}\n}";

.. index:: pair: variable; astf_vars
.. _doxid-structtapi__trex__opt_1afbb6ac713c37f573b218f742fa4ea2ac:

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

	const te_kvpair_h* astf_vars

Extensions for ``:ref:`tapi_trex_opt::astf_template <doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273>```. You can replace some fields with TAPI TRex environment variables.

The following field names are currently reserved and it's not recommended to use them in this option:

* ``CLIENT_HTTP``

* ``SERVER_HTTP``

* ``CLIENT_IP_START``

* ``CLIENT_IP_START``

* ``CLIENT_IP_END``

* ``CLIENT_IP_OFFSET``

* ``SERVER_IP_START``

* ``SERVER_IP_END``

* ``SERVER_IP_OFFSET``

* ``CLIENT_IP_PORT``

* ``SERVER_IP_PORT``



.. rubric:: See also:

:ref:`tapi_trex_opt::astf_template <doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273>`

.. index:: pair: variable; driver
.. _doxid-structtapi__trex__opt_1abc4d33919cf3ff82ccd29672981a05a7:

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

	const char* driver

Driver name for DPDK binding. Should be ``NULL`` if interface is already bound.

.. index:: pair: variable; astf_template
.. _doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273:

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

	const char* astf_template

TRex ASTF template.

Now TAPI TRex supports only JSON profile templates. To create JSON profile template you need to use existing Python traffic profile and use this command to see JSON profile:

.. ref-code-block:: cpp

	./astf-sim -f <your_profile>.py --json

Example:

.. ref-code-block:: cpp

	./astf-sim -f astf/http_simple.py --json

Use this JSON profile to create TAPI TRex ASTF template (``:ref:`tapi_trex_opt::astf_template <doxid-structtapi__trex__opt_1ab856b5aee82a3a3300d22f6ee7017273>```). You can replace some fields with TAPI TRex environment variables using ``tapi_trex_opt::extensions``.

Fields usage see ``te_string_expand_kvpairs`` for more details.

Example of JSON profile template:

.. ref-code-block:: cpp

	{
	   "buf_list": [
	       "${CLIENT_HTTP[0]|base64uri}",
	       "${SERVER_HTTP[0]|base64uri}"
	   ],
	
	   "ip_gen_dist_list": [
	       {
	           "ip_start": "${CLIENT_IP_START[0]:-0.0.0.0}",
	           "ip_end": "${CLIENT_IP_END[0]:-0.0.0.0}",
	           "distribution": "seq",
	           "dir": "c",
	           "ip_offset": "${CLIENT_IP_OFFSET[0]:-0.0.0.0}"
	       },
	       {
	           "ip_start": "${SERVER_IP_START[0]:-0.0.0.0}",
	           "ip_end": "${SERVER_IP_END[0]:-0.0.0.0}",
	           "distribution": "seq",
	           "dir": "s",
	           "ip_offset": "${SERVER_IP_OFFSET[0]:-0.0.0.0}"
	       }
	   ],
	
	   "program_list": [
	       {
	           "commands": [
	               {
	                   "name": "connect"
	               },
	               {
	                   "name": "tx",
	                   "buf_index": 0
	               },
	               {
	                   "name": "rx",
	                   "min_bytes": 10
	               },
	               {
	                   "name": "delay",
	                   "usec": 1000
	               }
	           ]
	       },
	       {
	           "commands": [
	               {
	                   "name": "connect"
	               },
	               {
	                   "name": "rx",
	                   "min_bytes": 10
	               },
	               {
	                   "name": "tx",
	                   "buf_index": 1
	               }
	           ]
	       }
	   ],
	
	   "templates": [
	       {
	           "client_template": {
	               "program_index": 0,
	               "ip_gen": {
	
	                   "dist_client": {
	                       "index": 0
	                   },
	
	                   "dist_server": {
	                       "index": 1
	                   }
	               },
	
	               "cluster": {},
	               "port": ${CLIENT_IP_PORT[0]:-80},
	               "cps": 1
	           },
	
	           "server_template": {
	               "program_index": 1,
	               "assoc": [
	                   {
	                       "port": ${SERVER_IP_PORT[0]:-80}
	                   }
	               ]
	           }
	       }
	   ],
	
	   "tg_names": []
	}



.. rubric:: See also:

:ref:`tapi_trex_opt::astf_vars <doxid-structtapi__trex__opt_1afbb6ac713c37f573b218f742fa4ea2ac>`

.. index:: pair: variable; trex_exec
.. _doxid-structtapi__trex__opt_1ad38aee06b1a35b35b5a292da13885f58:

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

	const char* trex_exec

Full path to TRex exec (should not be ``NULL``). The directory with TRex exec should also contain ``"astf_schema.json"``.