VecUtils.h

Go to the documentation of this file.

//===- VecUtils.h -----------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Collector for SandboxVectorizer related convenience functions that don't
// belong in other classes.
 
#ifndef LLVM_TRANSFORMS_VECTORIZE_SANDBOXVECTORIZER_VECUTILS_H
#define LLVM_TRANSFORMS_VECTORIZE_SANDBOXVECTORIZER_VECUTILS_H
 
#include "llvm/ADT/DenseSet.h"
#include "llvm/Analysis/ScalarEvolution.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/SandboxIR/Type.h"
#include "llvm/SandboxIR/Utils.h"
#include "llvm/Support/Compiler.h"
#include <iterator>
 
namespace llvm {
/// Traits for DenseMap.
template <> struct DenseMapInfo<SmallVector<sandboxir::Value *>> {
  static unsigned getHashValue(const SmallVector<sandboxir::Value *> &Vec) {
    return hash_combine_range(Vec);
  }
  static bool isEqual(const SmallVector<sandboxir::Value *> &Vec1,
                      const SmallVector<sandboxir::Value *> &Vec2) {
    return Vec1 == Vec2;
  }
};
 
namespace sandboxir {
 
class InstrMaps;
 
using BundleTy = SmallVector<Value *, 4>;
 
class VecUtils {
public:
  /// \Returns the number of elements in \p Ty. That is the number of lanes if a
  /// fixed vector or 1 if scalar. ScalableVectors have unknown size and
  /// therefore are unsupported.
  static int getNumElements(Type *Ty) {
    assert(!isa<ScalableVectorType>(Ty));
    return Ty->isVectorTy() ? cast<FixedVectorType>(Ty)->getNumElements() : 1;
  }
  /// Returns \p Ty if scalar or its element type if vector.
  static Type *getElementType(Type *Ty) {
    return Ty->isVectorTy() ? cast<FixedVectorType>(Ty)->getElementType() : Ty;
  }
 
  /// \Returns true if \p I1 and \p I2 are load/stores accessing consecutive
  /// memory addresses.
  template <typename LoadOrStoreT>
  static bool areConsecutive(LoadOrStoreT *I1, LoadOrStoreT *I2,
                             ScalarEvolution &SE, const DataLayout &DL) {
    static_assert(std::is_same<LoadOrStoreT, LoadInst>::value ||
                      std::is_same<LoadOrStoreT, StoreInst>::value,
                  "Expected Load or Store!");
    auto Diff = Utils::getPointerDiffInBytes(I1, I2, SE);
    if (!Diff)
      return false;
    int ElmBytes = Utils::getNumBits(I1) / 8;
    return *Diff == ElmBytes;
  }
 
  template <typename LoadOrStoreT, typename ValT>
  static bool areConsecutive(ArrayRef<ValT *> Bndl, ScalarEvolution &SE,
                             const DataLayout &DL) {
    static_assert(std::is_same<LoadOrStoreT, LoadInst>::value ||
                      std::is_same<LoadOrStoreT, StoreInst>::value,
                  "Expected Load or Store!");
    assert(isa<LoadOrStoreT>(Bndl[0]) && "Expected Load or Store!");
    auto *LastLS = cast<LoadOrStoreT>(Bndl[0]);
    for (Value *V : drop_begin(Bndl)) {
      assert(isa<LoadOrStoreT>(V) &&
             "Unimplemented: we only support StoreInst!");
      auto *LS = cast<LoadOrStoreT>(V);
      if (!VecUtils::areConsecutive(LastLS, LS, SE, DL))
        return false;
      LastLS = LS;
    }
    return true;
  }
 
  /// \Returns the number of vector lanes of \p Ty or 1 if not a vector.
  /// NOTE: It asserts that \p Ty is a fixed vector type.
  static unsigned getNumLanes(Type *Ty) {
    assert(!isa<ScalableVectorType>(Ty) && "Expect scalar or fixed vector");
    if (auto *FixedVecTy = dyn_cast<FixedVectorType>(Ty))
      return FixedVecTy->getNumElements();
    return 1u;
  }
 
  /// \Returns the expected vector lanes of \p V or 1 if not a vector.
  /// NOTE: It asserts that \p V is a fixed vector.
  static unsigned getNumLanes(Value *V) {
    return VecUtils::getNumLanes(Utils::getExpectedType(V));
  }
 
