16185b4c051f62310f35cb057244e5cf6d6a631a
[csit.git] / docs / report / introduction / methodology_vpp_startup_settings.rst
1 VPP Startup Settings
2 --------------------
3
4 CSIT code manipulates a number of VPP settings in startup.conf for optimized
5 performance. List of common settings applied to all tests and test
6 dependent settings follows.
7
8 See `VPP startup.conf`_
9 for a complete set and description of listed settings.
10
11 Common Settings
12 ~~~~~~~~~~~~~~~
13
14 List of vpp startup.conf settings applied to all tests:
15
16 #. heap-size <value> - set separately for ip4, ip6, stats, main
17    depending on scale tested.
18 #. no-tx-checksum-offload - disables UDP / TCP TX checksum offload in DPDK.
19    Typically needed for use faster vector PMDs (together with
20    no-multi-seg).
21 #. socket-mem <value>,<value> - memory per numa. (Not required anymore
22    due to VPP code changes, should be removed in CSIT-18.10.)
23
24 Per Test Settings
25 ~~~~~~~~~~~~~~~~~
26
27 List of vpp startup.conf settings applied dynamically per test:
28
29 #. corelist-workers <list_of_cores> - list of logical cores to run VPP
30    worker data plane threads. Depends on HyperThreading and core per
31    test configuration.
32 #. num-rx-queues <value> - depends on a number of VPP threads and NIC
33    interfaces.
34 #. num-rx-desc/num-tx-desc - number of rx/tx descriptors for specific
35    NICs, incl. xl710, x710, xxv710.
36 #. num-mbufs <value> - increases number of buffers allocated, needed
37    only in scenarios with large number of interfaces and worker threads.
38    Value is per CPU socket. Default is 16384.
39 #. no-multi-seg - disables multi-segment buffers in DPDK, improves
40    packet throughput, but disables Jumbo MTU support. Disabled for all
41    tests apart from the ones that require Jumbo 9000B frame support.
42 #. UIO driver - depends on topology file definition.
43 #. QAT VFs - depends on NRThreads, each thread = 1QAT VFs.