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))
221 ir_node *get_Spill_context(const ir_node *irn) {
222 be_spill_attr_t *a = (be_spill_attr_t *) &irn->attr;
223 assert(is_be_kind(irn, node_kind_spill));
228 * Finds a spill for a reload.
229 * If the reload is directly using the spill, this is simple,
230 * else we perform DFS from the reload (over all PhiMs) and return
231 * the first spill node we find.
233 static INLINE ir_node *find_a_spill(ir_node *irn)
235 ir_graph *irg = get_irn_irg(irn);
236 unsigned visited_nr = get_irg_visited(irg) + 1;
238 assert(is_be_kind(irn, node_kind_reload));
239 set_irg_visited(irg, visited_nr);
240 return find_a_spill_walker(irn, visited_nr);
244 unsigned get_Spill_offset(ir_node *irn)
246 be_node_attr_t *a = (be_node_attr_t *) &irn->attr;
247 assert(is_be_node(irn));
249 switch(a->op->kind) {
250 case node_kind_reload:
251 assert(0 && "not yet implemented");
252 return get_Spill_offset(find_a_spill(irn));
253 case node_kind_spill:
254 return ((be_spill_attr_t *) a)->offset;
256 assert(0 && "Illegal node kind (spill/reload required)");
262 ir_node *new_Reload(const be_node_factory_t *factory,
263 const arch_register_class_t *cls, ir_graph *irg,
264 ir_node *bl, ir_mode *mode, ir_node *spill_node)
266 ir_node *irn, *in[1];
267 be_op_t *bop = get_op(factory, cls, node_kind_reload);
270 assert(op && "Reload opcode must be present for this register class");
273 irn = new_ir_node(NULL, irg, bl, op, mode, 1, in);
274 init_node_attr(irn, bop, cls, 1);
279 ir_node *new_Perm(const be_node_factory_t *factory,
280 const arch_register_class_t *cls,
281 ir_graph *irg, ir_node *bl, int arity, ir_node **in)
284 be_op_t *bop = get_op(factory, cls, node_kind_perm);
287 irn = new_ir_node(NULL, irg, bl, op, mode_T, arity, in);
288 init_node_attr(irn, bop, cls, arity);
293 ir_node *new_Copy(const be_node_factory_t *factory,
294 const arch_register_class_t *cls,
295 ir_graph *irg, ir_node *bl, ir_node *in)
297 ir_node *irn, *ins[1];
298 be_op_t *bop = get_op(factory, cls, node_kind_copy);
303 irn = new_ir_node(NULL, irg, bl, op, get_irn_mode(in), 1, ins);
304 init_node_attr(irn, bop, cls, 1);
310 const be_node_factory_t *factory,
311 const arch_env_t *arch_env,
312 ir_node *irn, ir_node *ctx)
314 const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, irn, -1);
316 ir_node *bl = get_nodes_block(irn);
317 ir_graph *irg = get_irn_irg(bl);
318 ir_node *spill = new_Spill(factory, cls, irg, bl, irn, ctx);
322 * search the right insertion point. a spill of a phi cannot be put
323 * directly after the phi, if there are some phis behind the one which
326 insert = sched_next(irn);
327 while(is_Phi(insert) && !sched_is_end(insert))
328 insert = sched_next(insert);
330 sched_add_before(insert, spill);
334 ir_node *be_reload(const be_node_factory_t *factory,
335 const arch_env_t *arch_env,
336 const arch_register_class_t *cls,
337 ir_node *irn, int pos, ir_mode *mode, ir_node *spill)
341 ir_node *bl = get_nodes_block(irn);
342 ir_graph *irg = get_irn_irg(bl);
344 assert(is_Spill(spill)
345 || (is_Phi(spill) && get_irn_mode(spill) == mode_M));
347 reload = new_Reload(factory, cls, irg, bl, mode, spill);
349 set_irn_n(irn, pos, reload);
350 sched_add_before(irn, reload);
354 static INLINE arch_register_req_t *get_Perm_reqs(ir_node *perm)
356 be_node_attr_t *attr = (be_node_attr_t *) &perm->attr;
357 char *ptr = (char *) &perm->attr;
359 ptr += sizeof(be_node_attr_t);
360 ptr += sizeof(arch_register_t *) * attr->n_regs;
362 return (arch_register_req_t *) ptr;
366 * If the node is a proj, reset the node to the proj's target and return
368 * @param node The address of a node pointer.
369 * @param def A default value.
370 * @return If *node is a Proj, *node is set to the Proj's target and
371 * the Proj number is returned. Else *node remains the same and @p def
374 static int redir_proj(const ir_node **node, int def)
376 const ir_node *n = *node;
379 *node = get_Proj_pred(n);
380 def = -(get_Proj_proj(n) + 1);
386 static const arch_register_req_t *
387 be_node_get_irn_reg_req(const arch_irn_ops_t *_self,
388 arch_register_req_t *req, const ir_node *irn, int pos)
391 const be_node_factory_t *factory =
392 container_of(_self, const be_node_factory_t, irn_ops);
394 /* We cannot get output requirements for tuple nodes. */
395 if(get_irn_mode(irn) == mode_T && pos < 0)
399 * if we're interested in an output operand (pos < 0), so let's resolve projs.
402 pos = redir_proj((const ir_node **) &irn, pos);
404 /* look if the node is one of ours. */
405 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
410 for(i = 0; i < bo->n_pos; ++i) {
411 if(pos == bo->pos[i]) {
413 /* be nodes have no input constraints.
414 so return normal register requirements. */
417 req->type = arch_register_req_type_normal;
421 * if an output requirement is requested,
422 * return the one stored in the node.
425 be_node_attr_t *attr = (be_node_attr_t *) &irn->attr;
426 *req = attr->reg_data[pos].req;
437 void be_set_Perm_out_req(ir_node *irn, int pos, const arch_register_req_t *req)
439 be_node_attr_t *a = get_attr_and_check(irn, node_kind_perm);
441 assert(pos >= 0 && pos < get_irn_arity(irn) && "position out of range");
442 assert(a->op->kind == node_kind_perm && "node must be a perm node");
444 a->reg_data[pos].req = *req;
448 be_node_set_irn_reg(const arch_irn_ops_t *_self, ir_node *irn,
449 const arch_register_t *reg)
453 be_node_attr_t *attr;
454 const be_node_factory_t *factory =
455 container_of(_self, const be_node_factory_t, irn_ops);
457 if(get_irn_mode(irn) == mode_T)
460 pos = redir_proj((const ir_node **) &irn, -1);
461 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
466 attr = (be_node_attr_t *) &irn->attr;
467 attr->reg_data[-pos - 1].reg = reg;
470 const arch_register_t *
471 be_node_get_irn_reg(const arch_irn_ops_t *_self, const ir_node *irn)
475 const be_node_factory_t *factory =
476 container_of(_self, const be_node_factory_t, irn_ops);
478 if(get_irn_mode(irn) == mode_T)
481 pos = redir_proj((const ir_node **) &irn, -1);
482 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
487 for(i = 0; i < bo->n_pos; ++i) {
488 if(bo->pos[i] == pos) {
489 be_node_attr_t *attr = (be_node_attr_t *) &irn->attr;
490 return attr->reg_data[-pos - 1].reg;
497 arch_irn_class_t be_node_classify(const arch_irn_ops_t *_self, const ir_node *irn)
499 const be_node_factory_t *factory = container_of(_self, const be_node_factory_t, irn_ops);
504 idx = redir_proj(&irn, 0);
505 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
508 #define XXX(a) case node_kind_ ## a: return arch_irn_class_ ## a;
521 arch_irn_class_t be_node_get_flags(const arch_irn_ops_t *_self, const ir_node *irn)
526 static const arch_irn_ops_t *
527 be_node_get_irn_ops(const arch_irn_handler_t *_self, const ir_node *irn)
530 const be_node_factory_t *factory =
531 container_of(_self, const be_node_factory_t, handler);
534 bo = pmap_get(factory->irn_op_map, get_irn_op(irn));
536 return bo ? &factory->irn_ops : NULL;
539 const arch_irn_handler_t *be_node_get_irn_handler(const be_node_factory_t *f)
544 int is_Spill(const ir_node *irn)
546 return is_be_kind(irn, node_kind_spill);
549 int is_Perm(const ir_node *irn)
551 return is_be_kind(irn, node_kind_perm);
554 be_node_factory_t *be_node_factory_init(be_node_factory_t *factory, const arch_isa_t *isa)
558 factory->ops = new_set(cmp_op_map, 64);
559 factory->irn_op_map = pmap_create();
560 obstack_init(&factory->obst);
562 factory->handler.get_irn_ops = be_node_get_irn_ops;
564 factory->irn_ops.get_irn_reg_req = be_node_get_irn_reg_req;
565 factory->irn_ops.set_irn_reg = be_node_set_irn_reg;
566 factory->irn_ops.get_irn_reg = be_node_get_irn_reg;
567 factory->irn_ops.classify = be_node_classify;
568 factory->irn_ops.get_flags = be_node_get_flags;
570 for(i = 0, n = arch_isa_get_n_reg_class(isa); i < n; ++i) {
571 const arch_register_class_t *cls = arch_isa_get_reg_class(isa, i);
574 ent = get_op(factory, cls, node_kind_spill);
575 ent->op = new_ir_op(get_next_ir_opcode(), "Spill", op_pin_state_pinned,
576 0, oparity_unary, 0, sizeof(be_spill_attr_t), &be_node_ops);
577 ent->n_pos = ARRSIZE(templ_pos_Spill);
578 ent->pos = templ_pos_Spill;
579 pmap_insert(factory->irn_op_map, ent->op, ent);
581 ent = get_op(factory, cls, node_kind_reload);
582 ent->op = new_ir_op(get_next_ir_opcode(), "Reload", op_pin_state_pinned, 0,
583 oparity_unary, 0, sizeof(be_node_attr_t), &be_node_ops);
584 ent->n_pos = ARRSIZE(templ_pos_Reload);
585 ent->pos = templ_pos_Reload;
586 pmap_insert(factory->irn_op_map, ent->op, ent);
588 ent = get_op(factory, cls, node_kind_copy);
589 ent->op = new_ir_op(get_next_ir_opcode(), "Copy", op_pin_state_pinned, 0,
590 oparity_unary, 0, sizeof(be_node_attr_t), &be_node_ops);
591 ent->n_pos = ARRSIZE(templ_pos_Copy);
592 ent->pos = templ_pos_Copy;
593 pmap_insert(factory->irn_op_map, ent->op, ent);
595 ent = get_op(factory, cls, node_kind_perm);
596 ent->op = new_ir_op(get_next_ir_opcode(), "Perm", op_pin_state_pinned, 0,
598 sizeof(be_node_attr_t)
599 + sizeof(be_reg_data_t) * cls->n_regs, &be_node_ops);
600 ent->n_pos = 2 * cls->n_regs;
601 ent->pos = obstack_alloc(&factory->obst, sizeof(ent->pos[0]) * ent->n_pos);
602 for(j = 0; j < ent->n_pos; j += 2) {
605 ent->pos[j + 1] = -(k + 1);
607 pmap_insert(factory->irn_op_map, ent->op, ent);
614 static int dump_node(ir_node *irn, FILE *f, dump_reason_t reason)
616 be_node_attr_t *at = (be_node_attr_t *) &irn->attr;
620 assert(is_be_node(irn));
624 case dump_node_opcode_txt:
625 fprintf(f, get_op_name(bo->op));
627 case dump_node_mode_txt:
628 fprintf(f, get_mode_name(get_irn_mode(irn)));
630 case dump_node_nodeattr_txt:
631 fprintf(f, "%s ", bo->cls->name);
633 case dump_node_info_txt:
634 for(i = 0; i < at->n_regs; ++i) {
635 const arch_register_t *reg = at->reg_data[i].reg;
636 fprintf(f, "reg #%d: %s\n", i, reg ? reg->name : "n/a");
639 if(bo->kind == node_kind_spill) {
640 be_spill_attr_t *a = (be_spill_attr_t *) at;
641 ir_fprintf(f, "spill context: %+F\n", a->spill_ctx);
649 ir_node *insert_Perm_after(const be_main_env_t *env,
650 const arch_register_class_t *cls,
651 dom_front_info_t *dom_front,
654 const arch_env_t *arch_env = env->arch_env;
655 ir_node *bl = is_Block(pos) ? pos : get_nodes_block(pos);
656 ir_graph *irg = get_irn_irg(bl);
657 pset *live = pset_new_ptr_default();
658 firm_dbg_module_t *dbg = firm_dbg_register("firm.be.node");
661 ir_node *curr, *irn, *perm, **nodes;
664 firm_dbg_set_mask(dbg, DBG_LEVEL);
665 DBG((dbg, LEVEL_1, "Insert Perm after: %+F\n", pos));
668 live_foreach(bl, li) {
669 ir_node *irn = (ir_node *) li->irn;
670 if(live_is_end(li) && arch_irn_has_reg_class(arch_env, irn, -1, cls))
671 pset_insert_ptr(live, irn);
674 sched_foreach_reverse(bl, irn) {
678 * If we encounter the node we want to insert the Perm after,
679 * exit immediately, so that this node is still live
684 DBG((dbg, LEVEL_1, "%+F\n", irn));
685 for(x = pset_first(live); x; x = pset_next(live))
686 DBG((dbg, LEVEL_1, "\tlive: %+F\n", x));
688 if(arch_irn_has_reg_class(arch_env, irn, -1, cls))
689 pset_remove_ptr(live, irn);
691 for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
692 ir_node *op = get_irn_n(irn, i);
694 if(arch_irn_has_reg_class(arch_env, op, -1, cls))
695 pset_insert_ptr(live, op);
699 n = pset_count(live);
700 nodes = malloc(n * sizeof(nodes[0]));
702 DBG((dbg, LEVEL_1, "live:\n"));
703 for(irn = pset_first(live), i = 0; irn; irn = pset_next(live), i++) {
704 DBG((dbg, LEVEL_1, "\t%+F\n", irn));
708 perm = new_Perm(env->node_factory, cls, irg, bl, n, nodes);
709 sched_add_after(pos, perm);
713 for(i = 0; i < n; ++i) {
715 ir_node *perm_op = get_irn_n(perm, i);
716 const arch_register_t *reg = arch_get_irn_register(arch_env, perm_op);
718 ir_mode *mode = get_irn_mode(perm_op);
719 ir_node *proj = new_r_Proj(irg, bl, perm, mode, i);
720 arch_set_irn_register(arch_env, proj, reg);
722 sched_add_after(curr, proj);
726 be_introduce_copies(dom_front, perm_op, array_size(copies), copies);