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