Allow loading of stack parameters with a different mode than the parameter mode....

[libfirm] / ir / be / beabi.h

diff --git a/ir/be/beabi.h b/ir/be/beabi.h
index c1868a3..cfee128 100644 (file)
--- a/ir/be/beabi.h
+++ b/ir/be/beabi.h
@@ -1,10 +1,30 @@
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
 /**
- * Backend ABI implementation.
+ * @file
+ * @brief       Backend ABI implementation.
+ * @author      Sebastian Hack
+ * @version     $Id$
  */
-
-#ifndef _BEABI_H
-#define _BEABI_H
+#ifndef FIRM_BE_BEABI_H
+#define FIRM_BE_BEABI_H
 
 #include "firm_types.h"
 
@@ -13,6 +33,7 @@
 #include "bitset.h"
 
 #include "be.h"
+#include "beirg.h"
 #include "bearch.h"
 #include "beabi_t.h"
 
@@ -65,7 +86,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.
@@ -93,7 +114,29 @@ 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);
 
-void be_abi_call_param_stack(be_abi_call_t *call, int pos, unsigned alignment, unsigned space_before, unsigned space_after);
+/**
+ * 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.
+ * @param cls       The register class for call address.
+ */
+void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
+
+/**
+ * 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);
 
@@ -115,9 +158,14 @@ 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
+ */
+void be_abi_fix_stack_nodes(be_abi_irg_t *env);
+
 /**
  * Put the registers which are forbidden specifically for this IRG in a bitset.
  */
@@ -125,11 +173,11 @@ void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls,
 
 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))
 
+/** The number of parts of the stack layout. */
 #define N_FRAME_TYPES 3
 
 /**
@@ -137,7 +185,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 {
@@ -149,7 +198,7 @@ struct _be_stack_layout_t {
 
        int initial_offset;
        int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
-       entity **param_map;                /**< An array mapping type parameters to arg_type entries */
+       ir_entity **param_map;             /**< An array mapping type parameters to arg_type entries */
 };
 
 /**
@@ -163,4 +212,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 */