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