DOCA Documentation v1.5.0 LTS

RegEx Samples

NVIDIA DOCA RegEx Sample Guide

This document provides RegEx sample implementation on top of NVIDIA® BlueField® DPU.

BlueField DPU supports high-speed hardware regular expression (RegEx) acceleration. This allows accelerating different security and networking applications which require RegEx processing.

This document describes RegEx samples based on the DOCA RegEx library. These samples illustrate how to use the DOCA RegEx API to configure, send, and receive data buffers to and from the BlueField RegEx engine. Processing the data to detect matches requires compilation of regular expressions rules file. The compiled file (.ROF2) is loaded to the RegEx engine using DOCA RegEx APIs.

For more information about DOCA RegEx library, refer to NVIDIA DOCA RegEx Programming Guide.

Developing an application that leverages the RegEx engine requires pre-run setup:

  1. Allocate hugepages:
    Copy
    Copied!
                

    sudo echo 2048 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages

  2. Make sure the RegEx engine is active:
    Copy
    Copied!
                

    systemctl status mlx-regex

    If the status is inactive (Active: failed), run:
    Copy
    Copied!
                

    systemctl start mlx-regex


To run the application, the RegEx compiled rule file (.rof2.binary) must be supplied with it. To compile the sample rules file, run:

Copy
Copied!
            

cd /opt/mellanox/doca/samples/doca_regex/<sample_name>/ rxpc -f <rules_file_name>.txt -p 0.01 -o /tmp/sample_regex_rules

Note:

For more information, refer to NVIDIA RXP Compiler.

  1. Refer to the following documents:
  2. To build a given sample:
    Copy
    Copied!
                

    cd /opt/mellanox/doca/samples/doca_regex/<sample_name> meson build ninja -C build

    Note:

    The binary doca_<sample_name> will be created under ./build/.

  3. Sample (e.g., regex_scan) usage:
    Copy
    Copied!
                

    Usage: doca_regex_scan [DOCA Flags] [Program Flags] DOCA Flags: -h, --help Print a help synopsis -v, --version Print program version information -l, --log-level Set the log level for the program <CRITICAL=20, ERROR=30, WARNING=40, INFO=50, DEBUG=60> Program Flags: -p, --pci-addr <PCI-ADDRESS> RegEx device PCI address -r, --rules <path> Path to compiled rules file (rof2.binary) -d, --data <path> Path to data file

    For additional information per sample, use the -h option:
    Copy
    Copied!
                

    ./build/doca_<sample_name> -h


5.1. RegEx Scan

This sample illustrates how to scan data to find matches according to regular expression patterns. The sample logic includes:

  1. Accepting RegEx rules file path and data to scan.
  2. Configuring DOCA RegEx device (loading compiled rules, mempool allocation, etc.) to enable RegEx engine to receive jobs.
  3. Splitting the user data to 6 chunks.
  4. Sending the chunks to RegEx engine, each chunk is a RegEx job.
  5. HW scanning data and returning a list of matches.
  6. Reporting the results.

References:

  • /opt/mellanox/doca/samples/doca_regex/regex_scan/regex_scan_sample.c
  • /opt/mellanox/doca/samples/doca_regex/regex_scan/regex_scan_main.c
  • /opt/mellanox/doca/samples/doca_regex/regex_scan/meson.build
  • /opt/mellanox/doca/samples/doca_regex/regex_scan/regex_rules.txt
  • /opt/mellanox/doca/samples/doca_regex/regex_scan/data_to_scan.txt

Notice

This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIA Corporation nor any of its direct or indirect subsidiaries and affiliates (collectively: “NVIDIA”) make no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in this document and assume no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for any infringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material (defined below), code, or functionality.

NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.

Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.

NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreed in an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying any customer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formed either directly or indirectly by this document.

NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applications where failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIA accepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.

NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document, ensure the product is suitable and fit for the application planned by customer, and perform the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this document. NVIDIA accepts no liability related to any default, damage, costs, or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this document or (ii) customer product designs.

No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document. Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party, or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.

Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliance with all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.

THIS DOCUMENT AND ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the products described herein shall be limited in accordance with the Terms of Sale for the product.

Trademarks

NVIDIA, the NVIDIA logo, and Mellanox are trademarks and/or registered trademarks of Mellanox Technologies Ltd. and/or NVIDIA Corporation in the U.S. and in other countries. The registered trademark Linux® is used pursuant to a sublicense from the Linux Foundation, the exclusive licensee of Linus Torvalds, owner of the mark on a world¬wide basis. Other company and product names may be trademarks of the respective companies with which they are associated.

Copyright

© 2022 NVIDIA Corporation & affiliates. All rights reserved.

© Copyright 2023, NVIDIA. Last updated on Nov 7, 2022.