  /// \Returns the total number of lanes across all values in \p Bndl.
  static unsigned getNumLanes(ArrayRef<Value *> Bndl) {
    unsigned Lanes = 0;
    for (Value *V : Bndl)
      Lanes += getNumLanes(V);
    return Lanes;
  }
 
  /// \Returns <NumElts x ElemTy>.
  /// It works for both scalar and vector \p ElemTy.
  static Type *getWideType(Type *ElemTy, unsigned NumElts) {
    if (ElemTy->isVectorTy()) {
      auto *VecTy = cast<FixedVectorType>(ElemTy);
      ElemTy = VecTy->getElementType();
      NumElts = VecTy->getNumElements() * NumElts;
    }
    return FixedVectorType::get(ElemTy, NumElts);
  }
  /// \Returns the combined vector type for \p Bndl, even when the element types
  /// differ. For example: i8,i8,i16 will return <4 x i8>. \Returns null if
  /// types are of mixed float/integer types.
  static Type *getCombinedVectorTypeFor(ArrayRef<Instruction *> Bndl,
                                        const DataLayout &DL) {
    assert(!Bndl.empty() && "Expected non-empty Bndl!");
    unsigned TotalBits = 0;
    unsigned MinElmBits = std::numeric_limits<unsigned>::max();
    Type *MinElmTy = nullptr;
    for (auto [Idx, V] : enumerate(Bndl)) {
      Type *ElmTy = getElementType(Utils::getExpectedType(V));
 
      unsigned ElmBits = Utils::getNumBits(ElmTy, DL);
      TotalBits += ElmBits * VecUtils::getNumLanes(V);
      if (ElmBits < MinElmBits) {
        MinElmBits = ElmBits;
        MinElmTy = ElmTy;
      }
    }
    unsigned NumElms = TotalBits / MinElmBits;
    return FixedVectorType::get(MinElmTy, NumElms);
  }
  /// \Returns the instruction in \p Instrs that is lowest in the BB. Expects
  /// that all instructions are in the same BB.
  static Instruction *getLowest(ArrayRef<Instruction *> Instrs) {
    Instruction *LowestI = Instrs.front();
    for (auto *I : drop_begin(Instrs)) {
      if (LowestI->comesBefore(I))
        LowestI = I;
    }
    return LowestI;
  }
  /// \Returns the instruction in \p Instrs that is highest in the BB. Expects
  /// that all instructions are in the same BB.
  static Instruction *getHighest(ArrayRef<Instruction *> Instrs) {
    Instruction *HighestI = Instrs.front();
    for (auto *I : drop_begin(Instrs)) {
      if (I->comesBefore(HighestI))
        HighestI = I;
    }
    return HighestI;
  }
  /// \Returns the lowest instruction in \p Vals, or nullptr if no instructions
  /// are found. Skips instructions not in \p BB.
  static Instruction *getLowest(ArrayRef<Value *> Vals, BasicBlock *BB) {
    // Find the first Instruction in Vals that is also in `BB`.
    auto It = find_if(Vals, [BB](Value *V) {
      return isa<Instruction>(V) && cast<Instruction>(V)->getParent() == BB;
    });
    // If we couldn't find an instruction return nullptr.
    if (It == Vals.end())
      return nullptr;
    Instruction *FirstI = cast<Instruction>(*It);
    // Now look for the lowest instruction in Vals starting from one position
    // after FirstI.
    Instruction *LowestI = FirstI;
    for (auto *V : make_range(std::next(It), Vals.end())) {
      auto *I = dyn_cast<Instruction>(V);
      // Skip non-instructions.
      if (I == nullptr)
        continue;
      // Skips instructions not in \p BB.
      if (I->getParent() != BB)
        continue;
      // If `LowestI` comes before `I` then `I` is the new lowest.
      if (LowestI->comesBefore(I))
        LowestI = I;
    }
    return LowestI;
  }
 
  /// If \p I is not a PHI it returns it. Else it walks down the instruction
  /// chain looking for the last PHI and returns it. \Returns nullptr if \p I is
  /// nullptr.
  static Instruction *getLastPHIOrSelf(Instruction *I) {
    Instruction *LastI = I;
    while (I != nullptr && isa<PHINode>(I)) {
      LastI = I;
      I = I->getNextNode();
    }
    return LastI;
  }
 
