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. */
43 /** The driver for copy minimization. */
44 void co_driver(be_chordal_env_t *cenv);
46 typedef struct _copy_opt_t copy_opt_t;
48 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
50 /** A coalescing algorithm. */
51 typedef int (co_algo_t)(copy_opt_t *);
54 * Generate the problem. Collect all information and optimizable nodes.
56 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
59 * Free the space used...
61 void free_copy_opt(copy_opt_t *co);
64 * Checks if a node is optimizable, viz. has something to do with coalescing
65 * @param arch The architecture environment
66 * @param irn The irn to check
68 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
71 * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
73 int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
76 * Computes the costs of a copy according to loop depth
77 * @param co The copy opt object.
78 * @param pos the argument position of arg in the root arguments
79 * @return Must be >= 0 in all cases.
81 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
84 * Computes the costs of a copy according to execution frequency
85 * @param co The copy opt object.
86 * @param pos the argument position of arg in the root arguments
87 * @return Must be >= 0 in all cases.
89 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
92 * All costs equal 1. Using this will reduce the _number_ of copies.
93 * @param co The copy opt object.
94 * @return Must be >= 0 in all cases.
96 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
99 * Statistics over a copy optimization module.
102 ulong64 aff_edges; /**< number of affinity edges. */
103 ulong64 aff_nodes; /**< number of nodes with incident affinity edges. */
104 ulong64 aff_int; /**< number of affinity edges whose nodes also interfere. */
105 ulong64 inevit_costs; /**< costs which cannot be evited (due to interfering affinities). */
106 ulong64 max_costs; /**< all costs of the affinities. */
107 ulong64 costs; /**< The costs of the current coloring. */
108 ulong64 unsatisfied_edges; /**< The number of unequally colored affinity edges. */
109 } co_complete_stats_t;
112 * Collect statistics of a copy optimization module.
113 * @param co The copy optimization environment.
114 * @param stat Where to put the stats.
115 * @note This requires the graph info to be computed.
117 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
121 * Build internal optimization units structure
123 void co_build_ou_structure(copy_opt_t *co);
126 * Frees the space used by the opt unit representation.
127 * Does NOT free the whole copyopt structure
129 void co_free_ou_structure(copy_opt_t *co);
132 * Solves the problem using a heuristic approach
133 * Uses the OU data structure
135 int co_solve_heuristic(copy_opt_t *co);
138 * Apply Park/Moon coalescing to the graph.
139 * @param co The copy optimization data structure.
141 void co_solve_park_moon(copy_opt_t *co);
144 * Solves the copy minimization problem using another heuristic approach.
145 * Uses the OU and the GRAPH data structure.
147 int co_solve_heuristic_new(copy_opt_t *co);
150 * Solves the copy minimization problem using another heuristic approach implemented in Java.
151 * This function needs a JVM which is started to call the Java module.
152 * Uses the GRAPH data structure.
154 int co_solve_heuristic_java(copy_opt_t *co);
157 * This is the pure C implementation of co_solve_heuristic_java().
159 int co_solve_heuristic_mst(copy_opt_t *co);
162 * Returns the maximal costs possible, i.e. the costs if all
163 * pairs would be assigned different registers.
164 * Uses the OU data structure
166 int co_get_max_copy_costs(const copy_opt_t *co);
169 * Returns the inevitable costs, i.e. the costs of
170 * all copy pairs which interfere.
171 * Uses the OU data structure
173 int co_get_inevit_copy_costs(const copy_opt_t *co);
176 * Returns the current costs the copies are causing.
177 * The result includes inevitable costs and the costs
178 * of the copies regarding the current register allocation
179 * Uses the OU data structure
181 int co_get_copy_costs(const copy_opt_t *co);
184 * Returns a lower bound for the costs of copies in this ou.
185 * The result includes inevitable costs and the costs of a
186 * minimal costs caused by the nodes of the ou.
187 * Uses the OU data structure
189 int co_get_lower_bound(const copy_opt_t *co);
192 * Dump the interference graph according to the Appel/George coalescing contest file format.
193 * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
194 * @note Requires graph structure.
195 * @param co The copy opt object.
196 * @param f A file to dump to.
198 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
201 * Dumps the IFG of the program splitting after each instruction in the Appel format.
202 * @param co The copy opt object.
203 * @param f The file to dump to.
205 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
207 * Dump the interference graph with the affinity edges and the coloring.
208 * @param co The copy opt structure.
209 * @param f The file to dump to.
210 * @param flags The dump flags (see enum above).
212 void co_dump_ifg_dot(const copy_opt_t *co, FILE *f, unsigned flags);
215 * Constructs another internal representation of the affinity edges
217 void co_build_graph_structure(copy_opt_t *co);
220 * Frees the space used by the graph representation.
221 * Does NOT free the whole copyopt structure
223 void co_free_graph_structure(copy_opt_t *co);
226 * Solves the problem using mixed integer programming
227 * @returns 1 iff solution state was optimal
230 int co_solve_ilp1(copy_opt_t *co, double time_limit);
233 * Solves the problem using mixed integer programming
234 * @returns 1 iff solution state was optimal
235 * Uses the OU and the GRAPH data structure
236 * Dependency of the OU structure can be removed
238 int co_solve_ilp2(copy_opt_t *co);
241 * Checks if a node is optimizable, viz has something to do with coalescing.
242 * Uses the GRAPH data structure
244 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
246 #endif /* _BECOPYOPT_H */