source: icGREP/icgrep-devel/icgrep/cc/cc_compiler.cpp @ 5823

Last change on this file since 5823 was 5823, checked in by cameron, 9 months ago

Direct CC compiler

File size: 10.1 KB
Line 
1/*
2 *  Copyright (c) 2018 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
7#include "cc_compiler.h"
8#include <cc/alphabet.h>
9#include <pablo/codegenstate.h>
10#include <pablo/boolean.h>
11#include <pablo/pe_zeroes.h>
12#include <pablo/pe_ones.h>
13#include <pablo/builder.hpp>
14#include <pablo/pablo_kernel.h>
15#include <llvm/IR/DerivedTypes.h>
16#include <llvm/Support/ErrorHandling.h>
17
18using namespace re;
19using namespace pablo;
20using namespace llvm;
21
22namespace cc {
23
24CC_Compiler::CC_Compiler(pablo::PabloKernel * kernel, pablo::Var * basisBits)
25: mBuilder(kernel->getEntryBlock())
26, mEncodingBits(basisBits->getType()->getArrayNumElements())
27, mBasisBit(mEncodingBits) {
28    for (unsigned i = 0; i != mEncodingBits; i++) {
29        mBasisBit[i] = mBuilder.createExtract(basisBits, mBuilder.getInteger(i)); assert (mBasisBit[i]);
30    }
31    mEncodingMask = (static_cast<unsigned>(1) << mEncodingBits) - static_cast<unsigned>(1);
32}
33
34PabloAST * CC_Compiler::compileCC(const std::string & canonicalName, const CC *cc, PabloBlock & block) {
35    PabloAST * const var = charset_expr(cc, block);
36    if (LLVM_LIKELY(isa<Statement>(var))) {
37        cast<Statement>(var)->setName(block.makeName(canonicalName));
38    }
39    return var;
40}
41
42PabloAST * CC_Compiler::compileCC(const std::string & canonicalName, const CC *cc, PabloBuilder & builder) {
43    PabloAST * const var = charset_expr(cc, builder);
44    if (LLVM_LIKELY(isa<Statement>(var))) {
45        cast<Statement>(var)->setName(builder.makeName(canonicalName));
46    }
47    return var;
48}
49   
50template<typename PabloBlockOrBuilder>
51PabloAST * CC_Compiler::charset_expr(const CC * cc, PabloBlockOrBuilder & pb) {
52    if (cc->empty()) {
53        return pb.createZeroes();
54    }
55    if (cc->size() > 2) {
56        bool combine = true;
57        for (const interval_t & i : *cc) {
58            if (lo_codepoint(i) != hi_codepoint(i)) {
59                combine = false;
60                break;
61            }
62        }
63        if (combine) {
64            auto i = cc->begin(), e = cc->end();
65            for (auto j = i; ++j != e; i = j) {
66                if ((lo_codepoint(i) + 2) != lo_codepoint(j)) {
67                    combine  = false;
68                    break;
69                }
70            }
71            if (combine) {
72                codepoint_t lo = lo_codepoint(cc->front());
73                codepoint_t hi = lo_codepoint(cc->back());
74                lo &= (mEncodingMask - 1);
75                hi |= (mEncodingMask ^ (mEncodingMask - 1));
76                PabloAST * expr = make_range(lo, hi, pb);
77                PabloAST * bit0 = getBasisVar(0);
78                if ((lo & 1) == 0) {
79                    bit0 = pb.createNot(bit0);
80                }
81                return pb.createAnd(expr, bit0);
82            }
83        }
84    }
85    PabloAST * expr = nullptr;
86    for (const interval_t & i : *cc) {
87        PabloAST * temp = char_or_range_expr(lo_codepoint(i), hi_codepoint(i), pb);
88        expr = (expr == nullptr) ? temp : pb.createOr(expr, temp);
89    }
90    return expr;
91   
92}
93
94template<typename PabloBlockOrBuilder>
95PabloAST * CC_Compiler::bit_pattern_expr(const unsigned pattern, unsigned selected_bits, PabloBlockOrBuilder & pb) {
96    if (LLVM_UNLIKELY(selected_bits == 0)) {
97        return pb.createOnes();
98    } else {
99        std::vector<PabloAST*> terms;
100        for (unsigned i = 0; selected_bits; ++i) {
101            unsigned test_bit = static_cast<unsigned>(1) << i;
102            PabloAST * term = pb.createOnes();
103            if (selected_bits & test_bit) {
104                term = getBasisVar(i);
105                if ((pattern & test_bit) == 0) {
106                    term = pb.createNot(term);
107                }
108                selected_bits ^= test_bit;
109            }
110            terms.push_back(term);
111        }
112        if (terms.size() > 1) {
113            //Reduce the list so that all of the expressions are contained within a single expression.
114            std::vector<PabloAST*> temp;
115            temp.reserve(terms.size());
116            do {
117                for (unsigned i = 0; i < (terms.size() / 2); i++) {
118                    temp.push_back(pb.createAnd(terms[2 * i], terms[(2 * i) + 1]));
119                }
120                if (terms.size() % 2 == 1) {
121                    temp.push_back(terms.back());
122                }
123                terms.swap(temp);
124                temp.clear();
125            }
126            while (terms.size() > 1);
127        }
128        assert (terms.size() == 1);
129        return terms.front();
130    }
131}
132
133template<typename PabloBlockOrBuilder>
134inline PabloAST * CC_Compiler::char_test_expr(const codepoint_t ch, PabloBlockOrBuilder &pb) {
135    return bit_pattern_expr(ch, mEncodingMask, pb);
136}
137
138template<typename PabloBlockOrBuilder>
139PabloAST * CC_Compiler::make_range(const codepoint_t n1, const codepoint_t n2, PabloBlockOrBuilder & pb) {
140    codepoint_t diff_count = 0;
141
142    for (codepoint_t diff_bits = n1 ^ n2; diff_bits; diff_count++, diff_bits >>= 1);
143
144    if ((n2 < n1) || (diff_count > mEncodingBits)) {
145        llvm::report_fatal_error("Bad Range: [" + std::to_string(n1) + "," +
146                                 std::to_string(n2) + "] for " +
147                                 std::to_string(mEncodingBits) + "-bit encoding");
148    }
149
150    const codepoint_t mask0 = (static_cast<codepoint_t>(1) << diff_count) - 1;
151
152    PabloAST * common = bit_pattern_expr(n1 & ~mask0, mEncodingMask ^ mask0, pb);
153
154    if (diff_count == 0) return common;
155
156    const codepoint_t mask1 = (static_cast<codepoint_t>(1) << (diff_count - 1)) - 1;
157
158    PabloAST* lo_test = GE_Range(diff_count - 1, n1 & mask1, pb);
159    PabloAST* hi_test = LE_Range(diff_count - 1, n2 & mask1, pb);
160
161    return pb.createAnd(common, pb.createSel(getBasisVar(diff_count - 1), hi_test, lo_test));
162}
163
164template<typename PabloBlockOrBuilder>
165PabloAST * CC_Compiler::GE_Range(const unsigned N, const unsigned n, PabloBlockOrBuilder &pb) {
166    if (N == 0) {
167        return pb.createOnes(); //Return a true literal.
168    }
169    else if (((N % 2) == 0) && ((n >> (N - 2)) == 0)) {
170        return pb.createOr(pb.createOr(getBasisVar(N - 1), getBasisVar(N - 2)), GE_Range(N - 2, n, pb));
171    }
172    else if (((N % 2) == 0) && ((n >> (N - 2)) == 3)) {
173        return pb.createAnd(pb.createAnd(getBasisVar(N - 1), getBasisVar(N - 2)), GE_Range(N - 2, n - (3 << (N - 2)), pb));
174    }
175    else if (N >= 1)
176    {
177        int hi_bit = n & (1 << (N - 1));
178        int lo_bits = n - hi_bit;
179        PabloAST * lo_range = GE_Range(N - 1, lo_bits, pb);
180        if (hi_bit == 0)
181        {
182            /*
183              If the hi_bit of n is not set, then whenever the corresponding bit
184              is set in the target, the target will certaily be >=.  Otherwise,
185              the value of GE_range(N-1), lo_range) is required.
186            */
187            return pb.createOr(getBasisVar(N - 1), lo_range);
188        }
189        else
190        {
191            /*
192              If the hi_bit of n is set, then the corresponding bit must be set
193              in the target for >= and GE_range(N-1, lo_bits) must also be true.
194            */
195            return pb.createAnd(getBasisVar(N - 1), lo_range);
196        }
197    }
198    throw std::runtime_error("Unexpected input given to ge_range: " + std::to_string(N) + ", " + std::to_string(n));
199}
200
201template<typename PabloBlockOrBuilder>
202PabloAST * CC_Compiler::LE_Range(const unsigned N, const unsigned n, PabloBlockOrBuilder & pb) {
203    /*
204      If an N-bit pattern is all ones, then it is always true that any n-bit value is LE this pattern.
205      Handling this as a special case avoids an overflow issue with n+1 requiring more than N bits.
206    */
207    if ((n + 1) == (1UL << N)) {
208        return pb.createOnes(); //True.
209    } else {
210        return pb.createNot(GE_Range(N, n + 1, pb));
211    }
212}
213
214template<typename PabloBlockOrBuilder>
215inline PabloAST * CC_Compiler::char_or_range_expr(const codepoint_t lo, const codepoint_t hi, PabloBlockOrBuilder &pb) {
216    if (lo == hi) {
217        return char_test_expr(lo, pb);
218    } else if (lo < hi) {
219        return make_range(lo, hi, pb);
220    }
221    llvm::report_fatal_error(std::string("Invalid Character Set Range: [") + std::to_string(lo) + "," + std::to_string(hi) + "]");
222}
223
224inline PabloAST * CC_Compiler::getBasisVar(const unsigned i) const {
225    assert (i < mEncodingBits);
226    const unsigned index = mEncodingBits - i - 1; assert (index < mEncodingBits);
227    assert (mBasisBit[index]);
228    return mBasisBit[index];
229}
230
231   
232PabloAST * compileCCfromCodeUnitStream(const CC *cc, PabloAST * codeUnitStream, PabloBuilder & pb) {
233    const Alphabet * a = cc->getAlphabet();
234    if (!isa<CodeUnitAlphabet>(a)) {
235        llvm::report_fatal_error("compileCCfromCodeUnitStream must be applied to a CC with a CodeUnitAlphabet");
236    }
237    unsigned codeUnitWidth = cast<const CodeUnitAlphabet>(a)->getCodeUnitBitWidth();
238    unsigned topBit = 1 << codeUnitWidth;
239    unsigned maxCodeVal = (topBit - 1) | topBit;
240    PabloAST * ccStrm = pb.createZeroes();
241#ifdef PABLO_ALL
242    for (const auto & interval : *cc) {
243        unsigned lo = re::lo_codepoint(interval);
244        unsigned hi = re::hi_codepoint(interval);
245        if (lo == hi) {
246            PabloAST * testVal = pb.createAll(codeUnitWidth, lo);
247            ccStrm = pb.createOr(ccStrm, pb.createEqual(codeUnitStream, testVal));
248        } else if (lo == 0) {
249            if (hi == maxCodeVal) {
250                // All code units
251                ccStrm = pb.createOnes();
252            } else {
253                PabloAST * testVal = pb.createAll(codeUnitWidth, hi+1);
254                ccStrm = pb.createOr(ccStrm, pb.createLessThan(codeUnitStream, testVal));
255            }
256        } else if (hi == maxCodeVal) {
257            PabloAST * testVal = pb.createAll(codeUnitWidth, lo);
258            ccStrm = pb.createOr(ccStrm, pb.createNot(pb.createLessThan(codeUnitStream, testVal));)
259        } else {
260            PabloAST * testVal_lo = pb.createAll(codeUnitWidth, lo);
261            PabloAST * testVal_hi = pb.createAll(codeUnitWidth, hi+1);
262            ccStrm = pb.createOr(ccStrm, pb.createAnd(pb.createNot(pb.createLessThan(codeUnitStream, testVal_lo)),
263                                                      pb.createLessThan(codeUnitStream, testVal_hi)));
264        }
265    }
266#endif
267    return ccStrm;
268}
269} // end of namespace cc
Note: See TracBrowser for help on using the repository browser.