/build/source/llvm/include/llvm/IR/PatternMatch.h

Bug Summary

File:	build/source/llvm/include/llvm/IR/PatternMatch.h
Warning:	line 1450, column 9 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name InstCombineAddSub.cpp -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/source/build-llvm/tools/clang/stage2-bins -resource-dir /usr/lib/llvm-17/lib/clang/17 -D _DEBUG -D _GLIBCXX_ASSERTIONS -D _GNU_SOURCE -D _LIBCPP_ENABLE_ASSERTIONS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I lib/Transforms/InstCombine -I /build/source/llvm/lib/Transforms/InstCombine -I include -I /build/source/llvm/include -D _FORTIFY_SOURCE=2 -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-17/lib/clang/17/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/build/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fmacro-prefix-map=/build/source/= -fcoverage-prefix-map=/build/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fcoverage-prefix-map=/build/source/= -source-date-epoch 1683717183 -O2 -Wno-unused-command-line-argument -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -Wno-misleading-indentation -std=c++17 -fdeprecated-macro -fdebug-compilation-dir=/build/source/build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/source/= -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2023-05-10-133810-16478-1 -x c++ /build/source/llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp

/build/source/llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp

→

1//===- InstCombineAddSub.cpp ------------------------------------*- 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 file implements the visit functions for add, fadd, sub, and fsub.
10//
11//===----------------------------------------------------------------------===//

13#include "InstCombineInternal.h"
14#include "llvm/ADT/APFloat.h"
15#include "llvm/ADT/APInt.h"
16#include "llvm/ADT/STLExtras.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/Analysis/InstructionSimplify.h"
19#include "llvm/Analysis/ValueTracking.h"
20#include "llvm/IR/Constant.h"
21#include "llvm/IR/Constants.h"
22#include "llvm/IR/InstrTypes.h"
23#include "llvm/IR/Instruction.h"
24#include "llvm/IR/Instructions.h"
25#include "llvm/IR/Operator.h"
26#include "llvm/IR/PatternMatch.h"
27#include "llvm/IR/Type.h"
28#include "llvm/IR/Value.h"
29#include "llvm/Support/AlignOf.h"
30#include "llvm/Support/Casting.h"
31#include "llvm/Support/KnownBits.h"
32#include "llvm/Transforms/InstCombine/InstCombiner.h"
33#include <cassert>
34#include <utility>

36using namespace llvm;
37using namespace PatternMatch;

39#define DEBUG_TYPE"instcombine" "instcombine"

41namespace {

/// Class representing coefficient of floating-point addend.
/// This class needs to be highly efficient, which is especially true for
/// the constructor. As of I write this comment, the cost of the default
/// constructor is merely 4-byte-store-zero (Assuming compiler is able to
/// perform write-merging).
///
class FAddendCoef {
public:
  // The constructor has to initialize a APFloat, which is unnecessary for
  // most addends which have coefficient either 1 or -1. So, the constructor
  // is expensive. In order to avoid the cost of the constructor, we should
  // reuse some instances whenever possible. The pre-created instances
  // FAddCombine::Add[0-5] embodies this idea.
  FAddendCoef() = default;
  ~FAddendCoef();

  // If possible, don't define operator+/operator- etc because these
  // operators inevitably call FAddendCoef's constructor which is not cheap.
  void operator=(const FAddendCoef &A);
  void operator+=(const FAddendCoef &A);
  void operator*=(const FAddendCoef &S);

  void set(short C) {
    assert(!insaneIntVal(C) && "Insane coefficient")(static_cast <bool> (!insaneIntVal(C) && "Insane coefficient"
) ? void (0) : __assert_fail ("!insaneIntVal(C) && \"Insane coefficient\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 66
, __extension__ __PRETTY_FUNCTION__));
    IsFp = false; IntVal = C;
  }

  void set(const APFloat& C);

  void negate();

  bool isZero() const { return isInt() ? !IntVal : getFpVal().isZero(); }
  Value *getValue(Type *) const;

  bool isOne() const { return isInt() && IntVal == 1; }
  bool isTwo() const { return isInt() && IntVal == 2; }
  bool isMinusOne() const { return isInt() && IntVal == -1; }
  bool isMinusTwo() const { return isInt() && IntVal == -2; }

private:
  bool insaneIntVal(int V) { return V > 4 || V < -4; }

  APFloat *getFpValPtr() { return reinterpret_cast<APFloat *>(&FpValBuf); }

  const APFloat *getFpValPtr() const {
    return reinterpret_cast<const APFloat *>(&FpValBuf);
  }

  const APFloat &getFpVal() const {
    assert(IsFp && BufHasFpVal && "Incorret state")(static_cast <bool> (IsFp && BufHasFpVal &&
 "Incorret state") ? void (0) : __assert_fail ("IsFp && BufHasFpVal && \"Incorret state\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 92
, __extension__ __PRETTY_FUNCTION__));
    return *getFpValPtr();
  }

  APFloat &getFpVal() {
    assert(IsFp && BufHasFpVal && "Incorret state")(static_cast <bool> (IsFp && BufHasFpVal &&
 "Incorret state") ? void (0) : __assert_fail ("IsFp && BufHasFpVal && \"Incorret state\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 97
, __extension__ __PRETTY_FUNCTION__));
    return *getFpValPtr();
  }

  bool isInt() const { return !IsFp; }

  // If the coefficient is represented by an integer, promote it to a
  // floating point.
  void convertToFpType(const fltSemantics &Sem);

  // Construct an APFloat from a signed integer.
  // TODO: We should get rid of this function when APFloat can be constructed
  //       from an *SIGNED* integer.
  APFloat createAPFloatFromInt(const fltSemantics &Sem, int Val);

  bool IsFp = false;

  // True iff FpValBuf contains an instance of APFloat.
  bool BufHasFpVal = false;

  // The integer coefficient of an individual addend is either 1 or -1,
  // and we try to simplify at most 4 addends from neighboring at most
  // two instructions. So the range of <IntVal> falls in [-4, 4]. APInt
  // is overkill of this end.
  short IntVal = 0;

  AlignedCharArrayUnion<APFloat> FpValBuf;
};

/// FAddend is used to represent floating-point addend. An addend is
/// represented as <C, V>, where the V is a symbolic value, and C is a
/// constant coefficient. A constant addend is represented as <C, 0>.
class FAddend {
public:
  FAddend() = default;

  void operator+=(const FAddend &T) {
    assert((Val == T.Val) && "Symbolic-values disagree")(static_cast <bool> ((Val == T.Val) && "Symbolic-values disagree"
) ? void (0) : __assert_fail ("(Val == T.Val) && \"Symbolic-values disagree\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 134
, __extension__ __PRETTY_FUNCTION__));
    Coeff += T.Coeff;
  }

  Value *getSymVal() const { return Val; }
  const FAddendCoef &getCoef() const { return Coeff; }

  bool isConstant() const { return Val == nullptr; }
  bool isZero() const { return Coeff.isZero(); }

  void set(short Coefficient, Value *V) {
    Coeff.set(Coefficient);
    Val = V;
  }
  void set(const APFloat &Coefficient, Value *V) {
    Coeff.set(Coefficient);
    Val = V;
  }
  void set(const ConstantFP *Coefficient, Value *V) {
    Coeff.set(Coefficient->getValueAPF());
    Val = V;
  }

  void negate() { Coeff.negate(); }

  /// Drill down the U-D chain one step to find the definition of V, and
  /// try to break the definition into one or two addends.
  static unsigned drillValueDownOneStep(Value* V, FAddend &A0, FAddend &A1);

  /// Similar to FAddend::drillDownOneStep() except that the value being
  /// splitted is the addend itself.
  unsigned drillAddendDownOneStep(FAddend &Addend0, FAddend &Addend1) const;

private:
  void Scale(const FAddendCoef& ScaleAmt) { Coeff *= ScaleAmt; }

  // This addend has the value of "Coeff * Val".
  Value *Val = nullptr;
  FAddendCoef Coeff;
};

/// FAddCombine is the class for optimizing an unsafe fadd/fsub along
/// with its neighboring at most two instructions.
///
class FAddCombine {
public:
  FAddCombine(InstCombiner::BuilderTy &B) : Builder(B) {}

  Value *simplify(Instruction *FAdd);

private:
  using AddendVect = SmallVector<const FAddend *, 4>;

  Value *simplifyFAdd(AddendVect& V, unsigned InstrQuota);

  /// Convert given addend to a Value
  Value *createAddendVal(const FAddend &A, bool& NeedNeg);

  /// Return the number of instructions needed to emit the N-ary addition.
  unsigned calcInstrNumber(const AddendVect& Vect);

  Value *createFSub(Value *Opnd0, Value *Opnd1);
  Value *createFAdd(Value *Opnd0, Value *Opnd1);
  Value *createFMul(Value *Opnd0, Value *Opnd1);
  Value *createFNeg(Value *V);
  Value *createNaryFAdd(const AddendVect& Opnds, unsigned InstrQuota);
  void createInstPostProc(Instruction *NewInst, bool NoNumber = false);

   // Debugging stuff are clustered here.
  #ifndef NDEBUG
    unsigned CreateInstrNum;
    void initCreateInstNum() { CreateInstrNum = 0; }
    void incCreateInstNum() { CreateInstrNum++; }
  #else
    void initCreateInstNum() {}
    void incCreateInstNum() {}
  #endif

  InstCombiner::BuilderTy &Builder;
  Instruction *Instr = nullptr;
};

216} // end anonymous namespace

218//===----------------------------------------------------------------------===//
219//
220// Implementation of
221//    {FAddendCoef, FAddend, FAddition, FAddCombine}.
222//
223//===----------------------------------------------------------------------===//
224FAddendCoef::~FAddendCoef() {
if (BufHasFpVal)
  getFpValPtr()->~APFloat();
227}

229void FAddendCoef::set(const APFloat& C) {
APFloat *P = getFpValPtr();

if (isInt()) {
  // As the buffer is meanless byte stream, we cannot call
  // APFloat::operator=().
  new(P) APFloat(C);
} else
  *P = C;

IsFp = BufHasFpVal = true;
240}

242void FAddendCoef::convertToFpType(const fltSemantics &Sem) {
if (!isInt())
  return;

APFloat *P = getFpValPtr();
if (IntVal > 0)
  new(P) APFloat(Sem, IntVal);
else {
  new(P) APFloat(Sem, 0 - IntVal);
  P->changeSign();
}
IsFp = BufHasFpVal = true;
254}

256APFloat FAddendCoef::createAPFloatFromInt(const fltSemantics &Sem, int Val) {
if (Val >= 0)
  return APFloat(Sem, Val);

APFloat T(Sem, 0 - Val);
T.changeSign();

return T;
264}

266void FAddendCoef::operator=(const FAddendCoef &That) {
if (That.isInt())
  set(That.IntVal);
else
  set(That.getFpVal());
271}

273void FAddendCoef::operator+=(const FAddendCoef &That) {
RoundingMode RndMode = RoundingMode::NearestTiesToEven;
if (isInt() == That.isInt()) {
  if (isInt())
    IntVal += That.IntVal;
  else
    getFpVal().add(That.getFpVal(), RndMode);
  return;
}

if (isInt()) {
  const APFloat &T = That.getFpVal();
  convertToFpType(T.getSemantics());
  getFpVal().add(T, RndMode);
  return;
}

APFloat &T = getFpVal();
T.add(createAPFloatFromInt(T.getSemantics(), That.IntVal), RndMode);
292}

294void FAddendCoef::operator*=(const FAddendCoef &That) {
if (That.isOne())
  return;

if (That.isMinusOne()) {
  negate();
  return;
}

if (isInt() && That.isInt()) {
  int Res = IntVal * (int)That.IntVal;
  assert(!insaneIntVal(Res) && "Insane int value")(static_cast <bool> (!insaneIntVal(Res) && "Insane int value"
) ? void (0) : __assert_fail ("!insaneIntVal(Res) && \"Insane int value\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 305
, __extension__ __PRETTY_FUNCTION__));
  IntVal = Res;
  return;
}

const fltSemantics &Semantic =
  isInt() ? That.getFpVal().getSemantics() : getFpVal().getSemantics();

if (isInt())
  convertToFpType(Semantic);
APFloat &F0 = getFpVal();

if (That.isInt())
  F0.multiply(createAPFloatFromInt(Semantic, That.IntVal),
              APFloat::rmNearestTiesToEven);
else
  F0.multiply(That.getFpVal(), APFloat::rmNearestTiesToEven);
322}

324void FAddendCoef::negate() {
if (isInt())
  IntVal = 0 - IntVal;
else
  getFpVal().changeSign();
329}

331Value *FAddendCoef::getValue(Type *Ty) const {
return isInt() ?
  ConstantFP::get(Ty, float(IntVal)) :
  ConstantFP::get(Ty->getContext(), getFpVal());
335}

337// The definition of <Val>     Addends
338// =========================================
339//  A + B                     <1, A>, <1,B>
340//  A - B                     <1, A>, <1,B>
341//  0 - B                     <-1, B>
342//  C * A,                    <C, A>
343//  A + C                     <1, A> <C, NULL>
344//  0 +/- 0                   <0, NULL> (corner case)
345//
346// Legend: A and B are not constant, C is constant
347unsigned FAddend::drillValueDownOneStep
(Value *Val, FAddend &Addend0, FAddend &Addend1) {
Instruction *I = nullptr;
if (!Val || !(I = dyn_cast<Instruction>(Val)))
  return 0;

unsigned Opcode = I->getOpcode();

if (Opcode == Instruction::FAdd || Opcode == Instruction::FSub) {
  ConstantFP *C0, *C1;
  Value *Opnd0 = I->getOperand(0);
  Value *Opnd1 = I->getOperand(1);
  if ((C0 = dyn_cast<ConstantFP>(Opnd0)) && C0->isZero())
    Opnd0 = nullptr;

  if ((C1 = dyn_cast<ConstantFP>(Opnd1)) && C1->isZero())
    Opnd1 = nullptr;

  if (Opnd0) {
    if (!C0)
      Addend0.set(1, Opnd0);
    else
      Addend0.set(C0, nullptr);
  }

  if (Opnd1) {
    FAddend &Addend = Opnd0 ? Addend1 : Addend0;
    if (!C1)
      Addend.set(1, Opnd1);
    else
      Addend.set(C1, nullptr);
    if (Opcode == Instruction::FSub)
      Addend.negate();
  }

  if (Opnd0 || Opnd1)
    return Opnd0 && Opnd1 ? 2 : 1;

  // Both operands are zero. Weird!
  Addend0.set(APFloat(C0->getValueAPF().getSemantics()), nullptr);
  return 1;
}

if (I->getOpcode() == Instruction::FMul) {
  Value *V0 = I->getOperand(0);
  Value *V1 = I->getOperand(1);
  if (ConstantFP *C = dyn_cast<ConstantFP>(V0)) {
    Addend0.set(C, V1);
    return 1;
  }

  if (ConstantFP *C = dyn_cast<ConstantFP>(V1)) {
    Addend0.set(C, V0);
    return 1;
  }
}

return 0;
405}

407// Try to break *this* addend into two addends. e.g. Suppose this addend is
408// <2.3, V>, and V = X + Y, by calling this function, we obtain two addends,
409// i.e. <2.3, X> and <2.3, Y>.
410unsigned FAddend::drillAddendDownOneStep
(FAddend &Addend0, FAddend &Addend1) const {
if (isConstant())
  return 0;

unsigned BreakNum = FAddend::drillValueDownOneStep(Val, Addend0, Addend1);
if (!BreakNum || Coeff.isOne())
  return BreakNum;

Addend0.Scale(Coeff);

if (BreakNum == 2)
  Addend1.Scale(Coeff);

return BreakNum;
425}

427Value *FAddCombine::simplify(Instruction *I) {
assert(I->hasAllowReassoc() && I->hasNoSignedZeros() &&(static_cast <bool> (I->hasAllowReassoc() &&
 I->hasNoSignedZeros() && "Expected 'reassoc'+'nsz' instruction"
) ? void (0) : __assert_fail ("I->hasAllowReassoc() && I->hasNoSignedZeros() && \"Expected 'reassoc'+'nsz' instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 429
, __extension__ __PRETTY_FUNCTION__))
       "Expected 'reassoc'+'nsz' instruction")(static_cast <bool> (I->hasAllowReassoc() &&
 I->hasNoSignedZeros() && "Expected 'reassoc'+'nsz' instruction"
) ? void (0) : __assert_fail ("I->hasAllowReassoc() && I->hasNoSignedZeros() && \"Expected 'reassoc'+'nsz' instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 429
, __extension__ __PRETTY_FUNCTION__));

// Currently we are not able to handle vector type.
if (I->getType()->isVectorTy())
  return nullptr;

assert((I->getOpcode() == Instruction::FAdd ||(static_cast <bool> ((I->getOpcode() == Instruction::
FAdd || I->getOpcode() == Instruction::FSub) && "Expect add/sub"
) ? void (0) : __assert_fail ("(I->getOpcode() == Instruction::FAdd || I->getOpcode() == Instruction::FSub) && \"Expect add/sub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 436
, __extension__ __PRETTY_FUNCTION__))
        I->getOpcode() == Instruction::FSub) && "Expect add/sub")(static_cast <bool> ((I->getOpcode() == Instruction::
FAdd || I->getOpcode() == Instruction::FSub) && "Expect add/sub"
) ? void (0) : __assert_fail ("(I->getOpcode() == Instruction::FAdd || I->getOpcode() == Instruction::FSub) && \"Expect add/sub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 436
, __extension__ __PRETTY_FUNCTION__));

// Save the instruction before calling other member-functions.
Instr = I;

FAddend Opnd0, Opnd1, Opnd0_0, Opnd0_1, Opnd1_0, Opnd1_1;

unsigned OpndNum = FAddend::drillValueDownOneStep(I, Opnd0, Opnd1);

// Step 1: Expand the 1st addend into Opnd0_0 and Opnd0_1.
unsigned Opnd0_ExpNum = 0;
unsigned Opnd1_ExpNum = 0;

if (!Opnd0.isConstant())
  Opnd0_ExpNum = Opnd0.drillAddendDownOneStep(Opnd0_0, Opnd0_1);

// Step 2: Expand the 2nd addend into Opnd1_0 and Opnd1_1.
if (OpndNum == 2 && !Opnd1.isConstant())
  Opnd1_ExpNum = Opnd1.drillAddendDownOneStep(Opnd1_0, Opnd1_1);

// Step 3: Try to optimize Opnd0_0 + Opnd0_1 + Opnd1_0 + Opnd1_1
if (Opnd0_ExpNum && Opnd1_ExpNum) {
  AddendVect AllOpnds;
  AllOpnds.push_back(&Opnd0_0);
  AllOpnds.push_back(&Opnd1_0);
  if (Opnd0_ExpNum == 2)
    AllOpnds.push_back(&Opnd0_1);
  if (Opnd1_ExpNum == 2)
    AllOpnds.push_back(&Opnd1_1);

  // Compute instruction quota. We should save at least one instruction.
  unsigned InstQuota = 0;

  Value *V0 = I->getOperand(0);
  Value *V1 = I->getOperand(1);
  InstQuota = ((!isa<Constant>(V0) && V0->hasOneUse()) &&
               (!isa<Constant>(V1) && V1->hasOneUse())) ? 2 : 1;

  if (Value *R = simplifyFAdd(AllOpnds, InstQuota))
    return R;
}

if (OpndNum != 2) {
  // The input instruction is : "I=0.0 +/- V". If the "V" were able to be
  // splitted into two addends, say "V = X - Y", the instruction would have
  // been optimized into "I = Y - X" in the previous steps.
  //
  const FAddendCoef &CE = Opnd0.getCoef();
  return CE.isOne() ? Opnd0.getSymVal() : nullptr;
}

// step 4: Try to optimize Opnd0 + Opnd1_0 [+ Opnd1_1]
if (Opnd1_ExpNum) {
  AddendVect AllOpnds;
  AllOpnds.push_back(&Opnd0);
  AllOpnds.push_back(&Opnd1_0);
  if (Opnd1_ExpNum == 2)
    AllOpnds.push_back(&Opnd1_1);

  if (Value *R = simplifyFAdd(AllOpnds, 1))
    return R;
}

// step 5: Try to optimize Opnd1 + Opnd0_0 [+ Opnd0_1]
if (Opnd0_ExpNum) {
  AddendVect AllOpnds;
  AllOpnds.push_back(&Opnd1);
  AllOpnds.push_back(&Opnd0_0);
  if (Opnd0_ExpNum == 2)
    AllOpnds.push_back(&Opnd0_1);

  if (Value *R = simplifyFAdd(AllOpnds, 1))
    return R;
}

return nullptr;
512}

514Value *FAddCombine::simplifyFAdd(AddendVect& Addends, unsigned InstrQuota) {
unsigned AddendNum = Addends.size();
assert(AddendNum <= 4 && "Too many addends")(static_cast <bool> (AddendNum <= 4 && "Too many addends"
) ? void (0) : __assert_fail ("AddendNum <= 4 && \"Too many addends\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 516
, __extension__ __PRETTY_FUNCTION__));

// For saving intermediate results;
unsigned NextTmpIdx = 0;
FAddend TmpResult[3];

// Simplified addends are placed <SimpVect>.
AddendVect SimpVect;

// The outer loop works on one symbolic-value at a time. Suppose the input
// addends are : <a1, x>, <b1, y>, <a2, x>, <c1, z>, <b2, y>, ...
// The symbolic-values will be processed in this order: x, y, z.
for (unsigned SymIdx = 0; SymIdx < AddendNum; SymIdx++) {

  const FAddend *ThisAddend = Addends[SymIdx];
  if (!ThisAddend) {
    // This addend was processed before.
    continue;
  }

  Value *Val = ThisAddend->getSymVal();

  // If the resulting expr has constant-addend, this constant-addend is
  // desirable to reside at the top of the resulting expression tree. Placing
  // constant close to super-expr(s) will potentially reveal some
  // optimization opportunities in super-expr(s). Here we do not implement
  // this logic intentionally and rely on SimplifyAssociativeOrCommutative
  // call later.

  unsigned StartIdx = SimpVect.size();
  SimpVect.push_back(ThisAddend);

  // The inner loop collects addends sharing same symbolic-value, and these
  // addends will be later on folded into a single addend. Following above
  // example, if the symbolic value "y" is being processed, the inner loop
  // will collect two addends "<b1,y>" and "<b2,Y>". These two addends will
  // be later on folded into "<b1+b2, y>".
  for (unsigned SameSymIdx = SymIdx + 1;
       SameSymIdx < AddendNum; SameSymIdx++) {
    const FAddend *T = Addends[SameSymIdx];
    if (T && T->getSymVal() == Val) {
      // Set null such that next iteration of the outer loop will not process
      // this addend again.
      Addends[SameSymIdx] = nullptr;
      SimpVect.push_back(T);
    }
  }

  // If multiple addends share same symbolic value, fold them together.
  if (StartIdx + 1 != SimpVect.size()) {
    FAddend &R = TmpResult[NextTmpIdx ++];
    R = *SimpVect[StartIdx];
    for (unsigned Idx = StartIdx + 1; Idx < SimpVect.size(); Idx++)
      R += *SimpVect[Idx];

    // Pop all addends being folded and push the resulting folded addend.
    SimpVect.resize(StartIdx);
    if (!R.isZero()) {
      SimpVect.push_back(&R);
    }
  }
}

assert((NextTmpIdx <= std::size(TmpResult) + 1) && "out-of-bound access")(static_cast <bool> ((NextTmpIdx <= std::size(TmpResult
) + 1) && "out-of-bound access") ? void (0) : __assert_fail
 ("(NextTmpIdx <= std::size(TmpResult) + 1) && \"out-of-bound access\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 579
, __extension__ __PRETTY_FUNCTION__));

Value *Result;
if (!SimpVect.empty())
  Result = createNaryFAdd(SimpVect, InstrQuota);
else {
  // The addition is folded to 0.0.
  Result = ConstantFP::get(Instr->getType(), 0.0);
}

return Result;
590}

592Value *FAddCombine::createNaryFAdd
(const AddendVect &Opnds, unsigned InstrQuota) {
assert(!Opnds.empty() && "Expect at least one addend")(static_cast <bool> (!Opnds.empty() && "Expect at least one addend"
) ? void (0) : __assert_fail ("!Opnds.empty() && \"Expect at least one addend\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 594
, __extension__ __PRETTY_FUNCTION__));

// Step 1: Check if the # of instructions needed exceeds the quota.

unsigned InstrNeeded = calcInstrNumber(Opnds);
if (InstrNeeded > InstrQuota)
  return nullptr;

initCreateInstNum();

// step 2: Emit the N-ary addition.
// Note that at most three instructions are involved in Fadd-InstCombine: the
// addition in question, and at most two neighboring instructions.
// The resulting optimized addition should have at least one less instruction
// than the original addition expression tree. This implies that the resulting
// N-ary addition has at most two instructions, and we don't need to worry
// about tree-height when constructing the N-ary addition.

Value *LastVal = nullptr;
bool LastValNeedNeg = false;

// Iterate the addends, creating fadd/fsub using adjacent two addends.
for (const FAddend *Opnd : Opnds) {
  bool NeedNeg;
  Value *V = createAddendVal(*Opnd, NeedNeg);
  if (!LastVal) {
    LastVal = V;
    LastValNeedNeg = NeedNeg;
    continue;
  }

  if (LastValNeedNeg == NeedNeg) {
    LastVal = createFAdd(LastVal, V);
    continue;
  }

  if (LastValNeedNeg)
    LastVal = createFSub(V, LastVal);
  else
    LastVal = createFSub(LastVal, V);

  LastValNeedNeg = false;
}

if (LastValNeedNeg) {
  LastVal = createFNeg(LastVal);
}

642#ifndef NDEBUG
assert(CreateInstrNum == InstrNeeded &&(static_cast <bool> (CreateInstrNum == InstrNeeded &&
 "Inconsistent in instruction numbers") ? void (0) : __assert_fail
 ("CreateInstrNum == InstrNeeded && \"Inconsistent in instruction numbers\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 644
, __extension__ __PRETTY_FUNCTION__))
       "Inconsistent in instruction numbers")(static_cast <bool> (CreateInstrNum == InstrNeeded &&
 "Inconsistent in instruction numbers") ? void (0) : __assert_fail
 ("CreateInstrNum == InstrNeeded && \"Inconsistent in instruction numbers\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 644
, __extension__ __PRETTY_FUNCTION__));
645#endif

return LastVal;
648}

650Value *FAddCombine::createFSub(Value *Opnd0, Value *Opnd1) {
Value *V = Builder.CreateFSub(Opnd0, Opnd1);
if (Instruction *I = dyn_cast<Instruction>(V))
  createInstPostProc(I);
return V;
655}

657Value *FAddCombine::createFNeg(Value *V) {
Value *NewV = Builder.CreateFNeg(V);
if (Instruction *I = dyn_cast<Instruction>(NewV))
  createInstPostProc(I, true); // fneg's don't receive instruction numbers.
return NewV;
662}

664Value *FAddCombine::createFAdd(Value *Opnd0, Value *Opnd1) {
Value *V = Builder.CreateFAdd(Opnd0, Opnd1);
if (Instruction *I = dyn_cast<Instruction>(V))
  createInstPostProc(I);
return V;
669}

671Value *FAddCombine::createFMul(Value *Opnd0, Value *Opnd1) {
Value *V = Builder.CreateFMul(Opnd0, Opnd1);
if (Instruction *I = dyn_cast<Instruction>(V))
  createInstPostProc(I);
return V;
676}

678void FAddCombine::createInstPostProc(Instruction *NewInstr, bool NoNumber) {
NewInstr->setDebugLoc(Instr->getDebugLoc());

// Keep track of the number of instruction created.
if (!NoNumber)
  incCreateInstNum();

// Propagate fast-math flags
NewInstr->setFastMathFlags(Instr->getFastMathFlags());
687}

689// Return the number of instruction needed to emit the N-ary addition.
690// NOTE: Keep this function in sync with createAddendVal().
691unsigned FAddCombine::calcInstrNumber(const AddendVect &Opnds) {
unsigned OpndNum = Opnds.size();
unsigned InstrNeeded = OpndNum - 1;

// Adjust the number of instructions needed to emit the N-ary add.
for (const FAddend *Opnd : Opnds) {
  if (Opnd->isConstant())
    continue;

  // The constant check above is really for a few special constant
  // coefficients.
  if (isa<UndefValue>(Opnd->getSymVal()))
    continue;

  const FAddendCoef &CE = Opnd->getCoef();
  // Let the addend be "c * x". If "c == +/-1", the value of the addend
  // is immediately available; otherwise, it needs exactly one instruction
  // to evaluate the value.
  if (!CE.isMinusOne() && !CE.isOne())
    InstrNeeded++;
}
return InstrNeeded;
713}

715// Input Addend        Value           NeedNeg(output)
716// ================================================================
717// Constant C          C               false
718// <+/-1, V>           V               coefficient is -1
719// <2/-2, V>          "fadd V, V"      coefficient is -2
720// <C, V>             "fmul V, C"      false
721//
722// NOTE: Keep this function in sync with FAddCombine::calcInstrNumber.
723Value *FAddCombine::createAddendVal(const FAddend &Opnd, bool &NeedNeg) {
const FAddendCoef &Coeff = Opnd.getCoef();

if (Opnd.isConstant()) {
  NeedNeg = false;
  return Coeff.getValue(Instr->getType());
}

Value *OpndVal = Opnd.getSymVal();

if (Coeff.isMinusOne() || Coeff.isOne()) {
  NeedNeg = Coeff.isMinusOne();
  return OpndVal;
}

if (Coeff.isTwo() || Coeff.isMinusTwo()) {
  NeedNeg = Coeff.isMinusTwo();
  return createFAdd(OpndVal, OpndVal);
}

NeedNeg = false;
return createFMul(OpndVal, Coeff.getValue(Instr->getType()));
745}

747// Checks if any operand is negative and we can convert add to sub.
748// This function checks for following negative patterns
749//   ADD(XOR(OR(Z, NOT(C)), C)), 1) == NEG(AND(Z, C))
750//   ADD(XOR(AND(Z, C), C), 1) == NEG(OR(Z, ~C))
751//   XOR(AND(Z, C), (C + 1)) == NEG(OR(Z, ~C)) if C is even
752static Value *checkForNegativeOperand(BinaryOperator &I,
                                    InstCombiner::BuilderTy &Builder) {
Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);

