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