AArch64PostLegalizerLowering.cpp

Go to the documentation of this file.

//=== AArch64PostLegalizerLowering.cpp --------------------------*- 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
//
//===----------------------------------------------------------------------===//
///
/// \file
/// Post-legalization lowering for instructions.
///
/// This is used to offload pattern matching from the selector.
///
/// For example, this combiner will notice that a G_SHUFFLE_VECTOR is actually
/// a G_ZIP, G_UZP, etc.
///
/// General optimization combines should be handled by either the
/// AArch64PostLegalizerCombiner or the AArch64PreLegalizerCombiner.
///
//===----------------------------------------------------------------------===//
 
#include "AArch64.h"
#include "AArch64ExpandImm.h"
#include "AArch64GlobalISelUtils.h"
#include "AArch64PerfectShuffle.h"
#include "AArch64Subtarget.h"
#include "GISel/AArch64LegalizerInfo.h"
#include "MCTargetDesc/AArch64MCTargetDesc.h"
#include "Utils/AArch64BaseInfo.h"
#include "llvm/CodeGen/GlobalISel/Combiner.h"
#include "llvm/CodeGen/GlobalISel/CombinerHelper.h"
#include "llvm/CodeGen/GlobalISel/CombinerInfo.h"
#include "llvm/CodeGen/GlobalISel/GIMatchTableExecutorImpl.h"
#include "llvm/CodeGen/GlobalISel/GISelChangeObserver.h"
#include "llvm/CodeGen/GlobalISel/GenericMachineInstrs.h"
#include "llvm/CodeGen/GlobalISel/LegalizerHelper.h"
#include "llvm/CodeGen/GlobalISel/MIPatternMatch.h"
#include "llvm/CodeGen/GlobalISel/MachineIRBuilder.h"
#include "llvm/CodeGen/GlobalISel/Utils.h"
#include "llvm/CodeGen/MachineFrameInfo.h"
#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/CodeGen/MachineInstrBuilder.h"
#include "llvm/CodeGen/MachinePassManager.h"
#include "llvm/CodeGen/MachineRegisterInfo.h"
#include "llvm/CodeGen/TargetOpcodes.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/Support/ErrorHandling.h"
#include <optional>
 
#define GET_GICOMBINER_DEPS
#include "AArch64GenPostLegalizeGILowering.inc"
#undef GET_GICOMBINER_DEPS
 
#define DEBUG_TYPE "aarch64-postlegalizer-lowering"
 
using namespace llvm;
using namespace MIPatternMatch;
using namespace AArch64GISelUtils;
 
#define GET_GICOMBINER_TYPES
#include "AArch64GenPostLegalizeGILowering.inc"
#undef GET_GICOMBINER_TYPES
 
