2 * Copyright (C) 1995-2008 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 Copy minimization driver.
23 * @author Daniel Grund
27 * Main file for the optimization reducing the copies needed for:
29 * - Register-constrained nodes
30 * - Two-address code instructions
32 #ifndef FIRM_BE_BECOPYOPT_H
33 #define FIRM_BE_BECOPYOPT_H
37 #include "firm_types.h"
38 #include "bechordal.h"
42 * Flags for dumping the IFG.
45 CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
46 CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
47 CO_IFG_DUMP_SHAPE = 4, /**< Give constrained nodes special shapes. */
48 CO_IFG_DUMP_CONSTR = 8 /**< Dump the node constraints in the label. */
64 typedef struct copy_opt_t copy_opt_t;
66 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
69 int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
70 int can_improve_existing;
75 * Register a new copy optimization algorithm.
77 * @param name the name of the copy optimazation algorithm,
79 * @param copyopt a copy optimazation entry
81 void be_register_copyopt(const char *name, co_algo_info *copyopt);
83 /** The driver for copy minimization. */
84 void co_driver(be_chordal_env_t *cenv);
86 /** A coalescing algorithm. */
87 typedef int (co_algo_t)(copy_opt_t *);
90 * Generate the problem. Collect all information and optimizable nodes.
92 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
95 * Free the space used...
97 void free_copy_opt(copy_opt_t *co);
100 * Computes the costs of a copy according to loop depth
101 * @param co The copy opt object.
102 * @param pos the argument position of arg in the root arguments
103 * @return Must be >= 0 in all cases.
105 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
108 * Computes the costs of a copy according to execution frequency
109 * @param co The copy opt object.
110 * @param pos the argument position of arg in the root arguments
111 * @return Must be >= 0 in all cases.
113 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
116 * All costs equal 1. Using this will reduce the _number_ of copies.
117 * @param co The copy opt object.
118 * @return Must be >= 0 in all cases.
120 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
123 * Statistics over a copy optimization module.
126 unsigned long long aff_edges; /**< number of affinity edges. */
127 unsigned long long aff_nodes; /**< number of nodes with incident affinity edges. */
128 unsigned long long aff_int; /**< number of affinity edges whose nodes also interfere. */
129 unsigned long long inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
130 unsigned long long max_costs; /**< all costs of the affinities. */
131 unsigned long long costs; /**< The costs of the current coloring. */
132 unsigned long long unsatisfied_edges; /**< The number of unequally colored affinity edges. */
133 } co_complete_stats_t;
136 * Collect statistics of a copy optimization module.
137 * @param co The copy optimization environment.
138 * @param stat Where to put the stats.
139 * @note This requires the graph info to be computed.
141 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
145 * Build internal optimization units structure
147 void co_build_ou_structure(copy_opt_t *co);
150 * Frees the space used by the opt unit representation.
151 * Does NOT free the whole copyopt structure
153 void co_free_ou_structure(copy_opt_t *co);
156 * Solves the problem using a heuristic approach
157 * Uses the OU data structure
159 int co_solve_heuristic(copy_opt_t *co);
162 * Apply Park/Moon coalescing to the graph.
163 * @param co The copy optimization data structure.
165 void co_solve_park_moon(copy_opt_t *co);
168 * Solves the copy minimization problem using another heuristic approach.
169 * Uses the OU and the GRAPH data structure.
171 int co_solve_heuristic_new(copy_opt_t *co);
174 * Returns the maximal costs possible, i.e. the costs if all
175 * pairs would be assigned different registers.
176 * Uses the OU data structure
178 int co_get_max_copy_costs(const copy_opt_t *co);
181 * Returns the inevitable costs, i.e. the costs of
182 * all copy pairs which interfere.
183 * Uses the OU data structure
185 int co_get_inevit_copy_costs(const copy_opt_t *co);
188 * Returns the current costs the copies are causing.
189 * The result includes inevitable costs and the costs
190 * of the copies regarding the current register allocation
191 * Uses the OU data structure
193 int co_get_copy_costs(const copy_opt_t *co);
196 * Returns a lower bound for the costs of copies in this ou.
197 * The result includes inevitable costs and the costs of a
198 * minimal costs caused by the nodes of the ou.
199 * Uses the OU data structure
201 int co_get_lower_bound(const copy_opt_t *co);
204 * Dump the interference graph according to the Appel/George coalescing contest file format.
205 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
206 * @note Requires graph structure.
207 * @param co The copy opt object.
208 * @param f A file to dump to.
210 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
213 * Dumps the IFG of the program splitting after each instruction in the Appel format.
214 * @param co The copy opt object.
215 * @param f The file to dump to.
217 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
219 * Dump the interference graph with the affinity edges and the coloring.
220 * @param co The copy opt structure.
221 * @param f The file to dump to.
222 * @param flags The dump flags (see enum above).
224 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
227 * Constructs another internal representation of the affinity edges
229 void co_build_graph_structure(copy_opt_t *co);
232 * Frees the space used by the graph representation.
233 * Does NOT free the whole copyopt structure
235 void co_free_graph_structure(copy_opt_t *co);
238 * Solves the problem using mixed integer programming
239 * @returns 1 iff solution state was optimal
240 * Uses the OU and the GRAPH data structure
241 * Dependency of the OU structure can be removed
243 int co_solve_ilp2(copy_opt_t *co);
246 * Checks if a node is optimizable, viz has something to do with coalescing.
247 * Uses the GRAPH data structure
249 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);