4 * @author Sebastian Hack
6 * Backend node support.
8 * Copyright (C) 2005 Universitaet Karlsruhe
9 * Released under the GPL
15 #include "firm_config.h"
24 #define BE_OUT_POS(p) (-((p) + 1))
27 * The benode op's. Must be available to register emitter function.
29 extern ir_op *op_be_Spill;
30 extern ir_op *op_be_Reload;
31 extern ir_op *op_be_Perm;
32 extern ir_op *op_be_Copy;
33 extern ir_op *op_be_Keep;
34 extern ir_op *op_be_CopyKeep;
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;
69 /** Expresses the direction of the stack pointer increment of IncSP nodes. */
71 be_stack_dir_expand = 0,
72 be_stack_dir_shrink = 1
77 be_frame_flag_spill = 1,
78 be_frame_flag_local = 2,
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.
86 #define BE_STACK_FRAME_SIZE ((unsigned) -1)
89 * Create all BE specific opcodes.
91 void be_node_init(void);
94 * Position numbers for the be_Spill inputs.
97 be_pos_Spill_frame = 0,
102 * Make a new Spill node.
104 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);
107 * Position numbers for the be_Reload inputs.
110 be_pos_Reload_frame = 0,
111 be_pos_Reload_mem = 1
115 * Make a new Reload node.
117 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);
120 * Position numbers for the be_Copy inputs.
127 * Make a new Copy node.
129 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
130 /** Returns the Copy Argument. */
131 ir_node *be_get_Copy_op(const ir_node *cpy);
134 * Make a new Perm node.
136 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
137 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
139 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
140 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
141 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
142 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
143 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
146 * Position numbers for the be_AddSP inputs
149 be_pos_AddSP_old_sp = 0,
150 be_pos_AddSP_size = 1,
151 be_pos_AddSP_last = 2
155 * Make a new AddSP node.
156 * An AddSP node expresses an increase of the stack pointer in the direction the stack
157 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
158 * given by a constant but an ordinary Firm node.
159 * @param sp The stack pointer register.
160 * @param irg The graph.
161 * @param bl The block.
162 * @param old_sp The node representing the old stack pointer value.
163 * @param sz The node expressing the size by which the stack pointer shall be grown.
164 * @return A new AddSP node.
166 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
168 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);
171 * Make a stack pointer increase/decrease node.
172 * @param sp The stack pointer register.
173 * @param irg The graph to insert the node to.
174 * @param bl The block to insert the node into.
175 * @param old_sp The node defining the former stack pointer.
176 * @param amount The mount of bytes the stack pointer shall be increased/decreased.
177 * @param dir The direction in which the stack pointer shall be modified:
178 * Along the stack's growing direction or against.
179 * @return A new stack pointer increment/decrement node.
180 * @note This node sets a register constraint to the @p sp register on its output.
182 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);
184 /** Returns the previous node that computes the stack pointer. */
185 ir_node *be_get_IncSP_pred(ir_node *incsp);
187 /** Sets the previous node that computes the stack pointer. */
188 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
190 /** Returns the memory input of the IncSP. */
191 ir_node *be_get_IncSP_mem(ir_node *irn);
193 /** Sets a new offset to a IncSP node. */
194 void be_set_IncSP_offset(ir_node *irn, unsigned offset);
196 /** Gets the offset from a IncSP node. */
197 unsigned be_get_IncSP_offset(const ir_node *irn);
199 /** Sets a new direction to a IncSP node. */
200 void be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
202 /** Gets the direction from a IncSP node. */
203 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
205 /** Gets the call entity or NULL if this is no static call. */
206 entity *be_Call_get_entity(const ir_node *call);
207 /** Sets the call entity. */
208 void be_Call_set_entity(ir_node *call, entity *ent);
209 /** Gets the call type. */
210 ir_type *be_Call_get_type(ir_node *call);
211 /** Sets the call type. */
212 void be_Call_set_type(ir_node *call, ir_type *call_tp);
215 * Position numbers for the be_Call inputs.
218 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
219 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
220 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
221 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
225 * Projection numbers for result of be_Call node: use for Proj nodes!
228 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
229 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
233 * Construct a new be_Call
235 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
236 int n_outs, int n, ir_node *in[], ir_type *call_tp);
239 * Position numbers for the be_Return inputs.
242 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
243 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
244 be_pos_Return_val = 2, /**< first "real" return value if any */
248 * Construct a new be_Return.
249 * @param irg the graph where the new node will be placed
250 * @param bl the block where the new node will be placed
251 * @param n_res number of "real" results
252 * @param n number of inputs
253 * @param in input array
255 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
257 /** Returns the number of real returns values */
258 int be_Return_get_n_rets(ir_node *ret);
261 * Construct a new Stack Parameter node.
263 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);
264 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
266 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
268 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn, ir_node *spill_ctx);
269 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);
271 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);
272 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);
276 * Get the backend opcode of a backend node.
277 * @param irn The node.
278 * @return The backend opcode.
280 be_opcode_t be_get_irn_opcode(const ir_node *irn);
282 int be_is_Spill(const ir_node *irn);
283 int be_is_Reload(const ir_node *irn);
284 int be_is_Copy(const ir_node *irn);
285 int be_is_Perm(const ir_node *irn);
286 int be_is_Keep(const ir_node *irn);
287 int be_is_CopyKeep(const ir_node *irn);
288 int be_is_Call(const ir_node *irn);
289 int be_is_Return(const ir_node *irn);
290 int be_is_IncSP(const ir_node *irn);
291 int be_is_SetSP(const ir_node *irn);
292 int be_is_AddSP(const ir_node *irn);
293 int be_is_RegParams(const ir_node *irn);
294 int be_is_StackParam(const ir_node *irn);
295 int be_is_FrameAddr(const ir_node *irn);
296 int be_is_FrameLoad(const ir_node *irn);
297 int be_is_FrameStore(const ir_node *irn);
298 int be_is_Barrier(const ir_node *irn);
301 * Get the entity on the stack frame the given node uses.
302 * @param irn The node.
303 * @return The entity on the stack frame used by the node or NULL,
304 * if the node does not access the stack frame or is no back-end node.
307 entity *be_get_frame_entity(const ir_node *irn);
309 void be_set_Spill_entity(ir_node *irn, entity *ent);
310 entity *be_get_spill_entity(const ir_node *irn);
312 ir_node *be_get_Spill_context(const ir_node *irn);
315 * Set the entities of a Reload to the ones of the Spill it is pointing to.
316 * @param irg The graph.
318 void be_copy_entities_to_reloads(ir_graph *irg);
321 * Impose a register constraint on a backend node.
322 * @param irn The node.
323 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
324 * @param reg The register which is admissible for that node, argument/result and position.
326 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
329 * Impose register constraints on a backend node.
330 * The register subsets given by the limited function in @p req are copied to the backend node.
331 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
332 * @param irn The backend node.
333 * @param pos The position (@see be_set_constr_single_reg()).
334 * @param req The register requirements which shall be transferred.
336 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
339 * Set the flags of a node.
340 * @param irn The node itself.
341 * @param pos The position (0..n) for arguments, (-1..-m) for results.
342 * @param flags The flags to set for that node and position.
344 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
347 * Set the register class of a node.
348 * @param irn The node itself.
349 * @param pos The position (0..n) for arguments, (-1..-m) for results.
350 * @param flags The register class to set for that node and position.
352 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
355 * Make a new phi handler.
356 * @param env The architecture environment.
357 * @return A new phi handler.
359 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
362 * Free a phi handler.
363 * @param handler The handler to free.
365 void be_phi_handler_free(arch_irn_handler_t *handler);
368 * Reset the register data in the phi handler.
369 * This should be called on each new graph and deletes the register information of the current graph.
371 void be_phi_handler_reset(arch_irn_handler_t *handler);
374 * irn handler for common be nodes.
376 extern const arch_irn_handler_t be_node_irn_handler;
378 #endif /* _BENODE_T_H */