OSDN Git Service

2009-08-28 Sebastian Pop <sebastian.pop@amd.com>
[pf3gnuchains/gcc-fork.git] / gcc / graphite-poly.h
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>.
5
6 This file is part of GCC.
7
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)
11 any later version.
12
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.
17
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/>.  */
21
22 #ifndef GCC_GRAPHITE_POLY_H
23 #define GCC_GRAPHITE_POLY_H
24
25 typedef struct poly_dr *poly_dr_p;
26 DEF_VEC_P(poly_dr_p);
27 DEF_VEC_ALLOC_P (poly_dr_p, heap);
28
29 typedef struct poly_bb *poly_bb_p;
30 DEF_VEC_P(poly_bb_p);
31 DEF_VEC_ALLOC_P (poly_bb_p, heap);
32
33 typedef struct scop *scop_p;
34 DEF_VEC_P(scop_p);
35 DEF_VEC_ALLOC_P (scop_p, heap);
36
37 typedef ppl_dimension_type graphite_dim_t;
38
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);
42
43 /* A data reference can write or read some memory or we
44    just know it may write some memory.  */
45 enum POLY_DR_TYPE
46 {
47   PDR_READ,
48   /* PDR_MAY_READs are represented using PDR_READS. This does not limit the
49      expressiveness.  */
50   PDR_WRITE,
51   PDR_MAY_WRITE
52 };
53
54 struct poly_dr
55 {
56   /* An identifier for this PDR.  */
57   int id;
58
59   /* A pointer to compiler's data reference description.  */
60   void *compiler_dr;
61
62   /* A pointer to the PBB that contains this data reference.  */
63   poly_bb_p pbb;
64
65   enum POLY_DR_TYPE type;
66
67   /* The access polyhedron contains the polyhedral space this data
68      reference will access.
69
70      The polyhedron contains these dimensions:
71
72       - The alias set (a):
73       Every memory access is classified in at least one alias set.
74
75       - The subscripts (s_0, ..., s_n):
76       The memory is accessed using zero or more subscript dimensions.
77
78       - The iteration domain (variables and parameters)
79
80      Do not hardcode the dimensions.  Use the following accessor functions:
81      - pdr_alias_set_dim
82      - pdr_subscript_dim
83      - pdr_iterator_dim
84      - pdr_parameter_dim
85
86      Example:
87
88      | int A[1335][123];
89      | int *p = malloc ();
90      |
91      | k = ...
92      | for i
93      |   {
94      |     if (unknown_function ())
95      |       p = A;
96      |       ... = p[?][?];
97      |     for j
98      |       A[i][j+k] = m;
99      |   }
100
101      The data access A[i][j+k] in alias set "5" is described like this:
102
103      | i   j   k   a  s0  s1   1
104      | 0   0   0   1   0   0  -5     =  0
105      |-1   0   0   0   1   0   0     =  0
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
111
112      The pointer "*p" in alias set "5" and "7" is described as a union of
113      polyhedron:
114
115
116      | i   k   a  s0   1
117      | 0   0   1   0  -5   =  0
118      | 0   0   0   1   0   >= 0
119
120      "or"
121
122      | i   k   a  s0   1
123      | 0   0   1   0  -7   =  0
124      | 0   0   0   1   0   >= 0
125
126      "*p" accesses all of the object allocated with 'malloc'.
127
128      The scalar data access "m" is represented as an array with zero subscript
129      dimensions.
130
131      | i   j   k   a   1
132      | 0   0   0  -1   15  = 0 */
133   ppl_Pointset_Powerset_C_Polyhedron_t accesses;
134
135   /* The number of subscripts.  */
136   graphite_dim_t nb_subscripts;
137 };
138
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)
145
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);
152
153 /* The dimension of the PDR_ACCESSES polyhedron of PDR.  */
154
155 static inline ppl_dimension_type
156 pdr_dim (poly_dr_p pdr)
157 {
158   ppl_dimension_type dim;
159   ppl_Pointset_Powerset_C_Polyhedron_space_dimension (PDR_ACCESSES (pdr),
160                                                       &dim);
161   return dim;
162 }
163
164 /* The dimension of the iteration domain of the scop of PDR.  */
165
166 static inline ppl_dimension_type
167 pdr_dim_iter_domain (poly_dr_p pdr)
168 {
169   return pbb_dim_iter_domain (PDR_PBB (pdr));
170 }
171
172 /* The number of parameters of the scop of PDR.  */
173
174 static inline ppl_dimension_type
175 pdr_nb_params (poly_dr_p pdr)
176 {
177   return scop_nb_params (pdr_scop (pdr));
178 }
179
180 /* The dimension of the alias set in PDR.  */
181
182 static inline ppl_dimension_type
183 pdr_alias_set_dim (poly_dr_p pdr)
184 {
185   poly_bb_p pbb = PDR_PBB (pdr);
186
187   return pbb_dim_iter_domain (pbb) + pbb_nb_params (pbb);
188 }
189
190 /* The dimension in PDR containing subscript S.  */
191
192 static inline ppl_dimension_type
193 pdr_subscript_dim (poly_dr_p pdr, graphite_dim_t s)
194 {
195   poly_bb_p pbb = PDR_PBB (pdr);
196
197   return pbb_dim_iter_domain (pbb) + pbb_nb_params (pbb) + 1 + s;
198 }
199
200 /* The dimension in PDR containing the loop iterator ITER.  */
201
202 static inline ppl_dimension_type
203 pdr_iterator_dim (poly_dr_p pdr ATTRIBUTE_UNUSED, graphite_dim_t iter)
204 {
205   return iter;
206 }
207
208 /* The dimension in PDR containing parameter PARAM.  */
209
210 static inline ppl_dimension_type
211 pdr_parameter_dim (poly_dr_p pdr, graphite_dim_t param)
212 {
213   poly_bb_p pbb = PDR_PBB (pdr);
214
215   return pbb_dim_iter_domain (pbb) + param;
216 }
217
218 typedef struct poly_scattering *poly_scattering_p;
219
220 struct poly_scattering
221 {
222   /* The scattering function containing the transformations.  */
223   ppl_Polyhedron_t scattering;
224
225   /* The number of local variables.  */
226   int nb_local_variables;
227
228   /* The number of scattering dimensions.  */
229   int nb_scattering;
230 };
231
232 /* POLY_BB represents a blackbox in the polyhedral model.  */
233
234 struct poly_bb
235 {
236   void *black_box;
237
238   scop_p scop;
239
240   /* The iteration domain of this bb.
241      Example:
242
243      for (i = a - 7*b + 8; i <= 3*a + 13*b + 20; i++)
244        for (j = 2; j <= 2*i + 5; j++)
245          for (k = 0; k <= 5; k++)
246            S (i,j,k)
247
248      Loop iterators: i, j, k
249      Parameters: a, b
250
251      | i >=  a -  7b +  8
252      | i <= 3a + 13b + 20
253      | j >= 2
254      | j <= 2i + 5
255      | k >= 0
256      | k <= 5
257
258      The number of variables in the DOMAIN may change and is not
259      related to the number of loops in the original code.  */
260   ppl_Pointset_Powerset_C_Polyhedron_t domain;
261
262   /* The data references we access.  */
263   VEC (poly_dr_p, heap) *drs;
264
265   /* The original scattering.  */
266   poly_scattering_p original;
267
268   /* The transformed scattering.  */
269   poly_scattering_p transformed;
270
271   /* A copy of the transformed scattering.  */
272   poly_scattering_p saved;
273 };
274
275 #define PBB_BLACK_BOX(PBB) ((gimple_bb_p) PBB->black_box)
276 #define PBB_SCOP(PBB) (PBB->scop)
277 #define PBB_DOMAIN(PBB) (PBB->domain)
278 #define PBB_DRS(PBB) (PBB->drs)
279 #define PBB_ORIGINAL(PBB) (PBB->original)
280 #define PBB_ORIGINAL_SCATTERING(PBB) (PBB->original->scattering)
281 #define PBB_TRANSFORMED(PBB) (PBB->transformed)
282 #define PBB_TRANSFORMED_SCATTERING(PBB) (PBB->transformed->scattering)
283 #define PBB_SAVED(PBB) (PBB->saved)
284 #define PBB_NB_LOCAL_VARIABLES(PBB) (PBB->transformed->nb_local_variables)
285 #define PBB_NB_SCATTERING_TRANSFORM(PBB) (PBB->transformed->nb_scattering)
286
287 extern void new_poly_bb (scop_p, void *);
288 extern void free_poly_bb (poly_bb_p);
289 extern void debug_loop_vec (poly_bb_p);
290 extern void schedule_to_scattering (poly_bb_p, int);
291 extern void print_pbb_domain (FILE *, poly_bb_p);
292 extern void print_pbb (FILE *, poly_bb_p);
293 extern void print_scop_context (FILE *, scop_p);
294 extern void print_scop (FILE *, scop_p);
295 extern void debug_pbb_domain (poly_bb_p);
296 extern void debug_pbb (poly_bb_p);
297 extern void print_pdrs (FILE *, poly_bb_p);
298 extern void debug_pdrs (poly_bb_p);
299 extern void debug_scop_context (scop_p);
300 extern void debug_scop (scop_p);
301 extern void print_scop_params (FILE *, scop_p);
302 extern void debug_scop_params (scop_p);
303 extern void print_iteration_domain (FILE *, poly_bb_p);
304 extern void print_iteration_domains (FILE *, scop_p);
305 extern void debug_iteration_domain (poly_bb_p);
306 extern void debug_iteration_domains (scop_p);
307 extern bool scop_do_interchange (scop_p);
308 extern bool scop_do_strip_mine (scop_p);
309 extern void pbb_number_of_iterations (poly_bb_p, graphite_dim_t, Value);
310
311 /* The index of the PBB.  */
312
313 static inline int
314 pbb_index (poly_bb_p pbb)
315 {
316   return GBB_BB (PBB_BLACK_BOX (pbb))->index;
317 }
318
319 /* The scop that contains the PDR.  */
320
321 static inline scop_p
322 pdr_scop (poly_dr_p pdr)
323 {
324   return PBB_SCOP (PDR_PBB (pdr));
325 }
326
327 /* Set black box of PBB to BLACKBOX.  */
328
329 static inline void
330 pbb_set_black_box (poly_bb_p pbb, void *black_box)
331 {
332   pbb->black_box = black_box;
333 }
334
335 /* The number of loops around PBB: the dimension of the iteration
336    domain.  */
337
338 static inline graphite_dim_t
339 pbb_dim_iter_domain (const struct poly_bb *pbb)
340 {
341   scop_p scop = PBB_SCOP (pbb);
342   ppl_dimension_type dim;
343
344   ppl_Pointset_Powerset_C_Polyhedron_space_dimension (PBB_DOMAIN (pbb), &dim);
345   return dim - scop_nb_params (scop);
346 }
347
348 /* The number of params defined in PBB.  */
349
350 static inline graphite_dim_t
351 pbb_nb_params (const struct poly_bb *pbb)
352 {
353   scop_p scop = PBB_SCOP (pbb);
354
355   return scop_nb_params (scop);
356 }
357
358 /* The number of scattering dimensions in the SCATTERING polyhedron
359    of a PBB for a given SCOP.  */
360
361 static inline graphite_dim_t
362 pbb_nb_scattering_orig (const struct poly_bb *pbb)
363 {
364   return 2 * pbb_dim_iter_domain (pbb) + 1;
365 }
366
367 /* The number of scattering dimensions in PBB.  */
368
369 static inline graphite_dim_t
370 pbb_nb_scattering_transform (const struct poly_bb *pbb)
371 {
372   return PBB_NB_SCATTERING_TRANSFORM (pbb);
373 }
374
375 /* Returns the number of local variables used in the transformed
376    scattering polyhedron of PBB.  */
377
378 static inline graphite_dim_t
379 pbb_nb_local_vars (const struct poly_bb *pbb)
380 {
381   /* For now we do not have any local variables, as we do not do strip
382      mining for example.  */
383   return PBB_NB_LOCAL_VARIABLES (pbb);
384 }
385
386 /* The dimension in the domain of PBB containing the iterator ITER.  */
387
388 static inline ppl_dimension_type
389 pbb_iterator_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t iter)
390 {
391   return iter;
392 }
393
394 /* The dimension in the domain of PBB containing the iterator ITER.  */
395
396 static inline ppl_dimension_type
397 pbb_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
398 {
399   return param
400     + pbb_dim_iter_domain (pbb);
401 }
402
403 /* The dimension in the original scattering polyhedron of PBB
404    containing the scattering iterator SCATTER.  */
405
406 static inline ppl_dimension_type
407 psco_scattering_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t scatter)
408 {
409   gcc_assert (scatter < pbb_nb_scattering_orig (pbb));
410   return scatter;
411 }
412
413 /* The dimension in the transformed scattering polyhedron of PBB
414    containing the scattering iterator SCATTER.  */
415
416 static inline ppl_dimension_type
417 psct_scattering_dim (poly_bb_p pbb ATTRIBUTE_UNUSED, graphite_dim_t scatter)
418 {
419   gcc_assert (scatter <= pbb_nb_scattering_transform (pbb));
420   return scatter;
421 }
422
423 ppl_dimension_type psct_scattering_dim_for_loop_depth (poly_bb_p,
424                                                        graphite_dim_t);
425
426 /* The dimension in the transformed scattering polyhedron of PBB of
427    the local variable LV.  */
428
429 static inline ppl_dimension_type
430 psct_local_var_dim (poly_bb_p pbb, graphite_dim_t lv)
431 {
432   gcc_assert (lv <= pbb_nb_local_vars (pbb));
433   return lv + pbb_nb_scattering_transform (pbb);
434 }
435
436 /* The dimension in the original scattering polyhedron of PBB
437    containing the loop iterator ITER.  */
438
439 static inline ppl_dimension_type
440 psco_iterator_dim (poly_bb_p pbb, graphite_dim_t iter)
441 {
442   gcc_assert (iter < pbb_dim_iter_domain (pbb));
443   return iter + pbb_nb_scattering_orig (pbb);
444 }
445
446 /* The dimension in the transformed scattering polyhedron of PBB
447    containing the loop iterator ITER.  */
448
449 static inline ppl_dimension_type
450 psct_iterator_dim (poly_bb_p pbb, graphite_dim_t iter)
451 {
452   gcc_assert (iter < pbb_dim_iter_domain (pbb));
453   return iter
454     + pbb_nb_scattering_transform (pbb)
455     + pbb_nb_local_vars (pbb);
456 }
457
458 /* The dimension in the original scattering polyhedron of PBB
459    containing parameter PARAM.  */
460
461 static inline ppl_dimension_type
462 psco_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
463 {
464   gcc_assert (param < pbb_nb_params (pbb));
465   return param
466     + pbb_nb_scattering_orig (pbb)
467     + pbb_dim_iter_domain (pbb);
468 }
469
470 /* The dimension in the transformed scattering polyhedron of PBB
471    containing parameter PARAM.  */
472
473 static inline ppl_dimension_type
474 psct_parameter_dim (poly_bb_p pbb, graphite_dim_t param)
475 {
476   gcc_assert (param < pbb_nb_params (pbb));
477   return param
478     + pbb_nb_scattering_transform (pbb)
479     + pbb_nb_local_vars (pbb)
480     + pbb_dim_iter_domain (pbb);
481 }
482
483 /* Adds to the transformed scattering polyhedron of PBB a new local
484    variable and returns its index.  */
485
486 static inline graphite_dim_t
487 psct_add_local_variable (poly_bb_p pbb)
488 {
489   graphite_dim_t nlv = pbb_nb_local_vars (pbb);
490   ppl_dimension_type lv_column = psct_local_var_dim (pbb, nlv);
491   ppl_insert_dimensions (PBB_TRANSFORMED_SCATTERING (pbb), lv_column, 1);
492   PBB_NB_LOCAL_VARIABLES (pbb) += 1;
493   return nlv;
494 }
495
496 /* Adds a dimension to the transformed scattering polyhedron of PBB at
497    INDEX.  */
498
499 static inline void
500 psct_add_scattering_dimension (poly_bb_p pbb, ppl_dimension_type index)
501 {
502   gcc_assert (index < pbb_nb_scattering_transform (pbb));
503
504   ppl_insert_dimensions (PBB_TRANSFORMED_SCATTERING (pbb), index, 1);
505   PBB_NB_SCATTERING_TRANSFORM (pbb) += 1;
506 }
507
508 /* A SCOP is a Static Control Part of the program, simple enough to be
509    represented in polyhedral form.  */
510 struct scop
511 {
512   /* A SCOP is defined as a SESE region.  */
513   void *region;
514
515   /* Number of parameters in SCoP.  */
516   graphite_dim_t nb_params;
517
518   /* All the basic blocks in this scop that contain memory references
519      and that will be represented as statements in the polyhedral
520      representation.  */
521   VEC (poly_bb_p, heap) *bbs;
522
523   /* Data dependence graph for this SCoP.  */
524   struct graph *dep_graph;
525
526   /* The context describes known restrictions concerning the parameters
527      and relations in between the parameters.
528
529   void f (int8_t a, uint_16_t b) {
530     c = 2 a + b;
531     ...
532   }
533
534   Here we can add these restrictions to the context:
535
536   -128 >= a >= 127
537      0 >= b >= 65,535
538      c = 2a + b  */
539   ppl_Pointset_Powerset_C_Polyhedron_t context;
540
541   /* A hashtable of the data dependence relations for the original
542      scattering.  */
543   htab_t original_pddrs;
544 };
545
546 #define SCOP_BBS(S) (S->bbs)
547 #define SCOP_REGION(S) ((sese) S->region)
548 #define SCOP_DEP_GRAPH(S) (S->dep_graph)
549 #define SCOP_CONTEXT(S) (S->context)
550 #define SCOP_ORIGINAL_PDDRS(S) (S->original_pddrs)
551
552 extern scop_p new_scop (void *);
553 extern void free_scop (scop_p);
554 extern void free_scops (VEC (scop_p, heap) *);
555 extern void print_generated_program (FILE *, scop_p);
556 extern void debug_generated_program (scop_p);
557 extern void print_scattering_function (FILE *, poly_bb_p);
558 extern void print_scattering_functions (FILE *, scop_p);
559 extern void debug_scattering_function (poly_bb_p);
560 extern void debug_scattering_functions (scop_p);
561 extern int scop_max_loop_depth (scop_p);
562 extern int unify_scattering_dimensions (scop_p);
563 extern bool apply_poly_transforms (scop_p);
564 extern bool graphite_legal_transform (scop_p);
565
566 /* Set the region of SCOP to REGION.  */
567
568 static inline void
569 scop_set_region (scop_p scop, void *region)
570 {
571   scop->region = region;
572 }
573
574 /* Returns the number of parameters for SCOP.  */
575
576 static inline graphite_dim_t
577 scop_nb_params (scop_p scop)
578 {
579   return scop->nb_params;
580 }
581
582 /* Set the number of params of SCOP to NB_PARAMS.  */
583
584 static inline void
585 scop_set_nb_params (scop_p scop, graphite_dim_t nb_params)
586 {
587   scop->nb_params = nb_params;
588 }
589
590 /* Allocates a new empty poly_scattering structure.  */
591
592 static inline poly_scattering_p
593 poly_scattering_new (void)
594 {
595   poly_scattering_p res = XNEW (struct poly_scattering);
596
597   res->scattering = NULL;
598   res->nb_local_variables = 0;
599   res->nb_scattering = 0;
600   return res;
601 }
602
603 /* Free a poly_scattering structure.  */
604
605 static inline void
606 poly_scattering_free (poly_scattering_p s)
607 {
608   ppl_delete_Polyhedron (s->scattering);
609   free (s);
610 }
611
612 /* Copies S and return a new scattering.  */
613
614 static inline poly_scattering_p
615 poly_scattering_copy (poly_scattering_p s)
616 {
617   poly_scattering_p res = poly_scattering_new ();
618
619   ppl_new_C_Polyhedron_from_C_Polyhedron (&(res->scattering), s->scattering);
620   res->nb_local_variables = s->nb_local_variables;
621   res->nb_scattering = s->nb_scattering;
622   return res;
623 }
624
625 /* Saves the transformed scattering of PBB.  */
626
627 static inline void
628 store_scattering_pbb (poly_bb_p pbb)
629 {
630   gcc_assert (PBB_TRANSFORMED (pbb));
631
632   if (PBB_SAVED (pbb))
633     poly_scattering_free (PBB_SAVED (pbb));
634
635   PBB_SAVED (pbb) = poly_scattering_copy (PBB_TRANSFORMED (pbb));
636 }
637
638 /* Saves the scattering for all the pbbs in the SCOP.  */
639
640 static inline void
641 store_scattering (scop_p scop)
642 {
643   int i;
644   poly_bb_p pbb;
645
646   for (i = 0; VEC_iterate (poly_bb_p, SCOP_BBS (scop), i, pbb); i++)
647     store_scattering_pbb (pbb);
648 }
649
650 /* Restores the scattering of PBB.  */
651
652 static inline void
653 restore_scattering_pbb (poly_bb_p pbb)
654 {
655   gcc_assert (PBB_SAVED (pbb));
656
657   poly_scattering_free (PBB_TRANSFORMED (pbb));
658   PBB_TRANSFORMED (pbb) = poly_scattering_copy (PBB_SAVED (pbb));
659 }
660
661 /* Restores the scattering for all the pbbs in the SCOP.  */
662
663 static inline void
664 restore_scattering (scop_p scop)
665 {
666   int i;
667   poly_bb_p pbb;
668
669   for (i = 0; VEC_iterate (poly_bb_p, SCOP_BBS (scop), i, pbb); i++)
670     restore_scattering_pbb (pbb);
671 }
672
673 #endif