e7ff65a26355ceb2be5ef9d885d6d29a6fe0ac73
[libfirm] / ir / be / becopyopt.h
1 /**
2  * Author:      Daniel Grund
3  * Date:                11.04.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  *
7  * Main file for the optimization reducing the copies needed for:
8  * - Phi coalescing
9  * - Register-constrained nodes
10  * - Two-address code instructions
11  */
12
13 #ifndef _BECOPYOPT_H
14 #define _BECOPYOPT_H
15
16 #include <stdio.h>
17
18 #include "firm_types.h"
19 #include "bechordal.h"
20
21 #ifdef WITH_LIBCORE
22 #include <libcore/lc_opts.h>
23 extern void co_register_options(lc_opt_entry_t *grp);
24 #endif
25
26 /**
27  * Has to be called during the firm init phase
28  */
29 void be_copy_opt_init(void);
30
31 typedef struct _copy_opt_t copy_opt_t;
32
33 typedef int(*cost_fct_t)(const copy_opt_t *, ir_node*, ir_node*, int);
34
35 /**
36  * Generate the problem. Collect all information and optimizable nodes.
37  */
38 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
39
40 /**
41  * Free the space used...
42  */
43 void free_copy_opt(copy_opt_t *co);
44
45 /**
46  * Checks if a node is optimizable, viz. has something to do with coalescing
47  * @param arch The architecture environment
48  * @param irn  The irn to check
49  */
50 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
51
52 /**
53  * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
54  */
55 int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
56
57 /**
58  * Computes the costs of a copy according to loop depth
59  * @param co   The copy opt object.
60  * @param pos   the argument position of arg in the root arguments
61  * @return Must be >= 0 in all cases.
62  */
63 int co_get_costs_loop_depth(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
64
65 /**
66  * Computes the costs of a copy according to execution frequency
67  * @param co   The copy opt object.
68  * @param pos   the argument position of arg in the root arguments
69  * @return Must be >= 0 in all cases.
70  */
71 int co_get_costs_exec_freq(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
72
73 /**
74  * All costs equal 1. Using this will reduce the _number_ of copies.
75  * @param co   The copy opt object.
76  * @return Must be >= 0 in all cases.
77  */
78 int co_get_costs_all_one(const copy_opt_t *co, ir_node *root, ir_node* arg, int pos);
79
80
81
82
83 /**
84  * Build internal optimization units structure
85  */
86 void co_build_ou_structure(copy_opt_t *co);
87
88 /**
89  * Frees the space used by the opt unit representation.
90  * Does NOT free the whole copyopt structure
91  */
92 void co_free_ou_structure(copy_opt_t *co);
93
94 /**
95  * Solves the problem using a heuristic approach
96  * Uses the OU data structure
97  */
98 int co_solve_heuristic(copy_opt_t *co);
99
100 void co_solve_heuristic_new(copy_opt_t *co);
101
102 void co_solve_heuristic_java(copy_opt_t *co);
103
104 /**
105  * Apply Park/Moon coalescing to the graph.
106  * @param co The copy optimization data structure.
107  */
108 void co_solve_park_moon(copy_opt_t *co);
109
110 /**
111  * Solves the copy minimization problem using another heuristic approach.
112  * Uses the OU and the GRAPH data structure.
113  */
114 void co_solve_heuristic_new(copy_opt_t *co);
115
116 /**
117  * Returns the maximal costs possible, i.e. the costs if all
118  * pairs would be assigned different registers.
119  * Uses the OU data structure
120  */
121 int co_get_max_copy_costs(const copy_opt_t *co);
122
123 /**
124  * Returns the inevitable costs, i.e. the costs of
125  * all copy pairs which interfere.
126  * Uses the OU data structure
127  */
128 int co_get_inevit_copy_costs(const copy_opt_t *co);
129
130 /**
131  * Returns the current costs the copies are causing.
132  * The result includes inevitable costs and the costs
133  * of the copies regarding the current register allocation
134  * Uses the OU data structure
135  */
136 int co_get_copy_costs(const copy_opt_t *co);
137
138 /**
139  * Returns a lower bound for the costs of copies in this ou.
140  * The result includes inevitable costs and the costs of a
141  * minimal costs caused by the nodes of the ou.
142  * Uses the OU data structure
143  */
144 int co_get_lower_bound(const copy_opt_t *co);
145
146 /**
147  * Dump the interference graph according to the Appel/George coalescing contest file format.
148  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
149  * @note Requires graph structure.
150  * @param co The copy opt object.
151  * @param f  A file to dump to.
152  */
153 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
154
155 /**
156  * Dumps the IFG of the program splitting after each instruction in the Appel format.
157  * @param co The copy opt object.
158  * @param f  The file to dump to.
159  */
160 void co_dump_appel_graph_cliques(const copy_opt_t *co, FILE *f);
161
162 /**
163  * Constructs another internal representation of the affinity edges
164  */
165 void co_build_graph_structure(copy_opt_t *co);
166
167 /**
168  * Frees the space used by the graph representation.
169  * Does NOT free the whole copyopt structure
170  */
171 void co_free_graph_structure(copy_opt_t *co);
172
173 /**
174  * Solves the problem using mixed integer programming
175  * @returns 1 iff solution state was optimal
176  * NYI
177  */
178 int co_solve_ilp1(copy_opt_t *co, double time_limit);
179
180 /**
181  * Solves the problem using mixed integer programming
182  * @returns 1 iff solution state was optimal
183  * Uses the OU and the GRAPH data structure
184  * Dependency of the OU structure can be removed
185  */
186 int co_solve_ilp2(copy_opt_t *co, double time_limit);
187
188 /**
189  * Checks if a node is optimizable, viz has something to do with coalescing.
190  * Uses the GRAPH data structure
191  */
192 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
193
194 #endif /* _BECOPYOPT_H */