nsz Git - libfirm/blob - ir/ir/irphase_t.h

   1 /*
   2  * Copyright (C) 1995-2007 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   Phase information handling using node indexes.
  23  * @author  Sebastian Hack
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_IR_PHASE_T_H
  27 #define FIRM_IR_PHASE_T_H
  28
  29 #include "firm_types.h"
  30 #include "obst.h"
  31 #include "irgraph_t.h"
  32 #include "irtools.h"
  33
  34 /**
  35  * For statistics: A type containing statistic data of a phase object.
  36  */
  37 typedef struct {
  38         unsigned node_slots;       /**< The number of allocated node slots. */
  39         unsigned node_slots_used;  /**< The number of used node slots, ie. nodes that have node data. */
  40         unsigned node_map_bytes;   /**< Number of used bytes for the node map. */
  41         unsigned overall_bytes;    /**< Overall number of used bytes for the phase. */
  42 } phase_stat_t;
  43
  44 /**
  45  * Collect Phase statistics.
  46  *
  47  * @param phase  The phase.
  48  * @param stat   Will be filled with the statistical data.
  49  */
  50 phase_stat_t *phase_stat(const ir_phase *phase, phase_stat_t *stat);
  51
  52 /**
  53  * The type of a phase data init function. This callback is called to
  54  * (re-) initialize the phase data for each new node.
  55  *
  56  * @param phase  The phase.
  57  * @param irn    The node for which the phase data is (re-) initialized
  58  * @param old    The old phase data for this node.
  59  *
  60  * @return The new (or reinitialized) phase data for this node.
  61  *
  62  * If newly node data is allocated, old is equal to NULL, else points to the old data.
  63  */
  64 typedef void *(phase_irn_data_init_t)(ir_phase *phase, ir_node *irn, void *old);
  65
  66 /**
  67  * The default grow factor.
  68  * The node => data map does not speculatively allocate more slots.
  69  */
  70 #define PHASE_DEFAULT_GROWTH (256)
  71
  72 /**
  73  * A phase object.
  74  */
  75 struct _ir_phase {
  76         struct obstack         obst;           /**< The obstack where the irn phase data will be stored on. */
  77         const char            *name;           /**< The name of the phase. */
  78         ir_graph              *irg;            /**< The irg this phase will we applied to. */
  79         unsigned               growth_factor;  /**< The factor to leave room for additional nodes. 256 means 1.0. */
  80         void                  *priv;           /**< Some pointer private to the user of the phase. */
  81         size_t                 n_data_ptr;     /**< The length of the data_ptr array. */
  82         void                 **data_ptr;       /**< Map node indexes to irn data on the obstack. */
  83         phase_irn_data_init_t *data_init;      /**< A callback that is called to initialize newly created node data. */
  84 };
  85
  86 /**
  87  * Initialize a phase object.
  88  *
  89  * @param name          The name of the phase. Just for debugging.
  90  * @param irg           The graph the phase will run on.
  91  * @param growth_factor A factor denoting how many node slots will be additionally allocated,
  92  *                      if the node => data is full. The factor is given in units of 1/256, so
  93  *                      256 means 1.0.
  94  * @param irn_data_init A callback that is called to initialize newly created node data.
  95  *                      Must be non-null.
  96  * @param priv          Some private pointer which is kept in the phase and can be retrieved with phase_get_private().
  97  * @return              A new phase object.
  98  */
  99 ir_phase *phase_init(ir_phase *ph, const char *name, ir_graph *irg, unsigned growth_factor, phase_irn_data_init_t *data_init, void *priv);
 100
 101 /**
 102  * Free the phase and all node data associated with it.
 103  *
 104  * @param phase  The phase.
 105  */
 106 void phase_free(ir_phase *phase);
 107
 108 /**
 109  * Re-initialize the irn data for all nodes in the node => data map using the given callback.
 110  *
 111  * @param phase  The phase.
 112  */
 113 void phase_reinit_irn_data(ir_phase *phase);
 114
 115 /**
 116  * Re-initialize the irn data for all nodes having phase data in the given block.
 117  *
 118  * @param phase  The phase.
 119  * @param block  The block.
 120  *
 121  * @note Beware: iterates over all nodes in the graph to find the nodes of the given block.
 122  */
 123 void phase_reinit_block_irn_data(ir_phase *phase, ir_node *block);
 124
 125 /**
 126  * Re-initialize the irn data for the given node.
 127  *
 128  * @param phase  The phase.
 129  * @param irn    The irn.
 130  */
 131 #define phase_reinit_single_irn_data(phase, irn) _phase_reinit_single_irn_data((phase), (irn))
 132
 133 /**
 134  * Returns the first node of the phase having some data assigned.
 135  *
 136  * @param phase  The phase.
 137  *
 138  * @return The first irn having some data assigned, NULL otherwise
 139  */
 140 ir_node *phase_get_first_node(ir_phase *phase);
 141
 142 /**
 143  * Returns the next node after @p start having some data assigned.
 144  *
 145  * @param phase  The phase.
 146  * @param start  The node to start from
 147  *
 148  * @return The next node after start having some data assigned, NULL otherwise
 149  */
 150 ir_node *phase_get_next_node(ir_phase *phase, ir_node *start);
 151
 152 /**
 153  * Convenience macro to iterate over all nodes of a phase
 154  * having some data assigned.
 155  *
 156  * @param phase  The phase.
 157  * @param irn    A local variable that will hold the current node inside the loop.
 158  */
 159 #define foreach_phase_irn(phase, irn) \
 160         for (irn = phase_get_first_node(phase); irn; irn = phase_get_next_node(phase, irn))
 161
 162 /**
 163  * Get the name of the phase.
 164  *
 165  * @param phase  The phase.
 166  */
 167 #define phase_get_name(phase)                 ((phase)->name)
 168
 169 /**
 170  * Get the irg the phase runs on.
 171  *
 172  * @param phase  The phase.
 173  */
 174 #define phase_get_irg(phase)                  ((phase)->irg)
 175
 176 /**
 177  * Get private data pointer as passed on creating the phase.
 178  *
 179  * @param phase  The phase.
 180  */
 181 #define phase_get_private(phase)              ((phase)->priv)
 182
 183 /**
 184  * Allocate memory in the phase's memory pool.
 185  *
 186  * @param phase  The phase.
 187  * @param size   Number of bytes to allocate.
 188  */
 189 #define phase_alloc(phase, size)              obstack_alloc(phase_obst(phase), (size))
 190
 191 /**
 192  * Get the obstack of a phase.
 193  *
 194  * @param phase  The phase.
 195  */
 196 #define phase_obst(phase)                     (&(phase)->obst)
 197
 198 /**
 199  * Get the phase node data for an irn.
 200  *
 201  * @param phase   The phase.
 202  * @param irn     The irn to get data for.
 203  *
 204  * @return A pointer to the node data or NULL if the irn has no phase data allocated yet.
 205  */
 206 #define phase_get_irn_data(phase, irn)        _phase_get_irn_data((phase), (irn))
 207
 208 /**
 209  * Get or set phase data for an irn.
 210  *
 211  * @param phase  The phase.
 212  * @param irn    The irn to get (or set) node data for.
 213  *
 214  * @return A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one.
 215  */
 216 #define phase_get_or_set_irn_data(phase, irn) _phase_get_or_set_irn_data((phase), (irn))
 217
 218 /**
 219  * Set the node data for an irn.
 220  *
 221  * @param phase  The phase.
 222  * @param irn    The node.
 223  * @param data   The node data.
 224  *
 225  * @return The old data or NULL if there was none.
 226  */
 227 #define phase_set_irn_data(phase, irn, data)  _phase_set_irn_data((phase), (irn), (data))
 228
 229 /**
 230  * This is private and only here for performance reasons.
 231  */
 232 static INLINE void _phase_reinit_single_irn_data(ir_phase *phase, ir_node *irn)
 233 {
 234         int idx;
 235
 236         if (! phase->data_init)
 237                 return;
 238
 239         idx = get_irn_idx(irn);
 240         if (phase->data_ptr[idx])
 241                 phase->data_init(phase, irn, phase->data_ptr[idx]);
 242 }
 243
 244
 245 /**
 246  * This is private and just here for performance reasons.
 247  */
 248 static INLINE void _private_phase_enlarge(ir_phase *phase, unsigned max_idx)
 249 {
 250         unsigned last_irg_idx = get_irg_last_idx(phase->irg);
 251         size_t old_cap        = phase->n_data_ptr;
 252         size_t new_cap;
 253
 254         /* make the maximum index at least as big as the largest index in the graph. */
 255         max_idx = MAX(max_idx, last_irg_idx);
 256         new_cap = (size_t) (max_idx * phase->growth_factor / 256);
 257
 258         phase->data_ptr = (void **)xrealloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0]));
 259
 260         /* initialize the newly allocated memory. */
 261         memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0]));
 262         phase->n_data_ptr = new_cap;
 263 }
 264
 265 /**
 266  * This is private and only here for performance reasons.
 267  */
 268 #define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1)
 269
 270 static INLINE void *_phase_get_irn_data(const ir_phase *ph, const ir_node *irn)
 271 {
 272         unsigned idx = get_irn_idx(irn);
 273         return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL;
 274 }
 275
 276 static INLINE void *_phase_set_irn_data(ir_phase *ph, const ir_node *irn, void *data)
 277 {
 278         unsigned idx = get_irn_idx(irn);
 279         void *res;
 280
 281         /* Assure that there's a sufficient amount of slots. */
 282         _private_phase_assure_capacity(ph, idx);
 283
 284         res = ph->data_ptr[idx];
 285         ph->data_ptr[idx] = data;
 286
 287         return res;
 288 }
 289
 290
 291 static INLINE void *_phase_get_or_set_irn_data(ir_phase *ph, ir_node *irn)
 292 {
 293         unsigned idx = get_irn_idx(irn);
 294         void *res;
 295
 296         /* Assure that there's a sufficient amount of slots. */
 297         _private_phase_assure_capacity(ph, idx);
 298
 299         res = ph->data_ptr[idx];
 300
 301         /* If there has no irn data allocated yet, do that now. */
 302         if(!res) {
 303                 phase_irn_data_init_t *data_init = ph->data_init;
 304
 305                 /* call the node data structure allocator/constructor. */
 306                 res = ph->data_ptr[idx] = data_init(ph, irn, NULL);
 307
 308         }
 309         return res;
 310 }
 311
 312 #endif