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_SubSP;
43 extern ir_op *op_be_SetSP;
44 extern ir_op *op_be_RegParams;
45 extern ir_op *op_be_StackParam;
46 extern ir_op *op_be_FrameAddr;
47 extern ir_op *op_be_FrameLoad;
48 extern ir_op *op_be_FrameStore;
49 extern ir_op *op_be_Barrier;
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_EXPAND INT_MAX
87 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
90 * Determines if irn is a be_node.
92 int is_be_node(const ir_node *irn);
95 * Create all BE specific opcodes.
97 void be_node_init(void);
100 * Position numbers for the be_Spill inputs.
103 be_pos_Spill_frame = 0,
108 * Make a new Spill node.
110 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);
113 * Position numbers for the be_Reload inputs.
116 be_pos_Reload_frame = 0,
117 be_pos_Reload_mem = 1
121 * Make a new Reload node.
123 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);
126 * Position numbers for the be_Copy inputs.
133 * Make a new Copy node.
135 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
136 /** Returns the Copy Argument. */
137 ir_node *be_get_Copy_op(const ir_node *cpy);
138 /** Sets the Copy Argument. */
139 void be_set_Copy_op(ir_node *cpy, ir_node *op);
142 * Make a new Perm node.
144 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
146 * Create a new MemPerm node.
148 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
149 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
151 ir_node *be_new_FrameLoad(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, entity *ent);
153 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
154 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
155 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
158 * Position numbers for the be_AddSP inputs
161 be_pos_AddSP_old_sp = 0,
162 be_pos_AddSP_size = 1,
163 be_pos_AddSP_last = 2
173 * Make a new AddSP node.
174 * An AddSP node expresses an increase of the stack pointer in the direction the stack
175 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
176 * given by a constant but an ordinary Firm node.
177 * @param sp The stack pointer register.
178 * @param irg The graph.
179 * @param bl The block.
180 * @param old_sp The node representing the old stack pointer value.
181 * @param sz The node expressing the size by which the stack pointer shall be grown.
182 * @return A new AddSP node.
184 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
187 * Position numbers for the be_SubSP inputs
190 be_pos_SubSP_old_sp = 0,
191 be_pos_SubSP_size = 1,
192 be_pos_SubSP_last = 2
202 * Make a new SubSP node.
203 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
204 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
205 * given by a constant but an ordinary Firm node.
206 * @param sp The stack pointer register.
207 * @param irg The graph.
208 * @param bl The block.
209 * @param old_sp The node representing the old stack pointer value.
210 * @param sz The node expressing the size by which the stack pointer shall be grown.
211 * @return A new DecSP node.
213 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
215 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);
218 * Make a stack pointer increase/decrease node.
219 * @param sp The stack pointer register.
220 * @param irg The graph to insert the node to.
221 * @param bl The block to insert the node into.
222 * @param old_sp The node defining the former stack pointer.
223 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
224 * @param dir The direction in which the stack pointer shall be modified:
225 * Along the stack's growing direction or against.
226 * @return A new stack pointer increment/decrement node.
227 * @note This node sets a register constraint to the @p sp register on its output.
229 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
231 /** Returns the previous node that computes the stack pointer. */
232 ir_node *be_get_IncSP_pred(ir_node *incsp);
234 /** Sets the previous node that computes the stack pointer. */
235 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
238 * Sets a new offset to a IncSP node.
239 * A positive offset means expanding the stack, a negative offset shrinking
240 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
241 * stackframe in the fix_stack_offsets phase.
243 void be_set_IncSP_offset(ir_node *irn, int offset);
245 /** Gets the offset from a IncSP node. */
246 int be_get_IncSP_offset(const ir_node *irn);
248 /** Gets the call entity or NULL if this is no static call. */
249 entity *be_Call_get_entity(const ir_node *call);
250 /** Sets the call entity. */
251 void be_Call_set_entity(ir_node *call, entity *ent);
252 /** Gets the call type. */
253 ir_type *be_Call_get_type(ir_node *call);
254 /** Sets the call type. */
255 void be_Call_set_type(ir_node *call, ir_type *call_tp);
258 * Position numbers for the be_Call inputs.
261 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
262 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
263 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
264 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
268 * Projection numbers for result of be_Call node: use for Proj nodes!
271 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
272 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
276 * Construct a new be_Call
278 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
279 int n_outs, int n, ir_node *in[], ir_type *call_tp);
282 * Position numbers for the be_Return inputs.
285 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
286 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
287 be_pos_Return_val = 2, /**< first "real" return value if any */
291 * Construct a new be_Return.
292 * @param irg the graph where the new node will be placed
293 * @param bl the block where the new node will be placed
294 * @param n_res number of "real" results
295 * @param n number of inputs
296 * @param in input array
298 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
300 /** Returns the number of real returns values */
301 int be_Return_get_n_rets(ir_node *ret);
304 * Construct a new Stack Parameter node.
306 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);
307 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
309 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
314 * @param arch_env The architecture environment.
315 * @param irn The node to be spilled.
316 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
317 * @return The new spill node.
319 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
322 * Make a reload and insert it into the schedule.
324 * @param arch_env The architecture environment.
325 * @param cls The register class of the reloaded value.
326 * @param insert The node in the schedule in front of which the reload is inserted.
327 * @param mode The mode of the original (spilled) value.
328 * @param spill The spill node corresponding to this reload.
329 * @return A freshly made reload.
331 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);
334 be_pos_CopyKeep_op = 0
336 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);
337 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);
338 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
339 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
342 * Get the backend opcode of a backend node.
343 * @param irn The node.
344 * @return The backend opcode.
346 be_opcode_t be_get_irn_opcode(const ir_node *irn);
348 int be_is_Spill(const ir_node *irn);
349 int be_is_Reload(const ir_node *irn);
350 int be_is_Copy(const ir_node *irn);
351 int be_is_Perm(const ir_node *irn);
352 int be_is_MemPerm(const ir_node *irn);
353 int be_is_Keep(const ir_node *irn);
354 int be_is_CopyKeep(const ir_node *irn);
355 int be_is_Call(const ir_node *irn);
356 int be_is_Return(const ir_node *irn);
357 int be_is_IncSP(const ir_node *irn);
358 int be_is_SetSP(const ir_node *irn);
359 int be_is_AddSP(const ir_node *irn);
360 int be_is_RegParams(const ir_node *irn);
361 int be_is_StackParam(const ir_node *irn);
362 int be_is_FrameAddr(const ir_node *irn);
363 int be_is_FrameLoad(const ir_node *irn);
364 int be_is_FrameStore(const ir_node *irn);
365 int be_is_Barrier(const ir_node *irn);
368 * Try to avoid this function and better call arch_get_frame_entity!
370 * Returns the frame entity used by the be node
372 entity* be_get_frame_entity(const ir_node *irn);
374 ir_node* be_get_Reload_mem(const ir_node *irn);
375 ir_node* be_get_Reload_frame(const ir_node* irn);
377 ir_node* be_get_Spill_val(const ir_node *irn);
378 ir_node* be_get_Spill_frame(const ir_node* irn);
380 void be_set_MemPerm_in_entity(const ir_node *irn, int n, entity* ent);
381 entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
383 void be_set_MemPerm_out_entity(const ir_node *irn, int n, entity* ent);
384 entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
386 int be_get_MemPerm_entity_arity(const ir_node *irn);
389 * Impose a register constraint on a backend node.
390 * @param irn The node.
391 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
392 * @param reg The register which is admissible for that node, argument/result and position.
394 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
397 * Impose register constraints on a backend node.
398 * The register subsets given by the limited function in @p req are copied to the backend node.
399 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
400 * @param irn The backend node.
401 * @param pos The position (@see be_set_constr_single_reg()).
402 * @param req The register requirements which shall be transferred.
404 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
407 * Set the flags of a node.
408 * @param irn The node itself.
409 * @param pos The position (0..n) for arguments, (-1..-m) for results.
410 * @param flags The flags to set for that node and position.
412 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
415 * Set the register class of a node.
416 * @param irn The node itself.
417 * @param pos The position (0..n) for arguments, (-1..-m) for results.
418 * @param flags The register class to set for that node and position.
420 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
423 * Make a new phi handler.
424 * @param env The architecture environment.
425 * @return A new phi handler.
427 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
430 * Free a phi handler.
431 * @param handler The handler to free.
433 void be_phi_handler_free(arch_irn_handler_t *handler);
436 * Reset the register data in the phi handler.
437 * This should be called on each new graph and deletes the register information of the current graph.
439 void be_phi_handler_reset(arch_irn_handler_t *handler);
442 * irn handler for common be nodes.
444 extern const arch_irn_handler_t be_node_irn_handler;
446 #endif /* _BENODE_T_H */