fix(perf): Fix missing UDP iperf title in performance guide

Signed-off-by: Meghana Malladi <[email protected]>

Author: MeghanaMalladiTI

source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst

@@ -73,12 +73,12 @@ The latencies observed with this DK are summarized below:
 
 LMBench
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-LMBench is a collection of microbenchmarks of which the memory bandwidth 
-and latency related ones are typically used to estimate processor 
-memory system performance. More information about lmbench at 
+LMBench is a collection of microbenchmarks of which the memory bandwidth
+and latency related ones are typically used to estimate processor
+memory system performance. More information about lmbench at
 https://lmbench.sourceforge.net/whatis_lmbench.html and
 https://lmbench.sourceforge.net/man/lmbench.8.html
-  
+
 **Latency**: lat_mem_rd-stride128-szN, where N is equal to or smaller than the cache
 size at given level measures the cache miss penalty. N that is at least
 double the size of last level cache is the latency to external memory.
@@ -249,10 +249,10 @@ solving a dense linear system.
 Stream
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 STREAM is a microbenchmark for measuring data memory system performance without
-any data reuse. It is designed to miss on caches and exercise data prefetcher 
+any data reuse. It is designed to miss on caches and exercise data prefetcher
 and speculative accesses.
 It uses double precision floating point (64bit) but in
-most modern processors the memory access will be the bottleneck. 
+most modern processors the memory access will be the bottleneck.
 The four individual scores are copy, scale as in multiply by constant,
 add two numbers, and triad for multiply accumulate.
 For bandwidth, a byte read counts as one and a byte written counts as one,
@@ -370,39 +370,39 @@ Ethernet
 -----------------
 Ethernet performance benchmarks were measured using Netperf 2.7.1 https://hewlettpackard.github.io/netperf/doc/netperf.html
 Test procedures were modeled after those defined in RFC-2544:
-https://tools.ietf.org/html/rfc2544, where the DUT is the TI device 
+https://tools.ietf.org/html/rfc2544, where the DUT is the TI device
 and the "tester" used was a Linux PC. To produce consistent results,
-it is recommended to carry out performance tests in a private network and to avoid 
-running NFS on the same interface used in the test. In these results, 
+it is recommended to carry out performance tests in a private network and to avoid
+running NFS on the same interface used in the test. In these results,
 CPU utilization was captured as the total percentage used across all cores on the device,
-while running the performance test over one external interface.  
+while running the performance test over one external interface.
 
 UDP Throughput (0% loss) was measured by the procedure defined in RFC-2544 section 26.1: Throughput.
 In this scenario, netperf options burst_size (-b) and wait_time (-w) are used to limit bandwidth
-during different trials of the test, with the goal of finding the highest rate at which 
+during different trials of the test, with the goal of finding the highest rate at which
 no loss is seen. For example, to limit bandwidth to 500Mbits/sec with 1472B datagram:
 
 ::
 
    burst_size = <bandwidth (bits/sec)> / 8 (bits -> bytes) / <UDP datagram size> / 100 (seconds -> 10 ms)
-   burst_size = 500000000 / 8 / 1472 / 100 = 425 
+   burst_size = 500000000 / 8 / 1472 / 100 = 425
 
    wait_time = 10 milliseconds (minimum supported by Linux PC used for testing)
 
 UDP Throughput (possible loss) was measured by capturing throughput and packet loss statistics when
-running the netperf test with no bandwidth limit (remove -b/-w options). 
+running the netperf test with no bandwidth limit (remove -b/-w options).
 
 In order to start a netperf client on one device, the other device must have netserver running.
 To start netserver:
 
 ::
 
    netserver [-p <port_number>] [-4 (IPv4 addressing)] [-6 (IPv6 addressing)]
- 
-Running the following shell script from the DUT will trigger netperf clients to measure 
+
+Running the following shell script from the DUT will trigger netperf clients to measure
 bidirectional TCP performance for 60 seconds and report CPU utilization. Parameter -k is used in
