1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2023 Intel Corporation.
dpdk-test-dma-perf Application
==============================
The ``dpdk-test-dma-perf`` tool is a Data Plane Development Kit (DPDK) application
that evaluates the performance of DMA (Direct Memory Access) devices accessible in DPDK environment.
It provides a benchmark framework to assess the performance
of CPU and DMA devices under various combinations,
such as varying buffer lengths, scatter-gather copy, copying in remote memory etc.
It helps in evaluating performance of DMA device as hardware acceleration vehicle
in DPDK application.
In addition, this tool supports memory-to-memory, memory-to-device and device-to-memory copy tests,
to compare the performance of CPU and DMA capabilities under various conditions
with the help of a pre-set configuration file.
Configuration
-------------
Along with EAL command-line arguments, this application supports
various parameters for the benchmarking through a configuration file.
An example configuration file is provided below
along with the application to demonstrate all the parameters.
.. code-block:: ini
[case1]
type=DMA_MEM_COPY
mem_size=10
buf_size=64,8192,2,MUL
dma_ring_size=1024
kick_batch=32
src_numa_node=0
dst_numa_node=0
cache_flush=0
test_seconds=2
lcore_dma0=lcore=10,dev=0000:00:04.2,dir=mem2mem
lcore_dma0=lcore=11,dev=0000:00:04.3,dir=mem2mem
eal_args=--in-memory --file-prefix=test
[case2]
type=CPU_MEM_COPY
mem_size=10
buf_size=64,8192,2,MUL
src_numa_node=0
dst_numa_node=1
cache_flush=0
test_seconds=2
lcore = 3, 4
eal_args=--in-memory --no-pci
[case3]
skip=1
type=DMA_MEM_COPY
dma_src_sge=4
dma_dst_sge=1
mem_size=10
buf_size=64,8192,2,MUL
dma_ring_size=1024
kick_batch=32
src_numa_node=0
dst_numa_node=0
cache_flush=0
test_seconds=2
lcore_dma0=lcore=10,dev=0000:00:04.1,dir=mem2mem
lcore_dma1=lcore=11,dev=0000:00:04.2,dir=dev2mem,raddr=0x200000000,coreid=1,pfid=2,vfid=3
lcore_dma2=lcore=12,dev=0000:00:04.3,dir=mem2dev,raddr=0x200000000,coreid=1,pfid=2,vfid=3
eal_args=--in-memory --file-prefix=test
The configuration file is divided into multiple sections, each section represents a test case.
The four mandatory variables ``mem_size``, ``buf_size``, ``dma_ring_size``, and ``kick_batch``
can vary in each test case.
The format for this is ``variable=first,last,increment,ADD|MUL``.
This means that the first value of the variable is ``first``,
the last value is ``last``, ``increment`` is the step size,
and ``ADD|MUL`` indicates whether the change is by addition or multiplication.
The variables for mem2dev and dev2mem copy are
``dir``, ``dev``, ``lcore``, ``coreid``, ``pfid``, ``vfid``, ``raddr``
and can vary for each device.
For scatter-gather copy test ``dma_src_sge``, ``dma_dst_sge`` must be configured.
Each case can only have one variable change,
and each change will generate a scenario, so each case can have multiple scenarios.
Configuration Parameters
~~~~~~~~~~~~~~~~~~~~~~~~
``skip``
To skip a test-case, must be configured as ``1``
``type``
The type of the test.
Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.
``dma_src_sge``
Number of source segments for scatter-gather.
``dma_dst_sge``
Number of destination segments for scatter-gather.
``mem_size``
The size of the memory footprint in megabytes (MB) for source and destination.
``buf_size``
The memory size of a single operation in bytes (B).
``dma_ring_size``
The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.
``kick_batch``
The DMA operation batch size, should be greater than ``1`` normally.
``src_numa_node``
Controls the NUMA node where the source memory is allocated.
``dst_numa_node``
Controls the NUMA node where the destination memory is allocated.
``cache_flush``
Determines whether the cache should be flushed.
``1`` indicates to flush and ``0`` to not flush.
``test_seconds``
Controls the test time for each scenario.
``lcore_dma``
Specifies the lcore/DMA mapping and per device specific config.
* ``lcore``
Core number mapped to a DMA device.
* ``dir``
The direction of data transfer.
Currently supported directions:
* ``mem2mem`` - memory to memory copy
* ``mem2dev`` - memory to device copy
* ``dev2mem`` - device to memory copy
* ``dev``
DMA device bus address.
* ``raddr``
Remote machine address for ``mem2dev`` and ``dev2mem`` copy.
* ``coreid``
Denotes PCIe core index for ``mem2dev`` and ``dev2mem`` copy.
* ``pfid``
Denotes PF-id to be used for ``mem2dev`` and ``dev2mem`` copy.
* ``vfid``
Denotes VF-id of PF-id to be used for ``mem2dev`` and ``dev2mem`` copy.
.. note::
The mapping of lcore to DMA must be one-to-one and cannot be duplicated.
``lcore``
Specifies the lcore for CPU testing.
``eal_args``
Specifies the EAL arguments.
Running the Application
-----------------------
Typical command-line invocation to execute the application:
.. code-block:: console
dpdk-test-dma-perf --config ./config_dma.ini --result ./res_dma.csv
Where ``config_dma.ini`` is the configuration file,
and ``res_dma.csv`` will be the generated result file.
If no result file is specified, the test results are found in a file
with the same name as the configuration file with the addition of ``_result.csv`` at the end.
Limitations
-----------
Additional enhancements are possible in the future.
|
