2 * Copyright (C) 1995-2009 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Manager for optimization passes.
23 * @author Michael Beck
31 #include "irgraph_t.h"
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)
40 list_add_tail(&pass->list, &mgr->passes);
43 pass->add_to_mgr(pass->context);
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)
49 list_add_tail(&pass->list, &mgr->passes);
52 pass->add_to_mgr(pass->context);
56 * wrapper for running a graph pass manager as a pass on an irprog
59 static int run_wrapper(ir_prog *prog, void *ctx)
61 ir_graph_pass_manager_t *mgr = ctx;
64 return ir_graph_pass_mgr_run(mgr);
67 /* Ensure that no verifier is run an ir_prog pass. */
68 int ir_prog_no_verify(ir_prog *prog, void *ctx)
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)
84 * Term wrapper for a wrapped ir_graph pass manager.
86 static void term_wrapper(void *context)
88 ir_graph_pass_manager_t *mgr = context;
89 term_graph_pass_mgr(mgr);
93 * Create a wrapper ir_prog pass for an ir_graph manager.
95 static ir_prog_pass_t *create_wrapper_pass(ir_graph_pass_manager_t *graph_mgr)
97 /* create a wrapper pass */
98 ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
100 pass->run_on_irprog = run_wrapper;
101 pass->context = graph_mgr;
102 pass->name = graph_mgr->name;
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;
109 pass->add_to_mgr = NULL;
110 pass->rem_from_mgr = term_wrapper;
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)
119 ir_graph_pass_manager_t *graph_mgr;
120 ir_prog_pass_t *wrapper;
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;
128 ir_graph_pass_mgr_add(graph_mgr, pass);
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;
139 ir_graph_pass_mgr_add(graph_mgr, pass);
141 wrapper = create_wrapper_pass(graph_mgr);
142 ir_prog_pass_mgr_add(mgr, wrapper);
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)
149 ir_prog_pass_t *pass = create_wrapper_pass(graph_mgr);
152 graph_mgr->dump_all = 1;
154 graph_mgr->verify_all = 1;
155 graph_mgr->run_idx = mgr->n_passes;
157 ir_prog_pass_mgr_add(mgr, pass);
161 * Create a suffix for dumping.
163 static void create_suffix(char *suffix, size_t n, const char *pass_name,
166 snprintf(suffix, n, "-%02u_%s", index, pass_name);
169 /* Run all passes of an ir_graph pass manager. */
170 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
172 ir_graph_pass_t *pass;
174 ir_graph *rem = current_ir_graph;
176 /* on all graphs: beware: number of irgs might be changed */
177 for (i = 0; i < get_irp_n_irgs(); ++i) {
178 ir_graph *irg = current_ir_graph = get_irp_irg(i);
179 unsigned idx = mgr->run_idx;
180 /* run every pass on every graph */
181 list_for_each_entry(ir_graph_pass_t, pass, &mgr->passes, list) {
182 int pass_res = pass->run_on_irg(irg, pass->context);
185 /* verify is necessary */
186 if (mgr->verify_all) {
187 if (pass->verify_irg) {
188 pass->verify_irg(irg, pass->context);
195 if (pass->dump_irg) {
196 pass->dump_irg(irg, pass->context, idx);
199 create_suffix(suffix, sizeof(suffix), pass->name, idx);
200 dump_ir_block_graph(irg, suffix);
206 current_ir_graph = rem;
211 * Verify all graphs on the given ir_prog.
213 static int irp_verify_irgs(void)
217 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
218 res &= irg_verify(get_irp_irg(i), 0);
222 /* Run all passes of an ir_prog pass manager. */
223 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
225 ir_prog_pass_t *pass;
228 /* run every pass on every graph */
229 unsigned idx = mgr->run_idx;
230 list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
231 int pass_res = pass->run_on_irprog(irp, pass->context);
234 /* verify is necessary */
235 if (mgr->verify_all) {
236 if (pass->verify_irprog) {
237 pass->verify_irprog(irp, pass->context);
244 if (pass->dump_irprog) {
245 pass->dump_irprog(irp, pass->context, idx);
248 create_suffix(suffix, sizeof(suffix), pass->name, idx);
249 dump_all_ir_graphs(dump_ir_block_graph, suffix);
252 if (pass->is_wrapper) {
253 ir_graph_pass_manager_t *graph_mgr = pass->context;
254 idx += graph_mgr->n_passes;
261 /* Creates a new ir_graph pass manager. */
262 ir_graph_pass_manager_t *new_graph_pass_mgr(
263 const char *name, int verify_all, int dump_all)
265 ir_graph_pass_manager_t *res = XMALLOCZ(ir_graph_pass_manager_t);
267 INIT_LIST_HEAD(&res->passes);
268 res->kind = k_ir_graph_pass_mgr;
271 res->verify_all = verify_all != 0;
272 res->dump_all = dump_all != 0;
277 /* Creates a new ir_prog pass manager. */
278 ir_prog_pass_manager_t *new_prog_pass_mgr(
279 const char *name, int verify_all, int dump_all)
281 ir_prog_pass_manager_t *res = XMALLOCZ(ir_prog_pass_manager_t);
283 INIT_LIST_HEAD(&res->passes);
284 res->kind = k_ir_prog_pass_mgr;
287 res->verify_all = verify_all != 0;
288 res->dump_all = dump_all != 0;
293 /* Terminate an ir_graph pass manager and all owned passes. */
294 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
296 ir_graph_pass_t *pass, *next;
298 list_for_each_entry_safe(ir_graph_pass_t, pass, next, &mgr->passes, list) {
299 if (pass->rem_from_mgr)
300 pass->rem_from_mgr(pass->context);
308 /* Terminate an ir_prog pass manager and all owned passes. */
309 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
311 ir_prog_pass_t *pass, *next;
313 list_for_each_entry_safe(ir_prog_pass_t, pass, next, &mgr->passes, list) {
314 if (pass->rem_from_mgr)
315 pass->rem_from_mgr(pass->context);
324 * Set the run index for an irgraph pass manager.
326 * @param mgr the manager
327 * @param run_idx the index for the first pass of this manager
329 void ir_graph_pass_mgr_set_run_idx(
330 ir_graph_pass_manager_t *mgr, unsigned run_idx)
332 mgr->run_idx = run_idx;
336 * Set the run index for an irprog pass manager.
338 * @param mgr the manager
339 * @param run_idx the index for the first pass of this manager
341 void ir_prog_pass_mgr_set_run_idx(
342 ir_prog_pass_manager_t *mgr, unsigned run_idx)
344 mgr->run_idx = run_idx;
348 * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
350 static int void_graph_wrapper(ir_graph *irg, void *context)
352 void (*function)(ir_graph *irg) = context;
355 } /* void_graph_wrapper */
357 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
358 ir_graph_pass_t *def_graph_pass(
359 const char *name, void (*function)(ir_graph *irg))
361 struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
363 pass->kind = k_ir_graph_pass;
364 pass->run_on_irg = void_graph_wrapper;
365 pass->context = function;
368 INIT_LIST_HEAD(&pass->list);
371 } /* def_graph_pass */
374 * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
376 static int int_graph_wrapper(ir_graph *irg, void *context)
378 int (*function)(ir_graph *irg) = context;
379 return function(irg);
380 } /* int_graph_wrapper */
382 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
383 ir_graph_pass_t *def_graph_pass_ret(
384 const char *name, int (*function)(ir_graph *irg))
386 struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
388 pass->kind = k_ir_graph_pass;
389 pass->run_on_irg = int_graph_wrapper;
390 pass->context = function;
393 INIT_LIST_HEAD(&pass->list);
396 } /* def_graph_pass_ret */
398 /* constructor for a default graph pass */
399 ir_graph_pass_t *def_graph_pass_constructor(
400 ir_graph_pass_t *pass,
401 const char *name, int (*function)(ir_graph *irg, void *context)) {
403 pass = XMALLOCZ(ir_graph_pass_t);
405 memset(pass, 0, sizeof(ir_graph_pass_t));
406 pass->kind = k_ir_graph_pass;
407 pass->run_on_irg = function;
408 pass->context = pass;
411 INIT_LIST_HEAD(&pass->list);
414 } /* def_graph_pass_constructor */
416 /* set the run parallel property */
417 void ir_graph_pass_set_parallel(ir_graph_pass_t *pass, int flag)
419 pass->run_parallel = flag != 0;
420 } /* ir_graph_pass_set_parallel */
423 * Wrapper for running void function(void) as an ir_prog pass.
425 static int void_prog_wrapper(ir_prog *irp, void *context)
427 void (*function)(void) = context;
432 } /* void_graph_wrapper */
434 /* Creates an ir_prog pass for running void function(void). */
435 ir_prog_pass_t *def_prog_pass(
437 void (*function)(void))
439 struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
441 pass->kind = k_ir_prog_pass;
442 pass->run_on_irprog = void_prog_wrapper;
443 pass->context = function;
446 INIT_LIST_HEAD(&pass->list);
449 } /* def_prog_pass */
451 /* Creates an ir_prog pass for running void function(void). */
452 ir_prog_pass_t *def_prog_pass_constructor(
453 ir_prog_pass_t *pass,
455 int (*function)(ir_prog *irp, void *context))
458 pass = XMALLOCZ(ir_prog_pass_t);
460 memset(pass, 0, sizeof(ir_prog_pass_t));
462 pass->kind = k_ir_prog_pass;
463 pass->run_on_irprog = function;
464 pass->context = pass;
467 INIT_LIST_HEAD(&pass->list);
470 } /* def_prog_pass_constructor */
475 void (*function)(void *context);
479 * Wrapper for the call_function pass.
481 static int call_function_wrapper(ir_prog *irp, void *context)
483 struct pass_t *pass = context;
486 pass->function(pass->context);
488 } /* call_function_wrapper */
490 ir_prog_pass_t *call_function_pass(
491 const char *name, void (*function)(void *context), void *context) {
492 struct pass_t *pass = XMALLOCZ(struct pass_t);
494 def_prog_pass_constructor(
495 &pass->pass, name ? name : "set_function", call_function_wrapper);
497 pass->pass.verify_irprog = ir_prog_no_verify;
498 pass->pass.dump_irprog = ir_prog_no_dump;
499 pass->pass.context = pass;
501 pass->function = function;
502 pass->context = context;
505 } /* call_function_pass */