add isl_aff_mod_val
[platform/upstream/isl.git] / isl_band.c
index 53582f0..43e9f01 100644 (file)
@@ -1,20 +1,78 @@
 /*
  * Copyright 2011      INRIA Saclay
+ * Copyright 2012-2013 Ecole Normale Superieure
  *
- * Use of this software is governed by the GNU LGPLv2.1 license
+ * Use of this software is governed by the MIT license
  *
  * Written by Sven Verdoolaege, INRIA Saclay - Ile-de-France,
  * Parc Club Orsay Universite, ZAC des vignes, 4 rue Jacques Monod,
  * 91893 Orsay, France
+ * and Ecole Normale Superieure, 45 rue d'Ulm, 75230 Paris, France
  */
 
 #include <isl_band_private.h>
 #include <isl_schedule_private.h>
-#include <isl_list_private.h>
+
+#undef BASE
+#define BASE band
+
+#include <isl_list_templ.c>
 
 isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band)
 {
-       return band ? isl_union_map_get_ctx(band->map) : NULL;
+       return band ? isl_union_pw_multi_aff_get_ctx(band->pma) : NULL;
+}
+
+__isl_give isl_band *isl_band_alloc(isl_ctx *ctx)
+{
+       isl_band *band;
+
+       band = isl_calloc_type(ctx, isl_band);
+       if (!band)
+               return NULL;
+
+       band->ref = 1;
+
+       return band;
+}
+
+/* Create a duplicate of the given band.  The duplicate refers
+ * to the same schedule and parent as the input, but does not
+ * increment their reference counts.
+ */
+__isl_give isl_band *isl_band_dup(__isl_keep isl_band *band)
+{
+       int i;
+       isl_ctx *ctx;
+       isl_band *dup;
+
+       if (!band)
+               return NULL;
+
+       ctx = isl_band_get_ctx(band);
+       dup = isl_band_alloc(ctx);
+       if (!dup)
+               return NULL;
+
+       dup->n = band->n;
+       dup->zero = isl_alloc_array(ctx, int, band->n);
+       if (!dup->zero)
+               goto error;
+
+       for (i = 0; i < band->n; ++i)
+               dup->zero[i] = band->zero[i];
+
+       dup->pma = isl_union_pw_multi_aff_copy(band->pma);
+       dup->schedule = band->schedule;
+       dup->parent = band->parent;
+
+       if (!dup->pma)
+               goto error;
+
+       return dup;
+error:
+       isl_band_free(dup);
+       return NULL;
 }
 
 /* We not only increment the reference count of the band,
@@ -46,7 +104,7 @@ void *isl_band_free(__isl_take isl_band *band)
        if (--band->ref > 0)
                return isl_schedule_free(band->schedule);
 
-       isl_union_map_free(band->map);
+       isl_union_pw_multi_aff_free(band->pma);
        isl_band_list_free(band->children);
        free(band->zero);
        free(band);
@@ -98,21 +156,34 @@ int isl_band_member_is_zero_distance(__isl_keep isl_band *band, int pos)
 __isl_give isl_union_map *isl_band_get_prefix_schedule(
        __isl_keep isl_band *band)
 {
-       isl_union_map *prefix;
+       isl_union_set *domain;
+       isl_union_pw_multi_aff *prefix;
        isl_band *a;
 
        if (!band)
                return NULL;
 
-       prefix = isl_union_map_copy(band->map);
-       prefix = isl_union_map_from_domain(isl_union_map_domain(prefix));
+       prefix = isl_union_pw_multi_aff_copy(band->pma);
+       domain = isl_union_pw_multi_aff_domain(prefix);
+       prefix = isl_union_pw_multi_aff_from_domain(domain);
 
        for (a = band->parent; a; a = a->parent) {
-               isl_union_map *partial = isl_union_map_copy(a->map);
-               prefix = isl_union_map_flat_range_product(partial, prefix);
+               isl_union_pw_multi_aff *partial;
+
+               partial = isl_union_pw_multi_aff_copy(a->pma);
+               prefix = isl_union_pw_multi_aff_flat_range_product(partial,
+                                                                  prefix);
        }
 
-       return prefix;
+       return isl_union_map_from_union_pw_multi_aff(prefix);
+}
+
+/* Return the schedule of the band in isolation.
+ */
+__isl_give isl_union_pw_multi_aff *
+isl_band_get_partial_schedule_union_pw_multi_aff(__isl_keep isl_band *band)
+{
+       return band ? isl_union_pw_multi_aff_copy(band->pma) : NULL;
 }
 
 /* Return the schedule of the band in isolation.
@@ -120,49 +191,443 @@ __isl_give isl_union_map *isl_band_get_prefix_schedule(
 __isl_give isl_union_map *isl_band_get_partial_schedule(
        __isl_keep isl_band *band)
 {
-       return band ? isl_union_map_copy(band->map) : NULL;
+       isl_union_pw_multi_aff *sched;
+
+       sched = isl_band_get_partial_schedule_union_pw_multi_aff(band);
+       return isl_union_map_from_union_pw_multi_aff(sched);
+}
+
+__isl_give isl_union_pw_multi_aff *
+isl_band_get_suffix_schedule_union_pw_multi_aff(__isl_keep isl_band *band);
+
+/* Return the schedule for the given band list.
+ * For each band in the list, the schedule is composed of the partial
+ * and suffix schedules of that band.
+ */
+__isl_give isl_union_pw_multi_aff *
+isl_band_list_get_suffix_schedule_union_pw_multi_aff(
+       __isl_keep isl_band_list *list)
+{
+       isl_ctx *ctx;
+       int i, n;
+       isl_space *space;
+       isl_union_pw_multi_aff *suffix;
+
+       if (!list)
+               return NULL;
+
+       ctx = isl_band_list_get_ctx(list);
+       space = isl_space_alloc(ctx, 0, 0, 0);
+       suffix = isl_union_pw_multi_aff_empty(space);
+       n = isl_band_list_n_band(list);
+       for (i = 0; i < n; ++i) {
+               isl_band *el;
+               isl_union_pw_multi_aff *partial;
+               isl_union_pw_multi_aff *suffix_i;
+
+               el = isl_band_list_get_band(list, i);
+               partial = isl_band_get_partial_schedule_union_pw_multi_aff(el);
+               suffix_i = isl_band_get_suffix_schedule_union_pw_multi_aff(el);
+               suffix_i = isl_union_pw_multi_aff_flat_range_product(
+                               partial, suffix_i);
+               suffix = isl_union_pw_multi_aff_add(suffix, suffix_i);
+
+               isl_band_free(el);
+       }
+
+       return suffix;
+}
+
+/* Return the schedule for the given band list.
+ * For each band in the list, the schedule is composed of the partial
+ * and suffix schedules of that band.
+ */
+__isl_give isl_union_map *isl_band_list_get_suffix_schedule(
+       __isl_keep isl_band_list *list)
+{
+       isl_union_pw_multi_aff *suffix;
+
+       suffix = isl_band_list_get_suffix_schedule_union_pw_multi_aff(list);
+       return isl_union_map_from_union_pw_multi_aff(suffix);
 }
 
 /* Return the schedule for the forest underneath the given band.
  */
