src/external/pcre2-10.32/doc/html/pcre2perform.html

   1 <html>
   2 <head>
   3 <title>pcre2perform specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2perform man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE2 index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE2 HTML documentation. It was generated
  12 automatically from the original man page. If there is any nonsense in it,
  13 please consult the man page, in case the conversion went wrong.
  14 <br>
  15 <ul>
  16 <li><a name="TOC1" href="#SEC1">PCRE2 PERFORMANCE</a>
  17 <li><a name="TOC2" href="#SEC2">COMPILED PATTERN MEMORY USAGE</a>
  18 <li><a name="TOC3" href="#SEC3">STACK AND HEAP USAGE AT RUN TIME</a>
  19 <li><a name="TOC4" href="#SEC4">PROCESSING TIME</a>
  20 <li><a name="TOC5" href="#SEC5">AUTHOR</a>
  21 <li><a name="TOC6" href="#SEC6">REVISION</a>
  22 </ul>
  23 <br><a name="SEC1" href="#TOC1">PCRE2 PERFORMANCE</a><br>
  24 <P>
  25 Two aspects of performance are discussed below: memory usage and processing
  26 time. The way you express your pattern as a regular expression can affect both
  27 of them.
  28 </P>
  29 <br><a name="SEC2" href="#TOC1">COMPILED PATTERN MEMORY USAGE</a><br>
  30 <P>
  31 Patterns are compiled by PCRE2 into a reasonably efficient interpretive code,
  32 so that most simple patterns do not use much memory for storing the compiled
  33 version. However, there is one case where the memory usage of a compiled
  34 pattern can be unexpectedly large. If a parenthesized subpattern has a
  35 quantifier with a minimum greater than 1 and/or a limited maximum, the whole
  36 subpattern is repeated in the compiled code. For example, the pattern
  37 <pre>
  38   (abc|def){2,4}
  39 </pre>
  40 is compiled as if it were
  41 <pre>
  42   (abc|def)(abc|def)((abc|def)(abc|def)?)?
  43 </pre>
  44 (Technical aside: It is done this way so that backtrack points within each of
  45 the repetitions can be independently maintained.)
  46 </P>
  47 <P>
  48 For regular expressions whose quantifiers use only small numbers, this is not
  49 usually a problem. However, if the numbers are large, and particularly if such
  50 repetitions are nested, the memory usage can become an embarrassment. For
  51 example, the very simple pattern
  52 <pre>
  53   ((ab){1,1000}c){1,3}
  54 </pre>
  55 uses over 50KiB when compiled using the 8-bit library. When PCRE2 is
  56 compiled with its default internal pointer size of two bytes, the size limit on
  57 a compiled pattern is 65535 code units in the 8-bit and 16-bit libraries, and
  58 this is reached with the above pattern if the outer repetition is increased
  59 from 3 to 4. PCRE2 can be compiled to use larger internal pointers and thus
  60 handle larger compiled patterns, but it is better to try to rewrite your
  61 pattern to use less memory if you can.
  62 </P>
  63 <P>
  64 One way of reducing the memory usage for such patterns is to make use of
  65 PCRE2's
  66 <a href="pcre2pattern.html#subpatternsassubroutines">"subroutine"</a>
  67 facility. Re-writing the above pattern as
  68 <pre>
  69   ((ab)(?2){0,999}c)(?1){0,2}
  70 </pre>
  71 reduces the memory requirements to around 16KiB, and indeed it remains under
  72 20KiB even with the outer repetition increased to 100. However, this kind of
  73 pattern is not always exactly equivalent, because any captures within
  74 subroutine calls are lost when the subroutine completes. If this is not a
  75 problem, this kind of rewriting will allow you to process patterns that PCRE2
  76 cannot otherwise handle. The matching performance of the two different versions
  77 of the pattern are roughly the same. (This applies from release 10.30 - things
  78 were different in earlier releases.)
  79 </P>
  80 <br><a name="SEC3" href="#TOC1">STACK AND HEAP USAGE AT RUN TIME</a><br>
  81 <P>
  82 From release 10.30, the interpretive (non-JIT) version of <b>pcre2_match()</b>
  83 uses very little system stack at run time. In earlier releases recursive
  84 function calls could use a great deal of stack, and this could cause problems,
  85 but this usage has been eliminated. Backtracking positions are now explicitly
  86 remembered in memory frames controlled by the code. An initial 20KiB vector of
  87 frames is allocated on the system stack (enough for about 100 frames for small
  88 patterns), but if this is insufficient, heap memory is used. The amount of heap
  89 memory can be limited; if the limit is set to zero, only the initial stack
  90 vector is used. Rewriting patterns to be time-efficient, as described below,
  91 may also reduce the memory requirements.
  92 </P>
  93 <P>
  94 In contrast to <b>pcre2_match()</b>, <b>pcre2_dfa_match()</b> does use recursive
  95 function calls, but only for processing atomic groups, lookaround assertions,
  96 and recursion within the pattern. The original version of the code used to
  97 allocate quite large internal workspace vectors on the stack, which caused some
  98 problems for some patterns in environments with small stacks. From release
  99 10.32 the code for <b>pcre2_dfa_match()</b> has been re-factored to use heap
 100 memory when necessary for internal workspace when recursing, though recursive
 101 function calls are still used.
 102 </P>
 103 <P>
 104 The "match depth" parameter can be used to limit the depth of function
 105 recursion, and the "match heap" parameter to limit heap memory in
 106 <b>pcre2_dfa_match()</b>.
 107 </P>
 108 <br><a name="SEC4" href="#TOC1">PROCESSING TIME</a><br>
 109 <P>
 110 Certain items in regular expression patterns are processed more efficiently
 111 than others. It is more efficient to use a character class like [aeiou] than a
 112 set of single-character alternatives such as (a|e|i|o|u). In general, the
 113 simplest construction that provides the required behaviour is usually the most
 114 efficient. Jeffrey Friedl's book contains a lot of useful general discussion
 115 about optimizing regular expressions for efficient performance. This document
 116 contains a few observations about PCRE2.
 117 </P>
 118 <P>
 119 Using Unicode character properties (the \p, \P, and \X escapes) is slow,
 120 because PCRE2 has to use a multi-stage table lookup whenever it needs a
 121 character's property. If you can find an alternative pattern that does not use
 122 character properties, it will probably be faster.
 123 </P>
 124 <P>
 125 By default, the escape sequences \b, \d, \s, and \w, and the POSIX
 126 character classes such as [:alpha:] do not use Unicode properties, partly for
 127 backwards compatibility, and partly for performance reasons. However, you can
 128 set the PCRE2_UCP option or start the pattern with (*UCP) if you want Unicode
 129 character properties to be used. This can double the matching time for items
 130 such as \d, when matched with <b>pcre2_match()</b>; the performance loss is
 131 less with a DFA matching function, and in both cases there is not much
 132 difference for \b.
 133 </P>
 134 <P>
 135 When a pattern begins with .* not in atomic parentheses, nor in parentheses
 136 that are the subject of a backreference, and the PCRE2_DOTALL option is set,
 137 the pattern is implicitly anchored by PCRE2, since it can match only at the
 138 start of a subject string. If the pattern has multiple top-level branches, they
 139 must all be anchorable. The optimization can be disabled by the
 140 PCRE2_NO_DOTSTAR_ANCHOR option, and is automatically disabled if the pattern
 141 contains (*PRUNE) or (*SKIP).
 142 </P>
 143 <P>
 144 If PCRE2_DOTALL is not set, PCRE2 cannot make this optimization, because the
 145 dot metacharacter does not then match a newline, and if the subject string
 146 contains newlines, the pattern may match from the character immediately
 147 following one of them instead of from the very start. For example, the pattern
 148 <pre>
 149   .*second
 150 </pre>
 151 matches the subject "first\nand second" (where \n stands for a newline
 152 character), with the match starting at the seventh character. In order to do
 153 this, PCRE2 has to retry the match starting after every newline in the subject.
 154 </P>
 155 <P>
 156 If you are using such a pattern with subject strings that do not contain
 157 newlines, the best performance is obtained by setting PCRE2_DOTALL, or starting
 158 the pattern with ^.* or ^.*? to indicate explicit anchoring. That saves PCRE2
 159 from having to scan along the subject looking for a newline to restart at.
 160 </P>
 161 <P>
 162 Beware of patterns that contain nested indefinite repeats. These can take a
 163 long time to run when applied to a string that does not match. Consider the
 164 pattern fragment
 165 <pre>
 166   ^(a+)*
 167 </pre>
 168 This can match "aaaa" in 16 different ways, and this number increases very
 169 rapidly as the string gets longer. (The * repeat can match 0, 1, 2, 3, or 4
 170 times, and for each of those cases other than 0 or 4, the + repeats can match
 171 different numbers of times.) When the remainder of the pattern is such that the
 172 entire match is going to fail, PCRE2 has in principle to try every possible
 173 variation, and this can take an extremely long time, even for relatively short
 174 strings.
 175 </P>
 176 <P>
 177 An optimization catches some of the more simple cases such as
 178 <pre>
 179   (a+)*b
 180 </pre>
 181 where a literal character follows. Before embarking on the standard matching
 182 procedure, PCRE2 checks that there is a "b" later in the subject string, and if
 183 there is not, it fails the match immediately. However, when there is no
 184 following literal this optimization cannot be used. You can see the difference
 185 by comparing the behaviour of
 186 <pre>
 187   (a+)*\d
 188 </pre>
 189 with the pattern above. The former gives a failure almost instantly when
 190 applied to a whole line of "a" characters, whereas the latter takes an
 191 appreciable time with strings longer than about 20 characters.
 192 </P>
 193 <P>
 194 In many cases, the solution to this kind of performance issue is to use an
 195 atomic group or a possessive quantifier. This can often reduce memory
 196 requirements as well. As another example, consider this pattern:
 197 <pre>
 198   ([^&#60;]|&#60;(?!inet))+
 199 </pre>
 200 It matches from wherever it starts until it encounters "&#60;inet" or the end of
 201 the data, and is the kind of pattern that might be used when processing an XML
 202 file. Each iteration of the outer parentheses matches either one character that
 203 is not "&#60;" or a "&#60;" that is not followed by "inet". However, each time a
 204 parenthesis is processed, a backtracking position is passed, so this
 205 formulation uses a memory frame for each matched character. For a long string,
 206 a lot of memory is required. Consider now this rewritten pattern, which matches
 207 exactly the same strings:
 208 <pre>
 209   ([^&#60;]++|&#60;(?!inet))+
 210 </pre>
 211 This runs much faster, because sequences of characters that do not contain "&#60;"
 212 are "swallowed" in one item inside the parentheses, and a possessive quantifier
 213 is used to stop any backtracking into the runs of non-"&#60;" characters. This
 214 version also uses a lot less memory because entry to a new set of parentheses
 215 happens only when a "&#60;" character that is not followed by "inet" is encountered
 216 (and we assume this is relatively rare).
 217 </P>
 218 <P>
 219 This example shows that one way of optimizing performance when matching long
 220 subject strings is to write repeated parenthesized subpatterns to match more
 221 than one character whenever possible.
 222 </P>
 223 <br><b>
 224 SETTING RESOURCE LIMITS
 225 </b><br>
 226 <P>
 227 You can set limits on the amount of processing that takes place when matching,
 228 and on the amount of heap memory that is used. The default values of the limits
 229 are very large, and unlikely ever to operate. They can be changed when PCRE2 is
 230 built, and they can also be set when <b>pcre2_match()</b> or
 231 <b>pcre2_dfa_match()</b> is called. For details of these interfaces, see the
 232 <a href="pcre2build.html"><b>pcre2build</b></a>
 233 documentation and the section entitled
 234 <a href="pcre2api.html#matchcontext">"The match context"</a>
 235 in the
 236 <a href="pcre2api.html"><b>pcre2api</b></a>
 237 documentation.
 238 </P>
 239 <P>
 240 The <b>pcre2test</b> test program has a modifier called "find_limits" which, if
 241 applied to a subject line, causes it to find the smallest limits that allow a
 242 pattern to match. This is done by repeatedly matching with different limits.
 243 </P>
 244 <br><a name="SEC5" href="#TOC1">AUTHOR</a><br>
 245 <P>
 246 Philip Hazel
 247 <br>
 248 University Computing Service
 249 <br>
 250 Cambridge, England.
 251 <br>
 252 </P>
 253 <br><a name="SEC6" href="#TOC1">REVISION</a><br>
 254 <P>
 255 Last updated: 25 April 2018
 256 <br>
 257 Copyright &copy; 1997-2018 University of Cambridge.
 258 <br>
 259 <p>
 260 Return to the <a href="index.html">PCRE2 index page</a>.
 261 </p>