source: icGREP/icgrep-devel/icgrep/toolchain/cpudriver.cpp @ 5616

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

Bug fixes for IR/ASM writing

File size: 9.0 KB
Line 
1#include "cpudriver.h"
2
3#include <IR_Gen/idisa_target.h>
4#include <llvm/ExecutionEngine/ExecutionEngine.h>  // for EngineBuilder
5#include <llvm/IR/LegacyPassManager.h>             // for PassManager
6#include <llvm/IR/IRPrintingPasses.h>
7#include <llvm/InitializePasses.h>                 // for initializeCodeGen
8#include <llvm/PassRegistry.h>                     // for PassRegistry
9#include <llvm/Support/CodeGen.h>                  // for Level, Level::None
10#include <llvm/Support/Compiler.h>                 // for LLVM_UNLIKELY
11#include <llvm/Support/TargetSelect.h>
12#include <llvm/Target/TargetMachine.h>             // for TargetMachine, Tar...
13#include <llvm/Target/TargetOptions.h>             // for TargetOptions
14#include <llvm/Transforms/Scalar.h>
15#include <llvm/Transforms/Utils/Local.h>
16#include <toolchain/object_cache.h>
17#include <toolchain/toolchain.h>
18#include <toolchain/pipeline.h>
19#include <kernels/kernel_builder.h>
20#include <kernels/kernel.h>
21#include <llvm/IR/Verifier.h>
22#ifndef NDEBUG
23#define IN_DEBUG_MODE true
24#else
25#define IN_DEBUG_MODE false
26#endif
27
28using namespace llvm;
29using Kernel = kernel::Kernel;
30using StreamSetBuffer = parabix::StreamSetBuffer;
31using KernelBuilder = kernel::KernelBuilder;
32
33ParabixDriver::ParabixDriver(std::string && moduleName)
34: Driver(std::move(moduleName))
35, mTarget(nullptr)
36, mEngine(nullptr)
37, mCache(nullptr)
38, mIROutputStream(nullptr)
39, mASMOutputStream(nullptr) {
40
41    InitializeNativeTarget();
42    InitializeNativeTargetAsmPrinter();
43    InitializeNativeTargetAsmParser();
44
45    PassRegistry * Registry = PassRegistry::getPassRegistry();
46    initializeCore(*Registry);
47    initializeCodeGen(*Registry);
48    initializeLowerIntrinsicsPass(*Registry);
49
50    std::string errMessage;
51    EngineBuilder builder{std::unique_ptr<Module>(mMainModule)};
52    builder.setErrorStr(&errMessage);
53    builder.setUseOrcMCJITReplacement(true);
54    builder.setTargetOptions(codegen::Options);
55    builder.setVerifyModules(false);
56    builder.setOptLevel(codegen::OptLevel);
57
58    StringMap<bool> HostCPUFeatures;
59    if (sys::getHostCPUFeatures(HostCPUFeatures)) {
60        std::vector<std::string> attrs;
61        for (auto &flag : HostCPUFeatures) {
62            auto enabled = flag.second ? "+" : "-";
63            attrs.push_back(enabled + flag.first().str());
64        }
65        builder.setMAttrs(attrs);
66    }
67
68    mEngine = builder.create();
69    if (mEngine == nullptr) {
70        throw std::runtime_error("Could not create ExecutionEngine: " + errMessage);
71    }
72    mTarget = builder.selectTarget();
73    if (LLVM_LIKELY(codegen::EnableObjectCache)) {
74        if (codegen::ObjectCacheDir) {
75            mCache = new ParabixObjectCache(codegen::ObjectCacheDir);
76        } else {
77            mCache = new ParabixObjectCache();
78        }
79        mEngine->setObjectCache(mCache);
80    }
81    mMainModule->setTargetTriple(mTarget->getTargetTriple().getTriple());
82
83    iBuilder.reset(IDISA::GetIDISA_Builder(*mContext));
84    iBuilder->setDriver(this);
85    iBuilder->setModule(mMainModule);
86}
87
88void ParabixDriver::makeKernelCall(Kernel * kb, const std::vector<StreamSetBuffer *> & inputs, const std::vector<StreamSetBuffer *> & outputs) {
89    assert ("addKernelCall or makeKernelCall was already run on this kernel." && (kb->getModule() == nullptr));
90    mPipeline.emplace_back(kb);
91    kb->bindPorts(inputs, outputs);
92    kb->makeModule(iBuilder);
93}
94
95void ParabixDriver::generatePipelineIR() {
96    #ifndef NDEBUG
97    if (LLVM_UNLIKELY(mPipeline.empty())) {
98        report_fatal_error("Pipeline cannot be empty");
99    } else {
100        for (auto i = mPipeline.begin(); i != mPipeline.end(); ++i) {
101            for (auto j = i; ++j != mPipeline.end(); ) {
102                if (LLVM_UNLIKELY(*i == *j)) {
103                    report_fatal_error("Kernel instances cannot occur twice in the pipeline");
104                }
105            }
106        }
107    }
108    #endif
109    // note: instantiation of all kernels must occur prior to initialization
110    for (const auto & k : mPipeline) {
111        k->addKernelDeclarations(iBuilder);
112    }
113    for (const auto & k : mPipeline) {
114        k->createInstance(iBuilder);
115    }
116    for (const auto & k : mPipeline) {
117        k->initializeInstance(iBuilder);
118    }
119    if (codegen::PipelineParallel) {
120        generateParallelPipeline(iBuilder, mPipeline);
121    } else if (codegen::SegmentPipelineParallel) {
122        generateSegmentParallelPipeline(iBuilder, mPipeline);
123    } else {
124        generatePipelineLoop(iBuilder, mPipeline);
125    }
126    for (const auto & k : mPipeline) {
127        k->finalizeInstance(iBuilder);
128    }
129}
130
131Function * ParabixDriver::addLinkFunction(Module * mod, llvm::StringRef name, FunctionType * type, void * functionPtr) const {
132    assert ("addKernelCall or makeKernelCall must be called before LinkFunction" && (mod != nullptr));
133    Function * f = mod->getFunction(name);
134    if (LLVM_UNLIKELY(f == nullptr)) {
135        f = Function::Create(type, Function::ExternalLinkage, name, mod);
136        mEngine->addGlobalMapping(f, functionPtr);
137    } else if (LLVM_UNLIKELY(f->getType() != type->getPointerTo())) {
138        report_fatal_error("Cannot link " + name + ": a function with a different signature already exists with that name in " + mod->getName());
139    }
140    return f;
141}
142
143void ParabixDriver::finalizeObject() {
144
145    legacy::PassManager PM;
146    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::ShowUnoptimizedIR))) {
147        if (LLVM_LIKELY(mIROutputStream == nullptr)) {
148            if (codegen::IROutputFilename) {
149                std::error_code error;
150                mIROutputStream = new raw_fd_ostream(codegen::IROutputFilename, error, sys::fs::OpenFlags::F_None);
151            } else {
152                mIROutputStream = new raw_fd_ostream(STDERR_FILENO, false, true);
153            }
154        }
155        PM.add(createPrintModulePass(*mIROutputStream));
156    }
157    if (IN_DEBUG_MODE || LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::VerifyIR))) {
158        PM.add(createVerifierPass());
159    }
160    PM.add(createPromoteMemoryToRegisterPass());    // Promote stack variables to constants or PHI nodes
161    PM.add(createCFGSimplificationPass());          // Remove dead basic blocks and unnecessary branch statements / phi nodes
162    PM.add(createEarlyCSEPass());                   // Simple common subexpression elimination pass
163    PM.add(createInstructionCombiningPass());       // Simple peephole optimizations and bit-twiddling.
164    PM.add(createReassociatePass());                // Canonicalizes commutative expressions
165    PM.add(createGVNPass());                        // Global value numbering redundant expression elimination pass
166    PM.add(createCFGSimplificationPass());          // Repeat CFG Simplification to "clean up" any newly found redundant phi nodes
167
168    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::ShowIR))) {
169        if (LLVM_LIKELY(mIROutputStream == nullptr)) {
170            if (codegen::IROutputFilename) {
171                std::error_code error;
172                mIROutputStream = new raw_fd_ostream(codegen::IROutputFilename, error, sys::fs::OpenFlags::F_None);
173            } else {
174                mIROutputStream = new raw_fd_ostream(STDERR_FILENO, false, true);
175            }
176        }
177        PM.add(createPrintModulePass(*mIROutputStream));
178    }
179
180    #ifndef USE_LLVM_3_6
181    if (LLVM_UNLIKELY(codegen::DebugOptionIsSet(codegen::ShowASM))) {
182        if (codegen::ASMOutputFilename) {
183            std::error_code error;
184            mASMOutputStream = new raw_fd_ostream(codegen::ASMOutputFilename, error, sys::fs::OpenFlags::F_None);
185        } else {
186            mASMOutputStream = new raw_fd_ostream(STDERR_FILENO, false, true);
187        }
188        if (LLVM_UNLIKELY(mTarget->addPassesToEmitFile(PM, *mASMOutputStream, TargetMachine::CGFT_AssemblyFile))) {
189            report_fatal_error("LLVM error: could not add emit assembly pass");
190        }
191    }
192    #endif
193
194    Module * module = nullptr;
195
196    try {
197
198        for (Kernel * const kernel : mPipeline) {
199            iBuilder->setKernel(kernel);
200            module = kernel->getModule();
201            assert (module != mMainModule);
202            bool uncachedObject = true;
203            if (mCache && mCache->loadCachedObjectFile(iBuilder, kernel)) {
204                uncachedObject = false;
205            }
206            if (uncachedObject) {
207                module->setTargetTriple(mMainModule->getTargetTriple());
208                kernel->generateKernel(iBuilder);
209                PM.run(*module);
210            }
211            mEngine->addModule(std::unique_ptr<Module>(module));
212        }
213
214        iBuilder->setKernel(nullptr);
215        module = mMainModule;
216        PM.run(*mMainModule);
217        mEngine->finalizeObject();
218
219        if (mCache) mCache->cleanUpObjectCacheFiles();
220
221    } catch (const std::exception & e) {
222        report_fatal_error(e.what());
223    }
224
225}
226
227bool ParabixDriver::hasExternalFunction(llvm::StringRef functionName) const {
228    return mEngine->getPointerToNamedFunction(functionName, false) != nullptr;
229}
230
231void * ParabixDriver::getMain() {
232    return mEngine->getPointerToNamedFunction("Main");
233}
234
235ParabixDriver::~ParabixDriver() {
236    delete mEngine;
237    delete mCache;
238    delete mTarget;
239    delete mIROutputStream;
240    delete mASMOutputStream;
241}
Note: See TracBrowser for help on using the repository browser.