isl_hmap_templ.c

   1 /*
   2  * Copyright 2011      INRIA Saclay
   3  * Copyright 2013      Ecole Normale Superieure
   4  *
   5  * Use of this software is governed by the MIT license
   6  *
   7  * Written by Sven Verdoolaege, INRIA Saclay - Ile-de-France,
   8  * Parc Club Orsay Universite, ZAC des vignes, 4 rue Jacques Monod,
   9  * 91893 Orsay, France
  10  * and Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
  11  */
  12
  13 #include <isl/ctx.h>
  14 #include <isl/hash.h>
  15
  16 #define xCAT(A,B) A ## B
  17 #define CAT(A,B) xCAT(A,B)
  18 #define KEY CAT(isl_,KEY_BASE)
  19 #define VAL CAT(isl_,VAL_BASE)
  20 #define xFN(TYPE,NAME) TYPE ## _ ## NAME
  21 #define FN(TYPE,NAME) xFN(TYPE,NAME)
  22 #define xHMAP(KEY,VAL_BASE) KEY ## _to_ ## VAL_BASE
  23 #define yHMAP(KEY,VAL_BASE) xHMAP(KEY,VAL_BASE)
  24 #define HMAP yHMAP(KEY,VAL_BASE)
  25 #define HMAP_BASE yHMAP(KEY_BASE,VAL_BASE)
  26 #define xS(TYPE1,TYPE2,NAME) struct isl_ ## TYPE1 ## _ ## TYPE2 ## _ ## NAME
  27 #define yS(TYPE1,TYPE2,NAME) xS(TYPE1,TYPE2,NAME)
  28 #define S(NAME) yS(KEY_BASE,VAL_BASE,NAME)
  29
  30 struct HMAP {
  31         int ref;
  32         isl_ctx *ctx;
  33         struct isl_hash_table table;
  34 };
  35
  36 S(pair) {
  37         KEY *key;
  38         VAL *val;
  39 };
  40
  41 __isl_give HMAP *FN(HMAP,alloc)(isl_ctx *ctx, int min_size)
  42 {
  43         HMAP *hmap;
  44
  45         hmap = isl_calloc_type(ctx, HMAP);
  46         if (!hmap)
  47                 return NULL;
  48
  49         hmap->ctx = ctx;
  50         isl_ctx_ref(ctx);
  51         hmap->ref = 1;
  52
  53         if (isl_hash_table_init(ctx, &hmap->table, min_size) < 0)
  54                 return FN(HMAP,free)(hmap);
  55
  56         return hmap;
  57 }
  58
  59 static int free_pair(void **entry, void *user)
  60 {
  61         S(pair) *pair = *entry;
  62         FN(KEY,free)(pair->key);
  63         FN(VAL,free)(pair->val);
  64         free(pair);
  65         *entry = NULL;
  66         return 0;
  67 }
  68
  69 __isl_null HMAP *FN(HMAP,free)(__isl_take HMAP *hmap)
  70 {
  71         if (!hmap)
  72                 return NULL;
  73         if (--hmap->ref > 0)
  74                 return NULL;
  75         isl_hash_table_foreach(hmap->ctx, &hmap->table, &free_pair, NULL);
  76         isl_hash_table_clear(&hmap->table);
  77         isl_ctx_deref(hmap->ctx);
  78         free(hmap);
  79         return NULL;
  80 }
  81
  82 isl_ctx *FN(HMAP,get_ctx)(__isl_keep HMAP *hmap)
  83 {
  84         return hmap ? hmap->ctx : NULL;
  85 }
  86
  87 /* Add a mapping from "key" to "val" to the associative array
  88  * pointed to by user.
  89  */
  90 static int add_key_val(__isl_take KEY *key, __isl_take VAL *val, void *user)
  91 {
  92         HMAP **hmap = (HMAP **) user;
  93
  94         *hmap = FN(HMAP,set)(*hmap, key, val);
  95
  96         if (!*hmap)
  97                 return -1;
  98
  99         return 0;
 100 }
 101
 102 __isl_give HMAP *FN(HMAP,dup)(__isl_keep HMAP *hmap)
 103 {
 104         HMAP *dup;
 105
 106         if (!hmap)
 107                 return NULL;
 108
 109         dup = FN(HMAP,alloc)(hmap->ctx, hmap->table.n);
 110         if (FN(HMAP,foreach)(hmap, &add_key_val, &dup) < 0)
 111                 return FN(HMAP,free)(dup);
 112
 113         return dup;
 114 }
 115
 116 __isl_give HMAP *FN(HMAP,cow)(__isl_take HMAP *hmap)
 117 {
 118         if (!hmap)
 119                 return NULL;
 120
 121         if (hmap->ref == 1)
 122                 return hmap;
 123         hmap->ref--;
 124         return FN(HMAP,dup)(hmap);
 125 }
 126
 127 __isl_give HMAP *FN(HMAP,copy)(__isl_keep HMAP *hmap)
 128 {
 129         if (!hmap)
 130                 return NULL;
 131
 132         hmap->ref++;
 133         return hmap;
 134 }
 135
 136 static int has_key(const void *entry, const void *c_key)
 137 {
 138         const S(pair) *pair = entry;
 139         KEY *key = (KEY *) c_key;
 140
 141         return KEY_EQUAL(pair->key, key);
 142 }
 143
 144 int FN(HMAP,has)(__isl_keep HMAP *hmap, __isl_keep KEY *key)
 145 {
 146         uint32_t hash;
 147
 148         if (!hmap)
 149                 return -1;
 150
 151         hash = FN(KEY,get_hash)(key);
 152         return !!isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 153                                         &has_key, key, 0);
 154 }
 155
 156 __isl_give VAL *FN(HMAP,get)(__isl_keep HMAP *hmap, __isl_take KEY *key)
 157 {
 158         struct isl_hash_table_entry *entry;
 159         S(pair) *pair;
 160         uint32_t hash;
 161
 162         if (!hmap || !key)
 163                 goto error;
 164
 165         hash = FN(KEY,get_hash)(key);
 166         entry = isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 167                                         &has_key, key, 0);
 168         FN(KEY,free)(key);
 169
 170         if (!entry)
 171                 return NULL;
 172
 173         pair = entry->data;
 174
 175         return FN(VAL,copy)(pair->val);
 176 error:
 177         FN(KEY,free)(key);
 178         return NULL;
 179 }
 180
 181 /* Remove the mapping between "key" and its associated value (if any)
 182  * from "hmap".
 183  *
 184  * If "key" is not mapped to anything, then we leave "hmap" untouched"
 185  */
 186 __isl_give HMAP *FN(HMAP,drop)(__isl_take HMAP *hmap, __isl_take KEY *key)
 187 {
 188         struct isl_hash_table_entry *entry;
 189         S(pair) *pair;
 190         uint32_t hash;
 191
 192         if (!hmap || !key)
 193                 goto error;
 194
 195         hash = FN(KEY,get_hash)(key);
 196         entry = isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 197                                         &has_key, key, 0);
 198         if (!entry) {
 199                 FN(KEY,free)(key);
 200                 return hmap;
 201         }
 202
 203         hmap = FN(HMAP,cow)(hmap);
 204         if (!hmap)
 205                 goto error;
 206         entry = isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 207                                         &has_key, key, 0);
 208         FN(KEY,free)(key);
 209
 210         if (!entry)
 211                 isl_die(hmap->ctx, isl_error_internal,
 212                         "missing entry" , goto error);
 213
 214         pair = entry->data;
 215         isl_hash_table_remove(hmap->ctx, &hmap->table, entry);
 216         FN(KEY,free)(pair->key);
 217         FN(VAL,free)(pair->val);
 218         free(pair);
 219
 220         return hmap;
 221 error:
 222         FN(KEY,free)(key);
 223         FN(HMAP,free)(hmap);
 224         return NULL;
 225 }
 226
 227 /* Add a mapping from "key" to "val" to "hmap".
 228  * If "key" was already mapped to something else, then that mapping
 229  * is replaced.
 230  * If key happened to be mapped to "val" already, then we leave
 231  * "hmap" untouched.
 232  */
 233 __isl_give HMAP *FN(HMAP,set)(__isl_take HMAP *hmap,
 234         __isl_take KEY *key, __isl_take VAL *val)
 235 {
 236         struct isl_hash_table_entry *entry;
 237         S(pair) *pair;
 238         uint32_t hash;
 239
 240         if (!hmap || !key || !val)
 241                 goto error;
 242
 243         hash = FN(KEY,get_hash)(key);
 244         entry = isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 245                                         &has_key, key, 0);
 246         if (entry) {
 247                 int equal;
 248                 pair = entry->data;
 249                 equal = VAL_EQUAL(pair->val, val);
 250                 if (equal < 0)
 251                         goto error;
 252                 if (equal) {
 253                         FN(KEY,free)(key);
 254                         FN(VAL,free)(val);
 255                         return hmap;
 256                 }
 257         }
 258
 259         hmap = FN(HMAP,cow)(hmap);
 260         if (!hmap)
 261                 goto error;
 262
 263         entry = isl_hash_table_find(hmap->ctx, &hmap->table, hash,
 264                                         &has_key, key, 1);
 265
 266         if (!entry)
 267                 goto error;
 268
 269         if (entry->data) {
 270                 pair = entry->data;
 271                 FN(VAL,free)(pair->val);
 272                 pair->val = val;
 273                 FN(KEY,free)(key);
 274                 return hmap;
 275         }
 276
 277         pair = isl_alloc_type(hmap->ctx, S(pair));
 278         if (!pair)
 279                 goto error;
 280
 281         entry->data = pair;
 282         pair->key = key;
 283         pair->val = val;
 284         return hmap;
 285 error:
 286         FN(KEY,free)(key);
 287         FN(VAL,free)(val);
 288         return FN(HMAP,free)(hmap);
 289 }
 290
 291 /* Internal data structure for isl_map_to_basic_set_foreach.
 292  *
 293  * fn is the function that should be called on each entry.
 294  * user is the user-specified final argument to fn.
 295  */
 296 S(foreach_data) {
 297         int (*fn)(__isl_take KEY *key, __isl_take VAL *val, void *user);
 298         void *user;
 299 };
 300
 301 /* Call data->fn on a copy of the key and value in *entry.
 302  */
 303 static int call_on_copy(void **entry, void *user)
 304 {
 305         S(pair) *pair = *entry;
 306         S(foreach_data) *data = (S(foreach_data) *) user;
 307
 308         return data->fn(FN(KEY,copy)(pair->key), FN(VAL,copy)(pair->val),
 309                         data->user);
 310 }
 311
 312 /* Call "fn" on each pair of key and value in "hmap".
 313  */
 314 int FN(HMAP,foreach)(__isl_keep HMAP *hmap,
 315         int (*fn)(__isl_take KEY *key, __isl_take VAL *val, void *user),
 316         void *user)
 317 {
 318         S(foreach_data) data = { fn, user };
 319
 320         if (!hmap)
 321                 return -1;
 322
 323         return isl_hash_table_foreach(hmap->ctx, &hmap->table,
 324                                       &call_on_copy, &data);
 325 }
 326
 327 /* Internal data structure for print_pair.
 328  *
 329  * p is the printer on which the associative array is being printed.
 330  * first is set if the current key-value pair is the first to be printed.
 331  */
 332 S(print_data) {
 333         isl_printer *p;
 334         int first;
 335 };
 336
 337 /* Print the given key-value pair to data->p.
 338  */
 339 static int print_pair(__isl_take KEY *key, __isl_take VAL *val, void *user)
 340 {
 341         S(print_data) *data = user;
 342
 343         if (!data->first)
 344                 data->p = isl_printer_print_str(data->p, ", ");
 345         data->p = FN(isl_printer_print,KEY_BASE)(data->p, key);
 346         data->p = isl_printer_print_str(data->p, ": ");
 347         data->p = FN(isl_printer_print,VAL_BASE)(data->p, val);
 348         data->first = 0;
 349
 350         FN(KEY,free)(key);
 351         FN(VAL,free)(val);
 352         return 0;
 353 }
 354
 355 /* Print the associative array to "p".
 356  */
 357 __isl_give isl_printer *FN(isl_printer_print,HMAP_BASE)(
 358         __isl_take isl_printer *p, __isl_keep HMAP *hmap)
 359 {
 360         S(print_data) data;
 361
 362         if (!p || !hmap)
 363                 return isl_printer_free(p);
 364
 365         p = isl_printer_print_str(p, "{");
 366         data.p = p;
 367         data.first = 1;
 368         if (FN(HMAP,foreach)(hmap, &print_pair, &data) < 0)
 369                 data.p = isl_printer_free(data.p);
 370         p = data.p;
 371         p = isl_printer_print_str(p, "}");
 372
 373         return p;
 374 }
 375
 376 void FN(HMAP,dump)(__isl_keep HMAP *hmap)
 377 {
 378         isl_printer *printer;
 379
 380         if (!hmap)
 381                 return;
 382
 383         printer = isl_printer_to_file(FN(HMAP,get_ctx)(hmap), stderr);
 384         printer = FN(isl_printer_print,HMAP_BASE)(printer, hmap);
 385         printer = isl_printer_end_line(printer);
 386
 387         isl_printer_free(printer);
 388 }