2 * Copyright (C) 1995-2008 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)
312 if (get_irn_mode(node) != mode_T) {
313 if (arch_irn_is_ignore(node))
320 static void check_schedule(ir_node *node, void *data)
322 be_verify_schedule_env_t *env = data;
326 should_be = should_be_scheduled(node);
330 scheduled = bitset_is_set(env->scheduled, get_irn_idx(node)) ? 1 : 0;
331 should_be = should_be ? 1 : 0;
332 if (should_be != scheduled) {
333 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
334 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
335 env->problem_found = 1;
340 * Start a walk over the irg and check schedule.
342 int be_verify_schedule(ir_graph *irg)
344 be_verify_schedule_env_t env;
346 env.problem_found = 0;
348 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
350 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
351 /* check if all nodes are scheduled */
352 irg_walk_graph(irg, check_schedule, NULL, &env);
354 return ! env.problem_found;
359 /*--------------------------------------------------------------------------- */
363 typedef struct _spill_t {
373 } be_verify_spillslots_env_t;
375 static int cmp_spill(const void* d1, const void* d2, size_t size)
377 const spill_t* s1 = d1;
378 const spill_t* s2 = d2;
381 return s1->spill != s2->spill;
384 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
389 return set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
392 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
395 int hash = HASH_PTR(node);
398 res = set_find(env->spills, &spill, sizeof(spill), hash);
402 res = set_insert(env->spills, &spill, sizeof(spill), hash);
408 static ir_node *get_memory_edge(const ir_node *node)
411 ir_node *result = NULL;
413 arity = get_irn_arity(node);
414 for (i = arity - 1; i >= 0; --i) {
415 ir_node *arg = get_irn_n(node, i);
416 if (get_irn_mode(arg) == mode_M) {
417 assert(result == NULL);
425 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
427 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
430 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
431 node, get_nodes_block(node), get_irg_dump_name(env->irg));
435 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
437 ir_entity *spillent = arch_get_frame_entity(node);
438 be_check_entity(env, node, spillent);
439 get_spill(env, node, ent);
441 if (spillent != ent) {
442 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
443 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
444 env->problem_found = 1;
448 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
452 int hash = HASH_PTR(node);
457 assert(is_Proj(node));
459 memperm = get_Proj_pred(node);
460 out = get_Proj_proj(node);
462 spillent = be_get_MemPerm_out_entity(memperm, out);
463 be_check_entity(env, memperm, spillent);
464 if (spillent != ent) {
465 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
466 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
467 env->problem_found = 1;
471 res = set_find(env->spills, &spill, sizeof(spill), hash);
476 spill.ent = spillent;
477 res = set_insert(env->spills, &spill, sizeof(spill), hash);
479 for (i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
480 ir_node* arg = get_irn_n(memperm, i + 1);
481 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
483 collect(env, arg, memperm, argent);
487 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
491 int hash = HASH_PTR(node);
493 assert(is_Phi(node));
496 res = set_find(env->spills, &spill, sizeof(spill), hash);
502 res = set_insert(env->spills, &spill, sizeof(spill), hash);
504 /* is 1 of the arguments a spill? */
505 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
506 ir_node* arg = get_irn_n(node, i);
507 collect(env, arg, reload, ent);
511 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
513 if (be_is_Spill(node)) {
514 collect_spill(env, node, reload, ent);
515 } else if (is_Proj(node)) {
516 collect_memperm(env, node, reload, ent);
517 } else if (is_Phi(node) && get_irn_mode(node) == mode_M) {
518 collect_memphi(env, node, reload, ent);
520 /* Disabled for now, spills might get transformed by the backend */
522 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
523 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
524 env->problem_found = 1;
530 * This walker function searches for reloads and collects all the spills
531 * and memphis attached to them.
533 static void collect_spills_walker(ir_node *node, void *data)
535 be_verify_spillslots_env_t *env = data;
537 if (arch_irn_classify(node) & arch_irn_class_reload) {
538 ir_node *spill = get_memory_edge(node);
542 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
543 node, get_nodes_block(node), get_irg_dump_name(env->irg));
544 env->problem_found = 1;
547 ent = arch_get_frame_entity(node);
548 be_check_entity(env, node, ent);
550 collect(env, spill, node, ent);
551 ARR_APP1(ir_node*, env->reloads, node);
555 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
557 int spillcount = set_count(env->spills);
558 spill_t **spills = ALLOCAN(spill_t*, spillcount);
562 for (spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
566 for (i = 0; i < spillcount; ++i) {
567 spill_t *sp1 = spills[i];
570 for (i2 = i+1; i2 < spillcount; ++i2) {
571 spill_t *sp2 = spills[i2];
573 if (sp1->ent != sp2->ent)
576 if (my_values_interfere(sp1->spill, sp2->spill)) {
577 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
578 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
579 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
580 env->problem_found = 1;
581 my_values_interfere(sp1->spill, sp2->spill);
587 static void check_lonely_spills(ir_node *node, void *data)
589 be_verify_spillslots_env_t *env = data;
591 if (be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
592 spill_t *spill = find_spill(env, node);
593 if (be_is_Spill(node)) {
594 ir_entity *ent = arch_get_frame_entity(node);
595 be_check_entity(env, node, ent);
599 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
600 node, get_nodes_block(node), get_irg_dump_name(env->irg));
605 int be_verify_spillslots(ir_graph *irg)
607 be_verify_spillslots_env_t env;
610 env.spills = new_set(cmp_spill, 10);
611 env.reloads = NEW_ARR_F(ir_node*, 0);
612 env.problem_found = 0;
614 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
615 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
617 check_spillslot_interference(&env);
619 DEL_ARR_F(env.reloads);
622 return ! env.problem_found;
627 /*--------------------------------------------------------------------------- */
632 * Check, if two values interfere.
633 * @param a The first value.
634 * @param b The second value.
635 * @return 1, if a and b interfere, 0 if not.
637 static int my_values_interfere(const ir_node *a, const ir_node *b)
639 const ir_edge_t *edge;
641 int a2b = value_dominates(a, b);
642 int b2a = value_dominates(b, a);
644 /* If there is no dominance relation, they do not interfere. */
649 * Adjust a and b so, that a dominates b if
650 * a dominates b or vice versa.
653 const ir_node *t = a;
658 bb = get_nodes_block(b);
661 * Look at all usages of a.
662 * If there's one usage of a in the block of b, then
663 * we check, if this use is dominated by b, if that's true
664 * a and b interfere. Note that b must strictly dominate the user,
665 * since if b is the last user of in the block, b and a do not
667 * Uses of a not in b's block can be disobeyed, because the
668 * check for a being live at the end of b's block is already
671 foreach_out_edge(a, edge) {
672 const ir_node *user = get_edge_src_irn(edge);
676 if (get_irn_opcode(user) == iro_End)
679 /* in case of phi arguments we compare with the block the value comes from */
681 ir_node *phiblock = get_nodes_block(user);
684 user = get_irn_n(phiblock, get_edge_src_pos(edge));
687 if (value_dominates(b, user))
696 /*--------------------------------------------------------------------------- */
698 static const arch_env_t *arch_env;
699 static ir_graph *irg;
701 static int problem_found;
702 static const arch_register_class_t *regclass;
703 static ir_node **registers;
705 static void check_output_constraints(ir_node *node)
707 /* verify output register */
708 if (arch_get_irn_reg_class_out(node) == regclass) {
709 const arch_register_t *reg = arch_get_irn_register(node);
711 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
712 node, get_nodes_block(node), get_irg_dump_name(irg));
714 } else if (!arch_register_type_is(reg, joker) && !arch_reg_out_is_allocatable(node, reg)) {
715 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
716 reg->name, node, get_nodes_block(node), get_irg_dump_name(irg));
722 static void check_input_constraints(ir_node *node)
724 const arch_register_t *reg;
727 /* verify input register */
728 arity = get_irn_arity(node);
729 for (i = 0; i < arity; ++i) {
730 ir_node *pred = get_irn_n(node, i);
732 if (is_Unknown(pred))
736 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
737 node, get_nodes_block(node), get_irg_dump_name(irg), i);
742 if (arch_get_irn_reg_class(node, i) == NULL)
745 reg = arch_get_irn_register(pred);
747 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned (%+F input constraint)\n",
748 pred, get_nodes_block(pred), get_irg_dump_name(irg), node);
751 } else if (!arch_register_type_is(reg, joker) && ! arch_reg_is_allocatable(node, i, reg)) {
752 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
753 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(irg));
758 /* phis should be NOPs at this point, which means all input regs
759 * must be the same as the output reg */
763 reg = arch_get_irn_register(node);
765 arity = get_irn_arity(node);
766 for (i = 0; i < arity; ++i) {
767 ir_node *pred = get_Phi_pred(node, i);
768 const arch_register_t *pred_reg = arch_get_irn_register(pred);
770 if (reg != pred_reg && !arch_register_type_is(pred_reg, joker)) {
771 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
772 const char *reg_name = reg != NULL ? reg->name : "(null)";
773 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
774 i, node, get_nodes_block(node),
775 get_irg_dump_name(irg), pred_name, reg_name);
782 static void value_used(ir_node *block, ir_node *node)
784 const arch_register_t *reg;
787 if (arch_get_irn_reg_class_out(node) != regclass)
790 reg = arch_get_irn_register(node);
791 if (reg == NULL || reg->type & arch_register_type_virtual)
794 reg_node = registers[reg->index];
795 if (reg_node != NULL && reg_node != node) {
796 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
797 reg->name, block, get_irg_dump_name(irg),
802 registers[reg->index] = node;
805 static void value_def(ir_node *node)
807 const arch_register_t *reg;
810 if (arch_get_irn_reg_class_out(node) != regclass)
813 reg = arch_get_irn_register(node);
814 if (reg == NULL || reg->type & arch_register_type_virtual)
817 reg_node = registers[reg->index];
819 if (reg_node != node) {
820 ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
821 node, reg->name, reg_node, get_nodes_block(node), get_irg_dump_name(irg));
824 registers[reg->index] = NULL;
827 static void verify_block_register_allocation(ir_node *block, void *data)
832 nregclasses = arch_env_get_n_reg_class(arch_env);
833 for (i = 0; i < nregclasses; ++i) {
837 regclass = arch_env_get_reg_class(arch_env, i);
839 assert(lv->nodes && "live sets must be computed");
841 n_regs = arch_register_class_n_regs(regclass);
842 registers = ALLOCANZ(ir_node*, n_regs);
844 be_lv_foreach(lv, block, be_lv_state_end, idx) {
845 ir_node *node = be_lv_get_irn(lv, block, idx);
846 value_used(block, node);
849 sched_foreach_reverse(block, node) {
852 if (get_irn_mode(node) == mode_T) {
853 const ir_edge_t *edge;
854 foreach_out_edge(node, edge) {
855 ir_node *def = get_edge_src_irn(edge);
857 check_output_constraints(def);
861 check_output_constraints(node);
864 check_input_constraints(node);
866 /* process uses. (Phi inputs are no real uses) */
868 arity = get_irn_arity(node);
869 for (i2 = 0; i2 < arity; ++i2) {
870 ir_node *use = get_irn_n(node, i2);
871 value_used(block, use);
876 be_lv_foreach(lv, block, be_lv_state_in, idx) {
877 ir_node *node = be_lv_get_irn(lv, block, idx);
881 /* set must be empty now */
882 for (i2 = 0; i2 < n_regs; ++i2) {
883 if (registers[i2] == NULL)
886 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
887 registers[i2], block, get_irg_dump_name(irg));
893 int be_verify_register_allocation(ir_graph *new_irg)
896 arch_env = be_get_irg_arch_env(irg);
897 lv = be_liveness(irg);
900 be_liveness_assure_sets(lv);
901 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
903 be_liveness_free(lv);
905 return !problem_found;