namespace {
 
/// Represents a pseudo instruction which replaces a G_SHUFFLE_VECTOR.
///
/// Used for matching target-supported shuffles before codegen.
struct ShuffleVectorPseudo {
  unsigned Opc;                 ///< Opcode for the instruction. (E.g. G_ZIP1)
  Register Dst;                 ///< Destination register.
  SmallVector<SrcOp, 2> SrcOps; ///< Source registers.
  ShuffleVectorPseudo(unsigned Opc, Register Dst,
                      std::initializer_list<SrcOp> SrcOps)
      : Opc(Opc), Dst(Dst), SrcOps(SrcOps){};
  ShuffleVectorPseudo() = default;
};
 
/// Helper function for matchINS.
///
/// \returns a value when \p M is an ins mask for \p NumInputElements.
///
/// First element of the returned pair is true when the produced
/// G_INSERT_VECTOR_ELT destination should be the LHS of the G_SHUFFLE_VECTOR.
///
/// Second element is the destination lane for the G_INSERT_VECTOR_ELT.
std::optional<std::pair<bool, int>> isINSMask(ArrayRef<int> M,
                                              int NumInputElements) {
  if (M.size() != static_cast<size_t>(NumInputElements))
    return std::nullopt;
  int NumLHSMatch = 0, NumRHSMatch = 0;
  int LastLHSMismatch = -1, LastRHSMismatch = -1;
  for (int Idx = 0; Idx < NumInputElements; ++Idx) {
    if (M[Idx] == -1) {
      ++NumLHSMatch;
      ++NumRHSMatch;
      continue;
    }
    M[Idx] == Idx ? ++NumLHSMatch : LastLHSMismatch = Idx;
    M[Idx] == Idx + NumInputElements ? ++NumRHSMatch : LastRHSMismatch = Idx;
  }
  const int NumNeededToMatch = NumInputElements - 1;
  if (NumLHSMatch == NumNeededToMatch)
    return std::make_pair(true, LastLHSMismatch);
  if (NumRHSMatch == NumNeededToMatch)
    return std::make_pair(false, LastRHSMismatch);
  return std::nullopt;
}
 
/// \return true if a G_SHUFFLE_VECTOR instruction \p MI can be replaced with a
/// G_REV instruction. Returns the appropriate G_REV opcode in \p Opc.
bool matchREV(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  ArrayRef<int> ShuffleMask = MI.getOperand(3).getShuffleMask();
  Register Dst = MI.getOperand(0).getReg();
  Register Src = MI.getOperand(1).getReg();
  LLT Ty = MRI.getType(Dst);
  unsigned EltSize = Ty.getScalarSizeInBits();
 
  // Element size for a rev cannot be 64.
  if (EltSize == 64)
    return false;
 
  unsigned NumElts = Ty.getNumElements();
 
  // Try to produce a G_REV instruction
  for (unsigned LaneSize : {64U, 32U, 16U}) {
    if (isREVMask(ShuffleMask, EltSize, NumElts, LaneSize)) {
      unsigned Opcode;
      if (LaneSize == 64U)
        Opcode = AArch64::G_REV64;
      else if (LaneSize == 32U)
        Opcode = AArch64::G_REV32;
      else
        Opcode = AArch64::G_BSWAP;
 
      MatchInfo = ShuffleVectorPseudo(Opcode, Dst, {Src});
      return true;
    }
  }
 
  return false;
}
 
/// \return true if a G_SHUFFLE_VECTOR instruction \p MI can be replaced with
/// a G_TRN1 or G_TRN2 instruction.
bool matchTRN(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  unsigned WhichResult;
  unsigned OperandOrder = 0;
  ArrayRef<int> ShuffleMask = MI.getOperand(3).getShuffleMask();
  Register Dst = MI.getOperand(0).getReg();
  unsigned NumElts = MRI.getType(Dst).getNumElements();
  bool TRNMask = isTRNMask(ShuffleMask, NumElts, WhichResult, OperandOrder);
  if (!TRNMask && !isTRN_v_undef_Mask(ShuffleMask, NumElts, WhichResult))
    return false;
  unsigned Opc = (WhichResult == 0) ? AArch64::G_TRN1 : AArch64::G_TRN2;
  Register V1 = MI.getOperand(OperandOrder == 0 ? 1 : 2).getReg();
  Register V2 = MI.getOperand(OperandOrder == 0 && TRNMask ? 2 : 1).getReg();
  MatchInfo = ShuffleVectorPseudo(Opc, Dst, {V1, V2});
  return true;
}
 
/// \return true if a G_SHUFFLE_VECTOR instruction \p MI can be replaced with
/// a G_UZP1 or G_UZP2 instruction.
///
/// \param [in] MI - The shuffle vector instruction.
/// \param [out] MatchInfo - Either G_UZP1 or G_UZP2 on success.
bool matchUZP(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  unsigned WhichResult;
  ArrayRef<int> ShuffleMask = MI.getOperand(3).getShuffleMask();
  Register Dst = MI.getOperand(0).getReg();
  unsigned NumElts = MRI.getType(Dst).getNumElements();
  bool UZPMask = isUZPMask(ShuffleMask, NumElts, WhichResult);
  if (!UZPMask && !isUZP_v_undef_Mask(ShuffleMask, NumElts, WhichResult))
    return false;
  unsigned Opc = (WhichResult == 0) ? AArch64::G_UZP1 : AArch64::G_UZP2;
  Register V1 = MI.getOperand(1).getReg();
  Register V2 = MI.getOperand(UZPMask ? 2 : 1).getReg();
  MatchInfo = ShuffleVectorPseudo(Opc, Dst, {V1, V2});
  return true;
}
 
bool matchZip(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  unsigned WhichResult;
  unsigned OperandOrder = 0;
  ArrayRef<int> ShuffleMask = MI.getOperand(3).getShuffleMask();
  Register Dst = MI.getOperand(0).getReg();
  unsigned NumElts = MRI.getType(Dst).getNumElements();
  bool ZIPMask = isZIPMask(ShuffleMask, NumElts, WhichResult, OperandOrder);
  if (!ZIPMask && !isZIP_v_undef_Mask(ShuffleMask, NumElts, WhichResult))
    return false;
  unsigned Opc = (WhichResult == 0) ? AArch64::G_ZIP1 : AArch64::G_ZIP2;
  Register V1 = MI.getOperand(OperandOrder == 0 ? 1 : 2).getReg();
  Register V2 = MI.getOperand(OperandOrder == 0 && ZIPMask ? 2 : 1).getReg();
  MatchInfo = ShuffleVectorPseudo(Opc, Dst, {V1, V2});
  return true;
}
 
/// Helper function for matchDup.
bool matchDupFromInsertVectorElt(int Lane, MachineInstr &MI,
                                 MachineRegisterInfo &MRI,
                                 ShuffleVectorPseudo &MatchInfo) {
  if (Lane != 0)
    return false;
 
  // Try to match a vector splat operation into a dup instruction.
  // We're looking for this pattern:
  //
  // %scalar:gpr(s64) = COPY $x0
  // %undef:fpr(<2 x s64>) = G_IMPLICIT_DEF
  // %cst0:gpr(s32) = G_CONSTANT i32 0
  // %zerovec:fpr(<2 x s32>) = G_BUILD_VECTOR %cst0(s32), %cst0(s32)
  // %ins:fpr(<2 x s64>) = G_INSERT_VECTOR_ELT %undef, %scalar(s64), %cst0(s32)
  // %splat:fpr(<2 x s64>) = G_SHUFFLE_VECTOR %ins(<2 x s64>), %undef,
  // %zerovec(<2 x s32>)
  //
  // ...into:
  // %splat = G_SPLAT_VECTOR %scalar
 
  // Begin matching the insert.
  auto *InsMI = getOpcodeDef(TargetOpcode::G_INSERT_VECTOR_ELT,
                             MI.getOperand(1).getReg(), MRI);
  if (!InsMI)
    return false;
  // Match the undef vector operand.
  if (!getOpcodeDef(TargetOpcode::G_IMPLICIT_DEF, InsMI->getOperand(1).getReg(),
                    MRI))
    return false;
 
  // Match the index constant 0.
  if (!mi_match(InsMI->getOperand(3).getReg(), MRI, m_ZeroInt()))
    return false;
 
  MatchInfo = ShuffleVectorPseudo(TargetOpcode::G_SPLAT_VECTOR,
                                  MI.getOperand(0).getReg(),
                                  {InsMI->getOperand(2).getReg()});
  return true;
}
 
/// Helper function for matchDup.
bool matchDupFromBuildVector(int Lane, MachineInstr &MI,
                             MachineRegisterInfo &MRI,
                             ShuffleVectorPseudo &MatchInfo) {
  assert(Lane >= 0 && "Expected positive lane?");
  int NumElements = MRI.getType(MI.getOperand(1).getReg()).getNumElements();
  // Test if the LHS is a BUILD_VECTOR. If it is, then we can just reference the
  // lane's definition directly.
  auto *BuildVecMI =
      getOpcodeDef(TargetOpcode::G_BUILD_VECTOR,
                   MI.getOperand(Lane < NumElements ? 1 : 2).getReg(), MRI);
  // If Lane >= NumElements then it is point to RHS, just check from RHS
  if (NumElements <= Lane)
    Lane -= NumElements;
 
  if (!BuildVecMI)
    return false;
  Register Reg = BuildVecMI->getOperand(Lane + 1).getReg();
  MatchInfo = ShuffleVectorPseudo(TargetOpcode::G_SPLAT_VECTOR,
                                  MI.getOperand(0).getReg(), {Reg});
  return true;
}
 
bool matchDup(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  auto MaybeLane = getSplatIndex(MI);
  if (!MaybeLane)
    return false;
  int Lane = *MaybeLane;
  // If this is undef splat, generate it via "just" vdup, if possible.
  if (Lane < 0)
    Lane = 0;
  if (matchDupFromInsertVectorElt(Lane, MI, MRI, MatchInfo))
    return true;
  if (matchDupFromBuildVector(Lane, MI, MRI, MatchInfo))
    return true;
  return false;
}
 
bool matchEXT(MachineInstr &MI, MachineRegisterInfo &MRI,
              ShuffleVectorPseudo &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  Register Dst = MI.getOperand(0).getReg();
  LLT DstTy = MRI.getType(Dst);
  Register V1 = MI.getOperand(1).getReg();
  Register V2 = MI.getOperand(2).getReg();
  auto Mask = MI.getOperand(3).getShuffleMask();
  uint64_t ExtFactor = MRI.getType(V1).getScalarSizeInBits() / 8;
 
  unsigned Imm;
  bool ReverseExt;
  if (isEXTMask(Mask, DstTy.getNumElements(), ReverseExt, Imm)) {
    if (ReverseExt)
      std::swap(V1, V2);
    Imm *= ExtFactor;
    MatchInfo = ShuffleVectorPseudo(AArch64::G_EXT, Dst,
                                    {V1, V2, static_cast<uint64_t>(Imm)});
    return true;
  }
 
  if (!getOpcodeDef<GImplicitDef>(V2, MRI) ||
      !isSingletonEXTMask(Mask, DstTy.getNumElements(), Imm))
    return false;
 
  Imm = Mask[0] * ExtFactor;
  MatchInfo = ShuffleVectorPseudo(AArch64::G_EXT, Dst,
                                  {V1, V1, static_cast<uint64_t>(Imm)});
  return true;
}
 
/// Replace a G_SHUFFLE_VECTOR instruction with a pseudo.
/// \p Opc is the opcode to use. \p MI is the G_SHUFFLE_VECTOR.
void applyShuffleVectorPseudo(MachineInstr &MI, MachineRegisterInfo &MRI,
                              ShuffleVectorPseudo &MatchInfo) {
  MachineIRBuilder MIRBuilder(MI);
  if (MatchInfo.Opc == TargetOpcode::G_BSWAP) {
    assert(MatchInfo.SrcOps.size() == 1);
    LLT DstTy = MRI.getType(MatchInfo.Dst);
    assert(DstTy == LLT::fixed_vector(8, 8) ||
           DstTy == LLT::fixed_vector(16, 8));
    LLT BSTy = DstTy == LLT::fixed_vector(8, 8)
                   ? LLT::fixed_vector(4, LLT::integer(16))
                   : LLT::fixed_vector(8, LLT::integer(16));
    // FIXME: NVCAST
    auto BS1 = MIRBuilder.buildInstr(TargetOpcode::G_BITCAST, {BSTy},
                                     MatchInfo.SrcOps[0]);
    auto BS2 = MIRBuilder.buildInstr(MatchInfo.Opc, {BSTy}, {BS1});
    MIRBuilder.buildInstr(TargetOpcode::G_BITCAST, {MatchInfo.Dst}, {BS2});
  } else
    MIRBuilder.buildInstr(MatchInfo.Opc, {MatchInfo.Dst}, MatchInfo.SrcOps);
  MI.eraseFromParent();
}
 
/// Replace a G_SHUFFLE_VECTOR instruction with G_EXT.
/// Special-cased because the constant operand must be emitted as a G_CONSTANT
/// for the imported tablegen patterns to work.
void applyEXT(MachineInstr &MI, ShuffleVectorPseudo &MatchInfo) {
  MachineIRBuilder MIRBuilder(MI);
  if (MatchInfo.SrcOps[2].getImm() == 0)
    MIRBuilder.buildCopy(MatchInfo.Dst, MatchInfo.SrcOps[0]);
  else {
    // Tablegen patterns expect an i32 G_CONSTANT as the final op.
    auto Cst = MIRBuilder.buildConstant(LLT::integer(32),
                                        MatchInfo.SrcOps[2].getImm());
    MIRBuilder.buildInstr(MatchInfo.Opc, {MatchInfo.Dst},
                          {MatchInfo.SrcOps[0], MatchInfo.SrcOps[1], Cst});
  }
  MI.eraseFromParent();
}
 
static bool preferTBLToMultiInstrShuffle(MachineBasicBlock *MBB) {
  if (MBB->getParent()->getFunction().hasOptSize())
    return false;
  // Look for a simple single block loop.
  return is_contained(successors(MBB), MBB);
}
 
bool matchFullRev(MachineInstr &MI, MachineRegisterInfo &MRI) {
  if (preferTBLToMultiInstrShuffle(MI.getParent()))
    return false;
 
  auto &Shuf = cast<GShuffleVector>(MI);
  ArrayRef<int> Mask = Shuf.getMask();
  return mi_match(Shuf.getSrc2Reg(), MRI, m_GImplicitDef()) &&
         ShuffleVectorInst::isReverseMask(Mask, Mask.size());
}
 
void applyFullRev(MachineInstr &MI, MachineRegisterInfo &MRI) {
  Register Dst = MI.getOperand(0).getReg();
  Register Src = MI.getOperand(1).getReg();
  LLT DstTy = MRI.getType(Dst);
  assert(DstTy.getSizeInBits() == 128 &&
         "Expected 128bit vector in applyFullRev");
  MachineIRBuilder MIRBuilder(MI);
  auto Cst = MIRBuilder.buildConstant(LLT::integer(32), 8);
  auto Rev = MIRBuilder.buildInstr(AArch64::G_REV64, {DstTy}, {Src});
  MIRBuilder.buildInstr(AArch64::G_EXT, {Dst}, {Rev, Rev, Cst});
  MI.eraseFromParent();
}
 
bool matchNonConstInsert(MachineInstr &MI, MachineRegisterInfo &MRI) {
  assert(MI.getOpcode() == TargetOpcode::G_INSERT_VECTOR_ELT);
 
  auto ValAndVReg =
      getIConstantVRegValWithLookThrough(MI.getOperand(3).getReg(), MRI);
  return !ValAndVReg;
}
 
void applyNonConstInsert(MachineInstr &MI, MachineRegisterInfo &MRI,
                         MachineIRBuilder &Builder) {
  auto &Insert = cast<GInsertVectorElement>(MI);
  Builder.setInstrAndDebugLoc(Insert);
 
  Register Offset = Insert.getIndexReg();
  LLT VecTy = MRI.getType(Insert.getReg(0));
  LLT EltTy = MRI.getType(Insert.getElementReg());
  LLT IdxTy = MRI.getType(Insert.getIndexReg());
 
  if (VecTy.isScalableVector())
    return;
 
  // Create a stack slot and store the vector into it
  MachineFunction &MF = Builder.getMF();
  Align Alignment(
      std::min<uint64_t>(VecTy.getSizeInBytes().getKnownMinValue(), 16));
  int FrameIdx = MF.getFrameInfo().CreateStackObject(VecTy.getSizeInBytes(),
                                                     Alignment, false);
  LLT FramePtrTy = LLT::pointer(0, 64);
  MachinePointerInfo PtrInfo = MachinePointerInfo::getFixedStack(MF, FrameIdx);
  auto StackTemp = Builder.buildFrameIndex(FramePtrTy, FrameIdx);
 
  Builder.buildStore(Insert.getOperand(1), StackTemp, PtrInfo, Align(8));
 
  // Get the pointer to the element, and be sure not to hit undefined behavior
  // if the index is out of bounds.
  assert(isPowerOf2_64(VecTy.getNumElements()) &&
         "Expected a power-2 vector size");
  auto Mask = Builder.buildConstant(IdxTy, VecTy.getNumElements() - 1);
  Register And = Builder.buildAnd(IdxTy, Offset, Mask).getReg(0);
  auto EltSize = Builder.buildConstant(IdxTy, EltTy.getSizeInBytes());
  Register Mul = Builder.buildMul(IdxTy, And, EltSize).getReg(0);
  Register EltPtr =
      Builder.buildPtrAdd(MRI.getType(StackTemp.getReg(0)), StackTemp, Mul)
          .getReg(0);
 
  // Write the inserted element
  Builder.buildStore(Insert.getElementReg(), EltPtr, PtrInfo, Align(1));
  // Reload the whole vector.
  Builder.buildLoad(Insert.getReg(0), StackTemp, PtrInfo, Align(8));
  Insert.eraseFromParent();
}
 
/// Match a G_SHUFFLE_VECTOR with a mask which corresponds to a
/// G_INSERT_VECTOR_ELT and G_EXTRACT_VECTOR_ELT pair.
///
/// e.g.
///   %shuf = G_SHUFFLE_VECTOR %left, %right, shufflemask(0, 0)
///
/// Can be represented as
///
///   %extract = G_EXTRACT_VECTOR_ELT %left, 0
///   %ins = G_INSERT_VECTOR_ELT %left, %extract, 1
///
bool matchINS(MachineInstr &MI, MachineRegisterInfo &MRI,
              std::tuple<Register, int, Register, int> &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  ArrayRef<int> ShuffleMask = MI.getOperand(3).getShuffleMask();
  Register Dst = MI.getOperand(0).getReg();
  int NumElts = MRI.getType(Dst).getNumElements();
  auto DstIsLeftAndDstLane = isINSMask(ShuffleMask, NumElts);
  if (!DstIsLeftAndDstLane)
    return false;
  bool DstIsLeft;
  int DstLane;
  std::tie(DstIsLeft, DstLane) = *DstIsLeftAndDstLane;
  Register Left = MI.getOperand(1).getReg();
  Register Right = MI.getOperand(2).getReg();
  Register DstVec = DstIsLeft ? Left : Right;
  Register SrcVec = Left;
 
  int SrcLane = ShuffleMask[DstLane];
  if (SrcLane >= NumElts) {
    SrcVec = Right;
    SrcLane -= NumElts;
  }
 
  MatchInfo = std::make_tuple(DstVec, DstLane, SrcVec, SrcLane);
  return true;
}
 
void applyINS(MachineInstr &MI, MachineRegisterInfo &MRI,
              MachineIRBuilder &Builder,
              std::tuple<Register, int, Register, int> &MatchInfo) {
  Builder.setInstrAndDebugLoc(MI);
  Register Dst = MI.getOperand(0).getReg();
  auto ScalarTy = MRI.getType(Dst).getElementType();
  Register DstVec, SrcVec;
  int DstLane, SrcLane;
  std::tie(DstVec, DstLane, SrcVec, SrcLane) = MatchInfo;
  auto SrcCst = Builder.buildConstant(LLT::integer(64), SrcLane);
  auto Extract = Builder.buildExtractVectorElement(ScalarTy, SrcVec, SrcCst);
  auto DstCst = Builder.buildConstant(LLT::integer(64), DstLane);
  Builder.buildInsertVectorElement(Dst, DstVec, Extract, DstCst);
  MI.eraseFromParent();
}
 
/// isVShiftRImm - Check if this is a valid vector for the immediate
/// operand of a vector shift right operation. The value must be in the range:
///   1 <= Value <= ElementBits for a right shift.
bool isVShiftRImm(Register Reg, MachineRegisterInfo &MRI, LLT Ty,
                  int64_t &Cnt) {
  assert(Ty.isVector() && "vector shift count is not a vector type");
  int64_t ElementBits = Ty.getScalarSizeInBits();
  assert(ElementBits <= 64 && "expected <= 64bit shift type");
  MachineInstr *MI = MRI.getVRegDef(Reg);
  std::optional<Register> Splat = getVectorSplat(*MI, MRI);
  if (!Splat)
    return false;
  std::optional<APInt> C = getIConstantVRegVal(*Splat, MRI);
  if (!C)
    return false;
  Cnt = C->getSExtValue();
  return Cnt >= 1 && Cnt <= ElementBits;
}
 
/// Match a vector G_ASHR or G_LSHR with a valid immediate shift.
bool matchVAshrLshrImm(MachineInstr &MI, MachineRegisterInfo &MRI,
                       int64_t &Imm) {
  assert(MI.getOpcode() == TargetOpcode::G_ASHR ||
         MI.getOpcode() == TargetOpcode::G_LSHR);
  LLT Ty = MRI.getType(MI.getOperand(1).getReg());
  if (!Ty.isVector())
    return false;
  return isVShiftRImm(MI.getOperand(2).getReg(), MRI, Ty, Imm);
}
 
void applyVAshrLshrImm(MachineInstr &MI, MachineRegisterInfo &MRI,
                       int64_t &Imm) {
  unsigned Opc = MI.getOpcode();
  assert(Opc == TargetOpcode::G_ASHR || Opc == TargetOpcode::G_LSHR);
  unsigned NewOpc =
      Opc == TargetOpcode::G_ASHR ? AArch64::G_VASHR : AArch64::G_VLSHR;
  MachineIRBuilder MIB(MI);
  MIB.buildInstr(NewOpc, {MI.getOperand(0)}, {MI.getOperand(1)}).addImm(Imm);
  MI.eraseFromParent();
}
 
/// Determine whether an integer G_ICMP against 1 or -1 can compare
/// against 0 instead.
///
/// AArch64 can fold a compare-with-zero more cheaply than some non-arithmetic
/// immediates (SUBS/ADDS, or TST when the LHS is an AND). When the predicate
/// can be adjusted without changing semantics, the RHS may become 0.
///
/// Supported transforms (signed predicates only):
///   (and X, Y) slt  1  =>  (and X, Y) sle 0
///   (and X, Y) sge  1  =>  (and X, Y) sgt 0
///        X   sle -1  =>        X   slt 0
///        X   sgt -1  =>        X   sge 0
///
/// The compare-against-1 cases require the LHS to be G_AND because the
/// compare-with-zero path enables ANDS (TST) selection, and ANDS flags are
/// only reliable for those signed comparisons. This mirrors SelectionDAG
/// emitComparison().
///
/// For compare-against--1 on a non-AND LHS, \p LHS must have a single
/// non-debug use so other users are not left with a different immediate.
///
/// \param LHS The compare LHS register.
/// \param C   The constant RHS (only 1 or all-ones are considered).
/// \param P   In/out predicate; updated when a transform applies.
/// \param MRI Used to inspect the LHS definition and use count.
/// \returns true if \p P was updated and comparing against 0 is equivalent.
static bool shouldBeAdjustedToZero(Register LHS, const APInt &C,
                                   CmpInst::Predicate &P,
                                   const MachineRegisterInfo &MRI) {
  const bool IsAndLHS = getOpcodeDef<GAnd>(LHS, MRI) != nullptr;
 
  if (C.isOne() && (P == CmpInst::ICMP_SLT || P == CmpInst::ICMP_SGE) &&
      IsAndLHS) {
    P = (P == CmpInst::ICMP_SLT) ? CmpInst::ICMP_SLE : CmpInst::ICMP_SGT;
    return true;
  }
 
  if (!IsAndLHS && !MRI.hasOneNonDBGUse(LHS))
    return false;
 
  if (C.isAllOnes() && (P == CmpInst::ICMP_SLE || P == CmpInst::ICMP_SGT)) {
    P = (P == CmpInst::ICMP_SLE) ? CmpInst::ICMP_SLT : CmpInst::ICMP_SGE;
    return true;
  }
  return false;
}
 
/// Determine if it is possible to modify the \p RHS and predicate \p P of a
/// G_ICMP instruction such that the right-hand side is an arithmetic immediate.
///
/// \returns A pair containing the updated immediate and predicate which may
/// be used to optimize the instruction.
///
/// \note This assumes that the comparison has been legalized.
std::optional<std::pair<uint64_t, CmpInst::Predicate>>
tryAdjustICmpImmAndPred(Register LHS, Register RHS, CmpInst::Predicate P,
                        const MachineRegisterInfo &MRI) {
  const auto &Ty = MRI.getType(RHS);
  if (Ty.isVector())
    return std::nullopt;
  assert((Ty.getSizeInBits() == 32 || Ty.getSizeInBits() == 64) &&
         "Expected 32 or 64 bit compare only?");
 
  // If the RHS is not a constant, or the RHS is already a valid arithmetic
  // immediate, then there is nothing to change.
  auto ValAndVReg = getIConstantVRegValWithLookThrough(RHS, MRI);
  if (!ValAndVReg)
    return std::nullopt;
  APInt C = ValAndVReg->Value;
  if (shouldBeAdjustedToZero(LHS, C, P, MRI))
    return {{0, P}};
 
  if (AArch64_AM::isLegalCmpImmed(C))
    return std::nullopt;
 
  uint64_t OriginalC = C.getZExtValue();
 
  // We have a non-arithmetic immediate. Check if adjusting the immediate and
  // adjusting the predicate will result in a legal arithmetic immediate.
  switch (P) {
  default:
    return std::nullopt;
  case CmpInst::ICMP_SLT:
  case CmpInst::ICMP_SGE:
    // Check for
    //
    // x slt c => x sle c - 1
    // x sge c => x sgt c - 1
    //
    // When c is not the smallest possible negative number.
    if (C.isMinSignedValue())
      return std::nullopt;
    P = (P == CmpInst::ICMP_SLT) ? CmpInst::ICMP_SLE : CmpInst::ICMP_SGT;
    C = C - 1;
    break;
  case CmpInst::ICMP_ULT:
  case CmpInst::ICMP_UGE:
    // Check for
    //
    // x ult c => x ule c - 1
    // x uge c => x ugt c - 1
    //
    // When c is not zero.
    assert(!C.isZero() && "C should not be zero here!");
    P = (P == CmpInst::ICMP_ULT) ? CmpInst::ICMP_ULE : CmpInst::ICMP_UGT;
    C = C - 1;
    break;
  case CmpInst::ICMP_SLE:
  case CmpInst::ICMP_SGT:
    // Check for
    //
    // x sle c => x slt c + 1
    // x sgt c => s sge c + 1
    //
    // When c is not the largest possible signed integer.
    if (C.isMaxSignedValue())
      return std::nullopt;
    P = (P == CmpInst::ICMP_SLE) ? CmpInst::ICMP_SLT : CmpInst::ICMP_SGE;
    C = C + 1;
    break;
  case CmpInst::ICMP_ULE:
  case CmpInst::ICMP_UGT:
    // Check for
    //
    // x ule c => x ult c + 1
    // x ugt c => s uge c + 1
    //
    // When c is not the largest possible unsigned integer.
    if (C.isAllOnes())
      return std::nullopt;
    P = (P == CmpInst::ICMP_ULE) ? CmpInst::ICMP_ULT : CmpInst::ICMP_UGE;
    C = C + 1;
    break;
  }
 
  // Check if the new constant is valid, and return the updated constant and
  // predicate if it is.
  uint64_t NewC = C.getZExtValue();
  if (AArch64_AM::isLegalCmpImmed(C))
    return {{NewC, P}};
 
  auto NumberOfInstrToLoadImm = [=](uint64_t Imm) {
    SmallVector<AArch64_IMM::ImmInsnModel> Insn;
    AArch64_IMM::expandMOVImm(Imm, 32, Insn);
    return Insn.size();
  };
 
  if (NumberOfInstrToLoadImm(OriginalC) > NumberOfInstrToLoadImm(NewC))
    return {{NewC, P}};
 
  return std::nullopt;
}
 
/// Determine whether or not it is possible to update the RHS and predicate of
/// a G_ICMP instruction such that the RHS will be selected as an arithmetic
/// immediate.
///
/// \p MI - The G_ICMP instruction
/// \p MatchInfo - The new RHS immediate and predicate on success
///
/// See tryAdjustICmpImmAndPred for valid transformations.
bool matchAdjustICmpImmAndPred(
    MachineInstr &MI, const MachineRegisterInfo &MRI,
    std::pair<uint64_t, CmpInst::Predicate> &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_ICMP);
  Register LHS = MI.getOperand(2).getReg();
  Register RHS = MI.getOperand(3).getReg();
  auto Pred = static_cast<CmpInst::Predicate>(MI.getOperand(1).getPredicate());
  if (auto MaybeNewImmAndPred = tryAdjustICmpImmAndPred(LHS, RHS, Pred, MRI)) {
    MatchInfo = *MaybeNewImmAndPred;
    return true;
  }
  return false;
}
 
