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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irphase_t.c
   4  * Purpose:     Phase information handling using node indexes.
   5  * Author:      Sebastian Hack
   6  * Modified by:
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2006 Universitaet Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 #ifndef _FIRM_IR_PHASE_T_H
  14 #define _FIRM_IR_PHASE_T_H
  15
  16 #include "obstack.h"
  17 #include "irgraph_t.h"
  18 #include "irtools.h"
  19 #include "irphase.h"
  20 #include "irtools.h"
  21
  22 typedef struct {
  23         unsigned node_slots;
  24         unsigned node_slots_used;
  25         unsigned node_data_bytes;
  26         unsigned node_map_bytes;
  27         unsigned overall_bytes;
  28 } phase_stat_t;
  29
  30 /**
  31  * Phase statistics.
  32  */
  33 phase_stat_t *phase_stat(const phase_t *phase, phase_stat_t *stat);
  34
  35 typedef void *(phase_irn_data_init_t)(phase_t *phase, ir_node *irn, void *old);
  36
  37 /**
  38  * The default grow factor.
  39  * The node => data map does not speculatively allocate more slots.
  40  */
  41 #define PHASE_DEFAULT_GROWTH (256)
  42
  43 /**
  44  * A phase object.
  45  */
  46 struct _phase_t {
  47         struct obstack         obst;           /**< The obstack where the irn phase data will be stored on. */
  48         const char            *name;           /**< The name of the phase. */
  49         ir_graph              *irg;            /**< The irg this phase will we applied to. */
  50         unsigned               growth_factor;  /**< factor to leave room for add. nodes. 256 means 1.0. */
  51         void                  *priv;           /**< Some pointer private to the user of the phase. */
  52         size_t                 n_data_ptr;     /**< The length of the data_ptr array. */
  53         void                 **data_ptr;       /**< Map node indexes to irn data on the obstack. */
  54         phase_irn_data_init_t *data_init;      /**< A callback that is called to initialize newly created node data. */
  55 };
  56
  57 /**
  58  * Initialize a phase object.
  59  * @param name          The name of the phase.
  60  * @param irg           The graph the phase will run on.
  61  * @param growth_factor A factor denoting how many node slots will be additionally allocated,
  62  *                      if the node => data is full. 256 means 1.0.
  63  * @param irn_data_init A callback that is called to initialize newly created node data.
  64  * @param priv          Some private pointer which is kept in the phase and can be retrieved with phase_get_private().
  65  * @return              A new phase object.
  66  */
  67 phase_t *phase_init(phase_t *ph, const char *name, ir_graph *irg, unsigned growth_factor, phase_irn_data_init_t *data_init);
  68
  69 /**
  70  * Free the phase and all node data associated with it.
  71  * @param phase The phase.
  72  */
  73 void phase_free(phase_t *phase);
  74
  75 /**
  76  * Re-initialize the irn data for all nodes in the node => data map using the given callback.
  77  * @param phase The phase.
  78  */
  79 void phase_reinit_irn_data(phase_t *phase);
  80
  81 /**
  82  * Re-initialize the irn data for all nodes in the given block.
  83  * @param phase The phase.
  84  * @param block The block.
  85  */
  86 void phase_reinit_block_irn_data(phase_t *phase, ir_node *block);
  87
  88 /**
  89  * Re-initialize the irn data for the given node.
  90  * @param phase The phase.
  91  * @param irn   The irn.
  92  */
  93 #define phase_reinit_single_irn_data(phase, irn) _phase_reinit_single_irn_data((phase), (irn))
  94
  95 /**
  96  * Returns the first node of the phase having some data assigned.
  97  * @param phase The phase.
  98  * @return The first irn having some data assigned, NULL otherwise
  99  */
 100 ir_node *phase_get_first_node(phase_t *phase);
 101
 102 /**
 103  * Returns the next node after @p start having some data assigned.
 104  * @param phase The phase.
 105  * @param start The node to start from
 106  * @return The next node after start having some data assigned, NULL otherwise
 107  */
 108 ir_node *phase_get_next_node(phase_t *phase, ir_node *start);
 109
 110 /**
 111  * Convenience macro to iterate over all nodes of a phase
 112  * having some data assigned.
 113  */
 114 #define foreach_phase_irn(phase, irn) \
 115         for (irn = phase_get_first_node(phase); irn; irn = phase_get_next_node(phase, irn))
 116
 117 /**
 118  * Get the name of the phase.
 119  */
 120 #define phase_get_name(ph)                 ((ph)->name)
 121
 122 /**
 123  * Get the irg the phase runs on.
 124  */
 125 #define phase_get_irg(ph)                  ((ph)->irg)
 126
 127 /**
 128  * Get private data pointer as passed on creating the phase.
 129  */
 130 #define phase_get_private(ph)              ((ph)->priv)
 131
 132 /**
 133  * Allocate memory in the phase's memory pool.
 134  */
 135 #define phase_alloc(ph, size)              obstack_alloc(phase_obst(ph), (size))
 136
 137 /**
 138  * Get the obstack of the phase.
 139  */
 140 #define phase_obst(ph)                     (&(ph)->obst)
 141
 142 /**
 143  * Get the phase data for an irn.
 144  * @param ph   The phase.
 145  * @param irn  The irn to get data for.
 146  * @return     A pointer to the data or NULL if the irn has no phase data.
 147  */
 148 #define phase_get_irn_data(ph, irn)        _phase_get_irn_data((ph), (irn))
 149
 150 /**
 151  * Get or set phase data for an irn.
 152  * @param ph   The phase.
 153  * @param irn  The irn to get (or set) node data for.
 154  * @return     A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one.
 155  */
 156 #define phase_get_or_set_irn_data(ph, irn) _phase_get_or_set_irn_data((ph), (irn))
 157
 158 /**
 159  * Set the data for an irn.
 160  * @param ph The phase.
 161  * @param irn The node.
 162  * @param data The data.
 163  * @return The old data or NULL if there was none.
 164  */
 165 #define phase_set_irn_data(ph, irn, data)  _phase_set_irn_data((ph), (irn), (data))
 166
 167 /**
 168  * This is private and only here for performance reasons.
 169  */
 170 static INLINE void _phase_reinit_single_irn_data(phase_t *phase, ir_node *irn)
 171 {
 172         int idx;
 173
 174         if (! phase->data_init)
 175                 return;
 176
 177         idx = get_irn_idx(irn);
 178         if (phase->data_ptr[idx])
 179                 phase->data_init(phase, irn, phase->data_ptr[idx]);
 180 }
 181
 182
 183 /**
 184  * This is private and just here for performance reasons.
 185  */
 186 static INLINE void _private_phase_enlarge(phase_t *phase, unsigned max_idx)
 187 {
 188         unsigned last_irg_idx = get_irg_last_idx(phase->irg);
 189         size_t old_cap        = phase->n_data_ptr;
 190         size_t new_cap;
 191
 192         /* make the maximum index at least as big as the largest index in the graph. */
 193         max_idx = MAX(max_idx, last_irg_idx);
 194         new_cap = (size_t) (max_idx * phase->growth_factor / 256);
 195
 196         phase->data_ptr = (void **)xrealloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0]));
 197
 198         /* initialize the newly allocated memory. */
 199         memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0]));
 200         phase->n_data_ptr = new_cap;
 201 }
 202
 203 /**
 204  * This is private and only here for performance reasons.
 205  */
 206 #define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1)
 207
 208 static INLINE void *_phase_get_irn_data(const phase_t *ph, const ir_node *irn)
 209 {
 210         unsigned idx = get_irn_idx(irn);
 211         return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL;
 212 }
 213
 214 static INLINE void *_phase_set_irn_data(phase_t *ph, const ir_node *irn, void *data)
 215 {
 216         unsigned idx = get_irn_idx(irn);
 217         void *res;
 218
 219         /* Assure that there's a sufficient amount of slots. */
 220         _private_phase_assure_capacity(ph, idx);
 221
 222         res = ph->data_ptr[idx];
 223         ph->data_ptr[idx] = data;
 224
 225         return res;
 226 }
 227
 228
 229 static INLINE void *_phase_get_or_set_irn_data(phase_t *ph, ir_node *irn)
 230 {
 231         unsigned idx = get_irn_idx(irn);
 232         void *res;
 233
 234         /* Assure that there's a sufficient amount of slots. */
 235         _private_phase_assure_capacity(ph, idx);
 236
 237         res = ph->data_ptr[idx];
 238
 239         /* If there has no irn data allocated yet, do that now. */
 240         if(!res) {
 241                 phase_irn_data_init_t *data_init = ph->data_init;
 242
 243                 /* call the node data structure allocator/constructor. */
 244                 res = ph->data_ptr[idx] = data_init(ph, irn, NULL);
 245
 246         }
 247         return res;
 248 }
 249
 250 #endif /* _FIRM_IR_PHASE_T_H */