-__isl_give isl_union_map *isl_band_get_suffix_schedule(
-       __isl_keep isl_band *band)
+__isl_give isl_union_pw_multi_aff *
+isl_band_get_suffix_schedule_union_pw_multi_aff(__isl_keep isl_band *band)
 {
-       isl_union_map *suffix;
+       isl_union_pw_multi_aff *suffix;
 
        if (!band)
                return NULL;
 
        if (!isl_band_has_children(band)) {
-               suffix = isl_union_map_copy(band->map);
-               suffix = isl_union_map_from_domain(isl_union_map_domain(suffix));
+               isl_union_set *domain;
+
+               suffix = isl_union_pw_multi_aff_copy(band->pma);
+               domain = isl_union_pw_multi_aff_domain(suffix);
+               suffix = isl_union_pw_multi_aff_from_domain(domain);
        } else {
-               int i, n;
-               isl_band_list *children;
-
-               suffix = isl_union_map_empty(isl_union_map_get_space(band->map));
-               children = isl_band_get_children(band);
-               n = isl_band_list_n_band(children);
-               for (i = 0; i < n; ++i) {
-                       isl_band *child;
-                       isl_union_map *partial_i;
-                       isl_union_map *suffix_i;
-
-                       child = isl_band_list_get_band(children, i);
-                       partial_i = isl_band_get_partial_schedule(child);
-                       suffix_i = isl_band_get_suffix_schedule(child);
-                       suffix_i = isl_union_map_flat_range_product(partial_i,
-                                                                   suffix_i);
-                       suffix = isl_union_map_union(suffix, suffix_i);
-
-                       isl_band_free(child);
-               }
-               isl_band_list_free(children);
+               isl_band_list *list;
+
+               list = isl_band_get_children(band);
+               suffix =
+                   isl_band_list_get_suffix_schedule_union_pw_multi_aff(list);
+               isl_band_list_free(list);
        }
 
        return suffix;
 }
 
