2 * Author: Matthias Braun
4 * Copyright: (c) Universitaet Karlsruhe
5 * License: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
25 #include "besched_t.h"
28 static int my_values_interfere(const ir_node *a, const ir_node *b);
30 typedef struct be_verify_register_pressure_env_t_ {
31 ir_graph *irg; /**< the irg to verify */
32 be_lv_t *lv; /**< Liveness information. */
33 const arch_env_t *arch_env; /**< an architecture environment */
34 const arch_register_class_t *cls; /**< the register class to check for */
35 int registers_available; /**< number of available registers */
36 int problem_found; /**< flag indicating if a problem was found */
37 } be_verify_register_pressure_env_t;
40 * Print all nodes of a pset into a file.
42 static void print_living_values(FILE *F, pset *live_nodes) {
46 foreach_pset(live_nodes, node) {
47 ir_fprintf(F, "%+F ", node);
53 * Check if number of live nodes never exceeds the number of available registers.
55 static void verify_liveness_walker(ir_node *block, void *data) {
56 be_verify_register_pressure_env_t *env = (be_verify_register_pressure_env_t *)data;
57 pset *live_nodes = pset_new_ptr_default();
61 /* collect register pressure info, start with end of a block */
62 be_liveness_end_of_block(env->lv, env->arch_env, env->cls, block, live_nodes);
64 pressure = pset_count(live_nodes);
65 if(pressure > env->registers_available) {
66 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
67 block, get_irg_dump_name(env->irg), pressure, env->registers_available);
68 print_living_values(stderr, live_nodes);
69 env->problem_found = 1;
72 sched_foreach_reverse(block, irn) {
76 be_liveness_transfer(env->arch_env, env->cls, irn, live_nodes);
78 pressure = pset_count(live_nodes);
80 if(pressure > env->registers_available) {
81 ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
82 irn, block, get_irg_dump_name(env->irg), pressure, env->registers_available);
83 print_living_values(stderr, live_nodes);
84 env->problem_found = 1;
91 * Start a walk over the irg and check the register pressure.
93 int be_verify_register_pressure(const be_irg_t *birg, const arch_register_class_t *cls, ir_graph *irg) {
94 be_verify_register_pressure_env_t env;
96 env.lv = be_liveness(irg);
98 env.arch_env = birg->main_env->arch_env;
100 env.registers_available = env.cls->n_regs - be_put_ignore_regs(birg, env.cls, NULL);
101 env.problem_found = 0;
103 irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
104 be_liveness_free(env.lv);
106 return ! env.problem_found;
109 typedef struct be_verify_schedule_env_t_ {
110 int problem_found; /**< flags indicating if there was a problem */
111 ir_graph *irg; /**< the irg to check */
112 } be_verify_schedule_env_t;
115 * Simple schedule checker.
117 static void verify_schedule_walker(ir_node *block, void *data) {
118 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
120 int non_phi_found = 0;
121 int cfchange_found = 0;
122 // TODO ask arch about delay branches
123 int delay_branches = 0;
126 * Tests for the following things:
127 * 1. Make sure that all phi nodes are scheduled at the beginning of the block
128 * 2. There is 1 or no control flow changing node scheduled and exactly delay_branches operations after it.
129 * 3. No value is defined after it has been used
131 sched_foreach(block, node) {
137 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes in block %+F (%s)\n",
138 node, block, get_irg_dump_name(env->irg));
139 env->problem_found = 1;
145 // 2. Check for control flow changing nodes
146 if (is_cfop(node) && get_irn_opcode(node) != iro_Start) {
147 /* check, that only one CF operation is scheduled */
148 if (cfchange_found == 1) {
149 ir_fprintf(stderr, "Verify Warning: More than 1 control flow changing node (%+F) scheduled in block %+F (%s)\n",
150 node, block, get_irg_dump_name(env->irg));
151 env->problem_found = 1;
154 } else if (cfchange_found) {
155 // proj and keepany aren't real instructions...
156 if(!is_Proj(node) && !be_is_Keep(node)) {
157 /* check for delay branches */
158 if (delay_branches == 0) {
159 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node (+delay branches) in block %+F (%s)\n",
160 node, block, get_irg_dump_name(env->irg));
161 env->problem_found = 1;
170 int nodetime = sched_get_time_step(node);
171 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
172 ir_node *arg = get_irn_n(node, i);
173 if(get_nodes_block(arg) != block
174 || !sched_is_scheduled(arg))
177 if(sched_get_time_step(arg) >= nodetime) {
178 ir_fprintf(stderr, "Verify Warning: Value %+F used by %+F before it was defined in block %+F (%s)\n",
179 arg, node, block, get_irg_dump_name(env->irg));
180 env->problem_found = 1;
185 // 4. check for dead nodes
186 if(get_irn_n_edges(node) == 0) {
187 ir_fprintf(stderr, "Verify warning: Node %+F is dead but scheduled in block %+F (%s)\n",
188 node, block, get_irg_dump_name(env->irg));
189 env->problem_found = 1;
193 /* check that all delay branches are filled (at least with NOPs) */
194 if (cfchange_found && delay_branches != 0) {
195 ir_fprintf(stderr, "Verify warning: Not all delay slots filled after jump (%d/%d) in block %+F (%s)\n",
196 block, get_irg_dump_name(env->irg));
197 env->problem_found = 1;
201 static int should_be_scheduled(ir_node *node) {
205 if(get_irn_mode(node) == mode_M) {
208 if(is_Phi(node) || is_Sync(node) || is_Pin(node))
211 if(is_Proj(node) && get_irn_mode(node) == mode_X)
213 if(be_is_Keep(node) && get_irn_opcode(get_nodes_block(node)) == iro_Bad)
216 switch(get_irn_opcode(node)) {
229 static void check_schedule(ir_node *node, void *data) {
230 be_verify_schedule_env_t *env = data;
233 should_be = should_be_scheduled(node);
237 if(should_be ? !sched_is_scheduled(node) : sched_is_scheduled(node)) {
238 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
239 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
240 env->problem_found = 1;
245 * Start a walk over the irg and check schedule.
247 int be_verify_schedule(ir_graph *irg)
249 be_verify_schedule_env_t env;
251 env.problem_found = 0;
254 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
255 // check if all nodes are scheduled
256 irg_walk_graph(irg, check_schedule, NULL, &env);
258 return ! env.problem_found;
263 //---------------------------------------------------------------------------
267 typedef struct _spill_t {
273 const arch_env_t *arch_env;
278 } be_verify_spillslots_env_t;
280 static int cmp_spill(const void* d1, const void* d2, size_t size) {
281 const spill_t* s1 = d1;
282 const spill_t* s2 = d2;
283 return s1->spill != s2->spill;
286 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node) {
290 return set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
293 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
295 int hash = HASH_PTR(node);
298 res = set_find(env->spills, &spill, sizeof(spill), hash);
302 res = set_insert(env->spills, &spill, sizeof(spill), hash);
308 static ir_node *get_memory_edge(const ir_node *node) {
310 ir_node *result = NULL;
312 arity = get_irn_arity(node);
313 for(i = arity - 1; i >= 0; --i) {
314 ir_node *arg = get_irn_n(node, i);
315 if(get_irn_mode(arg) == mode_M) {
316 assert(result == NULL);
324 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
326 static void check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
328 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
329 node, get_nodes_block(node), get_irg_dump_name(env->irg));
333 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
334 ir_entity *spillent = arch_get_frame_entity(env->arch_env, node);
335 check_entity(env, node, spillent);
336 get_spill(env, node, ent);
338 if(spillent != ent) {
339 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
340 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
341 env->problem_found = 1;
345 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
348 int hash = HASH_PTR(node);
353 assert(is_Proj(node));
355 memperm = get_Proj_pred(node);
356 out = get_Proj_proj(node);
358 spillent = be_get_MemPerm_out_entity(memperm, out);
359 check_entity(env, memperm, spillent);
360 if(spillent != ent) {
361 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
362 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
363 env->problem_found = 1;
367 res = set_find(env->spills, &spill, sizeof(spill), hash);
372 spill.ent = spillent;
373 res = set_insert(env->spills, &spill, sizeof(spill), hash);
375 for(i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
376 ir_node* arg = get_irn_n(memperm, i + 1);
377 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
379 collect(env, arg, memperm, argent);
383 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent) {
386 int hash = HASH_PTR(node);
388 assert(is_Phi(node));
391 res = set_find(env->spills, &spill, sizeof(spill), hash);
397 res = set_insert(env->spills, &spill, sizeof(spill), hash);
399 // is 1 of the arguments a spill?
400 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
401 ir_node* arg = get_irn_n(node, i);
402 collect(env, arg, reload, ent);
406 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
407 if(be_is_Spill(node)) {
408 collect_spill(env, node, reload, ent);
409 } else if(is_Proj(node)) {
410 collect_memperm(env, node, reload, ent);
411 } else if(is_Phi(node) && get_irn_mode(node) == mode_M) {
412 collect_memphi(env, node, reload, ent);
414 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
415 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
416 env->problem_found = 1;
421 * This walker function searches for reloads and collects all the spills
422 * and memphis attached to them.
424 static void collect_spills_walker(ir_node *node, void *data) {
425 be_verify_spillslots_env_t *env = data;
426 const arch_env_t *arch_env = env->arch_env;
428 // @@@ ia32_classify returns classification of Proj_pred :-/
432 if(arch_irn_class_is(arch_env, node, reload)) {
433 ir_node *spill = get_memory_edge(node);
437 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
438 node, get_nodes_block(node), get_irg_dump_name(env->irg));
439 env->problem_found = 1;
442 ent = arch_get_frame_entity(env->arch_env, node);
443 check_entity(env, node, ent);
445 collect(env, spill, node, ent);
446 ARR_APP1(ir_node*, env->reloads, node);
450 static void check_spillslot_interference(be_verify_spillslots_env_t *env) {
451 int spillcount = set_count(env->spills);
452 spill_t **spills = alloca(spillcount * sizeof(spills[0]));
456 for(spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
460 for(i = 0; i < spillcount; ++i) {
461 spill_t *sp1 = spills[i];
464 for(i2 = i+1; i2 < spillcount; ++i2) {
465 spill_t *sp2 = spills[i2];
467 if(sp1->ent != sp2->ent)
470 if(my_values_interfere(sp1->spill, sp2->spill)) {
471 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
472 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
473 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
474 env->problem_found = 1;
475 my_values_interfere(sp1->spill, sp2->spill);
481 static void check_lonely_spills(ir_node *node, void *data) {
482 be_verify_spillslots_env_t *env = data;
484 if(be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
485 spill_t *spill = find_spill(env, node);
486 if(be_is_Spill(node)) {
487 ir_entity *ent = arch_get_frame_entity(env->arch_env, node);
488 check_entity(env, node, ent);
492 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
493 node, get_nodes_block(node), get_irg_dump_name(env->irg));
498 int be_verify_spillslots(const arch_env_t *arch_env, ir_graph *irg)
500 be_verify_spillslots_env_t env;
502 env.arch_env = arch_env;
504 env.spills = new_set(cmp_spill, 10);
505 env.reloads = NEW_ARR_F(ir_node*, 0);
506 env.problem_found = 0;
508 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
509 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
511 check_spillslot_interference(&env);
513 DEL_ARR_F(env.reloads);
516 return ! env.problem_found;
521 //---------------------------------------------------------------------------
526 * Check, if two values interfere.
527 * @param a The first value.
528 * @param b The second value.
529 * @return 1, if a and b interfere, 0 if not.
531 static int my_values_interfere(const ir_node *a, const ir_node *b) {
532 const ir_edge_t *edge;
534 int a2b = value_dominates(a, b);
535 int b2a = value_dominates(b, a);
537 /* If there is no dominance relation, they do not interfere. */
542 * Adjust a and b so, that a dominates b if
543 * a dominates b or vice versa.
546 const ir_node *t = a;
551 bb = get_nodes_block(b);
554 * Look at all usages of a.
555 * If there's one usage of a in the block of b, then
556 * we check, if this use is dominated by b, if that's true
557 * a and b interfere. Note that b must strictly dominate the user,
558 * since if b is the last user of in the block, b and a do not
560 * Uses of a not in b's block can be disobeyed, because the
561 * check for a being live at the end of b's block is already
564 foreach_out_edge(a, edge) {
565 const ir_node *user = get_edge_src_irn(edge);
569 if(get_irn_opcode(user) == iro_End)
572 // in case of phi arguments we compare with the block the value comes from
574 ir_node *phiblock = get_nodes_block(user);
577 user = get_irn_n(phiblock, get_edge_src_pos(edge));
580 if(value_dominates(b, user))
589 //---------------------------------------------------------------------------
593 typedef struct _be_verify_register_allocation_env_t {
594 const arch_env_t *arch_env;
598 } be_verify_register_allocation_env_t;
600 static void check_register_constraints(ir_node *node, be_verify_register_allocation_env_t *env) {
601 const arch_env_t *arch_env = env->arch_env;
602 const arch_register_t *reg;
605 /* verify output register */
606 if (arch_get_irn_reg_class(arch_env, node, -1) != NULL) {
607 reg = arch_get_irn_register(arch_env, node);
609 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
610 node, get_nodes_block(node), get_irg_dump_name(env->irg));
611 env->problem_found = 1;
613 else if (! arch_register_type_is(reg, joker) && !arch_reg_is_allocatable(arch_env, node, -1, reg)) {
614 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
615 reg->name, node, get_nodes_block(node), get_irg_dump_name(env->irg));
616 env->problem_found = 1;
620 /* verify input register */
621 arity = get_irn_arity(node);
622 for (i = 0; i < arity; ++i) {
623 ir_node *pred = get_irn_n(node, i);
625 if (is_Unknown(pred))
629 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
630 node, get_nodes_block(node), get_irg_dump_name(env->irg), i);
631 env->problem_found = 1;
635 if (arch_get_irn_reg_class(arch_env, node, i) == NULL)
638 reg = arch_get_irn_register(arch_env, pred);
640 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
641 pred, get_nodes_block(pred), get_irg_dump_name(env->irg));
642 env->problem_found = 1;
645 else if (! arch_register_type_is(reg, joker) && ! arch_reg_is_allocatable(arch_env, node, i, reg)) {
646 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
647 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(env->irg));
648 env->problem_found = 1;
653 static void check_register_allocation(be_verify_register_allocation_env_t *env,
654 const arch_register_class_t *regclass, pset *nodes) {
655 const arch_env_t *arch_env = env->arch_env;
656 const arch_register_t *reg = NULL;
658 bitset_t *registers = bitset_alloca(arch_register_class_n_regs(regclass));
661 foreach_pset(nodes, node) {
662 if (arch_get_irn_reg_class(arch_env, node, -1) != regclass)
665 reg = arch_get_irn_register(arch_env, node);
667 /* this problem is already reported in 'check_register_constraints' */
671 if (bitset_is_set(registers, reg->index)) {
676 bitset_set(registers, reg->index);
680 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s)\n",
681 reg->name, get_nodes_block(node), get_irg_dump_name(env->irg));
682 env->problem_found = 1;
684 foreach_pset(nodes, node) {
685 if (arch_get_irn_register(arch_env, node) == reg) {
686 ir_fprintf(stderr, " at node %+F\n", node);
692 static void verify_block_register_allocation(ir_node *block, void *data) {
693 be_verify_register_allocation_env_t *env = data;
694 const arch_env_t *arch_env = env->arch_env;
695 const arch_isa_t *isa = arch_env->isa;
698 nregclasses = arch_isa_get_n_reg_class(isa);
699 for (i = 0; i < nregclasses; ++i) {
700 const arch_register_class_t *regclass = arch_isa_get_reg_class(isa, i);
702 pset *live_nodes = pset_new_ptr_default();
704 be_liveness_end_of_block(env->lv, env->arch_env, regclass, block, live_nodes);
705 check_register_allocation(env, regclass, live_nodes);
707 sched_foreach_reverse(block, node) {
711 be_liveness_transfer(env->arch_env, regclass, node, live_nodes);
712 check_register_allocation(env, regclass, live_nodes);
713 check_register_constraints(node, env);
716 del_pset(live_nodes);
720 int be_verify_register_allocation(const arch_env_t *arch_env, ir_graph *irg) {
721 be_verify_register_allocation_env_t env;
723 env.arch_env = arch_env;
725 env.lv = be_liveness(irg);
726 env.problem_found = 0;
728 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, &env);
730 be_liveness_free(env.lv);
732 return !env.problem_found;
737 //---------------------------------------------------------------------------
741 typedef struct _verify_out_dead_nodes_env {
745 } verify_out_dead_nodes_env;
747 static void check_out_edges(ir_node *node, verify_out_dead_nodes_env *env) {
748 ir_graph *irg = env->irg;
749 const ir_edge_t* edge;
751 if(irn_visited(node))
753 mark_irn_visited(node);
755 foreach_out_edge(node, edge) {
756 ir_node* src = get_edge_src_irn(edge);
758 if(!bitset_is_set(env->reachable, get_irn_idx(src))) {
759 if(src != get_irg_globals(irg)
760 && src != get_irg_tls(irg)) {
762 "Verify warning: Node %+F in block %+F(%s) only reachable through out edges from %+F\n",
763 src, get_nodes_block(src), get_irg_dump_name(irg), node);
764 env->problem_found = 1;
770 check_out_edges(src, env);
775 static void set_reachable(ir_node *node, void* data)
777 bitset_t* reachable = data;
778 bitset_set(reachable, get_irn_idx(node));
781 int be_verify_out_edges(ir_graph *irg) {
782 verify_out_dead_nodes_env env;
784 env.reachable = bitset_alloca(get_irg_last_idx(irg));
785 env.problem_found = 0;
787 irg_walk_in_or_dep_graph(irg, set_reachable, NULL, env.reachable);
788 inc_irg_visited(irg);
789 check_out_edges(get_irg_start(irg), &env);
791 return !env.problem_found;