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