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

Last change on this file since 5916 was 5916, checked in by cameron, 11 months ago

Mangler function

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