92cf87ce8a58618370570dc4b52cf44e3d4f8d80
[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 /**
22  * Has to be called during the firm init phase
23  */
24 void be_copy_opt_init(void);
25
26 typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
27
28 typedef struct _copy_opt_t copy_opt_t;
29
30 /**
31  * Generate the problem. Collect all information and optimizable nodes.
32  */
33 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
34
35 /**
36  * Free the space used...
37  */
38 void free_copy_opt(copy_opt_t *co);
39
40 /**
41  * Checks if a node is optimizable, viz. has something to do with coalescing
42  * @param arch The architecture environment
43  * @param irn  The irn to check
44  */
45 int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
46
47 /**
48  * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
49  */
50 int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
51
52 /**
53  * Computes the costs of a copy according to loop depth
54  * @param pos:  the argument position of arg in the root arguments
55  * @return Must be >= 0 in all cases.
56  */
57 int co_get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
58
59 /**
60  * All costs equal 1. Using this will reduce the _number_ of copies.
61  * @return Must be >= 0 in all cases.
62  */
63 int co_get_costs_all_one(ir_node *root, ir_node* arg, int pos);
64
65
66
67
68 /**
69  * Build internal optimization units structure
70  */
71 void co_build_ou_structure(copy_opt_t *co);
72
73 /**
74  * Frees the space used by the opt unit representation.
75  * Does NOT free the whole copyopt structure
76  */
77 void co_free_ou_structure(copy_opt_t *co);
78
79 /**
80  * Solves the problem using a heuristic approach
81  * Uses the OU data structure
82  */
83 int co_solve_heuristic(copy_opt_t *co);
84
85 void co_solve_heuristic_new(copy_opt_t *co);
86
87
88 /**
89  * Apply Park/Moon coalescing to the graph.
90  * @param co The copy optimization data structure.
91  */
92 void co_solve_park_moon(copy_opt_t *co);
93
94 /**
95  * Solves the copy minimization problem using another heuristic approach.
96  * Uses the OU and the GRAPH data structure.
97  */
98 void co_solve_heuristic_new(copy_opt_t *co);
99
100 /**
101  * Returns the maximal costs possible, i.e. the costs if all
102  * pairs would be assigned different registers.
103  * Uses the OU data structure
104  */
105 int co_get_max_copy_costs(const copy_opt_t *co);
106
107 /**
108  * Returns the inevitable costs, i.e. the costs of
109  * all copy pairs which interfere.
110  * Uses the OU data structure
111  */
112 int co_get_inevit_copy_costs(const copy_opt_t *co);
113
114 /**
115  * Returns the current costs the copies are causing.
116  * The result includes inevitable costs and the costs
117  * of the copies regarding the current register allocation
118  * Uses the OU data structure
119  */
120 int co_get_copy_costs(const copy_opt_t *co);
121
122 /**
123  * Returns a lower bound for the costs of copies in this ou.
124  * The result includes inevitable costs and the costs of a
125  * minimal costs caused by the nodes of the ou.
126  * Uses the OU data structure
127  */
128 int co_get_lower_bound(const copy_opt_t *co);
129
130 /**
131  * Dump the interference graph according to the Appel/George coalescing contest file format.
132  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
133  * @note Requires graph structure.
134  * @param co The copy opt object.
135  * @param f  A file to dump to.
136  */
137 void co_dump_appel_graph(const copy_opt_t *co, FILE *f);
138
139
140
141 /**
142  * Constructs another internal representation of the affinity edges
143  */
144 void co_build_graph_structure(copy_opt_t *co);
145
146 /**
147  * Frees the space used by the graph representation.
148  * Does NOT free the whole copyopt structure
149  */
150 void co_free_graph_structure(copy_opt_t *co);
151
152 /**
153  * Solves the problem using mixed integer programming
154  * @returns 1 iff solution state was optimal
155  * NYI
156  */
157 int co_solve_ilp1(copy_opt_t *co, double time_limit);
158
159 /**
160  * Solves the problem using mixed integer programming
161  * @returns 1 iff solution state was optimal
162  * Uses the OU and the GRAPH data structure
163  * Dependency of the OU structure can be removed
164  */
165 int co_solve_ilp2(copy_opt_t *co, double time_limit);
166
167 /**
168  * Checks if a node is optimizable, viz has something to do with coalescing.
169  * Uses the GRAPH data structure
170  */
171 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
172
173 #endif /* _BECOPYOPT_H */