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 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
 160 {
 161         size_t    i;
 162         int       res = 0;
 163         ir_graph *rem = current_ir_graph;
 164
 165         /* on all graphs: beware: number of irgs might be changed */
 166         for (i = 0; i < get_irp_n_irgs(); ++i) {
 167                 ir_graph *irg = current_ir_graph = get_irp_irg(i);
 168                 unsigned idx = mgr->run_idx;
 169                 /* run every pass on every graph */
 170                 list_for_each_entry(ir_graph_pass_t, pass, &mgr->passes, list) {
 171                         int pass_res = pass->run_on_irg(irg, pass->context);
 172                         if (pass_res != 0)
 173                                 res = 1;
 174                         /* verify is necessary */
 175                         if (mgr->verify_all) {
 176                                 if (pass->verify_irg) {
 177                                         pass->verify_irg(irg, pass->context);
 178                                 } else {
 179                                         irg_verify(irg, 0);
 180                                 }
 181                         }
 182                         /* dump */
 183                         if (mgr->dump_all) {
 184                                 if (pass->dump_irg) {
 185                                         pass->dump_irg(irg, pass->context, idx);
 186                                 } else {
 187                                         dump_ir_graph(irg, pass->name);
 188                                 }
 189                         }
 190                         ++idx;
 191                 }
 192         }
 193         current_ir_graph = rem;
 194         return res;
 195 }
 196
 197 /**
 198  * Verify all graphs on the given ir_prog.
 199  */
 200 static int irp_verify_irgs(void)
 201 {
 202         int    res = 1;
 203         size_t i;
 204         size_t n_irgs = get_irp_n_irgs();
 205
 206         for (i = 0; i < n_irgs; ++i)
 207                 res &= irg_verify(get_irp_irg(i), 0);
 208         return res;
 209 }
 210
 211 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
 212 {
 213         int res = 0;
 214
 215         /* run every pass on every graph */
 216         unsigned idx = mgr->run_idx;
 217         list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
 218                 int pass_res = pass->run_on_irprog(irp, pass->context);
 219                 if (pass_res != 0)
 220                         res = 1;
 221                 /* verify is necessary */
 222                 if (mgr->verify_all) {
 223                         if (pass->verify_irprog) {
 224                                 pass->verify_irprog(irp, pass->context);
 225                         } else {
 226                                 irp_verify_irgs();
 227                         }
 228                 }
 229                 /* dump */
 230                 if (mgr->dump_all) {
 231                         if (pass->dump_irprog) {
 232                                 pass->dump_irprog(irp, pass->context, idx);
 233                         } else {
 234                                 dump_all_ir_graphs(pass->name);
 235                         }
 236                 }
 237                 if (pass->is_wrapper) {
 238                         ir_graph_pass_manager_t *graph_mgr = (ir_graph_pass_manager_t*)pass->context;
 239                         idx += graph_mgr->n_passes;
 240                 } else
 241                         ++idx;
 242         }
 243         return res;
 244 }
 245
 246 ir_graph_pass_manager_t *new_graph_pass_mgr(
 247         const char *name, int verify_all, int dump_all)
 248 {
 249         ir_graph_pass_manager_t *res = XMALLOCZ(ir_graph_pass_manager_t);
 250
 251         INIT_LIST_HEAD(&res->passes);
 252         res->kind       = k_ir_graph_pass_mgr;
 253         res->name       = name;
 254         res->run_idx    = 0;
 255         res->verify_all = verify_all != 0;
 256         res->dump_all   = dump_all   != 0;
 257
 258         return res;
 259 }
 260
 261 ir_prog_pass_manager_t *new_prog_pass_mgr(
 262         const char *name, int verify_all, int dump_all)
 263 {
 264         ir_prog_pass_manager_t *res = XMALLOCZ(ir_prog_pass_manager_t);
 265
 266         INIT_LIST_HEAD(&res->passes);
 267         res->kind       = k_ir_prog_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 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
 277 {
 278         list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
 279                 if (pass->rem_from_mgr)
 280                         pass->rem_from_mgr(pass->context);
 281                 pass->kind = k_BAD;
 282                 xfree(pass);
 283         }
 284         mgr->kind = k_BAD;
 285         xfree(mgr);
 286 }
 287
 288 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
 289 {
 290         list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
 291                 if (pass->rem_from_mgr)
 292                         pass->rem_from_mgr(pass->context);
 293                 pass->kind = k_BAD;
 294                 xfree(pass);
 295         }
 296         mgr->kind = k_BAD;
 297         xfree(mgr);
 298 }
 299
 300 void ir_graph_pass_mgr_set_run_idx(
 301         ir_graph_pass_manager_t *mgr, unsigned run_idx)
 302 {
 303         mgr->run_idx = run_idx;
 304 }
 305
 306 void ir_prog_pass_mgr_set_run_idx(
 307         ir_prog_pass_manager_t *mgr, unsigned run_idx)
 308 {
 309         mgr->run_idx = run_idx;
 310 }
 311
 312 /**
 313  * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
 314  */
 315 static int void_graph_wrapper(ir_graph *irg, void *context)
 316 {
 317         void_pass_func_irg function = (void_pass_func_irg)context;
 318         function(irg);
 319         return 0;
 320 }
 321
 322 ir_graph_pass_t *def_graph_pass(
 323         const char *name, void (*function)(ir_graph *irg))
 324 {
 325         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 326
 327         pass->kind       = k_ir_graph_pass;
 328         pass->run_on_irg = void_graph_wrapper;
 329         pass->context    = (void*)function;
 330         pass->name       = name;
 331
 332         INIT_LIST_HEAD(&pass->list);
 333
 334         return pass;
 335 }
 336
 337 /**
 338  * Wrapper for running int function(ir_graph *irg) as an ir_graph pass.
 339  */
 340 static int int_graph_wrapper(ir_graph *irg, void *context)
 341 {
 342         int_pass_func_irg function = (int_pass_func_irg)context;
 343         return function(irg);
 344 }
 345
 346 ir_graph_pass_t *def_graph_pass_ret(
 347                 const char *name, int (*function)(ir_graph *irg))
 348 {
 349         struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
 350
 351         pass->kind       = k_ir_graph_pass;
 352         pass->run_on_irg = int_graph_wrapper;
 353         pass->context    = (void*)function;
 354         pass->name       = name;
 355
 356         INIT_LIST_HEAD(&pass->list);
 357
 358         return pass;
 359 }
 360
 361 ir_graph_pass_t *def_graph_pass_constructor(
 362         ir_graph_pass_t *pass,
 363         const char *name, int (*function)(ir_graph *irg, void *context)) {
 364         if (pass == NULL)
 365                 pass = XMALLOCZ(ir_graph_pass_t);
 366         else
 367                 memset(pass, 0, sizeof(ir_graph_pass_t));
 368         pass->kind       = k_ir_graph_pass;
 369         pass->run_on_irg = function;
 370         pass->context    = pass;
 371         pass->name       = name;
 372
 373         INIT_LIST_HEAD(&pass->list);
 374
 375         return pass;
 376 }
 377
 378 void ir_graph_pass_set_parallel(ir_graph_pass_t *pass, int flag)
 379 {
 380         pass->run_parallel = flag != 0;
 381 }
 382
 383 /**
 384  * Wrapper for running void function(void) as an ir_prog pass.
 385  */
 386 static int void_prog_wrapper(ir_prog *irp, void *context)
 387 {
 388         void_pass_func function = (void_pass_func)context;
 389
 390         (void)irp;
 391         function();
 392         return 0;
 393 }
 394
 395 ir_prog_pass_t *def_prog_pass(
 396         const char *name,
 397         void (*function)(void))
 398 {
 399         struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
 400
 401         pass->kind          = k_ir_prog_pass;
 402         pass->run_on_irprog = void_prog_wrapper;
 403         pass->context       = (void*)function;
 404         pass->name          = name;
 405
 406         INIT_LIST_HEAD(&pass->list);
 407
 408         return pass;
 409 }
 410
 411 ir_prog_pass_t *def_prog_pass_constructor(
 412         ir_prog_pass_t *pass,
 413         const char *name,
 414         int (*function)(ir_prog *irp, void *context))
 415 {
 416         if (pass == NULL)
 417                 pass = XMALLOCZ(ir_prog_pass_t);
 418         else
 419                 memset(pass, 0, sizeof(ir_prog_pass_t));
 420
 421         pass->kind          = k_ir_prog_pass;
 422         pass->run_on_irprog = function;
 423         pass->context       = pass;
 424         pass->name          = name;
 425
 426         INIT_LIST_HEAD(&pass->list);
 427
 428         return pass;
 429 }
 430
 431 typedef struct pass_t {
 432         ir_prog_pass_t pass;
 433         void           *context;
 434         void (*function)(void *context);
 435 } pass_t;
 436
 437 /**
 438  * Wrapper for the call_function pass.
 439  */
 440 static int call_function_wrapper(ir_prog *irp, void *context)
 441 {
 442         pass_t *pass = (pass_t*)context;
 443
 444         (void)irp;
 445         pass->function(pass->context);
 446         return 0;
 447 }
 448
 449 ir_prog_pass_t *call_function_pass(
 450         const char *name, void (*function)(void *context), void *context) {
 451         struct pass_t *pass = XMALLOCZ(struct pass_t);
 452
 453         def_prog_pass_constructor(
 454                 &pass->pass, name ? name : "set_function", call_function_wrapper);
 455
 456         pass->pass.verify_irprog = ir_prog_no_verify;
 457         pass->pass.dump_irprog   = ir_prog_no_dump;
 458         pass->pass.context       = pass;
 459
 460         pass->function = function;
 461         pass->context  = context;
 462
 463         return &pass->pass;
 464 }