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

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

Jenkins u8u16 test check in.

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