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 int cfchange_found = 0;
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 */
208 if (is_cfop(node) && get_irn_opcode(node) != iro_Start) {
209 /* check, that only one CF operation is scheduled */
210 if (cfchange_found == 1) {
211 ir_fprintf(stderr, "Verify Warning: More than 1 control flow changing node (%+F) scheduled in block %+F (%s)\n",
212 node, block, get_irg_dump_name(env->irg));
213 env->problem_found = 1;
216 } else if (cfchange_found) {
217 /* proj and keepany aren't real instructions... */
218 if (!is_Proj(node) && !be_is_Keep(node)) {
219 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node in block %+F (%s)\n",
220 node, block, get_irg_dump_name(env->irg));
221 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;
249 if (be_is_Keep(node) || be_is_CopyKeep(node)) {
250 /* at least 1 of the keep arguments has to be its schedule
252 int arity = get_irn_arity(node);
254 ir_node *prev = sched_prev(node);
255 while (be_is_Keep(prev) || be_is_CopyKeep(prev))
256 prev = sched_prev(prev);
259 for (i = 0; i < arity; ++i) {
260 ir_node *in = get_irn_n(node, i);
267 prev = sched_prev(prev);
272 ir_fprintf(stderr, "%+F not scheduled after its pred node in block %+F (%s)\n",
273 node, block, get_irg_dump_name(env->irg));
274 env->problem_found = 1;
280 static void check_schedule(ir_node *node, void *data)
282 be_verify_schedule_env_t *env = (be_verify_schedule_env_t*)data;
283 bool should_be = to_appear_in_schedule(node);
284 bool scheduled = bitset_is_set(env->scheduled, get_irn_idx(node));
286 if (should_be != scheduled) {
287 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
288 node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : " not");
289 env->problem_found = 1;
294 * Start a walk over the irg and check schedule.
296 int be_verify_schedule(ir_graph *irg)
298 be_verify_schedule_env_t env;
300 env.problem_found = 0;
302 env.scheduled = bitset_alloca(get_irg_last_idx(env.irg));
304 irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
305 /* check if all nodes are scheduled */
306 irg_walk_graph(irg, check_schedule, NULL, &env);
308 return ! env.problem_found;
313 /*--------------------------------------------------------------------------- */
317 typedef struct spill_t {
327 } be_verify_spillslots_env_t;
329 static int cmp_spill(const void* d1, const void* d2, size_t size)
331 const spill_t* s1 = (const spill_t*)d1;
332 const spill_t* s2 = (const spill_t*)d2;
335 return s1->spill != s2->spill;
338 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
343 return (spill_t*)set_find(env->spills, &spill, sizeof(spill), HASH_PTR(node));
346 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
349 int hash = HASH_PTR(node);
352 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
356 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
362 static ir_node *get_memory_edge(const ir_node *node)
365 ir_node *result = NULL;
367 arity = get_irn_arity(node);
368 for (i = arity - 1; i >= 0; --i) {
369 ir_node *arg = get_irn_n(node, i);
370 if (get_irn_mode(arg) == mode_M) {
371 assert(result == NULL);
379 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
381 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
384 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have an entity assigned\n",
385 node, get_nodes_block(node), get_irg_dump_name(env->irg));
389 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
391 ir_entity *spillent = arch_get_frame_entity(node);
392 be_check_entity(env, node, spillent);
393 get_spill(env, node, ent);
395 if (spillent != ent) {
396 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
397 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
398 env->problem_found = 1;
402 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
406 int hash = HASH_PTR(node);
411 assert(is_Proj(node));
413 memperm = get_Proj_pred(node);
414 out = get_Proj_proj(node);
416 spillent = be_get_MemPerm_out_entity(memperm, out);
417 be_check_entity(env, memperm, spillent);
418 if (spillent != ent) {
419 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
420 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
421 env->problem_found = 1;
425 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
430 spill.ent = spillent;
431 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
433 for (i = 0, arity = be_get_MemPerm_entity_arity(memperm); i < arity; ++i) {
434 ir_node* arg = get_irn_n(memperm, i + 1);
435 ir_entity* argent = be_get_MemPerm_in_entity(memperm, i);
437 collect(env, arg, memperm, argent);
441 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
445 int hash = HASH_PTR(node);
447 assert(is_Phi(node));
450 res = (spill_t*)set_find(env->spills, &spill, sizeof(spill), hash);
456 res = (spill_t*)set_insert(env->spills, &spill, sizeof(spill), hash);
458 /* is 1 of the arguments a spill? */
459 for (i = 0, arity = get_irn_arity(node); i < arity; ++i) {
460 ir_node* arg = get_irn_n(node, i);
461 collect(env, arg, reload, ent);
465 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
467 if (be_is_Spill(node)) {
468 collect_spill(env, node, reload, ent);
469 } else if (is_Proj(node)) {
470 collect_memperm(env, node, reload, ent);
471 } else if (is_Phi(node) && get_irn_mode(node) == mode_M) {
472 collect_memphi(env, node, reload, ent);
474 /* Disabled for now, spills might get transformed by the backend */
476 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
477 node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
478 env->problem_found = 1;
484 * This walker function searches for reloads and collects all the spills
485 * and memphis attached to them.
487 static void collect_spills_walker(ir_node *node, void *data)
489 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
491 if (arch_irn_classify(node) & arch_irn_class_reload) {
492 ir_node *spill = get_memory_edge(node);
496 ir_fprintf(stderr, "Verify warning: No spill attached to reload %+F in block %+F(%s)\n",
497 node, get_nodes_block(node), get_irg_dump_name(env->irg));
498 env->problem_found = 1;
501 ent = arch_get_frame_entity(node);
502 be_check_entity(env, node, ent);
504 collect(env, spill, node, ent);
505 ARR_APP1(ir_node*, env->reloads, node);
509 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
511 int spillcount = set_count(env->spills);
512 spill_t **spills = ALLOCAN(spill_t*, spillcount);
517 foreach_set(env->spills, spill_t*, spill) {
521 for (i = 0; i < spillcount; ++i) {
522 spill_t *sp1 = spills[i];
525 for (i2 = i+1; i2 < spillcount; ++i2) {
526 spill_t *sp2 = spills[i2];
528 if (sp1->ent != sp2->ent)
531 if (my_values_interfere(sp1->spill, sp2->spill)) {
532 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
533 sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
534 sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
535 env->problem_found = 1;
536 my_values_interfere(sp1->spill, sp2->spill);
542 static void check_lonely_spills(ir_node *node, void *data)
544 be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
546 if (be_is_Spill(node) || (is_Proj(node) && be_is_MemPerm(get_Proj_pred(node)))) {
547 spill_t *spill = find_spill(env, node);
548 if (be_is_Spill(node)) {
549 ir_entity *ent = arch_get_frame_entity(node);
550 be_check_entity(env, node, ent);
554 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reaload\n",
555 node, get_nodes_block(node), get_irg_dump_name(env->irg));
560 int be_verify_spillslots(ir_graph *irg)
562 be_verify_spillslots_env_t env;
565 env.spills = new_set(cmp_spill, 10);
566 env.reloads = NEW_ARR_F(ir_node*, 0);
567 env.problem_found = 0;
569 irg_walk_graph(irg, collect_spills_walker, NULL, &env);
570 irg_walk_graph(irg, check_lonely_spills, NULL, &env);
572 check_spillslot_interference(&env);
574 DEL_ARR_F(env.reloads);
577 return ! env.problem_found;
582 /*--------------------------------------------------------------------------- */
587 * Check, if two values interfere.
588 * @param a The first value.
589 * @param b The second value.
590 * @return 1, if a and b interfere, 0 if not.
592 static int my_values_interfere(const ir_node *a, const ir_node *b)
594 const ir_edge_t *edge;
596 int a2b = value_dominates(a, b);
597 int b2a = value_dominates(b, a);
599 /* If there is no dominance relation, they do not interfere. */
604 * Adjust a and b so, that a dominates b if
605 * a dominates b or vice versa.
608 const ir_node *t = a;
613 bb = get_nodes_block(b);
616 * Look at all usages of a.
617 * If there's one usage of a in the block of b, then
618 * we check, if this use is dominated by b, if that's true
619 * a and b interfere. Note that b must strictly dominate the user,
620 * since if b is the last user of in the block, b and a do not
622 * Uses of a not in b's block can be disobeyed, because the
623 * check for a being live at the end of b's block is already
626 foreach_out_edge(a, edge) {
627 const ir_node *user = get_edge_src_irn(edge);
631 if (get_irn_opcode(user) == iro_End)
634 /* in case of phi arguments we compare with the block the value comes from */
636 ir_node *phiblock = get_nodes_block(user);
639 user = get_irn_n(phiblock, get_edge_src_pos(edge));
642 if (value_dominates(b, user))
651 /*--------------------------------------------------------------------------- */
653 static const arch_env_t *arch_env;
654 static ir_graph *irg;
656 static int problem_found;
657 static const arch_register_class_t *regclass;
658 static ir_node **registers;
660 static void check_output_constraints(ir_node *node)
662 /* verify output register */
663 if (arch_get_irn_reg_class_out(node) == regclass) {
664 const arch_register_t *reg = arch_get_irn_register(node);
666 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned\n",
667 node, get_nodes_block(node), get_irg_dump_name(irg));
669 } else if (!(reg->type & arch_register_type_joker) && !arch_reg_out_is_allocatable(node, reg)) {
670 ir_fprintf(stderr, "Verify warning: Register %s assigned as output of %+F not allowed (register constraint) in block %+F(%s)\n",
671 reg->name, node, get_nodes_block(node), get_irg_dump_name(irg));
677 static void check_input_constraints(ir_node *node)
679 const arch_register_t *reg;
682 /* verify input register */
683 arity = get_irn_arity(node);
684 for (i = 0; i < arity; ++i) {
685 const arch_register_req_t *req = arch_get_in_register_req(node, i);
686 ir_node *pred = get_irn_n(node, i);
687 const arch_register_req_t *pred_req = arch_get_register_req_out(pred);
690 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) has Bad as input %d\n",
691 node, get_nodes_block(node), get_irg_dump_name(irg), i);
695 if (req->cls == NULL)
698 if (req->width > pred_req->width) {
699 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register width of value at input %d too small\n",
700 node, get_nodes_block(node), get_irg_dump_name(irg), i);
704 reg = arch_get_irn_register(pred);
705 if (req->type & arch_register_req_type_aligned) {
706 if (reg->index % req->width != 0) {
707 ir_fprintf(stderr, "Verify warning: %+F in block %+F(%s) register allignment not fulfilled\n",
708 node, get_nodes_block(node), get_irg_dump_name(irg), i);
714 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should have a register assigned (%+F input constraint)\n",
715 pred, get_nodes_block(pred), get_irg_dump_name(irg), node);
718 } else if (!(reg->type & arch_register_type_joker) && ! arch_reg_is_allocatable(node, i, reg)) {
719 ir_fprintf(stderr, "Verify warning: Register %s as input %d of %+F not allowed (register constraint) in block %+F(%s)\n",
720 reg->name, i, node, get_nodes_block(node), get_irg_dump_name(irg));
725 /* phis should be NOPs at this point, which means all input regs
726 * must be the same as the output reg */
730 reg = arch_get_irn_register(node);
732 arity = get_irn_arity(node);
733 for (i = 0; i < arity; ++i) {
734 ir_node *pred = get_Phi_pred(node, i);
735 const arch_register_t *pred_reg = arch_get_irn_register(pred);
737 if (reg != pred_reg && !(pred_reg->type & arch_register_type_joker)) {
738 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
739 const char *reg_name = reg != NULL ? reg->name : "(null)";
740 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
741 i, node, get_nodes_block(node),
742 get_irg_dump_name(irg), pred_name, reg_name);
749 static void value_used(ir_node *block, ir_node *node)
751 const arch_register_t *reg;
754 if (arch_get_irn_reg_class_out(node) != regclass)
757 reg = arch_get_irn_register(node);
758 if (reg == NULL || reg->type & arch_register_type_virtual)
761 reg_node = registers[reg->index];
762 if (reg_node != NULL && reg_node != node) {
763 ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
764 reg->name, block, get_irg_dump_name(irg),
769 registers[reg->index] = node;
772 static void value_def(ir_node *node)
774 const arch_register_t *reg;
777 if (arch_get_irn_reg_class_out(node) != regclass)
780 reg = arch_get_irn_register(node);
781 if (reg == NULL || reg->type & arch_register_type_virtual)
784 reg_node = registers[reg->index];
786 if (reg_node != node) {
787 ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
788 node, reg->name, reg_node, get_nodes_block(node), get_irg_dump_name(irg));
791 registers[reg->index] = NULL;
794 static void verify_block_register_allocation(ir_node *block, void *data)
799 nregclasses = arch_env->n_register_classes;
800 for (i = 0; i < nregclasses; ++i) {
804 regclass = &arch_env->register_classes[i];
806 assert(lv->nodes && "live sets must be computed");
808 n_regs = arch_register_class_n_regs(regclass);
809 registers = ALLOCANZ(ir_node*, n_regs);
811 be_lv_foreach(lv, block, be_lv_state_end, idx) {
812 ir_node *node = be_lv_get_irn(lv, block, idx);
813 value_used(block, node);
816 sched_foreach_reverse(block, node) {
819 if (get_irn_mode(node) == mode_T) {
820 const ir_edge_t *edge;
821 foreach_out_edge(node, edge) {
822 ir_node *def = get_edge_src_irn(edge);
824 check_output_constraints(def);
828 check_output_constraints(node);
831 check_input_constraints(node);
833 /* process uses. (Phi inputs are no real uses) */
835 arity = get_irn_arity(node);
836 for (i2 = 0; i2 < arity; ++i2) {
837 ir_node *use = get_irn_n(node, i2);
838 value_used(block, use);
843 be_lv_foreach(lv, block, be_lv_state_in, idx) {
844 ir_node *node = be_lv_get_irn(lv, block, idx);
848 /* set must be empty now */
849 for (i2 = 0; i2 < n_regs; ++i2) {
850 if (registers[i2] == NULL)
853 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
854 registers[i2], block, get_irg_dump_name(irg));
860 int be_verify_register_allocation(ir_graph *new_irg)
863 arch_env = be_get_irg_arch_env(irg);
864 lv = be_liveness(irg);
867 be_liveness_assure_sets(lv);
868 irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
870 be_liveness_free(lv);
872 return !problem_found;