4 * @author Sebastian Hack
6 * Backend node support.
8 * This file provdies Perm, Copy, Spill and Reload nodes.
10 * Copyright (C) 2005 Universitaet Karlsruhe
11 * Released under the GPL
35 #include "besched_t.h"
42 #define BENODE_MAGIC FOURCC('B', 'E', 'N', 'O')
44 typedef enum _node_kind_t {
54 const arch_register_class_t *cls;
61 const arch_register_t *reg;
62 arch_register_req_t req;
69 be_reg_data_t reg_data[1];
74 ir_node *spill_ctx; /**< The node in whose context this spill was introduced. */
75 unsigned offset; /**< The offset of the memory location the spill writes to
79 static int templ_pos_Spill[] = {
83 static int templ_pos_Reload[] = {
87 static int templ_pos_Copy[] = {
91 static int dump_node(ir_node *irn, FILE *f, dump_reason_t reason);
93 static const ir_op_ops be_node_ops = {
109 static INLINE int is_be_node(const ir_node *irn)
111 const be_node_attr_t *attr = (const be_node_attr_t *) &irn->attr;
112 return attr->magic == BENODE_MAGIC;
115 static INLINE int is_be_kind(const ir_node *irn, node_kind_t kind)
117 const be_node_attr_t *a = (const be_node_attr_t *) &irn->attr;
118 return a->magic == BENODE_MAGIC && a->op && a->op->kind == kind;
121 static INLINE void *get_attr_and_check(ir_node *irn, node_kind_t kind)
123 is_be_kind(irn, kind);
127 static be_node_attr_t *init_node_attr(ir_node *irn,
129 const arch_register_class_t *cls,
133 be_node_attr_t *attr = (be_node_attr_t *) &irn->attr;
136 attr->magic = BENODE_MAGIC;
137 attr->n_regs = n_regs;
140 for(i = 0; i < n_regs; ++i) {
141 be_reg_data_t *rd = attr->reg_data + i;
145 rd->req.type = arch_register_req_type_normal;
151 #define ARRSIZE(x) (sizeof(x) / sizeof(x[0]))
153 static int cmp_op_map(const void *a, const void *b, size_t size)
155 const be_op_t *x = a;
156 const be_op_t *y = b;
158 return !(x->kind == y->kind && x->cls == y->cls);
161 static be_op_t *get_op(const be_node_factory_t *fact,
162 const arch_register_class_t *cls, node_kind_t kind)
169 return set_insert(fact->ops, &templ, sizeof(templ),
170 HASH_PTR(cls) + 7 * kind);
173 ir_node *new_Spill(const be_node_factory_t *factory,
174 const arch_register_class_t *cls,
175 ir_graph *irg, ir_node *bl, ir_node *node_to_spill, ir_node *ctx)
180 be_op_t *bop = get_op(factory, cls, node_kind_spill);
183 assert(op && "Spill opcode must be present for this register class");
184 in[0] = node_to_spill;
185 irn = new_ir_node(NULL, irg, bl, op, mode_M, 1, in);
186 a = (be_spill_attr_t *) init_node_attr(irn, bop, cls, 0);
193 void set_Spill_offset(ir_node *irn, unsigned offset)
195 be_spill_attr_t *a = (be_spill_attr_t *) &irn->attr;
196 assert(is_be_kind(irn, node_kind_spill));
200 static ir_node *find_a_spill_walker(ir_node *irn, unsigned visited_nr)
202 if(get_irn_visited(irn) < visited_nr) {
203 set_irn_visited(irn, visited_nr);
207 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
208 ir_node *n = find_a_spill_walker(get_irn_n(irn, i), visited_nr);
214 else if(is_be_kind(irn, node_kind_spill))
222 * Finds a spill for a reload.
223 * If the reload is directly using the spill, this is simple,
224 * else we perform DFS from the reload (over all PhiMs) and return
225 * the first spill node we find.
227 static INLINE ir_node *find_a_spill(ir_node *irn)
229 ir_graph *irg = get_irn_irg(irn);
230 unsigned visited_nr = get_irg_visited(irg) + 1;
232 assert(is_be_kind(irn, node_kind_reload));
233 set_irg_visited(irg, visited_nr);
234 return find_a_spill_walker(irn, visited_nr);
237 unsigned get_irn_spill_offset(ir_node *irn)
239 be_node_attr_t *a = (be_node_attr_t *) &irn->attr;
240 assert(is_be_node(irn));
242 switch(a->op->kind) {
243 case node_kind_reload:
244 assert(0 && "not yet implemented");
245 return get_irn_spill_offset(find_a_spill(irn));
246 case node_kind_spill:
247 return ((be_spill_attr_t *) a)->offset;
249 assert(0 && "Illegal node kind (spill/reload required)");
255 ir_node *new_Reload(const be_node_factory_t *factory,
256 const arch_register_class_t *cls, ir_graph *irg,
257 ir_node *bl, ir_mode *mode, ir_node *spill_node)
259 ir_node *irn, *in[1];
260 be_op_t *bop = get_op(factory, cls, node_kind_reload);
263 assert(op && "Reload opcode must be present for this register class");
266 irn = new_ir_node(NULL, irg, bl, op, mode, 1, in);
267 init_node_attr(irn, bop, cls, 1);
272 ir_node *new_Perm(const be_node_factory_t *factory,
273 const arch_register_class_t *cls,
274 ir_graph *irg, ir_node *bl, int arity, ir_node **in)
277 be_op_t *bop = get_op(factory, cls, node_kind_perm);
280 irn = new_ir_node(NULL, irg, bl, op, mode_T, arity, in);
281 init_node_attr(irn, bop, cls, arity);
286 ir_node *new_Copy(const be_node_factory_t *factory,
287 const arch_register_class_t *cls,
288 ir_graph *irg, ir_node *bl, ir_node *in)
290 ir_node *irn, *ins[1];
291 be_op_t *bop = get_op(factory, cls, node_kind_copy);
296 irn = new_ir_node(NULL, irg, bl, op, get_irn_mode(in), 1, ins);
297 init_node_attr(irn, bop, cls, 1);
303 const be_node_factory_t *factory,
304 const arch_env_t *arch_env,
305 ir_node *irn, ir_node *ctx)
307 const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, irn, -1);
309 ir_node *bl = get_nodes_block(irn);
310 ir_graph *irg = get_irn_irg(bl);
311 ir_node *spill = new_Spill(factory, cls, irg, bl, irn, ctx);
315 * search the right insertion point. a spill of a phi cannot be put
316 * directly after the phi, if there are some phis behind the one which
319 insert = sched_next(irn);
320 while(is_Phi(insert) && !sched_is_end(insert))
321 insert = sched_next(insert);
323 sched_add_before(insert, spill);
327 ir_node *be_reload(const be_node_factory_t *factory,
328 const arch_env_t *arch_env,
329 const arch_register_class_t *cls,
330 ir_node *irn, int pos, ir_mode *mode, ir_node *spill)
334 ir_node *bl = get_nodes_block(irn);
335 ir_graph *irg = get_irn_irg(bl);
337 assert(is_Spill(spill)
338 || (is_Phi(spill) && get_irn_mode(spill) == mode_M));
340 reload = new_Reload(factory, cls, irg, bl, mode, spill);
342 set_irn_n(irn, pos, reload);
343 sched_add_before(irn, reload);
347 static INLINE arch_register_req_t *get_Perm_reqs(ir_node *perm)
349 be_node_attr_t *attr = (be_node_attr_t *) &perm->attr;
350 char *ptr = (char *) &perm->attr;
352 ptr += sizeof(be_node_attr_t);
353 ptr += sizeof(arch_register_t *) * attr->n_regs;
355 return (arch_register_req_t *) ptr;
359 * If the node is a proj, reset the node to the proj's target and return
361 * @param node The address of a node pointer.
362 * @param def A default value.
363 * @return If *node is a Proj, *node is set to the Proj's target and
364 * the Proj number is returned. Else *node remains the same and @p def
367 static int redir_proj(const ir_node **node, int def)
369 const ir_node *n = *node;
372 *node = get_Proj_pred(n);
373 def = -(get_Proj_proj(n) + 1);
379 static const arch_register_req_t *
380 be_node_get_irn_reg_req(const arch_irn_ops_t *_self,
381 arch_register_req_t *req, const ir_node *irn, int pos)
384 const be_node_factory_t *factory =
385 container_of(_self, const be_node_factory_t, irn_ops);
387 /* We cannot get output requirements for tuple nodes. */
388 if(get_irn_mode(irn) == mode_T && pos < 0)
392 * if we're interested in an output operand (pos < 0), so let's resolve projs.
395 pos = redir_proj((const ir_node **) &irn, pos);
397 /* look if the node is one of ours. */
398 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
403 for(i = 0; i < bo->n_pos; ++i) {
404 if(pos == bo->pos[i]) {
406 /* be nodes have no input constraints.
407 so return normal register requirements. */
410 req->type = arch_register_req_type_normal;
414 * if an output requirement is requested,
415 * return the one stored in the node.
418 be_node_attr_t *attr = (be_node_attr_t *) &irn->attr;
419 *req = attr->reg_data[pos].req;
430 void be_set_Perm_out_req(ir_node *irn, int pos, const arch_register_req_t *req)
433 be_node_attr_t *a = get_attr_and_check(irn, node_kind_perm);
435 assert(pos >= 0 && pos < get_irn_arity(irn) && "position out of range");
436 assert(a->op->kind == node_kind_perm && "node must be a perm node");
438 a->reg_data[pos].req = *req;
442 be_node_set_irn_reg(const arch_irn_ops_t *_self, ir_node *irn,
443 const arch_register_t *reg)
447 be_node_attr_t *attr;
448 const be_node_factory_t *factory =
449 container_of(_self, const be_node_factory_t, irn_ops);
451 if(get_irn_mode(irn) == mode_T)
454 pos = redir_proj((const ir_node **) &irn, -1);
455 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
460 attr = (be_node_attr_t *) &irn->attr;
461 attr->reg_data[-pos - 1].reg = reg;
464 const arch_register_t *
465 be_node_get_irn_reg(const arch_irn_ops_t *_self, const ir_node *irn)
469 const be_node_factory_t *factory =
470 container_of(_self, const be_node_factory_t, irn_ops);
472 if(get_irn_mode(irn) == mode_T)
475 pos = redir_proj((const ir_node **) &irn, -1);
476 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
481 for(i = 0; i < bo->n_pos; ++i) {
482 if(bo->pos[i] == pos) {
483 be_node_attr_t *attr = (be_node_attr_t *) &irn->attr;
484 return attr->reg_data[-pos - 1].reg;
491 arch_irn_class_t be_node_classify(const arch_irn_ops_t *_self, const ir_node *irn)
493 const be_node_factory_t *factory = container_of(_self, const be_node_factory_t, irn_ops);
498 idx = redir_proj(&irn, 0);
499 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
502 #define XXX(a) case node_kind_ ## a: return arch_irn_class_ ## a;
515 arch_irn_class_t be_node_get_flags(const arch_irn_ops_t *_self, const ir_node *irn)
520 static const arch_irn_ops_t *
521 be_node_get_irn_ops(const arch_irn_handler_t *_self, const ir_node *irn)
524 const be_node_factory_t *factory =
525 container_of(_self, const be_node_factory_t, handler);
528 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
530 return bo ? &factory->irn_ops : NULL;
533 const arch_irn_handler_t *be_node_get_irn_handler(const be_node_factory_t *f)
538 int is_Spill(const ir_node *irn)
540 return is_be_kind(irn, node_kind_spill);
543 int is_Perm(const ir_node *irn)
545 return is_be_kind(irn, node_kind_perm);
548 be_node_factory_t *be_node_factory_init(be_node_factory_t *factory, const arch_isa_t *isa)
552 factory->ops = new_set(cmp_op_map, 64);
553 factory->irn_op_map = pmap_create();
554 obstack_init(&factory->obst);
556 factory->handler.get_irn_ops = be_node_get_irn_ops;
558 factory->irn_ops.get_irn_reg_req = be_node_get_irn_reg_req;
559 factory->irn_ops.set_irn_reg = be_node_set_irn_reg;
560 factory->irn_ops.get_irn_reg = be_node_get_irn_reg;
561 factory->irn_ops.classify = be_node_classify;
562 factory->irn_ops.get_flags = be_node_get_flags;
564 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
565 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
568 ent = get_op(factory, cls, node_kind_spill);
569 ent->op = new_ir_op(get_next_ir_opcode(), "Spill", op_pin_state_pinned,
570 0, oparity_unary, 0, sizeof(be_spill_attr_t), &be_node_ops);
571 ent->n_pos = ARRSIZE(templ_pos_Spill);
572 ent->pos = templ_pos_Spill;
573 pmap_insert(factory->irn_op_map, ent->op, ent);
575 ent = get_op(factory, cls, node_kind_reload);
576 ent->op = new_ir_op(get_next_ir_opcode(), "Reload", op_pin_state_pinned, 0,
577 oparity_unary, 0, sizeof(be_node_attr_t), &be_node_ops);
578 ent->n_pos = ARRSIZE(templ_pos_Reload);
579 ent->pos = templ_pos_Reload;
580 pmap_insert(factory->irn_op_map, ent->op, ent);
582 ent = get_op(factory, cls, node_kind_copy);
583 ent->op = new_ir_op(get_next_ir_opcode(), "Copy", op_pin_state_pinned, 0,
584 oparity_unary, 0, sizeof(be_node_attr_t), &be_node_ops);
585 ent->n_pos = ARRSIZE(templ_pos_Copy);
586 ent->pos = templ_pos_Copy;
587 pmap_insert(factory->irn_op_map, ent->op, ent);
589 ent = get_op(factory, cls, node_kind_perm);
590 ent->op = new_ir_op(get_next_ir_opcode(), "Perm", op_pin_state_pinned, 0,
592 sizeof(be_node_attr_t)
593 + sizeof(be_reg_data_t) * cls->n_regs, &be_node_ops);
594 ent->n_pos = 2 * cls->n_regs;
595 ent->pos = obstack_alloc(&factory->obst, sizeof(ent->pos[0]) * ent->n_pos);
596 for(j = 0; j < ent->n_pos; j += 2) {
599 ent->pos[j + 1] = -(k + 1);
601 pmap_insert(factory->irn_op_map, ent->op, ent);
608 static int dump_node(ir_node *irn, FILE *f, dump_reason_t reason)
610 be_node_attr_t *at = (be_node_attr_t *) &irn->attr;
614 assert(is_be_node(irn));
618 case dump_node_opcode_txt:
619 fprintf(f, get_op_name(bo->op));
621 case dump_node_mode_txt:
622 fprintf(f, get_mode_name(get_irn_mode(irn)));
624 case dump_node_nodeattr_txt:
625 fprintf(f, "%s ", bo->cls->name);
627 case dump_node_info_txt:
628 for(i = 0; i < at->n_regs; ++i) {
629 const arch_register_t *reg = at->reg_data[i].reg;
630 fprintf(f, "reg #%d: %s\n", i, reg ? reg->name : "n/a");
633 if(bo->kind == node_kind_spill) {
634 be_spill_attr_t *a = (be_spill_attr_t *) at;
635 ir_fprintf(f, "spill context: %+F\n", a->spill_ctx);
643 ir_node *insert_Perm_after(const be_main_env_t *env,
644 const arch_register_class_t *cls,
645 dom_front_info_t *dom_front,
648 const arch_env_t *arch_env = env->arch_env;
649 ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
650 ir_graph *irg = get_irn_irg(bl);
651 pset *live = pset_new_ptr_default();
652 firm_dbg_module_t *dbg = firm_dbg_register("firm.be.node");
655 ir_node *curr, *irn, *perm, **nodes;
658 firm_dbg_set_mask(dbg, DBG_LEVEL);
659 DBG((dbg, LEVEL_1, "Insert Perm after: %+F\n", pos));
662 live_foreach(bl, li) {
663 ir_node *irn = (ir_node *) li->irn;
664 if(live_is_end(li) && arch_irn_has_reg_class(arch_env, irn, -1, cls))
665 pset_insert_ptr(live, irn);
668 sched_foreach_reverse(bl, irn) {
672 * If we encounter the node we want to insert the Perm after,
673 * exit immediately, so that this node is still live
678 DBG((dbg, LEVEL_1, "%+F\n", irn));
679 for(x = pset_first(live); x; x = pset_next(live))
680 DBG((dbg, LEVEL_1, "\tlive: %+F\n", x));
682 if(arch_irn_has_reg_class(arch_env, irn, -1, cls))
683 pset_remove_ptr(live, irn);
685 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
686 ir_node *op = get_irn_n(irn, i);
688 if(arch_irn_has_reg_class(arch_env, op, -1, cls))
689 pset_insert_ptr(live, op);
693 n = pset_count(live);
694 nodes = malloc(n * sizeof(nodes[0]));
696 DBG((dbg, LEVEL_1, "live:\n"));
697 for(irn = pset_first(live), i = 0; irn; irn = pset_next(live), i++) {
698 DBG((dbg, LEVEL_1, "\t%+F\n", irn));
702 perm = new_Perm(env->node_factory, cls, irg, bl, n, nodes);
703 sched_add_after(pos, perm);
707 for(i = 0; i < n; ++i) {
709 ir_node *perm_op = get_irn_n(perm, i);
710 const arch_register_t *reg = arch_get_irn_register(arch_env, perm_op);
712 ir_mode *mode = get_irn_mode(perm_op);
713 ir_node *proj = new_r_Proj(irg, bl, perm, mode, i);
714 arch_set_irn_register(arch_env, proj, reg);
716 sched_add_after(curr, proj);
720 be_introduce_copies(dom_front, perm_op, array_size(copies), copies);