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

Last change on this file since 5924 was 5924, checked in by cameron, 13 months ago

Various cleanups

File size: 57.5 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/Mangler.h>
9#include <llvm/IR/Module.h>
10#include <llvm/IR/Constants.h>
11#include <llvm/IR/Intrinsics.h>
12#include <llvm/IR/TypeBuilder.h>
13#include <llvm/IR/MDBuilder.h>
14#include <llvm/Support/raw_ostream.h>
15#include <llvm/Support/Format.h>
16#include <toolchain/toolchain.h>
17#include <toolchain/driver.h>
18#include <set>
19#include <thread>
20#include <stdlib.h>
21#include <sys/mman.h>
22#include <unistd.h>
23#include <stdio.h>
24
25#if defined(__i386__)
26typedef uint32_t unw_word_t;
27#else
28typedef uint64_t unw_word_t;
29#endif
30#if defined(HAS_MACH_VM_TYPES)
31#include <mach/vm_types.h>
32extern void _thread_stack_pcs(vm_address_t *buffer, unsigned max, unsigned *nb, unsigned skip);
33static_assert(sizeof(vm_address_t) == sizeof(uintptr_t), "");
34#elif defined(HAS_LIBUNWIND)
35#define UNW_LOCAL_ONLY
36#include <libunwind.h>
37static_assert(sizeof(unw_word_t) <= sizeof(uintptr_t), "");
38#elif defined(HAS_EXECINFO)
39#include <execinfo.h>
40static_assert(sizeof(void *) == sizeof(uintptr_t), "");
41#endif
42
43
44#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
45#define setReturnDoesNotAlias() setDoesNotAlias(0)
46#endif
47
48
49using namespace llvm;
50
51inline static bool is_power_2(const uint64_t n) {
52    return ((n & (n - 1)) == 0) && n;
53}
54
55#ifdef HAS_ADDRESS_SANITIZER
56Value * checkHeapAddress(CBuilder * const b, Value * const Ptr, Value * const Size) {
57    Module * const m = b->getModule();
58    PointerType * const voidPtrTy = b->getVoidPtrTy();
59    IntegerType * const sizeTy = b->getSizeTy();
60    Function * isPoisoned = m->getFunction("__asan_region_is_poisoned");
61    if (LLVM_UNLIKELY(isPoisoned == nullptr)) {
62        isPoisoned = Function::Create(FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy}, false), Function::ExternalLinkage, "__asan_region_is_poisoned", m);
63        isPoisoned->setCallingConv(CallingConv::C);
64        isPoisoned->setReturnDoesNotAlias();
65        #if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
66        isPoisoned->setDoesNotAlias(1);
67        #endif
68    }
69    Value * const addr = b->CreatePointerCast(Ptr, voidPtrTy);
70    Value * check = b->CreateCall(isPoisoned, { addr, b->CreateTrunc(Size, sizeTy) });
71    return b->CreateICmpEQ(check, ConstantPointerNull::get(cast<PointerType>(isPoisoned->getReturnType())));
72}
73#define CHECK_HEAP_ADDRESS(Ptr, Size, Name) \
74if (LLVM_UNLIKELY(hasAddressSanitizer())) { \
75    CreateAssert(checkHeapAddress(this, Ptr, Size), Name " was given unallocated memory address"); \
76}
77#else
78#define CHECK_HEAP_ADDRESS(Ptr, Size, Name)
79#endif
80
81static AllocaInst * resolveStackAddress(Value * Ptr) {
82    for (;;) {
83        if (GetElementPtrInst * gep = dyn_cast<GetElementPtrInst>(Ptr)) {
84            Ptr = gep->getPointerOperand();
85        } else if (CastInst * ci = dyn_cast<CastInst>(Ptr)) {
86            Ptr = ci->getOperand(0);
87        } else {
88            return dyn_cast<AllocaInst>(Ptr);
89        }
90    }
91}
92
93static Value * checkStackAddress(CBuilder * const b, Value * const Ptr, Value * const Size, AllocaInst * const Base) {
94    DataLayout DL(b->getModule());
95    IntegerType * const intPtrTy = cast<IntegerType>(DL.getIntPtrType(Ptr->getType()));
96    Value * sz = ConstantExpr::getBitCast(ConstantExpr::getSizeOf(Base->getAllocatedType()), intPtrTy);
97    if (dyn_cast_or_null<Constant>(Base->getArraySize()) && !cast<Constant>(Base->getArraySize())->isNullValue()) {
98        sz = b->CreateMul(sz, b->CreateZExtOrTrunc(Base->getArraySize(), intPtrTy));
99    }
100    Value * const p = b->CreatePtrToInt(Ptr, intPtrTy);
101    Value * const s = b->CreatePtrToInt(Base, intPtrTy);
102    Value * const w = b->CreateAdd(p, b->CreateZExtOrTrunc(Size, intPtrTy));
103    Value * const e = b->CreateAdd(s, sz);
104    return b->CreateAnd(b->CreateICmpUGE(p, s), b->CreateICmpULE(w, e));
105}
106
107#define CHECK_ADDRESS(Ptr, Size, Name) \
108    CreateAssert(Ptr, Name " was given a null address"); \
109    if (AllocaInst * Base = resolveStackAddress(Ptr)) { \
110        CreateAssert(checkStackAddress(this, Ptr, Size, Base), Name " was given an invalid stack address"); \
111    } else { \
112        CHECK_HEAP_ADDRESS(Ptr, Size, Name) \
113    }
114
115Value * CBuilder::CreateURem(Value * const number, Value * const divisor, const Twine & Name) {
116    if (ConstantInt * c = dyn_cast<ConstantInt>(divisor)) {
117        const auto d = c->getZExtValue();
118        assert ("CreateURem divisor cannot be 0!" && d);
119        if (is_power_2(d)) {
120            return CreateAnd(number, ConstantInt::get(divisor->getType(), d - 1), Name);
121        }
122    }
123    CreateAssert(divisor, "CreateURem divisor cannot be 0!");
124    return Insert(BinaryOperator::CreateURem(number, divisor), Name);
125}
126
127Value * CBuilder::CreateUDiv(Value * const number, Value * const divisor, const Twine & Name) {
128    if (ConstantInt * c = dyn_cast<ConstantInt>(divisor)) {
129        const auto d = c->getZExtValue();
130        assert ("CreateUDiv divisor cannot be 0!" && d);
131        if (is_power_2(d)) {
132            if (d > 1) {
133                return CreateLShr(number, ConstantInt::get(divisor->getType(), std::log2(d)), Name);
134            } else {
135                return number;
136            }
137        }
138    }
139    CreateAssert(divisor, "CreateUDiv divisor cannot be 0!");
140    return Insert(BinaryOperator::CreateUDiv(number, divisor), Name);
141}
142
143Value * CBuilder::CreateUDivCeil(Value * const number, Value * const divisor, const Twine & Name) {
144    assert (number->getType() == divisor->getType());
145    Type * const t = number->getType();
146    Value * const n = CreateAdd(number, CreateSub(divisor, ConstantInt::get(t, 1)));
147    if (isa<ConstantInt>(divisor)) {
148        const auto d = cast<ConstantInt>(divisor)->getZExtValue();
149        if (is_power_2(d)) {
150            if (d > 1) {
151                return CreateLShr(n, ConstantInt::get(t, std::log2(d)), Name);
152            } else {
153                return number;
154            }
155        }
156    }
157    CreateAssert(divisor, "CreateUDivCeil divisor cannot be 0!");
158    return CreateUDiv(n, divisor, Name);
159}
160
161Value * CBuilder::CreateRoundUp(Value * const number, Value * const divisor, const Twine &Name) {
162    return CreateMul(CreateUDivCeil(number, divisor), divisor, Name);
163}
164
165Value * CBuilder::CreateOpenCall(Value * filename, Value * oflag, Value * mode) {
166    Module * const m = getModule();
167    Function * openFn = m->getFunction("open");
168    if (openFn == nullptr) {
169        IntegerType * const int32Ty = getInt32Ty();
170        PointerType * const int8PtrTy = getInt8PtrTy();
171        openFn = cast<Function>(m->getOrInsertFunction("open",
172                                                         int32Ty, int8PtrTy, int32Ty, int32Ty, nullptr));
173    }
174    return CreateCall(openFn, {filename, oflag, mode});
175}
176
177// ssize_t write(int fildes, const void *buf, size_t nbyte);
178Value * CBuilder::CreateWriteCall(Value * fileDescriptor, Value * buf, Value * nbyte) {
179    PointerType * const voidPtrTy = getVoidPtrTy();
180    Module * const m = getModule();
181    Function * write = m->getFunction("write");
182    if (write == nullptr) {
183        IntegerType * const sizeTy = getSizeTy();
184        IntegerType * const int32Ty = getInt32Ty();
185        write = cast<Function>(m->getOrInsertFunction("write",
186#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
187        AttributeSet().addAttribute(getContext(), 2U, Attribute::NoAlias),
188#else
189        AttributeList().addAttribute(getContext(), 2U, Attribute::NoAlias),
190#endif
191        sizeTy, int32Ty, voidPtrTy, sizeTy, nullptr));
192    }
193    buf = CreatePointerCast(buf, voidPtrTy);
194    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
195        CHECK_ADDRESS(buf, nbyte, "CreateWriteCall");
196    }
197    return CreateCall(write, {fileDescriptor, buf, nbyte});
198}
199
200Value * CBuilder::CreateReadCall(Value * fileDescriptor, Value * buf, Value * nbyte) {
201    PointerType * const voidPtrTy = getVoidPtrTy();
202    Module * const m = getModule();
203    Function * readFn = m->getFunction("read");
204    if (readFn == nullptr) {
205        IntegerType * const sizeTy = getSizeTy();
206        IntegerType * const int32Ty = getInt32Ty();
207        readFn = cast<Function>(m->getOrInsertFunction("read",
208#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
209        AttributeSet().addAttribute(getContext(), 2U, Attribute::NoAlias),
210#else
211        AttributeList().addAttribute(getContext(), 2U, Attribute::NoAlias),
212#endif
213        sizeTy, int32Ty, voidPtrTy, sizeTy, nullptr));
214    }
215    buf = CreatePointerCast(buf, voidPtrTy);
216    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
217        CHECK_ADDRESS(buf, nbyte, "CreateReadCall");
218    }
219    return CreateCall(readFn, {fileDescriptor, buf, nbyte});
220}
221
222Value * CBuilder::CreateCloseCall(Value * fileDescriptor) {
223    Module * const m = getModule();
224    Function * closeFn = m->getFunction("close");
225    if (closeFn == nullptr) {
226        IntegerType * int32Ty = getInt32Ty();
227        FunctionType * fty = FunctionType::get(int32Ty, {int32Ty}, true);
228        closeFn = Function::Create(fty, Function::ExternalLinkage, "close", m);
229    }
230    return CreateCall(closeFn, fileDescriptor);
231}
232
233Value * CBuilder::CreateUnlinkCall(Value * path) {
234    Module * const m = getModule();
235    Function * unlinkFunc = m->getFunction("unlink");
236    if (unlinkFunc == nullptr) {
237        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, false);
238        unlinkFunc = Function::Create(fty, Function::ExternalLinkage, "unlink", m);
239        unlinkFunc->setCallingConv(CallingConv::C);
240    }
241    return CreateCall(unlinkFunc, path);
242}
243
244Value * CBuilder::CreateMkstempCall(Value * ftemplate) {
245    Module * const m = getModule();
246    Function * mkstempFn = m->getFunction("mkstemp");
247    if (mkstempFn == nullptr) {
248        mkstempFn = cast<Function>(m->getOrInsertFunction("mkstemp", getInt32Ty(), getInt8PtrTy(), nullptr));
249    }
250    return CreateCall(mkstempFn, ftemplate);
251}
252
253Value * CBuilder::CreateStrlenCall(Value * str) {
254    Module * const m = getModule();
255    Function * strlenFn = m->getFunction("strlen");
256    if (strlenFn == nullptr) {
257        strlenFn = cast<Function>(m->getOrInsertFunction("strlen", getSizeTy(), getInt8PtrTy(), nullptr));
258    }
259    return CreateCall(strlenFn, str);
260}
261
262Function * CBuilder::GetPrintf() {
263    Module * const m = getModule();
264    Function * printf = m->getFunction("printf");
265    if (printf == nullptr) {
266        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, true);
267        printf = Function::Create(fty, Function::ExternalLinkage, "printf", m);
268        printf->addAttribute(1, Attribute::NoAlias);
269    }
270    return printf;
271}
272
273Function * CBuilder::GetDprintf() {
274    Module * const m = getModule();
275    Function * dprintf = m->getFunction("dprintf");
276    if (dprintf == nullptr) {
277        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt32Ty(), getInt8PtrTy()}, true);
278        dprintf = Function::Create(fty, Function::ExternalLinkage, "dprintf", m);
279    }
280    return dprintf;
281}
282
283void CBuilder::CallPrintInt(const std::string & name, Value * const value) {
284    Module * const m = getModule();
285    Constant * printRegister = m->getFunction("PrintInt");
286    IntegerType * int64Ty = getInt64Ty();
287    if (LLVM_UNLIKELY(printRegister == nullptr)) {
288        FunctionType *FT = FunctionType::get(getVoidTy(), { getInt8PtrTy(), int64Ty }, false);
289        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintInt", m);
290        auto arg = function->arg_begin();
291        std::string out = "%-40s = %" PRIx64 "\n";
292        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
293        IRBuilder<> builder(entry);
294        std::vector<Value *> args;
295        args.push_back(GetString(out.c_str()));
296        Value * const name = &*(arg++);
297        name->setName("name");
298        args.push_back(name);
299        Value * value = &*arg;
300        value->setName("value");
301        args.push_back(value);
302        builder.CreateCall(GetPrintf(), args);
303        builder.CreateRetVoid();
304
305        printRegister = function;
306    }
307    Value * num = nullptr;
308    if (value->getType()->isPointerTy()) {
309        num = CreatePtrToInt(value, int64Ty);
310    } else {
311        num = CreateZExtOrBitCast(value, int64Ty);
312    }
313    assert (num->getType()->isIntegerTy());
314    CreateCall(printRegister, {GetString(name.c_str()), num});
315}
316
317void CBuilder::CallPrintIntToStderr(const std::string & name, Value * const value) {
318    Module * const m = getModule();
319    Constant * printRegister = m->getFunction("PrintIntToStderr");
320    if (LLVM_UNLIKELY(printRegister == nullptr)) {
321        FunctionType *FT = FunctionType::get(getVoidTy(), { PointerType::get(getInt8Ty(), 0), getSizeTy() }, false);
322        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintIntToStderr", m);
323        auto arg = function->arg_begin();
324        std::string out = "%-40s = %" PRIx64 "\n";
325        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
326        IRBuilder<> builder(entry);
327        std::vector<Value *> args;
328        args.push_back(getInt32(STDERR_FILENO));
329        args.push_back(GetString(out.c_str()));
330        Value * const name = &*(arg++);
331        name->setName("name");
332        args.push_back(name);
333        Value * value = &*arg;
334        value->setName("value");
335        args.push_back(value);
336        builder.CreateCall(GetDprintf(), args);
337        builder.CreateRetVoid();
338
339        printRegister = function;
340    }
341    Value * num = nullptr;
342    if (value->getType()->isPointerTy()) {
343        num = CreatePtrToInt(value, getSizeTy());
344    } else {
345        num = CreateZExtOrBitCast(value, getSizeTy());
346    }
347    assert (num->getType()->isIntegerTy());
348    CreateCall(printRegister, {GetString(name.c_str()), num});
349}
350
351void CBuilder::CallPrintMsgToStderr(const std::string & message) {
352    Module * const m = getModule();
353    Constant * printMsg = m->getFunction("PrintMsgToStderr");
354    if (LLVM_UNLIKELY(printMsg == nullptr)) {
355        FunctionType *FT = FunctionType::get(getVoidTy(), { PointerType::get(getInt8Ty(), 0) }, false);
356        Function * function = Function::Create(FT, Function::InternalLinkage, "PrintMsgToStderr", m);
357        auto arg = function->arg_begin();
358        std::string out = "%s\n";
359        BasicBlock * entry = BasicBlock::Create(getContext(), "entry", function);
360        IRBuilder<> builder(entry);
361        std::vector<Value *> args;
362        args.push_back(getInt32(STDERR_FILENO));
363        args.push_back(GetString(out));
364        Value * const msg = &*(arg++);
365        msg->setName("msg");
366        args.push_back(msg);
367        builder.CreateCall(GetDprintf(), args);
368        builder.CreateRetVoid();
369
370        printMsg = function;
371    }
372    CreateCall(printMsg, {GetString(message.c_str())});
373}
374
375Value * CBuilder::CreateMalloc(Value * size) {
376    Module * const m = getModule();
377    IntegerType * const sizeTy = getSizeTy();   
378    Function * f = m->getFunction("malloc");
379    if (f == nullptr) {
380        PointerType * const voidPtrTy = getVoidPtrTy();
381        FunctionType * fty = FunctionType::get(voidPtrTy, {sizeTy}, false);
382        f = Function::Create(fty, Function::ExternalLinkage, "malloc", m);
383        f->setCallingConv(CallingConv::C);
384        f->setReturnDoesNotAlias();
385    }
386    size = CreateZExtOrTrunc(size, sizeTy);
387    CallInst * const ptr = CreateCall(f, size);
388    CreateAssert(ptr, "CreateMalloc: returned null pointer");
389    return ptr;
390}
391
392Value * CBuilder::CreateAlignedMalloc(Value * size, const unsigned alignment) {
393    if (LLVM_UNLIKELY(!is_power_2(alignment))) {
394        report_fatal_error("CreateAlignedMalloc: alignment must be a power of 2");
395    }
396    Module * const m = getModule();
397    IntegerType * const sizeTy = getSizeTy();
398    PointerType * const voidPtrTy = getVoidPtrTy();
399    ConstantInt * const align = ConstantInt::get(sizeTy, alignment);
400    ConstantInt * const alignMask = ConstantInt::get(sizeTy, alignment - 1);
401    size = CreateZExtOrTrunc(size, sizeTy);
402    Value * const offset = CreateAnd(size, alignMask);
403    size = CreateSelect(CreateIsNull(offset), size, CreateAdd(size, CreateXor(offset, alignMask)));
404    CreateAssertZero(CreateURem(size, align), "CreateAlignedMalloc: size must be an integral multiple of alignment.");
405    Value * ptr = nullptr;
406    if (hasAlignedAlloc()) {
407        Function * f = m->getFunction("aligned_alloc");
408        if (LLVM_UNLIKELY(f == nullptr)) {
409            FunctionType * const fty = FunctionType::get(voidPtrTy, {sizeTy, sizeTy}, false);
410            f = Function::Create(fty, Function::ExternalLinkage, "aligned_alloc", m);
411            f->setCallingConv(CallingConv::C);
412            f->setReturnDoesNotAlias();
413        }
414        ptr = CreateCall(f, {align, size});
415    } else if (hasPosixMemalign()) {
416        Function * f = m->getFunction("posix_memalign");
417        if (LLVM_UNLIKELY(f == nullptr)) {
418            FunctionType * const fty = FunctionType::get(getInt32Ty(), {voidPtrTy->getPointerTo(), sizeTy, sizeTy}, false);
419            f = Function::Create(fty, Function::ExternalLinkage, "posix_memalign", m);
420            f->setCallingConv(CallingConv::C);
421        }
422        Value * handle = CreateAlloca(voidPtrTy);
423        CallInst * success = CreateCall(f, {handle, align, size});
424        if (codegen::DebugOptionIsSet(codegen::EnableAsserts)) {
425            CreateAssertZero(success, "CreateAlignedMalloc: posix_memalign reported bad allocation");
426        }
427        ptr = CreateLoad(handle);
428    } else {
429        report_fatal_error("stdlib.h does not contain either aligned_alloc or posix_memalign");
430    }
431    CreateAssert(ptr, "CreateAlignedMalloc: returned null pointer.");
432    return ptr;
433}
434
435inline bool CBuilder::hasAlignedAlloc() const {
436    return mDriver && mDriver->hasExternalFunction("aligned_alloc");
437}
438
439
440inline bool CBuilder::hasPosixMemalign() const {
441    return mDriver && mDriver->hasExternalFunction("posix_memalign");
442}
443
444Value * CBuilder::CreateRealloc(Value * const ptr, Value * const size) {
445    Module * const m = getModule();
446    IntegerType * const sizeTy = getSizeTy();
447    PointerType * const voidPtrTy = getVoidPtrTy();
448    Function * f = m->getFunction("realloc");
449    if (f == nullptr) {
450        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy}, false);
451        f = Function::Create(fty, Function::ExternalLinkage, "realloc", m);
452        f->setCallingConv(CallingConv::C);
453        f->setReturnDoesNotAlias();
454#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
455        f->setDoesNotAlias(1);
456#endif
457    }
458    CallInst * const ci = CreateCall(f, {CreatePointerCast(ptr, voidPtrTy), CreateZExtOrTrunc(size, sizeTy)});
459    return CreatePointerCast(ci, ptr->getType());
460}
461
462void CBuilder::CreateFree(Value * const ptr) {
463    assert (ptr->getType()->isPointerTy());
464    Module * const m = getModule();
465    Type * const voidPtrTy =  getVoidPtrTy();
466    Function * f = m->getFunction("free");
467    if (f == nullptr) {
468        FunctionType * fty = FunctionType::get(getVoidTy(), {voidPtrTy}, false);
469        f = Function::Create(fty, Function::ExternalLinkage, "free", m);
470        f->setCallingConv(CallingConv::C);
471    }
472    CreateCall(f, CreatePointerCast(ptr, voidPtrTy));
473}
474
475Value * CBuilder::CreateAnonymousMMap(Value * size) {
476    PointerType * const voidPtrTy = getVoidPtrTy();
477    IntegerType * const intTy = getInt32Ty();
478    IntegerType * const sizeTy = getSizeTy();
479    size = CreateZExtOrTrunc(size, sizeTy);
480    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ | PROT_WRITE);
481    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE | MAP_ANON);
482    ConstantInt * const fd =  ConstantInt::get(intTy, -1);
483    Constant * const offset = ConstantInt::get(sizeTy, 0);
484    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
485}
486
487Value * CBuilder::CreateFileSourceMMap(Value * fd, Value * size) {
488    PointerType * const voidPtrTy = getVoidPtrTy();
489    IntegerType * const intTy = getInt32Ty();
490    fd = CreateZExtOrTrunc(fd, intTy);
491    IntegerType * const sizeTy = getSizeTy();
492    size = CreateZExtOrTrunc(size, sizeTy);
493    ConstantInt * const prot =  ConstantInt::get(intTy, PROT_READ);
494    ConstantInt * const flags =  ConstantInt::get(intTy, MAP_PRIVATE);
495    Constant * const offset = ConstantInt::get(sizeTy, 0);       
496    return CreateMMap(ConstantPointerNull::getNullValue(voidPtrTy), size, prot, flags, fd, offset);
497}
498
499Value * CBuilder::CreateMMap(Value * const addr, Value * size, Value * const prot, Value * const flags, Value * const fd, Value * const offset) {
500    Module * const m = getModule();
501    Function * fMMap = m->getFunction("mmap");
502    if (LLVM_UNLIKELY(fMMap == nullptr)) {
503        PointerType * const voidPtrTy = getVoidPtrTy();
504        IntegerType * const intTy = getInt32Ty();
505        IntegerType * const sizeTy = getSizeTy();
506        FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, intTy, intTy, intTy, sizeTy}, false);
507        fMMap = Function::Create(fty, Function::ExternalLinkage, "mmap", m);
508    }
509    Value * ptr = CreateCall(fMMap, {addr, size, prot, flags, fd, offset});
510    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
511        DataLayout DL(m);
512        IntegerType * const intTy = getIntPtrTy(DL);
513        Value * success = CreateICmpNE(CreatePtrToInt(addr, intTy), ConstantInt::getAllOnesValue(intTy)); // MAP_FAILED = -1
514        CreateAssert(success, "CreateMMap: mmap failed to allocate memory");
515    }
516    return ptr;
517}
518
519/**
520 * @brief CBuilder::CreateMAdvise
521 * @param addr
522 * @param length
523 * @param advice
524 *
525 * Note: this funcition can fail if a kernel resource was temporarily unavailable. Test if this is more than a simple hint and handle accordingly.
526 *
527 *  ADVICE_NORMAL
528 *      No special treatment. This is the default.
529 *  ADVICE_RANDOM
530 *      Expect page references in random order. (Hence, read ahead may be less useful than normally.)
531 *  ADVICE_SEQUENTIAL
532 *      Expect page references in sequential order. (Hence, pages in the given range can be aggressively read ahead, and may be freed
533 *      soon after they are accessed.)
534 *  ADVICE_WILLNEED
535 *      Expect access in the near future. (Hence, it might be a good idea to read some pages ahead.)
536 *  ADVICE_DONTNEED
537 *      Do not expect access in the near future. (For the time being, the application is finished with the given range, so the kernel
538 *      can free resources associated with it.) Subsequent accesses of pages in this range will succeed, but will result either in
539 *      reloading of the memory contents from the underlying mapped file (see mmap(2)) or zero-fill-on-demand pages for mappings
540 *      without an underlying file.
541 *
542 * @return Value indicating success (0) or failure (-1).
543 */
544Value * CBuilder::CreateMAdvise(Value * addr, Value * length, Advice advice) {
545    Triple T(mTriple);
546    Value * result = nullptr;
547    if (T.isOSLinux() || T.isOSDarwin()) {
548        Module * const m = getModule();
549        IntegerType * const intTy = getInt32Ty();
550        IntegerType * const sizeTy = getSizeTy();
551        PointerType * const voidPtrTy = getVoidPtrTy();
552        Function * MAdviseFunc = m->getFunction("madvise");
553        if (LLVM_UNLIKELY(MAdviseFunc == nullptr)) {
554            FunctionType * fty = FunctionType::get(intTy, {voidPtrTy, sizeTy, intTy}, false);
555            MAdviseFunc = Function::Create(fty, Function::ExternalLinkage, "madvise", m);
556        }
557        addr = CreatePointerCast(addr, voidPtrTy);
558        length = CreateZExtOrTrunc(length, sizeTy);
559        int madv_flag = 0;
560        switch (advice) {
561            case Advice::ADVICE_NORMAL:
562                madv_flag = MADV_NORMAL; break;
563            case Advice::ADVICE_RANDOM:
564                madv_flag = MADV_RANDOM; break;
565            case Advice::ADVICE_SEQUENTIAL:
566                madv_flag = MADV_SEQUENTIAL; break;
567            case Advice::ADVICE_WILLNEED:
568                madv_flag = MADV_WILLNEED; break;
569            case Advice::ADVICE_DONTNEED:
570                madv_flag = MADV_DONTNEED; break;
571        }
572        result = CreateCall(MAdviseFunc, {addr, length, ConstantInt::get(intTy, madv_flag)});
573    }
574    return result;
575}
576
577#ifndef MREMAP_MAYMOVE
578#define MREMAP_MAYMOVE  1
579#endif
580
581Value * CBuilder::CreateMRemap(Value * addr, Value * oldSize, Value * newSize) {
582    Triple T(mTriple);
583    Value * ptr = nullptr;
584    if (T.isOSLinux()) {
585        Module * const m = getModule();
586        DataLayout DL(m);
587        PointerType * const voidPtrTy = getVoidPtrTy();
588        IntegerType * const sizeTy = getSizeTy();
589        IntegerType * const intTy = getIntPtrTy(DL);
590        Function * fMRemap = m->getFunction("mremap");
591        if (LLVM_UNLIKELY(fMRemap == nullptr)) {
592            FunctionType * fty = FunctionType::get(voidPtrTy, {voidPtrTy, sizeTy, sizeTy, intTy}, false);
593            fMRemap = Function::Create(fty, Function::ExternalLinkage, "mremap", m);
594        }
595        addr = CreatePointerCast(addr, voidPtrTy);
596        oldSize = CreateZExtOrTrunc(oldSize, sizeTy);
597        newSize = CreateZExtOrTrunc(newSize, sizeTy);
598        ConstantInt * const flags = ConstantInt::get(intTy, MREMAP_MAYMOVE);
599        ptr = CreateCall(fMRemap, {addr, oldSize, newSize, flags});
600        if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
601            Value * success = CreateICmpNE(CreatePtrToInt(addr, intTy), ConstantInt::getAllOnesValue(intTy)); // MAP_FAILED = -1
602            CreateAssert(success, "CreateMRemap: mremap failed to allocate memory");
603        }
604    } else { // no OS mremap support
605        ptr = CreateAnonymousMMap(newSize);
606        CreateMemCpy(ptr, addr, oldSize, getpagesize());
607        CreateMUnmap(addr, oldSize);
608    }
609    return ptr;
610}
611
612Value * CBuilder::CreateMUnmap(Value * addr, Value * len) {
613    IntegerType * const sizeTy = getSizeTy();
614    PointerType * const voidPtrTy = getVoidPtrTy();
615    Module * const m = getModule();
616    Function * munmapFunc = m->getFunction("munmap");
617    if (LLVM_UNLIKELY(munmapFunc == nullptr)) {
618        FunctionType * const fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy}, false);
619        munmapFunc = Function::Create(fty, Function::ExternalLinkage, "munmap", m);
620    }
621    len = CreateZExtOrTrunc(len, sizeTy);
622    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
623        DataLayout DL(getModule());
624        IntegerType * const intPtrTy = getIntPtrTy(DL);
625        CreateAssert(len, "CreateMUnmap: length cannot be 0");
626        Value * const addrValue = CreatePtrToInt(addr, intPtrTy);
627        Value * const pageOffset = CreateURem(addrValue, ConstantInt::get(intPtrTy, getpagesize()));
628        CreateAssertZero(pageOffset, "CreateMUnmap: addr must be a multiple of the page size");
629        Value * const boundCheck = CreateICmpULT(addrValue, CreateSub(ConstantInt::getAllOnesValue(intPtrTy), CreateZExtOrTrunc(len, intPtrTy)));
630        CreateAssert(boundCheck, "CreateMUnmap: addresses in [addr, addr+len) are outside the valid address space range");
631    }
632    addr = CreatePointerCast(addr, voidPtrTy);
633    return CreateCall(munmapFunc, {addr, len});
634}
635
636Value * CBuilder::CreateMProtect(Value * addr, Value * size, const int protect) {
637    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
638        // mprotect() changes the access protections for the calling process's
639        // memory pages containing any part of the address range in the interval
640        // [addr, addr+len-1].  addr must be aligned to a page boundary.
641
642        // mprotect(): POSIX.1-2001, POSIX.1-2008, SVr4.  POSIX says that the
643        // behavior of mprotect() is unspecified if it is applied to a region of
644        // memory that was not obtained via mmap(2).
645
646        // On Linux, it is always permissible to call mprotect() on any address
647        // in a process's address space (except for the kernel vsyscall area).
648        // In particular, it can be used to change existing code mappings to be
649        // writable.
650
651//        Triple T(mTriple);
652//        if (!T.isOSLinux()) {
653//            DataLayout DL(getModule());
654//            IntegerType * const intPtrTy = getIntPtrTy(DL);
655//            Value * a = CreatePtrToInt(addr, intPtrTy);
656//            Constant * const pageSize = ConstantInt::get(intPtrTy, getpagesize());
657//            CreateAssertZero(CreateURem(a, pageSize), "CreateMProtect: addr must be aligned to page boundary on non-Linux architectures");
658//        }
659    }
660
661    IntegerType * const sizeTy = getSizeTy();
662    PointerType * const voidPtrTy = getVoidPtrTy();
663    IntegerType * const int32Ty = getInt32Ty();
664
665    Module * const m = getModule();
666    Function * mprotectFunc = m->getFunction("mprotect");
667    if (LLVM_UNLIKELY(mprotectFunc == nullptr)) {
668        FunctionType * const fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, int32Ty}, false);
669        mprotectFunc = Function::Create(fty, Function::ExternalLinkage, "mprotect", m);
670    }
671    addr = CreatePointerCast(addr, voidPtrTy);
672    size = CreateZExtOrTrunc(size, sizeTy);
673    return CreateCall(mprotectFunc, {addr, size, ConstantInt::get(int32Ty, (int)protect)});
674
675}
676
677IntegerType * LLVM_READNONE CBuilder::getIntAddrTy() const {
678    return TypeBuilder<intptr_t, false>::get(getContext());
679}
680
681PointerType * LLVM_READNONE CBuilder::getVoidPtrTy(const unsigned AddressSpace) const {
682    //return PointerType::get(Type::getVoidTy(getContext()), AddressSpace);
683    return PointerType::get(Type::getInt8Ty(getContext()), AddressSpace);
684}
685
686LoadInst * CBuilder::CreateAtomicLoadAcquire(Value * ptr) {
687    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
688    LoadInst * inst = CreateAlignedLoad(ptr, alignment);
689    inst->setOrdering(AtomicOrdering::Acquire);
690    return inst;
691   
692}
693
694StoreInst * CBuilder::CreateAtomicStoreRelease(Value * val, Value * ptr) {
695    const auto alignment = ptr->getType()->getPointerElementType()->getPrimitiveSizeInBits() / 8;
696    StoreInst * inst = CreateAlignedStore(val, ptr, alignment);
697    inst->setOrdering(AtomicOrdering::Release);
698    return inst;
699}
700
701PointerType * LLVM_READNONE CBuilder::getFILEptrTy() {
702    if (mFILEtype == nullptr) {
703        mFILEtype = StructType::create(getContext(), "struct._IO_FILE");
704    }
705    return mFILEtype->getPointerTo();
706}
707
708Value * CBuilder::CreateFOpenCall(Value * filename, Value * mode) {
709    Module * const m = getModule();
710    Function * fOpenFunc = m->getFunction("fopen");
711    if (fOpenFunc == nullptr) {
712        FunctionType * fty = FunctionType::get(getFILEptrTy(), {getInt8Ty()->getPointerTo(), getInt8Ty()->getPointerTo()}, false);
713        fOpenFunc = Function::Create(fty, Function::ExternalLinkage, "fopen", m);
714        fOpenFunc->setCallingConv(CallingConv::C);
715    }
716    return CreateCall(fOpenFunc, {filename, mode});
717}
718
719Value * CBuilder::CreateFReadCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
720    Module * const m = getModule();
721    Function * fReadFunc = m->getFunction("fread");
722    PointerType * const voidPtrTy = getVoidPtrTy();
723    if (fReadFunc == nullptr) {
724        IntegerType * const sizeTy = getSizeTy();
725        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
726        fReadFunc = Function::Create(fty, Function::ExternalLinkage, "fread", m);
727        fReadFunc->setCallingConv(CallingConv::C);
728    }
729    ptr = CreatePointerCast(ptr, voidPtrTy);
730    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
731        CHECK_ADDRESS(ptr, CreateMul(size, nitems), "CreateFReadCall");
732    }
733    return CreateCall(fReadFunc, {ptr, size, nitems, stream});
734}
735
736Value * CBuilder::CreateFWriteCall(Value * ptr, Value * size, Value * nitems, Value * stream) {
737    Module * const m = getModule();
738    Function * fWriteFunc = m->getFunction("fwrite");
739    PointerType * const voidPtrTy = getVoidPtrTy();
740    if (fWriteFunc == nullptr) {
741        IntegerType * const sizeTy = getSizeTy();
742        FunctionType * fty = FunctionType::get(sizeTy, {voidPtrTy, sizeTy, sizeTy, getFILEptrTy()}, false);
743        fWriteFunc = Function::Create(fty, Function::ExternalLinkage, "fwrite", m);
744        fWriteFunc->setCallingConv(CallingConv::C);
745    }
746    ptr = CreatePointerCast(ptr, voidPtrTy);
747    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
748        CHECK_ADDRESS(ptr, CreateMul(size, nitems), "CreateFReadCall");
749    }
750    return CreateCall(fWriteFunc, {ptr, size, nitems, stream});
751}
752
753Value * CBuilder::CreateFCloseCall(Value * stream) {
754    Module * const m = getModule();
755    Function * fCloseFunc = m->getFunction("fclose");
756    if (fCloseFunc == nullptr) {
757        FunctionType * fty = FunctionType::get(getInt32Ty(), {getFILEptrTy()}, false);
758        fCloseFunc = Function::Create(fty, Function::ExternalLinkage, "fclose", m);
759        fCloseFunc->setCallingConv(CallingConv::C);
760    }
761    return CreateCall(fCloseFunc, {stream});
762}
763
764Value * CBuilder::CreateRenameCall(Value * oldName, Value * newName) {
765    Module * const m = getModule();
766    Function * renameFunc = m->getFunction("rename");
767    if (renameFunc == nullptr) {
768        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy(), getInt8PtrTy()}, false);
769        renameFunc = Function::Create(fty, Function::ExternalLinkage, "rename", m);
770        renameFunc->setCallingConv(CallingConv::C);
771    }
772    return CreateCall(renameFunc, {oldName, newName});
773}
774
775Value * CBuilder::CreateRemoveCall(Value * path) {
776    Module * const m = getModule();
777    Function * removeFunc = m->getFunction("remove");
778    if (removeFunc == nullptr) {
779        FunctionType * fty = FunctionType::get(getInt32Ty(), {getInt8PtrTy()}, false);
780        removeFunc = Function::Create(fty, Function::ExternalLinkage, "remove", m);
781        removeFunc->setCallingConv(CallingConv::C);
782    }
783    return CreateCall(removeFunc, {path});
784}
785
786Value * CBuilder::CreatePThreadCreateCall(Value * thread, Value * attr, Function * start_routine, Value * arg) {
787    Module * const m = getModule();
788    Type * const voidPtrTy = getVoidPtrTy();
789    Function * pthreadCreateFunc = m->getFunction("pthread_create");
790    if (pthreadCreateFunc == nullptr) {
791        Type * pthreadTy = getSizeTy();
792        FunctionType * funVoidPtrVoidTy = FunctionType::get(getVoidTy(), {voidPtrTy}, false);
793        FunctionType * fty = FunctionType::get(getInt32Ty(), {pthreadTy->getPointerTo(), voidPtrTy, funVoidPtrVoidTy->getPointerTo(), voidPtrTy}, false);
794        pthreadCreateFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_create", m);
795        pthreadCreateFunc->setCallingConv(CallingConv::C);
796    }
797    return CreateCall(pthreadCreateFunc, {thread, attr, start_routine, CreatePointerCast(arg, voidPtrTy)});
798}
799
800Value * CBuilder::CreatePThreadYield() {
801    Module * const m = getModule();
802    Function * f = m->getFunction("pthread_yield");
803    if (f == nullptr) {
804        FunctionType * fty = FunctionType::get(getInt32Ty(), false);
805        f = Function::Create(fty, Function::ExternalLinkage, "pthread_yield", m);
806        f->setCallingConv(CallingConv::C);
807    }
808    return CreateCall(f);
809}
810
811Value * CBuilder::CreatePThreadExitCall(Value * value_ptr) {
812    Module * const m = getModule();
813    Function * pthreadExitFunc = m->getFunction("pthread_exit");
814    if (pthreadExitFunc == nullptr) {
815        FunctionType * fty = FunctionType::get(getVoidTy(), {getVoidPtrTy()}, false);
816        pthreadExitFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_exit", m);
817        pthreadExitFunc->addFnAttr(Attribute::NoReturn);
818        pthreadExitFunc->setCallingConv(CallingConv::C);
819    }
820    CallInst * exitThread = CreateCall(pthreadExitFunc, {value_ptr});
821    exitThread->setDoesNotReturn();
822    return exitThread;
823}
824
825Value * CBuilder::CreatePThreadJoinCall(Value * thread, Value * value_ptr){
826    Module * const m = getModule();
827    Function * pthreadJoinFunc = m->getFunction("pthread_join");
828    if (pthreadJoinFunc == nullptr) {
829        FunctionType * fty = FunctionType::get(getInt32Ty(), {getSizeTy(), getVoidPtrTy()->getPointerTo()}, false);
830        pthreadJoinFunc = Function::Create(fty, Function::ExternalLinkage, "pthread_join", m);
831        pthreadJoinFunc->setCallingConv(CallingConv::C);
832    }
833    return CreateCall(pthreadJoinFunc, {thread, value_ptr});
834}
835
836void __report_failure(const char * msg, const uintptr_t * trace, const uint32_t n) {
837    raw_fd_ostream out(STDERR_FILENO, false);
838    if (trace) {
839        SmallVector<char, 4096> tmp;
840        raw_svector_ostream trace_string(tmp);
841        for (uint32_t i = 0; i < n; ++i) {
842            const auto pc = trace[i];
843            trace_string << format_hex(pc, 16) << "   ";
844            const auto len = codegen::ProgramName.length() + 32;
845            char cmd[len];
846            snprintf(cmd, len,"addr2line -fpCe %s %p", codegen::ProgramName.data(), reinterpret_cast<void *>(pc));
847            FILE * f = popen(cmd, "r");
848            if (f) {
849                char buffer[1024] = {0};
850                while(fgets(buffer, sizeof(buffer), f)) {
851                    trace_string << buffer;
852                }
853                pclose(f);
854            }
855        }
856        out.changeColor(raw_fd_ostream::WHITE, true);
857        out << "Compilation Stacktrace:\n";
858        out.resetColor();
859        out << trace_string.str();
860    }
861    out.changeColor(raw_fd_ostream::WHITE, true);
862    out << msg << "\n";
863    out.resetColor();
864    out.flush();
865
866}
867
868#if defined(HAS_MACH_VM_TYPES)
869
870/*
871 * Copyright (c) 1999, 2007 Apple Inc. All rights reserved.
872 *
873 * @APPLE_LICENSE_HEADER_START@
874 *
875 * This file contains Original Code and/or Modifications of Original Code
876 * as defined in and that are subject to the Apple Public Source License
877 * Version 2.0 (the 'License'). You may not use this file except in
878 * compliance with the License. Please obtain a copy of the License at
879 * http://www.opensource.apple.com/apsl/ and read it before using this
880 * file.
881 *
882 * The Original Code and all software distributed under the License are
883 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
884 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
885 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
886 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
887 * Please see the License for the specific language governing rights and
888 * limitations under the License.
889 *
890 * @APPLE_LICENSE_HEADER_END@
891 */
892
893#include <pthread.h>
894#include <mach/mach.h>
895#include <mach/vm_statistics.h>
896#include <stdlib.h>
897
898#if defined(__i386__) || defined(__x86_64__)
899#define FP_LINK_OFFSET 1
900#elif defined(__ppc__) || defined(__ppc64__)
901#define FP_LINK_OFFSET 2
902#else
903#error  ********** Unimplemented architecture
904#endif
905
906#define INSTACK(a)      ((uintptr_t)(a) >= stackbot && (uintptr_t)(a) <= stacktop)
907#if defined(__ppc__) || defined(__ppc64__) || defined(__x86_64__)
908#define ISALIGNED(a)    ((((uintptr_t)(a)) & 0xf) == 0)
909#elif defined(__i386__)
910#define ISALIGNED(a)    ((((uintptr_t)(a)) & 0xf) == 8)
911#endif
912
913__private_extern__  __attribute__((noinline))
914void
915_thread_stack_pcs(vm_address_t *buffer, unsigned max, unsigned *nb, unsigned skip)
916{
917    void *frame, *next;
918    pthread_t self = pthread_self();
919    uintptr_t stacktop = (uintptr_t)(pthread_get_stackaddr_np(self));
920    uintptr_t stackbot = stacktop - (uintptr_t)(pthread_get_stacksize_np(self));
921   
922    *nb = 0;
923   
924    /* make sure return address is never out of bounds */
925    stacktop -= (FP_LINK_OFFSET + 1) * sizeof(void *);
926   
927    /*
928     * The original implementation called the first_frame_address() function,
929     * which returned the stack frame pointer.  The problem was that in ppc,
930     * it was a leaf function, so no new stack frame was set up with
931     * optimization turned on (while a new stack frame was set up without
932     * optimization).  We now inline the code to get the stack frame pointer,
933     * so we are consistent about the stack frame.
934     */
935#if defined(__i386__) || defined(__x86_64__)
936    frame = __builtin_frame_address(0);
937#elif defined(__ppc__) || defined(__ppc64__)
938    /* __builtin_frame_address IS BROKEN IN BEAKER: RADAR #2340421 */
939    __asm__ volatile("mr %0, r1" : "=r" (frame));
940#endif
941    if(!INSTACK(frame) || !ISALIGNED(frame))
942        return;
943#if defined(__ppc__) || defined(__ppc64__)
944    /* back up the stack pointer up over the current stack frame */
945    next = *(void **)frame;
946    if(!INSTACK(next) || !ISALIGNED(next) || next <= frame)
947        return;
948    frame = next;
949#endif
950    while (skip--) {
951        next = *(void **)frame;
952        if(!INSTACK(next) || !ISALIGNED(next) || next <= frame)
953            return;
954        frame = next;
955    }
956    while (max--) {
957        buffer[*nb] = *(vm_address_t *)(((void **)frame) + FP_LINK_OFFSET);
958        (*nb)++;
959        next = *(void **)frame;
960        if(!INSTACK(next) || !ISALIGNED(next) || next <= frame)
961            return;
962        frame = next;
963    }
964}
965#endif
966
967void CBuilder::__CreateAssert(Value * const assertion, const Twine & failureMessage) {
968    if (LLVM_UNLIKELY(isa<Constant>(assertion))) {
969        if (LLVM_UNLIKELY(cast<Constant>(assertion)->isNullValue())) {
970            report_fatal_error(failureMessage);
971        }
972    } else if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
973        Module * const m = getModule();
974        Type * const stackTy = TypeBuilder<uintptr_t, false>::get(getContext());
975        PointerType * const stackPtrTy = stackTy->getPointerTo();
976        PointerType * const int8PtrTy = getInt8PtrTy();
977        Function * function = m->getFunction("assert");
978        if (LLVM_UNLIKELY(function == nullptr)) {
979            auto ip = saveIP();
980            IntegerType * const int1Ty = getInt1Ty();
981            FunctionType * fty = FunctionType::get(getVoidTy(), { int1Ty, int8PtrTy, stackPtrTy, getInt32Ty() }, false);
982            function = Function::Create(fty, Function::PrivateLinkage, "assert", m);
983            function->setDoesNotThrow();
984#if LLVM_VERSION_INTEGER < LLVM_VERSION_CODE(5, 0, 0)
985            function->setDoesNotAlias(2);
986#endif
987            BasicBlock * const entry = BasicBlock::Create(getContext(), "", function);
988            BasicBlock * const failure = BasicBlock::Create(getContext(), "", function);
989            BasicBlock * const success = BasicBlock::Create(getContext(), "", function);
990            auto arg = function->arg_begin();
991            arg->setName("assertion");
992            Value * assertion = &*arg++;
993            arg->setName("msg");
994            Value * msg = &*arg++;
995            arg->setName("trace");
996            Value * trace = &*arg++;
997            arg->setName("depth");
998            Value * depth = &*arg++;
999            SetInsertPoint(entry);
1000            IRBuilder<>::CreateCondBr(assertion, success, failure);
1001            IRBuilder<>::SetInsertPoint(failure);
1002            IRBuilder<>::CreateCall(LinkFunction("__report_failure", __report_failure), { msg, trace, depth });
1003            CreateExit(-1);
1004            IRBuilder<>::CreateBr(success); // necessary to satisfy the LLVM verifier. this is never executed.
1005            SetInsertPoint(success);
1006            IRBuilder<>::CreateRetVoid();
1007            restoreIP(ip);
1008        }
1009
1010        SmallVector<unw_word_t, 64> stack;
1011        #if defined(HAS_MACH_VM_TYPES)
1012        for (;;) {
1013            unsigned int n;
1014            _thread_stack_pcs(reinterpret_cast<vm_address_t *>(stack.data()), stack.capacity(), &n, 1);
1015            if (LLVM_UNLIKELY(n < stack.capacity() || stack[n - 1] == 0)) {
1016                while (n >= 1 && stack[n - 1] == 0) {
1017                    n -= 1;
1018                }
1019                stack.set_size(n);
1020                break;
1021            }
1022            stack.reserve(n * 2);
1023        }
1024        #elif defined(HAS_LIBUNWIND)
1025        unw_context_t context;
1026        // Initialize cursor to current frame for local unwinding.
1027        unw_getcontext(&context);
1028        unw_cursor_t cursor;
1029        unw_init_local(&cursor, &context);
1030        // Unwind frames one by one, going up the frame stack.
1031        while (unw_step(&cursor) > 0) {
1032            unw_word_t pc;
1033            unw_get_reg(&cursor, UNW_REG_IP, &pc);
1034            if (pc == 0) {
1035                break;
1036            }
1037            stack.push_back(pc);
1038        }
1039        #elif defined(HAS_EXECINFO)
1040        for (;;) {
1041            const auto n = backtrace(reinterpret_cast<void **>(stack.data()), stack.capacity());
1042            if (LLVM_LIKELY(n < (int)stack.capacity())) {
1043                stack.set_size(n);
1044                break;
1045            }
1046            stack.reserve(n * 2);
1047        }
1048        #endif
1049        Value * trace = nullptr;
1050        ConstantInt * depth = nullptr;
1051        if (stack.empty()) {
1052            trace = ConstantPointerNull::get(stackPtrTy);
1053            depth = getInt32(0);
1054        } else {
1055            const auto n = stack.size() - 1;
1056            for (GlobalVariable & gv : m->getGlobalList()) {
1057                Type * const ty = gv.getValueType();
1058                if (ty->isArrayTy() && ty->getArrayElementType() == stackTy && ty->getArrayNumElements() == n) {
1059                    const ConstantDataArray * const array = cast<ConstantDataArray>(gv.getOperand(0));
1060                    bool found = true;
1061                    for (size_t i = 0; i < n; ++i) {
1062                        if (LLVM_LIKELY(array->getElementAsInteger(i) != stack[i + 1])) {
1063                            found = false;
1064                            break;
1065                        }
1066                    }
1067                    if (LLVM_UNLIKELY(found)) {
1068                        trace = &gv;
1069                        break;
1070                    }
1071                }
1072            }
1073            if (LLVM_LIKELY(trace == nullptr)) {
1074                Constant * const initializer = ConstantDataArray::get(getContext(), ArrayRef<unw_word_t>(stack.data() + 1, n));
1075                trace = new GlobalVariable(*m, initializer->getType(), true, GlobalVariable::InternalLinkage, initializer);
1076            }
1077            trace = CreatePointerCast(trace, stackPtrTy);
1078            depth = getInt32(n);
1079        }       
1080        SmallVector<char, 1024> tmp;
1081        IRBuilder<>::CreateCall(function, {assertion, GetString(failureMessage.toStringRef(tmp)), trace, depth});
1082    } else { // if assertions are not enabled, make it a compiler assumption.
1083
1084        // INVESTIGATE: while interesting, this does not seem to produce faster code and only provides a trivial
1085        // reduction of compiled code size in LLVM 3.8 but nearly doubles compilation time. This may have been
1086        // improved with later versions of LLVM but it's likely that assumptions ought to be hand placed once
1087        // they're proven to improve performance.
1088
1089        // IRBuilder<>::CreateAssumption(assertion);
1090    }
1091}
1092
1093void CBuilder::CreateExit(const int exitCode) {
1094    Module * const m = getModule();
1095    Function * exit = m->getFunction("exit");
1096    if (LLVM_UNLIKELY(exit == nullptr)) {
1097        FunctionType * fty = FunctionType::get(getVoidTy(), {getInt32Ty()}, false);
1098        exit = Function::Create(fty, Function::ExternalLinkage, "exit", m);
1099        exit->setDoesNotReturn();
1100        exit->setDoesNotThrow();
1101    }
1102    CreateCall(exit, getInt32(exitCode));
1103}
1104
1105BasicBlock * CBuilder::CreateBasicBlock(const StringRef name, BasicBlock * insertBefore) {
1106    return BasicBlock::Create(getContext(), name, GetInsertBlock()->getParent(), insertBefore);
1107}
1108
1109bool CBuilder::supportsIndirectBr() const {
1110    return !codegen::DebugOptionIsSet(codegen::DisableIndirectBranch);
1111}
1112
1113BranchInst * CBuilder::CreateLikelyCondBr(Value * Cond, BasicBlock * True, BasicBlock * False, const int probability) {
1114    MDBuilder mdb(getContext());
1115    if (probability < 0 || probability > 100) {
1116        report_fatal_error("branch weight probability must be in [0,100]");
1117    }
1118    return CreateCondBr(Cond, True, False, mdb.createBranchWeights(probability, 100 - probability));
1119}
1120
1121Value * CBuilder::CreatePopcount(Value * bits) {
1122    Value * ctpopFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctpop, bits->getType());
1123    return CreateCall(ctpopFunc, bits);
1124}
1125
1126Value * CBuilder::CreateCountForwardZeroes(Value * value, const bool guaranteedNonZero) {
1127    if (LLVM_UNLIKELY(guaranteedNonZero && codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1128        CreateAssert(value, "CreateCountForwardZeroes: value cannot be zero!");
1129    }
1130    Value * cttzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::cttz, value->getType());   
1131    return CreateCall(cttzFunc, {value, getInt1(guaranteedNonZero)});
1132}
1133
1134Value * CBuilder::CreateCountReverseZeroes(Value * value, const bool guaranteedNonZero) {
1135    if (LLVM_UNLIKELY(guaranteedNonZero && codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1136        CreateAssert(value, "CreateCountReverseZeroes: value cannot be zero!");
1137    }
1138    Value * ctlzFunc = Intrinsic::getDeclaration(getModule(), Intrinsic::ctlz, value->getType());
1139    return CreateCall(ctlzFunc, {value, getInt1(guaranteedNonZero)});
1140}
1141
1142Value * CBuilder::CreateResetLowestBit(Value * bits) {
1143    return CreateAnd(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
1144}
1145
1146Value * CBuilder::CreateIsolateLowestBit(Value * bits) {
1147    return CreateAnd(bits, CreateNeg(bits));
1148}
1149
1150Value * CBuilder::CreateMaskToLowestBitInclusive(Value * bits) {
1151    return CreateXor(bits, CreateSub(bits, ConstantInt::get(bits->getType(), 1)));
1152}
1153
1154Value * CBuilder::CreateMaskToLowestBitExclusive(Value * bits) {
1155    return CreateAnd(CreateSub(bits, ConstantInt::get(bits->getType(), 1)), CreateNot(bits));
1156}
1157
1158Value * CBuilder::CreateExtractBitField(Value * bits, Value * start, Value * length) {
1159    Constant * One = ConstantInt::get(bits->getType(), 1);
1160    return CreateAnd(CreateLShr(bits, start), CreateSub(CreateShl(One, length), One));
1161}
1162
1163Value * CBuilder::CreateCeilLog2(Value * value) {
1164    IntegerType * ty = cast<IntegerType>(value->getType());
1165    Value * m = CreateCountReverseZeroes(CreateSub(value, ConstantInt::get(ty, 1)));
1166    return CreateSub(ConstantInt::get(m->getType(), ty->getBitWidth()), m);
1167}
1168
1169Value * CBuilder::GetString(StringRef Str) {
1170    Module * const m = getModule();
1171    Value * ptr = m->getGlobalVariable(Str, true);
1172    if (ptr == nullptr) {
1173        ptr = CreateGlobalString(Str, Str);
1174    }
1175    Value * zero = getInt32(0);
1176    return CreateInBoundsGEP(ptr, { zero, zero });
1177}
1178
1179Value * CBuilder::CreateReadCycleCounter() {
1180    Module * const m = getModule();
1181    Value * cycleCountFunc = Intrinsic::getDeclaration(m, Intrinsic::readcyclecounter);
1182    return CreateCall(cycleCountFunc, std::vector<Value *>({}));
1183}
1184
1185Function * CBuilder::LinkFunction(StringRef name, FunctionType * type, void * functionPtr) const {
1186    assert (mDriver);
1187    return mDriver->addLinkFunction(getModule(), name, type, functionPtr);
1188}
1189
1190LoadInst * CBuilder::CreateLoad(Value *Ptr, const char * Name) {
1191    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1192        CHECK_ADDRESS(Ptr, ConstantExpr::getSizeOf(Ptr->getType()->getPointerElementType()), "CreateLoad");
1193    }
1194    return IRBuilder<>::CreateLoad(Ptr, Name);
1195}
1196
1197LoadInst * CBuilder::CreateLoad(Value * Ptr, const Twine & Name) {
1198    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1199        CHECK_ADDRESS(Ptr, ConstantExpr::getSizeOf(Ptr->getType()->getPointerElementType()), "CreateLoad");
1200    }
1201    return IRBuilder<>::CreateLoad(Ptr, Name);
1202}
1203
1204LoadInst * CBuilder::CreateLoad(Type * Ty, Value *Ptr, const Twine & Name) {
1205    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1206        CHECK_ADDRESS(Ptr, ConstantExpr::getSizeOf(Ty), "CreateLoad");
1207    }
1208    return IRBuilder<>::CreateLoad(Ty, Ptr, Name);
1209}
1210
1211LoadInst * CBuilder::CreateLoad(Value * Ptr, bool isVolatile, const Twine & Name) {
1212    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1213        CHECK_ADDRESS(Ptr, ConstantExpr::getSizeOf(Ptr->getType()->getPointerElementType()), "CreateLoad");
1214    }
1215    return IRBuilder<>::CreateLoad(Ptr, isVolatile, Name);
1216}
1217
1218StoreInst * CBuilder::CreateStore(Value * Val, Value * Ptr, bool isVolatile) {
1219    assert (Val->getType() == Ptr->getType()->getPointerElementType());
1220    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1221        CHECK_ADDRESS(Ptr, ConstantExpr::getSizeOf(Val->getType()), "CreateStore");
1222    }
1223    return IRBuilder<>::CreateStore(Val, Ptr, isVolatile);
1224}
1225
1226inline bool CBuilder::hasAddressSanitizer() const {
1227    return mDriver && mDriver->hasExternalFunction("__asan_region_is_poisoned");
1228}
1229
1230LoadInst * CBuilder::CreateAlignedLoad(Value * Ptr, unsigned Align, const char * Name) {
1231    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1232        DataLayout DL(getModule());
1233        IntegerType * const intPtrTy = cast<IntegerType>(DL.getIntPtrType(Ptr->getType()));
1234        Value * alignmentOffset = CreateURem(CreatePtrToInt(Ptr, intPtrTy), ConstantInt::get(intPtrTy, Align));
1235        CreateAssertZero(alignmentOffset, "CreateAlignedLoad: pointer is misaligned");
1236    }
1237    LoadInst * LI = CreateLoad(Ptr, Name);
1238    LI->setAlignment(Align);
1239    return LI;
1240}
1241
1242LoadInst * CBuilder::CreateAlignedLoad(Value * Ptr, unsigned Align, const Twine & Name) {
1243    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1244        DataLayout DL(getModule());
1245        IntegerType * const intPtrTy = cast<IntegerType>(DL.getIntPtrType(Ptr->getType()));
1246        Value * alignmentOffset = CreateURem(CreatePtrToInt(Ptr, intPtrTy), ConstantInt::get(intPtrTy, Align));
1247        CreateAssertZero(alignmentOffset, "CreateAlignedLoad: pointer is misaligned");
1248    }
1249    LoadInst * LI = CreateLoad(Ptr, Name);
1250    LI->setAlignment(Align);
1251    return LI;
1252}
1253
1254LoadInst * CBuilder::CreateAlignedLoad(Value * Ptr, unsigned Align, bool isVolatile, const Twine & Name) {
1255    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1256        DataLayout DL(getModule());
1257        IntegerType * const intPtrTy = cast<IntegerType>(DL.getIntPtrType(Ptr->getType()));
1258        Value * alignmentOffset = CreateURem(CreatePtrToInt(Ptr, intPtrTy), ConstantInt::get(intPtrTy, Align));
1259        CreateAssertZero(alignmentOffset, "CreateAlignedLoad: pointer is misaligned");
1260    }
1261    LoadInst * LI = CreateLoad(Ptr, isVolatile, Name);
1262    LI->setAlignment(Align);
1263    return LI;
1264}
1265
1266StoreInst * CBuilder::CreateAlignedStore(Value * Val, Value * Ptr, unsigned Align, bool isVolatile) {
1267    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1268        DataLayout DL(getModule());
1269        IntegerType * const intPtrTy = cast<IntegerType>(DL.getIntPtrType(Ptr->getType()));
1270        Value * alignmentOffset = CreateURem(CreatePtrToInt(Ptr, intPtrTy), ConstantInt::get(intPtrTy, Align));
1271        CreateAssertZero(alignmentOffset, "CreateAlignedStore: pointer is misaligned");
1272    }
1273    StoreInst *SI = CreateStore(Val, Ptr, isVolatile);
1274    SI->setAlignment(Align);
1275    return SI;
1276}
1277
1278CallInst * CBuilder::CreateMemMove(Value * Dst, Value * Src, Value *Size, unsigned Align, bool isVolatile,
1279                                   MDNode *TBAATag, MDNode *ScopeTag, MDNode *NoAliasTag) {
1280    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1281        CHECK_ADDRESS(Src, Size, "CreateMemMove: Src");
1282        CHECK_ADDRESS(Dst, Size, "CreateMemMove: Dst");
1283        // If the call to this intrinisic has an alignment value that is not 0 or 1, then the caller
1284        // guarantees that both the source and destination pointers are aligned to that boundary.
1285        if (Align > 1) {
1286            DataLayout DL(getModule());
1287            IntegerType * const intPtrTy = DL.getIntPtrType(getContext());
1288            Value * intSrc = CreatePtrToInt(Src, intPtrTy);
1289            Value * intDst = CreatePtrToInt(Dst, intPtrTy);
1290            ConstantInt * align = ConstantInt::get(intPtrTy, Align);
1291            CreateAssertZero(CreateURem(intSrc, align), "CreateMemMove: Src pointer is misaligned");
1292            CreateAssertZero(CreateURem(intDst, align), "CreateMemMove: Dst pointer is misaligned");
1293
1294        }
1295    }
1296    return IRBuilder<>::CreateMemMove(Dst, Src, Size, Align, isVolatile, TBAATag, ScopeTag, NoAliasTag);
1297}
1298
1299CallInst * CBuilder::CreateMemCpy(Value *Dst, Value *Src, Value *Size, unsigned Align, bool isVolatile,
1300                                  MDNode *TBAATag, MDNode *TBAAStructTag, MDNode *ScopeTag, MDNode *NoAliasTag) {
1301    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1302        CHECK_ADDRESS(Src, Size, "CreateMemCpy: Src");
1303        CHECK_ADDRESS(Dst, Size, "CreateMemCpy: Dst");
1304        DataLayout DL(getModule());
1305        IntegerType * const intPtrTy = DL.getIntPtrType(getContext());
1306        Value * intSrc = CreatePtrToInt(Src, intPtrTy);
1307        Value * intDst = CreatePtrToInt(Dst, intPtrTy);
1308        // If the call to this intrinisic has an alignment value that is not 0 or 1, then the caller
1309        // guarantees that both the source and destination pointers are aligned to that boundary.
1310        if (Align > 1) {
1311            ConstantInt * align = ConstantInt::get(intPtrTy, Align);
1312            CreateAssertZero(CreateURem(intSrc, align), "CreateMemCpy: Src is misaligned");
1313            CreateAssertZero(CreateURem(intDst, align), "CreateMemCpy: Dst is misaligned");
1314        }
1315        Value * intSize = CreateZExtOrTrunc(Size, intPtrTy);
1316        Value * nonOverlapping = CreateOr(CreateICmpULT(CreateAdd(intSrc, intSize), intDst),
1317                                          CreateICmpULT(CreateAdd(intDst, intSize), intSrc));
1318        CreateAssert(nonOverlapping, "CreateMemCpy: overlapping ranges is undefined");
1319    }
1320    return IRBuilder<>::CreateMemCpy(Dst, Src, Size, Align, isVolatile, TBAATag, TBAAStructTag, ScopeTag, NoAliasTag);
1321}
1322
1323CallInst * CBuilder::CreateMemSet(Value * Ptr, Value * Val, Value * Size, unsigned Align,
1324                       bool isVolatile, MDNode * TBAATag, MDNode * ScopeTag, MDNode * NoAliasTag) {
1325    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::EnableAsserts))) {
1326        CHECK_ADDRESS(Ptr, Size, "CreateMemSet");
1327        if (Align > 1) {
1328            DataLayout DL(getModule());
1329            IntegerType * const intPtrTy = DL.getIntPtrType(getContext());
1330            Value * intPtr = CreatePtrToInt(Ptr, intPtrTy);
1331            ConstantInt * align = ConstantInt::get(intPtrTy, Align);
1332            CreateAssertZero(CreateURem(intPtr, align), "CreateMemSet: Ptr is misaligned");
1333        }
1334    }
1335    return IRBuilder<>::CreateMemSet(Ptr, Val, Size, Align, isVolatile, TBAATag, ScopeTag, NoAliasTag);
1336}
1337
1338CBuilder::CBuilder(LLVMContext & C)
1339: IRBuilder<>(C)
1340, mCacheLineAlignment(64)
1341, mSizeType(TypeBuilder<size_t, false>::get(C))
1342, mFILEtype(nullptr)
1343, mDriver(nullptr) {
1344
1345}
Note: See TracBrowser for help on using the repository browser.