void applyAdjustICmpImmAndPred(
    MachineInstr &MI, std::pair<uint64_t, CmpInst::Predicate> &MatchInfo,
    MachineIRBuilder &MIB, GISelChangeObserver &Observer) {
  MIB.setInstrAndDebugLoc(MI);
  MachineOperand &RHS = MI.getOperand(3);
  MachineRegisterInfo &MRI = *MIB.getMRI();
  auto Cst = MIB.buildConstant(MRI.cloneVirtualRegister(RHS.getReg()),
                               MatchInfo.first);
  Observer.changingInstr(MI);
  RHS.setReg(Cst->getOperand(0).getReg());
  MI.getOperand(1).setPredicate(MatchInfo.second);
  Observer.changedInstr(MI);
}
 
bool matchDupLane(MachineInstr &MI, MachineRegisterInfo &MRI,
                  std::pair<unsigned, int> &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  Register Src1Reg = MI.getOperand(1).getReg();
  const LLT SrcTy = MRI.getType(Src1Reg);
  const LLT DstTy = MRI.getType(MI.getOperand(0).getReg());
 
  auto LaneIdx = getSplatIndex(MI);
  if (!LaneIdx)
    return false;
 
  // The lane idx should be within the first source vector.
  if (*LaneIdx >= SrcTy.getNumElements())
    return false;
 
  if (DstTy != SrcTy)
    return false;
 
  LLT ScalarTy = SrcTy.getElementType();
  unsigned ScalarSize = ScalarTy.getSizeInBits();
 
  unsigned Opc = 0;
  switch (SrcTy.getNumElements()) {
  case 2:
    if (ScalarSize == 64)
      Opc = AArch64::G_DUPLANE64;
    else if (ScalarSize == 32)
      Opc = AArch64::G_DUPLANE32;
    break;
  case 4:
    if (ScalarSize == 32)
      Opc = AArch64::G_DUPLANE32;
    else if (ScalarSize == 16)
      Opc = AArch64::G_DUPLANE16;
    break;
  case 8:
    if (ScalarSize == 8)
      Opc = AArch64::G_DUPLANE8;
    else if (ScalarSize == 16)
      Opc = AArch64::G_DUPLANE16;
    break;
  case 16:
    if (ScalarSize == 8)
      Opc = AArch64::G_DUPLANE8;
    break;
  default:
    break;
  }
  if (!Opc)
    return false;
 
  MatchInfo.first = Opc;
  MatchInfo.second = *LaneIdx;
  return true;
}
 
