Add ALLOCAN() and ALLOCANZ().
[libfirm] / ir / be / beabi.h
index 60a313b..69b915d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
  */
 
 /**
- * Backend ABI implementation.
+ * @file
+ * @brief       Backend ABI implementation.
+ * @author      Sebastian Hack
+ * @version     $Id$
  */
-#ifndef FIRM_BEABI_H
-#define FIRM_BEABI_H
+#ifndef FIRM_BE_BEABI_H
+#define FIRM_BE_BEABI_H
 
 #include "firm_types.h"
 
@@ -81,14 +84,15 @@ 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 map mapping all callee_save/ignore/parameter registers to their defining nodes.
-        * @return        The register which shall be used as a stack frame base.
+        * @param self       The callback object.
+        * @param mem        A pointer to the mem node. Update this if you define new memory.
+        * @param reg_map    A map mapping all callee_save/ignore/parameter registers to their defining nodes.
+        * @param stack_bias Points to the current stack bias, can be modified if needed.
+        * @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.
         */
-       const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map);
+       const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map, int *stack_bias);
 
        /**
         * Generate the epilogue.
@@ -111,6 +115,11 @@ struct _be_abi_callbacks_t {
  */
 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
 
+/**
+ * Sets the number of bytes the stackframe is shrinked by the callee on return
+ */
+void be_abi_call_set_pop(be_abi_call_t *call, int pop);
+
 /**
  * Set register class for call address.
  * @param call      The call.
@@ -118,7 +127,17 @@ void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const
  */
 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
 
-void be_abi_call_param_stack(be_abi_call_t *call, int pos, unsigned alignment, unsigned space_before, unsigned space_after);
+/**
+ * Describe the stack layout for a call parameter. Modifies the abi object.
+ *
+ * @param call          the abi call object
+ * @param pos           the parameter position
+ * @param load_mode     load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
+ * @param alignment     stack alignment for the parameter on the current architecture
+ * @param space_before  size of allocated additional space before the parameter
+ * @param space_after   size of allocated additional space after the parameter
+ */
+void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode, unsigned alignment, unsigned space_before, unsigned space_after);
 void be_abi_call_param_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
 void be_abi_call_res_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
 
@@ -139,6 +158,11 @@ be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 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);
+
+/**
+ * Fix the stack bias for all nodes accessing the stack frame using the
+ * stack pointer.
+ */
 void be_abi_fix_stack_bias(be_abi_irg_t *env);
 void be_abi_free(be_abi_irg_t *abi);
 
@@ -153,9 +177,10 @@ void be_abi_fix_stack_nodes(be_abi_irg_t *env);
  */
 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs);
 
+void be_abi_set_non_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, unsigned *raw_bitset);
+
 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg);
-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))
@@ -170,7 +195,7 @@ ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi);
  * - between_type: A struct type describing the stack layout between arguments
  *                 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
+ * - frame_type:   A class type describing the frame layout.
  */
 struct _be_stack_layout_t {
        ir_type *arg_type;                 /**< A type describing the stack argument layout. */
@@ -179,9 +204,10 @@ struct _be_stack_layout_t {
 
        ir_type *order[N_FRAME_TYPES];     /**< arg, between and frame types ordered. */
 
-       int initial_offset;
-       int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
        ir_entity **param_map;             /**< An array mapping type parameters to arg_type entries */
+       int initial_offset;                /**< the initial difference between stack pointer and frame pointer */
+       int initial_bias;                  /**< the initial stack bias */
+       int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
 };
 
 /**
@@ -195,4 +221,4 @@ const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi);
  */
 int be_abi_omit_fp(const be_abi_irg_t *abi);
 
-#endif /* _BEABI_H */
+#endif /* FIRM_BE_BEABI_H */