5.2.1. command-line Options

The following are the command-line options:

-h, --help

Shows help message and exit.

-p TESTAPP_PATH, --testapp_path TESTAPP_PATH

Indicates the path to the bbdev test app. If not specified path is set based on $RTE_SDK environment variable concatenated with “/build/app/testbbdev”.

-e EAL_PARAMS, --eal_params EAL_PARAMS

Specifies EAL arguments which are passed to the test app. For more details, refer to DPDK documentation at http://dpdk.org/doc.

-t TIMEOUT, --timeout TIMEOUT

Specifies timeout in seconds. If not specified timeout is set to 300 seconds.

-c TEST_CASE [TEST_CASE ...], --test_cases TEST_CASE [TEST_CASE ...]

Defines test cases to run. If not specified all available tests are run.

Example usage:

./test-bbdev.py -c validation

Runs validation test suite

./test-bbdev.py -c latency throughput

Runs latency and throughput test suites

-v TEST_VECTOR [TEST_VECTOR ...], --test_vector TEST_VECTOR [TEST_VECTOR ...]

Specifies paths to the test vector files. If not specified path is set based on $RTE_SDK environment variable concatenated with “/app/test-bbdev/test_vectors/bbdev_null.data” and indicates default data file.

Example usage:

./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_dec_test1.data

Fills vector based on turbo_dec_test1.data file and runs all tests

./test-bbdev.py -v turbo_dec_test1.data turbo_enc_test2.data

The bbdev test app is executed twice. First time vector is filled based on turbo_dec_test1.data file and second time based on turb_enc_test2.data file. For both executions all tests are run.

-n NUM_OPS, --num_ops NUM_OPS

Specifies number of operations to process on device. If not specified num_ops is set to 32 operations.

-l NUM_LCORES, --num_lcores NUM_LCORES

Specifies number of lcores to run. If not specified num_lcores is set according to value from RTE configuration (EAL coremask)

-b BURST_SIZE [BURST_SIZE ...], --burst-size BURST_SIZE [BURST_SIZE ...]

Specifies operations enqueue/dequeue burst size. If not specified burst_size is set to 32. Maximum is 512.

5.2.2. Test Cases

There are 6 main test cases that can be executed using testbbdev tool:

• Sanity checks [-c unittest]

  • Performs sanity checks on BBDEV interface, validating basic functionality

• Validation tests [-c validation]

  • Performs full operation of enqueue and dequeue
  • Compares the dequeued data buffer with a expected values in the test vector (TV) being used
  • Fails if any dequeued value does not match the data in the TV

• Offload Cost measurement [-c offload]

  • Measures the CPU cycles consumed from the receipt of a user enqueue until it is put on the device queue

  • The test measures 4 metrics

    1. SW Enq Offload Cost: Software only enqueue offload cost, the cycle counts and time (us) from the point the enqueue API is called until the point the operation is put on the accelerator queue.
    2. Acc Enq Offload Cost: The cycle count and time (us) from the point the operation is put on the accelerator queue until the return from enqueue.
    3. SW Deq Offload Cost: Software dequeue cost, the cycle counts and time (us) consumed to dequeue one operation.
    4. Empty Queue Enq Offload Cost: The cycle count and time (us) consumed to dequeue from an empty queue.

• Latency measurement [-c latency]

  • Measures the time consumed from the first enqueue until the first appearance of a dequeued result
  • This measurment represents the full latency of a bbdev operation (encode or decode) to execute

• Poll-mode Throughput measurement [-c throughput]

  • Performs full operation of enqueue and dequeue
  • Executes in poll mode
  • Measures the achieved throughput on a subset or all available CPU cores
  • Dequeued data is not validated against expected values stored in TV
  • Results are printed in million operations per second and million bits per second

• Interrupt-mode Throughput [-c interrupt]

  • Similar to Throughput test case, but using interrupts. No polling.

5.2.3. Parameter Globbing

Thanks to the globbing functionality in python test-bbdev.py script allows to run tests with different set of vector files without giving all of them explicitly.

Example usage:

./test-bbdev.py -v app/test-bbdev/test_vectors/turbo_<enc/dec>_c<c>_k<k>_r<r>_e<e>_<extra-info>.data

It runs all tests with following vectors:

• bbdev_null.data
• turbo_dec_c1_k6144_r0_e34560_sbd_negllr.data
• turbo_enc_c1_k40_r0_e1196_rm.data
• turbo_enc_c2_k5952_r0_e17868_crc24b.data
• turbo_dec_c1_k40_r0_e17280_sbd_negllr.data
• turbo_dec_c1_k6144_r0_e34560_sbd_posllr.data
• turbo_enc_c1_k40_r0_e272_rm.data
• turbo_enc_c3_k4800_r2_e14412_crc24b.data
• turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data
• turbo_dec_c2_k3136_r0_e4920_sbd_negllr_crc24b.data
• turbo_enc_c1_k6144_r0_e120_rm_rvidx.data
• turbo_enc_c4_k4800_r2_e14412_crc24b.data
• turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_low_snr.data
• turbo_dec_c2_k3136_r0_e4920_sbd_negllr.data
• turbo_enc_c1_k6144_r0_e18444.data
• turbo_dec_c1_k6144_r0_e34560_negllr.data
• turbo_enc_c1_k40_r0_e1190_rm.data
• turbo_enc_c1_k6144_r0_e18448_crc24a.data
• turbo_dec_c1_k6144_r0_e34560_posllr.data
• turbo_enc_c1_k40_r0_e1194_rm.data
• turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data

./test-bbdev.py -v app/test-bbdev/turbo_*_default.data

It runs all tests with “default” vectors.

• turbo_dec_default.data is a soft link to turbo_dec_c1_k6144_r0_e10376_crc24b_sbd_negllr_high_snr.data
• turbo_enc_default.data is a soft link to turbo_enc_c1_k6144_r0_e32256_crc24b_rm.data

5.3.1. All bbdev devices

./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
-v turbo_dec_default.data

It runs all available tests using the test vector filled based on turbo_dec_default.data file. By default number of operations to process on device is set to 32, timeout is set to 300s and operations enqueue/dequeue burst size is set to 32. Moreover a bbdev (baseband_null) device will be created.

5.3.2. baseband turbo_sw device

./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
-e="--vdev=baseband_turbo_sw" -t 120 -c validation
-v ./test_vectors/turbo_* -n 64 -b 8 32

It runs validation test for each vector file that matches the given pattern. Number of operations to process on device is set to 64 and operations timeout is set to 120s and enqueue/dequeue burst size is set to 8 and to 32. Moreover a bbdev (baseband_turbo_sw) device will be created.

5.3.3. bbdev null device

Executing bbdev null device with bbdev_null.data helps in measuring the overhead introduced by the bbdev framework.

./test-bbdev.py -e="--vdev=baseband_null0"
-v ./test_vectors/bbdev_null.data

Note:

baseband_null device does not have to be defined explicitly as it is created by default.