Update the copyright coredits -- Happy new year 2013!
[oota-llvm.git] / docs / Vectorizers.rst
index ab8a252951ba8d48316cb7c515e962836328520e..3410f183781a492c408d29d6ca24829265f9ad7a 100644 (file)
@@ -2,51 +2,64 @@
 Auto-Vectorization in LLVM
 ==========================
 
-LLVM has two vectorizers: The *Loop Vectorizer*, which operates on Loops,
-and the *Basic Block Vectorizer*, which optimizes straight-line code. These
-vectorizers focus on different optimization opportunities and use different
-techniques. The BB vectorizer merges multiple scalars that are found in the
-code into vectors while the Loop Vectorizer widens instructions in the
-original loop to operate on multiple consecutive loop iterations.
+.. contents::
+   :local:
+
+LLVM has two vectorizers: The :ref:`Loop Vectorizer <loop-vectorizer>`,
+which operates on Loops, and the :ref:`Basic Block Vectorizer
+<bb-vectorizer>`, which optimizes straight-line code. These vectorizers
+focus on different optimization opportunities and use different techniques.
+The BB vectorizer merges multiple scalars that are found in the code into
+vectors while the Loop Vectorizer widens instructions in the original loop
+to operate on multiple consecutive loop iterations.
+
+.. _loop-vectorizer:
 
 The Loop Vectorizer
 ===================
 
-LLVM’s Loop Vectorizer is now available and will be useful for many people.
+Usage
+-----
+
+LLVM's Loop Vectorizer is now available and will be useful for many people.
 It is not enabled by default, but can be enabled through clang using the
 command line flag:
 
 .. code-block:: console
 
-   $ clang -fvectorize file.c
+   $ clang -fvectorize -O3 file.c
+
+If the ``-fvectorize`` flag is used then the loop vectorizer will be enabled
+when running with ``-O3``, ``-O2``. When ``-Os`` is used, the loop vectorizer
+will only vectorize loops that do not require a major increase in code size.
 
 We plan to enable the Loop Vectorizer by default as part of the LLVM 3.3 release.
 
 Features
-^^^^^^^^^
+--------
 
 The LLVM Loop Vectorizer has a number of features that allow it to vectorize
 complex loops.
 
 Loops with unknown trip count
-------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The Loop Vectorizer supports loops with an unknown trip count.
 In the loop below, the iteration ``start`` and ``finish`` points are unknown,
 and the Loop Vectorizer has a mechanism to vectorize loops that do not start
-at zero. In this example, ‘n’ may not be a multiple of the vector width, and
+at zero. In this example, 'n' may not be a multiple of the vector width, and
 the vectorizer has to execute the last few iterations as scalar code. Keeping
 a scalar copy of the loop increases the code size.
 
 .. code-block:: c++
 
   void bar(float *A, float* B, float K, int start, int end) {
-   for (int i = start; i < end; ++i)
-     A[i] *= B[i] + K;
+    for (int i = start; i < end; ++i)
+      A[i] *= B[i] + K;
   }
 
 Runtime Checks of Pointers
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 In the example below, if the pointers A and B point to consecutive addresses,
 then it is illegal to vectorize the code because some elements of A will be
@@ -57,24 +70,24 @@ pointers are disjointed, but in our example, the Loop Vectorizer has no way of
 knowing that the pointers A and B are unique. The Loop Vectorizer handles this
 loop by placing code that checks, at runtime, if the arrays A and B point to
 disjointed memory locations. If arrays A and B overlap, then the scalar version
-of the loop is executed. 
+of the loop is executed.
 
 .. code-block:: c++
 
   void bar(float *A, float* B, float K, int n) {
-   for (int i = 0; i < n; ++i)
-     A[i] *= B[i] + K;
+    for (int i = 0; i < n; ++i)
+      A[i] *= B[i] + K;
   }
 
 
 Reductions
---------------------------
+^^^^^^^^^^
 
-In this example the ``sum`` variable is used by consecutive iterations of 
+In this example the ``sum`` variable is used by consecutive iterations of
 the loop. Normally, this would prevent vectorization, but the vectorizer can
-detect that ‘sum’ is a reduction variable. The variable ‘sum’ becomes a vector
+detect that 'sum' is a reduction variable. The variable 'sum' becomes a vector
 of integers, and at the end of the loop the elements of the array are added
-together to create the correct result. We support a number of different 
+together to create the correct result. We support a number of different
 reduction operations, such as addition, multiplication, XOR, AND and OR.
 
 .. code-block:: c++