// This function creates 2 instructions to replace ADD, we need at least one
// of LHS or RHS to have one use to ensure benefit in transform.
if (!LHS->hasOneUse() && !RHS->hasOneUse())
  return nullptr;

Value *X = nullptr, *Y = nullptr, *Z = nullptr;
const APInt *C1 = nullptr, *C2 = nullptr;

// if ONE is on other side, swap
if (match(RHS, m_Add(m_Value(X), m_One())))
  std::swap(LHS, RHS);

if (match(LHS, m_Add(m_Value(X), m_One()))) {
  // if XOR on other side, swap
  if (match(RHS, m_Xor(m_Value(Y), m_APInt(C1))))
    std::swap(X, RHS);

  if (match(X, m_Xor(m_Value(Y), m_APInt(C1)))) {
    // X = XOR(Y, C1), Y = OR(Z, C2), C2 = NOT(C1) ==> X == NOT(AND(Z, C1))
    // ADD(ADD(X, 1), RHS) == ADD(X, ADD(RHS, 1)) == SUB(RHS, AND(Z, C1))
    if (match(Y, m_Or(m_Value(Z), m_APInt(C2))) && (*C2 == ~(*C1))) {
      Value *NewAnd = Builder.CreateAnd(Z, *C1);
      return Builder.CreateSub(RHS, NewAnd, "sub");
    } else if (match(Y, m_And(m_Value(Z), m_APInt(C2))) && (*C1 == *C2)) {
      // X = XOR(Y, C1), Y = AND(Z, C2), C2 == C1 ==> X == NOT(OR(Z, ~C1))
      // ADD(ADD(X, 1), RHS) == ADD(X, ADD(RHS, 1)) == SUB(RHS, OR(Z, ~C1))
      Value *NewOr = Builder.CreateOr(Z, ~(*C1));
      return Builder.CreateSub(RHS, NewOr, "sub");
    }
  }
}

// Restore LHS and RHS
LHS = I.getOperand(0);
RHS = I.getOperand(1);

// if XOR is on other side, swap
if (match(RHS, m_Xor(m_Value(Y), m_APInt(C1))))
  std::swap(LHS, RHS);

// C2 is ODD
// LHS = XOR(Y, C1), Y = AND(Z, C2), C1 == (C2 + 1) => LHS == NEG(OR(Z, ~C2))
// ADD(LHS, RHS) == SUB(RHS, OR(Z, ~C2))
if (match(LHS, m_Xor(m_Value(Y), m_APInt(C1))))
  if (C1->countr_zero() == 0)
    if (match(Y, m_And(m_Value(Z), m_APInt(C2))) && *C1 == (*C2 + 1)) {
      Value *NewOr = Builder.CreateOr(Z, ~(*C2));
      return Builder.CreateSub(RHS, NewOr, "sub");
    }
return nullptr;
806}

808/// Wrapping flags may allow combining constants separated by an extend.
809static Instruction *foldNoWrapAdd(BinaryOperator &Add,
                                InstCombiner::BuilderTy &Builder) {
Value *Op0 = Add.getOperand(0), *Op1 = Add.getOperand(1);
Type *Ty = Add.getType();
Constant *Op1C;
if (!match(Op1, m_Constant(Op1C)))
  return nullptr;

// Try this match first because it results in an add in the narrow type.
// (zext (X +nuw C2)) + C1 --> zext (X + (C2 + trunc(C1)))
Value *X;
const APInt *C1, *C2;
if (match(Op1, m_APInt(C1)) &&
    match(Op0, m_OneUse(m_ZExt(m_NUWAdd(m_Value(X), m_APInt(C2))))) &&
    C1->isNegative() && C1->sge(-C2->sext(C1->getBitWidth()))) {
  Constant *NewC =
      ConstantInt::get(X->getType(), *C2 + C1->trunc(C2->getBitWidth()));
  return new ZExtInst(Builder.CreateNUWAdd(X, NewC), Ty);
}

// More general combining of constants in the wide type.
// (sext (X +nsw NarrowC)) + C --> (sext X) + (sext(NarrowC) + C)
Constant *NarrowC;
if (match(Op0, m_OneUse(m_SExt(m_NSWAdd(m_Value(X), m_Constant(NarrowC)))))) {
  Constant *WideC = ConstantExpr::getSExt(NarrowC, Ty);
  Constant *NewC = ConstantExpr::getAdd(WideC, Op1C);
  Value *WideX = Builder.CreateSExt(X, Ty);
  return BinaryOperator::CreateAdd(WideX, NewC);
}
// (zext (X +nuw NarrowC)) + C --> (zext X) + (zext(NarrowC) + C)
if (match(Op0, m_OneUse(m_ZExt(m_NUWAdd(m_Value(X), m_Constant(NarrowC)))))) {
  Constant *WideC = ConstantExpr::getZExt(NarrowC, Ty);
  Constant *NewC = ConstantExpr::getAdd(WideC, Op1C);
  Value *WideX = Builder.CreateZExt(X, Ty);
  return BinaryOperator::CreateAdd(WideX, NewC);
}

return nullptr;
847}

849Instruction *InstCombinerImpl::foldAddWithConstant(BinaryOperator &Add) {
Value *Op0 = Add.getOperand(0), *Op1 = Add.getOperand(1);
Type *Ty = Add.getType();
Constant *Op1C;
if (!match(Op1, m_ImmConstant(Op1C)))
  return nullptr;

if (Instruction *NV = foldBinOpIntoSelectOrPhi(Add))
  return NV;

Value *X;
Constant *Op00C;

// add (sub C1, X), C2 --> sub (add C1, C2), X
if (match(Op0, m_Sub(m_Constant(Op00C), m_Value(X))))
  return BinaryOperator::CreateSub(ConstantExpr::getAdd(Op00C, Op1C), X);

Value *Y;

// add (sub X, Y), -1 --> add (not Y), X
if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y)))) &&
    match(Op1, m_AllOnes()))
  return BinaryOperator::CreateAdd(Builder.CreateNot(Y), X);

// zext(bool) + C -> bool ? C + 1 : C
if (match(Op0, m_ZExt(m_Value(X))) &&
    X->getType()->getScalarSizeInBits() == 1)
  return SelectInst::Create(X, InstCombiner::AddOne(Op1C), Op1);
// sext(bool) + C -> bool ? C - 1 : C
if (match(Op0, m_SExt(m_Value(X))) &&
    X->getType()->getScalarSizeInBits() == 1)
  return SelectInst::Create(X, InstCombiner::SubOne(Op1C), Op1);

// ~X + C --> (C-1) - X
if (match(Op0, m_Not(m_Value(X))))
  return BinaryOperator::CreateSub(InstCombiner::SubOne(Op1C), X);

// (iN X s>> (N - 1)) + 1 --> zext (X > -1)
const APInt *C;
unsigned BitWidth = Ty->getScalarSizeInBits();
if (match(Op0, m_OneUse(m_AShr(m_Value(X),
                               m_SpecificIntAllowUndef(BitWidth - 1)))) &&
    match(Op1, m_One()))
  return new ZExtInst(Builder.CreateIsNotNeg(X, "isnotneg"), Ty);

if (!match(Op1, m_APInt(C)))
  return nullptr;

// (X | Op01C) + Op1C --> X + (Op01C + Op1C) iff the `or` is actually an `add`
Constant *Op01C;
if (match(Op0, m_Or(m_Value(X), m_ImmConstant(Op01C))) &&
    haveNoCommonBitsSet(X, Op01C, DL, &AC, &Add, &DT))
  return BinaryOperator::CreateAdd(X, ConstantExpr::getAdd(Op01C, Op1C));

// (X | C2) + C --> (X | C2) ^ C2 iff (C2 == -C)
const APInt *C2;
if (match(Op0, m_Or(m_Value(), m_APInt(C2))) && *C2 == -*C)
  return BinaryOperator::CreateXor(Op0, ConstantInt::get(Add.getType(), *C2));

if (C->isSignMask()) {
  // If wrapping is not allowed, then the addition must set the sign bit:
  // X + (signmask) --> X | signmask
  if (Add.hasNoSignedWrap() || Add.hasNoUnsignedWrap())
    return BinaryOperator::CreateOr(Op0, Op1);

  // If wrapping is allowed, then the addition flips the sign bit of LHS:
  // X + (signmask) --> X ^ signmask
  return BinaryOperator::CreateXor(Op0, Op1);
}

// Is this add the last step in a convoluted sext?
// add(zext(xor i16 X, -32768), -32768) --> sext X
if (match(Op0, m_ZExt(m_Xor(m_Value(X), m_APInt(C2)))) &&
    C2->isMinSignedValue() && C2->sext(Ty->getScalarSizeInBits()) == *C)
  return CastInst::Create(Instruction::SExt, X, Ty);

if (match(Op0, m_Xor(m_Value(X), m_APInt(C2)))) {
  // (X ^ signmask) + C --> (X + (signmask ^ C))
  if (C2->isSignMask())
    return BinaryOperator::CreateAdd(X, ConstantInt::get(Ty, *C2 ^ *C));

  // If X has no high-bits set above an xor mask:
  // add (xor X, LowMaskC), C --> sub (LowMaskC + C), X
  if (C2->isMask()) {
    KnownBits LHSKnown = computeKnownBits(X, 0, &Add);
    if ((*C2 | LHSKnown.Zero).isAllOnes())
      return BinaryOperator::CreateSub(ConstantInt::get(Ty, *C2 + *C), X);
  }

  // Look for a math+logic pattern that corresponds to sext-in-register of a
  // value with cleared high bits. Convert that into a pair of shifts:
  // add (xor X, 0x80), 0xF..F80 --> (X << ShAmtC) >>s ShAmtC
  // add (xor X, 0xF..F80), 0x80 --> (X << ShAmtC) >>s ShAmtC
  if (Op0->hasOneUse() && *C2 == -(*C)) {
    unsigned BitWidth = Ty->getScalarSizeInBits();
    unsigned ShAmt = 0;
    if (C->isPowerOf2())
      ShAmt = BitWidth - C->logBase2() - 1;
    else if (C2->isPowerOf2())
      ShAmt = BitWidth - C2->logBase2() - 1;
    if (ShAmt && MaskedValueIsZero(X, APInt::getHighBitsSet(BitWidth, ShAmt),
                                   0, &Add)) {
      Constant *ShAmtC = ConstantInt::get(Ty, ShAmt);
      Value *NewShl = Builder.CreateShl(X, ShAmtC, "sext");
      return BinaryOperator::CreateAShr(NewShl, ShAmtC);
    }
  }
}

if (C->isOne() && Op0->hasOneUse()) {
  // add (sext i1 X), 1 --> zext (not X)
  // TODO: The smallest IR representation is (select X, 0, 1), and that would
  // not require the one-use check. But we need to remove a transform in
  // visitSelect and make sure that IR value tracking for select is equal or
  // better than for these ops.
  if (match(Op0, m_SExt(m_Value(X))) &&
      X->getType()->getScalarSizeInBits() == 1)
    return new ZExtInst(Builder.CreateNot(X), Ty);

  // Shifts and add used to flip and mask off the low bit:
  // add (ashr (shl i32 X, 31), 31), 1 --> and (not X), 1
  const APInt *C3;
  if (match(Op0, m_AShr(m_Shl(m_Value(X), m_APInt(C2)), m_APInt(C3))) &&
      C2 == C3 && *C2 == Ty->getScalarSizeInBits() - 1) {
    Value *NotX = Builder.CreateNot(X);
    return BinaryOperator::CreateAnd(NotX, ConstantInt::get(Ty, 1));
  }
}

// Fold (add (zext (add X, -1)), 1) -> (zext X) if X is non-zero.
// TODO: There's a general form for any constant on the outer add.
if (C->isOne()) {
  if (match(Op0, m_ZExt(m_Add(m_Value(X), m_AllOnes())))) {
    const SimplifyQuery Q = SQ.getWithInstruction(&Add);
    if (llvm::isKnownNonZero(X, DL, 0, Q.AC, Q.CxtI, Q.DT))
      return new ZExtInst(X, Ty);
  }
}

return nullptr;
989}

991// Matches multiplication expression Op * C where C is a constant. Returns the
992// constant value in C and the other operand in Op. Returns true if such a
993// match is found.
994static bool MatchMul(Value *E, Value *&Op, APInt &C) {
const APInt *AI;
if (match(E, m_Mul(m_Value(Op), m_APInt(AI)))) {
  C = *AI;
  return true;
}
if (match(E, m_Shl(m_Value(Op), m_APInt(AI)))) {
  C = APInt(AI->getBitWidth(), 1);
  C <<= *AI;
  return true;
}
return false;
1006}

1008// Matches remainder expression Op % C where C is a constant. Returns the
1009// constant value in C and the other operand in Op. Returns the signedness of
1010// the remainder operation in IsSigned. Returns true if such a match is
1011// found.
1012static bool MatchRem(Value *E, Value *&Op, APInt &C, bool &IsSigned) {
const APInt *AI;
IsSigned = false;
if (match(E, m_SRem(m_Value(Op), m_APInt(AI)))) {
  IsSigned = true;
  C = *AI;
  return true;
}
if (match(E, m_URem(m_Value(Op), m_APInt(AI)))) {
  C = *AI;
  return true;
}
if (match(E, m_And(m_Value(Op), m_APInt(AI))) && (*AI + 1).isPowerOf2()) {
  C = *AI + 1;
  return true;
}
return false;
1029}

1031// Matches division expression Op / C with the given signedness as indicated
1032// by IsSigned, where C is a constant. Returns the constant value in C and the
1033// other operand in Op. Returns true if such a match is found.
1034static bool MatchDiv(Value *E, Value *&Op, APInt &C, bool IsSigned) {
const APInt *AI;
if (IsSigned && match(E, m_SDiv(m_Value(Op), m_APInt(AI)))) {
  C = *AI;
  return true;
}
if (!IsSigned) {
  if (match(E, m_UDiv(m_Value(Op), m_APInt(AI)))) {
    C = *AI;
    return true;
  }
  if (match(E, m_LShr(m_Value(Op), m_APInt(AI)))) {
    C = APInt(AI->getBitWidth(), 1);
    C <<= *AI;
    return true;
  }
}
return false;
1052}

1054// Returns whether C0 * C1 with the given signedness overflows.
1055static bool MulWillOverflow(APInt &C0, APInt &C1, bool IsSigned) {
bool overflow;
if (IsSigned)
  (void)C0.smul_ov(C1, overflow);
else
  (void)C0.umul_ov(C1, overflow);
return overflow;
1062}

1064// Simplifies X % C0 + (( X / C0 ) % C1) * C0 to X % (C0 * C1), where (C0 * C1)
1065// does not overflow.
1066Value *InstCombinerImpl::SimplifyAddWithRemainder(BinaryOperator &I) {
Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
Value *X, *MulOpV;
APInt C0, MulOpC;
bool IsSigned;
// Match I = X % C0 + MulOpV * C0
if (((MatchRem(LHS, X, C0, IsSigned) && MatchMul(RHS, MulOpV, MulOpC)) ||
     (MatchRem(RHS, X, C0, IsSigned) && MatchMul(LHS, MulOpV, MulOpC))) &&
    C0 == MulOpC) {
  Value *RemOpV;
  APInt C1;
  bool Rem2IsSigned;
  // Match MulOpC = RemOpV % C1
  if (MatchRem(MulOpV, RemOpV, C1, Rem2IsSigned) &&
      IsSigned == Rem2IsSigned) {
    Value *DivOpV;
    APInt DivOpC;
    // Match RemOpV = X / C0
    if (MatchDiv(RemOpV, DivOpV, DivOpC, IsSigned) && X == DivOpV &&
        C0 == DivOpC && !MulWillOverflow(C0, C1, IsSigned)) {
      Value *NewDivisor = ConstantInt::get(X->getType(), C0 * C1);
      return IsSigned ? Builder.CreateSRem(X, NewDivisor, "srem")
                      : Builder.CreateURem(X, NewDivisor, "urem");
    }
  }
}

return nullptr;
1094}

1096/// Fold
1097///   (1 << NBits) - 1
1098/// Into:
1099///   ~(-(1 << NBits))
1100/// Because a 'not' is better for bit-tracking analysis and other transforms
1101/// than an 'add'. The new shl is always nsw, and is nuw if old `and` was.
1102static Instruction *canonicalizeLowbitMask(BinaryOperator &I,
                                         InstCombiner::BuilderTy &Builder) {
Value *NBits;
if (!match(&I, m_Add(m_OneUse(m_Shl(m_One(), m_Value(NBits))), m_AllOnes())))
  return nullptr;

Constant *MinusOne = Constant::getAllOnesValue(NBits->getType());
Value *NotMask = Builder.CreateShl(MinusOne, NBits, "notmask");
// Be wary of constant folding.
if (auto *BOp = dyn_cast<BinaryOperator>(NotMask)) {
  // Always NSW. But NUW propagates from `add`.
  BOp->setHasNoSignedWrap();
  BOp->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
}

return BinaryOperator::CreateNot(NotMask, I.getName());
1118}

1120static Instruction *foldToUnsignedSaturatedAdd(BinaryOperator &I) {
assert(I.getOpcode() == Instruction::Add && "Expecting add instruction")(static_cast <bool> (I.getOpcode() == Instruction::Add &&
 "Expecting add instruction") ? void (0) : __assert_fail ("I.getOpcode() == Instruction::Add && \"Expecting add instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1121
, __extension__ __PRETTY_FUNCTION__));
Type *Ty = I.getType();
auto getUAddSat = [&]() {
  return Intrinsic::getDeclaration(I.getModule(), Intrinsic::uadd_sat, Ty);
};

// add (umin X, ~Y), Y --> uaddsat X, Y
Value *X, *Y;
if (match(&I, m_c_Add(m_c_UMin(m_Value(X), m_Not(m_Value(Y))),
                      m_Deferred(Y))))
  return CallInst::Create(getUAddSat(), { X, Y });

// add (umin X, ~C), C --> uaddsat X, C
const APInt *C, *NotC;
if (match(&I, m_Add(m_UMin(m_Value(X), m_APInt(NotC)), m_APInt(C))) &&
    *C == ~*NotC)
  return CallInst::Create(getUAddSat(), { X, ConstantInt::get(Ty, *C) });

return nullptr;
1140}

1142/// Try to reduce signed division by power-of-2 to an arithmetic shift right.
1143static Instruction *foldAddToAshr(BinaryOperator &Add) {
// Division must be by power-of-2, but not the minimum signed value.
Value *X;
const APInt *DivC;
if (!match(Add.getOperand(0), m_SDiv(m_Value(X), m_Power2(DivC))) ||
    DivC->isNegative())
  return nullptr;

// Rounding is done by adding -1 if the dividend (X) is negative and has any
// low bits set. The canonical pattern for that is an "ugt" compare with SMIN:
// sext (icmp ugt (X & (DivC - 1)), SMIN)
const APInt *MaskC;
ICmpInst::Predicate Pred;
if (!match(Add.getOperand(1),
           m_SExt(m_ICmp(Pred, m_And(m_Specific(X), m_APInt(MaskC)),
                         m_SignMask()))) ||
    Pred != ICmpInst::ICMP_UGT)
  return nullptr;

APInt SMin = APInt::getSignedMinValue(Add.getType()->getScalarSizeInBits());
if (*MaskC != (SMin | (*DivC - 1)))
  return nullptr;

// (X / DivC) + sext ((X & (SMin | (DivC - 1)) >u SMin) --> X >>s log2(DivC)
return BinaryOperator::CreateAShr(
    X, ConstantInt::get(Add.getType(), DivC->exactLogBase2()));
1169}

1171Instruction *InstCombinerImpl::
  canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(
      BinaryOperator &I) {
assert((I.getOpcode() == Instruction::Add ||(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction
::Sub) && "Expecting add/or/sub instruction") ? void (
0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction::Sub) && \"Expecting add/or/sub instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1177
, __extension__ __PRETTY_FUNCTION__))
1
Assuming the condition is false→
2
←
Assuming the condition is false→
3
←
Assuming the condition is true→
4
←
'?' condition is true→
        I.getOpcode() == Instruction::Or ||(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction
::Sub) && "Expecting add/or/sub instruction") ? void (
0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction::Sub) && \"Expecting add/or/sub instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1177
, __extension__ __PRETTY_FUNCTION__))
        I.getOpcode() == Instruction::Sub) &&(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction
::Sub) && "Expecting add/or/sub instruction") ? void (
0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction::Sub) && \"Expecting add/or/sub instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1177
, __extension__ __PRETTY_FUNCTION__))
       "Expecting add/or/sub instruction")(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction
::Sub) && "Expecting add/or/sub instruction") ? void (
0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Or || I.getOpcode() == Instruction::Sub) && \"Expecting add/or/sub instruction\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1177
, __extension__ __PRETTY_FUNCTION__));

// We have a subtraction/addition between a (potentially truncated) *logical*
// right-shift of X and a "select".
Value *X, *Select;
Instruction *LowBitsToSkip, *Extract;
if (!match(&I, m_c_BinOp(m_TruncOrSelf(m_CombineAnd(
10
←
Calling 'm_c_BinOp<llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>, 38>, llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>>, llvm::PatternMatch::bind_ty<llvm::Value>>'→
12
←
Returning from 'm_c_BinOp<llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>, 38>, llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>>, llvm::PatternMatch::bind_ty<llvm::Value>>'→
13
←
Calling 'match<llvm::BinaryOperator, llvm::PatternMatch::AnyBinaryOp_match<llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>, 38>, llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>>, llvm::PatternMatch::bind_ty<llvm::Value>, true>>'→
35
←
Returning from 'match<llvm::BinaryOperator, llvm::PatternMatch::AnyBinaryOp_match<llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>, 38>, llvm::PatternMatch::match_combine_and<llvm::PatternMatch::BinaryOp_match<llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Instruction>, 26>, llvm::PatternMatch::bind_ty<llvm::Instruction>>>, llvm::PatternMatch::bind_ty<llvm::Value>, true>>'→
                             m_LShr(m_Value(X), m_Instruction(LowBitsToSkip)),
                             m_Instruction(Extract))),
                         m_Value(Select))))
5
←
Calling 'm_Value'→
9
←
Returning from 'm_Value'→
  return nullptr;

// `add`/`or` is commutative; but for `sub`, "select" *must* be on RHS.
if (I.getOpcode() == Instruction::Sub && I.getOperand(1) != Select)
36
←
Assuming pointer value is null→
37
←
Taking false branch→
  return nullptr;

Type *XTy = X->getType();
bool HadTrunc = I.getType() != XTy;
38
←
Assuming the condition is false→

// If there was a truncation of extracted value, then we'll need to produce
// one extra instruction, so we need to ensure one instruction will go away.
if (HadTrunc38.1
'HadTrunc' is false
1
'HadTrunc' is false
 && !match(&I, m_c_BinOp(m_OneUse(m_Value()), m_Value())))
39
←
Taking false branch→
  return nullptr;

// Extraction should extract high NBits bits, with shift amount calculated as:
//   low bits to skip = shift bitwidth - high bits to extract
// The shift amount itself may be extended, and we need to look past zero-ext
// when matching NBits, that will matter for matching later.
Constant *C;
Value *NBits;
if (!match(
41
←
Taking false branch→
        LowBitsToSkip,
        m_ZExtOrSelf(m_Sub(m_Constant(C), m_ZExtOrSelf(m_Value(NBits))))) ||
    !match(C, m_SpecificInt_ICMP(ICmpInst::Predicate::ICMP_EQ,
40
←
Assuming the condition is false→
                                 APInt(C->getType()->getScalarSizeInBits(),
                                       X->getType()->getScalarSizeInBits()))))
  return nullptr;

// Sign-extending value can be zero-extended if we `sub`tract it,
// or sign-extended otherwise.
auto SkipExtInMagic = [&I](Value *&V) {
  if (I.getOpcode() == Instruction::Sub)
43
←
Taking true branch→
    match(V, m_ZExtOrSelf(m_Value(V)));
44
←
Calling 'm_Value'→
46
←
Returning from 'm_Value'→
47
←
Calling 'm_ZExtOrSelf<llvm::PatternMatch::bind_ty<llvm::Value>>'→
55
←
Returning from 'm_ZExtOrSelf<llvm::PatternMatch::bind_ty<llvm::Value>>'→
56
←
Calling 'match<llvm::Value, llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::bind_ty<llvm::Value>, 39>, llvm::PatternMatch::bind_ty<llvm::Value>>>'→
58
←
Returning from 'match<llvm::Value, llvm::PatternMatch::match_combine_or<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::bind_ty<llvm::Value>, 39>, llvm::PatternMatch::bind_ty<llvm::Value>>>'→
  else
    match(V, m_SExtOrSelf(m_Value(V)));
};
59
←
Returning without writing to 'V'→

// Now, finally validate the sign-extending magic.
// `select` itself may be appropriately extended, look past that.
SkipExtInMagic(Select);
42
←
Calling 'operator()'→
60
←
Returning from 'operator()'→

ICmpInst::Predicate Pred;
const APInt *Thr;
Value *SignExtendingValue, *Zero;
bool ShouldSignext;
// It must be a select between two values we will later establish to be a
// sign-extending value and a zero constant. The condition guarding the
// sign-extension must be based on a sign bit of the same X we had in `lshr`.
if (!match(Select, m_Select(m_ICmp(Pred, m_Specific(X), m_APInt(Thr)),
61
←
Passing null pointer value via 1st parameter 'V'→
62
←
Calling 'match<llvm::Value, llvm::PatternMatch::ThreeOps_match<llvm::PatternMatch::CmpClass_match<llvm::PatternMatch::specificval_ty, llvm::PatternMatch::apint_match, llvm::ICmpInst, llvm::CmpInst::Predicate>, llvm::PatternMatch::bind_ty<llvm::Value>, llvm::PatternMatch::bind_ty<llvm::Value>, 57>>'→
                            m_Value(SignExtendingValue), m_Value(Zero))) ||
    !isSignBitCheck(Pred, *Thr, ShouldSignext))
  return nullptr;

// icmp-select pair is commutative.
if (!ShouldSignext)
  std::swap(SignExtendingValue, Zero);

// If we should not perform sign-extension then we must add/or/subtract zero.
if (!match(Zero, m_Zero()))
  return nullptr;
// Otherwise, it should be some constant, left-shifted by the same NBits we
// had in `lshr`. Said left-shift can also be appropriately extended.
// Again, we must look past zero-ext when looking for NBits.
SkipExtInMagic(SignExtendingValue);
Constant *SignExtendingValueBaseConstant;
if (!match(SignExtendingValue,
           m_Shl(m_Constant(SignExtendingValueBaseConstant),
                 m_ZExtOrSelf(m_Specific(NBits)))))
  return nullptr;
// If we `sub`, then the constant should be one, else it should be all-ones.
if (I.getOpcode() == Instruction::Sub
        ? !match(SignExtendingValueBaseConstant, m_One())
        : !match(SignExtendingValueBaseConstant, m_AllOnes()))
  return nullptr;

auto *NewAShr = BinaryOperator::CreateAShr(X, LowBitsToSkip,
                                           Extract->getName() + ".sext");
NewAShr->copyIRFlags(Extract); // Preserve `exact`-ness.
if (!HadTrunc)
  return NewAShr;

Builder.Insert(NewAShr);
return TruncInst::CreateTruncOrBitCast(NewAShr, I.getType());
1270}

1272/// This is a specialization of a more general transform from
1273/// foldUsingDistributiveLaws. If that code can be made to work optimally
1274/// for multi-use cases or propagating nsw/nuw, then we would not need this.
1275static Instruction *factorizeMathWithShlOps(BinaryOperator &I,
                                          InstCombiner::BuilderTy &Builder) {
// TODO: Also handle mul by doubling the shift amount?
assert((I.getOpcode() == Instruction::Add ||(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Sub) && "Expected add/sub"
) ? void (0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Sub) && \"Expected add/sub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1280
, __extension__ __PRETTY_FUNCTION__))
        I.getOpcode() == Instruction::Sub) &&(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Sub) && "Expected add/sub"
) ? void (0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Sub) && \"Expected add/sub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1280
, __extension__ __PRETTY_FUNCTION__))
       "Expected add/sub")(static_cast <bool> ((I.getOpcode() == Instruction::Add
 || I.getOpcode() == Instruction::Sub) && "Expected add/sub"
) ? void (0) : __assert_fail ("(I.getOpcode() == Instruction::Add || I.getOpcode() == Instruction::Sub) && \"Expected add/sub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1280
, __extension__ __PRETTY_FUNCTION__));
auto *Op0 = dyn_cast<BinaryOperator>(I.getOperand(0));
auto *Op1 = dyn_cast<BinaryOperator>(I.getOperand(1));
if (!Op0 || !Op1 || !(Op0->hasOneUse() || Op1->hasOneUse()))
  return nullptr;

Value *X, *Y, *ShAmt;
if (!match(Op0, m_Shl(m_Value(X), m_Value(ShAmt))) ||
    !match(Op1, m_Shl(m_Value(Y), m_Specific(ShAmt))))
  return nullptr;

// No-wrap propagates only when all ops have no-wrap.
bool HasNSW = I.hasNoSignedWrap() && Op0->hasNoSignedWrap() &&
              Op1->hasNoSignedWrap();
bool HasNUW = I.hasNoUnsignedWrap() && Op0->hasNoUnsignedWrap() &&
              Op1->hasNoUnsignedWrap();

// add/sub (X << ShAmt), (Y << ShAmt) --> (add/sub X, Y) << ShAmt
Value *NewMath = Builder.CreateBinOp(I.getOpcode(), X, Y);
if (auto *NewI = dyn_cast<BinaryOperator>(NewMath)) {
  NewI->setHasNoSignedWrap(HasNSW);
  NewI->setHasNoUnsignedWrap(HasNUW);
}
auto *NewShl = BinaryOperator::CreateShl(NewMath, ShAmt);
NewShl->setHasNoSignedWrap(HasNSW);
NewShl->setHasNoUnsignedWrap(HasNUW);
return NewShl;
1307}

