source: icGREP/icgrep-devel/icgrep/pablo/pabloAST.h @ 5297

Last change on this file since 5297 was 5283, checked in by nmedfort, 2 years ago

Optimized Symbol Generation (and fixed potential bug that could allow duplicate names being constructed); made PabloKernel? extend PabloAST (temporarily removed PabloAST::getName() to avoid diamond problem); added an internal scalar to PabloKernel? struct for each Count to avoid InOut? output scalar variable problem; allowed CodeMotionPass? to move code within the same scope but across a branch statement. Began work on separating Kernels into either Block-Oriented or Segment-Oriented kernels.

File size: 16.9 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 PE_PabloAST_H
8#define PE_PabloAST_H
9
10#include <llvm/Support/Casting.h>
11#include <llvm/Support/Compiler.h>
12#include <boost/iterator/iterator_facade.hpp>
13#include <util/slab_allocator.h>
14#include <type_traits>
15#include <vector>
16namespace llvm { class Type; }
17namespace llvm { class raw_ostream; }
18namespace pablo { class PabloBlock; }
19namespace pablo { class String; }
20
21namespace pablo {
22
23class PabloAST {
24    friend class Statement;
25    friend class Variadic;
26    friend class StatementList;
27    friend class Branch;
28    friend class PabloBlock;
29    friend class SymbolGenerator;
30    friend class Count;
31    friend class Var;
32    friend class Operator;
33public:
34
35    using Allocator = SlabAllocator<PabloAST *>;
36    using UserAllocator = ProxyAllocator<PabloAST *>;
37    using Users = std::vector<PabloAST *, UserAllocator>;
38    using user_iterator = Users::iterator;
39    using const_user_iterator = Users::const_iterator;
40
41    static inline bool classof(const PabloAST *) {
42        return true;
43    }
44    static inline bool classof(const void *) {
45        return false;
46    }
47
48    enum class ClassTypeId : unsigned {
49        /** Non-statements **/
50        // Constants
51        Zeroes
52        , Ones
53        // Internal types
54        , Var       
55        , Integer
56        , String
57        , Block
58        , Kernel
59        // Arithmetic expressions
60        , Add
61        , Subtract
62        // Relational expressions
63        , LessThan
64        , LessThanEquals
65        , Equals
66        , GreaterThanEquals
67        , GreaterThan
68        , NotEquals
69        /** Statements **/
70        // Boolean operations
71        , And
72        , Or
73        , Xor
74        , Not       
75        , Sel
76        // Stream operations
77        , Advance
78        , ScanThru
79        , Lookahead
80        , MatchStar
81        , InFile
82        , AtEOF
83        // Statistics operations
84        , Count
85        // Variable assignments
86        , Assign
87        , Extract     
88        // Scope blocks
89        , If
90        , While
91    };
92
93    inline ClassTypeId getClassTypeId() const noexcept {
94        return mClassTypeId;
95    }
96
97    inline llvm::Type * getType() const noexcept {
98        return mType;
99    }
100
101    inline void setType(llvm::Type * type) noexcept {
102        mType = type;
103    }
104
105    inline user_iterator user_begin() {
106        return mUsers.begin();
107    }
108
109    inline user_iterator user_end() {
110        return mUsers.end();
111    }
112
113    inline const_user_iterator user_begin() const {
114        return mUsers.cbegin();
115    }
116
117    inline const_user_iterator user_end() const {
118        return mUsers.cend();
119    }
120
121    inline Users & users() {
122        return mUsers;
123    }
124
125    inline const Users & users() const {
126        return mUsers;
127    }
128
129    void replaceAllUsesWith(PabloAST * const expr);
130
131    inline Users::size_type getNumUses() const {
132        return mUsers.size();
133    }
134
135    void * operator new (std::size_t size, Allocator & allocator) noexcept {
136        return allocator.allocate<uint8_t>(size);
137    }
138
139//    void operator delete (void * ptr) {
140//        mAllocator.deallocate(static_cast<Allocator::value_type *>(ptr));
141//    }
142
143    void print(llvm::raw_ostream & O) const;
144
145protected:
146    inline PabloAST(const ClassTypeId id, llvm::Type * const type, Allocator & allocator)
147    : mClassTypeId(id)
148    , mType(type)
149    , mUsers(allocator) {
150
151    }
152    bool addUser(PabloAST * const user);
153    bool removeUser(PabloAST * const user);
154    virtual ~PabloAST() {
155        mUsers.clear();
156    }       
157private:
158    const ClassTypeId       mClassTypeId;
159    llvm::Type *            mType;
160    Users                   mUsers;
161};
162
163bool equals(const PabloAST * const expr1, const PabloAST * const expr2);
164
165bool dominates(const PabloAST * const expr1, const PabloAST * const expr2);
166
167bool postdominates(const PabloAST * const expr1, const PabloAST * const expr2);
168
169class StatementList;
170
171class String;
172
173class Statement : public PabloAST {
174    friend class StatementList;
175    friend class If;
176    friend class While;
177    friend class Simplifier;
178    friend class PabloBlock;
179public:
180    static inline bool classof(const PabloAST * e) {
181        return ((unsigned)e->getClassTypeId() >= (unsigned)PabloAST::ClassTypeId::And);
182    }
183    static inline bool classof(const Statement *) {
184        return true;
185    }
186    static inline bool classof(const void *) {
187        return false;
188    }
189
190    void replaceUsesOfWith(PabloAST * const from, PabloAST * const to);
191
192    const String & getName() const noexcept {
193        return *mName;
194    }
195
196    void setName(const String * const name) noexcept;
197
198    inline PabloAST * getOperand(const unsigned index) const {
199        assert (index < getNumOperands());
200        return mOperand[index];
201    }
202
203    void setOperand(const unsigned index, PabloAST * const value);
204
205    inline unsigned getNumOperands() const {
206        return mOperands;
207    }
208
209    void insertBefore(Statement * const statement);
210    void insertAfter(Statement * const statement);
211    Statement * removeFromParent();
212    Statement * eraseFromParent(const bool recursively = false);
213    Statement * replaceWith(PabloAST * const expr, const bool rename = true, const bool recursively = false);
214
215    inline Statement * getNextNode() const {
216        return mNext;
217    }
218    inline Statement * getPrevNode() const {
219        return mPrev;
220    }
221    inline PabloBlock * getParent() const {
222        return mParent;
223    }
224    virtual ~Statement() {}
225protected:
226
227    explicit Statement(const ClassTypeId id, llvm::Type * const type, std::initializer_list<PabloAST *> operands, const String * const name, Allocator & allocator)
228    : PabloAST(id, type, allocator)
229    , mOperands(operands.size())
230    , mOperand(allocator.allocate(mOperands))
231    , mNext(nullptr)
232    , mPrev(nullptr)
233    , mName(name)
234    , mParent(nullptr) {
235        unsigned i = 0;
236        for (PabloAST * const value : operands) {
237            assert (value);
238            mOperand[i] = value;
239            value->addUser(this);
240            ++i;
241        }
242    }
243
244    explicit Statement(const ClassTypeId id, llvm::Type * const type, const unsigned reserved, const String * const name, Allocator & allocator)
245    : PabloAST(id, type, allocator)
246    , mOperands(0)
247    , mOperand(allocator.allocate(mOperands))
248    , mNext(nullptr)
249    , mPrev(nullptr)
250    , mName(name)
251    , mParent(nullptr) {
252        std::memset(mOperand, 0, reserved * sizeof(PabloAST *));
253    }
254
255    template<typename iterator>
256    explicit Statement(const ClassTypeId id, llvm::Type * const type, iterator begin, iterator end, const String * const name, Allocator & allocator)
257    : PabloAST(id, type, allocator)
258    , mOperands(std::distance(begin, end))
259    , mOperand(allocator.allocate(mOperands))
260    , mNext(nullptr)
261    , mPrev(nullptr)
262    , mName(name)
263    , mParent(nullptr) {
264        unsigned i = 0;
265        for (auto value = begin; value != end; ++value, ++i) {
266            assert (*value);
267            mOperand[i] = *value;
268            (*value)->addUser(this);
269        }
270    }
271
272protected:   
273    unsigned        mOperands;
274    PabloAST **     mOperand;
275    Statement *     mNext;
276    Statement *     mPrev;
277    const String *  mName;
278    PabloBlock *    mParent;
279};
280
281class Variadic : public Statement {
282public:
283
284    static inline bool classof(const PabloAST * e) {
285        switch (e->getClassTypeId()) {
286            case PabloAST::ClassTypeId::And:
287            case PabloAST::ClassTypeId::Or:
288            case PabloAST::ClassTypeId::Xor:
289                return true;
290            default: return false;
291        }
292    }
293    static inline bool classof(const Variadic *) {
294        return true;
295    }
296    static inline bool classof(const void *) {
297        return false;
298    }
299
300    class iterator : public boost::iterator_facade<iterator, PabloAST *, boost::random_access_traversal_tag> {
301        friend class Variadic;
302        friend class boost::iterator_core_access;
303    protected:
304
305        iterator(PabloAST ** pointer) : mCurrent(pointer) { }
306        inline void increment() { ++mCurrent; }
307        inline void decrement() { --mCurrent; }
308        inline void advance(const std::ptrdiff_t n) { mCurrent += n; }
309        inline std::ptrdiff_t distance_to(const iterator & other) const { return other.mCurrent - mCurrent; }
310        inline PabloAST *& dereference() const { return *mCurrent; }
311
312        inline bool equal(const iterator & other) const { return (mCurrent == other.mCurrent); }
313
314    private:
315        PabloAST **        mCurrent;
316    };
317
318    using const_iterator = iterator;
319
320    void addOperand(PabloAST * const expr);
321
322    PabloAST * removeOperand(const unsigned index);
323
324    bool deleteOperand(const PabloAST * const expr);
325
326    iterator begin() {
327        return iterator(mOperand);
328    }
329
330    const_iterator begin() const {
331        return iterator(mOperand);
332    }
333
334    iterator end() {
335        return iterator(mOperand + mOperands);
336    }
337
338    const_iterator end() const {
339        return iterator(mOperand + mOperands);
340    }
341
342protected:
343    explicit Variadic(const ClassTypeId id, llvm::Type * const type, std::initializer_list<PabloAST *> operands, const String * const name, Allocator & allocator)
344    : Statement(id, type, operands, name, allocator)
345    , mCapacity(operands.size())
346    , mAllocator(allocator) {
347
348    }
349    explicit Variadic(const ClassTypeId id, llvm::Type * const type, const unsigned reserved, const String * name, Allocator & allocator)
350    : Statement(id, type, reserved, name, allocator)
351    , mCapacity(reserved)
352    , mAllocator(allocator) {
353
354    }
355    template<typename iterator>
356    explicit Variadic(const ClassTypeId id, llvm::Type * const type, iterator begin, iterator end, const String * name, Allocator & allocator)
357    : Statement(id, type, begin, end, name, allocator)
358    , mCapacity(std::distance(begin, end))
359    , mAllocator(allocator) {
360
361    }
362private:
363    unsigned        mCapacity;
364    Allocator &     mAllocator;
365};
366
367class StatementList {
368    friend class Statement;
369    friend class PabloBlock;
370public:
371    class iterator: public std::iterator<std::forward_iterator_tag, Statement> {
372    public:
373        iterator(): mCurrent(nullptr) {}
374
375        iterator(Statement* base): mCurrent(base) {}
376
377        iterator(const iterator& other): mCurrent(other.mCurrent) {}
378
379        const iterator& operator=(const iterator& other) {
380            mCurrent = other.mCurrent; return other;
381        }
382
383        inline iterator& operator++() {
384            assert (mCurrent);
385            mCurrent = mCurrent->mNext;
386            return *this;
387        }
388
389        iterator  operator++(int) {
390            iterator tmp(*this);
391            ++(*this);
392            return tmp;
393        }
394
395        bool operator==(const iterator& other) const {
396            return  mCurrent == other.mCurrent;
397        }
398
399        bool operator!=(const iterator& other) const {
400            return  mCurrent != other.mCurrent;
401        }
402
403        Statement* operator*() {return mCurrent;}
404        Statement* operator->(){return mCurrent;}
405
406    private:
407        Statement * mCurrent;
408        friend class const_iterator;
409    };
410
411    class const_iterator: public std::iterator<std::forward_iterator_tag, Statement> {
412    public:
413        const_iterator(): mCurrent(nullptr) {}
414        const_iterator(const Statement* base): mCurrent(base) {}
415        const_iterator(const const_iterator& other): mCurrent(other.mCurrent) {}
416        const const_iterator& operator=(const const_iterator& other) {mCurrent = other.mCurrent; return other;}
417
418        inline const_iterator& operator++() {
419            assert (mCurrent);
420            mCurrent = mCurrent->mNext;
421            return *this;
422        }
423
424        const_iterator  operator++(int) {
425            const_iterator tmp(*this);
426            ++(*this);
427            return tmp;
428        }
429
430        bool operator==(const const_iterator & other) const {
431            return  mCurrent == other.mCurrent;
432        }
433        bool operator!=(const const_iterator & other) const {
434            return  mCurrent != other.mCurrent;
435        }
436
437        const Statement* operator*() {return mCurrent;}
438        const Statement* operator->(){return mCurrent;}
439
440    private:
441        const Statement * mCurrent;
442        friend struct iterator;
443    };
444
445    class reverse_iterator: public std::iterator<std::forward_iterator_tag, Statement> {
446    public:
447        reverse_iterator(): mCurrent(nullptr) {}
448
449        reverse_iterator(Statement* base): mCurrent(base) {}
450
451        reverse_iterator(const reverse_iterator& other): mCurrent(other.mCurrent) {}
452
453        const reverse_iterator& operator=(const reverse_iterator& other) {
454            mCurrent = other.mCurrent; return other;
455        }
456
457        inline reverse_iterator& operator++() {
458            assert (mCurrent);
459            mCurrent = mCurrent->mPrev;
460            return *this;
461        }
462
463        reverse_iterator operator++(int) {
464            reverse_iterator tmp(*this);
465            ++(*this);
466            return tmp;
467        }
468
469        bool operator==(const reverse_iterator& other) const {
470            return  mCurrent == other.mCurrent;
471        }
472
473        bool operator!=(const reverse_iterator& other) const {
474            return  mCurrent != other.mCurrent;
475        }
476
477        Statement* operator*() {return mCurrent;}
478        Statement* operator->(){return mCurrent;}
479
480    private:
481        Statement * mCurrent;
482        friend class const_reverse_iterator;
483    };
484
485    class const_reverse_iterator: public std::iterator<std::forward_iterator_tag, Statement> {
486    public:
487        const_reverse_iterator(): mCurrent(nullptr) {}
488        const_reverse_iterator(const Statement* base): mCurrent(base) {}
489        const_reverse_iterator(const const_reverse_iterator& other): mCurrent(other.mCurrent) {}
490        const const_reverse_iterator& operator=(const const_reverse_iterator& other) {mCurrent = other.mCurrent; return other;}
491
492        inline const_reverse_iterator& operator++() {
493            assert (mCurrent);
494            mCurrent = mCurrent->mPrev;
495            return *this;
496        }
497
498        const_reverse_iterator  operator++(int) {
499            const_reverse_iterator tmp(*this);
500            ++(*this);
501            return tmp;
502        }
503
504        bool operator==(const const_reverse_iterator & other) const {
505            return  mCurrent == other.mCurrent;
506        }
507        bool operator!=(const const_reverse_iterator & other) const {
508            return  mCurrent != other.mCurrent;
509        }
510
511        const Statement* operator*() {return mCurrent;}
512        const Statement* operator->(){return mCurrent;}
513
514    private:
515        const Statement * mCurrent;
516        friend struct iterator;
517    };
518
519public:
520
521    StatementList()
522    : mInsertionPoint(nullptr)
523    , mFirst(nullptr)
524    , mLast(nullptr) {
525
526    }
527
528    StatementList(StatementList && other)
529    : mInsertionPoint(nullptr)
530    , mFirst(other.mFirst)
531    , mLast(other.mLast) {
532        other.mInsertionPoint = nullptr;
533        other.mFirst = nullptr;
534        other.mLast = nullptr;
535    }
536
537    iterator begin() {
538        return iterator(mFirst);
539    }
540
541    iterator end() {
542        return iterator(nullptr);
543    }
544
545    reverse_iterator rbegin() {
546        return reverse_iterator(mLast);
547    }
548
549    reverse_iterator rend() {
550        return reverse_iterator(nullptr);
551    }
552
553    const_iterator begin() const {
554        return const_iterator(mFirst);
555    }
556
557    const_iterator end() const {
558        return const_iterator(nullptr);
559    }
560
561    const_reverse_iterator rbegin() const {
562        return const_reverse_iterator(mLast);
563    }
564
565    const_reverse_iterator rend() const {
566        return const_reverse_iterator(nullptr);
567    }
568
569    const_iterator cbegin() const {
570        return const_iterator(mFirst);
571    }
572
573    const_iterator cend() const {
574        return const_iterator(nullptr);
575    }
576
577    const_reverse_iterator crbegin() const {
578        return const_reverse_iterator(mLast);
579    }
580
581    const_reverse_iterator crend() const {
582        return const_reverse_iterator(nullptr);
583    }
584
585    inline Statement * front() const {
586        return mFirst;
587    }
588
589    inline Statement * back() const {
590        return mLast;
591    }
592
593    inline void setInsertPoint(Statement * const statement) {
594        assert (statement == nullptr || contains(statement));
595        mInsertionPoint = statement;
596    }
597
598    inline Statement * getInsertPoint() const {
599        return mInsertionPoint;
600    }
601
602    bool contains(Statement * const statement);
603
604protected:
605
606    ~StatementList() = default;
607
608private:
609
610    Statement   * mInsertionPoint;
611    Statement   * mFirst;
612    Statement   * mLast;   
613};
614
615/** ------------------------------------------------------------------------------------------------------------- *
616 * @brief deleteOperand
617 ** ------------------------------------------------------------------------------------------------------------- */
618inline bool Variadic::deleteOperand(const PabloAST * const expr) {
619    for (unsigned i = 0; i != getNumOperands(); ++i) {
620        if (LLVM_UNLIKELY(getOperand(i) == expr)) {
621            removeOperand(i);
622            return true;
623        }
624    }
625    return false;
626}
627
628}
629
630#endif // PE_PabloAST_H
Note: See TracBrowser for help on using the repository browser.