2 * Copyright (C) 1995-2010 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
47 #include "beintlive_t.h"
49 static int my_values_interfere(const ir_node *a, const ir_node *b);
51 typedef struct be_verify_register_pressure_env_t_ {
52 ir_graph *irg; /**< the irg to verify */
53 be_lv_t *lv; /**< Liveness information. */
54 const arch_register_class_t *cls; /**< the register class to check for */
55 int registers_available; /**< number of available registers */
56 int problem_found; /**< flag indicating if a problem was found */
57 } be_verify_register_pressure_env_t;
60 * Print all nodes of a pset into a file.
62 static void print_living_values(FILE *F, const ir_nodeset_t *live_nodes)
64 ir_nodeset_iterator_t iter;
68 foreach_ir_nodeset(live_nodes, node, iter) {
69 ir_fprintf(F, "%+F ", node);
75 * Check if number of live nodes never exceeds the number of available registers.
77 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 ir_nodeset_t live_nodes;
84 /* collect register pressure info, start with end of a block */
85 // ir_fprintf(stderr, "liveness check %+F\n", block);
86 ir_nodeset_init(&live_nodes);
87 be_liveness_end_of_block(env->lv, env->cls, block,
90 // print_living_values(stderr, &live_nodes);
91 pressure = ir_nodeset_size(&live_nodes);
92 if (pressure > env->registers_available) {
93 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
94 block, get_irg_dump_name(env->irg), pressure, env->registers_available);
95 print_living_values(stderr, &live_nodes);
96 env->problem_found = 1;
99 sched_foreach_reverse(block, irn) {
103 // print_living_values(stderr, &live_nodes);
104 be_liveness_transfer(env->cls, irn, &live_nodes);
106 pressure = ir_nodeset_size(&live_nodes);
108 if (pressure > env->registers_available) {
109 ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
110 irn, block, get_irg_dump_name(env->irg), pressure, env->registers_available);
111 print_living_values(stderr, &live_nodes);
112 env->problem_found = 1;
116 ir_nodeset_destroy(&live_nodes);
120 * Start a walk over the irg and check the register pressure.
122 int be_verify_register_pressure(ir_graph *irg, const arch_register_class_t *cls)
124 be_verify_register_pressure_env_t env;
126 env.lv = be_liveness(irg);
129 env.registers_available
130 = env.cls->n_regs - be_put_ignore_regs(irg, env.cls, NULL);
131 env.problem_found = 0;
133 be_liveness_assure_sets(env.lv);
134 irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
135 be_liveness_free(env.lv);
137 return ! env.problem_found;
142 /*--------------------------------------------------------------------------- */
146 typedef struct be_verify_schedule_env_t_ {
147 int problem_found; /**< flags indicating a problem */
148 bitset_t *scheduled; /**< bitset of scheduled nodes */
149 ir_graph *irg; /**< the irg to check */
150 } be_verify_schedule_env_t;
153 * Simple schedule checker.
155 static void verify_schedule_walker(ir_node *block, void *data)
157 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
159 ir_node *non_phi_found = NULL;
160 int cfchange_found = 0;
161 /* TODO ask arch about delay branches */
162 int delay_branches = 0;
163 int last_timestep = INT_MIN;
166 * Tests for the following things:
167 * 1. Make sure that all phi nodes are scheduled at the beginning of the block
168 * 2. There is 1 or no control flow changing node scheduled and exactly delay_branches operations after it.
169 * 3. No value is defined after it has been used
170 * 4. mode_T nodes have all projs scheduled behind them followed by Keeps
171 * (except mode_X projs)
173 sched_foreach(block, node) {
177 /* this node is scheduled */
178 if (bitset_is_set(env->scheduled, get_irn_idx(node))) {
179 ir_fprintf(stderr, "Verify warning: %+F appears to be schedule twice\n");
180 env->problem_found = 1;
182 bitset_set(env->scheduled, get_irn_idx(node));
184 /* Check that scheduled nodes are in the correct block */
185 if (get_nodes_block(node) != block) {
186 ir_fprintf(stderr, "Verify warning: %+F is in block %+F but scheduled in %+F\n", node, get_nodes_block(node), block);
187 env->problem_found = 1;
190 /* Check that timesteps are increasing */
191 timestep = sched_get_time_step(node);
192 if (timestep <= last_timestep) {
193 ir_fprintf(stderr, "Verify warning: Schedule timestep did not increase at node %+F\n",
195 env->problem_found = 1;
197 last_timestep = timestep;
199 /* Check that phis come before any other node */
201 if (non_phi_found != NULL) {
202 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes (for example %+F) in block %+F (%s)\n",
203 node, non_phi_found, block, get_irg_dump_name(env->irg));
204 env->problem_found = 1;
207 non_phi_found = node;
210 /* Check for control flow changing nodes */
211 if (is_cfop(node) && get_irn_opcode(node) != iro_Start) {
212 /* check, that only one CF operation is scheduled */
213 if (cfchange_found == 1) {
214 ir_fprintf(stderr, "Verify Warning: More than 1 control flow changing node (%+F) scheduled in block %+F (%s)\n",
215 node, block, get_irg_dump_name(env->irg));
216 env->problem_found = 1;
219 } else if (cfchange_found) {
220 /* proj and keepany aren't real instructions... */
221 if (!is_Proj(node) && !be_is_Keep(node)) {
222 /* check for delay branches */
223 if (delay_branches == 0) {
224 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node (+delay branches) in block %+F (%s)\n",
225 node, block, get_irg_dump_name(env->irg));
226 env->problem_found = 1;
233 /* Check that all uses come before their definitions */
235 int nodetime = sched_get_time_step(node);
236 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
237 ir_node *arg = get_irn_n(node, i);
238 if (get_nodes_block(arg) != block
239 || !sched_is_scheduled(arg))
242 if (sched_get_time_step(arg) >= nodetime) {
243 ir_fprintf(stderr, "Verify Warning: Value %+F used by %+F before it was defined in block %+F (%s)\n",
244 arg, node, block, get_irg_dump_name(env->irg));
245 env->problem_found = 1;
250 /* Check that no dead nodes are scheduled */
251 if (get_irn_n_edges(node) == 0) {
252 ir_fprintf(stderr, "Verify warning: Node %+F is dead but scheduled in block %+F (%s)\n",
253 node, block, get_irg_dump_name(env->irg));
254 env->problem_found = 1;
257 if (be_is_Keep(node) || be_is_CopyKeep(node)) {
258 /* at least 1 of the keep arguments has to be it schedule
260 int arity = get_irn_arity(node);
262 ir_node *prev = sched_prev(node);
263 while (be_is_Keep(prev) || be_is_CopyKeep(prev))
264 prev = sched_prev(prev);
266 for (i = 0; i < arity; ++i) {
267 ir_node *in = get_irn_n(node, i);
273 ir_fprintf(stderr, "%+F not scheduled after its pred node in block %+F (%s)\n",
274 node, block, get_irg_dump_name(env->irg));
275 env->problem_found = 1;
280 /* check that all delay branches are filled (at least with NOPs) */
281 if (cfchange_found && delay_branches != 0) {
282 ir_fprintf(stderr, "Verify warning: Not all delay slots filled after jump (%d/%d) in block %+F (%s)\n",
283 block, get_irg_dump_name(env->irg));
284 env->problem_found = 1;
288 static int should_be_scheduled(ir_node *node)
290 switch (get_irn_opcode(node)) {
301 if (get_irn_mode(node) == mode_M)
307 case iro_Unreachable:
313 if (get_irn_mode(node) != mode_T) {
314 if (arch_irn_is_ignore(node))
321 static void check_schedule(ir_node *node, void *data)
323 be_verify_schedule_env_t *env = data;
327 should_be = should_be_scheduled(node);
331 scheduled = bitset_is_set(env->scheduled, get_irn_idx(node)) ? 1 : 0;
332 should_be = should_be ? 1 : 0;
333 if (should_be != scheduled) {
334 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
335 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
336 env->problem_found = 1;
341 * Start a walk over the irg and check schedule.
343 int be_verify_schedule(ir_graph *irg)
345 be_verify_schedule_env_t env;
347 env.problem_found = 0;
349 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
351 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
352 /* check if all nodes are scheduled */
353 irg_walk_graph(irg, check_schedule, NULL, &env);
355 return ! env.problem_found;
360 /*--------------------------------------------------------------------------- */
364 typedef struct _spill_t {
374 } be_verify_spillslots_env_t;
376 static int cmp_spill(const void* d1, const void* d2, size_t size)
378 const spill_t* s1 = d1;
379 const spill_t* s2 = d2;
382 return s1->spill != s2->spill;
385 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
390 return set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
393 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
396 int hash = HASH_PTR(node);
399 res = set_find(env->spills, &spill, sizeof(spill), hash);
403 res = set_insert(env->spills, &spill, sizeof(spill), hash);
409 static ir_node *get_memory_edge(const ir_node *node)
412 ir_node *result = NULL;
414 arity = get_irn_arity(node);
415 for (i = arity - 1; i >= 0; --i) {
416 ir_node *arg = get_irn_n(node, i);
417 if (get_irn_mode(arg) == mode_M) {
418 assert(result == NULL);
426 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
428 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
431 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
432 node, get_nodes_block(node), get_irg_dump_name(env->irg));
436 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
438 ir_entity *spillent = arch_get_frame_entity(node);
439 be_check_entity(env, node, spillent);
440 get_spill(env, node, ent);
442 if (spillent != ent) {
443 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
444 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
445 env->problem_found = 1;
449 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
453 int hash = HASH_PTR(node);
458 assert(is_Proj(node));
460 memperm = get_Proj_pred(node);
461 out = get_Proj_proj(node);
463 spillent = be_get_MemPerm_out_entity(memperm, out);
464 be_check_entity(env, memperm, spillent);
465 if (spillent != ent) {
466 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
467 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
468 env->problem_found = 1;
472 res = set_find(env->spills, &spill, sizeof(spill), hash);
477 spill.ent = spillent;
478 res = set_insert(env->spills, &spill, sizeof(spill), hash);
480 for (i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
481 ir_node* arg = get_irn_n(memperm, i + 1);
482 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
484 collect(env, arg, memperm, argent);
488 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
492 int hash = HASH_PTR(node);
494 assert(is_Phi(node));
497 res = set_find(env->spills, &spill, sizeof(spill), hash);
503 res = set_insert(env->spills, &spill, sizeof(spill), hash);
505 /* is 1 of the arguments a spill? */
506 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
507 ir_node* arg = get_irn_n(node, i);
508 collect(env, arg, reload, ent);
512 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
514 if (be_is_Spill(node)) {
515 collect_spill(env, node, reload, ent);
516 } else if (is_Proj(node)) {
517 collect_memperm(env, node, reload, ent);
518 } else if (is_Phi(node) && get_irn_mode(node) == mode_M) {
519 collect_memphi(env, node, reload, ent);
521 /* Disabled for now, spills might get transformed by the backend */
523 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
524 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
525 env->problem_found = 1;
531 * This walker function searches for reloads and collects all the spills
532 * and memphis attached to them.
534 static void collect_spills_walker(ir_node *node, void *data)
536 be_verify_spillslots_env_t *env = data;
538 if (arch_irn_classify(node) & arch_irn_class_reload) {
539 ir_node *spill = get_memory_edge(node);
543 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
544 node, get_nodes_block(node), get_irg_dump_name(env->irg));
545 env->problem_found = 1;
548 ent = arch_get_frame_entity(node);
549 be_check_entity(env, node, ent);
551 collect(env, spill, node, ent);
552 ARR_APP1(ir_node*, env->reloads, node);
556 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
558 int spillcount = set_count(env->spills);
559 spill_t **spills = ALLOCAN(spill_t*, spillcount);
563 for (spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
567 for (i = 0; i < spillcount; ++i) {
568 spill_t *sp1 = spills[i];
571 for (i2 = i+1; i2 < spillcount; ++i2) {
572 spill_t *sp2 = spills[i2];
574 if (sp1->ent != sp2->ent)
577 if (my_values_interfere(sp1->spill, sp2->spill)) {
578 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
579 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
580 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
581 env->problem_found = 1;
582 my_values_interfere(sp1->spill, sp2->spill);
588 static void check_lonely_spills(ir_node *node, void *data)
590 be_verify_spillslots_env_t *env = data;
592 if (be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
593 spill_t *spill = find_spill(env, node);
594 if (be_is_Spill(node)) {
595 ir_entity *ent = arch_get_frame_entity(node);
596 be_check_entity(env, node, ent);
600 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
601 node, get_nodes_block(node), get_irg_dump_name(env->irg));
606 int be_verify_spillslots(ir_graph *irg)
608 be_verify_spillslots_env_t env;
611 env.spills = new_set(cmp_spill, 10);
612 env.reloads = NEW_ARR_F(ir_node*, 0);
613 env.problem_found = 0;
615 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
616 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
618 check_spillslot_interference(&env);
620 DEL_ARR_F(env.reloads);
623 return ! env.problem_found;
628 /*--------------------------------------------------------------------------- */
633 * Check, if two values interfere.
634 * @param a The first value.
635 * @param b The second value.
636 * @return 1, if a and b interfere, 0 if not.
638 static int my_values_interfere(const ir_node *a, const ir_node *b)
640 const ir_edge_t *edge;
642 int a2b = value_dominates(a, b);
643 int b2a = value_dominates(b, a);
645 /* If there is no dominance relation, they do not interfere. */
650 * Adjust a and b so, that a dominates b if
651 * a dominates b or vice versa.
654 const ir_node *t = a;
659 bb = get_nodes_block(b);
662 * Look at all usages of a.
663 * If there's one usage of a in the block of b, then
664 * we check, if this use is dominated by b, if that's true
665 * a and b interfere. Note that b must strictly dominate the user,
666 * since if b is the last user of in the block, b and a do not
668 * Uses of a not in b's block can be disobeyed, because the
669 * check for a being live at the end of b's block is already
672 foreach_out_edge(a, edge) {
673 const ir_node *user = get_edge_src_irn(edge);
677 if (get_irn_opcode(user) == iro_End)
680 /* in case of phi arguments we compare with the block the value comes from */
682 ir_node *phiblock = get_nodes_block(user);
685 user = get_irn_n(phiblock, get_edge_src_pos(edge));
688 if (value_dominates(b, user))
697 /*--------------------------------------------------------------------------- */
699 static const arch_env_t *arch_env;
700 static ir_graph *irg;
702 static int problem_found;
703 static const arch_register_class_t *regclass;
704 static ir_node **registers;
706 static void check_output_constraints(ir_node *node)
708 /* verify output register */
709 if (arch_get_irn_reg_class_out(node) == regclass) {
710 const arch_register_t *reg = arch_get_irn_register(node);
712 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
713 node, get_nodes_block(node), get_irg_dump_name(irg));
715 } else if (!arch_register_type_is(reg, joker) && !arch_reg_out_is_allocatable(node, reg)) {
716 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
717 reg->name, node, get_nodes_block(node), get_irg_dump_name(irg));
723 static void check_input_constraints(ir_node *node)
725 const arch_register_t *reg;
728 /* verify input register */
729 arity = get_irn_arity(node);
730 for (i = 0; i < arity; ++i) {
731 ir_node *pred = get_irn_n(node, i);
733 if (is_Unknown(pred))
737 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
738 node, get_nodes_block(node), get_irg_dump_name(irg), i);
743 if (arch_get_irn_reg_class(node, i) == NULL)
746 reg = arch_get_irn_register(pred);
748 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned (%+F input constraint)\n",
749 pred, get_nodes_block(pred), get_irg_dump_name(irg), node);
752 } else if (!arch_register_type_is(reg, joker) && ! arch_reg_is_allocatable(node, i, reg)) {
753 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
754 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(irg));
759 /* phis should be NOPs at this point, which means all input regs
760 * must be the same as the output reg */
764 reg = arch_get_irn_register(node);
766 arity = get_irn_arity(node);
767 for (i = 0; i < arity; ++i) {
768 ir_node *pred = get_Phi_pred(node, i);
769 const arch_register_t *pred_reg = arch_get_irn_register(pred);
771 if (reg != pred_reg && !arch_register_type_is(pred_reg, joker)) {
772 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
773 const char *reg_name = reg != NULL ? reg->name : "(null)";
774 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
775 i, node, get_nodes_block(node),
776 get_irg_dump_name(irg), pred_name, reg_name);
783 static void value_used(ir_node *block, ir_node *node)
785 const arch_register_t *reg;
788 if (arch_get_irn_reg_class_out(node) != regclass)
791 reg = arch_get_irn_register(node);
792 if (reg == NULL || reg->type & arch_register_type_virtual)
795 reg_node = registers[reg->index];
796 if (reg_node != NULL && reg_node != node) {
797 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
798 reg->name, block, get_irg_dump_name(irg),
803 registers[reg->index] = node;
806 static void value_def(ir_node *node)
808 const arch_register_t *reg;
811 if (arch_get_irn_reg_class_out(node) != regclass)
814 reg = arch_get_irn_register(node);
815 if (reg == NULL || reg->type & arch_register_type_virtual)
818 reg_node = registers[reg->index];
820 if (reg_node != node) {
821 ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
822 node, reg->name, reg_node, get_nodes_block(node), get_irg_dump_name(irg));
825 registers[reg->index] = NULL;
828 static void verify_block_register_allocation(ir_node *block, void *data)
833 nregclasses = arch_env_get_n_reg_class(arch_env);
834 for (i = 0; i < nregclasses; ++i) {
838 regclass = arch_env_get_reg_class(arch_env, i);
840 assert(lv->nodes && "live sets must be computed");
842 n_regs = arch_register_class_n_regs(regclass);
843 registers = ALLOCANZ(ir_node*, n_regs);
845 be_lv_foreach(lv, block, be_lv_state_end, idx) {
846 ir_node *node = be_lv_get_irn(lv, block, idx);
847 value_used(block, node);
850 sched_foreach_reverse(block, node) {
853 if (get_irn_mode(node) == mode_T) {
854 const ir_edge_t *edge;
855 foreach_out_edge(node, edge) {
856 ir_node *def = get_edge_src_irn(edge);
858 check_output_constraints(def);
862 check_output_constraints(node);
865 check_input_constraints(node);
867 /* process uses. (Phi inputs are no real uses) */
869 arity = get_irn_arity(node);
870 for (i2 = 0; i2 < arity; ++i2) {
871 ir_node *use = get_irn_n(node, i2);
872 value_used(block, use);
877 be_lv_foreach(lv, block, be_lv_state_in, idx) {
878 ir_node *node = be_lv_get_irn(lv, block, idx);
882 /* set must be empty now */
883 for (i2 = 0; i2 < n_regs; ++i2) {
884 if (registers[i2] == NULL)
887 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
888 registers[i2], block, get_irg_dump_name(irg));
894 int be_verify_register_allocation(ir_graph *new_irg)
897 arch_env = be_get_irg_arch_env(irg);
898 lv = be_liveness(irg);
901 be_liveness_assure_sets(lv);
902 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
904 be_liveness_free(lv);
906 return !problem_found;