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

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

Update for grapheme cluster mode and boundaries.

File size: 36.2 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(diff->getLH());
238            CC * rh = getDefinitionIfCC(diff->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 (Name * name = dyn_cast<Name>(re)) {
267            if (visited.insert(name).second) {
268                if (isa<CC>(name->getDefinition())) {
269                    nameMap.emplace(name, nullptr);
270                } else {
271                    gather(name->getDefinition());
272                }
273            }
274        } else if (Seq * seq = dyn_cast<Seq>(re)) {
275            for (auto re : *seq) {
276                gather(re);
277            }
278        } else if (Alt * alt = dyn_cast<Alt>(re)) {
279            for (auto re : *alt) {
280                gather(re);
281            }
282        } else if (Rep * rep = dyn_cast<Rep>(re)) {
283            gather(rep->getRE());
284        } else if (Assertion * a = dyn_cast<Assertion>(re)) {
285            gather(a->getAsserted());
286        } else if (Diff * diff = dyn_cast<Diff>(re)) {
287            gather(diff->getLH());
288            gather(diff->getRH());
289        } else if (Intersect * ix = dyn_cast<Intersect>(re)) {
290            gather(ix->getLH());
291            gather(ix->getRH());
292        } else if (GraphemeBoundary * gb = dyn_cast<GraphemeBoundary>(re)) {
293            if (gb->getExpression()) {
294                gather(gb->getExpression());
295            }
296            gather(gb->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
334    // Break at the start and end of text.
335    RE * GCB_1 = makeStart();
336    RE * GCB_2 = makeEnd();
337    // Do not break between a CR and LF.
338    RE * GCB_3 = makeSeq({Behind(GCB_CR), Ahead(GCB_LF)});
339    // Otherwise, break before and after controls.
340    RE * GCB_4 = Behind(GCB_Control);
341    RE * GCB_5 = Ahead(GCB_Control);
342    RE * GCB_1_5 = makeAlt({GCB_1, GCB_2, makeDiff(makeSeq({GCB_4, GCB_5}), GCB_3)});
343
344    RE * GCB_L = makeName("gcb", "l", Name::Type::UnicodeProperty);
345    RE * GCB_V = makeName("gcb", "v", Name::Type::UnicodeProperty);
346    RE * GCB_LV = makeName("gcb", "lv", Name::Type::UnicodeProperty);
347    RE * GCB_LVT = makeName("gcb", "lvt", Name::Type::UnicodeProperty);
348    RE * GCB_T = makeName("gcb", "t", Name::Type::UnicodeProperty);
349    RE * GCB_RI = makeName("gcb", "ri", Name::Type::UnicodeProperty);
350    // Do not break Hangul syllable sequences.
351    RE * GCB_6 = makeSeq({Behind(GCB_L), Ahead(makeAlt({GCB_L, GCB_V, GCB_LV, GCB_LVT}))});
352    RE * GCB_7 = makeSeq({Behind(makeAlt({GCB_LV, GCB_V})), Ahead(makeAlt({GCB_V, GCB_T}))});
353    RE * GCB_8 = makeSeq({Behind(makeAlt({GCB_LVT, GCB_T})), Ahead(GCB_T)});
354    // Do not break between regional indicator symbols.
355    RE * GCB_8a = makeSeq({Behind(GCB_RI), Ahead(GCB_RI)});
356    // Do not break before extending characters.
357    RE * GCB_9 = Ahead(makeName("gcb", "ex", Name::Type::UnicodeProperty));
358    // Do not break before SpacingMarks, or after Prepend characters.
359    RE * GCB_9a = Ahead(makeName("gcb", "sm", Name::Type::UnicodeProperty));
360    RE * GCB_9b = Behind(makeName("gcb", "pp", Name::Type::UnicodeProperty));
361    RE * GCB_6_9b = makeAlt({GCB_6, GCB_7, GCB_8, GCB_8a, GCB_9, GCB_9a, GCB_9b});
362    // Otherwise, break everywhere.
363    RE * GCB_10 = makeSeq({Behind(makeAny()), Ahead(makeAny())});
364
365    Name * gcb = makeName("gcb", Name::Type::UnicodeProperty);
366    gcb->setDefinition(makeAlt({GCB_1_5, makeDiff(GCB_10, GCB_6_9b)}));
367    return gcb;
368}
369
370void RE_Compiler::finalizeMatchResult(MarkerType match_result) {
371    mFunction.setResult(0, mPB.createAssign("matches", mPB.createAnd(mPB.createMatchStar(markerVar(match_result), mAny), UNICODE_LINE_BREAK ? mUnicodeLineBreak : mLineFeed)));
372}
373
374MarkerType RE_Compiler::compile(RE * re, PabloBuilder & pb) {
375    return process(re, makeMarker(MarkerPosition::FinalPostPositionByte, pb.createOnes()), pb);
376}
377
378MarkerType RE_Compiler::process(RE * re, MarkerType marker, PabloBuilder & pb) {
379    if (Name * name = dyn_cast<Name>(re)) {
380        return compileName(name, marker, pb);
381    } else if (Seq* seq = dyn_cast<Seq>(re)) {
382        return compileSeq(seq, marker, pb);
383    } else if (Alt * alt = dyn_cast<Alt>(re)) {
384        return compileAlt(alt, marker, pb);
385    } else if (Rep * rep = dyn_cast<Rep>(re)) {
386        return compileRep(rep, marker, pb);
387    } else if (Assertion * a = dyn_cast<Assertion>(re)) {
388        return compileAssertion(a, marker, pb);
389    } else if (isa<Any>(re)) {
390        return compileAny(marker, pb);
391    } else if (Diff * diff = dyn_cast<Diff>(re)) {
392        return compileDiff(diff, marker, pb);
393    } else if (Intersect * ix = dyn_cast<Intersect>(re)) {
394        return compileIntersect(ix, marker, pb);
395    } else if (isa<Start>(re)) {
396        return compileStart(marker, pb);
397    } else if (isa<End>(re)) {
398        return compileEnd(marker, pb);
399    } else if (GraphemeBoundary * gb = dyn_cast<GraphemeBoundary>(re)) {
400        return compileGraphemeBoundary(gb, marker, pb);
401    }
402    throw std::runtime_error("RE Compiler failed to process " + Printer_RE::PrintRE(re));
403}
404
405inline MarkerType RE_Compiler::compileAny(const MarkerType m, PabloBuilder & pb) {
406    PabloAST * nextFinalByte = markerVar(AdvanceMarker(m, MarkerPosition::FinalPostPositionByte, pb));
407    PabloAST * lb = mLineFeed;
408    if (UNICODE_LINE_BREAK) {
409        lb = pb.createOr(mUnicodeLineBreak, mCRLF);
410    }
411    return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(nextFinalByte, pb.createNot(lb), "dot"));
412}
413
414inline MarkerType RE_Compiler::compileName(Name * name, MarkerType marker, PabloBuilder & pb) {
415    MarkerType nameMarker = compileName(name, pb);
416    MarkerType nextPos;
417    if (markerPos(marker) == MarkerPosition::FinalPostPositionByte) {
418        nextPos = marker;
419    } else if (name->getType() == Name::Type::Byte) {
420        nextPos = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
421    } else {
422        nextPos = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
423    }
424    nameMarker.stream = pb.createAnd(markerVar(nextPos), markerVar(nameMarker), name->getName());
425    return nameMarker;
426}
427
428inline MarkerType RE_Compiler::compileName(Name * name, PabloBuilder & pb) {
429    auto f = mCompiledName.find(name);
430    if (LLVM_LIKELY(f != mCompiledName.end())) {
431        return f->second;
432    } else if (LLVM_LIKELY(name->getDefinition() != nullptr)) {
433        MarkerType m = compile(name->getDefinition(), pb);
434        mCompiledName.insert(std::make_pair(name, m));
435        return m;
436    }
437    throw std::runtime_error("Unresolved name " + name->getName());
438}
439
440MarkerType RE_Compiler::compileSeq(Seq * seq, MarkerType marker, PabloBuilder & pb) {
441    // if-hierarchies are not inserted within unbounded repetitions
442    if (mStarDepth > 0) {
443        for (RE * re : *seq) {
444            marker = process(re, marker, pb);
445        }
446        return marker;
447    } else {
448        return compileSeqTail(seq->begin(), seq->end(), 0, marker, pb);
449    }
450}
451
452MarkerType RE_Compiler::compileSeqTail(Seq::iterator current, Seq::iterator end, int matchLenSoFar, MarkerType marker, PabloBuilder & pb) {
453    if (current == end) return marker;
454    if (matchLenSoFar < IfInsertionGap) {
455        RE * r = *current;
456        marker = process(r, marker, pb);
457        current++;
458        return compileSeqTail(current, end, matchLenSoFar + minMatchLength(r), marker, pb);
459    } else {
460        PabloBuilder nested = PabloBuilder::Create(pb);
461        MarkerType m1 = compileSeqTail(current, end, 0, marker, nested);
462        Assign * m1a = nested.createAssign("m", markerVar(m1));
463        pb.createIf(markerVar(marker), {m1a}, nested);
464        return makeMarker(m1.pos, m1a);
465    }
466}
467
468MarkerType RE_Compiler::compileAlt(Alt * alt, MarkerType marker, PabloBuilder & pb) {
469    std::vector<PabloAST *>  accum = {pb.createZeroes(), pb.createZeroes(), pb.createZeroes()};
470    MarkerType const base = marker;
471    // The following may be useful to force a common Advance rather than separate
472    // Advances in each alternative.
473    // MarkerType const base = makeMarker(InitialPostPositionByte, postPositionVar(marker, pb), pb);
474    for (RE * re : *alt) {
475        MarkerType rslt = process(re, base, pb);
476        MarkerPosition p = markerPos(rslt);
477        accum[p] = pb.createOr(accum[p], markerVar(rslt), "alt");
478    }
479    if (isa<Zeroes>(accum[MarkerPosition::InitialPostPositionByte]) && isa<Zeroes>(accum[MarkerPosition::FinalPostPositionByte])) {
480        return makeMarker(MarkerPosition::FinalMatchByte, accum[MarkerPosition::FinalMatchByte]);
481    }
482    PabloAST * combine = pb.createOr(accum[InitialPostPositionByte], pb.createAdvance(accum[MarkerPosition::FinalMatchByte], 1), "alt");
483    if (isa<Zeroes>(accum[FinalPostPositionByte])) {
484        return makeMarker(InitialPostPositionByte, combine);
485    }
486    combine = pb.createOr(pb.createScanThru(pb.createAnd(mInitial, combine), mNonFinal), accum[MarkerPosition::FinalPostPositionByte], "alt");
487    return makeMarker(MarkerPosition::FinalPostPositionByte, combine);
488}
489
490MarkerType RE_Compiler::compileAssertion(Assertion * a, MarkerType marker, PabloBuilder & pb) {
491    RE * asserted = a->getAsserted();
492    if (a->getKind() == Assertion::Kind::Lookbehind) {
493        MarkerType lookback = compile(asserted, pb);
494        AlignMarkers(marker, lookback, pb);
495        PabloAST * lb = markerVar(lookback);
496        if (a->getSense() == Assertion::Sense::Negative) {
497            lb = pb.createNot(lb);
498        }
499        return makeMarker(markerPos(marker), pb.createAnd(markerVar(marker), lb, "lookback"));
500    } else if (isUnicodeUnitLength(asserted)) {
501        MarkerType lookahead = compile(asserted, pb);
502        if (LLVM_LIKELY(markerPos(lookahead) == MarkerPosition::FinalMatchByte)) {
503            PabloAST * la = markerVar(lookahead);
504            if (a->getSense() == Assertion::Sense::Negative) {
505                la = pb.createNot(la);
506            }
507            MarkerType fbyte = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
508            return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(fbyte), la, "lookahead"));
509        }
510    }
511    throw std::runtime_error("Unsupported lookahead assertion.");
512}
513
514inline bool alignedUnicodeLength(const RE * lh, const RE * rh) {
515    const auto lhl = getUnicodeUnitLengthRange(lh);
516    const auto rhl = getUnicodeUnitLengthRange(rh);
517    return (lhl.first == lhl.second && lhl.first == rhl.first && lhl.second == rhl.second);
518}
519
520MarkerType RE_Compiler::compileDiff(Diff * diff, MarkerType marker, PabloBuilder & pb) {
521    RE * lh = diff->getLH();
522    RE * rh = diff->getRH();
523    if (alignedUnicodeLength(lh, rh)) {
524        MarkerType t1 = process(lh, marker, pb);
525        MarkerType t2 = process(rh, marker, pb);
526        AlignMarkers(t1, t2, pb);
527        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), pb.createNot(markerVar(t2)), "diff"));
528    }
529    throw std::runtime_error("Unsupported Diff operands: " + Printer_RE::PrintRE(diff));
530}
531
532MarkerType RE_Compiler::compileIntersect(Intersect * x, MarkerType marker, PabloBuilder & pb) {
533    RE * lh = x->getLH();
534    RE * rh = x->getRH();
535    if (alignedUnicodeLength(lh, rh)) {
536        MarkerType t1 = process(lh, marker, pb);
537        MarkerType t2 = process(rh, marker, pb);
538        AlignMarkers(t1, t2, pb);
539        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), markerVar(t2), "intersect"));
540    }
541    throw std::runtime_error("Unsupported Intersect operands: " + Printer_RE::PrintRE(x));
542}
543
544MarkerType RE_Compiler::compileRep(Rep * rep, MarkerType marker, PabloBuilder & pb) {
545    int lb = rep->getLB();
546    int ub = rep->getUB();
547    if (lb > 0) {
548        marker = processLowerBound(rep->getRE(), lb, marker, pb);
549    }
550    if (ub == Rep::UNBOUNDED_REP) {
551        marker = processUnboundedRep(rep->getRE(), marker, pb);
552    } else if (lb < ub) {
553        marker = processBoundedRep(rep->getRE(), ub - lb, marker, pb);
554    }
555    return marker;
556}
557
558/*
559   Given a stream |repeated| marking positions associated with matches to an item
560   of length |repeated_lgth|, compute a stream marking |repeat_count| consecutive
561   occurrences of such items.
562*/
563
564inline PabloAST * RE_Compiler::consecutive_matches(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
565    int i = length;
566    int total = repeat_count * length;
567    PabloAST * consecutive_i = repeated;
568    while (i * 2 < total) {
569        PabloAST * v = consecutive_i;
570        PabloAST * v2 =  pb.createAdvance(v, i);
571        i *= 2;
572        consecutive_i = pb.createAnd(v, v2, "at" + std::to_string(i) + "of" + std::to_string(total));
573    }
574    if (i < total) {
575        PabloAST * v = consecutive_i;
576        consecutive_i = pb.createAnd(v, pb.createAdvance(v, total - i), "at" + std::to_string(total));
577    }
578    return consecutive_i;
579}
580
581inline PabloAST * RE_Compiler::reachable(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
582    int i = length;
583    int total_lgth = repeat_count * length;
584    if (repeat_count == 0) {
585        return repeated;
586    }
587    PabloAST * reachable_i = pb.createOr(repeated, pb.createAdvance(repeated, 1), "within1");
588    while (i * 2 < total_lgth) {
589        PabloAST * v = reachable_i;
590        PabloAST * v2 =  pb.createAdvance(v, i);
591        i *= 2;
592        reachable_i = pb.createOr(v, v2, "within" + std::to_string(i));
593    }
594    if (i < total_lgth) {
595        PabloAST * v = reachable_i;
596        reachable_i = pb.createOr(v, pb.createAdvance(v, total_lgth - i), "within" + std::to_string(total_lgth));
597    }
598    return reachable_i;
599}
600
601MarkerType RE_Compiler::processLowerBound(RE * repeated, int lb, MarkerType marker, PabloBuilder & pb) {
602    if (isByteLength(repeated) && !DisableLog2BoundedRepetition) {
603        PabloAST * cc = markerVar(compile(repeated, pb));
604        PabloAST * cc_lb = consecutive_matches(cc, 1, lb, pb);
605        PabloAST * marker_fwd = pb.createAdvance(markerVar(marker), markerPos(marker) == MarkerPosition::FinalMatchByte ? lb : lb - 1);
606        return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(marker_fwd, cc_lb, "lowerbound"));
607    }
608    // Fall through to general case.
609    while (lb-- != 0) {
610        marker = process(repeated, marker, pb);
611    }
612    return marker;
613}
614
615MarkerType RE_Compiler::processBoundedRep(RE * repeated, int ub, MarkerType marker, PabloBuilder & pb) {
616    if (isByteLength(repeated) && ub > 1 && !DisableLog2BoundedRepetition) {
617        // log2 upper bound for fixed length (=1) class
618        // Create a mask of positions reachable within ub from current marker.
619        // Use matchstar, then apply filter.
620        PabloAST * match = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
621        PabloAST * upperLimitMask = reachable(match, 1, ub, pb);
622        PabloAST * cursor = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
623        PabloAST * rep_class_var = markerVar(compile(repeated, pb));
624        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(pb.createMatchStar(cursor, rep_class_var), upperLimitMask, "bounded"));
625    }
626    // Fall through to general case.
627    while (ub-- != 0) {
628        MarkerType a = process(repeated, marker, pb);
629        MarkerType m = marker;
630        AlignMarkers(a, m, pb);
631        marker = makeMarker(markerPos(a), pb.createOr(markerVar(a), markerVar(m), "m"));
632    }
633    return marker;
634}
635
636MarkerType RE_Compiler::processUnboundedRep(RE * repeated, MarkerType marker, PabloBuilder & pb) {
637    // always use PostPosition markers for unbounded repetition.
638    PabloAST * base = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));   
639    if (isByteLength(repeated)  && !DisableMatchStar) {
640        PabloAST * cc = markerVar(compile(repeated, pb));
641        PabloAST * mstar = nullptr;
642        if (SetMod64Approximation) {
643            mstar = pb.createMod64MatchStar(base, cc, "unbounded");
644        } else {
645            mstar = pb.createMatchStar(base, cc, "unbounded");
646        }
647        return makeMarker(MarkerPosition::InitialPostPositionByte, mstar);
648    } else if (isUnicodeUnitLength(repeated) && !DisableMatchStar && !DisableUnicodeMatchStar) {
649        PabloAST * cc = markerVar(compile(repeated, pb));
650        PabloAST * mstar = nullptr;
651        PabloAST * nonFinal = mNonFinal;
652        if (mGraphemeBoundaryRule) {
653            nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
654        }
655        cc = pb.createOr(cc, nonFinal);
656        if (SetMod64Approximation) {
657            mstar = pb.createMod64MatchStar(base, cc);
658        } else {
659            mstar = pb.createMatchStar(base, cc);
660        }
661        PabloAST * final = mFinal;
662        if (mGraphemeBoundaryRule) {
663            final = mGraphemeBoundaryRule;
664        }
665        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(mstar, final, "unbounded"));
666    } else if (mStarDepth > 0){
667        PabloBuilder * outerb = pb.getParent();       
668        Assign * starPending = outerb->createAssign("pending", outerb->createZeroes());
669        Assign * starAccum = outerb->createAssign("accum", outerb->createZeroes());       
670        mStarDepth++;
671        PabloAST * m1 = pb.createOr(base, starPending);
672        PabloAST * m2 = pb.createOr(base, starAccum);
673        PabloAST * loopComputation = markerVar(AdvanceMarker(process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, m1), pb), MarkerPosition::InitialPostPositionByte, pb));
674        Next * nextPending = pb.createNext(starPending, pb.createAnd(loopComputation, pb.createNot(m2)));
675        Next * nextStarAccum = pb.createNext(starAccum, pb.createOr(loopComputation, m2));
676        mWhileTest = pb.createOr(mWhileTest, nextPending);
677        mLoopVariants.push_back(nextPending);
678        mLoopVariants.push_back(nextStarAccum);
679        mStarDepth--;       
680        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAssign("unbounded", pb.createOr(base, nextStarAccum)));
681    } else {
682        Assign * whileTest = pb.createAssign("test", base);
683        Assign * whilePending = pb.createAssign("pending", base);
684        Assign * whileAccum = pb.createAssign("accum", base);
685        mWhileTest = pb.createZeroes();
686
687        PabloBuilder wb = PabloBuilder::Create(pb);
688        mStarDepth++;
689
690        PabloAST * loopComputation = markerVar(AdvanceMarker(process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, whilePending), wb), MarkerPosition::InitialPostPositionByte, wb));
691        Next * nextWhilePending = wb.createNext(whilePending, wb.createAnd(loopComputation, wb.createNot(whileAccum)));
692        Next * nextWhileAccum = wb.createNext(whileAccum, wb.createOr(loopComputation, whileAccum));
693        Next * nextWhileTest = wb.createNext(whileTest, wb.createOr(mWhileTest, nextWhilePending));
694        mLoopVariants.push_back(nextWhilePending);
695        mLoopVariants.push_back(nextWhileAccum);
696        mLoopVariants.push_back(nextWhileTest);
697        pb.createWhile(nextWhileTest, mLoopVariants, wb);
698        mStarDepth--;
699        mLoopVariants.clear();
700        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAssign("unbounded", nextWhileAccum));
701    }   
702}
703
704inline MarkerType RE_Compiler::compileStart(const MarkerType marker, pablo::PabloBuilder & pb) {
705    MarkerType m = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
706    if (UNICODE_LINE_BREAK) {
707        PabloAST * line_end = mPB.createOr(mUnicodeLineBreak, mCRLF);
708        PabloAST * sol = pb.createNot(pb.createOr(pb.createAdvance(pb.createNot(line_end), 1), mCRLF));
709        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
710    } else {
711        PabloAST * sol = pb.createNot(pb.createAdvance(pb.createNot(mLineFeed), 1));
712        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
713    }
714}
715
716inline MarkerType RE_Compiler::compileEnd(const MarkerType marker, pablo::PabloBuilder & pb) {
717    if (UNICODE_LINE_BREAK) {
718        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb));
719        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mUnicodeLineBreak, "eol"));
720    } else {
721        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));  // For LF match
722        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mLineFeed, "eol"));
723    }
724}
725
726inline MarkerType RE_Compiler::compileGraphemeBoundary(GraphemeBoundary * gb, MarkerType marker, pablo::PabloBuilder & pb) {
727    auto f = mCompiledName.find(gb->getBoundaryRule());
728    assert ("Internal error: failed to locate grapheme boundary rule!" && (f != mCompiledName.end()));
729    if (gb->getExpression()) {
730        const auto graphemeBoundaryRule = mGraphemeBoundaryRule;
731        mGraphemeBoundaryRule = markerVar(f->second);
732        marker = process(gb->getExpression(), marker, pb);
733        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
734        mGraphemeBoundaryRule = graphemeBoundaryRule;
735    } else {
736        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
737        PabloAST * rule = markerVar(f->second);
738        if (gb->getSense() == GraphemeBoundary::Sense::Negative) {
739            rule = pb.createNot(rule);
740        }
741        marker = makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(marker), rule, "gb"));
742    }
743    return marker;
744}
745
746inline MarkerType RE_Compiler::AdvanceMarker(MarkerType marker, const MarkerPosition newpos, PabloBuilder & pb) {
747    if (marker.pos != newpos) {
748        if (marker.pos == MarkerPosition::FinalMatchByte) {
749            marker.stream = pb.createAdvance(marker.stream, 1, "ipp");
750            marker.pos = MarkerPosition::InitialPostPositionByte;
751        }
752        if (newpos == MarkerPosition::FinalPostPositionByte) {
753            PabloAST * nonFinal = mNonFinal;
754            if (mGraphemeBoundaryRule) {
755                nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
756            }
757            marker.stream = pb.createScanThru(pb.createAnd(mInitial, marker.stream), nonFinal, "fpp");
758            marker.pos = MarkerPosition::FinalPostPositionByte;
759        }
760    }
761    return marker;
762}
763
764inline void RE_Compiler::AlignMarkers(MarkerType & m1, MarkerType & m2, PabloBuilder & pb) {
765    if (m1.pos < m2.pos) {
766        m1 = AdvanceMarker(m1, m2.pos, pb);
767    } else if (m2.pos < m1.pos) {
768        m2 = AdvanceMarker(m2, m1.pos, pb);
769    }
770}
771
772RE_Compiler::RE_Compiler(pablo::PabloFunction & function, cc::CC_Compiler & ccCompiler)
773: mCCCompiler(ccCompiler)
774, mLineFeed(nullptr)
775, mCRLF(nullptr)
776, mUnicodeLineBreak(nullptr)
777, mAny(nullptr)
778, mGraphemeBoundaryRule(nullptr)
779, mInitial(nullptr)
780, mNonFinal(nullptr)
781, mFinal(nullptr)
782, mWhileTest(nullptr)
783, mStarDepth(0)
784, mLoopVariants()
785, mPB(*ccCompiler.getBuilder().getPabloBlock(), ccCompiler.getBuilder())
786, mFunction(function)
787{
788
789}
790
791} // end of namespace re
Note: See TracBrowser for help on using the repository browser.