4 * @author Sebastian Hack
6 * Backend node support.
8 * Copyright (C) 2005 Universitaet Karlsruhe
9 * Released under the GPL
15 #include "firm_config.h"
25 #define BE_OUT_POS(p) (-((p) + 1))
28 * The benode op's. Must be available to register emitter function.
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;
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 be_pos_Spill_frame = 0,
97 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);
100 be_pos_Reload_frame = 0,
101 be_pos_Reload_mem = 1
103 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);
108 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
109 ir_node *be_get_Copy_op(const ir_node *cpy);
111 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
112 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
114 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
115 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
116 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
117 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
118 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
121 be_pos_AddSP_old_sp = 0,
122 be_pos_AddSP_size = 1,
123 be_pos_AddSP_last = 2
127 * Make a new AddSP node.
128 * An AddSP node expresses an increase of the stack pointer in the direction the stack
129 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
130 * given by a constant but an ordinary Firm node.
131 * @param sp The stack pointer register.
132 * @param irg The graph.
133 * @param bl The block.
134 * @param old_sp The node representing the old stack pointer value.
135 * @param sz The node expressing the size by which the stack pointer shall be grown.
136 * @return A new AddSP node.
138 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
140 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);
143 * Make a stack pointer increase/decrease node.
144 * @param sp The stack pointer register.
145 * @param irg The graph to insert the node to.
146 * @param bl The block to insert the node into.
147 * @param old_sp The node defining the former stack pointer.
148 * @param amount The mount of bytes the stack pointer shall be increased/decreased.
149 * @param dir The direction in which the stack pointer shall be modified:
150 * Along the stack's growing direction or against.
151 * @return A new stack pointer increment/decrement node.
152 * @note This node sets a register constraint to the @p sp register on its output.
154 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);
156 /** Returns the previous node that computes the stack pointer. */
157 ir_node *be_get_IncSP_pred(ir_node *incsp);
159 /** Sets a new offset to a IncSP node. */
160 void be_set_IncSP_offset(ir_node *irn, unsigned offset);
162 /** Gets the offset from a IncSP node. */
163 unsigned be_get_IncSP_offset(const ir_node *irn);
165 /** Sets a new direction to a IncSP node. */
166 void be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
168 /** Gets the direction from a IncSP node. */
169 be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
171 /** Gets the call entity or NULL if this is no static call. */
172 entity *be_Call_get_entity(const ir_node *call);
173 /** Sets the call entity. */
174 void be_Call_set_entity(ir_node *call, entity *ent);
175 /** Gets the call type. */
176 ir_type *be_Call_get_type(ir_node *call);
177 /** Sets the call type. */
178 void be_Call_set_type(ir_node *call, ir_type *call_tp);
181 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
182 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
183 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
184 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
188 * Projection numbers for result of be_Call node: use for Proj nodes!
191 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
192 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
196 * Construct a new be_Call
198 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
199 int n_outs, int n, ir_node *in[], ir_type *call_tp);
202 * Construct a new be_Return
204 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
205 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);
206 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
208 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
210 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
211 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);
213 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);
214 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);
218 * Get the backend opcode of a backend node.
219 * @param irn The node.
220 * @return The backend opcode.
222 be_opcode_t be_get_irn_opcode(const ir_node *irn);
224 int be_is_Spill(const ir_node *irn);
225 int be_is_Reload(const ir_node *irn);
226 int be_is_Copy(const ir_node *irn);
227 int be_is_Perm(const ir_node *irn);
228 int be_is_Keep(const ir_node *irn);
229 int be_is_CopyKeep(const ir_node *irn);
230 int be_is_Call(const ir_node *irn);
231 int be_is_Return(const ir_node *irn);
232 int be_is_IncSP(const ir_node *irn);
233 int be_is_SetSP(const ir_node *irn);
234 int be_is_AddSP(const ir_node *irn);
235 int be_is_RegParams(const ir_node *irn);
236 int be_is_StackParam(const ir_node *irn);
237 int be_is_FrameAddr(const ir_node *irn);
238 int be_is_FrameLoad(const ir_node *irn);
239 int be_is_FrameStore(const ir_node *irn);
240 int be_is_Barrier(const ir_node *irn);
243 * Get the entity on the stack frame the given node uses.
244 * @param irn The node.
245 * @return The entity on the stack frame used by the node or NULL,
246 * if the node does not access the stack frame or is no back-end node.
249 entity *be_get_frame_entity(const ir_node *irn);
251 void be_set_Spill_entity(ir_node *irn, entity *ent);
252 entity *be_get_spill_entity(const ir_node *irn);
254 ir_node *be_get_Spill_context(const ir_node *irn);
257 * Set the entities of a Reload to the ones of the Spill it is pointing to.
258 * @param irg The graph.
260 void be_copy_entities_to_reloads(ir_graph *irg);
263 * Impose a register constraint on a backend node.
264 * @param irn The node.
265 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
266 * @param reg The register which is admissible for that node, argument/result and position.
268 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
271 * Impose register constraints on a backend node.
272 * The register subsets given by the limited function in @p req are copied to the backend node.
273 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
274 * @param irn The backend node.
275 * @param pos The position (@see be_set_constr_single_reg()).
276 * @param req The register requirements which shall be transferred.
278 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
281 * Set the flags of a node.
282 * @param irn The node itself.
283 * @param pos The position (0..n) for arguments, (-1..-m) for results.
284 * @param flags The flags to set for that node and position.
286 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
289 * Set the register class of a node.
290 * @param irn The node itself.
291 * @param pos The position (0..n) for arguments, (-1..-m) for results.
292 * @param flags The register class to set for that node and position.
294 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
297 * Make a new phi handler.
298 * @param env The architecture environment.
299 * @return A new phi handler.
301 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
304 * Free a phi handler.
305 * @param handler The handler to free.
307 void be_phi_handler_free(arch_irn_handler_t *handler);
310 * Reset the register data in the phi handler.
311 * This should be called on each new graph and deletes the register information of the current graph.
313 void be_phi_handler_reset(arch_irn_handler_t *handler);
316 * irn handler for common be nodes.
318 extern const arch_irn_handler_t be_node_irn_handler;
320 #endif /* _BENODE_T_H */