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
24 //undef those as llvm defines them on its own config.h as well.
25 #undef PACKAGE_BUGREPORT
28 #undef PACKAGE_TARNAME
29 #undef PACKAGE_VERSION
33 #include <llvm/Support/raw_ostream.h>
34 #include <llvm/PassManager.h>
35 #include <llvm/ExecutionEngine/ExecutionEngine.h>
36 #include <llvm/ExecutionEngine/JITMemoryManager.h>
37 #include <llvm/ExecutionEngine/JITEventListener.h>
38 #include <llvm/Target/TargetOptions.h>
39 #include <llvm/Target/TargetRegisterInfo.h>
40 #include <llvm/Analysis/Verifier.h>
41 #include <llvm/Analysis/Passes.h>
42 #include <llvm/Transforms/Scalar.h>
43 #include <llvm/Support/CommandLine.h>
44 #include "llvm/Support/PassNameParser.h"
45 #include "llvm/Support/PrettyStackTrace.h"
46 #include <llvm/CodeGen/Passes.h>
47 #include <llvm/CodeGen/MachineFunctionPass.h>
48 #include <llvm/CodeGen/MachineFunction.h>
49 #include <llvm/CodeGen/MachineFrameInfo.h>
50 #include <llvm/IR/Function.h>
51 #include <llvm/IR/IRBuilder.h>
52 #include <llvm/IR/Module.h>
53 //#include <llvm/LinkAllPasses.h>
55 #include "llvm-c/Core.h"
56 #include "llvm-c/ExecutionEngine.h"
58 #include "mini-llvm-cpp.h"
60 #define LLVM_CHECK_VERSION(major,minor) \
61 ((LLVM_MAJOR_VERSION > (major)) || \
62 ((LLVM_MAJOR_VERSION == (major)) && (LLVM_MINOR_VERSION >= (minor))))
64 // extern "C" void LLVMInitializeARMTargetInfo();
65 // extern "C" void LLVMInitializeARMTarget ();
66 // extern "C" void LLVMInitializeARMTargetMC ();
70 #ifndef MONO_CROSS_COMPILE
72 class MonoJITMemoryManager : public JITMemoryManager
78 /* Callbacks installed by mono */
79 AllocCodeMemoryCb *alloc_cb;
82 MonoJITMemoryManager ();
83 ~MonoJITMemoryManager ();
85 void setMemoryWritable (void);
87 void setMemoryExecutable (void);
91 unsigned char *getGOTBase() const {
92 return mm->getGOTBase ();
95 void setPoisonMemory(bool) {
98 unsigned char *startFunctionBody(const Function *F,
99 uintptr_t &ActualSize);
101 unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
104 void endFunctionBody(const Function *F, unsigned char *FunctionStart,
105 unsigned char *FunctionEnd);
107 unsigned char *allocateSpace(intptr_t Size, unsigned Alignment);
109 uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
111 void deallocateMemForFunction(const Function *F);
113 unsigned char*startExceptionTable(const Function* F,
114 uintptr_t &ActualSize);
116 void endExceptionTable(const Function *F, unsigned char *TableStart,
117 unsigned char *TableEnd,
118 unsigned char* FrameRegister);
120 virtual void deallocateFunctionBody(void*) {
123 virtual void deallocateExceptionTable(void*) {
126 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
127 unsigned SectionID) {
133 virtual uint8_t* allocateDataSection(uintptr_t, unsigned int, unsigned int, bool) {
139 virtual bool applyPermissions(std::string*) {
145 virtual void* getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure) {
149 err = dlsym_cb (Name.c_str (), &res);
151 outs () << "Unable to resolve: " << Name << ": " << err << "\n";
159 MonoJITMemoryManager::MonoJITMemoryManager ()
161 mm = JITMemoryManager::CreateDefaultMemManager ();
164 MonoJITMemoryManager::~MonoJITMemoryManager ()
170 MonoJITMemoryManager::setMemoryWritable (void)
175 MonoJITMemoryManager::setMemoryExecutable (void)
180 MonoJITMemoryManager::AllocateGOT()
186 MonoJITMemoryManager::startFunctionBody(const Function *F,
187 uintptr_t &ActualSize)
189 // FIXME: This leaks memory
192 return alloc_cb (wrap (F), ActualSize);
196 MonoJITMemoryManager::allocateStub(const GlobalValue* F, unsigned StubSize,
199 return alloc_cb (wrap (F), StubSize);
203 MonoJITMemoryManager::endFunctionBody(const Function *F, unsigned char *FunctionStart,
204 unsigned char *FunctionEnd)
209 MonoJITMemoryManager::allocateSpace(intptr_t Size, unsigned Alignment)
211 return new unsigned char [Size];
215 MonoJITMemoryManager::allocateGlobal(uintptr_t Size, unsigned Alignment)
217 return new unsigned char [Size];
221 MonoJITMemoryManager::deallocateMemForFunction(const Function *F)
226 MonoJITMemoryManager::startExceptionTable(const Function* F,
227 uintptr_t &ActualSize)
229 return startFunctionBody(F, ActualSize);
233 MonoJITMemoryManager::endExceptionTable(const Function *F, unsigned char *TableStart,
234 unsigned char *TableEnd,
235 unsigned char* FrameRegister)
239 #endif /* !MONO_CROSS_COMPILE */
241 class MonoJITEventListener : public JITEventListener {
244 FunctionEmittedCb *emitted_cb;
246 MonoJITEventListener (FunctionEmittedCb *cb) {
250 virtual void NotifyFunctionEmitted(const Function &F,
251 void *Code, size_t Size,
252 const EmittedFunctionDetails &Details) {
254 * X86TargetMachine::setCodeModelForJIT() sets the code model to Large on amd64,
255 * which means the JIT will generate calls of the form
258 * Our trampoline code can't patch this. Passing CodeModel::Small to createJIT
259 * doesn't seem to work, we need Default. A discussion is here:
260 * http://lists.cs.uiuc.edu/pipermail/llvmdev/2009-December/027999.html
261 * There seems to no way to get the TargeMachine used by an EE either, so we
262 * install a profiler hook and reset the code model here.
263 * This should be inside an ifdef, but we can't include our config.h either,
264 * since its definitions conflict with LLVM's config.h.
267 //#if defined(TARGET_X86) || defined(TARGET_AMD64)
268 #ifndef LLVM_MONO_BRANCH
269 /* The LLVM mono branch contains a workaround, so this is not needed */
270 if (Details.MF->getTarget ().getCodeModel () == CodeModel::Large) {
271 Details.MF->getTarget ().setCodeModel (CodeModel::Default);
276 emitted_cb (wrap (&F), Code, (char*)Code + Size);
280 #ifndef MONO_CROSS_COMPILE
281 static MonoJITMemoryManager *mono_mm;
283 static MonoJITEventListener *mono_event_listener;
285 static FunctionPassManager *fpm;
288 mono_llvm_optimize_method (LLVMValueRef method)
290 verifyFunction (*(unwrap<Function> (method)));
291 fpm->run (*unwrap<Function> (method));
295 mono_llvm_dump_value (LLVMValueRef value)
297 /* Same as LLVMDumpValue (), but print to stdout */
299 outs () << (*unwrap<Value> (value));
302 /* Missing overload for building an alloca with an alignment */
304 mono_llvm_build_alloca (LLVMBuilderRef builder, LLVMTypeRef Ty,
305 LLVMValueRef ArraySize,
306 int alignment, const char *Name)
308 return wrap (unwrap (builder)->Insert (new AllocaInst (unwrap (Ty), unwrap (ArraySize), alignment), Name));
312 mono_llvm_build_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
313 const char *Name, gboolean is_volatile)
315 return wrap(unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name));
319 mono_llvm_build_aligned_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
320 const char *Name, gboolean is_volatile, int alignment)
324 ins = unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name);
325 ins->setAlignment (alignment);
331 mono_llvm_build_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
332 gboolean is_volatile)
334 return wrap(unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile));
338 mono_llvm_build_aligned_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
339 gboolean is_volatile, int alignment)
343 ins = unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile);
344 ins->setAlignment (alignment);
350 mono_llvm_build_cmpxchg (LLVMBuilderRef builder, LLVMValueRef ptr, LLVMValueRef cmp, LLVMValueRef val)
352 AtomicCmpXchgInst *ins;
354 ins = unwrap(builder)->CreateAtomicCmpXchg (unwrap(ptr), unwrap (cmp), unwrap (val), SequentiallyConsistent);
359 mono_llvm_build_atomic_rmw (LLVMBuilderRef builder, AtomicRMWOp op, LLVMValueRef ptr, LLVMValueRef val)
361 AtomicRMWInst::BinOp aop = AtomicRMWInst::Xchg;
365 case LLVM_ATOMICRMW_OP_XCHG:
366 aop = AtomicRMWInst::Xchg;
368 case LLVM_ATOMICRMW_OP_ADD:
369 aop = AtomicRMWInst::Add;
372 g_assert_not_reached ();
376 ins = unwrap (builder)->CreateAtomicRMW (aop, unwrap (ptr), unwrap (val), AcquireRelease);
381 mono_llvm_build_fence (LLVMBuilderRef builder)
385 ins = unwrap (builder)->CreateFence (AcquireRelease);
390 mono_llvm_replace_uses_of (LLVMValueRef var, LLVMValueRef v)
392 Value *V = ConstantExpr::getTruncOrBitCast (unwrap<Constant> (v), unwrap (var)->getType ());
393 unwrap (var)->replaceAllUsesWith (V);
396 static cl::list<const PassInfo*, bool, PassNameParser>
397 PassList(cl::desc("Optimizations available:"));
400 force_pass_linking (void)
402 // Make sure the rest is linked in, but never executed
403 if (g_getenv ("FOO") != (char*)-1)
406 // This is a subset of the passes in LinkAllPasses.h
407 // The utility passes and the interprocedural passes are commented out
409 (void) llvm::createAAEvalPass();
410 (void) llvm::createAggressiveDCEPass();
411 (void) llvm::createAliasAnalysisCounterPass();
412 (void) llvm::createAliasDebugger();
414 (void) llvm::createArgumentPromotionPass();
415 (void) llvm::createStructRetPromotionPass();
417 (void) llvm::createBasicAliasAnalysisPass();
418 (void) llvm::createLibCallAliasAnalysisPass(0);
419 (void) llvm::createScalarEvolutionAliasAnalysisPass();
420 (void) llvm::createBlockPlacementPass();
421 (void) llvm::createBreakCriticalEdgesPass();
422 (void) llvm::createCFGSimplificationPass();
424 (void) llvm::createConstantMergePass();
425 (void) llvm::createConstantPropagationPass();
428 (void) llvm::createDeadArgEliminationPass();
430 (void) llvm::createDeadCodeEliminationPass();
431 (void) llvm::createDeadInstEliminationPass();
432 (void) llvm::createDeadStoreEliminationPass();
434 (void) llvm::createDeadTypeEliminationPass();
435 (void) llvm::createDomOnlyPrinterPass();
436 (void) llvm::createDomPrinterPass();
437 (void) llvm::createDomOnlyViewerPass();
438 (void) llvm::createDomViewerPass();
439 (void) llvm::createEdgeProfilerPass();
440 (void) llvm::createOptimalEdgeProfilerPass();
441 (void) llvm::createFunctionInliningPass();
442 (void) llvm::createAlwaysInlinerPass();
443 (void) llvm::createGlobalDCEPass();
444 (void) llvm::createGlobalOptimizerPass();
445 (void) llvm::createGlobalsModRefPass();
446 (void) llvm::createIPConstantPropagationPass();
447 (void) llvm::createIPSCCPPass();
449 (void) llvm::createIndVarSimplifyPass();
450 (void) llvm::createInstructionCombiningPass();
452 (void) llvm::createInternalizePass(false);
454 (void) llvm::createLCSSAPass();
455 (void) llvm::createLICMPass();
456 (void) llvm::createLazyValueInfoPass();
457 //(void) llvm::createLoopDependenceAnalysisPass();
459 (void) llvm::createLoopExtractorPass();
461 (void) llvm::createLoopSimplifyPass();
462 (void) llvm::createLoopStrengthReducePass();
463 (void) llvm::createLoopUnrollPass();
464 (void) llvm::createLoopUnswitchPass();
465 (void) llvm::createLoopRotatePass();
466 (void) llvm::createLowerInvokePass();
468 (void) llvm::createLowerSetJmpPass();
470 (void) llvm::createLowerSwitchPass();
471 (void) llvm::createNoAAPass();
473 (void) llvm::createNoProfileInfoPass();
474 (void) llvm::createProfileEstimatorPass();
475 (void) llvm::createProfileVerifierPass();
476 (void) llvm::createProfileLoaderPass();
478 (void) llvm::createPromoteMemoryToRegisterPass();
479 (void) llvm::createDemoteRegisterToMemoryPass();
481 (void) llvm::createPruneEHPass();
482 (void) llvm::createPostDomOnlyPrinterPass();
483 (void) llvm::createPostDomPrinterPass();
484 (void) llvm::createPostDomOnlyViewerPass();
485 (void) llvm::createPostDomViewerPass();
487 (void) llvm::createReassociatePass();
488 (void) llvm::createSCCPPass();
489 (void) llvm::createScalarReplAggregatesPass();
490 (void) llvm::createSimplifyLibCallsPass();
492 (void) llvm::createSingleLoopExtractorPass();
493 (void) llvm::createStripSymbolsPass();
494 (void) llvm::createStripNonDebugSymbolsPass();
495 (void) llvm::createStripDeadDebugInfoPass();
496 (void) llvm::createStripDeadPrototypesPass();
497 (void) llvm::createTailCallEliminationPass();
498 (void) llvm::createTailDuplicationPass();
499 (void) llvm::createJumpThreadingPass();
502 (void) llvm::createUnifyFunctionExitNodesPass();
504 (void) llvm::createInstCountPass();
505 (void) llvm::createCodeGenPreparePass();
506 (void) llvm::createGVNPass();
507 (void) llvm::createMemCpyOptPass();
508 (void) llvm::createLoopDeletionPass();
510 (void) llvm::createPostDomTree();
511 (void) llvm::createPostDomFrontier();
512 (void) llvm::createInstructionNamerPass();
513 (void) llvm::createPartialSpecializationPass();
514 (void) llvm::createFunctionAttrsPass();
515 (void) llvm::createMergeFunctionsPass();
516 (void) llvm::createPrintModulePass(0);
517 (void) llvm::createPrintFunctionPass("", 0);
518 (void) llvm::createDbgInfoPrinterPass();
519 (void) llvm::createModuleDebugInfoPrinterPass();
520 (void) llvm::createPartialInliningPass();
521 (void) llvm::createGEPSplitterPass();
522 (void) llvm::createLintPass();
524 (void) llvm::createSinkingPass();
527 #ifndef MONO_CROSS_COMPILE
529 LLVMExecutionEngineRef
530 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb)
534 force_pass_linking ();
537 LLVMInitializeARMTarget ();
538 LLVMInitializeARMTargetInfo ();
539 LLVMInitializeARMTargetMC ();
541 LLVMInitializeX86Target ();
542 LLVMInitializeX86TargetInfo ();
543 LLVMInitializeX86TargetMC ();
546 mono_mm = new MonoJITMemoryManager ();
547 mono_mm->alloc_cb = alloc_cb;
548 mono_mm->dlsym_cb = dlsym_cb;
550 //JITExceptionHandling = true;
551 // PrettyStackTrace installs signal handlers which trip up libgc
552 DisablePrettyStackTrace = true;
555 * The Default code model doesn't seem to work on amd64,
556 * test_0_fields_with_big_offsets (among others) crashes, because LLVM tries to call
557 * memset using a normal pcrel code which is in 32bit memory, while memset isn't.
561 opts.JITExceptionHandling = 1;
563 EngineBuilder b (unwrap (MP));
565 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setCodeModel (CodeModel::Large).setAllocateGVsWithCode (true).create ();
567 ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).create ();
572 ExecutionEngine *EE = ExecutionEngine::createJIT (unwrap (MP), &Error, mono_mm, CodeGenOpt::Default, true, Reloc::Default, CodeModel::Large);
574 errs () << "Unable to create LLVM ExecutionEngine: " << Error << "\n";
575 g_assert_not_reached ();
579 EE->InstallExceptionTableRegister (exception_cb);
580 mono_event_listener = new MonoJITEventListener (emitted_cb);
581 EE->RegisterJITEventListener (mono_event_listener);
583 fpm = new FunctionPassManager (unwrap (MP));
585 fpm->add(new DataLayout(*EE->getDataLayout()));
587 PassRegistry &Registry = *PassRegistry::getPassRegistry();
588 initializeCore(Registry);
589 initializeScalarOpts(Registry);
590 //initializeIPO(Registry);
591 initializeAnalysis(Registry);
592 initializeIPA(Registry);
593 initializeTransformUtils(Registry);
594 initializeInstCombine(Registry);
595 //initializeInstrumentation(Registry);
596 initializeTarget(Registry);
598 llvm::cl::ParseEnvironmentOptions("mono", "MONO_LLVM", "");
600 if (PassList.size() > 0) {
601 /* Use the passes specified by the env variable */
602 /* Only the passes in force_pass_linking () can be used */
603 for (unsigned i = 0; i < PassList.size(); ++i) {
604 const PassInfo *PassInf = PassList[i];
607 if (PassInf->getNormalCtor())
608 P = PassInf->getNormalCtor()();
612 /* Use the same passes used by 'opt' by default, without the ipo passes */
613 const char *opts = "-simplifycfg -domtree -domfrontier -scalarrepl -instcombine -simplifycfg -domtree -domfrontier -scalarrepl -simplify-libcalls -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 -preverify -domtree -verify";
617 args = g_strsplit (opts, " ", 1000);
618 for (i = 0; args [i]; i++)
620 llvm::cl::ParseCommandLineOptions (i, args, "");
623 for (unsigned i = 0; i < PassList.size(); ++i) {
624 const PassInfo *PassInf = PassList[i];
627 if (PassInf->getNormalCtor())
628 P = PassInf->getNormalCtor()();
629 g_assert (P->getPassKind () == llvm::PT_Function || P->getPassKind () == llvm::PT_Loop);
634 fpm->add(createInstructionCombiningPass());
635 fpm->add(createReassociatePass());
636 fpm->add(createGVNPass());
637 fpm->add(createCFGSimplificationPass());
645 mono_llvm_dispose_ee (LLVMExecutionEngineRef ee)
654 LLVMExecutionEngineRef
655 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb)
657 g_assert_not_reached ();
662 mono_llvm_dispose_ee (LLVMExecutionEngineRef ee)
664 g_assert_not_reached ();
669 LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
672 g_assert_not_reached ();
676 LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global)
678 g_assert_not_reached ();
682 #endif /* !MONO_CROSS_COMPILE */