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