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

Last change on this file since 5918 was 5918, checked in by cameron, 11 months ago

Fix wrong attribute error for posix_memalign

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