2 // mini-llvm-cpp.cpp: C++ support classes for the mono LLVM integration
4 // (C) 2009-2011 Novell, Inc.
5 // Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
9 // We need to override some stuff in LLVM, but this cannot be done using the C
10 // interface, so we have to use some C++ code here.
11 // The things which we override are:
12 // - the default JIT code manager used by LLVM doesn't allocate memory using
13 // MAP_32BIT, we require it.
14 // - add some callbacks so we can obtain the size of methods and their exception
19 // Mono's internal header files are not C++ clean, so avoid including them if
27 #include <llvm/Support/raw_ostream.h>
28 #include <llvm/Support/Host.h>
29 #include <llvm/PassManager.h>
30 #include <llvm/ExecutionEngine/ExecutionEngine.h>
31 #include <llvm/ExecutionEngine/JITMemoryManager.h>
32 #include <llvm/ExecutionEngine/JITEventListener.h>
33 #include <llvm/Target/TargetOptions.h>
34 #include <llvm/Target/TargetRegisterInfo.h>
35 #if LLVM_API_VERSION >= 1
36 #include <llvm/IR/Verifier.h>
38 #include <llvm/Analysis/Verifier.h>
40 #include <llvm/Analysis/Passes.h>
41 #include <llvm/Transforms/Scalar.h>
42 #include <llvm/Support/CommandLine.h>
43 #if LLVM_API_VERSION >= 1
44 #include "llvm/IR/LegacyPassNameParser.h"
46 #include "llvm/Support/PassNameParser.h"
48 #include "llvm/Support/PrettyStackTrace.h"
49 #include <llvm/CodeGen/Passes.h>
50 #include <llvm/CodeGen/MachineFunctionPass.h>
51 #include <llvm/CodeGen/MachineFunction.h>
52 #include <llvm/CodeGen/MachineFrameInfo.h>
53 #include <llvm/IR/Function.h>
54 #include <llvm/IR/IRBuilder.h>
55 #include <llvm/IR/Module.h>
56 //#include <llvm/LinkAllPasses.h>
58 #include "llvm-c/Core.h"
59 #include "llvm-c/ExecutionEngine.h"
61 #include "mini-llvm-cpp.h"
63 #define LLVM_CHECK_VERSION(major,minor) \
64 ((LLVM_MAJOR_VERSION > (major)) || \
65 ((LLVM_MAJOR_VERSION == (major)) && (LLVM_MINOR_VERSION >= (minor))))
67 // extern "C" void LLVMInitializeARMTargetInfo();
68 // extern "C" void LLVMInitializeARMTarget ();
69 // extern "C" void LLVMInitializeARMTargetMC ();
73 #ifndef MONO_CROSS_COMPILE
75 class MonoJITMemoryManager : public JITMemoryManager
81 /* Callbacks installed by mono */
82 AllocCodeMemoryCb *alloc_cb;
85 MonoJITMemoryManager ();
86 ~MonoJITMemoryManager ();
88 void setMemoryWritable (void);
90 void setMemoryExecutable (void);
94 unsigned char *getGOTBase() const {
95 return mm->getGOTBase ();
98 void setPoisonMemory(bool) {
101 unsigned char *startFunctionBody(const Function *F,
102 uintptr_t &ActualSize);
104 unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
107 void endFunctionBody(const Function *F, unsigned char *FunctionStart,
108 unsigned char *FunctionEnd);
110 unsigned char *allocateSpace(intptr_t Size, unsigned Alignment);
112 uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
114 void deallocateMemForFunction(const Function *F);
116 unsigned char*startExceptionTable(const Function* F,
117 uintptr_t &ActualSize);
119 void endExceptionTable(const Function *F, unsigned char *TableStart,
120 unsigned char *TableEnd,
121 unsigned char* FrameRegister);
123 virtual void deallocateFunctionBody(void*) {
126 virtual void deallocateExceptionTable(void*) {
129 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
130 StringRef SectionName) {
136 virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
137 StringRef SectionName, bool IsReadOnly) {
143 virtual bool applyPermissions(std::string*) {
149 virtual bool finalizeMemory(std::string *ErrMsg = 0) {
155 virtual void* getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure) {
159 err = dlsym_cb (Name.c_str (), &res);
161 outs () << "Unable to resolve: " << Name << ": " << err << "\n";
169 MonoJITMemoryManager::MonoJITMemoryManager ()
171 mm = JITMemoryManager::CreateDefaultMemManager ();
174 MonoJITMemoryManager::~MonoJITMemoryManager ()
180 MonoJITMemoryManager::setMemoryWritable (void)
185 MonoJITMemoryManager::setMemoryExecutable (void)
190 MonoJITMemoryManager::AllocateGOT()
196 MonoJITMemoryManager::startFunctionBody(const Function *F,
197 uintptr_t &ActualSize)
199 // FIXME: This leaks memory
202 return alloc_cb (wrap (F), ActualSize);
206 MonoJITMemoryManager::allocateStub(const GlobalValue* F, unsigned StubSize,
209 return alloc_cb (wrap (F), StubSize);
213 MonoJITMemoryManager::endFunctionBody(const Function *F, unsigned char *FunctionStart,
214 unsigned char *FunctionEnd)
219 MonoJITMemoryManager::allocateSpace(intptr_t Size, unsigned Alignment)
221 return new unsigned char [Size];
225 MonoJITMemoryManager::allocateGlobal(uintptr_t Size, unsigned Alignment)
227 return new unsigned char [Size];
231 MonoJITMemoryManager::deallocateMemForFunction(const Function *F)
236 MonoJITMemoryManager::startExceptionTable(const Function* F,
237 uintptr_t &ActualSize)
239 return startFunctionBody(F, ActualSize);
243 MonoJITMemoryManager::endExceptionTable(const Function *F, unsigned char *TableStart,
244 unsigned char *TableEnd,
245 unsigned char* FrameRegister)
251 class MonoJITMemoryManager {
254 #endif /* !MONO_CROSS_COMPILE */
256 class MonoJITEventListener : public JITEventListener {
259 FunctionEmittedCb *emitted_cb;
261 MonoJITEventListener (FunctionEmittedCb *cb) {
265 virtual void NotifyFunctionEmitted(const Function &F,
266 void *Code, size_t Size,
267 const EmittedFunctionDetails &Details) {
269 * X86TargetMachine::setCodeModelForJIT() sets the code model to Large on amd64,
270 * which means the JIT will generate calls of the form
273 * Our trampoline code can't patch this. Passing CodeModel::Small to createJIT
274 * doesn't seem to work, we need Default. A discussion is here:
275 * http://lists.cs.uiuc.edu/pipermail/llvmdev/2009-December/027999.html
276 * There seems to no way to get the TargeMachine used by an EE either, so we
277 * install a profiler hook and reset the code model here.
278 * This should be inside an ifdef, but we can't include our config.h either,
279 * since its definitions conflict with LLVM's config.h.
280 * The LLVM mono branch contains a workaround.
282 emitted_cb (wrap (&F), Code, (char*)Code + Size);
289 MonoJITMemoryManager *mm;
290 MonoJITEventListener *listener;
291 FunctionPassManager *fpm;
295 mono_llvm_optimize_method (MonoEERef eeref, LLVMValueRef method)
297 MonoEE *mono_ee = (MonoEE*)eeref;
300 * The verifier does some checks on the whole module, leading to quadratic behavior.
302 //verifyFunction (*(unwrap<Function> (method)));
303 mono_ee->fpm->run (*unwrap<Function> (method));
307 mono_llvm_dump_value (LLVMValueRef value)
309 /* Same as LLVMDumpValue (), but print to stdout */
311 outs () << (*unwrap<Value> (value));
314 /* Missing overload for building an alloca with an alignment */
316 mono_llvm_build_alloca (LLVMBuilderRef builder, LLVMTypeRef Ty,
317 LLVMValueRef ArraySize,
318 int alignment, const char *Name)
320 return wrap (unwrap (builder)->Insert (new AllocaInst (unwrap (Ty), unwrap (ArraySize), alignment), Name));
324 mono_llvm_build_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
325 const char *Name, gboolean is_volatile)
327 return wrap(unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name));
331 mono_llvm_build_aligned_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
332 const char *Name, gboolean is_volatile, int alignment)
336 ins = unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name);
337 ins->setAlignment (alignment);
343 mono_llvm_build_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
344 gboolean is_volatile)
346 return wrap(unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile));
350 mono_llvm_build_aligned_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
351 gboolean is_volatile, int alignment)
355 ins = unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile);
356 ins->setAlignment (alignment);
362 mono_llvm_build_cmpxchg (LLVMBuilderRef builder, LLVMValueRef ptr, LLVMValueRef cmp, LLVMValueRef val)
364 AtomicCmpXchgInst *ins;
366 #if LLVM_API_VERSION >= 1
367 ins = unwrap(builder)->CreateAtomicCmpXchg (unwrap(ptr), unwrap (cmp), unwrap (val), SequentiallyConsistent, SequentiallyConsistent);
369 ins = unwrap(builder)->CreateAtomicCmpXchg (unwrap(ptr), unwrap (cmp), unwrap (val), SequentiallyConsistent);
375 mono_llvm_build_atomic_rmw (LLVMBuilderRef builder, AtomicRMWOp op, LLVMValueRef ptr, LLVMValueRef val)
377 AtomicRMWInst::BinOp aop = AtomicRMWInst::Xchg;
381 case LLVM_ATOMICRMW_OP_XCHG:
382 aop = AtomicRMWInst::Xchg;
384 case LLVM_ATOMICRMW_OP_ADD:
385 aop = AtomicRMWInst::Add;
388 g_assert_not_reached ();
392 ins = unwrap (builder)->CreateAtomicRMW (aop, unwrap (ptr), unwrap (val), AcquireRelease);
397 mono_llvm_build_fence (LLVMBuilderRef builder)
401 ins = unwrap (builder)->CreateFence (AcquireRelease);
406 mono_llvm_replace_uses_of (LLVMValueRef var, LLVMValueRef v)
408 Value *V = ConstantExpr::getTruncOrBitCast (unwrap<Constant> (v), unwrap (var)->getType ());
409 unwrap (var)->replaceAllUsesWith (V);
412 static cl::list<const PassInfo*, bool, PassNameParser>
413 PassList(cl::desc("Optimizations available:"));
416 force_pass_linking (void)
418 // Make sure the rest is linked in, but never executed
419 if (g_getenv ("FOO") != (char*)-1)
422 // This is a subset of the passes in LinkAllPasses.h
423 // The utility passes and the interprocedural passes are commented out
425 (void) llvm::createAAEvalPass();
426 (void) llvm::createAggressiveDCEPass();
427 (void) llvm::createAliasAnalysisCounterPass();
428 (void) llvm::createAliasDebugger();
430 (void) llvm::createArgumentPromotionPass();
431 (void) llvm::createStructRetPromotionPass();
433 (void) llvm::createBasicAliasAnalysisPass();
434 (void) llvm::createLibCallAliasAnalysisPass(0);
435 (void) llvm::createScalarEvolutionAliasAnalysisPass();
436 //(void) llvm::createBlockPlacementPass();
437 (void) llvm::createBreakCriticalEdgesPass();
438 (void) llvm::createCFGSimplificationPass();
440 (void) llvm::createConstantMergePass();
441 (void) llvm::createConstantPropagationPass();
444 (void) llvm::createDeadArgEliminationPass();
446 (void) llvm::createDeadCodeEliminationPass();
447 (void) llvm::createDeadInstEliminationPass();
448 (void) llvm::createDeadStoreEliminationPass();
450 (void) llvm::createDeadTypeEliminationPass();
451 (void) llvm::createDomOnlyPrinterPass();
452 (void) llvm::createDomPrinterPass();
453 (void) llvm::createDomOnlyViewerPass();
454 (void) llvm::createDomViewerPass();
455 (void) llvm::createEdgeProfilerPass();
456 (void) llvm::createOptimalEdgeProfilerPass();
457 (void) llvm::createFunctionInliningPass();
458 (void) llvm::createAlwaysInlinerPass();
459 (void) llvm::createGlobalDCEPass();
460 (void) llvm::createGlobalOptimizerPass();
461 (void) llvm::createGlobalsModRefPass();
462 (void) llvm::createIPConstantPropagationPass();
463 (void) llvm::createIPSCCPPass();
465 (void) llvm::createIndVarSimplifyPass();
466 (void) llvm::createInstructionCombiningPass();
468 (void) llvm::createInternalizePass(false);
470 (void) llvm::createLCSSAPass();
471 (void) llvm::createLICMPass();
472 (void) llvm::createLazyValueInfoPass();
473 //(void) llvm::createLoopDependenceAnalysisPass();
475 (void) llvm::createLoopExtractorPass();
477 (void) llvm::createLoopSimplifyPass();
478 (void) llvm::createLoopStrengthReducePass();
479 (void) llvm::createLoopUnrollPass();
480 (void) llvm::createLoopUnswitchPass();
481 (void) llvm::createLoopRotatePass();
482 (void) llvm::createLowerInvokePass();
484 (void) llvm::createLowerSetJmpPass();
486 (void) llvm::createLowerSwitchPass();
487 (void) llvm::createNoAAPass();
489 (void) llvm::createNoProfileInfoPass();
490 (void) llvm::createProfileEstimatorPass();
491 (void) llvm::createProfileVerifierPass();
492 (void) llvm::createProfileLoaderPass();
494 (void) llvm::createPromoteMemoryToRegisterPass();
495 (void) llvm::createDemoteRegisterToMemoryPass();
497 (void) llvm::createPruneEHPass();
498 (void) llvm::createPostDomOnlyPrinterPass();
499 (void) llvm::createPostDomPrinterPass();
500 (void) llvm::createPostDomOnlyViewerPass();
501 (void) llvm::createPostDomViewerPass();
503 (void) llvm::createReassociatePass();
504 (void) llvm::createSCCPPass();
505 (void) llvm::createScalarReplAggregatesPass();
506 //(void) llvm::createSimplifyLibCallsPass();
508 (void) llvm::createSingleLoopExtractorPass();
509 (void) llvm::createStripSymbolsPass();
510 (void) llvm::createStripNonDebugSymbolsPass();
511 (void) llvm::createStripDeadDebugInfoPass();
512 (void) llvm::createStripDeadPrototypesPass();
513 (void) llvm::createTailCallEliminationPass();
514 (void) llvm::createTailDuplicationPass();
515 (void) llvm::createJumpThreadingPass();
518 (void) llvm::createUnifyFunctionExitNodesPass();
520 (void) llvm::createInstCountPass();
521 (void) llvm::createCodeGenPreparePass();
522 (void) llvm::createGVNPass();
523 (void) llvm::createMemCpyOptPass();
524 (void) llvm::createLoopDeletionPass();
526 (void) llvm::createPostDomTree();
527 (void) llvm::createPostDomFrontier();
528 (void) llvm::createInstructionNamerPass();
529 (void) llvm::createPartialSpecializationPass();
530 (void) llvm::createFunctionAttrsPass();
531 (void) llvm::createMergeFunctionsPass();
532 (void) llvm::createPrintModulePass(0);
533 (void) llvm::createPrintFunctionPass("", 0);
534 (void) llvm::createDbgInfoPrinterPass();
535 (void) llvm::createModuleDebugInfoPrinterPass();
536 (void) llvm::createPartialInliningPass();
537 (void) llvm::createGEPSplitterPass();
538 (void) llvm::createLintPass();
540 (void) llvm::createSinkingPass();
543 #ifndef MONO_CROSS_COMPILE
545 static gboolean inited;
553 force_pass_linking ();
556 LLVMInitializeARMTarget ();
557 LLVMInitializeARMTargetInfo ();
558 LLVMInitializeARMTargetMC ();
560 LLVMInitializeX86Target ();
561 LLVMInitializeX86TargetInfo ();
562 LLVMInitializeX86TargetMC ();
565 PassRegistry &Registry = *PassRegistry::getPassRegistry();
566 initializeCore(Registry);
567 initializeScalarOpts(Registry);
568 initializeAnalysis(Registry);
569 initializeIPA(Registry);
570 initializeTransformUtils(Registry);
571 initializeInstCombine(Registry);
572 initializeTarget(Registry);
574 llvm::cl::ParseEnvironmentOptions("mono", "MONO_LLVM", "");
580 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
587 mono_ee = new MonoEE ();
589 MonoJITMemoryManager *mono_mm = new MonoJITMemoryManager ();
590 mono_mm->alloc_cb = alloc_cb;
591 mono_mm->dlsym_cb = dlsym_cb;
592 mono_ee->mm = mono_mm;
595 * The Default code model doesn't seem to work on amd64,
596 * test_0_fields_with_big_offsets (among others) crashes, because LLVM tries to call
597 * memset using a normal pcrel code which is in 32bit memory, while memset isn't.
601 opts.JITExceptionHandling = 1;
603 #if LLVM_API_VERSION >= 2
604 StringRef cpu_name = sys::getHostCPUName ();
606 // EngineBuilder no longer has a copy assignment operator (?)
607 std::unique_ptr<Module> Owner(unwrap(MP));
608 EngineBuilder b (std::move(Owner));
609 EngineBuilder &eb = b;
611 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).setMCPU (cpu_name).setCodeModel (CodeModel::Large).create ();
613 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).setMCPU (cpu_name).create ();
618 EngineBuilder b (unwrap (MP));
619 EngineBuilder &eb = b;
620 eb = eb.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true);
621 #if LLVM_API_VERSION >= 1
622 StringRef cpu_name = sys::getHostCPUName ();
623 eb = eb.setMCPU (cpu_name);
626 eb = eb.setCodeModel (CodeModel::Large);
629 ExecutionEngine *EE = eb.create ();
635 EE->InstallExceptionTableRegister (exception_cb);
636 MonoJITEventListener *listener = new MonoJITEventListener (emitted_cb);
637 EE->RegisterJITEventListener (listener);
638 mono_ee->listener = listener;
640 FunctionPassManager *fpm = new FunctionPassManager (unwrap (MP));
643 #if LLVM_API_VERSION >= 1
644 fpm->add(new DataLayoutPass(*EE->getDataLayout()));
646 fpm->add(new DataLayout(*EE->getDataLayout()));
649 if (PassList.size() > 0) {
650 /* Use the passes specified by the env variable */
651 /* Only the passes in force_pass_linking () can be used */
652 for (unsigned i = 0; i < PassList.size(); ++i) {
653 const PassInfo *PassInf = PassList[i];
656 if (PassInf->getNormalCtor())
657 P = PassInf->getNormalCtor()();
661 /* Use the same passes used by 'opt' by default, without the ipo passes */
662 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";
666 args = g_strsplit (opts, " ", 1000);
667 for (i = 0; args [i]; i++)
669 llvm::cl::ParseCommandLineOptions (i, args, "");
672 for (unsigned i = 0; i < PassList.size(); ++i) {
673 const PassInfo *PassInf = PassList[i];
676 if (PassInf->getNormalCtor())
677 P = PassInf->getNormalCtor()();
678 g_assert (P->getPassKind () == llvm::PT_Function || P->getPassKind () == llvm::PT_Loop);
683 fpm->add(createInstructionCombiningPass());
684 fpm->add(createReassociatePass());
685 fpm->add(createGVNPass());
686 fpm->add(createCFGSimplificationPass());
696 mono_llvm_dispose_ee (MonoEERef *eeref)
698 MonoEE *mono_ee = (MonoEE*)eeref;
702 //delete mono_ee->mm;
703 delete mono_ee->listener;
710 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
712 g_assert_not_reached ();
717 mono_llvm_dispose_ee (MonoEERef *eeref)
719 g_assert_not_reached ();
724 LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
727 g_assert_not_reached ();
731 LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global)
733 g_assert_not_reached ();
737 #endif /* !MONO_CROSS_COMPILE */