nsz Git - libfirm/blob - ir/ir/irpass.c

   1 /*
   2  * Copyright (C) 1995-2009 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     Manager for optimization passes.
  23  * @author    Michael Beck
  24  * @version   $Id$
  25  */
  26 #include "config.h"
  27
  28 #include <string.h>
  29 #include "adt/list.h"
  30 #include "irpass_t.h"
  31 #include "irgraph_t.h"
  32 #include "irprog_t.h"
  33 #include "irdump.h"
  34 #include "irvrfy.h"
  35 #include "xmalloc.h"
  36
  37 /*Add a graph pass to a graph pass manager. */
  38 void ir_graph_pass_mgr_add(ir_graph_pass_manager_t *mgr, ir_graph_pass_t *pass)
  39 {
  40         list_add(&pass->list, &mgr->passes);
  41         ++mgr->n_passes;
  42         if (pass->add_to_mgr)
  43                 pass->add_to_mgr(pass->context);
  44 }
  45
  46 /* Add an irprog pass to an irprog pass manager. */
  47 void ir_prog_pass_mgr_add(ir_prog_pass_manager_t *mgr, ir_prog_pass_t *pass)
  48 {
  49         list_add(&pass->list, &mgr->passes);
  50         ++mgr->n_passes;
  51         if (pass->add_to_mgr)
  52                 pass->add_to_mgr(pass->context);
  53 }
  54
  55 /**
  56  * wrapper for running a graph pass manager as a pass on an irprog
  57  * pass manager.
  58  */
  59 static int run_wrapper(ir_prog *prog, void *ctx)
  60 {
  61         ir_graph_pass_manager_t *mgr = ctx;
  62
  63         (void)prog;
  64         return ir_graph_pass_mgr_run(mgr);
  65 }
  66
  67 /**
  68  * Ensure that no verifier is run from the wrapper.
  69  */
  70 static int no_verify(ir_prog *prog, void *ctx)
  71 {
  72         (void)prog;
  73         (void)ctx;
  74         return 0;
  75 }
  76
  77 /**
  78  * Ensure that no dumper is run from the wrapper.
  79  */
  80 static void no_dump(ir_prog *prog, void *ctx, unsigned idx)
  81 {
  82         (void)prog;
  83         (void)ctx;
  84         (void)idx;
  85 }
  86
  87 /**
  88  * Term warpper for a wrapped ir_graph pass manager.
  89  */
  90 static void term_wrapper(void *context)
  91 {
  92         ir_graph_pass_manager_t *mgr = context;
  93         term_graph_pass_mgr(mgr);
  94 }
  95
  96 /**
  97  * Create a wrapper ir_prog pass for an ir_graph manager.
  98  */
  99 static ir_prog_pass_t *create_wrapper_pass(ir_graph_pass_manager_t *graph_mgr)
 100 {
 101         /* create a wrapper pass */
 102         ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 103
 104         pass->run_on_irprog = run_wrapper;
 105         pass->context       = graph_mgr;
 106         pass->name          = graph_mgr->name;
 107
 108         /* do not verify nor dump: this is handled by the graph manager */
 109         pass->verify_irprog = no_verify;
 110         pass->dump_irprog   = no_dump;
 111         pass->is_wrapper    = 1;
 112
 113         pass->add_to_mgr   = NULL;
 114         pass->rem_from_mgr = term_wrapper;
 115
 116         return pass;
 117 }
 118
 119 /* Add an ir_graph_pass as a pass to an ir_prog pass manager. */
 120 void ir_prog_pass_mgr_add_graph_pass(
 121         ir_prog_pass_manager_t *mgr, ir_graph_pass_t *pass)
 122 {
 123         ir_graph_pass_manager_t *graph_mgr;
 124         ir_prog_pass_t          *wrapper;
 125
 126         /* check if the last pass is a graph_pass wrapper */
 127         if (! list_empty(&mgr->passes)) {
 128                 wrapper = list_entry(mgr->passes.prev, ir_prog_pass_t, list);
 129                 if (wrapper->is_wrapper) {
 130                         graph_mgr = wrapper->context;
 131
 132                         ir_graph_pass_mgr_add(graph_mgr, pass);
 133                         return;
 134                 }
 135         }
 136
 137         /* not found, create a new wrapper */
 138         graph_mgr = new_graph_pass_mgr("wrapper", mgr->verify_all, mgr->dump_all);
 139         ir_graph_pass_mgr_add(graph_mgr, pass);
 140
 141         wrapper = create_wrapper_pass(graph_mgr);
 142         ir_prog_pass_mgr_add(mgr, wrapper);
 143 }
 144
 145 /* Add an ir_graph_pass_manager as a pass to an ir_prog pass manager. */
 146 void ir_prog_pass_mgr_add_graph_mgr(
 147         ir_prog_pass_manager_t *mgr, ir_graph_pass_manager_t *graph_mgr)
 148 {
 149         ir_prog_pass_t *pass = create_wrapper_pass(graph_mgr);
 150
 151         if (mgr->dump_all)
 152                 graph_mgr->dump_all = 1;
 153         if (mgr->verify_all)
 154                 graph_mgr->verify_all = 1;
 155         graph_mgr->run_idx = mgr->n_passes;
 156
 157         ir_prog_pass_mgr_add(mgr, pass);
 158 }
 159
 160 /**
 161  * Create a suffix for dumping.
 162  */
 163 void create_suffix(char *suffix, size_t n, const char *pass_name, unsigned index)
 164 {
 165         snprintf(suffix, n, "-%02u_%s", index, pass_name);
 166 }
 167
 168 /* Run all passes of an ir_graph pass manager. */
 169 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
 170 {
 171         ir_graph_pass_t *pass;
 172         int             i, res = 0;
 173         ir_graph        *rem = current_ir_graph;
 174
 175         /* on all graphs: beware: number of irgs might be changed */
 176         for (i = 0; i < get_irp_n_irgs(); ++i) {
 177                 ir_graph *irg = current_ir_graph = get_irp_irg(i);
 178                 unsigned idx = mgr->run_idx;
 179                 /* run every pass on every graph */
 180                 list_for_each_entry(ir_graph_pass_t, pass, &mgr->passes, list) {
 181                         int pass_res = pass->run_on_irg(irg, pass->context);
 182                         if (pass_res != 0)
 183                                 res = 1;
 184                         /* verify is necessary */
 185                         if (mgr->verify_all) {
 186                                 if (pass->verify_irg) {
 187                                         pass->verify_irg(irg, pass->context);
 188                                 } else {
 189                                         irg_verify(irg, 0);
 190                                 }
 191                         }
 192                         /* dump */
 193                         if (mgr->dump_all) {
 194                                 if (pass->dump_irg) {
 195                                         pass->dump_irg(irg, pass->context, idx);
 196                                 } else {
 197                                         char suffix[1024];
 198                                         create_suffix(suffix, sizeof(suffix), pass->name, idx);
 199                                         dump_ir_block_graph(irg, suffix);
 200                                 }
 201                         }
 202                         ++idx;
 203                 }
 204         }
 205         current_ir_graph = rem;
 206         return res;
 207 }
 208
 209 /**
 210  * Verify all graphs on the given ir_prog.
 211  */
 212 static int irp_verify_irgs(void)
 213 {
 214         int i, res = 1;
 215
 216         for (i = get_irp_n_irgs() - 1; i >= 0; --i)
 217                 res &= irg_verify(get_irp_irg(i), 0);
 218         return res;
 219 }
 220
 221 /* Run all passes of an ir_prog pass manager. */
 222 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
 223 {
 224         ir_prog_pass_t *pass;
 225         int            res = 0;
 226
 227         /* run every pass on every graph */
 228         unsigned idx = mgr->run_idx;
 229         list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
 230                 int pass_res = pass->run_on_irprog(irp, pass->context);
 231                 if (pass_res != 0)
 232                         res = 1;
 233                 /* verify is necessary */
 234                 if (mgr->verify_all) {
 235                         if (pass->verify_irprog) {
 236                                 pass->verify_irprog(irp, pass->context);
 237                         } else {
 238                                 irp_verify_irgs();
 239                         }
 240                 }
 241                 /* dump */
 242                 if (mgr->dump_all) {
 243                         if (pass->dump_irprog) {
 244                                 pass->dump_irprog(irp, pass->context, idx);
 245                         } else {
 246                                 char suffix[1024];
 247                                 create_suffix(suffix, sizeof(suffix), pass->name, idx);
 248                                 dump_all_ir_graphs(dump_ir_block_graph, suffix);
 249                         }
 250                 }
 251                 if (pass->is_wrapper) {
 252                         ir_graph_pass_manager_t *graph_mgr = pass->context;
 253                         idx += graph_mgr->n_passes;
 254                 } else
 255                         ++idx;
 256         }
 257         return res;
 258 }
 259
 260 /* Creates a new ir_graph pass manager. */
 261 ir_graph_pass_manager_t *new_graph_pass_mgr(
 262         const char *name, int verify_all, int dump_all)
 263 {
 264         ir_graph_pass_manager_t *res = xmalloc(sizeof(res));
 265
 266         INIT_LIST_HEAD(&res->passes);
 267         res->name       = name;
 268         res->run_idx    = 0;
 269         res->verify_all = verify_all != 0;
 270         res->dump_all   = dump_all   != 0;
 271
 272         return res;
 273 }
 274
 275 /* Creates a new ir_prog pass manager. */
 276 ir_prog_pass_manager_t *new_prog_pass_mgr(
 277         const char *name, int verify_all, int dump_all)
 278 {
 279         ir_prog_pass_manager_t *res = xmalloc(sizeof(res));
 280
 281         INIT_LIST_HEAD(&res->passes);
 282         res->name       = name;
 283         res->run_idx    = 0;
 284         res->verify_all = verify_all != 0;
 285         res->dump_all   = dump_all   != 0;
 286
 287         return res;
 288 }
 289
 290 /* Terminate an ir_graph pass manager and all owned passes. */
 291 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
 292 {
 293         ir_graph_pass_t *pass, *next;
 294
 295         list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
 296                 if (pass->rem_from_mgr)
 297                         pass->rem_from_mgr(pass->context);
 298                 pass->kind = k_BAD;
 299                 xfree(pass);
 300         }
 301         mgr->kind = k_BAD;
 302         xfree(mgr);
 303 }
 304
 305 /* Terminate an ir_prog pass manager and all owned passes. */
 306 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
 307 {
 308         ir_prog_pass_t *pass, *next;
 309
 310         list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
 311                 if (pass->rem_from_mgr)
 312                         pass->rem_from_mgr(pass->context);
 313                 pass->kind = k_BAD;
 314                 xfree(pass);
 315         }
 316         mgr->kind = k_BAD;
 317         xfree(mgr);
 318 }
 319
 320 /**
 321  * Set the run index for an irgraph pass manager.
 322  *
 323  * @param mgr      the manager
 324  * @param run_idx  the index for the first pass of this manager
 325  */
 326 void ir_graph_pass_manager_set_run_idx(
 327         ir_graph_pass_manager_t *mgr, unsigned run_idx)
 328 {
 329         mgr->run_idx = run_idx;
 330 }
 331
 332 /**
 333  * Set the run index for an irprog pass manager.
 334  *
 335  * @param mgr      the manager
 336  * @param run_idx  the index for the first pass of this manager
 337  */
 338 void ir_prog_pass_manager_set_run_idx(
 339         ir_prog_pass_manager_t *mgr, unsigned run_idx)
 340 {
 341         mgr->run_idx = run_idx;
 342 }
 343
 344 /**
 345  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 346  */
 347 static int void_graph_wrapper(ir_graph *irg, void *context) {
 348         void (*function)(ir_graph *irg) = context;
 349         function(irg);
 350         return 0;
 351 }  /* void_graph_wrapper */
 352
 353 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
 354 ir_graph_pass_t *def_graph_pass(
 355         const char *name, void (*function)(ir_graph *irg))
 356 {
 357         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 358
 359         pass->kind       = k_ir_graph_pass;
 360         pass->run_on_irg = void_graph_wrapper;
 361         pass->context    = function;
 362         pass->name       = name;
 363
 364         INIT_LIST_HEAD(&pass->list);
 365
 366         return pass;
 367 }  /* def_graph_pass */
 368
 369 /**
 370  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 371  */
 372 static int int_graph_wrapper(ir_graph *irg, void *context) {
 373         int (*function)(ir_graph *irg) = context;
 374         return function(irg);
 375 }  /* int_graph_wrapper */
 376
 377 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
 378 ir_graph_pass_t *def_graph_pass_ret(
 379                 const char *name, int (*function)(ir_graph *irg))
 380 {
 381         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 382
 383         pass->kind       = k_ir_graph_pass;
 384         pass->run_on_irg = int_graph_wrapper;
 385         pass->context    = function;
 386         pass->name       = name;
 387
 388         INIT_LIST_HEAD(&pass->list);
 389
 390         return pass;
 391 }  /* def_graph_pass_ret */
 392
 393 /* constructor for a default graph pass */
 394 ir_graph_pass_t *def_graph_pass_constructor(
 395         ir_graph_pass_t *pass,
 396         const char *name, int (*function)(ir_graph *irg, void *context)) {
 397         if (pass == NULL)
 398                 pass = XMALLOCZ(ir_graph_pass_t);
 399         pass->kind       = k_ir_graph_pass;
 400         pass->run_on_irg = function;
 401         pass->context    = pass;
 402         pass->name       = name;
 403
 404         INIT_LIST_HEAD(&pass->list);
 405
 406         return pass;
 407 }  /* def_graph_pass_constructor */
 408
 409
 410 /**
 411  * Wrapper for running void function(void) as an ir_prog pass.
 412  */
 413 static int void_prog_wrapper(ir_prog *irp, void *context) {
 414         void (*function)(void) = context;
 415
 416         (void)irp;
 417         function();
 418         return 0;
 419 }  /* void_graph_wrapper */
 420
 421 /* Creates an ir_prog pass for running void function(void). */
 422 ir_prog_pass_t *def_prog_pass(
 423         const char *name,
 424         void (*function)(void))
 425 {
 426         struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 427
 428         pass->kind          = k_ir_prog_pass;
 429         pass->run_on_irprog = void_prog_wrapper;
 430         pass->context       = function;
 431         pass->name          = name;
 432
 433         INIT_LIST_HEAD(&pass->list);
 434
 435         return pass;
 436 }  /* def_prog_pass */
 437
 438 /* Creates an ir_prog pass for running void function(void). */
 439 ir_prog_pass_t *def_prog_pass_constructor(
 440         ir_prog_pass_t *pass,
 441         const char *name,
 442         void (*function)(ir_prog *irp, void *context))
 443 {
 444         if (pass == NULL)
 445                 pass = XMALLOCZ(ir_prog_pass_t);
 446
 447         pass->kind          = k_ir_prog_pass;
 448         pass->run_on_irprog = function;
 449         pass->context       = pass;
 450         pass->name          = name;
 451
 452         INIT_LIST_HEAD(&pass->list);
 453
 454         return pass;
 455 }  /* def_prog_pass_constructor */