3 * File name: ir/ir/irphase_t.c
4 * Purpose: Phase information handling using node indexes.
5 * Author: Sebastian Hack
9 * Copyright: (c) 1998-2006 Universitaet Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
13 #ifndef _FIRM_IR_PHASE_T_H
14 #define _FIRM_IR_PHASE_T_H
17 #include "irgraph_t.h"
22 unsigned node_slots_used;
23 unsigned node_data_bytes;
24 unsigned node_map_bytes;
25 unsigned overall_bytes;
31 phase_stat_t *phase_stat(const phase_t *phase, phase_stat_t *stat);
33 typedef void (phase_irn_data_init_t)(const phase_t *phase, const ir_node *irn, void *data);
36 * The default grow factor.
37 * The node => data map does not speculatively allocate more slots.
39 #define PHASE_DEFAULT_GROWTH (256)
45 struct obstack obst; /**< The obstack where the irn phase data will be stored on. */
46 const char *name; /**< The name of the phase. */
47 ir_graph *irg; /**< The irg this phase will we applied to. */
48 unsigned growth_factor; /**< factor to leave room for add. nodes. 256 means 1.0. */
49 void *priv; /**< Some pointer private to the user of the phase. */
50 size_t data_size; /**< The amount of bytes which shall be allocated for each irn. */
51 size_t n_data_ptr; /**< The length of the data_ptr array. */
52 void **data_ptr; /**< Map node indexes to irn data on the obstack. */
53 phase_irn_data_init_t *data_init; /**< A callback that is called to initialize newly created node data. */
57 * Initialize a phase object.
58 * @param name The name of the phase.
59 * @param irg The graph the phase will run on.
60 * @param data_size The amount of extra storage in bytes that should be allocated for each node.
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.
67 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 * Free the phase and all node data associated with it.
71 * @param phase The phase.
73 void phase_free(phase_t *phase);
76 * Re-initialize the irn data for all nodes in the node => data map using the given callback.
77 * @param phase The phase.
78 * @note This function will pass NULL to the init function passed to phase_new().
80 void phase_reinit_irn_data(phase_t *phase);
83 * Get the name of the phase.
85 #define phase_get_name(ph) ((ph)->name)
88 * Get the irg the phase runs on.
90 #define phase_get_irg(ph) ((ph)->irg)
93 * Get private data pointer as passed on creating the phase.
95 #define phase_get_private(ph) ((ph)->priv)
98 * Allocate memory in the phase's memory pool.
100 #define phase_alloc(ph, size) obstack_alloc(phase_obst(ph), (size))
103 * Get the obstack of the phase.
105 #define phase_obst(ph) (&(ph)->obst)
108 * Get the phase data for an irn.
109 * @param ph The phase.
110 * @param irn The irn to get data for.
111 * @return A pointer to the data or NULL if the irn has no phase data.
113 #define phase_get_irn_data(ph, irn) _phase_get_irn_data((ph), (irn))
116 * Get or set phase data for an irn.
117 * @param ph The phase.
118 * @param irn The irn to get (or set) node data for.
119 * @return A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one.
121 #define phase_get_or_set_irn_data(ph, irn) _phase_get_or_set_irn_data((ph), (irn))
124 * This is private and just here for performance reasons.
126 static INLINE void _private_phase_enlarge(phase_t *phase, unsigned max_idx)
128 unsigned last_irg_idx = get_irg_last_idx(phase->irg);
129 size_t old_cap = phase->n_data_ptr;
132 /* make the maximum index at least as big as the largest index in the graph. */
133 max_idx = MAX(max_idx, last_irg_idx);
134 new_cap = (size_t) (max_idx * phase->growth_factor / 256);
136 phase->data_ptr = (void **) realloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0]));
138 /* initialize the newly allocated memory. */
139 memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0]));
140 phase->n_data_ptr = new_cap;
144 * This is private and only here for performance reasons.
146 #define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1)
148 static INLINE void *_phase_get_irn_data(phase_t *ph, const ir_node *irn)
150 unsigned idx = get_irn_idx(irn);
151 return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL;
154 static INLINE void *_phase_get_or_set_irn_data(phase_t *ph, const ir_node *irn)
156 unsigned idx = get_irn_idx(irn);
159 /* Assure that there's a sufficient amount of slots. */
160 _private_phase_assure_capacity(ph, idx);
162 res = ph->data_ptr[idx];
164 /* If there has no irn data allocated yet, do that now. */
166 phase_irn_data_init_t *data_init = ph->data_init;
167 ph->data_ptr[idx] = res = phase_alloc(ph, ph->data_size);
169 /* Call the irn data callback, if there is one. */
171 data_init(ph, irn, res);
177 #endif /* _FIRM_IR_PHASE_T_H */