-client commands to summarize selected statistics on their own line and -j is used to gain 
-additional timing measurements during the test.  
+client commands to summarize selected statistics on their own line and -j is used to gain
+additional timing measurements during the test.
 
 ::
 
@@ -411,45 +411,45 @@ additional timing measurements during the test.
    do
       netperf -H <tester ip> -j -c -l 60 -t TCP_STREAM --
          -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE &
-      
+
       netperf -H <tester ip> -j -c -l 60 -t TCP_MAERTS --
          -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE &
    done
 
-Running the following commands will trigger netperf clients to measure UDP burst performance for 
-60 seconds at various burst/datagram sizes and report CPU utilization. 
+Running the following commands will trigger netperf clients to measure UDP burst performance for
+60 seconds at various burst/datagram sizes and report CPU utilization.
 
 - For UDP egress tests, run netperf client from DUT and start netserver on tester.
 
 ::
 
-   netperf -H <tester ip> -j -c -l 60 -t UDP_STREAM -b <burst_size> -w <wait_time> -- -m <UDP datagram size> 
-      -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE 
+   netperf -H <tester ip> -j -c -l 60 -t UDP_STREAM -b <burst_size> -w <wait_time> -- -m <UDP datagram size>
+      -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE
 
-- For UDP ingress tests, run netperf client from tester and start netserver on DUT. 
+- For UDP ingress tests, run netperf client from tester and start netserver on DUT.
 
 ::
 
    netperf -H <DUT ip> -j -C -l 60 -t UDP_STREAM -b <burst_size> -w <wait_time> -- -m <UDP datagram size>
-      -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE 
+      -k DIRECTION,THROUGHPUT,MEAN_LATENCY,LOCAL_CPU_UTIL,REMOTE_CPU_UTIL,LOCAL_BYTES_SENT,REMOTE_BYTES_RECVD,LOCAL_SEND_SIZE
 
-CPSW/CPSW2g/CPSW3g Ethernet Driver 
+CPSW/CPSW2g/CPSW3g Ethernet Driver
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - CPSW3g: AM64x
 
-.. rubric::  TCP Bidirectional Throughput 
+.. rubric::  TCP Bidirectional Throughput
    :name: CPSW2g-tcp-bidirectional-throughput
 
 .. csv-table:: CPSW2g TCP Bidirectional Throughput
     :header: "Command Used","am64xx-hsevm: THROUGHPUT (Mbits/sec)","am64xx-hsevm: CPU Load % (LOCAL_CPU_UTIL)"
 
     "netperf -H 192.168.0.1 -j -c -C -l 60 -t TCP_STREAM; netperf -H 192.168.0.1 -j -c -C -l 60 -t TCP_MAERTS","1095.34","98.12"
 
-ICSSG Ethernet Driver 
+ICSSG Ethernet Driver
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric::  TCP Bidirectional Throughput 
+.. rubric::  TCP Bidirectional Throughput
    :name: tcp-bidirectional-throughput
 
 .. csv-table:: ICSSG TCP Bidirectional Throughput
@@ -465,6 +465,9 @@ ICSSG Ethernet Driver
 
     "netperf -H 192.168.2.1 -j -c -C -l 60 -t TCP_STREAM; netperf -H 192.168.2.1 -j -c -C -l 60 -t TCP_MAERTS","359.51","53.51"
 
+.. rubric::  UDP Ingress Throughput
+   :name: ICSSG-udp-ingress-throughput
+
 .. csv-table:: ICSSG UDP Ingress Throughput 0 loss
     :header: "Frame Size(bytes)","am64xx-hsevm: UDP Datagram Size(bytes) (LOCAL_SEND_SIZE)","am64xx-hsevm: THROUGHPUT (Mbits/sec)","am64xx-hsevm: Packets Per Second (kPPS)","am64xx-hsevm: CPU Load %"