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_immediate(mips_emit_env_t *env, const ir_node *node)
234 const mips_attr_t *attr;
236 attr = get_mips_attr(node);
237 be_emit_tarval(env->emit, attr->tv);
241 * Add a number to a prefix. This number will not be used a second time.
244 char *get_unique_label(char *buf, size_t buflen, const char *prefix)
246 static unsigned long id = 0;
247 snprintf(buf, buflen, "%s%lu", prefix, ++id);
251 /************************************************************************/
253 /************************************************************************/
256 void mips_emit_IncSP(mips_emit_env_t *env, const ir_node *node)
258 int offset = be_get_IncSP_offset(node);
261 be_emit_cstring(env->emit, "\t/* omitted IncSP with 0 */");
262 be_emit_finish_line_gas(env->emit, node);
266 if(offset > 0xffff || offset < -0xffff) {
267 panic("stackframe > 2^16 bytes not supported yet\n");
271 be_emit_irprintf(env->emit, "\tsubu $sp, $sp, %d", offset);
273 be_emit_irprintf(env->emit, "\taddu $sp, $sp, %d", -offset);
275 be_emit_finish_line_gas(env->emit, node);
278 static void mips_emit_Copy(mips_emit_env_t *env, const ir_node *node)
280 be_emit_cstring(env->emit, "\tmove ");
281 mips_emit_dest_register(env, node, 0);
282 be_emit_cstring(env->emit, ", ");
283 mips_emit_source_register(env, node, 0);
284 be_emit_finish_line_gas(env->emit, node);
287 static void mips_emit_Return(mips_emit_env_t *env, const ir_node* node)
289 be_emit_cstring(env->emit, "\tj $ra");
290 be_emit_finish_line_gas(env->emit, node);
293 static __attribute__((unused))
294 void mips_emit_nops(mips_emit_env_t *env, int n)
298 for(i = 0; i < n; ++i) {
299 be_emit_cstring(env->emit, "\tnop\n");
300 be_emit_write_line(env->emit);
304 static void mips_emit_Perm(mips_emit_env_t *env, const ir_node *node)
306 assert(get_irn_arity(node) == 2);
308 be_emit_cstring(env->emit, "\txor ");
309 mips_emit_source_register(env, node, 0);
310 be_emit_cstring(env->emit, ", ");
311 mips_emit_source_register(env, node, 0);
312 be_emit_cstring(env->emit, ", ");
313 mips_emit_source_register(env, node, 1);
314 be_emit_finish_line_gas(env->emit, node);
316 /* mips_emit_nops(env, 3); */
318 be_emit_cstring(env->emit, "\txor ");
319 mips_emit_source_register(env, node, 1);
320 be_emit_cstring(env->emit, ", ");
321 mips_emit_source_register(env, node, 1);
322 be_emit_cstring(env->emit, ", ");
323 mips_emit_source_register(env, node, 0);
324 be_emit_finish_line_gas(env->emit, node);
326 /* mips_emit_nops(env, 3); */
328 be_emit_cstring(env->emit, "\txor ");
329 mips_emit_source_register(env, node, 0);
330 be_emit_cstring(env->emit, ", ");
331 mips_emit_source_register(env, node, 0);
332 be_emit_cstring(env->emit, ", ");
333 mips_emit_source_register(env, node, 1);
334 be_emit_finish_line_gas(env->emit, node);
336 /* mips_emit_nops(env, 3); */
339 /************************************************************************/
341 /************************************************************************/
343 static void mips_emit_Call(mips_emit_env_t *env, const ir_node *node)
347 be_emit_cstring(env->emit, "\tjal ");
349 /* call of immediate value (label) */
350 callee = be_Call_get_entity(node);
352 be_emit_ident(env->emit, get_entity_ld_ident(callee));
354 mips_emit_source_register(env, node, be_pos_Call_ptr);
356 be_emit_finish_line_gas(env->emit, node);
359 /************************************************************************
361 * | |_ _ _ __ ___ _ __ ___
362 * _ | | | | | '_ ` _ \| '_ \/ __|
363 * | |_| | |_| | | | | | | |_) \__ \
364 * \___/ \__,_|_| |_| |_| .__/|___/
366 ************************************************************************/
368 const char* mips_get_block_label(const ir_node* block)
371 snprintf(buf, sizeof(buf), "BLOCK_%ld", get_irn_node_nr(block));
377 * Emits a block label from the given block.
380 void mips_emit_block_label(mips_emit_env_t *env, const ir_node *block)
382 be_emit_irprintf(env->emit, "BLOCK_%ld", get_irn_node_nr(block));
385 static void mips_emit_Jump(mips_emit_env_t *env, const ir_node *node)
387 const ir_node *block = get_irn_link(node);
388 assert(is_Block(block));
390 be_emit_cstring(env->emit, "\tb ");
391 mips_emit_block_label(env, block);
392 be_emit_finish_line_gas(env->emit, node);
395 ir_node *mips_get_jump_block(const ir_node* node, int projn)
397 const ir_edge_t *oute;
398 for(oute = get_irn_out_edge_first(node); oute != NULL;
399 oute = get_irn_out_edge_next(node, oute)) {
400 ir_node *proj = get_edge_src_irn(oute);
402 assert(is_Proj(proj));
404 n = get_Proj_proj(proj);
406 return get_irn_link(proj);
412 void mips_emit_jump_target_proj(mips_emit_env_t *env, const ir_node *node, int projn)
414 ir_node *jumpblock = mips_get_jump_block(node, projn);
415 assert(jumpblock != NULL);
417 mips_emit_block_label(env, jumpblock);
420 void mips_emit_jump_target(mips_emit_env_t *env, const ir_node *node)
422 ir_node *jumpblock = get_irn_link(node);
423 assert(jumpblock != NULL);
425 mips_emit_block_label(env, jumpblock);
428 /************************************************************************
430 * / ___|_ _(_) |_ ___| |__ | |_ _ _ __ ___ _ __ *
431 * \___ \ \ /\ / / | __/ __| '_ \ _ | | | | | '_ ` _ \| '_ \ *
432 * ___) \ V V /| | || (__| | | | |_| | |_| | | | | | | |_) | *
433 * |____/ \_/\_/ |_|\__\___|_| |_|\___/ \__,_|_| |_| |_| .__/ *
436 ************************************************************************/
438 /* jump table entry (target and corresponding number) */
439 typedef struct _branch_t {
444 /* jump table for switch generation */
445 typedef struct _jmp_tbl_t {
446 ir_node *defBlock; /**< default target */
447 int min_value; /**< smallest switch case */
448 int max_value; /**< largest switch case */
449 int num_branches; /**< number of jumps */
450 char *label; /**< label of the jump table */
451 branch_t *branches; /**< jump array */
455 * Compare two variables of type branch_t. Used to sort all switch cases
457 static int mips_cmp_branch_t(const void *a, const void *b) {
458 branch_t *b1 = (branch_t *)a;
459 branch_t *b2 = (branch_t *)b;
461 if (b1->value <= b2->value)
467 const char* mips_get_jumptbl_label(const ir_node* switchjmp)
470 snprintf(buf, sizeof(buf), "__JUMPTBL%ld", get_irn_node_nr(switchjmp));
476 * Emits code for a SwitchJmp (creates a jump table if
477 * possible otherwise a cmp-jmp cascade). Stolen from ia32
479 void emit_mips_jump_table(mips_emit_env_t *env, const ir_node *irn) {
480 int lastval, i, i2, pn;
483 const ir_edge_t *edge;
484 mips_attr_t *attr = get_mips_attr(irn);
486 /* fill the table structure */
487 tbl.label = xmalloc(SNPRINTF_BUF_LEN);
488 tbl.label = get_unique_label(tbl.label, SNPRINTF_BUF_LEN, "JMPTBL_");
490 tbl.num_branches = get_irn_n_edges(irn);
491 tbl.branches = xcalloc(tbl.num_branches, sizeof(tbl.branches[0]));
492 tbl.min_value = INT_MAX;
493 tbl.max_value = INT_MIN;
496 /* go over all proj's and collect them */
497 foreach_out_edge(irn, edge) {
498 proj = get_edge_src_irn(edge);
499 assert(is_Proj(proj) && "Only proj allowed at SwitchJmp");
501 pn = get_Proj_proj(proj);
503 /* create branch entry */
504 tbl.branches[i].target = get_irn_link(proj);
505 tbl.branches[i].value = pn;
507 tbl.min_value = pn < tbl.min_value ? pn : tbl.min_value;
508 tbl.max_value = pn > tbl.max_value ? pn : tbl.max_value;
513 /* sort the branches by their number */
514 qsort(tbl.branches, tbl.num_branches, sizeof(tbl.branches[0]), mips_cmp_branch_t);
516 be_emit_string(env->emit, mips_get_jumptbl_label(irn));
517 be_emit_cstring(env->emit, ":\n");
518 be_emit_write_line(env->emit);
519 lastval = tbl.min_value;
520 for(i = 0; i < tbl.num_branches; ++i) {
521 const branch_t *branch = &tbl.branches[i];
522 int value = branch->value;
524 for(i2 = lastval + 1; i2 < value; ++i2) {
525 be_emit_cstring(env->emit, "\t.word ");
526 be_emit_ident(env->emit, attr->symconst_id);
527 be_emit_char(env->emit, '\n');
528 be_emit_write_line(env->emit);
531 be_emit_cstring(env->emit, "\t.word ");
532 mips_emit_block_label(env, branch->target);
533 be_emit_char(env->emit, '\n');
534 be_emit_write_line(env->emit);
536 lastval = branch->value;
546 void dump_jump_tables(ir_node* node, void *data)
548 mips_emit_env_t *env = data;
551 if(is_mips_SwitchJump(node)) {
552 be_emit_cstring(env->emit, ".data\n");
553 be_emit_write_line(env->emit);
555 emit_mips_jump_table(env, node);
557 be_emit_cstring(env->emit, ".text\n");
558 be_emit_write_line(env->emit);
562 /***********************************************************************************
565 * _ __ ___ __ _ _ _ __ | |_ _ __ __ _ _ __ ___ _____ _____ _ __| | __
566 * | '_ ` _ \ / _` | | '_ \ | _| '__/ _` | '_ ` _ \ / _ \ \ /\ / / _ \| '__| |/ /
567 * | | | | | | (_| | | | | | | | | | | (_| | | | | | | __/\ V V / (_) | | | <
568 * |_| |_| |_|\__,_|_|_| |_| |_| |_| \__,_|_| |_| |_|\___| \_/\_/ \___/|_| |_|\_\
570 ***********************************************************************************/
572 static void mips_emit_nothing(mips_emit_env_t *env, const ir_node *node)
578 static void mips_emit_this_shouldnt_happen(mips_emit_env_t *env, const ir_node *node)
581 panic("Found non-lowered node %+F while emitting", node);
585 * The type of a emitter function.
587 typedef void (*emit_func) (mips_emit_env_t *, const ir_node *);
590 * Set a node emitter. Make it a bit more type safe.
592 static void register_emitter(ir_op *op, emit_func func) {
593 op->ops.generic = (op_func) func;
597 * Register emitter functions for mips backend
599 void mips_register_emitters(void) {
600 /* first clear the generic function pointer for all ops */
601 clear_irp_opcodes_generic_func();
603 /* register all emitter functions defined in spec */
604 mips_register_spec_emitters();
607 register_emitter(op_be_IncSP, mips_emit_IncSP);
608 register_emitter(op_be_SetSP, mips_emit_this_shouldnt_happen);
609 register_emitter(op_be_AddSP, mips_emit_this_shouldnt_happen);
610 register_emitter(op_be_Call, mips_emit_Call);
611 register_emitter(op_be_Copy, mips_emit_Copy);
612 register_emitter(op_be_Keep, mips_emit_nothing);
613 register_emitter(op_be_Barrier, mips_emit_nothing);
614 register_emitter(op_be_Return, mips_emit_Return);
615 register_emitter(op_be_RegParams, mips_emit_nothing);
616 register_emitter(op_be_Spill, mips_emit_this_shouldnt_happen);
617 register_emitter(op_be_Reload, mips_emit_this_shouldnt_happen);
618 register_emitter(op_be_Perm, mips_emit_Perm);
620 register_emitter(op_Start, mips_emit_nothing);
621 register_emitter(op_Proj, mips_emit_nothing);
622 register_emitter(op_SymConst, mips_emit_this_shouldnt_happen);
623 register_emitter(op_Const, mips_emit_this_shouldnt_happen);
624 register_emitter(op_Jmp, mips_emit_Jump);
625 register_emitter(op_Cmp, mips_emit_this_shouldnt_happen);
626 register_emitter(op_Cond, mips_emit_this_shouldnt_happen);
630 * Emits assembly for a single node
632 static void mips_emit_node(mips_emit_env_t *env, const ir_node *node)
634 ir_op *op = get_irn_op(node);
636 if (op->ops.generic) {
637 emit_func emit = (emit_func) op->ops.generic;
640 panic("No emitter defined for node %+F", node);
645 * Walks over the nodes in a block connected by scheduling edges
646 * and emits code for each node.
648 void mips_gen_block(mips_emit_env_t *env, ir_node *block)
652 if (! is_Block(block))
655 mips_emit_block_label(env, block);
656 be_emit_cstring(env->emit, ":\n");
657 be_emit_write_line(env->emit);
659 sched_foreach(block, node) {
660 mips_emit_node(env, node);
663 be_emit_char(env->emit, '\n');
664 be_emit_write_line(env->emit);
668 * Emits code for function start.
670 void mips_emit_func_prolog(mips_emit_env_t *env, ir_graph *irg)
672 ident *irg_ident = get_entity_ld_ident(get_irg_entity(irg));
673 be_emit_env_t *eenv = env->emit;
676 irg_walk_graph(irg, NULL, dump_jump_tables, env);
678 be_emit_write_line(eenv);
679 be_gas_emit_switch_section(eenv, GAS_SECTION_TEXT);
681 be_emit_cstring(eenv, "\t.balign\t4\n");
683 be_emit_cstring(eenv, "\t.global\t");
684 be_emit_ident(eenv, irg_ident);
685 be_emit_char(eenv, '\n');
687 be_emit_cstring(eenv, "\t.set\tnomips16\n");
689 be_emit_cstring(eenv, "\t.ent\t");
690 be_emit_ident(eenv, irg_ident);
691 be_emit_char(eenv, '\n');
693 be_emit_ident(eenv, irg_ident);
694 be_emit_cstring(eenv, ":\n");
696 be_emit_cstring(eenv, "\t.frame\t$fp, 24, $ra\n");
697 be_emit_cstring(eenv, "\t.mask\t0xc0000000, -4\n");
698 be_emit_cstring(eenv, "\t.fmask\t0x00000000, 0\n");
700 be_emit_write_line(eenv);
704 * Emits code for function end
706 void mips_emit_func_epilog(mips_emit_env_t *env, ir_graph *irg)
708 ident *irg_ident = get_entity_ident(get_irg_entity(irg));
710 be_emit_cstring(env->emit, "\t.end\t");
711 be_emit_ident(env->emit, irg_ident);
712 be_emit_char(env->emit, '\n');
713 be_emit_write_line(env->emit);
717 * Sets labels for control flow nodes (jump target)
719 void mips_gen_labels(ir_node *block, void *env)
722 int n = get_Block_n_cfgpreds(block);
724 for (n--; n >= 0; n--) {
725 pred = get_Block_cfgpred(block, n);
726 set_irn_link(pred, block);
733 void mips_gen_routine(mips_code_gen_t *cg, ir_graph *irg)
738 env.isa = (mips_isa_t*) cg->arch_env->isa;
739 env.emit = &env.isa->emit;
740 env.arch_env = cg->arch_env;
743 mips_register_emitters();
745 irg_block_walk_graph(irg, mips_gen_labels, NULL, &env);
747 mips_emit_func_prolog(&env, irg);
749 dump_ir_block_graph_sched(irg, "-kaputtelist");
751 for (i = 0, n = mips_get_sched_n_blocks(cg); i < n; ++i) {
752 ir_node *block = mips_get_sched_block(cg, i);
753 mips_gen_block(&env, block);
756 mips_emit_func_epilog(&env, irg);
759 void mips_init_emitter(void)
761 FIRM_DBG_REGISTER(dbg, "firm.be.mips.emitter");