@@ -82,12 +95,12 @@ reduction operations, such as addition, multiplication, XOR, AND and OR.
   int foo(int *A, int *B, int n) {
     unsigned sum = 0;
     for (int i = 0; i < n; ++i)
-        sum += A[i] + 5;
+      sum += A[i] + 5;
     return sum;
   }
 
 Inductions
---------------------------
+^^^^^^^^^^
 
 In this example the value of the induction variable ``i`` is saved into an
 array. The Loop Vectorizer knows to vectorize induction variables.
@@ -95,12 +108,12 @@ array. The Loop Vectorizer knows to vectorize induction variables.
 .. code-block:: c++
 
   void bar(float *A, float* B, float K, int n) {
-   for (int i = 0; i < n; ++i)
-     A[i] = i;
+    for (int i = 0; i < n; ++i)
+      A[i] = i;
   }
 
 If Conversion
---------------------------
+^^^^^^^^^^^^^
 
 The Loop Vectorizer is able to "flatten" the IF statement in the code and
 generate a single stream of instructions. The Loop Vectorizer supports any
@@ -118,7 +131,7 @@ nesting of IFs, ELSEs and even GOTOs.
   }
 
 Pointer Induction Variables
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This example uses the "accumulate" function of the standard c++ library. This
 loop uses C++ iterators, which are pointers, and not integer indices.
@@ -132,7 +145,7 @@ this loop. This feature is important because many C++ programs use iterators.
   }
 
 Reverse Iterators
---------------------------
+^^^^^^^^^^^^^^^^^
 
 The Loop Vectorizer can vectorize loops that count backwards.
 
@@ -144,20 +157,20 @@ The Loop Vectorizer can vectorize loops that count backwards.
   }
 
 Scatter / Gather
---------------------------
+^^^^^^^^^^^^^^^^
 
-The Loop Vectorizer can generate code diverging memory indices that result in
-scatter/gather memory accesses.
+The Loop Vectorizer can vectorize code that becomes scatter/gather
+memory accesses.
 
 .. code-block:: c++
 
   int foo(int *A, int *B, int n, int k) {
-  for (int i = 0; i < n; ++i)
+    for (int i = 0; i < n; ++i)
       A[i*7] += B[i*k];
   }
 
-Vectorization of programs with Mixed Types
---------------------------
+Vectorization of Mixed Types
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The Loop Vectorizer can vectorize programs with mixed types. The Vectorizer
 cost model can estimate the cost of the type conversion and decide if
@@ -166,12 +179,12 @@ vectorization is profitable.
 .. code-block:: c++
 
   int foo(int *A, char *B, int n, int k) {
-  for (int i = 0; i < n; ++i)
+    for (int i = 0; i < n; ++i)
       A[i] += 4 * B[i];
   }
 
 Vectorization of function calls
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The Loop Vectorize can vectorize intrinsic math functions.
 See the table below for a list of these functions.
@@ -187,22 +200,45 @@ See the table below for a list of these functions.
 +-----+-----+---------+
 |fma  |trunc|nearbyint|
 +-----+-----+---------+
+|     |     | fmuladd |
++-----+-----+---------+
+
+Performance
+-----------
+
+This section shows the the execution time of Clang on a simple benchmark:
+`gcc-loops <http://llvm.org/viewvc/llvm-project/test-suite/trunk/SingleSource/UnitTests/Vectorizer/>`_.
+This benchmarks is a collection of loops from the GCC autovectorization
+`page <http://gcc.gnu.org/projects/tree-ssa/vectorization.html>`_ by Dorit Nuzman.
+
+The chart below compares GCC-4.7, ICC-13, and Clang-SVN with and without loop vectorization at -O3, tuned for "corei7-avx", running on a Sandybridge iMac.
+The Y-axis shows the time in msec. Lower is better. The last column shows the geomean of all the kernels.
+
+.. image:: gcc-loops.png
+
+.. _bb-vectorizer:
 
 The Basic Block Vectorizer
 ==========================
 
+Usage
+------
+
 The Basic Block Vectorizer is not enabled by default, but it can be enabled
 through clang using the command line flag:
 
 .. code-block:: console
 
-   $ clang -fslp-vectorize file.c 
+   $ clang -fslp-vectorize file.c
+
+Details
+-------
 
 The goal of basic-block vectorization (a.k.a. superword-level parallelism) is
 to combine similar independent instructions within simple control-flow regions
 into vector instructions. Memory accesses, arithemetic operations, comparison
 operations and some math functions can all be vectorized using this technique
-(subject to the capabilities of the target architecture). 
+(subject to the capabilities of the target architecture).
 
 For example, the following function performs very similar operations on its
 inputs (a1, b1) and (a2, b2). The basic-block vectorizer may combine these