Corrected setting register classes of Return and Barrier nodes
[libfirm] / ir / be / benode_t.h
1 /**
2  * @file   benode_t.h
3  * @date   17.05.2005
4  * @author Sebastian Hack
5  *
6  * Backend node support.
7  *
8  * Copyright (C) 2005 Universitaet Karlsruhe
9  * Released under the GPL
10  */
11
12 #ifndef _BENODE_T_H
13 #define _BENODE_T_H
14
15 #include "firm_config.h"
16 #include "pmap.h"
17
18 #include "irmode.h"
19 #include "irnode.h"
20 #include "entity_t.h"
21
22 #include "be_t.h"
23 #include "bearch.h"
24
25 #define BE_OUT_POS(p) (-((p) + 1))
26
27 /**
28  * The benode op's.  Must be available to register emitter function.
29  */
30 extern ir_op *op_be_Spill;
31 extern ir_op *op_be_Reload;
32 extern ir_op *op_be_Perm;
33 extern ir_op *op_be_Copy;
34 extern ir_op *op_be_Keep;
35 extern ir_op *op_be_Call;
36 extern ir_op *op_be_Return;
37 extern ir_op *op_be_IncSP;
38 extern ir_op *op_be_AddSP;
39 extern ir_op *op_be_SetSP;
40 extern ir_op *op_be_RegParams;
41 extern ir_op *op_be_StackParam;
42 extern ir_op *op_be_FrameAddr;
43 extern ir_op *op_be_FrameLoad;
44 extern ir_op *op_be_FrameStore;
45 extern ir_op *op_be_Barrier;
46
47 typedef enum {
48         beo_NoBeOp = 0,
49         beo_Spill,
50         beo_Reload,
51         beo_Perm,
52         beo_Copy,
53         beo_Keep,
54         beo_CopyKeep,
55         beo_Call,
56         beo_Return,
57         beo_AddSP,
58         beo_IncSP,
59         beo_SetSP,
60         beo_RegParams,
61         beo_StackParam,
62         beo_FrameLoad,
63         beo_FrameStore,
64         beo_FrameAddr,
65         beo_Barrier,
66         beo_Last
67 } be_opcode_t;
68
69 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
70 typedef enum {
71         be_stack_dir_along = 0,
72         be_stack_dir_against = 1
73 } be_stack_dir_t;
74
75 /** Not used yet. */
76 typedef enum {
77         be_frame_flag_spill = 1,
78         be_frame_flag_local = 2,
79         be_frame_flag_arg   = 4
80 } be_frame_flag_t;
81
82 /**
83  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
84  * It gets back-patched to the real size as soon it is known.
85  */
86 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
87
88 void be_node_init(void);
89
90 const arch_irn_handler_t be_node_irn_handler;
91
92 enum {
93         be_pos_Spill_frame = 0,
94         be_pos_Spill_val   = 1
95 };
96 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *node_to_spill, ir_node *ctx);
97
98 enum {
99         be_pos_Reload_frame = 0,
100         be_pos_Reload_mem   = 1
101 };
102 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *spill_node, ir_mode *mode);
103
104 enum {
105         be_pos_Copy_orig = 0
106 };
107 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
108 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
109 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
110
111 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
112                                                   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
113 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
114                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
115 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
116
117 enum {
118         be_pos_AddSP_old_sp = 0,
119         be_pos_AddSP_size   = 1,
120         be_pos_AddSP_last   = 2
121 };
122
123 /**
124  * Make a new AddSP node.
125  * An AddSP node expresses an increase of the stack pointer in the direction the stack
126  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
127  * given by a constant but an ordinary Firm node.
128  * @param sp     The stack pointer register.
129  * @param irg    The graph.
130  * @param bl     The block.
131  * @param old_sp The node representing the old stack pointer value.
132  * @param sz     The node expressing the size by which the stack pointer shall be grown.
133  * @return       A new AddSP node.
134  */
135 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
136
137 ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand, ir_node *mem);
138
139 /**
140  * Make a stack pointer increase/decrease node.
141  * @param sp     The stack pointer register.
142  * @param irg    The graph to insert the node to.
143  * @param bl     The block to insert the node into.
144  * @param old_sp The node defining the former stack pointer.
145  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
146  * @param dir    The direction in which the stack pointer shall be modified:
147  *               Along the stack's growing direction or against.
148  * @return       A new stack pointer increment/decrement node.
149  * @note         This node sets a register constraint to the @p sp register on its output.
150  */
151 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *mem, unsigned amount, be_stack_dir_t dir);
152
153
154
155 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
156 unsigned be_get_IncSP_offset(const ir_node *irn);
157
158 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
159 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
160
161 entity *be_Call_get_entity(const ir_node *call);
162 void    be_Call_set_entity(ir_node *call, entity *ent);
163
164 enum {
165         be_pos_Call_mem = 0,
166         be_pos_Call_sp  = 1,
167         be_pos_Call_ptr = 2
168 };
169
170 ir_node *be_new_Call(ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr, int n_outs, int n, ir_node *in[]);
171 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
172 ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, entity *ent);
173 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
174
175 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
176
177 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
178 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *reloader, ir_mode *mode, ir_node *spill);
179
180 ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, int n, ir_node *in_keep[], ir_mode *mode);
181 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);
182
183
184 /**
185  * Get the backend opcode of a backend node.
186  * @param irn The node.
187  * @return The backend opcode.
188  */
189 be_opcode_t be_get_irn_opcode(const ir_node *irn);
190
191 int be_is_Spill(const ir_node *irn);
192 int be_is_Reload(const ir_node *irn);
193 int be_is_Copy(const ir_node *irn);
194 int be_is_Perm(const ir_node *irn);
195 int be_is_Keep(const ir_node *irn);
196 int be_is_CopyKeep(const ir_node *irn);
197 int be_is_Call(const ir_node *irn);
198 int be_is_Return(const ir_node *irn);
199 int be_is_IncSP(const ir_node *irn);
200 int be_is_SetSP(const ir_node *irn);
201 int be_is_AddSP(const ir_node *irn);
202 int be_is_RegParams(const ir_node *irn);
203 int be_is_StackParam(const ir_node *irn);
204 int be_is_FrameAddr(const ir_node *irn);
205 int be_is_FrameLoad(const ir_node *irn);
206 int be_is_FrameStore(const ir_node *irn);
207 int be_is_Barrier(const ir_node *irn);
208
209 /**
210  * Get the entity on the stack frame the given node uses.
211  * @param irn The node.
212  * @return The entity on the stack frame used by the node or NULL,
213  *         if the node does not access the stack frame or is no back-end node.
214  *
215  */
216 entity *be_get_frame_entity(const ir_node *irn);
217
218 void   be_set_Spill_entity(ir_node *irn, entity *ent);
219 entity *be_get_spill_entity(const ir_node *irn);
220
221 ir_node *be_get_Spill_context(const ir_node *irn);
222
223 /**
224  * Set the entities of a Reload to the ones of the Spill it is pointing to.
225  * @param irg The graph.
226  */
227 void be_copy_entities_to_reloads(ir_graph *irg);
228
229 /**
230  * Impose a register constraint on a backend node.
231  * @param irn The node.
232  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
233  * @param reg The register which is admissible for that node, argument/result and position.
234  */
235 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
236
237 /**
238  * Impose register constraints on a backend node.
239  * The register subsets given by the limited function in @p req are copied to the backend node.
240  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
241  * @param irn The backend node.
242  * @param pos The position (@see be_set_constr_single_reg()).
243  * @param req The register requirements which shall be transferred.
244  */
245 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
246
247 /**
248  * Set the flags of a node.
249  * @param irn The node itself.
250  * @param pos The position (0..n) for arguments, (-1..-m) for results.
251  * @param flags The flags to set for that node and position.
252  */
253 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
254
255 /**
256  * Set the register class of a node.
257  * @param irn The node itself.
258  * @param pos The position (0..n) for arguments, (-1..-m) for results.
259  * @param flags The register class to set for that node and position.
260  */
261 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
262
263 /**
264  * Insert a Perm node after a specific node in the schedule.
265  * The Perm permutes over all values live at the given node.
266  * This means that all liveness intervals are cut apart at this
267  * location in the program.
268  */
269 ir_node *insert_Perm_after(const arch_env_t *env,
270                                                    const arch_register_class_t *cls,
271                                                    dom_front_info_t *dom_front,
272                                                    ir_node *pos);
273
274
275 #endif /* _BENODE_T_H */