array: Add and use NEW_ARR_DZ().
[libfirm] / ir / be / TEMPLATE / bearch_TEMPLATE.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    The main TEMPLATE backend driver file.
23  */
24 #include "config.h"
25
26 #include "bearch_TEMPLATE_t.h"
27
28 #include "irgwalk.h"
29 #include "irprog.h"
30 #include "irprintf.h"
31 #include "ircons.h"
32 #include "irgmod.h"
33 #include "lower_calls.h"
34 #include "lower_builtins.h"
35
36 #include "bitset.h"
37 #include "debug.h"
38
39 #include "be_t.h"
40 #include "bearch.h"
41 #include "benode.h"
42 #include "belower.h"
43 #include "besched.h"
44 #include "beabi.h"
45 #include "bemodule.h"
46 #include "begnuas.h"
47 #include "belistsched.h"
48 #include "bestack.h"
49 #include "bespillutil.h"
50
51 #include "TEMPLATE_new_nodes.h"
52 #include "gen_TEMPLATE_regalloc_if.h"
53 #include "TEMPLATE_transform.h"
54 #include "TEMPLATE_emitter.h"
55
56 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57
58 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
59 {
60         (void) node;
61         /* TODO: return the ir_entity assigned to the frame */
62         return NULL;
63 }
64
65 /**
66  * This function is called by the generic backend to correct offsets for
67  * nodes accessing the stack.
68  */
69 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
70 {
71         (void) irn;
72         (void) offset;
73         /* TODO: correct offset if irn accesses the stack */
74 }
75
76 static int TEMPLATE_get_sp_bias(const ir_node *irn)
77 {
78         (void) irn;
79         return 0;
80 }
81
82 /* fill register allocator interface */
83
84 static const arch_irn_ops_t TEMPLATE_irn_ops = {
85         TEMPLATE_get_frame_entity,
86         TEMPLATE_set_frame_offset,
87         TEMPLATE_get_sp_bias,
88         NULL,    /* get_op_estimated_cost   */
89         NULL,    /* possible_memory_operand */
90         NULL,    /* perform_memory_operand  */
91 };
92
93
94
95 /**
96  * Transforms the standard firm graph into
97  * a TEMLPATE firm graph
98  */
99 static void TEMPLATE_prepare_graph(ir_graph *irg)
100 {
101         /* transform nodes into assembler instructions */
102         TEMPLATE_transform_graph(irg);
103 }
104
105
106
107 /**
108  * Called immediatly before emit phase.
109  */
110 static void TEMPLATE_finish_irg(ir_graph *irg)
111 {
112         /* fix stack entity offsets */
113         be_abi_fix_stack_nodes(irg);
114         be_abi_fix_stack_bias(irg);
115 }
116
117
118 static void TEMPLATE_before_ra(ir_graph *irg)
119 {
120         (void) irg;
121         /* Some stuff you need to do after scheduling but before register allocation */
122 }
123
124 static void TEMPLATE_init_graph(ir_graph *irg)
125 {
126         (void) irg;
127 }
128
129
130
131 extern const arch_isa_if_t TEMPLATE_isa_if;
132 static TEMPLATE_isa_t TEMPLATE_isa_template = {
133         {
134                 &TEMPLATE_isa_if,            /* isa interface implementation */
135                 N_TEMPLATE_REGISTERS,
136                 TEMPLATE_registers,
137                 N_TEMPLATE_CLASSES,
138                 TEMPLATE_reg_classes,
139                 &TEMPLATE_registers[REG_SP], /* stack pointer register */
140                 &TEMPLATE_registers[REG_BP], /* base pointer register */
141                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
142                 7,                           /* costs for a spill instruction */
143                 5,                           /* costs for a reload instruction */
144                 true,                        /* no custom abi handling */
145         },
146 };
147
148 static void TEMPLATE_init(void)
149 {
150         TEMPLATE_register_init();
151         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
152 }
153
154 static void TEMPLATE_finish(void)
155 {
156         TEMPLATE_free_opcodes();
157 }
158
159 static arch_env_t *TEMPLATE_begin_codegeneration(void)
160 {
161         TEMPLATE_isa_t *isa = XMALLOC(TEMPLATE_isa_t);
162         *isa = TEMPLATE_isa_template;
163
164         return &isa->base;
165 }
166
167 /**
168  * Closes the output file and frees the ISA structure.
169  */
170 static void TEMPLATE_end_codegeneration(void *self)
171 {
172         free(self);
173 }
174
175 /**
176  * Get the between type for that call.
177  * @param self The callback object.
178  * @return The between type of for that call.
179  */
180 static ir_type *TEMPLATE_get_between_type(ir_graph *irg)
181 {
182         static ir_type *between_type = NULL;
183         static ir_entity *old_bp_ent = NULL;
184         (void) irg;
185
186         if (!between_type) {
187                 ir_entity *ret_addr_ent;
188                 ir_type *ret_addr_type = new_type_primitive(mode_P);
189                 ir_type *old_bp_type   = new_type_primitive(mode_P);
190
191                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
192                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
193                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
194
195                 set_entity_offset(old_bp_ent, 0);
196                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
197                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
198         }
199
200         return between_type;
201 }
202
203 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
204         TEMPLATE_get_between_type,
205 };
206
207 /**
208  * Get the ABI restrictions for procedure calls.
209  * @param self        The this pointer.
210  * @param method_type The type of the method (procedure) in question.
211  * @param abi         The abi object to be modified
212  */
213 static void TEMPLATE_get_call_abi(ir_type *method_type, be_abi_call_t *abi)
214 {
215         ir_type  *tp;
216         ir_mode  *mode;
217         int       i, n = get_method_n_params(method_type);
218
219         /* set abi flags for calls */
220         be_abi_call_flags_t call_flags = be_abi_call_get_flags(abi);
221         call_flags.call_has_imm = true;
222         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
223
224         for (i = 0; i < n; i++) {
225                 /* TODO: implement register parameter: */
226                 /* reg = get reg for param i;          */
227                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
228
229                 /* default: all parameters on stack */
230                 tp   = get_method_param_type(method_type, i);
231                 mode = get_type_mode(tp);
232                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
233         }
234
235         /* TODO: set correct return register */
236         /* default: return value is in R0 resp. F0 */
237         if (get_method_n_ress(method_type) > 0) {
238                 tp   = get_method_res_type(method_type, 0);
239                 mode = get_type_mode(tp);
240
241                 be_abi_call_res_reg(abi, 0,
242                         mode_is_float(mode) ? &TEMPLATE_registers[REG_F0] : &TEMPLATE_registers[REG_R0], ABI_CONTEXT_BOTH);
243         }
244 }
245
246 static void TEMPLATE_lower_for_target(void)
247 {
248         lower_builtins(0, NULL);
249
250         /* lower compound param handling */
251         lower_calls_with_compounds(LF_RETURN_HIDDEN);
252 }
253
254 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
255                                    ir_node *mux_true)
256 {
257         (void) sel;
258         (void) mux_false;
259         (void) mux_true;
260         return false;
261 }
262
263 /**
264  * Returns the libFirm configuration parameter for this backend.
265  */
266 static const backend_params *TEMPLATE_get_backend_params(void)
267 {
268         static backend_params p = {
269                 0,     /* no inline assembly */
270                 0,     /* no support for Rotl nodes */
271                 0,     /* 0: little-endian, 1: big-endian */
272                 1,     /* modulo shift efficient */
273                 0,     /* non-modulo shift efficient */
274                 NULL,  /* architecture dependent settings, will be set later */
275                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
276                 32,    /* machine size - a 32bit CPU */
277                 NULL,  /* float arithmetic mode */
278                 NULL,  /* long long type */
279                 NULL,  /* unsigned long long type */
280                 NULL,  /* long double type */
281                 0,     /* no trampoline support: size 0 */
282                 0,     /* no trampoline support: align 0 */
283                 NULL,  /* no trampoline support: no trampoline builder */
284                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
285         };
286         return &p;
287 }
288
289 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
290 {
291         (void) c;
292         return ASM_CONSTRAINT_FLAG_INVALID;
293 }
294
295 static int TEMPLATE_is_valid_clobber(const char *clobber)
296 {
297         (void) clobber;
298         return 0;
299 }
300
301 /**
302  * Check if the given register is callee or caller save.
303  */
304 static int TEMPLATE_register_saved_by(const arch_register_t *reg, int callee)
305 {
306         if (callee) {
307                 /* check for callee saved */
308                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
309                         switch (reg->index) {
310                         case REG_GP_R7:
311                         case REG_GP_R8:
312                         case REG_GP_R9:
313                         case REG_GP_R10:
314                         case REG_GP_R11:
315                         case REG_GP_R12:
316                         case REG_GP_R13:
317                                 return 1;
318                         default:
319                                 return 0;
320                         }
321                 }
322         } else {
323                 /* check for caller saved */
324                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
325                         switch (reg->index) {
326                         case REG_GP_R0:
327                         case REG_GP_R1:
328                         case REG_GP_R2:
329                         case REG_GP_R3:
330                         case REG_GP_R4:
331                         case REG_GP_R5:
332                         case REG_GP_R6:
333                                 return 1;
334                         default:
335                                 return 0;
336                         }
337                 } else if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp]) {
338                         /* all FP registers are caller save */
339                         return 1;
340                 }
341         }
342         return 0;
343 }
344
345 const arch_isa_if_t TEMPLATE_isa_if = {
346         TEMPLATE_init,
347         TEMPLATE_finish,
348     TEMPLATE_get_backend_params,
349         TEMPLATE_lower_for_target,
350         TEMPLATE_parse_asm_constraint,
351         TEMPLATE_is_valid_clobber,
352
353         TEMPLATE_begin_codegeneration,
354         TEMPLATE_end_codegeneration,
355         TEMPLATE_init_graph,
356         TEMPLATE_get_call_abi,
357         NULL, /* mark remat */
358         NULL, /* get_pic_base */
359         be_new_spill,
360         be_new_reload,
361         TEMPLATE_register_saved_by,
362
363         NULL, /* handle intrinsics */
364         NULL, /* before_abi */
365         TEMPLATE_prepare_graph,
366         TEMPLATE_before_ra,
367         TEMPLATE_finish_irg,
368         TEMPLATE_emit_routine,
369 };
370
371 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE)
372 void be_init_arch_TEMPLATE(void)
373 {
374         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
375         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
376         TEMPLATE_init_transform();
377 }