move backend into libfirm
[libfirm] / ir / be / bearch.c
1 /**
2  * Processor architecture specification.
3  * @author Sebastian Hack
4  * @date 11.2.2005
5  *
6  * $Id$
7  */
8 #ifdef HAVE_CONFIG_H
9 #include "config.h"
10 #endif
11
12 #ifdef HAVE_ALLOCA_H
13 #include <alloca.h>
14 #endif
15
16 #ifdef HAVE_MALLOC_H
17 #include <malloc.h>
18 #endif
19
20 #include <string.h>
21
22 #include "bearch.h"
23 #include "ircons_t.h"
24 #include "irnode_t.h"
25
26 #include "bitset.h"
27 #include "pset.h"
28 #include "entity.h"
29 #include "raw_bitset.h"
30
31 #include "irprintf.h"
32
33 /* Initialize the architecture environment struct. */
34 arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa_if, FILE *file_handle, be_main_env_t *main_env)
35 {
36         memset(env, 0, sizeof(*env));
37         env->isa                  = isa_if->init(file_handle);
38         env->isa->main_env        = main_env;
39         return env;
40 }
41
42 arch_env_t *arch_env_push_irn_handler(arch_env_t *env,
43                                       const arch_irn_handler_t *handler)
44 {
45         assert(env->handlers_tos < ARCH_MAX_HANDLERS);
46         env->handlers[env->handlers_tos++] = handler;
47         return env;
48 }
49
50 const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env)
51 {
52         assert(env->handlers_tos > 0 && env->handlers_tos <= ARCH_MAX_HANDLERS);
53         return env->handlers[--env->handlers_tos];
54 }
55
56 static const arch_irn_ops_t *fallback_irn_ops = NULL;
57
58 int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs)
59 {
60         if(bs) {
61                 int i, n;
62                 for(i = 0, n = cls->n_regs; i < n; ++i)
63                         bitset_set(bs, i);
64         }
65
66         return cls->n_regs;
67 }
68
69 /**
70  * Get the isa responsible for a node.
71  * @param env The arch environment with the isa stack.
72  * @param irn The node to get the responsible isa for.
73  * @return The irn operations given by the responsible isa.
74  */
75 static INLINE const arch_irn_ops_t *
76 get_irn_ops(const arch_env_t *env, const ir_node *irn)
77 {
78         int i;
79
80         for(i = env->handlers_tos - 1; i >= 0; --i) {
81                 const arch_irn_handler_t *handler = env->handlers[i];
82                 const arch_irn_ops_t *ops = handler->get_irn_ops(handler, irn);
83
84                 if(ops)
85                         return ops;
86         }
87
88         return fallback_irn_ops;
89 }
90
91 const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn) {
92         return get_irn_ops(env, irn);
93 }
94
95 const arch_register_req_t *arch_get_register_req(const arch_env_t *env,
96                                                  const ir_node *irn, int pos)
97 {
98         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
99         return ops->impl->get_irn_reg_req(ops, irn, pos);
100 }
101
102 void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int offset)
103 {
104         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
105         ops->impl->set_frame_offset(ops, irn, offset);
106 }
107
108 ir_entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn)
109 {
110         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
111         return ops->impl->get_frame_entity(ops, irn);
112 }
113
114 void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, ir_entity *ent)
115 {
116         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
117         ops->impl->set_frame_entity(ops, irn, ent);
118 }
119
120 int arch_get_sp_bias(const arch_env_t *env, ir_node *irn)
121 {
122         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
123         return ops->impl->get_sp_bias(ops, irn);
124 }
125
126 arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack)
127 {
128         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
129
130         if(ops->impl->get_inverse) {
131                 return ops->impl->get_inverse(ops, irn, i, inverse, obstack);
132         } else {
133                 return NULL;
134         }
135 }
136
137 int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i) {
138         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
139
140         if(ops->impl->possible_memory_operand) {
141                 return ops->impl->possible_memory_operand(ops, irn, i);
142         } else {
143                 return 0;
144         }
145 }
146
147 void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i) {
148         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
149
150         if(ops->impl->perform_memory_operand) {
151                 ops->impl->perform_memory_operand(ops, irn, spill, i);
152         } else {
153                 return;
154         }
155 }
156
157 int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn)
158 {
159         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
160
161         if(ops->impl->get_op_estimated_cost) {
162                 return ops->impl->get_op_estimated_cost(ops, irn);
163         } else {
164                 return 1;
165         }
166 }
167
168 int arch_is_possible_memory_operand(const arch_env_t *env, const ir_node *irn, int i)
169 {
170         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
171
172         if(ops->impl->possible_memory_operand) {
173                 return ops->impl->possible_memory_operand(ops, irn, i);
174         } else {
175                 return 0;
176         }
177 }
178
179 int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs)
180 {
181         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
182         const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, irn, pos);
183
184         if(req->type == arch_register_req_type_none) {
185                 bitset_clear_all(bs);
186                 return 0;
187         }
188
189         if(arch_register_req_is(req, limited)) {
190                 rbitset_copy_to_bitset(req->limited, bs);
191                 return bitset_popcnt(bs);
192         }
193
194         arch_register_class_put(req->cls, bs);
195         return req->cls->n_regs;
196 }
197
198 void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs)
199 {
200         int i;
201
202         for(i = 0; i < cls->n_regs; ++i) {
203                 if(!arch_register_type_is(&cls->regs[i], ignore))
204                         bitset_set(bs, i);
205         }
206 }
207
208 int arch_count_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls)
209 {
210         int i;
211         int result = 0;
212
213         for(i = 0; i < cls->n_regs; ++i) {
214                 if(!arch_register_type_is(&cls->regs[i], ignore))
215                         result++;
216         }
217
218         return result;
219 }
220
221 int arch_is_register_operand(const arch_env_t *env,
222     const ir_node *irn, int pos)
223 {
224         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
225         const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, irn, pos);
226
227         return req != NULL;
228 }
229
230 int arch_reg_is_allocatable(const arch_env_t *env, const ir_node *irn,
231     int pos, const arch_register_t *reg)
232 {
233         const arch_register_req_t *req;
234
235         req = arch_get_register_req(env, irn, pos);
236
237         if(req->type == arch_register_req_type_none)
238                 return 0;
239
240         if(arch_register_req_is(req, limited)) {
241                 assert(arch_register_get_class(reg) == req->cls);
242                 return rbitset_is_set(req->limited, arch_register_get_index(reg));
243         }
244
245         return req->cls == reg->reg_class;
246 }
247
248 const arch_register_class_t *
249 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos)
250 {
251         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
252         const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, irn, pos);
253
254         assert(req->type != arch_register_req_type_none || req->cls == NULL);
255
256         return req->cls;
257 }
258
259 extern const arch_register_t *
260 arch_get_irn_register(const arch_env_t *env, const ir_node *irn)
261 {
262         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
263         return ops->impl->get_irn_reg(ops, irn);
264 }
265
266 extern void arch_set_irn_register(const arch_env_t *env,
267     ir_node *irn, const arch_register_t *reg)
268 {
269         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
270         ops->impl->set_irn_reg(ops, irn, reg);
271 }
272
273 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn)
274 {
275         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
276         return ops->impl->classify(ops, irn);
277 }
278
279 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn)
280 {
281         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
282         return ops->impl->get_flags(ops, irn);
283 }
284
285 extern const char *arch_irn_flag_str(arch_irn_flags_t fl)
286 {
287         switch(fl) {
288 #define XXX(x) case arch_irn_flags_ ## x: return #x;
289                 XXX(dont_spill);
290                 XXX(ignore);
291                 XXX(rematerializable);
292                 XXX(modify_sp);
293                 XXX(none);
294 #undef XXX
295         }
296         return "n/a";
297 }
298
299 extern char *arch_register_req_format(char *buf, size_t len,
300                                       const arch_register_req_t *req,
301                                       const ir_node *node)
302 {
303         char tmp[128];
304         snprintf(buf, len, "class: %s", req->cls->name);
305
306         if(arch_register_req_is(req, limited)) {
307                 unsigned n_regs = req->cls->n_regs;
308                 unsigned i;
309
310                 strncat(buf, " limited:", len);
311                 for(i = 0; i < n_regs; ++i) {
312                         if(rbitset_is_set(req->limited, i)) {
313                                 const arch_register_t *reg = &req->cls->regs[i];
314                                 strncat(buf, " ", len);
315                                 strncat(buf, reg->name, len);
316                         }
317                 }
318         }
319
320         if(arch_register_req_is(req, should_be_same)) {
321                 const ir_node *same = get_irn_n(node, req->other_same);
322                 ir_snprintf(tmp, sizeof(tmp), " same to: %+F", same);
323                 strncat(buf, tmp, len);
324         }
325
326         if(arch_register_req_is(req, should_be_different)) {
327                 const ir_node *different = get_irn_n(node, req->other_different);
328                 ir_snprintf(tmp, sizeof(tmp), " different to: %+F", different);
329                 strncat(buf, tmp, len);
330         }
331
332         return buf;
333 }
334
335 static const arch_register_req_t no_requirement = {
336         arch_register_req_type_none,
337         NULL,
338         NULL,
339         -1,
340         -1
341 };
342 const arch_register_req_t *arch_no_register_req = &no_requirement;