void applyDupLane(MachineInstr &MI, MachineRegisterInfo &MRI,
                  MachineIRBuilder &B, std::pair<unsigned, int> &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_SHUFFLE_VECTOR);
  Register Src1Reg = MI.getOperand(1).getReg();
  const LLT SrcTy = MRI.getType(Src1Reg);
 
  B.setInstrAndDebugLoc(MI);
  auto Lane = B.buildConstant(LLT::integer(64), MatchInfo.second);
 
  Register DupSrc = MI.getOperand(1).getReg();
  // For types like <2 x s32>, we can use G_DUPLANE32, with a <4 x s32> source.
  // To do this, we can use a G_CONCAT_VECTORS to do the widening.
  if (SrcTy.getSizeInBits() == 64) {
    auto Undef = B.buildUndef(SrcTy);
    DupSrc = B.buildConcatVectors(SrcTy.multiplyElements(2),
                                  {Src1Reg, Undef.getReg(0)})
                 .getReg(0);
  }
  B.buildInstr(MatchInfo.first, {MI.getOperand(0).getReg()}, {DupSrc, Lane});
  MI.eraseFromParent();
}
 
bool matchScalarizeVectorUnmerge(MachineInstr &MI, MachineRegisterInfo &MRI) {
  auto &Unmerge = cast<GUnmerge>(MI);
  Register Src1Reg = Unmerge.getReg(Unmerge.getNumOperands() - 1);
  const LLT SrcTy = MRI.getType(Src1Reg);
  if (SrcTy.getSizeInBits() != 128 && SrcTy.getSizeInBits() != 64)
    return false;
  return SrcTy.isVector() && !SrcTy.isScalable() &&
         (Unmerge.getNumOperands() == (unsigned)SrcTy.getNumElements() + 1 ||
          (Unmerge.getNumDefs() == 2 && SrcTy.getSizeInBits() == 128 &&
           MRI.getType(Unmerge.getReg(0)).getSizeInBits() == 64));
}
 
