rework ASM node, it always has a memory input now
[libfirm] / ir / be / beverify.c
1 /*
2  * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Various verify routines that check a scheduled graph for correctness.
23  * @author      Matthias Braun
24  * @date        05.05.2006
25  */
26 #include "config.h"
27
28 #include <limits.h>
29 #include <stdbool.h>
30
31 #include "bitset.h"
32 #include "set.h"
33 #include "array.h"
34
35 #include "irnode.h"
36 #include "irgraph.h"
37 #include "irgwalk.h"
38 #include "irprintf.h"
39 #include "irdump_t.h"
40 #include "iredges.h"
41
42 #include "beverify.h"
43 #include "belive.h"
44 #include "besched.h"
45 #include "benode.h"
46 #include "beirg.h"
47 #include "beintlive_t.h"
48 #include "belistsched.h"
49
50 static int my_values_interfere(const ir_node *a, const ir_node *b);
51
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;
59
60 /**
61  * Print all nodes of a pset into a file.
62  */
63 static void print_living_values(FILE *F, const ir_nodeset_t *live_nodes)
64 {
65         ir_fprintf(F, "\t");
66         foreach_ir_nodeset(live_nodes, node, iter) {
67                 ir_fprintf(F, "%+F ", node);
68         }
69         ir_fprintf(F, "\n");
70 }
71
72 static const char *get_irg_name(ir_graph *irg)
73 {
74         ir_entity *entity = get_irg_entity(irg);
75         return get_entity_ld_name(entity);
76 }
77
78 /**
79  * Check if number of live nodes never exceeds the number of available registers.
80  */
81 static void verify_liveness_walker(ir_node *block, void *data)
82 {
83         be_verify_register_pressure_env_t *env = (be_verify_register_pressure_env_t *)data;
84         ir_nodeset_t live_nodes;
85         int pressure;
86
87         /* collect register pressure info, start with end of a block */
88         // ir_fprintf(stderr, "liveness check %+F\n", block);
89         ir_nodeset_init(&live_nodes);
90         be_liveness_end_of_block(env->lv, env->cls, block,
91                                  &live_nodes);
92
93         // print_living_values(stderr, &live_nodes);
94         pressure = ir_nodeset_size(&live_nodes);
95         if (pressure > env->registers_available) {
96                 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
97                         block, get_irg_name(env->irg), pressure, env->registers_available);
98                 print_living_values(stderr, &live_nodes);
99                 env->problem_found = 1;
100         }
101
102         sched_foreach_reverse(block, irn) {
103                 if (is_Phi(irn))
104                         break;
105
106                 // print_living_values(stderr, &live_nodes);
107                 be_liveness_transfer(env->cls, irn, &live_nodes);
108
109                 pressure = ir_nodeset_size(&live_nodes);
110
111                 if (pressure > env->registers_available) {
112                         ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
113                                 irn, block, get_irg_name(env->irg), pressure, env->registers_available);
114                         print_living_values(stderr, &live_nodes);
115                         env->problem_found = 1;
116                         assert(0);
117                 }
118         }
119         ir_nodeset_destroy(&live_nodes);
120 }
121
122 /**
123  * Start a walk over the irg and check the register pressure.
124  */
125 int be_verify_register_pressure(ir_graph *irg, const arch_register_class_t *cls)
126 {
127         be_verify_register_pressure_env_t env;
128
129         env.lv                  = be_liveness_new(irg);
130         env.irg                 = irg;
131         env.cls                 = cls;
132         env.registers_available = be_get_n_allocatable_regs(irg, cls);
133         env.problem_found       = 0;
134
135         be_liveness_compute_sets(env.lv);
136         irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
137         be_liveness_free(env.lv);
138
139         return ! env.problem_found;
140 }
141
142 /*--------------------------------------------------------------------------- */
143
144 typedef struct be_verify_schedule_env_t_ {
145         int       problem_found; /**< flags indicating a problem */
146         bitset_t *scheduled;     /**< bitset of scheduled nodes */
147         ir_graph *irg;           /**< the irg to check */
148 } be_verify_schedule_env_t;
149
150 /**
151  * Simple schedule checker.
152  */
153 static void verify_schedule_walker(ir_node *block, void *data)
154 {
155         be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
156         ir_node *non_phi_found  = NULL;
157         ir_node *cfchange_found = NULL;
158         int last_timestep = INT_MIN;
159
160         /*
161          * Tests for the following things:
162          *   1. Make sure that all phi nodes are scheduled at the beginning of the
163          *      block
164          *   2. No value is defined after it has been used
165          *   3. mode_T nodes have all projs scheduled behind them followed by Keeps
166          *       (except mode_X projs)
167          */
168         sched_foreach(block, node) {
169                 int timestep;
170
171                 /* this node is scheduled */
172                 if (bitset_is_set(env->scheduled, get_irn_idx(node))) {
173                         ir_fprintf(stderr, "Verify warning: %+F appears to be schedule twice\n");
174                         env->problem_found = 1;
175                 }
176                 bitset_set(env->scheduled, get_irn_idx(node));
177
178                 /* Check that scheduled nodes are in the correct block */
179                 if (get_nodes_block(node) != block) {
180                         ir_fprintf(stderr, "Verify warning: %+F is in block %+F but scheduled in %+F\n", node, get_nodes_block(node), block);
181                         env->problem_found = 1;
182                 }
183
184                 /* Check that timesteps are increasing */
185                 timestep = sched_get_time_step(node);
186                 if (timestep <= last_timestep) {
187                         ir_fprintf(stderr, "Verify warning: Schedule timestep did not increase at node %+F\n",
188                                    node);
189                         env->problem_found = 1;
190                 }
191                 last_timestep = timestep;
192
193                 /* Check that phis come before any other node */
194                 if (is_Phi(node)) {
195                         if (non_phi_found != NULL) {
196                                 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes (for example %+F) in block %+F (%s)\n",
197                                         node, non_phi_found, block, get_irg_name(env->irg));
198                                 env->problem_found = 1;
199                         }
200                 } else {
201                         non_phi_found = node;
202                 }
203
204                 /* Check for control flow changing nodes */
205                 if (is_cfop(node)) {
206                         /* check, that only one CF operation is scheduled */
207                         if (cfchange_found != NULL) {
208                                 ir_fprintf(stderr, "Verify Warning: Additional control flow changing node %+F scheduled after %+F in block %+F (%s)\n",
209                                         node, block, cfchange_found, get_irg_name(env->irg));
210                                 env->problem_found = 1;
211                         } else {
212                                 cfchange_found = node;
213                         }
214                 } else if (cfchange_found != NULL) {
215                         /* proj and keepany aren't real instructions... */
216                         if (!is_Proj(node) && !be_is_Keep(node)) {
217                                 ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node in block %+F (%s)\n",
218                                            node, block, get_irg_name(env->irg));
219                                 env->problem_found = 1;
220                         }
221                 }
222
223                 /* Check that all uses come before their definitions */
224                 if (!is_Phi(node)) {
225                         int i;
226                         int arity;
227                         sched_timestep_t 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))
232                                         continue;
233
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_name(env->irg));
237                                         env->problem_found = 1;
238                                 }
239                         }
240                 }
241
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_name(env->irg));
246                         env->problem_found = 1;
247                 }
248
249                 if (be_is_Keep(node) || be_is_CopyKeep(node)) {
250                         /* at least 1 of the keep arguments has to be its schedule
251                          * predecessor */
252                         int      arity   = get_irn_arity(node);
253                         bool     found   = false;
254                         ir_node *prev    = sched_prev(node);
255                         while (be_is_Keep(prev) || be_is_CopyKeep(prev))
256                                 prev = sched_prev(prev);
257
258                         while (true) {
259                                 int i;
260                                 for (i = 0; i < arity; ++i) {
261                                         ir_node *in = get_irn_n(node, i);
262                                         in = skip_Proj(in);
263                                         if (in == prev)
264                                                 found = true;
265                                 }
266                                 if (found)
267                                         break;
268                                 prev = sched_prev(prev);
269                                 if (!is_Phi(prev))
270                                         break;
271                         }
272                         if (!found) {
273                                 ir_fprintf(stderr, "%+F not scheduled after its pred node in block %+F (%s)\n",
274                                            node, block, get_irg_name(env->irg));
275                                 env->problem_found = 1;
276                         }
277                 }
278         }
279 }
280
281 static void check_schedule(ir_node *node, void *data)
282 {
283         be_verify_schedule_env_t *env = (be_verify_schedule_env_t*)data;
284         bool should_be = !is_Proj(node) && !(arch_get_irn_flags(node) & arch_irn_flags_not_scheduled);
285         bool scheduled = bitset_is_set(env->scheduled, get_irn_idx(node));
286
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_name(env->irg), should_be ? "" : " not");
290                 env->problem_found = 1;
291         }
292 }
293
294 /**
295  * Start a walk over the irg and check schedule.
296  */
297 int be_verify_schedule(ir_graph *irg)
298 {
299         be_verify_schedule_env_t env;
300
301         env.problem_found = 0;
302         env.irg           = irg;
303         env.scheduled     = bitset_alloca(get_irg_last_idx(env.irg));
304
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);
308
309         return ! env.problem_found;
310 }
311
312
313
314 /*--------------------------------------------------------------------------- */
315
316
317
318 typedef struct spill_t {
319         ir_node *spill;
320         ir_entity *ent;
321 } spill_t;
322
323 typedef struct {
324         ir_graph  *irg;
325         set       *spills;
326         ir_node  **reloads;
327         int        problem_found;
328 } be_verify_spillslots_env_t;
329
330 static int cmp_spill(const void* d1, const void* d2, size_t size)
331 {
332         const spill_t* s1 = (const spill_t*)d1;
333         const spill_t* s2 = (const spill_t*)d2;
334         (void) size;
335
336         return s1->spill != s2->spill;
337 }
338
339 static spill_t *find_spill(be_verify_spillslots_env_t *env, ir_node *node)
340 {
341         spill_t spill;
342
343         spill.spill = node;
344         return set_find(spill_t, env->spills, &spill, sizeof(spill), hash_ptr(node));
345 }
346
347 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
348 {
349         spill_t spill, *res;
350         int hash = hash_ptr(node);
351
352         spill.spill = node;
353         res = set_find(spill_t, env->spills, &spill, sizeof(spill), hash);
354
355         if (res == NULL) {
356                 spill.ent = ent;
357                 res = set_insert(spill_t, env->spills, &spill, sizeof(spill), hash);
358         }
359
360         return res;
361 }
362
363 static ir_node *get_memory_edge(const ir_node *node)
364 {
365         int i, arity;
366         ir_node *result = NULL;
367
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);
373                         result = arg;
374                 }
375         }
376
377         return result;
378 }
379
380 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent);
381
382 static void be_check_entity(be_verify_spillslots_env_t *env, ir_node *node, ir_entity *ent)
383 {
384         if (ent == NULL) {
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_name(env->irg));
387         }
388 }
389
390 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
391 {
392         ir_entity *spillent = arch_get_frame_entity(node);
393         be_check_entity(env, node, spillent);
394         get_spill(env, node, ent);
395
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_name(env->irg));
399                 env->problem_found = 1;
400         }
401 }
402
403 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
404 {
405         int i, arity;
406         spill_t spill, *res;
407         int hash = hash_ptr(node);
408         int out;
409         ir_node* memperm;
410         ir_entity *spillent;
411
412         assert(is_Proj(node));
413
414         memperm = get_Proj_pred(node);
415         out = get_Proj_proj(node);
416
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_name(env->irg));
422                 env->problem_found = 1;
423         }
424
425         spill.spill = node;
426         res = set_find(spill_t, env->spills, &spill, sizeof(spill), hash);
427         if (res != NULL) {
428                 return;
429         }
430
431         spill.ent = spillent;
432         res = set_insert(spill_t, env->spills, &spill, sizeof(spill), hash);
433
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);
437
438                 collect(env, arg, memperm, argent);
439         }
440 }
441
442 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity *ent)
443 {
444         int i, arity;
445         spill_t spill, *res;
446         int hash = hash_ptr(node);
447
448         assert(is_Phi(node));
449
450         spill.spill = node;
451         res = set_find(spill_t, env->spills, &spill, sizeof(spill), hash);
452         if (res != NULL) {
453                 return;
454         }
455
456         spill.ent = ent;
457         res = set_insert(spill_t, env->spills, &spill, sizeof(spill), hash);
458
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);
463         }
464 }
465
466 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, ir_entity* ent)
467 {
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);
474         } else {
475                 /* Disabled for now, spills might get transformed by the backend */
476 #if 0
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_name(env->irg));
479                 env->problem_found = 1;
480 #endif
481         }
482 }
483
484 /**
485  * This walker function searches for reloads and collects all the spills
486  * and memphis attached to them.
487  */
488 static void collect_spills_walker(ir_node *node, void *data)
489 {
490         be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
491
492         if (be_is_Reload(node)) {
493                 ir_node *spill = get_memory_edge(node);
494                 ir_entity *ent;
495
496                 if (spill == NULL) {
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_name(env->irg));
499                         env->problem_found = 1;
500                         return;
501                 }
502                 ent = arch_get_frame_entity(node);
503                 be_check_entity(env, node, ent);
504
505                 collect(env, spill, node, ent);
506                 ARR_APP1(ir_node*, env->reloads, node);
507         }
508 }
509
510 static void check_spillslot_interference(be_verify_spillslots_env_t *env)
511 {
512         int       spillcount = set_count(env->spills);
513         spill_t **spills     = ALLOCAN(spill_t*, spillcount);
514         int       i;
515
516         i = 0;
517         foreach_set(env->spills, spill_t, spill) {
518                 spills[i++] = spill;
519         }
520
521         for (i = 0; i < spillcount; ++i) {
522                 spill_t *sp1 = spills[i];
523                 int i2;
524
525                 for (i2 = i+1; i2 < spillcount; ++i2) {
526                         spill_t *sp2 = spills[i2];
527
528                         if (sp1->ent != sp2->ent)
529                                 continue;
530
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_name(env->irg),
534                                         sp2->spill, get_nodes_block(sp2->spill), get_irg_name(env->irg));
535                                 env->problem_found = 1;
536                                 my_values_interfere(sp1->spill, sp2->spill);
537                         }
538                 }
539         }
540 }
541
542 static void check_lonely_spills(ir_node *node, void *data)
543 {
544         be_verify_spillslots_env_t *env = (be_verify_spillslots_env_t*)data;
545
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);
551                 }
552
553                 if (spill == NULL) {
554                         ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) not connected to a reload\n",
555                                    node, get_nodes_block(node), get_irg_name(env->irg));
556                 }
557         }
558 }
559
560 int be_verify_spillslots(ir_graph *irg)
561 {
562         be_verify_spillslots_env_t env;
563
564         env.irg = irg;
565         env.spills = new_set(cmp_spill, 10);
566         env.reloads = NEW_ARR_F(ir_node*, 0);
567         env.problem_found = 0;
568
569         irg_walk_graph(irg, collect_spills_walker, NULL, &env);
570         irg_walk_graph(irg, check_lonely_spills, NULL, &env);
571
572         check_spillslot_interference(&env);
573
574         DEL_ARR_F(env.reloads);
575         del_set(env.spills);
576
577         return ! env.problem_found;
578 }
579
580
581
582 /*--------------------------------------------------------------------------- */
583
584
585
586 /**
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.
591  */
592 static int my_values_interfere(const ir_node *a, const ir_node *b)
593 {
594         ir_node *bb;
595         int a2b = value_dominates(a, b);
596         int b2a = value_dominates(b, a);
597
598         /* If there is no dominance relation, they do not interfere. */
599         if (!a2b && !b2a)
600                 return 0;
601
602         /*
603          * Adjust a and b so, that a dominates b if
604          * a dominates b or vice versa.
605          */
606         if (b2a) {
607                 const ir_node *t = a;
608                 a = b;
609                 b = t;
610         }
611
612         bb = get_nodes_block(b);
613
614         /*
615          * Look at all usages of a.
616          * If there's one usage of a in the block of b, then
617          * we check, if this use is dominated by b, if that's true
618          * a and b interfere. Note that b must strictly dominate the user,
619          * since if b is the last user of in the block, b and a do not
620          * interfere.
621          * Uses of a not in b's block can be disobeyed, because the
622          * check for a being live at the end of b's block is already
623          * performed.
624          */
625         foreach_out_edge(a, edge) {
626                 const ir_node *user = get_edge_src_irn(edge);
627                 if (b == user)
628                         continue;
629
630                 if (get_irn_opcode(user) == iro_End)
631                         continue;
632
633                 /* in case of phi arguments we compare with the block the value comes from */
634                 if (is_Phi(user)) {
635                         ir_node *phiblock = get_nodes_block(user);
636                         if (phiblock == bb)
637                                 continue;
638                         user = get_irn_n(phiblock, get_edge_src_pos(edge));
639                 }
640
641                 if (value_dominates(b, user))
642                         return 1;
643         }
644
645         return 0;
646 }
647
648
649
650 /*--------------------------------------------------------------------------- */
651
652 static const arch_env_t            *arch_env;
653 static ir_graph                    *irg;
654 static be_lv_t                     *lv;
655 static bool                         problem_found;
656 static const ir_node              **registers;
657
658 static void check_output_constraints(const ir_node *node)
659 {
660         if (arch_get_irn_reg_class(node) == NULL)
661                 return;
662
663         /* verify output register */
664         const arch_register_req_t *req = arch_get_irn_register_req(node);
665         const arch_register_t     *reg = arch_get_irn_register(node);
666         if (reg == NULL) {
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_name(irg));
669                 problem_found = true;
670         } else if (!arch_reg_is_allocatable(req, 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_name(irg));
673                 problem_found = true;
674         }
675 }
676
677 static void check_input_constraints(ir_node *node)
678 {
679         const arch_register_t *reg;
680         int                    i, arity;
681
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_irn_register_req_in(node, i);
686                 ir_node                   *pred     = get_irn_n(node, i);
687                 const arch_register_req_t *pred_req = arch_get_irn_register_req(pred);
688
689                 if (is_Bad(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_name(irg), i);
692                         problem_found = 1;
693                         continue;
694                 }
695                 if (req->cls == NULL)
696                         continue;
697
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_name(irg), i);
701                         problem_found = 1;
702                 }
703
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_name(irg), i);
709                                 problem_found = 1;
710                         }
711                 }
712
713                 if (reg == NULL) {
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_name(irg), node);
716                         problem_found = 1;
717                         continue;
718                 } else if (!arch_reg_is_allocatable(req, 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_name(irg));
721                         problem_found = 1;
722                 }
723         }
724
725         /* phis should be NOPs at this point, which means all input regs
726          * must be the same as the output reg */
727         if (is_Phi(node)) {
728                 reg = arch_get_irn_register(node);
729
730                 arity = get_irn_arity(node);
731                 for (i = 0; i < arity; ++i) {
732                         ir_node               *pred     = get_Phi_pred(node, i);
733                         const arch_register_t *pred_reg = arch_get_irn_register(pred);
734
735                         if (reg != pred_reg && !(pred_reg->type & arch_register_type_joker)) {
736                                 const char *pred_name = pred_reg != NULL ? pred_reg->name : "(null)";
737                                 const char *reg_name  = reg != NULL ? reg->name : "(null)";
738                                 ir_fprintf(stderr, "Verify warning: Input %d of %+F in block %+F(%s) uses register %s instead of %s\n",
739                                            i, node, get_nodes_block(node),
740                                            get_irg_name(irg), pred_name, reg_name);
741                                 problem_found = 1;
742                         }
743                 }
744         }
745 }
746
747 static void value_used(const ir_node *block, const ir_node *node)
748 {
749         const arch_register_t     *reg = arch_get_irn_register(node);
750         const arch_register_req_t *req;
751         unsigned                   i;
752         unsigned                   idx;
753
754         if (reg == NULL || reg->type & arch_register_type_virtual)
755                 return;
756
757         req = arch_get_irn_register_req(node);
758         assert(req->width > 0);
759         idx = reg->global_index;
760         for (i = 0; i < req->width; ++i) {
761                 const ir_node *reg_node = registers[idx+i];
762                 if (reg_node != NULL && reg_node != node) {
763                         const arch_register_t *realreg = &arch_env->registers[idx+i];
764                         ir_fprintf(stderr, "Verify warning: Register %s assigned more than once in block %+F(%s) (nodes %+F %+F)\n",
765                                            realreg->name, block, get_irg_name(irg),
766                                            node, reg_node);
767                         problem_found = true;
768                 }
769                 registers[idx+i] = node;
770         }
771 }
772
773 static void value_def(const ir_node *node)
774 {
775         const arch_register_t     *reg = arch_get_irn_register(node);
776         const arch_register_req_t *req;
777         unsigned                   idx;
778         unsigned                   i;
779
780         if (reg == NULL || reg->type & arch_register_type_virtual)
781                 return;
782
783         req = arch_get_irn_register_req(node);
784         assert(req->width > 0);
785         idx = reg->global_index;
786         for (i = 0; i < req->width; ++i) {
787                 const ir_node *reg_node = registers[idx+i];
788
789                 /* a little cheat, since its so hard to remove all outedges to dead code
790                  * in the backend. This particular case should never be a problem. */
791                 if (reg_node == NULL && get_irn_n_edges(node) == 0)
792                         return;
793
794                 if (reg_node != node) {
795                         const arch_register_t *realreg = &arch_env->registers[idx+i];
796                         ir_fprintf(stderr, "Verify warning: Node %+F not registered as value for Register %s (but %+F) in block %+F(%s)\n",
797                                    node, realreg->name, reg_node, get_nodes_block(node),
798                                    get_irg_name(irg));
799                         problem_found = true;
800                 }
801                 registers[idx+i] = NULL;
802         }
803 }
804
805 static void verify_block_register_allocation(ir_node *block, void *data)
806 {
807         unsigned i;
808         unsigned n_regs;
809
810         (void) data;
811
812         assert(lv->sets_valid && "live sets must be computed");
813
814         n_regs    = arch_env->n_registers;
815         registers = ALLOCANZ(const ir_node*, n_regs);
816
817         be_lv_foreach(lv, block, be_lv_state_end, lv_node) {
818                 value_used(block, lv_node);
819         }
820
821         sched_foreach_reverse(block, node) {
822                 int arity;
823
824                 if (get_irn_mode(node) == mode_T) {
825                         foreach_out_edge(node, edge) {
826                                 ir_node *def = get_edge_src_irn(edge);
827                                 value_def(def);
828                                 check_output_constraints(def);
829                         }
830                 } else {
831                         value_def(node);
832                         check_output_constraints(node);
833                 }
834
835                 check_input_constraints(node);
836
837                 /* process uses. (Phi inputs are no real uses) */
838                 if (!is_Phi(node)) {
839                         int in;
840                         arity = get_irn_arity(node);
841                         for (in = 0; in < arity; ++in) {
842                                 ir_node *use = get_irn_n(node, in);
843                                 value_used(block, use);
844                         }
845                 }
846         }
847
848         be_lv_foreach(lv, block, be_lv_state_in, lv_node) {
849                 value_def(lv_node);
850         }
851
852         /* set must be empty now */
853         for (i = 0; i < n_regs; ++i) {
854                 if (registers[i] == NULL)
855                         continue;
856
857                 ir_fprintf(stderr, "Verify warning: Node %+F not live-in and no def found in block %+F(%s)\n",
858                                 registers[i], block, get_irg_name(irg));
859                 problem_found = true;
860         }
861 }
862
863 bool be_verify_register_allocation(ir_graph *new_irg)
864 {
865         irg           = new_irg;
866         arch_env      = be_get_irg_arch_env(irg);
867         lv            = be_liveness_new(irg);
868         problem_found = false;
869
870         be_liveness_compute_sets(lv);
871         irg_block_walk_graph(irg, verify_block_register_allocation, NULL, NULL);
872         be_liveness_free(lv);
873
874         return !problem_found;
875 }
876
877 /*--------------------------------------------------------------------------- */
878
879 /**
880  * Walker: checks that every predecessors of a node dominates the node.
881  */
882 static void dom_check(ir_node *irn, void *data)
883 {
884         bool *problem_found = (bool*)data;
885
886         if (!is_Block(irn) && irn != get_irg_end(get_irn_irg(irn))) {
887                 int i, n;
888                 ir_node *bl = get_nodes_block(irn);
889
890                 for (i = 0, n = get_irn_arity(irn); i < n; ++i) {
891                         ir_node *op     = get_irn_n(irn, i);
892                         ir_node *def_bl = get_nodes_block(op);
893                         ir_node *use_bl = bl;
894
895                         if (is_Phi(irn))
896                                 use_bl = get_Block_cfgpred_block(bl, i);
897
898                         if (get_irn_opcode(use_bl) != iro_Bad
899                              && get_irn_opcode(def_bl) != iro_Bad
900                              && !block_dominates(def_bl, use_bl)) {
901                                 ir_fprintf(stderr, "Verify warning: %+F in %+F must dominate %+F for user %+F (%s)\n", op, def_bl, use_bl, irn, get_irg_name(get_irn_irg(op)));
902                                 *problem_found = true;
903                         }
904                 }
905         }
906 }
907
908 /* Check, if the SSA dominance property is fulfilled. */
909 bool be_check_dominance(ir_graph *irg)
910 {
911         bool problem_found = false;
912
913         assure_doms(irg);
914         irg_walk_graph(irg, dom_check, NULL, &problem_found);
915
916         return !problem_found;
917 }
918
919 /*--------------------------------------------------------------------------- */
920
921 typedef struct lv_walker_t {
922         be_lv_t *lv;
923         void *data;
924 } lv_walker_t;
925
926 static const char *lv_flags_to_str(unsigned flags)
927 {
928         static const char *states[] = {
929                 "---",
930                 "i--",
931                 "-e-",
932                 "ie-",
933                 "--o",
934                 "i-o",
935                 "-eo",
936                 "ieo"
937         };
938
939         return states[flags & 7];
940 }
941
942 static void lv_check_walker(ir_node *bl, void *data)
943 {
944         lv_walker_t *w = (lv_walker_t*)data;
945         be_lv_t *lv    = w->lv;
946         be_lv_t *fresh = (be_lv_t*)w->data;
947
948         be_lv_info_t *curr = ir_nodehashmap_get(be_lv_info_t, &fresh->map, bl);
949         be_lv_info_t *fr   = ir_nodehashmap_get(be_lv_info_t, &fresh->map, bl);
950
951         if (!fr && curr && curr[0].head.n_members > 0) {
952                 unsigned i;
953
954                 ir_fprintf(stderr, "%+F liveness should be empty but current liveness contains:\n", bl);
955                 for (i = 0; i < curr[0].head.n_members; ++i) {
956                         ir_fprintf(stderr, "\t%+F\n", get_idx_irn(lv->irg, curr[1 + i].node.idx));
957                 }
958         }
959
960         else if (curr) {
961                 unsigned n_curr  = curr[0].head.n_members;
962                 unsigned n_fresh = fr[0].head.n_members;
963
964                 unsigned i;
965
966                 if (n_curr != n_fresh) {
967                         ir_fprintf(stderr, "%+F: liveness set sizes differ. curr %d, correct %d\n", bl, n_curr, n_fresh);
968
969                         ir_fprintf(stderr, "current:\n");
970                         for (i = 0; i < n_curr; ++i) {
971                                 be_lv_info_node_t *n = &curr[1 + i].node;
972                                 ir_fprintf(stderr, "%+F %u %+F %s\n", bl, i, get_idx_irn(lv->irg, n->idx), lv_flags_to_str(n->flags));
973                         }
974
975                         ir_fprintf(stderr, "correct:\n");
976                         for (i = 0; i < n_fresh; ++i) {
977                                 be_lv_info_node_t *n = &fr[1 + i].node;
978                                 ir_fprintf(stderr, "%+F %u %+F %s\n", bl, i, get_idx_irn(lv->irg, n->idx), lv_flags_to_str(n->flags));
979                         }
980                 }
981         }
982 }
983
984 void be_liveness_check(be_lv_t *lv)
985 {
986         lv_walker_t w;
987         be_lv_t *fresh = be_liveness_new(lv->irg);
988
989         w.lv   = lv;
990         w.data = fresh;
991         irg_block_walk_graph(lv->irg, lv_check_walker, NULL, &w);
992         be_liveness_free(fresh);
993 }