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 /** The driver for copy minimization. */
65 void co_driver(be_chordal_env_t *cenv);
67 typedef struct _copy_opt_t copy_opt_t;
69 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
71 /** A coalescing algorithm. */
72 typedef int (co_algo_t)(copy_opt_t *);
75 * Generate the problem. Collect all information and optimizable nodes.
77 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
80 * Free the space used...
82 void free_copy_opt(copy_opt_t *co);
85 * Checks if a node is optimizable, viz. has something to do with coalescing
86 * @param arch The architecture environment
87 * @param irn The irn to check
89 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
92 * Computes the costs of a copy according to loop depth
93 * @param co The copy opt object.
94 * @param pos the argument position of arg in the root arguments
95 * @return Must be >= 0 in all cases.
97 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
100 * Computes the costs of a copy according to execution frequency
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_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
108 * All costs equal 1. Using this will reduce the _number_ of copies.
109 * @param co The copy opt object.
110 * @return Must be >= 0 in all cases.
112 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
115 * Statistics over a copy optimization module.
118 ulong64 aff_edges; /**< number of affinity edges. */
119 ulong64 aff_nodes; /**< number of nodes with incident affinity edges. */
120 ulong64 aff_int; /**< number of affinity edges whose nodes also interfere. */
121 ulong64 inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
122 ulong64 max_costs; /**< all costs of the affinities. */
123 ulong64 costs; /**< The costs of the current coloring. */
124 ulong64 unsatisfied_edges; /**< The number of unequally colored affinity edges. */
125 } co_complete_stats_t;
128 * Collect statistics of a copy optimization module.
129 * @param co The copy optimization environment.
130 * @param stat Where to put the stats.
131 * @note This requires the graph info to be computed.
133 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
137 * Build internal optimization units structure
139 void co_build_ou_structure(copy_opt_t *co);
142 * Frees the space used by the opt unit representation.
143 * Does NOT free the whole copyopt structure
145 void co_free_ou_structure(copy_opt_t *co);
148 * Solves the problem using a heuristic approach
149 * Uses the OU data structure
151 int co_solve_heuristic(copy_opt_t *co);
154 * Apply Park/Moon coalescing to the graph.
155 * @param co The copy optimization data structure.
157 void co_solve_park_moon(copy_opt_t *co);
160 * Solves the copy minimization problem using another heuristic approach.
161 * Uses the OU and the GRAPH data structure.
163 int co_solve_heuristic_new(copy_opt_t *co);
166 * Solves the copy minimization problem using another heuristic approach implemented in Java.
167 * This function needs a JVM which is started to call the Java module.
168 * Uses the GRAPH data structure.
170 int co_solve_heuristic_java(copy_opt_t *co);
173 * This is the pure C implementation of co_solve_heuristic_java().
175 int co_solve_heuristic_mst(copy_opt_t *co);
178 * Returns the maximal costs possible, i.e. the costs if all
179 * pairs would be assigned different registers.
180 * Uses the OU data structure
182 int co_get_max_copy_costs(const copy_opt_t *co);
185 * Returns the inevitable costs, i.e. the costs of
186 * all copy pairs which interfere.
187 * Uses the OU data structure
189 int co_get_inevit_copy_costs(const copy_opt_t *co);
192 * Returns the current costs the copies are causing.
193 * The result includes inevitable costs and the costs
194 * of the copies regarding the current register allocation
195 * Uses the OU data structure
197 int co_get_copy_costs(const copy_opt_t *co);
200 * Returns a lower bound for the costs of copies in this ou.
201 * The result includes inevitable costs and the costs of a
202 * minimal costs caused by the nodes of the ou.
203 * Uses the OU data structure
205 int co_get_lower_bound(const copy_opt_t *co);
208 * Dump the interference graph according to the Appel/George coalescing contest file format.
209 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
210 * @note Requires graph structure.
211 * @param co The copy opt object.
212 * @param f A file to dump to.
214 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
217 * Dumps the IFG of the program splitting after each instruction in the Appel format.
218 * @param co The copy opt object.
219 * @param f The file to dump to.
221 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
223 * Dump the interference graph with the affinity edges and the coloring.
224 * @param co The copy opt structure.
225 * @param f The file to dump to.
226 * @param flags The dump flags (see enum above).
228 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
231 * Constructs another internal representation of the affinity edges
233 void co_build_graph_structure(copy_opt_t *co);
236 * Frees the space used by the graph representation.
237 * Does NOT free the whole copyopt structure
239 void co_free_graph_structure(copy_opt_t *co);
242 * Solves the problem using mixed integer programming
243 * @returns 1 iff solution state was optimal
246 int co_solve_ilp1(copy_opt_t *co, double time_limit);
249 * Solves the problem using mixed integer programming
250 * @returns 1 iff solution state was optimal
251 * Uses the OU and the GRAPH data structure
252 * Dependency of the OU structure can be removed
254 int co_solve_ilp2(copy_opt_t *co);
257 * Checks if a node is optimizable, viz has something to do with coalescing.
258 * Uses the GRAPH data structure
260 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
262 #endif /* FIRM_BE_BECOPYOPT_H */