4 * @author Sebastian Hack
6 * Backend node support.
8 * Copyright (C) 2005 Universitaet Karlsruhe
9 * Released under the GPL
15 #include "firm_config.h"
26 #define BE_OUT_POS(p) (-((p) + 1))
29 * The benode op's. Must be available to register emitter function.
31 extern ir_op *op_be_Spill;
32 extern ir_op *op_be_Reload;
33 extern ir_op *op_be_Perm;
34 extern ir_op *op_be_MemPerm;
35 extern ir_op *op_be_Copy;
36 extern ir_op *op_be_Keep;
37 extern ir_op *op_be_CopyKeep;
38 extern ir_op *op_be_Call;
39 extern ir_op *op_be_Return;
40 extern ir_op *op_be_IncSP;
41 extern ir_op *op_be_AddSP;
42 extern ir_op *op_be_SetSP;
43 extern ir_op *op_be_RegParams;
44 extern ir_op *op_be_StackParam;
45 extern ir_op *op_be_FrameAddr;
46 extern ir_op *op_be_FrameLoad;
47 extern ir_op *op_be_FrameStore;
48 extern ir_op *op_be_Barrier;
75 be_frame_flag_spill = 1,
76 be_frame_flag_local = 2,
81 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
82 * It gets back-patched to the real size as soon it is known.
84 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
85 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
88 * Determines if irn is a be_node.
90 int is_be_node(const ir_node *irn);
93 * Create all BE specific opcodes.
95 void be_node_init(void);
98 * Position numbers for the be_Spill inputs.
101 be_pos_Spill_frame = 0,
106 * Make a new Spill node.
108 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);
111 * Position numbers for the be_Reload inputs.
114 be_pos_Reload_frame = 0,
115 be_pos_Reload_mem = 1
119 * Make a new Reload node.
121 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);
124 * Position numbers for the be_Copy inputs.
131 * Make a new Copy node.
133 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
134 /** Returns the Copy Argument. */
135 ir_node *be_get_Copy_op(const ir_node *cpy);
136 /** Sets the Copy Argument. */
137 void be_set_Copy_op(ir_node *cpy, ir_node *op);
140 * Make a new Perm node.
142 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
144 * Create a new MemPerm node.
146 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
147 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
149 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
150 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
151 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
152 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
153 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
156 * Position numbers for the be_AddSP inputs
159 be_pos_AddSP_old_sp = 0,
160 be_pos_AddSP_size = 1,
161 be_pos_AddSP_last = 2
171 * Make a new AddSP node.
172 * An AddSP node expresses an increase of the stack pointer in the direction the stack
173 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
174 * given by a constant but an ordinary Firm node.
175 * @param sp The stack pointer register.
176 * @param irg The graph.
177 * @param bl The block.
178 * @param old_sp The node representing the old stack pointer value.
179 * @param sz The node expressing the size by which the stack pointer shall be grown.
180 * @return A new AddSP node.
182 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
184 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);
187 * Make a stack pointer increase/decrease node.
188 * @param sp The stack pointer register.
189 * @param irg The graph to insert the node to.
190 * @param bl The block to insert the node into.
191 * @param old_sp The node defining the former stack pointer.
192 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
193 * @param dir The direction in which the stack pointer shall be modified:
194 * Along the stack's growing direction or against.
195 * @return A new stack pointer increment/decrement node.
196 * @note This node sets a register constraint to the @p sp register on its output.
198 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
200 /** Returns the previous node that computes the stack pointer. */
201 ir_node *be_get_IncSP_pred(ir_node *incsp);
203 /** Sets the previous node that computes the stack pointer. */
204 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
207 * Sets a new offset to a IncSP node.
208 * A positive offset means expanding the stack, a negative offset shrinking
209 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
210 * stackframe in the fix_stack_offsets phase.
212 void be_set_IncSP_offset(ir_node *irn, int offset);
214 /** Gets the offset from a IncSP node. */
215 int be_get_IncSP_offset(const ir_node *irn);
217 /** Gets the call entity or NULL if this is no static call. */
218 entity *be_Call_get_entity(const ir_node *call);
219 /** Sets the call entity. */
220 void be_Call_set_entity(ir_node *call, entity *ent);
221 /** Gets the call type. */
222 ir_type *be_Call_get_type(ir_node *call);
223 /** Sets the call type. */
224 void be_Call_set_type(ir_node *call, ir_type *call_tp);
227 * Position numbers for the be_Call inputs.
230 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
231 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
232 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
233 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
237 * Projection numbers for result of be_Call node: use for Proj nodes!
240 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
241 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
245 * Construct a new be_Call
247 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
248 int n_outs, int n, ir_node *in[], ir_type *call_tp);
251 * Position numbers for the be_Return inputs.
254 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
255 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
256 be_pos_Return_val = 2, /**< first "real" return value if any */
260 * Construct a new be_Return.
261 * @param irg the graph where the new node will be placed
262 * @param bl the block where the new node will be placed
263 * @param n_res number of "real" results
264 * @param n number of inputs
265 * @param in input array
267 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
269 /** Returns the number of real returns values */
270 int be_Return_get_n_rets(ir_node *ret);
273 * Construct a new Stack Parameter node.
275 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);
276 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
278 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
283 * @param arch_env The architecture environment.
284 * @param irn The node to be spilled.
285 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
286 * @return The new spill node.
288 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
291 * Make a reload and insert it into the schedule.
293 * @param arch_env The architecture environment.
294 * @param cls The register class of the reloaded value.
295 * @param insert The node in the schedule in front of which the reload is inserted.
296 * @param mode The mode of the original (spilled) value.
297 * @param spill The spill node corresponding to this reload.
298 * @return A freshly made reload.
300 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);
303 be_pos_CopyKeep_op = 0
305 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);
306 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);
307 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
308 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
311 * Get the backend opcode of a backend node.
312 * @param irn The node.
313 * @return The backend opcode.
315 be_opcode_t be_get_irn_opcode(const ir_node *irn);
317 int be_is_Spill(const ir_node *irn);
318 int be_is_Reload(const ir_node *irn);
319 int be_is_Copy(const ir_node *irn);
320 int be_is_Perm(const ir_node *irn);
321 int be_is_MemPerm(const ir_node *irn);
322 int be_is_Keep(const ir_node *irn);
323 int be_is_CopyKeep(const ir_node *irn);
324 int be_is_Call(const ir_node *irn);
325 int be_is_Return(const ir_node *irn);
326 int be_is_IncSP(const ir_node *irn);
327 int be_is_SetSP(const ir_node *irn);
328 int be_is_AddSP(const ir_node *irn);
329 int be_is_RegParams(const ir_node *irn);
330 int be_is_StackParam(const ir_node *irn);
331 int be_is_FrameAddr(const ir_node *irn);
332 int be_is_FrameLoad(const ir_node *irn);
333 int be_is_FrameStore(const ir_node *irn);
334 int be_is_Barrier(const ir_node *irn);
337 * Try to avoid this function and better call arch_get_frame_entity!
339 * Returns the frame entity used by the be node
341 entity* be_get_frame_entity(const ir_node *irn);
343 ir_node* be_get_Reload_mem(const ir_node *irn);
344 ir_node* be_get_Reload_frame(const ir_node* irn);
346 ir_node* be_get_Spill_val(const ir_node *irn);
347 ir_node* be_get_Spill_frame(const ir_node* irn);
349 void be_set_MemPerm_in_entity(const ir_node *irn, int n, entity* ent);
350 entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
352 void be_set_MemPerm_out_entity(const ir_node *irn, int n, entity* ent);
353 entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
355 int be_get_MemPerm_entity_arity(const ir_node *irn);
358 * Impose a register constraint on a backend node.
359 * @param irn The node.
360 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
361 * @param reg The register which is admissible for that node, argument/result and position.
363 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
366 * Impose register constraints on a backend node.
367 * The register subsets given by the limited function in @p req are copied to the backend node.
368 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
369 * @param irn The backend node.
370 * @param pos The position (@see be_set_constr_single_reg()).
371 * @param req The register requirements which shall be transferred.
373 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
376 * Set the flags of a node.
377 * @param irn The node itself.
378 * @param pos The position (0..n) for arguments, (-1..-m) for results.
379 * @param flags The flags to set for that node and position.
381 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
384 * Set the register class of a node.
385 * @param irn The node itself.
386 * @param pos The position (0..n) for arguments, (-1..-m) for results.
387 * @param flags The register class to set for that node and position.
389 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
392 * Make a new phi handler.
393 * @param env The architecture environment.
394 * @return A new phi handler.
396 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
399 * Free a phi handler.
400 * @param handler The handler to free.
402 void be_phi_handler_free(arch_irn_handler_t *handler);
405 * Reset the register data in the phi handler.
406 * This should be called on each new graph and deletes the register information of the current graph.
408 void be_phi_handler_reset(arch_irn_handler_t *handler);
411 * irn handler for common be nodes.
413 extern const arch_irn_handler_t be_node_irn_handler;
415 #endif /* _BENODE_T_H */