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

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

Cleaned up memory leaks + some warning messages.

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