  /// \Returns the BB iterator after the lowest instruction in \p Vals
  /// (skipping instructions not in \p BB), or the top of BB if no
  /// instruction found in \p Vals.
  static BasicBlock::iterator getInsertPointAfterInstrs(ArrayRef<Value *> Vals,
                                                        BasicBlock *BB) {
    auto *BotI = getLastPHIOrSelf(getLowest(Vals, BB));
    if (BotI == nullptr)
      // We are using BB->begin() (or after PHIs) as the fallback insert point.
      return BB->empty()
                 ? BB->begin()
                 : std::next(getLastPHIOrSelf(&*BB->begin())->getIterator());
    return std::next(BotI->getIterator());
  }
 
  /// If all values in \p Bndl are of the same scalar type then return it,
  /// otherwise return nullptr.
  static Type *tryGetCommonScalarType(ArrayRef<Value *> Bndl) {
    Value *V0 = Bndl[0];
    Type *Ty0 = Utils::getExpectedType(V0);
    Type *ScalarTy = VecUtils::getElementType(Ty0);
    for (auto *V : drop_begin(Bndl)) {
      Type *NTy = Utils::getExpectedType(V);
      Type *NScalarTy = VecUtils::getElementType(NTy);
      if (NScalarTy != ScalarTy)
        return nullptr;
    }
    return ScalarTy;
  }
 
  /// Similar to tryGetCommonScalarType() but will assert that there is a common
  /// type. So this is faster in release builds as it won't iterate through the
  /// values.
  static Type *getCommonScalarType(ArrayRef<Value *> Bndl) {
    Value *V0 = Bndl[0];
    Type *Ty0 = Utils::getExpectedType(V0);
    Type *ScalarTy = VecUtils::getElementType(Ty0);
    assert(tryGetCommonScalarType(Bndl) && "Expected common scalar type!");
    return ScalarTy;
  }
  /// \Returns the first integer power of 2 that is <= Num.
  LLVM_ABI static unsigned getFloorPowerOf2(unsigned Num);
 
  /// For each user of lane 0 in \p Bndl, try to form a bundle of matching
  /// users for all lanes. Returns all complete user bundles found.
  /// \p Claimed contains instructions that have already been claimed by a
  /// bundle.
  LLVM_ABI static SmallVector<BundleTy>
  getNextUserBundles(ArrayRef<Value *> Bndl, const InstrMaps &IMaps,
                     SmallPtrSet<Instruction *, 4> &Claimed);
 
  /// Helper struct for `matchPack()`. Describes the instructions and operands
  /// of a pack pattern.
  struct PackPattern {
    /// The insertelement instructions that form the pack pattern in bottom-up
    /// order, i.e., the first instruction in `Instrs` is the bottom-most
    /// InsertElement instruction of the pack pattern.
    /// For example in this simple pack pattern:
    ///  %Pack0 = insertelement <2 x i8> poison, i8 %v0, i64 0
    ///  %Pack1 = insertelement <2 x i8> %Pack0, i8 %v1, i64 1
    /// this is [ %Pack1, %Pack0 ].
    SmallVector<Instruction *> Instrs;
    /// The "external" operands of the pack pattern, i.e., the values that get
    /// packed into a vector, skipping the ones in `Instrs`. The operands are in
    /// bottom-up order, starting from the operands of the bottom-most insert.
    /// So in our example this would be [ %v1, %v0 ].
    SmallVector<Value *> Operands;
  };
 
  /// If \p I is the last instruction of a pack pattern (i.e., an InsertElement
  /// into a vector), then this function returns the instructions in the pack
  /// and the operands in the pack, else returns nullopt.
  /// Here is an example of a matched pattern:
  ///  %PackA0 = insertelement <2 x i8> poison, i8 %v0, i64 0
  ///  %PackA1 = insertelement <2 x i8> %PackA0, i8 %v1, i64 1
  /// TODO: this currently detects only simple canonicalized patterns.
  static std::optional<PackPattern> matchPack(Instruction *I) {
    // TODO: Support vector pack patterns.
    // TODO: Support out-of-order inserts.
 
    // Early return if `I` is not an Insert.
    if (!isa<InsertElementInst>(I))
      return std::nullopt;
    auto *BB0 = I->getParent();
    // The pack contains as many instrs as the lanes of the bottom-most Insert
    unsigned ExpectedNumInserts = VecUtils::getNumLanes(I);
    assert(ExpectedNumInserts >= 2 && "Expected at least 2 inserts!");
    PackPattern Pack;
    Pack.Operands.resize(ExpectedNumInserts);
    // Collect the inserts by walking up the use-def chain.
    Instruction *InsertI = I;
    for (auto ExpectedLane : reverse(seq<unsigned>(ExpectedNumInserts))) {
      if (InsertI == nullptr)
        return std::nullopt;
      if (InsertI->getParent() != BB0)
        return std::nullopt;
      // Check the lane.
      auto *LaneC = dyn_cast<ConstantInt>(InsertI->getOperand(2));
      if (LaneC == nullptr || LaneC->getSExtValue() != ExpectedLane)
        return std::nullopt;
      Pack.Instrs.push_back(InsertI);
      Pack.Operands[ExpectedLane] = InsertI->getOperand(1);
 
      Value *Op = InsertI->getOperand(0);
      if (ExpectedLane == 0) {
        // Check the topmost insert. The operand should be a Poison.
        if (!isa<PoisonValue>(Op))
          return std::nullopt;
      } else {
        InsertI = dyn_cast<InsertElementInst>(Op);
      }
    }
    return Pack;
  }
 