void applyScalarizeVectorUnmerge(MachineInstr &MI, MachineRegisterInfo &MRI,
                                 MachineIRBuilder &B) {
  auto &Unmerge = cast<GUnmerge>(MI);
  Register Src1Reg = Unmerge.getReg(Unmerge.getNumOperands() - 1);
  const LLT SrcTy = MRI.getType(Src1Reg);
  const LLT DstTy = MRI.getType(Unmerge.getReg(0));
  assert((SrcTy.isVector() && !SrcTy.isScalable()) &&
         "Expected a fixed length vector");
 
  if (DstTy.isVector()) {
    assert(Unmerge.getNumDefs() == 2);
    if (!MRI.use_nodbg_empty(Unmerge.getReg(0)))
      B.buildExtractSubvector(Unmerge.getReg(0), Src1Reg, 0);
    if (!MRI.use_nodbg_empty(Unmerge.getReg(1)))
      B.buildExtractSubvector(Unmerge.getReg(1), Src1Reg,
                              SrcTy.getNumElements() / 2);
  } else {
    for (int I = 0; I < SrcTy.getNumElements(); ++I)
      if (!MRI.use_nodbg_empty(Unmerge.getReg(I)))
        B.buildExtractVectorElementConstant(Unmerge.getReg(I), Src1Reg, I);
  }
  MI.eraseFromParent();
}
 
bool matchBuildVectorToDup(MachineInstr &MI, Register &Src,
                           MachineRegisterInfo &MRI) {
  assert(MI.getOpcode() == TargetOpcode::G_BUILD_VECTOR);
 
  // Later, during selection, we'll try to match imported patterns using
  // immAllOnesV and immAllZerosV. These require G_BUILD_VECTOR. Don't lower
  // G_BUILD_VECTORs which could match those patterns.
  if (isBuildVectorAllZeros(MI, MRI) || isBuildVectorAllOnes(MI, MRI))
    return false;
 
  // Find buildvector which always uses the same register or undef. Return true
  // so long as at least 2 registers were found (not all-undef or only 1
  // non-undef entry).
  Register Reg = 0;
  unsigned NumNonUndef = 0;
  for (const MachineOperand &Op : drop_begin(MI.operands())) {
    if (getOpcodeDef<GImplicitDef>(Op.getReg(), MRI))
      continue;
 
    if (!Reg)
      Reg = Op.getReg();
    else if (Op.getReg() != Reg)
      return false;
    NumNonUndef++;
  }
 
  Src = Reg;
  return Reg && NumNonUndef > 1;
}
 
void applyBuildVectorToDup(MachineInstr &MI, Register Src,
                           MachineRegisterInfo &MRI, MachineIRBuilder &B) {
  B.setInstrAndDebugLoc(MI);
  B.buildInstr(TargetOpcode::G_SPLAT_VECTOR, {MI.getOperand(0).getReg()},
               {Src});
  MI.eraseFromParent();
}
 
/// \returns how many instructions would be saved by folding a G_ICMP's shift
/// and/or extension operations.
static unsigned getCmpOperandFoldingProfit(Register CmpOp,
                                           MachineRegisterInfo &MRI) {
  // FIXME: This is duplicated with the selector. (See: selectShiftedRegister)
  auto IsSupportedExtend = [&](const MachineInstr &MI) {
    if (MI.getOpcode() == TargetOpcode::G_SEXT_INREG)
      return true;
    if (MI.getOpcode() == TargetOpcode::G_AND) {
      auto ValAndVReg =
          getIConstantVRegValWithLookThrough(MI.getOperand(2).getReg(), MRI);
      if (ValAndVReg) {
        uint64_t Mask = ValAndVReg->Value.getZExtValue();
        return (Mask == 0xFF || Mask == 0xFFFF || Mask == 0xFFFFFFFF);
      }
    }
    return false;
  };
 
  // No instructions to save if there's more than one use or no uses.
  if (!MRI.hasOneNonDBGUse(CmpOp))
    return 0;
 
  MachineInstr *Def = getDefIgnoringCopies(CmpOp, MRI);
  if (IsSupportedExtend(*Def))
    return 1;
 
  unsigned Opc = Def->getOpcode();
  if (Opc == TargetOpcode::G_SHL || Opc == TargetOpcode::G_LSHR ||
      Opc == TargetOpcode::G_ASHR) {
    auto MaybeShiftAmt =
        getIConstantVRegValWithLookThrough(Def->getOperand(2).getReg(), MRI);
    if (MaybeShiftAmt) {
      uint64_t ShiftAmt = MaybeShiftAmt->Value.getZExtValue();
      MachineInstr *ShiftLHS =
          getDefIgnoringCopies(Def->getOperand(1).getReg(), MRI);
      if (IsSupportedExtend(*ShiftLHS))
        return (ShiftAmt <= 4) ? 2 : 1;
      LLT Ty = MRI.getType(Def->getOperand(0).getReg());
      if (Ty.isVector())
        return 0;
      unsigned ShiftSize = Ty.getSizeInBits();
      if ((ShiftSize == 32 && ShiftAmt <= 31) ||
          (ShiftSize == 64 && ShiftAmt <= 63))
        return 1;
    }
  }
 
  return 0;
}
 
