1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
9 #include <rte_malloc.h>
12 #include <rte_compressdev.h>
14 #include "comp_perf.h"
15 #include "comp_perf_options.h"
16 #include "comp_perf_test_common.h"
17 #include "comp_perf_test_cyclecount.h"
18 #include "comp_perf_test_throughput.h"
19 #include "comp_perf_test_verify.h"
21 #define NUM_MAX_XFORMS 16
22 #define NUM_MAX_INFLIGHT_OPS 512
25 const char *comp_perf_test_type_strs[] = {
26 [CPERF_TEST_TYPE_THROUGHPUT] = "throughput",
27 [CPERF_TEST_TYPE_VERIFY] = "verify",
28 [CPERF_TEST_TYPE_PMDCC] = "pmd-cyclecount"
32 static const struct cperf_test cperf_testmap[] = {
33 [CPERF_TEST_TYPE_THROUGHPUT] = {
34 cperf_throughput_test_constructor,
35 cperf_throughput_test_runner,
36 cperf_throughput_test_destructor
39 [CPERF_TEST_TYPE_VERIFY] = {
40 cperf_verify_test_constructor,
41 cperf_verify_test_runner,
42 cperf_verify_test_destructor
45 [CPERF_TEST_TYPE_PMDCC] = {
46 cperf_cyclecount_test_constructor,
47 cperf_cyclecount_test_runner,
48 cperf_cyclecount_test_destructor
52 static struct comp_test_data *test_data;
55 comp_perf_check_capabilities(struct comp_test_data *test_data, uint8_t cdev_id)
57 const struct rte_compressdev_capabilities *cap;
59 cap = rte_compressdev_capability_get(cdev_id,
60 RTE_COMP_ALGO_DEFLATE);
64 "Compress device does not support DEFLATE\n");
68 uint64_t comp_flags = cap->comp_feature_flags;
70 /* Huffman encoding */
71 if (test_data->huffman_enc == RTE_COMP_HUFFMAN_FIXED &&
72 (comp_flags & RTE_COMP_FF_HUFFMAN_FIXED) == 0) {
74 "Compress device does not supported Fixed Huffman\n");
78 if (test_data->huffman_enc == RTE_COMP_HUFFMAN_DYNAMIC &&
79 (comp_flags & RTE_COMP_FF_HUFFMAN_DYNAMIC) == 0) {
81 "Compress device does not supported Dynamic Huffman\n");
86 if (test_data->window_sz != -1) {
87 if (param_range_check(test_data->window_sz, &cap->window_size)
90 "Compress device does not support "
91 "this window size\n");
95 /* Set window size to PMD maximum if none was specified */
96 test_data->window_sz = cap->window_size.max;
98 /* Check if chained mbufs is supported */
99 if (test_data->max_sgl_segs > 1 &&
100 (comp_flags & RTE_COMP_FF_OOP_SGL_IN_SGL_OUT) == 0) {
101 RTE_LOG(INFO, USER1, "Compress device does not support "
102 "chained mbufs. Max SGL segments set to 1\n");
103 test_data->max_sgl_segs = 1;
106 /* Level 0 support */
107 if (test_data->level_lst.min == 0 &&
108 (comp_flags & RTE_COMP_FF_NONCOMPRESSED_BLOCKS) == 0) {
109 RTE_LOG(ERR, USER1, "Compress device does not support "
110 "level 0 (no compression)\n");
118 comp_perf_initialize_compressdev(struct comp_test_data *test_data,
119 uint8_t *enabled_cdevs)
121 uint8_t enabled_cdev_count, nb_lcores, cdev_id;
125 enabled_cdev_count = rte_compressdev_devices_get(test_data->driver_name,
126 enabled_cdevs, RTE_COMPRESS_MAX_DEVS);
127 if (enabled_cdev_count == 0) {
128 RTE_LOG(ERR, USER1, "No compress devices type %s available,"
129 " please check the list of specified devices in EAL section\n",
130 test_data->driver_name);
134 nb_lcores = rte_lcore_count() - 1;
137 * if there are more available than cores.
139 if (enabled_cdev_count > nb_lcores) {
140 if (nb_lcores == 0) {
141 RTE_LOG(ERR, USER1, "Cannot run with 0 cores! Increase the number of cores\n");
144 enabled_cdev_count = nb_lcores;
146 "There's more available devices than cores!"
147 " The number of devices has been aligned to %d cores\n",
152 * Calculate number of needed queue pairs, based on the amount
153 * of available number of logical cores and compression devices.
154 * For instance, if there are 4 cores and 2 compression devices,
155 * 2 queue pairs will be set up per device.
156 * One queue pair per one core.
157 * if e.g.: there're 3 cores and 2 compression devices,
158 * 2 queue pairs will be set up per device but one queue pair
159 * will left unused in the last one device
161 test_data->nb_qps = (nb_lcores % enabled_cdev_count) ?
162 (nb_lcores / enabled_cdev_count) + 1 :
163 nb_lcores / enabled_cdev_count;
165 for (i = 0; i < enabled_cdev_count &&
166 i < RTE_COMPRESS_MAX_DEVS; i++,
167 nb_lcores -= test_data->nb_qps) {
168 cdev_id = enabled_cdevs[i];
170 struct rte_compressdev_info cdev_info;
171 int socket_id = rte_compressdev_socket_id(cdev_id);
173 rte_compressdev_info_get(cdev_id, &cdev_info);
174 if (cdev_info.max_nb_queue_pairs &&
175 test_data->nb_qps > cdev_info.max_nb_queue_pairs) {
177 "Number of needed queue pairs is higher "
178 "than the maximum number of queue pairs "
181 "Lower the number of cores or increase "
182 "the number of crypto devices\n");
186 if (comp_perf_check_capabilities(test_data, cdev_id) < 0)
189 /* Configure compressdev */
190 struct rte_compressdev_config config = {
191 .socket_id = socket_id,
192 .nb_queue_pairs = nb_lcores > test_data->nb_qps
193 ? test_data->nb_qps : nb_lcores,
194 .max_nb_priv_xforms = NUM_MAX_XFORMS,
197 test_data->nb_qps = config.nb_queue_pairs;
199 if (rte_compressdev_configure(cdev_id, &config) < 0) {
200 RTE_LOG(ERR, USER1, "Device configuration failed\n");
204 for (j = 0; j < test_data->nb_qps; j++) {
205 ret = rte_compressdev_queue_pair_setup(cdev_id, j,
206 NUM_MAX_INFLIGHT_OPS, socket_id);
209 "Failed to setup queue pair %u on compressdev %u",
215 ret = rte_compressdev_start(cdev_id);
218 "Failed to start device %u: error %d\n",
224 return enabled_cdev_count;
228 comp_perf_dump_input_data(struct comp_test_data *test_data)
230 FILE *f = fopen(test_data->input_file, "r");
234 RTE_LOG(ERR, USER1, "Input file could not be opened\n");
238 if (fseek(f, 0, SEEK_END) != 0) {
239 RTE_LOG(ERR, USER1, "Size of input could not be calculated\n");
242 size_t actual_file_sz = ftell(f);
243 /* If extended input data size has not been set,
244 * input data size = file size
247 if (test_data->input_data_sz == 0)
248 test_data->input_data_sz = actual_file_sz;
250 if (test_data->input_data_sz <= 0 || actual_file_sz <= 0 ||
251 fseek(f, 0, SEEK_SET) != 0) {
252 RTE_LOG(ERR, USER1, "Size of input could not be calculated\n");
256 test_data->input_data = rte_zmalloc_socket(NULL,
257 test_data->input_data_sz, 0, rte_socket_id());
259 if (test_data->input_data == NULL) {
260 RTE_LOG(ERR, USER1, "Memory to hold the data from the input "
261 "file could not be allocated\n");
265 size_t remaining_data = test_data->input_data_sz;
266 uint8_t *data = test_data->input_data;
268 while (remaining_data > 0) {
269 size_t data_to_read = RTE_MIN(remaining_data, actual_file_sz);
271 if (fread(data, data_to_read, 1, f) != 1) {
272 RTE_LOG(ERR, USER1, "Input file could not be read\n");
275 if (fseek(f, 0, SEEK_SET) != 0) {
277 "Size of input could not be calculated\n");
280 remaining_data -= data_to_read;
281 data += data_to_read;
285 if (test_data->input_data_sz > actual_file_sz)
287 "%zu bytes read from file %s, extending the file %.2f times\n",
288 test_data->input_data_sz, test_data->input_file,
289 (double)test_data->input_data_sz/actual_file_sz);
292 "%zu bytes read from file %s\n",
293 test_data->input_data_sz, test_data->input_file);
303 comp_perf_cleanup_on_signal(int signalNumber __rte_unused)
305 test_data->perf_comp_force_stop = 1;
309 comp_perf_register_cleanup_on_signal(void)
311 signal(SIGTERM, comp_perf_cleanup_on_signal);
312 signal(SIGINT, comp_perf_cleanup_on_signal);
316 main(int argc, char **argv)
318 uint8_t level_idx = 0;
320 void *ctx[RTE_MAX_LCORE] = {};
321 uint8_t enabled_cdevs[RTE_COMPRESS_MAX_DEVS];
322 int nb_compressdevs = 0;
323 uint16_t total_nb_qps = 0;
327 /* Initialise DPDK EAL */
328 ret = rte_eal_init(argc, argv);
330 rte_exit(EXIT_FAILURE, "Invalid EAL arguments!\n");
334 test_data = rte_zmalloc_socket(NULL, sizeof(struct comp_test_data),
337 if (test_data == NULL)
338 rte_exit(EXIT_FAILURE, "Cannot reserve memory in socket %d\n",
341 comp_perf_register_cleanup_on_signal();
344 test_data->cleanup = ST_TEST_DATA;
345 comp_perf_options_default(test_data);
347 if (comp_perf_options_parse(test_data, argc, argv) < 0) {
349 "Parsing one or more user options failed\n");
354 if (comp_perf_options_check(test_data) < 0) {
360 comp_perf_initialize_compressdev(test_data, enabled_cdevs);
362 if (nb_compressdevs < 1) {
367 test_data->cleanup = ST_COMPDEV;
368 if (comp_perf_dump_input_data(test_data) < 0) {
373 test_data->cleanup = ST_INPUT_DATA;
375 if (test_data->level_lst.inc != 0)
376 test_data->level = test_data->level_lst.min;
378 test_data->level = test_data->level_lst.list[0];
380 printf("\nApp uses socket: %u\n", rte_socket_id());
381 printf("Burst size = %u\n", test_data->burst_sz);
382 printf("Input data size = %zu\n", test_data->input_data_sz);
383 if (test_data->test == CPERF_TEST_TYPE_PMDCC)
384 printf("Cycle-count delay = %u [us]\n",
385 test_data->cyclecount_delay);
387 test_data->cleanup = ST_DURING_TEST;
388 total_nb_qps = nb_compressdevs * test_data->nb_qps;
391 uint8_t qp_id = 0, cdev_index = 0;
393 RTE_LCORE_FOREACH_WORKER(lcore_id) {
395 if (i == total_nb_qps)
398 cdev_id = enabled_cdevs[cdev_index];
399 ctx[i] = cperf_testmap[test_data->test].constructor(
402 if (ctx[i] == NULL) {
403 RTE_LOG(ERR, USER1, "Test run constructor failed\n");
406 qp_id = (qp_id + 1) % test_data->nb_qps;
412 print_test_dynamics(test_data);
414 while (test_data->level <= test_data->level_lst.max) {
417 RTE_LCORE_FOREACH_WORKER(lcore_id) {
419 if (i == total_nb_qps)
422 rte_eal_remote_launch(
423 cperf_testmap[test_data->test].runner,
428 RTE_LCORE_FOREACH_WORKER(lcore_id) {
430 if (i == total_nb_qps)
432 ret |= rte_eal_wait_lcore(lcore_id);
436 if (ret != EXIT_SUCCESS)
439 if (test_data->level_lst.inc != 0)
440 test_data->level += test_data->level_lst.inc;
442 if (++level_idx == test_data->level_lst.count)
444 test_data->level = test_data->level_lst.list[level_idx];
449 switch (test_data->cleanup) {
453 RTE_LCORE_FOREACH_WORKER(lcore_id) {
454 if (i == total_nb_qps)
457 if (ctx[i] && cperf_testmap[test_data->test].destructor)
458 cperf_testmap[test_data->test].destructor(
464 rte_free(test_data->input_data);
467 for (i = 0; i < nb_compressdevs &&
468 i < RTE_COMPRESS_MAX_DEVS; i++) {
469 rte_compressdev_stop(enabled_cdevs[i]);
470 rte_compressdev_close(enabled_cdevs[i]);
478 i = rte_eal_cleanup();
481 "Error from rte_eal_cleanup(), %d\n", i);
490 cperf_cyclecount_test_constructor(uint8_t dev_id __rte_unused,
491 uint16_t qp_id __rte_unused,
492 struct comp_test_data *options __rte_unused)
494 RTE_LOG(INFO, USER1, "Cycle count test is not supported yet\n");
499 cperf_cyclecount_test_destructor(void *arg __rte_unused)
501 RTE_LOG(INFO, USER1, "Something wrong happened!!!\n");
505 cperf_cyclecount_test_runner(void *test_ctx __rte_unused)
511 cperf_throughput_test_constructor(uint8_t dev_id __rte_unused,
512 uint16_t qp_id __rte_unused,
513 struct comp_test_data *options __rte_unused)
515 RTE_LOG(INFO, USER1, "Benchmark test is not supported yet\n");
520 cperf_throughput_test_destructor(void *arg __rte_unused)
526 cperf_throughput_test_runner(void *test_ctx __rte_unused)
531 cperf_verify_test_constructor(uint8_t dev_id __rte_unused,
532 uint16_t qp_id __rte_unused,
533 struct comp_test_data *options __rte_unused)
535 RTE_LOG(INFO, USER1, "Verify test is not supported yet\n");
540 cperf_verify_test_destructor(void *arg __rte_unused)
546 cperf_verify_test_runner(void *test_ctx __rte_unused)