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 = be_get_n_allocatable_regs(irg, cls);
130 env.problem_found = 0;
132 be_liveness_assure_sets(env.lv);
133 irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
134 be_liveness_free(env.lv);
136 return ! env.problem_found;
141 /*--------------------------------------------------------------------------- */
145 typedef struct be_verify_schedule_env_t_ {
146 int problem_found; /**< flags indicating a problem */
147 bitset_t *scheduled; /**< bitset of scheduled nodes */
148 ir_graph *irg; /**< the irg to check */
149 } be_verify_schedule_env_t;
152 * Simple schedule checker.
154 static void verify_schedule_walker(ir_node *block, void *data)
156 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
158 ir_node *non_phi_found = NULL;
159 ir_node *cfchange_found = NULL;
160 int last_timestep = INT_MIN;
163 * Tests for the following things:
164 * 1. Make sure that all phi nodes are scheduled at the beginning of the
166 * 2. No value is defined after it has been used
167 * 3. mode_T nodes have all projs scheduled behind them followed by Keeps
168 * (except mode_X projs)
170 sched_foreach(block, node) {
174 /* this node is scheduled */
175 if (bitset_is_set(env->scheduled, get_irn_idx(node))) {
176 ir_fprintf(stderr, "Verify warning: %+F appears to be schedule twice\n");
177 env->problem_found = 1;
179 bitset_set(env->scheduled, get_irn_idx(node));
181 /* Check that scheduled nodes are in the correct block */
182 if (get_nodes_block(node) != block) {
183 ir_fprintf(stderr, "Verify warning: %+F is in block %+F but scheduled in %+F\n", node, get_nodes_block(node), block);
184 env->problem_found = 1;
187 /* Check that timesteps are increasing */
188 timestep = sched_get_time_step(node);
189 if (timestep <= last_timestep) {
190 ir_fprintf(stderr, "Verify warning: Schedule timestep did not increase at node %+F\n",
192 env->problem_found = 1;
194 last_timestep = timestep;
196 /* Check that phis come before any other node */
198 if (non_phi_found != NULL) {
199 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes (for example %+F) in block %+F (%s)\n",
200 node, non_phi_found, block, get_irg_dump_name(env->irg));
201 env->problem_found = 1;
204 non_phi_found = node;
207 /* Check for control flow changing nodes */
209 /* check, that only one CF operation is scheduled */
210 if (cfchange_found != NULL) {
211 ir_fprintf(stderr, "Verify Warning: Additional control flow changing node %+F scheduled after %+F in block %+F (%s)\n",
212 node, block, cfchange_found, get_irg_dump_name(env->irg));
213 env->problem_found = 1;
215 cfchange_found = node;
217 } else if (cfchange_found != NULL) {
218 /* proj and keepany aren't real instructions... */
219 if (!is_Proj(node) && !be_is_Keep(node)) {
220 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node in block %+F (%s)\n",
221 node, block, get_irg_dump_name(env->irg));
222 env->problem_found = 1;
226 /* Check that all uses come before their definitions */
228 int nodetime = sched_get_time_step(node);
229 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
230 ir_node *arg = get_irn_n(node, i);
231 if (get_nodes_block(arg) != block
232 || !sched_is_scheduled(arg))
235 if (sched_get_time_step(arg) >= nodetime) {
236 ir_fprintf(stderr, "Verify Warning: Value %+F used by %+F before it was defined in block %+F (%s)\n",
237 arg, node, block, get_irg_dump_name(env->irg));
238 env->problem_found = 1;
243 /* Check that no dead nodes are scheduled */
244 if (get_irn_n_edges(node) == 0) {
245 ir_fprintf(stderr, "Verify warning: Node %+F is dead but scheduled in block %+F (%s)\n",
246 node, block, get_irg_dump_name(env->irg));
247 env->problem_found = 1;
250 if (be_is_Keep(node) || be_is_CopyKeep(node)) {
251 /* at least 1 of the keep arguments has to be its schedule
253 int arity = get_irn_arity(node);
255 ir_node *prev = sched_prev(node);
256 while (be_is_Keep(prev) || be_is_CopyKeep(prev))
257 prev = sched_prev(prev);
260 for (i = 0; i < arity; ++i) {
261 ir_node *in = get_irn_n(node, i);
268 prev = sched_prev(prev);
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;
281 static void check_schedule(ir_node *node, void *data)
283 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*)data;
284 bool should_be = to_appear_in_schedule(node);
285 bool scheduled = bitset_is_set(env->scheduled, get_irn_idx(node));
287 if (should_be != scheduled) {
288 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
289 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
290 env->problem_found = 1;
295 * Start a walk over the irg and check schedule.
297 int be_verify_schedule(ir_graph *irg)
299 be_verify_schedule_env_t env;
301 env.problem_found = 0;
303 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
305 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
306 /* check if all nodes are scheduled */
307 irg_walk_graph(irg, check_schedule, NULL, &env);
309 return ! env.problem_found;
314 /*--------------------------------------------------------------------------- */
318 typedef struct spill_t {
328 } be_verify_spillslots_env_t;
330 static int cmp_spill(const void* d1, const void* d2, size_t size)
332 const spill_t* s1 = (const spill_t*)d1;
333 const spill_t* s2 = (const spill_t*)d2;
336 return s1->spill != s2->spill;
339 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
344 return (spill_t*)set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
347 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
350 int hash = HASH_PTR(node);
353 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
357 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
363 static ir_node *get_memory_edge(const ir_node *node)
366 ir_node *result = NULL;
368 arity = get_irn_arity(node);
369 for (i = arity - 1; i >= 0; --i) {
370 ir_node *arg = get_irn_n(node, i);
371 if (get_irn_mode(arg) == mode_M) {
372 assert(result == NULL);
380 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
382 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
385 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
386 node, get_nodes_block(node), get_irg_dump_name(env->irg));
390 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
392 ir_entity *spillent = arch_get_frame_entity(node);
393 be_check_entity(env, node, spillent);
394 get_spill(env, node, ent);
396 if (spillent != ent) {
397 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
398 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
399 env->problem_found = 1;
403 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
407 int hash = HASH_PTR(node);
412 assert(is_Proj(node));
414 memperm = get_Proj_pred(node);
415 out = get_Proj_proj(node);
417 spillent = be_get_MemPerm_out_entity(memperm, out);
418 be_check_entity(env, memperm, spillent);
419 if (spillent != ent) {
420 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
421 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
422 env->problem_found = 1;
426 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
431 spill.ent = spillent;
432 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
434 for (i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
435 ir_node* arg = get_irn_n(memperm, i + 1);
436 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
438 collect(env, arg, memperm, argent);
442 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
446 int hash = HASH_PTR(node);
448 assert(is_Phi(node));
451 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
457 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
459 /* is 1 of the arguments a spill? */
460 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
461 ir_node* arg = get_irn_n(node, i);
462 collect(env, arg, reload, ent);
466 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
468 if (be_is_Spill(node)) {
469 collect_spill(env, node, reload, ent);
470 } else if (is_Proj(node)) {
471 collect_memperm(env, node, reload, ent);
472 } else if (is_Phi(node) && get_irn_mode(node) == mode_M) {
473 collect_memphi(env, node, reload, ent);
475 /* Disabled for now, spills might get transformed by the backend */
477 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
478 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
479 env->problem_found = 1;
485 * This walker function searches for reloads and collects all the spills
486 * and memphis attached to them.
488 static void collect_spills_walker(ir_node *node, void *data)
490 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
492 if (arch_irn_classify(node) & arch_irn_class_reload) {
493 ir_node *spill = get_memory_edge(node);
497 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
498 node, get_nodes_block(node), get_irg_dump_name(env->irg));
499 env->problem_found = 1;
502 ent = arch_get_frame_entity(node);
503 be_check_entity(env, node, ent);
505 collect(env, spill, node, ent);
506 ARR_APP1(ir_node*, env->reloads, node);
510 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
512 int spillcount = set_count(env->spills);
513 spill_t **spills = ALLOCAN(spill_t*, spillcount);
518 foreach_set(env->spills, spill_t*, spill) {
522 for (i = 0; i < spillcount; ++i) {
523 spill_t *sp1 = spills[i];
526 for (i2 = i+1; i2 < spillcount; ++i2) {
527 spill_t *sp2 = spills[i2];
529 if (sp1->ent != sp2->ent)
532 if (my_values_interfere(sp1->spill, sp2->spill)) {
533 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
534 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
535 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
536 env->problem_found = 1;
537 my_values_interfere(sp1->spill, sp2->spill);
543 static void check_lonely_spills(ir_node *node, void *data)
545 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
547 if (be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
548 spill_t *spill = find_spill(env, node);
549 if (be_is_Spill(node)) {
550 ir_entity *ent = arch_get_frame_entity(node);
551 be_check_entity(env, node, ent);
555 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
556 node, get_nodes_block(node), get_irg_dump_name(env->irg));
561 int be_verify_spillslots(ir_graph *irg)
563 be_verify_spillslots_env_t env;
566 env.spills = new_set(cmp_spill, 10);
567 env.reloads = NEW_ARR_F(ir_node*, 0);
568 env.problem_found = 0;
570 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
571 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
573 check_spillslot_interference(&env);
575 DEL_ARR_F(env.reloads);
578 return ! env.problem_found;
583 /*--------------------------------------------------------------------------- */
588 * Check, if two values interfere.
589 * @param a The first value.
590 * @param b The second value.
591 * @return 1, if a and b interfere, 0 if not.
593 static int my_values_interfere(const ir_node *a, const ir_node *b)
595 const ir_edge_t *edge;
597 int a2b = value_dominates(a, b);
598 int b2a = value_dominates(b, a);
600 /* If there is no dominance relation, they do not interfere. */
605 * Adjust a and b so, that a dominates b if
606 * a dominates b or vice versa.
609 const ir_node *t = a;
614 bb = get_nodes_block(b);
617 * Look at all usages of a.
618 * If there's one usage of a in the block of b, then
619 * we check, if this use is dominated by b, if that's true
620 * a and b interfere. Note that b must strictly dominate the user,
621 * since if b is the last user of in the block, b and a do not
623 * Uses of a not in b's block can be disobeyed, because the
624 * check for a being live at the end of b's block is already
627 foreach_out_edge(a, edge) {
628 const ir_node *user = get_edge_src_irn(edge);
632 if (get_irn_opcode(user) == iro_End)
635 /* in case of phi arguments we compare with the block the value comes from */
637 ir_node *phiblock = get_nodes_block(user);
640 user = get_irn_n(phiblock, get_edge_src_pos(edge));
643 if (value_dominates(b, user))
652 /*--------------------------------------------------------------------------- */
654 static const arch_env_t *arch_env;
655 static ir_graph *irg;
657 static int problem_found;
658 static const arch_register_class_t *regclass;
659 static ir_node **registers;
661 static void check_output_constraints(ir_node *node)
663 /* verify output register */
664 if (arch_get_irn_reg_class_out(node) == regclass) {
665 const arch_register_t *reg = arch_get_irn_register(node);
667 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
668 node, get_nodes_block(node), get_irg_dump_name(irg));
670 } else if (!(reg->type & arch_register_type_joker) && !arch_reg_out_is_allocatable(node, reg)) {
671 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
672 reg->name, node, get_nodes_block(node), get_irg_dump_name(irg));
678 static void check_input_constraints(ir_node *node)
680 const arch_register_t *reg;
683 /* verify input register */
684 arity = get_irn_arity(node);
685 for (i = 0; i < arity; ++i) {
686 const arch_register_req_t *req = arch_get_in_register_req(node, i);
687 ir_node *pred = get_irn_n(node, i);
688 const arch_register_req_t *pred_req = arch_get_register_req_out(pred);
691 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
692 node, get_nodes_block(node), get_irg_dump_name(irg), i);
696 if (req->cls == NULL)
699 if (req->width > pred_req->width) {
700 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register width of value at input %d too small\n",
701 node, get_nodes_block(node), get_irg_dump_name(irg), i);
705 reg = arch_get_irn_register(pred);
706 if (req->type & arch_register_req_type_aligned) {
707 if (reg->index % req->width != 0) {
708 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register allignment not fulfilled\n",
709 node, get_nodes_block(node), get_irg_dump_name(irg), i);
715 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned (%+F input constraint)\n",
716 pred, get_nodes_block(pred), get_irg_dump_name(irg), node);
719 } else if (!(reg->type & arch_register_type_joker) && ! arch_reg_is_allocatable(node, i, reg)) {
720 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
721 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(irg));
726 /* phis should be NOPs at this point, which means all input regs
727 * must be the same as the output reg */
731 reg = arch_get_irn_register(node);
733 arity = get_irn_arity(node);
734 for (i = 0; i < arity; ++i) {
735 ir_node *pred = get_Phi_pred(node, i);
736 const arch_register_t *pred_reg = arch_get_irn_register(pred);
738 if (reg != pred_reg && !(pred_reg->type & arch_register_type_joker)) {
739 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
740 const char *reg_name = reg != NULL ? reg->name : "(null)";
741 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
742 i, node, get_nodes_block(node),
743 get_irg_dump_name(irg), pred_name, reg_name);
750 static void value_used(ir_node *block, ir_node *node)
752 const arch_register_t *reg;
755 if (arch_get_irn_reg_class_out(node) != regclass)
758 reg = arch_get_irn_register(node);
759 if (reg == NULL || reg->type & arch_register_type_virtual)
762 reg_node = registers[reg->index];
763 if (reg_node != NULL && reg_node != node) {
764 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
765 reg->name, block, get_irg_dump_name(irg),
770 registers[reg->index] = node;
773 static void value_def(ir_node *node)
775 const arch_register_t *reg;
778 if (arch_get_irn_reg_class_out(node) != regclass)
781 reg = arch_get_irn_register(node);
782 if (reg == NULL || reg->type & arch_register_type_virtual)
785 reg_node = registers[reg->index];
787 if (reg_node != node) {
788 ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
789 node, reg->name, reg_node, get_nodes_block(node), get_irg_dump_name(irg));
792 registers[reg->index] = NULL;
795 static void verify_block_register_allocation(ir_node *block, void *data)
800 nregclasses = arch_env->n_register_classes;
801 for (i = 0; i < nregclasses; ++i) {
805 regclass = &arch_env->register_classes[i];
807 assert(lv->nodes && "live sets must be computed");
809 n_regs = arch_register_class_n_regs(regclass);
810 registers = ALLOCANZ(ir_node*, n_regs);
812 be_lv_foreach(lv, block, be_lv_state_end, idx) {
813 ir_node *node = be_lv_get_irn(lv, block, idx);
814 value_used(block, node);
817 sched_foreach_reverse(block, node) {
820 if (get_irn_mode(node) == mode_T) {
821 const ir_edge_t *edge;
822 foreach_out_edge(node, edge) {
823 ir_node *def = get_edge_src_irn(edge);
825 check_output_constraints(def);
829 check_output_constraints(node);
832 check_input_constraints(node);
834 /* process uses. (Phi inputs are no real uses) */
836 arity = get_irn_arity(node);
837 for (i2 = 0; i2 < arity; ++i2) {
838 ir_node *use = get_irn_n(node, i2);
839 value_used(block, use);
844 be_lv_foreach(lv, block, be_lv_state_in, idx) {
845 ir_node *node = be_lv_get_irn(lv, block, idx);
849 /* set must be empty now */
850 for (i2 = 0; i2 < n_regs; ++i2) {
851 if (registers[i2] == NULL)
854 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
855 registers[i2], block, get_irg_dump_name(irg));
861 int be_verify_register_allocation(ir_graph *new_irg)
864 arch_env = be_get_irg_arch_env(irg);
865 lv = be_liveness(irg);
868 be_liveness_assure_sets(lv);
869 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
871 be_liveness_free(lv);
873 return !problem_found;