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_t.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 #include "TEMPLATE_map_regs.h"
  54
  55 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
  56 static set *cur_reg_set = NULL;
  57
  58 /**************************************************
  59  *                         _ _              _  __
  60  *                        | | |            (_)/ _|
  61  *  _ __ ___  __ _    __ _| | | ___   ___   _| |_
  62  * | '__/ _ \/ _` |  / _` | | |/ _ \ / __| | |  _|
  63  * | | |  __/ (_| | | (_| | | | (_) | (__  | | |
  64  * |_|  \___|\__, |  \__,_|_|_|\___/ \___| |_|_|
  65  *            __/ |
  66  *           |___/
  67  **************************************************/
  68
  69 /**
  70  * Return register requirements for a TEMPLATE node.
  71  * If the node returns a tuple (mode_T) then the proj's
  72  * will be asked for this information.
  73  */
  74 static const arch_register_req_t *TEMPLATE_get_irn_reg_req(const ir_node *node,
  75                                                            int pos)
  76 {
  77         long               node_pos = pos == -1 ? 0 : pos;
  78         ir_mode           *mode     = get_irn_mode(node);
  79
  80         if (mode == mode_T || mode == mode_M) {
  81                 return arch_no_register_req;
  82         }
  83
  84         if (is_Proj(node)) {
  85                 /* in case of a proj, we need to get the correct OUT slot */
  86                 /* of the node corresponding to the proj number */
  87                 if (pos == -1) {
  88                         node_pos = TEMPLATE_translate_proj_pos(node);
  89                 } else {
  90                         node_pos = pos;
  91                 }
  92
  93                 node = skip_Proj_const(node);
  94         }
  95
  96         /* get requirements for our own nodes */
  97         if (is_TEMPLATE_irn(node)) {
  98                 const arch_register_req_t *req;
  99                 if (pos >= 0) {
 100                         req = get_TEMPLATE_in_req(node, pos);
 101                 } else {
 102                         req = get_TEMPLATE_out_req(node, node_pos);
 103                 }
 104
 105                 assert(req != NULL);
 106
 107                 return req;
 108         }
 109
 110         /* unknowns should be transformed already */
 111         assert(!is_Unknown(node));
 112
 113         return arch_no_register_req;
 114 }
 115
 116 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
 117 {
 118         irn = skip_Proj_const(irn);
 119
 120         if (is_cfop(irn)) {
 121                 return arch_irn_class_branch;
 122         }
 123
 124         return 0;
 125 }
 126
 127 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
 128 {
 129         (void) node;
 130         /* TODO: return the ir_entity assigned to the frame */
 131         return NULL;
 132 }
 133
 134 static void TEMPLATE_set_frame_entity(ir_node *node, ir_entity *ent)
 135 {
 136         (void) node;
 137         (void) ent;
 138         /* TODO: set the ir_entity assigned to the frame */
 139 }
 140
 141 /**
 142  * This function is called by the generic backend to correct offsets for
 143  * nodes accessing the stack.
 144  */
 145 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
 146 {
 147         (void) irn;
 148         (void) offset;
 149         /* TODO: correct offset if irn accesses the stack */
 150 }
 151
 152 static int TEMPLATE_get_sp_bias(const ir_node *irn)
 153 {
 154         (void) irn;
 155         return 0;
 156 }
 157
 158 /* fill register allocator interface */
 159
 160 static const arch_irn_ops_t TEMPLATE_irn_ops = {
 161         TEMPLATE_get_irn_reg_req,
 162         TEMPLATE_classify,
 163         TEMPLATE_get_frame_entity,
 164         TEMPLATE_set_frame_entity,
 165         TEMPLATE_set_frame_offset,
 166         TEMPLATE_get_sp_bias,
 167         NULL,    /* get_inverse             */
 168         NULL,    /* get_op_estimated_cost   */
 169         NULL,    /* possible_memory_operand */
 170         NULL,    /* perform_memory_operand  */
 171 };
 172
 173 /**************************************************
 174  *                _                         _  __
 175  *               | |                       (_)/ _|
 176  *   ___ ___   __| | ___  __ _  ___ _ __    _| |_
 177  *  / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \  | |  _|
 178  * | (_| (_) | (_| |  __/ (_| |  __/ | | | | | |
 179  *  \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
 180  *                        __/ |
 181  *                       |___/
 182  **************************************************/
 183
 184 /**
 185  * Transforms the standard firm graph into
 186  * a TEMLPATE firm graph
 187  */
 188 static void TEMPLATE_prepare_graph(void *self) {
 189         TEMPLATE_code_gen_t *cg = self;
 190
 191         irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
 192 }
 193
 194
 195
 196 /**
 197  * Called immediatly before emit phase.
 198  */
 199 static void TEMPLATE_finish_irg(void *self) {
 200         TEMPLATE_code_gen_t *cg = self;
 201         ir_graph            *irg = cg->irg;
 202
 203         dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
 204 }
 205
 206
 207 static void TEMPLATE_before_ra(void *self) {
 208         (void) self;
 209         /* Some stuff you need to do after scheduling but before register allocation */
 210 }
 211
 212 static void TEMPLATE_after_ra(void *self) {
 213         (void) self;
 214         /* Some stuff you need to do immediatly after register allocation */
 215 }
 216
 217
 218
 219 /**
 220  * Emits the code, closes the output file and frees
 221  * the code generator interface.
 222  */
 223 static void TEMPLATE_emit_and_done(void *self) {
 224         TEMPLATE_code_gen_t *cg = self;
 225         ir_graph           *irg = cg->irg;
 226
 227         TEMPLATE_gen_routine(cg, irg);
 228
 229         cur_reg_set = NULL;
 230
 231         /* de-allocate code generator */
 232         del_set(cg->reg_set);
 233         free(cg);
 234 }
 235
 236 static void *TEMPLATE_cg_init(be_irg_t *birg);
 237
 238 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
 239         TEMPLATE_cg_init,
 240         NULL,                    /* get_pic_base hook */
 241         NULL,                    /* before abi introduce hook */
 242         TEMPLATE_prepare_graph,
 243         NULL,                    /* spill hook */
 244         TEMPLATE_before_ra,      /* before register allocation hook */
 245         TEMPLATE_after_ra,       /* after register allocation hook */
 246         TEMPLATE_finish_irg,
 247         TEMPLATE_emit_and_done
 248 };
 249
 250 /**
 251  * Initializes the code generator.
 252  */
 253 static void *TEMPLATE_cg_init(be_irg_t *birg) {
 254         const arch_env_t    *arch_env = be_get_birg_arch_env(birg);
 255         TEMPLATE_isa_t      *isa      = (TEMPLATE_isa_t *) arch_env;
 256         TEMPLATE_code_gen_t *cg       = XMALLOC(TEMPLATE_code_gen_t);
 257
 258         cg->impl     = &TEMPLATE_code_gen_if;
 259         cg->irg      = be_get_birg_irg(birg);
 260         cg->reg_set  = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
 261         cg->isa      = isa;
 262         cg->birg     = birg;
 263         FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
 264
 265         cur_reg_set = cg->reg_set;
 266
 267         return (arch_code_generator_t *)cg;
 268 }
 269
 270
 271
 272 /*****************************************************************
 273  *  ____             _                  _   _____  _____
 274  * |  _ \           | |                | | |_   _|/ ____|  /\
 275  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
 276  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
 277  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
 278  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
 279  *
 280  *****************************************************************/
 281
 282 static TEMPLATE_isa_t TEMPLATE_isa_template = {
 283         {
 284                 &TEMPLATE_isa_if,             /* isa interface implementation */
 285                 &TEMPLATE_general_purpose_regs[REG_SP],  /* stack pointer register */
 286                 &TEMPLATE_general_purpose_regs[REG_BP],  /* base pointer register */
 287                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose],  /* link pointer register class */
 288                 -1,                          /* stack direction */
 289                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
 290                 NULL,                        /* main environment */
 291                 7,                           /* costs for a spill instruction */
 292                 5,                           /* costs for a reload instruction */
 293         },
 294 };
 295
 296 /**
 297  * Initializes the backend ISA and opens the output file.
 298  */
 299 static arch_env_t *TEMPLATE_init(FILE *outfile) {
 300         static int run_once = 0;
 301         TEMPLATE_isa_t *isa;
 302
 303         if(run_once)
 304                 return NULL;
 305         run_once = 1;
 306
 307         isa = XMALLOC(TEMPLATE_isa_t);
 308         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
 309
 310         be_emit_init(outfile);
 311
 312         TEMPLATE_register_init();
 313         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
 314
 315         return &isa->arch_env;
 316 }
 317
 318
 319
 320 /**
 321  * Closes the output file and frees the ISA structure.
 322  */
 323 static void TEMPLATE_done(void *self) {
 324         TEMPLATE_isa_t *isa = self;
 325
 326         /* emit now all global declarations */
 327         be_gas_emit_decls(isa->arch_env.main_env, 0);
 328
 329         be_emit_exit();
 330         free(self);
 331 }
 332
 333
 334
 335 static unsigned TEMPLATE_get_n_reg_class(const void *self)
 336 {
 337         (void) self;
 338         return N_CLASSES;
 339 }
 340
 341 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self,
 342                                                            unsigned i)
 343 {
 344         (void) self;
 345         assert(i < N_CLASSES);
 346         return &TEMPLATE_reg_classes[i];
 347 }
 348
 349
 350
 351 /**
 352  * Get the register class which shall be used to store a value of a given mode.
 353  * @param self The this pointer.
 354  * @param mode The mode in question.
 355  * @return A register class which can hold values of the given mode.
 356  */
 357 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self,
 358                 const ir_mode *mode)
 359 {
 360         (void) self;
 361         if (mode_is_float(mode))
 362                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
 363         else
 364                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
 365 }
 366
 367
 368
 369 typedef struct {
 370         be_abi_call_flags_bits_t flags;
 371         const arch_env_t *arch_env;
 372         ir_graph *irg;
 373 } TEMPLATE_abi_env_t;
 374
 375 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
 376 {
 377         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
 378         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
 379         env->flags    = fl.bits;
 380         env->irg      = irg;
 381         env->arch_env = arch_env;
 382         return env;
 383 }
 384
 385 /**
 386  * Get the between type for that call.
 387  * @param self The callback object.
 388  * @return The between type of for that call.
 389  */
 390 static ir_type *TEMPLATE_get_between_type(void *self)
 391 {
 392         static ir_type *between_type = NULL;
 393         static ir_entity *old_bp_ent = NULL;
 394         (void) self;
 395
 396         if(!between_type) {
 397                 ir_entity *ret_addr_ent;
 398                 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
 399                 ir_type *old_bp_type   = new_type_primitive(new_id_from_str("bp"), mode_P);
 400
 401                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
 402                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
 403                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
 404
 405                 set_entity_offset(old_bp_ent, 0);
 406                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
 407                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
 408         }
 409
 410         return between_type;
 411 }
 412
 413 /**
 414  * Build the prolog, return the BASE POINTER register
 415  */
 416 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
 417                                                     pmap *reg_map, int *stack_bias)
 418 {
 419         TEMPLATE_abi_env_t *env = self;
 420         (void) reg_map;
 421         (void) mem;
 422         (void) stack_bias;
 423
 424         if(env->flags.try_omit_fp)
 425                 return env->arch_env->sp;
 426         return env->arch_env->bp;
 427 }
 428
 429 /* Build the epilog */
 430 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
 431                                   pmap *reg_map)
 432 {
 433         (void) self;
 434         (void) bl;
 435         (void) mem;
 436         (void) reg_map;
 437 }
 438
 439 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
 440         TEMPLATE_abi_init,
 441         free,
 442         TEMPLATE_get_between_type,
 443         TEMPLATE_abi_prologue,
 444         TEMPLATE_abi_epilogue,
 445 };
 446
 447 /**
 448  * Get the ABI restrictions for procedure calls.
 449  * @param self        The this pointer.
 450  * @param method_type The type of the method (procedure) in question.
 451  * @param abi         The abi object to be modified
 452  */
 453 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
 454                            be_abi_call_t *abi)
 455 {
 456         ir_type  *tp;
 457         ir_mode  *mode;
 458         int       i, n = get_method_n_params(method_type);
 459         be_abi_call_flags_t call_flags;
 460         (void) self;
 461
 462         /* set abi flags for calls */
 463         call_flags.bits.left_to_right         = 0;
 464         call_flags.bits.store_args_sequential = 1;
 465         call_flags.bits.try_omit_fp           = 1;
 466         call_flags.bits.fp_free               = 0;
 467         call_flags.bits.call_has_imm          = 1;
 468
 469         /* set stack parameter passing style */
 470         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
 471
 472         for (i = 0; i < n; i++) {
 473                 /* TODO: implement register parameter: */
 474                 /* reg = get reg for param i;          */
 475                 /* be_abi_call_param_reg(abi, i, reg); */
 476
 477                 /* default: all parameters on stack */
 478                 tp   = get_method_param_type(method_type, i);
 479                 mode = get_type_mode(tp);
 480                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
 481         }
 482
 483         /* TODO: set correct return register */
 484         /* default: return value is in R0 resp. F0 */
 485         if (get_method_n_ress(method_type) > 0) {
 486                 tp   = get_method_res_type(method_type, 0);
 487                 mode = get_type_mode(tp);
 488
 489                 be_abi_call_res_reg(abi, 0,
 490                         mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
 491         }
 492 }
 493
 494 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
 495 {
 496         (void) block_env;
 497
 498         if(!is_TEMPLATE_irn(irn))
 499                 return -1;
 500
 501         return 1;
 502 }
 503
 504 /**
 505  * Initializes the code generator interface.
 506  */
 507 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
 508                 void *self)
 509 {
 510         (void) self;
 511         return &TEMPLATE_code_gen_if;
 512 }
 513
 514 list_sched_selector_t TEMPLATE_sched_selector;
 515
 516 /**
 517  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
 518  */
 519 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
 520                 const void *self, list_sched_selector_t *selector)
 521 {
 522         (void) self;
 523         (void) selector;
 524
 525         TEMPLATE_sched_selector = trivial_selector;
 526         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
 527         return &TEMPLATE_sched_selector;
 528 }
 529
 530 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
 531                 const void *self)
 532 {
 533         (void) self;
 534         return NULL;
 535 }
 536
 537 /**
 538  * Returns the necessary byte alignment for storing a register of given class.
 539  */
 540 static int TEMPLATE_get_reg_class_alignment(const void *self,
 541                                             const arch_register_class_t *cls) {
 542         ir_mode *mode = arch_register_class_mode(cls);
 543         (void) self;
 544         return get_mode_size_bytes(mode);
 545 }
 546
 547 /**
 548  * Returns the libFirm configuration parameter for this backend.
 549  */
 550 static const backend_params *TEMPLATE_get_backend_params(void) {
 551         static backend_params p = {
 552                 0,     /* no dword lowering */
 553                 0,     /* no inline assembly */
 554                 NULL,  /* will be set later */
 555                 NULL,  /* no creator function */
 556                 NULL,  /* context for create_intrinsic_fkt */
 557                 NULL,  /* parameter for if conversion */
 558                 NULL,  /* float arithmetic mode */
 559                 0,     /* no trampoline support: size 0 */
 560                 0,     /* no trampoline support: align 0 */
 561                 NULL,  /* no trampoline support: no trampoline builder */
 562                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
 563         };
 564         return &p;
 565 }
 566
 567 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
 568                 const void *self, const ir_node *irn)
 569 {
 570         (void) self;
 571         (void) irn;
 572         /* TODO */
 573         assert(0);
 574         return NULL;
 575 }
 576
 577 static const be_machine_t *TEMPLATE_get_machine(const void *self)
 578 {
 579         (void) self;
 580         /* TODO */
 581         assert(0);
 582         return NULL;
 583 }
 584
 585 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
 586                                                 ir_graph ***irgs)
 587 {
 588         (void) self;
 589         (void) irgs;
 590         return NULL;
 591 }
 592
 593 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const void *self,
 594                                                             const char **c)
 595 {
 596         (void) self;
 597         (void) c;
 598         return ASM_CONSTRAINT_FLAG_INVALID;
 599 }
 600
 601 static int TEMPLATE_is_valid_clobber(const void *self, const char *clobber)
 602 {
 603         (void) self;
 604         (void) clobber;
 605         return 0;
 606 }
 607
 608 const arch_isa_if_t TEMPLATE_isa_if = {
 609         TEMPLATE_init,
 610         TEMPLATE_done,
 611         NULL,                /* handle intrinsics */
 612         TEMPLATE_get_n_reg_class,
 613         TEMPLATE_get_reg_class,
 614         TEMPLATE_get_reg_class_for_mode,
 615         TEMPLATE_get_call_abi,
 616         TEMPLATE_get_code_generator_if,
 617         TEMPLATE_get_list_sched_selector,
 618         TEMPLATE_get_ilp_sched_selector,
 619         TEMPLATE_get_reg_class_alignment,
 620     TEMPLATE_get_backend_params,
 621         TEMPLATE_get_allowed_execution_units,
 622         TEMPLATE_get_machine,
 623         TEMPLATE_get_backend_irg_list,
 624         NULL,                    /* mark remat */
 625         TEMPLATE_parse_asm_constraint,
 626         TEMPLATE_is_valid_clobber
 627 };
 628
 629 void be_init_arch_TEMPLATE(void)
 630 {
 631         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
 632 }
 633
 634 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);