source: icGREP/icgrep-devel/icgrep/IR_Gen/CBuilder.h @ 5463

Last change on this file since 5463 was 5440, checked in by nmedfort, 2 years ago

Large refactoring step. Removed IR generation code from Kernel (formally KernelBuilder?) and moved it into the new KernelBuilder? class.

File size: 9.0 KB
Line 
1/*
2 *  Copyright (c) 2016 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 */
5#ifndef CBUILDER_H
6#define CBUILDER_H
7
8#include <IR_Gen/FunctionTypeBuilder.h>
9#include <llvm/IR/IRBuilder.h>
10#include <llvm/IR/Constants.h>
11#include <llvm/ADT/Triple.h>
12#ifndef NDEBUG
13#include <llvm/IR/Function.h>
14#endif
15
16namespace kernels { class KernelBuilder; }
17namespace llvm { class Function; }
18namespace llvm { class IntegerType; }
19namespace llvm { class Module; }
20namespace llvm { class PointerType; }
21namespace llvm { class Type; }
22namespace llvm { class Value; }
23
24class ParabixDriver;
25
26class CBuilder : public llvm::IRBuilder<> {
27    friend class ParabixDriver;
28public:
29
30    CBuilder(llvm::LLVMContext & C, const unsigned GeneralRegisterWidthInBits);
31   
32    virtual ~CBuilder() {}
33
34    llvm::Module * getModule() const {
35        #ifndef NDEBUG
36        llvm::BasicBlock * const bb = GetInsertBlock();
37        if (bb) {
38            llvm::Function * const f = bb->getParent();
39            assert ("CBuilder has an insert point that is not contained within a Function" && f);
40            assert ("CBuilder module differs from insertion point module" && (mModule == f->getParent()));
41        }
42        #endif
43        return mModule;
44    }
45
46    void setModule(llvm::Module * module) {
47        mModule = module;
48        ClearInsertionPoint();
49    }
50
51    llvm::Value * CreateMalloc(llvm::Value * size);
52
53    llvm::Value * CreateAlignedMalloc(llvm::Value * size, const unsigned alignment);
54   
55    void CreateFree(llvm::Value * const ptr);
56   
57    void CreateAlignedFree(llvm::Value * const ptr, const bool testForNullAddress = false);
58   
59    llvm::Value * CreateRealloc(llvm::Value * ptr, llvm::Value * size);
60
61    llvm::CallInst * CreateMemZero(llvm::Value * ptr, llvm::Value * size, const unsigned alignment = 1) {
62        return CreateMemSet(ptr, getInt8(0), size, alignment);
63    }
64
65    llvm::AllocaInst * CreateCacheAlignedAlloca(llvm::Type * Ty, llvm::Value * ArraySize = nullptr) {
66        llvm::AllocaInst * instr = CreateAlloca(Ty, ArraySize);
67        instr->setAlignment(getCacheAlignment());
68        return instr;
69    }
70
71    // stdio.h functions
72    //
73    //  Create a call to:  FILE * fopen(const char *filename, const char *mode);
74    llvm::Value * CreateFOpenCall(llvm::Value * filename, llvm::Value * mode);
75    //  Create a call to:  size_t fread(void *ptr, size_t size, size_t nitems, FILE *stream);
76    llvm::Value * CreateFReadCall(llvm::Value * ptr, llvm::Value * size, llvm::Value * nitems, llvm::Value * stream);
77    //  Create a call to:  size_t fwrite(const void *ptr, size_t size, size_t nitems, FILE *stream));
78    llvm::Value * CreateFWriteCall(llvm::Value * ptr, llvm::Value * size, llvm::Value * nitems, llvm::Value * stream);
79    //  Create a call to:  int fclose ( FILE * stream );
80    llvm::Value * CreateFCloseCall(llvm::Value * stream);
81    //  Create a call to:  int remove(const char *path);
82    llvm::Value * CreateRemoveCall(llvm::Value * path);
83   
84    //  Create a call to:  int rename(const char *old, const char *new);
85    llvm::Value * CreateRenameCall(llvm::Value * oldName, llvm::Value * newName);
86   
87    llvm::Function * GetPrintf();
88
89    llvm::Function * GetDprintf();
90
91    //  Create calls to unistd.h functions.
92    //
93    //  Create a call to:  int open(const char *filename, int oflag, ...);
94    llvm::Value * CreateOpenCall(llvm::Value * filename, llvm::Value * oflag, llvm::Value * mode);
95    //  Create a call to:  ssize_t write(int fildes, const void *buf, size_t nbyte);
96    llvm::Value * CreateWriteCall(llvm::Value * fileDescriptor, llvm::Value * buf, llvm::Value * nbyte);
97    //  Create a call to:  ssize_t read(int fildes, void *buf, size_t nbyte);
98    llvm::Value * CreateReadCall(llvm::Value * fileDescriptor, llvm::Value * buf, llvm::Value * nbyte);
99    //  Create a call to:  int close(int filedes);
100    llvm::Value * CreateCloseCall(llvm::Value * fileDescriptor);
101    //  Create a call to:  int unlink(const char *path);
102    llvm::Value * CreateUnlinkCall(llvm::Value * path);
103
104    llvm::Value * CreateFileSize(llvm::Value * fileDescriptor);
105
106    //  Create calls to stdlib.h functions.
107    //
108    //  Create a call to:  int mkstemp (char *template);
109    llvm::Value * CreateMkstempCall(llvm::Value * ftemplate);
110   
111    //  Create a call to:  size_t strlen(const char *str);
112    llvm::Value * CreateStrlenCall(llvm::Value * str);
113   
114    llvm::Value * CreateAnonymousMMap(llvm::Value * size);
115
116    llvm::Value * CreateFileSourceMMap(llvm::Value * fd, llvm::Value * size);
117
118    enum Advice {
119        ADVICE_NORMAL
120        , ADVICE_RANDOM
121        , ADVICE_SEQUENTIAL
122        , ADVICE_WILLNEED
123        , ADVICE_DONTNEED
124    };
125
126    llvm::Value * CreateMAdvise(llvm::Value * addr, llvm::Value * length, Advice advice);
127
128    llvm::Value * CreateMMap(llvm::Value * const addr, llvm::Value * size, llvm::Value * const prot, llvm::Value * const flags, llvm::Value * const fd, llvm::Value * const offset);
129
130    llvm::Value * CheckMMapSuccess(llvm::Value * const addr);
131
132    llvm::Value * CreateMRemap(llvm::Value * addr, llvm::Value * oldSize, llvm::Value * newSize);
133
134    llvm::Value * CreateMUnmap(llvm::Value * addr, llvm::Value * size);
135
136    //  Posix thread (pthread.h) functions.
137    //
138    //  Create a call to:  int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
139    //                    void *(*start_routine)(void*), void *arg);
140    llvm::Value * CreatePThreadCreateCall(llvm::Value * thread, llvm::Value * attr, llvm::Function * start_routine, llvm::Value * arg);
141   
142    //  Create a call to:  void pthread_exit(void *value_ptr);
143    llvm::Value * CreatePThreadExitCall(llvm::Value * value_ptr);
144   
145    //  Create a call to:  int pthread_join(pthread_t thread, void **value_ptr);
146    llvm::Value * CreatePThreadJoinCall(llvm::Value * thread, llvm::Value * value_ptr);
147   
148    void CallPrintInt(const std::string & name, llvm::Value * const value);
149   
150    void CallPrintIntToStderr(const std::string & name, llvm::Value * const value);
151   
152    llvm::Value * GetString(llvm::StringRef Str);
153   
154    void CallPrintMsgToStderr(const std::string & message);
155
156    inline llvm::IntegerType * getSizeTy() const {
157        assert (mSizeType);
158        return mSizeType;
159    }
160   
161    inline llvm::ConstantInt * getSize(const size_t value) {
162        return llvm::ConstantInt::get(getSizeTy(), value);
163    }
164   
165    llvm::PointerType * getVoidPtrTy() const;
166
167    llvm::PointerType * getFILEptrTy();
168   
169    inline unsigned getCacheAlignment() const {
170        return mCacheLineAlignment;
171    }
172   
173    virtual llvm::LoadInst* CreateAtomicLoadAcquire(llvm::Value * ptr);
174
175    virtual llvm::StoreInst *  CreateAtomicStoreRelease(llvm::Value * val, llvm::Value * ptr);
176
177    void CreateAssert(llvm::Value * assertion, llvm::StringRef failureMessage);
178
179    void CreateExit(const int exitCode);
180
181    llvm::BranchInst * CreateLikelyCondBr(llvm::Value * Cond, llvm::BasicBlock * True, llvm::BasicBlock * False, const int probability = 90);
182
183    llvm::BranchInst * CreateUnlikelyCondBr(llvm::Value * Cond, llvm::BasicBlock * True, llvm::BasicBlock * False, const int probability = 90) {
184        return CreateLikelyCondBr(Cond, True, False, 100 - probability);
185    }
186
187    llvm::BasicBlock * CreateBasicBlock(std::string && name);
188
189    virtual bool supportsIndirectBr() const {
190        return true;
191    }
192
193    llvm::Value * CreatePopcount(llvm::Value * bits);
194
195    llvm::Value * CreateCountForwardZeroes(llvm::Value * value);
196
197    llvm::Value * CreateCountReverseZeroes(llvm::Value * value);
198   
199    // Useful bit manipulation operations 
200    llvm::Value * CreateResetLowestBit(llvm::Value * bits);   
201   
202    llvm::Value * CreateIsolateLowestBit(llvm::Value * bits);
203   
204    llvm::Value * CreateMaskToLowestBitInclusive(llvm::Value * bits);
205   
206    llvm::Value * CreateMaskToLowestBitExclusive(llvm::Value * bits);
207   
208    llvm::Value * CreateExtractBitField(llvm::Value * bits, llvm::Value * start, llvm::Value * length);
209   
210    llvm::Value * CreateCeilLog2(llvm::Value * value);
211   
212    llvm::Value * CreateReadCycleCounter();
213
214    template <typename ExternalFunctionType>
215    llvm::Function * LinkFunction(llvm::StringRef name, ExternalFunctionType * functionPtr) const;
216
217protected:
218
219    llvm::Function * LinkFunction(llvm::StringRef name, llvm::FunctionType * type, void * functionPtr) const;
220
221    void setDriver(ParabixDriver * driver) {
222        mDriver = driver;
223    }
224
225protected:
226
227    llvm::Module *                  mModule;
228    unsigned                        mCacheLineAlignment;
229    llvm::IntegerType *             mSizeType;
230    llvm::StructType *              mFILEtype;
231    ParabixDriver *                 mDriver;
232    llvm::LLVMContext               mContext;
233    const std::string               mTriple;
234};
235
236template <typename ExternalFunctionType>
237llvm::Function *CBuilder::LinkFunction(llvm::StringRef name, ExternalFunctionType * functionPtr) const {
238    llvm::FunctionType * const type = FunctionTypeBuilder<ExternalFunctionType>::get(getContext());
239    assert ("FunctionTypeBuilder did not resolve a function type." && type);
240    return LinkFunction(name, type, reinterpret_cast<void *>(functionPtr));
241}
242
243#endif
Note: See TracBrowser for help on using the repository browser.