1309/// Reduce a sequence of masked half-width multiplies to a single multiply.
1310/// ((XLow * YHigh) + (YLow * XHigh)) << HalfBits) + (XLow * YLow) --> X * Y
1311static Instruction *foldBoxMultiply(BinaryOperator &I) {
unsigned BitWidth = I.getType()->getScalarSizeInBits();
// Skip the odd bitwidth types.
if ((BitWidth & 0x1))
  return nullptr;

unsigned HalfBits = BitWidth >> 1;
APInt HalfMask = APInt::getMaxValue(HalfBits);

// ResLo = (CrossSum << HalfBits) + (YLo * XLo)
Value *XLo, *YLo;
Value *CrossSum;
if (!match(&I, m_c_Add(m_Shl(m_Value(CrossSum), m_SpecificInt(HalfBits)),
                       m_Mul(m_Value(YLo), m_Value(XLo)))))
  return nullptr;

// XLo = X & HalfMask
// YLo = Y & HalfMask
// TODO: Refactor with SimplifyDemandedBits or KnownBits known leading zeros
// to enhance robustness
Value *X, *Y;
if (!match(XLo, m_And(m_Value(X), m_SpecificInt(HalfMask))) ||
    !match(YLo, m_And(m_Value(Y), m_SpecificInt(HalfMask))))
  return nullptr;

// CrossSum = (X' * (Y >> Halfbits)) + (Y' * (X >> HalfBits))
// X' can be either X or XLo in the pattern (and the same for Y')
if (match(CrossSum,
          m_c_Add(m_c_Mul(m_LShr(m_Specific(Y), m_SpecificInt(HalfBits)),
                          m_CombineOr(m_Specific(X), m_Specific(XLo))),
                  m_c_Mul(m_LShr(m_Specific(X), m_SpecificInt(HalfBits)),
                          m_CombineOr(m_Specific(Y), m_Specific(YLo))))))
  return BinaryOperator::CreateMul(X, Y);

return nullptr;
1346}

1348Instruction *InstCombinerImpl::visitAdd(BinaryOperator &I) {
if (Value *V = simplifyAddInst(I.getOperand(0), I.getOperand(1),
                               I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
                               SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (SimplifyAssociativeOrCommutative(I))
  return &I;

if (Instruction *X = foldVectorBinop(I))
  return X;

if (Instruction *Phi = foldBinopWithPhiOperands(I))
  return Phi;

// (A*B)+(A*C) -> A*(B+C) etc
if (Value *V = foldUsingDistributiveLaws(I))
  return replaceInstUsesWith(I, V);

if (Instruction *R = foldBoxMultiply(I))
  return R;

if (Instruction *R = factorizeMathWithShlOps(I, Builder))
  return R;

if (Instruction *X = foldAddWithConstant(I))
  return X;

if (Instruction *X = foldNoWrapAdd(I, Builder))
  return X;

Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
Type *Ty = I.getType();
if (Ty->isIntOrIntVectorTy(1))
  return BinaryOperator::CreateXor(LHS, RHS);

// X + X --> X << 1
if (LHS == RHS) {
  auto *Shl = BinaryOperator::CreateShl(LHS, ConstantInt::get(Ty, 1));
  Shl->setHasNoSignedWrap(I.hasNoSignedWrap());
  Shl->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
  return Shl;
}

Value *A, *B;
if (match(LHS, m_Neg(m_Value(A)))) {
  // -A + -B --> -(A + B)
  if (match(RHS, m_Neg(m_Value(B))))
    return BinaryOperator::CreateNeg(Builder.CreateAdd(A, B));

  // -A + B --> B - A
  return BinaryOperator::CreateSub(RHS, A);
}

// A + -B  -->  A - B
if (match(RHS, m_Neg(m_Value(B))))
  return BinaryOperator::CreateSub(LHS, B);

if (Value *V = checkForNegativeOperand(I, Builder))
  return replaceInstUsesWith(I, V);

// (A + 1) + ~B --> A - B
// ~B + (A + 1) --> A - B
// (~B + A) + 1 --> A - B
// (A + ~B) + 1 --> A - B
if (match(&I, m_c_BinOp(m_Add(m_Value(A), m_One()), m_Not(m_Value(B)))) ||
    match(&I, m_BinOp(m_c_Add(m_Not(m_Value(B)), m_Value(A)), m_One())))
  return BinaryOperator::CreateSub(A, B);

// (A + RHS) + RHS --> A + (RHS << 1)
if (match(LHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(RHS)))))
  return BinaryOperator::CreateAdd(A, Builder.CreateShl(RHS, 1, "reass.add"));

// LHS + (A + LHS) --> A + (LHS << 1)
if (match(RHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(LHS)))))
  return BinaryOperator::CreateAdd(A, Builder.CreateShl(LHS, 1, "reass.add"));

{
  // (A + C1) + (C2 - B) --> (A - B) + (C1 + C2)
  Constant *C1, *C2;
  if (match(&I, m_c_Add(m_Add(m_Value(A), m_ImmConstant(C1)),
                        m_Sub(m_ImmConstant(C2), m_Value(B)))) &&
      (LHS->hasOneUse() || RHS->hasOneUse())) {
    Value *Sub = Builder.CreateSub(A, B);
    return BinaryOperator::CreateAdd(Sub, ConstantExpr::getAdd(C1, C2));
  }

  // Canonicalize a constant sub operand as an add operand for better folding:
  // (C1 - A) + B --> (B - A) + C1
  if (match(&I, m_c_Add(m_OneUse(m_Sub(m_ImmConstant(C1), m_Value(A))),
                        m_Value(B)))) {
    Value *Sub = Builder.CreateSub(B, A, "reass.sub");
    return BinaryOperator::CreateAdd(Sub, C1);
  }
}

// X % C0 + (( X / C0 ) % C1) * C0 => X % (C0 * C1)
if (Value *V = SimplifyAddWithRemainder(I)) return replaceInstUsesWith(I, V);

// ((X s/ C1) << C2) + X => X s% -C1 where -C1 is 1 << C2
const APInt *C1, *C2;
if (match(LHS, m_Shl(m_SDiv(m_Specific(RHS), m_APInt(C1)), m_APInt(C2)))) {
  APInt one(C2->getBitWidth(), 1);
  APInt minusC1 = -(*C1);
  if (minusC1 == (one << *C2)) {
    Constant *NewRHS = ConstantInt::get(RHS->getType(), minusC1);
    return BinaryOperator::CreateSRem(RHS, NewRHS);
  }
}

// (A & 2^C1) + A => A & (2^C1 - 1) iff bit C1 in A is a sign bit
if (match(&I, m_c_Add(m_And(m_Value(A), m_APInt(C1)), m_Deferred(A))) &&
    C1->isPowerOf2() && (ComputeNumSignBits(A) > C1->countl_zero())) {
  Constant *NewMask = ConstantInt::get(RHS->getType(), *C1 - 1);
  return BinaryOperator::CreateAnd(A, NewMask);
}

// ZExt (B - A) + ZExt(A) --> ZExt(B)
if ((match(RHS, m_ZExt(m_Value(A))) &&
     match(LHS, m_ZExt(m_NUWSub(m_Value(B), m_Specific(A))))) ||
    (match(LHS, m_ZExt(m_Value(A))) &&
     match(RHS, m_ZExt(m_NUWSub(m_Value(B), m_Specific(A))))))
  return new ZExtInst(B, LHS->getType());

// A+B --> A|B iff A and B have no bits set in common.
if (haveNoCommonBitsSet(LHS, RHS, DL, &AC, &I, &DT))
  return BinaryOperator::CreateOr(LHS, RHS);

if (Instruction *Ext = narrowMathIfNoOverflow(I))
  return Ext;

// (add (xor A, B) (and A, B)) --> (or A, B)
// (add (and A, B) (xor A, B)) --> (or A, B)
if (match(&I, m_c_BinOp(m_Xor(m_Value(A), m_Value(B)),
                        m_c_And(m_Deferred(A), m_Deferred(B)))))
  return BinaryOperator::CreateOr(A, B);

// (add (or A, B) (and A, B)) --> (add A, B)
// (add (and A, B) (or A, B)) --> (add A, B)
if (match(&I, m_c_BinOp(m_Or(m_Value(A), m_Value(B)),
                        m_c_And(m_Deferred(A), m_Deferred(B))))) {
  // Replacing operands in-place to preserve nuw/nsw flags.
  replaceOperand(I, 0, A);
  replaceOperand(I, 1, B);
  return &I;
}

// (add A (or A, -A)) --> (and (add A, -1) A)
// (add A (or -A, A)) --> (and (add A, -1) A)
// (add (or A, -A) A) --> (and (add A, -1) A)
// (add (or -A, A) A) --> (and (add A, -1) A)
if (match(&I, m_c_BinOp(m_Value(A), m_OneUse(m_c_Or(m_Neg(m_Deferred(A)),
                                                    m_Deferred(A)))))) {
  Value *Add =
      Builder.CreateAdd(A, Constant::getAllOnesValue(A->getType()), "",
                        I.hasNoUnsignedWrap(), I.hasNoSignedWrap());
  return BinaryOperator::CreateAnd(Add, A);
}

// Canonicalize ((A & -A) - 1) --> ((A - 1) & ~A)
// Forms all commutable operations, and simplifies ctpop -> cttz folds.
if (match(&I,
          m_Add(m_OneUse(m_c_And(m_Value(A), m_OneUse(m_Neg(m_Deferred(A))))),
                m_AllOnes()))) {
  Constant *AllOnes = ConstantInt::getAllOnesValue(RHS->getType());
  Value *Dec = Builder.CreateAdd(A, AllOnes);
  Value *Not = Builder.CreateXor(A, AllOnes);
  return BinaryOperator::CreateAnd(Dec, Not);
}

// Disguised reassociation/factorization:
// ~(A * C1) + A
// ((A * -C1) - 1) + A
// ((A * -C1) + A) - 1
// (A * (1 - C1)) - 1
if (match(&I,
          m_c_Add(m_OneUse(m_Not(m_OneUse(m_Mul(m_Value(A), m_APInt(C1))))),
                  m_Deferred(A)))) {
  Type *Ty = I.getType();
  Constant *NewMulC = ConstantInt::get(Ty, 1 - *C1);
  Value *NewMul = Builder.CreateMul(A, NewMulC);
  return BinaryOperator::CreateAdd(NewMul, ConstantInt::getAllOnesValue(Ty));
}

// (A * -2**C) + B --> B - (A << C)
const APInt *NegPow2C;
if (match(&I, m_c_Add(m_OneUse(m_Mul(m_Value(A), m_NegatedPower2(NegPow2C))),
                      m_Value(B)))) {
  Constant *ShiftAmtC = ConstantInt::get(Ty, NegPow2C->countr_zero());
  Value *Shl = Builder.CreateShl(A, ShiftAmtC);
  return BinaryOperator::CreateSub(B, Shl);
}

// Canonicalize signum variant that ends in add:
// (A s>> (BW - 1)) + (zext (A s> 0)) --> (A s>> (BW - 1)) | (zext (A != 0))
ICmpInst::Predicate Pred;
uint64_t BitWidth = Ty->getScalarSizeInBits();
if (match(LHS, m_AShr(m_Value(A), m_SpecificIntAllowUndef(BitWidth - 1))) &&
    match(RHS, m_OneUse(m_ZExt(
                   m_OneUse(m_ICmp(Pred, m_Specific(A), m_ZeroInt()))))) &&
    Pred == CmpInst::ICMP_SGT) {
  Value *NotZero = Builder.CreateIsNotNull(A, "isnotnull");
  Value *Zext = Builder.CreateZExt(NotZero, Ty, "isnotnull.zext");
  return BinaryOperator::CreateOr(LHS, Zext);
}

if (Instruction *Ashr = foldAddToAshr(I))
  return Ashr;

// min(A, B) + max(A, B) => A + B.
if (match(&I, m_CombineOr(m_c_Add(m_SMax(m_Value(A), m_Value(B)),
                                  m_c_SMin(m_Deferred(A), m_Deferred(B))),
                          m_c_Add(m_UMax(m_Value(A), m_Value(B)),
                                  m_c_UMin(m_Deferred(A), m_Deferred(B))))))
  return BinaryOperator::CreateWithCopiedFlags(Instruction::Add, A, B, &I);

// TODO(jingyue): Consider willNotOverflowSignedAdd and
// willNotOverflowUnsignedAdd to reduce the number of invocations of
// computeKnownBits.
bool Changed = false;
if (!I.hasNoSignedWrap() && willNotOverflowSignedAdd(LHS, RHS, I)) {
  Changed = true;
  I.setHasNoSignedWrap(true);
}
if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedAdd(LHS, RHS, I)) {
  Changed = true;
  I.setHasNoUnsignedWrap(true);
}

if (Instruction *V = canonicalizeLowbitMask(I, Builder))
  return V;

if (Instruction *V =
        canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(I))
  return V;

if (Instruction *SatAdd = foldToUnsignedSaturatedAdd(I))
  return SatAdd;

// usub.sat(A, B) + B => umax(A, B)
if (match(&I, m_c_BinOp(
        m_OneUse(m_Intrinsic<Intrinsic::usub_sat>(m_Value(A), m_Value(B))),
        m_Deferred(B)))) {
  return replaceInstUsesWith(I,
      Builder.CreateIntrinsic(Intrinsic::umax, {I.getType()}, {A, B}));
}

// ctpop(A) + ctpop(B) => ctpop(A | B) if A and B have no bits set in common.
if (match(LHS, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(A)))) &&
    match(RHS, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(B)))) &&
    haveNoCommonBitsSet(A, B, DL, &AC, &I, &DT))
  return replaceInstUsesWith(
      I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
                                 {Builder.CreateOr(A, B)}));

return Changed ? &I : nullptr;
1604}

1606/// Eliminate an op from a linear interpolation (lerp) pattern.
1607static Instruction *factorizeLerp(BinaryOperator &I,
                                InstCombiner::BuilderTy &Builder) {
Value *X, *Y, *Z;
if (!match(&I, m_c_FAdd(m_OneUse(m_c_FMul(m_Value(Y),
                                          m_OneUse(m_FSub(m_FPOne(),
                                                          m_Value(Z))))),
                        m_OneUse(m_c_FMul(m_Value(X), m_Deferred(Z))))))
  return nullptr;

// (Y * (1.0 - Z)) + (X * Z) --> Y + Z * (X - Y) [8 commuted variants]
Value *XY = Builder.CreateFSubFMF(X, Y, &I);
Value *MulZ = Builder.CreateFMulFMF(Z, XY, &I);
return BinaryOperator::CreateFAddFMF(Y, MulZ, &I);
1620}

1622/// Factor a common operand out of fadd/fsub of fmul/fdiv.
1623static Instruction *factorizeFAddFSub(BinaryOperator &I,
                                    InstCombiner::BuilderTy &Builder) {
assert((I.getOpcode() == Instruction::FAdd ||(static_cast <bool> ((I.getOpcode() == Instruction::FAdd
 || I.getOpcode() == Instruction::FSub) && "Expecting fadd/fsub"
) ? void (0) : __assert_fail ("(I.getOpcode() == Instruction::FAdd || I.getOpcode() == Instruction::FSub) && \"Expecting fadd/fsub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1626
, __extension__ __PRETTY_FUNCTION__))
        I.getOpcode() == Instruction::FSub) && "Expecting fadd/fsub")(static_cast <bool> ((I.getOpcode() == Instruction::FAdd
 || I.getOpcode() == Instruction::FSub) && "Expecting fadd/fsub"
) ? void (0) : __assert_fail ("(I.getOpcode() == Instruction::FAdd || I.getOpcode() == Instruction::FSub) && \"Expecting fadd/fsub\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1626
, __extension__ __PRETTY_FUNCTION__));
assert(I.hasAllowReassoc() && I.hasNoSignedZeros() &&(static_cast <bool> (I.hasAllowReassoc() && I.hasNoSignedZeros
() && "FP factorization requires FMF") ? void (0) : __assert_fail
 ("I.hasAllowReassoc() && I.hasNoSignedZeros() && \"FP factorization requires FMF\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1628
, __extension__ __PRETTY_FUNCTION__))
       "FP factorization requires FMF")(static_cast <bool> (I.hasAllowReassoc() && I.hasNoSignedZeros
() && "FP factorization requires FMF") ? void (0) : __assert_fail
 ("I.hasAllowReassoc() && I.hasNoSignedZeros() && \"FP factorization requires FMF\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1628
, __extension__ __PRETTY_FUNCTION__));

if (Instruction *Lerp = factorizeLerp(I, Builder))
  return Lerp;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
if (!Op0->hasOneUse() || !Op1->hasOneUse())
  return nullptr;

Value *X, *Y, *Z;
bool IsFMul;
if ((match(Op0, m_FMul(m_Value(X), m_Value(Z))) &&
     match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))) ||
    (match(Op0, m_FMul(m_Value(Z), m_Value(X))) &&
     match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))))
  IsFMul = true;
else if (match(Op0, m_FDiv(m_Value(X), m_Value(Z))) &&
         match(Op1, m_FDiv(m_Value(Y), m_Specific(Z))))
  IsFMul = false;
else
  return nullptr;

// (X * Z) + (Y * Z) --> (X + Y) * Z
// (X * Z) - (Y * Z) --> (X - Y) * Z
// (X / Z) + (Y / Z) --> (X + Y) / Z
// (X / Z) - (Y / Z) --> (X - Y) / Z
bool IsFAdd = I.getOpcode() == Instruction::FAdd;
Value *XY = IsFAdd ? Builder.CreateFAddFMF(X, Y, &I)
                   : Builder.CreateFSubFMF(X, Y, &I);

// Bail out if we just created a denormal constant.
// TODO: This is copied from a previous implementation. Is it necessary?
const APFloat *C;
if (match(XY, m_APFloat(C)) && !C->isNormal())
  return nullptr;

return IsFMul ? BinaryOperator::CreateFMulFMF(XY, Z, &I)
              : BinaryOperator::CreateFDivFMF(XY, Z, &I);
1666}

1668Instruction *InstCombinerImpl::visitFAdd(BinaryOperator &I) {
if (Value *V = simplifyFAddInst(I.getOperand(0), I.getOperand(1),
                                I.getFastMathFlags(),
                                SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (SimplifyAssociativeOrCommutative(I))
  return &I;

if (Instruction *X = foldVectorBinop(I))
  return X;

if (Instruction *Phi = foldBinopWithPhiOperands(I))
  return Phi;

if (Instruction *FoldedFAdd = foldBinOpIntoSelectOrPhi(I))
  return FoldedFAdd;

// (-X) + Y --> Y - X
Value *X, *Y;
if (match(&I, m_c_FAdd(m_FNeg(m_Value(X)), m_Value(Y))))
  return BinaryOperator::CreateFSubFMF(Y, X, &I);

// Similar to above, but look through fmul/fdiv for the negated term.
// (-X * Y) + Z --> Z - (X * Y) [4 commuted variants]
Value *Z;
if (match(&I, m_c_FAdd(m_OneUse(m_c_FMul(m_FNeg(m_Value(X)), m_Value(Y))),
                       m_Value(Z)))) {
  Value *XY = Builder.CreateFMulFMF(X, Y, &I);
  return BinaryOperator::CreateFSubFMF(Z, XY, &I);
}
// (-X / Y) + Z --> Z - (X / Y) [2 commuted variants]
// (X / -Y) + Z --> Z - (X / Y) [2 commuted variants]
if (match(&I, m_c_FAdd(m_OneUse(m_FDiv(m_FNeg(m_Value(X)), m_Value(Y))),
                       m_Value(Z))) ||
    match(&I, m_c_FAdd(m_OneUse(m_FDiv(m_Value(X), m_FNeg(m_Value(Y)))),
                       m_Value(Z)))) {
  Value *XY = Builder.CreateFDivFMF(X, Y, &I);
  return BinaryOperator::CreateFSubFMF(Z, XY, &I);
}

// Check for (fadd double (sitofp x), y), see if we can merge this into an
// integer add followed by a promotion.
Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
if (SIToFPInst *LHSConv = dyn_cast<SIToFPInst>(LHS)) {
  Value *LHSIntVal = LHSConv->getOperand(0);
  Type *FPType = LHSConv->getType();

  // TODO: This check is overly conservative. In many cases known bits
  // analysis can tell us that the result of the addition has less significant
  // bits than the integer type can hold.
  auto IsValidPromotion = [](Type *FTy, Type *ITy) {
    Type *FScalarTy = FTy->getScalarType();
    Type *IScalarTy = ITy->getScalarType();

    // Do we have enough bits in the significand to represent the result of
    // the integer addition?
    unsigned MaxRepresentableBits =
        APFloat::semanticsPrecision(FScalarTy->getFltSemantics());
    return IScalarTy->getIntegerBitWidth() <= MaxRepresentableBits;
  };

  // (fadd double (sitofp x), fpcst) --> (sitofp (add int x, intcst))
  // ... if the constant fits in the integer value.  This is useful for things
  // like (double)(x & 1234) + 4.0 -> (double)((X & 1234)+4) which no longer
  // requires a constant pool load, and generally allows the add to be better
  // instcombined.
  if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHS))
    if (IsValidPromotion(FPType, LHSIntVal->getType())) {
      Constant *CI =
        ConstantExpr::getFPToSI(CFP, LHSIntVal->getType());
      if (LHSConv->hasOneUse() &&
          ConstantExpr::getSIToFP(CI, I.getType()) == CFP &&
          willNotOverflowSignedAdd(LHSIntVal, CI, I)) {
        // Insert the new integer add.
        Value *NewAdd = Builder.CreateNSWAdd(LHSIntVal, CI, "addconv");
        return new SIToFPInst(NewAdd, I.getType());
      }
    }

  // (fadd double (sitofp x), (sitofp y)) --> (sitofp (add int x, y))
  if (SIToFPInst *RHSConv = dyn_cast<SIToFPInst>(RHS)) {
    Value *RHSIntVal = RHSConv->getOperand(0);
    // It's enough to check LHS types only because we require int types to
    // be the same for this transform.
    if (IsValidPromotion(FPType, LHSIntVal->getType())) {
      // Only do this if x/y have the same type, if at least one of them has a
      // single use (so we don't increase the number of int->fp conversions),
      // and if the integer add will not overflow.
      if (LHSIntVal->getType() == RHSIntVal->getType() &&
          (LHSConv->hasOneUse() || RHSConv->hasOneUse()) &&
          willNotOverflowSignedAdd(LHSIntVal, RHSIntVal, I)) {
        // Insert the new integer add.
        Value *NewAdd = Builder.CreateNSWAdd(LHSIntVal, RHSIntVal, "addconv");
        return new SIToFPInst(NewAdd, I.getType());
      }
    }
  }
}

// Handle specials cases for FAdd with selects feeding the operation
if (Value *V = SimplifySelectsFeedingBinaryOp(I, LHS, RHS))
  return replaceInstUsesWith(I, V);

if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
  if (Instruction *F = factorizeFAddFSub(I, Builder))
    return F;

  // Try to fold fadd into start value of reduction intrinsic.
  if (match(&I, m_c_FAdd(m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(
                             m_AnyZeroFP(), m_Value(X))),
                         m_Value(Y)))) {
    // fadd (rdx 0.0, X), Y --> rdx Y, X
    return replaceInstUsesWith(
        I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
                                   {X->getType()}, {Y, X}, &I));
  }
  const APFloat *StartC, *C;
  if (match(LHS, m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(
                     m_APFloat(StartC), m_Value(X)))) &&
      match(RHS, m_APFloat(C))) {
    // fadd (rdx StartC, X), C --> rdx (C + StartC), X
    Constant *NewStartC = ConstantFP::get(I.getType(), *C + *StartC);
    return replaceInstUsesWith(
        I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
                                   {X->getType()}, {NewStartC, X}, &I));
  }

  // (X * MulC) + X --> X * (MulC + 1.0)
  Constant *MulC;
  if (match(&I, m_c_FAdd(m_FMul(m_Value(X), m_ImmConstant(MulC)),
                         m_Deferred(X)))) {
    if (Constant *NewMulC = ConstantFoldBinaryOpOperands(
            Instruction::FAdd, MulC, ConstantFP::get(I.getType(), 1.0), DL))
      return BinaryOperator::CreateFMulFMF(X, NewMulC, &I);
  }

  // (-X - Y) + (X + Z) --> Z - Y
  if (match(&I, m_c_FAdd(m_FSub(m_FNeg(m_Value(X)), m_Value(Y)),
                         m_c_FAdd(m_Deferred(X), m_Value(Z)))))
    return BinaryOperator::CreateFSubFMF(Z, Y, &I);

  if (Value *V = FAddCombine(Builder).simplify(&I))
    return replaceInstUsesWith(I, V);
}

// minumum(X, Y) + maximum(X, Y) => X + Y.
if (match(&I,
          m_c_FAdd(m_Intrinsic<Intrinsic::maximum>(m_Value(X), m_Value(Y)),
                   m_c_Intrinsic<Intrinsic::minimum>(m_Deferred(X),
                                                     m_Deferred(Y))))) {
  BinaryOperator *Result = BinaryOperator::CreateFAddFMF(X, Y, &I);
  // We cannot preserve ninf if nnan flag is not set.
  // If X is NaN and Y is Inf then in original program we had NaN + NaN,
  // while in optimized version NaN + Inf and this is a poison with ninf flag.
  if (!Result->hasNoNaNs())
    Result->setHasNoInfs(false);
  return Result;
}

return nullptr;
1829}

1831/// Optimize pointer differences into the same array into a size.  Consider:
1832///  &A[10] - &A[0]: we should compile this to "10".  LHS/RHS are the pointer
1833/// operands to the ptrtoint instructions for the LHS/RHS of the subtract.
1834Value *InstCombinerImpl::OptimizePointerDifference(Value *LHS, Value *RHS,
                                                 Type *Ty, bool IsNUW) {
// If LHS is a gep based on RHS or RHS is a gep based on LHS, we can optimize
// this.
bool Swapped = false;
GEPOperator *GEP1 = nullptr, *GEP2 = nullptr;
if (!isa<GEPOperator>(LHS) && isa<GEPOperator>(RHS)) {
  std::swap(LHS, RHS);
  Swapped = true;
}

// Require at least one GEP with a common base pointer on both sides.
if (auto *LHSGEP = dyn_cast<GEPOperator>(LHS)) {
  // (gep X, ...) - X
  if (LHSGEP->getOperand(0)->stripPointerCasts() ==
      RHS->stripPointerCasts()) {
    GEP1 = LHSGEP;
  } else if (auto *RHSGEP = dyn_cast<GEPOperator>(RHS)) {
    // (gep X, ...) - (gep X, ...)
    if (LHSGEP->getOperand(0)->stripPointerCasts() ==
        RHSGEP->getOperand(0)->stripPointerCasts()) {
      GEP1 = LHSGEP;
      GEP2 = RHSGEP;
    }
  }
}

if (!GEP1)
  return nullptr;

if (GEP2) {
  // (gep X, ...) - (gep X, ...)
  //
  // Avoid duplicating the arithmetic if there are more than one non-constant
  // indices between the two GEPs and either GEP has a non-constant index and
  // multiple users. If zero non-constant index, the result is a constant and
  // there is no duplication. If one non-constant index, the result is an add
  // or sub with a constant, which is no larger than the original code, and
  // there's no duplicated arithmetic, even if either GEP has multiple
  // users. If more than one non-constant indices combined, as long as the GEP
  // with at least one non-constant index doesn't have multiple users, there
  // is no duplication.
  unsigned NumNonConstantIndices1 = GEP1->countNonConstantIndices();
  unsigned NumNonConstantIndices2 = GEP2->countNonConstantIndices();
  if (NumNonConstantIndices1 + NumNonConstantIndices2 > 1 &&
      ((NumNonConstantIndices1 > 0 && !GEP1->hasOneUse()) ||
       (NumNonConstantIndices2 > 0 && !GEP2->hasOneUse()))) {
    return nullptr;
  }
}

// Emit the offset of the GEP and an intptr_t.
Value *Result = EmitGEPOffset(GEP1);

// If this is a single inbounds GEP and the original sub was nuw,
// then the final multiplication is also nuw.
if (auto *I = dyn_cast<Instruction>(Result))
  if (IsNUW && !GEP2 && !Swapped && GEP1->isInBounds() &&
      I->getOpcode() == Instruction::Mul)
    I->setHasNoUnsignedWrap();

// If we have a 2nd GEP of the same base pointer, subtract the offsets.
// If both GEPs are inbounds, then the subtract does not have signed overflow.
if (GEP2) {
  Value *Offset = EmitGEPOffset(GEP2);
  Result = Builder.CreateSub(Result, Offset, "gepdiff", /* NUW */ false,
                             GEP1->isInBounds() && GEP2->isInBounds());
}

// If we have p - gep(p, ...)  then we have to negate the result.
if (Swapped)
  Result = Builder.CreateNeg(Result, "diff.neg");

return Builder.CreateIntCast(Result, Ty, true);
1908}

1910static Instruction *foldSubOfMinMax(BinaryOperator &I,
                                  InstCombiner::BuilderTy &Builder) {
Value *Op0 = I.getOperand(0);
Value *Op1 = I.getOperand(1);
Type *Ty = I.getType();
auto *MinMax = dyn_cast<MinMaxIntrinsic>(Op1);
if (!MinMax)
  return nullptr;

// sub(add(X,Y), s/umin(X,Y)) --> s/umax(X,Y)
// sub(add(X,Y), s/umax(X,Y)) --> s/umin(X,Y)
Value *X = MinMax->getLHS();
Value *Y = MinMax->getRHS();
if (match(Op0, m_c_Add(m_Specific(X), m_Specific(Y))) &&
    (Op0->hasOneUse() || Op1->hasOneUse())) {
  Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
  Function *F = Intrinsic::getDeclaration(I.getModule(), InvID, Ty);
  return CallInst::Create(F, {X, Y});
}

// sub(add(X,Y),umin(Y,Z)) --> add(X,usub.sat(Y,Z))
// sub(add(X,Z),umin(Y,Z)) --> add(X,usub.sat(Z,Y))
Value *Z;
if (match(Op1, m_OneUse(m_UMin(m_Value(Y), m_Value(Z))))) {
  if (match(Op0, m_OneUse(m_c_Add(m_Specific(Y), m_Value(X))))) {
    Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Y, Z});
    return BinaryOperator::CreateAdd(X, USub);
  }
  if (match(Op0, m_OneUse(m_c_Add(m_Specific(Z), m_Value(X))))) {
    Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Z, Y});
    return BinaryOperator::CreateAdd(X, USub);
  }
}

