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,
111 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
114 * Position numbers for the be_Reload inputs.
117 be_pos_Reload_frame = 0,
118 be_pos_Reload_mem = 1
122 * Make a new Reload node.
124 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
125 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
128 * Position numbers for the be_Copy inputs.
135 * Make a new Copy node.
137 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
138 /** Returns the Copy Argument. */
139 ir_node *be_get_Copy_op(const ir_node *cpy);
140 /** Sets the Copy Argument. */
141 void be_set_Copy_op(ir_node *cpy, ir_node *op);
144 * Make a new Perm node.
146 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
148 * Create a new MemPerm node.
150 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
151 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
153 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
155 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
156 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_entity *ent);
157 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
158 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, ir_entity *ent);
159 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
162 * Position numbers for the be_AddSP inputs
165 be_pos_AddSP_old_sp = 0,
166 be_pos_AddSP_size = 1,
167 be_pos_AddSP_last = 2
177 * Make a new AddSP node.
178 * An AddSP node expresses an increase of the stack pointer in the direction the stack
179 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
180 * given by a constant but an ordinary Firm node.
181 * @param sp The stack pointer register.
182 * @param irg The graph.
183 * @param bl The block.
184 * @param old_sp The node representing the old stack pointer value.
185 * @param sz The node expressing the size by which the stack pointer shall be grown.
186 * @return A new AddSP node.
188 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
191 * Position numbers for the be_SubSP inputs
194 be_pos_SubSP_old_sp = 0,
195 be_pos_SubSP_size = 1,
196 be_pos_SubSP_last = 2
206 * Make a new SubSP node.
207 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
208 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
209 * given by a constant but an ordinary Firm node.
210 * @param sp The stack pointer register.
211 * @param irg The graph.
212 * @param bl The block.
213 * @param old_sp The node representing the old stack pointer value.
214 * @param sz The node expressing the size by which the stack pointer shall be grown.
215 * @return A new DecSP node.
217 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
219 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);
222 * Make a stack pointer increase/decrease node.
223 * @param sp The stack pointer register.
224 * @param irg The graph to insert the node to.
225 * @param bl The block to insert the node into.
226 * @param old_sp The node defining the former stack pointer.
227 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
228 * @param dir The direction in which the stack pointer shall be modified:
229 * Along the stack's growing direction or against.
230 * @return A new stack pointer increment/decrement node.
231 * @note This node sets a register constraint to the @p sp register on its output.
233 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
235 /** Returns the previous node that computes the stack pointer. */
236 ir_node *be_get_IncSP_pred(ir_node *incsp);
238 /** Sets the previous node that computes the stack pointer. */
239 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
242 * Sets a new offset to a IncSP node.
243 * A positive offset means expanding the stack, a negative offset shrinking
244 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
245 * stackframe in the fix_stack_offsets phase.
247 void be_set_IncSP_offset(ir_node *irn, int offset);
249 /** Gets the offset from a IncSP node. */
250 int be_get_IncSP_offset(const ir_node *irn);
252 /** Gets the call entity or NULL if this is no static call. */
253 ir_entity *be_Call_get_entity(const ir_node *call);
254 /** Sets the call entity. */
255 void be_Call_set_entity(ir_node *call, ir_entity *ent);
256 /** Gets the call type. */
257 ir_type *be_Call_get_type(ir_node *call);
258 /** Sets the call type. */
259 void be_Call_set_type(ir_node *call, ir_type *call_tp);
262 * Position numbers for the be_Call inputs.
265 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
266 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
267 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
268 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
272 * Projection numbers for result of be_Call node: use for Proj nodes!
275 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
276 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
280 * Construct a new be_Call
282 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
283 int n_outs, int n, ir_node *in[], ir_type *call_tp);
286 * Position numbers for the be_Return inputs.
289 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
290 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
291 be_pos_Return_val = 2, /**< first "real" return value if any */
295 * Construct a new be_Return.
296 * @param irg the graph where the new node will be placed
297 * @param bl the block where the new node will be placed
298 * @param n_res number of "real" results
299 * @param n number of inputs
300 * @param in input array
302 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
304 /** Returns the number of real returns values */
305 int be_Return_get_n_rets(ir_node *ret);
307 /** appends a node to the return node, returns the position of the node */
308 int be_Return_append_node(ir_node *ret, ir_node *node);
311 * Construct a new Stack Parameter node.
313 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, ir_entity *ent);
314 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
316 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
319 * Appends a node to a barrier, returns the result proj of the node
321 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
324 * Appends a register out requirement to a RegParams node
326 * @returns the proj node for the new register
328 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
329 const arch_env_t *arch_env,
330 const arch_register_t *reg);
335 * @param arch_env The architecture environment.
336 * @param irn The node to be spilled.
337 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
338 * @return The new spill node.
340 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
343 * Make a reload and insert it into the schedule.
345 * @param arch_env The architecture environment.
346 * @param cls The register class of the reloaded value.
347 * @param insert The node in the schedule in front of which the reload is inserted.
348 * @param mode The mode of the original (spilled) value.
349 * @param spill The spill node corresponding to this reload.
350 * @return A freshly made reload.
352 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);
355 be_pos_CopyKeep_op = 0
357 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);
358 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);
359 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
360 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
363 * Get the backend opcode of a backend node.
364 * @param irn The node.
365 * @return The backend opcode.
367 be_opcode_t be_get_irn_opcode(const ir_node *irn);
369 int be_is_Spill(const ir_node *irn);
370 int be_is_Reload(const ir_node *irn);
371 int be_is_Copy(const ir_node *irn);
372 int be_is_Perm(const ir_node *irn);
373 int be_is_MemPerm(const ir_node *irn);
374 int be_is_Keep(const ir_node *irn);
375 int be_is_CopyKeep(const ir_node *irn);
376 int be_is_Call(const ir_node *irn);
377 int be_is_Return(const ir_node *irn);
378 int be_is_IncSP(const ir_node *irn);
379 int be_is_SetSP(const ir_node *irn);
380 int be_is_AddSP(const ir_node *irn);
381 int be_is_SubSP(const ir_node *irn);
382 int be_is_RegParams(const ir_node *irn);
383 int be_is_StackParam(const ir_node *irn);
384 int be_is_FrameAddr(const ir_node *irn);
385 int be_is_FrameLoad(const ir_node *irn);
386 int be_is_FrameStore(const ir_node *irn);
387 int be_is_Barrier(const ir_node *irn);
390 * Try to avoid this function and better call arch_get_frame_entity!
392 * Returns the frame entity used by the be node
394 ir_entity *be_get_frame_entity(const ir_node *irn);
397 * Returns the frame offset of this node.
399 int be_get_frame_offset(const ir_node *irn);
401 ir_node* be_get_Reload_mem(const ir_node *irn);
402 ir_node *be_get_Reload_frame(const ir_node *irn);
403 ir_node* be_get_Spill_val(const ir_node *irn);
404 ir_node *be_get_Spill_frame(const ir_node *irn);
406 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
407 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
409 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
410 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
412 int be_get_MemPerm_entity_arity(const ir_node *irn);
415 * Impose a register constraint on a backend node.
416 * @param irn The node.
417 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
418 * @param reg The register which is admissible for that node, argument/result and position.
420 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
423 * Impose register constraints on a backend node.
424 * The register subsets given by the limited function in @p req are copied to the backend node.
425 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
426 * @param irn The backend node.
427 * @param pos The position (@see be_set_constr_single_reg()).
428 * @param req The register requirements which shall be transferred.
430 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
433 * Set the flags of a node.
434 * @param irn The node itself.
435 * @param pos The position (0..n) for arguments, (-1..-m) for results.
436 * @param flags The flags to set for that node and position.
438 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
441 * Set the register class of a node.
442 * @param irn The node itself.
443 * @param pos The position (0..n) for arguments, (-1..-m) for results.
444 * @param flags The register class to set for that node and position.
446 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
449 * Set the register requirement type of a node.
450 * @param irn The node itself.
451 * @param pos The position (0..n) for arguments, (-1..-m) for results.
452 * @param flags The register requirement type to set for that node and position.
454 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
457 * Make a new phi handler.
458 * @param env The architecture environment.
459 * @return A new phi handler.
461 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
464 * Free a phi handler.
465 * @param handler The handler to free.
467 void be_phi_handler_free(arch_irn_handler_t *handler);
470 * Reset the register data in the phi handler.
471 * This should be called on each new graph and deletes the register information of the current graph.
473 void be_phi_handler_reset(arch_irn_handler_t *handler);
476 * Set the register requirements for a phi node.
478 void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
479 const arch_register_req_t *req);
482 * Set flags for a phi node
484 void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
485 arch_irn_flags_t flags);
488 * irn handler for common be nodes.
490 extern const arch_irn_handler_t be_node_irn_handler;
492 #endif /* _BENODE_T_H */