0414004938b87482c2dc2aa57b980c746069f4f2
[mono.git] / mono / mini / mini.h
1 #ifndef __MONO_MINI_H__
2 #define __MONO_MINI_H__
3
4 #include "config.h"
5 #include <glib.h>
6 #include <signal.h>
7 #include <mono/metadata/loader.h>
8 #include <mono/metadata/mempool.h>
9 #include <mono/utils/monobitset.h>
10 #include <mono/metadata/class.h>
11 #include <mono/metadata/object.h>
12 #include <mono/metadata/opcodes.h>
13 #include <mono/metadata/tabledefs.h>
14 #include <mono/metadata/domain-internals.h>
15 #include "mono/metadata/class-internals.h"
16 #include "mono/metadata/object-internals.h"
17 #include <mono/metadata/profiler-private.h>
18 #include <mono/utils/mono-compiler.h>
19
20 #include "mini-arch.h"
21 #include "regalloc.h"
22 #include "declsec.h"
23
24 #ifndef G_LIKELY
25 #define G_LIKELY(a) (a)
26 #define G_UNLIKELY(a) (a)
27 #endif
28
29 #if DISABLE_LOGGING
30 #define MINI_DEBUG(level,limit,code)
31 #else
32 #define MINI_DEBUG(level,limit,code) do {if (G_UNLIKELY ((level) >= (limit))) code} while (0)
33 #endif
34
35 #ifndef DISABLE_AOT
36 #define MONO_USE_AOT_COMPILER
37 #endif
38
39 /* for 32 bit systems */
40 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
41 #define MINI_LS_WORD_OFFSET 0
42 #define MINI_MS_WORD_OFFSET 4
43 #define inst_ls_word data.op[0].const_val
44 #define inst_ms_word data.op[1].const_val
45 #else
46 #define MINI_LS_WORD_OFFSET 4
47 #define MINI_MS_WORD_OFFSET 0
48 #define inst_ls_word data.op[1].const_val
49 #define inst_ms_word data.op[0].const_val
50 #endif
51
52 /* Version number of the AOT file format */
53 #define MONO_AOT_FILE_VERSION "25"
54
55 #if 0
56 #define mono_bitset_foreach_bit(set,b,n) \
57         for (b = 0; b < n; b++)\
58                 if (mono_bitset_test_fast(set,b))
59 #define mono_bitset_foreach_bit_rev(set,b,n) \
60         for (b = n - 1; b >= 0; b--)\
61                 if (mono_bitset_test_fast(set,b))
62 #else
63 #define mono_bitset_foreach_bit(set,b,n) \
64         for (b = mono_bitset_find_start (set); b < n && b >= 0; b = mono_bitset_find_first (set, b))
65 #define mono_bitset_foreach_bit_rev(set,b,n) \
66         for (b = mono_bitset_find_last (set, n - 1); b >= 0; b = b ? mono_bitset_find_last (set, b) : -1)
67  
68 #endif
69
70 /*
71  * Pull the list of opcodes
72  */
73 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
74         a = i,
75
76 enum {
77 #include "mono/cil/opcode.def"
78         CEE_LASTOP
79 };
80 #undef OPDEF
81
82 #define MONO_VARINFO(cfg,varnum) ((cfg)->vars [varnum])
83
84 #define MONO_INST_NEW(cfg,dest,op) do { \
85                 (dest) = mono_mempool_alloc0 ((cfg)->mempool, sizeof (MonoInst));       \
86                 (dest)->opcode = (op);  \
87         } while (0)
88
89 #define MONO_INST_NEW_CALL(cfg,dest,op) do {    \
90                 (dest) = mono_mempool_alloc0 ((cfg)->mempool, sizeof (MonoCallInst));   \
91                 (dest)->inst.opcode = (op);     \
92         } while (0)
93
94 #define MONO_INST_NEW_CALL_ARG(cfg,dest,op) do {        \
95                 (dest) = mono_mempool_alloc0 ((cfg)->mempool, sizeof (MonoCallArgParm));        \
96                 (dest)->ins.opcode = (op);      \
97         } while (0)
98
99 #define MONO_ADD_INS(b,inst) do {       \
100                 if ((b)->last_ins) {    \
101                         (b)->last_ins->next = (inst);   \
102                         (b)->last_ins = (inst); \
103                 } else {        \
104                         (b)->code = (b)->last_ins = (inst);     \
105                 }       \
106         } while (0)
107
108 typedef struct MonoInst MonoInst;
109 typedef struct MonoCallInst MonoCallInst;
110 typedef struct MonoCallArgParm MonoCallArgParm;
111 typedef struct MonoEdge MonoEdge;
112 typedef struct MonoMethodVar MonoMethodVar;
113 typedef struct MonoBasicBlock MonoBasicBlock;
114 typedef struct MonoLMF MonoLMF;
115 typedef struct MonoSpillInfo MonoSpillInfo;
116 typedef struct MonoTraceSpec MonoTraceSpec;
117
118 extern guint32 mono_jit_tls_id;
119 extern MonoTraceSpec *mono_jit_trace_calls;
120 extern gboolean mono_break_on_exc;
121 extern int mono_exc_esp_offset;
122 #ifdef DISABLE_AOT
123 #define mono_compile_aot 0
124 #else
125 extern gboolean mono_compile_aot;
126 #endif
127 extern gboolean mono_use_security_manager;
128
129 struct MonoEdge {
130         MonoEdge *next;
131         MonoBasicBlock *bb;
132         /* add edge type? */
133 };
134
135 struct MonoSpillInfo {
136         MonoSpillInfo *next;
137         int offset;
138 };
139
140 /*
141  * The IR-level basic block.  
142  *
143  * A basic block can have multiple exits just fine, as long as the point of
144  * 'departure' is the last instruction in the basic block. Extended basic
145  * blocks, on the other hand, may have instructions that leave the block
146  * midstream. The important thing is that they cannot be _entered_
147  * midstream, ie, execution of a basic block (or extened bb) always start
148  * at the beginning of the block, never in the middle.
149  */
150 struct MonoBasicBlock {
151         MonoInst *last_ins;
152
153         /* the next basic block in the order it appears in IL */
154         MonoBasicBlock *next_bb;
155
156         /*
157          * Before instruction selection it is the first tree in the
158          * forest and the first item in the list of trees. After
159          * instruction selection it is the first instruction and the
160          * first item in the list of instructions.
161          */
162         MonoInst *code;
163
164         /* unique block number identification */
165         gint32 block_num;
166         
167         gint32 dfn;
168
169         /* Basic blocks: incoming and outgoing counts and pointers */
170         gint16 out_count, in_count;
171         MonoBasicBlock **in_bb;
172         MonoBasicBlock **out_bb;
173
174         /* Points to the start of the CIL code that initiated this BB */
175         unsigned char* cil_code;
176
177         /* Length of the CIL block */
178         gint32 cil_length;
179
180         /* The address of the generated code, used for fixups */
181         int native_offset;
182         int max_offset;
183
184         /* Visited and reachable flags */
185         guint32 flags;
186
187         /*
188          * SSA and loop based flags
189          */
190         MonoBitSet *dominators;
191         MonoBitSet *dfrontier;
192         MonoBasicBlock *idom;
193         GList *dominated;
194         /* fast dominator algorithm */
195         MonoBasicBlock *df_parent, *ancestor, *child, *label;
196         MonoEdge *bucket;
197         int size, sdom, idomn;
198         
199         /* loop nesting and recognition */
200         GList *loop_blocks;
201         gint8  nesting;
202         gint8  loop_body_start;
203
204         /* 
205          * Whenever the bblock is rarely executed so it should be emitted after
206          * the function epilog.
207          */
208         gboolean out_of_line : 1;
209         /* Caches the result of uselessness calculation during optimize_branches */
210         gboolean not_useless : 1;
211
212         /* use for liveness analysis */
213         MonoBitSet *gen_set;
214         MonoBitSet *kill_set;
215         MonoBitSet *live_in_set;
216         MonoBitSet *live_out_set;
217
218         /* fields to deal with non-empty stack slots at bb boundary */
219         guint16 out_scount, in_scount;
220         MonoInst **out_stack;
221         MonoInst **in_stack;
222
223         /* we use that to prevent merging of bblock covered by different clauses*/
224         guint real_offset;
225
226         /*
227          * The region encodes whether the basic block is inside
228          * a finally, catch, filter or none of thoese.
229          *
230          * If the value is -1, then it is neither finally, catch nor filter
231          *
232          * Otherwise the format is:
233          *
234          *  Bits: |     0-3      |       4-7      |     8-31
235          *        |              |                |
236          *        | clause-flags |   MONO_REGION  | clause-index 
237          *
238          */
239         guint region;
240
241         /* The current symbolic register number, used in local register allocation. */
242         guint32 max_ireg, max_freg;
243 };
244
245 /* BBlock flags */
246 enum {
247         BB_VISITED            = 1 << 0,
248         BB_REACHABLE          = 1 << 1,
249         BB_EXCEPTION_DEAD_OBJ = 1 << 2,
250         BB_EXCEPTION_UNSAFE   = 1 << 3,
251         BB_EXCEPTION_HANDLER  = 1 << 4
252 };
253
254 struct MonoInst {
255         union {
256                 union {
257                         MonoInst *src;
258                         MonoMethodVar *var;
259                         gssize const_val;
260                         gpointer p;
261                         MonoMethod *method;
262                         MonoMethodSignature *signature;
263                         MonoBasicBlock **many_blocks;
264                         MonoBasicBlock *target_block;
265                         MonoInst **args;
266                         MonoType *vtype;
267                         MonoClass *klass;
268                         int *phi_args;
269                 } op [2];
270                 gint64 i8const;
271                 double r8const;
272         } data;
273         guint16 opcode;
274         guint8  type; /* stack type */
275         guint   ssa_op : 3;
276         guint8  flags  : 5;
277         
278         /* used by the register allocator */
279         gint32 dreg, sreg1, sreg2, unused;
280         
281         MonoInst *next;
282         MonoClass *klass;
283         const unsigned char* cil_code; /* for debugging and bblock splitting */
284 };
285         
286 struct MonoCallInst {
287         MonoInst inst;
288         MonoMethodSignature *signature;
289         MonoMethod *method;
290         MonoInst **args;
291         MonoInst *out_args;
292         gconstpointer fptr;
293         guint stack_usage;
294         gboolean virtual;
295         regmask_t used_iregs;
296         regmask_t used_fregs;
297 #if defined(MONO_ARCH_HAS_XP_LOCAL_REGALLOC) || defined(__x86_64__)
298         GSList *out_ireg_args;
299         GSList *out_freg_args;
300 #endif
301 };
302
303 struct MonoCallArgParm {
304         MonoInst ins;
305         gint32 size;
306         gint32 offset;
307         gint32 offPrm;
308 };
309
310 /* 
311  * flags for MonoInst
312  * Note: some of the values overlap, because they can't appear
313  * in the same MonoInst.
314  */
315 enum {
316         MONO_INST_HAS_METHOD = 1,
317         /* temp local created by a DUP: used only within a BB */
318         MONO_INST_IS_TEMP    = 1,
319         MONO_INST_INIT       = 1, /* in localloc */
320         MONO_INST_IS_DEAD    = 2,
321         MONO_INST_TAILCALL   = 4,
322         MONO_INST_VOLATILE   = 4,
323         MONO_INST_BRLABEL    = 4,
324         MONO_INST_NOTYPECHECK    = 4,
325         MONO_INST_UNALIGNED  = 8,
326         /* the address of the variable has been taken */
327         MONO_INST_INDIRECT   = 16,
328         MONO_INST_NORANGECHECK   = 16
329 };
330
331 #define inst_c0 data.op[0].const_val
332 #define inst_c1 data.op[1].const_val
333 #define inst_i0 data.op[0].src
334 #define inst_i1 data.op[1].src
335 #define inst_p0 data.op[0].p
336 #define inst_p1 data.op[1].p
337 #define inst_l  data.i8const
338 #define inst_r  data.r8const
339 #define inst_left  data.op[0].src
340 #define inst_right data.op[1].src
341
342 #define inst_newa_len   data.op[0].src
343 #define inst_newa_class data.op[1].klass
344
345 #define inst_var    data.op[0].var
346 #define inst_vtype  data.op[1].vtype
347 /* in branch instructions */
348 #define inst_many_bb   data.op[1].many_blocks
349 #define inst_target_bb data.op[0].target_block
350 #define inst_true_bb   data.op[1].many_blocks[0]
351 #define inst_false_bb  data.op[1].many_blocks[1]
352
353 #define inst_basereg sreg1
354 #define inst_indexreg sreg2
355 #define inst_destbasereg dreg
356 #define inst_offset data.op[0].const_val
357 #define inst_imm    data.op[1].const_val
358
359 #define inst_phi_args   data.op[1].phi_args
360
361 /* instruction description for use in regalloc/scheduling */
362 enum {
363         MONO_INST_DEST,
364         MONO_INST_SRC1,
365         MONO_INST_SRC2,
366         MONO_INST_FLAGS,
367         MONO_INST_CLOB,
368         MONO_INST_COST,
369         MONO_INST_DELAY,
370         MONO_INST_RES,
371         MONO_INST_LEN,
372         MONO_INST_MAX
373 };
374
375 typedef union {
376         struct {
377                 guint16 tid; /* tree number */
378                 guint16 bid; /* block number */
379         } pos ;
380         guint32 abs_pos; 
381 } MonoPosition;
382
383 typedef struct {
384         MonoPosition first_use, last_use;
385 } MonoLiveRange;
386
387 /*
388  * Additional information about a variable
389  */
390 struct MonoMethodVar {
391         guint           idx; /* inside cfg->varinfo, cfg->vars */
392         guint           last_name;
393         MonoBitSet     *dfrontier;
394         MonoLiveRange   range; /* generated by liveness analysis */
395         int             reg; /* != -1 if allocated into a register */
396         int             spill_costs;
397         MonoBitSet     *def_in; /* used by SSA */
398         MonoInst       *def;    /* used by SSA */
399         MonoBasicBlock *def_bb; /* used by SSA */
400         GList          *uses;   /* used by SSA */
401         char            cpstate;  /* used by SSA conditional  constant propagation */
402 };
403
404 typedef struct {
405         gpointer          end_of_stack;
406         guint32           stack_size;
407         MonoLMF          *lmf;
408         MonoLMF          *first_lmf;
409         gpointer         signal_stack;
410         guint32          signal_stack_size;
411         void            (*abort_func) (MonoObject *object);
412 } MonoJitTlsData;
413
414 typedef enum {
415         MONO_PATCH_INFO_BB,
416         MONO_PATCH_INFO_ABS,
417         MONO_PATCH_INFO_LABEL,
418         MONO_PATCH_INFO_METHOD,
419         MONO_PATCH_INFO_METHOD_JUMP,
420         MONO_PATCH_INFO_METHOD_REL,
421         MONO_PATCH_INFO_METHODCONST,
422         MONO_PATCH_INFO_INTERNAL_METHOD,
423         MONO_PATCH_INFO_SWITCH,
424         MONO_PATCH_INFO_EXC,
425         MONO_PATCH_INFO_EXC_NAME,
426         MONO_PATCH_INFO_CLASS,
427         MONO_PATCH_INFO_IMAGE,
428         MONO_PATCH_INFO_FIELD,
429         MONO_PATCH_INFO_VTABLE,
430         MONO_PATCH_INFO_CLASS_INIT,
431         MONO_PATCH_INFO_SFLDA,
432         MONO_PATCH_INFO_LDSTR,
433         MONO_PATCH_INFO_LDTOKEN,
434         MONO_PATCH_INFO_TYPE_FROM_HANDLE,
435         MONO_PATCH_INFO_R4,
436         MONO_PATCH_INFO_R8,
437         MONO_PATCH_INFO_IP,
438         MONO_PATCH_INFO_IID,
439         MONO_PATCH_INFO_BB_OVF,
440         MONO_PATCH_INFO_EXC_OVF,
441         MONO_PATCH_INFO_WRAPPER,
442         MONO_PATCH_INFO_GOT_OFFSET,
443         MONO_PATCH_INFO_DECLSEC,
444         MONO_PATCH_INFO_NONE
445 } MonoJumpInfoType;
446
447 /*
448  * We need to store the image which the token refers to along with the token,
449  * since the image might not be the same as the image of the method which
450  * contains the relocation, because of inlining.
451  */
452 typedef struct MonoJumpInfoToken {
453         MonoImage *image;
454         guint32 token;
455 } MonoJumpInfoToken;
456
457 typedef struct MonoJumpInfoBBTable {
458         MonoBasicBlock **table;
459         int table_size;
460 } MonoJumpInfoBBTable;
461
462 typedef struct MonoJumpInfo MonoJumpInfo;
463 struct MonoJumpInfo {
464         MonoJumpInfo *next;
465         union {
466                 int i;
467                 guint8 *p;
468                 MonoInst *label;
469         } ip;
470
471         MonoJumpInfoType type;
472         union {
473                 gconstpointer   target;
474 #if SIZEOF_VOID_P == 8
475                 gint64          offset;
476 #else
477                 int             offset;
478 #endif
479                 MonoBasicBlock *bb;
480                 MonoInst       *inst;
481                 MonoMethod     *method;
482                 MonoClass      *klass;
483                 MonoClassField *field;
484                 MonoImage      *image;
485                 MonoVTable     *vtable;
486                 const char     *name;
487                 MonoJumpInfoToken  *token;
488                 MonoJumpInfoBBTable *table;
489         } data;
490 };
491
492 typedef enum {
493         MONO_TRAMPOLINE_GENERIC,
494         MONO_TRAMPOLINE_JUMP,
495         MONO_TRAMPOLINE_CLASS_INIT,
496         MONO_TRAMPOLINE_AOT,
497         MONO_TRAMPOLINE_DELEGATE,
498         MONO_TRAMPOLINE_NUM
499 } MonoTrampolineType;
500
501 /* optimization flags: keep up to date with the name array in driver.c */
502 enum {
503         MONO_OPT_PEEPHOLE = 1 << 0,
504         MONO_OPT_BRANCH   = 1 << 1,
505         MONO_OPT_INLINE   = 1 << 2,
506         MONO_OPT_CFOLD    = 1 << 3,
507         MONO_OPT_CONSPROP = 1 << 4,
508         MONO_OPT_COPYPROP = 1 << 5,
509         MONO_OPT_DEADCE   = 1 << 6,
510         MONO_OPT_LINEARS  = 1 << 7,
511         MONO_OPT_CMOV     = 1 << 8,
512         MONO_OPT_SHARED   = 1 << 9,
513         MONO_OPT_SCHED    = 1 << 10,
514         MONO_OPT_INTRINS  = 1 << 11,
515         MONO_OPT_TAILC    = 1 << 12,
516         MONO_OPT_LOOP     = 1 << 13,
517         MONO_OPT_FCMOV    = 1 << 14,
518         MONO_OPT_LEAF     = 1 << 15,
519         MONO_OPT_AOT      = 1 << 16,
520         MONO_OPT_PRECOMP  = 1 << 17,
521         MONO_OPT_ABCREM   = 1 << 18,
522         MONO_OPT_SSAPRE   = 1 << 19,
523         MONO_OPT_EXCEPTION= 1 << 20,
524         MONO_OPT_SSA      = 1 << 21
525 };
526
527 /* Bit-fields in the MonoBasicBlock.region */
528 #define MONO_REGION_TRY       0
529 #define MONO_REGION_FINALLY  16
530 #define MONO_REGION_CATCH    32
531 #define MONO_REGION_FAULT    64         /* Currently unused */
532 #define MONO_REGION_FILTER  128
533
534 #define MONO_BBLOCK_IS_IN_REGION(bblock, regtype) (((bblock)->region & (0xf << 4)) == (regtype))
535
536 /*
537  * Control Flow Graph and compilation unit information
538  */
539 typedef struct {
540         MonoMethod      *method;
541         MonoMemPool     *mempool;
542         MonoInst       **varinfo;
543         MonoMethodVar  **vars;
544         MonoInst        *ret;
545         MonoBasicBlock  *bb_entry;
546         MonoBasicBlock  *bb_exit;
547         MonoBasicBlock  *bb_init;
548         MonoBasicBlock **bblocks;
549         GHashTable      *bb_hash;
550         MonoMemPool     *state_pool; /* used by instruction selection */
551         MonoBasicBlock  *cbb;        /* used by instruction selection */
552         MonoInst        *prev_ins;   /* in decompose */
553         MonoJumpInfo    *patch_info;
554         MonoJitInfo     *jit_info;
555         MonoJitDynamicMethodInfo *dynamic_info;
556         guint            num_bblocks;
557         guint            locals_start;
558         guint            num_varinfo; /* used items in varinfo */
559         guint            varinfo_count; /* total storage in varinfo */
560         gint             stack_offset;
561         gint             max_ireg;
562         MonoRegState    *rs;
563         MonoSpillInfo   *spill_info; /* machine register spills */
564         MonoSpillInfo   *spill_info_float; /* fp register spills */
565         gint             spill_count;
566         /* unsigned char   *cil_code; */
567         MonoMethod      *inlined_method; /* the method which is currently inlined */
568         MonoInst        *domainvar; /* a cache for the current domain */
569         MonoInst        *got_var; /* Global Offset Table variable */
570         
571         struct MonoAliasingInformation *aliasing_info;
572
573         /* A hashtable of region ID-> SP var mappings */
574         /* An SP var is a place to store the stack pointer (used by handlers)*/
575         GHashTable      *spvars;
576
577         /* A hashtable of region ID -> EX var mappings */
578         /* An EX var stores the exception object passed to catch/filter blocks */
579         GHashTable      *exvars;
580
581         GList           *ldstr_list; /* used by AOT */
582         
583         MonoDomain      *domain;
584
585         unsigned char   *native_code;
586         guint            code_size;
587         guint            code_len;
588         guint            prolog_end;
589         guint            epilog_begin;
590         regmask_t        used_int_regs;
591         guint32          opt;
592         guint32          prof_options;
593         guint32          flags;
594         guint32          comp_done;
595         guint32          verbose_level;
596         guint32          stack_usage;
597         guint32          param_area;
598         guint32          frame_reg;
599         gint32           sig_cookie;
600         gboolean         disable_aot;
601         gboolean         disable_ssa;
602         gboolean         run_cctors;
603         gboolean         need_lmf_area;
604         gboolean         compile_aot;
605         gboolean         got_var_allocated;
606         gboolean         ret_var_is_local;
607         gpointer         debug_info;
608         guint32          lmf_offset;
609         guint16          *intvars;
610         MonoProfileCoverageInfo *coverage_info;
611         MonoCompileArch  arch;
612         guint32          exception_type;        /* MONO_EXCEPTION_* */
613         guint32          exception_data;
614         char*            exception_message;
615 #ifdef __ia64
616         guint8           ins, locals, outs; /* reg stack region sizes */
617 #endif /* __ia64 */
618 } MonoCompile;
619
620 typedef enum {
621         MONO_CFG_HAS_ALLOCA = 1 << 0,
622         MONO_CFG_HAS_CALLS  = 1 << 1,
623         MONO_CFG_HAS_LDELEMA  = 1 << 2,
624         MONO_CFG_HAS_VARARGS  = 1 << 3,
625         MONO_CFG_HAS_TAIL     = 1 << 4,
626         MONO_CFG_HAS_FPOUT    = 1 << 5, /* there are fp values passed in int registers */
627         MONO_CFG_HAS_SPILLUP  = 1 << 6  /* spill var slots are allocated from bottom to top */
628 } MonoCompileFlags;
629
630 typedef struct {
631         gulong methods_compiled;
632         gulong methods_aot;
633         gulong methods_lookups;
634         gulong method_trampolines;
635         gulong allocate_var;
636         gulong analyze_stack_repeat;
637         gulong cil_code_size;
638         gulong native_code_size;
639         gulong code_reallocs;
640         gulong max_code_size_ratio;
641         gulong biggest_method_size;
642         gulong allocated_code_size;
643         gulong inlineable_methods;
644         gulong inlined_methods;
645         gulong basic_blocks;
646         gulong max_basic_blocks;
647         gulong cas_declsec_check;
648         gulong cas_linkdemand_icall;
649         gulong cas_linkdemand_pinvoke;
650         gulong cas_linkdemand_aptc;
651         gulong cas_linkdemand;
652         gulong cas_demand_generation;
653         MonoMethod *max_ratio_method;
654         MonoMethod *biggest_method;
655         gboolean enabled;
656 } MonoJitStats;
657
658 extern MonoJitStats mono_jit_stats;
659
660 /* values for MonoInst.ssa_op */
661 enum {
662         MONO_SSA_NOP = 0,
663         MONO_SSA_ADDRESS_TAKEN = 1,
664         MONO_SSA_LOAD = 2,
665         MONO_SSA_STORE = 4,
666         MONO_SSA_LOAD_STORE = MONO_SSA_LOAD|MONO_SSA_STORE,
667         MONO_SSA_INDIRECT_LOAD = MONO_SSA_LOAD|MONO_SSA_ADDRESS_TAKEN,
668         MONO_SSA_INDIRECT_STORE = MONO_SSA_STORE|MONO_SSA_ADDRESS_TAKEN,
669         MONO_SSA_INDIRECT_LOAD_STORE =
670         MONO_SSA_LOAD|MONO_SSA_STORE|MONO_SSA_ADDRESS_TAKEN
671 };
672
673 #define OP_CEQ    (256+CEE_CEQ)
674 #define OP_CLT    (256+CEE_CLT)
675 #define OP_CLT_UN (256+CEE_CLT_UN)
676 #define OP_CGT    (256+CEE_CGT)
677 #define OP_CGT_UN (256+CEE_CGT_UN)
678 #define OP_LOCALLOC (256+CEE_LOCALLOC)
679
680 /* opcodes: value assigned after all the CIL opcodes */
681 #ifdef MINI_OP
682 #undef MINI_OP
683 #endif
684 #define MINI_OP(a,b) a,
685 enum {
686         OP_START = MONO_CEE_LAST,
687 #include "mini-ops.h"
688         OP_LAST
689 };
690 #undef MINI_OP
691
692 #if SIZEOF_VOID_P == 8
693 #define OP_PCONST OP_I8CONST
694 #define OP_PADD OP_LADD
695 #define OP_PNEG OP_LNEG
696 #define OP_PCONV_TO_U2 OP_LCONV_TO_U2
697 #define OP_PCONV_TO_OVF_I1_UN OP_LCONV_TO_OVF_I1_UN
698 #define OP_PCONV_TO_OVF_I1 OP_LCONV_TO_OVF_I1
699 #define OP_PCEQ CEE_CEQ
700 #define OP_STOREP_MEMBASE_REG OP_STOREI8_MEMBASE_REG
701 #define OP_STOREP_MEMBASE_IMM OP_STOREI8_MEMBASE_IMM
702 #else
703 #define OP_PCONST OP_ICONST
704 #define OP_PADD CEE_ADD
705 #define OP_PNEG CEE_NEG
706 #define OP_PCONV_TO_U2 CEE_CONV_U2
707 #define OP_PCONV_TO_OVF_I1_UN CEE_CONV_OVF_I1_UN
708 #define OP_PCONV_TO_OVF_I1 CEE_CONV_OVF_I1
709 #define OP_PCEQ CEE_CEQ
710 #define OP_STOREP_MEMBASE_REG OP_STOREI4_MEMBASE_REG
711 #define OP_STOREP_MEMBASE_IMM OP_STOREI4_MEMBASE_IMM
712 #endif
713
714 typedef enum {
715         STACK_INV,
716         STACK_I4,
717         STACK_I8,
718         STACK_PTR,
719         STACK_R8,
720         STACK_MP,
721         STACK_OBJ,
722         STACK_VTYPE,
723         STACK_MAX
724 } MonoStackType;
725
726 typedef struct {
727         union {
728                 double   r8;
729                 gint32   i4;
730                 gint64   i8;
731                 gpointer p;
732                 MonoClass *klass;
733         } data;
734         int type;
735 } StackSlot;
736
737 #if HAVE_ARRAY_ELEM_INIT
738 extern const guint8 mono_burg_arity [];
739 #else
740 extern guint8 mono_burg_arity [];
741 #endif
742
743 enum {
744         MONO_COMP_DOM = 1,
745         MONO_COMP_IDOM = 2,
746         MONO_COMP_DFRONTIER = 4,
747         MONO_COMP_DOM_REV = 8,
748         MONO_COMP_LIVENESS = 16,
749         MONO_COMP_SSA = 32,
750         MONO_COMP_SSA_DEF_USE = 64,
751         MONO_COMP_REACHABILITY = 128,
752         MONO_COMP_LOOPS = 256
753 };
754
755 typedef enum {
756         MONO_GRAPH_CFG = 1,
757         MONO_GRAPH_DTREE = 2,
758         MONO_GRAPH_CFG_CODE = 4,
759         MONO_GRAPH_CFG_SSA = 8,
760         MONO_GRAPH_CFG_OPTCODE = 16
761 } MonoGraphOptions;
762
763 typedef struct {
764         guint16 size;
765         guint16 offset;
766         guint8  pad;
767 } MonoJitArgumentInfo;
768
769 typedef struct {
770         gboolean handle_sigint;
771         gboolean keep_delegates;
772         gboolean collect_pagefault_stats;
773 } MonoDebugOptions;
774
775 enum {
776         BRANCH_NOT_TAKEN,
777         BRANCH_TAKEN,
778         BRANCH_UNDEF
779 };
780
781 /* Implicit exceptions */
782 enum {
783         MONO_EXC_INDEX_OUT_OF_RANGE,
784         MONO_EXC_OVERFLOW,
785         MONO_EXC_ARITHMETIC,
786         MONO_EXC_DIVIDE_BY_ZERO,
787         MONO_EXC_INVALID_CAST,
788         MONO_EXC_NULL_REF,
789         MONO_EXC_ARRAY_TYPE_MISMATCH,
790         MONO_EXC_INTRINS_NUM
791 };
792
793 typedef void (*MonoInstFunc) (MonoInst *tree, gpointer data);
794
795 /* main function */
796 int         mono_main                      (int argc, char* argv[]);
797 void        mono_set_defaults              (int verbose_level, guint32 opts);
798 MonoDomain* mini_init                      (const char *filename);
799 void        mini_cleanup                   (MonoDomain *domain);
800
801 /* helper methods */
802 MonoJumpInfoToken * mono_jump_info_token_new (MonoMemPool *mp, MonoImage *image, guint32 token);
803 MonoInst* mono_find_spvar_for_region        (MonoCompile *cfg, int region);
804 void      mono_precompile_assemblies        (void);
805 int       mono_parse_default_optimizations  (const char* p);
806 void      mono_bblock_add_inst              (MonoBasicBlock *bb, MonoInst *inst);
807 void      mono_constant_fold                (MonoCompile *cfg);
808 void      mono_constant_fold_inst           (MonoInst *inst, gpointer data);
809 int       mono_eval_cond_branch             (MonoInst *branch);
810 int       mono_is_power_of_two              (guint32 val);
811 void      mono_cprop_local                  (MonoCompile *cfg, MonoBasicBlock *bb, MonoInst **acp, int acp_size);
812 MonoInst* mono_compile_create_var           (MonoCompile *cfg, MonoType *type, int opcode);
813 void      mono_compile_make_var_load        (MonoCompile *cfg, MonoInst *dest, gssize var_index);
814 MonoInst* mono_compile_create_var_load      (MonoCompile *cfg, gssize var_index);
815 MonoInst* mono_compile_create_var_store     (MonoCompile *cfg, gssize var_index, MonoInst *value);
816 MonoType* mono_type_from_stack_type         (MonoInst *ins);
817 void      mono_unlink_bblock                (MonoCompile *cfg, MonoBasicBlock *from, MonoBasicBlock* to);
818 void      mono_blockset_print               (MonoCompile *cfg, MonoBitSet *set, const char *name, guint idom);
819 void      mono_print_tree                   (MonoInst *tree);
820 void      mono_print_tree_nl                (MonoInst *tree);
821 void      mono_print_code                   (MonoCompile *cfg);
822 void      mono_print_method_from_ip         (void *ip);
823 char     *mono_pmip                         (void *ip);
824 void      mono_select_instructions          (MonoCompile *cfg);
825 const char* mono_inst_name                  (int op);
826 void      mono_inst_foreach                 (MonoInst *tree, MonoInstFunc func, gpointer data);
827 void      mono_disassemble_code             (MonoCompile *cfg, guint8 *code, int size, char *id);
828 guint     mono_type_to_ldind                (MonoType *t);
829 guint     mono_type_to_stind                (MonoType *t);
830 void      mono_add_patch_info               (MonoCompile *cfg, int ip, MonoJumpInfoType type, gconstpointer target);
831 void      mono_remove_patch_info            (MonoCompile *cfg, int ip);
832 gpointer  mono_resolve_patch_target         (MonoMethod *method, MonoDomain *domain, guint8 *code, MonoJumpInfo *patch_info, gboolean run_cctors);
833 MonoLMF** mono_get_lmf_addr                 (void);
834 void      mono_jit_thread_attach            (MonoDomain *domain);
835 guint32   mono_get_jit_tls_key              (void);
836 gint32    mono_get_lmf_tls_offset           (void);
837 GList    *mono_varlist_insert_sorted        (MonoCompile *cfg, GList *list, MonoMethodVar *mv, gboolean sort_end);
838 GList    *mono_varlist_sort                 (MonoCompile *cfg, GList *list, int sort_type);
839 void      mono_analyze_liveness             (MonoCompile *cfg);
840 void      mono_linear_scan                  (MonoCompile *cfg, GList *vars, GList *regs, regmask_t *used_mask);
841 void      mono_create_jump_table            (MonoCompile *cfg, MonoInst *label, MonoBasicBlock **bbs, int num_blocks);
842 int       mono_compile_assembly             (MonoAssembly *ass, guint32 opts, const char *aot_options);
843 MonoCompile *mini_method_compile            (MonoMethod *method, guint32 opts, MonoDomain *domain, gboolean run_cctors, gboolean compile_aot, int parts);
844 void      mono_destroy_compile              (MonoCompile *cfg);
845
846 void      mono_aot_init                     (void);
847 MonoJitInfo*  mono_aot_get_method           (MonoDomain *domain,
848                                                                                          MonoMethod *method);
849 gpointer  mono_aot_get_method_from_token    (MonoDomain *domain, MonoImage *image, guint32 token);
850 gboolean  mono_aot_is_got_entry             (guint8 *code, guint8 *addr);
851 gboolean  mono_aot_init_vtable              (MonoVTable *vtable);
852 gboolean  mono_aot_get_cached_class_info    (MonoClass *klass, MonoCachedClassInfo *res);
853 MonoJitInfo* mono_aot_find_jit_info         (MonoDomain *domain, MonoImage *image, gpointer addr);
854 void mono_aot_set_make_unreadable           (gboolean unreadable);
855 gboolean mono_aot_is_pagefault              (void *ptr);
856 void mono_aot_handle_pagefault              (void *ptr);
857 guint32 mono_aot_get_n_pagefaults           (void);
858
859 gboolean  mono_method_blittable             (MonoMethod *method);
860 gboolean  mono_method_same_domain           (MonoJitInfo *caller, MonoJitInfo *callee);
861
862 void      mono_register_opcode_emulation    (int opcode, const char* name, const char *sigstr, gpointer func, gboolean no_throw);
863 void      mono_draw_graph                   (MonoCompile *cfg, MonoGraphOptions draw_options);
864 void      mono_add_varcopy_to_end           (MonoCompile *cfg, MonoBasicBlock *bb, int src, int dest);
865 void      mono_add_ins_to_end               (MonoBasicBlock *bb, MonoInst *inst);
866 gpointer  mono_create_ftnptr                (MonoDomain *domain, gpointer addr);
867
868 int               mono_find_method_opcode      (MonoMethod *method);
869 MonoJitICallInfo *mono_find_jit_icall_by_name  (const char *name);
870 MonoJitICallInfo *mono_find_jit_icall_by_addr  (gconstpointer addr);
871 MonoJitICallInfo *mono_register_jit_icall      (gconstpointer func, const char *name, MonoMethodSignature *sig, gboolean is_save);
872 gconstpointer     mono_icall_get_wrapper       (MonoJitICallInfo* callinfo);
873
874 guint8 *          mono_get_trampoline_code (MonoTrampolineType tramp_type);
875 gpointer          mono_create_jump_trampoline (MonoDomain *domain, 
876                                                                                            MonoMethod *method, 
877                                                                                            gboolean add_sync_wrapper);
878 gpointer          mono_create_class_init_trampoline (MonoVTable *vtable);
879 gpointer          mono_create_jit_trampoline (MonoMethod *method);
880 gpointer          mono_create_jit_trampoline_from_token (MonoImage *image, guint32 token);
881 MonoVTable*       mono_find_class_init_trampoline_by_addr (gconstpointer addr);
882 gpointer          mono_magic_trampoline (gssize *regs, guint8 *code, MonoMethod *m, guint8* tramp);
883 gpointer          mono_delegate_trampoline (gssize *regs, guint8 *code, MonoMethod *m, guint8* tramp);
884 gpointer          mono_aot_trampoline (gssize *regs, guint8 *code, guint8 *token_info, 
885                                                                            guint8* tramp);
886 void              mono_class_init_trampoline (gssize *regs, guint8 *code, MonoVTable *vtable, guint8 *tramp);
887
888 gboolean          mono_running_on_valgrind (void);
889 void*             mono_global_codeman_reserve (int size);
890 const char       *mono_regname_full (int reg, gboolean fp);
891 gint32*           mono_allocate_stack_slots_full (MonoCompile *cfg, gboolean backward, guint32 *stack_size, guint32 *stack_align);
892 gint32*           mono_allocate_stack_slots (MonoCompile *cfg, guint32 *stack_size, guint32 *stack_align);
893 void              mono_local_regalloc (MonoCompile *cfg, MonoBasicBlock *bb);
894 MonoInst         *mono_branch_optimize_exception_target (MonoCompile *cfg, MonoBasicBlock *bb, const char * exname);              
895
896 /* methods that must be provided by the arch-specific port */
897 void      mono_arch_cpu_init                    (void);
898 guint32   mono_arch_cpu_optimizazions           (guint32 *exclude_mask);
899 void      mono_arch_instrument_mem_needs        (MonoMethod *method, int *stack, int *code);
900 void     *mono_arch_instrument_prolog           (MonoCompile *cfg, void *func, void *p, gboolean enable_arguments);
901 void     *mono_arch_instrument_epilog           (MonoCompile *cfg, void *func, void *p, gboolean enable_arguments);
902 MonoCallInst *mono_arch_call_opcode             (MonoCompile *cfg, MonoBasicBlock* bb, MonoCallInst *call, int is_virtual);
903 MonoInst *mono_arch_get_inst_for_method       (MonoCompile *cfg, MonoMethod *cmethod, MonoMethodSignature *fsig, MonoInst **args);
904 void      mono_codegen                          (MonoCompile *cfg);
905 void      mono_call_inst_add_outarg_reg         (MonoCallInst *call, int vreg, int hreg, gboolean fp);
906 const char *mono_arch_regname                   (int reg);
907 const char *mono_arch_fregname                  (int reg);
908 gpointer  mono_arch_get_throw_exception         (void);
909 gpointer  mono_arch_get_rethrow_exception       (void);
910 gpointer  mono_arch_get_throw_exception_by_name (void);
911 gpointer  mono_arch_get_throw_corlib_exception  (void);
912 guchar*   mono_arch_create_trampoline_code      (MonoTrampolineType tramp_type);
913 gpointer  mono_arch_create_jit_trampoline       (MonoMethod *method);
914 MonoJitInfo *mono_arch_create_jump_trampoline      (MonoMethod *method);
915 gpointer  mono_arch_create_class_init_trampoline(MonoVTable *vtable);
916 gpointer  mono_create_delegate_trampoline       (MonoMethod *method, gpointer addr);
917 GList    *mono_arch_get_allocatable_int_vars    (MonoCompile *cfg);
918 GList    *mono_arch_get_global_int_regs         (MonoCompile *cfg);
919 guint32   mono_arch_regalloc_cost               (MonoCompile *cfg, MonoMethodVar *vmv);
920 void      mono_arch_patch_code                  (MonoMethod *method, MonoDomain *domain, guint8 *code, MonoJumpInfo *ji, gboolean run_cctors);
921 void      mono_arch_flush_icache                (guint8 *code, gint size);
922 int       mono_arch_max_epilog_size             (MonoCompile *cfg);
923 guint8   *mono_arch_emit_prolog                 (MonoCompile *cfg);
924 void      mono_arch_emit_epilog                 (MonoCompile *cfg);
925 void      mono_arch_emit_exceptions             (MonoCompile *cfg);
926 void      mono_arch_local_regalloc              (MonoCompile *cfg, MonoBasicBlock *bb);
927 void      mono_arch_output_basic_block          (MonoCompile *cfg, MonoBasicBlock *bb);
928 gboolean  mono_arch_has_unwind_info             (gconstpointer addr);
929 void      mono_arch_setup_jit_tls_data          (MonoJitTlsData *tls);
930 void      mono_arch_free_jit_tls_data           (MonoJitTlsData *tls);
931 void      mono_arch_emit_this_vret_args         (MonoCompile *cfg, MonoCallInst *inst, int this_reg, int this_type, int vt_reg);
932 void      mono_arch_allocate_vars               (MonoCompile *m);
933 int       mono_arch_get_argument_info           (MonoMethodSignature *csig, int param_count, MonoJitArgumentInfo *arg_info);
934 gboolean  mono_arch_print_tree                  (MonoInst *tree, int arity);
935 MonoJitInfo *mono_arch_find_jit_info            (MonoDomain *domain, 
936                                                  MonoJitTlsData *jit_tls, 
937                                                  MonoJitInfo *res, 
938                                                  MonoJitInfo *prev_ji, 
939                                                  MonoContext *ctx, 
940                                                  MonoContext *new_ctx, 
941                                                  char **trace, 
942                                                  MonoLMF **lmf, 
943                                                  int *native_offset,
944                                                  gboolean *managed);
945 gpointer mono_arch_get_call_filter              (void);
946 gpointer mono_arch_get_restore_context          (void);
947 gboolean mono_arch_handle_exception             (void *sigctx, gpointer obj, gboolean test_only);
948 gpointer mono_arch_ip_from_context              (void *sigctx);
949 void     mono_arch_sigctx_to_monoctx            (void *sigctx, MonoContext *ctx);
950 void     mono_arch_monoctx_to_sigctx            (MonoContext *mctx, void *ctx);
951 void     mono_arch_flush_register_windows       (void);
952 gboolean mono_arch_is_inst_imm                  (gint64 imm);
953 MonoInst* mono_arch_get_domain_intrinsic        (MonoCompile* cfg);
954 MonoInst* mono_arch_get_thread_intrinsic        (MonoCompile* cfg);
955 gboolean mono_arch_is_int_overflow              (void *sigctx, void *info);
956 void     mono_arch_invalidate_method            (MonoJitInfo *ji, void *func, gpointer func_arg);
957 guint32  mono_arch_get_patch_offset             (guint8 *code);
958 gpointer*mono_arch_get_vcall_slot_addr          (guint8* code, gpointer *regs);
959 gpointer*mono_arch_get_delegate_method_ptr_addr (guint8* code, gpointer *regs);
960 void     mono_arch_create_vars                  (MonoCompile *cfg);
961 void     mono_arch_save_unwind_info             (MonoCompile *cfg);
962 void     mono_arch_register_lowlevel_calls      (void);
963 gpointer mono_arch_get_unbox_trampoline         (MonoMethod *m, gpointer addr);
964 void     mono_arch_patch_callsite               (guint8 *code, guint8 *addr);
965 void     mono_arch_nullify_class_init_trampoline(guint8 *code, gssize *regs);
966 void     mono_arch_patch_delegate_trampoline    (guint8 *code, guint8 *tramp, gssize *regs, guint8 *addr);
967 gpointer mono_arch_create_specific_trampoline   (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len);
968
969 /* Exception handling */
970 gboolean mono_handle_exception                  (MonoContext *ctx, gpointer obj,
971                                                  gpointer original_ip, gboolean test_only);
972 void     mono_handle_native_sigsegv             (void *sigctx);
973 void     mono_print_thread_dump                 (void *sigctx);
974 void     mono_jit_walk_stack                    (MonoStackWalk func, gboolean do_il_offset, gpointer user_data);
975 void     mono_jit_walk_stack_from_ctx           (MonoStackWalk func, MonoContext *ctx, gboolean do_il_offset, gpointer user_data);
976 void     mono_setup_altstack                    (MonoJitTlsData *tls);
977 void     mono_free_altstack                     (MonoJitTlsData *tls);
978
979 /* the new function to do stack walks */
980 typedef gboolean (*MonoStackFrameWalk)          (MonoDomain *domain, MonoContext *ctx, MonoJitInfo *ji, gpointer data);
981 void      mono_walk_stack                       (MonoDomain *domain, MonoJitTlsData *jit_tls, MonoContext *start_ctx, MonoStackFrameWalk func, gpointer user_data);
982
983 MonoArray *ves_icall_get_trace                  (MonoException *exc, gint32 skip, MonoBoolean need_file_info);
984 MonoBoolean ves_icall_get_frame_info            (gint32 skip, MonoBoolean need_file_info, 
985                                                  MonoReflectionMethod **method, 
986                                                  gint32 *iloffset, gint32 *native_offset,
987                                                  MonoString **file, gint32 *line, gint32 *column);
988 MonoString *ves_icall_System_Exception_get_trace (MonoException *exc);
989
990 /* Dominator/SSA methods */
991 void        mono_compile_dominator_info         (MonoCompile *cfg, int dom_flags);
992 void        mono_compute_natural_loops          (MonoCompile *cfg);
993 MonoBitSet* mono_compile_iterated_dfrontier     (MonoCompile *cfg, MonoBitSet *set);
994 void        mono_ssa_compute                    (MonoCompile *cfg);
995 void        mono_ssa_remove                     (MonoCompile *cfg);
996 void        mono_ssa_cprop                      (MonoCompile *cfg);
997 void        mono_ssa_deadce                     (MonoCompile *cfg);
998 void        mono_ssa_strength_reduction         (MonoCompile *cfg);
999 void        mono_free_loop_info                 (MonoCompile *cfg);
1000
1001 /* debugging support */
1002 void      mono_debug_init_method                (MonoCompile *cfg, MonoBasicBlock *start_block,
1003                                                  guint32 breakpoint_id);
1004 void      mono_debug_open_method                (MonoCompile *cfg);
1005 void      mono_debug_close_method               (MonoCompile *cfg);
1006 void      mono_debug_open_block                 (MonoCompile *cfg, MonoBasicBlock *bb, guint32 address);
1007 void      mono_debug_record_line_number         (MonoCompile *cfg, MonoInst *ins, guint32 address);
1008 void      mono_debug_serialize_debug_info       (MonoCompile *cfg, guint8 **out_buf, guint32 *buf_len);
1009 void      mono_debug_add_aot_method             (MonoDomain *domain,
1010                                                  MonoMethod *method, guint8 *code_start, 
1011                                                  guint8 *debug_info, guint32 debug_info_len);
1012 void      mono_debug_add_icall_wrapper          (MonoMethod *method, MonoJitICallInfo* info);
1013 void      mono_debugger_run_finally             (MonoContext *start_ctx);
1014
1015 /* Mono Debugger support */
1016 void      mono_debugger_init                    (void);
1017 int       mono_debugger_main                    (MonoDomain *domain, MonoAssembly *assembly, int argc, char **argv);
1018
1019
1020 /* Tracing */
1021 MonoTraceSpec *mono_trace_parse_options         (char *options);
1022 void           mono_trace_set_assembly          (MonoAssembly *assembly);
1023 gboolean       mono_trace_eval                  (MonoMethod *method);
1024
1025 extern void
1026 mono_perform_abc_removal (MonoCompile *cfg);
1027 extern void
1028 mono_perform_ssapre (MonoCompile *cfg);
1029
1030 /* CAS - stack walk */
1031 MonoSecurityFrame* ves_icall_System_Security_SecurityFrame_GetSecurityFrame (gint32 skip);
1032 MonoArray* ves_icall_System_Security_SecurityFrame_GetSecurityStack (gint32 skip);
1033
1034 #endif /* __MONO_MINI_H__ */