2 * emit-x86.c: Support functions for emitting x86 code
5 * Dietmar Maurer (dietmar@ximian.com)
6 * Miguel de Icaza (miguel@ximian.com)
8 * (C) 2001 Ximian, Inc.
14 #include <mono/metadata/assembly.h>
15 #include <mono/metadata/loader.h>
16 #include <mono/metadata/cil-coff.h>
17 #include <mono/metadata/tabledefs.h>
18 #include <mono/metadata/class.h>
19 #include <mono/metadata/debug-helpers.h>
20 #include <mono/metadata/mono-endian.h>
21 #include <mono/arch/x86/x86-codegen.h>
28 enter_method (MonoMethod *method, char *ebp)
34 printf ("ENTER: %s.%s::%s\n(", method->klass->name_space,
35 method->klass->name, method->name);
38 if (((int)ebp & 3) != 0) {
39 g_error ("unaligned stack detected (%p)", ebp);
44 if (ISSTRUCT (method->signature->ret)) {
47 g_assert (!method->signature->ret->byref);
49 size = mono_type_stack_size (method->signature->ret, &align);
51 printf ("VALUERET:%p, ", *((gpointer *)ebp));
52 ebp += sizeof (gpointer);
55 if (method->signature->hasthis) {
56 if (method->klass->valuetype) {
57 printf ("value:%p, ", *((gpointer *)ebp));
59 o = *((MonoObject **)ebp);
63 class = o->vtable->klass;
65 if (class == mono_defaults.string_class) {
66 printf ("this:[STRING:%p:%s], ", o, mono_string_to_utf8 ((MonoString *)o));
68 printf ("this:%p[%s.%s], ", o, class->name_space, class->name);
71 ebp += sizeof (gpointer);
74 for (i = 0; i < method->signature->param_count; ++i) {
75 MonoType *type = method->signature->params [i];
77 size = mono_type_stack_size (type, &align);
80 printf ("[BYREF:%p], ", *((gpointer *)ebp));
81 } else switch (type->type) {
83 case MONO_TYPE_BOOLEAN:
93 printf ("%d, ", *((int *)(ebp)));
95 case MONO_TYPE_STRING: {
96 MonoString *s = *((MonoString **)ebp);
98 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
99 printf ("[STRING:%p:%s], ", s, mono_string_to_utf8 (s));
101 printf ("[STRING:null], ");
104 case MONO_TYPE_CLASS:
105 case MONO_TYPE_OBJECT: {
106 o = *((MonoObject **)ebp);
108 class = o->vtable->klass;
110 if (class == mono_defaults.string_class) {
111 printf ("[STRING:%p:%s], ", o, mono_string_to_utf8 ((MonoString *)o));
112 } else if (class == mono_defaults.int32_class) {
113 printf ("[INT32:%p:%d], ", o, *(gint32 *)((char *)o + sizeof (MonoObject)));
115 printf ("[%s.%s:%p], ", class->name_space, class->name, o);
117 printf ("%p, ", *((gpointer *)(ebp)));
122 case MONO_TYPE_FNPTR:
123 case MONO_TYPE_ARRAY:
124 case MONO_TYPE_SZARRAY:
125 printf ("%p, ", *((gpointer *)(ebp)));
128 printf ("%lld, ", *((gint64 *)(ebp)));
131 printf ("%f, ", *((float *)(ebp)));
134 printf ("%f, ", *((double *)(ebp)));
136 case MONO_TYPE_VALUETYPE:
138 for (j = 0; j < size; j++)
139 printf ("%02x,", *((guint8*)ebp +j));
146 g_assert (align == 4);
148 ebp = (gpointer)((unsigned)ebp & ~(3));
155 leave_method (MonoMethod *method, int edx, int eax, double test)
159 printf ("LEAVE: %s.%s::%s ", method->klass->name_space,
160 method->klass->name, method->name);
162 switch (method->signature->ret->type) {
165 case MONO_TYPE_BOOLEAN:
167 printf ("TRUE:%d", eax);
181 printf ("EAX=%d", eax);
183 case MONO_TYPE_STRING: {
184 MonoString *s = (MonoString *)eax;
187 g_assert (((MonoObject *)s)->vtable->klass == mono_defaults.string_class);
188 printf ("[STRING:%p:%s]", s, mono_string_to_utf8 (s));
190 printf ("[STRING:null], ");
193 case MONO_TYPE_OBJECT: {
194 MonoObject *o = (MonoObject *)eax;
197 if (o->vtable->klass == mono_defaults.boolean_class) {
198 printf ("[BOOLEAN:%p:%d]", o, *((guint8 *)o + sizeof (MonoObject)));
199 } else if (o->vtable->klass == mono_defaults.int32_class) {
200 printf ("[INT32:%p:%d]", o, *((gint32 *)((char *)o + sizeof (MonoObject))));
202 printf ("[%s.%s:%p]", o->vtable->klass->name_space, o->vtable->klass->name, o);
204 printf ("[OBJECT:%p]", o);
208 case MONO_TYPE_CLASS:
210 case MONO_TYPE_FNPTR:
211 case MONO_TYPE_ARRAY:
212 case MONO_TYPE_SZARRAY:
213 printf ("EAX=%p", (gpointer)eax);
216 *((gint32 *)&l) = eax;
217 *((gint32 *)&l + 1) = edx;
218 printf ("EAX/EDX=%lld", l);
221 printf ("FP=%f\n", test);
224 printf ("(unknown return type)");
231 * arch_emit_prologue:
232 * @cfg: pointer to status information
234 * Emits the function prolog.
237 arch_emit_prologue (MonoFlowGraph *cfg)
239 x86_push_reg (cfg->code, X86_EBP);
240 x86_mov_reg_reg (cfg->code, X86_EBP, X86_ESP, 4);
242 if (cfg->locals_size)
243 x86_alu_reg_imm (cfg->code, X86_SUB, X86_ESP, cfg->locals_size);
245 if (mono_regset_reg_used (cfg->rs, X86_EBX))
246 x86_push_reg (cfg->code, X86_EBX);
248 if (mono_regset_reg_used (cfg->rs, X86_EDI))
249 x86_push_reg (cfg->code, X86_EDI);
251 if (mono_regset_reg_used (cfg->rs, X86_ESI))
252 x86_push_reg (cfg->code, X86_ESI);
254 if (mono_jit_trace_calls) {
255 x86_push_reg (cfg->code, X86_EBP);
256 x86_push_imm (cfg->code, cfg->method);
257 x86_mov_reg_imm (cfg->code, X86_EAX, enter_method);
258 x86_call_reg (cfg->code, X86_EAX);
259 x86_alu_reg_imm (cfg->code, X86_ADD, X86_ESP, 8);
264 * arch_emit_epilogue:
265 * @cfg: pointer to status information
267 * Emits the function epilog.
270 arch_emit_epilogue (MonoFlowGraph *cfg)
272 if (mono_jit_trace_calls) {
273 x86_fld_reg (cfg->code, 0);
274 x86_alu_reg_imm (cfg->code, X86_SUB, X86_ESP, 8);
275 x86_fst_membase (cfg->code, X86_ESP, 0, TRUE, TRUE);
276 x86_push_reg (cfg->code, X86_EAX);
277 x86_push_reg (cfg->code, X86_EDX);
278 x86_push_imm (cfg->code, cfg->method);
279 x86_mov_reg_imm (cfg->code, X86_EAX, leave_method);
280 x86_call_reg (cfg->code, X86_EAX);
281 x86_alu_reg_imm (cfg->code, X86_ADD, X86_ESP, 4);
282 x86_pop_reg (cfg->code, X86_EDX);
283 x86_pop_reg (cfg->code, X86_EAX);
284 x86_alu_reg_imm (cfg->code, X86_ADD, X86_ESP, 8);
287 if (mono_regset_reg_used (cfg->rs, X86_ESI))
288 x86_pop_reg (cfg->code, X86_ESI);
290 if (mono_regset_reg_used (cfg->rs, X86_EDI))
291 x86_pop_reg (cfg->code, X86_EDI);
293 if (mono_regset_reg_used (cfg->rs, X86_EBX))
294 x86_pop_reg (cfg->code, X86_EBX);
296 x86_leave (cfg->code);
301 mono_label_cfg (MonoFlowGraph *cfg)
305 for (i = 0; i < cfg->block_count; i++) {
306 GPtrArray *forest = cfg->bblocks [i].forest;
309 if (!cfg->bblocks [i].reached) /* unreachable code */
314 for (j = 0; j < top; j++) {
315 MBTree *t1 = (MBTree *) g_ptr_array_index (forest, j);
318 mbstate = mono_burg_label (t1, cfg);
321 if (mono_debug_handle)
323 g_warning ("tree does not match");
324 mono_print_ctree (t1); printf ("\n\n");
326 mono_print_forest (forest);
327 g_assert_not_reached ();
334 tree_preallocate_regs (MBTree *tree, int goal, MonoRegSet *rs)
337 case MB_TERM_CALL_I4:
338 case MB_TERM_CALL_I8:
339 case MB_TERM_CALL_R8:
340 // case MB_TERM_CALL_VOID :
341 tree->reg1 = mono_regset_alloc_reg (rs, X86_EAX, tree->exclude_mask);
342 tree->reg2 = mono_regset_alloc_reg (rs, X86_EDX, tree->exclude_mask);
343 tree->reg3 = mono_regset_alloc_reg (rs, X86_ECX, tree->exclude_mask);
350 case MB_NTERM_lreg: {
355 tree->exclude_mask |= (1 << X86_ECX);
356 tree->left->exclude_mask |= (1 << X86_ECX);
359 case MB_TERM_MUL_OVF:
360 case MB_TERM_MUL_OVF_UN:
365 tree->reg1 = mono_regset_alloc_reg (rs, X86_EAX, tree->exclude_mask);
366 tree->reg2 = mono_regset_alloc_reg (rs, X86_EDX, tree->exclude_mask);
367 if (goal == MB_NTERM_reg) {
368 tree->left->exclude_mask |= (1 << X86_EDX);
369 tree->right->exclude_mask |= (1 << X86_EDX) | (1 << X86_EAX);
383 tree_allocate_regs (MBTree *tree, int goal, MonoRegSet *rs)
386 int ern = mono_burg_rule (tree->state, goal);
387 const guint16 *nts = mono_burg_nts [ern];
390 mono_burg_kids (tree, ern, kids);
392 //printf ("RALLOC START %d %p %d\n", tree->op, rs->free_mask, goal);
394 if (nts [0] && kids [0] == tree) {
396 tree_allocate_regs (kids [0], nts [0], rs);
400 for (i = 0; nts [i]; i++)
401 tree_preallocate_regs (kids [i], nts [i], rs);
403 for (i = 0; nts [i]; i++)
404 tree_allocate_regs (kids [i], nts [i], rs);
406 for (i = 0; nts [i]; i++) {
407 mono_regset_free_reg (rs, kids [i]->reg1);
408 mono_regset_free_reg (rs, kids [i]->reg2);
409 mono_regset_free_reg (rs, kids [i]->reg3);
414 if (tree->reg1 < 0) {
415 tree->reg1 = mono_regset_alloc_reg (rs, -1, tree->exclude_mask);
416 g_assert (tree->reg1 != -1);
421 if (tree->reg1 < 0) {
422 tree->reg1 = mono_regset_alloc_reg (rs, -1, tree->exclude_mask);
423 g_assert (tree->reg1 != -1);
425 if (tree->reg2 < 0) {
426 tree->reg2 = mono_regset_alloc_reg (rs, -1, tree->exclude_mask);
427 g_assert (tree->reg2 != -1);
432 /* fixme: allocate floating point registers */
436 if (tree->op == MB_TERM_ADD) {
437 tree->reg1 = mono_regset_alloc_reg (rs, tree->left->reg1, tree->exclude_mask);
438 tree->reg2 = mono_regset_alloc_reg (rs, tree->right->reg1, tree->exclude_mask);
443 if (tree->op == MB_TERM_ADD) {
444 tree->reg1 = mono_regset_alloc_reg (rs, tree->left->reg1, tree->exclude_mask);
449 if (tree->op == MB_TERM_SHL ||
450 tree->op == MB_TERM_MUL) {
451 tree->reg1 = mono_regset_alloc_reg (rs, tree->left->reg1, tree->exclude_mask);
459 //printf ("RALLOC END %d %p\n", tree->op, rs->free_mask);
460 tree->emit = mono_burg_func [ern];
464 arch_allocate_regs (MonoFlowGraph *cfg)
468 for (i = 0; i < cfg->block_count; i++) {
469 GPtrArray *forest = cfg->bblocks [i].forest;
472 if (!cfg->bblocks [i].reached) /* unreachable code */
477 for (j = 0; j < top; j++) {
478 MBTree *t1 = (MBTree *) g_ptr_array_index (forest, j);
479 //printf ("AREGSTART %d:%d %p\n", i, j, cfg->rs->free_mask);
480 tree_allocate_regs (t1, 1, cfg->rs);
481 //printf ("AREGENDT %d:%d %p\n", i, j, cfg->rs->free_mask);
482 g_assert (cfg->rs->free_mask == 0xffffffff);
488 tree_emit (int goal, MonoFlowGraph *cfg, MBTree *tree)
491 int i, ern = mono_burg_rule (tree->state, goal);
492 const guint16 *nts = mono_burg_nts [ern];
496 mono_burg_kids (tree, ern, kids);
498 for (i = 0; nts [i]; i++)
499 tree_emit (nts [i], cfg, kids [i]);
501 tree->addr = offset = cfg->code - cfg->start;
503 // we assume an instruction uses a maximum of 128 bytes
504 if ((cfg->code_size - offset) <= 128) {
505 int add = MIN (cfg->code_size, 128);
506 cfg->code_size += add;
507 mono_jit_stats.code_reallocs++;
508 cfg->start = g_realloc (cfg->start, cfg->code_size);
509 g_assert (cfg->start);
510 cfg->code = cfg->start + offset;
513 if ((emit = mono_burg_func [ern]))
516 g_assert ((cfg->code - cfg->start) < cfg->code_size);
520 mono_emit_cfg (MonoFlowGraph *cfg)
524 for (i = 0; i < cfg->block_count; i++) {
525 MonoBBlock *bb = &cfg->bblocks [i];
526 GPtrArray *forest = bb->forest;
529 if (!bb->reached) /* unreachable code */
534 bb->addr = cfg->code - cfg->start;
536 for (j = 0; j < top; j++) {
537 MBTree *t1 = (MBTree *) g_ptr_array_index (forest, j);
539 tree_emit (1, cfg, t1);
543 cfg->epilog = cfg->code - cfg->start;
547 mono_compute_branches (MonoFlowGraph *cfg)
555 for (j = 0; j < cfg->block_count; j++) {
556 MonoBBlock *bb = &cfg->bblocks [j];
557 GPtrArray *forest = bb->forest;
560 if (!bb->reached) /* unreachable code */
565 for (i = 0; i < top; i++) {
566 MBTree *t1 = (MBTree *) g_ptr_array_index (forest, i);
568 if (t1->op == MB_TERM_SWITCH) {
569 MonoBBlock **jt = (MonoBBlock **)t1->data.p;
570 guint32 *rt = (guint32 *)t1->data.p;
571 int m = *((guint32 *)t1->data.p) + 1;
574 for (k = 1; k <= m; k++)
575 rt [k] = (int)(jt [k]->addr + cfg->start);
577 /* emit the switch instruction again to update addresses */
578 cfg->code = cfg->start + t1->addr;
579 ((MBEmitFunc)t1->emit) (t1, cfg);
586 for (ji = cfg->jump_info; ji; ji = ji->next) {
587 gpointer *ip = GUINT_TO_POINTER (GPOINTER_TO_UINT (ji->ip) + cfg->start);
591 case MONO_JUMP_INFO_BB:
592 target = ji->data.bb->addr + cfg->start;
593 *ip = target - GPOINTER_TO_UINT(ip) - 4;
595 case MONO_JUMP_INFO_ABS:
596 target = ji->data.target;
597 *ip = target - GPOINTER_TO_UINT(ip) - 4;
599 case MONO_JUMP_INFO_EPILOG:
600 target = cfg->epilog + cfg->start;
601 *ip = target - GPOINTER_TO_UINT(ip) - 4;
603 case MONO_JUMP_INFO_IP:
607 g_assert_not_reached ();
613 mono_add_jump_info (MonoFlowGraph *cfg, gpointer ip, MonoJumpInfoType type, gpointer target)
615 MonoJumpInfo *ji = mono_mempool_alloc (cfg->mp, sizeof (MonoJumpInfo));
618 ji->ip = GUINT_TO_POINTER (GPOINTER_TO_UINT (ip) - GPOINTER_TO_UINT (cfg->start));
619 ji->data.target = target;
620 ji->next = cfg->jump_info;
626 match_debug_method (MonoMethod* method)
628 GList *tmp = mono_debug_methods;
630 for (; tmp; tmp = tmp->next) {
631 if (mono_method_desc_full_match (tmp->data, method))
638 * arch_compile_method:
639 * @method: pointer to the method info
641 * JIT compilation of a single method.
643 * Returns: a pointer to the newly created code.
646 arch_compile_method (MonoMethod *method)
648 MonoDomain *target_domain, *domain = mono_domain_get ();
652 GHashTable *jit_code_hash;
654 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
655 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)) {
657 method->info = arch_create_native_wrapper (method);
661 if (mono_jit_share_code)
662 target_domain = mono_root_domain;
664 target_domain = domain;
666 jit_code_hash = target_domain->jit_code_hash;
668 if ((addr = g_hash_table_lookup (jit_code_hash, method))) {
669 mono_jit_stats.methods_lookups++;
673 mono_jit_stats.methods_compiled++;
675 mp = mono_mempool_new ();
677 if (mono_jit_trace_calls || mono_jit_dump_asm || mono_jit_dump_forest) {
678 printf ("Start JIT compilation of %s.%s:%s\n", method->klass->name_space,
679 method->klass->name, method->name);
682 if (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) {
683 const char *name = method->name;
685 gboolean delegate = FALSE;
687 if (method->klass->parent == mono_defaults.multicastdelegate_class)
690 if (delegate && *name == '.' && (strcmp (name, ".ctor") == 0)) {
691 addr = (gpointer)mono_delegate_ctor;
692 } else if (delegate && *name == 'I' && (strcmp (name, "Invoke") == 0)) {
695 addr = arch_get_delegate_invoke (method, &size);
697 if (mono_jit_dump_asm) {
698 char *id = g_strdup_printf ("%s.%s_%s", method->klass->name_space,
699 method->klass->name, method->name);
700 mono_disassemble_code (addr, size, id);
703 } else if (delegate && *name == 'B' && (strcmp (name, "BeginInvoke") == 0)) {
704 code = addr = g_malloc (256);
705 x86_push_imm (code, method);
706 x86_call_code (code, arch_begin_invoke);
707 x86_alu_reg_imm (code, X86_ADD, X86_ESP, 4);
709 } else if (delegate && *name == 'E' && (strcmp (name, "EndInvoke") == 0)) {
710 /* this an raise exceptions, so we need a wrapper to save/restore LMF */
711 method->addr = (gpointer)arch_end_invoke;
712 addr = arch_create_native_wrapper (method);
714 if (mono_debug_handle)
717 g_error ("Don't know how to exec runtime method %s.%s::%s",
718 method->klass->name_space, method->klass->name, method->name);
722 MonoMethodHeader *header = ((MonoMethodNormal *)method)->header;
725 gulong code_size_ratio;
727 ji = mono_mempool_alloc0 (target_domain->mp, sizeof (MonoJitInfo));
729 cfg = mono_cfg_new (method, mp);
731 mono_analyze_flow (cfg);
735 mono_analyze_stack (cfg);
739 cfg->rs = mono_regset_new (X86_NREG);
740 mono_regset_reserve_reg (cfg->rs, X86_ESP);
741 mono_regset_reserve_reg (cfg->rs, X86_EBP);
743 cfg->code_size = MAX (header->code_size * 5, 256);
744 cfg->start = cfg->code = g_malloc (cfg->code_size);
746 mono_debug_last_breakpoint_address = cfg->code;
748 if (match_debug_method (method) || mono_debug_insert_breakpoint)
749 x86_breakpoint (cfg->code);
750 else if (mono_debug_handle)
753 if (mono_debug_insert_breakpoint > 0)
754 mono_debug_insert_breakpoint--;
756 if (mono_jit_dump_forest) {
758 printf ("FOREST %s.%s:%s\n", method->klass->name_space,
759 method->klass->name, method->name);
760 for (i = 0; i < cfg->block_count; i++) {
761 printf ("BLOCK %d:\n", i);
762 mono_print_forest (cfg->bblocks [i].forest);
766 mono_label_cfg (cfg);
770 arch_allocate_regs (cfg);
772 /* align to 8 byte boundary */
773 cfg->locals_size += 7;
774 cfg->locals_size &= ~7;
776 arch_emit_prologue (cfg);
777 cfg->prologue_end = cfg->code - cfg->start;
779 cfg->epilogue_begin = cfg->code - cfg->start;
780 arch_emit_epilogue (cfg);
784 mono_jit_stats.allocated_code_size += cfg->code_size;
786 code_size_ratio = cfg->code - cfg->start;
787 if (code_size_ratio > mono_jit_stats.biggest_method_size) {
788 mono_jit_stats.biggest_method_size = code_size_ratio;
789 mono_jit_stats.biggest_method = method;
791 code_size_ratio = (code_size_ratio * 100) / header->code_size;
792 if (code_size_ratio > mono_jit_stats.max_code_size_ratio) {
793 mono_jit_stats.max_code_size_ratio = code_size_ratio;
794 mono_jit_stats.max_ratio_method = method;
797 mono_compute_branches (cfg);
799 if (mono_jit_dump_asm) {
800 char *id = g_strdup_printf ("%s.%s_%s", method->klass->name_space,
801 method->klass->name, method->name);
802 mono_disassemble_code (cfg->start, cfg->code - cfg->start, id);
805 if (mono_debug_handle)
806 mono_debug_add_method (mono_debug_handle, cfg);
808 ji->code_size = cfg->code - cfg->start;
809 ji->used_regs = cfg->rs->used_mask;
811 ji->code_start = addr;
813 mono_jit_stats.native_code_size += ji->code_size;
815 if (header->num_clauses) {
816 int i, start_block, end_block;
818 ji->num_clauses = header->num_clauses;
819 ji->clauses = mono_mempool_alloc0 (target_domain->mp,
820 sizeof (MonoJitExceptionInfo) * header->num_clauses);
822 for (i = 0; i < header->num_clauses; i++) {
823 MonoExceptionClause *ec = &header->clauses [i];
824 MonoJitExceptionInfo *ei = &ji->clauses [i];
826 ei->flags = ec->flags;
827 ei->token_or_filter = ec->token_or_filter;
829 g_assert (cfg->bcinfo [ec->try_offset].is_block_start);
830 start_block = cfg->bcinfo [ec->try_offset].block_id;
831 end_block = cfg->bcinfo [ec->try_offset + ec->try_len].block_id;
832 g_assert (cfg->bcinfo [ec->try_offset + ec->try_len].is_block_start);
834 ei->try_start = cfg->start + cfg->bblocks [start_block].addr;
835 ei->try_end = cfg->start + cfg->bblocks [end_block].addr;
837 g_assert (cfg->bcinfo [ec->handler_offset].is_block_start);
838 start_block = cfg->bcinfo [ec->handler_offset].block_id;
839 ei->handler_start = cfg->start + cfg->bblocks [start_block].addr;
841 //printf ("TEST %x %x %x\n", ei->try_start, ei->try_end, ei->handler_start);
845 mono_jit_info_table_add (target_domain, ji);
847 mono_regset_free (cfg->rs);
851 mono_mempool_destroy (mp);
855 if (mono_jit_trace_calls || mono_jit_dump_asm || mono_jit_dump_forest) {
856 printf ("END JIT compilation of %s.%s:%s %p %p\n", method->klass->name_space,
857 method->klass->name, method->name, method, addr);
860 g_hash_table_insert (jit_code_hash, method, addr);