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
26 * Main file for the optimization reducing the copies needed for:
28 * - Register-constrained nodes
29 * - Two-address code instructions
31 #ifndef FIRM_BE_BECOPYOPT_H
32 #define FIRM_BE_BECOPYOPT_H
36 #include "firm_types.h"
37 #include "bechordal.h"
41 * Flags for dumping the IFG.
44 CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
45 CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
46 CO_IFG_DUMP_SHAPE = 4, /**< Give constrained nodes special shapes. */
47 CO_IFG_DUMP_CONSTR = 8 /**< Dump the node constraints in the label. */
63 typedef struct copy_opt_t copy_opt_t;
65 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
68 int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
69 int can_improve_existing;
74 * Register a new copy optimization algorithm.
76 * @param name the name of the copy optimazation algorithm,
78 * @param copyopt a copy optimazation entry
80 void be_register_copyopt(const char *name, co_algo_info *copyopt);
82 /** The driver for copy minimization. */
83 void co_driver(be_chordal_env_t *cenv);
85 /** A coalescing algorithm. */
86 typedef int (co_algo_t)(copy_opt_t *);
89 * Generate the problem. Collect all information and optimizable nodes.
91 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
94 * Free the space used...
96 void free_copy_opt(copy_opt_t *co);
99 * Computes the costs of a copy according to loop depth
100 * @param co The copy opt object.
101 * @param pos the argument position of arg in the root arguments
102 * @return Must be >= 0 in all cases.
104 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
107 * Computes the costs of a copy according to execution frequency
108 * @param co The copy opt object.
109 * @param pos the argument position of arg in the root arguments
110 * @return Must be >= 0 in all cases.
112 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
115 * All costs equal 1. Using this will reduce the _number_ of copies.
116 * @param co The copy opt object.
117 * @return Must be >= 0 in all cases.
119 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
122 * Statistics over a copy optimization module.
125 unsigned long long aff_edges; /**< number of affinity edges. */
126 unsigned long long aff_nodes; /**< number of nodes with incident affinity edges. */
127 unsigned long long aff_int; /**< number of affinity edges whose nodes also interfere. */
128 unsigned long long inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
129 unsigned long long max_costs; /**< all costs of the affinities. */
130 unsigned long long costs; /**< The costs of the current coloring. */
131 unsigned long long unsatisfied_edges; /**< The number of unequally colored affinity edges. */
132 } co_complete_stats_t;
135 * Collect statistics of a copy optimization module.
136 * @param co The copy optimization environment.
137 * @param stat Where to put the stats.
138 * @note This requires the graph info to be computed.
140 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
144 * Build internal optimization units structure
146 void co_build_ou_structure(copy_opt_t *co);
149 * Frees the space used by the opt unit representation.
150 * Does NOT free the whole copyopt structure
152 void co_free_ou_structure(copy_opt_t *co);
155 * Solves the problem using a heuristic approach
156 * Uses the OU data structure
158 int co_solve_heuristic(copy_opt_t *co);
161 * Apply Park/Moon coalescing to the graph.
162 * @param co The copy optimization data structure.
164 void co_solve_park_moon(copy_opt_t *co);
167 * Solves the copy minimization problem using another heuristic approach.
168 * Uses the OU and the GRAPH data structure.
170 int co_solve_heuristic_new(copy_opt_t *co);
173 * Returns the maximal costs possible, i.e. the costs if all
174 * pairs would be assigned different registers.
175 * Uses the OU data structure
177 int co_get_max_copy_costs(const copy_opt_t *co);
180 * Returns the inevitable costs, i.e. the costs of
181 * all copy pairs which interfere.
182 * Uses the OU data structure
184 int co_get_inevit_copy_costs(const copy_opt_t *co);
187 * Returns the current costs the copies are causing.
188 * The result includes inevitable costs and the costs
189 * of the copies regarding the current register allocation
190 * Uses the OU data structure
192 int co_get_copy_costs(const copy_opt_t *co);
195 * Returns a lower bound for the costs of copies in this ou.
196 * The result includes inevitable costs and the costs of a
197 * minimal costs caused by the nodes of the ou.
198 * Uses the OU data structure
200 int co_get_lower_bound(const copy_opt_t *co);
203 * Dump the interference graph according to the Appel/George coalescing contest file format.
204 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
205 * @note Requires graph structure.
206 * @param co The copy opt object.
207 * @param f A file to dump to.
209 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
212 * Dumps the IFG of the program splitting after each instruction in the Appel format.
213 * @param co The copy opt object.
214 * @param f The file to dump to.
216 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
218 * Dump the interference graph with the affinity edges and the coloring.
219 * @param co The copy opt structure.
220 * @param f The file to dump to.
221 * @param flags The dump flags (see enum above).
223 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
226 * Constructs another internal representation of the affinity edges
228 void co_build_graph_structure(copy_opt_t *co);
231 * Frees the space used by the graph representation.
232 * Does NOT free the whole copyopt structure
234 void co_free_graph_structure(copy_opt_t *co);
237 * Solves the problem using mixed integer programming
238 * @returns 1 iff solution state was optimal
239 * Uses the OU and the GRAPH data structure
240 * Dependency of the OU structure can be removed
242 int co_solve_ilp2(copy_opt_t *co);
245 * Checks if a node is optimizable, viz has something to do with coalescing.
246 * Uses the GRAPH data structure
248 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);