gcc/tree-vectorizer.h

   1 /* Loop Vectorization
   2    Copyright (C) 2003, 2004, 2005 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: unary or binary.  */
  47 enum operation_type {
  48   unary_op = 1,
  49   binary_op
  50 };
  51
  52 /* Define type of available alignment support.  */
  53 enum dr_alignment_support {
  54   dr_unaligned_unsupported,
  55   dr_unaligned_supported,
  56   dr_unaligned_software_pipeline,
  57   dr_aligned
  58 };
  59
  60 /* Define type of def-use cross-iteration cycle.  */
  61 enum vect_def_type {
  62   vect_constant_def,
  63   vect_invariant_def,
  64   vect_loop_def,
  65   vect_induction_def,
  66   vect_reduction_def,
  67   vect_unknown_def_type
  68 };
  69
  70 /* Define verbosity levels.  */
  71 enum verbosity_levels {
  72   REPORT_NONE,
  73   REPORT_VECTORIZED_LOOPS,
  74   REPORT_UNVECTORIZED_LOOPS,
  75   REPORT_ALIGNMENT,
  76   REPORT_DR_DETAILS,
  77   REPORT_BAD_FORM_LOOPS,
  78   REPORT_OUTER_LOOPS,
  79   REPORT_DETAILS,
  80   /* New verbosity levels should be added before this one.  */
  81   MAX_VERBOSITY_LEVEL
  82 };
  83
  84 /*-----------------------------------------------------------------*/
  85 /* Info on vectorized loops.                                       */
  86 /*-----------------------------------------------------------------*/
  87 typedef struct _loop_vec_info {
  88
  89   /* The loop to which this info struct refers to.  */
  90   struct loop *loop;
  91
  92   /* The loop basic blocks.  */
  93   basic_block *bbs;
  94
  95   /* The loop exit_condition.  */
  96   tree exit_cond;
  97
  98   /* Number of iterations.  */
  99   tree num_iters;
 100
 101   /* Is the loop vectorizable? */
 102   bool vectorizable;
 103
 104   /* Unrolling factor  */
 105   int vectorization_factor;
 106
 107   /* Unknown DRs according to which loop was peeled.  */
 108   struct data_reference *unaligned_dr;
 109
 110   /* peeling_for_alignment indicates whether peeling for alignment will take
 111      place, and what the peeling factor should be:
 112      peeling_for_alignment = X means:
 113         If X=0: Peeling for alignment will not be applied.
 114         If X>0: Peel first X iterations.
 115         If X=-1: Generate a runtime test to calculate the number of iterations
 116                  to be peeled, using the dataref recorded in the field
 117                  unaligned_dr.  */
 118   int peeling_for_alignment;
 119
 120   /* All data references in the loop.  */
 121   varray_type datarefs;
 122
 123   /* All data dependences in the loop.  */
 124   varray_type ddrs;
 125
 126   /* The loop location in the source.  */
 127   LOC loop_line_number;
 128 } *loop_vec_info;
 129
 130   /* Access Functions.  */
 131 #define LOOP_VINFO_LOOP(L)            (L)->loop
 132 #define LOOP_VINFO_BBS(L)             (L)->bbs
 133 #define LOOP_VINFO_EXIT_COND(L)       (L)->exit_cond
 134 #define LOOP_VINFO_NITERS(L)          (L)->num_iters
 135 #define LOOP_VINFO_VECTORIZABLE_P(L)  (L)->vectorizable
 136 #define LOOP_VINFO_VECT_FACTOR(L)     (L)->vectorization_factor
 137 #define LOOP_VINFO_DATAREFS(L)        (L)->datarefs
 138 #define LOOP_VINFO_DDRS(L)            (L)->ddrs
 139 #define LOOP_VINFO_INT_NITERS(L)      (TREE_INT_CST_LOW ((L)->num_iters))
 140 #define LOOP_PEELING_FOR_ALIGNMENT(L) (L)->peeling_for_alignment
 141 #define LOOP_VINFO_UNALIGNED_DR(L)    (L)->unaligned_dr
 142 #define LOOP_VINFO_LOC(L)             (L)->loop_line_number
 143
 144 #define LOOP_VINFO_NITERS_KNOWN_P(L)                     \
 145 (host_integerp ((L)->num_iters,0)                        \
 146 && TREE_INT_CST_LOW ((L)->num_iters) > 0)
 147
 148 /*-----------------------------------------------------------------*/
 149 /* Info on vectorized defs.                                        */
 150 /*-----------------------------------------------------------------*/
 151 enum stmt_vec_info_type {
 152   undef_vec_info_type = 0,
 153   load_vec_info_type,
 154   store_vec_info_type,
 155   op_vec_info_type,
 156   assignment_vec_info_type,
 157   condition_vec_info_type,
 158   reduc_vec_info_type
 159 };
 160
 161 typedef struct data_reference *dr_p;
 162 DEF_VEC_P(dr_p);
 163 DEF_VEC_ALLOC_P(dr_p,heap);
 164
 165 typedef struct _stmt_vec_info {
 166
 167   enum stmt_vec_info_type type;
 168
 169   /* The stmt to which this info struct refers to.  */
 170   tree stmt;
 171
 172   /* The loop_vec_info with respect to which STMT is vectorized.  */
 173   loop_vec_info loop_vinfo;
 174
 175   /* Not all stmts in the loop need to be vectorized. e.g, the incrementation
 176      of the loop induction variable and computation of array indexes. relevant
 177      indicates whether the stmt needs to be vectorized.  */
 178   bool relevant;
 179
 180   /* Indicates whether this stmts is part of a computation whose result is
 181      used outside the loop.  */
 182   bool live;
 183
 184   /* The vector type to be used.  */
 185   tree vectype;
 186
 187   /* The vectorized version of the stmt.  */
 188   tree vectorized_stmt;
 189
 190
 191   /** The following is relevant only for stmts that contain a non-scalar
 192      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 193      at most one such data-ref.  **/
 194
 195   /* Information about the data-ref (access function, etc).  */
 196   struct data_reference *data_ref_info;
 197
 198   /* List of datarefs that are known to have the same alignment as the dataref
 199      of this stmt.  */
 200   VEC(dr_p,heap) *same_align_refs;
 201
 202   /* Classify the def of this stmt.  */
 203   enum vect_def_type def_type;
 204
 205 } *stmt_vec_info;
 206
 207 /* Access Functions.  */
 208 #define STMT_VINFO_TYPE(S)                (S)->type
 209 #define STMT_VINFO_STMT(S)                (S)->stmt
 210 #define STMT_VINFO_LOOP_VINFO(S)          (S)->loop_vinfo
 211 #define STMT_VINFO_RELEVANT_P(S)          (S)->relevant
 212 #define STMT_VINFO_LIVE_P(S)              (S)->live
 213 #define STMT_VINFO_VECTYPE(S)             (S)->vectype
 214 #define STMT_VINFO_VEC_STMT(S)            (S)->vectorized_stmt
 215 #define STMT_VINFO_DATA_REF(S)            (S)->data_ref_info
 216 #define STMT_VINFO_SAME_ALIGN_REFS(S)     (S)->same_align_refs
 217 #define STMT_VINFO_DEF_TYPE(S)            (S)->def_type
 218
 219 static inline void set_stmt_info (tree_ann_t ann, stmt_vec_info stmt_info);
 220 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
 221
 222 static inline void
 223 set_stmt_info (tree_ann_t ann, stmt_vec_info stmt_info)
 224 {
 225   if (ann)
 226     ann->common.aux = (char *) stmt_info;
 227 }
 228
 229 static inline stmt_vec_info
 230 vinfo_for_stmt (tree stmt)
 231 {
 232   tree_ann_t ann = tree_ann (stmt);
 233   return ann ? (stmt_vec_info) ann->common.aux : NULL;
 234 }
 235
 236 /*-----------------------------------------------------------------*/
 237 /* Info on data references alignment.                              */
 238 /*-----------------------------------------------------------------*/
 239
 240 /* Reflects actual alignment of first access in the vectorized loop,
 241    taking into account peeling/versioning if applied.  */
 242 #define DR_MISALIGNMENT(DR)   (DR)->aux
 243
 244 static inline bool
 245 aligned_access_p (struct data_reference *data_ref_info)
 246 {
 247   return (DR_MISALIGNMENT (data_ref_info) == 0);
 248 }
 249
 250 static inline bool
 251 known_alignment_for_access_p (struct data_reference *data_ref_info)
 252 {
 253   return (DR_MISALIGNMENT (data_ref_info) != -1);
 254 }
 255
 256 /* Perform signed modulo, always returning a non-negative value.  */
 257 #define VECT_SMODULO(x,y) ((x) % (y) < 0 ? ((x) % (y) + (y)) : (x) % (y))
 258
 259 /* vect_dump will be set to stderr or dump_file if exist.  */
 260 extern FILE *vect_dump;
 261 extern enum verbosity_levels vect_verbosity_level;
 262
 263 /* Number of loops, at the beginning of vectorization.  */
 264 extern unsigned int vect_loops_num;
 265
 266 /* Bitmap of virtual variables to be renamed.  */
 267 extern bitmap vect_vnames_to_rename;
 268
 269 /*-----------------------------------------------------------------*/
 270 /* Function prototypes.                                            */
 271 /*-----------------------------------------------------------------*/
 272
 273 /*************************************************************************
 274   Simple Loop Peeling Utilities - in tree-vectorizer.c
 275  *************************************************************************/
 276 /* Entry point for peeling of simple loops.
 277    Peel the first/last iterations of a loop.
 278    It can be used outside of the vectorizer for loops that are simple enough
 279    (see function documentation).  In the vectorizer it is used to peel the
 280    last few iterations when the loop bound is unknown or does not evenly
 281    divide by the vectorization factor, and to peel the first few iterations
 282    to force the alignment of data references in the loop.  */
 283 extern struct loop *slpeel_tree_peel_loop_to_edge
 284   (struct loop *, struct loops *, edge, tree, tree, bool);
 285 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 286 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
 287 #ifdef ENABLE_CHECKING
 288 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
 289 #endif
 290
 291
 292 /*************************************************************************
 293   General Vectorization Utilities
 294  *************************************************************************/
 295 /** In tree-vectorizer.c **/
 296 extern tree vect_strip_conversion (tree);
 297 extern tree get_vectype_for_scalar_type (tree);
 298 extern bool vect_is_simple_use (tree, loop_vec_info, tree *, tree *,
 299                                 enum vect_def_type *);
 300 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
 301 extern tree vect_is_simple_reduction (struct loop *, tree);
 302 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 303 extern enum dr_alignment_support vect_supportable_dr_alignment
 304   (struct data_reference *);
 305 extern bool reduction_code_for_scalar_code (enum tree_code, enum tree_code *);
 306
 307 /* Creation and deletion of loop and stmt info structs.  */
 308 extern loop_vec_info new_loop_vec_info (struct loop *loop);
 309 extern void destroy_loop_vec_info (loop_vec_info);
 310 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
 311 /* Main driver.  */
 312 extern void vectorize_loops (struct loops *);
 313
 314 /** In tree-vect-analyze.c  **/
 315 /* Driver for analysis stage.  */
 316 extern loop_vec_info vect_analyze_loop (struct loop *);
 317
 318 /** In tree-vect-transform.c  **/
 319 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
 320 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
 321 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
 322 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
 323 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
 324 extern bool vectorizable_live_operation (tree, block_stmt_iterator *, tree *);
 325 extern bool vectorizable_reduction (tree, block_stmt_iterator *, tree *);
 326 /* Driver for transformation stage.  */
 327 extern void vect_transform_loop (loop_vec_info, struct loops *);
 328
 329 /*************************************************************************
 330   Vectorization Debug Information - in tree-vectorizer.c
 331  *************************************************************************/
 332 extern bool vect_print_dump_info (enum verbosity_levels);
 333 extern void vect_set_verbosity_level (const char *);
 334 extern LOC find_loop_location (struct loop *);
 335
 336 #endif  /* GCC_TREE_VECTORIZER_H  */