6b8efc11afe82dfda2ad74b6f4759e0537d48ca6
[libfirm] / ir / be / bechordal_t.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Internal data structures for the chordal register allocator.
23  * @author      Sebastian Hack
24  * @date        25.01.2005
25  */
26 #ifndef FIRM_BE_BECHORDAL_T_H
27 #define FIRM_BE_BECHORDAL_T_H
28
29 #include "firm_types.h"
30 #include "list.h"
31 #include "pmap.h"
32 #include "bitset.h"
33 #include "obst.h"
34 #include "debug.h"
35
36 #include "bechordal.h"
37 #include "beirg.h"
38 #include "beifg.h"
39
40 /**
41  * A liveness interval border.
42  */
43 struct border_t {
44         DEBUG_ONLY(unsigned magic;)     /**< A magic number for checking. */
45         struct list_head  list;         /**< list head for queuing. */
46         border_t         *other_end;    /**< The other end of the border. */
47         ir_node          *irn;          /**< The node. */
48         unsigned         step;          /**< The number equal to the interval border. */
49         unsigned         pressure;      /**< The pressure at this interval border. (The border itself is counting). */
50         unsigned         is_def  : 1;   /**< Does this border denote a use or a def. */
51         unsigned         is_real : 1;   /**< Is the def/use real? Or is it just
52                                              inserted at block beginnings or ends
53                                              to ensure that inside a block, each
54                                              value has one begin and one end. */
55 };
56
57 /**
58  * Environment for each of the chordal register allocator phases
59  */
60 struct be_chordal_env_t {
61         struct obstack       *obst;         /**< An obstack for temporary storage. */
62         be_ra_chordal_opts_t *opts;         /**< A pointer to the chordal ra options. */
63         ir_graph             *irg;          /**< The graph under examination. */
64         const arch_register_class_t *cls;   /**< The current register class. */
65         pmap                 *border_heads; /**< Maps blocks to border heads. */
66         be_ifg_t             *ifg;          /**< The interference graph. */
67         bitset_t             *allocatable_regs; /**< set of allocatable registers */
68 };
69
70 static inline struct list_head *get_block_border_head(be_chordal_env_t const *const inf, ir_node *const bl)
71 {
72   return pmap_get(list_head, inf->border_heads, bl);
73 }
74
75 #define foreach_border_head(head, pos)      list_for_each_entry_reverse(border_t, pos, head, list)
76
77 /**
78  * Check, if an irn is of the register class currently under processing.
79  * @param env The chordal environment.
80  * @param irn The node.
81  * @return whether the node is of that register class.
82  */
83 static inline bool has_reg_class(be_chordal_env_t const *const env, ir_node const *const irn)
84 {
85         return arch_irn_consider_in_reg_alloc(env->cls, irn);
86 }
87
88 void be_ra_chordal_color(be_chordal_env_t *chordal_env);
89
90 enum {
91         /* Dump flags */
92         BE_CH_DUMP_NONE       = (1 << 0),
93         BE_CH_DUMP_SPILL      = (1 << 1),
94         BE_CH_DUMP_LIVE       = (1 << 2),
95         BE_CH_DUMP_COLOR      = (1 << 3),
96         BE_CH_DUMP_COPYMIN    = (1 << 4),
97         BE_CH_DUMP_SSADESTR   = (1 << 5),
98         BE_CH_DUMP_TREE_INTV  = (1 << 6),
99         BE_CH_DUMP_CONSTR     = (1 << 7),
100         BE_CH_DUMP_SPILLSLOTS = (1 << 8),
101         BE_CH_DUMP_LOWER      = (1 << 9),
102         BE_CH_DUMP_SPLIT      = (1 << 10),
103         BE_CH_DUMP_APPEL      = (1 << 11),
104         BE_CH_DUMP_ALL        = 2 * BE_CH_DUMP_APPEL - 1,
105
106         /* lower perm options */
107         BE_CH_LOWER_PERM_SWAP   = 1,
108         BE_CH_LOWER_PERM_COPY   = 2,
109
110         /* verify options */
111         BE_CH_VRFY_OFF    = 1,
112         BE_CH_VRFY_WARN   = 2,
113         BE_CH_VRFY_ASSERT = 3,
114 };
115
116 struct be_ra_chordal_opts_t {
117         unsigned dump_flags;
118         int      lower_perm_opt;
119         int      vrfy_option;
120
121         char ilp_server[128];
122         char ilp_solver[128];
123 };
124
125 void check_for_memory_operands(ir_graph *irg);
126
127 #endif /* FIRM_BE_BECHORDAL_T_H */