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"
49 #include "beintlive_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))
269 if(get_irn_mode(node) == mode_X)
271 return should_be_scheduled(env, get_Proj_pred(node));
273 if(be_is_Keep(node) && get_irn_opcode(get_nodes_block(node)) == iro_Bad)
276 switch(get_irn_opcode(node)) {
286 if(arch_irn_get_flags(env->arch_env, node) & arch_irn_flags_ignore)
292 static void check_schedule(ir_node *node, void *data) {
293 be_verify_schedule_env_t *env = data;
297 should_be = should_be_scheduled(env, node);
301 scheduled = bitset_is_set(env->scheduled, get_irn_idx(node)) ? 1 : 0;
302 should_be = should_be ? 1 : 0;
303 if(should_be != scheduled) {
304 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
305 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
306 env->problem_found = 1;
311 * Start a walk over the irg and check schedule.
313 int be_verify_schedule(const be_irg_t *birg)
315 be_verify_schedule_env_t env;
317 env.problem_found = 0;
318 env.irg = be_get_birg_irg(birg);
319 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
320 env.arch_env = birg->main_env->arch_env;
322 irg_block_walk_graph(env.irg, verify_schedule_walker, NULL, &env);
323 // check if all nodes are scheduled
324 irg_walk_graph(env.irg, check_schedule, NULL, &env);
326 return ! env.problem_found;
331 //---------------------------------------------------------------------------
335 typedef struct _spill_t {
341 const arch_env_t *arch_env;
346 } be_verify_spillslots_env_t;
348 static int cmp_spill(const void* d1, const void* d2, size_t size) {
349 const spill_t* s1 = d1;
350 const spill_t* s2 = d2;
351 return s1->spill != s2->spill;
354 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node) {
358 return set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
361 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
363 int hash = HASH_PTR(node);
366 res = set_find(env->spills, &spill, sizeof(spill), hash);
370 res = set_insert(env->spills, &spill, sizeof(spill), hash);
376 static ir_node *get_memory_edge(const ir_node *node) {
378 ir_node *result = NULL;
380 arity = get_irn_arity(node);
381 for(i = arity - 1; i >= 0; --i) {
382 ir_node *arg = get_irn_n(node, i);
383 if(get_irn_mode(arg) == mode_M) {
384 assert(result == NULL);
392 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
394 static void check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent) {
396 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
397 node, get_nodes_block(node), get_irg_dump_name(env->irg));
401 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
402 ir_entity *spillent = arch_get_frame_entity(env->arch_env, node);
403 check_entity(env, node, spillent);
404 get_spill(env, node, ent);
406 if(spillent != ent) {
407 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
408 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
409 env->problem_found = 1;
413 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
416 int hash = HASH_PTR(node);
421 assert(is_Proj(node));
423 memperm = get_Proj_pred(node);
424 out = get_Proj_proj(node);
426 spillent = be_get_MemPerm_out_entity(memperm, out);
427 check_entity(env, memperm, spillent);
428 if(spillent != ent) {
429 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
430 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
431 env->problem_found = 1;
435 res = set_find(env->spills, &spill, sizeof(spill), hash);
440 spill.ent = spillent;
441 res = set_insert(env->spills, &spill, sizeof(spill), hash);
443 for(i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
444 ir_node* arg = get_irn_n(memperm, i + 1);
445 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
447 collect(env, arg, memperm, argent);
451 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent) {
454 int hash = HASH_PTR(node);
456 assert(is_Phi(node));
459 res = set_find(env->spills, &spill, sizeof(spill), hash);
465 res = set_insert(env->spills, &spill, sizeof(spill), hash);
467 // is 1 of the arguments a spill?
468 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
469 ir_node* arg = get_irn_n(node, i);
470 collect(env, arg, reload, ent);
474 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent) {
475 if(be_is_Spill(node)) {
476 collect_spill(env, node, reload, ent);
477 } else if(is_Proj(node)) {
478 collect_memperm(env, node, reload, ent);
479 } else if(is_Phi(node) && get_irn_mode(node) == mode_M) {
480 collect_memphi(env, node, reload, ent);
482 // Disabled for now, spills might get transformed by the backend
484 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
485 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
486 env->problem_found = 1;
492 * This walker function searches for reloads and collects all the spills
493 * and memphis attached to them.
495 static void collect_spills_walker(ir_node *node, void *data) {
496 be_verify_spillslots_env_t *env = data;
497 const arch_env_t *arch_env = env->arch_env;
499 // @@@ ia32_classify returns classification of Proj_pred :-/
503 if(arch_irn_class_is(arch_env, node, reload)) {
504 ir_node *spill = get_memory_edge(node);
508 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
509 node, get_nodes_block(node), get_irg_dump_name(env->irg));
510 env->problem_found = 1;
513 ent = arch_get_frame_entity(env->arch_env, node);
514 check_entity(env, node, ent);
516 collect(env, spill, node, ent);
517 ARR_APP1(ir_node*, env->reloads, node);
521 static void check_spillslot_interference(be_verify_spillslots_env_t *env) {
522 int spillcount = set_count(env->spills);
523 spill_t **spills = alloca(spillcount * sizeof(spills[0]));
527 for(spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
531 for(i = 0; i < spillcount; ++i) {
532 spill_t *sp1 = spills[i];
535 for(i2 = i+1; i2 < spillcount; ++i2) {
536 spill_t *sp2 = spills[i2];
538 if(sp1->ent != sp2->ent)
541 if(my_values_interfere(sp1->spill, sp2->spill)) {
542 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
543 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
544 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
545 env->problem_found = 1;
546 my_values_interfere(sp1->spill, sp2->spill);
552 static void check_lonely_spills(ir_node *node, void *data) {
553 be_verify_spillslots_env_t *env = data;
555 if(be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
556 spill_t *spill = find_spill(env, node);
557 if(be_is_Spill(node)) {
558 ir_entity *ent = arch_get_frame_entity(env->arch_env, node);
559 check_entity(env, node, ent);
563 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
564 node, get_nodes_block(node), get_irg_dump_name(env->irg));
569 int be_verify_spillslots(const arch_env_t *arch_env, ir_graph *irg)
571 be_verify_spillslots_env_t env;
573 env.arch_env = arch_env;
575 env.spills = new_set(cmp_spill, 10);
576 env.reloads = NEW_ARR_F(ir_node*, 0);
577 env.problem_found = 0;
579 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
580 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
582 check_spillslot_interference(&env);
584 DEL_ARR_F(env.reloads);
587 return ! env.problem_found;
592 //---------------------------------------------------------------------------
597 * Check, if two values interfere.
598 * @param a The first value.
599 * @param b The second value.
600 * @return 1, if a and b interfere, 0 if not.
602 static int my_values_interfere(const ir_node *a, const ir_node *b) {
603 const ir_edge_t *edge;
605 int a2b = value_dominates(a, b);
606 int b2a = value_dominates(b, a);
608 /* If there is no dominance relation, they do not interfere. */
613 * Adjust a and b so, that a dominates b if
614 * a dominates b or vice versa.
617 const ir_node *t = a;
622 bb = get_nodes_block(b);
625 * Look at all usages of a.
626 * If there's one usage of a in the block of b, then
627 * we check, if this use is dominated by b, if that's true
628 * a and b interfere. Note that b must strictly dominate the user,
629 * since if b is the last user of in the block, b and a do not
631 * Uses of a not in b's block can be disobeyed, because the
632 * check for a being live at the end of b's block is already
635 foreach_out_edge(a, edge) {
636 const ir_node *user = get_edge_src_irn(edge);
640 if(get_irn_opcode(user) == iro_End)
643 // in case of phi arguments we compare with the block the value comes from
645 ir_node *phiblock = get_nodes_block(user);
648 user = get_irn_n(phiblock, get_edge_src_pos(edge));
651 if(value_dominates(b, user))
660 //---------------------------------------------------------------------------
664 typedef struct _be_verify_register_allocation_env_t {
665 const arch_env_t *arch_env;
669 } be_verify_register_allocation_env_t;
671 static void check_register_constraints(ir_node *node, be_verify_register_allocation_env_t *env) {
672 const arch_env_t *arch_env = env->arch_env;
673 const arch_register_t *reg;
676 /* verify output register */
677 if (arch_get_irn_reg_class(arch_env, node, -1) != NULL) {
678 reg = arch_get_irn_register(arch_env, node);
680 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
681 node, get_nodes_block(node), get_irg_dump_name(env->irg));
682 env->problem_found = 1;
684 else if (! arch_register_type_is(reg, joker) && !arch_reg_is_allocatable(arch_env, node, -1, reg)) {
685 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
686 reg->name, node, get_nodes_block(node), get_irg_dump_name(env->irg));
687 env->problem_found = 1;
691 /* verify input register */
692 arity = get_irn_arity(node);
693 for (i = 0; i < arity; ++i) {
694 ir_node *pred = get_irn_n(node, i);
696 if (is_Unknown(pred))
700 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
701 node, get_nodes_block(node), get_irg_dump_name(env->irg), i);
702 env->problem_found = 1;
706 if (arch_get_irn_reg_class(arch_env, node, i) == NULL)
709 reg = arch_get_irn_register(arch_env, pred);
711 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
712 pred, get_nodes_block(pred), get_irg_dump_name(env->irg));
713 env->problem_found = 1;
716 else if (! arch_register_type_is(reg, joker) && ! arch_reg_is_allocatable(arch_env, node, i, reg)) {
717 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
718 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(env->irg));
719 env->problem_found = 1;
724 static void check_register_allocation(be_verify_register_allocation_env_t *env,
725 const arch_register_class_t *regclass, pset *nodes) {
726 const arch_env_t *arch_env = env->arch_env;
727 const arch_register_t *reg = NULL;
729 bitset_t *registers = bitset_alloca(arch_register_class_n_regs(regclass));
732 foreach_pset(nodes, node) {
733 if (arch_get_irn_reg_class(arch_env, node, -1) != regclass)
736 reg = arch_get_irn_register(arch_env, node);
738 /* this problem is already reported in 'check_register_constraints' */
742 if (bitset_is_set(registers, reg->index)) {
747 bitset_set(registers, reg->index);
751 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s)\n",
752 reg->name, get_nodes_block(node), get_irg_dump_name(env->irg));
753 env->problem_found = 1;
755 foreach_pset(nodes, node) {
756 if (arch_get_irn_register(arch_env, node) == reg) {
757 ir_fprintf(stderr, " at node %+F\n", node);
763 static void verify_block_register_allocation(ir_node *block, void *data) {
764 be_verify_register_allocation_env_t *env = data;
765 const arch_env_t *arch_env = env->arch_env;
766 const arch_isa_t *isa = arch_env->isa;
769 nregclasses = arch_isa_get_n_reg_class(isa);
770 for (i = 0; i < nregclasses; ++i) {
771 const arch_register_class_t *regclass = arch_isa_get_reg_class(isa, i);
773 pset *live_nodes = pset_new_ptr_default();
775 be_liveness_end_of_block(env->lv, env->arch_env, regclass, block, live_nodes);
776 check_register_allocation(env, regclass, live_nodes);
778 sched_foreach_reverse(block, node) {
782 be_liveness_transfer(env->arch_env, regclass, node, live_nodes);
783 check_register_allocation(env, regclass, live_nodes);
784 check_register_constraints(node, env);
787 del_pset(live_nodes);
791 int be_verify_register_allocation(const arch_env_t *arch_env, ir_graph *irg) {
792 be_verify_register_allocation_env_t env;
794 env.arch_env = arch_env;
796 env.lv = be_liveness(irg);
797 env.problem_found = 0;
799 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, &env);
801 be_liveness_free(env.lv);
803 return !env.problem_found;
808 //---------------------------------------------------------------------------
812 typedef struct _verify_out_dead_nodes_env {
816 } verify_out_dead_nodes_env;
818 static void check_out_edges(ir_node *node, verify_out_dead_nodes_env *env) {
819 ir_graph *irg = env->irg;
820 const ir_edge_t* edge;
822 if(irn_visited(node))
824 mark_irn_visited(node);
826 foreach_out_edge(node, edge) {
827 ir_node* src = get_edge_src_irn(edge);
829 if(!bitset_is_set(env->reachable, get_irn_idx(src)) && !is_Block(node)) {
830 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) only reachable through out edges from %+F\n",
831 src, get_nodes_block(src), get_irg_dump_name(irg), node);
832 env->problem_found = 1;
836 check_out_edges(src, env);
840 static void set_reachable(ir_node *node, void* data)
842 bitset_t* reachable = data;
843 bitset_set(reachable, get_irn_idx(node));
846 int be_verify_out_edges(ir_graph *irg) {
847 verify_out_dead_nodes_env env;
850 env.reachable = bitset_alloca(get_irg_last_idx(irg));
851 env.problem_found = edges_verify(irg);
853 irg_walk_in_or_dep_graph(irg, set_reachable, NULL, env.reachable);
854 irg_walk_anchors(irg, set_reachable, NULL, env.reachable);
855 inc_irg_visited(irg);
856 check_out_edges(get_irg_start(irg), &env);
858 return ! env.problem_found;