// sub Op0, smin((sub nsw Op0, Z), 0) --> smax Op0, Z
// sub Op0, smax((sub nsw Op0, Z), 0) --> smin Op0, Z
if (MinMax->isSigned() && match(Y, m_ZeroInt()) &&
    match(X, m_NSWSub(m_Specific(Op0), m_Value(Z)))) {
  Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
  Function *F = Intrinsic::getDeclaration(I.getModule(), InvID, Ty);
  return CallInst::Create(F, {Op0, Z});
}

return nullptr;
1954}

1956Instruction *InstCombinerImpl::visitSub(BinaryOperator &I) {
if (Value *V = simplifySubInst(I.getOperand(0), I.getOperand(1),
                               I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
                               SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (Instruction *X = foldVectorBinop(I))
  return X;

if (Instruction *Phi = foldBinopWithPhiOperands(I))
  return Phi;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);

// If this is a 'B = x-(-A)', change to B = x+A.
// We deal with this without involving Negator to preserve NSW flag.
if (Value *V = dyn_castNegVal(Op1)) {
  BinaryOperator *Res = BinaryOperator::CreateAdd(Op0, V);

  if (const auto *BO = dyn_cast<BinaryOperator>(Op1)) {
    assert(BO->getOpcode() == Instruction::Sub &&(static_cast <bool> (BO->getOpcode() == Instruction::
Sub && "Expected a subtraction operator!") ? void (0)
 : __assert_fail ("BO->getOpcode() == Instruction::Sub && \"Expected a subtraction operator!\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1977
, __extension__ __PRETTY_FUNCTION__))
           "Expected a subtraction operator!")(static_cast <bool> (BO->getOpcode() == Instruction::
Sub && "Expected a subtraction operator!") ? void (0)
 : __assert_fail ("BO->getOpcode() == Instruction::Sub && \"Expected a subtraction operator!\""
, "llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp", 1977
, __extension__ __PRETTY_FUNCTION__));
    if (BO->hasNoSignedWrap() && I.hasNoSignedWrap())
      Res->setHasNoSignedWrap(true);
  } else {
    if (cast<Constant>(Op1)->isNotMinSignedValue() && I.hasNoSignedWrap())
      Res->setHasNoSignedWrap(true);
  }

  return Res;
}

// Try this before Negator to preserve NSW flag.
if (Instruction *R = factorizeMathWithShlOps(I, Builder))
  return R;

Constant *C;
if (match(Op0, m_ImmConstant(C))) {
  Value *X;
  Constant *C2;

  // C-(X+C2) --> (C-C2)-X
  if (match(Op1, m_Add(m_Value(X), m_ImmConstant(C2))))
    return BinaryOperator::CreateSub(ConstantExpr::getSub(C, C2), X);
}

auto TryToNarrowDeduceFlags = [this, &I, &Op0, &Op1]() -> Instruction * {
  if (Instruction *Ext = narrowMathIfNoOverflow(I))
    return Ext;

  bool Changed = false;
  if (!I.hasNoSignedWrap() && willNotOverflowSignedSub(Op0, Op1, I)) {
    Changed = true;
    I.setHasNoSignedWrap(true);
  }
  if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedSub(Op0, Op1, I)) {
    Changed = true;
    I.setHasNoUnsignedWrap(true);
  }

  return Changed ? &I : nullptr;
};

// First, let's try to interpret `sub a, b` as `add a, (sub 0, b)`,
// and let's try to sink `(sub 0, b)` into `b` itself. But only if this isn't
// a pure negation used by a select that looks like abs/nabs.
bool IsNegation = match(Op0, m_ZeroInt());
if (!IsNegation || none_of(I.users(), [&I, Op1](const User *U) {
      const Instruction *UI = dyn_cast<Instruction>(U);
      if (!UI)
        return false;
      return match(UI,
                   m_Select(m_Value(), m_Specific(Op1), m_Specific(&I))) ||
             match(UI, m_Select(m_Value(), m_Specific(&I), m_Specific(Op1)));
    })) {
  if (Value *NegOp1 = Negator::Negate(IsNegation, Op1, *this))
    return BinaryOperator::CreateAdd(NegOp1, Op0);
}
if (IsNegation)
  return TryToNarrowDeduceFlags(); // Should have been handled in Negator!

// (A*B)-(A*C) -> A*(B-C) etc
if (Value *V = foldUsingDistributiveLaws(I))
  return replaceInstUsesWith(I, V);

if (I.getType()->isIntOrIntVectorTy(1))
  return BinaryOperator::CreateXor(Op0, Op1);

// Replace (-1 - A) with (~A).
if (match(Op0, m_AllOnes()))
  return BinaryOperator::CreateNot(Op1);

// (X + -1) - Y --> ~Y + X
Value *X, *Y;
if (match(Op0, m_OneUse(m_Add(m_Value(X), m_AllOnes()))))
  return BinaryOperator::CreateAdd(Builder.CreateNot(Op1), X);

// Reassociate sub/add sequences to create more add instructions and
// reduce dependency chains:
// ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
Value *Z;
if (match(Op0, m_OneUse(m_c_Add(m_OneUse(m_Sub(m_Value(X), m_Value(Y))),
                                m_Value(Z))))) {
  Value *XZ = Builder.CreateAdd(X, Z);
  Value *YW = Builder.CreateAdd(Y, Op1);
  return BinaryOperator::CreateSub(XZ, YW);
}

// ((X - Y) - Op1)  -->  X - (Y + Op1)
if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y))))) {
  Value *Add = Builder.CreateAdd(Y, Op1);
  return BinaryOperator::CreateSub(X, Add);
}

// (~X) - (~Y) --> Y - X
// This is placed after the other reassociations and explicitly excludes a
// sub-of-sub pattern to avoid infinite looping.
if (isFreeToInvert(Op0, Op0->hasOneUse()) &&
    isFreeToInvert(Op1, Op1->hasOneUse()) &&
    !match(Op0, m_Sub(m_ImmConstant(), m_Value()))) {
  Value *NotOp0 = Builder.CreateNot(Op0);
  Value *NotOp1 = Builder.CreateNot(Op1);
  return BinaryOperator::CreateSub(NotOp1, NotOp0);
}

auto m_AddRdx = [](Value *&Vec) {
  return m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_add>(m_Value(Vec)));
};
Value *V0, *V1;
if (match(Op0, m_AddRdx(V0)) && match(Op1, m_AddRdx(V1)) &&
    V0->getType() == V1->getType()) {
  // Difference of sums is sum of differences:
  // add_rdx(V0) - add_rdx(V1) --> add_rdx(V0 - V1)
  Value *Sub = Builder.CreateSub(V0, V1);
  Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_add,
                                       {Sub->getType()}, {Sub});
  return replaceInstUsesWith(I, Rdx);
}

if (Constant *C = dyn_cast<Constant>(Op0)) {
  Value *X;
  if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
    // C - (zext bool) --> bool ? C - 1 : C
    return SelectInst::Create(X, InstCombiner::SubOne(C), C);
  if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
    // C - (sext bool) --> bool ? C + 1 : C
    return SelectInst::Create(X, InstCombiner::AddOne(C), C);

  // C - ~X == X + (1+C)
  if (match(Op1, m_Not(m_Value(X))))
    return BinaryOperator::CreateAdd(X, InstCombiner::AddOne(C));

  // Try to fold constant sub into select arguments.
  if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
    if (Instruction *R = FoldOpIntoSelect(I, SI))
      return R;

  // Try to fold constant sub into PHI values.
  if (PHINode *PN = dyn_cast<PHINode>(Op1))
    if (Instruction *R = foldOpIntoPhi(I, PN))
      return R;

  Constant *C2;

  // C-(C2-X) --> X+(C-C2)
  if (match(Op1, m_Sub(m_ImmConstant(C2), m_Value(X))))
    return BinaryOperator::CreateAdd(X, ConstantExpr::getSub(C, C2));
}

const APInt *Op0C;
if (match(Op0, m_APInt(Op0C))) {
  if (Op0C->isMask()) {
    // Turn this into a xor if LHS is 2^n-1 and the remaining bits are known
    // zero.
    KnownBits RHSKnown = computeKnownBits(Op1, 0, &I);
    if ((*Op0C | RHSKnown.Zero).isAllOnes())
      return BinaryOperator::CreateXor(Op1, Op0);
  }

  // C - ((C3 -nuw X) & C2) --> (C - (C2 & C3)) + (X & C2) when:
  // (C3 - ((C2 & C3) - 1)) is pow2
  // ((C2 + C3) & ((C2 & C3) - 1)) == ((C2 & C3) - 1)
  // C2 is negative pow2 || sub nuw
  const APInt *C2, *C3;
  BinaryOperator *InnerSub;
  if (match(Op1, m_OneUse(m_And(m_BinOp(InnerSub), m_APInt(C2)))) &&
      match(InnerSub, m_Sub(m_APInt(C3), m_Value(X))) &&
      (InnerSub->hasNoUnsignedWrap() || C2->isNegatedPowerOf2())) {
    APInt C2AndC3 = *C2 & *C3;
    APInt C2AndC3Minus1 = C2AndC3 - 1;
    APInt C2AddC3 = *C2 + *C3;
    if ((*C3 - C2AndC3Minus1).isPowerOf2() &&
        C2AndC3Minus1.isSubsetOf(C2AddC3)) {
      Value *And = Builder.CreateAnd(X, ConstantInt::get(I.getType(), *C2));
      return BinaryOperator::CreateAdd(
          And, ConstantInt::get(I.getType(), *Op0C - C2AndC3));
    }
  }
}

{
  Value *Y;
  // X-(X+Y) == -Y    X-(Y+X) == -Y
  if (match(Op1, m_c_Add(m_Specific(Op0), m_Value(Y))))
    return BinaryOperator::CreateNeg(Y);

  // (X-Y)-X == -Y
  if (match(Op0, m_Sub(m_Specific(Op1), m_Value(Y))))
    return BinaryOperator::CreateNeg(Y);
}

// (sub (or A, B) (and A, B)) --> (xor A, B)
{
  Value *A, *B;
  if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
      match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
    return BinaryOperator::CreateXor(A, B);
}

// (sub (add A, B) (or A, B)) --> (and A, B)
{
  Value *A, *B;
  if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
      match(Op1, m_c_Or(m_Specific(A), m_Specific(B))))
    return BinaryOperator::CreateAnd(A, B);
}

// (sub (add A, B) (and A, B)) --> (or A, B)
{
  Value *A, *B;
  if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
      match(Op1, m_c_And(m_Specific(A), m_Specific(B))))
    return BinaryOperator::CreateOr(A, B);
}

// (sub (and A, B) (or A, B)) --> neg (xor A, B)
{
  Value *A, *B;
  if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
      match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
      (Op0->hasOneUse() || Op1->hasOneUse()))
    return BinaryOperator::CreateNeg(Builder.CreateXor(A, B));
}

// (sub (or A, B), (xor A, B)) --> (and A, B)
{
  Value *A, *B;
  if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
      match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
    return BinaryOperator::CreateAnd(A, B);
}

// (sub (xor A, B) (or A, B)) --> neg (and A, B)
{
  Value *A, *B;
  if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
      match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
      (Op0->hasOneUse() || Op1->hasOneUse()))
    return BinaryOperator::CreateNeg(Builder.CreateAnd(A, B));
}

{
  Value *Y;
  // ((X | Y) - X) --> (~X & Y)
  if (match(Op0, m_OneUse(m_c_Or(m_Value(Y), m_Specific(Op1)))))
    return BinaryOperator::CreateAnd(
        Y, Builder.CreateNot(Op1, Op1->getName() + ".not"));
}

{
  // (sub (and Op1, (neg X)), Op1) --> neg (and Op1, (add X, -1))
  Value *X;
  if (match(Op0, m_OneUse(m_c_And(m_Specific(Op1),
                                  m_OneUse(m_Neg(m_Value(X))))))) {
    return BinaryOperator::CreateNeg(Builder.CreateAnd(
        Op1, Builder.CreateAdd(X, Constant::getAllOnesValue(I.getType()))));
  }
}

{
  // (sub (and Op1, C), Op1) --> neg (and Op1, ~C)
  Constant *C;
  if (match(Op0, m_OneUse(m_And(m_Specific(Op1), m_Constant(C))))) {
    return BinaryOperator::CreateNeg(
        Builder.CreateAnd(Op1, Builder.CreateNot(C)));
  }
}

if (Instruction *R = foldSubOfMinMax(I, Builder))
  return R;

{
  // If we have a subtraction between some value and a select between
  // said value and something else, sink subtraction into select hands, i.e.:
  //   sub (select %Cond, %TrueVal, %FalseVal), %Op1
  //     ->
  //   select %Cond, (sub %TrueVal, %Op1), (sub %FalseVal, %Op1)
  //  or
  //   sub %Op0, (select %Cond, %TrueVal, %FalseVal)
  //     ->
  //   select %Cond, (sub %Op0, %TrueVal), (sub %Op0, %FalseVal)
  // This will result in select between new subtraction and 0.
  auto SinkSubIntoSelect =
      [Ty = I.getType()](Value *Select, Value *OtherHandOfSub,
                         auto SubBuilder) -> Instruction * {
    Value *Cond, *TrueVal, *FalseVal;
    if (!match(Select, m_OneUse(m_Select(m_Value(Cond), m_Value(TrueVal),
                                         m_Value(FalseVal)))))
      return nullptr;
    if (OtherHandOfSub != TrueVal && OtherHandOfSub != FalseVal)
      return nullptr;
    // While it is really tempting to just create two subtractions and let
    // InstCombine fold one of those to 0, it isn't possible to do so
    // because of worklist visitation order. So ugly it is.
    bool OtherHandOfSubIsTrueVal = OtherHandOfSub == TrueVal;
    Value *NewSub = SubBuilder(OtherHandOfSubIsTrueVal ? FalseVal : TrueVal);
    Constant *Zero = Constant::getNullValue(Ty);
    SelectInst *NewSel =
        SelectInst::Create(Cond, OtherHandOfSubIsTrueVal ? Zero : NewSub,
                           OtherHandOfSubIsTrueVal ? NewSub : Zero);
    // Preserve prof metadata if any.
    NewSel->copyMetadata(cast<Instruction>(*Select));
    return NewSel;
  };
  if (Instruction *NewSel = SinkSubIntoSelect(
          /*Select=*/Op0, /*OtherHandOfSub=*/Op1,
          [Builder = &Builder, Op1](Value *OtherHandOfSelect) {
            return Builder->CreateSub(OtherHandOfSelect,
                                      /*OtherHandOfSub=*/Op1);
          }))
    return NewSel;
  if (Instruction *NewSel = SinkSubIntoSelect(
          /*Select=*/Op1, /*OtherHandOfSub=*/Op0,
          [Builder = &Builder, Op0](Value *OtherHandOfSelect) {
            return Builder->CreateSub(/*OtherHandOfSub=*/Op0,
                                      OtherHandOfSelect);
          }))
    return NewSel;
}

// (X - (X & Y))   -->   (X & ~Y)
if (match(Op1, m_c_And(m_Specific(Op0), m_Value(Y))) &&
    (Op1->hasOneUse() || isa<Constant>(Y)))
  return BinaryOperator::CreateAnd(
      Op0, Builder.CreateNot(Y, Y->getName() + ".not"));

// ~X - Min/Max(~X, Y) -> ~Min/Max(X, ~Y) - X
// ~X - Min/Max(Y, ~X) -> ~Min/Max(X, ~Y) - X
// Min/Max(~X, Y) - ~X -> X - ~Min/Max(X, ~Y)
// Min/Max(Y, ~X) - ~X -> X - ~Min/Max(X, ~Y)
// As long as Y is freely invertible, this will be neutral or a win.
// Note: We don't generate the inverse max/min, just create the 'not' of
// it and let other folds do the rest.
if (match(Op0, m_Not(m_Value(X))) &&
    match(Op1, m_c_MaxOrMin(m_Specific(Op0), m_Value(Y))) &&
    !Op0->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
  Value *Not = Builder.CreateNot(Op1);
  return BinaryOperator::CreateSub(Not, X);
}
if (match(Op1, m_Not(m_Value(X))) &&
    match(Op0, m_c_MaxOrMin(m_Specific(Op1), m_Value(Y))) &&
    !Op1->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
  Value *Not = Builder.CreateNot(Op0);
  return BinaryOperator::CreateSub(X, Not);
}

// Optimize pointer differences into the same array into a size.  Consider:
//  &A[10] - &A[0]: we should compile this to "10".
Value *LHSOp, *RHSOp;
if (match(Op0, m_PtrToInt(m_Value(LHSOp))) &&
    match(Op1, m_PtrToInt(m_Value(RHSOp))))
  if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
                                             I.hasNoUnsignedWrap()))
    return replaceInstUsesWith(I, Res);

// trunc(p)-trunc(q) -> trunc(p-q)
if (match(Op0, m_Trunc(m_PtrToInt(m_Value(LHSOp)))) &&
    match(Op1, m_Trunc(m_PtrToInt(m_Value(RHSOp)))))
  if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
                                             /* IsNUW */ false))
    return replaceInstUsesWith(I, Res);

// Canonicalize a shifty way to code absolute value to the common pattern.
// There are 2 potential commuted variants.
// We're relying on the fact that we only do this transform when the shift has
// exactly 2 uses and the xor has exactly 1 use (otherwise, we might increase
// instructions).
Value *A;
const APInt *ShAmt;
Type *Ty = I.getType();
unsigned BitWidth = Ty->getScalarSizeInBits();
if (match(Op1, m_AShr(m_Value(A), m_APInt(ShAmt))) &&
    Op1->hasNUses(2) && *ShAmt == BitWidth - 1 &&
    match(Op0, m_OneUse(m_c_Xor(m_Specific(A), m_Specific(Op1))))) {
  // B = ashr i32 A, 31 ; smear the sign bit
  // sub (xor A, B), B  ; flip bits if negative and subtract -1 (add 1)
  // --> (A < 0) ? -A : A
  Value *IsNeg = Builder.CreateIsNeg(A);
  // Copy the nuw/nsw flags from the sub to the negate.
  Value *NegA = Builder.CreateNeg(A, "", I.hasNoUnsignedWrap(),
                                  I.hasNoSignedWrap());
  return SelectInst::Create(IsNeg, NegA, A);
}

// If we are subtracting a low-bit masked subset of some value from an add
// of that same value with no low bits changed, that is clearing some low bits
// of the sum:
// sub (X + AddC), (X & AndC) --> and (X + AddC), ~AndC
const APInt *AddC, *AndC;
if (match(Op0, m_Add(m_Value(X), m_APInt(AddC))) &&
    match(Op1, m_And(m_Specific(X), m_APInt(AndC)))) {
  unsigned Cttz = AddC->countr_zero();
  APInt HighMask(APInt::getHighBitsSet(BitWidth, BitWidth - Cttz));
  if ((HighMask & *AndC).isZero())
    return BinaryOperator::CreateAnd(Op0, ConstantInt::get(Ty, ~(*AndC)));
}

if (Instruction *V =
        canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(I))
  return V;

// X - usub.sat(X, Y) => umin(X, Y)
if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::usub_sat>(m_Specific(Op0),
                                                         m_Value(Y)))))
  return replaceInstUsesWith(
      I, Builder.CreateIntrinsic(Intrinsic::umin, {I.getType()}, {Op0, Y}));

// umax(X, Op1) - Op1 --> usub.sat(X, Op1)
// TODO: The one-use restriction is not strictly necessary, but it may
//       require improving other pattern matching and/or codegen.
if (match(Op0, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op1)))))
  return replaceInstUsesWith(
      I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op1}));

// Op0 - umin(X, Op0) --> usub.sat(Op0, X)
if (match(Op1, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op0)))))
  return replaceInstUsesWith(
      I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op0, X}));

// Op0 - umax(X, Op0) --> 0 - usub.sat(X, Op0)
if (match(Op1, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op0))))) {
  Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op0});
  return BinaryOperator::CreateNeg(USub);
}

// umin(X, Op1) - Op1 --> 0 - usub.sat(Op1, X)
if (match(Op0, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op1))))) {
  Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op1, X});
  return BinaryOperator::CreateNeg(USub);
}

// C - ctpop(X) => ctpop(~X) if C is bitwidth
if (match(Op0, m_SpecificInt(BitWidth)) &&
    match(Op1, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(X)))))
  return replaceInstUsesWith(
      I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
                                 {Builder.CreateNot(X)}));

// Reduce multiplies for difference-of-squares by factoring:
// (X * X) - (Y * Y) --> (X + Y) * (X - Y)
if (match(Op0, m_OneUse(m_Mul(m_Value(X), m_Deferred(X)))) &&
    match(Op1, m_OneUse(m_Mul(m_Value(Y), m_Deferred(Y))))) {
  auto *OBO0 = cast<OverflowingBinaryOperator>(Op0);
  auto *OBO1 = cast<OverflowingBinaryOperator>(Op1);
  bool PropagateNSW = I.hasNoSignedWrap() && OBO0->hasNoSignedWrap() &&
                      OBO1->hasNoSignedWrap() && BitWidth > 2;
  bool PropagateNUW = I.hasNoUnsignedWrap() && OBO0->hasNoUnsignedWrap() &&
                      OBO1->hasNoUnsignedWrap() && BitWidth > 1;
  Value *Add = Builder.CreateAdd(X, Y, "add", PropagateNUW, PropagateNSW);
  Value *Sub = Builder.CreateSub(X, Y, "sub", PropagateNUW, PropagateNSW);
  Value *Mul = Builder.CreateMul(Add, Sub, "", PropagateNUW, PropagateNSW);
  return replaceInstUsesWith(I, Mul);
}

// max(X,Y) nsw/nuw - min(X,Y) --> abs(X nsw - Y)
if (match(Op0, m_OneUse(m_c_SMax(m_Value(X), m_Value(Y)))) &&
    match(Op1, m_OneUse(m_c_SMin(m_Specific(X), m_Specific(Y))))) {
  if (I.hasNoUnsignedWrap() || I.hasNoSignedWrap()) {
    Value *Sub =
        Builder.CreateSub(X, Y, "sub", /*HasNUW=*/false, /*HasNSW=*/true);
    Value *Call =
        Builder.CreateBinaryIntrinsic(Intrinsic::abs, Sub, Builder.getTrue());
    return replaceInstUsesWith(I, Call);
  }
}

return TryToNarrowDeduceFlags();
2443}

2445/// This eliminates floating-point negation in either 'fneg(X)' or
2446/// 'fsub(-0.0, X)' form by combining into a constant operand.
2447static Instruction *foldFNegIntoConstant(Instruction &I, const DataLayout &DL) {
// This is limited with one-use because fneg is assumed better for
// reassociation and cheaper in codegen than fmul/fdiv.
// TODO: Should the m_OneUse restriction be removed?
Instruction *FNegOp;
if (!match(&I, m_FNeg(m_OneUse(m_Instruction(FNegOp)))))
  return nullptr;

Value *X;
Constant *C;

// Fold negation into constant operand.
// -(X * C) --> X * (-C)
if (match(FNegOp, m_FMul(m_Value(X), m_Constant(C))))
  if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
    return BinaryOperator::CreateFMulFMF(X, NegC, &I);
// -(X / C) --> X / (-C)
if (match(FNegOp, m_FDiv(m_Value(X), m_Constant(C))))
  if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
    return BinaryOperator::CreateFDivFMF(X, NegC, &I);
// -(C / X) --> (-C) / X
if (match(FNegOp, m_FDiv(m_Constant(C), m_Value(X))))
  if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL)) {
    Instruction *FDiv = BinaryOperator::CreateFDivFMF(NegC, X, &I);

    // Intersect 'nsz' and 'ninf' because those special value exceptions may
    // not apply to the fdiv. Everything else propagates from the fneg.
    // TODO: We could propagate nsz/ninf from fdiv alone?
    FastMathFlags FMF = I.getFastMathFlags();
    FastMathFlags OpFMF = FNegOp->getFastMathFlags();
    FDiv->setHasNoSignedZeros(FMF.noSignedZeros() && OpFMF.noSignedZeros());
    FDiv->setHasNoInfs(FMF.noInfs() && OpFMF.noInfs());
    return FDiv;
  }
// With NSZ [ counter-example with -0.0: -(-0.0 + 0.0) != 0.0 + -0.0 ]:
// -(X + C) --> -X + -C --> -C - X
if (I.hasNoSignedZeros() && match(FNegOp, m_FAdd(m_Value(X), m_Constant(C))))
  if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
    return BinaryOperator::CreateFSubFMF(NegC, X, &I);

return nullptr;
2488}

2490static Instruction *hoistFNegAboveFMulFDiv(Instruction &I,
                                         InstCombiner::BuilderTy &Builder) {
Value *FNeg;
if (!match(&I, m_FNeg(m_Value(FNeg))))
  return nullptr;

Value *X, *Y;
if (match(FNeg, m_OneUse(m_FMul(m_Value(X), m_Value(Y)))))
  return BinaryOperator::CreateFMulFMF(Builder.CreateFNegFMF(X, &I), Y, &I);

if (match(FNeg, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))))
  return BinaryOperator::CreateFDivFMF(Builder.CreateFNegFMF(X, &I), Y, &I);

return nullptr;
2504}

