2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Backend irg - a ir_graph with additional analysis information.
23 * @author Matthias Braun
26 #ifndef FIRM_BE_BEIRG_H
27 #define FIRM_BE_BEIRG_H
34 void be_assure_live_sets(ir_graph *irg);
35 void be_assure_live_chk(ir_graph *irg);
37 * Liveness is invalid (call when nodes have been added but the control
38 * flow has not been changed)
40 void be_invalidate_live_sets(ir_graph *irg);
42 * Call when control flow has changed.
43 * be_invalidate_live_sets() is called.
45 void be_invalidate_live_chk(ir_graph *irg);
48 * frees all memory allocated by birg structures (liveness, ...).
49 * The memory of the birg structure itself is not freed.
51 void be_free_birg(ir_graph *irg);
53 /** The number of parts of the stack layout. */
54 #define N_FRAME_TYPES 3
57 * This type describes the stack layout.
58 * The stack is divided into 3 parts:
59 * - arg_type: A struct type describing the stack arguments and its order.
60 * - between_type: A struct type describing the stack layout between arguments
61 * and frame type. In architectures that put the return address
62 * automatically on the stack, the return address is put here.
63 * - frame_type: A class type describing the frame layout.
65 struct be_stack_layout_t {
66 ir_type *arg_type; /**< A type describing the stack argument layout. */
67 ir_type *between_type; /**< A type describing the "between" layout. */
68 ir_type *frame_type; /**< The frame type. */
70 ir_type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
72 int initial_offset; /**< the initial difference between stack pointer and frame pointer */
73 int initial_bias; /**< the initial stack bias */
74 bool sp_relative : 1; /**< entities are addressed relative to
75 stack pointer (omit-fp mode) */
79 * An ir_graph with additional analysis data about this irg. Also includes some
82 typedef struct be_irg_t {
84 be_main_env_t *main_env;
87 be_stack_layout_t stack_layout;
88 unsigned *allocatable_regs; /**< registers available for the
90 arch_register_req_t *sp_req; /**< requirements for stackpointer producing
92 struct obstack obst; /**< birg obstack (mainly used to keep
93 register constraints which we can't keep
94 in the irg obst, because it gets replaced
95 during code selection) */
96 void *isa_link; /**< architecture specific per-graph data*/
99 static inline be_irg_t *be_birg_from_irg(const ir_graph *irg)
101 return (be_irg_t*) irg->be_data;
104 static inline be_main_env_t *be_get_irg_main_env(const ir_graph *irg)
106 return be_birg_from_irg(irg)->main_env;
109 static inline be_lv_t *be_get_irg_liveness(const ir_graph *irg)
111 return be_birg_from_irg(irg)->lv;
114 static inline be_abi_irg_t *be_get_irg_abi(const ir_graph *irg)
116 return be_birg_from_irg(irg)->abi;
119 static inline void be_set_irg_abi(ir_graph *irg, be_abi_irg_t *abi)
121 be_birg_from_irg(irg)->abi = abi;
125 static inline ir_graph *be_get_birg_irg(const be_irg_t *birg)
130 static inline const arch_env_t *be_get_irg_arch_env(const ir_graph *irg)
132 return be_birg_from_irg(irg)->main_env->arch_env;
135 static inline struct obstack *be_get_be_obst(const ir_graph *irg)
137 be_irg_t *const birg = be_birg_from_irg(irg);
138 struct obstack *const obst = &birg->obst;
139 assert(obstack_object_size(obst) == 0);
143 static inline be_stack_layout_t *be_get_irg_stack_layout(const ir_graph *irg)
145 return &be_birg_from_irg(irg)->stack_layout;