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(&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(&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);
68 * Ensure that no verifier is run from the wrapper.
70 static int no_verify(ir_prog *prog, void *ctx)
78 * Ensure that no dumper is run from the wrapper.
80 static void no_dump(ir_prog *prog, void *ctx, unsigned idx)
88 * Term warpper for a wrapped ir_graph pass manager.
90 static void term_wrapper(void *context)
92 ir_graph_pass_manager_t *mgr = context;
93 term_graph_pass_mgr(mgr);
97 * Create a wrapper ir_prog pass for an ir_graph manager.
99 static ir_prog_pass_t *create_wrapper_pass(ir_graph_pass_manager_t *graph_mgr)
101 /* create a wrapper pass */
102 ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
104 pass->run_on_irprog = run_wrapper;
105 pass->context = graph_mgr;
106 pass->name = graph_mgr->name;
108 /* do not verify nor dump: this is handled by the graph manager */
109 pass->verify_irprog = no_verify;
110 pass->dump_irprog = no_dump;
111 pass->is_wrapper = 1;
113 pass->add_to_mgr = NULL;
114 pass->rem_from_mgr = term_wrapper;
119 /* Add an ir_graph_pass as a pass to an ir_prog pass manager. */
120 void ir_prog_pass_mgr_add_graph_pass(
121 ir_prog_pass_manager_t *mgr, ir_graph_pass_t *pass)
123 ir_graph_pass_manager_t *graph_mgr;
124 ir_prog_pass_t *wrapper;
126 /* check if the last pass is a graph_pass wrapper */
127 if (! list_empty(&mgr->passes)) {
128 wrapper = list_entry(mgr->passes.prev, ir_prog_pass_t, list);
129 if (wrapper->is_wrapper) {
130 graph_mgr = wrapper->context;
132 ir_graph_pass_mgr_add(graph_mgr, pass);
137 /* not found, create a new wrapper */
138 graph_mgr = new_graph_pass_mgr("wrapper", mgr->verify_all, mgr->dump_all);
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 void create_suffix(char *suffix, size_t n, const char *pass_name, unsigned index)
165 snprintf(suffix, n, "-%02u_%s", index, pass_name);
168 /* Run all passes of an ir_graph pass manager. */
169 int ir_graph_pass_mgr_run(ir_graph_pass_manager_t *mgr)
171 ir_graph_pass_t *pass;
173 ir_graph *rem = current_ir_graph;
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);
184 /* verify is necessary */
185 if (mgr->verify_all) {
186 if (pass->verify_irg) {
187 pass->verify_irg(irg, pass->context);
194 if (pass->dump_irg) {
195 pass->dump_irg(irg, pass->context, idx);
198 create_suffix(suffix, sizeof(suffix), pass->name, idx);
199 dump_ir_block_graph(irg, suffix);
205 current_ir_graph = rem;
210 * Verify all graphs on the given ir_prog.
212 static int irp_verify_irgs(ir_prog *irp, int flags) {
215 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
216 res &= irg_verify(get_irp_irg(i), flags);
220 /* Run all passes of an ir_prog pass manager. */
221 int ir_prog_pass_mgr_run(ir_prog_pass_manager_t *mgr)
223 ir_prog_pass_t *pass;
226 /* run every pass on every graph */
227 unsigned idx = mgr->run_idx;
228 list_for_each_entry(ir_prog_pass_t, pass, &mgr->passes, list) {
229 int pass_res = pass->run_on_irprog(irp, pass->context);
232 /* verify is necessary */
233 if (mgr->verify_all) {
234 if (pass->verify_irprog) {
235 pass->verify_irprog(irp, pass->context);
237 irp_verify_irgs(irp, 0);
242 if (pass->dump_irprog) {
243 pass->dump_irprog(irp, pass->context, idx);
246 create_suffix(suffix, sizeof(suffix), pass->name, idx);
247 dump_all_ir_graphs(dump_ir_block_graph, suffix);
250 if (pass->is_wrapper) {
251 ir_graph_pass_manager_t *graph_mgr = pass->context;
252 idx += graph_mgr->n_passes;
259 /* Creates a new ir_graph pass manager. */
260 ir_graph_pass_manager_t *new_graph_pass_mgr(
261 const char *name, int verify_all, int dump_all)
263 ir_graph_pass_manager_t *res = xmalloc(sizeof(res));
265 INIT_LIST_HEAD(&res->passes);
268 res->verify_all = verify_all != 0;
269 res->dump_all = dump_all != 0;
274 /* Creates a new ir_prog pass manager. */
275 ir_prog_pass_manager_t *new_prog_pass_mgr(
276 const char *name, int verify_all, int dump_all)
278 ir_prog_pass_manager_t *res = xmalloc(sizeof(res));
280 INIT_LIST_HEAD(&res->passes);
283 res->verify_all = verify_all != 0;
284 res->dump_all = dump_all != 0;
289 /* Terminate an ir_graph pass manager and all owned passes. */
290 void term_graph_pass_mgr(ir_graph_pass_manager_t *mgr)
292 ir_graph_pass_t *pass, *next;
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);
304 /* Terminate an ir_prog pass manager and all owned passes. */
305 void term_prog_pass_mgr(ir_prog_pass_manager_t *mgr)
307 ir_prog_pass_t *pass, *next;
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);
320 * Set the run index for an irgraph pass manager.
322 * @param mgr the manager
323 * @param run_idx the index for the first pass of this manager
325 void ir_graph_pass_manager_set_run_idx(
326 ir_graph_pass_manager_t *mgr, unsigned run_idx)
328 mgr->run_idx = run_idx;
332 * Set the run index for an irprog pass manager.
334 * @param mgr the manager
335 * @param run_idx the index for the first pass of this manager
337 void ir_prog_pass_manager_set_run_idx(
338 ir_prog_pass_manager_t *mgr, unsigned run_idx)
340 mgr->run_idx = run_idx;
344 * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
346 static int void_graph_wrapper(ir_graph *irg, void *context) {
347 void (*function)(ir_graph *irg) = context;
350 } /* void_graph_wrapper */
352 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
353 ir_graph_pass_t *def_graph_pass(
354 const char *name, void (*function)(ir_graph *irg))
356 struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
358 pass->kind = k_ir_graph_pass;
359 pass->run_on_irg = void_graph_wrapper;
360 pass->context = function;
363 INIT_LIST_HEAD(&pass->list);
366 } /* def_graph_pass */
369 * Wrapper for running void function(ir_graph *irg) as an ir_graph pass.
371 static int int_graph_wrapper(ir_graph *irg, void *context) {
372 int (*function)(ir_graph *irg) = context;
373 return function(irg);
374 } /* int_graph_wrapper */
376 /* Creates an ir_graph pass for running void function(ir_graph *irg). */
377 ir_graph_pass_t *def_graph_pass_ret(
378 const char *name, int (*function)(ir_graph *irg))
380 struct ir_graph_pass_t *pass = XMALLOCZ(ir_graph_pass_t);
382 pass->kind = k_ir_graph_pass;
383 pass->run_on_irg = int_graph_wrapper;
384 pass->context = function;
387 INIT_LIST_HEAD(&pass->list);
390 } /* def_graph_pass_ret */
392 /* constructor for a default graph pass */
393 ir_graph_pass_t *def_graph_pass_constructor(
394 ir_graph_pass_t *pass,
395 const char *name, int (*function)(ir_graph *irg, void *context)) {
397 pass = XMALLOCZ(ir_graph_pass_t);
398 pass->kind = k_ir_graph_pass;
399 pass->run_on_irg = function;
400 pass->context = pass;
403 INIT_LIST_HEAD(&pass->list);
406 } /* def_graph_pass_constructor */
410 * Wrapper for running void function(void) as an ir_prog pass.
412 static int void_prog_wrapper(ir_prog *irp, void *context) {
413 void (*function)(void) = context;
418 } /* void_graph_wrapper */
420 /* Creates an ir_prog pass for running void function(void). */
421 ir_prog_pass_t *def_prog_pass(
423 void (*function)(void))
425 struct ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
427 pass->kind = k_ir_prog_pass;
428 pass->run_on_irprog = void_prog_wrapper;
429 pass->context = function;
432 INIT_LIST_HEAD(&pass->list);
435 } /* def_prog_pass */