4 * Copyright: (c) Universitaet Karlsruhe
5 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
7 * Main file for the optimization reducing the copies needed for:
9 * - Register-constrained nodes
10 * - Two-address code instructions
17 #include "firm_types.h"
18 #include "bechordal.h"
21 * Flags for dumping the IFG.
24 CO_IFG_DUMP_COLORS = 1, /**< Dump the graph colored. */
25 CO_IFG_DUMP_LABELS = 2, /**< Dump node/edge labels. */
26 CO_IFG_DUMP_SHAPE = 4, /**< Give constrained nodes special shapes. */
27 CO_IFG_DUMP_CONSTR = 8 /**< Dump the node constraints in the label. */
42 /** The driver for copy minimization. */
43 void co_driver(be_chordal_env_t *cenv);
45 typedef struct _copy_opt_t copy_opt_t;
47 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
49 /** A coalescing algorithm. */
50 typedef int (co_algo_t)(copy_opt_t *);
53 * Generate the problem. Collect all information and optimizable nodes.
55 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
58 * Free the space used...
60 void free_copy_opt(copy_opt_t *co);
63 * Checks if a node is optimizable, viz. has something to do with coalescing
64 * @param arch The architecture environment
65 * @param irn The irn to check
67 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
70 * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
72 int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
75 * Computes the costs of a copy according to loop depth
76 * @param co The copy opt object.
77 * @param pos the argument position of arg in the root arguments
78 * @return Must be >= 0 in all cases.
80 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
83 * Computes the costs of a copy according to execution frequency
84 * @param co The copy opt object.
85 * @param pos the argument position of arg in the root arguments
86 * @return Must be >= 0 in all cases.
88 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
91 * All costs equal 1. Using this will reduce the _number_ of copies.
92 * @param co The copy opt object.
93 * @return Must be >= 0 in all cases.
95 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
98 * Statistics over a copy optimization module.
101 ulong64 aff_edges; /**< number of affinity edges. */
102 ulong64 aff_nodes; /**< number of nodes with incident affinity edges. */
103 ulong64 aff_int; /**< number of affinity edges whose nodes also interfere. */
104 ulong64 inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
105 ulong64 max_costs; /**< all costs of the affinities. */
106 ulong64 costs; /**< The costs of the current coloring. */
107 ulong64 unsatisfied_edges; /**< The number of unequally colored affinity edges. */
108 } co_complete_stats_t;
111 * Collect statistics of a copy optimization module.
112 * @param co The copy optimization environment.
113 * @param stat Where to put the stats.
114 * @note This requires the graph info to be computed.
116 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
120 * Build internal optimization units structure
122 void co_build_ou_structure(copy_opt_t *co);
125 * Frees the space used by the opt unit representation.
126 * Does NOT free the whole copyopt structure
128 void co_free_ou_structure(copy_opt_t *co);
131 * Solves the problem using a heuristic approach
132 * Uses the OU data structure
134 int co_solve_heuristic(copy_opt_t *co);
137 * Apply Park/Moon coalescing to the graph.
138 * @param co The copy optimization data structure.
140 void co_solve_park_moon(copy_opt_t *co);
143 * Solves the copy minimization problem using another heuristic approach.
144 * Uses the OU and the GRAPH data structure.
146 int co_solve_heuristic_new(copy_opt_t *co);
149 * Solves the copy minimization problem using another heuristic approach implemented in Java.
150 * This function needs a JVM which is started to call the Java module.
151 * Uses the GRAPH data structure.
153 int co_solve_heuristic_java(copy_opt_t *co);
156 * Returns the maximal costs possible, i.e. the costs if all
157 * pairs would be assigned different registers.
158 * Uses the OU data structure
160 int co_get_max_copy_costs(const copy_opt_t *co);
163 * Returns the inevitable costs, i.e. the costs of
164 * all copy pairs which interfere.
165 * Uses the OU data structure
167 int co_get_inevit_copy_costs(const copy_opt_t *co);
170 * Returns the current costs the copies are causing.
171 * The result includes inevitable costs and the costs
172 * of the copies regarding the current register allocation
173 * Uses the OU data structure
175 int co_get_copy_costs(const copy_opt_t *co);
178 * Returns a lower bound for the costs of copies in this ou.
179 * The result includes inevitable costs and the costs of a
180 * minimal costs caused by the nodes of the ou.
181 * Uses the OU data structure
183 int co_get_lower_bound(const copy_opt_t *co);
186 * Dump the interference graph according to the Appel/George coalescing contest file format.
187 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
188 * @note Requires graph structure.
189 * @param co The copy opt object.
190 * @param f A file to dump to.
192 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
195 * Dumps the IFG of the program splitting after each instruction in the Appel format.
196 * @param co The copy opt object.
197 * @param f The file to dump to.
199 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
201 * Dump the interference graph with the affinity edges and the coloring.
202 * @param co The copy opt structure.
203 * @param f The file to dump to.
204 * @param flags The dump flags (see enum above).
206 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
209 * Constructs another internal representation of the affinity edges
211 void co_build_graph_structure(copy_opt_t *co);
214 * Frees the space used by the graph representation.
215 * Does NOT free the whole copyopt structure
217 void co_free_graph_structure(copy_opt_t *co);
220 * Solves the problem using mixed integer programming
221 * @returns 1 iff solution state was optimal
224 int co_solve_ilp1(copy_opt_t *co, double time_limit);
227 * Solves the problem using mixed integer programming
228 * @returns 1 iff solution state was optimal
229 * Uses the OU and the GRAPH data structure
230 * Dependency of the OU structure can be removed
232 int co_solve_ilp2(copy_opt_t *co);
235 * Checks if a node is optimizable, viz has something to do with coalescing.
236 * Uses the GRAPH data structure
238 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
240 #endif /* _BECOPYOPT_H */