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

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

lz4d - LZ4 decompressor - initial check-in

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