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   assignment_vec_info_type,
 167   condition_vec_info_type,
 168   reduc_vec_info_type
 169 };
 170
 171 typedef struct data_reference *dr_p;
 172 DEF_VEC_P(dr_p);
 173 DEF_VEC_ALLOC_P(dr_p,heap);
 174
 175 typedef struct _stmt_vec_info {
 176
 177   enum stmt_vec_info_type type;
 178
 179   /* The stmt to which this info struct refers to.  */
 180   tree stmt;
 181
 182   /* The loop_vec_info with respect to which STMT is vectorized.  */
 183   loop_vec_info loop_vinfo;
 184
 185   /* Not all stmts in the loop need to be vectorized. e.g, the incrementation
 186      of the loop induction variable and computation of array indexes. relevant
 187      indicates whether the stmt needs to be vectorized.  */
 188   bool relevant;
 189
 190   /* Indicates whether this stmts is part of a computation whose result is
 191      used outside the loop.  */
 192   bool live;
 193
 194   /* The vector type to be used.  */
 195   tree vectype;
 196
 197   /* The vectorized version of the stmt.  */
 198   tree vectorized_stmt;
 199
 200
 201   /** The following is relevant only for stmts that contain a non-scalar
 202      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 203      at most one such data-ref.  **/
 204
 205   /* Information about the data-ref (access function, etc).  */
 206   struct data_reference *data_ref_info;
 207
 208   /* Stmt is part of some pattern (computation idiom)  */
 209   bool in_pattern_p;
 210
 211   /* Used for various bookkeeping purposes, generally holding a pointer to
 212      some other stmt S that is in some way "related" to this stmt.
 213      Current use of this field is:
 214         If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
 215         true): S is the "pattern stmt" that represents (and replaces) the
 216         sequence of stmts that constitutes the pattern.  Similarly, the
 217         related_stmt of the "pattern stmt" points back to this stmt (which is
 218         the last stmt in the original sequence of stmts that constitutes the
 219         pattern).  */
 220   tree related_stmt;
 221
 222   /* List of datarefs that are known to have the same alignment as the dataref
 223      of this stmt.  */
 224   VEC(dr_p,heap) *same_align_refs;
 225
 226   /* Classify the def of this stmt.  */
 227   enum vect_def_type def_type;
 228
 229 } *stmt_vec_info;
 230
 231 /* Access Functions.  */
 232 #define STMT_VINFO_TYPE(S)                (S)->type
 233 #define STMT_VINFO_STMT(S)                (S)->stmt
 234 #define STMT_VINFO_LOOP_VINFO(S)          (S)->loop_vinfo
 235 #define STMT_VINFO_RELEVANT_P(S)          (S)->relevant
 236 #define STMT_VINFO_LIVE_P(S)              (S)->live
 237 #define STMT_VINFO_VECTYPE(S)             (S)->vectype
 238 #define STMT_VINFO_VEC_STMT(S)            (S)->vectorized_stmt
 239 #define STMT_VINFO_DATA_REF(S)            (S)->data_ref_info
 240 #define STMT_VINFO_IN_PATTERN_P(S)        (S)->in_pattern_p
 241 #define STMT_VINFO_RELATED_STMT(S)        (S)->related_stmt
 242 #define STMT_VINFO_SAME_ALIGN_REFS(S)     (S)->same_align_refs
 243 #define STMT_VINFO_DEF_TYPE(S)            (S)->def_type
 244
 245 static inline void set_stmt_info (tree_ann_t ann, stmt_vec_info stmt_info);
 246 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
 247
 248 static inline void
 249 set_stmt_info (tree_ann_t ann, stmt_vec_info stmt_info)
 250 {
 251   if (ann)
 252     ann->common.aux = (char *) stmt_info;
 253 }
 254
 255 static inline stmt_vec_info
 256 vinfo_for_stmt (tree stmt)
 257 {
 258   tree_ann_t ann = tree_ann (stmt);
 259   return ann ? (stmt_vec_info) ann->common.aux : NULL;
 260 }
 261
 262 /*-----------------------------------------------------------------*/
 263 /* Info on data references alignment.                              */
 264 /*-----------------------------------------------------------------*/
 265
 266 /* Reflects actual alignment of first access in the vectorized loop,
 267    taking into account peeling/versioning if applied.  */
 268 #define DR_MISALIGNMENT(DR)   (DR)->aux
 269
 270 static inline bool
 271 aligned_access_p (struct data_reference *data_ref_info)
 272 {
 273   return (DR_MISALIGNMENT (data_ref_info) == 0);
 274 }
 275
 276 static inline bool
 277 known_alignment_for_access_p (struct data_reference *data_ref_info)
 278 {
 279   return (DR_MISALIGNMENT (data_ref_info) != -1);
 280 }
 281
 282 /* Perform signed modulo, always returning a non-negative value.  */
 283 #define VECT_SMODULO(x,y) ((x) % (y) < 0 ? ((x) % (y) + (y)) : (x) % (y))
 284
 285 /* vect_dump will be set to stderr or dump_file if exist.  */
 286 extern FILE *vect_dump;
 287 extern enum verbosity_levels vect_verbosity_level;
 288
 289 /* Number of loops, at the beginning of vectorization.  */
 290 extern unsigned int vect_loops_num;
 291
 292 /* Bitmap of virtual variables to be renamed.  */
 293 extern bitmap vect_vnames_to_rename;
 294
 295 /*-----------------------------------------------------------------*/
 296 /* Function prototypes.                                            */
 297 /*-----------------------------------------------------------------*/
 298
 299 /*************************************************************************
 300   Simple Loop Peeling Utilities - in tree-vectorizer.c
 301  *************************************************************************/
 302 /* Entry point for peeling of simple loops.
 303    Peel the first/last iterations of a loop.
 304    It can be used outside of the vectorizer for loops that are simple enough
 305    (see function documentation).  In the vectorizer it is used to peel the
 306    last few iterations when the loop bound is unknown or does not evenly
 307    divide by the vectorization factor, and to peel the first few iterations
 308    to force the alignment of data references in the loop.  */
 309 extern struct loop *slpeel_tree_peel_loop_to_edge
 310   (struct loop *, struct loops *, edge, tree, tree, bool);
 311 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 312 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
 313 #ifdef ENABLE_CHECKING
 314 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
 315 #endif
 316
 317
 318 /*************************************************************************
 319   General Vectorization Utilities
 320  *************************************************************************/
 321 /** In tree-vectorizer.c **/
 322 extern tree get_vectype_for_scalar_type (tree);
 323 extern bool vect_is_simple_use (tree, loop_vec_info, tree *, tree *,
 324                                 enum vect_def_type *);
 325 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
 326 extern tree vect_is_simple_reduction (struct loop *, tree);
 327 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 328 extern enum dr_alignment_support vect_supportable_dr_alignment
 329   (struct data_reference *);
 330 extern bool reduction_code_for_scalar_code (enum tree_code, enum tree_code *);
 331 /* Creation and deletion of loop and stmt info structs.  */
 332 extern loop_vec_info new_loop_vec_info (struct loop *loop);
 333 extern void destroy_loop_vec_info (loop_vec_info);
 334 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
 335 /* Main driver.  */
 336 extern void vectorize_loops (struct loops *);
 337
 338
 339 /** In tree-vect-analyze.c  **/
 340 /* Driver for analysis stage.  */
 341 extern loop_vec_info vect_analyze_loop (struct loop *);
 342
 343
 344 /** In tree-vect-patterns.c  **/
 345 /* Pattern recognition functions.
 346    Additional pattern recognition functions can (and will) be added
 347    in the future.  */
 348 typedef tree (* vect_recog_func_ptr) (tree, tree *, tree *);
 349 #define NUM_PATTERNS 3
 350 void vect_pattern_recog (loop_vec_info);
 351
 352
 353 /** In tree-vect-transform.c  **/
 354 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
 355 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
 356 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
 357 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
 358 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
 359 extern bool vectorizable_live_operation (tree, block_stmt_iterator *, tree *);
 360 extern bool vectorizable_reduction (tree, block_stmt_iterator *, tree *);
 361 /* Driver for transformation stage.  */
 362 extern void vect_transform_loop (loop_vec_info, struct loops *);
 363
 364 /*************************************************************************
 365   Vectorization Debug Information - in tree-vectorizer.c
 366  *************************************************************************/
 367 extern bool vect_print_dump_info (enum verbosity_levels);
 368 extern void vect_set_verbosity_level (const char *);
 369 extern LOC find_loop_location (struct loop *);
 370
 371 #endif  /* GCC_TREE_VECTORIZER_H  */