typo fixed
[libfirm] / ir / be / becopyopt.h
1 /**
2  * Author:      Daniel Grund
3  * Date:                12.04.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  *
7  * Header for copy optimization problem. Analysis and set up of the problem.
8  */
9
10 #ifndef _BECOPYOPT_H
11 #define _BECOPYOPT_H
12
13 #include "debug.h"
14 #include "obst.h"
15 #include "list.h"
16 #include "set.h"
17 #include "pset.h"
18 #include "bitset.h"
19 #include "sp_matrix.h"
20
21 #include "irgraph.h"
22 #include "irgwalk.h"
23 #include "irnode.h"
24 #include "irdom.h"
25 #include "irouts.h"
26
27 #include "beutil.h"
28 #include "benumb_t.h"
29 #include "belive_t.h"
30 #include "bechordal_t.h"
31 #include "bearch.h"
32
33 #define DEBUG_IRG "NONE spec.c__main__datab"
34 #define DEBUG_LVL_CO   LEVEL_1
35 #define DEBUG_LVL_HEUR LEVEL_1
36 #define DEBUG_LVL_ILP  LEVEL_1
37
38 /**
39  * Data representing the problem of copy minimization.
40  */
41 typedef struct _copy_opt_t {
42         be_chordal_env_t *chordal_env;
43         char *name;                                                     /**< ProgName__IrgName__RegClass */
44         struct list_head units;                         /**< all units to optimize in right order */
45         pset *roots;                                            /**< used only temporary for detecting multiple appends */
46         struct obstack ob;
47 } copy_opt_t;
48
49 /**
50  * A single unit of optimization. Lots of these form a copy-opt problem
51  */
52 typedef struct _unit_t {
53         struct list_head units;         /**< chain for all units */
54         copy_opt_t *co;                         /**< the copy_opt this unit belongs to */
55         int interf;                                     /**< number of nodes dropped due to interference */
56         int node_count;                         /**< size of the nodes array */
57         ir_node **nodes;                        /**< [0] is the root-node, others are non interfering args of it. */
58         int ifg_mis_size;                       /**< size of a mis considering only ifg (not coloring conflicts) */
59
60         /* for heuristic */
61         struct list_head queue;         /**< list of (mis/color) sorted by size of mis */
62 } unit_t;
63
64 /* Helpers */
65 #define set_irn_col(co, irn, col) \
66         arch_set_irn_register(co->chordal_env->arch_env, irn, 0, arch_register_for_index(co->chordal_env->cls, col))
67
68 #define get_irn_col(co, irn) \
69         arch_register_get_index(arch_get_irn_register(co->chordal_env->arch_env, irn, 0))
70
71
72 /**
73  * Generate the problem. Collect all infos and optimizable nodes.
74  */
75 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env);
76
77 /**
78  * Free the space...
79  */
80 void free_copy_opt(copy_opt_t *co);
81
82
83 #define is_Perm(arch_env, irn) (arch_irn_classify(arch_env, irn) == arch_irn_class_perm)
84
85 /**
86  * A copy is a proj haning out of perm node
87  */
88 #define is_Copy(arch_env, irn) (is_Proj(irn) && is_Perm(arch_env, get_Proj_pred(irn)))
89
90 /**
91  * returns the corresponding argument of the perm node for a copy
92  */
93 #define get_Copy_src(irn) (get_irn_n(get_Proj_pred(irn), get_Proj_proj(irn)))
94
95 /**
96  * Checks if a node is optimizable, viz. is a target of a 'copy-op'
97  */
98 #define is_optimizable(arch_env, irn) (is_Phi(irn) || is_Copy(arch_env, irn))
99
100 /**
101  * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
102  */
103 int is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
104
105
106 /**
107  * Returns the current number of copies needed
108  */
109 int co_get_copy_count(const copy_opt_t *co);
110
111 /**
112  * Returns a lower bound for the number of copies needed based on interfering
113  * arguments and the size of a max indep. set (only ifg-edges) of the other args.
114  */
115 int co_get_lower_bound(const copy_opt_t *co);
116
117 /**
118  * Returns the number of arguments interfering with their root node. This also
119  * is a (worse) lower bound for the number of copies needed.
120  */
121 int co_get_interferer_count(const copy_opt_t *co);
122
123 /**
124  * Solves the problem using a heuristic approach
125  */
126 void co_heur_opt(copy_opt_t *co);
127
128 /**
129  * Solves the problem using mixed integer programming
130  */
131 void co_ilp_opt(copy_opt_t *co);
132
133 /**
134  * Checks the register allocation for correctness
135  */
136 void co_check_allocation(copy_opt_t *co);
137
138 #endif