isl_ast_graft.c: store_guard: coalesce guard after taking gist
[platform/upstream/isl.git] / isl_ast_build.c
1 /*
2  * Copyright 2012      Ecole Normale Superieure
3  *
4  * Use of this software is governed by the MIT license
5  *
6  * Written by Sven Verdoolaege,
7  * Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
8  */
9
10 #include <isl/map.h>
11 #include <isl/aff.h>
12 #include <isl/map.h>
13 #include <isl_ast_build_private.h>
14 #include <isl_ast_private.h>
15
16 /* Construct a map that isolates the current dimension.
17  *
18  * Essentially, the current dimension of "set" is moved to the single output
19  * dimension in the result, with the current dimension in the domain replaced
20  * by an unconstrained variable.
21  */
22 __isl_give isl_map *isl_ast_build_map_to_iterator(
23         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
24 {
25         isl_map *map;
26
27         map = isl_map_from_domain(set);
28         map = isl_map_add_dims(map, isl_dim_out, 1);
29
30         if (!build)
31                 return isl_map_free(map);
32
33         map = isl_map_equate(map, isl_dim_in, build->depth, isl_dim_out, 0);
34         map = isl_map_eliminate(map, isl_dim_in, build->depth, 1);
35
36         return map;
37 }
38
39 /* Initialize the information derived during the AST generation to default
40  * values for a schedule domain in "space".
41  *
42  * We also check that the remaining fields are not NULL so that
43  * the calling functions don't have to perform this test.
44  */
45 static __isl_give isl_ast_build *isl_ast_build_init_derived(
46         __isl_take isl_ast_build *build, __isl_take isl_space *space)
47 {
48         isl_ctx *ctx;
49         isl_vec *strides;
50
51         build = isl_ast_build_cow(build);
52         if (!build || !build->domain)
53                 goto error;
54
55         ctx = isl_ast_build_get_ctx(build);
56         strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
57         strides = isl_vec_set_si(strides, 1);
58
59         isl_vec_free(build->strides);
60         build->strides = strides;
61
62         space = isl_space_map_from_set(space);
63         isl_multi_aff_free(build->offsets);
64         build->offsets = isl_multi_aff_zero(isl_space_copy(space));
65         isl_multi_aff_free(build->values);
66         build->values = isl_multi_aff_identity(space);
67
68         if (!build->iterators || !build->domain || !build->generated ||
69             !build->pending || !build->values ||
70             !build->strides || !build->offsets || !build->options)
71                 return isl_ast_build_free(build);
72
73         return build;
74 error:
75         isl_space_free(space);
76         return isl_ast_build_free(build);
77 }
78
79 /* Return an isl_id called "c%d", with "%d" set to "i".
80  * If an isl_id with such a name already appears among the parameters
81  * in build->domain, then adjust the name to "c%d_%d".
82  */
83 static __isl_give isl_id *generate_name(isl_ctx *ctx, int i,
84         __isl_keep isl_ast_build *build)
85 {
86         int j;
87         char name[16];
88         isl_set *dom = build->domain;
89
90         snprintf(name, sizeof(name), "c%d", i);
91         j = 0;
92         while (isl_set_find_dim_by_name(dom, isl_dim_param, name) >= 0)
93                 snprintf(name, sizeof(name), "c%d_%d", i, j++);
94         return isl_id_alloc(ctx, name, NULL);
95 }
96
97 /* Create an isl_ast_build with "set" as domain.
98  *
99  * The input set is usually a parameter domain, but we currently allow it to
100  * be any kind of set.  We set the domain of the returned isl_ast_build
101  * to "set" and initialize all the other field to default values.
102  */
103 __isl_give isl_ast_build *isl_ast_build_from_context(__isl_take isl_set *set)
104 {
105         int i, n;
106         isl_ctx *ctx;
107         isl_space *space;
108         isl_ast_build *build;
109
110         set = isl_set_compute_divs(set);
111         if (!set)
112                 return NULL;
113
114         ctx = isl_set_get_ctx(set);
115
116         build = isl_calloc_type(ctx, isl_ast_build);
117         if (!build)
118                 goto error;
119
120         build->ref = 1;
121         build->domain = set;
122         build->generated = isl_set_copy(build->domain);
123         build->pending = isl_set_universe(isl_set_get_space(build->domain));
124         build->options = isl_union_map_empty(isl_space_params_alloc(ctx, 0));
125         n = isl_set_dim(set, isl_dim_set);
126         build->depth = n;
127         build->iterators = isl_id_list_alloc(ctx, n);
128         for (i = 0; i < n; ++i) {
129                 isl_id *id;
130                 if (isl_set_has_dim_id(set, isl_dim_set, i))
131                         id = isl_set_get_dim_id(set, isl_dim_set, i);
132                 else
133                         id = generate_name(ctx, i, build);
134                 build->iterators = isl_id_list_add(build->iterators, id);
135         }
136         space = isl_set_get_space(set);
137         if (isl_space_is_params(space))
138                 space = isl_space_set_from_params(space);
139
140         return isl_ast_build_init_derived(build, space);
141 error:
142         isl_set_free(set);
143         return NULL;
144 }
145
146 __isl_give isl_ast_build *isl_ast_build_copy(__isl_keep isl_ast_build *build)
147 {
148         if (!build)
149                 return NULL;
150
151         build->ref++;
152         return build;
153 }
154
155 __isl_give isl_ast_build *isl_ast_build_dup(__isl_keep isl_ast_build *build)
156 {
157         isl_ctx *ctx;
158         isl_ast_build *dup;
159
160         if (!build)
161                 return NULL;
162
163         ctx = isl_ast_build_get_ctx(build);
164         dup = isl_calloc_type(ctx, isl_ast_build);
165         if (!dup)
166                 return NULL;
167
168         dup->ref = 1;
169         dup->outer_pos = build->outer_pos;
170         dup->depth = build->depth;
171         dup->iterators = isl_id_list_copy(build->iterators);
172         dup->domain = isl_set_copy(build->domain);
173         dup->generated = isl_set_copy(build->generated);
174         dup->pending = isl_set_copy(build->pending);
175         dup->values = isl_multi_aff_copy(build->values);
176         dup->value = isl_pw_aff_copy(build->value);
177         dup->strides = isl_vec_copy(build->strides);
178         dup->offsets = isl_multi_aff_copy(build->offsets);
179         dup->executed = isl_union_map_copy(build->executed);
180         dup->single_valued = build->single_valued;
181         dup->options = isl_union_map_copy(build->options);
182         dup->at_each_domain = build->at_each_domain;
183         dup->at_each_domain_user = build->at_each_domain_user;
184         dup->before_each_for = build->before_each_for;
185         dup->before_each_for_user = build->before_each_for_user;
186         dup->after_each_for = build->after_each_for;
187         dup->after_each_for_user = build->after_each_for_user;
188         dup->create_leaf = build->create_leaf;
189         dup->create_leaf_user = build->create_leaf_user;
190
191         if (!dup->iterators || !dup->domain || !dup->generated ||
192             !dup->pending || !dup->values ||
193             !dup->strides || !dup->offsets || !dup->options ||
194             (build->executed && !dup->executed) ||
195             (build->value && !dup->value))
196                 return isl_ast_build_free(dup);
197
198         return dup;
199 }
200
201 /* Align the parameters of "build" to those of "model", introducing
202  * additional parameters if needed.
203  */
204 __isl_give isl_ast_build *isl_ast_build_align_params(
205         __isl_take isl_ast_build *build, __isl_take isl_space *model)
206 {
207         build = isl_ast_build_cow(build);
208         if (!build)
209                 goto error;
210
211         build->domain = isl_set_align_params(build->domain,
212                                                 isl_space_copy(model));
213         build->generated = isl_set_align_params(build->generated,
214                                                 isl_space_copy(model));
215         build->pending = isl_set_align_params(build->pending,
216                                                 isl_space_copy(model));
217         build->values = isl_multi_aff_align_params(build->values,
218                                                 isl_space_copy(model));
219         build->offsets = isl_multi_aff_align_params(build->offsets,
220                                                 isl_space_copy(model));
221         build->options = isl_union_map_align_params(build->options,
222                                                 isl_space_copy(model));
223         isl_space_free(model);
224
225         if (!build->domain || !build->values || !build->offsets ||
226             !build->options)
227                 return isl_ast_build_free(build);
228
229         return build;
230 error:
231         isl_space_free(model);
232         return NULL;
233 }
234
235 __isl_give isl_ast_build *isl_ast_build_cow(__isl_take isl_ast_build *build)
236 {
237         if (!build)
238                 return NULL;
239
240         if (build->ref == 1)
241                 return build;
242         build->ref--;
243         return isl_ast_build_dup(build);
244 }
245
246 void *isl_ast_build_free(__isl_take isl_ast_build *build)
247 {
248         if (!build)
249                 return NULL;
250
251         if (--build->ref > 0)
252                 return NULL;
253
254         isl_id_list_free(build->iterators);
255         isl_set_free(build->domain);
256         isl_set_free(build->generated);
257         isl_set_free(build->pending);
258         isl_multi_aff_free(build->values);
259         isl_pw_aff_free(build->value);
260         isl_vec_free(build->strides);
261         isl_multi_aff_free(build->offsets);
262         isl_multi_aff_free(build->schedule_map);
263         isl_union_map_free(build->executed);
264         isl_union_map_free(build->options);
265
266         free(build);
267
268         return NULL;
269 }
270
271 isl_ctx *isl_ast_build_get_ctx(__isl_keep isl_ast_build *build)
272 {
273         return build ? isl_set_get_ctx(build->domain) : NULL;
274 }
275
276 /* Replace build->options by "options".
277  */
278 __isl_give isl_ast_build *isl_ast_build_set_options(
279         __isl_take isl_ast_build *build, __isl_take isl_union_map *options)
280 {
281         build = isl_ast_build_cow(build);
282
283         if (!build || !options)
284                 goto error;
285
286         isl_union_map_free(build->options);
287         build->options = options;
288
289         return build;
290 error:
291         isl_union_map_free(options);
292         return isl_ast_build_free(build);
293 }
294
295 /* Set the iterators for the next code generation.
296  *
297  * If we still have some iterators left from the previous code generation
298  * (if any) or if iterators have already been set by a previous
299  * call to this function, then we remove them first.
300  */
301 __isl_give isl_ast_build *isl_ast_build_set_iterators(
302         __isl_take isl_ast_build *build, __isl_take isl_id_list *iterators)
303 {
304         int dim, n_it;
305
306         build = isl_ast_build_cow(build);
307         if (!build)
308                 goto error;
309
310         dim = isl_set_dim(build->domain, isl_dim_set);
311         n_it = isl_id_list_n_id(build->iterators);
312         if (n_it < dim)
313                 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
314                         "isl_ast_build in inconsistent state", goto error);
315         if (n_it > dim)
316                 build->iterators = isl_id_list_drop(build->iterators,
317                                                         dim, n_it - dim);
318         build->iterators = isl_id_list_concat(build->iterators, iterators);
319         if (!build->iterators)
320                 return isl_ast_build_free(build);
321
322         return build;
323 error:
324         isl_id_list_free(iterators);
325         return isl_ast_build_free(build);
326 }
327
328 /* Set the "at_each_domain" callback of "build" to "fn".
329  */
330 __isl_give isl_ast_build *isl_ast_build_set_at_each_domain(
331         __isl_take isl_ast_build *build,
332         __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
333                 __isl_keep isl_ast_build *build, void *user), void *user)
334 {
335         build = isl_ast_build_cow(build);
336
337         if (!build)
338                 return NULL;
339
340         build->at_each_domain = fn;
341         build->at_each_domain_user = user;
342
343         return build;
344 }
345
346 /* Set the "before_each_for" callback of "build" to "fn".
347  */
348 __isl_give isl_ast_build *isl_ast_build_set_before_each_for(
349         __isl_take isl_ast_build *build,
350         __isl_give isl_id *(*fn)(__isl_keep isl_ast_build *build,
351                 void *user), void *user)
352 {
353         build = isl_ast_build_cow(build);
354
355         if (!build)
356                 return NULL;
357
358         build->before_each_for = fn;
359         build->before_each_for_user = user;
360
361         return build;
362 }
363
364 /* Set the "after_each_for" callback of "build" to "fn".
365  */
366 __isl_give isl_ast_build *isl_ast_build_set_after_each_for(
367         __isl_take isl_ast_build *build,
368         __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
369                 __isl_keep isl_ast_build *build, void *user), void *user)
370 {
371         build = isl_ast_build_cow(build);
372
373         if (!build)
374                 return NULL;
375
376         build->after_each_for = fn;
377         build->after_each_for_user = user;
378
379         return build;
380 }
381
382 /* Set the "create_leaf" callback of "build" to "fn".
383  */
384 __isl_give isl_ast_build *isl_ast_build_set_create_leaf(
385         __isl_take isl_ast_build *build,
386         __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_build *build,
387                 void *user), void *user)
388 {
389         build = isl_ast_build_cow(build);
390
391         if (!build)
392                 return NULL;
393
394         build->create_leaf = fn;
395         build->create_leaf_user = user;
396
397         return build;
398 }
399
400 /* Clear all information that is specific to this code generation
401  * and that is (probably) not meaningful to any nested code generation.
402  */
403 __isl_give isl_ast_build *isl_ast_build_clear_local_info(
404         __isl_take isl_ast_build *build)
405 {
406         isl_space *space;
407
408         build = isl_ast_build_cow(build);
409         if (!build)
410                 return NULL;
411
412         space = isl_union_map_get_space(build->options);
413         isl_union_map_free(build->options);
414         build->options = isl_union_map_empty(space);
415
416         build->at_each_domain = NULL;
417         build->at_each_domain_user = NULL;
418         build->before_each_for = NULL;
419         build->before_each_for_user = NULL;
420         build->after_each_for = NULL;
421         build->after_each_for_user = NULL;
422         build->create_leaf = NULL;
423         build->create_leaf_user = NULL;
424
425         if (!build->options)
426                 return isl_ast_build_free(build);
427
428         return build;
429 }
430
431 /* Have any loops been eliminated?
432  * That is, do any of the original schedule dimensions have a fixed
433  * value that has been substituted?
434  */
435 static int any_eliminated(isl_ast_build *build)
436 {
437         int i;
438
439         for (i = 0; i < build->depth; ++i)
440                 if (isl_ast_build_has_affine_value(build, i))
441                         return 1;
442
443         return 0;
444 }
445
446 /* Clear build->schedule_map.
447  * This function should be called whenever anything that might affect
448  * the result of isl_ast_build_get_schedule_map_multi_aff changes.
449  * In particular, it should be called when the depth is changed or
450  * when an iterator is determined to have a fixed value.
451  */
452 static void isl_ast_build_reset_schedule_map(__isl_keep isl_ast_build *build)
453 {
454         if (!build)
455                 return;
456         isl_multi_aff_free(build->schedule_map);
457         build->schedule_map = NULL;
458 }
459
460 /* Do we need a (non-trivial) schedule map?
461  * That is, is the internal schedule space different from
462  * the external schedule space?
463  *
464  * The internal and external schedule spaces are only the same
465  * if code has been generated for the entire schedule and if none
466  * of the loops have been eliminated.
467  */
468 __isl_give int isl_ast_build_need_schedule_map(__isl_keep isl_ast_build *build)
469 {
470         int dim;
471
472         if (!build)
473                 return -1;
474
475         dim = isl_set_dim(build->domain, isl_dim_set);
476         return build->depth != dim || any_eliminated(build);
477 }
478
479 /* Return a mapping from the internal schedule space to the external
480  * schedule space in the form of an isl_multi_aff.
481  * The internal schedule space originally corresponds to that of the
482  * input schedule.  This may change during the code generation if
483  * if isl_ast_build_insert_dim is ever called.
484  * The external schedule space corresponds to the
485  * loops that have been generated.
486  *
487  * Currently, the only difference between the internal schedule domain
488  * and the external schedule domain is that some dimensions are projected
489  * out in the external schedule domain.  In particular, the dimensions
490  * for which no code has been generated yet and the dimensions that correspond
491  * to eliminated loops.
492  *
493  * We cache a copy of the schedule_map in build->schedule_map.
494  * The cache is cleared through isl_ast_build_reset_schedule_map
495  * whenever anything changes that might affect the result of this function.
496  */
497 __isl_give isl_multi_aff *isl_ast_build_get_schedule_map_multi_aff(
498         __isl_keep isl_ast_build *build)
499 {
500         isl_space *space;
501         isl_multi_aff *ma;
502
503         if (!build)
504                 return NULL;
505         if (build->schedule_map)
506                 return isl_multi_aff_copy(build->schedule_map);
507
508         space = isl_ast_build_get_space(build, 1);
509         space = isl_space_map_from_set(space);
510         ma = isl_multi_aff_identity(space);
511         if (isl_ast_build_need_schedule_map(build)) {
512                 int i;
513                 int dim = isl_set_dim(build->domain, isl_dim_set);
514                 ma = isl_multi_aff_drop_dims(ma, isl_dim_out,
515                                         build->depth, dim - build->depth);
516                 for (i = build->depth - 1; i >= 0; --i)
517                         if (isl_ast_build_has_affine_value(build, i))
518                                 ma = isl_multi_aff_drop_dims(ma,
519                                                         isl_dim_out, i, 1);
520         }
521
522         build->schedule_map = ma;
523         return isl_multi_aff_copy(build->schedule_map);
524 }
525
526 /* Return a mapping from the internal schedule space to the external
527  * schedule space in the form of an isl_map.
528  */
529 __isl_give isl_map *isl_ast_build_get_schedule_map(
530         __isl_keep isl_ast_build *build)
531 {
532         isl_multi_aff *ma;
533
534         ma = isl_ast_build_get_schedule_map_multi_aff(build);
535         return isl_map_from_multi_aff(ma);
536 }
537
538 /* Return the position of the dimension in build->domain for which
539  * an AST node is currently being generated.
540  */
541 int isl_ast_build_get_depth(__isl_keep isl_ast_build *build)
542 {
543         return build ? build->depth : -1;
544 }
545
546 /* Prepare for generating code for the next level.
547  * In particular, increase the depth and reset any information
548  * that is local to the current depth.
549  */
550 __isl_give isl_ast_build *isl_ast_build_increase_depth(
551         __isl_take isl_ast_build *build)
552 {
553         build = isl_ast_build_cow(build);
554         if (!build)
555                 return NULL;
556         build->depth++;
557         isl_ast_build_reset_schedule_map(build);
558         build->value = isl_pw_aff_free(build->value);
559         return build;
560 }
561
562 void isl_ast_build_dump(__isl_keep isl_ast_build *build)
563 {
564         if (!build)
565                 return;
566
567         fprintf(stderr, "domain: ");
568         isl_set_dump(build->domain);
569         fprintf(stderr, "generated: ");
570         isl_set_dump(build->generated);
571         fprintf(stderr, "pending: ");
572         isl_set_dump(build->pending);
573         fprintf(stderr, "iterators: ");
574         isl_id_list_dump(build->iterators);
575         fprintf(stderr, "values: ");
576         isl_multi_aff_dump(build->values);
577         if (build->value) {
578                 fprintf(stderr, "value: ");
579                 isl_pw_aff_dump(build->value);
580         }
581         fprintf(stderr, "strides: ");
582         isl_vec_dump(build->strides);
583         fprintf(stderr, "offsets: ");
584         isl_multi_aff_dump(build->offsets);
585 }
586
587 /* Initialize "build" for AST construction in schedule space "space"
588  * in the case that build->domain is a parameter set.
589  *
590  * build->iterators is assumed to have been updated already.
591  */
592 static __isl_give isl_ast_build *isl_ast_build_init(
593         __isl_take isl_ast_build *build, __isl_take isl_space *space)
594 {
595         isl_set *set;
596
597         build = isl_ast_build_cow(build);
598         if (!build)
599                 goto error;
600
601         set = isl_set_universe(isl_space_copy(space));
602         build->domain = isl_set_intersect_params(isl_set_copy(set),
603                                                     build->domain);
604         build->pending = isl_set_intersect_params(isl_set_copy(set),
605                                                     build->pending);
606         build->generated = isl_set_intersect_params(set, build->generated);
607
608         return isl_ast_build_init_derived(build, space);
609 error:
610         isl_ast_build_free(build);
611         isl_space_free(space);
612         return NULL;
613 }
614
615 /* Assign "aff" to *user and return -1, effectively extracting
616  * the first (and presumably only) affine expression in the isl_pw_aff
617  * on which this function is used.
618  */
619 static int extract_single_piece(__isl_take isl_set *set,
620         __isl_take isl_aff *aff, void *user)
621 {
622         isl_aff **p = user;
623
624         *p = aff;
625         isl_set_free(set);
626
627         return -1;
628 }
629
630 /* Check if the given bounds on the current dimension imply that
631  * this current dimension attains only a single value (in terms of
632  * parameters and outer dimensions).
633  * If so, we record it in build->value.
634  * If, moreover, this value can be represented as a single affine expression,
635  * then we also update build->values, effectively marking the current
636  * dimension as "eliminated".
637  *
638  * When computing the gist of the fixed value that can be represented
639  * as a single affine expression, it is important to only take into
640  * account the domain constraints in the original AST build and
641  * not the domain of the affine expression itself.
642  * Otherwise, a [i/3] is changed into a i/3 because we know that i
643  * is a multiple of 3, but then we end up not expressing anywhere
644  * in the context that i is a multiple of 3.
645  */
646 static __isl_give isl_ast_build *update_values(
647         __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
648 {
649         int sv;
650         isl_pw_multi_aff *pma;
651         isl_aff *aff = NULL;
652         isl_map *it_map;
653         isl_set *set;
654
655         set = isl_set_from_basic_set(bounds);
656         set = isl_set_intersect(set, isl_set_copy(build->domain));
657         it_map = isl_ast_build_map_to_iterator(build, set);
658
659         sv = isl_map_is_single_valued(it_map);
660         if (sv < 0)
661                 build = isl_ast_build_free(build);
662         if (!build || !sv) {
663                 isl_map_free(it_map);
664                 return build;
665         }
666
667         pma = isl_pw_multi_aff_from_map(it_map);
668         build->value = isl_pw_multi_aff_get_pw_aff(pma, 0);
669         build->value = isl_ast_build_compute_gist_pw_aff(build, build->value);
670         build->value = isl_pw_aff_coalesce(build->value);
671         isl_pw_multi_aff_free(pma);
672
673         if (!build->value)
674                 return isl_ast_build_free(build);
675
676         if (isl_pw_aff_n_piece(build->value) != 1)
677                 return build;
678
679         isl_pw_aff_foreach_piece(build->value, &extract_single_piece, &aff);
680
681         build->values = isl_multi_aff_set_aff(build->values, build->depth, aff);
682         if (!build->values)
683                 return isl_ast_build_free(build);
684         isl_ast_build_reset_schedule_map(build);
685         return build;
686 }
687
688 /* Update the AST build based on the given loop bounds for
689  * the current dimension.
690  *
691  * We first make sure that the bounds do not refer to any iterators
692  * that have already been eliminated.
693  * Then, we check if the bounds imply that the current iterator
694  * has a fixed value.
695  * If they do and if this fixed value can be expressed as a single
696  * affine expression, we eliminate the iterators from the bounds.
697  * Note that we cannot simply plug in this single value using
698  * isl_basic_set_preimage_multi_aff as the single value may only
699  * be defined on a subset of the domain.  Plugging in the value
700  * would restrict the build domain to this subset, while this
701  * restriction may not be reflected in the generated code.
702  * build->domain may, however, already refer to the current dimension
703  * due an earlier call to isl_ast_build_include_stride.  If so, we need
704  * to eliminate the dimension so that we do not introduce it in any other sets.
705  * Finally, we intersect build->domain with the updated bounds.
706  *
707  * Note that the check for a fixed value in update_values requires
708  * us to intersect the bounds with the current build domain.
709  * When we intersect build->domain with the updated bounds in
710  * the final step, we make sure that these updated bounds have
711  * not been intersected with the old build->domain.
712  * Otherwise, we would indirectly intersect the build domain with itself,
713  * which can lead to inefficiencies, in particular if the build domain
714  * contains any unknown divs.
715  */
716 __isl_give isl_ast_build *isl_ast_build_set_loop_bounds(
717         __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
718 {
719         isl_set *set;
720
721         build = isl_ast_build_cow(build);
722         if (!build)
723                 goto error;
724
725         bounds = isl_basic_set_preimage_multi_aff(bounds,
726                                         isl_multi_aff_copy(build->values));
727         build = update_values(build, isl_basic_set_copy(bounds));
728         if (!build)
729                 goto error;
730         set = isl_set_from_basic_set(isl_basic_set_copy(bounds));
731         if (isl_ast_build_has_affine_value(build, build->depth)) {
732                 set = isl_set_eliminate(set, isl_dim_set, build->depth, 1);
733                 set = isl_set_compute_divs(set);
734                 build->pending = isl_set_intersect(build->pending,
735                                                         isl_set_copy(set));
736                 if (isl_ast_build_has_stride(build, build->depth))
737                         build->domain = isl_set_eliminate(build->domain,
738                                                 isl_dim_set, build->depth, 1);
739         } else {
740                 isl_basic_set *generated, *pending;
741
742                 pending = isl_basic_set_copy(bounds);
743                 pending = isl_basic_set_drop_constraints_involving_dims(pending,
744                                         isl_dim_set, build->depth, 1);
745                 build->pending = isl_set_intersect(build->pending,
746                                         isl_set_from_basic_set(pending));
747                 generated = isl_basic_set_copy(bounds);
748                 generated = isl_basic_set_drop_constraints_not_involving_dims(
749                                     generated, isl_dim_set, build->depth, 1);
750                 build->generated = isl_set_intersect(build->generated,
751                                         isl_set_from_basic_set(generated));
752         }
753         isl_basic_set_free(bounds);
754
755         build->domain = isl_set_intersect(build->domain, set);
756         if (!build->domain || !build->pending || !build->generated)
757                 return isl_ast_build_free(build);
758
759         return build;
760 error:
761         isl_ast_build_free(build);
762         isl_basic_set_free(bounds);
763         return NULL;
764 }
765
766 /* Update build->domain based on the constraints enforced by inner loops.
767  *
768  * The constraints in build->pending may end up not getting generated
769  * if they are implied by "enforced".  We therefore reconstruct
770  * build->domain from build->generated and build->pending, dropping
771  * those constraint in build->pending that may not get generated.
772  */
773 __isl_give isl_ast_build *isl_ast_build_set_enforced(
774         __isl_take isl_ast_build *build, __isl_take isl_basic_set *enforced)
775 {
776         isl_set *set;
777
778         build = isl_ast_build_cow(build);
779         if (!build)
780                 goto error;
781
782         set = isl_set_from_basic_set(enforced);
783         set = isl_set_gist(isl_set_copy(build->pending), set);
784         set = isl_set_intersect(isl_set_copy(build->generated), set);
785
786         isl_set_free(build->domain);
787         build->domain = set;
788
789         if (!build->domain)
790                 return isl_ast_build_free(build);
791
792         return build;
793 error:
794         isl_basic_set_free(enforced);
795         return isl_ast_build_free(build);
796 }
797
798 /* Intersect build->domain with "set", where "set" is specified
799  * in terms of the internal schedule domain.
800  */
801 static __isl_give isl_ast_build *isl_ast_build_restrict_internal(
802         __isl_take isl_ast_build *build, __isl_take isl_set *set)
803 {
804         build = isl_ast_build_cow(build);
805         if (!build)
806                 goto error;
807
808         set = isl_set_compute_divs(set);
809         build->domain = isl_set_intersect(build->domain, set);
810         build->domain = isl_set_coalesce(build->domain);
811
812         if (!build->domain)
813                 return isl_ast_build_free(build);
814
815         return build;
816 error:
817         isl_ast_build_free(build);
818         isl_set_free(set);
819         return NULL;
820 }
821
822 /* Intersect build->generated and build->domain with "set",
823  * where "set" is specified in terms of the internal schedule domain.
824  */
825 __isl_give isl_ast_build *isl_ast_build_restrict_generated(
826         __isl_take isl_ast_build *build, __isl_take isl_set *set)
827 {
828         set = isl_set_compute_divs(set);
829         build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
830         build = isl_ast_build_cow(build);
831         if (!build)
832                 goto error;
833
834         build->generated = isl_set_intersect(build->generated, set);
835         build->generated = isl_set_coalesce(build->generated);
836
837         if (!build->generated)
838                 return isl_ast_build_free(build);
839
840         return build;
841 error:
842         isl_ast_build_free(build);
843         isl_set_free(set);
844         return NULL;
845 }
846
847 /* Intersect build->pending and build->domain with "set",
848  * where "set" is specified in terms of the internal schedule domain.
849  */
850 __isl_give isl_ast_build *isl_ast_build_restrict_pending(
851         __isl_take isl_ast_build *build, __isl_take isl_set *set)
852 {
853         set = isl_set_compute_divs(set);
854         build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
855         build = isl_ast_build_cow(build);
856         if (!build)
857                 goto error;
858
859         build->pending = isl_set_intersect(build->pending, set);
860         build->pending = isl_set_coalesce(build->pending);
861
862         if (!build->pending)
863                 return isl_ast_build_free(build);
864
865         return build;
866 error:
867         isl_ast_build_free(build);
868         isl_set_free(set);
869         return NULL;
870 }
871
872 /* Intersect build->domain with "set", where "set" is specified
873  * in terms of the external schedule domain.
874  */
875 __isl_give isl_ast_build *isl_ast_build_restrict(
876         __isl_take isl_ast_build *build, __isl_take isl_set *set)
877 {
878         if (isl_set_is_params(set))
879                 return isl_ast_build_restrict_generated(build, set);
880
881         if (isl_ast_build_need_schedule_map(build)) {
882                 isl_multi_aff *ma;
883                 ma = isl_ast_build_get_schedule_map_multi_aff(build);
884                 set = isl_set_preimage_multi_aff(set, ma);
885         }
886         return isl_ast_build_restrict_generated(build, set);
887 }
888
889 /* Replace build->executed by "executed".
890  */
891 __isl_give isl_ast_build *isl_ast_build_set_executed(
892         __isl_take isl_ast_build *build, __isl_take isl_union_map *executed)
893 {
894         build = isl_ast_build_cow(build);
895         if (!build)
896                 goto error;
897
898         isl_union_map_free(build->executed);
899         build->executed = executed;
900
901         return build;
902 error:
903         isl_ast_build_free(build);
904         isl_union_map_free(executed);
905         return NULL;
906 }
907
908 /* Return a copy of the current schedule domain.
909  */
910 __isl_give isl_set *isl_ast_build_get_domain(__isl_keep isl_ast_build *build)
911 {
912         return build ? isl_set_copy(build->domain) : NULL;
913 }
914
915 /* Return the (schedule) space of "build".
916  *
917  * If "internal" is set, then this space is the space of the internal
918  * representation of the entire schedule, including those parts for
919  * which no code has been generated yet.
920  *
921  * If "internal" is not set, then this space is the external representation
922  * of the loops generated so far.
923  */
924 __isl_give isl_space *isl_ast_build_get_space(__isl_keep isl_ast_build *build,
925         int internal)
926 {
927         int i;
928         int dim;
929         isl_space *space;
930
931         if (!build)
932                 return NULL;
933
934         space = isl_set_get_space(build->domain);
935         if (internal)
936                 return space;
937
938         if (!isl_ast_build_need_schedule_map(build))
939                 return space;
940
941         dim = isl_set_dim(build->domain, isl_dim_set);
942         space = isl_space_drop_dims(space, isl_dim_set,
943                                     build->depth, dim - build->depth);
944         for (i = build->depth - 1; i >= 0; --i)
945                 if (isl_ast_build_has_affine_value(build, i))
946                         space = isl_space_drop_dims(space, isl_dim_set, i, 1);
947
948         return space;
949 }
950
951 /* Return the external representation of the schedule space of "build",
952  * i.e., a space with a dimension for each loop generated so far,
953  * with the names of the dimensions set to the loop iterators.
954  */
955 __isl_give isl_space *isl_ast_build_get_schedule_space(
956         __isl_keep isl_ast_build *build)
957 {
958         isl_space *space;
959         int i, skip;
960
961         if (!build)
962                 return NULL;
963
964         space = isl_ast_build_get_space(build, 0);
965
966         skip = 0;
967         for (i = 0; i < build->depth; ++i) {
968                 isl_id *id;
969
970                 if (isl_ast_build_has_affine_value(build, i)) {
971                         skip++;
972                         continue;
973                 }
974
975                 id = isl_ast_build_get_iterator_id(build, i);
976                 space = isl_space_set_dim_id(space, isl_dim_set, i - skip, id);
977         }
978
979         return space;
980 }
981
982 /* Return the current schedule, as stored in build->executed, in terms
983  * of the external schedule domain.
984  */
985 __isl_give isl_union_map *isl_ast_build_get_schedule(
986         __isl_keep isl_ast_build *build)
987 {
988         isl_union_map *executed;
989         isl_union_map *schedule;
990
991         if (!build)
992                 return NULL;
993
994         executed = isl_union_map_copy(build->executed);
995         if (isl_ast_build_need_schedule_map(build)) {
996                 isl_map *proj = isl_ast_build_get_schedule_map(build);
997                 executed = isl_union_map_apply_domain(executed,
998                                         isl_union_map_from_map(proj));
999         }
1000         schedule = isl_union_map_reverse(executed);
1001
1002         return schedule;
1003 }
1004
1005 /* Return the iterator attached to the internal schedule dimension "pos".
1006  */
1007 __isl_give isl_id *isl_ast_build_get_iterator_id(
1008         __isl_keep isl_ast_build *build, int pos)
1009 {
1010         if (!build)
1011                 return NULL;
1012
1013         return isl_id_list_get_id(build->iterators, pos);
1014 }
1015
1016 /* Set the stride and offset of the current dimension to the given
1017  * value and expression.
1018  */
1019 static __isl_give isl_ast_build *set_stride(__isl_take isl_ast_build *build,
1020         isl_int stride, __isl_take isl_aff *offset)
1021 {
1022         int pos;
1023
1024         build = isl_ast_build_cow(build);
1025         if (!build || !offset)
1026                 goto error;
1027
1028         pos = build->depth;
1029         build->strides = isl_vec_set_element(build->strides, pos, stride);
1030         build->offsets = isl_multi_aff_set_aff(build->offsets, pos, offset);
1031         if (!build->strides || !build->offsets)
1032                 return isl_ast_build_free(build);
1033
1034         return build;
1035 error:
1036         isl_aff_free(offset);
1037         return isl_ast_build_free(build);
1038 }
1039
1040 /* Return a set expressing the stride constraint at the current depth.
1041  *
1042  * In particular, if the current iterator (i) is known to attain values
1043  *
1044  *      f + s a
1045  *
1046  * where f is the offset and s is the stride, then the returned set
1047  * expresses the constraint
1048  *
1049  *      (f - i) mod s = 0
1050  */
1051 __isl_give isl_set *isl_ast_build_get_stride_constraint(
1052         __isl_keep isl_ast_build *build)
1053 {
1054         isl_aff *aff;
1055         isl_set *set;
1056         isl_int stride;
1057         int pos;
1058
1059         if (!build)
1060                 return NULL;
1061
1062         pos = build->depth;
1063
1064         if (!isl_ast_build_has_stride(build, pos))
1065                 return isl_set_universe(isl_ast_build_get_space(build, 1));
1066
1067         isl_int_init(stride);
1068
1069         isl_ast_build_get_stride(build, pos, &stride);
1070         aff = isl_ast_build_get_offset(build, pos);
1071         aff = isl_aff_add_coefficient_si(aff, isl_dim_in, pos, -1);
1072         aff = isl_aff_mod(aff, stride);
1073         set = isl_set_from_basic_set(isl_aff_zero_basic_set(aff));
1074
1075         isl_int_clear(stride);
1076
1077         return set;
1078 }
1079
1080 /* Return the expansion implied by the stride and offset at the current
1081  * depth.
1082  *
1083  * That is, return the mapping
1084  *
1085  *      [i_0, ..., i_{d-1}, i_d, i_{d+1}, ...]
1086  *              -> [i_0, ..., i_{d-1}, s * i_d + offset(i),  i_{d+1}, ...]
1087  *
1088  * where s is the stride at the current depth d and offset(i) is
1089  * the corresponding offset.
1090  */
1091 __isl_give isl_multi_aff *isl_ast_build_get_stride_expansion(
1092         __isl_keep isl_ast_build *build)
1093 {
1094         isl_space *space;
1095         isl_multi_aff *ma;
1096         int pos;
1097         isl_aff *aff, *offset;
1098         isl_int stride;
1099
1100         if (!build)
1101                 return NULL;
1102
1103         pos = isl_ast_build_get_depth(build);
1104         space = isl_ast_build_get_space(build, 1);
1105         space = isl_space_map_from_set(space);
1106         ma = isl_multi_aff_identity(space);
1107
1108         if (!isl_ast_build_has_stride(build, pos))
1109                 return ma;
1110
1111         isl_int_init(stride);
1112         offset = isl_ast_build_get_offset(build, pos);
1113         isl_ast_build_get_stride(build, pos, &stride);
1114         aff = isl_multi_aff_get_aff(ma, pos);
1115         aff = isl_aff_scale(aff, stride);
1116         aff = isl_aff_add(aff, offset);
1117         ma = isl_multi_aff_set_aff(ma, pos, aff);
1118         isl_int_clear(stride);
1119
1120         return ma;
1121 }
1122
1123 /* Add constraints corresponding to any previously detected
1124  * stride on the current dimension to build->domain.
1125  */
1126 __isl_give isl_ast_build *isl_ast_build_include_stride(
1127         __isl_take isl_ast_build *build)
1128 {
1129         isl_set *set;
1130
1131         if (!build)
1132                 return NULL;
1133         if (!isl_ast_build_has_stride(build, build->depth))
1134                 return build;
1135         build = isl_ast_build_cow(build);
1136         if (!build)
1137                 return NULL;
1138
1139         set = isl_ast_build_get_stride_constraint(build);
1140
1141         build->domain = isl_set_intersect(build->domain, isl_set_copy(set));
1142         build->generated = isl_set_intersect(build->generated, set);
1143         if (!build->domain || !build->generated)
1144                 return isl_ast_build_free(build);
1145
1146         return build;
1147 }
1148
1149 /* Compute x, y and g such that g = gcd(a,b) and a*x+b*y = g */
1150 static void euclid(isl_int a, isl_int b, isl_int *x, isl_int *y, isl_int *g)
1151 {
1152         isl_int c, d, e, f, tmp;
1153
1154         isl_int_init(c);
1155         isl_int_init(d);
1156         isl_int_init(e);
1157         isl_int_init(f);
1158         isl_int_init(tmp);
1159         isl_int_abs(c, a);
1160         isl_int_abs(d, b);
1161         isl_int_set_si(e, 1);
1162         isl_int_set_si(f, 0);
1163         while (isl_int_is_pos(d)) {
1164                 isl_int_tdiv_q(tmp, c, d);
1165                 isl_int_mul(tmp, tmp, f);
1166                 isl_int_sub(e, e, tmp);
1167                 isl_int_tdiv_q(tmp, c, d);
1168                 isl_int_mul(tmp, tmp, d);
1169                 isl_int_sub(c, c, tmp);
1170                 isl_int_swap(c, d);
1171                 isl_int_swap(e, f);
1172         }
1173         isl_int_set(*g, c);
1174         if (isl_int_is_zero(a))
1175                 isl_int_set_si(*x, 0);
1176         else if (isl_int_is_pos(a))
1177                 isl_int_set(*x, e);
1178         else
1179                 isl_int_neg(*x, e);
1180         if (isl_int_is_zero(b))
1181                 isl_int_set_si(*y, 0);
1182         else {
1183                 isl_int_mul(tmp, a, *x);
1184                 isl_int_sub(tmp, c, tmp);
1185                 isl_int_divexact(*y, tmp, b);
1186         }
1187         isl_int_clear(c);
1188         isl_int_clear(d);
1189         isl_int_clear(e);
1190         isl_int_clear(f);
1191         isl_int_clear(tmp);
1192 }
1193
1194 /* Information used inside detect_stride.
1195  *
1196  * "build" may be updated by detect_stride to include stride information.
1197  * "pos" is equal to build->depth.
1198  */
1199 struct isl_detect_stride_data {
1200         isl_ast_build *build;
1201         int pos;
1202 };
1203
1204 /* Check if constraint "c" imposes any stride on dimension data->pos
1205  * and, if so, update the stride information in data->build.
1206  *
1207  * In order to impose a stride on the dimension, "c" needs to be an equality
1208  * and it needs to involve the dimension.  Note that "c" may also be
1209  * a div constraint and thus an inequality that we cannot use.
1210  *
1211  * Let c be of the form
1212  *
1213  *      h(p) + g * v * i + g * stride * f(alpha) = 0
1214  *
1215  * with h(p) an expression in terms of the parameters and outer dimensions
1216  * and f(alpha) an expression in terms of the existentially quantified
1217  * variables.  Note that the inner dimensions have been eliminated so
1218  * they do not appear in "c".
1219  *
1220  * If "stride" is not zero and not one, then it represents a non-trivial stride
1221  * on "i".  We compute a and b such that
1222  *
1223  *      a v + b stride = 1
1224  *
1225  * We have
1226  *
1227  *      g v i = -h(p) + g stride f(alpha)
1228  *
1229  *      a g v i = -a h(p) + g stride f(alpha)
1230  *
1231  *      a g v i + b g stride i = -a h(p) + g stride * (...)
1232  *
1233  *      g i = -a h(p) + g stride * (...)
1234  *
1235  *      i = -a h(p)/g + stride * (...)
1236  *
1237  * The expression "-a h(p)/g" can therefore be used as offset.
1238  */
1239 static int detect_stride(__isl_take isl_constraint *c, void *user)
1240 {
1241         struct isl_detect_stride_data *data = user;
1242         int i, n_div;
1243         isl_int v, gcd, stride, a, b, m;
1244
1245         if (!isl_constraint_is_equality(c) ||
1246             !isl_constraint_involves_dims(c, isl_dim_set, data->pos, 1)) {
1247                 isl_constraint_free(c);
1248                 return 0;
1249         }
1250
1251         isl_int_init(a);
1252         isl_int_init(b);
1253         isl_int_init(v);
1254         isl_int_init(m);
1255         isl_int_init(gcd);
1256         isl_int_init(stride);
1257
1258         isl_int_set_si(gcd, 0);
1259         n_div = isl_constraint_dim(c, isl_dim_div);
1260         for (i = 0; i < n_div; ++i) {
1261                 isl_constraint_get_coefficient(c, isl_dim_div, i, &v);
1262                 isl_int_gcd(gcd, gcd, v);
1263         }
1264
1265         isl_constraint_get_coefficient(c, isl_dim_set, data->pos, &v);
1266         isl_int_gcd(m, v, gcd);
1267         isl_int_divexact(stride, gcd, m);
1268         isl_int_divexact(v, v, m);
1269
1270         if (!isl_int_is_zero(stride) && !isl_int_is_one(stride)) {
1271                 isl_aff *aff;
1272
1273                 euclid(v, stride, &a, &b, &gcd);
1274
1275                 aff = isl_constraint_get_aff(c);
1276                 for (i = 0; i < n_div; ++i)
1277                         aff = isl_aff_set_coefficient_si(aff,
1278                                                          isl_dim_div, i, 0);
1279                 aff = isl_aff_set_coefficient_si(aff, isl_dim_in, data->pos, 0);
1280                 isl_int_neg(a, a);
1281                 aff = isl_aff_scale(aff, a);
1282                 aff = isl_aff_scale_down(aff, m);
1283                 data->build = set_stride(data->build, stride, aff);
1284         }
1285
1286         isl_int_clear(stride);
1287         isl_int_clear(gcd);
1288         isl_int_clear(m);
1289         isl_int_clear(v);
1290         isl_int_clear(b);
1291         isl_int_clear(a);
1292
1293         isl_constraint_free(c);
1294         return 0;
1295 }
1296
1297 /* Check if the constraints in "set" imply any stride on the current
1298  * dimension and, if so, record the stride information in "build"
1299  * and return the updated "build".
1300  *
1301  * We compute the affine hull and then check if any of the constraints
1302  * in the hull imposes any stride on the current dimension.
1303  *
1304  * We assume that inner dimensions have been eliminated from "set"
1305  * by the caller.  This is needed because the common stride
1306  * may be imposed by different inner dimensions on different parts of
1307  * the domain.
1308  */
1309 __isl_give isl_ast_build *isl_ast_build_detect_strides(
1310         __isl_take isl_ast_build *build, __isl_take isl_set *set)
1311 {
1312         isl_basic_set *hull;
1313         struct isl_detect_stride_data data;
1314
1315         if (!build)
1316                 goto error;
1317
1318         data.build = build;
1319         data.pos = isl_ast_build_get_depth(build);
1320         hull = isl_set_affine_hull(set);
1321
1322         if (isl_basic_set_foreach_constraint(hull, &detect_stride, &data) < 0)
1323                 data.build = isl_ast_build_free(data.build);
1324
1325         isl_basic_set_free(hull);
1326         return data.build;
1327 error:
1328         isl_set_free(set);
1329         return NULL;
1330 }
1331
1332 struct isl_ast_build_involves_data {
1333         int depth;
1334         int involves;
1335 };
1336
1337 /* Check if "map" involves the input dimension data->depth.
1338  */
1339 static int involves_depth(__isl_take isl_map *map, void *user)
1340 {
1341         struct isl_ast_build_involves_data *data = user;
1342
1343         data->involves = isl_map_involves_dims(map, isl_dim_in, data->depth, 1);
1344         isl_map_free(map);
1345
1346         if (data->involves < 0 || data->involves)
1347                 return -1;
1348         return 0;
1349 }
1350
1351 /* Do any options depend on the value of the dimension at the current depth?
1352  */
1353 int isl_ast_build_options_involve_depth(__isl_keep isl_ast_build *build)
1354 {
1355         struct isl_ast_build_involves_data data;
1356
1357         if (!build)
1358                 return -1;
1359
1360         data.depth = build->depth;
1361         data.involves = 0;
1362
1363         if (isl_union_map_foreach_map(build->options,
1364                                         &involves_depth, &data) < 0) {
1365                 if (data.involves < 0 || !data.involves)
1366                         return -1;
1367         }
1368
1369         return data.involves;
1370 }
1371
1372 /* Construct the map
1373  *
1374  *      { [i] -> [i] : i < pos; [i] -> [i + 1] : i >= pos }
1375  *
1376  * with "space" the parameter space of the constructed map.
1377  */
1378 static __isl_give isl_map *construct_insertion_map(__isl_take isl_space *space,
1379         int pos)
1380 {
1381         isl_constraint *c;
1382         isl_basic_map *bmap1, *bmap2;
1383
1384         space = isl_space_set_from_params(space);
1385         space = isl_space_add_dims(space, isl_dim_set, 1);
1386         space = isl_space_map_from_set(space);
1387         c = isl_equality_alloc(isl_local_space_from_space(space));
1388         c = isl_constraint_set_coefficient_si(c, isl_dim_in, 0, 1);
1389         c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, -1);
1390         bmap1 = isl_basic_map_from_constraint(isl_constraint_copy(c));
1391         c = isl_constraint_set_constant_si(c, 1);
1392         bmap2 = isl_basic_map_from_constraint(c);
1393
1394         bmap1 = isl_basic_map_upper_bound_si(bmap1, isl_dim_in, 0, pos - 1);
1395         bmap2 = isl_basic_map_lower_bound_si(bmap2, isl_dim_in, 0, pos);
1396
1397         return isl_basic_map_union(bmap1, bmap2);
1398 }
1399
1400 static const char *option_str[] = {
1401         [atomic] = "atomic",
1402         [unroll] = "unroll",
1403         [separate] = "separate"
1404 };
1405
1406 /* Update the "options" to reflect the insertion of a dimension
1407  * at position "pos" in the schedule domain space.
1408  * "space" is the original domain space before the insertion and
1409  * may be named and/or structured.
1410  *
1411  * The (relevant) input options all have "space" as domain, which
1412  * has to be mapped to the extended space.
1413  * The values of the ranges also refer to the schedule domain positions
1414  * and they therefore also need to be adjusted.  In particular, values
1415  * smaller than pos do not need to change, while values greater than or
1416  * equal to pos need to be incremented.
1417  * That is, we need to apply the following map.
1418  *
1419  *      { atomic[i] -> atomic[i] : i < pos; [i] -> [i + 1] : i >= pos;
1420  *        unroll[i] -> unroll[i] : i < pos; [i] -> [i + 1] : i >= pos;
1421  *        separate[i] -> separate[i] : i < pos; [i] -> [i + 1] : i >= pos;
1422  *        separation_class[[i] -> [c]]
1423  *              -> separation_class[[i] -> [c]] : i < pos;
1424  *        separation_class[[i] -> [c]]
1425  *              -> separation_class[[i + 1] -> [c]] : i >= pos }
1426  */
1427 static __isl_give isl_union_map *options_insert_dim(
1428         __isl_take isl_union_map *options, __isl_take isl_space *space, int pos)
1429 {
1430         isl_map *map;
1431         isl_union_map *insertion;
1432         enum isl_ast_build_domain_type type;
1433         const char *name = "separation_class";
1434
1435         space = isl_space_map_from_set(space);
1436         map = isl_map_identity(space);
1437         map = isl_map_insert_dims(map, isl_dim_out, pos, 1);
1438         options = isl_union_map_apply_domain(options,
1439                                                 isl_union_map_from_map(map));
1440
1441         if (!options)
1442                 return NULL;
1443
1444         map = construct_insertion_map(isl_union_map_get_space(options), pos);
1445
1446         insertion = isl_union_map_empty(isl_union_map_get_space(options));
1447
1448         for (type = atomic; type <= separate; ++type) {
1449                 isl_map *map_type = isl_map_copy(map);
1450                 const char *name = option_str[type];
1451                 map_type = isl_map_set_tuple_name(map_type, isl_dim_in, name);
1452                 map_type = isl_map_set_tuple_name(map_type, isl_dim_out, name);
1453                 insertion = isl_union_map_add_map(insertion, map_type);
1454         }
1455
1456         map = isl_map_product(map, isl_map_identity(isl_map_get_space(map)));
1457         map = isl_map_set_tuple_name(map, isl_dim_in, name);
1458         map = isl_map_set_tuple_name(map, isl_dim_out, name);
1459         insertion = isl_union_map_add_map(insertion, map);
1460
1461         options = isl_union_map_apply_range(options, insertion);
1462
1463         return options;
1464 }
1465
1466 /* Insert a single dimension in the schedule domain at position "pos".
1467  * The new dimension is given an isl_id with the empty string as name.
1468  *
1469  * The main difficulty is updating build->options to reflect the
1470  * extra dimension.  This is handled in options_insert_dim.
1471  *
1472  * Note that because of the dimension manipulations, the resulting
1473  * schedule domain space will always be unnamed and unstructured.
1474  * However, the original schedule domain space may be named and/or
1475  * structured, so we have to take this possibility into account
1476  * while performing the transformations.
1477  */
1478 __isl_give isl_ast_build *isl_ast_build_insert_dim(
1479         __isl_take isl_ast_build *build, int pos)
1480 {
1481         isl_ctx *ctx;
1482         isl_space *space, *ma_space;
1483         isl_id *id;
1484         isl_multi_aff *ma;
1485
1486         build = isl_ast_build_cow(build);
1487         if (!build)
1488                 return NULL;
1489
1490         ctx = isl_ast_build_get_ctx(build);
1491         id = isl_id_alloc(ctx, "", NULL);
1492         space = isl_ast_build_get_space(build, 1);
1493         build->iterators = isl_id_list_insert(build->iterators, pos, id);
1494         build->domain = isl_set_insert_dims(build->domain,
1495                                                 isl_dim_set, pos, 1);
1496         build->generated = isl_set_insert_dims(build->generated,
1497                                                 isl_dim_set, pos, 1);
1498         build->pending = isl_set_insert_dims(build->pending,
1499                                                 isl_dim_set, pos, 1);
1500         build->strides = isl_vec_insert_els(build->strides, pos, 1);
1501         build->strides = isl_vec_set_element_si(build->strides, pos, 1);
1502         ma_space = isl_space_params(isl_multi_aff_get_space(build->offsets));
1503         ma_space = isl_space_set_from_params(ma_space);
1504         ma_space = isl_space_add_dims(ma_space, isl_dim_set, 1);
1505         ma_space = isl_space_map_from_set(ma_space);
1506         ma = isl_multi_aff_zero(isl_space_copy(ma_space));
1507         build->offsets = isl_multi_aff_splice(build->offsets, pos, pos, ma);
1508         ma = isl_multi_aff_identity(ma_space);
1509         build->values = isl_multi_aff_splice(build->values, pos, pos, ma);
1510         build->options = options_insert_dim(build->options, space, pos);
1511
1512         if (!build->iterators || !build->domain || !build->generated ||
1513             !build->pending || !build->values ||
1514             !build->strides || !build->offsets || !build->options)
1515                 return isl_ast_build_free(build);
1516
1517         return build;
1518 }
1519
1520 /* Scale down the current dimension by a factor of "m".
1521  * "umap" is an isl_union_map that implements the scaling down.
1522  * That is, it is of the form
1523  *
1524  *      { [.... i ....] -> [.... i' ....] : i = m i' }
1525  *
1526  * This function is called right after the strides have been
1527  * detected, but before any constraints on the current dimension
1528  * have been included in build->domain.
1529  * We therefore only need to update stride, offset and the options.
1530  */
1531 __isl_give isl_ast_build *isl_ast_build_scale_down(
1532         __isl_take isl_ast_build *build, isl_int m,
1533         __isl_take isl_union_map *umap)
1534 {
1535         isl_aff *aff;
1536         isl_int v;
1537         int depth;
1538
1539         build = isl_ast_build_cow(build);
1540         if (!build || !umap)
1541                 goto error;
1542
1543         depth = build->depth;
1544
1545         isl_int_init(v);
1546         if (isl_vec_get_element(build->strides, depth, &v) < 0)
1547                 build->strides = isl_vec_free(build->strides);
1548         isl_int_divexact(v, v, m);
1549         build->strides = isl_vec_set_element(build->strides, depth, v);
1550         isl_int_clear(v);
1551
1552         aff = isl_multi_aff_get_aff(build->offsets, depth);
1553         aff = isl_aff_scale_down(aff, m);
1554         build->offsets = isl_multi_aff_set_aff(build->offsets, depth, aff);
1555         build->options = isl_union_map_apply_domain(build->options, umap);
1556         if (!build->strides || !build->offsets || !build->options)
1557                 return isl_ast_build_free(build);
1558
1559         return build;
1560 error:
1561         isl_union_map_free(umap);
1562         return isl_ast_build_free(build);
1563 }
1564
1565 /* Return a list of "n" isl_ids called "c%d", with "%d" starting at "first".
1566  * If an isl_id with such a name already appears among the parameters
1567  * in build->domain, then adjust the name to "c%d_%d".
1568  */
1569 static __isl_give isl_id_list *generate_names(isl_ctx *ctx, int n, int first,
1570         __isl_keep isl_ast_build *build)
1571 {
1572         int i;
1573         isl_id_list *names;
1574
1575         names = isl_id_list_alloc(ctx, n);
1576         for (i = 0; i < n; ++i) {
1577                 isl_id *id;
1578
1579                 id = generate_name(ctx, first + i, build);
1580                 names = isl_id_list_add(names, id);
1581         }
1582
1583         return names;
1584 }
1585
1586 /* Embed "options" into the given isl_ast_build space.
1587  *
1588  * This function is called from within a nested call to
1589  * isl_ast_build_ast_from_schedule.
1590  * "options" refers to the additional schedule,
1591  * while space refers to both the space of the outer isl_ast_build and
1592  * that of the additional schedule.
1593  * Specifically, space is of the form
1594  *
1595  *      [I -> S]
1596  *
1597  * while options lives in the space(s)
1598  *
1599  *      S -> *
1600  *
1601  * We compute
1602  *
1603  *      [I -> S] -> S
1604  *
1605  * and compose this with options, to obtain the new options
1606  * living in the space(s)
1607  *
1608  *      [I -> S] -> *
1609  */
1610 static __isl_give isl_union_map *embed_options(
1611         __isl_take isl_union_map *options, __isl_take isl_space *space)
1612 {
1613         isl_map *map;
1614
1615         map = isl_map_universe(isl_space_unwrap(space));
1616         map = isl_map_range_map(map);
1617
1618         options = isl_union_map_apply_range(
1619                                 isl_union_map_from_map(map), options);
1620
1621         return options;
1622 }
1623
1624 /* Update "build" for use in a (possibly nested) code generation.  That is,
1625  * extend "build" from an AST build on some domain O to an AST build
1626  * on domain [O -> S], with S corresponding to "space".
1627  * If the original domain is a parameter domain, then the new domain is
1628  * simply S.
1629  * "iterators" is a list of iterators for S, but the number of elements
1630  * may be smaller or greater than the number of set dimensions of S.
1631  * If "keep_iterators" is set, then any extra ids in build->iterators
1632  * are reused for S.  Otherwise, these extra ids are dropped.
1633  *
1634  * We first update build->outer_pos to the current depth.
1635  * This depth is zero in case this is the outermost code generation.
1636  *
1637  * We then add additional ids such that the number of iterators is at least
1638  * equal to the dimension of the new build domain.
1639  *
1640  * If the original domain is parametric, then we are constructing
1641  * an isl_ast_build for the outer code generation and we pass control
1642  * to isl_ast_build_init.
1643  *
1644  * Otherwise, we adjust the fields of "build" to include "space".
1645  */
1646 __isl_give isl_ast_build *isl_ast_build_product(
1647         __isl_take isl_ast_build *build, __isl_take isl_space *space)
1648 {
1649         isl_ctx *ctx;
1650         isl_vec *strides;
1651         isl_set *set;
1652         isl_multi_aff *embedding;
1653         int dim, n_it;
1654
1655         build = isl_ast_build_cow(build);
1656         if (!build)
1657                 goto error;
1658
1659         build->outer_pos = build->depth;
1660
1661         ctx = isl_ast_build_get_ctx(build);
1662         dim = isl_set_dim(build->domain, isl_dim_set);
1663         dim += isl_space_dim(space, isl_dim_set);
1664         n_it = isl_id_list_n_id(build->iterators);
1665         if (n_it < dim) {
1666                 isl_id_list *l;
1667                 l = generate_names(ctx, dim - n_it, n_it, build);
1668                 build->iterators = isl_id_list_concat(build->iterators, l);
1669         }
1670
1671         if (isl_set_is_params(build->domain))
1672                 return isl_ast_build_init(build, space);
1673
1674         set = isl_set_universe(isl_space_copy(space));
1675         build->domain = isl_set_product(build->domain, isl_set_copy(set));
1676         build->pending = isl_set_product(build->pending, isl_set_copy(set));
1677         build->generated = isl_set_product(build->generated, set);
1678
1679         strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
1680         strides = isl_vec_set_si(strides, 1);
1681         build->strides = isl_vec_concat(build->strides, strides);
1682
1683         space = isl_space_map_from_set(space);
1684         build->offsets = isl_multi_aff_align_params(build->offsets,
1685                                                     isl_space_copy(space));
1686         build->offsets = isl_multi_aff_product(build->offsets,
1687                                 isl_multi_aff_zero(isl_space_copy(space)));
1688         build->values = isl_multi_aff_align_params(build->values,
1689                                                     isl_space_copy(space));
1690         embedding = isl_multi_aff_identity(space);
1691         build->values = isl_multi_aff_product(build->values, embedding);
1692
1693         space = isl_ast_build_get_space(build, 1);
1694         build->options = embed_options(build->options, space);
1695
1696         if (!build->iterators || !build->domain || !build->generated ||
1697             !build->pending || !build->values ||
1698             !build->strides || !build->offsets || !build->options)
1699                 return isl_ast_build_free(build);
1700
1701         return build;
1702 error:
1703         isl_ast_build_free(build);
1704         isl_space_free(space);
1705         return NULL;
1706 }
1707
1708 /* Does "aff" only attain non-negative values over build->domain?
1709  * That is, does it not attain any negative values?
1710  */
1711 int isl_ast_build_aff_is_nonneg(__isl_keep isl_ast_build *build,
1712         __isl_keep isl_aff *aff)
1713 {
1714         isl_set *test;
1715         int empty;
1716
1717         if (!build)
1718                 return -1;
1719
1720         aff = isl_aff_copy(aff);
1721         test = isl_set_from_basic_set(isl_aff_neg_basic_set(aff));
1722         test = isl_set_intersect(test, isl_set_copy(build->domain));
1723         empty = isl_set_is_empty(test);
1724         isl_set_free(test);
1725
1726         return empty;
1727 }
1728
1729 /* Does the dimension at (internal) position "pos" have a non-trivial stride?
1730  */
1731 int isl_ast_build_has_stride(__isl_keep isl_ast_build *build, int pos)
1732 {
1733         isl_int v;
1734         int has_stride;
1735
1736         if (!build)
1737                 return -1;
1738
1739         isl_int_init(v);
1740         isl_vec_get_element(build->strides, pos, &v);
1741         has_stride = !isl_int_is_one(v);
1742         isl_int_clear(v);
1743
1744         return has_stride;
1745 }
1746
1747 /* Given that the dimension at position "pos" takes on values
1748  *
1749  *      f + s a
1750  *
1751  * with a an integer, return s through *stride.
1752  */
1753 int isl_ast_build_get_stride(__isl_keep isl_ast_build *build, int pos,
1754         isl_int *stride)
1755 {
1756         if (!build)
1757                 return -1;
1758
1759         isl_vec_get_element(build->strides, pos, stride);
1760
1761         return 0;
1762 }
1763
1764 /* Given that the dimension at position "pos" takes on values
1765  *
1766  *      f + s a
1767  *
1768  * with a an integer, return f.
1769  */
1770 __isl_give isl_aff *isl_ast_build_get_offset(
1771         __isl_keep isl_ast_build *build, int pos)
1772 {
1773         if (!build)
1774                 return NULL;
1775
1776         return isl_multi_aff_get_aff(build->offsets, pos);
1777 }
1778
1779 /* Is the dimension at position "pos" known to attain only a single
1780  * value that, moreover, can be described by a single affine expression
1781  * in terms of the outer dimensions and parameters?
1782  *
1783  * If not, then the correponding affine expression in build->values
1784  * is set to be equal to the same input dimension.
1785  * Otherwise, it is set to the requested expression in terms of
1786  * outer dimensions and parameters.
1787  */
1788 int isl_ast_build_has_affine_value(__isl_keep isl_ast_build *build,
1789         int pos)
1790 {
1791         isl_aff *aff;
1792         int involves;
1793
1794         if (!build)
1795                 return -1;
1796
1797         aff = isl_multi_aff_get_aff(build->values, pos);
1798         involves = isl_aff_involves_dims(aff, isl_dim_in, pos, 1);
1799         isl_aff_free(aff);
1800
1801         if (involves < 0)
1802                 return -1;
1803
1804         return !involves;
1805 }
1806
1807 /* Is the current dimension known to attain only a single value?
1808  */
1809 int isl_ast_build_has_value(__isl_keep isl_ast_build *build)
1810 {
1811         if (!build)
1812                 return -1;
1813
1814         return build->value != NULL;
1815 }
1816
1817 /* Simplify the basic set "bset" based on what we know about
1818  * the iterators of already generated loops.
1819  *
1820  * "bset" is assumed to live in the (internal) schedule domain.
1821  */
1822 __isl_give isl_basic_set *isl_ast_build_compute_gist_basic_set(
1823         __isl_keep isl_ast_build *build, __isl_take isl_basic_set *bset)
1824 {
1825         if (!build)
1826                 goto error;
1827
1828         bset = isl_basic_set_preimage_multi_aff(bset,
1829                                         isl_multi_aff_copy(build->values));
1830         bset = isl_basic_set_gist(bset,
1831                         isl_set_simple_hull(isl_set_copy(build->domain)));
1832
1833         return bset;
1834 error:
1835         isl_basic_set_free(bset);
1836         return NULL;
1837 }
1838
1839 /* Simplify the set "set" based on what we know about
1840  * the iterators of already generated loops.
1841  *
1842  * "set" is assumed to live in the (internal) schedule domain.
1843  */
1844 __isl_give isl_set *isl_ast_build_compute_gist(
1845         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
1846 {
1847         if (!build)
1848                 goto error;
1849
1850         set = isl_set_preimage_multi_aff(set,
1851                                         isl_multi_aff_copy(build->values));
1852         set = isl_set_gist(set, isl_set_copy(build->domain));
1853
1854         return set;
1855 error:
1856         isl_set_free(set);
1857         return NULL;
1858 }
1859
1860 /* Simplify the map "map" based on what we know about
1861  * the iterators of already generated loops.
1862  *
1863  * The domain of "map" is assumed to live in the (internal) schedule domain.
1864  */
1865 __isl_give isl_map *isl_ast_build_compute_gist_map_domain(
1866         __isl_keep isl_ast_build *build, __isl_take isl_map *map)
1867 {
1868         if (!build)
1869                 goto error;
1870
1871         map = isl_map_gist_domain(map, isl_set_copy(build->domain));
1872
1873         return map;
1874 error:
1875         isl_map_free(map);
1876         return NULL;
1877 }
1878
1879 /* Simplify the affine expression "aff" based on what we know about
1880  * the iterators of already generated loops.
1881  *
1882  * The domain of "aff" is assumed to live in the (internal) schedule domain.
1883  */
1884 __isl_give isl_aff *isl_ast_build_compute_gist_aff(
1885         __isl_keep isl_ast_build *build, __isl_take isl_aff *aff)
1886 {
1887         if (!build)
1888                 goto error;
1889
1890         aff = isl_aff_gist(aff, isl_set_copy(build->domain));
1891
1892         return aff;
1893 error:
1894         isl_aff_free(aff);
1895         return NULL;
1896 }
1897
1898 /* Simplify the piecewise affine expression "aff" based on what we know about
1899  * the iterators of already generated loops.
1900  *
1901  * The domain of "pa" is assumed to live in the (internal) schedule domain.
1902  */
1903 __isl_give isl_pw_aff *isl_ast_build_compute_gist_pw_aff(
1904         __isl_keep isl_ast_build *build, __isl_take isl_pw_aff *pa)
1905 {
1906         if (!build)
1907                 goto error;
1908
1909         pa = isl_pw_aff_pullback_multi_aff(pa,
1910                                         isl_multi_aff_copy(build->values));
1911         pa = isl_pw_aff_gist(pa, isl_set_copy(build->domain));
1912
1913         return pa;
1914 error:
1915         isl_pw_aff_free(pa);
1916         return NULL;
1917 }
1918
1919 /* Simplify the piecewise multi-affine expression "aff" based on what
1920  * we know about the iterators of already generated loops.
1921  *
1922  * The domain of "pma" is assumed to live in the (internal) schedule domain.
1923  */
1924 __isl_give isl_pw_multi_aff *isl_ast_build_compute_gist_pw_multi_aff(
1925         __isl_keep isl_ast_build *build, __isl_take isl_pw_multi_aff *pma)
1926 {
1927         if (!build)
1928                 goto error;
1929
1930         pma = isl_pw_multi_aff_pullback_multi_aff(pma,
1931                                         isl_multi_aff_copy(build->values));
1932         pma = isl_pw_multi_aff_gist(pma, isl_set_copy(build->domain));
1933
1934         return pma;
1935 error:
1936         isl_pw_multi_aff_free(pma);
1937         return NULL;
1938 }
1939
1940 /* Extract the schedule domain of the given type from build->options
1941  * at the current depth.
1942  *
1943  * In particular, find the subset of build->options that is of
1944  * the following form
1945  *
1946  *      schedule_domain -> type[depth]
1947  *
1948  * and return the corresponding domain, after eliminating inner dimensions
1949  * and divs that depend on the current dimension.
1950  *
1951  * Note that the domain of build->options has been reformulated
1952  * in terms of the internal build space in embed_options,
1953  * but the position is still that within the current code generation.
1954  */
1955 __isl_give isl_set *isl_ast_build_get_option_domain(
1956         __isl_keep isl_ast_build *build,
1957         enum isl_ast_build_domain_type type)
1958 {
1959         const char *name;
1960         isl_space *space;
1961         isl_map *option;
1962         isl_set *domain;
1963         int local_pos;
1964
1965         if (!build)
1966                 return NULL;
1967
1968         name = option_str[type];
1969         local_pos = build->depth - build->outer_pos;
1970
1971         space = isl_ast_build_get_space(build, 1);
1972         space = isl_space_from_domain(space);
1973         space = isl_space_add_dims(space, isl_dim_out, 1);
1974         space = isl_space_set_tuple_name(space, isl_dim_out, name);
1975
1976         option = isl_union_map_extract_map(build->options, space);
1977         option = isl_map_fix_si(option, isl_dim_out, 0, local_pos);
1978
1979         domain = isl_map_domain(option);
1980         domain = isl_ast_build_eliminate(build, domain);
1981
1982         return domain;
1983 }
1984
1985 /* Extract the separation class mapping at the current depth.
1986  *
1987  * In particular, find and return the subset of build->options that is of
1988  * the following form
1989  *
1990  *      schedule_domain -> separation_class[[depth] -> [class]]
1991  *
1992  * The caller is expected to eliminate inner dimensions from the domain.
1993  *
1994  * Note that the domain of build->options has been reformulated
1995  * in terms of the internal build space in embed_options,
1996  * but the position is still that within the current code generation.
1997  */
1998 __isl_give isl_map *isl_ast_build_get_separation_class(
1999         __isl_keep isl_ast_build *build)
2000 {
2001         isl_ctx *ctx;
2002         isl_space *space_sep, *space;
2003         isl_map *res;
2004         int local_pos;
2005
2006         if (!build)
2007                 return NULL;
2008
2009         local_pos = build->depth - build->outer_pos;
2010         ctx = isl_ast_build_get_ctx(build);
2011         space_sep = isl_space_alloc(ctx, 0, 1, 1);
2012         space_sep = isl_space_wrap(space_sep);
2013         space_sep = isl_space_set_tuple_name(space_sep, isl_dim_set,
2014                                                 "separation_class");
2015         space = isl_ast_build_get_space(build, 1);
2016         space_sep = isl_space_align_params(space_sep, isl_space_copy(space));
2017         space = isl_space_map_from_domain_and_range(space, space_sep);
2018
2019         res = isl_union_map_extract_map(build->options, space);
2020         res = isl_map_fix_si(res, isl_dim_out, 0, local_pos);
2021         res = isl_map_coalesce(res);
2022
2023         return res;
2024 }
2025
2026 /* Eliminate dimensions inner to the current dimension.
2027  */
2028 __isl_give isl_set *isl_ast_build_eliminate_inner(
2029         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2030 {
2031         int dim;
2032         int depth;
2033
2034         if (!build)
2035                 return isl_set_free(set);
2036
2037         dim = isl_set_dim(set, isl_dim_set);
2038         depth = build->depth;
2039         set = isl_set_detect_equalities(set);
2040         set = isl_set_eliminate(set, isl_dim_set, depth + 1, dim - (depth + 1));
2041
2042         return set;
2043 }
2044
2045 /* Eliminate unknown divs and divs that depend on the current dimension.
2046  *
2047  * Note that during the elimination of unknown divs, we may discover
2048  * an explicit representation of some other unknown divs, which may
2049  * depend on the current dimension.  We therefore need to eliminate
2050  * unknown divs first.
2051  */
2052 __isl_give isl_set *isl_ast_build_eliminate_divs(
2053         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2054 {
2055         int depth;
2056
2057         if (!build)
2058                 return isl_set_free(set);
2059
2060         set = isl_set_remove_unknown_divs(set);
2061         depth = build->depth;
2062         set = isl_set_remove_divs_involving_dims(set, isl_dim_set, depth, 1);
2063
2064         return set;
2065 }
2066
2067 /* Eliminate dimensions inner to the current dimension as well as
2068  * unknown divs and divs that depend on the current dimension.
2069  * The result then consists only of constraints that are independent
2070  * of the current dimension and upper and lower bounds on the current
2071  * dimension.
2072  */
2073 __isl_give isl_set *isl_ast_build_eliminate(
2074         __isl_keep isl_ast_build *build, __isl_take isl_set *domain)
2075 {
2076         domain = isl_ast_build_eliminate_inner(build, domain);
2077         domain = isl_ast_build_eliminate_divs(build, domain);
2078         return domain;
2079 }
2080
2081 /* Replace build->single_valued by "sv".
2082  */
2083 __isl_give isl_ast_build *isl_ast_build_set_single_valued(
2084         __isl_take isl_ast_build *build, int sv)
2085 {
2086         if (!build)
2087                 return build;
2088         if (build->single_valued == sv)
2089                 return build;
2090         build = isl_ast_build_cow(build);
2091         if (!build)
2092                 return build;
2093         build->single_valued = sv;
2094
2095         return build;
2096 }