1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2020 Mellanox Technologies, Ltd
17 #include <rte_common.h>
18 #include <rte_malloc.h>
19 #include <rte_mempool.h>
21 #include <rte_cycles.h>
22 #include <rte_regexdev.h>
24 #define MAX_FILE_NAME 255
25 #define MBUF_CACHE_SIZE 256
26 #define MBUF_SIZE (1 << 8)
27 #define START_BURST_SIZE 32u
35 ARG_NUM_OF_ITERATIONS,
42 struct rte_mbuf *mbuf;
46 uint32_t total_enqueue;
47 uint32_t total_dequeue;
48 uint32_t total_matches;
49 struct rte_regex_ops **ops;
50 struct job_ctx *jobs_ctx;
56 struct qps_per_lcore {
57 unsigned int lcore_id;
66 uint32_t nb_iterations;
68 uint8_t nb_max_matches;
78 usage(const char *prog_name)
80 printf("%s [EAL options] --\n"
81 " --rules NAME: precompiled rules file\n"
82 " --data NAME: data file to use\n"
83 " --nb_jobs: number of jobs to use\n"
84 " --perf N: only outputs the performance data\n"
85 " --nb_iter N: number of iteration to run\n"
86 " --nb_qps N: number of queues to use\n"
87 " --nb_lcores N: number of lcores to use\n"
88 " --nb_segs N: number of mbuf segments\n",
93 args_parse(int argc, char **argv, char *rules_file, char *data_file,
94 uint32_t *nb_jobs, bool *perf_mode, uint32_t *nb_iterations,
95 uint32_t *nb_qps, uint32_t *nb_lcores, uint32_t *nb_segs)
101 static struct option lgopts[] = {
102 { "help", 0, 0, ARG_HELP},
103 /* Rules database file to load. */
104 { "rules", 1, 0, ARG_RULES_FILE_NAME},
105 /* Data file to load. */
106 { "data", 1, 0, ARG_DATA_FILE_NAME},
107 /* Number of jobs to create. */
108 { "nb_jobs", 1, 0, ARG_NUM_OF_JOBS},
110 { "perf", 0, 0, ARG_PERF_MODE},
111 /* Number of iterations to run with perf test */
112 { "nb_iter", 1, 0, ARG_NUM_OF_ITERATIONS},
114 { "nb_qps", 1, 0, ARG_NUM_OF_QPS},
115 /* Number of lcores. */
116 { "nb_lcores", 1, 0, ARG_NUM_OF_LCORES},
117 /* Number of mbuf segments. */
118 { "nb_segs", 1, 0, ARG_NUM_OF_MBUF_SEGS},
124 while ((opt = getopt_long(argc, argvopt, "",
125 lgopts, &opt_idx)) != EOF) {
127 case ARG_RULES_FILE_NAME:
128 len = strnlen(optarg, MAX_FILE_NAME - 1);
129 if (len == MAX_FILE_NAME)
130 rte_exit(EXIT_FAILURE,
131 "Rule file name to long max %d\n",
133 strncpy(rules_file, optarg, MAX_FILE_NAME - 1);
135 case ARG_DATA_FILE_NAME:
136 len = strnlen(optarg, MAX_FILE_NAME - 1);
137 if (len == MAX_FILE_NAME)
138 rte_exit(EXIT_FAILURE,
139 "Data file name to long max %d\n",
141 strncpy(data_file, optarg, MAX_FILE_NAME - 1);
143 case ARG_NUM_OF_JOBS:
144 *nb_jobs = atoi(optarg);
149 case ARG_NUM_OF_ITERATIONS:
150 *nb_iterations = atoi(optarg);
153 *nb_qps = atoi(optarg);
155 case ARG_NUM_OF_LCORES:
156 *nb_lcores = atoi(optarg);
158 case ARG_NUM_OF_MBUF_SEGS:
159 *nb_segs = atoi(optarg);
162 usage("RegEx test app");
165 fprintf(stderr, "Invalid option: %s\n", argv[optind]);
166 usage("RegEx test app");
167 rte_exit(EXIT_FAILURE, "Invalid option\n");
177 read_file(char *file, char **buf)
184 fp = fopen(file, "r");
187 if (fseek(fp, 0L, SEEK_END) == 0) {
193 *buf = rte_malloc(NULL, sizeof(char) * (buf_len + 1), 4096);
198 if (fseek(fp, 0L, SEEK_SET) != 0) {
202 read_len = fread(*buf, sizeof(char), buf_len, fp);
203 if (read_len != (unsigned long)buf_len) {
211 printf("Error, can't open file %s\n, err = %d", file, res);
220 clone_buf(char *data_buf, char **buf, long data_len)
224 rte_malloc(NULL, sizeof(char) * (data_len + 1), 4096);
227 memcpy(dest_buf, data_buf, data_len + 1);
233 init_port(uint16_t *nb_max_payload, char *rules_file, uint8_t *nb_max_matches,
241 struct rte_regexdev_info info;
242 struct rte_regexdev_config dev_conf = {
243 .nb_queue_pairs = nb_qps,
246 struct rte_regexdev_qp_conf qp_conf = {
252 num_devs = rte_regexdev_count();
254 printf("Error, no devices detected.\n");
258 rules_len = read_file(rules_file, &rules);
260 printf("Error, can't read rules files.\n");
265 for (id = 0; id < num_devs; id++) {
266 res = rte_regexdev_info_get(id, &info);
268 printf("Error, can't get device info.\n");
271 printf(":: initializing dev: %d\n", id);
272 *nb_max_matches = info.max_matches;
273 *nb_max_payload = info.max_payload_size;
274 if (info.regexdev_capa & RTE_REGEXDEV_SUPP_MATCH_AS_END_F)
275 dev_conf.dev_cfg_flags |=
276 RTE_REGEXDEV_CFG_MATCH_AS_END_F;
277 dev_conf.nb_max_matches = info.max_matches;
278 dev_conf.nb_rules_per_group = info.max_rules_per_group;
279 dev_conf.rule_db_len = rules_len;
280 dev_conf.rule_db = rules;
281 res = rte_regexdev_configure(id, &dev_conf);
283 printf("Error, can't configure device %d.\n", id);
286 if (info.regexdev_capa & RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F)
287 qp_conf.qp_conf_flags |=
288 RTE_REGEX_QUEUE_PAIR_CFG_OOS_F;
289 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
290 res = rte_regexdev_queue_pair_setup(id, qp_id,
293 printf("Error, can't setup queue pair %u for "
294 "device %d.\n", qp_id, id);
298 printf(":: initializing device: %d done\n", id);
309 extbuf_free_cb(void *addr __rte_unused, void *fcb_opaque __rte_unused)
313 static inline struct rte_mbuf *
314 regex_create_segmented_mbuf(struct rte_mempool *mbuf_pool, int pkt_len,
315 int nb_segs, void *buf) {
317 struct rte_mbuf *m = NULL, *mbuf = NULL;
325 printf("Packet size must be 1 or more (is %d)\n", pkt_len);
330 printf("Number of segments must be 1 or more (is %d)\n",
335 t_len = pkt_len >= nb_segs ? (pkt_len / nb_segs +
336 !!(pkt_len % nb_segs)) : 1;
339 /* Create chained mbuf_src and fill it with buf data */
340 for (i = 0; size > 0; i++) {
342 m = rte_pktmbuf_alloc(mbuf_pool);
347 printf("Cannot create segment for source mbuf");
351 data_len = size > t_len ? t_len : size;
352 memset(rte_pktmbuf_mtod(m, uint8_t *), 0,
353 rte_pktmbuf_tailroom(m));
354 memcpy(rte_pktmbuf_mtod(m, uint8_t *), src, data_len);
355 dst = (uint8_t *)rte_pktmbuf_append(m, data_len);
357 printf("Cannot append %d bytes to the mbuf\n",
363 rte_pktmbuf_chain(mbuf, m);
372 rte_pktmbuf_free(mbuf);
377 run_regex(void *args)
379 struct regex_conf *rgxc = args;
380 uint32_t nb_jobs = rgxc->nb_jobs;
381 uint32_t nb_segs = rgxc->nb_segs;
382 uint32_t nb_iterations = rgxc->nb_iterations;
383 uint8_t nb_max_matches = rgxc->nb_max_matches;
384 uint32_t nb_qps = rgxc->nb_qps;
385 uint16_t qp_id_base = rgxc->qp_id_base;
386 char *data_buf = rgxc->data_buf;
387 long data_len = rgxc->data_len;
388 long job_len = rgxc->job_len;
391 uint32_t actual_jobs = 0;
396 struct rte_regexdev_match *match;
398 unsigned long d_ind = 0;
399 struct rte_mbuf_ext_shared_info shinfo;
402 struct rte_mempool *mbuf_mp;
403 struct qp_params *qp;
404 struct qp_params *qps = NULL;
406 uint16_t qps_used = 0;
409 shinfo.free_cb = extbuf_free_cb;
412 "mbuf_pool_%2u", qp_id_base);
413 mbuf_mp = rte_pktmbuf_pool_create(mbuf_pool,
414 rte_align32pow2(nb_jobs * nb_qps * nb_segs),
415 0, 0, (nb_segs == 1) ? MBUF_SIZE :
416 (rte_align32pow2(job_len) / nb_segs +
417 RTE_PKTMBUF_HEADROOM),
419 if (mbuf_mp == NULL) {
420 printf("Error, can't create memory pool\n");
424 qps = rte_malloc(NULL, sizeof(*qps) * nb_qps, 0);
426 printf("Error, can't allocate memory for QPs\n");
431 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
432 struct rte_regex_ops **ops;
433 struct job_ctx *jobs_ctx;
439 qp->ops = ops = rte_malloc(NULL, sizeof(*ops) * nb_jobs, 0);
441 printf("Error, can't allocate memory for ops.\n");
446 qp->jobs_ctx = jobs_ctx =
447 rte_malloc(NULL, sizeof(*jobs_ctx) * nb_jobs, 0);
449 printf("Error, can't allocate memory for jobs_ctx.\n");
454 if (clone_buf(data_buf, &buf, data_len)) {
455 printf("Error, can't clone buf.\n");
460 /* Assign each mbuf with the data to handle. */
463 /* Allocate the jobs and assign each job with an mbuf. */
464 for (i = 0; (pos < data_len) && (i < nb_jobs) ; i++) {
465 long act_job_len = RTE_MIN(job_len, data_len - pos);
467 ops[i] = rte_malloc(NULL, sizeof(*ops[0]) +
469 sizeof(struct rte_regexdev_match), 0);
471 printf("Error, can't allocate "
477 ops[i]->mbuf = regex_create_segmented_mbuf
478 (mbuf_mp, act_job_len,
481 ops[i]->mbuf = rte_pktmbuf_alloc(mbuf_mp);
483 rte_pktmbuf_attach_extbuf(ops[i]->mbuf,
484 &buf[pos], 0, act_job_len, &shinfo);
485 ops[i]->mbuf->data_len = job_len;
486 ops[i]->mbuf->pkt_len = act_job_len;
490 printf("Error, can't add mbuf.\n");
495 jobs_ctx[i].mbuf = ops[i]->mbuf;
497 ops[i]->group_id0 = 1;
503 qp->total_matches = 0;
508 for (i = 0; i < nb_iterations; i++) {
509 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
511 qp->total_enqueue = 0;
512 qp->total_dequeue = 0;
516 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
518 if (qp->total_dequeue < actual_jobs) {
519 qp->start = rte_rdtsc_precise();
520 struct rte_regex_ops **
521 cur_ops_to_enqueue = qp->ops +
524 if (actual_jobs - qp->total_enqueue)
526 rte_regexdev_enqueue_burst
534 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
536 if (qp->total_dequeue < actual_jobs) {
537 struct rte_regex_ops **
538 cur_ops_to_dequeue = qp->ops +
542 rte_regexdev_dequeue_burst
549 (rte_rdtsc_precise() - qp->start);
555 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
557 time = (long double)qp->cycles / rte_get_timer_hz();
558 printf("Core=%u QP=%u Job=%ld Bytes Time=%Lf sec Perf=%Lf "
559 "Gbps\n", rte_lcore_id(), qp_id + qp_id_base,
561 (((double)actual_jobs * job_len * nb_iterations * 8)
562 / time) / 1000000000.0);
567 for (qp_id = 0; qp_id < nb_qps; qp_id++) {
568 printf("\n############ Core=%u QP=%u ############\n",
569 rte_lcore_id(), qp_id + qp_id_base);
571 /* Log results per job. */
572 for (d_ind = 0; d_ind < qp->total_dequeue; d_ind++) {
573 nb_matches = qp->ops[d_ind % actual_jobs]->nb_matches;
574 printf("Job id %"PRIu64" number of matches = %d\n",
575 qp->ops[d_ind]->user_id, nb_matches);
576 qp->total_matches += nb_matches;
577 match = qp->ops[d_ind % actual_jobs]->matches;
578 for (i = 0; i < nb_matches; i++) {
579 printf("match %d, rule = %d, "
580 "start = %d,len = %d\n",
581 i, match->rule_id, match->start_offset,
586 printf("Total matches = %d\n", qp->total_matches);
587 printf("All Matches:\n");
588 /* Log absolute results. */
589 for (d_ind = 0; d_ind < qp->total_dequeue; d_ind++) {
590 nb_matches = qp->ops[d_ind % actual_jobs]->nb_matches;
591 qp->total_matches += nb_matches;
592 match = qp->ops[d_ind % actual_jobs]->matches;
593 for (i = 0; i < nb_matches; i++) {
594 printf("start = %ld, len = %d, rule = %d\n",
595 match->start_offset +
597 match->len, match->rule_id);
603 for (qp_id = 0; qp_id < qps_used; qp_id++) {
605 for (i = 0; i < actual_jobs && qp->ops; i++)
606 rte_free(qp->ops[i]);
609 for (i = 0; i < actual_jobs && qp->jobs_ctx; i++)
610 rte_pktmbuf_free(qp->jobs_ctx[i].mbuf);
611 rte_free(qp->jobs_ctx);
617 rte_mempool_free(mbuf_mp);
623 distribute_qps_to_lcores(uint32_t nb_cores, uint32_t nb_qps,
624 struct qps_per_lcore **qpl)
631 struct qps_per_lcore *qps_per_lcore;
632 uint32_t detected_lcores;
634 if (nb_qps < nb_cores) {
636 printf("Reducing number of cores to number of QPs (%u)\n",
639 /* Allocate qps_per_lcore array */
641 rte_malloc(NULL, sizeof(*qps_per_lcore) * nb_cores, 0);
643 rte_exit(EXIT_FAILURE, "Failed to create qps_per_lcore array\n");
644 *qpl = qps_per_lcore;
648 RTE_LCORE_FOREACH_WORKER(lcore_id) {
649 if (detected_lcores >= nb_cores)
651 qps_per_lcore[detected_lcores].lcore_id = lcore_id;
652 socket = rte_lcore_to_socket_id(lcore_id);
653 if (socket == SOCKET_ID_ANY)
655 qps_per_lcore[detected_lcores].socket = socket;
656 qps_per_lcore[detected_lcores].qp_id_base = min_qp_id;
657 max_qp_id = min_qp_id + nb_qps / nb_cores - 1;
658 if (nb_qps % nb_cores > detected_lcores)
660 qps_per_lcore[detected_lcores].nb_qps = max_qp_id -
662 min_qp_id = max_qp_id + 1;
665 if (detected_lcores != nb_cores)
668 for (i = 0; i < detected_lcores; i++) {
669 printf("===> Core %d: allocated queues: ",
670 qps_per_lcore[i].lcore_id);
671 min_qp_id = qps_per_lcore[i].qp_id_base;
673 qps_per_lcore[i].qp_id_base + qps_per_lcore[i].nb_qps;
674 while (min_qp_id < max_qp_id) {
675 printf("%u ", min_qp_id);
684 main(int argc, char **argv)
686 char rules_file[MAX_FILE_NAME];
687 char data_file[MAX_FILE_NAME];
688 uint32_t nb_jobs = 0;
690 uint32_t nb_iterations = 0;
692 uint16_t nb_max_payload = 0;
693 uint8_t nb_max_matches = 0;
698 uint32_t nb_lcores = 1, nb_segs = 1;
699 struct regex_conf *rgxc;
701 struct qps_per_lcore *qps_per_lcore;
704 ret = rte_eal_init(argc, argv);
706 rte_exit(EXIT_FAILURE, "EAL init failed\n");
710 args_parse(argc, argv, rules_file, data_file, &nb_jobs,
711 &perf_mode, &nb_iterations, &nb_qps,
712 &nb_lcores, &nb_segs);
715 rte_exit(EXIT_FAILURE, "Number of QPs must be greater than 0\n");
717 rte_exit(EXIT_FAILURE, "Number of lcores must be greater than 0\n");
718 if (distribute_qps_to_lcores(nb_lcores, nb_qps, &qps_per_lcore) < 0)
719 rte_exit(EXIT_FAILURE, "Failed to distribute queues to lcores!\n");
720 ret = init_port(&nb_max_payload, rules_file,
721 &nb_max_matches, nb_qps);
723 rte_exit(EXIT_FAILURE, "init port failed\n");
725 data_len = read_file(data_file, &data_buf);
727 rte_exit(EXIT_FAILURE, "Error, can't read file, or file is empty.\n");
729 job_len = data_len / nb_jobs;
731 rte_exit(EXIT_FAILURE, "Error, To many jobs, for the given input.\n");
733 if (job_len > nb_max_payload)
734 rte_exit(EXIT_FAILURE, "Error, not enough jobs to cover input.\n");
736 rgxc = rte_malloc(NULL, sizeof(*rgxc) * nb_lcores, 0);
738 rte_exit(EXIT_FAILURE, "Failed to create Regex Conf\n");
739 for (i = 0; i < nb_lcores; i++) {
740 rgxc[i] = (struct regex_conf){
743 .perf_mode = perf_mode,
744 .nb_iterations = nb_iterations,
745 .nb_max_matches = nb_max_matches,
746 .nb_qps = qps_per_lcore[i].nb_qps,
747 .qp_id_base = qps_per_lcore[i].qp_id_base,
748 .data_buf = data_buf,
749 .data_len = data_len,
752 rte_eal_remote_launch(run_regex, &rgxc[i],
753 qps_per_lcore[i].lcore_id);
755 rte_eal_mp_wait_lcore();
758 rte_free(qps_per_lcore);