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

Last change on this file since 4907 was 4870, checked in by nmedfort, 4 years ago

Bug fix for Multiplexing. Added ability to set the body of a If/While? node after creation.

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