besched: Add and use sched_replace().
[libfirm] / ir / be / benode.h
index ad34f4a..44970e4 100644 (file)
@@ -22,7 +22,6 @@
  * @brief       Backend node support for generic backend nodes.
  * @author      Sebastian Hack
  * @date        17.05.2005
- * @version     $Id$
  *
  * Backend node support for generic backend nodes.
  * This file provides Perm, Copy, Spill and Reload nodes.
@@ -53,14 +52,6 @@ extern ir_op *op_be_AddSP;
 extern ir_op *op_be_SubSP;
 extern ir_op *op_be_Start;
 extern ir_op *op_be_FrameAddr;
-extern ir_op *op_be_Barrier;
-
-/**
- * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
- * It gets back-patched to the real size as soon it is known.
- */
-#define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
-#define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
 
 /**
  * Determines if irn is a be_node.
@@ -72,54 +63,57 @@ int is_be_node(const ir_node *irn);
  */
 void be_init_op(void);
 
+void be_finish_op(void);
+
 /**
  * Position numbers for the be_Spill inputs.
  */
 enum {
-       be_pos_Spill_frame = 0,
-       be_pos_Spill_val   = 1
+       n_be_Spill_frame = 0,
+       n_be_Spill_val   = 1
 };
 
 /**
  * Make a new Spill node.
  */
-ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
-       ir_node *bl, ir_node *frame, ir_node *to_spill);
+ir_node *be_new_Spill(const arch_register_class_t *cls,
+                      const arch_register_class_t *cls_frame, ir_node *block,
+                      ir_node *frame, ir_node *to_spill);
 
 /**
  * Position numbers for the be_Reload inputs.
  */
 enum {
-       be_pos_Reload_frame = 0,
-       be_pos_Reload_mem   = 1
+       n_be_Reload_frame = 0,
+       n_be_Reload_mem   = 1
 };
 
 /**
  * Make a new Reload node.
  */
-ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
-       ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
+ir_node *be_new_Reload(const arch_register_class_t *cls,
+                       const arch_register_class_t *cls_frame, ir_node *block,
+                       ir_node *frame, ir_node *mem, ir_mode *mode);
 
 /**
  * Position numbers for the be_Copy inputs.
  */
 enum {
-       be_pos_Copy_op = 0
+       n_be_Copy_op = 0
 };
 
 /**
  * Make a new Copy node.
  */
-ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block, ir_node *in);
+ir_node *be_new_Copy(ir_node *block, ir_node *in);
 /** Returns the Copy Argument. */
 ir_node *be_get_Copy_op(const ir_node *cpy);
-/** Sets the Copy Argument. */
-void be_set_Copy_op(ir_node *cpy, ir_node *op);
 
 /**
  * Make a new Perm node.
  */
-ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *bl, int arity, ir_node *in[]);
+ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *block,
+                     int n, ir_node *in[]);
 
 /**
  * Reduce a Perm.
@@ -127,30 +121,38 @@ ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *bl, int arity, i
  * map is -1, the argument gets deleted.
  * This function takes care, that the register data and the input array reflects
  * the changes described by the map.
- * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
+ * This is needed by the Perm optimization/movement in belower.c, see
+ * push_through_perm().
  * @param perm     The perm node.
- * @param new_size The new number of arguments (must be smaller or equal to the current one).
- * @param map      A map assigning each operand a new index (or -1 to indicate deletion).
+ * @param new_size The new number of arguments (must be smaller or equal to the
+ *                 current one).
+ * @param map      A map assigning each operand a new index (or -1 to indicate
+ *                 deletion).
  */
 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
 
 /**
  * Create a new MemPerm node.
+ * A MemPerm node exchanges the values of memory locations. (Typically entities
+ * used as spillslots). MemPerm nodes perform this operation without modifying
+ * any register values.
  */
-ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_node *bl, int n, ir_node *in[]);
+ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *in[]);
 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
 
-void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
+void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
+                      ir_node *node);
 
 /**
  * Position numbers for the be_FrameAddr inputs
  */
 enum {
-       be_pos_FrameAddr_ptr = 0
+       n_be_FrameAddr_ptr = 0
 };
 
 /** Create a new FrameAddr node. */
-ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_node *bl, ir_node *frame, ir_entity *ent);
+ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
+                          ir_node *block, ir_node *frame, ir_entity *ent);
 
 /** Return the frame input of a FrameAddr node. */
 ir_node *be_get_FrameAddr_frame(const ir_node *node);
@@ -161,9 +163,9 @@ ir_entity *be_get_FrameAddr_entity(const ir_node *node);
  * Position numbers for the be_AddSP inputs
  */
 enum {
-       be_pos_AddSP_old_sp = 0,
-       be_pos_AddSP_size   = 1,
-       be_pos_AddSP_last   = 2
+       n_be_AddSP_old_sp = 0,
+       n_be_AddSP_size   = 1,
+       n_be_AddSP_last   = 2
 };
 
 enum {
@@ -175,24 +177,26 @@ enum {
 
 /**
  * Make a new AddSP node.
- * An AddSP node expresses an increase of the stack pointer in the direction the stack
- * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
- * given by a constant but an ordinary Firm node.
+ * An AddSP node expresses an increase of the stack pointer in the direction
+ * the stack grows. In contrast to IncSP, the amount of bytes the stack pointer
+ * is grown, is not given by a constant but an ordinary Firm node.
  * @param sp     The stack pointer register.
- * @param bl     The block.
+ * @param block  The block.
  * @param old_sp The node representing the old stack pointer value.
- * @param sz     The node expressing the size by which the stack pointer shall be grown.
+ * @param size   The node expressing the size by which the stack pointer shall
+ *               be grown.
  * @return       A new AddSP node.
  */
-ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
+ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
+                      ir_node *old_sp, ir_node *size);
 
 /**
  * Position numbers for the be_SubSP inputs
  */
 enum {
-       be_pos_SubSP_old_sp = 0,
-       be_pos_SubSP_size   = 1,
-       be_pos_SubSP_last   = 2
+       n_be_SubSP_old_sp = 0,
+       n_be_SubSP_size   = 1,
+       n_be_SubSP_last   = 2
 };
 
 enum {
@@ -203,29 +207,35 @@ enum {
 
 /**
  * Make a new SubSP node.
- * A SubSP node expresses a decrease of the stack pointer in the direction the stack
- * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
- * given by a constant but an ordinary Firm node.
+ * A SubSP node expresses a decrease of the stack pointer in the direction the
+ * stack grows. In contrast to IncSP, the amount of bytes the stack pointer is
+ * grown, is not given by a constant but an ordinary Firm node.
  * @param sp     The stack pointer register.
- * @param bl     The block.
+ * @param block  The block.
  * @param old_sp The node representing the old stack pointer value.
- * @param sz     The node expressing the size by which the stack pointer shall be grown.
+ * @param size   The node expressing the size by which the stack pointer shall
+ *               be grown.
  * @return       A new DecSP node.
  */
-ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
+ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
+                      ir_node *old_sp, ir_node *size);
 
 /**
  * Make a stack pointer increase/decrease node.
- * @param sp     The stack pointer register. * @param irg    The graph to insert the node to.
- * @param bl     The block to insert the node into.
+ * @param sp     The stack pointer register.
+ * @param block  The block to insert the node into.
  * @param old_sp The node defining the former stack pointer.
- * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
- * @param dir    The direction in which the stack pointer shall be modified:
- *               Along the stack's growing direction or against.
+ * @param offset amount the stack should expand (positive offset) or shrink
+ *               (negative offset). Note that the offset is independent of the
+ *               natural stack direction of the architecture but just specifies
+ *               abstract expanding/shrinking of the stack area.
+ * @param align  force stack alignment to this power of 2. (ie. specifying 3
+ *               results in a 2^3 = 8byte stack alignment)
  * @return       A new stack pointer increment/decrement node.
- * @note         This node sets a register constraint to the @p sp register on its output.
+ * @note         This node sets a register constraint to the @p sp register on
+ *               its output.
  */
-ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *bl,
+ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
                       ir_node *old_sp, int offset, int align);
 
 /** Returns the previous node that computes the stack pointer. */
@@ -263,19 +273,21 @@ unsigned be_Call_get_pop(const ir_node *call);
  * Position numbers for the be_Call inputs.
  */
 enum {
-       be_pos_Call_mem       = 0,  /**< memory input of a be_Call node */
-       be_pos_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
-       be_pos_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
-       be_pos_Call_first_arg = 3   /**< first argument input of a be_Call node */
+       n_be_Call_mem       = 0,  /**< memory input of a be_Call node */
+       n_be_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
+       n_be_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
+       n_be_Call_first_arg = 3   /**< first argument input of a be_Call node */
 };
 
 /**
  * Projection numbers for result of be_Call node: use for Proj nodes!
  */
 typedef enum {
-       pn_be_Call_M_regular = pn_Call_M_regular,  /**< The memory result of a be_Call. */
-       pn_be_Call_sp        = pn_Call_max,
-       pn_be_Call_first_res                      /**< The first result proj number of a be_Call. */
+       pn_be_Call_M         = pn_Call_M, /**< The memory result of a be_Call. */
+       pn_be_Call_X_regular = pn_Call_X_regular,
+       pn_be_Call_X_except  = pn_Call_X_except,
+       pn_be_Call_sp        = pn_Call_max+1,
+       pn_be_Call_first_res     /**< The first result proj number of a be_Call. */
 } pn_be_Call;
 
 /**
@@ -283,25 +295,28 @@ typedef enum {
  *
  * @param dbg      debug info
  * @param irg      the graph where the call is placed
- * @param bl       the block where the call is placed
+ * @param block    the block where the call is placed
  * @param mem      the memory input of the call
  * @param sp       the stack pointer input of the call
- * @param ptr      the address of the called function, if immediate call set to sp
+ * @param ptr      the address of the called function, if immediate call set
+ *                 to sp
  * @param n_outs   the number of outcoming values from this call
  * @param n        the number of (register) inputs of this call
  * @param in       the (register) inputs of this call
  * @param call_tp  the call type of this call
  */
-ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
+ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
+                     const arch_register_req_t *sp_req, ir_node *sp,
+                     const arch_register_req_t *ptr_req, ir_node *ptr,
                      int n_outs, int n, ir_node *in[], ir_type *call_tp);
 
 /**
  * Position numbers for the be_Return inputs.
  */
 enum {
-       be_pos_Return_mem  = 0,     /**< memory input of a be_Return node */
-       be_pos_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
-       be_pos_Return_val  = 2,     /**< first "real" return value if any */
+       n_be_Return_mem  = 0,     /**< memory input of a be_Return node */
+       n_be_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
+       n_be_Return_val  = 2,     /**< first "real" return value if any */
 };
 
 /**
@@ -309,19 +324,21 @@ enum {
  *
  * @param dbg    debug info
  * @param irg    the graph where the new node will be placed
- * @param bl     the block where the new node will be placed
+ * @param block  the block where the new node will be placed
  * @param n_res  number of "real" results
- * @param n      number of inputs
  * @param pop    pop number of bytes on return
+ * @param n      number of inputs
  * @param in     input array
  */
-ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, unsigned pop, int n, ir_node *in[]);
+ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
+                       unsigned pop, int n, ir_node *in[]);
 
 /** Returns the number of real returns values */
 int be_Return_get_n_rets(const ir_node *ret);
 
 /**
- * Return the number of bytes that should be popped from stack when executing the Return.
+ * Return the number of bytes that should be popped from stack when executing
+ * the Return.
  *
  * @param ret  the be_Return node
  */
@@ -341,52 +358,19 @@ int be_Return_get_emit_pop(const ir_node *ret);
  */
 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
 
-/** appends a node to the return node, returns the position of the node */
-int be_Return_append_node(ir_node *ret, ir_node *node);
-
 ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
 
-ir_node *be_new_Barrier(ir_node *bl, int n, ir_node *in[]);
-
-/**
- * Appends a node to a barrier, returns the result proj of the node
- */
-ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
-
-/**
- * Make a spill node.
- *
- * @param irn       The node to be spilled.
- * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
- * @return          The new spill node.
- */
-ir_node *be_spill(ir_node *block, ir_node *irn);
-
-/**
- * Make a reload and insert it into the schedule.
- *
- * @param cls      The register class of the reloaded value.
- * @param insert   The node in the schedule in front of which the reload is inserted.
- * @param mode     The mode of the original (spilled) value.
- * @param spill    The spill node corresponding to this reload.
- * @return         A freshly made reload.
- */
-ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
-
 enum {
-       be_pos_CopyKeep_op = 0
+       n_be_CopyKeep_op = 0
 };
-ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_node *bl, ir_node *src, int n, ir_node *in_keep[], ir_mode *mode);
-ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls, ir_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);
+ir_node *be_new_CopyKeep(ir_node *block, ir_node *src,
+                         int n, ir_node *in_keep[]);
+
+ir_node *be_new_CopyKeep_single(ir_node *block, ir_node *src, ir_node *keep);
+
 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
-void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 
-/**
- * Get the backend opcode of a backend node.
- * @param irn The node.
- * @return The backend opcode.
- */
-#define be_get_irn_opcode(irn) get_irn_opcode(irn)
+void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
 
 /**
  * Returns the frame entity of a be node.
@@ -396,6 +380,8 @@ void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
  */
 ir_entity *be_get_frame_entity(const ir_node *irn);
 
+void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
+
 /**
  * Returns the frame offset of this node.
  */
@@ -418,17 +404,22 @@ int be_get_MemPerm_entity_arity(const ir_node *irn);
  * Impose a register constraint on a backend node.
  * @param irn The node.
  * @param pos The position of the argument.
- * @param reg The register which is admissible for that node, argument/result and position.
+ * @param reg The register which is admissible for that node, argument/result
+ *            and position.
  */
 void be_set_constr_single_reg_in(ir_node *irn, int pos,
                const arch_register_t *reg, arch_register_req_type_t additional_flags);
 void be_set_constr_single_reg_out(ir_node *irn, int pos,
                const arch_register_t *reg, arch_register_req_type_t additional_flags);
 
+const arch_register_req_t *be_create_reg_req(struct obstack *obst,
+               const arch_register_t *reg, arch_register_req_type_t additional_types);
+
 /**
  * Impose register constraints on a backend node.
- * The register subsets given by the limited function in @p req are copied to the backend node.
- * This requires that the constraint type of the @p req is arch_register_req_type_limited.
+ * The register subsets given by the limited function in @p req are copied to
+ * the backend node. This requires that the constraint type of the @p req is
+ * arch_register_req_type_limited.
  * @param irn The backend node.
  * @param pos The position (@see be_set_constr_single_reg()).
  * @param req The register requirements which shall be transferred.
@@ -442,26 +433,28 @@ void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
  * @param pos The position (0..n) for arguments
  * @param flags The register class to set for that node and position.
  */
-void be_node_set_reg_class_in(ir_node *irn, int pos, const arch_register_class_t *cls);
-void be_node_set_reg_class_out(ir_node *irn, int pos, const arch_register_class_t *cls);
+void be_node_set_reg_class_in(ir_node *irn, int pos,
+                              const arch_register_class_t *cls);
+void be_node_set_reg_class_out(ir_node *irn, int pos,
+                               const arch_register_class_t *cls);
 
 /**
  * Set the register requirements for a phi node.
  */
 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
 
-int be_dump_phi_reg_reqs(ir_node *node, FILE *F, dump_reason_t reason);
+void be_dump_phi_reg_reqs(FILE *out, const ir_node *node, dump_reason_t reason);
 
 /**
  * Creates a new phi with associated backend informations
  */
 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
-                    const arch_register_class_t *cls);
+                    const arch_register_req_t *req);
 
 /**
- * irn handler for common be nodes and Phi's.
+ * Search for output of start node with a specific register
  */
-const void *be_node_get_irn_ops(const ir_node *irn);
+ir_node *be_get_initial_reg_value(ir_graph *irg, const arch_register_t *reg);
 
 static inline int be_is_Spill    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill    ; }
 static inline int be_is_Reload   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload   ; }
@@ -475,8 +468,7 @@ static inline int be_is_Return   (const ir_node *irn) { return get_irn_opcode(ir
 static inline int be_is_IncSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP    ; }
 static inline int be_is_AddSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP    ; }
 static inline int be_is_SubSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP    ; }
-static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
+static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start    ; }
 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
-static inline int be_is_Barrier  (const ir_node *irn) { return get_irn_opcode(irn) == beo_Barrier  ; }
 
-#endif /* FIRM_BE_BENODE_T_H */
+#endif