2 Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
3 Contributed by Dorit Naishlos <dorit@il.ibm.com>
5 This file is part of GCC.
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
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
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
22 #ifndef GCC_TREE_VECTORIZER_H
23 #define GCC_TREE_VECTORIZER_H
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)
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
39 /* Used for naming of new temporaries. */
46 /* Defines type of operation. */
53 /* Define type of available alignment support. */
54 enum dr_alignment_support {
55 dr_unaligned_unsupported,
56 dr_unaligned_supported,
57 dr_unaligned_software_pipeline,
61 /* Define type of def-use cross-iteration cycle. */
71 /* Define verbosity levels. */
72 enum verbosity_levels {
74 REPORT_VECTORIZED_LOOPS,
75 REPORT_UNVECTORIZED_LOOPS,
78 REPORT_BAD_FORM_LOOPS,
81 /* New verbosity levels should be added before this one. */
85 /*-----------------------------------------------------------------*/
86 /* Info on vectorized loops. */
87 /*-----------------------------------------------------------------*/
88 typedef struct _loop_vec_info {
90 /* The loop to which this info struct refers to. */
93 /* The loop basic blocks. */
96 /* The loop exit_condition. */
99 /* Number of iterations. */
102 /* Is the loop vectorizable? */
105 /* Unrolling factor */
106 int vectorization_factor;
108 /* Unknown DRs according to which loop was peeled. */
109 struct data_reference *unaligned_dr;
111 /* peeling_for_alignment indicates whether peeling for alignment will take
112 place, and what the peeling factor should be:
113 peeling_for_alignment = X means:
114 If X=0: Peeling for alignment will not be applied.
115 If X>0: Peel first X iterations.
116 If X=-1: Generate a runtime test to calculate the number of iterations
117 to be peeled, using the dataref recorded in the field
119 int peeling_for_alignment;
121 /* The mask used to check the alignment of pointers or arrays. */
124 /* All data references in the loop. */
125 VEC (data_reference_p, heap) *datarefs;
127 /* All data dependences in the loop. */
128 VEC (ddr_p, heap) *ddrs;
130 /* Statements in the loop that have data references that are candidates for a
131 runtime (loop versioning) misalignment check. */
132 VEC(tree,heap) *may_misalign_stmts;
134 /* The loop location in the source. */
135 LOC loop_line_number;
138 /* Access Functions. */
139 #define LOOP_VINFO_LOOP(L) (L)->loop
140 #define LOOP_VINFO_BBS(L) (L)->bbs
141 #define LOOP_VINFO_EXIT_COND(L) (L)->exit_cond
142 #define LOOP_VINFO_NITERS(L) (L)->num_iters
143 #define LOOP_VINFO_VECTORIZABLE_P(L) (L)->vectorizable
144 #define LOOP_VINFO_VECT_FACTOR(L) (L)->vectorization_factor
145 #define LOOP_VINFO_PTR_MASK(L) (L)->ptr_mask
146 #define LOOP_VINFO_DATAREFS(L) (L)->datarefs
147 #define LOOP_VINFO_DDRS(L) (L)->ddrs
148 #define LOOP_VINFO_INT_NITERS(L) (TREE_INT_CST_LOW ((L)->num_iters))
149 #define LOOP_PEELING_FOR_ALIGNMENT(L) (L)->peeling_for_alignment
150 #define LOOP_VINFO_UNALIGNED_DR(L) (L)->unaligned_dr
151 #define LOOP_VINFO_MAY_MISALIGN_STMTS(L) (L)->may_misalign_stmts
152 #define LOOP_VINFO_LOC(L) (L)->loop_line_number
154 #define NITERS_KNOWN_P(n) \
155 (host_integerp ((n),0) \
156 && TREE_INT_CST_LOW ((n)) > 0)
158 #define LOOP_VINFO_NITERS_KNOWN_P(L) \
159 NITERS_KNOWN_P((L)->num_iters)
161 /*-----------------------------------------------------------------*/
162 /* Info on vectorized defs. */
163 /*-----------------------------------------------------------------*/
164 enum stmt_vec_info_type {
165 undef_vec_info_type = 0,
170 assignment_vec_info_type,
171 condition_vec_info_type,
174 type_promotion_vec_info_type,
175 type_demotion_vec_info_type,
176 type_conversion_vec_info_type
179 /* Indicates whether/how a variable is used in the loop. */
181 vect_unused_in_loop = 0,
183 /* defs that feed computations that end up (only) in a reduction. These
184 defs may be used by non-reduction stmts, but eventually, any
185 computations/values that are affected by these defs are used to compute
186 a reduction (i.e. don't get stored to memory, for example). We use this
187 to identify computations that we can change the order in which they are
189 vect_used_by_reduction,
194 typedef struct data_reference *dr_p;
196 DEF_VEC_ALLOC_P(dr_p,heap);
198 typedef struct _stmt_vec_info {
200 enum stmt_vec_info_type type;
202 /* The stmt to which this info struct refers to. */
205 /* The loop_vec_info with respect to which STMT is vectorized. */
206 loop_vec_info loop_vinfo;
208 /* Not all stmts in the loop need to be vectorized. e.g, the increment
209 of the loop induction variable and computation of array indexes. relevant
210 indicates whether the stmt needs to be vectorized. */
211 enum vect_relevant relevant;
213 /* Indicates whether this stmts is part of a computation whose result is
214 used outside the loop. */
217 /* The vector type to be used. */
220 /* The vectorized version of the stmt. */
221 tree vectorized_stmt;
224 /** The following is relevant only for stmts that contain a non-scalar
225 data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
226 at most one such data-ref. **/
228 /* Information about the data-ref (access function, etc). */
229 struct data_reference *data_ref_info;
231 /* Stmt is part of some pattern (computation idiom) */
234 /* Used for various bookkeeping purposes, generally holding a pointer to
235 some other stmt S that is in some way "related" to this stmt.
236 Current use of this field is:
237 If this stmt is part of a pattern (i.e. the field 'in_pattern_p' is
238 true): S is the "pattern stmt" that represents (and replaces) the
239 sequence of stmts that constitutes the pattern. Similarly, the
240 related_stmt of the "pattern stmt" points back to this stmt (which is
241 the last stmt in the original sequence of stmts that constitutes the
245 /* List of datarefs that are known to have the same alignment as the dataref
247 VEC(dr_p,heap) *same_align_refs;
249 /* Classify the def of this stmt. */
250 enum vect_def_type def_type;
252 /* Interleaving info. */
253 /* First data-ref in the interleaving group. */
255 /* Pointer to the next data-ref in the group. */
257 /* The size of the interleaving group. */
259 /* For stores, number of stores from this group seen. We vectorize the last
261 unsigned int store_count;
262 /* For loads only, the gap from the previous load. For consecutive loads, GAP
265 /* In case that two or more stmts share data-ref, this is the pointer to the
266 previously detected stmt with the same dr. */
268 /* For loads only, if there is a store with the same location, this field is
273 /* Access Functions. */
274 #define STMT_VINFO_TYPE(S) (S)->type
275 #define STMT_VINFO_STMT(S) (S)->stmt
276 #define STMT_VINFO_LOOP_VINFO(S) (S)->loop_vinfo
277 #define STMT_VINFO_RELEVANT(S) (S)->relevant
278 #define STMT_VINFO_LIVE_P(S) (S)->live
279 #define STMT_VINFO_VECTYPE(S) (S)->vectype
280 #define STMT_VINFO_VEC_STMT(S) (S)->vectorized_stmt
281 #define STMT_VINFO_DATA_REF(S) (S)->data_ref_info
282 #define STMT_VINFO_IN_PATTERN_P(S) (S)->in_pattern_p
283 #define STMT_VINFO_RELATED_STMT(S) (S)->related_stmt
284 #define STMT_VINFO_SAME_ALIGN_REFS(S) (S)->same_align_refs
285 #define STMT_VINFO_DEF_TYPE(S) (S)->def_type
286 #define STMT_VINFO_DR_GROUP_FIRST_DR(S) (S)->first_dr
287 #define STMT_VINFO_DR_GROUP_NEXT_DR(S) (S)->next_dr
288 #define STMT_VINFO_DR_GROUP_SIZE(S) (S)->size
289 #define STMT_VINFO_DR_GROUP_STORE_COUNT(S) (S)->store_count
290 #define STMT_VINFO_DR_GROUP_GAP(S) (S)->gap
291 #define STMT_VINFO_DR_GROUP_SAME_DR_STMT(S)(S)->same_dr_stmt
292 #define STMT_VINFO_DR_GROUP_READ_WRITE_DEPENDENCE(S) (S)->read_write_dep
294 #define DR_GROUP_FIRST_DR(S) (S)->first_dr
295 #define DR_GROUP_NEXT_DR(S) (S)->next_dr
296 #define DR_GROUP_SIZE(S) (S)->size
297 #define DR_GROUP_STORE_COUNT(S) (S)->store_count
298 #define DR_GROUP_GAP(S) (S)->gap
299 #define DR_GROUP_SAME_DR_STMT(S) (S)->same_dr_stmt
300 #define DR_GROUP_READ_WRITE_DEPENDENCE(S) (S)->read_write_dep
302 #define STMT_VINFO_RELEVANT_P(S) ((S)->relevant != vect_unused_in_loop)
304 static inline void set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info);
305 static inline stmt_vec_info vinfo_for_stmt (tree stmt);
308 set_stmt_info (stmt_ann_t ann, stmt_vec_info stmt_info)
311 ann->common.aux = (char *) stmt_info;
314 static inline stmt_vec_info
315 vinfo_for_stmt (tree stmt)
317 stmt_ann_t ann = stmt_ann (stmt);
318 return ann ? (stmt_vec_info) ann->common.aux : NULL;
322 is_pattern_stmt_p (stmt_vec_info stmt_info)
325 stmt_vec_info related_stmt_info;
327 related_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
329 && (related_stmt_info = vinfo_for_stmt (related_stmt))
330 && STMT_VINFO_IN_PATTERN_P (related_stmt_info))
336 /*-----------------------------------------------------------------*/
337 /* Info on data references alignment. */
338 /*-----------------------------------------------------------------*/
340 /* Reflects actual alignment of first access in the vectorized loop,
341 taking into account peeling/versioning if applied. */
342 #define DR_MISALIGNMENT(DR) (DR)->aux
345 aligned_access_p (struct data_reference *data_ref_info)
347 return (DR_MISALIGNMENT (data_ref_info) == 0);
351 known_alignment_for_access_p (struct data_reference *data_ref_info)
353 return (DR_MISALIGNMENT (data_ref_info) != -1);
356 /* vect_dump will be set to stderr or dump_file if exist. */
357 extern FILE *vect_dump;
358 extern enum verbosity_levels vect_verbosity_level;
360 /* Bitmap of virtual variables to be renamed. */
361 extern bitmap vect_memsyms_to_rename;
363 /*-----------------------------------------------------------------*/
364 /* Function prototypes. */
365 /*-----------------------------------------------------------------*/
367 /*************************************************************************
368 Simple Loop Peeling Utilities - in tree-vectorizer.c
369 *************************************************************************/
370 /* Entry point for peeling of simple loops.
371 Peel the first/last iterations of a loop.
372 It can be used outside of the vectorizer for loops that are simple enough
373 (see function documentation). In the vectorizer it is used to peel the
374 last few iterations when the loop bound is unknown or does not evenly
375 divide by the vectorization factor, and to peel the first few iterations
376 to force the alignment of data references in the loop. */
377 extern struct loop *slpeel_tree_peel_loop_to_edge
378 (struct loop *, edge, tree, tree, bool, unsigned int);
379 extern void slpeel_make_loop_iterate_ntimes (struct loop *, tree);
380 extern bool slpeel_can_duplicate_loop_p (struct loop *, edge);
381 #ifdef ENABLE_CHECKING
382 extern void slpeel_verify_cfg_after_peeling (struct loop *, struct loop *);
386 /*************************************************************************
387 General Vectorization Utilities
388 *************************************************************************/
389 /** In tree-vectorizer.c **/
390 extern tree get_vectype_for_scalar_type (tree);
391 extern bool vect_is_simple_use (tree, loop_vec_info, tree *, tree *,
392 enum vect_def_type *);
393 extern bool vect_is_simple_iv_evolution (unsigned, tree, tree *, tree *);
394 extern tree vect_is_simple_reduction (struct loop *, tree);
395 extern bool vect_can_force_dr_alignment_p (tree, unsigned int);
396 extern enum dr_alignment_support vect_supportable_dr_alignment
397 (struct data_reference *);
398 extern bool reduction_code_for_scalar_code (enum tree_code, enum tree_code *);
399 extern bool supportable_widening_operation (enum tree_code, tree, tree,
400 tree *, tree *, enum tree_code *, enum tree_code *);
401 /* Creation and deletion of loop and stmt info structs. */
402 extern loop_vec_info new_loop_vec_info (struct loop *loop);
403 extern void destroy_loop_vec_info (loop_vec_info);
404 extern stmt_vec_info new_stmt_vec_info (tree stmt, loop_vec_info);
407 /** In tree-vect-analyze.c **/
408 /* Driver for analysis stage. */
409 extern loop_vec_info vect_analyze_loop (struct loop *);
412 /** In tree-vect-patterns.c **/
413 /* Pattern recognition functions.
414 Additional pattern recognition functions can (and will) be added
416 typedef tree (* vect_recog_func_ptr) (tree, tree *, tree *);
417 #define NUM_PATTERNS 4
418 void vect_pattern_recog (loop_vec_info);
421 /** In tree-vect-transform.c **/
422 extern bool vectorizable_load (tree, block_stmt_iterator *, tree *);
423 extern bool vectorizable_store (tree, block_stmt_iterator *, tree *);
424 extern bool vectorizable_operation (tree, block_stmt_iterator *, tree *);
425 extern bool vectorizable_type_promotion (tree, block_stmt_iterator *, tree *);
426 extern bool vectorizable_type_demotion (tree, block_stmt_iterator *, tree *);
427 extern bool vectorizable_conversion (tree, block_stmt_iterator *,
429 extern bool vectorizable_assignment (tree, block_stmt_iterator *, tree *);
430 extern tree vectorizable_function (tree, tree, tree);
431 extern bool vectorizable_call (tree, block_stmt_iterator *, tree *);
432 extern bool vectorizable_condition (tree, block_stmt_iterator *, tree *);
433 extern bool vectorizable_live_operation (tree, block_stmt_iterator *, tree *);
434 extern bool vectorizable_reduction (tree, block_stmt_iterator *, tree *);
435 extern bool vectorizable_induction (tree, block_stmt_iterator *, tree *);
436 /* Driver for transformation stage. */
437 extern void vect_transform_loop (loop_vec_info);
439 /*************************************************************************
440 Vectorization Debug Information - in tree-vectorizer.c
441 *************************************************************************/
442 extern bool vect_print_dump_info (enum verbosity_levels);
443 extern void vect_set_verbosity_level (const char *);
444 extern LOC find_loop_location (struct loop *);
446 #endif /* GCC_TREE_VECTORIZER_H */