isl_list_templ.c

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  * Copyright 2011      INRIA Saclay
   4  * Copyright 2012-2013 Ecole Normale Superieure
   5  * Copyright 2017      Sven Verdoolaege
   6  *
   7  * Use of this software is governed by the MIT license
   8  *
   9  * Written by Sven Verdoolaege, K.U.Leuven, Departement
  10  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
  11  * and INRIA Saclay - Ile-de-France, Parc Club Orsay Universite,
  12  * ZAC des vignes, 4 rue Jacques Monod, 91893 Orsay, France
  13  * and Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
  14  */
  15
  16 #include <isl_sort.h>
  17 #include <isl_tarjan.h>
  18 #include <isl/printer.h>
  19
  20 #define xCAT(A,B) A ## B
  21 #define CAT(A,B) xCAT(A,B)
  22 #undef EL
  23 #define EL CAT(isl_,BASE)
  24 #define xFN(TYPE,NAME) TYPE ## _ ## NAME
  25 #define FN(TYPE,NAME) xFN(TYPE,NAME)
  26 #define xLIST(EL) EL ## _list
  27 #define LIST(EL) xLIST(EL)
  28 #define xS(TYPE,NAME) struct TYPE ## _ ## NAME
  29 #define S(TYPE,NAME) xS(TYPE,NAME)
  30
  31 isl_ctx *FN(LIST(EL),get_ctx)(__isl_keep LIST(EL) *list)
  32 {
  33         return list ? list->ctx : NULL;
  34 }
  35
  36 __isl_give LIST(EL) *FN(LIST(EL),alloc)(isl_ctx *ctx, int n)
  37 {
  38         LIST(EL) *list;
  39
  40         if (n < 0)
  41                 isl_die(ctx, isl_error_invalid,
  42                         "cannot create list of negative length",
  43                         return NULL);
  44         list = isl_alloc(ctx, LIST(EL),
  45                          sizeof(LIST(EL)) + (n - 1) * sizeof(struct EL *));
  46         if (!list)
  47                 return NULL;
  48
  49         list->ctx = ctx;
  50         isl_ctx_ref(ctx);
  51         list->ref = 1;
  52         list->size = n;
  53         list->n = 0;
  54         return list;
  55 }
  56
  57 __isl_give LIST(EL) *FN(LIST(EL),copy)(__isl_keep LIST(EL) *list)
  58 {
  59         if (!list)
  60                 return NULL;
  61
  62         list->ref++;
  63         return list;
  64 }
  65
  66 __isl_give LIST(EL) *FN(LIST(EL),dup)(__isl_keep LIST(EL) *list)
  67 {
  68         int i;
  69         LIST(EL) *dup;
  70
  71         if (!list)
  72                 return NULL;
  73
  74         dup = FN(LIST(EL),alloc)(FN(LIST(EL),get_ctx)(list), list->n);
  75         if (!dup)
  76                 return NULL;
  77         for (i = 0; i < list->n; ++i)
  78                 dup = FN(LIST(EL),add)(dup, FN(EL,copy)(list->p[i]));
  79         return dup;
  80 }
  81
  82 __isl_give LIST(EL) *FN(LIST(EL),cow)(__isl_take LIST(EL) *list)
  83 {
  84         if (!list)
  85                 return NULL;
  86
  87         if (list->ref == 1)
  88                 return list;
  89         list->ref--;
  90         return FN(LIST(EL),dup)(list);
  91 }
  92
  93 /* Make sure "list" has room for at least "n" more pieces.
  94  * Always return a list with a single reference.
  95  *
  96  * If there is only one reference to list, we extend it in place.
  97  * Otherwise, we create a new LIST(EL) and copy the elements.
  98  */
  99 static __isl_give LIST(EL) *FN(LIST(EL),grow)(__isl_take LIST(EL) *list, int n)
 100 {
 101         isl_ctx *ctx;
 102         int i, new_size;
 103         LIST(EL) *res;
 104
 105         if (!list)
 106                 return NULL;
 107         if (list->ref == 1 && list->n + n <= list->size)
 108                 return list;
 109
 110         ctx = FN(LIST(EL),get_ctx)(list);
 111         new_size = ((list->n + n + 1) * 3) / 2;
 112         if (list->ref == 1) {
 113                 res = isl_realloc(ctx, list, LIST(EL),
 114                             sizeof(LIST(EL)) + (new_size - 1) * sizeof(EL *));
 115                 if (!res)
 116                         return FN(LIST(EL),free)(list);
 117                 res->size = new_size;
 118                 return res;
 119         }
 120
 121         if (list->n + n <= list->size && list->size < new_size)
 122                 new_size = list->size;
 123
 124         res = FN(LIST(EL),alloc)(ctx, new_size);
 125         if (!res)
 126                 return FN(LIST(EL),free)(list);
 127
 128         for (i = 0; i < list->n; ++i)
 129                 res = FN(LIST(EL),add)(res, FN(EL,copy)(list->p[i]));
 130
 131         FN(LIST(EL),free)(list);
 132         return res;
 133 }
 134
 135 /* Check that "index" is a valid position in "list".
 136  */
 137 static isl_stat FN(LIST(EL),check_index)(__isl_keep LIST(EL) *list, int index)
 138 {
 139         if (!list)
 140                 return isl_stat_error;
 141         if (index < 0 || index >= list->n)
 142                 isl_die(FN(LIST(EL),get_ctx)(list), isl_error_invalid,
 143                         "index out of bounds", return isl_stat_error);
 144         return isl_stat_ok;
 145 }
 146
 147 __isl_give LIST(EL) *FN(LIST(EL),add)(__isl_take LIST(EL) *list,
 148         __isl_take struct EL *el)
 149 {
 150         list = FN(LIST(EL),grow)(list, 1);
 151         if (!list || !el)
 152                 goto error;
 153         list->p[list->n] = el;
 154         list->n++;
 155         return list;
 156 error:
 157         FN(EL,free)(el);
 158         FN(LIST(EL),free)(list);
 159         return NULL;
 160 }
 161
 162 /* Remove the "n" elements starting at "first" from "list".
 163  */
 164 __isl_give LIST(EL) *FN(LIST(EL),drop)(__isl_take LIST(EL) *list,
 165         unsigned first, unsigned n)
 166 {
 167         int i;
 168
 169         if (!list)
 170                 return NULL;
 171         if (first + n > list->n || first + n < first)
 172                 isl_die(list->ctx, isl_error_invalid,
 173                         "index out of bounds", return FN(LIST(EL),free)(list));
 174         if (n == 0)
 175                 return list;
 176         list = FN(LIST(EL),cow)(list);
 177         if (!list)
 178                 return NULL;
 179         for (i = 0; i < n; ++i)
 180                 FN(EL,free)(list->p[first + i]);
 181         for (i = first; i + n < list->n; ++i)
 182                 list->p[i] = list->p[i + n];
 183         list->n -= n;
 184         return list;
 185 }
 186
 187 /* Insert "el" at position "pos" in "list".
 188  *
 189  * If there is only one reference to "list" and if it already has space
 190  * for one extra element, we insert it directly into "list".
 191  * Otherwise, we create a new list consisting of "el" and copied
 192  * elements from "list".
 193  */
 194 __isl_give LIST(EL) *FN(LIST(EL),insert)(__isl_take LIST(EL) *list,
 195         unsigned pos, __isl_take struct EL *el)
 196 {
 197         int i;
 198         isl_ctx *ctx;
 199         LIST(EL) *res;
 200
 201         if (!list || !el)
 202                 goto error;
 203         ctx = FN(LIST(EL),get_ctx)(list);
 204         if (pos > list->n)
 205                 isl_die(ctx, isl_error_invalid,
 206                         "index out of bounds", goto error);
 207
 208         if (list->ref == 1 && list->size > list->n) {
 209                 for (i = list->n; i > pos; --i)
 210                         list->p[i] = list->p[i - 1];
 211                 list->n++;
 212                 list->p[pos] = el;
 213                 return list;
 214         }
 215
 216         res = FN(LIST(EL),alloc)(ctx, list->n + 1);
 217         for (i = 0; i < pos; ++i)
 218                 res = FN(LIST(EL),add)(res, FN(EL,copy)(list->p[i]));
 219         res = FN(LIST(EL),add)(res, el);
 220         for (i = pos; i < list->n; ++i)
 221                 res = FN(LIST(EL),add)(res, FN(EL,copy)(list->p[i]));
 222         FN(LIST(EL),free)(list);
 223
 224         return res;
 225 error:
 226         FN(EL,free)(el);
 227         FN(LIST(EL),free)(list);
 228         return NULL;
 229 }
 230
 231 __isl_null LIST(EL) *FN(LIST(EL),free)(__isl_take LIST(EL) *list)
 232 {
 233         int i;
 234
 235         if (!list)
 236                 return NULL;
 237
 238         if (--list->ref > 0)
 239                 return NULL;
 240
 241         isl_ctx_deref(list->ctx);
 242         for (i = 0; i < list->n; ++i)
 243                 FN(EL,free)(list->p[i]);
 244         free(list);
 245
 246         return NULL;
 247 }
 248
 249 int FN(FN(LIST(EL),n),BASE)(__isl_keep LIST(EL) *list)
 250 {
 251         return list ? list->n : 0;
 252 }
 253
 254 __isl_give EL *FN(FN(LIST(EL),get),BASE)(__isl_keep LIST(EL) *list, int index)
 255 {
 256         if (FN(LIST(EL),check_index)(list, index) < 0)
 257                 return NULL;
 258         return FN(EL,copy)(list->p[index]);
 259 }
 260
 261 /* Replace the element at position "index" in "list" by "el".
 262  */
 263 __isl_give LIST(EL) *FN(FN(LIST(EL),set),BASE)(__isl_take LIST(EL) *list,
 264         int index, __isl_take EL *el)
 265 {
 266         if (!list || !el)
 267                 goto error;
 268         if (FN(LIST(EL),check_index)(list, index) < 0)
 269                 goto error;
 270         if (list->p[index] == el) {
 271                 FN(EL,free)(el);
 272                 return list;
 273         }
 274         list = FN(LIST(EL),cow)(list);
 275         if (!list)
 276                 goto error;
 277         FN(EL,free)(list->p[index]);
 278         list->p[index] = el;
 279         return list;
 280 error:
 281         FN(EL,free)(el);
 282         FN(LIST(EL),free)(list);
 283         return NULL;
 284 }
 285
 286 /* Return the element at position "index" of "list".
 287  * This may be either a copy or the element itself
 288  * if there is only one reference to "list".
 289  * This allows the element to be modified inplace
 290  * if both the list and the element have only a single reference.
 291  * The caller is not allowed to modify "list" between
 292  * this call to isl_list_*_take_* and a subsequent call
 293  * to isl_list_*_restore_*.
 294  * The only exception is that isl_list_*_free can be called instead.
 295  */
 296 static __isl_give EL *FN(FN(LIST(EL),take),BASE)(__isl_keep LIST(EL) *list,
 297         int index)
 298 {
 299         EL *el;
 300
 301         if (FN(LIST(EL),check_index)(list, index) < 0)
 302                 return NULL;
 303         if (list->ref != 1)
 304                 return FN(FN(LIST(EL),get),BASE)(list, index);
 305         el = list->p[index];
 306         list->p[index] = NULL;
 307         return el;
 308 }
 309
 310 /* Set the element at position "index" of "list" to "el",
 311  * where the position may be empty due to a previous call
 312  * to isl_list_*_take_*.
 313  */
 314 static __isl_give LIST(EL) *FN(FN(LIST(EL),restore),BASE)(
 315         __isl_take LIST(EL) *list, int index, __isl_take EL *el)
 316 {
 317         return FN(FN(LIST(EL),set),BASE)(list, index, el);
 318 }
 319
 320 isl_stat FN(LIST(EL),foreach)(__isl_keep LIST(EL) *list,
 321         isl_stat (*fn)(__isl_take EL *el, void *user), void *user)
 322 {
 323         int i;
 324
 325         if (!list)
 326                 return isl_stat_error;
 327
 328         for (i = 0; i < list->n; ++i) {
 329                 EL *el = FN(EL,copy)(list->p[i]);
 330                 if (!el)
 331                         return isl_stat_error;
 332                 if (fn(el, user) < 0)
 333                         return isl_stat_error;
 334         }
 335
 336         return isl_stat_ok;
 337 }
 338
 339 /* Replace each element in "list" by the result of calling "fn"
 340  * on the element.
 341  */
 342 __isl_give LIST(EL) *FN(LIST(EL),map)(__isl_keep LIST(EL) *list,
 343         __isl_give EL *(*fn)(__isl_take EL *el, void *user), void *user)
 344 {
 345         int i, n;
 346
 347         if (!list)
 348                 return NULL;
 349
 350         n = list->n;
 351         for (i = 0; i < n; ++i) {
 352                 EL *el = FN(FN(LIST(EL),take),BASE)(list, i);
 353                 if (!el)
 354                         return FN(LIST(EL),free)(list);
 355                 el = fn(el, user);
 356                 list = FN(FN(LIST(EL),restore),BASE)(list, i, el);
 357         }
 358
 359         return list;
 360 }
 361
 362 /* Internal data structure for isl_*_list_sort.
 363  *
 364  * "cmp" is the original comparison function.
 365  * "user" is a user provided pointer that should be passed to "cmp".
 366  */
 367 S(LIST(EL),sort_data) {
 368         int (*cmp)(__isl_keep EL *a, __isl_keep EL *b, void *user);
 369         void *user;
 370 };
 371
 372 /* Compare two entries of an isl_*_list based on the user provided
 373  * comparison function on pairs of isl_* objects.
 374  */
 375 static int FN(LIST(EL),cmp)(const void *a, const void *b, void *user)
 376 {
 377         S(LIST(EL),sort_data) *data = user;
 378         EL * const *el1 = a;
 379         EL * const *el2 = b;
 380
 381         return data->cmp(*el1, *el2, data->user);
 382 }
 383
 384 /* Sort the elements of "list" in ascending order according to
 385  * comparison function "cmp".
 386  */
 387 __isl_give LIST(EL) *FN(LIST(EL),sort)(__isl_take LIST(EL) *list,
 388         int (*cmp)(__isl_keep EL *a, __isl_keep EL *b, void *user), void *user)
 389 {
 390         S(LIST(EL),sort_data) data = { cmp, user };
 391
 392         if (!list)
 393                 return NULL;
 394         if (list->n <= 1)
 395                 return list;
 396         list = FN(LIST(EL),cow)(list);
 397         if (!list)
 398                 return NULL;
 399
 400         if (isl_sort(list->p, list->n, sizeof(list->p[0]),
 401                         &FN(LIST(EL),cmp), &data) < 0)
 402                 return FN(LIST(EL),free)(list);
 403
 404         return list;
 405 }
 406
 407 /* Internal data structure for isl_*_list_foreach_scc.
 408  *
 409  * "list" is the original list.
 410  * "follows" is the user provided callback that defines the edges of the graph.
 411  */
 412 S(LIST(EL),foreach_scc_data) {
 413         LIST(EL) *list;
 414         isl_bool (*follows)(__isl_keep EL *a, __isl_keep EL *b, void *user);
 415         void *follows_user;
 416 };
 417
 418 /* Does element i of data->list follow element j?
 419  *
 420  * Use the user provided callback to find out.
 421  */
 422 static isl_bool FN(LIST(EL),follows)(int i, int j, void *user)
 423 {
 424         S(LIST(EL),foreach_scc_data) *data = user;
 425
 426         return data->follows(data->list->p[i], data->list->p[j],
 427                                 data->follows_user);
 428 }
 429
 430 /* Call "fn" on the sublist of "list" that consists of the elements
 431  * with indices specified by the "n" elements of "pos".
 432  */
 433 static isl_stat FN(LIST(EL),call_on_scc)(__isl_keep LIST(EL) *list, int *pos,
 434         int n, isl_stat (*fn)(__isl_take LIST(EL) *scc, void *user), void *user)
 435 {
 436         int i;
 437         isl_ctx *ctx;
 438         LIST(EL) *slice;
 439
 440         ctx = FN(LIST(EL),get_ctx)(list);
 441         slice = FN(LIST(EL),alloc)(ctx, n);
 442         for (i = 0; i < n; ++i) {
 443                 EL *el;
 444
 445                 el = FN(EL,copy)(list->p[pos[i]]);
 446                 slice = FN(LIST(EL),add)(slice, el);
 447         }
 448
 449         return fn(slice, user);
 450 }
 451
 452 /* Call "fn" on each of the strongly connected components (SCCs) of
 453  * the graph with as vertices the elements of "list" and
 454  * a directed edge from node b to node a iff follows(a, b)
 455  * returns 1.  follows should return -1 on error.
 456  *
 457  * If SCC a contains a node i that follows a node j in another SCC b
 458  * (i.e., follows(i, j, user) returns 1), then fn will be called on SCC a
 459  * after being called on SCC b.
 460  *
 461  * We simply call isl_tarjan_graph_init, extract the SCCs from the result and
 462  * call fn on each of them.
 463  */
 464 isl_stat FN(LIST(EL),foreach_scc)(__isl_keep LIST(EL) *list,
 465         isl_bool (*follows)(__isl_keep EL *a, __isl_keep EL *b, void *user),
 466         void *follows_user,
 467         isl_stat (*fn)(__isl_take LIST(EL) *scc, void *user), void *fn_user)
 468 {
 469         S(LIST(EL),foreach_scc_data) data = { list, follows, follows_user };
 470         int i, n;
 471         isl_ctx *ctx;
 472         struct isl_tarjan_graph *g;
 473
 474         if (!list)
 475                 return isl_stat_error;
 476         if (list->n == 0)
 477                 return isl_stat_ok;
 478         if (list->n == 1)
 479                 return fn(FN(LIST(EL),copy)(list), fn_user);
 480
 481         ctx = FN(LIST(EL),get_ctx)(list);
 482         n = list->n;
 483         g = isl_tarjan_graph_init(ctx, n, &FN(LIST(EL),follows), &data);
 484         if (!g)
 485                 return isl_stat_error;
 486
 487         i = 0;
 488         do {
 489                 int first;
 490
 491                 if (g->order[i] == -1)
 492                         isl_die(ctx, isl_error_internal, "cannot happen",
 493                                 break);
 494                 first = i;
 495                 while (g->order[i] != -1) {
 496                         ++i; --n;
 497                 }
 498                 if (first == 0 && n == 0) {
 499                         isl_tarjan_graph_free(g);
 500                         return fn(FN(LIST(EL),copy)(list), fn_user);
 501                 }
 502                 if (FN(LIST(EL),call_on_scc)(list, g->order + first, i - first,
 503                                             fn, fn_user) < 0)
 504                         break;
 505                 ++i;
 506         } while (n);
 507
 508         isl_tarjan_graph_free(g);
 509
 510         return n > 0 ? isl_stat_error : isl_stat_ok;
 511 }
 512
 513 __isl_give LIST(EL) *FN(FN(LIST(EL),from),BASE)(__isl_take EL *el)
 514 {
 515         isl_ctx *ctx;
 516         LIST(EL) *list;
 517
 518         if (!el)
 519                 return NULL;
 520         ctx = FN(EL,get_ctx)(el);
 521         list = FN(LIST(EL),alloc)(ctx, 1);
 522         if (!list)
 523                 goto error;
 524         list = FN(LIST(EL),add)(list, el);
 525         return list;
 526 error:
 527         FN(EL,free)(el);
 528         return NULL;
 529 }
 530
 531 /* Append the elements of "list2" to "list1", where "list1" is known
 532  * to have only a single reference and enough room to hold
 533  * the extra elements.
 534  */
 535 static __isl_give LIST(EL) *FN(LIST(EL),concat_inplace)(
 536         __isl_take LIST(EL) *list1, __isl_take LIST(EL) *list2)
 537 {
 538         int i;
 539
 540         for (i = 0; i < list2->n; ++i)
 541                 list1 = FN(LIST(EL),add)(list1, FN(EL,copy)(list2->p[i]));
 542         FN(LIST(EL),free)(list2);
 543         return list1;
 544 }
 545
 546 /* Concatenate "list1" and "list2".
 547  * If "list1" has only one reference and has enough room
 548  * for the elements of "list2", the add the elements to "list1" itself.
 549  * Otherwise, create a new list to store the result.
 550  */
 551 __isl_give LIST(EL) *FN(LIST(EL),concat)(__isl_take LIST(EL) *list1,
 552         __isl_take LIST(EL) *list2)
 553 {
 554         int i;
 555         isl_ctx *ctx;
 556         LIST(EL) *res;
 557
 558         if (!list1 || !list2)
 559                 goto error;
 560
 561         if (list1->ref == 1 && list1->n + list2->n <= list1->size)
 562                 return FN(LIST(EL),concat_inplace)(list1, list2);
 563
 564         ctx = FN(LIST(EL),get_ctx)(list1);
 565         res = FN(LIST(EL),alloc)(ctx, list1->n + list2->n);
 566         for (i = 0; i < list1->n; ++i)
 567                 res = FN(LIST(EL),add)(res, FN(EL,copy)(list1->p[i]));
 568         for (i = 0; i < list2->n; ++i)
 569                 res = FN(LIST(EL),add)(res, FN(EL,copy)(list2->p[i]));
 570
 571         FN(LIST(EL),free)(list1);
 572         FN(LIST(EL),free)(list2);
 573         return res;
 574 error:
 575         FN(LIST(EL),free)(list1);
 576         FN(LIST(EL),free)(list2);
 577         return NULL;
 578 }
 579
 580 __isl_give isl_printer *CAT(isl_printer_print_,LIST(BASE))(
 581         __isl_take isl_printer *p, __isl_keep LIST(EL) *list)
 582 {
 583         int i;
 584
 585         if (!p || !list)
 586                 goto error;
 587         p = isl_printer_print_str(p, "(");
 588         for (i = 0; i < list->n; ++i) {
 589                 if (i)
 590                         p = isl_printer_print_str(p, ",");
 591                 p = CAT(isl_printer_print_,BASE)(p, list->p[i]);
 592         }
 593         p = isl_printer_print_str(p, ")");
 594         return p;
 595 error:
 596         isl_printer_free(p);
 597         return NULL;
 598 }
 599
 600 void FN(LIST(EL),dump)(__isl_keep LIST(EL) *list)
 601 {
 602         isl_printer *printer;
 603
 604         if (!list)
 605                 return;
 606
 607         printer = isl_printer_to_file(FN(LIST(EL),get_ctx)(list), stderr);
 608         printer = CAT(isl_printer_print_,LIST(BASE))(printer, list);
 609         printer = isl_printer_end_line(printer);
 610
 611         isl_printer_free(printer);
 612 }