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

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

Add bit manipulation instructions to CBuilder

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