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