Merge pull request #496 from nicolas-raoul/unit-test-for-issue2907
[mono.git] / mono / mini / mini-llvm-cpp.cpp
1 //
2 // mini-llvm-cpp.cpp: C++ support classes for the mono LLVM integration
3 //
4 // (C) 2009-2011 Novell, Inc.
5 // Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
6 //
7
8 //
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
15 //   tables.
16 //
17
18 //
19 // Mono's internal header files are not C++ clean, so avoid including them if 
20 // possible
21 //
22
23 #include "config.h"
24 //undef those as llvm defines them on its own config.h as well.
25 #undef PACKAGE_BUGREPORT
26 #undef PACKAGE_NAME
27 #undef PACKAGE_STRING
28 #undef PACKAGE_TARNAME
29 #undef PACKAGE_VERSION
30
31 #include <stdint.h>
32
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/TargetData.h>
40 #include <llvm/Target/TargetRegisterInfo.h>
41 #include <llvm/Analysis/Verifier.h>
42 #include <llvm/Analysis/Passes.h>
43 #include <llvm/Transforms/Scalar.h>
44 #include <llvm/Support/CommandLine.h>
45 #include "llvm/Support/PassNameParser.h"
46 #include "llvm/Support/PrettyStackTrace.h"
47 #include <llvm/CodeGen/Passes.h>
48 #include <llvm/CodeGen/MachineFunctionPass.h>
49 #include <llvm/CodeGen/MachineFunction.h>
50 #include <llvm/CodeGen/MachineFrameInfo.h>
51 //#include <llvm/LinkAllPasses.h>
52
53 #include "llvm-c/Core.h"
54 #include "llvm-c/ExecutionEngine.h"
55
56 #include "mini-llvm-cpp.h"
57
58 #define LLVM_CHECK_VERSION(major,minor) \
59         ((LLVM_MAJOR_VERSION > (major)) ||                                                                      \
60          ((LLVM_MAJOR_VERSION == (major)) && (LLVM_MINOR_VERSION >= (minor))))
61
62 // extern "C" void LLVMInitializeARMTargetInfo();
63 // extern "C" void LLVMInitializeARMTarget ();
64 // extern "C" void LLVMInitializeARMTargetMC ();
65
66 using namespace llvm;
67
68 class MonoJITMemoryManager : public JITMemoryManager
69 {
70 private:
71         JITMemoryManager *mm;
72
73 public:
74         /* Callbacks installed by mono */
75         AllocCodeMemoryCb *alloc_cb;
76         DlSymCb *dlsym_cb;
77
78         MonoJITMemoryManager ();
79         ~MonoJITMemoryManager ();
80
81         void setMemoryWritable (void);
82
83         void setMemoryExecutable (void);
84
85         void AllocateGOT();
86
87     unsigned char *getGOTBase() const {
88                 return mm->getGOTBase ();
89     }
90
91         void setPoisonMemory(bool) {
92         }
93
94         unsigned char *startFunctionBody(const Function *F, 
95                                                                          uintptr_t &ActualSize);
96   
97         unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
98                                                                  unsigned Alignment);
99   
100         void endFunctionBody(const Function *F, unsigned char *FunctionStart,
101                                                  unsigned char *FunctionEnd);
102
103         unsigned char *allocateSpace(intptr_t Size, unsigned Alignment);
104
105         uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
106   
107         void deallocateMemForFunction(const Function *F);
108   
109         unsigned char*startExceptionTable(const Function* F,
110                                                                           uintptr_t &ActualSize);
111   
112         void endExceptionTable(const Function *F, unsigned char *TableStart,
113                                                    unsigned char *TableEnd, 
114                                                    unsigned char* FrameRegister);
115
116         virtual void deallocateFunctionBody(void*) {
117         }
118
119         virtual void deallocateExceptionTable(void*) {
120         }
121
122         virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
123                                                                                  unsigned SectionID) {
124                 // FIXME:
125                 assert(0);
126                 return NULL;
127         }
128
129         virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
130                                                                                  unsigned SectionID) {
131                 // FIXME:
132                 assert(0);
133                 return NULL;
134         }
135
136         virtual void* getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure) {
137                 void *res;
138                 char *err;
139
140                 err = dlsym_cb (Name.c_str (), &res);
141                 if (err) {
142                         outs () << "Unable to resolve: " << Name << ": " << err << "\n";
143                         assert(0);
144                         return NULL;
145                 }
146                 return res;
147         }
148 };
149
150 MonoJITMemoryManager::MonoJITMemoryManager ()
151 {
152         mm = JITMemoryManager::CreateDefaultMemManager ();
153 }
154
155 MonoJITMemoryManager::~MonoJITMemoryManager ()
156 {
157         delete mm;
158 }
159
160 void
161 MonoJITMemoryManager::setMemoryWritable (void)
162 {
163 }
164
165 void
166 MonoJITMemoryManager::setMemoryExecutable (void)
167 {
168 }
169
170 void
171 MonoJITMemoryManager::AllocateGOT()
172 {
173         mm->AllocateGOT ();
174 }
175
176 unsigned char *
177 MonoJITMemoryManager::startFunctionBody(const Function *F, 
178                                         uintptr_t &ActualSize)
179 {
180         // FIXME: This leaks memory
181         if (ActualSize == 0)
182                 ActualSize = 128;
183         return alloc_cb (wrap (F), ActualSize);
184 }
185   
186 unsigned char *
187 MonoJITMemoryManager::allocateStub(const GlobalValue* F, unsigned StubSize,
188                            unsigned Alignment)
189 {
190         return alloc_cb (wrap (F), StubSize);
191 }
192   
193 void
194 MonoJITMemoryManager::endFunctionBody(const Function *F, unsigned char *FunctionStart,
195                                   unsigned char *FunctionEnd)
196 {
197 }
198
199 unsigned char *
200 MonoJITMemoryManager::allocateSpace(intptr_t Size, unsigned Alignment)
201 {
202         return new unsigned char [Size];
203 }
204
205 uint8_t *
206 MonoJITMemoryManager::allocateGlobal(uintptr_t Size, unsigned Alignment)
207 {
208         return new unsigned char [Size];
209 }
210
211 void
212 MonoJITMemoryManager::deallocateMemForFunction(const Function *F)
213 {
214 }
215   
216 unsigned char*
217 MonoJITMemoryManager::startExceptionTable(const Function* F,
218                                           uintptr_t &ActualSize)
219 {
220         return startFunctionBody(F, ActualSize);
221 }
222   
223 void
224 MonoJITMemoryManager::endExceptionTable(const Function *F, unsigned char *TableStart,
225                                         unsigned char *TableEnd, 
226                                         unsigned char* FrameRegister)
227 {
228 }
229
230 class MonoJITEventListener : public JITEventListener {
231
232 public:
233         FunctionEmittedCb *emitted_cb;
234
235         MonoJITEventListener (FunctionEmittedCb *cb) {
236                 emitted_cb = cb;
237         }
238
239         virtual void NotifyFunctionEmitted(const Function &F,
240                                                                            void *Code, size_t Size,
241                                                                            const EmittedFunctionDetails &Details) {
242                 /*
243                  * X86TargetMachine::setCodeModelForJIT() sets the code model to Large on amd64,
244                  * which means the JIT will generate calls of the form
245                  * mov reg, <imm>
246                  * call *reg
247                  * Our trampoline code can't patch this. Passing CodeModel::Small to createJIT
248                  * doesn't seem to work, we need Default. A discussion is here:
249                  * http://lists.cs.uiuc.edu/pipermail/llvmdev/2009-December/027999.html
250                  * There seems to no way to get the TargeMachine used by an EE either, so we
251                  * install a profiler hook and reset the code model here.
252                  * This should be inside an ifdef, but we can't include our config.h either,
253                  * since its definitions conflict with LLVM's config.h.
254                  *
255                  */
256                 //#if defined(TARGET_X86) || defined(TARGET_AMD64)
257 #ifndef LLVM_MONO_BRANCH
258                 /* The LLVM mono branch contains a workaround, so this is not needed */
259                 if (Details.MF->getTarget ().getCodeModel () == CodeModel::Large) {
260                         Details.MF->getTarget ().setCodeModel (CodeModel::Default);
261                 }
262 #endif
263                 //#endif
264
265                 emitted_cb (wrap (&F), Code, (char*)Code + Size);
266         }
267 };
268
269 static MonoJITMemoryManager *mono_mm;
270 static MonoJITEventListener *mono_event_listener;
271
272 static FunctionPassManager *fpm;
273
274 void
275 mono_llvm_optimize_method (LLVMValueRef method)
276 {
277         verifyFunction (*(unwrap<Function> (method)));
278         fpm->run (*unwrap<Function> (method));
279 }
280
281 void
282 mono_llvm_dump_value (LLVMValueRef value)
283 {
284         /* Same as LLVMDumpValue (), but print to stdout */
285         fflush (stdout);
286         outs () << (*unwrap<Value> (value));
287 }
288
289 /* Missing overload for building an alloca with an alignment */
290 LLVMValueRef
291 mono_llvm_build_alloca (LLVMBuilderRef builder, LLVMTypeRef Ty, 
292                                                 LLVMValueRef ArraySize,
293                                                 int alignment, const char *Name)
294 {
295         return wrap (unwrap (builder)->Insert (new AllocaInst (unwrap (Ty), unwrap (ArraySize), alignment), Name));
296 }
297
298 LLVMValueRef 
299 mono_llvm_build_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
300                                           const char *Name, gboolean is_volatile)
301 {
302         return wrap(unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name));
303 }
304
305 LLVMValueRef 
306 mono_llvm_build_aligned_load (LLVMBuilderRef builder, LLVMValueRef PointerVal,
307                                                           const char *Name, gboolean is_volatile, int alignment)
308 {
309         LoadInst *ins;
310
311         ins = unwrap(builder)->CreateLoad(unwrap(PointerVal), is_volatile, Name);
312         ins->setAlignment (alignment);
313
314         return wrap(ins);
315 }
316
317 LLVMValueRef 
318 mono_llvm_build_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
319                                           gboolean is_volatile)
320 {
321         return wrap(unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile));
322 }
323
324 LLVMValueRef 
325 mono_llvm_build_aligned_store (LLVMBuilderRef builder, LLVMValueRef Val, LLVMValueRef PointerVal,
326                                                            gboolean is_volatile, int alignment)
327 {
328         StoreInst *ins;
329
330         ins = unwrap(builder)->CreateStore(unwrap(Val), unwrap(PointerVal), is_volatile);
331         ins->setAlignment (alignment);
332
333         return wrap (ins);
334 }
335
336 LLVMValueRef
337 mono_llvm_build_cmpxchg (LLVMBuilderRef builder, LLVMValueRef ptr, LLVMValueRef cmp, LLVMValueRef val)
338 {
339         AtomicCmpXchgInst *ins;
340
341         ins = unwrap(builder)->CreateAtomicCmpXchg (unwrap(ptr), unwrap (cmp), unwrap (val), SequentiallyConsistent);
342         return wrap (ins);
343 }
344
345 LLVMValueRef
346 mono_llvm_build_atomic_rmw (LLVMBuilderRef builder, AtomicRMWOp op, LLVMValueRef ptr, LLVMValueRef val)
347 {
348         AtomicRMWInst::BinOp aop = AtomicRMWInst::Xchg;
349         AtomicRMWInst *ins;
350
351         switch (op) {
352         case LLVM_ATOMICRMW_OP_XCHG:
353                 aop = AtomicRMWInst::Xchg;
354                 break;
355         case LLVM_ATOMICRMW_OP_ADD:
356                 aop = AtomicRMWInst::Add;
357                 break;
358         default:
359                 g_assert_not_reached ();
360                 break;
361         }
362
363         ins = unwrap (builder)->CreateAtomicRMW (aop, unwrap (ptr), unwrap (val), AcquireRelease);
364         return wrap (ins);
365 }
366
367 LLVMValueRef
368 mono_llvm_build_fence (LLVMBuilderRef builder)
369 {
370         FenceInst *ins;
371
372         ins = unwrap (builder)->CreateFence (AcquireRelease);
373         return wrap (ins);
374 }
375
376 void
377 mono_llvm_replace_uses_of (LLVMValueRef var, LLVMValueRef v)
378 {
379         Value *V = ConstantExpr::getTruncOrBitCast (unwrap<Constant> (v), unwrap (var)->getType ());
380         unwrap (var)->replaceAllUsesWith (V);
381 }
382
383 static cl::list<const PassInfo*, bool, PassNameParser>
384 PassList(cl::desc("Optimizations available:"));
385
386 static void
387 force_pass_linking (void)
388 {
389         // Make sure the rest is linked in, but never executed
390         if (getenv ("FOO") != (char*)-1)
391                 return;
392
393         // This is a subset of the passes in LinkAllPasses.h
394         // The utility passes and the interprocedural passes are commented out
395
396       (void) llvm::createAAEvalPass();
397       (void) llvm::createAggressiveDCEPass();
398       (void) llvm::createAliasAnalysisCounterPass();
399       (void) llvm::createAliasDebugger();
400           /*
401       (void) llvm::createArgumentPromotionPass();
402       (void) llvm::createStructRetPromotionPass();
403           */
404       (void) llvm::createBasicAliasAnalysisPass();
405       (void) llvm::createLibCallAliasAnalysisPass(0);
406       (void) llvm::createScalarEvolutionAliasAnalysisPass();
407       (void) llvm::createBlockPlacementPass();
408       (void) llvm::createBreakCriticalEdgesPass();
409       (void) llvm::createCFGSimplificationPass();
410           /*
411       (void) llvm::createConstantMergePass();
412       (void) llvm::createConstantPropagationPass();
413           */
414           /*
415       (void) llvm::createDeadArgEliminationPass();
416           */
417       (void) llvm::createDeadCodeEliminationPass();
418       (void) llvm::createDeadInstEliminationPass();
419       (void) llvm::createDeadStoreEliminationPass();
420           /*
421       (void) llvm::createDeadTypeEliminationPass();
422       (void) llvm::createDomOnlyPrinterPass();
423       (void) llvm::createDomPrinterPass();
424       (void) llvm::createDomOnlyViewerPass();
425       (void) llvm::createDomViewerPass();
426       (void) llvm::createEdgeProfilerPass();
427       (void) llvm::createOptimalEdgeProfilerPass();
428       (void) llvm::createFunctionInliningPass();
429       (void) llvm::createAlwaysInlinerPass();
430       (void) llvm::createGlobalDCEPass();
431       (void) llvm::createGlobalOptimizerPass();
432       (void) llvm::createGlobalsModRefPass();
433       (void) llvm::createIPConstantPropagationPass();
434       (void) llvm::createIPSCCPPass();
435           */
436       (void) llvm::createIndVarSimplifyPass();
437       (void) llvm::createInstructionCombiningPass();
438           /*
439       (void) llvm::createInternalizePass(false);
440           */
441       (void) llvm::createLCSSAPass();
442       (void) llvm::createLICMPass();
443       (void) llvm::createLazyValueInfoPass();
444       (void) llvm::createLoopDependenceAnalysisPass();
445           /*
446       (void) llvm::createLoopExtractorPass();
447           */
448       (void) llvm::createLoopSimplifyPass();
449       (void) llvm::createLoopStrengthReducePass();
450       (void) llvm::createLoopUnrollPass();
451       (void) llvm::createLoopUnswitchPass();
452       (void) llvm::createLoopRotatePass();
453       (void) llvm::createLowerInvokePass();
454           /*
455       (void) llvm::createLowerSetJmpPass();
456           */
457       (void) llvm::createLowerSwitchPass();
458       (void) llvm::createNoAAPass();
459           /*
460       (void) llvm::createNoProfileInfoPass();
461       (void) llvm::createProfileEstimatorPass();
462       (void) llvm::createProfileVerifierPass();
463       (void) llvm::createProfileLoaderPass();
464           */
465       (void) llvm::createPromoteMemoryToRegisterPass();
466       (void) llvm::createDemoteRegisterToMemoryPass();
467           /*
468       (void) llvm::createPruneEHPass();
469       (void) llvm::createPostDomOnlyPrinterPass();
470       (void) llvm::createPostDomPrinterPass();
471       (void) llvm::createPostDomOnlyViewerPass();
472       (void) llvm::createPostDomViewerPass();
473           */
474       (void) llvm::createReassociatePass();
475       (void) llvm::createSCCPPass();
476       (void) llvm::createScalarReplAggregatesPass();
477       (void) llvm::createSimplifyLibCallsPass();
478           /*
479       (void) llvm::createSingleLoopExtractorPass();
480       (void) llvm::createStripSymbolsPass();
481       (void) llvm::createStripNonDebugSymbolsPass();
482       (void) llvm::createStripDeadDebugInfoPass();
483       (void) llvm::createStripDeadPrototypesPass();
484       (void) llvm::createTailCallEliminationPass();
485       (void) llvm::createTailDuplicationPass();
486       (void) llvm::createJumpThreadingPass();
487           */
488           /*
489       (void) llvm::createUnifyFunctionExitNodesPass();
490           */
491       (void) llvm::createInstCountPass();
492       (void) llvm::createCodeGenPreparePass();
493       (void) llvm::createGVNPass();
494       (void) llvm::createMemCpyOptPass();
495       (void) llvm::createLoopDeletionPass();
496           /*
497       (void) llvm::createPostDomTree();
498       (void) llvm::createPostDomFrontier();
499       (void) llvm::createInstructionNamerPass();
500       (void) llvm::createPartialSpecializationPass();
501       (void) llvm::createFunctionAttrsPass();
502       (void) llvm::createMergeFunctionsPass();
503       (void) llvm::createPrintModulePass(0);
504       (void) llvm::createPrintFunctionPass("", 0);
505       (void) llvm::createDbgInfoPrinterPass();
506       (void) llvm::createModuleDebugInfoPrinterPass();
507       (void) llvm::createPartialInliningPass();
508       (void) llvm::createGEPSplitterPass();
509       (void) llvm::createLintPass();
510           */
511       (void) llvm::createSinkingPass();
512 }
513
514 LLVMExecutionEngineRef
515 mono_llvm_create_ee (LLVMModuleProviderRef MP, AllocCodeMemoryCb *alloc_cb, FunctionEmittedCb *emitted_cb, ExceptionTableCb *exception_cb, DlSymCb *dlsym_cb)
516 {
517   std::string Error;
518
519   force_pass_linking ();
520
521 #ifdef TARGET_ARM
522   LLVMInitializeARMTarget ();
523   LLVMInitializeARMTargetInfo ();
524   LLVMInitializeARMTargetMC ();
525 #else
526   LLVMInitializeX86Target ();
527   LLVMInitializeX86TargetInfo ();
528   LLVMInitializeX86TargetMC ();
529 #endif
530
531   mono_mm = new MonoJITMemoryManager ();
532   mono_mm->alloc_cb = alloc_cb;
533   mono_mm->dlsym_cb = dlsym_cb;
534
535   //JITExceptionHandling = true;
536   // PrettyStackTrace installs signal handlers which trip up libgc
537   DisablePrettyStackTrace = true;
538
539   /*
540    * The Default code model doesn't seem to work on amd64,
541    * test_0_fields_with_big_offsets (among others) crashes, because LLVM tries to call
542    * memset using a normal pcrel code which is in 32bit memory, while memset isn't.
543    */
544
545   TargetOptions opts;
546   opts.JITExceptionHandling = 1;
547
548   EngineBuilder b (unwrap (MP));
549 #ifdef TARGET_AMD64
550   ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setCodeModel (CodeModel::Large).setAllocateGVsWithCode (true).create ();
551 #else
552   ExecutionEngine *EE = b.setJITMemoryManager (mono_mm).setTargetOptions (opts).setAllocateGVsWithCode (true).create ();
553 #endif
554   g_assert (EE);
555
556 #if 0
557   ExecutionEngine *EE = ExecutionEngine::createJIT (unwrap (MP), &Error, mono_mm, CodeGenOpt::Default, true, Reloc::Default, CodeModel::Large);
558   if (!EE) {
559           errs () << "Unable to create LLVM ExecutionEngine: " << Error << "\n";
560           g_assert_not_reached ();
561   }
562 #endif
563
564   EE->InstallExceptionTableRegister (exception_cb);
565   mono_event_listener = new MonoJITEventListener (emitted_cb);
566   EE->RegisterJITEventListener (mono_event_listener);
567
568   fpm = new FunctionPassManager (unwrap (MP));
569
570   fpm->add(new TargetData(*EE->getTargetData()));
571
572   PassRegistry &Registry = *PassRegistry::getPassRegistry();
573   initializeCore(Registry);
574   initializeScalarOpts(Registry);
575   //initializeIPO(Registry);
576   initializeAnalysis(Registry);
577   initializeIPA(Registry);
578   initializeTransformUtils(Registry);
579   initializeInstCombine(Registry);
580   //initializeInstrumentation(Registry);
581   initializeTarget(Registry);
582
583   llvm::cl::ParseEnvironmentOptions("mono", "MONO_LLVM", "", false);
584
585   if (PassList.size() > 0) {
586           /* Use the passes specified by the env variable */
587           /* Only the passes in force_pass_linking () can be used */
588           for (unsigned i = 0; i < PassList.size(); ++i) {
589                   const PassInfo *PassInf = PassList[i];
590                   Pass *P = 0;
591
592                   if (PassInf->getNormalCtor())
593                           P = PassInf->getNormalCtor()();
594                   fpm->add (P);
595           }
596   } else {
597           /* Use the same passes used by 'opt' by default, without the ipo passes */
598           const char *opts = "-simplifycfg -domtree -domfrontier -scalarrepl -instcombine -simplifycfg -basiccg -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";
599           char **args;
600           int i;
601
602           args = g_strsplit (opts, " ", 1000);
603           for (i = 0; args [i]; i++)
604                   ;
605           llvm::cl::ParseCommandLineOptions (i, args, "", false);
606           g_strfreev (args);
607
608           for (unsigned i = 0; i < PassList.size(); ++i) {
609                   const PassInfo *PassInf = PassList[i];
610                   Pass *P = 0;
611
612                   if (PassInf->getNormalCtor())
613                           P = PassInf->getNormalCtor()();
614                   fpm->add (P);
615           }
616
617           /*
618           fpm->add(createInstructionCombiningPass());
619           fpm->add(createReassociatePass());
620           fpm->add(createGVNPass());
621           fpm->add(createCFGSimplificationPass());
622           */
623   }
624
625   return wrap(EE);
626 }
627
628 void
629 mono_llvm_dispose_ee (LLVMExecutionEngineRef ee)
630 {
631         delete unwrap (ee);
632
633         delete fpm;
634 }