gcc/tree-vectorizer.h

   1 /* Loop Vectorization
   2    Copyright (C) 2003, 2004, 2005, 2006 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   /* Is the loop vectorizable? */
 103   bool vectorizable;
 104
 105   /* Unrolling factor  */
 106   int vectorization_factor;
 107
 108   /* Unknown DRs according to which loop was peeled.  */
 109   struct data_reference *unaligned_dr;
 110
 111   /* peeling_for_alignment indicates whether peeling for alignment will take
 112      place, and what the peeling factor should be:
 113      peeling_for_alignment = X means:
 114         If X=0: Peeling for alignment will not be applied.
 115         If X>0: Peel first X iterations.
 116         If X=-1: Generate a runtime test to calculate the number of iterations
 117                  to be peeled, using the dataref recorded in the field
 118                  unaligned_dr.  */
 119   int peeling_for_alignment;
 120
 121   /* The mask used to check the alignment of pointers or arrays.  */
 122   int ptr_mask;
 123
 124   /* All data references in the loop.  */
 125   VEC (data_reference_p, heap) *datarefs;
 126
 127   /* All data dependences in the loop.  */
 128   VEC (ddr_p, heap) *ddrs;
 129
 130   /* Statements in the loop that have data references that are candidates for a
 131      runtime (loop versioning) misalignment check.  */
 132   VEC(tree,heap) *may_misalign_stmts;
 133
 134   /* The loop location in the source.  */
 135   LOC loop_line_number;
 136 } *loop_vec_info;
 137
 138 /* Access Functions.  */
 139 #define LOOP_VINFO_LOOP(L)            (L)->loop
 140 #define LOOP_VINFO_BBS(L)             (L)->bbs
 141 #define LOOP_VINFO_EXIT_COND(L)       (L)->exit_cond
 142 #define LOOP_VINFO_NITERS(L)          (L)->num_iters
 143 #define LOOP_VINFO_VECTORIZABLE_P(L)  (L)->vectorizable
 144 #define LOOP_VINFO_VECT_FACTOR(L)     (L)->vectorization_factor
 145 #define LOOP_VINFO_PTR_MASK(L)        (L)->ptr_mask
 146 #define LOOP_VINFO_DATAREFS(L)        (L)->datarefs
 147 #define LOOP_VINFO_DDRS(L)            (L)->ddrs
 148 #define LOOP_VINFO_INT_NITERS(L)      (TREE_INT_CST_LOW ((L)->num_iters))
 149 #define LOOP_PEELING_FOR_ALIGNMENT(L) (L)->peeling_for_alignment
 150 #define LOOP_VINFO_UNALIGNED_DR(L)    (L)->unaligned_dr
 151 #define LOOP_VINFO_MAY_MISALIGN_STMTS(L) (L)->may_misalign_stmts
 152 #define LOOP_VINFO_LOC(L)             (L)->loop_line_number
 153
 154 #define LOOP_VINFO_NITERS_KNOWN_P(L)                     \
 155 (host_integerp ((L)->num_iters,0)                        \
 156 && TREE_INT_CST_LOW ((L)->num_iters) > 0)
 157
 158 /*-----------------------------------------------------------------*/
 159 /* Info on vectorized defs.                                        */
 160 /*-----------------------------------------------------------------*/
 161 enum stmt_vec_info_type {
 162   undef_vec_info_type = 0,
 163   load_vec_info_type,
 164   store_vec_info_type,
 165   op_vec_info_type,
 166   call_vec_info_type,
 167   assignment_vec_info_type,
 168   condition_vec_info_type,
 169   reduc_vec_info_type,
 170   type_promotion_vec_info_type,
 171   type_demotion_vec_info_type,
 172   type_conversion_vec_info_type
 173 };
 174
 175 /* Indicates whether/how a variable is used in the loop.  */
 176 enum vect_relevant {
 177   vect_unused_in_loop = 0,
 178
 179   /* defs that feed computations that end up (only) in a reduction. These
 180      defs may be used by non-reduction stmts, but eventually, any
 181      computations/values that are affected by these defs are used to compute
 182      a reduction (i.e. don't get stored to memory, for example). We use this
 183      to identify computations that we can change the order in which they are
 184      computed.  */
 185   vect_used_by_reduction,
 186
 187   vect_used_in_loop
 188 };
 189
 190 typedef struct data_reference *dr_p;
 191 DEF_VEC_P(dr_p);
 192 DEF_VEC_ALLOC_P(dr_p,heap);
 193
 194 typedef struct _stmt_vec_info {
 195
 196   enum stmt_vec_info_type type;
 197
 198   /* The stmt to which this info struct refers to.  */
 199   tree stmt;
 200
 201   /* The loop_vec_info with respect to which STMT is vectorized.  */
 202   loop_vec_info loop_vinfo;
 203
 204   /* Not all stmts in the loop need to be vectorized. e.g, the increment
 205      of the loop induction variable and computation of array indexes. relevant
 206      indicates whether the stmt needs to be vectorized.  */
 207   enum vect_relevant relevant;
 208
 209   /* Indicates whether this stmts is part of a computation whose result is
 210      used outside the loop.  */
 211   bool live;
 212
 213   /* The vector type to be used.  */
 214   tree vectype;
 215
 216   /* The vectorized version of the stmt.  */
 217   tree vectorized_stmt;
 218
 219
 220   /** The following is relevant only for stmts that contain a non-scalar
 221      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 222      at most one such data-ref.  **/
 223
 224   /* Information about the data-ref (access function, etc).  */
 225   struct data_reference *data_ref_info;
 226
 227   /* Stmt is part of some pattern (computation idiom)  */
 228   bool in_pattern_p;
 229
 230   /* Used for various bookkeeping purposes, generally holding a pointer to
 231      some other stmt S that is in some way "related" to this stmt.
 232      Current use of this field is:
 233         If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
 234         true): S is the "pattern stmt" that represents (and replaces) the
 235         sequence of stmts that constitutes the pattern.  Similarly, the
 236         related_stmt of the "pattern stmt" points back to this stmt (which is
 237         the last stmt in the original sequence of stmts that constitutes the
 238         pattern).  */
 239   tree related_stmt;
 240
 241   /* List of datarefs that are known to have the same alignment as the dataref
 242      of this stmt.  */
 243   VEC(dr_p,heap) *same_align_refs;
 244
 245   /* Classify the def of this stmt.  */
 246   enum vect_def_type def_type;
 247
 248   /* Interleaving info.  */
 249   /* First data-ref in the interleaving group.  */
 250   tree first_dr;
 251   /* Pointer to the next data-ref in the group.  */
 252   tree next_dr;
 253   /* The size of the interleaving group.  */
 254   unsigned int size;
 255   /* For stores, number of stores from this group seen. We vectorize the last
 256      one.  */
 257   unsigned int store_count;
 258   /* For loads only, the gap from the previous load. For consecutive loads, GAP
 259      is 1.  */
 260   unsigned int gap;
 261   /* In case that two or more stmts share data-ref, this is the pointer to the
 262      previously detected stmt with the same dr.  */
 263   tree same_dr_stmt;
 264   /* For loads only, if there is a store with the same location, this field is
 265      TRUE.  */
 266   bool read_write_dep;
 267 } *stmt_vec_info;
 268
 269 /* Access Functions.  */
 270 #define STMT_VINFO_TYPE(S)                 (S)->type
 271 #define STMT_VINFO_STMT(S)                 (S)->stmt
 272 #define STMT_VINFO_LOOP_VINFO(S)           (S)->loop_vinfo
 273 #define STMT_VINFO_RELEVANT(S)             (S)->relevant
 274 #define STMT_VINFO_LIVE_P(S)               (S)->live
 275 #define STMT_VINFO_VECTYPE(S)              (S)->vectype
 276 #define STMT_VINFO_VEC_STMT(S)             (S)->vectorized_stmt
 277 #define STMT_VINFO_DATA_REF(S)             (S)->data_ref_info
 278 #define STMT_VINFO_IN_PATTERN_P(S)         (S)->in_pattern_p
 279 #define STMT_VINFO_RELATED_STMT(S)         (S)->related_stmt
 280 #define STMT_VINFO_SAME_ALIGN_REFS(S)      (S)->same_align_refs
 281 #define STMT_VINFO_DEF_TYPE(S)             (S)->def_type
 282 #define STMT_VINFO_DR_GROUP_FIRST_DR(S)    (S)->first_dr
 283 #define STMT_VINFO_DR_GROUP_NEXT_DR(S)     (S)->next_dr
 284 #define STMT_VINFO_DR_GROUP_SIZE(S)        (S)->size
 285 #define STMT_VINFO_DR_GROUP_STORE_COUNT(S) (S)->store_count
 286 #define STMT_VINFO_DR_GROUP_GAP(S)         (S)->gap
 287 #define STMT_VINFO_DR_GROUP_SAME_DR_STMT(S)(S)->same_dr_stmt
 288 #define STMT_VINFO_DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 289
 290 #define DR_GROUP_FIRST_DR(S)               (S)->first_dr
 291 #define DR_GROUP_NEXT_DR(S)                (S)->next_dr
 292 #define DR_GROUP_SIZE(S)                   (S)->size
 293 #define DR_GROUP_STORE_COUNT(S)            (S)->store_count
 294 #define DR_GROUP_GAP(S)                    (S)->gap
 295 #define DR_GROUP_SAME_DR_STMT(S)           (S)->same_dr_stmt
 296 #define DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
 297
 298 #define STMT_VINFO_RELEVANT_P(S)          ((S)->relevant != vect_unused_in_loop)
 299
 300 static inline void set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info);
 301 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
 302
 303 static inline void
 304 set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info)
 305 {
 306   if (ann)
 307     ann->common.aux = (char *) stmt_info;
 308 }
 309
 310 static inline stmt_vec_info
 311 vinfo_for_stmt (tree stmt)
 312 {
 313   stmt_ann_t ann = stmt_ann (stmt);
 314   return ann ? (stmt_vec_info) ann->common.aux : NULL;
 315 }
 316
 317 static inline bool
 318 is_pattern_stmt_p (stmt_vec_info stmt_info)
 319 {
 320   tree related_stmt;
 321   stmt_vec_info related_stmt_info;
 322
 323   related_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
 324   if (related_stmt
 325       && (related_stmt_info = vinfo_for_stmt (related_stmt))
 326       && STMT_VINFO_IN_PATTERN_P (related_stmt_info))
 327     return true;
 328
 329   return false;
 330 }
 331
 332 /*-----------------------------------------------------------------*/
 333 /* Info on data references alignment.                              */
 334 /*-----------------------------------------------------------------*/
 335
 336 /* Reflects actual alignment of first access in the vectorized loop,
 337    taking into account peeling/versioning if applied.  */
 338 #define DR_MISALIGNMENT(DR)   (DR)->aux
 339
 340 static inline bool
 341 aligned_access_p (struct data_reference *data_ref_info)
 342 {
 343   return (DR_MISALIGNMENT (data_ref_info) == 0);
 344 }
 345
 346 static inline bool
 347 known_alignment_for_access_p (struct data_reference *data_ref_info)
 348 {
 349   return (DR_MISALIGNMENT (data_ref_info) != -1);
 350 }
 351
 352 /* vect_dump will be set to stderr or dump_file if exist.  */
 353 extern FILE *vect_dump;
 354 extern enum verbosity_levels vect_verbosity_level;
 355
 356 /* Bitmap of virtual variables to be renamed.  */
 357 extern bitmap vect_memsyms_to_rename;
 358
 359 /*-----------------------------------------------------------------*/
 360 /* Function prototypes.                                            */
 361 /*-----------------------------------------------------------------*/
 362
 363 /*************************************************************************
 364   Simple Loop Peeling Utilities - in tree-vectorizer.c
 365  *************************************************************************/
 366 /* Entry point for peeling of simple loops.
 367    Peel the first/last iterations of a loop.
 368    It can be used outside of the vectorizer for loops that are simple enough
 369    (see function documentation).  In the vectorizer it is used to peel the
 370    last few iterations when the loop bound is unknown or does not evenly
 371    divide by the vectorization factor, and to peel the first few iterations
 372    to force the alignment of data references in the loop.  */
 373 extern struct loop *slpeel_tree_peel_loop_to_edge
 374   (struct loop *, edge, tree, tree, bool, unsigned int);
 375 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 376 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
 377 #ifdef ENABLE_CHECKING
 378 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
 379 #endif
 380
 381
 382 /*************************************************************************
 383   General Vectorization Utilities
 384  *************************************************************************/
 385 /** In tree-vectorizer.c **/
 386 extern tree get_vectype_for_scalar_type (tree);
 387 extern bool vect_is_simple_use (tree, loop_vec_info, tree *, tree *,
 388                                 enum vect_def_type *);
 389 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
 390 extern tree vect_is_simple_reduction (struct loop *, tree);
 391 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 392 extern enum dr_alignment_support vect_supportable_dr_alignment
 393   (struct data_reference *);
 394 extern bool reduction_code_for_scalar_code (enum tree_code, enum tree_code *);
 395 extern bool supportable_widening_operation (enum tree_code, tree, tree,
 396   tree *, tree *, enum tree_code *, enum tree_code *);
 397 /* Creation and deletion of loop and stmt info structs.  */
 398 extern loop_vec_info new_loop_vec_info (struct loop *loop);
 399 extern void destroy_loop_vec_info (loop_vec_info);
 400 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
 401
 402
 403 /** In tree-vect-analyze.c  **/
 404 /* Driver for analysis stage.  */
 405 extern loop_vec_info vect_analyze_loop (struct loop *);
 406
 407
 408 /** In tree-vect-patterns.c  **/
 409 /* Pattern recognition functions.
 410    Additional pattern recognition functions can (and will) be added
 411    in the future.  */
 412 typedef tree (* vect_recog_func_ptr) (tree, tree *, tree *);
 413 #define NUM_PATTERNS 4
 414 void vect_pattern_recog (loop_vec_info);
 415
 416
 417 /** In tree-vect-transform.c  **/
 418 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
 419 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
 420 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
 421 extern bool vectorizable_type_promotion (tree, block_stmt_iterator *, tree *);
 422 extern bool vectorizable_type_demotion (tree, block_stmt_iterator *, tree *);
 423 extern bool vectorizable_conversion (tree, block_stmt_iterator *,
 424                                      tree *);
 425 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
 426 extern tree vectorizable_function (tree, tree, tree);
 427 extern bool vectorizable_call (tree, block_stmt_iterator *, tree *);
 428 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
 429 extern bool vectorizable_live_operation (tree, block_stmt_iterator *, tree *);
 430 extern bool vectorizable_reduction (tree, block_stmt_iterator *, tree *);
 431 /* Driver for transformation stage.  */
 432 extern void vect_transform_loop (loop_vec_info);
 433
 434 /*************************************************************************
 435   Vectorization Debug Information - in tree-vectorizer.c
 436  *************************************************************************/
 437 extern bool vect_print_dump_info (enum verbosity_levels);
 438 extern void vect_set_verbosity_level (const char *);
 439 extern LOC find_loop_location (struct loop *);
 440
 441 #endif  /* GCC_TREE_VECTORIZER_H  */