46d6c6d52dfe7c46caae4c622c8424fdcd8ffbab
[libfirm] / ir / be / beverify.c
1 /*
2  * Author:    Matthias Braun
3  * Date:      05.05.2006
4  * Copyright: (c) Universitaet Karlsruhe
5  * License:   This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  * CVS-Id:    $Id$
7  */
8 #ifdef HAVE_CONFIG_H
9 #include "config.h"
10 #endif
11
12 #include "beverify.h"
13 #include "belive.h"
14 #include "besched_t.h"
15
16 #include "irnode.h"
17 #include "irgraph.h"
18 #include "irgwalk.h"
19 #include "irprintf.h"
20 #include "irdump_t.h"
21 #include "iredges.h"
22 #include "set.h"
23 #include "array.h"
24 #include "benode_t.h"
25
26 static int my_values_interfere(const ir_node *a, const ir_node *b);
27
28 typedef struct be_verify_register_pressure_env_t_ {
29         ir_graph                    *irg;                 /**< the irg to verify */
30          be_lv_t                    *lv;                  /**< Liveness information. */
31         const arch_env_t            *arch_env;            /**< an architecture environment */
32         const arch_register_class_t *cls;                 /**< the register class to check for */
33         int                         registers_available;  /**< number of available registers */
34         int                         problem_found;        /**< flag indicating if a problem was found */
35 } be_verify_register_pressure_env_t;
36
37 /**
38  * Print all nodes of a pset into a file.
39  */
40 static void print_living_values(FILE *F, pset *live_nodes)
41 {
42         ir_node *node;
43
44         ir_fprintf(F, "\t");
45         foreach_pset(live_nodes, node) {
46                 ir_fprintf(F, "%+F ", node);
47         }
48         ir_fprintf(F, "\n");
49 }
50
51 /**
52  * Check if number of live nodes never exceeds the number of available registers.
53  */
54 static void verify_liveness_walker(ir_node *block, void *data)
55 {
56         be_verify_register_pressure_env_t *env = (be_verify_register_pressure_env_t *)data;
57         pset    *live_nodes = pset_new_ptr_default();
58         ir_node *irn;
59         int pressure;
60
61         /* collect register pressure info, start with end of a block */
62         be_liveness_end_of_block(env->lv, env->arch_env, env->cls, block, live_nodes);
63
64         pressure = pset_count(live_nodes);
65         if(pressure > env->registers_available) {
66                 ir_fprintf(stderr, "Verify Warning: Register pressure too high at end of block %+F(%s) (%d/%d):\n",
67                         block, get_irg_dump_name(env->irg), pressure, env->registers_available);
68                 print_living_values(stderr, live_nodes);
69                 env->problem_found = 1;
70         }
71
72         sched_foreach_reverse(block, irn) {
73                 if (is_Phi(irn))
74                         break;
75
76                 be_liveness_transfer(env->arch_env, env->cls, irn, live_nodes);
77
78                 pressure = pset_count(live_nodes);
79
80                 if(pressure > env->registers_available) {
81                         ir_fprintf(stderr, "Verify Warning: Register pressure too high before node %+F in %+F(%s) (%d/%d):\n",
82                                 irn, block, get_irg_dump_name(env->irg), pressure, env->registers_available);
83                         print_living_values(stderr, live_nodes);
84                         env->problem_found = 1;
85                 }
86         }
87         del_pset(live_nodes);
88 }
89
90 /**
91  * Start a walk over the irg and check the register pressure.
92  */
93 int be_verify_register_pressure(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_graph *irg)
94 {
95         be_verify_register_pressure_env_t env;
96
97         env.lv                  = be_liveness(irg);
98         env.irg                 = irg;
99         env.arch_env            = arch_env;
100         env.cls                 = cls;
101         env.registers_available = arch_count_non_ignore_regs(arch_env, cls);
102         env.problem_found       = 0;
103
104         irg_block_walk_graph(irg, verify_liveness_walker, NULL, &env);
105         be_liveness_free(env.lv);
106
107         return ! env.problem_found;
108 }
109
110 typedef struct be_verify_schedule_env_t_ {
111         int      problem_found;    /**< flags indicating if there was a problem */
112         ir_graph *irg;             /**< the irg to check */
113 } be_verify_schedule_env_t;
114
115 /**
116  * Simple schedule checker.
117  */
118 static void verify_schedule_walker(ir_node *block, void *data)
119 {
120         be_verify_schedule_env_t *env = (be_verify_schedule_env_t*) data;
121         ir_node *node;
122         int non_phi_found  = 0;
123         int cfchange_found = 0;
124         // TODO ask arch about delay branches
125         int delay_branches = 0;
126         pset *uses = pset_new_ptr_default();
127
128         /*
129          * Tests for the following things:
130          *   1. Make sure that all phi nodes are scheduled at the beginning of the block
131          *   2. There is 1 or no control flow changing node scheduled and exactly delay_branches operations after it.
132          *   3. No value is defined after it has been used
133          */
134         sched_foreach(block, node) {
135                 int i, arity;
136
137                 // 1. Check for phis
138                 if (is_Phi(node)) {
139                         if (non_phi_found) {
140                                 ir_fprintf(stderr, "Verify Warning: Phi node %+F scheduled after non-Phi nodes in block %+F (%s)\n",
141                                         node, block, get_irg_dump_name(env->irg));
142                                 env->problem_found = 1;
143                         }
144                 } else {
145                         non_phi_found = 1;
146                 }
147
148                 // 2. Check for control flow changing nodes
149                 if (is_cfop(node) && get_irn_opcode(node) != iro_Start) {
150                         /* check, that only one CF operation is scheduled */
151                         if (cfchange_found == 1) {
152                                 ir_fprintf(stderr, "Verify Warning: More than 1 control flow changing node (%+F) scheduled in block %+F (%s)\n",
153                                         node, block, get_irg_dump_name(env->irg));
154                                 env->problem_found = 1;
155                         }
156                         cfchange_found = 1;
157                 } else if (cfchange_found) {
158                         // proj and keepany aren't real instructions...
159                         if(!is_Proj(node) && !be_is_Keep(node)) {
160                                 /* check for delay branches */
161                                 if (delay_branches == 0) {
162                                         ir_fprintf(stderr, "Verify Warning: Node %+F scheduled after control flow changing node (+delay branches) in block %+F (%s)\n",
163                                                 node, block, get_irg_dump_name(env->irg));
164                                         env->problem_found = 1;
165                                 } else {
166                                         delay_branches--;
167                                 }
168                         }
169                 }
170
171                 // 3. Check for uses
172                 if(pset_find_ptr(uses, node)) {
173                         ir_fprintf(stderr, "Verify Warning: Value %+F used before it was defined in block %+F (%s)\n",
174                                 node, block, get_irg_dump_name(env->irg));
175                         env->problem_found = 1;
176                 }
177                 if(!is_Phi(node)) {
178                         for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
179                                 pset_insert_ptr(uses, get_irn_n(node, i));
180                         }
181                 }
182         }
183         del_pset(uses);
184
185         /* check that all delay branches are filled (at least with NOPs) */
186         if (cfchange_found && delay_branches != 0) {
187                 ir_fprintf(stderr, "Verify warning: Not all delay slots filled after jump (%d/%d) in block %+F (%s)\n",
188                         block, get_irg_dump_name(env->irg));
189                 env->problem_found = 1;
190         }
191 }
192
193 static int should_be_scheduled(ir_node *node) {
194         if(get_irn_mode(node) == mode_M) {
195                 if(is_Phi(node) || is_Proj(node) || is_Sync(node))
196                         return 0;
197         }
198         if(is_Proj(node) && get_irn_mode(node) == mode_X)
199                 return 0;
200         if(get_irn_opcode(node) == iro_End || get_irn_opcode(node) == iro_NoMem)
201                 return 0;
202
203         return 1;
204 }
205
206 static void check_schedule(ir_node *node, void *data) {
207         be_verify_schedule_env_t *env = data;
208         int should_be;
209
210         if(is_Block(node))
211                 return;
212
213         should_be = should_be_scheduled(node);
214
215         if(should_be ? !sched_is_scheduled(node) : sched_is_scheduled(node)) {
216                 ir_fprintf(stderr, "Verify warning: Node %+F in block %+F(%s) should%s be scheduled\n",
217                         node, get_nodes_block(node), get_irg_dump_name(env->irg), should_be ? "" : "not ");
218                 env->problem_found = 1;
219         }
220 }
221
222 /**
223  * Start a walk over the irg and check schedule.
224  */
225 int be_verify_schedule(ir_graph *irg)
226 {
227         be_verify_schedule_env_t env;
228
229         env.problem_found = 0;
230         env.irg           = irg;
231
232         irg_block_walk_graph(irg, verify_schedule_walker, NULL, &env);
233         // check if all nodes are scheduled
234         irg_walk_graph(irg, check_schedule, NULL, &env);
235
236         return ! env.problem_found;
237 }
238
239
240
241 //---------------------------------------------------------------------------
242
243
244
245 typedef struct _spill_t {
246         ir_node *spill;
247         entity *ent;
248 } spill_t;
249
250 typedef struct {
251         be_lv_t *lv;
252         ir_graph *irg;
253         set *spills;
254         ir_node **reloads;
255         int problem_found;
256 } be_verify_spillslots_env_t;
257
258 static int cmp_spill(const void* d1, const void* d2, size_t size) {
259         const spill_t* s1 = d1;
260         const spill_t* s2 = d2;
261         return s1->spill != s2->spill;
262 }
263
264 static spill_t *get_spill(be_verify_spillslots_env_t *env, ir_node *node, entity *ent) {
265         spill_t spill, *res;
266         int hash = HASH_PTR(node);
267
268         spill.spill = node;
269         res = set_find(env->spills, &spill, sizeof(spill), hash);
270
271         if(res == NULL) {
272                 spill.ent = ent;
273                 res = set_insert(env->spills, &spill, sizeof(spill), hash);
274         }
275
276         return res;
277 }
278
279 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, entity* ent);
280
281 static void collect_spill(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, entity* ent) {
282         entity *spillent = be_get_frame_entity(node);
283         get_spill(env, node, ent);
284
285         if(spillent != ent) {
286                 ir_fprintf(stderr, "Verify warning: Spill %+F has different entity than reload %+F in block %+F(%s)\n",
287                         node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
288                 env->problem_found = 1;
289         }
290 }
291
292 static void collect_memperm(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, entity* ent) {
293         int i, arity;
294         spill_t spill, *res;
295         int hash = HASH_PTR(node);
296         int out;
297         ir_node* memperm;
298         entity *spillent;
299
300         assert(is_Proj(node));
301
302         memperm = get_Proj_pred(node);
303         out = get_Proj_proj(node);
304
305         spillent = be_get_MemPerm_out_entity(memperm, out);
306         if(spillent != ent) {
307                 ir_fprintf(stderr, "Verify warning: MemPerm %+F has different entity than reload %+F in block %+F(%s)\n",
308                         node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
309                 env->problem_found = 1;
310         }
311
312         spill.spill = node;
313         res = set_find(env->spills, &spill, sizeof(spill), hash);
314         if(res != NULL) {
315                 return;
316         }
317
318         spill.ent = spillent;
319         res = set_insert(env->spills, &spill, sizeof(spill), hash);
320
321         for(i = 0, arity = get_irn_arity(memperm); i < arity; ++i) {
322                 ir_node* arg = get_irn_n(memperm, i);
323                 entity* argent = be_get_MemPerm_in_entity(memperm, i);
324
325                 collect(env, arg, memperm, argent);
326         }
327 }
328
329 static void collect_memphi(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, entity *ent) {
330         int i, arity;
331         spill_t spill, *res;
332         int hash = HASH_PTR(node);
333
334         assert(is_Phi(node));
335
336         spill.spill = node;
337         res = set_find(env->spills, &spill, sizeof(spill), hash);
338         if(res != NULL) {
339                 return;
340         }
341
342         spill.ent = ent;
343         res = set_insert(env->spills, &spill, sizeof(spill), hash);
344
345         // is 1 of the arguments a spill?
346         for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
347                 ir_node* arg = get_irn_n(node, i);
348                 collect(env, arg, reload, ent);
349         }
350 }
351
352 static void collect(be_verify_spillslots_env_t *env, ir_node *node, ir_node *reload, entity* ent) {
353         if(be_is_Spill(node)) {
354                 collect_spill(env, node, reload, ent);
355         } else if(is_Proj(node)) {
356                 collect_memperm(env, node, reload, ent);
357         } else if(is_Phi(node) && get_irn_mode(node) == mode_M) {
358                 collect_memphi(env, node, reload, ent);
359         } else {
360                 ir_fprintf(stderr, "Verify warning: No spill, memperm or memphi attached to node %+F found from node %+F in block %+F(%s)\n",
361                         node, reload, get_nodes_block(node), get_irg_dump_name(env->irg));
362                 env->problem_found = 1;
363         }
364 }
365
366 /**
367  * This walker function searches for reloads and collects all the spills
368  * and memphis attached to them.
369  */
370 static void collect_spills_walker(ir_node *node, void *data) {
371         be_verify_spillslots_env_t *env = data;
372
373         if(be_is_Reload(node)) {
374                 ir_node *spill = get_irn_n(node, be_pos_Reload_mem);
375                 entity* ent = be_get_frame_entity(node);
376
377                 collect(env, spill, node, ent);
378                 ARR_APP1(ir_node*, env->reloads, node);
379         }
380 }
381
382 static void check_spillslot_interference(be_verify_spillslots_env_t *env) {
383         int spillcount = set_count(env->spills);
384         spill_t **spills = alloca(spillcount * sizeof(spills[0]));
385         spill_t *spill;
386         int i;
387
388         for(spill = set_first(env->spills), i = 0; spill != NULL; spill = set_next(env->spills), ++i) {
389                 spills[i] = spill;
390         }
391
392         for(i = 0; i < spillcount; ++i) {
393                 spill_t *sp1 = spills[i];
394                 int i2;
395
396                 for(i2 = i+1; i2 < spillcount; ++i2) {
397                         spill_t *sp2 = spills[i2];
398
399                         if(sp1->ent != sp2->ent)
400                                 continue;
401
402                         if(my_values_interfere(sp1->spill, sp2->spill)) {
403                                 ir_fprintf(stderr, "Verify warning: Spillslots for %+F in block %+F(%s) and %+F in block %+F(%s) interfere\n",
404                                         sp1->spill, get_nodes_block(sp1->spill), get_irg_dump_name(env->irg),
405                                         sp2->spill, get_nodes_block(sp2->spill), get_irg_dump_name(env->irg));
406                                 env->problem_found = 1;
407                                 my_values_interfere(sp1->spill, sp2->spill);
408                                 printf("Intf: %d\n", values_interfere(env->lv, sp1->spill, sp2->spill));
409                         }
410                 }
411         }
412 }
413
414 int be_verify_spillslots(ir_graph *irg)
415 {
416         be_verify_spillslots_env_t env;
417
418         env.irg = irg;
419         env.spills = new_set(cmp_spill, 10);
420         env.reloads = NEW_ARR_F(ir_node*, 0);
421         env.problem_found = 0;
422         env.lv = be_liveness(irg);
423
424         irg_walk_graph(irg, collect_spills_walker, NULL, &env);
425
426         check_spillslot_interference(&env);
427
428         be_liveness_free(env.lv);
429         DEL_ARR_F(env.reloads);
430         del_set(env.spills);
431
432         return ! env.problem_found;
433 }
434
435
436
437 //---------------------------------------------------------------------------
438
439
440
441 /**
442  * Check, if two values interfere.
443  * @param a The first value.
444  * @param b The second value.
445  * @return 1, if a and b interfere, 0 if not.
446  */
447 static int my_values_interfere(const ir_node *a, const ir_node *b)
448 {
449         const ir_edge_t *edge;
450         ir_node *bb;
451         int a2b = value_dominates(a, b);
452         int b2a = value_dominates(b, a);
453
454         /* If there is no dominance relation, they do not interfere. */
455         if(!a2b && !b2a)
456                 return 0;
457
458         /*
459          * Adjust a and b so, that a dominates b if
460          * a dominates b or vice versa.
461          */
462         if(b2a) {
463                 const ir_node *t = a;
464                 a = b;
465                 b = t;
466         }
467
468         bb = get_nodes_block(b);
469
470         /*
471          * Look at all usages of a.
472          * If there's one usage of a in the block of b, then
473          * we check, if this use is dominated by b, if that's true
474          * a and b interfere. Note that b must strictly dominate the user,
475          * since if b is the last user of in the block, b and a do not
476          * interfere.
477          * Uses of a not in b's block can be disobeyed, because the
478          * check for a being live at the end of b's block is already
479          * performed.
480          */
481         foreach_out_edge(a, edge) {
482                 const ir_node *user = get_edge_src_irn(edge);
483                 if(b == user)
484                         continue;
485
486                 if(get_irn_opcode(user) == iro_End)
487                         continue;
488
489                 // in case of phi arguments we compare with the block the value comes from
490                 if(is_Phi(user)) {
491                         ir_node *phiblock = get_nodes_block(user);
492                         if(phiblock == bb)
493                                 continue;
494                         user = get_irn_n(phiblock, get_edge_src_pos(edge));
495                 }
496
497                 if(value_dominates(b, user))
498                         return 1;
499         }
500
501         return 0;
502 }