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

Last change on this file since 5675 was 5675, checked in by cameron, 2 years ago

getIntAddrTy()

File size: 13.2 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 Driver;
25
26class CBuilder : public llvm::IRBuilder<> {
27    using Predicate = llvm::CmpInst::Predicate;
28public:
29
30    CBuilder(llvm::LLVMContext & C);
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    // UDiv and URem with optimization for division by power-of-2 constants
52    llvm::Value * CreateUDiv(llvm::Value * number, llvm::Value * divisor, const llvm::Twine &Name = "");
53    llvm::Value * CreateURem(llvm::Value * number, llvm::Value * divisor, const llvm::Twine &Name = "");
54
55    // Division with rounding up to the ceiling
56    // Equivalent to CreateUDiv(CreateAdd(number, CreateSub(divisor, ConstantInt::get(divisor->getType(), 1))), divisor)
57    llvm::Value * CreateUDivCeil(llvm::Value * number, llvm::Value * divisor, const llvm::Twine &Name = "");
58   
59    // Round up to a multiple of divisor.
60    llvm::Value * CreateRoundUp(llvm::Value * number, llvm::Value * divisor, const llvm::Twine &Name = "");
61           
62    llvm::Value * CreateMalloc(llvm::Value * size);
63
64    llvm::Value * CreateAlignedMalloc(llvm::Value * size, const unsigned alignment);
65   
66    void CreateFree(llvm::Value * const ptr);
67
68    llvm::Value * CreateRealloc(llvm::Value * ptr, llvm::Value * size);
69
70    llvm::CallInst * CreateMemZero(llvm::Value * ptr, llvm::Value * size, const unsigned alignment = 1) {
71        return CreateMemSet(ptr, getInt8(0), size, alignment);
72    }
73
74    llvm::AllocaInst * CreateCacheAlignedAlloca(llvm::Type * Ty, llvm::Value * ArraySize = nullptr) {
75        llvm::AllocaInst * instr = CreateAlloca(Ty, ArraySize);
76        instr->setAlignment(getCacheAlignment());
77        return instr;
78    }
79
80    llvm::Value * CreateCacheAlignedMalloc(llvm::Value * size);
81
82    // stdio.h functions
83    //
84    //  Create a call to:  FILE * fopen(const char *filename, const char *mode);
85    llvm::Value * CreateFOpenCall(llvm::Value * filename, llvm::Value * mode);
86    //  Create a call to:  size_t fread(void *ptr, size_t size, size_t nitems, FILE *stream);
87    llvm::Value * CreateFReadCall(llvm::Value * ptr, llvm::Value * size, llvm::Value * nitems, llvm::Value * stream);
88    //  Create a call to:  size_t fwrite(const void *ptr, size_t size, size_t nitems, FILE *stream));
89    llvm::Value * CreateFWriteCall(llvm::Value * ptr, llvm::Value * size, llvm::Value * nitems, llvm::Value * stream);
90    //  Create a call to:  int fclose ( FILE * stream );
91    llvm::Value * CreateFCloseCall(llvm::Value * stream);
92    //  Create a call to:  int remove(const char *path);
93    llvm::Value * CreateRemoveCall(llvm::Value * path);
94   
95    //  Create a call to:  int rename(const char *old, const char *new);
96    llvm::Value * CreateRenameCall(llvm::Value * oldName, llvm::Value * newName);
97   
98    llvm::Function * GetPrintf();
99
100    llvm::Function * GetDprintf();
101
102    //  Create calls to unistd.h functions.
103    //
104    //  Create a call to:  int open(const char *filename, int oflag, ...);
105    llvm::Value * CreateOpenCall(llvm::Value * filename, llvm::Value * oflag, llvm::Value * mode);
106    //  Create a call to:  ssize_t write(int fildes, const void *buf, size_t nbyte);
107    llvm::Value * CreateWriteCall(llvm::Value * fileDescriptor, llvm::Value * buf, llvm::Value * nbyte);
108    //  Create a call to:  ssize_t read(int fildes, void *buf, size_t nbyte);
109    llvm::Value * CreateReadCall(llvm::Value * fileDescriptor, llvm::Value * buf, llvm::Value * nbyte);
110    //  Create a call to:  int close(int filedes);
111    llvm::Value * CreateCloseCall(llvm::Value * fileDescriptor);
112    //  Create a call to:  int unlink(const char *path);
113    llvm::Value * CreateUnlinkCall(llvm::Value * path);
114
115    llvm::Value * CreateFileSize(llvm::Value * fileDescriptor);
116
117    //  Create calls to stdlib.h functions.
118    //
119    //  Create a call to:  int mkstemp (char *template);
120    llvm::Value * CreateMkstempCall(llvm::Value * ftemplate);
121   
122    //  Create a call to:  size_t strlen(const char *str);
123    llvm::Value * CreateStrlenCall(llvm::Value * str);
124   
125    llvm::Value * CreateAnonymousMMap(llvm::Value * size);
126
127    llvm::Value * CreateFileSourceMMap(llvm::Value * fd, llvm::Value * size);
128
129    enum Advice {
130        ADVICE_NORMAL
131        , ADVICE_RANDOM
132        , ADVICE_SEQUENTIAL
133        , ADVICE_WILLNEED
134        , ADVICE_DONTNEED
135    };
136
137    llvm::Value * CreateMAdvise(llvm::Value * addr, llvm::Value * length, Advice advice);
138
139    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);
140
141    llvm::Value * CreateMRemap(llvm::Value * addr, llvm::Value * oldSize, llvm::Value * newSize);
142
143    llvm::Value * CreateMUnmap(llvm::Value * addr, llvm::Value * size);
144
145    //  Posix thread (pthread.h) functions.
146    //
147    //  Create a call to:  int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
148    //                    void *(*start_routine)(void*), void *arg);
149    llvm::Value * CreatePThreadCreateCall(llvm::Value * thread, llvm::Value * attr, llvm::Function * start_routine, llvm::Value * arg);
150
151    //  Create a call to:  int pthread_yield(void);
152    llvm::Value * CreatePThreadYield();
153   
154    //  Create a call to:  void pthread_exit(void *value_ptr);
155    llvm::Value * CreatePThreadExitCall(llvm::Value * value_ptr);
156   
157    //  Create a call to:  int pthread_join(pthread_t thread, void **value_ptr);
158    llvm::Value * CreatePThreadJoinCall(llvm::Value * thread, llvm::Value * value_ptr);
159   
160    void CallPrintInt(const std::string & name, llvm::Value * const value);
161   
162    void CallPrintIntToStderr(const std::string & name, llvm::Value * const value);
163   
164    llvm::Value * GetString(llvm::StringRef Str);
165   
166    void CallPrintMsgToStderr(const std::string & message);
167
168    inline llvm::IntegerType * getSizeTy() const {
169        assert (mSizeType);
170        return mSizeType;
171    }
172   
173    inline llvm::ConstantInt * getSize(const size_t value) {
174        return llvm::ConstantInt::get(getSizeTy(), value);
175    }
176   
177    llvm::IntegerType * getIntAddrTy() const;
178   
179    llvm::PointerType * getVoidPtrTy() const;
180   
181    llvm::PointerType * getFILEptrTy();
182   
183    inline unsigned getCacheAlignment() const {
184        return mCacheLineAlignment;
185    }
186   
187    virtual llvm::LoadInst* CreateAtomicLoadAcquire(llvm::Value * ptr);
188
189    virtual llvm::StoreInst *  CreateAtomicStoreRelease(llvm::Value * val, llvm::Value * ptr);
190
191    void CreateAssert(llvm::Value * assertion, llvm::StringRef failureMessage) {
192        if (LLVM_UNLIKELY(assertion->getType()->isVectorTy())) {
193            assertion = CreateBitCast(assertion, getIntNTy(assertion->getType()->getPrimitiveSizeInBits()));
194        }
195        return __CreateAssert(CreateIsNotNull(assertion), failureMessage);
196    }
197
198    void CreateAssertZero(llvm::Value * assertion, llvm::StringRef failureMessage) {
199        if (LLVM_UNLIKELY(assertion->getType()->isVectorTy())) {
200            assertion = CreateBitCast(assertion, getIntNTy(assertion->getType()->getPrimitiveSizeInBits()));
201        }
202        return __CreateAssert(CreateIsNull(assertion), failureMessage);
203    }
204
205    void CreateExit(const int exitCode);
206
207    llvm::BranchInst * CreateLikelyCondBr(llvm::Value * Cond, llvm::BasicBlock * True, llvm::BasicBlock * False, const int probability = 90);
208
209    llvm::BranchInst * CreateUnlikelyCondBr(llvm::Value * Cond, llvm::BasicBlock * True, llvm::BasicBlock * False, const int probability = 90) {
210        return CreateLikelyCondBr(Cond, True, False, 100 - probability);
211    }
212
213    llvm::BasicBlock * CreateBasicBlock(std::string && name);
214
215    virtual bool supportsIndirectBr() const {
216        return true;
217    }
218
219    llvm::Value * CreatePopcount(llvm::Value * bits);
220
221    llvm::Value * CreateCountForwardZeroes(llvm::Value * value, const bool isZeroUndefined = false);
222
223    llvm::Value * CreateCountReverseZeroes(llvm::Value * value, const bool isZeroUndefined = false);
224   
225    // Useful bit manipulation operations 
226    llvm::Value * CreateResetLowestBit(llvm::Value * bits);   
227   
228    llvm::Value * CreateIsolateLowestBit(llvm::Value * bits);
229   
230    llvm::Value * CreateMaskToLowestBitInclusive(llvm::Value * bits);
231   
232    llvm::Value * CreateMaskToLowestBitExclusive(llvm::Value * bits);
233   
234    llvm::Value * CreateExtractBitField(llvm::Value * bits, llvm::Value * start, llvm::Value * length);
235   
236    llvm::Value * CreateCeilLog2(llvm::Value * value);
237   
238    llvm::Value * CreateReadCycleCounter();
239
240    template <typename ExternalFunctionType>
241    llvm::Function * LinkFunction(llvm::StringRef name, ExternalFunctionType * functionPtr) const;
242
243
244    virtual llvm::LoadInst * CreateLoad(llvm::Value * Ptr, const char * Name);
245
246    virtual llvm::LoadInst * CreateLoad(llvm::Value * Ptr, const llvm::Twine & Name = "");
247
248    virtual llvm::LoadInst * CreateLoad(llvm::Type * Ty, llvm::Value * Ptr, const llvm::Twine & Name = "");
249
250    virtual llvm::LoadInst * CreateLoad(llvm::Value * Ptr, bool isVolatile, const llvm::Twine & Name = "");
251
252    virtual llvm::StoreInst * CreateStore(llvm::Value * Val, llvm::Value * Ptr, bool isVolatile = false);
253
254    llvm::LoadInst * CreateAlignedLoad(llvm::Value * Ptr, unsigned Align, const char * Name);
255
256    llvm::LoadInst * CreateAlignedLoad(llvm::Value * Ptr, unsigned Align, const llvm::Twine & Name = "");
257
258    llvm::LoadInst * CreateAlignedLoad(llvm::Value * Ptr, unsigned Align, bool isVolatile, const llvm::Twine & Name = "");
259
260    llvm::StoreInst * CreateAlignedStore(llvm::Value * Val, llvm::Value * Ptr, unsigned Align, bool isVolatile = false);
261
262    llvm::CallInst * CreateMemMove(llvm::Value *Dst, llvm::Value *Src, uint64_t Size, unsigned Align,
263                            bool isVolatile = false, llvm::MDNode *TBAATag = nullptr,
264                            llvm::MDNode *ScopeTag = nullptr,
265                            llvm::MDNode *NoAliasTag = nullptr) {
266        return CreateMemMove(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag, ScopeTag, NoAliasTag);
267    }
268
269    llvm::CallInst * CreateMemMove(llvm::Value *Dst, llvm::Value *Src, llvm::Value *Size, unsigned Align,
270                            bool isVolatile = false, llvm::MDNode *TBAATag = nullptr,
271                            llvm::MDNode *ScopeTag = nullptr,
272                            llvm::MDNode *NoAliasTag = nullptr);
273
274    llvm::CallInst * CreateMemCpy(llvm::Value *Dst, llvm::Value *Src, uint64_t Size, unsigned Align,
275                           bool isVolatile = false, llvm::MDNode *TBAATag = nullptr,
276                           llvm::MDNode *TBAAStructTag = nullptr,
277                           llvm::MDNode *ScopeTag = nullptr,
278                           llvm::MDNode *NoAliasTag = nullptr) {
279        return CreateMemCpy(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag, TBAAStructTag, ScopeTag, NoAliasTag);
280    }
281
282    llvm::CallInst * CreateMemCpy(llvm::Value *Dst, llvm::Value *Src, llvm::Value *Size, unsigned Align,
283                           bool isVolatile = false, llvm::MDNode *TBAATag = nullptr,
284                           llvm::MDNode *TBAAStructTag = nullptr,
285                           llvm::MDNode *ScopeTag = nullptr,
286                           llvm::MDNode *NoAliasTag = nullptr);
287
288
289    void setDriver(Driver * const driver) {
290        mDriver = driver;
291    }
292
293protected:
294
295    bool hasAlignedAlloc() const;
296
297    bool hasPosixMemalign() const;
298
299    bool hasAddressSanitizer() const;
300
301    void __CreateAssert(llvm::Value * assertion, llvm::StringRef failureMessage);
302
303    llvm::Function * LinkFunction(llvm::StringRef name, llvm::FunctionType * type, void * functionPtr) const;
304
305protected:
306
307    llvm::Module *                  mModule;
308    unsigned                        mCacheLineAlignment;
309    llvm::IntegerType * const       mSizeType;
310    llvm::StructType *              mFILEtype;
311    Driver *                        mDriver;   
312    llvm::LLVMContext               mContext;
313    const std::string               mTriple;
314};
315
316template <typename ExternalFunctionType>
317llvm::Function *CBuilder::LinkFunction(llvm::StringRef name, ExternalFunctionType * functionPtr) const {
318    llvm::FunctionType * const type = FunctionTypeBuilder<ExternalFunctionType>::get(getContext());
319    assert ("FunctionTypeBuilder did not resolve a function type." && type);
320    return LinkFunction(name, type, reinterpret_cast<void *>(functionPtr));
321}
322
323#endif
Note: See TracBrowser for help on using the repository browser.