2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief The main TEMPLATE backend driver file.
27 #include "pseudo_irg.h"
38 #include "../bearch.h"
39 #include "../benode.h"
40 #include "../belower.h"
41 #include "../besched.h"
43 #include "../bemodule.h"
44 #include "../begnuas.h"
45 #include "../belistsched.h"
47 #include "bearch_TEMPLATE_t.h"
49 #include "TEMPLATE_new_nodes.h"
50 #include "gen_TEMPLATE_regalloc_if.h"
51 #include "TEMPLATE_transform.h"
52 #include "TEMPLATE_emitter.h"
54 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
56 /**************************************************
59 * _ __ ___ __ _ __ _| | | ___ ___ _| |_
60 * | '__/ _ \/ _` | / _` | | |/ _ \ / __| | | _|
61 * | | | __/ (_| | | (_| | | | (_) | (__ | | |
62 * |_| \___|\__, | \__,_|_|_|\___/ \___| |_|_|
65 **************************************************/
67 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
73 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
76 /* TODO: return the ir_entity assigned to the frame */
80 static void TEMPLATE_set_frame_entity(ir_node *node, ir_entity *ent)
84 /* TODO: set the ir_entity assigned to the frame */
88 * This function is called by the generic backend to correct offsets for
89 * nodes accessing the stack.
91 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
95 /* TODO: correct offset if irn accesses the stack */
98 static int TEMPLATE_get_sp_bias(const ir_node *irn)
104 /* fill register allocator interface */
106 static const arch_irn_ops_t TEMPLATE_irn_ops = {
109 TEMPLATE_get_frame_entity,
110 TEMPLATE_set_frame_entity,
111 TEMPLATE_set_frame_offset,
112 TEMPLATE_get_sp_bias,
113 NULL, /* get_inverse */
114 NULL, /* get_op_estimated_cost */
115 NULL, /* possible_memory_operand */
116 NULL, /* perform_memory_operand */
119 /**************************************************
122 * ___ ___ __| | ___ __ _ ___ _ __ _| |_
123 * / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \ | | _|
124 * | (_| (_) | (_| | __/ (_| | __/ | | | | | |
125 * \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
128 **************************************************/
131 * Transforms the standard firm graph into
132 * a TEMLPATE firm graph
134 static void TEMPLATE_prepare_graph(void *self)
136 TEMPLATE_code_gen_t *cg = self;
138 irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
144 * Called immediatly before emit phase.
146 static void TEMPLATE_finish_irg(void *self)
148 TEMPLATE_code_gen_t *cg = self;
149 ir_graph *irg = cg->irg;
151 dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
155 static void TEMPLATE_before_ra(void *self)
158 /* Some stuff you need to do after scheduling but before register allocation */
161 static void TEMPLATE_after_ra(void *self)
164 /* Some stuff you need to do immediatly after register allocation */
170 * Emits the code, closes the output file and frees
171 * the code generator interface.
173 static void TEMPLATE_emit_and_done(void *self)
175 TEMPLATE_code_gen_t *cg = self;
176 ir_graph *irg = cg->irg;
178 TEMPLATE_gen_routine(cg, irg);
180 /* de-allocate code generator */
184 static void *TEMPLATE_cg_init(be_irg_t *birg);
186 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
188 NULL, /* get_pic_base hook */
189 NULL, /* before abi introduce hook */
190 TEMPLATE_prepare_graph,
191 NULL, /* spill hook */
192 TEMPLATE_before_ra, /* before register allocation hook */
193 TEMPLATE_after_ra, /* after register allocation hook */
195 TEMPLATE_emit_and_done
199 * Initializes the code generator.
201 static void *TEMPLATE_cg_init(be_irg_t *birg)
203 const arch_env_t *arch_env = be_get_birg_arch_env(birg);
204 TEMPLATE_isa_t *isa = (TEMPLATE_isa_t *) arch_env;
205 TEMPLATE_code_gen_t *cg = XMALLOC(TEMPLATE_code_gen_t);
207 cg->impl = &TEMPLATE_code_gen_if;
208 cg->irg = be_get_birg_irg(birg);
212 return (arch_code_generator_t *)cg;
217 /*****************************************************************
218 * ____ _ _ _____ _____
219 * | _ \ | | | | |_ _|/ ____| /\
220 * | |_) | __ _ ___| | _____ _ __ __| | | | | (___ / \
221 * | _ < / _` |/ __| |/ / _ \ '_ \ / _` | | | \___ \ / /\ \
222 * | |_) | (_| | (__| < __/ | | | (_| | _| |_ ____) / ____ \
223 * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/ \_\
225 *****************************************************************/
227 const arch_isa_if_t TEMPLATE_isa_if;
228 static TEMPLATE_isa_t TEMPLATE_isa_template = {
230 &TEMPLATE_isa_if, /* isa interface implementation */
231 &TEMPLATE_general_purpose_regs[REG_SP], /* stack pointer register */
232 &TEMPLATE_general_purpose_regs[REG_BP], /* base pointer register */
233 &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose], /* link pointer register class */
234 -1, /* stack direction */
235 2, /* power of two stack alignment for calls, 2^2 == 4 */
236 NULL, /* main environment */
237 7, /* costs for a spill instruction */
238 5, /* costs for a reload instruction */
243 * Initializes the backend ISA and opens the output file.
245 static arch_env_t *TEMPLATE_init(FILE *outfile)
247 static int run_once = 0;
254 isa = XMALLOC(TEMPLATE_isa_t);
255 memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
257 be_emit_init(outfile);
259 TEMPLATE_register_init();
260 TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
262 return &isa->arch_env;
268 * Closes the output file and frees the ISA structure.
270 static void TEMPLATE_done(void *self)
272 TEMPLATE_isa_t *isa = self;
274 /* emit now all global declarations */
275 be_gas_emit_decls(isa->arch_env.main_env, 0);
282 static unsigned TEMPLATE_get_n_reg_class(void)
287 static const arch_register_class_t *TEMPLATE_get_reg_class(unsigned i)
289 assert(i < N_CLASSES);
290 return &TEMPLATE_reg_classes[i];
296 * Get the register class which shall be used to store a value of a given mode.
297 * @param self The this pointer.
298 * @param mode The mode in question.
299 * @return A register class which can hold values of the given mode.
301 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
303 if (mode_is_float(mode))
304 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
306 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
312 be_abi_call_flags_bits_t flags;
313 const arch_env_t *arch_env;
315 } TEMPLATE_abi_env_t;
317 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
319 TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
320 be_abi_call_flags_t fl = be_abi_call_get_flags(call);
321 env->flags = fl.bits;
323 env->arch_env = arch_env;
328 * Get the between type for that call.
329 * @param self The callback object.
330 * @return The between type of for that call.
332 static ir_type *TEMPLATE_get_between_type(void *self)
334 static ir_type *between_type = NULL;
335 static ir_entity *old_bp_ent = NULL;
339 ir_entity *ret_addr_ent;
340 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
341 ir_type *old_bp_type = new_type_primitive(new_id_from_str("bp"), mode_P);
343 between_type = new_type_class(new_id_from_str("TEMPLATE_between_type"));
344 old_bp_ent = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
345 ret_addr_ent = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
347 set_entity_offset(old_bp_ent, 0);
348 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
349 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
356 * Build the prolog, return the BASE POINTER register
358 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
359 pmap *reg_map, int *stack_bias)
361 TEMPLATE_abi_env_t *env = self;
366 if(env->flags.try_omit_fp)
367 return env->arch_env->sp;
368 return env->arch_env->bp;
371 /* Build the epilog */
372 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
381 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
384 TEMPLATE_get_between_type,
385 TEMPLATE_abi_prologue,
386 TEMPLATE_abi_epilogue,
390 * Get the ABI restrictions for procedure calls.
391 * @param self The this pointer.
392 * @param method_type The type of the method (procedure) in question.
393 * @param abi The abi object to be modified
395 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
400 int i, n = get_method_n_params(method_type);
401 be_abi_call_flags_t call_flags;
404 /* set abi flags for calls */
405 call_flags.bits.left_to_right = 0;
406 call_flags.bits.store_args_sequential = 1;
407 call_flags.bits.try_omit_fp = 1;
408 call_flags.bits.fp_free = 0;
409 call_flags.bits.call_has_imm = 1;
411 /* set stack parameter passing style */
412 be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
414 for (i = 0; i < n; i++) {
415 /* TODO: implement register parameter: */
416 /* reg = get reg for param i; */
417 /* be_abi_call_param_reg(abi, i, reg); */
419 /* default: all parameters on stack */
420 tp = get_method_param_type(method_type, i);
421 mode = get_type_mode(tp);
422 be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
425 /* TODO: set correct return register */
426 /* default: return value is in R0 resp. F0 */
427 if (get_method_n_ress(method_type) > 0) {
428 tp = get_method_res_type(method_type, 0);
429 mode = get_type_mode(tp);
431 be_abi_call_res_reg(abi, 0,
432 mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
436 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
440 if(!is_TEMPLATE_irn(irn))
447 * Initializes the code generator interface.
449 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
453 return &TEMPLATE_code_gen_if;
456 list_sched_selector_t TEMPLATE_sched_selector;
459 * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
461 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
462 const void *self, list_sched_selector_t *selector)
467 TEMPLATE_sched_selector = trivial_selector;
468 TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
469 return &TEMPLATE_sched_selector;
472 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
480 * Returns the necessary byte alignment for storing a register of given class.
482 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
484 ir_mode *mode = arch_register_class_mode(cls);
485 return get_mode_size_bytes(mode);
489 * Returns the libFirm configuration parameter for this backend.
491 static const backend_params *TEMPLATE_get_backend_params(void) {
492 static backend_params p = {
493 0, /* no dword lowering */
494 0, /* no inline assembly */
495 NULL, /* will be set later */
496 NULL, /* no creator function */
497 NULL, /* context for create_intrinsic_fkt */
498 NULL, /* parameter for if conversion */
499 NULL, /* float arithmetic mode */
500 0, /* no trampoline support: size 0 */
501 0, /* no trampoline support: align 0 */
502 NULL, /* no trampoline support: no trampoline builder */
503 4 /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
508 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
517 static const be_machine_t *TEMPLATE_get_machine(const void *self)
525 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
533 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
536 return ASM_CONSTRAINT_FLAG_INVALID;
539 static int TEMPLATE_is_valid_clobber(const char *clobber)
545 const arch_isa_if_t TEMPLATE_isa_if = {
548 NULL, /* handle intrinsics */
549 TEMPLATE_get_n_reg_class,
550 TEMPLATE_get_reg_class,
551 TEMPLATE_get_reg_class_for_mode,
552 TEMPLATE_get_call_abi,
553 TEMPLATE_get_code_generator_if,
554 TEMPLATE_get_list_sched_selector,
555 TEMPLATE_get_ilp_sched_selector,
556 TEMPLATE_get_reg_class_alignment,
557 TEMPLATE_get_backend_params,
558 TEMPLATE_get_allowed_execution_units,
559 TEMPLATE_get_machine,
560 TEMPLATE_get_backend_irg_list,
561 NULL, /* mark remat */
562 TEMPLATE_parse_asm_constraint,
563 TEMPLATE_is_valid_clobber
566 void be_init_arch_TEMPLATE(void)
568 be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
569 FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
570 TEMPLATE_init_transform();
572 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);