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. */
65 /** The driver for copy minimization. */
66 void co_driver(be_chordal_env_t *cenv);
68 typedef struct _copy_opt_t copy_opt_t;
70 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node *, ir_node *, int);
72 /** A coalescing algorithm. */
73 typedef int (co_algo_t)(copy_opt_t *);
76 * Generate the problem. Collect all information and optimizable nodes.
78 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
81 * Free the space used...
83 void free_copy_opt(copy_opt_t *co);
86 * Computes the costs of a copy according to loop depth
87 * @param co The copy opt object.
88 * @param pos the argument position of arg in the root arguments
89 * @return Must be >= 0 in all cases.
91 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
94 * Computes the costs of a copy according to execution frequency
95 * @param co The copy opt object.
96 * @param pos the argument position of arg in the root arguments
97 * @return Must be >= 0 in all cases.
99 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
102 * All costs equal 1. Using this will reduce the _number_ of copies.
103 * @param co The copy opt object.
104 * @return Must be >= 0 in all cases.
106 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
109 * Statistics over a copy optimization module.
112 ulong64 aff_edges; /**< number of affinity edges. */
113 ulong64 aff_nodes; /**< number of nodes with incident affinity edges. */
114 ulong64 aff_int; /**< number of affinity edges whose nodes also interfere. */
115 ulong64 inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
116 ulong64 max_costs; /**< all costs of the affinities. */
117 ulong64 costs; /**< The costs of the current coloring. */
118 ulong64 unsatisfied_edges; /**< The number of unequally colored affinity edges. */
119 } co_complete_stats_t;
122 * Collect statistics of a copy optimization module.
123 * @param co The copy optimization environment.
124 * @param stat Where to put the stats.
125 * @note This requires the graph info to be computed.
127 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
131 * Build internal optimization units structure
133 void co_build_ou_structure(copy_opt_t *co);
136 * Frees the space used by the opt unit representation.
137 * Does NOT free the whole copyopt structure
139 void co_free_ou_structure(copy_opt_t *co);
142 * Solves the problem using a heuristic approach
143 * Uses the OU data structure
145 int co_solve_heuristic(copy_opt_t *co);
148 * Apply Park/Moon coalescing to the graph.
149 * @param co The copy optimization data structure.
151 void co_solve_park_moon(copy_opt_t *co);
154 * Solves the copy minimization problem using another heuristic approach.
155 * Uses the OU and the GRAPH data structure.
157 int co_solve_heuristic_new(copy_opt_t *co);
160 * Solves the copy minimization problem using another heuristic approach implemented in Java.
161 * This function needs a JVM which is started to call the Java module.
162 * Uses the GRAPH data structure.
164 int co_solve_heuristic_java(copy_opt_t *co);
167 * This is the pure C implementation of co_solve_heuristic_java().
169 int co_solve_heuristic_mst(copy_opt_t *co);
172 * Returns the maximal costs possible, i.e. the costs if all
173 * pairs would be assigned different registers.
174 * Uses the OU data structure
176 int co_get_max_copy_costs(const copy_opt_t *co);
179 * Returns the inevitable costs, i.e. the costs of
180 * all copy pairs which interfere.
181 * Uses the OU data structure
183 int co_get_inevit_copy_costs(const copy_opt_t *co);
186 * Returns the current costs the copies are causing.
187 * The result includes inevitable costs and the costs
188 * of the copies regarding the current register allocation
189 * Uses the OU data structure
191 int co_get_copy_costs(const copy_opt_t *co);
194 * Returns a lower bound for the costs of copies in this ou.
195 * The result includes inevitable costs and the costs of a
196 * minimal costs caused by the nodes of the ou.
197 * Uses the OU data structure
199 int co_get_lower_bound(const copy_opt_t *co);
202 * Dump the interference graph according to the Appel/George coalescing contest file format.
203 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
204 * @note Requires graph structure.
205 * @param co The copy opt object.
206 * @param f A file to dump to.
208 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
211 * Dumps the IFG of the program splitting after each instruction in the Appel format.
212 * @param co The copy opt object.
213 * @param f The file to dump to.
215 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
217 * Dump the interference graph with the affinity edges and the coloring.
218 * @param co The copy opt structure.
219 * @param f The file to dump to.
220 * @param flags The dump flags (see enum above).
222 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
225 * Constructs another internal representation of the affinity edges
227 void co_build_graph_structure(copy_opt_t *co);
230 * Frees the space used by the graph representation.
231 * Does NOT free the whole copyopt structure
233 void co_free_graph_structure(copy_opt_t *co);
236 * Solves the problem using mixed integer programming
237 * @returns 1 iff solution state was optimal
240 int co_solve_ilp1(copy_opt_t *co, double time_limit);
243 * Solves the problem using mixed integer programming
244 * @returns 1 iff solution state was optimal
245 * Uses the OU and the GRAPH data structure
246 * Dependency of the OU structure can be removed
248 int co_solve_ilp2(copy_opt_t *co);
250 int co_solve_heuristic_pbqp(copy_opt_t *co);
253 * Checks if a node is optimizable, viz has something to do with coalescing.
254 * Uses the GRAPH data structure
256 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
258 #endif /* FIRM_BE_BECOPYOPT_H */