FM / html

/usr/share/doc/pcre2-devel/html

Name	Size	Mode	Actions
index.html	13696	0644	edit dl rm
NON-AUTOTOOLS-BUILD.txt	17762	0644	edit dl rm
pcre2-config.html	3498	0644	edit dl rm
pcre2.html	9575	0644	edit dl rm
pcre2api.html	171917	0644	edit dl rm
pcre2build.html	24793	0644	edit dl rm
pcre2callout.html	20058	0644	edit dl rm
pcre2compat.html	10297	0644	edit dl rm
pcre2convert.html	7884	0644	edit dl rm
pcre2demo.html	20164	0644	edit dl rm
pcre2grep.html	48111	0644	edit dl rm
pcre2jit.html	20036	0644	edit dl rm
pcre2limits.html	3257	0644	edit dl rm
pcre2matching.html	10863	0644	edit dl rm
pcre2partial.html	20826	0644	edit dl rm
pcre2pattern.html	155879	0644	edit dl rm
pcre2perform.html	11852	0644	edit dl rm
pcre2posix.html	14502	0644	edit dl rm
pcre2sample.html	3905	0644	edit dl rm
pcre2serialize.html	10082	0644	edit dl rm
pcre2syntax.html	20478	0644	edit dl rm
pcre2test.html	87053	0644	edit dl rm
pcre2unicode.html	12150	0644	edit dl rm
pcre2_callout_enumerate.html	2431	0644	edit dl rm
pcre2_code_copy.html	1370	0644	edit dl rm
pcre2_code_copy_with_tables.html	1491	0644	edit dl rm
pcre2_code_free.html	1243	0644	edit dl rm
pcre2_compile.html	4318	0644	edit dl rm
pcre2_compile_context_copy.html	1176	0644	edit dl rm
pcre2_compile_context_create.html	1271	0644	edit dl rm
pcre2_compile_context_free.html	1233	0644	edit dl rm
pcre2_config.html	3575	0644	edit dl rm
pcre2_converted_pattern_free.html	1249	0644	edit dl rm
pcre2_convert_context_copy.html	1157	0644	edit dl rm
pcre2_convert_context_create.html	1251	0644	edit dl rm
pcre2_convert_context_free.html	1214	0644	edit dl rm
pcre2_dfa_match.html	3499	0644	edit dl rm
pcre2_general_context_copy.html	1225	0644	edit dl rm
pcre2_general_context_create.html	1486	0644	edit dl rm
pcre2_general_context_free.html	1172	0644	edit dl rm
pcre2_get_error_message.html	1745	0644	edit dl rm
pcre2_get_mark.html	1505	0644	edit dl rm
pcre2_get_ovector_count.html	1072	0644	edit dl rm
pcre2_get_ovector_pointer.html	1148	0644	edit dl rm
pcre2_get_startchar.html	1430	0644	edit dl rm
pcre2_jit_compile.html	1843	0644	edit dl rm
pcre2_jit_free_unused_memory.html	1327	0644	edit dl rm
pcre2_jit_match.html	2039	0644	edit dl rm
pcre2_jit_stack_assign.html	2562	0644	edit dl rm
pcre2_jit_stack_create.html	1725	0644	edit dl rm
pcre2_jit_stack_free.html	1223	0644	edit dl rm
pcre2_maketables.html	1653	0644	edit dl rm
pcre2_match.html	3577	0644	edit dl rm
pcre2_match_context_copy.html	1164	0644	edit dl rm
pcre2_match_context_create.html	1261	0644	edit dl rm
pcre2_match_context_free.html	1223	0644	edit dl rm
pcre2_match_data_create.html	1623	0644	edit dl rm
pcre2_match_data_create_from_pattern.html	1740	0644	edit dl rm
pcre2_match_data_free.html	1239	0644	edit dl rm
pcre2_pattern_convert.html	2663	0644	edit dl rm
pcre2_pattern_info.html	4801	0644	edit dl rm
pcre2_serialize_decode.html	2547	0644	edit dl rm
pcre2_serialize_encode.html	2721	0644	edit dl rm
pcre2_serialize_free.html	1187	0644	edit dl rm
pcre2_serialize_get_number_of_codes.html	1634	0644	edit dl rm
pcre2_set_bsr.html	1199	0644	edit dl rm
pcre2_set_callout.html	1276	0644	edit dl rm
pcre2_set_character_tables.html	1235	0644	edit dl rm
pcre2_set_compile_extra_options.html	1513	0644	edit dl rm
pcre2_set_compile_recursion_guard.html	1664	0644	edit dl rm
pcre2_set_depth_limit.html	1080	0644	edit dl rm
pcre2_set_glob_escape.html	1365	0644	edit dl rm
pcre2_set_glob_separator.html	1336	0644	edit dl rm
pcre2_set_heap_limit.html	1076	0644	edit dl rm
pcre2_set_match_limit.html	1067	0644	edit dl rm
pcre2_set_max_pattern_length.html	1336	0644	edit dl rm
pcre2_set_newline.html	1566	0644	edit dl rm
pcre2_set_offset_limit.html	1073	0644	edit dl rm
pcre2_set_parens_nest_limit.html	1122	0644	edit dl rm
pcre2_set_recursion_limit.html	1097	0644	edit dl rm
pcre2_set_recursion_memory_management.html	1245	0644	edit dl rm
pcre2_substitute.html	4084	0644	edit dl rm
pcre2_substring_copy_byname.html	2059	0644	edit dl rm
pcre2_substring_copy_bynumber.html	1860	0644	edit dl rm
pcre2_substring_free.html	1196	0644	edit dl rm
pcre2_substring_get_byname.html	2187	0644	edit dl rm
pcre2_substring_get_bynumber.html	2023	0644	edit dl rm
pcre2_substring_length_byname.html	1364	0644	edit dl rm
pcre2_substring_length_bynumber.html	1518	0644	edit dl rm
pcre2_substring_list_free.html	1211	0644	edit dl rm
pcre2_substring_list_get.html	2136	0644	edit dl rm
pcre2_substring_nametable_scan.html	1845	0644	edit dl rm
pcre2_substring_number_from_name.html	1645	0644	edit dl rm
README.txt	41975	0644	edit dl rm

