regexec.c

   1 /*    regexec.c
   2  */
   3
   4 /*
   5  * "One Ring to rule them all, One Ring to find them..."
   6  */
   7
   8 /* This file contains functions for executing a regular expression.  See
   9  * also regcomp.c which funnily enough, contains functions for compiling
  10  * a regular expression.
  11  *
  12  * This file is also copied at build time to ext/re/re_exec.c, where
  13  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
  14  * This causes the main functions to be compiled under new names and with
  15  * debugging support added, which makes "use re 'debug'" work.
  16  */
  17
  18 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
  19  * confused with the original package (see point 3 below).  Thanks, Henry!
  20  */
  21
  22 /* Additional note: this code is very heavily munged from Henry's version
  23  * in places.  In some spots I've traded clarity for efficiency, so don't
  24  * blame Henry for some of the lack of readability.
  25  */
  26
  27 /* The names of the functions have been changed from regcomp and
  28  * regexec to  pregcomp and pregexec in order to avoid conflicts
  29  * with the POSIX routines of the same names.
  30 */
  31
  32 #ifdef PERL_EXT_RE_BUILD
  33 #include "re_top.h"
  34 #endif
  35
  36 /*
  37  * pregcomp and pregexec -- regsub and regerror are not used in perl
  38  *
  39  *      Copyright (c) 1986 by University of Toronto.
  40  *      Written by Henry Spencer.  Not derived from licensed software.
  41  *
  42  *      Permission is granted to anyone to use this software for any
  43  *      purpose on any computer system, and to redistribute it freely,
  44  *      subject to the following restrictions:
  45  *
  46  *      1. The author is not responsible for the consequences of use of
  47  *              this software, no matter how awful, even if they arise
  48  *              from defects in it.
  49  *
  50  *      2. The origin of this software must not be misrepresented, either
  51  *              by explicit claim or by omission.
  52  *
  53  *      3. Altered versions must be plainly marked as such, and must not
  54  *              be misrepresented as being the original software.
  55  *
  56  ****    Alterations to Henry's code are...
  57  ****
  58  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
  59  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
  60  ****
  61  ****    You may distribute under the terms of either the GNU General Public
  62  ****    License or the Artistic License, as specified in the README file.
  63  *
  64  * Beware that some of this code is subtly aware of the way operator
  65  * precedence is structured in regular expressions.  Serious changes in
  66  * regular-expression syntax might require a total rethink.
  67  */
  68 #include "EXTERN.h"
  69 #define PERL_IN_REGEXEC_C
  70 #include "perl.h"
  71
  72 #ifdef PERL_IN_XSUB_RE
  73 #  include "re_comp.h"
  74 #else
  75 #  include "regcomp.h"
  76 #endif
  77
  78 #define RF_tainted      1               /* tainted information used? */
  79 #define RF_warned       2               /* warned about big count? */
  80
  81 #define RF_utf8         8               /* Pattern contains multibyte chars? */
  82
  83 #define UTF ((PL_reg_flags & RF_utf8) != 0)
  84
  85 #define RS_init         1               /* eval environment created */
  86 #define RS_set          2               /* replsv value is set */
  87
  88 #ifndef STATIC
  89 #define STATIC  static
  90 #endif
  91
  92 #define REGINCLASS(prog,p,c)  (ANYOF_FLAGS(p) ? reginclass(prog,p,c,0,0) : ANYOF_BITMAP_TEST(p,*(c)))
  93
  94 /*
  95  * Forwards.
  96  */
  97
  98 #define CHR_SVLEN(sv) (do_utf8 ? sv_len_utf8(sv) : SvCUR(sv))
  99 #define CHR_DIST(a,b) (PL_reg_match_utf8 ? utf8_distance(a,b) : a - b)
 100
 101 #define HOPc(pos,off) \
 102         (char *)(PL_reg_match_utf8 \
 103             ? reghop3((U8*)pos, off, (U8*)(off >= 0 ? PL_regeol : PL_bostr)) \
 104             : (U8*)(pos + off))
 105 #define HOPBACKc(pos, off) \
 106         (char*)(PL_reg_match_utf8\
 107             ? reghopmaybe3((U8*)pos, -off, (U8*)PL_bostr) \
 108             : (pos - off >= PL_bostr)           \
 109                 ? (U8*)pos - off                \
 110                 : NULL)
 111
 112 #define HOP3(pos,off,lim) (PL_reg_match_utf8 ? reghop3((U8*)(pos), off, (U8*)(lim)) : (U8*)(pos + off))
 113 #define HOP3c(pos,off,lim) ((char*)HOP3(pos,off,lim))
 114
 115 #define LOAD_UTF8_CHARCLASS(class,str) STMT_START { \
 116     if (!CAT2(PL_utf8_,class)) { bool ok; ENTER; save_re_context(); ok=CAT2(is_utf8_,class)((const U8*)str); assert(ok); LEAVE; } } STMT_END
 117 #define LOAD_UTF8_CHARCLASS_ALNUM() LOAD_UTF8_CHARCLASS(alnum,"a")
 118 #define LOAD_UTF8_CHARCLASS_DIGIT() LOAD_UTF8_CHARCLASS(digit,"0")
 119 #define LOAD_UTF8_CHARCLASS_SPACE() LOAD_UTF8_CHARCLASS(space," ")
 120 #define LOAD_UTF8_CHARCLASS_MARK()  LOAD_UTF8_CHARCLASS(mark, "\xcd\x86")
 121
 122 /* TODO: Combine JUMPABLE and HAS_TEXT to cache OP(rn) */
 123
 124 /* for use after a quantifier and before an EXACT-like node -- japhy */
 125 #define JUMPABLE(rn) ( \
 126     OP(rn) == OPEN || OP(rn) == CLOSE || OP(rn) == EVAL || \
 127     OP(rn) == SUSPEND || OP(rn) == IFMATCH || \
 128     OP(rn) == PLUS || OP(rn) == MINMOD || \
 129     (PL_regkind[OP(rn)] == CURLY && ARG1(rn) > 0) \
 130 )
 131
 132 #define HAS_TEXT(rn) ( \
 133     PL_regkind[OP(rn)] == EXACT || PL_regkind[OP(rn)] == REF \
 134 )
 135
 136 /*
 137   Search for mandatory following text node; for lookahead, the text must
 138   follow but for lookbehind (rn->flags != 0) we skip to the next step.
 139 */
 140 #define FIND_NEXT_IMPT(rn) STMT_START { \
 141     while (JUMPABLE(rn)) { \
 142         const OPCODE type = OP(rn); \
 143         if (type == SUSPEND || PL_regkind[type] == CURLY) \
 144             rn = NEXTOPER(NEXTOPER(rn)); \
 145         else if (type == PLUS) \
 146             rn = NEXTOPER(rn); \
 147         else if (type == IFMATCH) \
 148             rn = (rn->flags == 0) ? NEXTOPER(NEXTOPER(rn)) : rn + ARG(rn); \
 149         else rn += NEXT_OFF(rn); \
 150     } \
 151 } STMT_END
 152
 153
 154 static void restore_pos(pTHX_ void *arg);
 155
 156 STATIC CHECKPOINT
 157 S_regcppush(pTHX_ I32 parenfloor)
 158 {
 159     dVAR;
 160     const int retval = PL_savestack_ix;
 161 #define REGCP_PAREN_ELEMS 4
 162     const int paren_elems_to_push = (PL_regsize - parenfloor) * REGCP_PAREN_ELEMS;
 163     int p;
 164     GET_RE_DEBUG_FLAGS_DECL;
 165
 166     if (paren_elems_to_push < 0)
 167         Perl_croak(aTHX_ "panic: paren_elems_to_push < 0");
 168
 169 #define REGCP_OTHER_ELEMS 8
 170     SSGROW(paren_elems_to_push + REGCP_OTHER_ELEMS);
 171
 172     for (p = PL_regsize; p > parenfloor; p--) {
 173 /* REGCP_PARENS_ELEMS are pushed per pairs of parentheses. */
 174         SSPUSHINT(PL_regendp[p]);
 175         SSPUSHINT(PL_regstartp[p]);
 176         SSPUSHPTR(PL_reg_start_tmp[p]);
 177         SSPUSHINT(p);
 178         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 179           "     saving \\%"UVuf" %"IVdf"(%"IVdf")..%"IVdf"\n",
 180                       (UV)p, (IV)PL_regstartp[p],
 181                       (IV)(PL_reg_start_tmp[p] - PL_bostr),
 182                       (IV)PL_regendp[p]
 183         ));
 184     }
 185 /* REGCP_OTHER_ELEMS are pushed in any case, parentheses or no. */
 186     SSPUSHPTR(PL_regstartp);
 187     SSPUSHPTR(PL_regendp);
 188     SSPUSHINT(PL_regsize);
 189     SSPUSHINT(*PL_reglastparen);
 190     SSPUSHINT(*PL_reglastcloseparen);
 191     SSPUSHPTR(PL_reginput);
 192 #define REGCP_FRAME_ELEMS 2
 193 /* REGCP_FRAME_ELEMS are part of the REGCP_OTHER_ELEMS and
 194  * are needed for the regexp context stack bookkeeping. */
 195     SSPUSHINT(paren_elems_to_push + REGCP_OTHER_ELEMS - REGCP_FRAME_ELEMS);
 196     SSPUSHINT(SAVEt_REGCONTEXT); /* Magic cookie. */
 197
 198     return retval;
 199 }
 200
 201 /* These are needed since we do not localize EVAL nodes: */
 202 #define REGCP_SET(cp)                                           \
 203     DEBUG_STATE_r(                                              \
 204             PerlIO_printf(Perl_debug_log,                       \
 205                 "  Setting an EVAL scope, savestack=%"IVdf"\n", \
 206                 (IV)PL_savestack_ix));                          \
 207     cp = PL_savestack_ix
 208
 209 #define REGCP_UNWIND(cp)                                        \
 210     DEBUG_STATE_r(                                              \
 211         if (cp != PL_savestack_ix)                              \
 212             PerlIO_printf(Perl_debug_log,                       \
 213                 "  Clearing an EVAL scope, savestack=%"IVdf"..%"IVdf"\n", \
 214                 (IV)(cp), (IV)PL_savestack_ix));                \
 215     regcpblow(cp)
 216
 217 STATIC char *
 218 S_regcppop(pTHX_ const regexp *rex)
 219 {
 220     dVAR;
 221     I32 i;
 222     char *input;
 223
 224     GET_RE_DEBUG_FLAGS_DECL;
 225
 226     /* Pop REGCP_OTHER_ELEMS before the parentheses loop starts. */
 227     i = SSPOPINT;
 228     assert(i == SAVEt_REGCONTEXT); /* Check that the magic cookie is there. */
 229     i = SSPOPINT; /* Parentheses elements to pop. */
 230     input = (char *) SSPOPPTR;
 231     *PL_reglastcloseparen = SSPOPINT;
 232     *PL_reglastparen = SSPOPINT;
 233     PL_regsize = SSPOPINT;
 234     PL_regendp=(I32 *) SSPOPPTR;
 235     PL_regstartp=(I32 *) SSPOPPTR;
 236
 237
 238     /* Now restore the parentheses context. */
 239     for (i -= (REGCP_OTHER_ELEMS - REGCP_FRAME_ELEMS);
 240          i > 0; i -= REGCP_PAREN_ELEMS) {
 241         I32 tmps;
 242         U32 paren = (U32)SSPOPINT;
 243         PL_reg_start_tmp[paren] = (char *) SSPOPPTR;
 244         PL_regstartp[paren] = SSPOPINT;
 245         tmps = SSPOPINT;
 246         if (paren <= *PL_reglastparen)
 247             PL_regendp[paren] = tmps;
 248         DEBUG_EXECUTE_r(
 249             PerlIO_printf(Perl_debug_log,
 250                           "     restoring \\%"UVuf" to %"IVdf"(%"IVdf")..%"IVdf"%s\n",
 251                           (UV)paren, (IV)PL_regstartp[paren],
 252                           (IV)(PL_reg_start_tmp[paren] - PL_bostr),
 253                           (IV)PL_regendp[paren],
 254                           (paren > *PL_reglastparen ? "(no)" : ""));
 255         );
 256     }
 257     DEBUG_EXECUTE_r(
 258         if (*PL_reglastparen + 1 <= rex->nparens) {
 259             PerlIO_printf(Perl_debug_log,
 260                           "     restoring \\%"IVdf"..\\%"IVdf" to undef\n",
 261                           (IV)(*PL_reglastparen + 1), (IV)rex->nparens);
 262         }
 263     );
 264 #if 1
 265     /* It would seem that the similar code in regtry()
 266      * already takes care of this, and in fact it is in
 267      * a better location to since this code can #if 0-ed out
 268      * but the code in regtry() is needed or otherwise tests
 269      * requiring null fields (pat.t#187 and split.t#{13,14}
 270      * (as of patchlevel 7877)  will fail.  Then again,
 271      * this code seems to be necessary or otherwise
 272      * building DynaLoader will fail:
 273      * "Error: '*' not in typemap in DynaLoader.xs, line 164"
 274      * --jhi */
 275     for (i = *PL_reglastparen + 1; (U32)i <= rex->nparens; i++) {
 276         if (i > PL_regsize)
 277             PL_regstartp[i] = -1;
 278         PL_regendp[i] = -1;
 279     }
 280 #endif
 281     return input;
 282 }
 283
 284 #define regcpblow(cp) LEAVE_SCOPE(cp)   /* Ignores regcppush()ed data. */
 285
 286 /*
 287  * pregexec and friends
 288  */
 289
 290 #ifndef PERL_IN_XSUB_RE
 291 /*
 292  - pregexec - match a regexp against a string
 293  */
 294 I32
 295 Perl_pregexec(pTHX_ register regexp *prog, char *stringarg, register char *strend,
 296          char *strbeg, I32 minend, SV *screamer, U32 nosave)
 297 /* strend: pointer to null at end of string */
 298 /* strbeg: real beginning of string */
 299 /* minend: end of match must be >=minend after stringarg. */
 300 /* nosave: For optimizations. */
 301 {
 302     return
 303         regexec_flags(prog, stringarg, strend, strbeg, minend, screamer, NULL,
 304                       nosave ? 0 : REXEC_COPY_STR);
 305 }
 306 #endif
 307
 308 /*
 309  * Need to implement the following flags for reg_anch:
 310  *
 311  * USE_INTUIT_NOML              - Useful to call re_intuit_start() first
 312  * USE_INTUIT_ML
 313  * INTUIT_AUTORITATIVE_NOML     - Can trust a positive answer
 314  * INTUIT_AUTORITATIVE_ML
 315  * INTUIT_ONCE_NOML             - Intuit can match in one location only.
 316  * INTUIT_ONCE_ML
 317  *
 318  * Another flag for this function: SECOND_TIME (so that float substrs
 319  * with giant delta may be not rechecked).
 320  */
 321
 322 /* Assumptions: if ANCH_GPOS, then strpos is anchored. XXXX Check GPOS logic */
 323
 324 /* If SCREAM, then SvPVX_const(sv) should be compatible with strpos and strend.
 325    Otherwise, only SvCUR(sv) is used to get strbeg. */
 326
 327 /* XXXX We assume that strpos is strbeg unless sv. */
 328
 329 /* XXXX Some places assume that there is a fixed substring.
 330         An update may be needed if optimizer marks as "INTUITable"
 331         RExen without fixed substrings.  Similarly, it is assumed that
 332         lengths of all the strings are no more than minlen, thus they
 333         cannot come from lookahead.
 334         (Or minlen should take into account lookahead.)
 335   NOTE: Some of this comment is not correct. minlen does now take account
 336   of lookahead/behind. Further research is required. -- demerphq
 337
 338 */
 339
 340 /* A failure to find a constant substring means that there is no need to make
 341    an expensive call to REx engine, thus we celebrate a failure.  Similarly,
 342    finding a substring too deep into the string means that less calls to
 343    regtry() should be needed.
 344
 345    REx compiler's optimizer found 4 possible hints:
 346         a) Anchored substring;
 347         b) Fixed substring;
 348         c) Whether we are anchored (beginning-of-line or \G);
 349         d) First node (of those at offset 0) which may distingush positions;
 350    We use a)b)d) and multiline-part of c), and try to find a position in the
 351    string which does not contradict any of them.
 352  */
 353
 354 /* Most of decisions we do here should have been done at compile time.
 355    The nodes of the REx which we used for the search should have been
 356    deleted from the finite automaton. */
 357
 358 char *
 359 Perl_re_intuit_start(pTHX_ regexp *prog, SV *sv, char *strpos,
 360                      char *strend, U32 flags, re_scream_pos_data *data)
 361 {
 362     dVAR;
 363     register I32 start_shift = 0;
 364     /* Should be nonnegative! */
 365     register I32 end_shift   = 0;
 366     register char *s;
 367     register SV *check;
 368     char *strbeg;
 369     char *t;
 370     const bool do_utf8 = (sv && SvUTF8(sv)) ? 1 : 0; /* if no sv we have to assume bytes */
 371     I32 ml_anch;
 372     register char *other_last = NULL;   /* other substr checked before this */
 373     char *check_at = NULL;              /* check substr found at this pos */
 374     const I32 multiline = prog->reganch & PMf_MULTILINE;
 375 #ifdef DEBUGGING
 376     const char * const i_strpos = strpos;
 377 #endif
 378
 379     GET_RE_DEBUG_FLAGS_DECL;
 380
 381     RX_MATCH_UTF8_set(prog,do_utf8);
 382
 383     if (prog->reganch & ROPT_UTF8) {
 384         PL_reg_flags |= RF_utf8;
 385     }
 386     DEBUG_EXECUTE_r(
 387         debug_start_match(prog, do_utf8, strpos, strend,
 388             sv ? "Guessing start of match in sv for"
 389                : "Guessing start of match in string for");
 390               );
 391
 392     /* CHR_DIST() would be more correct here but it makes things slow. */
 393     if (prog->minlen > strend - strpos) {
 394         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 395                               "String too short... [re_intuit_start]\n"));
 396         goto fail;
 397     }
 398
 399     strbeg = (sv && SvPOK(sv)) ? strend - SvCUR(sv) : strpos;
 400     PL_regeol = strend;
 401     if (do_utf8) {
 402         if (!prog->check_utf8 && prog->check_substr)
 403             to_utf8_substr(prog);
 404         check = prog->check_utf8;
 405     } else {
 406         if (!prog->check_substr && prog->check_utf8)
 407             to_byte_substr(prog);
 408         check = prog->check_substr;
 409     }
 410     if (check == &PL_sv_undef) {
 411         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 412                 "Non-utf8 string cannot match utf8 check string\n"));
 413         goto fail;
 414     }
 415     if (prog->reganch & ROPT_ANCH) {    /* Match at beg-of-str or after \n */
 416         ml_anch = !( (prog->reganch & ROPT_ANCH_SINGLE)
 417                      || ( (prog->reganch & ROPT_ANCH_BOL)
 418                           && !multiline ) );    /* Check after \n? */
 419
 420         if (!ml_anch) {
 421           if ( !(prog->reganch & (ROPT_ANCH_GPOS /* Checked by the caller */
 422                                   | ROPT_IMPLICIT)) /* not a real BOL */
 423                /* SvCUR is not set on references: SvRV and SvPVX_const overlap */
 424                && sv && !SvROK(sv)
 425                && (strpos != strbeg)) {
 426               DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not at start...\n"));
 427               goto fail;
 428           }
 429           if (prog->check_offset_min == prog->check_offset_max &&
 430               !(prog->reganch & ROPT_CANY_SEEN)) {
 431             /* Substring at constant offset from beg-of-str... */
 432             I32 slen;
 433
 434             s = HOP3c(strpos, prog->check_offset_min, strend);
 435
 436             if (SvTAIL(check)) {
 437                 slen = SvCUR(check);    /* >= 1 */
 438
 439                 if ( strend - s > slen || strend - s < slen - 1
 440                      || (strend - s == slen && strend[-1] != '\n')) {
 441                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String too long...\n"));
 442                     goto fail_finish;
 443                 }
 444                 /* Now should match s[0..slen-2] */
 445                 slen--;
 446                 if (slen && (*SvPVX_const(check) != *s
 447                              || (slen > 1
 448                                  && memNE(SvPVX_const(check), s, slen)))) {
 449                   report_neq:
 450                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String not equal...\n"));
 451                     goto fail_finish;
 452                 }
 453             }
 454             else if (*SvPVX_const(check) != *s
 455                      || ((slen = SvCUR(check)) > 1
 456                          && memNE(SvPVX_const(check), s, slen)))
 457                 goto report_neq;
 458             check_at = s;
 459             goto success_at_start;
 460           }
 461         }
 462         /* Match is anchored, but substr is not anchored wrt beg-of-str. */
 463         s = strpos;
 464         start_shift = prog->check_offset_min; /* okay to underestimate on CC */
 465         end_shift = prog->check_end_shift;
 466
 467         if (!ml_anch) {
 468             const I32 end = prog->check_offset_max + CHR_SVLEN(check)
 469                                          - (SvTAIL(check) != 0);
 470             const I32 eshift = CHR_DIST((U8*)strend, (U8*)s) - end;
 471
 472             if (end_shift < eshift)
 473                 end_shift = eshift;
 474         }
 475     }
 476     else {                              /* Can match at random position */
 477         ml_anch = 0;
 478         s = strpos;
 479         start_shift = prog->check_offset_min;  /* okay to underestimate on CC */
 480         end_shift = prog->check_end_shift;
 481
 482         /* end shift should be non negative here */
 483     }
 484
 485 #ifdef DEBUGGING        /* 7/99: reports of failure (with the older version) */
 486     if (end_shift < 0)
 487         Perl_croak(aTHX_ "panic: end_shift: %"IVdf" pattern:\n%s\n ",
 488                    (IV)end_shift, prog->precomp);
 489 #endif
 490
 491   restart:
 492     /* Find a possible match in the region s..strend by looking for
 493        the "check" substring in the region corrected by start/end_shift. */
 494
 495     {
 496         I32 srch_start_shift = start_shift;
 497         I32 srch_end_shift = end_shift;
 498         if (srch_start_shift < 0 && strbeg - s > srch_start_shift) {
 499             srch_end_shift -= ((strbeg - s) - srch_start_shift);
 500             srch_start_shift = strbeg - s;
 501         }
 502     DEBUG_OPTIMISE_MORE_r({
 503         PerlIO_printf(Perl_debug_log, "Check offset min: %"IVdf" Start shift: %"IVdf" End shift %"IVdf" Real End Shift: %"IVdf"\n",
 504             (IV)prog->check_offset_min,
 505             (IV)srch_start_shift,
 506             (IV)srch_end_shift,
 507             (IV)prog->check_end_shift);
 508     });
 509
 510     if (flags & REXEC_SCREAM) {
 511         I32 p = -1;                     /* Internal iterator of scream. */
 512         I32 * const pp = data ? data->scream_pos : &p;
 513
 514         if (PL_screamfirst[BmRARE(check)] >= 0
 515             || ( BmRARE(check) == '\n'
 516                  && (BmPREVIOUS(check) == SvCUR(check) - 1)
 517                  && SvTAIL(check) ))
 518             s = screaminstr(sv, check,
 519                             srch_start_shift + (s - strbeg), srch_end_shift, pp, 0);
 520         else
 521             goto fail_finish;
 522         /* we may be pointing at the wrong string */
 523         if (s && RX_MATCH_COPIED(prog))
 524             s = strbeg + (s - SvPVX_const(sv));
 525         if (data)
 526             *data->scream_olds = s;
 527     }
 528     else {
 529         U8* start_point;
 530         U8* end_point;
 531         if (prog->reganch & ROPT_CANY_SEEN) {
 532             start_point= (U8*)(s + srch_start_shift);
 533             end_point= (U8*)(strend - srch_end_shift);
 534         } else {
 535             start_point= HOP3(s, srch_start_shift, srch_start_shift < 0 ? strbeg : strend);
 536             end_point= HOP3(strend, -srch_end_shift, strbeg);
 537         }
 538         DEBUG_OPTIMISE_MORE_r({
 539             PerlIO_printf(Perl_debug_log, "fbm_instr len=%d str=<%.*s>\n",
 540                 (int)(end_point - start_point),
 541                 (int)(end_point - start_point) > 20 ? 20 : (int)(end_point - start_point),
 542                 start_point);
 543         });
 544
 545         s = fbm_instr( start_point, end_point,
 546                       check, multiline ? FBMrf_MULTILINE : 0);
 547     }
 548     }
 549     /* Update the count-of-usability, remove useless subpatterns,
 550         unshift s.  */
 551
 552     DEBUG_EXECUTE_r({
 553         RE_PV_QUOTED_DECL(quoted, do_utf8, PERL_DEBUG_PAD_ZERO(0),
 554             SvPVX_const(check), RE_SV_DUMPLEN(check), 30);
 555         PerlIO_printf(Perl_debug_log, "%s %s substr %s%s%s",
 556                           (s ? "Found" : "Did not find"),
 557             (check == (do_utf8 ? prog->anchored_utf8 : prog->anchored_substr)
 558                 ? "anchored" : "floating"),
 559             quoted,
 560             RE_SV_TAIL(check),
 561             (s ? " at offset " : "...\n") );
 562     });
 563
 564     if (!s)
 565         goto fail_finish;
 566     /* Finish the diagnostic message */
 567     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%ld...\n", (long)(s - i_strpos)) );
 568
 569     /* XXX dmq: first branch is for positive lookbehind...
 570        Our check string is offset from the beginning of the pattern.
 571        So we need to do any stclass tests offset forward from that
 572        point. I think. :-(
 573      */
 574
 575
 576
 577     check_at=s;
 578
 579
 580     /* Got a candidate.  Check MBOL anchoring, and the *other* substr.
 581        Start with the other substr.
 582        XXXX no SCREAM optimization yet - and a very coarse implementation
 583        XXXX /ttx+/ results in anchored="ttx", floating="x".  floating will
 584                 *always* match.  Probably should be marked during compile...
 585        Probably it is right to do no SCREAM here...
 586      */
 587
 588     if (do_utf8 ? (prog->float_utf8 && prog->anchored_utf8)
 589                 : (prog->float_substr && prog->anchored_substr))
 590     {
 591         /* Take into account the "other" substring. */
 592         /* XXXX May be hopelessly wrong for UTF... */
 593         if (!other_last)
 594             other_last = strpos;
 595         if (check == (do_utf8 ? prog->float_utf8 : prog->float_substr)) {
 596           do_other_anchored:
 597             {
 598                 char * const last = HOP3c(s, -start_shift, strbeg);
 599                 char *last1, *last2;
 600                 char * const saved_s = s;
 601                 SV* must;
 602
 603                 t = s - prog->check_offset_max;
 604                 if (s - strpos > prog->check_offset_max  /* signed-corrected t > strpos */
 605                     && (!do_utf8
 606                         || ((t = (char*)reghopmaybe3((U8*)s, -(prog->check_offset_max), (U8*)strpos))
 607                             && t > strpos)))
 608                     NOOP;
 609                 else
 610                     t = strpos;
 611                 t = HOP3c(t, prog->anchored_offset, strend);
 612                 if (t < other_last)     /* These positions already checked */
 613                     t = other_last;
 614                 last2 = last1 = HOP3c(strend, -prog->minlen, strbeg);
 615                 if (last < last1)
 616                     last1 = last;
 617                 /* XXXX It is not documented what units *_offsets are in.
 618                    We assume bytes, but this is clearly wrong.
 619                    Meaning this code needs to be carefully reviewed for errors.
 620                    dmq.
 621                   */
 622
 623                 /* On end-of-str: see comment below. */
 624                 must = do_utf8 ? prog->anchored_utf8 : prog->anchored_substr;
 625                 if (must == &PL_sv_undef) {
 626                     s = (char*)NULL;
 627                     DEBUG_r(must = prog->anchored_utf8);        /* for debug */
 628                 }
 629                 else
 630                     s = fbm_instr(
 631                         (unsigned char*)t,
 632                         HOP3(HOP3(last1, prog->anchored_offset, strend)
 633                                 + SvCUR(must), -(SvTAIL(must)!=0), strbeg),
 634                         must,
 635                         multiline ? FBMrf_MULTILINE : 0
 636                     );
 637                 DEBUG_EXECUTE_r({
 638                     RE_PV_QUOTED_DECL(quoted, do_utf8, PERL_DEBUG_PAD_ZERO(0),
 639                         SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
 640                     PerlIO_printf(Perl_debug_log, "%s anchored substr %s%s",
 641                         (s ? "Found" : "Contradicts"),
 642                         quoted, RE_SV_TAIL(must));
 643                 });
 644
 645
 646                 if (!s) {
 647                     if (last1 >= last2) {
 648                         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 649                                                 ", giving up...\n"));
 650                         goto fail_finish;
 651                     }
 652                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 653                         ", trying floating at offset %ld...\n",
 654                         (long)(HOP3c(saved_s, 1, strend) - i_strpos)));
 655                     other_last = HOP3c(last1, prog->anchored_offset+1, strend);
 656                     s = HOP3c(last, 1, strend);
 657                     goto restart;
 658                 }
 659                 else {
 660                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
 661                           (long)(s - i_strpos)));
 662                     t = HOP3c(s, -prog->anchored_offset, strbeg);
 663                     other_last = HOP3c(s, 1, strend);
 664                     s = saved_s;
 665                     if (t == strpos)
 666                         goto try_at_start;
 667                     goto try_at_offset;
 668                 }
 669             }
 670         }
 671         else {          /* Take into account the floating substring. */
 672             char *last, *last1;
 673             char * const saved_s = s;
 674             SV* must;
 675
 676             t = HOP3c(s, -start_shift, strbeg);
 677             last1 = last =
 678                 HOP3c(strend, -prog->minlen + prog->float_min_offset, strbeg);
 679             if (CHR_DIST((U8*)last, (U8*)t) > prog->float_max_offset)
 680                 last = HOP3c(t, prog->float_max_offset, strend);
 681             s = HOP3c(t, prog->float_min_offset, strend);
 682             if (s < other_last)
 683                 s = other_last;
 684  /* XXXX It is not documented what units *_offsets are in.  Assume bytes.  */
 685             must = do_utf8 ? prog->float_utf8 : prog->float_substr;
 686             /* fbm_instr() takes into account exact value of end-of-str
 687                if the check is SvTAIL(ed).  Since false positives are OK,
 688                and end-of-str is not later than strend we are OK. */
 689             if (must == &PL_sv_undef) {
 690                 s = (char*)NULL;
 691                 DEBUG_r(must = prog->float_utf8);       /* for debug message */
 692             }
 693             else
 694                 s = fbm_instr((unsigned char*)s,
 695                               (unsigned char*)last + SvCUR(must)
 696                                   - (SvTAIL(must)!=0),
 697                               must, multiline ? FBMrf_MULTILINE : 0);
 698             DEBUG_EXECUTE_r({
 699                 RE_PV_QUOTED_DECL(quoted, do_utf8, PERL_DEBUG_PAD_ZERO(0),
 700                     SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
 701                 PerlIO_printf(Perl_debug_log, "%s floating substr %s%s",
 702                     (s ? "Found" : "Contradicts"),
 703                     quoted, RE_SV_TAIL(must));
 704             });
 705             if (!s) {
 706                 if (last1 == last) {
 707                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 708                                             ", giving up...\n"));
 709                     goto fail_finish;
 710                 }
 711                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 712                     ", trying anchored starting at offset %ld...\n",
 713                     (long)(saved_s + 1 - i_strpos)));
 714                 other_last = last;
 715                 s = HOP3c(t, 1, strend);
 716                 goto restart;
 717             }
 718             else {
 719                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
 720                       (long)(s - i_strpos)));
 721                 other_last = s; /* Fix this later. --Hugo */
 722                 s = saved_s;
 723                 if (t == strpos)
 724                     goto try_at_start;
 725                 goto try_at_offset;
 726             }
 727         }
 728     }
 729
 730
 731     t= (char*)HOP3( s, -prog->check_offset_max, (prog->check_offset_max<0) ? strend : strpos);
 732
 733     DEBUG_OPTIMISE_MORE_r(
 734         PerlIO_printf(Perl_debug_log,
 735             "Check offset min:%"IVdf" max:%"IVdf" S:%"IVdf" t:%"IVdf" D:%"IVdf" end:%"IVdf"\n",
 736             (IV)prog->check_offset_min,
 737             (IV)prog->check_offset_max,
 738             (IV)(s-strpos),
 739             (IV)(t-strpos),
 740             (IV)(t-s),
 741             (IV)(strend-strpos)
 742         )
 743     );
 744
 745     if (s - strpos > prog->check_offset_max  /* signed-corrected t > strpos */
 746         && (!do_utf8
 747             || ((t = (char*)reghopmaybe3((U8*)s, -prog->check_offset_max, (U8*) ((prog->check_offset_max<0) ? strend : strpos)))
 748                  && t > strpos)))
 749     {
 750         /* Fixed substring is found far enough so that the match
 751            cannot start at strpos. */
 752       try_at_offset:
 753         if (ml_anch && t[-1] != '\n') {
 754             /* Eventually fbm_*() should handle this, but often
 755                anchored_offset is not 0, so this check will not be wasted. */
 756             /* XXXX In the code below we prefer to look for "^" even in
 757                presence of anchored substrings.  And we search even
 758                beyond the found float position.  These pessimizations
 759                are historical artefacts only.  */
 760           find_anchor:
 761             while (t < strend - prog->minlen) {
 762                 if (*t == '\n') {
 763                     if (t < check_at - prog->check_offset_min) {
 764                         if (do_utf8 ? prog->anchored_utf8 : prog->anchored_substr) {
 765                             /* Since we moved from the found position,
 766                                we definitely contradict the found anchored
 767                                substr.  Due to the above check we do not
 768                                contradict "check" substr.
 769                                Thus we can arrive here only if check substr
 770                                is float.  Redo checking for "other"=="fixed".
 771                              */
 772                             strpos = t + 1;
 773                             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld, rescanning for anchored from offset %ld...\n",
 774                                 PL_colors[0], PL_colors[1], (long)(strpos - i_strpos), (long)(strpos - i_strpos + prog->anchored_offset)));
 775                             goto do_other_anchored;
 776                         }
 777                         /* We don't contradict the found floating substring. */
 778                         /* XXXX Why not check for STCLASS? */
 779                         s = t + 1;
 780                         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld...\n",
 781                             PL_colors[0], PL_colors[1], (long)(s - i_strpos)));
 782                         goto set_useful;
 783                     }
 784                     /* Position contradicts check-string */
 785                     /* XXXX probably better to look for check-string
 786                        than for "\n", so one should lower the limit for t? */
 787                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m, restarting lookup for check-string at offset %ld...\n",
 788                         PL_colors[0], PL_colors[1], (long)(t + 1 - i_strpos)));
 789                     other_last = strpos = s = t + 1;
 790                     goto restart;
 791                 }
 792                 t++;
 793             }
 794             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Did not find /%s^%s/m...\n",
 795                         PL_colors[0], PL_colors[1]));
 796             goto fail_finish;
 797         }
 798         else {
 799             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Starting position does not contradict /%s^%s/m...\n",
 800                         PL_colors[0], PL_colors[1]));
 801         }
 802         s = t;
 803       set_useful:
 804         ++BmUSEFUL(do_utf8 ? prog->check_utf8 : prog->check_substr);    /* hooray/5 */
 805     }
 806     else {
 807         /* The found string does not prohibit matching at strpos,
 808            - no optimization of calling REx engine can be performed,
 809            unless it was an MBOL and we are not after MBOL,
 810            or a future STCLASS check will fail this. */
 811       try_at_start:
 812         /* Even in this situation we may use MBOL flag if strpos is offset
 813            wrt the start of the string. */
 814         if (ml_anch && sv && !SvROK(sv) /* See prev comment on SvROK */
 815             && (strpos != strbeg) && strpos[-1] != '\n'
 816             /* May be due to an implicit anchor of m{.*foo}  */
 817             && !(prog->reganch & ROPT_IMPLICIT))
 818         {
 819             t = strpos;
 820             goto find_anchor;
 821         }
 822         DEBUG_EXECUTE_r( if (ml_anch)
 823             PerlIO_printf(Perl_debug_log, "Position at offset %ld does not contradict /%s^%s/m...\n",
 824                         (long)(strpos - i_strpos), PL_colors[0], PL_colors[1]);
 825         );
 826       success_at_start:
 827         if (!(prog->reganch & ROPT_NAUGHTY)     /* XXXX If strpos moved? */
 828             && (do_utf8 ? (
 829                 prog->check_utf8                /* Could be deleted already */
 830                 && --BmUSEFUL(prog->check_utf8) < 0
 831                 && (prog->check_utf8 == prog->float_utf8)
 832             ) : (
 833                 prog->check_substr              /* Could be deleted already */
 834                 && --BmUSEFUL(prog->check_substr) < 0
 835                 && (prog->check_substr == prog->float_substr)
 836             )))
 837         {
 838             /* If flags & SOMETHING - do not do it many times on the same match */
 839             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "... Disabling check substring...\n"));
 840             SvREFCNT_dec(do_utf8 ? prog->check_utf8 : prog->check_substr);
 841             if (do_utf8 ? prog->check_substr : prog->check_utf8)
 842                 SvREFCNT_dec(do_utf8 ? prog->check_substr : prog->check_utf8);
 843             prog->check_substr = prog->check_utf8 = NULL;       /* disable */
 844             prog->float_substr = prog->float_utf8 = NULL;       /* clear */
 845             check = NULL;                       /* abort */
 846             s = strpos;
 847             /* XXXX This is a remnant of the old implementation.  It
 848                     looks wasteful, since now INTUIT can use many
 849                     other heuristics. */
 850             prog->reganch &= ~RE_USE_INTUIT;
 851         }
 852         else
 853             s = strpos;
 854     }
 855
 856     /* Last resort... */
 857     /* XXXX BmUSEFUL already changed, maybe multiple change is meaningful... */
 858     /* trie stclasses are too expensive to use here, we are better off to
 859        leave it to regmatch itself */
 860     if (prog->regstclass && PL_regkind[OP(prog->regstclass)]!=TRIE) {
 861         /* minlen == 0 is possible if regstclass is \b or \B,
 862            and the fixed substr is ''$.
 863            Since minlen is already taken into account, s+1 is before strend;
 864            accidentally, minlen >= 1 guaranties no false positives at s + 1
 865            even for \b or \B.  But (minlen? 1 : 0) below assumes that
 866            regstclass does not come from lookahead...  */
 867         /* If regstclass takes bytelength more than 1: If charlength==1, OK.
 868            This leaves EXACTF only, which is dealt with in find_byclass().  */
 869         const U8* const str = (U8*)STRING(prog->regstclass);
 870         const int cl_l = (PL_regkind[OP(prog->regstclass)] == EXACT
 871                     ? CHR_DIST(str+STR_LEN(prog->regstclass), str)
 872                     : 1);
 873         char * endpos;
 874         if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
 875             endpos= HOP3c(s, (prog->minlen ? cl_l : 0), strend);
 876         else if (prog->float_substr || prog->float_utf8)
 877             endpos= HOP3c(HOP3c(check_at, -start_shift, strbeg), cl_l, strend);
 878         else
 879             endpos= strend;
 880
 881         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %d s: %d endpos: %d\n",
 882                                       (IV)start_shift, check_at - strbeg, s - strbeg, endpos - strbeg));
 883
 884         t = s;
 885         s = find_byclass(prog, prog->regstclass, s, endpos, NULL);
 886         if (!s) {
 887 #ifdef DEBUGGING
 888             const char *what = NULL;
 889 #endif
 890             if (endpos == strend) {
 891                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 892                                 "Could not match STCLASS...\n") );
 893                 goto fail;
 894             }
 895             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 896                                    "This position contradicts STCLASS...\n") );
 897             if ((prog->reganch & ROPT_ANCH) && !ml_anch)
 898                 goto fail;
 899             /* Contradict one of substrings */
 900             if (prog->anchored_substr || prog->anchored_utf8) {
 901                 if ((do_utf8 ? prog->anchored_utf8 : prog->anchored_substr) == check) {
 902                     DEBUG_EXECUTE_r( what = "anchored" );
 903                   hop_and_restart:
 904                     s = HOP3c(t, 1, strend);
 905                     if (s + start_shift + end_shift > strend) {
 906                         /* XXXX Should be taken into account earlier? */
 907                         DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 908                                                "Could not match STCLASS...\n") );
 909                         goto fail;
 910                     }
 911                     if (!check)
 912                         goto giveup;
 913                     DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 914                                 "Looking for %s substr starting at offset %ld...\n",
 915                                  what, (long)(s + start_shift - i_strpos)) );
 916                     goto restart;
 917                 }
 918                 /* Have both, check_string is floating */
 919                 if (t + start_shift >= check_at) /* Contradicts floating=check */
 920                     goto retry_floating_check;
 921                 /* Recheck anchored substring, but not floating... */
 922                 s = check_at;
 923                 if (!check)
 924                     goto giveup;
 925                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 926                           "Looking for anchored substr starting at offset %ld...\n",
 927                           (long)(other_last - i_strpos)) );
 928                 goto do_other_anchored;
 929             }
 930             /* Another way we could have checked stclass at the
 931                current position only: */
 932             if (ml_anch) {
 933                 s = t = t + 1;
 934                 if (!check)
 935                     goto giveup;
 936                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
 937                           "Looking for /%s^%s/m starting at offset %ld...\n",
 938                           PL_colors[0], PL_colors[1], (long)(t - i_strpos)) );
 939                 goto try_at_offset;
 940             }
 941             if (!(do_utf8 ? prog->float_utf8 : prog->float_substr))     /* Could have been deleted */
 942                 goto fail;
 943             /* Check is floating subtring. */
 944           retry_floating_check:
 945             t = check_at - start_shift;
 946             DEBUG_EXECUTE_r( what = "floating" );
 947             goto hop_and_restart;
 948         }
 949         if (t != s) {
 950             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 951                         "By STCLASS: moving %ld --> %ld\n",
 952                                   (long)(t - i_strpos), (long)(s - i_strpos))
 953                    );
 954         }
 955         else {
 956             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 957                                   "Does not contradict STCLASS...\n");
 958                    );
 959         }
 960     }
 961   giveup:
 962     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s%s:%s match at offset %ld\n",
 963                           PL_colors[4], (check ? "Guessed" : "Giving up"),
 964                           PL_colors[5], (long)(s - i_strpos)) );
 965     return s;
 966
 967   fail_finish:                          /* Substring not found */
 968     if (prog->check_substr || prog->check_utf8)         /* could be removed already */
 969         BmUSEFUL(do_utf8 ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
 970   fail:
 971     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch rejected by optimizer%s\n",
 972                           PL_colors[4], PL_colors[5]));
 973     return NULL;
 974 }
 975
 976
 977
 978 #define REXEC_TRIE_READ_CHAR(trie_type, trie, uc, uscan, len, uvc, charid,  \
 979 foldlen, foldbuf, uniflags) STMT_START {                                    \
 980     switch (trie_type) {                                                    \
 981     case trie_utf8_fold:                                                    \
 982         if ( foldlen>0 ) {                                                  \
 983             uvc = utf8n_to_uvuni( uscan, UTF8_MAXLEN, &len, uniflags );     \
 984             foldlen -= len;                                                 \
 985             uscan += len;                                                   \
 986             len=0;                                                          \
 987         } else {                                                            \
 988             uvc = utf8n_to_uvuni( (U8*)uc, UTF8_MAXLEN, &len, uniflags );   \
 989             uvc = to_uni_fold( uvc, foldbuf, &foldlen );                    \
 990             foldlen -= UNISKIP( uvc );                                      \
 991             uscan = foldbuf + UNISKIP( uvc );                               \
 992         }                                                                   \
 993         break;                                                              \
 994     case trie_utf8:                                                         \
 995         uvc = utf8n_to_uvuni( (U8*)uc, UTF8_MAXLEN, &len, uniflags );       \
 996         break;                                                              \
 997     case trie_plain:                                                        \
 998         uvc = (UV)*uc;                                                      \
 999         len = 1;                                                            \
1000     }                                                                       \
1001                                                                             \
1002     if (uvc < 256) {                                                        \
1003         charid = trie->charmap[ uvc ];                                      \
1004     }                                                                       \
1005     else {                                                                  \
1006         charid = 0;                                                         \
1007         if (trie->widecharmap) {                                            \
1008             SV** const svpp = hv_fetch(trie->widecharmap,                   \
1009                         (char*)&uvc, sizeof(UV), 0);                        \
1010             if (svpp)                                                       \
1011                 charid = (U16)SvIV(*svpp);                                  \
1012         }                                                                   \
1013     }                                                                       \
1014 } STMT_END
1015
1016 #define REXEC_FBC_EXACTISH_CHECK(CoNd)                  \
1017     if ( (CoNd)                                        \
1018          && (ln == len ||                              \
1019              ibcmp_utf8(s, NULL, 0,  do_utf8,          \
1020                         m, NULL, ln, (bool)UTF))       \
1021          && (!reginfo || regtry(reginfo, &s)) )         \
1022         goto got_it;                                   \
1023     else {                                             \
1024          U8 foldbuf[UTF8_MAXBYTES_CASE+1];             \
1025          uvchr_to_utf8(tmpbuf, c);                     \
1026          f = to_utf8_fold(tmpbuf, foldbuf, &foldlen);  \
1027          if ( f != c                                   \
1028               && (f == c1 || f == c2)                  \
1029               && (ln == foldlen ||                     \
1030                   !ibcmp_utf8((char *) foldbuf,        \
1031                               NULL, foldlen, do_utf8,  \
1032                               m,                       \
1033                               NULL, ln, (bool)UTF))    \
1034               && (!reginfo || regtry(reginfo, &s)) )    \
1035               goto got_it;                             \
1036     }                                                  \
1037     s += len
1038
1039 #define REXEC_FBC_EXACTISH_SCAN(CoNd)                     \
1040 STMT_START {                                              \
1041     while (s <= e) {                                      \
1042         if ( (CoNd)                                       \
1043              && (ln == 1 || !(OP(c) == EXACTF             \
1044                               ? ibcmp(s, m, ln)           \
1045                               : ibcmp_locale(s, m, ln)))  \
1046              && (!reginfo || regtry(reginfo, &s)) )        \
1047             goto got_it;                                  \
1048         s++;                                              \
1049     }                                                     \
1050 } STMT_END
1051
1052 #define REXEC_FBC_UTF8_SCAN(CoDe)                     \
1053 STMT_START {                                          \
1054     while (s + (uskip = UTF8SKIP(s)) <= strend) {     \
1055         CoDe                                          \
1056         s += uskip;                                   \
1057     }                                                 \
1058 } STMT_END
1059
1060 #define REXEC_FBC_SCAN(CoDe)                          \
1061 STMT_START {                                          \
1062     while (s < strend) {                              \
1063         CoDe                                          \
1064         s++;                                          \
1065     }                                                 \
1066 } STMT_END
1067
1068 #define REXEC_FBC_UTF8_CLASS_SCAN(CoNd)               \
1069 REXEC_FBC_UTF8_SCAN(                                  \
1070     if (CoNd) {                                       \
1071         if (tmp && (!reginfo || regtry(reginfo, &s)))  \
1072             goto got_it;                              \
1073         else                                          \
1074             tmp = doevery;                            \
1075     }                                                 \
1076     else                                              \
1077         tmp = 1;                                      \
1078 )
1079
1080 #define REXEC_FBC_CLASS_SCAN(CoNd)                    \
1081 REXEC_FBC_SCAN(                                       \
1082     if (CoNd) {                                       \
1083         if (tmp && (!reginfo || regtry(reginfo, &s)))  \
1084             goto got_it;                              \
1085         else                                          \
1086             tmp = doevery;                            \
1087     }                                                 \
1088     else                                              \
1089         tmp = 1;                                      \
1090 )
1091
1092 #define REXEC_FBC_TRYIT               \
1093 if ((!reginfo || regtry(reginfo, &s))) \
1094     goto got_it
1095
1096 #define REXEC_FBC_CSCAN_PRELOAD(UtFpReLoAd,CoNdUtF8,CoNd)      \
1097     if (do_utf8) {                                             \
1098         UtFpReLoAd;                                            \
1099         REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8);                   \
1100     }                                                          \
1101     else {                                                     \
1102         REXEC_FBC_CLASS_SCAN(CoNd);                            \
1103     }                                                          \
1104     break
1105
1106 #define REXEC_FBC_CSCAN_TAINT(CoNdUtF8,CoNd)                   \
1107     PL_reg_flags |= RF_tainted;                                \
1108     if (do_utf8) {                                             \
1109         REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8);                   \
1110     }                                                          \
1111     else {                                                     \
1112         REXEC_FBC_CLASS_SCAN(CoNd);                            \
1113     }                                                          \
1114     break
1115
1116 #define DUMP_EXEC_POS(li,s,doutf8) \
1117     dump_exec_pos(li,s,(PL_regeol),(PL_bostr),(PL_reg_starttry),doutf8)
1118
1119 /* We know what class REx starts with.  Try to find this position... */
1120 /* if reginfo is NULL, its a dryrun */
1121 /* annoyingly all the vars in this routine have different names from their counterparts
1122    in regmatch. /grrr */
1123
1124 STATIC char *
1125 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s,
1126     const char *strend, regmatch_info *reginfo)
1127 {
1128         dVAR;
1129         const I32 doevery = (prog->reganch & ROPT_SKIP) == 0;
1130         char *m;
1131         STRLEN ln;
1132         STRLEN lnc;
1133         register STRLEN uskip;
1134         unsigned int c1;
1135         unsigned int c2;
1136         char *e;
1137         register I32 tmp = 1;   /* Scratch variable? */
1138         register const bool do_utf8 = PL_reg_match_utf8;
1139
1140         /* We know what class it must start with. */
1141         switch (OP(c)) {
1142         case ANYOF:
1143             if (do_utf8) {
1144                  REXEC_FBC_UTF8_CLASS_SCAN((ANYOF_FLAGS(c) & ANYOF_UNICODE) ||
1145                           !UTF8_IS_INVARIANT((U8)s[0]) ?
1146                           reginclass(prog, c, (U8*)s, 0, do_utf8) :
1147                           REGINCLASS(prog, c, (U8*)s));
1148             }
1149             else {
1150                  while (s < strend) {
1151                       STRLEN skip = 1;
1152
1153                       if (REGINCLASS(prog, c, (U8*)s) ||
1154                           (ANYOF_FOLD_SHARP_S(c, s, strend) &&
1155                            /* The assignment of 2 is intentional:
1156                             * for the folded sharp s, the skip is 2. */
1157                            (skip = SHARP_S_SKIP))) {
1158                            if (tmp && (!reginfo || regtry(reginfo, &s)))
1159                                 goto got_it;
1160                            else
1161                                 tmp = doevery;
1162                       }
1163                       else
1164                            tmp = 1;
1165                       s += skip;
1166                  }
1167             }
1168             break;
1169         case CANY:
1170             REXEC_FBC_SCAN(
1171                 if (tmp && (!reginfo || regtry(reginfo, &s)))
1172                     goto got_it;
1173                 else
1174                     tmp = doevery;
1175             );
1176             break;
1177         case EXACTF:
1178             m   = STRING(c);
1179             ln  = STR_LEN(c);   /* length to match in octets/bytes */
1180             lnc = (I32) ln;     /* length to match in characters */
1181             if (UTF) {
1182                 STRLEN ulen1, ulen2;
1183                 U8 *sm = (U8 *) m;
1184                 U8 tmpbuf1[UTF8_MAXBYTES_CASE+1];
1185                 U8 tmpbuf2[UTF8_MAXBYTES_CASE+1];
1186                 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1187
1188                 to_utf8_lower((U8*)m, tmpbuf1, &ulen1);
1189                 to_utf8_upper((U8*)m, tmpbuf2, &ulen2);
1190
1191                 c1 = utf8n_to_uvchr(tmpbuf1, UTF8_MAXBYTES_CASE,
1192                                     0, uniflags);
1193                 c2 = utf8n_to_uvchr(tmpbuf2, UTF8_MAXBYTES_CASE,
1194                                     0, uniflags);
1195                 lnc = 0;
1196                 while (sm < ((U8 *) m + ln)) {
1197                     lnc++;
1198                     sm += UTF8SKIP(sm);
1199                 }
1200             }
1201             else {
1202                 c1 = *(U8*)m;
1203                 c2 = PL_fold[c1];
1204             }
1205             goto do_exactf;
1206         case EXACTFL:
1207             m   = STRING(c);
1208             ln  = STR_LEN(c);
1209             lnc = (I32) ln;
1210             c1 = *(U8*)m;
1211             c2 = PL_fold_locale[c1];
1212           do_exactf:
1213             e = HOP3c(strend, -((I32)lnc), s);
1214
1215             if (!reginfo && e < s)
1216                 e = s;                  /* Due to minlen logic of intuit() */
1217
1218             /* The idea in the EXACTF* cases is to first find the
1219              * first character of the EXACTF* node and then, if
1220              * necessary, case-insensitively compare the full
1221              * text of the node.  The c1 and c2 are the first
1222              * characters (though in Unicode it gets a bit
1223              * more complicated because there are more cases
1224              * than just upper and lower: one needs to use
1225              * the so-called folding case for case-insensitive
1226              * matching (called "loose matching" in Unicode).
1227              * ibcmp_utf8() will do just that. */
1228
1229             if (do_utf8) {
1230                 UV c, f;
1231                 U8 tmpbuf [UTF8_MAXBYTES+1];
1232                 STRLEN len, foldlen;
1233                 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1234                 if (c1 == c2) {
1235                     /* Upper and lower of 1st char are equal -
1236                      * probably not a "letter". */
1237                     while (s <= e) {
1238                         c = utf8n_to_uvchr((U8*)s, UTF8_MAXBYTES, &len,
1239                                            uniflags);
1240                         REXEC_FBC_EXACTISH_CHECK(c == c1);
1241                     }
1242                 }
1243                 else {
1244                     while (s <= e) {
1245                       c = utf8n_to_uvchr((U8*)s, UTF8_MAXBYTES, &len,
1246                                            uniflags);
1247
1248                         /* Handle some of the three Greek sigmas cases.
1249                          * Note that not all the possible combinations
1250                          * are handled here: some of them are handled
1251                          * by the standard folding rules, and some of
1252                          * them (the character class or ANYOF cases)
1253                          * are handled during compiletime in
1254                          * regexec.c:S_regclass(). */
1255                         if (c == (UV)UNICODE_GREEK_CAPITAL_LETTER_SIGMA ||
1256                             c == (UV)UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA)
1257                             c = (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA;
1258
1259                         REXEC_FBC_EXACTISH_CHECK(c == c1 || c == c2);
1260                     }
1261                 }
1262             }
1263             else {
1264                 if (c1 == c2)
1265                     REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1266                 else
1267                     REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1268             }
1269             break;
1270         case BOUNDL:
1271             PL_reg_flags |= RF_tainted;
1272             /* FALL THROUGH */
1273         case BOUND:
1274             if (do_utf8) {
1275                 if (s == PL_bostr)
1276                     tmp = '\n';
1277                 else {
1278                     U8 * const r = reghop3((U8*)s, -1, (U8*)PL_bostr);
1279                     tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT);
1280                 }
1281                 tmp = ((OP(c) == BOUND ?
1282                         isALNUM_uni(tmp) : isALNUM_LC_uvchr(UNI_TO_NATIVE(tmp))) != 0);
1283                 LOAD_UTF8_CHARCLASS_ALNUM();
1284                 REXEC_FBC_UTF8_SCAN(
1285                     if (tmp == !(OP(c) == BOUND ?
1286                                  (bool)swash_fetch(PL_utf8_alnum, (U8*)s, do_utf8) :
1287                                  isALNUM_LC_utf8((U8*)s)))
1288                     {
1289                         tmp = !tmp;
1290                         REXEC_FBC_TRYIT;
1291                 }
1292                 );
1293             }
1294             else {
1295                 tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n';
1296                 tmp = ((OP(c) == BOUND ? isALNUM(tmp) : isALNUM_LC(tmp)) != 0);
1297                 REXEC_FBC_SCAN(
1298                     if (tmp ==
1299                         !(OP(c) == BOUND ? isALNUM(*s) : isALNUM_LC(*s))) {
1300                         tmp = !tmp;
1301                         REXEC_FBC_TRYIT;
1302                 }
1303                 );
1304             }
1305             if ((!prog->minlen && tmp) && (!reginfo || regtry(reginfo, &s)))
1306                 goto got_it;
1307             break;
1308         case NBOUNDL:
1309             PL_reg_flags |= RF_tainted;
1310             /* FALL THROUGH */
1311         case NBOUND:
1312             if (do_utf8) {
1313                 if (s == PL_bostr)
1314                     tmp = '\n';
1315                 else {
1316                     U8 * const r = reghop3((U8*)s, -1, (U8*)PL_bostr);
1317                     tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT);
1318                 }
1319                 tmp = ((OP(c) == NBOUND ?
1320                         isALNUM_uni(tmp) : isALNUM_LC_uvchr(UNI_TO_NATIVE(tmp))) != 0);
1321                 LOAD_UTF8_CHARCLASS_ALNUM();
1322                 REXEC_FBC_UTF8_SCAN(
1323                     if (tmp == !(OP(c) == NBOUND ?
1324                                  (bool)swash_fetch(PL_utf8_alnum, (U8*)s, do_utf8) :
1325                                  isALNUM_LC_utf8((U8*)s)))
1326                         tmp = !tmp;
1327                     else REXEC_FBC_TRYIT;
1328                 );
1329             }
1330             else {
1331                 tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n';
1332                 tmp = ((OP(c) == NBOUND ?
1333                         isALNUM(tmp) : isALNUM_LC(tmp)) != 0);
1334                 REXEC_FBC_SCAN(
1335                     if (tmp ==
1336                         !(OP(c) == NBOUND ? isALNUM(*s) : isALNUM_LC(*s)))
1337                         tmp = !tmp;
1338                     else REXEC_FBC_TRYIT;
1339                 );
1340             }
1341             if ((!prog->minlen && !tmp) && (!reginfo || regtry(reginfo, &s)))
1342                 goto got_it;
1343             break;
1344         case ALNUM:
1345             REXEC_FBC_CSCAN_PRELOAD(
1346                 LOAD_UTF8_CHARCLASS_ALNUM(),
1347                 swash_fetch(PL_utf8_alnum, (U8*)s, do_utf8),
1348                 isALNUM(*s)
1349             );
1350         case ALNUML:
1351             REXEC_FBC_CSCAN_TAINT(
1352                 isALNUM_LC_utf8((U8*)s),
1353                 isALNUM_LC(*s)
1354             );
1355         case NALNUM:
1356             REXEC_FBC_CSCAN_PRELOAD(
1357                 LOAD_UTF8_CHARCLASS_ALNUM(),
1358                 !swash_fetch(PL_utf8_alnum, (U8*)s, do_utf8),
1359                 !isALNUM(*s)
1360             );
1361         case NALNUML:
1362             REXEC_FBC_CSCAN_TAINT(
1363                 !isALNUM_LC_utf8((U8*)s),
1364                 !isALNUM_LC(*s)
1365             );
1366         case SPACE:
1367             REXEC_FBC_CSCAN_PRELOAD(
1368                 LOAD_UTF8_CHARCLASS_SPACE(),
1369                 *s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, do_utf8),
1370                 isSPACE(*s)
1371             );
1372         case SPACEL:
1373             REXEC_FBC_CSCAN_TAINT(
1374                 *s == ' ' || isSPACE_LC_utf8((U8*)s),
1375                 isSPACE_LC(*s)
1376             );
1377         case NSPACE:
1378             REXEC_FBC_CSCAN_PRELOAD(
1379                 LOAD_UTF8_CHARCLASS_SPACE(),
1380                 !(*s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, do_utf8)),
1381                 !isSPACE(*s)
1382             );
1383         case NSPACEL:
1384             REXEC_FBC_CSCAN_TAINT(
1385                 !(*s == ' ' || isSPACE_LC_utf8((U8*)s)),
1386                 !isSPACE_LC(*s)
1387             );
1388         case DIGIT:
1389             REXEC_FBC_CSCAN_PRELOAD(
1390                 LOAD_UTF8_CHARCLASS_DIGIT(),
1391                 swash_fetch(PL_utf8_digit,(U8*)s, do_utf8),
1392                 isDIGIT(*s)
1393             );
1394         case DIGITL:
1395             REXEC_FBC_CSCAN_TAINT(
1396                 isDIGIT_LC_utf8((U8*)s),
1397                 isDIGIT_LC(*s)
1398             );
1399         case NDIGIT:
1400             REXEC_FBC_CSCAN_PRELOAD(
1401                 LOAD_UTF8_CHARCLASS_DIGIT(),
1402                 !swash_fetch(PL_utf8_digit,(U8*)s, do_utf8),
1403                 !isDIGIT(*s)
1404             );
1405         case NDIGITL:
1406             REXEC_FBC_CSCAN_TAINT(
1407                 !isDIGIT_LC_utf8((U8*)s),
1408                 !isDIGIT_LC(*s)
1409             );
1410         case AHOCORASICKC:
1411         case AHOCORASICK:
1412             {
1413                 const enum { trie_plain, trie_utf8, trie_utf8_fold }
1414                     trie_type = do_utf8 ?
1415                           (c->flags == EXACT ? trie_utf8 : trie_utf8_fold)
1416                         : trie_plain;
1417                 /* what trie are we using right now */
1418                 reg_ac_data *aho
1419                     = (reg_ac_data*)prog->data->data[ ARG( c ) ];
1420                 reg_trie_data *trie=aho->trie;
1421
1422                 const char *last_start = strend - trie->minlen;
1423 #ifdef DEBUGGING
1424                 const char *real_start = s;
1425 #endif
1426                 STRLEN maxlen = trie->maxlen;
1427                 SV *sv_points;
1428                 U8 **points; /* map of where we were in the input string
1429                                 when reading a given char. For ASCII this
1430                                 is unnecessary overhead as the relationship
1431                                 is always 1:1, but for unicode, especially
1432                                 case folded unicode this is not true. */
1433                 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1434                 U8 *bitmap=NULL;
1435
1436
1437                 GET_RE_DEBUG_FLAGS_DECL;
1438
1439                 /* We can't just allocate points here. We need to wrap it in
1440                  * an SV so it gets freed properly if there is a croak while
1441                  * running the match */
1442                 ENTER;
1443                 SAVETMPS;
1444                 sv_points=newSV(maxlen * sizeof(U8 *));
1445                 SvCUR_set(sv_points,
1446                     maxlen * sizeof(U8 *));
1447                 SvPOK_on(sv_points);
1448                 sv_2mortal(sv_points);
1449                 points=(U8**)SvPV_nolen(sv_points );
1450                 if ( trie_type != trie_utf8_fold
1451                      && (trie->bitmap || OP(c)==AHOCORASICKC) )
1452                 {
1453                     if (trie->bitmap)
1454                         bitmap=(U8*)trie->bitmap;
1455                     else
1456                         bitmap=(U8*)ANYOF_BITMAP(c);
1457                 }
1458                 /* this is the Aho-Corasick algorithm modified a touch
1459                    to include special handling for long "unknown char"
1460                    sequences. The basic idea being that we use AC as long
1461                    as we are dealing with a possible matching char, when
1462                    we encounter an unknown char (and we have not encountered
1463                    an accepting state) we scan forward until we find a legal
1464                    starting char.
1465                    AC matching is basically that of trie matching, except
1466                    that when we encounter a failing transition, we fall back
1467                    to the current states "fail state", and try the current char
1468                    again, a process we repeat until we reach the root state,
1469                    state 1, or a legal transition. If we fail on the root state
1470                    then we can either terminate if we have reached an accepting
1471                    state previously, or restart the entire process from the beginning
1472                    if we have not.
1473
1474                  */
1475                 while (s <= last_start) {
1476                     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1477                     U8 *uc = (U8*)s;
1478                     U16 charid = 0;
1479                     U32 base = 1;
1480                     U32 state = 1;
1481                     UV uvc = 0;
1482                     STRLEN len = 0;
1483                     STRLEN foldlen = 0;
1484                     U8 *uscan = (U8*)NULL;
1485                     U8 *leftmost = NULL;
1486 #ifdef DEBUGGING
1487                     U32 accepted_word= 0;
1488 #endif
1489                     U32 pointpos = 0;
1490
1491                     while ( state && uc <= (U8*)strend ) {
1492                         int failed=0;
1493                         U32 word = aho->states[ state ].wordnum;
1494
1495                         if( state==1 ) {
1496                             if ( bitmap ) {
1497                                 DEBUG_TRIE_EXECUTE_r(
1498                                     if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1499                                         dump_exec_pos( (char *)uc, c, strend, real_start,
1500                                             (char *)uc, do_utf8 );
1501                                         PerlIO_printf( Perl_debug_log,
1502                                             " Scanning for legal start char...\n");
1503                                     }
1504                                 );
1505                                 while ( uc <= (U8*)last_start  && !BITMAP_TEST(bitmap,*uc) ) {
1506                                     uc++;
1507                                 }
1508                                 s= (char *)uc;
1509                             }
1510                             if (uc >(U8*)last_start) break;
1511                         }
1512
1513                         if ( word ) {
1514                             U8 *lpos= points[ (pointpos - trie->wordlen[word-1] ) % maxlen ];
1515                             if (!leftmost || lpos < leftmost) {
1516                                 DEBUG_r(accepted_word=word);
1517                                 leftmost= lpos;
1518                             }
1519                             if (base==0) break;
1520
1521                         }
1522                         points[pointpos++ % maxlen]= uc;
1523                         REXEC_TRIE_READ_CHAR(trie_type, trie, uc, uscan, len,
1524                             uvc, charid, foldlen, foldbuf, uniflags);
1525                         DEBUG_TRIE_EXECUTE_r({
1526                             dump_exec_pos( (char *)uc, c, strend, real_start,
1527                                 s,   do_utf8 );
1528                             PerlIO_printf(Perl_debug_log,
1529                                 " Charid:%3u CP:%4"UVxf" ",
1530                                  charid, uvc);
1531                         });
1532
1533                         do {
1534 #ifdef DEBUGGING
1535                             word = aho->states[ state ].wordnum;
1536 #endif
1537                             base = aho->states[ state ].trans.base;
1538
1539                             DEBUG_TRIE_EXECUTE_r({
1540                                 if (failed)
1541                                     dump_exec_pos( (char *)uc, c, strend, real_start,
1542                                         s,   do_utf8 );
1543                                 PerlIO_printf( Perl_debug_log,
1544                                     "%sState: %4"UVxf", word=%"UVxf,
1545                                     failed ? " Fail transition to " : "",
1546                                     (UV)state, (UV)word);
1547                             });
1548                             if ( base ) {
1549                                 U32 tmp;
1550                                 if (charid &&
1551                                      (base + charid > trie->uniquecharcount )
1552                                      && (base + charid - 1 - trie->uniquecharcount
1553                                             < trie->lasttrans)
1554                                      && trie->trans[base + charid - 1 -
1555                                             trie->uniquecharcount].check == state
1556                                      && (tmp=trie->trans[base + charid - 1 -
1557                                         trie->uniquecharcount ].next))
1558                                 {
1559                                     DEBUG_TRIE_EXECUTE_r(
1560                                         PerlIO_printf( Perl_debug_log," - legal\n"));
1561                                     state = tmp;
1562                                     break;
1563                                 }
1564                                 else {
1565                                     DEBUG_TRIE_EXECUTE_r(
1566                                         PerlIO_printf( Perl_debug_log," - fail\n"));
1567                                     failed = 1;
1568                                     state = aho->fail[state];
1569                                 }
1570                             }
1571                             else {
1572                                 /* we must be accepting here */
1573                                 DEBUG_TRIE_EXECUTE_r(
1574                                         PerlIO_printf( Perl_debug_log," - accepting\n"));
1575                                 failed = 1;
1576                                 break;
1577                             }
1578                         } while(state);
1579                         uc += len;
1580                         if (failed) {
1581                             if (leftmost)
1582                                 break;
1583                             if (!state) state = 1;
1584                         }
1585                     }
1586                     if ( aho->states[ state ].wordnum ) {
1587                         U8 *lpos = points[ (pointpos - trie->wordlen[aho->states[ state ].wordnum-1]) % maxlen ];
1588                         if (!leftmost || lpos < leftmost) {
1589                             DEBUG_r(accepted_word=aho->states[ state ].wordnum);
1590                             leftmost = lpos;
1591                         }
1592                     }
1593                     if (leftmost) {
1594                         s = (char*)leftmost;
1595                         DEBUG_TRIE_EXECUTE_r({
1596                             PerlIO_printf(
1597                                 Perl_debug_log,"Matches word #%"UVxf" at position %d. Trying full pattern...\n",
1598                                 (UV)accepted_word, s - real_start
1599                             );
1600                         });
1601                         if (!reginfo || regtry(reginfo, &s)) {
1602                             FREETMPS;
1603                             LEAVE;
1604                             goto got_it;
1605                         }
1606                         s = HOPc(s,1);
1607                         DEBUG_TRIE_EXECUTE_r({
1608                             PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
1609                         });
1610                     } else {
1611                         DEBUG_TRIE_EXECUTE_r(
1612                             PerlIO_printf( Perl_debug_log,"No match.\n"));
1613                         break;
1614                     }
1615                 }
1616                 FREETMPS;
1617                 LEAVE;
1618             }
1619             break;
1620         default:
1621             Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
1622             break;
1623         }
1624         return 0;
1625       got_it:
1626         return s;
1627 }
1628
1629 /*
1630  - regexec_flags - match a regexp against a string
1631  */
1632 I32
1633 Perl_regexec_flags(pTHX_ register regexp *prog, char *stringarg, register char *strend,
1634               char *strbeg, I32 minend, SV *sv, void *data, U32 flags)
1635 /* strend: pointer to null at end of string */
1636 /* strbeg: real beginning of string */
1637 /* minend: end of match must be >=minend after stringarg. */
1638 /* data: May be used for some additional optimizations. */
1639 /* nosave: For optimizations. */
1640 {
1641     dVAR;
1642     /*register*/ char *s;
1643     register regnode *c;
1644     /*register*/ char *startpos = stringarg;
1645     I32 minlen;         /* must match at least this many chars */
1646     I32 dontbother = 0; /* how many characters not to try at end */
1647     I32 end_shift = 0;                  /* Same for the end. */         /* CC */
1648     I32 scream_pos = -1;                /* Internal iterator of scream. */
1649     char *scream_olds = NULL;
1650     SV* const oreplsv = GvSV(PL_replgv);
1651     const bool do_utf8 = (bool)DO_UTF8(sv);
1652     I32 multiline;
1653
1654     regmatch_info reginfo;  /* create some info to pass to regtry etc */
1655
1656     GET_RE_DEBUG_FLAGS_DECL;
1657
1658     PERL_UNUSED_ARG(data);
1659
1660     /* Be paranoid... */
1661     if (prog == NULL || startpos == NULL) {
1662         Perl_croak(aTHX_ "NULL regexp parameter");
1663         return 0;
1664     }
1665
1666     multiline = prog->reganch & PMf_MULTILINE;
1667     reginfo.prog = prog;
1668
1669     RX_MATCH_UTF8_set(prog, do_utf8);
1670     DEBUG_EXECUTE_r(
1671         debug_start_match(prog, do_utf8, startpos, strend,
1672         "Matching");
1673     );
1674
1675     minlen = prog->minlen;
1676
1677     if (strend - startpos < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
1678         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1679                               "String too short [regexec_flags]...\n"));
1680         goto phooey;
1681     }
1682
1683
1684     /* Check validity of program. */
1685     if (UCHARAT(prog->program) != REG_MAGIC) {
1686         Perl_croak(aTHX_ "corrupted regexp program");
1687     }
1688
1689     PL_reg_flags = 0;
1690     PL_reg_eval_set = 0;
1691     PL_reg_maxiter = 0;
1692
1693     if (prog->reganch & ROPT_UTF8)
1694         PL_reg_flags |= RF_utf8;
1695
1696     /* Mark beginning of line for ^ and lookbehind. */
1697     reginfo.bol = startpos; /* XXX not used ??? */
1698     PL_bostr  = strbeg;
1699     reginfo.sv = sv;
1700
1701     /* Mark end of line for $ (and such) */
1702     PL_regeol = strend;
1703
1704     /* see how far we have to get to not match where we matched before */
1705     reginfo.till = startpos+minend;
1706
1707     /* If there is a "must appear" string, look for it. */
1708     s = startpos;
1709
1710     if (prog->reganch & ROPT_GPOS_SEEN) { /* Need to set reginfo->ganch */
1711         MAGIC *mg;
1712
1713         if (flags & REXEC_IGNOREPOS)    /* Means: check only at start */
1714             reginfo.ganch = startpos;
1715         else if (sv && SvTYPE(sv) >= SVt_PVMG
1716                   && SvMAGIC(sv)
1717                   && (mg = mg_find(sv, PERL_MAGIC_regex_global))
1718                   && mg->mg_len >= 0) {
1719             reginfo.ganch = strbeg + mg->mg_len;        /* Defined pos() */
1720             if (prog->reganch & ROPT_ANCH_GPOS) {
1721                 if (s > reginfo.ganch)
1722                     goto phooey;
1723                 s = reginfo.ganch;
1724             }
1725         }
1726         else                            /* pos() not defined */
1727             reginfo.ganch = strbeg;
1728     }
1729
1730     if (!(flags & REXEC_CHECKED) && (prog->check_substr != NULL || prog->check_utf8 != NULL)) {
1731         re_scream_pos_data d;
1732
1733         d.scream_olds = &scream_olds;
1734         d.scream_pos = &scream_pos;
1735         s = re_intuit_start(prog, sv, s, strend, flags, &d);
1736         if (!s) {
1737             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not present...\n"));
1738             goto phooey;        /* not present */
1739         }
1740     }
1741
1742
1743
1744     /* Simplest case:  anchored match need be tried only once. */
1745     /*  [unless only anchor is BOL and multiline is set] */
1746     if (prog->reganch & (ROPT_ANCH & ~ROPT_ANCH_GPOS)) {
1747         if (s == startpos && regtry(&reginfo, &startpos))
1748             goto got_it;
1749         else if (multiline || (prog->reganch & ROPT_IMPLICIT)
1750                  || (prog->reganch & ROPT_ANCH_MBOL)) /* XXXX SBOL? */
1751         {
1752             char *end;
1753
1754             if (minlen)
1755                 dontbother = minlen - 1;
1756             end = HOP3c(strend, -dontbother, strbeg) - 1;
1757             /* for multiline we only have to try after newlines */
1758             if (prog->check_substr || prog->check_utf8) {
1759                 if (s == startpos)
1760                     goto after_try;
1761                 while (1) {
1762                     if (regtry(&reginfo, &s))
1763                         goto got_it;
1764                   after_try:
1765                     if (s >= end)
1766                         goto phooey;
1767                     if (prog->reganch & RE_USE_INTUIT) {
1768                         s = re_intuit_start(prog, sv, s + 1, strend, flags, NULL);
1769                         if (!s)
1770                             goto phooey;
1771                     }
1772                     else
1773                         s++;
1774                 }
1775             } else {
1776                 if (s > startpos)
1777                     s--;
1778                 while (s < end) {
1779                     if (*s++ == '\n') { /* don't need PL_utf8skip here */
1780                         if (regtry(&reginfo, &s))
1781                             goto got_it;
1782                     }
1783                 }
1784             }
1785         }
1786         goto phooey;
1787     } else if (ROPT_GPOS_CHECK == (prog->reganch & ROPT_GPOS_CHECK))
1788     {
1789         /* the warning about reginfo.ganch being used without intialization
1790            is bogus -- we set it above, when prog->reganch & ROPT_GPOS_SEEN
1791            and we only enter this block when the same bit is set. */
1792         if (regtry(&reginfo, &reginfo.ganch))
1793             goto got_it;
1794         goto phooey;
1795     }
1796
1797     /* Messy cases:  unanchored match. */
1798     if ((prog->anchored_substr || prog->anchored_utf8) && prog->reganch & ROPT_SKIP) {
1799         /* we have /x+whatever/ */
1800         /* it must be a one character string (XXXX Except UTF?) */
1801         char ch;
1802 #ifdef DEBUGGING
1803         int did_match = 0;
1804 #endif
1805         if (!(do_utf8 ? prog->anchored_utf8 : prog->anchored_substr))
1806             do_utf8 ? to_utf8_substr(prog) : to_byte_substr(prog);
1807         ch = SvPVX_const(do_utf8 ? prog->anchored_utf8 : prog->anchored_substr)[0];
1808
1809         if (do_utf8) {
1810             REXEC_FBC_SCAN(
1811                 if (*s == ch) {
1812                     DEBUG_EXECUTE_r( did_match = 1 );
1813                     if (regtry(&reginfo, &s)) goto got_it;
1814                     s += UTF8SKIP(s);
1815                     while (s < strend && *s == ch)
1816                         s += UTF8SKIP(s);
1817                 }
1818             );
1819         }
1820         else {
1821             REXEC_FBC_SCAN(
1822                 if (*s == ch) {
1823                     DEBUG_EXECUTE_r( did_match = 1 );
1824                     if (regtry(&reginfo, &s)) goto got_it;
1825                     s++;
1826                     while (s < strend && *s == ch)
1827                         s++;
1828                 }
1829             );
1830         }
1831         DEBUG_EXECUTE_r(if (!did_match)
1832                 PerlIO_printf(Perl_debug_log,
1833                                   "Did not find anchored character...\n")
1834                );
1835     }
1836     else if (prog->anchored_substr != NULL
1837               || prog->anchored_utf8 != NULL
1838               || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
1839                   && prog->float_max_offset < strend - s)) {
1840         SV *must;
1841         I32 back_max;
1842         I32 back_min;
1843         char *last;
1844         char *last1;            /* Last position checked before */
1845 #ifdef DEBUGGING
1846         int did_match = 0;
1847 #endif
1848         if (prog->anchored_substr || prog->anchored_utf8) {
1849             if (!(do_utf8 ? prog->anchored_utf8 : prog->anchored_substr))
1850                 do_utf8 ? to_utf8_substr(prog) : to_byte_substr(prog);
1851             must = do_utf8 ? prog->anchored_utf8 : prog->anchored_substr;
1852             back_max = back_min = prog->anchored_offset;
1853         } else {
1854             if (!(do_utf8 ? prog->float_utf8 : prog->float_substr))
1855                 do_utf8 ? to_utf8_substr(prog) : to_byte_substr(prog);
1856             must = do_utf8 ? prog->float_utf8 : prog->float_substr;
1857             back_max = prog->float_max_offset;
1858             back_min = prog->float_min_offset;
1859         }
1860
1861
1862         if (must == &PL_sv_undef)
1863             /* could not downgrade utf8 check substring, so must fail */
1864             goto phooey;
1865
1866         if (back_min<0) {
1867             last = strend;
1868         } else {
1869             last = HOP3c(strend,        /* Cannot start after this */
1870                   -(I32)(CHR_SVLEN(must)
1871                          - (SvTAIL(must) != 0) + back_min), strbeg);
1872         }
1873         if (s > PL_bostr)
1874             last1 = HOPc(s, -1);
1875         else
1876             last1 = s - 1;      /* bogus */
1877
1878         /* XXXX check_substr already used to find "s", can optimize if
1879            check_substr==must. */
1880         scream_pos = -1;
1881         dontbother = end_shift;
1882         strend = HOPc(strend, -dontbother);
1883         while ( (s <= last) &&
1884                 ((flags & REXEC_SCREAM)
1885                  ? (s = screaminstr(sv, must, HOP3c(s, back_min, (back_min<0 ? strbeg : strend)) - strbeg,
1886                                     end_shift, &scream_pos, 0))
1887                  : (s = fbm_instr((unsigned char*)HOP3(s, back_min, (back_min<0 ? strbeg : strend)),
1888                                   (unsigned char*)strend, must,
1889                                   multiline ? FBMrf_MULTILINE : 0))) ) {
1890             /* we may be pointing at the wrong string */
1891             if ((flags & REXEC_SCREAM) && RX_MATCH_COPIED(prog))
1892                 s = strbeg + (s - SvPVX_const(sv));
1893             DEBUG_EXECUTE_r( did_match = 1 );
1894             if (HOPc(s, -back_max) > last1) {
1895                 last1 = HOPc(s, -back_min);
1896                 s = HOPc(s, -back_max);
1897             }
1898             else {
1899                 char * const t = (last1 >= PL_bostr) ? HOPc(last1, 1) : last1 + 1;
1900
1901                 last1 = HOPc(s, -back_min);
1902                 s = t;
1903             }
1904             if (do_utf8) {
1905                 while (s <= last1) {
1906                     if (regtry(&reginfo, &s))
1907                         goto got_it;
1908                     s += UTF8SKIP(s);
1909                 }
1910             }
1911             else {
1912                 while (s <= last1) {
1913                     if (regtry(&reginfo, &s))
1914                         goto got_it;
1915                     s++;
1916                 }
1917             }
1918         }
1919         DEBUG_EXECUTE_r(if (!did_match) {
1920             RE_PV_QUOTED_DECL(quoted, do_utf8, PERL_DEBUG_PAD_ZERO(0),
1921                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
1922             PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
1923                               ((must == prog->anchored_substr || must == prog->anchored_utf8)
1924                                ? "anchored" : "floating"),
1925                 quoted, RE_SV_TAIL(must));
1926         });
1927         goto phooey;
1928     }
1929     else if ( (c = prog->regstclass) ) {
1930         if (minlen) {
1931             const OPCODE op = OP(prog->regstclass);
1932             /* don't bother with what can't match */
1933             if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
1934                 strend = HOPc(strend, -(minlen - 1));
1935         }
1936         DEBUG_EXECUTE_r({
1937             SV * const prop = sv_newmortal();
1938             regprop(prog, prop, c);
1939             {
1940                 RE_PV_QUOTED_DECL(quoted,UTF,PERL_DEBUG_PAD_ZERO(1),
1941                     s,strend-s,60);
1942                 PerlIO_printf(Perl_debug_log,
1943                     "Matching stclass %.*s against %s (%d chars)\n",
1944                     (int)SvCUR(prop), SvPVX_const(prop),
1945                      quoted, (int)(strend - s));
1946             }
1947         });
1948         if (find_byclass(prog, c, s, strend, &reginfo))
1949             goto got_it;
1950         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
1951     }
1952     else {
1953         dontbother = 0;
1954         if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
1955             /* Trim the end. */
1956             char *last;
1957             SV* float_real;
1958
1959             if (!(do_utf8 ? prog->float_utf8 : prog->float_substr))
1960                 do_utf8 ? to_utf8_substr(prog) : to_byte_substr(prog);
1961             float_real = do_utf8 ? prog->float_utf8 : prog->float_substr;
1962
1963             if (flags & REXEC_SCREAM) {
1964                 last = screaminstr(sv, float_real, s - strbeg,
1965                                    end_shift, &scream_pos, 1); /* last one */
1966                 if (!last)
1967                     last = scream_olds; /* Only one occurrence. */
1968                 /* we may be pointing at the wrong string */
1969                 else if (RX_MATCH_COPIED(prog))
1970                     s = strbeg + (s - SvPVX_const(sv));
1971             }
1972             else {
1973                 STRLEN len;
1974                 const char * const little = SvPV_const(float_real, len);
1975
1976                 if (SvTAIL(float_real)) {
1977                     if (memEQ(strend - len + 1, little, len - 1))
1978                         last = strend - len + 1;
1979                     else if (!multiline)
1980                         last = memEQ(strend - len, little, len)
1981                             ? strend - len : NULL;
1982                     else
1983                         goto find_last;
1984                 } else {
1985                   find_last:
1986                     if (len)
1987                         last = rninstr(s, strend, little, little + len);
1988                     else
1989                         last = strend;  /* matching "$" */
1990                 }
1991             }
1992             if (last == NULL) {
1993                 DEBUG_EXECUTE_r(
1994                     PerlIO_printf(Perl_debug_log,
1995                         "%sCan't trim the tail, match fails (should not happen)%s\n",
1996                         PL_colors[4], PL_colors[5]));
1997                 goto phooey; /* Should not happen! */
1998             }
1999             dontbother = strend - last + prog->float_min_offset;
2000         }
2001         if (minlen && (dontbother < minlen))
2002             dontbother = minlen - 1;
2003         strend -= dontbother;              /* this one's always in bytes! */
2004         /* We don't know much -- general case. */
2005         if (do_utf8) {
2006             for (;;) {
2007                 if (regtry(&reginfo, &s))
2008                     goto got_it;
2009                 if (s >= strend)
2010                     break;
2011                 s += UTF8SKIP(s);
2012             };
2013         }
2014         else {
2015             do {
2016                 if (regtry(&reginfo, &s))
2017                     goto got_it;
2018             } while (s++ < strend);
2019         }
2020     }
2021
2022     /* Failure. */
2023     goto phooey;
2024
2025 got_it:
2026     RX_MATCH_TAINTED_set(prog, PL_reg_flags & RF_tainted);
2027
2028     if (PL_reg_eval_set) {
2029         /* Preserve the current value of $^R */
2030         if (oreplsv != GvSV(PL_replgv))
2031             sv_setsv(oreplsv, GvSV(PL_replgv));/* So that when GvSV(replgv) is
2032                                                   restored, the value remains
2033                                                   the same. */
2034         restore_pos(aTHX_ prog);
2035     }
2036     if (prog->paren_names)
2037         (void)hv_iterinit(prog->paren_names);
2038
2039     /* make sure $`, $&, $', and $digit will work later */
2040     if ( !(flags & REXEC_NOT_FIRST) ) {
2041         RX_MATCH_COPY_FREE(prog);
2042         if (flags & REXEC_COPY_STR) {
2043             const I32 i = PL_regeol - startpos + (stringarg - strbeg);
2044 #ifdef PERL_OLD_COPY_ON_WRITE
2045             if ((SvIsCOW(sv)
2046                  || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)) {
2047                 if (DEBUG_C_TEST) {
2048                     PerlIO_printf(Perl_debug_log,
2049                                   "Copy on write: regexp capture, type %d\n",
2050                                   (int) SvTYPE(sv));
2051                 }
2052                 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2053                 prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2054                 assert (SvPOKp(prog->saved_copy));
2055             } else
2056 #endif
2057             {
2058                 RX_MATCH_COPIED_on(prog);
2059                 s = savepvn(strbeg, i);
2060                 prog->subbeg = s;
2061             }
2062             prog->sublen = i;
2063         }
2064         else {
2065             prog->subbeg = strbeg;
2066             prog->sublen = PL_regeol - strbeg;  /* strend may have been modified */
2067         }
2068     }
2069
2070     return 1;
2071
2072 phooey:
2073     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
2074                           PL_colors[4], PL_colors[5]));
2075     if (PL_reg_eval_set)
2076         restore_pos(aTHX_ prog);
2077     return 0;
2078 }
2079
2080
2081 /*
2082  - regtry - try match at specific point
2083  */
2084 STATIC I32                      /* 0 failure, 1 success */
2085 S_regtry(pTHX_ regmatch_info *reginfo, char **startpos)
2086 {
2087     dVAR;
2088     register I32 *sp;
2089     register I32 *ep;
2090     CHECKPOINT lastcp;
2091     regexp *prog = reginfo->prog;
2092     GET_RE_DEBUG_FLAGS_DECL;
2093     reginfo->cutpoint=NULL;
2094
2095     if ((prog->reganch & ROPT_EVAL_SEEN) && !PL_reg_eval_set) {
2096         MAGIC *mg;
2097
2098         PL_reg_eval_set = RS_init;
2099         DEBUG_EXECUTE_r(DEBUG_s(
2100             PerlIO_printf(Perl_debug_log, "  setting stack tmpbase at %"IVdf"\n",
2101                           (IV)(PL_stack_sp - PL_stack_base));
2102             ));
2103         SAVESTACK_CXPOS();
2104         cxstack[cxstack_ix].blk_oldsp = PL_stack_sp - PL_stack_base;
2105         /* Otherwise OP_NEXTSTATE will free whatever on stack now.  */
2106         SAVETMPS;
2107         /* Apparently this is not needed, judging by wantarray. */
2108         /* SAVEI8(cxstack[cxstack_ix].blk_gimme);
2109            cxstack[cxstack_ix].blk_gimme = G_SCALAR; */
2110
2111         if (reginfo->sv) {
2112             /* Make $_ available to executed code. */
2113             if (reginfo->sv != DEFSV) {
2114                 SAVE_DEFSV;
2115                 DEFSV = reginfo->sv;
2116             }
2117
2118             if (!(SvTYPE(reginfo->sv) >= SVt_PVMG && SvMAGIC(reginfo->sv)
2119                   && (mg = mg_find(reginfo->sv, PERL_MAGIC_regex_global)))) {
2120                 /* prepare for quick setting of pos */
2121 #ifdef PERL_OLD_COPY_ON_WRITE
2122                 if (SvIsCOW(sv))
2123                     sv_force_normal_flags(sv, 0);
2124 #endif
2125                 mg = sv_magicext(reginfo->sv, NULL, PERL_MAGIC_regex_global,
2126                                  &PL_vtbl_mglob, NULL, 0);
2127                 mg->mg_len = -1;
2128             }
2129             PL_reg_magic    = mg;
2130             PL_reg_oldpos   = mg->mg_len;
2131             SAVEDESTRUCTOR_X(restore_pos, prog);
2132         }
2133         if (!PL_reg_curpm) {
2134             Newxz(PL_reg_curpm, 1, PMOP);
2135 #ifdef USE_ITHREADS
2136             {
2137                 SV* const repointer = newSViv(0);
2138                 /* so we know which PL_regex_padav element is PL_reg_curpm */
2139                 SvFLAGS(repointer) |= SVf_BREAK;
2140                 av_push(PL_regex_padav,repointer);
2141                 PL_reg_curpm->op_pmoffset = av_len(PL_regex_padav);
2142                 PL_regex_pad = AvARRAY(PL_regex_padav);
2143             }
2144 #endif
2145         }
2146         PM_SETRE(PL_reg_curpm, prog);
2147         PL_reg_oldcurpm = PL_curpm;
2148         PL_curpm = PL_reg_curpm;
2149         if (RX_MATCH_COPIED(prog)) {
2150             /*  Here is a serious problem: we cannot rewrite subbeg,
2151                 since it may be needed if this match fails.  Thus
2152                 $` inside (?{}) could fail... */
2153             PL_reg_oldsaved = prog->subbeg;
2154             PL_reg_oldsavedlen = prog->sublen;
2155 #ifdef PERL_OLD_COPY_ON_WRITE
2156             PL_nrs = prog->saved_copy;
2157 #endif
2158             RX_MATCH_COPIED_off(prog);
2159         }
2160         else
2161             PL_reg_oldsaved = NULL;
2162         prog->subbeg = PL_bostr;
2163         prog->sublen = PL_regeol - PL_bostr; /* strend may have been modified */
2164     }
2165     DEBUG_EXECUTE_r(PL_reg_starttry = *startpos);
2166     prog->startp[0] = *startpos - PL_bostr;
2167     PL_reginput = *startpos;
2168     PL_reglastparen = &prog->lastparen;
2169     PL_reglastcloseparen = &prog->lastcloseparen;
2170     prog->lastparen = 0;
2171     prog->lastcloseparen = 0;
2172     PL_regsize = 0;
2173     PL_regstartp = prog->startp;
2174     PL_regendp = prog->endp;
2175     if (PL_reg_start_tmpl <= prog->nparens) {
2176         PL_reg_start_tmpl = prog->nparens*3/2 + 3;
2177         if(PL_reg_start_tmp)
2178             Renew(PL_reg_start_tmp, PL_reg_start_tmpl, char*);
2179         else
2180             Newx(PL_reg_start_tmp, PL_reg_start_tmpl, char*);
2181     }
2182
2183     /* XXXX What this code is doing here?!!!  There should be no need
2184        to do this again and again, PL_reglastparen should take care of
2185        this!  --ilya*/
2186
2187     /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
2188      * Actually, the code in regcppop() (which Ilya may be meaning by
2189      * PL_reglastparen), is not needed at all by the test suite
2190      * (op/regexp, op/pat, op/split), but that code is needed, oddly
2191      * enough, for building DynaLoader, or otherwise this
2192      * "Error: '*' not in typemap in DynaLoader.xs, line 164"
2193      * will happen.  Meanwhile, this code *is* needed for the
2194      * above-mentioned test suite tests to succeed.  The common theme
2195      * on those tests seems to be returning null fields from matches.
2196      * --jhi */
2197 #if 1
2198     sp = prog->startp;
2199     ep = prog->endp;
2200     if (prog->nparens) {
2201         register I32 i;
2202         for (i = prog->nparens; i > (I32)*PL_reglastparen; i--) {
2203             *++sp = -1;
2204             *++ep = -1;
2205         }
2206     }
2207 #endif
2208     REGCP_SET(lastcp);
2209     if (regmatch(reginfo, prog->program + 1)) {
2210         prog->endp[0] = PL_reginput - PL_bostr;
2211         return 1;
2212     }
2213     if (reginfo->cutpoint)
2214         *startpos= reginfo->cutpoint;
2215     REGCP_UNWIND(lastcp);
2216     return 0;
2217 }
2218
2219
2220 #define sayYES goto yes
2221 #define sayNO goto no
2222 #define sayNO_SILENT goto no_silent
2223
2224 /* we dont use STMT_START/END here because it leads to
2225    "unreachable code" warnings, which are bogus, but distracting. */
2226 #define CACHEsayNO \
2227     if (ST.cache_mask) \
2228        PL_reg_poscache[ST.cache_offset] |= ST.cache_mask; \
2229     sayNO
2230
2231 /* this is used to determine how far from the left messages like
2232    'failed...' are printed. It should be set such that messages
2233    are inline with the regop output that created them.
2234 */
2235 #define REPORT_CODE_OFF 32
2236
2237
2238 /* Make sure there is a test for this +1 options in re_tests */
2239 #define TRIE_INITAL_ACCEPT_BUFFLEN 4;
2240
2241 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
2242 #define CHRTEST_VOID   -1000 /* the c1/c2 "next char" test should be skipped */
2243
2244 #define SLAB_FIRST(s) (&(s)->states[0])
2245 #define SLAB_LAST(s)  (&(s)->states[PERL_REGMATCH_SLAB_SLOTS-1])
2246
2247 /* grab a new slab and return the first slot in it */
2248
2249 STATIC regmatch_state *
2250 S_push_slab(pTHX)
2251 {
2252 #if PERL_VERSION < 9
2253     dMY_CXT;
2254 #endif
2255     regmatch_slab *s = PL_regmatch_slab->next;
2256     if (!s) {
2257         Newx(s, 1, regmatch_slab);
2258         s->prev = PL_regmatch_slab;
2259         s->next = NULL;
2260         PL_regmatch_slab->next = s;
2261     }
2262     PL_regmatch_slab = s;
2263     return SLAB_FIRST(s);
2264 }
2265
2266
2267 /* push a new state then goto it */
2268
2269 #define PUSH_STATE_GOTO(state, node) \
2270     scan = node; \
2271     st->resume_state = state; \
2272     goto push_state;
2273
2274 /* push a new state with success backtracking, then goto it */
2275
2276 #define PUSH_YES_STATE_GOTO(state, node) \
2277     scan = node; \
2278     st->resume_state = state; \
2279     goto push_yes_state;
2280
2281
2282
2283 /*
2284
2285 regmatch() - main matching routine
2286
2287 This is basically one big switch statement in a loop. We execute an op,
2288 set 'next' to point the next op, and continue. If we come to a point which
2289 we may need to backtrack to on failure such as (A|B|C), we push a
2290 backtrack state onto the backtrack stack. On failure, we pop the top
2291 state, and re-enter the loop at the state indicated. If there are no more
2292 states to pop, we return failure.
2293
2294 Sometimes we also need to backtrack on success; for example /A+/, where
2295 after successfully matching one A, we need to go back and try to
2296 match another one; similarly for lookahead assertions: if the assertion
2297 completes successfully, we backtrack to the state just before the assertion
2298 and then carry on.  In these cases, the pushed state is marked as
2299 'backtrack on success too'. This marking is in fact done by a chain of
2300 pointers, each pointing to the previous 'yes' state. On success, we pop to
2301 the nearest yes state, discarding any intermediate failure-only states.
2302 Sometimes a yes state is pushed just to force some cleanup code to be
2303 called at the end of a successful match or submatch; e.g. (??{$re}) uses
2304 it to free the inner regex.
2305
2306 Note that failure backtracking rewinds the cursor position, while
2307 success backtracking leaves it alone.
2308
2309 A pattern is complete when the END op is executed, while a subpattern
2310 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
2311 ops trigger the "pop to last yes state if any, otherwise return true"
2312 behaviour.
2313
2314 A common convention in this function is to use A and B to refer to the two
2315 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
2316 the subpattern to be matched possibly multiple times, while B is the entire
2317 rest of the pattern. Variable and state names reflect this convention.
2318
2319 The states in the main switch are the union of ops and failure/success of
2320 substates associated with with that op.  For example, IFMATCH is the op
2321 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
2322 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
2323 successfully matched A and IFMATCH_A_fail is a state saying that we have
2324 just failed to match A. Resume states always come in pairs. The backtrack
2325 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
2326 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
2327 on success or failure.
2328
2329 The struct that holds a backtracking state is actually a big union, with
2330 one variant for each major type of op. The variable st points to the
2331 top-most backtrack struct. To make the code clearer, within each
2332 block of code we #define ST to alias the relevant union.
2333
2334 Here's a concrete example of a (vastly oversimplified) IFMATCH
2335 implementation:
2336
2337     switch (state) {
2338     ....
2339
2340 #define ST st->u.ifmatch
2341
2342     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
2343         ST.foo = ...; // some state we wish to save
2344         ...
2345         // push a yes backtrack state with a resume value of
2346         // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
2347         // first node of A:
2348         PUSH_YES_STATE_GOTO(IFMATCH_A, A);
2349         // NOTREACHED
2350
2351     case IFMATCH_A: // we have successfully executed A; now continue with B
2352         next = B;
2353         bar = ST.foo; // do something with the preserved value
2354         break;
2355
2356     case IFMATCH_A_fail: // A failed, so the assertion failed
2357         ...;   // do some housekeeping, then ...
2358         sayNO; // propagate the failure
2359
2360 #undef ST
2361
2362     ...
2363     }
2364
2365 For any old-timers reading this who are familiar with the old recursive
2366 approach, the code above is equivalent to:
2367
2368     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
2369     {
2370         int foo = ...
2371         ...
2372         if (regmatch(A)) {
2373             next = B;
2374             bar = foo;
2375             break;
2376         }
2377         ...;   // do some housekeeping, then ...
2378         sayNO; // propagate the failure
2379     }
2380
2381 The topmost backtrack state, pointed to by st, is usually free. If you
2382 want to claim it, populate any ST.foo fields in it with values you wish to
2383 save, then do one of
2384
2385         PUSH_STATE_GOTO(resume_state, node);
2386         PUSH_YES_STATE_GOTO(resume_state, node);
2387
2388 which sets that backtrack state's resume value to 'resume_state', pushes a
2389 new free entry to the top of the backtrack stack, then goes to 'node'.
2390 On backtracking, the free slot is popped, and the saved state becomes the
2391 new free state. An ST.foo field in this new top state can be temporarily
2392 accessed to retrieve values, but once the main loop is re-entered, it
2393 becomes available for reuse.
2394
2395 Note that the depth of the backtrack stack constantly increases during the
2396 left-to-right execution of the pattern, rather than going up and down with
2397 the pattern nesting. For example the stack is at its maximum at Z at the
2398 end of the pattern, rather than at X in the following:
2399
2400     /(((X)+)+)+....(Y)+....Z/
2401
2402 The only exceptions to this are lookahead/behind assertions and the cut,
2403 (?>A), which pop all the backtrack states associated with A before
2404 continuing.
2405
2406 Bascktrack state structs are allocated in slabs of about 4K in size.
2407 PL_regmatch_state and st always point to the currently active state,
2408 and PL_regmatch_slab points to the slab currently containing
2409 PL_regmatch_state.  The first time regmatch() is called, the first slab is
2410 allocated, and is never freed until interpreter destruction. When the slab
2411 is full, a new one is allocated and chained to the end. At exit from
2412 regmatch(), slabs allocated since entry are freed.
2413
2414 */
2415
2416
2417 #define DEBUG_STATE_pp(pp)                                  \
2418     DEBUG_STATE_r({                                         \
2419         DUMP_EXEC_POS(locinput, scan, do_utf8);             \
2420         PerlIO_printf(Perl_debug_log,                       \
2421             "    %*s"pp" %s\n",                             \
2422             depth*2, "",                                    \
2423             reg_name[st->resume_state] );   \
2424     });
2425
2426
2427 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
2428
2429 #ifdef DEBUGGING
2430
2431 STATIC void
2432 S_debug_start_match(pTHX_ const regexp *prog, const bool do_utf8,
2433     const char *start, const char *end, const char *blurb)
2434 {
2435     const bool utf8_pat= prog->reganch & ROPT_UTF8 ? 1 : 0;
2436     if (!PL_colorset)
2437             reginitcolors();
2438     {
2439         RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0),
2440             prog->precomp, prog->prelen, 60);
2441
2442         RE_PV_QUOTED_DECL(s1, do_utf8, PERL_DEBUG_PAD_ZERO(1),
2443             start, end - start, 60);
2444
2445         PerlIO_printf(Perl_debug_log,
2446             "%s%s REx%s %s against %s\n",
2447                        PL_colors[4], blurb, PL_colors[5], s0, s1);
2448
2449         if (do_utf8||utf8_pat)
2450             PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
2451                 utf8_pat ? "pattern" : "",
2452                 utf8_pat && do_utf8 ? " and " : "",
2453                 do_utf8 ? "string" : ""
2454             );
2455     }
2456 }
2457
2458 STATIC void
2459 S_dump_exec_pos(pTHX_ const char *locinput,
2460                       const regnode *scan,
2461                       const char *loc_regeol,
2462                       const char *loc_bostr,
2463                       const char *loc_reg_starttry,
2464                       const bool do_utf8)
2465 {
2466     const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
2467     const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
2468     int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
2469     /* The part of the string before starttry has one color
2470        (pref0_len chars), between starttry and current
2471        position another one (pref_len - pref0_len chars),
2472        after the current position the third one.
2473        We assume that pref0_len <= pref_len, otherwise we
2474        decrease pref0_len.  */
2475     int pref_len = (locinput - loc_bostr) > (5 + taill) - l
2476         ? (5 + taill) - l : locinput - loc_bostr;
2477     int pref0_len;
2478
2479     while (do_utf8 && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
2480         pref_len++;
2481     pref0_len = pref_len  - (locinput - loc_reg_starttry);
2482     if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
2483         l = ( loc_regeol - locinput > (5 + taill) - pref_len
2484               ? (5 + taill) - pref_len : loc_regeol - locinput);
2485     while (do_utf8 && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
2486         l--;
2487     if (pref0_len < 0)
2488         pref0_len = 0;
2489     if (pref0_len > pref_len)
2490         pref0_len = pref_len;
2491     {
2492         const int is_uni = (do_utf8 && OP(scan) != CANY) ? 1 : 0;
2493
2494         RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
2495             (locinput - pref_len),pref0_len, 60, 4, 5);
2496
2497         RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
2498                     (locinput - pref_len + pref0_len),
2499                     pref_len - pref0_len, 60, 2, 3);
2500
2501         RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
2502                     locinput, loc_regeol - locinput, 10, 0, 1);
2503
2504         const STRLEN tlen=len0+len1+len2;
2505         PerlIO_printf(Perl_debug_log,
2506                     "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
2507                     (IV)(locinput - loc_bostr),
2508                     len0, s0,
2509                     len1, s1,
2510                     (docolor ? "" : "> <"),
2511                     len2, s2,
2512                     (int)(tlen > 19 ? 0 :  19 - tlen),
2513                     "");
2514     }
2515 }
2516
2517 #endif
2518
2519 /* reg_check_named_buff_matched()
2520  * Checks to see if a named buffer has matched. The data array of
2521  * buffer numbers corresponding to the buffer is expected to reside
2522  * in the regexp->data->data array in the slot stored in the ARG() of
2523  * node involved. Note that this routine doesn't actually care about the
2524  * name, that information is not preserved from compilation to execution.
2525  * Returns the index of the leftmost defined buffer with the given name
2526  * or 0 if non of the buffers matched.
2527  */
2528 STATIC I32
2529 S_reg_check_named_buff_matched(pTHX_ const regexp *rex, const regnode *scan) {
2530     I32 n;
2531     SV *sv_dat=(SV*)rex->data->data[ ARG( scan ) ];
2532     I32 *nums=(I32*)SvPVX(sv_dat);
2533     for ( n=0; n<SvIVX(sv_dat); n++ ) {
2534         if ((I32)*PL_reglastparen >= nums[n] &&
2535             PL_regendp[nums[n]] != -1)
2536         {
2537             return nums[n];
2538         }
2539     }
2540     return 0;
2541 }
2542
2543 STATIC I32                      /* 0 failure, 1 success */
2544 S_regmatch(pTHX_ regmatch_info *reginfo, regnode *prog)
2545 {
2546 #if PERL_VERSION < 9
2547     dMY_CXT;
2548 #endif
2549     dVAR;
2550     register const bool do_utf8 = PL_reg_match_utf8;
2551     const U32 uniflags = UTF8_ALLOW_DEFAULT;
2552
2553     regexp *rex = reginfo->prog;
2554
2555     regmatch_slab  *orig_slab;
2556     regmatch_state *orig_state;
2557
2558     /* the current state. This is a cached copy of PL_regmatch_state */
2559     register regmatch_state *st;
2560
2561     /* cache heavy used fields of st in registers */
2562     register regnode *scan;
2563     register regnode *next;
2564     register U32 n = 0; /* general value; init to avoid compiler warning */
2565     register I32 ln = 0; /* len or last;  init to avoid compiler warning */
2566     register char *locinput = PL_reginput;
2567     register I32 nextchr;   /* is always set to UCHARAT(locinput) */
2568
2569     bool result = 0;        /* return value of S_regmatch */
2570     int depth = 0;          /* depth of backtrack stack */
2571     int nochange_depth = 0; /* depth of GOSUB recursion with nochange*/
2572     regmatch_state *yes_state = NULL; /* state to pop to on success of
2573                                                             subpattern */
2574     /* mark_state piggy backs on the yes_state logic so that when we unwind
2575        the stack on success we can update the mark_state as we go */
2576     regmatch_state *mark_state = NULL; /* last mark state we have seen */
2577     regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
2578     struct regmatch_state  *cur_curlyx = NULL; /* most recent curlyx */
2579     U32 state_num;
2580     bool no_final = 0;
2581     char *startpoint = PL_reginput;
2582     SV *popmark = NULL;
2583     SV *sv_commit = NULL;
2584     int lastopen = 0;
2585     /* these three flags are set by various ops to signal information to
2586      * the very next op. They have a useful lifetime of exactly one loop
2587      * iteration, and are not preserved or restored by state pushes/pops
2588      */
2589     bool sw = 0;            /* the condition value in (?(cond)a|b) */
2590     bool minmod = 0;        /* the next "{n,m}" is a "{n,m}?" */
2591     int logical = 0;        /* the following EVAL is:
2592                                 0: (?{...})
2593                                 1: (?(?{...})X|Y)
2594                                 2: (??{...})
2595                                or the following IFMATCH/UNLESSM is:
2596                                 false: plain (?=foo)
2597                                 true:  used as a condition: (?(?=foo))
2598                             */
2599
2600 #ifdef DEBUGGING
2601     GET_RE_DEBUG_FLAGS_DECL;
2602 #endif
2603
2604     DEBUG_STACK_r( {
2605             PerlIO_printf(Perl_debug_log,"regmatch start\n");
2606     });
2607     /* on first ever call to regmatch, allocate first slab */
2608     if (!PL_regmatch_slab) {
2609         Newx(PL_regmatch_slab, 1, regmatch_slab);
2610         PL_regmatch_slab->prev = NULL;
2611         PL_regmatch_slab->next = NULL;
2612         PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
2613     }
2614
2615     /* remember current high-water mark for exit */
2616     /* XXX this should be done with SAVE* instead */
2617     orig_slab  = PL_regmatch_slab;
2618     orig_state = PL_regmatch_state;
2619
2620     /* grab next free state slot */
2621     st = ++PL_regmatch_state;
2622     if (st >  SLAB_LAST(PL_regmatch_slab))
2623         st = PL_regmatch_state = S_push_slab(aTHX);
2624
2625     /* Note that nextchr is a byte even in UTF */
2626     nextchr = UCHARAT(locinput);
2627     scan = prog;
2628     while (scan != NULL) {
2629
2630         DEBUG_EXECUTE_r( {
2631             SV * const prop = sv_newmortal();
2632             regnode *rnext=regnext(scan);
2633             DUMP_EXEC_POS( locinput, scan, do_utf8 );
2634             regprop(rex, prop, scan);
2635
2636             PerlIO_printf(Perl_debug_log,
2637                     "%3"IVdf":%*s%s(%"IVdf")\n",
2638                     (IV)(scan - rex->program), depth*2, "",
2639                     SvPVX_const(prop),
2640                     (PL_regkind[OP(scan)] == END || !rnext) ?
2641                         0 : (IV)(rnext - rex->program));
2642         });
2643
2644         next = scan + NEXT_OFF(scan);
2645         if (next == scan)
2646             next = NULL;
2647         state_num = OP(scan);
2648
2649       reenter_switch:
2650         switch (state_num) {
2651         case BOL:
2652             if (locinput == PL_bostr)
2653             {
2654                 /* reginfo->till = reginfo->bol; */
2655                 break;
2656             }
2657             sayNO;
2658         case MBOL:
2659             if (locinput == PL_bostr ||
2660                 ((nextchr || locinput < PL_regeol) && locinput[-1] == '\n'))
2661             {
2662                 break;
2663             }
2664             sayNO;
2665         case SBOL:
2666             if (locinput == PL_bostr)
2667                 break;
2668             sayNO;
2669         case GPOS:
2670             if (locinput == reginfo->ganch)
2671                 break;
2672             sayNO;
2673         case EOL:
2674                 goto seol;
2675         case MEOL:
2676             if ((nextchr || locinput < PL_regeol) && nextchr != '\n')
2677                 sayNO;
2678             break;
2679         case SEOL:
2680           seol:
2681             if ((nextchr || locinput < PL_regeol) && nextchr != '\n')
2682                 sayNO;
2683             if (PL_regeol - locinput > 1)
2684                 sayNO;
2685             break;
2686         case EOS:
2687             if (PL_regeol != locinput)
2688                 sayNO;
2689             break;
2690         case SANY:
2691             if (!nextchr && locinput >= PL_regeol)
2692                 sayNO;
2693             if (do_utf8) {
2694                 locinput += PL_utf8skip[nextchr];
2695                 if (locinput > PL_regeol)
2696                     sayNO;
2697                 nextchr = UCHARAT(locinput);
2698             }
2699             else
2700                 nextchr = UCHARAT(++locinput);
2701             break;
2702         case CANY:
2703             if (!nextchr && locinput >= PL_regeol)
2704                 sayNO;
2705             nextchr = UCHARAT(++locinput);
2706             break;
2707         case REG_ANY:
2708             if ((!nextchr && locinput >= PL_regeol) || nextchr == '\n')
2709                 sayNO;
2710             if (do_utf8) {
2711                 locinput += PL_utf8skip[nextchr];
2712                 if (locinput > PL_regeol)
2713                     sayNO;
2714                 nextchr = UCHARAT(locinput);
2715             }
2716             else
2717                 nextchr = UCHARAT(++locinput);
2718             break;
2719
2720 #undef  ST
2721 #define ST st->u.trie
2722         case TRIEC:
2723             /* In this case the charclass data is available inline so
2724                we can fail fast without a lot of extra overhead.
2725              */
2726             if (scan->flags == EXACT || !do_utf8) {
2727                 if(!ANYOF_BITMAP_TEST(scan, *locinput)) {
2728                     DEBUG_EXECUTE_r(
2729                         PerlIO_printf(Perl_debug_log,
2730                                   "%*s  %sfailed to match trie start class...%s\n",
2731                                   REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
2732                     );
2733                     sayNO_SILENT;
2734                     /* NOTREACHED */
2735                 }
2736             }
2737             /* FALL THROUGH */
2738         case TRIE:
2739             {
2740                 /* what type of TRIE am I? (utf8 makes this contextual) */
2741                 const enum { trie_plain, trie_utf8, trie_utf8_fold }
2742                     trie_type = do_utf8 ?
2743                           (scan->flags == EXACT ? trie_utf8 : trie_utf8_fold)
2744                         : trie_plain;
2745
2746                 /* what trie are we using right now */
2747                 reg_trie_data * const trie
2748                     = (reg_trie_data*)rex->data->data[ ARG( scan ) ];
2749                 U32 state = trie->startstate;
2750
2751                 if (trie->bitmap && trie_type != trie_utf8_fold &&
2752                     !TRIE_BITMAP_TEST(trie,*locinput)
2753                 ) {
2754                     if (trie->states[ state ].wordnum) {
2755                          DEBUG_EXECUTE_r(
2756                             PerlIO_printf(Perl_debug_log,
2757                                           "%*s  %smatched empty string...%s\n",
2758                                           REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
2759                         );
2760                         break;
2761                     } else {
2762                         DEBUG_EXECUTE_r(
2763                             PerlIO_printf(Perl_debug_log,
2764                                           "%*s  %sfailed to match trie start class...%s\n",
2765                                           REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
2766                         );
2767                         sayNO_SILENT;
2768                    }
2769                 }
2770
2771             {
2772                 U8 *uc = ( U8* )locinput;
2773
2774                 STRLEN len = 0;
2775                 STRLEN foldlen = 0;
2776                 U8 *uscan = (U8*)NULL;
2777                 STRLEN bufflen=0;
2778                 SV *sv_accept_buff = NULL;
2779                 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2780
2781                 ST.accepted = 0; /* how many accepting states we have seen */
2782                 ST.B = next;
2783                 ST.jump = trie->jump;
2784                 ST.me = scan;
2785
2786                 /*
2787                    traverse the TRIE keeping track of all accepting states
2788                    we transition through until we get to a failing node.
2789                 */
2790
2791                 while ( state && uc <= (U8*)PL_regeol ) {
2792                     U32 base = trie->states[ state ].trans.base;
2793                     UV uvc = 0;
2794                     U16 charid;
2795                     /* We use charid to hold the wordnum as we don't use it
2796                        for charid until after we have done the wordnum logic.
2797                        We define an alias just so that the wordnum logic reads
2798                        more naturally. */
2799
2800 #define got_wordnum charid
2801                     got_wordnum = trie->states[ state ].wordnum;
2802
2803                     if ( got_wordnum ) {
2804                         if ( ! ST.accepted ) {
2805                             ENTER;
2806                             SAVETMPS;
2807                             bufflen = TRIE_INITAL_ACCEPT_BUFFLEN;
2808                             sv_accept_buff=newSV(bufflen *
2809                                             sizeof(reg_trie_accepted) - 1);
2810                             SvCUR_set(sv_accept_buff, 0);
2811                             SvPOK_on(sv_accept_buff);
2812                             sv_2mortal(sv_accept_buff);
2813                             SAVETMPS;
2814                             ST.accept_buff =
2815                                 (reg_trie_accepted*)SvPV_nolen(sv_accept_buff );
2816                         }
2817                         do {
2818                             if (ST.accepted >= bufflen) {
2819                                 bufflen *= 2;
2820                                 ST.accept_buff =(reg_trie_accepted*)
2821                                     SvGROW(sv_accept_buff,
2822                                         bufflen * sizeof(reg_trie_accepted));
2823                             }
2824                             SvCUR_set(sv_accept_buff,SvCUR(sv_accept_buff)
2825                                 + sizeof(reg_trie_accepted));
2826
2827
2828                             ST.accept_buff[ST.accepted].wordnum = got_wordnum;
2829                             ST.accept_buff[ST.accepted].endpos = uc;
2830                             ++ST.accepted;
2831                         } while (trie->nextword && (got_wordnum= trie->nextword[got_wordnum]));
2832                     }
2833 #undef got_wordnum
2834
2835                     DEBUG_TRIE_EXECUTE_r({
2836                                 DUMP_EXEC_POS( (char *)uc, scan, do_utf8 );
2837                                 PerlIO_printf( Perl_debug_log,
2838                                     "%*s  %sState: %4"UVxf" Accepted: %4"UVxf" ",
2839                                     2+depth * 2, "", PL_colors[4],
2840                                     (UV)state, (UV)ST.accepted );
2841                     });
2842
2843                     if ( base ) {
2844                         REXEC_TRIE_READ_CHAR(trie_type, trie, uc, uscan, len,
2845                             uvc, charid, foldlen, foldbuf, uniflags);
2846
2847                         if (charid &&
2848                              (base + charid > trie->uniquecharcount )
2849                              && (base + charid - 1 - trie->uniquecharcount
2850                                     < trie->lasttrans)
2851                              && trie->trans[base + charid - 1 -
2852                                     trie->uniquecharcount].check == state)
2853                         {
2854                             state = trie->trans[base + charid - 1 -
2855                                 trie->uniquecharcount ].next;
2856                         }
2857                         else {
2858                             state = 0;
2859                         }
2860                         uc += len;
2861
2862                     }
2863                     else {
2864                         state = 0;
2865                     }
2866                     DEBUG_TRIE_EXECUTE_r(
2867                         PerlIO_printf( Perl_debug_log,
2868                             "Charid:%3x CP:%4"UVxf" After State: %4"UVxf"%s\n",
2869                             charid, uvc, (UV)state, PL_colors[5] );
2870                     );
2871                 }
2872                 if (!ST.accepted )
2873                    sayNO;
2874
2875                 DEBUG_EXECUTE_r(
2876                     PerlIO_printf( Perl_debug_log,
2877                         "%*s  %sgot %"IVdf" possible matches%s\n",
2878                         REPORT_CODE_OFF + depth * 2, "",
2879                         PL_colors[4], (IV)ST.accepted, PL_colors[5] );
2880                 );
2881             }}
2882
2883             /* FALL THROUGH */
2884
2885         case TRIE_next_fail: /* we failed - try next alterative */
2886
2887             if ( ST.accepted == 1 ) {
2888                 /* only one choice left - just continue */
2889                 DEBUG_EXECUTE_r({
2890                     reg_trie_data * const trie
2891                         = (reg_trie_data*)rex->data->data[ ARG(ST.me) ];
2892                     SV ** const tmp = RX_DEBUG(reginfo->prog)
2893                                     ? av_fetch( trie->words, ST.accept_buff[ 0 ].wordnum-1, 0 )
2894                                     : NULL;
2895                     PerlIO_printf( Perl_debug_log,
2896                         "%*s  %sonly one match left: #%d <%s>%s\n",
2897                         REPORT_CODE_OFF+depth*2, "", PL_colors[4],
2898                         ST.accept_buff[ 0 ].wordnum,
2899                         tmp ? SvPV_nolen_const( *tmp ) : "not compiled under -Dr",
2900                         PL_colors[5] );
2901                 });
2902                 PL_reginput = (char *)ST.accept_buff[ 0 ].endpos;
2903                 /* in this case we free tmps/leave before we call regmatch
2904                    as we wont be using accept_buff again. */
2905                 FREETMPS;
2906                 LEAVE;
2907                 locinput = PL_reginput;
2908                 nextchr = UCHARAT(locinput);
2909
2910                 if ( !ST.jump || !ST.jump[ST.accept_buff[0].wordnum])
2911                     scan = ST.B;
2912                 else
2913                     scan = ST.me + ST.jump[ST.accept_buff[0].wordnum];
2914
2915                 continue; /* execute rest of RE */
2916             }
2917
2918             if (!ST.accepted-- ) {
2919                 FREETMPS;
2920                 LEAVE;
2921                 sayNO;
2922             }
2923
2924             /*
2925                There are at least two accepting states left.  Presumably
2926                the number of accepting states is going to be low,
2927                typically two. So we simply scan through to find the one
2928                with lowest wordnum.  Once we find it, we swap the last
2929                state into its place and decrement the size. We then try to
2930                match the rest of the pattern at the point where the word
2931                ends. If we succeed, control just continues along the
2932                regex; if we fail we return here to try the next accepting
2933                state
2934              */
2935
2936             {
2937                 U32 best = 0;
2938                 U32 cur;
2939                 for( cur = 1 ; cur <= ST.accepted ; cur++ ) {
2940                     DEBUG_TRIE_EXECUTE_r(
2941                         PerlIO_printf( Perl_debug_log,
2942                             "%*s  %sgot %"IVdf" (%d) as best, looking at %"IVdf" (%d)%s\n",
2943                             REPORT_CODE_OFF + depth * 2, "", PL_colors[4],
2944                             (IV)best, ST.accept_buff[ best ].wordnum, (IV)cur,
2945                             ST.accept_buff[ cur ].wordnum, PL_colors[5] );
2946                     );
2947
2948                     if (ST.accept_buff[cur].wordnum <
2949                             ST.accept_buff[best].wordnum)
2950                         best = cur;
2951                 }
2952
2953                 DEBUG_EXECUTE_r({
2954                     reg_trie_data * const trie
2955                         = (reg_trie_data*)rex->data->data[ ARG(ST.me) ];
2956                     SV ** const tmp = RX_DEBUG(reginfo->prog)
2957                                 ? av_fetch( trie->words, ST.accept_buff[ best ].wordnum - 1, 0 )
2958                                 : NULL;
2959                     regnode *nextop=(!ST.jump || !ST.jump[ST.accept_buff[best].wordnum]) ?
2960                                     ST.B :
2961                                     ST.me + ST.jump[ST.accept_buff[best].wordnum];
2962                     PerlIO_printf( Perl_debug_log,
2963                         "%*s  %strying alternation #%d <%s> at node #%d %s\n",
2964                         REPORT_CODE_OFF+depth*2, "", PL_colors[4],
2965                         ST.accept_buff[best].wordnum,
2966                         tmp ? SvPV_nolen_const( *tmp ) : "not compiled under -Dr",
2967                             REG_NODE_NUM(nextop),
2968                         PL_colors[5] );
2969                 });
2970
2971                 if ( best<ST.accepted ) {
2972                     reg_trie_accepted tmp = ST.accept_buff[ best ];
2973                     ST.accept_buff[ best ] = ST.accept_buff[ ST.accepted ];
2974                     ST.accept_buff[ ST.accepted ] = tmp;
2975                     best = ST.accepted;
2976                 }
2977                 PL_reginput = (char *)ST.accept_buff[ best ].endpos;
2978                 if ( !ST.jump || !ST.jump[ST.accept_buff[best].wordnum]) {
2979                     PUSH_STATE_GOTO(TRIE_next, ST.B);
2980                     /* NOTREACHED */
2981                 } else {
2982                     PUSH_STATE_GOTO(TRIE_next, ST.me + ST.jump[ST.accept_buff[best].wordnum]);
2983                     /* NOTREACHED */
2984                 }
2985                 /* NOTREACHED */
2986             }
2987             /* NOTREACHED */
2988
2989 #undef  ST
2990
2991         case EXACT: {
2992             char *s = STRING(scan);
2993             ln = STR_LEN(scan);
2994             if (do_utf8 != UTF) {
2995                 /* The target and the pattern have differing utf8ness. */
2996                 char *l = locinput;
2997                 const char * const e = s + ln;
2998
2999                 if (do_utf8) {
3000                     /* The target is utf8, the pattern is not utf8. */
3001                     while (s < e) {
3002                         STRLEN ulen;
3003                         if (l >= PL_regeol)
3004                              sayNO;
3005                         if (NATIVE_TO_UNI(*(U8*)s) !=
3006                             utf8n_to_uvuni((U8*)l, UTF8_MAXBYTES, &ulen,
3007                                             uniflags))
3008                              sayNO;
3009                         l += ulen;
3010                         s ++;
3011                     }
3012                 }
3013                 else {
3014                     /* The target is not utf8, the pattern is utf8. */
3015                     while (s < e) {
3016                         STRLEN ulen;
3017                         if (l >= PL_regeol)
3018                             sayNO;
3019                         if (NATIVE_TO_UNI(*((U8*)l)) !=
3020                             utf8n_to_uvuni((U8*)s, UTF8_MAXBYTES, &ulen,
3021                                            uniflags))
3022                             sayNO;
3023                         s += ulen;
3024                         l ++;
3025                     }
3026                 }
3027                 locinput = l;
3028                 nextchr = UCHARAT(locinput);
3029                 break;
3030             }
3031             /* The target and the pattern have the same utf8ness. */
3032             /* Inline the first character, for speed. */
3033             if (UCHARAT(s) != nextchr)
3034                 sayNO;
3035             if (PL_regeol - locinput < ln)
3036                 sayNO;
3037             if (ln > 1 && memNE(s, locinput, ln))
3038                 sayNO;
3039             locinput += ln;
3040             nextchr = UCHARAT(locinput);
3041             break;
3042             }
3043         case EXACTFL:
3044             PL_reg_flags |= RF_tainted;
3045             /* FALL THROUGH */
3046         case EXACTF: {
3047             char * const s = STRING(scan);
3048             ln = STR_LEN(scan);
3049
3050             if (do_utf8 || UTF) {
3051               /* Either target or the pattern are utf8. */
3052                 const char * const l = locinput;
3053                 char *e = PL_regeol;
3054
3055                 if (ibcmp_utf8(s, 0,  ln, (bool)UTF,
3056                                l, &e, 0,  do_utf8)) {
3057                      /* One more case for the sharp s:
3058                       * pack("U0U*", 0xDF) =~ /ss/i,
3059                       * the 0xC3 0x9F are the UTF-8
3060                       * byte sequence for the U+00DF. */
3061                      if (!(do_utf8 &&
3062                            toLOWER(s[0]) == 's' &&
3063                            ln >= 2 &&
3064                            toLOWER(s[1]) == 's' &&
3065                            (U8)l[0] == 0xC3 &&
3066                            e - l >= 2 &&
3067                            (U8)l[1] == 0x9F))
3068                           sayNO;
3069                 }
3070                 locinput = e;
3071                 nextchr = UCHARAT(locinput);
3072                 break;
3073             }
3074
3075             /* Neither the target and the pattern are utf8. */
3076
3077             /* Inline the first character, for speed. */
3078             if (UCHARAT(s) != nextchr &&
3079                 UCHARAT(s) != ((OP(scan) == EXACTF)
3080                                ? PL_fold : PL_fold_locale)[nextchr])
3081                 sayNO;
3082             if (PL_regeol - locinput < ln)
3083                 sayNO;
3084             if (ln > 1 && (OP(scan) == EXACTF
3085                            ? ibcmp(s, locinput, ln)
3086                            : ibcmp_locale(s, locinput, ln)))
3087                 sayNO;
3088             locinput += ln;
3089             nextchr = UCHARAT(locinput);
3090             break;
3091             }
3092         case ANYOF:
3093             if (do_utf8) {
3094                 STRLEN inclasslen = PL_regeol - locinput;
3095
3096                 if (!reginclass(rex, scan, (U8*)locinput, &inclasslen, do_utf8))
3097                     goto anyof_fail;
3098                 if (locinput >= PL_regeol)
3099                     sayNO;
3100                 locinput += inclasslen ? inclasslen : UTF8SKIP(locinput);
3101                 nextchr = UCHARAT(locinput);
3102                 break;
3103             }
3104             else {
3105                 if (nextchr < 0)
3106                     nextchr = UCHARAT(locinput);
3107                 if (!REGINCLASS(rex, scan, (U8*)locinput))
3108                     goto anyof_fail;
3109                 if (!nextchr && locinput >= PL_regeol)
3110                     sayNO;
3111                 nextchr = UCHARAT(++locinput);
3112                 break;
3113             }
3114         anyof_fail:
3115             /* If we might have the case of the German sharp s
3116              * in a casefolding Unicode character class. */
3117
3118             if (ANYOF_FOLD_SHARP_S(scan, locinput, PL_regeol)) {
3119                  locinput += SHARP_S_SKIP;
3120                  nextchr = UCHARAT(locinput);
3121             }
3122             else
3123                  sayNO;
3124             break;
3125         case ALNUML:
3126             PL_reg_flags |= RF_tainted;
3127             /* FALL THROUGH */
3128         case ALNUM:
3129             if (!nextchr)
3130                 sayNO;
3131             if (do_utf8) {
3132                 LOAD_UTF8_CHARCLASS_ALNUM();
3133                 if (!(OP(scan) == ALNUM
3134                       ? (bool)swash_fetch(PL_utf8_alnum, (U8*)locinput, do_utf8)
3135                       : isALNUM_LC_utf8((U8*)locinput)))
3136                 {
3137                     sayNO;
3138                 }
3139                 locinput += PL_utf8skip[nextchr];
3140                 nextchr = UCHARAT(locinput);
3141                 break;
3142             }
3143             if (!(OP(scan) == ALNUM
3144                   ? isALNUM(nextchr) : isALNUM_LC(nextchr)))
3145                 sayNO;
3146             nextchr = UCHARAT(++locinput);
3147             break;
3148         case NALNUML:
3149             PL_reg_flags |= RF_tainted;
3150             /* FALL THROUGH */
3151         case NALNUM:
3152             if (!nextchr && locinput >= PL_regeol)
3153                 sayNO;
3154             if (do_utf8) {
3155                 LOAD_UTF8_CHARCLASS_ALNUM();
3156                 if (OP(scan) == NALNUM
3157                     ? (bool)swash_fetch(PL_utf8_alnum, (U8*)locinput, do_utf8)
3158                     : isALNUM_LC_utf8((U8*)locinput))
3159                 {
3160                     sayNO;
3161                 }
3162                 locinput += PL_utf8skip[nextchr];
3163                 nextchr = UCHARAT(locinput);
3164                 break;
3165             }
3166             if (OP(scan) == NALNUM
3167                 ? isALNUM(nextchr) : isALNUM_LC(nextchr))
3168                 sayNO;
3169             nextchr = UCHARAT(++locinput);
3170             break;
3171         case BOUNDL:
3172         case NBOUNDL:
3173             PL_reg_flags |= RF_tainted;
3174             /* FALL THROUGH */
3175         case BOUND:
3176         case NBOUND:
3177             /* was last char in word? */
3178             if (do_utf8) {
3179                 if (locinput == PL_bostr)
3180                     ln = '\n';
3181                 else {
3182                     const U8 * const r = reghop3((U8*)locinput, -1, (U8*)PL_bostr);
3183
3184                     ln = utf8n_to_uvchr(r, UTF8SKIP(r), 0, uniflags);
3185                 }
3186                 if (OP(scan) == BOUND || OP(scan) == NBOUND) {
3187                     ln = isALNUM_uni(ln);
3188                     LOAD_UTF8_CHARCLASS_ALNUM();
3189                     n = swash_fetch(PL_utf8_alnum, (U8*)locinput, do_utf8);
3190                 }
3191                 else {
3192                     ln = isALNUM_LC_uvchr(UNI_TO_NATIVE(ln));
3193                     n = isALNUM_LC_utf8((U8*)locinput);
3194                 }
3195             }
3196             else {
3197                 ln = (locinput != PL_bostr) ?
3198                     UCHARAT(locinput - 1) : '\n';
3199                 if (OP(scan) == BOUND || OP(scan) == NBOUND) {
3200                     ln = isALNUM(ln);
3201                     n = isALNUM(nextchr);
3202                 }
3203                 else {
3204                     ln = isALNUM_LC(ln);
3205                     n = isALNUM_LC(nextchr);
3206                 }
3207             }
3208             if (((!ln) == (!n)) == (OP(scan) == BOUND ||
3209                                     OP(scan) == BOUNDL))
3210                     sayNO;
3211             break;
3212         case SPACEL:
3213             PL_reg_flags |= RF_tainted;
3214             /* FALL THROUGH */
3215         case SPACE:
3216             if (!nextchr)
3217                 sayNO;
3218             if (do_utf8) {
3219                 if (UTF8_IS_CONTINUED(nextchr)) {
3220                     LOAD_UTF8_CHARCLASS_SPACE();
3221                     if (!(OP(scan) == SPACE
3222                           ? (bool)swash_fetch(PL_utf8_space, (U8*)locinput, do_utf8)
3223                           : isSPACE_LC_utf8((U8*)locinput)))
3224                     {
3225                         sayNO;
3226                     }
3227                     locinput += PL_utf8skip[nextchr];
3228                     nextchr = UCHARAT(locinput);
3229                     break;
3230                 }
3231                 if (!(OP(scan) == SPACE
3232                       ? isSPACE(nextchr) : isSPACE_LC(nextchr)))
3233                     sayNO;
3234                 nextchr = UCHARAT(++locinput);
3235             }
3236             else {
3237                 if (!(OP(scan) == SPACE
3238                       ? isSPACE(nextchr) : isSPACE_LC(nextchr)))
3239                     sayNO;
3240                 nextchr = UCHARAT(++locinput);
3241             }
3242             break;
3243         case NSPACEL:
3244             PL_reg_flags |= RF_tainted;
3245             /* FALL THROUGH */
3246         case NSPACE:
3247             if (!nextchr && locinput >= PL_regeol)
3248                 sayNO;
3249             if (do_utf8) {
3250                 LOAD_UTF8_CHARCLASS_SPACE();
3251                 if (OP(scan) == NSPACE
3252                     ? (bool)swash_fetch(PL_utf8_space, (U8*)locinput, do_utf8)
3253                     : isSPACE_LC_utf8((U8*)locinput))
3254                 {
3255                     sayNO;
3256                 }
3257                 locinput += PL_utf8skip[nextchr];
3258                 nextchr = UCHARAT(locinput);
3259                 break;
3260             }
3261             if (OP(scan) == NSPACE
3262                 ? isSPACE(nextchr) : isSPACE_LC(nextchr))
3263                 sayNO;
3264             nextchr = UCHARAT(++locinput);
3265             break;
3266         case DIGITL:
3267             PL_reg_flags |= RF_tainted;
3268             /* FALL THROUGH */
3269         case DIGIT:
3270             if (!nextchr)
3271                 sayNO;
3272             if (do_utf8) {
3273                 LOAD_UTF8_CHARCLASS_DIGIT();
3274                 if (!(OP(scan) == DIGIT
3275                       ? (bool)swash_fetch(PL_utf8_digit, (U8*)locinput, do_utf8)
3276                       : isDIGIT_LC_utf8((U8*)locinput)))
3277                 {
3278                     sayNO;
3279                 }
3280                 locinput += PL_utf8skip[nextchr];
3281                 nextchr = UCHARAT(locinput);
3282                 break;
3283             }
3284             if (!(OP(scan) == DIGIT
3285                   ? isDIGIT(nextchr) : isDIGIT_LC(nextchr)))
3286                 sayNO;
3287             nextchr = UCHARAT(++locinput);
3288             break;
3289         case NDIGITL:
3290             PL_reg_flags |= RF_tainted;
3291             /* FALL THROUGH */
3292         case NDIGIT:
3293             if (!nextchr && locinput >= PL_regeol)
3294                 sayNO;
3295             if (do_utf8) {
3296                 LOAD_UTF8_CHARCLASS_DIGIT();
3297                 if (OP(scan) == NDIGIT
3298                     ? (bool)swash_fetch(PL_utf8_digit, (U8*)locinput, do_utf8)
3299                     : isDIGIT_LC_utf8((U8*)locinput))
3300                 {
3301                     sayNO;
3302                 }
3303                 locinput += PL_utf8skip[nextchr];
3304                 nextchr = UCHARAT(locinput);
3305                 break;
3306             }
3307             if (OP(scan) == NDIGIT
3308                 ? isDIGIT(nextchr) : isDIGIT_LC(nextchr))
3309                 sayNO;
3310             nextchr = UCHARAT(++locinput);
3311             break;
3312         case CLUMP:
3313             if (locinput >= PL_regeol)
3314                 sayNO;
3315             if  (do_utf8) {
3316                 LOAD_UTF8_CHARCLASS_MARK();
3317                 if (swash_fetch(PL_utf8_mark,(U8*)locinput, do_utf8))
3318                     sayNO;
3319                 locinput += PL_utf8skip[nextchr];
3320                 while (locinput < PL_regeol &&
3321                        swash_fetch(PL_utf8_mark,(U8*)locinput, do_utf8))
3322                     locinput += UTF8SKIP(locinput);
3323                 if (locinput > PL_regeol)
3324                     sayNO;
3325             }
3326             else
3327                locinput++;
3328             nextchr = UCHARAT(locinput);
3329             break;
3330
3331         case NREFFL:
3332         {
3333             char *s;
3334             char type;
3335             PL_reg_flags |= RF_tainted;
3336             /* FALL THROUGH */
3337         case NREF:
3338         case NREFF:
3339             type = OP(scan);
3340             n = reg_check_named_buff_matched(rex,scan);
3341
3342             if ( n ) {
3343                 type = REF + ( type - NREF );
3344                 goto do_ref;
3345             } else {
3346                 sayNO;
3347             }
3348             /* unreached */
3349         case REFFL:
3350             PL_reg_flags |= RF_tainted;
3351             /* FALL THROUGH */
3352         case REF:
3353         case REFF:
3354             n = ARG(scan);  /* which paren pair */
3355             type = OP(scan);
3356           do_ref:
3357             ln = PL_regstartp[n];
3358             PL_reg_leftiter = PL_reg_maxiter;           /* Void cache */
3359             if ((I32)*PL_reglastparen < n || ln == -1)
3360                 sayNO;                  /* Do not match unless seen CLOSEn. */
3361             if (ln == PL_regendp[n])
3362                 break;
3363
3364             s = PL_bostr + ln;
3365             if (do_utf8 && type != REF) {       /* REF can do byte comparison */
3366                 char *l = locinput;
3367                 const char *e = PL_bostr + PL_regendp[n];
3368                 /*
3369                  * Note that we can't do the "other character" lookup trick as
3370                  * in the 8-bit case (no pun intended) because in Unicode we
3371                  * have to map both upper and title case to lower case.
3372                  */
3373                 if (type == REFF) {
3374                     while (s < e) {
3375                         STRLEN ulen1, ulen2;
3376                         U8 tmpbuf1[UTF8_MAXBYTES_CASE+1];
3377                         U8 tmpbuf2[UTF8_MAXBYTES_CASE+1];
3378
3379                         if (l >= PL_regeol)
3380                             sayNO;
3381                         toLOWER_utf8((U8*)s, tmpbuf1, &ulen1);
3382                         toLOWER_utf8((U8*)l, tmpbuf2, &ulen2);
3383                         if (ulen1 != ulen2 || memNE((char *)tmpbuf1, (char *)tmpbuf2, ulen1))
3384                             sayNO;
3385                         s += ulen1;
3386                         l += ulen2;
3387                     }
3388                 }
3389                 locinput = l;
3390                 nextchr = UCHARAT(locinput);
3391                 break;
3392             }
3393
3394             /* Inline the first character, for speed. */
3395             if (UCHARAT(s) != nextchr &&
3396                 (type == REF ||
3397                  (UCHARAT(s) != (type == REFF
3398                                   ? PL_fold : PL_fold_locale)[nextchr])))
3399                 sayNO;
3400             ln = PL_regendp[n] - ln;
3401             if (locinput + ln > PL_regeol)
3402                 sayNO;
3403             if (ln > 1 && (type == REF
3404                            ? memNE(s, locinput, ln)
3405                            : (type == REFF
3406                               ? ibcmp(s, locinput, ln)
3407                               : ibcmp_locale(s, locinput, ln))))
3408                 sayNO;
3409             locinput += ln;
3410             nextchr = UCHARAT(locinput);
3411             break;
3412         }
3413         case NOTHING:
3414         case TAIL:
3415             break;
3416         case BACK:
3417             break;
3418
3419 #undef  ST
3420 #define ST st->u.eval
3421         {
3422             SV *ret;
3423             regexp *re;
3424             regnode *startpoint;
3425
3426         case GOSTART:
3427         case GOSUB: /*    /(...(?1))/      */
3428             if (cur_eval && cur_eval->locinput==locinput) {
3429                 if (cur_eval->u.eval.close_paren == (U32)ARG(scan))
3430                     Perl_croak(aTHX_ "Infinite recursion in regex");
3431                 if ( ++nochange_depth > MAX_RECURSE_EVAL_NOCHANGE_DEPTH )
3432                     Perl_croak(aTHX_
3433                         "Pattern subroutine nesting without pos change"
3434                         " exceeded limit in regex");
3435             } else {
3436                 nochange_depth = 0;
3437             }
3438             re = rex;
3439             (void)ReREFCNT_inc(rex);
3440             if (OP(scan)==GOSUB) {
3441                 startpoint = scan + ARG2L(scan);
3442                 ST.close_paren = ARG(scan);
3443             } else {
3444                 startpoint = re->program+1;
3445                 ST.close_paren = 0;
3446             }
3447             goto eval_recurse_doit;
3448             /* NOTREACHED */
3449         case EVAL:  /*   /(?{A})B/   /(??{A})B/  and /(?(?{A})X|Y)B/   */
3450             if (cur_eval && cur_eval->locinput==locinput) {
3451                 if ( ++nochange_depth > MAX_RECURSE_EVAL_NOCHANGE_DEPTH )
3452                     Perl_croak(aTHX_ "EVAL without pos change exceeded limit in regex");
3453             } else {
3454                 nochange_depth = 0;
3455             }
3456             {
3457                 /* execute the code in the {...} */
3458                 dSP;
3459                 SV ** const before = SP;
3460                 OP_4tree * const oop = PL_op;
3461                 COP * const ocurcop = PL_curcop;
3462                 PAD *old_comppad;
3463
3464                 n = ARG(scan);
3465                 PL_op = (OP_4tree*)rex->data->data[n];
3466                 DEBUG_STATE_r( PerlIO_printf(Perl_debug_log,
3467                     "  re_eval 0x%"UVxf"\n", PTR2UV(PL_op)) );
3468                 PAD_SAVE_LOCAL(old_comppad, (PAD*)rex->data->data[n + 2]);
3469                 PL_regendp[0] = PL_reg_magic->mg_len = locinput - PL_bostr;
3470
3471                 CALLRUNOPS(aTHX);                       /* Scalar context. */
3472                 SPAGAIN;
3473                 if (SP == before)
3474                     ret = &PL_sv_undef;   /* protect against empty (?{}) blocks. */
3475                 else {
3476                     ret = POPs;
3477                     PUTBACK;
3478                 }
3479
3480                 PL_op = oop;
3481                 PAD_RESTORE_LOCAL(old_comppad);
3482                 PL_curcop = ocurcop;
3483                 if (!logical) {
3484                     /* /(?{...})/ */
3485                     sv_setsv(save_scalar(PL_replgv), ret);
3486                     break;
3487                 }
3488             }
3489             if (logical == 2) { /* Postponed subexpression: /(??{...})/ */
3490                 logical = 0;
3491                 {
3492                     /* extract RE object from returned value; compiling if
3493                      * necessary */
3494
3495                     MAGIC *mg = NULL;
3496                     const SV *sv;
3497                     if(SvROK(ret) && SvSMAGICAL(sv = SvRV(ret)))
3498                         mg = mg_find(sv, PERL_MAGIC_qr);
3499                     else if (SvSMAGICAL(ret)) {
3500                         if (SvGMAGICAL(ret))
3501                             sv_unmagic(ret, PERL_MAGIC_qr);
3502                         else
3503                             mg = mg_find(ret, PERL_MAGIC_qr);
3504                     }
3505
3506                     if (mg) {
3507                         re = (regexp *)mg->mg_obj;
3508                         (void)ReREFCNT_inc(re);
3509                     }
3510                     else {
3511                         STRLEN len;
3512                         const char * const t = SvPV_const(ret, len);
3513                         PMOP pm;
3514                         const I32 osize = PL_regsize;
3515
3516                         Zero(&pm, 1, PMOP);
3517                         if (DO_UTF8(ret)) pm.op_pmdynflags |= PMdf_DYN_UTF8;
3518                         re = CALLREGCOMP((char*)t, (char*)t + len, &pm);
3519                         if (!(SvFLAGS(ret)
3520                               & (SVs_TEMP | SVs_PADTMP | SVf_READONLY
3521                                 | SVs_GMG)))
3522                             sv_magic(ret,(SV*)ReREFCNT_inc(re),
3523                                         PERL_MAGIC_qr,0,0);
3524                         PL_regsize = osize;
3525                     }
3526                 }
3527                 DEBUG_EXECUTE_r(
3528                     debug_start_match(re, do_utf8, locinput, PL_regeol,
3529                         "Matching embedded");
3530                 );
3531                 startpoint = re->program + 1;
3532                 ST.close_paren = 0; /* only used for GOSUB */
3533                 /* borrowed from regtry */
3534                 if (PL_reg_start_tmpl <= re->nparens) {
3535                     PL_reg_start_tmpl = re->nparens*3/2 + 3;
3536                     if(PL_reg_start_tmp)
3537                         Renew(PL_reg_start_tmp, PL_reg_start_tmpl, char*);
3538                     else
3539                         Newx(PL_reg_start_tmp, PL_reg_start_tmpl, char*);
3540                 }
3541
3542         eval_recurse_doit: /* Share code with GOSUB below this line */
3543                 /* run the pattern returned from (??{...}) */
3544                 ST.cp = regcppush(0);   /* Save *all* the positions. */
3545                 REGCP_SET(ST.lastcp);
3546
3547                 PL_regstartp = re->startp; /* essentially NOOP on GOSUB */
3548                 PL_regendp = re->endp;     /* essentially NOOP on GOSUB */
3549
3550                 *PL_reglastparen = 0;
3551                 *PL_reglastcloseparen = 0;
3552                 PL_reginput = locinput;
3553                 PL_regsize = 0;
3554
3555                 /* XXXX This is too dramatic a measure... */
3556                 PL_reg_maxiter = 0;
3557
3558                 ST.toggle_reg_flags = PL_reg_flags;
3559                 if (re->reganch & ROPT_UTF8)
3560                     PL_reg_flags |= RF_utf8;
3561                 else
3562                     PL_reg_flags &= ~RF_utf8;
3563                 ST.toggle_reg_flags ^= PL_reg_flags; /* diff of old and new */
3564
3565                 ST.prev_rex = rex;
3566                 ST.prev_curlyx = cur_curlyx;
3567                 rex = re;
3568                 cur_curlyx = NULL;
3569                 ST.B = next;
3570                 ST.prev_eval = cur_eval;
3571                 cur_eval = st;
3572                 /* now continue from first node in postoned RE */
3573                 PUSH_YES_STATE_GOTO(EVAL_AB, startpoint);
3574                 /* NOTREACHED */
3575             }
3576             /* logical is 1,   /(?(?{...})X|Y)/ */
3577             sw = (bool)SvTRUE(ret);
3578             logical = 0;
3579             break;
3580         }
3581
3582         case EVAL_AB: /* cleanup after a successful (??{A})B */
3583             /* note: this is called twice; first after popping B, then A */
3584             PL_reg_flags ^= ST.toggle_reg_flags;
3585             ReREFCNT_dec(rex);
3586             rex = ST.prev_rex;
3587             regcpblow(ST.cp);
3588             cur_eval = ST.prev_eval;
3589             cur_curlyx = ST.prev_curlyx;
3590             /* XXXX This is too dramatic a measure... */
3591             PL_reg_maxiter = 0;
3592             sayYES;
3593
3594
3595         case EVAL_AB_fail: /* unsuccessfully ran A or B in (??{A})B */
3596             /* note: this is called twice; first after popping B, then A */
3597             PL_reg_flags ^= ST.toggle_reg_flags;
3598             ReREFCNT_dec(rex);
3599             rex = ST.prev_rex;
3600             PL_reginput = locinput;
3601             REGCP_UNWIND(ST.lastcp);
3602             regcppop(rex);
3603             cur_eval = ST.prev_eval;
3604             cur_curlyx = ST.prev_curlyx;
3605             /* XXXX This is too dramatic a measure... */
3606             PL_reg_maxiter = 0;
3607             sayNO_SILENT;
3608 #undef ST
3609
3610         case OPEN:
3611             n = ARG(scan);  /* which paren pair */
3612             PL_reg_start_tmp[n] = locinput;
3613             if (n > PL_regsize)
3614                 PL_regsize = n;
3615             lastopen = n;
3616             break;
3617         case CLOSE:
3618             n = ARG(scan);  /* which paren pair */
3619             PL_regstartp[n] = PL_reg_start_tmp[n] - PL_bostr;
3620             PL_regendp[n] = locinput - PL_bostr;
3621             /*if (n > PL_regsize)
3622                 PL_regsize = n;*/
3623             if (n > (I32)*PL_reglastparen)
3624                 *PL_reglastparen = n;
3625             *PL_reglastcloseparen = n;
3626             if (cur_eval && cur_eval->u.eval.close_paren == (U32)n) {
3627                 goto fake_end;
3628             }
3629             break;
3630         case ACCEPT:
3631             if (ARG(scan)){
3632                 regnode *cursor;
3633                 for (cursor=scan;
3634                      cursor && OP(cursor)!=END;
3635                      cursor=regnext(cursor))
3636                 {
3637                     if ( OP(cursor)==CLOSE ){
3638                         n = ARG(cursor);
3639                         if ( n <= lastopen ) {
3640                             PL_regstartp[n] = PL_reg_start_tmp[n] - PL_bostr;
3641                             PL_regendp[n] = locinput - PL_bostr;
3642                             /*if (n > PL_regsize)
3643                             PL_regsize = n;*/
3644                             if (n > (I32)*PL_reglastparen)
3645                                 *PL_reglastparen = n;
3646                             *PL_reglastcloseparen = n;
3647                             if ( n == ARG(scan) || (cur_eval &&
3648                                 cur_eval->u.eval.close_paren == (U32)n))
3649                                 break;
3650                         }
3651                     }
3652                 }
3653             }
3654             goto fake_end;
3655             /*NOTREACHED*/
3656         case GROUPP:
3657             n = ARG(scan);  /* which paren pair */
3658             sw = (bool)((I32)*PL_reglastparen >= n && PL_regendp[n] != -1);
3659             break;
3660         case NGROUPP:
3661             /* reg_check_named_buff_matched returns 0 for no match */
3662             sw = (bool)(0 < reg_check_named_buff_matched(rex,scan));
3663             break;
3664         case INSUBP:
3665             n = ARG(scan);
3666             sw = (cur_eval && (!n || cur_eval->u.eval.close_paren == (U32)n));
3667             break;
3668         case DEFINEP:
3669             sw = 0;
3670             break;
3671         case IFTHEN:
3672             PL_reg_leftiter = PL_reg_maxiter;           /* Void cache */
3673             if (sw)
3674                 next = NEXTOPER(NEXTOPER(scan));
3675             else {
3676                 next = scan + ARG(scan);
3677                 if (OP(next) == IFTHEN) /* Fake one. */
3678                     next = NEXTOPER(NEXTOPER(next));
3679             }
3680             break;
3681         case LOGICAL:
3682             logical = scan->flags;
3683             break;
3684
3685 /*******************************************************************
3686
3687 The CURLYX/WHILEM pair of ops handle the most generic case of the /A*B/
3688 pattern, where A and B are subpatterns. (For simple A, CURLYM or
3689 STAR/PLUS/CURLY/CURLYN are used instead.)
3690
3691 A*B is compiled as <CURLYX><A><WHILEM><B>
3692
3693 On entry to the subpattern, CURLYX is called. This pushes a CURLYX
3694 state, which contains the current count, initialised to -1. It also sets
3695 cur_curlyx to point to this state, with any previous value saved in the
3696 state block.
3697
3698 CURLYX then jumps straight to the WHILEM op, rather than executing A,
3699 since the pattern may possibly match zero times (i.e. it's a while {} loop
3700 rather than a do {} while loop).
3701
3702 Each entry to WHILEM represents a successful match of A. The count in the
3703 CURLYX block is incremented, another WHILEM state is pushed, and execution
3704 passes to A or B depending on greediness and the current count.
3705
3706 For example, if matching against the string a1a2a3b (where the aN are
3707 substrings that match /A/), then the match progresses as follows: (the
3708 pushed states are interspersed with the bits of strings matched so far):
3709
3710     <CURLYX cnt=-1>
3711     <CURLYX cnt=0><WHILEM>
3712     <CURLYX cnt=1><WHILEM> a1 <WHILEM>
3713     <CURLYX cnt=2><WHILEM> a1 <WHILEM> a2 <WHILEM>
3714     <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM>
3715     <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM> b
3716
3717 (Contrast this with something like CURLYM, which maintains only a single
3718 backtrack state:
3719
3720     <CURLYM cnt=0> a1
3721     a1 <CURLYM cnt=1> a2
3722     a1 a2 <CURLYM cnt=2> a3
3723     a1 a2 a3 <CURLYM cnt=3> b
3724 )
3725
3726 Each WHILEM state block marks a point to backtrack to upon partial failure
3727 of A or B, and also contains some minor state data related to that
3728 iteration.  The CURLYX block, pointed to by cur_curlyx, contains the
3729 overall state, such as the count, and pointers to the A and B ops.
3730
3731 This is complicated slightly by nested CURLYX/WHILEM's. Since cur_curlyx
3732 must always point to the *current* CURLYX block, the rules are:
3733
3734 When executing CURLYX, save the old cur_curlyx in the CURLYX state block,
3735 and set cur_curlyx to point the new block.
3736
3737 When popping the CURLYX block after a successful or unsuccessful match,
3738 restore the previous cur_curlyx.
3739
3740 When WHILEM is about to execute B, save the current cur_curlyx, and set it
3741 to the outer one saved in the CURLYX block.
3742
3743 When popping the WHILEM block after a successful or unsuccessful B match,
3744 restore the previous cur_curlyx.
3745
3746 Here's an example for the pattern (AI* BI)*BO
3747 I and O refer to inner and outer, C and W refer to CURLYX and WHILEM:
3748
3749 cur_
3750 curlyx backtrack stack
3751 ------ ---------------
3752 NULL
3753 CO     <CO prev=NULL> <WO>
3754 CI     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
3755 CO     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
3756 NULL   <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi <WO prev=CO> bo
3757
3758 At this point the pattern succeeds, and we work back down the stack to
3759 clean up, restoring as we go:
3760
3761 CO     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
3762 CI     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
3763 CO     <CO prev=NULL> <WO>
3764 NULL
3765
3766 *******************************************************************/
3767
3768 #define ST st->u.curlyx
3769
3770         case CURLYX:    /* start of /A*B/  (for complex A) */
3771         {
3772             /* No need to save/restore up to this paren */
3773             I32 parenfloor = scan->flags;
3774
3775             assert(next); /* keep Coverity happy */
3776             if (OP(PREVOPER(next)) == NOTHING) /* LONGJMP */
3777                 next += ARG(next);
3778
3779             /* XXXX Probably it is better to teach regpush to support
3780                parenfloor > PL_regsize... */
3781             if (parenfloor > (I32)*PL_reglastparen)
3782                 parenfloor = *PL_reglastparen; /* Pessimization... */
3783
3784             ST.prev_curlyx= cur_curlyx;
3785             cur_curlyx = st;
3786             ST.cp = PL_savestack_ix;
3787
3788             /* these fields contain the state of the current curly.
3789              * they are accessed by subsequent WHILEMs */
3790             ST.parenfloor = parenfloor;
3791             ST.min = ARG1(scan);
3792             ST.max = ARG2(scan);
3793             ST.A = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3794             ST.B = next;
3795             ST.minmod = minmod;
3796             minmod = 0;
3797             ST.count = -1;      /* this will be updated by WHILEM */
3798             ST.lastloc = NULL;  /* this will be updated by WHILEM */
3799
3800             PL_reginput = locinput;
3801             PUSH_YES_STATE_GOTO(CURLYX_end, PREVOPER(next));
3802             /* NOTREACHED */
3803         }
3804
3805         case CURLYX_end: /* just finished matching all of A*B */
3806             regcpblow(ST.cp);
3807             cur_curlyx = ST.prev_curlyx;
3808             sayYES;
3809             /* NOTREACHED */
3810
3811         case CURLYX_end_fail: /* just failed to match all of A*B */
3812             regcpblow(ST.cp);
3813             cur_curlyx = ST.prev_curlyx;
3814             sayNO;
3815             /* NOTREACHED */
3816
3817
3818 #undef ST
3819 #define ST st->u.whilem
3820
3821         case WHILEM:     /* just matched an A in /A*B/  (for complex A) */
3822         {
3823             /* see the discussion above about CURLYX/WHILEM */
3824             I32 n;
3825             assert(cur_curlyx); /* keep Coverity happy */
3826             n = ++cur_curlyx->u.curlyx.count; /* how many A's matched */
3827             ST.save_lastloc = cur_curlyx->u.curlyx.lastloc;
3828             ST.cache_offset = 0;
3829             ST.cache_mask = 0;
3830
3831             PL_reginput = locinput;
3832
3833             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
3834                   "%*s  whilem: matched %ld out of %ld..%ld\n",
3835                   REPORT_CODE_OFF+depth*2, "", (long)n,
3836                   (long)cur_curlyx->u.curlyx.min,
3837                   (long)cur_curlyx->u.curlyx.max)
3838             );
3839
3840             /* First just match a string of min A's. */
3841
3842             if (n < cur_curlyx->u.curlyx.min) {
3843                 cur_curlyx->u.curlyx.lastloc = locinput;
3844                 PUSH_STATE_GOTO(WHILEM_A_pre, cur_curlyx->u.curlyx.A);
3845                 /* NOTREACHED */
3846             }
3847
3848             /* If degenerate A matches "", assume A done. */
3849
3850             if (locinput == cur_curlyx->u.curlyx.lastloc) {
3851                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
3852                    "%*s  whilem: empty match detected, trying continuation...\n",
3853                    REPORT_CODE_OFF+depth*2, "")
3854                 );
3855                 goto do_whilem_B_max;
3856             }
3857
3858             /* super-linear cache processing */
3859
3860             if (scan->flags) {
3861
3862                 if (!PL_reg_maxiter) {
3863                     /* start the countdown: Postpone detection until we
3864                      * know the match is not *that* much linear. */
3865                     PL_reg_maxiter = (PL_regeol - PL_bostr + 1) * (scan->flags>>4);
3866                     /* possible overflow for long strings and many CURLYX's */
3867                     if (PL_reg_maxiter < 0)
3868                         PL_reg_maxiter = I32_MAX;
3869                     PL_reg_leftiter = PL_reg_maxiter;
3870                 }
3871
3872                 if (PL_reg_leftiter-- == 0) {
3873                     /* initialise cache */
3874                     const I32 size = (PL_reg_maxiter + 7)/8;
3875                     if (PL_reg_poscache) {
3876                         if ((I32)PL_reg_poscache_size < size) {
3877                             Renew(PL_reg_poscache, size, char);
3878                             PL_reg_poscache_size = size;
3879                         }
3880                         Zero(PL_reg_poscache, size, char);
3881                     }
3882                     else {
3883                         PL_reg_poscache_size = size;
3884                         Newxz(PL_reg_poscache, size, char);
3885                     }
3886                     DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
3887       "%swhilem: Detected a super-linear match, switching on caching%s...\n",
3888                               PL_colors[4], PL_colors[5])
3889                     );
3890                 }
3891
3892                 if (PL_reg_leftiter < 0) {
3893                     /* have we already failed at this position? */
3894                     I32 offset, mask;
3895                     offset  = (scan->flags & 0xf) - 1
3896                                 + (locinput - PL_bostr)  * (scan->flags>>4);
3897                     mask    = 1 << (offset % 8);
3898                     offset /= 8;
3899                     if (PL_reg_poscache[offset] & mask) {
3900                         DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
3901                             "%*s  whilem: (cache) already tried at this position...\n",
3902                             REPORT_CODE_OFF+depth*2, "")
3903                         );
3904                         sayNO; /* cache records failure */
3905                     }
3906                     ST.cache_offset = offset;
3907                     ST.cache_mask   = mask;
3908                 }
3909             }
3910
3911             /* Prefer B over A for minimal matching. */
3912
3913             if (cur_curlyx->u.curlyx.minmod) {
3914                 ST.save_curlyx = cur_curlyx;
3915                 cur_curlyx = cur_curlyx->u.curlyx.prev_curlyx;
3916                 ST.cp = regcppush(ST.save_curlyx->u.curlyx.parenfloor);
3917                 REGCP_SET(ST.lastcp);
3918                 PUSH_YES_STATE_GOTO(WHILEM_B_min, ST.save_curlyx->u.curlyx.B);
3919                 /* NOTREACHED */
3920             }
3921
3922             /* Prefer A over B for maximal matching. */
3923
3924             if (n < cur_curlyx->u.curlyx.max) { /* More greed allowed? */
3925                 ST.cp = regcppush(cur_curlyx->u.curlyx.parenfloor);
3926                 cur_curlyx->u.curlyx.lastloc = locinput;
3927                 REGCP_SET(ST.lastcp);
3928                 PUSH_STATE_GOTO(WHILEM_A_max, cur_curlyx->u.curlyx.A);
3929                 /* NOTREACHED */
3930             }
3931             goto do_whilem_B_max;
3932         }
3933         /* NOTREACHED */
3934
3935         case WHILEM_B_min: /* just matched B in a minimal match */
3936         case WHILEM_B_max: /* just matched B in a maximal match */
3937             cur_curlyx = ST.save_curlyx;
3938             sayYES;
3939             /* NOTREACHED */
3940
3941         case WHILEM_B_max_fail: /* just failed to match B in a maximal match */
3942             cur_curlyx = ST.save_curlyx;
3943             cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
3944             cur_curlyx->u.curlyx.count--;
3945             CACHEsayNO;
3946             /* NOTREACHED */
3947
3948         case WHILEM_A_min_fail: /* just failed to match A in a minimal match */
3949             REGCP_UNWIND(ST.lastcp);
3950             regcppop(rex);
3951             /* FALL THROUGH */
3952         case WHILEM_A_pre_fail: /* just failed to match even minimal A */
3953             cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
3954             cur_curlyx->u.curlyx.count--;
3955             CACHEsayNO;
3956             /* NOTREACHED */
3957
3958         case WHILEM_A_max_fail: /* just failed to match A in a maximal match */