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

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

Bug fixes

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