  /// Emits the necessary instruction sequence to extract element of type \p
  /// ExtrTy at \p Lane from \p FromVec. Emits instructions before \p WhereIt.
  /// Returns the extracted value.
  /// Note: This handles both vectors and scalars. In the vector case it
  /// extracts an N-wide element (with N dictated by \p ExtrTy).
  static Value *unpack(Value *FromVec, Type *ExtrTy, unsigned Lane,
                       BasicBlock::iterator WhereIt) {
    assert(isa<FixedVectorType>(FromVec->getType()) && "Expected vector!");
    auto &Ctx = FromVec->getContext();
    if (!ExtrTy->isVectorTy()) {
      // For scalar elements we emit a single ExtractElementInst.
      assert(Lane <
                 cast<FixedVectorType>(FromVec->getType())->getNumElements() &&
             "Out of bounds!");
      assert(ExtrTy ==
                 cast<FixedVectorType>(FromVec->getType())->getElementType() &&
             "Expected same element type!");
      Constant *ExtractLaneC =
          ConstantInt::getSigned(Type::getInt32Ty(Ctx), Lane);
      // Note: This may be folded into a Constant if FromVec is a Constant.
      return ExtractElementInst::create(FromVec, ExtractLaneC, WhereIt, Ctx,
                                        "Unpack");
    }
    // For vector elements we emit a shuffle.
    // For example, extracting lanes 2 and 3 of a <4 x i32> vector %vec:
    //  shufflevector <4 x i32> %vec, <4 x i32> poison, <2 x i32> <i32 2, i32 3>
    auto *VecTy = cast<FixedVectorType>(FromVec->getType());
    auto *ExtrVecTy = cast<FixedVectorType>(ExtrTy);
    assert(ExtrVecTy->getElementType() == VecTy->getElementType() &&
           "Expected same element type!");
    SmallVector<int, 4> Mask;
    for (unsigned Idx = 0, E = ExtrVecTy->getNumElements(); Idx != E; ++Idx) {
      int MaskLane = Lane + Idx;
      assert((unsigned)MaskLane <
                 cast<FixedVectorType>(FromVec->getType())->getNumElements() &&
             "Out of bounds!");
      Mask.push_back(MaskLane);
    }
    return ShuffleVectorInst::create(FromVec, PoisonValue::get(VecTy), Mask,
                                     WhereIt, Ctx, "Unpack");
  }
 
  /// Iterate over all lanes and Value pairs.
  // For example, given a range: {i32 %v0, <2 x i32> %v1, i32 %v2} we get:
  //  Lane Elm
  //   0   %v0
  //   1   %v1
  //   3   %v2
  template <typename RangeIteratorT> class LaneValueEnumerator {
    /// Points to current element.
    RangeIteratorT It;
    RangeIteratorT ItE;
    /// Accumulator of lanes.
    unsigned Lane;
 
  public:
    // Note that We can start counting from a non-zero BeginLane, though the
    // user must make sure it corresponds to the correct lane matching Begin.
    LaneValueEnumerator(RangeIteratorT Begin, RangeIteratorT End,
                        unsigned BeginLane)
        : It(Begin), ItE(End), Lane(BeginLane) {}
    using iterator_catecotry = std::input_iterator_tag;
    // NOTE: dereference returns by value instead of by reference.
    using value_type = std::pair<unsigned, Value *>;
    using difference_type = std::ptrdiff_t;
    using pointer = std::pair<unsigned, Value *> *;
    using reference = std::pair<unsigned, Value *> &;
    LaneValueEnumerator operator++() {
      assert(It != ItE && "Already at end!");
      auto *Ty = Utils::getExpectedType(*It);
      if (auto *VecTy = dyn_cast<FixedVectorType>(Ty)) {
        Lane += VecTy->getNumElements();
      } else {
        assert(!isa<VectorType>(Ty) && "Expected scalar type!");
        Lane += 1;
      }
      ++It;
      return *this;
    }
    value_type operator*() const { return {Lane, *It}; }
    bool operator==(const LaneValueEnumerator &Other) const {
      return It == Other.It;
    }
    bool operator!=(const LaneValueEnumerator &Other) const {
      return !(*this == Other);
    }
  };
 
