2 // jit-llvm.cpp: Support code for using LLVM as a JIT backend
4 // (C) 2009-2011 Novell, Inc.
5 // Copyright 2011-2015 Xamarin, Inc (http://www.xamarin.com)
9 // Mono's internal header files are not C++ clean, so avoid including them if
15 #include <llvm-c/Core.h>
16 #include <llvm-c/ExecutionEngine.h>
18 #include "mini-llvm-cpp.h"
21 #if !defined(MONO_CROSS_COMPILE) && LLVM_API_VERSION > 100
24 * LLVM 3.9 uses the OrcJIT APIs
27 #include <llvm/Support/raw_ostream.h>
28 #include <llvm/Support/Host.h>
29 #include <llvm/Support/TargetSelect.h>
30 #include <llvm/ExecutionEngine/ExecutionEngine.h>
31 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
32 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
33 #include "llvm/ExecutionEngine/Orc/LambdaResolver.h"
34 #include "llvm/ExecutionEngine/Orc/LazyEmittingLayer.h"
35 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
36 #include "llvm/ExecutionEngine/Orc/OrcArchitectureSupport.h"
39 using namespace llvm::orc;
42 mono_llvm_set_unhandled_exception_handler (void)
46 static gboolean inited;
54 InitializeNativeTarget ();
55 InitializeNativeTargetAsmPrinter();
59 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
67 mono_llvm_optimize_method (MonoEERef eeref, LLVMValueRef method)
69 g_assert_not_reached ();
73 mono_llvm_dispose_ee (MonoEERef *eeref)
78 LLVMAddGlobalMapping (LLVMExecutionEngineRef EE, LLVMValueRef Global,
84 LLVMGetPointerToGlobal (LLVMExecutionEngineRef EE, LLVMValueRef Global)
86 g_assert_not_reached ();
90 #elif !defined(MONO_CROSS_COMPILE) && LLVM_API_VERSION < 100
94 #include <llvm/Support/raw_ostream.h>
95 #include <llvm/Support/Host.h>
96 #include <llvm/PassManager.h>
97 #include <llvm/ExecutionEngine/ExecutionEngine.h>
98 #include <llvm/ExecutionEngine/JITMemoryManager.h>
99 #include <llvm/ExecutionEngine/JITEventListener.h>
100 #include <llvm/Target/TargetOptions.h>
101 #include <llvm/Target/TargetRegisterInfo.h>
102 #include <llvm/IR/Verifier.h>
103 #include <llvm/Analysis/Passes.h>
104 #include <llvm/Transforms/Scalar.h>
105 #include <llvm/Support/CommandLine.h>
106 #include <llvm/IR/LegacyPassNameParser.h>
107 #include <llvm/Support/PrettyStackTrace.h>
108 #include <llvm/CodeGen/Passes.h>
109 #include <llvm/CodeGen/MachineFunctionPass.h>
110 #include <llvm/CodeGen/MachineFunction.h>
111 #include <llvm/CodeGen/MachineFrameInfo.h>
112 #include <llvm/IR/Function.h>
113 #include <llvm/IR/IRBuilder.h>
114 #include <llvm/IR/Module.h>
116 using namespace llvm;
118 static void (*unhandled_exception)() = default_mono_llvm_unhandled_exception;
121 mono_llvm_set_unhandled_exception_handler (void)
123 std::set_terminate (unhandled_exception);
126 class MonoJITMemoryManager : public JITMemoryManager
129 JITMemoryManager *mm;
132 /* Callbacks installed by mono */
133 AllocCodeMemoryCb *alloc_cb;
135 ExceptionTableCb *exception_cb;
137 MonoJITMemoryManager ();
138 ~MonoJITMemoryManager ();
140 void setMemoryWritable (void);
142 void setMemoryExecutable (void);
146 unsigned char *getGOTBase() const {
147 return mm->getGOTBase ();
150 void setPoisonMemory(bool) {
153 unsigned char *startFunctionBody(const Function *F,
154 uintptr_t &ActualSize);
156 unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
159 void endFunctionBody(const Function *F, unsigned char *FunctionStart,
160 unsigned char *FunctionEnd);
162 unsigned char *allocateSpace(intptr_t Size, unsigned Alignment);
164 uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
166 void deallocateMemForFunction(const Function *F);
168 unsigned char*startExceptionTable(const Function* F,
169 uintptr_t &ActualSize);
171 void endExceptionTable(const Function *F, unsigned char *TableStart,
172 unsigned char *TableEnd,
173 unsigned char* FrameRegister);
175 virtual void deallocateFunctionBody(void*) {
178 virtual void deallocateExceptionTable(void*) {
181 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
182 StringRef SectionName) {
188 virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
189 StringRef SectionName, bool IsReadOnly) {
195 virtual bool applyPermissions(std::string*) {
201 virtual bool finalizeMemory(std::string *ErrMsg = 0) {
207 virtual void* getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure) {
211 err = dlsym_cb (Name.c_str (), &res);
213 outs () << "Unable to resolve: " << Name << ": " << err << "\n";
221 MonoJITMemoryManager::MonoJITMemoryManager ()
223 mm = JITMemoryManager::CreateDefaultMemManager ();
226 MonoJITMemoryManager::~MonoJITMemoryManager ()
232 MonoJITMemoryManager::setMemoryWritable (void)
237 MonoJITMemoryManager::setMemoryExecutable (void)
242 MonoJITMemoryManager::AllocateGOT()
248 MonoJITMemoryManager::startFunctionBody(const Function *F,
249 uintptr_t &ActualSize)
251 // FIXME: This leaks memory
254 return alloc_cb (wrap (F), ActualSize);
258 MonoJITMemoryManager::allocateStub(const GlobalValue* F, unsigned StubSize,
261 return alloc_cb (wrap (F), StubSize);
265 MonoJITMemoryManager::endFunctionBody(const Function *F, unsigned char *FunctionStart,
266 unsigned char *FunctionEnd)
271 MonoJITMemoryManager::allocateSpace(intptr_t Size, unsigned Alignment)
273 return new unsigned char [Size];
277 MonoJITMemoryManager::allocateGlobal(uintptr_t Size, unsigned Alignment)
279 return new unsigned char [Size];
283 MonoJITMemoryManager::deallocateMemForFunction(const Function *F)
288 MonoJITMemoryManager::startExceptionTable(const Function* F,
289 uintptr_t &ActualSize)
291 return startFunctionBody(F, ActualSize);
295 MonoJITMemoryManager::endExceptionTable(const Function *F, unsigned char *TableStart,
296 unsigned char *TableEnd,
297 unsigned char* FrameRegister)
299 exception_cb (FrameRegister);
302 class MonoJITEventListener : public JITEventListener {
305 FunctionEmittedCb *emitted_cb;
307 MonoJITEventListener (FunctionEmittedCb *cb) {
311 virtual void NotifyFunctionEmitted(const Function &F,
312 void *Code, size_t Size,
313 const EmittedFunctionDetails &Details) {
314 emitted_cb (wrap (&F), Code, (char*)Code + Size);
321 MonoJITMemoryManager *mm;
322 MonoJITEventListener *listener;
323 FunctionPassManager *fpm;
327 mono_llvm_optimize_method (MonoEERef eeref, LLVMValueRef method)
329 MonoEE *mono_ee = (MonoEE*)eeref;
332 * The verifier does some checks on the whole module, leading to quadratic behavior.
334 //verifyFunction (*(unwrap<Function> (method)));
335 mono_ee->fpm->run (*unwrap<Function> (method));
338 static cl::list<const PassInfo*, bool, PassNameParser>
339 PassList(cl::desc("Optimizations available:"));
342 force_pass_linking (void)
344 // Make sure the rest is linked in, but never executed
345 if (g_getenv ("FOO") != (char*)-1)
348 // This is a subset of the passes in LinkAllPasses.h
349 // The utility passes and the interprocedural passes are commented out
351 (void) llvm::createAAEvalPass();
352 (void) llvm::createAggressiveDCEPass();
353 (void) llvm::createAliasAnalysisCounterPass();
354 (void) llvm::createAliasDebugger();
356 (void) llvm::createArgumentPromotionPass();
357 (void) llvm::createStructRetPromotionPass();
359 (void) llvm::createBasicAliasAnalysisPass();
360 (void) llvm::createLibCallAliasAnalysisPass(0);
361 (void) llvm::createScalarEvolutionAliasAnalysisPass();
362 //(void) llvm::createBlockPlacementPass();
363 (void) llvm::createBreakCriticalEdgesPass();
364 (void) llvm::createCFGSimplificationPass();
366 (void) llvm::createConstantMergePass();
367 (void) llvm::createConstantPropagationPass();
370 (void) llvm::createDeadArgEliminationPass();
372 (void) llvm::createDeadCodeEliminationPass();
373 (void) llvm::createDeadInstEliminationPass();
374 (void) llvm::createDeadStoreEliminationPass();
376 (void) llvm::createDeadTypeEliminationPass();
377 (void) llvm::createDomOnlyPrinterPass();
378 (void) llvm::createDomPrinterPass();
379 (void) llvm::createDomOnlyViewerPass();
380 (void) llvm::createDomViewerPass();
381 (void) llvm::createEdgeProfilerPass();
382 (void) llvm::createOptimalEdgeProfilerPass();
383 (void) llvm::createFunctionInliningPass();
384 (void) llvm::createAlwaysInlinerPass();
385 (void) llvm::createGlobalDCEPass();
386 (void) llvm::createGlobalOptimizerPass();
387 (void) llvm::createGlobalsModRefPass();
388 (void) llvm::createIPConstantPropagationPass();
389 (void) llvm::createIPSCCPPass();
391 (void) llvm::createIndVarSimplifyPass();
392 (void) llvm::createInstructionCombiningPass();
394 (void) llvm::createInternalizePass(false);
396 (void) llvm::createLCSSAPass();
397 (void) llvm::createLICMPass();
398 (void) llvm::createLazyValueInfoPass();
399 //(void) llvm::createLoopDependenceAnalysisPass();
401 (void) llvm::createLoopExtractorPass();
403 (void) llvm::createLoopSimplifyPass();
404 (void) llvm::createLoopStrengthReducePass();
405 (void) llvm::createLoopUnrollPass();
406 (void) llvm::createLoopUnswitchPass();
407 (void) llvm::createLoopRotatePass();
408 (void) llvm::createLowerInvokePass();
410 (void) llvm::createLowerSetJmpPass();
412 (void) llvm::createLowerSwitchPass();
413 (void) llvm::createNoAAPass();
415 (void) llvm::createNoProfileInfoPass();
416 (void) llvm::createProfileEstimatorPass();
417 (void) llvm::createProfileVerifierPass();
418 (void) llvm::createProfileLoaderPass();
420 (void) llvm::createPromoteMemoryToRegisterPass();
421 (void) llvm::createDemoteRegisterToMemoryPass();
423 (void) llvm::createPruneEHPass();
424 (void) llvm::createPostDomOnlyPrinterPass();
425 (void) llvm::createPostDomPrinterPass();
426 (void) llvm::createPostDomOnlyViewerPass();
427 (void) llvm::createPostDomViewerPass();
429 (void) llvm::createReassociatePass();
430 (void) llvm::createSCCPPass();
431 (void) llvm::createScalarReplAggregatesPass();
432 //(void) llvm::createSimplifyLibCallsPass();
434 (void) llvm::createSingleLoopExtractorPass();
435 (void) llvm::createStripSymbolsPass();
436 (void) llvm::createStripNonDebugSymbolsPass();
437 (void) llvm::createStripDeadDebugInfoPass();
438 (void) llvm::createStripDeadPrototypesPass();
439 (void) llvm::createTailCallEliminationPass();
440 (void) llvm::createTailDuplicationPass();
441 (void) llvm::createJumpThreadingPass();
444 (void) llvm::createUnifyFunctionExitNodesPass();
446 (void) llvm::createInstCountPass();
447 (void) llvm::createCodeGenPreparePass();
448 (void) llvm::createGVNPass();
449 (void) llvm::createMemCpyOptPass();
450 (void) llvm::createLoopDeletionPass();
452 (void) llvm::createPostDomTree();
453 (void) llvm::createPostDomFrontier();
454 (void) llvm::createInstructionNamerPass();
455 (void) llvm::createPartialSpecializationPass();
456 (void) llvm::createFunctionAttrsPass();
457 (void) llvm::createMergeFunctionsPass();
458 (void) llvm::createPrintModulePass(0);
459 (void) llvm::createPrintFunctionPass("", 0);
460 (void) llvm::createDbgInfoPrinterPass();
461 (void) llvm::createModuleDebugInfoPrinterPass();
462 (void) llvm::createPartialInliningPass();
463 (void) llvm::createGEPSplitterPass();
464 (void) llvm::createLintPass();
466 (void) llvm::createSinkingPass();
469 static gboolean inited;
477 force_pass_linking ();
480 LLVMInitializeARMTarget ();
481 LLVMInitializeARMTargetInfo ();
482 LLVMInitializeARMTargetMC ();
483 #elif defined(TARGET_X86) || defined(TARGET_AMD64)
484 LLVMInitializeX86Target ();
485 LLVMInitializeX86TargetInfo ();
486 LLVMInitializeX86TargetMC ();
487 #elif defined(TARGET_POWERPC)
488 LLVMInitializePowerPCTarget ();
489 LLVMInitializePowerPCTargetInfo ();
490 LLVMInitializePowerPCTargetMC ();
492 #error Unsupported mono-llvm target
495 PassRegistry &Registry = *PassRegistry::getPassRegistry();
496 initializeCore(Registry);
497 initializeScalarOpts(Registry);
498 initializeAnalysis(Registry);
499 initializeIPA(Registry);
500 initializeTransformUtils(Registry);
501 initializeInstCombine(Registry);
502 initializeTarget(Registry);
504 llvm::cl::ParseEnvironmentOptions("mono", "MONO_LLVM", "");
510 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
517 mono_ee = new MonoEE ();
519 MonoJITMemoryManager *mono_mm = new MonoJITMemoryManager ();
520 mono_mm->alloc_cb = alloc_cb;
521 mono_mm->dlsym_cb = dlsym_cb;
522 mono_mm->exception_cb = exception_cb;
523 mono_ee->mm = mono_mm;
526 * The Default code model doesn't seem to work on amd64,
527 * test_0_fields_with_big_offsets (among others) crashes, because LLVM tries to call
528 * memset using a normal pcrel code which is in 32bit memory, while memset isn't.
532 opts.JITExceptionHandling = 1;
534 StringRef cpu_name = sys::getHostCPUName ();
536 // EngineBuilder no longer has a copy assignment operator (?)
537 std::unique_ptr<Module> Owner(unwrap(MP));
538 EngineBuilder b (std::move(Owner));
539 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).setMCPU (cpu_name).create ();
544 MonoJITEventListener *listener = new MonoJITEventListener (emitted_cb);
545 EE->RegisterJITEventListener (listener);
546 mono_ee->listener = listener;
548 FunctionPassManager *fpm = new FunctionPassManager (unwrap (MP));
551 fpm->add(new DataLayoutPass(*EE->getDataLayout()));
553 if (PassList.size() > 0) {
554 /* Use the passes specified by the env variable */
555 /* Only the passes in force_pass_linking () can be used */
556 for (unsigned i = 0; i < PassList.size(); ++i) {
557 const PassInfo *PassInf = PassList[i];
560 if (PassInf->getNormalCtor())
561 P = PassInf->getNormalCtor()();
565 /* Use the same passes used by 'opt' by default, without the ipo passes */
566 const char *opts = "-simplifycfg -domtree -domfrontier -scalarrepl -instcombine -simplifycfg -domtree -domfrontier -scalarrepl -instcombine -simplifycfg -instcombine -simplifycfg -reassociate -domtree -loops -loop-simplify -domfrontier -loop-simplify -lcssa -loop-rotate -licm -lcssa -loop-unswitch -instcombine -scalar-evolution -loop-simplify -lcssa -iv-users -indvars -loop-deletion -loop-simplify -lcssa -loop-unroll -instcombine -memdep -gvn -memdep -memcpyopt -sccp -instcombine -domtree -memdep -dse -adce -gvn -simplifycfg";
570 args = g_strsplit (opts, " ", 1000);
571 for (i = 0; args [i]; i++)
573 llvm::cl::ParseCommandLineOptions (i, args, "");
576 for (unsigned i = 0; i < PassList.size(); ++i) {
577 const PassInfo *PassInf = PassList[i];
580 if (PassInf->getNormalCtor())
581 P = PassInf->getNormalCtor()();
582 g_assert (P->getPassKind () == llvm::PT_Function || P->getPassKind () == llvm::PT_Loop);
587 fpm->add(createInstructionCombiningPass());
588 fpm->add(createReassociatePass());
589 fpm->add(createGVNPass());
590 fpm->add(createCFGSimplificationPass());
600 mono_llvm_dispose_ee (MonoEERef *eeref)
602 MonoEE *mono_ee = (MonoEE*)eeref;
606 //delete mono_ee->mm;
607 delete mono_ee->listener;
611 #else /* MONO_CROSS_COMPILE */
614 mono_llvm_set_unhandled_exception_handler (void)
619 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
621 g_assert_not_reached ();
626 mono_llvm_optimize_method (MonoEERef eeref, LLVMValueRef method)
628 g_assert_not_reached ();
632 mono_llvm_dispose_ee (MonoEERef *eeref)
634 g_assert_not_reached ();
639 LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
642 g_assert_not_reached ();
646 LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global)
648 g_assert_not_reached ();
652 #endif /* !MONO_CROSS_COMPILE */