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

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

AlignedMalloc? now uses posix_memalign if aligned_alloc does not exist in stdlib.h.

File size: 31.3 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
240#ifndef STDLIB_HAS_ALIGNED_ALLOC
241void * aligned_alloc(const size_t alignment, const size_t size) {
242    void * ptr;
243    if (LLVM_UNLIKELY(::posix_memalign(&ptr, alignment, size) != 0)) {
244        throw std::bad_alloc();
245    }
246    return ptr;
247}
248#endif
249
250Value * CBuilder::CreateAlignedMalloc(Value * size, const unsigned alignment) {
251    if (LLVM_UNLIKELY((alignment & (alignment - 1)) != 0)) {
252        report_fatal_error("CreateAlignedMalloc: alignment must be a power of 2");
253    }
254    Module * const m = getModule();
255    Function * f = m->getFunction("aligned_alloc");
256    IntegerType * const sizeTy = getSizeTy();
257    if (LLVM_UNLIKELY(f == nullptr)) {
258        f = LinkFunction("aligned_alloc", &aligned_alloc);
259    }
260
261    size = CreateZExtOrTrunc(size, sizeTy);
262    ConstantInt * const align = ConstantInt::get(sizeTy, alignment);
263    if (codegen::EnableAsserts) {
264        CreateAssert(CreateICmpEQ(CreateURem(size, align), ConstantInt::get(sizeTy, 0)),
265                     "CreateAlignedMalloc: size must be an integral multiple of alignment.");
266    }
267    Value * const ptr = CreateCall(f, {align, size});
268    CreateAssert(ptr, "CreateAlignedMalloc: returned null pointer.");
269    return ptr;
270}
271
272Value * CBuilder::CreateAnonymousMMap(Value * size) {
273    PointerType * const voidPtrTy = getVoidPtrTy();
274    IntegerType * const intTy = getInt32Ty();
275    IntegerType * const sizeTy = getSizeTy();
276    size = CreateZExtOrTrunc(size, sizeTy);
277    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ | PROT_WRITE);
278    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE | MAP_ANON);
279    ConstantInt * const fd =  ConstantInt::get(intTy, -1);
280    Constant * const offset = ConstantInt::get(sizeTy, 0);
281    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
282}
283
284Value * CBuilder::CreateFileSourceMMap(Value * fd, Value * size) {
285    PointerType * const voidPtrTy = getVoidPtrTy();
286    IntegerType * const intTy = getInt32Ty();
287    fd = CreateZExtOrTrunc(fd, intTy);
288    IntegerType * const sizeTy = getSizeTy();
289    size = CreateZExtOrTrunc(size, sizeTy);
290    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ);
291    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE);
292    Constant * const offset = ConstantInt::get(sizeTy, 0);       
293    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
294}
295
296Value * CBuilder::CreateMMap(Value * const addr, Value * size, Value * const prot, Value * const flags, Value * const fd, Value * const offset) {
297    Module * const m = getModule();
298    Function * fMMap = m->getFunction("mmap");
299    if (LLVM_UNLIKELY(fMMap == nullptr)) {
300        PointerType * const voidPtrTy = getVoidPtrTy();
301        IntegerType * const intTy = getInt32Ty();
302        IntegerType * const sizeTy = getSizeTy();
303        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, intTy, intTy, intTy, sizeTy}, false);
304        fMMap = Function::Create(fty, Function::ExternalLinkage, "mmap", m);
305    }
306    Value * ptr = CreateCall(fMMap, {addr, size, prot, flags, fd, offset});
307    if (codegen::EnableAsserts) {
308        CreateAssert(CheckMMapSuccess(ptr), "CreateMMap: mmap failed to allocate memory");
309    }
310    return ptr;
311}
312
313/**
314 * @brief CBuilder::CreateMAdvise
315 * @param addr
316 * @param length
317 * @param advice
318 *
319 * Note: this funcition can fail if a kernel resource was temporarily unavailable. Test if this is more than a simple hint and handle accordingly.
320 *
321 *  ADVICE_NORMAL
322 *      No special treatment. This is the default.
323 *  ADVICE_RANDOM
324 *      Expect page references in random order. (Hence, read ahead may be less useful than normally.)
325 *  ADVICE_SEQUENTIAL
326 *      Expect page references in sequential order. (Hence, pages in the given range can be aggressively read ahead, and may be freed
327 *      soon after they are accessed.)
328 *  ADVICE_WILLNEED
329 *      Expect access in the near future. (Hence, it might be a good idea to read some pages ahead.)
330 *  ADVICE_DONTNEED
331 *      Do not expect access in the near future. (For the time being, the application is finished with the given range, so the kernel
332 *      can free resources associated with it.) Subsequent accesses of pages in this range will succeed, but will result either in
333 *      reloading of the memory contents from the underlying mapped file (see mmap(2)) or zero-fill-on-demand pages for mappings
334 *      without an underlying file.
335 *
336 * @return Value indicating success (0) or failure (-1).
337 */
338Value * CBuilder::CreateMAdvise(Value * addr, Value * length, Advice advice) {
339    Triple T(mTriple);
340    Value * result = nullptr;
341    if (T.isOSLinux() || T.isOSDarwin()) {
342        Module * const m = getModule();
343        IntegerType * const intTy = getInt32Ty();
344        IntegerType * const sizeTy = getSizeTy();
345        PointerType * const voidPtrTy = getVoidPtrTy();
346        Function * MAdviseFunc = m->getFunction("madvise");
347        if (LLVM_UNLIKELY(MAdviseFunc == nullptr)) {
348            FunctionType * fty = FunctionType::get(intTy, {voidPtrTy, sizeTy, intTy}, false);
349            MAdviseFunc = Function::Create(fty, Function::ExternalLinkage, "madvise", m);
350        }
351        addr = CreatePointerCast(addr, voidPtrTy);
352        length = CreateZExtOrTrunc(length, sizeTy);
353        int madv_flag = 0;
354        switch (advice) {
355            case Advice::ADVICE_NORMAL:
356                madv_flag = MADV_NORMAL; break;
357            case Advice::ADVICE_RANDOM:
358                madv_flag = MADV_RANDOM; break;
359            case Advice::ADVICE_SEQUENTIAL:
360                madv_flag = MADV_SEQUENTIAL; break;
361            case Advice::ADVICE_WILLNEED:
362                madv_flag = MADV_WILLNEED; break;
363            case Advice::ADVICE_DONTNEED:
364                madv_flag = MADV_DONTNEED; break;
365        }
366        result = CreateCall(MAdviseFunc, {addr, length, ConstantInt::get(intTy, madv_flag)});
367    }
368    return result;
369}
370
371Value * CBuilder::CheckMMapSuccess(Value * const addr) {
372    Module * const m = getModule();
373    DataLayout DL(m);
374    IntegerType * const intTy = getIntPtrTy(DL);
375    return CreateICmpNE(CreatePtrToInt(addr, intTy), ConstantInt::getAllOnesValue(intTy)); // MAP_FAILED = -1
376}
377
378#ifndef MREMAP_MAYMOVE
379#define MREMAP_MAYMOVE  1
380#endif
381
382Value * CBuilder::CreateMRemap(Value * addr, Value * oldSize, Value * newSize) {
383    Triple T(mTriple);
384    Value * ptr = nullptr;
385    if (T.isOSLinux()) {
386        Module * const m = getModule();
387        DataLayout DL(m);
388        PointerType * const voidPtrTy = getVoidPtrTy();
389        IntegerType * const sizeTy = getSizeTy();
390        IntegerType * const intTy = getIntPtrTy(DL);
391        Function * fMRemap = m->getFunction("mremap");
392        if (LLVM_UNLIKELY(fMRemap == nullptr)) {
393            FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, sizeTy, intTy}, false);
394            fMRemap = Function::Create(fty, Function::ExternalLinkage, "mremap", m);
395        }
396        addr = CreatePointerCast(addr, voidPtrTy);
397        oldSize = CreateZExtOrTrunc(oldSize, sizeTy);
398        newSize = CreateZExtOrTrunc(newSize, sizeTy);
399        ConstantInt * const flags = ConstantInt::get(intTy, MREMAP_MAYMOVE);
400        ptr = CreateCall(fMRemap, {addr, oldSize, newSize, flags});
401        if (codegen::EnableAsserts) {
402            CreateAssert(CheckMMapSuccess(ptr), "CreateMRemap: mremap failed to allocate memory");
403        }
404    } else { // no OS mremap support
405        ptr = CreateAnonymousMMap(newSize);
406        CreateMemCpy(ptr, addr, oldSize, getpagesize());
407        CreateMUnmap(addr, oldSize);
408    }
409    return ptr;
410}
411
412Value * CBuilder::CreateMUnmap(Value * addr, Value * len) {
413    IntegerType * const sizeTy = getSizeTy();
414    PointerType * const voidPtrTy = getVoidPtrTy();
415    Module * const m = getModule();
416    Function * munmapFunc = m->getFunction("munmap");
417    if (LLVM_UNLIKELY(munmapFunc == nullptr)) {
418        FunctionType * const fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy}, false);
419        munmapFunc = Function::Create(fty, Function::ExternalLinkage, "munmap", m);
420    }
421    len = CreateZExtOrTrunc(len, sizeTy);
422    if (codegen::EnableAsserts) {
423        DataLayout DL(getModule());
424        IntegerType * const intPtrTy = getIntPtrTy(DL);
425        CreateAssert(len, "CreateMUnmap: length cannot be 0");
426        Value * const addrValue = CreatePtrToInt(addr, intPtrTy);
427        Value * const pageOffset = CreateURem(addrValue, ConstantInt::get(intPtrTy, getpagesize()));
428        CreateAssert(CreateICmpEQ(pageOffset, ConstantInt::getNullValue(intPtrTy)), "CreateMUnmap: addr must be a multiple of the page size");
429        Value * const boundCheck = CreateICmpULT(addrValue, CreateSub(ConstantInt::getAllOnesValue(intPtrTy), CreateZExtOrTrunc(len, intPtrTy)));
430        CreateAssert(boundCheck, "CreateMUnmap: addresses in [addr, addr+len) are outside the valid address space range");
431    }
432    addr = CreatePointerCast(addr, voidPtrTy);
433    return CreateCall(munmapFunc, {addr, len});
434}
435
436void CBuilder::CreateFree(Value * ptr) {
437    assert (ptr->getType()->isPointerTy());
438    Module * const m = getModule();
439    Type * const voidPtrTy =  getVoidPtrTy();
440    Function * f = m->getFunction("free");
441    if (f == nullptr) {
442        FunctionType * fty = FunctionType::get(getVoidTy(), {voidPtrTy}, false);
443        f = Function::Create(fty, Function::ExternalLinkage, "free", m);
444        f->setCallingConv(CallingConv::C);
445        // f = LinkFunction("free", &std::free);
446    }
447    ptr = CreatePointerCast(ptr, voidPtrTy);
448    CreateCall(f, ptr)->setTailCall();
449}
450
451Value * CBuilder::CreateRealloc(Value * const ptr, Value * size) {
452    Module * const m = getModule();
453    IntegerType * const sizeTy = getSizeTy();
454    PointerType * const voidPtrTy = getVoidPtrTy();
455    Function * f = m->getFunction("realloc");
456    if (f == nullptr) {
457        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy}, false);
458        f = Function::Create(fty, Function::ExternalLinkage, "realloc", m);
459        f->setCallingConv(CallingConv::C);
460        f->setDoesNotAlias(0);
461        f->setDoesNotAlias(1);
462        // f = LinkFunction("realloc", &realloc);
463    }
464    Value * const addr = CreatePointerCast(ptr, voidPtrTy);
465    size = CreateZExtOrTrunc(size, sizeTy);
466    CallInst * const ci = CreateCall(f, {addr, size});
467    ci->setTailCall();
468    return CreatePointerCast(ci, ptr->getType());
469}
470
471PointerType * CBuilder::getVoidPtrTy() const {
472    return TypeBuilder<void *, false>::get(getContext());
473}
474
475LoadInst * CBuilder::CreateAtomicLoadAcquire(Value * ptr) {
476    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
477    LoadInst * inst = CreateAlignedLoad(ptr, alignment);
478    inst->setOrdering(AtomicOrdering::Acquire);
479    return inst;
480   
481}
482
483StoreInst * CBuilder::CreateAtomicStoreRelease(Value * val, Value * ptr) {
484    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
485    StoreInst * inst = CreateAlignedStore(val, ptr, alignment);
486    inst->setOrdering(AtomicOrdering::Release);
487    return inst;
488}
489
490PointerType * CBuilder::getFILEptrTy() {
491    if (mFILEtype == nullptr) {
492        mFILEtype = StructType::create(getContext(), "struct._IO_FILE");
493    }
494    return mFILEtype->getPointerTo();
495}
496
497Value * CBuilder::CreateFOpenCall(Value * filename, Value * mode) {
498    Module * const m = getModule();
499    Function * fOpenFunc = m->getFunction("fopen");
500    if (fOpenFunc == nullptr) {
501        FunctionType * fty = FunctionType::get(getFILEptrTy(), {getInt8Ty()->getPointerTo(), getInt8Ty()->getPointerTo()}, false);
502        fOpenFunc = Function::Create(fty, Function::ExternalLinkage, "fopen", m);
503        fOpenFunc->setCallingConv(CallingConv::C);
504    }
505    return CreateCall(fOpenFunc, {filename, mode});
506}
507
508Value * CBuilder::CreateFReadCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
509    Module * const m = getModule();
510    Function * fReadFunc = m->getFunction("fread");
511    PointerType * const voidPtrTy = getVoidPtrTy();
512    if (fReadFunc == nullptr) {
513        IntegerType * const sizeTy = getSizeTy();
514        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
515        fReadFunc = Function::Create(fty, Function::ExternalLinkage, "fread", m);
516        fReadFunc->setCallingConv(CallingConv::C);
517    }
518    ptr = CreatePointerCast(ptr, voidPtrTy);
519    return CreateCall(fReadFunc, {ptr, size, nitems, stream});
520}
521
522Value * CBuilder::CreateFWriteCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
523    Module * const m = getModule();
524    Function * fWriteFunc = m->getFunction("fwrite");
525    PointerType * const voidPtrTy = getVoidPtrTy();
526    if (fWriteFunc == nullptr) {
527        IntegerType * const sizeTy = getSizeTy();
528        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
529        fWriteFunc = Function::Create(fty, Function::ExternalLinkage, "fwrite", m);
530        fWriteFunc->setCallingConv(CallingConv::C);
531    }
532    ptr = CreatePointerCast(ptr, voidPtrTy);
533    return CreateCall(fWriteFunc, {ptr, size, nitems, stream});
534}
535
536Value * CBuilder::CreateFCloseCall(Value * stream) {
537    Module * const m = getModule();
538    Function * fCloseFunc = m->getFunction("fclose");
539    if (fCloseFunc == nullptr) {
540        FunctionType * fty = FunctionType::get(getInt32Ty(), {getFILEptrTy()}, false);
541        fCloseFunc = Function::Create(fty, Function::ExternalLinkage, "fclose", m);
542        fCloseFunc->setCallingConv(CallingConv::C);
543    }
544    return CreateCall(fCloseFunc, {stream});
545}
546
547Value * CBuilder::CreateRenameCall(Value * oldName, Value * newName) {
548    Module * const m = getModule();
549    Function * renameFunc = m->getFunction("rename");
550    if (renameFunc == nullptr) {
551        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy(), getInt8PtrTy()}, false);
552        renameFunc = Function::Create(fty, Function::ExternalLinkage, "rename", m);
553        renameFunc->setCallingConv(CallingConv::C);
554    }
555    return CreateCall(renameFunc, {oldName, newName});
556}
557
558Value * CBuilder::CreateRemoveCall(Value * path) {
559    Module * const m = getModule();
560    Function * removeFunc = m->getFunction("remove");
561    if (removeFunc == nullptr) {
562        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, false);
563        removeFunc = Function::Create(fty, Function::ExternalLinkage, "remove", m);
564        removeFunc->setCallingConv(CallingConv::C);
565    }
566    return CreateCall(removeFunc, {path});
567}
568
569Value * CBuilder::CreatePThreadCreateCall(Value * thread, Value * attr, Function * start_routine, Value * arg) {
570    Module * const m = getModule();
571    Type * const voidPtrTy = getVoidPtrTy();
572    Function * pthreadCreateFunc = m->getFunction("pthread_create");
573    if (pthreadCreateFunc == nullptr) {
574        Type * pthreadTy = getSizeTy();
575        FunctionType * funVoidPtrVoidTy = FunctionType::get(getVoidTy(), {getVoidPtrTy()}, false);
576        FunctionType * fty = FunctionType::get(getInt32Ty(), {pthreadTy->getPointerTo(), voidPtrTy, funVoidPtrVoidTy->getPointerTo(), voidPtrTy}, false);
577        pthreadCreateFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_create", m);
578        pthreadCreateFunc->setCallingConv(CallingConv::C);
579    }
580    return CreateCall(pthreadCreateFunc, {thread, attr, start_routine, CreatePointerCast(arg, voidPtrTy)});
581}
582
583Value * CBuilder::CreatePThreadExitCall(Value * value_ptr) {
584    Module * const m = getModule();
585    Function * pthreadExitFunc = m->getFunction("pthread_exit");
586    if (pthreadExitFunc == nullptr) {
587        FunctionType * fty = FunctionType::get(getVoidTy(), {getVoidPtrTy()}, false);
588        pthreadExitFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_exit", m);
589        pthreadExitFunc->addFnAttr(Attribute::NoReturn);
590        pthreadExitFunc->setCallingConv(CallingConv::C);
591    }
592    CallInst * exitThread = CreateCall(pthreadExitFunc, {value_ptr});
593    exitThread->setDoesNotReturn();
594    return exitThread;
595}
596
597Value * CBuilder::CreatePThreadJoinCall(Value * thread, Value * value_ptr){
598    Module * const m = getModule();
599    Function * pthreadJoinFunc = m->getFunction("pthread_join");
600    if (pthreadJoinFunc == nullptr) {
601        Type * pthreadTy = getSizeTy();
602        FunctionType * fty = FunctionType::get(getInt32Ty(), {pthreadTy, getVoidPtrTy()->getPointerTo()}, false);
603        pthreadJoinFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_join", m);
604        pthreadJoinFunc->setCallingConv(CallingConv::C);
605    }
606    return CreateCall(pthreadJoinFunc, {thread, value_ptr});
607}
608
609void CBuilder::CreateAssert(Value * const assertion, StringRef failureMessage) {   
610    if (codegen::EnableAsserts) {
611        Module * const m = getModule();
612        Function * function = m->getFunction("__assert");
613        if (LLVM_UNLIKELY(function == nullptr)) {
614            auto ip = saveIP();
615            FunctionType * fty = FunctionType::get(getVoidTy(), { getInt1Ty(), getInt8PtrTy(), getSizeTy() }, false);
616            function = Function::Create(fty, Function::PrivateLinkage, "__assert", m);
617            function->setDoesNotThrow();
618            function->setDoesNotAlias(2);
619            BasicBlock * const entry = BasicBlock::Create(getContext(), "", function);
620            BasicBlock * const failure = BasicBlock::Create(getContext(), "", function);
621            BasicBlock * const success = BasicBlock::Create(getContext(), "", function);
622            auto arg = function->arg_begin();
623            arg->setName("assertion");
624            Value * e = &*arg++;
625            arg->setName("msg");
626            Value * msg = &*arg++;
627            arg->setName("sz");
628            Value * sz = &*arg;
629            SetInsertPoint(entry);
630            CreateCondBr(e, failure, success);
631            SetInsertPoint(failure);
632            Value * len = CreateAdd(sz, getSize(21));
633            ConstantInt * _11 = getSize(11);
634            Value * bytes = CreatePointerCast(CreateMalloc(len), getInt8PtrTy());
635            CreateMemCpy(bytes, GetString("Assertion `"), _11, 1);
636            CreateMemCpy(CreateGEP(bytes, _11), msg, sz, 1);
637            CreateMemCpy(CreateGEP(bytes, CreateAdd(sz, _11)), GetString("' failed.\n"), getSize(10), 1);
638            CreateWriteCall(getInt32(2), bytes, len);
639
640
641            CreateExit(-1);
642            CreateBr(success); // necessary to satisfy the LLVM verifier. this is not actually executed.
643            SetInsertPoint(success);
644            CreateRetVoid();
645            restoreIP(ip);
646        }
647        CreateCall(function, {CreateICmpEQ(assertion, Constant::getNullValue(assertion->getType())), GetString(failureMessage), getSize(failureMessage.size())});
648    }
649}
650
651void CBuilder::CreateExit(const int exitCode) {
652    Module * const m = getModule();
653    Function * exit = m->getFunction("exit");
654    if (LLVM_UNLIKELY(exit == nullptr)) {
655        FunctionType * fty = FunctionType::get(getVoidTy(), {getInt32Ty()}, false);
656        exit = Function::Create(fty, Function::ExternalLinkage, "exit", m);
657        exit->setDoesNotReturn();
658        exit->setDoesNotThrow();
659    }
660    CreateCall(exit, getInt32(exitCode));
661}
662
663llvm::BasicBlock * CBuilder::CreateBasicBlock(std::string && name) {
664    return BasicBlock::Create(getContext(), name, GetInsertBlock()->getParent());
665}
666
667BranchInst * CBuilder::CreateLikelyCondBr(Value * Cond, BasicBlock * True, BasicBlock * False, const int probability) {
668    MDBuilder mdb(getContext());
669    if (probability < 0 || probability > 100) {
670        report_fatal_error("branch weight probability must be in [0,100]");
671    }
672    return CreateCondBr(Cond, True, False, mdb.createBranchWeights(probability, 100 - probability));
673}
674
675Value * CBuilder::CreatePopcount(Value * bits) {
676    Value * ctpopFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctpop, bits->getType());
677    return CreateCall(ctpopFunc, bits);
678}
679
680Value * CBuilder::CreateCountForwardZeroes(Value * value) {
681    Value * cttzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::cttz, value->getType());
682    return CreateCall(cttzFunc, {value, ConstantInt::getFalse(getContext())});
683}
684
685Value * CBuilder::CreateCountReverseZeroes(Value * value) {
686    Value * ctlzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctlz, value->getType());
687    return CreateCall(ctlzFunc, {value, ConstantInt::getFalse(getContext())});
688}
689
690Value * CBuilder::CreateResetLowestBit(Value * bits) {
691    return CreateAnd(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
692}
693
694Value * CBuilder::CreateIsolateLowestBit(Value * bits) {
695    return CreateAnd(bits, CreateNeg(bits));
696}
697
698Value * CBuilder::CreateMaskToLowestBitInclusive(Value * bits) {
699    return CreateXor(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
700}
701
702Value * CBuilder::CreateMaskToLowestBitExclusive(Value * bits) {
703    return CreateAnd(CreateSub(bits, ConstantInt::get(bits->getType(), 1)), CreateNot(bits));
704}
705
706Value * CBuilder::CreateExtractBitField(llvm::Value * bits, Value * start, Value * length) {
707    Constant * One = ConstantInt::get(bits->getType(), 1);
708    return CreateAnd(CreateLShr(bits, start), CreateSub(CreateShl(One, length), One));
709}
710
711Value * CBuilder::CreateCeilLog2(Value * value) {
712    IntegerType * ty = cast<IntegerType>(value->getType());
713    CreateAssert(value, "CreateCeilLog2: value cannot be zero");
714    Value * m = CreateCountReverseZeroes(CreateSub(value, ConstantInt::get(ty, 1)));
715    return CreateSub(ConstantInt::get(m->getType(), ty->getBitWidth() - 1), m);
716}
717
718Value * CBuilder::GetString(StringRef Str) {
719    Module * const m = getModule();
720    Value * ptr = m->getGlobalVariable(Str, true);
721    if (ptr == nullptr) {
722        ptr = CreateGlobalString(Str, Str);
723    }
724    Value * zero = getInt32(0);
725    return CreateInBoundsGEP(ptr, { zero, zero });
726}
727
728Value * CBuilder::CreateReadCycleCounter() {
729    Module * const m = getModule();
730    Value * cycleCountFunc = Intrinsic::getDeclaration(m, Intrinsic::readcyclecounter);
731    return CreateCall(cycleCountFunc, std::vector<Value *>({}));
732}
733
734Function * CBuilder::LinkFunction(llvm::StringRef name, FunctionType * type, void * functionPtr) const {
735    assert (mDriver);
736    return mDriver->addLinkFunction(getModule(), name, type, functionPtr);
737}
738
739CBuilder::CBuilder(llvm::LLVMContext & C, const unsigned GeneralRegisterWidthInBits)
740: IRBuilder<>(C)
741, mCacheLineAlignment(64)
742, mSizeType(getIntNTy(GeneralRegisterWidthInBits))
743, mFILEtype(nullptr)
744, mDriver(nullptr) {
745
746}
Note: See TracBrowser for help on using the repository browser.