1 #ifndef __MONO_MINI_H__
2 #define __MONO_MINI_H__
6 #include <mono/metadata/loader.h>
7 #include <mono/metadata/mempool.h>
8 #include <mono/utils/monobitset.h>
9 #include <mono/metadata/class.h>
10 #include <mono/metadata/object.h>
11 #include <mono/metadata/opcodes.h>
12 #include <mono/metadata/tabledefs.h>
15 /* fixme: configure should set this */
16 #define SIZEOF_VOID_P 4
18 #define MONO_USE_AOT_COMPILER
21 #define mono_bitset_test_fast(set,n) (((guint32*)set)[2+(n)/32] & (1 << ((n) % 32)))
23 #define mono_bitset_test_fast(set,n) mono_bitset_test(set,n)
27 #define mono_bitset_foreach_bit(set,b,n) \
28 for (b = 0; b < n; b++)\
29 if (mono_bitset_test_fast(set,b))
30 #define mono_bitset_foreach_bit_rev(set,b,n) \
31 for (b = n - 1; b >= 0; b--)\
32 if (mono_bitset_test_fast(set,b))
34 #define mono_bitset_foreach_bit(set,b,n) \
35 for (b = mono_bitset_find_first (set, -1); b < n && b >= 0; b = mono_bitset_find_first (set, b))
36 #define mono_bitset_foreach_bit_rev(set,b,n) \
37 for (b = mono_bitset_find_last (set, n - 1); b >= 0; b = b ? mono_bitset_find_last (set, b) : -1)
42 * Pull the list of opcodes
44 #define OPDEF(a,b,c,d,e,f,g,h,i,j) \
48 #include "mono/cil/opcode.def"
53 #define MONO_VARINFO(cfg,varnum) ((cfg)->vars [varnum])
55 #define MONO_INST_NEW(cfg,dest,op) do { \
56 (dest) = mono_mempool_alloc0 ((cfg)->mempool, sizeof (MonoInst)); \
57 (dest)->opcode = (op); \
60 #define MONO_INST_NEW_CALL(cfg,dest,op) do { \
61 (dest) = mono_mempool_alloc0 ((cfg)->mempool, sizeof (MonoCallInst)); \
62 (dest)->inst.opcode = (op); \
65 #define MONO_ADD_INS(b,inst) do { \
66 if ((b)->last_ins) { \
67 (b)->last_ins->next = (inst); \
68 (b)->last_ins = (inst); \
70 (b)->code = (b)->last_ins = (inst); \
74 typedef struct MonoInst MonoInst;
75 typedef struct MonoCallInst MonoCallInst;
76 typedef struct MonoEdge MonoEdge;
77 typedef struct MonoMethodVar MonoMethodVar;
78 typedef struct MonoBasicBlock MonoBasicBlock;
79 typedef struct MonoLMF MonoLMF;
80 typedef struct MonoSpillInfo MonoSpillInfo;
82 extern guint32 mono_jit_tls_id;
83 extern gboolean mono_jit_trace_calls;
84 extern gboolean mono_break_on_exc;
85 extern int mono_exc_esp_offset;
86 extern gboolean mono_compile_aot;
87 extern gboolean mono_trace_coverage;
88 extern gboolean mono_jit_profile;
90 extern CRITICAL_SECTION *metadata_section;
98 struct MonoSpillInfo {
104 * The IR-level basic block.
106 * A basic block can have multiple exits just fine, as long as the point of
107 * 'departure' is the last instruction in the basic block. Extended basic
108 * blocks, on the other hand, may have instructions that leave the block
109 * midstream. The important thing is that they cannot be _entered_
110 * midstream, ie, execution of a basic block (or extened bb) always start
111 * at the beginning of the block, never in the middle.
113 struct MonoBasicBlock {
116 /* Points to the start of the CIL code that initiated this BB */
117 unsigned char* cil_code;
119 /* Length of the CIL block */
122 /* The address of the generated code, used for fixups */
128 /* unique block number identification */
131 /* Visited and reachable flags */
134 /* Basic blocks: incoming and outgoing counts and pointers */
135 gint16 out_count, in_count;
136 MonoBasicBlock **in_bb;
137 MonoBasicBlock **out_bb;
139 /* the next basic block in the order it appears in IL */
140 MonoBasicBlock *next_bb;
143 * Before instruction selection it is the first tree in the
144 * forest and the first item in the list of trees. After
145 * instruction selection it is the first instruction and the
146 * first item in the list of instructions.
151 * SSA and loop based flags
153 MonoBitSet *dominators;
154 MonoBitSet *dfrontier;
155 MonoBasicBlock *idom;
157 /* fast dominator algorithm */
158 MonoBasicBlock *df_parent, *ancestor, *child, *label;
160 int size, sdom, idomn;
162 /* loop nesting and recognition */
166 /* use for liveness analysis */
168 MonoBitSet *kill_set;
169 MonoBitSet *live_in_set;
170 MonoBitSet *live_out_set;
172 /* fields to deal with non-empty stack slots at bb boundary */
173 guint16 out_scount, in_scount;
174 MonoInst **out_stack;
177 /* we use that to prevent merging of bblock covered by different clauses*/
181 /* The current symbolic register number, used in local register allocation. */
182 guint32 max_ireg, max_freg;
187 #define BB_REACHABLE 2
197 MonoMethodSignature *signature;
198 MonoBasicBlock **many_blocks;
199 MonoBasicBlock *target_block;
209 guint8 type; /* stack type */
213 /* used by the register allocator */
214 gint32 dreg, sreg1, sreg2, unused;
218 const unsigned char* cil_code; /* for debugging and bblock splitting */
221 struct MonoCallInst {
223 MonoMethodSignature *signature;
234 * Note: some of the values overlap, because they can't appear
235 * in the same MonoInst.
238 MONO_INST_HAS_METHOD = 1,
239 /* temp local created by a DUP: used only within a BB */
240 MONO_INST_IS_TEMP = 1,
241 MONO_INST_INIT = 1, /* in localloc */
242 MONO_INST_IS_DEAD = 2,
243 MONO_INST_TAILCALL = 4,
244 MONO_INST_VOLATILE = 4,
245 MONO_INST_BRLABEL = 4,
246 MONO_INST_UNALIGNED = 8,
247 /* the address of the variable has been taken */
248 MONO_INST_INDIRECT = 16
251 #define inst_c0 data.op[0].const_val
252 #define inst_c1 data.op[1].const_val
253 #define inst_i0 data.op[0].src
254 #define inst_i1 data.op[1].src
255 #define inst_p0 data.op[0].p
256 #define inst_p1 data.op[1].p
257 #define inst_l data.i8const
258 #define inst_r data.r8const
259 #define inst_left data.op[0].src
260 #define inst_right data.op[1].src
262 #define inst_newa_len data.op[0].src
263 #define inst_newa_class data.op[1].klass
265 #define inst_switch data.op[0].switch_blocks
266 #define inst_var data.op[0].var
267 #define inst_vtype data.op[1].vtype
268 /* in branch instructions */
269 #define inst_many_bb data.op[1].many_blocks
270 #define inst_target_bb data.op[0].target_block
271 #define inst_true_bb data.op[1].many_blocks[0]
272 #define inst_false_bb data.op[1].many_blocks[1]
274 #define inst_basereg sreg1
275 #define inst_indexreg sreg2
276 #define inst_destbasereg dreg
277 #define inst_offset data.op[0].const_val
278 #define inst_imm data.op[1].const_val
280 #define inst_phi_args data.op[1].phi_args
282 /* instruction description for use in regalloc/scheduling */
298 guint16 tid; /* tree number */
299 guint16 bid; /* block number */
305 MonoPosition first_use, last_use;
309 * Additional information about a variable
311 struct MonoMethodVar {
312 guint idx; /* inside cfg->varinfo, cfg->vars */
314 MonoBitSet *dfrontier;
315 MonoLiveRange range; /* generated by liveness analysis */
316 int reg; /* != -1 if allocated into a register */
318 MonoBitSet *def_in; /* used by SSA */
319 MonoInst *def; /* used by SSA */
320 MonoBasicBlock *def_bb; /* used by SSA */
321 GList *uses; /* used by SSA */
322 char cpstate; /* used by SSA conditional constant propagation */
326 gpointer end_of_stack;
328 void (*abort_func) (MonoObject *object);
334 MONO_PATCH_INFO_LABEL,
335 MONO_PATCH_INFO_METHOD,
336 MONO_PATCH_INFO_METHOD_JUMP,
337 MONO_PATCH_INFO_METHODCONST,
338 MONO_PATCH_INFO_INTERNAL_METHOD,
339 MONO_PATCH_INFO_SWITCH,
341 MONO_PATCH_INFO_CLASS,
342 MONO_PATCH_INFO_IMAGE,
343 MONO_PATCH_INFO_FIELD,
349 typedef struct MonoJumpInfo MonoJumpInfo;
350 struct MonoJumpInfo {
358 MonoJumpInfoType type;
360 gconstpointer target;
363 MonoBasicBlock **table;
367 MonoClassField *field;
372 int table_size; /* use by switch */
375 /* optimization flags: keep up to date with the name array in mini.c */
377 MONO_OPT_PEEPHOLE = 1 << 0,
378 MONO_OPT_BRANCH = 1 << 1,
379 MONO_OPT_INLINE = 1 << 2,
380 MONO_OPT_CFOLD = 1 << 3,
381 MONO_OPT_CONSPROP = 1 << 4,
382 MONO_OPT_COPYPROP = 1 << 5,
383 MONO_OPT_DEADCE = 1 << 6,
384 MONO_OPT_LINEARS = 1 << 7,
385 MONO_OPT_CMOV = 1 << 8,
386 MONO_OPT_SHARED = 1 << 9,
387 MONO_OPT_SCHED = 1 << 10,
388 MONO_OPT_INTRINS = 1 << 11,
389 MONO_OPT_TAILC = 1 << 12,
390 MONO_OPT_LOOP = 1 << 13,
391 MONO_OPT_FCMOV = 1 << 14,
392 MONO_OPT_LEAF = 1 << 15
395 #define MONO_REGION_FINALLY 16
396 #define MONO_REGION_CATCH 32
397 #define MONO_REGION_FAULT 64
398 #define MONO_REGION_FILTER 128
401 * Control Flow Graph and compilation unit information
405 MonoMemPool *mempool;
407 MonoMethodVar **vars;
409 MonoBasicBlock *bb_entry;
410 MonoBasicBlock *bb_exit;
411 MonoBasicBlock *bb_init;
412 MonoBasicBlock **bblocks;
414 MonoMemPool *state_pool; /* used by instruction selection */
415 MonoBasicBlock *cbb; /* used by instruction selection */
416 MonoInst *prev_ins; /* in decompose */
417 MonoJumpInfo *patch_info;
420 guint num_varinfo; /* used items in varinfo */
421 guint varinfo_count; /* total storage in varinfo */
424 MonoSpillInfo *spill_info;
426 // unsigned char *cil_code;
428 MonoInst *exvar; /* the exception object passed to catch/filter blocks */
429 MonoInst *domainvar; /* a cache for the current domain */
430 MonoInst *spvar; /* a place to store the stack pointer (used by handlers) */
432 GList *ldstr_list; /* used by AOT */
436 unsigned char *native_code;
441 guint32 used_int_regs;
445 guint32 verbose_level;
450 gboolean disable_aot;
451 gboolean disable_ssa;
457 MONO_CFG_HAS_ALLOCA = 1 << 0,
458 MONO_CFG_HAS_CALLS = 1 << 1
470 gulong methods_compiled;
472 gulong methods_lookups;
473 gulong method_trampolines;
475 gulong analyze_stack_repeat;
476 gulong cil_code_size;
477 gulong native_code_size;
478 gulong code_reallocs;
479 gulong max_code_size_ratio;
480 gulong biggest_method_size;
481 gulong allocated_code_size;
482 gulong inlineable_methods;
483 gulong inlined_methods;
485 gulong max_basic_blocks;
486 MonoMethod *max_ratio_method;
487 MonoMethod *biggest_method;
491 extern MonoJitStats mono_jit_stats;
493 /* values for MonoInst.ssa_op */
502 #define OP_CEQ (256+CEE_CEQ)
503 #define OP_CLT (256+CEE_CLT)
504 #define OP_CLT_UN (256+CEE_CLT_UN)
505 #define OP_CGT (256+CEE_CGT)
506 #define OP_CGT_UN (256+CEE_CGT_UN)
507 #define OP_LOCALLOC (256+CEE_LOCALLOC)
509 /* opcodes: value assigned after all the CIL opcodes */
513 #define MINI_OP(a,b) a,
515 OP_START = MONO_CEE_LAST,
516 #include "mini-ops.h"
521 /* make this depend on 32bit platform (use OP_LADD otherwise) */
522 #define OP_PADD CEE_ADD
523 #define OP_PNEG CEE_NEG
524 #define OP_PCONV_TO_U2 CEE_CONV_U2
525 #define OP_PCONV_TO_OVF_I1_UN CEE_CONV_OVF_I1_UN
526 #define OP_PCONV_TO_OVF_I1 CEE_CONV_OVF_I1
527 #define OP_PCEQ CEE_CEQ
555 MONO_COMP_DFRONTIER = 4,
556 MONO_COMP_DOM_REV = 8,
557 MONO_COMP_LIVENESS = 16,
559 MONO_COMP_SSA_DEF_USE = 64,
560 MONO_COMP_REACHABILITY = 128,
561 MONO_COMP_LOOPS = 256
566 MONO_GRAPH_DTREE = 2,
567 MONO_GRAPH_CFG_CODE = 4,
568 MONO_GRAPH_CFG_SSA = 8,
569 MONO_GRAPH_CFG_OPTCODE = 16
575 gconstpointer wrapper;
576 MonoMethodSignature *sig;
579 typedef void (*MonoInstFunc) (MonoInst *tree, gpointer data);
582 int mono_main (int argc, char* argv[]);
583 void mono_set_defaults (int verbose_level, guint32 opts);
584 MonoDomain* mini_init (const char *filename);
585 void mini_cleanup (MonoDomain *domain);
588 int mono_parse_default_optimizations (const char* p);
589 void mono_bblock_add_inst (MonoBasicBlock *bb, MonoInst *inst);
590 void mono_constant_fold (MonoCompile *cfg);
591 void mono_constant_fold_inst (MonoInst *inst, gpointer data);
592 void mono_cprop_local (MonoCompile *cfg, MonoBasicBlock *bb, MonoInst **acp, int acp_size);
593 MonoInst* mono_compile_create_var (MonoCompile *cfg, MonoType *type, int opcode);
594 void mono_blockset_print (MonoCompile *cfg, MonoBitSet *set, const char *name, guint idom);
595 void mono_print_tree (MonoInst *tree);
596 int mono_spillvar_offset (MonoCompile *cfg, int spillvar);
597 void mono_select_instructions (MonoCompile *cfg);
598 const char* mono_inst_name (int op);
599 void mono_inst_foreach (MonoInst *tree, MonoInstFunc func, gpointer data);
600 void mono_disassemble_code (guint8 *code, int size, char *id);
601 guint mono_type_to_ldind (MonoType *t);
602 guint mono_type_to_stind (MonoType *t);
603 void mono_add_patch_info (MonoCompile *cfg, int ip, MonoJumpInfoType type, gconstpointer target);
604 void mono_remove_patch_info (MonoCompile *cfg, int ip);
605 gpointer mono_get_lmf_addr (void);
606 GList *mono_varlist_insert_sorted (MonoCompile *cfg, GList *list, MonoMethodVar *mv, gboolean sort_end);
607 void mono_analyze_liveness (MonoCompile *cfg);
608 void mono_linear_scan (MonoCompile *cfg, GList *vars, GList *regs, guint32 *used_mask);
609 void mono_create_jump_table (MonoCompile *cfg, MonoInst *label, MonoBasicBlock **bbs, int num_blocks);
610 int mono_compile_assembly (MonoAssembly *ass, guint32 opts);
611 MonoCompile *mini_method_compile (MonoMethod *method, guint32 opts, MonoDomain *domain, int parts);
612 void mono_destroy_compile (MonoCompile *cfg);
613 gpointer mono_aot_get_method (MonoMethod *method);
614 gboolean mono_method_blittable (MonoMethod *method);
615 void mono_register_opcode_emulation (int opcode, const char* name, MonoMethodSignature *sig, gpointer func, gboolean no_throw);
616 void mono_arch_register_lowlevel_calls (void);
617 void mono_draw_graph (MonoCompile *cfg, MonoGraphOptions draw_options);
618 void mono_add_varcopy_to_end (MonoCompile *cfg, MonoBasicBlock *bb, int src, int dest);
620 int mono_find_method_opcode (MonoMethod *method);
621 MonoJitICallInfo *mono_find_jit_icall_by_name (const char *name);
622 MonoJitICallInfo *mono_find_jit_icall_by_addr (gconstpointer addr);
623 MonoJitICallInfo *mono_register_jit_icall (gconstpointer func, const char *name, MonoMethodSignature *sig, gboolean is_save);
624 gconstpointer mono_icall_get_wrapper (MonoJitICallInfo* callinfo);
626 MonoCoverageInfo *mono_allocate_coverage_info (MonoMethod *method, int size);
627 MonoCoverageInfo *mono_get_coverage_info (MonoMethod *method);
629 /* methods that must be provided by the arch-specific port */
630 guint32 mono_arch_cpu_optimizazions (guint32 *exclude_mask);
631 void mono_arch_instrument_mem_needs (MonoMethod *method, int *stack, int *code);
632 void *mono_arch_instrument_prolog (MonoCompile *cfg, void *func, void *p, gboolean enable_arguments);
633 void *mono_arch_instrument_epilog (MonoCompile *cfg, void *func, void *p, gboolean enable_arguments);
634 MonoCallInst *mono_arch_call_opcode (MonoCompile *cfg, MonoBasicBlock* bb, MonoCallInst *call, int is_virtual);
635 void mono_codegen (MonoCompile *cfg);
636 const char *mono_arch_regname (int reg);
637 gpointer mono_arch_get_throw_exception (void);
638 gpointer mono_arch_get_throw_exception_by_name (void);
639 gpointer mono_arch_create_jit_trampoline (MonoMethod *method);
640 gpointer mono_arch_create_jump_trampoline (MonoMethod *method);
641 GList *mono_arch_get_allocatable_int_vars (MonoCompile *cfg);
642 GList *mono_arch_get_global_int_regs (MonoCompile *cfg);
643 void mono_arch_patch_code (MonoMethod *method, MonoDomain *domain, guint8 *code, MonoJumpInfo *ji);
644 void mono_arch_flush_icache (guint8 *code, gint size);
645 int mono_arch_max_epilog_size (MonoCompile *cfg);
646 guint8 *mono_arch_emit_prolog (MonoCompile *cfg);
647 void mono_arch_emit_epilog (MonoCompile *cfg);
648 void mono_arch_local_regalloc (MonoCompile *cfg, MonoBasicBlock *bb);
649 void mono_arch_output_basic_block (MonoCompile *cfg, MonoBasicBlock *bb);
650 gboolean mono_arch_has_unwind_info (gconstpointer addr);
651 void mono_arch_allocate_vars (MonoCompile *m);
652 void mono_jit_walk_stack (MonoStackWalk func, gpointer user_data);
653 MonoArray *ves_icall_get_trace (MonoException *exc, gint32 skip, MonoBoolean need_file_info);
654 MonoBoolean ves_icall_get_frame_info (gint32 skip, MonoBoolean need_file_info,
655 MonoReflectionMethod **method,
656 gint32 *iloffset, gint32 *native_offset,
657 MonoString **file, gint32 *line, gint32 *column);
659 /* Dominator/SSA methods */
660 void mono_compile_dominator_info (MonoCompile *cfg, int dom_flags);
661 void mono_compute_natural_loops (MonoCompile *cfg);
662 MonoBitSet* mono_compile_iterated_dfrontier (MonoCompile *cfg, MonoBitSet *set);
663 void mono_ssa_compute (MonoCompile *cfg);
664 void mono_ssa_remove (MonoCompile *cfg);
665 void mono_ssa_cprop (MonoCompile *cfg);
666 void mono_ssa_deadce (MonoCompile *cfg);
667 void mono_ssa_strength_reduction (MonoCompile *cfg);
669 /* debugging support */
670 void mono_debug_init_method (MonoCompile *cfg, MonoBasicBlock *start_block,
671 guint32 breakpoint_id);
672 void mono_debug_open_method (MonoCompile *cfg);
673 void mono_debug_close_method (MonoCompile *cfg);
674 void mono_debug_open_block (MonoCompile *cfg, MonoBasicBlock *bb, guint32 address);
675 void mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address);
677 #endif /* __MONO_MINI_H__ */