isl_ast_build.c: use isl_int_gcdext instead of open-coded version
[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                         build->domain = isl_set_compute_divs(build->domain);
740                 }
741         } else {
742                 isl_basic_set *generated, *pending;
743
744                 pending = isl_basic_set_copy(bounds);
745                 pending = isl_basic_set_drop_constraints_involving_dims(pending,
746                                         isl_dim_set, build->depth, 1);
747                 build->pending = isl_set_intersect(build->pending,
748                                         isl_set_from_basic_set(pending));
749                 generated = isl_basic_set_copy(bounds);
750                 generated = isl_basic_set_drop_constraints_not_involving_dims(
751                                     generated, isl_dim_set, build->depth, 1);
752                 build->generated = isl_set_intersect(build->generated,
753                                         isl_set_from_basic_set(generated));
754         }
755         isl_basic_set_free(bounds);
756
757         build->domain = isl_set_intersect(build->domain, set);
758         if (!build->domain || !build->pending || !build->generated)
759                 return isl_ast_build_free(build);
760
761         return build;
762 error:
763         isl_ast_build_free(build);
764         isl_basic_set_free(bounds);
765         return NULL;
766 }
767
768 /* Update build->domain based on the constraints enforced by inner loops.
769  *
770  * The constraints in build->pending may end up not getting generated
771  * if they are implied by "enforced".  We therefore reconstruct
772  * build->domain from build->generated and build->pending, dropping
773  * those constraint in build->pending that may not get generated.
774  */
775 __isl_give isl_ast_build *isl_ast_build_set_enforced(
776         __isl_take isl_ast_build *build, __isl_take isl_basic_set *enforced)
777 {
778         isl_set *set;
779
780         build = isl_ast_build_cow(build);
781         if (!build)
782                 goto error;
783
784         set = isl_set_from_basic_set(enforced);
785         set = isl_set_gist(isl_set_copy(build->pending), set);
786         set = isl_set_intersect(isl_set_copy(build->generated), set);
787
788         isl_set_free(build->domain);
789         build->domain = set;
790
791         if (!build->domain)
792                 return isl_ast_build_free(build);
793
794         return build;
795 error:
796         isl_basic_set_free(enforced);
797         return isl_ast_build_free(build);
798 }
799
800 /* Intersect build->domain with "set", where "set" is specified
801  * in terms of the internal schedule domain.
802  */
803 static __isl_give isl_ast_build *isl_ast_build_restrict_internal(
804         __isl_take isl_ast_build *build, __isl_take isl_set *set)
805 {
806         build = isl_ast_build_cow(build);
807         if (!build)
808                 goto error;
809
810         set = isl_set_compute_divs(set);
811         build->domain = isl_set_intersect(build->domain, set);
812         build->domain = isl_set_coalesce(build->domain);
813
814         if (!build->domain)
815                 return isl_ast_build_free(build);
816
817         return build;
818 error:
819         isl_ast_build_free(build);
820         isl_set_free(set);
821         return NULL;
822 }
823
824 /* Intersect build->generated and build->domain with "set",
825  * where "set" is specified in terms of the internal schedule domain.
826  */
827 __isl_give isl_ast_build *isl_ast_build_restrict_generated(
828         __isl_take isl_ast_build *build, __isl_take isl_set *set)
829 {
830         set = isl_set_compute_divs(set);
831         build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
832         build = isl_ast_build_cow(build);
833         if (!build)
834                 goto error;
835
836         build->generated = isl_set_intersect(build->generated, set);
837         build->generated = isl_set_coalesce(build->generated);
838
839         if (!build->generated)
840                 return isl_ast_build_free(build);
841
842         return build;
843 error:
844         isl_ast_build_free(build);
845         isl_set_free(set);
846         return NULL;
847 }
848
849 /* Intersect build->pending and build->domain with "set",
850  * where "set" is specified in terms of the internal schedule domain.
851  */
852 __isl_give isl_ast_build *isl_ast_build_restrict_pending(
853         __isl_take isl_ast_build *build, __isl_take isl_set *set)
854 {
855         set = isl_set_compute_divs(set);
856         build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
857         build = isl_ast_build_cow(build);
858         if (!build)
859                 goto error;
860
861         build->pending = isl_set_intersect(build->pending, set);
862         build->pending = isl_set_coalesce(build->pending);
863
864         if (!build->pending)
865                 return isl_ast_build_free(build);
866
867         return build;
868 error:
869         isl_ast_build_free(build);
870         isl_set_free(set);
871         return NULL;
872 }
873
874 /* Intersect build->domain with "set", where "set" is specified
875  * in terms of the external schedule domain.
876  */
877 __isl_give isl_ast_build *isl_ast_build_restrict(
878         __isl_take isl_ast_build *build, __isl_take isl_set *set)
879 {
880         if (isl_set_is_params(set))
881                 return isl_ast_build_restrict_generated(build, set);
882
883         if (isl_ast_build_need_schedule_map(build)) {
884                 isl_multi_aff *ma;
885                 ma = isl_ast_build_get_schedule_map_multi_aff(build);
886                 set = isl_set_preimage_multi_aff(set, ma);
887         }
888         return isl_ast_build_restrict_generated(build, set);
889 }
890
891 /* Replace build->executed by "executed".
892  */
893 __isl_give isl_ast_build *isl_ast_build_set_executed(
894         __isl_take isl_ast_build *build, __isl_take isl_union_map *executed)
895 {
896         build = isl_ast_build_cow(build);
897         if (!build)
898                 goto error;
899
900         isl_union_map_free(build->executed);
901         build->executed = executed;
902
903         return build;
904 error:
905         isl_ast_build_free(build);
906         isl_union_map_free(executed);
907         return NULL;
908 }
909
910 /* Return a copy of the current schedule domain.
911  */
912 __isl_give isl_set *isl_ast_build_get_domain(__isl_keep isl_ast_build *build)
913 {
914         return build ? isl_set_copy(build->domain) : NULL;
915 }
916
917 /* Return the (schedule) space of "build".
918  *
919  * If "internal" is set, then this space is the space of the internal
920  * representation of the entire schedule, including those parts for
921  * which no code has been generated yet.
922  *
923  * If "internal" is not set, then this space is the external representation
924  * of the loops generated so far.
925  */
926 __isl_give isl_space *isl_ast_build_get_space(__isl_keep isl_ast_build *build,
927         int internal)
928 {
929         int i;
930         int dim;
931         isl_space *space;
932
933         if (!build)
934                 return NULL;
935
936         space = isl_set_get_space(build->domain);
937         if (internal)
938                 return space;
939
940         if (!isl_ast_build_need_schedule_map(build))
941                 return space;
942
943         dim = isl_set_dim(build->domain, isl_dim_set);
944         space = isl_space_drop_dims(space, isl_dim_set,
945                                     build->depth, dim - build->depth);
946         for (i = build->depth - 1; i >= 0; --i)
947                 if (isl_ast_build_has_affine_value(build, i))
948                         space = isl_space_drop_dims(space, isl_dim_set, i, 1);
949
950         return space;
951 }
952
953 /* Return the external representation of the schedule space of "build",
954  * i.e., a space with a dimension for each loop generated so far,
955  * with the names of the dimensions set to the loop iterators.
956  */
957 __isl_give isl_space *isl_ast_build_get_schedule_space(
958         __isl_keep isl_ast_build *build)
959 {
960         isl_space *space;
961         int i, skip;
962
963         if (!build)
964                 return NULL;
965
966         space = isl_ast_build_get_space(build, 0);
967
968         skip = 0;
969         for (i = 0; i < build->depth; ++i) {
970                 isl_id *id;
971
972                 if (isl_ast_build_has_affine_value(build, i)) {
973                         skip++;
974                         continue;
975                 }
976
977                 id = isl_ast_build_get_iterator_id(build, i);
978                 space = isl_space_set_dim_id(space, isl_dim_set, i - skip, id);
979         }
980
981         return space;
982 }
983
984 /* Return the current schedule, as stored in build->executed, in terms
985  * of the external schedule domain.
986  */
987 __isl_give isl_union_map *isl_ast_build_get_schedule(
988         __isl_keep isl_ast_build *build)
989 {
990         isl_union_map *executed;
991         isl_union_map *schedule;
992
993         if (!build)
994                 return NULL;
995
996         executed = isl_union_map_copy(build->executed);
997         if (isl_ast_build_need_schedule_map(build)) {
998                 isl_map *proj = isl_ast_build_get_schedule_map(build);
999                 executed = isl_union_map_apply_domain(executed,
1000                                         isl_union_map_from_map(proj));
1001         }
1002         schedule = isl_union_map_reverse(executed);
1003
1004         return schedule;
1005 }
1006
1007 /* Return the iterator attached to the internal schedule dimension "pos".
1008  */
1009 __isl_give isl_id *isl_ast_build_get_iterator_id(
1010         __isl_keep isl_ast_build *build, int pos)
1011 {
1012         if (!build)
1013                 return NULL;
1014
1015         return isl_id_list_get_id(build->iterators, pos);
1016 }
1017
1018 /* Set the stride and offset of the current dimension to the given
1019  * value and expression.
1020  */
1021 static __isl_give isl_ast_build *set_stride(__isl_take isl_ast_build *build,
1022         isl_int stride, __isl_take isl_aff *offset)
1023 {
1024         int pos;
1025
1026         build = isl_ast_build_cow(build);
1027         if (!build || !offset)
1028                 goto error;
1029
1030         pos = build->depth;
1031         build->strides = isl_vec_set_element(build->strides, pos, stride);
1032         build->offsets = isl_multi_aff_set_aff(build->offsets, pos, offset);
1033         if (!build->strides || !build->offsets)
1034                 return isl_ast_build_free(build);
1035
1036         return build;
1037 error:
1038         isl_aff_free(offset);
1039         return isl_ast_build_free(build);
1040 }
1041
1042 /* Return a set expressing the stride constraint at the current depth.
1043  *
1044  * In particular, if the current iterator (i) is known to attain values
1045  *
1046  *      f + s a
1047  *
1048  * where f is the offset and s is the stride, then the returned set
1049  * expresses the constraint
1050  *
1051  *      (f - i) mod s = 0
1052  */
1053 __isl_give isl_set *isl_ast_build_get_stride_constraint(
1054         __isl_keep isl_ast_build *build)
1055 {
1056         isl_aff *aff;
1057         isl_set *set;
1058         isl_int stride;
1059         int pos;
1060
1061         if (!build)
1062                 return NULL;
1063
1064         pos = build->depth;
1065
1066         if (!isl_ast_build_has_stride(build, pos))
1067                 return isl_set_universe(isl_ast_build_get_space(build, 1));
1068
1069         isl_int_init(stride);
1070
1071         isl_ast_build_get_stride(build, pos, &stride);
1072         aff = isl_ast_build_get_offset(build, pos);
1073         aff = isl_aff_add_coefficient_si(aff, isl_dim_in, pos, -1);
1074         aff = isl_aff_mod(aff, stride);
1075         set = isl_set_from_basic_set(isl_aff_zero_basic_set(aff));
1076
1077         isl_int_clear(stride);
1078
1079         return set;
1080 }
1081
1082 /* Return the expansion implied by the stride and offset at the current
1083  * depth.
1084  *
1085  * That is, return the mapping
1086  *
1087  *      [i_0, ..., i_{d-1}, i_d, i_{d+1}, ...]
1088  *              -> [i_0, ..., i_{d-1}, s * i_d + offset(i),  i_{d+1}, ...]
1089  *
1090  * where s is the stride at the current depth d and offset(i) is
1091  * the corresponding offset.
1092  */
1093 __isl_give isl_multi_aff *isl_ast_build_get_stride_expansion(
1094         __isl_keep isl_ast_build *build)
1095 {
1096         isl_space *space;
1097         isl_multi_aff *ma;
1098         int pos;
1099         isl_aff *aff, *offset;
1100         isl_int stride;
1101
1102         if (!build)
1103                 return NULL;
1104
1105         pos = isl_ast_build_get_depth(build);
1106         space = isl_ast_build_get_space(build, 1);
1107         space = isl_space_map_from_set(space);
1108         ma = isl_multi_aff_identity(space);
1109
1110         if (!isl_ast_build_has_stride(build, pos))
1111                 return ma;
1112
1113         isl_int_init(stride);
1114         offset = isl_ast_build_get_offset(build, pos);
1115         isl_ast_build_get_stride(build, pos, &stride);
1116         aff = isl_multi_aff_get_aff(ma, pos);
1117         aff = isl_aff_scale(aff, stride);
1118         aff = isl_aff_add(aff, offset);
1119         ma = isl_multi_aff_set_aff(ma, pos, aff);
1120         isl_int_clear(stride);
1121
1122         return ma;
1123 }
1124
1125 /* Add constraints corresponding to any previously detected
1126  * stride on the current dimension to build->domain.
1127  */
1128 __isl_give isl_ast_build *isl_ast_build_include_stride(
1129         __isl_take isl_ast_build *build)
1130 {
1131         isl_set *set;
1132
1133         if (!build)
1134                 return NULL;
1135         if (!isl_ast_build_has_stride(build, build->depth))
1136                 return build;
1137         build = isl_ast_build_cow(build);
1138         if (!build)
1139                 return NULL;
1140
1141         set = isl_ast_build_get_stride_constraint(build);
1142
1143         build->domain = isl_set_intersect(build->domain, isl_set_copy(set));
1144         build->generated = isl_set_intersect(build->generated, set);
1145         if (!build->domain || !build->generated)
1146                 return isl_ast_build_free(build);
1147
1148         return build;
1149 }
1150
1151 /* Information used inside detect_stride.
1152  *
1153  * "build" may be updated by detect_stride to include stride information.
1154  * "pos" is equal to build->depth.
1155  */
1156 struct isl_detect_stride_data {
1157         isl_ast_build *build;
1158         int pos;
1159 };
1160
1161 /* Check if constraint "c" imposes any stride on dimension data->pos
1162  * and, if so, update the stride information in data->build.
1163  *
1164  * In order to impose a stride on the dimension, "c" needs to be an equality
1165  * and it needs to involve the dimension.  Note that "c" may also be
1166  * a div constraint and thus an inequality that we cannot use.
1167  *
1168  * Let c be of the form
1169  *
1170  *      h(p) + g * v * i + g * stride * f(alpha) = 0
1171  *
1172  * with h(p) an expression in terms of the parameters and outer dimensions
1173  * and f(alpha) an expression in terms of the existentially quantified
1174  * variables.  Note that the inner dimensions have been eliminated so
1175  * they do not appear in "c".
1176  *
1177  * If "stride" is not zero and not one, then it represents a non-trivial stride
1178  * on "i".  We compute a and b such that
1179  *
1180  *      a v + b stride = 1
1181  *
1182  * We have
1183  *
1184  *      g v i = -h(p) + g stride f(alpha)
1185  *
1186  *      a g v i = -a h(p) + g stride f(alpha)
1187  *
1188  *      a g v i + b g stride i = -a h(p) + g stride * (...)
1189  *
1190  *      g i = -a h(p) + g stride * (...)
1191  *
1192  *      i = -a h(p)/g + stride * (...)
1193  *
1194  * The expression "-a h(p)/g" can therefore be used as offset.
1195  */
1196 static int detect_stride(__isl_take isl_constraint *c, void *user)
1197 {
1198         struct isl_detect_stride_data *data = user;
1199         int i, n_div;
1200         isl_int v, gcd, stride, a, b, m;
1201
1202         if (!isl_constraint_is_equality(c) ||
1203             !isl_constraint_involves_dims(c, isl_dim_set, data->pos, 1)) {
1204                 isl_constraint_free(c);
1205                 return 0;
1206         }
1207
1208         isl_int_init(a);
1209         isl_int_init(b);
1210         isl_int_init(v);
1211         isl_int_init(m);
1212         isl_int_init(gcd);
1213         isl_int_init(stride);
1214
1215         isl_int_set_si(gcd, 0);
1216         n_div = isl_constraint_dim(c, isl_dim_div);
1217         for (i = 0; i < n_div; ++i) {
1218                 isl_constraint_get_coefficient(c, isl_dim_div, i, &v);
1219                 isl_int_gcd(gcd, gcd, v);
1220         }
1221
1222         isl_constraint_get_coefficient(c, isl_dim_set, data->pos, &v);
1223         isl_int_gcd(m, v, gcd);
1224         isl_int_divexact(stride, gcd, m);
1225         isl_int_divexact(v, v, m);
1226
1227         if (!isl_int_is_zero(stride) && !isl_int_is_one(stride)) {
1228                 isl_aff *aff;
1229
1230                 isl_int_gcdext(gcd, a, b, v, stride);
1231
1232                 aff = isl_constraint_get_aff(c);
1233                 for (i = 0; i < n_div; ++i)
1234                         aff = isl_aff_set_coefficient_si(aff,
1235                                                          isl_dim_div, i, 0);
1236                 aff = isl_aff_set_coefficient_si(aff, isl_dim_in, data->pos, 0);
1237                 isl_int_neg(a, a);
1238                 aff = isl_aff_scale(aff, a);
1239                 aff = isl_aff_scale_down(aff, m);
1240                 data->build = set_stride(data->build, stride, aff);
1241         }
1242
1243         isl_int_clear(stride);
1244         isl_int_clear(gcd);
1245         isl_int_clear(m);
1246         isl_int_clear(v);
1247         isl_int_clear(b);
1248         isl_int_clear(a);
1249
1250         isl_constraint_free(c);
1251         return 0;
1252 }
1253
1254 /* Check if the constraints in "set" imply any stride on the current
1255  * dimension and, if so, record the stride information in "build"
1256  * and return the updated "build".
1257  *
1258  * We compute the affine hull and then check if any of the constraints
1259  * in the hull imposes any stride on the current dimension.
1260  *
1261  * We assume that inner dimensions have been eliminated from "set"
1262  * by the caller.  This is needed because the common stride
1263  * may be imposed by different inner dimensions on different parts of
1264  * the domain.
1265  */
1266 __isl_give isl_ast_build *isl_ast_build_detect_strides(
1267         __isl_take isl_ast_build *build, __isl_take isl_set *set)
1268 {
1269         isl_basic_set *hull;
1270         struct isl_detect_stride_data data;
1271
1272         if (!build)
1273                 goto error;
1274
1275         data.build = build;
1276         data.pos = isl_ast_build_get_depth(build);
1277         hull = isl_set_affine_hull(set);
1278
1279         if (isl_basic_set_foreach_constraint(hull, &detect_stride, &data) < 0)
1280                 data.build = isl_ast_build_free(data.build);
1281
1282         isl_basic_set_free(hull);
1283         return data.build;
1284 error:
1285         isl_set_free(set);
1286         return NULL;
1287 }
1288
1289 struct isl_ast_build_involves_data {
1290         int depth;
1291         int involves;
1292 };
1293
1294 /* Check if "map" involves the input dimension data->depth.
1295  */
1296 static int involves_depth(__isl_take isl_map *map, void *user)
1297 {
1298         struct isl_ast_build_involves_data *data = user;
1299
1300         data->involves = isl_map_involves_dims(map, isl_dim_in, data->depth, 1);
1301         isl_map_free(map);
1302
1303         if (data->involves < 0 || data->involves)
1304                 return -1;
1305         return 0;
1306 }
1307
1308 /* Do any options depend on the value of the dimension at the current depth?
1309  */
1310 int isl_ast_build_options_involve_depth(__isl_keep isl_ast_build *build)
1311 {
1312         struct isl_ast_build_involves_data data;
1313
1314         if (!build)
1315                 return -1;
1316
1317         data.depth = build->depth;
1318         data.involves = 0;
1319
1320         if (isl_union_map_foreach_map(build->options,
1321                                         &involves_depth, &data) < 0) {
1322                 if (data.involves < 0 || !data.involves)
1323                         return -1;
1324         }
1325
1326         return data.involves;
1327 }
1328
1329 /* Construct the map
1330  *
1331  *      { [i] -> [i] : i < pos; [i] -> [i + 1] : i >= pos }
1332  *
1333  * with "space" the parameter space of the constructed map.
1334  */
1335 static __isl_give isl_map *construct_insertion_map(__isl_take isl_space *space,
1336         int pos)
1337 {
1338         isl_constraint *c;
1339         isl_basic_map *bmap1, *bmap2;
1340
1341         space = isl_space_set_from_params(space);
1342         space = isl_space_add_dims(space, isl_dim_set, 1);
1343         space = isl_space_map_from_set(space);
1344         c = isl_equality_alloc(isl_local_space_from_space(space));
1345         c = isl_constraint_set_coefficient_si(c, isl_dim_in, 0, 1);
1346         c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, -1);
1347         bmap1 = isl_basic_map_from_constraint(isl_constraint_copy(c));
1348         c = isl_constraint_set_constant_si(c, 1);
1349         bmap2 = isl_basic_map_from_constraint(c);
1350
1351         bmap1 = isl_basic_map_upper_bound_si(bmap1, isl_dim_in, 0, pos - 1);
1352         bmap2 = isl_basic_map_lower_bound_si(bmap2, isl_dim_in, 0, pos);
1353
1354         return isl_basic_map_union(bmap1, bmap2);
1355 }
1356
1357 static const char *option_str[] = {
1358         [atomic] = "atomic",
1359         [unroll] = "unroll",
1360         [separate] = "separate"
1361 };
1362
1363 /* Update the "options" to reflect the insertion of a dimension
1364  * at position "pos" in the schedule domain space.
1365  * "space" is the original domain space before the insertion and
1366  * may be named and/or structured.
1367  *
1368  * The (relevant) input options all have "space" as domain, which
1369  * has to be mapped to the extended space.
1370  * The values of the ranges also refer to the schedule domain positions
1371  * and they therefore also need to be adjusted.  In particular, values
1372  * smaller than pos do not need to change, while values greater than or
1373  * equal to pos need to be incremented.
1374  * That is, we need to apply the following map.
1375  *
1376  *      { atomic[i] -> atomic[i] : i < pos; [i] -> [i + 1] : i >= pos;
1377  *        unroll[i] -> unroll[i] : i < pos; [i] -> [i + 1] : i >= pos;
1378  *        separate[i] -> separate[i] : i < pos; [i] -> [i + 1] : i >= pos;
1379  *        separation_class[[i] -> [c]]
1380  *              -> separation_class[[i] -> [c]] : i < pos;
1381  *        separation_class[[i] -> [c]]
1382  *              -> separation_class[[i + 1] -> [c]] : i >= pos }
1383  */
1384 static __isl_give isl_union_map *options_insert_dim(
1385         __isl_take isl_union_map *options, __isl_take isl_space *space, int pos)
1386 {
1387         isl_map *map;
1388         isl_union_map *insertion;
1389         enum isl_ast_build_domain_type type;
1390         const char *name = "separation_class";
1391
1392         space = isl_space_map_from_set(space);
1393         map = isl_map_identity(space);
1394         map = isl_map_insert_dims(map, isl_dim_out, pos, 1);
1395         options = isl_union_map_apply_domain(options,
1396                                                 isl_union_map_from_map(map));
1397
1398         if (!options)
1399                 return NULL;
1400
1401         map = construct_insertion_map(isl_union_map_get_space(options), pos);
1402
1403         insertion = isl_union_map_empty(isl_union_map_get_space(options));
1404
1405         for (type = atomic; type <= separate; ++type) {
1406                 isl_map *map_type = isl_map_copy(map);
1407                 const char *name = option_str[type];
1408                 map_type = isl_map_set_tuple_name(map_type, isl_dim_in, name);
1409                 map_type = isl_map_set_tuple_name(map_type, isl_dim_out, name);
1410                 insertion = isl_union_map_add_map(insertion, map_type);
1411         }
1412
1413         map = isl_map_product(map, isl_map_identity(isl_map_get_space(map)));
1414         map = isl_map_set_tuple_name(map, isl_dim_in, name);
1415         map = isl_map_set_tuple_name(map, isl_dim_out, name);
1416         insertion = isl_union_map_add_map(insertion, map);
1417
1418         options = isl_union_map_apply_range(options, insertion);
1419
1420         return options;
1421 }
1422
1423 /* Insert a single dimension in the schedule domain at position "pos".
1424  * The new dimension is given an isl_id with the empty string as name.
1425  *
1426  * The main difficulty is updating build->options to reflect the
1427  * extra dimension.  This is handled in options_insert_dim.
1428  *
1429  * Note that because of the dimension manipulations, the resulting
1430  * schedule domain space will always be unnamed and unstructured.
1431  * However, the original schedule domain space may be named and/or
1432  * structured, so we have to take this possibility into account
1433  * while performing the transformations.
1434  */
1435 __isl_give isl_ast_build *isl_ast_build_insert_dim(
1436         __isl_take isl_ast_build *build, int pos)
1437 {
1438         isl_ctx *ctx;
1439         isl_space *space, *ma_space;
1440         isl_id *id;
1441         isl_multi_aff *ma;
1442
1443         build = isl_ast_build_cow(build);
1444         if (!build)
1445                 return NULL;
1446
1447         ctx = isl_ast_build_get_ctx(build);
1448         id = isl_id_alloc(ctx, "", NULL);
1449         space = isl_ast_build_get_space(build, 1);
1450         build->iterators = isl_id_list_insert(build->iterators, pos, id);
1451         build->domain = isl_set_insert_dims(build->domain,
1452                                                 isl_dim_set, pos, 1);
1453         build->generated = isl_set_insert_dims(build->generated,
1454                                                 isl_dim_set, pos, 1);
1455         build->pending = isl_set_insert_dims(build->pending,
1456                                                 isl_dim_set, pos, 1);
1457         build->strides = isl_vec_insert_els(build->strides, pos, 1);
1458         build->strides = isl_vec_set_element_si(build->strides, pos, 1);
1459         ma_space = isl_space_params(isl_multi_aff_get_space(build->offsets));
1460         ma_space = isl_space_set_from_params(ma_space);
1461         ma_space = isl_space_add_dims(ma_space, isl_dim_set, 1);
1462         ma_space = isl_space_map_from_set(ma_space);
1463         ma = isl_multi_aff_zero(isl_space_copy(ma_space));
1464         build->offsets = isl_multi_aff_splice(build->offsets, pos, pos, ma);
1465         ma = isl_multi_aff_identity(ma_space);
1466         build->values = isl_multi_aff_splice(build->values, pos, pos, ma);
1467         build->options = options_insert_dim(build->options, space, pos);
1468
1469         if (!build->iterators || !build->domain || !build->generated ||
1470             !build->pending || !build->values ||
1471             !build->strides || !build->offsets || !build->options)
1472                 return isl_ast_build_free(build);
1473
1474         return build;
1475 }
1476
1477 /* Scale down the current dimension by a factor of "m".
1478  * "umap" is an isl_union_map that implements the scaling down.
1479  * That is, it is of the form
1480  *
1481  *      { [.... i ....] -> [.... i' ....] : i = m i' }
1482  *
1483  * This function is called right after the strides have been
1484  * detected, but before any constraints on the current dimension
1485  * have been included in build->domain.
1486  * We therefore only need to update stride, offset and the options.
1487  */
1488 __isl_give isl_ast_build *isl_ast_build_scale_down(
1489         __isl_take isl_ast_build *build, isl_int m,
1490         __isl_take isl_union_map *umap)
1491 {
1492         isl_aff *aff;
1493         isl_int v;
1494         int depth;
1495
1496         build = isl_ast_build_cow(build);
1497         if (!build || !umap)
1498                 goto error;
1499
1500         depth = build->depth;
1501
1502         isl_int_init(v);
1503         if (isl_vec_get_element(build->strides, depth, &v) < 0)
1504                 build->strides = isl_vec_free(build->strides);
1505         isl_int_divexact(v, v, m);
1506         build->strides = isl_vec_set_element(build->strides, depth, v);
1507         isl_int_clear(v);
1508
1509         aff = isl_multi_aff_get_aff(build->offsets, depth);
1510         aff = isl_aff_scale_down(aff, m);
1511         build->offsets = isl_multi_aff_set_aff(build->offsets, depth, aff);
1512         build->options = isl_union_map_apply_domain(build->options, umap);
1513         if (!build->strides || !build->offsets || !build->options)
1514                 return isl_ast_build_free(build);
1515
1516         return build;
1517 error:
1518         isl_union_map_free(umap);
1519         return isl_ast_build_free(build);
1520 }
1521
1522 /* Return a list of "n" isl_ids called "c%d", with "%d" starting at "first".
1523  * If an isl_id with such a name already appears among the parameters
1524  * in build->domain, then adjust the name to "c%d_%d".
1525  */
1526 static __isl_give isl_id_list *generate_names(isl_ctx *ctx, int n, int first,
1527         __isl_keep isl_ast_build *build)
1528 {
1529         int i;
1530         isl_id_list *names;
1531
1532         names = isl_id_list_alloc(ctx, n);
1533         for (i = 0; i < n; ++i) {
1534                 isl_id *id;
1535
1536                 id = generate_name(ctx, first + i, build);
1537                 names = isl_id_list_add(names, id);
1538         }
1539
1540         return names;
1541 }
1542
1543 /* Embed "options" into the given isl_ast_build space.
1544  *
1545  * This function is called from within a nested call to
1546  * isl_ast_build_ast_from_schedule.
1547  * "options" refers to the additional schedule,
1548  * while space refers to both the space of the outer isl_ast_build and
1549  * that of the additional schedule.
1550  * Specifically, space is of the form
1551  *
1552  *      [I -> S]
1553  *
1554  * while options lives in the space(s)
1555  *
1556  *      S -> *
1557  *
1558  * We compute
1559  *
1560  *      [I -> S] -> S
1561  *
1562  * and compose this with options, to obtain the new options
1563  * living in the space(s)
1564  *
1565  *      [I -> S] -> *
1566  */
1567 static __isl_give isl_union_map *embed_options(
1568         __isl_take isl_union_map *options, __isl_take isl_space *space)
1569 {
1570         isl_map *map;
1571
1572         map = isl_map_universe(isl_space_unwrap(space));
1573         map = isl_map_range_map(map);
1574
1575         options = isl_union_map_apply_range(
1576                                 isl_union_map_from_map(map), options);
1577
1578         return options;
1579 }
1580
1581 /* Update "build" for use in a (possibly nested) code generation.  That is,
1582  * extend "build" from an AST build on some domain O to an AST build
1583  * on domain [O -> S], with S corresponding to "space".
1584  * If the original domain is a parameter domain, then the new domain is
1585  * simply S.
1586  * "iterators" is a list of iterators for S, but the number of elements
1587  * may be smaller or greater than the number of set dimensions of S.
1588  * If "keep_iterators" is set, then any extra ids in build->iterators
1589  * are reused for S.  Otherwise, these extra ids are dropped.
1590  *
1591  * We first update build->outer_pos to the current depth.
1592  * This depth is zero in case this is the outermost code generation.
1593  *
1594  * We then add additional ids such that the number of iterators is at least
1595  * equal to the dimension of the new build domain.
1596  *
1597  * If the original domain is parametric, then we are constructing
1598  * an isl_ast_build for the outer code generation and we pass control
1599  * to isl_ast_build_init.
1600  *
1601  * Otherwise, we adjust the fields of "build" to include "space".
1602  */
1603 __isl_give isl_ast_build *isl_ast_build_product(
1604         __isl_take isl_ast_build *build, __isl_take isl_space *space)
1605 {
1606         isl_ctx *ctx;
1607         isl_vec *strides;
1608         isl_set *set;
1609         isl_multi_aff *embedding;
1610         int dim, n_it;
1611
1612         build = isl_ast_build_cow(build);
1613         if (!build)
1614                 goto error;
1615
1616         build->outer_pos = build->depth;
1617
1618         ctx = isl_ast_build_get_ctx(build);
1619         dim = isl_set_dim(build->domain, isl_dim_set);
1620         dim += isl_space_dim(space, isl_dim_set);
1621         n_it = isl_id_list_n_id(build->iterators);
1622         if (n_it < dim) {
1623                 isl_id_list *l;
1624                 l = generate_names(ctx, dim - n_it, n_it, build);
1625                 build->iterators = isl_id_list_concat(build->iterators, l);
1626         }
1627
1628         if (isl_set_is_params(build->domain))
1629                 return isl_ast_build_init(build, space);
1630
1631         set = isl_set_universe(isl_space_copy(space));
1632         build->domain = isl_set_product(build->domain, isl_set_copy(set));
1633         build->pending = isl_set_product(build->pending, isl_set_copy(set));
1634         build->generated = isl_set_product(build->generated, set);
1635
1636         strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
1637         strides = isl_vec_set_si(strides, 1);
1638         build->strides = isl_vec_concat(build->strides, strides);
1639
1640         space = isl_space_map_from_set(space);
1641         build->offsets = isl_multi_aff_align_params(build->offsets,
1642                                                     isl_space_copy(space));
1643         build->offsets = isl_multi_aff_product(build->offsets,
1644                                 isl_multi_aff_zero(isl_space_copy(space)));
1645         build->values = isl_multi_aff_align_params(build->values,
1646                                                     isl_space_copy(space));
1647         embedding = isl_multi_aff_identity(space);
1648         build->values = isl_multi_aff_product(build->values, embedding);
1649
1650         space = isl_ast_build_get_space(build, 1);
1651         build->options = embed_options(build->options, space);
1652
1653         if (!build->iterators || !build->domain || !build->generated ||
1654             !build->pending || !build->values ||
1655             !build->strides || !build->offsets || !build->options)
1656                 return isl_ast_build_free(build);
1657
1658         return build;
1659 error:
1660         isl_ast_build_free(build);
1661         isl_space_free(space);
1662         return NULL;
1663 }
1664
1665 /* Does "aff" only attain non-negative values over build->domain?
1666  * That is, does it not attain any negative values?
1667  */
1668 int isl_ast_build_aff_is_nonneg(__isl_keep isl_ast_build *build,
1669         __isl_keep isl_aff *aff)
1670 {
1671         isl_set *test;
1672         int empty;
1673
1674         if (!build)
1675                 return -1;
1676
1677         aff = isl_aff_copy(aff);
1678         test = isl_set_from_basic_set(isl_aff_neg_basic_set(aff));
1679         test = isl_set_intersect(test, isl_set_copy(build->domain));
1680         empty = isl_set_is_empty(test);
1681         isl_set_free(test);
1682
1683         return empty;
1684 }
1685
1686 /* Does the dimension at (internal) position "pos" have a non-trivial stride?
1687  */
1688 int isl_ast_build_has_stride(__isl_keep isl_ast_build *build, int pos)
1689 {
1690         isl_int v;
1691         int has_stride;
1692
1693         if (!build)
1694                 return -1;
1695
1696         isl_int_init(v);
1697         isl_vec_get_element(build->strides, pos, &v);
1698         has_stride = !isl_int_is_one(v);
1699         isl_int_clear(v);
1700
1701         return has_stride;
1702 }
1703
1704 /* Given that the dimension at position "pos" takes on values
1705  *
1706  *      f + s a
1707  *
1708  * with a an integer, return s through *stride.
1709  */
1710 int isl_ast_build_get_stride(__isl_keep isl_ast_build *build, int pos,
1711         isl_int *stride)
1712 {
1713         if (!build)
1714                 return -1;
1715
1716         isl_vec_get_element(build->strides, pos, stride);
1717
1718         return 0;
1719 }
1720
1721 /* Given that the dimension at position "pos" takes on values
1722  *
1723  *      f + s a
1724  *
1725  * with a an integer, return f.
1726  */
1727 __isl_give isl_aff *isl_ast_build_get_offset(
1728         __isl_keep isl_ast_build *build, int pos)
1729 {
1730         if (!build)
1731                 return NULL;
1732
1733         return isl_multi_aff_get_aff(build->offsets, pos);
1734 }
1735
1736 /* Is the dimension at position "pos" known to attain only a single
1737  * value that, moreover, can be described by a single affine expression
1738  * in terms of the outer dimensions and parameters?
1739  *
1740  * If not, then the correponding affine expression in build->values
1741  * is set to be equal to the same input dimension.
1742  * Otherwise, it is set to the requested expression in terms of
1743  * outer dimensions and parameters.
1744  */
1745 int isl_ast_build_has_affine_value(__isl_keep isl_ast_build *build,
1746         int pos)
1747 {
1748         isl_aff *aff;
1749         int involves;
1750
1751         if (!build)
1752                 return -1;
1753
1754         aff = isl_multi_aff_get_aff(build->values, pos);
1755         involves = isl_aff_involves_dims(aff, isl_dim_in, pos, 1);
1756         isl_aff_free(aff);
1757
1758         if (involves < 0)
1759                 return -1;
1760
1761         return !involves;
1762 }
1763
1764 /* Plug in the known values (fixed affine expressions in terms of
1765  * parameters and outer loop iterators) of all loop iterators
1766  * in the domain of "umap".
1767  *
1768  * We simply precompose "umap" with build->values.
1769  */
1770 __isl_give isl_union_map *isl_ast_build_substitute_values_union_map_domain(
1771         __isl_keep isl_ast_build *build, __isl_take isl_union_map *umap)
1772 {
1773         isl_multi_aff *values;
1774
1775         if (!build)
1776                 return isl_union_map_free(umap);
1777
1778         values = isl_multi_aff_copy(build->values);
1779         umap = isl_union_map_preimage_domain_multi_aff(umap, values);
1780
1781         return umap;
1782 }
1783
1784 /* Is the current dimension known to attain only a single value?
1785  */
1786 int isl_ast_build_has_value(__isl_keep isl_ast_build *build)
1787 {
1788         if (!build)
1789                 return -1;
1790
1791         return build->value != NULL;
1792 }
1793
1794 /* Simplify the basic set "bset" based on what we know about
1795  * the iterators of already generated loops.
1796  *
1797  * "bset" is assumed to live in the (internal) schedule domain.
1798  */
1799 __isl_give isl_basic_set *isl_ast_build_compute_gist_basic_set(
1800         __isl_keep isl_ast_build *build, __isl_take isl_basic_set *bset)
1801 {
1802         if (!build)
1803                 goto error;
1804
1805         bset = isl_basic_set_preimage_multi_aff(bset,
1806                                         isl_multi_aff_copy(build->values));
1807         bset = isl_basic_set_gist(bset,
1808                         isl_set_simple_hull(isl_set_copy(build->domain)));
1809
1810         return bset;
1811 error:
1812         isl_basic_set_free(bset);
1813         return NULL;
1814 }
1815
1816 /* Simplify the set "set" based on what we know about
1817  * the iterators of already generated loops.
1818  *
1819  * "set" is assumed to live in the (internal) schedule domain.
1820  */
1821 __isl_give isl_set *isl_ast_build_compute_gist(
1822         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
1823 {
1824         if (!build)
1825                 goto error;
1826
1827         set = isl_set_preimage_multi_aff(set,
1828                                         isl_multi_aff_copy(build->values));
1829         set = isl_set_gist(set, isl_set_copy(build->domain));
1830
1831         return set;
1832 error:
1833         isl_set_free(set);
1834         return NULL;
1835 }
1836
1837 /* Simplify the map "map" based on what we know about
1838  * the iterators of already generated loops.
1839  *
1840  * The domain of "map" is assumed to live in the (internal) schedule domain.
1841  */
1842 __isl_give isl_map *isl_ast_build_compute_gist_map_domain(
1843         __isl_keep isl_ast_build *build, __isl_take isl_map *map)
1844 {
1845         if (!build)
1846                 goto error;
1847
1848         map = isl_map_gist_domain(map, isl_set_copy(build->domain));
1849
1850         return map;
1851 error:
1852         isl_map_free(map);
1853         return NULL;
1854 }
1855
1856 /* Simplify the affine expression "aff" based on what we know about
1857  * the iterators of already generated loops.
1858  *
1859  * The domain of "aff" is assumed to live in the (internal) schedule domain.
1860  */
1861 __isl_give isl_aff *isl_ast_build_compute_gist_aff(
1862         __isl_keep isl_ast_build *build, __isl_take isl_aff *aff)
1863 {
1864         if (!build)
1865                 goto error;
1866
1867         aff = isl_aff_gist(aff, isl_set_copy(build->domain));
1868
1869         return aff;
1870 error:
1871         isl_aff_free(aff);
1872         return NULL;
1873 }
1874
1875 /* Simplify the piecewise affine expression "aff" based on what we know about
1876  * the iterators of already generated loops.
1877  *
1878  * The domain of "pa" is assumed to live in the (internal) schedule domain.
1879  */
1880 __isl_give isl_pw_aff *isl_ast_build_compute_gist_pw_aff(
1881         __isl_keep isl_ast_build *build, __isl_take isl_pw_aff *pa)
1882 {
1883         if (!build)
1884                 goto error;
1885
1886         pa = isl_pw_aff_pullback_multi_aff(pa,
1887                                         isl_multi_aff_copy(build->values));
1888         pa = isl_pw_aff_gist(pa, isl_set_copy(build->domain));
1889
1890         return pa;
1891 error:
1892         isl_pw_aff_free(pa);
1893         return NULL;
1894 }
1895
1896 /* Simplify the piecewise multi-affine expression "aff" based on what
1897  * we know about the iterators of already generated loops.
1898  *
1899  * The domain of "pma" is assumed to live in the (internal) schedule domain.
1900  */
1901 __isl_give isl_pw_multi_aff *isl_ast_build_compute_gist_pw_multi_aff(
1902         __isl_keep isl_ast_build *build, __isl_take isl_pw_multi_aff *pma)
1903 {
1904         if (!build)
1905                 goto error;
1906
1907         pma = isl_pw_multi_aff_pullback_multi_aff(pma,
1908                                         isl_multi_aff_copy(build->values));
1909         pma = isl_pw_multi_aff_gist(pma, isl_set_copy(build->domain));
1910
1911         return pma;
1912 error:
1913         isl_pw_multi_aff_free(pma);
1914         return NULL;
1915 }
1916
1917 /* Extract the schedule domain of the given type from build->options
1918  * at the current depth.
1919  *
1920  * In particular, find the subset of build->options that is of
1921  * the following form
1922  *
1923  *      schedule_domain -> type[depth]
1924  *
1925  * and return the corresponding domain, after eliminating inner dimensions
1926  * and divs that depend on the current dimension.
1927  *
1928  * Note that the domain of build->options has been reformulated
1929  * in terms of the internal build space in embed_options,
1930  * but the position is still that within the current code generation.
1931  */
1932 __isl_give isl_set *isl_ast_build_get_option_domain(
1933         __isl_keep isl_ast_build *build,
1934         enum isl_ast_build_domain_type type)
1935 {
1936         const char *name;
1937         isl_space *space;
1938         isl_map *option;
1939         isl_set *domain;
1940         int local_pos;
1941
1942         if (!build)
1943                 return NULL;
1944
1945         name = option_str[type];
1946         local_pos = build->depth - build->outer_pos;
1947
1948         space = isl_ast_build_get_space(build, 1);
1949         space = isl_space_from_domain(space);
1950         space = isl_space_add_dims(space, isl_dim_out, 1);
1951         space = isl_space_set_tuple_name(space, isl_dim_out, name);
1952
1953         option = isl_union_map_extract_map(build->options, space);
1954         option = isl_map_fix_si(option, isl_dim_out, 0, local_pos);
1955
1956         domain = isl_map_domain(option);
1957         domain = isl_ast_build_eliminate(build, domain);
1958
1959         return domain;
1960 }
1961
1962 /* Extract the separation class mapping at the current depth.
1963  *
1964  * In particular, find and return the subset of build->options that is of
1965  * the following form
1966  *
1967  *      schedule_domain -> separation_class[[depth] -> [class]]
1968  *
1969  * The caller is expected to eliminate inner dimensions from the domain.
1970  *
1971  * Note that the domain of build->options has been reformulated
1972  * in terms of the internal build space in embed_options,
1973  * but the position is still that within the current code generation.
1974  */
1975 __isl_give isl_map *isl_ast_build_get_separation_class(
1976         __isl_keep isl_ast_build *build)
1977 {
1978         isl_ctx *ctx;
1979         isl_space *space_sep, *space;
1980         isl_map *res;
1981         int local_pos;
1982
1983         if (!build)
1984                 return NULL;
1985
1986         local_pos = build->depth - build->outer_pos;
1987         ctx = isl_ast_build_get_ctx(build);
1988         space_sep = isl_space_alloc(ctx, 0, 1, 1);
1989         space_sep = isl_space_wrap(space_sep);
1990         space_sep = isl_space_set_tuple_name(space_sep, isl_dim_set,
1991                                                 "separation_class");
1992         space = isl_ast_build_get_space(build, 1);
1993         space_sep = isl_space_align_params(space_sep, isl_space_copy(space));
1994         space = isl_space_map_from_domain_and_range(space, space_sep);
1995
1996         res = isl_union_map_extract_map(build->options, space);
1997         res = isl_map_fix_si(res, isl_dim_out, 0, local_pos);
1998         res = isl_map_coalesce(res);
1999
2000         return res;
2001 }
2002
2003 /* Eliminate dimensions inner to the current dimension.
2004  */
2005 __isl_give isl_set *isl_ast_build_eliminate_inner(
2006         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2007 {
2008         int dim;
2009         int depth;
2010
2011         if (!build)
2012                 return isl_set_free(set);
2013
2014         dim = isl_set_dim(set, isl_dim_set);
2015         depth = build->depth;
2016         set = isl_set_detect_equalities(set);
2017         set = isl_set_eliminate(set, isl_dim_set, depth + 1, dim - (depth + 1));
2018
2019         return set;
2020 }
2021
2022 /* Eliminate unknown divs and divs that depend on the current dimension.
2023  *
2024  * Note that during the elimination of unknown divs, we may discover
2025  * an explicit representation of some other unknown divs, which may
2026  * depend on the current dimension.  We therefore need to eliminate
2027  * unknown divs first.
2028  */
2029 __isl_give isl_set *isl_ast_build_eliminate_divs(
2030         __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2031 {
2032         int depth;
2033
2034         if (!build)
2035                 return isl_set_free(set);
2036
2037         set = isl_set_remove_unknown_divs(set);
2038         depth = build->depth;
2039         set = isl_set_remove_divs_involving_dims(set, isl_dim_set, depth, 1);
2040
2041         return set;
2042 }
2043
2044 /* Eliminate dimensions inner to the current dimension as well as
2045  * unknown divs and divs that depend on the current dimension.
2046  * The result then consists only of constraints that are independent
2047  * of the current dimension and upper and lower bounds on the current
2048  * dimension.
2049  */
2050 __isl_give isl_set *isl_ast_build_eliminate(
2051         __isl_keep isl_ast_build *build, __isl_take isl_set *domain)
2052 {
2053         domain = isl_ast_build_eliminate_inner(build, domain);
2054         domain = isl_ast_build_eliminate_divs(build, domain);
2055         return domain;
2056 }
2057
2058 /* Replace build->single_valued by "sv".
2059  */
2060 __isl_give isl_ast_build *isl_ast_build_set_single_valued(
2061         __isl_take isl_ast_build *build, int sv)
2062 {
2063         if (!build)
2064                 return build;
2065         if (build->single_valued == sv)
2066                 return build;
2067         build = isl_ast_build_cow(build);
2068         if (!build)
2069                 return build;
2070         build->single_valued = sv;
2071
2072         return build;
2073 }