Edit: /usr/share/doc/pcre2-devel/html/pcre2perform.html (11852B)

<html>
<head>
<title>pcre2perform specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2perform man page</h1>

Return to the <a href="index.html">PCRE2 index page</a>.


This page is part of the PCRE2 HTML documentation. It was generated
automatically from the original man page. If there is any nonsense in it,
please consult the man page, in case the conversion went wrong.
 
<ul>
<li><a name="TOC1" href="#SEC1">PCRE2 PERFORMANCE</a>
<li><a name="TOC2" href="#SEC2">COMPILED PATTERN MEMORY USAGE</a>
<li><a name="TOC3" href="#SEC3">STACK AND HEAP USAGE AT RUN TIME</a>
<li><a name="TOC4" href="#SEC4">PROCESSING TIME</a>
<li><a name="TOC5" href="#SEC5">AUTHOR</a>
<li><a name="TOC6" href="#SEC6">REVISION</a>
</ul>
 <a name="SEC1" href="#TOC1">PCRE2 PERFORMANCE</a> 

Two aspects of performance are discussed below: memory usage and processing
time. The way you express your pattern as a regular expression can affect both
of them.

 <a name="SEC2" href="#TOC1">COMPILED PATTERN MEMORY USAGE</a> 

Patterns are compiled by PCRE2 into a reasonably efficient interpretive code,
so that most simple patterns do not use much memory for storing the compiled
version. However, there is one case where the memory usage of a compiled
pattern can be unexpectedly large. If a parenthesized subpattern has a
quantifier with a minimum greater than 1 and/or a limited maximum, the whole
subpattern is repeated in the compiled code. For example, the pattern
<pre>
 (abc|def){2,4}
</pre>
is compiled as if it were
<pre>
 (abc|def)(abc|def)((abc|def)(abc|def)?)?
</pre>
(Technical aside: It is done this way so that backtrack points within each of
the repetitions can be independently maintained.)


For regular expressions whose quantifiers use only small numbers, this is not
usually a problem. However, if the numbers are large, and particularly if such
repetitions are nested, the memory usage can become an embarrassment. For
example, the very simple pattern
<pre>
 ((ab){1,1000}c){1,3}