2506Instruction *InstCombinerImpl::visitFNeg(UnaryOperator &I) {
Value *Op = I.getOperand(0);

if (Value *V = simplifyFNegInst(Op, I.getFastMathFlags(),
                                getSimplifyQuery().getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (Instruction *X = foldFNegIntoConstant(I, DL))
  return X;

Value *X, *Y;

// If we can ignore the sign of zeros: -(X - Y) --> (Y - X)
if (I.hasNoSignedZeros() &&
    match(Op, m_OneUse(m_FSub(m_Value(X), m_Value(Y)))))
  return BinaryOperator::CreateFSubFMF(Y, X, &I);

if (Instruction *R = hoistFNegAboveFMulFDiv(I, Builder))
  return R;

Value *OneUse;
if (!match(Op, m_OneUse(m_Value(OneUse))))
  return nullptr;

// Try to eliminate fneg if at least 1 arm of the select is negated.
Value *Cond;
if (match(OneUse, m_Select(m_Value(Cond), m_Value(X), m_Value(Y)))) {
  // Unlike most transforms, this one is not safe to propagate nsz unless
  // it is present on the original select. We union the flags from the select
  // and fneg and then remove nsz if needed.
  auto propagateSelectFMF = [&](SelectInst *S, bool CommonOperand) {
    S->copyFastMathFlags(&I);
    if (auto *OldSel = dyn_cast<SelectInst>(Op)) {
      FastMathFlags FMF = I.getFastMathFlags();
      FMF |= OldSel->getFastMathFlags();
      S->setFastMathFlags(FMF);
      if (!OldSel->hasNoSignedZeros() && !CommonOperand &&
          !isGuaranteedNotToBeUndefOrPoison(OldSel->getCondition()))
        S->setHasNoSignedZeros(false);
    }
  };
  // -(Cond ? -P : Y) --> Cond ? P : -Y
  Value *P;
  if (match(X, m_FNeg(m_Value(P)))) {
    Value *NegY = Builder.CreateFNegFMF(Y, &I, Y->getName() + ".neg");
    SelectInst *NewSel = SelectInst::Create(Cond, P, NegY);
    propagateSelectFMF(NewSel, P == Y);
    return NewSel;
  }
  // -(Cond ? X : -P) --> Cond ? -X : P
  if (match(Y, m_FNeg(m_Value(P)))) {
    Value *NegX = Builder.CreateFNegFMF(X, &I, X->getName() + ".neg");
    SelectInst *NewSel = SelectInst::Create(Cond, NegX, P);
    propagateSelectFMF(NewSel, P == X);
    return NewSel;
  }
}

// fneg (copysign x, y) -> copysign x, (fneg y)
if (match(OneUse, m_CopySign(m_Value(X), m_Value(Y)))) {
  // The source copysign has an additional value input, so we can't propagate
  // flags the copysign doesn't also have.
  FastMathFlags FMF = I.getFastMathFlags();
  FMF &= cast<FPMathOperator>(OneUse)->getFastMathFlags();

  IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
  Builder.setFastMathFlags(FMF);

  Value *NegY = Builder.CreateFNeg(Y);
  Value *NewCopySign = Builder.CreateCopySign(X, NegY);
  return replaceInstUsesWith(I, NewCopySign);
}

return nullptr;
2580}

2582Instruction *InstCombinerImpl::visitFSub(BinaryOperator &I) {
if (Value *V = simplifyFSubInst(I.getOperand(0), I.getOperand(1),
                                I.getFastMathFlags(),
                                getSimplifyQuery().getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (Instruction *X = foldVectorBinop(I))
  return X;

if (Instruction *Phi = foldBinopWithPhiOperands(I))
  return Phi;

// Subtraction from -0.0 is the canonical form of fneg.
// fsub -0.0, X ==> fneg X
// fsub nsz 0.0, X ==> fneg nsz X
//
// FIXME This matcher does not respect FTZ or DAZ yet:
// fsub -0.0, Denorm ==> +-0
// fneg Denorm ==> -Denorm
Value *Op;
if (match(&I, m_FNeg(m_Value(Op))))
  return UnaryOperator::CreateFNegFMF(Op, &I);

if (Instruction *X = foldFNegIntoConstant(I, DL))
  return X;

if (Instruction *R = hoistFNegAboveFMulFDiv(I, Builder))
  return R;

Value *X, *Y;
Constant *C;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
// If Op0 is not -0.0 or we can ignore -0.0: Z - (X - Y) --> Z + (Y - X)
// Canonicalize to fadd to make analysis easier.
// This can also help codegen because fadd is commutative.
// Note that if this fsub was really an fneg, the fadd with -0.0 will get
// killed later. We still limit that particular transform with 'hasOneUse'
// because an fneg is assumed better/cheaper than a generic fsub.
if (I.hasNoSignedZeros() || CannotBeNegativeZero(Op0, SQ.TLI)) {
  if (match(Op1, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
    Value *NewSub = Builder.CreateFSubFMF(Y, X, &I);
    return BinaryOperator::CreateFAddFMF(Op0, NewSub, &I);
  }
}

// (-X) - Op1 --> -(X + Op1)
if (I.hasNoSignedZeros() && !isa<ConstantExpr>(Op0) &&
    match(Op0, m_OneUse(m_FNeg(m_Value(X))))) {
  Value *FAdd = Builder.CreateFAddFMF(X, Op1, &I);
  return UnaryOperator::CreateFNegFMF(FAdd, &I);
}

if (isa<Constant>(Op0))
  if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
    if (Instruction *NV = FoldOpIntoSelect(I, SI))
      return NV;

// X - C --> X + (-C)
// But don't transform constant expressions because there's an inverse fold
// for X + (-Y) --> X - Y.
if (match(Op1, m_ImmConstant(C)))
  if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
    return BinaryOperator::CreateFAddFMF(Op0, NegC, &I);

// X - (-Y) --> X + Y
if (match(Op1, m_FNeg(m_Value(Y))))
  return BinaryOperator::CreateFAddFMF(Op0, Y, &I);

// Similar to above, but look through a cast of the negated value:
// X - (fptrunc(-Y)) --> X + fptrunc(Y)
Type *Ty = I.getType();
if (match(Op1, m_OneUse(m_FPTrunc(m_FNeg(m_Value(Y))))))
  return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPTrunc(Y, Ty), &I);

// X - (fpext(-Y)) --> X + fpext(Y)
if (match(Op1, m_OneUse(m_FPExt(m_FNeg(m_Value(Y))))))
  return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPExt(Y, Ty), &I);

// Similar to above, but look through fmul/fdiv of the negated value:
// Op0 - (-X * Y) --> Op0 + (X * Y)
// Op0 - (Y * -X) --> Op0 + (X * Y)
if (match(Op1, m_OneUse(m_c_FMul(m_FNeg(m_Value(X)), m_Value(Y))))) {
  Value *FMul = Builder.CreateFMulFMF(X, Y, &I);
  return BinaryOperator::CreateFAddFMF(Op0, FMul, &I);
}
// Op0 - (-X / Y) --> Op0 + (X / Y)
// Op0 - (X / -Y) --> Op0 + (X / Y)
if (match(Op1, m_OneUse(m_FDiv(m_FNeg(m_Value(X)), m_Value(Y)))) ||
    match(Op1, m_OneUse(m_FDiv(m_Value(X), m_FNeg(m_Value(Y)))))) {
  Value *FDiv = Builder.CreateFDivFMF(X, Y, &I);
  return BinaryOperator::CreateFAddFMF(Op0, FDiv, &I);
}

// Handle special cases for FSub with selects feeding the operation
if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
  return replaceInstUsesWith(I, V);

if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
  // (Y - X) - Y --> -X
  if (match(Op0, m_FSub(m_Specific(Op1), m_Value(X))))
    return UnaryOperator::CreateFNegFMF(X, &I);

  // Y - (X + Y) --> -X
  // Y - (Y + X) --> -X
  if (match(Op1, m_c_FAdd(m_Specific(Op0), m_Value(X))))
    return UnaryOperator::CreateFNegFMF(X, &I);

  // (X * C) - X --> X * (C - 1.0)
  if (match(Op0, m_FMul(m_Specific(Op1), m_Constant(C)))) {
    if (Constant *CSubOne = ConstantFoldBinaryOpOperands(
            Instruction::FSub, C, ConstantFP::get(Ty, 1.0), DL))
      return BinaryOperator::CreateFMulFMF(Op1, CSubOne, &I);
  }
  // X - (X * C) --> X * (1.0 - C)
  if (match(Op1, m_FMul(m_Specific(Op0), m_Constant(C)))) {
    if (Constant *OneSubC = ConstantFoldBinaryOpOperands(
            Instruction::FSub, ConstantFP::get(Ty, 1.0), C, DL))
      return BinaryOperator::CreateFMulFMF(Op0, OneSubC, &I);
  }

  // Reassociate fsub/fadd sequences to create more fadd instructions and
  // reduce dependency chains:
  // ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
  Value *Z;
  if (match(Op0, m_OneUse(m_c_FAdd(m_OneUse(m_FSub(m_Value(X), m_Value(Y))),
                                   m_Value(Z))))) {
    Value *XZ = Builder.CreateFAddFMF(X, Z, &I);
    Value *YW = Builder.CreateFAddFMF(Y, Op1, &I);
    return BinaryOperator::CreateFSubFMF(XZ, YW, &I);
  }

  auto m_FaddRdx = [](Value *&Sum, Value *&Vec) {
    return m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(m_Value(Sum),
                                                               m_Value(Vec)));
  };
  Value *A0, *A1, *V0, *V1;
  if (match(Op0, m_FaddRdx(A0, V0)) && match(Op1, m_FaddRdx(A1, V1)) &&
      V0->getType() == V1->getType()) {
    // Difference of sums is sum of differences:
    // add_rdx(A0, V0) - add_rdx(A1, V1) --> add_rdx(A0, V0 - V1) - A1
    Value *Sub = Builder.CreateFSubFMF(V0, V1, &I);
    Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
                                         {Sub->getType()}, {A0, Sub}, &I);
    return BinaryOperator::CreateFSubFMF(Rdx, A1, &I);
  }

  if (Instruction *F = factorizeFAddFSub(I, Builder))
    return F;

  // TODO: This performs reassociative folds for FP ops. Some fraction of the
  // functionality has been subsumed by simple pattern matching here and in
  // InstSimplify. We should let a dedicated reassociation pass handle more
  // complex pattern matching and remove this from InstCombine.
  if (Value *V = FAddCombine(Builder).simplify(&I))
    return replaceInstUsesWith(I, V);

  // (X - Y) - Op1 --> X - (Y + Op1)
  if (match(Op0, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
    Value *FAdd = Builder.CreateFAddFMF(Y, Op1, &I);
    return BinaryOperator::CreateFSubFMF(X, FAdd, &I);
  }
}

return nullptr;
2747}

←

/build/source/llvm/include/llvm/IR/PatternMatch.h

1//===- PatternMatch.h - Match on the LLVM IR --------------------*- 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 file provides a simple and efficient mechanism for performing general
10// tree-based pattern matches on the LLVM IR. The power of these routines is
11// that it allows you to write concise patterns that are expressive and easy to
12// understand. The other major advantage of this is that it allows you to
13// trivially capture/bind elements in the pattern to variables. For example,
14// you can do something like this:
15//
16//  Value *Exp = ...
17//  Value *X, *Y;  ConstantInt *C1, *C2;      // (X & C1) | (Y & C2)
18//  if (match(Exp, m_Or(m_And(m_Value(X), m_ConstantInt(C1)),
19//                      m_And(m_Value(Y), m_ConstantInt(C2))))) {
20//    ... Pattern is matched and variables are bound ...
21//  }
22//
23// This is primarily useful to things like the instruction combiner, but can
24// also be useful for static analysis tools or code generators.
25//
26//===----------------------------------------------------------------------===//
27 
28#ifndef LLVM_IR_PATTERNMATCH_H
29#define LLVM_IR_PATTERNMATCH_H
30 
31#include "llvm/ADT/APFloat.h"
32#include "llvm/ADT/APInt.h"
33#include "llvm/IR/Constant.h"
34#include "llvm/IR/Constants.h"
35#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/InstrTypes.h"
37#include "llvm/IR/Instruction.h"
38#include "llvm/IR/Instructions.h"
39#include "llvm/IR/IntrinsicInst.h"
40#include "llvm/IR/Intrinsics.h"
41#include "llvm/IR/Operator.h"
42#include "llvm/IR/Value.h"
43#include "llvm/Support/Casting.h"
44#include <cstdint>
45 
46namespace llvm {
47namespace PatternMatch {
48 
49template <typename Val, typename Pattern> bool match(Val *V, const Pattern &P) {
50  return const_cast<Pattern &>(P).match(V);
14
←
Calling 'AnyBinaryOp_match::match'→
34
←
Returning from 'AnyBinaryOp_match::match'→
57
←
Returning without writing to 'P.R.VR'→
63
←
Passing null pointer value via 1st parameter 'V'→
64
←
Calling 'ThreeOps_match::match'→
51}
52 
53template <typename Pattern> bool match(ArrayRef<int> Mask, const Pattern &P) {
54  return const_cast<Pattern &>(P).match(Mask);
55}
56 
57template <typename SubPattern_t> struct OneUse_match {
58  SubPattern_t SubPattern;
59 
60  OneUse_match(const SubPattern_t &SP) : SubPattern(SP) {}
61 
62  template <typename OpTy> bool match(OpTy *V) {
63    return V->hasOneUse() && SubPattern.match(V);
64  }
65};
66 
67template <typename T> inline OneUse_match<T> m_OneUse(const T &SubPattern) {
68  return SubPattern;
69}
70 
71template <typename Class> struct class_match {
72  template <typename ITy> bool match(ITy *V) { return isa<Class>(V); }
73};
74 
75/// Match an arbitrary value and ignore it.
76inline class_match<Value> m_Value() { return class_match<Value>(); }
77 
78/// Match an arbitrary unary operation and ignore it.
79inline class_match<UnaryOperator> m_UnOp() {
80  return class_match<UnaryOperator>();
81}
82 
83/// Match an arbitrary binary operation and ignore it.
84inline class_match<BinaryOperator> m_BinOp() {
85  return class_match<BinaryOperator>();
86}
87 
88/// Matches any compare instruction and ignore it.
89inline class_match<CmpInst> m_Cmp() { return class_match<CmpInst>(); }
90 
91struct undef_match {
92  static bool check(const Value *V) {
93    if (isa<UndefValue>(V))
94      return true;
95 
96    const auto *CA = dyn_cast<ConstantAggregate>(V);
97    if (!CA)
98      return false;
99 
100    SmallPtrSet<const ConstantAggregate *, 8> Seen;
101    SmallVector<const ConstantAggregate *, 8> Worklist;
102 
103    // Either UndefValue, PoisonValue, or an aggregate that only contains
104    // these is accepted by matcher.
105    // CheckValue returns false if CA cannot satisfy this constraint.
106    auto CheckValue = [&](const ConstantAggregate *CA) {
107      for (const Value *Op : CA->operand_values()) {
108        if (isa<UndefValue>(Op))
109          continue;
110 
111        const auto *CA = dyn_cast<ConstantAggregate>(Op);
112        if (!CA)
113          return false;
114        if (Seen.insert(CA).second)
115          Worklist.emplace_back(CA);
116      }
117 
118      return true;
119    };
120 
121    if (!CheckValue(CA))
122      return false;
123 
124    while (!Worklist.empty()) {
125      if (!CheckValue(Worklist.pop_back_val()))
126        return false;
127    }
128    return true;
129  }
130  template <typename ITy> bool match(ITy *V) { return check(V); }
131};
132 
133/// Match an arbitrary undef constant. This matches poison as well.
134/// If this is an aggregate and contains a non-aggregate element that is
135/// neither undef nor poison, the aggregate is not matched.
136inline auto m_Undef() { return undef_match(); }
137 
138/// Match an arbitrary poison constant.
139inline class_match<PoisonValue> m_Poison() {
140  return class_match<PoisonValue>();
141}
142 
143/// Match an arbitrary Constant and ignore it.
144inline class_match<Constant> m_Constant() { return class_match<Constant>(); }
145 
146/// Match an arbitrary ConstantInt and ignore it.
147inline class_match<ConstantInt> m_ConstantInt() {
148  return class_match<ConstantInt>();
149}
150 
151/// Match an arbitrary ConstantFP and ignore it.
152inline class_match<ConstantFP> m_ConstantFP() {
153  return class_match<ConstantFP>();
154}
155 
156struct constantexpr_match {
157  template <typename ITy> bool match(ITy *V) {
158    auto *C = dyn_cast<Constant>(V);
159    return C && (isa<ConstantExpr>(C) || C->containsConstantExpression());
160  }
161};
162 
163/// Match a constant expression or a constant that contains a constant
164/// expression.
165inline constantexpr_match m_ConstantExpr() { return constantexpr_match(); }
166 
167/// Match an arbitrary basic block value and ignore it.
168inline class_match<BasicBlock> m_BasicBlock() {
169  return class_match<BasicBlock>();
170}
171 
172/// Inverting matcher
173template <typename Ty> struct match_unless {
174  Ty M;
175 
176  match_unless(const Ty &Matcher) : M(Matcher) {}
177 
178  template <typename ITy> bool match(ITy *V) { return !M.match(V); }
179};
180 
181/// Match if the inner matcher does *NOT* match.
182template <typename Ty> inline match_unless<Ty> m_Unless(const Ty &M) {
183  return match_unless<Ty>(M);
184}
185 
186/// Matching combinators
187template <typename LTy, typename RTy> struct match_combine_or {
188  LTy L;
189  RTy R;
190 
191  match_combine_or(const LTy &Left, const RTy &Right) : L(Left), R(Right) {}
192 
193  template <typename ITy> bool match(ITy *V) {
194    if (L.match(V))
17
←
Taking false branch→
195      return true;
196    if (R.match(V))
18
←
Calling 'match_combine_and::match'→
31
←
Returning from 'match_combine_and::match'→
32
←
Taking true branch→
197      return true;
198    return false;
199  }
200};
201 
202template <typename LTy, typename RTy> struct match_combine_and {
203  LTy L;
204  RTy R;
205 
206  match_combine_and(const LTy &Left, const RTy &Right) : L(Left), R(Right) {}
207 
208  template <typename ITy> bool match(ITy *V) {
209    if (L.match(V))
19
←
Calling 'BinaryOp_match::match'→
28
←
Returning from 'BinaryOp_match::match'→
29
←
Taking true branch→
210      if (R.match(V))
30
←
Taking true branch→
211        return true;
212    return false;
213  }
214};
215 
216/// Combine two pattern matchers matching L || R
217template <typename LTy, typename RTy>
218inline match_combine_or<LTy, RTy> m_CombineOr(const LTy &L, const RTy &R) {
219  return match_combine_or<LTy, RTy>(L, R);
52
←
Returning without writing to 'L.Op.VR'→
220}
221 
222/// Combine two pattern matchers matching L && R
223template <typename LTy, typename RTy>
224inline match_combine_and<LTy, RTy> m_CombineAnd(const LTy &L, const RTy &R) {
225  return match_combine_and<LTy, RTy>(L, R);
226}
227 
228struct apint_match {
229  const APInt *&Res;
230  bool AllowUndef;
231 
232  apint_match(const APInt *&Res, bool AllowUndef)
233      : Res(Res), AllowUndef(AllowUndef) {}
234 
235  template <typename ITy> bool match(ITy *V) {
236    if (auto *CI = dyn_cast<ConstantInt>(V)) {
237      Res = &CI->getValue();
238      return true;
239    }
240    if (V->getType()->isVectorTy())
241      if (const auto *C = dyn_cast<Constant>(V))
242        if (auto *CI =
243                dyn_cast_or_null<ConstantInt>(C->getSplatValue(AllowUndef))) {
244          Res = &CI->getValue();
245          return true;
246        }
247    return false;
248  }
249};
250// Either constexpr if or renaming ConstantFP::getValueAPF to
251// ConstantFP::getValue is needed to do it via single template
252// function for both apint/apfloat.
253struct apfloat_match {
254  const APFloat *&Res;
255  bool AllowUndef;
256 
257  apfloat_match(const APFloat *&Res, bool AllowUndef)
258      : Res(Res), AllowUndef(AllowUndef) {}
259 
260  template <typename ITy> bool match(ITy *V) {
261    if (auto *CI = dyn_cast<ConstantFP>(V)) {
262      Res = &CI->getValueAPF();
263      return true;
264    }
265    if (V->getType()->isVectorTy())
266      if (const auto *C = dyn_cast<Constant>(V))
267        if (auto *CI =
268                dyn_cast_or_null<ConstantFP>(C->getSplatValue(AllowUndef))) {
269          Res = &CI->getValueAPF();
270          return true;
271        }
272    return false;
273  }
274};
275 
276/// Match a ConstantInt or splatted ConstantVector, binding the
277/// specified pointer to the contained APInt.
278inline apint_match m_APInt(const APInt *&Res) {
279  // Forbid undefs by default to maintain previous behavior.
280  return apint_match(Res, /* AllowUndef */ false);
281}
282 
283/// Match APInt while allowing undefs in splat vector constants.
284inline apint_match m_APIntAllowUndef(const APInt *&Res) {
285  return apint_match(Res, /* AllowUndef */ true);
286}
287 
288/// Match APInt while forbidding undefs in splat vector constants.
289inline apint_match m_APIntForbidUndef(const APInt *&Res) {
290  return apint_match(Res, /* AllowUndef */ false);
291}
292 
293/// Match a ConstantFP or splatted ConstantVector, binding the
294/// specified pointer to the contained APFloat.
295inline apfloat_match m_APFloat(const APFloat *&Res) {
296  // Forbid undefs by default to maintain previous behavior.
297  return apfloat_match(Res, /* AllowUndef */ false);
298}
299 
300/// Match APFloat while allowing undefs in splat vector constants.
301inline apfloat_match m_APFloatAllowUndef(const APFloat *&Res) {
302  return apfloat_match(Res, /* AllowUndef */ true);
303}
304 
305/// Match APFloat while forbidding undefs in splat vector constants.
306inline apfloat_match m_APFloatForbidUndef(const APFloat *&Res) {
307  return apfloat_match(Res, /* AllowUndef */ false);
308}
309 
310template <int64_t Val> struct constantint_match {
311  template <typename ITy> bool match(ITy *V) {
312    if (const auto *CI = dyn_cast<ConstantInt>(V)) {
313      const APInt &CIV = CI->getValue();
314      if (Val >= 0)
315        return CIV == static_cast<uint64_t>(Val);
316      // If Val is negative, and CI is shorter than it, truncate to the right
317      // number of bits.  If it is larger, then we have to sign extend.  Just
318      // compare their negated values.
319      return -CIV == -Val;
320    }
321    return false;
322  }
323};
324 
325/// Match a ConstantInt with a specific value.
326template <int64_t Val> inline constantint_match<Val> m_ConstantInt() {
327  return constantint_match<Val>();
328}
329 
330/// This helper class is used to match constant scalars, vector splats,
331/// and fixed width vectors that satisfy a specified predicate.
332/// For fixed width vector constants, undefined elements are ignored.
333template <typename Predicate, typename ConstantVal>
334struct cstval_pred_ty : public Predicate {
335  template <typename ITy> bool match(ITy *V) {
336    if (const auto *CV = dyn_cast<ConstantVal>(V))
337      return this->isValue(CV->getValue());
338    if (const auto *VTy = dyn_cast<VectorType>(V->getType())) {
339      if (const auto *C = dyn_cast<Constant>(V)) {
340        if (const auto *CV = dyn_cast_or_null<ConstantVal>(C->getSplatValue()))
341          return this->isValue(CV->getValue());
342 
343        // Number of elements of a scalable vector unknown at compile time
344        auto *FVTy = dyn_cast<FixedVectorType>(VTy);
345        if (!FVTy)
346          return false;
347 
348        // Non-splat vector constant: check each element for a match.
349        unsigned NumElts = FVTy->getNumElements();
350        assert(NumElts != 0 && "Constant vector with no elements?")(static_cast <bool> (NumElts != 0 && "Constant vector with no elements?"
) ? void (0) : __assert_fail ("NumElts != 0 && \"Constant vector with no elements?\""
, "llvm/include/llvm/IR/PatternMatch.h", 350, __extension__ __PRETTY_FUNCTION__
));
351        bool HasNonUndefElements = false;
352        for (unsigned i = 0; i != NumElts; ++i) {
353          Constant *Elt = C->getAggregateElement(i);
354          if (!Elt)
355            return false;
356          if (isa<UndefValue>(Elt))
357            continue;
358          auto *CV = dyn_cast<ConstantVal>(Elt);
359          if (!CV || !this->isValue(CV->getValue()))
360            return false;
361          HasNonUndefElements = true;
362        }
363        return HasNonUndefElements;
364      }
365    }
366    return false;
367  }
368};
369 
370/// specialization of cstval_pred_ty for ConstantInt
371template <typename Predicate>
372using cst_pred_ty = cstval_pred_ty<Predicate, ConstantInt>;
373 
374/// specialization of cstval_pred_ty for ConstantFP
375template <typename Predicate>
376using cstfp_pred_ty = cstval_pred_ty<Predicate, ConstantFP>;
377 
378/// This helper class is used to match scalar and vector constants that
379/// satisfy a specified predicate, and bind them to an APInt.
380template <typename Predicate> struct api_pred_ty : public Predicate {
381  const APInt *&Res;
382 
383  api_pred_ty(const APInt *&R) : Res(R) {}
384 
385  template <typename ITy> bool match(ITy *V) {
386    if (const auto *CI = dyn_cast<ConstantInt>(V))
387      if (this->isValue(CI->getValue())) {
388        Res = &CI->getValue();
389        return true;
390      }
391    if (V->getType()->isVectorTy())
392      if (const auto *C = dyn_cast<Constant>(V))
393        if (auto *CI = dyn_cast_or_null<ConstantInt>(C->getSplatValue()))
394          if (this->isValue(CI->getValue())) {
395            Res = &CI->getValue();
396            return true;
397          }
398 
399    return false;
400  }
401};
402 
403/// This helper class is used to match scalar and vector constants that
404/// satisfy a specified predicate, and bind them to an APFloat.
405/// Undefs are allowed in splat vector constants.
406template <typename Predicate> struct apf_pred_ty : public Predicate {
407  const APFloat *&Res;
408 
409  apf_pred_ty(const APFloat *&R) : Res(R) {}
410 
411  template <typename ITy> bool match(ITy *V) {
412    if (const auto *CI = dyn_cast<ConstantFP>(V))
413      if (this->isValue(CI->getValue())) {
414        Res = &CI->getValue();
415        return true;
416      }
417    if (V->getType()->isVectorTy())
418      if (const auto *C = dyn_cast<Constant>(V))
419        if (auto *CI = dyn_cast_or_null<ConstantFP>(
420                C->getSplatValue(/* AllowUndef */ true)))
421          if (this->isValue(CI->getValue())) {
422            Res = &CI->getValue();
423            return true;
424          }
425 
426    return false;
427  }
428};
429 
430///////////////////////////////////////////////////////////////////////////////
431//
432// Encapsulate constant value queries for use in templated predicate matchers.
433// This allows checking if constants match using compound predicates and works
434// with vector constants, possibly with relaxed constraints. For example, ignore
435// undef values.
436//
437///////////////////////////////////////////////////////////////////////////////
438 
439struct is_any_apint {
440  bool isValue(const APInt &C) { return true; }
441};
442/// Match an integer or vector with any integral constant.
443/// For vectors, this includes constants with undefined elements.
444inline cst_pred_ty<is_any_apint> m_AnyIntegralConstant() {
445  return cst_pred_ty<is_any_apint>();
446}
447 
448struct is_all_ones {
449  bool isValue(const APInt &C) { return C.isAllOnes(); }
450};
451/// Match an integer or vector with all bits set.
452/// For vectors, this includes constants with undefined elements.
453inline cst_pred_ty<is_all_ones> m_AllOnes() {
454  return cst_pred_ty<is_all_ones>();
455}
456 
457struct is_maxsignedvalue {
458  bool isValue(const APInt &C) { return C.isMaxSignedValue(); }
459};
460/// Match an integer or vector with values having all bits except for the high
461/// bit set (0x7f...).
462/// For vectors, this includes constants with undefined elements.
463inline cst_pred_ty<is_maxsignedvalue> m_MaxSignedValue() {
464  return cst_pred_ty<is_maxsignedvalue>();
465}
466inline api_pred_ty<is_maxsignedvalue> m_MaxSignedValue(const APInt *&V) {
467  return V;
468}
469 
470struct is_negative {
471  bool isValue(const APInt &C) { return C.isNegative(); }
472};
473/// Match an integer or vector of negative values.
474/// For vectors, this includes constants with undefined elements.
475inline cst_pred_ty<is_negative> m_Negative() {
476  return cst_pred_ty<is_negative>();
477}
478inline api_pred_ty<is_negative> m_Negative(const APInt *&V) { return V; }
479 
480struct is_nonnegative {
481  bool isValue(const APInt &C) { return C.isNonNegative(); }
482};
483/// Match an integer or vector of non-negative values.
484/// For vectors, this includes constants with undefined elements.
485inline cst_pred_ty<is_nonnegative> m_NonNegative() {
486  return cst_pred_ty<is_nonnegative>();
487}
488inline api_pred_ty<is_nonnegative> m_NonNegative(const APInt *&V) { return V; }
489 
490struct is_strictlypositive {
491  bool isValue(const APInt &C) { return C.isStrictlyPositive(); }
492};
493/// Match an integer or vector of strictly positive values.
494/// For vectors, this includes constants with undefined elements.
495inline cst_pred_ty<is_strictlypositive> m_StrictlyPositive() {
496  return cst_pred_ty<is_strictlypositive>();
497}
498inline api_pred_ty<is_strictlypositive> m_StrictlyPositive(const APInt *&V) {
499  return V;
500}
501 
502struct is_nonpositive {
503  bool isValue(const APInt &C) { return C.isNonPositive(); }
504};
505/// Match an integer or vector of non-positive values.
506/// For vectors, this includes constants with undefined elements.
507inline cst_pred_ty<is_nonpositive> m_NonPositive() {
508  return cst_pred_ty<is_nonpositive>();
509}
510inline api_pred_ty<is_nonpositive> m_NonPositive(const APInt *&V) { return V; }
511 
512struct is_one {
513  bool isValue(const APInt &C) { return C.isOne(); }
514};
515/// Match an integer 1 or a vector with all elements equal to 1.
516/// For vectors, this includes constants with undefined elements.
517inline cst_pred_ty<is_one> m_One() { return cst_pred_ty<is_one>(); }
518 
519struct is_zero_int {
520  bool isValue(const APInt &C) { return C.isZero(); }
521};
522/// Match an integer 0 or a vector with all elements equal to 0.
523/// For vectors, this includes constants with undefined elements.
524inline cst_pred_ty<is_zero_int> m_ZeroInt() {
525  return cst_pred_ty<is_zero_int>();
526}
527 
528struct is_zero {
529  template <typename ITy> bool match(ITy *V) {
530    auto *C = dyn_cast<Constant>(V);
531    // FIXME: this should be able to do something for scalable vectors
532    return C && (C->isNullValue() || cst_pred_ty<is_zero_int>().match(C));
533  }
534};
535/// Match any null constant or a vector with all elements equal to 0.
536/// For vectors, this includes constants with undefined elements.
537inline is_zero m_Zero() { return is_zero(); }
538 
539struct is_power2 {
540  bool isValue(const APInt &C) { return C.isPowerOf2(); }
541};
542/// Match an integer or vector power-of-2.
543/// For vectors, this includes constants with undefined elements.
544inline cst_pred_ty<is_power2> m_Power2() { return cst_pred_ty<is_power2>(); }
545inline api_pred_ty<is_power2> m_Power2(const APInt *&V) { return V; }
546 
547struct is_negated_power2 {
548  bool isValue(const APInt &C) { return C.isNegatedPowerOf2(); }
549};
550/// Match a integer or vector negated power-of-2.
551/// For vectors, this includes constants with undefined elements.
552inline cst_pred_ty<is_negated_power2> m_NegatedPower2() {
553  return cst_pred_ty<is_negated_power2>();
554}
555inline api_pred_ty<is_negated_power2> m_NegatedPower2(const APInt *&V) {
556  return V;
557}
558 
559struct is_power2_or_zero {
560  bool isValue(const APInt &C) { return !C || C.isPowerOf2(); }
561};
562/// Match an integer or vector of 0 or power-of-2 values.
563/// For vectors, this includes constants with undefined elements.
564inline cst_pred_ty<is_power2_or_zero> m_Power2OrZero() {
565  return cst_pred_ty<is_power2_or_zero>();
566}
567inline api_pred_ty<is_power2_or_zero> m_Power2OrZero(const APInt *&V) {
568  return V;
569}
570 
571struct is_sign_mask {
572  bool isValue(const APInt &C) { return C.isSignMask(); }
573};
574/// Match an integer or vector with only the sign bit(s) set.
575/// For vectors, this includes constants with undefined elements.
576inline cst_pred_ty<is_sign_mask> m_SignMask() {
577  return cst_pred_ty<is_sign_mask>();
578}
579 
580struct is_lowbit_mask {
581  bool isValue(const APInt &C) { return C.isMask(); }
582};
583/// Match an integer or vector with only the low bit(s) set.
584/// For vectors, this includes constants with undefined elements.
585inline cst_pred_ty<is_lowbit_mask> m_LowBitMask() {
586  return cst_pred_ty<is_lowbit_mask>();
587}
588inline api_pred_ty<is_lowbit_mask> m_LowBitMask(const APInt *&V) { return V; }
589 
590struct icmp_pred_with_threshold {
591  ICmpInst::Predicate Pred;
592  const APInt *Thr;
593  bool isValue(const APInt &C) { return ICmpInst::compare(C, *Thr, Pred); }
594};
595/// Match an integer or vector with every element comparing 'pred' (eg/ne/...)
596/// to Threshold. For vectors, this includes constants with undefined elements.
597inline cst_pred_ty<icmp_pred_with_threshold>
598m_SpecificInt_ICMP(ICmpInst::Predicate Predicate, const APInt &Threshold) {
599  cst_pred_ty<icmp_pred_with_threshold> P;
600  P.Pred = Predicate;
601  P.Thr = &Threshold;
602  return P;
603}
604 
605struct is_nan {
606  bool isValue(const APFloat &C) { return C.isNaN(); }
607};
608/// Match an arbitrary NaN constant. This includes quiet and signalling nans.
609/// For vectors, this includes constants with undefined elements.
610inline cstfp_pred_ty<is_nan> m_NaN() { return cstfp_pred_ty<is_nan>(); }
611 
612struct is_nonnan {
613  bool isValue(const APFloat &C) { return !C.isNaN(); }
614};
615/// Match a non-NaN FP constant.
616/// For vectors, this includes constants with undefined elements.
617inline cstfp_pred_ty<is_nonnan> m_NonNaN() {
618  return cstfp_pred_ty<is_nonnan>();
619}
620 
621struct is_inf {
622  bool isValue(const APFloat &C) { return C.isInfinity(); }
623};
624/// Match a positive or negative infinity FP constant.
625/// For vectors, this includes constants with undefined elements.
626inline cstfp_pred_ty<is_inf> m_Inf() { return cstfp_pred_ty<is_inf>(); }
627 
628struct is_noninf {
629  bool isValue(const APFloat &C) { return !C.isInfinity(); }
630};
631/// Match a non-infinity FP constant, i.e. finite or NaN.
632/// For vectors, this includes constants with undefined elements.
633inline cstfp_pred_ty<is_noninf> m_NonInf() {
634  return cstfp_pred_ty<is_noninf>();
635}
636 
637struct is_finite {
638  bool isValue(const APFloat &C) { return C.isFinite(); }
639};
640/// Match a finite FP constant, i.e. not infinity or NaN.
641/// For vectors, this includes constants with undefined elements.
642inline cstfp_pred_ty<is_finite> m_Finite() {
643  return cstfp_pred_ty<is_finite>();
644}
645inline apf_pred_ty<is_finite> m_Finite(const APFloat *&V) { return V; }
646 
647struct is_finitenonzero {
648  bool isValue(const APFloat &C) { return C.isFiniteNonZero(); }
649};
650/// Match a finite non-zero FP constant.
651/// For vectors, this includes constants with undefined elements.
652inline cstfp_pred_ty<is_finitenonzero> m_FiniteNonZero() {
653  return cstfp_pred_ty<is_finitenonzero>();
654}
655inline apf_pred_ty<is_finitenonzero> m_FiniteNonZero(const APFloat *&V) {
656  return V;
657}
658 
659struct is_any_zero_fp {
660  bool isValue(const APFloat &C) { return C.isZero(); }
661};
662/// Match a floating-point negative zero or positive zero.
663/// For vectors, this includes constants with undefined elements.
664inline cstfp_pred_ty<is_any_zero_fp> m_AnyZeroFP() {
665  return cstfp_pred_ty<is_any_zero_fp>();
666}
667 
668struct is_pos_zero_fp {
669  bool isValue(const APFloat &C) { return C.isPosZero(); }
670};
671/// Match a floating-point positive zero.
672/// For vectors, this includes constants with undefined elements.
673inline cstfp_pred_ty<is_pos_zero_fp> m_PosZeroFP() {
674  return cstfp_pred_ty<is_pos_zero_fp>();
675}
676 
677struct is_neg_zero_fp {
678  bool isValue(const APFloat &C) { return C.isNegZero(); }
679};
680/// Match a floating-point negative zero.
681/// For vectors, this includes constants with undefined elements.
682inline cstfp_pred_ty<is_neg_zero_fp> m_NegZeroFP() {
683  return cstfp_pred_ty<is_neg_zero_fp>();
684}
685 
686struct is_non_zero_fp {
687  bool isValue(const APFloat &C) { return C.isNonZero(); }
688};
689/// Match a floating-point non-zero.
690/// For vectors, this includes constants with undefined elements.
691inline cstfp_pred_ty<is_non_zero_fp> m_NonZeroFP() {
692  return cstfp_pred_ty<is_non_zero_fp>();
693}
694 
695///////////////////////////////////////////////////////////////////////////////
696 
697template <typename Class> struct bind_ty {
698  Class *&VR;
699 
700  bind_ty(Class *&V) : VR(V) {}
701 
702  template <typename ITy> bool match(ITy *V) {
703    if (auto *CV = dyn_cast<Class>(V)) {
704      VR = CV;
705      return true;
706    }
707    return false;
708  }
709};
710 
711/// Match a value, capturing it if we match.
712inline bind_ty<Value> m_Value(Value *&V) { return V; }
6
←
Calling constructor for 'bind_ty<llvm::Value>'→
7
←
Returning from constructor for 'bind_ty<llvm::Value>'→
8
←
Returning without writing to 'V'→
45
←
Returning without writing to 'V'→
713inline bind_ty<const Value> m_Value(const Value *&V) { return V; }
714 
715/// Match an instruction, capturing it if we match.
716inline bind_ty<Instruction> m_Instruction(Instruction *&I) { return I; }
717/// Match a unary operator, capturing it if we match.
718inline bind_ty<UnaryOperator> m_UnOp(UnaryOperator *&I) { return I; }
719/// Match a binary operator, capturing it if we match.
720inline bind_ty<BinaryOperator> m_BinOp(BinaryOperator *&I) { return I; }
721/// Match a with overflow intrinsic, capturing it if we match.
722inline bind_ty<WithOverflowInst> m_WithOverflowInst(WithOverflowInst *&I) {
723  return I;
724}
725inline bind_ty<const WithOverflowInst>
726m_WithOverflowInst(const WithOverflowInst *&I) {
727  return I;
728}
729 
730/// Match a Constant, capturing the value if we match.
731inline bind_ty<Constant> m_Constant(Constant *&C) { return C; }
732 
733/// Match a ConstantInt, capturing the value if we match.
734inline bind_ty<ConstantInt> m_ConstantInt(ConstantInt *&CI) { return CI; }
735 
736/// Match a ConstantFP, capturing the value if we match.
737inline bind_ty<ConstantFP> m_ConstantFP(ConstantFP *&C) { return C; }
738 
739/// Match a ConstantExpr, capturing the value if we match.
740inline bind_ty<ConstantExpr> m_ConstantExpr(ConstantExpr *&C) { return C; }
741 
742/// Match a basic block value, capturing it if we match.
743inline bind_ty<BasicBlock> m_BasicBlock(BasicBlock *&V) { return V; }
744inline bind_ty<const BasicBlock> m_BasicBlock(const BasicBlock *&V) {
745  return V;
746}
747 
748/// Match an arbitrary immediate Constant and ignore it.
749inline match_combine_and<class_match<Constant>,
750                         match_unless<constantexpr_match>>
751m_ImmConstant() {
752  return m_CombineAnd(m_Constant(), m_Unless(m_ConstantExpr()));
753}
754 
755/// Match an immediate Constant, capturing the value if we match.
756inline match_combine_and<bind_ty<Constant>,
757                         match_unless<constantexpr_match>>
758m_ImmConstant(Constant *&C) {
759  return m_CombineAnd(m_Constant(C), m_Unless(m_ConstantExpr()));
760}
761 
762/// Match a specified Value*.
763struct specificval_ty {
764  const Value *Val;
765 
766  specificval_ty(const Value *V) : Val(V) {}
767 
768  template <typename ITy> bool match(ITy *V) { return V == Val; }
769};
770 
771/// Match if we have a specific specified value.
772inline specificval_ty m_Specific(const Value *V) { return V; }
773 
774/// Stores a reference to the Value *, not the Value * itself,
775/// thus can be used in commutative matchers.
776template <typename Class> struct deferredval_ty {
777  Class *const &Val;
778 
779  deferredval_ty(Class *const &V) : Val(V) {}
780 
781  template <typename ITy> bool match(ITy *const V) { return V == Val; }
782};
783 
784/// Like m_Specific(), but works if the specific value to match is determined
785/// as part of the same match() expression. For example:
786/// m_Add(m_Value(X), m_Specific(X)) is incorrect, because m_Specific() will
787/// bind X before the pattern match starts.
788/// m_Add(m_Value(X), m_Deferred(X)) is correct, and will check against
789/// whichever value m_Value(X) populated.
790inline deferredval_ty<Value> m_Deferred(Value *const &V) { return V; }
791inline deferredval_ty<const Value> m_Deferred(const Value *const &V) {
792  return V;
793}
794 
795/// Match a specified floating point value or vector of all elements of
796/// that value.
797struct specific_fpval {
798  double Val;
799 
800  specific_fpval(double V) : Val(V) {}
801 
802  template <typename ITy> bool match(ITy *V) {
803    if (const auto *CFP = dyn_cast<ConstantFP>(V))
804      return CFP->isExactlyValue(Val);
805    if (V->getType()->isVectorTy())
806      if (const auto *C = dyn_cast<Constant>(V))
807        if (auto *CFP = dyn_cast_or_null<ConstantFP>(C->getSplatValue()))
808          return CFP->isExactlyValue(Val);
809    return false;
810  }
811};
812 
813/// Match a specific floating point value or vector with all elements
814/// equal to the value.
815inline specific_fpval m_SpecificFP(double V) { return specific_fpval(V); }
816 
817/// Match a float 1.0 or vector with all elements equal to 1.0.
818inline specific_fpval m_FPOne() { return m_SpecificFP(1.0); }
819 
820struct bind_const_intval_ty {
821  uint64_t &VR;
822 
823  bind_const_intval_ty(uint64_t &V) : VR(V) {}
824 
825  template <typename ITy> bool match(ITy *V) {
826    if (const auto *CV = dyn_cast<ConstantInt>(V))
827      if (CV->getValue().ule(UINT64_MAX(18446744073709551615UL))) {
828        VR = CV->getZExtValue();
829        return true;
830      }
831    return false;
832  }
833};
834 
835/// Match a specified integer value or vector of all elements of that
836/// value.
837template <bool AllowUndefs> struct specific_intval {
838  APInt Val;
839 
840  specific_intval(APInt V) : Val(std::move(V)) {}
841 
842  template <typename ITy> bool match(ITy *V) {
843    const auto *CI = dyn_cast<ConstantInt>(V);
844    if (!CI && V->getType()->isVectorTy())
845      if (const auto *C = dyn_cast<Constant>(V))
846        CI = dyn_cast_or_null<ConstantInt>(C->getSplatValue(AllowUndefs));
847 
848    return CI && APInt::isSameValue(CI->getValue(), Val);
849  }
850};
851 
852/// Match a specific integer value or vector with all elements equal to
853/// the value.
854inline specific_intval<false> m_SpecificInt(APInt V) {
855  return specific_intval<false>(std::move(V));
856}
857 
858inline specific_intval<false> m_SpecificInt(uint64_t V) {
859  return m_SpecificInt(APInt(64, V));
860}
861 
862inline specific_intval<true> m_SpecificIntAllowUndef(APInt V) {
863  return specific_intval<true>(std::move(V));
864}
865 
866inline specific_intval<true> m_SpecificIntAllowUndef(uint64_t V) {
867  return m_SpecificIntAllowUndef(APInt(64, V));
868}
869 
870/// Match a ConstantInt and bind to its value.  This does not match
871/// ConstantInts wider than 64-bits.
872inline bind_const_intval_ty m_ConstantInt(uint64_t &V) { return V; }
873 
874/// Match a specified basic block value.
875struct specific_bbval {
876  BasicBlock *Val;
877 
878  specific_bbval(BasicBlock *Val) : Val(Val) {}
879 
880  template <typename ITy> bool match(ITy *V) {
881    const auto *BB = dyn_cast<BasicBlock>(V);
882    return BB && BB == Val;
883  }
884};
885 
886/// Match a specific basic block value.
887inline specific_bbval m_SpecificBB(BasicBlock *BB) {
888  return specific_bbval(BB);
889}
890 
891/// A commutative-friendly version of m_Specific().
892inline deferredval_ty<BasicBlock> m_Deferred(BasicBlock *const &BB) {
893  return BB;
894}
895inline deferredval_ty<const BasicBlock>
896m_Deferred(const BasicBlock *const &BB) {
897  return BB;
898}
899 
900//===----------------------------------------------------------------------===//
901// Matcher for any binary operator.
902//
903template <typename LHS_t, typename RHS_t, bool Commutable = false>
904struct AnyBinaryOp_match {
905  LHS_t L;
906  RHS_t R;
907 
908  // The evaluation order is always stable, regardless of Commutability.
909  // The LHS is always matched first.
910  AnyBinaryOp_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
911 
912  template <typename OpTy> bool match(OpTy *V) {
913    if (auto *I15.1
'I' is non-null
15.1
'I' is non-null
 = dyn_cast<BinaryOperator>(V))
15
←
Assuming 'V' is a 'CastReturnType'→
914      return (L.match(I->getOperand(0)) && R.match(I->getOperand(1))) ||
16
←
Calling 'match_combine_or::match'→
33
←
Returning from 'match_combine_or::match'→
915             (Commutable && L.match(I->getOperand(1)) &&
916              R.match(I->getOperand(0)));
917    return false;
918  }
919};
920 
921template <typename LHS, typename RHS>
922inline AnyBinaryOp_match<LHS, RHS> m_BinOp(const LHS &L, const RHS &R) {
923  return AnyBinaryOp_match<LHS, RHS>(L, R);
924}
925 
926//===----------------------------------------------------------------------===//
927// Matcher for any unary operator.
928// TODO fuse unary, binary matcher into n-ary matcher
929//
930template <typename OP_t> struct AnyUnaryOp_match {
931  OP_t X;
932 
933  AnyUnaryOp_match(const OP_t &X) : X(X) {}
934 
935  template <typename OpTy> bool match(OpTy *V) {
936    if (auto *I = dyn_cast<UnaryOperator>(V))
937      return X.match(I->getOperand(0));
938    return false;
939  }
940};
941 
942template <typename OP_t> inline AnyUnaryOp_match<OP_t> m_UnOp(const OP_t &X) {
943  return AnyUnaryOp_match<OP_t>(X);
944}
945 
946//===----------------------------------------------------------------------===//
947// Matchers for specific binary operators.
948//
949 
950template <typename LHS_t, typename RHS_t, unsigned Opcode,
951          bool Commutable = false>
952struct BinaryOp_match {
953  LHS_t L;
954  RHS_t R;
955 
956  // The evaluation order is always stable, regardless of Commutability.
957  // The LHS is always matched first.
958  BinaryOp_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
959 
960  template <typename OpTy> inline bool match(unsigned Opc, OpTy *V) {
961    if (V->getValueID() == Value::InstructionVal + Opc) {
21
←
Assuming the condition is true→
22
←
Taking true branch→
962      auto *I = cast<BinaryOperator>(V);
23
←
'V' is a 'CastReturnType'→
963      return (L.match(I->getOperand(0)) && R.match(I->getOperand(1))) ||
24
←
Value assigned to 'Select'→
25
←
Assuming the condition is true→
26
←
Assuming the condition is true→
964             (Commutable && L.match(I->getOperand(1)) &&
965              R.match(I->getOperand(0)));
966    }
967    if (auto *CE = dyn_cast<ConstantExpr>(V))
968      return CE->getOpcode() == Opc &&
969             ((L.match(CE->getOperand(0)) && R.match(CE->getOperand(1))) ||
970              (Commutable && L.match(CE->getOperand(1)) &&
971               R.match(CE->getOperand(0))));
972    return false;
973  }
974 
975  template <typename OpTy> bool match(OpTy *V) { return match(Opcode, V); }
20
←
Calling 'BinaryOp_match::match'→
27
←
Returning from 'BinaryOp_match::match'→
976};
977 
978template <typename LHS, typename RHS>
979inline BinaryOp_match<LHS, RHS, Instruction::Add> m_Add(const LHS &L,
980                                                        const RHS &R) {
981  return BinaryOp_match<LHS, RHS, Instruction::Add>(L, R);
982}
983 
984template <typename LHS, typename RHS>
985inline BinaryOp_match<LHS, RHS, Instruction::FAdd> m_FAdd(const LHS &L,
986                                                          const RHS &R) {
987  return BinaryOp_match<LHS, RHS, Instruction::FAdd>(L, R);
988}
989 
990template <typename LHS, typename RHS>
991inline BinaryOp_match<LHS, RHS, Instruction::Sub> m_Sub(const LHS &L,
992                                                        const RHS &R) {
993  return BinaryOp_match<LHS, RHS, Instruction::Sub>(L, R);
994}
995 
996template <typename LHS, typename RHS>
997inline BinaryOp_match<LHS, RHS, Instruction::FSub> m_FSub(const LHS &L,
998                                                          const RHS &R) {
999  return BinaryOp_match<LHS, RHS, Instruction::FSub>(L, R);
1000}
1001 
1002template <typename Op_t> struct FNeg_match {
1003  Op_t X;
1004 
1005  FNeg_match(const Op_t &Op) : X(Op) {}
1006  template <typename OpTy> bool match(OpTy *V) {
1007    auto *FPMO = dyn_cast<FPMathOperator>(V);
1008    if (!FPMO)
1009      return false;
1010 
1011    if (FPMO->getOpcode() == Instruction::FNeg)
1012      return X.match(FPMO->getOperand(0));
1013 
1014    if (FPMO->getOpcode() == Instruction::FSub) {
1015      if (FPMO->hasNoSignedZeros()) {
1016        // With 'nsz', any zero goes.
1017        if (!cstfp_pred_ty<is_any_zero_fp>().match(FPMO->getOperand(0)))
1018          return false;
1019      } else {
1020        // Without 'nsz', we need fsub -0.0, X exactly.
1021        if (!cstfp_pred_ty<is_neg_zero_fp>().match(FPMO->getOperand(0)))
1022          return false;
1023      }
1024 
1025      return X.match(FPMO->getOperand(1));
1026    }
1027 
1028    return false;
1029  }
1030};
1031 
1032/// Match 'fneg X' as 'fsub -0.0, X'.
1033template <typename OpTy> inline FNeg_match<OpTy> m_FNeg(const OpTy &X) {
1034  return FNeg_match<OpTy>(X);
1035}
1036 
1037/// Match 'fneg X' as 'fsub +-0.0, X'.
1038template <typename RHS>
1039inline BinaryOp_match<cstfp_pred_ty<is_any_zero_fp>, RHS, Instruction::FSub>
1040m_FNegNSZ(const RHS &X) {
1041  return m_FSub(m_AnyZeroFP(), X);
1042}
1043 
1044template <typename LHS, typename RHS>
1045inline BinaryOp_match<LHS, RHS, Instruction::Mul> m_Mul(const LHS &L,
1046                                                        const RHS &R) {
1047  return BinaryOp_match<LHS, RHS, Instruction::Mul>(L, R);
1048}
1049 
1050template <typename LHS, typename RHS>
1051inline BinaryOp_match<LHS, RHS, Instruction::FMul> m_FMul(const LHS &L,
1052                                                          const RHS &R) {
1053  return BinaryOp_match<LHS, RHS, Instruction::FMul>(L, R);
1054}
1055 
1056template <typename LHS, typename RHS>
1057inline BinaryOp_match<LHS, RHS, Instruction::UDiv> m_UDiv(const LHS &L,
1058                                                          const RHS &R) {
1059  return BinaryOp_match<LHS, RHS, Instruction::UDiv>(L, R);
1060}
1061 
1062template <typename LHS, typename RHS>
1063inline BinaryOp_match<LHS, RHS, Instruction::SDiv> m_SDiv(const LHS &L,
1064                                                          const RHS &R) {
1065  return BinaryOp_match<LHS, RHS, Instruction::SDiv>(L, R);
1066}
1067 
1068template <typename LHS, typename RHS>
1069inline BinaryOp_match<LHS, RHS, Instruction::FDiv> m_FDiv(const LHS &L,
1070                                                          const RHS &R) {
1071  return BinaryOp_match<LHS, RHS, Instruction::FDiv>(L, R);
1072}
1073 
1074template <typename LHS, typename RHS>
1075inline BinaryOp_match<LHS, RHS, Instruction::URem> m_URem(const LHS &L,
1076                                                          const RHS &R) {
1077  return BinaryOp_match<LHS, RHS, Instruction::URem>(L, R);
1078}
1079 
1080template <typename LHS, typename RHS>
1081inline BinaryOp_match<LHS, RHS, Instruction::SRem> m_SRem(const LHS &L,
1082                                                          const RHS &R) {
1083  return BinaryOp_match<LHS, RHS, Instruction::SRem>(L, R);
1084}
1085 
1086template <typename LHS, typename RHS>
1087inline BinaryOp_match<LHS, RHS, Instruction::FRem> m_FRem(const LHS &L,
1088                                                          const RHS &R) {
1089  return BinaryOp_match<LHS, RHS, Instruction::FRem>(L, R);
1090}
1091 
1092template <typename LHS, typename RHS>
1093inline BinaryOp_match<LHS, RHS, Instruction::And> m_And(const LHS &L,
1094                                                        const RHS &R) {
1095  return BinaryOp_match<LHS, RHS, Instruction::And>(L, R);
1096}
1097 
1098template <typename LHS, typename RHS>
1099inline BinaryOp_match<LHS, RHS, Instruction::Or> m_Or(const LHS &L,
1100                                                      const RHS &R) {
1101  return BinaryOp_match<LHS, RHS, Instruction::Or>(L, R);
1102}
1103 
1104template <typename LHS, typename RHS>
1105inline BinaryOp_match<LHS, RHS, Instruction::Xor> m_Xor(const LHS &L,
1106                                                        const RHS &R) {
1107  return BinaryOp_match<LHS, RHS, Instruction::Xor>(L, R);
1108}
1109 
1110template <typename LHS, typename RHS>
1111inline BinaryOp_match<LHS, RHS, Instruction::Shl> m_Shl(const LHS &L,
1112                                                        const RHS &R) {
1113  return BinaryOp_match<LHS, RHS, Instruction::Shl>(L, R);
1114}
1115 
1116template <typename LHS, typename RHS>
1117inline BinaryOp_match<LHS, RHS, Instruction::LShr> m_LShr(const LHS &L,
1118                                                          const RHS &R) {
1119  return BinaryOp_match<LHS, RHS, Instruction::LShr>(L, R);
1120}
1121 
1122template <typename LHS, typename RHS>
1123inline BinaryOp_match<LHS, RHS, Instruction::AShr> m_AShr(const LHS &L,
1124                                                          const RHS &R) {
1125  return BinaryOp_match<LHS, RHS, Instruction::AShr>(L, R);
1126}
1127 
1128template <typename LHS_t, typename RHS_t, unsigned Opcode,
1129          unsigned WrapFlags = 0>
1130struct OverflowingBinaryOp_match {
1131  LHS_t L;
1132  RHS_t R;
1133 
1134  OverflowingBinaryOp_match(const LHS_t &LHS, const RHS_t &RHS)
1135      : L(LHS), R(RHS) {}
1136 
1137  template <typename OpTy> bool match(OpTy *V) {
1138    if (auto *Op = dyn_cast<OverflowingBinaryOperator>(V)) {
1139      if (Op->getOpcode() != Opcode)
1140        return false;
1141      if ((WrapFlags & OverflowingBinaryOperator::NoUnsignedWrap) &&
1142          !Op->hasNoUnsignedWrap())
1143        return false;
1144      if ((WrapFlags & OverflowingBinaryOperator::NoSignedWrap) &&
1145          !Op->hasNoSignedWrap())
1146        return false;
1147      return L.match(Op->getOperand(0)) && R.match(Op->getOperand(1));
1148    }
1149    return false;
1150  }
1151};
1152 
1153template <typename LHS, typename RHS>
1154inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Add,
1155                                 OverflowingBinaryOperator::NoSignedWrap>
1156m_NSWAdd(const LHS &L, const RHS &R) {
1157  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Add,
1158                                   OverflowingBinaryOperator::NoSignedWrap>(L,
1159                                                                            R);
1160}
1161template <typename LHS, typename RHS>
1162inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Sub,
1163                                 OverflowingBinaryOperator::NoSignedWrap>
1164m_NSWSub(const LHS &L, const RHS &R) {
1165  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Sub,
1166                                   OverflowingBinaryOperator::NoSignedWrap>(L,
1167                                                                            R);
1168}
1169template <typename LHS, typename RHS>
1170inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Mul,
1171                                 OverflowingBinaryOperator::NoSignedWrap>
1172m_NSWMul(const LHS &L, const RHS &R) {
1173  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Mul,
1174                                   OverflowingBinaryOperator::NoSignedWrap>(L,
1175                                                                            R);
1176}
1177template <typename LHS, typename RHS>
1178inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Shl,
1179                                 OverflowingBinaryOperator::NoSignedWrap>
1180m_NSWShl(const LHS &L, const RHS &R) {
1181  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Shl,
1182                                   OverflowingBinaryOperator::NoSignedWrap>(L,
1183                                                                            R);
1184}
1185 
1186template <typename LHS, typename RHS>
1187inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Add,
1188                                 OverflowingBinaryOperator::NoUnsignedWrap>
1189m_NUWAdd(const LHS &L, const RHS &R) {
1190  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Add,
1191                                   OverflowingBinaryOperator::NoUnsignedWrap>(
1192      L, R);
1193}
1194template <typename LHS, typename RHS>
1195inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Sub,
1196                                 OverflowingBinaryOperator::NoUnsignedWrap>
1197m_NUWSub(const LHS &L, const RHS &R) {
1198  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Sub,
1199                                   OverflowingBinaryOperator::NoUnsignedWrap>(
1200      L, R);
1201}
1202template <typename LHS, typename RHS>
1203inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Mul,
1204                                 OverflowingBinaryOperator::NoUnsignedWrap>
1205m_NUWMul(const LHS &L, const RHS &R) {
1206  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Mul,
1207                                   OverflowingBinaryOperator::NoUnsignedWrap>(
1208      L, R);
1209}
1210template <typename LHS, typename RHS>
1211inline OverflowingBinaryOp_match<LHS, RHS, Instruction::Shl,
1212                                 OverflowingBinaryOperator::NoUnsignedWrap>
1213m_NUWShl(const LHS &L, const RHS &R) {
1214  return OverflowingBinaryOp_match<LHS, RHS, Instruction::Shl,
1215                                   OverflowingBinaryOperator::NoUnsignedWrap>(
1216      L, R);
1217}
1218 
1219template <typename LHS_t, typename RHS_t, bool Commutable = false>
1220struct SpecificBinaryOp_match
1221    : public BinaryOp_match<LHS_t, RHS_t, 0, Commutable> {
1222  unsigned Opcode;
1223 
1224  SpecificBinaryOp_match(unsigned Opcode, const LHS_t &LHS, const RHS_t &RHS)
1225      : BinaryOp_match<LHS_t, RHS_t, 0, Commutable>(LHS, RHS), Opcode(Opcode) {}
1226 
1227  template <typename OpTy> bool match(OpTy *V) {
1228    return BinaryOp_match<LHS_t, RHS_t, 0, Commutable>::match(Opcode, V);
1229  }
1230};
1231 
1232/// Matches a specific opcode.
1233template <typename LHS, typename RHS>
1234inline SpecificBinaryOp_match<LHS, RHS> m_BinOp(unsigned Opcode, const LHS &L,
1235                                                const RHS &R) {
1236  return SpecificBinaryOp_match<LHS, RHS>(Opcode, L, R);
1237}
1238 
1239//===----------------------------------------------------------------------===//
1240// Class that matches a group of binary opcodes.
1241//
1242template <typename LHS_t, typename RHS_t, typename Predicate>
1243struct BinOpPred_match : Predicate {
1244  LHS_t L;
1245  RHS_t R;
1246 
1247  BinOpPred_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
1248 
1249  template <typename OpTy> bool match(OpTy *V) {
1250    if (auto *I = dyn_cast<Instruction>(V))
1251      return this->isOpType(I->getOpcode()) && L.match(I->getOperand(0)) &&
1252             R.match(I->getOperand(1));
1253    if (auto *CE = dyn_cast<ConstantExpr>(V))
1254      return this->isOpType(CE->getOpcode()) && L.match(CE->getOperand(0)) &&
1255             R.match(CE->getOperand(1));
1256    return false;
1257  }
1258};
1259 
1260struct is_shift_op {
1261  bool isOpType(unsigned Opcode) { return Instruction::isShift(Opcode); }
1262};
1263 
1264struct is_right_shift_op {
1265  bool isOpType(unsigned Opcode) {
1266    return Opcode == Instruction::LShr || Opcode == Instruction::AShr;
1267  }
1268};
1269 
1270struct is_logical_shift_op {
1271  bool isOpType(unsigned Opcode) {
1272    return Opcode == Instruction::LShr || Opcode == Instruction::Shl;
1273  }
1274};
1275 
1276struct is_bitwiselogic_op {
1277  bool isOpType(unsigned Opcode) {
1278    return Instruction::isBitwiseLogicOp(Opcode);
1279  }
1280};
1281 
1282struct is_idiv_op {
1283  bool isOpType(unsigned Opcode) {
1284    return Opcode == Instruction::SDiv || Opcode == Instruction::UDiv;
1285  }
1286};
1287 
1288struct is_irem_op {
1289  bool isOpType(unsigned Opcode) {
1290    return Opcode == Instruction::SRem || Opcode == Instruction::URem;
1291  }
1292};
1293 
1294/// Matches shift operations.
1295template <typename LHS, typename RHS>
1296inline BinOpPred_match<LHS, RHS, is_shift_op> m_Shift(const LHS &L,
1297                                                      const RHS &R) {
1298  return BinOpPred_match<LHS, RHS, is_shift_op>(L, R);
1299}
1300 
1301/// Matches logical shift operations.
1302template <typename LHS, typename RHS>
1303inline BinOpPred_match<LHS, RHS, is_right_shift_op> m_Shr(const LHS &L,
1304                                                          const RHS &R) {
1305  return BinOpPred_match<LHS, RHS, is_right_shift_op>(L, R);
1306}
1307 
1308/// Matches logical shift operations.
1309template <typename LHS, typename RHS>
1310inline BinOpPred_match<LHS, RHS, is_logical_shift_op>
1311m_LogicalShift(const LHS &L, const RHS &R) {
1312  return BinOpPred_match<LHS, RHS, is_logical_shift_op>(L, R);
1313}
1314 
1315/// Matches bitwise logic operations.
1316template <typename LHS, typename RHS>
1317inline BinOpPred_match<LHS, RHS, is_bitwiselogic_op>
1318m_BitwiseLogic(const LHS &L, const RHS &R) {
1319  return BinOpPred_match<LHS, RHS, is_bitwiselogic_op>(L, R);
1320}
1321 
1322/// Matches integer division operations.
1323template <typename LHS, typename RHS>
1324inline BinOpPred_match<LHS, RHS, is_idiv_op> m_IDiv(const LHS &L,
1325                                                    const RHS &R) {
1326  return BinOpPred_match<LHS, RHS, is_idiv_op>(L, R);
1327}
1328 
1329/// Matches integer remainder operations.
1330template <typename LHS, typename RHS>
1331inline BinOpPred_match<LHS, RHS, is_irem_op> m_IRem(const LHS &L,
1332                                                    const RHS &R) {
1333  return BinOpPred_match<LHS, RHS, is_irem_op>(L, R);
1334}
1335 
1336//===----------------------------------------------------------------------===//
1337// Class that matches exact binary ops.
1338//
1339template <typename SubPattern_t> struct Exact_match {
1340  SubPattern_t SubPattern;
1341 
1342  Exact_match(const SubPattern_t &SP) : SubPattern(SP) {}
1343 
1344  template <typename OpTy> bool match(OpTy *V) {
1345    if (auto *PEO = dyn_cast<PossiblyExactOperator>(V))
1346      return PEO->isExact() && SubPattern.match(V);
1347    return false;
1348  }
1349};
1350 
1351template <typename T> inline Exact_match<T> m_Exact(const T &SubPattern) {
1352  return SubPattern;
1353}
1354 
1355//===----------------------------------------------------------------------===//
1356// Matchers for CmpInst classes
1357//
1358 
1359template <typename LHS_t, typename RHS_t, typename Class, typename PredicateTy,
1360          bool Commutable = false>
1361struct CmpClass_match {
1362  PredicateTy &Predicate;
1363  LHS_t L;
1364  RHS_t R;
1365 
1366  // The evaluation order is always stable, regardless of Commutability.
1367  // The LHS is always matched first.
1368  CmpClass_match(PredicateTy &Pred, const LHS_t &LHS, const RHS_t &RHS)
1369      : Predicate(Pred), L(LHS), R(RHS) {}
1370 
1371  template <typename OpTy> bool match(OpTy *V) {
1372    if (auto *I = dyn_cast<Class>(V)) {
1373      if (L.match(I->getOperand(0)) && R.match(I->getOperand(1))) {
1374        Predicate = I->getPredicate();
1375        return true;
1376      } else if (Commutable && L.match(I->getOperand(1)) &&
1377                 R.match(I->getOperand(0))) {
1378        Predicate = I->getSwappedPredicate();
1379        return true;
1380      }
1381    }
1382    return false;
1383  }
1384};
1385 
1386template <typename LHS, typename RHS>
1387inline CmpClass_match<LHS, RHS, CmpInst, CmpInst::Predicate>
1388m_Cmp(CmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
1389  return CmpClass_match<LHS, RHS, CmpInst, CmpInst::Predicate>(Pred, L, R);
1390}
1391 
1392template <typename LHS, typename RHS>
1393inline CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate>
1394m_ICmp(ICmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
1395  return CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate>(Pred, L, R);
1396}
1397 
1398template <typename LHS, typename RHS>
1399inline CmpClass_match<LHS, RHS, FCmpInst, FCmpInst::Predicate>
1400m_FCmp(FCmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
1401  return CmpClass_match<LHS, RHS, FCmpInst, FCmpInst::Predicate>(Pred, L, R);
1402}
1403 
1404//===----------------------------------------------------------------------===//
1405// Matchers for instructions with a given opcode and number of operands.
1406//
1407 
1408/// Matches instructions with Opcode and three operands.
1409template <typename T0, unsigned Opcode> struct OneOps_match {
1410  T0 Op1;
1411 
1412  OneOps_match(const T0 &Op1) : Op1(Op1) {}
1413 
1414  template <typename OpTy> bool match(OpTy *V) {
1415    if (V->getValueID() == Value::InstructionVal + Opcode) {
1416      auto *I = cast<Instruction>(V);
1417      return Op1.match(I->getOperand(0));
1418    }
1419    return false;
1420  }
1421};
1422 
1423/// Matches instructions with Opcode and three operands.
1424template <typename T0, typename T1, unsigned Opcode> struct TwoOps_match {
1425  T0 Op1;
1426  T1 Op2;
1427 
1428  TwoOps_match(const T0 &Op1, const T1 &Op2) : Op1(Op1), Op2(Op2) {}
1429 
1430  template <typename OpTy> bool match(OpTy *V) {
1431    if (V->getValueID() == Value::InstructionVal + Opcode) {
1432      auto *I = cast<Instruction>(V);
1433      return Op1.match(I->getOperand(0)) && Op2.match(I->getOperand(1));
1434    }
1435    return false;
1436  }
1437};
1438 
1439/// Matches instructions with Opcode and three operands.
1440template <typename T0, typename T1, typename T2, unsigned Opcode>
1441struct ThreeOps_match {
1442  T0 Op1;
1443  T1 Op2;
1444  T2 Op3;
1445 
1446  ThreeOps_match(const T0 &Op1, const T1 &Op2, const T2 &Op3)
1447      : Op1(Op1), Op2(Op2), Op3(Op3) {}
1448 
1449  template <typename OpTy> bool match(OpTy *V) {
1450    if (V->getValueID() == Value::InstructionVal + Opcode) {
65
←
Called C++ object pointer is null
1451      auto *I = cast<Instruction>(V);
1452      return Op1.match(I->getOperand(0)) && Op2.match(I->getOperand(1)) &&
1453             Op3.match(I->getOperand(2));
1454    }
1455    return false;
1456  }
1457};
1458 
1459/// Matches SelectInst.
1460template <typename Cond, typename LHS, typename RHS>
1461inline ThreeOps_match<Cond, LHS, RHS, Instruction::Select>
1462m_Select(const Cond &C, const LHS &L, const RHS &R) {
1463  return ThreeOps_match<Cond, LHS, RHS, Instruction::Select>(C, L, R);
1464}
1465 
1466/// This matches a select of two constants, e.g.:
1467/// m_SelectCst<-1, 0>(m_Value(V))
1468template <int64_t L, int64_t R, typename Cond>
1469inline ThreeOps_match<Cond, constantint_match<L>, constantint_match<R>,
1470                      Instruction::Select>
1471m_SelectCst(const Cond &C) {
1472  return m_Select(C, m_ConstantInt<L>(), m_ConstantInt<R>());
1473}
1474 
1475/// Matches FreezeInst.
1476template <typename OpTy>
1477inline OneOps_match<OpTy, Instruction::Freeze> m_Freeze(const OpTy &Op) {
1478  return OneOps_match<OpTy, Instruction::Freeze>(Op);
1479}
1480 
1481/// Matches InsertElementInst.
1482template <typename Val_t, typename Elt_t, typename Idx_t>
1483inline ThreeOps_match<Val_t, Elt_t, Idx_t, Instruction::InsertElement>
1484m_InsertElt(const Val_t &Val, const Elt_t &Elt, const Idx_t &Idx) {
1485  return ThreeOps_match<Val_t, Elt_t, Idx_t, Instruction::InsertElement>(
1486      Val, Elt, Idx);
1487}
1488 
1489/// Matches ExtractElementInst.
1490template <typename Val_t, typename Idx_t>
1491inline TwoOps_match<Val_t, Idx_t, Instruction::ExtractElement>
1492m_ExtractElt(const Val_t &Val, const Idx_t &Idx) {
1493  return TwoOps_match<Val_t, Idx_t, Instruction::ExtractElement>(Val, Idx);
1494}
1495 
1496/// Matches shuffle.
1497template <typename T0, typename T1, typename T2> struct Shuffle_match {
1498  T0 Op1;
1499  T1 Op2;
1500  T2 Mask;
1501 
1502  Shuffle_match(const T0 &Op1, const T1 &Op2, const T2 &Mask)
1503      : Op1(Op1), Op2(Op2), Mask(Mask) {}
1504 
1505  template <typename OpTy> bool match(OpTy *V) {
1506    if (auto *I = dyn_cast<ShuffleVectorInst>(V)) {
1507      return Op1.match(I->getOperand(0)) && Op2.match(I->getOperand(1)) &&
1508             Mask.match(I->getShuffleMask());
1509    }
1510    return false;
1511  }
1512};
1513 
1514struct m_Mask {
1515  ArrayRef<int> &MaskRef;
1516  m_Mask(ArrayRef<int> &MaskRef) : MaskRef(MaskRef) {}
1517  bool match(ArrayRef<int> Mask) {
1518    MaskRef = Mask;
1519    return true;
1520  }
1521};
1522 
1523struct m_ZeroMask {
1524  bool match(ArrayRef<int> Mask) {
1525    return all_of(Mask, [](int Elem) { return Elem == 0 || Elem == -1; });
1526  }
1527};
1528 
1529struct m_SpecificMask {
1530  ArrayRef<int> &MaskRef;
1531  m_SpecificMask(ArrayRef<int> &MaskRef) : MaskRef(MaskRef) {}
1532  bool match(ArrayRef<int> Mask) { return MaskRef == Mask; }
1533};
1534 
1535struct m_SplatOrUndefMask {
1536  int &SplatIndex;
1537  m_SplatOrUndefMask(int &SplatIndex) : SplatIndex(SplatIndex) {}
1538  bool match(ArrayRef<int> Mask) {
1539    const auto *First = find_if(Mask, [](int Elem) { return Elem != -1; });
1540    if (First == Mask.end())
1541      return false;
1542    SplatIndex = *First;
1543    return all_of(Mask,
1544                  [First](int Elem) { return Elem == *First || Elem == -1; });
1545  }
1546};
1547 
1548/// Matches ShuffleVectorInst independently of mask value.
1549template <typename V1_t, typename V2_t>
1550inline TwoOps_match<V1_t, V2_t, Instruction::ShuffleVector>
1551m_Shuffle(const V1_t &v1, const V2_t &v2) {
1552  return TwoOps_match<V1_t, V2_t, Instruction::ShuffleVector>(v1, v2);
1553}
1554 
1555template <typename V1_t, typename V2_t, typename Mask_t>
1556inline Shuffle_match<V1_t, V2_t, Mask_t>
1557m_Shuffle(const V1_t &v1, const V2_t &v2, const Mask_t &mask) {
1558  return Shuffle_match<V1_t, V2_t, Mask_t>(v1, v2, mask);
1559}
1560 
1561/// Matches LoadInst.
1562template <typename OpTy>
1563inline OneOps_match<OpTy, Instruction::Load> m_Load(const OpTy &Op) {
1564  return OneOps_match<OpTy, Instruction::Load>(Op);
1565}
1566 
1567/// Matches StoreInst.
1568template <typename ValueOpTy, typename PointerOpTy>
1569inline TwoOps_match<ValueOpTy, PointerOpTy, Instruction::Store>
1570m_Store(const ValueOpTy &ValueOp, const PointerOpTy &PointerOp) {
1571  return TwoOps_match<ValueOpTy, PointerOpTy, Instruction::Store>(ValueOp,
1572                                                                  PointerOp);
1573}
1574 
1575//===----------------------------------------------------------------------===//
1576// Matchers for CastInst classes
1577//
1578 
1579template <typename Op_t, unsigned Opcode> struct CastClass_match {
1580  Op_t Op;
1581 
1582  CastClass_match(const Op_t &OpMatch) : Op(OpMatch) {}
1583 
1584  template <typename OpTy> bool match(OpTy *V) {
1585    if (auto *O = dyn_cast<Operator>(V))
1586      return O->getOpcode() == Opcode && Op.match(O->getOperand(0));
1587    return false;
1588  }
1589};
1590 
1591/// Matches BitCast.
1592template <typename OpTy>
1593inline CastClass_match<OpTy, Instruction::BitCast> m_BitCast(const OpTy &Op) {
1594  return CastClass_match<OpTy, Instruction::BitCast>(Op);
1595}
1596 
1597/// Matches PtrToInt.
1598template <typename OpTy>
1599inline CastClass_match<OpTy, Instruction::PtrToInt> m_PtrToInt(const OpTy &Op) {
1600  return CastClass_match<OpTy, Instruction::PtrToInt>(Op);
1601}
1602 
1603/// Matches IntToPtr.
1604template <typename OpTy>
1605inline CastClass_match<OpTy, Instruction::IntToPtr> m_IntToPtr(const OpTy &Op) {
1606  return CastClass_match<OpTy, Instruction::IntToPtr>(Op);
1607}
1608 
1609/// Matches Trunc.
1610template <typename OpTy>
1611inline CastClass_match<OpTy, Instruction::Trunc> m_Trunc(const OpTy &Op) {
1612  return CastClass_match<OpTy, Instruction::Trunc>(Op);
1613}
1614 
1615template <typename OpTy>
1616inline match_combine_or<CastClass_match<OpTy, Instruction::Trunc>, OpTy>
1617m_TruncOrSelf(const OpTy &Op) {
1618  return m_CombineOr(m_Trunc(Op), Op);
1619}
1620 
1621/// Matches SExt.
1622template <typename OpTy>
1623inline CastClass_match<OpTy, Instruction::SExt> m_SExt(const OpTy &Op) {
1624  return CastClass_match<OpTy, Instruction::SExt>(Op);
1625}
1626 
1627/// Matches ZExt.
1628template <typename OpTy>
1629inline CastClass_match<OpTy, Instruction::ZExt> m_ZExt(const OpTy &Op) {
1630  return CastClass_match<OpTy, Instruction::ZExt>(Op);
49
←
Returning without writing to 'Op.VR'→
1631}
1632 
1633template <typename OpTy>
1634inline match_combine_or<CastClass_match<OpTy, Instruction::ZExt>, OpTy>
1635m_ZExtOrSelf(const OpTy &Op) {
1636  return m_CombineOr(m_ZExt(Op), Op);
48
←
Calling 'm_ZExt<llvm::PatternMatch::bind_ty<llvm::Value>>'→
50
←
Returning from 'm_ZExt<llvm::PatternMatch::bind_ty<llvm::Value>>'→
51
←
Calling 'm_CombineOr<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::bind_ty<llvm::Value>, 39>, llvm::PatternMatch::bind_ty<llvm::Value>>'→
53
←
Returning from 'm_CombineOr<llvm::PatternMatch::CastClass_match<llvm::PatternMatch::bind_ty<llvm::Value>, 39>, llvm::PatternMatch::bind_ty<llvm::Value>>'→
54
←
Returning without writing to 'Op.VR'→
1637}
1638 
1639template <typename OpTy>
1640inline match_combine_or<CastClass_match<OpTy, Instruction::SExt>, OpTy>
1641m_SExtOrSelf(const OpTy &Op) {
1642  return m_CombineOr(m_SExt(Op), Op);
1643}
1644 
1645template <typename OpTy>
1646inline match_combine_or<CastClass_match<OpTy, Instruction::ZExt>,
1647                        CastClass_match<OpTy, Instruction::SExt>>
1648m_ZExtOrSExt(const OpTy &Op) {
1649  return m_CombineOr(m_ZExt(Op), m_SExt(Op));
1650}
1651 
1652template <typename OpTy>
1653inline match_combine_or<
1654    match_combine_or<CastClass_match<OpTy, Instruction::ZExt>,
1655                     CastClass_match<OpTy, Instruction::SExt>>,
1656    OpTy>
1657m_ZExtOrSExtOrSelf(const OpTy &Op) {
1658  return m_CombineOr(m_ZExtOrSExt(Op), Op);
1659}
1660 
1661template <typename OpTy>
1662inline CastClass_match<OpTy, Instruction::UIToFP> m_UIToFP(const OpTy &Op) {
1663  return CastClass_match<OpTy, Instruction::UIToFP>(Op);
1664}
1665 
1666template <typename OpTy>
1667inline CastClass_match<OpTy, Instruction::SIToFP> m_SIToFP(const OpTy &Op) {
1668  return CastClass_match<OpTy, Instruction::SIToFP>(Op);
1669}
1670 
1671template <typename OpTy>
1672inline CastClass_match<OpTy, Instruction::FPToUI> m_FPToUI(const OpTy &Op) {
1673  return CastClass_match<OpTy, Instruction::FPToUI>(Op);
1674}
1675 
1676template <typename OpTy>
1677inline CastClass_match<OpTy, Instruction::FPToSI> m_FPToSI(const OpTy &Op) {
1678  return CastClass_match<OpTy, Instruction::FPToSI>(Op);
1679}
1680 
1681template <typename OpTy>
1682inline CastClass_match<OpTy, Instruction::FPTrunc> m_FPTrunc(const OpTy &Op) {
1683  return CastClass_match<OpTy, Instruction::FPTrunc>(Op);
1684}
1685 
1686template <typename OpTy>
1687inline CastClass_match<OpTy, Instruction::FPExt> m_FPExt(const OpTy &Op) {
1688  return CastClass_match<OpTy, Instruction::FPExt>(Op);
1689}
1690 
1691//===----------------------------------------------------------------------===//
1692// Matchers for control flow.
1693//
1694 
1695struct br_match {
1696  BasicBlock *&Succ;
1697 
1698  br_match(BasicBlock *&Succ) : Succ(Succ) {}
1699 
1700  template <typename OpTy> bool match(OpTy *V) {
1701    if (auto *BI = dyn_cast<BranchInst>(V))
1702      if (BI->isUnconditional()) {
1703        Succ = BI->getSuccessor(0);
1704        return true;
1705      }
1706    return false;
1707  }
1708};
1709 
1710inline br_match m_UnconditionalBr(BasicBlock *&Succ) { return br_match(Succ); }
1711 
1712template <typename Cond_t, typename TrueBlock_t, typename FalseBlock_t>
1713struct brc_match {
1714  Cond_t Cond;
1715  TrueBlock_t T;
1716  FalseBlock_t F;
1717 
1718  brc_match(const Cond_t &C, const TrueBlock_t &t, const FalseBlock_t &f)
1719      : Cond(C), T(t), F(f) {}
1720 
1721  template <typename OpTy> bool match(OpTy *V) {
1722    if (auto *BI = dyn_cast<BranchInst>(V))
1723      if (BI->isConditional() && Cond.match(BI->getCondition()))
1724        return T.match(BI->getSuccessor(0)) && F.match(BI->getSuccessor(1));
1725    return false;
1726  }
1727};
1728 
1729template <typename Cond_t>
1730inline brc_match<Cond_t, bind_ty<BasicBlock>, bind_ty<BasicBlock>>
1731m_Br(const Cond_t &C, BasicBlock *&T, BasicBlock *&F) {
1732  return brc_match<Cond_t, bind_ty<BasicBlock>, bind_ty<BasicBlock>>(
1733      C, m_BasicBlock(T), m_BasicBlock(F));
1734}
1735 
1736template <typename Cond_t, typename TrueBlock_t, typename FalseBlock_t>
1737inline brc_match<Cond_t, TrueBlock_t, FalseBlock_t>
1738m_Br(const Cond_t &C, const TrueBlock_t &T, const FalseBlock_t &F) {
1739  return brc_match<Cond_t, TrueBlock_t, FalseBlock_t>(C, T, F);
1740}
1741 
1742//===----------------------------------------------------------------------===//
1743// Matchers for max/min idioms, eg: "select (sgt x, y), x, y" -> smax(x,y).
1744//
1745 
1746template <typename CmpInst_t, typename LHS_t, typename RHS_t, typename Pred_t,
1747          bool Commutable = false>
1748struct MaxMin_match {
1749  using PredType = Pred_t;
1750  LHS_t L;
1751  RHS_t R;
1752 
1753  // The evaluation order is always stable, regardless of Commutability.
1754  // The LHS is always matched first.
1755  MaxMin_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
1756 
1757  template <typename OpTy> bool match(OpTy *V) {
1758    if (auto *II = dyn_cast<IntrinsicInst>(V)) {
1759      Intrinsic::ID IID = II->getIntrinsicID();
1760      if ((IID == Intrinsic::smax && Pred_t::match(ICmpInst::ICMP_SGT)) ||
1761          (IID == Intrinsic::smin && Pred_t::match(ICmpInst::ICMP_SLT)) ||
1762          (IID == Intrinsic::umax && Pred_t::match(ICmpInst::ICMP_UGT)) ||
1763          (IID == Intrinsic::umin && Pred_t::match(ICmpInst::ICMP_ULT))) {
1764        Value *LHS = II->getOperand(0), *RHS = II->getOperand(1);
1765        return (L.match(LHS) && R.match(RHS)) ||
1766               (Commutable && L.match(RHS) && R.match(LHS));
1767      }
1768    }
1769    // Look for "(x pred y) ? x : y" or "(x pred y) ? y : x".
1770    auto *SI = dyn_cast<SelectInst>(V);
1771    if (!SI)
1772      return false;
1773    auto *Cmp = dyn_cast<CmpInst_t>(SI->getCondition());
1774    if (!Cmp)
1775      return false;
1776    // At this point we have a select conditioned on a comparison.  Check that
1777    // it is the values returned by the select that are being compared.
1778    auto *TrueVal = SI->getTrueValue();
1779    auto *FalseVal = SI->getFalseValue();
1780    auto *LHS = Cmp->getOperand(0);
1781    auto *RHS = Cmp->getOperand(1);
1782    if ((TrueVal != LHS || FalseVal != RHS) &&
1783        (TrueVal != RHS || FalseVal != LHS))
1784      return false;
1785    typename CmpInst_t::Predicate Pred =
1786        LHS == TrueVal ? Cmp->getPredicate() : Cmp->getInversePredicate();
1787    // Does "(x pred y) ? x : y" represent the desired max/min operation?
1788    if (!Pred_t::match(Pred))
1789      return false;
1790    // It does!  Bind the operands.
1791    return (L.match(LHS) && R.match(RHS)) ||
1792           (Commutable && L.match(RHS) && R.match(LHS));
1793  }
1794};
1795 
1796/// Helper class for identifying signed max predicates.
1797struct smax_pred_ty {
1798  static bool match(ICmpInst::Predicate Pred) {
1799    return Pred == CmpInst::ICMP_SGT || Pred == CmpInst::ICMP_SGE;
1800  }
1801};
1802 
1803/// Helper class for identifying signed min predicates.
1804struct smin_pred_ty {
1805  static bool match(ICmpInst::Predicate Pred) {
1806    return Pred == CmpInst::ICMP_SLT || Pred == CmpInst::ICMP_SLE;
1807  }
1808};
1809 
1810/// Helper class for identifying unsigned max predicates.
1811struct umax_pred_ty {
1812  static bool match(ICmpInst::Predicate Pred) {
1813    return Pred == CmpInst::ICMP_UGT || Pred == CmpInst::ICMP_UGE;
1814  }
1815};
1816 
1817/// Helper class for identifying unsigned min predicates.
1818struct umin_pred_ty {
1819  static bool match(ICmpInst::Predicate Pred) {
1820    return Pred == CmpInst::ICMP_ULT || Pred == CmpInst::ICMP_ULE;
1821  }
1822};
1823 
1824/// Helper class for identifying ordered max predicates.
1825struct ofmax_pred_ty {
1826  static bool match(FCmpInst::Predicate Pred) {
1827    return Pred == CmpInst::FCMP_OGT || Pred == CmpInst::FCMP_OGE;
1828  }
1829};
1830 
1831/// Helper class for identifying ordered min predicates.
1832struct ofmin_pred_ty {
1833  static bool match(FCmpInst::Predicate Pred) {
1834    return Pred == CmpInst::FCMP_OLT || Pred == CmpInst::FCMP_OLE;
1835  }
1836};
1837 
1838/// Helper class for identifying unordered max predicates.
1839struct ufmax_pred_ty {
1840  static bool match(FCmpInst::Predicate Pred) {
1841    return Pred == CmpInst::FCMP_UGT || Pred == CmpInst::FCMP_UGE;
1842  }
1843};
1844 
1845/// Helper class for identifying unordered min predicates.
1846struct ufmin_pred_ty {
1847  static bool match(FCmpInst::Predicate Pred) {
1848    return Pred == CmpInst::FCMP_ULT || Pred == CmpInst::FCMP_ULE;
1849  }
1850};
1851 
1852template <typename LHS, typename RHS>
1853inline MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty> m_SMax(const LHS &L,
1854                                                             const RHS &R) {
1855  return MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty>(L, R);
1856}
1857 
1858template <typename LHS, typename RHS>
1859inline MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty> m_SMin(const LHS &L,
1860                                                             const RHS &R) {
1861  return MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty>(L, R);
1862}
1863 
1864template <typename LHS, typename RHS>
1865inline MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty> m_UMax(const LHS &L,
1866                                                             const RHS &R) {
1867  return MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty>(L, R);
1868}
1869 
1870template <typename LHS, typename RHS>
1871inline MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty> m_UMin(const LHS &L,
1872                                                             const RHS &R) {
1873  return MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty>(L, R);
1874}
1875 
1876template <typename LHS, typename RHS>
1877inline match_combine_or<
1878    match_combine_or<MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty>,
1879                     MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty>>,
1880    match_combine_or<MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty>,
1881                     MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty>>>
1882m_MaxOrMin(const LHS &L, const RHS &R) {
1883  return m_CombineOr(m_CombineOr(m_SMax(L, R), m_SMin(L, R)),
1884                     m_CombineOr(m_UMax(L, R), m_UMin(L, R)));
1885}
1886 
1887/// Match an 'ordered' floating point maximum function.
1888/// Floating point has one special value 'NaN'. Therefore, there is no total
1889/// order. However, if we can ignore the 'NaN' value (for example, because of a
1890/// 'no-nans-float-math' flag) a combination of a fcmp and select has 'maximum'
1891/// semantics. In the presence of 'NaN' we have to preserve the original
1892/// select(fcmp(ogt/ge, L, R), L, R) semantics matched by this predicate.
1893///
1894///                         max(L, R)  iff L and R are not NaN
1895///  m_OrdFMax(L, R) =      R          iff L or R are NaN
1896template <typename LHS, typename RHS>
1897inline MaxMin_match<FCmpInst, LHS, RHS, ofmax_pred_ty> m_OrdFMax(const LHS &L,
1898                                                                 const RHS &R) {
1899  return MaxMin_match<FCmpInst, LHS, RHS, ofmax_pred_ty>(L, R);
1900}
1901 
1902/// Match an 'ordered' floating point minimum function.
1903/// Floating point has one special value 'NaN'. Therefore, there is no total
1904/// order. However, if we can ignore the 'NaN' value (for example, because of a
1905/// 'no-nans-float-math' flag) a combination of a fcmp and select has 'minimum'
1906/// semantics. In the presence of 'NaN' we have to preserve the original
1907/// select(fcmp(olt/le, L, R), L, R) semantics matched by this predicate.
1908///
1909///                         min(L, R)  iff L and R are not NaN
1910///  m_OrdFMin(L, R) =      R          iff L or R are NaN
1911template <typename LHS, typename RHS>
1912inline MaxMin_match<FCmpInst, LHS, RHS, ofmin_pred_ty> m_OrdFMin(const LHS &L,
1913                                                                 const RHS &R) {
1914  return MaxMin_match<FCmpInst, LHS, RHS, ofmin_pred_ty>(L, R);
1915}
1916 
1917/// Match an 'unordered' floating point maximum function.
1918/// Floating point has one special value 'NaN'. Therefore, there is no total
1919/// order. However, if we can ignore the 'NaN' value (for example, because of a
1920/// 'no-nans-float-math' flag) a combination of a fcmp and select has 'maximum'
1921/// semantics. In the presence of 'NaN' we have to preserve the original
1922/// select(fcmp(ugt/ge, L, R), L, R) semantics matched by this predicate.
1923///
1924///                         max(L, R)  iff L and R are not NaN
1925///  m_UnordFMax(L, R) =    L          iff L or R are NaN
1926template <typename LHS, typename RHS>
1927inline MaxMin_match<FCmpInst, LHS, RHS, ufmax_pred_ty>
1928m_UnordFMax(const LHS &L, const RHS &R) {
1929  return MaxMin_match<FCmpInst, LHS, RHS, ufmax_pred_ty>(L, R);
1930}
1931 
1932/// Match an 'unordered' floating point minimum function.
1933/// Floating point has one special value 'NaN'. Therefore, there is no total
1934/// order. However, if we can ignore the 'NaN' value (for example, because of a
1935/// 'no-nans-float-math' flag) a combination of a fcmp and select has 'minimum'
1936/// semantics. In the presence of 'NaN' we have to preserve the original
1937/// select(fcmp(ult/le, L, R), L, R) semantics matched by this predicate.
1938///
1939///                          min(L, R)  iff L and R are not NaN
1940///  m_UnordFMin(L, R) =     L          iff L or R are NaN
1941template <typename LHS, typename RHS>
1942inline MaxMin_match<FCmpInst, LHS, RHS, ufmin_pred_ty>
1943m_UnordFMin(const LHS &L, const RHS &R) {
1944  return MaxMin_match<FCmpInst, LHS, RHS, ufmin_pred_ty>(L, R);
1945}
1946 
1947//===----------------------------------------------------------------------===//
1948// Matchers for overflow check patterns: e.g. (a + b) u< a, (a ^ -1) <u b
1949// Note that S might be matched to other instructions than AddInst.
1950//
1951 
1952template <typename LHS_t, typename RHS_t, typename Sum_t>
1953struct UAddWithOverflow_match {
1954  LHS_t L;
1955  RHS_t R;
1956  Sum_t S;
1957 
1958  UAddWithOverflow_match(const LHS_t &L, const RHS_t &R, const Sum_t &S)
1959      : L(L), R(R), S(S) {}
1960 
1961  template <typename OpTy> bool match(OpTy *V) {
1962    Value *ICmpLHS, *ICmpRHS;
1963    ICmpInst::Predicate Pred;
1964    if (!m_ICmp(Pred, m_Value(ICmpLHS), m_Value(ICmpRHS)).match(V))
1965      return false;
1966 
1967    Value *AddLHS, *AddRHS;
1968    auto AddExpr = m_Add(m_Value(AddLHS), m_Value(AddRHS));
1969 
1970    // (a + b) u< a, (a + b) u< b
1971    if (Pred == ICmpInst::ICMP_ULT)
1972      if (AddExpr.match(ICmpLHS) && (ICmpRHS == AddLHS || ICmpRHS == AddRHS))
1973        return L.match(AddLHS) && R.match(AddRHS) && S.match(ICmpLHS);
1974 
1975    // a >u (a + b), b >u (a + b)
1976    if (Pred == ICmpInst::ICMP_UGT)
1977      if (AddExpr.match(ICmpRHS) && (ICmpLHS == AddLHS || ICmpLHS == AddRHS))
1978        return L.match(AddLHS) && R.match(AddRHS) && S.match(ICmpRHS);
1979 
1980    Value *Op1;
1981    auto XorExpr = m_OneUse(m_Xor(m_Value(Op1), m_AllOnes()));
1982    // (a ^ -1) <u b
1983    if (Pred == ICmpInst::ICMP_ULT) {
1984      if (XorExpr.match(ICmpLHS))
1985        return L.match(Op1) && R.match(ICmpRHS) && S.match(ICmpLHS);
1986    }
1987    //  b > u (a ^ -1)
1988    if (Pred == ICmpInst::ICMP_UGT) {
1989      if (XorExpr.match(ICmpRHS))
1990        return L.match(Op1) && R.match(ICmpLHS) && S.match(ICmpRHS);
1991    }
1992 
1993    // Match special-case for increment-by-1.
1994    if (Pred == ICmpInst::ICMP_EQ) {
1995      // (a + 1) == 0
1996      // (1 + a) == 0
1997      if (AddExpr.match(ICmpLHS) && m_ZeroInt().match(ICmpRHS) &&
1998          (m_One().match(AddLHS) || m_One().match(AddRHS)))
1999        return L.match(AddLHS) && R.match(AddRHS) && S.match(ICmpLHS);
2000      // 0 == (a + 1)
2001      // 0 == (1 + a)
2002      if (m_ZeroInt().match(ICmpLHS) && AddExpr.match(ICmpRHS) &&
2003          (m_One().match(AddLHS) || m_One().match(AddRHS)))
2004        return L.match(AddLHS) && R.match(AddRHS) && S.match(ICmpRHS);
2005    }
2006 
2007    return false;
2008  }
2009};
2010 
2011/// Match an icmp instruction checking for unsigned overflow on addition.
2012///
2013/// S is matched to the addition whose result is being checked for overflow, and
2014/// L and R are matched to the LHS and RHS of S.
2015template <typename LHS_t, typename RHS_t, typename Sum_t>
2016UAddWithOverflow_match<LHS_t, RHS_t, Sum_t>
2017m_UAddWithOverflow(const LHS_t &L, const RHS_t &R, const Sum_t &S) {
2018  return UAddWithOverflow_match<LHS_t, RHS_t, Sum_t>(L, R, S);
2019}
2020 
2021template <typename Opnd_t> struct Argument_match {
2022  unsigned OpI;
2023  Opnd_t Val;
2024 
2025  Argument_match(unsigned OpIdx, const Opnd_t &V) : OpI(OpIdx), Val(V) {}
2026 
2027  template <typename OpTy> bool match(OpTy *V) {
2028    // FIXME: Should likely be switched to use `CallBase`.
2029    if (const auto *CI = dyn_cast<CallInst>(V))
2030      return Val.match(CI->getArgOperand(OpI));
2031    return false;
2032  }
2033};
2034 
2035/// Match an argument.
2036template <unsigned OpI, typename Opnd_t>
2037inline Argument_match<Opnd_t> m_Argument(const Opnd_t &Op) {
2038  return Argument_match<Opnd_t>(OpI, Op);
2039}
2040 
2041/// Intrinsic matchers.
2042struct IntrinsicID_match {
2043  unsigned ID;
2044 
2045  IntrinsicID_match(Intrinsic::ID IntrID) : ID(IntrID) {}
2046 
2047  template <typename OpTy> bool match(OpTy *V) {
2048    if (const auto *CI = dyn_cast<CallInst>(V))
2049      if (const auto *F = CI->getCalledFunction())
2050        return F->getIntrinsicID() == ID;
2051    return false;
2052  }
2053};
2054 
2055/// Intrinsic matches are combinations of ID matchers, and argument
2056/// matchers. Higher arity matcher are defined recursively in terms of and-ing
2057/// them with lower arity matchers. Here's some convenient typedefs for up to
2058/// several arguments, and more can be added as needed
2059template <typename T0 = void, typename T1 = void, typename T2 = void,
2060          typename T3 = void, typename T4 = void, typename T5 = void,
2061          typename T6 = void, typename T7 = void, typename T8 = void,
2062          typename T9 = void, typename T10 = void>
2063struct m_Intrinsic_Ty;
2064template <typename T0> struct m_Intrinsic_Ty<T0> {
2065  using Ty = match_combine_and<IntrinsicID_match, Argument_match<T0>>;
2066};
2067template <typename T0, typename T1> struct m_Intrinsic_Ty<T0, T1> {
2068  using Ty =
2069      match_combine_and<typename m_Intrinsic_Ty<T0>::Ty, Argument_match<T1>>;
2070};
2071template <typename T0, typename T1, typename T2>
2072struct m_Intrinsic_Ty<T0, T1, T2> {
2073  using Ty = match_combine_and<typename m_Intrinsic_Ty<T0, T1>::Ty,
2074                               Argument_match<T2>>;
2075};
2076template <typename T0, typename T1, typename T2, typename T3>
2077struct m_Intrinsic_Ty<T0, T1, T2, T3> {
2078  using Ty = match_combine_and<typename m_Intrinsic_Ty<T0, T1, T2>::Ty,
2079                               Argument_match<T3>>;
2080};
2081 
2082template <typename T0, typename T1, typename T2, typename T3, typename T4>
2083struct m_Intrinsic_Ty<T0, T1, T2, T3, T4> {
2084  using Ty = match_combine_and<typename m_Intrinsic_Ty<T0, T1, T2, T3>::Ty,
2085                               Argument_match<T4>>;
2086};
2087 
2088template <typename T0, typename T1, typename T2, typename T3, typename T4,
2089          typename T5>
2090struct m_Intrinsic_Ty<T0, T1, T2, T3, T4, T5> {
2091  using Ty = match_combine_and<typename m_Intrinsic_Ty<T0, T1, T2, T3, T4>::Ty,
2092                               Argument_match<T5>>;
2093};
2094 
2095/// Match intrinsic calls like this:
2096/// m_Intrinsic<Intrinsic::fabs>(m_Value(X))
2097template <Intrinsic::ID IntrID> inline IntrinsicID_match m_Intrinsic() {
2098  return IntrinsicID_match(IntrID);
2099}
2100 
2101/// Matches MaskedLoad Intrinsic.
2102template <typename Opnd0, typename Opnd1, typename Opnd2, typename Opnd3>
2103inline typename m_Intrinsic_Ty<Opnd0, Opnd1, Opnd2, Opnd3>::Ty
2104m_MaskedLoad(const Opnd0 &Op0, const Opnd1 &Op1, const Opnd2 &Op2,
2105             const Opnd3 &Op3) {
2106  return m_Intrinsic<Intrinsic::masked_load>(Op0, Op1, Op2, Op3);
2107}
2108 
2109/// Matches MaskedGather Intrinsic.
2110template <typename Opnd0, typename Opnd1, typename Opnd2, typename Opnd3>
2111inline typename m_Intrinsic_Ty<Opnd0, Opnd1, Opnd2, Opnd3>::Ty
2112m_MaskedGather(const Opnd0 &Op0, const Opnd1 &Op1, const Opnd2 &Op2,
2113               const Opnd3 &Op3) {
2114  return m_Intrinsic<Intrinsic::masked_gather>(Op0, Op1, Op2, Op3);
2115}
2116 
2117template <Intrinsic::ID IntrID, typename T0>
2118inline typename m_Intrinsic_Ty<T0>::Ty m_Intrinsic(const T0 &Op0) {
2119  return m_CombineAnd(m_Intrinsic<IntrID>(), m_Argument<0>(Op0));
2120}
2121 
2122template <Intrinsic::ID IntrID, typename T0, typename T1>
2123inline typename m_Intrinsic_Ty<T0, T1>::Ty m_Intrinsic(const T0 &Op0,
2124                                                       const T1 &Op1) {
2125  return m_CombineAnd(m_Intrinsic<IntrID>(Op0), m_Argument<1>(Op1));
2126}
2127 
2128template <Intrinsic::ID IntrID, typename T0, typename T1, typename T2>
2129inline typename m_Intrinsic_Ty<T0, T1, T2>::Ty
2130m_Intrinsic(const T0 &Op0, const T1 &Op1, const T2 &Op2) {
2131  return m_CombineAnd(m_Intrinsic<IntrID>(Op0, Op1), m_Argument<2>(Op2));
2132}
2133 
2134template <Intrinsic::ID IntrID, typename T0, typename T1, typename T2,
2135          typename T3>
2136inline typename m_Intrinsic_Ty<T0, T1, T2, T3>::Ty
2137m_Intrinsic(const T0 &Op0, const T1 &Op1, const T2 &Op2, const T3 &Op3) {
2138  return m_CombineAnd(m_Intrinsic<IntrID>(Op0, Op1, Op2), m_Argument<3>(Op3));
2139}
2140 
2141template <Intrinsic::ID IntrID, typename T0, typename T1, typename T2,
2142          typename T3, typename T4>
2143inline typename m_Intrinsic_Ty<T0, T1, T2, T3, T4>::Ty
2144m_Intrinsic(const T0 &Op0, const T1 &Op1, const T2 &Op2, const T3 &Op3,
2145            const T4 &Op4) {
2146  return m_CombineAnd(m_Intrinsic<IntrID>(Op0, Op1, Op2, Op3),
2147                      m_Argument<4>(Op4));
2148}
2149 
2150template <Intrinsic::ID IntrID, typename T0, typename T1, typename T2,
2151          typename T3, typename T4, typename T5>
2152inline typename m_Intrinsic_Ty<T0, T1, T2, T3, T4, T5>::Ty
2153m_Intrinsic(const T0 &Op0, const T1 &Op1, const T2 &Op2, const T3 &Op3,
2154            const T4 &Op4, const T5 &Op5) {
2155  return m_CombineAnd(m_Intrinsic<IntrID>(Op0, Op1, Op2, Op3, Op4),
2156                      m_Argument<5>(Op5));
2157}
2158 
2159// Helper intrinsic matching specializations.
2160template <typename Opnd0>
2161inline typename m_Intrinsic_Ty<Opnd0>::Ty m_BitReverse(const Opnd0 &Op0) {
2162  return m_Intrinsic<Intrinsic::bitreverse>(Op0);
2163}
2164 
2165template <typename Opnd0>
2166inline typename m_Intrinsic_Ty<Opnd0>::Ty m_BSwap(const Opnd0 &Op0) {
2167  return m_Intrinsic<Intrinsic::bswap>(Op0);
2168}
2169 
2170template <typename Opnd0>
2171inline typename m_Intrinsic_Ty<Opnd0>::Ty m_FAbs(const Opnd0 &Op0) {
2172  return m_Intrinsic<Intrinsic::fabs>(Op0);
2173}
2174 
2175template <typename Opnd0>
2176inline typename m_Intrinsic_Ty<Opnd0>::Ty m_FCanonicalize(const Opnd0 &Op0) {
2177  return m_Intrinsic<Intrinsic::canonicalize>(Op0);
2178}
2179 
2180template <typename Opnd0, typename Opnd1>
2181inline typename m_Intrinsic_Ty<Opnd0, Opnd1>::Ty m_FMin(const Opnd0 &Op0,
2182                                                        const Opnd1 &Op1) {
2183  return m_Intrinsic<Intrinsic::minnum>(Op0, Op1);
2184}
2185 
2186template <typename Opnd0, typename Opnd1>
2187inline typename m_Intrinsic_Ty<Opnd0, Opnd1>::Ty m_FMax(const Opnd0 &Op0,
2188                                                        const Opnd1 &Op1) {
2189  return m_Intrinsic<Intrinsic::maxnum>(Op0, Op1);
2190}
2191 
2192template <typename Opnd0, typename Opnd1, typename Opnd2>
2193inline typename m_Intrinsic_Ty<Opnd0, Opnd1, Opnd2>::Ty
2194m_FShl(const Opnd0 &Op0, const Opnd1 &Op1, const Opnd2 &Op2) {
2195  return m_Intrinsic<Intrinsic::fshl>(Op0, Op1, Op2);
2196}
2197 
2198template <typename Opnd0, typename Opnd1, typename Opnd2>
2199inline typename m_Intrinsic_Ty<Opnd0, Opnd1, Opnd2>::Ty
2200m_FShr(const Opnd0 &Op0, const Opnd1 &Op1, const Opnd2 &Op2) {
2201  return m_Intrinsic<Intrinsic::fshr>(Op0, Op1, Op2);
2202}
2203 
2204template <typename Opnd0>
2205inline typename m_Intrinsic_Ty<Opnd0>::Ty m_Sqrt(const Opnd0 &Op0) {
2206  return m_Intrinsic<Intrinsic::sqrt>(Op0);
2207}
2208 
2209template <typename Opnd0, typename Opnd1>
2210inline typename m_Intrinsic_Ty<Opnd0, Opnd1>::Ty m_CopySign(const Opnd0 &Op0,
2211                                                            const Opnd1 &Op1) {
2212  return m_Intrinsic<Intrinsic::copysign>(Op0, Op1);
2213}
2214 
2215template <typename Opnd0>
2216inline typename m_Intrinsic_Ty<Opnd0>::Ty m_VecReverse(const Opnd0 &Op0) {
2217  return m_Intrinsic<Intrinsic::experimental_vector_reverse>(Op0);
2218}
2219 
2220//===----------------------------------------------------------------------===//
2221// Matchers for two-operands operators with the operators in either order
2222//
2223 
2224/// Matches a BinaryOperator with LHS and RHS in either order.
2225template <typename LHS, typename RHS>
2226inline AnyBinaryOp_match<LHS, RHS, true> m_c_BinOp(const LHS &L, const RHS &R) {
2227  return AnyBinaryOp_match<LHS, RHS, true>(L, R);
11
←
Returning without writing to 'R.VR'→
2228}
2229 
2230/// Matches an ICmp with a predicate over LHS and RHS in either order.
2231/// Swaps the predicate if operands are commuted.
2232template <typename LHS, typename RHS>
2233inline CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate, true>
2234m_c_ICmp(ICmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
2235  return CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate, true>(Pred, L,
2236                                                                       R);
2237}
2238 
2239/// Matches a specific opcode with LHS and RHS in either order.
2240template <typename LHS, typename RHS>
2241inline SpecificBinaryOp_match<LHS, RHS, true>
2242m_c_BinOp(unsigned Opcode, const LHS &L, const RHS &R) {
2243  return SpecificBinaryOp_match<LHS, RHS, true>(Opcode, L, R);
2244}
2245 
2246/// Matches a Add with LHS and RHS in either order.
2247template <typename LHS, typename RHS>
2248inline BinaryOp_match<LHS, RHS, Instruction::Add, true> m_c_Add(const LHS &L,
2249                                                                const RHS &R) {
2250  return BinaryOp_match<LHS, RHS, Instruction::Add, true>(L, R);
2251}
2252 
2253/// Matches a Mul with LHS and RHS in either order.
2254template <typename LHS, typename RHS>
2255inline BinaryOp_match<LHS, RHS, Instruction::Mul, true> m_c_Mul(const LHS &L,
2256                                                                const RHS &R) {
2257  return BinaryOp_match<LHS, RHS, Instruction::Mul, true>(L, R);
2258}
2259 
2260/// Matches an And with LHS and RHS in either order.
2261template <typename LHS, typename RHS>
2262inline BinaryOp_match<LHS, RHS, Instruction::And, true> m_c_And(const LHS &L,
2263                                                                const RHS &R) {
2264  return BinaryOp_match<LHS, RHS, Instruction::And, true>(L, R);
2265}
2266 
2267/// Matches an Or with LHS and RHS in either order.
2268template <typename LHS, typename RHS>
2269inline BinaryOp_match<LHS, RHS, Instruction::Or, true> m_c_Or(const LHS &L,
2270                                                              const RHS &R) {
2271  return BinaryOp_match<LHS, RHS, Instruction::Or, true>(L, R);
2272}
2273 
2274/// Matches an Xor with LHS and RHS in either order.
2275template <typename LHS, typename RHS>
2276inline BinaryOp_match<LHS, RHS, Instruction::Xor, true> m_c_Xor(const LHS &L,
2277                                                                const RHS &R) {
2278  return BinaryOp_match<LHS, RHS, Instruction::Xor, true>(L, R);
2279}
2280 
2281/// Matches a 'Neg' as 'sub 0, V'.
2282template <typename ValTy>
2283inline BinaryOp_match<cst_pred_ty<is_zero_int>, ValTy, Instruction::Sub>
2284m_Neg(const ValTy &V) {
2285  return m_Sub(m_ZeroInt(), V);
2286}
2287 
2288/// Matches a 'Neg' as 'sub nsw 0, V'.
2289template <typename ValTy>
2290inline OverflowingBinaryOp_match<cst_pred_ty<is_zero_int>, ValTy,
2291                                 Instruction::Sub,
2292                                 OverflowingBinaryOperator::NoSignedWrap>
2293m_NSWNeg(const ValTy &V) {
2294  return m_NSWSub(m_ZeroInt(), V);
2295}
2296 
2297/// Matches a 'Not' as 'xor V, -1' or 'xor -1, V'.
2298/// NOTE: we first match the 'Not' (by matching '-1'),
2299/// and only then match the inner matcher!
2300template <typename ValTy>
2301inline BinaryOp_match<cst_pred_ty<is_all_ones>, ValTy, Instruction::Xor, true>
2302m_Not(const ValTy &V) {
2303  return m_c_Xor(m_AllOnes(), V);
2304}
2305 
2306template <typename ValTy> struct NotForbidUndef_match {
2307  ValTy Val;
2308  NotForbidUndef_match(const ValTy &V) : Val(V) {}
2309 
2310  template <typename OpTy> bool match(OpTy *V) {
2311    // We do not use m_c_Xor because that could match an arbitrary APInt that is
2312    // not -1 as C and then fail to match the other operand if it is -1.
2313    // This code should still work even when both operands are constants.
2314    Value *X;
2315    const APInt *C;
2316    if (m_Xor(m_Value(X), m_APIntForbidUndef(C)).match(V) && C->isAllOnes())
2317      return Val.match(X);
2318    if (m_Xor(m_APIntForbidUndef(C), m_Value(X)).match(V) && C->isAllOnes())
2319      return Val.match(X);
2320    return false;
2321  }
2322};
2323 
2324/// Matches a bitwise 'not' as 'xor V, -1' or 'xor -1, V'. For vectors, the
2325/// constant value must be composed of only -1 scalar elements.
2326template <typename ValTy>
2327inline NotForbidUndef_match<ValTy> m_NotForbidUndef(const ValTy &V) {
2328  return NotForbidUndef_match<ValTy>(V);
2329}
2330 
2331/// Matches an SMin with LHS and RHS in either order.
2332template <typename LHS, typename RHS>
2333inline MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty, true>
2334m_c_SMin(const LHS &L, const RHS &R) {
2335  return MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty, true>(L, R);
2336}
2337/// Matches an SMax with LHS and RHS in either order.
2338template <typename LHS, typename RHS>
2339inline MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty, true>
2340m_c_SMax(const LHS &L, const RHS &R) {
2341  return MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty, true>(L, R);
2342}
2343/// Matches a UMin with LHS and RHS in either order.
2344template <typename LHS, typename RHS>
2345inline MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty, true>
2346m_c_UMin(const LHS &L, const RHS &R) {
2347  return MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty, true>(L, R);
2348}
2349/// Matches a UMax with LHS and RHS in either order.
2350template <typename LHS, typename RHS>
2351inline MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty, true>
2352m_c_UMax(const LHS &L, const RHS &R) {
2353  return MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty, true>(L, R);
2354}
2355 
2356template <typename LHS, typename RHS>
2357inline match_combine_or<
2358    match_combine_or<MaxMin_match<ICmpInst, LHS, RHS, smax_pred_ty, true>,
2359                     MaxMin_match<ICmpInst, LHS, RHS, smin_pred_ty, true>>,
2360    match_combine_or<MaxMin_match<ICmpInst, LHS, RHS, umax_pred_ty, true>,
2361                     MaxMin_match<ICmpInst, LHS, RHS, umin_pred_ty, true>>>
2362m_c_MaxOrMin(const LHS &L, const RHS &R) {
2363  return m_CombineOr(m_CombineOr(m_c_SMax(L, R), m_c_SMin(L, R)),
2364                     m_CombineOr(m_c_UMax(L, R), m_c_UMin(L, R)));
2365}
2366 
2367template <Intrinsic::ID IntrID, typename T0, typename T1>
2368inline match_combine_or<typename m_Intrinsic_Ty<T0, T1>::Ty,
2369                        typename m_Intrinsic_Ty<T1, T0>::Ty>
2370m_c_Intrinsic(const T0 &Op0, const T1 &Op1) {
2371  return m_CombineOr(m_Intrinsic<IntrID>(Op0, Op1),
2372                     m_Intrinsic<IntrID>(Op1, Op0));
2373}
2374 
2375/// Matches FAdd with LHS and RHS in either order.
2376template <typename LHS, typename RHS>
2377inline BinaryOp_match<LHS, RHS, Instruction::FAdd, true>
2378m_c_FAdd(const LHS &L, const RHS &R) {
2379  return BinaryOp_match<LHS, RHS, Instruction::FAdd, true>(L, R);
2380}
2381 
2382/// Matches FMul with LHS and RHS in either order.
2383template <typename LHS, typename RHS>
2384inline BinaryOp_match<LHS, RHS, Instruction::FMul, true>
2385m_c_FMul(const LHS &L, const RHS &R) {
2386  return BinaryOp_match<LHS, RHS, Instruction::FMul, true>(L, R);
2387}
2388 
2389template <typename Opnd_t> struct Signum_match {
2390  Opnd_t Val;
2391  Signum_match(const Opnd_t &V) : Val(V) {}
2392 
2393  template <typename OpTy> bool match(OpTy *V) {
2394    unsigned TypeSize = V->getType()->getScalarSizeInBits();
2395    if (TypeSize == 0)
2396      return false;
2397 
2398    unsigned ShiftWidth = TypeSize - 1;
2399    Value *OpL = nullptr, *OpR = nullptr;
2400 
2401    // This is the representation of signum we match:
2402    //
2403    //  signum(x) == (x >> 63) | (-x >>u 63)
2404    //
2405    // An i1 value is its own signum, so it's correct to match
2406    //
2407    //  signum(x) == (x >> 0)  | (-x >>u 0)
2408    //
2409    // for i1 values.
2410 
2411    auto LHS = m_AShr(m_Value(OpL), m_SpecificInt(ShiftWidth));
2412    auto RHS = m_LShr(m_Neg(m_Value(OpR)), m_SpecificInt(ShiftWidth));
2413    auto Signum = m_Or(LHS, RHS);
2414 
2415    return Signum.match(V) && OpL == OpR && Val.match(OpL);
2416  }
2417};
2418 
2419/// Matches a signum pattern.
2420///
2421/// signum(x) =
2422///      x >  0  ->  1
2423///      x == 0  ->  0
2424///      x <  0  -> -1
2425template <typename Val_t> inline Signum_match<Val_t> m_Signum(const Val_t &V) {
2426  return Signum_match<Val_t>(V);
2427}
2428 
2429template <int Ind, typename Opnd_t> struct ExtractValue_match {
2430  Opnd_t Val;
2431  ExtractValue_match(const Opnd_t &V) : Val(V) {}
2432 
2433  template <typename OpTy> bool match(OpTy *V) {
2434    if (auto *I = dyn_cast<ExtractValueInst>(V)) {
2435      // If Ind is -1, don't inspect indices
2436      if (Ind != -1 &&
2437          !(I->getNumIndices() == 1 && I->getIndices()[0] == (unsigned)Ind))
2438        return false;
2439      return Val.match(I->getAggregateOperand());
2440    }
2441    return false;
2442  }
2443};
2444 
2445/// Match a single index ExtractValue instruction.
2446/// For example m_ExtractValue<1>(...)
2447template <int Ind, typename Val_t>
2448inline ExtractValue_match<Ind, Val_t> m_ExtractValue(const Val_t &V) {
2449  return ExtractValue_match<Ind, Val_t>(V);
2450}
2451 
2452/// Match an ExtractValue instruction with any index.
2453/// For example m_ExtractValue(...)
2454template <typename Val_t>
2455inline ExtractValue_match<-1, Val_t> m_ExtractValue(const Val_t &V) {
2456  return ExtractValue_match<-1, Val_t>(V);
2457}
2458 
2459/// Matcher for a single index InsertValue instruction.
2460template <int Ind, typename T0, typename T1> struct InsertValue_match {
2461  T0 Op0;
2462  T1 Op1;
2463 
2464  InsertValue_match(const T0 &Op0, const T1 &Op1) : Op0(Op0), Op1(Op1) {}
2465 
2466  template <typename OpTy> bool match(OpTy *V) {
2467    if (auto *I = dyn_cast<InsertValueInst>(V)) {
2468      return Op0.match(I->getOperand(0)) && Op1.match(I->getOperand(1)) &&
2469             I->getNumIndices() == 1 && Ind == I->getIndices()[0];
2470    }
2471    return false;
2472  }
2473};
2474 
2475/// Matches a single index InsertValue instruction.
2476template <int Ind, typename Val_t, typename Elt_t>
2477inline InsertValue_match<Ind, Val_t, Elt_t> m_InsertValue(const Val_t &Val,
2478                                                          const Elt_t &Elt) {
2479  return InsertValue_match<Ind, Val_t, Elt_t>(Val, Elt);
2480}
2481 
2482/// Matches patterns for `vscale`. This can either be a call to `llvm.vscale` or
2483/// the constant expression
2484///  `ptrtoint(gep <vscale x 1 x i8>, <vscale x 1 x i8>* null, i32 1>`
2485/// under the right conditions determined by DataLayout.
2486struct VScaleVal_match {
2487  template <typename ITy> bool match(ITy *V) {
2488    if (m_Intrinsic<Intrinsic::vscale>().match(V))
2489      return true;
2490 
2491    Value *Ptr;
2492    if (m_PtrToInt(m_Value(Ptr)).match(V)) {
2493      if (auto *GEP = dyn_cast<GEPOperator>(Ptr)) {
2494        auto *DerefTy =
2495            dyn_cast<ScalableVectorType>(GEP->getSourceElementType());
2496        if (GEP->getNumIndices() == 1 && DerefTy &&
2497            DerefTy->getElementType()->isIntegerTy(8) &&
2498            m_Zero().match(GEP->getPointerOperand()) &&
2499            m_SpecificInt(1).match(GEP->idx_begin()->get()))
2500          return true;
2501      }
2502    }
2503 
2504    return false;
2505  }
2506};
2507 
2508inline VScaleVal_match m_VScale() {
2509  return VScaleVal_match();
2510}
2511 
2512template <typename LHS, typename RHS, unsigned Opcode, bool Commutable = false>
2513struct LogicalOp_match {
2514  LHS L;
2515  RHS R;
2516 
2517  LogicalOp_match(const LHS &L, const RHS &R) : L(L), R(R) {}
2518 
2519  template <typename T> bool match(T *V) {
2520    auto *I = dyn_cast<Instruction>(V);
2521    if (!I || !I->getType()->isIntOrIntVectorTy(1))
2522      return false;
2523 
2524    if (I->getOpcode() == Opcode) {
2525      auto *Op0 = I->getOperand(0);
2526      auto *Op1 = I->getOperand(1);
2527      return (L.match(Op0) && R.match(Op1)) ||
2528             (Commutable && L.match(Op1) && R.match(Op0));
2529    }
2530 
2531    if (auto *Select = dyn_cast<SelectInst>(I)) {
2532      auto *Cond = Select->getCondition();
2533      auto *TVal = Select->getTrueValue();
2534      auto *FVal = Select->getFalseValue();
2535 
2536      // Don't match a scalar select of bool vectors.
2537      // Transforms expect a single type for operands if this matches.
2538      if (Cond->getType() != Select->getType())
2539        return false;
2540 
2541      if (Opcode == Instruction::And) {
2542        auto *C = dyn_cast<Constant>(FVal);
2543        if (C && C->isNullValue())
2544          return (L.match(Cond) && R.match(TVal)) ||
2545                 (Commutable && L.match(TVal) && R.match(Cond));
2546      } else {
2547        assert(Opcode == Instruction::Or)(static_cast <bool> (Opcode == Instruction::Or) ? void (
0) : __assert_fail ("Opcode == Instruction::Or", "llvm/include/llvm/IR/PatternMatch.h"
, 2547, __extension__ __PRETTY_FUNCTION__));
2548        auto *C = dyn_cast<Constant>(TVal);
2549        if (C && C->isOneValue())
2550          return (L.match(Cond) && R.match(FVal)) ||
2551                 (Commutable && L.match(FVal) && R.match(Cond));
2552      }
2553    }
2554 
2555    return false;
2556  }
2557};
2558 
2559/// Matches L && R either in the form of L & R or L ? R : false.
2560/// Note that the latter form is poison-blocking.
2561template <typename LHS, typename RHS>
2562inline LogicalOp_match<LHS, RHS, Instruction::And> m_LogicalAnd(const LHS &L,
2563                                                                const RHS &R) {
2564  return LogicalOp_match<LHS, RHS, Instruction::And>(L, R);
2565}
2566 
2567/// Matches L && R where L and R are arbitrary values.
2568inline auto m_LogicalAnd() { return m_LogicalAnd(m_Value(), m_Value()); }
2569 
2570/// Matches L && R with LHS and RHS in either order.
2571template <typename LHS, typename RHS>
2572inline LogicalOp_match<LHS, RHS, Instruction::And, true>
2573m_c_LogicalAnd(const LHS &L, const RHS &R) {
2574  return LogicalOp_match<LHS, RHS, Instruction::And, true>(L, R);
2575}
2576 
2577/// Matches L || R either in the form of L | R or L ? true : R.
2578/// Note that the latter form is poison-blocking.
2579template <typename LHS, typename RHS>
2580inline LogicalOp_match<LHS, RHS, Instruction::Or> m_LogicalOr(const LHS &L,
2581                                                              const RHS &R) {
2582  return LogicalOp_match<LHS, RHS, Instruction::Or>(L, R);
2583}
2584 
2585/// Matches L || R where L and R are arbitrary values.
2586inline auto m_LogicalOr() { return m_LogicalOr(m_Value(), m_Value()); }
2587 
2588/// Matches L || R with LHS and RHS in either order.
2589template <typename LHS, typename RHS>
2590inline LogicalOp_match<LHS, RHS, Instruction::Or, true>
2591m_c_LogicalOr(const LHS &L, const RHS &R) {
2592  return LogicalOp_match<LHS, RHS, Instruction::Or, true>(L, R);
2593}
2594 
2595/// Matches either L && R or L || R,
2596/// either one being in the either binary or logical form.
2597/// Note that the latter form is poison-blocking.
2598template <typename LHS, typename RHS, bool Commutable = false>
2599inline auto m_LogicalOp(const LHS &L, const RHS &R) {
2600  return m_CombineOr(
2601      LogicalOp_match<LHS, RHS, Instruction::And, Commutable>(L, R),
2602      LogicalOp_match<LHS, RHS, Instruction::Or, Commutable>(L, R));
2603}
2604 
2605/// Matches either L && R or L || R where L and R are arbitrary values.
2606inline auto m_LogicalOp() { return m_LogicalOp(m_Value(), m_Value()); }
2607 
2608/// Matches either L && R or L || R with LHS and RHS in either order.
2609template <typename LHS, typename RHS>
2610inline auto m_c_LogicalOp(const LHS &L, const RHS &R) {
2611  return m_LogicalOp<LHS, RHS, /*Commutable=*/true>(L, R);
2612}
2613 
2614} // end namespace PatternMatch
2615} // end namespace llvm
2616 
2617#endif // LLVM_IR_PATTERNMATCH_H