2 Copyright (C) 2003, 2004, 2005 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, 59 Temple Place - Suite 330, 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. */
45 /* Defines type of operation: unary or binary. */
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
,
59 /* Define verbosity levels. */
60 enum verbosity_levels
{
62 REPORT_VECTORIZED_LOOPS
,
63 REPORT_UNVECTORIZED_LOOPS
,
65 REPORT_BAD_FORM_LOOPS
,
68 /* New verbosity levels should be added before this one. */
72 /*-----------------------------------------------------------------*/
73 /* Info on vectorized loops. */
74 /*-----------------------------------------------------------------*/
75 typedef struct _loop_vec_info
{
77 /* The loop to which this info struct refers to. */
80 /* The loop basic blocks. */
83 /* The loop exit_condition. */
86 /* Number of iterations. */
89 /* Is the loop vectorizable? */
92 /* Unrolling factor */
93 int vectorization_factor
;
95 /* Unknown DRs according to which loop was peeled. */
96 struct data_reference
*unaligned_dr
;
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
106 int peeling_for_alignment
;
108 /* All data references in the loop that are being written to. */
109 varray_type data_ref_writes
;
111 /* All data references in the loop that are being read from. */
112 varray_type data_ref_reads
;
114 /* The loop location in the source. */
115 LOC loop_line_number
;
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
132 #define LOOP_LOC(L) LOOP_VINFO_LOC(L)
135 #define LOOP_VINFO_NITERS_KNOWN_P(L) \
136 (host_integerp ((L)->num_iters,0) \
137 && TREE_INT_CST_LOW ((L)->num_iters) > 0)
139 /*-----------------------------------------------------------------*/
140 /* Info on vectorized defs. */
141 /*-----------------------------------------------------------------*/
142 enum stmt_vec_info_type
{
143 undef_vec_info_type
= 0,
147 assignment_vec_info_type
150 typedef struct _stmt_vec_info
{
152 enum stmt_vec_info_type type
;
154 /* The stmt to which this info struct refers to. */
157 /* The loop_vec_info with respect to which STMT is vectorized. */
158 loop_vec_info loop_vinfo
;
160 /* Not all stmts in the loop need to be vectorized. e.g, the incrementation
161 of the loop induction variable and computation of array indexes. relevant
162 indicates whether the stmt needs to be vectorized. */
165 /* The vector type to be used. */
168 /* The vectorized version of the stmt. */
169 tree vectorized_stmt
;
172 /** The following is relevant only for stmts that contain a non-scalar
173 data-ref (array/pointer/struct access). A GIMPLE stmt is expected to have
174 at most one such data-ref. **/
176 /* Information about the data-ref (access function, etc). */
177 struct data_reference
*data_ref_info
;
179 /* Aliasing information. */
183 /** The following fields are used to store the information about
184 data-reference. {base_address + initial_offset} is the first location
185 accessed by data-ref in the loop, and step is the stride of data-ref in
190 data-ref a[j].b[i][j] a + 4B (a is int*)
193 initial_offset j_0*D_j + i_0*D_i + C 4
196 data-reference structure info:
198 access_fn <access_fns of indexes of b> (0, +, 1)
201 /* The above base_address, offset and step. */
206 /* Alignment information. Whether the base of the data-reference is aligned
209 /* Alignment information. The offset of the data-reference from its base
214 /* Access Functions. */
215 #define STMT_VINFO_TYPE(S) (S)->type
216 #define STMT_VINFO_STMT(S) (S)->stmt
217 #define STMT_VINFO_LOOP_VINFO(S) (S)->loop_vinfo
218 #define STMT_VINFO_RELEVANT_P(S) (S)->relevant
219 #define STMT_VINFO_VECTYPE(S) (S)->vectype
220 #define STMT_VINFO_VEC_STMT(S) (S)->vectorized_stmt
221 #define STMT_VINFO_DATA_REF(S) (S)->data_ref_info
222 #define STMT_VINFO_MEMTAG(S) (S)->memtag
223 #define STMT_VINFO_SUBVARS(S) (S)->subvars
224 #define STMT_VINFO_VECT_DR_BASE_ADDRESS(S)(S)->base_address
225 #define STMT_VINFO_VECT_INIT_OFFSET(S) (S)->initial_offset
226 #define STMT_VINFO_VECT_STEP(S) (S)->step
227 #define STMT_VINFO_VECT_BASE_ALIGNED_P(S) (S)->base_aligned_p
228 #define STMT_VINFO_VECT_MISALIGNMENT(S) (S)->misalignment
230 static inline void set_stmt_info (stmt_ann_t ann
, stmt_vec_info stmt_info
);
231 static inline stmt_vec_info
vinfo_for_stmt (tree stmt
);
234 set_stmt_info (stmt_ann_t ann
, stmt_vec_info stmt_info
)
237 ann
->common
.aux
= (char *) stmt_info
;
240 static inline stmt_vec_info
241 vinfo_for_stmt (tree stmt
)
243 stmt_ann_t ann
= stmt_ann (stmt
);
244 return ann
? (stmt_vec_info
) ann
->common
.aux
: NULL
;
247 /*-----------------------------------------------------------------*/
248 /* Info on data references alignment. */
249 /*-----------------------------------------------------------------*/
251 /* Reflects actual alignment of first access in the vectorized loop,
252 taking into account peeling/versioning if applied. */
253 #define DR_MISALIGNMENT(DR) (DR)->aux
256 aligned_access_p (struct data_reference
*data_ref_info
)
258 return (DR_MISALIGNMENT (data_ref_info
) == 0);
262 known_alignment_for_access_p (struct data_reference
*data_ref_info
)
264 return (DR_MISALIGNMENT (data_ref_info
) != -1);
267 /* Perform signed modulo, always returning a non-negative value. */
268 #define VECT_SMODULO(x,y) ((x) % (y) < 0 ? ((x) % (y) + (y)) : (x) % (y))
270 /* vect_dump will be set to stderr or dump_file if exist. */
271 extern FILE *vect_dump
;
272 extern enum verbosity_levels vect_verbosity_level
;
274 /*-----------------------------------------------------------------*/
275 /* Function prototypes. */
276 /*-----------------------------------------------------------------*/
278 /*************************************************************************
279 Simple Loop Peeling Utilities - in tree-vectorizer.c
280 *************************************************************************/
281 /* Entry point for peeling of simple loops.
282 Peel the first/last iterations of a loop.
283 It can be used outside of the vectorizer for loops that are simple enough
284 (see function documentation). In the vectorizer it is used to peel the
285 last few iterations when the loop bound is unknown or does not evenly
286 divide by the vectorization factor, and to peel the first few iterations
287 to force the alignment of data references in the loop. */
288 extern struct loop
*slpeel_tree_peel_loop_to_edge
289 (struct loop
*, struct loops
*, edge
, tree
, tree
, bool);
290 extern void slpeel_make_loop_iterate_ntimes (struct loop
*, tree
);
291 extern bool slpeel_can_duplicate_loop_p (struct loop
*, edge
);
292 #ifdef ENABLE_CHECKING
293 extern void slpeel_verify_cfg_after_peeling (struct loop
*, struct loop
*);
297 /*************************************************************************
298 General Vectorization Utilities
299 *************************************************************************/
300 /** In tree-vectorizer.c **/
301 extern tree
vect_strip_conversion (tree
);
302 extern tree
get_vectype_for_scalar_type (tree
);
303 extern bool vect_is_simple_use (tree
, loop_vec_info
, tree
*);
304 extern bool vect_is_simple_iv_evolution (unsigned, tree
, tree
*, tree
*);
305 extern bool vect_can_force_dr_alignment_p (tree
, unsigned int);
306 extern enum dr_alignment_support vect_supportable_dr_alignment
307 (struct data_reference
*);
308 /* Creation and deletion of loop and stmt info structs. */
309 extern loop_vec_info
new_loop_vec_info (struct loop
*loop
);
310 extern void destroy_loop_vec_info (loop_vec_info
);
311 extern stmt_vec_info
new_stmt_vec_info (tree stmt
, loop_vec_info
);
313 extern void vectorize_loops (struct loops
*);
315 /** In tree-vect-analyze.c **/
316 /* Driver for analysis stage. */
317 extern loop_vec_info
vect_analyze_loop (struct loop
*);
319 /** In tree-vect-transform.c **/
320 extern bool vectorizable_load (tree
, block_stmt_iterator
*, tree
*);
321 extern bool vectorizable_store (tree
, block_stmt_iterator
*, tree
*);
322 extern bool vectorizable_operation (tree
, block_stmt_iterator
*, tree
*);
323 extern bool vectorizable_assignment (tree
, block_stmt_iterator
*, tree
*);
324 /* Driver for transformation stage. */
325 extern void vect_transform_loop (loop_vec_info
, struct loops
*);
327 /*************************************************************************
328 Vectorization Debug Information - in tree-vectorizer.c
329 *************************************************************************/
330 extern bool vect_print_dump_info (enum verbosity_levels
, LOC
);
331 extern void vect_set_verbosity_level (const char *);
332 extern LOC
find_loop_location (struct loop
*);
334 #endif /* GCC_TREE_VECTORIZER_H */