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

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

Restructuring work for the Driver classes. Start of work to eliminate the memory leaks with the ExecutionEngine?. Replaced custom AlignedMalloc? with backend call to std::aligned_malloc. Salvaged some work on DistributionPass? for reevaluation.

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