1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Intel Corporation
4 dpdk-test-bbdev Application
5 ===========================
7 The ``dpdk-test-bbdev`` tool is a Data Plane Development Kit (DPDK) utility that
8 allows measuring performance parameters of PMDs available in the bbdev framework.
9 Available tests available for execution are: latency, throughput, validation and
10 sanity tests. Execution of tests can be customized using various parameters
11 passed to a python running script.
13 Compiling the Application
14 -------------------------
16 **Step 1: PMD setting**
18 The ``dpdk-test-bbdev`` tool depends on crypto device drivers PMD which
19 are disabled by default in the build configuration file ``common_base``.
20 The bbdevice drivers PMD which should be tested can be enabled by setting
22 ``CONFIG_RTE_LIBRTE_PMD_<name>=y``
24 Setting example for (*turbo_sw*) PMD
26 ``CONFIG_RTE_LIBRTE_PMD_BBDEV_TURBO_SW=y``
28 **Step 2: Build the application**
30 Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
31 ``dpdk-test-bbdev`` application.
33 Initially, the user must select a DPDK target to choose the correct target type
34 and compiler options to use when building the libraries.
35 The user must have all libraries, modules, updates and compilers installed
36 in the system prior to this, as described in the earlier chapters in this
37 Getting Started Guide.
39 Running the Application
40 -----------------------
42 The tool application has a number of command line options:
44 .. code-block:: console
46 python test-bbdev.py [-h] [-p TESTAPP_PATH] [-e EAL_PARAMS] [-t TIMEOUT]
47 [-c TEST_CASE [TEST_CASE ...]]
48 [-v TEST_VECTOR [TEST_VECTOR...]] [-n NUM_OPS]
49 [-b BURST_SIZE [BURST_SIZE ...]] [-l NUM_LCORES]
54 The following are the command-line options:
57 Shows help message and exit.
59 ``-p TESTAPP_PATH, --testapp_path TESTAPP_PATH``
60 Indicates the path to the bbdev test app. If not specified path is set based
61 on *$RTE_SDK* environment variable concatenated with "*/build/app/testbbdev*".
63 ``-e EAL_PARAMS, --eal_params EAL_PARAMS``
64 Specifies EAL arguments which are passed to the test app. For more details,
65 refer to DPDK documentation at http://dpdk.org/doc.
67 ``-t TIMEOUT, --timeout TIMEOUT``
68 Specifies timeout in seconds. If not specified timeout is set to 300 seconds.
70 ``-c TEST_CASE [TEST_CASE ...], --test_cases TEST_CASE [TEST_CASE ...]``
71 Defines test cases to run. If not specified all available tests are run.
73 The following tests can be run:
76 Small unit tests witch check basic functionality of bbdev library.
78 Test calculates three latency metrics:
81 measures the cost of offloading enqueue and dequeue operations.
82 * offload_latency_empty_q_tc
83 measures the cost of offloading a dequeue operation from an empty queue.
84 checks how long last dequeueing if there is no operations to dequeue
85 * operation_latency_tc
86 measures the time difference from the first attempt to enqueue till the
87 first successful dequeue.
89 Test do enqueue on given vector and compare output after dequeueing.
91 Test measures the achieved throughput on the available lcores.
92 Results are printed in million operations per second and million bits per second.
94 The same test as 'throughput' but uses interrupts instead of PMD to perform
99 ``./test-bbdev.py -c validation``
100 Runs validation test suite
102 ``./test-bbdev.py -c latency throughput``
103 Runs latency and throughput test suites
105 ``-v TEST_VECTOR [TEST_VECTOR ...], --test_vector TEST_VECTOR [TEST_VECTOR ...]``
106 Specifies paths to the test vector files. If not specified path is set based
107 on *$RTE_SDK* environment variable concatenated with
108 "*/app/test-bbdev/test_vectors/bbdev_vector_null.data*" and indicates default
113 ``./test-bbdev.py -v app/test-bbdev/test_vectors/bbdev_vector_td_test1.data``
114 Fills vector based on bbdev_vector_td_test1.data file and runs all tests
116 ``./test-bbdev.py -v bbdev_vector_td_test1.data bbdev_vector_te_test2.data``
117 The bbdev test app is executed twice. First time vector is filled based on
118 *bbdev_vector_td_test1.data* file and second time based on
119 *bbdev_vector_te_test2.data* file. For both executions all tests are run.
121 ``-n NUM_OPS, --num_ops NUM_OPS``
122 Specifies number of operations to process on device. If not specified num_ops
123 is set to 32 operations.
125 ``-l NUM_LCORES, --num_lcores NUM_LCORES``
126 Specifies number of lcores to run. If not specified num_lcores is set
127 according to value from RTE configuration (EAL coremask)
129 ``-b BURST_SIZE [BURST_SIZE ...], --burst-size BURST_SIZE [BURST_SIZE ...]``
130 Specifies operations enqueue/dequeue burst size. If not specified burst_size is
131 set to 32. Maximum is 512.
137 Thanks to the globbing functionality in python test-bbdev.py script allows to
138 run tests with different set of vector files without giving all of them explicitly.
142 .. code-block:: console
144 ./test-bbdev.py -v app/test-bbdev/test_vectors/bbdev_vector_*.data
146 It runs all tests with following vectors:
148 - ``bbdev_vector_null.data``
150 - ``bbdev_vector_td_default.data``
152 - ``bbdev_vector_te_default.data``
155 .. code-block:: console
157 ./test-bbdev.py -v app/test-bbdev/test_vectors/bbdev_vector_t?_default.data
159 It runs all tests with "default" vectors:
161 - ``bbdev_vector_te_default.data``
163 - ``bbdev_vector_td_default.data``
169 Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled for
170 x86_64-native-linuxapp-icc target:
177 |-- bbdev_vector_null.data
178 |-- bbdev_vector_td_default.data
179 |-- bbdev_vector_te_default.data
181 |-- x86_64-native-linuxapp-icc
188 .. code-block:: console
190 ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
191 -v ./test_vectors/bbdev_vector_td_default.data
193 It runs all available tests using the test vector filled based on
194 *bbdev_vector_td_default.data* file.
195 By default number of operations to process on device is set to 32, timeout is
196 set to 300s and operations enqueue/dequeue burst size is set to 32.
197 Moreover a bbdev (*bbdev_null*) device will be created.
199 bbdev turbo_sw device
200 ~~~~~~~~~~~~~~~~~~~~~
202 .. code-block:: console
204 ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
205 -e="--vdev=turbo_sw" -t 120 -c validation
206 -v ./test_vectors/bbdev_vector_t?_default.data -n 64 -b 8 32
208 It runs **validation** test for each vector file that matches the given pattern.
209 Number of operations to process on device is set to 64 and operations timeout is
210 set to 120s and enqueue/dequeue burst size is set to 8 and to 32.
211 Moreover a bbdev (*turbo_sw*) device will be created.
217 Executing bbdev null device with *bbdev_vector_null.data* helps in measuring the
218 overhead introduced by the bbdev framework.
220 .. code-block:: console
222 ./test-bbdev.py -e="--vdev=bbdev_null0"
223 -v ./test_vectors/bbdev_vector_null.data
227 bbdev_null device does not have to be defined explicitly as it is created by default.
234 Test Vector files contain the data which is used to set turbo decoder/encoder
235 parameters and buffers for validation purpose. New test vector files should be
236 stored in ``app/test-bbdev/test_vectors/`` directory. Detailed description of
237 the syntax of the test vector files is in the following section.
240 Basic principles for test vector files
241 --------------------------------------
242 Line started with ``#`` is treated as a comment and is ignored.
244 If variable is a chain of values, values should be separated by a comma. If
245 assignment is split into several lines, each line (except the last one) has to
246 be ended with a comma.
247 There is no comma after last value in last line. Correct assignment should
248 look like the following:
253 value, value, value, value,
256 In case where variable is a single value correct assignment looks like the
264 Length of chain variable is calculated by parser. Can not be defined
267 Variable op_type has to be defined as a first variable in file. It specifies
268 what type of operations will be executed. For decoder op_type has to be set to
269 ``RTE_BBDEV_OP_TURBO_DEC`` and for encoder to ``RTE_BBDEV_OP_TURBO_ENC``.
271 Full details of the meaning and valid values for the below fields are
272 documented in *rte_bbdev_op.h*
275 Turbo decoder test vectors template
276 -----------------------------------
278 For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC``
283 RTE_BBDEV_OP_TURBO_DEC
285 Chain of uint32_t values. Note that it is possible to define more than one
286 input/output entries which will result in chaining two or more data structures
287 for *segmented Transport Blocks*
292 0x00000000, 0x7f817f00, 0x7f7f8100, 0x817f8100, 0x81008100, 0x7f818100, 0x81817f00, 0x7f818100,
293 0x81007f00, 0x7f818100, 0x817f8100, 0x81817f00, 0x81008100, 0x817f7f00, 0x7f7f8100, 0x81817f00
295 Chain of uint32_t values
300 0x7f7f0000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
301 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
303 Chain of uint32_t values
308 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
309 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
311 Chain of uint32_t values
318 Chain of uint32_t values
325 Chain of uint32_t values
330 0x817f817f, 0x7f817f7f, 0x81818181, 0x817f7f81, 0x7f818181, 0x8181817f, 0x817f817f, 0x8181817f
332 Chain of uint32_t values
337 0x817f7f81, 0x7f7f7f81, 0x7f7f8181
378 expected_iter_count =
395 Chain of flags for turbo decoder operation. Following flags can be used:
397 - ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE``
399 - ``RTE_BBDEV_TURBO_CRC_TYPE_24B``
401 - ``RTE_BBDEV_TURBO_EQUALIZER``
403 - ``RTE_BBDEV_TURBO_SOFT_OUT_SATURATE``
405 - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN``
407 - ``RTE_BBDEV_TURBO_CONTINUE_CRC_MATCH``
409 - ``RTE_BBDEV_TURBO_SOFT_OUTPUT``
411 - ``RTE_BBDEV_TURBO_EARLY_TERMINATION``
413 - ``RTE_BBDEV_TURBO_DEC_INTERRUPTS``
415 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN``
417 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN``
419 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_SOFT_OUT``
421 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_SOFT_OUT``
423 - ``RTE_BBDEV_TURBO_MAP_DEC``
430 RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE, RTE_BBDEV_TURBO_EQUALIZER,
431 RTE_BBDEV_TURBO_SOFT_OUTPUT
433 Chain of operation statuses that are expected after operation is performed.
434 Following statuses can be used:
444 ``OK`` means no errors are expected. Cannot be used with other values.
452 Turbo encoder test vectors template
453 -----------------------------------
455 For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC``
460 RTE_BBDEV_OP_TURBO_ENC
462 Chain of uint32_t values
469 Chain of uint32_t values
474 0xd2399179, 0x640eb999, 0x2cbaf577, 0xaf224ae2, 0x9d139927, 0xe6909b29,
475 0xa25b7f47, 0x2aa224ce, 0x79f2
505 Chain of flags for turbo encoder operation. Following flags can be used:
507 - ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS``
509 - ``RTE_BBDEV_TURBO_RATE_MATCH``
511 - ``RTE_BBDEV_TURBO_CRC_24B_ATTACH``
513 - ``RTE_BBDEV_TURBO_CRC_24A_ATTACH``
515 - ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER``
517 ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER`` is used to indicate the parser to
518 force the input data to be memory split and formed as a segmented mbuf.
524 RTE_BBDEV_TURBO_RATE_MATCH
526 Chain of operation statuses that are expected after operation is performed.
527 Following statuses can be used:
535 ``OK`` means no errors are expected. Cannot be used with other values.