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 "irphase.h"
  19 #include "irtools.h"
  20
  21 typedef struct {
  22         unsigned node_slots;
  23         unsigned node_slots_used;
  24         unsigned node_data_bytes;
  25         unsigned node_map_bytes;
  26         unsigned overall_bytes;
  27 } phase_stat_t;
  28
  29 /**
  30  * Phase statistics.
  31  */
  32 phase_stat_t *phase_stat(const phase_t *phase, phase_stat_t *stat);
  33
  34 typedef void (phase_irn_data_init_t)(const phase_t *phase, const ir_node *irn, void *data);
  35
  36 /**
  37  * The default grow factor.
  38  * The node => data map does not speculatively allocate more slots.
  39  */
  40 #define PHASE_DEFAULT_GROWTH (256)
  41
  42 /**
  43  * A phase object.
  44  */
  45 struct _phase_t {
  46         struct obstack         obst;           /**< The obstack where the irn phase data will be stored on. */
  47         const char            *name;           /**< The name of the phase. */
  48         ir_graph              *irg;            /**< The irg this phase will we applied to. */
  49         unsigned               growth_factor;  /**< factor to leave room for add. nodes. 256 means 1.0. */
  50         void                  *priv;           /**< Some pointer private to the user of the phase. */
  51         size_t                 data_size;      /**< The amount of bytes which shall be allocated for each irn. */
  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 data_size     The amount of extra storage in bytes that should be allocated for each node.
  62  * @param growth_factor A factor denoting how many node slots will be additionally allocated,
  63  *                      if the node => data is full. 256 means 1.0.
  64  * @param irn_data_init A callback that is called to initialize newly created node data.
  65  * @param priv          Some private pointer which is kept in the phase and can be retrieved with phase_get_private().
  66  * @return              A new phase object.
  67  */
  68 phase_t *phase_init(phase_t *ph, const char *name, ir_graph *irg, size_t data_size, unsigned growth_factor, phase_irn_data_init_t *data_init);
  69
  70 /**
  71  * Free the phase and all node data associated with it.
  72  * @param phase The phase.
  73  */
  74 void phase_free(phase_t *phase);
  75
  76 /**
  77  * Re-initialize the irn data for all nodes in the node => data map using the given callback.
  78  * @param phase The phase.
  79  * @note This function will pass NULL to the init function passed to phase_new().
  80  */
  81 void phase_reinit_irn_data(phase_t *phase);
  82
  83 /**
  84  * Get the name of the phase.
  85  */
  86 #define phase_get_name(ph)                 ((ph)->name)
  87
  88 /**
  89  * Get the irg the phase runs on.
  90  */
  91 #define phase_get_irg(ph)                  ((ph)->irg)
  92
  93 /**
  94  * Get private data pointer as passed on creating the phase.
  95  */
  96 #define phase_get_private(ph)              ((ph)->priv)
  97
  98 /**
  99  * Allocate memory in the phase's memory pool.
 100  */
 101 #define phase_alloc(ph, size)              obstack_alloc(phase_obst(ph), (size))
 102
 103 /**
 104  * Get the obstack of the phase.
 105  */
 106 #define phase_obst(ph)                     (&(ph)->obst)
 107
 108 /**
 109  * Get the phase data for an irn.
 110  * @param ph   The phase.
 111  * @param irn  The irn to get data for.
 112  * @return     A pointer to the data or NULL if the irn has no phase data.
 113  */
 114 #define phase_get_irn_data(ph, irn)        _phase_get_irn_data((ph), (irn))
 115
 116 /**
 117  * Get or set phase data for an irn.
 118  * @param ph   The phase.
 119  * @param irn  The irn to get (or set) node data for.
 120  * @return     A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one.
 121  */
 122 #define phase_get_or_set_irn_data(ph, irn) _phase_get_or_set_irn_data((ph), (irn))
 123
 124 /**
 125  * This is private and just here for performance reasons.
 126  */
 127 static INLINE void _private_phase_enlarge(phase_t *phase, unsigned max_idx)
 128 {
 129         unsigned last_irg_idx = get_irg_last_idx(phase->irg);
 130         size_t old_cap        = phase->n_data_ptr;
 131         size_t new_cap;
 132
 133         /* make the maximum index at least as big as the largest index in the graph. */
 134         max_idx = MAX(max_idx, last_irg_idx);
 135         new_cap = (size_t) (max_idx * phase->growth_factor / 256);
 136
 137         phase->data_ptr = (void **) realloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0]));
 138
 139         /* initialize the newly allocated memory. */
 140         memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0]));
 141         phase->n_data_ptr = new_cap;
 142 }
 143
 144 /**
 145  * This is private and only here for performance reasons.
 146  */
 147 #define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1)
 148
 149 static INLINE void *_phase_get_irn_data(phase_t *ph, const ir_node *irn)
 150 {
 151         unsigned idx = get_irn_idx(irn);
 152         return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL;
 153 }
 154
 155 static INLINE void *_phase_get_or_set_irn_data(phase_t *ph, const ir_node *irn)
 156 {
 157         unsigned idx = get_irn_idx(irn);
 158         void *res;
 159
 160         /* Assure that there's a sufficient amount of slots. */
 161         _private_phase_assure_capacity(ph, idx);
 162
 163         res = ph->data_ptr[idx];
 164
 165         /* If there has no irn data allocated yet, do that now. */
 166         if(!res) {
 167                 phase_irn_data_init_t *data_init = ph->data_init;
 168                 ph->data_ptr[idx] = res = phase_alloc(ph, ph->data_size);
 169
 170                 /* Call the irn data callback, if there is one. */
 171                 if(data_init)
 172                         data_init(ph, irn, res);
 173         }
 174         return res;
 175 }
 176
 177
 178 #endif /* _FIRM_IR_PHASE_T_H */