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

Last change on this file since 4921 was 4921, checked in by nmedfort, 3 years ago

Bug fix for RE Compiler.

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