irgraph: Use get_irg_obstack() instead of accessing irg->obst directly.
[libfirm] / ir / be / bechordal_common.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       Common functions for chordal register allocation.
23  * @author      Sebastian Hack
24  * @date        08.12.2004
25  */
26 #include "config.h"
27
28 #include "bechordal_common.h"
29
30 #include "debug.h"
31
32 #include "iredges.h"
33 #include "bitset.h"
34
35 #include "bechordal.h"
36 #include "bechordal_t.h"
37 #include "beirg.h"
38 #include "beirgmod.h"
39 #include "beinsn_t.h"
40 #include "besched.h"
41 #include "statev_t.h"
42 #include "benode.h"
43 #include "bemodule.h"
44 #include "belive.h"
45 #include "belive_t.h"
46 #include "fourcc.h"
47
48 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
49
50 /* Make a fourcc for border checking. */
51 #define BORDER_FOURCC   FOURCC('B', 'O', 'R', 'D')
52
53 static inline border_t *border_add(be_chordal_env_t *env, struct list_head *head,
54                         ir_node *irn, unsigned step, unsigned pressure,
55                         unsigned is_def, unsigned is_real)
56 {
57         border_t *b;
58
59         if (!is_def) {
60                 border_t *def;
61
62                 b = OALLOC(&env->obst, border_t);
63
64                 /* also allocate the def and tie it to the use. */
65                 def = OALLOCZ(&env->obst, border_t);
66                 b->other_end = def;
67                 def->other_end = b;
68
69                 /*
70                  * Set the link field of the irn to the def.
71                  * This strongly relies on the fact, that the use is always
72                  * made before the def.
73                  */
74                 set_irn_link(irn, def);
75
76                 DEBUG_ONLY(b->magic = BORDER_FOURCC;)
77                 DEBUG_ONLY(def->magic = BORDER_FOURCC;)
78         } else {
79                 /*
80                  * If the def is encountered, the use was made and so was the
81                  * the def node (see the code above). It was placed into the
82                  * link field of the irn, so we can get it there.
83                  */
84                 b = (border_t*)get_irn_link(irn);
85
86                 DEBUG_ONLY(assert(b && b->magic == BORDER_FOURCC && "Illegal border encountered");)
87         }
88
89         b->pressure = pressure;
90         b->is_def = is_def;
91         b->is_real = is_real;
92         b->irn = irn;
93         b->step = step;
94         list_add_tail(&b->list, head);
95         DBG((dbg, LEVEL_5, "\t\t%s adding %+F, step: %d\n", is_def ? "def" : "use", irn, step));
96
97
98         return b;
99 }
100
101 void create_borders(ir_node *block, void *env_ptr)
102 {
103 /* Convenience macro for a def */
104 #define border_def(irn, step, real) \
105         border_add(env, head, irn, step, pressure--, 1, real)
106
107 /* Convenience macro for a use */
108 #define border_use(irn, step, real) \
109         border_add(env, head, irn, step, ++pressure, 0, real)
110
111         be_chordal_env_t *env  = (be_chordal_env_t*)env_ptr;
112         bitset_t         *live = bitset_malloc(get_irg_last_idx(env->irg));
113         be_lv_t          *lv   = be_get_irg_liveness(env->irg);
114
115         unsigned step = 0;
116         unsigned pressure = 0;
117         struct list_head *head;
118
119         bitset_clear_all(live);
120
121         /* Set up the border list in the block info */
122         head = OALLOC(&env->obst, struct list_head);
123         INIT_LIST_HEAD(head);
124         assert(pmap_get(struct list_head, env->border_heads, block) == NULL);
125         pmap_insert(env->border_heads, block, head);
126
127         /*
128          * Make final uses of all values live out of the block.
129          * They are necessary to build up real intervals.
130          */
131         be_lv_foreach_cls(lv, block, be_lv_state_end, env->cls, irn) {
132                 DB((dbg, LEVEL_3, "\tMaking live: %+F/%d\n", irn, get_irn_idx(irn)));
133                 bitset_set(live, get_irn_idx(irn));
134                 border_use(irn, step, 0);
135         }
136         ++step;
137
138         /*
139          * Determine the last uses of a value inside the block, since they are
140          * relevant for the interval borders.
141          */
142         sched_foreach_reverse(block, irn) {
143                 DB((dbg, LEVEL_1, "\tinsn: %+F, pressure: %d\n", irn, pressure));
144                 DB((dbg, LEVEL_2, "\tlive: %B\n", live));
145
146                 be_foreach_definition(irn, env->cls, def, req,
147                         /*
148                          * If the node defines some value, which can put into a
149                          * register of the current class, make a border for it.
150                          */
151                         unsigned idx = get_irn_idx(def);
152                         bitset_clear(live, idx);
153                         border_def(def, step, 1);
154                 );
155
156                 /*
157                  * If the node is no phi node we can examine the uses.
158                  */
159                 if (!is_Phi(irn)) {
160                         be_foreach_use(irn, env->cls, in_req_, op, op_req_,
161                                 unsigned idx = get_irn_idx(op);
162                                 const char *msg = "-";
163
164                                 if (!bitset_is_set(live, idx)) {
165                                         border_use(op, step, 1);
166                                         bitset_set(live, idx);
167                                         msg = "X";
168                                 }
169
170                                 DB((dbg, LEVEL_4, "\t\t%s pos: %d, use: %+F\n", msg, i_, op));
171                         );
172                 }
173                 ++step;
174         }
175
176         bitset_foreach(live, elm) {
177                 ir_node *irn = get_idx_irn(env->irg, elm);
178                 if (be_is_live_in(lv, block, irn))
179                         border_def(irn, step, 0);
180         }
181
182         bitset_free(live);
183 }
184
185 ir_node *pre_process_constraints(be_chordal_env_t *env, be_insn_t **the_insn)
186 {
187         be_insn_t *insn = *the_insn;
188
189         /*
190          * Make the Perm, recompute liveness and re-scan the insn since the
191          * in operands are now the Projs of the Perm.
192          */
193         ir_node *const irn  = insn->irn;
194         ir_node *const perm = insert_Perm_before(env->irg, env->cls, irn);
195
196         /* Registers are propagated by insert_Perm_before(). Clean them here! */
197         if (perm == NULL)
198                 return NULL;
199
200         stat_ev_int("constr_perm", get_irn_arity(perm));
201
202         /*
203          * We also have to re-build the insn since the input operands are now the Projs of
204          * the Perm. Recomputing liveness is also a good idea if a Perm is inserted, since
205          * the live sets may change.
206          */
207         obstack_free(&env->obst, insn);
208         *the_insn = insn = be_scan_insn(env, irn);
209
210         /* Copy the input constraints of the irn to the Perm as output
211          * constraints. Succeeding phases (coalescing) will need that. */
212         for (int i = 0, n = get_irn_arity(irn); i != n; ++i) {
213                 ir_node *const proj = get_irn_n(irn, i);
214                 /* Note that the predecessor is not necessarily a Proj of the Perm,
215                  * since ignore-nodes are not Perm'ed. */
216                 if (!is_Proj(proj) || get_Proj_pred(proj) != perm)
217                         continue;
218                 /* FIXME: Only setting the constraints, when the register requirement is
219                  * limited, is a hack.  It will break when multiple differently constrained
220                  * inputs use the same value. */
221                 arch_register_req_t const *const req = arch_get_irn_register_req_in(irn, i);
222                 if (!arch_register_req_is(req, limited))
223                         continue;
224                 be_set_constr_out(perm, get_Proj_proj(proj), req);
225         }
226
227         return perm;
228 }
229
230 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_chordal_common)
231 void be_init_chordal_common(void)
232 {
233         FIRM_DBG_REGISTER(dbg, "firm.be.chordal_common");
234 }