  /// Utility class to collect and erase dead instructions.
  class DeadInstructionMorgue {
  public:
    DeadInstructionMorgue() = default;
    DeadInstructionMorgue(const DeadInstructionMorgue &) = delete;
 
    /// Record instructions in \p Bndl that may be dead after vectorization.
    /// For load/store bundles, also record non-first-lane pointer operands;
    /// the first lane's pointer is skipped because the vector load/store
    /// reuses it. Erased later by \c tryEraseDeadInstrs().
    template <typename T> void collectPotentiallyDeadInstrs(ArrayRef<T *> Bndl);
 
    /// Erase candidates recorded by \c collectPotentiallyDeadInstrs() that
    /// now have no uses, then clear the candidate set.
    LLVM_ABI void tryEraseDeadInstrs();
 
#ifndef NDEBUG
    void print(raw_ostream &OS) const {
      OS << "DeadInstrCandidates:\n";
      for (auto *I : DeadInstrCandidates)
        OS << *I << '\n';
    }
    LLVM_DUMP_METHOD void debug() const {
      print(dbgs());
      dbgs() << '\n';
    }
#endif /* NDEBUG */
 
  private:
    DenseSet<Instruction *> DeadInstrCandidates;
  };
 
  /// Helper for creating LaneValueEnumerator ranges. Can be used in for loops
  /// like: `for (auto [Lane, V] : enumerateLanes(Range))`
  template <typename ValueContainerT>
  static auto enumerateLanes(const ValueContainerT &Range) {
    auto Begin = LaneValueEnumerator<decltype(Range.begin())>(Range.begin(),
                                                              Range.end(), 0);
    auto End = LaneValueEnumerator<decltype(Range.begin())>(Range.end(),
                                                            Range.end(), 0);
    return make_range(Begin, End);
  }
 
#ifndef NDEBUG
  /// Helper dump function for debugging.
  LLVM_DUMP_METHOD static void dump(ArrayRef<Value *> Bndl);
  LLVM_DUMP_METHOD static void dump(ArrayRef<Instruction *> Bndl);
#endif // NDEBUG
};
 
/// An ArrayRef of Values or Instructions that we can print/dump for debugging.
/// It is mainly used for the vectorizer's instr/value bundles.
template <typename T> class BndlRef : public ArrayRef<T> {
public:
  // Inherit constructors.
  using ArrayRef<T>::ArrayRef;
 
#ifndef NDEBUG
  /// Helper dump function for debugging.
  void print(raw_ostream &OS) const {
    for (const auto &[Idx, Val] : enumerate(*this))
      OS << Idx << ". " << *Val << "\n";
  }
  LLVM_DUMP_METHOD void dump() const;
#endif // NDEBUG
};
 
/// @name BndlRef Deduction guides
/// @{
/// Deduction guide to construct a BndlRef from a single element.
template <typename T> BndlRef(const T &OneElt) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a pointer and length
template <typename T> BndlRef(const T *data, size_t length) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a range
template <typename T> BndlRef(const T *data, const T *end) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a SmallVector
template <typename T> BndlRef(const SmallVectorImpl<T> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a SmallVector
template <typename T, unsigned N>
BndlRef(const SmallVector<T, N> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a std::vector
template <typename T> BndlRef(const std::vector<T> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a std::array
template <typename T, std::size_t N>
BndlRef(const std::array<T, N> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from an BndlRef (const)
template <typename T> BndlRef(const BndlRef<T> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from an BndlRef
template <typename T> BndlRef(BndlRef<T> &Vec) -> BndlRef<T>;
/// Deduction guide to construct a BndlRef from a C array.
template <typename T, size_t N> BndlRef(const T (&Arr)[N]) -> BndlRef<T>;
/// @}
 
} // namespace sandboxir
 
} // namespace llvm
 
#endif // LLVM_TRANSFORMS_VECTORIZE_SANDBOXVECTORIZER_VECUTILS_H