</pre>
uses over 50KiB when compiled using the 8-bit library. When PCRE2 is
compiled with its default internal pointer size of two bytes, the size limit on
a compiled pattern is 65535 code units in the 8-bit and 16-bit libraries, and
this is reached with the above pattern if the outer repetition is increased
from 3 to 4. PCRE2 can be compiled to use larger internal pointers and thus
handle larger compiled patterns, but it is better to try to rewrite your
pattern to use less memory if you can.


One way of reducing the memory usage for such patterns is to make use of
PCRE2's
<a href="pcre2pattern.html#subpatternsassubroutines">"subroutine"</a>
facility. Re-writing the above pattern as
<pre>
 ((ab)(?2){0,999}c)(?1){0,2}
</pre>
reduces the memory requirements to around 16KiB, and indeed it remains under
20KiB even with the outer repetition increased to 100. However, this kind of
pattern is not always exactly equivalent, because any captures within
subroutine calls are lost when the subroutine completes. If this is not a
problem, this kind of rewriting will allow you to process patterns that PCRE2
cannot otherwise handle. The matching performance of the two different versions
of the pattern are roughly the same. (This applies from release 10.30 - things
were different in earlier releases.)

 <a name="SEC3" href="#TOC1">STACK AND HEAP USAGE AT RUN TIME</a> 

From release 10.30, the interpretive (non-JIT) version of pcre2_match()
uses very little system stack at run time. In earlier releases recursive
function calls could use a great deal of stack, and this could cause problems,
but this usage has been eliminated. Backtracking positions are now explicitly
remembered in memory frames controlled by the code. An initial 20KiB vector of
frames is allocated on the system stack (enough for about 100 frames for small
patterns), but if this is insufficient, heap memory is used. The amount of heap
memory can be limited; if the limit is set to zero, only the initial stack
vector is used. Rewriting patterns to be time-efficient, as described below,
may also reduce the memory requirements.


In contrast to pcre2_match(), pcre2_dfa_match() does use recursive
function calls, but only for processing atomic groups, lookaround assertions,
and recursion within the pattern. The original version of the code used to
allocate quite large internal workspace vectors on the stack, which caused some
problems for some patterns in environments with small stacks. From release
10.32 the code for pcre2_dfa_match() has been re-factored to use heap
memory when necessary for internal workspace when recursing, though recursive
function calls are still used.


The "match depth" parameter can be used to limit the depth of function
recursion, and the "match heap" parameter to limit heap memory in
pcre2_dfa_match().

 <a name="SEC4" href="#TOC1">PROCESSING TIME</a> 

Certain items in regular expression patterns are processed more efficiently
than others. It is more efficient to use a character class like [aeiou] than a
set of single-character alternatives such as (a|e|i|o|u). In general, the
simplest construction that provides the required behaviour is usually the most
efficient. Jeffrey Friedl's book contains a lot of useful general discussion
about optimizing regular expressions for efficient performance. This document
contains a few observations about PCRE2.


Using Unicode character properties (the \p, \P, and \X escapes) is slow,
because PCRE2 has to use a multi-stage table lookup whenever it needs a
character's property. If you can find an alternative pattern that does not use
character properties, it will probably be faster.


By default, the escape sequences \b, \d, \s, and \w, and the POSIX
character classes such as [:alpha:] do not use Unicode properties, partly for
backwards compatibility, and partly for performance reasons. However, you can
set the PCRE2_UCP option or start the pattern with (*UCP) if you want Unicode
character properties to be used. This can double the matching time for items
such as \d, when matched with pcre2_match(); the performance loss is
less with a DFA matching function, and in both cases there is not much
difference for \b.


When a pattern begins with .* not in atomic parentheses, nor in parentheses
that are the subject of a backreference, and the PCRE2_DOTALL option is set,
the pattern is implicitly anchored by PCRE2, since it can match only at the
start of a subject string. If the pattern has multiple top-level branches, they
must all be anchorable. The optimization can be disabled by the
PCRE2_NO_DOTSTAR_ANCHOR option, and is automatically disabled if the pattern
contains (*PRUNE) or (*SKIP).


