xref: /dpdk/doc/guides/regexdevs/features_overview.rst (revision 7be78d027918dbc846e502780faf94d5acdf5f75)
1cf9b3c36SYuval Avnery.. SPDX-License-Identifier: BSD-3-Clause
2cf9b3c36SYuval Avnery   Copyright 2020 Mellanox Technologies, Ltd
3cf9b3c36SYuval Avnery
4cf9b3c36SYuval AvneryOverview of RegEx Drivers Features
5cf9b3c36SYuval Avnery==================================
6cf9b3c36SYuval Avnery
7cf9b3c36SYuval AvneryThis section explains the supported features that are listed in the table below.
8cf9b3c36SYuval Avnery
9cf9b3c36SYuval AvneryCross buffer
10cf9b3c36SYuval Avnery  Support cross buffer detection.
11cf9b3c36SYuval Avnery
12cf9b3c36SYuval AvneryPCRE start anchor
13cf9b3c36SYuval Avnery  Support PCRE start anchor.
14cf9b3c36SYuval Avnery
15cf9b3c36SYuval AvneryPCRE atomic grouping
16cf9b3c36SYuval Avnery  Support PCRE atomic grouping.
17cf9b3c36SYuval Avnery
18cf9b3c36SYuval AvneryPCRE back reference
199c30a6f3SHenry Nadeau  Support PCRE back reference.
20cf9b3c36SYuval Avnery
21cf9b3c36SYuval AvneryPCRE back tracking ctrl
22cf9b3c36SYuval Avnery  Support PCRE back tracking ctrl.
23cf9b3c36SYuval Avnery
24cf9b3c36SYuval AvneryPCRE call outs
25*7be78d02SJosh Soref  Support PCRE call routes.
26cf9b3c36SYuval Avnery
27cf9b3c36SYuval AvneryPCRE forward reference
28cf9b3c36SYuval Avnery  Support Forward reference.
29cf9b3c36SYuval Avnery
30cf9b3c36SYuval AvneryPCRE greedy
31cf9b3c36SYuval Avnery  Support PCRE greedy mode.
32cf9b3c36SYuval Avnery
33cf9b3c36SYuval AvneryPCRE match all
34cf9b3c36SYuval Avnery  Support PCRE match all.
35cf9b3c36SYuval Avnery
36cf9b3c36SYuval AvneryPCRE match as end
37cf9b3c36SYuval Avnery  Support match as end.
38cf9b3c36SYuval Avnery
39cf9b3c36SYuval AvneryPCRE match point rst
40cf9b3c36SYuval Avnery  Support PCRE match point reset directive.
41cf9b3c36SYuval Avnery
42cf9b3c36SYuval AvneryPCRE New line conventions
43cf9b3c36SYuval Avnery  Support new line conventions.
44cf9b3c36SYuval Avnery
45cf9b3c36SYuval AvneryPCRE new line SEQ
46cf9b3c36SYuval Avnery  Support new line sequence.
47cf9b3c36SYuval Avnery
48cf9b3c36SYuval AvneryPCRE look around
49cf9b3c36SYuval Avnery  Support PCRE look around.
50cf9b3c36SYuval Avnery
51cf9b3c36SYuval AvneryPCRE possessive qualifiers
52cf9b3c36SYuval Avnery  Support PCRE possessive qualifiers.
53cf9b3c36SYuval Avnery
54cf9b3c36SYuval AvneryPCRE subroutine references
55cf9b3c36SYuval Avnery  Support PCRE subroutine references.
56cf9b3c36SYuval Avnery
57cf9b3c36SYuval AvneryPCRE UTF 8
58cf9b3c36SYuval Avnery  Support UTF-8.
59cf9b3c36SYuval Avnery
60cf9b3c36SYuval AvneryPCRE UTF 16
61cf9b3c36SYuval Avnery  Support UTF-16.
62cf9b3c36SYuval Avnery
63cf9b3c36SYuval AvneryPCRE UTF 32
64cf9b3c36SYuval Avnery  Support UTF-32.
65cf9b3c36SYuval Avnery
66cf9b3c36SYuval AvneryPCRE word boundary
67cf9b3c36SYuval Avnery  Support word boundaries.
68cf9b3c36SYuval Avnery
69cf9b3c36SYuval AvneryRun time compilation
70cf9b3c36SYuval Avnery  Support compilation during run time.
71cf9b3c36SYuval Avnery
72cf9b3c36SYuval AvneryArmv8
73cf9b3c36SYuval Avnery  Support armv8 (64bit) architecture.
74cf9b3c36SYuval Avnery
75cf9b3c36SYuval Avneryx86
76cf9b3c36SYuval Avnery  Support x86 architecture.
77cf9b3c36SYuval Avnery
78cf9b3c36SYuval Avnery.. note::
79cf9b3c36SYuval Avnery
80cf9b3c36SYuval Avnery   Most of the features capabilities should be provided by the drivers via the
81cf9b3c36SYuval Avnery   RegEx ``info_get`` operation.
82cf9b3c36SYuval Avnery
83cf9b3c36SYuval Avnery
84cf9b3c36SYuval AvneryReferences
85cf9b3c36SYuval Avnery==========
86cf9b3c36SYuval Avnery
87cf9b3c36SYuval Avnery  * `PCRE: PCRE pattern man page <https://www.pcre.org/original/doc/html/pcrepattern.html>`_
88cf9b3c36SYuval Avnery
89cf9b3c36SYuval Avnery
90cf9b3c36SYuval AvneryFeatures Table
91cf9b3c36SYuval Avnery==============
92cf9b3c36SYuval Avnery
93cf9b3c36SYuval Avnery.. _table_regex_pmd_features:
94cf9b3c36SYuval Avnery
95cf9b3c36SYuval Avnery.. include:: overview_feature_table.txt
96cf9b3c36SYuval Avnery
97cf9b3c36SYuval Avnery.. Note::
98cf9b3c36SYuval Avnery
99cf9b3c36SYuval Avnery   Features marked with "P" are partially supported. Refer to the appropriate
100cf9b3c36SYuval Avnery   driver guide in the following sections for details.
101