nsz Git - libfirm/blob - 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  * @version  $Id$
  24  */
  25 #include "config.h"
  26
  27 #include "pseudo_irg.h"
  28 #include "irgwalk.h"
  29 #include "irprog.h"
  30 #include "irprintf.h"
  31 #include "ircons.h"
  32 #include "irgmod.h"
  33
  34 #include "bitset.h"
  35 #include "debug.h"
  36
  37 #include "be.h"
  38 #include "../bearch.h"
  39 #include "../benode.h"
  40 #include "../belower.h"
  41 #include "../besched.h"
  42 #include "../beabi.h"
  43 #include "../bemodule.h"
  44 #include "../begnuas.h"
  45 #include "../belistsched.h"
  46
  47 #include "bearch_TEMPLATE_t.h"
  48
  49 #include "TEMPLATE_new_nodes.h"
  50 #include "gen_TEMPLATE_regalloc_if.h"
  51 #include "TEMPLATE_transform.h"
  52 #include "TEMPLATE_emitter.h"
  53
  54 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
  55
  56 /**************************************************
  57  *                         _ _              _  __
  58  *                        | | |            (_)/ _|
  59  *  _ __ ___  __ _    __ _| | | ___   ___   _| |_
  60  * | '__/ _ \/ _` |  / _` | | |/ _ \ / __| | |  _|
  61  * | | |  __/ (_| | | (_| | | | (_) | (__  | | |
  62  * |_|  \___|\__, |  \__,_|_|_|\___/ \___| |_|_|
  63  *            __/ |
  64  *           |___/
  65  **************************************************/
  66
  67 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
  68 {
  69         (void) irn;
  70         return 0;
  71 }
  72
  73 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
  74 {
  75         (void) node;
  76         /* TODO: return the ir_entity assigned to the frame */
  77         return NULL;
  78 }
  79
  80 static void TEMPLATE_set_frame_entity(ir_node *node, ir_entity *ent)
  81 {
  82         (void) node;
  83         (void) ent;
  84         /* TODO: set the ir_entity assigned to the frame */
  85 }
  86
  87 /**
  88  * This function is called by the generic backend to correct offsets for
  89  * nodes accessing the stack.
  90  */
  91 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
  92 {
  93         (void) irn;
  94         (void) offset;
  95         /* TODO: correct offset if irn accesses the stack */
  96 }
  97
  98 static int TEMPLATE_get_sp_bias(const ir_node *irn)
  99 {
 100         (void) irn;
 101         return 0;
 102 }
 103
 104 /* fill register allocator interface */
 105
 106 static const arch_irn_ops_t TEMPLATE_irn_ops = {
 107         get_TEMPLATE_in_req,
 108         TEMPLATE_classify,
 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  */
 117 };
 118
 119 /**************************************************
 120  *                _                         _  __
 121  *               | |                       (_)/ _|
 122  *   ___ ___   __| | ___  __ _  ___ _ __    _| |_
 123  *  / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \  | |  _|
 124  * | (_| (_) | (_| |  __/ (_| |  __/ | | | | | |
 125  *  \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
 126  *                        __/ |
 127  *                       |___/
 128  **************************************************/
 129
 130 /**
 131  * Transforms the standard firm graph into
 132  * a TEMLPATE firm graph
 133  */
 134 static void TEMPLATE_prepare_graph(void *self)
 135 {
 136         TEMPLATE_code_gen_t *cg = self;
 137
 138         irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
 139 }
 140
 141
 142
 143 /**
 144  * Called immediatly before emit phase.
 145  */
 146 static void TEMPLATE_finish_irg(void *self)
 147 {
 148         TEMPLATE_code_gen_t *cg = self;
 149         ir_graph            *irg = cg->irg;
 150
 151         dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
 152 }
 153
 154
 155 static void TEMPLATE_before_ra(void *self)
 156 {
 157         (void) self;
 158         /* Some stuff you need to do after scheduling but before register allocation */
 159 }
 160
 161 static void TEMPLATE_after_ra(void *self)
 162 {
 163         (void) self;
 164         /* Some stuff you need to do immediatly after register allocation */
 165 }
 166
 167
 168
 169 /**
 170  * Emits the code, closes the output file and frees
 171  * the code generator interface.
 172  */
 173 static void TEMPLATE_emit_and_done(void *self)
 174 {
 175         TEMPLATE_code_gen_t *cg = self;
 176         ir_graph           *irg = cg->irg;
 177
 178         TEMPLATE_gen_routine(cg, irg);
 179
 180         /* de-allocate code generator */
 181         free(cg);
 182 }
 183
 184 static void *TEMPLATE_cg_init(be_irg_t *birg);
 185
 186 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
 187         TEMPLATE_cg_init,
 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 */
 194         TEMPLATE_finish_irg,
 195         TEMPLATE_emit_and_done
 196 };
 197
 198 /**
 199  * Initializes the code generator.
 200  */
 201 static void *TEMPLATE_cg_init(be_irg_t *birg)
 202 {
 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);
 206
 207         cg->impl     = &TEMPLATE_code_gen_if;
 208         cg->irg      = be_get_birg_irg(birg);
 209         cg->isa      = isa;
 210         cg->birg     = birg;
 211
 212         return (arch_code_generator_t *)cg;
 213 }
 214
 215
 216
 217 /*****************************************************************
 218  *  ____             _                  _   _____  _____
 219  * |  _ \           | |                | | |_   _|/ ____|  /\
 220  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
 221  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
 222  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
 223  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
 224  *
 225  *****************************************************************/
 226
 227 const arch_isa_if_t TEMPLATE_isa_if;
 228 static TEMPLATE_isa_t TEMPLATE_isa_template = {
 229         {
 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 */
 239         },
 240 };
 241
 242 /**
 243  * Initializes the backend ISA and opens the output file.
 244  */
 245 static arch_env_t *TEMPLATE_init(FILE *outfile)
 246 {
 247         static int run_once = 0;
 248         TEMPLATE_isa_t *isa;
 249
 250         if(run_once)
 251                 return NULL;
 252         run_once = 1;
 253
 254         isa = XMALLOC(TEMPLATE_isa_t);
 255         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
 256
 257         be_emit_init(outfile);
 258
 259         TEMPLATE_register_init();
 260         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
 261
 262         return &isa->arch_env;
 263 }
 264
 265
 266
 267 /**
 268  * Closes the output file and frees the ISA structure.
 269  */
 270 static void TEMPLATE_done(void *self)
 271 {
 272         TEMPLATE_isa_t *isa = self;
 273
 274         /* emit now all global declarations */
 275         be_gas_emit_decls(isa->arch_env.main_env, 0);
 276
 277         be_emit_exit();
 278         free(self);
 279 }
 280
 281
 282 static unsigned TEMPLATE_get_n_reg_class(void)
 283 {
 284         return N_CLASSES;
 285 }
 286
 287 static const arch_register_class_t *TEMPLATE_get_reg_class(unsigned i)
 288 {
 289         assert(i < N_CLASSES);
 290         return &TEMPLATE_reg_classes[i];
 291 }
 292
 293
 294
 295 /**
 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.
 300  */
 301 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
 302 {
 303         if (mode_is_float(mode))
 304                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
 305         else
 306                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
 307 }
 308
 309
 310
 311 typedef struct {
 312         be_abi_call_flags_bits_t flags;
 313         const arch_env_t *arch_env;
 314         ir_graph *irg;
 315 } TEMPLATE_abi_env_t;
 316
 317 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
 318 {
 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;
 322         env->irg      = irg;
 323         env->arch_env = arch_env;
 324         return env;
 325 }
 326
 327 /**
 328  * Get the between type for that call.
 329  * @param self The callback object.
 330  * @return The between type of for that call.
 331  */
 332 static ir_type *TEMPLATE_get_between_type(void *self)
 333 {
 334         static ir_type *between_type = NULL;
 335         static ir_entity *old_bp_ent = NULL;
 336         (void) self;
 337
 338         if(!between_type) {
 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);
 342
 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);
 346
 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));
 350         }
 351
 352         return between_type;
 353 }
 354
 355 /**
 356  * Build the prolog, return the BASE POINTER register
 357  */
 358 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
 359                                                     pmap *reg_map, int *stack_bias)
 360 {
 361         TEMPLATE_abi_env_t *env = self;
 362         (void) reg_map;
 363         (void) mem;
 364         (void) stack_bias;
 365
 366         if(env->flags.try_omit_fp)
 367                 return env->arch_env->sp;
 368         return env->arch_env->bp;
 369 }
 370
 371 /* Build the epilog */
 372 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
 373                                   pmap *reg_map)
 374 {
 375         (void) self;
 376         (void) bl;
 377         (void) mem;
 378         (void) reg_map;
 379 }
 380
 381 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
 382         TEMPLATE_abi_init,
 383         free,
 384         TEMPLATE_get_between_type,
 385         TEMPLATE_abi_prologue,
 386         TEMPLATE_abi_epilogue,
 387 };
 388
 389 /**
 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
 394  */
 395 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
 396                            be_abi_call_t *abi)
 397 {
 398         ir_type  *tp;
 399         ir_mode  *mode;
 400         int       i, n = get_method_n_params(method_type);
 401         be_abi_call_flags_t call_flags;
 402         (void) self;
 403
 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;
 410
 411         /* set stack parameter passing style */
 412         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
 413
 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); */
 418
 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);
 423         }
 424
 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);
 430
 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]);
 433         }
 434 }
 435
 436 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
 437 {
 438         (void) block_env;
 439
 440         if(!is_TEMPLATE_irn(irn))
 441                 return -1;
 442
 443         return 1;
 444 }
 445
 446 /**
 447  * Initializes the code generator interface.
 448  */
 449 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
 450                 void *self)
 451 {
 452         (void) self;
 453         return &TEMPLATE_code_gen_if;
 454 }
 455
 456 list_sched_selector_t TEMPLATE_sched_selector;
 457
 458 /**
 459  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
 460  */
 461 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
 462                 const void *self, list_sched_selector_t *selector)
 463 {
 464         (void) self;
 465         (void) selector;
 466
 467         TEMPLATE_sched_selector = trivial_selector;
 468         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
 469         return &TEMPLATE_sched_selector;
 470 }
 471
 472 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
 473                 const void *self)
 474 {
 475         (void) self;
 476         return NULL;
 477 }
 478
 479 /**
 480  * Returns the necessary byte alignment for storing a register of given class.
 481  */
 482 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
 483 {
 484         ir_mode *mode = arch_register_class_mode(cls);
 485         return get_mode_size_bytes(mode);
 486 }
 487
 488 /**
 489  * Returns the libFirm configuration parameter for this backend.
 490  */
 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) */
 504         };
 505         return &p;
 506 }
 507
 508 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
 509                 const ir_node *irn)
 510 {
 511         (void) irn;
 512         /* TODO */
 513         assert(0);
 514         return NULL;
 515 }
 516
 517 static const be_machine_t *TEMPLATE_get_machine(const void *self)
 518 {
 519         (void) self;
 520         /* TODO */
 521         assert(0);
 522         return NULL;
 523 }
 524
 525 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
 526                                                 ir_graph ***irgs)
 527 {
 528         (void) self;
 529         (void) irgs;
 530         return NULL;
 531 }
 532
 533 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
 534 {
 535         (void) c;
 536         return ASM_CONSTRAINT_FLAG_INVALID;
 537 }
 538
 539 static int TEMPLATE_is_valid_clobber(const char *clobber)
 540 {
 541         (void) clobber;
 542         return 0;
 543 }
 544
 545 const arch_isa_if_t TEMPLATE_isa_if = {
 546         TEMPLATE_init,
 547         TEMPLATE_done,
 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
 564 };
 565
 566 void be_init_arch_TEMPLATE(void)
 567 {
 568         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
 569         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
 570         TEMPLATE_init_transform();
 571 }
 572 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);