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 * Determines if irn is a be_node.
91 int is_be_node(const ir_node *irn);
94 * Create all BE specific opcodes.
96 void be_node_init(void);
99 * Position numbers for the be_Spill inputs.
102 be_pos_Spill_frame = 0,
107 * Make a new Spill node.
109 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);
112 * Position numbers for the be_Reload inputs.
115 be_pos_Reload_frame = 0,
116 be_pos_Reload_mem = 1
120 * Make a new Reload node.
122 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);
125 * Position numbers for the be_Copy inputs.
132 * Make a new Copy node.
134 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
135 /** Returns the Copy Argument. */
136 ir_node *be_get_Copy_op(const ir_node *cpy);
137 /** Sets the Copy Argument. */
138 void be_set_Copy_op(ir_node *cpy, ir_node *op);
141 * Make a new Perm node.
143 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
144 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
146 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
147 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
148 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
149 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
150 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
153 * Position numbers for the be_AddSP inputs
156 be_pos_AddSP_old_sp = 0,
157 be_pos_AddSP_size = 1,
158 be_pos_AddSP_last = 2
162 * Make a new AddSP node.
163 * An AddSP node expresses an increase of the stack pointer in the direction the stack
164 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
165 * given by a constant but an ordinary Firm node.
166 * @param sp The stack pointer register.
167 * @param irg The graph.
168 * @param bl The block.
169 * @param old_sp The node representing the old stack pointer value.
170 * @param sz The node expressing the size by which the stack pointer shall be grown.
171 * @return A new AddSP node.
173 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
175 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);
178 * Make a stack pointer increase/decrease node.
179 * @param sp The stack pointer register.
180 * @param irg The graph to insert the node to.
181 * @param bl The block to insert the node into.
182 * @param old_sp The node defining the former stack pointer.
183 * @param amount The mount of bytes the stack pointer shall be increased/decreased.
184 * @param dir The direction in which the stack pointer shall be modified:
185 * Along the stack's growing direction or against.
186 * @return A new stack pointer increment/decrement node.
187 * @note This node sets a register constraint to the @p sp register on its output.
189 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);
191 /** Returns the previous node that computes the stack pointer. */
192 ir_node *be_get_IncSP_pred(ir_node *incsp);
194 /** Sets the previous node that computes the stack pointer. */
195 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
197 /** Returns the memory input of the IncSP. */
198 ir_node *be_get_IncSP_mem(ir_node *irn);
200 /** Sets a new offset to a IncSP node. */
201 void be_set_IncSP_offset(ir_node *irn, unsigned offset);
203 /** Gets the offset from a IncSP node. */
204 unsigned be_get_IncSP_offset(const ir_node *irn);
206 /** Sets a new direction to a IncSP node. */
207 void be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
209 /** Gets the direction from a IncSP node. */
210 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
212 /** Gets the call entity or NULL if this is no static call. */
213 entity *be_Call_get_entity(const ir_node *call);
214 /** Sets the call entity. */
215 void be_Call_set_entity(ir_node *call, entity *ent);
216 /** Gets the call type. */
217 ir_type *be_Call_get_type(ir_node *call);
218 /** Sets the call type. */
219 void be_Call_set_type(ir_node *call, ir_type *call_tp);
222 * Position numbers for the be_Call inputs.
225 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
226 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
227 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
228 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
232 * Projection numbers for result of be_Call node: use for Proj nodes!
235 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
236 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
240 * Construct a new be_Call
242 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
243 int n_outs, int n, ir_node *in[], ir_type *call_tp);
246 * Position numbers for the be_Return inputs.
249 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
250 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
251 be_pos_Return_val = 2, /**< first "real" return value if any */
255 * Construct a new be_Return.
256 * @param irg the graph where the new node will be placed
257 * @param bl the block where the new node will be placed
258 * @param n_res number of "real" results
259 * @param n number of inputs
260 * @param in input array
262 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
264 /** Returns the number of real returns values */
265 int be_Return_get_n_rets(ir_node *ret);
268 * Construct a new Stack Parameter node.
270 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);
271 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
273 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
278 * @param arch_env The architecture environment.
279 * @param irn The node to be spilled.
280 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
281 * @return The new spill node.
283 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn, ir_node *spill_ctx);
286 * Make a reload and insert it into the schedule.
288 * @param arch_env The architecture environment.
289 * @param cls The register class of the reloaded value.
290 * @param insert The node in the schedule in front of which the reload is inserted.
291 * @param mode The mode of the original (spilled) value.
292 * @param spill The spill node corresponding to this reload.
293 * @return A freshly made reload.
295 ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
298 be_pos_CopyKeep_op = 0
300 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);
301 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);
302 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
303 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
306 * Get the backend opcode of a backend node.
307 * @param irn The node.
308 * @return The backend opcode.
310 be_opcode_t be_get_irn_opcode(const ir_node *irn);
312 int be_is_Spill(const ir_node *irn);
313 int be_is_Reload(const ir_node *irn);
314 int be_is_Copy(const ir_node *irn);
315 int be_is_Perm(const ir_node *irn);
316 int be_is_Keep(const ir_node *irn);
317 int be_is_CopyKeep(const ir_node *irn);
318 int be_is_Call(const ir_node *irn);
319 int be_is_Return(const ir_node *irn);
320 int be_is_IncSP(const ir_node *irn);
321 int be_is_SetSP(const ir_node *irn);
322 int be_is_AddSP(const ir_node *irn);
323 int be_is_RegParams(const ir_node *irn);
324 int be_is_StackParam(const ir_node *irn);
325 int be_is_FrameAddr(const ir_node *irn);
326 int be_is_FrameLoad(const ir_node *irn);
327 int be_is_FrameStore(const ir_node *irn);
328 int be_is_Barrier(const ir_node *irn);
331 * Get the entity on the stack frame the given node uses.
332 * @param irn The node.
333 * @return The entity on the stack frame used by the node or NULL,
334 * if the node does not access the stack frame or is no back-end node.
337 entity *be_get_frame_entity(const ir_node *irn);
339 void be_set_Spill_entity(ir_node *irn, entity *ent);
340 entity *be_get_spill_entity(const ir_node *irn);
342 void be_set_Spill_context(ir_node *irn, ir_node *ctx);
343 ir_node *be_get_Spill_context(const ir_node *irn);
346 ir_node* be_get_Reload_mem(const ir_node *irn);
347 ir_node* be_get_Reload_frame(const ir_node* irn);
350 * Set the entities of a Reload to the ones of the Spill it is pointing to.
351 * @param irg The graph.
353 void be_copy_entities_to_reloads(ir_graph *irg);
356 * Impose a register constraint on a backend node.
357 * @param irn The node.
358 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
359 * @param reg The register which is admissible for that node, argument/result and position.
361 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
364 * Impose register constraints on a backend node.
365 * The register subsets given by the limited function in @p req are copied to the backend node.
366 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
367 * @param irn The backend node.
368 * @param pos The position (@see be_set_constr_single_reg()).
369 * @param req The register requirements which shall be transferred.
371 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
374 * Set the flags of a node.
375 * @param irn The node itself.
376 * @param pos The position (0..n) for arguments, (-1..-m) for results.
377 * @param flags The flags to set for that node and position.
379 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
382 * Set the register class of a node.
383 * @param irn The node itself.
384 * @param pos The position (0..n) for arguments, (-1..-m) for results.
385 * @param flags The register class to set for that node and position.
387 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
390 * Make a new phi handler.
391 * @param env The architecture environment.
392 * @return A new phi handler.
394 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
397 * Free a phi handler.
398 * @param handler The handler to free.
400 void be_phi_handler_free(arch_irn_handler_t *handler);
403 * Reset the register data in the phi handler.
404 * This should be called on each new graph and deletes the register information of the current graph.
406 void be_phi_handler_reset(arch_irn_handler_t *handler);
409 * irn handler for common be nodes.
411 extern const arch_irn_handler_t be_node_irn_handler;
413 #endif /* _BENODE_T_H */