1/* Vectorizer
2   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
3   Free Software Foundation, Inc.
4   Contributed by Dorit Naishlos <dorit@il.ibm.com>
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify it under
9the terms of the GNU General Public License as published by the Free
10Software Foundation; either version 3, or (at your option) any later
11version.
12
13GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14WARRANTY; without even the implied warranty of MERCHANTABILITY or
15FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING3.  If not see
20<http://www.gnu.org/licenses/>.  */
21
22#ifndef GCC_TREE_VECTORIZER_H
23#define GCC_TREE_VECTORIZER_H
24
25#include "tree-data-ref.h"
26
27typedef source_location LOC;
28#define UNKNOWN_LOC UNKNOWN_LOCATION
29#define EXPR_LOC(e) EXPR_LOCATION(e)
30#define LOC_FILE(l) LOCATION_FILE (l)
31#define LOC_LINE(l) LOCATION_LINE (l)
32
33/* Used for naming of new temporaries.  */
34enum vect_var_kind {
35  vect_simple_var,
36  vect_pointer_var,
37  vect_scalar_var
38};
39
40/* Defines type of operation.  */
41enum operation_type {
42  unary_op = 1,
43  binary_op,
44  ternary_op
45};
46
47/* Define type of available alignment support.  */
48enum dr_alignment_support {
49  dr_unaligned_unsupported,
50  dr_unaligned_supported,
51  dr_explicit_realign,
52  dr_explicit_realign_optimized,
53  dr_aligned
54};
55
56/* Define type of def-use cross-iteration cycle.  */
57enum vect_def_type {
58  vect_uninitialized_def = 0,
59  vect_constant_def = 1,
60  vect_external_def,
61  vect_internal_def,
62  vect_induction_def,
63  vect_reduction_def,
64  vect_double_reduction_def,
65  vect_nested_cycle,
66  vect_unknown_def_type
67};
68
69#define VECTORIZABLE_CYCLE_DEF(D) (((D) == vect_reduction_def)           \
70                                   || ((D) == vect_double_reduction_def) \
71                                   || ((D) == vect_nested_cycle))
72
73/* Define verbosity levels.  */
74enum verbosity_levels {
75  REPORT_NONE,
76  REPORT_VECTORIZED_LOCATIONS,
77  REPORT_UNVECTORIZED_LOCATIONS,
78  REPORT_COST,
79  REPORT_ALIGNMENT,
80  REPORT_DR_DETAILS,
81  REPORT_BAD_FORM_LOOPS,
82  REPORT_OUTER_LOOPS,
83  REPORT_SLP,
84  REPORT_DETAILS,
85  /* New verbosity levels should be added before this one.  */
86  MAX_VERBOSITY_LEVEL
87};
88
89/************************************************************************
90  SLP
91 ************************************************************************/
92
93/* A computation tree of an SLP instance. Each node corresponds to a group of
94   stmts to be packed in a SIMD stmt.  */
95typedef struct _slp_tree {
96  /* Only binary and unary operations are supported. LEFT child corresponds to
97     the first operand and RIGHT child to the second if the operation is
98     binary.  */
99  struct _slp_tree *left;
100  struct _slp_tree *right;
101  /* A group of scalar stmts to be vectorized together.  */
102  VEC (gimple, heap) *stmts;
103  /* Vectorized stmt/s.  */
104  VEC (gimple, heap) *vec_stmts;
105  /* Number of vector stmts that are created to replace the group of scalar
106     stmts. It is calculated during the transformation phase as the number of
107     scalar elements in one scalar iteration (GROUP_SIZE) multiplied by VF
108     divided by vector size.  */
109  unsigned int vec_stmts_size;
110  /* Vectorization costs associated with SLP node.  */
111  struct
112  {
113    int outside_of_loop;     /* Statements generated outside loop.  */
114    int inside_of_loop;      /* Statements generated inside loop.  */
115  } cost;
116} *slp_tree;
117
118DEF_VEC_P(slp_tree);
119DEF_VEC_ALLOC_P(slp_tree, heap);
120
121/* SLP instance is a sequence of stmts in a loop that can be packed into
122   SIMD stmts.  */
123typedef struct _slp_instance {
124  /* The root of SLP tree.  */
125  slp_tree root;
126
127  /* Size of groups of scalar stmts that will be replaced by SIMD stmt/s.  */
128  unsigned int group_size;
129
130  /* The unrolling factor required to vectorized this SLP instance.  */
131  unsigned int unrolling_factor;
132
133  /* Vectorization costs associated with SLP instance.  */
134  struct
135  {
136    int outside_of_loop;     /* Statements generated outside loop.  */
137    int inside_of_loop;      /* Statements generated inside loop.  */
138  } cost;
139
140  /* Loads permutation relatively to the stores, NULL if there is no
141     permutation.  */
142  VEC (int, heap) *load_permutation;
143
144  /* The group of nodes that contain loads of this SLP instance.  */
145  VEC (slp_tree, heap) *loads;
146
147  /* The first scalar load of the instance. The created vector loads will be
148     inserted before this statement.  */
149  gimple first_load;
150} *slp_instance;
151
152DEF_VEC_P(slp_instance);
153DEF_VEC_ALLOC_P(slp_instance, heap);
154
155/* Access Functions.  */
156#define SLP_INSTANCE_TREE(S)                     (S)->root
157#define SLP_INSTANCE_GROUP_SIZE(S)               (S)->group_size
158#define SLP_INSTANCE_UNROLLING_FACTOR(S)         (S)->unrolling_factor
159#define SLP_INSTANCE_OUTSIDE_OF_LOOP_COST(S)     (S)->cost.outside_of_loop
160#define SLP_INSTANCE_INSIDE_OF_LOOP_COST(S)      (S)->cost.inside_of_loop
161#define SLP_INSTANCE_LOAD_PERMUTATION(S)         (S)->load_permutation
162#define SLP_INSTANCE_LOADS(S)                    (S)->loads
163#define SLP_INSTANCE_FIRST_LOAD_STMT(S)          (S)->first_load
164
165#define SLP_TREE_LEFT(S)                         (S)->left
166#define SLP_TREE_RIGHT(S)                        (S)->right
167#define SLP_TREE_SCALAR_STMTS(S)                 (S)->stmts
168#define SLP_TREE_VEC_STMTS(S)                    (S)->vec_stmts
169#define SLP_TREE_NUMBER_OF_VEC_STMTS(S)          (S)->vec_stmts_size
170#define SLP_TREE_OUTSIDE_OF_LOOP_COST(S)         (S)->cost.outside_of_loop
171#define SLP_TREE_INSIDE_OF_LOOP_COST(S)          (S)->cost.inside_of_loop
172
173/*-----------------------------------------------------------------*/
174/* Info on vectorized loops.                                       */
175/*-----------------------------------------------------------------*/
176typedef struct _loop_vec_info {
177
178  /* The loop to which this info struct refers to.  */
179  struct loop *loop;
180
181  /* The loop basic blocks.  */
182  basic_block *bbs;
183
184  /* Number of iterations.  */
185  tree num_iters;
186  tree num_iters_unchanged;
187
188  /* Minimum number of iterations below which vectorization is expected to
189     not be profitable (as estimated by the cost model).
190     -1 indicates that vectorization will not be profitable.
191     FORNOW: This field is an int. Will be a tree in the future, to represent
192	     values unknown at compile time.  */
193  int min_profitable_iters;
194
195  /* Is the loop vectorizable? */
196  bool vectorizable;
197
198  /* Unrolling factor  */
199  int vectorization_factor;
200
201  /* Unknown DRs according to which loop was peeled.  */
202  struct data_reference *unaligned_dr;
203
204  /* peeling_for_alignment indicates whether peeling for alignment will take
205     place, and what the peeling factor should be:
206     peeling_for_alignment = X means:
207        If X=0: Peeling for alignment will not be applied.
208        If X>0: Peel first X iterations.
209        If X=-1: Generate a runtime test to calculate the number of iterations
210                 to be peeled, using the dataref recorded in the field
211                 unaligned_dr.  */
212  int peeling_for_alignment;
213
214  /* The mask used to check the alignment of pointers or arrays.  */
215  int ptr_mask;
216
217  /* All data references in the loop.  */
218  VEC (data_reference_p, heap) *datarefs;
219
220  /* All data dependences in the loop.  */
221  VEC (ddr_p, heap) *ddrs;
222
223  /* Data Dependence Relations defining address ranges that are candidates
224     for a run-time aliasing check.  */
225  VEC (ddr_p, heap) *may_alias_ddrs;
226
227  /* Statements in the loop that have data references that are candidates for a
228     runtime (loop versioning) misalignment check.  */
229  VEC(gimple,heap) *may_misalign_stmts;
230
231  /* The loop location in the source.  */
232  LOC loop_line_number;
233
234  /* All interleaving chains of stores in the loop, represented by the first
235     stmt in the chain.  */
236  VEC(gimple, heap) *strided_stores;
237
238  /* All SLP instances in the loop. This is a subset of the set of STRIDED_STORES
239     of the loop.  */
240  VEC(slp_instance, heap) *slp_instances;
241
242  /* The unrolling factor needed to SLP the loop. In case of that pure SLP is
243     applied to the loop, i.e., no unrolling is needed, this is 1.  */
244  unsigned slp_unrolling_factor;
245} *loop_vec_info;
246
247/* Access Functions.  */
248#define LOOP_VINFO_LOOP(L)                 (L)->loop
249#define LOOP_VINFO_BBS(L)                  (L)->bbs
250#define LOOP_VINFO_NITERS(L)               (L)->num_iters
251/* Since LOOP_VINFO_NITERS can change after prologue peeling
252   retain total unchanged scalar loop iterations for cost model.  */
253#define LOOP_VINFO_NITERS_UNCHANGED(L)     (L)->num_iters_unchanged
254#define LOOP_VINFO_COST_MODEL_MIN_ITERS(L) (L)->min_profitable_iters
255#define LOOP_VINFO_VECTORIZABLE_P(L)       (L)->vectorizable
256#define LOOP_VINFO_VECT_FACTOR(L)          (L)->vectorization_factor
257#define LOOP_VINFO_PTR_MASK(L)             (L)->ptr_mask
258#define LOOP_VINFO_DATAREFS(L)             (L)->datarefs
259#define LOOP_VINFO_DDRS(L)                 (L)->ddrs
260#define LOOP_VINFO_INT_NITERS(L)           (TREE_INT_CST_LOW ((L)->num_iters))
261#define LOOP_PEELING_FOR_ALIGNMENT(L)      (L)->peeling_for_alignment
262#define LOOP_VINFO_UNALIGNED_DR(L)         (L)->unaligned_dr
263#define LOOP_VINFO_MAY_MISALIGN_STMTS(L)   (L)->may_misalign_stmts
264#define LOOP_VINFO_LOC(L)                  (L)->loop_line_number
265#define LOOP_VINFO_MAY_ALIAS_DDRS(L)       (L)->may_alias_ddrs
266#define LOOP_VINFO_STRIDED_STORES(L)       (L)->strided_stores
267#define LOOP_VINFO_SLP_INSTANCES(L)        (L)->slp_instances
268#define LOOP_VINFO_SLP_UNROLLING_FACTOR(L) (L)->slp_unrolling_factor
269
270#define LOOP_REQUIRES_VERSIONING_FOR_ALIGNMENT(L) \
271VEC_length (gimple, (L)->may_misalign_stmts) > 0
272#define LOOP_REQUIRES_VERSIONING_FOR_ALIAS(L)     \
273VEC_length (ddr_p, (L)->may_alias_ddrs) > 0
274
275#define NITERS_KNOWN_P(n)                     \
276(host_integerp ((n),0)                        \
277&& TREE_INT_CST_LOW ((n)) > 0)
278
279#define LOOP_VINFO_NITERS_KNOWN_P(L)          \
280NITERS_KNOWN_P((L)->num_iters)
281
282static inline loop_vec_info
283loop_vec_info_for_loop (struct loop *loop)
284{
285  return (loop_vec_info) loop->aux;
286}
287
288static inline bool
289nested_in_vect_loop_p (struct loop *loop, gimple stmt)
290{
291  return (loop->inner
292          && (loop->inner == (gimple_bb (stmt))->loop_father));
293}
294
295typedef struct _bb_vec_info {
296
297  basic_block bb;
298  /* All interleaving chains of stores in the basic block, represented by the
299     first stmt in the chain.  */
300  VEC(gimple, heap) *strided_stores;
301
302  /* All SLP instances in the basic block. This is a subset of the set of
303     STRIDED_STORES of the basic block.  */
304  VEC(slp_instance, heap) *slp_instances;
305
306  /* All data references in the basic block.  */
307  VEC (data_reference_p, heap) *datarefs;
308
309  /* All data dependences in the basic block.  */
310  VEC (ddr_p, heap) *ddrs;
311} *bb_vec_info;
312
313#define BB_VINFO_BB(B)              (B)->bb
314#define BB_VINFO_STRIDED_STORES(B)  (B)->strided_stores
315#define BB_VINFO_SLP_INSTANCES(B)   (B)->slp_instances
316#define BB_VINFO_DATAREFS(B)        (B)->datarefs
317#define BB_VINFO_DDRS(B)            (B)->ddrs
318
319static inline bb_vec_info
320vec_info_for_bb (basic_block bb)
321{
322  return (bb_vec_info) bb->aux;
323}
324
325/*-----------------------------------------------------------------*/
326/* Info on vectorized defs.                                        */
327/*-----------------------------------------------------------------*/
328enum stmt_vec_info_type {
329  undef_vec_info_type = 0,
330  load_vec_info_type,
331  store_vec_info_type,
332  shift_vec_info_type,
333  op_vec_info_type,
334  call_vec_info_type,
335  assignment_vec_info_type,
336  condition_vec_info_type,
337  reduc_vec_info_type,
338  induc_vec_info_type,
339  type_promotion_vec_info_type,
340  type_demotion_vec_info_type,
341  type_conversion_vec_info_type,
342  loop_exit_ctrl_vec_info_type
343};
344
345/* Indicates whether/how a variable is used in the scope of loop/basic
346   block.  */
347enum vect_relevant {
348  vect_unused_in_scope = 0,
349  /* The def is in the inner loop, and the use is in the outer loop, and the
350     use is a reduction stmt.  */
351  vect_used_in_outer_by_reduction,
352  /* The def is in the inner loop, and the use is in the outer loop (and is
353     not part of reduction).  */
354  vect_used_in_outer,
355
356  /* defs that feed computations that end up (only) in a reduction. These
357     defs may be used by non-reduction stmts, but eventually, any
358     computations/values that are affected by these defs are used to compute
359     a reduction (i.e. don't get stored to memory, for example). We use this
360     to identify computations that we can change the order in which they are
361     computed.  */
362  vect_used_by_reduction,
363
364  vect_used_in_scope
365};
366
367/* The type of vectorization that can be applied to the stmt: regular loop-based
368   vectorization; pure SLP - the stmt is a part of SLP instances and does not
369   have uses outside SLP instances; or hybrid SLP and loop-based - the stmt is
370   a part of SLP instance and also must be loop-based vectorized, since it has
371   uses outside SLP sequences.
372
373   In the loop context the meanings of pure and hybrid SLP are slightly
374   different. By saying that pure SLP is applied to the loop, we mean that we
375   exploit only intra-iteration parallelism in the loop; i.e., the loop can be
376   vectorized without doing any conceptual unrolling, cause we don't pack
377   together stmts from different iterations, only within a single iteration.
378   Loop hybrid SLP means that we exploit both intra-iteration and
379   inter-iteration parallelism (e.g., number of elements in the vector is 4
380   and the slp-group-size is 2, in which case we don't have enough parallelism
381   within an iteration, so we obtain the rest of the parallelism from subsequent
382   iterations by unrolling the loop by 2).  */
383enum slp_vect_type {
384  loop_vect = 0,
385  pure_slp,
386  hybrid
387};
388
389
390typedef struct data_reference *dr_p;
391DEF_VEC_P(dr_p);
392DEF_VEC_ALLOC_P(dr_p,heap);
393
394typedef struct _stmt_vec_info {
395
396  enum stmt_vec_info_type type;
397
398  /* The stmt to which this info struct refers to.  */
399  gimple stmt;
400
401  /* The loop_vec_info with respect to which STMT is vectorized.  */
402  loop_vec_info loop_vinfo;
403
404  /* Not all stmts in the loop need to be vectorized. e.g, the increment
405     of the loop induction variable and computation of array indexes. relevant
406     indicates whether the stmt needs to be vectorized.  */
407  enum vect_relevant relevant;
408
409  /* Indicates whether this stmts is part of a computation whose result is
410     used outside the loop.  */
411  bool live;
412
413  /* The vector type to be used.  */
414  tree vectype;
415
416  /* The vectorized version of the stmt.  */
417  gimple vectorized_stmt;
418
419
420  /** The following is relevant only for stmts that contain a non-scalar
421     data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
422     at most one such data-ref.  **/
423
424  /* Information about the data-ref (access function, etc),
425     relative to the inner-most containing loop.  */
426  struct data_reference *data_ref_info;
427
428  /* Information about the data-ref relative to this loop
429     nest (the loop that is being considered for vectorization).  */
430  tree dr_base_address;
431  tree dr_init;
432  tree dr_offset;
433  tree dr_step;
434  tree dr_aligned_to;
435
436  /* Stmt is part of some pattern (computation idiom)  */
437  bool in_pattern_p;
438
439  /* Used for various bookkeeping purposes, generally holding a pointer to
440     some other stmt S that is in some way "related" to this stmt.
441     Current use of this field is:
442        If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
443        true): S is the "pattern stmt" that represents (and replaces) the
444        sequence of stmts that constitutes the pattern.  Similarly, the
445        related_stmt of the "pattern stmt" points back to this stmt (which is
446        the last stmt in the original sequence of stmts that constitutes the
447        pattern).  */
448  gimple related_stmt;
449
450  /* List of datarefs that are known to have the same alignment as the dataref
451     of this stmt.  */
452  VEC(dr_p,heap) *same_align_refs;
453
454  /* Classify the def of this stmt.  */
455  enum vect_def_type def_type;
456
457  /* Interleaving info.  */
458  /* First data-ref in the interleaving group.  */
459  gimple first_dr;
460  /* Pointer to the next data-ref in the group.  */
461  gimple next_dr;
462  /* The size of the interleaving group.  */
463  unsigned int size;
464  /* For stores, number of stores from this group seen. We vectorize the last
465     one.  */
466  unsigned int store_count;
467  /* For loads only, the gap from the previous load. For consecutive loads, GAP
468     is 1.  */
469  unsigned int gap;
470  /* In case that two or more stmts share data-ref, this is the pointer to the
471     previously detected stmt with the same dr.  */
472  gimple same_dr_stmt;
473  /* For loads only, if there is a store with the same location, this field is
474     TRUE.  */
475  bool read_write_dep;
476
477  /* Vectorization costs associated with statement.  */
478  struct
479  {
480    int outside_of_loop;     /* Statements generated outside loop.  */
481    int inside_of_loop;      /* Statements generated inside loop.  */
482  } cost;
483
484  /*  Whether the stmt is SLPed, loop-based vectorized, or both.  */
485  enum slp_vect_type slp_type;
486
487  /* The bb_vec_info with respect to which STMT is vectorized.  */
488  bb_vec_info bb_vinfo;
489} *stmt_vec_info;
490
491/* Access Functions.  */
492#define STMT_VINFO_TYPE(S)                 (S)->type
493#define STMT_VINFO_STMT(S)                 (S)->stmt
494#define STMT_VINFO_LOOP_VINFO(S)           (S)->loop_vinfo
495#define STMT_VINFO_BB_VINFO(S)             (S)->bb_vinfo
496#define STMT_VINFO_RELEVANT(S)             (S)->relevant
497#define STMT_VINFO_LIVE_P(S)               (S)->live
498#define STMT_VINFO_VECTYPE(S)              (S)->vectype
499#define STMT_VINFO_VEC_STMT(S)             (S)->vectorized_stmt
500#define STMT_VINFO_DATA_REF(S)             (S)->data_ref_info
501
502#define STMT_VINFO_DR_BASE_ADDRESS(S)      (S)->dr_base_address
503#define STMT_VINFO_DR_INIT(S)              (S)->dr_init
504#define STMT_VINFO_DR_OFFSET(S)            (S)->dr_offset
505#define STMT_VINFO_DR_STEP(S)              (S)->dr_step
506#define STMT_VINFO_DR_ALIGNED_TO(S)        (S)->dr_aligned_to
507
508#define STMT_VINFO_IN_PATTERN_P(S)         (S)->in_pattern_p
509#define STMT_VINFO_RELATED_STMT(S)         (S)->related_stmt
510#define STMT_VINFO_SAME_ALIGN_REFS(S)      (S)->same_align_refs
511#define STMT_VINFO_DEF_TYPE(S)             (S)->def_type
512#define STMT_VINFO_DR_GROUP_FIRST_DR(S)    (S)->first_dr
513#define STMT_VINFO_DR_GROUP_NEXT_DR(S)     (S)->next_dr
514#define STMT_VINFO_DR_GROUP_SIZE(S)        (S)->size
515#define STMT_VINFO_DR_GROUP_STORE_COUNT(S) (S)->store_count
516#define STMT_VINFO_DR_GROUP_GAP(S)         (S)->gap
517#define STMT_VINFO_DR_GROUP_SAME_DR_STMT(S)(S)->same_dr_stmt
518#define STMT_VINFO_DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
519#define STMT_VINFO_STRIDED_ACCESS(S)      ((S)->first_dr != NULL)
520
521#define DR_GROUP_FIRST_DR(S)               (S)->first_dr
522#define DR_GROUP_NEXT_DR(S)                (S)->next_dr
523#define DR_GROUP_SIZE(S)                   (S)->size
524#define DR_GROUP_STORE_COUNT(S)            (S)->store_count
525#define DR_GROUP_GAP(S)                    (S)->gap
526#define DR_GROUP_SAME_DR_STMT(S)           (S)->same_dr_stmt
527#define DR_GROUP_READ_WRITE_DEPENDENCE(S)  (S)->read_write_dep
528
529#define STMT_VINFO_RELEVANT_P(S)          ((S)->relevant != vect_unused_in_scope)
530#define STMT_VINFO_OUTSIDE_OF_LOOP_COST(S) (S)->cost.outside_of_loop
531#define STMT_VINFO_INSIDE_OF_LOOP_COST(S)  (S)->cost.inside_of_loop
532
533#define HYBRID_SLP_STMT(S)                ((S)->slp_type == hybrid)
534#define PURE_SLP_STMT(S)                  ((S)->slp_type == pure_slp)
535#define STMT_SLP_TYPE(S)                   (S)->slp_type
536
537/* These are some defines for the initial implementation of the vectorizer's
538   cost model.  These will later be target specific hooks.  */
539
540/* Cost of conditional taken branch.  */
541#ifndef TARG_COND_TAKEN_BRANCH_COST
542#define TARG_COND_TAKEN_BRANCH_COST        3
543#endif
544
545/* Cost of conditional not taken branch.  */
546#ifndef TARG_COND_NOT_TAKEN_BRANCH_COST
547#define TARG_COND_NOT_TAKEN_BRANCH_COST        1
548#endif
549
550/* Cost of any scalar operation, excluding load and store.  */
551#ifndef TARG_SCALAR_STMT_COST
552#define TARG_SCALAR_STMT_COST           1
553#endif
554
555/* Cost of scalar load.  */
556#ifndef TARG_SCALAR_LOAD_COST
557#define TARG_SCALAR_LOAD_COST           1
558#endif
559
560/* Cost of scalar store.  */
561#ifndef TARG_SCALAR_STORE_COST
562#define TARG_SCALAR_STORE_COST           1
563#endif
564
565/* Cost of any vector operation, excluding load, store or vector to scalar
566   operation.  */
567#ifndef TARG_VEC_STMT_COST
568#define TARG_VEC_STMT_COST           1
569#endif
570
571/* Cost of vector to scalar operation.  */
572#ifndef TARG_VEC_TO_SCALAR_COST
573#define TARG_VEC_TO_SCALAR_COST      1
574#endif
575
576/* Cost of scalar to vector operation.  */
577#ifndef TARG_SCALAR_TO_VEC_COST
578#define TARG_SCALAR_TO_VEC_COST      1
579#endif
580
581/* Cost of aligned vector load.  */
582#ifndef TARG_VEC_LOAD_COST
583#define TARG_VEC_LOAD_COST           1
584#endif
585
586/* Cost of misaligned vector load.  */
587#ifndef TARG_VEC_UNALIGNED_LOAD_COST
588#define TARG_VEC_UNALIGNED_LOAD_COST 2
589#endif
590
591/* Cost of vector store.  */
592#ifndef TARG_VEC_STORE_COST
593#define TARG_VEC_STORE_COST          1
594#endif
595
596/* Cost of vector permutation.  */
597#ifndef TARG_VEC_PERMUTE_COST
598#define TARG_VEC_PERMUTE_COST          1
599#endif
600
601/* The maximum number of intermediate steps required in multi-step type
602   conversion.  */
603#define MAX_INTERM_CVT_STEPS         3
604
605/* Avoid GTY(()) on stmt_vec_info.  */
606typedef void *vec_void_p;
607DEF_VEC_P (vec_void_p);
608DEF_VEC_ALLOC_P (vec_void_p, heap);
609
610extern VEC(vec_void_p,heap) *stmt_vec_info_vec;
611
612void init_stmt_vec_info_vec (void);
613void free_stmt_vec_info_vec (void);
614
615static inline stmt_vec_info
616vinfo_for_stmt (gimple stmt)
617{
618  unsigned int uid = gimple_uid (stmt);
619  if (uid == 0)
620    return NULL;
621
622  gcc_assert (uid <= VEC_length (vec_void_p, stmt_vec_info_vec));
623  return (stmt_vec_info) VEC_index (vec_void_p, stmt_vec_info_vec, uid - 1);
624}
625
626static inline void
627set_vinfo_for_stmt (gimple stmt, stmt_vec_info info)
628{
629  unsigned int uid = gimple_uid (stmt);
630  if (uid == 0)
631    {
632      gcc_assert (info);
633      uid = VEC_length (vec_void_p, stmt_vec_info_vec) + 1;
634      gimple_set_uid (stmt, uid);
635      VEC_safe_push (vec_void_p, heap, stmt_vec_info_vec, (vec_void_p) info);
636    }
637  else
638    VEC_replace (vec_void_p, stmt_vec_info_vec, uid - 1, (vec_void_p) info);
639}
640
641static inline gimple
642get_earlier_stmt (gimple stmt1, gimple stmt2)
643{
644  unsigned int uid1, uid2;
645
646  if (stmt1 == NULL)
647    return stmt2;
648
649  if (stmt2 == NULL)
650    return stmt1;
651
652  uid1 = gimple_uid (stmt1);
653  uid2 = gimple_uid (stmt2);
654
655  if (uid1 == 0 || uid2 == 0)
656    return NULL;
657
658  gcc_assert (uid1 <= VEC_length (vec_void_p, stmt_vec_info_vec));
659  gcc_assert (uid2 <= VEC_length (vec_void_p, stmt_vec_info_vec));
660
661  if (uid1 < uid2)
662    return stmt1;
663  else
664    return stmt2;
665}
666
667static inline bool
668is_pattern_stmt_p (stmt_vec_info stmt_info)
669{
670  gimple related_stmt;
671  stmt_vec_info related_stmt_info;
672
673  related_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
674  if (related_stmt
675      && (related_stmt_info = vinfo_for_stmt (related_stmt))
676      && STMT_VINFO_IN_PATTERN_P (related_stmt_info))
677    return true;
678
679  return false;
680}
681
682static inline bool
683is_loop_header_bb_p (basic_block bb)
684{
685  if (bb == (bb->loop_father)->header)
686    return true;
687  gcc_assert (EDGE_COUNT (bb->preds) == 1);
688  return false;
689}
690
691static inline void
692stmt_vinfo_set_inside_of_loop_cost (stmt_vec_info stmt_info, slp_tree slp_node,
693				    int cost)
694{
695  if (slp_node)
696    SLP_TREE_INSIDE_OF_LOOP_COST (slp_node) = cost;
697  else
698    STMT_VINFO_INSIDE_OF_LOOP_COST (stmt_info) = cost;
699}
700
701static inline void
702stmt_vinfo_set_outside_of_loop_cost (stmt_vec_info stmt_info, slp_tree slp_node,
703				     int cost)
704{
705  if (slp_node)
706    SLP_TREE_OUTSIDE_OF_LOOP_COST (slp_node) = cost;
707  else
708    STMT_VINFO_OUTSIDE_OF_LOOP_COST (stmt_info) = cost;
709}
710
711static inline int
712vect_pow2 (int x)
713{
714  int i, res = 1;
715
716  for (i = 0; i < x; i++)
717    res *= 2;
718
719  return res;
720}
721
722/*-----------------------------------------------------------------*/
723/* Info on data references alignment.                              */
724/*-----------------------------------------------------------------*/
725
726/* Reflects actual alignment of first access in the vectorized loop,
727   taking into account peeling/versioning if applied.  */
728#define DR_MISALIGNMENT(DR)   ((int) (size_t) (DR)->aux)
729#define SET_DR_MISALIGNMENT(DR, VAL)   ((DR)->aux = (void *) (size_t) (VAL))
730
731static inline bool
732aligned_access_p (struct data_reference *data_ref_info)
733{
734  return (DR_MISALIGNMENT (data_ref_info) == 0);
735}
736
737static inline bool
738known_alignment_for_access_p (struct data_reference *data_ref_info)
739{
740  return (DR_MISALIGNMENT (data_ref_info) != -1);
741}
742
743/* vect_dump will be set to stderr or dump_file if exist.  */
744extern FILE *vect_dump;
745extern LOC vect_loop_location;
746
747/*-----------------------------------------------------------------*/
748/* Function prototypes.                                            */
749/*-----------------------------------------------------------------*/
750
751/* Simple loop peeling and versioning utilities for vectorizer's purposes -
752   in tree-vect-loop-manip.c.  */
753extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
754extern bool slpeel_can_duplicate_loop_p (const struct loop *, const_edge);
755extern void vect_loop_versioning (loop_vec_info, bool, tree *, gimple_seq *);
756extern void vect_do_peeling_for_loop_bound (loop_vec_info, tree *,
757                                            tree, gimple_seq);
758extern void vect_do_peeling_for_alignment (loop_vec_info);
759extern LOC find_loop_location (struct loop *);
760extern bool vect_can_advance_ivs_p (loop_vec_info);
761
762/* In tree-vect-stmts.c.  */
763extern tree get_vectype_for_scalar_type (tree);
764extern bool vect_is_simple_use (tree, loop_vec_info, bb_vec_info, gimple *,
765                                tree *,  enum vect_def_type *);
766extern bool supportable_widening_operation (enum tree_code, gimple, tree,
767                                            tree *, tree *, enum tree_code *,
768                                            enum tree_code *, int *,
769                                            VEC (tree, heap) **);
770extern bool supportable_narrowing_operation (enum tree_code, const_gimple,
771                                             tree, enum tree_code *, int *,
772                                             VEC (tree, heap) **);
773extern stmt_vec_info new_stmt_vec_info (gimple stmt, loop_vec_info,
774                                        bb_vec_info);
775extern void free_stmt_vec_info (gimple stmt);
776extern tree vectorizable_function (gimple, tree, tree);
777extern void vect_model_simple_cost (stmt_vec_info, int, enum vect_def_type *,
778                                    slp_tree);
779extern void vect_model_store_cost (stmt_vec_info, int, enum vect_def_type,
780                                   slp_tree);
781extern void vect_model_load_cost (stmt_vec_info, int, slp_tree);
782extern void vect_finish_stmt_generation (gimple, gimple,
783                                         gimple_stmt_iterator *);
784extern bool vect_mark_stmts_to_be_vectorized (loop_vec_info);
785extern int cost_for_stmt (gimple);
786extern tree vect_get_vec_def_for_operand (tree, gimple, tree *);
787extern tree vect_init_vector (gimple, tree, tree,
788                              gimple_stmt_iterator *);
789extern tree vect_get_vec_def_for_stmt_copy (enum vect_def_type, tree);
790extern bool vect_transform_stmt (gimple, gimple_stmt_iterator *,
791                                 bool *, slp_tree, slp_instance);
792extern void vect_remove_stores (gimple);
793extern bool vect_analyze_stmt (gimple, bool *, slp_tree);
794extern bool vectorizable_condition (gimple, gimple_stmt_iterator *, gimple *,
795                                    tree, int);
796
797/* In tree-vect-data-refs.c.  */
798extern bool vect_can_force_dr_alignment_p (const_tree, unsigned int);
799extern enum dr_alignment_support vect_supportable_dr_alignment
800                                           (struct data_reference *);
801extern tree vect_get_smallest_scalar_type (gimple, HOST_WIDE_INT *,
802                                           HOST_WIDE_INT *);
803extern bool vect_analyze_data_ref_dependences (loop_vec_info, bb_vec_info);
804extern bool vect_enhance_data_refs_alignment (loop_vec_info);
805extern bool vect_analyze_data_refs_alignment (loop_vec_info, bb_vec_info);
806extern bool vect_verify_datarefs_alignment (loop_vec_info, bb_vec_info);
807extern bool vect_analyze_data_ref_accesses (loop_vec_info, bb_vec_info);
808extern bool vect_prune_runtime_alias_test_list (loop_vec_info);
809extern bool vect_analyze_data_refs (loop_vec_info, bb_vec_info);
810extern tree vect_create_data_ref_ptr (gimple, struct loop *, tree, tree *,
811                                      gimple *, bool, bool *);
812extern tree bump_vector_ptr (tree, gimple, gimple_stmt_iterator *, gimple, tree);
813extern tree vect_create_destination_var (tree, tree);
814extern bool vect_strided_store_supported (tree);
815extern bool vect_strided_load_supported (tree);
816extern bool vect_permute_store_chain (VEC(tree,heap) *,unsigned int, gimple,
817                                    gimple_stmt_iterator *, VEC(tree,heap) **);
818extern tree vect_setup_realignment (gimple, gimple_stmt_iterator *, tree *,
819                                    enum dr_alignment_support, tree,
820                                    struct loop **);
821extern bool vect_permute_load_chain (VEC(tree,heap) *,unsigned int, gimple,
822                                    gimple_stmt_iterator *, VEC(tree,heap) **);
823extern bool vect_transform_strided_load (gimple, VEC(tree,heap) *, int,
824                                         gimple_stmt_iterator *);
825extern int vect_get_place_in_interleaving_chain (gimple, gimple);
826extern tree vect_get_new_vect_var (tree, enum vect_var_kind, const char *);
827extern tree vect_create_addr_base_for_vector_ref (gimple, gimple_seq *,
828                                                  tree, struct loop *);
829
830/* In tree-vect-loop.c.  */
831/* FORNOW: Used in tree-parloops.c.  */
832extern void destroy_loop_vec_info (loop_vec_info, bool);
833extern gimple vect_is_simple_reduction (loop_vec_info, gimple, bool, bool *);
834/* Drive for loop analysis stage.  */
835extern loop_vec_info vect_analyze_loop (struct loop *);
836/* Drive for loop transformation stage.  */
837extern void vect_transform_loop (loop_vec_info);
838extern loop_vec_info vect_analyze_loop_form (struct loop *);
839extern bool vectorizable_live_operation (gimple, gimple_stmt_iterator *,
840                                         gimple *);
841extern bool vectorizable_reduction (gimple, gimple_stmt_iterator *, gimple *);
842extern bool vectorizable_induction (gimple, gimple_stmt_iterator *, gimple *);
843extern int vect_estimate_min_profitable_iters (loop_vec_info);
844extern tree get_initial_def_for_reduction (gimple, tree, tree *);
845extern int vect_min_worthwhile_factor (enum tree_code);
846
847
848/* In tree-vect-slp.c.  */
849extern void vect_free_slp_instance (slp_instance);
850extern bool vect_transform_slp_perm_load (gimple, VEC (tree, heap) *,
851                                          gimple_stmt_iterator *, int,
852                                          slp_instance, bool);
853extern bool vect_schedule_slp (loop_vec_info, bb_vec_info);
854extern void vect_update_slp_costs_according_to_vf (loop_vec_info);
855extern bool vect_analyze_slp (loop_vec_info, bb_vec_info);
856extern void vect_make_slp_decision (loop_vec_info);
857extern void vect_detect_hybrid_slp (loop_vec_info);
858extern void vect_get_slp_defs (tree, tree, slp_tree, VEC (tree,heap) **,
859                               VEC (tree,heap) **);
860extern LOC find_bb_location (basic_block);
861extern bb_vec_info vect_slp_analyze_bb (basic_block);
862extern void vect_slp_transform_bb (basic_block);
863
864/* In tree-vect-patterns.c.  */
865/* Pattern recognition functions.
866   Additional pattern recognition functions can (and will) be added
867   in the future.  */
868typedef gimple (* vect_recog_func_ptr) (gimple, tree *, tree *);
869#define NUM_PATTERNS 4
870void vect_pattern_recog (loop_vec_info);
871
872/* In tree-vectorizer.c.  */
873unsigned vectorize_loops (void);
874/* Vectorization debug information */
875extern bool vect_print_dump_info (enum verbosity_levels);
876
877#endif  /* GCC_TREE_VECTORIZER_H  */
878