source: icGREP/icgrep-devel/icgrep/IR_Gen/CBuilder.cpp @ 5465

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

Jenkins investigation check-in

File size: 31.4 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 *  icgrep is a trademark of International Characters.
5 */
6
7#include "CBuilder.h"
8#include <llvm/IR/Module.h>
9#include <llvm/IR/Constants.h>
10#include <llvm/IR/Intrinsics.h>
11#include <llvm/IR/TypeBuilder.h>
12#include <llvm/IR/MDBuilder.h>
13#include <llvm/Support/raw_ostream.h>
14#include <toolchain/toolchain.h>
15#include <toolchain/driver.h>
16#include <stdlib.h>
17#include <sys/mman.h>
18#include <unistd.h>
19
20using namespace llvm;
21
22Value * CBuilder::CreateOpenCall(Value * filename, Value * oflag, Value * mode) {
23    Module * const m = getModule();
24    Function * openFn = m->getFunction("open");
25    if (openFn == nullptr) {
26        IntegerType * int32Ty = getInt32Ty();
27        PointerType * int8PtrTy = getInt8PtrTy();
28        openFn = cast<Function>(m->getOrInsertFunction("open",
29                                                         int32Ty, int8PtrTy, int32Ty, int32Ty, nullptr));
30    }
31    return CreateCall(openFn, {filename, oflag, mode});
32}
33
34// ssize_t write(int fildes, const void *buf, size_t nbyte);
35Value * CBuilder::CreateWriteCall(Value * fileDescriptor, Value * buf, Value * nbyte) {
36    PointerType * voidPtrTy = getVoidPtrTy();
37    Module * const m = getModule();
38    Function * write = m->getFunction("write");
39    if (write == nullptr) {
40        IntegerType * sizeTy = getSizeTy();
41        IntegerType * int32Ty = getInt32Ty();
42        write = cast<Function>(m->getOrInsertFunction("write",
43                                                        AttributeSet().addAttribute(getContext(), 2U, Attribute::NoAlias),
44                                                        sizeTy, int32Ty, voidPtrTy, sizeTy, nullptr));
45    }
46    buf = CreatePointerCast(buf, voidPtrTy);
47    return CreateCall(write, {fileDescriptor, buf, nbyte});
48}
49
50Value * CBuilder::CreateReadCall(Value * fileDescriptor, Value * buf, Value * nbyte) {
51    PointerType * voidPtrTy = getVoidPtrTy();
52    Module * const m = getModule();
53    Function * readFn = m->getFunction("read");
54    if (readFn == nullptr) {
55        IntegerType * sizeTy = getSizeTy();
56        IntegerType * int32Ty = getInt32Ty();
57        readFn = cast<Function>(m->getOrInsertFunction("read",
58                                                         AttributeSet().addAttribute(getContext(), 2U, Attribute::NoAlias),
59                                                         sizeTy, int32Ty, voidPtrTy, sizeTy, nullptr));
60    }
61    buf = CreatePointerCast(buf, voidPtrTy);
62    return CreateCall(readFn, {fileDescriptor, buf, nbyte});
63}
64
65Value * CBuilder::CreateCloseCall(Value * fileDescriptor) {
66    Module * const m = getModule();
67    Function * closeFn = m->getFunction("close");
68    if (closeFn == nullptr) {
69        IntegerType * int32Ty = getInt32Ty();
70        FunctionType * fty = FunctionType::get(int32Ty, {int32Ty}, true);
71        closeFn = Function::Create(fty, Function::ExternalLinkage, "close", m);
72    }
73    return CreateCall(closeFn, fileDescriptor);
74}
75
76
77Value * CBuilder::CreateUnlinkCall(Value * path) {
78    Module * const m = getModule();
79    Function * unlinkFunc = m->getFunction("unlink");
80    if (unlinkFunc == nullptr) {
81        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, false);
82        unlinkFunc = Function::Create(fty, Function::ExternalLinkage, "unlink", m);
83        unlinkFunc->setCallingConv(CallingConv::C);
84    }
85    return CreateCall(unlinkFunc, path);
86}
87
88Value * CBuilder::CreateMkstempCall(Value * ftemplate) {
89    Module * const m = getModule();
90    Function * mkstempFn = m->getFunction("mkstemp");
91    if (mkstempFn == nullptr) {
92        mkstempFn = cast<Function>(m->getOrInsertFunction("mkstemp", getInt32Ty(), getInt8PtrTy(), nullptr));
93    }
94    return CreateCall(mkstempFn, ftemplate);
95}
96
97
98Value * CBuilder::CreateStrlenCall(Value * str) {
99    Module * const m = getModule();
100    Function * strlenFn = m->getFunction("strlen");
101    if (strlenFn == nullptr) {
102        strlenFn = cast<Function>(m->getOrInsertFunction("strlen", getSizeTy(), getInt8PtrTy(), nullptr));
103    }
104    return CreateCall(strlenFn, str);
105}
106
107
108Function * CBuilder::GetPrintf() {
109    Module * const m = getModule();
110    Function * printf = m->getFunction("printf");
111    if (printf == nullptr) {
112        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, true);
113        printf = Function::Create(fty, Function::ExternalLinkage, "printf", m);
114        printf->addAttribute(1, Attribute::NoAlias);
115    }
116    return printf;
117}
118
119Function * CBuilder::GetDprintf() {
120    Module * const m = getModule();
121    Function * dprintf = m->getFunction("dprintf");
122    if (dprintf == nullptr) {
123        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt32Ty(), getInt8PtrTy()}, true);
124        dprintf = Function::Create(fty, Function::ExternalLinkage, "dprintf", m);
125    }
126    return dprintf;
127}
128
129void CBuilder::CallPrintInt(const std::string & name, Value * const value) {
130    Module * const m = getModule();
131    Constant * printRegister = m->getFunction("PrintInt");
132    IntegerType * int64Ty = getInt64Ty();
133    if (LLVM_UNLIKELY(printRegister == nullptr)) {
134        FunctionType *FT = FunctionType::get(getVoidTy(), { getInt8PtrTy(), int64Ty }, false);
135        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintInt", m);
136        auto arg = function->arg_begin();
137        std::string out = "%-40s = %" PRIx64 "\n";
138        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
139        IRBuilder<> builder(entry);
140        std::vector<Value *> args;
141        args.push_back(GetString(out.c_str()));
142        Value * const name = &*(arg++);
143        name->setName("name");
144        args.push_back(name);
145        Value * value = &*arg;
146        value->setName("value");
147        args.push_back(value);
148        builder.CreateCall(GetPrintf(), args);
149        builder.CreateRetVoid();
150
151        printRegister = function;
152    }
153    Value * num = nullptr;
154    if (value->getType()->isPointerTy()) {
155        num = CreatePtrToInt(value, int64Ty);
156    } else {
157        num = CreateZExtOrBitCast(value, int64Ty);
158    }
159    assert (num->getType()->isIntegerTy());
160    CreateCall(printRegister, {GetString(name.c_str()), num});
161}
162
163void CBuilder::CallPrintIntToStderr(const std::string & name, Value * const value) {
164    Module * const m = getModule();
165    Constant * printRegister = m->getFunction("PrintIntToStderr");
166    if (LLVM_UNLIKELY(printRegister == nullptr)) {
167        FunctionType *FT = FunctionType::get(getVoidTy(), { PointerType::get(getInt8Ty(), 0), getSizeTy() }, false);
168        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintIntToStderr", m);
169        auto arg = function->arg_begin();
170        std::string out = "%-40s = %" PRIx64 "\n";
171        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
172        IRBuilder<> builder(entry);
173        std::vector<Value *> args;
174        args.push_back(getInt32(2));    // fd 2 (stderr)
175        args.push_back(GetString(out.c_str()));
176        Value * const name = &*(arg++);
177        name->setName("name");
178        args.push_back(name);
179        Value * value = &*arg;
180        value->setName("value");
181        args.push_back(value);
182        builder.CreateCall(GetDprintf(), args);
183        builder.CreateRetVoid();
184
185        printRegister = function;
186    }
187    Value * num = nullptr;
188    if (value->getType()->isPointerTy()) {
189        num = CreatePtrToInt(value, getSizeTy());
190    } else {
191        num = CreateZExtOrBitCast(value, getSizeTy());
192    }
193    assert (num->getType()->isIntegerTy());
194    CreateCall(printRegister, {GetString(name.c_str()), num});
195}
196
197void CBuilder::CallPrintMsgToStderr(const std::string & message) {
198    Module * const m = getModule();
199    Constant * printMsg = m->getFunction("PrintMsgToStderr");
200    if (LLVM_UNLIKELY(printMsg == nullptr)) {
201        FunctionType *FT = FunctionType::get(getVoidTy(), { PointerType::get(getInt8Ty(), 0) }, false);
202        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintMsgToStderr", m);
203        auto arg = function->arg_begin();
204        std::string out = "%s\n";
205        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
206        IRBuilder<> builder(entry);
207        std::vector<Value *> args;
208        args.push_back(getInt32(2));    // fd 2 (stderr)
209        args.push_back(GetString(out.c_str()));
210        Value * const msg = &*(arg++);
211        msg->setName("msg");
212        args.push_back(msg);
213        builder.CreateCall(GetDprintf(), args);
214        builder.CreateRetVoid();
215
216        printMsg = function;
217    }
218    CreateCall(printMsg, {GetString(message.c_str())});
219}
220
221Value * CBuilder::CreateMalloc(Value * size) {
222    Module * const m = getModule();
223    IntegerType * const sizeTy = getSizeTy();   
224    Function * malloc = m->getFunction("malloc");
225    if (malloc == nullptr) {
226//        malloc = LinkFunction("malloc", &std::malloc);
227        PointerType * const voidPtrTy = getVoidPtrTy();
228        FunctionType * fty = FunctionType::get(voidPtrTy, {sizeTy}, false);
229        malloc = Function::Create(fty, Function::ExternalLinkage, "malloc", m);
230        malloc->setCallingConv(CallingConv::C);
231        malloc->setDoesNotAlias(0);
232    }
233    size = CreateZExtOrTrunc(size, sizeTy);
234    CallInst * const ptr = CreateCall(malloc, size);
235    ptr->setTailCall();
236    CreateAssert(ptr, "CreateMalloc: returned null pointer");
237    return ptr;
238}
239
240Value * CBuilder::CreateAlignedMalloc(Value * size, const unsigned alignment) {
241    if (LLVM_UNLIKELY((alignment & (alignment - 1)) != 0)) {
242        report_fatal_error("CreateAlignedMalloc: alignment must be a power of 2");
243    }
244    Module * const m = getModule();
245    Function * f = m->getFunction("aligned_alloc");
246    IntegerType * const sizeTy = getSizeTy();
247    if (LLVM_UNLIKELY(f == nullptr)) {
248//        PointerType * const voidPtrTy = getVoidPtrTy();
249//        FunctionType * const fty = FunctionType::get(voidPtrTy, {sizeTy, sizeTy}, false);
250//        f = Function::Create(fty, Function::ExternalLinkage, "aligned_alloc", m);
251//        f->setCallingConv(CallingConv::C);
252//        f->setDoesNotAlias(0);
253        f = LinkFunction("aligned_alloc", &aligned_alloc);
254    }
255
256    size = CreateZExtOrTrunc(size, sizeTy);
257    ConstantInt * const align = ConstantInt::get(sizeTy, alignment);
258    if (codegen::EnableAsserts) {
259        CreateAssert(CreateICmpEQ(CreateURem(size, align), ConstantInt::get(sizeTy, 0)),
260                     "CreateAlignedMalloc: size must be an integral multiple of alignment.");
261    }
262    Value * const ptr = CreateCall(f, {align, size});
263    CreateAssert(ptr, "CreateAlignedMalloc: returned null pointer.");
264    return ptr;
265}
266
267Value * CBuilder::CreateAnonymousMMap(Value * size) {
268    PointerType * const voidPtrTy = getVoidPtrTy();
269    IntegerType * const intTy = getInt32Ty();
270    IntegerType * const sizeTy = getSizeTy();
271    size = CreateZExtOrTrunc(size, sizeTy);
272    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ | PROT_WRITE);
273    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE | MAP_ANON);
274    ConstantInt * const fd =  ConstantInt::get(intTy, -1);
275    Constant * const offset = ConstantInt::get(sizeTy, 0);
276    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
277}
278
279Value * CBuilder::CreateFileSourceMMap(Value * fd, Value * size) {
280    PointerType * const voidPtrTy = getVoidPtrTy();
281    IntegerType * const intTy = getInt32Ty();
282    fd = CreateZExtOrTrunc(fd, intTy);
283    IntegerType * const sizeTy = getSizeTy();
284    size = CreateZExtOrTrunc(size, sizeTy);
285    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ);
286    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE);
287    Constant * const offset = ConstantInt::get(sizeTy, 0);       
288    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
289}
290
291Value * CBuilder::CreateMMap(Value * const addr, Value * size, Value * const prot, Value * const flags, Value * const fd, Value * const offset) {
292    Module * const m = getModule();
293    Function * fMMap = m->getFunction("mmap");
294    if (LLVM_UNLIKELY(fMMap == nullptr)) {
295        PointerType * const voidPtrTy = getVoidPtrTy();
296        IntegerType * const intTy = getInt32Ty();
297        IntegerType * const sizeTy = getSizeTy();
298        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, intTy, intTy, intTy, sizeTy}, false);
299        fMMap = Function::Create(fty, Function::ExternalLinkage, "mmap", m);
300    }
301    Value * ptr = CreateCall(fMMap, {addr, size, prot, flags, fd, offset});
302    if (codegen::EnableAsserts) {
303        CreateAssert(CheckMMapSuccess(ptr), "CreateMMap: mmap failed to allocate memory");
304    }
305    return ptr;
306}
307
308/**
309 * @brief CBuilder::CreateMAdvise
310 * @param addr
311 * @param length
312 * @param advice
313 *
314 * Note: this funcition can fail if a kernel resource was temporarily unavailable. Test if this is more than a simple hint and handle accordingly.
315 *
316 *  ADVICE_NORMAL
317 *      No special treatment. This is the default.
318 *  ADVICE_RANDOM
319 *      Expect page references in random order. (Hence, read ahead may be less useful than normally.)
320 *  ADVICE_SEQUENTIAL
321 *      Expect page references in sequential order. (Hence, pages in the given range can be aggressively read ahead, and may be freed
322 *      soon after they are accessed.)
323 *  ADVICE_WILLNEED
324 *      Expect access in the near future. (Hence, it might be a good idea to read some pages ahead.)
325 *  ADVICE_DONTNEED
326 *      Do not expect access in the near future. (For the time being, the application is finished with the given range, so the kernel
327 *      can free resources associated with it.) Subsequent accesses of pages in this range will succeed, but will result either in
328 *      reloading of the memory contents from the underlying mapped file (see mmap(2)) or zero-fill-on-demand pages for mappings
329 *      without an underlying file.
330 *
331 * @return Value indicating success (0) or failure (-1).
332 */
333Value * CBuilder::CreateMAdvise(Value * addr, Value * length, Advice advice) {
334    Triple T(mTriple);
335    Value * result = nullptr;
336    if (T.isOSLinux() || T.isOSDarwin()) {
337        Module * const m = getModule();
338        IntegerType * const intTy = getInt32Ty();
339        IntegerType * const sizeTy = getSizeTy();
340        PointerType * const voidPtrTy = getVoidPtrTy();
341        Function * MAdviseFunc = m->getFunction("madvise");
342        if (LLVM_UNLIKELY(MAdviseFunc == nullptr)) {
343            FunctionType * fty = FunctionType::get(intTy, {voidPtrTy, sizeTy, intTy}, false);
344            MAdviseFunc = Function::Create(fty, Function::ExternalLinkage, "madvise", m);
345        }
346        addr = CreatePointerCast(addr, voidPtrTy);
347        length = CreateZExtOrTrunc(length, sizeTy);
348        int madv_flag = 0;
349        switch (advice) {
350            case Advice::ADVICE_NORMAL:
351                madv_flag = MADV_NORMAL; break;
352            case Advice::ADVICE_RANDOM:
353                madv_flag = MADV_RANDOM; break;
354            case Advice::ADVICE_SEQUENTIAL:
355                madv_flag = MADV_SEQUENTIAL; break;
356            case Advice::ADVICE_WILLNEED:
357                madv_flag = MADV_WILLNEED; break;
358            case Advice::ADVICE_DONTNEED:
359                madv_flag = MADV_DONTNEED; break;
360        }
361        result = CreateCall(MAdviseFunc, {addr, length, ConstantInt::get(intTy, madv_flag)});
362    }
363    return result;
364}
365
366Value * CBuilder::CheckMMapSuccess(Value * const addr) {
367    Module * const m = getModule();
368    DataLayout DL(m);
369    IntegerType * const intTy = getIntPtrTy(DL);
370    return CreateICmpNE(CreatePtrToInt(addr, intTy), ConstantInt::getAllOnesValue(intTy)); // MAP_FAILED = -1
371}
372
373#ifndef MREMAP_MAYMOVE
374#define MREMAP_MAYMOVE  1
375#endif
376
377Value * CBuilder::CreateMRemap(Value * addr, Value * oldSize, Value * newSize) {
378    Triple T(mTriple);
379    Value * ptr = nullptr;
380    if (T.isOSLinux()) {
381        Module * const m = getModule();
382        DataLayout DL(m);
383        PointerType * const voidPtrTy = getVoidPtrTy();
384        IntegerType * const sizeTy = getSizeTy();
385        IntegerType * const intTy = getIntPtrTy(DL);
386        Function * fMRemap = m->getFunction("mremap");
387        if (LLVM_UNLIKELY(fMRemap == nullptr)) {
388            FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, sizeTy, intTy}, false);
389            fMRemap = Function::Create(fty, Function::ExternalLinkage, "mremap", m);
390        }
391        addr = CreatePointerCast(addr, voidPtrTy);
392        oldSize = CreateZExtOrTrunc(oldSize, sizeTy);
393        newSize = CreateZExtOrTrunc(newSize, sizeTy);
394        ConstantInt * const flags = ConstantInt::get(intTy, MREMAP_MAYMOVE);
395        ptr = CreateCall(fMRemap, {addr, oldSize, newSize, flags});
396        if (codegen::EnableAsserts) {
397            CreateAssert(CheckMMapSuccess(ptr), "CreateMRemap: mremap failed to allocate memory");
398        }
399    } else { // no OS mremap support
400        ptr = CreateAnonymousMMap(newSize);
401        CreateMemCpy(ptr, addr, oldSize, getpagesize());
402        CreateMUnmap(addr, oldSize);
403    }
404    return ptr;
405}
406
407Value * CBuilder::CreateMUnmap(Value * addr, Value * len) {
408    IntegerType * const sizeTy = getSizeTy();
409    PointerType * const voidPtrTy = getVoidPtrTy();
410    Module * const m = getModule();
411    Function * munmapFunc = m->getFunction("munmap");
412    if (LLVM_UNLIKELY(munmapFunc == nullptr)) {
413        FunctionType * const fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy}, false);
414        munmapFunc = Function::Create(fty, Function::ExternalLinkage, "munmap", m);
415    }
416    len = CreateZExtOrTrunc(len, sizeTy);
417    if (codegen::EnableAsserts) {
418        DataLayout DL(getModule());
419        IntegerType * const intPtrTy = getIntPtrTy(DL);
420        CreateAssert(len, "CreateMUnmap: length cannot be 0");
421        Value * const addrValue = CreatePtrToInt(addr, intPtrTy);
422        Value * const pageOffset = CreateURem(addrValue, ConstantInt::get(intPtrTy, getpagesize()));
423        CreateAssert(CreateICmpEQ(pageOffset, ConstantInt::getNullValue(intPtrTy)), "CreateMUnmap: addr must be a multiple of the page size");
424        Value * const boundCheck = CreateICmpULT(addrValue, CreateSub(ConstantInt::getAllOnesValue(intPtrTy), CreateZExtOrTrunc(len, intPtrTy)));
425        CreateAssert(boundCheck, "CreateMUnmap: addresses in [addr, addr+len) are outside the valid address space range");
426    }
427    addr = CreatePointerCast(addr, voidPtrTy);
428    return CreateCall(munmapFunc, {addr, len});
429}
430
431void CBuilder::CreateFree(Value * ptr) {
432    assert (ptr->getType()->isPointerTy());
433    Module * const m = getModule();
434    Type * const voidPtrTy =  getVoidPtrTy();
435    Function * f = m->getFunction("free");
436    if (f == nullptr) {
437        FunctionType * fty = FunctionType::get(getVoidTy(), {voidPtrTy}, false);
438        f = Function::Create(fty, Function::ExternalLinkage, "free", m);
439        f->setCallingConv(CallingConv::C);
440        // f = LinkFunction("free", &std::free);
441    }
442    ptr = CreatePointerCast(ptr, voidPtrTy);
443    CreateCall(f, ptr)->setTailCall();
444}
445
446Value * CBuilder::CreateRealloc(Value * const ptr, Value * size) {
447    Module * const m = getModule();
448    IntegerType * const sizeTy = getSizeTy();
449    PointerType * const voidPtrTy = getVoidPtrTy();
450    Function * f = m->getFunction("realloc");
451    if (f == nullptr) {
452        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy}, false);
453        f = Function::Create(fty, Function::ExternalLinkage, "realloc", m);
454        f->setCallingConv(CallingConv::C);
455        f->setDoesNotAlias(0);
456        f->setDoesNotAlias(1);
457        // f = LinkFunction("realloc", &realloc);
458    }
459    Value * const addr = CreatePointerCast(ptr, voidPtrTy);
460    size = CreateZExtOrTrunc(size, sizeTy);
461    CallInst * const ci = CreateCall(f, {addr, size});
462    ci->setTailCall();
463    return CreatePointerCast(ci, ptr->getType());
464}
465
466PointerType * CBuilder::getVoidPtrTy() const {
467    return TypeBuilder<void *, false>::get(getContext());
468}
469
470LoadInst * CBuilder::CreateAtomicLoadAcquire(Value * ptr) {
471    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
472    LoadInst * inst = CreateAlignedLoad(ptr, alignment);
473    inst->setOrdering(AtomicOrdering::Acquire);
474    return inst;
475   
476}
477
478StoreInst * CBuilder::CreateAtomicStoreRelease(Value * val, Value * ptr) {
479    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
480    StoreInst * inst = CreateAlignedStore(val, ptr, alignment);
481    inst->setOrdering(AtomicOrdering::Release);
482    return inst;
483}
484
485PointerType * CBuilder::getFILEptrTy() {
486    if (mFILEtype == nullptr) {
487        mFILEtype = StructType::create(getContext(), "struct._IO_FILE");
488    }
489    return mFILEtype->getPointerTo();
490}
491
492Value * CBuilder::CreateFOpenCall(Value * filename, Value * mode) {
493    Module * const m = getModule();
494    Function * fOpenFunc = m->getFunction("fopen");
495    if (fOpenFunc == nullptr) {
496        FunctionType * fty = FunctionType::get(getFILEptrTy(), {getInt8Ty()->getPointerTo(), getInt8Ty()->getPointerTo()}, false);
497        fOpenFunc = Function::Create(fty, Function::ExternalLinkage, "fopen", m);
498        fOpenFunc->setCallingConv(CallingConv::C);
499    }
500    return CreateCall(fOpenFunc, {filename, mode});
501}
502
503Value * CBuilder::CreateFReadCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
504    Module * const m = getModule();
505    Function * fReadFunc = m->getFunction("fread");
506    PointerType * const voidPtrTy = getVoidPtrTy();
507    if (fReadFunc == nullptr) {
508        IntegerType * const sizeTy = getSizeTy();
509        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
510        fReadFunc = Function::Create(fty, Function::ExternalLinkage, "fread", m);
511        fReadFunc->setCallingConv(CallingConv::C);
512    }
513    ptr = CreatePointerCast(ptr, voidPtrTy);
514    return CreateCall(fReadFunc, {ptr, size, nitems, stream});
515}
516
517Value * CBuilder::CreateFWriteCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
518    Module * const m = getModule();
519    Function * fWriteFunc = m->getFunction("fwrite");
520    PointerType * const voidPtrTy = getVoidPtrTy();
521    if (fWriteFunc == nullptr) {
522        IntegerType * const sizeTy = getSizeTy();
523        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
524        fWriteFunc = Function::Create(fty, Function::ExternalLinkage, "fwrite", m);
525        fWriteFunc->setCallingConv(CallingConv::C);
526    }
527    ptr = CreatePointerCast(ptr, voidPtrTy);
528    return CreateCall(fWriteFunc, {ptr, size, nitems, stream});
529}
530
531Value * CBuilder::CreateFCloseCall(Value * stream) {
532    Module * const m = getModule();
533    Function * fCloseFunc = m->getFunction("fclose");
534    if (fCloseFunc == nullptr) {
535        FunctionType * fty = FunctionType::get(getInt32Ty(), {getFILEptrTy()}, false);
536        fCloseFunc = Function::Create(fty, Function::ExternalLinkage, "fclose", m);
537        fCloseFunc->setCallingConv(CallingConv::C);
538    }
539    return CreateCall(fCloseFunc, {stream});
540}
541
542Value * CBuilder::CreateRenameCall(Value * oldName, Value * newName) {
543    Module * const m = getModule();
544    Function * renameFunc = m->getFunction("rename");
545    if (renameFunc == nullptr) {
546        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy(), getInt8PtrTy()}, false);
547        renameFunc = Function::Create(fty, Function::ExternalLinkage, "rename", m);
548        renameFunc->setCallingConv(CallingConv::C);
549    }
550    return CreateCall(renameFunc, {oldName, newName});
551}
552
553Value * CBuilder::CreateRemoveCall(Value * path) {
554    Module * const m = getModule();
555    Function * removeFunc = m->getFunction("remove");
556    if (removeFunc == nullptr) {
557        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, false);
558        removeFunc = Function::Create(fty, Function::ExternalLinkage, "remove", m);
559        removeFunc->setCallingConv(CallingConv::C);
560    }
561    return CreateCall(removeFunc, {path});
562}
563
564Value * CBuilder::CreatePThreadCreateCall(Value * thread, Value * attr, Function * start_routine, Value * arg) {
565    Module * const m = getModule();
566    Type * const voidPtrTy = getVoidPtrTy();
567    Function * pthreadCreateFunc = m->getFunction("pthread_create");
568    if (pthreadCreateFunc == nullptr) {
569        Type * pthreadTy = getSizeTy();
570        FunctionType * funVoidPtrVoidTy = FunctionType::get(getVoidTy(), {getVoidPtrTy()}, false);
571        FunctionType * fty = FunctionType::get(getInt32Ty(), {pthreadTy->getPointerTo(), voidPtrTy, funVoidPtrVoidTy->getPointerTo(), voidPtrTy}, false);
572        pthreadCreateFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_create", m);
573        pthreadCreateFunc->setCallingConv(CallingConv::C);
574    }
575    return CreateCall(pthreadCreateFunc, {thread, attr, start_routine, CreatePointerCast(arg, voidPtrTy)});
576}
577
578Value * CBuilder::CreatePThreadExitCall(Value * value_ptr) {
579    Module * const m = getModule();
580    Function * pthreadExitFunc = m->getFunction("pthread_exit");
581    if (pthreadExitFunc == nullptr) {
582        FunctionType * fty = FunctionType::get(getVoidTy(), {getVoidPtrTy()}, false);
583        pthreadExitFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_exit", m);
584        pthreadExitFunc->addFnAttr(Attribute::NoReturn);
585        pthreadExitFunc->setCallingConv(CallingConv::C);
586    }
587    CallInst * exitThread = CreateCall(pthreadExitFunc, {value_ptr});
588    exitThread->setDoesNotReturn();
589    return exitThread;
590}
591
592Value * CBuilder::CreatePThreadJoinCall(Value * thread, Value * value_ptr){
593    Module * const m = getModule();
594    Function * pthreadJoinFunc = m->getFunction("pthread_join");
595    if (pthreadJoinFunc == nullptr) {
596        Type * pthreadTy = getSizeTy();
597        FunctionType * fty = FunctionType::get(getInt32Ty(), {pthreadTy, getVoidPtrTy()->getPointerTo()}, false);
598        pthreadJoinFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_join", m);
599        pthreadJoinFunc->setCallingConv(CallingConv::C);
600    }
601    return CreateCall(pthreadJoinFunc, {thread, value_ptr});
602}
603
604void CBuilder::CreateAssert(Value * const assertion, StringRef failureMessage) {   
605    if (codegen::EnableAsserts) {
606        Module * const m = getModule();
607        Function * function = m->getFunction("__assert");
608        if (LLVM_UNLIKELY(function == nullptr)) {
609            auto ip = saveIP();
610            FunctionType * fty = FunctionType::get(getVoidTy(), { getInt1Ty(), getInt8PtrTy(), getSizeTy() }, false);
611            function = Function::Create(fty, Function::PrivateLinkage, "__assert", m);
612            function->setDoesNotThrow();
613            function->setDoesNotAlias(2);
614            BasicBlock * const entry = BasicBlock::Create(getContext(), "", function);
615            BasicBlock * const failure = BasicBlock::Create(getContext(), "", function);
616            BasicBlock * const success = BasicBlock::Create(getContext(), "", function);
617            auto arg = function->arg_begin();
618            arg->setName("assertion");
619            Value * e = &*arg++;
620            arg->setName("msg");
621            Value * msg = &*arg++;
622            arg->setName("sz");
623            Value * sz = &*arg;
624            SetInsertPoint(entry);
625            CreateCondBr(e, failure, success);
626            SetInsertPoint(failure);
627            Value * len = CreateAdd(sz, getSize(21));
628            ConstantInt * _11 = getSize(11);
629            Value * bytes = CreatePointerCast(CreateMalloc(len), getInt8PtrTy());
630            CreateMemCpy(bytes, GetString("Assertion `"), _11, 1);
631            CreateMemCpy(CreateGEP(bytes, _11), msg, sz, 1);
632            CreateMemCpy(CreateGEP(bytes, CreateAdd(sz, _11)), GetString("' failed.\n"), getSize(10), 1);
633            CreateWriteCall(getInt32(2), bytes, len);
634
635
636            CreateExit(-1);
637            CreateBr(success); // necessary to satisfy the LLVM verifier. this is not actually executed.
638            SetInsertPoint(success);
639            CreateRetVoid();
640            restoreIP(ip);
641        }
642        CreateCall(function, {CreateICmpEQ(assertion, Constant::getNullValue(assertion->getType())), GetString(failureMessage), getSize(failureMessage.size())});
643    }
644}
645
646void CBuilder::CreateExit(const int exitCode) {
647    Module * const m = getModule();
648    Function * exit = m->getFunction("exit");
649    if (LLVM_UNLIKELY(exit == nullptr)) {
650        FunctionType * fty = FunctionType::get(getVoidTy(), {getInt32Ty()}, false);
651        exit = Function::Create(fty, Function::ExternalLinkage, "exit", m);
652        exit->setDoesNotReturn();
653        exit->setDoesNotThrow();
654    }
655    CreateCall(exit, getInt32(exitCode));
656}
657
658llvm::BasicBlock * CBuilder::CreateBasicBlock(std::string && name) {
659    return BasicBlock::Create(getContext(), name, GetInsertBlock()->getParent());
660}
661
662BranchInst * CBuilder::CreateLikelyCondBr(Value * Cond, BasicBlock * True, BasicBlock * False, const int probability) {
663    MDBuilder mdb(getContext());
664    if (probability < 0 || probability > 100) {
665        report_fatal_error("branch weight probability must be in [0,100]");
666    }
667    return CreateCondBr(Cond, True, False, mdb.createBranchWeights(probability, 100 - probability));
668}
669
670Value * CBuilder::CreatePopcount(Value * bits) {
671    Value * ctpopFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctpop, bits->getType());
672    return CreateCall(ctpopFunc, bits);
673}
674
675Value * CBuilder::CreateCountForwardZeroes(Value * value) {
676    Value * cttzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::cttz, value->getType());
677    return CreateCall(cttzFunc, {value, ConstantInt::getFalse(getContext())});
678}
679
680Value * CBuilder::CreateCountReverseZeroes(Value * value) {
681    Value * ctlzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctlz, value->getType());
682    return CreateCall(ctlzFunc, {value, ConstantInt::getFalse(getContext())});
683}
684
685Value * CBuilder::CreateResetLowestBit(Value * bits) {
686    return CreateAnd(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
687}
688
689Value * CBuilder::CreateIsolateLowestBit(Value * bits) {
690    return CreateAnd(bits, CreateNeg(bits));
691}
692
693Value * CBuilder::CreateMaskToLowestBitInclusive(Value * bits) {
694    return CreateXor(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
695}
696
697Value * CBuilder::CreateMaskToLowestBitExclusive(Value * bits) {
698    return CreateAnd(CreateSub(bits, ConstantInt::get(bits->getType(), 1)), CreateNot(bits));
699}
700
701Value * CBuilder::CreateExtractBitField(llvm::Value * bits, Value * start, Value * length) {
702    Constant * One = ConstantInt::get(bits->getType(), 1);
703    return CreateAnd(CreateLShr(bits, start), CreateSub(CreateShl(One, length), One));
704}
705
706Value * CBuilder::CreateCeilLog2(Value * value) {
707    IntegerType * ty = cast<IntegerType>(value->getType());
708    CreateAssert(value, "CreateCeilLog2: value cannot be zero");
709    Value * m = CreateCountReverseZeroes(CreateSub(value, ConstantInt::get(ty, 1)));
710    return CreateSub(ConstantInt::get(m->getType(), ty->getBitWidth() - 1), m);
711}
712
713Value * CBuilder::GetString(StringRef Str) {
714    Module * const m = getModule();
715    Value * ptr = m->getGlobalVariable(Str, true);
716    if (ptr == nullptr) {
717        ptr = CreateGlobalString(Str, Str);
718    }
719    Value * zero = getInt32(0);
720    return CreateInBoundsGEP(ptr, { zero, zero });
721}
722
723Value * CBuilder::CreateReadCycleCounter() {
724    Module * const m = getModule();
725    Value * cycleCountFunc = Intrinsic::getDeclaration(m, Intrinsic::readcyclecounter);
726    return CreateCall(cycleCountFunc, std::vector<Value *>({}));
727}
728
729Function * CBuilder::LinkFunction(llvm::StringRef name, FunctionType * type, void * functionPtr) const {
730    assert (mDriver);
731    return mDriver->addLinkFunction(getModule(), name, type, functionPtr);
732}
733
734CBuilder::CBuilder(llvm::LLVMContext & C, const unsigned GeneralRegisterWidthInBits)
735: IRBuilder<>(C)
736, mCacheLineAlignment(64)
737, mSizeType(getIntNTy(GeneralRegisterWidthInBits))
738, mFILEtype(nullptr)
739, mDriver(nullptr) {
740
741}
Note: See TracBrowser for help on using the repository browser.