sched_skip_cf_predicator() does not need an arch_env as environment anymore.
[libfirm] / ir / be / bessadestrsimple.c
1 /*
2  * Copyright (C) 1995-2008 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       Simple SSA destruction.
23  * @author      Daniel Grund
24  * @date        17.01.2006
25  * @version     $Id$
26  */
27 #ifdef NOT_PORTED
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <limits.h>
36
37 #include "set.h"
38 #include "pset.h"
39 #include "pmap.h"
40 #include "bitset.h"
41
42 #include "irprintf_t.h"
43 #include "irnode_t.h"
44 #include "irgraph_t.h"
45 #include "irgwalk.h"
46 #include "iredges_t.h"
47 #include "irdom_t.h"
48 #include "phiclass.h"
49
50 #include "beabi.h"
51 #include "bearch_t.h"
52 #include "benode_t.h"
53 #include "beirgmod.h"
54 #include "besched_t.h"
55 #include "beutil.h"
56 #include "belive_t.h"
57 #include "beinsn_t.h"
58
59 #include "bessadestrsimple.h"
60
61 #define DBG_LEVEL 2
62
63 typedef struct _ssa_destr_env_t {
64         ir_graph                    *irg;
65         const arch_register_class_t *cls;
66         const arch_env_t            *aenv;
67         set                         *vars;
68 } ssa_destr_env_t;
69
70 #define pset_foreach(pset, irn)  for(irn=pset_first(pset); irn; irn=pset_next(pset))
71 #define set_foreach(set, e)  for(e=set_first(set); e; e=set_next(set))
72
73 static phi_classes_t *pc = NULL;
74
75 /******************************************************************************
76    __      __   _       ___   __      __
77    \ \    / /  | |     |__ \  \ \    / /
78     \ \  / /_ _| |___     ) |  \ \  / /_ _ _ __ ___
79      \ \/ / _` | / __|   / /    \ \/ / _` | '__/ __|
80       \  / (_| | \__ \  / /_     \  / (_| | |  \__ \
81        \/ \__,_|_|___/ |____|     \/ \__,_|_|  |___/
82  *****************************************************************************/
83
84 /**
85  * The link field of an irn points to the var_info struct
86  * representing the corresponding variable.
87  */
88 #define set_var_info(irn, vi)                           set_irn_link(irn, vi)
89
90 #define HASH_VAR_NR(var_nr) var_nr
91
92 static int compare_var_infos(const void *e1, const void *e2, size_t size) {
93         const be_var_info_t *v1 = e1;
94         const be_var_info_t *v2 = e2;
95
96         if (v1->var_nr == SET_REMOVED || v2->var_nr == SET_REMOVED)
97                 return 1;
98
99         return v1->var_nr != v2->var_nr;
100 }
101
102 be_var_info_t *be_var_find(set *vars, int var_nr) {
103         be_var_info_t vi;
104         vi.var_nr = var_nr;
105
106         return set_find(vars, &vi, sizeof(vi), HASH_VAR_NR(var_nr));
107 }
108
109 be_var_info_t *be_var_find_or_insert(set *vars, int var_nr) {
110         be_var_info_t vi, *found;
111         memset(&vi, 0, sizeof(vi));
112         vi.var_nr = var_nr;
113
114         found = set_insert(vars, &vi, sizeof(vi), HASH_VAR_NR(var_nr));
115
116         if (!found->values)
117                 found->values  = pset_new_ptr(1);
118
119         return found;
120 }
121
122 /**
123  * Adds a value to a variable. Sets all pointers accordingly.
124  */
125 be_var_info_t *be_var_add_value(set *vars, int var_nr, ir_node *irn) {
126         be_var_info_t *vi = be_var_find_or_insert(vars, var_nr);
127
128         /* var 2 value mapping */
129         pset_insert_ptr(vi->values, irn);
130
131         /* value 2 var mapping */
132         set_var_info(irn, vi);
133
134         return vi;
135 }
136
137 pset *be_get_var_values(set *vars, int var_nr) {
138         be_var_info_t *vi = be_var_find(vars, var_nr);
139         assert(vi && "Variable does not exist");
140         return vi->values;
141 }
142
143 static INLINE ir_node *get_first_phi(ir_node **s) {
144         int i;
145
146         for (i = ARR_LEN(s) - 1; i >= 0; --i) {
147                 if (is_Phi(s[i]))
148                         return s[i];
149         }
150
151         assert(0 && "There must be a phi in this");
152         return NULL;
153 }
154
155
156 /**
157  * Define variables (numbers) for all SSA-values.
158  * All values in a phi class get assigned the same variable name.
159  * The link field maps values to the var-name
160  */
161 static void values_to_vars(ir_node *irn, void *env) {
162         ssa_destr_env_t *sde = env;
163         int             nr, i, build_vals = 0;
164         ir_node         **vals;
165
166         if (arch_get_irn_reg_class(sde->aenv, irn, -1) == NULL)
167                 return;
168
169         vals = get_phi_class(pc, irn);
170
171         if (vals) {
172                 nr = get_irn_node_nr(get_first_phi(vals));
173         } else {
174                 /* not a phi class member, value == var */
175                 nr         = get_irn_node_nr(irn);
176                 vals       = NEW_ARR_F(ir_node *, 1);
177                 vals[0]    = irn;
178                 build_vals = 1;
179         }
180
181         /* values <--> var mapping */
182         for (i = ARR_LEN(vals) - 1; i >= 0; --i) {
183                 be_var_add_value(sde->vars, nr, vals[i]);
184         }
185
186         if (build_vals)
187                 DEL_ARR_F(vals);
188 }
189
190 /******************************************************************************
191      _____ _____              _____            _
192     / ____/ ____|  /\        |  __ \          | |
193    | (___| (___   /  \ ______| |  | | ___  ___| |_ _ __
194     \___ \\___ \ / /\ \______| |  | |/ _ \/ __| __| '__|
195     ____) |___) / ____ \     | |__| |  __/\__ \ |_| |
196    |_____/_____/_/    \_\    |_____/ \___||___/\__|_|
197
198  *****************************************************************************/
199
200 #define mark_as_done(irn, pos)                  set_irn_link(irn, INT_TO_PTR(pos+1))
201 #define has_been_done(irn, pos)                 (PTR_TO_INT(get_irn_link(irn)) > pos)
202
203 /**
204  * Insert a copy for the argument of @p start_phi found at position @p pos.
205  * Also searches a phi-loop of arbitrary length to detect and resolve
206  *   the class of phi-swap-problems. To search for a loop recursion is used.
207  *
208  * 1) Simplest case (phi with a non-phi arg):
209  *     A single copy is inserted.
210  *
211  * 2) Phi chain (phi (with phi-arg)* with non-phi arg):
212  *     Several copies are placed, each after returning from recursion.
213  *
214  * 3) Phi-loop:
215  *     On detection a loop breaker is inserted, which is a copy of the start_phi.
216  *     This copy then pretends beeing the argumnent of the last phi.
217  *     Now case 2) can be used.
218  *
219  * The values of @p start_phi and @p pos never change during recursion.
220  *
221  * @p start_phi  Phi node to process
222  * @p pos        Argument position to insert copy/copies for
223  * @p curr_phi   Phi node currently processed during recursion. Equals start_phi on initial call
224  *
225  * @return NULL  If no copy is necessary
226  *         NULL  If the phi has already been processed at this pos
227  *               Link field is used to keep track of processed positions
228  *         In all other cases the ir_node *copy which was placed is returned.
229  */
230 static ir_node *insert_copies(ssa_destr_env_t *sde, const arch_register_class_t *cls, ir_node *start_phi, int pos, ir_node *curr_phi) {
231         ir_node *arg = get_irn_n(curr_phi, pos);
232         ir_node *arg_blk = get_nodes_block(arg);
233         ir_node *pred_blk = get_Block_cfgpred_block(get_nodes_block(curr_phi), pos);
234         ir_node *curr_cpy, *last_cpy;
235
236         assert(is_Phi(start_phi) && is_Phi(curr_phi));
237
238         if (has_been_done(start_phi, pos))
239                 return NULL;
240
241         /* In case this is a 'normal' phi we insert at the
242          * end of the pred block before cf nodes */
243         last_cpy = sched_skip(pred_blk, 0, sched_skip_cf_predicator, NULL);
244         last_cpy = sched_next(last_cpy);
245
246         /* If we detect a loop stop recursion. */
247         if (arg == start_phi) {
248                 ir_node *loop_breaker;
249                 if (start_phi == curr_phi) {
250                         /* Phi directly uses itself. No copy necessary */
251                         return NULL;
252                 }
253
254                 /* At least 2 phis are involved */
255                 /* Insert a loop breaking copy (an additional variable T) */
256                 loop_breaker = be_new_Copy(cls, sde->irg, pred_blk, start_phi);
257                 sched_add_before(last_cpy, loop_breaker);
258
259                 arg = loop_breaker;
260         }
261
262         /* If arg is a phi in the same block we have to continue search */
263         if (is_Phi(arg) && arg_blk == get_nodes_block(start_phi))
264                 last_cpy = insert_copies(sde, cls, start_phi, pos, arg);
265
266         /* Insert copy of argument (may be the loop-breaker) */
267         curr_cpy = be_new_Copy(cls, sde->irg, pred_blk, arg);
268         set_irn_n(curr_phi, pos, curr_cpy);
269         mark_as_done(curr_phi, pos);
270         sched_add_before(last_cpy, curr_cpy);
271         return curr_cpy;
272 }
273
274
275 /**
276  * Perform simple SSA-destruction with copies.
277  * The order of processing _must_ be
278  *  for all positions {
279  *    for all phis {
280  *      doit
281  *    }
282  *  }
283  * else the magic to keep track of processed phi-positions will fail in
284  * function 'insert_copies'
285  */
286 static void ssa_destr_simple_walker(ir_node *blk, void *env) {
287         ssa_destr_env_t *sde = env;
288         int pos, max;
289         ir_node *phi;
290         const arch_register_class_t *cls;
291
292         /* for all argument positions of the phis */
293         for (pos=0, max=get_irn_arity(blk); pos<max; ++pos) {
294
295                 /* for all phi nodes (which are scheduled first) */
296                 sched_foreach(blk, phi) {
297                         if (!is_Phi(phi))
298                                 break;
299
300                         if (arch_irn_is(sde->aenv, phi, ignore))
301                                 continue;
302
303                         cls = arch_get_irn_reg_class(sde->aenv, phi, -1);
304                         insert_copies(sde, cls, phi, pos, phi);
305                 }
306         }
307 }
308
309
310 set *be_ssa_destr_simple(ir_graph *irg, const arch_env_t *aenv) {
311         ssa_destr_env_t sde;
312
313         sde.irg = irg;
314         sde.aenv = aenv;
315         sde.vars = new_set(compare_var_infos, 16);
316
317         be_clear_links(irg);
318         irg_block_walk_graph(irg, ssa_destr_simple_walker, NULL, &sde);
319
320         /* Mapping of SSA-Values <--> Variables */
321         pc = phi_class_new_from_irg(irg, 0);
322         be_clear_links(irg);
323         irg_walk_graph(irg, values_to_vars, NULL, &sde);
324
325         return sde.vars;
326 }
327
328 void free_ssa_destr_simple(set *vars)
329 {
330   be_var_info_t *vi;
331
332   set_foreach(vars, vi)
333     del_pset(vi->values);
334
335   del_set(vars);
336   phi_class_free(pc);
337 }
338
339 #endif /* NOT_PORTED */