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

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

First attempt at adding grapheme cluster mode to icgrep.

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