nsz Git - libfirm/blob - ir/be/beabi.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Backend ABI implementation.
  23  * @author      Sebastian Hack
  24  */
  25 #ifndef FIRM_BE_BEABI_H
  26 #define FIRM_BE_BEABI_H
  27
  28 #include "firm_types.h"
  29
  30 #include "pset.h"
  31 #include "pmap.h"
  32 #include "bitset.h"
  33
  34 #include "be.h"
  35 #include "beirg.h"
  36 #include "bearch.h"
  37 #include "beabi.h"
  38 #include "beabihelper.h"
  39
  40 struct be_abi_call_flags_t {
  41         bool try_omit_fp   : 1; /**< Try to omit the frame pointer. */
  42         bool call_has_imm  : 1; /**< A call can take the callee's address as an
  43                                      immediate. */
  44 };
  45
  46 struct be_abi_callbacks_t {
  47         /**
  48          * Get the between type for that call.
  49          * @param self The callback object.
  50          * @return The between type of for that call.
  51          */
  52         ir_type *(*get_between_type)(ir_graph *irg);
  53 };
  54
  55 /**
  56  * Set the flags for a call.
  57  * @param call          The call.
  58  * @param flags         Some flags to be set.
  59  * @param cb            The call callbacks for that call.
  60  * @note                The ABI phase might change the flags due to analysis.
  61  */
  62 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
  63
  64 /**
  65  * Sets the number of bytes the stackframe is shrinked by the callee on return
  66  */
  67 void be_abi_call_set_pop(be_abi_call_t *call, int pop);
  68
  69 /**
  70  * Set register class for call address.
  71  * @param call      The call.
  72  * @param cls       The register class for call address.
  73  */
  74 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
  75
  76 /**
  77  * The ABI can change when we call a function vs. when we have
  78  * been called.
  79  */
  80 typedef enum {
  81         ABI_CONTEXT_CALLEE = 1 << 0,
  82         ABI_CONTEXT_CALLER = 1 << 1,
  83         ABI_CONTEXT_BOTH   = ABI_CONTEXT_CALLEE | ABI_CONTEXT_CALLER
  84 } be_abi_context_t;
  85
  86 /**
  87  * Record the that ABI transmits call argument pos on the stack. Modifies the abi object.
  88  *
  89  * @param call          the abi call object
  90  * @param pos           the parameter position
  91  * @param load_mode     load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
  92  * @param alignment     stack alignment for the parameter on the current architecture
  93  * @param space_before  size of allocated additional space before the parameter
  94  * @param space_after   size of allocated additional space after the parameter
  95  */
  96 void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode,
  97                              unsigned alignment, unsigned space_before,
  98                              unsigned space_after, be_abi_context_t context);
  99
 100 /**
 101  * Record the that ABI transmits call argument pos in the given register.
 102  *
 103  * @param call          the abi call object
 104  * @param pos           the parameter position
 105  * @param reg           the register used
 106  */
 107 void be_abi_call_param_reg(be_abi_call_t *call, int pos,
 108                            const arch_register_t *reg,
 109                            be_abi_context_t context);
 110
 111 /**
 112  * Record the that ABI transmits return value pos in the given register.
 113  *
 114  * @param call          the abi call object
 115  * @param pos           the return value position
 116  * @param reg           the register used
 117  */
 118 void be_abi_call_res_reg(be_abi_call_t *call, int pos,
 119                          const arch_register_t *reg,
 120                          be_abi_context_t context);
 121
 122 /**
 123  * Get the flags of a ABI call object.
 124  * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
 125  * altered several flags, so getting them from the call object is always a good idea.
 126  * @param call The call object.
 127  * @return The flags.
 128  */
 129 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 130
 131 /**
 132  * Get the method type of an ABI call object.
 133  * @param call The call object.
 134  * @return The method type for that call object.
 135  */
 136 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 137
 138 void be_abi_introduce(ir_graph *irg);
 139
 140 #endif