OSDN Git Service

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