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   condition_vec_info_type
 149 };
 150
 151 typedef struct _stmt_vec_info {
 152
 153   enum stmt_vec_info_type type;
 154
 155   /* The stmt to which this info struct refers to.  */
 156   tree stmt;
 157
 158   /* The loop_vec_info with respect to which STMT is vectorized.  */
 159   loop_vec_info loop_vinfo;
 160
 161   /* Not all stmts in the loop need to be vectorized. e.g, the incrementation
 162      of the loop induction variable and computation of array indexes. relevant
 163      indicates whether the stmt needs to be vectorized.  */
 164   bool relevant;
 165
 166   /* The vector type to be used.  */
 167   tree vectype;
 168
 169   /* The vectorized version of the stmt.  */
 170   tree vectorized_stmt;
 171
 172
 173   /** The following is relevant only for stmts that contain a non-scalar
 174      data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
 175      at most one such data-ref.  **/
 176
 177   /* Information about the data-ref (access function, etc).  */
 178   struct data_reference *data_ref_info;
 179
 180   /* Aliasing information.  This field represents the symbol that
 181      should be aliased by a pointer holding the address of this data
 182      reference.  If the original data reference was a pointer
 183      dereference, then this field contains the memory tag that should
 184      be used by the new vector-pointer.  */
 185   tree memtag;
 186   struct ptr_info_def *ptr_info;
 187   subvar_t subvars;
 188
 189   /** The following fields are used to store the information about
 190       data-reference. {base_address + initial_offset} is the first location
 191       accessed by data-ref in the loop, and step is the stride of data-ref in
 192       the loop in bytes;
 193       e.g.:
 194
 195                        Example 1                      Example 2
 196       data-ref         a[j].b[i][j]                   a + 4B (a is int*)
 197
 198       base_address     &a                             a
 199       initial_offset   j_0*D_j + i_0*D_i + C          4
 200       step             D_j                            4
 201
 202       data-reference structure info:
 203       base_name        a                              NULL
 204       access_fn        <access_fns of indexes of b>   (0, +, 1)
 205
 206   **/
 207   /* The above base_address, offset and step.  */
 208   tree base_address;
 209   tree initial_offset;
 210   tree step;
 211
 212   /* Alignment information. Whether the base of the data-reference is aligned
 213      to vectype.  */
 214   bool base_aligned_p;
 215   /* Alignment information. The offset of the data-reference from its base
 216      in bytes.  */
 217   tree misalignment;
 218 } *stmt_vec_info;
 219
 220 /* Access Functions.  */
 221 #define STMT_VINFO_TYPE(S)                (S)->type
 222 #define STMT_VINFO_STMT(S)                (S)->stmt
 223 #define STMT_VINFO_LOOP_VINFO(S)          (S)->loop_vinfo
 224 #define STMT_VINFO_RELEVANT_P(S)          (S)->relevant
 225 #define STMT_VINFO_VECTYPE(S)             (S)->vectype
 226 #define STMT_VINFO_VEC_STMT(S)            (S)->vectorized_stmt
 227 #define STMT_VINFO_DATA_REF(S)            (S)->data_ref_info
 228 #define STMT_VINFO_MEMTAG(S)              (S)->memtag
 229 #define STMT_VINFO_PTR_INFO(S)            (S)->ptr_info
 230 #define STMT_VINFO_SUBVARS(S)             (S)->subvars
 231 #define STMT_VINFO_VECT_DR_BASE_ADDRESS(S)(S)->base_address
 232 #define STMT_VINFO_VECT_INIT_OFFSET(S)    (S)->initial_offset
 233 #define STMT_VINFO_VECT_STEP(S)           (S)->step
 234 #define STMT_VINFO_VECT_BASE_ALIGNED_P(S) (S)->base_aligned_p
 235 #define STMT_VINFO_VECT_MISALIGNMENT(S)   (S)->misalignment
 236
 237 static inline void set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info);
 238 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
 239
 240 static inline void
 241 set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info)
 242 {
 243   if (ann)
 244     ann->common.aux = (char *) stmt_info;
 245 }
 246
 247 static inline stmt_vec_info
 248 vinfo_for_stmt (tree stmt)
 249 {
 250   stmt_ann_t ann = stmt_ann (stmt);
 251   return ann ? (stmt_vec_info) ann->common.aux : NULL;
 252 }
 253
 254 /*-----------------------------------------------------------------*/
 255 /* Info on data references alignment.                              */
 256 /*-----------------------------------------------------------------*/
 257
 258 /* Reflects actual alignment of first access in the vectorized loop,
 259    taking into account peeling/versioning if applied.  */
 260 #define DR_MISALIGNMENT(DR)   (DR)->aux
 261
 262 static inline bool
 263 aligned_access_p (struct data_reference *data_ref_info)
 264 {
 265   return (DR_MISALIGNMENT (data_ref_info) == 0);
 266 }
 267
 268 static inline bool
 269 known_alignment_for_access_p (struct data_reference *data_ref_info)
 270 {
 271   return (DR_MISALIGNMENT (data_ref_info) != -1);
 272 }
 273
 274 /* Perform signed modulo, always returning a non-negative value.  */
 275 #define VECT_SMODULO(x,y) ((x) % (y) < 0 ? ((x) % (y) + (y)) : (x) % (y))
 276
 277 /* vect_dump will be set to stderr or dump_file if exist.  */
 278 extern FILE *vect_dump;
 279 extern enum verbosity_levels vect_verbosity_level;
 280
 281 /* Number of loops, at the beginning of vectorization.  */
 282 extern unsigned int vect_loops_num;
 283 /*-----------------------------------------------------------------*/
 284 /* Function prototypes.                                            */
 285 /*-----------------------------------------------------------------*/
 286
 287 /*************************************************************************
 288   Simple Loop Peeling Utilities - in tree-vectorizer.c
 289  *************************************************************************/
 290 /* Entry point for peeling of simple loops.
 291    Peel the first/last iterations of a loop.
 292    It can be used outside of the vectorizer for loops that are simple enough
 293    (see function documentation).  In the vectorizer it is used to peel the
 294    last few iterations when the loop bound is unknown or does not evenly
 295    divide by the vectorization factor, and to peel the first few iterations
 296    to force the alignment of data references in the loop.  */
 297 extern struct loop *slpeel_tree_peel_loop_to_edge
 298   (struct loop *, struct loops *, edge, tree, tree, bool);
 299 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
 300 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
 301 #ifdef ENABLE_CHECKING
 302 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
 303 #endif
 304
 305
 306 /*************************************************************************
 307   General Vectorization Utilities
 308  *************************************************************************/
 309 /** In tree-vectorizer.c **/
 310 extern tree vect_strip_conversion (tree);
 311 extern tree get_vectype_for_scalar_type (tree);
 312 extern bool vect_is_simple_use (tree , loop_vec_info, tree *);
 313 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
 314 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
 315 extern enum dr_alignment_support vect_supportable_dr_alignment
 316   (struct data_reference *);
 317 /* Creation and deletion of loop and stmt info structs.  */
 318 extern loop_vec_info new_loop_vec_info (struct loop *loop);
 319 extern void destroy_loop_vec_info (loop_vec_info);
 320 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
 321 /* Main driver.  */
 322 extern void vectorize_loops (struct loops *);
 323
 324 /** In tree-vect-analyze.c  **/
 325 /* Driver for analysis stage.  */
 326 extern loop_vec_info vect_analyze_loop (struct loop *);
 327
 328 /** In tree-vect-transform.c  **/
 329 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
 330 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
 331 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
 332 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
 333 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
 334 /* Driver for transformation stage.  */
 335 extern void vect_transform_loop (loop_vec_info, struct loops *);
 336
 337 /*************************************************************************
 338   Vectorization Debug Information - in tree-vectorizer.c
 339  *************************************************************************/
 340 extern bool vect_print_dump_info (enum verbosity_levels, LOC);
 341 extern void vect_set_verbosity_level (const char *);
 342 extern LOC find_loop_location (struct loop *);
 343
 344 #endif  /* GCC_TREE_VECTORIZER_H  */