Skip to content

s5uishida/install_trex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 

Repository files navigation

Install TRex

This is a simple description of the procedure to install the traffic generator TRex. The detailed documentation for TRex can be found here. This is intended as a preparation for measuring the performance of open source UPFs.



Table of Contents


Simple Overview of TRex and DUT (UPF)

This describes a simple configuration of TRex and DUT (UPF). Note that this configuration is implemented with Proxmox VE VMs.

The following minimum configuration was set as a condition.

  • One TRex and DUT (UPF)

The built simulation environment is as follows.

The TRex used is as follows.

Each VMs are as follows.

VM SW & Role IP address OS CPU
(Min)
Mem
(Min)
HDD
(Min)
VM-TG TRex
Traffic Generator
192.168.0.131/24 Ubuntu 22.04 3 8GB 20GB
VM-DUT each UPF DUT
(Device Under Test)
192.168.0.151/24 Ubuntu 24.04
or 22.04
2 8GB 20GB

The network interfaces of each VM are as follows.

VM Device Model Linux Bridge IP address Interface Under
DPDK
VM-TG ens18 VirtIO vmbr1 10.0.0.131/24 (NAPT NW) --
ens19 VirtIO mgbr0 192.168.0.131/24 (Mgmt NW) --
ens20 VirtIO vmbr3 192.168.13.131/24 N3 x
ens21 VirtIO vmbr6 192.168.16.152/24 N6
(default GW for VM-DUT)
x
VM-DUT ens18 VirtIO vmbr1 10.0.0.151/24 (NAPT NW) down --
ens19 VirtIO mgbr0 192.168.0.151/24 (Mgmt NW) --
ens20 VirtIO vmbr3 192.168.13.151/24 N3 --
ens21 VirtIO vmbr4 192.168.14.151/24 N4 --
ens22 VirtIO vmbr6 192.168.16.151/24 N6 --

Linux Bridges of Proxmox VE are as follows.

Linux Bridge Network CIDR Interface
vmbr1 10.0.0.0/24 NAPT NW
mgbr0 192.168.0.0/24 Mgmt NW
vmbr3 192.168.13.0/24 N3
vmbr4 192.168.14.0/24 N4
vmbr6 192.168.16.0/24 N6

UE IP address and TEID are as follows.

UE IP address TEID
10.45.0.2/24 0x0000001

Install TRex

Please refer to the following for installing TRex.

Install required packages

# apt install python3 python3-pip
# pip3 install scapy-python3

Install TRex

This section explains how to install v3.06 to /opt/trex directory.

First, download v3.06 and extract it to the specified directory.

# cd /opt
# wget --no-check-certificate https://trex-tgn.cisco.com/trex/release/v3.06.tar.gz
# tar xfvz v3.06.tar.gz 
# mv v3.06 trex

Then fix a bug in dpdk_setup_ports.py script when mounting hugepages.

# cd /opt
# wget https://github.com/cisco-system-traffic-generator/trex-core/commit/d7c4e407b926db6f26736a4db6932c691cfaf80a.diff
# cd trex
# patch  < ../d7c4e407b926db6f26736a4db6932c691cfaf80a.diff

Setup TRex

Check network devices and bus information

First, check the network devices and bus information of the installation machine.

# lshw -c network -businfo
Bus info          Device      Class      Description
====================================================
pci@0000:00:12.0              network    Virtio network device
virtio@1          ens18       network    Ethernet interface
pci@0000:00:13.0              network    Virtio network device
virtio@2          ens19       network    Ethernet interface
pci@0000:00:14.0              network    Virtio network device
virtio@3          ens20       network    Ethernet interface
pci@0000:00:15.0              network    Virtio network device
virtio@4          ens21       network    Ethernet interface

In my environment, based on this information, configure pci@0000:00:14.0 of ens20(N3) and pci@0000:00:15.0 of ens21(N6).

Create configuration file

Use the following dpdk_setup_ports.py script to create /etc/trex_cfg.yaml with the IP settings for the ports used by DPDK.

# cd /opt/trex
# ./dpdk_setup_ports.py -i
...

I edited this file created as follows.

/etc/trex_cfg.yaml

### Config file generated by dpdk_setup_ports.py ###

- version: 2
  interfaces: ['00:14.0', '00:15.0']
  port_info:
      - ip: 192.168.13.131
      - ip: 192.168.16.152

  platform:
      master_thread_id: 0
      latency_thread_id: 1
      dual_if:
        - socket: 0
          threads: [2]

Create load profile

