source: icGREP/icgrep-devel/icgrep/re/re_compiler.cpp @ 4980

Last change on this file since 4980 was 4980, checked in by cameron, 3 years ago

Remove mod64 junk

File size: 37.1 KB
Line 
1/*
2 *  Copyright (c) 2014 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 *  icgrep is a trademark of International Characters.
5 */
6#include <re/re_compiler.h>
7//Regular Expressions
8#include <re/re_name.h>
9#include <re/re_any.h>
10#include <re/re_start.h>
11#include <re/re_end.h>
12#include <re/re_alt.h>
13#include <re/re_cc.h>
14#include <re/re_seq.h>
15#include <re/re_rep.h>
16#include <re/re_diff.h>
17#include <re/re_intersect.h>
18#include <re/re_assertion.h>
19#include <re/re_grapheme_boundary.hpp>
20#include <re/re_analysis.h>
21#include <re/re_memoizer.hpp>
22#include <re/printer_re.h>
23#include <pablo/codegenstate.h>
24#include <UCD/ucd_compiler.hpp>
25#include <UCD/resolve_properties.h>
26#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
27#include <UCD/precompiled_properties.h>
28#endif
29#include <assert.h>
30#include <stdexcept>
31#include <iostream>
32#include <pablo/printer_pablos.h>
33#include "llvm/Support/CommandLine.h"
34#include <sstream>
35#include <unordered_set>
36
37static cl::OptionCategory fREcompilationOptions("Regex Compilation Options", "These options control the compilation of regular expressions to Pablo.");
38static cl::opt<bool> InvertMatches("v", cl::init(false),
39                     cl::desc("select non-matching lines"), cl::cat(fREcompilationOptions));
40static cl::alias InvertMatchesLong("invert-matches", cl::desc("Alias for -v"), cl::aliasopt(InvertMatches));
41
42static cl::opt<bool> DisableLog2BoundedRepetition("disable-log2-bounded-repetition", cl::init(false),
43                     cl::desc("disable log2 optimizations for bounded repetition of bytes"), cl::cat(fREcompilationOptions));
44static cl::opt<bool> DisableIfHierarchy("disable-if-hierarchy-strategy", cl::init(false),
45                     cl::desc("disable nested if hierarchy for generated Unicode classes (not recommended)"), cl::cat(fREcompilationOptions));
46static cl::opt<int> IfInsertionGap("if-insertion-gap", cl::init(3), cl::desc("minimum number of nonempty elements between inserted if short-circuit tests"), cl::cat(fREcompilationOptions));
47static cl::opt<bool> DisableMatchStar("disable-matchstar", cl::init(false),
48                     cl::desc("disable MatchStar optimization"), cl::cat(fREcompilationOptions));
49static cl::opt<bool> DisableUnicodeMatchStar("disable-unicode-matchstar", cl::init(false),
50                     cl::desc("disable Unicode MatchStar optimization"), cl::cat(fREcompilationOptions));
51static cl::opt<bool> DisableUnicodeLineBreak("disable-unicode-linebreak", cl::init(false),
52                     cl::desc("disable Unicode line breaks - use LF only"), cl::cat(fREcompilationOptions));
53
54#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
55static cl::opt<bool> UsePregeneratedUnicode("use-pregenerated-unicode", cl::init(false),
56                     cl::desc("use fixed pregenerated Unicode character class sets instead"), cl::cat(fREcompilationOptions));
57#endif
58
59#define UNICODE_LINE_BREAK (!DisableUnicodeLineBreak)
60
61using namespace pablo;
62
63namespace re {
64
65void RE_Compiler::initializeRequiredStreams() {
66
67    Assign * LF = mPB.createAssign("LF", mCCCompiler.compileCC(makeCC(0x0A)));
68    mLineFeed = LF;
69    PabloAST * CR = mCCCompiler.compileCC(makeCC(0x0D));
70    PabloAST * LF_VT_FF_CR = mCCCompiler.compileCC(makeCC(0x0A, 0x0D));
71
72    PabloBuilder crb = PabloBuilder::Create(mPB);
73    PabloAST * cr1 = crb.createAdvance(CR, 1, "cr1");
74    Assign * acrlf = crb.createAssign("crlf", crb.createAnd(cr1, LF));
75    mPB.createIf(CR, {acrlf}, crb);
76    mCRLF = acrlf;
77
78    PabloAST * u8pfx = mCCCompiler.compileCC(makeCC(0xC0, 0xFF));
79    PabloBuilder it = PabloBuilder::Create(mPB);
80    PabloAST * u8pfx2 = mCCCompiler.compileCC(makeCC(0xC2, 0xDF), it);
81    PabloAST * u8pfx3 = mCCCompiler.compileCC(makeCC(0xE0, 0xEF), it);
82    PabloAST * u8pfx4 = mCCCompiler.compileCC(makeCC(0xF0, 0xF4), it);
83    Assign * u8suffix = it.createAssign("u8suffix", mCCCompiler.compileCC(makeCC(0x80, 0xBF)));
84
85    //
86    // Two-byte sequences
87    PabloBuilder it2 = PabloBuilder::Create(it);
88    Assign * u8scope22 = it2.createAssign("u8scope22", it2.createAdvance(u8pfx2, 1));
89    Assign * NEL = it2.createAssign("NEL", it2.createAnd(it2.createAdvance(mCCCompiler.compileCC(makeCC(0xC2), it2), 1), mCCCompiler.compileCC(makeCC(0x85), it2)));
90    it.createIf(u8pfx2, {u8scope22, NEL}, it2);
91
92    //
93    // Three-byte sequences
94    PabloBuilder it3 = PabloBuilder::Create(it);
95    Assign * u8scope32 = it3.createAssign("u8scope32", it3.createAdvance(u8pfx3, 1));
96    PabloAST * u8scope33 = it3.createAdvance(u8pfx3, 2);
97    Assign * u8scope3X = it3.createAssign("u8scope3X", it3.createOr(u8scope32, u8scope33));
98    PabloAST * E2_80 = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xE2), it3), 1), mCCCompiler.compileCC(makeCC(0x80), it3));
99    Assign * LS_PS = it3.createAssign("LS_PS", it3.createAnd(it3.createAdvance(E2_80, 1), mCCCompiler.compileCC(makeCC(0xA8,0xA9), it3)));
100    PabloAST * E0_invalid = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xE0), it3), 1), mCCCompiler.compileCC(makeCC(0x80, 0x9F), it3));
101    PabloAST * ED_invalid = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xED), it3), 1), mCCCompiler.compileCC(makeCC(0xA0, 0xBF), it3));
102    Assign * EX_invalid = it3.createAssign("EX_invalid", it3.createOr(E0_invalid, ED_invalid));
103    it.createIf(u8pfx3, {u8scope32, u8scope3X, LS_PS, EX_invalid}, it3);
104
105    //
106    // Four-byte sequences
107    PabloBuilder it4 = PabloBuilder::Create(it);
108    PabloAST * u8scope42 = it4.createAdvance(u8pfx4, 1, "u8scope42");
109    PabloAST * u8scope43 = it4.createAdvance(u8scope42, 1, "u8scope43");
110    PabloAST * u8scope44 = it4.createAdvance(u8scope43, 1, "u8scope44");
111    Assign * u8scope4nonfinal = it4.createAssign("u8scope4nonfinal", it4.createOr(u8scope42, u8scope43));
112    Assign * u8scope4X = it4.createAssign("u8scope4X", it4.createOr(u8scope4nonfinal, u8scope44));
113    PabloAST * F0_invalid = it4.createAnd(it4.createAdvance(mCCCompiler.compileCC(makeCC(0xF0), it4), 1), mCCCompiler.compileCC(makeCC(0x80, 0x8F), it4));
114    PabloAST * F4_invalid = it4.createAnd(it4.createAdvance(mCCCompiler.compileCC(makeCC(0xF4), it4), 1), mCCCompiler.compileCC(makeCC(0x90, 0xBF), it4));
115    Assign * FX_invalid = it4.createAssign("FX_invalid", it4.createOr(F0_invalid, F4_invalid));
116    it.createIf(u8pfx4, {u8scope4nonfinal, u8scope4X, FX_invalid}, it4);
117
118    //
119    // Invalid cases
120    PabloAST * anyscope = it.createOr(u8scope22, it.createOr(u8scope3X, u8scope4X));
121    PabloAST * legalpfx = it.createOr(it.createOr(u8pfx2, u8pfx3), u8pfx4);
122    //  Any scope that does not have a suffix byte, and any suffix byte that is not in
123    //  a scope is a mismatch, i.e., invalid UTF-8.
124    PabloAST * mismatch = it.createXor(anyscope, u8suffix);
125    //
126    PabloAST * EF_invalid = it.createOr(EX_invalid, FX_invalid);
127    PabloAST * pfx_invalid = it.createXor(u8pfx, legalpfx);
128    Assign * u8invalid = it.createAssign("u8invalid", it.createOr(pfx_invalid, it.createOr(mismatch, EF_invalid)));
129    Assign * u8valid = it.createAssign("u8valid", it.createNot(u8invalid));
130    //
131    //
132
133    Assign * valid_pfx = it.createAssign("valid_pfx", it.createAnd(u8pfx, u8valid));
134    mNonFinal = it.createAssign("nonfinal", it.createAnd(it.createOr(it.createOr(u8pfx, u8scope32), u8scope4nonfinal), u8valid));
135
136    Assign * NEL_LS_PS = it.createAssign("NEL_LS_PS", it.createOr(NEL, LS_PS));
137    mPB.createIf(u8pfx, {u8invalid, valid_pfx, mNonFinal, NEL_LS_PS}, it);
138
139    PabloAST * LB_chars = mPB.createOr(LF_VT_FF_CR, NEL_LS_PS);
140    PabloAST * u8single = mPB.createAnd(mCCCompiler.compileCC(makeCC(0x00, 0x7F)), mPB.createNot(u8invalid));
141    mInitial = mPB.createOr(u8single, valid_pfx, "initial");
142    mFinal = mPB.createNot(mPB.createOr(mNonFinal, u8invalid), "final");
143    mUnicodeLineBreak = mPB.createAnd(LB_chars, mPB.createNot(mCRLF));  // count the CR, but not CRLF
144    PabloAST * const lb = UNICODE_LINE_BREAK ? mUnicodeLineBreak : mLineFeed;
145    mAny = mPB.createNot(lb, "any");
146    mFunction.setResult(1, mPB.createAssign("lf", mPB.createAnd(lb, mPB.createNot(mCRLF))));
147}
148
149static inline CC * getDefinitionIfCC(RE * re) {
150    if (LLVM_LIKELY(isa<Name>(re))) {
151        Name * name = cast<Name>(re);
152        if (name->getDefinition() && isa<CC>(name->getDefinition())) {
153            return cast<CC>(name->getDefinition());
154        }
155    }
156    return nullptr;
157}
158
159RE * RE_Compiler::resolveUnicodeProperties(RE * re) {
160
161    Memoizer memoizer;
162    Name * graphemeClusterRule = nullptr;
163
164    std::function<RE*(RE*)> resolve = [&](RE * re) -> RE * {
165        if (Name * name = dyn_cast<Name>(re)) {
166            auto f = memoizer.find(name);
167            if (f == memoizer.end()) {
168                if (LLVM_LIKELY(name->getDefinition() != nullptr)) {
169                    name->setDefinition(resolve(name->getDefinition()));
170                } else if (LLVM_LIKELY(name->getType() == Name::Type::UnicodeProperty)) {
171                    if (UCD::resolvePropertyDefinition(name)) {
172                        resolve(name->getDefinition());
173                    } else {
174                        #ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
175                        if (UsePregeneratedUnicode) {
176                            const std::string functionName = UCD::resolvePropertyFunction(name);
177                            const UCD::ExternalProperty & ep = UCD::resolveExternalProperty(functionName);
178                            Call * call = mPB.createCall(Prototype::Create(functionName, std::get<1>(ep), std::get<2>(ep), std::get<0>(ep)), mCCCompiler.getBasisBits());
179                            name->setCompiled(call);
180                        } else {
181                        #endif
182                            name->setDefinition(makeCC(std::move(UCD::resolveUnicodeSet(name))));
183                        #ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
184                        }
185                        #endif
186                    }
187                } else {
188                    throw std::runtime_error("All non-unicode-property Name objects should have been defined prior to Unicode property resolution.");
189                }
190            } else {
191                return *f;
192            }
193        } else if (Seq * seq = dyn_cast<Seq>(re)) {
194            for (auto si = seq->begin(); si != seq->end(); ++si) {
195                *si = resolve(*si);
196            }
197        } else if (Alt * alt = dyn_cast<Alt>(re)) {
198            CC * unionCC = nullptr;
199            std::stringstream name;
200            for (auto ai = alt->begin(); ai != alt->end(); ) {
201                RE * re = resolve(*ai);
202                if (CC * cc = getDefinitionIfCC(re)) {
203                    if (unionCC == nullptr) {
204                        unionCC = cc;
205                    } else {
206                        unionCC = makeCC(unionCC, cc);
207                        name << '+';
208                    }
209                    Name * n = cast<Name>(re);
210                    if (n->hasNamespace()) {
211                        name << n->getNamespace() << ':';
212                    }
213                    name << n->getName();
214                    ai = alt->erase(ai);
215                } else {
216                    *ai++ = re;
217                }
218            }
219            if (unionCC) {
220                alt->push_back(makeName(name.str(), unionCC));
221            }
222            if (alt->size() == 1) {
223                return alt->front();
224            }
225        } else if (Rep * rep = dyn_cast<Rep>(re)) {
226            rep->setRE(resolve(rep->getRE()));
227        } else if (Assertion * a = dyn_cast<Assertion>(re)) {
228            a->setAsserted(resolve(a->getAsserted()));
229        } else if (Diff * diff = dyn_cast<Diff>(re)) {
230            diff->setLH(resolve(diff->getLH()));
231            diff->setRH(resolve(diff->getRH()));
232            CC * lh = getDefinitionIfCC(diff->getLH());
233            CC * rh = getDefinitionIfCC(diff->getRH());
234            if (lh && rh) {
235                return resolve(makeName("diff", subtractCC(lh, rh)));
236            }
237        } else if (Intersect * ix = dyn_cast<Intersect>(re)) {
238            ix->setLH(resolve(ix->getLH()));
239            ix->setRH(resolve(ix->getRH()));
240            CC * lh = getDefinitionIfCC(ix->getLH());
241            CC * rh = getDefinitionIfCC(ix->getRH());
242            if (lh && rh) {
243                return resolve(makeName("intersect", intersectCC(lh, rh)));
244            }
245        } else if (GraphemeBoundary * gb = dyn_cast<GraphemeBoundary>(re)) {
246            if (LLVM_LIKELY(gb->getBoundaryRule() == nullptr)) {
247                switch (gb->getType()) {
248                    case GraphemeBoundary::Type::ClusterBoundary:
249                        if (graphemeClusterRule == nullptr) {
250                            graphemeClusterRule = cast<Name>(resolve(generateGraphemeClusterBoundaryRule()));
251                        }
252                        gb->setBoundaryRule(graphemeClusterRule);
253                        break;
254                    default:
255                        throw std::runtime_error("Only grapheme cluster boundary rules are supported in icGrep 1.0");
256                }
257            }
258            if (gb->getExpression()) {
259                resolve(gb->getExpression());
260            }
261        }
262        return re;
263    };
264
265    UCD::UCDCompiler::NameMap nameMap;
266    std::unordered_set<Name *> visited;
267
268    std::function<void(RE*)> gather = [&](RE * re) {
269        assert ("RE object cannot be null!" && re);
270        if (isa<Name>(re)) {
271            if (visited.insert(cast<Name>(re)).second) {
272                if (isa<CC>(cast<Name>(re)->getDefinition())) {
273                    nameMap.emplace(cast<Name>(re), nullptr);
274                } else {
275                    gather(cast<Name>(re)->getDefinition());
276                }
277            }
278        } else if (isa<Seq>(re)) {
279            for (RE * item : *cast<Seq>(re)) {
280                gather(item);
281            }
282        } else if (isa<Alt>(re)) {
283            for (RE * item : *cast<Alt>(re)) {
284                gather(item);
285            }
286        } else if (isa<Rep>(re)) {
287            gather(cast<Rep>(re)->getRE());
288        } else if (isa<Assertion>(re)) {
289            gather(cast<Assertion>(re)->getAsserted());
290        } else if (isa<Diff>(re)) {
291            gather(cast<Diff>(re)->getLH());
292            gather(cast<Diff>(re)->getRH());
293        } else if (isa<Intersect>(re)) {
294            gather(cast<Intersect>(re)->getLH());
295            gather(cast<Intersect>(re)->getRH());
296        } else if (isa<GraphemeBoundary>(re)) {
297            if (cast<GraphemeBoundary>(re)->getExpression()) {
298                gather(cast<GraphemeBoundary>(re)->getExpression());
299            }
300            gather(cast<GraphemeBoundary>(re)->getBoundaryRule());
301        }
302    };
303
304    re = resolve(re);
305    gather(re);
306
307    if (LLVM_LIKELY(nameMap.size() > 0)) {
308        UCD::UCDCompiler ucdCompiler(mCCCompiler);
309        if (LLVM_UNLIKELY(DisableIfHierarchy)) {
310            ucdCompiler.generateWithoutIfHierarchy(nameMap, mPB);
311        } else {
312            ucdCompiler.generateWithDefaultIfHierarchy(nameMap, mPB);
313        }
314        for (auto t : nameMap) {
315            if (t.second) {
316                mCompiledName.insert(std::make_pair(t.first, makeMarker(MarkerPosition::FinalMatchByte, t.second)));
317            }
318        }
319    }
320
321    // Now precompile any grapheme segmentation rules
322    if (graphemeClusterRule) {
323        auto gcb = compileName(graphemeClusterRule, mPB);
324        mCompiledName.insert(std::make_pair(graphemeClusterRule, gcb));
325    }
326    return re;
327}
328
329void RE_Compiler::compileUnicodeNames(RE *& re) {
330    re = resolveUnicodeProperties(re);
331}
332
333Name * RE_Compiler::generateGraphemeClusterBoundaryRule() {
334    // 3.1.1 Grapheme Cluster Boundary Rules
335    #define Behind(x) makeLookBehindAssertion(x)
336    #define Ahead(x) makeLookAheadAssertion(x)
337
338    RE * GCB_Control = makeName("gcb", "cn", Name::Type::UnicodeProperty);
339    RE * GCB_CR = makeName("gcb", "cr", Name::Type::UnicodeProperty);
340    RE * GCB_LF = makeName("gcb", "lf", Name::Type::UnicodeProperty);
341    RE * GCB_Control_CR_LF = makeAlt({GCB_CR, GCB_LF, GCB_Control});
342
343    // Break at the start and end of text.
344    RE * GCB_1 = makeStart();
345    RE * GCB_2 = makeEnd();
346    // Do not break between a CR and LF.
347    RE * GCB_3 = makeSeq({Behind(GCB_CR), Ahead(GCB_LF)});
348    // Otherwise, break before and after controls.
349    RE * GCB_4 = Behind(GCB_Control_CR_LF);
350    RE * GCB_5 = Ahead(GCB_Control_CR_LF);
351    RE * GCB_1_5 = makeAlt({GCB_1, GCB_2, makeDiff(makeAlt({GCB_4, GCB_5}), GCB_3)});
352
353    RE * GCB_L = makeName("gcb", "l", Name::Type::UnicodeProperty);
354    RE * GCB_V = makeName("gcb", "v", Name::Type::UnicodeProperty);
355    RE * GCB_LV = makeName("gcb", "lv", Name::Type::UnicodeProperty);
356    RE * GCB_LVT = makeName("gcb", "lvt", Name::Type::UnicodeProperty);
357    RE * GCB_T = makeName("gcb", "t", Name::Type::UnicodeProperty);
358    RE * GCB_RI = makeName("gcb", "ri", Name::Type::UnicodeProperty);
359    // Do not break Hangul syllable sequences.
360    RE * GCB_6 = makeSeq({Behind(GCB_L), Ahead(makeAlt({GCB_L, GCB_V, GCB_LV, GCB_LVT}))});
361    RE * GCB_7 = makeSeq({Behind(makeAlt({GCB_LV, GCB_V})), Ahead(makeAlt({GCB_V, GCB_T}))});
362    RE * GCB_8 = makeSeq({Behind(makeAlt({GCB_LVT, GCB_T})), Ahead(GCB_T)});
363    // Do not break between regional indicator symbols.
364    RE * GCB_8a = makeSeq({Behind(GCB_RI), Ahead(GCB_RI)});
365    // Do not break before extending characters.
366    RE * GCB_9 = Ahead(makeName("gcb", "ex", Name::Type::UnicodeProperty));
367    // Do not break before SpacingMarks, or after Prepend characters.
368    RE * GCB_9a = Ahead(makeName("gcb", "sm", Name::Type::UnicodeProperty));
369    RE * GCB_9b = Behind(makeName("gcb", "pp", Name::Type::UnicodeProperty));
370    RE * GCB_6_9b = makeAlt({GCB_6, GCB_7, GCB_8, GCB_8a, GCB_9, GCB_9a, GCB_9b});
371    // Otherwise, break everywhere.
372    RE * GCB_10 = makeSeq({Behind(makeAny()), Ahead(makeAny())});
373
374    Name * gcb = makeName("gcb", Name::Type::UnicodeProperty);
375    gcb->setDefinition(makeAlt({GCB_1_5, makeDiff(GCB_10, GCB_6_9b)}));
376    return gcb;
377}
378
379void RE_Compiler::finalizeMatchResult(MarkerType match_result) {
380    PabloAST * match_follow = mPB.createMatchStar(markerVar(match_result), mAny);
381    if (InvertMatches) {
382        match_follow = mPB.createNot(match_follow);
383    }
384    mFunction.setResult(0, mPB.createAssign("matches", mPB.createAnd(match_follow, UNICODE_LINE_BREAK ? mUnicodeLineBreak : mLineFeed)));
385}
386
387MarkerType RE_Compiler::compile(RE * re, PabloBuilder & pb) {
388    return process(re, makeMarker(MarkerPosition::FinalPostPositionByte, pb.createOnes()), pb);
389}
390
391MarkerType RE_Compiler::process(RE * re, MarkerType marker, PabloBuilder & pb) {
392    if (isa<Name>(re)) {
393        return compileName(cast<Name>(re), marker, pb);
394    } else if (isa<Seq>(re)) {
395        return compileSeq(cast<Seq>(re), marker, pb);
396    } else if (isa<Alt>(re)) {
397        return compileAlt(cast<Alt>(re), marker, pb);
398    } else if (isa<Rep>(re)) {
399        return compileRep(cast<Rep>(re), marker, pb);
400    } else if (isa<Assertion>(re)) {
401        return compileAssertion(cast<Assertion>(re), marker, pb);
402    } else if (isa<Any>(re)) {
403        return compileAny(marker, pb);
404    } else if (isa<Diff>(re)) {
405        return compileDiff(cast<Diff>(re), marker, pb);
406    } else if (isa<Intersect>(re)) {
407        return compileIntersect(cast<Intersect>(re), marker, pb);
408    } else if (isa<Start>(re)) {
409        return compileStart(marker, pb);
410    } else if (isa<End>(re)) {
411        return compileEnd(marker, pb);
412    } else if (isa<GraphemeBoundary>(re)) {
413        return compileGraphemeBoundary(cast<GraphemeBoundary>(re), marker, pb);
414    }
415    throw std::runtime_error("RE Compiler failed to process " + Printer_RE::PrintRE(re));
416}
417
418inline MarkerType RE_Compiler::compileAny(const MarkerType m, PabloBuilder & pb) {
419    PabloAST * nextFinalByte = markerVar(AdvanceMarker(m, MarkerPosition::FinalPostPositionByte, pb));
420    PabloAST * lb = mLineFeed;
421    if (UNICODE_LINE_BREAK) {
422        lb = pb.createOr(mUnicodeLineBreak, mCRLF);
423    }
424    return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(nextFinalByte, pb.createNot(lb), "dot"));
425}
426
427inline MarkerType RE_Compiler::compileName(Name * name, MarkerType marker, PabloBuilder & pb) {
428    MarkerType nameMarker = compileName(name, pb);
429    MarkerType nextPos;
430    if (markerPos(marker) == MarkerPosition::FinalPostPositionByte) {
431        nextPos = marker;
432    } else if (name->getType() == Name::Type::Byte) {
433        nextPos = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
434    } else {
435        nextPos = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
436    }
437    nameMarker.stream = pb.createAnd(markerVar(nextPos), markerVar(nameMarker), name->getName());
438    return nameMarker;
439}
440
441inline MarkerType RE_Compiler::compileName(Name * name, PabloBuilder & pb) {
442    auto f = mCompiledName.find(name);
443    if (LLVM_LIKELY(f != mCompiledName.end())) {
444        return f->second;
445    } else if (LLVM_LIKELY(name->getDefinition() != nullptr)) {
446        MarkerType m = compile(name->getDefinition(), pb);
447        mCompiledName.insert(std::make_pair(name, m));
448        return m;
449    }
450    throw std::runtime_error("Unresolved name " + name->getName());
451}
452
453MarkerType RE_Compiler::compileSeq(Seq * seq, MarkerType marker, PabloBuilder & pb) {
454    // if-hierarchies are not inserted within unbounded repetitions
455    if (mStarDepth > 0) {
456        for (RE * re : *seq) {
457            marker = process(re, marker, pb);
458        }
459        return marker;
460    } else {
461        return compileSeqTail(seq->begin(), seq->end(), 0, marker, pb);
462    }
463}
464
465MarkerType RE_Compiler::compileSeqTail(Seq::iterator current, Seq::iterator end, int matchLenSoFar, MarkerType marker, PabloBuilder & pb) {
466    if (current == end) return marker;
467    if (matchLenSoFar < IfInsertionGap) {
468        RE * r = *current;
469        marker = process(r, marker, pb);
470        current++;
471        return compileSeqTail(current, end, matchLenSoFar + minMatchLength(r), marker, pb);
472    } else {
473        PabloBuilder nested = PabloBuilder::Create(pb);
474        MarkerType m1 = compileSeqTail(current, end, 0, marker, nested);
475        Assign * m1a = nested.createAssign("m", markerVar(m1));
476        pb.createIf(markerVar(marker), {m1a}, nested);
477        return makeMarker(m1.pos, m1a);
478    }
479}
480
481MarkerType RE_Compiler::compileAlt(Alt * alt, MarkerType marker, PabloBuilder & pb) {
482    std::vector<PabloAST *>  accum = {pb.createZeroes(), pb.createZeroes(), pb.createZeroes()};
483    MarkerType const base = marker;
484    // The following may be useful to force a common Advance rather than separate
485    // Advances in each alternative.
486    // MarkerType const base = makeMarker(InitialPostPositionByte, postPositionVar(marker, pb), pb);
487    for (RE * re : *alt) {
488        MarkerType rslt = process(re, base, pb);
489        MarkerPosition p = markerPos(rslt);
490        accum[p] = pb.createOr(accum[p], markerVar(rslt), "alt");
491    }
492    if (isa<Zeroes>(accum[MarkerPosition::InitialPostPositionByte]) && isa<Zeroes>(accum[MarkerPosition::FinalPostPositionByte])) {
493        return makeMarker(MarkerPosition::FinalMatchByte, accum[MarkerPosition::FinalMatchByte]);
494    }
495    PabloAST * combine = pb.createOr(accum[InitialPostPositionByte], pb.createAdvance(accum[MarkerPosition::FinalMatchByte], 1), "alt");
496    if (isa<Zeroes>(accum[FinalPostPositionByte])) {
497        return makeMarker(InitialPostPositionByte, combine);
498    }
499    combine = pb.createOr(pb.createScanThru(pb.createAnd(mInitial, combine), mNonFinal), accum[MarkerPosition::FinalPostPositionByte], "alt");
500    return makeMarker(MarkerPosition::FinalPostPositionByte, combine);
501}
502
503MarkerType RE_Compiler::compileAssertion(Assertion * a, MarkerType marker, PabloBuilder & pb) {
504    RE * asserted = a->getAsserted();
505    if (a->getKind() == Assertion::Kind::Lookbehind) {
506        MarkerType lookback = compile(asserted, pb);
507        AlignMarkers(marker, lookback, pb);
508        PabloAST * lb = markerVar(lookback);
509        if (a->getSense() == Assertion::Sense::Negative) {
510            lb = pb.createNot(lb);
511        }
512        return makeMarker(markerPos(marker), pb.createAnd(markerVar(marker), lb, "lookback"));
513    } else if (isUnicodeUnitLength(asserted)) {
514        MarkerType lookahead = compile(asserted, pb);
515        if (LLVM_LIKELY(markerPos(lookahead) == MarkerPosition::FinalMatchByte)) {
516            PabloAST * la = markerVar(lookahead);
517            if (a->getSense() == Assertion::Sense::Negative) {
518                la = pb.createNot(la);
519            }
520            MarkerType fbyte = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
521            return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(fbyte), la, "lookahead"));
522        }
523    }
524    throw std::runtime_error("Unsupported lookahead assertion.");
525}
526
527inline bool alignedUnicodeLength(const RE * lh, const RE * rh) {
528    const auto lhl = getUnicodeUnitLengthRange(lh);
529    const auto rhl = getUnicodeUnitLengthRange(rh);
530    return (lhl.first == lhl.second && lhl.first == rhl.first && lhl.second == rhl.second);
531}
532
533MarkerType RE_Compiler::compileDiff(Diff * diff, MarkerType marker, PabloBuilder & pb) {
534    RE * lh = diff->getLH();
535    RE * rh = diff->getRH();
536    if (alignedUnicodeLength(lh, rh)) {
537        MarkerType t1 = process(lh, marker, pb);
538        MarkerType t2 = process(rh, marker, pb);
539        AlignMarkers(t1, t2, pb);
540        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), pb.createNot(markerVar(t2)), "diff"));
541    }
542    throw std::runtime_error("Unsupported Diff operands: " + Printer_RE::PrintRE(diff));
543}
544
545MarkerType RE_Compiler::compileIntersect(Intersect * x, MarkerType marker, PabloBuilder & pb) {
546    RE * lh = x->getLH();
547    RE * rh = x->getRH();
548    if (alignedUnicodeLength(lh, rh)) {
549        MarkerType t1 = process(lh, marker, pb);
550        MarkerType t2 = process(rh, marker, pb);
551        AlignMarkers(t1, t2, pb);
552        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), markerVar(t2), "intersect"));
553    }
554    throw std::runtime_error("Unsupported Intersect operands: " + Printer_RE::PrintRE(x));
555}
556
557MarkerType RE_Compiler::compileRep(Rep * rep, MarkerType marker, PabloBuilder & pb) {
558    int lb = rep->getLB();
559    int ub = rep->getUB();
560    if (lb > 0) {
561        marker = processLowerBound(rep->getRE(), lb, marker, pb);
562    }
563    if (ub == Rep::UNBOUNDED_REP) {
564        marker = processUnboundedRep(rep->getRE(), marker, pb);
565    } else if (lb < ub) {
566        marker = processBoundedRep(rep->getRE(), ub - lb, marker, pb);
567    }
568    return marker;
569}
570
571/*
572   Given a stream |repeated| marking positions associated with matches to an item
573   of length |repeated_lgth|, compute a stream marking |repeat_count| consecutive
574   occurrences of such items.
575*/
576
577inline PabloAST * RE_Compiler::consecutive_matches(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
578    int i = length;
579    int total = repeat_count * length;
580    PabloAST * consecutive_i = repeated;
581    while (i * 2 < total) {
582        PabloAST * v = consecutive_i;
583        PabloAST * v2 =  pb.createAdvance(v, i);
584        i *= 2;
585        consecutive_i = pb.createAnd(v, v2, "at" + std::to_string(i) + "of" + std::to_string(total));
586    }
587    if (i < total) {
588        PabloAST * v = consecutive_i;
589        consecutive_i = pb.createAnd(v, pb.createAdvance(v, total - i), "at" + std::to_string(total));
590    }
591    return consecutive_i;
592}
593
594inline PabloAST * RE_Compiler::reachable(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
595    int i = length;
596    int total_lgth = repeat_count * length;
597    if (repeat_count == 0) {
598        return repeated;
599    }
600    PabloAST * reachable_i = pb.createOr(repeated, pb.createAdvance(repeated, 1), "within1");
601    while (i * 2 < total_lgth) {
602        PabloAST * v = reachable_i;
603        PabloAST * v2 =  pb.createAdvance(v, i);
604        i *= 2;
605        reachable_i = pb.createOr(v, v2, "within" + std::to_string(i));
606    }
607    if (i < total_lgth) {
608        PabloAST * v = reachable_i;
609        reachable_i = pb.createOr(v, pb.createAdvance(v, total_lgth - i), "within" + std::to_string(total_lgth));
610    }
611    return reachable_i;
612}
613
614MarkerType RE_Compiler::processLowerBound(RE * repeated, int lb, MarkerType marker, PabloBuilder & pb) {
615    if (!mGraphemeBoundaryRule && isByteLength(repeated) && !DisableLog2BoundedRepetition) {
616        PabloAST * cc = markerVar(compile(repeated, pb));
617        PabloAST * cc_lb = consecutive_matches(cc, 1, lb, pb);
618        PabloAST * marker_fwd = pb.createAdvance(markerVar(marker), markerPos(marker) == MarkerPosition::FinalMatchByte ? lb : lb - 1);
619        return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(marker_fwd, cc_lb, "lowerbound"));
620    }
621    // Fall through to general case.
622    for (int i = 1; i <= lb; ++i) {
623        marker = process(repeated, marker, pb);
624        if (mGraphemeBoundaryRule) {
625            marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
626        }
627    }
628    return marker;
629}
630
631MarkerType RE_Compiler::processBoundedRep(RE * repeated, int ub, MarkerType marker, PabloBuilder & pb) {
632    if (!mGraphemeBoundaryRule && isByteLength(repeated) && ub > 1 && !DisableLog2BoundedRepetition) {
633        // log2 upper bound for fixed length (=1) class
634        // Create a mask of positions reachable within ub from current marker.
635        // Use matchstar, then apply filter.
636        PabloAST * match = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
637        PabloAST * upperLimitMask = reachable(match, 1, ub, pb);
638        PabloAST * cursor = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
639        PabloAST * rep_class_var = markerVar(compile(repeated, pb));
640        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(pb.createMatchStar(cursor, rep_class_var), upperLimitMask, "bounded"));
641    }
642    // Fall through to general case.
643    for (int i = 1; i <= ub; ++i) {
644        MarkerType a = process(repeated, marker, pb);
645        MarkerType m = marker;
646        AlignMarkers(a, m, pb);
647        marker = makeMarker(markerPos(a), pb.createOr(markerVar(a), markerVar(m), "upper" + std::to_string(i)));
648        if (mGraphemeBoundaryRule) {
649            marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
650        }
651    }
652    return marker;
653}
654
655MarkerType RE_Compiler::processUnboundedRep(RE * repeated, MarkerType marker, PabloBuilder & pb) {
656    // always use PostPosition markers for unbounded repetition.
657    PabloAST * base = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
658    if (!mGraphemeBoundaryRule && isByteLength(repeated)  && !DisableMatchStar) {
659        PabloAST * cc = markerVar(compile(repeated, pb));
660        PabloAST * mstar = nullptr;
661        mstar = pb.createMatchStar(base, cc, "unbounded");
662        return makeMarker(MarkerPosition::InitialPostPositionByte, mstar);
663    } else if (isUnicodeUnitLength(repeated) && !DisableMatchStar && !DisableUnicodeMatchStar) {
664        PabloAST * cc = markerVar(compile(repeated, pb));
665        PabloAST * mstar = nullptr;
666        PabloAST * nonFinal = mNonFinal;
667        if (mGraphemeBoundaryRule) {
668            nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
669        }
670        cc = pb.createOr(cc, nonFinal);
671        mstar = pb.createMatchStar(base, cc);
672        PabloAST * final = mFinal;
673        if (mGraphemeBoundaryRule) {
674            final = mGraphemeBoundaryRule;
675        }
676        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(mstar, final, "unbounded"));
677    } else if (mStarDepth > 0){
678        PabloBuilder * outerb = pb.getParent();
679        Assign * starPending = outerb->createAssign("pending", outerb->createZeroes());
680        Assign * starAccum = outerb->createAssign("accum", outerb->createZeroes());
681        mStarDepth++;
682        PabloAST * m1 = pb.createOr(base, starPending);
683        PabloAST * m2 = pb.createOr(base, starAccum);
684        MarkerType result = process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, m1), pb);
685        result = AdvanceMarker(result, MarkerPosition::InitialPostPositionByte, pb);
686        PabloAST * loopComputation = markerVar(result);
687        Next * nextPending = pb.createNext(starPending, pb.createAnd(loopComputation, pb.createNot(m2)));
688        Next * nextStarAccum = pb.createNext(starAccum, pb.createOr(loopComputation, m2));
689        mWhileTest = pb.createOr(mWhileTest, nextPending);
690        mLoopVariants.push_back(nextPending);
691        mLoopVariants.push_back(nextStarAccum);
692        mStarDepth--;
693        return makeMarker(markerPos(result), pb.createAssign("unbounded", pb.createOr(base, nextStarAccum)));
694    } else {
695        Assign * whileTest = pb.createAssign("test", base);
696        Assign * whilePending = pb.createAssign("pending", base);
697        Assign * whileAccum = pb.createAssign("accum", base);
698        mWhileTest = pb.createZeroes();
699        PabloBuilder wb = PabloBuilder::Create(pb);
700        mStarDepth++;
701        MarkerType result = process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, whilePending), wb);
702        result = AdvanceMarker(result, MarkerPosition::InitialPostPositionByte, wb);
703        PabloAST * loopComputation = markerVar(result);
704        Next * nextWhilePending = wb.createNext(whilePending, wb.createAnd(loopComputation, wb.createNot(whileAccum)));
705        Next * nextWhileAccum = wb.createNext(whileAccum, wb.createOr(loopComputation, whileAccum));
706        Next * nextWhileTest = wb.createNext(whileTest, wb.createOr(mWhileTest, nextWhilePending));
707        mLoopVariants.push_back(nextWhilePending);
708        mLoopVariants.push_back(nextWhileAccum);
709        mLoopVariants.push_back(nextWhileTest);
710        pb.createWhile(nextWhileTest, mLoopVariants, wb);
711        mStarDepth--;
712        mLoopVariants.clear();
713        return makeMarker(markerPos(result), pb.createAssign("unbounded", nextWhileAccum));
714    }
715}
716
717inline MarkerType RE_Compiler::compileStart(const MarkerType marker, pablo::PabloBuilder & pb) {
718    MarkerType m = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
719    if (UNICODE_LINE_BREAK) {
720        PabloAST * line_end = mPB.createOr(mUnicodeLineBreak, mCRLF);
721        PabloAST * sol = pb.createNot(pb.createOr(pb.createAdvance(pb.createNot(line_end), 1), mCRLF));
722        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
723    } else {
724        PabloAST * sol = pb.createNot(pb.createAdvance(pb.createNot(mLineFeed), 1));
725        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
726    }
727}
728
729inline MarkerType RE_Compiler::compileEnd(const MarkerType marker, pablo::PabloBuilder & pb) {
730    if (UNICODE_LINE_BREAK) {
731        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb));
732        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mUnicodeLineBreak, "eol"));
733    } else {
734        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));  // For LF match
735        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mLineFeed, "eol"));
736    }
737}
738
739inline MarkerType RE_Compiler::compileGraphemeBoundary(GraphemeBoundary * gb, MarkerType marker, pablo::PabloBuilder & pb) {
740    auto f = mCompiledName.find(gb->getBoundaryRule());
741    assert ("Internal error: failed to locate grapheme boundary rule!" && (f != mCompiledName.end()));
742    if (gb->getExpression()) {
743        const auto graphemeBoundaryRule = mGraphemeBoundaryRule;
744        mGraphemeBoundaryRule = markerVar(f->second);
745        marker = process(gb->getExpression(), marker, pb);
746        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
747        mGraphemeBoundaryRule = graphemeBoundaryRule;
748    } else {
749        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
750        PabloAST * rule = markerVar(f->second);
751        if (gb->getSense() == GraphemeBoundary::Sense::Negative) {
752            rule = pb.createNot(rule);
753        }
754        marker = makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(marker), rule, "gb"));
755    }
756    return marker;
757}
758
759inline MarkerType RE_Compiler::AdvanceMarker(MarkerType marker, const MarkerPosition newpos, PabloBuilder & pb) {
760    if (marker.pos != newpos) {
761        if (marker.pos == MarkerPosition::FinalMatchByte) {
762            marker.stream = pb.createAdvance(marker.stream, 1, "ipp");
763            marker.pos = MarkerPosition::InitialPostPositionByte;
764        }
765        if (newpos == MarkerPosition::FinalPostPositionByte) {
766            PabloAST * nonFinal = mNonFinal;
767            if (mGraphemeBoundaryRule) {
768                nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
769            }
770            marker.stream = pb.createScanThru(pb.createAnd(mInitial, marker.stream), nonFinal, "fpp");
771            marker.pos = MarkerPosition::FinalPostPositionByte;
772        }
773    }
774    return marker;
775}
776
777inline void RE_Compiler::AlignMarkers(MarkerType & m1, MarkerType & m2, PabloBuilder & pb) {
778    if (m1.pos < m2.pos) {
779        m1 = AdvanceMarker(m1, m2.pos, pb);
780    } else if (m2.pos < m1.pos) {
781        m2 = AdvanceMarker(m2, m1.pos, pb);
782    }
783}
784
785RE_Compiler::RE_Compiler(pablo::PabloFunction & function, cc::CC_Compiler & ccCompiler)
786: mCCCompiler(ccCompiler)
787, mLineFeed(nullptr)
788, mCRLF(nullptr)
789, mUnicodeLineBreak(nullptr)
790, mAny(nullptr)
791, mGraphemeBoundaryRule(nullptr)
792, mInitial(nullptr)
793, mNonFinal(nullptr)
794, mFinal(nullptr)
795, mWhileTest(nullptr)
796, mStarDepth(0)
797, mLoopVariants()
798, mPB(ccCompiler.getBuilder().getPabloBlock(), ccCompiler.getBuilder())
799, mFunction(function)
800{
801
802}
803
804} // end of namespace re
Note: See TracBrowser for help on using the repository browser.