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_tail(&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_tail(&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 /* Ensure that no verifier is run an ir_prog pass. */
  68 int ir_prog_no_verify(ir_prog *prog, void *ctx)
  69 {
  70         (void)prog;
  71         (void)ctx;
  72         return 0;
  73 }
  74
  75 /* Ensure that no dumper is run from an ir_prog pass. */
  76 void ir_prog_no_dump(ir_prog *prog, void *ctx, unsigned idx)
  77 {
  78         (void)prog;
  79         (void)ctx;
  80         (void)idx;
  81 }
  82
  83 /**
  84  * Term wrapper for a wrapped ir_graph pass manager.
  85  */
  86 static void term_wrapper(void *context)
  87 {
  88         ir_graph_pass_manager_t *mgr = context;
  89         term_graph_pass_mgr(mgr);
  90 }
  91
  92 /**
  93  * Create a wrapper ir_prog pass for an ir_graph manager.
  94  */
  95 static ir_prog_pass_t *create_wrapper_pass(ir_graph_pass_manager_t *graph_mgr)
  96 {
  97         /* create a wrapper pass */
  98         ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
  99
 100         pass->run_on_irprog = run_wrapper;
 101         pass->context       = graph_mgr;
 102         pass->name          = graph_mgr->name;
 103
 104         /* do not verify nor dump: this is handled by the graph manager */
 105         pass->verify_irprog = ir_prog_no_verify;
 106         pass->dump_irprog   = ir_prog_no_dump;
 107         pass->is_wrapper    = 1;
 108
 109         pass->add_to_mgr   = NULL;
 110         pass->rem_from_mgr = term_wrapper;
 111
 112         return pass;
 113 }
 114
 115 /* Add an ir_graph_pass as a pass to an ir_prog pass manager. */
 116 void ir_prog_pass_mgr_add_graph_pass(
 117         ir_prog_pass_manager_t *mgr, ir_graph_pass_t *pass)
 118 {
 119         ir_graph_pass_manager_t *graph_mgr;
 120         ir_prog_pass_t          *wrapper;
 121
 122         /* check if the last pass is a graph_pass wrapper */
 123         if (! list_empty(&mgr->passes)) {
 124                 wrapper = list_entry(mgr->passes.prev, ir_prog_pass_t, list);
 125                 if (wrapper->is_wrapper) {
 126                         graph_mgr = wrapper->context;
 127
 128                         ir_graph_pass_mgr_add(graph_mgr, pass);
 129                         ++mgr->n_passes;
 130                         return;
 131                 }
 132         }
 133
 134         /* not found, create a new wrapper */
 135         graph_mgr = new_graph_pass_mgr(
 136                 "graph_pass_wrapper", mgr->verify_all, mgr->dump_all);
 137         graph_mgr->run_idx = mgr->n_passes;
 138
 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 = XMALLOCZ(ir_graph_pass_manager_t);
 265
 266         INIT_LIST_HEAD(&res->passes);
 267         res->kind       = k_ir_graph_pass_mgr;
 268         res->name       = name;
 269         res->run_idx    = 0;
 270         res->verify_all = verify_all != 0;
 271         res->dump_all   = dump_all   != 0;
 272
 273         return res;
 274 }
 275
 276 /* Creates a new ir_prog pass manager. */
 277 ir_prog_pass_manager_t *new_prog_pass_mgr(
 278         const char *name, int verify_all, int dump_all)
 279 {
 280         ir_prog_pass_manager_t *res = XMALLOCZ(ir_prog_pass_manager_t);
 281
 282         INIT_LIST_HEAD(&res->passes);
 283         res->kind       = k_ir_prog_pass_mgr;
 284         res->name       = name;
 285         res->run_idx    = 0;
 286         res->verify_all = verify_all != 0;
 287         res->dump_all   = dump_all   != 0;
 288
 289         return res;
 290 }
 291
 292 /* Terminate an ir_graph pass manager and all owned passes. */
 293 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
 294 {
 295         ir_graph_pass_t *pass, *next;
 296
 297         list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
 298                 if (pass->rem_from_mgr)
 299                         pass->rem_from_mgr(pass->context);
 300                 pass->kind = k_BAD;
 301                 xfree(pass);
 302         }
 303         mgr->kind = k_BAD;
 304         xfree(mgr);
 305 }
 306
 307 /* Terminate an ir_prog pass manager and all owned passes. */
 308 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
 309 {
 310         ir_prog_pass_t *pass, *next;
 311
 312         list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
 313                 if (pass->rem_from_mgr)
 314                         pass->rem_from_mgr(pass->context);
 315                 pass->kind = k_BAD;
 316                 xfree(pass);
 317         }
 318         mgr->kind = k_BAD;
 319         xfree(mgr);
 320 }
 321
 322 /**
 323  * Set the run index for an irgraph pass manager.
 324  *
 325  * @param mgr      the manager
 326  * @param run_idx  the index for the first pass of this manager
 327  */
 328 void ir_graph_pass_mgr_set_run_idx(
 329         ir_graph_pass_manager_t *mgr, unsigned run_idx)
 330 {
 331         mgr->run_idx = run_idx;
 332 }
 333
 334 /**
 335  * Set the run index for an irprog pass manager.
 336  *
 337  * @param mgr      the manager
 338  * @param run_idx  the index for the first pass of this manager
 339  */
 340 void ir_prog_pass_manager_set_run_idx(
 341         ir_prog_pass_manager_t *mgr, unsigned run_idx)
 342 {
 343         mgr->run_idx = run_idx;
 344 }
 345
 346 /**
 347  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 348  */
 349 static int void_graph_wrapper(ir_graph *irg, void *context) {
 350         void (*function)(ir_graph *irg) = context;
 351         function(irg);
 352         return 0;
 353 }  /* void_graph_wrapper */
 354
 355 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
 356 ir_graph_pass_t *def_graph_pass(
 357         const char *name, void (*function)(ir_graph *irg))
 358 {
 359         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 360
 361         pass->kind       = k_ir_graph_pass;
 362         pass->run_on_irg = void_graph_wrapper;
 363         pass->context    = function;
 364         pass->name       = name;
 365
 366         INIT_LIST_HEAD(&pass->list);
 367
 368         return pass;
 369 }  /* def_graph_pass */
 370
 371 /**
 372  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 373  */
 374 static int int_graph_wrapper(ir_graph *irg, void *context) {
 375         int (*function)(ir_graph *irg) = context;
 376         return function(irg);
 377 }  /* int_graph_wrapper */
 378
 379 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
 380 ir_graph_pass_t *def_graph_pass_ret(
 381                 const char *name, int (*function)(ir_graph *irg))
 382 {
 383         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 384
 385         pass->kind       = k_ir_graph_pass;
 386         pass->run_on_irg = int_graph_wrapper;
 387         pass->context    = function;
 388         pass->name       = name;
 389
 390         INIT_LIST_HEAD(&pass->list);
 391
 392         return pass;
 393 }  /* def_graph_pass_ret */
 394
 395 /* constructor for a default graph pass */
 396 ir_graph_pass_t *def_graph_pass_constructor(
 397         ir_graph_pass_t *pass,
 398         const char *name, int (*function)(ir_graph *irg, void *context)) {
 399         if (pass == NULL)
 400                 pass = XMALLOCZ(ir_graph_pass_t);
 401         else
 402                 memset(pass, 0, sizeof(ir_graph_pass_t));
 403         pass->kind       = k_ir_graph_pass;
 404         pass->run_on_irg = function;
 405         pass->context    = pass;
 406         pass->name       = name;
 407
 408         INIT_LIST_HEAD(&pass->list);
 409
 410         return pass;
 411 }  /* def_graph_pass_constructor */
 412
 413
 414 /**
 415  * Wrapper for running void function(void) as an ir_prog pass.
 416  */
 417 static int void_prog_wrapper(ir_prog *irp, void *context) {
 418         void (*function)(void) = context;
 419
 420         (void)irp;
 421         function();
 422         return 0;
 423 }  /* void_graph_wrapper */
 424
 425 /* Creates an ir_prog pass for running void function(void). */
 426 ir_prog_pass_t *def_prog_pass(
 427         const char *name,
 428         void (*function)(void))
 429 {
 430         struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 431
 432         pass->kind          = k_ir_prog_pass;
 433         pass->run_on_irprog = void_prog_wrapper;
 434         pass->context       = function;
 435         pass->name          = name;
 436
 437         INIT_LIST_HEAD(&pass->list);
 438
 439         return pass;
 440 }  /* def_prog_pass */
 441
 442 /* Creates an ir_prog pass for running void function(void). */
 443 ir_prog_pass_t *def_prog_pass_constructor(
 444         ir_prog_pass_t *pass,
 445         const char *name,
 446         int (*function)(ir_prog *irp, void *context))
 447 {
 448         if (pass == NULL)
 449                 pass = XMALLOCZ(ir_prog_pass_t);
 450         else
 451                 memset(pass, 0, sizeof(ir_prog_pass_t));
 452
 453         pass->kind          = k_ir_prog_pass;
 454         pass->run_on_irprog = function;
 455         pass->context       = pass;
 456         pass->name          = name;
 457
 458         INIT_LIST_HEAD(&pass->list);
 459
 460         return pass;
 461 }  /* def_prog_pass_constructor */
 462
 463 struct pass_t {
 464         ir_prog_pass_t pass;
 465         void           *context;
 466         void (*function)(void *context);
 467 };
 468
 469 /**
 470  * Wrapper for the call_function pass.
 471  */
 472 static int call_function_wrapper(ir_prog *irp, void *context) {
 473         struct pass_t *pass = context;
 474
 475         (void)irp;
 476         pass->function(pass->context);
 477         return 0;
 478 }  /* call_function_wrapper */
 479
 480 ir_prog_pass_t *call_function_pass(
 481         const char *name, void (*function)(void *context), void *context) {
 482         struct pass_t *pass = XMALLOCZ(struct pass_t);
 483
 484         def_prog_pass_constructor(
 485                 &pass->pass, name ? name : "set_function", call_function_wrapper);
 486
 487         pass->pass.verify_irprog = ir_prog_no_verify;
 488         pass->pass.dump_irprog   = ir_prog_no_dump;
 489         pass->pass.context       = pass;
 490
 491         pass->function = function;
 492         pass->context  = context;
 493
 494         return &pass->pass;
 495 }  /* call_function_pass */