Keep flag added
[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 "beutil.h"
22 #include "bechordal_t.h"
23 #include "becopyopt.h"
24 #include "becopystat.h"
25
26 static firm_dbg_module_t *dbg = NULL;
27
28 #define is_curr_reg_class(irn) \
29   (arch_get_irn_reg_class(get_arch_env(co), \
30                           irn, -1) == co->chordal_env->cls)
31
32 #define MIN(a,b) ((a<b)?(a):(b))
33 #define MAX(a,b) ((a<b)?(b):(a))
34
35
36 /**
37  * Determines a maximum weighted independent set with respect to
38  * the interference and conflict edges of all nodes in a qnode.
39  */
40 static int ou_max_ind_set_costs(unit_t *ou) {
41         be_chordal_env_t *chordal_env = ou->co->chordal_env;
42         ir_node **safe, **unsafe;
43         int i, o, safe_count, safe_costs, unsafe_count, *unsafe_costs;
44         bitset_t *curr;
45         int max, pos, curr_weight, best_weight = 0;
46
47         /* assign the nodes into two groups.
48          * safe: node has no interference, hence it is in every max stable set.
49          * unsafe: node has an interference
50          */
51         safe = alloca((ou->node_count-1) * sizeof(*safe));
52         safe_costs = 0;
53         safe_count = 0;
54         unsafe = alloca((ou->node_count-1) * sizeof(*unsafe));
55         unsafe_costs = alloca((ou->node_count-1) * sizeof(*unsafe_costs));
56         unsafe_count = 0;
57         for(i=1; i<ou->node_count; ++i) {
58                 int is_safe = 1;
59                 for(o=1; o<ou->node_count; ++o) {
60                         if (i==o)
61                                 continue;
62                         if (nodes_interfere(chordal_env, ou->nodes[i], ou->nodes[o])) {
63                                 unsafe_costs[unsafe_count] = ou->costs[i];
64                                 unsafe[unsafe_count] = ou->nodes[i];
65                                 ++unsafe_count;
66                                 is_safe = 0;
67                                 break;
68                         }
69                 }
70                 if (is_safe) {
71                         safe_costs += ou->costs[i];
72                         safe[safe_count++] = ou->nodes[i];
73                 }
74         }
75
76
77         /* now compute the best set out of the unsafe nodes*/
78         if (unsafe_count > MIS_HEUR_TRIGGER) {
79                 bitset_t *best = bitset_alloca(unsafe_count);
80                 /* Heuristik: Greedy trial and error form index 0 to unsafe_count-1 */
81                 for (i=0; i<unsafe_count; ++i) {
82                         bitset_set(best, i);
83                         /* check if it is a stable set */
84                         for (o=bitset_next_set(best, 0); o!=-1 && o<i; o=bitset_next_set(best, o+1))
85                                 if (nodes_interfere(chordal_env, unsafe[i], unsafe[o])) {
86                                         bitset_clear(best, i); /* clear the bit and try next one */
87                                         break;
88                                 }
89                 }
90                 /* compute the weight */
91                 bitset_foreach(best, pos)
92                         best_weight += unsafe_costs[pos];
93         } else {
94                 /* Exact Algorithm: Brute force */
95                 curr = bitset_alloca(unsafe_count);
96                 bitset_set_all(curr);
97                 while ((max = bitset_popcnt(curr)) != 0) {
98                         /* check if curr is a stable set */
99                         for (i=bitset_next_set(curr, 0); i!=-1; i=bitset_next_set(curr, i+1))
100                                 for (o=bitset_next_set(curr, i+1); o!=-1; o=bitset_next_set(curr, o+1)) /* !!!!! difference to qnode_max_ind_set(): NOT (curr, i) */
101                                                 if (nodes_interfere(chordal_env, unsafe[i], unsafe[o]))
102                                                         goto no_stable_set;
103
104                         /* if we arrive here, we have a stable set */
105                         /* compute the weigth of the stable set*/
106                         curr_weight = 0;
107                         bitset_foreach(curr, pos)
108                                 curr_weight += unsafe_costs[pos];
109
110                         /* any better ? */
111                         if (curr_weight > best_weight) {
112                                 best_weight = curr_weight;
113                         }
114
115         no_stable_set:
116                         bitset_minus1(curr);
117                 }
118         }
119
120         return safe_costs+best_weight;
121 }
122
123 static void co_collect_units(ir_node *irn, void *env) {
124         copy_opt_t *co = env;
125         unit_t *unit;
126         arch_register_req_t req;
127
128         if (!is_curr_reg_class(irn))
129                 return;
130         if (!is_optimizable(get_arch_env(co), irn, &req))
131                 return;
132
133         /* Init a new unit */
134         unit = xcalloc(1, sizeof(*unit));
135         unit->co = co;
136         unit->node_count = 1;
137         INIT_LIST_HEAD(&unit->queue);
138
139         /* Phi with some/all of its arguments */
140         if (is_Reg_Phi(irn)) {
141                 int i, arity;
142
143                 /* init */
144                 arity = get_irn_arity(irn);
145                 unit->nodes = xmalloc((arity+1) * sizeof(*unit->nodes));
146                 unit->costs = xmalloc((arity+1) * sizeof(*unit->costs));
147                 unit->nodes[0] = irn;
148
149                 /* fill */
150                 for (i=0; i<arity; ++i) {
151                         int o, arg_pos;
152                         ir_node *arg = get_irn_n(irn, i);
153
154                         assert(is_curr_reg_class(arg) && "Argument not in same register class.");
155                         if (arg == irn)
156                                 continue;
157                         if (nodes_interfere(co->chordal_env, irn, arg)) {
158                                 unit->inevitable_costs += co->get_costs(irn, arg, i);
159                                 continue;
160                         }
161
162                         /* Else insert the argument of the phi to the members of this ou */
163                         DBG((dbg, LEVEL_1, "\t   Member: %+F\n", arg));
164
165                         /* Check if arg has occurred at a prior position in the arg/list */
166                         arg_pos = 0;
167                         for (o=0; o<unit->node_count; ++o)
168                                 if (unit->nodes[o] == arg) {
169                                         arg_pos = o;
170                                         break;
171                                 }
172
173                         if (!arg_pos) { /* a new argument */
174                                 /* insert node, set costs */
175                                 unit->nodes[unit->node_count] = arg;
176                                 unit->costs[unit->node_count] = co->get_costs(irn, arg, i);
177                                 unit->node_count++;
178                         } else { /* arg has occured before in same phi */
179                                 /* increase costs for existing arg */
180                                 unit->costs[arg_pos] += co->get_costs(irn, arg, i);
181                         }
182                 }
183                 unit->nodes = xrealloc(unit->nodes, unit->node_count * sizeof(*unit->nodes));
184                 unit->costs = xrealloc(unit->costs, unit->node_count * sizeof(*unit->costs));
185         } else
186
187         /* Proj of a perm with corresponding arg */
188         if (is_Perm_Proj(get_arch_env(co), irn)) {
189                 assert(!nodes_interfere(co->chordal_env, irn, get_Copy_src(irn)));
190                 unit->nodes = xmalloc(2 * sizeof(*unit->nodes));
191                 unit->costs = xmalloc(2 * sizeof(*unit->costs));
192                 unit->node_count = 2;
193                 unit->nodes[0] = irn;
194                 unit->nodes[1] = get_Copy_src(irn);
195                 unit->costs[1] = co->get_costs(irn, unit->nodes[1], -1);
196         } else
197
198         /* Src == Tgt of a 2-addr-code instruction */
199         if (is_2addr_code(get_arch_env(co), irn, &req)) {
200                 ir_node *other = req.other;
201                 if (!nodes_interfere(co->chordal_env, irn, other)) {
202                         unit->nodes = xmalloc(2 * sizeof(*unit->nodes));
203                         unit->costs = xmalloc(2 * sizeof(*unit->costs));
204                         unit->node_count = 2;
205                         unit->nodes[0] = irn;
206                         unit->nodes[1] = other;
207                         unit->costs[1] = co->get_costs(irn, other, -120480);
208                 }
209         } else
210                 assert(0 && "This is not an optimizable node!");
211
212         /* Insert the new unit at a position according to its costs */
213         if (unit->node_count > 1) {
214                 int i;
215                 struct list_head *tmp;
216
217                 /* Determine the maximum costs this unit can cause: all_nodes_cost */
218                 for(i=1; i<unit->node_count; ++i) {
219                         unit->sort_key = MAX(unit->sort_key, unit->costs[i]);
220                         unit->all_nodes_costs += unit->costs[i];
221                 }
222
223                 /* Determine the minimal costs this unit will cause: min_nodes_costs */
224                 unit->min_nodes_costs += unit->all_nodes_costs - ou_max_ind_set_costs(unit);
225
226                 /* Insert the new ou according to its sort_key */
227                 tmp = &co->units;
228                 while (tmp->next != &co->units && list_entry_units(tmp->next)->sort_key > unit->sort_key)
229                         tmp = tmp->next;
230                 list_add(&unit->units, tmp);
231         } else {
232                 free(unit);
233         }
234 }
235
236 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, int (*get_costs)(ir_node*, ir_node*, int)) {
237         const char *s1, *s2, *s3;
238         int len;
239         copy_opt_t *co;
240
241         dbg = firm_dbg_register("ir.be.copyopt");
242
243         co = xcalloc(1, sizeof(*co));
244         co->chordal_env = chordal_env;
245         co->get_costs = get_costs;
246
247         s1 = get_irp_prog_name();
248         s2 = get_entity_name(get_irg_entity(get_irg(co)));
249         s3 = chordal_env->cls->name;
250         len = strlen(s1) + strlen(s2) + strlen(s3) + 5;
251         co->name = xmalloc(len);
252         snprintf(co->name, len, "%s__%s__%s", s1, s2, s3);
253
254         DBG((dbg, LEVEL_1, "\tCollecting optimization units\n"));
255         INIT_LIST_HEAD(&co->units);
256         irg_walk_graph(get_irg(co), co_collect_units, NULL, co);
257         return co;
258 }
259
260 void free_copy_opt(copy_opt_t *co) {
261         unit_t *curr, *tmp;
262         xfree(co->name);
263         list_for_each_entry_safe(unit_t, curr, tmp, &co->units, units) {
264                 xfree(curr->nodes);
265                 xfree(curr->costs);
266                 xfree(curr);
267         }
268 }
269
270 int is_optimizable_arg(const copy_opt_t *co, ir_node *irn) {
271         arch_env_t *aenv = co->chordal_env->main_env->arch_env;
272         const ir_edge_t *edge;
273
274         foreach_out_edge(irn, edge) {
275                 ir_node *n = edge->src;
276                 arch_register_req_t req;
277
278                 arch_get_register_req(aenv, &req, n, -1);
279
280                 if(     (       (req.type == arch_register_req_type_should_be_same && req.other == irn) ||
281                                 is_Reg_Phi(n) ||
282                                 is_Perm(get_arch_env(co), n)
283                         ) && (irn == n || !nodes_interfere(co->chordal_env, irn, n)))
284                                 return 1;
285         }
286
287         return 0;
288 }
289
290 int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos) {
291         int cost = 0;
292         ir_loop *loop;
293         ir_node *root_block = get_nodes_block(root);
294
295         if (is_Phi(root)) {
296                 /* for phis the copies are placed in the corresponding pred-block */
297                 loop = get_irn_loop(get_Block_cfgpred_block(root_block, pos));
298         } else {
299                 /* a perm places the copy in the same block as it resides */
300                 loop = get_irn_loop(root_block);
301         }
302         if (loop) {
303                 int d = get_loop_depth(loop);
304                 cost = d*d;
305         }
306         return cost+1;
307 }
308
309 int get_costs_all_one(ir_node *root, ir_node* arg, int pos) {
310         return 1;
311 }
312
313 int co_get_max_copy_costs(const copy_opt_t *co) {
314         int i, res = 0;
315         unit_t *curr;
316
317         list_for_each_entry(unit_t, curr, &co->units, units) {
318                 res += curr->inevitable_costs;
319                 for (i=1; i<curr->node_count; ++i)
320                         res += curr->costs[i];
321         }
322         return res;
323 }
324
325 int co_get_inevit_copy_costs(const copy_opt_t *co) {
326         int res = 0;
327         unit_t *curr;
328
329         list_for_each_entry(unit_t, curr, &co->units, units)
330                 res += curr->inevitable_costs;
331         return res;
332 }
333
334 int co_get_copy_costs(const copy_opt_t *co) {
335         int i, res = 0;
336         unit_t *curr;
337
338         list_for_each_entry(unit_t, curr, &co->units, units) {
339                 int root_col = get_irn_col(co, curr->nodes[0]);
340                 DBG((dbg, LEVEL_1, "  %3d costs for root %+F color %d\n", curr->inevitable_costs, curr->nodes[0], root_col));
341                 res += curr->inevitable_costs;
342                 for (i=1; i<curr->node_count; ++i) {
343                         int arg_col = get_irn_col(co, curr->nodes[i]);
344                         if (root_col != arg_col) {
345                                 DBG((dbg, LEVEL_1, "  %3d for arg %+F color %d\n", curr->costs[i], curr->nodes[i], arg_col));
346                                 res += curr->costs[i];
347                         }
348                 }
349         }
350         return res;
351 }
352
353 int co_get_lower_bound(const copy_opt_t *co) {
354         int res = 0;
355         unit_t *curr;
356         list_for_each_entry(unit_t, curr, &co->units, units)
357                 res += curr->inevitable_costs + curr->min_nodes_costs;
358         return res;
359 }