isl_schedule.c: fix typo in comment
[platform/upstream/isl.git] / isl_band.c
1 /*
2  * Copyright 2011      INRIA Saclay
3  *
4  * Use of this software is governed by the GNU LGPLv2.1 license
5  *
6  * Written by Sven Verdoolaege, INRIA Saclay - Ile-de-France,
7  * Parc Club Orsay Universite, ZAC des vignes, 4 rue Jacques Monod,
8  * 91893 Orsay, France
9  */
10
11 #include <isl_band_private.h>
12 #include <isl_schedule_private.h>
13 #include <isl_list_private.h>
14
15 isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band)
16 {
17         return band ? isl_union_map_get_ctx(band->map) : NULL;
18 }
19
20 /* We not only increment the reference count of the band,
21  * but also that of the schedule that contains this band.
22  * This ensures that the schedule won't disappear while there
23  * is still a reference to the band outside of the schedule.
24  * There is no need to increment the reference count of the parent
25  * band as the parent band is part of the same schedule.
26  */
27 __isl_give isl_band *isl_band_copy(__isl_keep isl_band *band)
28 {
29         if (!band)
30                 return NULL;
31
32         band->ref++;
33         band->schedule->ref++;
34         return band;
35 }
36
37 /* If this is not the last reference to the band (the one from within the
38  * schedule), then we also need to decrement the reference count of the
39  * containing schedule as it was incremented in isl_band_copy.
40  */
41 void *isl_band_free(__isl_take isl_band *band)
42 {
43         if (!band)
44                 return NULL;
45
46         if (--band->ref > 0)
47                 return isl_schedule_free(band->schedule);
48
49         isl_union_map_free(band->map);
50         isl_band_list_free(band->children);
51         free(band->zero);
52         free(band);
53
54         return NULL;
55 }
56
57 int isl_band_has_children(__isl_keep isl_band *band)
58 {
59         if (!band)
60                 return -1;
61
62         return band->children != NULL;
63 }
64
65 __isl_give isl_band_list *isl_band_get_children(
66         __isl_keep isl_band *band)
67 {
68         if (!band)
69                 return NULL;
70         if (!band->children)
71                 isl_die(isl_band_get_ctx(band), isl_error_invalid,
72                         "band has no children", return NULL);
73         return isl_band_list_dup(band->children);
74 }
75
76 int isl_band_n_member(__isl_keep isl_band *band)
77 {
78         return band ? band->n : 0;
79 }
80
81 /* Is the given scheduling dimension zero distance within the band and
82  * with respect to the proximity dependences.
83  */
84 int isl_band_member_is_zero_distance(__isl_keep isl_band *band, int pos)
85 {
86         if (!band)
87                 return -1;
88
89         if (pos < 0 || pos >= band->n)
90                 isl_die(isl_band_get_ctx(band), isl_error_invalid,
91                         "invalid member position", return -1);
92
93         return band->zero[pos];
94 }
95
96 /* Return the schedule that leads up to this band.
97  */
98 __isl_give isl_union_map *isl_band_get_prefix_schedule(
99         __isl_keep isl_band *band)
100 {
101         isl_union_map *prefix;
102         isl_band *a;
103
104         if (!band)
105                 return NULL;
106
107         prefix = isl_union_map_copy(band->map);
108         prefix = isl_union_map_from_domain(isl_union_map_domain(prefix));
109
110         for (a = band->parent; a; a = a->parent) {
111                 isl_union_map *partial = isl_union_map_copy(a->map);
112                 prefix = isl_union_map_flat_range_product(partial, prefix);
113         }
114
115         return prefix;
116 }
117
118 /* Return the schedule of the band in isolation.
119  */
120 __isl_give isl_union_map *isl_band_get_partial_schedule(
121         __isl_keep isl_band *band)
122 {
123         return band ? isl_union_map_copy(band->map) : NULL;
124 }
125
126 /* Return the schedule for the forest underneath the given band.
127  */
128 __isl_give isl_union_map *isl_band_get_suffix_schedule(
129         __isl_keep isl_band *band)
130 {
131         isl_union_map *suffix;
132
133         if (!band)
134                 return NULL;
135
136         if (!isl_band_has_children(band)) {
137                 suffix = isl_union_map_copy(band->map);
138                 suffix = isl_union_map_from_domain(isl_union_map_domain(suffix));
139         } else {
140                 int i, n;
141                 isl_band_list *children;
142
143                 suffix = isl_union_map_empty(isl_union_map_get_space(band->map));
144                 children = isl_band_get_children(band);
145                 n = isl_band_list_n_band(children);
146                 for (i = 0; i < n; ++i) {
147                         isl_band *child;
148                         isl_union_map *partial_i;
149                         isl_union_map *suffix_i;
150
151                         child = isl_band_list_get_band(children, i);
152                         partial_i = isl_band_get_partial_schedule(child);
153                         suffix_i = isl_band_get_suffix_schedule(child);
154                         suffix_i = isl_union_map_flat_range_product(partial_i,
155                                                                     suffix_i);
156                         suffix = isl_union_map_union(suffix, suffix_i);
157
158                         isl_band_free(child);
159                 }
160                 isl_band_list_free(children);
161         }
162
163         return suffix;
164 }
165
166 __isl_give isl_printer *isl_printer_print_band(__isl_take isl_printer *p,
167         __isl_keep isl_band *band)
168 {
169         isl_union_map *prefix, *partial, *suffix;
170
171         prefix = isl_band_get_prefix_schedule(band);
172         partial = isl_band_get_partial_schedule(band);
173         suffix = isl_band_get_suffix_schedule(band);
174
175         p = isl_printer_print_str(p, "(");
176         p = isl_printer_print_union_map(p, prefix);
177         p = isl_printer_print_str(p, ",");
178         p = isl_printer_print_union_map(p, partial);
179         p = isl_printer_print_str(p, ",");
180         p = isl_printer_print_union_map(p, suffix);
181         p = isl_printer_print_str(p, ")");
182
183         isl_union_map_free(prefix);
184         isl_union_map_free(partial);
185         isl_union_map_free(suffix);
186
187         return p;
188 }