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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @author    Michael Beck
  23  * @brief     A linked nodemap.
  24  */
  25 #ifndef _FIRM_IRLINKEDNODEMAP_H_
  26 #define _FIRM_IRLINKEDNODEMAP_H_
  27
  28 #include "firm_types.h"
  29 #include "xmalloc.h"
  30 #include "list.h"
  31
  32 /*
  33  * sebastian experimental:
  34  * use ordered arrays as node sets.
  35  * the guys here have made good experiences with that.
  36  * Internally we use normal Firm arrays and binary
  37  * search for locating the elements. Using arrays should
  38  * give the sets a small footprint.
  39  */
  40 #undef IR_nodemap_USE_ORDERED_SETS
  41
  42 typedef struct ir_lnk_nodemap_entry_t {
  43         ir_node     *node;  /**< the node itself */
  44         void        *data;  /**< associated data */
  45         list_head   list;   /**< link field for the list iterator */
  46 } ir_lnk_nodemap_entry_t;
  47
  48 #define HashSet          ir_lnk_nodemap_t
  49 #define ValueType        ir_lnk_nodemap_entry_t
  50 #define ADDITIONAL_DATA  list_head elem_list; list_head all_iters;
  51 #define DO_REHASH
  52
  53 #include "hashset.h"
  54
  55 #undef DO_REHASH
  56 #undef ADDITIONAL_DATA
  57 #undef ValueType
  58 #undef HashSet
  59
  60 typedef struct ir_lnk_nodemap_t ir_lnk_nodemap_t;
  61 typedef struct ir_lnk_nodemap_iterator_t {
  62         list_head              *iter;       /**< points to the list head of the last element */
  63         const ir_lnk_nodemap_t *nodemap;    /**< lithe nodemap of this iterator. */
  64 } ir_lnk_nodemap_iterator_t;
  65
  66 /**
  67  * Initializes a linked nodemap with default size.
  68  *
  69  * @param nodemap      Pointer to allocated space for the nodemap
  70  */
  71 void ir_lnk_nodemap_init(ir_lnk_nodemap_t *nodemap);
  72
  73 /**
  74  * Initializes a linked nodemap.
  75  *
  76  * @param nodemap             Pointer to allocated space for the nodemap
  77  * @param expected_elements   Number of elements expected in the nodemap (roughly)
  78  */
  79 void ir_lnk_nodemap_init_size(ir_lnk_nodemap_t *nodemap, size_t expected_elements);
  80
  81 /**
  82  * Destroys a nodemap and frees the memory allocated for hashtable. The memory of
  83  * the nodemap itself is not freed.
  84  *
  85  * @param nodemap   Pointer to the nodemap
  86  */
  87 void ir_lnk_nodemap_destroy(ir_lnk_nodemap_t *nodemap);
  88
  89 /**
  90  * Allocates memory for a linked nodemap and initializes the set.
  91  *
  92  * @param expected_elements   Number of elements expected in the nodemap (roughly)
  93  * @return The initialized nodemap
  94  */
  95 static inline ir_lnk_nodemap_t *ir_lnk_nodemap_new(size_t expected_elements) {
  96         ir_lnk_nodemap_t *res = XMALLOC(ir_lnk_nodemap_t);
  97         ir_lnk_nodemap_init_size(res, expected_elements);
  98         return res;
  99 }
 100
 101 /**
 102  * Destroys a linked nodemap and frees the memory of the nodemap itself.
 103  */
 104 static inline void ir_lnk_nodemap_del(ir_lnk_nodemap_t *nodemap) {
 105         ir_lnk_nodemap_destroy(nodemap);
 106         xfree(nodemap);
 107 }
 108
 109 /**
 110  * Inserts a node into a linked nodemap.
 111  *
 112  * @param nodemap   Pointer to the nodemap
 113  * @param node      node to insert into the nodemap
 114  * @param data      data to associate with the node
 115  * @returns         1 if the element has been inserted,
 116  *                  0 if it was already there
 117  */
 118 int ir_lnk_nodemap_put(ir_lnk_nodemap_t *nodemap, ir_node *node, void *data);
 119
 120 /**
 121  * Get the associated value of a specific node
 122  *
 123  * @param nodemap   Pointer to the nodemap
 124  * @param node      The pointer to find
 125  * @returns         the associated data of the node or NULL
 126  */
 127 void *ir_lnk_nodemap_get(const ir_lnk_nodemap_t *nodemap, const ir_node *node);
 128
 129 /**
 130  * Removes a node from a linked nodemap. Does nothing if the nodemap doesn't contain
 131  * the node.
 132  *
 133  * @param nodemap  Pointer to the nodemap
 134  * @param node     Node to remove from the nodemap
 135  */
 136 void ir_lnk_nodemap_remove(ir_lnk_nodemap_t *nodemap, const ir_node *node);
 137
 138 /**
 139  * Returns the number of nodes contained in the linked nodemap.
 140  *
 141  * @param nodemap   Pointer to the nodemap
 142  * @returns         Number of nodes contained in the linked nodemap
 143  */
 144 size_t ir_lnk_nodemap_size(const ir_lnk_nodemap_t *nodemap);
 145
 146 /**
 147  * Initializes a nodemap iterator. Sets the iterator before the first element in
 148  * the linked nodemap.
 149  *
 150  * @param iterator   Pointer to already allocated iterator memory
 151  * @param nodemap       Pointer to the nodemap
 152  */
 153 void ir_lnk_nodemap_iterator_init(ir_lnk_nodemap_iterator_t *iterator,
 154                                   const ir_lnk_nodemap_t *nodemap);
 155
 156 /**
 157  * Advances the iterator and returns the current element or NULL if all elements
 158  * in the linked nodemap have been processed.
 159  * @attention It is not allowed to use ir_lnk_nodemap_insert or ir_lnk_nodemap_remove while
 160  *            iterating over a nodemap.
 161  *
 162  * @param iterator  Pointer to the nodemap iterator.
 163  * @returns         Next element in the nodemap or NULL
 164  */
 165 ir_node *ir_lnk_nodemap_iterator_next(ir_lnk_nodemap_iterator_t *iterator);
 166
 167 /**
 168  * Removes the element the iterator currently points to.
 169  *
 170  * @param nodemap   Pointer to the linked nodemap
 171  * @param iterator  Pointer to the linked nodemap iterator.
 172  */
 173 void ir_lnk_nodemap_remove_iterator(ir_lnk_nodemap_t *nodemap,
 174                                     ir_lnk_nodemap_iterator_t *iterator);
 175
 176 #define foreach_ir_lnk_nodemap(nodemap, irn, iter) \
 177         for (ir_lnk_nodemap_iterator_init(&iter, nodemap), \
 178         irn = ir_lnk_nodemap_iterator_next(&iter);    \
 179                 irn != NULL; irn = ir_lnk_nodemap_iterator_next(&iter))
 180
 181 #endif