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