gcc/tree-vectorizer.h

   1 /* Vectorizer
   2    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4    Contributed by Dorit Naishlos <dorit@il.ibm.com>
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 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_TREE_VECTORIZER_H
  23 #define GCC_TREE_VECTORIZER_H
  24
  25 #include "tree-data-ref.h"
  26
  27 typedef source_location LOC;
  28 #define UNKNOWN_LOC UNKNOWN_LOCATION
  29 #define EXPR_LOC(e) EXPR_LOCATION(e)
  30 #define LOC_FILE(l) LOCATION_FILE (l)
  31 #define LOC_LINE(l) LOCATION_LINE (l)
  32
  33 /* Used for naming of new temporaries.  */
  34 enum vect_var_kind {
  35   vect_simple_var,
  36   vect_pointer_var,
  37   vect_scalar_var
  38 };
  39
  40 /* Defines type of operation.  */
  41 enum operation_type {
  42   unary_op = 1,
  43   binary_op,
  44   ternary_op
  45 };
  46
  47 /* Define type of available alignment support.  */
  48 enum dr_alignment_support {
  49   dr_unaligned_unsupported,
  50   dr_unaligned_supported,
  51   dr_explicit_realign,
  52   dr_explicit_realign_optimized,
  53   dr_aligned
  54 };
  55
  56 /* Define type of def-use cross-iteration cycle.  */
  57 enum vect_def_type {
  58   vect_uninitialized_def = 0,
  59   vect_constant_def = 1,
  60   vect_external_def,
  61   vect_internal_def,
  62   vect_induction_def,
  63   vect_reduction_def,
  64   vect_double_reduction_def,
  65   vect_nested_cycle,
  66   vect_unknown_def_type
  67 };
  68
  69 #define VECTORIZABLE_CYCLE_DEF(D) (((D) == vect_reduction_def)           \
  70                                    || ((D) == vect_double_reduction_def) \
  71                                    || ((D) == vect_nested_cycle))
  72
  73 /************************************************************************
  74   SLP
  75  ************************************************************************/
  76
  77 /* A computation tree of an SLP instance. Each node corresponds to a group of
  78    stmts to be packed in a SIMD stmt.  */
  79 typedef struct _slp_tree {
  80   /* Only binary and unary operations are supported. LEFT child corresponds to
  81      the first operand and RIGHT child to the second if the operation is
  82      binary.  */
  83   struct _slp_tree *left;
  84   struct _slp_tree *right;
  85   /* A group of scalar stmts to be vectorized together.  */
  86   VEC (gimple, heap) *stmts;
  87   /* Vectorized stmt/s.  */
  88   VEC (gimple, heap) *vec_stmts;
  89   /* Number of vector stmts that are created to replace the group of scalar
  90      stmts. It is calculated during the transformation phase as the number of
  91      scalar elements in one scalar iteration (GROUP_SIZE) multiplied by VF
  92      divided by vector size.  */
  93   unsigned int vec_stmts_size;
  94   /* Vectorization costs associated with SLP node.  */
  95   struct
  96   {
  97     int outside_of_loop;     /* Statements generated outside loop.  */
  98     int inside_of_loop;      /* Statements generated inside loop.  */
  99   } cost;
 100 } *slp_tree;
 101
 102 DEF_VEC_P(slp_tree);
 103 DEF_VEC_ALLOC_P(slp_tree, heap);
 104
 105 /* SLP instance is a sequence of stmts in a loop that can be packed into
 106    SIMD stmts.  */
 107 typedef struct _slp_instance {
 108   /* The root of SLP tree.  */
 109   slp_tree root;
 110
 111   /* Size of groups of scalar stmts that will be replaced by SIMD stmt/s.  */
 112   unsigned int group_size;
 113
 114   /* The unrolling factor required to vectorized this SLP instance.  */
 115   unsigned int unrolling_factor;
 116
 117   /* Vectorization costs associated with SLP instance.  */
 118   struct
 119   {
 120     int outside_of_loop;     /* Statements generated outside loop.  */
 121     int inside_of_loop;      /* Statements generated inside loop.  */
 122   } cost;
 123
 124   /* Loads permutation relatively to the stores, NULL if there is no
 125      permutation.  */
 126   VEC (int, heap) *load_permutation;
 127
 128   /* The group of nodes that contain loads of this SLP instance.  */
 129   VEC (slp_tree, heap) *loads;
 130
 131   /* The first scalar load of the instance. The created vector loads will be
 132      inserted before this statement.  */
 133   gimple first_load;
 134 } *slp_instance;
 135
 136 DEF_VEC_P(slp_instance);
 137 DEF_VEC_ALLOC_P(slp_instance, heap);
 138
 139 /* Access Functions.  */
 140 #define SLP_INSTANCE_TREE(S)                     (S)->root
 141 #define SLP_INSTANCE_GROUP_SIZE(S)               (S)->group_size
 142 #define SLP_INSTANCE_UNROLLING_FACTOR(S)         (S)->unrolling_factor
 143 #define SLP_INSTANCE_OUTSIDE_OF_LOOP_COST(S)     (S)->cost.outside_of_loop
 144 #define SLP_INSTANCE_INSIDE_OF_LOOP_COST(S)      (S)->cost.inside_of_loop
 145 #define SLP_INSTANCE_LOAD_PERMUTATION(S)         (S)->load_permutation
 146 #define SLP_INSTANCE_LOADS(S)                    (S)->loads
 147 #define SLP_INSTANCE_FIRST_LOAD_STMT(S)          (S)->first_load
 148
 149 #define SLP_TREE_LEFT(S)                         (S)->left
 150 #define SLP_TREE_RIGHT(S)                        (S)->right
 151 #define SLP_TREE_SCALAR_STMTS(S)                 (S)->stmts
 152 #define SLP_TREE_VEC_STMTS(S)                    (S)->vec_stmts
 153 #define SLP_TREE_NUMBER_OF_VEC_STMTS(S)          (S)->vec_stmts_size
 154 #define SLP_TREE_OUTSIDE_OF_LOOP_COST(S)         (S)->cost.outside_of_loop
 155 #define SLP_TREE_INSIDE_OF_LOOP_COST(S)          (S)->cost.inside_of_loop
 156
 157
 158 typedef struct _vect_peel_info
 159 {
 160   int npeel;
 161   struct data_reference *dr;
 162   unsigned int count;
 163 } *vect_peel_info;
 164
 165 typedef struct _vect_peel_extended_info
 166 {
 167   struct _vect_peel_info peel_info;
 168   unsigned int inside_cost;
 169   unsigned int outside_cost;
 170 } *vect_peel_extended_info;
 171
 172 /*-----------------------------------------------------------------*/
 173 /* Info on vectorized loops.                                       */
 174 /*-----------------------------------------------------------------*/
 175 typedef struct _loop_vec_info {
 176
 177   /* The loop to which this info struct refers to.  */
 178   struct loop *loop;
 179
 180   /* The loop basic blocks.  */
 181   basic_block *bbs;
 182
 183   /* Number of iterations.  */
 184   tree num_iters;
 185   tree num_iters_unchanged;
 186
 187   /* Minimum number of iterations below which vectorization is expected to
 188      not be profitable (as estimated by the cost model).
 189      -1 indicates that vectorization will not be profitable.
 190      FORNOW: This field is an int. Will be a tree in the future, to represent
 191              values unknown at compile time.  */
 192   int min_profitable_iters;
 193
 194   /* Is the loop vectorizable? */
 195   bool vectorizable;
 196
 197   /* Unrolling factor  */
 198   int vectorization_factor;
 199
 200   /* The loop location in the source.  */
 201   LOC loop_line_number;
 202
 203   /* Unknown DRs according to which loop was peeled.  */
 204   struct data_reference *unaligned_dr;
 205
 206   /* peeling_for_alignment indicates whether peeling for alignment will take
 207      place, and what the peeling factor should be:
 208      peeling_for_alignment = X means:
 209         If X=0: Peeling for alignment will not be applied.
 210         If X>0: Peel first X iterations.
 211         If X=-1: Generate a runtime test to calculate the number of iterations
 212                  to be peeled, using the dataref recorded in the field
 213                  unaligned_dr.  */
 214   int peeling_for_alignment;
 215
 216   /* The mask used to check the alignment of pointers or arrays.  */
 217   int ptr_mask;
 218
 219   /* All data references in the loop.  */
 220   VEC (data_reference_p, heap) *datarefs;
 221
 222   /* All data dependences in the loop.  */
 223   VEC (ddr_p, heap) *ddrs;
 224
 225   /* Data Dependence Relations defining address ranges that are candidates
 226      for a run-time aliasing check.  */
 227   VEC (ddr_p, heap) *may_alias_ddrs;
 228
 229   /* Statements in the loop that have data references that are candidates for a
 230      runtime (loop versioning) misalignment check.  */
 231   VEC(gimple,heap) *may_misalign_stmts;
 232
 233   /* All interleaving chains of stores in the loop, represented by the first
 234      stmt in the chain.  */
 235   VEC(gimple, heap) *strided_stores;
 236
 237   /* All SLP instances in the loop. This is a subset of the set of STRIDED_STORES
 238      of the loop.  */
 239   VEC(slp_instance, heap) *slp_instances;
 240
 241   /* The unrolling factor needed to SLP the loop. In case of that pure SLP is
 242      applied to the loop, i.e., no unrolling is needed, this is 1.  */
 243   unsigned slp_unrolling_factor;
 244
 245   /* Reduction cycles detected in the loop. Used in loop-aware SLP.  */
 246   VEC (gimple, heap) *reductions;
 247
 248   /* Hash table used to choose the best peeling option.  */
 249   htab_t peeling_htab;
 250
 251 } *loop_vec_info;
 252
 253 /* Access Functions.  */
 254 #define LOOP_VINFO_LOOP(L)                 (L)->loop
 255 #define LOOP_VINFO_BBS(L)                  (L)->bbs
 256 #define LOOP_VINFO_NITERS(L)               (L)->num_iters
 257 /* Since LOOP_VINFO_NITERS can change after prologue peeling
 258    retain total unchanged scalar loop iterations for cost model.  */
 259 #define LOOP_VINFO_NITERS_UNCHANGED(L)     (L)->num_iters_unchanged
 260 #define LOOP_VINFO_COST_MODEL_MIN_ITERS(L) (L)->min_profitable_iters
 261 #define LOOP_VINFO_VECTORIZABLE_P(L)       (L)->vectorizable
 262 #define LOOP_VINFO_VECT_FACTOR(L)          (L)->vectorization_factor
 263 #define LOOP_VINFO_PTR_MASK(L)             (L)->ptr_mask
 264 #define LOOP_VINFO_DATAREFS(L)             (L)->datarefs
 265 #define LOOP_VINFO_DDRS(L)                 (L)->ddrs
 266 #define LOOP_VINFO_INT_NITERS(L)           (TREE_INT_CST_LOW ((L)->num_iters))
 267 #define LOOP_PEELING_FOR_ALIGNMENT(L)      (L)->peeling_for_alignment
 268 #define LOOP_VINFO_UNALIGNED_DR(L)         (L)->unaligned_dr
 269 #define LOOP_VINFO_MAY_MISALIGN_STMTS(L)   (L)->may_misalign_stmts
 270 #define LOOP_VINFO_LOC(L)                  (L)->loop_line_number
 271 #define LOOP_VINFO_MAY_ALIAS_DDRS(L)       (L)->may_alias_ddrs
 272 #define LOOP_VINFO_STRIDED_STORES(L)       (L)->strided_stores
 273 #define LOOP_VINFO_SLP_INSTANCES(L)        (L)->slp_instances
 274 #define LOOP_VINFO_SLP_UNROLLING_FACTOR(L) (L)->slp_unrolling_factor
 275 #define LOOP_VINFO_REDUCTIONS(L)           (L)->reductions
 276 #define LOOP_VINFO_PEELING_HTAB(L)         (L)->peeling_htab
 277
 278 #define LOOP_REQUIRES_VERSIONING_FOR_ALIGNMENT(L) \
 279 VEC_length (gimple, (L)->may_misalign_stmts) > 0
 280 #define LOOP_REQUIRES_VERSIONING_FOR_ALIAS(L)     \
 281 VEC_length (ddr_p, (L)->may_alias_ddrs) > 0
 282
 283 #define NITERS_KNOWN_P(n)                     \
 284 (host_integerp ((n),0)                        \
 285 && TREE_INT_CST_LOW ((n)) > 0)
 286
 287 #define LOOP_VINFO_NITERS_KNOWN_P(L)          \
 288 NITERS_KNOWN_P((L)->num_iters)
 289
 290 static inline loop_vec_info
 291 loop_vec_info_for_loop (struct loop *loop)
 292 {
 293   return (loop_vec_info) loop->aux;
 294 }
 295
 296 static inline bool
 297 nested_in_vect_loop_p (struct loop *loop, gimple stmt)
 298 {
 299   return (loop->inner
 300           && (loop->inner == (gimple_bb (stmt))->loop_father));
 301 }
 302
 303 typedef struct _bb_vec_info {
 304
 305   basic_block bb;
 306   /* All interleaving chains of stores in the basic block, represented by the
 307      first stmt in the chain.  */
 308   VEC(gimple, heap) *strided_stores;
 309
 310   /* All SLP instances in the basic block. This is a subset of the set of
 311      STRIDED_STORES of the basic block.  */
 312   VEC(slp_instance, heap) *slp_instances;
 313
 314   /* All data references in the basic block.  */
 315   VEC (data_reference_p, heap) *datarefs;
 316
 317   /* All data dependences in the basic block.  */
 318   VEC (ddr_p, heap) *ddrs;
 319 } *bb_vec_info;
 320
 321 #define BB_VINFO_BB(B)              (B)->bb
 322 #define BB_VINFO_STRIDED_STORES(B)  (B)->strided_stores
 323 #define BB_VINFO_SLP_INSTANCES(B)   (B)->slp_instances
 324 #define BB_VINFO_DATAREFS(B)        (B)->datarefs
 325 #define BB_VINFO_DDRS(B)            (B)->ddrs
 326
 327 static inline bb_vec_info
 328 vec_info_for_bb (basic_block bb)
 329 {
 330   return (bb_vec_info) bb->aux;
 331 }
 332
 333 /*-----------------------------------------------------------------*/
 334 /* Info on vectorized defs.                                        */
 335 /*-----------------------------------------------------------------*/
 336 enum stmt_vec_info_type {
 337   undef_vec_info_type = 0,
 338   load_vec_info_type,
 339   store_vec_info_type,
 340   shift_vec_info_type,
 341   op_vec_info_type,
 342   call_vec_info_type,
 343   assignment_vec_info_type,
 344   condition_vec_info_type,
 345   reduc_vec_info_type,
 346   induc_vec_info_type,
 347   type_promotion_vec_info_type,
 348   type_demotion_vec_info_type,
 349   type_conversion_vec_info_type,
 350   loop_exit_ctrl_vec_info_type
 351 };
 352
 353 /* Indicates whether/how a variable is used in the scope of loop/basic
 354    block.  */
 355 enum vect_relevant {
 356   vect_unused_in_scope = 0,
 357   /* The def is in the inner loop, and the use is in the outer loop, and the
 358      use is a reduction stmt.  */
 359   vect_used_in_outer_by_reduction,
 360   /* The def is in the inner loop, and the use is in the outer loop (and is
 361      not part of reduction).  */
 362   vect_used_in_outer,
 363
 364   /* defs that feed computations that end up (only) in a reduction. These
 365      defs may be used by non-reduction stmts, but eventually, any
 366      computations/values that are affected by these defs are used to compute
 367      a reduction (i.e. don't get stored to memory, for example). We use this
 368      to identify computations that we can change the order in which they are
 369      computed.  */
 370   vect_used_by_reduction,
 371
 372   vect_used_in_scope
 373 };
 374
 375 /* The type of vectorization that can be applied to the stmt: regular loop-based
 376    vectorization; pure SLP - the stmt is a part of SLP instances and does not
 377    have uses outside SLP instances; or hybrid SLP and loop-based - the stmt is
 378    a part of SLP instance and also must be loop-based vectorized, since it has
 379    uses outside SLP sequences.
 380
 381    In the loop context the meanings of pure and hybrid SLP are slightly
 382    different. By saying that pure SLP is applied to the loop, we mean that we
 383    exploit only intra-iteration parallelism in the loop; i.e., the loop can be
 384    vectorized without doing any conceptual unrolling, cause we don't pack
 385    together stmts from different iterations, only within a single iteration.
 386    Loop hybrid SLP means that we exploit both intra-iteration and
 387    inter-iteration parallelism (e.g., number of elements in the vector is 4
 388    and the slp-group-size is 2, in which case we don't have enough parallelism
 389    within an iteration, so we obtain the rest of the parallelism from subsequent
 390    iterations by unrolling the loop by 2).  */
 391 enum slp_vect_type {
 392   loop_vect = 0,
 393   pure_slp,
 394   hybrid
 395 };
 396
 397
 398 typedef struct data_reference *dr_p;
 399 DEF_VEC_P(dr_p);
 400 DEF_VEC_ALLOC_P(dr_p,heap);
 401
 402 typedef struct _stmt_vec_info {
 403
 404   enum stmt_vec_info_type type;
 405
 406   /* Indicates whether this stmts is part of a computation whose result is
 407      used outside the loop.  */
 408   bool live;
 409
 410   /* Stmt is part of some pattern (computation idiom)  */
 411   bool in_pattern_p;
 412
 413   /* For loads only, if there is a store with the same location, this field is
 414      TRUE.  */
 415   bool read_write_dep;
 416
 417   /* The stmt to which this info struct refers to.  */
 418   gimple stmt;
 419
 420   /* The loop_vec_info with respect to which STMT is vectorized.  */
 421   loop_vec_info loop_vinfo;
 422
 423   /* The vector type to be used for the LHS of this statement.  */
 424   tree vectype;
 425
 426   /* The vectorized version of the stmt.  */
 427   gimple vectorized_stmt;
 428
 429
 430   /** The following is relevant only for stmts that contain a non-scalar
 431      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 432      at most one such data-ref.  **/
 433
 434   /* Information about the data-ref (access function, etc),
 435      relative to the inner-most containing loop.  */
 436   struct data_reference *data_ref_info;
 437
 438   /* Information about the data-ref relative to this loop
 439      nest (the loop that is being considered for vectorization).  */
 440   tree dr_base_address;
 441   tree dr_init;
 442   tree dr_offset;
 443   tree dr_step;
 444   tree dr_aligned_to;
 445
 446   /* Used for various bookkeeping purposes, generally holding a pointer to
 447      some other stmt S that is in some way "related" to this stmt.
 448      Current use of this field is:
 449         If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
 450         true): S is the "pattern stmt" that represents (and replaces) the
 451         sequence of stmts that constitutes the pattern.  Similarly, the
 452         related_stmt of the "pattern stmt" points back to this stmt (which is
 453         the last stmt in the original sequence of stmts that constitutes the
 454         pattern).  */
 455   gimple related_stmt;
 456
 457   /* List of datarefs that are known to have the same alignment as the dataref
 458      of this stmt.  */
 459   VEC(dr_p,heap) *same_align_refs;
 460
 461   /* Classify the def of this stmt.  */
 462   enum vect_def_type def_type;
 463
 464   /*  Whether the stmt is SLPed, loop-based vectorized, or both.  */
 465   enum slp_vect_type slp_type;
 466
 467   /* Interleaving info.  */
 468   /* First data-ref in the interleaving group.  */
 469   gimple first_dr;
 470   /* Pointer to the next data-ref in the group.  */
 471   gimple next_dr;
 472   /* In case that two or more stmts share data-ref, this is the pointer to the
 473      previously detected stmt with the same dr.  */
 474   gimple same_dr_stmt;
 475   /* The size of the interleaving group.  */
 476   unsigned int size;
 477   /* For stores, number of stores from this group seen. We vectorize the last
 478      one.  */
 479   unsigned int store_count;
 480   /* For loads only, the gap from the previous load. For consecutive loads, GAP
 481      is 1.  */
 482   unsigned int gap;
 483
 484   /* Not all stmts in the loop need to be vectorized. e.g, the increment
 485      of the loop induction variable and computation of array indexes. relevant
 486      indicates whether the stmt needs to be vectorized.  */
 487   enum vect_relevant relevant;
 488
 489   /* Vectorization costs associated with statement.  */
 490   struct
 491   {
 492     int outside_of_loop;     /* Statements generated outside loop.  */
 493     int inside_of_loop;      /* Statements generated inside loop.  */
 494   } cost;
 495
 496   /* The bb_vec_info with respect to which STMT is vectorized.  */
 497   bb_vec_info bb_vinfo;
 498
 499   /* Is this statement vectorizable or should it be skipped in (partial)
 500      vectorization.  */
 501   bool vectorizable;
 502 } *stmt_vec_info;
 503
 504 /* Access Functions.  */
 505 #define STMT_VINFO_TYPE(S)                 (S)->type
 506 #define STMT_VINFO_STMT(S)                 (S)->stmt
 507 #define STMT_VINFO_LOOP_VINFO(S)           (S)->loop_vinfo
 508 #define STMT_VINFO_BB_VINFO(S)             (S)->bb_vinfo
 509 #define STMT_VINFO_RELEVANT(S)             (S)->relevant
 510 #define STMT_VINFO_LIVE_P(S)               (S)->live
 511 #define STMT_VINFO_VECTYPE(S)              (S)->vectype
 512 #define STMT_VINFO_VEC_STMT(S)             (S)->vectorized_stmt
 513 #define STMT_VINFO_VECTORIZABLE(S)         (S)->vectorizable
 514 #define STMT_VINFO_DATA_REF(S)             (S)->data_ref_info
 515
 516 #define STMT_VINFO_DR_BASE_ADDRESS(S)      (S)->dr_base_address
 517 #define STMT_VINFO_DR_INIT(S)              (S)->dr_init
 518 #define STMT_VINFO_DR_OFFSET(S)            (S)->dr_offset
 519 #define STMT_VINFO_DR_STEP(S)              (S)->dr_step
 520 #define STMT_VINFO_DR_ALIGNED_TO(S)        (S)->dr_aligned_to
 521
 522 #define STMT_VINFO_IN_PATTERN_P(S)         (S)->in_pattern_p
 523 #define STMT_VINFO_RELATED_STMT(S)         (S)->related_stmt
 524 #define STMT_VINFO_SAME_ALIGN_REFS(S)      (S)->same_align_refs
 525 #define STMT_VINFO_DEF_TYPE(S)             (S)->def_type
 526 #define STMT_VINFO_DR_GROUP_FIRST_DR(S)    (S)->first_dr
 527 #define STMT_VINFO_DR_GROUP_NEXT_DR(S)     (S)->next_dr
 528 #define STMT_VINFO_DR_GROUP_SIZE(S)        (S)->size
 529 #define STMT_VINFO_DR_GROUP_STORE_COUNT(S) (S)->store_count
 530 #define STMT_VINFO_DR_GROUP_GAP(S)         (S)->gap
 531 #define STMT_VINFO_DR_GROUP_SAME_DR_STMT(S)(S)->same_dr_stmt
 532 #define STMT_VINFO_DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 533 #define STMT_VINFO_STRIDED_ACCESS(S)      ((S)->first_dr != NULL)
 534
 535 #define DR_GROUP_FIRST_DR(S)               (S)->first_dr
 536 #define DR_GROUP_NEXT_DR(S)                (S)->next_dr
 537 #define DR_GROUP_SIZE(S)                   (S)->size
 538 #define DR_GROUP_STORE_COUNT(S)            (S)->store_count
 539 #define DR_GROUP_GAP(S)                    (S)->gap
 540 #define DR_GROUP_SAME_DR_STMT(S)           (S)->same_dr_stmt
 541 #define DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 542
 543 #define STMT_VINFO_RELEVANT_P(S)          ((S)->relevant != vect_unused_in_scope)
 544 #define STMT_VINFO_OUTSIDE_OF_LOOP_COST(S) (S)->cost.outside_of_loop
 545 #define STMT_VINFO_INSIDE_OF_LOOP_COST(S)  (S)->cost.inside_of_loop
 546
 547 #define HYBRID_SLP_STMT(S)                ((S)->slp_type == hybrid)
 548 #define PURE_SLP_STMT(S)                  ((S)->slp_type == pure_slp)
 549 #define STMT_SLP_TYPE(S)                   (S)->slp_type
 550
 551 #define VECT_MAX_COST 1000
 552
 553 /* The maximum number of intermediate steps required in multi-step type
 554    conversion.  */
 555 #define MAX_INTERM_CVT_STEPS         3
 556
 557 /* The maximum vectorization factor supported by any target (V32QI).  */
 558 #define MAX_VECTORIZATION_FACTOR 32
 559
 560 /* Avoid GTY(()) on stmt_vec_info.  */
 561 typedef void *vec_void_p;
 562 DEF_VEC_P (vec_void_p);
 563 DEF_VEC_ALLOC_P (vec_void_p, heap);
 564
 565 extern VEC(vec_void_p,heap) *stmt_vec_info_vec;
 566
 567 void init_stmt_vec_info_vec (void);
 568 void free_stmt_vec_info_vec (void);
 569
 570 /* Return a stmt_vec_info corresponding to STMT.  */
 571
 572 static inline stmt_vec_info
 573 vinfo_for_stmt (gimple stmt)
 574 {
 575   unsigned int uid = gimple_uid (stmt);
 576   if (uid == 0)
 577     return NULL;
 578
 579   return (stmt_vec_info) VEC_index (vec_void_p, stmt_vec_info_vec, uid - 1);
 580 }
 581
 582 /* Set vectorizer information INFO for STMT.  */
 583
 584 static inline void
 585 set_vinfo_for_stmt (gimple stmt, stmt_vec_info info)
 586 {
 587   unsigned int uid = gimple_uid (stmt);
 588   if (uid == 0)
 589     {
 590       gcc_checking_assert (info);
 591       uid = VEC_length (vec_void_p, stmt_vec_info_vec) + 1;
 592       gimple_set_uid (stmt, uid);
 593       VEC_safe_push (vec_void_p, heap, stmt_vec_info_vec, (vec_void_p) info);
 594     }
 595   else
 596     VEC_replace (vec_void_p, stmt_vec_info_vec, uid - 1, (vec_void_p) info);
 597 }
 598
 599 /* Return the earlier statement between STMT1 and STMT2.  */
 600
 601 static inline gimple
 602 get_earlier_stmt (gimple stmt1, gimple stmt2)
 603 {
 604   unsigned int uid1, uid2;
 605
 606   if (stmt1 == NULL)
 607     return stmt2;
 608
 609   if (stmt2 == NULL)
 610     return stmt1;
 611
 612   uid1 = gimple_uid (stmt1);
 613   uid2 = gimple_uid (stmt2);
 614
 615   if (uid1 == 0 || uid2 == 0)
 616     return NULL;
 617
 618   gcc_checking_assert (uid1 <= VEC_length (vec_void_p, stmt_vec_info_vec)
 619                        && uid2 <= VEC_length (vec_void_p, stmt_vec_info_vec));
 620
 621   if (uid1 < uid2)
 622     return stmt1;
 623   else
 624     return stmt2;
 625 }
 626
 627 /* Return the later statement between STMT1 and STMT2.  */
 628
 629 static inline gimple
 630 get_later_stmt (gimple stmt1, gimple stmt2)
 631 {
 632   unsigned int uid1, uid2;
 633
 634   if (stmt1 == NULL)
 635     return stmt2;
 636
 637   if (stmt2 == NULL)
 638     return stmt1;
 639
 640   uid1 = gimple_uid (stmt1);
 641   uid2 = gimple_uid (stmt2);
 642
 643   if (uid1 == 0 || uid2 == 0)
 644     return NULL;
 645
 646   gcc_assert (uid1 <= VEC_length (vec_void_p, stmt_vec_info_vec));
 647   gcc_assert (uid2 <= VEC_length (vec_void_p, stmt_vec_info_vec));
 648
 649   if (uid1 > uid2)
 650     return stmt1;
 651   else
 652     return stmt2;
 653 }
 654
 655 /* Return TRUE if a statement represented by STMT_INFO is a part of a
 656    pattern.  */
 657
 658 static inline bool
 659 is_pattern_stmt_p (stmt_vec_info stmt_info)
 660 {
 661   gimple related_stmt;
 662   stmt_vec_info related_stmt_info;
 663
 664   related_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
 665   if (related_stmt
 666       && (related_stmt_info = vinfo_for_stmt (related_stmt))
 667       && STMT_VINFO_IN_PATTERN_P (related_stmt_info))
 668     return true;
 669
 670   return false;
 671 }
 672
 673 /* Return true if BB is a loop header.  */
 674
 675 static inline bool
 676 is_loop_header_bb_p (basic_block bb)
 677 {
 678   if (bb == (bb->loop_father)->header)
 679     return true;
 680   gcc_checking_assert (EDGE_COUNT (bb->preds) == 1);
 681   return false;
 682 }
 683
 684 /* Set inside loop vectorization cost.  */
 685
 686 static inline void
 687 stmt_vinfo_set_inside_of_loop_cost (stmt_vec_info stmt_info, slp_tree slp_node,
 688                                     int cost)
 689 {
 690   if (slp_node)
 691     SLP_TREE_INSIDE_OF_LOOP_COST (slp_node) = cost;
 692   else
 693     STMT_VINFO_INSIDE_OF_LOOP_COST (stmt_info) = cost;
 694 }
 695
 696 /* Set inside loop vectorization cost.  */
 697
 698 static inline void
 699 stmt_vinfo_set_outside_of_loop_cost (stmt_vec_info stmt_info, slp_tree slp_node,
 700                                      int cost)
 701 {
 702   if (slp_node)
 703     SLP_TREE_OUTSIDE_OF_LOOP_COST (slp_node) = cost;
 704   else
 705     STMT_VINFO_OUTSIDE_OF_LOOP_COST (stmt_info) = cost;
 706 }
 707
 708 /* Return pow2 (X).  */
 709
 710 static inline int
 711 vect_pow2 (int x)
 712 {
 713   int i, res = 1;
 714
 715   for (i = 0; i < x; i++)
 716     res *= 2;
 717
 718   return res;
 719 }
 720
 721 /*-----------------------------------------------------------------*/
 722 /* Info on data references alignment.                              */
 723 /*-----------------------------------------------------------------*/
 724
 725 /* Reflects actual alignment of first access in the vectorized loop,
 726    taking into account peeling/versioning if applied.  */
 727 #define DR_MISALIGNMENT(DR)   ((int) (size_t) (DR)->aux)
 728 #define SET_DR_MISALIGNMENT(DR, VAL)   ((DR)->aux = (void *) (size_t) (VAL))
 729
 730 /* Return TRUE if the data access is aligned, and FALSE otherwise.  */
 731
 732 static inline bool
 733 aligned_access_p (struct data_reference *data_ref_info)
 734 {
 735   return (DR_MISALIGNMENT (data_ref_info) == 0);
 736 }
 737
 738 /* Return TRUE if the alignment of the data access is known, and FALSE
 739    otherwise.  */
 740
 741 static inline bool
 742 known_alignment_for_access_p (struct data_reference *data_ref_info)
 743 {
 744   return (DR_MISALIGNMENT (data_ref_info) != -1);
 745 }
 746
 747 /* vect_dump will be set to stderr or dump_file if exist.  */
 748 extern FILE *vect_dump;
 749 extern LOC vect_loop_location;
 750
 751 /*-----------------------------------------------------------------*/
 752 /* Function prototypes.                                            */
 753 /*-----------------------------------------------------------------*/
 754
 755 /* Simple loop peeling and versioning utilities for vectorizer's purposes -
 756    in tree-vect-loop-manip.c.  */
 757 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 758 extern bool slpeel_can_duplicate_loop_p (const struct loop *, const_edge);
 759 extern void vect_loop_versioning (loop_vec_info, bool, tree *, gimple_seq *);
 760 extern void vect_do_peeling_for_loop_bound (loop_vec_info, tree *,
 761                                             tree, gimple_seq);
 762 extern void vect_do_peeling_for_alignment (loop_vec_info);
 763 extern LOC find_loop_location (struct loop *);
 764 extern bool vect_can_advance_ivs_p (loop_vec_info);
 765
 766 /* In tree-vect-stmts.c.  */
 767 extern unsigned int current_vector_size;
 768 extern tree get_vectype_for_scalar_type (tree);
 769 extern tree get_same_sized_vectype (tree, tree);
 770 extern bool vect_is_simple_use (tree, loop_vec_info, bb_vec_info, gimple *,
 771                                 tree *,  enum vect_def_type *);
 772 extern bool vect_is_simple_use_1 (tree, loop_vec_info, bb_vec_info, gimple *,
 773                                   tree *,  enum vect_def_type *, tree *);
 774 extern bool supportable_widening_operation (enum tree_code, gimple, tree, tree,
 775                                             tree *, tree *, enum tree_code *,
 776                                             enum tree_code *, int *,
 777                                             VEC (tree, heap) **);
 778 extern bool supportable_narrowing_operation (enum tree_code, tree, tree,
 779                                              enum tree_code *,
 780                                              int *, VEC (tree, heap) **);
 781 extern stmt_vec_info new_stmt_vec_info (gimple stmt, loop_vec_info,
 782                                         bb_vec_info);
 783 extern void free_stmt_vec_info (gimple stmt);
 784 extern tree vectorizable_function (gimple, tree, tree);
 785 extern void vect_model_simple_cost (stmt_vec_info, int, enum vect_def_type *,
 786                                     slp_tree);
 787 extern void vect_model_store_cost (stmt_vec_info, int, enum vect_def_type,
 788                                    slp_tree);
 789 extern void vect_model_load_cost (stmt_vec_info, int, slp_tree);
 790 extern void vect_finish_stmt_generation (gimple, gimple,
 791                                          gimple_stmt_iterator *);
 792 extern bool vect_mark_stmts_to_be_vectorized (loop_vec_info);
 793 extern int cost_for_stmt (gimple);
 794 extern tree vect_get_vec_def_for_operand (tree, gimple, tree *);
 795 extern tree vect_init_vector (gimple, tree, tree,
 796                               gimple_stmt_iterator *);
 797 extern tree vect_get_vec_def_for_stmt_copy (enum vect_def_type, tree);
 798 extern bool vect_transform_stmt (gimple, gimple_stmt_iterator *,
 799                                  bool *, slp_tree, slp_instance);
 800 extern void vect_remove_stores (gimple);
 801 extern bool vect_analyze_stmt (gimple, bool *, slp_tree);
 802 extern bool vectorizable_condition (gimple, gimple_stmt_iterator *, gimple *,
 803                                     tree, int);
 804 extern void vect_get_load_cost (struct data_reference *, int, bool,
 805                                 unsigned int *, unsigned int *);
 806 extern void vect_get_store_cost (struct data_reference *, int, unsigned int *);
 807
 808 /* In tree-vect-data-refs.c.  */
 809 extern bool vect_can_force_dr_alignment_p (const_tree, unsigned int);
 810 extern enum dr_alignment_support vect_supportable_dr_alignment
 811                                            (struct data_reference *, bool);
 812 extern tree vect_get_smallest_scalar_type (gimple, HOST_WIDE_INT *,
 813                                            HOST_WIDE_INT *);
 814 extern bool vect_analyze_data_ref_dependences (loop_vec_info, bb_vec_info,
 815                                                int *, bool *);
 816 extern bool vect_enhance_data_refs_alignment (loop_vec_info);
 817 extern bool vect_analyze_data_refs_alignment (loop_vec_info, bb_vec_info);
 818 extern bool vect_verify_datarefs_alignment (loop_vec_info, bb_vec_info);
 819 extern bool vect_analyze_data_ref_accesses (loop_vec_info, bb_vec_info);
 820 extern bool vect_prune_runtime_alias_test_list (loop_vec_info);
 821 extern bool vect_analyze_data_refs (loop_vec_info, bb_vec_info, int *);
 822 extern tree vect_create_data_ref_ptr (gimple, struct loop *, tree, tree *,
 823                                       gimple *, bool, bool *);
 824 extern tree bump_vector_ptr (tree, gimple, gimple_stmt_iterator *, gimple, tree);
 825 extern tree vect_create_destination_var (tree, tree);
 826 extern bool vect_strided_store_supported (tree);
 827 extern bool vect_strided_load_supported (tree);
 828 extern bool vect_permute_store_chain (VEC(tree,heap) *,unsigned int, gimple,
 829                                     gimple_stmt_iterator *, VEC(tree,heap) **);
 830 extern tree vect_setup_realignment (gimple, gimple_stmt_iterator *, tree *,
 831                                     enum dr_alignment_support, tree,
 832                                     struct loop **);
 833 extern bool vect_permute_load_chain (VEC(tree,heap) *,unsigned int, gimple,
 834                                     gimple_stmt_iterator *, VEC(tree,heap) **);
 835 extern bool vect_transform_strided_load (gimple, VEC(tree,heap) *, int,
 836                                          gimple_stmt_iterator *);
 837 extern int vect_get_place_in_interleaving_chain (gimple, gimple);
 838 extern tree vect_get_new_vect_var (tree, enum vect_var_kind, const char *);
 839 extern tree vect_create_addr_base_for_vector_ref (gimple, gimple_seq *,
 840                                                   tree, struct loop *);
 841
 842 /* In tree-vect-loop.c.  */
 843 /* FORNOW: Used in tree-parloops.c.  */
 844 extern void destroy_loop_vec_info (loop_vec_info, bool);
 845 extern gimple vect_force_simple_reduction (loop_vec_info, gimple, bool, bool *);
 846 /* Drive for loop analysis stage.  */
 847 extern loop_vec_info vect_analyze_loop (struct loop *);
 848 /* Drive for loop transformation stage.  */
 849 extern void vect_transform_loop (loop_vec_info);
 850 extern loop_vec_info vect_analyze_loop_form (struct loop *);
 851 extern bool vectorizable_live_operation (gimple, gimple_stmt_iterator *,
 852                                          gimple *);
 853 extern bool vectorizable_reduction (gimple, gimple_stmt_iterator *, gimple *,
 854                                     slp_tree);
 855 extern bool vectorizable_induction (gimple, gimple_stmt_iterator *, gimple *);
 856 extern int vect_estimate_min_profitable_iters (loop_vec_info);
 857 extern tree get_initial_def_for_reduction (gimple, tree, tree *);
 858 extern int vect_min_worthwhile_factor (enum tree_code);
 859 extern int vect_get_known_peeling_cost (loop_vec_info, int, int *, int);
 860 extern int vect_get_single_scalar_iteraion_cost (loop_vec_info);
 861
 862 /* In tree-vect-slp.c.  */
 863 extern void vect_free_slp_instance (slp_instance);
 864 extern bool vect_transform_slp_perm_load (gimple, VEC (tree, heap) *,
 865                                           gimple_stmt_iterator *, int,
 866                                           slp_instance, bool);
 867 extern bool vect_schedule_slp (loop_vec_info, bb_vec_info);
 868 extern void vect_update_slp_costs_according_to_vf (loop_vec_info);
 869 extern bool vect_analyze_slp (loop_vec_info, bb_vec_info);
 870 extern void vect_make_slp_decision (loop_vec_info);
 871 extern void vect_detect_hybrid_slp (loop_vec_info);
 872 extern void vect_get_slp_defs (tree, tree, slp_tree, VEC (tree,heap) **,
 873                                VEC (tree,heap) **, int);
 874 extern LOC find_bb_location (basic_block);
 875 extern bb_vec_info vect_slp_analyze_bb (basic_block);
 876 extern void vect_slp_transform_bb (basic_block);
 877
 878 /* In tree-vect-patterns.c.  */
 879 /* Pattern recognition functions.
 880    Additional pattern recognition functions can (and will) be added
 881    in the future.  */
 882 typedef gimple (* vect_recog_func_ptr) (gimple, tree *, tree *);
 883 #define NUM_PATTERNS 4
 884 void vect_pattern_recog (loop_vec_info);
 885
 886 /* In tree-vectorizer.c.  */
 887 unsigned vectorize_loops (void);
 888 /* Vectorization debug information */
 889 extern bool vect_print_dump_info (enum vect_verbosity_levels);
 890
 891 #endif  /* GCC_TREE_VECTORIZER_H  */