removed check_heads assertions
[libfirm] / ir / be / becopyopt.c
1 /**
2  * Author:      Daniel Grund
3  * Date:                12.04.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  */
7 #ifdef HAVE_CONFIG_H
8 #include "config.h"
9 #endif
10 #ifdef HAVE_ALLOCA_H
11 #include <alloca.h>
12 #endif
13 #ifdef HAVE_MALLOC_H
14 #include <malloc.h>
15 #endif
16
17 #include "irprog.h"
18 #include "irloop_t.h"
19
20 #include "xmalloc.h"
21 #include "bechordal_t.h"
22 #include "becopyopt.h"
23 #include "becopystat.h"
24
25 static firm_dbg_module_t *dbg = NULL;
26
27 #define is_curr_reg_class(irn) \
28   (arch_get_irn_reg_class(get_arch_env(co), \
29                           irn, arch_pos_make_out(0)) == co->chordal_env->cls)
30
31 #define MIN(a,b) ((a<b)?(a):(b))
32 #define MAX(a,b) ((a<b)?(b):(a))
33
34 /**
35  * Computes the weight of a 'max independent set' wrt. ifg-edges only
36  * (no coloring conflicts, no register constraints)
37  * @return The costs of such a mis
38  * NOTE: Code adapted from becopyheur
39  * BETTER: Here we can be sure having a chordal graph to work on,
40  *                 so, for 'larger' opt-units we could use a special algorithm.
41  */
42 static int ou_max_ind_set_costs(unit_t *ou) {
43         ir_node **irns;
44         int max, pos, curr_weight, best_weight = 0;
45         bitset_t *curr;
46
47         irns = alloca((ou->node_count-1) * sizeof(*irns));
48         curr = bitset_alloca(ou->node_count-1);
49
50         /* brute force the best set */
51         bitset_set_all(curr);
52         while ((max = bitset_popcnt(curr)) != 0) {
53                 /* check if curr is a stable set */
54                 int i, o, is_stable_set = 1;
55
56                 /* copy the irns */
57                 i = 0;
58                 bitset_foreach(curr, pos)
59                         irns[i++] = ou->nodes[1+pos];
60                 assert(i==max);
61
62                 for(i=0; i<max; ++i)
63                         for(o=i+1; o<max; ++o) /* !!!!! difference to qnode_max_ind_set(): NOT o=i */
64                                 if (nodes_interfere(ou->co->chordal_env, irns[i], irns[o])) {
65                                         is_stable_set = 0;
66                                         break;
67                                 }
68
69                 if (is_stable_set) {
70                         /* calc current weigth */
71                         curr_weight = 0;
72                         bitset_foreach(curr, pos)
73                                 curr_weight += ou->costs[1+pos];
74
75                         /* any better ? */
76                         if (curr_weight > best_weight)
77                                 best_weight = curr_weight;
78                 }
79
80                 bitset_minus1(curr);
81         }
82         return best_weight;
83 }
84
85 /**
86  * Builds an optimization unit for a given optimizable irn (root).
87  * This opt-unit is inserted in the main structure co.
88  * If an arg of root itself is optimizable process this arg before with a
89  * recursive call. For handling this situation and loops co->root is used
90  * to remember all roots.
91  */
92 static void co_append_unit(copy_opt_t *co, ir_node *root) {
93         int i, arity;
94         unit_t *unit;
95         struct list_head *tmp;
96
97         DBG((dbg, LEVEL_1, "\t  Root: %n %N\n", root, root));
98         /* check if we encountered this root earlier */
99         if (pset_find_ptr(co->roots, root))
100                 return;
101         pset_insert_ptr(co->roots, root);
102
103         assert(is_curr_reg_class(root) && "node is in wrong register class!");
104
105         /* init unit */
106         arity = get_irn_arity(root);
107         unit = xcalloc(1, sizeof(*unit));
108         unit->co = co;
109         unit->nodes = xmalloc((arity+1) * sizeof(*unit->nodes));
110         unit->costs = xmalloc((arity+1) * sizeof(*unit->costs));
111         unit->node_count = 1;
112         unit->nodes[0] = root;
113         INIT_LIST_HEAD(&unit->queue);
114
115         /* check all args */
116         if (is_Phi(root)) {
117                 for (i=0; i<arity; ++i) {
118                         int o, arg_pos = 0;
119                         ir_node *arg = get_irn_n(root, i);
120
121                         assert(is_curr_reg_class(arg) && "Argument not in same register class.");
122                         if (arg == root)
123                                 continue;
124                         if (nodes_interfere(co->chordal_env, root, arg)) {
125                                 unit->inevitable_costs += co->get_costs(root, arg, i);
126                                 continue;
127                         }
128
129                         /* Else insert the argument of the phi to the members of this ou */
130                         DBG((dbg, LEVEL_1, "\t   Member: %n %N\n", arg, arg));
131
132                         /* Check if arg has occurred at a prior position in the arg/list */
133                         for (o=0; o<unit->node_count; ++o)
134                                 if (unit->nodes[o] == arg) {
135                                         arg_pos = o;
136                                         break;
137                                 }
138
139                         if (!arg_pos) { /* a new argument */
140                                 /* insert node, set costs */
141                                 unit->nodes[unit->node_count] = arg;
142                                 unit->costs[unit->node_count] = co->get_costs(root, arg, i);
143                                 unit->node_count++;
144                         } else { /* arg has occured before in same phi */
145                                 /* increase costs for existing arg */
146                                 unit->costs[arg_pos] += co->get_costs(root, arg, i);
147                         }
148                 }
149                 unit->nodes = xrealloc(unit->nodes, unit->node_count * sizeof(*unit->nodes));
150                 unit->costs = xrealloc(unit->costs, unit->node_count * sizeof(*unit->costs));
151         } else if (is_Copy(get_arch_env(co), root)) {
152                 assert(!nodes_interfere(co->chordal_env, root, get_Copy_src(root)));
153                 unit->nodes[1] = get_Copy_src(root);
154                 unit->costs[1] = co->get_costs(root, unit->nodes[1], -1);
155                 unit->node_count = 2;
156                 unit->nodes = xrealloc(unit->nodes, 2 * sizeof(*unit->nodes));
157                 unit->costs = xrealloc(unit->costs, 2 * sizeof(*unit->costs));
158         } else
159                 assert(0 && "This is not an optimizable node!");
160         /* TODO add ou's for 2-addr-code instructions */
161
162
163         /* Determine the maximum costs this unit can cause: all_nodes_cost */
164         for(i=1; i<unit->node_count; ++i) {
165                 unit->sort_key = MAX(unit->sort_key, unit->costs[i]);
166                 unit->all_nodes_costs += unit->costs[i];
167         }
168
169         /* Determine the minimal costs this unit will cause: min_nodes_costs */
170         unit->min_nodes_costs += unit->all_nodes_costs - ou_max_ind_set_costs(unit);
171
172         /* Insert the new ou according to its sort_key */
173         tmp = &co->units;
174         while (tmp->next != &co->units && list_entry_units(tmp->next)->sort_key > unit->sort_key)
175                 tmp = tmp->next;
176         list_add(&unit->units, tmp);
177 }
178
179 static void co_collect_in_block(ir_node *block, void *env) {
180         copy_opt_t *co = env;
181         struct list_head *head = get_block_border_head(co->chordal_env, block);
182         border_t *curr;
183
184         list_for_each_entry_reverse(border_t, curr, head, list)
185                 if (curr->is_def && curr->is_real && is_optimizable(get_arch_env(co), curr->irn))
186                         co_append_unit(co, curr->irn);
187 }
188
189 static void co_collect_units(copy_opt_t *co) {
190         DBG((dbg, LEVEL_1, "\tCollecting optimization units\n"));
191         co->roots = pset_new_ptr(64);
192         dom_tree_walk_irg(get_irg(co), co_collect_in_block, NULL, co);
193         del_pset(co->roots);
194 }
195
196 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, int (*get_costs)(ir_node*, ir_node*, int)) {
197         const char *s1, *s2, *s3;
198         int len;
199         copy_opt_t *co;
200
201         dbg = firm_dbg_register("ir.be.copyopt");
202         firm_dbg_set_mask(dbg, DEBUG_LVL_CO);
203
204         co = xcalloc(1, sizeof(*co));
205         co->chordal_env = chordal_env;
206         co->get_costs = get_costs;
207
208         s1 = get_irp_prog_name();
209         s2 = get_entity_name(get_irg_entity(get_irg(co)));
210         s3 = chordal_env->cls->name;
211         len = strlen(s1) + strlen(s2) + strlen(s3) + 5;
212         co->name = xmalloc(len);
213         snprintf(co->name, len, "%s__%s__%s", s1, s2, s3);
214         if (!strcmp(co->name, DEBUG_IRG))
215                 firm_dbg_set_mask(dbg, DEBUG_IRG_LVL_CO);
216         else
217                 firm_dbg_set_mask(dbg, DEBUG_LVL_CO);
218
219         INIT_LIST_HEAD(&co->units);
220         co_collect_units(co);
221         return co;
222 }
223
224 void free_copy_opt(copy_opt_t *co) {
225         unit_t *curr, *tmp;
226         xfree(co->name);
227         list_for_each_entry_safe(unit_t, curr, tmp, &co->units, units) {
228                 xfree(curr->nodes);
229                 xfree(curr);
230         }
231 }
232
233 int is_optimizable_arg(const copy_opt_t *co, ir_node *irn) {
234         int i, max;
235         for(i=0, max=get_irn_n_outs(irn); i<max; ++i) {
236                 ir_node *n = get_irn_out(irn, i);
237                 if ((is_Phi(n) || is_Perm(get_arch_env(co), n)) && (irn == n || !nodes_interfere(co->chordal_env, irn, n)))
238                         return 1;
239         }
240         return 0;
241 }
242
243 int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos) {
244         int cost = 0;
245         ir_loop *loop;
246         ir_node *root_block = get_nodes_block(root);
247
248         assert(pos==-1 || is_Phi(root));
249         if (pos == -1) {
250                 /* a perm places the copy in the same block as it resides */
251                 loop = get_irn_loop(root_block);
252         } else {
253                 /* for phis the copies are placed in the corresponding pred-block */
254                 loop = get_irn_loop(get_Block_cfgpred_block(root_block, pos));
255         }
256         if (loop)
257                 cost = 2*get_loop_depth(loop);
258         return cost+1;
259 }
260
261 int get_costs_all_one(ir_node *root, ir_node* arg, int pos) {
262         return 1;
263 }
264
265 int co_get_max_copy_costs(const copy_opt_t *co) {
266         int i, res = 0;
267         unit_t *curr;
268
269         list_for_each_entry(unit_t, curr, &co->units, units) {
270                 res += curr->inevitable_costs;
271                 for (i=1; i<curr->node_count; ++i)
272                         res += curr->costs[i];
273         }
274         return res;
275 }
276
277 int co_get_inevit_copy_costs(const copy_opt_t *co) {
278         int res = 0;
279         unit_t *curr;
280
281         list_for_each_entry(unit_t, curr, &co->units, units)
282                 res += curr->inevitable_costs;
283         return res;
284 }
285
286 int co_get_copy_costs(const copy_opt_t *co) {
287         int i, res = 0;
288         unit_t *curr;
289
290         list_for_each_entry(unit_t, curr, &co->units, units) {
291                 int root_col = get_irn_col(co, curr->nodes[0]);
292                 res += curr->inevitable_costs;
293                 DBG((dbg, LEVEL_1, "  Adding costs for root %+F color %d\n", curr->nodes[0], root_col));
294                 for (i=1; i<curr->node_count; ++i) {
295                         int arg_col = get_irn_col(co, curr->nodes[i]);
296                         if (root_col != arg_col) {
297                                 DBG((dbg, LEVEL_1, "  Arg %+F color %d costs %d\n", curr->nodes[i], arg_col, curr->costs[i]));
298                                 res += curr->costs[i];
299                         }
300                 }
301         }
302         return res;
303 }
304
305 int co_get_lower_bound(const copy_opt_t *co) {
306         int res = 0;
307         unit_t *curr;
308         list_for_each_entry(unit_t, curr, &co->units, units)
309                 res += curr->inevitable_costs + curr->min_nodes_costs;
310         return res;
311 }