source: icGREP/icgrep-devel/icgrep/pablo/codegenstate.h @ 5074

Last change on this file since 5074 was 5061, checked in by cameron, 3 years ago

pablo.Count is a pure statement, setting an accumulator state variable

File size: 9.5 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
7#ifndef PS_PABLOS_H
8#define PS_PABLOS_H
9
10#include <pablo/pabloAST.h>
11#include <pablo/symbol_generator.h>
12#include <pablo/pe_advance.h>
13#include <pablo/pe_lookahead.h>
14#include <pablo/pe_and.h>
15#include <pablo/pe_call.h>
16#include <pablo/pe_matchstar.h>
17#include <pablo/pe_next.h>
18#include <pablo/pe_not.h>
19#include <pablo/pe_ones.h>
20#include <pablo/pe_or.h>
21#include <pablo/pe_scanthru.h>
22#include <pablo/pe_sel.h>
23#include <pablo/pe_infile.h>
24#include <pablo/pe_integer.h>
25#include <pablo/pe_string.h>
26#include <pablo/pe_var.h>
27#include <pablo/pe_xor.h>
28#include <pablo/pe_zeroes.h>
29#include <pablo/pe_count.h>
30#include <pablo/ps_assign.h>
31#include <pablo/ps_if.h>
32#include <pablo/ps_while.h>
33#include <pablo/function.h>
34#include <llvm/ADT/ArrayRef.h>
35#include <stdexcept>
36
37namespace pablo {
38
39class PabloBlock : public PabloAST, public StatementList {
40    friend class PabloAST;
41    friend class If;
42    friend class While;
43    friend class PabloBuilder;
44public:
45
46    static inline bool classof(const PabloBlock *) {
47        return true;
48    }
49    static inline bool classof(const Statement *) {
50        return false;
51    }
52    static inline bool classof(const PabloAST * e) {
53        return e->getClassTypeId() == ClassTypeId::Block;
54    }
55    static inline bool classof(const void *) {
56        return false;
57    }
58
59    inline static PabloBlock * Create(PabloFunction & function) noexcept {
60        return new PabloBlock(function.mSymbolTable);
61    }
62
63    inline static PabloBlock * Create(PabloBlock * const block) noexcept {
64        return new PabloBlock(block->mSymbolGenerator);
65    }
66
67    PabloAST * createAdvance(PabloAST * expr, const Integer::Type shiftAmount);
68
69    PabloAST * createAdvance(PabloAST * expr, PabloAST * shiftAmount);
70
71    PabloAST * createAdvance(PabloAST * expr, const Integer::Type shiftAmount, const std::string prefix);
72
73    PabloAST * createAdvance(PabloAST * expr, PabloAST * shiftAmount, const std::string prefix);
74
75    PabloAST * createLookahead(PabloAST * expr, const Integer::Type shiftAmount);
76
77    PabloAST * createLookahead(PabloAST * expr, PabloAST * shiftAmount);
78
79    PabloAST * createLookahead(PabloAST * expr, const Integer::Type shiftAmount, const std::string prefix);
80
81    PabloAST * createLookahead(PabloAST * expr, PabloAST * shiftAmount, const std::string prefix);
82
83    static inline Zeroes * createZeroes() {
84        return &mZeroes;
85    }
86
87    static inline Ones * createOnes() {
88        return &mOnes;
89    }
90
91    inline Call * createCall(Prototype * prototype, const std::vector<Var *> & args) {
92        return createCall(prototype, reinterpret_cast<const std::vector<PabloAST *> &>(args));
93    }
94
95    inline Call * createCall(Prototype * prototype, const std::vector<PabloAST *> & args) {
96        if (prototype == nullptr) {
97            throw std::runtime_error("Call object cannot be created with a Null prototype!");
98        }
99        if (args.size() != cast<Prototype>(prototype)->getNumOfParameters()) {
100            throw std::runtime_error("Invalid number of arguments passed into Call object!");
101        }
102        return createCall(static_cast<PabloAST *>(prototype), args);
103    }
104
105    Assign * createAssign(const std::string && prefix, PabloAST * const expr);
106
107    inline Var * createVar(const std::string name) {
108        return createVar(getName(name, false));
109    }
110
111    inline Var * createVar(String * name) {
112        return createVar(cast<PabloAST>(name));
113    }
114
115    Next * createNext(Assign * assign, PabloAST * expr);
116
117    PabloAST * createAnd(PabloAST * expr1, PabloAST * expr2);
118
119    PabloAST * createAnd(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
120
121    And * createAnd(const unsigned reserved);
122
123    And * createAnd(const unsigned reserved, const std::string prefix);
124
125    And * createAnd(std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end) {
126        return insertAtInsertionPoint(new And(begin, end, makeName("and_")));
127    }
128
129    And * createAnd(Variadic::iterator begin, Variadic::iterator end) {
130        return insertAtInsertionPoint(new And(begin, end, makeName("and_")));
131    }
132
133    PabloAST * createNot(PabloAST * expr);
134
135    PabloAST * createNot(PabloAST * expr, const std::string prefix);
136
137    PabloAST * createOr(PabloAST * expr1, PabloAST * expr2);
138
139    PabloAST * createOr(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
140
141    Or * createOr(std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end) {
142        return insertAtInsertionPoint(new Or(begin, end, makeName("or_")));
143    }
144
145    Or * createOr(Variadic::iterator begin, Variadic::iterator end) {
146        return insertAtInsertionPoint(new Or(begin, end, makeName("or_")));
147    }
148
149    Or * createOr(const unsigned reserved);
150
151    Or * createOr(const unsigned reserved, const std::string prefix);
152
153    PabloAST * createXor(PabloAST * expr1, PabloAST * expr2);
154
155    PabloAST * createXor(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
156
157    Xor * createXor(std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end) {
158        return insertAtInsertionPoint(new Xor(begin, end, makeName("xor_")));
159    }
160
161    Xor * createXor(Variadic::iterator begin, Variadic::iterator end) {
162        return insertAtInsertionPoint(new Xor(begin, end, makeName("xor_")));
163    }
164
165    Xor * createXor(const unsigned reserved);
166
167    Xor * createXor(const unsigned reserved, const std::string prefix);
168
169    PabloAST * createMatchStar(PabloAST * marker, PabloAST * charclass);
170
171    PabloAST * createMatchStar(PabloAST * marker, PabloAST * charclass, const std::string prefix);
172
173    PabloAST * createScanThru(PabloAST * from, PabloAST * thru);
174
175    PabloAST * createScanThru(PabloAST * from, PabloAST * thru, const std::string prefix);
176
177    PabloAST * createSel(PabloAST * condition, PabloAST * trueExpr, PabloAST * falseExpr);
178
179    PabloAST * createSel(PabloAST * condition, PabloAST * trueExpr, PabloAST * falseExpr, const std::string prefix);
180
181    Count * createCount(const std::string counter, PabloAST * const expr);
182   
183    PabloAST * createInFile(PabloAST * expr);
184   
185    PabloAST * createInFile(PabloAST * expr, const std::string prefix);
186   
187    PabloAST * createAtEOF(PabloAST * expr);
188   
189    PabloAST * createAtEOF(PabloAST * expr, const std::string prefix);
190   
191    If * createIf(PabloAST * condition, const std::initializer_list<Assign *> definedVars, PabloBlock * body);
192
193    If * createIf(PabloAST * condition, const std::vector<Assign *> & definedVars, PabloBlock * body);
194
195    If * createIf(PabloAST * condition, std::vector<Assign *> && definedVars, PabloBlock * body);
196
197    While * createWhile(PabloAST * condition, const std::initializer_list<Next *> nextVars, PabloBlock * body);
198
199    While * createWhile(PabloAST * condition, const std::vector<Next *> & nextVars, PabloBlock * body);
200
201    While * createWhile(PabloAST * condition, std::vector<Next *> && nextVars, PabloBlock * body);
202
203    inline StatementList & statements() {
204        return *this;
205    }
206
207    inline const StatementList & statements() const {
208        return *this;
209    }
210
211    inline String * getName(const std::string name, const bool generated = true) const {
212        return mSymbolGenerator->get(name, generated);
213    }
214
215    inline String * makeName(const std::string prefix, const bool generated = true) const {
216        return mSymbolGenerator->make(prefix, generated);
217    }
218
219    inline Integer * getInteger(Integer::Type value) {
220        return mSymbolGenerator->getInteger(value);
221    }
222
223    inline PabloBlock * getParent() const {
224        return mParent;
225    }
226   
227    void setParent(PabloBlock * parent) {
228        mParent = parent;
229        // Add test to assert this block is in the same function.
230    }
231
232    void insert(Statement * const statement);
233
234    unsigned enumerateScopes(unsigned baseScopeIndex);
235   
236    inline unsigned getScopeIndex() const {
237        return mScopeIndex;
238    }
239   
240    void eraseFromParent(const bool recursively = false);
241
242    inline Statement * getBranch() const {
243        return mBranch;
244    }
245
246    virtual ~PabloBlock();
247
248protected:
249
250    explicit PabloBlock(SymbolGenerator * symbolGenerator) noexcept;
251
252    PabloAST * renameNonNamedNode(PabloAST * expr, const std::string && prefix);
253
254    template<typename Type>
255    inline Type * insertAtInsertionPoint(Type * expr) {
256        if (isa<Statement>(expr)) {
257            if (LLVM_UNLIKELY(isa<If>(expr) || isa<While>(expr))) {
258                PabloBlock * const body = isa<If>(expr) ? cast<If>(expr)->getBody() : cast<While>(expr)->getBody();
259                body->setParent(this);
260                addUser(body);
261            }
262            insert(cast<Statement>(expr));
263        }
264        return expr;
265    }
266
267    inline void setBranch(Statement * const branch) {
268        mBranch = branch;
269    }
270
271private:
272
273    Call * createCall(PabloAST * prototype, const std::vector<PabloAST *> &);
274
275    Var * createVar(PabloAST * name);
276
277private:       
278    static Zeroes                                       mZeroes;
279    static Ones                                         mOnes;
280    SymbolGenerator *                                   mSymbolGenerator; // TODO: need a better way of passing a symbol generator around
281    PabloBlock *                                        mParent;
282    Statement *                                         mBranch; // What statement branches into this scope block?
283    unsigned                                            mScopeIndex;
284};
285
286}
287
288#endif // PS_PABLOS_H
Note: See TracBrowser for help on using the repository browser.