typo fixed

[libfirm] / ir / be / beabi.h

diff --git a/ir/be/beabi.h b/ir/be/beabi.h
index 4bc1563..da06899 100644 (file)
--- a/ir/be/beabi.h
+++ b/ir/be/beabi.h
@@ -65,7 +65,7 @@ struct _be_abi_callbacks_t {
         * Generate the prologue.
         * @param self    The callback object.
         * @param mem     A pointer to the mem node. Update this if you define new memory.
-        * @param reg_map A mapping mapping all callee_save/ignore/parameter registers to their defining nodes.
+        * @param reg_map A map mapping all callee_save/ignore/parameter registers to their defining nodes.
         * @return        The register which shall be used as a stack frame base.
         *
         * All nodes which define registers in @p reg_map must keep @p reg_map current.
@@ -82,6 +82,8 @@ struct _be_abi_callbacks_t {
         * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
         */
        void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
+
+       int (*collect_stack_phis)(void *self);
 };
 
 /**
@@ -122,9 +124,16 @@ ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 
 be_abi_irg_t *be_abi_introduce(be_irg_t *bi);
 void be_abi_fix_stack_bias(be_abi_irg_t *env);
-void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv);
 void be_abi_free(be_abi_irg_t *abi);
 
+/**
+ * Rewire all stack modifying nodes and their users to assure SSA property.
+ * @param env   The abi
+ * @param lv    Liveness object, so the liveness of changed and newly introduces nodes
+ *              can be recomputed. Maybe NULL (no liveness information update then)
+ */
+void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv);
+
 /**
  * Put the registers which are forbidden specifically for this IRG in a bitset.
  */
@@ -137,6 +146,7 @@ ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi);
 #define be_abi_reg_map_get(map, reg)      pmap_get((map), (void *) (reg))
 #define be_abi_reg_map_set(map, reg, irn)  pmap_insert((map), (void *) (reg), (irn))
 
+/** The number of parts of the stack layout. */
 #define N_FRAME_TYPES 3
 
 /**
@@ -144,7 +154,8 @@ ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi);
  * The stack is divided into 3 parts:
  * - arg_type:     A struct type describing the stack arguments and it's order.
  * - between_type: A struct type describing the stack layout between arguments
- *                 and frame type
+ *                 and frame type. In architectures that put the return address
+ *                 automatically on the stack, the return address is put here.
  * - frame_type:   A class type describing the frame layout
  */
 struct _be_stack_layout_t {