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"
48 #include "belistsched.h"
50 static int my_values_interfere(const ir_node *a, const ir_node *b);
52 typedef struct be_verify_register_pressure_env_t_ {
53 ir_graph *irg; /**< the irg to verify */
54 be_lv_t *lv; /**< Liveness information. */
55 const arch_register_class_t *cls; /**< the register class to check for */
56 int registers_available; /**< number of available registers */
57 int problem_found; /**< flag indicating if a problem was found */
58 } be_verify_register_pressure_env_t;
61 * Print all nodes of a pset into a file.
63 static void print_living_values(FILE *F, const ir_nodeset_t *live_nodes)
65 ir_nodeset_iterator_t iter;
69 foreach_ir_nodeset(live_nodes, node, iter) {
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)
80 be_verify_register_pressure_env_t *env = (be_verify_register_pressure_env_t *)data;
81 ir_nodeset_t live_nodes;
85 /* collect register pressure info, start with end of a block */
86 // ir_fprintf(stderr, "liveness check %+F\n", block);
87 ir_nodeset_init(&live_nodes);
88 be_liveness_end_of_block(env->lv, env->cls, block,
91 // print_living_values(stderr, &live_nodes);
92 pressure = ir_nodeset_size(&live_nodes);
93 if (pressure > env->registers_available) {
94 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
95 block, get_irg_dump_name(env->irg), pressure, env->registers_available);
96 print_living_values(stderr, &live_nodes);
97 env->problem_found = 1;
100 sched_foreach_reverse(block, irn) {
104 // print_living_values(stderr, &live_nodes);
105 be_liveness_transfer(env->cls, irn, &live_nodes);
107 pressure = ir_nodeset_size(&live_nodes);
109 if (pressure > env->registers_available) {
110 ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
111 irn, block, get_irg_dump_name(env->irg), pressure, env->registers_available);
112 print_living_values(stderr, &live_nodes);
113 env->problem_found = 1;
117 ir_nodeset_destroy(&live_nodes);
121 * Start a walk over the irg and check the register pressure.
123 int be_verify_register_pressure(ir_graph *irg, const arch_register_class_t *cls)
125 be_verify_register_pressure_env_t env;
127 env.lv = be_liveness(irg);
130 env.registers_available = be_get_n_allocatable_regs(irg, cls);
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 ir_node *cfchange_found = NULL;
161 int last_timestep = INT_MIN;
164 * Tests for the following things:
165 * 1. Make sure that all phi nodes are scheduled at the beginning of the
167 * 2. No value is defined after it has been used
168 * 3. mode_T nodes have all projs scheduled behind them followed by Keeps
169 * (except mode_X projs)
171 sched_foreach(block, node) {
175 /* this node is scheduled */
176 if (bitset_is_set(env->scheduled, get_irn_idx(node))) {
177 ir_fprintf(stderr, "Verify warning: %+F appears to be schedule twice\n");
178 env->problem_found = 1;
180 bitset_set(env->scheduled, get_irn_idx(node));
182 /* Check that scheduled nodes are in the correct block */
183 if (get_nodes_block(node) != block) {
184 ir_fprintf(stderr, "Verify warning: %+F is in block %+F but scheduled in %+F\n", node, get_nodes_block(node), block);
185 env->problem_found = 1;
188 /* Check that timesteps are increasing */
189 timestep = sched_get_time_step(node);
190 if (timestep <= last_timestep) {
191 ir_fprintf(stderr, "Verify warning: Schedule timestep did not increase at node %+F\n",
193 env->problem_found = 1;
195 last_timestep = timestep;
197 /* Check that phis come before any other node */
199 if (non_phi_found != NULL) {
200 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes (for example %+F) in block %+F (%s)\n",
201 node, non_phi_found, block, get_irg_dump_name(env->irg));
202 env->problem_found = 1;
205 non_phi_found = node;
208 /* Check for control flow changing nodes */
210 /* check, that only one CF operation is scheduled */
211 if (cfchange_found != NULL) {
212 ir_fprintf(stderr, "Verify Warning: Additional control flow changing node %+F scheduled after %+F in block %+F (%s)\n",
213 node, block, cfchange_found, get_irg_dump_name(env->irg));
214 env->problem_found = 1;
216 cfchange_found = node;
218 } else if (cfchange_found != NULL) {
219 /* proj and keepany aren't real instructions... */
220 if (!is_Proj(node) && !be_is_Keep(node)) {
221 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node in block %+F (%s)\n",
222 node, block, get_irg_dump_name(env->irg));
223 env->problem_found = 1;
227 /* Check that all uses come before their definitions */
229 sched_timestep_t nodetime = sched_get_time_step(node);
230 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
231 ir_node *arg = get_irn_n(node, i);
232 if (get_nodes_block(arg) != block
233 || !sched_is_scheduled(arg))
236 if (sched_get_time_step(arg) >= nodetime) {
237 ir_fprintf(stderr, "Verify Warning: Value %+F used by %+F before it was defined in block %+F (%s)\n",
238 arg, node, block, get_irg_dump_name(env->irg));
239 env->problem_found = 1;
244 /* Check that no dead nodes are scheduled */
245 if (get_irn_n_edges(node) == 0) {
246 ir_fprintf(stderr, "Verify warning: Node %+F is dead but scheduled in block %+F (%s)\n",
247 node, block, get_irg_dump_name(env->irg));
248 env->problem_found = 1;
251 if (be_is_Keep(node) || be_is_CopyKeep(node)) {
252 /* at least 1 of the keep arguments has to be its schedule
254 int arity = get_irn_arity(node);
256 ir_node *prev = sched_prev(node);
257 while (be_is_Keep(prev) || be_is_CopyKeep(prev))
258 prev = sched_prev(prev);
261 for (i = 0; i < arity; ++i) {
262 ir_node *in = get_irn_n(node, i);
269 prev = sched_prev(prev);
274 ir_fprintf(stderr, "%+F not scheduled after its pred node in block %+F (%s)\n",
275 node, block, get_irg_dump_name(env->irg));
276 env->problem_found = 1;
282 static void check_schedule(ir_node *node, void *data)
284 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*)data;
285 bool should_be = !is_Proj(node) && !(arch_irn_get_flags(node) & arch_irn_flags_not_scheduled);
286 bool scheduled = bitset_is_set(env->scheduled, get_irn_idx(node));
288 if (should_be != scheduled) {
289 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
290 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
291 env->problem_found = 1;
296 * Start a walk over the irg and check schedule.
298 int be_verify_schedule(ir_graph *irg)
300 be_verify_schedule_env_t env;
302 env.problem_found = 0;
304 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
306 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
307 /* check if all nodes are scheduled */
308 irg_walk_graph(irg, check_schedule, NULL, &env);
310 return ! env.problem_found;
315 /*--------------------------------------------------------------------------- */
319 typedef struct spill_t {
329 } be_verify_spillslots_env_t;
331 static int cmp_spill(const void* d1, const void* d2, size_t size)
333 const spill_t* s1 = (const spill_t*)d1;
334 const spill_t* s2 = (const spill_t*)d2;
337 return s1->spill != s2->spill;
340 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
345 return (spill_t*)set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
348 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
351 int hash = HASH_PTR(node);
354 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
358 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
364 static ir_node *get_memory_edge(const ir_node *node)
367 ir_node *result = NULL;
369 arity = get_irn_arity(node);
370 for (i = arity - 1; i >= 0; --i) {
371 ir_node *arg = get_irn_n(node, i);
372 if (get_irn_mode(arg) == mode_M) {
373 assert(result == NULL);
381 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
383 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
386 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
387 node, get_nodes_block(node), get_irg_dump_name(env->irg));
391 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
393 ir_entity *spillent = arch_get_frame_entity(node);
394 be_check_entity(env, node, spillent);
395 get_spill(env, node, ent);
397 if (spillent != ent) {
398 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
399 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
400 env->problem_found = 1;
404 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
408 int hash = HASH_PTR(node);
413 assert(is_Proj(node));
415 memperm = get_Proj_pred(node);
416 out = get_Proj_proj(node);
418 spillent = be_get_MemPerm_out_entity(memperm, out);
419 be_check_entity(env, memperm, spillent);
420 if (spillent != ent) {
421 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
422 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
423 env->problem_found = 1;
427 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
432 spill.ent = spillent;
433 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
435 for (i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
436 ir_node* arg = get_irn_n(memperm, i + 1);
437 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
439 collect(env, arg, memperm, argent);
443 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
447 int hash = HASH_PTR(node);
449 assert(is_Phi(node));
452 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
458 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
460 /* is 1 of the arguments a spill? */
461 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
462 ir_node* arg = get_irn_n(node, i);
463 collect(env, arg, reload, ent);
467 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
469 if (be_is_Spill(node)) {
470 collect_spill(env, node, reload, ent);
471 } else if (is_Proj(node)) {
472 collect_memperm(env, node, reload, ent);
473 } else if (is_Phi(node) && get_irn_mode(node) == mode_M) {
474 collect_memphi(env, node, reload, ent);
476 /* Disabled for now, spills might get transformed by the backend */
478 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
479 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
480 env->problem_found = 1;
486 * This walker function searches for reloads and collects all the spills
487 * and memphis attached to them.
489 static void collect_spills_walker(ir_node *node, void *data)
491 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
493 if (arch_irn_classify(node) & arch_irn_class_reload) {
494 ir_node *spill = get_memory_edge(node);
498 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
499 node, get_nodes_block(node), get_irg_dump_name(env->irg));
500 env->problem_found = 1;
503 ent = arch_get_frame_entity(node);
504 be_check_entity(env, node, ent);
506 collect(env, spill, node, ent);
507 ARR_APP1(ir_node*, env->reloads, node);
511 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
513 int spillcount = set_count(env->spills);
514 spill_t **spills = ALLOCAN(spill_t*, spillcount);
519 foreach_set(env->spills, spill_t*, spill) {
523 for (i = 0; i < spillcount; ++i) {
524 spill_t *sp1 = spills[i];
527 for (i2 = i+1; i2 < spillcount; ++i2) {
528 spill_t *sp2 = spills[i2];
530 if (sp1->ent != sp2->ent)
533 if (my_values_interfere(sp1->spill, sp2->spill)) {
534 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
535 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
536 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
537 env->problem_found = 1;
538 my_values_interfere(sp1->spill, sp2->spill);
544 static void check_lonely_spills(ir_node *node, void *data)
546 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
548 if (be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
549 spill_t *spill = find_spill(env, node);
550 if (be_is_Spill(node)) {
551 ir_entity *ent = arch_get_frame_entity(node);
552 be_check_entity(env, node, ent);
556 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
557 node, get_nodes_block(node), get_irg_dump_name(env->irg));
562 int be_verify_spillslots(ir_graph *irg)
564 be_verify_spillslots_env_t env;
567 env.spills = new_set(cmp_spill, 10);
568 env.reloads = NEW_ARR_F(ir_node*, 0);
569 env.problem_found = 0;
571 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
572 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
574 check_spillslot_interference(&env);
576 DEL_ARR_F(env.reloads);
579 return ! env.problem_found;
584 /*--------------------------------------------------------------------------- */
589 * Check, if two values interfere.
590 * @param a The first value.
591 * @param b The second value.
592 * @return 1, if a and b interfere, 0 if not.
594 static int my_values_interfere(const ir_node *a, const ir_node *b)
596 const ir_edge_t *edge;
598 int a2b = value_dominates(a, b);
599 int b2a = value_dominates(b, a);
601 /* If there is no dominance relation, they do not interfere. */
606 * Adjust a and b so, that a dominates b if
607 * a dominates b or vice versa.
610 const ir_node *t = a;
615 bb = get_nodes_block(b);
618 * Look at all usages of a.
619 * If there's one usage of a in the block of b, then
620 * we check, if this use is dominated by b, if that's true
621 * a and b interfere. Note that b must strictly dominate the user,
622 * since if b is the last user of in the block, b and a do not
624 * Uses of a not in b's block can be disobeyed, because the
625 * check for a being live at the end of b's block is already
628 foreach_out_edge(a, edge) {
629 const ir_node *user = get_edge_src_irn(edge);
633 if (get_irn_opcode(user) == iro_End)
636 /* in case of phi arguments we compare with the block the value comes from */
638 ir_node *phiblock = get_nodes_block(user);
641 user = get_irn_n(phiblock, get_edge_src_pos(edge));
644 if (value_dominates(b, user))
653 /*--------------------------------------------------------------------------- */
655 static const arch_env_t *arch_env;
656 static ir_graph *irg;
658 static int problem_found;
659 static const arch_register_class_t *regclass;
660 static ir_node **registers;
662 static void check_output_constraints(ir_node *node)
664 /* verify output register */
665 if (arch_get_irn_reg_class_out(node) == regclass) {
666 const arch_register_t *reg = arch_get_irn_register(node);
668 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
669 node, get_nodes_block(node), get_irg_dump_name(irg));
671 } else if (!(reg->type & arch_register_type_joker) && !arch_reg_out_is_allocatable(node, reg)) {
672 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
673 reg->name, node, get_nodes_block(node), get_irg_dump_name(irg));
679 static void check_input_constraints(ir_node *node)
681 const arch_register_t *reg;
684 /* verify input register */
685 arity = get_irn_arity(node);
686 for (i = 0; i < arity; ++i) {
687 const arch_register_req_t *req = arch_get_in_register_req(node, i);
688 ir_node *pred = get_irn_n(node, i);
689 const arch_register_req_t *pred_req = arch_get_register_req_out(pred);
692 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
693 node, get_nodes_block(node), get_irg_dump_name(irg), i);
697 if (req->cls == NULL)
700 if (req->width > pred_req->width) {
701 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register width of value at input %d too small\n",
702 node, get_nodes_block(node), get_irg_dump_name(irg), i);
706 reg = arch_get_irn_register(pred);
707 if (req->type & arch_register_req_type_aligned) {
708 if (reg->index % req->width != 0) {
709 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register allignment not fulfilled\n",
710 node, get_nodes_block(node), get_irg_dump_name(irg), i);
716 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned (%+F input constraint)\n",
717 pred, get_nodes_block(pred), get_irg_dump_name(irg), node);
720 } else if (!(reg->type & arch_register_type_joker) && ! arch_reg_is_allocatable(node, i, reg)) {
721 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
722 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(irg));
727 /* phis should be NOPs at this point, which means all input regs
728 * must be the same as the output reg */
732 reg = arch_get_irn_register(node);
734 arity = get_irn_arity(node);
735 for (i = 0; i < arity; ++i) {
736 ir_node *pred = get_Phi_pred(node, i);
737 const arch_register_t *pred_reg = arch_get_irn_register(pred);
739 if (reg != pred_reg && !(pred_reg->type & arch_register_type_joker)) {
740 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
741 const char *reg_name = reg != NULL ? reg->name : "(null)";
742 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
743 i, node, get_nodes_block(node),
744 get_irg_dump_name(irg), pred_name, reg_name);
751 static void value_used(ir_node *block, ir_node *node)
753 const arch_register_t *reg;
756 if (arch_get_irn_reg_class_out(node) != regclass)
759 reg = arch_get_irn_register(node);
760 if (reg == NULL || reg->type & arch_register_type_virtual)
763 reg_node = registers[reg->index];
764 if (reg_node != NULL && reg_node != node) {
765 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
766 reg->name, block, get_irg_dump_name(irg),
771 registers[reg->index] = node;
774 static void value_def(ir_node *node)
776 const arch_register_t *reg;
779 if (arch_get_irn_reg_class_out(node) != regclass)
782 reg = arch_get_irn_register(node);
783 if (reg == NULL || reg->type & arch_register_type_virtual)
786 reg_node = registers[reg->index];
788 if (reg_node != node) {
789 ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
790 node, reg->name, reg_node, get_nodes_block(node), get_irg_dump_name(irg));
793 registers[reg->index] = NULL;
796 static void verify_block_register_allocation(ir_node *block, void *data)
801 nregclasses = arch_env->n_register_classes;
802 for (i = 0; i < nregclasses; ++i) {
806 regclass = &arch_env->register_classes[i];
808 assert(lv->nodes && "live sets must be computed");
810 n_regs = arch_register_class_n_regs(regclass);
811 registers = ALLOCANZ(ir_node*, n_regs);
813 be_lv_foreach(lv, block, be_lv_state_end, idx) {
814 ir_node *node = be_lv_get_irn(lv, block, idx);
815 value_used(block, node);
818 sched_foreach_reverse(block, node) {
821 if (get_irn_mode(node) == mode_T) {
822 const ir_edge_t *edge;
823 foreach_out_edge(node, edge) {
824 ir_node *def = get_edge_src_irn(edge);
826 check_output_constraints(def);
830 check_output_constraints(node);
833 check_input_constraints(node);
835 /* process uses. (Phi inputs are no real uses) */
837 arity = get_irn_arity(node);
838 for (i2 = 0; i2 < arity; ++i2) {
839 ir_node *use = get_irn_n(node, i2);
840 value_used(block, use);
845 be_lv_foreach(lv, block, be_lv_state_in, idx) {
846 ir_node *node = be_lv_get_irn(lv, block, idx);
850 /* set must be empty now */
851 for (i2 = 0; i2 < n_regs; ++i2) {
852 if (registers[i2] == NULL)
855 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
856 registers[i2], block, get_irg_dump_name(irg));
862 int be_verify_register_allocation(ir_graph *new_irg)
865 arch_env = be_get_irg_arch_env(irg);
866 lv = be_liveness(irg);
869 be_liveness_assure_sets(lv);
870 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
872 be_liveness_free(lv);
874 return !problem_found;