added new callback to set frame entity
[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)
35 {
36   memset(env, 0, sizeof(*env));
37   env->isa = isa_if->init(file_handle);
38   return env;
39 }
40
41 arch_env_t *arch_env_push_irn_handler(arch_env_t *env,
42     const arch_irn_handler_t *handler)
43 {
44   assert(env->handlers_tos <= ARCH_MAX_HANDLERS);
45   env->handlers[env->handlers_tos++] = handler;
46   return env;
47 }
48
49 const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env)
50 {
51   assert(env->handlers_tos > 0 && env->handlers_tos <= ARCH_MAX_HANDLERS);
52   return env->handlers[--env->handlers_tos];
53 }
54
55 static const arch_irn_ops_t *fallback_irn_ops = NULL;
56
57 int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs)
58 {
59   if(bs) {
60     int i, n;
61     for(i = 0, n = cls->n_regs; i < n; ++i)
62       bitset_set(bs, i);
63   }
64
65   return cls->n_regs;
66 }
67
68 /**
69  * Get the isa responsible for a node.
70  * @param env The arch environment with the isa stack.
71  * @param irn The node to get the responsible isa for.
72  * @return The irn operations given by the responsible isa.
73  */
74 static INLINE const arch_irn_ops_t *
75 get_irn_ops(const arch_env_t *env, const ir_node *irn)
76 {
77   int i;
78
79   for(i = env->handlers_tos - 1; i >= 0; --i) {
80     const arch_irn_handler_t *handler = env->handlers[i];
81     const arch_irn_ops_t *ops = handler->get_irn_ops(handler, irn);
82
83     if(ops)
84       return ops;
85   }
86
87   return fallback_irn_ops;
88 }
89
90 const arch_register_req_t *arch_get_register_req(const arch_env_t *env,
91     arch_register_req_t *req, const ir_node *irn, int pos)
92 {
93   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
94   req->type = arch_register_req_type_none;
95   return ops->impl->get_irn_reg_req(ops, req, irn, pos);
96 }
97
98 void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int offset)
99 {
100   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
101   ops->impl->set_frame_offset(ops, irn, offset);
102 }
103
104 entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn)
105 {
106   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
107   return ops->impl->get_frame_entity(ops, irn);
108 }
109
110 void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent)
111 {
112         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
113         ops->impl->set_frame_entity(ops, irn, ent);
114 }
115
116 arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node *irn, int i, arch_inverse_t *inverse, struct obstack *obstack)
117 {
118   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
119   if(ops->impl->get_inverse) {
120     return ops->impl->get_inverse(ops, irn, i, inverse, obstack);
121   } else {
122     return NULL;
123   }
124 }
125
126 int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i) {
127         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
128         if(ops->impl->possible_memory_operand) {
129                 return ops->impl->possible_memory_operand(ops, irn, i);
130         } else {
131                 return 0;
132         }
133 }
134
135 extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *reload, unsigned int i) {
136         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
137         if(ops->impl->perform_memory_operand) {
138                 ops->impl->perform_memory_operand(ops, irn, reload, i);
139         } else {
140                 return;
141         }
142 }
143
144 int arch_get_op_estimated_cost(const arch_env_t *env, const ir_node *irn)
145 {
146   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
147   if(ops->impl->get_op_estimated_cost) {
148     return ops->impl->get_op_estimated_cost(ops, irn);
149   } else {
150     return 1;
151   }
152 }
153
154 int arch_is_possible_memory_operand(const arch_env_t *env, const ir_node *irn, int i)
155 {
156   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
157   if(ops->impl->possible_memory_operand) {
158     return ops->impl->possible_memory_operand(ops, irn, i);
159   } else {
160     return 0;
161   }
162 }
163
164 int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs)
165 {
166   arch_register_req_t local_req;
167   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
168   const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
169
170   if(req->type == arch_register_req_type_none) {
171           bitset_clear_all(bs);
172           return 0;
173   }
174
175   if(arch_register_req_is(req, limited)) {
176           req->limited(req->limited_env, bs);
177           return bitset_popcnt(bs);
178   }
179
180   arch_register_class_put(req->cls, bs);
181   return req->cls->n_regs;
182 }
183
184 void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs)
185 {
186         int i;
187
188         for(i = 0; i < cls->n_regs; ++i) {
189                 if(!arch_register_type_is(&cls->regs[i], ignore))
190                         bitset_set(bs, i);
191         }
192 }
193
194 int arch_count_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls)
195 {
196         int i;
197         int result = 0;
198
199         for(i = 0; i < cls->n_regs; ++i) {
200                 if(!arch_register_type_is(&cls->regs[i], ignore))
201                         result++;
202         }
203
204         return result;
205 }
206
207 int arch_is_register_operand(const arch_env_t *env,
208     const ir_node *irn, int pos)
209 {
210         arch_register_req_t local_req;
211         const arch_irn_ops_t *ops = get_irn_ops(env, irn);
212         const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
213         return req != NULL;
214 }
215
216 int arch_reg_is_allocatable(const arch_env_t *env, const ir_node *irn,
217     int pos, const arch_register_t *reg)
218 {
219         arch_register_req_t req;
220
221         arch_get_register_req(env, &req, irn, pos);
222
223         if(req.type == arch_register_req_type_none)
224                 return 0;
225
226         if(arch_register_req_is(&req, limited)) {
227                 bitset_t *bs = bitset_alloca(req.cls->n_regs);
228                 req.limited(req.limited_env, bs);
229                 return bitset_is_set(bs, arch_register_get_index(reg));
230         }
231
232         return req.cls == reg->reg_class;
233 }
234
235 const arch_register_class_t *
236 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos)
237 {
238   arch_register_req_t local_req;
239   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
240   const arch_register_req_t *req = ops->impl->get_irn_reg_req(ops, &local_req, irn, pos);
241   return req ? req->cls : NULL;
242 }
243
244 extern const arch_register_t *
245 arch_get_irn_register(const arch_env_t *env, const ir_node *irn)
246 {
247   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
248   return ops->impl->get_irn_reg(ops, irn);
249 }
250
251 extern void arch_set_irn_register(const arch_env_t *env,
252     ir_node *irn, const arch_register_t *reg)
253 {
254   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
255   ops->impl->set_irn_reg(ops, irn, reg);
256 }
257
258 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn)
259 {
260   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
261   return ops->impl->classify(ops, irn);
262 }
263
264 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn)
265 {
266   const arch_irn_ops_t *ops = get_irn_ops(env, irn);
267   return ops->impl->get_flags(ops, irn);
268 }
269
270 extern const char *arch_irn_flag_str(arch_irn_flags_t fl)
271 {
272         switch(fl) {
273 #define XXX(x) case arch_irn_flags_ ## x: return #x;
274                 XXX(dont_spill);
275                 XXX(ignore);
276                 XXX(rematerializable);
277                 XXX(modify_sp);
278                 XXX(none);
279 #undef XXX
280         }
281         return "n/a";
282 }
283
284 extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req)
285 {
286         char tmp[128];
287         snprintf(buf, len, "class: %s", req->cls->name);
288
289         if(arch_register_req_is(req, limited)) {
290                 bitset_pos_t elm;
291                 bitset_t *bs = bitset_alloca(req->cls->n_regs);
292                 req->limited(req->limited_env, bs);
293                 strncat(buf, " limited:", len);
294                 bitset_foreach(bs, elm) {
295                         strncat(buf, " ", len);
296                         strncat(buf, req->cls->regs[elm].name, len);
297                 }
298         }
299
300         if(arch_register_req_is(req, should_be_same)) {
301                 ir_snprintf(tmp, sizeof(tmp), " same to: %+F", req->other_different);
302                 strncat(buf, tmp, len);
303         }
304
305         if(arch_register_req_is(req, should_be_different)) {
306                 ir_snprintf(tmp, sizeof(tmp), " different to: %+F", req->other_different);
307                 strncat(buf, tmp, len);
308         }
309
310         return buf;
311 }