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

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

Work on coalescing algorithm + minor changes.

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