Report 2005: Configure rls2005.39
[csit.git] / docs / report / introduction / methodology_trex_traffic_generator.rst
index 4d4de96..dfa496b 100644 (file)
@@ -4,30 +4,45 @@ TRex Traffic Generator
 Usage
 ~~~~~
 
 Usage
 ~~~~~
 
-`TRex traffic generator <https://wiki.fd.io/view/TRex>`_ is used for all
-CSIT performance tests. TRex stateless mode is used to measure NDR and
-PDR throughputs using binary search (NDR and PDR discovery tests) and
-for quick checks of DUT performance against the reference NDRs (NDR
-check tests) for specific configuration.
+`TRex traffic generator <https://trex-tgn.cisco.com>`_ is used for majority of
+CSIT performance tests. TRex stateless mode is used to measure NDR and PDR
+throughputs using MLRsearch and to measure maximum transfer rate in MRR tests.
 
 
-TRex is installed and run on the TG compute node. The typical procedure
-is:
+TRex is installed and run on the TG compute node. The typical procedure is:
 
 
-- If the TRex is not already installed on TG, it is installed in the
-  suite setup phase - see `TRex intallation`_.
 - TRex configuration is set in its configuration file
 - TRex configuration is set in its configuration file
+
   ::
 
   ::
 
-  /etc/trex_cfg.yaml
+      $ sudo -E -S sh -c 'cat << EOF > /etc/trex_cfg.yaml
+      - version: 2
+        c: 15
+        limit_memory: 8192
+        interfaces: ["${pci1}","${pci2}"]
+        port_info:
+          - dest_mac: [${dest_mac1}]
+            src_mac: [${src_mac1}]
+          - dest_mac: [${dest_mac2}]
+            src_mac: [${src_mac2}]
+        platform :
+          master_thread_id: 0
+          latency_thread_id: 16
+          dual_if:
+              - socket: 0
+                threads: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
+      EOF'
+
+- TRex is started in the interactive mode as a background service
 
 
-- TRex is started in the background mode
   ::
 
   ::
 
-  $ sh -c 'cd <t-rex-install-dir>/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /tmp/trex.log 2>&1 &' > /dev/null
+      $ sh -c 'cd <t-rex-install-dir>/scripts/ && \
+        sudo nohup ./t-rex-64 -i --prefix $(hostname) --hdrh --no-scapy-server \
+        > /tmp/trex.log 2>&1 &' > /dev/null
 
 - There are traffic streams dynamically prepared for each test, based on traffic
 
 - There are traffic streams dynamically prepared for each test, based on traffic
-  profiles. The traffic is sent and the statistics obtained using
-  :command:`trex_stl_lib.api.STLClient`.
+  profiles. The traffic is sent and the statistics obtained using API
+  :command:`trex.stl.api.STLClient`.
 
 Measuring Packet Loss
 ~~~~~~~~~~~~~~~~~~~~~
 
 Measuring Packet Loss
 ~~~~~~~~~~~~~~~~~~~~~
@@ -50,4 +65,4 @@ Measuring Latency
 If measurement of latency is requested, two more packet streams are
 created (one for each direction) with TRex flow_stats parameter set to
 STLFlowLatencyStats. In that case, returned statistics will also include
 If measurement of latency is requested, two more packet streams are
 created (one for each direction) with TRex flow_stats parameter set to
 STLFlowLatencyStats. In that case, returned statistics will also include
-min/avg/max latency values.
+min/avg/max latency values and encoded HDRHistogram data.