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 "irverify.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->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 static void create_suffix(char *suffix, size_t n, const char *pass_name)
 161 {
 162         snprintf(suffix, n, "%s.svg", pass_name);
 163 }
 164
 165 /* Run all passes of an ir_graph pass manager. */
 166 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
 167 {
 168         ir_graph_pass_t *pass;
 169         int             i, res = 0;
 170         ir_graph        *rem = current_ir_graph;
 171
 172         /* on all graphs: beware: number of irgs might be changed */
 173         for (i = 0; i < get_irp_n_irgs(); ++i) {
 174                 ir_graph *irg = current_ir_graph = get_irp_irg(i);
 175                 unsigned idx = mgr->run_idx;
 176                 /* run every pass on every graph */
 177                 list_for_each_entry(ir_graph_pass_t, pass, &mgr->passes, list) {
 178                         int pass_res = pass->run_on_irg(irg, pass->context);
 179                         if (pass_res != 0)
 180                                 res = 1;
 181                         /* verify is necessary */
 182                         if (mgr->verify_all) {
 183                                 if (pass->verify_irg) {
 184                                         pass->verify_irg(irg, pass->context);
 185                                 } else {
 186                                         irg_verify(irg, 0);
 187                                 }
 188                         }
 189                         /* dump */
 190                         if (mgr->dump_all) {
 191                                 if (pass->dump_irg) {
 192                                         pass->dump_irg(irg, pass->context, idx);
 193                                 } else {
 194                                         char buf[1024];
 195                                         create_suffix(buf, sizeof(buf), pass->name);
 196                                         dump_ir_graph(irg, buf);
 197                                 }
 198                         }
 199                         ++idx;
 200                 }
 201         }
 202         current_ir_graph = rem;
 203         return res;
 204 }
 205
 206 /**
 207  * Verify all graphs on the given ir_prog.
 208  */
 209 static int irp_verify_irgs(void)
 210 {
 211         int i, res = 1;
 212
 213         for (i = get_irp_n_irgs() - 1; i >= 0; --i)
 214                 res &= irg_verify(get_irp_irg(i), 0);
 215         return res;
 216 }
 217
 218 /* Run all passes of an ir_prog pass manager. */
 219 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
 220 {
 221         ir_prog_pass_t *pass;
 222         int            res = 0;
 223
 224         /* run every pass on every graph */
 225         unsigned idx = mgr->run_idx;
 226         list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
 227                 int pass_res = pass->run_on_irprog(irp, pass->context);
 228                 if (pass_res != 0)
 229                         res = 1;
 230                 /* verify is necessary */
 231                 if (mgr->verify_all) {
 232                         if (pass->verify_irprog) {
 233                                 pass->verify_irprog(irp, pass->context);
 234                         } else {
 235                                 irp_verify_irgs();
 236                         }
 237                 }
 238                 /* dump */
 239                 if (mgr->dump_all) {
 240                         if (pass->dump_irprog) {
 241                                 pass->dump_irprog(irp, pass->context, idx);
 242                         } else {
 243                                 char buf[1024];
 244                                 create_suffix(buf, sizeof(buf), pass->name);
 245                                 dump_all_ir_graphs(buf);
 246                         }
 247                 }
 248                 if (pass->is_wrapper) {
 249                         ir_graph_pass_manager_t *graph_mgr = pass->context;
 250                         idx += graph_mgr->n_passes;
 251                 } else
 252                         ++idx;
 253         }
 254         return res;
 255 }
 256
 257 /* Creates a new ir_graph pass manager. */
 258 ir_graph_pass_manager_t *new_graph_pass_mgr(
 259         const char *name, int verify_all, int dump_all)
 260 {
 261         ir_graph_pass_manager_t *res = XMALLOCZ(ir_graph_pass_manager_t);
 262
 263         INIT_LIST_HEAD(&res->passes);
 264         res->kind       = k_ir_graph_pass_mgr;
 265         res->name       = name;
 266         res->run_idx    = 0;
 267         res->verify_all = verify_all != 0;
 268         res->dump_all   = dump_all   != 0;
 269
 270         return res;
 271 }
 272
 273 /* Creates a new ir_prog pass manager. */
 274 ir_prog_pass_manager_t *new_prog_pass_mgr(
 275         const char *name, int verify_all, int dump_all)
 276 {
 277         ir_prog_pass_manager_t *res = XMALLOCZ(ir_prog_pass_manager_t);
 278
 279         INIT_LIST_HEAD(&res->passes);
 280         res->kind       = k_ir_prog_pass_mgr;
 281         res->name       = name;
 282         res->run_idx    = 0;
 283         res->verify_all = verify_all != 0;
 284         res->dump_all   = dump_all   != 0;
 285
 286         return res;
 287 }
 288
 289 /* Terminate an ir_graph pass manager and all owned passes. */
 290 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
 291 {
 292         ir_graph_pass_t *pass, *next;
 293
 294         list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
 295                 if (pass->rem_from_mgr)
 296                         pass->rem_from_mgr(pass->context);
 297                 pass->kind = k_BAD;
 298                 xfree(pass);
 299         }
 300         mgr->kind = k_BAD;
 301         xfree(mgr);
 302 }
 303
 304 /* Terminate an ir_prog pass manager and all owned passes. */
 305 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
 306 {
 307         ir_prog_pass_t *pass, *next;
 308
 309         list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
 310                 if (pass->rem_from_mgr)
 311                         pass->rem_from_mgr(pass->context);
 312                 pass->kind = k_BAD;
 313                 xfree(pass);
 314         }
 315         mgr->kind = k_BAD;
 316         xfree(mgr);
 317 }
 318
 319 /**
 320  * Set the run index for an irgraph pass manager.
 321  *
 322  * @param mgr      the manager
 323  * @param run_idx  the index for the first pass of this manager
 324  */
 325 void ir_graph_pass_mgr_set_run_idx(
 326         ir_graph_pass_manager_t *mgr, unsigned run_idx)
 327 {
 328         mgr->run_idx = run_idx;
 329 }
 330
 331 /**
 332  * Set the run index for an irprog pass manager.
 333  *
 334  * @param mgr      the manager
 335  * @param run_idx  the index for the first pass of this manager
 336  */
 337 void ir_prog_pass_mgr_set_run_idx(
 338         ir_prog_pass_manager_t *mgr, unsigned run_idx)
 339 {
 340         mgr->run_idx = run_idx;
 341 }
 342
 343 /**
 344  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 345  */
 346 static int void_graph_wrapper(ir_graph *irg, void *context)
 347 {
 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 {
 374         int (*function)(ir_graph *irg) = context;
 375         return function(irg);
 376 }  /* int_graph_wrapper */
 377
 378 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
 379 ir_graph_pass_t *def_graph_pass_ret(
 380                 const char *name, int (*function)(ir_graph *irg))
 381 {
 382         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 383
 384         pass->kind       = k_ir_graph_pass;
 385         pass->run_on_irg = int_graph_wrapper;
 386         pass->context    = function;
 387         pass->name       = name;
 388
 389         INIT_LIST_HEAD(&pass->list);
 390
 391         return pass;
 392 }  /* def_graph_pass_ret */
 393
 394 /* constructor for a default graph pass */
 395 ir_graph_pass_t *def_graph_pass_constructor(
 396         ir_graph_pass_t *pass,
 397         const char *name, int (*function)(ir_graph *irg, void *context)) {
 398         if (pass == NULL)
 399                 pass = XMALLOCZ(ir_graph_pass_t);
 400         else
 401                 memset(pass, 0, sizeof(ir_graph_pass_t));
 402         pass->kind       = k_ir_graph_pass;
 403         pass->run_on_irg = function;
 404         pass->context    = pass;
 405         pass->name       = name;
 406
 407         INIT_LIST_HEAD(&pass->list);
 408
 409         return pass;
 410 }  /* def_graph_pass_constructor */
 411
 412 /* set the run parallel property */
 413 void ir_graph_pass_set_parallel(ir_graph_pass_t *pass, int flag)
 414 {
 415         pass->run_parallel = flag != 0;
 416 }  /* ir_graph_pass_set_parallel */
 417
 418 /**
 419  * Wrapper for running void function(void) as an ir_prog pass.
 420  */
 421 static int void_prog_wrapper(ir_prog *irp, void *context)
 422 {
 423         void (*function)(void) = context;
 424
 425         (void)irp;
 426         function();
 427         return 0;
 428 }  /* void_graph_wrapper */
 429
 430 /* Creates an ir_prog pass for running void function(void). */
 431 ir_prog_pass_t *def_prog_pass(
 432         const char *name,
 433         void (*function)(void))
 434 {
 435         struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 436
 437         pass->kind          = k_ir_prog_pass;
 438         pass->run_on_irprog = void_prog_wrapper;
 439         pass->context       = function;
 440         pass->name          = name;
 441
 442         INIT_LIST_HEAD(&pass->list);
 443
 444         return pass;
 445 }  /* def_prog_pass */
 446
 447 /* Creates an ir_prog pass for running void function(void). */
 448 ir_prog_pass_t *def_prog_pass_constructor(
 449         ir_prog_pass_t *pass,
 450         const char *name,
 451         int (*function)(ir_prog *irp, void *context))
 452 {
 453         if (pass == NULL)
 454                 pass = XMALLOCZ(ir_prog_pass_t);
 455         else
 456                 memset(pass, 0, sizeof(ir_prog_pass_t));
 457
 458         pass->kind          = k_ir_prog_pass;
 459         pass->run_on_irprog = function;
 460         pass->context       = pass;
 461         pass->name          = name;
 462
 463         INIT_LIST_HEAD(&pass->list);
 464
 465         return pass;
 466 }  /* def_prog_pass_constructor */
 467
 468 struct pass_t {
 469         ir_prog_pass_t pass;
 470         void           *context;
 471         void (*function)(void *context);
 472 };
 473
 474 /**
 475  * Wrapper for the call_function pass.
 476  */
 477 static int call_function_wrapper(ir_prog *irp, void *context)
 478 {
 479         struct pass_t *pass = context;
 480
 481         (void)irp;
 482         pass->function(pass->context);
 483         return 0;
 484 }  /* call_function_wrapper */
 485
 486 ir_prog_pass_t *call_function_pass(
 487         const char *name, void (*function)(void *context), void *context) {
 488         struct pass_t *pass = XMALLOCZ(struct pass_t);
 489
 490         def_prog_pass_constructor(
 491                 &pass->pass, name ? name : "set_function", call_function_wrapper);
 492
 493         pass->pass.verify_irprog = ir_prog_no_verify;
 494         pass->pass.dump_irprog   = ir_prog_no_dump;
 495         pass->pass.context       = pass;
 496
 497         pass->function = function;
 498         pass->context  = context;
 499
 500         return &pass->pass;
 501 }  /* call_function_pass */