gcc/tree-vectorizer.h

   1 /* Loop Vectorization
   2    Copyright (C) 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   3    Contributed by Dorit Naishlos <dorit@il.ibm.com>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301, USA.  */
  21
  22 #ifndef GCC_TREE_VECTORIZER_H
  23 #define GCC_TREE_VECTORIZER_H
  24
  25 #ifdef USE_MAPPED_LOCATION
  26   typedef source_location LOC;
  27   #define UNKNOWN_LOC UNKNOWN_LOCATION
  28   #define EXPR_LOC(e) EXPR_LOCATION(e)
  29   #define LOC_FILE(l) LOCATION_FILE (l)
  30   #define LOC_LINE(l) LOCATION_LINE (l)
  31 #else
  32   typedef source_locus LOC;
  33   #define UNKNOWN_LOC NULL
  34   #define EXPR_LOC(e) EXPR_LOCUS(e)
  35   #define LOC_FILE(l) (l)->file
  36   #define LOC_LINE(l) (l)->line
  37 #endif
  38
  39 /* Used for naming of new temporaries.  */
  40 enum vect_var_kind {
  41   vect_simple_var,
  42   vect_pointer_var,
  43   vect_scalar_var
  44 };
  45
  46 /* Defines type of operation.  */
  47 enum operation_type {
  48   unary_op = 1,
  49   binary_op,
  50   ternary_op
  51 };
  52
  53 /* Define type of available alignment support.  */
  54 enum dr_alignment_support {
  55   dr_unaligned_unsupported,
  56   dr_unaligned_supported,
  57   dr_unaligned_software_pipeline,
  58   dr_aligned
  59 };
  60
  61 /* Define type of def-use cross-iteration cycle.  */
  62 enum vect_def_type {
  63   vect_constant_def,
  64   vect_invariant_def,
  65   vect_loop_def,
  66   vect_induction_def,
  67   vect_reduction_def,
  68   vect_unknown_def_type
  69 };
  70
  71 /* Define verbosity levels.  */
  72 enum verbosity_levels {
  73   REPORT_NONE,
  74   REPORT_VECTORIZED_LOOPS,
  75   REPORT_UNVECTORIZED_LOOPS,
  76   REPORT_ALIGNMENT,
  77   REPORT_DR_DETAILS,
  78   REPORT_BAD_FORM_LOOPS,
  79   REPORT_OUTER_LOOPS,
  80   REPORT_DETAILS,
  81   /* New verbosity levels should be added before this one.  */
  82   MAX_VERBOSITY_LEVEL
  83 };
  84
  85 /*-----------------------------------------------------------------*/
  86 /* Info on vectorized loops.                                       */
  87 /*-----------------------------------------------------------------*/
  88 typedef struct _loop_vec_info {
  89
  90   /* The loop to which this info struct refers to.  */
  91   struct loop *loop;
  92
  93   /* The loop basic blocks.  */
  94   basic_block *bbs;
  95
  96   /* The loop exit_condition.  */
  97   tree exit_cond;
  98
  99   /* Number of iterations.  */
 100   tree num_iters;
 101
 102   /* Minimum number of iterations below which vectorization is expected to
 103      not be profitable (as estimated by the cost model).
 104      -1 indicates that vectorization will not be profitable.
 105      FORNOW: This field is an int. Will be a tree in the future, to represent
 106              values unknown at compile time.  */
 107   int min_profitable_iters;
 108
 109   /* Is the loop vectorizable? */
 110   bool vectorizable;
 111
 112   /* Unrolling factor  */
 113   int vectorization_factor;
 114
 115   /* Unknown DRs according to which loop was peeled.  */
 116   struct data_reference *unaligned_dr;
 117
 118   /* peeling_for_alignment indicates whether peeling for alignment will take
 119      place, and what the peeling factor should be:
 120      peeling_for_alignment = X means:
 121         If X=0: Peeling for alignment will not be applied.
 122         If X>0: Peel first X iterations.
 123         If X=-1: Generate a runtime test to calculate the number of iterations
 124                  to be peeled, using the dataref recorded in the field
 125                  unaligned_dr.  */
 126   int peeling_for_alignment;
 127
 128   /* The mask used to check the alignment of pointers or arrays.  */
 129   int ptr_mask;
 130
 131   /* All data references in the loop.  */
 132   VEC (data_reference_p, heap) *datarefs;
 133
 134   /* All data dependences in the loop.  */
 135   VEC (ddr_p, heap) *ddrs;
 136
 137   /* Statements in the loop that have data references that are candidates for a
 138      runtime (loop versioning) misalignment check.  */
 139   VEC(tree,heap) *may_misalign_stmts;
 140
 141   /* The loop location in the source.  */
 142   LOC loop_line_number;
 143 } *loop_vec_info;
 144
 145 /* Access Functions.  */
 146 #define LOOP_VINFO_LOOP(L)            (L)->loop
 147 #define LOOP_VINFO_BBS(L)             (L)->bbs
 148 #define LOOP_VINFO_EXIT_COND(L)       (L)->exit_cond
 149 #define LOOP_VINFO_NITERS(L)          (L)->num_iters
 150 #define LOOP_VINFO_COST_MODEL_MIN_ITERS(L)      (L)->min_profitable_iters
 151 #define LOOP_VINFO_VECTORIZABLE_P(L)  (L)->vectorizable
 152 #define LOOP_VINFO_VECT_FACTOR(L)     (L)->vectorization_factor
 153 #define LOOP_VINFO_PTR_MASK(L)        (L)->ptr_mask
 154 #define LOOP_VINFO_DATAREFS(L)        (L)->datarefs
 155 #define LOOP_VINFO_DDRS(L)            (L)->ddrs
 156 #define LOOP_VINFO_INT_NITERS(L)      (TREE_INT_CST_LOW ((L)->num_iters))
 157 #define LOOP_PEELING_FOR_ALIGNMENT(L) (L)->peeling_for_alignment
 158 #define LOOP_VINFO_UNALIGNED_DR(L)    (L)->unaligned_dr
 159 #define LOOP_VINFO_MAY_MISALIGN_STMTS(L) (L)->may_misalign_stmts
 160 #define LOOP_VINFO_LOC(L)             (L)->loop_line_number
 161
 162 #define NITERS_KNOWN_P(n)                     \
 163 (host_integerp ((n),0)                        \
 164 && TREE_INT_CST_LOW ((n)) > 0)
 165
 166 #define LOOP_VINFO_NITERS_KNOWN_P(L)                     \
 167 NITERS_KNOWN_P((L)->num_iters)
 168
 169 /*-----------------------------------------------------------------*/
 170 /* Info on vectorized defs.                                        */
 171 /*-----------------------------------------------------------------*/
 172 enum stmt_vec_info_type {
 173   undef_vec_info_type = 0,
 174   load_vec_info_type,
 175   store_vec_info_type,
 176   op_vec_info_type,
 177   call_vec_info_type,
 178   assignment_vec_info_type,
 179   condition_vec_info_type,
 180   reduc_vec_info_type,
 181   induc_vec_info_type,
 182   type_promotion_vec_info_type,
 183   type_demotion_vec_info_type,
 184   type_conversion_vec_info_type
 185 };
 186
 187 /* Indicates whether/how a variable is used in the loop.  */
 188 enum vect_relevant {
 189   vect_unused_in_loop = 0,
 190
 191   /* defs that feed computations that end up (only) in a reduction. These
 192      defs may be used by non-reduction stmts, but eventually, any
 193      computations/values that are affected by these defs are used to compute
 194      a reduction (i.e. don't get stored to memory, for example). We use this
 195      to identify computations that we can change the order in which they are
 196      computed.  */
 197   vect_used_by_reduction,
 198
 199   vect_used_in_loop
 200 };
 201
 202 typedef struct data_reference *dr_p;
 203 DEF_VEC_P(dr_p);
 204 DEF_VEC_ALLOC_P(dr_p,heap);
 205
 206 typedef struct _stmt_vec_info {
 207
 208   enum stmt_vec_info_type type;
 209
 210   /* The stmt to which this info struct refers to.  */
 211   tree stmt;
 212
 213   /* The loop_vec_info with respect to which STMT is vectorized.  */
 214   loop_vec_info loop_vinfo;
 215
 216   /* Not all stmts in the loop need to be vectorized. e.g, the increment
 217      of the loop induction variable and computation of array indexes. relevant
 218      indicates whether the stmt needs to be vectorized.  */
 219   enum vect_relevant relevant;
 220
 221   /* Indicates whether this stmts is part of a computation whose result is
 222      used outside the loop.  */
 223   bool live;
 224
 225   /* The vector type to be used.  */
 226   tree vectype;
 227
 228   /* The vectorized version of the stmt.  */
 229   tree vectorized_stmt;
 230
 231
 232   /** The following is relevant only for stmts that contain a non-scalar
 233      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 234      at most one such data-ref.  **/
 235
 236   /* Information about the data-ref (access function, etc).  */
 237   struct data_reference *data_ref_info;
 238
 239   /* Stmt is part of some pattern (computation idiom)  */
 240   bool in_pattern_p;
 241
 242   /* Used for various bookkeeping purposes, generally holding a pointer to
 243      some other stmt S that is in some way "related" to this stmt.
 244      Current use of this field is:
 245         If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
 246         true): S is the "pattern stmt" that represents (and replaces) the
 247         sequence of stmts that constitutes the pattern.  Similarly, the
 248         related_stmt of the "pattern stmt" points back to this stmt (which is
 249         the last stmt in the original sequence of stmts that constitutes the
 250         pattern).  */
 251   tree related_stmt;
 252
 253   /* List of datarefs that are known to have the same alignment as the dataref
 254      of this stmt.  */
 255   VEC(dr_p,heap) *same_align_refs;
 256
 257   /* Classify the def of this stmt.  */
 258   enum vect_def_type def_type;
 259
 260   /* Interleaving info.  */
 261   /* First data-ref in the interleaving group.  */
 262   tree first_dr;
 263   /* Pointer to the next data-ref in the group.  */
 264   tree next_dr;
 265   /* The size of the interleaving group.  */
 266   unsigned int size;
 267   /* For stores, number of stores from this group seen. We vectorize the last
 268      one.  */
 269   unsigned int store_count;
 270   /* For loads only, the gap from the previous load. For consecutive loads, GAP
 271      is 1.  */
 272   unsigned int gap;
 273   /* In case that two or more stmts share data-ref, this is the pointer to the
 274      previously detected stmt with the same dr.  */
 275   tree same_dr_stmt;
 276   /* For loads only, if there is a store with the same location, this field is
 277      TRUE.  */
 278   bool read_write_dep;
 279
 280   /* Vectorization costs associated with statement.  */
 281   struct
 282   {
 283     int outside_of_loop;     /* Statements generated outside loop.  */
 284     int inside_of_loop;      /* Statements generated inside loop.  */
 285   } cost;
 286 } *stmt_vec_info;
 287
 288 /* Access Functions.  */
 289 #define STMT_VINFO_TYPE(S)                 (S)->type
 290 #define STMT_VINFO_STMT(S)                 (S)->stmt
 291 #define STMT_VINFO_LOOP_VINFO(S)           (S)->loop_vinfo
 292 #define STMT_VINFO_RELEVANT(S)             (S)->relevant
 293 #define STMT_VINFO_LIVE_P(S)               (S)->live
 294 #define STMT_VINFO_VECTYPE(S)              (S)->vectype
 295 #define STMT_VINFO_VEC_STMT(S)             (S)->vectorized_stmt
 296 #define STMT_VINFO_DATA_REF(S)             (S)->data_ref_info
 297 #define STMT_VINFO_IN_PATTERN_P(S)         (S)->in_pattern_p
 298 #define STMT_VINFO_RELATED_STMT(S)         (S)->related_stmt
 299 #define STMT_VINFO_SAME_ALIGN_REFS(S)      (S)->same_align_refs
 300 #define STMT_VINFO_DEF_TYPE(S)             (S)->def_type
 301 #define STMT_VINFO_DR_GROUP_FIRST_DR(S)    (S)->first_dr
 302 #define STMT_VINFO_DR_GROUP_NEXT_DR(S)     (S)->next_dr
 303 #define STMT_VINFO_DR_GROUP_SIZE(S)        (S)->size
 304 #define STMT_VINFO_DR_GROUP_STORE_COUNT(S) (S)->store_count
 305 #define STMT_VINFO_DR_GROUP_GAP(S)         (S)->gap
 306 #define STMT_VINFO_DR_GROUP_SAME_DR_STMT(S)(S)->same_dr_stmt
 307 #define STMT_VINFO_DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 308
 309 #define DR_GROUP_FIRST_DR(S)               (S)->first_dr
 310 #define DR_GROUP_NEXT_DR(S)                (S)->next_dr
 311 #define DR_GROUP_SIZE(S)                   (S)->size
 312 #define DR_GROUP_STORE_COUNT(S)            (S)->store_count
 313 #define DR_GROUP_GAP(S)                    (S)->gap
 314 #define DR_GROUP_SAME_DR_STMT(S)           (S)->same_dr_stmt
 315 #define DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 316
 317 #define STMT_VINFO_RELEVANT_P(S)          ((S)->relevant != vect_unused_in_loop)
 318 #define STMT_VINFO_OUTSIDE_OF_LOOP_COST(S) (S)->cost.outside_of_loop
 319 #define STMT_VINFO_INSIDE_OF_LOOP_COST(S)  (S)->cost.inside_of_loop
 320
 321 /* These are some defines for the initial implementation of the vectorizer's
 322    cost model.  These will later be target specific hooks.  */
 323
 324 /* Cost of conditional branch.  */
 325 #ifndef TARG_COND_BRANCH_COST
 326 #define TARG_COND_BRANCH_COST        3
 327 #endif
 328
 329 /* Cost of any vector operation, excluding load, store or vector to scalar
 330    operation.  */
 331 #ifndef TARG_VEC_STMT_COST
 332 #define TARG_VEC_STMT_COST           1
 333 #endif
 334
 335 /* Cost of vector to scalar operation.  */
 336 #ifndef TARG_VEC_TO_SCALAR_COST
 337 #define TARG_VEC_TO_SCALAR_COST      1
 338 #endif
 339
 340 /* Cost of scalar to vector operation.  */
 341 #ifndef TARG_SCALAR_TO_VEC_COST
 342 #define TARG_SCALAR_TO_VEC_COST      1
 343 #endif
 344
 345 /* Cost of aligned vector load.  */
 346 #ifndef TARG_VEC_LOAD_COST
 347 #define TARG_VEC_LOAD_COST           1
 348 #endif
 349
 350 /* Cost of misaligned vector load.  */
 351 #ifndef TARG_VEC_UNALIGNED_LOAD_COST
 352 #define TARG_VEC_UNALIGNED_LOAD_COST 2
 353 #endif
 354
 355 /* Cost of vector store.  */
 356 #ifndef TARG_VEC_STORE_COST
 357 #define TARG_VEC_STORE_COST          1
 358 #endif
 359
 360 static inline void set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info);
 361 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
 362
 363 static inline void
 364 set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info)
 365 {
 366   if (ann)
 367     ann->common.aux = (char *) stmt_info;
 368 }
 369
 370 static inline stmt_vec_info
 371 vinfo_for_stmt (tree stmt)
 372 {
 373   stmt_ann_t ann = stmt_ann (stmt);
 374   return ann ? (stmt_vec_info) ann->common.aux : NULL;
 375 }
 376
 377 static inline bool
 378 is_pattern_stmt_p (stmt_vec_info stmt_info)
 379 {
 380   tree related_stmt;
 381   stmt_vec_info related_stmt_info;
 382
 383   related_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
 384   if (related_stmt
 385       && (related_stmt_info = vinfo_for_stmt (related_stmt))
 386       && STMT_VINFO_IN_PATTERN_P (related_stmt_info))
 387     return true;
 388
 389   return false;
 390 }
 391
 392 /*-----------------------------------------------------------------*/
 393 /* Info on data references alignment.                              */
 394 /*-----------------------------------------------------------------*/
 395
 396 /* Reflects actual alignment of first access in the vectorized loop,
 397    taking into account peeling/versioning if applied.  */
 398 #define DR_MISALIGNMENT(DR)   ((int) (size_t) (DR)->aux)
 399 #define SET_DR_MISALIGNMENT(DR, VAL)   ((DR)->aux = (void *) (size_t) (VAL))
 400
 401 static inline bool
 402 aligned_access_p (struct data_reference *data_ref_info)
 403 {
 404   return (DR_MISALIGNMENT (data_ref_info) == 0);
 405 }
 406
 407 static inline bool
 408 known_alignment_for_access_p (struct data_reference *data_ref_info)
 409 {
 410   return (DR_MISALIGNMENT (data_ref_info) != -1);
 411 }
 412
 413 /* vect_dump will be set to stderr or dump_file if exist.  */
 414 extern FILE *vect_dump;
 415 extern enum verbosity_levels vect_verbosity_level;
 416
 417 /* Bitmap of virtual variables to be renamed.  */
 418 extern bitmap vect_memsyms_to_rename;
 419
 420 /*-----------------------------------------------------------------*/
 421 /* Function prototypes.                                            */
 422 /*-----------------------------------------------------------------*/
 423
 424 /*************************************************************************
 425   Simple Loop Peeling Utilities - in tree-vectorizer.c
 426  *************************************************************************/
 427 /* Entry point for peeling of simple loops.
 428    Peel the first/last iterations of a loop.
 429    It can be used outside of the vectorizer for loops that are simple enough
 430    (see function documentation).  In the vectorizer it is used to peel the
 431    last few iterations when the loop bound is unknown or does not evenly
 432    divide by the vectorization factor, and to peel the first few iterations
 433    to force the alignment of data references in the loop.  */
 434 extern struct loop *slpeel_tree_peel_loop_to_edge
 435   (struct loop *, edge, tree, tree, bool, unsigned int);
 436 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 437 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
 438 #ifdef ENABLE_CHECKING
 439 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
 440 #endif
 441
 442
 443 /*************************************************************************
 444   General Vectorization Utilities
 445  *************************************************************************/
 446 /** In tree-vectorizer.c **/
 447 extern tree get_vectype_for_scalar_type (tree);
 448 extern bool vect_is_simple_use (tree, loop_vec_info, tree *, tree *,
 449                                 enum vect_def_type *);
 450 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
 451 extern tree vect_is_simple_reduction (struct loop *, tree);
 452 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 453 extern enum dr_alignment_support vect_supportable_dr_alignment
 454   (struct data_reference *);
 455 extern bool reduction_code_for_scalar_code (enum tree_code, enum tree_code *);
 456 extern bool supportable_widening_operation (enum tree_code, tree, tree,
 457   tree *, tree *, enum tree_code *, enum tree_code *);
 458 extern bool supportable_narrowing_operation (enum tree_code, tree, tree,
 459                                              enum tree_code *);
 460
 461 /* Creation and deletion of loop and stmt info structs.  */
 462 extern loop_vec_info new_loop_vec_info (struct loop *loop);
 463 extern void destroy_loop_vec_info (loop_vec_info);
 464 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
 465
 466
 467 /** In tree-vect-analyze.c  **/
 468 /* Driver for analysis stage.  */
 469 extern loop_vec_info vect_analyze_loop (struct loop *);
 470
 471
 472 /** In tree-vect-patterns.c  **/
 473 /* Pattern recognition functions.
 474    Additional pattern recognition functions can (and will) be added
 475    in the future.  */
 476 typedef tree (* vect_recog_func_ptr) (tree, tree *, tree *);
 477 #define NUM_PATTERNS 4
 478 void vect_pattern_recog (loop_vec_info);
 479
 480
 481 /** In tree-vect-transform.c  **/
 482 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
 483 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
 484 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
 485 extern bool vectorizable_type_promotion (tree, block_stmt_iterator *, tree *);
 486 extern bool vectorizable_type_demotion (tree, block_stmt_iterator *, tree *);
 487 extern bool vectorizable_conversion (tree, block_stmt_iterator *,
 488                                      tree *);
 489 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
 490 extern tree vectorizable_function (tree, tree, tree);
 491 extern bool vectorizable_call (tree, block_stmt_iterator *, tree *);
 492 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
 493 extern bool vectorizable_live_operation (tree, block_stmt_iterator *, tree *);
 494 extern bool vectorizable_reduction (tree, block_stmt_iterator *, tree *);
 495 extern bool vectorizable_induction (tree, block_stmt_iterator *, tree *);
 496 extern int  vect_estimate_min_profitable_iters (loop_vec_info);
 497 /* Driver for transformation stage.  */
 498 extern void vect_transform_loop (loop_vec_info);
 499
 500 /*************************************************************************
 501   Vectorization Debug Information - in tree-vectorizer.c
 502  *************************************************************************/
 503 extern bool vect_print_dump_info (enum verbosity_levels);
 504 extern void vect_set_verbosity_level (const char *);
 505 extern LOC find_loop_location (struct loop *);
 506
 507 #endif  /* GCC_TREE_VECTORIZER_H  */