3cdb218b1283453cbb2fa6c9bdacf935c459a196
[libfirm] / ir / be / beirg.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       Backend irg - a ir_graph with additional analysis information.
23  * @author      Matthias Braun
24  * @date        05.05.2006
25  * @version     $Id$
26  */
27 #ifndef FIRM_BE_BEIRG_H
28 #define FIRM_BE_BEIRG_H
29
30 #include "be.h"
31 #include "be_types.h"
32 #include "be_t.h"
33 #include "irtypes.h"
34
35 be_lv_t *be_assure_liveness(ir_graph *irg);
36
37 void be_assure_dom_front(ir_graph *irg);
38 void be_invalidate_dom_front(ir_graph *irg);
39
40 /**
41  * frees all memory allocated by birg structures (liveness, dom_front, ...).
42  * The memory of the birg structure itself is not freed.
43  */
44 void be_free_birg(ir_graph *irg);
45
46 /**
47  * An ir_graph with additional analysis data about this irg. Also includes some
48  * backend structures
49  */
50 struct be_irg_t {
51         ir_graph               *irg;
52         be_main_env_t          *main_env;
53         be_abi_irg_t           *abi;
54         arch_code_generator_t  *cg;
55         ir_exec_freq           *exec_freq;
56         be_dom_front_info_t    *dom_front;
57         be_lv_t                *lv;
58         struct obstack          obst; /**< birg obstack (mainly used to keep
59                                            register constraints which we can't keep
60                                            in the irg obst, because it gets replace
61                                            during code selection) */
62 };
63
64 static inline be_irg_t *be_birg_from_irg(const ir_graph *irg)
65 {
66         return (be_irg_t*) irg->be_data;
67 }
68
69 static inline be_lv_t *be_get_irg_liveness(const ir_graph *irg)
70 {
71         return be_birg_from_irg(irg)->lv;
72 }
73
74 static inline ir_exec_freq *be_get_irg_exec_freq(const ir_graph *irg)
75 {
76         return be_birg_from_irg(irg)->exec_freq;
77 }
78
79 static inline be_dom_front_info_t *be_get_irg_dom_front(const ir_graph *irg)
80 {
81         return be_birg_from_irg(irg)->dom_front;
82 }
83
84 static inline be_abi_irg_t *be_get_irg_abi(const ir_graph *irg)
85 {
86         return be_birg_from_irg(irg)->abi;
87 }
88
89 static inline be_options_t *be_get_irg_options(const ir_graph *irg)
90 {
91         return be_birg_from_irg(irg)->main_env->options;
92 }
93
94 static inline arch_code_generator_t *be_get_irg_cg(const ir_graph *irg)
95 {
96         return be_birg_from_irg(irg)->cg;
97 }
98
99 /** deprecated */
100 static inline ir_graph *be_get_birg_irg(const be_irg_t *birg)
101 {
102         return birg->irg;
103 }
104
105 static inline const arch_env_t *be_get_irg_arch_env(const ir_graph *irg)
106 {
107         return be_birg_from_irg(irg)->main_env->arch_env;
108 }
109
110 static inline struct obstack *be_get_birg_obst(const ir_graph *irg)
111 {
112         be_irg_t *birg = be_birg_from_irg(irg);
113         return &birg->obst;
114 }
115
116 #endif /* FIRM_BE_BEIRG_H */