/// \returns true if it would be profitable to swap the LHS and RHS of a G_ICMP
/// instruction \p MI.
bool trySwapICmpOperands(MachineInstr &MI, MachineRegisterInfo &MRI) {
  assert(MI.getOpcode() == TargetOpcode::G_ICMP);
  // Swap the operands if it would introduce a profitable folding opportunity.
  // (e.g. a shift + extend).
  //
  //  For example:
  //    lsl     w13, w11, #1
  //    cmp     w13, w12
  // can be turned into:
  //    cmp     w12, w11, lsl #1
 
  // Don't swap if there's a constant on the RHS and it is a legal compare
  // immediate, because we know we can fold that.
  Register RHS = MI.getOperand(3).getReg();
  auto RHSCst = getIConstantVRegValWithLookThrough(RHS, MRI);
  if (RHSCst && AArch64_AM::isLegalCmpImmed(RHSCst->Value))
    return false;
 
  Register LHS = MI.getOperand(2).getReg();
  auto Pred = static_cast<CmpInst::Predicate>(MI.getOperand(1).getPredicate());
  auto GetRegForProfit = [&](Register Reg) {
    MachineInstr *Def = getDefIgnoringCopies(Reg, MRI);
    return isCMN(Def, Pred, MRI) ? Def->getOperand(2).getReg() : Reg;
  };
 
  // Don't have a constant on the RHS. If we swap the LHS and RHS of the
  // compare, would we be able to fold more instructions?
  Register TheLHS = GetRegForProfit(LHS);
  Register TheRHS = GetRegForProfit(RHS);
 
  // If the LHS is more likely to give us a folding opportunity, then swap the
  // LHS and RHS.
  return (getCmpOperandFoldingProfit(TheLHS, MRI) >
          getCmpOperandFoldingProfit(TheRHS, MRI));
}
 
void applySwapICmpOperands(MachineInstr &MI, GISelChangeObserver &Observer) {
  auto Pred = static_cast<CmpInst::Predicate>(MI.getOperand(1).getPredicate());
  Register LHS = MI.getOperand(2).getReg();
  Register RHS = MI.getOperand(3).getReg();
  Observer.changingInstr(MI);
  MI.getOperand(1).setPredicate(CmpInst::getSwappedPredicate(Pred));
  MI.getOperand(2).setReg(RHS);
  MI.getOperand(3).setReg(LHS);
  Observer.changedInstr(MI);
}
 
/// \returns a function which builds a vector floating point compare instruction
/// for a condition code \p CC.
/// \param [in] NoNans - True if the instruction has nnan flag.
std::function<Register(MachineIRBuilder &)>
getVectorFCMP(AArch64CC::CondCode CC, Register LHS, Register RHS, bool NoNans,
              MachineRegisterInfo &MRI) {
  LLT OldTy = MRI.getType(LHS);
  LLT DstTy = LLT::fixed_vector(OldTy.getNumElements(),
                                LLT::integer(OldTy.getScalarSizeInBits()));
  assert(DstTy.isVector() && "Expected vector types only?");
  switch (CC) {
  default:
    llvm_unreachable("Unexpected condition code!");
  case AArch64CC::NE:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      auto FCmp = MIB.buildInstr(AArch64::G_FCMEQ, {DstTy}, {LHS, RHS});
      return MIB.buildNot(DstTy, FCmp).getReg(0);
    };
  case AArch64CC::EQ:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      return MIB.buildInstr(AArch64::G_FCMEQ, {DstTy}, {LHS, RHS}).getReg(0);
    };
  case AArch64CC::GE:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      return MIB.buildInstr(AArch64::G_FCMGE, {DstTy}, {LHS, RHS}).getReg(0);
    };
  case AArch64CC::GT:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      return MIB.buildInstr(AArch64::G_FCMGT, {DstTy}, {LHS, RHS}).getReg(0);
    };
  case AArch64CC::LS:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      return MIB.buildInstr(AArch64::G_FCMGE, {DstTy}, {RHS, LHS}).getReg(0);
    };
  case AArch64CC::MI:
    return [LHS, RHS, DstTy](MachineIRBuilder &MIB) {
      return MIB.buildInstr(AArch64::G_FCMGT, {DstTy}, {RHS, LHS}).getReg(0);
    };
  }
}
 
/// Try to lower a vector G_FCMP \p MI into an AArch64-specific pseudo.
bool matchLowerVectorFCMP(MachineInstr &MI, MachineRegisterInfo &MRI,
                          MachineIRBuilder &MIB) {
  assert(MI.getOpcode() == TargetOpcode::G_FCMP);
  const auto &ST = MI.getMF()->getSubtarget<AArch64Subtarget>();
 
  Register Dst = MI.getOperand(0).getReg();
  LLT DstTy = MRI.getType(Dst);
  if (!DstTy.isVector() || !ST.hasNEON())
    return false;
  Register LHS = MI.getOperand(2).getReg();
  unsigned EltSize = MRI.getType(LHS).getScalarSizeInBits();
  if (EltSize == 16 && !ST.hasFullFP16())
    return false;
  if (EltSize != 16 && EltSize != 32 && EltSize != 64)
    return false;
 
  return true;
}
 
/// Try to lower a vector G_FCMP \p MI into an AArch64-specific pseudo.
void applyLowerVectorFCMP(MachineInstr &MI, MachineRegisterInfo &MRI,
                          MachineIRBuilder &MIB) {
  assert(MI.getOpcode() == TargetOpcode::G_FCMP);
 
  const auto &CmpMI = cast<GFCmp>(MI);
 
  Register Dst = CmpMI.getReg(0);
  CmpInst::Predicate Pred = CmpMI.getCond();
  Register LHS = CmpMI.getLHSReg();
  Register RHS = CmpMI.getRHSReg();
 
  LLT DstTy = MRI.getType(Dst);
 
  bool Invert = false;
  AArch64CC::CondCode CC, CC2 = AArch64CC::AL;
  if ((Pred == CmpInst::Predicate::FCMP_ORD ||
       Pred == CmpInst::Predicate::FCMP_UNO) &&
      isBuildVectorAllZeros(*MRI.getVRegDef(RHS), MRI)) {
    // The special case "fcmp ord %a, 0" is the canonical check that LHS isn't
    // NaN, so equivalent to a == a and doesn't need the two comparisons an
    // "ord" normally would.
    // Similarly, "fcmp uno %a, 0" is the canonical check that LHS is NaN and is
    // thus equivalent to a != a.
    RHS = LHS;
    CC = Pred == CmpInst::Predicate::FCMP_ORD ? AArch64CC::EQ : AArch64CC::NE;
  } else
    changeVectorFCMPPredToAArch64CC(Pred, CC, CC2, Invert);
 
  // Instead of having an apply function, just build here to simplify things.
  MIB.setInstrAndDebugLoc(MI);
 
  // TODO: Also consider GISelValueTracking result if eligible.
  const bool NoNans = MI.getFlag(MachineInstr::FmNoNans);
 
  auto Cmp = getVectorFCMP(CC, LHS, RHS, NoNans, MRI);
  Register CmpRes;
  if (CC2 == AArch64CC::AL)
    CmpRes = Cmp(MIB);
  else {
    auto Cmp2 = getVectorFCMP(CC2, LHS, RHS, NoNans, MRI);
    auto Cmp2Dst = Cmp2(MIB);
    auto Cmp1Dst = Cmp(MIB);
    CmpRes = MIB.buildOr(DstTy, Cmp1Dst, Cmp2Dst).getReg(0);
  }
  if (Invert)
    CmpRes = MIB.buildNot(DstTy, CmpRes).getReg(0);
  MRI.replaceRegWith(Dst, CmpRes);
  MI.eraseFromParent();
}
 