If PCRE2_DOTALL is not set, PCRE2 cannot make this optimization, because the
dot metacharacter does not then match a newline, and if the subject string
contains newlines, the pattern may match from the character immediately
following one of them instead of from the very start. For example, the pattern
<pre>
 .*second
</pre>
matches the subject "first\nand second" (where \n stands for a newline
character), with the match starting at the seventh character. In order to do
this, PCRE2 has to retry the match starting after every newline in the subject.


If you are using such a pattern with subject strings that do not contain
newlines, the best performance is obtained by setting PCRE2_DOTALL, or starting
the pattern with ^.* or ^.*? to indicate explicit anchoring. That saves PCRE2
from having to scan along the subject looking for a newline to restart at.


Beware of patterns that contain nested indefinite repeats. These can take a
long time to run when applied to a string that does not match. Consider the
pattern fragment
<pre>
 ^(a+)*
</pre>
This can match "aaaa" in 16 different ways, and this number increases very
rapidly as the string gets longer. (The * repeat can match 0, 1, 2, 3, or 4
times, and for each of those cases other than 0 or 4, the + repeats can match
different numbers of times.) When the remainder of the pattern is such that the
entire match is going to fail, PCRE2 has in principle to try every possible
variation, and this can take an extremely long time, even for relatively short
strings.


An optimization catches some of the more simple cases such as
<pre>
 (a+)*b
</pre>
where a literal character follows. Before embarking on the standard matching
procedure, PCRE2 checks that there is a "b" later in the subject string, and if
there is not, it fails the match immediately. However, when there is no
following literal this optimization cannot be used. You can see the difference
by comparing the behaviour of
<pre>
 (a+)*\d
</pre>
with the pattern above. The former gives a failure almost instantly when
applied to a whole line of "a" characters, whereas the latter takes an
appreciable time with strings longer than about 20 characters.


In many cases, the solution to this kind of performance issue is to use an
atomic group or a possessive quantifier. This can often reduce memory
requirements as well. As another example, consider this pattern:
<pre>
 ([^&#60;]|&#60;(?!inet))+
</pre>
It matches from wherever it starts until it encounters "&#60;inet" or the end of
the data, and is the kind of pattern that might be used when processing an XML
file. Each iteration of the outer parentheses matches either one character that
is not "&#60;" or a "&#60;" that is not followed by "inet". However, each time a
parenthesis is processed, a backtracking position is passed, so this
formulation uses a memory frame for each matched character. For a long string,
a lot of memory is required. Consider now this rewritten pattern, which matches
exactly the same strings:
<pre>
 ([^&#60;]++|&#60;(?!inet))+
</pre>
This runs much faster, because sequences of characters that do not contain "&#60;"
are "swallowed" in one item inside the parentheses, and a possessive quantifier
is used to stop any backtracking into the runs of non-"&#60;" characters. This
version also uses a lot less memory because entry to a new set of parentheses
happens only when a "&#60;" character that is not followed by "inet" is encountered
(and we assume this is relatively rare).


This example shows that one way of optimizing performance when matching long
subject strings is to write repeated parenthesized subpatterns to match more
than one character whenever possible.

 
SETTING RESOURCE LIMITS
 

You can set limits on the amount of processing that takes place when matching,
and on the amount of heap memory that is used. The default values of the limits
are very large, and unlikely ever to operate. They can be changed when PCRE2 is
built, and they can also be set when pcre2_match() or
pcre2_dfa_match() is called. For details of these interfaces, see the
<a href="pcre2build.html">pcre2build</a>
documentation and the section entitled
<a href="pcre2api.html#matchcontext">"The match context"</a>
in the
<a href="pcre2api.html">pcre2api</a>
documentation.


The pcre2test test program has a modifier called "find_limits" which, if
applied to a subject line, causes it to find the smallest limits that allow a
pattern to match. This is done by repeatedly matching with different limits.

 <a name="SEC5" href="#TOC1">AUTHOR</a> 

Philip Hazel
 
University Computing Service
 
Cambridge, England.
 

 <a name="SEC6" href="#TOC1">REVISION</a> 

Last updated: 25 April 2018
 
Copyright &copy; 1997-2018 University of Cambridge.
 

Return to the <a href="index.html">PCRE2 index page</a>.

cmd: