gcc/graphite.h

   1 /* Gimple Represented as Polyhedra.
   2    Copyright (C) 2006, 2007, 2008  Free Software Foundation, Inc.
   3    Contributed by Sebastian Pop <sebastian.pop@inria.fr>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3, or (at your option)
  10 any later version.
  11
  12 GCC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_GRAPHITE_H
  22 #define GCC_GRAPHITE_H
  23
  24 #include "tree-data-ref.h"
  25
  26 typedef struct graphite_bb *graphite_bb_p;
  27 DEF_VEC_P(graphite_bb_p);
  28 DEF_VEC_ALLOC_P (graphite_bb_p, heap);
  29
  30 DEF_VEC_P(scop_p);
  31 DEF_VEC_ALLOC_P (scop_p, heap);
  32
  33 static inline int scop_nb_loops (scop_p scop);
  34 static inline unsigned scop_nb_params (scop_p scop);
  35 static inline bool scop_contains_loop (scop_p scop, struct loop *loop);
  36
  37 typedef struct graphite_bb
  38 {
  39   basic_block bb;
  40   scop_p scop;
  41
  42   /* The static schedule contains the textual order for every loop layer.
  43
  44      Example:
  45
  46      S0
  47      for (i ...)
  48        {
  49          S1
  50          for (j ...)
  51            {
  52              S2
  53              S3
  54            }
  55          S4
  56        }
  57      S5
  58      for (k ...)
  59        {
  60          S6
  61          S7
  62          for (l ...)
  63            {
  64              S8
  65            }
  66          S9
  67        }
  68      S10
  69
  70      Schedules:
  71
  72         | Depth
  73      BB | 0  1  2
  74      ------------
  75      S0 | 0
  76      S1 | 1, 0
  77      S2 | 1, 1, 0
  78      S3 | 1, 1, 1
  79      S4 | 1, 2
  80      S5 | 2
  81      S6 | 3, 0
  82      S7 | 3, 1
  83      S8 | 3, 2, 0
  84      S9 | 3, 3
  85      S10| 4
  86
  87    Normalization rules:
  88      - One SCoP can never contain two bbs with the same schedule timestamp.
  89      - All bbs at the same loop depth have a consecutive ordering (no gaps). */
  90   lambda_vector static_schedule;
  91
  92   /* The iteration domain of this bb. It contains this columns:
  93      - In/Eq: If this line is a equation or inequation.
  94      - For every loop iterator one column.
  95      - One column for every parameter in this SCoP.
  96      - The constant column to add integers to the (in)equations.
  97
  98      Example:
  99
 100      for (i = a - 7*b + 8; i <= 3*a + 13*b + 20; i++)
 101        for (j = 2; j <= 2*i + 5; j++)
 102          for (k = 0; k <= 5; k++)
 103            S (i,j,k)
 104
 105      Loop iterators: i, j, k
 106      Parameters: a, b
 107
 108      (I)eq   i   j   k   a   b   1
 109
 110      1       1   0   0  -1   7   -8    #  i >=  a -  7b +  8
 111      1      -1   0   0   3   13  20    #  i <= 3a + 13b + 20
 112      1       0   1   0   0   0   -2    #  j >= 2
 113      1       2  -1   0   0   0    5    #  j <= 2i + 5
 114      1       0   0   1   0   0    0    #  k >= 0
 115      1       0   0  -1   0   0    5    #  k <= 5
 116
 117      The number of loop iterators may change and is not connected to the
 118      number of loops, that surrounded this bb in the gimple code. */
 119    CloogMatrix *domain;
 120
 121   /* Lists containing the restrictions of the conditional statements
 122      dominating this bb.  This bb can only be executed, if all conditions
 123      are true.
 124
 125      Example:
 126
 127      for (i = 0; i <= 20; i++)
 128      {
 129        A
 130
 131        if (2i <= 8)
 132          B
 133      }
 134
 135      So for B there is an additional condition (2i <= 8).
 136
 137      TODO: Add these restrictions to the domain matrix.
 138
 139      List of COND_EXPR and SWITCH_EXPR.  A COND_EXPR is true only if the
 140      corresponding element in CONDITION_CASES is not NULL_TREE.  For a
 141      SWITCH_EXPR the corresponding element in CONDITION_CASES is a
 142      CASE_LABEL_EXPR.  */
 143   VEC (gimple, heap) *conditions;
 144   VEC (gimple, heap) *condition_cases;
 145
 146   /* LOOPS contains for every column in the graphite domain the corresponding
 147      gimple loop. If there exists no corresponding gimple loop LOOPS contains
 148      NULL.
 149
 150      Example:
 151
 152      Original code:
 153
 154      for (i = 0; i <= 20; i++)
 155        for (j = 5; j <= 10; j++)
 156          A
 157
 158      Original domain:
 159
 160      (I)eq  i  j  1
 161      1      1  0  0   # i >= 0
 162      1     -1  0  20  # i <= 20
 163      1      0  1  0   # j >= 0
 164      1      0 -1  10  # j <= 10
 165
 166      Original loops vector:
 167      0         1
 168      Loop i    Loop j
 169
 170      After some changes (Exchange i and j, strip-mine i):
 171
 172      Domain:
 173
 174      (I)eq  j  ii i  k  1
 175      1      0  0  1  0  0   # i >= 0
 176      1      0  0 -1  0  20  # i <= 20
 177      1      1  0  0  0  0   # j >= 0
 178      1     -1  0  0  0  10  # j <= 10
 179      1      0 -1  1  0  0   # ii <= i
 180      1      0  1 -1  0  1   # ii + 1 >= i
 181      1      0 -1  0  2  0   # ii <= 2k
 182      1      0  1  0 -2  0   # ii >= 2k
 183
 184      Iterator vector:
 185      0        1        2         3
 186      Loop j   NULL     Loop i    NULL
 187
 188      Means the original loop i is now at column two of the domain and
 189      loop j in the original loop nest is now at column 0.  Column 1 and
 190      3 are emtpy.  */
 191   VEC (loop_p, heap) *loops;
 192
 193   lambda_vector compressed_alpha_matrix;
 194   CloogMatrix *dynamic_schedule;
 195   VEC (data_reference_p, heap) *data_refs;
 196 } *gbb_p;
 197
 198 #define GBB_BB(GBB) GBB->bb
 199 #define GBB_SCOP(GBB) GBB->scop
 200 #define GBB_STATIC_SCHEDULE(GBB) GBB->static_schedule
 201 #define GBB_DATA_REFS(GBB) GBB->data_refs
 202 #define GBB_ALPHA(GBB) GBB->compressed_alpha_matrix
 203 #define GBB_DYNAMIC_SCHEDULE(GBB) GBB->dynamic_schedule
 204 #define GBB_DOMAIN(GBB) GBB->domain
 205 #define GBB_CONDITIONS(GBB) GBB->conditions
 206 #define GBB_CONDITION_CASES(GBB) GBB->condition_cases
 207 #define GBB_LOOPS(GBB) GBB->loops
 208
 209 /* Return the loop that contains the basic block GBB.  */
 210
 211 static inline struct loop *
 212 gbb_loop (struct graphite_bb *gbb)
 213 {
 214   return GBB_BB (gbb)->loop_father;
 215 }
 216
 217 /* Calculate the number of loops around GB in the current SCOP.  Only
 218    works if GBB_DOMAIN is built.  */
 219
 220 static inline int
 221 gbb_nb_loops (const struct graphite_bb *gb)
 222 {
 223   scop_p scop = GBB_SCOP (gb);
 224
 225   if (GBB_DOMAIN (gb) == NULL)
 226     return 0;
 227
 228   return GBB_DOMAIN (gb)->NbColumns - scop_nb_params (scop) - 2;
 229 }
 230
 231 /* Returns the gimple loop, that corresponds to the loop_iterator_INDEX.
 232    If there is no corresponding gimple loop, we return NULL.  */
 233
 234 static inline loop_p
 235 gbb_loop_at_index (graphite_bb_p gb, int index)
 236 {
 237   return VEC_index (loop_p, GBB_LOOPS (gb), index);
 238 }
 239
 240 /* Returns the index of LOOP in the loop nest around GB.  */
 241
 242 static inline int
 243 gbb_loop_index (graphite_bb_p gb, loop_p loop)
 244 {
 245   int i;
 246   loop_p l;
 247
 248   for (i = 0; VEC_iterate (loop_p, GBB_LOOPS (gb), i, l); i++)
 249     if (loop == l)
 250       return i;
 251
 252   gcc_unreachable();
 253 }
 254
 255 struct loop_to_cloog_loop_str
 256 {
 257   unsigned int loop_num;
 258   unsigned int loop_position; /* The column that represents this loop.  */
 259   CloogLoop *cloog_loop;
 260 };
 261
 262 typedef struct name_tree
 263 {
 264   tree t;
 265   const char *name;
 266   struct loop *loop;
 267 } *name_tree;
 268
 269 DEF_VEC_P(name_tree);
 270 DEF_VEC_ALLOC_P (name_tree, heap);
 271
 272 /* A Single Entry, Single Exit region is a part of the CFG delimited
 273    by two edges.  */
 274 typedef struct sese
 275 {
 276   edge entry, exit;
 277 } *sese;
 278
 279 #define SESE_ENTRY(S) (S->entry)
 280 #define SESE_EXIT(S) (S->exit)
 281
 282 /* A SCOP is a Static Control Part of the program, simple enough to be
 283    represented in polyhedral form.  */
 284 struct scop
 285 {
 286   /* A SCOP is defined as a SESE region.  */
 287   sese region;
 288
 289   /* All the basic blocks in this scop.  They have extra information
 290      attached to them, in the graphite_bb structure.  */
 291   VEC (graphite_bb_p, heap) *bbs;
 292
 293   /* Set for a basic block index when it belongs to this SCOP.  */
 294   bitmap bbs_b;
 295
 296   lambda_vector static_schedule;
 297
 298   /* Parameters used within the SCOP.  */
 299   VEC (name_tree, heap) *params;
 300
 301   /* A collection of old induction variables*/
 302   VEC (name_tree, heap) *old_ivs;
 303
 304   /* Loops completely contained in the SCOP.  */
 305   bitmap loops;
 306   VEC (loop_p, heap) *loop_nest;
 307
 308   /* ???  It looks like a global mapping loop_id -> cloog_loop would work.  */
 309   htab_t loop2cloog_loop;
 310
 311   /* Cloog representation of this scop.  */
 312   CloogProgram *program;
 313
 314   /* Are we allowed to add more params?  This is for debugging purpose.  We
 315      can only add new params before generating the bb domains, otherwise they
 316      become invalid.  */
 317   bool add_params;
 318 };
 319
 320 #define SCOP_BBS(S) S->bbs
 321 #define SCOP_BBS_B(S) S->bbs_b
 322 #define SCOP_REGION(S) S->region
 323 /* SCOP_ENTRY bb dominates all the bbs of the scop.  SCOP_EXIT bb
 324    post-dominates all the bbs of the scop.  SCOP_EXIT potentially
 325    contains non affine data accesses, side effect statements or
 326    difficult constructs, and thus is not considered part of the scop,
 327    but just a boundary.  SCOP_ENTRY is considered part of the scop.  */
 328 #define SCOP_ENTRY(S) (SESE_ENTRY (SCOP_REGION (S))->dest)
 329 #define SCOP_EXIT(S) (SESE_EXIT (SCOP_REGION (S))->dest)
 330 #define SCOP_STATIC_SCHEDULE(S) S->static_schedule
 331 #define SCOP_LOOPS(S) S->loops
 332 #define SCOP_LOOP_NEST(S) S->loop_nest
 333 #define SCOP_ADD_PARAMS(S) S->add_params
 334 #define SCOP_PARAMS(S) S->params
 335 #define SCOP_OLDIVS(S) S->old_ivs
 336 #define SCOP_PROG(S) S->program
 337 #define SCOP_LOOP2CLOOG_LOOP(S) S->loop2cloog_loop
 338 #define SCOP_LOOPS_MAPPING(S) S->loops_mapping
 339
 340 extern void debug_scop (scop_p, int);
 341 extern void debug_scops (int);
 342 extern void print_graphite_bb (FILE *, graphite_bb_p, int, int);
 343 extern void debug_gbb (graphite_bb_p, int);
 344 extern void dot_scop (scop_p);
 345 extern void dot_all_scops (void);
 346 extern void debug_clast_stmt (struct clast_stmt *);
 347 extern void debug_rename_map (htab_t);
 348 extern void debug_loop_vec (graphite_bb_p gb);
 349 extern void debug_oldivs (scop_p);
 350
 351 /* Describes the type of an iv stack entry.  */
 352 typedef enum {
 353   iv_stack_entry_unknown = 0,
 354   iv_stack_entry_iv,
 355   iv_stack_entry_const
 356 } iv_stack_entry_kind;
 357
 358 /* Data contained in an iv stack entry.  */
 359 typedef union iv_stack_entry_data_union
 360 {
 361   name_tree iv;
 362   tree constant;
 363 } iv_stack_entry_data;
 364
 365 /* Datatype for loop iv stack entry.  */
 366 typedef struct iv_stack_entry_struct
 367 {
 368   iv_stack_entry_kind kind;
 369   iv_stack_entry_data data;
 370 } iv_stack_entry;
 371
 372 typedef iv_stack_entry *iv_stack_entry_p;
 373
 374 DEF_VEC_P(iv_stack_entry_p);
 375 DEF_VEC_ALLOC_P(iv_stack_entry_p,heap);
 376
 377 typedef VEC(iv_stack_entry_p, heap) **loop_iv_stack;
 378 extern void debug_loop_iv_stack (loop_iv_stack);
 379
 380 /* Return the number of gimple loops contained in SCOP.  */
 381
 382 static inline int
 383 scop_nb_loops (scop_p scop)
 384 {
 385   return VEC_length (loop_p, SCOP_LOOP_NEST (scop));
 386 }
 387
 388 /* Returns the number of parameters for SCOP.  */
 389
 390 static inline unsigned
 391 scop_nb_params (scop_p scop)
 392 {
 393   return VEC_length (name_tree, SCOP_PARAMS (scop));
 394 }
 395
 396 /* Return the dimension of the domains for SCOP.  */
 397
 398 static inline int
 399 scop_dim_domain (scop_p scop)
 400 {
 401   return scop_nb_loops (scop) + scop_nb_params (scop) + 1;
 402 }
 403
 404 /* Return the dimension of the domains for GB.  */
 405
 406 static inline int
 407 gbb_dim_domain (graphite_bb_p gb)
 408 {
 409   return scop_dim_domain (GBB_SCOP (gb));
 410 }
 411
 412 /* Returns the dimensionality of a loop iteration domain for a given
 413    loop, identified by LOOP_NUM, with respect to SCOP.  */
 414
 415 static inline int
 416 loop_domain_dim (unsigned int loop_num, scop_p scop)
 417 {
 418   struct loop_to_cloog_loop_str tmp, *slot;
 419   htab_t tab = SCOP_LOOP2CLOOG_LOOP (scop);
 420
 421   tmp.loop_num = loop_num;
 422   slot = (struct loop_to_cloog_loop_str *) htab_find (tab, &tmp);
 423
 424   /* The loop containing the entry of the scop is not always part of
 425      the SCoP, and it is not registered in SCOP_LOOP2CLOOG_LOOP.  */
 426   if (!slot)
 427     return scop_nb_params (scop) + 2;
 428
 429   return cloog_domain_dim (cloog_loop_domain (slot->cloog_loop)) + 2;
 430 }
 431
 432 /* Returns the dimensionality of a loop iteration vector in a loop
 433    iteration domain for a given loop (identified by LOOP_NUM) with
 434    respect to SCOP.  */
 435
 436 static inline int
 437 loop_iteration_vector_dim (unsigned int loop_num, scop_p scop)
 438 {
 439   return loop_domain_dim (loop_num, scop) - 2 - scop_nb_params (scop);
 440 }
 441
 442 /* Checks, if SCOP contains LOOP.  */
 443
 444 static inline bool
 445 scop_contains_loop (scop_p scop, struct loop *loop)
 446 {
 447   return bitmap_bit_p (SCOP_LOOPS (scop), loop->num);
 448 }
 449
 450 /* Returns the index of LOOP in the domain matrix for the SCOP.  */
 451
 452 static inline int
 453 scop_loop_index (scop_p scop, struct loop *loop)
 454 {
 455   unsigned i;
 456   struct loop *l;
 457
 458   gcc_assert (scop_contains_loop (scop, loop));
 459
 460   for (i = 0; VEC_iterate (loop_p, SCOP_LOOP_NEST (scop), i, l); i++)
 461     if (l == loop)
 462       return i;
 463
 464   gcc_unreachable();
 465 }
 466
 467 /* Return the index of innermost loop that contains the basic block
 468    GBB.  */
 469
 470 static inline int
 471 gbb_inner_most_loop_index (scop_p scop, graphite_bb_p gb)
 472 {
 473   return scop_loop_index(scop, gbb_loop (gb));
 474 }
 475
 476 /* Return the outermost loop that contains the loop LOOP.  The outer
 477    loops are searched until a sibling for the outer loop is found.  */
 478
 479 static struct loop *
 480 outer_most_loop_1 (scop_p scop, struct loop* loop, struct loop* current_outer)
 481 {
 482   return (!scop_contains_loop (scop, loop)) ? current_outer :
 483     (loop->next != NULL) ? loop :
 484     outer_most_loop_1 (scop, loop_outer (loop), loop);
 485 }
 486
 487 /* Return the outermost loop that contains the loop LOOP.  */
 488
 489 static struct loop *
 490 outer_most_loop (scop_p scop, struct loop *loop)
 491 {
 492   return outer_most_loop_1 (scop, loop, NULL);
 493 }
 494
 495 /* Return the index of the outermost loop that contains the basic
 496    block BB.  */
 497
 498 static inline int
 499 gbb_outer_most_loop_index (scop_p scop, graphite_bb_p gb)
 500 {
 501   return scop_loop_index (scop, outer_most_loop (scop, gbb_loop (gb)));
 502 }
 503
 504 /* Return the loop depth of LOOP in SCOP.  */
 505
 506 static inline unsigned int
 507 scop_gimple_loop_depth (scop_p scop, loop_p loop)
 508 {
 509   unsigned int depth = 0;
 510
 511   loop = loop_outer (loop);
 512
 513   while (scop_contains_loop (scop, loop))
 514     {
 515       depth++;
 516       loop = loop_outer (loop);
 517     }
 518
 519   return depth;
 520 }
 521
 522 /* Static inline function prototypes.  */
 523
 524 static inline unsigned scop_nb_params (scop_p scop);
 525
 526 /* Returns true when BB is in SCOP.  */
 527
 528 static inline bool
 529 bb_in_scop_p (basic_block bb, scop_p scop)
 530 {
 531   return bitmap_bit_p (SCOP_BBS_B (scop), bb->index);
 532 }
 533
 534 /* Returns true when LOOP is in SCOP.  */
 535
 536 static inline bool
 537 loop_in_scop_p (struct loop *loop, scop_p scop)
 538 {
 539   return (bb_in_scop_p (loop->header, scop)
 540           && bb_in_scop_p (loop->latch, scop));
 541 }
 542
 543 /* Calculate the number of loops around LOOP in the SCOP.  */
 544
 545 static inline int
 546 nb_loops_around_loop_in_scop (struct loop *l, scop_p scop)
 547 {
 548   int d = 0;
 549
 550   for (; loop_in_scop_p (l, scop); d++, l = loop_outer (l));
 551
 552   return d;
 553 }
 554
 555 /* Calculate the number of loops around GB in the current SCOP.  */
 556
 557 static inline int
 558 nb_loops_around_gb (graphite_bb_p gb)
 559 {
 560   return nb_loops_around_loop_in_scop (gbb_loop (gb), GBB_SCOP (gb));
 561 }
 562
 563 /* Returns the dimensionality of an enclosing loop iteration domain
 564    with respect to enclosing SCoP for a given data reference REF.  The
 565    returned dimensionality is homogeneous (depth of loop nest + number
 566    of SCoP parameters + const).  */
 567
 568 static inline int
 569 ref_nb_loops (data_reference_p ref)
 570 {
 571   loop_p loop = loop_containing_stmt (DR_STMT (ref));
 572   scop_p scop = DR_SCOP (ref);
 573
 574   return nb_loops_around_loop_in_scop (loop, scop) + scop_nb_params (scop) + 2;
 575 }
 576
 577 #endif  /* GCC_GRAPHITE_H  */