OSDN Git Service

* doc/loop.texi: Document recording of loop exits.
[pf3gnuchains/gcc-fork.git] / gcc / tree-vectorizer.c
1 /* Loop Vectorization
2    Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
3    Contributed by Dorit Naishlos <dorit@il.ibm.com>
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA.  */
21
22 /* Loop Vectorization Pass.
23
24    This pass tries to vectorize loops. This first implementation focuses on
25    simple inner-most loops, with no conditional control flow, and a set of
26    simple operations which vector form can be expressed using existing
27    tree codes (PLUS, MULT etc).
28
29    For example, the vectorizer transforms the following simple loop:
30
31         short a[N]; short b[N]; short c[N]; int i;
32
33         for (i=0; i<N; i++){
34           a[i] = b[i] + c[i];
35         }
36
37    as if it was manually vectorized by rewriting the source code into:
38
39         typedef int __attribute__((mode(V8HI))) v8hi;
40         short a[N];  short b[N]; short c[N];   int i;
41         v8hi *pa = (v8hi*)a, *pb = (v8hi*)b, *pc = (v8hi*)c;
42         v8hi va, vb, vc;
43
44         for (i=0; i<N/8; i++){
45           vb = pb[i];
46           vc = pc[i];
47           va = vb + vc;
48           pa[i] = va;
49         }
50
51         The main entry to this pass is vectorize_loops(), in which
52    the vectorizer applies a set of analyses on a given set of loops,
53    followed by the actual vectorization transformation for the loops that
54    had successfully passed the analysis phase.
55
56         Throughout this pass we make a distinction between two types of
57    data: scalars (which are represented by SSA_NAMES), and memory references
58    ("data-refs"). These two types of data require different handling both 
59    during analysis and transformation. The types of data-refs that the 
60    vectorizer currently supports are ARRAY_REFS which base is an array DECL 
61    (not a pointer), and INDIRECT_REFS through pointers; both array and pointer
62    accesses are required to have a  simple (consecutive) access pattern.
63
64    Analysis phase:
65    ===============
66         The driver for the analysis phase is vect_analyze_loop_nest().
67    It applies a set of analyses, some of which rely on the scalar evolution 
68    analyzer (scev) developed by Sebastian Pop.
69
70         During the analysis phase the vectorizer records some information
71    per stmt in a "stmt_vec_info" struct which is attached to each stmt in the 
72    loop, as well as general information about the loop as a whole, which is
73    recorded in a "loop_vec_info" struct attached to each loop.
74
75    Transformation phase:
76    =====================
77         The loop transformation phase scans all the stmts in the loop, and
78    creates a vector stmt (or a sequence of stmts) for each scalar stmt S in
79    the loop that needs to be vectorized. It insert the vector code sequence
80    just before the scalar stmt S, and records a pointer to the vector code
81    in STMT_VINFO_VEC_STMT (stmt_info) (stmt_info is the stmt_vec_info struct 
82    attached to S). This pointer will be used for the vectorization of following
83    stmts which use the def of stmt S. Stmt S is removed if it writes to memory;
84    otherwise, we rely on dead code elimination for removing it.
85
86         For example, say stmt S1 was vectorized into stmt VS1:
87
88    VS1: vb = px[i];
89    S1:  b = x[i];    STMT_VINFO_VEC_STMT (stmt_info (S1)) = VS1
90    S2:  a = b;
91
92    To vectorize stmt S2, the vectorizer first finds the stmt that defines
93    the operand 'b' (S1), and gets the relevant vector def 'vb' from the
94    vector stmt VS1 pointed to by STMT_VINFO_VEC_STMT (stmt_info (S1)). The
95    resulting sequence would be:
96
97    VS1: vb = px[i];
98    S1:  b = x[i];       STMT_VINFO_VEC_STMT (stmt_info (S1)) = VS1
99    VS2: va = vb;
100    S2:  a = b;          STMT_VINFO_VEC_STMT (stmt_info (S2)) = VS2
101
102         Operands that are not SSA_NAMEs, are data-refs that appear in 
103    load/store operations (like 'x[i]' in S1), and are handled differently.
104
105    Target modeling:
106    =================
107         Currently the only target specific information that is used is the
108    size of the vector (in bytes) - "UNITS_PER_SIMD_WORD". Targets that can 
109    support different sizes of vectors, for now will need to specify one value 
110    for "UNITS_PER_SIMD_WORD". More flexibility will be added in the future.
111
112         Since we only vectorize operations which vector form can be
113    expressed using existing tree codes, to verify that an operation is
114    supported, the vectorizer checks the relevant optab at the relevant
115    machine_mode (e.g, add_optab->handlers[(int) V8HImode].insn_code). If
116    the value found is CODE_FOR_nothing, then there's no target support, and
117    we can't vectorize the stmt.
118
119    For additional information on this project see:
120    http://gcc.gnu.org/projects/tree-ssa/vectorization.html
121 */
122
123 #include "config.h"
124 #include "system.h"
125 #include "coretypes.h"
126 #include "tm.h"
127 #include "ggc.h"
128 #include "tree.h"
129 #include "target.h"
130 #include "rtl.h"
131 #include "basic-block.h"
132 #include "diagnostic.h"
133 #include "tree-flow.h"
134 #include "tree-dump.h"
135 #include "timevar.h"
136 #include "cfgloop.h"
137 #include "cfglayout.h"
138 #include "expr.h"
139 #include "recog.h"
140 #include "optabs.h"
141 #include "params.h"
142 #include "toplev.h"
143 #include "tree-chrec.h"
144 #include "tree-data-ref.h"
145 #include "tree-scalar-evolution.h"
146 #include "input.h"
147 #include "tree-vectorizer.h"
148 #include "tree-pass.h"
149
150 /*************************************************************************
151   Simple Loop Peeling Utilities
152  *************************************************************************/
153 static void slpeel_update_phis_for_duplicate_loop 
154   (struct loop *, struct loop *, bool after);
155 static void slpeel_update_phi_nodes_for_guard1 
156   (edge, struct loop *, bool, basic_block *, bitmap *); 
157 static void slpeel_update_phi_nodes_for_guard2 
158   (edge, struct loop *, bool, basic_block *);
159 static edge slpeel_add_loop_guard (basic_block, tree, basic_block, basic_block);
160
161 static void rename_use_op (use_operand_p);
162 static void rename_variables_in_bb (basic_block);
163 static void rename_variables_in_loop (struct loop *);
164
165 /*************************************************************************
166   General Vectorization Utilities
167  *************************************************************************/
168 static void vect_set_dump_settings (void);
169
170 /* vect_dump will be set to stderr or dump_file if exist.  */
171 FILE *vect_dump;
172
173 /* vect_verbosity_level set to an invalid value 
174    to mark that it's uninitialized.  */
175 enum verbosity_levels vect_verbosity_level = MAX_VERBOSITY_LEVEL;
176
177 /* Loop location.  */
178 static LOC vect_loop_location;
179
180 /* Bitmap of virtual variables to be renamed.  */
181 bitmap vect_memsyms_to_rename;
182 \f
183 /*************************************************************************
184   Simple Loop Peeling Utilities
185
186   Utilities to support loop peeling for vectorization purposes.
187  *************************************************************************/
188
189
190 /* Renames the use *OP_P.  */
191
192 static void
193 rename_use_op (use_operand_p op_p)
194 {
195   tree new_name;
196
197   if (TREE_CODE (USE_FROM_PTR (op_p)) != SSA_NAME)
198     return;
199
200   new_name = get_current_def (USE_FROM_PTR (op_p));
201
202   /* Something defined outside of the loop.  */
203   if (!new_name)
204     return;
205
206   /* An ordinary ssa name defined in the loop.  */
207
208   SET_USE (op_p, new_name);
209 }
210
211
212 /* Renames the variables in basic block BB.  */
213
214 static void
215 rename_variables_in_bb (basic_block bb)
216 {
217   tree phi;
218   block_stmt_iterator bsi;
219   tree stmt;
220   use_operand_p use_p;
221   ssa_op_iter iter;
222   edge e;
223   edge_iterator ei;
224   struct loop *loop = bb->loop_father;
225
226   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
227     {
228       stmt = bsi_stmt (bsi);
229       FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter, SSA_OP_ALL_USES)
230         rename_use_op (use_p);
231     }
232
233   FOR_EACH_EDGE (e, ei, bb->succs)
234     {
235       if (!flow_bb_inside_loop_p (loop, e->dest))
236         continue;
237       for (phi = phi_nodes (e->dest); phi; phi = PHI_CHAIN (phi))
238         rename_use_op (PHI_ARG_DEF_PTR_FROM_EDGE (phi, e));
239     }
240 }
241
242
243 /* Renames variables in new generated LOOP.  */
244
245 static void
246 rename_variables_in_loop (struct loop *loop)
247 {
248   unsigned i;
249   basic_block *bbs;
250
251   bbs = get_loop_body (loop);
252
253   for (i = 0; i < loop->num_nodes; i++)
254     rename_variables_in_bb (bbs[i]);
255
256   free (bbs);
257 }
258
259
260 /* Update the PHI nodes of NEW_LOOP.
261
262    NEW_LOOP is a duplicate of ORIG_LOOP.
263    AFTER indicates whether NEW_LOOP executes before or after ORIG_LOOP:
264    AFTER is true if NEW_LOOP executes after ORIG_LOOP, and false if it
265    executes before it.  */
266
267 static void
268 slpeel_update_phis_for_duplicate_loop (struct loop *orig_loop,
269                                        struct loop *new_loop, bool after)
270 {
271   tree new_ssa_name;
272   tree phi_new, phi_orig;
273   tree def;
274   edge orig_loop_latch = loop_latch_edge (orig_loop);
275   edge orig_entry_e = loop_preheader_edge (orig_loop);
276   edge new_loop_exit_e = single_exit (new_loop);
277   edge new_loop_entry_e = loop_preheader_edge (new_loop);
278   edge entry_arg_e = (after ? orig_loop_latch : orig_entry_e);
279
280   /*
281      step 1. For each loop-header-phi:
282              Add the first phi argument for the phi in NEW_LOOP
283             (the one associated with the entry of NEW_LOOP)
284
285      step 2. For each loop-header-phi:
286              Add the second phi argument for the phi in NEW_LOOP
287             (the one associated with the latch of NEW_LOOP)
288
289      step 3. Update the phis in the successor block of NEW_LOOP.
290
291         case 1: NEW_LOOP was placed before ORIG_LOOP:
292                 The successor block of NEW_LOOP is the header of ORIG_LOOP.
293                 Updating the phis in the successor block can therefore be done
294                 along with the scanning of the loop header phis, because the
295                 header blocks of ORIG_LOOP and NEW_LOOP have exactly the same
296                 phi nodes, organized in the same order.
297
298         case 2: NEW_LOOP was placed after ORIG_LOOP:
299                 The successor block of NEW_LOOP is the original exit block of 
300                 ORIG_LOOP - the phis to be updated are the loop-closed-ssa phis.
301                 We postpone updating these phis to a later stage (when
302                 loop guards are added).
303    */
304
305
306   /* Scan the phis in the headers of the old and new loops
307      (they are organized in exactly the same order).  */
308
309   for (phi_new = phi_nodes (new_loop->header),
310        phi_orig = phi_nodes (orig_loop->header);
311        phi_new && phi_orig;
312        phi_new = PHI_CHAIN (phi_new), phi_orig = PHI_CHAIN (phi_orig))
313     {
314       /* step 1.  */
315       def = PHI_ARG_DEF_FROM_EDGE (phi_orig, entry_arg_e);
316       add_phi_arg (phi_new, def, new_loop_entry_e);
317
318       /* step 2.  */
319       def = PHI_ARG_DEF_FROM_EDGE (phi_orig, orig_loop_latch);
320       if (TREE_CODE (def) != SSA_NAME)
321         continue;
322
323       new_ssa_name = get_current_def (def);
324       if (!new_ssa_name)
325         {
326           /* This only happens if there are no definitions
327              inside the loop. use the phi_result in this case.  */
328           new_ssa_name = PHI_RESULT (phi_new);
329         }
330
331       /* An ordinary ssa name defined in the loop.  */
332       add_phi_arg (phi_new, new_ssa_name, loop_latch_edge (new_loop));
333
334       /* step 3 (case 1).  */
335       if (!after)
336         {
337           gcc_assert (new_loop_exit_e == orig_entry_e);
338           SET_PHI_ARG_DEF (phi_orig,
339                            new_loop_exit_e->dest_idx,
340                            new_ssa_name);
341         }
342     }
343 }
344
345
346 /* Update PHI nodes for a guard of the LOOP.
347
348    Input:
349    - LOOP, GUARD_EDGE: LOOP is a loop for which we added guard code that
350         controls whether LOOP is to be executed.  GUARD_EDGE is the edge that
351         originates from the guard-bb, skips LOOP and reaches the (unique) exit
352         bb of LOOP.  This loop-exit-bb is an empty bb with one successor.
353         We denote this bb NEW_MERGE_BB because before the guard code was added
354         it had a single predecessor (the LOOP header), and now it became a merge
355         point of two paths - the path that ends with the LOOP exit-edge, and
356         the path that ends with GUARD_EDGE.
357    - NEW_EXIT_BB: New basic block that is added by this function between LOOP
358         and NEW_MERGE_BB. It is used to place loop-closed-ssa-form exit-phis.
359
360    ===> The CFG before the guard-code was added:
361         LOOP_header_bb:
362           loop_body
363           if (exit_loop) goto update_bb
364           else           goto LOOP_header_bb
365         update_bb:
366
367    ==> The CFG after the guard-code was added:
368         guard_bb:
369           if (LOOP_guard_condition) goto new_merge_bb
370           else                      goto LOOP_header_bb
371         LOOP_header_bb:
372           loop_body
373           if (exit_loop_condition) goto new_merge_bb
374           else                     goto LOOP_header_bb
375         new_merge_bb:
376           goto update_bb
377         update_bb:
378
379    ==> The CFG after this function:
380         guard_bb:
381           if (LOOP_guard_condition) goto new_merge_bb
382           else                      goto LOOP_header_bb
383         LOOP_header_bb:
384           loop_body
385           if (exit_loop_condition) goto new_exit_bb
386           else                     goto LOOP_header_bb
387         new_exit_bb:
388         new_merge_bb:
389           goto update_bb
390         update_bb:
391
392    This function:
393    1. creates and updates the relevant phi nodes to account for the new
394       incoming edge (GUARD_EDGE) into NEW_MERGE_BB. This involves:
395       1.1. Create phi nodes at NEW_MERGE_BB.
396       1.2. Update the phi nodes at the successor of NEW_MERGE_BB (denoted
397            UPDATE_BB).  UPDATE_BB was the exit-bb of LOOP before NEW_MERGE_BB
398    2. preserves loop-closed-ssa-form by creating the required phi nodes
399       at the exit of LOOP (i.e, in NEW_EXIT_BB).
400
401    There are two flavors to this function:
402
403    slpeel_update_phi_nodes_for_guard1:
404      Here the guard controls whether we enter or skip LOOP, where LOOP is a
405      prolog_loop (loop1 below), and the new phis created in NEW_MERGE_BB are
406      for variables that have phis in the loop header.
407
408    slpeel_update_phi_nodes_for_guard2:
409      Here the guard controls whether we enter or skip LOOP, where LOOP is an
410      epilog_loop (loop2 below), and the new phis created in NEW_MERGE_BB are
411      for variables that have phis in the loop exit.
412
413    I.E., the overall structure is:
414
415         loop1_preheader_bb:
416                 guard1 (goto loop1/merg1_bb)
417         loop1
418         loop1_exit_bb:
419                 guard2 (goto merge1_bb/merge2_bb)
420         merge1_bb
421         loop2
422         loop2_exit_bb
423         merge2_bb
424         next_bb
425
426    slpeel_update_phi_nodes_for_guard1 takes care of creating phis in
427    loop1_exit_bb and merge1_bb. These are entry phis (phis for the vars
428    that have phis in loop1->header).
429
430    slpeel_update_phi_nodes_for_guard2 takes care of creating phis in
431    loop2_exit_bb and merge2_bb. These are exit phis (phis for the vars
432    that have phis in next_bb). It also adds some of these phis to
433    loop1_exit_bb.
434
435    slpeel_update_phi_nodes_for_guard1 is always called before
436    slpeel_update_phi_nodes_for_guard2. They are both needed in order
437    to create correct data-flow and loop-closed-ssa-form.
438
439    Generally slpeel_update_phi_nodes_for_guard1 creates phis for variables
440    that change between iterations of a loop (and therefore have a phi-node
441    at the loop entry), whereas slpeel_update_phi_nodes_for_guard2 creates
442    phis for variables that are used out of the loop (and therefore have 
443    loop-closed exit phis). Some variables may be both updated between 
444    iterations and used after the loop. This is why in loop1_exit_bb we
445    may need both entry_phis (created by slpeel_update_phi_nodes_for_guard1)
446    and exit phis (created by slpeel_update_phi_nodes_for_guard2).
447
448    - IS_NEW_LOOP: if IS_NEW_LOOP is true, then LOOP is a newly created copy of
449      an original loop. i.e., we have:
450
451            orig_loop
452            guard_bb (goto LOOP/new_merge)
453            new_loop <-- LOOP
454            new_exit
455            new_merge
456            next_bb
457
458      If IS_NEW_LOOP is false, then LOOP is an original loop, in which case we
459      have:
460
461            new_loop
462            guard_bb (goto LOOP/new_merge)
463            orig_loop <-- LOOP
464            new_exit
465            new_merge
466            next_bb
467
468      The SSA names defined in the original loop have a current
469      reaching definition that that records the corresponding new
470      ssa-name used in the new duplicated loop copy.
471   */
472
473 /* Function slpeel_update_phi_nodes_for_guard1
474    
475    Input:
476    - GUARD_EDGE, LOOP, IS_NEW_LOOP, NEW_EXIT_BB - as explained above.
477    - DEFS - a bitmap of ssa names to mark new names for which we recorded
478             information. 
479    
480    In the context of the overall structure, we have:
481
482         loop1_preheader_bb: 
483                 guard1 (goto loop1/merg1_bb)
484 LOOP->  loop1
485         loop1_exit_bb:
486                 guard2 (goto merge1_bb/merge2_bb)
487         merge1_bb
488         loop2
489         loop2_exit_bb
490         merge2_bb
491         next_bb
492
493    For each name updated between loop iterations (i.e - for each name that has
494    an entry (loop-header) phi in LOOP) we create a new phi in:
495    1. merge1_bb (to account for the edge from guard1)
496    2. loop1_exit_bb (an exit-phi to keep LOOP in loop-closed form)
497 */
498
499 static void
500 slpeel_update_phi_nodes_for_guard1 (edge guard_edge, struct loop *loop,
501                                     bool is_new_loop, basic_block *new_exit_bb,
502                                     bitmap *defs)
503 {
504   tree orig_phi, new_phi;
505   tree update_phi, update_phi2;
506   tree guard_arg, loop_arg;
507   basic_block new_merge_bb = guard_edge->dest;
508   edge e = EDGE_SUCC (new_merge_bb, 0);
509   basic_block update_bb = e->dest;
510   basic_block orig_bb = loop->header;
511   edge new_exit_e;
512   tree current_new_name;
513   tree name;
514
515   /* Create new bb between loop and new_merge_bb.  */
516   *new_exit_bb = split_edge (single_exit (loop));
517
518   new_exit_e = EDGE_SUCC (*new_exit_bb, 0);
519
520   for (orig_phi = phi_nodes (orig_bb), update_phi = phi_nodes (update_bb);
521        orig_phi && update_phi;
522        orig_phi = PHI_CHAIN (orig_phi), update_phi = PHI_CHAIN (update_phi))
523     {
524       /* Virtual phi; Mark it for renaming. We actually want to call
525          mar_sym_for_renaming, but since all ssa renaming datastructures
526          are going to be freed before we get to call ssa_upate, we just
527          record this name for now in a bitmap, and will mark it for
528          renaming later.  */
529       name = PHI_RESULT (orig_phi);
530       if (!is_gimple_reg (SSA_NAME_VAR (name)))
531         bitmap_set_bit (vect_memsyms_to_rename, DECL_UID (SSA_NAME_VAR (name)));
532
533       /** 1. Handle new-merge-point phis  **/
534
535       /* 1.1. Generate new phi node in NEW_MERGE_BB:  */
536       new_phi = create_phi_node (SSA_NAME_VAR (PHI_RESULT (orig_phi)),
537                                  new_merge_bb);
538
539       /* 1.2. NEW_MERGE_BB has two incoming edges: GUARD_EDGE and the exit-edge
540             of LOOP. Set the two phi args in NEW_PHI for these edges:  */
541       loop_arg = PHI_ARG_DEF_FROM_EDGE (orig_phi, EDGE_SUCC (loop->latch, 0));
542       guard_arg = PHI_ARG_DEF_FROM_EDGE (orig_phi, loop_preheader_edge (loop));
543
544       add_phi_arg (new_phi, loop_arg, new_exit_e);
545       add_phi_arg (new_phi, guard_arg, guard_edge);
546
547       /* 1.3. Update phi in successor block.  */
548       gcc_assert (PHI_ARG_DEF_FROM_EDGE (update_phi, e) == loop_arg
549                   || PHI_ARG_DEF_FROM_EDGE (update_phi, e) == guard_arg);
550       SET_PHI_ARG_DEF (update_phi, e->dest_idx, PHI_RESULT (new_phi));
551       update_phi2 = new_phi;
552
553
554       /** 2. Handle loop-closed-ssa-form phis  **/
555
556       if (!is_gimple_reg (PHI_RESULT (orig_phi)))
557         continue;
558
559       /* 2.1. Generate new phi node in NEW_EXIT_BB:  */
560       new_phi = create_phi_node (SSA_NAME_VAR (PHI_RESULT (orig_phi)),
561                                  *new_exit_bb);
562
563       /* 2.2. NEW_EXIT_BB has one incoming edge: the exit-edge of the loop.  */
564       add_phi_arg (new_phi, loop_arg, single_exit (loop));
565
566       /* 2.3. Update phi in successor of NEW_EXIT_BB:  */
567       gcc_assert (PHI_ARG_DEF_FROM_EDGE (update_phi2, new_exit_e) == loop_arg);
568       SET_PHI_ARG_DEF (update_phi2, new_exit_e->dest_idx, PHI_RESULT (new_phi));
569
570       /* 2.4. Record the newly created name with set_current_def.
571          We want to find a name such that
572                 name = get_current_def (orig_loop_name)
573          and to set its current definition as follows:
574                 set_current_def (name, new_phi_name)
575
576          If LOOP is a new loop then loop_arg is already the name we're
577          looking for. If LOOP is the original loop, then loop_arg is
578          the orig_loop_name and the relevant name is recorded in its
579          current reaching definition.  */
580       if (is_new_loop)
581         current_new_name = loop_arg;
582       else
583         {
584           current_new_name = get_current_def (loop_arg);
585           /* current_def is not available only if the variable does not
586              change inside the loop, in which case we also don't care
587              about recording a current_def for it because we won't be
588              trying to create loop-exit-phis for it.  */
589           if (!current_new_name)
590             continue;
591         }
592       gcc_assert (get_current_def (current_new_name) == NULL_TREE);
593
594       set_current_def (current_new_name, PHI_RESULT (new_phi));
595       bitmap_set_bit (*defs, SSA_NAME_VERSION (current_new_name));
596     }
597
598   set_phi_nodes (new_merge_bb, phi_reverse (phi_nodes (new_merge_bb)));
599 }
600
601
602 /* Function slpeel_update_phi_nodes_for_guard2
603
604    Input:
605    - GUARD_EDGE, LOOP, IS_NEW_LOOP, NEW_EXIT_BB - as explained above.
606
607    In the context of the overall structure, we have:
608
609         loop1_preheader_bb: 
610                 guard1 (goto loop1/merg1_bb)
611         loop1
612         loop1_exit_bb: 
613                 guard2 (goto merge1_bb/merge2_bb)
614         merge1_bb
615 LOOP->  loop2
616         loop2_exit_bb
617         merge2_bb
618         next_bb
619
620    For each name used out side the loop (i.e - for each name that has an exit
621    phi in next_bb) we create a new phi in:
622    1. merge2_bb (to account for the edge from guard_bb) 
623    2. loop2_exit_bb (an exit-phi to keep LOOP in loop-closed form)
624    3. guard2 bb (an exit phi to keep the preceding loop in loop-closed form),
625       if needed (if it wasn't handled by slpeel_update_phis_nodes_for_phi1).
626 */
627
628 static void
629 slpeel_update_phi_nodes_for_guard2 (edge guard_edge, struct loop *loop,
630                                     bool is_new_loop, basic_block *new_exit_bb)
631 {
632   tree orig_phi, new_phi;
633   tree update_phi, update_phi2;
634   tree guard_arg, loop_arg;
635   basic_block new_merge_bb = guard_edge->dest;
636   edge e = EDGE_SUCC (new_merge_bb, 0);
637   basic_block update_bb = e->dest;
638   edge new_exit_e;
639   tree orig_def, orig_def_new_name;
640   tree new_name, new_name2;
641   tree arg;
642
643   /* Create new bb between loop and new_merge_bb.  */
644   *new_exit_bb = split_edge (single_exit (loop));
645
646   new_exit_e = EDGE_SUCC (*new_exit_bb, 0);
647
648   for (update_phi = phi_nodes (update_bb); update_phi; 
649        update_phi = PHI_CHAIN (update_phi))
650     {
651       orig_phi = update_phi;
652       orig_def = PHI_ARG_DEF_FROM_EDGE (orig_phi, e);
653       /* This loop-closed-phi actually doesn't represent a use
654          out of the loop - the phi arg is a constant.  */ 
655       if (TREE_CODE (orig_def) != SSA_NAME)
656         continue;
657       orig_def_new_name = get_current_def (orig_def);
658       arg = NULL_TREE;
659
660       /** 1. Handle new-merge-point phis  **/
661
662       /* 1.1. Generate new phi node in NEW_MERGE_BB:  */
663       new_phi = create_phi_node (SSA_NAME_VAR (PHI_RESULT (orig_phi)),
664                                  new_merge_bb);
665
666       /* 1.2. NEW_MERGE_BB has two incoming edges: GUARD_EDGE and the exit-edge
667             of LOOP. Set the two PHI args in NEW_PHI for these edges:  */
668       new_name = orig_def;
669       new_name2 = NULL_TREE;
670       if (orig_def_new_name)
671         {
672           new_name = orig_def_new_name;
673           /* Some variables have both loop-entry-phis and loop-exit-phis.
674              Such variables were given yet newer names by phis placed in
675              guard_bb by slpeel_update_phi_nodes_for_guard1. I.e:
676              new_name2 = get_current_def (get_current_def (orig_name)).  */
677           new_name2 = get_current_def (new_name);
678         }
679   
680       if (is_new_loop)
681         {
682           guard_arg = orig_def;
683           loop_arg = new_name;
684         }
685       else
686         {
687           guard_arg = new_name;
688           loop_arg = orig_def;
689         }
690       if (new_name2)
691         guard_arg = new_name2;
692   
693       add_phi_arg (new_phi, loop_arg, new_exit_e);
694       add_phi_arg (new_phi, guard_arg, guard_edge);
695
696       /* 1.3. Update phi in successor block.  */
697       gcc_assert (PHI_ARG_DEF_FROM_EDGE (update_phi, e) == orig_def);
698       SET_PHI_ARG_DEF (update_phi, e->dest_idx, PHI_RESULT (new_phi));
699       update_phi2 = new_phi;
700
701
702       /** 2. Handle loop-closed-ssa-form phis  **/
703
704       /* 2.1. Generate new phi node in NEW_EXIT_BB:  */
705       new_phi = create_phi_node (SSA_NAME_VAR (PHI_RESULT (orig_phi)),
706                                  *new_exit_bb);
707
708       /* 2.2. NEW_EXIT_BB has one incoming edge: the exit-edge of the loop.  */
709       add_phi_arg (new_phi, loop_arg, single_exit (loop));
710
711       /* 2.3. Update phi in successor of NEW_EXIT_BB:  */
712       gcc_assert (PHI_ARG_DEF_FROM_EDGE (update_phi2, new_exit_e) == loop_arg);
713       SET_PHI_ARG_DEF (update_phi2, new_exit_e->dest_idx, PHI_RESULT (new_phi));
714
715
716       /** 3. Handle loop-closed-ssa-form phis for first loop  **/
717
718       /* 3.1. Find the relevant names that need an exit-phi in
719          GUARD_BB, i.e. names for which
720          slpeel_update_phi_nodes_for_guard1 had not already created a
721          phi node. This is the case for names that are used outside
722          the loop (and therefore need an exit phi) but are not updated
723          across loop iterations (and therefore don't have a
724          loop-header-phi).
725
726          slpeel_update_phi_nodes_for_guard1 is responsible for
727          creating loop-exit phis in GUARD_BB for names that have a
728          loop-header-phi.  When such a phi is created we also record
729          the new name in its current definition.  If this new name
730          exists, then guard_arg was set to this new name (see 1.2
731          above).  Therefore, if guard_arg is not this new name, this
732          is an indication that an exit-phi in GUARD_BB was not yet
733          created, so we take care of it here.  */
734       if (guard_arg == new_name2)
735         continue;
736       arg = guard_arg;
737
738       /* 3.2. Generate new phi node in GUARD_BB:  */
739       new_phi = create_phi_node (SSA_NAME_VAR (PHI_RESULT (orig_phi)),
740                                  guard_edge->src);
741
742       /* 3.3. GUARD_BB has one incoming edge:  */
743       gcc_assert (EDGE_COUNT (guard_edge->src->preds) == 1);
744       add_phi_arg (new_phi, arg, EDGE_PRED (guard_edge->src, 0));
745
746       /* 3.4. Update phi in successor of GUARD_BB:  */
747       gcc_assert (PHI_ARG_DEF_FROM_EDGE (update_phi2, guard_edge)
748                                                                 == guard_arg);
749       SET_PHI_ARG_DEF (update_phi2, guard_edge->dest_idx, PHI_RESULT (new_phi));
750     }
751
752   set_phi_nodes (new_merge_bb, phi_reverse (phi_nodes (new_merge_bb)));
753 }
754
755
756 /* Make the LOOP iterate NITERS times. This is done by adding a new IV
757    that starts at zero, increases by one and its limit is NITERS.
758
759    Assumption: the exit-condition of LOOP is the last stmt in the loop.  */
760
761 void
762 slpeel_make_loop_iterate_ntimes (struct loop *loop, tree niters)
763 {
764   tree indx_before_incr, indx_after_incr, cond_stmt, cond;
765   tree orig_cond;
766   edge exit_edge = single_exit (loop);
767   block_stmt_iterator loop_cond_bsi;
768   block_stmt_iterator incr_bsi;
769   bool insert_after;
770   tree begin_label = tree_block_label (loop->latch);
771   tree exit_label = tree_block_label (single_exit (loop)->dest);
772   tree init = build_int_cst (TREE_TYPE (niters), 0);
773   tree step = build_int_cst (TREE_TYPE (niters), 1);
774   tree then_label;
775   tree else_label;
776   LOC loop_loc;
777
778   orig_cond = get_loop_exit_condition (loop);
779   gcc_assert (orig_cond);
780   loop_cond_bsi = bsi_for_stmt (orig_cond);
781
782   standard_iv_increment_position (loop, &incr_bsi, &insert_after);
783   create_iv (init, step, NULL_TREE, loop,
784              &incr_bsi, insert_after, &indx_before_incr, &indx_after_incr);
785
786   if (exit_edge->flags & EDGE_TRUE_VALUE) /* 'then' edge exits the loop.  */
787     {
788       cond = build2 (GE_EXPR, boolean_type_node, indx_after_incr, niters);
789       then_label = build1 (GOTO_EXPR, void_type_node, exit_label);
790       else_label = build1 (GOTO_EXPR, void_type_node, begin_label);
791     }
792   else /* 'then' edge loops back.  */
793     {
794       cond = build2 (LT_EXPR, boolean_type_node, indx_after_incr, niters);
795       then_label = build1 (GOTO_EXPR, void_type_node, begin_label);
796       else_label = build1 (GOTO_EXPR, void_type_node, exit_label);
797     }
798
799   cond_stmt = build3 (COND_EXPR, TREE_TYPE (orig_cond), cond,
800                      then_label, else_label);
801   bsi_insert_before (&loop_cond_bsi, cond_stmt, BSI_SAME_STMT);
802
803   /* Remove old loop exit test:  */
804   bsi_remove (&loop_cond_bsi, true);
805
806   loop_loc = find_loop_location (loop);
807   if (dump_file && (dump_flags & TDF_DETAILS))
808     {
809       if (loop_loc != UNKNOWN_LOC)
810         fprintf (dump_file, "\nloop at %s:%d: ",
811                  LOC_FILE (loop_loc), LOC_LINE (loop_loc));
812       print_generic_expr (dump_file, cond_stmt, TDF_SLIM);
813     }
814
815   loop->nb_iterations = niters;
816 }
817
818
819 /* Given LOOP this function generates a new copy of it and puts it 
820    on E which is either the entry or exit of LOOP.  */
821
822 static struct loop *
823 slpeel_tree_duplicate_loop_to_edge_cfg (struct loop *loop, edge e)
824 {
825   struct loop *new_loop;
826   basic_block *new_bbs, *bbs;
827   bool at_exit;
828   bool was_imm_dom;
829   basic_block exit_dest; 
830   tree phi, phi_arg;
831   edge exit, new_exit;
832
833   at_exit = (e == single_exit (loop)); 
834   if (!at_exit && e != loop_preheader_edge (loop))
835     return NULL;
836
837   bbs = get_loop_body (loop);
838
839   /* Check whether duplication is possible.  */
840   if (!can_copy_bbs_p (bbs, loop->num_nodes))
841     {
842       free (bbs);
843       return NULL;
844     }
845
846   /* Generate new loop structure.  */
847   new_loop = duplicate_loop (loop, loop->outer);
848   if (!new_loop)
849     {
850       free (bbs);
851       return NULL;
852     }
853
854   exit_dest = single_exit (loop)->dest;
855   was_imm_dom = (get_immediate_dominator (CDI_DOMINATORS, 
856                                           exit_dest) == loop->header ? 
857                  true : false);
858
859   new_bbs = XNEWVEC (basic_block, loop->num_nodes);
860
861   exit = single_exit (loop);
862   copy_bbs (bbs, loop->num_nodes, new_bbs,
863             &exit, 1, &new_exit, NULL,
864             e->src);
865
866   /* Duplicating phi args at exit bbs as coming 
867      also from exit of duplicated loop.  */
868   for (phi = phi_nodes (exit_dest); phi; phi = PHI_CHAIN (phi))
869     {
870       phi_arg = PHI_ARG_DEF_FROM_EDGE (phi, single_exit (loop));
871       if (phi_arg)
872         {
873           edge new_loop_exit_edge;
874
875           if (EDGE_SUCC (new_loop->header, 0)->dest == new_loop->latch)
876             new_loop_exit_edge = EDGE_SUCC (new_loop->header, 1);
877           else
878             new_loop_exit_edge = EDGE_SUCC (new_loop->header, 0);
879   
880           add_phi_arg (phi, phi_arg, new_loop_exit_edge);       
881         }
882     }    
883    
884   if (at_exit) /* Add the loop copy at exit.  */
885     {
886       redirect_edge_and_branch_force (e, new_loop->header);
887       set_immediate_dominator (CDI_DOMINATORS, new_loop->header, e->src);
888       if (was_imm_dom)
889         set_immediate_dominator (CDI_DOMINATORS, exit_dest, new_loop->header);
890     }
891   else /* Add the copy at entry.  */
892     {
893       edge new_exit_e;
894       edge entry_e = loop_preheader_edge (loop);
895       basic_block preheader = entry_e->src;
896            
897       if (!flow_bb_inside_loop_p (new_loop, 
898                                   EDGE_SUCC (new_loop->header, 0)->dest))
899         new_exit_e = EDGE_SUCC (new_loop->header, 0);
900       else
901         new_exit_e = EDGE_SUCC (new_loop->header, 1); 
902
903       redirect_edge_and_branch_force (new_exit_e, loop->header);
904       set_immediate_dominator (CDI_DOMINATORS, loop->header,
905                                new_exit_e->src);
906
907       /* We have to add phi args to the loop->header here as coming 
908          from new_exit_e edge.  */
909       for (phi = phi_nodes (loop->header); phi; phi = PHI_CHAIN (phi))
910         {
911           phi_arg = PHI_ARG_DEF_FROM_EDGE (phi, entry_e);
912           if (phi_arg)
913             add_phi_arg (phi, phi_arg, new_exit_e);     
914         }    
915
916       redirect_edge_and_branch_force (entry_e, new_loop->header);
917       set_immediate_dominator (CDI_DOMINATORS, new_loop->header, preheader);
918     }
919
920   free (new_bbs);
921   free (bbs);
922
923   return new_loop;
924 }
925
926
927 /* Given the condition statement COND, put it as the last statement
928    of GUARD_BB; EXIT_BB is the basic block to skip the loop;
929    Assumes that this is the single exit of the guarded loop.  
930    Returns the skip edge.  */
931
932 static edge
933 slpeel_add_loop_guard (basic_block guard_bb, tree cond, basic_block exit_bb,
934                         basic_block dom_bb)
935 {
936   block_stmt_iterator bsi;
937   edge new_e, enter_e;
938   tree cond_stmt, then_label, else_label;
939
940   enter_e = EDGE_SUCC (guard_bb, 0);
941   enter_e->flags &= ~EDGE_FALLTHRU;
942   enter_e->flags |= EDGE_FALSE_VALUE;
943   bsi = bsi_last (guard_bb);
944
945   then_label = build1 (GOTO_EXPR, void_type_node,
946                        tree_block_label (exit_bb));
947   else_label = build1 (GOTO_EXPR, void_type_node,
948                        tree_block_label (enter_e->dest));
949   cond_stmt = build3 (COND_EXPR, void_type_node, cond,
950                      then_label, else_label);
951   bsi_insert_after (&bsi, cond_stmt, BSI_NEW_STMT);
952   /* Add new edge to connect guard block to the merge/loop-exit block.  */
953   new_e = make_edge (guard_bb, exit_bb, EDGE_TRUE_VALUE);
954   set_immediate_dominator (CDI_DOMINATORS, exit_bb, dom_bb);
955   return new_e;
956 }
957
958
959 /* This function verifies that the following restrictions apply to LOOP:
960    (1) it is innermost
961    (2) it consists of exactly 2 basic blocks - header, and an empty latch.
962    (3) it is single entry, single exit
963    (4) its exit condition is the last stmt in the header
964    (5) E is the entry/exit edge of LOOP.
965  */
966
967 bool
968 slpeel_can_duplicate_loop_p (struct loop *loop, edge e)
969 {
970   edge exit_e = single_exit (loop);
971   edge entry_e = loop_preheader_edge (loop);
972   tree orig_cond = get_loop_exit_condition (loop);
973   block_stmt_iterator loop_exit_bsi = bsi_last (exit_e->src);
974
975   if (need_ssa_update_p ())
976     return false;
977
978   if (loop->inner
979       /* All loops have an outer scope; the only case loop->outer is NULL is for
980          the function itself.  */
981       || !loop->outer
982       || loop->num_nodes != 2
983       || !empty_block_p (loop->latch)
984       || !single_exit (loop)
985       /* Verify that new loop exit condition can be trivially modified.  */
986       || (!orig_cond || orig_cond != bsi_stmt (loop_exit_bsi))
987       || (e != exit_e && e != entry_e))
988     return false;
989
990   return true;
991 }
992
993 #ifdef ENABLE_CHECKING
994 void
995 slpeel_verify_cfg_after_peeling (struct loop *first_loop,
996                                  struct loop *second_loop)
997 {
998   basic_block loop1_exit_bb = single_exit (first_loop)->dest;
999   basic_block loop2_entry_bb = loop_preheader_edge (second_loop)->src;
1000   basic_block loop1_entry_bb = loop_preheader_edge (first_loop)->src;
1001
1002   /* A guard that controls whether the second_loop is to be executed or skipped
1003      is placed in first_loop->exit.  first_loopt->exit therefore has two
1004      successors - one is the preheader of second_loop, and the other is a bb
1005      after second_loop.
1006    */
1007   gcc_assert (EDGE_COUNT (loop1_exit_bb->succs) == 2);
1008    
1009   /* 1. Verify that one of the successors of first_loopt->exit is the preheader
1010         of second_loop.  */
1011    
1012   /* The preheader of new_loop is expected to have two predecessors:
1013      first_loop->exit and the block that precedes first_loop.  */
1014
1015   gcc_assert (EDGE_COUNT (loop2_entry_bb->preds) == 2 
1016               && ((EDGE_PRED (loop2_entry_bb, 0)->src == loop1_exit_bb
1017                    && EDGE_PRED (loop2_entry_bb, 1)->src == loop1_entry_bb)
1018                || (EDGE_PRED (loop2_entry_bb, 1)->src ==  loop1_exit_bb
1019                    && EDGE_PRED (loop2_entry_bb, 0)->src == loop1_entry_bb)));
1020   
1021   /* Verify that the other successor of first_loopt->exit is after the
1022      second_loop.  */
1023   /* TODO */
1024 }
1025 #endif
1026
1027 /* Function slpeel_tree_peel_loop_to_edge.
1028
1029    Peel the first (last) iterations of LOOP into a new prolog (epilog) loop
1030    that is placed on the entry (exit) edge E of LOOP. After this transformation
1031    we have two loops one after the other - first-loop iterates FIRST_NITERS
1032    times, and second-loop iterates the remainder NITERS - FIRST_NITERS times.
1033
1034    Input:
1035    - LOOP: the loop to be peeled.
1036    - E: the exit or entry edge of LOOP.
1037         If it is the entry edge, we peel the first iterations of LOOP. In this
1038         case first-loop is LOOP, and second-loop is the newly created loop.
1039         If it is the exit edge, we peel the last iterations of LOOP. In this
1040         case, first-loop is the newly created loop, and second-loop is LOOP.
1041    - NITERS: the number of iterations that LOOP iterates.
1042    - FIRST_NITERS: the number of iterations that the first-loop should iterate.
1043    - UPDATE_FIRST_LOOP_COUNT:  specified whether this function is responsible
1044         for updating the loop bound of the first-loop to FIRST_NITERS.  If it
1045         is false, the caller of this function may want to take care of this
1046         (this can be useful if we don't want new stmts added to first-loop).
1047
1048    Output:
1049    The function returns a pointer to the new loop-copy, or NULL if it failed
1050    to perform the transformation.
1051
1052    The function generates two if-then-else guards: one before the first loop,
1053    and the other before the second loop:
1054    The first guard is:
1055      if (FIRST_NITERS == 0) then skip the first loop,
1056      and go directly to the second loop.
1057    The second guard is:
1058      if (FIRST_NITERS == NITERS) then skip the second loop.
1059
1060    FORNOW only simple loops are supported (see slpeel_can_duplicate_loop_p).
1061    FORNOW the resulting code will not be in loop-closed-ssa form.
1062 */
1063
1064 struct loop*
1065 slpeel_tree_peel_loop_to_edge (struct loop *loop, 
1066                                edge e, tree first_niters, 
1067                                tree niters, bool update_first_loop_count)
1068 {
1069   struct loop *new_loop = NULL, *first_loop, *second_loop;
1070   edge skip_e;
1071   tree pre_condition;
1072   bitmap definitions;
1073   basic_block bb_before_second_loop, bb_after_second_loop;
1074   basic_block bb_before_first_loop;
1075   basic_block bb_between_loops;
1076   basic_block new_exit_bb;
1077   edge exit_e = single_exit (loop);
1078   LOC loop_loc;
1079   
1080   if (!slpeel_can_duplicate_loop_p (loop, e))
1081     return NULL;
1082   
1083   /* We have to initialize cfg_hooks. Then, when calling
1084    cfg_hooks->split_edge, the function tree_split_edge 
1085    is actually called and, when calling cfg_hooks->duplicate_block,
1086    the function tree_duplicate_bb is called.  */
1087   tree_register_cfg_hooks ();
1088
1089
1090   /* 1. Generate a copy of LOOP and put it on E (E is the entry/exit of LOOP).
1091         Resulting CFG would be:
1092
1093         first_loop:
1094         do {
1095         } while ...
1096
1097         second_loop:
1098         do {
1099         } while ...
1100
1101         orig_exit_bb:
1102    */
1103   
1104   if (!(new_loop = slpeel_tree_duplicate_loop_to_edge_cfg (loop, e)))
1105     {
1106       loop_loc = find_loop_location (loop);
1107       if (dump_file && (dump_flags & TDF_DETAILS))
1108         {
1109           if (loop_loc != UNKNOWN_LOC)
1110             fprintf (dump_file, "\n%s:%d: note: ",
1111                      LOC_FILE (loop_loc), LOC_LINE (loop_loc));
1112           fprintf (dump_file, "tree_duplicate_loop_to_edge_cfg failed.\n");
1113         }
1114       return NULL;
1115     }
1116   
1117   if (e == exit_e)
1118     {
1119       /* NEW_LOOP was placed after LOOP.  */
1120       first_loop = loop;
1121       second_loop = new_loop;
1122     }
1123   else
1124     {
1125       /* NEW_LOOP was placed before LOOP.  */
1126       first_loop = new_loop;
1127       second_loop = loop;
1128     }
1129
1130   definitions = ssa_names_to_replace ();
1131   slpeel_update_phis_for_duplicate_loop (loop, new_loop, e == exit_e);
1132   rename_variables_in_loop (new_loop);
1133
1134
1135   /* 2. Add the guard that controls whether the first loop is executed.
1136         Resulting CFG would be:
1137
1138         bb_before_first_loop:
1139         if (FIRST_NITERS == 0) GOTO bb_before_second_loop
1140                                GOTO first-loop
1141
1142         first_loop:
1143         do {
1144         } while ...
1145
1146         bb_before_second_loop:
1147
1148         second_loop:
1149         do {
1150         } while ...
1151
1152         orig_exit_bb:
1153    */
1154
1155   bb_before_first_loop = split_edge (loop_preheader_edge (first_loop));
1156   bb_before_second_loop = split_edge (single_exit (first_loop));
1157
1158   pre_condition =
1159     fold_build2 (LE_EXPR, boolean_type_node, first_niters, 
1160                  build_int_cst (TREE_TYPE (first_niters), 0));
1161   skip_e = slpeel_add_loop_guard (bb_before_first_loop, pre_condition,
1162                                   bb_before_second_loop, bb_before_first_loop);
1163   slpeel_update_phi_nodes_for_guard1 (skip_e, first_loop,
1164                                       first_loop == new_loop,
1165                                       &new_exit_bb, &definitions);
1166
1167
1168   /* 3. Add the guard that controls whether the second loop is executed.
1169         Resulting CFG would be:
1170
1171         bb_before_first_loop:
1172         if (FIRST_NITERS == 0) GOTO bb_before_second_loop (skip first loop)
1173                                GOTO first-loop
1174
1175         first_loop:
1176         do {
1177         } while ...
1178
1179         bb_between_loops:
1180         if (FIRST_NITERS == NITERS) GOTO bb_after_second_loop (skip second loop)
1181                                     GOTO bb_before_second_loop
1182
1183         bb_before_second_loop:
1184
1185         second_loop:
1186         do {
1187         } while ...
1188
1189         bb_after_second_loop:
1190
1191         orig_exit_bb:
1192    */
1193
1194   bb_between_loops = new_exit_bb;
1195   bb_after_second_loop = split_edge (single_exit (second_loop));
1196
1197   pre_condition = 
1198         fold_build2 (EQ_EXPR, boolean_type_node, first_niters, niters);
1199   skip_e = slpeel_add_loop_guard (bb_between_loops, pre_condition,
1200                                   bb_after_second_loop, bb_before_first_loop);
1201   slpeel_update_phi_nodes_for_guard2 (skip_e, second_loop,
1202                                      second_loop == new_loop, &new_exit_bb);
1203
1204   /* 4. Make first-loop iterate FIRST_NITERS times, if requested.
1205    */
1206   if (update_first_loop_count)
1207     slpeel_make_loop_iterate_ntimes (first_loop, first_niters);
1208
1209   BITMAP_FREE (definitions);
1210   delete_update_ssa ();
1211
1212   return new_loop;
1213 }
1214
1215 /* Function vect_get_loop_location.
1216
1217    Extract the location of the loop in the source code.
1218    If the loop is not well formed for vectorization, an estimated
1219    location is calculated.
1220    Return the loop location if succeed and NULL if not.  */
1221
1222 LOC
1223 find_loop_location (struct loop *loop)
1224 {
1225   tree node = NULL_TREE;
1226   basic_block bb;
1227   block_stmt_iterator si;
1228
1229   if (!loop)
1230     return UNKNOWN_LOC;
1231
1232   node = get_loop_exit_condition (loop);
1233
1234   if (node && CAN_HAVE_LOCATION_P (node) && EXPR_HAS_LOCATION (node)
1235       && EXPR_FILENAME (node) && EXPR_LINENO (node))
1236     return EXPR_LOC (node);
1237
1238   /* If we got here the loop is probably not "well formed",
1239      try to estimate the loop location */
1240
1241   if (!loop->header)
1242     return UNKNOWN_LOC;
1243
1244   bb = loop->header;
1245
1246   for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
1247     {
1248       node = bsi_stmt (si);
1249       if (node && CAN_HAVE_LOCATION_P (node) && EXPR_HAS_LOCATION (node))
1250         return EXPR_LOC (node);
1251     }
1252
1253   return UNKNOWN_LOC;
1254 }
1255
1256
1257 /*************************************************************************
1258   Vectorization Debug Information.
1259  *************************************************************************/
1260
1261 /* Function vect_set_verbosity_level.
1262
1263    Called from toplev.c upon detection of the
1264    -ftree-vectorizer-verbose=N option.  */
1265
1266 void
1267 vect_set_verbosity_level (const char *val)
1268 {
1269    unsigned int vl;
1270
1271    vl = atoi (val);
1272    if (vl < MAX_VERBOSITY_LEVEL)
1273      vect_verbosity_level = vl;
1274    else
1275      vect_verbosity_level = MAX_VERBOSITY_LEVEL - 1;
1276 }
1277
1278
1279 /* Function vect_set_dump_settings.
1280
1281    Fix the verbosity level of the vectorizer if the
1282    requested level was not set explicitly using the flag
1283    -ftree-vectorizer-verbose=N.
1284    Decide where to print the debugging information (dump_file/stderr).
1285    If the user defined the verbosity level, but there is no dump file,
1286    print to stderr, otherwise print to the dump file.  */
1287
1288 static void
1289 vect_set_dump_settings (void)
1290 {
1291   vect_dump = dump_file;
1292
1293   /* Check if the verbosity level was defined by the user:  */
1294   if (vect_verbosity_level != MAX_VERBOSITY_LEVEL)
1295     {
1296       /* If there is no dump file, print to stderr.  */
1297       if (!dump_file)
1298         vect_dump = stderr;
1299       return;
1300     }
1301
1302   /* User didn't specify verbosity level:  */
1303   if (dump_file && (dump_flags & TDF_DETAILS))
1304     vect_verbosity_level = REPORT_DETAILS;
1305   else if (dump_file && (dump_flags & TDF_STATS))
1306     vect_verbosity_level = REPORT_UNVECTORIZED_LOOPS;
1307   else
1308     vect_verbosity_level = REPORT_NONE;
1309
1310   gcc_assert (dump_file || vect_verbosity_level == REPORT_NONE);
1311 }
1312
1313
1314 /* Function debug_loop_details.
1315
1316    For vectorization debug dumps.  */
1317
1318 bool
1319 vect_print_dump_info (enum verbosity_levels vl)
1320 {
1321   if (vl > vect_verbosity_level)
1322     return false;
1323
1324   if (!current_function_decl || !vect_dump)
1325     return false;
1326
1327   if (vect_loop_location == UNKNOWN_LOC)
1328     fprintf (vect_dump, "\n%s:%d: note: ",
1329              DECL_SOURCE_FILE (current_function_decl),
1330              DECL_SOURCE_LINE (current_function_decl));
1331   else
1332     fprintf (vect_dump, "\n%s:%d: note: ", 
1333              LOC_FILE (vect_loop_location), LOC_LINE (vect_loop_location));
1334
1335   return true;
1336 }
1337
1338
1339 /*************************************************************************
1340   Vectorization Utilities.
1341  *************************************************************************/
1342
1343 /* Function new_stmt_vec_info.
1344
1345    Create and initialize a new stmt_vec_info struct for STMT.  */
1346
1347 stmt_vec_info
1348 new_stmt_vec_info (tree stmt, loop_vec_info loop_vinfo)
1349 {
1350   stmt_vec_info res;
1351   res = (stmt_vec_info) xcalloc (1, sizeof (struct _stmt_vec_info));
1352
1353   STMT_VINFO_TYPE (res) = undef_vec_info_type;
1354   STMT_VINFO_STMT (res) = stmt;
1355   STMT_VINFO_LOOP_VINFO (res) = loop_vinfo;
1356   STMT_VINFO_RELEVANT (res) = 0;
1357   STMT_VINFO_LIVE_P (res) = false;
1358   STMT_VINFO_VECTYPE (res) = NULL;
1359   STMT_VINFO_VEC_STMT (res) = NULL;
1360   STMT_VINFO_IN_PATTERN_P (res) = false;
1361   STMT_VINFO_RELATED_STMT (res) = NULL;
1362   STMT_VINFO_DATA_REF (res) = NULL;
1363   if (TREE_CODE (stmt) == PHI_NODE)
1364     STMT_VINFO_DEF_TYPE (res) = vect_unknown_def_type;
1365   else
1366     STMT_VINFO_DEF_TYPE (res) = vect_loop_def;
1367   STMT_VINFO_SAME_ALIGN_REFS (res) = VEC_alloc (dr_p, heap, 5);
1368   DR_GROUP_FIRST_DR (res) = NULL_TREE;
1369   DR_GROUP_NEXT_DR (res) = NULL_TREE;
1370   DR_GROUP_SIZE (res) = 0;
1371   DR_GROUP_STORE_COUNT (res) = 0;
1372   DR_GROUP_GAP (res) = 0;
1373   DR_GROUP_SAME_DR_STMT (res) = NULL_TREE;
1374
1375   return res;
1376 }
1377
1378
1379 /* Function new_loop_vec_info.
1380
1381    Create and initialize a new loop_vec_info struct for LOOP, as well as
1382    stmt_vec_info structs for all the stmts in LOOP.  */
1383
1384 loop_vec_info
1385 new_loop_vec_info (struct loop *loop)
1386 {
1387   loop_vec_info res;
1388   basic_block *bbs;
1389   block_stmt_iterator si;
1390   unsigned int i;
1391
1392   res = (loop_vec_info) xcalloc (1, sizeof (struct _loop_vec_info));
1393
1394   bbs = get_loop_body (loop);
1395
1396   /* Create stmt_info for all stmts in the loop.  */
1397   for (i = 0; i < loop->num_nodes; i++)
1398     {
1399       basic_block bb = bbs[i];
1400       tree phi;
1401
1402       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
1403         {
1404           stmt_ann_t ann = get_stmt_ann (phi);
1405           set_stmt_info (ann, new_stmt_vec_info (phi, res));
1406         }
1407
1408       for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
1409         {
1410           tree stmt = bsi_stmt (si);
1411           stmt_ann_t ann;
1412
1413           ann = stmt_ann (stmt);
1414           set_stmt_info (ann, new_stmt_vec_info (stmt, res));
1415         }
1416     }
1417
1418   LOOP_VINFO_LOOP (res) = loop;
1419   LOOP_VINFO_BBS (res) = bbs;
1420   LOOP_VINFO_EXIT_COND (res) = NULL;
1421   LOOP_VINFO_NITERS (res) = NULL;
1422   LOOP_VINFO_VECTORIZABLE_P (res) = 0;
1423   LOOP_PEELING_FOR_ALIGNMENT (res) = 0;
1424   LOOP_VINFO_VECT_FACTOR (res) = 0;
1425   LOOP_VINFO_DATAREFS (res) = VEC_alloc (data_reference_p, heap, 10);
1426   LOOP_VINFO_DDRS (res) = VEC_alloc (ddr_p, heap, 10 * 10);
1427   LOOP_VINFO_UNALIGNED_DR (res) = NULL;
1428   LOOP_VINFO_MAY_MISALIGN_STMTS (res)
1429     = VEC_alloc (tree, heap, PARAM_VALUE (PARAM_VECT_MAX_VERSION_CHECKS));
1430
1431   return res;
1432 }
1433
1434
1435 /* Function destroy_loop_vec_info.
1436  
1437    Free LOOP_VINFO struct, as well as all the stmt_vec_info structs of all the 
1438    stmts in the loop.  */
1439
1440 void
1441 destroy_loop_vec_info (loop_vec_info loop_vinfo)
1442 {
1443   struct loop *loop;
1444   basic_block *bbs;
1445   int nbbs;
1446   block_stmt_iterator si;
1447   int j;
1448
1449   if (!loop_vinfo)
1450     return;
1451
1452   loop = LOOP_VINFO_LOOP (loop_vinfo);
1453
1454   bbs = LOOP_VINFO_BBS (loop_vinfo);
1455   nbbs = loop->num_nodes;
1456
1457   for (j = 0; j < nbbs; j++)
1458     {
1459       basic_block bb = bbs[j];
1460       tree phi;
1461       stmt_vec_info stmt_info;
1462
1463       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
1464         {
1465           stmt_ann_t ann = stmt_ann (phi);
1466
1467           stmt_info = vinfo_for_stmt (phi);
1468           free (stmt_info);
1469           set_stmt_info (ann, NULL);
1470         }
1471
1472       for (si = bsi_start (bb); !bsi_end_p (si); )
1473         {
1474           tree stmt = bsi_stmt (si);
1475           stmt_ann_t ann = stmt_ann (stmt);
1476           stmt_vec_info stmt_info = vinfo_for_stmt (stmt);
1477
1478           if (stmt_info)
1479             {
1480               /* Check if this is a "pattern stmt" (introduced by the 
1481                  vectorizer during the pattern recognition pass).  */
1482               bool remove_stmt_p = false;
1483               tree orig_stmt = STMT_VINFO_RELATED_STMT (stmt_info);
1484               if (orig_stmt)
1485                 {
1486                   stmt_vec_info orig_stmt_info = vinfo_for_stmt (orig_stmt);
1487                   if (orig_stmt_info
1488                       && STMT_VINFO_IN_PATTERN_P (orig_stmt_info))
1489                     remove_stmt_p = true; 
1490                 }
1491                         
1492               /* Free stmt_vec_info.  */
1493               VEC_free (dr_p, heap, STMT_VINFO_SAME_ALIGN_REFS (stmt_info));
1494               free (stmt_info);
1495               set_stmt_info (ann, NULL);
1496
1497               /* Remove dead "pattern stmts".  */
1498               if (remove_stmt_p)
1499                 bsi_remove (&si, true);
1500             }
1501           bsi_next (&si);
1502         }
1503     }
1504
1505   free (LOOP_VINFO_BBS (loop_vinfo));
1506   free_data_refs (LOOP_VINFO_DATAREFS (loop_vinfo));
1507   free_dependence_relations (LOOP_VINFO_DDRS (loop_vinfo));
1508   VEC_free (tree, heap, LOOP_VINFO_MAY_MISALIGN_STMTS (loop_vinfo));
1509
1510   free (loop_vinfo);
1511 }
1512
1513
1514 /* Function vect_force_dr_alignment_p.
1515
1516    Returns whether the alignment of a DECL can be forced to be aligned
1517    on ALIGNMENT bit boundary.  */
1518
1519 bool 
1520 vect_can_force_dr_alignment_p (tree decl, unsigned int alignment)
1521 {
1522   if (TREE_CODE (decl) != VAR_DECL)
1523     return false;
1524
1525   if (DECL_EXTERNAL (decl))
1526     return false;
1527
1528   if (TREE_ASM_WRITTEN (decl))
1529     return false;
1530
1531   if (TREE_STATIC (decl))
1532     return (alignment <= MAX_OFILE_ALIGNMENT);
1533   else
1534     /* This is not 100% correct.  The absolute correct stack alignment
1535        is STACK_BOUNDARY.  We're supposed to hope, but not assume, that
1536        PREFERRED_STACK_BOUNDARY is honored by all translation units.
1537        However, until someone implements forced stack alignment, SSE
1538        isn't really usable without this.  */  
1539     return (alignment <= PREFERRED_STACK_BOUNDARY); 
1540 }
1541
1542
1543 /* Function get_vectype_for_scalar_type.
1544
1545    Returns the vector type corresponding to SCALAR_TYPE as supported
1546    by the target.  */
1547
1548 tree
1549 get_vectype_for_scalar_type (tree scalar_type)
1550 {
1551   enum machine_mode inner_mode = TYPE_MODE (scalar_type);
1552   int nbytes = GET_MODE_SIZE (inner_mode);
1553   int nunits;
1554   tree vectype;
1555
1556   if (nbytes == 0 || nbytes >= UNITS_PER_SIMD_WORD)
1557     return NULL_TREE;
1558
1559   /* FORNOW: Only a single vector size per target (UNITS_PER_SIMD_WORD)
1560      is expected.  */
1561   nunits = UNITS_PER_SIMD_WORD / nbytes;
1562
1563   vectype = build_vector_type (scalar_type, nunits);
1564   if (vect_print_dump_info (REPORT_DETAILS))
1565     {
1566       fprintf (vect_dump, "get vectype with %d units of type ", nunits);
1567       print_generic_expr (vect_dump, scalar_type, TDF_SLIM);
1568     }
1569
1570   if (!vectype)
1571     return NULL_TREE;
1572
1573   if (vect_print_dump_info (REPORT_DETAILS))
1574     {
1575       fprintf (vect_dump, "vectype: ");
1576       print_generic_expr (vect_dump, vectype, TDF_SLIM);
1577     }
1578
1579   if (!VECTOR_MODE_P (TYPE_MODE (vectype))
1580       && !INTEGRAL_MODE_P (TYPE_MODE (vectype)))
1581     {
1582       if (vect_print_dump_info (REPORT_DETAILS))
1583         fprintf (vect_dump, "mode not supported by target.");
1584       return NULL_TREE;
1585     }
1586
1587   return vectype;
1588 }
1589
1590
1591 /* Function vect_supportable_dr_alignment
1592
1593    Return whether the data reference DR is supported with respect to its
1594    alignment.  */
1595
1596 enum dr_alignment_support
1597 vect_supportable_dr_alignment (struct data_reference *dr)
1598 {
1599   tree vectype = STMT_VINFO_VECTYPE (vinfo_for_stmt (DR_STMT (dr)));
1600   enum machine_mode mode = (int) TYPE_MODE (vectype);
1601
1602   if (aligned_access_p (dr))
1603     return dr_aligned;
1604
1605   /* Possibly unaligned access.  */
1606   
1607   if (DR_IS_READ (dr))
1608     {
1609       if (vec_realign_load_optab->handlers[mode].insn_code != CODE_FOR_nothing
1610           && (!targetm.vectorize.builtin_mask_for_load
1611               || targetm.vectorize.builtin_mask_for_load ()))
1612         return dr_unaligned_software_pipeline;
1613
1614       if (movmisalign_optab->handlers[mode].insn_code != CODE_FOR_nothing)
1615         /* Can't software pipeline the loads, but can at least do them.  */
1616         return dr_unaligned_supported;
1617     }
1618
1619   /* Unsupported.  */
1620   return dr_unaligned_unsupported;
1621 }
1622
1623
1624 /* Function vect_is_simple_use.
1625
1626    Input:
1627    LOOP - the loop that is being vectorized.
1628    OPERAND - operand of a stmt in LOOP.
1629    DEF - the defining stmt in case OPERAND is an SSA_NAME.
1630
1631    Returns whether a stmt with OPERAND can be vectorized.
1632    Supportable operands are constants, loop invariants, and operands that are
1633    defined by the current iteration of the loop. Unsupportable operands are 
1634    those that are defined by a previous iteration of the loop (as is the case
1635    in reduction/induction computations).  */
1636
1637 bool
1638 vect_is_simple_use (tree operand, loop_vec_info loop_vinfo, tree *def_stmt,
1639                     tree *def, enum vect_def_type *dt)
1640
1641   basic_block bb;
1642   stmt_vec_info stmt_vinfo;
1643   struct loop *loop = LOOP_VINFO_LOOP (loop_vinfo);
1644
1645   *def_stmt = NULL_TREE;
1646   *def = NULL_TREE;
1647   
1648   if (vect_print_dump_info (REPORT_DETAILS))
1649     {
1650       fprintf (vect_dump, "vect_is_simple_use: operand ");
1651       print_generic_expr (vect_dump, operand, TDF_SLIM);
1652     }
1653     
1654   if (TREE_CODE (operand) == INTEGER_CST || TREE_CODE (operand) == REAL_CST)
1655     {
1656       *dt = vect_constant_def;
1657       return true;
1658     }
1659     
1660   if (TREE_CODE (operand) != SSA_NAME)
1661     {
1662       if (vect_print_dump_info (REPORT_DETAILS))
1663         fprintf (vect_dump, "not ssa-name.");
1664       return false;
1665     }
1666     
1667   *def_stmt = SSA_NAME_DEF_STMT (operand);
1668   if (*def_stmt == NULL_TREE )
1669     {
1670       if (vect_print_dump_info (REPORT_DETAILS))
1671         fprintf (vect_dump, "no def_stmt.");
1672       return false;
1673     }
1674
1675   if (vect_print_dump_info (REPORT_DETAILS))
1676     {
1677       fprintf (vect_dump, "def_stmt: ");
1678       print_generic_expr (vect_dump, *def_stmt, TDF_SLIM);
1679     }
1680
1681   /* empty stmt is expected only in case of a function argument.
1682      (Otherwise - we expect a phi_node or a GIMPLE_MODIFY_STMT).  */
1683   if (IS_EMPTY_STMT (*def_stmt))
1684     {
1685       tree arg = TREE_OPERAND (*def_stmt, 0);
1686       if (TREE_CODE (arg) == INTEGER_CST || TREE_CODE (arg) == REAL_CST)
1687         {
1688           *def = operand;
1689           *dt = vect_invariant_def;
1690           return true;
1691         }
1692
1693       if (vect_print_dump_info (REPORT_DETAILS))
1694         fprintf (vect_dump, "Unexpected empty stmt.");
1695       return false;
1696     }
1697
1698   bb = bb_for_stmt (*def_stmt);
1699   if (!flow_bb_inside_loop_p (loop, bb))
1700     *dt = vect_invariant_def;
1701   else
1702     {
1703       stmt_vinfo = vinfo_for_stmt (*def_stmt);
1704       *dt = STMT_VINFO_DEF_TYPE (stmt_vinfo);
1705     }
1706
1707   if (*dt == vect_unknown_def_type)
1708     {
1709       if (vect_print_dump_info (REPORT_DETAILS))
1710         fprintf (vect_dump, "Unsupported pattern.");
1711       return false;
1712     }
1713
1714   /* stmts inside the loop that have been identified as performing
1715      a reduction operation cannot have uses in the loop.  */
1716   if (*dt == vect_reduction_def && TREE_CODE (*def_stmt) != PHI_NODE)
1717     {
1718       if (vect_print_dump_info (REPORT_DETAILS))
1719         fprintf (vect_dump, "reduction used in loop.");
1720       return false;
1721     }
1722
1723   if (vect_print_dump_info (REPORT_DETAILS))
1724     fprintf (vect_dump, "type of def: %d.",*dt);
1725
1726   switch (TREE_CODE (*def_stmt))
1727     {
1728     case PHI_NODE:
1729       *def = PHI_RESULT (*def_stmt);
1730       gcc_assert (*dt == vect_induction_def || *dt == vect_reduction_def
1731                   || *dt == vect_invariant_def);
1732       break;
1733
1734     case GIMPLE_MODIFY_STMT:
1735       *def = GIMPLE_STMT_OPERAND (*def_stmt, 0);
1736       gcc_assert (*dt == vect_loop_def || *dt == vect_invariant_def);
1737       break;
1738
1739     default:
1740       if (vect_print_dump_info (REPORT_DETAILS))
1741         fprintf (vect_dump, "unsupported defining stmt: ");
1742       return false;
1743     }
1744
1745   if (*dt == vect_induction_def)
1746     {
1747       if (vect_print_dump_info (REPORT_DETAILS))
1748         fprintf (vect_dump, "induction not supported.");
1749       return false;
1750     }
1751
1752   return true;
1753 }
1754
1755
1756 /* Function supportable_widening_operation
1757
1758    Check whether an operation represented by the code CODE is a 
1759    widening operation that is supported by the target platform in 
1760    vector form (i.e., when operating on arguments of type VECTYPE).
1761     
1762    The two kinds of widening operations we currently support are
1763    NOP and WIDEN_MULT. This function checks if these operations
1764    are supported by the target platform either directly (via vector 
1765    tree-codes), or via target builtins.
1766
1767    Output:
1768    - CODE1 and CODE2 are codes of vector operations to be used when 
1769    vectorizing the operation, if available. 
1770    - DECL1 and DECL2 are decls of target builtin functions to be used
1771    when vectorizing the operation, if available. In this case,
1772    CODE1 and CODE2 are CALL_EXPR.  */
1773
1774 bool
1775 supportable_widening_operation (enum tree_code code, tree stmt, tree vectype,
1776                                 tree *decl1, tree *decl2,
1777                                 enum tree_code *code1, enum tree_code *code2)
1778 {
1779   stmt_vec_info stmt_info = vinfo_for_stmt (stmt);
1780   bool ordered_p;
1781   enum machine_mode vec_mode;
1782   enum insn_code icode1, icode2;
1783   optab optab1, optab2;
1784   tree expr = GIMPLE_STMT_OPERAND (stmt, 1);
1785   tree type = TREE_TYPE (expr);
1786   tree wide_vectype = get_vectype_for_scalar_type (type);
1787   enum tree_code c1, c2;
1788
1789   /* The result of a vectorized widening operation usually requires two vectors 
1790      (because the widened results do not fit int one vector). The generated 
1791      vector results would normally be expected to be generated in the same 
1792      order as in the original scalar computation. i.e. if 8 results are 
1793      generated in each vector iteration, they are to be organized as follows:
1794         vect1: [res1,res2,res3,res4], vect2: [res5,res6,res7,res8]. 
1795
1796      However, in the special case that the result of the widening operation is 
1797      used in a reduction computation only, the order doesn't matter (because
1798      when vectorizing a reduction we change the order of the computation). 
1799      Some targets can take advantage of this and generate more efficient code.
1800      For example, targets like Altivec, that support widen_mult using a sequence
1801      of {mult_even,mult_odd} generate the following vectors:
1802         vect1: [res1,res3,res5,res7], vect2: [res2,res4,res6,res8].  */
1803
1804    if (STMT_VINFO_RELEVANT (stmt_info) == vect_used_by_reduction)
1805      ordered_p = false;
1806    else
1807      ordered_p = true;
1808
1809   if (!ordered_p
1810       && code == WIDEN_MULT_EXPR
1811       && targetm.vectorize.builtin_mul_widen_even
1812       && targetm.vectorize.builtin_mul_widen_even (vectype)
1813       && targetm.vectorize.builtin_mul_widen_odd
1814       && targetm.vectorize.builtin_mul_widen_odd (vectype))
1815     {
1816       if (vect_print_dump_info (REPORT_DETAILS))
1817         fprintf (vect_dump, "Unordered widening operation detected.");
1818
1819       *code1 = *code2 = CALL_EXPR;
1820       *decl1 = targetm.vectorize.builtin_mul_widen_even (vectype);
1821       *decl2 = targetm.vectorize.builtin_mul_widen_odd (vectype);
1822       return true;
1823     }
1824
1825   switch (code)
1826     {
1827     case WIDEN_MULT_EXPR:
1828       if (BYTES_BIG_ENDIAN)
1829         {
1830           c1 = VEC_WIDEN_MULT_HI_EXPR;
1831           c2 = VEC_WIDEN_MULT_LO_EXPR;
1832         }
1833       else
1834         {
1835           c2 = VEC_WIDEN_MULT_HI_EXPR;
1836           c1 = VEC_WIDEN_MULT_LO_EXPR;
1837         }
1838       break;
1839
1840     case NOP_EXPR:
1841       if (BYTES_BIG_ENDIAN)
1842         {
1843           c1 = VEC_UNPACK_HI_EXPR;
1844           c2 = VEC_UNPACK_LO_EXPR;
1845         }
1846       else
1847         {
1848           c2 = VEC_UNPACK_HI_EXPR;
1849           c1 = VEC_UNPACK_LO_EXPR;
1850         }
1851       break;
1852
1853     default:
1854       gcc_unreachable ();
1855     }
1856
1857   *code1 = c1;
1858   *code2 = c2;
1859   optab1 = optab_for_tree_code (c1, vectype);
1860   optab2 = optab_for_tree_code (c2, vectype);
1861
1862   if (!optab1 || !optab2)
1863     return false;
1864
1865   vec_mode = TYPE_MODE (vectype);
1866   if ((icode1 = optab1->handlers[(int) vec_mode].insn_code) == CODE_FOR_nothing
1867       || insn_data[icode1].operand[0].mode != TYPE_MODE (wide_vectype)
1868       || (icode2 = optab2->handlers[(int) vec_mode].insn_code)
1869                                                         == CODE_FOR_nothing
1870       || insn_data[icode2].operand[0].mode != TYPE_MODE (wide_vectype))
1871     return false;
1872
1873   return true;
1874 }
1875
1876
1877 /* Function reduction_code_for_scalar_code
1878
1879    Input:
1880    CODE - tree_code of a reduction operations.
1881
1882    Output:
1883    REDUC_CODE - the corresponding tree-code to be used to reduce the
1884       vector of partial results into a single scalar result (which
1885       will also reside in a vector).
1886
1887    Return TRUE if a corresponding REDUC_CODE was found, FALSE otherwise.  */
1888
1889 bool
1890 reduction_code_for_scalar_code (enum tree_code code,
1891                                 enum tree_code *reduc_code)
1892 {
1893   switch (code)
1894   {
1895   case MAX_EXPR:
1896     *reduc_code = REDUC_MAX_EXPR;
1897     return true;
1898
1899   case MIN_EXPR:
1900     *reduc_code = REDUC_MIN_EXPR;
1901     return true;
1902
1903   case PLUS_EXPR:
1904     *reduc_code = REDUC_PLUS_EXPR;
1905     return true;
1906
1907   default:
1908     return false;
1909   }
1910 }
1911
1912
1913 /* Function vect_is_simple_reduction
1914
1915    Detect a cross-iteration def-use cucle that represents a simple
1916    reduction computation. We look for the following pattern:
1917
1918    loop_header:
1919      a1 = phi < a0, a2 >
1920      a3 = ...
1921      a2 = operation (a3, a1)
1922   
1923    such that:
1924    1. operation is commutative and associative and it is safe to 
1925       change the order of the computation.
1926    2. no uses for a2 in the loop (a2 is used out of the loop)
1927    3. no uses of a1 in the loop besides the reduction operation.
1928
1929    Condition 1 is tested here.
1930    Conditions 2,3 are tested in vect_mark_stmts_to_be_vectorized.  */
1931
1932 tree
1933 vect_is_simple_reduction (struct loop *loop, tree phi)
1934 {
1935   edge latch_e = loop_latch_edge (loop);
1936   tree loop_arg = PHI_ARG_DEF_FROM_EDGE (phi, latch_e);
1937   tree def_stmt, def1, def2;
1938   enum tree_code code;
1939   int op_type;
1940   tree operation, op1, op2;
1941   tree type;
1942
1943   if (TREE_CODE (loop_arg) != SSA_NAME)
1944     {
1945       if (vect_print_dump_info (REPORT_DETAILS))
1946         {
1947           fprintf (vect_dump, "reduction: not ssa_name: ");
1948           print_generic_expr (vect_dump, loop_arg, TDF_SLIM);
1949         }
1950       return NULL_TREE;
1951     }
1952
1953   def_stmt = SSA_NAME_DEF_STMT (loop_arg);
1954   if (!def_stmt)
1955     {
1956       if (vect_print_dump_info (REPORT_DETAILS))
1957         fprintf (vect_dump, "reduction: no def_stmt.");
1958       return NULL_TREE;
1959     }
1960
1961   if (TREE_CODE (def_stmt) != GIMPLE_MODIFY_STMT)
1962     {
1963       if (vect_print_dump_info (REPORT_DETAILS))
1964         {
1965           print_generic_expr (vect_dump, def_stmt, TDF_SLIM);
1966         }
1967       return NULL_TREE;
1968     }
1969
1970   operation = GIMPLE_STMT_OPERAND (def_stmt, 1);
1971   code = TREE_CODE (operation);
1972   if (!commutative_tree_code (code) || !associative_tree_code (code))
1973     {
1974       if (vect_print_dump_info (REPORT_DETAILS))
1975         {
1976           fprintf (vect_dump, "reduction: not commutative/associative: ");
1977           print_generic_expr (vect_dump, operation, TDF_SLIM);
1978         }
1979       return NULL_TREE;
1980     }
1981
1982   op_type = TREE_CODE_LENGTH (code);
1983   if (op_type != binary_op)
1984     {
1985       if (vect_print_dump_info (REPORT_DETAILS))
1986         {
1987           fprintf (vect_dump, "reduction: not binary operation: ");
1988           print_generic_expr (vect_dump, operation, TDF_SLIM);
1989         }
1990       return NULL_TREE;
1991     }
1992
1993   op1 = TREE_OPERAND (operation, 0);
1994   op2 = TREE_OPERAND (operation, 1);
1995   if (TREE_CODE (op1) != SSA_NAME || TREE_CODE (op2) != SSA_NAME)
1996     {
1997       if (vect_print_dump_info (REPORT_DETAILS))
1998         {
1999           fprintf (vect_dump, "reduction: uses not ssa_names: ");
2000           print_generic_expr (vect_dump, operation, TDF_SLIM);
2001         }
2002       return NULL_TREE;
2003     }
2004
2005   /* Check that it's ok to change the order of the computation.  */
2006   type = TREE_TYPE (operation);
2007   if (TYPE_MAIN_VARIANT (type) != TYPE_MAIN_VARIANT (TREE_TYPE (op1))
2008       || TYPE_MAIN_VARIANT (type) != TYPE_MAIN_VARIANT (TREE_TYPE (op2)))
2009     {
2010       if (vect_print_dump_info (REPORT_DETAILS))
2011         {
2012           fprintf (vect_dump, "reduction: multiple types: operation type: ");
2013           print_generic_expr (vect_dump, type, TDF_SLIM);
2014           fprintf (vect_dump, ", operands types: ");
2015           print_generic_expr (vect_dump, TREE_TYPE (op1), TDF_SLIM);
2016           fprintf (vect_dump, ",");
2017           print_generic_expr (vect_dump, TREE_TYPE (op2), TDF_SLIM);
2018         }
2019       return NULL_TREE;
2020     }
2021
2022   /* CHECKME: check for !flag_finite_math_only too?  */
2023   if (SCALAR_FLOAT_TYPE_P (type) && !flag_unsafe_math_optimizations)
2024     {
2025       /* Changing the order of operations changes the semantics.  */
2026       if (vect_print_dump_info (REPORT_DETAILS))
2027         {
2028           fprintf (vect_dump, "reduction: unsafe fp math optimization: ");
2029           print_generic_expr (vect_dump, operation, TDF_SLIM);
2030         }
2031       return NULL_TREE;
2032     }
2033   else if (INTEGRAL_TYPE_P (type) && !TYPE_UNSIGNED (type) && flag_trapv)
2034     {
2035       /* Changing the order of operations changes the semantics.  */
2036       if (vect_print_dump_info (REPORT_DETAILS))
2037         {
2038           fprintf (vect_dump, "reduction: unsafe int math optimization: ");
2039           print_generic_expr (vect_dump, operation, TDF_SLIM);
2040         }
2041       return NULL_TREE;
2042     }
2043
2044   /* reduction is safe. we're dealing with one of the following:
2045      1) integer arithmetic and no trapv
2046      2) floating point arithmetic, and special flags permit this optimization.
2047    */
2048   def1 = SSA_NAME_DEF_STMT (op1);
2049   def2 = SSA_NAME_DEF_STMT (op2);
2050   if (!def1 || !def2)
2051     {
2052       if (vect_print_dump_info (REPORT_DETAILS))
2053         {
2054           fprintf (vect_dump, "reduction: no defs for operands: ");
2055           print_generic_expr (vect_dump, operation, TDF_SLIM);
2056         }
2057       return NULL_TREE;
2058     }
2059
2060   if (TREE_CODE (def1) == GIMPLE_MODIFY_STMT
2061       && flow_bb_inside_loop_p (loop, bb_for_stmt (def1))
2062       && def2 == phi)
2063     {
2064       if (vect_print_dump_info (REPORT_DETAILS))
2065         {
2066           fprintf (vect_dump, "detected reduction:");
2067           print_generic_expr (vect_dump, operation, TDF_SLIM);
2068         }
2069       return def_stmt;
2070     }
2071   else if (TREE_CODE (def2) == GIMPLE_MODIFY_STMT
2072       && flow_bb_inside_loop_p (loop, bb_for_stmt (def2))
2073       && def1 == phi)
2074     {
2075       /* Swap operands (just for simplicity - so that the rest of the code
2076          can assume that the reduction variable is always the last (second)
2077          argument).  */
2078       if (vect_print_dump_info (REPORT_DETAILS))
2079         {
2080           fprintf (vect_dump, "detected reduction: need to swap operands:");
2081           print_generic_expr (vect_dump, operation, TDF_SLIM);
2082         }
2083       swap_tree_operands (def_stmt, &TREE_OPERAND (operation, 0), 
2084                                     &TREE_OPERAND (operation, 1));
2085       return def_stmt;
2086     }
2087   else
2088     {
2089       if (vect_print_dump_info (REPORT_DETAILS))
2090         {
2091           fprintf (vect_dump, "reduction: unknown pattern.");
2092           print_generic_expr (vect_dump, operation, TDF_SLIM);
2093         }
2094       return NULL_TREE;
2095     }
2096 }
2097
2098
2099 /* Function vect_is_simple_iv_evolution.
2100
2101    FORNOW: A simple evolution of an induction variables in the loop is
2102    considered a polynomial evolution with constant step.  */
2103
2104 bool
2105 vect_is_simple_iv_evolution (unsigned loop_nb, tree access_fn, tree * init, 
2106                              tree * step)
2107 {
2108   tree init_expr;
2109   tree step_expr;
2110   
2111   tree evolution_part = evolution_part_in_loop_num (access_fn, loop_nb);
2112
2113   /* When there is no evolution in this loop, the evolution function
2114      is not "simple".  */  
2115   if (evolution_part == NULL_TREE)
2116     return false;
2117   
2118   /* When the evolution is a polynomial of degree >= 2
2119      the evolution function is not "simple".  */
2120   if (tree_is_chrec (evolution_part))
2121     return false;
2122   
2123   step_expr = evolution_part;
2124   init_expr = unshare_expr (initial_condition_in_loop_num (access_fn,
2125                                                            loop_nb));
2126
2127   if (vect_print_dump_info (REPORT_DETAILS))
2128     {
2129       fprintf (vect_dump, "step: ");
2130       print_generic_expr (vect_dump, step_expr, TDF_SLIM);
2131       fprintf (vect_dump, ",  init: ");
2132       print_generic_expr (vect_dump, init_expr, TDF_SLIM);
2133     }
2134
2135   *init = init_expr;
2136   *step = step_expr;
2137
2138   if (TREE_CODE (step_expr) != INTEGER_CST)
2139     {
2140       if (vect_print_dump_info (REPORT_DETAILS))
2141         fprintf (vect_dump, "step unknown.");
2142       return false;
2143     }
2144
2145   return true;
2146 }
2147
2148
2149 /* Function vectorize_loops.
2150    
2151    Entry Point to loop vectorization phase.  */
2152
2153 unsigned
2154 vectorize_loops (void)
2155 {
2156   unsigned int i;
2157   unsigned int num_vectorized_loops = 0;
2158   unsigned int vect_loops_num;
2159   loop_iterator li;
2160   struct loop *loop;
2161
2162   /* Fix the verbosity level if not defined explicitly by the user.  */
2163   vect_set_dump_settings ();
2164
2165   /* Allocate the bitmap that records which virtual variables that 
2166      need to be renamed.  */
2167   vect_memsyms_to_rename = BITMAP_ALLOC (NULL);
2168
2169   /*  ----------- Analyze loops. -----------  */
2170
2171   /* If some loop was duplicated, it gets bigger number 
2172      than all previously defined loops. This fact allows us to run 
2173      only over initial loops skipping newly generated ones.  */
2174   vect_loops_num = number_of_loops ();
2175   FOR_EACH_LOOP (li, loop, LI_ONLY_OLD)
2176     {
2177       loop_vec_info loop_vinfo;
2178
2179       vect_loop_location = find_loop_location (loop);
2180       loop_vinfo = vect_analyze_loop (loop);
2181       loop->aux = loop_vinfo;
2182
2183       if (!loop_vinfo || !LOOP_VINFO_VECTORIZABLE_P (loop_vinfo))
2184         continue;
2185
2186       vect_transform_loop (loop_vinfo);
2187       num_vectorized_loops++;
2188     }
2189   vect_loop_location = UNKNOWN_LOC;
2190
2191   if (vect_print_dump_info (REPORT_VECTORIZED_LOOPS))
2192     fprintf (vect_dump, "vectorized %u loops in function.\n",
2193              num_vectorized_loops);
2194
2195   /*  ----------- Finalize. -----------  */
2196
2197   BITMAP_FREE (vect_memsyms_to_rename);
2198
2199   for (i = 1; i < vect_loops_num; i++)
2200     {
2201       loop_vec_info loop_vinfo;
2202
2203       loop = get_loop (i);
2204       if (!loop)
2205         continue;
2206       loop_vinfo = loop->aux;
2207       destroy_loop_vec_info (loop_vinfo);
2208       loop->aux = NULL;
2209     }
2210
2211   return num_vectorized_loops > 0 ? TODO_cleanup_cfg : 0;
2212 }
2213
2214 /* Increase alignment of global arrays to improve vectorization potential.
2215    TODO:
2216    - Consider also structs that have an array field.
2217    - Use ipa analysis to prune arrays that can't be vectorized?
2218      This should involve global alignment analysis and in the future also
2219      array padding.  */
2220
2221 static unsigned int
2222 increase_alignment (void)
2223 {
2224   struct varpool_node *vnode;
2225
2226   /* Increase the alignment of all global arrays for vectorization.  */
2227   for (vnode = varpool_nodes_queue;
2228        vnode;
2229        vnode = vnode->next_needed)
2230     {
2231       tree vectype, decl = vnode->decl;
2232       unsigned int alignment;
2233
2234       if (TREE_CODE (TREE_TYPE (decl)) != ARRAY_TYPE)
2235         continue;
2236       vectype = get_vectype_for_scalar_type (TREE_TYPE (TREE_TYPE (decl)));
2237       if (!vectype)
2238         continue;
2239       alignment = TYPE_ALIGN (vectype);
2240       if (DECL_ALIGN (decl) >= alignment)
2241         continue;
2242
2243       if (vect_can_force_dr_alignment_p (decl, alignment))
2244         { 
2245           DECL_ALIGN (decl) = TYPE_ALIGN (vectype);
2246           DECL_USER_ALIGN (decl) = 1;
2247           if (dump_file)
2248             { 
2249               fprintf (dump_file, "Increasing alignment of decl: ");
2250               print_generic_expr (dump_file, decl, TDF_SLIM);
2251             }
2252         }
2253     }
2254   return 0;
2255 }
2256
2257 static bool
2258 gate_increase_alignment (void)
2259 {
2260   return flag_section_anchors && flag_tree_vectorize;
2261 }
2262
2263 struct tree_opt_pass pass_ipa_increase_alignment = 
2264 {
2265   "increase_alignment",                 /* name */
2266   gate_increase_alignment,              /* gate */
2267   increase_alignment,                   /* execute */
2268   NULL,                                 /* sub */
2269   NULL,                                 /* next */
2270   0,                                    /* static_pass_number */
2271   0,                                    /* tv_id */
2272   0,                                    /* properties_required */
2273   0,                                    /* properties_provided */
2274   0,                                    /* properties_destroyed */
2275   0,                                    /* todo_flags_start */
2276   0,                                    /* todo_flags_finish */
2277   0                                     /* letter */
2278 };