isl_mat_rank: return isl_size
[isl.git] / isl_scheduler.c
blob6b85bd7061234a51e08e00588b05a937deebd792
1 /*
2 * Copyright 2011 INRIA Saclay
3 * Copyright 2012-2014 Ecole Normale Superieure
4 * Copyright 2015-2016 Sven Verdoolaege
5 * Copyright 2016 INRIA Paris
6 * Copyright 2017 Sven Verdoolaege
8 * Use of this software is governed by the MIT license
10 * Written by Sven Verdoolaege, INRIA Saclay - Ile-de-France,
11 * Parc Club Orsay Universite, ZAC des vignes, 4 rue Jacques Monod,
12 * 91893 Orsay, France
13 * and Ecole Normale Superieure, 45 rue d'Ulm, 75230 Paris, France
14 * and Centre de Recherche Inria de Paris, 2 rue Simone Iff - Voie DQ12,
15 * CS 42112, 75589 Paris Cedex 12, France
18 #include <isl_ctx_private.h>
19 #include <isl_map_private.h>
20 #include <isl_space_private.h>
21 #include <isl_aff_private.h>
22 #include <isl/hash.h>
23 #include <isl/id.h>
24 #include <isl/constraint.h>
25 #include <isl/schedule.h>
26 #include <isl_schedule_constraints.h>
27 #include <isl/schedule_node.h>
28 #include <isl_mat_private.h>
29 #include <isl_vec_private.h>
30 #include <isl/set.h>
31 #include <isl_union_set_private.h>
32 #include <isl_seq.h>
33 #include <isl_tab.h>
34 #include <isl_dim_map.h>
35 #include <isl/map_to_basic_set.h>
36 #include <isl_sort.h>
37 #include <isl_options_private.h>
38 #include <isl_tarjan.h>
39 #include <isl_morph.h>
40 #include <isl/ilp.h>
41 #include <isl_val_private.h>
44 * The scheduling algorithm implemented in this file was inspired by
45 * Bondhugula et al., "Automatic Transformations for Communication-Minimized
46 * Parallelization and Locality Optimization in the Polyhedral Model".
48 * For a detailed description of the variant implemented in isl,
49 * see Verdoolaege and Janssens, "Scheduling for PPCG" (2017).
53 /* Internal information about a node that is used during the construction
54 * of a schedule.
55 * space represents the original space in which the domain lives;
56 * that is, the space is not affected by compression
57 * sched is a matrix representation of the schedule being constructed
58 * for this node; if compressed is set, then this schedule is
59 * defined over the compressed domain space
60 * sched_map is an isl_map representation of the same (partial) schedule
61 * sched_map may be NULL; if compressed is set, then this map
62 * is defined over the uncompressed domain space
63 * rank is the number of linearly independent rows in the linear part
64 * of sched
65 * the rows of "vmap" represent a change of basis for the node
66 * variables; the first rank rows span the linear part of
67 * the schedule rows; the remaining rows are linearly independent
68 * the rows of "indep" represent linear combinations of the schedule
69 * coefficients that are non-zero when the schedule coefficients are
70 * linearly independent of previously computed schedule rows.
71 * start is the first variable in the LP problem in the sequences that
72 * represents the schedule coefficients of this node
73 * nvar is the dimension of the (compressed) domain
74 * nparam is the number of parameters or 0 if we are not constructing
75 * a parametric schedule
77 * If compressed is set, then hull represents the constraints
78 * that were used to derive the compression, while compress and
79 * decompress map the original space to the compressed space and
80 * vice versa.
82 * scc is the index of SCC (or WCC) this node belongs to
84 * "cluster" is only used inside extract_clusters and identifies
85 * the cluster of SCCs that the node belongs to.
87 * coincident contains a boolean for each of the rows of the schedule,
88 * indicating whether the corresponding scheduling dimension satisfies
89 * the coincidence constraints in the sense that the corresponding
90 * dependence distances are zero.
92 * If the schedule_treat_coalescing option is set, then
93 * "sizes" contains the sizes of the (compressed) instance set
94 * in each direction. If there is no fixed size in a given direction,
95 * then the corresponding size value is set to infinity.
96 * If the schedule_treat_coalescing option or the schedule_max_coefficient
97 * option is set, then "max" contains the maximal values for
98 * schedule coefficients of the (compressed) variables. If no bound
99 * needs to be imposed on a particular variable, then the corresponding
100 * value is negative.
101 * If not NULL, then "bounds" contains a non-parametric set
102 * in the compressed space that is bounded by the size in each direction.
104 struct isl_sched_node {
105 isl_space *space;
106 int compressed;
107 isl_set *hull;
108 isl_multi_aff *compress;
109 isl_multi_aff *decompress;
110 isl_mat *sched;
111 isl_map *sched_map;
112 int rank;
113 isl_mat *indep;
114 isl_mat *vmap;
115 int start;
116 int nvar;
117 int nparam;
119 int scc;
120 int cluster;
122 int *coincident;
124 isl_multi_val *sizes;
125 isl_basic_set *bounds;
126 isl_vec *max;
129 static int node_has_tuples(const void *entry, const void *val)
131 struct isl_sched_node *node = (struct isl_sched_node *)entry;
132 isl_space *space = (isl_space *) val;
134 return isl_space_has_equal_tuples(node->space, space);
137 static int node_scc_exactly(struct isl_sched_node *node, int scc)
139 return node->scc == scc;
142 static int node_scc_at_most(struct isl_sched_node *node, int scc)
144 return node->scc <= scc;
147 static int node_scc_at_least(struct isl_sched_node *node, int scc)
149 return node->scc >= scc;
152 /* An edge in the dependence graph. An edge may be used to
153 * ensure validity of the generated schedule, to minimize the dependence
154 * distance or both
156 * map is the dependence relation, with i -> j in the map if j depends on i
157 * tagged_condition and tagged_validity contain the union of all tagged
158 * condition or conditional validity dependence relations that
159 * specialize the dependence relation "map"; that is,
160 * if (i -> a) -> (j -> b) is an element of "tagged_condition"
161 * or "tagged_validity", then i -> j is an element of "map".
162 * If these fields are NULL, then they represent the empty relation.
163 * src is the source node
164 * dst is the sink node
166 * types is a bit vector containing the types of this edge.
167 * validity is set if the edge is used to ensure correctness
168 * coincidence is used to enforce zero dependence distances
169 * proximity is set if the edge is used to minimize dependence distances
170 * condition is set if the edge represents a condition
171 * for a conditional validity schedule constraint
172 * local can only be set for condition edges and indicates that
173 * the dependence distance over the edge should be zero
174 * conditional_validity is set if the edge is used to conditionally
175 * ensure correctness
177 * For validity edges, start and end mark the sequence of inequality
178 * constraints in the LP problem that encode the validity constraint
179 * corresponding to this edge.
181 * During clustering, an edge may be marked "no_merge" if it should
182 * not be used to merge clusters.
183 * The weight is also only used during clustering and it is
184 * an indication of how many schedule dimensions on either side
185 * of the schedule constraints can be aligned.
186 * If the weight is negative, then this means that this edge was postponed
187 * by has_bounded_distances or any_no_merge. The original weight can
188 * be retrieved by adding 1 + graph->max_weight, with "graph"
189 * the graph containing this edge.
191 struct isl_sched_edge {
192 isl_map *map;
193 isl_union_map *tagged_condition;
194 isl_union_map *tagged_validity;
196 struct isl_sched_node *src;
197 struct isl_sched_node *dst;
199 unsigned types;
201 int start;
202 int end;
204 int no_merge;
205 int weight;
208 /* Is "edge" marked as being of type "type"?
210 static int is_type(struct isl_sched_edge *edge, enum isl_edge_type type)
212 return ISL_FL_ISSET(edge->types, 1 << type);
215 /* Mark "edge" as being of type "type".
217 static void set_type(struct isl_sched_edge *edge, enum isl_edge_type type)
219 ISL_FL_SET(edge->types, 1 << type);
222 /* No longer mark "edge" as being of type "type"?
224 static void clear_type(struct isl_sched_edge *edge, enum isl_edge_type type)
226 ISL_FL_CLR(edge->types, 1 << type);
229 /* Is "edge" marked as a validity edge?
231 static int is_validity(struct isl_sched_edge *edge)
233 return is_type(edge, isl_edge_validity);
236 /* Mark "edge" as a validity edge.
238 static void set_validity(struct isl_sched_edge *edge)
240 set_type(edge, isl_edge_validity);
243 /* Is "edge" marked as a proximity edge?
245 static int is_proximity(struct isl_sched_edge *edge)
247 return is_type(edge, isl_edge_proximity);
250 /* Is "edge" marked as a local edge?
252 static int is_local(struct isl_sched_edge *edge)
254 return is_type(edge, isl_edge_local);
257 /* Mark "edge" as a local edge.
259 static void set_local(struct isl_sched_edge *edge)
261 set_type(edge, isl_edge_local);
264 /* No longer mark "edge" as a local edge.
266 static void clear_local(struct isl_sched_edge *edge)
268 clear_type(edge, isl_edge_local);
271 /* Is "edge" marked as a coincidence edge?
273 static int is_coincidence(struct isl_sched_edge *edge)
275 return is_type(edge, isl_edge_coincidence);
278 /* Is "edge" marked as a condition edge?
280 static int is_condition(struct isl_sched_edge *edge)
282 return is_type(edge, isl_edge_condition);
285 /* Is "edge" marked as a conditional validity edge?
287 static int is_conditional_validity(struct isl_sched_edge *edge)
289 return is_type(edge, isl_edge_conditional_validity);
292 /* Is "edge" of a type that can appear multiple times between
293 * the same pair of nodes?
295 * Condition edges and conditional validity edges may have tagged
296 * dependence relations, in which case an edge is added for each
297 * pair of tags.
299 static int is_multi_edge_type(struct isl_sched_edge *edge)
301 return is_condition(edge) || is_conditional_validity(edge);
304 /* Internal information about the dependence graph used during
305 * the construction of the schedule.
307 * intra_hmap is a cache, mapping dependence relations to their dual,
308 * for dependences from a node to itself, possibly without
309 * coefficients for the parameters
310 * intra_hmap_param is a cache, mapping dependence relations to their dual,
311 * for dependences from a node to itself, including coefficients
312 * for the parameters
313 * inter_hmap is a cache, mapping dependence relations to their dual,
314 * for dependences between distinct nodes
315 * if compression is involved then the key for these maps
316 * is the original, uncompressed dependence relation, while
317 * the value is the dual of the compressed dependence relation.
319 * n is the number of nodes
320 * node is the list of nodes
321 * maxvar is the maximal number of variables over all nodes
322 * max_row is the allocated number of rows in the schedule
323 * n_row is the current (maximal) number of linearly independent
324 * rows in the node schedules
325 * n_total_row is the current number of rows in the node schedules
326 * band_start is the starting row in the node schedules of the current band
327 * root is set to the original dependence graph from which this graph
328 * is derived through splitting. If this graph is not the result of
329 * splitting, then the root field points to the graph itself.
331 * sorted contains a list of node indices sorted according to the
332 * SCC to which a node belongs
334 * n_edge is the number of edges
335 * edge is the list of edges
336 * max_edge contains the maximal number of edges of each type;
337 * in particular, it contains the number of edges in the inital graph.
338 * edge_table contains pointers into the edge array, hashed on the source
339 * and sink spaces; there is one such table for each type;
340 * a given edge may be referenced from more than one table
341 * if the corresponding relation appears in more than one of the
342 * sets of dependences; however, for each type there is only
343 * a single edge between a given pair of source and sink space
344 * in the entire graph
346 * node_table contains pointers into the node array, hashed on the space tuples
348 * region contains a list of variable sequences that should be non-trivial
350 * lp contains the (I)LP problem used to obtain new schedule rows
352 * src_scc and dst_scc are the source and sink SCCs of an edge with
353 * conflicting constraints
355 * scc represents the number of components
356 * weak is set if the components are weakly connected
358 * max_weight is used during clustering and represents the maximal
359 * weight of the relevant proximity edges.
361 struct isl_sched_graph {
362 isl_map_to_basic_set *intra_hmap;
363 isl_map_to_basic_set *intra_hmap_param;
364 isl_map_to_basic_set *inter_hmap;
366 struct isl_sched_node *node;
367 int n;
368 int maxvar;
369 int max_row;
370 int n_row;
372 int *sorted;
374 int n_total_row;
375 int band_start;
377 struct isl_sched_graph *root;
379 struct isl_sched_edge *edge;
380 int n_edge;
381 int max_edge[isl_edge_last + 1];
382 struct isl_hash_table *edge_table[isl_edge_last + 1];
384 struct isl_hash_table *node_table;
385 struct isl_trivial_region *region;
387 isl_basic_set *lp;
389 int src_scc;
390 int dst_scc;
392 int scc;
393 int weak;
395 int max_weight;
398 /* Initialize node_table based on the list of nodes.
400 static int graph_init_table(isl_ctx *ctx, struct isl_sched_graph *graph)
402 int i;
404 graph->node_table = isl_hash_table_alloc(ctx, graph->n);
405 if (!graph->node_table)
406 return -1;
408 for (i = 0; i < graph->n; ++i) {
409 struct isl_hash_table_entry *entry;
410 uint32_t hash;
412 hash = isl_space_get_tuple_hash(graph->node[i].space);
413 entry = isl_hash_table_find(ctx, graph->node_table, hash,
414 &node_has_tuples,
415 graph->node[i].space, 1);
416 if (!entry)
417 return -1;
418 entry->data = &graph->node[i];
421 return 0;
424 /* Return a pointer to the node that lives within the given space,
425 * an invalid node if there is no such node, or NULL in case of error.
427 static struct isl_sched_node *graph_find_node(isl_ctx *ctx,
428 struct isl_sched_graph *graph, __isl_keep isl_space *space)
430 struct isl_hash_table_entry *entry;
431 uint32_t hash;
433 if (!space)
434 return NULL;
436 hash = isl_space_get_tuple_hash(space);
437 entry = isl_hash_table_find(ctx, graph->node_table, hash,
438 &node_has_tuples, space, 0);
440 return entry ? entry->data : graph->node + graph->n;
443 /* Is "node" a node in "graph"?
445 static int is_node(struct isl_sched_graph *graph,
446 struct isl_sched_node *node)
448 return node && node >= &graph->node[0] && node < &graph->node[graph->n];
451 static int edge_has_src_and_dst(const void *entry, const void *val)
453 const struct isl_sched_edge *edge = entry;
454 const struct isl_sched_edge *temp = val;
456 return edge->src == temp->src && edge->dst == temp->dst;
459 /* Add the given edge to graph->edge_table[type].
461 static isl_stat graph_edge_table_add(isl_ctx *ctx,
462 struct isl_sched_graph *graph, enum isl_edge_type type,
463 struct isl_sched_edge *edge)
465 struct isl_hash_table_entry *entry;
466 uint32_t hash;
468 hash = isl_hash_init();
469 hash = isl_hash_builtin(hash, edge->src);
470 hash = isl_hash_builtin(hash, edge->dst);
471 entry = isl_hash_table_find(ctx, graph->edge_table[type], hash,
472 &edge_has_src_and_dst, edge, 1);
473 if (!entry)
474 return isl_stat_error;
475 entry->data = edge;
477 return isl_stat_ok;
480 /* Add "edge" to all relevant edge tables.
481 * That is, for every type of the edge, add it to the corresponding table.
483 static isl_stat graph_edge_tables_add(isl_ctx *ctx,
484 struct isl_sched_graph *graph, struct isl_sched_edge *edge)
486 enum isl_edge_type t;
488 for (t = isl_edge_first; t <= isl_edge_last; ++t) {
489 if (!is_type(edge, t))
490 continue;
491 if (graph_edge_table_add(ctx, graph, t, edge) < 0)
492 return isl_stat_error;
495 return isl_stat_ok;
498 /* Allocate the edge_tables based on the maximal number of edges of
499 * each type.
501 static int graph_init_edge_tables(isl_ctx *ctx, struct isl_sched_graph *graph)
503 int i;
505 for (i = 0; i <= isl_edge_last; ++i) {
506 graph->edge_table[i] = isl_hash_table_alloc(ctx,
507 graph->max_edge[i]);
508 if (!graph->edge_table[i])
509 return -1;
512 return 0;
515 /* If graph->edge_table[type] contains an edge from the given source
516 * to the given destination, then return the hash table entry of this edge.
517 * Otherwise, return NULL.
519 static struct isl_hash_table_entry *graph_find_edge_entry(
520 struct isl_sched_graph *graph,
521 enum isl_edge_type type,
522 struct isl_sched_node *src, struct isl_sched_node *dst)
524 isl_ctx *ctx = isl_space_get_ctx(src->space);
525 uint32_t hash;
526 struct isl_sched_edge temp = { .src = src, .dst = dst };
528 hash = isl_hash_init();
529 hash = isl_hash_builtin(hash, temp.src);
530 hash = isl_hash_builtin(hash, temp.dst);
531 return isl_hash_table_find(ctx, graph->edge_table[type], hash,
532 &edge_has_src_and_dst, &temp, 0);
536 /* If graph->edge_table[type] contains an edge from the given source
537 * to the given destination, then return this edge.
538 * Otherwise, return NULL.
540 static struct isl_sched_edge *graph_find_edge(struct isl_sched_graph *graph,
541 enum isl_edge_type type,
542 struct isl_sched_node *src, struct isl_sched_node *dst)
544 struct isl_hash_table_entry *entry;
546 entry = graph_find_edge_entry(graph, type, src, dst);
547 if (!entry)
548 return NULL;
550 return entry->data;
553 /* Check whether the dependence graph has an edge of the given type
554 * between the given two nodes.
556 static isl_bool graph_has_edge(struct isl_sched_graph *graph,
557 enum isl_edge_type type,
558 struct isl_sched_node *src, struct isl_sched_node *dst)
560 struct isl_sched_edge *edge;
561 isl_bool empty;
563 edge = graph_find_edge(graph, type, src, dst);
564 if (!edge)
565 return isl_bool_false;
567 empty = isl_map_plain_is_empty(edge->map);
569 return isl_bool_not(empty);
572 /* Look for any edge with the same src, dst and map fields as "model".
574 * Return the matching edge if one can be found.
575 * Return "model" if no matching edge is found.
576 * Return NULL on error.
578 static struct isl_sched_edge *graph_find_matching_edge(
579 struct isl_sched_graph *graph, struct isl_sched_edge *model)
581 enum isl_edge_type i;
582 struct isl_sched_edge *edge;
584 for (i = isl_edge_first; i <= isl_edge_last; ++i) {
585 int is_equal;
587 edge = graph_find_edge(graph, i, model->src, model->dst);
588 if (!edge)
589 continue;
590 is_equal = isl_map_plain_is_equal(model->map, edge->map);
591 if (is_equal < 0)
592 return NULL;
593 if (is_equal)
594 return edge;
597 return model;
600 /* Remove the given edge from all the edge_tables that refer to it.
602 static void graph_remove_edge(struct isl_sched_graph *graph,
603 struct isl_sched_edge *edge)
605 isl_ctx *ctx = isl_map_get_ctx(edge->map);
606 enum isl_edge_type i;
608 for (i = isl_edge_first; i <= isl_edge_last; ++i) {
609 struct isl_hash_table_entry *entry;
611 entry = graph_find_edge_entry(graph, i, edge->src, edge->dst);
612 if (!entry)
613 continue;
614 if (entry->data != edge)
615 continue;
616 isl_hash_table_remove(ctx, graph->edge_table[i], entry);
620 /* Check whether the dependence graph has any edge
621 * between the given two nodes.
623 static isl_bool graph_has_any_edge(struct isl_sched_graph *graph,
624 struct isl_sched_node *src, struct isl_sched_node *dst)
626 enum isl_edge_type i;
627 isl_bool r;
629 for (i = isl_edge_first; i <= isl_edge_last; ++i) {
630 r = graph_has_edge(graph, i, src, dst);
631 if (r < 0 || r)
632 return r;
635 return r;
638 /* Check whether the dependence graph has a validity edge
639 * between the given two nodes.
641 * Conditional validity edges are essentially validity edges that
642 * can be ignored if the corresponding condition edges are iteration private.
643 * Here, we are only checking for the presence of validity
644 * edges, so we need to consider the conditional validity edges too.
645 * In particular, this function is used during the detection
646 * of strongly connected components and we cannot ignore
647 * conditional validity edges during this detection.
649 static isl_bool graph_has_validity_edge(struct isl_sched_graph *graph,
650 struct isl_sched_node *src, struct isl_sched_node *dst)
652 isl_bool r;
654 r = graph_has_edge(graph, isl_edge_validity, src, dst);
655 if (r < 0 || r)
656 return r;
658 return graph_has_edge(graph, isl_edge_conditional_validity, src, dst);
661 /* Perform all the required memory allocations for a schedule graph "graph"
662 * with "n_node" nodes and "n_edge" edge and initialize the corresponding
663 * fields.
665 static isl_stat graph_alloc(isl_ctx *ctx, struct isl_sched_graph *graph,
666 int n_node, int n_edge)
668 int i;
670 graph->n = n_node;
671 graph->n_edge = n_edge;
672 graph->node = isl_calloc_array(ctx, struct isl_sched_node, graph->n);
673 graph->sorted = isl_calloc_array(ctx, int, graph->n);
674 graph->region = isl_alloc_array(ctx,
675 struct isl_trivial_region, graph->n);
676 graph->edge = isl_calloc_array(ctx,
677 struct isl_sched_edge, graph->n_edge);
679 graph->intra_hmap = isl_map_to_basic_set_alloc(ctx, 2 * n_edge);
680 graph->intra_hmap_param = isl_map_to_basic_set_alloc(ctx, 2 * n_edge);
681 graph->inter_hmap = isl_map_to_basic_set_alloc(ctx, 2 * n_edge);
683 if (!graph->node || !graph->region || (graph->n_edge && !graph->edge) ||
684 !graph->sorted)
685 return isl_stat_error;
687 for(i = 0; i < graph->n; ++i)
688 graph->sorted[i] = i;
690 return isl_stat_ok;
693 /* Free the memory associated to node "node" in "graph".
694 * The "coincident" field is shared by nodes in a graph and its subgraph.
695 * It therefore only needs to be freed for the original dependence graph,
696 * i.e., one that is not the result of splitting.
698 static void clear_node(struct isl_sched_graph *graph,
699 struct isl_sched_node *node)
701 isl_space_free(node->space);
702 isl_set_free(node->hull);
703 isl_multi_aff_free(node->compress);
704 isl_multi_aff_free(node->decompress);
705 isl_mat_free(node->sched);
706 isl_map_free(node->sched_map);
707 isl_mat_free(node->indep);
708 isl_mat_free(node->vmap);
709 if (graph->root == graph)
710 free(node->coincident);
711 isl_multi_val_free(node->sizes);
712 isl_basic_set_free(node->bounds);
713 isl_vec_free(node->max);
716 static void graph_free(isl_ctx *ctx, struct isl_sched_graph *graph)
718 int i;
720 isl_map_to_basic_set_free(graph->intra_hmap);
721 isl_map_to_basic_set_free(graph->intra_hmap_param);
722 isl_map_to_basic_set_free(graph->inter_hmap);
724 if (graph->node)
725 for (i = 0; i < graph->n; ++i)
726 clear_node(graph, &graph->node[i]);
727 free(graph->node);
728 free(graph->sorted);
729 if (graph->edge)
730 for (i = 0; i < graph->n_edge; ++i) {
731 isl_map_free(graph->edge[i].map);
732 isl_union_map_free(graph->edge[i].tagged_condition);
733 isl_union_map_free(graph->edge[i].tagged_validity);
735 free(graph->edge);
736 free(graph->region);
737 for (i = 0; i <= isl_edge_last; ++i)
738 isl_hash_table_free(ctx, graph->edge_table[i]);
739 isl_hash_table_free(ctx, graph->node_table);
740 isl_basic_set_free(graph->lp);
743 /* For each "set" on which this function is called, increment
744 * graph->n by one and update graph->maxvar.
746 static isl_stat init_n_maxvar(__isl_take isl_set *set, void *user)
748 struct isl_sched_graph *graph = user;
749 isl_size nvar = isl_set_dim(set, isl_dim_set);
751 graph->n++;
752 if (nvar > graph->maxvar)
753 graph->maxvar = nvar;
755 isl_set_free(set);
757 if (nvar < 0)
758 return isl_stat_error;
759 return isl_stat_ok;
762 /* Compute the number of rows that should be allocated for the schedule.
763 * In particular, we need one row for each variable or one row
764 * for each basic map in the dependences.
765 * Note that it is practically impossible to exhaust both
766 * the number of dependences and the number of variables.
768 static isl_stat compute_max_row(struct isl_sched_graph *graph,
769 __isl_keep isl_schedule_constraints *sc)
771 int n_edge;
772 isl_stat r;
773 isl_union_set *domain;
775 graph->n = 0;
776 graph->maxvar = 0;
777 domain = isl_schedule_constraints_get_domain(sc);
778 r = isl_union_set_foreach_set(domain, &init_n_maxvar, graph);
779 isl_union_set_free(domain);
780 if (r < 0)
781 return isl_stat_error;
782 n_edge = isl_schedule_constraints_n_basic_map(sc);
783 if (n_edge < 0)
784 return isl_stat_error;
785 graph->max_row = n_edge + graph->maxvar;
787 return isl_stat_ok;
790 /* Does "bset" have any defining equalities for its set variables?
792 static isl_bool has_any_defining_equality(__isl_keep isl_basic_set *bset)
794 int i;
795 isl_size n;
797 n = isl_basic_set_dim(bset, isl_dim_set);
798 if (n < 0)
799 return isl_bool_error;
801 for (i = 0; i < n; ++i) {
802 isl_bool has;
804 has = isl_basic_set_has_defining_equality(bset, isl_dim_set, i,
805 NULL);
806 if (has < 0 || has)
807 return has;
810 return isl_bool_false;
813 /* Set the entries of node->max to the value of the schedule_max_coefficient
814 * option, if set.
816 static isl_stat set_max_coefficient(isl_ctx *ctx, struct isl_sched_node *node)
818 int max;
820 max = isl_options_get_schedule_max_coefficient(ctx);
821 if (max == -1)
822 return isl_stat_ok;
824 node->max = isl_vec_alloc(ctx, node->nvar);
825 node->max = isl_vec_set_si(node->max, max);
826 if (!node->max)
827 return isl_stat_error;
829 return isl_stat_ok;
832 /* Set the entries of node->max to the minimum of the schedule_max_coefficient
833 * option (if set) and half of the minimum of the sizes in the other
834 * dimensions. Round up when computing the half such that
835 * if the minimum of the sizes is one, half of the size is taken to be one
836 * rather than zero.
837 * If the global minimum is unbounded (i.e., if both
838 * the schedule_max_coefficient is not set and the sizes in the other
839 * dimensions are unbounded), then store a negative value.
840 * If the schedule coefficient is close to the size of the instance set
841 * in another dimension, then the schedule may represent a loop
842 * coalescing transformation (especially if the coefficient
843 * in that other dimension is one). Forcing the coefficient to be
844 * smaller than or equal to half the minimal size should avoid this
845 * situation.
847 static isl_stat compute_max_coefficient(isl_ctx *ctx,
848 struct isl_sched_node *node)
850 int max;
851 int i, j;
852 isl_vec *v;
854 max = isl_options_get_schedule_max_coefficient(ctx);
855 v = isl_vec_alloc(ctx, node->nvar);
856 if (!v)
857 return isl_stat_error;
859 for (i = 0; i < node->nvar; ++i) {
860 isl_int_set_si(v->el[i], max);
861 isl_int_mul_si(v->el[i], v->el[i], 2);
864 for (i = 0; i < node->nvar; ++i) {
865 isl_val *size;
867 size = isl_multi_val_get_val(node->sizes, i);
868 if (!size)
869 goto error;
870 if (!isl_val_is_int(size)) {
871 isl_val_free(size);
872 continue;
874 for (j = 0; j < node->nvar; ++j) {
875 if (j == i)
876 continue;
877 if (isl_int_is_neg(v->el[j]) ||
878 isl_int_gt(v->el[j], size->n))
879 isl_int_set(v->el[j], size->n);
881 isl_val_free(size);
884 for (i = 0; i < node->nvar; ++i)
885 isl_int_cdiv_q_ui(v->el[i], v->el[i], 2);
887 node->max = v;
888 return isl_stat_ok;
889 error:
890 isl_vec_free(v);
891 return isl_stat_error;
894 /* Compute and return the size of "set" in dimension "dim".
895 * The size is taken to be the difference in values for that variable
896 * for fixed values of the other variables.
897 * This assumes that "set" is convex.
898 * In particular, the variable is first isolated from the other variables
899 * in the range of a map
901 * [i_0, ..., i_dim-1, i_dim+1, ...] -> [i_dim]
903 * and then duplicated
905 * [i_0, ..., i_dim-1, i_dim+1, ...] -> [[i_dim] -> [i_dim']]
907 * The shared variables are then projected out and the maximal value
908 * of i_dim' - i_dim is computed.
910 static __isl_give isl_val *compute_size(__isl_take isl_set *set, int dim)
912 isl_map *map;
913 isl_local_space *ls;
914 isl_aff *obj;
915 isl_val *v;
917 map = isl_set_project_onto_map(set, isl_dim_set, dim, 1);
918 map = isl_map_project_out(map, isl_dim_in, dim, 1);
919 map = isl_map_range_product(map, isl_map_copy(map));
920 map = isl_set_unwrap(isl_map_range(map));
921 set = isl_map_deltas(map);
922 ls = isl_local_space_from_space(isl_set_get_space(set));
923 obj = isl_aff_var_on_domain(ls, isl_dim_set, 0);
924 v = isl_set_max_val(set, obj);
925 isl_aff_free(obj);
926 isl_set_free(set);
928 return v;
931 /* Compute the size of the instance set "set" of "node", after compression,
932 * as well as bounds on the corresponding coefficients, if needed.
934 * The sizes are needed when the schedule_treat_coalescing option is set.
935 * The bounds are needed when the schedule_treat_coalescing option or
936 * the schedule_max_coefficient option is set.
938 * If the schedule_treat_coalescing option is not set, then at most
939 * the bounds need to be set and this is done in set_max_coefficient.
940 * Otherwise, compress the domain if needed, compute the size
941 * in each direction and store the results in node->size.
942 * If the domain is not convex, then the sizes are computed
943 * on a convex superset in order to avoid picking up sizes
944 * that are valid for the individual disjuncts, but not for
945 * the domain as a whole.
946 * Finally, set the bounds on the coefficients based on the sizes
947 * and the schedule_max_coefficient option in compute_max_coefficient.
949 static isl_stat compute_sizes_and_max(isl_ctx *ctx, struct isl_sched_node *node,
950 __isl_take isl_set *set)
952 int j;
953 isl_size n;
954 isl_multi_val *mv;
956 if (!isl_options_get_schedule_treat_coalescing(ctx)) {
957 isl_set_free(set);
958 return set_max_coefficient(ctx, node);
961 if (node->compressed)
962 set = isl_set_preimage_multi_aff(set,
963 isl_multi_aff_copy(node->decompress));
964 set = isl_set_from_basic_set(isl_set_simple_hull(set));
965 mv = isl_multi_val_zero(isl_set_get_space(set));
966 n = isl_set_dim(set, isl_dim_set);
967 if (n < 0)
968 mv = isl_multi_val_free(mv);
969 for (j = 0; j < n; ++j) {
970 isl_val *v;
972 v = compute_size(isl_set_copy(set), j);
973 mv = isl_multi_val_set_val(mv, j, v);
975 node->sizes = mv;
976 isl_set_free(set);
977 if (!node->sizes)
978 return isl_stat_error;
979 return compute_max_coefficient(ctx, node);
982 /* Add a new node to the graph representing the given instance set.
983 * "nvar" is the (possibly compressed) number of variables and
984 * may be smaller than then number of set variables in "set"
985 * if "compressed" is set.
986 * If "compressed" is set, then "hull" represents the constraints
987 * that were used to derive the compression, while "compress" and
988 * "decompress" map the original space to the compressed space and
989 * vice versa.
990 * If "compressed" is not set, then "hull", "compress" and "decompress"
991 * should be NULL.
993 * Compute the size of the instance set and bounds on the coefficients,
994 * if needed.
996 static isl_stat add_node(struct isl_sched_graph *graph,
997 __isl_take isl_set *set, int nvar, int compressed,
998 __isl_take isl_set *hull, __isl_take isl_multi_aff *compress,
999 __isl_take isl_multi_aff *decompress)
1001 isl_size nparam;
1002 isl_ctx *ctx;
1003 isl_mat *sched;
1004 isl_space *space;
1005 int *coincident;
1006 struct isl_sched_node *node;
1008 nparam = isl_set_dim(set, isl_dim_param);
1009 if (nparam < 0)
1010 goto error;
1012 ctx = isl_set_get_ctx(set);
1013 if (!ctx->opt->schedule_parametric)
1014 nparam = 0;
1015 sched = isl_mat_alloc(ctx, 0, 1 + nparam + nvar);
1016 node = &graph->node[graph->n];
1017 graph->n++;
1018 space = isl_set_get_space(set);
1019 node->space = space;
1020 node->nvar = nvar;
1021 node->nparam = nparam;
1022 node->sched = sched;
1023 node->sched_map = NULL;
1024 coincident = isl_calloc_array(ctx, int, graph->max_row);
1025 node->coincident = coincident;
1026 node->compressed = compressed;
1027 node->hull = hull;
1028 node->compress = compress;
1029 node->decompress = decompress;
1030 if (compute_sizes_and_max(ctx, node, set) < 0)
1031 return isl_stat_error;
1033 if (!space || !sched || (graph->max_row && !coincident))
1034 return isl_stat_error;
1035 if (compressed && (!hull || !compress || !decompress))
1036 return isl_stat_error;
1038 return isl_stat_ok;
1039 error:
1040 isl_set_free(set);
1041 isl_set_free(hull);
1042 isl_multi_aff_free(compress);
1043 isl_multi_aff_free(decompress);
1044 return isl_stat_error;
1047 /* Construct an identifier for node "node", which will represent "set".
1048 * The name of the identifier is either "compressed" or
1049 * "compressed_<name>", with <name> the name of the space of "set".
1050 * The user pointer of the identifier points to "node".
1052 static __isl_give isl_id *construct_compressed_id(__isl_keep isl_set *set,
1053 struct isl_sched_node *node)
1055 isl_bool has_name;
1056 isl_ctx *ctx;
1057 isl_id *id;
1058 isl_printer *p;
1059 const char *name;
1060 char *id_name;
1062 has_name = isl_set_has_tuple_name(set);
1063 if (has_name < 0)
1064 return NULL;
1066 ctx = isl_set_get_ctx(set);
1067 if (!has_name)
1068 return isl_id_alloc(ctx, "compressed", node);
1070 p = isl_printer_to_str(ctx);
1071 name = isl_set_get_tuple_name(set);
1072 p = isl_printer_print_str(p, "compressed_");
1073 p = isl_printer_print_str(p, name);
1074 id_name = isl_printer_get_str(p);
1075 isl_printer_free(p);
1077 id = isl_id_alloc(ctx, id_name, node);
1078 free(id_name);
1080 return id;
1083 /* Add a new node to the graph representing the given set.
1085 * If any of the set variables is defined by an equality, then
1086 * we perform variable compression such that we can perform
1087 * the scheduling on the compressed domain.
1088 * In this case, an identifier is used that references the new node
1089 * such that each compressed space is unique and
1090 * such that the node can be recovered from the compressed space.
1092 static isl_stat extract_node(__isl_take isl_set *set, void *user)
1094 isl_size nvar;
1095 isl_bool has_equality;
1096 isl_id *id;
1097 isl_basic_set *hull;
1098 isl_set *hull_set;
1099 isl_morph *morph;
1100 isl_multi_aff *compress, *decompress;
1101 struct isl_sched_graph *graph = user;
1103 hull = isl_set_affine_hull(isl_set_copy(set));
1104 hull = isl_basic_set_remove_divs(hull);
1105 nvar = isl_set_dim(set, isl_dim_set);
1106 has_equality = has_any_defining_equality(hull);
1108 if (nvar < 0 || has_equality < 0)
1109 goto error;
1110 if (!has_equality) {
1111 isl_basic_set_free(hull);
1112 return add_node(graph, set, nvar, 0, NULL, NULL, NULL);
1115 id = construct_compressed_id(set, &graph->node[graph->n]);
1116 morph = isl_basic_set_variable_compression_with_id(hull,
1117 isl_dim_set, id);
1118 isl_id_free(id);
1119 nvar = isl_morph_ran_dim(morph, isl_dim_set);
1120 if (nvar < 0)
1121 set = isl_set_free(set);
1122 compress = isl_morph_get_var_multi_aff(morph);
1123 morph = isl_morph_inverse(morph);
1124 decompress = isl_morph_get_var_multi_aff(morph);
1125 isl_morph_free(morph);
1127 hull_set = isl_set_from_basic_set(hull);
1128 return add_node(graph, set, nvar, 1, hull_set, compress, decompress);
1129 error:
1130 isl_basic_set_free(hull);
1131 isl_set_free(set);
1132 return isl_stat_error;
1135 struct isl_extract_edge_data {
1136 enum isl_edge_type type;
1137 struct isl_sched_graph *graph;
1140 /* Merge edge2 into edge1, freeing the contents of edge2.
1141 * Return 0 on success and -1 on failure.
1143 * edge1 and edge2 are assumed to have the same value for the map field.
1145 static int merge_edge(struct isl_sched_edge *edge1,
1146 struct isl_sched_edge *edge2)
1148 edge1->types |= edge2->types;
1149 isl_map_free(edge2->map);
1151 if (is_condition(edge2)) {
1152 if (!edge1->tagged_condition)
1153 edge1->tagged_condition = edge2->tagged_condition;
1154 else
1155 edge1->tagged_condition =
1156 isl_union_map_union(edge1->tagged_condition,
1157 edge2->tagged_condition);
1160 if (is_conditional_validity(edge2)) {
1161 if (!edge1->tagged_validity)
1162 edge1->tagged_validity = edge2->tagged_validity;
1163 else
1164 edge1->tagged_validity =
1165 isl_union_map_union(edge1->tagged_validity,
1166 edge2->tagged_validity);
1169 if (is_condition(edge2) && !edge1->tagged_condition)
1170 return -1;
1171 if (is_conditional_validity(edge2) && !edge1->tagged_validity)
1172 return -1;
1174 return 0;
1177 /* Insert dummy tags in domain and range of "map".
1179 * In particular, if "map" is of the form
1181 * A -> B
1183 * then return
1185 * [A -> dummy_tag] -> [B -> dummy_tag]
1187 * where the dummy_tags are identical and equal to any dummy tags
1188 * introduced by any other call to this function.
1190 static __isl_give isl_map *insert_dummy_tags(__isl_take isl_map *map)
1192 static char dummy;
1193 isl_ctx *ctx;
1194 isl_id *id;
1195 isl_space *space;
1196 isl_set *domain, *range;
1198 ctx = isl_map_get_ctx(map);
1200 id = isl_id_alloc(ctx, NULL, &dummy);
1201 space = isl_space_params(isl_map_get_space(map));
1202 space = isl_space_set_from_params(space);
1203 space = isl_space_set_tuple_id(space, isl_dim_set, id);
1204 space = isl_space_map_from_set(space);
1206 domain = isl_map_wrap(map);
1207 range = isl_map_wrap(isl_map_universe(space));
1208 map = isl_map_from_domain_and_range(domain, range);
1209 map = isl_map_zip(map);
1211 return map;
1214 /* Given that at least one of "src" or "dst" is compressed, return
1215 * a map between the spaces of these nodes restricted to the affine
1216 * hull that was used in the compression.
1218 static __isl_give isl_map *extract_hull(struct isl_sched_node *src,
1219 struct isl_sched_node *dst)
1221 isl_set *dom, *ran;
1223 if (src->compressed)
1224 dom = isl_set_copy(src->hull);
1225 else
1226 dom = isl_set_universe(isl_space_copy(src->space));
1227 if (dst->compressed)
1228 ran = isl_set_copy(dst->hull);
1229 else
1230 ran = isl_set_universe(isl_space_copy(dst->space));
1232 return isl_map_from_domain_and_range(dom, ran);
1235 /* Intersect the domains of the nested relations in domain and range
1236 * of "tagged" with "map".
1238 static __isl_give isl_map *map_intersect_domains(__isl_take isl_map *tagged,
1239 __isl_keep isl_map *map)
1241 isl_set *set;
1243 tagged = isl_map_zip(tagged);
1244 set = isl_map_wrap(isl_map_copy(map));
1245 tagged = isl_map_intersect_domain(tagged, set);
1246 tagged = isl_map_zip(tagged);
1247 return tagged;
1250 /* Return a pointer to the node that lives in the domain space of "map",
1251 * an invalid node if there is no such node, or NULL in case of error.
1253 static struct isl_sched_node *find_domain_node(isl_ctx *ctx,
1254 struct isl_sched_graph *graph, __isl_keep isl_map *map)
1256 struct isl_sched_node *node;
1257 isl_space *space;
1259 space = isl_space_domain(isl_map_get_space(map));
1260 node = graph_find_node(ctx, graph, space);
1261 isl_space_free(space);
1263 return node;
1266 /* Return a pointer to the node that lives in the range space of "map",
1267 * an invalid node if there is no such node, or NULL in case of error.
1269 static struct isl_sched_node *find_range_node(isl_ctx *ctx,
1270 struct isl_sched_graph *graph, __isl_keep isl_map *map)
1272 struct isl_sched_node *node;
1273 isl_space *space;
1275 space = isl_space_range(isl_map_get_space(map));
1276 node = graph_find_node(ctx, graph, space);
1277 isl_space_free(space);
1279 return node;
1282 /* Refrain from adding a new edge based on "map".
1283 * Instead, just free the map.
1284 * "tagged" is either a copy of "map" with additional tags or NULL.
1286 static isl_stat skip_edge(__isl_take isl_map *map, __isl_take isl_map *tagged)
1288 isl_map_free(map);
1289 isl_map_free(tagged);
1291 return isl_stat_ok;
1294 /* Add a new edge to the graph based on the given map
1295 * and add it to data->graph->edge_table[data->type].
1296 * If a dependence relation of a given type happens to be identical
1297 * to one of the dependence relations of a type that was added before,
1298 * then we don't create a new edge, but instead mark the original edge
1299 * as also representing a dependence of the current type.
1301 * Edges of type isl_edge_condition or isl_edge_conditional_validity
1302 * may be specified as "tagged" dependence relations. That is, "map"
1303 * may contain elements (i -> a) -> (j -> b), where i -> j denotes
1304 * the dependence on iterations and a and b are tags.
1305 * edge->map is set to the relation containing the elements i -> j,
1306 * while edge->tagged_condition and edge->tagged_validity contain
1307 * the union of all the "map" relations
1308 * for which extract_edge is called that result in the same edge->map.
1310 * If the source or the destination node is compressed, then
1311 * intersect both "map" and "tagged" with the constraints that
1312 * were used to construct the compression.
1313 * This ensures that there are no schedule constraints defined
1314 * outside of these domains, while the scheduler no longer has
1315 * any control over those outside parts.
1317 static isl_stat extract_edge(__isl_take isl_map *map, void *user)
1319 isl_bool empty;
1320 isl_ctx *ctx = isl_map_get_ctx(map);
1321 struct isl_extract_edge_data *data = user;
1322 struct isl_sched_graph *graph = data->graph;
1323 struct isl_sched_node *src, *dst;
1324 struct isl_sched_edge *edge;
1325 isl_map *tagged = NULL;
1327 if (data->type == isl_edge_condition ||
1328 data->type == isl_edge_conditional_validity) {
1329 if (isl_map_can_zip(map)) {
1330 tagged = isl_map_copy(map);
1331 map = isl_set_unwrap(isl_map_domain(isl_map_zip(map)));
1332 } else {
1333 tagged = insert_dummy_tags(isl_map_copy(map));
1337 src = find_domain_node(ctx, graph, map);
1338 dst = find_range_node(ctx, graph, map);
1340 if (!src || !dst)
1341 goto error;
1342 if (!is_node(graph, src) || !is_node(graph, dst))
1343 return skip_edge(map, tagged);
1345 if (src->compressed || dst->compressed) {
1346 isl_map *hull;
1347 hull = extract_hull(src, dst);
1348 if (tagged)
1349 tagged = map_intersect_domains(tagged, hull);
1350 map = isl_map_intersect(map, hull);
1353 empty = isl_map_plain_is_empty(map);
1354 if (empty < 0)
1355 goto error;
1356 if (empty)
1357 return skip_edge(map, tagged);
1359 graph->edge[graph->n_edge].src = src;
1360 graph->edge[graph->n_edge].dst = dst;
1361 graph->edge[graph->n_edge].map = map;
1362 graph->edge[graph->n_edge].types = 0;
1363 graph->edge[graph->n_edge].tagged_condition = NULL;
1364 graph->edge[graph->n_edge].tagged_validity = NULL;
1365 set_type(&graph->edge[graph->n_edge], data->type);
1366 if (data->type == isl_edge_condition)
1367 graph->edge[graph->n_edge].tagged_condition =
1368 isl_union_map_from_map(tagged);
1369 if (data->type == isl_edge_conditional_validity)
1370 graph->edge[graph->n_edge].tagged_validity =
1371 isl_union_map_from_map(tagged);
1373 edge = graph_find_matching_edge(graph, &graph->edge[graph->n_edge]);
1374 if (!edge) {
1375 graph->n_edge++;
1376 return isl_stat_error;
1378 if (edge == &graph->edge[graph->n_edge])
1379 return graph_edge_table_add(ctx, graph, data->type,
1380 &graph->edge[graph->n_edge++]);
1382 if (merge_edge(edge, &graph->edge[graph->n_edge]) < 0)
1383 return isl_stat_error;
1385 return graph_edge_table_add(ctx, graph, data->type, edge);
1386 error:
1387 isl_map_free(map);
1388 isl_map_free(tagged);
1389 return isl_stat_error;
1392 /* Initialize the schedule graph "graph" from the schedule constraints "sc".
1394 * The context is included in the domain before the nodes of
1395 * the graphs are extracted in order to be able to exploit
1396 * any possible additional equalities.
1397 * Note that this intersection is only performed locally here.
1399 static isl_stat graph_init(struct isl_sched_graph *graph,
1400 __isl_keep isl_schedule_constraints *sc)
1402 isl_ctx *ctx;
1403 isl_union_set *domain;
1404 isl_union_map *c;
1405 struct isl_extract_edge_data data;
1406 enum isl_edge_type i;
1407 isl_stat r;
1409 if (!sc)
1410 return isl_stat_error;
1412 ctx = isl_schedule_constraints_get_ctx(sc);
1414 domain = isl_schedule_constraints_get_domain(sc);
1415 graph->n = isl_union_set_n_set(domain);
1416 isl_union_set_free(domain);
1418 if (graph_alloc(ctx, graph, graph->n,
1419 isl_schedule_constraints_n_map(sc)) < 0)
1420 return isl_stat_error;
1422 if (compute_max_row(graph, sc) < 0)
1423 return isl_stat_error;
1424 graph->root = graph;
1425 graph->n = 0;
1426 domain = isl_schedule_constraints_get_domain(sc);
1427 domain = isl_union_set_intersect_params(domain,
1428 isl_schedule_constraints_get_context(sc));
1429 r = isl_union_set_foreach_set(domain, &extract_node, graph);
1430 isl_union_set_free(domain);
1431 if (r < 0)
1432 return isl_stat_error;
1433 if (graph_init_table(ctx, graph) < 0)
1434 return isl_stat_error;
1435 for (i = isl_edge_first; i <= isl_edge_last; ++i) {
1436 c = isl_schedule_constraints_get(sc, i);
1437 graph->max_edge[i] = isl_union_map_n_map(c);
1438 isl_union_map_free(c);
1439 if (!c)
1440 return isl_stat_error;
1442 if (graph_init_edge_tables(ctx, graph) < 0)
1443 return isl_stat_error;
1444 graph->n_edge = 0;
1445 data.graph = graph;
1446 for (i = isl_edge_first; i <= isl_edge_last; ++i) {
1447 isl_stat r;
1449 data.type = i;
1450 c = isl_schedule_constraints_get(sc, i);
1451 r = isl_union_map_foreach_map(c, &extract_edge, &data);
1452 isl_union_map_free(c);
1453 if (r < 0)
1454 return isl_stat_error;
1457 return isl_stat_ok;
1460 /* Check whether there is any dependence from node[j] to node[i]
1461 * or from node[i] to node[j].
1463 static isl_bool node_follows_weak(int i, int j, void *user)
1465 isl_bool f;
1466 struct isl_sched_graph *graph = user;
1468 f = graph_has_any_edge(graph, &graph->node[j], &graph->node[i]);
1469 if (f < 0 || f)
1470 return f;
1471 return graph_has_any_edge(graph, &graph->node[i], &graph->node[j]);
1474 /* Check whether there is a (conditional) validity dependence from node[j]
1475 * to node[i], forcing node[i] to follow node[j].
1477 static isl_bool node_follows_strong(int i, int j, void *user)
1479 struct isl_sched_graph *graph = user;
1481 return graph_has_validity_edge(graph, &graph->node[j], &graph->node[i]);
1484 /* Use Tarjan's algorithm for computing the strongly connected components
1485 * in the dependence graph only considering those edges defined by "follows".
1487 static isl_stat detect_ccs(isl_ctx *ctx, struct isl_sched_graph *graph,
1488 isl_bool (*follows)(int i, int j, void *user))
1490 int i, n;
1491 struct isl_tarjan_graph *g = NULL;
1493 g = isl_tarjan_graph_init(ctx, graph->n, follows, graph);
1494 if (!g)
1495 return isl_stat_error;
1497 graph->scc = 0;
1498 i = 0;
1499 n = graph->n;
1500 while (n) {
1501 while (g->order[i] != -1) {
1502 graph->node[g->order[i]].scc = graph->scc;
1503 --n;
1504 ++i;
1506 ++i;
1507 graph->scc++;
1510 isl_tarjan_graph_free(g);
1512 return isl_stat_ok;
1515 /* Apply Tarjan's algorithm to detect the strongly connected components
1516 * in the dependence graph.
1517 * Only consider the (conditional) validity dependences and clear "weak".
1519 static isl_stat detect_sccs(isl_ctx *ctx, struct isl_sched_graph *graph)
1521 graph->weak = 0;
1522 return detect_ccs(ctx, graph, &node_follows_strong);
1525 /* Apply Tarjan's algorithm to detect the (weakly) connected components
1526 * in the dependence graph.
1527 * Consider all dependences and set "weak".
1529 static isl_stat detect_wccs(isl_ctx *ctx, struct isl_sched_graph *graph)
1531 graph->weak = 1;
1532 return detect_ccs(ctx, graph, &node_follows_weak);
1535 static int cmp_scc(const void *a, const void *b, void *data)
1537 struct isl_sched_graph *graph = data;
1538 const int *i1 = a;
1539 const int *i2 = b;
1541 return graph->node[*i1].scc - graph->node[*i2].scc;
1544 /* Sort the elements of graph->sorted according to the corresponding SCCs.
1546 static int sort_sccs(struct isl_sched_graph *graph)
1548 return isl_sort(graph->sorted, graph->n, sizeof(int), &cmp_scc, graph);
1551 /* Return a non-parametric set in the compressed space of "node" that is
1552 * bounded by the size in each direction
1554 * { [x] : -S_i <= x_i <= S_i }
1556 * If S_i is infinity in direction i, then there are no constraints
1557 * in that direction.
1559 * Cache the result in node->bounds.
1561 static __isl_give isl_basic_set *get_size_bounds(struct isl_sched_node *node)
1563 isl_space *space;
1564 isl_basic_set *bounds;
1565 int i;
1567 if (node->bounds)
1568 return isl_basic_set_copy(node->bounds);
1570 if (node->compressed)
1571 space = isl_multi_aff_get_domain_space(node->decompress);
1572 else
1573 space = isl_space_copy(node->space);
1574 space = isl_space_drop_all_params(space);
1575 bounds = isl_basic_set_universe(space);
1577 for (i = 0; i < node->nvar; ++i) {
1578 isl_val *size;
1580 size = isl_multi_val_get_val(node->sizes, i);
1581 if (!size)
1582 return isl_basic_set_free(bounds);
1583 if (!isl_val_is_int(size)) {
1584 isl_val_free(size);
1585 continue;
1587 bounds = isl_basic_set_upper_bound_val(bounds, isl_dim_set, i,
1588 isl_val_copy(size));
1589 bounds = isl_basic_set_lower_bound_val(bounds, isl_dim_set, i,
1590 isl_val_neg(size));
1593 node->bounds = isl_basic_set_copy(bounds);
1594 return bounds;
1597 /* Drop some constraints from "delta" that could be exploited
1598 * to construct loop coalescing schedules.
1599 * In particular, drop those constraint that bound the difference
1600 * to the size of the domain.
1601 * First project out the parameters to improve the effectiveness.
1603 static __isl_give isl_set *drop_coalescing_constraints(
1604 __isl_take isl_set *delta, struct isl_sched_node *node)
1606 isl_size nparam;
1607 isl_basic_set *bounds;
1609 nparam = isl_set_dim(delta, isl_dim_param);
1610 if (nparam < 0)
1611 return isl_set_free(delta);
1613 bounds = get_size_bounds(node);
1615 delta = isl_set_project_out(delta, isl_dim_param, 0, nparam);
1616 delta = isl_set_remove_divs(delta);
1617 delta = isl_set_plain_gist_basic_set(delta, bounds);
1618 return delta;
1621 /* Given a dependence relation R from "node" to itself,
1622 * construct the set of coefficients of valid constraints for elements
1623 * in that dependence relation.
1624 * In particular, the result contains tuples of coefficients
1625 * c_0, c_n, c_x such that
1627 * c_0 + c_n n + c_x y - c_x x >= 0 for each (x,y) in R
1629 * or, equivalently,
1631 * c_0 + c_n n + c_x d >= 0 for each d in delta R = { y - x | (x,y) in R }
1633 * We choose here to compute the dual of delta R.
1634 * Alternatively, we could have computed the dual of R, resulting
1635 * in a set of tuples c_0, c_n, c_x, c_y, and then
1636 * plugged in (c_0, c_n, c_x, -c_x).
1638 * If "need_param" is set, then the resulting coefficients effectively
1639 * include coefficients for the parameters c_n. Otherwise, they may
1640 * have been projected out already.
1641 * Since the constraints may be different for these two cases,
1642 * they are stored in separate caches.
1643 * In particular, if no parameter coefficients are required and
1644 * the schedule_treat_coalescing option is set, then the parameters
1645 * are projected out and some constraints that could be exploited
1646 * to construct coalescing schedules are removed before the dual
1647 * is computed.
1649 * If "node" has been compressed, then the dependence relation
1650 * is also compressed before the set of coefficients is computed.
1652 static __isl_give isl_basic_set *intra_coefficients(
1653 struct isl_sched_graph *graph, struct isl_sched_node *node,
1654 __isl_take isl_map *map, int need_param)
1656 isl_ctx *ctx;
1657 isl_set *delta;
1658 isl_map *key;
1659 isl_basic_set *coef;
1660 isl_maybe_isl_basic_set m;
1661 isl_map_to_basic_set **hmap = &graph->intra_hmap;
1662 int treat;
1664 if (!map)
1665 return NULL;
1667 ctx = isl_map_get_ctx(map);
1668 treat = !need_param && isl_options_get_schedule_treat_coalescing(ctx);
1669 if (!treat)
1670 hmap = &graph->intra_hmap_param;
1671 m = isl_map_to_basic_set_try_get(*hmap, map);
1672 if (m.valid < 0 || m.valid) {
1673 isl_map_free(map);
1674 return m.value;
1677 key = isl_map_copy(map);
1678 if (node->compressed) {
1679 map = isl_map_preimage_domain_multi_aff(map,
1680 isl_multi_aff_copy(node->decompress));
1681 map = isl_map_preimage_range_multi_aff(map,
1682 isl_multi_aff_copy(node->decompress));
1684 delta = isl_map_deltas(map);
1685 if (treat)
1686 delta = drop_coalescing_constraints(delta, node);
1687 delta = isl_set_remove_divs(delta);
1688 coef = isl_set_coefficients(delta);
1689 *hmap = isl_map_to_basic_set_set(*hmap, key, isl_basic_set_copy(coef));
1691 return coef;
1694 /* Given a dependence relation R, construct the set of coefficients
1695 * of valid constraints for elements in that dependence relation.
1696 * In particular, the result contains tuples of coefficients
1697 * c_0, c_n, c_x, c_y such that
1699 * c_0 + c_n n + c_x x + c_y y >= 0 for each (x,y) in R
1701 * If the source or destination nodes of "edge" have been compressed,
1702 * then the dependence relation is also compressed before
1703 * the set of coefficients is computed.
1705 static __isl_give isl_basic_set *inter_coefficients(
1706 struct isl_sched_graph *graph, struct isl_sched_edge *edge,
1707 __isl_take isl_map *map)
1709 isl_set *set;
1710 isl_map *key;
1711 isl_basic_set *coef;
1712 isl_maybe_isl_basic_set m;
1714 m = isl_map_to_basic_set_try_get(graph->inter_hmap, map);
1715 if (m.valid < 0 || m.valid) {
1716 isl_map_free(map);
1717 return m.value;
1720 key = isl_map_copy(map);
1721 if (edge->src->compressed)
1722 map = isl_map_preimage_domain_multi_aff(map,
1723 isl_multi_aff_copy(edge->src->decompress));
1724 if (edge->dst->compressed)
1725 map = isl_map_preimage_range_multi_aff(map,
1726 isl_multi_aff_copy(edge->dst->decompress));
1727 set = isl_map_wrap(isl_map_remove_divs(map));
1728 coef = isl_set_coefficients(set);
1729 graph->inter_hmap = isl_map_to_basic_set_set(graph->inter_hmap, key,
1730 isl_basic_set_copy(coef));
1732 return coef;
1735 /* Return the position of the coefficients of the variables in
1736 * the coefficients constraints "coef".
1738 * The space of "coef" is of the form
1740 * { coefficients[[cst, params] -> S] }
1742 * Return the position of S.
1744 static isl_size coef_var_offset(__isl_keep isl_basic_set *coef)
1746 isl_size offset;
1747 isl_space *space;
1749 space = isl_space_unwrap(isl_basic_set_get_space(coef));
1750 offset = isl_space_dim(space, isl_dim_in);
1751 isl_space_free(space);
1753 return offset;
1756 /* Return the offset of the coefficient of the constant term of "node"
1757 * within the (I)LP.
1759 * Within each node, the coefficients have the following order:
1760 * - positive and negative parts of c_i_x
1761 * - c_i_n (if parametric)
1762 * - c_i_0
1764 static int node_cst_coef_offset(struct isl_sched_node *node)
1766 return node->start + 2 * node->nvar + node->nparam;
1769 /* Return the offset of the coefficients of the parameters of "node"
1770 * within the (I)LP.
1772 * Within each node, the coefficients have the following order:
1773 * - positive and negative parts of c_i_x
1774 * - c_i_n (if parametric)
1775 * - c_i_0
1777 static int node_par_coef_offset(struct isl_sched_node *node)
1779 return node->start + 2 * node->nvar;
1782 /* Return the offset of the coefficients of the variables of "node"
1783 * within the (I)LP.
1785 * Within each node, the coefficients have the following order:
1786 * - positive and negative parts of c_i_x
1787 * - c_i_n (if parametric)
1788 * - c_i_0
1790 static int node_var_coef_offset(struct isl_sched_node *node)
1792 return node->start;
1795 /* Return the position of the pair of variables encoding
1796 * coefficient "i" of "node".
1798 * The order of these variable pairs is the opposite of
1799 * that of the coefficients, with 2 variables per coefficient.
1801 static int node_var_coef_pos(struct isl_sched_node *node, int i)
1803 return node_var_coef_offset(node) + 2 * (node->nvar - 1 - i);
1806 /* Construct an isl_dim_map for mapping constraints on coefficients
1807 * for "node" to the corresponding positions in graph->lp.
1808 * "offset" is the offset of the coefficients for the variables
1809 * in the input constraints.
1810 * "s" is the sign of the mapping.
1812 * The input constraints are given in terms of the coefficients
1813 * (c_0, c_x) or (c_0, c_n, c_x).
1814 * The mapping produced by this function essentially plugs in
1815 * (0, c_i_x^+ - c_i_x^-) if s = 1 and
1816 * (0, -c_i_x^+ + c_i_x^-) if s = -1 or
1817 * (0, 0, c_i_x^+ - c_i_x^-) if s = 1 and
1818 * (0, 0, -c_i_x^+ + c_i_x^-) if s = -1.
1819 * In graph->lp, the c_i_x^- appear before their c_i_x^+ counterpart.
1820 * Furthermore, the order of these pairs is the opposite of that
1821 * of the corresponding coefficients.
1823 * The caller can extend the mapping to also map the other coefficients
1824 * (and therefore not plug in 0).
1826 static __isl_give isl_dim_map *intra_dim_map(isl_ctx *ctx,
1827 struct isl_sched_graph *graph, struct isl_sched_node *node,
1828 int offset, int s)
1830 int pos;
1831 isl_size total;
1832 isl_dim_map *dim_map;
1834 total = isl_basic_set_dim(graph->lp, isl_dim_all);
1835 if (!node || total < 0)
1836 return NULL;
1838 pos = node_var_coef_pos(node, 0);
1839 dim_map = isl_dim_map_alloc(ctx, total);
1840 isl_dim_map_range(dim_map, pos, -2, offset, 1, node->nvar, -s);
1841 isl_dim_map_range(dim_map, pos + 1, -2, offset, 1, node->nvar, s);
1843 return dim_map;
1846 /* Construct an isl_dim_map for mapping constraints on coefficients
1847 * for "src" (node i) and "dst" (node j) to the corresponding positions
1848 * in graph->lp.
1849 * "offset" is the offset of the coefficients for the variables of "src"
1850 * in the input constraints.
1851 * "s" is the sign of the mapping.
1853 * The input constraints are given in terms of the coefficients
1854 * (c_0, c_n, c_x, c_y).
1855 * The mapping produced by this function essentially plugs in
1856 * (c_j_0 - c_i_0, c_j_n - c_i_n,
1857 * -(c_i_x^+ - c_i_x^-), c_j_x^+ - c_j_x^-) if s = 1 and
1858 * (-c_j_0 + c_i_0, -c_j_n + c_i_n,
1859 * c_i_x^+ - c_i_x^-, -(c_j_x^+ - c_j_x^-)) if s = -1.
1860 * In graph->lp, the c_*^- appear before their c_*^+ counterpart.
1861 * Furthermore, the order of these pairs is the opposite of that
1862 * of the corresponding coefficients.
1864 * The caller can further extend the mapping.
1866 static __isl_give isl_dim_map *inter_dim_map(isl_ctx *ctx,
1867 struct isl_sched_graph *graph, struct isl_sched_node *src,
1868 struct isl_sched_node *dst, int offset, int s)
1870 int pos;
1871 isl_size total;
1872 isl_dim_map *dim_map;
1874 total = isl_basic_set_dim(graph->lp, isl_dim_all);
1875 if (!src || !dst || total < 0)
1876 return NULL;
1878 dim_map = isl_dim_map_alloc(ctx, total);
1880 pos = node_cst_coef_offset(dst);
1881 isl_dim_map_range(dim_map, pos, 0, 0, 0, 1, s);
1882 pos = node_par_coef_offset(dst);
1883 isl_dim_map_range(dim_map, pos, 1, 1, 1, dst->nparam, s);
1884 pos = node_var_coef_pos(dst, 0);
1885 isl_dim_map_range(dim_map, pos, -2, offset + src->nvar, 1,
1886 dst->nvar, -s);
1887 isl_dim_map_range(dim_map, pos + 1, -2, offset + src->nvar, 1,
1888 dst->nvar, s);
1890 pos = node_cst_coef_offset(src);
1891 isl_dim_map_range(dim_map, pos, 0, 0, 0, 1, -s);
1892 pos = node_par_coef_offset(src);
1893 isl_dim_map_range(dim_map, pos, 1, 1, 1, src->nparam, -s);
1894 pos = node_var_coef_pos(src, 0);
1895 isl_dim_map_range(dim_map, pos, -2, offset, 1, src->nvar, s);
1896 isl_dim_map_range(dim_map, pos + 1, -2, offset, 1, src->nvar, -s);
1898 return dim_map;
1901 /* Add the constraints from "src" to "dst" using "dim_map",
1902 * after making sure there is enough room in "dst" for the extra constraints.
1904 static __isl_give isl_basic_set *add_constraints_dim_map(
1905 __isl_take isl_basic_set *dst, __isl_take isl_basic_set *src,
1906 __isl_take isl_dim_map *dim_map)
1908 int n_eq, n_ineq;
1910 n_eq = isl_basic_set_n_equality(src);
1911 n_ineq = isl_basic_set_n_inequality(src);
1912 dst = isl_basic_set_extend_constraints(dst, n_eq, n_ineq);
1913 dst = isl_basic_set_add_constraints_dim_map(dst, src, dim_map);
1914 return dst;
1917 /* Add constraints to graph->lp that force validity for the given
1918 * dependence from a node i to itself.
1919 * That is, add constraints that enforce
1921 * (c_i_0 + c_i_n n + c_i_x y) - (c_i_0 + c_i_n n + c_i_x x)
1922 * = c_i_x (y - x) >= 0
1924 * for each (x,y) in R.
1925 * We obtain general constraints on coefficients (c_0, c_x)
1926 * of valid constraints for (y - x) and then plug in (0, c_i_x^+ - c_i_x^-),
1927 * where c_i_x = c_i_x^+ - c_i_x^-, with c_i_x^+ and c_i_x^- non-negative.
1928 * In graph->lp, the c_i_x^- appear before their c_i_x^+ counterpart.
1929 * Note that the result of intra_coefficients may also contain
1930 * parameter coefficients c_n, in which case 0 is plugged in for them as well.
1932 static isl_stat add_intra_validity_constraints(struct isl_sched_graph *graph,
1933 struct isl_sched_edge *edge)
1935 isl_size offset;
1936 isl_map *map = isl_map_copy(edge->map);
1937 isl_ctx *ctx = isl_map_get_ctx(map);
1938 isl_dim_map *dim_map;
1939 isl_basic_set *coef;
1940 struct isl_sched_node *node = edge->src;
1942 coef = intra_coefficients(graph, node, map, 0);
1944 offset = coef_var_offset(coef);
1945 if (offset < 0)
1946 coef = isl_basic_set_free(coef);
1947 if (!coef)
1948 return isl_stat_error;
1950 dim_map = intra_dim_map(ctx, graph, node, offset, 1);
1951 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
1953 return isl_stat_ok;
1956 /* Add constraints to graph->lp that force validity for the given
1957 * dependence from node i to node j.
1958 * That is, add constraints that enforce
1960 * (c_j_0 + c_j_n n + c_j_x y) - (c_i_0 + c_i_n n + c_i_x x) >= 0
1962 * for each (x,y) in R.
1963 * We obtain general constraints on coefficients (c_0, c_n, c_x, c_y)
1964 * of valid constraints for R and then plug in
1965 * (c_j_0 - c_i_0, c_j_n - c_i_n, -(c_i_x^+ - c_i_x^-), c_j_x^+ - c_j_x^-),
1966 * where c_* = c_*^+ - c_*^-, with c_*^+ and c_*^- non-negative.
1967 * In graph->lp, the c_*^- appear before their c_*^+ counterpart.
1969 static isl_stat add_inter_validity_constraints(struct isl_sched_graph *graph,
1970 struct isl_sched_edge *edge)
1972 isl_size offset;
1973 isl_map *map;
1974 isl_ctx *ctx;
1975 isl_dim_map *dim_map;
1976 isl_basic_set *coef;
1977 struct isl_sched_node *src = edge->src;
1978 struct isl_sched_node *dst = edge->dst;
1980 if (!graph->lp)
1981 return isl_stat_error;
1983 map = isl_map_copy(edge->map);
1984 ctx = isl_map_get_ctx(map);
1985 coef = inter_coefficients(graph, edge, map);
1987 offset = coef_var_offset(coef);
1988 if (offset < 0)
1989 coef = isl_basic_set_free(coef);
1990 if (!coef)
1991 return isl_stat_error;
1993 dim_map = inter_dim_map(ctx, graph, src, dst, offset, 1);
1995 edge->start = graph->lp->n_ineq;
1996 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
1997 if (!graph->lp)
1998 return isl_stat_error;
1999 edge->end = graph->lp->n_ineq;
2001 return isl_stat_ok;
2004 /* Add constraints to graph->lp that bound the dependence distance for the given
2005 * dependence from a node i to itself.
2006 * If s = 1, we add the constraint
2008 * c_i_x (y - x) <= m_0 + m_n n
2010 * or
2012 * -c_i_x (y - x) + m_0 + m_n n >= 0
2014 * for each (x,y) in R.
2015 * If s = -1, we add the constraint
2017 * -c_i_x (y - x) <= m_0 + m_n n
2019 * or
2021 * c_i_x (y - x) + m_0 + m_n n >= 0
2023 * for each (x,y) in R.
2024 * We obtain general constraints on coefficients (c_0, c_n, c_x)
2025 * of valid constraints for (y - x) and then plug in (m_0, m_n, -s * c_i_x),
2026 * with each coefficient (except m_0) represented as a pair of non-negative
2027 * coefficients.
2030 * If "local" is set, then we add constraints
2032 * c_i_x (y - x) <= 0
2034 * or
2036 * -c_i_x (y - x) <= 0
2038 * instead, forcing the dependence distance to be (less than or) equal to 0.
2039 * That is, we plug in (0, 0, -s * c_i_x),
2040 * intra_coefficients is not required to have c_n in its result when
2041 * "local" is set. If they are missing, then (0, -s * c_i_x) is plugged in.
2042 * Note that dependences marked local are treated as validity constraints
2043 * by add_all_validity_constraints and therefore also have
2044 * their distances bounded by 0 from below.
2046 static isl_stat add_intra_proximity_constraints(struct isl_sched_graph *graph,
2047 struct isl_sched_edge *edge, int s, int local)
2049 isl_size offset;
2050 isl_size nparam;
2051 isl_map *map = isl_map_copy(edge->map);
2052 isl_ctx *ctx = isl_map_get_ctx(map);
2053 isl_dim_map *dim_map;
2054 isl_basic_set *coef;
2055 struct isl_sched_node *node = edge->src;
2057 coef = intra_coefficients(graph, node, map, !local);
2058 nparam = isl_space_dim(node->space, isl_dim_param);
2060 offset = coef_var_offset(coef);
2061 if (nparam < 0 || offset < 0)
2062 coef = isl_basic_set_free(coef);
2063 if (!coef)
2064 return isl_stat_error;
2066 dim_map = intra_dim_map(ctx, graph, node, offset, -s);
2068 if (!local) {
2069 isl_dim_map_range(dim_map, 1, 0, 0, 0, 1, 1);
2070 isl_dim_map_range(dim_map, 4, 2, 1, 1, nparam, -1);
2071 isl_dim_map_range(dim_map, 5, 2, 1, 1, nparam, 1);
2073 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
2075 return isl_stat_ok;
2078 /* Add constraints to graph->lp that bound the dependence distance for the given
2079 * dependence from node i to node j.
2080 * If s = 1, we add the constraint
2082 * (c_j_0 + c_j_n n + c_j_x y) - (c_i_0 + c_i_n n + c_i_x x)
2083 * <= m_0 + m_n n
2085 * or
2087 * -(c_j_0 + c_j_n n + c_j_x y) + (c_i_0 + c_i_n n + c_i_x x) +
2088 * m_0 + m_n n >= 0
2090 * for each (x,y) in R.
2091 * If s = -1, we add the constraint
2093 * -((c_j_0 + c_j_n n + c_j_x y) - (c_i_0 + c_i_n n + c_i_x x))
2094 * <= m_0 + m_n n
2096 * or
2098 * (c_j_0 + c_j_n n + c_j_x y) - (c_i_0 + c_i_n n + c_i_x x) +
2099 * m_0 + m_n n >= 0
2101 * for each (x,y) in R.
2102 * We obtain general constraints on coefficients (c_0, c_n, c_x, c_y)
2103 * of valid constraints for R and then plug in
2104 * (m_0 - s*c_j_0 + s*c_i_0, m_n - s*c_j_n + s*c_i_n,
2105 * s*c_i_x, -s*c_j_x)
2106 * with each coefficient (except m_0, c_*_0 and c_*_n)
2107 * represented as a pair of non-negative coefficients.
2110 * If "local" is set (and s = 1), then we add constraints
2112 * (c_j_0 + c_j_n n + c_j_x y) - (c_i_0 + c_i_n n + c_i_x x) <= 0
2114 * or
2116 * -((c_j_0 + c_j_n n + c_j_x y) + (c_i_0 + c_i_n n + c_i_x x)) >= 0
2118 * instead, forcing the dependence distance to be (less than or) equal to 0.
2119 * That is, we plug in
2120 * (-s*c_j_0 + s*c_i_0, -s*c_j_n + s*c_i_n, s*c_i_x, -s*c_j_x).
2121 * Note that dependences marked local are treated as validity constraints
2122 * by add_all_validity_constraints and therefore also have
2123 * their distances bounded by 0 from below.
2125 static isl_stat add_inter_proximity_constraints(struct isl_sched_graph *graph,
2126 struct isl_sched_edge *edge, int s, int local)
2128 isl_size offset;
2129 isl_size nparam;
2130 isl_map *map = isl_map_copy(edge->map);
2131 isl_ctx *ctx = isl_map_get_ctx(map);
2132 isl_dim_map *dim_map;
2133 isl_basic_set *coef;
2134 struct isl_sched_node *src = edge->src;
2135 struct isl_sched_node *dst = edge->dst;
2137 coef = inter_coefficients(graph, edge, map);
2138 nparam = isl_space_dim(src->space, isl_dim_param);
2140 offset = coef_var_offset(coef);
2141 if (nparam < 0 || offset < 0)
2142 coef = isl_basic_set_free(coef);
2143 if (!coef)
2144 return isl_stat_error;
2146 dim_map = inter_dim_map(ctx, graph, src, dst, offset, -s);
2148 if (!local) {
2149 isl_dim_map_range(dim_map, 1, 0, 0, 0, 1, 1);
2150 isl_dim_map_range(dim_map, 4, 2, 1, 1, nparam, -1);
2151 isl_dim_map_range(dim_map, 5, 2, 1, 1, nparam, 1);
2154 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
2156 return isl_stat_ok;
2159 /* Should the distance over "edge" be forced to zero?
2160 * That is, is it marked as a local edge?
2161 * If "use_coincidence" is set, then coincidence edges are treated
2162 * as local edges.
2164 static int force_zero(struct isl_sched_edge *edge, int use_coincidence)
2166 return is_local(edge) || (use_coincidence && is_coincidence(edge));
2169 /* Add all validity constraints to graph->lp.
2171 * An edge that is forced to be local needs to have its dependence
2172 * distances equal to zero. We take care of bounding them by 0 from below
2173 * here. add_all_proximity_constraints takes care of bounding them by 0
2174 * from above.
2176 * If "use_coincidence" is set, then we treat coincidence edges as local edges.
2177 * Otherwise, we ignore them.
2179 static int add_all_validity_constraints(struct isl_sched_graph *graph,
2180 int use_coincidence)
2182 int i;
2184 for (i = 0; i < graph->n_edge; ++i) {
2185 struct isl_sched_edge *edge = &graph->edge[i];
2186 int zero;
2188 zero = force_zero(edge, use_coincidence);
2189 if (!is_validity(edge) && !zero)
2190 continue;
2191 if (edge->src != edge->dst)
2192 continue;
2193 if (add_intra_validity_constraints(graph, edge) < 0)
2194 return -1;
2197 for (i = 0; i < graph->n_edge; ++i) {
2198 struct isl_sched_edge *edge = &graph->edge[i];
2199 int zero;
2201 zero = force_zero(edge, use_coincidence);
2202 if (!is_validity(edge) && !zero)
2203 continue;
2204 if (edge->src == edge->dst)
2205 continue;
2206 if (add_inter_validity_constraints(graph, edge) < 0)
2207 return -1;
2210 return 0;
2213 /* Add constraints to graph->lp that bound the dependence distance
2214 * for all dependence relations.
2215 * If a given proximity dependence is identical to a validity
2216 * dependence, then the dependence distance is already bounded
2217 * from below (by zero), so we only need to bound the distance
2218 * from above. (This includes the case of "local" dependences
2219 * which are treated as validity dependence by add_all_validity_constraints.)
2220 * Otherwise, we need to bound the distance both from above and from below.
2222 * If "use_coincidence" is set, then we treat coincidence edges as local edges.
2223 * Otherwise, we ignore them.
2225 static int add_all_proximity_constraints(struct isl_sched_graph *graph,
2226 int use_coincidence)
2228 int i;
2230 for (i = 0; i < graph->n_edge; ++i) {
2231 struct isl_sched_edge *edge = &graph->edge[i];
2232 int zero;
2234 zero = force_zero(edge, use_coincidence);
2235 if (!is_proximity(edge) && !zero)
2236 continue;
2237 if (edge->src == edge->dst &&
2238 add_intra_proximity_constraints(graph, edge, 1, zero) < 0)
2239 return -1;
2240 if (edge->src != edge->dst &&
2241 add_inter_proximity_constraints(graph, edge, 1, zero) < 0)
2242 return -1;
2243 if (is_validity(edge) || zero)
2244 continue;
2245 if (edge->src == edge->dst &&
2246 add_intra_proximity_constraints(graph, edge, -1, 0) < 0)
2247 return -1;
2248 if (edge->src != edge->dst &&
2249 add_inter_proximity_constraints(graph, edge, -1, 0) < 0)
2250 return -1;
2253 return 0;
2256 /* Normalize the rows of "indep" such that all rows are lexicographically
2257 * positive and such that each row contains as many final zeros as possible,
2258 * given the choice for the previous rows.
2259 * Do this by performing elementary row operations.
2261 static __isl_give isl_mat *normalize_independent(__isl_take isl_mat *indep)
2263 indep = isl_mat_reverse_gauss(indep);
2264 indep = isl_mat_lexnonneg_rows(indep);
2265 return indep;
2268 /* Extract the linear part of the current schedule for node "node".
2270 static __isl_give isl_mat *extract_linear_schedule(struct isl_sched_node *node)
2272 isl_size n_row = isl_mat_rows(node->sched);
2274 if (n_row < 0)
2275 return NULL;
2276 return isl_mat_sub_alloc(node->sched, 0, n_row,
2277 1 + node->nparam, node->nvar);
2280 /* Compute a basis for the rows in the linear part of the schedule
2281 * and extend this basis to a full basis. The remaining rows
2282 * can then be used to force linear independence from the rows
2283 * in the schedule.
2285 * In particular, given the schedule rows S, we compute
2287 * S = H Q
2288 * S U = H
2290 * with H the Hermite normal form of S. That is, all but the
2291 * first rank columns of H are zero and so each row in S is
2292 * a linear combination of the first rank rows of Q.
2293 * The matrix Q can be used as a variable transformation
2294 * that isolates the directions of S in the first rank rows.
2295 * Transposing S U = H yields
2297 * U^T S^T = H^T
2299 * with all but the first rank rows of H^T zero.
2300 * The last rows of U^T are therefore linear combinations
2301 * of schedule coefficients that are all zero on schedule
2302 * coefficients that are linearly dependent on the rows of S.
2303 * At least one of these combinations is non-zero on
2304 * linearly independent schedule coefficients.
2305 * The rows are normalized to involve as few of the last
2306 * coefficients as possible and to have a positive initial value.
2308 static int node_update_vmap(struct isl_sched_node *node)
2310 isl_mat *H, *U, *Q;
2312 H = extract_linear_schedule(node);
2314 H = isl_mat_left_hermite(H, 0, &U, &Q);
2315 isl_mat_free(node->indep);
2316 isl_mat_free(node->vmap);
2317 node->vmap = Q;
2318 node->indep = isl_mat_transpose(U);
2319 node->rank = isl_mat_initial_non_zero_cols(H);
2320 node->indep = isl_mat_drop_rows(node->indep, 0, node->rank);
2321 node->indep = normalize_independent(node->indep);
2322 isl_mat_free(H);
2324 if (!node->indep || !node->vmap || node->rank < 0)
2325 return -1;
2326 return 0;
2329 /* Is "edge" marked as a validity or a conditional validity edge?
2331 static int is_any_validity(struct isl_sched_edge *edge)
2333 return is_validity(edge) || is_conditional_validity(edge);
2336 /* How many times should we count the constraints in "edge"?
2338 * We count as follows
2339 * validity -> 1 (>= 0)
2340 * validity+proximity -> 2 (>= 0 and upper bound)
2341 * proximity -> 2 (lower and upper bound)
2342 * local(+any) -> 2 (>= 0 and <= 0)
2344 * If an edge is only marked conditional_validity then it counts
2345 * as zero since it is only checked afterwards.
2347 * If "use_coincidence" is set, then we treat coincidence edges as local edges.
2348 * Otherwise, we ignore them.
2350 static int edge_multiplicity(struct isl_sched_edge *edge, int use_coincidence)
2352 if (is_proximity(edge) || force_zero(edge, use_coincidence))
2353 return 2;
2354 if (is_validity(edge))
2355 return 1;
2356 return 0;
2359 /* How many times should the constraints in "edge" be counted
2360 * as a parametric intra-node constraint?
2362 * Only proximity edges that are not forced zero need
2363 * coefficient constraints that include coefficients for parameters.
2364 * If the edge is also a validity edge, then only
2365 * an upper bound is introduced. Otherwise, both lower and upper bounds
2366 * are introduced.
2368 static int parametric_intra_edge_multiplicity(struct isl_sched_edge *edge,
2369 int use_coincidence)
2371 if (edge->src != edge->dst)
2372 return 0;
2373 if (!is_proximity(edge))
2374 return 0;
2375 if (force_zero(edge, use_coincidence))
2376 return 0;
2377 if (is_validity(edge))
2378 return 1;
2379 else
2380 return 2;
2383 /* Add "f" times the number of equality and inequality constraints of "bset"
2384 * to "n_eq" and "n_ineq" and free "bset".
2386 static isl_stat update_count(__isl_take isl_basic_set *bset,
2387 int f, int *n_eq, int *n_ineq)
2389 if (!bset)
2390 return isl_stat_error;
2392 *n_eq += isl_basic_set_n_equality(bset);
2393 *n_ineq += isl_basic_set_n_inequality(bset);
2394 isl_basic_set_free(bset);
2396 return isl_stat_ok;
2399 /* Count the number of equality and inequality constraints
2400 * that will be added for the given map.
2402 * The edges that require parameter coefficients are counted separately.
2404 * "use_coincidence" is set if we should take into account coincidence edges.
2406 static isl_stat count_map_constraints(struct isl_sched_graph *graph,
2407 struct isl_sched_edge *edge, __isl_take isl_map *map,
2408 int *n_eq, int *n_ineq, int use_coincidence)
2410 isl_map *copy;
2411 isl_basic_set *coef;
2412 int f = edge_multiplicity(edge, use_coincidence);
2413 int fp = parametric_intra_edge_multiplicity(edge, use_coincidence);
2415 if (f == 0) {
2416 isl_map_free(map);
2417 return isl_stat_ok;
2420 if (edge->src != edge->dst) {
2421 coef = inter_coefficients(graph, edge, map);
2422 return update_count(coef, f, n_eq, n_ineq);
2425 if (fp > 0) {
2426 copy = isl_map_copy(map);
2427 coef = intra_coefficients(graph, edge->src, copy, 1);
2428 if (update_count(coef, fp, n_eq, n_ineq) < 0)
2429 goto error;
2432 if (f > fp) {
2433 copy = isl_map_copy(map);
2434 coef = intra_coefficients(graph, edge->src, copy, 0);
2435 if (update_count(coef, f - fp, n_eq, n_ineq) < 0)
2436 goto error;
2439 isl_map_free(map);
2440 return isl_stat_ok;
2441 error:
2442 isl_map_free(map);
2443 return isl_stat_error;
2446 /* Count the number of equality and inequality constraints
2447 * that will be added to the main lp problem.
2448 * We count as follows
2449 * validity -> 1 (>= 0)
2450 * validity+proximity -> 2 (>= 0 and upper bound)
2451 * proximity -> 2 (lower and upper bound)
2452 * local(+any) -> 2 (>= 0 and <= 0)
2454 * If "use_coincidence" is set, then we treat coincidence edges as local edges.
2455 * Otherwise, we ignore them.
2457 static int count_constraints(struct isl_sched_graph *graph,
2458 int *n_eq, int *n_ineq, int use_coincidence)
2460 int i;
2462 *n_eq = *n_ineq = 0;
2463 for (i = 0; i < graph->n_edge; ++i) {
2464 struct isl_sched_edge *edge = &graph->edge[i];
2465 isl_map *map = isl_map_copy(edge->map);
2467 if (count_map_constraints(graph, edge, map, n_eq, n_ineq,
2468 use_coincidence) < 0)
2469 return -1;
2472 return 0;
2475 /* Count the number of constraints that will be added by
2476 * add_bound_constant_constraints to bound the values of the constant terms
2477 * and increment *n_eq and *n_ineq accordingly.
2479 * In practice, add_bound_constant_constraints only adds inequalities.
2481 static isl_stat count_bound_constant_constraints(isl_ctx *ctx,
2482 struct isl_sched_graph *graph, int *n_eq, int *n_ineq)
2484 if (isl_options_get_schedule_max_constant_term(ctx) == -1)
2485 return isl_stat_ok;
2487 *n_ineq += graph->n;
2489 return isl_stat_ok;
2492 /* Add constraints to bound the values of the constant terms in the schedule,
2493 * if requested by the user.
2495 * The maximal value of the constant terms is defined by the option
2496 * "schedule_max_constant_term".
2498 static isl_stat add_bound_constant_constraints(isl_ctx *ctx,
2499 struct isl_sched_graph *graph)
2501 int i, k;
2502 int max;
2503 isl_size total;
2505 max = isl_options_get_schedule_max_constant_term(ctx);
2506 if (max == -1)
2507 return isl_stat_ok;
2509 total = isl_basic_set_dim(graph->lp, isl_dim_set);
2510 if (total < 0)
2511 return isl_stat_error;
2513 for (i = 0; i < graph->n; ++i) {
2514 struct isl_sched_node *node = &graph->node[i];
2515 int pos;
2517 k = isl_basic_set_alloc_inequality(graph->lp);
2518 if (k < 0)
2519 return isl_stat_error;
2520 isl_seq_clr(graph->lp->ineq[k], 1 + total);
2521 pos = node_cst_coef_offset(node);
2522 isl_int_set_si(graph->lp->ineq[k][1 + pos], -1);
2523 isl_int_set_si(graph->lp->ineq[k][0], max);
2526 return isl_stat_ok;
2529 /* Count the number of constraints that will be added by
2530 * add_bound_coefficient_constraints and increment *n_eq and *n_ineq
2531 * accordingly.
2533 * In practice, add_bound_coefficient_constraints only adds inequalities.
2535 static int count_bound_coefficient_constraints(isl_ctx *ctx,
2536 struct isl_sched_graph *graph, int *n_eq, int *n_ineq)
2538 int i;
2540 if (isl_options_get_schedule_max_coefficient(ctx) == -1 &&
2541 !isl_options_get_schedule_treat_coalescing(ctx))
2542 return 0;
2544 for (i = 0; i < graph->n; ++i)
2545 *n_ineq += graph->node[i].nparam + 2 * graph->node[i].nvar;
2547 return 0;
2550 /* Add constraints to graph->lp that bound the values of
2551 * the parameter schedule coefficients of "node" to "max" and
2552 * the variable schedule coefficients to the corresponding entry
2553 * in node->max.
2554 * In either case, a negative value means that no bound needs to be imposed.
2556 * For parameter coefficients, this amounts to adding a constraint
2558 * c_n <= max
2560 * i.e.,
2562 * -c_n + max >= 0
2564 * The variables coefficients are, however, not represented directly.
2565 * Instead, the variable coefficients c_x are written as differences
2566 * c_x = c_x^+ - c_x^-.
2567 * That is,
2569 * -max_i <= c_x_i <= max_i
2571 * is encoded as
2573 * -max_i <= c_x_i^+ - c_x_i^- <= max_i
2575 * or
2577 * -(c_x_i^+ - c_x_i^-) + max_i >= 0
2578 * c_x_i^+ - c_x_i^- + max_i >= 0
2580 static isl_stat node_add_coefficient_constraints(isl_ctx *ctx,
2581 struct isl_sched_graph *graph, struct isl_sched_node *node, int max)
2583 int i, j, k;
2584 isl_size total;
2585 isl_vec *ineq;
2587 total = isl_basic_set_dim(graph->lp, isl_dim_set);
2588 if (total < 0)
2589 return isl_stat_error;
2591 for (j = 0; j < node->nparam; ++j) {
2592 int dim;
2594 if (max < 0)
2595 continue;
2597 k = isl_basic_set_alloc_inequality(graph->lp);
2598 if (k < 0)
2599 return isl_stat_error;
2600 dim = 1 + node_par_coef_offset(node) + j;
2601 isl_seq_clr(graph->lp->ineq[k], 1 + total);
2602 isl_int_set_si(graph->lp->ineq[k][dim], -1);
2603 isl_int_set_si(graph->lp->ineq[k][0], max);
2606 ineq = isl_vec_alloc(ctx, 1 + total);
2607 ineq = isl_vec_clr(ineq);
2608 if (!ineq)
2609 return isl_stat_error;
2610 for (i = 0; i < node->nvar; ++i) {
2611 int pos = 1 + node_var_coef_pos(node, i);
2613 if (isl_int_is_neg(node->max->el[i]))
2614 continue;
2616 isl_int_set_si(ineq->el[pos], 1);
2617 isl_int_set_si(ineq->el[pos + 1], -1);
2618 isl_int_set(ineq->el[0], node->max->el[i]);
2620 k = isl_basic_set_alloc_inequality(graph->lp);
2621 if (k < 0)
2622 goto error;
2623 isl_seq_cpy(graph->lp->ineq[k], ineq->el, 1 + total);
2625 isl_seq_neg(ineq->el + pos, ineq->el + pos, 2);
2626 k = isl_basic_set_alloc_inequality(graph->lp);
2627 if (k < 0)
2628 goto error;
2629 isl_seq_cpy(graph->lp->ineq[k], ineq->el, 1 + total);
2631 isl_seq_clr(ineq->el + pos, 2);
2633 isl_vec_free(ineq);
2635 return isl_stat_ok;
2636 error:
2637 isl_vec_free(ineq);
2638 return isl_stat_error;
2641 /* Add constraints that bound the values of the variable and parameter
2642 * coefficients of the schedule.
2644 * The maximal value of the coefficients is defined by the option
2645 * 'schedule_max_coefficient' and the entries in node->max.
2646 * These latter entries are only set if either the schedule_max_coefficient
2647 * option or the schedule_treat_coalescing option is set.
2649 static isl_stat add_bound_coefficient_constraints(isl_ctx *ctx,
2650 struct isl_sched_graph *graph)
2652 int i;
2653 int max;
2655 max = isl_options_get_schedule_max_coefficient(ctx);
2657 if (max == -1 && !isl_options_get_schedule_treat_coalescing(ctx))
2658 return isl_stat_ok;
2660 for (i = 0; i < graph->n; ++i) {
2661 struct isl_sched_node *node = &graph->node[i];
2663 if (node_add_coefficient_constraints(ctx, graph, node, max) < 0)
2664 return isl_stat_error;
2667 return isl_stat_ok;
2670 /* Add a constraint to graph->lp that equates the value at position
2671 * "sum_pos" to the sum of the "n" values starting at "first".
2673 static isl_stat add_sum_constraint(struct isl_sched_graph *graph,
2674 int sum_pos, int first, int n)
2676 int i, k;
2677 isl_size total;
2679 total = isl_basic_set_dim(graph->lp, isl_dim_set);
2680 if (total < 0)
2681 return isl_stat_error;
2683 k = isl_basic_set_alloc_equality(graph->lp);
2684 if (k < 0)
2685 return isl_stat_error;
2686 isl_seq_clr(graph->lp->eq[k], 1 + total);
2687 isl_int_set_si(graph->lp->eq[k][1 + sum_pos], -1);
2688 for (i = 0; i < n; ++i)
2689 isl_int_set_si(graph->lp->eq[k][1 + first + i], 1);
2691 return isl_stat_ok;
2694 /* Add a constraint to graph->lp that equates the value at position
2695 * "sum_pos" to the sum of the parameter coefficients of all nodes.
2697 static isl_stat add_param_sum_constraint(struct isl_sched_graph *graph,
2698 int sum_pos)
2700 int i, j, k;
2701 isl_size total;
2703 total = isl_basic_set_dim(graph->lp, isl_dim_set);
2704 if (total < 0)
2705 return isl_stat_error;
2707 k = isl_basic_set_alloc_equality(graph->lp);
2708 if (k < 0)
2709 return isl_stat_error;
2710 isl_seq_clr(graph->lp->eq[k], 1 + total);
2711 isl_int_set_si(graph->lp->eq[k][1 + sum_pos], -1);
2712 for (i = 0; i < graph->n; ++i) {
2713 int pos = 1 + node_par_coef_offset(&graph->node[i]);
2715 for (j = 0; j < graph->node[i].nparam; ++j)
2716 isl_int_set_si(graph->lp->eq[k][pos + j], 1);
2719 return isl_stat_ok;
2722 /* Add a constraint to graph->lp that equates the value at position
2723 * "sum_pos" to the sum of the variable coefficients of all nodes.
2725 static isl_stat add_var_sum_constraint(struct isl_sched_graph *graph,
2726 int sum_pos)
2728 int i, j, k;
2729 isl_size total;
2731 total = isl_basic_set_dim(graph->lp, isl_dim_set);
2732 if (total < 0)
2733 return isl_stat_error;
2735 k = isl_basic_set_alloc_equality(graph->lp);
2736 if (k < 0)
2737 return isl_stat_error;
2738 isl_seq_clr(graph->lp->eq[k], 1 + total);
2739 isl_int_set_si(graph->lp->eq[k][1 + sum_pos], -1);
2740 for (i = 0; i < graph->n; ++i) {
2741 struct isl_sched_node *node = &graph->node[i];
2742 int pos = 1 + node_var_coef_offset(node);
2744 for (j = 0; j < 2 * node->nvar; ++j)
2745 isl_int_set_si(graph->lp->eq[k][pos + j], 1);
2748 return isl_stat_ok;
2751 /* Construct an ILP problem for finding schedule coefficients
2752 * that result in non-negative, but small dependence distances
2753 * over all dependences.
2754 * In particular, the dependence distances over proximity edges
2755 * are bounded by m_0 + m_n n and we compute schedule coefficients
2756 * with small values (preferably zero) of m_n and m_0.
2758 * All variables of the ILP are non-negative. The actual coefficients
2759 * may be negative, so each coefficient is represented as the difference
2760 * of two non-negative variables. The negative part always appears
2761 * immediately before the positive part.
2762 * Other than that, the variables have the following order
2764 * - sum of positive and negative parts of m_n coefficients
2765 * - m_0
2766 * - sum of all c_n coefficients
2767 * (unconstrained when computing non-parametric schedules)
2768 * - sum of positive and negative parts of all c_x coefficients
2769 * - positive and negative parts of m_n coefficients
2770 * - for each node
2771 * - positive and negative parts of c_i_x, in opposite order
2772 * - c_i_n (if parametric)
2773 * - c_i_0
2775 * The constraints are those from the edges plus two or three equalities
2776 * to express the sums.
2778 * If "use_coincidence" is set, then we treat coincidence edges as local edges.
2779 * Otherwise, we ignore them.
2781 static isl_stat setup_lp(isl_ctx *ctx, struct isl_sched_graph *graph,
2782 int use_coincidence)
2784 int i;
2785 isl_size nparam;
2786 unsigned total;
2787 isl_space *space;
2788 int parametric;
2789 int param_pos;
2790 int n_eq, n_ineq;
2792 parametric = ctx->opt->schedule_parametric;
2793 nparam = isl_space_dim(graph->node[0].space, isl_dim_param);
2794 if (nparam < 0)
2795 return isl_stat_error;
2796 param_pos = 4;
2797 total = param_pos + 2 * nparam;
2798 for (i = 0; i < graph->n; ++i) {
2799 struct isl_sched_node *node = &graph->node[graph->sorted[i]];
2800 if (node_update_vmap(node) < 0)
2801 return isl_stat_error;
2802 node->start = total;
2803 total += 1 + node->nparam + 2 * node->nvar;
2806 if (count_constraints(graph, &n_eq, &n_ineq, use_coincidence) < 0)
2807 return isl_stat_error;
2808 if (count_bound_constant_constraints(ctx, graph, &n_eq, &n_ineq) < 0)
2809 return isl_stat_error;
2810 if (count_bound_coefficient_constraints(ctx, graph, &n_eq, &n_ineq) < 0)
2811 return isl_stat_error;
2813 space = isl_space_set_alloc(ctx, 0, total);
2814 isl_basic_set_free(graph->lp);
2815 n_eq += 2 + parametric;
2817 graph->lp = isl_basic_set_alloc_space(space, 0, n_eq, n_ineq);
2819 if (add_sum_constraint(graph, 0, param_pos, 2 * nparam) < 0)
2820 return isl_stat_error;
2821 if (parametric && add_param_sum_constraint(graph, 2) < 0)
2822 return isl_stat_error;
2823 if (add_var_sum_constraint(graph, 3) < 0)
2824 return isl_stat_error;
2825 if (add_bound_constant_constraints(ctx, graph) < 0)
2826 return isl_stat_error;
2827 if (add_bound_coefficient_constraints(ctx, graph) < 0)
2828 return isl_stat_error;
2829 if (add_all_validity_constraints(graph, use_coincidence) < 0)
2830 return isl_stat_error;
2831 if (add_all_proximity_constraints(graph, use_coincidence) < 0)
2832 return isl_stat_error;
2834 return isl_stat_ok;
2837 /* Analyze the conflicting constraint found by
2838 * isl_tab_basic_set_non_trivial_lexmin. If it corresponds to the validity
2839 * constraint of one of the edges between distinct nodes, living, moreover
2840 * in distinct SCCs, then record the source and sink SCC as this may
2841 * be a good place to cut between SCCs.
2843 static int check_conflict(int con, void *user)
2845 int i;
2846 struct isl_sched_graph *graph = user;
2848 if (graph->src_scc >= 0)
2849 return 0;
2851 con -= graph->lp->n_eq;
2853 if (con >= graph->lp->n_ineq)
2854 return 0;
2856 for (i = 0; i < graph->n_edge; ++i) {
2857 if (!is_validity(&graph->edge[i]))
2858 continue;
2859 if (graph->edge[i].src == graph->edge[i].dst)
2860 continue;
2861 if (graph->edge[i].src->scc == graph->edge[i].dst->scc)
2862 continue;
2863 if (graph->edge[i].start > con)
2864 continue;
2865 if (graph->edge[i].end <= con)
2866 continue;
2867 graph->src_scc = graph->edge[i].src->scc;
2868 graph->dst_scc = graph->edge[i].dst->scc;
2871 return 0;
2874 /* Check whether the next schedule row of the given node needs to be
2875 * non-trivial. Lower-dimensional domains may have some trivial rows,
2876 * but as soon as the number of remaining required non-trivial rows
2877 * is as large as the number or remaining rows to be computed,
2878 * all remaining rows need to be non-trivial.
2880 static int needs_row(struct isl_sched_graph *graph, struct isl_sched_node *node)
2882 return node->nvar - node->rank >= graph->maxvar - graph->n_row;
2885 /* Construct a non-triviality region with triviality directions
2886 * corresponding to the rows of "indep".
2887 * The rows of "indep" are expressed in terms of the schedule coefficients c_i,
2888 * while the triviality directions are expressed in terms of
2889 * pairs of non-negative variables c^+_i - c^-_i, with c^-_i appearing
2890 * before c^+_i. Furthermore,
2891 * the pairs of non-negative variables representing the coefficients
2892 * are stored in the opposite order.
2894 static __isl_give isl_mat *construct_trivial(__isl_keep isl_mat *indep)
2896 isl_ctx *ctx;
2897 isl_mat *mat;
2898 int i, j;
2899 isl_size n, n_var;
2901 n = isl_mat_rows(indep);
2902 n_var = isl_mat_cols(indep);
2903 if (n < 0 || n_var < 0)
2904 return NULL;
2906 ctx = isl_mat_get_ctx(indep);
2907 mat = isl_mat_alloc(ctx, n, 2 * n_var);
2908 if (!mat)
2909 return NULL;
2910 for (i = 0; i < n; ++i) {
2911 for (j = 0; j < n_var; ++j) {
2912 int nj = n_var - 1 - j;
2913 isl_int_neg(mat->row[i][2 * nj], indep->row[i][j]);
2914 isl_int_set(mat->row[i][2 * nj + 1], indep->row[i][j]);
2918 return mat;
2921 /* Solve the ILP problem constructed in setup_lp.
2922 * For each node such that all the remaining rows of its schedule
2923 * need to be non-trivial, we construct a non-triviality region.
2924 * This region imposes that the next row is independent of previous rows.
2925 * In particular, the non-triviality region enforces that at least
2926 * one of the linear combinations in the rows of node->indep is non-zero.
2928 static __isl_give isl_vec *solve_lp(isl_ctx *ctx, struct isl_sched_graph *graph)
2930 int i;
2931 isl_vec *sol;
2932 isl_basic_set *lp;
2934 for (i = 0; i < graph->n; ++i) {
2935 struct isl_sched_node *node = &graph->node[i];
2936 isl_mat *trivial;
2938 graph->region[i].pos = node_var_coef_offset(node);
2939 if (needs_row(graph, node))
2940 trivial = construct_trivial(node->indep);
2941 else
2942 trivial = isl_mat_zero(ctx, 0, 0);
2943 graph->region[i].trivial = trivial;
2945 lp = isl_basic_set_copy(graph->lp);
2946 sol = isl_tab_basic_set_non_trivial_lexmin(lp, 2, graph->n,
2947 graph->region, &check_conflict, graph);
2948 for (i = 0; i < graph->n; ++i)
2949 isl_mat_free(graph->region[i].trivial);
2950 return sol;
2953 /* Extract the coefficients for the variables of "node" from "sol".
2955 * Each schedule coefficient c_i_x is represented as the difference
2956 * between two non-negative variables c_i_x^+ - c_i_x^-.
2957 * The c_i_x^- appear before their c_i_x^+ counterpart.
2958 * Furthermore, the order of these pairs is the opposite of that
2959 * of the corresponding coefficients.
2961 * Return c_i_x = c_i_x^+ - c_i_x^-
2963 static __isl_give isl_vec *extract_var_coef(struct isl_sched_node *node,
2964 __isl_keep isl_vec *sol)
2966 int i;
2967 int pos;
2968 isl_vec *csol;
2970 if (!sol)
2971 return NULL;
2972 csol = isl_vec_alloc(isl_vec_get_ctx(sol), node->nvar);
2973 if (!csol)
2974 return NULL;
2976 pos = 1 + node_var_coef_offset(node);
2977 for (i = 0; i < node->nvar; ++i)
2978 isl_int_sub(csol->el[node->nvar - 1 - i],
2979 sol->el[pos + 2 * i + 1], sol->el[pos + 2 * i]);
2981 return csol;
2984 /* Update the schedules of all nodes based on the given solution
2985 * of the LP problem.
2986 * The new row is added to the current band.
2987 * All possibly negative coefficients are encoded as a difference
2988 * of two non-negative variables, so we need to perform the subtraction
2989 * here.
2991 * If coincident is set, then the caller guarantees that the new
2992 * row satisfies the coincidence constraints.
2994 static int update_schedule(struct isl_sched_graph *graph,
2995 __isl_take isl_vec *sol, int coincident)
2997 int i, j;
2998 isl_vec *csol = NULL;
3000 if (!sol)
3001 goto error;
3002 if (sol->size == 0)
3003 isl_die(sol->ctx, isl_error_internal,
3004 "no solution found", goto error);
3005 if (graph->n_total_row >= graph->max_row)
3006 isl_die(sol->ctx, isl_error_internal,
3007 "too many schedule rows", goto error);
3009 for (i = 0; i < graph->n; ++i) {
3010 struct isl_sched_node *node = &graph->node[i];
3011 int pos;
3012 isl_size row = isl_mat_rows(node->sched);
3014 isl_vec_free(csol);
3015 csol = extract_var_coef(node, sol);
3016 if (row < 0 || !csol)
3017 goto error;
3019 isl_map_free(node->sched_map);
3020 node->sched_map = NULL;
3021 node->sched = isl_mat_add_rows(node->sched, 1);
3022 if (!node->sched)
3023 goto error;
3024 pos = node_cst_coef_offset(node);
3025 node->sched = isl_mat_set_element(node->sched,
3026 row, 0, sol->el[1 + pos]);
3027 pos = node_par_coef_offset(node);
3028 for (j = 0; j < node->nparam; ++j)
3029 node->sched = isl_mat_set_element(node->sched,
3030 row, 1 + j, sol->el[1 + pos + j]);
3031 for (j = 0; j < node->nvar; ++j)
3032 node->sched = isl_mat_set_element(node->sched,
3033 row, 1 + node->nparam + j, csol->el[j]);
3034 node->coincident[graph->n_total_row] = coincident;
3036 isl_vec_free(sol);
3037 isl_vec_free(csol);
3039 graph->n_row++;
3040 graph->n_total_row++;
3042 return 0;
3043 error:
3044 isl_vec_free(sol);
3045 isl_vec_free(csol);
3046 return -1;
3049 /* Convert row "row" of node->sched into an isl_aff living in "ls"
3050 * and return this isl_aff.
3052 static __isl_give isl_aff *extract_schedule_row(__isl_take isl_local_space *ls,
3053 struct isl_sched_node *node, int row)
3055 int j;
3056 isl_int v;
3057 isl_aff *aff;
3059 isl_int_init(v);
3061 aff = isl_aff_zero_on_domain(ls);
3062 if (isl_mat_get_element(node->sched, row, 0, &v) < 0)
3063 goto error;
3064 aff = isl_aff_set_constant(aff, v);
3065 for (j = 0; j < node->nparam; ++j) {
3066 if (isl_mat_get_element(node->sched, row, 1 + j, &v) < 0)
3067 goto error;
3068 aff = isl_aff_set_coefficient(aff, isl_dim_param, j, v);
3070 for (j = 0; j < node->nvar; ++j) {
3071 if (isl_mat_get_element(node->sched, row,
3072 1 + node->nparam + j, &v) < 0)
3073 goto error;
3074 aff = isl_aff_set_coefficient(aff, isl_dim_in, j, v);
3077 isl_int_clear(v);
3079 return aff;
3080 error:
3081 isl_int_clear(v);
3082 isl_aff_free(aff);
3083 return NULL;
3086 /* Convert the "n" rows starting at "first" of node->sched into a multi_aff
3087 * and return this multi_aff.
3089 * The result is defined over the uncompressed node domain.
3091 static __isl_give isl_multi_aff *node_extract_partial_schedule_multi_aff(
3092 struct isl_sched_node *node, int first, int n)
3094 int i;
3095 isl_space *space;
3096 isl_local_space *ls;
3097 isl_aff *aff;
3098 isl_multi_aff *ma;
3099 isl_size nrow;
3101 if (!node)
3102 return NULL;
3103 nrow = isl_mat_rows(node->sched);
3104 if (nrow < 0)
3105 return NULL;
3106 if (node->compressed)
3107 space = isl_multi_aff_get_domain_space(node->decompress);
3108 else
3109 space = isl_space_copy(node->space);
3110 ls = isl_local_space_from_space(isl_space_copy(space));
3111 space = isl_space_from_domain(space);
3112 space = isl_space_add_dims(space, isl_dim_out, n);
3113 ma = isl_multi_aff_zero(space);
3115 for (i = first; i < first + n; ++i) {
3116 aff = extract_schedule_row(isl_local_space_copy(ls), node, i);
3117 ma = isl_multi_aff_set_aff(ma, i - first, aff);
3120 isl_local_space_free(ls);
3122 if (node->compressed)
3123 ma = isl_multi_aff_pullback_multi_aff(ma,
3124 isl_multi_aff_copy(node->compress));
3126 return ma;
3129 /* Convert node->sched into a multi_aff and return this multi_aff.
3131 * The result is defined over the uncompressed node domain.
3133 static __isl_give isl_multi_aff *node_extract_schedule_multi_aff(
3134 struct isl_sched_node *node)
3136 isl_size nrow;
3138 nrow = isl_mat_rows(node->sched);
3139 if (nrow < 0)
3140 return NULL;
3141 return node_extract_partial_schedule_multi_aff(node, 0, nrow);
3144 /* Convert node->sched into a map and return this map.
3146 * The result is cached in node->sched_map, which needs to be released
3147 * whenever node->sched is updated.
3148 * It is defined over the uncompressed node domain.
3150 static __isl_give isl_map *node_extract_schedule(struct isl_sched_node *node)
3152 if (!node->sched_map) {
3153 isl_multi_aff *ma;
3155 ma = node_extract_schedule_multi_aff(node);
3156 node->sched_map = isl_map_from_multi_aff(ma);
3159 return isl_map_copy(node->sched_map);
3162 /* Construct a map that can be used to update a dependence relation
3163 * based on the current schedule.
3164 * That is, construct a map expressing that source and sink
3165 * are executed within the same iteration of the current schedule.
3166 * This map can then be intersected with the dependence relation.
3167 * This is not the most efficient way, but this shouldn't be a critical
3168 * operation.
3170 static __isl_give isl_map *specializer(struct isl_sched_node *src,
3171 struct isl_sched_node *dst)
3173 isl_map *src_sched, *dst_sched;
3175 src_sched = node_extract_schedule(src);
3176 dst_sched = node_extract_schedule(dst);
3177 return isl_map_apply_range(src_sched, isl_map_reverse(dst_sched));
3180 /* Intersect the domains of the nested relations in domain and range
3181 * of "umap" with "map".
3183 static __isl_give isl_union_map *intersect_domains(
3184 __isl_take isl_union_map *umap, __isl_keep isl_map *map)
3186 isl_union_set *uset;
3188 umap = isl_union_map_zip(umap);
3189 uset = isl_union_set_from_set(isl_map_wrap(isl_map_copy(map)));
3190 umap = isl_union_map_intersect_domain(umap, uset);
3191 umap = isl_union_map_zip(umap);
3192 return umap;
3195 /* Update the dependence relation of the given edge based
3196 * on the current schedule.
3197 * If the dependence is carried completely by the current schedule, then
3198 * it is removed from the edge_tables. It is kept in the list of edges
3199 * as otherwise all edge_tables would have to be recomputed.
3201 * If the edge is of a type that can appear multiple times
3202 * between the same pair of nodes, then it is added to
3203 * the edge table (again). This prevents the situation
3204 * where none of these edges is referenced from the edge table
3205 * because the one that was referenced turned out to be empty and
3206 * was therefore removed from the table.
3208 static isl_stat update_edge(isl_ctx *ctx, struct isl_sched_graph *graph,
3209 struct isl_sched_edge *edge)
3211 int empty;
3212 isl_map *id;
3214 id = specializer(edge->src, edge->dst);
3215 edge->map = isl_map_intersect(edge->map, isl_map_copy(id));
3216 if (!edge->map)
3217 goto error;
3219 if (edge->tagged_condition) {
3220 edge->tagged_condition =
3221 intersect_domains(edge->tagged_condition, id);
3222 if (!edge->tagged_condition)
3223 goto error;
3225 if (edge->tagged_validity) {
3226 edge->tagged_validity =
3227 intersect_domains(edge->tagged_validity, id);
3228 if (!edge->tagged_validity)
3229 goto error;
3232 empty = isl_map_plain_is_empty(edge->map);
3233 if (empty < 0)
3234 goto error;
3235 if (empty) {
3236 graph_remove_edge(graph, edge);
3237 } else if (is_multi_edge_type(edge)) {
3238 if (graph_edge_tables_add(ctx, graph, edge) < 0)
3239 goto error;
3242 isl_map_free(id);
3243 return isl_stat_ok;
3244 error:
3245 isl_map_free(id);
3246 return isl_stat_error;
3249 /* Does the domain of "umap" intersect "uset"?
3251 static int domain_intersects(__isl_keep isl_union_map *umap,
3252 __isl_keep isl_union_set *uset)
3254 int empty;
3256 umap = isl_union_map_copy(umap);
3257 umap = isl_union_map_intersect_domain(umap, isl_union_set_copy(uset));
3258 empty = isl_union_map_is_empty(umap);
3259 isl_union_map_free(umap);
3261 return empty < 0 ? -1 : !empty;
3264 /* Does the range of "umap" intersect "uset"?
3266 static int range_intersects(__isl_keep isl_union_map *umap,
3267 __isl_keep isl_union_set *uset)
3269 int empty;
3271 umap = isl_union_map_copy(umap);
3272 umap = isl_union_map_intersect_range(umap, isl_union_set_copy(uset));
3273 empty = isl_union_map_is_empty(umap);
3274 isl_union_map_free(umap);
3276 return empty < 0 ? -1 : !empty;
3279 /* Are the condition dependences of "edge" local with respect to
3280 * the current schedule?
3282 * That is, are domain and range of the condition dependences mapped
3283 * to the same point?
3285 * In other words, is the condition false?
3287 static int is_condition_false(struct isl_sched_edge *edge)
3289 isl_union_map *umap;
3290 isl_map *map, *sched, *test;
3291 int empty, local;
3293 empty = isl_union_map_is_empty(edge->tagged_condition);
3294 if (empty < 0 || empty)
3295 return empty;
3297 umap = isl_union_map_copy(edge->tagged_condition);
3298 umap = isl_union_map_zip(umap);
3299 umap = isl_union_set_unwrap(isl_union_map_domain(umap));
3300 map = isl_map_from_union_map(umap);
3302 sched = node_extract_schedule(edge->src);
3303 map = isl_map_apply_domain(map, sched);
3304 sched = node_extract_schedule(edge->dst);
3305 map = isl_map_apply_range(map, sched);
3307 test = isl_map_identity(isl_map_get_space(map));
3308 local = isl_map_is_subset(map, test);
3309 isl_map_free(map);
3310 isl_map_free(test);
3312 return local;
3315 /* For each conditional validity constraint that is adjacent
3316 * to a condition with domain in condition_source or range in condition_sink,
3317 * turn it into an unconditional validity constraint.
3319 static int unconditionalize_adjacent_validity(struct isl_sched_graph *graph,
3320 __isl_take isl_union_set *condition_source,
3321 __isl_take isl_union_set *condition_sink)
3323 int i;
3325 condition_source = isl_union_set_coalesce(condition_source);
3326 condition_sink = isl_union_set_coalesce(condition_sink);
3328 for (i = 0; i < graph->n_edge; ++i) {
3329 int adjacent;
3330 isl_union_map *validity;
3332 if (!is_conditional_validity(&graph->edge[i]))
3333 continue;
3334 if (is_validity(&graph->edge[i]))
3335 continue;
3337 validity = graph->edge[i].tagged_validity;
3338 adjacent = domain_intersects(validity, condition_sink);
3339 if (adjacent >= 0 && !adjacent)
3340 adjacent = range_intersects(validity, condition_source);
3341 if (adjacent < 0)
3342 goto error;
3343 if (!adjacent)
3344 continue;
3346 set_validity(&graph->edge[i]);
3349 isl_union_set_free(condition_source);
3350 isl_union_set_free(condition_sink);
3351 return 0;
3352 error:
3353 isl_union_set_free(condition_source);
3354 isl_union_set_free(condition_sink);
3355 return -1;
3358 /* Update the dependence relations of all edges based on the current schedule
3359 * and enforce conditional validity constraints that are adjacent
3360 * to satisfied condition constraints.
3362 * First check if any of the condition constraints are satisfied
3363 * (i.e., not local to the outer schedule) and keep track of
3364 * their domain and range.
3365 * Then update all dependence relations (which removes the non-local
3366 * constraints).
3367 * Finally, if any condition constraints turned out to be satisfied,
3368 * then turn all adjacent conditional validity constraints into
3369 * unconditional validity constraints.
3371 static int update_edges(isl_ctx *ctx, struct isl_sched_graph *graph)
3373 int i;
3374 int any = 0;
3375 isl_union_set *source, *sink;
3377 source = isl_union_set_empty(isl_space_params_alloc(ctx, 0));
3378 sink = isl_union_set_empty(isl_space_params_alloc(ctx, 0));
3379 for (i = 0; i < graph->n_edge; ++i) {
3380 int local;
3381 isl_union_set *uset;
3382 isl_union_map *umap;
3384 if (!is_condition(&graph->edge[i]))
3385 continue;
3386 if (is_local(&graph->edge[i]))
3387 continue;
3388 local = is_condition_false(&graph->edge[i]);
3389 if (local < 0)
3390 goto error;
3391 if (local)
3392 continue;
3394 any = 1;
3396 umap = isl_union_map_copy(graph->edge[i].tagged_condition);
3397 uset = isl_union_map_domain(umap);
3398 source = isl_union_set_union(source, uset);
3400 umap = isl_union_map_copy(graph->edge[i].tagged_condition);
3401 uset = isl_union_map_range(umap);
3402 sink = isl_union_set_union(sink, uset);
3405 for (i = 0; i < graph->n_edge; ++i) {
3406 if (update_edge(ctx, graph, &graph->edge[i]) < 0)
3407 goto error;
3410 if (any)
3411 return unconditionalize_adjacent_validity(graph, source, sink);
3413 isl_union_set_free(source);
3414 isl_union_set_free(sink);
3415 return 0;
3416 error:
3417 isl_union_set_free(source);
3418 isl_union_set_free(sink);
3419 return -1;
3422 static void next_band(struct isl_sched_graph *graph)
3424 graph->band_start = graph->n_total_row;
3427 /* Return the union of the universe domains of the nodes in "graph"
3428 * that satisfy "pred".
3430 static __isl_give isl_union_set *isl_sched_graph_domain(isl_ctx *ctx,
3431 struct isl_sched_graph *graph,
3432 int (*pred)(struct isl_sched_node *node, int data), int data)
3434 int i;
3435 isl_set *set;
3436 isl_union_set *dom;
3438 for (i = 0; i < graph->n; ++i)
3439 if (pred(&graph->node[i], data))
3440 break;
3442 if (i >= graph->n)
3443 isl_die(ctx, isl_error_internal,
3444 "empty component", return NULL);
3446 set = isl_set_universe(isl_space_copy(graph->node[i].space));
3447 dom = isl_union_set_from_set(set);
3449 for (i = i + 1; i < graph->n; ++i) {
3450 if (!pred(&graph->node[i], data))
3451 continue;
3452 set = isl_set_universe(isl_space_copy(graph->node[i].space));
3453 dom = isl_union_set_union(dom, isl_union_set_from_set(set));
3456 return dom;
3459 /* Return a list of unions of universe domains, where each element
3460 * in the list corresponds to an SCC (or WCC) indexed by node->scc.
3462 static __isl_give isl_union_set_list *extract_sccs(isl_ctx *ctx,
3463 struct isl_sched_graph *graph)
3465 int i;
3466 isl_union_set_list *filters;
3468 filters = isl_union_set_list_alloc(ctx, graph->scc);
3469 for (i = 0; i < graph->scc; ++i) {
3470 isl_union_set *dom;
3472 dom = isl_sched_graph_domain(ctx, graph, &node_scc_exactly, i);
3473 filters = isl_union_set_list_add(filters, dom);
3476 return filters;
3479 /* Return a list of two unions of universe domains, one for the SCCs up
3480 * to and including graph->src_scc and another for the other SCCs.
3482 static __isl_give isl_union_set_list *extract_split(isl_ctx *ctx,
3483 struct isl_sched_graph *graph)
3485 isl_union_set *dom;
3486 isl_union_set_list *filters;
3488 filters = isl_union_set_list_alloc(ctx, 2);
3489 dom = isl_sched_graph_domain(ctx, graph,
3490 &node_scc_at_most, graph->src_scc);
3491 filters = isl_union_set_list_add(filters, dom);
3492 dom = isl_sched_graph_domain(ctx, graph,
3493 &node_scc_at_least, graph->src_scc + 1);
3494 filters = isl_union_set_list_add(filters, dom);
3496 return filters;
3499 /* Copy nodes that satisfy node_pred from the src dependence graph
3500 * to the dst dependence graph.
3502 static isl_stat copy_nodes(struct isl_sched_graph *dst,
3503 struct isl_sched_graph *src,
3504 int (*node_pred)(struct isl_sched_node *node, int data), int data)
3506 int i;
3508 dst->n = 0;
3509 for (i = 0; i < src->n; ++i) {
3510 int j;
3512 if (!node_pred(&src->node[i], data))
3513 continue;
3515 j = dst->n;
3516 dst->node[j].space = isl_space_copy(src->node[i].space);
3517 dst->node[j].compressed = src->node[i].compressed;
3518 dst->node[j].hull = isl_set_copy(src->node[i].hull);
3519 dst->node[j].compress =
3520 isl_multi_aff_copy(src->node[i].compress);
3521 dst->node[j].decompress =
3522 isl_multi_aff_copy(src->node[i].decompress);
3523 dst->node[j].nvar = src->node[i].nvar;
3524 dst->node[j].nparam = src->node[i].nparam;
3525 dst->node[j].sched = isl_mat_copy(src->node[i].sched);
3526 dst->node[j].sched_map = isl_map_copy(src->node[i].sched_map);
3527 dst->node[j].coincident = src->node[i].coincident;
3528 dst->node[j].sizes = isl_multi_val_copy(src->node[i].sizes);
3529 dst->node[j].bounds = isl_basic_set_copy(src->node[i].bounds);
3530 dst->node[j].max = isl_vec_copy(src->node[i].max);
3531 dst->n++;
3533 if (!dst->node[j].space || !dst->node[j].sched)
3534 return isl_stat_error;
3535 if (dst->node[j].compressed &&
3536 (!dst->node[j].hull || !dst->node[j].compress ||
3537 !dst->node[j].decompress))
3538 return isl_stat_error;
3541 return isl_stat_ok;
3544 /* Copy non-empty edges that satisfy edge_pred from the src dependence graph
3545 * to the dst dependence graph.
3546 * If the source or destination node of the edge is not in the destination
3547 * graph, then it must be a backward proximity edge and it should simply
3548 * be ignored.
3550 static isl_stat copy_edges(isl_ctx *ctx, struct isl_sched_graph *dst,
3551 struct isl_sched_graph *src,
3552 int (*edge_pred)(struct isl_sched_edge *edge, int data), int data)
3554 int i;
3556 dst->n_edge = 0;
3557 for (i = 0; i < src->n_edge; ++i) {
3558 struct isl_sched_edge *edge = &src->edge[i];
3559 isl_map *map;
3560 isl_union_map *tagged_condition;
3561 isl_union_map *tagged_validity;
3562 struct isl_sched_node *dst_src, *dst_dst;
3564 if (!edge_pred(edge, data))
3565 continue;
3567 if (isl_map_plain_is_empty(edge->map))
3568 continue;
3570 dst_src = graph_find_node(ctx, dst, edge->src->space);
3571 dst_dst = graph_find_node(ctx, dst, edge->dst->space);
3572 if (!dst_src || !dst_dst)
3573 return isl_stat_error;
3574 if (!is_node(dst, dst_src) || !is_node(dst, dst_dst)) {
3575 if (is_validity(edge) || is_conditional_validity(edge))
3576 isl_die(ctx, isl_error_internal,
3577 "backward (conditional) validity edge",
3578 return isl_stat_error);
3579 continue;
3582 map = isl_map_copy(edge->map);
3583 tagged_condition = isl_union_map_copy(edge->tagged_condition);
3584 tagged_validity = isl_union_map_copy(edge->tagged_validity);
3586 dst->edge[dst->n_edge].src = dst_src;
3587 dst->edge[dst->n_edge].dst = dst_dst;
3588 dst->edge[dst->n_edge].map = map;
3589 dst->edge[dst->n_edge].tagged_condition = tagged_condition;
3590 dst->edge[dst->n_edge].tagged_validity = tagged_validity;
3591 dst->edge[dst->n_edge].types = edge->types;
3592 dst->n_edge++;
3594 if (edge->tagged_condition && !tagged_condition)
3595 return isl_stat_error;
3596 if (edge->tagged_validity && !tagged_validity)
3597 return isl_stat_error;
3599 if (graph_edge_tables_add(ctx, dst,
3600 &dst->edge[dst->n_edge - 1]) < 0)
3601 return isl_stat_error;
3604 return isl_stat_ok;
3607 /* Compute the maximal number of variables over all nodes.
3608 * This is the maximal number of linearly independent schedule
3609 * rows that we need to compute.
3610 * Just in case we end up in a part of the dependence graph
3611 * with only lower-dimensional domains, we make sure we will
3612 * compute the required amount of extra linearly independent rows.
3614 static int compute_maxvar(struct isl_sched_graph *graph)
3616 int i;
3618 graph->maxvar = 0;
3619 for (i = 0; i < graph->n; ++i) {
3620 struct isl_sched_node *node = &graph->node[i];
3621 int nvar;
3623 if (node_update_vmap(node) < 0)
3624 return -1;
3625 nvar = node->nvar + graph->n_row - node->rank;
3626 if (nvar > graph->maxvar)
3627 graph->maxvar = nvar;
3630 return 0;
3633 /* Extract the subgraph of "graph" that consists of the nodes satisfying
3634 * "node_pred" and the edges satisfying "edge_pred" and store
3635 * the result in "sub".
3637 static isl_stat extract_sub_graph(isl_ctx *ctx, struct isl_sched_graph *graph,
3638 int (*node_pred)(struct isl_sched_node *node, int data),
3639 int (*edge_pred)(struct isl_sched_edge *edge, int data),
3640 int data, struct isl_sched_graph *sub)
3642 int i, n = 0, n_edge = 0;
3643 int t;
3645 for (i = 0; i < graph->n; ++i)
3646 if (node_pred(&graph->node[i], data))
3647 ++n;
3648 for (i = 0; i < graph->n_edge; ++i)
3649 if (edge_pred(&graph->edge[i], data))
3650 ++n_edge;
3651 if (graph_alloc(ctx, sub, n, n_edge) < 0)
3652 return isl_stat_error;
3653 sub->root = graph->root;
3654 if (copy_nodes(sub, graph, node_pred, data) < 0)
3655 return isl_stat_error;
3656 if (graph_init_table(ctx, sub) < 0)
3657 return isl_stat_error;
3658 for (t = 0; t <= isl_edge_last; ++t)
3659 sub->max_edge[t] = graph->max_edge[t];
3660 if (graph_init_edge_tables(ctx, sub) < 0)
3661 return isl_stat_error;
3662 if (copy_edges(ctx, sub, graph, edge_pred, data) < 0)
3663 return isl_stat_error;
3664 sub->n_row = graph->n_row;
3665 sub->max_row = graph->max_row;
3666 sub->n_total_row = graph->n_total_row;
3667 sub->band_start = graph->band_start;
3669 return isl_stat_ok;
3672 static __isl_give isl_schedule_node *compute_schedule(isl_schedule_node *node,
3673 struct isl_sched_graph *graph);
3674 static __isl_give isl_schedule_node *compute_schedule_wcc(
3675 isl_schedule_node *node, struct isl_sched_graph *graph);
3677 /* Compute a schedule for a subgraph of "graph". In particular, for
3678 * the graph composed of nodes that satisfy node_pred and edges that
3679 * that satisfy edge_pred.
3680 * If the subgraph is known to consist of a single component, then wcc should
3681 * be set and then we call compute_schedule_wcc on the constructed subgraph.
3682 * Otherwise, we call compute_schedule, which will check whether the subgraph
3683 * is connected.
3685 * The schedule is inserted at "node" and the updated schedule node
3686 * is returned.
3688 static __isl_give isl_schedule_node *compute_sub_schedule(
3689 __isl_take isl_schedule_node *node, isl_ctx *ctx,
3690 struct isl_sched_graph *graph,
3691 int (*node_pred)(struct isl_sched_node *node, int data),
3692 int (*edge_pred)(struct isl_sched_edge *edge, int data),
3693 int data, int wcc)
3695 struct isl_sched_graph split = { 0 };
3697 if (extract_sub_graph(ctx, graph, node_pred, edge_pred, data,
3698 &split) < 0)
3699 goto error;
3701 if (wcc)
3702 node = compute_schedule_wcc(node, &split);
3703 else
3704 node = compute_schedule(node, &split);
3706 graph_free(ctx, &split);
3707 return node;
3708 error:
3709 graph_free(ctx, &split);
3710 return isl_schedule_node_free(node);
3713 static int edge_scc_exactly(struct isl_sched_edge *edge, int scc)
3715 return edge->src->scc == scc && edge->dst->scc == scc;
3718 static int edge_dst_scc_at_most(struct isl_sched_edge *edge, int scc)
3720 return edge->dst->scc <= scc;
3723 static int edge_src_scc_at_least(struct isl_sched_edge *edge, int scc)
3725 return edge->src->scc >= scc;
3728 /* Reset the current band by dropping all its schedule rows.
3730 static isl_stat reset_band(struct isl_sched_graph *graph)
3732 int i;
3733 int drop;
3735 drop = graph->n_total_row - graph->band_start;
3736 graph->n_total_row -= drop;
3737 graph->n_row -= drop;
3739 for (i = 0; i < graph->n; ++i) {
3740 struct isl_sched_node *node = &graph->node[i];
3742 isl_map_free(node->sched_map);
3743 node->sched_map = NULL;
3745 node->sched = isl_mat_drop_rows(node->sched,
3746 graph->band_start, drop);
3748 if (!node->sched)
3749 return isl_stat_error;
3752 return isl_stat_ok;
3755 /* Split the current graph into two parts and compute a schedule for each
3756 * part individually. In particular, one part consists of all SCCs up
3757 * to and including graph->src_scc, while the other part contains the other
3758 * SCCs. The split is enforced by a sequence node inserted at position "node"
3759 * in the schedule tree. Return the updated schedule node.
3760 * If either of these two parts consists of a sequence, then it is spliced
3761 * into the sequence containing the two parts.
3763 * The current band is reset. It would be possible to reuse
3764 * the previously computed rows as the first rows in the next
3765 * band, but recomputing them may result in better rows as we are looking
3766 * at a smaller part of the dependence graph.
3768 static __isl_give isl_schedule_node *compute_split_schedule(
3769 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
3771 int is_seq;
3772 isl_ctx *ctx;
3773 isl_union_set_list *filters;
3775 if (!node)
3776 return NULL;
3778 if (reset_band(graph) < 0)
3779 return isl_schedule_node_free(node);
3781 next_band(graph);
3783 ctx = isl_schedule_node_get_ctx(node);
3784 filters = extract_split(ctx, graph);
3785 node = isl_schedule_node_insert_sequence(node, filters);
3786 node = isl_schedule_node_child(node, 1);
3787 node = isl_schedule_node_child(node, 0);
3789 node = compute_sub_schedule(node, ctx, graph,
3790 &node_scc_at_least, &edge_src_scc_at_least,
3791 graph->src_scc + 1, 0);
3792 is_seq = isl_schedule_node_get_type(node) == isl_schedule_node_sequence;
3793 node = isl_schedule_node_parent(node);
3794 node = isl_schedule_node_parent(node);
3795 if (is_seq)
3796 node = isl_schedule_node_sequence_splice_child(node, 1);
3797 node = isl_schedule_node_child(node, 0);
3798 node = isl_schedule_node_child(node, 0);
3799 node = compute_sub_schedule(node, ctx, graph,
3800 &node_scc_at_most, &edge_dst_scc_at_most,
3801 graph->src_scc, 0);
3802 is_seq = isl_schedule_node_get_type(node) == isl_schedule_node_sequence;
3803 node = isl_schedule_node_parent(node);
3804 node = isl_schedule_node_parent(node);
3805 if (is_seq)
3806 node = isl_schedule_node_sequence_splice_child(node, 0);
3808 return node;
3811 /* Insert a band node at position "node" in the schedule tree corresponding
3812 * to the current band in "graph". Mark the band node permutable
3813 * if "permutable" is set.
3814 * The partial schedules and the coincidence property are extracted
3815 * from the graph nodes.
3816 * Return the updated schedule node.
3818 static __isl_give isl_schedule_node *insert_current_band(
3819 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
3820 int permutable)
3822 int i;
3823 int start, end, n;
3824 isl_multi_aff *ma;
3825 isl_multi_pw_aff *mpa;
3826 isl_multi_union_pw_aff *mupa;
3828 if (!node)
3829 return NULL;
3831 if (graph->n < 1)
3832 isl_die(isl_schedule_node_get_ctx(node), isl_error_internal,
3833 "graph should have at least one node",
3834 return isl_schedule_node_free(node));
3836 start = graph->band_start;
3837 end = graph->n_total_row;
3838 n = end - start;
3840 ma = node_extract_partial_schedule_multi_aff(&graph->node[0], start, n);
3841 mpa = isl_multi_pw_aff_from_multi_aff(ma);
3842 mupa = isl_multi_union_pw_aff_from_multi_pw_aff(mpa);
3844 for (i = 1; i < graph->n; ++i) {
3845 isl_multi_union_pw_aff *mupa_i;
3847 ma = node_extract_partial_schedule_multi_aff(&graph->node[i],
3848 start, n);
3849 mpa = isl_multi_pw_aff_from_multi_aff(ma);
3850 mupa_i = isl_multi_union_pw_aff_from_multi_pw_aff(mpa);
3851 mupa = isl_multi_union_pw_aff_union_add(mupa, mupa_i);
3853 node = isl_schedule_node_insert_partial_schedule(node, mupa);
3855 for (i = 0; i < n; ++i)
3856 node = isl_schedule_node_band_member_set_coincident(node, i,
3857 graph->node[0].coincident[start + i]);
3858 node = isl_schedule_node_band_set_permutable(node, permutable);
3860 return node;
3863 /* Update the dependence relations based on the current schedule,
3864 * add the current band to "node" and then continue with the computation
3865 * of the next band.
3866 * Return the updated schedule node.
3868 static __isl_give isl_schedule_node *compute_next_band(
3869 __isl_take isl_schedule_node *node,
3870 struct isl_sched_graph *graph, int permutable)
3872 isl_ctx *ctx;
3874 if (!node)
3875 return NULL;
3877 ctx = isl_schedule_node_get_ctx(node);
3878 if (update_edges(ctx, graph) < 0)
3879 return isl_schedule_node_free(node);
3880 node = insert_current_band(node, graph, permutable);
3881 next_band(graph);
3883 node = isl_schedule_node_child(node, 0);
3884 node = compute_schedule(node, graph);
3885 node = isl_schedule_node_parent(node);
3887 return node;
3890 /* Add the constraints "coef" derived from an edge from "node" to itself
3891 * to graph->lp in order to respect the dependences and to try and carry them.
3892 * "pos" is the sequence number of the edge that needs to be carried.
3893 * "coef" represents general constraints on coefficients (c_0, c_x)
3894 * of valid constraints for (y - x) with x and y instances of the node.
3896 * The constraints added to graph->lp need to enforce
3898 * (c_j_0 + c_j_x y) - (c_j_0 + c_j_x x)
3899 * = c_j_x (y - x) >= e_i
3901 * for each (x,y) in the dependence relation of the edge.
3902 * That is, (-e_i, c_j_x) needs to be plugged in for (c_0, c_x),
3903 * taking into account that each coefficient in c_j_x is represented
3904 * as a pair of non-negative coefficients.
3906 static isl_stat add_intra_constraints(struct isl_sched_graph *graph,
3907 struct isl_sched_node *node, __isl_take isl_basic_set *coef, int pos)
3909 isl_size offset;
3910 isl_ctx *ctx;
3911 isl_dim_map *dim_map;
3913 offset = coef_var_offset(coef);
3914 if (offset < 0)
3915 coef = isl_basic_set_free(coef);
3916 if (!coef)
3917 return isl_stat_error;
3919 ctx = isl_basic_set_get_ctx(coef);
3920 dim_map = intra_dim_map(ctx, graph, node, offset, 1);
3921 isl_dim_map_range(dim_map, 3 + pos, 0, 0, 0, 1, -1);
3922 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
3924 return isl_stat_ok;
3927 /* Add the constraints "coef" derived from an edge from "src" to "dst"
3928 * to graph->lp in order to respect the dependences and to try and carry them.
3929 * "pos" is the sequence number of the edge that needs to be carried or
3930 * -1 if no attempt should be made to carry the dependences.
3931 * "coef" represents general constraints on coefficients (c_0, c_n, c_x, c_y)
3932 * of valid constraints for (x, y) with x and y instances of "src" and "dst".
3934 * The constraints added to graph->lp need to enforce
3936 * (c_k_0 + c_k_n n + c_k_x y) - (c_j_0 + c_j_n n + c_j_x x) >= e_i
3938 * for each (x,y) in the dependence relation of the edge or
3940 * (c_k_0 + c_k_n n + c_k_x y) - (c_j_0 + c_j_n n + c_j_x x) >= 0
3942 * if pos is -1.
3943 * That is,
3944 * (-e_i + c_k_0 - c_j_0, c_k_n - c_j_n, -c_j_x, c_k_x)
3945 * or
3946 * (c_k_0 - c_j_0, c_k_n - c_j_n, -c_j_x, c_k_x)
3947 * needs to be plugged in for (c_0, c_n, c_x, c_y),
3948 * taking into account that each coefficient in c_j_x and c_k_x is represented
3949 * as a pair of non-negative coefficients.
3951 static isl_stat add_inter_constraints(struct isl_sched_graph *graph,
3952 struct isl_sched_node *src, struct isl_sched_node *dst,
3953 __isl_take isl_basic_set *coef, int pos)
3955 isl_size offset;
3956 isl_ctx *ctx;
3957 isl_dim_map *dim_map;
3959 offset = coef_var_offset(coef);
3960 if (offset < 0)
3961 coef = isl_basic_set_free(coef);
3962 if (!coef)
3963 return isl_stat_error;
3965 ctx = isl_basic_set_get_ctx(coef);
3966 dim_map = inter_dim_map(ctx, graph, src, dst, offset, 1);
3967 if (pos >= 0)
3968 isl_dim_map_range(dim_map, 3 + pos, 0, 0, 0, 1, -1);
3969 graph->lp = add_constraints_dim_map(graph->lp, coef, dim_map);
3971 return isl_stat_ok;
3974 /* Data structure for keeping track of the data needed
3975 * to exploit non-trivial lineality spaces.
3977 * "any_non_trivial" is true if there are any non-trivial lineality spaces.
3978 * If "any_non_trivial" is not true, then "equivalent" and "mask" may be NULL.
3979 * "equivalent" connects instances to other instances on the same line(s).
3980 * "mask" contains the domain spaces of "equivalent".
3981 * Any instance set not in "mask" does not have a non-trivial lineality space.
3983 struct isl_exploit_lineality_data {
3984 isl_bool any_non_trivial;
3985 isl_union_map *equivalent;
3986 isl_union_set *mask;
3989 /* Data structure collecting information used during the construction
3990 * of an LP for carrying dependences.
3992 * "intra" is a sequence of coefficient constraints for intra-node edges.
3993 * "inter" is a sequence of coefficient constraints for inter-node edges.
3994 * "lineality" contains data used to exploit non-trivial lineality spaces.
3996 struct isl_carry {
3997 isl_basic_set_list *intra;
3998 isl_basic_set_list *inter;
3999 struct isl_exploit_lineality_data lineality;
4002 /* Free all the data stored in "carry".
4004 static void isl_carry_clear(struct isl_carry *carry)
4006 isl_basic_set_list_free(carry->intra);
4007 isl_basic_set_list_free(carry->inter);
4008 isl_union_map_free(carry->lineality.equivalent);
4009 isl_union_set_free(carry->lineality.mask);
4012 /* Return a pointer to the node in "graph" that lives in "space".
4013 * If the requested node has been compressed, then "space"
4014 * corresponds to the compressed space.
4015 * The graph is assumed to have such a node.
4016 * Return NULL in case of error.
4018 * First try and see if "space" is the space of an uncompressed node.
4019 * If so, return that node.
4020 * Otherwise, "space" was constructed by construct_compressed_id and
4021 * contains a user pointer pointing to the node in the tuple id.
4022 * However, this node belongs to the original dependence graph.
4023 * If "graph" is a subgraph of this original dependence graph,
4024 * then the node with the same space still needs to be looked up
4025 * in the current graph.
4027 static struct isl_sched_node *graph_find_compressed_node(isl_ctx *ctx,
4028 struct isl_sched_graph *graph, __isl_keep isl_space *space)
4030 isl_id *id;
4031 struct isl_sched_node *node;
4033 if (!space)
4034 return NULL;
4036 node = graph_find_node(ctx, graph, space);
4037 if (!node)
4038 return NULL;
4039 if (is_node(graph, node))
4040 return node;
4042 id = isl_space_get_tuple_id(space, isl_dim_set);
4043 node = isl_id_get_user(id);
4044 isl_id_free(id);
4046 if (!node)
4047 return NULL;
4049 if (!is_node(graph->root, node))
4050 isl_die(ctx, isl_error_internal,
4051 "space points to invalid node", return NULL);
4052 if (graph != graph->root)
4053 node = graph_find_node(ctx, graph, node->space);
4054 if (!is_node(graph, node))
4055 isl_die(ctx, isl_error_internal,
4056 "unable to find node", return NULL);
4058 return node;
4061 /* Internal data structure for add_all_constraints.
4063 * "graph" is the schedule constraint graph for which an LP problem
4064 * is being constructed.
4065 * "carry_inter" indicates whether inter-node edges should be carried.
4066 * "pos" is the position of the next edge that needs to be carried.
4068 struct isl_add_all_constraints_data {
4069 isl_ctx *ctx;
4070 struct isl_sched_graph *graph;
4071 int carry_inter;
4072 int pos;
4075 /* Add the constraints "coef" derived from an edge from a node to itself
4076 * to data->graph->lp in order to respect the dependences and
4077 * to try and carry them.
4079 * The space of "coef" is of the form
4081 * coefficients[[c_cst] -> S[c_x]]
4083 * with S[c_x] the (compressed) space of the node.
4084 * Extract the node from the space and call add_intra_constraints.
4086 static isl_stat lp_add_intra(__isl_take isl_basic_set *coef, void *user)
4088 struct isl_add_all_constraints_data *data = user;
4089 isl_space *space;
4090 struct isl_sched_node *node;
4092 space = isl_basic_set_get_space(coef);
4093 space = isl_space_range(isl_space_unwrap(space));
4094 node = graph_find_compressed_node(data->ctx, data->graph, space);
4095 isl_space_free(space);
4096 return add_intra_constraints(data->graph, node, coef, data->pos++);
4099 /* Add the constraints "coef" derived from an edge from a node j
4100 * to a node k to data->graph->lp in order to respect the dependences and
4101 * to try and carry them (provided data->carry_inter is set).
4103 * The space of "coef" is of the form
4105 * coefficients[[c_cst, c_n] -> [S_j[c_x] -> S_k[c_y]]]
4107 * with S_j[c_x] and S_k[c_y] the (compressed) spaces of the nodes.
4108 * Extract the nodes from the space and call add_inter_constraints.
4110 static isl_stat lp_add_inter(__isl_take isl_basic_set *coef, void *user)
4112 struct isl_add_all_constraints_data *data = user;
4113 isl_space *space, *dom;
4114 struct isl_sched_node *src, *dst;
4115 int pos;
4117 space = isl_basic_set_get_space(coef);
4118 space = isl_space_unwrap(isl_space_range(isl_space_unwrap(space)));
4119 dom = isl_space_domain(isl_space_copy(space));
4120 src = graph_find_compressed_node(data->ctx, data->graph, dom);
4121 isl_space_free(dom);
4122 space = isl_space_range(space);
4123 dst = graph_find_compressed_node(data->ctx, data->graph, space);
4124 isl_space_free(space);
4126 pos = data->carry_inter ? data->pos++ : -1;
4127 return add_inter_constraints(data->graph, src, dst, coef, pos);
4130 /* Add constraints to graph->lp that force all (conditional) validity
4131 * dependences to be respected and attempt to carry them.
4132 * "intra" is the sequence of coefficient constraints for intra-node edges.
4133 * "inter" is the sequence of coefficient constraints for inter-node edges.
4134 * "carry_inter" indicates whether inter-node edges should be carried or
4135 * only respected.
4137 static isl_stat add_all_constraints(isl_ctx *ctx, struct isl_sched_graph *graph,
4138 __isl_keep isl_basic_set_list *intra,
4139 __isl_keep isl_basic_set_list *inter, int carry_inter)
4141 struct isl_add_all_constraints_data data = { ctx, graph, carry_inter };
4143 data.pos = 0;
4144 if (isl_basic_set_list_foreach(intra, &lp_add_intra, &data) < 0)
4145 return isl_stat_error;
4146 if (isl_basic_set_list_foreach(inter, &lp_add_inter, &data) < 0)
4147 return isl_stat_error;
4148 return isl_stat_ok;
4151 /* Internal data structure for count_all_constraints
4152 * for keeping track of the number of equality and inequality constraints.
4154 struct isl_sched_count {
4155 int n_eq;
4156 int n_ineq;
4159 /* Add the number of equality and inequality constraints of "bset"
4160 * to data->n_eq and data->n_ineq.
4162 static isl_stat bset_update_count(__isl_take isl_basic_set *bset, void *user)
4164 struct isl_sched_count *data = user;
4166 return update_count(bset, 1, &data->n_eq, &data->n_ineq);
4169 /* Count the number of equality and inequality constraints
4170 * that will be added to the carry_lp problem.
4171 * We count each edge exactly once.
4172 * "intra" is the sequence of coefficient constraints for intra-node edges.
4173 * "inter" is the sequence of coefficient constraints for inter-node edges.
4175 static isl_stat count_all_constraints(__isl_keep isl_basic_set_list *intra,
4176 __isl_keep isl_basic_set_list *inter, int *n_eq, int *n_ineq)
4178 struct isl_sched_count data;
4180 data.n_eq = data.n_ineq = 0;
4181 if (isl_basic_set_list_foreach(inter, &bset_update_count, &data) < 0)
4182 return isl_stat_error;
4183 if (isl_basic_set_list_foreach(intra, &bset_update_count, &data) < 0)
4184 return isl_stat_error;
4186 *n_eq = data.n_eq;
4187 *n_ineq = data.n_ineq;
4189 return isl_stat_ok;
4192 /* Construct an LP problem for finding schedule coefficients
4193 * such that the schedule carries as many validity dependences as possible.
4194 * In particular, for each dependence i, we bound the dependence distance
4195 * from below by e_i, with 0 <= e_i <= 1 and then maximize the sum
4196 * of all e_i's. Dependences with e_i = 0 in the solution are simply
4197 * respected, while those with e_i > 0 (in practice e_i = 1) are carried.
4198 * "intra" is the sequence of coefficient constraints for intra-node edges.
4199 * "inter" is the sequence of coefficient constraints for inter-node edges.
4200 * "n_edge" is the total number of edges.
4201 * "carry_inter" indicates whether inter-node edges should be carried or
4202 * only respected. That is, if "carry_inter" is not set, then
4203 * no e_i variables are introduced for the inter-node edges.
4205 * All variables of the LP are non-negative. The actual coefficients
4206 * may be negative, so each coefficient is represented as the difference
4207 * of two non-negative variables. The negative part always appears
4208 * immediately before the positive part.
4209 * Other than that, the variables have the following order
4211 * - sum of (1 - e_i) over all edges
4212 * - sum of all c_n coefficients
4213 * (unconstrained when computing non-parametric schedules)
4214 * - sum of positive and negative parts of all c_x coefficients
4215 * - for each edge
4216 * - e_i
4217 * - for each node
4218 * - positive and negative parts of c_i_x, in opposite order
4219 * - c_i_n (if parametric)
4220 * - c_i_0
4222 * The constraints are those from the (validity) edges plus three equalities
4223 * to express the sums and n_edge inequalities to express e_i <= 1.
4225 static isl_stat setup_carry_lp(isl_ctx *ctx, struct isl_sched_graph *graph,
4226 int n_edge, __isl_keep isl_basic_set_list *intra,
4227 __isl_keep isl_basic_set_list *inter, int carry_inter)
4229 int i;
4230 int k;
4231 isl_space *dim;
4232 unsigned total;
4233 int n_eq, n_ineq;
4235 total = 3 + n_edge;
4236 for (i = 0; i < graph->n; ++i) {
4237 struct isl_sched_node *node = &graph->node[graph->sorted[i]];
4238 node->start = total;
4239 total += 1 + node->nparam + 2 * node->nvar;
4242 if (count_all_constraints(intra, inter, &n_eq, &n_ineq) < 0)
4243 return isl_stat_error;
4245 dim = isl_space_set_alloc(ctx, 0, total);
4246 isl_basic_set_free(graph->lp);
4247 n_eq += 3;
4248 n_ineq += n_edge;
4249 graph->lp = isl_basic_set_alloc_space(dim, 0, n_eq, n_ineq);
4250 graph->lp = isl_basic_set_set_rational(graph->lp);
4252 k = isl_basic_set_alloc_equality(graph->lp);
4253 if (k < 0)
4254 return isl_stat_error;
4255 isl_seq_clr(graph->lp->eq[k], 1 + total);
4256 isl_int_set_si(graph->lp->eq[k][0], -n_edge);
4257 isl_int_set_si(graph->lp->eq[k][1], 1);
4258 for (i = 0; i < n_edge; ++i)
4259 isl_int_set_si(graph->lp->eq[k][4 + i], 1);
4261 if (add_param_sum_constraint(graph, 1) < 0)
4262 return isl_stat_error;
4263 if (add_var_sum_constraint(graph, 2) < 0)
4264 return isl_stat_error;
4266 for (i = 0; i < n_edge; ++i) {
4267 k = isl_basic_set_alloc_inequality(graph->lp);
4268 if (k < 0)
4269 return isl_stat_error;
4270 isl_seq_clr(graph->lp->ineq[k], 1 + total);
4271 isl_int_set_si(graph->lp->ineq[k][4 + i], -1);
4272 isl_int_set_si(graph->lp->ineq[k][0], 1);
4275 if (add_all_constraints(ctx, graph, intra, inter, carry_inter) < 0)
4276 return isl_stat_error;
4278 return isl_stat_ok;
4281 static __isl_give isl_schedule_node *compute_component_schedule(
4282 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
4283 int wcc);
4285 /* If the schedule_split_scaled option is set and if the linear
4286 * parts of the scheduling rows for all nodes in the graphs have
4287 * a non-trivial common divisor, then remove this
4288 * common divisor from the linear part.
4289 * Otherwise, insert a band node directly and continue with
4290 * the construction of the schedule.
4292 * If a non-trivial common divisor is found, then
4293 * the linear part is reduced and the remainder is ignored.
4294 * The pieces of the graph that are assigned different remainders
4295 * form (groups of) strongly connected components within
4296 * the scaled down band. If needed, they can therefore
4297 * be ordered along this remainder in a sequence node.
4298 * However, this ordering is not enforced here in order to allow
4299 * the scheduler to combine some of the strongly connected components.
4301 static __isl_give isl_schedule_node *split_scaled(
4302 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
4304 int i;
4305 int row;
4306 isl_ctx *ctx;
4307 isl_int gcd, gcd_i;
4308 isl_size n_row;
4310 if (!node)
4311 return NULL;
4313 ctx = isl_schedule_node_get_ctx(node);
4314 if (!ctx->opt->schedule_split_scaled)
4315 return compute_next_band(node, graph, 0);
4316 if (graph->n <= 1)
4317 return compute_next_band(node, graph, 0);
4318 n_row = isl_mat_rows(graph->node[0].sched);
4319 if (n_row < 0)
4320 return isl_schedule_node_free(node);
4322 isl_int_init(gcd);
4323 isl_int_init(gcd_i);
4325 isl_int_set_si(gcd, 0);
4327 row = n_row - 1;
4329 for (i = 0; i < graph->n; ++i) {
4330 struct isl_sched_node *node = &graph->node[i];
4331 isl_size cols = isl_mat_cols(node->sched);
4333 if (cols < 0)
4334 break;
4335 isl_seq_gcd(node->sched->row[row] + 1, cols - 1, &gcd_i);
4336 isl_int_gcd(gcd, gcd, gcd_i);
4339 isl_int_clear(gcd_i);
4340 if (i < graph->n)
4341 goto error;
4343 if (isl_int_cmp_si(gcd, 1) <= 0) {
4344 isl_int_clear(gcd);
4345 return compute_next_band(node, graph, 0);
4348 for (i = 0; i < graph->n; ++i) {
4349 struct isl_sched_node *node = &graph->node[i];
4351 isl_int_fdiv_q(node->sched->row[row][0],
4352 node->sched->row[row][0], gcd);
4353 isl_int_mul(node->sched->row[row][0],
4354 node->sched->row[row][0], gcd);
4355 node->sched = isl_mat_scale_down_row(node->sched, row, gcd);
4356 if (!node->sched)
4357 goto error;
4360 isl_int_clear(gcd);
4362 return compute_next_band(node, graph, 0);
4363 error:
4364 isl_int_clear(gcd);
4365 return isl_schedule_node_free(node);
4368 /* Is the schedule row "sol" trivial on node "node"?
4369 * That is, is the solution zero on the dimensions linearly independent of
4370 * the previously found solutions?
4371 * Return 1 if the solution is trivial, 0 if it is not and -1 on error.
4373 * Each coefficient is represented as the difference between
4374 * two non-negative values in "sol".
4375 * We construct the schedule row s and check if it is linearly
4376 * independent of previously computed schedule rows
4377 * by computing T s, with T the linear combinations that are zero
4378 * on linearly dependent schedule rows.
4379 * If the result consists of all zeros, then the solution is trivial.
4381 static int is_trivial(struct isl_sched_node *node, __isl_keep isl_vec *sol)
4383 int trivial;
4384 isl_vec *node_sol;
4386 if (!sol)
4387 return -1;
4388 if (node->nvar == node->rank)
4389 return 0;
4391 node_sol = extract_var_coef(node, sol);
4392 node_sol = isl_mat_vec_product(isl_mat_copy(node->indep), node_sol);
4393 if (!node_sol)
4394 return -1;
4396 trivial = isl_seq_first_non_zero(node_sol->el,
4397 node->nvar - node->rank) == -1;
4399 isl_vec_free(node_sol);
4401 return trivial;
4404 /* Is the schedule row "sol" trivial on any node where it should
4405 * not be trivial?
4406 * Return 1 if any solution is trivial, 0 if they are not and -1 on error.
4408 static int is_any_trivial(struct isl_sched_graph *graph,
4409 __isl_keep isl_vec *sol)
4411 int i;
4413 for (i = 0; i < graph->n; ++i) {
4414 struct isl_sched_node *node = &graph->node[i];
4415 int trivial;
4417 if (!needs_row(graph, node))
4418 continue;
4419 trivial = is_trivial(node, sol);
4420 if (trivial < 0 || trivial)
4421 return trivial;
4424 return 0;
4427 /* Does the schedule represented by "sol" perform loop coalescing on "node"?
4428 * If so, return the position of the coalesced dimension.
4429 * Otherwise, return node->nvar or -1 on error.
4431 * In particular, look for pairs of coefficients c_i and c_j such that
4432 * |c_j/c_i| > ceil(size_i/2), i.e., |c_j| > |c_i * ceil(size_i/2)|.
4433 * If any such pair is found, then return i.
4434 * If size_i is infinity, then no check on c_i needs to be performed.
4436 static int find_node_coalescing(struct isl_sched_node *node,
4437 __isl_keep isl_vec *sol)
4439 int i, j;
4440 isl_int max;
4441 isl_vec *csol;
4443 if (node->nvar <= 1)
4444 return node->nvar;
4446 csol = extract_var_coef(node, sol);
4447 if (!csol)
4448 return -1;
4449 isl_int_init(max);
4450 for (i = 0; i < node->nvar; ++i) {
4451 isl_val *v;
4453 if (isl_int_is_zero(csol->el[i]))
4454 continue;
4455 v = isl_multi_val_get_val(node->sizes, i);
4456 if (!v)
4457 goto error;
4458 if (!isl_val_is_int(v)) {
4459 isl_val_free(v);
4460 continue;
4462 v = isl_val_div_ui(v, 2);
4463 v = isl_val_ceil(v);
4464 if (!v)
4465 goto error;
4466 isl_int_mul(max, v->n, csol->el[i]);
4467 isl_val_free(v);
4469 for (j = 0; j < node->nvar; ++j) {
4470 if (j == i)
4471 continue;
4472 if (isl_int_abs_gt(csol->el[j], max))
4473 break;
4475 if (j < node->nvar)
4476 break;
4479 isl_int_clear(max);
4480 isl_vec_free(csol);
4481 return i;
4482 error:
4483 isl_int_clear(max);
4484 isl_vec_free(csol);
4485 return -1;
4488 /* Force the schedule coefficient at position "pos" of "node" to be zero
4489 * in "tl".
4490 * The coefficient is encoded as the difference between two non-negative
4491 * variables. Force these two variables to have the same value.
4493 static __isl_give isl_tab_lexmin *zero_out_node_coef(
4494 __isl_take isl_tab_lexmin *tl, struct isl_sched_node *node, int pos)
4496 int dim;
4497 isl_ctx *ctx;
4498 isl_vec *eq;
4500 ctx = isl_space_get_ctx(node->space);
4501 dim = isl_tab_lexmin_dim(tl);
4502 if (dim < 0)
4503 return isl_tab_lexmin_free(tl);
4504 eq = isl_vec_alloc(ctx, 1 + dim);
4505 eq = isl_vec_clr(eq);
4506 if (!eq)
4507 return isl_tab_lexmin_free(tl);
4509 pos = 1 + node_var_coef_pos(node, pos);
4510 isl_int_set_si(eq->el[pos], 1);
4511 isl_int_set_si(eq->el[pos + 1], -1);
4512 tl = isl_tab_lexmin_add_eq(tl, eq->el);
4513 isl_vec_free(eq);
4515 return tl;
4518 /* Return the lexicographically smallest rational point in the basic set
4519 * from which "tl" was constructed, double checking that this input set
4520 * was not empty.
4522 static __isl_give isl_vec *non_empty_solution(__isl_keep isl_tab_lexmin *tl)
4524 isl_vec *sol;
4526 sol = isl_tab_lexmin_get_solution(tl);
4527 if (!sol)
4528 return NULL;
4529 if (sol->size == 0)
4530 isl_die(isl_vec_get_ctx(sol), isl_error_internal,
4531 "error in schedule construction",
4532 return isl_vec_free(sol));
4533 return sol;
4536 /* Does the solution "sol" of the LP problem constructed by setup_carry_lp
4537 * carry any of the "n_edge" groups of dependences?
4538 * The value in the first position is the sum of (1 - e_i) over all "n_edge"
4539 * edges, with 0 <= e_i <= 1 equal to 1 when the dependences represented
4540 * by the edge are carried by the solution.
4541 * If the sum of the (1 - e_i) is smaller than "n_edge" then at least
4542 * one of those is carried.
4544 * Note that despite the fact that the problem is solved using a rational
4545 * solver, the solution is guaranteed to be integral.
4546 * Specifically, the dependence distance lower bounds e_i (and therefore
4547 * also their sum) are integers. See Lemma 5 of [1].
4549 * Any potential denominator of the sum is cleared by this function.
4550 * The denominator is not relevant for any of the other elements
4551 * in the solution.
4553 * [1] P. Feautrier, Some Efficient Solutions to the Affine Scheduling
4554 * Problem, Part II: Multi-Dimensional Time.
4555 * In Intl. Journal of Parallel Programming, 1992.
4557 static int carries_dependences(__isl_keep isl_vec *sol, int n_edge)
4559 isl_int_divexact(sol->el[1], sol->el[1], sol->el[0]);
4560 isl_int_set_si(sol->el[0], 1);
4561 return isl_int_cmp_si(sol->el[1], n_edge) < 0;
4564 /* Return the lexicographically smallest rational point in "lp",
4565 * assuming that all variables are non-negative and performing some
4566 * additional sanity checks.
4567 * If "want_integral" is set, then compute the lexicographically smallest
4568 * integer point instead.
4569 * In particular, "lp" should not be empty by construction.
4570 * Double check that this is the case.
4571 * If dependences are not carried for any of the "n_edge" edges,
4572 * then return an empty vector.
4574 * If the schedule_treat_coalescing option is set and
4575 * if the computed schedule performs loop coalescing on a given node,
4576 * i.e., if it is of the form
4578 * c_i i + c_j j + ...
4580 * with |c_j/c_i| >= size_i, then force the coefficient c_i to be zero
4581 * to cut out this solution. Repeat this process until no more loop
4582 * coalescing occurs or until no more dependences can be carried.
4583 * In the latter case, revert to the previously computed solution.
4585 * If the caller requests an integral solution and if coalescing should
4586 * be treated, then perform the coalescing treatment first as
4587 * an integral solution computed before coalescing treatment
4588 * would carry the same number of edges and would therefore probably
4589 * also be coalescing.
4591 * To allow the coalescing treatment to be performed first,
4592 * the initial solution is allowed to be rational and it is only
4593 * cut out (if needed) in the next iteration, if no coalescing measures
4594 * were taken.
4596 static __isl_give isl_vec *non_neg_lexmin(struct isl_sched_graph *graph,
4597 __isl_take isl_basic_set *lp, int n_edge, int want_integral)
4599 int i, pos, cut;
4600 isl_ctx *ctx;
4601 isl_tab_lexmin *tl;
4602 isl_vec *sol = NULL, *prev;
4603 int treat_coalescing;
4604 int try_again;
4606 if (!lp)
4607 return NULL;
4608 ctx = isl_basic_set_get_ctx(lp);
4609 treat_coalescing = isl_options_get_schedule_treat_coalescing(ctx);
4610 tl = isl_tab_lexmin_from_basic_set(lp);
4612 cut = 0;
4613 do {
4614 int integral;
4616 try_again = 0;
4617 if (cut)
4618 tl = isl_tab_lexmin_cut_to_integer(tl);
4619 prev = sol;
4620 sol = non_empty_solution(tl);
4621 if (!sol)
4622 goto error;
4624 integral = isl_int_is_one(sol->el[0]);
4625 if (!carries_dependences(sol, n_edge)) {
4626 if (!prev)
4627 prev = isl_vec_alloc(ctx, 0);
4628 isl_vec_free(sol);
4629 sol = prev;
4630 break;
4632 prev = isl_vec_free(prev);
4633 cut = want_integral && !integral;
4634 if (cut)
4635 try_again = 1;
4636 if (!treat_coalescing)
4637 continue;
4638 for (i = 0; i < graph->n; ++i) {
4639 struct isl_sched_node *node = &graph->node[i];
4641 pos = find_node_coalescing(node, sol);
4642 if (pos < 0)
4643 goto error;
4644 if (pos < node->nvar)
4645 break;
4647 if (i < graph->n) {
4648 try_again = 1;
4649 tl = zero_out_node_coef(tl, &graph->node[i], pos);
4650 cut = 0;
4652 } while (try_again);
4654 isl_tab_lexmin_free(tl);
4656 return sol;
4657 error:
4658 isl_tab_lexmin_free(tl);
4659 isl_vec_free(prev);
4660 isl_vec_free(sol);
4661 return NULL;
4664 /* If "edge" is an edge from a node to itself, then add the corresponding
4665 * dependence relation to "umap".
4666 * If "node" has been compressed, then the dependence relation
4667 * is also compressed first.
4669 static __isl_give isl_union_map *add_intra(__isl_take isl_union_map *umap,
4670 struct isl_sched_edge *edge)
4672 isl_map *map;
4673 struct isl_sched_node *node = edge->src;
4675 if (edge->src != edge->dst)
4676 return umap;
4678 map = isl_map_copy(edge->map);
4679 if (node->compressed) {
4680 map = isl_map_preimage_domain_multi_aff(map,
4681 isl_multi_aff_copy(node->decompress));
4682 map = isl_map_preimage_range_multi_aff(map,
4683 isl_multi_aff_copy(node->decompress));
4685 umap = isl_union_map_add_map(umap, map);
4686 return umap;
4689 /* If "edge" is an edge from a node to another node, then add the corresponding
4690 * dependence relation to "umap".
4691 * If the source or destination nodes of "edge" have been compressed,
4692 * then the dependence relation is also compressed first.
4694 static __isl_give isl_union_map *add_inter(__isl_take isl_union_map *umap,
4695 struct isl_sched_edge *edge)
4697 isl_map *map;
4699 if (edge->src == edge->dst)
4700 return umap;
4702 map = isl_map_copy(edge->map);
4703 if (edge->src->compressed)
4704 map = isl_map_preimage_domain_multi_aff(map,
4705 isl_multi_aff_copy(edge->src->decompress));
4706 if (edge->dst->compressed)
4707 map = isl_map_preimage_range_multi_aff(map,
4708 isl_multi_aff_copy(edge->dst->decompress));
4709 umap = isl_union_map_add_map(umap, map);
4710 return umap;
4713 /* Internal data structure used by union_drop_coalescing_constraints
4714 * to collect bounds on all relevant statements.
4716 * "graph" is the schedule constraint graph for which an LP problem
4717 * is being constructed.
4718 * "bounds" collects the bounds.
4720 struct isl_collect_bounds_data {
4721 isl_ctx *ctx;
4722 struct isl_sched_graph *graph;
4723 isl_union_set *bounds;
4726 /* Add the size bounds for the node with instance deltas in "set"
4727 * to data->bounds.
4729 static isl_stat collect_bounds(__isl_take isl_set *set, void *user)
4731 struct isl_collect_bounds_data *data = user;
4732 struct isl_sched_node *node;
4733 isl_space *space;
4734 isl_set *bounds;
4736 space = isl_set_get_space(set);
4737 isl_set_free(set);
4739 node = graph_find_compressed_node(data->ctx, data->graph, space);
4740 isl_space_free(space);
4742 bounds = isl_set_from_basic_set(get_size_bounds(node));
4743 data->bounds = isl_union_set_add_set(data->bounds, bounds);
4745 return isl_stat_ok;
4748 /* Drop some constraints from "delta" that could be exploited
4749 * to construct loop coalescing schedules.
4750 * In particular, drop those constraint that bound the difference
4751 * to the size of the domain.
4752 * Do this for each set/node in "delta" separately.
4753 * The parameters are assumed to have been projected out by the caller.
4755 static __isl_give isl_union_set *union_drop_coalescing_constraints(isl_ctx *ctx,
4756 struct isl_sched_graph *graph, __isl_take isl_union_set *delta)
4758 struct isl_collect_bounds_data data = { ctx, graph };
4760 data.bounds = isl_union_set_empty(isl_space_params_alloc(ctx, 0));
4761 if (isl_union_set_foreach_set(delta, &collect_bounds, &data) < 0)
4762 data.bounds = isl_union_set_free(data.bounds);
4763 delta = isl_union_set_plain_gist(delta, data.bounds);
4765 return delta;
4768 /* Given a non-trivial lineality space "lineality", add the corresponding
4769 * universe set to data->mask and add a map from elements to
4770 * other elements along the lines in "lineality" to data->equivalent.
4771 * If this is the first time this function gets called
4772 * (data->any_non_trivial is still false), then set data->any_non_trivial and
4773 * initialize data->mask and data->equivalent.
4775 * In particular, if the lineality space is defined by equality constraints
4777 * E x = 0
4779 * then construct an affine mapping
4781 * f : x -> E x
4783 * and compute the equivalence relation of having the same image under f:
4785 * { x -> x' : E x = E x' }
4787 static isl_stat add_non_trivial_lineality(__isl_take isl_basic_set *lineality,
4788 struct isl_exploit_lineality_data *data)
4790 isl_mat *eq;
4791 isl_space *space;
4792 isl_set *univ;
4793 isl_multi_aff *ma;
4794 isl_multi_pw_aff *mpa;
4795 isl_map *map;
4796 isl_size n;
4798 if (isl_basic_set_check_no_locals(lineality) < 0)
4799 goto error;
4801 space = isl_basic_set_get_space(lineality);
4802 if (!data->any_non_trivial) {
4803 data->equivalent = isl_union_map_empty(isl_space_copy(space));
4804 data->mask = isl_union_set_empty(isl_space_copy(space));
4806 data->any_non_trivial = isl_bool_true;
4808 univ = isl_set_universe(isl_space_copy(space));
4809 data->mask = isl_union_set_add_set(data->mask, univ);
4811 eq = isl_basic_set_extract_equalities(lineality);
4812 n = isl_mat_rows(eq);
4813 if (n < 0)
4814 space = isl_space_free(space);
4815 eq = isl_mat_insert_zero_rows(eq, 0, 1);
4816 eq = isl_mat_set_element_si(eq, 0, 0, 1);
4817 space = isl_space_from_domain(space);
4818 space = isl_space_add_dims(space, isl_dim_out, n);
4819 ma = isl_multi_aff_from_aff_mat(space, eq);
4820 mpa = isl_multi_pw_aff_from_multi_aff(ma);
4821 map = isl_multi_pw_aff_eq_map(mpa, isl_multi_pw_aff_copy(mpa));
4822 data->equivalent = isl_union_map_add_map(data->equivalent, map);
4824 isl_basic_set_free(lineality);
4825 return isl_stat_ok;
4826 error:
4827 isl_basic_set_free(lineality);
4828 return isl_stat_error;
4831 /* Check if the lineality space "set" is non-trivial (i.e., is not just
4832 * the origin or, in other words, satisfies a number of equality constraints
4833 * that is smaller than the dimension of the set).
4834 * If so, extend data->mask and data->equivalent accordingly.
4836 * The input should not have any local variables already, but
4837 * isl_set_remove_divs is called to make sure it does not.
4839 static isl_stat add_lineality(__isl_take isl_set *set, void *user)
4841 struct isl_exploit_lineality_data *data = user;
4842 isl_basic_set *hull;
4843 isl_size dim;
4844 int n_eq;
4846 set = isl_set_remove_divs(set);
4847 hull = isl_set_unshifted_simple_hull(set);
4848 dim = isl_basic_set_dim(hull, isl_dim_set);
4849 n_eq = isl_basic_set_n_equality(hull);
4850 if (dim < 0)
4851 goto error;
4852 if (dim != n_eq)
4853 return add_non_trivial_lineality(hull, data);
4854 isl_basic_set_free(hull);
4855 return isl_stat_ok;
4856 error:
4857 isl_basic_set_free(hull);
4858 return isl_stat_error;
4861 /* Check if the difference set on intra-node schedule constraints "intra"
4862 * has any non-trivial lineality space.
4863 * If so, then extend the difference set to a difference set
4864 * on equivalent elements. That is, if "intra" is
4866 * { y - x : (x,y) \in V }
4868 * and elements are equivalent if they have the same image under f,
4869 * then return
4871 * { y' - x' : (x,y) \in V and f(x) = f(x') and f(y) = f(y') }
4873 * or, since f is linear,
4875 * { y' - x' : (x,y) \in V and f(y - x) = f(y' - x') }
4877 * The results of the search for non-trivial lineality spaces is stored
4878 * in "data".
4880 static __isl_give isl_union_set *exploit_intra_lineality(
4881 __isl_take isl_union_set *intra,
4882 struct isl_exploit_lineality_data *data)
4884 isl_union_set *lineality;
4885 isl_union_set *uset;
4887 data->any_non_trivial = isl_bool_false;
4888 lineality = isl_union_set_copy(intra);
4889 lineality = isl_union_set_combined_lineality_space(lineality);
4890 if (isl_union_set_foreach_set(lineality, &add_lineality, data) < 0)
4891 data->any_non_trivial = isl_bool_error;
4892 isl_union_set_free(lineality);
4894 if (data->any_non_trivial < 0)
4895 return isl_union_set_free(intra);
4896 if (!data->any_non_trivial)
4897 return intra;
4899 uset = isl_union_set_copy(intra);
4900 intra = isl_union_set_subtract(intra, isl_union_set_copy(data->mask));
4901 uset = isl_union_set_apply(uset, isl_union_map_copy(data->equivalent));
4902 intra = isl_union_set_union(intra, uset);
4904 intra = isl_union_set_remove_divs(intra);
4906 return intra;
4909 /* If the difference set on intra-node schedule constraints was found to have
4910 * any non-trivial lineality space by exploit_intra_lineality,
4911 * as recorded in "data", then extend the inter-node
4912 * schedule constraints "inter" to schedule constraints on equivalent elements.
4913 * That is, if "inter" is V and
4914 * elements are equivalent if they have the same image under f, then return
4916 * { (x', y') : (x,y) \in V and f(x) = f(x') and f(y) = f(y') }
4918 static __isl_give isl_union_map *exploit_inter_lineality(
4919 __isl_take isl_union_map *inter,
4920 struct isl_exploit_lineality_data *data)
4922 isl_union_map *umap;
4924 if (data->any_non_trivial < 0)
4925 return isl_union_map_free(inter);
4926 if (!data->any_non_trivial)
4927 return inter;
4929 umap = isl_union_map_copy(inter);
4930 inter = isl_union_map_subtract_range(inter,
4931 isl_union_set_copy(data->mask));
4932 umap = isl_union_map_apply_range(umap,
4933 isl_union_map_copy(data->equivalent));
4934 inter = isl_union_map_union(inter, umap);
4935 umap = isl_union_map_copy(inter);
4936 inter = isl_union_map_subtract_domain(inter,
4937 isl_union_set_copy(data->mask));
4938 umap = isl_union_map_apply_range(isl_union_map_copy(data->equivalent),
4939 umap);
4940 inter = isl_union_map_union(inter, umap);
4942 inter = isl_union_map_remove_divs(inter);
4944 return inter;
4947 /* For each (conditional) validity edge in "graph",
4948 * add the corresponding dependence relation using "add"
4949 * to a collection of dependence relations and return the result.
4950 * If "coincidence" is set, then coincidence edges are considered as well.
4952 static __isl_give isl_union_map *collect_validity(struct isl_sched_graph *graph,
4953 __isl_give isl_union_map *(*add)(__isl_take isl_union_map *umap,
4954 struct isl_sched_edge *edge), int coincidence)
4956 int i;
4957 isl_space *space;
4958 isl_union_map *umap;
4960 space = isl_space_copy(graph->node[0].space);
4961 umap = isl_union_map_empty(space);
4963 for (i = 0; i < graph->n_edge; ++i) {
4964 struct isl_sched_edge *edge = &graph->edge[i];
4966 if (!is_any_validity(edge) &&
4967 (!coincidence || !is_coincidence(edge)))
4968 continue;
4970 umap = add(umap, edge);
4973 return umap;
4976 /* For each dependence relation on a (conditional) validity edge
4977 * from a node to itself,
4978 * construct the set of coefficients of valid constraints for elements
4979 * in that dependence relation and collect the results.
4980 * If "coincidence" is set, then coincidence edges are considered as well.
4982 * In particular, for each dependence relation R, constraints
4983 * on coefficients (c_0, c_x) are constructed such that
4985 * c_0 + c_x d >= 0 for each d in delta R = { y - x | (x,y) in R }
4987 * If the schedule_treat_coalescing option is set, then some constraints
4988 * that could be exploited to construct coalescing schedules
4989 * are removed before the dual is computed, but after the parameters
4990 * have been projected out.
4991 * The entire computation is essentially the same as that performed
4992 * by intra_coefficients, except that it operates on multiple
4993 * edges together and that the parameters are always projected out.
4995 * Additionally, exploit any non-trivial lineality space
4996 * in the difference set after removing coalescing constraints and
4997 * store the results of the non-trivial lineality space detection in "data".
4998 * The procedure is currently run unconditionally, but it is unlikely
4999 * to find any non-trivial lineality spaces if no coalescing constraints
5000 * have been removed.
5002 * Note that if a dependence relation is a union of basic maps,
5003 * then each basic map needs to be treated individually as it may only
5004 * be possible to carry the dependences expressed by some of those
5005 * basic maps and not all of them.
5006 * The collected validity constraints are therefore not coalesced and
5007 * it is assumed that they are not coalesced automatically.
5008 * Duplicate basic maps can be removed, however.
5009 * In particular, if the same basic map appears as a disjunct
5010 * in multiple edges, then it only needs to be carried once.
5012 static __isl_give isl_basic_set_list *collect_intra_validity(isl_ctx *ctx,
5013 struct isl_sched_graph *graph, int coincidence,
5014 struct isl_exploit_lineality_data *data)
5016 isl_union_map *intra;
5017 isl_union_set *delta;
5018 isl_basic_set_list *list;
5020 intra = collect_validity(graph, &add_intra, coincidence);
5021 delta = isl_union_map_deltas(intra);
5022 delta = isl_union_set_project_out_all_params(delta);
5023 delta = isl_union_set_remove_divs(delta);
5024 if (isl_options_get_schedule_treat_coalescing(ctx))
5025 delta = union_drop_coalescing_constraints(ctx, graph, delta);
5026 delta = exploit_intra_lineality(delta, data);
5027 list = isl_union_set_get_basic_set_list(delta);
5028 isl_union_set_free(delta);
5030 return isl_basic_set_list_coefficients(list);
5033 /* For each dependence relation on a (conditional) validity edge
5034 * from a node to some other node,
5035 * construct the set of coefficients of valid constraints for elements
5036 * in that dependence relation and collect the results.
5037 * If "coincidence" is set, then coincidence edges are considered as well.
5039 * In particular, for each dependence relation R, constraints
5040 * on coefficients (c_0, c_n, c_x, c_y) are constructed such that
5042 * c_0 + c_n n + c_x x + c_y y >= 0 for each (x,y) in R
5044 * This computation is essentially the same as that performed
5045 * by inter_coefficients, except that it operates on multiple
5046 * edges together.
5048 * Additionally, exploit any non-trivial lineality space
5049 * that may have been discovered by collect_intra_validity
5050 * (as stored in "data").
5052 * Note that if a dependence relation is a union of basic maps,
5053 * then each basic map needs to be treated individually as it may only
5054 * be possible to carry the dependences expressed by some of those
5055 * basic maps and not all of them.
5056 * The collected validity constraints are therefore not coalesced and
5057 * it is assumed that they are not coalesced automatically.
5058 * Duplicate basic maps can be removed, however.
5059 * In particular, if the same basic map appears as a disjunct
5060 * in multiple edges, then it only needs to be carried once.
5062 static __isl_give isl_basic_set_list *collect_inter_validity(
5063 struct isl_sched_graph *graph, int coincidence,
5064 struct isl_exploit_lineality_data *data)
5066 isl_union_map *inter;
5067 isl_union_set *wrap;
5068 isl_basic_set_list *list;
5070 inter = collect_validity(graph, &add_inter, coincidence);
5071 inter = exploit_inter_lineality(inter, data);
5072 inter = isl_union_map_remove_divs(inter);
5073 wrap = isl_union_map_wrap(inter);
5074 list = isl_union_set_get_basic_set_list(wrap);
5075 isl_union_set_free(wrap);
5076 return isl_basic_set_list_coefficients(list);
5079 /* Construct an LP problem for finding schedule coefficients
5080 * such that the schedule carries as many of the "n_edge" groups of
5081 * dependences as possible based on the corresponding coefficient
5082 * constraints and return the lexicographically smallest non-trivial solution.
5083 * "intra" is the sequence of coefficient constraints for intra-node edges.
5084 * "inter" is the sequence of coefficient constraints for inter-node edges.
5085 * If "want_integral" is set, then compute an integral solution
5086 * for the coefficients rather than using the numerators
5087 * of a rational solution.
5088 * "carry_inter" indicates whether inter-node edges should be carried or
5089 * only respected.
5091 * If none of the "n_edge" groups can be carried
5092 * then return an empty vector.
5094 static __isl_give isl_vec *compute_carrying_sol_coef(isl_ctx *ctx,
5095 struct isl_sched_graph *graph, int n_edge,
5096 __isl_keep isl_basic_set_list *intra,
5097 __isl_keep isl_basic_set_list *inter, int want_integral,
5098 int carry_inter)
5100 isl_basic_set *lp;
5102 if (setup_carry_lp(ctx, graph, n_edge, intra, inter, carry_inter) < 0)
5103 return NULL;
5105 lp = isl_basic_set_copy(graph->lp);
5106 return non_neg_lexmin(graph, lp, n_edge, want_integral);
5109 /* Construct an LP problem for finding schedule coefficients
5110 * such that the schedule carries as many of the validity dependences
5111 * as possible and
5112 * return the lexicographically smallest non-trivial solution.
5113 * If "fallback" is set, then the carrying is performed as a fallback
5114 * for the Pluto-like scheduler.
5115 * If "coincidence" is set, then try and carry coincidence edges as well.
5117 * The variable "n_edge" stores the number of groups that should be carried.
5118 * If none of the "n_edge" groups can be carried
5119 * then return an empty vector.
5120 * If, moreover, "n_edge" is zero, then the LP problem does not even
5121 * need to be constructed.
5123 * If a fallback solution is being computed, then compute an integral solution
5124 * for the coefficients rather than using the numerators
5125 * of a rational solution.
5127 * If a fallback solution is being computed, if there are any intra-node
5128 * dependences, and if requested by the user, then first try
5129 * to only carry those intra-node dependences.
5130 * If this fails to carry any dependences, then try again
5131 * with the inter-node dependences included.
5133 static __isl_give isl_vec *compute_carrying_sol(isl_ctx *ctx,
5134 struct isl_sched_graph *graph, int fallback, int coincidence)
5136 int n_intra, n_inter;
5137 int n_edge;
5138 struct isl_carry carry = { 0 };
5139 isl_vec *sol;
5141 carry.intra = collect_intra_validity(ctx, graph, coincidence,
5142 &carry.lineality);
5143 carry.inter = collect_inter_validity(graph, coincidence,
5144 &carry.lineality);
5145 if (!carry.intra || !carry.inter)
5146 goto error;
5147 n_intra = isl_basic_set_list_n_basic_set(carry.intra);
5148 n_inter = isl_basic_set_list_n_basic_set(carry.inter);
5150 if (fallback && n_intra > 0 &&
5151 isl_options_get_schedule_carry_self_first(ctx)) {
5152 sol = compute_carrying_sol_coef(ctx, graph, n_intra,
5153 carry.intra, carry.inter, fallback, 0);
5154 if (!sol || sol->size != 0 || n_inter == 0) {
5155 isl_carry_clear(&carry);
5156 return sol;
5158 isl_vec_free(sol);
5161 n_edge = n_intra + n_inter;
5162 if (n_edge == 0) {
5163 isl_carry_clear(&carry);
5164 return isl_vec_alloc(ctx, 0);
5167 sol = compute_carrying_sol_coef(ctx, graph, n_edge,
5168 carry.intra, carry.inter, fallback, 1);
5169 isl_carry_clear(&carry);
5170 return sol;
5171 error:
5172 isl_carry_clear(&carry);
5173 return NULL;
5176 /* Construct a schedule row for each node such that as many validity dependences
5177 * as possible are carried and then continue with the next band.
5178 * If "fallback" is set, then the carrying is performed as a fallback
5179 * for the Pluto-like scheduler.
5180 * If "coincidence" is set, then try and carry coincidence edges as well.
5182 * If there are no validity dependences, then no dependence can be carried and
5183 * the procedure is guaranteed to fail. If there is more than one component,
5184 * then try computing a schedule on each component separately
5185 * to prevent or at least postpone this failure.
5187 * If a schedule row is computed, then check that dependences are carried
5188 * for at least one of the edges.
5190 * If the computed schedule row turns out to be trivial on one or
5191 * more nodes where it should not be trivial, then we throw it away
5192 * and try again on each component separately.
5194 * If there is only one component, then we accept the schedule row anyway,
5195 * but we do not consider it as a complete row and therefore do not
5196 * increment graph->n_row. Note that the ranks of the nodes that
5197 * do get a non-trivial schedule part will get updated regardless and
5198 * graph->maxvar is computed based on these ranks. The test for
5199 * whether more schedule rows are required in compute_schedule_wcc
5200 * is therefore not affected.
5202 * Insert a band corresponding to the schedule row at position "node"
5203 * of the schedule tree and continue with the construction of the schedule.
5204 * This insertion and the continued construction is performed by split_scaled
5205 * after optionally checking for non-trivial common divisors.
5207 static __isl_give isl_schedule_node *carry(__isl_take isl_schedule_node *node,
5208 struct isl_sched_graph *graph, int fallback, int coincidence)
5210 int trivial;
5211 isl_ctx *ctx;
5212 isl_vec *sol;
5214 if (!node)
5215 return NULL;
5217 ctx = isl_schedule_node_get_ctx(node);
5218 sol = compute_carrying_sol(ctx, graph, fallback, coincidence);
5219 if (!sol)
5220 return isl_schedule_node_free(node);
5221 if (sol->size == 0) {
5222 isl_vec_free(sol);
5223 if (graph->scc > 1)
5224 return compute_component_schedule(node, graph, 1);
5225 isl_die(ctx, isl_error_unknown, "unable to carry dependences",
5226 return isl_schedule_node_free(node));
5229 trivial = is_any_trivial(graph, sol);
5230 if (trivial < 0) {
5231 sol = isl_vec_free(sol);
5232 } else if (trivial && graph->scc > 1) {
5233 isl_vec_free(sol);
5234 return compute_component_schedule(node, graph, 1);
5237 if (update_schedule(graph, sol, 0) < 0)
5238 return isl_schedule_node_free(node);
5239 if (trivial)
5240 graph->n_row--;
5242 return split_scaled(node, graph);
5245 /* Construct a schedule row for each node such that as many validity dependences
5246 * as possible are carried and then continue with the next band.
5247 * Do so as a fallback for the Pluto-like scheduler.
5248 * If "coincidence" is set, then try and carry coincidence edges as well.
5250 static __isl_give isl_schedule_node *carry_fallback(
5251 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
5252 int coincidence)
5254 return carry(node, graph, 1, coincidence);
5257 /* Construct a schedule row for each node such that as many validity dependences
5258 * as possible are carried and then continue with the next band.
5259 * Do so for the case where the Feautrier scheduler was selected
5260 * by the user.
5262 static __isl_give isl_schedule_node *carry_feautrier(
5263 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
5265 return carry(node, graph, 0, 0);
5268 /* Construct a schedule row for each node such that as many validity dependences
5269 * as possible are carried and then continue with the next band.
5270 * Do so as a fallback for the Pluto-like scheduler.
5272 static __isl_give isl_schedule_node *carry_dependences(
5273 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
5275 return carry_fallback(node, graph, 0);
5278 /* Construct a schedule row for each node such that as many validity or
5279 * coincidence dependences as possible are carried and
5280 * then continue with the next band.
5281 * Do so as a fallback for the Pluto-like scheduler.
5283 static __isl_give isl_schedule_node *carry_coincidence(
5284 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
5286 return carry_fallback(node, graph, 1);
5289 /* Topologically sort statements mapped to the same schedule iteration
5290 * and add insert a sequence node in front of "node"
5291 * corresponding to this order.
5292 * If "initialized" is set, then it may be assumed that compute_maxvar
5293 * has been called on the current band. Otherwise, call
5294 * compute_maxvar if and before carry_dependences gets called.
5296 * If it turns out to be impossible to sort the statements apart,
5297 * because different dependences impose different orderings
5298 * on the statements, then we extend the schedule such that
5299 * it carries at least one more dependence.
5301 static __isl_give isl_schedule_node *sort_statements(
5302 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
5303 int initialized)
5305 isl_ctx *ctx;
5306 isl_union_set_list *filters;
5308 if (!node)
5309 return NULL;
5311 ctx = isl_schedule_node_get_ctx(node);
5312 if (graph->n < 1)
5313 isl_die(ctx, isl_error_internal,
5314 "graph should have at least one node",
5315 return isl_schedule_node_free(node));
5317 if (graph->n == 1)
5318 return node;
5320 if (update_edges(ctx, graph) < 0)
5321 return isl_schedule_node_free(node);
5323 if (graph->n_edge == 0)
5324 return node;
5326 if (detect_sccs(ctx, graph) < 0)
5327 return isl_schedule_node_free(node);
5329 next_band(graph);
5330 if (graph->scc < graph->n) {
5331 if (!initialized && compute_maxvar(graph) < 0)
5332 return isl_schedule_node_free(node);
5333 return carry_dependences(node, graph);
5336 filters = extract_sccs(ctx, graph);
5337 node = isl_schedule_node_insert_sequence(node, filters);
5339 return node;
5342 /* Are there any (non-empty) (conditional) validity edges in the graph?
5344 static int has_validity_edges(struct isl_sched_graph *graph)
5346 int i;
5348 for (i = 0; i < graph->n_edge; ++i) {
5349 int empty;
5351 empty = isl_map_plain_is_empty(graph->edge[i].map);
5352 if (empty < 0)
5353 return -1;
5354 if (empty)
5355 continue;
5356 if (is_any_validity(&graph->edge[i]))
5357 return 1;
5360 return 0;
5363 /* Should we apply a Feautrier step?
5364 * That is, did the user request the Feautrier algorithm and are
5365 * there any validity dependences (left)?
5367 static int need_feautrier_step(isl_ctx *ctx, struct isl_sched_graph *graph)
5369 if (ctx->opt->schedule_algorithm != ISL_SCHEDULE_ALGORITHM_FEAUTRIER)
5370 return 0;
5372 return has_validity_edges(graph);
5375 /* Compute a schedule for a connected dependence graph using Feautrier's
5376 * multi-dimensional scheduling algorithm and return the updated schedule node.
5378 * The original algorithm is described in [1].
5379 * The main idea is to minimize the number of scheduling dimensions, by
5380 * trying to satisfy as many dependences as possible per scheduling dimension.
5382 * [1] P. Feautrier, Some Efficient Solutions to the Affine Scheduling
5383 * Problem, Part II: Multi-Dimensional Time.
5384 * In Intl. Journal of Parallel Programming, 1992.
5386 static __isl_give isl_schedule_node *compute_schedule_wcc_feautrier(
5387 isl_schedule_node *node, struct isl_sched_graph *graph)
5389 return carry_feautrier(node, graph);
5392 /* Turn off the "local" bit on all (condition) edges.
5394 static void clear_local_edges(struct isl_sched_graph *graph)
5396 int i;
5398 for (i = 0; i < graph->n_edge; ++i)
5399 if (is_condition(&graph->edge[i]))
5400 clear_local(&graph->edge[i]);
5403 /* Does "graph" have both condition and conditional validity edges?
5405 static int need_condition_check(struct isl_sched_graph *graph)
5407 int i;
5408 int any_condition = 0;
5409 int any_conditional_validity = 0;
5411 for (i = 0; i < graph->n_edge; ++i) {
5412 if (is_condition(&graph->edge[i]))
5413 any_condition = 1;
5414 if (is_conditional_validity(&graph->edge[i]))
5415 any_conditional_validity = 1;
5418 return any_condition && any_conditional_validity;
5421 /* Does "graph" contain any coincidence edge?
5423 static int has_any_coincidence(struct isl_sched_graph *graph)
5425 int i;
5427 for (i = 0; i < graph->n_edge; ++i)
5428 if (is_coincidence(&graph->edge[i]))
5429 return 1;
5431 return 0;
5434 /* Extract the final schedule row as a map with the iteration domain
5435 * of "node" as domain.
5437 static __isl_give isl_map *final_row(struct isl_sched_node *node)
5439 isl_multi_aff *ma;
5440 isl_size n_row;
5442 n_row = isl_mat_rows(node->sched);
5443 if (n_row < 0)
5444 return NULL;
5445 ma = node_extract_partial_schedule_multi_aff(node, n_row - 1, 1);
5446 return isl_map_from_multi_aff(ma);
5449 /* Is the conditional validity dependence in the edge with index "edge_index"
5450 * violated by the latest (i.e., final) row of the schedule?
5451 * That is, is i scheduled after j
5452 * for any conditional validity dependence i -> j?
5454 static int is_violated(struct isl_sched_graph *graph, int edge_index)
5456 isl_map *src_sched, *dst_sched, *map;
5457 struct isl_sched_edge *edge = &graph->edge[edge_index];
5458 int empty;
5460 src_sched = final_row(edge->src);
5461 dst_sched = final_row(edge->dst);
5462 map = isl_map_copy(edge->map);
5463 map = isl_map_apply_domain(map, src_sched);
5464 map = isl_map_apply_range(map, dst_sched);
5465 map = isl_map_order_gt(map, isl_dim_in, 0, isl_dim_out, 0);
5466 empty = isl_map_is_empty(map);
5467 isl_map_free(map);
5469 if (empty < 0)
5470 return -1;
5472 return !empty;
5475 /* Does "graph" have any satisfied condition edges that
5476 * are adjacent to the conditional validity constraint with
5477 * domain "conditional_source" and range "conditional_sink"?
5479 * A satisfied condition is one that is not local.
5480 * If a condition was forced to be local already (i.e., marked as local)
5481 * then there is no need to check if it is in fact local.
5483 * Additionally, mark all adjacent condition edges found as local.
5485 static int has_adjacent_true_conditions(struct isl_sched_graph *graph,
5486 __isl_keep isl_union_set *conditional_source,
5487 __isl_keep isl_union_set *conditional_sink)
5489 int i;
5490 int any = 0;
5492 for (i = 0; i < graph->n_edge; ++i) {
5493 int adjacent, local;
5494 isl_union_map *condition;
5496 if (!is_condition(&graph->edge[i]))
5497 continue;
5498 if (is_local(&graph->edge[i]))
5499 continue;
5501 condition = graph->edge[i].tagged_condition;
5502 adjacent = domain_intersects(condition, conditional_sink);
5503 if (adjacent >= 0 && !adjacent)
5504 adjacent = range_intersects(condition,
5505 conditional_source);
5506 if (adjacent < 0)
5507 return -1;
5508 if (!adjacent)
5509 continue;
5511 set_local(&graph->edge[i]);
5513 local = is_condition_false(&graph->edge[i]);
5514 if (local < 0)
5515 return -1;
5516 if (!local)
5517 any = 1;
5520 return any;
5523 /* Are there any violated conditional validity dependences with
5524 * adjacent condition dependences that are not local with respect
5525 * to the current schedule?
5526 * That is, is the conditional validity constraint violated?
5528 * Additionally, mark all those adjacent condition dependences as local.
5529 * We also mark those adjacent condition dependences that were not marked
5530 * as local before, but just happened to be local already. This ensures
5531 * that they remain local if the schedule is recomputed.
5533 * We first collect domain and range of all violated conditional validity
5534 * dependences and then check if there are any adjacent non-local
5535 * condition dependences.
5537 static int has_violated_conditional_constraint(isl_ctx *ctx,
5538 struct isl_sched_graph *graph)
5540 int i;
5541 int any = 0;
5542 isl_union_set *source, *sink;
5544 source = isl_union_set_empty(isl_space_params_alloc(ctx, 0));
5545 sink = isl_union_set_empty(isl_space_params_alloc(ctx, 0));
5546 for (i = 0; i < graph->n_edge; ++i) {
5547 isl_union_set *uset;
5548 isl_union_map *umap;
5549 int violated;
5551 if (!is_conditional_validity(&graph->edge[i]))
5552 continue;
5554 violated = is_violated(graph, i);
5555 if (violated < 0)
5556 goto error;
5557 if (!violated)
5558 continue;
5560 any = 1;
5562 umap = isl_union_map_copy(graph->edge[i].tagged_validity);
5563 uset = isl_union_map_domain(umap);
5564 source = isl_union_set_union(source, uset);
5565 source = isl_union_set_coalesce(source);
5567 umap = isl_union_map_copy(graph->edge[i].tagged_validity);
5568 uset = isl_union_map_range(umap);
5569 sink = isl_union_set_union(sink, uset);
5570 sink = isl_union_set_coalesce(sink);
5573 if (any)
5574 any = has_adjacent_true_conditions(graph, source, sink);
5576 isl_union_set_free(source);
5577 isl_union_set_free(sink);
5578 return any;
5579 error:
5580 isl_union_set_free(source);
5581 isl_union_set_free(sink);
5582 return -1;
5585 /* Examine the current band (the rows between graph->band_start and
5586 * graph->n_total_row), deciding whether to drop it or add it to "node"
5587 * and then continue with the computation of the next band, if any.
5588 * If "initialized" is set, then it may be assumed that compute_maxvar
5589 * has been called on the current band. Otherwise, call
5590 * compute_maxvar if and before carry_dependences gets called.
5592 * The caller keeps looking for a new row as long as
5593 * graph->n_row < graph->maxvar. If the latest attempt to find
5594 * such a row failed (i.e., we still have graph->n_row < graph->maxvar),
5595 * then we either
5596 * - split between SCCs and start over (assuming we found an interesting
5597 * pair of SCCs between which to split)
5598 * - continue with the next band (assuming the current band has at least
5599 * one row)
5600 * - if there is more than one SCC left, then split along all SCCs
5601 * - if outer coincidence needs to be enforced, then try to carry as many
5602 * validity or coincidence dependences as possible and
5603 * continue with the next band
5604 * - try to carry as many validity dependences as possible and
5605 * continue with the next band
5606 * In each case, we first insert a band node in the schedule tree
5607 * if any rows have been computed.
5609 * If the caller managed to complete the schedule and the current band
5610 * is empty, then finish off by topologically
5611 * sorting the statements based on the remaining dependences.
5612 * If, on the other hand, the current band has at least one row,
5613 * then continue with the next band. Note that this next band
5614 * will necessarily be empty, but the graph may still be split up
5615 * into weakly connected components before arriving back here.
5617 static __isl_give isl_schedule_node *compute_schedule_finish_band(
5618 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
5619 int initialized)
5621 int empty;
5623 if (!node)
5624 return NULL;
5626 empty = graph->n_total_row == graph->band_start;
5627 if (graph->n_row < graph->maxvar) {
5628 isl_ctx *ctx;
5630 ctx = isl_schedule_node_get_ctx(node);
5631 if (!ctx->opt->schedule_maximize_band_depth && !empty)
5632 return compute_next_band(node, graph, 1);
5633 if (graph->src_scc >= 0)
5634 return compute_split_schedule(node, graph);
5635 if (!empty)
5636 return compute_next_band(node, graph, 1);
5637 if (graph->scc > 1)
5638 return compute_component_schedule(node, graph, 1);
5639 if (!initialized && compute_maxvar(graph) < 0)
5640 return isl_schedule_node_free(node);
5641 if (isl_options_get_schedule_outer_coincidence(ctx))
5642 return carry_coincidence(node, graph);
5643 return carry_dependences(node, graph);
5646 if (!empty)
5647 return compute_next_band(node, graph, 1);
5648 return sort_statements(node, graph, initialized);
5651 /* Construct a band of schedule rows for a connected dependence graph.
5652 * The caller is responsible for determining the strongly connected
5653 * components and calling compute_maxvar first.
5655 * We try to find a sequence of as many schedule rows as possible that result
5656 * in non-negative dependence distances (independent of the previous rows
5657 * in the sequence, i.e., such that the sequence is tilable), with as
5658 * many of the initial rows as possible satisfying the coincidence constraints.
5659 * The computation stops if we can't find any more rows or if we have found
5660 * all the rows we wanted to find.
5662 * If ctx->opt->schedule_outer_coincidence is set, then we force the
5663 * outermost dimension to satisfy the coincidence constraints. If this
5664 * turns out to be impossible, we fall back on the general scheme above
5665 * and try to carry as many dependences as possible.
5667 * If "graph" contains both condition and conditional validity dependences,
5668 * then we need to check that that the conditional schedule constraint
5669 * is satisfied, i.e., there are no violated conditional validity dependences
5670 * that are adjacent to any non-local condition dependences.
5671 * If there are, then we mark all those adjacent condition dependences
5672 * as local and recompute the current band. Those dependences that
5673 * are marked local will then be forced to be local.
5674 * The initial computation is performed with no dependences marked as local.
5675 * If we are lucky, then there will be no violated conditional validity
5676 * dependences adjacent to any non-local condition dependences.
5677 * Otherwise, we mark some additional condition dependences as local and
5678 * recompute. We continue this process until there are no violations left or
5679 * until we are no longer able to compute a schedule.
5680 * Since there are only a finite number of dependences,
5681 * there will only be a finite number of iterations.
5683 static isl_stat compute_schedule_wcc_band(isl_ctx *ctx,
5684 struct isl_sched_graph *graph)
5686 int has_coincidence;
5687 int use_coincidence;
5688 int force_coincidence = 0;
5689 int check_conditional;
5691 if (sort_sccs(graph) < 0)
5692 return isl_stat_error;
5694 clear_local_edges(graph);
5695 check_conditional = need_condition_check(graph);
5696 has_coincidence = has_any_coincidence(graph);
5698 if (ctx->opt->schedule_outer_coincidence)
5699 force_coincidence = 1;
5701 use_coincidence = has_coincidence;
5702 while (graph->n_row < graph->maxvar) {
5703 isl_vec *sol;
5704 int violated;
5705 int coincident;
5707 graph->src_scc = -1;
5708 graph->dst_scc = -1;
5710 if (setup_lp(ctx, graph, use_coincidence) < 0)
5711 return isl_stat_error;
5712 sol = solve_lp(ctx, graph);
5713 if (!sol)
5714 return isl_stat_error;
5715 if (sol->size == 0) {
5716 int empty = graph->n_total_row == graph->band_start;
5718 isl_vec_free(sol);
5719 if (use_coincidence && (!force_coincidence || !empty)) {
5720 use_coincidence = 0;
5721 continue;
5723 return isl_stat_ok;
5725 coincident = !has_coincidence || use_coincidence;
5726 if (update_schedule(graph, sol, coincident) < 0)
5727 return isl_stat_error;
5729 if (!check_conditional)
5730 continue;
5731 violated = has_violated_conditional_constraint(ctx, graph);
5732 if (violated < 0)
5733 return isl_stat_error;
5734 if (!violated)
5735 continue;
5736 if (reset_band(graph) < 0)
5737 return isl_stat_error;
5738 use_coincidence = has_coincidence;
5741 return isl_stat_ok;
5744 /* Compute a schedule for a connected dependence graph by considering
5745 * the graph as a whole and return the updated schedule node.
5747 * The actual schedule rows of the current band are computed by
5748 * compute_schedule_wcc_band. compute_schedule_finish_band takes
5749 * care of integrating the band into "node" and continuing
5750 * the computation.
5752 static __isl_give isl_schedule_node *compute_schedule_wcc_whole(
5753 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
5755 isl_ctx *ctx;
5757 if (!node)
5758 return NULL;
5760 ctx = isl_schedule_node_get_ctx(node);
5761 if (compute_schedule_wcc_band(ctx, graph) < 0)
5762 return isl_schedule_node_free(node);
5764 return compute_schedule_finish_band(node, graph, 1);
5767 /* Clustering information used by compute_schedule_wcc_clustering.
5769 * "n" is the number of SCCs in the original dependence graph
5770 * "scc" is an array of "n" elements, each representing an SCC
5771 * of the original dependence graph. All entries in the same cluster
5772 * have the same number of schedule rows.
5773 * "scc_cluster" maps each SCC index to the cluster to which it belongs,
5774 * where each cluster is represented by the index of the first SCC
5775 * in the cluster. Initially, each SCC belongs to a cluster containing
5776 * only that SCC.
5778 * "scc_in_merge" is used by merge_clusters_along_edge to keep
5779 * track of which SCCs need to be merged.
5781 * "cluster" contains the merged clusters of SCCs after the clustering
5782 * has completed.
5784 * "scc_node" is a temporary data structure used inside copy_partial.
5785 * For each SCC, it keeps track of the number of nodes in the SCC
5786 * that have already been copied.
5788 struct isl_clustering {
5789 int n;
5790 struct isl_sched_graph *scc;
5791 struct isl_sched_graph *cluster;
5792 int *scc_cluster;
5793 int *scc_node;
5794 int *scc_in_merge;
5797 /* Initialize the clustering data structure "c" from "graph".
5799 * In particular, allocate memory, extract the SCCs from "graph"
5800 * into c->scc, initialize scc_cluster and construct
5801 * a band of schedule rows for each SCC.
5802 * Within each SCC, there is only one SCC by definition.
5803 * Each SCC initially belongs to a cluster containing only that SCC.
5805 static isl_stat clustering_init(isl_ctx *ctx, struct isl_clustering *c,
5806 struct isl_sched_graph *graph)
5808 int i;
5810 c->n = graph->scc;
5811 c->scc = isl_calloc_array(ctx, struct isl_sched_graph, c->n);
5812 c->cluster = isl_calloc_array(ctx, struct isl_sched_graph, c->n);
5813 c->scc_cluster = isl_calloc_array(ctx, int, c->n);
5814 c->scc_node = isl_calloc_array(ctx, int, c->n);
5815 c->scc_in_merge = isl_calloc_array(ctx, int, c->n);
5816 if (!c->scc || !c->cluster ||
5817 !c->scc_cluster || !c->scc_node || !c->scc_in_merge)
5818 return isl_stat_error;
5820 for (i = 0; i < c->n; ++i) {
5821 if (extract_sub_graph(ctx, graph, &node_scc_exactly,
5822 &edge_scc_exactly, i, &c->scc[i]) < 0)
5823 return isl_stat_error;
5824 c->scc[i].scc = 1;
5825 if (compute_maxvar(&c->scc[i]) < 0)
5826 return isl_stat_error;
5827 if (compute_schedule_wcc_band(ctx, &c->scc[i]) < 0)
5828 return isl_stat_error;
5829 c->scc_cluster[i] = i;
5832 return isl_stat_ok;
5835 /* Free all memory allocated for "c".
5837 static void clustering_free(isl_ctx *ctx, struct isl_clustering *c)
5839 int i;
5841 if (c->scc)
5842 for (i = 0; i < c->n; ++i)
5843 graph_free(ctx, &c->scc[i]);
5844 free(c->scc);
5845 if (c->cluster)
5846 for (i = 0; i < c->n; ++i)
5847 graph_free(ctx, &c->cluster[i]);
5848 free(c->cluster);
5849 free(c->scc_cluster);
5850 free(c->scc_node);
5851 free(c->scc_in_merge);
5854 /* Should we refrain from merging the cluster in "graph" with
5855 * any other cluster?
5856 * In particular, is its current schedule band empty and incomplete.
5858 static int bad_cluster(struct isl_sched_graph *graph)
5860 return graph->n_row < graph->maxvar &&
5861 graph->n_total_row == graph->band_start;
5864 /* Is "edge" a proximity edge with a non-empty dependence relation?
5866 static isl_bool is_non_empty_proximity(struct isl_sched_edge *edge)
5868 if (!is_proximity(edge))
5869 return isl_bool_false;
5870 return isl_bool_not(isl_map_plain_is_empty(edge->map));
5873 /* Return the index of an edge in "graph" that can be used to merge
5874 * two clusters in "c".
5875 * Return graph->n_edge if no such edge can be found.
5876 * Return -1 on error.
5878 * In particular, return a proximity edge between two clusters
5879 * that is not marked "no_merge" and such that neither of the
5880 * two clusters has an incomplete, empty band.
5882 * If there are multiple such edges, then try and find the most
5883 * appropriate edge to use for merging. In particular, pick the edge
5884 * with the greatest weight. If there are multiple of those,
5885 * then pick one with the shortest distance between
5886 * the two cluster representatives.
5888 static int find_proximity(struct isl_sched_graph *graph,
5889 struct isl_clustering *c)
5891 int i, best = graph->n_edge, best_dist, best_weight;
5893 for (i = 0; i < graph->n_edge; ++i) {
5894 struct isl_sched_edge *edge = &graph->edge[i];
5895 int dist, weight;
5896 isl_bool prox;
5898 prox = is_non_empty_proximity(edge);
5899 if (prox < 0)
5900 return -1;
5901 if (!prox)
5902 continue;
5903 if (edge->no_merge)
5904 continue;
5905 if (bad_cluster(&c->scc[edge->src->scc]) ||
5906 bad_cluster(&c->scc[edge->dst->scc]))
5907 continue;
5908 dist = c->scc_cluster[edge->dst->scc] -
5909 c->scc_cluster[edge->src->scc];
5910 if (dist == 0)
5911 continue;
5912 weight = edge->weight;
5913 if (best < graph->n_edge) {
5914 if (best_weight > weight)
5915 continue;
5916 if (best_weight == weight && best_dist <= dist)
5917 continue;
5919 best = i;
5920 best_dist = dist;
5921 best_weight = weight;
5924 return best;
5927 /* Internal data structure used in mark_merge_sccs.
5929 * "graph" is the dependence graph in which a strongly connected
5930 * component is constructed.
5931 * "scc_cluster" maps each SCC index to the cluster to which it belongs.
5932 * "src" and "dst" are the indices of the nodes that are being merged.
5934 struct isl_mark_merge_sccs_data {
5935 struct isl_sched_graph *graph;
5936 int *scc_cluster;
5937 int src;
5938 int dst;
5941 /* Check whether the cluster containing node "i" depends on the cluster
5942 * containing node "j". If "i" and "j" belong to the same cluster,
5943 * then they are taken to depend on each other to ensure that
5944 * the resulting strongly connected component consists of complete
5945 * clusters. Furthermore, if "i" and "j" are the two nodes that
5946 * are being merged, then they are taken to depend on each other as well.
5947 * Otherwise, check if there is a (conditional) validity dependence
5948 * from node[j] to node[i], forcing node[i] to follow node[j].
5950 static isl_bool cluster_follows(int i, int j, void *user)
5952 struct isl_mark_merge_sccs_data *data = user;
5953 struct isl_sched_graph *graph = data->graph;
5954 int *scc_cluster = data->scc_cluster;
5956 if (data->src == i && data->dst == j)
5957 return isl_bool_true;
5958 if (data->src == j && data->dst == i)
5959 return isl_bool_true;
5960 if (scc_cluster[graph->node[i].scc] == scc_cluster[graph->node[j].scc])
5961 return isl_bool_true;
5963 return graph_has_validity_edge(graph, &graph->node[j], &graph->node[i]);
5966 /* Mark all SCCs that belong to either of the two clusters in "c"
5967 * connected by the edge in "graph" with index "edge", or to any
5968 * of the intermediate clusters.
5969 * The marking is recorded in c->scc_in_merge.
5971 * The given edge has been selected for merging two clusters,
5972 * meaning that there is at least a proximity edge between the two nodes.
5973 * However, there may also be (indirect) validity dependences
5974 * between the two nodes. When merging the two clusters, all clusters
5975 * containing one or more of the intermediate nodes along the
5976 * indirect validity dependences need to be merged in as well.
5978 * First collect all such nodes by computing the strongly connected
5979 * component (SCC) containing the two nodes connected by the edge, where
5980 * the two nodes are considered to depend on each other to make
5981 * sure they end up in the same SCC. Similarly, each node is considered
5982 * to depend on every other node in the same cluster to ensure
5983 * that the SCC consists of complete clusters.
5985 * Then the original SCCs that contain any of these nodes are marked
5986 * in c->scc_in_merge.
5988 static isl_stat mark_merge_sccs(isl_ctx *ctx, struct isl_sched_graph *graph,
5989 int edge, struct isl_clustering *c)
5991 struct isl_mark_merge_sccs_data data;
5992 struct isl_tarjan_graph *g;
5993 int i;
5995 for (i = 0; i < c->n; ++i)
5996 c->scc_in_merge[i] = 0;
5998 data.graph = graph;
5999 data.scc_cluster = c->scc_cluster;
6000 data.src = graph->edge[edge].src - graph->node;
6001 data.dst = graph->edge[edge].dst - graph->node;
6003 g = isl_tarjan_graph_component(ctx, graph->n, data.dst,
6004 &cluster_follows, &data);
6005 if (!g)
6006 goto error;
6008 i = g->op;
6009 if (i < 3)
6010 isl_die(ctx, isl_error_internal,
6011 "expecting at least two nodes in component",
6012 goto error);
6013 if (g->order[--i] != -1)
6014 isl_die(ctx, isl_error_internal,
6015 "expecting end of component marker", goto error);
6017 for (--i; i >= 0 && g->order[i] != -1; --i) {
6018 int scc = graph->node[g->order[i]].scc;
6019 c->scc_in_merge[scc] = 1;
6022 isl_tarjan_graph_free(g);
6023 return isl_stat_ok;
6024 error:
6025 isl_tarjan_graph_free(g);
6026 return isl_stat_error;
6029 /* Construct the identifier "cluster_i".
6031 static __isl_give isl_id *cluster_id(isl_ctx *ctx, int i)
6033 char name[40];
6035 snprintf(name, sizeof(name), "cluster_%d", i);
6036 return isl_id_alloc(ctx, name, NULL);
6039 /* Construct the space of the cluster with index "i" containing
6040 * the strongly connected component "scc".
6042 * In particular, construct a space called cluster_i with dimension equal
6043 * to the number of schedule rows in the current band of "scc".
6045 static __isl_give isl_space *cluster_space(struct isl_sched_graph *scc, int i)
6047 int nvar;
6048 isl_space *space;
6049 isl_id *id;
6051 nvar = scc->n_total_row - scc->band_start;
6052 space = isl_space_copy(scc->node[0].space);
6053 space = isl_space_params(space);
6054 space = isl_space_set_from_params(space);
6055 space = isl_space_add_dims(space, isl_dim_set, nvar);
6056 id = cluster_id(isl_space_get_ctx(space), i);
6057 space = isl_space_set_tuple_id(space, isl_dim_set, id);
6059 return space;
6062 /* Collect the domain of the graph for merging clusters.
6064 * In particular, for each cluster with first SCC "i", construct
6065 * a set in the space called cluster_i with dimension equal
6066 * to the number of schedule rows in the current band of the cluster.
6068 static __isl_give isl_union_set *collect_domain(isl_ctx *ctx,
6069 struct isl_sched_graph *graph, struct isl_clustering *c)
6071 int i;
6072 isl_space *space;
6073 isl_union_set *domain;
6075 space = isl_space_params_alloc(ctx, 0);
6076 domain = isl_union_set_empty(space);
6078 for (i = 0; i < graph->scc; ++i) {
6079 isl_space *space;
6081 if (!c->scc_in_merge[i])
6082 continue;
6083 if (c->scc_cluster[i] != i)
6084 continue;
6085 space = cluster_space(&c->scc[i], i);
6086 domain = isl_union_set_add_set(domain, isl_set_universe(space));
6089 return domain;
6092 /* Construct a map from the original instances to the corresponding
6093 * cluster instance in the current bands of the clusters in "c".
6095 static __isl_give isl_union_map *collect_cluster_map(isl_ctx *ctx,
6096 struct isl_sched_graph *graph, struct isl_clustering *c)
6098 int i, j;
6099 isl_space *space;
6100 isl_union_map *cluster_map;
6102 space = isl_space_params_alloc(ctx, 0);
6103 cluster_map = isl_union_map_empty(space);
6104 for (i = 0; i < graph->scc; ++i) {
6105 int start, n;
6106 isl_id *id;
6108 if (!c->scc_in_merge[i])
6109 continue;
6111 id = cluster_id(ctx, c->scc_cluster[i]);
6112 start = c->scc[i].band_start;
6113 n = c->scc[i].n_total_row - start;
6114 for (j = 0; j < c->scc[i].n; ++j) {
6115 isl_multi_aff *ma;
6116 isl_map *map;
6117 struct isl_sched_node *node = &c->scc[i].node[j];
6119 ma = node_extract_partial_schedule_multi_aff(node,
6120 start, n);
6121 ma = isl_multi_aff_set_tuple_id(ma, isl_dim_out,
6122 isl_id_copy(id));
6123 map = isl_map_from_multi_aff(ma);
6124 cluster_map = isl_union_map_add_map(cluster_map, map);
6126 isl_id_free(id);
6129 return cluster_map;
6132 /* Add "umap" to the schedule constraints "sc" of all types of "edge"
6133 * that are not isl_edge_condition or isl_edge_conditional_validity.
6135 static __isl_give isl_schedule_constraints *add_non_conditional_constraints(
6136 struct isl_sched_edge *edge, __isl_keep isl_union_map *umap,
6137 __isl_take isl_schedule_constraints *sc)
6139 enum isl_edge_type t;
6141 if (!sc)
6142 return NULL;
6144 for (t = isl_edge_first; t <= isl_edge_last; ++t) {
6145 if (t == isl_edge_condition ||
6146 t == isl_edge_conditional_validity)
6147 continue;
6148 if (!is_type(edge, t))
6149 continue;
6150 sc = isl_schedule_constraints_add(sc, t,
6151 isl_union_map_copy(umap));
6154 return sc;
6157 /* Add schedule constraints of types isl_edge_condition and
6158 * isl_edge_conditional_validity to "sc" by applying "umap" to
6159 * the domains of the wrapped relations in domain and range
6160 * of the corresponding tagged constraints of "edge".
6162 static __isl_give isl_schedule_constraints *add_conditional_constraints(
6163 struct isl_sched_edge *edge, __isl_keep isl_union_map *umap,
6164 __isl_take isl_schedule_constraints *sc)
6166 enum isl_edge_type t;
6167 isl_union_map *tagged;
6169 for (t = isl_edge_condition; t <= isl_edge_conditional_validity; ++t) {
6170 if (!is_type(edge, t))
6171 continue;
6172 if (t == isl_edge_condition)
6173 tagged = isl_union_map_copy(edge->tagged_condition);
6174 else
6175 tagged = isl_union_map_copy(edge->tagged_validity);
6176 tagged = isl_union_map_zip(tagged);
6177 tagged = isl_union_map_apply_domain(tagged,
6178 isl_union_map_copy(umap));
6179 tagged = isl_union_map_zip(tagged);
6180 sc = isl_schedule_constraints_add(sc, t, tagged);
6181 if (!sc)
6182 return NULL;
6185 return sc;
6188 /* Given a mapping "cluster_map" from the original instances to
6189 * the cluster instances, add schedule constraints on the clusters
6190 * to "sc" corresponding to the original constraints represented by "edge".
6192 * For non-tagged dependence constraints, the cluster constraints
6193 * are obtained by applying "cluster_map" to the edge->map.
6195 * For tagged dependence constraints, "cluster_map" needs to be applied
6196 * to the domains of the wrapped relations in domain and range
6197 * of the tagged dependence constraints. Pick out the mappings
6198 * from these domains from "cluster_map" and construct their product.
6199 * This mapping can then be applied to the pair of domains.
6201 static __isl_give isl_schedule_constraints *collect_edge_constraints(
6202 struct isl_sched_edge *edge, __isl_keep isl_union_map *cluster_map,
6203 __isl_take isl_schedule_constraints *sc)
6205 isl_union_map *umap;
6206 isl_space *space;
6207 isl_union_set *uset;
6208 isl_union_map *umap1, *umap2;
6210 if (!sc)
6211 return NULL;
6213 umap = isl_union_map_from_map(isl_map_copy(edge->map));
6214 umap = isl_union_map_apply_domain(umap,
6215 isl_union_map_copy(cluster_map));
6216 umap = isl_union_map_apply_range(umap,
6217 isl_union_map_copy(cluster_map));
6218 sc = add_non_conditional_constraints(edge, umap, sc);
6219 isl_union_map_free(umap);
6221 if (!sc || (!is_condition(edge) && !is_conditional_validity(edge)))
6222 return sc;
6224 space = isl_space_domain(isl_map_get_space(edge->map));
6225 uset = isl_union_set_from_set(isl_set_universe(space));
6226 umap1 = isl_union_map_copy(cluster_map);
6227 umap1 = isl_union_map_intersect_domain(umap1, uset);
6228 space = isl_space_range(isl_map_get_space(edge->map));
6229 uset = isl_union_set_from_set(isl_set_universe(space));
6230 umap2 = isl_union_map_copy(cluster_map);
6231 umap2 = isl_union_map_intersect_domain(umap2, uset);
6232 umap = isl_union_map_product(umap1, umap2);
6234 sc = add_conditional_constraints(edge, umap, sc);
6236 isl_union_map_free(umap);
6237 return sc;
6240 /* Given a mapping "cluster_map" from the original instances to
6241 * the cluster instances, add schedule constraints on the clusters
6242 * to "sc" corresponding to all edges in "graph" between nodes that
6243 * belong to SCCs that are marked for merging in "scc_in_merge".
6245 static __isl_give isl_schedule_constraints *collect_constraints(
6246 struct isl_sched_graph *graph, int *scc_in_merge,
6247 __isl_keep isl_union_map *cluster_map,
6248 __isl_take isl_schedule_constraints *sc)
6250 int i;
6252 for (i = 0; i < graph->n_edge; ++i) {
6253 struct isl_sched_edge *edge = &graph->edge[i];
6255 if (!scc_in_merge[edge->src->scc])
6256 continue;
6257 if (!scc_in_merge[edge->dst->scc])
6258 continue;
6259 sc = collect_edge_constraints(edge, cluster_map, sc);
6262 return sc;
6265 /* Construct a dependence graph for scheduling clusters with respect
6266 * to each other and store the result in "merge_graph".
6267 * In particular, the nodes of the graph correspond to the schedule
6268 * dimensions of the current bands of those clusters that have been
6269 * marked for merging in "c".
6271 * First construct an isl_schedule_constraints object for this domain
6272 * by transforming the edges in "graph" to the domain.
6273 * Then initialize a dependence graph for scheduling from these
6274 * constraints.
6276 static isl_stat init_merge_graph(isl_ctx *ctx, struct isl_sched_graph *graph,
6277 struct isl_clustering *c, struct isl_sched_graph *merge_graph)
6279 isl_union_set *domain;
6280 isl_union_map *cluster_map;
6281 isl_schedule_constraints *sc;
6282 isl_stat r;
6284 domain = collect_domain(ctx, graph, c);
6285 sc = isl_schedule_constraints_on_domain(domain);
6286 if (!sc)
6287 return isl_stat_error;
6288 cluster_map = collect_cluster_map(ctx, graph, c);
6289 sc = collect_constraints(graph, c->scc_in_merge, cluster_map, sc);
6290 isl_union_map_free(cluster_map);
6292 r = graph_init(merge_graph, sc);
6294 isl_schedule_constraints_free(sc);
6296 return r;
6299 /* Compute the maximal number of remaining schedule rows that still need
6300 * to be computed for the nodes that belong to clusters with the maximal
6301 * dimension for the current band (i.e., the band that is to be merged).
6302 * Only clusters that are about to be merged are considered.
6303 * "maxvar" is the maximal dimension for the current band.
6304 * "c" contains information about the clusters.
6306 * Return the maximal number of remaining schedule rows or -1 on error.
6308 static int compute_maxvar_max_slack(int maxvar, struct isl_clustering *c)
6310 int i, j;
6311 int max_slack;
6313 max_slack = 0;
6314 for (i = 0; i < c->n; ++i) {
6315 int nvar;
6316 struct isl_sched_graph *scc;
6318 if (!c->scc_in_merge[i])
6319 continue;
6320 scc = &c->scc[i];
6321 nvar = scc->n_total_row - scc->band_start;
6322 if (nvar != maxvar)
6323 continue;
6324 for (j = 0; j < scc->n; ++j) {
6325 struct isl_sched_node *node = &scc->node[j];
6326 int slack;
6328 if (node_update_vmap(node) < 0)
6329 return -1;
6330 slack = node->nvar - node->rank;
6331 if (slack > max_slack)
6332 max_slack = slack;
6336 return max_slack;
6339 /* If there are any clusters where the dimension of the current band
6340 * (i.e., the band that is to be merged) is smaller than "maxvar" and
6341 * if there are any nodes in such a cluster where the number
6342 * of remaining schedule rows that still need to be computed
6343 * is greater than "max_slack", then return the smallest current band
6344 * dimension of all these clusters. Otherwise return the original value
6345 * of "maxvar". Return -1 in case of any error.
6346 * Only clusters that are about to be merged are considered.
6347 * "c" contains information about the clusters.
6349 static int limit_maxvar_to_slack(int maxvar, int max_slack,
6350 struct isl_clustering *c)
6352 int i, j;
6354 for (i = 0; i < c->n; ++i) {
6355 int nvar;
6356 struct isl_sched_graph *scc;
6358 if (!c->scc_in_merge[i])
6359 continue;
6360 scc = &c->scc[i];
6361 nvar = scc->n_total_row - scc->band_start;
6362 if (nvar >= maxvar)
6363 continue;
6364 for (j = 0; j < scc->n; ++j) {
6365 struct isl_sched_node *node = &scc->node[j];
6366 int slack;
6368 if (node_update_vmap(node) < 0)
6369 return -1;
6370 slack = node->nvar - node->rank;
6371 if (slack > max_slack) {
6372 maxvar = nvar;
6373 break;
6378 return maxvar;
6381 /* Adjust merge_graph->maxvar based on the number of remaining schedule rows
6382 * that still need to be computed. In particular, if there is a node
6383 * in a cluster where the dimension of the current band is smaller
6384 * than merge_graph->maxvar, but the number of remaining schedule rows
6385 * is greater than that of any node in a cluster with the maximal
6386 * dimension for the current band (i.e., merge_graph->maxvar),
6387 * then adjust merge_graph->maxvar to the (smallest) current band dimension
6388 * of those clusters. Without this adjustment, the total number of
6389 * schedule dimensions would be increased, resulting in a skewed view
6390 * of the number of coincident dimensions.
6391 * "c" contains information about the clusters.
6393 * If the maximize_band_depth option is set and merge_graph->maxvar is reduced,
6394 * then there is no point in attempting any merge since it will be rejected
6395 * anyway. Set merge_graph->maxvar to zero in such cases.
6397 static isl_stat adjust_maxvar_to_slack(isl_ctx *ctx,
6398 struct isl_sched_graph *merge_graph, struct isl_clustering *c)
6400 int max_slack, maxvar;
6402 max_slack = compute_maxvar_max_slack(merge_graph->maxvar, c);
6403 if (max_slack < 0)
6404 return isl_stat_error;
6405 maxvar = limit_maxvar_to_slack(merge_graph->maxvar, max_slack, c);
6406 if (maxvar < 0)
6407 return isl_stat_error;
6409 if (maxvar < merge_graph->maxvar) {
6410 if (isl_options_get_schedule_maximize_band_depth(ctx))
6411 merge_graph->maxvar = 0;
6412 else
6413 merge_graph->maxvar = maxvar;
6416 return isl_stat_ok;
6419 /* Return the number of coincident dimensions in the current band of "graph",
6420 * where the nodes of "graph" are assumed to be scheduled by a single band.
6422 static int get_n_coincident(struct isl_sched_graph *graph)
6424 int i;
6426 for (i = graph->band_start; i < graph->n_total_row; ++i)
6427 if (!graph->node[0].coincident[i])
6428 break;
6430 return i - graph->band_start;
6433 /* Should the clusters be merged based on the cluster schedule
6434 * in the current (and only) band of "merge_graph", given that
6435 * coincidence should be maximized?
6437 * If the number of coincident schedule dimensions in the merged band
6438 * would be less than the maximal number of coincident schedule dimensions
6439 * in any of the merged clusters, then the clusters should not be merged.
6441 static isl_bool ok_to_merge_coincident(struct isl_clustering *c,
6442 struct isl_sched_graph *merge_graph)
6444 int i;
6445 int n_coincident;
6446 int max_coincident;
6448 max_coincident = 0;
6449 for (i = 0; i < c->n; ++i) {
6450 if (!c->scc_in_merge[i])
6451 continue;
6452 n_coincident = get_n_coincident(&c->scc[i]);
6453 if (n_coincident > max_coincident)
6454 max_coincident = n_coincident;
6457 n_coincident = get_n_coincident(merge_graph);
6459 return n_coincident >= max_coincident;
6462 /* Return the transformation on "node" expressed by the current (and only)
6463 * band of "merge_graph" applied to the clusters in "c".
6465 * First find the representation of "node" in its SCC in "c" and
6466 * extract the transformation expressed by the current band.
6467 * Then extract the transformation applied by "merge_graph"
6468 * to the cluster to which this SCC belongs.
6469 * Combine the two to obtain the complete transformation on the node.
6471 * Note that the range of the first transformation is an anonymous space,
6472 * while the domain of the second is named "cluster_X". The range
6473 * of the former therefore needs to be adjusted before the two
6474 * can be combined.
6476 static __isl_give isl_map *extract_node_transformation(isl_ctx *ctx,
6477 struct isl_sched_node *node, struct isl_clustering *c,
6478 struct isl_sched_graph *merge_graph)
6480 struct isl_sched_node *scc_node, *cluster_node;
6481 int start, n;
6482 isl_id *id;
6483 isl_space *space;
6484 isl_multi_aff *ma, *ma2;
6486 scc_node = graph_find_node(ctx, &c->scc[node->scc], node->space);
6487 if (scc_node && !is_node(&c->scc[node->scc], scc_node))
6488 isl_die(ctx, isl_error_internal, "unable to find node",
6489 return NULL);
6490 start = c->scc[node->scc].band_start;
6491 n = c->scc[node->scc].n_total_row - start;
6492 ma = node_extract_partial_schedule_multi_aff(scc_node, start, n);
6493 space = cluster_space(&c->scc[node->scc], c->scc_cluster[node->scc]);
6494 cluster_node = graph_find_node(ctx, merge_graph, space);
6495 if (cluster_node && !is_node(merge_graph, cluster_node))
6496 isl_die(ctx, isl_error_internal, "unable to find cluster",
6497 space = isl_space_free(space));
6498 id = isl_space_get_tuple_id(space, isl_dim_set);
6499 ma = isl_multi_aff_set_tuple_id(ma, isl_dim_out, id);
6500 isl_space_free(space);
6501 n = merge_graph->n_total_row;
6502 ma2 = node_extract_partial_schedule_multi_aff(cluster_node, 0, n);
6503 ma = isl_multi_aff_pullback_multi_aff(ma2, ma);
6505 return isl_map_from_multi_aff(ma);
6508 /* Give a set of distances "set", are they bounded by a small constant
6509 * in direction "pos"?
6510 * In practice, check if they are bounded by 2 by checking that there
6511 * are no elements with a value greater than or equal to 3 or
6512 * smaller than or equal to -3.
6514 static isl_bool distance_is_bounded(__isl_keep isl_set *set, int pos)
6516 isl_bool bounded;
6517 isl_set *test;
6519 if (!set)
6520 return isl_bool_error;
6522 test = isl_set_copy(set);
6523 test = isl_set_lower_bound_si(test, isl_dim_set, pos, 3);
6524 bounded = isl_set_is_empty(test);
6525 isl_set_free(test);
6527 if (bounded < 0 || !bounded)
6528 return bounded;
6530 test = isl_set_copy(set);
6531 test = isl_set_upper_bound_si(test, isl_dim_set, pos, -3);
6532 bounded = isl_set_is_empty(test);
6533 isl_set_free(test);
6535 return bounded;
6538 /* Does the set "set" have a fixed (but possible parametric) value
6539 * at dimension "pos"?
6541 static isl_bool has_single_value(__isl_keep isl_set *set, int pos)
6543 isl_size n;
6544 isl_bool single;
6546 n = isl_set_dim(set, isl_dim_set);
6547 if (n < 0)
6548 return isl_bool_error;
6549 set = isl_set_copy(set);
6550 set = isl_set_project_out(set, isl_dim_set, pos + 1, n - (pos + 1));
6551 set = isl_set_project_out(set, isl_dim_set, 0, pos);
6552 single = isl_set_is_singleton(set);
6553 isl_set_free(set);
6555 return single;
6558 /* Does "map" have a fixed (but possible parametric) value
6559 * at dimension "pos" of either its domain or its range?
6561 static isl_bool has_singular_src_or_dst(__isl_keep isl_map *map, int pos)
6563 isl_set *set;
6564 isl_bool single;
6566 set = isl_map_domain(isl_map_copy(map));
6567 single = has_single_value(set, pos);
6568 isl_set_free(set);
6570 if (single < 0 || single)
6571 return single;
6573 set = isl_map_range(isl_map_copy(map));
6574 single = has_single_value(set, pos);
6575 isl_set_free(set);
6577 return single;
6580 /* Does the edge "edge" from "graph" have bounded dependence distances
6581 * in the merged graph "merge_graph" of a selection of clusters in "c"?
6583 * Extract the complete transformations of the source and destination
6584 * nodes of the edge, apply them to the edge constraints and
6585 * compute the differences. Finally, check if these differences are bounded
6586 * in each direction.
6588 * If the dimension of the band is greater than the number of
6589 * dimensions that can be expected to be optimized by the edge
6590 * (based on its weight), then also allow the differences to be unbounded
6591 * in the remaining dimensions, but only if either the source or
6592 * the destination has a fixed value in that direction.
6593 * This allows a statement that produces values that are used by
6594 * several instances of another statement to be merged with that
6595 * other statement.
6596 * However, merging such clusters will introduce an inherently
6597 * large proximity distance inside the merged cluster, meaning
6598 * that proximity distances will no longer be optimized in
6599 * subsequent merges. These merges are therefore only allowed
6600 * after all other possible merges have been tried.
6601 * The first time such a merge is encountered, the weight of the edge
6602 * is replaced by a negative weight. The second time (i.e., after
6603 * all merges over edges with a non-negative weight have been tried),
6604 * the merge is allowed.
6606 static isl_bool has_bounded_distances(isl_ctx *ctx, struct isl_sched_edge *edge,
6607 struct isl_sched_graph *graph, struct isl_clustering *c,
6608 struct isl_sched_graph *merge_graph)
6610 int i, n_slack;
6611 isl_size n;
6612 isl_bool bounded;
6613 isl_map *map, *t;
6614 isl_set *dist;
6616 map = isl_map_copy(edge->map);
6617 t = extract_node_transformation(ctx, edge->src, c, merge_graph);
6618 map = isl_map_apply_domain(map, t);
6619 t = extract_node_transformation(ctx, edge->dst, c, merge_graph);
6620 map = isl_map_apply_range(map, t);
6621 dist = isl_map_deltas(isl_map_copy(map));
6623 bounded = isl_bool_true;
6624 n = isl_set_dim(dist, isl_dim_set);
6625 if (n < 0)
6626 goto error;
6627 n_slack = n - edge->weight;
6628 if (edge->weight < 0)
6629 n_slack -= graph->max_weight + 1;
6630 for (i = 0; i < n; ++i) {
6631 isl_bool bounded_i, singular_i;
6633 bounded_i = distance_is_bounded(dist, i);
6634 if (bounded_i < 0)
6635 goto error;
6636 if (bounded_i)
6637 continue;
6638 if (edge->weight >= 0)
6639 bounded = isl_bool_false;
6640 n_slack--;
6641 if (n_slack < 0)
6642 break;
6643 singular_i = has_singular_src_or_dst(map, i);
6644 if (singular_i < 0)
6645 goto error;
6646 if (singular_i)
6647 continue;
6648 bounded = isl_bool_false;
6649 break;
6651 if (!bounded && i >= n && edge->weight >= 0)
6652 edge->weight -= graph->max_weight + 1;
6653 isl_map_free(map);
6654 isl_set_free(dist);
6656 return bounded;
6657 error:
6658 isl_map_free(map);
6659 isl_set_free(dist);
6660 return isl_bool_error;
6663 /* Should the clusters be merged based on the cluster schedule
6664 * in the current (and only) band of "merge_graph"?
6665 * "graph" is the original dependence graph, while "c" records
6666 * which SCCs are involved in the latest merge.
6668 * In particular, is there at least one proximity constraint
6669 * that is optimized by the merge?
6671 * A proximity constraint is considered to be optimized
6672 * if the dependence distances are small.
6674 static isl_bool ok_to_merge_proximity(isl_ctx *ctx,
6675 struct isl_sched_graph *graph, struct isl_clustering *c,
6676 struct isl_sched_graph *merge_graph)
6678 int i;
6680 for (i = 0; i < graph->n_edge; ++i) {
6681 struct isl_sched_edge *edge = &graph->edge[i];
6682 isl_bool bounded;
6684 if (!is_proximity(edge))
6685 continue;
6686 if (!c->scc_in_merge[edge->src->scc])
6687 continue;
6688 if (!c->scc_in_merge[edge->dst->scc])
6689 continue;
6690 if (c->scc_cluster[edge->dst->scc] ==
6691 c->scc_cluster[edge->src->scc])
6692 continue;
6693 bounded = has_bounded_distances(ctx, edge, graph, c,
6694 merge_graph);
6695 if (bounded < 0 || bounded)
6696 return bounded;
6699 return isl_bool_false;
6702 /* Should the clusters be merged based on the cluster schedule
6703 * in the current (and only) band of "merge_graph"?
6704 * "graph" is the original dependence graph, while "c" records
6705 * which SCCs are involved in the latest merge.
6707 * If the current band is empty, then the clusters should not be merged.
6709 * If the band depth should be maximized and the merge schedule
6710 * is incomplete (meaning that the dimension of some of the schedule
6711 * bands in the original schedule will be reduced), then the clusters
6712 * should not be merged.
6714 * If the schedule_maximize_coincidence option is set, then check that
6715 * the number of coincident schedule dimensions is not reduced.
6717 * Finally, only allow the merge if at least one proximity
6718 * constraint is optimized.
6720 static isl_bool ok_to_merge(isl_ctx *ctx, struct isl_sched_graph *graph,
6721 struct isl_clustering *c, struct isl_sched_graph *merge_graph)
6723 if (merge_graph->n_total_row == merge_graph->band_start)
6724 return isl_bool_false;
6726 if (isl_options_get_schedule_maximize_band_depth(ctx) &&
6727 merge_graph->n_total_row < merge_graph->maxvar)
6728 return isl_bool_false;
6730 if (isl_options_get_schedule_maximize_coincidence(ctx)) {
6731 isl_bool ok;
6733 ok = ok_to_merge_coincident(c, merge_graph);
6734 if (ok < 0 || !ok)
6735 return ok;
6738 return ok_to_merge_proximity(ctx, graph, c, merge_graph);
6741 /* Apply the schedule in "t_node" to the "n" rows starting at "first"
6742 * of the schedule in "node" and return the result.
6744 * That is, essentially compute
6746 * T * N(first:first+n-1)
6748 * taking into account the constant term and the parameter coefficients
6749 * in "t_node".
6751 static __isl_give isl_mat *node_transformation(isl_ctx *ctx,
6752 struct isl_sched_node *t_node, struct isl_sched_node *node,
6753 int first, int n)
6755 int i, j;
6756 isl_mat *t;
6757 isl_size n_row, n_col;
6758 int n_param, n_var;
6760 n_param = node->nparam;
6761 n_var = node->nvar;
6762 n_row = isl_mat_rows(t_node->sched);
6763 n_col = isl_mat_cols(node->sched);
6764 if (n_row < 0 || n_col < 0)
6765 return NULL;
6766 t = isl_mat_alloc(ctx, n_row, n_col);
6767 if (!t)
6768 return NULL;
6769 for (i = 0; i < n_row; ++i) {
6770 isl_seq_cpy(t->row[i], t_node->sched->row[i], 1 + n_param);
6771 isl_seq_clr(t->row[i] + 1 + n_param, n_var);
6772 for (j = 0; j < n; ++j)
6773 isl_seq_addmul(t->row[i],
6774 t_node->sched->row[i][1 + n_param + j],
6775 node->sched->row[first + j],
6776 1 + n_param + n_var);
6778 return t;
6781 /* Apply the cluster schedule in "t_node" to the current band
6782 * schedule of the nodes in "graph".
6784 * In particular, replace the rows starting at band_start
6785 * by the result of applying the cluster schedule in "t_node"
6786 * to the original rows.
6788 * The coincidence of the schedule is determined by the coincidence
6789 * of the cluster schedule.
6791 static isl_stat transform(isl_ctx *ctx, struct isl_sched_graph *graph,
6792 struct isl_sched_node *t_node)
6794 int i, j;
6795 isl_size n_new;
6796 int start, n;
6798 start = graph->band_start;
6799 n = graph->n_total_row - start;
6801 n_new = isl_mat_rows(t_node->sched);
6802 if (n_new < 0)
6803 return isl_stat_error;
6804 for (i = 0; i < graph->n; ++i) {
6805 struct isl_sched_node *node = &graph->node[i];
6806 isl_mat *t;
6808 t = node_transformation(ctx, t_node, node, start, n);
6809 node->sched = isl_mat_drop_rows(node->sched, start, n);
6810 node->sched = isl_mat_concat(node->sched, t);
6811 node->sched_map = isl_map_free(node->sched_map);
6812 if (!node->sched)
6813 return isl_stat_error;
6814 for (j = 0; j < n_new; ++j)
6815 node->coincident[start + j] = t_node->coincident[j];
6817 graph->n_total_row -= n;
6818 graph->n_row -= n;
6819 graph->n_total_row += n_new;
6820 graph->n_row += n_new;
6822 return isl_stat_ok;
6825 /* Merge the clusters marked for merging in "c" into a single
6826 * cluster using the cluster schedule in the current band of "merge_graph".
6827 * The representative SCC for the new cluster is the SCC with
6828 * the smallest index.
6830 * The current band schedule of each SCC in the new cluster is obtained
6831 * by applying the schedule of the corresponding original cluster
6832 * to the original band schedule.
6833 * All SCCs in the new cluster have the same number of schedule rows.
6835 static isl_stat merge(isl_ctx *ctx, struct isl_clustering *c,
6836 struct isl_sched_graph *merge_graph)
6838 int i;
6839 int cluster = -1;
6840 isl_space *space;
6842 for (i = 0; i < c->n; ++i) {
6843 struct isl_sched_node *node;
6845 if (!c->scc_in_merge[i])
6846 continue;
6847 if (cluster < 0)
6848 cluster = i;
6849 space = cluster_space(&c->scc[i], c->scc_cluster[i]);
6850 node = graph_find_node(ctx, merge_graph, space);
6851 isl_space_free(space);
6852 if (!node)
6853 return isl_stat_error;
6854 if (!is_node(merge_graph, node))
6855 isl_die(ctx, isl_error_internal,
6856 "unable to find cluster",
6857 return isl_stat_error);
6858 if (transform(ctx, &c->scc[i], node) < 0)
6859 return isl_stat_error;
6860 c->scc_cluster[i] = cluster;
6863 return isl_stat_ok;
6866 /* Try and merge the clusters of SCCs marked in c->scc_in_merge
6867 * by scheduling the current cluster bands with respect to each other.
6869 * Construct a dependence graph with a space for each cluster and
6870 * with the coordinates of each space corresponding to the schedule
6871 * dimensions of the current band of that cluster.
6872 * Construct a cluster schedule in this cluster dependence graph and
6873 * apply it to the current cluster bands if it is applicable
6874 * according to ok_to_merge.
6876 * If the number of remaining schedule dimensions in a cluster
6877 * with a non-maximal current schedule dimension is greater than
6878 * the number of remaining schedule dimensions in clusters
6879 * with a maximal current schedule dimension, then restrict
6880 * the number of rows to be computed in the cluster schedule
6881 * to the minimal such non-maximal current schedule dimension.
6882 * Do this by adjusting merge_graph.maxvar.
6884 * Return isl_bool_true if the clusters have effectively been merged
6885 * into a single cluster.
6887 * Note that since the standard scheduling algorithm minimizes the maximal
6888 * distance over proximity constraints, the proximity constraints between
6889 * the merged clusters may not be optimized any further than what is
6890 * sufficient to bring the distances within the limits of the internal
6891 * proximity constraints inside the individual clusters.
6892 * It may therefore make sense to perform an additional translation step
6893 * to bring the clusters closer to each other, while maintaining
6894 * the linear part of the merging schedule found using the standard
6895 * scheduling algorithm.
6897 static isl_bool try_merge(isl_ctx *ctx, struct isl_sched_graph *graph,
6898 struct isl_clustering *c)
6900 struct isl_sched_graph merge_graph = { 0 };
6901 isl_bool merged;
6903 if (init_merge_graph(ctx, graph, c, &merge_graph) < 0)
6904 goto error;
6906 if (compute_maxvar(&merge_graph) < 0)
6907 goto error;
6908 if (adjust_maxvar_to_slack(ctx, &merge_graph,c) < 0)
6909 goto error;
6910 if (compute_schedule_wcc_band(ctx, &merge_graph) < 0)
6911 goto error;
6912 merged = ok_to_merge(ctx, graph, c, &merge_graph);
6913 if (merged && merge(ctx, c, &merge_graph) < 0)
6914 goto error;
6916 graph_free(ctx, &merge_graph);
6917 return merged;
6918 error:
6919 graph_free(ctx, &merge_graph);
6920 return isl_bool_error;
6923 /* Is there any edge marked "no_merge" between two SCCs that are
6924 * about to be merged (i.e., that are set in "scc_in_merge")?
6925 * "merge_edge" is the proximity edge along which the clusters of SCCs
6926 * are going to be merged.
6928 * If there is any edge between two SCCs with a negative weight,
6929 * while the weight of "merge_edge" is non-negative, then this
6930 * means that the edge was postponed. "merge_edge" should then
6931 * also be postponed since merging along the edge with negative weight should
6932 * be postponed until all edges with non-negative weight have been tried.
6933 * Replace the weight of "merge_edge" by a negative weight as well and
6934 * tell the caller not to attempt a merge.
6936 static int any_no_merge(struct isl_sched_graph *graph, int *scc_in_merge,
6937 struct isl_sched_edge *merge_edge)
6939 int i;
6941 for (i = 0; i < graph->n_edge; ++i) {
6942 struct isl_sched_edge *edge = &graph->edge[i];
6944 if (!scc_in_merge[edge->src->scc])
6945 continue;
6946 if (!scc_in_merge[edge->dst->scc])
6947 continue;
6948 if (edge->no_merge)
6949 return 1;
6950 if (merge_edge->weight >= 0 && edge->weight < 0) {
6951 merge_edge->weight -= graph->max_weight + 1;
6952 return 1;
6956 return 0;
6959 /* Merge the two clusters in "c" connected by the edge in "graph"
6960 * with index "edge" into a single cluster.
6961 * If it turns out to be impossible to merge these two clusters,
6962 * then mark the edge as "no_merge" such that it will not be
6963 * considered again.
6965 * First mark all SCCs that need to be merged. This includes the SCCs
6966 * in the two clusters, but it may also include the SCCs
6967 * of intermediate clusters.
6968 * If there is already a no_merge edge between any pair of such SCCs,
6969 * then simply mark the current edge as no_merge as well.
6970 * Likewise, if any of those edges was postponed by has_bounded_distances,
6971 * then postpone the current edge as well.
6972 * Otherwise, try and merge the clusters and mark "edge" as "no_merge"
6973 * if the clusters did not end up getting merged, unless the non-merge
6974 * is due to the fact that the edge was postponed. This postponement
6975 * can be recognized by a change in weight (from non-negative to negative).
6977 static isl_stat merge_clusters_along_edge(isl_ctx *ctx,
6978 struct isl_sched_graph *graph, int edge, struct isl_clustering *c)
6980 isl_bool merged;
6981 int edge_weight = graph->edge[edge].weight;
6983 if (mark_merge_sccs(ctx, graph, edge, c) < 0)
6984 return isl_stat_error;
6986 if (any_no_merge(graph, c->scc_in_merge, &graph->edge[edge]))
6987 merged = isl_bool_false;
6988 else
6989 merged = try_merge(ctx, graph, c);
6990 if (merged < 0)
6991 return isl_stat_error;
6992 if (!merged && edge_weight == graph->edge[edge].weight)
6993 graph->edge[edge].no_merge = 1;
6995 return isl_stat_ok;
6998 /* Does "node" belong to the cluster identified by "cluster"?
7000 static int node_cluster_exactly(struct isl_sched_node *node, int cluster)
7002 return node->cluster == cluster;
7005 /* Does "edge" connect two nodes belonging to the cluster
7006 * identified by "cluster"?
7008 static int edge_cluster_exactly(struct isl_sched_edge *edge, int cluster)
7010 return edge->src->cluster == cluster && edge->dst->cluster == cluster;
7013 /* Swap the schedule of "node1" and "node2".
7014 * Both nodes have been derived from the same node in a common parent graph.
7015 * Since the "coincident" field is shared with that node
7016 * in the parent graph, there is no need to also swap this field.
7018 static void swap_sched(struct isl_sched_node *node1,
7019 struct isl_sched_node *node2)
7021 isl_mat *sched;
7022 isl_map *sched_map;
7024 sched = node1->sched;
7025 node1->sched = node2->sched;
7026 node2->sched = sched;
7028 sched_map = node1->sched_map;
7029 node1->sched_map = node2->sched_map;
7030 node2->sched_map = sched_map;
7033 /* Copy the current band schedule from the SCCs that form the cluster
7034 * with index "pos" to the actual cluster at position "pos".
7035 * By construction, the index of the first SCC that belongs to the cluster
7036 * is also "pos".
7038 * The order of the nodes inside both the SCCs and the cluster
7039 * is assumed to be same as the order in the original "graph".
7041 * Since the SCC graphs will no longer be used after this function,
7042 * the schedules are actually swapped rather than copied.
7044 static isl_stat copy_partial(struct isl_sched_graph *graph,
7045 struct isl_clustering *c, int pos)
7047 int i, j;
7049 c->cluster[pos].n_total_row = c->scc[pos].n_total_row;
7050 c->cluster[pos].n_row = c->scc[pos].n_row;
7051 c->cluster[pos].maxvar = c->scc[pos].maxvar;
7052 j = 0;
7053 for (i = 0; i < graph->n; ++i) {
7054 int k;
7055 int s;
7057 if (graph->node[i].cluster != pos)
7058 continue;
7059 s = graph->node[i].scc;
7060 k = c->scc_node[s]++;
7061 swap_sched(&c->cluster[pos].node[j], &c->scc[s].node[k]);
7062 if (c->scc[s].maxvar > c->cluster[pos].maxvar)
7063 c->cluster[pos].maxvar = c->scc[s].maxvar;
7064 ++j;
7067 return isl_stat_ok;
7070 /* Is there a (conditional) validity dependence from node[j] to node[i],
7071 * forcing node[i] to follow node[j] or do the nodes belong to the same
7072 * cluster?
7074 static isl_bool node_follows_strong_or_same_cluster(int i, int j, void *user)
7076 struct isl_sched_graph *graph = user;
7078 if (graph->node[i].cluster == graph->node[j].cluster)
7079 return isl_bool_true;
7080 return graph_has_validity_edge(graph, &graph->node[j], &graph->node[i]);
7083 /* Extract the merged clusters of SCCs in "graph", sort them, and
7084 * store them in c->clusters. Update c->scc_cluster accordingly.
7086 * First keep track of the cluster containing the SCC to which a node
7087 * belongs in the node itself.
7088 * Then extract the clusters into c->clusters, copying the current
7089 * band schedule from the SCCs that belong to the cluster.
7090 * Do this only once per cluster.
7092 * Finally, topologically sort the clusters and update c->scc_cluster
7093 * to match the new scc numbering. While the SCCs were originally
7094 * sorted already, some SCCs that depend on some other SCCs may
7095 * have been merged with SCCs that appear before these other SCCs.
7096 * A reordering may therefore be required.
7098 static isl_stat extract_clusters(isl_ctx *ctx, struct isl_sched_graph *graph,
7099 struct isl_clustering *c)
7101 int i;
7103 for (i = 0; i < graph->n; ++i)
7104 graph->node[i].cluster = c->scc_cluster[graph->node[i].scc];
7106 for (i = 0; i < graph->scc; ++i) {
7107 if (c->scc_cluster[i] != i)
7108 continue;
7109 if (extract_sub_graph(ctx, graph, &node_cluster_exactly,
7110 &edge_cluster_exactly, i, &c->cluster[i]) < 0)
7111 return isl_stat_error;
7112 c->cluster[i].src_scc = -1;
7113 c->cluster[i].dst_scc = -1;
7114 if (copy_partial(graph, c, i) < 0)
7115 return isl_stat_error;
7118 if (detect_ccs(ctx, graph, &node_follows_strong_or_same_cluster) < 0)
7119 return isl_stat_error;
7120 for (i = 0; i < graph->n; ++i)
7121 c->scc_cluster[graph->node[i].scc] = graph->node[i].cluster;
7123 return isl_stat_ok;
7126 /* Compute weights on the proximity edges of "graph" that can
7127 * be used by find_proximity to find the most appropriate
7128 * proximity edge to use to merge two clusters in "c".
7129 * The weights are also used by has_bounded_distances to determine
7130 * whether the merge should be allowed.
7131 * Store the maximum of the computed weights in graph->max_weight.
7133 * The computed weight is a measure for the number of remaining schedule
7134 * dimensions that can still be completely aligned.
7135 * In particular, compute the number of equalities between
7136 * input dimensions and output dimensions in the proximity constraints.
7137 * The directions that are already handled by outer schedule bands
7138 * are projected out prior to determining this number.
7140 * Edges that will never be considered by find_proximity are ignored.
7142 static isl_stat compute_weights(struct isl_sched_graph *graph,
7143 struct isl_clustering *c)
7145 int i;
7147 graph->max_weight = 0;
7149 for (i = 0; i < graph->n_edge; ++i) {
7150 struct isl_sched_edge *edge = &graph->edge[i];
7151 struct isl_sched_node *src = edge->src;
7152 struct isl_sched_node *dst = edge->dst;
7153 isl_basic_map *hull;
7154 isl_bool prox;
7155 isl_size n_in, n_out;
7157 prox = is_non_empty_proximity(edge);
7158 if (prox < 0)
7159 return isl_stat_error;
7160 if (!prox)
7161 continue;
7162 if (bad_cluster(&c->scc[edge->src->scc]) ||
7163 bad_cluster(&c->scc[edge->dst->scc]))
7164 continue;
7165 if (c->scc_cluster[edge->dst->scc] ==
7166 c->scc_cluster[edge->src->scc])
7167 continue;
7169 hull = isl_map_affine_hull(isl_map_copy(edge->map));
7170 hull = isl_basic_map_transform_dims(hull, isl_dim_in, 0,
7171 isl_mat_copy(src->vmap));
7172 hull = isl_basic_map_transform_dims(hull, isl_dim_out, 0,
7173 isl_mat_copy(dst->vmap));
7174 hull = isl_basic_map_project_out(hull,
7175 isl_dim_in, 0, src->rank);
7176 hull = isl_basic_map_project_out(hull,
7177 isl_dim_out, 0, dst->rank);
7178 hull = isl_basic_map_remove_divs(hull);
7179 n_in = isl_basic_map_dim(hull, isl_dim_in);
7180 n_out = isl_basic_map_dim(hull, isl_dim_out);
7181 if (n_in < 0 || n_out < 0)
7182 hull = isl_basic_map_free(hull);
7183 hull = isl_basic_map_drop_constraints_not_involving_dims(hull,
7184 isl_dim_in, 0, n_in);
7185 hull = isl_basic_map_drop_constraints_not_involving_dims(hull,
7186 isl_dim_out, 0, n_out);
7187 if (!hull)
7188 return isl_stat_error;
7189 edge->weight = isl_basic_map_n_equality(hull);
7190 isl_basic_map_free(hull);
7192 if (edge->weight > graph->max_weight)
7193 graph->max_weight = edge->weight;
7196 return isl_stat_ok;
7199 /* Call compute_schedule_finish_band on each of the clusters in "c"
7200 * in their topological order. This order is determined by the scc
7201 * fields of the nodes in "graph".
7202 * Combine the results in a sequence expressing the topological order.
7204 * If there is only one cluster left, then there is no need to introduce
7205 * a sequence node. Also, in this case, the cluster necessarily contains
7206 * the SCC at position 0 in the original graph and is therefore also
7207 * stored in the first cluster of "c".
7209 static __isl_give isl_schedule_node *finish_bands_clustering(
7210 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
7211 struct isl_clustering *c)
7213 int i;
7214 isl_ctx *ctx;
7215 isl_union_set_list *filters;
7217 if (graph->scc == 1)
7218 return compute_schedule_finish_band(node, &c->cluster[0], 0);
7220 ctx = isl_schedule_node_get_ctx(node);
7222 filters = extract_sccs(ctx, graph);
7223 node = isl_schedule_node_insert_sequence(node, filters);
7225 for (i = 0; i < graph->scc; ++i) {
7226 int j = c->scc_cluster[i];
7227 node = isl_schedule_node_child(node, i);
7228 node = isl_schedule_node_child(node, 0);
7229 node = compute_schedule_finish_band(node, &c->cluster[j], 0);
7230 node = isl_schedule_node_parent(node);
7231 node = isl_schedule_node_parent(node);
7234 return node;
7237 /* Compute a schedule for a connected dependence graph by first considering
7238 * each strongly connected component (SCC) in the graph separately and then
7239 * incrementally combining them into clusters.
7240 * Return the updated schedule node.
7242 * Initially, each cluster consists of a single SCC, each with its
7243 * own band schedule. The algorithm then tries to merge pairs
7244 * of clusters along a proximity edge until no more suitable
7245 * proximity edges can be found. During this merging, the schedule
7246 * is maintained in the individual SCCs.
7247 * After the merging is completed, the full resulting clusters
7248 * are extracted and in finish_bands_clustering,
7249 * compute_schedule_finish_band is called on each of them to integrate
7250 * the band into "node" and to continue the computation.
7252 * compute_weights initializes the weights that are used by find_proximity.
7254 static __isl_give isl_schedule_node *compute_schedule_wcc_clustering(
7255 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
7257 isl_ctx *ctx;
7258 struct isl_clustering c;
7259 int i;
7261 ctx = isl_schedule_node_get_ctx(node);
7263 if (clustering_init(ctx, &c, graph) < 0)
7264 goto error;
7266 if (compute_weights(graph, &c) < 0)
7267 goto error;
7269 for (;;) {
7270 i = find_proximity(graph, &c);
7271 if (i < 0)
7272 goto error;
7273 if (i >= graph->n_edge)
7274 break;
7275 if (merge_clusters_along_edge(ctx, graph, i, &c) < 0)
7276 goto error;
7279 if (extract_clusters(ctx, graph, &c) < 0)
7280 goto error;
7282 node = finish_bands_clustering(node, graph, &c);
7284 clustering_free(ctx, &c);
7285 return node;
7286 error:
7287 clustering_free(ctx, &c);
7288 return isl_schedule_node_free(node);
7291 /* Compute a schedule for a connected dependence graph and return
7292 * the updated schedule node.
7294 * If Feautrier's algorithm is selected, we first recursively try to satisfy
7295 * as many validity dependences as possible. When all validity dependences
7296 * are satisfied we extend the schedule to a full-dimensional schedule.
7298 * Call compute_schedule_wcc_whole or compute_schedule_wcc_clustering
7299 * depending on whether the user has selected the option to try and
7300 * compute a schedule for the entire (weakly connected) component first.
7301 * If there is only a single strongly connected component (SCC), then
7302 * there is no point in trying to combine SCCs
7303 * in compute_schedule_wcc_clustering, so compute_schedule_wcc_whole
7304 * is called instead.
7306 static __isl_give isl_schedule_node *compute_schedule_wcc(
7307 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph)
7309 isl_ctx *ctx;
7311 if (!node)
7312 return NULL;
7314 ctx = isl_schedule_node_get_ctx(node);
7315 if (detect_sccs(ctx, graph) < 0)
7316 return isl_schedule_node_free(node);
7318 if (compute_maxvar(graph) < 0)
7319 return isl_schedule_node_free(node);
7321 if (need_feautrier_step(ctx, graph))
7322 return compute_schedule_wcc_feautrier(node, graph);
7324 if (graph->scc <= 1 || isl_options_get_schedule_whole_component(ctx))
7325 return compute_schedule_wcc_whole(node, graph);
7326 else
7327 return compute_schedule_wcc_clustering(node, graph);
7330 /* Compute a schedule for each group of nodes identified by node->scc
7331 * separately and then combine them in a sequence node (or as set node
7332 * if graph->weak is set) inserted at position "node" of the schedule tree.
7333 * Return the updated schedule node.
7335 * If "wcc" is set then each of the groups belongs to a single
7336 * weakly connected component in the dependence graph so that
7337 * there is no need for compute_sub_schedule to look for weakly
7338 * connected components.
7340 * If a set node would be introduced and if the number of components
7341 * is equal to the number of nodes, then check if the schedule
7342 * is already complete. If so, a redundant set node would be introduced
7343 * (without any further descendants) stating that the statements
7344 * can be executed in arbitrary order, which is also expressed
7345 * by the absence of any node. Refrain from inserting any nodes
7346 * in this case and simply return.
7348 static __isl_give isl_schedule_node *compute_component_schedule(
7349 __isl_take isl_schedule_node *node, struct isl_sched_graph *graph,
7350 int wcc)
7352 int component;
7353 isl_ctx *ctx;
7354 isl_union_set_list *filters;
7356 if (!node)
7357 return NULL;
7359 if (graph->weak && graph->scc == graph->n) {
7360 if (compute_maxvar(graph) < 0)
7361 return isl_schedule_node_free(node);
7362 if (graph->n_row >= graph->maxvar)
7363 return node;
7366 ctx = isl_schedule_node_get_ctx(node);
7367 filters = extract_sccs(ctx, graph);
7368 if (graph->weak)
7369 node = isl_schedule_node_insert_set(node, filters);
7370 else
7371 node = isl_schedule_node_insert_sequence(node, filters);
7373 for (component = 0; component < graph->scc; ++component) {
7374 node = isl_schedule_node_child(node, component);
7375 node = isl_schedule_node_child(node, 0);
7376 node = compute_sub_schedule(node, ctx, graph,
7377 &node_scc_exactly,
7378 &edge_scc_exactly, component, wcc);
7379 node = isl_schedule_node_parent(node);
7380 node = isl_schedule_node_parent(node);
7383 return node;
7386 /* Compute a schedule for the given dependence graph and insert it at "node".
7387 * Return the updated schedule node.
7389 * We first check if the graph is connected (through validity and conditional
7390 * validity dependences) and, if not, compute a schedule
7391 * for each component separately.
7392 * If the schedule_serialize_sccs option is set, then we check for strongly
7393 * connected components instead and compute a separate schedule for
7394 * each such strongly connected component.
7396 static __isl_give isl_schedule_node *compute_schedule(isl_schedule_node *node,
7397 struct isl_sched_graph *graph)
7399 isl_ctx *ctx;
7401 if (!node)
7402 return NULL;
7404 ctx = isl_schedule_node_get_ctx(node);
7405 if (isl_options_get_schedule_serialize_sccs(ctx)) {
7406 if (detect_sccs(ctx, graph) < 0)
7407 return isl_schedule_node_free(node);
7408 } else {
7409 if (detect_wccs(ctx, graph) < 0)
7410 return isl_schedule_node_free(node);
7413 if (graph->scc > 1)
7414 return compute_component_schedule(node, graph, 1);
7416 return compute_schedule_wcc(node, graph);
7419 /* Compute a schedule on sc->domain that respects the given schedule
7420 * constraints.
7422 * In particular, the schedule respects all the validity dependences.
7423 * If the default isl scheduling algorithm is used, it tries to minimize
7424 * the dependence distances over the proximity dependences.
7425 * If Feautrier's scheduling algorithm is used, the proximity dependence
7426 * distances are only minimized during the extension to a full-dimensional
7427 * schedule.
7429 * If there are any condition and conditional validity dependences,
7430 * then the conditional validity dependences may be violated inside
7431 * a tilable band, provided they have no adjacent non-local
7432 * condition dependences.
7434 __isl_give isl_schedule *isl_schedule_constraints_compute_schedule(
7435 __isl_take isl_schedule_constraints *sc)
7437 isl_ctx *ctx = isl_schedule_constraints_get_ctx(sc);
7438 struct isl_sched_graph graph = { 0 };
7439 isl_schedule *sched;
7440 isl_schedule_node *node;
7441 isl_union_set *domain;
7443 sc = isl_schedule_constraints_align_params(sc);
7445 domain = isl_schedule_constraints_get_domain(sc);
7446 if (isl_union_set_n_set(domain) == 0) {
7447 isl_schedule_constraints_free(sc);
7448 return isl_schedule_from_domain(domain);
7451 if (graph_init(&graph, sc) < 0)
7452 domain = isl_union_set_free(domain);
7454 node = isl_schedule_node_from_domain(domain);
7455 node = isl_schedule_node_child(node, 0);
7456 if (graph.n > 0)
7457 node = compute_schedule(node, &graph);
7458 sched = isl_schedule_node_get_schedule(node);
7459 isl_schedule_node_free(node);
7461 graph_free(ctx, &graph);
7462 isl_schedule_constraints_free(sc);
7464 return sched;
7467 /* Compute a schedule for the given union of domains that respects
7468 * all the validity dependences and minimizes
7469 * the dependence distances over the proximity dependences.
7471 * This function is kept for backward compatibility.
7473 __isl_give isl_schedule *isl_union_set_compute_schedule(
7474 __isl_take isl_union_set *domain,
7475 __isl_take isl_union_map *validity,
7476 __isl_take isl_union_map *proximity)
7478 isl_schedule_constraints *sc;
7480 sc = isl_schedule_constraints_on_domain(domain);
7481 sc = isl_schedule_constraints_set_validity(sc, validity);
7482 sc = isl_schedule_constraints_set_proximity(sc, proximity);
7484 return isl_schedule_constraints_compute_schedule(sc);