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

   1 /*
   2  * Copyright (C) 1995-2010 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  */
  25 #include "config.h"
  26
  27 #include <string.h>
  28 #include "adt/list.h"
  29 #include "irpass_t.h"
  30 #include "irgraph_t.h"
  31 #include "irprog_t.h"
  32 #include "irdump.h"
  33 #include "irverify.h"
  34 #include "ircons.h"
  35 #include "xmalloc.h"
  36
  37 typedef void (*void_pass_func_irg)(ir_graph *irg);
  38 typedef int (*int_pass_func_irg)(ir_graph *irg);
  39 typedef void (*void_pass_func)(void);
  40
  41 void ir_graph_pass_mgr_add(ir_graph_pass_manager_t *mgr, ir_graph_pass_t *pass)
  42 {
  43         list_add_tail(&pass->list, &mgr->passes);
  44         ++mgr->n_passes;
  45         if (pass->add_to_mgr)
  46                 pass->add_to_mgr(pass->context);
  47 }
  48
  49 void ir_prog_pass_mgr_add(ir_prog_pass_manager_t *mgr, ir_prog_pass_t *pass)
  50 {
  51         list_add_tail(&pass->list, &mgr->passes);
  52         ++mgr->n_passes;
  53         if (pass->add_to_mgr)
  54                 pass->add_to_mgr(pass->context);
  55 }
  56
  57 /**
  58  * wrapper for running a graph pass manager as a pass on an irprog
  59  * pass manager.
  60  */
  61 static int run_wrapper(ir_prog *prog, void *ctx)
  62 {
  63         ir_graph_pass_manager_t *mgr = (ir_graph_pass_manager_t*)ctx;
  64
  65         (void)prog;
  66         return ir_graph_pass_mgr_run(mgr);
  67 }
  68
  69 int ir_prog_no_verify(ir_prog *prog, void *ctx)
  70 {
  71         (void)prog;
  72         (void)ctx;
  73         return 0;
  74 }
  75
  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 = (ir_graph_pass_manager_t*)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->kind          = k_ir_prog_pass;
 101         pass->run_on_irprog = run_wrapper;
 102         pass->context       = graph_mgr;
 103         pass->name          = graph_mgr->name;
 104
 105         /* do not verify nor dump: this is handled by the graph manager */
 106         pass->verify_irprog = ir_prog_no_verify;
 107         pass->dump_irprog   = ir_prog_no_dump;
 108         pass->is_wrapper    = 1;
 109
 110         pass->add_to_mgr   = NULL;
 111         pass->rem_from_mgr = term_wrapper;
 112
 113         return pass;
 114 }
 115
 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 = (ir_graph_pass_manager_t*)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 void ir_prog_pass_mgr_add_graph_mgr(
 146         ir_prog_pass_manager_t *mgr, ir_graph_pass_manager_t *graph_mgr)
 147 {
 148         ir_prog_pass_t *pass = create_wrapper_pass(graph_mgr);
 149
 150         if (mgr->dump_all)
 151                 graph_mgr->dump_all = 1;
 152         if (mgr->verify_all)
 153                 graph_mgr->verify_all = 1;
 154         graph_mgr->run_idx = mgr->n_passes;
 155
 156         ir_prog_pass_mgr_add(mgr, pass);
 157 }
 158
 159 static void create_suffix(char *suffix, size_t n, const char *pass_name)
 160 {
 161         snprintf(suffix, n, "%s.svg", pass_name);
 162 }
 163
 164 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
 165 {
 166         size_t    i;
 167         int       res = 0;
 168         ir_graph *rem = current_ir_graph;
 169
 170         /* on all graphs: beware: number of irgs might be changed */
 171         for (i = 0; i < get_irp_n_irgs(); ++i) {
 172                 ir_graph *irg = current_ir_graph = get_irp_irg(i);
 173                 unsigned idx = mgr->run_idx;
 174                 /* run every pass on every graph */
 175                 list_for_each_entry(ir_graph_pass_t, pass, &mgr->passes, list) {
 176                         int pass_res = pass->run_on_irg(irg, pass->context);
 177                         if (pass_res != 0)
 178                                 res = 1;
 179                         /* verify is necessary */
 180                         if (mgr->verify_all) {
 181                                 if (pass->verify_irg) {
 182                                         pass->verify_irg(irg, pass->context);
 183                                 } else {
 184                                         irg_verify(irg, 0);
 185                                 }
 186                         }
 187                         /* dump */
 188                         if (mgr->dump_all) {
 189                                 if (pass->dump_irg) {
 190                                         pass->dump_irg(irg, pass->context, idx);
 191                                 } else {
 192                                         char buf[1024];
 193                                         create_suffix(buf, sizeof(buf), pass->name);
 194                                         dump_ir_graph(irg, buf);
 195                                 }
 196                         }
 197                         ++idx;
 198                 }
 199         }
 200         current_ir_graph = rem;
 201         return res;
 202 }
 203
 204 /**
 205  * Verify all graphs on the given ir_prog.
 206  */
 207 static int irp_verify_irgs(void)
 208 {
 209         int    res = 1;
 210         size_t i;
 211         size_t n_irgs = get_irp_n_irgs();
 212
 213         for (i = 0; i < n_irgs; ++i)
 214                 res &= irg_verify(get_irp_irg(i), 0);
 215         return res;
 216 }
 217
 218 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
 219 {
 220         int res = 0;
 221
 222         /* run every pass on every graph */
 223         unsigned idx = mgr->run_idx;
 224         list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
 225                 int pass_res = pass->run_on_irprog(irp, pass->context);
 226                 if (pass_res != 0)
 227                         res = 1;
 228                 /* verify is necessary */
 229                 if (mgr->verify_all) {
 230                         if (pass->verify_irprog) {
 231                                 pass->verify_irprog(irp, pass->context);
 232                         } else {
 233                                 irp_verify_irgs();
 234                         }
 235                 }
 236                 /* dump */
 237                 if (mgr->dump_all) {
 238                         if (pass->dump_irprog) {
 239                                 pass->dump_irprog(irp, pass->context, idx);
 240                         } else {
 241                                 char buf[1024];
 242                                 create_suffix(buf, sizeof(buf), pass->name);
 243                                 dump_all_ir_graphs(buf);
 244                         }
 245                 }
 246                 if (pass->is_wrapper) {
 247                         ir_graph_pass_manager_t *graph_mgr = (ir_graph_pass_manager_t*)pass->context;
 248                         idx += graph_mgr->n_passes;
 249                 } else
 250                         ++idx;
 251         }
 252         return res;
 253 }
 254
 255 ir_graph_pass_manager_t *new_graph_pass_mgr(
 256         const char *name, int verify_all, int dump_all)
 257 {
 258         ir_graph_pass_manager_t *res = XMALLOCZ(ir_graph_pass_manager_t);
 259
 260         INIT_LIST_HEAD(&res->passes);
 261         res->kind       = k_ir_graph_pass_mgr;
 262         res->name       = name;
 263         res->run_idx    = 0;
 264         res->verify_all = verify_all != 0;
 265         res->dump_all   = dump_all   != 0;
 266
 267         return res;
 268 }
 269
 270 ir_prog_pass_manager_t *new_prog_pass_mgr(
 271         const char *name, int verify_all, int dump_all)
 272 {
 273         ir_prog_pass_manager_t *res = XMALLOCZ(ir_prog_pass_manager_t);
 274
 275         INIT_LIST_HEAD(&res->passes);
 276         res->kind       = k_ir_prog_pass_mgr;
 277         res->name       = name;
 278         res->run_idx    = 0;
 279         res->verify_all = verify_all != 0;
 280         res->dump_all   = dump_all   != 0;
 281
 282         return res;
 283 }
 284
 285 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
 286 {
 287         list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
 288                 if (pass->rem_from_mgr)
 289                         pass->rem_from_mgr(pass->context);
 290                 pass->kind = k_BAD;
 291                 xfree(pass);
 292         }
 293         mgr->kind = k_BAD;
 294         xfree(mgr);
 295 }
 296
 297 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
 298 {
 299         list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
 300                 if (pass->rem_from_mgr)
 301                         pass->rem_from_mgr(pass->context);
 302                 pass->kind = k_BAD;
 303                 xfree(pass);
 304         }
 305         mgr->kind = k_BAD;
 306         xfree(mgr);
 307 }
 308
 309 void ir_graph_pass_mgr_set_run_idx(
 310         ir_graph_pass_manager_t *mgr, unsigned run_idx)
 311 {
 312         mgr->run_idx = run_idx;
 313 }
 314
 315 void ir_prog_pass_mgr_set_run_idx(
 316         ir_prog_pass_manager_t *mgr, unsigned run_idx)
 317 {
 318         mgr->run_idx = run_idx;
 319 }
 320
 321 /**
 322  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 323  */
 324 static int void_graph_wrapper(ir_graph *irg, void *context)
 325 {
 326         void_pass_func_irg function = (void_pass_func_irg)context;
 327         function(irg);
 328         return 0;
 329 }
 330
 331 ir_graph_pass_t *def_graph_pass(
 332         const char *name, void (*function)(ir_graph *irg))
 333 {
 334         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 335
 336         pass->kind       = k_ir_graph_pass;
 337         pass->run_on_irg = void_graph_wrapper;
 338         pass->context    = (void*)function;
 339         pass->name       = name;
 340
 341         INIT_LIST_HEAD(&pass->list);
 342
 343         return pass;
 344 }
 345
 346 /**
 347  * Wrapper for running int function(ir_graph *irg) as an ir_graph pass.
 348  */
 349 static int int_graph_wrapper(ir_graph *irg, void *context)
 350 {
 351         int_pass_func_irg function = (int_pass_func_irg)context;
 352         return function(irg);
 353 }
 354
 355 ir_graph_pass_t *def_graph_pass_ret(
 356                 const char *name, int (*function)(ir_graph *irg))
 357 {
 358         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 359
 360         pass->kind       = k_ir_graph_pass;
 361         pass->run_on_irg = int_graph_wrapper;
 362         pass->context    = (void*)function;
 363         pass->name       = name;
 364
 365         INIT_LIST_HEAD(&pass->list);
 366
 367         return pass;
 368 }
 369
 370 ir_graph_pass_t *def_graph_pass_constructor(
 371         ir_graph_pass_t *pass,
 372         const char *name, int (*function)(ir_graph *irg, void *context)) {
 373         if (pass == NULL)
 374                 pass = XMALLOCZ(ir_graph_pass_t);
 375         else
 376                 memset(pass, 0, sizeof(ir_graph_pass_t));
 377         pass->kind       = k_ir_graph_pass;
 378         pass->run_on_irg = function;
 379         pass->context    = pass;
 380         pass->name       = name;
 381
 382         INIT_LIST_HEAD(&pass->list);
 383
 384         return pass;
 385 }
 386
 387 void ir_graph_pass_set_parallel(ir_graph_pass_t *pass, int flag)
 388 {
 389         pass->run_parallel = flag != 0;
 390 }
 391
 392 /**
 393  * Wrapper for running void function(void) as an ir_prog pass.
 394  */
 395 static int void_prog_wrapper(ir_prog *irp, void *context)
 396 {
 397         void_pass_func function = (void_pass_func)context;
 398
 399         (void)irp;
 400         function();
 401         return 0;
 402 }
 403
 404 ir_prog_pass_t *def_prog_pass(
 405         const char *name,
 406         void (*function)(void))
 407 {
 408         struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 409
 410         pass->kind          = k_ir_prog_pass;
 411         pass->run_on_irprog = void_prog_wrapper;
 412         pass->context       = (void*)function;
 413         pass->name          = name;
 414
 415         INIT_LIST_HEAD(&pass->list);
 416
 417         return pass;
 418 }
 419
 420 ir_prog_pass_t *def_prog_pass_constructor(
 421         ir_prog_pass_t *pass,
 422         const char *name,
 423         int (*function)(ir_prog *irp, void *context))
 424 {
 425         if (pass == NULL)
 426                 pass = XMALLOCZ(ir_prog_pass_t);
 427         else
 428                 memset(pass, 0, sizeof(ir_prog_pass_t));
 429
 430         pass->kind          = k_ir_prog_pass;
 431         pass->run_on_irprog = function;
 432         pass->context       = pass;
 433         pass->name          = name;
 434
 435         INIT_LIST_HEAD(&pass->list);
 436
 437         return pass;
 438 }
 439
 440 typedef struct pass_t {
 441         ir_prog_pass_t pass;
 442         void           *context;
 443         void (*function)(void *context);
 444 } pass_t;
 445
 446 /**
 447  * Wrapper for the call_function pass.
 448  */
 449 static int call_function_wrapper(ir_prog *irp, void *context)
 450 {
 451         pass_t *pass = (pass_t*)context;
 452
 453         (void)irp;
 454         pass->function(pass->context);
 455         return 0;
 456 }
 457
 458 ir_prog_pass_t *call_function_pass(
 459         const char *name, void (*function)(void *context), void *context) {
 460         struct pass_t *pass = XMALLOCZ(struct pass_t);
 461
 462         def_prog_pass_constructor(
 463                 &pass->pass, name ? name : "set_function", call_function_wrapper);
 464
 465         pass->pass.verify_irprog = ir_prog_no_verify;
 466         pass->pass.dump_irprog   = ir_prog_no_dump;
 467         pass->pass.context       = pass;
 468
 469         pass->function = function;
 470         pass->context  = context;
 471
 472         return &pass->pass;
 473 }