nsz Git - libfirm/blob - ir/be/beirg.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 irg - a ir_graph with additional analysis information.
  23  * @author      Matthias Braun
  24  * @date        05.05.2006
  25  */
  26 #ifndef FIRM_BE_BEIRG_H
  27 #define FIRM_BE_BEIRG_H
  28
  29 #include "be.h"
  30 #include "be_types.h"
  31 #include "be_t.h"
  32 #include "irtypes.h"
  33
  34 be_lv_t *be_assure_liveness(ir_graph *irg);
  35
  36 void be_assure_dom_front(ir_graph *irg);
  37 void be_invalidate_dom_front(ir_graph *irg);
  38
  39 /**
  40  * frees all memory allocated by birg structures (liveness, dom_front, ...).
  41  * The memory of the birg structure itself is not freed.
  42  */
  43 void be_free_birg(ir_graph *irg);
  44
  45 /** The number of parts of the stack layout. */
  46 #define N_FRAME_TYPES 3
  47
  48 /**
  49  * This type describes the stack layout.
  50  * The stack is divided into 3 parts:
  51  * - arg_type:     A struct type describing the stack arguments and its order.
  52  * - between_type: A struct type describing the stack layout between arguments
  53  *                 and frame type. In architectures that put the return address
  54  *                 automatically on the stack, the return address is put here.
  55  * - frame_type:   A class type describing the frame layout.
  56  */
  57 struct be_stack_layout_t {
  58         ir_type *arg_type;             /**< A type describing the stack argument layout. */
  59         ir_type *between_type;         /**< A type describing the "between" layout. */
  60         ir_type *frame_type;           /**< The frame type. */
  61
  62         ir_type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
  63
  64         ir_entity **param_map;         /**< An array mapping type parameters to arg_type entries */
  65         int initial_offset;            /**< the initial difference between stack pointer and frame pointer */
  66         int initial_bias;              /**< the initial stack bias */
  67         bool sp_relative : 1;          /**< entities are addressed relative to
  68                                             stack pointer (omit-fp mode) */
  69 };
  70
  71 /**
  72  * An ir_graph with additional analysis data about this irg. Also includes some
  73  * backend structures
  74  */
  75 typedef struct be_irg_t {
  76         ir_graph              *irg;
  77         be_main_env_t         *main_env;
  78         be_abi_irg_t          *abi;
  79         ir_exec_freq          *exec_freq;
  80         be_dom_front_info_t   *dom_front;
  81         be_lv_t               *lv;
  82         be_stack_layout_t      stack_layout;
  83         unsigned              *allocatable_regs; /**< registers available for the
  84                                                                                               allocator */
  85         arch_register_req_t   *sp_req; /**< requirements for stackpointer producing
  86                                             nodes. */
  87         struct obstack         obst; /**< birg obstack (mainly used to keep
  88                                           register constraints which we can't keep
  89                                           in the irg obst, because it gets replaced
  90                                           during code selection) */
  91         void                  *isa_link; /**< architecture specific per-graph data*/
  92 } be_irg_t;
  93
  94 static inline be_irg_t *be_birg_from_irg(const ir_graph *irg)
  95 {
  96         return (be_irg_t*) irg->be_data;
  97 }
  98
  99 static inline be_main_env_t *be_get_irg_main_env(const ir_graph *irg)
 100 {
 101         return be_birg_from_irg(irg)->main_env;
 102 }
 103
 104 static inline be_lv_t *be_get_irg_liveness(const ir_graph *irg)
 105 {
 106         return be_birg_from_irg(irg)->lv;
 107 }
 108
 109 static inline ir_exec_freq *be_get_irg_exec_freq(const ir_graph *irg)
 110 {
 111         return be_birg_from_irg(irg)->exec_freq;
 112 }
 113
 114 static inline be_dom_front_info_t *be_get_irg_dom_front(const ir_graph *irg)
 115 {
 116         return be_birg_from_irg(irg)->dom_front;
 117 }
 118
 119 static inline be_abi_irg_t *be_get_irg_abi(const ir_graph *irg)
 120 {
 121         return be_birg_from_irg(irg)->abi;
 122 }
 123
 124 static inline void be_set_irg_abi(ir_graph *irg, be_abi_irg_t *abi)
 125 {
 126         be_birg_from_irg(irg)->abi = abi;
 127 }
 128
 129 static inline be_options_t *be_get_irg_options(const ir_graph *irg)
 130 {
 131         return be_birg_from_irg(irg)->main_env->options;
 132 }
 133
 134 /** deprecated */
 135 static inline ir_graph *be_get_birg_irg(const be_irg_t *birg)
 136 {
 137         return birg->irg;
 138 }
 139
 140 static inline const arch_env_t *be_get_irg_arch_env(const ir_graph *irg)
 141 {
 142         return be_birg_from_irg(irg)->main_env->arch_env;
 143 }
 144
 145 static inline struct obstack *be_get_be_obst(const ir_graph *irg)
 146 {
 147         be_irg_t *birg = be_birg_from_irg(irg);
 148         return &birg->obst;
 149 }
 150
 151 static inline be_stack_layout_t *be_get_irg_stack_layout(const ir_graph *irg)
 152 {
 153         return &be_birg_from_irg(irg)->stack_layout;
 154 }
 155
 156 #endif