source: icGREP/icgrep-devel/icgrep/pablo/pablo_compiler.h @ 4532

Last change on this file since 4532 was 4516, checked in by nmedfort, 4 years ago

More memory leak fixes. All known leaks accounted for.

File size: 5.2 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 PABLO_COMPILER_H
8#define PABLO_COMPILER_H
9
10//indicates that we use llvm.uadd.with.overflow.carryin for genAddWithCarry
11//#define USE_UADD_OVERFLOW
12//#define USE_LONG_INTEGER_SHIFT
13//#define USE_TWO_UADD_OVERFLOW
14
15#if defined(USE_TWO_UADD_OVERFLOW) && !defined(USE_UADD_OVERFLOW)
16static_assert(false, "Need to turn on them together.");
17#endif
18
19//Pablo Expressions
20#include <string>
21#include <list>
22#include <vector>
23#include <map>
24#include <algorithm>
25#include <unordered_map>
26#include <pablo/pe_string.h>
27#include <llvm/ADT/Twine.h>
28
29namespace llvm {
30    class Value;
31    class Module;
32    class ExecutionEngine;
33    class VectorType;
34    class PointerType;
35    class ConstantAggregateZero;
36    class Constant;
37    class FunctionType;
38    class Function;
39    class BasicBlock;
40}
41
42namespace pablo {
43
44using namespace llvm;
45
46class PabloAST;
47class PabloBlock;
48class String;
49class Var;
50class Statement;
51class StatementList;
52
53struct CompiledPabloFunction {
54    const unsigned      CarryQueueSize;
55    const unsigned      AdvanceQueueSize;
56    void * const        FunctionPointer;
57private:
58    Function *          mFunction;
59    ExecutionEngine *   mExecutionEngine;
60public:
61    CompiledPabloFunction(unsigned carryQSize, unsigned advanceQSize, Function * function, ExecutionEngine * executionEngine);
62
63    inline CompiledPabloFunction(CompiledPabloFunction && cpf)
64    : CarryQueueSize(cpf.CarryQueueSize)
65    , AdvanceQueueSize(cpf.AdvanceQueueSize)
66    , FunctionPointer(cpf.FunctionPointer)
67    , mFunction(cpf.mFunction)
68    , mExecutionEngine(cpf.mExecutionEngine)
69    {
70        cpf.mFunction = nullptr;
71        cpf.mExecutionEngine = nullptr;
72    }
73
74    ~CompiledPabloFunction();
75
76};
77
78class PabloCompiler {
79    #ifdef USE_UADD_OVERFLOW
80    struct SumWithOverflowPack {
81        Value * sum;
82        Value * obit;
83    };
84    #endif
85
86    typedef std::unordered_map<const pablo::PabloAST *, Value*>    ASTToValueMap;
87    typedef std::unordered_map<const pablo::String *, Value*>      StringToValueMap;
88    typedef std::vector<Value*>                                    CarryQueueVector;
89
90public:
91    PabloCompiler(const std::vector<Var *> & basisBitVars);
92    ~PabloCompiler();
93    void InstallExternalFunction(std::string C_fn_name, void * fn_ptr);
94    CompiledPabloFunction compile(PabloBlock & pb);
95private:
96    void DefineTypes();
97    void DeclareFunctions();
98    void Examine(StatementList & stmts);
99    void DeclareCallFunctions();
100    void SetOutputValue(Value * marker, const unsigned index);
101
102    void compileStatements(const StatementList & stmts);
103    void compileStatement(const Statement * stmt);
104    Value* compileExpression(const PabloAST * expr);
105    Value* genCarryInLoad(const unsigned index);
106    void   genCarryOutStore(Value* carryOut, const unsigned index);
107    Value* genAdvanceInLoad(const unsigned index);
108    void   genAdvanceOutStore(Value* advanceOut, const unsigned index);
109    Value* genAddWithCarry(Value* e1, Value* e2);
110    Value* genAdvanceWithCarry(Value* e1, int shift_amount);
111    Value* genBitBlockAny(Value* test);
112    Value* genShiftHighbitToLow(Value* e, const Twine & namehint = "");
113    Value* genShiftLeft64(Value* e, const Twine & namehint = "") ;
114    Value* genNot(Value* expr);
115
116    #ifdef USE_UADD_OVERFLOW
117    #ifdef USE_TWO_UADD_OVERFLOW
118    Function* mFunctionUaddOverflow;
119    SumWithOverflowPack callUaddOverflow(Value *e1, Value *e2);
120    #else
121    Function* mFunctionUaddOverflowCarryin;
122    SumWithOverflowPack callUaddOverflow(Value *e1, Value *e2, Value *cin);
123    #endif
124    #endif
125
126
127    ASTToValueMap                       mMarkerMap;
128    CarryQueueVector                    mCarryQueueVector;
129    std::vector<int>                    mCarryQueueSummaryIdx;
130    CarryQueueVector                    mAdvanceQueueVector;
131    std::vector<int>                    mAdvanceQueueSummaryIdx;
132
133    const std::vector<Var *> &          mBasisBits;
134
135    Module* const                       mMod;
136    BasicBlock*                         mBasicBlock;
137    ExecutionEngine*                    mExecutionEngine;
138
139    VectorType* const                   mBitBlockType;
140    PointerType*                        mBasisBitsInputPtr;
141
142    unsigned                            mCarryQueueIdx;
143    Value*                              mCarryQueuePtr;
144    unsigned                            mNestingDepth;
145    unsigned                            mCarryQueueSize;
146
147    unsigned                            mAdvanceQueueIdx;
148    Value*                              mAdvanceQueuePtr;
149    unsigned                            mAdvanceQueueSize;
150
151    ConstantAggregateZero* const        mZeroInitializer;
152    Constant* const                     mOneInitializer;
153
154    FunctionType*                       mFunctionType;
155    Function*                           mFunction;
156
157
158    Value*                              mBasisBitsAddr;
159    Value*                              mOutputAddrPtr;
160
161    unsigned                            mMaxNestingDepth;
162
163    std::map<std::string, void *>       mExternalMap;
164    StringToValueMap                    mCalleeMap;
165
166    Constant *                          mPrintRegisterFunction;
167};
168
169}
170
171#endif // LLVM_GENERATOR_H
Note: See TracBrowser for help on using the repository browser.