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