54338fe2ae0b5b7e0e523b2cc4350a508faf3f33
[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_Epilogue;
46 extern ir_op *op_be_Prologue;
47
48 typedef enum {
49         beo_NoBeOp = 0,
50         beo_Spill,
51         beo_Reload,
52         beo_Perm,
53         beo_Copy,
54         beo_Keep,
55         beo_CopyKeep,
56         beo_Call,
57         beo_Return,
58         beo_AddSP,
59         beo_IncSP,
60         beo_SetSP,
61         beo_RegParams,
62         beo_StackParam,
63         beo_FrameLoad,
64         beo_FrameStore,
65         beo_FrameAddr,
66         beo_Epilogue,
67         beo_Prologue,
68         beo_Last
69 } be_opcode_t;
70
71 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
72 typedef enum {
73         be_stack_dir_along = 0,
74         be_stack_dir_against = 1
75 } be_stack_dir_t;
76
77 /** Not used yet. */
78 typedef enum {
79         be_frame_flag_spill = 1,
80         be_frame_flag_local = 2,
81         be_frame_flag_arg   = 4
82 } be_frame_flag_t;
83
84 /**
85  * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
86  * It gets back-patched to the real size as soon it is known.
87  */
88 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
89
90 void be_node_init(void);
91
92 const arch_irn_handler_t be_node_irn_handler;
93
94 enum {
95         be_pos_Spill_frame = 0,
96         be_pos_Spill_val   = 1
97 };
98 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);
99
100 enum {
101         be_pos_Reload_frame = 0,
102         be_pos_Reload_mem   = 1
103 };
104 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);
105
106 enum {
107         be_pos_Copy_orig = 0
108 };
109 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
110 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
111 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
112
113 ir_node *be_new_FrameLoad(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, entity *ent);
115 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
116                                                    ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
117 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
118
119 enum {
120         be_pos_AddSP_old_sp = 0,
121         be_pos_AddSP_size   = 1,
122         be_pos_AddSP_last   = 2
123 };
124
125 /**
126  * Make a new AddSP node.
127  * An AddSP node expresses an increase of the stack pointer in the direction the stack
128  * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
129  * given by a constant but an ordinary Firm node.
130  * @param sp     The stack pointer register.
131  * @param irg    The graph.
132  * @param bl     The block.
133  * @param old_sp The node representing the old stack pointer value.
134  * @param sz     The node expressing the size by which the stack pointer shall be grown.
135  * @return       A new AddSP node.
136  */
137 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
138
139 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);
140
141 /**
142  * Make a stack pointer increase/decrease node.
143  * @param sp     The stack pointer register.
144  * @param irg    The graph to insert the node to.
145  * @param bl     The block to insert the node into.
146  * @param old_sp The node defining the former stack pointer.
147  * @param amount The mount of bytes the stack pointer shall be increased/decreased.
148  * @param dir    The direction in which the stack pointer shall be modified:
149  *               Along the stack's growing direction or against.
150  * @return       A new stack pointer increment/decrement node.
151  * @note         This node sets a register constraint to the @p sp register on its output.
152  */
153 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);
154
155
156
157 void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
158 unsigned be_get_IncSP_offset(const ir_node *irn);
159
160 void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
161 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
162
163 entity *be_Call_get_entity(const ir_node *call);
164 void    be_Call_set_entity(ir_node *call, entity *ent);
165
166 enum {
167         be_pos_Call_mem = 0,
168         be_pos_Call_sp  = 1,
169         be_pos_Call_ptr = 2
170 };
171
172 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[]);
173 ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
174 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);
175 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
176
177 ir_node *be_new_Epilogue(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
178 ir_node *be_new_Prologue(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
179
180 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
181 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);
182
183 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);
184 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);
185
186
187 /**
188  * Get the backend opcode of a backend node.
189  * @param irn The node.
190  * @return The backend opcode.
191  */
192 be_opcode_t be_get_irn_opcode(const ir_node *irn);
193
194 int be_is_Spill(const ir_node *irn);
195 int be_is_Reload(const ir_node *irn);
196 int be_is_Copy(const ir_node *irn);
197 int be_is_Perm(const ir_node *irn);
198 int be_is_Keep(const ir_node *irn);
199 int be_is_CopyKeep(const ir_node *irn);
200 int be_is_Call(const ir_node *irn);
201 int be_is_Return(const ir_node *irn);
202 int be_is_IncSP(const ir_node *irn);
203 int be_is_SetSP(const ir_node *irn);
204 int be_is_AddSP(const ir_node *irn);
205 int be_is_RegParams(const ir_node *irn);
206 int be_is_StackParam(const ir_node *irn);
207 int be_is_FrameAddr(const ir_node *irn);
208 int be_is_FrameLoad(const ir_node *irn);
209 int be_is_FrameStore(const ir_node *irn);
210 int be_is_Epilogue(const ir_node *irn);
211 int be_is_Prologue(const ir_node *irn);
212
213 /**
214  * Get the entity on the stack frame the given node uses.
215  * @param irn The node.
216  * @return The entity on the stack frame used by the node or NULL,
217  *         if the node does not access the stack frame or is no back-end node.
218  *
219  */
220 entity *be_get_frame_entity(const ir_node *irn);
221
222 void   be_set_Spill_entity(ir_node *irn, entity *ent);
223 entity *be_get_spill_entity(const ir_node *irn);
224
225 ir_node *be_get_Spill_context(const ir_node *irn);
226
227 /**
228  * Set the entities of a Reload to the ones of the Spill it is pointing to.
229  * @param irg The graph.
230  */
231 void be_copy_entities_to_reloads(ir_graph *irg);
232
233 /**
234  * Impose a register constraint on a backend node.
235  * @param irn The node.
236  * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
237  * @param reg The register which is admissible for that node, argument/result and position.
238  */
239 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
240
241 /**
242  * Impose register constraints on a backend node.
243  * The register subsets given by the limited function in @p req are copied to the backend node.
244  * This requires that the constraint type of the @p req is arch_register_req_type_limited.
245  * @param irn The backend node.
246  * @param pos The position (@see be_set_constr_single_reg()).
247  * @param req The register requirements which shall be transferred.
248  */
249 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
250
251 /**
252  * Set the flags of a node.
253  * @param irn The node itself.
254  * @param pos The position (0..n) for arguments, (-1..-m) for results.
255  * @param flags The flags to set for that node and position.
256  */
257 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
258
259 /**
260  * Set the register class of a node.
261  * @param irn The node itself.
262  * @param pos The position (0..n) for arguments, (-1..-m) for results.
263  * @param flags The register class to set for that node and position.
264  */
265 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
266
267 /**
268  * Insert a Perm node after a specific node in the schedule.
269  * The Perm permutes over all values live at the given node.
270  * This means that all liveness intervals are cut apart at this
271  * location in the program.
272  */
273 ir_node *insert_Perm_after(const arch_env_t *env,
274                                                    const arch_register_class_t *cls,
275                                                    dom_front_info_t *dom_front,
276                                                    ir_node *pos);
277
278
279 #endif /* _BENODE_T_H */