1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 Mellanox Technologies, Ltd
7 The ``dpdk-test-regex`` tool is a Data Plane Development Kit (DPDK)
8 application that allows functional testing and performance measurement for
10 The test supports only one core and one PMD.
11 It is based on precompiled rule file, and an input file, both of them can
12 be selected using command-line options.
14 In general case, each PMD has its own rule file.
16 The test outputs the following data:
18 * Performance, in gigabit per second.
20 * Matching results (rule id, position, length), for each job.
22 * Matching results in absolute location (rule id, position , length),
23 relative to the start of the input data.
29 * Only one queue is supported.
31 * Supports only precompiled rules.
47 only outputs the performance data
50 number of iteration to run
53 print application options
59 **Step 1: Compile a rule file**
61 In order for the RegEx to work it must have a precompiled rule file.
62 to generate this file there is a need to use a RegEx compiler that matches the
65 **Step 2: Generate a data file**
67 The data file, will be used as a source data for the RegEx to work on.
69 **Step 3: Run the tool**
71 The tool has a number of command line options. Here is the sample command line::
73 ./dpdk-test-regex -w 83:00.0 -- --rules rule_file.rof2 --data data_file.txt --job 100