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 #include <llvm/IR/Verifier.h>
36 #include <llvm/Analysis/Passes.h>
37 #include <llvm/Transforms/Scalar.h>
38 #include <llvm/Support/CommandLine.h>
39 #include "llvm/IR/LegacyPassNameParser.h"
40 #include "llvm/Support/PrettyStackTrace.h"
41 #include <llvm/CodeGen/Passes.h>
42 #include <llvm/CodeGen/MachineFunctionPass.h>
43 #include <llvm/CodeGen/MachineFunction.h>
44 #include <llvm/CodeGen/MachineFrameInfo.h>
45 #include <llvm/IR/Function.h>
46 #include <llvm/IR/IRBuilder.h>
47 #include <llvm/IR/Module.h>
49 #include "llvm-c/Core.h"
50 #include "llvm-c/ExecutionEngine.h"
52 #include "mini-llvm-cpp.h"
54 // extern "C" void LLVMInitializeARMTargetInfo();
55 // extern "C" void LLVMInitializeARMTarget ();
56 // extern "C" void LLVMInitializeARMTargetMC ();
60 #ifndef MONO_CROSS_COMPILE
63 mono_llvm_cpp_throw_exception (gint32 *exc)
69 mono_llvm_cpp_rethrow_exception (gint32 *exc)
74 void (*unhandled_exception)() = default_mono_llvm_unhandled_exception;
77 mono_llvm_set_unhandled_exception_handler (void)
79 std::set_terminate (unhandled_exception);
82 class MonoJITMemoryManager : public JITMemoryManager
88 /* Callbacks installed by mono */
89 AllocCodeMemoryCb *alloc_cb;
91 ExceptionTableCb *exception_cb;
93 MonoJITMemoryManager ();
94 ~MonoJITMemoryManager ();
96 void setMemoryWritable (void);
98 void setMemoryExecutable (void);
102 unsigned char *getGOTBase() const {
103 return mm->getGOTBase ();
106 void setPoisonMemory(bool) {
109 unsigned char *startFunctionBody(const Function *F,
110 uintptr_t &ActualSize);
112 unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
115 void endFunctionBody(const Function *F, unsigned char *FunctionStart,
116 unsigned char *FunctionEnd);
118 unsigned char *allocateSpace(intptr_t Size, unsigned Alignment);
120 uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
122 void deallocateMemForFunction(const Function *F);
124 unsigned char*startExceptionTable(const Function* F,
125 uintptr_t &ActualSize);
127 void endExceptionTable(const Function *F, unsigned char *TableStart,
128 unsigned char *TableEnd,
129 unsigned char* FrameRegister);
131 virtual void deallocateFunctionBody(void*) {
134 virtual void deallocateExceptionTable(void*) {
137 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
138 StringRef SectionName) {
144 virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment, unsigned SectionID,
145 StringRef SectionName, bool IsReadOnly) {
151 virtual bool applyPermissions(std::string*) {
157 virtual bool finalizeMemory(std::string *ErrMsg = 0) {
163 virtual void* getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure) {
167 err = dlsym_cb (Name.c_str (), &res);
169 outs () << "Unable to resolve: " << Name << ": " << err << "\n";
177 MonoJITMemoryManager::MonoJITMemoryManager ()
179 mm = JITMemoryManager::CreateDefaultMemManager ();
182 MonoJITMemoryManager::~MonoJITMemoryManager ()
188 MonoJITMemoryManager::setMemoryWritable (void)
193 MonoJITMemoryManager::setMemoryExecutable (void)
198 MonoJITMemoryManager::AllocateGOT()
204 MonoJITMemoryManager::startFunctionBody(const Function *F,
205 uintptr_t &ActualSize)
207 // FIXME: This leaks memory
210 return alloc_cb (wrap (F), ActualSize);
214 MonoJITMemoryManager::allocateStub(const GlobalValue* F, unsigned StubSize,
217 return alloc_cb (wrap (F), StubSize);
221 MonoJITMemoryManager::endFunctionBody(const Function *F, unsigned char *FunctionStart,
222 unsigned char *FunctionEnd)
227 MonoJITMemoryManager::allocateSpace(intptr_t Size, unsigned Alignment)
229 return new unsigned char [Size];
233 MonoJITMemoryManager::allocateGlobal(uintptr_t Size, unsigned Alignment)
235 return new unsigned char [Size];
239 MonoJITMemoryManager::deallocateMemForFunction(const Function *F)
244 MonoJITMemoryManager::startExceptionTable(const Function* F,
245 uintptr_t &ActualSize)
247 return startFunctionBody(F, ActualSize);
251 MonoJITMemoryManager::endExceptionTable(const Function *F, unsigned char *TableStart,
252 unsigned char *TableEnd,
253 unsigned char* FrameRegister)
255 exception_cb (FrameRegister);
260 class MonoJITMemoryManager {
263 #endif /* !MONO_CROSS_COMPILE */
265 class MonoJITEventListener : public JITEventListener {
268 FunctionEmittedCb *emitted_cb;
270 MonoJITEventListener (FunctionEmittedCb *cb) {
274 virtual void NotifyFunctionEmitted(const Function &F,
275 void *Code, size_t Size,
276 const EmittedFunctionDetails &Details) {
277 emitted_cb (wrap (&F), Code, (char*)Code + Size);
284 MonoJITMemoryManager *mm;
285 MonoJITEventListener *listener;
286 FunctionPassManager *fpm;
290 mono_llvm_optimize_method (MonoEERef eeref, LLVMValueRef method)
292 MonoEE *mono_ee = (MonoEE*)eeref;
295 * The verifier does some checks on the whole module, leading to quadratic behavior.
297 //verifyFunction (*(unwrap<Function> (method)));
298 mono_ee->fpm->run (*unwrap<Function> (method));
302 mono_llvm_dump_value (LLVMValueRef value)
304 /* Same as LLVMDumpValue (), but print to stdout */
306 outs () << (*unwrap<Value> (value));
309 /* Missing overload for building an alloca with an alignment */
311 mono_llvm_build_alloca (LLVMBuilderRef builder, LLVMTypeRef Ty,
312 LLVMValueRef ArraySize,
313 int alignment, const char *Name)
315 return wrap (unwrap (builder)->Insert (new AllocaInst (unwrap (Ty), unwrap (ArraySize), alignment), Name));
319 mono_llvm_build_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
320 const char *Name, gboolean is_volatile, BarrierKind barrier)
322 LoadInst *ins = unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name);
325 case LLVM_BARRIER_NONE:
327 case LLVM_BARRIER_ACQ:
328 ins->setOrdering(Acquire);
330 case LLVM_BARRIER_SEQ:
331 ins->setOrdering(SequentiallyConsistent);
334 g_assert_not_reached ();
342 mono_llvm_build_aligned_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
343 const char *Name, gboolean is_volatile, int alignment)
347 ins = unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name);
348 ins->setAlignment (alignment);
354 mono_llvm_build_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
355 gboolean is_volatile, BarrierKind barrier)
357 StoreInst *ins = unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile);
360 case LLVM_BARRIER_NONE:
362 case LLVM_BARRIER_REL:
363 ins->setOrdering(Release);
365 case LLVM_BARRIER_SEQ:
366 ins->setOrdering(SequentiallyConsistent);
369 g_assert_not_reached ();
377 mono_llvm_build_aligned_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
378 gboolean is_volatile, int alignment)
382 ins = unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile);
383 ins->setAlignment (alignment);
389 mono_llvm_build_cmpxchg (LLVMBuilderRef builder, LLVMValueRef ptr, LLVMValueRef cmp, LLVMValueRef val)
391 AtomicCmpXchgInst *ins;
393 ins = unwrap(builder)->CreateAtomicCmpXchg (unwrap(ptr), unwrap (cmp), unwrap (val), SequentiallyConsistent, SequentiallyConsistent);
398 mono_llvm_build_atomic_rmw (LLVMBuilderRef builder, AtomicRMWOp op, LLVMValueRef ptr, LLVMValueRef val)
400 AtomicRMWInst::BinOp aop = AtomicRMWInst::Xchg;
404 case LLVM_ATOMICRMW_OP_XCHG:
405 aop = AtomicRMWInst::Xchg;
407 case LLVM_ATOMICRMW_OP_ADD:
408 aop = AtomicRMWInst::Add;
411 g_assert_not_reached ();
415 ins = unwrap (builder)->CreateAtomicRMW (aop, unwrap (ptr), unwrap (val), SequentiallyConsistent);
420 mono_llvm_build_fence (LLVMBuilderRef builder, BarrierKind kind)
423 AtomicOrdering ordering;
425 g_assert (kind != LLVM_BARRIER_NONE);
428 case LLVM_BARRIER_ACQ:
431 case LLVM_BARRIER_REL:
434 case LLVM_BARRIER_SEQ:
435 ordering = SequentiallyConsistent;
438 g_assert_not_reached ();
442 ins = unwrap (builder)->CreateFence (ordering);
447 mono_llvm_set_must_tail (LLVMValueRef call_ins)
449 CallInst *ins = (CallInst*)unwrap (call_ins);
451 ins->setTailCallKind (CallInst::TailCallKind::TCK_MustTail);
455 mono_llvm_replace_uses_of (LLVMValueRef var, LLVMValueRef v)
457 Value *V = ConstantExpr::getTruncOrBitCast (unwrap<Constant> (v), unwrap (var)->getType ());
458 unwrap (var)->replaceAllUsesWith (V);
462 mono_llvm_create_constant_data_array (const uint8_t *data, int len)
464 return wrap(ConstantDataArray::get (*unwrap(LLVMGetGlobalContext ()), makeArrayRef(data, len)));
468 mono_llvm_set_is_constant (LLVMValueRef global_var)
470 unwrap<GlobalVariable>(global_var)->setConstant (true);
473 static cl::list<const PassInfo*, bool, PassNameParser>
474 PassList(cl::desc("Optimizations available:"));
477 force_pass_linking (void)
479 // Make sure the rest is linked in, but never executed
480 if (g_getenv ("FOO") != (char*)-1)
483 // This is a subset of the passes in LinkAllPasses.h
484 // The utility passes and the interprocedural passes are commented out
486 (void) llvm::createAAEvalPass();
487 (void) llvm::createAggressiveDCEPass();
488 (void) llvm::createAliasAnalysisCounterPass();
489 (void) llvm::createAliasDebugger();
491 (void) llvm::createArgumentPromotionPass();
492 (void) llvm::createStructRetPromotionPass();
494 (void) llvm::createBasicAliasAnalysisPass();
495 (void) llvm::createLibCallAliasAnalysisPass(0);
496 (void) llvm::createScalarEvolutionAliasAnalysisPass();
497 //(void) llvm::createBlockPlacementPass();
498 (void) llvm::createBreakCriticalEdgesPass();
499 (void) llvm::createCFGSimplificationPass();
501 (void) llvm::createConstantMergePass();
502 (void) llvm::createConstantPropagationPass();
505 (void) llvm::createDeadArgEliminationPass();
507 (void) llvm::createDeadCodeEliminationPass();
508 (void) llvm::createDeadInstEliminationPass();
509 (void) llvm::createDeadStoreEliminationPass();
511 (void) llvm::createDeadTypeEliminationPass();
512 (void) llvm::createDomOnlyPrinterPass();
513 (void) llvm::createDomPrinterPass();
514 (void) llvm::createDomOnlyViewerPass();
515 (void) llvm::createDomViewerPass();
516 (void) llvm::createEdgeProfilerPass();
517 (void) llvm::createOptimalEdgeProfilerPass();
518 (void) llvm::createFunctionInliningPass();
519 (void) llvm::createAlwaysInlinerPass();
520 (void) llvm::createGlobalDCEPass();
521 (void) llvm::createGlobalOptimizerPass();
522 (void) llvm::createGlobalsModRefPass();
523 (void) llvm::createIPConstantPropagationPass();
524 (void) llvm::createIPSCCPPass();
526 (void) llvm::createIndVarSimplifyPass();
527 (void) llvm::createInstructionCombiningPass();
529 (void) llvm::createInternalizePass(false);
531 (void) llvm::createLCSSAPass();
532 (void) llvm::createLICMPass();
533 (void) llvm::createLazyValueInfoPass();
534 //(void) llvm::createLoopDependenceAnalysisPass();
536 (void) llvm::createLoopExtractorPass();
538 (void) llvm::createLoopSimplifyPass();
539 (void) llvm::createLoopStrengthReducePass();
540 (void) llvm::createLoopUnrollPass();
541 (void) llvm::createLoopUnswitchPass();
542 (void) llvm::createLoopRotatePass();
543 (void) llvm::createLowerInvokePass();
545 (void) llvm::createLowerSetJmpPass();
547 (void) llvm::createLowerSwitchPass();
548 (void) llvm::createNoAAPass();
550 (void) llvm::createNoProfileInfoPass();
551 (void) llvm::createProfileEstimatorPass();
552 (void) llvm::createProfileVerifierPass();
553 (void) llvm::createProfileLoaderPass();
555 (void) llvm::createPromoteMemoryToRegisterPass();
556 (void) llvm::createDemoteRegisterToMemoryPass();
558 (void) llvm::createPruneEHPass();
559 (void) llvm::createPostDomOnlyPrinterPass();
560 (void) llvm::createPostDomPrinterPass();
561 (void) llvm::createPostDomOnlyViewerPass();
562 (void) llvm::createPostDomViewerPass();
564 (void) llvm::createReassociatePass();
565 (void) llvm::createSCCPPass();
566 (void) llvm::createScalarReplAggregatesPass();
567 //(void) llvm::createSimplifyLibCallsPass();
569 (void) llvm::createSingleLoopExtractorPass();
570 (void) llvm::createStripSymbolsPass();
571 (void) llvm::createStripNonDebugSymbolsPass();
572 (void) llvm::createStripDeadDebugInfoPass();
573 (void) llvm::createStripDeadPrototypesPass();
574 (void) llvm::createTailCallEliminationPass();
575 (void) llvm::createTailDuplicationPass();
576 (void) llvm::createJumpThreadingPass();
579 (void) llvm::createUnifyFunctionExitNodesPass();
581 (void) llvm::createInstCountPass();
582 (void) llvm::createCodeGenPreparePass();
583 (void) llvm::createGVNPass();
584 (void) llvm::createMemCpyOptPass();
585 (void) llvm::createLoopDeletionPass();
587 (void) llvm::createPostDomTree();
588 (void) llvm::createPostDomFrontier();
589 (void) llvm::createInstructionNamerPass();
590 (void) llvm::createPartialSpecializationPass();
591 (void) llvm::createFunctionAttrsPass();
592 (void) llvm::createMergeFunctionsPass();
593 (void) llvm::createPrintModulePass(0);
594 (void) llvm::createPrintFunctionPass("", 0);
595 (void) llvm::createDbgInfoPrinterPass();
596 (void) llvm::createModuleDebugInfoPrinterPass();
597 (void) llvm::createPartialInliningPass();
598 (void) llvm::createGEPSplitterPass();
599 (void) llvm::createLintPass();
601 (void) llvm::createSinkingPass();
604 #ifndef MONO_CROSS_COMPILE
606 static gboolean inited;
614 force_pass_linking ();
617 LLVMInitializeARMTarget ();
618 LLVMInitializeARMTargetInfo ();
619 LLVMInitializeARMTargetMC ();
621 LLVMInitializeX86Target ();
622 LLVMInitializeX86TargetInfo ();
623 LLVMInitializeX86TargetMC ();
626 PassRegistry &Registry = *PassRegistry::getPassRegistry();
627 initializeCore(Registry);
628 initializeScalarOpts(Registry);
629 initializeAnalysis(Registry);
630 initializeIPA(Registry);
631 initializeTransformUtils(Registry);
632 initializeInstCombine(Registry);
633 initializeTarget(Registry);
635 llvm::cl::ParseEnvironmentOptions("mono", "MONO_LLVM", "");
641 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
648 mono_ee = new MonoEE ();
650 MonoJITMemoryManager *mono_mm = new MonoJITMemoryManager ();
651 mono_mm->alloc_cb = alloc_cb;
652 mono_mm->dlsym_cb = dlsym_cb;
653 mono_mm->exception_cb = exception_cb;
654 mono_ee->mm = mono_mm;
657 * The Default code model doesn't seem to work on amd64,
658 * test_0_fields_with_big_offsets (among others) crashes, because LLVM tries to call
659 * memset using a normal pcrel code which is in 32bit memory, while memset isn't.
663 opts.JITExceptionHandling = 1;
665 StringRef cpu_name = sys::getHostCPUName ();
667 // EngineBuilder no longer has a copy assignment operator (?)
668 std::unique_ptr<Module> Owner(unwrap(MP));
669 EngineBuilder b (std::move(Owner));
670 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).setMCPU (cpu_name).create ();
675 MonoJITEventListener *listener = new MonoJITEventListener (emitted_cb);
676 EE->RegisterJITEventListener (listener);
677 mono_ee->listener = listener;
679 FunctionPassManager *fpm = new FunctionPassManager (unwrap (MP));
682 fpm->add(new DataLayoutPass(*EE->getDataLayout()));
684 if (PassList.size() > 0) {
685 /* Use the passes specified by the env variable */
686 /* Only the passes in force_pass_linking () can be used */
687 for (unsigned i = 0; i < PassList.size(); ++i) {
688 const PassInfo *PassInf = PassList[i];
691 if (PassInf->getNormalCtor())
692 P = PassInf->getNormalCtor()();
696 /* Use the same passes used by 'opt' by default, without the ipo passes */
697 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";
701 args = g_strsplit (opts, " ", 1000);
702 for (i = 0; args [i]; i++)
704 llvm::cl::ParseCommandLineOptions (i, args, "");
707 for (unsigned i = 0; i < PassList.size(); ++i) {
708 const PassInfo *PassInf = PassList[i];
711 if (PassInf->getNormalCtor())
712 P = PassInf->getNormalCtor()();
713 g_assert (P->getPassKind () == llvm::PT_Function || P->getPassKind () == llvm::PT_Loop);
718 fpm->add(createInstructionCombiningPass());
719 fpm->add(createReassociatePass());
720 fpm->add(createGVNPass());
721 fpm->add(createCFGSimplificationPass());
731 mono_llvm_dispose_ee (MonoEERef *eeref)
733 MonoEE *mono_ee = (MonoEE*)eeref;
737 //delete mono_ee->mm;
738 delete mono_ee->listener;
745 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb, LLVMExecutionEngineRef *ee)
747 g_assert_not_reached ();
752 mono_llvm_dispose_ee (MonoEERef *eeref)
754 g_assert_not_reached ();
759 LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
762 g_assert_not_reached ();
766 LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global)
768 g_assert_not_reached ();
773 #endif /* !MONO_CROSS_COMPILE */