1 /* Graphite polyhedral representation.
2 Copyright (C) 2009 Free Software Foundation, Inc.
3 Contributed by Sebastian Pop <sebastian.pop@amd.com> and
4 Tobias Grosser <grosser@fim.uni-passau.de>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #ifndef GCC_GRAPHITE_POLY_H
23 #define GCC_GRAPHITE_POLY_H
25 typedef struct poly_dr *poly_dr_p;
27 DEF_VEC_ALLOC_P (poly_dr_p, heap);
29 typedef struct poly_bb *poly_bb_p;
31 DEF_VEC_ALLOC_P (poly_bb_p, heap);
33 typedef struct scop *scop_p;
35 DEF_VEC_ALLOC_P (scop_p, heap);
37 typedef ppl_dimension_type graphite_dim_t;
39 static inline graphite_dim_t pbb_dim_iter_domain (const struct poly_bb *);
40 static inline graphite_dim_t pbb_nb_params (const struct poly_bb *);
41 static inline graphite_dim_t scop_nb_params (scop_p);
43 /* A data reference can write or read some memory or we
44 just know it may write some memory. */
48 /* PDR_MAY_READs are represented using PDR_READS. This does not
49 limit the expressiveness. */
56 /* An identifier for this PDR. */
59 /* A pointer to compiler's data reference description. */
62 /* A pointer to the PBB that contains this data reference. */
65 enum poly_dr_type type;
67 /* The access polyhedron contains the polyhedral space this data
68 reference will access.
70 The polyhedron contains these dimensions:
73 Every memory access is classified in at least one alias set.
75 - The subscripts (s_0, ..., s_n):
76 The memory is accessed using zero or more subscript dimensions.
78 - The iteration domain (variables and parameters)
80 Do not hardcode the dimensions. Use the following accessor functions:
94 | if (unknown_function ())
101 The data access A[i][j+k] in alias set "5" is described like this:
106 | 0 -1 -1 0 0 1 0 = 0
107 | 0 0 0 0 1 0 0 >= 0 # The last four lines describe the
108 | 0 0 0 0 0 1 0 >= 0 # array size.
109 | 0 0 0 0 -1 0 1335 >= 0
110 | 0 0 0 0 0 -1 123 >= 0
112 The pointer "*p" in alias set "5" and "7" is described as a union of
126 "*p" accesses all of the object allocated with 'malloc'.
128 The scalar data access "m" is represented as an array with zero subscript
133 ppl_Pointset_Powerset_C_Polyhedron_t accesses;
135 /* The number of subscripts. */
136 graphite_dim_t nb_subscripts;
139 #define PDR_ID(PDR) (PDR->id)
140 #define PDR_CDR(PDR) (PDR->compiler_dr)
141 #define PDR_PBB(PDR) (PDR->pbb)
142 #define PDR_TYPE(PDR) (PDR->type)
143 #define PDR_ACCESSES(PDR) (PDR->accesses)
144 #define PDR_NB_SUBSCRIPTS(PDR) (PDR->nb_subscripts)
146 void new_poly_dr (poly_bb_p, ppl_Pointset_Powerset_C_Polyhedron_t,
147 enum poly_dr_type, void *, int);
148 void free_poly_dr (poly_dr_p);
149 void debug_pdr (poly_dr_p);
150 void print_pdr (FILE *, poly_dr_p);
151 static inline scop_p pdr_scop (poly_dr_p pdr);
153 /* The dimension of the PDR_ACCESSES polyhedron of PDR. */
155 static inline ppl_dimension_type
156 pdr_dim (poly_dr_p pdr)
158 ppl_dimension_type dim;
159 ppl_Pointset_Powerset_C_Polyhedron_space_dimension (PDR_ACCESSES (pdr),
164 /* The dimension of the iteration domain of the scop of PDR. */
166 static inline ppl_dimension_type
167 pdr_dim_iter_domain (poly_dr_p pdr)
169 return pbb_dim_iter_domain (PDR_PBB (pdr));
172 /* The number of parameters of the scop of PDR. */
174 static inline ppl_dimension_type
175 pdr_nb_params (poly_dr_p pdr)
177 return scop_nb_params (pdr_scop (pdr));
180 /* The dimension of the alias set in PDR. */
182 static inline ppl_dimension_type
183 pdr_alias_set_dim (poly_dr_p pdr)
185 poly_bb_p pbb = PDR_PBB (pdr);
187 return pbb_dim_iter_domain (pbb) + pbb_nb_params (pbb);
190 /* The dimension in PDR containing subscript S. */
192 static inline ppl_dimension_type
193 pdr_subscript_dim (poly_dr_p pdr, graphite_dim_t s)
195 poly_bb_p pbb = PDR_PBB (pdr);
197 return pbb_dim_iter_domain (pbb) + pbb_nb_params (pbb) + 1 + s;
200 /* The dimension in PDR containing the loop iterator ITER. */
202 static inline ppl_dimension_type
203 pdr_iterator_dim (poly_dr_p pdr ATTRIBUTE_UNUSED, graphite_dim_t iter)
208 /* The dimension in PDR containing parameter PARAM. */
210 static inline ppl_dimension_type
211 pdr_parameter_dim (poly_dr_p pdr, graphite_dim_t param)
213 poly_bb_p pbb = PDR_PBB (pdr);
215 return pbb_dim_iter_domain (pbb) + param;
218 /* Returns true when PDR is a "read". */
221 pdr_read_p (poly_dr_p pdr)
223 return PDR_TYPE (pdr) == PDR_READ;
226 /* Returns true when PDR is a "write". */
229 pdr_write_p (poly_dr_p pdr)
231 return PDR_TYPE (pdr) == PDR_WRITE;
234 /* Returns true when PDR is a "may write". */
237 pdr_may_write_p (poly_dr_p pdr)
239 return PDR_TYPE (pdr) == PDR_MAY_WRITE;
242 typedef struct poly_scattering *poly_scattering_p;
244 struct poly_scattering
246 /* The scattering function containing the transformations. */
247 ppl_Polyhedron_t scattering;
249 /* The number of local variables. */
250 int nb_local_variables;
252 /* The number of scattering dimensions. */
256 /* POLY_BB represents a blackbox in the polyhedral model. */
264 /* The iteration domain of this bb.
267 for (i = a - 7*b + 8; i <= 3*a + 13*b + 20; i++)
268 for (j = 2; j <= 2*i + 5; j++)
269 for (k = 0; k <= 5; k++)
272 Loop iterators: i, j, k
282 The number of variables in the DOMAIN may change and is not
283 related to the number of loops in the original code. */
284 ppl_Pointset_Powerset_C_Polyhedron_t domain;
286 /* The data references we access. */
287 VEC (poly_dr_p, heap) *drs;
289 /* The original scattering. */
290 poly_scattering_p original;
292 /* The transformed scattering. */
293 poly_scattering_p transformed;
295 /* A copy of the transformed scattering. */
296 poly_scattering_p saved;
299 #define PBB_BLACK_BOX(PBB) ((gimple_bb_p) PBB->black_box)
300 #define PBB_SCOP(PBB) (PBB->scop)
301 #define PBB_DOMAIN(PBB) (PBB->domain)
302 #define PBB_DRS(PBB) (PBB->drs)
303 #define PBB_ORIGINAL(PBB) (PBB->original)
304 #define PBB_ORIGINAL_SCATTERING(PBB) (PBB->original->scattering)
305 #define PBB_TRANSFORMED(PBB) (PBB->transformed)
306 #define PBB_TRANSFORMED_SCATTERING(PBB) (PBB->transformed->scattering)
307 #define PBB_SAVED(PBB) (PBB->saved)
308 #define PBB_NB_LOCAL_VARIABLES(PBB) (PBB->transformed->nb_local_variables)
309 #define PBB_NB_SCATTERING_TRANSFORM(PBB) (PBB->transformed->nb_scattering)
311 extern void new_poly_bb (scop_p, void *);
312 extern void free_poly_bb (poly_bb_p);
313 extern void debug_loop_vec (poly_bb_p);
314 extern void schedule_to_scattering (poly_bb_p, int);
315 extern void print_pbb_domain (FILE *, poly_bb_p);
316 extern void print_pbb (FILE *, poly_bb_p);
317 extern void print_scop_context (FILE *, scop_p);
318 extern void print_scop (FILE *, scop_p);
319 extern void debug_pbb_domain (poly_bb_p);
320 extern void debug_pbb (poly_bb_p);
321 extern void print_pdrs (FILE *, poly_bb_p);
322 extern void debug_pdrs (poly_bb_p);
323 extern void debug_scop_context (scop_p);
324 extern void debug_scop (scop_p);
325 extern void print_scop_params (FILE *, scop_p);
326 extern void debug_scop_params (scop_p);
327 extern void print_iteration_domain (FILE *, poly_bb_p);
328 extern void print_iteration_domains (FILE *, scop_p);
329 extern void debug_iteration_domain (poly_bb_p);
330 extern void debug_iteration_domains (scop_p);
331 extern bool scop_do_interchange (scop_p);
332 extern bool scop_do_strip_mine (scop_p);
333 extern void pbb_number_of_iterations (poly_bb_p, graphite_dim_t, Value);
334 extern void pbb_number_of_iterations_at_time (poly_bb_p, graphite_dim_t, Value);
336 /* The index of the PBB. */
339 pbb_index (poly_bb_p pbb)
341 return GBB_BB (PBB_BLACK_BOX (pbb))->index;
344 /* The scop that contains the PDR. */
347 pdr_scop (poly_dr_p pdr)
349 return PBB_SCOP (PDR_PBB (pdr));
352 /* Set black box of PBB to BLACKBOX. */
355 pbb_set_black_box (poly_bb_p pbb, void *black_box)
357 pbb->black_box = black_box;
360 /* The number of loops around PBB: the dimension of the iteration
363 static inline graphite_dim_t
364 pbb_dim_iter_domain (const struct poly_bb *pbb)
366 scop_p scop = PBB_SCOP (pbb);
367 ppl_dimension_type dim;
369 ppl_Pointset_Powerset_C_Polyhedron_space_dimension (PBB_DOMAIN (pbb), &dim);
370 return dim - scop_nb_params (scop);
373 /* The number of params defined in PBB. */
375 static inline graphite_dim_t
376 pbb_nb_params (const struct poly_bb *pbb)
378 scop_p scop = PBB_SCOP (pbb);
380 return scop_nb_params (scop);
383 /* The number of scattering dimensions in the SCATTERING polyhedron
384 of a PBB for a given SCOP. */
386 static inline graphite_dim_t
387 pbb_nb_scattering_orig (const struct poly_bb *pbb)
389 return 2 * pbb_dim_iter_domain (pbb) + 1;
392 /* The number of scattering dimensions in PBB. */
394 static inline graphite_dim_t
395 pbb_nb_scattering_transform (const struct poly_bb *pbb)
397 return PBB_NB_SCATTERING_TRANSFORM (pbb);
400 /* The number of dynamic scattering dimensions in PBB. */
402 static inline graphite_dim_t
403 pbb_nb_dynamic_scattering_transform (const struct poly_bb *pbb)
405 /* This function requires the 2d + 1 scattering format to be
406 invariant during all transformations. */
407 gcc_assert (PBB_NB_SCATTERING_TRANSFORM (pbb) % 2);
408 return PBB_NB_SCATTERING_TRANSFORM (pbb) / 2;
411 /* Returns the number of local variables used in the transformed
412 scattering polyhedron of PBB. */
414 static inline graphite_dim_t
415 pbb_nb_local_vars (const struct poly_bb *pbb)
417 /* For now we do not have any local variables, as we do not do strip
418 mining for example. */
419 return PBB_NB_LOCAL_VARIABLES (pbb);
422 /* The dimension in the domain of PBB containing the iterator ITER. */
424 static inline ppl_dimension_type
425 pbb_iterator_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t iter)
430 /* The dimension in the domain of PBB containing the iterator ITER. */
432 static inline ppl_dimension_type
433 pbb_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
436 + pbb_dim_iter_domain (pbb);
439 /* The dimension in the original scattering polyhedron of PBB
440 containing the scattering iterator SCATTER. */
442 static inline ppl_dimension_type
443 psco_scattering_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t scatter)
445 gcc_assert (scatter < pbb_nb_scattering_orig (pbb));
449 /* The dimension in the transformed scattering polyhedron of PBB
450 containing the scattering iterator SCATTER. */
452 static inline ppl_dimension_type
453 psct_scattering_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t scatter)
455 gcc_assert (scatter <= pbb_nb_scattering_transform (pbb));
459 ppl_dimension_type psct_scattering_dim_for_loop_depth (poly_bb_p,
462 /* The dimension in the transformed scattering polyhedron of PBB of
463 the local variable LV. */
465 static inline ppl_dimension_type
466 psct_local_var_dim (poly_bb_p pbb, graphite_dim_t lv)
468 gcc_assert (lv <= pbb_nb_local_vars (pbb));
469 return lv + pbb_nb_scattering_transform (pbb);
472 /* The dimension in the original scattering polyhedron of PBB
473 containing the loop iterator ITER. */
475 static inline ppl_dimension_type
476 psco_iterator_dim (poly_bb_p pbb, graphite_dim_t iter)
478 gcc_assert (iter < pbb_dim_iter_domain (pbb));
479 return iter + pbb_nb_scattering_orig (pbb);
482 /* The dimension in the transformed scattering polyhedron of PBB
483 containing the loop iterator ITER. */
485 static inline ppl_dimension_type
486 psct_iterator_dim (poly_bb_p pbb, graphite_dim_t iter)
488 gcc_assert (iter < pbb_dim_iter_domain (pbb));
490 + pbb_nb_scattering_transform (pbb)
491 + pbb_nb_local_vars (pbb);
494 /* The dimension in the original scattering polyhedron of PBB
495 containing parameter PARAM. */
497 static inline ppl_dimension_type
498 psco_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
500 gcc_assert (param < pbb_nb_params (pbb));
502 + pbb_nb_scattering_orig (pbb)
503 + pbb_dim_iter_domain (pbb);
506 /* The dimension in the transformed scattering polyhedron of PBB
507 containing parameter PARAM. */
509 static inline ppl_dimension_type
510 psct_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
512 gcc_assert (param < pbb_nb_params (pbb));
514 + pbb_nb_scattering_transform (pbb)
515 + pbb_nb_local_vars (pbb)
516 + pbb_dim_iter_domain (pbb);
519 /* The scattering dimension of PBB corresponding to the dynamic level
522 static inline ppl_dimension_type
523 psct_dynamic_dim (poly_bb_p pbb, graphite_dim_t level)
525 graphite_dim_t result;
526 result = 1 + 2 * level;
528 gcc_assert (result < pbb_nb_scattering_transform (pbb));
532 /* Adds to the transformed scattering polyhedron of PBB a new local
533 variable and returns its index. */
535 static inline graphite_dim_t
536 psct_add_local_variable (poly_bb_p pbb)
538 graphite_dim_t nlv = pbb_nb_local_vars (pbb);
539 ppl_dimension_type lv_column = psct_local_var_dim (pbb, nlv);
540 ppl_insert_dimensions (PBB_TRANSFORMED_SCATTERING (pbb), lv_column, 1);
541 PBB_NB_LOCAL_VARIABLES (pbb) += 1;
545 /* Adds a dimension to the transformed scattering polyhedron of PBB at
549 psct_add_scattering_dimension (poly_bb_p pbb, ppl_dimension_type index)
551 gcc_assert (index < pbb_nb_scattering_transform (pbb));
553 ppl_insert_dimensions (PBB_TRANSFORMED_SCATTERING (pbb), index, 1);
554 PBB_NB_SCATTERING_TRANSFORM (pbb) += 1;
557 /* A SCOP is a Static Control Part of the program, simple enough to be
558 represented in polyhedral form. */
561 /* A SCOP is defined as a SESE region. */
564 /* Number of parameters in SCoP. */
565 graphite_dim_t nb_params;
567 /* All the basic blocks in this scop that contain memory references
568 and that will be represented as statements in the polyhedral
570 VEC (poly_bb_p, heap) *bbs;
572 /* Data dependence graph for this SCoP. */
573 struct graph *dep_graph;
575 /* The context describes known restrictions concerning the parameters
576 and relations in between the parameters.
578 void f (int8_t a, uint_16_t b) {
583 Here we can add these restrictions to the context:
588 ppl_Pointset_Powerset_C_Polyhedron_t context;
590 /* A hashtable of the data dependence relations for the original
592 htab_t original_pddrs;
595 #define SCOP_BBS(S) (S->bbs)
596 #define SCOP_REGION(S) ((sese) S->region)
597 #define SCOP_DEP_GRAPH(S) (S->dep_graph)
598 #define SCOP_CONTEXT(S) (S->context)
599 #define SCOP_ORIGINAL_PDDRS(S) (S->original_pddrs)
601 extern scop_p new_scop (void *);
602 extern void free_scop (scop_p);
603 extern void free_scops (VEC (scop_p, heap) *);
604 extern void print_generated_program (FILE *, scop_p);
605 extern void debug_generated_program (scop_p);
606 extern void print_scattering_function (FILE *, poly_bb_p);
607 extern void print_scattering_functions (FILE *, scop_p);
608 extern void debug_scattering_function (poly_bb_p);
609 extern void debug_scattering_functions (scop_p);
610 extern int scop_max_loop_depth (scop_p);
611 extern int unify_scattering_dimensions (scop_p);
612 extern bool apply_poly_transforms (scop_p);
613 extern bool graphite_legal_transform (scop_p);
615 /* Set the region of SCOP to REGION. */
618 scop_set_region (scop_p scop, void *region)
620 scop->region = region;
623 /* Returns the number of parameters for SCOP. */
625 static inline graphite_dim_t
626 scop_nb_params (scop_p scop)
628 return scop->nb_params;
631 /* Set the number of params of SCOP to NB_PARAMS. */
634 scop_set_nb_params (scop_p scop, graphite_dim_t nb_params)
636 scop->nb_params = nb_params;
639 /* Allocates a new empty poly_scattering structure. */
641 static inline poly_scattering_p
642 poly_scattering_new (void)
644 poly_scattering_p res = XNEW (struct poly_scattering);
646 res->scattering = NULL;
647 res->nb_local_variables = 0;
648 res->nb_scattering = 0;
652 /* Free a poly_scattering structure. */
655 poly_scattering_free (poly_scattering_p s)
657 ppl_delete_Polyhedron (s->scattering);
661 /* Copies S and return a new scattering. */
663 static inline poly_scattering_p
664 poly_scattering_copy (poly_scattering_p s)
666 poly_scattering_p res = poly_scattering_new ();
668 ppl_new_C_Polyhedron_from_C_Polyhedron (&(res->scattering), s->scattering);
669 res->nb_local_variables = s->nb_local_variables;
670 res->nb_scattering = s->nb_scattering;
674 /* Saves the transformed scattering of PBB. */
677 store_scattering_pbb (poly_bb_p pbb)
679 gcc_assert (PBB_TRANSFORMED (pbb));
682 poly_scattering_free (PBB_SAVED (pbb));
684 PBB_SAVED (pbb) = poly_scattering_copy (PBB_TRANSFORMED (pbb));
687 /* Saves the scattering for all the pbbs in the SCOP. */
690 store_scattering (scop_p scop)
695 for (i = 0; VEC_iterate (poly_bb_p, SCOP_BBS (scop), i, pbb); i++)
696 store_scattering_pbb (pbb);
699 /* Restores the scattering of PBB. */
702 restore_scattering_pbb (poly_bb_p pbb)
704 gcc_assert (PBB_SAVED (pbb));
706 poly_scattering_free (PBB_TRANSFORMED (pbb));
707 PBB_TRANSFORMED (pbb) = poly_scattering_copy (PBB_SAVED (pbb));
710 /* Restores the scattering for all the pbbs in the SCOP. */
713 restore_scattering (scop_p scop)
718 for (i = 0; VEC_iterate (poly_bb_p, SCOP_BBS (scop), i, pbb); i++)
719 restore_scattering_pbb (pbb);