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

Last change on this file since 6233 was 6233, checked in by nmedfort, 4 months ago

Moved termination signals into pipeline kernel

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