nsz Git - libfirm/blob - ir/be/bemain.c

   1 /**
   2  * Backend driver.
   3  * @author Sebastian Hack
   4  * @date 25.11.2004
   5  */
   6 #ifdef HAVE_CONFIG_H
   7 #include "config.h"
   8 #endif
   9
  10 #include <stdarg.h>
  11
  12 #ifdef WITH_LIBCORE
  13 #include <libcore/lc_opts.h>
  14 #include <libcore/lc_opts_enum.h>
  15 #endif /* WITH_LIBCORE */
  16
  17 #include "obst.h"
  18 #include "bitset.h"
  19
  20 #include "irprog.h"
  21 #include "irgopt.h"
  22 #include "irgraph.h"
  23 #include "irdump.h"
  24 #include "phiclass.h"
  25 #include "irdom_t.h"
  26 #include "iredges_t.h"
  27 #include "irloop_t.h"
  28 #include "irtools.h"
  29 #include "return.h"
  30
  31 #include "bearch.h"
  32 #include "firm/bearch_firm.h"
  33 #include "ia32/bearch_ia32.h"
  34 #include "arm/bearch_arm.h"
  35 #include "ppc32/bearch_ppc32.h"
  36 #include "mips/bearch_mips.h"
  37
  38 #include "be_t.h"
  39 #include "benumb_t.h"
  40 #include "beutil.h"
  41 #include "benode_t.h"
  42 #include "beirgmod.h"
  43 #include "besched_t.h"
  44 #include "belistsched.h"
  45 #include "belive_t.h"
  46 #include "bespillilp.h"
  47 #include "bespillbelady.h"
  48 #include "bera.h"
  49 #include "beraextern.h"
  50 #include "bechordal_t.h"
  51 #include "beifg.h"
  52 #include "beifg_impl.h"
  53 #include "becopyopt.h"
  54 #include "becopystat.h"
  55 #include "bessadestr.h"
  56 #include "beabi.h"
  57 #include "belower.h"
  58 #include "beschedmris.h"
  59 #include "bestat.h"
  60
  61 #define DUMP_INITIAL    (1 << 0)
  62 #define DUMP_ABI        (1 << 1)
  63 #define DUMP_SCHED      (1 << 2)
  64 #define DUMP_PREPARED   (1 << 3)
  65 #define DUMP_RA         (1 << 4)
  66 #define DUMP_FINAL      (1 << 5)
  67
  68 /* options visible for anyone */
  69 static be_options_t be_options = {
  70         /* ilp server */
  71         "i44pc52.info.uni-karlsruhe.de",
  72
  73         /* ilp solver */
  74         "cplex"
  75 };
  76
  77 /* dump flags */
  78 static unsigned dump_flags = 0;
  79
  80 /* register allocator to use. */
  81 static const be_ra_t *ra = &be_ra_chordal_allocator;
  82
  83 /* back end instruction set architecture to use */
  84 static const arch_isa_if_t *isa_if = &ia32_isa_if;
  85 #ifdef WITH_LIBCORE
  86
  87 static lc_opt_entry_t *be_grp_root = NULL;
  88
  89 static int be_disable_mris = 0;
  90
  91 /* possible dumping options */
  92 static const lc_opt_enum_mask_items_t dump_items[] = {
  93         { "none",       0 },
  94         { "initial",    DUMP_INITIAL },
  95         { "abi",        DUMP_ABI    },
  96         { "sched",      DUMP_SCHED  },
  97         { "prepared",   DUMP_PREPARED },
  98         { "regalloc",   DUMP_RA },
  99         { "final",      DUMP_FINAL },
 100         { "all",        2 * DUMP_FINAL - 1 },
 101         { NULL,         0 }
 102 };
 103
 104 /* register allocators */
 105 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
 106         { "chordal", &be_ra_chordal_allocator },
 107         { "external", &be_ra_external_allocator },
 108         { NULL,      NULL }
 109 };
 110
 111 /* instruction set architectures. */
 112 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
 113         { "firm",    &firm_isa },
 114         { "ia32",    &ia32_isa_if },
 115 #if 0
 116         { "arm",     &arm_isa_if },
 117         { "ppc32",   &ppc32_isa_if },
 118         { "mips",    &mips_isa_if },
 119 #endif
 120         { NULL,      NULL }
 121 };
 122
 123 static lc_opt_enum_mask_var_t dump_var = {
 124         &dump_flags, dump_items
 125 };
 126
 127 static lc_opt_enum_const_ptr_var_t ra_var = {
 128         (const void **) &ra, ra_items
 129 };
 130
 131 static lc_opt_enum_const_ptr_var_t isa_var = {
 132         (const void **) &isa_if, isa_items
 133 };
 134
 135 static const lc_opt_table_entry_t be_main_options[] = {
 136         LC_OPT_ENT_ENUM_MASK("dump",     "dump irg on several occasions",     &dump_var),
 137         LC_OPT_ENT_ENUM_PTR ("ra",       "register allocator",                &ra_var),
 138         LC_OPT_ENT_ENUM_PTR ("isa",      "the instruction set architecture",  &isa_var),
 139         LC_OPT_ENT_NEGBOOL  ("noomitfp", "do not omit frame pointer",         &be_omit_fp),
 140         LC_OPT_ENT_NEGBOOL  ("nomris",   "disable mris schedule preparation", &be_disable_mris),
 141
 142 #ifdef WITH_ILP
 143         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
 144         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
 145 #endif /* WITH_ILP */
 146         { NULL }
 147 };
 148
 149 #endif /* WITH_LIBCORE */
 150
 151 void be_opt_register(void)
 152 {
 153 #ifdef WITH_LIBCORE
 154         int i;
 155         lc_opt_entry_t *be_grp_ra;
 156         static int run_once = 0;
 157
 158         if (! run_once) {
 159                 run_once    = 1;
 160                 be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
 161                 be_grp_ra   = lc_opt_get_grp(be_grp_root, "ra");
 162
 163                 lc_opt_add_table(be_grp_root, be_main_options);
 164
 165                 /* register allocator options */
 166                 for(i = 0; ra_items[i].name != NULL; ++i) {
 167                         const be_ra_t *ra = ra_items[i].value;
 168                         ra->register_options(be_grp_ra);
 169                 }
 170
 171                 /* register isa options */
 172                 for(i = 0; isa_items[i].name != NULL; ++i) {
 173                         const arch_isa_if_t *isa = isa_items[i].value;
 174                         isa->register_options(be_grp_root);
 175                 }
 176         }
 177 #endif /* WITH_LIBCORE */
 178 }
 179
 180 /* Parse one argument. */
 181 int be_parse_arg(const char *arg) {
 182 #ifdef WITH_LIBCORE
 183         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
 184                 lc_opt_print_help(be_grp_root, stdout);
 185                 return -1;
 186         }
 187         return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
 188 #endif /* WITH_LIBCORE */
 189 }
 190
 191 /** The be parameters returned by default, all off. */
 192 const static backend_params be_params = {
 193         NULL,
 194         NULL,
 195         0,
 196         NULL,
 197 };
 198
 199 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
 200 const backend_params *be_init(void)
 201 {
 202         be_opt_register();
 203
 204         be_sched_init();
 205         be_liveness_init();
 206         be_numbering_init();
 207         be_copy_opt_init();
 208         copystat_init();
 209         phi_class_init();
 210
 211         if (isa_if->get_params)
 212                 return isa_if->get_params();
 213         return &be_params;
 214 }
 215
 216 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
 217 {
 218         memset(env, 0, sizeof(*env));
 219         obstack_init(&env->obst);
 220         env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
 221         env->options  = &be_options;
 222         FIRM_DBG_REGISTER(env->dbg, "be.main");
 223
 224         arch_env_init(env->arch_env, isa_if, file_handle);
 225
 226         /* Register the irn handler of the architecture */
 227         if (arch_isa_get_irn_handler(env->arch_env->isa))
 228                 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
 229
 230         /*
 231          * Register the node handler of the back end infrastructure.
 232          * This irn handler takes care of the platform independent
 233          * spill, reload and perm nodes.
 234          */
 235         arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
 236         env->phi_handler = be_phi_handler_new(env->arch_env);
 237         arch_env_push_irn_handler(env->arch_env, env->phi_handler);
 238
 239         return env;
 240 }
 241
 242 static void be_done_env(be_main_env_t *env)
 243 {
 244         env->arch_env->isa->impl->done(env->arch_env->isa);
 245         be_phi_handler_free(env->phi_handler);
 246         obstack_free(&env->obst, NULL);
 247 }
 248
 249 static void dump(int mask, ir_graph *irg, const char *suffix,
 250                  void (*dumper)(ir_graph *, const char *))
 251 {
 252         if(dump_flags & mask)
 253                 be_dump(irg, suffix, dumper);
 254 }
 255
 256 /**
 257  * Prepare a backend graph for code generation.
 258  */
 259 static void prepare_graph(be_irg_t *birg)
 260 {
 261         ir_graph *irg = birg->irg;
 262
 263         /* Normalize proj nodes. */
 264         normalize_proj_nodes(irg);
 265
 266         /* Make just one return node. */
 267         normalize_one_return(irg);
 268
 269         /* Remove critical edges */
 270         remove_critical_cf_edges(irg);
 271
 272         /* Compute the dominance information. */
 273         free_dom(irg);
 274         compute_doms(irg);
 275
 276         /* Ensure, that the ir_edges are computed. */
 277         edges_activate(irg);
 278
 279         /* check, if the dominance property is fulfilled. */
 280         be_check_dominance(irg);
 281
 282         /* reset the phi handler. */
 283         be_phi_handler_reset(birg->main_env->phi_handler);
 284 }
 285
 286 /**
 287  * The Firm backend main loop.
 288  * Do architecture specific lowering for all graphs
 289  * and call the architecture specific code generator.
 290  */
 291 static void be_main_loop(FILE *file_handle)
 292 {
 293         int i, n;
 294         arch_isa_t *isa;
 295         be_main_env_t env;
 296
 297         be_init_env(&env, file_handle);
 298
 299         isa = arch_env_get_isa(env.arch_env);
 300
 301         // /* for debugging, anchors helps */
 302         // dump_all_anchors(1);
 303
 304         /* For all graphs */
 305         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
 306                 ir_graph *irg = get_irp_irg(i);
 307                 const arch_code_generator_if_t *cg_if;
 308                 be_irg_t birg;
 309
 310                 birg.irg      = irg;
 311                 birg.main_env = &env;
 312
 313                 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
 314                 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
 315
 316                 /* set the current graph (this is important for several firm functions) */
 317                 current_ir_graph = birg.irg;
 318
 319                 /* Get the code generator interface. */
 320                 cg_if = isa->impl->get_code_generator_if(isa);
 321
 322                 /* get a code generator for this graph. */
 323                 birg.cg = cg_if->init(&birg);
 324
 325                 /* create the code generator and generate code. */
 326                 prepare_graph(&birg);
 327
 328                 /* some transformations need to be done before abi introduce */
 329                 arch_code_generator_before_abi(birg.cg);
 330
 331                 /* implement the ABI conventions. */
 332                 birg.abi = be_abi_introduce(&birg);
 333                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
 334
 335                 /* generate code */
 336                 arch_code_generator_prepare_graph(birg.cg);
 337
 338                 /*
 339                  * Since the code generator made a lot of new nodes and skipped
 340                  * a lot of old ones, we should do dead node elimination here.
 341                  * Note that this requires disabling the edges here.
 342                  */
 343                 edges_deactivate(irg);
 344                 //dead_node_elimination(irg);
 345                 edges_activate(irg);
 346
 347                 /* Compute loop nesting information (for weighting copies) */
 348                 construct_cf_backedges(irg);
 349
 350                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
 351
 352                 /* Schedule the graphs. */
 353                 arch_code_generator_before_sched(birg.cg);
 354                 list_sched(&birg, be_disable_mris);
 355                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
 356
 357                 /* add Keeps for should_be_different constrained nodes  */
 358                 /* beware: needs schedule due to usage of be_ssa_constr */
 359                 assure_constraints(&birg);
 360                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
 361
 362                 /* connect all stack modifying nodes together (see beabi.c) */
 363                 be_abi_fix_stack_nodes(birg.abi);
 364                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
 365
 366                 /* Verify the schedule */
 367                 assert(sched_verify_irg(irg));
 368
 369                 /* do some statistics */
 370                 be_do_stat_reg_pressure(&birg);
 371
 372                 /* Do register allocation */
 373                 arch_code_generator_before_ra(birg.cg);
 374                 ra->allocate(&birg);
 375                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
 376
 377                 arch_code_generator_after_ra(birg.cg);
 378                 be_abi_fix_stack_bias(birg.abi);
 379
 380                 arch_code_generator_done(birg.cg);
 381                 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
 382                 be_abi_free(birg.abi);
 383
 384 //              free_ir_graph(irg);
 385         }
 386         be_done_env(&env);
 387 }
 388
 389 /* Main interface to the frontend. */
 390 void be_main(FILE *file_handle)
 391 {
 392         /* never build code for pseudo irgs */
 393         set_visit_pseudo_irgs(0);
 394
 395         be_node_init();
 396         be_main_loop(file_handle);
 397 }
 398
 399 /** The debug info retriever function. */
 400 static retrieve_dbg_func retrieve_dbg = NULL;
 401
 402 /* Sets a debug info retriever. */
 403 void be_set_debug_retrieve(retrieve_dbg_func func) {
 404         retrieve_dbg = func;
 405 }
 406
 407 /* Retrieve the debug info. */
 408 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
 409         if (retrieve_dbg)
 410                 return retrieve_dbg(dbg, line);
 411         *line = 0;
 412         return NULL;
 413 }