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 Various verify routines that check a scheduled graph for correctness.
23 * @author Matthias Braun
46 #include "besched_t.h"
51 static int my_values_interfere(const ir_node *a, const ir_node *b);
53 typedef struct be_verify_register_pressure_env_t_ {
54 ir_graph *irg; /**< the irg to verify */
55 be_lv_t *lv; /**< Liveness information. */
56 const arch_env_t *arch_env; /**< an architecture environment */
57 const arch_register_class_t *cls; /**< the register class to check for */
58 int registers_available; /**< number of available registers */
59 int problem_found; /**< flag indicating if a problem was found */
60 } be_verify_register_pressure_env_t;
63 * Print all nodes of a pset into a file.
65 static void print_living_values(FILE *F, pset *live_nodes) {
69 foreach_pset(live_nodes, node) {
70 ir_fprintf(F, "%+F ", node);
76 * Check if number of live nodes never exceeds the number of available registers.
78 static void verify_liveness_walker(ir_node *block, void *data) {
79 be_verify_register_pressure_env_t *env = (be_verify_register_pressure_env_t *)data;
80 pset *live_nodes = pset_new_ptr_default();
84 /* collect register pressure info, start with end of a block */
85 be_liveness_end_of_block(env->lv, env->arch_env, env->cls, block, live_nodes);
87 pressure = pset_count(live_nodes);
88 if(pressure > env->registers_available) {
89 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
90 block, get_irg_dump_name(env->irg), pressure, env->registers_available);
91 print_living_values(stderr, live_nodes);
92 env->problem_found = 1;
95 sched_foreach_reverse(block, irn) {
99 be_liveness_transfer(env->arch_env, env->cls, irn, live_nodes);
101 pressure = pset_count(live_nodes);
103 if(pressure > env->registers_available) {
104 ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
105 irn, block, get_irg_dump_name(env->irg), pressure, env->registers_available);
106 print_living_values(stderr, live_nodes);
107 env->problem_found = 1;
110 del_pset(live_nodes);
114 * Start a walk over the irg and check the register pressure.
116 int be_verify_register_pressure(const be_irg_t *birg,
117 const arch_register_class_t *cls,
119 be_verify_register_pressure_env_t env;
121 env.lv = be_liveness(irg);
123 env.arch_env = birg->main_env->arch_env;
125 env.registers_available = env.cls->n_regs - be_put_ignore_regs(birg, env.cls, NULL);
126 env.problem_found = 0;
128 irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
129 be_liveness_free(env.lv);
131 return ! env.problem_found;
136 //---------------------------------------------------------------------------
140 typedef struct be_verify_schedule_env_t_ {
141 int problem_found; /**< flags indicating if there was a problem */
142 bitset_t *scheduled; /**< bitset of scheduled nodes */
143 ir_graph *irg; /**< the irg to check */
144 const arch_env_t *arch_env; /**< the arch_env */
145 } be_verify_schedule_env_t;
148 * Simple schedule checker.
150 static void verify_schedule_walker(ir_node *block, void *data) {
151 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
153 int non_phi_found = 0;
154 int cfchange_found = 0;
155 // TODO ask arch about delay branches
156 int delay_branches = 0;
157 int last_timestep = INT_MIN;
160 * Tests for the following things:
161 * 1. Make sure that all phi nodes are scheduled at the beginning of the block
162 * 2. There is 1 or no control flow changing node scheduled and exactly delay_branches operations after it.
163 * 3. No value is defined after it has been used
165 sched_foreach(block, node) {
169 // this node is scheduled
170 if(bitset_is_set(env->scheduled, get_irn_idx(node))) {
171 ir_fprintf(stderr, "Verify warning: %+F appears to be schedule twice\n");
172 env->problem_found = 1;
174 bitset_set(env->scheduled, get_irn_idx(node));
176 // Check that scheduled nodes are in the correct block
177 if(get_nodes_block(node) != block) {
178 ir_fprintf(stderr, "Verify warning: %+F is in block %+F but scheduled in %+F\n", node, get_nodes_block(node), block);
179 env->problem_found = 1;
182 // Check that timesteps are increasing
183 timestep = sched_get_time_step(node);
184 if(timestep <= last_timestep) {
185 ir_fprintf(stderr, "Verify warning: Schedule timestep did not increase at node %+F\n",
187 env->problem_found = 1;
189 last_timestep = timestep;
191 // Check that phis come before any other node
194 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes in block %+F (%s)\n",
195 node, block, get_irg_dump_name(env->irg));
196 env->problem_found = 1;
202 // Check for control flow changing nodes
203 if (is_cfop(node) && get_irn_opcode(node) != iro_Start) {
204 /* check, that only one CF operation is scheduled */
205 if (cfchange_found == 1) {
206 ir_fprintf(stderr, "Verify Warning: More than 1 control flow changing node (%+F) scheduled in block %+F (%s)\n",
207 node, block, get_irg_dump_name(env->irg));
208 env->problem_found = 1;
211 } else if (cfchange_found) {
212 // proj and keepany aren't real instructions...
213 if(!is_Proj(node) && !be_is_Keep(node)) {
214 /* check for delay branches */
215 if (delay_branches == 0) {
216 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node (+delay branches) in block %+F (%s)\n",
217 node, block, get_irg_dump_name(env->irg));
218 env->problem_found = 1;
225 // Check that all uses come before their definitions
227 int nodetime = sched_get_time_step(node);
228 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
229 ir_node *arg = get_irn_n(node, i);
230 if(get_nodes_block(arg) != block
231 || !sched_is_scheduled(arg))
234 if(sched_get_time_step(arg) >= nodetime) {
235 ir_fprintf(stderr, "Verify Warning: Value %+F used by %+F before it was defined in block %+F (%s)\n",
236 arg, node, block, get_irg_dump_name(env->irg));
237 env->problem_found = 1;
242 // Check that no dead nodes are scheduled
243 if(get_irn_n_edges(node) == 0) {
244 ir_fprintf(stderr, "Verify warning: Node %+F is dead but scheduled in block %+F (%s)\n",
245 node, block, get_irg_dump_name(env->irg));
246 env->problem_found = 1;
250 /* check that all delay branches are filled (at least with NOPs) */
251 if (cfchange_found && delay_branches != 0) {
252 ir_fprintf(stderr, "Verify warning: Not all delay slots filled after jump (%d/%d) in block %+F (%s)\n",
253 block, get_irg_dump_name(env->irg));
254 env->problem_found = 1;
258 static int should_be_scheduled(be_verify_schedule_env_t *env, ir_node *node) {
262 if(get_irn_mode(node) == mode_M) {
265 if(is_Phi(node) || is_Sync(node) || is_Pin(node))
268 if(is_Proj(node) && get_irn_mode(node) == mode_X)
270 if(be_is_Keep(node) && get_irn_opcode(get_nodes_block(node)) == iro_Bad)
273 switch(get_irn_opcode(node)) {
283 if(arch_irn_get_flags(env->arch_env, node) & arch_irn_flags_ignore)
289 static void check_schedule(ir_node *node, void *data) {
290 be_verify_schedule_env_t *env = data;
294 should_be = should_be_scheduled(env, node);
298 scheduled = bitset_is_set(env->scheduled, get_irn_idx(node)) ? 1 : 0;
299 should_be = should_be ? 1 : 0;
300 if(should_be != scheduled) {
301 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
302 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
303 env->problem_found = 1;
308 * Start a walk over the irg and check schedule.
310 int be_verify_schedule(const be_irg_t *birg)
312 be_verify_schedule_env_t env;
314 env.problem_found = 0;
315 env.irg = be_get_birg_irg(birg);
316 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
317 env.arch_env = birg->main_env->arch_env;
319 irg_block_walk_graph(env.irg, verify_schedule_walker, NULL, &env);
320 // check if all nodes are scheduled
321 irg_walk_graph(env.irg, check_schedule, NULL, &env);
323 return ! env.problem_found;
328 //---------------------------------------------------------------------------
332 typedef struct _spill_t {
338 const arch_env_t *arch_env;
343 } be_verify_spillslots_env_t;
345 static int cmp_spill(const void* d1, const void* d2, size_t size) {
346 const spill_t* s1 = d1;
347 const spill_t* s2 = d2;
348 return s1->spill != s2->spill;
351 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node) {
355 return set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
358 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
360 int hash = HASH_PTR(node);
363 res = set_find(env->spills, &spill, sizeof(spill), hash);
367 res = set_insert(env->spills, &spill, sizeof(spill), hash);
373 static ir_node *get_memory_edge(const ir_node *node) {
375 ir_node *result = NULL;
377 arity = get_irn_arity(node);
378 for(i = arity - 1; i >= 0; --i) {
379 ir_node *arg = get_irn_n(node, i);
380 if(get_irn_mode(arg) == mode_M) {
381 assert(result == NULL);
389 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
391 static void check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
393 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
394 node, get_nodes_block(node), get_irg_dump_name(env->irg));
398 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
399 ir_entity *spillent = arch_get_frame_entity(env->arch_env, node);
400 check_entity(env, node, spillent);
401 get_spill(env, node, ent);
403 if(spillent != ent) {
404 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
405 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
406 env->problem_found = 1;
410 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
413 int hash = HASH_PTR(node);
418 assert(is_Proj(node));
420 memperm = get_Proj_pred(node);
421 out = get_Proj_proj(node);
423 spillent = be_get_MemPerm_out_entity(memperm, out);
424 check_entity(env, memperm, spillent);
425 if(spillent != ent) {
426 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
427 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
428 env->problem_found = 1;
432 res = set_find(env->spills, &spill, sizeof(spill), hash);
437 spill.ent = spillent;
438 res = set_insert(env->spills, &spill, sizeof(spill), hash);
440 for(i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
441 ir_node* arg = get_irn_n(memperm, i + 1);
442 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
444 collect(env, arg, memperm, argent);
448 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent) {
451 int hash = HASH_PTR(node);
453 assert(is_Phi(node));
456 res = set_find(env->spills, &spill, sizeof(spill), hash);
462 res = set_insert(env->spills, &spill, sizeof(spill), hash);
464 // is 1 of the arguments a spill?
465 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
466 ir_node* arg = get_irn_n(node, i);
467 collect(env, arg, reload, ent);
471 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
472 if(be_is_Spill(node)) {
473 collect_spill(env, node, reload, ent);
474 } else if(is_Proj(node)) {
475 collect_memperm(env, node, reload, ent);
476 } else if(is_Phi(node) && get_irn_mode(node) == mode_M) {
477 collect_memphi(env, node, reload, ent);
479 // Disabled for now, spills might get transformed by the backend
481 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
482 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
483 env->problem_found = 1;
489 * This walker function searches for reloads and collects all the spills
490 * and memphis attached to them.
492 static void collect_spills_walker(ir_node *node, void *data) {
493 be_verify_spillslots_env_t *env = data;
494 const arch_env_t *arch_env = env->arch_env;
496 // @@@ ia32_classify returns classification of Proj_pred :-/
500 if(arch_irn_class_is(arch_env, node, reload)) {
501 ir_node *spill = get_memory_edge(node);
505 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
506 node, get_nodes_block(node), get_irg_dump_name(env->irg));
507 env->problem_found = 1;
510 ent = arch_get_frame_entity(env->arch_env, node);
511 check_entity(env, node, ent);
513 collect(env, spill, node, ent);
514 ARR_APP1(ir_node*, env->reloads, node);
518 static void check_spillslot_interference(be_verify_spillslots_env_t *env) {
519 int spillcount = set_count(env->spills);
520 spill_t **spills = alloca(spillcount * sizeof(spills[0]));
524 for(spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
528 for(i = 0; i < spillcount; ++i) {
529 spill_t *sp1 = spills[i];
532 for(i2 = i+1; i2 < spillcount; ++i2) {
533 spill_t *sp2 = spills[i2];
535 if(sp1->ent != sp2->ent)
538 if(my_values_interfere(sp1->spill, sp2->spill)) {
539 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
540 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
541 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
542 env->problem_found = 1;
543 my_values_interfere(sp1->spill, sp2->spill);
549 static void check_lonely_spills(ir_node *node, void *data) {
550 be_verify_spillslots_env_t *env = data;
552 if(be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
553 spill_t *spill = find_spill(env, node);
554 if(be_is_Spill(node)) {
555 ir_entity *ent = arch_get_frame_entity(env->arch_env, node);
556 check_entity(env, node, ent);
560 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
561 node, get_nodes_block(node), get_irg_dump_name(env->irg));
566 int be_verify_spillslots(const arch_env_t *arch_env, ir_graph *irg)
568 be_verify_spillslots_env_t env;
570 env.arch_env = arch_env;
572 env.spills = new_set(cmp_spill, 10);
573 env.reloads = NEW_ARR_F(ir_node*, 0);
574 env.problem_found = 0;
576 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
577 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
579 check_spillslot_interference(&env);
581 DEL_ARR_F(env.reloads);
584 return ! env.problem_found;
589 //---------------------------------------------------------------------------
594 * Check, if two values interfere.
595 * @param a The first value.
596 * @param b The second value.
597 * @return 1, if a and b interfere, 0 if not.
599 static int my_values_interfere(const ir_node *a, const ir_node *b) {
600 const ir_edge_t *edge;
602 int a2b = value_dominates(a, b);
603 int b2a = value_dominates(b, a);
605 /* If there is no dominance relation, they do not interfere. */
610 * Adjust a and b so, that a dominates b if
611 * a dominates b or vice versa.
614 const ir_node *t = a;
619 bb = get_nodes_block(b);
622 * Look at all usages of a.
623 * If there's one usage of a in the block of b, then
624 * we check, if this use is dominated by b, if that's true
625 * a and b interfere. Note that b must strictly dominate the user,
626 * since if b is the last user of in the block, b and a do not
628 * Uses of a not in b's block can be disobeyed, because the
629 * check for a being live at the end of b's block is already
632 foreach_out_edge(a, edge) {
633 const ir_node *user = get_edge_src_irn(edge);
637 if(get_irn_opcode(user) == iro_End)
640 // in case of phi arguments we compare with the block the value comes from
642 ir_node *phiblock = get_nodes_block(user);
645 user = get_irn_n(phiblock, get_edge_src_pos(edge));
648 if(value_dominates(b, user))
657 //---------------------------------------------------------------------------
661 typedef struct _be_verify_register_allocation_env_t {
662 const arch_env_t *arch_env;
666 } be_verify_register_allocation_env_t;
668 static void check_register_constraints(ir_node *node, be_verify_register_allocation_env_t *env) {
669 const arch_env_t *arch_env = env->arch_env;
670 const arch_register_t *reg;
673 /* verify output register */
674 if (arch_get_irn_reg_class(arch_env, node, -1) != NULL) {
675 reg = arch_get_irn_register(arch_env, node);
677 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
678 node, get_nodes_block(node), get_irg_dump_name(env->irg));
679 env->problem_found = 1;
681 else if (! arch_register_type_is(reg, joker) && !arch_reg_is_allocatable(arch_env, node, -1, reg)) {
682 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
683 reg->name, node, get_nodes_block(node), get_irg_dump_name(env->irg));
684 env->problem_found = 1;
688 /* verify input register */
689 arity = get_irn_arity(node);
690 for (i = 0; i < arity; ++i) {
691 ir_node *pred = get_irn_n(node, i);
693 if (is_Unknown(pred))
697 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
698 node, get_nodes_block(node), get_irg_dump_name(env->irg), i);
699 env->problem_found = 1;
703 if (arch_get_irn_reg_class(arch_env, node, i) == NULL)
706 reg = arch_get_irn_register(arch_env, pred);
708 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
709 pred, get_nodes_block(pred), get_irg_dump_name(env->irg));
710 env->problem_found = 1;
713 else if (! arch_register_type_is(reg, joker) && ! arch_reg_is_allocatable(arch_env, node, i, reg)) {
714 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
715 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(env->irg));
716 env->problem_found = 1;
721 static void check_register_allocation(be_verify_register_allocation_env_t *env,
722 const arch_register_class_t *regclass, pset *nodes) {
723 const arch_env_t *arch_env = env->arch_env;
724 const arch_register_t *reg = NULL;
726 bitset_t *registers = bitset_alloca(arch_register_class_n_regs(regclass));
729 foreach_pset(nodes, node) {
730 if (arch_get_irn_reg_class(arch_env, node, -1) != regclass)
733 reg = arch_get_irn_register(arch_env, node);
735 /* this problem is already reported in 'check_register_constraints' */
739 if (bitset_is_set(registers, reg->index)) {
744 bitset_set(registers, reg->index);
748 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s)\n",
749 reg->name, get_nodes_block(node), get_irg_dump_name(env->irg));
750 env->problem_found = 1;
752 foreach_pset(nodes, node) {
753 if (arch_get_irn_register(arch_env, node) == reg) {
754 ir_fprintf(stderr, " at node %+F\n", node);
760 static void verify_block_register_allocation(ir_node *block, void *data) {
761 be_verify_register_allocation_env_t *env = data;
762 const arch_env_t *arch_env = env->arch_env;
763 const arch_isa_t *isa = arch_env->isa;
766 nregclasses = arch_isa_get_n_reg_class(isa);
767 for (i = 0; i < nregclasses; ++i) {
768 const arch_register_class_t *regclass = arch_isa_get_reg_class(isa, i);
770 pset *live_nodes = pset_new_ptr_default();
772 be_liveness_end_of_block(env->lv, env->arch_env, regclass, block, live_nodes);
773 check_register_allocation(env, regclass, live_nodes);
775 sched_foreach_reverse(block, node) {
779 be_liveness_transfer(env->arch_env, regclass, node, live_nodes);
780 check_register_allocation(env, regclass, live_nodes);
781 check_register_constraints(node, env);
784 del_pset(live_nodes);
788 int be_verify_register_allocation(const arch_env_t *arch_env, ir_graph *irg) {
789 be_verify_register_allocation_env_t env;
791 env.arch_env = arch_env;
793 env.lv = be_liveness(irg);
794 env.problem_found = 0;
796 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, &env);
798 be_liveness_free(env.lv);
800 return !env.problem_found;
805 //---------------------------------------------------------------------------
809 typedef struct _verify_out_dead_nodes_env {
813 } verify_out_dead_nodes_env;
815 static void check_out_edges(ir_node *node, verify_out_dead_nodes_env *env) {
816 ir_graph *irg = env->irg;
817 const ir_edge_t* edge;
819 if(irn_visited(node))
821 mark_irn_visited(node);
823 foreach_out_edge(node, edge) {
824 ir_node* src = get_edge_src_irn(edge);
826 if(!bitset_is_set(env->reachable, get_irn_idx(src)) && !is_Block(node)) {
827 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) only reachable through out edges from %+F\n",
828 src, get_nodes_block(src), get_irg_dump_name(irg), node);
829 env->problem_found = 1;
833 check_out_edges(src, env);
837 static void set_reachable(ir_node *node, void* data)
839 bitset_t* reachable = data;
840 bitset_set(reachable, get_irn_idx(node));
843 int be_verify_out_edges(ir_graph *irg) {
844 verify_out_dead_nodes_env env;
847 env.reachable = bitset_alloca(get_irg_last_idx(irg));
848 env.problem_found = edges_verify(irg);
850 irg_walk_in_or_dep_graph(irg, set_reachable, NULL, env.reachable);
851 irg_walk_anchors(irg, set_reachable, NULL, env.reachable);
852 inc_irg_visited(irg);
853 check_out_edges(get_irg_start(irg), &env);
855 return ! env.problem_found;