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 (*baseband_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.
75 ``./test-bbdev.py -c validation``
76 Runs validation test suite
78 ``./test-bbdev.py -c latency throughput``
79 Runs latency and throughput test suites
81 ``-v TEST_VECTOR [TEST_VECTOR ...], --test_vector TEST_VECTOR [TEST_VECTOR ...]``
82 Specifies paths to the test vector files. If not specified path is set based
83 on *$RTE_SDK* environment variable concatenated with
84 "*/app/test-bbdev/test_vectors/bbdev_null.data*" and indicates default
89 ``./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_dec_test1.data``
90 Fills vector based on turbo_dec_test1.data file and runs all tests
92 ``./test-bbdev.py -v turbo_dec_test1.data turbo_enc_test2.data``
93 The bbdev test app is executed twice. First time vector is filled based on
94 *turbo_dec_test1.data* file and second time based on
95 *turb_enc_test2.data* file. For both executions all tests are run.
97 ``-n NUM_OPS, --num_ops NUM_OPS``
98 Specifies number of operations to process on device. If not specified num_ops
99 is set to 32 operations.
101 ``-l NUM_LCORES, --num_lcores NUM_LCORES``
102 Specifies number of lcores to run. If not specified num_lcores is set
103 according to value from RTE configuration (EAL coremask)
105 ``-b BURST_SIZE [BURST_SIZE ...], --burst-size BURST_SIZE [BURST_SIZE ...]``
106 Specifies operations enqueue/dequeue burst size. If not specified burst_size is
107 set to 32. Maximum is 512.
112 There are 6 main test cases that can be executed using testbbdev tool:
114 * Sanity checks [-c unittest]
115 - Performs sanity checks on BBDEV interface, validating basic functionality
117 * Validation tests [-c validation]
118 - Performs full operation of enqueue and dequeue
119 - Compares the dequeued data buffer with a expected values in the test
120 vector (TV) being used
121 - Fails if any dequeued value does not match the data in the TV
123 * Offload Cost measurement [-c offload]
124 - Measures the CPU cycles consumed from the receipt of a user enqueue
125 until it is put on the device queue
126 - The test measures 4 metrics
127 (a) *SW Enq Offload Cost*: Software only enqueue offload cost, the cycle
128 counts and time (us) from the point the enqueue API is called until
129 the point the operation is put on the accelerator queue.
130 (b) *Acc Enq Offload Cost*: The cycle count and time (us) from the
131 point the operation is put on the accelerator queue until the return
133 (c) *SW Deq Offload Cost*: Software dequeue cost, the cycle counts and
134 time (us) consumed to dequeue one operation.
135 (d) *Empty Queue Enq Offload Cost*: The cycle count and time (us)
136 consumed to dequeue from an empty queue.
138 * Latency measurement [-c latency]
139 - Measures the time consumed from the first enqueue until the first
140 appearance of a dequeued result
141 - This measurment represents the full latency of a bbdev operation
142 (encode or decode) to execute
144 * Poll-mode Throughput measurement [-c throughput]
145 - Performs full operation of enqueue and dequeue
146 - Executes in poll mode
147 - Measures the achieved throughput on a subset or all available CPU cores
148 - Dequeued data is not validated against expected values stored in TV
149 - Results are printed in million operations per second and million bits
152 * Interrupt-mode Throughput [-c interrupt]
153 - Similar to Throughput test case, but using interrupts. No polling.
159 Thanks to the globbing functionality in python test-bbdev.py script allows to
160 run tests with different set of vector files without giving all of them explicitly.
164 .. code-block:: console
166 ./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_<enc/dec>_c<c>_k<k>_r<r>_e<e>_<extra-info>.data
168 It runs all tests with following vectors:
170 - ``bbdev_null.data``
172 - ``turbo_dec_c1_k6144_r0_e34560_sbd_negllr.data``
174 - ``turbo_enc_c1_k40_r0_e1196_rm.data``
176 - ``turbo_enc_c2_k5952_r0_e17868_crc24b.data``
178 - ``turbo_dec_c1_k40_r0_e17280_sbd_negllr.data``
180 - ``turbo_dec_c1_k6144_r0_e34560_sbd_posllr.data``
182 - ``turbo_enc_c1_k40_r0_e272_rm.data``
184 - ``turbo_enc_c3_k4800_r2_e14412_crc24b.data``
186 - ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data``
188 - ``turbo_dec_c2_k3136_r0_e4920_sbd_negllr_crc24b.data``
190 - ``turbo_enc_c1_k6144_r0_e120_rm_rvidx.data``
192 - ``turbo_enc_c4_k4800_r2_e14412_crc24b.data``
194 - ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_low_snr.data``
196 - ``turbo_dec_c2_k3136_r0_e4920_sbd_negllr.data``
198 - ``turbo_enc_c1_k6144_r0_e18444.data``
200 - ``turbo_dec_c1_k6144_r0_e34560_negllr.data``
202 - ``turbo_enc_c1_k40_r0_e1190_rm.data``
204 - ``turbo_enc_c1_k6144_r0_e18448_crc24a.data``
206 - ``turbo_dec_c1_k6144_r0_e34560_posllr.data``
208 - ``turbo_enc_c1_k40_r0_e1194_rm.data``
210 - ``turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data``
212 .. code-block:: console
214 ./test-bbdev.py -v app/test-bbdev/turbo_*_default.data
216 It runs all tests with "default" vectors.
218 * ``turbo_dec_default.data`` is a soft link to
219 ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data``
221 * ``turbo_enc_default.data`` is a soft link to
222 ``turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data``
228 Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled for
229 x86_64-native-linuxapp-icc target:
237 |-- turbo_dec_c1_k6144_r0_e34560_sbd_negllr.data
238 |-- turbo_enc_c1_k40_r0_e1196_rm.data
239 |-- turbo_enc_c2_k5952_r0_e17868_crc24b.data
240 |-- turbo_dec_c1_k40_r0_e17280_sbd_negllr.data
241 |-- turbo_dec_c1_k6144_r0_e34560_sbd_posllr.data
242 |-- turbo_enc_c1_k40_r0_e272_rm.data
243 |-- turbo_enc_c3_k4800_r2_e14412_crc24b.data
244 |-- turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data
245 |-- turbo_dec_c2_k3136_r0_e4920_sbd_negllr_crc24b.data
246 |-- turbo_enc_c1_k6144_r0_e120_rm_rvidx.data
247 |-- turbo_enc_c4_k4800_r2_e14412_crc24b.data
248 |-- turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_low_snr.data
249 |-- turbo_dec_c2_k3136_r0_e4920_sbd_negllr.data
250 |-- turbo_enc_c1_k6144_r0_e18444.data
251 |-- turbo_dec_c1_k6144_r0_e34560_negllr.data
252 |-- turbo_enc_c1_k40_r0_e1190_rm.data
253 |-- turbo_enc_c1_k6144_r0_e18448_crc24a.data
254 |-- turbo_dec_c1_k6144_r0_e34560_posllr.data
255 |-- turbo_enc_c1_k40_r0_e1194_rm.data
256 |-- turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data
258 |-- x86_64-native-linuxapp-icc
265 .. code-block:: console
267 ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
268 -v turbo_dec_default.data
270 It runs all available tests using the test vector filled based on
271 *turbo_dec_default.data* file.
272 By default number of operations to process on device is set to 32, timeout is
273 set to 300s and operations enqueue/dequeue burst size is set to 32.
274 Moreover a bbdev (*baseband_null*) device will be created.
276 baseband turbo_sw device
277 ~~~~~~~~~~~~~~~~~~~~~~~~
279 .. code-block:: console
281 ./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
282 -e="--vdev=baseband_turbo_sw" -t 120 -c validation
283 -v ./test_vectors/turbo_* -n 64 -b 8 32
285 It runs **validation** test for each vector file that matches the given pattern.
286 Number of operations to process on device is set to 64 and operations timeout is
287 set to 120s and enqueue/dequeue burst size is set to 8 and to 32.
288 Moreover a bbdev (*baseband_turbo_sw*) device will be created.
294 Executing bbdev null device with *bbdev_null.data* helps in measuring the
295 overhead introduced by the bbdev framework.
297 .. code-block:: console
299 ./test-bbdev.py -e="--vdev=baseband_null0"
300 -v ./test_vectors/bbdev_null.data
304 baseband_null device does not have to be defined explicitly as it is created by default.
311 Test Vector files contain the data which is used to set turbo decoder/encoder
312 parameters and buffers for validation purpose. New test vector files should be
313 stored in ``app/test-bbdev/test_vectors/`` directory. Detailed description of
314 the syntax of the test vector files is in the following section.
317 Basic principles for test vector files
318 --------------------------------------
319 Line started with ``#`` is treated as a comment and is ignored.
321 If variable is a chain of values, values should be separated by a comma. If
322 assignment is split into several lines, each line (except the last one) has to
323 be ended with a comma.
324 There is no comma after last value in last line. Correct assignment should
325 look like the following:
330 value, value, value, value,
333 In case where variable is a single value correct assignment looks like the
341 Length of chain variable is calculated by parser. Can not be defined
344 Variable op_type has to be defined as a first variable in file. It specifies
345 what type of operations will be executed. For decoder op_type has to be set to
346 ``RTE_BBDEV_OP_TURBO_DEC`` and for encoder to ``RTE_BBDEV_OP_TURBO_ENC``.
348 Full details of the meaning and valid values for the below fields are
349 documented in *rte_bbdev_op.h*
352 Turbo decoder test vectors template
353 -----------------------------------
355 For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC``
360 RTE_BBDEV_OP_TURBO_DEC
362 Chain of uint32_t values. Note that it is possible to define more than one
363 input/output entries which will result in chaining two or more data structures
364 for *segmented Transport Blocks*
369 0x00000000, 0x7f817f00, 0x7f7f8100, 0x817f8100, 0x81008100, 0x7f818100, 0x81817f00, 0x7f818100,
370 0x81007f00, 0x7f818100, 0x817f8100, 0x81817f00, 0x81008100, 0x817f7f00, 0x7f7f8100, 0x81817f00
372 Chain of uint32_t values
377 0x7f7f0000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
378 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
380 Chain of uint32_t values
385 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
386 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
388 Chain of uint32_t values
395 Chain of uint32_t values
402 Chain of uint32_t values
407 0x817f817f, 0x7f817f7f, 0x81818181, 0x817f7f81, 0x7f818181, 0x8181817f, 0x817f817f, 0x8181817f
409 Chain of uint32_t values
414 0x817f7f81, 0x7f7f7f81, 0x7f7f8181
455 expected_iter_count =
472 Chain of flags for turbo decoder operation. Following flags can be used:
474 - ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE``
476 - ``RTE_BBDEV_TURBO_CRC_TYPE_24B``
478 - ``RTE_BBDEV_TURBO_EQUALIZER``
480 - ``RTE_BBDEV_TURBO_SOFT_OUT_SATURATE``
482 - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN``
484 - ``RTE_BBDEV_TURBO_CONTINUE_CRC_MATCH``
486 - ``RTE_BBDEV_TURBO_SOFT_OUTPUT``
488 - ``RTE_BBDEV_TURBO_EARLY_TERMINATION``
490 - ``RTE_BBDEV_TURBO_DEC_INTERRUPTS``
492 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN``
494 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN``
496 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_SOFT_OUT``
498 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_SOFT_OUT``
500 - ``RTE_BBDEV_TURBO_MAP_DEC``
507 RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE, RTE_BBDEV_TURBO_EQUALIZER,
508 RTE_BBDEV_TURBO_SOFT_OUTPUT
510 Chain of operation statuses that are expected after operation is performed.
511 Following statuses can be used:
521 ``OK`` means no errors are expected. Cannot be used with other values.
529 Turbo encoder test vectors template
530 -----------------------------------
532 For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC``
537 RTE_BBDEV_OP_TURBO_ENC
539 Chain of uint32_t values
546 Chain of uint32_t values
551 0xd2399179, 0x640eb999, 0x2cbaf577, 0xaf224ae2, 0x9d139927, 0xe6909b29,
552 0xa25b7f47, 0x2aa224ce, 0x79f2
582 Chain of flags for turbo encoder operation. Following flags can be used:
584 - ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS``
586 - ``RTE_BBDEV_TURBO_RATE_MATCH``
588 - ``RTE_BBDEV_TURBO_CRC_24B_ATTACH``
590 - ``RTE_BBDEV_TURBO_CRC_24A_ATTACH``
592 - ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER``
594 ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER`` is used to indicate the parser to
595 force the input data to be memory split and formed as a segmented mbuf.
601 RTE_BBDEV_TURBO_RATE_MATCH
603 Chain of operation statuses that are expected after operation is performed.
604 Following statuses can be used:
612 ``OK`` means no errors are expected. Cannot be used with other values.