// Matches G_BUILD_VECTOR where at least one source operand is not a constant
bool matchLowerBuildToInsertVecElt(MachineInstr &MI, MachineRegisterInfo &MRI) {
  auto *GBuildVec = cast<GBuildVector>(&MI);
 
  // Check if the values are all constants
  for (unsigned I = 0; I < GBuildVec->getNumSources(); ++I) {
    auto ConstVal =
        getAnyConstantVRegValWithLookThrough(GBuildVec->getSourceReg(I), MRI);
 
    if (!ConstVal.has_value())
      return true;
  }
 
  return false;
}
 
void applyLowerBuildToInsertVecElt(MachineInstr &MI, MachineRegisterInfo &MRI,
                                   MachineIRBuilder &B) {
  auto *GBuildVec = cast<GBuildVector>(&MI);
  LLT DstTy = MRI.getType(GBuildVec->getReg(0));
  Register DstReg = B.buildUndef(DstTy).getReg(0);
 
  for (unsigned I = 0; I < GBuildVec->getNumSources(); ++I) {
    Register SrcReg = GBuildVec->getSourceReg(I);
    if (mi_match(SrcReg, MRI, m_GImplicitDef()))
      continue;
    auto IdxReg = B.buildConstant(LLT::integer(64), I);
    DstReg =
        B.buildInsertVectorElement(DstTy, DstReg, SrcReg, IdxReg).getReg(0);
  }
  B.buildCopy(GBuildVec->getReg(0), DstReg);
  GBuildVec->eraseFromParent();
}
 
// Detect vector constants that cannot be natively represent, but can be
// represented as fneg(constant). For example the constant
// <0x800000000000000, 0x800000000000000> can be represented as fneg(<0, 0>).
bool matchConstBuildVectorToFNeg(MachineInstr &MI, MachineRegisterInfo &MRI,
                                 const AArch64Subtarget &ST,
                                 std::pair<APInt, unsigned> &MatchInfo) {
  assert(MI.getOpcode() == TargetOpcode::G_BUILD_VECTOR);
  if (!ST.isNeonAvailable())
    return false;
  LLT Ty = MRI.getType(MI.getOperand(0).getReg());
  // Limit to fneg of v2f32, v4f32, f64, v2f64 or v4f16 and v8f16 with fullfp16.
  if (Ty.getSizeInBits() != 64 && Ty.getSizeInBits() != 128)
    return false;
  unsigned EltSize = Ty.getScalarSizeInBits();
 
  APInt Imm(Ty.getSizeInBits(), 0);
  for (unsigned Idx = 1; Idx < MI.getNumOperands(); Idx++) {
    auto C =
        getAnyConstantVRegValWithLookThrough(MI.getOperand(Idx).getReg(), MRI);
    if (!C)
      return false;
    Imm |= C->Value.trunc(EltSize)
               .zext(Ty.getSizeInBits())
               .shl((Idx - 1) * EltSize);
  }
 
  SmallVector<AArch64_IMM::ImmInsnModel> Insns;
  if (AArch64_IMM::expandVectorMOVImm(Imm, Insns, ST))
    return false;
 
  auto Check = [&](APInt &Imm, unsigned Size) {
    APInt NImm = Imm ^ APInt::getSplat(Imm.getBitWidth(),
                                       APInt::getHighBitsSet(Size, 1));
    SmallVector<AArch64_IMM::ImmInsnModel> Insns;
    MatchInfo.first = NImm;
    MatchInfo.second = Size;
    return AArch64_IMM::expandVectorMOVImm(NImm, Insns, ST);
  };
 
  return Check(Imm, 64) || Check(Imm, 32) ||
         (ST.hasFullFP16() && Check(Imm, 16));
}
 
void applyConstBuildVectorToFNeg(MachineInstr &MI, MachineRegisterInfo &MRI,
                                 MachineIRBuilder &B,
                                 std::pair<APInt, unsigned> &MatchInfo) {
  B.setInstrAndDebugLoc(MI);
  LLT Ty = MRI.getType(MI.getOperand(0).getReg());
  // Extract the Immediate into chunks of size EltSize
  unsigned EltSize = MatchInfo.second;
  unsigned NumLanes = Ty.getSizeInBits() / EltSize;
  LLT VTy = NumLanes == 1
                ? LLT::floatIEEE(EltSize)
                : LLT::fixed_vector(NumLanes, LLT::floatIEEE(EltSize));
  SmallVector<APInt> Imms;
  for (unsigned I = 0; I < NumLanes; I++)
    Imms.push_back(MatchInfo.first.extractBits(EltSize, I * EltSize));
  // Build the new BV and FNeg of it.
  auto BV = NumLanes == 1 ? B.buildFConstant(VTy, APFloat(APFloat::IEEEdouble(),
                                                          MatchInfo.first))
                          : B.buildBuildVectorConstant(VTy, Imms);
  auto FNeg = B.buildFNeg(Ty == VTy ? DstOp(MI.getOperand(0)) : DstOp(VTy), BV);
  if (Ty != VTy)
    B.buildBitcast(MI.getOperand(0), FNeg);
  MI.eraseFromParent();
}
 
bool matchFormTruncstore(MachineInstr &MI, MachineRegisterInfo &MRI,
                         Register &SrcReg) {
  assert(MI.getOpcode() == TargetOpcode::G_STORE);
  Register DstReg = MI.getOperand(0).getReg();
  if (cast<GLoadStore>(MI).isAtomic())
    return false;
  if (MRI.getType(DstReg).isVector())
    return false;
  // Match a store of a truncate.
  if (!mi_match(DstReg, MRI, m_GTrunc(m_Reg(SrcReg))))
    return false;
  // Only form truncstores for value types of max 64b.
  return MRI.getType(SrcReg).getSizeInBits() <= 64;
}
 
void applyFormTruncstore(MachineInstr &MI, MachineRegisterInfo &MRI,
                         MachineIRBuilder &B, GISelChangeObserver &Observer,
                         Register &SrcReg) {
  assert(MI.getOpcode() == TargetOpcode::G_STORE);
  Observer.changingInstr(MI);
  MI.getOperand(0).setReg(SrcReg);
  Observer.changedInstr(MI);
}
 
// Lower vector G_SEXT_INREG back to shifts for selection. We allowed them to
// form in the first place for combine opportunities, so any remaining ones
// at this stage need be lowered back.
bool matchVectorSextInReg(MachineInstr &MI, MachineRegisterInfo &MRI) {
  assert(MI.getOpcode() == TargetOpcode::G_SEXT_INREG);
  Register DstReg = MI.getOperand(0).getReg();
  LLT DstTy = MRI.getType(DstReg);
  return DstTy.isVector();
}
 
void applyVectorSextInReg(MachineInstr &MI, MachineRegisterInfo &MRI,
                          MachineIRBuilder &B, GISelChangeObserver &Observer) {
  assert(MI.getOpcode() == TargetOpcode::G_SEXT_INREG);
  B.setInstrAndDebugLoc(MI);
  LegalizerHelper Helper(*MI.getMF(), Observer, B);
  Helper.lower(MI, 0, /* Unused hint type */ LLT());
}
 
/// Combine <N x t>, unused = unmerge(G_EXT <2*N x t> v, undef, N)
///           => unused, <N x t> = unmerge v
bool matchUnmergeExtToUnmerge(MachineInstr &MI, MachineRegisterInfo &MRI,
                              Register &MatchInfo) {
  auto &Unmerge = cast<GUnmerge>(MI);
  if (Unmerge.getNumDefs() != 2)
    return false;
  if (!MRI.use_nodbg_empty(Unmerge.getReg(1)))
    return false;
 
  LLT DstTy = MRI.getType(Unmerge.getReg(0));
  if (!DstTy.isVector())
    return false;
 
  MachineInstr *Ext = getOpcodeDef(AArch64::G_EXT, Unmerge.getSourceReg(), MRI);
  if (!Ext)
    return false;
 
  Register ExtSrc1 = Ext->getOperand(1).getReg();
  Register ExtSrc2 = Ext->getOperand(2).getReg();
  auto LowestVal =
      getIConstantVRegValWithLookThrough(Ext->getOperand(3).getReg(), MRI);
  if (!LowestVal || LowestVal->Value.getZExtValue() != DstTy.getSizeInBytes())
    return false;
 
  if (!getOpcodeDef<GImplicitDef>(ExtSrc2, MRI))
    return false;
 
  MatchInfo = ExtSrc1;
  return true;
}
 
