X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firphase_t.h;h=9a6e4630ab1bf3b991e36fa09abaf63be3a9e784;hb=255a9cc77e3cdf878406d722cf8414063c87e99b;hp=a2d849982e8c440c806d03514b21c9edb2481d97;hpb=1bebdda91969b4d0d295d01886b66ec47e4b8cc4;p=libfirm diff --git a/ir/ir/irphase_t.h b/ir/ir/irphase_t.h index a2d849982..9a6e4630a 100644 --- a/ir/ir/irphase_t.h +++ b/ir/ir/irphase_t.h @@ -1,191 +1,177 @@ /* - * Project: libFIRM - * File name: ir/ir/irphase_t.c - * Purpose: Phase information handling using node indexes. - * Author: Sebastian Hack - * Modified by: - * Created: - * CVS-ID: $Id$ - * Copyright: (c) 1998-2007 Universitaet Karlsruhe - * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. + * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * This file may be distributed and/or modified under the terms of the + * GNU General Public License version 2 as published by the Free Software + * Foundation and appearing in the file LICENSE.GPL included in the + * packaging of this file. + * + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. + * + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. */ -#ifndef _FIRM_IR_PHASE_T_H -#define _FIRM_IR_PHASE_T_H +/** + * @file + * @brief Phase information handling using node indexes. + * @author Sebastian Hack + * @version $Id$ + */ +#ifndef FIRM_IR_PHASE_T_H +#define FIRM_IR_PHASE_T_H #include "firm_types.h" -#include "obstack.h" +#include "obst.h" #include "irgraph_t.h" #include "irtools.h" -#include "irtools.h" - -typedef struct { - unsigned node_slots; - unsigned node_slots_used; - unsigned node_data_bytes; - unsigned node_map_bytes; - unsigned overall_bytes; -} phase_stat_t; - -/** - * Phase statistics. - */ -phase_stat_t *phase_stat(const ir_phase *phase, phase_stat_t *stat); - -typedef void *(phase_irn_data_init_t)(ir_phase *phase, ir_node *irn, void *old); - -/** - * The default grow factor. - * The node => data map does not speculatively allocate more slots. - */ -#define PHASE_DEFAULT_GROWTH (256) +#include "irphase.h" /** * A phase object. */ -struct _ir_phase { - struct obstack obst; /**< The obstack where the irn phase data will be stored on. */ - const char *name; /**< The name of the phase. */ - ir_graph *irg; /**< The irg this phase will we applied to. */ - unsigned growth_factor; /**< factor to leave room for add. nodes. 256 means 1.0. */ - void *priv; /**< Some pointer private to the user of the phase. */ - size_t n_data_ptr; /**< The length of the data_ptr array. */ - void **data_ptr; /**< Map node indexes to irn data on the obstack. */ - phase_irn_data_init_t *data_init; /**< A callback that is called to initialize newly created node data. */ +struct ir_phase { + void **data_ptr; /**< Map node indexes to irn data on the obstack. */ + ir_graph *irg; /**< The irg this phase will we applied to. */ + phase_irn_init *data_init; /**< A callback that is called to initialize newly created node data. */ + size_t n_data_ptr; /**< The length of the data_ptr array. */ + struct obstack obst; /**< The obstack where the irn phase data will be stored on. */ + void *priv; /**< Some pointer private to the user of the phase. */ }; /** - * Initialize a phase object. - * @param name The name of the phase. - * @param irg The graph the phase will run on. - * @param growth_factor A factor denoting how many node slots will be additionally allocated, - * if the node => data is full. The factor is given in units of 1/256, so - * 256 means 1.0. - * @param irn_data_init A callback that is called to initialize newly created node data. - * Must be non-null. - * @param priv Some private pointer which is kept in the phase and can be retrieved with phase_get_private(). - * @return A new phase object. + * For statistics: A type containing statistic data of a phase object. */ -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); +typedef struct { + size_t node_slots; /**< The number of allocated node slots. */ + size_t node_slots_used; /**< The number of used node slots, i.e. nodes that have node data. */ + size_t node_map_bytes; /**< Number of used bytes for the node map. */ + size_t overall_bytes; /**< Overall number of used bytes for the phase. */ +} phase_stat_t; /** - * Free the phase and all node data associated with it. - * @param phase The phase. + * Collect Phase statistics. + * + * @param phase The phase. + * @param stat Will be filled with the statistical data. */ -void phase_free(ir_phase *phase); +phase_stat_t *phase_stat(const ir_phase *phase, phase_stat_t *stat); -/** - * Re-initialize the irn data for all nodes in the node => data map using the given callback. - * @param phase The phase. - */ -void phase_reinit_irn_data(ir_phase *phase); - -/** - * Re-initialize the irn data for all nodes in the given block. - * @param phase The phase. - * @param block The block. - */ -void phase_reinit_block_irn_data(ir_phase *phase, ir_node *block); /** * Re-initialize the irn data for the given node. - * @param phase The phase. - * @param irn The irn. + * + * @param phase The phase. + * @param irn The irn. */ -#define phase_reinit_single_irn_data(phase, irn) _phase_reinit_single_irn_data((phase), (irn)) +static inline void phase_reinit_single_irn_data(ir_phase *phase, ir_node *irn, + phase_irn_reinit *reinit) +{ + int idx; + + if (! phase->data_init) + return; + + idx = get_irn_idx(irn); + if (phase->data_ptr[idx]) + phase->data_ptr[idx] = reinit(phase, irn, phase->data_ptr[idx]); +} /** * Returns the first node of the phase having some data assigned. - * @param phase The phase. + * + * @param phase The phase. + * * @return The first irn having some data assigned, NULL otherwise */ -ir_node *phase_get_first_node(ir_phase *phase); +ir_node *phase_get_first_node(const ir_phase *phase); /** * Returns the next node after @p start having some data assigned. - * @param phase The phase. - * @param start The node to start from + * + * @param phase The phase. + * @param start The node to start from + * * @return The next node after start having some data assigned, NULL otherwise */ -ir_node *phase_get_next_node(ir_phase *phase, ir_node *start); +ir_node *phase_get_next_node(const ir_phase *phase, ir_node *start); /** * Convenience macro to iterate over all nodes of a phase * having some data assigned. + * + * @param phase The phase. + * @param irn A local variable that will hold the current node inside the loop. */ #define foreach_phase_irn(phase, irn) \ for (irn = phase_get_first_node(phase); irn; irn = phase_get_next_node(phase, irn)) -/** - * Get the name of the phase. - */ -#define phase_get_name(ph) ((ph)->name) - /** * Get the irg the phase runs on. + * + * @param phase The phase. */ -#define phase_get_irg(ph) ((ph)->irg) +static inline ir_graph *phase_get_irg(const ir_phase *phase) +{ + return phase->irg; +} /** * Get private data pointer as passed on creating the phase. + * + * @param phase The phase. */ -#define phase_get_private(ph) ((ph)->priv) - -/** - * Allocate memory in the phase's memory pool. - */ -#define phase_alloc(ph, size) obstack_alloc(phase_obst(ph), (size)) - -/** - * Get the obstack of the phase. - */ -#define phase_obst(ph) (&(ph)->obst) +static inline void *phase_get_private(const ir_phase *phase) +{ + return phase->priv; +} /** - * Get the phase data for an irn. - * @param ph The phase. - * @param irn The irn to get data for. - * @return A pointer to the data or NULL if the irn has no phase data. + * Attach pointer with private data to phase */ -#define phase_get_irn_data(ph, irn) _phase_get_irn_data((ph), (irn)) +static inline void phase_set_private(ir_phase *phase, void *priv) +{ + phase->priv = priv; +} -/** - * Get or set phase data for an irn. - * @param ph The phase. - * @param irn The irn to get (or set) node data for. - * @return A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one. - */ -#define phase_get_or_set_irn_data(ph, irn) _phase_get_or_set_irn_data((ph), (irn)) +static inline void *phase_alloc(ir_phase *phase, size_t size) +{ + return obstack_alloc(&phase->obst, size); +} /** - * Set the data for an irn. - * @param ph The phase. - * @param irn The node. - * @param data The data. - * @return The old data or NULL if there was none. + * Get the obstack of a phase. + * + * @param phase The phase. */ -#define phase_set_irn_data(ph, irn, data) _phase_set_irn_data((ph), (irn), (data)) +static inline struct obstack *phase_obst(ir_phase *phase) +{ + return &phase->obst; +} /** - * This is private and only here for performance reasons. + * Get the phase node data for an irn. + * + * @param phase The phase. + * @param irn The irn to get data for. + * + * @return A pointer to the node data or NULL if the irn has no phase data allocated yet. */ -static INLINE void _phase_reinit_single_irn_data(ir_phase *phase, ir_node *irn) +static inline void *phase_get_irn_data(const ir_phase *ph, const ir_node *irn) { - int idx; - - if (! phase->data_init) - return; - - idx = get_irn_idx(irn); - if (phase->data_ptr[idx]) - phase->data_init(phase, irn, phase->data_ptr[idx]); + unsigned idx = get_irn_idx(irn); + return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL; } - /** * This is private and just here for performance reasons. */ -static INLINE void _private_phase_enlarge(ir_phase *phase, unsigned max_idx) +static inline void private_phase_enlarge(ir_phase *phase, unsigned max_idx) { unsigned last_irg_idx = get_irg_last_idx(phase->irg); size_t old_cap = phase->n_data_ptr; @@ -193,60 +179,108 @@ static INLINE void _private_phase_enlarge(ir_phase *phase, unsigned max_idx) /* make the maximum index at least as big as the largest index in the graph. */ max_idx = MAX(max_idx, last_irg_idx); - new_cap = (size_t) (max_idx * phase->growth_factor / 256); + new_cap = (size_t) (max_idx + 256); - phase->data_ptr = (void **)xrealloc(phase->data_ptr, new_cap * sizeof(phase->data_ptr[0])); + phase->data_ptr = XREALLOC(phase->data_ptr, void*, new_cap); /* initialize the newly allocated memory. */ memset(phase->data_ptr + old_cap, 0, (new_cap - old_cap) * sizeof(phase->data_ptr[0])); phase->n_data_ptr = new_cap; } -/** +/* * This is private and only here for performance reasons. */ -#define _private_phase_assure_capacity(ph, max_idx) ((max_idx) >= (ph)->n_data_ptr ? (_private_phase_enlarge((ph), (max_idx)), 1) : 1) - -static INLINE void *_phase_get_irn_data(const ir_phase *ph, const ir_node *irn) +static inline void private_phase_assure_capacity(ir_phase *ph, unsigned max_idx) { - unsigned idx = get_irn_idx(irn); - return idx < ph->n_data_ptr ? ph->data_ptr[idx] : NULL; + if (max_idx >= ph->n_data_ptr) + private_phase_enlarge(ph, max_idx); } -static INLINE void *_phase_set_irn_data(ir_phase *ph, const ir_node *irn, void *data) + +/** + * Get or set phase data for an irn. + * + * @param phase The phase. + * @param irn The irn to get (or set) node data for. + * + * @return A (non-NULL) pointer to phase data for the irn. Either existent one or newly allocated one. + */ +static inline void *phase_get_or_set_irn_data(ir_phase *ph, const ir_node *irn) { unsigned idx = get_irn_idx(irn); void *res; /* Assure that there's a sufficient amount of slots. */ - _private_phase_assure_capacity(ph, idx); + private_phase_assure_capacity(ph, idx + 1); res = ph->data_ptr[idx]; - ph->data_ptr[idx] = data; + /* If there has no irn data allocated yet, do that now. */ + if(!res) { + phase_irn_init *data_init = ph->data_init; + + /* call the node data structure allocator/constructor. */ + res = ph->data_ptr[idx] = data_init(ph, irn); + } return res; } - -static INLINE void *_phase_get_or_set_irn_data(ir_phase *ph, ir_node *irn) +/** + * Set the node data for an irn. + * + * @param phase The phase. + * @param irn The node. + * @param data The node data. + * + * @return The old data or NULL if there was none. + */ +static inline void *phase_set_irn_data(ir_phase *ph, const ir_node *irn, + void *data) { unsigned idx = get_irn_idx(irn); void *res; /* Assure that there's a sufficient amount of slots. */ - _private_phase_assure_capacity(ph, idx); + private_phase_assure_capacity(ph, idx + 1); res = ph->data_ptr[idx]; + ph->data_ptr[idx] = data; - /* If there has no irn data allocated yet, do that now. */ - if(!res) { - phase_irn_data_init_t *data_init = ph->data_init; + return res; +} - /* call the node data structure allocator/constructor. */ - res = ph->data_ptr[idx] = data_init(ph, irn, NULL); +/** + * convenience function that returns phase information attached to a node + */ +static inline void *get_irn_phase_info(const ir_node *irn, ir_phase_id id) +{ + const ir_graph *irg = get_irn_irg(irn); + const ir_phase *ph = irg_get_phase(irg, id); + return phase_get_irn_data(ph, irn); +} - } - return res; +/** + * Get or set information a phase holds about a node. + * If the given phase does not hold information of the node, + * the information structure will be created, initialized (see the data_init + * function of ir_phase), and returned. + * @param irn The node. + * @param id The ID of the phase. + */ +static inline void *get_or_set_irn_phase_info(const ir_node *irn, ir_phase_id id) +{ + const ir_graph *irg = get_irn_irg(irn); + ir_phase *ph = irg_get_phase(irg, id); + return phase_get_or_set_irn_data(ph, irn); +} + +static inline void *set_irn_phase_info(const ir_node *irn, ir_phase_id id, + void *data) +{ + const ir_graph *irg = get_irn_irg(irn); + ir_phase *ph = irg_get_phase(irg, id); + return phase_set_irn_data(ph, irn, data); } -#endif /* _FIRM_IR_PHASE_T_H */ +#endif