gpu_group.c: set_last_shared: extract out gpu_array_ref_group_tile
[ppcg.git] / gpu.c
bloba377b3a512c9395c57b73e0cf2a6edd24c230d37
1 /*
2 * Copyright 2010-2011 INRIA Saclay
3 * Copyright 2012-2013 Ecole Normale Superieure
5 * Use of this software is governed by the MIT license
7 * Written by Sven Verdoolaege, INRIA Saclay - Ile-de-France,
8 * Parc Club Orsay Universite, ZAC des vignes, 4 rue Jacques Monod,
9 * 91893 Orsay, France
10 * and Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
13 #include <assert.h>
14 #include <stdlib.h>
15 #include <string.h>
17 #include <isl/polynomial.h>
18 #include <isl/union_set.h>
19 #include <isl/aff.h>
20 #include <isl/ilp.h>
21 #include <isl/flow.h>
22 #include <isl/schedule.h>
23 #include <isl/schedule_node.h>
24 #include <isl/options.h>
25 #include <isl/ast_build.h>
27 #include "cpu.h"
28 #include "gpu.h"
29 #include "gpu_array_tile.h"
30 #include "gpu_group.h"
31 #include "gpu_tree.h"
32 #include "schedule.h"
33 #include "ppcg_options.h"
34 #include "print.h"
36 struct gpu_array_info;
38 /* Collect all references to the given array and store pointers to them
39 * in array->refs.
41 * If the array contains structures, then there is no need to collect
42 * the references since we will not be computing any reference groups.
44 static void collect_references(struct gpu_prog *prog,
45 struct gpu_array_info *array)
47 int i;
48 int n;
50 if (array->has_compound_element)
51 return;
53 n = 0;
54 for (i = 0; i < prog->n_stmts; ++i) {
55 struct gpu_stmt *stmt = &prog->stmts[i];
56 struct gpu_stmt_access *access;
58 for (access = stmt->accesses; access; access = access->next) {
59 const char *name;
60 name = isl_map_get_tuple_name(access->access,
61 isl_dim_out);
62 if (name && !strcmp(array->name, name))
63 n++;
67 array->n_ref = n;
68 array->refs = isl_alloc_array(prog->ctx, struct gpu_stmt_access *, n);
69 assert(array->refs);
71 n = 0;
72 for (i = 0; i < prog->n_stmts; ++i) {
73 struct gpu_stmt *stmt = &prog->stmts[i];
74 struct gpu_stmt_access *access;
76 for (access = stmt->accesses; access; access = access->next) {
77 const char *name;
78 name = isl_map_get_tuple_name(access->access,
79 isl_dim_out);
80 if (!name || strcmp(array->name, name))
81 continue;
83 array->refs[n++] = access;
88 /* Compute and return the extent of "array", taking into account the set of
89 * accessed elements.
91 * In particular, the extent in the outer dimension is taken
92 * from "accessed", while the extents in the remaining dimensions
93 * are taken from array->extent.
95 * The extent in the outer dimension cannot be taken from array->extent
96 * because that may be unbounded. Furthermore, even if it is bounded,
97 * it may be larger than the piece of the array that is being accessed.
99 static __isl_give isl_set *compute_extent(struct pet_array *array,
100 __isl_keep isl_set *accessed)
102 int n_index;
103 isl_id *id;
104 isl_set *outer;
105 isl_set *extent;
107 extent = isl_set_copy(array->extent);
109 n_index = isl_set_dim(accessed, isl_dim_set);
110 if (n_index == 0)
111 return extent;
113 extent = isl_set_project_out(extent, isl_dim_set, 0, 1);
114 outer = isl_set_copy(accessed);
115 outer = isl_set_project_out(outer, isl_dim_set, 1, n_index - 1);
116 extent = isl_set_flat_product(outer, extent);
117 id = isl_set_get_tuple_id(accessed);
118 extent = isl_set_set_tuple_id(extent, id);
120 return extent;
123 /* Is the array "array" being extracted a read-only scalar?
125 * That is, is "array" a scalar that is never possibly written to.
126 * An array containing structures is never considered to be a scalar.
128 static int is_read_only_scalar(struct gpu_array_info *array,
129 struct gpu_prog *prog)
131 isl_set *space;
132 isl_union_map *write;
133 int empty;
135 if (array->has_compound_element)
136 return 0;
137 if (array->n_index != 0)
138 return 0;
140 write = isl_union_map_copy(prog->may_write);
141 space = isl_set_universe(isl_space_copy(array->space));
142 write = isl_union_map_intersect_range(write,
143 isl_union_set_from_set(space));
144 empty = isl_union_map_is_empty(write);
145 isl_union_map_free(write);
147 return empty;
150 /* Compute bounds on the host array "pa" based on the corresponding
151 * accessed elements in "arrays"
152 * and collect all references to the array.
153 * Store the results in "info".
155 * If the array is zero-dimensional and does not contain structures,
156 * i.e., if the array is a scalar, we check whether it is read-only.
157 * We also check whether the array is accessed at all.
159 static int extract_array_info(struct gpu_prog *prog,
160 struct gpu_array_info *info, struct pet_array *pa,
161 __isl_keep isl_union_set *arrays)
163 int i, empty;
164 const char *name;
165 int n_index;
166 isl_pw_aff **bounds;
167 isl_set *accessed, *extent;
169 n_index = isl_set_dim(pa->extent, isl_dim_set);
170 name = isl_set_get_tuple_name(pa->extent);
171 bounds = isl_alloc_array(prog->ctx, isl_pw_aff *, n_index);
172 if (!bounds)
173 return -1;
175 info->space = isl_set_get_space(pa->extent);
176 info->name = strdup(name);
177 info->n_index = n_index;
178 info->bound = bounds;
179 info->linearize = prog->scop->options->linearize_device_arrays;
181 info->type = strdup(pa->element_type);
182 info->size = pa->element_size;
183 info->local = pa->declared && !pa->exposed;
184 info->has_compound_element = pa->element_is_record;
185 info->read_only_scalar = is_read_only_scalar(info, prog);
187 accessed = isl_union_set_extract_set(arrays,
188 isl_space_copy(info->space));
189 empty = isl_set_is_empty(accessed);
190 extent = compute_extent(pa, accessed);
191 isl_set_free(accessed);
192 info->extent = extent;
193 if (empty < 0)
194 return -1;
195 info->accessed = !empty;
196 for (i = 0; i < n_index; ++i) {
197 isl_set *dom;
198 isl_local_space *ls;
199 isl_aff *one;
200 isl_pw_aff *bound;
202 dom = isl_set_copy(extent);
203 dom = isl_set_project_out(dom, isl_dim_set, i + 1,
204 n_index - (i + 1));
205 dom = isl_set_project_out(dom, isl_dim_set, 0, i);
206 if (!isl_set_dim_has_upper_bound(dom, isl_dim_set, 0)) {
207 fprintf(stderr, "unable to determine extent of '%s' "
208 "in dimension %d\n", info->name, i);
209 dom = isl_set_free(dom);
211 bound = isl_set_dim_max(dom, 0);
212 dom = isl_pw_aff_domain(isl_pw_aff_copy(bound));
213 ls = isl_local_space_from_space(isl_set_get_space(dom));
214 one = isl_aff_zero_on_domain(ls);
215 one = isl_aff_add_constant_si(one, 1);
216 bound = isl_pw_aff_add(bound, isl_pw_aff_alloc(dom, one));
217 bound = isl_pw_aff_gist(bound, isl_set_copy(prog->context));
219 bounds[i] = bound;
220 if (!isl_pw_aff_is_cst(bound))
221 info->linearize = 1;
224 collect_references(prog, info);
226 return 0;
229 /* Remove independence from the order constraints "order" on array "array".
230 * Since the pairs of iterations in the filter relation of an independence
231 * are guaranteed to be completely independent by the user, there is
232 * no need to ensure that live ranges are ordered along thong pairs.
233 * We make an exception for local variables, though, as the independence
234 * guarantee does not apply to those.
236 * The order constraints are used in two places.
237 * Those on scalars are used in check_scalar_live_ranges to check if
238 * we need to force the scalar to be private. Any non-local scalar
239 * should not be forced scalar if it only appears in independent loops.
240 * Those on non-scalars are added to the coincidence constraints
241 * in compute_schedule because we do not support any array expansion.
242 * Accesses to non-local arrays should not prevent a loop from being
243 * considered coincident so we should indeed remove those constraints
244 * from the order constraints.
246 static __isl_give isl_union_map *remove_independences(struct gpu_prog *prog,
247 struct gpu_array_info *array, __isl_take isl_union_map *order)
249 int i;
251 for (i = 0; i < prog->scop->pet->n_independence; ++i) {
252 struct pet_independence *pi = prog->scop->pet->independences[i];
253 if (isl_union_set_contains(pi->local, array->space))
254 continue;
256 order = isl_union_map_subtract(order,
257 isl_union_map_copy(pi->filter));
260 return order;
263 /* For each array in "prog", store the (untagged) order dependences
264 * derived from the array in array->dep_order.
265 * In particular, consider all references that access the given array
266 * and take the order dependences that have one of these references
267 * as source. (Since an order dependence relates two references to
268 * the same array, the target of these order dependences will also
269 * be one of these references.)
270 * Additionally, store the union of these array->dep_order relations
271 * for all non-scalar arrays in prog->array_order.
273 void collect_order_dependences(struct gpu_prog *prog)
275 int i;
276 isl_space *space;
277 isl_union_map *accesses;
279 space = isl_union_map_get_space(prog->read);
280 prog->array_order = isl_union_map_empty(space);
282 accesses = isl_union_map_copy(prog->scop->tagged_reads);
283 accesses = isl_union_map_union(accesses,
284 isl_union_map_copy(prog->scop->tagged_may_writes));
285 accesses = isl_union_map_universe(accesses);
286 accesses = isl_union_map_apply_range(accesses,
287 isl_union_map_copy(prog->to_outer));
289 for (i = 0; i < prog->n_array; ++i) {
290 struct gpu_array_info *array = &prog->array[i];
291 isl_set *set;
292 isl_union_set *uset;
293 isl_union_map *order;
295 set = isl_set_universe(isl_space_copy(array->space));
296 uset = isl_union_set_from_set(set);
297 uset = isl_union_map_domain(
298 isl_union_map_intersect_range(isl_union_map_copy(accesses),
299 uset));
300 order = isl_union_map_copy(prog->scop->tagged_dep_order);
301 order = isl_union_map_intersect_domain(order, uset);
302 order = isl_union_map_zip(order);
303 order = isl_union_set_unwrap(isl_union_map_domain(order));
304 order = remove_independences(prog, array, order);
305 array->dep_order = order;
307 if (gpu_array_is_scalar(array) && !array->has_compound_element)
308 continue;
310 prog->array_order = isl_union_map_union(prog->array_order,
311 isl_union_map_copy(array->dep_order));
314 isl_union_map_free(accesses);
317 /* Construct a gpu_array_info for each array referenced by prog->scop and
318 * collect them in prog->array.
320 * The sizes are based on the extents and the set of possibly accessed
321 * elements by "prog".
322 * If there are any member accesses involved, then they are first mapped
323 * to the outer arrays of structs.
325 * If we are allowing live range reordering, then also set
326 * the dep_order field. Otherwise leave it NULL.
328 static int collect_array_info(struct gpu_prog *prog)
330 int i;
331 int r = 0;
332 isl_union_set *arrays;
334 arrays = isl_union_map_range(isl_union_map_copy(prog->read));
335 arrays = isl_union_set_union(arrays,
336 isl_union_map_range(isl_union_map_copy(prog->may_write)));
338 arrays = isl_union_set_apply(arrays,
339 isl_union_map_copy(prog->to_outer));
341 arrays = isl_union_set_coalesce(arrays);
343 prog->n_array = prog->scop->pet->n_array;
344 prog->array = isl_calloc_array(prog->ctx,
345 struct gpu_array_info, prog->n_array);
346 assert(prog->array);
347 for (i = 0; i < prog->scop->pet->n_array; ++i)
348 if (extract_array_info(prog, &prog->array[i],
349 prog->scop->pet->arrays[i], arrays) < 0)
350 r = -1;
352 isl_union_set_free(arrays);
354 if (prog->scop->options->live_range_reordering)
355 collect_order_dependences(prog);
357 return r;
360 static void free_array_info(struct gpu_prog *prog)
362 int i, j;
364 for (i = 0; i < prog->n_array; ++i) {
365 int n_index = prog->array[i].n_index;
366 free(prog->array[i].type);
367 free(prog->array[i].name);
368 for (j = 0; j < n_index; ++j)
369 isl_pw_aff_free(prog->array[i].bound[j]);
370 isl_space_free(prog->array[i].space);
371 isl_set_free(prog->array[i].extent);
372 free(prog->array[i].bound);
373 free(prog->array[i].refs);
374 isl_union_map_free(prog->array[i].dep_order);
376 free(prog->array);
379 /* Check if a gpu array is a scalar. A scalar is a value that is not stored
380 * as an array or through a pointer reference, but as a single data element.
381 * At the moment, scalars are represented as zero-dimensional arrays.
382 * Note that the single data element may be an entire structure.
384 int gpu_array_is_scalar(struct gpu_array_info *array)
386 return array->n_index == 0;
389 /* Is "array" a read-only scalar?
391 int gpu_array_is_read_only_scalar(struct gpu_array_info *array)
393 return array->read_only_scalar;
396 /* Return the set of parameter values for which the array has a positive
397 * size in all dimensions.
398 * If the sizes are only valid for some parameter values, then those
399 * constraints are also taken into account.
401 __isl_give isl_set *gpu_array_positive_size_guard(struct gpu_array_info *array)
403 int i;
404 isl_space *space;
405 isl_set *guard;
407 space = isl_space_params(isl_space_copy(array->space));
408 guard = isl_set_universe(space);
410 for (i = 0; i < array->n_index; ++i) {
411 isl_pw_aff *bound;
412 isl_set *guard_i, *zero;
414 bound = isl_pw_aff_copy(array->bound[i]);
415 guard_i = isl_pw_aff_nonneg_set(isl_pw_aff_copy(bound));
416 zero = isl_pw_aff_zero_set(bound);
417 guard_i = isl_set_subtract(guard_i, zero);
418 guard = isl_set_intersect(guard, guard_i);
421 return guard;
424 /* Internal data structure for extract_size_of_type.
425 * "type" specifies the name of the space that we want to extract.
426 * "res" is used to store the subset of that space.
428 struct ppcg_extract_size_data {
429 const char *type;
430 isl_set *res;
433 /* This function is called for each set in a union_set.
434 * If the name of the set matches data->type, we store the
435 * set in data->res.
437 static int extract_size_of_type(__isl_take isl_set *size, void *user)
439 struct ppcg_extract_size_data *data = user;
440 const char *name;
442 name = isl_set_get_tuple_name(size);
443 if (name && !strcmp(name, data->type)) {
444 data->res = size;
445 return -1;
448 isl_set_free(size);
449 return 0;
452 /* Given a union map { kernel[i] -> *[...] },
453 * return the range in the space called "type" for the kernel with
454 * sequence number "id".
456 static __isl_give isl_set *extract_sizes(__isl_keep isl_union_map *sizes,
457 const char *type, int id)
459 isl_space *space;
460 isl_set *dom;
461 isl_union_set *local_sizes;
462 struct ppcg_extract_size_data data = { type, NULL };
464 if (!sizes)
465 return NULL;
467 space = isl_union_map_get_space(sizes);
468 space = isl_space_set_from_params(space);
469 space = isl_space_add_dims(space, isl_dim_set, 1);
470 space = isl_space_set_tuple_name(space, isl_dim_set, "kernel");
471 dom = isl_set_universe(space);
472 dom = isl_set_fix_si(dom, isl_dim_set, 0, id);
474 local_sizes = isl_union_set_apply(isl_union_set_from_set(dom),
475 isl_union_map_copy(sizes));
476 isl_union_set_foreach_set(local_sizes, &extract_size_of_type, &data);
477 isl_union_set_free(local_sizes);
478 return data.res;
481 /* Given a singleton set, extract the first (at most *len) elements
482 * of the single integer tuple into *sizes and update *len if needed.
484 static void read_sizes_from_set(__isl_take isl_set *set, int *sizes, int *len)
486 int i;
487 int dim;
489 if (!set)
490 return;
492 dim = isl_set_dim(set, isl_dim_set);
493 if (dim < *len)
494 *len = dim;
496 for (i = 0; i < *len; ++i) {
497 isl_val *v;
499 v = isl_set_plain_get_val_if_fixed(set, isl_dim_set, i);
500 assert(v);
502 sizes[i] = isl_val_get_num_si(v);
503 isl_val_free(v);
506 isl_set_free(set);
509 /* Add the map { kernel[id] -> type[sizes] } to gen->used_sizes,
510 * if the option debug->dump_sizes is set.
512 static void set_used_sizes(struct gpu_gen *gen, const char *type, int id,
513 int *sizes, int len)
515 int i;
516 isl_space *space;
517 isl_map *map;
519 if (!gen->options->debug->dump_sizes)
520 return;
522 space = isl_union_map_get_space(gen->used_sizes);
523 space = isl_space_set_from_params(space);
524 space = isl_space_add_dims(space, isl_dim_set, 1);
525 space = isl_space_set_tuple_name(space, isl_dim_set, "kernel");
526 space = isl_space_from_domain(space);
527 space = isl_space_add_dims(space, isl_dim_out, len);
528 space = isl_space_set_tuple_name(space, isl_dim_out, type);
530 map = isl_map_universe(space);
531 map = isl_map_fix_si(map, isl_dim_in, 0, id);
532 for (i = 0; i < len; ++i)
533 map = isl_map_fix_si(map, isl_dim_out, i, sizes[i]);
535 gen->used_sizes = isl_union_map_add_map(gen->used_sizes, map);
538 /* Extract user specified "tile" sizes from the "sizes" command line option,
539 * defaulting to option->tile_size in each dimension.
540 * *tile_len contains the maximum number of tile sizes needed.
541 * Update *tile_len to the number of specified tile sizes, if any, and
542 * return a pointer to the tile sizes (or NULL on error).
543 * Add the effectively used sizes to gen->used_sizes.
545 static int *read_tile_sizes(struct gpu_gen *gen, int *tile_len)
547 int n;
548 int *tile_size;
549 isl_set *size;
551 tile_size = isl_alloc_array(gen->ctx, int, *tile_len);
552 if (!tile_size)
553 return NULL;
554 for (n = 0; n < *tile_len; ++n)
555 tile_size[n] = gen->options->tile_size;
557 size = extract_sizes(gen->sizes, "tile", gen->kernel_id);
558 read_sizes_from_set(size, tile_size, tile_len);
559 set_used_sizes(gen, "tile", gen->kernel_id, tile_size, *tile_len);
561 return tile_size;
564 /* Extract user specified "block" sizes from the "sizes" command line option,
565 * after filling in some potentially useful defaults.
567 static void read_block_sizes(struct ppcg_kernel *kernel,
568 __isl_keep isl_union_map *sizes)
570 isl_set *size;
572 if (kernel->n_block > 3)
573 kernel->n_block = 3;
574 switch (kernel->n_block) {
575 case 1:
576 kernel->block_dim[0] = 512;
577 break;
578 case 2:
579 kernel->block_dim[0] = 32;
580 kernel->block_dim[1] = 16;
581 break;
582 default:
583 kernel->block_dim[0] = 32;
584 kernel->block_dim[1] = 4;
585 kernel->block_dim[2] = 4;
586 break;
589 size = extract_sizes(sizes, "block", kernel->id);
590 read_sizes_from_set(size, kernel->block_dim, &kernel->n_block);
593 /* Extract user specified "grid" sizes from the "sizes" command line option,
594 * after filling in some potentially useful defaults.
596 static void read_grid_sizes(struct ppcg_kernel *kernel,
597 __isl_keep isl_union_map *sizes)
599 isl_set *size;
601 if (kernel->n_grid > 2)
602 kernel->n_grid = 2;
603 switch (kernel->n_grid) {
604 case 1:
605 kernel->grid_dim[0] = 32768;
606 break;
607 default:
608 kernel->grid_dim[0] = 256;
609 kernel->grid_dim[1] = 256;
610 break;
613 size = extract_sizes(sizes, "grid", kernel->id);
614 read_sizes_from_set(size, kernel->grid_dim, &kernel->n_grid);
617 /* Extract user specified grid and block sizes from the gen->sizes
618 * command line option after filling in some potentially useful defaults.
619 * Store the extracted sizes in "kernel".
620 * Add the effectively used sizes to gen->used_sizes.
622 static void read_grid_and_block_sizes(struct ppcg_kernel *kernel,
623 struct gpu_gen *gen)
625 read_block_sizes(kernel, gen->sizes);
626 read_grid_sizes(kernel, gen->sizes);
627 set_used_sizes(gen, "block", kernel->id,
628 kernel->block_dim, kernel->n_block);
629 set_used_sizes(gen, "grid", kernel->id,
630 kernel->grid_dim, kernel->n_grid);
633 static void *free_stmts(struct gpu_stmt *stmts, int n)
635 int i;
637 if (!stmts)
638 return NULL;
640 for (i = 0; i < n; ++i) {
641 struct gpu_stmt_access *access, *next;
643 for (access = stmts[i].accesses; access; access = next) {
644 next = access->next;
645 isl_id_free(access->ref_id);
646 isl_map_free(access->access);
647 isl_map_free(access->tagged_access);
648 free(access);
651 isl_id_free(stmts[i].id);
653 free(stmts);
655 return NULL;
658 /* Construct a map from a domain of dimensionality "len"
659 * to a domain of dimensionality "len" + "tile_len" that tiles
660 * the "tile_len" coordinates starting at "first".
661 * In particular, [s_i] -> [s_i / tile_size[i], s_i % tile_size[i]].
662 * "dim" prescribes the parameters.
664 static __isl_give isl_map *tile(__isl_take isl_space *dim, int len,
665 int first, int tile_len, int *tile_size)
667 int i;
668 isl_basic_map *bmap;
669 isl_constraint *c;
670 isl_local_space *ls;
672 dim = isl_space_add_dims(dim, isl_dim_in, len);
673 dim = isl_space_add_dims(dim, isl_dim_out, len + tile_len);
674 bmap = isl_basic_map_universe(isl_space_copy(dim));
675 ls = isl_local_space_from_space(dim);
677 for (i = 0; i < len - tile_len; ++i) {
678 int j = i < first ? i : i + tile_len;
679 int k = i < first ? i : i + 2 * tile_len;
681 c = isl_equality_alloc(isl_local_space_copy(ls));
682 c = isl_constraint_set_coefficient_si(c, isl_dim_in, j, -1);
683 c = isl_constraint_set_coefficient_si(c, isl_dim_out, k, 1);
684 bmap = isl_basic_map_add_constraint(bmap, c);
687 for (i = 0; i < tile_len; ++i) {
688 c = isl_equality_alloc(isl_local_space_copy(ls));
689 c = isl_constraint_set_coefficient_si(c, isl_dim_in,
690 first + i, -1);
691 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
692 first + i, tile_size[i]);
693 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
694 first + i + tile_len, 1);
695 bmap = isl_basic_map_add_constraint(bmap, c);
697 c = isl_inequality_alloc(isl_local_space_copy(ls));
698 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
699 first + i + tile_len, 1);
700 bmap = isl_basic_map_add_constraint(bmap, c);
702 c = isl_inequality_alloc(isl_local_space_copy(ls));
703 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
704 first + i + tile_len, -1);
705 c = isl_constraint_set_constant_si(c, tile_size[i] - 1);
706 bmap = isl_basic_map_add_constraint(bmap, c);
709 isl_local_space_free(ls);
711 return isl_map_from_basic_map(bmap);
714 /* Construct a map from a domain of dimensionality "len"
715 * to a domain of dimensionality "len" + "wrap_len" that "wraps"
716 * the "wrap_len" coordinates starting at "first" according to "wrap_size".
717 * In particular, [s_i] -> [s_i, s_i % wrap_size[i]].
718 * To do so, we need extra variables corresponding to [s_i / wrap_size[i]],
719 * that are projected out at the end.
720 * "dim" prescribes the parameters.
722 static __isl_give isl_map *wrap(__isl_take isl_space *dim, int len,
723 int first, int wrap_len, int *wrap_size)
725 int i;
726 isl_basic_map *bmap;
727 isl_constraint *c;
728 isl_local_space *ls;
730 dim = isl_space_add_dims(dim, isl_dim_in, len);
731 dim = isl_space_add_dims(dim, isl_dim_out, len + 2 * wrap_len);
732 bmap = isl_basic_map_universe(isl_space_copy(dim));
733 ls = isl_local_space_from_space(dim);
735 for (i = 0; i < len; ++i) {
736 int k = i < first + wrap_len ? i : i + 2 * wrap_len;
738 c = isl_equality_alloc(isl_local_space_copy(ls));
739 c = isl_constraint_set_coefficient_si(c, isl_dim_in, i, -1);
740 c = isl_constraint_set_coefficient_si(c, isl_dim_out, k, 1);
741 bmap = isl_basic_map_add_constraint(bmap, c);
744 for (i = 0; i < wrap_len; ++i) {
745 c = isl_equality_alloc(isl_local_space_copy(ls));
746 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
747 first + i, -1);
748 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
749 first + wrap_len + i, 1);
750 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
751 first + 2 * wrap_len + i, wrap_size[i]);
752 bmap = isl_basic_map_add_constraint(bmap, c);
754 c = isl_inequality_alloc(isl_local_space_copy(ls));
755 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
756 first + wrap_len + i, 1);
757 bmap = isl_basic_map_add_constraint(bmap, c);
759 c = isl_inequality_alloc(isl_local_space_copy(ls));
760 c = isl_constraint_set_coefficient_si(c, isl_dim_out,
761 first + wrap_len + i, -1);
762 c = isl_constraint_set_constant_si(c, wrap_size[i] - 1);
763 bmap = isl_basic_map_add_constraint(bmap, c);
766 isl_local_space_free(ls);
768 bmap = isl_basic_map_project_out(bmap, isl_dim_out,
769 first + 2 * wrap_len, wrap_len);
771 return isl_map_from_basic_map(bmap);
774 /* Tile the B loops over the tile sizes and then tile/wrap
775 * the T1 loops over the blocks.
777 static __isl_give isl_union_map *tile_schedule(struct gpu_gen *gen,
778 __isl_take isl_union_map *sched)
780 struct ppcg_kernel *kernel = gen->kernel;
781 isl_space *dim;
782 isl_map *tiling, *block_tiling;
784 dim = isl_union_map_get_space(sched);
785 tiling = tile(isl_space_copy(dim), gen->untiled_len,
786 gen->tile_first, kernel->tile_len, kernel->tile_size);
788 if (gen->options->wrap)
789 block_tiling = wrap(dim, gen->untiled_len + kernel->tile_len,
790 gen->tile_first, kernel->n_grid, kernel->grid_dim);
791 else
792 block_tiling = tile(dim, gen->untiled_len + kernel->tile_len,
793 gen->tile_first, kernel->n_grid, kernel->grid_dim);
795 gen->tiled_len = gen->untiled_len + kernel->tile_len + kernel->n_grid;
797 tiling = isl_map_apply_range(tiling, block_tiling);
799 sched = isl_union_map_apply_range(sched,
800 isl_union_map_from_map(tiling));
802 gen->shared_len = gen->tile_first + kernel->tile_len + kernel->n_grid;
804 return sched;
807 /* Equate the "T1P" iterators in the tiled schedule "sched"
808 * to the block dimensions.
810 static __isl_give isl_union_map *parametrize_tiled_schedule(
811 struct gpu_gen *gen, __isl_take isl_union_map *sched)
813 struct ppcg_kernel *kernel = gen->kernel;
814 isl_space *dim;
815 isl_set *par;
817 dim = isl_union_map_get_space(sched);
818 par = parametrization(dim, gen->tiled_len,
819 gen->tile_first + kernel->n_grid, kernel->block_ids);
820 sched = isl_union_map_intersect_range(sched,
821 isl_union_set_from_set(par));
823 return sched;
826 /* Tile/wrap the P1 loops over the threads.
828 static __isl_give isl_union_map *thread_tile_schedule(struct gpu_gen *gen,
829 __isl_take isl_union_map *sched)
831 struct ppcg_kernel *kernel = gen->kernel;
832 isl_space *dim;
833 isl_map *tiling;
834 isl_set *par;
836 dim = isl_union_map_get_space(sched);
838 if (gen->options->wrap)
839 tiling = wrap(isl_space_copy(dim), gen->tiled_len,
840 gen->shared_len, kernel->n_block, kernel->block_dim);
841 else
842 tiling = tile(isl_space_copy(dim), gen->tiled_len,
843 gen->shared_len, kernel->n_block, kernel->block_dim);
844 gen->thread_tiled_len = gen->tiled_len + kernel->n_block;
846 sched = isl_union_map_apply_range(sched,
847 isl_union_map_from_map(tiling));
849 par = parametrization(dim, gen->thread_tiled_len,
850 gen->tile_first + kernel->tile_len +
851 kernel->n_grid + kernel->n_block, kernel->thread_ids);
852 sched = isl_union_map_intersect_range(sched,
853 isl_union_set_from_set(par));
855 gen->shared_len = gen->tile_first + kernel->tile_len + kernel->n_grid;
857 return sched;
860 /* If the user asked for it, scale the shared memory tile loops
861 * (T1T and T2) of "sched" by kernel->tile_size[i].
862 * If we are not performing "wrapping", then additionally scale the T1P
863 * loops by kernel->grid_dim[i].
865 static __isl_give isl_union_map *scale_tile_loops(struct gpu_gen *gen,
866 __isl_take isl_union_map *sched)
868 struct ppcg_kernel *kernel = gen->kernel;
869 int i;
870 isl_space *dim;
871 isl_basic_map *scale;
872 isl_constraint *c;
873 isl_local_space *ls;
875 if (!gen->options->scale_tile_loops)
876 return sched;
878 dim = isl_union_map_get_space(sched);
879 dim = isl_space_add_dims(dim, isl_dim_in, gen->tiled_len);
880 dim = isl_space_add_dims(dim, isl_dim_out, gen->tiled_len);
881 scale = isl_basic_map_universe(isl_space_copy(dim));
882 ls = isl_local_space_from_space(dim);
884 for (i = 0; i < gen->tiled_len; ++i) {
885 int f = 1;
887 if (i >= gen->tile_first &&
888 i < gen->tile_first + kernel->n_grid) {
889 f = kernel->tile_size[i - gen->tile_first];
890 if (!gen->options->wrap)
891 f *= kernel->grid_dim[i - gen->tile_first];
892 } else if (i >= gen->tile_first + kernel->n_grid &&
893 i < gen->tile_first + kernel->n_grid +
894 kernel->tile_len) {
895 f = kernel->tile_size[i -
896 (gen->tile_first + kernel->n_grid)];
899 c = isl_equality_alloc(isl_local_space_copy(ls));
900 c = isl_constraint_set_coefficient_si(c, isl_dim_in, i, f);
901 c = isl_constraint_set_coefficient_si(c, isl_dim_out, i, -1);
902 scale = isl_basic_map_add_constraint(scale, c);
905 isl_local_space_free(ls);
907 sched = isl_union_map_apply_range(sched,
908 isl_union_map_from_map(isl_map_from_basic_map(scale)));
910 return sched;
913 /* If we are not performing "wrapping" and if the user asked for it,
914 * scale the thread tile loops (P1T) of "sched" by kernel->block_dim[i].
916 static __isl_give isl_union_map *scale_thread_tile_loops(struct gpu_gen *gen,
917 __isl_take isl_union_map *sched)
919 int i;
920 isl_space *dim;
921 isl_basic_map *scale;
922 isl_constraint *c;
923 isl_local_space *ls;
925 if (gen->options->wrap)
926 return sched;
927 if (!gen->options->scale_tile_loops)
928 return sched;
930 dim = isl_union_map_get_space(sched);
931 dim = isl_space_add_dims(dim, isl_dim_in, gen->thread_tiled_len);
932 dim = isl_space_add_dims(dim, isl_dim_out, gen->thread_tiled_len);
933 scale = isl_basic_map_universe(isl_space_copy(dim));
934 ls = isl_local_space_from_space(dim);
936 for (i = 0; i < gen->thread_tiled_len; ++i) {
937 int f = 1;
939 if (i >= gen->shared_len &&
940 i < gen->shared_len + gen->kernel->n_block)
941 f = gen->kernel->block_dim[i - gen->shared_len];
943 c = isl_equality_alloc(isl_local_space_copy(ls));
944 c = isl_constraint_set_coefficient_si(c, isl_dim_in, i, f);
945 c = isl_constraint_set_coefficient_si(c, isl_dim_out, i, -1);
946 scale = isl_basic_map_add_constraint(scale, c);
949 isl_local_space_free(ls);
951 sched = isl_union_map_apply_range(sched,
952 isl_union_map_from_map(isl_map_from_basic_map(scale)));
954 return sched;
957 /* If we are not performing "wrapping" and if the user asked for it,
958 * scale the "n_tile" loops starting at "first" of "sched" by gen->block_dim[i].
960 static __isl_give isl_union_map *scale_access_tile_loops(struct gpu_gen *gen,
961 __isl_take isl_union_map *sched, int len, int first, int n_tile)
963 int i;
964 isl_space *dim;
965 isl_basic_map *scale;
966 isl_constraint *c;
967 isl_local_space *ls;
969 if (gen->options->wrap)
970 return sched;
971 if (!gen->options->scale_tile_loops)
972 return sched;
974 dim = isl_union_map_get_space(sched);
975 dim = isl_space_add_dims(dim, isl_dim_in, len);
976 dim = isl_space_add_dims(dim, isl_dim_out, len);
977 scale = isl_basic_map_universe(isl_space_copy(dim));
978 ls = isl_local_space_from_space(dim);
980 for (i = 0; i < len; ++i) {
981 int f = 1;
983 if (i >= first && i < first + n_tile)
984 f = gen->kernel->block_dim[i - first];
986 c = isl_equality_alloc(isl_local_space_copy(ls));
987 c = isl_constraint_set_coefficient_si(c, isl_dim_in, i, f);
988 c = isl_constraint_set_coefficient_si(c, isl_dim_out, i, -1);
989 scale = isl_basic_map_add_constraint(scale, c);
992 isl_local_space_free(ls);
994 sched = isl_union_map_apply_range(sched,
995 isl_union_map_from_map(isl_map_from_basic_map(scale)));
997 return sched;
1000 /* Add parameters p[i] with identifiers "ids" to "set",
1001 * with bounds to 0 <= p[i] < size[i].
1003 __isl_give isl_set *add_bounded_parameters(__isl_take isl_set *set,
1004 int *size, __isl_keep isl_id_list *ids)
1006 int i, len;
1007 unsigned nparam;
1009 len = isl_id_list_n_id(ids);
1010 nparam = isl_set_dim(set, isl_dim_param);
1011 set = isl_set_add_dims(set, isl_dim_param, len);
1013 for (i = 0; i < len; ++i) {
1014 isl_id *id;
1016 id = isl_id_list_get_id(ids, i);
1017 set = isl_set_set_dim_id(set, isl_dim_param, nparam + i, id);
1018 set = isl_set_lower_bound_si(set, isl_dim_param, nparam + i, 0);
1019 set = isl_set_upper_bound_si(set, isl_dim_param,
1020 nparam + i, size[i] - 1);
1023 return set;
1026 /* Add "len" parameters p[i] with identifiers "ids" and intersect "set"
1027 * with
1029 * { : 0 <= p[i] < size[i] }
1031 * or an overapproximation.
1033 static __isl_give isl_set *add_bounded_parameters_dynamic(
1034 __isl_take isl_set *set, __isl_keep isl_multi_pw_aff *size,
1035 __isl_keep isl_id_list *ids)
1037 int i, len;
1038 unsigned nparam;
1039 isl_space *space;
1040 isl_local_space *ls;
1042 len = isl_multi_pw_aff_dim(size, isl_dim_out);
1043 nparam = isl_set_dim(set, isl_dim_param);
1044 set = isl_set_add_dims(set, isl_dim_param, len);
1046 for (i = 0; i < len; ++i) {
1047 isl_id *id;
1049 id = isl_id_list_get_id(ids, i);
1050 set = isl_set_set_dim_id(set, isl_dim_param, nparam + i, id);
1053 space = isl_space_params(isl_set_get_space(set));
1054 ls = isl_local_space_from_space(space);
1055 for (i = 0; i < len; ++i) {
1056 isl_pw_aff *param, *size_i, *zero;
1057 isl_set *bound;
1059 param = isl_pw_aff_var_on_domain(isl_local_space_copy(ls),
1060 isl_dim_param, nparam + i);
1062 size_i = isl_multi_pw_aff_get_pw_aff(size, i);
1063 bound = isl_pw_aff_lt_set(isl_pw_aff_copy(param), size_i);
1064 bound = isl_set_from_basic_set(isl_set_simple_hull(bound));
1065 set = isl_set_intersect_params(set, bound);
1067 zero = isl_pw_aff_zero_on_domain(isl_local_space_copy(ls));
1068 bound = isl_pw_aff_ge_set(param, zero);
1069 set = isl_set_intersect_params(set, bound);
1071 isl_local_space_free(ls);
1073 return set;
1076 /* Construct a map from an access to group->array to the corresponding
1077 * shared/private memory tile.
1078 * The map is of the form
1080 * { [D[i] -> A[a]] -> T[t] }
1082 * where D represents the initial shared_len dimensions
1083 * of the computed schedule.
1085 static __isl_give isl_map *shift_access(struct gpu_array_ref_group *group)
1087 struct gpu_array_tile *tile;
1088 isl_multi_aff *tiling;
1090 tile = group->private_tile;
1091 if (!tile)
1092 tile = group->shared_tile;
1094 tiling = isl_multi_aff_copy(tile->tiling);
1096 return isl_map_from_multi_aff(tiling);
1099 /* Given a schedule that iterates over all elements in a piece of an array,
1100 * perform tiling/wrapping over the threads.
1102 * In particular, we tile the final iterators so that the final thread
1103 * dimension runs over the final array dimension.
1104 * However, if those final iterators have only a single iteration,
1105 * we try to tile earlier iterators instead.
1107 static __isl_give isl_map *tile_access_schedule(struct gpu_gen *gen,
1108 __isl_take isl_map *sched)
1110 isl_space *dim;
1111 isl_union_map *usched;
1112 isl_map *tiling;
1113 isl_set *par;
1114 unsigned nvar = isl_map_dim(sched, isl_dim_out);
1115 int n_tile;
1116 int first;
1118 n_tile = gen->kernel->n_block;
1119 if (n_tile > nvar) {
1120 int i;
1121 sched = isl_map_insert_dims(sched,
1122 isl_dim_out, 0, n_tile - nvar);
1123 for (i = 0; i < n_tile - nvar; ++i)
1124 sched = isl_map_fix_si(sched, isl_dim_out, i, 0);
1125 nvar = n_tile;
1128 first = nvar - n_tile;
1130 for (; first > 0; first --)
1131 if (!map_plain_is_fixed(sched, isl_dim_out, first + n_tile - 1))
1132 break;
1134 dim = isl_map_get_space(sched);
1135 dim = isl_space_params(dim);
1136 if (gen->options->wrap)
1137 tiling = wrap(isl_space_copy(dim), nvar, first,
1138 n_tile, gen->kernel->block_dim);
1139 else
1140 tiling = tile(isl_space_copy(dim), nvar, first,
1141 n_tile, gen->kernel->block_dim);
1142 sched = isl_map_apply_range(sched, tiling);
1144 par = parametrization(dim, nvar + n_tile, first + n_tile,
1145 gen->kernel->thread_ids);
1146 sched = isl_map_intersect_range(sched, par);
1148 usched = isl_union_map_from_map(sched);
1149 usched = scale_access_tile_loops(gen, usched, nvar + n_tile,
1150 first, n_tile);
1151 sched = isl_map_from_union_map(usched);
1153 return sched;
1156 /* Return the union of all tagged access relations in the group.
1158 static __isl_give isl_union_map *group_tagged_access_relation(
1159 struct gpu_array_ref_group *group)
1161 int i;
1162 isl_union_map *access;
1164 access = isl_union_map_empty(isl_map_get_space(group->access));
1165 for (i = 0; i < group->n_ref; ++i) {
1166 isl_map *map_i;
1168 map_i = isl_map_copy(group->refs[i]->tagged_access);
1169 access = isl_union_map_union(access,
1170 isl_union_map_from_map(map_i));
1173 return access;
1176 /* Return the extent of "array", recomputed from the bounds.
1177 * The recomputed extent may be simpler than the original extent.
1179 static __isl_give isl_set *array_extent(struct gpu_array_info *array)
1181 int i;
1182 isl_id *id;
1183 isl_space *space;
1184 isl_local_space *ls;
1185 isl_set *extent;
1187 id = isl_set_get_tuple_id(array->extent);
1188 space = isl_set_get_space(array->extent);
1189 extent = isl_set_universe(isl_space_copy(space));
1190 ls = isl_local_space_from_space(space);
1191 for (i = 0; i < array->n_index; ++i) {
1192 isl_pw_aff *bound;
1193 isl_aff *aff;
1194 isl_pw_aff *index;
1195 isl_set *lt;
1197 extent = isl_set_lower_bound_si(extent, isl_dim_set, i, 0);
1199 aff = isl_aff_var_on_domain(isl_local_space_copy(ls),
1200 isl_dim_set, i);
1201 index = isl_pw_aff_from_aff(aff);
1202 bound = isl_pw_aff_copy(array->bound[i]);
1203 bound = isl_pw_aff_from_range(bound);
1204 bound = isl_pw_aff_add_dims(bound, isl_dim_in, array->n_index);
1205 bound = isl_pw_aff_set_tuple_id(bound, isl_dim_in,
1206 isl_id_copy(id));
1207 lt = isl_pw_aff_lt_set(index, bound);
1208 extent = isl_set_intersect(extent, lt);
1210 isl_local_space_free(ls);
1211 isl_id_free(id);
1213 return extent;
1216 /* Return a map from the first shared_len dimensions of the computed
1217 * schedule to the array tile in
1218 * global memory that corresponds to the shared memory copy.
1220 * In particular, return a map
1222 * { D[i] -> A[a] }
1224 * with constraints
1226 * tile_offset(i) <= a <= tile_offset(i) + tile_size - 1 (1)
1228 * and
1230 * 0 <= a <= array_size - 1 (2)
1232 * Note that if some stride has been detected (i.e., when
1233 * group->shared_tile->bound[i].shift is set), then a in (1) refers
1234 * to the shifted and scaled down version.
1236 * Constraints (1) are obtained by mapping the size constraints on the
1237 * shared/private memory tile back to the access relation.
1238 * Constraints (2) are obtained from the (recomputed) extent.
1240 static __isl_give isl_map *group_tile(struct gpu_array_ref_group *group)
1242 int i;
1243 int n_index = group->array->n_index;
1244 isl_map *tile;
1245 isl_space *space;
1246 isl_set *local;
1247 isl_set *extent;
1249 space = isl_multi_aff_get_space(group->shared_tile->tiling);
1250 space = isl_space_range(space);
1251 local = isl_set_universe(space);
1252 for (i = 0; i < n_index; ++i) {
1253 isl_val *bound;
1255 local = isl_set_lower_bound_si(local, isl_dim_set, i, 0);
1256 bound = isl_val_copy(group->shared_tile->bound[i].size);
1257 bound = isl_val_sub_ui(bound, 1);
1258 local = isl_set_upper_bound_val(local, isl_dim_set, i, bound);
1260 local = isl_set_preimage_multi_aff(local,
1261 isl_multi_aff_copy(group->shared_tile->tiling));
1262 tile = isl_set_unwrap(local);
1263 extent = array_extent(group->array);
1264 tile = isl_map_intersect_range(tile, extent);
1266 return tile;
1269 /* Given a mapping "iterator_map" from the AST schedule to a domain,
1270 * return the corresponding mapping from the AST schedule to
1271 * to the first shared_len dimensions of the schedule computed by PPCG.
1273 static __isl_give isl_pw_multi_aff *compute_sched_to_shared(struct gpu_gen *gen,
1274 __isl_take isl_pw_multi_aff *iterator_map)
1276 isl_union_map *umap;
1277 isl_space *space;
1278 isl_map *map, *sched;;
1280 space = isl_space_range(isl_pw_multi_aff_get_space(iterator_map));
1281 space = isl_space_from_domain(space);
1282 space = isl_space_add_dims(space, isl_dim_out, gen->shared_len);
1284 umap = isl_union_map_copy(gen->shared_sched);
1285 umap = isl_union_map_apply_range(umap,
1286 isl_union_map_copy(gen->shared_proj));
1287 map = isl_union_map_extract_map(umap, space);
1288 isl_union_map_free(umap);
1290 sched = isl_map_preimage_domain_pw_multi_aff(map, iterator_map);
1291 sched = isl_map_detect_equalities(sched);
1293 return isl_pw_multi_aff_from_map(sched);
1296 /* Set unroll[j] if the input dimension j is involved in
1297 * the index expression represented by ma.
1299 static int check_unroll(__isl_take isl_set *set, __isl_take isl_multi_aff *ma,
1300 void *user)
1302 int i, j;
1303 int n_in = isl_multi_aff_dim(ma, isl_dim_in);
1304 int n_out = isl_multi_aff_dim(ma, isl_dim_out);
1305 int *unroll = user;
1307 for (i = 0; i < n_out; ++i) {
1308 isl_aff *aff;
1310 aff = isl_multi_aff_get_aff(ma, i);
1311 for (j = 0; j < n_in; ++j)
1312 if (isl_aff_involves_dims(aff, isl_dim_in, j, 1))
1313 unroll[j] = 1;
1314 isl_aff_free(aff);
1317 isl_set_free(set);
1318 isl_multi_aff_free(ma);
1319 return 0;
1322 /* Given an array pos mapping input dimensions to the corresponding
1323 * output dimension, construct the corresponding map.
1325 static __isl_give isl_map *permutation(__isl_take isl_space *dim,
1326 int *pos, int len)
1328 int i;
1329 isl_constraint *c;
1330 isl_basic_map *bmap;
1331 isl_local_space *ls;
1333 dim = isl_space_add_dims(dim, isl_dim_in, len);
1334 dim = isl_space_add_dims(dim, isl_dim_out, len);
1335 bmap = isl_basic_map_universe(isl_space_copy(dim));
1336 ls = isl_local_space_from_space(dim);
1338 for (i = 0; i < len; ++i) {
1339 c = isl_equality_alloc(isl_local_space_copy(ls));
1340 c = isl_constraint_set_coefficient_si(c, isl_dim_in, i,
1341 -1);
1342 c = isl_constraint_set_coefficient_si(c, isl_dim_out, pos[i],
1344 bmap = isl_basic_map_add_constraint(bmap, c);
1346 isl_local_space_free(ls);
1348 return isl_map_from_basic_map(bmap);
1351 /* Remove the private tiles from all array reference groups,
1352 * except for the groups of arrays that are marked force_private.
1354 static void remove_private_tiles(struct gpu_gen *gen)
1356 int i, j;
1358 for (i = 0; i < gen->kernel->n_array; ++i) {
1359 struct gpu_local_array_info *local = &gen->kernel->array[i];
1361 if (local->force_private)
1362 continue;
1364 for (j = 0; j < local->n_group; ++j) {
1365 struct gpu_array_ref_group *group = local->groups[j];
1367 group->private_tile =
1368 gpu_array_tile_free(group->private_tile);
1373 /* Find all loops involved in any of the index expressions for any of
1374 * the private accesses, move them innermost and then mark them as
1375 * requiring unrolling by setting gen->first_unroll.
1376 * The loops involved should all be parallel because of the checks
1377 * we performed in check_private_group_access. Moving them innermost
1378 * is therefore a valid transformation.
1380 * If any of the arrays are marked force_private, however, then
1381 * those loops may not be parallel with respect to the marked arrays.
1382 * If any of the loops would have to be moved innermost for the
1383 * (non forced) private accesses and if there are any force_private
1384 * arrays, then we revert the decision to map the selected arrays
1385 * to private memory. An alternative solution would be to expand
1386 * the force_private arrays.
1388 * Loops up to gen->shared_len are generated before the mapping to
1389 * threads is applied. They should therefore be ignored.
1391 * We compute the hidden equalities of the schedule first
1392 * since we will need them in our calls to isl_pw_multi_aff_from_map
1393 * and because we want to make sure that the same equalities
1394 * are also available to the code generator.
1396 static __isl_give isl_union_map *interchange_for_unroll(struct gpu_gen *gen,
1397 __isl_take isl_union_map *sched)
1399 struct ppcg_kernel *kernel = gen->kernel;
1400 int i, j;
1401 int unroll[gen->thread_tiled_len];
1402 int perm[gen->thread_tiled_len];
1403 isl_space *dim;
1404 isl_map *permute;
1405 int len = gen->shared_len + kernel->n_parallel + kernel->n_block;
1407 gen->first_unroll = -1;
1409 sched = isl_union_map_detect_equalities(sched);
1410 for (i = 0; i < gen->thread_tiled_len; ++i)
1411 unroll[i] = 0;
1412 for (i = 0; i < kernel->n_array; ++i) {
1413 struct gpu_local_array_info *array = &kernel->array[i];
1415 for (j = 0; j < array->n_group; ++j) {
1416 isl_union_map *access;
1417 isl_map *acc;
1418 isl_pw_multi_aff *pma;
1420 if (!array->groups[j]->private_tile)
1421 continue;
1423 access = gpu_array_ref_group_access_relation(
1424 array->groups[j], 1, 1);
1425 access = isl_union_map_apply_domain(access,
1426 isl_union_map_copy(sched));
1428 acc = isl_map_from_union_map(access);
1429 pma = isl_pw_multi_aff_from_map(acc);
1430 isl_pw_multi_aff_foreach_piece(pma,
1431 &check_unroll, unroll);
1433 isl_pw_multi_aff_free(pma);
1437 for (i = gen->shared_len; i < len; ++i)
1438 if (unroll[i])
1439 break;
1441 if (i >= len)
1442 return sched;
1444 for (i = len; i < gen->thread_tiled_len; ++i)
1445 if (unroll[i])
1446 return sched;
1448 if (kernel->any_force_private) {
1449 remove_private_tiles(gen);
1450 return sched;
1453 j = 0;
1454 for (i = 0; i < gen->shared_len; ++i)
1455 perm[i] = j++;
1456 for (i = gen->shared_len; i < gen->thread_tiled_len; ++i)
1457 if (!unroll[i])
1458 perm[i] = j++;
1459 gen->first_unroll = j - gen->shared_len;
1460 for (i = gen->shared_len; i < len; ++i)
1461 if (unroll[i])
1462 perm[i] = j++;
1464 dim = isl_union_map_get_space(sched);
1465 permute = permutation(dim, perm, gen->thread_tiled_len);
1466 sched = isl_union_map_apply_range(sched,
1467 isl_union_map_from_map(permute));
1469 return sched;
1472 /* Construct a map with input the shared tile loops and the loops that
1473 * will be wrapped around the threads that relates these later loops
1474 * to the thread indices and then projects them out.
1476 static __isl_give isl_map *compute_privatization(struct gpu_gen *gen)
1478 struct ppcg_kernel *kernel = gen->kernel;
1479 isl_map *priv;
1480 isl_map *tiling;
1481 isl_map *proj;
1482 isl_set *par;
1483 isl_space *dim;
1485 dim = isl_union_map_get_space(gen->shared_sched);
1487 if (gen->options->wrap)
1488 tiling = wrap(isl_space_copy(dim),
1489 gen->shared_len + kernel->n_block,
1490 gen->shared_len, kernel->n_block, kernel->block_dim);
1491 else
1492 tiling = tile(isl_space_copy(dim),
1493 gen->shared_len + kernel->n_block,
1494 gen->shared_len, kernel->n_block, kernel->block_dim);
1496 priv = tiling;
1498 par = parametrization(dim, gen->shared_len + 2 * kernel->n_block,
1499 gen->tile_first + kernel->tile_len +
1500 kernel->n_grid + kernel->n_block, kernel->thread_ids);
1502 priv = isl_map_align_params(priv, isl_set_get_space(par));
1503 priv = isl_map_intersect_range(priv, par);
1505 dim = isl_map_get_space(priv);
1506 dim = isl_space_drop_dims(dim, isl_dim_in, 0, isl_space_dim(dim, isl_dim_in));
1507 dim = isl_space_drop_dims(dim, isl_dim_out, 0, isl_space_dim(dim, isl_dim_out));
1508 proj = projection(dim, gen->shared_len + 2 * kernel->n_block,
1509 gen->shared_len);
1511 priv = isl_map_apply_range(priv, proj);
1513 return priv;
1516 /* If max_shared_memory is not set to infinity (-1), then make
1517 * sure that the total amount of shared memory required by the
1518 * array reference groups mapped to shared memory by "kernel"
1519 * is no larger than this maximum.
1521 * We apply a greedy approach and discard (keep in global memory)
1522 * those groups that would result in a total memory size that
1523 * is larger than the maximum.
1525 * This function should be called after any function that may
1526 * affect the decision on whether to place a reference group
1527 * in private, shared or global memory.
1529 static void check_shared_memory_bound(struct ppcg_kernel *kernel)
1531 int i, j;
1532 isl_val *left, *size;
1534 if (kernel->options->max_shared_memory < 0)
1535 return;
1537 left = isl_val_int_from_si(kernel->ctx,
1538 kernel->options->max_shared_memory);
1540 for (i = 0; i < kernel->n_array; ++i) {
1541 struct gpu_local_array_info *local = &kernel->array[i];
1543 for (j = 0; j < local->n_group; ++j) {
1544 struct gpu_array_ref_group *group;
1546 group = local->groups[j];
1547 if (group->private_tile)
1548 continue;
1549 if (!group->shared_tile)
1550 continue;
1552 size = gpu_array_tile_size(group->shared_tile);
1553 size = isl_val_mul_ui(size, local->array->size);
1555 if (isl_val_le(size, left)) {
1556 left = isl_val_sub(left, size);
1557 continue;
1559 isl_val_free(size);
1561 group->shared_tile =
1562 gpu_array_tile_free(group->shared_tile);
1566 isl_val_free(left);
1569 /* Compute a tiling for all the array reference groups in "kernel".
1571 static void compute_group_tilings(struct ppcg_kernel *kernel)
1573 int i, j;
1575 for (i = 0; i < kernel->n_array; ++i) {
1576 struct gpu_local_array_info *array = &kernel->array[i];
1578 for (j = 0; j < array->n_group; ++j)
1579 gpu_array_ref_group_compute_tiling(array->groups[j]);
1583 /* Take tiled_sched, project it onto the shared tile loops and
1584 * the loops that will be wrapped over the threads and
1585 * store the result in gen->shared_sched.
1586 * Also compute a projection that projects out the loops that will be
1587 * wrapped over the threads and store this projection in gen->shared_proj.
1589 static void compute_shared_sched(struct gpu_gen *gen)
1591 isl_space *dim;
1592 isl_map *proj;
1593 isl_set *par;
1594 isl_union_map *sched;
1596 sched = isl_union_map_copy(gen->tiled_sched);
1598 dim = isl_union_map_get_space(sched);
1599 proj = projection(dim, gen->tiled_len,
1600 gen->shared_len + gen->kernel->n_block);
1601 sched = isl_union_map_apply_range(sched, isl_union_map_from_map(proj));
1603 dim = isl_union_map_get_space(sched);
1604 proj = projection(dim, gen->shared_len + gen->kernel->n_block,
1605 gen->shared_len);
1607 gen->shared_sched = sched;
1608 gen->shared_proj = isl_union_map_from_map(proj);
1611 /* Compute the size of a bounding box around the origin and "set",
1612 * where "set" is assumed to contain only non-negative elements.
1613 * In particular, compute the maximal value of "set" in each direction
1614 * and add one.
1616 static __isl_give isl_multi_pw_aff *extract_size(__isl_take isl_set *set,
1617 __isl_take isl_set *context)
1619 int i, n;
1620 isl_multi_pw_aff *mpa;
1622 context = isl_set_params(context);
1623 n = isl_set_dim(set, isl_dim_set);
1624 mpa = isl_multi_pw_aff_zero(isl_set_get_space(set));
1625 for (i = 0; i < n; ++i) {
1626 isl_space *space;
1627 isl_aff *one;
1628 isl_pw_aff *bound;
1630 bound = isl_set_dim_max(isl_set_copy(set), i);
1631 bound = isl_pw_aff_coalesce(bound);
1632 bound = isl_pw_aff_gist(bound, isl_set_copy(context));
1634 space = isl_pw_aff_get_domain_space(bound);
1635 one = isl_aff_zero_on_domain(isl_local_space_from_space(space));
1636 one = isl_aff_add_constant_si(one, 1);
1637 bound = isl_pw_aff_add(bound, isl_pw_aff_from_aff(one));
1638 mpa = isl_multi_pw_aff_set_pw_aff(mpa, i, bound);
1640 isl_set_free(set);
1641 isl_set_free(context);
1643 return mpa;
1646 /* Compute the effective grid size as a list of the sizes in each dimension.
1648 * The grid size specified by the user or set by default
1649 * in read_grid_sizes() and applied by the block filter,
1650 * may be too large for the given code in the sense that
1651 * it may contain blocks that don't need to execute anything.
1652 * We therefore don't return this grid size, but instead the
1653 * smallest grid size that ensures that all blocks that actually
1654 * execute code are included in the grid.
1656 * We first extract a description of the grid, i.e., the possible values
1657 * of the block ids, from the domain elements in "domain" and
1658 * kernel->block_filter.
1659 * The block ids are parameters in kernel->block_filter.
1660 * We simply need to change them into set dimensions.
1662 * Then, for each block dimension, we compute the maximal value of the block id
1663 * and add one.
1665 static __isl_give isl_multi_pw_aff *extract_grid_size(
1666 struct ppcg_kernel *kernel, __isl_take isl_union_set *domain)
1668 int i;
1669 isl_set *grid;
1671 domain = isl_union_set_intersect(domain,
1672 isl_union_set_copy(kernel->block_filter));
1673 grid = isl_union_set_params(domain);
1674 grid = isl_set_from_params(grid);
1675 grid = isl_set_add_dims(grid, isl_dim_set, kernel->n_grid);
1676 for (i = 0; i < kernel->n_grid; ++i) {
1677 int pos;
1678 isl_id *id;
1680 id = isl_id_list_get_id(kernel->block_ids, i);
1681 pos = isl_set_find_dim_by_id(grid, isl_dim_param, id);
1682 isl_id_free(id);
1683 assert(pos >= 0);
1684 grid = isl_set_equate(grid, isl_dim_param, pos, isl_dim_set, i);
1685 grid = isl_set_project_out(grid, isl_dim_param, pos, 1);
1688 return extract_size(grid, isl_set_copy(kernel->context));
1691 /* Compute the size of a fixed bounding box around the origin and "set",
1692 * where "set" is assumed to contain only non-negative elements,
1693 * and store the results in "size".
1694 * In particular, compute the maximal value of "set" in each direction
1695 * and add one.
1697 static void extract_fixed_size(__isl_take isl_set *set, int *size)
1699 int i, n;
1700 isl_local_space *ls;
1701 isl_aff *obj;
1703 n = isl_set_dim(set, isl_dim_set);
1704 ls = isl_local_space_from_space(isl_set_get_space(set));
1705 obj = isl_aff_zero_on_domain(ls);
1706 for (i = 0; i < n; ++i) {
1707 isl_val *max;
1709 obj = isl_aff_set_coefficient_si(obj, isl_dim_in, i, 1);
1710 max = isl_set_max_val(set, obj);
1711 size[i] = isl_val_get_num_si(max) + 1;
1712 isl_val_free(max);
1713 obj = isl_aff_set_coefficient_si(obj, isl_dim_in, i, 0);
1715 isl_aff_free(obj);
1716 isl_set_free(set);
1719 /* Compute the effective block size as a list of the sizes in each dimension
1720 * and store the sizes in kernel->block_dim.
1722 * The block size specified by the user or set by default
1723 * in read_block_sizes() and applied by the thread filter,
1724 * may be too large for the given code in the sense that
1725 * it may contain threads that don't need to execute anything.
1726 * We therefore update this block size in kernel->block_dim
1727 * to the smallest block size that ensures that all threads
1728 * that actually execute code are included in the block.
1730 * The possible values of the thread ids is obtained from
1731 * the domain elements "domain" and kernel->thread_filter.
1732 * The current implementation eliminates all parameters, ensuring
1733 * that the size is a fixed constant in each dimension.
1734 * In principle we could also compute parametric sizes.
1735 * We would have to make sure to project out all b%d and t%d parameters,
1736 * however.
1738 static void extract_block_size(struct ppcg_kernel *kernel,
1739 __isl_take isl_union_set *domain)
1741 int i;
1742 int nparam;
1743 isl_set *block;
1745 domain = isl_union_set_intersect(domain,
1746 isl_union_set_copy(kernel->thread_filter));
1747 block = isl_union_set_params(domain);
1748 block = isl_set_from_params(block);
1749 block = isl_set_add_dims(block, isl_dim_set, kernel->n_block);
1750 for (i = 0; i < kernel->n_block; ++i) {
1751 int pos;
1752 isl_id *id;
1754 id = isl_id_list_get_id(kernel->thread_ids, i);
1755 pos = isl_set_find_dim_by_id(block, isl_dim_param, id);
1756 isl_id_free(id);
1757 assert(pos >= 0);
1758 block = isl_set_equate(block, isl_dim_param, pos,
1759 isl_dim_set, i);
1761 nparam = isl_set_dim(block, isl_dim_param);
1762 block = isl_set_project_out(block, isl_dim_param, 0, nparam);
1764 extract_fixed_size(block, kernel->block_dim);
1767 struct ppcg_kernel *ppcg_kernel_free(struct ppcg_kernel *kernel)
1769 int i, j;
1771 if (!kernel)
1772 return NULL;
1774 isl_id_list_free(kernel->block_ids);
1775 isl_id_list_free(kernel->thread_ids);
1776 isl_multi_pw_aff_free(kernel->grid_size);
1777 isl_set_free(kernel->context);
1778 isl_union_set_free(kernel->core);
1779 isl_union_set_free(kernel->arrays);
1780 isl_space_free(kernel->space);
1781 isl_ast_node_free(kernel->tree);
1782 isl_union_set_free(kernel->block_filter);
1783 isl_union_set_free(kernel->thread_filter);
1785 for (i = 0; i < kernel->n_array; ++i) {
1786 struct gpu_local_array_info *array = &kernel->array[i];
1788 for (j = 0; j < array->n_group; ++j)
1789 gpu_array_ref_group_free(array->groups[j]);
1790 free(array->groups);
1792 isl_pw_aff_list_free(array->bound);
1794 free(kernel->array);
1796 for (i = 0; i < kernel->n_var; ++i) {
1797 free(kernel->var[i].name);
1798 isl_vec_free(kernel->var[i].size);
1800 free(kernel->var);
1801 free(kernel->tile_size);
1803 free(kernel);
1805 return NULL;
1808 /* Wrapper around ppcg_kernel_free for use as a isl_id_set_free_user callback.
1810 static void ppcg_kernel_free_wrap(void *user)
1812 struct ppcg_kernel *kernel = user;
1814 ppcg_kernel_free(kernel);
1817 static void create_kernel_var(isl_ctx *ctx, struct gpu_array_ref_group *group,
1818 struct ppcg_kernel_var *var)
1820 int j;
1821 struct gpu_array_tile *tile;
1822 isl_printer *p;
1823 char *name;
1825 var->array = group->array;
1827 tile = group->private_tile;
1828 var->type = ppcg_access_private;
1829 if (!tile) {
1830 tile = group->shared_tile;
1831 var->type = ppcg_access_shared;
1834 p = isl_printer_to_str(ctx);
1835 p = gpu_array_ref_group_print_name(group, p);
1836 var->name = isl_printer_get_str(p);
1837 isl_printer_free(p);
1839 var->size = isl_vec_alloc(ctx, group->array->n_index);
1841 for (j = 0; j < group->array->n_index; ++j)
1842 var->size = isl_vec_set_element_val(var->size, j,
1843 isl_val_copy(tile->bound[j].size));
1846 static void create_kernel_vars(struct ppcg_kernel *kernel)
1848 int i, j, n;
1850 n = 0;
1851 for (i = 0; i < kernel->n_array; ++i) {
1852 struct gpu_local_array_info *array = &kernel->array[i];
1854 for (j = 0; j < array->n_group; ++j) {
1855 struct gpu_array_ref_group *group = array->groups[j];
1856 if (group->private_tile || group->shared_tile)
1857 ++n;
1861 kernel->n_var = n;
1862 kernel->var = isl_calloc_array(kernel->ctx, struct ppcg_kernel_var, n);
1863 assert(kernel->var);
1865 n = 0;
1866 for (i = 0; i < kernel->n_array; ++i) {
1867 struct gpu_local_array_info *array = &kernel->array[i];
1869 for (j = 0; j < array->n_group; ++j) {
1870 struct gpu_array_ref_group *group = array->groups[j];
1871 if (!group->private_tile && !group->shared_tile)
1872 continue;
1873 create_kernel_var(kernel->ctx, group, &kernel->var[n]);
1874 ++n;
1879 /* Replace "pa" by the zero function defined over the universe domain
1880 * in the space of "pa".
1882 static __isl_give isl_pw_aff *set_universally_zero(__isl_take isl_pw_aff *pa)
1884 isl_space *space;
1885 isl_aff *zero;
1887 space = isl_space_domain(isl_pw_aff_get_space(pa));
1888 isl_pw_aff_free(pa);
1889 zero = isl_aff_zero_on_domain(isl_local_space_from_space(space));
1891 return isl_pw_aff_from_aff(zero);
1894 /* The sizes of the arrays on the host that have been computed by
1895 * extract_array_info may depend on the parameters. Use the extra
1896 * constraints on the parameters that are valid at "host_domain"
1897 * to simplify these expressions and store the results in kernel->array.
1899 * We only need these localized bounds for arrays that are accessed
1900 * by the current kernel. If we have found at least one reference group
1901 * then the array is accessed by the kernel. If the array has compound
1902 * elements then we skipped the construction of array reference groups.
1904 * The resulting sizes may be functions that are nowhere defined
1905 * in case the access function cannot possibly access anything inside
1906 * the kernel for some reason. If so, they are replaced by the zero
1907 * function. Since the access function cannot actually access anything,
1908 * there is no harm in printing the array sizes as zero.
1910 static void localize_bounds(struct ppcg_kernel *kernel,
1911 __isl_keep isl_set *host_domain)
1913 int i, j;
1914 isl_set *context;
1916 context = isl_set_copy(host_domain);
1917 context = isl_set_params(context);
1919 for (i = 0; i < kernel->n_array; ++i) {
1920 struct gpu_local_array_info *local = &kernel->array[i];
1921 isl_pw_aff_list *bound;
1922 int n_index;
1924 if (local->n_group == 0 && !local->array->has_compound_element)
1925 continue;
1927 n_index = local->array->n_index;
1928 bound = isl_pw_aff_list_alloc(kernel->ctx, n_index);
1930 for (j = 0; j < n_index; ++j) {
1931 isl_pw_aff *pwaff;
1932 int empty;
1934 pwaff = isl_pw_aff_copy(local->array->bound[j]);
1935 pwaff = isl_pw_aff_gist(pwaff, isl_set_copy(context));
1936 empty = isl_pw_aff_is_empty(pwaff);
1937 if (empty < 0)
1938 pwaff = isl_pw_aff_free(pwaff);
1939 else if (empty)
1940 pwaff = set_universally_zero(pwaff);
1941 bound = isl_pw_aff_list_add(bound, pwaff);
1944 local->n_index = n_index;
1945 local->bound = bound;
1947 isl_set_free(context);
1950 /* Create the array of gpu_local_array_info structures "array"
1951 * inside "kernel". The number of elements in this array is
1952 * the same as the number of arrays in "prog".
1953 * Initialize the "array" field of each local array to point
1954 * to the corresponding array in "prog".
1956 static struct ppcg_kernel *ppcg_kernel_create_local_arrays(
1957 struct ppcg_kernel *kernel, struct gpu_prog *prog)
1959 int i;
1960 isl_ctx *ctx;
1962 ctx = isl_set_get_ctx(prog->context);
1963 kernel->array = isl_calloc_array(ctx,
1964 struct gpu_local_array_info, prog->n_array);
1965 if (!kernel->array)
1966 return ppcg_kernel_free(kernel);
1967 kernel->n_array = prog->n_array;
1969 for (i = 0; i < prog->n_array; ++i)
1970 kernel->array[i].array = &prog->array[i];
1972 return kernel;
1975 /* Find the element in gen->stmt that has the given "id".
1976 * Return NULL if no such gpu_stmt can be found.
1978 static struct gpu_stmt *find_stmt(struct gpu_prog *prog, __isl_keep isl_id *id)
1980 int i;
1982 for (i = 0; i < prog->n_stmts; ++i) {
1983 if (id == prog->stmts[i].id)
1984 break;
1987 return i < prog->n_stmts ? &prog->stmts[i] : NULL;
1990 void ppcg_kernel_stmt_free(void *user)
1992 int i;
1993 struct ppcg_kernel_stmt *stmt = user;
1995 if (!stmt)
1996 return;
1998 switch (stmt->type) {
1999 case ppcg_kernel_copy:
2000 isl_ast_expr_free(stmt->u.c.index);
2001 isl_ast_expr_free(stmt->u.c.local_index);
2002 break;
2003 case ppcg_kernel_domain:
2004 isl_id_to_ast_expr_free(stmt->u.d.ref2expr);
2005 break;
2006 case ppcg_kernel_sync:
2007 break;
2010 free(stmt);
2013 /* Set the options of "context" to
2015 * { space -> [x] : x >= first }
2017 static __isl_give isl_ast_build *set_unroll(
2018 __isl_take isl_ast_build *build, __isl_take isl_space *space,
2019 int first)
2021 isl_ctx *ctx;
2022 isl_map *unroll;
2023 isl_union_map *opt;
2025 ctx = isl_ast_build_get_ctx(build);
2027 space = isl_space_from_domain(space);
2028 space = isl_space_add_dims(space, isl_dim_out, 1);
2029 space = isl_space_set_tuple_name(space, isl_dim_out, "unroll");
2030 unroll = isl_map_universe(space);
2031 unroll = isl_map_lower_bound_si(unroll, isl_dim_out, 0, first);
2032 opt = isl_union_map_from_map(unroll);
2034 build = isl_ast_build_set_options(build, opt);
2036 return build;
2039 /* Extend the schedule "schedule" with the part of "extension"
2040 * starting at "first" up to "len".
2042 static __isl_give isl_union_map *extend_schedule(
2043 __isl_take isl_union_map *schedule,
2044 __isl_take isl_union_map *extension, int first, int len)
2046 isl_space *space;
2047 isl_map *proj;
2048 isl_union_map *umap;
2049 isl_set *set;
2051 space = isl_union_map_get_space(schedule);
2052 space = isl_space_set_from_params(space);
2053 space = isl_space_add_dims(space, isl_dim_set, len);
2054 proj = isl_set_identity(isl_set_universe(space));
2055 proj = isl_map_project_out(proj, isl_dim_out, 0, first);
2056 extension = isl_union_map_apply_range(extension,
2057 isl_union_map_from_map(proj));
2059 schedule = isl_union_map_range_product(schedule, extension);
2061 return schedule;
2064 /* Return the gpu_stmt_access in the list "accesses" that corresponds
2065 * to "ref_id".
2067 static struct gpu_stmt_access *find_access(struct gpu_stmt_access *accesses,
2068 __isl_keep isl_id *ref_id)
2070 struct gpu_stmt_access *access;
2072 for (access = accesses; access; access = access->next)
2073 if (access->ref_id == ref_id)
2074 return access;
2076 return NULL;
2079 /* Return the index of the array called "name" in the list of arrays.
2081 static int find_array_index(struct ppcg_kernel *kernel, const char *name)
2083 int i;
2085 for (i = 0; i < kernel->n_array; ++i)
2086 if (!strcmp(name, kernel->array[i].array->name))
2087 return i;
2089 return -1;
2092 /* Internal data structure for the index and AST expression transformation
2093 * callbacks for pet_stmt_build_ast_exprs.
2095 * "accesses" is the list of gpu_stmt_access in the statement.
2096 * "iterator_map" expresses the statement iterators in terms of
2097 * the AST loop iterators.
2098 * "sched2shared" expresses the first shared_len dimensions of
2099 * the computed schedule in terms of the AST loop iterators.
2101 * The following fields are set in transform_index and used in transform_expr.
2102 * "array" is the array that is being accessed.
2103 * "global" is set if the global array is accessed (rather than
2104 * shared/private memory).
2105 * "local_array" refers to information on the array specialized
2106 * to the current kernel.
2108 struct ppcg_transform_data {
2109 struct gpu_gen *gen;
2110 struct gpu_stmt_access *accesses;
2111 isl_pw_multi_aff *iterator_map;
2112 isl_pw_multi_aff *sched2shared;
2114 struct gpu_array_info *array;
2115 int global;
2116 struct gpu_local_array_info *local_array;
2119 /* Return the name of the outer array (of structs) accessed by "access".
2121 static const char *get_outer_array_name(__isl_keep isl_map *access)
2123 isl_space *space;
2124 const char *name;
2126 space = isl_space_range(isl_map_get_space(access));
2127 while (space && isl_space_is_wrapping(space))
2128 space = isl_space_domain(isl_space_unwrap(space));
2129 name = isl_space_get_tuple_name(space, isl_dim_set);
2130 isl_space_free(space);
2132 return name;
2135 /* Return a pointer to the gpu_array_ref_group in "local"
2136 * that contains the reference "access".
2137 * Return NULL if no such group can be found.
2139 static struct gpu_array_ref_group *find_ref_group(
2140 struct gpu_local_array_info *local, struct gpu_stmt_access *access)
2142 int i, j;
2144 for (i = 0; i < local->n_group; ++i) {
2145 struct gpu_array_ref_group *group = local->groups[i];
2147 for (j = 0; j < group->n_ref; ++j)
2148 if (group->refs[j] == access)
2149 return group;
2152 return NULL;
2155 /* Index transformation callback for pet_stmt_build_ast_exprs.
2157 * "index" expresses the array indices in terms of statement iterators
2159 * We first reformulate "index" in terms of the AST loop iterators.
2160 * Then we check if we are accessing the global array or
2161 * a shared/private copy. In the former case, we simply return
2162 * the updated index. If "index" is an affine expression rather
2163 * than an array access, then we also return the updated index here.
2165 * If no reference groups have been computed for the array,
2166 * then we can only be accessing the global array.
2168 * Otherwise, we apply the tiling to the index.
2169 * This tiling is of the form
2171 * [D -> A] -> T
2173 * The index is of the form
2175 * L -> A
2177 * We update the tiling to refer to the AST loop iterators
2179 * [L -> A] -> T
2181 * and modify index to keep track of those iterators
2183 * L -> [L -> A]
2185 * Combining these two yields a tiled index expression in terms
2186 * of the AST loop iterators
2188 * L -> T
2190 static __isl_give isl_multi_pw_aff *transform_index(
2191 __isl_take isl_multi_pw_aff *index, __isl_keep isl_id *ref_id,
2192 void *user)
2194 struct ppcg_transform_data *data = user;
2195 struct gpu_stmt_access *access;
2196 struct gpu_array_ref_group *group;
2197 struct gpu_array_tile *tile;
2198 isl_pw_multi_aff *iterator_map;
2199 int i;
2200 const char *name;
2201 isl_space *space;
2202 isl_multi_pw_aff *tiling;
2203 isl_pw_multi_aff *pma;
2204 isl_multi_pw_aff *mpa;
2206 data->array = NULL;
2208 iterator_map = isl_pw_multi_aff_copy(data->iterator_map);
2209 index = isl_multi_pw_aff_pullback_pw_multi_aff(index, iterator_map);
2211 access = find_access(data->accesses, ref_id);
2212 if (!access)
2213 return index;
2214 if (!isl_map_has_tuple_name(access->access, isl_dim_out))
2215 return index;
2217 name = get_outer_array_name(access->access);
2218 i = find_array_index(data->gen->kernel, name);
2219 if (i < 0)
2220 isl_die(isl_multi_pw_aff_get_ctx(index), isl_error_internal,
2221 "cannot find array",
2222 return isl_multi_pw_aff_free(index));
2223 data->array = &data->gen->prog->array[i];
2224 data->local_array = &data->gen->kernel->array[i];
2226 group = find_ref_group(data->local_array, access);
2227 if (!group) {
2228 data->global = 1;
2229 return index;
2232 tile = group->private_tile;
2233 if (!tile)
2234 tile = group->shared_tile;
2235 data->global = !tile;
2236 if (!tile)
2237 return index;
2239 space = isl_space_range(isl_multi_pw_aff_get_space(index));
2240 space = isl_space_map_from_set(space);
2241 pma = isl_pw_multi_aff_identity(space);
2242 pma = isl_pw_multi_aff_product(
2243 isl_pw_multi_aff_copy(data->sched2shared), pma);
2244 tiling = isl_multi_pw_aff_from_multi_aff(
2245 isl_multi_aff_copy(tile->tiling));
2246 tiling = isl_multi_pw_aff_pullback_pw_multi_aff(tiling, pma);
2248 space = isl_space_domain(isl_multi_pw_aff_get_space(index));
2249 space = isl_space_map_from_set(space);
2250 mpa = isl_multi_pw_aff_identity(space);
2251 index = isl_multi_pw_aff_range_product(mpa, index);
2252 index = isl_multi_pw_aff_pullback_multi_pw_aff(tiling, index);
2254 return index;
2257 /* Dereference "expr" by adding an index [0].
2258 * The original "expr" is assumed not to have any indices.
2260 * If "expr" is a member access, then the dereferencing needs
2261 * to be applied to the structure argument of this member access.
2263 static __isl_give isl_ast_expr *dereference(__isl_take isl_ast_expr *expr)
2265 isl_ctx *ctx;
2266 isl_ast_expr *arg0, *res;
2267 isl_ast_expr_list *list;
2269 arg0 = isl_ast_expr_get_op_arg(expr, 0);
2270 if (!arg0)
2271 return isl_ast_expr_free(expr);
2272 if (isl_ast_expr_get_type(arg0) == isl_ast_expr_op &&
2273 isl_ast_expr_get_op_type(arg0) == isl_ast_op_member) {
2274 isl_ast_expr *arg;
2276 arg = isl_ast_expr_get_op_arg(arg0, 0);
2277 arg = dereference(arg);
2278 arg0 = isl_ast_expr_set_op_arg(arg0, 0, arg);
2279 expr = isl_ast_expr_set_op_arg(expr, 0, arg0);
2281 return expr;
2283 isl_ast_expr_free(arg0);
2285 ctx = isl_ast_expr_get_ctx(expr);
2286 res = isl_ast_expr_from_val(isl_val_zero(ctx));
2287 list = isl_ast_expr_list_from_ast_expr(res);
2288 res = isl_ast_expr_get_op_arg(expr, 0);
2289 res = isl_ast_expr_access(res, list);
2290 isl_ast_expr_free(expr);
2292 return res;
2295 /* Linearize the index expression "expr" based on the array bounds
2296 * of "array".
2298 * That is, transform expression
2300 * A[i_0][i_1]...[i_n]
2302 * to
2304 * A[(..((i_0 * b_1 + i_1) ... ) * b_n + i_n]
2306 * where b_0, b_1, ..., b_n are the bounds on the array.
2308 * If the base of "expr" is a member access, then the linearization needs
2309 * to be applied to the structure argument of this member access.
2311 * In the base case, if "expr" has no arguments (other than the name of
2312 * the array), then we are passing an entire array to a function.
2313 * In this case, there is nothing to linearize.
2314 * Note that at this point an expression with no arguments can
2315 * only be an entire array because the scalar case and
2316 * the case of single struct are handled by the caller.
2318 * If the number of specified index expressions in "expr"
2319 * is smaller than the dimension of the accessed array,
2320 * then the missing i_j also do not appear in the linearized expression.
2321 * Furthermore, since such an expression does not refer to a single
2322 * element while the default linearized expression would refer to
2323 * a single element, we return the expression
2325 * A + (..((i_0 * b_1 + i_1) ... ) * b_n]
2327 * instead. Note that because of the special case handling above,
2328 * we can assume here that here that there is at least one index expression.
2330 __isl_give isl_ast_expr *gpu_local_array_info_linearize_index(
2331 struct gpu_local_array_info *array, __isl_take isl_ast_expr *expr)
2333 int i, n;
2334 isl_ctx *ctx;
2335 isl_set *context;
2336 isl_ast_expr *arg0;
2337 isl_ast_expr *res;
2338 isl_ast_expr_list *list;
2339 isl_ast_build *build;
2341 arg0 = isl_ast_expr_get_op_arg(expr, 0);
2342 if (isl_ast_expr_get_type(arg0) == isl_ast_expr_op &&
2343 isl_ast_expr_get_op_type(arg0) == isl_ast_op_member) {
2344 isl_ast_expr *arg;
2346 arg = isl_ast_expr_get_op_arg(arg0, 0);
2347 arg = gpu_local_array_info_linearize_index(array, arg);
2348 arg0 = isl_ast_expr_set_op_arg(arg0, 0, arg);
2349 expr = isl_ast_expr_set_op_arg(expr, 0, arg0);
2351 return expr;
2353 isl_ast_expr_free(arg0);
2355 if (isl_ast_expr_get_op_n_arg(expr) == 1)
2356 return expr;
2358 ctx = isl_ast_expr_get_ctx(expr);
2359 context = isl_set_universe(isl_space_params_alloc(ctx, 0));
2360 build = isl_ast_build_from_context(context);
2362 n = isl_ast_expr_get_op_n_arg(expr);
2363 res = isl_ast_expr_get_op_arg(expr, 1);
2364 for (i = 1; i < array->n_index; ++i) {
2365 isl_pw_aff *bound_i;
2366 isl_ast_expr *expr_i;
2368 bound_i = isl_pw_aff_list_get_pw_aff(array->bound, i);
2369 expr_i = isl_ast_build_expr_from_pw_aff(build, bound_i);
2370 res = isl_ast_expr_mul(res, expr_i);
2372 if (i + 1 >= n)
2373 continue;
2374 expr_i = isl_ast_expr_get_op_arg(expr, i + 1);
2375 res = isl_ast_expr_add(res, expr_i);
2378 isl_ast_build_free(build);
2380 if (1 + array->n_index > n) {
2381 res = isl_ast_expr_add(isl_ast_expr_get_op_arg(expr, 0), res);
2382 } else {
2383 list = isl_ast_expr_list_from_ast_expr(res);
2384 res = isl_ast_expr_get_op_arg(expr, 0);
2385 res = isl_ast_expr_access(res, list);
2388 isl_ast_expr_free(expr);
2390 return res;
2393 /* AST expression transformation callback for pet_stmt_build_ast_exprs.
2395 * If the AST expression refers to an array that is not accessed
2396 * at all, then this means the value of the expression is not used,
2397 * so we might as well print zero (NULL pointer) instead.
2399 * If the AST expression refers to a global scalar that is not
2400 * a read-only scalar, then its address was passed to the kernel and
2401 * we need to dereference it.
2403 * If the AST expression refers to an access to a global array,
2404 * then we linearize the access exploiting the bounds in data->local_array.
2406 static __isl_give isl_ast_expr *transform_expr(__isl_take isl_ast_expr *expr,
2407 __isl_keep isl_id *id, void *user)
2409 struct ppcg_transform_data *data = user;
2411 if (!data->array)
2412 return expr;
2413 if (!data->array->accessed) {
2414 isl_ctx *ctx;
2416 ctx = isl_ast_expr_get_ctx(expr);
2417 isl_ast_expr_free(expr);
2418 return isl_ast_expr_from_val(isl_val_zero(ctx));
2420 if (gpu_array_is_read_only_scalar(data->array))
2421 return expr;
2422 if (!data->global)
2423 return expr;
2424 if (data->array->n_index == 0)
2425 return dereference(expr);
2426 if (!data->array->linearize)
2427 return expr;
2429 return gpu_local_array_info_linearize_index(data->local_array, expr);
2432 /* This function is called for each instance of a user statement
2433 * in the kernel.
2435 * We attach a struct ppcg_kernel_stmt to the "node", containing
2436 * a computed AST expression for each access.
2437 * These AST expressions are computed from iterator_map,
2438 * which expresses the domain
2439 * elements in terms of the generated loops, and sched2shared,
2440 * which expresses the first shared_len dimensions of the schedule
2441 * computed by PPCG in terms of the generated loops.
2443 static __isl_give isl_ast_node *at_each_domain(__isl_take isl_ast_node *node,
2444 __isl_keep isl_ast_build *build, void *user)
2446 struct ppcg_transform_data data;
2447 struct gpu_gen *gen = (struct gpu_gen *) user;
2448 struct ppcg_kernel_stmt *stmt;
2449 isl_id *id;
2450 isl_pw_multi_aff *sched2shared;
2451 isl_map *map;
2452 isl_pw_multi_aff *iterator_map;
2453 isl_ast_expr *expr, *arg;
2454 isl_union_map *schedule;
2456 stmt = isl_calloc_type(gen->ctx, struct ppcg_kernel_stmt);
2457 if (!stmt)
2458 return isl_ast_node_free(node);
2460 expr = isl_ast_node_user_get_expr(node);
2461 arg = isl_ast_expr_get_op_arg(expr, 0);
2462 id = isl_ast_expr_get_id(arg);
2464 schedule = isl_ast_build_get_schedule(build);
2465 map = isl_map_reverse(isl_map_from_union_map(schedule));
2466 iterator_map = isl_pw_multi_aff_from_map(map);
2467 sched2shared = compute_sched_to_shared(gen,
2468 isl_pw_multi_aff_copy(iterator_map));
2470 stmt->type = ppcg_kernel_domain;
2471 stmt->u.d.stmt = find_stmt(gen->prog, id);
2472 if (!stmt->u.d.stmt)
2473 isl_die(gen->ctx, isl_error_internal,
2474 "statement not found", goto error);
2476 data.gen = gen;
2477 data.accesses = stmt->u.d.stmt->accesses;
2478 data.iterator_map = iterator_map;
2479 data.sched2shared = sched2shared;
2480 stmt->u.d.ref2expr = pet_stmt_build_ast_exprs(stmt->u.d.stmt->stmt,
2481 build, &transform_index, &data,
2482 &transform_expr, &data);
2484 isl_id_free(id);
2485 isl_pw_multi_aff_free(iterator_map);
2486 isl_pw_multi_aff_free(sched2shared);
2487 isl_ast_expr_free(arg);
2488 isl_ast_expr_free(expr);
2490 id = isl_id_alloc(gen->ctx, NULL, stmt);
2491 id = isl_id_set_free_user(id, &ppcg_kernel_stmt_free);
2492 return isl_ast_node_set_annotation(node, id);
2493 error:
2494 isl_id_free(id);
2495 isl_pw_multi_aff_free(iterator_map);
2496 ppcg_kernel_stmt_free(stmt);
2497 isl_pw_multi_aff_free(sched2shared);
2498 return isl_ast_node_free(node);
2501 /* This function is called when code has been generated for the shared
2502 * tile loops. The "schedule" refers only to the original statements.
2504 * We extend the schedule with that part of gen->local_sched that hasn't
2505 * been taken into account yet. This introduces parameters referring
2506 * to thread ids in the schedule, so we add them (with the appropriate
2507 * bounds to the context as well).
2508 * Finally, we set the appropriate unrolling options
2509 * if gen->first_unroll is set.
2511 static __isl_give isl_ast_node *create_domain_leaf(
2512 __isl_take isl_union_map *schedule, __isl_take isl_ast_build *build,
2513 void *user)
2515 struct gpu_gen *gen = (struct gpu_gen *) user;
2516 isl_space *space;
2517 isl_union_map *sched;
2518 isl_ast_node *tree;
2519 isl_set *set;
2520 isl_id_list *iterators;
2521 int n;
2523 schedule = extend_schedule(schedule,
2524 isl_union_map_copy(gen->local_sched),
2525 gen->shared_len, gen->thread_tiled_len);
2527 space = isl_ast_build_get_schedule_space(build);
2528 set = isl_set_universe(space);
2529 set = add_bounded_parameters(set, gen->kernel->block_dim,
2530 gen->kernel->thread_ids);
2531 build = isl_ast_build_restrict(build, set);
2533 n = gen->thread_tiled_len - gen->shared_len;
2535 if (gen->first_unroll >= 0) {
2536 space = isl_space_set_alloc(gen->ctx, 0, n);
2537 build = set_unroll(build, space, gen->first_unroll);
2539 iterators = ppcg_scop_generate_names(gen->prog->scop, n, "c");
2540 build = isl_ast_build_set_iterators(build, iterators);
2541 build = isl_ast_build_set_at_each_domain(build, &at_each_domain, gen);
2542 tree = isl_ast_build_node_from_schedule_map(build, schedule);
2543 isl_ast_build_free(build);
2545 return tree;
2548 /* This function is called for each statement node in the AST of the code
2549 * for copying to or from shared/private memory.
2550 * Attach a pointer to a ppcg_kernel_stmt representing the copy
2551 * statement to the node.
2552 * The statement name is "read" or "write", depending on whether we are
2553 * reading from global memory or writing to global memory.
2554 * The name of the T space is {shared,private}_<array>.
2556 * The schedule is of the form
2558 * type[A -> T] -> L
2560 * where A refers to a piece of an array and T to the corresponding
2561 * shifted tile. We split this schedule into mappings L -> A and L -> T
2562 * and store the corresponding expressions in stmt->index and stmt->local_index,
2563 * where stmt points to the ppcg_kernel_stmt that is attached to the node.
2565 static __isl_give isl_ast_node *attach_copy_stmt(__isl_take isl_ast_node *node,
2566 __isl_keep isl_ast_build *build, void *user)
2568 struct gpu_gen *gen = (struct gpu_gen *) user;
2569 struct ppcg_kernel_stmt *stmt;
2570 isl_id *id;
2571 isl_ast_expr *expr;
2572 isl_space *space;
2573 isl_map *access, *local_access, *map;
2574 isl_pw_multi_aff *pma;
2575 const char *type;
2576 int array_index;
2578 stmt = isl_calloc_type(gen->ctx, struct ppcg_kernel_stmt);
2579 if (!stmt)
2580 return isl_ast_node_free(node);
2582 access = isl_map_from_union_map(isl_ast_build_get_schedule(build));
2583 type = isl_map_get_tuple_name(access, isl_dim_in);
2584 stmt->u.c.read = !strcmp(type, "read");
2585 access = isl_map_reverse(access);
2586 space = isl_space_unwrap(isl_space_range(isl_map_get_space(access)));
2587 local_access = isl_map_copy(access);
2589 map = isl_map_domain_map(isl_map_universe(isl_space_copy(space)));
2590 id = isl_map_get_tuple_id(access, isl_dim_out);
2591 map = isl_map_set_tuple_id(map, isl_dim_in, id);
2592 access = isl_map_apply_range(access, map);
2593 pma = isl_pw_multi_aff_from_map(access);
2594 expr = isl_ast_build_access_from_pw_multi_aff(build, pma);
2595 stmt->u.c.index = expr;
2597 map = isl_map_range_map(isl_map_universe(space));
2598 id = isl_map_get_tuple_id(local_access, isl_dim_out);
2599 map = isl_map_set_tuple_id(map, isl_dim_in, id);
2600 local_access = isl_map_apply_range(local_access, map);
2601 pma = isl_pw_multi_aff_from_map(local_access);
2602 expr = isl_ast_build_access_from_pw_multi_aff(build, pma);
2603 stmt->u.c.local_index = expr;
2605 stmt->u.c.array = gen->copy_group->array;
2606 array_index = stmt->u.c.array - gen->prog->array;
2607 stmt->u.c.local_array = &gen->kernel->array[array_index];
2608 stmt->type = ppcg_kernel_copy;
2610 id = isl_id_alloc(gen->ctx, NULL, stmt);
2611 id = isl_id_set_free_user(id, &ppcg_kernel_stmt_free);
2612 return isl_ast_node_set_annotation(node, id);
2615 /* Given a schedule of the form
2617 * [S -> A] -> L
2619 * (with S the first shared_len dimensions of the computed schedule,
2620 * A the array and L the schedule correponding to the generated loops),
2621 * indicating where to copy the array elements that need to be copied,
2622 * construct code for performing the copying.
2624 * "group" is the array reference group that is being copied
2625 * "type" is either "read" or "write"
2626 * private is set if copying needs to be performed to/from registers
2628 * We first construct a mapping to a shifted tile of the array,
2630 * [S -> A] -> T(S,A) (1)
2632 * If private is set, then we also use this mapping as a schedule
2633 * (which is already thread-specific and will be completely unrolled).
2634 * Otherwise, we wrap/tile the range over the threads.
2635 * The result is
2637 * [S -> A] -> T'(S,A)
2639 * Combined with the given schedule, we have
2641 * [S -> A] -> [L -> T'(S,A)] (2)
2643 * From the shifted tile mapping, we construct a mapping
2645 * [S -> A] -> [A -> T(S,A)]
2647 * and apply it to the schedule (2), obtaining
2649 * [A -> T(S(L),A)] -> [L -> T'(S(L),A)]
2651 * Note that we can project out S because it is uniquely defined by L.
2653 static __isl_give isl_ast_node *copy_access(struct gpu_gen *gen,
2654 __isl_take isl_map *sched,
2655 const char *type, struct gpu_array_ref_group *group,
2656 __isl_take isl_ast_build *build, int private)
2658 isl_space *space;
2659 isl_ast_node *tree;
2660 isl_map *schedule, *shift, *map;
2661 isl_set *set;
2662 isl_id_list *iterators;
2663 int n;
2665 shift = shift_access(group);
2667 schedule = isl_map_copy(shift);
2668 schedule = isl_map_reset_tuple_id(schedule, isl_dim_out);
2669 if (!private)
2670 schedule = tile_access_schedule(gen, schedule);
2672 n = isl_map_dim(schedule, isl_dim_out);
2673 set = isl_set_universe(isl_ast_build_get_schedule_space(build));
2674 set = add_bounded_parameters(set, gen->kernel->block_dim,
2675 gen->kernel->thread_ids);
2677 schedule = isl_map_range_product(sched, schedule);
2679 space = isl_space_domain(isl_map_get_space(shift));
2680 map = isl_map_range_map(isl_map_universe(isl_space_unwrap(space)));
2681 map = isl_map_range_product(map, shift);
2683 schedule = isl_map_apply_domain(schedule, map);
2685 schedule = isl_map_set_tuple_name(schedule, isl_dim_in, type);
2687 build = isl_ast_build_restrict(build, set);
2689 gen->copy_group = group;
2691 if (private) {
2692 space = isl_space_range(isl_map_get_space(schedule));
2693 space = isl_space_range(isl_space_unwrap(space));
2694 build = set_unroll(build, space, 0);
2696 iterators = ppcg_scop_generate_names(gen->prog->scop, n, "c");
2697 build = isl_ast_build_set_iterators(build, iterators);
2698 build = isl_ast_build_set_at_each_domain(build, &attach_copy_stmt, gen);
2699 tree = isl_ast_build_node_from_schedule_map(build,
2700 isl_union_map_from_map(schedule));
2701 isl_ast_build_free(build);
2703 return tree;
2706 /* Return code for reading into or writing from shared memory
2707 * the given array reference group.
2709 * If we are performing a read from global memory to shared memory and
2710 * if the array involved is not a scalar, then we copy
2711 * the entire tile to shared memory. This may result in some extra
2712 * elements getting copied, but it should lead to simpler code
2713 * (which means that fewer registers may be needed) and less divergence.
2715 * Otherwise, we only copy the elements that will be read or have been written
2716 * in the kernel.
2719 * The input "sched" is of the form.
2721 * type[S -> A] -> L
2723 * with S the first shared_len dimensions of the computed schedule,
2724 * A the array and L the schedule correponding to the generated loops.
2726 * We first drop "type",
2728 * [S -> A] -> L
2730 * If the above conditions are satisfied, we project out A,
2731 * resulting in
2733 * S -> L
2735 * and then introduce the group tile [S -> T], resulting in
2737 * [S -> T] -> L
2739 static __isl_give isl_ast_node *copy_group_shared_accesses(
2740 struct gpu_gen *gen, struct gpu_array_ref_group *group,
2741 __isl_take isl_map *sched, __isl_take isl_ast_build *build)
2743 const char *type;
2744 int read;
2745 isl_union_map *access;
2747 type = isl_map_get_tuple_name(sched, isl_dim_in);
2748 read = !strcmp(type, "read");
2750 sched = isl_map_reset_tuple_id(sched, isl_dim_in);
2752 if (read && !gpu_array_is_scalar(group->array)) {
2753 isl_space *space;
2754 isl_map *map;
2756 space = isl_space_domain(isl_map_get_space(sched));
2757 space = isl_space_unwrap(space);
2758 map = isl_map_domain_map(isl_map_universe(space));
2759 sched = isl_map_apply_domain(sched, map);
2761 map = group_tile(group);
2762 map = isl_map_reverse(isl_map_domain_map(map));
2763 sched = isl_map_apply_domain(sched, map);
2766 return copy_access(gen, sched, type, group, build, 0);
2769 /* Return code for reading into or writing from private memory
2770 * the given array reference group.
2772 * Let S be the first shared_len dimensions of the computed schedule,
2773 * D the iteration domains, A the array and L the schedule correponding
2774 * to the generated loops.
2775 * "sched" is of the form
2777 * type[S -> A] -> L
2779 * where type is either "read" or "write".
2780 * We apply the privatization D -> S(t), with t the thread ids,
2781 * to the access relation D -> A to obtain the privatized access relation
2783 * S(t) -> A
2785 * We drop the type from "sched" and intersect with the privatized access
2786 * relation to obtain
2788 * [S(t) -> A] -> L
2790 static __isl_give isl_ast_node *copy_group_private_accesses(
2791 struct gpu_gen *gen, struct gpu_array_ref_group *group,
2792 __isl_take isl_map *sched, __isl_take isl_ast_build *build)
2794 const char *type;
2795 int read;
2796 isl_union_map *priv;
2797 isl_union_map *access;
2798 isl_map *access_map;
2800 type = isl_map_get_tuple_name(sched, isl_dim_in);
2801 read = !strcmp(type, "read");
2803 priv = isl_union_map_from_map(isl_map_copy(gen->privatization));
2804 priv = isl_union_map_apply_range(isl_union_map_copy(gen->shared_sched),
2805 priv);
2807 access = gpu_array_ref_group_access_relation(group, read, !read);
2808 access = isl_union_map_apply_domain(access, priv);
2809 access_map = isl_map_from_union_map(access);
2811 sched = isl_map_reset_tuple_id(sched, isl_dim_in);
2812 sched = isl_map_intersect_domain(sched, isl_map_wrap(access_map));
2814 return copy_access(gen, sched, type, group, build, 1);
2817 /* Return code for reading into or writing from shared or private memory.
2819 * "schedule" is of the form
2821 * type[S -> A] -> L
2823 * with S be the first shared_len dimensions of the computed schedule,
2824 * A the array and L the schedule correponding to the generated loops.
2825 * The array reference group is attached to "type".
2827 static __isl_give isl_ast_node *create_access_leaf(
2828 struct gpu_gen *gen, __isl_take isl_map *schedule,
2829 __isl_take isl_ast_build *build)
2831 struct gpu_array_ref_group *group;
2832 isl_id *id;
2834 id = isl_map_get_tuple_id(schedule, isl_dim_in);
2835 group = isl_id_get_user(id);
2836 isl_id_free(id);
2838 if (group->private_tile)
2839 return copy_group_private_accesses(gen, group, schedule,
2840 build);
2841 else
2842 return copy_group_shared_accesses(gen, group, schedule,
2843 build);
2846 /* Create a domain node representing a synchronization.
2848 static __isl_give isl_ast_node *create_sync_leaf(
2849 struct gpu_gen *gen, __isl_take isl_map *schedule,
2850 __isl_take isl_ast_build *build)
2852 struct ppcg_kernel_stmt *stmt;
2853 isl_id *id;
2854 isl_space *space;
2855 isl_ast_node *node;
2856 isl_ast_expr *expr;
2858 isl_map_free(schedule);
2860 stmt = isl_calloc_type(gen->ctx, struct ppcg_kernel_stmt);
2861 if (!stmt)
2862 return NULL;
2864 stmt->type = ppcg_kernel_sync;
2866 space = isl_ast_build_get_schedule_space(build);
2867 space = isl_space_from_domain(space);
2868 space = isl_space_set_tuple_name(space, isl_dim_out, "sync");
2869 expr = isl_ast_build_call_from_pw_multi_aff(build,
2870 isl_pw_multi_aff_from_multi_aff(isl_multi_aff_zero(space)));
2871 node = isl_ast_node_alloc_user(expr);
2872 isl_ast_build_free(build);
2874 id = isl_id_alloc(gen->ctx, NULL, stmt);
2875 id = isl_id_set_free_user(id, &ppcg_kernel_stmt_free);
2876 return isl_ast_node_set_annotation(node, id);
2879 /* This function is called during the code generation at the point
2880 * where the schedule domain element is completely determined by
2881 * the generated code. The input schedule contains the original
2882 * statements as well as synchronization and copy "statements".
2883 * The latter are scheduled at different points than any of the original
2884 * statements, so they will only arrive here in isolation.
2886 * If the current schedule only refers to a single statement,
2887 * we check if it is a copy or synchronization statement and
2888 * call the appropriate functions.
2889 * Otherwise, we assume we are dealing with the original statements
2890 * and we call create_domain_leaf.
2892 static __isl_give isl_ast_node *create_kernel_leaf(
2893 __isl_take isl_ast_build *build, void *user)
2895 struct gpu_gen *gen = (struct gpu_gen *) user;
2896 isl_map *map;
2897 isl_union_map *schedule;
2898 const char *name;
2900 schedule = isl_ast_build_get_schedule(build);
2902 if (isl_union_map_n_map(schedule) != 1)
2903 return create_domain_leaf(schedule, build, user);
2905 map = isl_map_from_union_map(schedule);
2906 name = isl_map_get_tuple_name(map, isl_dim_in);
2907 if (!strcmp(name, "read") || !strcmp(name, "write"))
2908 return create_access_leaf(gen, map, build);
2909 if (!strcmp(name, "sync"))
2910 return create_sync_leaf(gen, map, build);
2912 return create_domain_leaf(isl_union_map_from_map(map), build, user);
2915 /* Mark all odd schedule dimensions as "atomic" (when the even dimensions
2916 * have value 0) and all even schedule dimensions as "unroll".
2918 * That is, the options look as follows
2920 * { [0, b, 0, d, ..., 0] -> atomic[i] : exists a : i = 2 a + 1;
2921 * [a, b, c, d, ..., z] -> unroll[i] : exists a : i = 2 a }
2923 * The even positions are used to be able to schedule copying blocks
2924 * and synchronization before or after each level of the shared memory
2925 * tile loops and we want to make sure that code for these is generated
2926 * separately (within each level).
2928 static __isl_give isl_ast_build *set_atomic_and_unroll(
2929 __isl_take isl_ast_build *build,
2930 __isl_take isl_space *space, int sched_len)
2932 isl_ctx *ctx;
2933 isl_map *map;
2934 isl_constraint *c;
2935 isl_union_map *opt;
2936 isl_local_space *ls;
2937 int i, n;
2939 ctx = isl_ast_build_get_ctx(build);
2941 space = isl_space_params(space);
2942 space = isl_space_add_dims(space, isl_dim_set, sched_len);
2943 space = isl_space_from_domain(space);
2944 space = isl_space_add_dims(space, isl_dim_out, 2);
2945 map = isl_map_universe(isl_space_copy(space));
2946 for (i = 0; i < sched_len; i += 2)
2947 map = isl_map_fix_si(map, isl_dim_in, i, 0);
2948 ls = isl_local_space_from_space(isl_map_get_space(map));
2949 c = isl_equality_alloc(ls);
2950 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, 1);
2951 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 1, 2);
2952 c = isl_constraint_set_constant_si(c, 1);
2953 map = isl_map_add_constraint(map, c);
2954 map = isl_map_project_out(map, isl_dim_out, 1, 1);
2955 map = isl_map_set_tuple_name(map, isl_dim_out, "atomic");
2956 opt = isl_union_map_from_map(map);
2958 map = isl_map_universe(space);
2959 ls = isl_local_space_from_space(isl_map_get_space(map));
2960 c = isl_equality_alloc(ls);
2961 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, 1);
2962 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 1, 2);
2963 map = isl_map_add_constraint(map, c);
2964 map = isl_map_project_out(map, isl_dim_out, 1, 1);
2965 map = isl_map_set_tuple_name(map, isl_dim_out, "unroll");
2966 opt = isl_union_map_add_map(opt, map);
2968 build = isl_ast_build_set_options(build, opt);
2970 return build;
2973 /* Return a map that maps a space of dimension gen->shared_len
2974 * to its last dimensions starting at gen->tile_first.
2975 * The range is of dimension
2977 * 2 * (gen->shared_len - gen->tile_first) + 1
2979 * The input dimensions are mapped to the odd dimensions in the output,
2980 * while the even dimensions (except 2*pos) are fixed to 0.
2981 * Output dimension 2*pos (if pos >= 0) is fixed to "val".
2982 * If pos >= 0, then only the pos first dimensions starting at gen->tile_first
2983 * are mapped to the output. The remaining input dimensions are projected
2984 * out and the corresponding output dimensions are fixed to 0.
2986 static __isl_give isl_map *insert_even(struct gpu_gen *gen,
2987 __isl_take isl_space *space, int pos, int val)
2989 int i, n;
2990 isl_map *proj;
2992 space = isl_space_set_from_params(space);
2993 space = isl_space_add_dims(space, isl_dim_set, gen->shared_len);
2994 space = isl_space_map_from_set(space);
2995 proj = isl_map_identity(space);
2996 proj = isl_map_project_out(proj, isl_dim_out, 0, gen->tile_first);
2997 n = gen->shared_len - gen->tile_first;
2998 for (i = 0; i <= n; ++i) {
2999 proj = isl_map_insert_dims(proj, isl_dim_out, 2 * i, 1);
3000 if (i == pos)
3001 proj = isl_map_fix_si(proj, isl_dim_out, 2 * i, val);
3002 else
3003 proj = isl_map_fix_si(proj, isl_dim_out, 2 * i, 0);
3006 if (pos < 0)
3007 return proj;
3009 proj = isl_map_eliminate(proj, isl_dim_in, gen->tile_first + pos,
3010 gen->shared_len - (gen->tile_first + pos));
3011 for (i = pos; i < n; ++i)
3012 proj = isl_map_fix_si(proj, isl_dim_out, 2 * i + 1, 0);
3014 return proj;
3017 /* Given the AST context schedule "schedule" and the mapping from
3018 * domains to the shared tile loops "shared_sched", add a schedule
3019 * for a synchronization operation at position "val" of loop level "pos".
3021 * schedule is of the form
3023 * D -> L
3025 * (with D the iteration domains and L the already generated loops),
3026 * while shared_sched is of the form
3028 * D -> S
3030 * We combine them into
3032 * L -> S
3034 * apply a mapping
3036 * [s_0,...] -> [0,s_{tile_first},0,..., val, 0, 0, ... 0]
3038 * and use the result as a schedule for "sync".
3040 static __isl_give isl_union_map *add_sync_schedule(struct gpu_gen *gen,
3041 __isl_take isl_union_map *res, __isl_keep isl_union_map *schedule,
3042 __isl_keep isl_union_map *shared_sched, int pos, int val)
3044 isl_space *space;
3045 isl_map *proj, *map;
3047 shared_sched = isl_union_map_copy(shared_sched);
3048 schedule = isl_union_map_copy(schedule);
3050 space = isl_union_map_get_space(shared_sched);
3051 schedule = isl_union_map_apply_domain(shared_sched, schedule);
3052 map = isl_map_from_union_map(schedule);
3054 proj = insert_even(gen, space, pos, val);
3055 map = isl_map_apply_range(map, proj);
3056 map = isl_map_from_range(isl_map_wrap(map));
3057 map = isl_map_set_tuple_name(map, isl_dim_in, "sync");
3059 res = isl_union_map_add_map(res, map);
3061 return res;
3064 /* Given a set of wrapped references "ref", return the corresponding
3065 * access relations based on the tagged access relations "tagged".
3067 * The elements of "ref" are of the form
3069 * [D -> R]
3071 * with D an iteration domains and R a reference.
3072 * The elements of "tagged" are of the form
3074 * [D -> R] -> A
3076 * with A an array.
3078 * Extend "tagged" to include the iteration domain in the range, i.e.,
3080 * [D -> R] -> [D -> A]
3082 * apply the result to "ref" and then unwrap the resulting set
3083 * to obtain relations of the form
3085 * D -> A
3087 static __isl_give isl_union_map *wrapped_reference_to_access(
3088 __isl_take isl_union_set *ref, __isl_take isl_union_map *tagged)
3090 isl_union_map *tag2access;
3092 tag2access = isl_union_map_copy(tagged);
3093 tag2access = isl_union_map_universe(tag2access);
3094 tag2access = isl_union_set_unwrap(isl_union_map_domain(tag2access));
3095 tag2access = isl_union_map_domain_map(tag2access);
3096 tag2access = isl_union_map_range_product(tag2access, tagged);
3098 ref = isl_union_set_coalesce(ref);
3099 ref = isl_union_set_apply(ref, tag2access);
3101 return isl_union_set_unwrap(ref);
3104 /* Given an access relation "access" from "group", remove those reads
3105 * if ("read" is 1) or writes (if "read" is 0) that are only needed to
3106 * communicate data within the same iteration of the last_shared dimension
3107 * of the group.
3109 * If the access is a read then it is either an element of
3111 * live_in union (range flow)
3113 * where live_in and flow may be overapproximations, or
3114 * it reads an uninitialized value (that is not live-in because
3115 * there is an intermediate kill) or it reads a value that was
3116 * written within the same (compound) statement instance.
3117 * If the access is a write then it is either an element of
3119 * live_out union (domain flow)
3121 * or it writes a value that is never read (and is not live-out
3122 * because of an intermediate kill) or only
3123 * within the same (compound) statement instance.
3124 * In both cases, the access relation is also a subset of
3125 * the group access relation.
3127 * The cases where an uninitialized value is read or a value is written
3128 * that is never read or where the dataflow occurs within a statement
3129 * instance are also considered local and may also be removed.
3131 * Essentially, we compute the intersection of "access" with either
3133 * live_in union (range non-local-flow)
3135 * or
3137 * live_out union (domain non-local-flow)
3139 * We first construct a relation "local"
3141 * [[D -> R] -> [D' -> R']]
3143 * of pairs of domain iterations accessing the reference group
3144 * and references in the group that are scheduled to the same iteration
3145 * of the last_shared dimension.
3147 * If this relation does not intersect the dataflow dependences,
3148 * then there is nothing we can possibly remove, unless the dataflow
3149 * dependences themselves only relate a subset of the accesses.
3150 * In particular, the accesses may not be involved in any dataflow
3151 * dependences, either because they are uninitialized reads/dead writes
3152 * or because the dataflow occurs inside a statement instance.
3154 * Since the computation below may break up the access relation
3155 * into smaller pieces, we only perform the intersection with
3156 * the non-local dependent accesses if the local pairs
3157 * intersect the dataflow dependences. Otherwise, we intersect
3158 * with the universe of the non-local dependent accesses.
3159 * This should at least remove accesses from statements that
3160 * do not participate in any dependences.
3162 * In particular, we remove the "local" dataflow dependences from
3163 * the set of all dataflow dependences.
3164 * Note that if the potential dataflow dependences are an overapproximation
3165 * of the actual dataflow dependences, then the result remains an
3166 * overapproximation of the non-local dataflow dependences.
3167 * Copying to/from global memory is only needed for the references
3168 * in the domain/range of the result or for accesses that are live out/in
3169 * for the entire scop.
3171 * We therefore map the domain/range of the "external" relation
3172 * to the corresponding access relation and take the union with
3173 * the live out/in relation.
3175 static __isl_give isl_union_map *remove_local_accesses(struct gpu_gen *gen,
3176 struct gpu_array_ref_group *group, __isl_take isl_union_map *access,
3177 int read)
3179 int empty;
3180 isl_union_pw_multi_aff *tagger;
3181 isl_union_set *domain;
3182 isl_space *space;
3183 isl_union_map *sched, *local, *tagged, *external;
3184 isl_union_set *tag_set;
3185 isl_map *proj;
3187 if (isl_union_map_is_empty(access))
3188 return access;
3190 tagged = group_tagged_access_relation(group);
3192 sched = isl_union_map_copy(gen->sched);
3194 space = isl_union_map_get_space(sched);
3195 proj = projection(space, gen->untiled_len, group->last_shared + 1);
3196 sched = isl_union_map_apply_range(sched, isl_union_map_from_map(proj));
3198 tagger = isl_union_pw_multi_aff_copy(gen->prog->scop->tagger);
3199 domain = isl_union_map_domain(isl_union_map_copy(tagged));
3200 tagger = isl_union_pw_multi_aff_intersect_domain(tagger, domain);
3201 sched = isl_union_map_preimage_domain_union_pw_multi_aff(sched, tagger);
3203 local = isl_union_map_apply_range(sched,
3204 isl_union_map_reverse(isl_union_map_copy(sched)));
3205 local = isl_union_map_intersect(local,
3206 isl_union_map_copy(gen->prog->scop->tagged_dep_flow));
3208 empty = isl_union_map_is_empty(local);
3210 external = isl_union_map_copy(gen->prog->scop->tagged_dep_flow);
3211 external = isl_union_map_intersect_params(external,
3212 isl_set_copy(gen->prog->scop->context));
3213 external = isl_union_map_subtract(external, local);
3215 if (read) {
3216 tag_set = isl_union_map_range(external);
3217 external = wrapped_reference_to_access(tag_set, tagged);
3218 external = isl_union_map_union(external,
3219 isl_union_map_copy(gen->prog->scop->live_in));
3220 } else {
3221 tag_set = isl_union_map_domain(external);
3222 external = wrapped_reference_to_access(tag_set, tagged);
3223 external = isl_union_map_union(external,
3224 isl_union_map_copy(gen->prog->scop->live_out));
3227 if (empty < 0)
3228 external = isl_union_map_free(external);
3229 else if (empty)
3230 external = isl_union_map_universe(external);
3232 access = isl_union_map_intersect(access, external);
3234 return access;
3237 /* Given the AST context schedule "schedule" and the mapping from
3238 * domains to the shared tile loops "shared_sched", add a schedule
3239 * for copying an array reference group to/from shared/private memory.
3240 * "read" is set if data should be copied from global memory
3241 * to shared/private memory.
3242 * "k" represents the current group
3243 * "s" is the total number of groups
3245 * We schedule an operation before or after the innermost loop
3246 * of "shared_sched" that affects the tile of the array reference group.
3248 * schedule is of the form
3250 * D -> L
3252 * (with D the iteration domains and L the already generated loops),
3253 * while shared_sched is of the form
3255 * D -> S
3257 * We first compute the access relation for the reference group
3259 * D -> A
3261 * and remove from this access relation those reads or writes
3262 * that only needed to communicate data within the same iteration
3263 * of the last_shared dimension of the group.
3264 * We then combine what is left with shared_sched into
3266 * D -> [S -> A]
3268 * If this results in an empty relation, no copying needs to be performed
3269 * at this point.
3270 * Otherwise, we invert the relation and combine it with "schedule" into
3272 * [S -> A] -> L
3274 * The actual additional piece of the schedule is obtained from combining
3276 * [S -> A] -> S
3278 * with a mapping
3280 * [s_0,...] -> [0,s_{tile_first},0,..., val, 0, 0, ... 0]
3282 * The position of "val" corresponds to the innermost loop that affects
3283 * the tile and the value indicates where the copying is scheduled
3284 * with respect to the actual kernel code (at value 0).
3285 * Reads are schedule before the code, writes to global memory from
3286 * private memory are scheduled at values 1 to s, writes to global
3287 * memory from shared memory are scheduled at values s + 2 to 2 * s + 1.
3289 * If we are scheduling a read from global memory to shared memory,
3290 * we insert a synchronization before the kernel code (at the innermost
3291 * level).
3292 * If we are scheduling a write to global memory, then we add
3293 * a synchronization after all writes (at value 2 *s + 2).
3294 * However, there is no need for a synchronization after the outermost loop.
3295 * A write to global memory from private memory at the innermost level
3296 * does not require a synchronization, because it is covered by
3297 * the synchronization after the kernel inserted by body_schedule.
3299 static __isl_give isl_union_map *add_group_schedule(struct gpu_gen *gen,
3300 __isl_take isl_union_map *res, __isl_keep isl_union_map *schedule,
3301 __isl_keep isl_union_map *shared_sched,
3302 struct gpu_array_ref_group *group, int read, int k, int s)
3304 int n;
3305 int pos, val;
3306 isl_space *space;
3307 isl_union_map *access;
3308 isl_map *map, *proj, *access_map;
3309 isl_id *id;
3311 access = gpu_array_ref_group_access_relation(group, read, !read);
3312 access = remove_local_accesses(gen, group, access, read);
3313 access = isl_union_map_range_product(isl_union_map_copy(shared_sched),
3314 access);
3316 if (isl_union_map_is_empty(access)) {
3317 isl_union_map_free(access);
3318 return res;
3321 access = isl_union_map_reverse(access);
3322 access = isl_union_map_apply_range(access,
3323 isl_union_map_copy(schedule));
3324 access_map = isl_map_from_union_map(access);
3326 space = isl_space_copy(group->array->space);
3327 space = isl_space_from_range(space);
3328 space = isl_space_add_dims(space, isl_dim_in, gen->shared_len);
3329 map = isl_map_domain_map(isl_map_universe(space));
3331 space = isl_union_map_get_space(schedule);
3332 pos = group->last_shared + 1 - gen->tile_first;
3333 assert(pos >= 0);
3334 if (read)
3335 val = -2 - k;
3336 else if (group->private_tile)
3337 val = 1 + k;
3338 else
3339 val = 1 + s + 1 + k;
3340 proj = insert_even(gen, space, pos, val);
3341 map = isl_map_apply_range(map, proj);
3343 access_map = isl_map_range_product(access_map, map);
3345 id = isl_id_alloc(gen->ctx, read ? "read" : "write", group);
3346 access_map = isl_map_set_tuple_id(access_map, isl_dim_in, id);
3348 res = isl_union_map_add_map(res, access_map);
3350 n = gen->shared_len - gen->tile_first;
3351 if (read) {
3352 if (!group->private_tile)
3353 res = add_sync_schedule(gen, res, schedule,
3354 shared_sched, n, -1);
3355 } else {
3356 if (pos == 0)
3357 return res;
3358 if (pos == n && group->private_tile)
3359 return res;
3360 res = add_sync_schedule(gen, res, schedule, shared_sched,
3361 pos, 2 * s + 2);
3364 return res;
3367 /* Return a schedule for the shared tile loops based on the current
3368 * AST context schedule.
3370 * We create a "shared_sched" that maps the domains to the first
3371 * shared_len dimensions of the computed schedule, project out the
3372 * first tile_first dimensions (as these are already covered by
3373 * the host code) and insert "statement-level" dimensions at even
3374 * positions so that we can schedule copy blocks and synchronization
3375 * before/after each level.
3377 * In particular, copy blocks are inserted inside the innermost
3378 * level that affect the tile. For the copying to global memory,
3379 * those from private memory are scheduled before those from shared
3380 * memory such that synchronization can be inserted between the two
3381 * at the innermost level.
3382 * Synchronization is inserted at the innermost level before the
3383 * actual kernel code if there is any copying from global memory
3384 * to shared memory. It is inserted unconditionally at the innermost
3385 * level after the actual kernel code and the copying to global memory
3386 * from private memory (if any). Finally, it is inserted after
3387 * any copying to global memory, except at the outermost level
3388 * and at the innermost level if there is no copying from shared
3389 * memory. The copying from private memory is covered by the unconditional
3390 * synchronization at the innermost level.
3392 static __isl_give isl_union_map *body_schedule(struct gpu_gen *gen,
3393 __isl_take isl_union_map *schedule)
3395 isl_space *space;
3396 isl_union_map *res;
3397 isl_union_map *shared_sched;
3398 isl_union_map *sched;
3399 isl_map *proj, *map;
3400 int i, j, k, s;
3402 shared_sched = isl_union_map_copy(gen->tiled_sched);
3403 proj = projection(isl_union_map_get_space(shared_sched),
3404 gen->tiled_len, gen->shared_len);
3405 shared_sched = isl_union_map_apply_range(shared_sched,
3406 isl_union_map_from_map(proj));
3407 space = isl_union_map_get_space(shared_sched);
3408 proj = insert_even(gen, space, -1, 0);
3409 sched = isl_union_map_apply_range(isl_union_map_copy(shared_sched),
3410 isl_union_map_from_map(proj));
3412 res = isl_union_map_range_product(isl_union_map_copy(schedule), sched);
3414 s = 0;
3415 for (i = 0; i < gen->kernel->n_array; ++i)
3416 s += gen->kernel->array[i].n_group;
3418 k = 0;
3419 for (i = 0; i < gen->kernel->n_array; ++i) {
3420 struct gpu_local_array_info *array = &gen->kernel->array[i];
3422 for (j = 0; j < array->n_group; ++j) {
3423 struct gpu_array_ref_group *group;
3425 group = array->groups[j];
3426 if (!group->private_tile && !group->shared_tile)
3427 continue;
3428 res = add_group_schedule(gen, res, schedule,
3429 shared_sched, group, 0, k, s);
3430 res = add_group_schedule(gen, res, schedule,
3431 shared_sched, group, 1, k, s);
3432 ++k;
3436 res = add_sync_schedule(gen, res, schedule, shared_sched,
3437 gen->shared_len - gen->tile_first, 1 + s);
3439 isl_union_map_free(shared_sched);
3440 isl_union_map_free(schedule);
3442 return res;
3445 /* Generate code for "kernel" in the given "context".
3447 * We first generate code for the shared tile loops (T1T, T1P and T2)
3448 * in a context that includes the block ids.
3449 * Within each iteration of these loops an additional code generation
3450 * is performed (within create_kernel_leaf) for the rest of the schedule
3451 * in a context that includes the thread ids.
3453 static __isl_give isl_ast_node *generate_kernel(struct gpu_gen *gen,
3454 __isl_keep isl_ast_build *build, __isl_keep isl_set *host_domain,
3455 __isl_keep isl_multi_pw_aff *grid_size)
3457 isl_space *space;
3458 isl_set *set;
3459 isl_id_list *iterators;
3460 isl_union_map *schedule;
3461 isl_ast_node *tree;
3462 int sched_len;
3464 schedule = isl_ast_build_get_schedule(build);
3466 build = isl_ast_build_copy(build);
3467 build = isl_ast_build_restrict(build, isl_set_copy(host_domain));
3468 space = isl_ast_build_get_schedule_space(build);
3469 set = isl_set_universe(isl_space_copy(space));
3470 set = add_bounded_parameters_dynamic(set, grid_size,
3471 gen->kernel->block_ids);
3472 build = isl_ast_build_restrict(build, set);
3474 schedule = body_schedule(gen, schedule);
3476 sched_len = 2 * (gen->shared_len - gen->tile_first) + 1;
3478 build = set_atomic_and_unroll(build, space, sched_len);
3479 iterators = ppcg_scop_generate_names(gen->prog->scop, sched_len, "g");
3480 build = isl_ast_build_set_iterators(build, iterators);
3481 build = isl_ast_build_set_create_leaf(build, &create_kernel_leaf, gen);
3482 tree = isl_ast_build_node_from_schedule_map(build, schedule);
3483 isl_ast_build_free(build);
3485 return tree;
3488 /* Attach "id" to the given node.
3490 static __isl_give isl_ast_node *attach_id(__isl_take isl_ast_node *node,
3491 __isl_keep isl_ast_build *build, void *user)
3493 isl_id *id = user;
3495 node = isl_ast_node_set_annotation(node, id);
3497 return node;
3500 /* Construct an AST node for performing a kernel launch and attach
3501 * the information about the kernel to that node.
3502 * "kernel_id" has name "kernel" and contains a pointer
3503 * to the ppcg_kernel structure.
3505 * The kernel AST has been constructed in the context of the range
3506 * of "schedule". In particular, the grid size has been computed
3507 * in the context. We therefore still need to make sure that these
3508 * constraints are expressed in the code. We do this by creating a schedule
3510 * kernel[] -> [S -> []]
3512 * where S is the schedule domain, i.e., the range of "schedule".
3513 * The AST generation will then create a single call surrounded by
3514 * all the condition in "S" that have not been expressed yet.
3516 * The kernel information is attached to this node in attach_id.
3518 static __isl_give isl_ast_node *construct_launch(
3519 __isl_take isl_ast_build *build, __isl_take isl_union_map *schedule,
3520 __isl_take isl_id *kernel_id)
3522 isl_ctx *ctx;
3523 isl_union_set *domain;
3524 isl_set *set;
3525 isl_map *map;
3526 isl_ast_node *node;
3528 ctx = isl_ast_build_get_ctx(build);
3530 domain = isl_union_map_range(schedule);
3531 set = isl_set_from_union_set(domain);
3532 map = isl_map_from_domain(set);
3533 map = isl_map_from_range(isl_map_wrap(map));
3534 map = isl_map_set_tuple_name(map, isl_dim_in, "kernel");
3535 schedule = isl_union_map_from_map(map);
3537 build = isl_ast_build_set_at_each_domain(build, &attach_id, kernel_id);
3538 node = isl_ast_build_node_from_schedule_map(build, schedule);
3539 isl_ast_build_free(build);
3541 return node;
3544 /* This function is called for each leaf in the AST of the host code.
3545 * We first specialize the schedule to the site of the leaf, compute
3546 * the size of shared memory and then construct the body of the host code
3547 * and the associated kernel.
3549 * The necessary information for printing the kernel launch is
3550 * stored in the struct ppcg_kernel that was created in create_kernel and
3551 * attached to an outer mark node in the schedule tree.
3552 * Note that this assumes that a kernel is only launched once.
3553 * The kernel pointer itself is stored in gen->kernel by before_mark,
3554 * while the isl_id containing this pointer is stored in gen->kernel_mark.
3555 * The latter is attached to the leaf AST node created to represent the launch.
3557 static __isl_give isl_ast_node *create_host_leaf(
3558 __isl_take isl_ast_build *build, void *user)
3560 struct gpu_gen *gen = (struct gpu_gen *) user;
3561 isl_id *id;
3562 isl_ast_node *node;
3563 struct ppcg_kernel *kernel;
3564 isl_set *host_domain;
3565 isl_union_map *schedule;
3566 isl_union_map *local_sched;
3567 isl_union_set *domain;
3568 int i;
3570 schedule = isl_ast_build_get_schedule(build);
3572 kernel = gen->kernel;
3573 if (!kernel)
3574 goto error;
3576 domain = isl_union_map_domain(isl_union_map_copy(schedule));
3578 local_sched = isl_union_map_copy(gen->sched);
3579 local_sched = isl_union_map_intersect_domain(local_sched, domain);
3581 gen->tiled_sched = tile_schedule(gen, local_sched);
3582 gen->tiled_sched = parametrize_tiled_schedule(gen, gen->tiled_sched);
3583 gen->tiled_sched = scale_tile_loops(gen, gen->tiled_sched);
3585 gen->local_sched = isl_union_map_copy(gen->tiled_sched);
3586 gen->local_sched = thread_tile_schedule(gen, gen->local_sched);
3587 gen->local_sched = scale_thread_tile_loops(gen, gen->local_sched);
3589 kernel->space = isl_ast_build_get_schedule_space(build);
3591 compute_shared_sched(gen);
3592 gen->privatization = compute_privatization(gen);
3593 if (gpu_group_references(gen) < 0)
3594 schedule = isl_union_map_free(schedule);
3595 host_domain = isl_set_from_union_set(isl_union_map_range(
3596 isl_union_map_copy(schedule)));
3597 localize_bounds(kernel, host_domain);
3599 gen->local_sched = interchange_for_unroll(gen, gen->local_sched);
3600 check_shared_memory_bound(gen->kernel);
3601 compute_group_tilings(gen->kernel);
3603 kernel->tree = generate_kernel(gen, build, host_domain,
3604 kernel->grid_size);
3605 create_kernel_vars(kernel);
3607 isl_map_free(gen->privatization);
3608 isl_union_map_free(gen->local_sched);
3609 isl_union_map_free(gen->tiled_sched);
3610 isl_union_map_free(gen->shared_sched);
3611 isl_union_map_free(gen->shared_proj);
3612 isl_set_free(host_domain);
3614 node = construct_launch(build, schedule, isl_id_copy(gen->kernel_mark));
3616 return node;
3617 error:
3618 isl_union_map_free(schedule);
3619 return NULL;
3622 /* This function is called before the AST generator starts traversing
3623 * the schedule subtree of a node with mark "mark".
3625 * If the mark is called "kernel", store the mark itself in gen->kernel_mark
3626 * and the kernel pointer in gen->kernel for use in create_host_leaf.
3628 static int before_mark(__isl_keep isl_id *mark,
3629 __isl_keep isl_ast_build *build, void *user)
3631 struct gpu_gen *gen = user;
3633 if (!mark)
3634 return -1;
3635 if (!strcmp(isl_id_get_name(mark), "kernel")) {
3636 gen->kernel_mark = isl_id_copy(mark);
3637 gen->kernel = isl_id_get_user(mark);
3639 return 0;
3642 /* This function is called after the AST generator has finished traversing
3643 * the schedule subtree of a mark node. "node" points to the corresponding
3644 * mark AST node.
3646 * If the mark is called "kernel", then clear kernel and gen->kernel_mark.
3648 static __isl_give isl_ast_node *after_mark(__isl_take isl_ast_node *node,
3649 __isl_keep isl_ast_build *build, void *user)
3651 struct gpu_gen *gen = user;
3652 isl_id *id;
3654 id = isl_ast_node_mark_get_id(node);
3655 if (!id)
3656 return isl_ast_node_free(node);
3657 if (!strcmp(isl_id_get_name(id), "kernel") && gen->kernel) {
3658 gen->kernel_mark = isl_id_free(gen->kernel_mark);
3659 gen->kernel = NULL;
3662 isl_id_free(id);
3663 return node;
3666 /* Use isl to generate host code from gen->host_schedule, which corresponds to
3667 * the outer gen->tile_first loops of the global schedule in gen->sched.
3668 * Within each iteration of this partial schedule, i.e., for each kernel
3669 * launch, create_host_leaf takes care of generating the kernel code.
3670 * The ppcg_kernel objects are stored in mark nodes in the schedule
3671 * tree and are extracted in before_mark.
3673 static __isl_give isl_ast_node *generate_host_code(struct gpu_gen *gen)
3675 isl_ast_build *build;
3676 isl_ast_node *tree;
3677 isl_schedule *schedule;
3678 isl_id_list *iterators;
3680 isl_options_set_ast_build_group_coscheduled(gen->ctx, 1);
3681 build = isl_ast_build_from_context(isl_set_copy(gen->prog->context));
3682 iterators = ppcg_scop_generate_names(gen->prog->scop,
3683 gen->tile_first, "h");
3684 build = isl_ast_build_set_iterators(build, iterators);
3685 build = isl_ast_build_set_create_leaf(build, &create_host_leaf, gen);
3686 build = isl_ast_build_set_before_each_mark(build, &before_mark, gen);
3687 build = isl_ast_build_set_after_each_mark(build, &after_mark, gen);
3688 schedule = isl_schedule_copy(gen->host_schedule);
3689 tree = isl_ast_build_node_from_schedule(build, schedule);
3690 isl_ast_build_free(build);
3692 return tree;
3695 __isl_give isl_union_map *extract_sizes_from_str(isl_ctx *ctx, const char *str)
3697 if (!str)
3698 return NULL;
3699 return isl_union_map_read_from_str(ctx, str);
3702 /* Information about the outermost tilable bands in the forest of bands.
3704 * prefix is the (padded) schedule leading up to the outermost tilable bands.
3706 * tile_first is the number of schedule dimensions in prefix.
3708 * suffix is the schedule of the outermost tilable bands and their descendants.
3710 struct band_info {
3711 struct gpu_gen *gen;
3712 int tile_first;
3713 isl_union_map *prefix;
3714 isl_union_map *suffix;
3717 /* Construct an isl_multi_val for use as tile sizes for tiling "node"
3718 * from the elements in "tile_size".
3720 static __isl_give isl_multi_val *construct_band_tiles_sizes(
3721 __isl_keep isl_schedule_node *node, int *tile_size)
3723 int i, n;
3724 isl_ctx *ctx;
3725 isl_space *space;
3726 isl_multi_val *mv;
3728 if (!node)
3729 return NULL;
3731 ctx = isl_schedule_node_get_ctx(node);
3732 space = isl_schedule_node_band_get_space(node);
3733 n = isl_schedule_node_band_n_member(node);
3734 mv = isl_multi_val_zero(space);
3735 for (i = 0; i < n; ++i) {
3736 isl_val *v;
3738 v = isl_val_int_from_si(ctx, tile_size[i]);
3739 mv = isl_multi_val_set_val(mv, i, v);
3742 return mv;
3745 /* Replace the partial schedule S of the band node "node" by
3747 * floor(S/f)
3749 * or
3751 * f * floor(S/f)
3753 * if scale_tile_loops is set, with f the integers in "factor".
3754 * The list that "factor" points to is assumed to contain at least
3755 * as many elements as the number of members in the band.
3757 static __isl_give isl_schedule_node *snap_band_to_sizes(
3758 __isl_take isl_schedule_node *node, int *factor,
3759 struct ppcg_options *options)
3761 isl_multi_val *mv;
3763 mv = construct_band_tiles_sizes(node, factor);
3764 node = isl_schedule_node_band_scale_down(node, isl_multi_val_copy(mv));
3765 if (options->scale_tile_loops)
3766 node = isl_schedule_node_band_scale(node,
3767 isl_multi_val_copy(mv));
3768 isl_multi_val_free(mv);
3770 return node;
3773 /* Tile "band" with tile size specified by "sizes".
3775 * Since the tile loops will be mapped to block ids, we forcibly
3776 * turn off tile loop scaling. We may want to enable tile loop scaling
3777 * at some later point, but then we would have to support the detection
3778 * of strides during the mapping to block ids.
3779 * Similarly, since the point loops will be mapped to thread ids,
3780 * we forcibly shift the point loops so that they start at zero.
3782 static __isl_give isl_schedule_node *tile_band(
3783 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *sizes)
3785 isl_ctx *ctx = isl_schedule_node_get_ctx(node);
3786 int scale_tile;
3787 int shift_point;
3789 scale_tile = isl_options_get_tile_scale_tile_loops(ctx);
3790 isl_options_set_tile_scale_tile_loops(ctx, 0);
3791 shift_point = isl_options_get_tile_shift_point_loops(ctx);
3792 isl_options_set_tile_shift_point_loops(ctx, 1);
3794 node = isl_schedule_node_band_tile(node, sizes);
3796 isl_options_set_tile_scale_tile_loops(ctx, scale_tile);
3797 isl_options_set_tile_shift_point_loops(ctx, shift_point);
3799 return node;
3802 /* Extract the set of parameter values and outer schedule dimensions
3803 * for which any statement instance
3804 * in the kernel inserted at "node" needs to be executed.
3805 * Intersect the set of parameter values derived from the host schedule
3806 * relation with the context of "prog".
3808 static __isl_give isl_set *extract_context(__isl_keep isl_schedule_node *node,
3809 struct gpu_prog *prog)
3811 isl_union_map *schedule;
3812 isl_union_set *schedule_domain;
3813 isl_set *context;
3814 int empty;
3816 schedule = isl_schedule_node_get_prefix_schedule_relation(node);
3817 schedule_domain = isl_union_map_range(schedule);
3818 empty = isl_union_set_is_empty(schedule_domain);
3819 if (empty < 0) {
3820 isl_union_set_free(schedule_domain);
3821 return NULL;
3823 if (empty) {
3824 int depth;
3825 isl_space *space;
3827 space = isl_union_set_get_space(schedule_domain);
3828 isl_union_set_free(schedule_domain);
3829 space = isl_space_set_from_params(space);
3830 depth = isl_schedule_node_get_schedule_depth(node);
3831 space = isl_space_add_dims(space, isl_dim_set, depth);
3832 context = isl_set_empty(space);
3833 } else {
3834 context = isl_set_from_union_set(schedule_domain);
3836 context = isl_set_intersect_params(context,
3837 isl_set_copy(prog->context));
3839 return context;
3842 /* Return the set of outer array elements accessed by
3843 * by the statement instance in "domain" in "prog".
3845 static __isl_give isl_union_set *accessed_by_domain(
3846 __isl_take isl_union_set *domain, struct gpu_prog *prog)
3848 isl_union_map *access;
3849 isl_union_set *arrays;
3851 access = isl_union_map_union(isl_union_map_copy(prog->read),
3852 isl_union_map_copy(prog->may_write));
3853 access = isl_union_map_intersect_domain(access, domain);
3854 arrays = isl_union_map_range(access);
3855 arrays = isl_union_set_apply(arrays,
3856 isl_union_map_copy(prog->to_outer));
3858 return arrays;
3861 /* Return the number of outer band members of the band node "node"
3862 * that are marked coincident.
3864 static int n_outer_coincidence(__isl_keep isl_schedule_node *node)
3866 int i, n;
3868 n = isl_schedule_node_band_n_member(node);
3870 for (i = 0; i < n; ++i)
3871 if (!isl_schedule_node_band_member_get_coincident(node, i))
3872 break;
3874 return i;
3877 /* If the band node "node" has more than "n" members, then split off
3878 * the first "n" of them.
3880 static __isl_give isl_schedule_node *split_band(
3881 __isl_take isl_schedule_node *node, int n)
3883 int dim;
3885 dim = isl_schedule_node_band_n_member(node);
3886 if (n < dim)
3887 node = isl_schedule_node_band_split(node, n);
3889 return node;
3892 /* Scale a band node that may have been split by split_band.
3893 * "sizes" are the scaling factors for the original node.
3894 * "node" either points to the original band node, or the outer
3895 * of the two pieces after splitting.
3897 * If the number of elements in "node" is smaller than the number of
3898 * elements in "sizes", then some splitting has occurred and we split
3899 * "sizes" in the same way.
3901 static __isl_give isl_schedule_node *scale_band(
3902 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *sizes)
3904 int n, dim;
3906 n = isl_multi_val_dim(sizes, isl_dim_set);
3907 dim = isl_schedule_node_band_n_member(node);
3908 if (n > dim) {
3909 isl_multi_val *sizes2;
3911 sizes2 = isl_multi_val_copy(sizes);
3912 sizes = isl_multi_val_drop_dims(sizes,
3913 isl_dim_set, dim, n - dim);
3914 sizes2 = isl_multi_val_drop_dims(sizes2, isl_dim_set, 0, dim);
3915 node = isl_schedule_node_child(node, 0);
3916 node = isl_schedule_node_band_scale(node, sizes2);
3917 node = isl_schedule_node_parent(node);
3920 return isl_schedule_node_band_scale(node, sizes);
3923 /* Return an isl_multi_aff, with as elements the parameters in "space"
3924 * that have the names specified by the elements in "names".
3925 * If (some of) these parameters do not already appear in "space",
3926 * then they are added first.
3928 static __isl_give isl_multi_aff *parameter_vector(__isl_take isl_space *space,
3929 __isl_keep isl_id_list *names)
3931 int i, n;
3932 isl_local_space *ls;
3933 isl_multi_aff *ma;
3935 if (!names)
3936 space = isl_space_free(space);
3938 n = isl_id_list_n_id(names);
3939 for (i = 0; i < n; ++i) {
3940 int pos;
3941 isl_id *id;
3943 id = isl_id_list_get_id(names, i);
3944 pos = isl_space_find_dim_by_id(space, isl_dim_param, id);
3945 if (pos >= 0) {
3946 isl_id_free(id);
3947 continue;
3949 pos = isl_space_dim(space, isl_dim_param);
3950 space = isl_space_add_dims(space, isl_dim_param, 1);
3951 space = isl_space_set_dim_id(space, isl_dim_param, pos, id);
3953 ma = isl_multi_aff_zero(isl_space_copy(space));
3954 ls = isl_local_space_from_space(isl_space_domain(space));
3955 for (i = 0; i < n; ++i) {
3956 int pos;
3957 isl_id *id;
3958 isl_aff *aff;
3960 id = isl_id_list_get_id(names, i);
3961 pos = isl_space_find_dim_by_id(space, isl_dim_param, id);
3962 isl_id_free(id);
3963 aff = isl_aff_var_on_domain(isl_local_space_copy(ls),
3964 isl_dim_param, pos);
3965 ma = isl_multi_aff_set_aff(ma, i, aff);
3967 isl_local_space_free(ls);
3969 return ma;
3972 /* Return constraints on the domain elements that equate a sequence of
3973 * parameters called "names", to the partial schedule
3974 * of "node" modulo the integers in "size".
3975 * The number of elements in the array "size" should be equal
3976 * to the number of members of the band node "node" and
3977 * to the number of elements in "names".
3979 static __isl_give isl_union_set *set_schedule_modulo(
3980 __isl_keep isl_schedule_node *node, __isl_keep isl_id_list *names,
3981 int *size)
3983 isl_space *space;
3984 isl_multi_aff *ma;
3985 isl_multi_union_pw_aff *mupa, *mupa2;
3986 isl_multi_val *mv;
3987 isl_union_set *domain;
3989 if (!node)
3990 return NULL;
3991 if (isl_schedule_node_band_n_member(node) == 0)
3992 return isl_schedule_node_get_universe_domain(node);
3994 mupa = isl_schedule_node_band_get_partial_schedule(node);
3995 mv = construct_band_tiles_sizes(node, size);
3996 mupa = isl_multi_union_pw_aff_mod_multi_val(mupa, mv);
3998 space = isl_multi_union_pw_aff_get_space(mupa);
3999 ma = parameter_vector(space, names);
4001 domain = isl_schedule_node_get_universe_domain(node);
4003 mupa2 = isl_multi_union_pw_aff_multi_aff_on_domain(domain, ma);
4004 mupa = isl_multi_union_pw_aff_sub(mupa, mupa2);
4006 return isl_multi_union_pw_aff_zero_union_set(mupa);
4009 /* Insert a context node at "node" introducing the block and thread
4010 * identifiers along with their bounds, which are stored in kernel->grid_size
4011 * and kernel->block_dim.
4012 * Note that the bounds on the block identifiers may implicitly impose
4013 * constraints on the parameters. A guard needs to be inserted
4014 * in the schedule tree to ensure that those bounds hold at "node".
4015 * This guard is inserted in insert_guard.
4017 static __isl_give isl_schedule_node *insert_context(struct ppcg_kernel *kernel,
4018 __isl_take isl_schedule_node *node)
4020 isl_set *context;
4022 context = isl_set_universe(isl_set_get_space(kernel->context));
4024 context = add_bounded_parameters_dynamic(context,
4025 kernel->grid_size, kernel->block_ids);
4026 context = add_bounded_parameters(context,
4027 kernel->block_dim, kernel->thread_ids);
4029 node = isl_schedule_node_insert_context(node, context);
4031 return node;
4034 /* Insert a guard that eliminates kernel launches where the kernel
4035 * obviously does not have any work to do.
4037 * In particular, eliminate kernel launches where there are obviously
4038 * zero blocks.
4039 * Use the same block size constraints that are used to create the context
4040 * to ensure that all constraints implicit in the constructed context
4041 * are imposed by the guard.
4043 * Additionally, add other constraints that are valid
4044 * for each executed instance ("context"), as long as this does not result
4045 * in a disjunction.
4047 static __isl_give isl_schedule_node *insert_guard(
4048 __isl_take isl_schedule_node *node, __isl_keep isl_set *context,
4049 __isl_keep isl_multi_pw_aff *size, struct ppcg_scop *scop)
4051 unsigned nparam, n;
4052 isl_set *guard;
4053 isl_id_list *ids;
4055 guard = isl_set_copy(context);
4056 guard = isl_set_compute_divs(guard);
4057 guard = isl_set_from_basic_set(isl_set_simple_hull(guard));
4059 nparam = isl_set_dim(guard, isl_dim_param);
4060 n = isl_multi_pw_aff_dim(size, isl_dim_out);
4061 ids = ppcg_scop_generate_names(scop, n, "__ppcg_tmp");
4062 guard = add_bounded_parameters_dynamic(guard, size, ids);
4063 isl_id_list_free(ids);
4064 guard = isl_set_project_out(guard, isl_dim_param, nparam, n);
4066 node = isl_schedule_node_insert_guard(node, guard);
4068 return node;
4071 /* Mark all dimensions in the current band node atomic.
4073 static __isl_give isl_schedule_node *atomic(__isl_take isl_schedule_node *node)
4075 int i, n;
4077 n = isl_schedule_node_band_n_member(node);
4078 for (i = 0; i < n; ++i)
4079 node = isl_schedule_node_band_member_set_ast_loop_type(node, i,
4080 isl_ast_loop_atomic);
4082 return node;
4085 /* Mark "node" atomic, if it is a band node.
4086 * Do the same for all ancestors.
4087 * Return a pointer to "node" (in the updated schedule tree).
4089 static __isl_give isl_schedule_node *atomic_ancestors(
4090 __isl_take isl_schedule_node *node)
4092 int pos;
4094 if (!node)
4095 return NULL;
4096 if (!isl_schedule_node_has_parent(node))
4097 return node;
4099 pos = isl_schedule_node_get_child_position(node);
4100 node = isl_schedule_node_parent(node);
4101 if (isl_schedule_node_get_type(node) == isl_schedule_node_band)
4102 node = atomic(node);
4103 node = atomic_ancestors(node);
4104 node = isl_schedule_node_child(node, pos);
4106 return node;
4109 /* Group the domain elements into a single space, named kernelX,
4110 * with X the kernel sequence number "kernel_id".
4112 static __isl_give isl_schedule_node *group_statements(
4113 __isl_take isl_schedule_node *node, int kernel_id)
4115 char buffer[20];
4116 isl_id *id;
4118 if (!node)
4119 return NULL;
4121 snprintf(buffer, sizeof(buffer), "kernel%d", kernel_id);
4122 id = isl_id_alloc(isl_schedule_node_get_ctx(node), buffer, NULL);
4123 return isl_schedule_node_group(node, id);
4126 /* Create a ppcg_kernel representing the domain instances that reach "node"
4127 * and replace the subtree at "node" by a mark node pointing
4128 * to the ppcg_kernel.
4129 * The band that "node" points to is the band that needs to be mapped
4130 * to block identifiers. The band that needs to be mapped to thread
4131 * identifiers should be marked by a "thread" mark by the caller.
4132 * If "scale" is set, then the band that "node" points to is scaled
4133 * by "sizes".
4135 * Mark all outer band nodes as atomic to ensure each kernel is only
4136 * scheduled once.
4137 * If the domain elements that reach "node" live in more than one space,
4138 * then group the domain elements into a single space, named kernelX,
4139 * with X the kernel sequence number.
4141 * Insert a guard node governing the kernel node to ensure that
4142 * no kernels with zero blocks are launched.
4144 * Temporarily adjust the schedule tree underneath the kernel mark as follows.
4145 * Insert a context node describing the block and thread
4146 * identifiers inside the kernel mark.
4147 * The context node needs to be inserted after the effective block size
4148 * has been determined such that the bounds on the thread identifiers
4149 * would reflect the effective block size.
4150 * Insert a filter node inside the context node mapping the statement
4151 * instances to block identifiers. In particular, the block identifiers
4152 * are equated to the partial schedule of band that was marked for mapping
4153 * to blocks modulo the grid size.
4154 * Insert a filter node inside the "thread" mark mapping the statement
4155 * instances to thread identifiers. In particular, the thread identifiers
4156 * are equated to the partial schedule of band that was marked for mapping
4157 * to threads modulo the block size.
4159 * Store a pointer to the created ppcg_kernel in gen->kernel.
4161 * We keep a copy of the isl_id that points to the kernel to ensure
4162 * that the kernel does not get destroyed if the schedule node
4163 * is freed due to some error condition.
4165 static __isl_give isl_schedule_node *create_kernel(struct gpu_gen *gen,
4166 __isl_take isl_schedule_node *node, int scale,
4167 __isl_keep isl_multi_val *sizes)
4169 struct ppcg_kernel *kernel;
4170 isl_id *id;
4171 isl_schedule_node *node_thread;
4172 isl_union_set *domain;
4173 int single_statement;
4175 kernel = isl_calloc_type(gen->ctx, struct ppcg_kernel);
4176 kernel = ppcg_kernel_create_local_arrays(kernel, gen->prog);
4177 if (!kernel)
4178 return isl_schedule_node_free(node);
4180 domain = isl_schedule_node_get_domain(node);
4181 single_statement = isl_union_set_n_set(domain) == 1;
4183 kernel->ctx = gen->ctx;
4184 kernel->options = gen->options;
4185 kernel->context = extract_context(node, gen->prog);
4186 kernel->core = isl_union_set_universe(isl_union_set_copy(domain));
4187 kernel->arrays = accessed_by_domain(isl_union_set_copy(domain),
4188 gen->prog);
4189 kernel->tile_len = isl_schedule_node_band_n_member(node);
4190 kernel->n_parallel = n_outer_coincidence(node);
4191 kernel->n_grid = kernel->n_parallel;
4192 node_thread = isl_schedule_node_copy(node);
4193 node_thread = gpu_tree_move_down_to_thread(node_thread, kernel->core);
4194 node_thread = isl_schedule_node_child(node_thread, 0);
4195 kernel->n_block = n_outer_coincidence(node_thread);
4196 isl_schedule_node_free(node_thread);
4197 kernel->id = gen->kernel_id++;
4198 read_grid_and_block_sizes(kernel, gen);
4200 gen->kernel = kernel;
4202 node = atomic_ancestors(node);
4204 id = isl_id_alloc(gen->ctx, "kernel", kernel);
4205 id = isl_id_set_free_user(id, &ppcg_kernel_free_wrap);
4206 node = isl_schedule_node_insert_mark(node, isl_id_copy(id));
4208 if (!single_statement)
4209 node = group_statements(node, kernel->id);
4211 node = isl_schedule_node_child(node, 0);
4212 node = split_band(node, kernel->n_grid);
4213 kernel->block_ids = ppcg_scop_generate_names(gen->prog->scop,
4214 kernel->n_grid, "b");
4215 kernel->block_filter = set_schedule_modulo(node, kernel->block_ids,
4216 kernel->grid_dim);
4217 kernel->grid_size = extract_grid_size(kernel,
4218 isl_union_set_copy(domain));
4219 if (!kernel->options->wrap)
4220 node = snap_band_to_sizes(node, kernel->grid_dim,
4221 kernel->options);
4222 if (scale)
4223 node = scale_band(node, isl_multi_val_copy(sizes));
4224 node = isl_schedule_node_parent(node);
4225 if (!single_statement)
4226 node = isl_schedule_node_parent(node);
4227 node = insert_guard(node, kernel->context, kernel->grid_size,
4228 gen->prog->scop);
4229 node = gpu_tree_move_down_to_thread(node, kernel->core);
4230 node = isl_schedule_node_child(node, 0);
4231 node = split_band(node, kernel->n_block);
4232 kernel->thread_ids = ppcg_scop_generate_names(gen->prog->scop,
4233 kernel->n_block, "t");
4234 kernel->thread_filter = set_schedule_modulo(node, kernel->thread_ids,
4235 kernel->block_dim);
4236 extract_block_size(kernel, domain);
4238 node = gpu_tree_move_up_to_kernel(node);
4239 node = isl_schedule_node_child(node, 0);
4240 node = insert_context(kernel, node);
4241 node = isl_schedule_node_child(node, 0);
4242 node = isl_schedule_node_insert_filter(node,
4243 isl_union_set_copy(kernel->block_filter));
4245 node = gpu_tree_move_down_to_thread(node, kernel->core);
4246 node = isl_schedule_node_child(node, 0);
4247 if (!kernel->options->wrap)
4248 node = snap_band_to_sizes(node, kernel->block_dim,
4249 kernel->options);
4250 node = isl_schedule_node_insert_filter(node,
4251 isl_union_set_copy(kernel->thread_filter));
4253 node = gpu_tree_move_up_to_kernel(node);
4255 node = isl_schedule_node_child(node, 0);
4256 node = isl_schedule_node_cut(node);
4257 node = isl_schedule_node_parent(node);
4259 if (!single_statement)
4260 node = isl_schedule_node_parent(node);
4261 node = isl_schedule_node_parent(node);
4263 isl_id_free(id);
4264 return node;
4267 /* Insert a zero-dimensional permutable band at "node".
4269 static __isl_give isl_schedule_node *insert_empty_permutable_band(
4270 __isl_take isl_schedule_node *node)
4272 isl_space *space;
4273 isl_schedule *schedule;
4274 isl_union_set *domain;
4275 isl_multi_union_pw_aff *mupa;
4277 schedule = isl_schedule_node_get_schedule(node);
4278 domain = isl_schedule_get_domain(schedule);
4279 space = isl_union_set_get_space(domain);
4280 isl_union_set_free(domain);
4281 isl_schedule_free(schedule);
4283 space = isl_space_set_from_params(space);
4284 mupa = isl_multi_union_pw_aff_zero(space);
4285 node = isl_schedule_node_insert_partial_schedule(node, mupa);
4286 node = isl_schedule_node_band_set_permutable(node, 1);
4288 return node;
4291 /* Mark "node" as outer permutable.
4293 * If "node" originally points to a leaf, then insert a zero-dimensional
4294 * permutable band such that we can assume that "node" always
4295 * points to a band node.
4297 * Tile "node" using user specified tile sizes, after splitting the band
4298 * if the number of specified tile sizes is smaller than the dimension
4299 * of the band. Mark the point band of this tiling as the band that
4300 * needs to be mapped to threads.
4301 * Create a kernel representing the domain instances that reach "node" and
4302 * replace the band node with a mark node pointing to the kernel.
4304 static __isl_give isl_schedule_node *mark_outer_permutable(
4305 struct gpu_gen *gen, __isl_take isl_schedule_node *node)
4307 struct ppcg_kernel *kernel;
4308 int scale;
4309 int tile_len;
4310 int *tile_size;
4311 isl_id *id;
4312 isl_multi_val *sizes;
4314 if (isl_schedule_node_get_type(node) == isl_schedule_node_leaf)
4315 node = insert_empty_permutable_band(node);
4317 tile_len = isl_schedule_node_band_n_member(node);
4318 tile_size = read_tile_sizes(gen, &tile_len);
4319 if (!tile_size)
4320 return isl_schedule_node_free(node);
4321 if (tile_len < isl_schedule_node_band_n_member(node))
4322 node = isl_schedule_node_band_split(node, tile_len);
4323 sizes = construct_band_tiles_sizes(node, tile_size);
4324 node = tile_band(node, isl_multi_val_copy(sizes));
4325 node = isl_schedule_node_child(node, 0);
4326 id = isl_id_alloc(gen->ctx, "thread", NULL);
4327 node = isl_schedule_node_insert_mark(node, id);
4328 node = isl_schedule_node_parent(node);
4330 scale = gen->options->scale_tile_loops;
4331 node = create_kernel(gen, node, scale, sizes);
4332 isl_multi_val_free(sizes);
4333 if (!node)
4334 return NULL;
4335 kernel = gen->kernel;
4336 kernel->tile_len = tile_len;
4337 kernel->tile_size = tile_size;
4339 return node;
4342 static __isl_give isl_schedule_node *select_outer_band(struct gpu_gen *gen,
4343 __isl_take isl_schedule_node *node, int pos, struct band_info *info);
4345 /* Check if this band node is tilable and has any parallel loops. If so,
4346 * take it as the outermost tilable band. If not, continue looking for the
4347 * outermost tilable band in the children of the current band.
4348 * Return a pointer to the same node in a tree where all outermost tilable
4349 * bands in the current subtree have been replaced by mark nodes
4350 * containing a pointer to a ppcg_kernel object.
4352 static __isl_give isl_schedule_node *band_select_outer_band(struct gpu_gen *gen,
4353 __isl_take isl_schedule_node *node, int pos, struct band_info *info)
4355 int n = isl_schedule_node_band_n_member(node);
4356 int n_parallel;
4358 n_parallel = n_outer_coincidence(node);
4360 if (!isl_schedule_node_band_get_permutable(node) || n_parallel == 0) {
4361 node = isl_schedule_node_child(node, 0);
4362 node = select_outer_band(gen, node, pos + n, info);
4363 return isl_schedule_node_parent(node);
4366 gen->any_parallelism = 1;
4367 info->gen = gen;
4368 info->tile_first = pos;
4369 info->prefix = isl_schedule_node_get_prefix_schedule_union_map(node);
4370 info->suffix = isl_schedule_node_get_subtree_schedule_union_map(node);
4372 node = mark_outer_permutable(gen, node);
4374 return node;
4377 /* Extend "umap" with coordinates with fixed value "val"
4378 * to a total length of "dst_len", assuming the original dimension is "src_len".
4380 static __isl_give isl_union_map *extend_range(
4381 __isl_take isl_union_map *umap, int src_len, int dst_len, int val)
4383 isl_space *dim;
4384 isl_map *map;
4385 int i;
4387 dim = isl_union_map_get_space(umap);
4388 map = isl_map_reverse(projection(dim, dst_len, src_len));
4389 for (i = src_len; i < dst_len; ++i)
4390 map = isl_map_fix_si(map, isl_dim_out, i, val);
4392 umap = isl_union_map_apply_range(umap, isl_union_map_from_map(map));
4394 return umap;
4397 /* Select the outermost bands in the elements of the sequence or set
4398 * node "node", align their prefix schedules and combine the resulting
4399 * prefix and suffix schedules into a single pair of prefix and
4400 * suffix schedules for the entire list.
4401 * Return a pointer to the same node in a tree where all outermost tilable
4402 * bands in the current subtree have been replaced by mark nodes
4403 * containing a pointer to a ppcg_kernel object.
4405 static __isl_give isl_schedule_node *list_select_outer_band(
4406 struct gpu_gen *gen, __isl_take isl_schedule_node *node, int pos,
4407 struct band_info *list_info)
4409 int i;
4410 int n = isl_schedule_node_n_children(node);
4411 isl_ctx *ctx = isl_schedule_node_get_ctx(node);
4412 struct band_info *info;
4413 int max_tile_first;
4414 isl_union_map *prefix;
4415 isl_union_map *suffix;
4417 assert(n >= 1);
4418 info = isl_calloc_array(ctx, struct band_info, n);
4419 assert(info);
4421 max_tile_first = 0;
4422 for (i = 0; i < n; ++i) {
4423 node = isl_schedule_node_child(node, i);
4424 node = select_outer_band(gen, node, pos, &info[i]);
4425 if (info[i].tile_first > max_tile_first)
4426 max_tile_first = info[i].tile_first;
4427 node = isl_schedule_node_parent(node);
4430 for (i = 0; i < n; ++i) {
4431 if (info[i].tile_first == max_tile_first)
4432 continue;
4433 info[i].prefix = extend_range(info[i].prefix,
4434 info[i].tile_first, max_tile_first, 0);
4435 info[i].tile_first = max_tile_first;
4438 prefix = info[0].prefix;
4439 suffix = info[0].suffix;
4441 for (i = 1; i < n; ++i) {
4442 prefix = isl_union_map_union(prefix, info[i].prefix);
4443 suffix = isl_union_map_union(suffix, info[i].suffix);
4446 list_info->tile_first = info[0].tile_first;
4447 list_info->prefix = prefix;
4448 list_info->suffix = suffix;
4450 free(info);
4451 return node;
4454 /* If we reach a leaf node, then we have not found any outer tilable
4455 * band with parallel loops, so consider the leaf node as the outermost
4456 * tilable band.
4457 * Return a pointer to a mark node containing a pointer
4458 * to a ppcg_kernel object inserted at the original leaf node.
4460 static __isl_give isl_schedule_node *leaf_select_outer_band(struct gpu_gen *gen,
4461 __isl_take isl_schedule_node *node, int pos, struct band_info *info)
4463 info->gen = gen;
4464 info->tile_first = pos;
4465 info->prefix = isl_schedule_node_get_prefix_schedule_union_map(node);
4466 info->suffix = isl_schedule_node_get_subtree_schedule_union_map(node);
4468 node = mark_outer_permutable(gen, node);
4470 return node;
4473 /* Select the outermost tilable band in the subtree that "node" points to and
4474 * return a pointer to the same node in a tree where all outermost tilable
4475 * bands in the current subtree have been replaced by mark nodes
4476 * containing a pointer to a ppcg_kernel object.
4478 static __isl_give isl_schedule_node *select_outer_band(struct gpu_gen *gen,
4479 __isl_take isl_schedule_node *node, int pos, struct band_info *info)
4481 enum isl_schedule_node_type type;
4483 type = isl_schedule_node_get_type(node);
4484 switch (type) {
4485 case isl_schedule_node_domain:
4486 case isl_schedule_node_filter:
4487 node = isl_schedule_node_child(node, 0);
4488 node = select_outer_band(gen, node, pos, info);
4489 return isl_schedule_node_parent(node);
4490 case isl_schedule_node_leaf:
4491 return leaf_select_outer_band(gen, node, pos, info);
4492 case isl_schedule_node_band:
4493 return band_select_outer_band(gen, node, pos, info);
4494 case isl_schedule_node_set:
4495 case isl_schedule_node_sequence:
4496 return list_select_outer_band(gen, node, pos, info);
4497 default:
4498 isl_die(isl_schedule_node_get_ctx(node),
4499 isl_error_unsupported, "unhandled schedule node type",
4500 node = node);
4501 case isl_schedule_node_error:
4502 info->prefix = NULL;
4503 info->suffix = NULL;
4504 break;
4507 return isl_schedule_node_free(node);
4510 /* Select the outermost tilable band that (by construction)
4511 * has at least one parallel loop.
4512 * The starting position of the aligned band is stored in the pair
4513 * gen->tile_first.
4514 * The sizes and number of parallel loops may be different in different
4515 * parts of the band forest and are therefore stored in the gpu_stmts.
4517 * Return the complete schedule, with the tilable bands aligned
4518 * at gen->tile_first and padded with zero, if needed.
4519 * Store a schedule tree corresponding to the outer gen->tile_first
4520 * dimensions, with mark nodes containing pointers to ppcg_kernel objects,
4521 * in gen->host_schedule.
4523 static __isl_give isl_union_map *select_outer_tilable_band(struct gpu_gen *gen,
4524 __isl_keep isl_schedule *schedule)
4526 isl_schedule_node *node;
4527 struct band_info info;
4529 node = isl_schedule_get_root(schedule);
4530 node = select_outer_band(gen, node, 0, &info);
4531 gen->host_schedule = isl_schedule_node_get_schedule(node);
4532 isl_schedule_node_free(node);
4534 gen->tile_first = info.tile_first;
4535 info.suffix = align_range(info.suffix);
4537 return isl_union_map_flat_range_product(info.prefix, info.suffix);
4540 /* Set gen->untiled_len to the number of scheduling dimensions
4541 * for the schedule of the first domain.
4542 * We assume here that this number is the same for all domains.
4544 static int set_untiled_len(__isl_take isl_map *map, void *user)
4546 unsigned *untiled_len = user;
4548 *untiled_len = isl_map_dim(map, isl_dim_out);
4550 isl_map_free(map);
4551 return -1;
4554 /* Compute an appropriate schedule based on the accesses in
4555 * gen->read and gen->write.
4557 * We use the dependences in gen->prog->scop to compute
4558 * a schedule that has a parallel loop in each tilable band.
4559 * Finally, we select the outermost tilable band.
4561 * If live range reordering is allowed, then we need to make sure
4562 * that live ranges on arrays are not run in parallel since doing
4563 * so would require array expansion. We therefore add the array
4564 * order dependences to the coincidence dependences. Non-zero array
4565 * order dependences will then prevent a schedule dimension from being
4566 * considered parallel.
4567 * Live ranges derived from scalars are allowed to be run in parallel
4568 * since we force the scalars to be mapped to private memory in
4569 * check_scalar_live_ranges.
4570 * If live range reordering is allowed, then the false dependences
4571 * are not added to the validity constraints as that would prevent
4572 * reordering. Instead, the external false dependences that enforce that reads
4573 * from potentially live-in data precede any later write and
4574 * that writes of potentially live-out data follow any other earlier write
4575 * are added to the validity and the coincidence constraints.
4576 * The false dependences are still added to the proximity constraints
4577 * for consistency with the case where live range reordering is not allowed.
4578 * The coincidence constraints then consist of flow dependences,
4579 * external false dependences and array order dependences.
4580 * The independences can be filtered out from the first two sets.
4581 * They have already been filtered out from the array order dependences
4582 * on a per array basis in collect_order_dependences.
4583 * There is no need for a per array handling of the other two sets
4584 * as there should be no flow or external false dependence on local
4585 * variables that can be filtered out.
4587 static void compute_schedule(struct gpu_gen *gen)
4589 isl_union_set *domain;
4590 isl_union_map *dep_raw, *dep;
4591 isl_union_map *validity, *proximity, *coincidence;
4592 isl_union_map *sched;
4593 isl_schedule_constraints *sc;
4594 isl_schedule *schedule;
4596 domain = isl_union_set_copy(gen->prog->scop->domain);
4597 sc = isl_schedule_constraints_on_domain(isl_union_set_copy(domain));
4598 sc = isl_schedule_constraints_set_context(sc,
4599 isl_set_copy(gen->prog->scop->context));
4600 if (gen->options->live_range_reordering) {
4601 sc = isl_schedule_constraints_set_conditional_validity(sc,
4602 isl_union_map_copy(gen->prog->scop->tagged_dep_flow),
4603 isl_union_map_copy(gen->prog->scop->tagged_dep_order));
4604 proximity = isl_union_map_copy(gen->prog->scop->dep_flow);
4605 validity = isl_union_map_copy(proximity);
4606 validity = isl_union_map_union(validity,
4607 isl_union_map_copy(gen->prog->scop->dep_forced));
4608 proximity = isl_union_map_union(proximity,
4609 isl_union_map_copy(gen->prog->scop->dep_false));
4610 coincidence = isl_union_map_copy(validity);
4611 coincidence = isl_union_map_subtract(coincidence,
4612 isl_union_map_copy(gen->prog->scop->independence));
4613 coincidence = isl_union_map_union(coincidence,
4614 isl_union_map_copy(gen->prog->array_order));
4615 } else {
4616 dep_raw = isl_union_map_copy(gen->prog->scop->dep_flow);
4617 dep = isl_union_map_copy(gen->prog->scop->dep_false);
4618 dep = isl_union_map_union(dep, dep_raw);
4619 dep = isl_union_map_coalesce(dep);
4620 proximity = isl_union_map_copy(dep);
4621 coincidence = isl_union_map_copy(dep);
4622 validity = dep;
4624 sc = isl_schedule_constraints_set_validity(sc, validity);
4625 sc = isl_schedule_constraints_set_coincidence(sc, coincidence);
4626 sc = isl_schedule_constraints_set_proximity(sc, proximity);
4628 if (gen->options->debug->dump_schedule_constraints)
4629 isl_schedule_constraints_dump(sc);
4630 schedule = isl_schedule_constraints_compute_schedule(sc);
4631 if (gen->options->debug->dump_schedule)
4632 isl_schedule_dump(schedule);
4634 sched = select_outer_tilable_band(gen, schedule);
4636 isl_union_map_foreach_map(sched, &set_untiled_len, &gen->untiled_len);
4637 sched = isl_union_map_intersect_domain(sched, domain);
4638 gen->sched = sched;
4640 isl_schedule_free(schedule);
4643 /* Compute the sets of outer array elements that need to be copied in and out.
4645 * In particular, for each array that is possibly written anywhere in
4646 * gen->prog and that is visible outside the corresponding scop,
4647 * we copy out its entire extent.
4649 * Any array elements that is read without first being written needs
4650 * to be copied in. Furthermore, if there are any array elements that
4651 * are copied out, but that may not be written inside gen->prog, then
4652 * they also need to be copied in to ensure that the value after execution
4653 * is the same as the value before execution, at least for those array
4654 * elements that may have their values preserved by the scop.
4655 * In case the array elements are structures, we need to take into
4656 * account that all members of the structures need to be written
4657 * by gen->prog before we can avoid copying the data structure in.
4659 * While computing the set of array elements that are copied out but
4660 * not necessarily written, we intersect both sets with the context.
4661 * This helps in those cases where the arrays are declared with a fixed size,
4662 * while the accesses are parametric and the context assigns a fixed value
4663 * to the parameters.
4665 * If an element from a local array is read without first being written,
4666 * then there is no point in copying it in since it cannot have been
4667 * written prior to the scop. Warn about the uninitialized read instead.
4669 static void compute_copy_in_and_out(struct gpu_gen *gen)
4671 int i;
4672 isl_union_set *local;
4673 isl_union_set *may_write, *must_write;
4674 isl_union_set *copy_in, *copy_out;
4675 isl_union_set *not_written;
4676 isl_union_map *uninitialized;
4677 isl_union_map *local_uninitialized;
4679 must_write = isl_union_map_range(
4680 isl_union_map_copy(gen->prog->must_write));
4681 must_write = isl_union_set_intersect_params(must_write,
4682 isl_set_copy(gen->prog->context));
4683 may_write = isl_union_map_range(
4684 isl_union_map_copy(gen->prog->may_write));
4685 may_write = isl_union_set_intersect_params(may_write,
4686 isl_set_copy(gen->prog->context));
4687 may_write = isl_union_set_universe(may_write);
4688 may_write = isl_union_set_apply(may_write,
4689 isl_union_map_copy(gen->prog->to_outer));
4690 copy_out = isl_union_set_empty(isl_union_set_get_space(may_write));
4691 local = isl_union_set_copy(copy_out);
4693 for (i = 0; i < gen->prog->n_array; ++i) {
4694 isl_space *space;
4695 isl_set *write_i;
4696 int empty;
4698 space = isl_space_copy(gen->prog->array[i].space);
4700 if (gen->prog->array[i].local) {
4701 isl_set *set;
4703 set = isl_set_universe(space);
4704 local = isl_union_set_add_set(local, set);
4705 continue;
4708 write_i = isl_union_set_extract_set(may_write, space);
4709 empty = isl_set_plain_is_empty(write_i);
4710 isl_set_free(write_i);
4711 if (empty)
4712 continue;
4714 write_i = isl_set_copy(gen->prog->array[i].extent);
4715 copy_out = isl_union_set_add_set(copy_out, write_i);
4717 isl_union_set_free(may_write);
4719 copy_out = isl_union_set_intersect_params(copy_out,
4720 isl_set_copy(gen->prog->context));
4722 gen->prog->copy_out = isl_union_set_copy(copy_out);
4724 copy_out = isl_union_set_apply(copy_out,
4725 isl_union_map_copy(gen->prog->to_inner));
4726 copy_out = isl_union_set_intersect(copy_out,
4727 isl_union_set_copy(gen->prog->may_persist));
4728 not_written = isl_union_set_subtract(copy_out, must_write);
4730 uninitialized = isl_union_map_copy(gen->prog->scop->live_in);
4731 local_uninitialized = isl_union_map_copy(uninitialized);
4733 local = isl_union_set_apply(local,
4734 isl_union_map_copy(gen->prog->to_inner));
4735 local_uninitialized = isl_union_map_intersect_range(local_uninitialized,
4736 local);
4737 if (!isl_union_map_is_empty(local_uninitialized)) {
4738 fprintf(stderr,
4739 "possibly uninitialized reads (not copied in):\n");
4740 isl_union_map_dump(local_uninitialized);
4742 uninitialized = isl_union_map_subtract(uninitialized,
4743 local_uninitialized);
4744 copy_in = isl_union_map_range(uninitialized);
4745 copy_in = isl_union_set_union(copy_in, not_written);
4746 copy_in = isl_union_set_apply(copy_in,
4747 isl_union_map_copy(gen->prog->to_outer));
4749 gen->prog->copy_in = copy_in;
4752 /* Internal data structure for extract_access.
4753 * "next_access" points to the end of a linked list that is extended
4754 * by extract_access.
4755 * "single_expression" is set if the access expressions belong to
4756 * an expression statement (i.e., a statement without internal control).
4757 * "any_to_outer" maps all intermediate arrays to their outer arrays.
4759 struct ppcg_extract_access_data {
4760 struct gpu_stmt_access **next_access;
4761 int single_expression;
4762 isl_union_map *any_to_outer;
4765 /* Given a tagged access relation to a single array "tagged", extract it
4766 * as a map, taking into account that the input may be empty.
4767 * If the access relation is empty, then it does not contain
4768 * any space information, so we try to recover it from the index
4769 * expression.
4770 * The space of the index expression is of the form I -> A,
4771 * with I the statement instances and A the array, or [I -> F] -> A,
4772 * with F the filters corresponding to arguments.
4773 * We first drop F, if present, obtaining I -> A.
4774 * Then we construct I -> R, with R the reference tag,
4775 * combine the two into I -> [R -> A] and uncurry to obtain
4776 * the final result [I -> R] -> A.
4777 * Note that the index expression may have a lower dimension
4778 * than that of the array, but this dimension is not used
4779 * if the access relation is empty.
4781 static __isl_give isl_map *extract_single_tagged_access(
4782 __isl_take isl_union_map *tagged, __isl_keep pet_expr *expr)
4784 int empty;
4785 isl_id *id;
4786 isl_space *space, *space2;
4787 isl_multi_pw_aff *index;
4789 empty = isl_union_map_is_empty(tagged);
4790 if (empty < 0)
4791 goto error;
4792 if (!empty)
4793 return isl_map_from_union_map(tagged);
4794 isl_union_map_free(tagged);
4796 index = pet_expr_access_get_index(expr);
4797 space = isl_multi_pw_aff_get_space(index);
4798 isl_multi_pw_aff_free(index);
4799 if (isl_space_domain_is_wrapping(space))
4800 space = isl_space_domain_factor_domain(space);
4801 space2 = isl_space_copy(space);
4802 space2 = isl_space_from_domain(isl_space_domain(space));
4803 id = pet_expr_access_get_ref_id(expr);
4804 space2 = isl_space_set_tuple_id(space2, isl_dim_out, id);
4805 space = isl_space_range_product(space2, space);
4806 space = isl_space_uncurry(space);
4808 return isl_map_empty(space);
4809 error:
4810 isl_union_map_free(tagged);
4811 return NULL;
4814 /* Extract a gpu_stmt_access from "expr", append it to the list
4815 * that ends in *data->next_access and update the end of the list.
4816 * If the access expression performs a write, then it is considered
4817 * exact only if it appears in a single expression statement and
4818 * if its may access relation is equal to its must access relation.
4820 * The combined set of may accesses may be union if member accesses
4821 * are involved, but the entire set is derived from a single reference and
4822 * therefore from a single index expression. These accesses therefore
4823 * all map to the same outer array.
4825 static int extract_access(__isl_keep pet_expr *expr, void *user)
4827 struct ppcg_extract_access_data *data = user;
4828 isl_union_map *tagged;
4829 struct gpu_stmt_access *access;
4830 isl_ctx *ctx = pet_expr_get_ctx(expr);
4831 isl_multi_pw_aff *index;
4833 access = isl_alloc_type(ctx, struct gpu_stmt_access);
4834 assert(access);
4835 access->next = NULL;
4836 access->read = pet_expr_access_is_read(expr);
4837 access->write = pet_expr_access_is_write(expr);
4838 tagged = pet_expr_access_get_tagged_may_read(expr);
4839 tagged = isl_union_map_union(tagged,
4840 pet_expr_access_get_tagged_may_write(expr));
4841 tagged = isl_union_map_apply_range(tagged,
4842 isl_union_map_copy(data->any_to_outer));
4843 if (!access->write) {
4844 access->exact_write = 1;
4845 } else if (!data->single_expression) {
4846 access->exact_write = 0;
4847 } else {
4848 isl_union_map *must, *may;
4849 may = isl_union_map_copy(tagged);
4850 may = isl_union_map_domain_factor_domain(may);
4851 must = pet_expr_access_get_must_write(expr);
4852 access->exact_write = isl_union_map_is_equal(must, may);
4853 isl_union_map_free(must);
4854 isl_union_map_free(may);
4856 index = pet_expr_access_get_index(expr);
4857 access->n_index = isl_multi_pw_aff_dim(index, isl_dim_out);
4858 isl_multi_pw_aff_free(index);
4859 access->ref_id = pet_expr_access_get_ref_id(expr);
4860 access->tagged_access = extract_single_tagged_access(tagged, expr);
4861 access->access = isl_map_copy(access->tagged_access);
4862 access->access = isl_map_domain_factor_domain(access->access);
4864 *data->next_access = access;
4865 data->next_access = &(*data->next_access)->next;
4867 if (!access->access)
4868 return -1;
4870 return 0;
4873 /* Construct a linked list of gpu_stmt_access objects,
4874 * one for each access expression in the statement body.
4875 * "any_to_outer" maps all intermediate arrays to their outer arrays.
4877 static int pet_stmt_extract_accesses(struct gpu_stmt *stmt,
4878 __isl_keep isl_union_map *any_to_outer)
4880 struct ppcg_extract_access_data data;
4882 stmt->accesses = NULL;
4883 data.next_access = &stmt->accesses;
4884 data.single_expression =
4885 pet_tree_get_type(stmt->stmt->body) == pet_tree_expr;
4886 data.any_to_outer = any_to_outer;
4887 return pet_tree_foreach_access_expr(stmt->stmt->body,
4888 &extract_access, &data);
4891 /* Return an array of gpu_stmt representing the statements in "scop".
4893 static struct gpu_stmt *extract_stmts(isl_ctx *ctx, struct ppcg_scop *scop,
4894 __isl_keep isl_set *context, __isl_keep isl_union_map *any_to_outer)
4896 int i;
4897 struct gpu_stmt *stmts;
4899 stmts = isl_calloc_array(ctx, struct gpu_stmt, scop->pet->n_stmt);
4900 if (!stmts)
4901 return NULL;
4903 for (i = 0; i < scop->pet->n_stmt; ++i) {
4904 struct gpu_stmt *s = &stmts[i];
4906 s->id = isl_set_get_tuple_id(scop->pet->stmts[i]->domain);
4907 s->stmt = scop->pet->stmts[i];
4908 if (pet_stmt_extract_accesses(s, any_to_outer) < 0)
4909 return free_stmts(stmts, i + 1);
4912 return stmts;
4915 /* Callback for ppcg_print_guarded that calls the callback for generate_gpu.
4917 static __isl_give isl_printer *print_gpu(__isl_take isl_printer *p, void *user)
4919 struct gpu_gen *gen = user;
4921 return gen->print(p, gen->prog, gen->tree, &gen->types,
4922 gen->print_user);
4925 /* Generate CUDA code for "scop" and print it to "p".
4926 * After generating an AST for the transformed scop as explained below,
4927 * we call "gen->print" to print the AST in the desired output format
4928 * to "p".
4930 * If it turns out that it does not make sense to generate GPU code,
4931 * then we generate CPU code instead.
4933 * The GPU code is generated in a context where at least one
4934 * statement instance is executed. The corresponding guard (if any) is printed
4935 * around the entire generated GPU code, except for the declaration
4936 * of the arrays that are visible outside of the scop and that therefore
4937 * cannot be declared inside the body of any possible guard.
4939 * We first compute a schedule that respects the dependences
4940 * of the original program and select the outermost band
4941 * of tilable dimensions that has at least one parallel loop.
4942 * We then have three blocks of dimensions
4944 * H B G
4946 * The tilable band "B" is first tiled according to "tile" sizes, resulting
4947 * in
4949 * H T P G
4951 * For each iteration of the T loop and for each array, we compute
4952 * the array elements accessed by that iteration, construct a rectangular
4953 * box around it and shift it to the origin. The result is used
4954 * as shared memory for the array.
4956 * We then split off at most 2 parallel loops from the T loops and
4957 * at most 3 parallel loops from the P loops
4959 * H T1 T2 P1 P2 G
4961 * The T1/P1 loops are then tiled or "wrapped" over the blocks/threads,
4962 * according to "grid"/"block" sizes.
4964 * H T1T T1P T2 P1T P1P P2 G
4966 * Finally, the T1P and P1P iterators are equated to the block and
4967 * thread dimensions respectively and so are effectively removed.
4968 * The H loops are run on the host. The T1T, T2, P1T, P2 and G loops
4969 * are run on the GPU.
4971 * Code is generated in three stages. We first generate code for the
4972 * host (the H loops), with iterators h%d. Then, for each leaf node
4973 * of the resulting AST, we generate code for the shared loops (up to
4974 * and including T2), with iterators g%d and after equating the H loops
4975 * to h%d parameters and the T1P loops to the block dimensions.
4976 * Finally, we generate code for the remaining loops in a similar fashion.
4978 static __isl_give isl_printer *generate(__isl_take isl_printer *p,
4979 struct gpu_gen *gen, struct ppcg_scop *scop,
4980 struct ppcg_options *options)
4982 struct gpu_prog *prog;
4983 isl_ctx *ctx;
4984 isl_set *context, *guard;
4986 if (!scop)
4987 return isl_printer_free(p);
4989 ctx = isl_printer_get_ctx(p);
4990 prog = gpu_prog_alloc(ctx, scop);
4991 if (!prog)
4992 return isl_printer_free(p);
4994 context = isl_set_copy(prog->context);
4995 guard = isl_union_set_params(isl_union_set_copy(prog->scop->domain));
4996 prog->context = isl_set_intersect(prog->context, isl_set_copy(guard));
4998 gen->prog = prog;
4999 gen->any_parallelism = 0;
5000 compute_schedule(gen);
5002 if (!gen->any_parallelism) {
5003 isl_set_free(context);
5004 isl_set_free(guard);
5005 p = print_cpu(p, scop, options);
5006 } else {
5007 compute_copy_in_and_out(gen);
5008 gen->tree = generate_host_code(gen);
5009 p = ppcg_print_exposed_declarations(p, prog->scop);
5010 p = ppcg_print_guarded(p, guard, context, &print_gpu, gen);
5011 isl_ast_node_free(gen->tree);
5014 isl_union_map_free(gen->sched);
5015 isl_schedule_free(gen->host_schedule);
5017 gpu_prog_free(prog);
5019 return p;
5022 /* Wrapper around generate for use as a ppcg_transform callback.
5024 static __isl_give isl_printer *generate_wrap(__isl_take isl_printer *p,
5025 struct ppcg_scop *scop, void *user)
5027 struct gpu_gen *gen = user;
5029 return generate(p, gen, scop, gen->options);
5032 /* Transform the code in the file called "input" by replacing
5033 * all scops by corresponding GPU code and write the results to "out".
5035 int generate_gpu(isl_ctx *ctx, const char *input, FILE *out,
5036 struct ppcg_options *options,
5037 __isl_give isl_printer *(*print)(__isl_take isl_printer *p,
5038 struct gpu_prog *prog, __isl_keep isl_ast_node *tree,
5039 struct gpu_types *types, void *user), void *user)
5041 struct gpu_gen gen;
5042 int r;
5043 int i;
5045 gen.ctx = ctx;
5046 gen.sizes = extract_sizes_from_str(ctx, options->sizes);
5047 gen.options = options;
5048 gen.kernel_id = 0;
5049 gen.print = print;
5050 gen.print_user = user;
5051 gen.types.n = 0;
5052 gen.types.name = NULL;
5054 if (options->debug->dump_sizes) {
5055 isl_space *space = isl_space_params_alloc(ctx, 0);
5056 gen.used_sizes = isl_union_map_empty(space);
5059 r = ppcg_transform(ctx, input, out, options, &generate_wrap, &gen);
5061 if (options->debug->dump_sizes) {
5062 isl_union_map_dump(gen.used_sizes);
5063 isl_union_map_free(gen.used_sizes);
5066 isl_union_map_free(gen.sizes);
5067 for (i = 0; i < gen.types.n; ++i)
5068 free(gen.types.name[i]);
5069 free(gen.types.name);
5071 return r;
5074 /* Compute the set of inner array elements that may have their values
5075 * preserved by "prog". In particular, collect the array elements of
5076 * arrays that are not local to "prog" and remove those elements that
5077 * are definitely killed or definitely written by "prog".
5079 static __isl_give isl_union_set *compute_may_persist(struct gpu_prog *prog)
5081 int i;
5082 isl_union_set *may_persist, *killed;
5083 isl_union_map *must_kill;
5085 may_persist = isl_union_set_empty(isl_set_get_space(prog->context));
5086 for (i = 0; i < prog->n_array; ++i) {
5087 isl_set *extent;
5089 if (prog->array[i].local)
5090 continue;
5092 extent = isl_set_copy(prog->array[i].extent);
5093 may_persist = isl_union_set_add_set(may_persist, extent);
5096 may_persist = isl_union_set_intersect_params(may_persist,
5097 isl_set_copy(prog->context));
5098 may_persist = isl_union_set_apply(may_persist,
5099 isl_union_map_copy(prog->to_inner));
5100 must_kill = isl_union_map_copy(prog->tagged_must_kill);
5101 killed = isl_union_map_range(must_kill);
5102 must_kill = isl_union_map_copy(prog->must_write);
5103 killed = isl_union_set_union(killed, isl_union_map_range(must_kill));
5105 may_persist = isl_union_set_subtract(may_persist, killed);
5106 return may_persist;
5109 struct gpu_prog *gpu_prog_alloc(isl_ctx *ctx, struct ppcg_scop *scop)
5111 struct gpu_prog *prog;
5112 isl_space *space;
5113 isl_map *id;
5115 if (!scop)
5116 return NULL;
5118 prog = isl_calloc_type(ctx, struct gpu_prog);
5119 assert(prog);
5121 prog->ctx = ctx;
5122 prog->scop = scop;
5123 prog->context = isl_set_copy(scop->context);
5124 prog->n_stmts = scop->pet->n_stmt;
5125 prog->any_to_outer = pet_scop_compute_outer_to_any(scop->pet);
5126 prog->any_to_outer = isl_union_map_reverse(prog->any_to_outer);
5127 space = isl_union_map_get_space(prog->any_to_outer);
5128 space = isl_space_set_from_params(space);
5129 space = isl_space_add_dims(space, isl_dim_set, 1);
5130 space = isl_space_map_from_set(space);
5131 id = isl_map_identity(space);
5132 prog->any_to_outer = isl_union_map_add_map(prog->any_to_outer, id);
5133 prog->stmts = extract_stmts(ctx, scop,
5134 prog->context, prog->any_to_outer);
5135 prog->read = isl_union_map_copy(scop->reads);
5136 prog->may_write = isl_union_map_copy(scop->may_writes);
5137 prog->must_write = isl_union_map_copy(scop->must_writes);
5138 prog->tagged_must_kill = isl_union_map_copy(scop->tagged_must_kills);
5139 prog->to_inner = pet_scop_compute_outer_to_inner(scop->pet);
5140 prog->to_outer = isl_union_map_copy(prog->to_inner);
5141 prog->to_outer = isl_union_map_reverse(prog->to_outer);
5143 if (!prog->stmts)
5144 return gpu_prog_free(prog);
5146 if (collect_array_info(prog) < 0)
5147 return gpu_prog_free(prog);
5148 prog->may_persist = compute_may_persist(prog);
5150 return prog;
5153 void *gpu_prog_free(struct gpu_prog *prog)
5155 if (!prog)
5156 return NULL;
5157 free_array_info(prog);
5158 free_stmts(prog->stmts, prog->n_stmts);
5159 isl_union_map_free(prog->any_to_outer);
5160 isl_union_map_free(prog->to_outer);
5161 isl_union_map_free(prog->to_inner);
5162 isl_union_set_free(prog->copy_in);
5163 isl_union_set_free(prog->copy_out);
5164 isl_union_map_free(prog->read);
5165 isl_union_map_free(prog->may_write);
5166 isl_union_map_free(prog->must_write);
5167 isl_union_map_free(prog->tagged_must_kill);
5168 isl_union_map_free(prog->array_order);
5169 isl_union_set_free(prog->may_persist);
5170 isl_set_free(prog->context);
5171 free(prog);
5172 return NULL;