I am using the following for the TRex load profile. Also, the payload size is set to 1400 bytes.

/opt/trex/stl/gtp_1pkt_simple.py

from trex_stl_lib.api import *
from scapy.contrib.gtp import GTP_U_Header
import argparse

class STLS1(object):

    def create_stream (self):
        return STLStream(
            packet =
                    STLPktBuilder(
                        pkt = Ether()/IP(src="192.168.13.131",dst="192.168.13.151")/
                                UDP(dport=2152,sport=2152)/
                                GTP_U_Header(teid=0x0000001)/
                                IP(src="10.45.0.2",dst="192.168.16.152",version=4)/
                                UDP()/
                                (1400*'x')
                    ),
             mode = STLTXCont())

    def get_streams (self, tunables, **kwargs):
        parser = argparse.ArgumentParser(description='Argparser for {}'.format(os.path.basename(__file__)),
                                         formatter_class=argparse.ArgumentDefaultsHelpFormatter)
        args = parser.parse_args(tunables)
        # create 1 stream
        return [ self.create_stream() ]

def register():
    return STLS1()

Set kernel parameter

Set vm.nr_hugepages to 2048.

# sysctl vm.nr_hugepages=2048

Run TRex

Please configure and start the DUT (UPF in my environment) in advance.
For information on how to use the TRex console, see here.

First, start the TRex server.

# cd /opt/trex
# ./t-rex-64 -i

Then, open another console and apply traffic to the DUT. In the following example, use the load profile gtp_1pkt_simple.py to apply GTP-U traffic to the DUT at 150 Kpps for 60 seconds.

# cd /opt/trex
# ./trex-console
...
trex>start -f stl/gtp_1pkt_simple.py -p 0 -m 150kpps -d 60

To check the traffic statistics, type tui in the TRex console to switch the view.

trex>tui

Below are some sample statistics. According to this, 489.02 Mbps of 1.78 Gbps was dropped, and 1.29 Gbps was received.

Global Statistics

connection   : localhost, Port 4501                       total_tx_L2  : 1.78 Gbps  
version      : STL @ v3.06                                total_tx_L1  : 1.8 Gbps   
cpu_util.    : 1.43% @ 1 cores (1 per dual port)          total_rx     : 1.29 Gbps  
rx_cpu_util. : 0.17% / 111.47 Kpps                        total_pps    : 150.01 Kpps
async_util.  : 0% / 6.45 bps                              drop_rate    : 489.02 Mbps
total_cps.   : 0 cps                                      queue_full   : 33,524 pkts

Port Statistics

   port    |         0         |         1         |       total       
-----------+-------------------+-------------------+------------------
owner      |              root |              root |                   
link       |                UP |                UP |                   
state      |      TRANSMITTING |              IDLE |                   
speed      |          200 Gb/s |          200 Gb/s |                   
CPU util.  |             1.43% |              0.0% |                   
--         |                   |                   |                   
Tx bps L2  |         1.78 Gbps |             0 bps |         1.78 Gbps 
Tx bps L1  |          1.8 Gbps |             0 bps |          1.8 Gbps 
Tx pps     |       150.01 Kpps |             0 pps |       150.01 Kpps 
Line Util. |             0.9 % |               0 % |                   
---        |                   |                   |                   
Rx bps     |             0 bps |         1.29 Gbps |         1.29 Gbps 
Rx pps     |             0 pps |       111.47 Kpps |       111.47 Kpps 
----       |                   |                   |                   
opackets   |          32201768 |                 0 |          32201768 
ipackets   |                 0 |          23902477 |          23902477 
obytes     |       47723020176 |                 0 |       47723020176 
ibytes     |                 0 |       34562981742 |       34562981742 
tx-pkts    |        32.2 Mpkts |            0 pkts |        32.2 Mpkts 
rx-pkts    |            0 pkts |        23.9 Mpkts |        23.9 Mpkts 
tx-bytes   |          47.72 GB |               0 B |          47.72 GB 
rx-bytes   |               0 B |          34.56 GB |          34.56 GB 
-----      |                   |                   |                   
oerrors    |                 0 |                 0 |                 0 
ierrors    |                 0 |                 0 |                 0 

status:  /

Press 'ESC' for navigation panel...
status: 

tui>

With the above steps, TRex has been constructed. Although the settings differ for each UPF, I believe this has made some progress in preparing to measure open source UPFs performance using TRex. I would like to thank the excellent developers and all the contributors of TRex.

Sample Configurations

Changelog (summary)

  • [2024.11.03] Initial release.