- renamed access offset functions
[libfirm] / ir / be / bechordal_t.h
1
2 /**
3  * Internal data structures for the chordal register allocator.
4  * @author Sebastian Hack
5  * @date 25.1.2005
6  */
7
8 #ifndef _BECHORDAL_T_H
9 #define _BECHORDAL_T_H
10
11 #include "firm_types.h"
12 #include "firm_config.h"
13
14 #include <stdlib.h>
15
16 #include "bitset.h"
17 #include "list.h"
18 #include "obst.h"
19 #include "pset.h"
20 #include "pmap.h"
21 #include "set.h"
22
23 #include "execfreq.h"
24
25 #include "be_t.h"
26 #include "beifg.h"
27 #include "bera.h"
28 #include "bearch.h"
29 #include "bechordal.h"
30 #include "beirgmod.h"
31 #include "belive.h"
32
33 typedef struct _be_ra_chordal_opts_t be_ra_chordal_opts_t;
34
35 /** Defines an invalid register index. */
36 #define NO_COLOR (-1)
37
38 /**
39  * A liveness interval border.
40  */
41 typedef struct _border_t {
42         unsigned magic;                 /**< A magic number for checking. */
43         struct list_head list;          /**< list head for queuing. */
44         struct _border_t *other_end;    /**< The other end of the border. */
45         ir_node *irn;                   /**< The node. */
46         unsigned step;                  /**< The number equal to the interval border. */
47         unsigned pressure;              /**< The pressure at this interval border. (The border itself is counting). */
48         unsigned is_def : 1;            /**< Does this border denote a use or a def. */
49         unsigned is_real : 1;           /**< Is the def/use real? Or is it just inserted
50                                         at block beginnings or ends to ensure that inside
51                                         a block, each value has one begin and one end. */
52 } border_t;
53
54 /**
55  * Environment for each of the chordal register allocator phases
56  */
57 struct _be_chordal_env_t {
58         struct obstack obst;                /**< An obstack for temporary storage. */
59         be_ra_chordal_opts_t *opts;         /**< A pointer to the chordal ra options. */
60         be_irg_t *birg;                     /**< Back-end IRG session. */
61         ir_graph *irg;                      /**< The graph under examination. */
62         const arch_register_class_t *cls;   /**< The current register class. */
63         pmap *border_heads;                 /**< Maps blocks to border heads. */
64         be_ifg_t *ifg;                      /**< The interference graph. */
65         void *data;                         /**< Some pointer, to which different phases can attach data to. */
66         bitset_t *ignore_colors;            /**< A set of colors which shall be ignored in register allocation. */
67         DEBUG_ONLY(firm_dbg_module_t *dbg;) /**< Debug module for the chordal register allocator. */
68 };
69
70 static INLINE struct list_head *_get_block_border_head(const be_chordal_env_t *inf, ir_node *bl) {
71   return pmap_get(inf->border_heads, bl);
72 }
73
74 #define get_block_border_head(info, bl)     _get_block_border_head(info, bl)
75
76 #define foreach_border_head(head, pos)          list_for_each_entry_reverse(border_t, pos, head, list)
77 #define border_next(b)                      (list_entry((b)->list.next, border_t, list))
78 #define border_prev(b)                      (list_entry((b)->list.prev, border_t, list))
79
80 #define chordal_has_class(chordal_env, irn) \
81         arch_irn_consider_in_reg_alloc(chordal_env->birg->main_env->arch_env, chordal_env->cls, irn)
82
83 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b);
84
85 void be_ra_chordal_color(be_chordal_env_t *chordal_env);
86
87 /**
88  * Check a register allocation obtained with the chordal register allocator.
89  * @param chordal_env The chordal environment.
90  */
91 void be_ra_chordal_check(be_chordal_env_t *chordal_env);
92
93 enum {
94         /* spill method */
95         BE_CH_SPILL_BELADY    = 1,
96         BE_CH_SPILL_MORGAN    = 2,
97         BE_CH_SPILL_REMAT     = 3,
98
99         /* Dump flags */
100         BE_CH_DUMP_NONE       = (1 << 0),
101         BE_CH_DUMP_SPILL      = (1 << 1),
102         BE_CH_DUMP_LIVE       = (1 << 2),
103         BE_CH_DUMP_COLOR      = (1 << 3),
104         BE_CH_DUMP_COPYMIN    = (1 << 4),
105         BE_CH_DUMP_SSADESTR   = (1 << 5),
106         BE_CH_DUMP_TREE_INTV  = (1 << 6),
107         BE_CH_DUMP_CONSTR     = (1 << 7),
108         BE_CH_DUMP_SPILLSLOTS = (1 << 8),
109         BE_CH_DUMP_LOWER      = (1 << 9),
110         BE_CH_DUMP_APPEL      = (1 << 10),
111         BE_CH_DUMP_ALL        = 2 * BE_CH_DUMP_APPEL - 1,
112
113         /* ifg flavor */
114         BE_CH_IFG_STD     = 1,
115         BE_CH_IFG_FAST    = 2,
116         BE_CH_IFG_CLIQUE  = 3,
117         BE_CH_IFG_POINTER = 4,
118         BE_CH_IFG_LIST    = 5,
119         BE_CH_IFG_CHECK   = 6,
120
121         /* lower perm options */
122         BE_CH_LOWER_PERM_SWAP   = 1,
123         BE_CH_LOWER_PERM_COPY   = 2,
124
125         /* verify options */
126         BE_CH_VRFY_OFF    = 1,
127         BE_CH_VRFY_WARN   = 2,
128         BE_CH_VRFY_ASSERT = 3,
129 };
130
131 struct _be_ra_chordal_opts_t {
132         int dump_flags;
133         int spill_method;
134         int ifg_flavor;
135         int lower_perm_opt;
136         int vrfy_option;
137
138         char ilp_server[128];
139         char ilp_solver[128];
140 };
141
142 /**
143  * Open a file whose name is composed from the graph's name and the current register class.
144  * @note The name of the file will be prefix(ifg_name)_(reg_class_name).suffix
145  * @param prefix The file name's prefix.
146  * @param suffix The file name's ending (the . is inserted automatically).
147  * @return       A text file opened for writing.
148  */
149 FILE *be_chordal_open(const be_chordal_env_t *env, const char *prefix, const char *suffix);
150
151 void be_pre_spill_prepare_constr(be_chordal_env_t *cenv);
152
153 #endif /* _BECHORDAL_T_H */