2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief implementation of mips assembly emitter
23 * @author Matthias Braun, Mehdi
44 #include "../besched.h"
45 #include "../benode_t.h"
46 #include "../beutil.h"
47 #include "../begnuas.h"
49 #include "mips_emitter.h"
50 #include "gen_mips_emitter.h"
51 #include "mips_nodes_attr.h"
52 #include "mips_new_nodes.h"
53 #include "mips_map_regs.h"
55 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57 #define SNPRINTF_BUF_LEN 128
60 * Returns the register at in position pos.
62 static const arch_register_t *get_in_reg(const arch_env_t *arch_env,
63 const ir_node *node, int pos)
66 const arch_register_t *reg = NULL;
68 assert(get_irn_arity(node) > pos && "Invalid IN position");
70 /* The out register of the operator at position pos is the
71 in register we need. */
72 op = get_irn_n(node, pos);
74 reg = arch_get_irn_register(arch_env, op);
76 assert(reg && "no in register found");
81 * Returns the register at out position pos.
83 static const arch_register_t *get_out_reg(const arch_env_t *arch_env,
84 const ir_node *node, int pos)
87 const arch_register_t *reg = NULL;
89 /* 1st case: irn is not of mode_T, so it has only */
90 /* one OUT register -> good */
91 /* 2nd case: irn is of mode_T -> collect all Projs and ask the */
92 /* Proj with the corresponding projnum for the register */
94 if (get_irn_mode(node) != mode_T) {
95 reg = arch_get_irn_register(arch_env, node);
96 } else if (is_mips_irn(node)) {
97 reg = get_mips_out_reg(node, pos);
99 const ir_edge_t *edge;
101 foreach_out_edge(node, edge) {
102 proj = get_edge_src_irn(edge);
103 assert(is_Proj(proj) && "non-Proj from mode_T node");
104 if (get_Proj_proj(proj) == pos) {
105 reg = arch_get_irn_register(arch_env, proj);
111 assert(reg && "no out register found");
115 /*************************************************************
117 * (_) | | / _| | | | |
118 * _ __ _ __ _ _ __ | |_| |_ | |__ ___| |_ __ ___ _ __
119 * | '_ \| '__| | '_ \| __| _| | '_ \ / _ \ | '_ \ / _ \ '__|
120 * | |_) | | | | | | | |_| | | | | | __/ | |_) | __/ |
121 * | .__/|_| |_|_| |_|\__|_| |_| |_|\___|_| .__/ \___|_|
124 *************************************************************/
127 * Emit the name of the source register at given input position.
129 void mips_emit_source_register(mips_emit_env_t *env, const ir_node *node,
132 const arch_register_t *reg = get_in_reg(env->arch_env, node, pos);
133 be_emit_char(env->emit, '$');
134 be_emit_string(env->emit, arch_register_get_name(reg));
138 * Emit the name of the destination register at given output position.
140 void mips_emit_dest_register(mips_emit_env_t *env, const ir_node *node,
143 const arch_register_t *reg = get_out_reg(env->arch_env, node, pos);
144 be_emit_char(env->emit, '$');
145 be_emit_string(env->emit, arch_register_get_name(reg));
149 static const char *get_symconst_str(ir_node *node)
153 switch(get_SymConst_kind(node)) {
154 case symconst_addr_name:
155 id = get_SymConst_name(node);
156 return get_id_str(id);
157 case symconst_addr_ent:
158 id = get_entity_ident(get_SymConst_entity(node));
159 return get_id_str(id);
168 * Return a const or symconst as string.
170 static const char *node_const_to_str(ir_node *n)
173 const mips_attr_t *attr = get_mips_attr(n);
176 if(is_mips_load_r(n) || is_mips_store_r(n)) {
177 mips_attr_t *attr = get_mips_attr(n);
180 if(attr->tv != NULL) {
181 val = get_tarval_long(attr->tv);
182 snprintf(buf, sizeof(buf), "%ld", val);
186 if(attr->stack_entity != NULL) {
187 snprintf(buf, sizeof(buf), "%d", attr->stack_entity_offset);
191 symconst = get_irn_n(n, 1);
192 assert(get_irn_opcode(symconst) == iro_SymConst);
194 return get_symconst_str(symconst);
195 } else if(is_mips_la(n)) {
196 snprintf(buf, sizeof(buf), "%s", get_id_str(attr->symconst_id));
198 } else if(is_mips_lli(n)) {
199 assert(attr->tv != NULL);
200 if(get_mode_sign(get_tarval_mode(attr->tv))) {
201 long val = get_tarval_long(attr->tv);
202 snprintf(buf, sizeof(buf), "0x%04lX", val & 0xffff);
204 unsigned long val = get_tarval_long(attr->tv);
205 snprintf(buf, sizeof(buf), "0x%04lX", val & 0xffff);
209 } else if(is_mips_lui(n)) {
210 assert(attr->tv != NULL);
211 if(get_mode_sign(get_tarval_mode(attr->tv))) {
212 long val = get_tarval_long(attr->tv);
213 val = (val & 0xffff0000) >> 16;
214 snprintf(buf, sizeof(buf), "0x%04lX", val & 0xffff);
216 unsigned long val = get_tarval_long(attr->tv);
217 val = (val & 0xffff0000) >> 16;
218 snprintf(buf, sizeof(buf), "0x%04lX", val & 0xffff);
224 assert(attr->tv != NULL);
225 val = get_tarval_long(attr->tv);
226 snprintf(buf, sizeof(buf), "%ld", val);
232 void mips_emit_load_store_address(mips_emit_env_t *env, const ir_node *node,
235 const mips_load_store_attr_t *attr = get_mips_load_store_attr_const(node);
237 be_emit_irprintf(env->emit, "%d(", attr->offset);
238 mips_emit_source_register(env, node, pos);
239 be_emit_char(env->emit, ')');
242 void mips_emit_immediate_suffix(mips_emit_env_t *env, const ir_node *node,
245 ir_node *op = get_irn_n(node, pos);
246 if(is_mips_Immediate(op))
247 be_emit_char(env->emit, 'i');
250 void mips_emit_immediate(mips_emit_env_t *env, const ir_node *node)
252 const mips_immediate_attr_t *attr = get_mips_immediate_attr_const(node);
254 switch(attr->imm_type) {
256 be_emit_irprintf(env->emit, "%d", attr->val);
258 case MIPS_IMM_SYMCONST_LO:
259 be_emit_cstring(env->emit, "%lo($");
260 be_emit_ident(env->emit, get_entity_ld_ident(attr->entity));
262 be_emit_irprintf(env->emit, "%+d", attr->val);
264 be_emit_char(env->emit, ')');
266 case MIPS_IMM_SYMCONST_HI:
267 be_emit_cstring(env->emit, "%hi($");
268 be_emit_ident(env->emit, get_entity_ld_ident(attr->entity));
270 be_emit_irprintf(env->emit, "%+d", attr->val);
272 be_emit_char(env->emit, ')');
275 panic("invalid immediate type found");
280 * Emit the name of the destination register at given output position.
282 void mips_emit_source_register_or_immediate(mips_emit_env_t *env,
283 const ir_node *node, int pos)
285 const ir_node *op = get_irn_n(node, pos);
286 if(is_mips_Immediate(op)) {
287 mips_emit_immediate(env, op);
289 mips_emit_source_register(env, node, pos);
295 * Add a number to a prefix. This number will not be used a second time.
297 static char *get_unique_label(char *buf, size_t buflen, const char *prefix)
299 static unsigned long id = 0;
300 snprintf(buf, buflen, "%s%lu", prefix, ++id);
305 /************************************************************************/
307 /************************************************************************/
310 void mips_emit_IncSP(mips_emit_env_t *env, const ir_node *node)
312 int offset = be_get_IncSP_offset(node);
315 be_emit_cstring(env->emit, "\t/* omitted IncSP with 0 */");
316 be_emit_finish_line_gas(env->emit, node);
320 if(offset > 0xffff || offset < -0xffff) {
321 panic("stackframe > 2^16 bytes not supported yet\n");
325 be_emit_irprintf(env->emit, "\tsubu $sp, $sp, %d", offset);
327 be_emit_irprintf(env->emit, "\taddu $sp, $sp, %d", -offset);
329 be_emit_finish_line_gas(env->emit, node);
332 static void mips_emit_Copy(mips_emit_env_t *env, const ir_node *node)
334 be_emit_cstring(env->emit, "\tmove ");
335 mips_emit_dest_register(env, node, 0);
336 be_emit_cstring(env->emit, ", ");
337 mips_emit_source_register(env, node, 0);
338 be_emit_finish_line_gas(env->emit, node);
341 static void mips_emit_Return(mips_emit_env_t *env, const ir_node* node)
343 be_emit_cstring(env->emit, "\tj $ra");
344 be_emit_finish_line_gas(env->emit, node);
347 static __attribute__((unused))
348 void mips_emit_nops(mips_emit_env_t *env, int n)
352 for(i = 0; i < n; ++i) {
353 be_emit_cstring(env->emit, "\tnop\n");
354 be_emit_write_line(env->emit);
358 static void mips_emit_Perm(mips_emit_env_t *env, const ir_node *node)
360 assert(get_irn_arity(node) == 2);
362 be_emit_cstring(env->emit, "\txor ");
363 mips_emit_source_register(env, node, 0);
364 be_emit_cstring(env->emit, ", ");
365 mips_emit_source_register(env, node, 0);
366 be_emit_cstring(env->emit, ", ");
367 mips_emit_source_register(env, node, 1);
368 be_emit_finish_line_gas(env->emit, node);
370 /* mips_emit_nops(env, 3); */
372 be_emit_cstring(env->emit, "\txor ");
373 mips_emit_source_register(env, node, 1);
374 be_emit_cstring(env->emit, ", ");
375 mips_emit_source_register(env, node, 1);
376 be_emit_cstring(env->emit, ", ");
377 mips_emit_source_register(env, node, 0);
378 be_emit_finish_line_gas(env->emit, node);
380 /* mips_emit_nops(env, 3); */
382 be_emit_cstring(env->emit, "\txor ");
383 mips_emit_source_register(env, node, 0);
384 be_emit_cstring(env->emit, ", ");
385 mips_emit_source_register(env, node, 0);
386 be_emit_cstring(env->emit, ", ");
387 mips_emit_source_register(env, node, 1);
388 be_emit_finish_line_gas(env->emit, node);
390 /* mips_emit_nops(env, 3); */
393 /************************************************************************/
395 /************************************************************************/
397 static void mips_emit_Call(mips_emit_env_t *env, const ir_node *node)
401 be_emit_cstring(env->emit, "\tjal ");
403 /* call of immediate value (label) */
404 callee = be_Call_get_entity(node);
406 be_emit_ident(env->emit, get_entity_ld_ident(callee));
408 mips_emit_source_register(env, node, be_pos_Call_ptr);
410 be_emit_finish_line_gas(env->emit, node);
413 /************************************************************************
415 * | |_ _ _ __ ___ _ __ ___
416 * _ | | | | | '_ ` _ \| '_ \/ __|
417 * | |_| | |_| | | | | | | |_) \__ \
418 * \___/ \__,_|_| |_| |_| .__/|___/
420 ************************************************************************/
422 const char* mips_get_block_label(const ir_node* block)
425 snprintf(buf, sizeof(buf), "BLOCK_%ld", get_irn_node_nr(block));
431 * Emits a block label from the given block.
434 void mips_emit_block_label(mips_emit_env_t *env, const ir_node *block)
436 be_emit_irprintf(env->emit, "BLOCK_%d", get_irn_node_nr(block));
439 static void mips_emit_Jump(mips_emit_env_t *env, const ir_node *node)
441 const ir_node *block = get_irn_link(node);
442 assert(is_Block(block));
444 be_emit_cstring(env->emit, "\tb ");
445 mips_emit_block_label(env, block);
446 be_emit_finish_line_gas(env->emit, node);
449 ir_node *mips_get_jump_block(const ir_node* node, long projn)
451 const ir_edge_t *oute;
452 for(oute = get_irn_out_edge_first(node); oute != NULL;
453 oute = get_irn_out_edge_next(node, oute)) {
454 ir_node *proj = get_edge_src_irn(oute);
456 assert(is_Proj(proj));
458 n = get_Proj_proj(proj);
460 return get_irn_link(proj);
466 void mips_emit_jump_target_proj(mips_emit_env_t *env, const ir_node *node,
469 ir_node *jumpblock = mips_get_jump_block(node, projn);
470 assert(jumpblock != NULL);
472 mips_emit_block_label(env, jumpblock);
475 void mips_emit_jump_target(mips_emit_env_t *env, const ir_node *node)
477 ir_node *jumpblock = get_irn_link(node);
478 assert(jumpblock != NULL);
480 mips_emit_block_label(env, jumpblock);
483 void mips_emit_jump_or_fallthrough(mips_emit_env_t *env, const ir_node *node,
486 ir_node *jumpblock = mips_get_jump_block(node, pn);
487 assert(jumpblock != NULL);
489 /* TODO: use fallthrough when possible */
490 be_emit_cstring(env->emit, "b ");
491 mips_emit_block_label(env, jumpblock);
494 /************************************************************************
496 * / ___|_ _(_) |_ ___| |__ | |_ _ _ __ ___ _ __ *
497 * \___ \ \ /\ / / | __/ __| '_ \ _ | | | | | '_ ` _ \| '_ \ *
498 * ___) \ V V /| | || (__| | | | |_| | |_| | | | | | | |_) | *
499 * |____/ \_/\_/ |_|\__\___|_| |_|\___/ \__,_|_| |_| |_| .__/ *
502 ************************************************************************/
505 /* jump table entry (target and corresponding number) */
506 typedef struct _branch_t {
511 /* jump table for switch generation */
512 typedef struct _jmp_tbl_t {
513 ir_node *defBlock; /**< default target */
514 int min_value; /**< smallest switch case */
515 int max_value; /**< largest switch case */
516 int num_branches; /**< number of jumps */
517 char *label; /**< label of the jump table */
518 branch_t *branches; /**< jump array */
522 * Compare two variables of type branch_t. Used to sort all switch cases
524 static int mips_cmp_branch_t(const void *a, const void *b)
526 branch_t *b1 = (branch_t *)a;
527 branch_t *b2 = (branch_t *)b;
529 if (b1->value <= b2->value)
535 const char* mips_get_jumptbl_label(const ir_node* switchjmp)
538 snprintf(buf, sizeof(buf), "__JUMPTBL%ld", get_irn_node_nr(switchjmp));
544 * Emits code for a SwitchJmp (creates a jump table if
545 * possible otherwise a cmp-jmp cascade). Stolen from ia32
547 void emit_mips_jump_table(mips_emit_env_t *env, const ir_node *irn) {
548 int lastval, i, i2, pn;
551 const ir_edge_t *edge;
552 const mips_attr_t *attr = get_mips_attr_const(irn);
554 /* fill the table structure */
555 tbl.label = xmalloc(SNPRINTF_BUF_LEN);
556 tbl.label = get_unique_label(tbl.label, SNPRINTF_BUF_LEN, "JMPTBL_");
558 tbl.num_branches = get_irn_n_edges(irn);
559 tbl.branches = xcalloc(tbl.num_branches, sizeof(tbl.branches[0]));
560 tbl.min_value = INT_MAX;
561 tbl.max_value = INT_MIN;
564 /* go over all proj's and collect them */
565 foreach_out_edge(irn, edge) {
566 proj = get_edge_src_irn(edge);
567 assert(is_Proj(proj) && "Only proj allowed at SwitchJmp");
569 pn = get_Proj_proj(proj);
571 /* create branch entry */
572 tbl.branches[i].target = get_irn_link(proj);
573 tbl.branches[i].value = pn;
575 tbl.min_value = pn < tbl.min_value ? pn : tbl.min_value;
576 tbl.max_value = pn > tbl.max_value ? pn : tbl.max_value;
581 /* sort the branches by their number */
582 qsort(tbl.branches, tbl.num_branches, sizeof(tbl.branches[0]), mips_cmp_branch_t);
584 be_emit_string(env->emit, mips_get_jumptbl_label(irn));
585 be_emit_cstring(env->emit, ":\n");
586 be_emit_write_line(env->emit);
587 lastval = tbl.min_value;
588 for(i = 0; i < tbl.num_branches; ++i) {
589 const branch_t *branch = &tbl.branches[i];
590 int value = branch->value;
592 for(i2 = lastval + 1; i2 < value; ++i2) {
593 be_emit_cstring(env->emit, "\t.word ");
594 be_emit_ident(env->emit, get_entity_ld_ident(attr->symconst));
595 be_emit_char(env->emit, '\n');
596 be_emit_write_line(env->emit);
599 be_emit_cstring(env->emit, "\t.word ");
600 mips_emit_block_label(env, branch->target);
601 be_emit_char(env->emit, '\n');
602 be_emit_write_line(env->emit);
604 lastval = branch->value;
614 void dump_jump_tables(ir_node* node, void *data)
616 mips_emit_env_t *env = data;
619 if(is_mips_SwitchJump(node)) {
620 be_emit_cstring(env->emit, ".data\n");
621 be_emit_write_line(env->emit);
623 emit_mips_jump_table(env, node);
625 be_emit_cstring(env->emit, ".text\n");
626 be_emit_write_line(env->emit);
631 /***********************************************************************************
634 * _ __ ___ __ _ _ _ __ | |_ _ __ __ _ _ __ ___ _____ _____ _ __| | __
635 * | '_ ` _ \ / _` | | '_ \ | _| '__/ _` | '_ ` _ \ / _ \ \ /\ / / _ \| '__| |/ /
636 * | | | | | | (_| | | | | | | | | | | (_| | | | | | | __/\ V V / (_) | | | <
637 * |_| |_| |_|\__,_|_|_| |_| |_| |_| \__,_|_| |_| |_|\___| \_/\_/ \___/|_| |_|\_\
639 ***********************************************************************************/
641 static void mips_emit_nothing(mips_emit_env_t *env, const ir_node *node)
647 static void mips_emit_this_shouldnt_happen(mips_emit_env_t *env, const ir_node *node)
650 panic("Found non-lowered node %+F while emitting", node);
654 * The type of a emitter function.
656 typedef void (*emit_func) (mips_emit_env_t *, const ir_node *);
659 * Set a node emitter. Make it a bit more type safe.
661 static void register_emitter(ir_op *op, emit_func func) {
662 op->ops.generic = (op_func) func;
666 * Register emitter functions for mips backend
668 void mips_register_emitters(void) {
669 /* first clear the generic function pointer for all ops */
670 clear_irp_opcodes_generic_func();
672 /* register all emitter functions defined in spec */
673 mips_register_spec_emitters();
676 register_emitter(op_be_IncSP, mips_emit_IncSP);
677 register_emitter(op_be_SetSP, mips_emit_this_shouldnt_happen);
678 register_emitter(op_be_AddSP, mips_emit_this_shouldnt_happen);
679 register_emitter(op_be_Call, mips_emit_Call);
680 register_emitter(op_be_Copy, mips_emit_Copy);
681 register_emitter(op_be_Keep, mips_emit_nothing);
682 register_emitter(op_be_Barrier, mips_emit_nothing);
683 register_emitter(op_be_Return, mips_emit_Return);
684 register_emitter(op_be_RegParams, mips_emit_nothing);
685 register_emitter(op_be_Spill, mips_emit_this_shouldnt_happen);
686 register_emitter(op_be_Reload, mips_emit_this_shouldnt_happen);
687 register_emitter(op_be_Perm, mips_emit_Perm);
689 register_emitter(op_Start, mips_emit_nothing);
690 register_emitter(op_Proj, mips_emit_nothing);
691 register_emitter(op_SymConst, mips_emit_this_shouldnt_happen);
692 register_emitter(op_Const, mips_emit_this_shouldnt_happen);
693 register_emitter(op_Jmp, mips_emit_Jump);
694 register_emitter(op_Cmp, mips_emit_this_shouldnt_happen);
695 register_emitter(op_Cond, mips_emit_this_shouldnt_happen);
696 register_emitter(op_Phi, mips_emit_nothing);
700 * Emits assembly for a single node
702 static void mips_emit_node(mips_emit_env_t *env, const ir_node *node)
704 ir_op *op = get_irn_op(node);
706 if (op->ops.generic) {
707 emit_func emit = (emit_func) op->ops.generic;
710 panic("No emitter defined for node %+F", node);
715 * Walks over the nodes in a block connected by scheduling edges
716 * and emits code for each node.
718 void mips_gen_block(mips_emit_env_t *env, ir_node *block)
722 if (! is_Block(block))
725 mips_emit_block_label(env, block);
726 be_emit_cstring(env->emit, ":\n");
727 be_emit_write_line(env->emit);
729 sched_foreach(block, node) {
730 mips_emit_node(env, node);
733 be_emit_char(env->emit, '\n');
734 be_emit_write_line(env->emit);
738 * Emits code for function start.
740 void mips_emit_func_prolog(mips_emit_env_t *env, ir_graph *irg)
742 ident *irg_ident = get_entity_ld_ident(get_irg_entity(irg));
743 be_emit_env_t *eenv = env->emit;
746 //irg_walk_graph(irg, NULL, dump_jump_tables, env);
748 be_emit_write_line(eenv);
749 be_gas_emit_switch_section(eenv, GAS_SECTION_TEXT);
751 be_emit_cstring(eenv, "\t.balign\t4\n");
753 be_emit_cstring(eenv, "\t.global\t");
754 be_emit_ident(eenv, irg_ident);
755 be_emit_char(eenv, '\n');
757 be_emit_cstring(eenv, "\t.set\tnomips16\n");
759 be_emit_cstring(eenv, "\t.ent\t");
760 be_emit_ident(eenv, irg_ident);
761 be_emit_char(eenv, '\n');
763 be_emit_ident(eenv, irg_ident);
764 be_emit_cstring(eenv, ":\n");
766 be_emit_cstring(eenv, "\t.frame\t$fp, 24, $ra\n");
767 be_emit_cstring(eenv, "\t.mask\t0xc0000000, -4\n");
768 be_emit_cstring(eenv, "\t.fmask\t0x00000000, 0\n");
770 be_emit_write_line(eenv);
774 * Emits code for function end
776 void mips_emit_func_epilog(mips_emit_env_t *env, ir_graph *irg)
778 ident *irg_ident = get_entity_ident(get_irg_entity(irg));
780 be_emit_cstring(env->emit, "\t.end\t");
781 be_emit_ident(env->emit, irg_ident);
782 be_emit_char(env->emit, '\n');
783 be_emit_write_line(env->emit);
787 * Sets labels for control flow nodes (jump target)
789 void mips_gen_labels(ir_node *block, void *env)
792 int n = get_Block_n_cfgpreds(block);
795 for (n--; n >= 0; n--) {
796 pred = get_Block_cfgpred(block, n);
797 set_irn_link(pred, block);
804 void mips_gen_routine(mips_code_gen_t *cg, ir_graph *irg)
809 env.isa = (mips_isa_t*) cg->arch_env->isa;
810 env.emit = &env.isa->emit;
811 env.arch_env = cg->arch_env;
814 mips_register_emitters();
816 irg_block_walk_graph(irg, mips_gen_labels, NULL, &env);
818 mips_emit_func_prolog(&env, irg);
820 dump_ir_block_graph_sched(irg, "-kaputtelist");
822 for (i = 0, n = mips_get_sched_n_blocks(cg); i < n; ++i) {
823 ir_node *block = mips_get_sched_block(cg, i);
824 mips_gen_block(&env, block);
827 mips_emit_func_epilog(&env, irg);
830 void mips_init_emitter(void)
832 FIRM_DBG_REGISTER(dbg, "firm.be.mips.emitter");