void applyUnmergeExtToUnmerge(MachineInstr &MI, MachineRegisterInfo &MRI,
                              MachineIRBuilder &B,
                              GISelChangeObserver &Observer, Register &SrcReg) {
  Observer.changingInstr(MI);
  // Swap dst registers.
  Register Dst1 = MI.getOperand(0).getReg();
  MI.getOperand(0).setReg(MI.getOperand(1).getReg());
  MI.getOperand(1).setReg(Dst1);
  MI.getOperand(2).setReg(SrcReg);
  Observer.changedInstr(MI);
}
 
// Match mul({z/s}ext , {z/s}ext) => {u/s}mull OR
// Match v2s64 mul instructions, which will then be scalarised later on
// Doing these two matches in one function to ensure that the order of matching
// will always be the same.
// Try lowering MUL to MULL before trying to scalarize if needed.
bool matchMulv2s64(MachineInstr &MI, MachineRegisterInfo &MRI) {
  // Get the instructions that defined the source operand
  LLT DstTy = MRI.getType(MI.getOperand(0).getReg());
  return DstTy == LLT::fixed_vector(2, 64);
}
 
void applyMulv2s64(MachineInstr &MI, MachineRegisterInfo &MRI,
                   MachineIRBuilder &B, GISelChangeObserver &Observer) {
  assert(MI.getOpcode() == TargetOpcode::G_MUL &&
         "Expected a G_MUL instruction");
 
  // Get the instructions that defined the source operand
  LLT DstTy = MRI.getType(MI.getOperand(0).getReg());
  assert(DstTy == LLT::fixed_vector(2, 64) && "Expected v2s64 Mul");
  LegalizerHelper Helper(*MI.getMF(), Observer, B);
  Helper.fewerElementsVector(
      MI, 0,
      DstTy.changeElementCount(DstTy.getElementCount().divideCoefficientBy(2)));
}
 
class AArch64PostLegalizerLoweringImpl : public Combiner {
protected:
  const CombinerHelper Helper;
  const AArch64PostLegalizerLoweringImplRuleConfig &RuleConfig;
  const AArch64Subtarget &STI;
 
public:
  AArch64PostLegalizerLoweringImpl(
      MachineFunction &MF, CombinerInfo &CInfo, GISelCSEInfo *CSEInfo,
      const AArch64PostLegalizerLoweringImplRuleConfig &RuleConfig,
      const AArch64Subtarget &STI);
 
  static const char *getName() { return "AArch6400PreLegalizerCombiner"; }
 
  bool tryCombineAll(MachineInstr &I) const override;
 
private:
#define GET_GICOMBINER_CLASS_MEMBERS
#include "AArch64GenPostLegalizeGILowering.inc"
#undef GET_GICOMBINER_CLASS_MEMBERS
};
 
#define GET_GICOMBINER_IMPL
#include "AArch64GenPostLegalizeGILowering.inc"
#undef GET_GICOMBINER_IMPL
 
AArch64PostLegalizerLoweringImpl::AArch64PostLegalizerLoweringImpl(
    MachineFunction &MF, CombinerInfo &CInfo, GISelCSEInfo *CSEInfo,
    const AArch64PostLegalizerLoweringImplRuleConfig &RuleConfig,
    const AArch64Subtarget &STI)
    : Combiner(MF, CInfo, /*VT*/ nullptr, CSEInfo),
      Helper(Observer, B, /*IsPreLegalize*/ true), RuleConfig(RuleConfig),
      STI(STI),
#define GET_GICOMBINER_CONSTRUCTOR_INITS
#include "AArch64GenPostLegalizeGILowering.inc"
#undef GET_GICOMBINER_CONSTRUCTOR_INITS
{
}
 
bool runPostLegalizerLowering(
    MachineFunction &MF,
    const AArch64PostLegalizerLoweringImplRuleConfig &RuleConfig) {
  if (MF.getProperties().hasFailedISel())
    return false;
  const Function &F = MF.getFunction();
 
  const AArch64Subtarget &ST = MF.getSubtarget<AArch64Subtarget>();
  CombinerInfo CInfo(/*AllowIllegalOps=*/true, /*ShouldLegalizeIllegal=*/false,
                     /*LegalizerInfo=*/nullptr, /*OptEnabled=*/true,
                     F.hasOptSize(), F.hasMinSize());
  // Disable fixed-point iteration to reduce compile-time
  CInfo.MaxIterations = 1;
  CInfo.ObserverLvl = CombinerInfo::ObserverLevel::SinglePass;
  // PostLegalizerCombiner performs DCE, so a full DCE pass is unnecessary.
  CInfo.EnableFullDCE = false;
  AArch64PostLegalizerLoweringImpl Impl(MF, CInfo, /*CSEInfo=*/nullptr,
                                        RuleConfig, ST);
  return Impl.combineMachineInstrs();
}
 
class AArch64PostLegalizerLoweringLegacy : public MachineFunctionPass {
public:
  static char ID;
 
  AArch64PostLegalizerLoweringLegacy();
 
  StringRef getPassName() const override {
    return "AArch64PostLegalizerLowering";
  }
 
  bool runOnMachineFunction(MachineFunction &MF) override;
  void getAnalysisUsage(AnalysisUsage &AU) const override;
 
private:
  AArch64PostLegalizerLoweringImplRuleConfig RuleConfig;
};
} // end anonymous namespace
 
void AArch64PostLegalizerLoweringLegacy::getAnalysisUsage(
    AnalysisUsage &AU) const {
  AU.setPreservesCFG();
  getSelectionDAGFallbackAnalysisUsage(AU);
  MachineFunctionPass::getAnalysisUsage(AU);
}
 
AArch64PostLegalizerLoweringLegacy::AArch64PostLegalizerLoweringLegacy()
    : MachineFunctionPass(ID) {
  if (!RuleConfig.parseCommandLineOption())
    report_fatal_error("Invalid rule identifier");
}
 
bool AArch64PostLegalizerLoweringLegacy::runOnMachineFunction(
    MachineFunction &MF) {
  assert(MF.getProperties().hasLegalized() && "Expected a legalized function?");
  return runPostLegalizerLowering(MF, RuleConfig);
}
 
char AArch64PostLegalizerLoweringLegacy::ID = 0;
INITIALIZE_PASS_BEGIN(AArch64PostLegalizerLoweringLegacy, DEBUG_TYPE,
                      "Lower AArch64 MachineInstrs after legalization", false,
                      false)
INITIALIZE_PASS_END(AArch64PostLegalizerLoweringLegacy, DEBUG_TYPE,
                    "Lower AArch64 MachineInstrs after legalization", false,
                    false)
 
AArch64PostLegalizerLoweringPass::AArch64PostLegalizerLoweringPass()
    : RuleConfig(
          std::make_unique<AArch64PostLegalizerLoweringImplRuleConfig>()) {
  if (!RuleConfig->parseCommandLineOption())
    reportFatalUsageError("invalid rule identifier");
}
 
AArch64PostLegalizerLoweringPass::AArch64PostLegalizerLoweringPass(
    AArch64PostLegalizerLoweringPass &&) = default;
 
AArch64PostLegalizerLoweringPass::~AArch64PostLegalizerLoweringPass() = default;
 
PreservedAnalyses
AArch64PostLegalizerLoweringPass::run(MachineFunction &MF,
                                      MachineFunctionAnalysisManager &MFAM) {
  MFPropsModifier _(*this, MF);
  const bool Changed = runPostLegalizerLowering(MF, *RuleConfig);
 
  if (!Changed)
    return PreservedAnalyses::all();
 
  PreservedAnalyses PA = getMachineFunctionPassPreservedAnalyses();
  PA.preserveSet<CFGAnalyses>();
  return PA;
}
 
namespace llvm {
FunctionPass *createAArch64PostLegalizerLowering() {
  return new AArch64PostLegalizerLoweringLegacy();
}
} // end namespace llvm