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
66 http://doc.dpdk.org/guides/linux_gsg/linux_eal_parameters.html.
68 ``-t TIMEOUT, --timeout TIMEOUT``
69 Specifies timeout in seconds. If not specified timeout is set to 300 seconds.
71 ``-c TEST_CASE [TEST_CASE ...], --test_cases TEST_CASE [TEST_CASE ...]``
72 Defines test cases to run. If not specified all available tests are run.
76 ``./test-bbdev.py -c validation``
77 Runs validation test suite
79 ``./test-bbdev.py -c latency throughput``
80 Runs latency and throughput test suites
82 ``-v TEST_VECTOR [TEST_VECTOR ...], --test_vector TEST_VECTOR [TEST_VECTOR ...]``
83 Specifies paths to the test vector files. If not specified path is set based
84 on *$RTE_SDK* environment variable concatenated with
85 "*/app/test-bbdev/test_vectors/bbdev_null.data*" and indicates default
90 ``./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_dec_test1.data``
91 Fills vector based on turbo_dec_test1.data file and runs all tests
93 ``./test-bbdev.py -v turbo_dec_test1.data turbo_enc_test2.data``
94 The bbdev test app is executed twice. First time vector is filled based on
95 *turbo_dec_test1.data* file and second time based on
96 *turb_enc_test2.data* file. For both executions all tests are run.
98 ``-n NUM_OPS, --num_ops NUM_OPS``
99 Specifies number of operations to process on device. If not specified num_ops
100 is set to 32 operations.
102 ``-l NUM_LCORES, --num_lcores NUM_LCORES``
103 Specifies number of lcores to run. If not specified num_lcores is set
104 according to value from RTE configuration (EAL coremask)
106 ``-b BURST_SIZE [BURST_SIZE ...], --burst-size BURST_SIZE [BURST_SIZE ...]``
107 Specifies operations enqueue/dequeue burst size. If not specified burst_size is
108 set to 32. Maximum is 512.
113 There are 6 main test cases that can be executed using testbbdev tool:
115 * Sanity checks [-c unittest]
116 - Performs sanity checks on BBDEV interface, validating basic functionality
118 * Validation tests [-c validation]
119 - Performs full operation of enqueue and dequeue
120 - Compares the dequeued data buffer with a expected values in the test
121 vector (TV) being used
122 - Fails if any dequeued value does not match the data in the TV
124 * Offload Cost measurement [-c offload]
125 - Measures the CPU cycles consumed from the receipt of a user enqueue
126 until it is put on the device queue
127 - The test measures 4 metrics
128 (a) *SW Enq Offload Cost*: Software only enqueue offload cost, the cycle
129 counts and time (us) from the point the enqueue API is called until
130 the point the operation is put on the accelerator queue.
131 (b) *Acc Enq Offload Cost*: The cycle count and time (us) from the
132 point the operation is put on the accelerator queue until the return
134 (c) *SW Deq Offload Cost*: Software dequeue cost, the cycle counts and
135 time (us) consumed to dequeue one operation.
136 (d) *Empty Queue Enq Offload Cost*: The cycle count and time (us)
137 consumed to dequeue from an empty queue.
139 * Latency measurement [-c latency]
140 - Measures the time consumed from the first enqueue until the first
141 appearance of a dequeued result
142 - This measurement represents the full latency of a bbdev operation
143 (encode or decode) to execute
145 * Poll-mode Throughput measurement [-c throughput]
146 - Performs full operation of enqueue and dequeue
147 - Executes in poll mode
148 - Measures the achieved throughput on a subset or all available CPU cores
149 - Dequeued data is not validated against expected values stored in TV
150 - Results are printed in million operations per second and million bits
153 * Interrupt-mode Throughput [-c interrupt]
154 - Similar to Throughput test case, but using interrupts. No polling.
160 Thanks to the globbing functionality in python test-bbdev.py script allows to
161 run tests with different set of vector files without giving all of them explicitly.
165 .. code-block:: console
167 ./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_<enc/dec>_c<c>_k<k>_r<r>_e<e>_<extra-info>.data
169 It runs all tests with following vectors:
171 - ``bbdev_null.data``
173 - ``turbo_dec_c1_k6144_r0_e34560_sbd_negllr.data``
175 - ``turbo_enc_c1_k40_r0_e1196_rm.data``
177 - ``turbo_enc_c2_k5952_r0_e17868_crc24b.data``
179 - ``turbo_dec_c1_k40_r0_e17280_sbd_negllr.data``
181 - ``turbo_dec_c1_k6144_r0_e34560_sbd_posllr.data``
183 - ``turbo_enc_c1_k40_r0_e272_rm.data``
185 - ``turbo_enc_c3_k4800_r2_e14412_crc24b.data``
187 - ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data``
189 - ``turbo_dec_c2_k3136_r0_e4920_sbd_negllr_crc24b.data``
191 - ``turbo_enc_c1_k6144_r0_e120_rm_rvidx.data``
193 - ``turbo_enc_c4_k4800_r2_e14412_crc24b.data``
195 - ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_low_snr.data``
197 - ``turbo_dec_c2_k3136_r0_e4920_sbd_negllr.data``
199 - ``turbo_enc_c1_k6144_r0_e18444.data``
201 - ``turbo_dec_c1_k6144_r0_e34560_negllr.data``
203 - ``turbo_enc_c1_k40_r0_e1190_rm.data``
205 - ``turbo_enc_c1_k6144_r0_e18448_crc24a.data``
207 - ``turbo_dec_c1_k6144_r0_e34560_posllr.data``
209 - ``turbo_enc_c1_k40_r0_e1194_rm.data``
211 - ``turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data``
213 .. code-block:: console
215 ./test-bbdev.py -v app/test-bbdev/turbo_*_default.data
217 It runs all tests with "default" vectors.
219 * ``turbo_dec_default.data`` is a soft link to
220 ``turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data``
222 * ``turbo_enc_default.data`` is a soft link to
223 ``turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data``
229 Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled for
230 x86_64-native-linux-icc target:
238 |-- turbo_dec_c1_k6144_r0_e34560_sbd_negllr.data
239 |-- turbo_enc_c1_k40_r0_e1196_rm.data
240 |-- turbo_enc_c2_k5952_r0_e17868_crc24b.data
241 |-- turbo_dec_c1_k40_r0_e17280_sbd_negllr.data
242 |-- turbo_dec_c1_k6144_r0_e34560_sbd_posllr.data
243 |-- turbo_enc_c1_k40_r0_e272_rm.data
244 |-- turbo_enc_c3_k4800_r2_e14412_crc24b.data
245 |-- turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data
246 |-- turbo_dec_c2_k3136_r0_e4920_sbd_negllr_crc24b.data
247 |-- turbo_enc_c1_k6144_r0_e120_rm_rvidx.data
248 |-- turbo_enc_c4_k4800_r2_e14412_crc24b.data
249 |-- turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_low_snr.data
250 |-- turbo_dec_c2_k3136_r0_e4920_sbd_negllr.data
251 |-- turbo_enc_c1_k6144_r0_e18444.data
252 |-- turbo_dec_c1_k6144_r0_e34560_negllr.data
253 |-- turbo_enc_c1_k40_r0_e1190_rm.data
254 |-- turbo_enc_c1_k6144_r0_e18448_crc24a.data
255 |-- turbo_dec_c1_k6144_r0_e34560_posllr.data
256 |-- turbo_enc_c1_k40_r0_e1194_rm.data
257 |-- turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data
259 |-- x86_64-native-linux-icc
266 .. code-block:: console
268 ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev
269 -v turbo_dec_default.data
271 It runs all available tests using the test vector filled based on
272 *turbo_dec_default.data* file.
273 By default number of operations to process on device is set to 32, timeout is
274 set to 300s and operations enqueue/dequeue burst size is set to 32.
275 Moreover a bbdev (*baseband_null*) device will be created.
277 baseband turbo_sw device
278 ~~~~~~~~~~~~~~~~~~~~~~~~
280 .. code-block:: console
282 ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev
283 -e="--vdev=baseband_turbo_sw" -t 120 -c validation
284 -v ./test_vectors/turbo_* -n 64 -b 8 32
286 It runs **validation** test for each vector file that matches the given pattern.
287 Number of operations to process on device is set to 64 and operations timeout is
288 set to 120s and enqueue/dequeue burst size is set to 8 and to 32.
289 Moreover a bbdev (*baseband_turbo_sw*) device will be created.
295 Executing bbdev null device with *bbdev_null.data* helps in measuring the
296 overhead introduced by the bbdev framework.
298 .. code-block:: console
300 ./test-bbdev.py -e="--vdev=baseband_null0"
301 -v ./test_vectors/bbdev_null.data
305 baseband_null device does not have to be defined explicitly as it is created by default.
312 Test Vector files contain the data which is used to set turbo decoder/encoder
313 parameters and buffers for validation purpose. New test vector files should be
314 stored in ``app/test-bbdev/test_vectors/`` directory. Detailed description of
315 the syntax of the test vector files is in the following section.
318 Basic principles for test vector files
319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320 Line started with ``#`` is treated as a comment and is ignored.
322 If variable is a chain of values, values should be separated by a comma. If
323 assignment is split into several lines, each line (except the last one) has to
324 be ended with a comma.
325 There is no comma after last value in last line. Correct assignment should
326 look like the following:
331 value, value, value, value,
334 In case where variable is a single value correct assignment looks like the
342 Length of chain variable is calculated by parser. Can not be defined
345 Variable op_type has to be defined as a first variable in file. It specifies
346 what type of operations will be executed. For decoder op_type has to be set to
347 ``RTE_BBDEV_OP_TURBO_DEC`` and for encoder to ``RTE_BBDEV_OP_TURBO_ENC``.
349 Full details of the meaning and valid values for the below fields are
350 documented in *rte_bbdev_op.h*
353 Turbo decoder test vectors template
354 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
356 For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC``
361 RTE_BBDEV_OP_TURBO_DEC
363 Chain of uint32_t values. Note that it is possible to define more than one
364 input/output entries which will result in chaining two or more data structures
365 for *segmented Transport Blocks*
370 0x00000000, 0x7f817f00, 0x7f7f8100, 0x817f8100, 0x81008100, 0x7f818100, 0x81817f00, 0x7f818100,
371 0x81007f00, 0x7f818100, 0x817f8100, 0x81817f00, 0x81008100, 0x817f7f00, 0x7f7f8100, 0x81817f00
373 Chain of uint32_t values
378 0x7f7f0000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
379 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
381 Chain of uint32_t values
386 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
387 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
389 Chain of uint32_t values
396 Chain of uint32_t values
403 Chain of uint32_t values
408 0x817f817f, 0x7f817f7f, 0x81818181, 0x817f7f81, 0x7f818181, 0x8181817f, 0x817f817f, 0x8181817f
410 Chain of uint32_t values
415 0x817f7f81, 0x7f7f7f81, 0x7f7f8181
456 expected_iter_count =
473 Chain of flags for turbo decoder operation. Following flags can be used:
475 - ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE``
477 - ``RTE_BBDEV_TURBO_CRC_TYPE_24B``
479 - ``RTE_BBDEV_TURBO_EQUALIZER``
481 - ``RTE_BBDEV_TURBO_SOFT_OUT_SATURATE``
483 - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN``
485 - ``RTE_BBDEV_TURBO_CONTINUE_CRC_MATCH``
487 - ``RTE_BBDEV_TURBO_SOFT_OUTPUT``
489 - ``RTE_BBDEV_TURBO_EARLY_TERMINATION``
491 - ``RTE_BBDEV_TURBO_DEC_INTERRUPTS``
493 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN``
495 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN``
497 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_SOFT_OUT``
499 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_SOFT_OUT``
501 - ``RTE_BBDEV_TURBO_MAP_DEC``
508 RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE, RTE_BBDEV_TURBO_EQUALIZER,
509 RTE_BBDEV_TURBO_SOFT_OUTPUT
511 Chain of operation statuses that are expected after operation is performed.
512 Following statuses can be used:
522 ``OK`` means no errors are expected. Cannot be used with other values.
530 Turbo encoder test vectors template
531 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
533 For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC``
538 RTE_BBDEV_OP_TURBO_ENC
540 Chain of uint32_t values
547 Chain of uint32_t values
552 0xd2399179, 0x640eb999, 0x2cbaf577, 0xaf224ae2, 0x9d139927, 0xe6909b29,
553 0xa25b7f47, 0x2aa224ce, 0x79f2
583 Chain of flags for turbo encoder operation. Following flags can be used:
585 - ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS``
587 - ``RTE_BBDEV_TURBO_RATE_MATCH``
589 - ``RTE_BBDEV_TURBO_CRC_24B_ATTACH``
591 - ``RTE_BBDEV_TURBO_CRC_24A_ATTACH``
593 - ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER``
595 ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER`` is used to indicate the parser to
596 force the input data to be memory split and formed as a segmented mbuf.
602 RTE_BBDEV_TURBO_RATE_MATCH
604 Chain of operation statuses that are expected after operation is performed.
605 Following statuses can be used:
613 ``OK`` means no errors are expected. Cannot be used with other values.