include/llvm/Transforms/Vectorize.h

   1 //===-- Vectorize.h - Vectorization Transformations -------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This header file defines prototypes for accessor functions that expose passes
  10 // in the Vectorize transformations library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TRANSFORMS_VECTORIZE_H
  15 #define LLVM_TRANSFORMS_VECTORIZE_H
  16
  17 namespace llvm {
  18 class BasicBlock;
  19 class BasicBlockPass;
  20 class Pass;
  21
  22 //===----------------------------------------------------------------------===//
  23 /// Vectorize configuration.
  24 struct VectorizeConfig {
  25   //===--------------------------------------------------------------------===//
  26   // Target architecture related parameters
  27
  28   /// The size of the native vector registers.
  29   unsigned VectorBits;
  30
  31   /// Vectorize boolean values.
  32   bool VectorizeBools;
  33
  34   /// Vectorize integer values.
  35   bool VectorizeInts;
  36
  37   /// Vectorize floating-point values.
  38   bool VectorizeFloats;
  39
  40   /// Vectorize pointer values.
  41   bool VectorizePointers;
  42
  43   /// Vectorize casting (conversion) operations.
  44   bool VectorizeCasts;
  45
  46   /// Vectorize floating-point math intrinsics.
  47   bool VectorizeMath;
  48
  49   /// Vectorize bit intrinsics.
  50   bool VectorizeBitManipulations;
  51
  52   /// Vectorize the fused-multiply-add intrinsic.
  53   bool VectorizeFMA;
  54
  55   /// Vectorize select instructions.
  56   bool VectorizeSelect;
  57
  58   /// Vectorize comparison instructions.
  59   bool VectorizeCmp;
  60
  61   /// Vectorize getelementptr instructions.
  62   bool VectorizeGEP;
  63
  64   /// Vectorize loads and stores.
  65   bool VectorizeMemOps;
  66
  67   /// Only generate aligned loads and stores.
  68   bool AlignedOnly;
  69
  70   //===--------------------------------------------------------------------===//
  71   // Misc parameters
  72
  73   /// The required chain depth for vectorization.
  74   unsigned ReqChainDepth;
  75
  76   /// The maximum search distance for instruction pairs.
  77   unsigned SearchLimit;
  78
  79   /// The maximum number of candidate pairs with which to use a full
  80   ///        cycle check.
  81   unsigned MaxCandPairsForCycleCheck;
  82
  83   /// Replicating one element to a pair breaks the chain.
  84   bool SplatBreaksChain;
  85
  86   /// The maximum number of pairable instructions per group.
  87   unsigned MaxInsts;
  88
  89   /// The maximum number of candidate instruction pairs per group.
  90   unsigned MaxPairs;
  91
  92   /// The maximum number of pairing iterations.
  93   unsigned MaxIter;
  94
  95   /// Don't try to form odd-length vectors.
  96   bool Pow2LenOnly;
  97
  98   /// Don't boost the chain-depth contribution of loads and stores.
  99   bool NoMemOpBoost;
 100
 101   /// Use a fast instruction dependency analysis.
 102   bool FastDep;
 103
 104   /// Initialize the VectorizeConfig from command line options.
 105   VectorizeConfig();
 106 };
 107
 108 //===----------------------------------------------------------------------===//
 109 //
 110 // LoopVectorize - Create a loop vectorization pass.
 111 //
 112 Pass *createLoopVectorizePass(bool InterleaveOnlyWhenForced = false,
 113                               bool VectorizeOnlyWhenForced = false);
 114
 115 //===----------------------------------------------------------------------===//
 116 //
 117 // SLPVectorizer - Create a bottom-up SLP vectorizer pass.
 118 //
 119 Pass *createSLPVectorizerPass();
 120
 121 //===----------------------------------------------------------------------===//
 122 /// Vectorize the BasicBlock.
 123 ///
 124 /// @param BB The BasicBlock to be vectorized
 125 /// @param P  The current running pass, should require AliasAnalysis and
 126 ///           ScalarEvolution. After the vectorization, AliasAnalysis,
 127 ///           ScalarEvolution and CFG are preserved.
 128 ///
 129 /// @return True if the BB is changed, false otherwise.
 130 ///
 131 bool vectorizeBasicBlock(Pass *P, BasicBlock &BB,
 132                          const VectorizeConfig &C = VectorizeConfig());
 133
 134 //===----------------------------------------------------------------------===//
 135 //
 136 // LoadStoreVectorizer - Create vector loads and stores, but leave scalar
 137 // operations.
 138 //
 139 Pass *createLoadStoreVectorizerPass();
 140
 141 } // End llvm namespace
 142
 143 #endif