support for custom attribute types on nodes
[libfirm] / ir / be / bespillmorgan.c
1 /*
2  * Copyright (C) 1995-2007 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       Morgans spill algorithm.
23  * @author      Matthias Braun
24  * @date        05.05.2006
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "irgwalk.h"
32 #include "irloop_t.h"
33 #include "irgraph_t.h"
34 #include "irprintf.h"
35 #include "obst.h"
36
37 #include "bespillmorgan.h"
38 #include "bechordal_t.h"
39 #include "bespill.h"
40 #include "belive_t.h"
41 #include "beabi.h"
42 #include "bespillbelady.h"
43 #include "beverify.h"
44 #include "benodesets.h"
45 #include "bespilloptions.h"
46 #include "besched.h"
47 #include "beutil.h"
48 #include "bemodule.h"
49 #include "beirg_t.h"
50
51 #define DBG_LIVE                1
52 #define DBG_LOOPANA             2
53 #define DBG_PRESSURE    4
54 #define DBG_SPILLS      8
55 #define DBG_CHOOSE              16
56 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57
58 typedef struct morgan_env {
59         const arch_env_t *arch;
60         const arch_register_class_t *cls;
61         ir_graph *irg;
62         const be_lv_t *lv;
63         struct obstack obst;
64         /** maximum safe register pressure */
65         int registers_available;
66
67         spill_env_t *senv;
68
69         set *loop_attr_set;
70         set *block_attr_set;
71 } morgan_env_t;
72
73 typedef struct loop_edge {
74         ir_node *block;
75         int pos;
76 } loop_edge_t;
77
78 typedef struct loop_attr {
79         const ir_loop *loop;
80         set *out_edges;
81         set *in_edges;
82         /** The set of all values that are live in the loop but not used in the loop */
83         bitset_t *livethrough_unused;
84 } loop_attr_t;
85
86 typedef struct morgan_block_attr {
87         const ir_node *block;
88         /** set of all values that are live in the block but not used in the block */
89         bitset_t *livethrough_unused;
90 } block_attr_t;
91
92 //---------------------------------------------------------------------------
93
94 static int loop_edge_cmp(const void* p1, const void* p2, size_t s) {
95         loop_edge_t *e1 = (loop_edge_t*) p1;
96         loop_edge_t *e2 = (loop_edge_t*) p2;
97
98         return e1->block != e2->block || e1->pos != e2->pos;
99 }
100
101 static int loop_attr_cmp(const void *e1, const void *e2, size_t s) {
102         loop_attr_t *la1 = (loop_attr_t*) e1;
103         loop_attr_t *la2 = (loop_attr_t*) e2;
104
105         return la1->loop != la2->loop;
106 }
107
108 static int block_attr_cmp(const void *e1, const void *e2, size_t s) {
109         block_attr_t *b1 = (block_attr_t*) e1;
110         block_attr_t *b2 = (block_attr_t*) e2;
111
112         return b1->block != b2->block;
113 }
114
115 static INLINE int loop_attr_hash(const loop_attr_t *a) {
116 #ifdef DEBUG_libfirm
117         return a->loop->loop_nr;
118 #else
119         return HASH_PTR(a->loop);
120 #endif
121 }
122
123 static INLINE int block_attr_hash(const block_attr_t *b) {
124         return nodeset_hash(b->block);
125 }
126
127 static INLINE int loop_edge_hash(const loop_edge_t *e) {
128         return nodeset_hash(e->block) ^ (e->pos * 31);
129 }
130
131 static INLINE loop_attr_t *get_loop_attr(morgan_env_t *env, const ir_loop *loop) {
132         loop_attr_t l_attr, *res;
133         int hash;
134         l_attr.loop = loop;
135
136         hash = loop_attr_hash(&l_attr);
137         res = set_find(env->loop_attr_set, &l_attr, sizeof(l_attr), hash);
138
139         // create new loop_attr if none exists yet
140         if (res == NULL) {
141                 l_attr.out_edges = new_set(loop_edge_cmp, 1);
142                 l_attr.in_edges = new_set(loop_edge_cmp, 1);
143                 l_attr.livethrough_unused = bitset_obstack_alloc(&env->obst, get_irg_last_idx(env->irg));
144                 res = set_insert(env->loop_attr_set, &l_attr, sizeof(l_attr), hash);
145         }
146
147         return res;
148 }
149
150 static INLINE block_attr_t *get_block_attr(morgan_env_t *env, const ir_node *block) {
151         block_attr_t b_attr, *res;
152         int hash;
153         b_attr.block = block;
154
155         hash = block_attr_hash(&b_attr);
156         res = set_find(env->block_attr_set, &b_attr, sizeof(b_attr), hash);
157
158         if(res == NULL) {
159                 b_attr.livethrough_unused = NULL;
160                 res = set_insert(env->block_attr_set, &b_attr, sizeof(b_attr), hash);
161         }
162
163         return res;
164 }
165
166 //---------------------------------------------------------------------------
167
168 static INLINE int consider_for_spilling(const arch_env_t *env, const arch_register_class_t *cls, const ir_node *node) {
169         if(!arch_irn_has_reg_class(env, node, -1, cls))
170                 return 0;
171
172         return !(arch_irn_get_flags(env, node) & (arch_irn_flags_ignore | arch_irn_flags_dont_spill));
173 }
174
175 /**
176  * Determine edges going out of a loop (= edges that go to a block that is not
177  * inside the loop or one of its subloops)
178  */
179 static INLINE void construct_loop_edges(ir_node *block, void *data) {
180         morgan_env_t *env = data;
181         int n_cfgpreds = get_Block_n_cfgpreds(block);
182         int i;
183         ir_loop* loop = get_irn_loop(block);
184         DBG((dbg, DBG_LOOPANA, "Loop for %+F: %d (depth %d)\n", block, loop->loop_nr, loop->depth));
185
186         for(i = 0; i < n_cfgpreds; ++i) {
187                 loop_edge_t edge;
188                 int hash;
189                 ir_node* cfgpred = get_Block_cfgpred(block, i);
190                 ir_node* cfgpred_block = get_nodes_block(cfgpred);
191                 ir_loop* cfgpred_loop = get_irn_loop(cfgpred_block);
192
193                 if(cfgpred_loop == loop)
194                         continue;
195
196                 assert(get_loop_depth(cfgpred_loop) != get_loop_depth(loop));
197
198                 edge.block = block;
199                 edge.pos = i;
200                 hash = loop_edge_hash(&edge);
201
202                 // edge out of a loop?
203                 if(get_loop_depth(cfgpred_loop) > get_loop_depth(loop)) {
204                         ir_loop *l;
205
206                         DBG((dbg, DBG_LOOPANA, "Loop out edge from %+F (loop %d) to %+F (loop %d)\n", block, get_loop_loop_nr(loop),
207                              cfgpred_block, get_loop_loop_nr(cfgpred_loop)));
208
209                         /* this might be a jump out of multiple loops, so add this to all
210                      * needed outedge sets */
211                         l = cfgpred_loop;
212                         do {
213                                 loop_attr_t *l_attr = get_loop_attr(env, l);
214                                 set_insert(l_attr->out_edges, &edge, sizeof(edge), hash);
215
216                                 l = get_loop_outer_loop(l);
217                                 assert(l != NULL);
218                         } while(l != loop);
219                 } else {
220                         ir_loop *l;
221
222                         // edge into a loop
223                         DBG((dbg, DBG_LOOPANA, "Loop in edge from %+F (loop %d) to %+F (loop %d)\n", block, get_loop_loop_nr(loop),
224                              cfgpred_block, get_loop_loop_nr(cfgpred_loop)));
225
226                         l = loop;
227                         do {
228                                 loop_attr_t *l_attr = get_loop_attr(env, l);
229                                 set_insert(l_attr->in_edges, &edge, sizeof(edge), hash);
230
231                                 l = get_loop_outer_loop(l);
232                         } while(l != cfgpred_loop);
233                 }
234         }
235 }
236
237 static void free_loop_edges(morgan_env_t *env) {
238         loop_attr_t *l_attr;
239
240         for(l_attr = set_first(env->loop_attr_set); l_attr != NULL; l_attr = set_next(env->loop_attr_set)) {
241                 del_set(l_attr->out_edges);
242                 del_set(l_attr->in_edges);
243         }
244 }
245
246 #if 0
247 /**
248  * Debugging help, shows all nodes in a (node-)bitset
249  */
250 static void show_nodebitset(ir_graph* irg, const bitset_t* bitset) {
251         int i;
252
253         bitset_foreach(bitset, i) {
254                 ir_node* node = get_idx_irn(irg, i);
255                 ir_fprintf(stderr, " %+F", node);
256         }
257         fprintf(stderr, "\n");
258 }
259 #endif
260
261 static INLINE void init_livethrough_unuseds(block_attr_t *attr, morgan_env_t *env) {
262         const ir_node *block;
263         int i;
264         const be_lv_t *lv = env->lv;
265
266         if(attr->livethrough_unused != NULL)
267                 return;
268
269         block = attr->block;
270
271         attr->livethrough_unused = bitset_obstack_alloc(&env->obst, get_irg_last_idx(env->irg));
272
273         // copy all live-outs into the livethrough_unused set
274         be_lv_foreach(lv, block, be_lv_state_in | be_lv_state_out, i) {
275                 ir_node *irn = be_lv_get_irn(lv, block, i);
276                 int node_idx;
277
278                 if(!consider_for_spilling(env->arch, env->cls, irn))
279                         continue;
280
281                 node_idx = get_irn_idx(irn);
282                 bitset_set(attr->livethrough_unused, node_idx);
283         }
284 }
285
286 /**
287  * Construct the livethrough unused set for a block
288  */
289 static void construct_block_livethrough_unused(ir_node *block, void *data) {
290         morgan_env_t* env = data;
291         block_attr_t *block_attr = get_block_attr(env, block);
292         ir_node *node;
293         int n_cfgpreds;
294         block_attr_t **pred_attrs = NULL;
295         int i;
296
297         init_livethrough_unuseds(block_attr, env);
298
299         DBG((dbg, DBG_LIVE, "Processing block %d\n", get_irn_node_nr(block)));
300
301         n_cfgpreds = get_Block_n_cfgpreds(block);
302         if(n_cfgpreds > 1) {
303                 pred_attrs = alloca(sizeof(pred_attrs[0]) * n_cfgpreds);
304                 for(i = 0; i < n_cfgpreds; ++i) {
305                         ir_node *pred_block = get_Block_cfgpred_block(block, i);
306                         pred_attrs[i] = get_block_attr(env, pred_block);
307                         init_livethrough_unuseds(pred_attrs[i], env);
308                 }
309         }
310
311         /*
312          * All values that are used within the block are not unused (and therefore not
313          * livethrough_unused)
314          */
315         sched_foreach(block, node) {
316                 int i, arity;
317
318                 // phis are really uses in the pred block
319                 if(is_Phi(node)) {
320                         int j;
321                         for(j = 0; j < n_cfgpreds; ++j) {
322                                 ir_node *used_value = get_Phi_pred(node, j);
323                                 int idx = get_irn_idx(used_value);
324                                 block_attr_t *pred_attr = pred_attrs[j];
325
326                                 bitset_clear(pred_attr->livethrough_unused, idx);
327                         }
328                 } else {
329                         // mark all used values as used
330                         for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
331                                 int idx = get_irn_idx(get_irn_n(node, i));
332                                 bitset_clear(block_attr->livethrough_unused, idx);
333                         }
334                 }
335         }
336 }
337
338 /**
339  * Construct the livethrough unused set for a loop (and all its subloops+blocks)
340  */
341 static bitset_t *construct_loop_livethrough_unused(morgan_env_t *env, const ir_loop *loop) {
342         int i;
343         loop_attr_t* loop_attr = get_loop_attr(env, loop);
344
345         DBG((dbg, DBG_LIVE, "Processing Loop %d\n", loop->loop_nr));
346         assert(get_loop_n_elements(loop) > 0);
347         for(i = 0; i < get_loop_n_elements(loop); ++i) {
348                 loop_element elem = get_loop_element(loop, i);
349                 switch (*elem.kind) {
350                 case k_ir_node: {
351                         ir_node *block = elem.node;
352                         block_attr_t *block_attr = get_block_attr(env, block);
353                         bitset_t *livethrough_block_unused = block_attr->livethrough_unused;
354
355                         assert(is_Block(elem.node));
356                         assert(livethrough_block_unused != NULL);
357
358                         if(i == 0) {
359                                 bitset_copy(loop_attr->livethrough_unused, livethrough_block_unused);
360                         } else {
361                                 bitset_and(loop_attr->livethrough_unused, livethrough_block_unused);
362                         }
363                         break;
364                 }
365                 case k_ir_loop: {
366                         bitset_t *livethrough_son_unused;
367
368                         livethrough_son_unused = construct_loop_livethrough_unused(env, elem.son);
369                         if(i == 0) {
370                                 bitset_copy(loop_attr->livethrough_unused, livethrough_son_unused);
371                         } else {
372                                 bitset_and(loop_attr->livethrough_unused, livethrough_son_unused);
373                         }
374                         break;
375                 }
376             default:
377                         assert(0);
378                         break;
379                 }
380     }
381         DBG((dbg, DBG_LIVE, "Done with loop %d\n", loop->loop_nr));
382
383         // remove all unused livethroughs that are remembered for this loop from child loops and blocks
384         for(i = 0; i < get_loop_n_elements(loop); ++i) {
385                 const loop_element elem = get_loop_element(loop, i);
386
387                 if(*elem.kind == k_ir_loop) {
388                         loop_attr_t *son_attr = get_loop_attr(env, elem.son);
389                         bitset_andnot(son_attr->livethrough_unused, loop_attr->livethrough_unused);
390
391                         DBG((dbg, DBG_LIVE, "Livethroughs for loop %d:\n", loop->loop_nr));
392                 } else if(*elem.kind == k_ir_node) {
393                         block_attr_t *block_attr = get_block_attr(env, elem.node);
394                         bitset_andnot(block_attr->livethrough_unused, loop_attr->livethrough_unused);
395
396                         DBG((dbg, DBG_LIVE, "Livethroughs for block %+F\n", elem.node));
397                 } else {
398                         assert(0);
399                 }
400         }
401
402         return loop_attr->livethrough_unused;
403 }
404
405 /*---------------------------------------------------------------------------*/
406
407 typedef struct _spillcandidate_t {
408         ir_node *node;
409         int cost;
410 } spillcandidate_t;
411
412 static int compare_spillcandidates(const void *d1, const void *d2) {
413         const spillcandidate_t *cand1 = d1;
414         const spillcandidate_t *cand2 = d2;
415
416         return cand1->cost - cand2->cost;
417 }
418
419 static void spill_values(morgan_env_t *env, const loop_attr_t *loop_attr, int spills) {
420         const bitset_t *cand_bitset = loop_attr->livethrough_unused;
421         int candidatecount = bitset_popcnt(cand_bitset);
422         spillcandidate_t *candidates;
423         int i, c;
424         loop_edge_t *edge;
425
426         assert(spills <= candidatecount);
427
428         candidates = alloca(sizeof(candidates[0]) * candidatecount);
429
430         DBG((dbg, DBG_CHOOSE, "Candidates for loop %d\n", get_loop_loop_nr(loop_attr->loop)));
431         // build candidiatelist
432         c = 0;
433         bitset_foreach(cand_bitset, i) {
434                 ir_node *node = get_idx_irn(env->irg, i);
435                 candidates[c].node = node;
436                 candidates[c].cost = 0;
437
438                 for(edge = set_first(loop_attr->out_edges); edge != NULL; edge = set_next(loop_attr->out_edges)) {
439                         candidates[c].cost += be_get_reload_costs_on_edge(env->senv, node, edge->block, edge->pos);
440                 }
441                 DBG((dbg, DBG_CHOOSE, "%+F has costs %d\n", node, candidates[c].cost));
442
443                 c++;
444         }
445         assert(c == candidatecount);
446
447         // sort list
448         qsort(candidates, candidatecount, sizeof(candidates[0]), compare_spillcandidates);
449
450         // spill values
451         for(i = 0; i < spills; ++i) {
452                 ir_node *to_spill = candidates[i].node;
453                 DBG((dbg, DBG_CHOOSE, "Spilling %+F ", to_spill));
454
455                 for(edge = set_first(loop_attr->out_edges); edge != NULL; edge = set_next(loop_attr->out_edges)) {
456                         be_add_reload_on_edge(env->senv, to_spill, edge->block, edge->pos, env->cls, 1);
457                 }
458         }
459 }
460
461 static int reduce_register_pressure_in_block(morgan_env_t *env, const ir_node* block, int loop_unused_spills_possible) {
462         ir_node *node;
463         int max_pressure;
464         int loop_unused_spills_needed;
465         pset *live_nodes = pset_new_ptr_default();
466         const be_lv_t *lv = env->lv;
467
468         be_liveness_end_of_block(lv, env->arch, env->cls, block, live_nodes);
469         max_pressure = pset_count(live_nodes);
470
471         DBG((dbg, DBG_LIVE, "Reduce pressure to %d In Block %+F:\n", env->registers_available, block));
472
473         /**
474          * Determine register pressure in block
475          */
476         sched_foreach_reverse(block, node) {
477                 int pressure;
478
479                 if(is_Phi(node))
480                         break;
481
482                 be_liveness_transfer(env->arch, env->cls, node, live_nodes);
483                 pressure = pset_count(live_nodes);
484                 if(pressure > max_pressure)
485                         max_pressure = pressure;
486         }
487         del_pset(live_nodes);
488
489         loop_unused_spills_needed = max_pressure - env->registers_available;
490
491         if(loop_unused_spills_needed < 0) {
492                 loop_unused_spills_needed = 0;
493         } else if(loop_unused_spills_needed > loop_unused_spills_possible) {
494                 loop_unused_spills_needed = loop_unused_spills_possible;
495         }
496
497         DBG((dbg, DBG_PRESSURE, "Block %+F: max-pressure %d spills possible: %d spills used: %d\n",
498                  block, max_pressure, loop_unused_spills_possible, loop_unused_spills_needed));
499         return loop_unused_spills_needed;
500 }
501
502 /**
503  * Reduce register pressure in a loop
504  *
505  * @param unused_spills_possible        Number of spills from livethrough_unused variables possible in outer loops
506  * @return                                                      Number of spills of livethrough_unused variables needed in outer loops
507  */
508 static int reduce_register_pressure_in_loop(morgan_env_t *env, const ir_loop *loop, int outer_spills_possible) {
509         int i;
510         loop_attr_t* loop_attr = get_loop_attr(env, loop);
511         int spills_needed = 0;
512         int spills_possible = outer_spills_possible + bitset_popcnt(loop_attr->livethrough_unused);
513         int outer_spills_needed;
514
515         DBG((dbg, DBG_PRESSURE, "Reducing Pressure in loop %d\n", loop->loop_nr));
516         for(i = 0; i < get_loop_n_elements(loop); ++i) {
517                 loop_element elem = get_loop_element(loop, i);
518                 switch (*elem.kind) {
519                 case k_ir_node: {
520                         int needed;
521                         assert(is_Block(elem.node));
522                         needed = reduce_register_pressure_in_block(env, elem.node, spills_possible);
523                         assert(needed >= 0);
524                         assert(needed <= spills_possible);
525                         if(needed > spills_needed)
526                                 spills_needed = needed;
527                         break;
528                 }
529                 case k_ir_loop: {
530                         int needed = reduce_register_pressure_in_loop(env, elem.son, spills_possible);
531                         assert(needed >= 0);
532                         assert(needed <= spills_possible);
533                         if(needed > spills_needed)
534                                 spills_needed = needed;
535                         break;
536                 }
537             default:
538                         assert(0);
539                         break;
540                 }
541     }
542
543         /* calculate number of spills needed in outer loop and spill
544          * unused livethrough nodes around this loop */
545         if(spills_needed > outer_spills_possible) {
546                 int spills_to_place;
547                 outer_spills_needed = outer_spills_possible;
548                 spills_needed -= outer_spills_possible;
549
550                 spills_to_place = spills_needed;
551
552                 DBG((dbg, DBG_SPILLS, "%d values unused in loop %d, spilling %d\n",
553                  spills_possible - outer_spills_possible, loop->loop_nr, spills_to_place));
554
555                 spill_values(env, loop_attr, spills_to_place);
556         } else {
557                 outer_spills_needed = spills_needed;
558         }
559
560         return outer_spills_needed;
561 }
562
563 void be_spill_morgan(be_irg_t *birg, const arch_register_class_t *cls) {
564         ir_graph     *irg = be_get_birg_irg(birg);
565         morgan_env_t env;
566
567         be_assure_liveness(birg);
568
569         env.arch = birg->main_env->arch_env;
570         env.irg  = irg;
571         env.cls  = cls;
572         env.lv   = be_get_birg_liveness(birg);
573         env.senv = be_new_spill_env(birg);
574         DEBUG_ONLY(be_set_spill_env_dbg_module(env.senv, dbg);)
575
576         obstack_init(&env.obst);
577
578         env.registers_available = env.cls->n_regs - be_put_ignore_regs(birg, env.cls, NULL);
579
580         env.loop_attr_set  = new_set(loop_attr_cmp, 5);
581         env.block_attr_set = new_set(block_attr_cmp, 20);
582
583         /* -- Part1: Analysis -- */
584
585         /* construct control flow loop tree */
586         if (! (get_irg_loopinfo_state(irg) & loopinfo_cf_consistent)) {
587                 construct_cf_backedges(irg);
588         }
589
590         /* construct loop out edges and livethrough_unused sets for loops and blocks */
591         irg_block_walk_graph(irg, construct_block_livethrough_unused, construct_loop_edges, &env);
592         construct_loop_livethrough_unused(&env, get_irg_loop(irg));
593
594         /* -- Part2: Transformation -- */
595
596         /* spill unused livethrough values around loops and blocks where
597          * the pressure is too high
598          */
599         reduce_register_pressure_in_loop(&env, get_irg_loop(irg), 0);
600
601         /* Insert real spill/reload nodes and fix usages */
602         be_insert_spills_reloads(env.senv);
603
604         /* Verify the result */
605         if (birg->main_env->options->vrfy_option == BE_VRFY_WARN) {
606                 be_verify_schedule(birg);
607         } else if (birg->main_env->options->vrfy_option == BE_VRFY_ASSERT) {
608                 assert(be_verify_schedule(birg));
609         }
610
611         /* cleanup */
612         free_loop_edges(&env);
613         del_set(env.loop_attr_set);
614         del_set(env.block_attr_set);
615
616         /* fix the remaining places with too high register pressure with beladies algorithm */
617         be_spill_belady_spill_env(birg, cls, env.senv);
618
619         be_delete_spill_env(env.senv);
620         obstack_free(&env.obst, NULL);
621 }
622
623 void be_init_spillmorgan(void)
624 {
625         static be_spiller_t morgan_spiller = {
626                 be_spill_morgan
627         };
628
629         be_register_spiller("morgan", &morgan_spiller);
630         FIRM_DBG_REGISTER(dbg, "ir.be.spillmorgan");
631 }
632
633 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_spillmorgan);