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