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

Last change on this file since 5732 was 5706, checked in by nmedfort, 20 months ago

First stage of MultiBlockKernel? and pipeline restructuring

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