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 *data);
  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                 data_size;      /**< The amount of bytes which shall be allocated for each irn. */
  53         size_t                 n_data_ptr;     /**< The length of the data_ptr array. */
  54         void                 **data_ptr;       /**< Map node indexes to irn data on the obstack. */
  55         phase_irn_data_init_t *data_init;      /**< A callback that is called to initialize newly created node data. */
  56 };
  57
  58 /**
  59  * Initialize a phase object.
  60  * @param name          The name of the phase.
  61  * @param irg           The graph the phase will run on.
  62  * @param data_size     The amount of extra storage in bytes that should be allocated for each node.
  63  * @param growth_factor A factor denoting how many node slots will be additionally allocated,
  64  *                      if the node => data is full. 256 means 1.0.
  65  * @param irn_data_init A callback that is called to initialize newly created node data.
  66  * @param priv          Some private pointer which is kept in the phase and can be retrieved with phase_get_private().
  67  * @return              A new phase object.
  68  */
  69 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);
  70
  71 /**
  72  * Free the phase and all node data associated with it.
  73  * @param phase The phase.
  74  */
  75 void phase_free(phase_t *phase);
  76
  77 /**
  78  * Re-initialize the irn data for all nodes in the node => data map using the given callback.
  79  * @param phase The phase.
  80  * @note This function will pass NULL to the init function passed to phase_new().
  81  */
  82 void phase_reinit_irn_data(phase_t *phase);
  83
  84 /**
  85  * Get the name of the phase.
  86  */
  87 #define phase_get_name(ph)                 ((ph)->name)
  88
  89 /**
  90  * Get the irg the phase runs on.
  91  */
  92 #define phase_get_irg(ph)                  ((ph)->irg)
  93
  94 /**
  95  * Get private data pointer as passed on creating the phase.
  96  */
  97 #define phase_get_private(ph)              ((ph)->priv)
  98
  99 /**
 100  * Allocate memory in the phase's memory pool.
 101  */
 102 #define phase_alloc(ph, size)              obstack_alloc(phase_obst(ph), (size))
 103
 104 /**
 105  * Get the obstack of the phase.
 106  */
 107 #define phase_obst(ph)                     (&(ph)->obst)
 108
 109 /**
 110  * Get the phase data for an irn.
 111  * @param ph   The phase.
 112  * @param irn  The irn to get data for.
 113  * @return     A pointer to the data or NULL if the irn has no phase data.
 114  */
 115 #define phase_get_irn_data(ph, irn)        _phase_get_irn_data((ph), (irn))
 116
 117 /**
 118  * Get or set phase data for an irn.
 119  * @param ph   The phase.
 120  * @param irn  The irn to get (or set) node data for.
 121  * @return     A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one.
 122  */
 123 #define phase_get_or_set_irn_data(ph, irn) _phase_get_or_set_irn_data((ph), (irn))
 124
 125 /**
 126  * This is private and just here for performance reasons.
 127  */
 128 static INLINE void _private_phase_enlarge(phase_t *phase, unsigned max_idx)
 129 {
 130         unsigned last_irg_idx = get_irg_last_idx(phase->irg);
 131         size_t old_cap        = phase->n_data_ptr;
 132         size_t new_cap;
 133
 134         /* make the maximum index at least as big as the largest index in the graph. */
 135         max_idx = MAX(max_idx, last_irg_idx);
 136         new_cap = (size_t) (max_idx * phase->growth_factor / 256);
 137
 138         phase->data_ptr = (void **) realloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0]));
 139
 140         /* initialize the newly allocated memory. */
 141         memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0]));
 142         phase->n_data_ptr = new_cap;
 143 }
 144
 145 /**
 146  * This is private and only here for performance reasons.
 147  */
 148 #define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1)
 149
 150 static INLINE void *_phase_get_irn_data(phase_t *ph, const ir_node *irn)
 151 {
 152         unsigned idx = get_irn_idx(irn);
 153         return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL;
 154 }
 155
 156 static INLINE void *_phase_get_or_set_irn_data(phase_t *ph, ir_node *irn)
 157 {
 158         unsigned idx = get_irn_idx(irn);
 159         void *res;
 160
 161         /* Assure that there's a sufficient amount of slots. */
 162         _private_phase_assure_capacity(ph, idx);
 163
 164         res = ph->data_ptr[idx];
 165
 166         /* If there has no irn data allocated yet, do that now. */
 167         if(!res) {
 168                 phase_irn_data_init_t *data_init = ph->data_init;
 169                 ph->data_ptr[idx] = res = phase_alloc(ph, ph->data_size);
 170
 171                 /* Call the irn data callback, if there is one. */
 172                 if(data_init)
 173                         data_init(ph, irn, res);
 174         }
 175         return res;
 176 }
 177
 178
 179 #endif /* _FIRM_IR_PHASE_T_H */