+/* Return the schedule for the forest underneath the given band.
+ */
+__isl_give isl_union_map *isl_band_get_suffix_schedule(
+       __isl_keep isl_band *band)
+{
+       isl_union_pw_multi_aff *suffix;
+
+       suffix = isl_band_get_suffix_schedule_union_pw_multi_aff(band);
+       return isl_union_map_from_union_pw_multi_aff(suffix);
+}
+
+/* Call "fn" on each band (recursively) in the list
+ * in depth-first post-order.
+ */
+int isl_band_list_foreach_band(__isl_keep isl_band_list *list,
+       int (*fn)(__isl_keep isl_band *band, void *user), void *user)
+{
+       int i, n;
+
+       if (!list)
+               return -1;
+
+       n = isl_band_list_n_band(list);
+       for (i = 0; i < n; ++i) {
+               isl_band *band;
+               int r = 0;
+
+               band = isl_band_list_get_band(list, i);
+               if (isl_band_has_children(band)) {
+                       isl_band_list *children;
+
+                       children = isl_band_get_children(band);
+                       r = isl_band_list_foreach_band(children, fn, user);
+                       isl_band_list_free(children);
+               }
+
+               if (!band)
+                       r = -1;
+               if (r == 0)
+                       r = fn(band, user);
+
+               isl_band_free(band);
+               if (r)
+                       return r;
+       }
+
+       return 0;
+}
+
+/* Internal data used during the construction of the schedule
+ * for the tile loops.
+ *
+ * sizes contains the tile sizes
+ * scale is set if the tile loops should be scaled
+ * tiled collects the result for a single statement
+ * res collects the result for all statements
+ */
+struct isl_band_tile_data {
+       isl_vec *sizes;
+       isl_union_pw_multi_aff *res;
+       isl_pw_multi_aff *tiled;
+       int scale;
+};
+
+/* Given part of the schedule of a band, construct the corresponding
+ * schedule for the tile loops based on the tile sizes in data->sizes
+ * and add the result to data->tiled.
+ *
+ * If data->scale is set, then dimension i of the schedule will be
+ * of the form
+ *
+ *     m_i * floor(s_i(x) / m_i)
+ *
+ * where s_i(x) refers to the original schedule and m_i is the tile size.
+ * If data->scale is not set, then dimension i of the schedule will be
+ * of the form
+ *
+ *     floor(s_i(x) / m_i)
+ *
+ */
+static int multi_aff_tile(__isl_take isl_set *set,
+       __isl_take isl_multi_aff *ma, void *user)
+{
+       struct isl_band_tile_data *data = user;
+       isl_pw_multi_aff *pma;
+       int i, n;
+       isl_int v;
+
+       n = isl_multi_aff_dim(ma, isl_dim_out);
+       if (isl_vec_size(data->sizes) < n)
+               n = isl_vec_size(data->sizes);
+
+       isl_int_init(v);
+       for (i = 0; i < n; ++i) {
+               isl_aff *aff;
+
+               aff = isl_multi_aff_get_aff(ma, i);
+               isl_vec_get_element(data->sizes, i, &v);
+
+               aff = isl_aff_scale_down(aff, v);
+               aff = isl_aff_floor(aff);
+               if (data->scale)
+                       aff = isl_aff_scale(aff, v);
+
+               ma = isl_multi_aff_set_aff(ma, i, aff);
+       }
+       isl_int_clear(v);
+
+       pma = isl_pw_multi_aff_alloc(set, ma);
+       data->tiled = isl_pw_multi_aff_union_add(data->tiled, pma);
+
+       return 0;
+}
+
+/* Given part of the schedule of a band, construct the corresponding
+ * schedule for the tile loops based on the tile sizes in data->sizes
+ * and add the result to data->res.
+ */
+static int pw_multi_aff_tile(__isl_take isl_pw_multi_aff *pma, void *user)
+{
+       struct isl_band_tile_data *data = user;
+
+       data->tiled = isl_pw_multi_aff_empty(isl_pw_multi_aff_get_space(pma));
+
+       if (isl_pw_multi_aff_foreach_piece(pma, &multi_aff_tile, data) < 0)
+               goto error;
+
+       isl_pw_multi_aff_free(pma);
+       data->res = isl_union_pw_multi_aff_add_pw_multi_aff(data->res,
+                                                               data->tiled);
+
+       return 0;
+error:
+       isl_pw_multi_aff_free(pma);
+       isl_pw_multi_aff_free(data->tiled);
+       return -1;
+}
+
+/* Given the schedule of a band, construct the corresponding
+ * schedule for the tile loops based on the given tile sizes
+ * and return the result.
+ */
+static isl_union_pw_multi_aff *isl_union_pw_multi_aff_tile(
+       __isl_take isl_union_pw_multi_aff *sched, __isl_keep isl_vec *sizes)
+{
+       isl_ctx *ctx;
+       isl_space *space;
+       struct isl_band_tile_data data = { sizes };
+
+       ctx = isl_vec_get_ctx(sizes);
+
+       space = isl_union_pw_multi_aff_get_space(sched);
+       data.res = isl_union_pw_multi_aff_empty(space);
+       data.scale = isl_options_get_tile_scale_tile_loops(ctx);
+
+       if (isl_union_pw_multi_aff_foreach_pw_multi_aff(sched,
+                                               &pw_multi_aff_tile, &data) < 0)
+               goto error;
+
+       isl_union_pw_multi_aff_free(sched);
+       return data.res;
+error:
+       isl_union_pw_multi_aff_free(sched);
+       isl_union_pw_multi_aff_free(data.res);
+       return NULL;
+}
+
+/* Tile the given band using the specified tile sizes.
+ * The given band is modified to refer to the tile loops and
+ * a child band is created to refer to the point loops.
+ * The children of this point loop band are the children
+ * of the original band.
+ *
+ * If the scale tile loops option is set, then the tile loops
+ * are scaled by the tile sizes.  If the shift point loops option is set,
+ * then the point loops are shifted to start at zero.
+ * In particular, these options affect the tile and point loop schedules
+ * as follows
+ *
+ *     scale   shift   original        tile            point
+ *
+ *     0       0       i               floor(i/s)      i
+ *     1       0       i               s * floor(i/s)  i
+ *     0       1       i               floor(i/s)      i - s * floor(i/s)
+ *     1       1       i               s * floor(i/s)  i - s * floor(i/s)
+ */
+int isl_band_tile(__isl_keep isl_band *band, __isl_take isl_vec *sizes)
+{
+       isl_ctx *ctx;
+       isl_band *child;
+       isl_band_list *list = NULL;
+       isl_union_pw_multi_aff *sched = NULL, *child_sched = NULL;
+
+       if (!band || !sizes)
+               goto error;
+
+       ctx = isl_vec_get_ctx(sizes);
+       child = isl_band_dup(band);
+       list = isl_band_list_alloc(ctx, 1);
+       list = isl_band_list_add(list, child);
+       if (!list)
+               goto error;
+
+       sched = isl_union_pw_multi_aff_copy(band->pma);
+       sched = isl_union_pw_multi_aff_tile(sched, sizes);
+
+       child_sched = isl_union_pw_multi_aff_copy(child->pma);
+       if (isl_options_get_tile_shift_point_loops(ctx)) {
+               isl_union_pw_multi_aff *scaled;
+               scaled = isl_union_pw_multi_aff_copy(sched);
+               if (!isl_options_get_tile_scale_tile_loops(ctx))
+                       scaled = isl_union_pw_multi_aff_scale_vec(scaled,
+                                                       isl_vec_copy(sizes));
+               child_sched = isl_union_pw_multi_aff_sub(child_sched, scaled);
+       }
+       if (!sched || !child_sched)
+               goto error;
+
+       child->children = band->children;
+       band->children = list;
+       child->parent = band;
+       isl_union_pw_multi_aff_free(band->pma);
+       band->pma = sched;
+       isl_union_pw_multi_aff_free(child->pma);
+       child->pma = child_sched;
+
+       isl_vec_free(sizes);
+       return 0;
+error:
+       isl_union_pw_multi_aff_free(sched);
+       isl_union_pw_multi_aff_free(child_sched);
+       isl_band_list_free(list);
+       isl_vec_free(sizes);
+       return -1;
+}
+
+/* Internal data structure used inside isl_union_pw_multi_aff_drop.
+ *
+ * "pos" is the position of the first dimension to drop.
+ * "n" is the number of dimensions to drop.
+ * "res" accumulates the result.
+ */
+struct isl_union_pw_multi_aff_drop_data {
+       int pos;
+       int n;
+       isl_union_pw_multi_aff *res;
+};
+
+/* Drop the data->n output dimensions starting at data->pos from "pma"
+ * and add the result to data->res.
+ */
+static int pw_multi_aff_drop(__isl_take isl_pw_multi_aff *pma, void *user)
+{
+       struct isl_union_pw_multi_aff_drop_data *data = user;
+
+       pma = isl_pw_multi_aff_drop_dims(pma, isl_dim_out, data->pos, data->n);
+
+       data->res = isl_union_pw_multi_aff_add_pw_multi_aff(data->res, pma);
+       if (!data->res)
+               return -1;
+
+       return 0;
+}
+
+/* Drop the "n" output dimensions starting at "pos" from "sched".
+ */
+static isl_union_pw_multi_aff *isl_union_pw_multi_aff_drop(
+       __isl_take isl_union_pw_multi_aff *sched, int pos, int n)
+{
+       isl_space *space;
+       struct isl_union_pw_multi_aff_drop_data data = { pos, n };
+
+       space = isl_union_pw_multi_aff_get_space(sched);
+       data.res = isl_union_pw_multi_aff_empty(space);
+
+       if (isl_union_pw_multi_aff_foreach_pw_multi_aff(sched,
+                                               &pw_multi_aff_drop, &data) < 0)
+               data.res = isl_union_pw_multi_aff_free(data.res);
+
+       isl_union_pw_multi_aff_free(sched);
+       return data.res;
+}
+
+/* Drop the "n" dimensions starting at "pos" from "band".
+ */
+static int isl_band_drop(__isl_keep isl_band *band, int pos, int n)
+{
+       int i;
+       isl_union_pw_multi_aff *sched;
+
+       if (!band)
+               return -1;
+       if (n == 0)
+               return 0;
+
+       sched = isl_union_pw_multi_aff_copy(band->pma);
+       sched = isl_union_pw_multi_aff_drop(sched, pos, n);
+       if (!sched)
+               return -1;
+
+       isl_union_pw_multi_aff_free(band->pma);
+       band->pma = sched;
+
+       for (i = pos + n; i < band->n; ++i)
+               band->zero[i - n] = band->zero[i];
+
+       band->n -= n;
+
+       return 0;
+}
+
+/* Split the given band into two nested bands, one with the first "pos"
+ * dimensions of "band" and one with the remaining band->n - pos dimensions.
+ */
+int isl_band_split(__isl_keep isl_band *band, int pos)
+{
+       isl_ctx *ctx;
+       isl_band *child;
+       isl_band_list *list;
+
+       if (!band)
+               return -1;
+
+       ctx = isl_band_get_ctx(band);
+
+       if (pos < 0 || pos > band->n)
+               isl_die(ctx, isl_error_invalid, "position out of bounds",
+                       return -1);
+
+       child = isl_band_dup(band);
+       if (isl_band_drop(child, 0, pos) < 0)
+               child = isl_band_free(child);
+       list = isl_band_list_alloc(ctx, 1);
+       list = isl_band_list_add(list, child);
+       if (!list)
+               return -1;
+
+       if (isl_band_drop(band, pos, band->n - pos) < 0) {
+               isl_band_list_free(list);
+               return -1;
+       }
+
+       child->children = band->children;
+       band->children = list;
+       child->parent = band;
+
+       return 0;
+}
+
 __isl_give isl_printer *isl_printer_print_band(__isl_take isl_printer *p,
        __isl_keep isl_band *band)
 {