source: icGREP/icgrep-devel/icgrep/UCD/ucd_compiler.cpp @ 4629

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

Couple modifications to the UCD compiler. Splitting Multiplexing from BDD Minimization.

File size: 19.8 KB
Line 
1#include "ucd_compiler.hpp"
2#include <cc/cc_compiler.h>
3#include <UCD/unicode_set.h>
4#include <utf8_encoder.h>
5#include <iostream>
6
7using namespace cc;
8using namespace re;
9using namespace pablo;
10
11namespace UCD {
12
13/** ------------------------------------------------------------------------------------------------------------- *
14 * @brief generateWithDefaultIfHierarchy
15 * @param set the unicode set to generate
16 * @param the entry block to the function we're filling
17 * @return the output stream with a 1-bit in any position of a character in the unicode set
18 ** ------------------------------------------------------------------------------------------------------------- */
19PabloAST * UCDCompiler::generateWithIfHierarchy(const RangeList & ifRanges, const UnicodeSet & set, PabloBuilder & entry) {
20    return generateWithIfHierarchy(ifRanges, set, 0, CC::UNICODE_MAX, entry);
21}
22
23/** ------------------------------------------------------------------------------------------------------------- *
24 * @brief generateCharClassDefsInIfHierarchy
25 * @param ifRangeList
26 ** ------------------------------------------------------------------------------------------------------------- */
27PabloAST * UCDCompiler::generateWithIfHierarchy(const RangeList & ifRanges, const UnicodeSet & set, const codepoint_t lo, const codepoint_t hi, PabloBuilder & block) {
28
29    PabloAST * target = block.createZeroes();
30    // Codepoints in unenclosed ranges will be computed unconditionally.
31    // Generate them first so that computed subexpressions may be shared
32    // with calculations within the if hierarchy.
33
34    const auto enclosed = rangeIntersect(ifRanges, lo, hi);
35
36    for (const auto rg : rangeGaps(enclosed, lo, hi)) {
37        target = generateSubRanges(set, lo_codepoint(rg), hi_codepoint(rg), block, target);
38    }
39
40    const auto outer = outerRanges(enclosed);
41    const auto inner = innerRanges(enclosed);
42
43    for (const auto range : outer) {
44        codepoint_t lo, hi;
45        std::tie(lo, hi) = range;
46        if (set.intersects(lo, hi)) {
47            PabloBuilder inner_block = PabloBuilder::Create(block);
48            PabloAST * inner_target = generateWithIfHierarchy(inner, set, lo, hi, inner_block);
49            // If this range is empty, just skip creating the if block
50            if (LLVM_UNLIKELY(isa<Zeroes>(inner_target))) {
51                continue;
52            }
53            Assign * matches = inner_block.createAssign("m", inner_target);
54            block.createIf(ifTestCompiler(lo, hi, block), {matches}, inner_block);
55            target = block.createOr(target, matches);
56        }
57    }
58
59    return target;
60}
61
62/** ------------------------------------------------------------------------------------------------------------- *
63 * @brief generateCharClassSubDefs
64 * @param ifRangeList
65 ** ------------------------------------------------------------------------------------------------------------- */
66PabloAST * UCDCompiler::generateSubRanges(const UnicodeSet & set, const codepoint_t lo, const codepoint_t hi, PabloBuilder & block, PabloAST * target) {
67    const auto range = rangeIntersect(set, lo, hi);
68    // Divide by UTF-8 length, separating out E0, ED, F0 and F4 ranges
69    const std::array<interval_t, 9> ranges =
70        {{{0, 0x7F}, {0x80, 0x7FF}, {0x800, 0xFFF}, {0x1000, 0xD7FF}, {0xD800, 0xDFFF},
71         {0xE000, 0xFFFF}, {0x10000, 0x3FFFF}, {0x40000, 0xFFFFF}, {0x100000, 0x10FFFF}}};
72    for (auto r : ranges) {
73        const auto subrange = rangeIntersect(range, lo_codepoint(r), hi_codepoint(r));
74        target = sequenceGenerator(std::move(subrange), 1, block, target, nullptr);
75    }
76    return target;
77}
78
79/** ------------------------------------------------------------------------------------------------------------- *
80 * @brief sequenceGenerator
81 * @param ifRangeList
82 *
83 *
84 * Generate remaining code to match UTF-8 code sequences within the codepoint set cpset, assuming that the code
85 * matching the sequences up to byte number byte_no have been generated.
86 ** ------------------------------------------------------------------------------------------------------------- */
87PabloAST * UCDCompiler::sequenceGenerator(const RangeList && ranges, const unsigned byte_no, PabloBuilder & block, PabloAST * target, PabloAST * prefix) {
88
89    if (LLVM_LIKELY(!ranges.empty())) {
90
91        codepoint_t lo, hi;
92        std::tie(lo, hi) = ranges[0];
93
94        const auto min = UTF8_Encoder::length(lo_codepoint(ranges.front()));
95        const auto max = UTF8_Encoder::length(hi_codepoint(ranges.back()));
96
97        if (min != max) {
98            const auto mid = UTF8_Encoder::maxCodePoint(min);
99            target = sequenceGenerator(std::move(rangeIntersect(ranges, lo, mid)), byte_no, block, target, prefix);
100            target = sequenceGenerator(std::move(rangeIntersect(ranges, mid + 1, hi)), byte_no, block, target, prefix);
101        }
102        else if (min == byte_no) {
103            // We have a single byte remaining to match for all code points in this CC.
104            // Use the byte class compiler to generate matches for these codepoints.
105            const auto bytes = byteDefinitions(ranges, byte_no);
106            PabloAST * testVar = mCharacterClassCompiler.compileCC(makeCC(bytes), block);
107            if (byte_no > 1) {
108                testVar = block.createAnd(testVar, block.createAdvance(makePrefix(lo, byte_no, block, prefix), 1));
109            }
110            target = block.createOr(target, testVar);
111        }
112        else {
113            for (auto rg : ranges) {
114                codepoint_t lo, hi;
115                std::tie(lo, hi) = rg;
116                const auto lo_byte = UTF8_Encoder::encodingByte(lo, byte_no);
117                const auto hi_byte = UTF8_Encoder::encodingByte(hi, byte_no);
118                if (lo_byte != hi_byte) {
119                    if (!UTF8_Encoder::isLowCodePointAfterByte(lo, byte_no)) {
120                        const codepoint_t mid = lo | ((1 << (6 * (min - byte_no))) - 1);
121                        target = sequenceGenerator(lo, mid, byte_no, block, target, prefix);
122                        target = sequenceGenerator(mid + 1, hi, byte_no, block, target, prefix);
123                    }
124                    else if (!UTF8_Encoder::isHighCodePointAfterByte(hi, byte_no)) {
125                        const codepoint_t mid = hi & ~((1 << (6 * (min - byte_no))) - 1);
126                        target = sequenceGenerator(lo, mid - 1, byte_no, block, target, prefix);
127                        target = sequenceGenerator(mid, hi, byte_no, block, target, prefix);
128                    }
129                    else { // we have a prefix group of type (a)
130                        PabloAST * var = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
131                        if (byte_no > 1) {
132                            var = block.createAnd(block.createAdvance(prefix, 1), var);
133                        }
134                        PabloAST * suffixVar = mCharacterClassCompiler.compileCC(mSuffix, block);
135                        for (auto i = byte_no; i < UTF8_Encoder::length(lo); ++i) {
136                            var = block.createAnd(suffixVar, block.createAdvance(var, 1));
137                        }
138                        target = block.createOr(target, var);
139                    }
140                }
141                else { // lbyte == hbyte
142                    PabloAST * byteVar = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
143                    PabloAST * infix = byteVar;
144                    if (byte_no > 1) {
145                        infix = block.createAnd(block.createAdvance(prefix ? prefix : byteVar, 1), byteVar);
146                    }
147                    if (byte_no < UTF8_Encoder::length(lo)) {
148                        target = sequenceGenerator(lo, hi, byte_no + 1, block, target, infix);
149                    }
150                }
151            }
152        }
153    }
154
155    return target;
156}
157
158/** ------------------------------------------------------------------------------------------------------------- *
159 * @brief sequenceGenerator
160 ** ------------------------------------------------------------------------------------------------------------- */
161inline PabloAST * UCDCompiler::sequenceGenerator(const codepoint_t lo, const codepoint_t hi, const unsigned byte_no, PabloBuilder & block, PabloAST * target, PabloAST * prefix) {
162    return sequenceGenerator({{ lo, hi }}, byte_no, block, target, prefix);
163}
164
165/** ------------------------------------------------------------------------------------------------------------- *
166 * @brief ifTestCompiler
167 ** ------------------------------------------------------------------------------------------------------------- */
168inline PabloAST * UCDCompiler::ifTestCompiler(const codepoint_t lo, const codepoint_t hi, PabloBuilder & block) {
169    return ifTestCompiler(lo, hi, 1, block, block.createOnes());
170}
171
172/** ------------------------------------------------------------------------------------------------------------- *
173 * @brief ifTestCompiler
174 ** ------------------------------------------------------------------------------------------------------------- */
175PabloAST * UCDCompiler::ifTestCompiler(const codepoint_t lo, const codepoint_t hi, const unsigned byte_no, PabloBuilder & block, PabloAST * target) {
176
177    codepoint_t lo_byte = UTF8_Encoder::encodingByte(lo, byte_no);
178    codepoint_t hi_byte = UTF8_Encoder::encodingByte(hi, byte_no);
179    const bool at_lo_boundary = (lo == 0 || UTF8_Encoder::encodingByte(lo - 1, byte_no) != lo_byte);
180    const bool at_hi_boundary = (hi == 0x10FFFF || UTF8_Encoder::encodingByte(hi + 1, byte_no) != hi_byte);
181
182    if (at_lo_boundary && at_hi_boundary) {
183        if (lo_byte != hi_byte) {
184            if (lo == 0x80) lo_byte = 0xC0;
185            if (hi == 0x10FFFF) hi_byte = 0xFF;
186        }
187        PabloAST * cc = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
188        target = block.createAnd(cc, target);
189    }
190    else if (lo_byte == hi_byte) {
191        PabloAST * cc = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
192        target = block.createAnd(cc, target);
193        target = block.createAdvance(target, 1);
194        target = ifTestCompiler(lo, hi, byte_no + 1, block, target);
195    }
196    else if (!at_hi_boundary) {
197        const auto mid = UTF8_Encoder::minCodePointWithCommonBytes(hi, byte_no);
198        PabloAST * e1 = ifTestCompiler(lo, mid - 1, byte_no, block, target);
199        PabloAST * e2 = ifTestCompiler(mid, hi, byte_no, block, target);
200        target = block.createOr(e1, e2);
201    }
202    else {
203        const auto mid = UTF8_Encoder::maxCodePointWithCommonBytes(lo, byte_no);
204        PabloAST * e1 = ifTestCompiler(lo, mid, byte_no, block, target);
205        PabloAST * e2 = ifTestCompiler(mid + 1, hi, byte_no, block, target);
206        target = block.createOr(e1, e2);
207    }
208    return target;
209}
210
211/** ------------------------------------------------------------------------------------------------------------- *
212 * @brief definePrecedingPrefix
213 * @param ifRangeList
214 *
215 *
216 * Ensure the sequence of preceding bytes is defined, up to, but not including the given byte_no
217 ** ------------------------------------------------------------------------------------------------------------- */
218PabloAST * UCDCompiler::makePrefix(const codepoint_t cp, const unsigned byte_no, PabloBuilder & pb, PabloAST * prefix) {
219    assert (byte_no >= 1 && byte_no <= 4);
220    assert (byte_no == 1 || prefix != nullptr);
221    for (unsigned i = 1; i != byte_no; ++i) {
222        const CC * const cc = makeCC(UTF8_Encoder::encodingByte(cp, i));
223        PabloAST * var = mCharacterClassCompiler.compileCC(cc, pb);
224        if (i > 1) {
225            var = pb.createAnd(var, pb.createAdvance(prefix, 1));
226        }
227        prefix = var;
228    }
229    return prefix;
230}
231
232/** ------------------------------------------------------------------------------------------------------------- *
233 * @brief definePrecedingPrefix
234 * @param ifRangeList
235 *
236 *
237 * Ensure the sequence of preceding bytes is defined, up to, but not including the given byte_no
238 ** ------------------------------------------------------------------------------------------------------------- */
239UCDCompiler::RangeList UCDCompiler::byteDefinitions(const RangeList & list, const unsigned byte_no) {
240    RangeList result;
241    result.reserve(list.size());
242    for (const auto & i : list) {
243        result.emplace_back(UTF8_Encoder::encodingByte(lo_codepoint(i), byte_no), UTF8_Encoder::encodingByte(hi_codepoint(i), byte_no));
244    }
245    return result;
246}
247
248/** ------------------------------------------------------------------------------------------------------------- *
249 * @brief rangeIntersect
250 * @param list
251 * @param lo
252 * @param hi
253 ** ------------------------------------------------------------------------------------------------------------- */
254template <typename RangeListOrUnicodeSet>
255UCDCompiler::RangeList UCDCompiler::rangeIntersect(const RangeListOrUnicodeSet & list, const codepoint_t lo, const codepoint_t hi) {
256    RangeList result;
257    for (const auto i : list) {
258        if ((lo_codepoint(i) <= hi) && (hi_codepoint(i) >= lo)) {
259            result.emplace_back(std::max(lo, lo_codepoint(i)), std::min(hi, hi_codepoint(i)));
260        }
261    }
262    return result;
263}
264
265/** ------------------------------------------------------------------------------------------------------------- *
266 * @brief rangeGaps
267 * @param cc
268 * @param lo
269 * @param hi
270 ** ------------------------------------------------------------------------------------------------------------- */
271UCDCompiler::RangeList UCDCompiler::rangeGaps(const RangeList & list, const codepoint_t lo, const codepoint_t hi) {
272    RangeList gaps;
273    if (LLVM_LIKELY(lo < hi)) {
274        if (LLVM_UNLIKELY(list.empty())) {
275            gaps.emplace_back(lo, hi);
276        }
277        else {
278            codepoint_t cp = lo;
279            for (const auto & i : list) {
280                if (hi_codepoint(i) < cp) {
281                    continue;
282                }
283                else if (lo_codepoint(i) > cp) {
284                    gaps.emplace_back(cp, lo_codepoint(i) - 1);
285                }
286                else if (hi_codepoint(i) >= hi) {
287                    continue;
288                }
289                cp = hi_codepoint(i) + 1;
290            }
291        }
292    }
293    return gaps;
294}
295
296/** ------------------------------------------------------------------------------------------------------------- *
297 * @brief outerRanges
298 * @param list
299 ** ------------------------------------------------------------------------------------------------------------- */
300UCDCompiler::RangeList UCDCompiler::outerRanges(const RangeList & list) {
301    RangeList ranges;
302    if (LLVM_LIKELY(list.size() > 0)) {
303        auto i = list.cbegin();
304        for (auto j = i + 1; j != list.cend(); ++j) {
305            if (hi_codepoint(*j) > hi_codepoint(*i)) {
306                ranges.emplace_back(lo_codepoint(*i), hi_codepoint(*i));
307                i = j;
308            }
309        }
310        if (LLVM_LIKELY(i != list.end())) {
311            ranges.emplace_back(lo_codepoint(*i), hi_codepoint(*i));
312        }
313    }
314    return ranges;
315}
316
317/** ------------------------------------------------------------------------------------------------------------- *
318 * @brief innerRanges
319 * @param list
320 ** ------------------------------------------------------------------------------------------------------------- */
321UCDCompiler::RangeList UCDCompiler::innerRanges(const RangeList & list) {
322    RangeList ranges;
323    if (LLVM_LIKELY(list.size() > 0)) {
324        for (auto i = list.cbegin(), j = i + 1; j != list.cend(); ++j) {
325            if (hi_codepoint(*j) <= hi_codepoint(*i)) {
326                ranges.emplace_back(lo_codepoint(*j), hi_codepoint(*j));
327            }
328            else {
329                i = j;
330            }
331        }
332    }
333    return ranges;
334}
335
336/** ------------------------------------------------------------------------------------------------------------- *
337 * @brief generateWithDefaultIfHierarchy
338 * @param set the unicode set to generate
339 * @param the entry block to the function we're filling
340 * @return the output stream with a 1-bit in any position of a character in the unicode set
341 ** ------------------------------------------------------------------------------------------------------------- */
342PabloAST * UCDCompiler::generateWithDefaultIfHierarchy(const UnicodeSet & set, PabloBuilder & entry) {
343
344    const RangeList defaultIfHierachy = {
345        // Non-ASCII
346        {0x80, 0x10FFFF},
347        // Two-byte sequences
348        {0x80, 0x7FF},
349        {0x100, 0x3FF},
350        // 0100..017F; Latin Extended-A
351        // 0180..024F; Latin Extended-B
352        // 0250..02AF; IPA Extensions
353        // 02B0..02FF; Spacing Modifier Letters
354        {0x100, 0x2FF}, {0x100, 0x24F}, {0x100, 0x17F}, {0x180, 0x24F}, {0x250, 0x2AF}, {0x2B0, 0x2FF},
355        // 0300..036F; Combining Diacritical Marks
356        // 0370..03FF; Greek and Coptic
357        {0x300, 0x36F}, {0x370, 0x3FF},
358        // 0400..04FF; Cyrillic
359        // 0500..052F; Cyrillic Supplement
360        // 0530..058F; Armenian
361        // 0590..05FF; Hebrew
362        // 0600..06FF; Arabic
363        {0x400, 0x5FF}, {0x400, 0x4FF}, {0x500, 0x058F}, {0x500, 0x52F}, {0x530, 0x58F}, {0x590, 0x5FF}, {0x600, 0x6FF},
364        // 0700..074F; Syriac
365        // 0750..077F; Arabic Supplement
366        // 0780..07BF; Thaana
367        // 07C0..07FF; NKo
368        {0x700, 0x77F}, {0x700, 0x74F}, {0x750, 0x77F}, {0x780, 0x7FF}, {0x780, 0x7BF}, {0x7C0, 0x7FF},
369        // Three-byte sequences
370        {0x800, 0xFFFF}, {0x800, 0x4DFF}, {0x800, 0x1FFF}, {0x800, 0x0FFF},
371        // 0800..083F; Samaritan
372        // 0840..085F; Mandaic
373        // 08A0..08FF; Arabic Extended-A
374        // 0900..097F; Devanagari
375        // 0980..09FF; Bengali
376        // 0A00..0A7F; Gurmukhi
377        // 0A80..0AFF; Gujarati
378        // 0B00..0B7F; Oriya
379        // 0B80..0BFF; Tamil
380        // 0C00..0C7F; Telugu
381        // 0C80..0CFF; Kannada
382        // 0D00..0D7F; Malayalam
383        // 0D80..0DFF; Sinhala
384        // 0E00..0E7F; Thai
385        // 0E80..0EFF; Lao
386        // 0F00..0FFF; Tibetan
387        {0x1000, 0x1FFF},
388        // 1000..109F; Myanmar
389        // 10A0..10FF; Georgian
390        // 1100..11FF; Hangul Jamo
391        // 1200..137F; Ethiopic
392        // 1380..139F; Ethiopic Supplement
393        // 13A0..13FF; Cherokee
394        // 1400..167F; Unified Canadian Aboriginal Syllabics
395        // 1680..169F; Ogham
396        // 16A0..16FF; Runic
397        // 1700..171F; Tagalog
398        // 1720..173F; Hanunoo
399        // 1740..175F; Buhid
400        // 1760..177F; Tagbanwa
401        // 1780..17FF; Khmer
402        // 1800..18AF; Mongolian
403        // 18B0..18FF; Unified Canadian Aboriginal Syllabics Extended
404        // 1900..194F; Limbu
405        // 1950..197F; Tai Le
406        // 1980..19DF; New Tai Lue
407        // 19E0..19FF; Khmer Symbols
408        // 1A00..1A1F; Buginese
409        // 1A20..1AAF; Tai Tham
410        // 1AB0..1AFF; Combining Diacritical Marks Extended
411        // 1B00..1B7F; Balinese
412        // 1B80..1BBF; Sundanese
413        // 1BC0..1BFF; Batak
414        // 1C00..1C4F; Lepcha
415        // 1C50..1C7F; Ol Chiki
416        // 1CC0..1CCF; Sundanese Supplement
417        // 1CD0..1CFF; Vedic Extensions
418        // 1D00..1D7F; Phonetic Extensions
419        // 1D80..1DBF; Phonetic Extensions Supplement
420        // 1DC0..1DFF; Combining Diacritical Marks Supplement
421        // 1E00..1EFF; Latin Extended Additional
422        // 1F00..1FFF; Greek Extended
423        {0x2000, 0x4DFF}, {0x2000, 0x2FFF},
424        {0x3000, 0x4DFF},
425        {0x4E00, 0x9FFF},
426        // 4E00..9FFF; CJK Unified Ideographs
427        {0xA000, 0xFFFF},
428
429        {0x10000, 0x10FFFF}};
430
431//    llvm::raw_os_ostream out(std::cerr);
432
433//    for (auto range : set) {
434//        out << range.first << ',' << range.second << "\n";
435//    }
436
437//    out.flush();
438
439    return generateWithIfHierarchy(defaultIfHierachy, set, entry);
440}
441
442/** ------------------------------------------------------------------------------------------------------------- *
443 * @brief constructor
444 ** ------------------------------------------------------------------------------------------------------------- */
445UCDCompiler::UCDCompiler(cc::CC_Compiler & ccCompiler)
446: mCharacterClassCompiler(ccCompiler)
447, mSuffix(makeCC(0x80, 0xBF)) { }
448
449}
Note: See TracBrowser for help on using the repository browser.