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.

The following tests can be run:

• unittest

  Small unit tests witch check basic functionality of bbdev library.

• latency

  Test calculates three latency metrics:

  • offload_latency_tc

    measures the cost of offloading enqueue and dequeue operations.

  • offload_latency_empty_q_tc

    measures the cost of offloading a dequeue operation from an empty queue. checks how long last dequeueing if there is no operations to dequeue

  • operation_latency_tc

    measures the time difference from the first attempt to enqueue till the first successful dequeue.

• validation

  Test do enqueue on given vector and compare output after dequeueing.

• throughput

  Test measures the achieved throughput on the available lcores. Results are printed in million operations per second and million bits per second.

• interrupt

  The same test as ‘throughput’ but uses interrupts instead of PMD to perform the dequeue.

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_vector_null.data” and indicates default data file.

Example usage:

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

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

./test-bbdev.py -v bbdev_vector_td_test1.data bbdev_vector_te_test2.data

The bbdev test app is executed twice. First time vector is filled based on bbdev_vector_td_test1.data file and second time based on bbdev_vector_te_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. 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/bbdev_vector_*.data

It runs all tests with following vectors:

• bbdev_vector_null.data
• bbdev_vector_td_default.data
• bbdev_vector_te_default.data

./test-bbdev.py -v app/test-bbdev/test_vectors/bbdev_vector_t?_default.data

It runs all tests with “default” vectors:

• bbdev_vector_te_default.data
• bbdev_vector_td_default.data

5.3.1. All bbdev devices

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

It runs all available tests using the test vector filled based on bbdev_vector_td_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 (bbdev_null) device will be created.

5.3.2. bbdev turbo_sw device

./test-bbdev.py -p ../../x86_64-native-linuxapp-icc/app/testbbdev
-e="--vdev=turbo_sw" -t 120 -c validation
-v ./test_vectors/bbdev_vector_t?_default.data -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 (turbo_sw) device will be created.

5.3.3. bbdev null device

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

./test-bbdev.py -e="--vdev=bbdev_null0"
-v ./test_vectors/bbdev_vector_null.data

Note:

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