/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Transforms/InstCombine/InstCombineMulDivRem.cpp

Bug Summary

File:	src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Transforms/InstCombine/InstCombineMulDivRem.cpp
Warning:	line 672, column 24 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name InstCombineMulDivRem.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -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 -mrelocation-model pic -pic-level 1 -fhalf-no-semantic-interposition -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Analysis -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ASMParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/BinaryFormat -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitstream -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /include/llvm/CodeGen -I /include/llvm/CodeGen/PBQP -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Coroutines -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData/Coverage -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/CodeView -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/DWARF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/MSF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/PDB -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Demangle -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/JITLink -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/Orc -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenACC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenMP -I /include/llvm/CodeGen/GlobalISel -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IRReader -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/LTO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Linker -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC/MCParser -I /include/llvm/CodeGen/MIRParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Object -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Option -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Passes -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Scalar -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ADT -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Support -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/Symbolize -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Target -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Utils -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Vectorize -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/IPO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/libLLVM/../include -I /usr/src/gnu/usr.bin/clang/libLLVM/obj -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -D PIC -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -D_RET_PROTECTOR -ret-protector -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Transforms/InstCombine/InstCombineMulDivRem.cpp

/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Transforms/InstCombine/InstCombineMulDivRem.cpp

→

1//===- InstCombineMulDivRem.cpp -------------------------------------------===//
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 mul, fmul, sdiv, udiv, fdiv,
10// srem, urem, frem.
11//
12//===----------------------------------------------------------------------===//

14#include "InstCombineInternal.h"
15#include "llvm/ADT/APFloat.h"
16#include "llvm/ADT/APInt.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/Analysis/InstructionSimplify.h"
19#include "llvm/IR/BasicBlock.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/IntrinsicInst.h"
26#include "llvm/IR/Intrinsics.h"
27#include "llvm/IR/Operator.h"
28#include "llvm/IR/PatternMatch.h"
29#include "llvm/IR/Type.h"
30#include "llvm/IR/Value.h"
31#include "llvm/Support/Casting.h"
32#include "llvm/Support/ErrorHandling.h"
33#include "llvm/Support/KnownBits.h"
34#include "llvm/Transforms/InstCombine/InstCombineWorklist.h"
35#include "llvm/Transforms/InstCombine/InstCombiner.h"
36#include "llvm/Transforms/Utils/BuildLibCalls.h"
37#include <cassert>
38#include <cstddef>
39#include <cstdint>
40#include <utility>

42using namespace llvm;
43using namespace PatternMatch;

45#define DEBUG_TYPE"instcombine" "instcombine"

47/// The specific integer value is used in a context where it is known to be
48/// non-zero.  If this allows us to simplify the computation, do so and return
49/// the new operand, otherwise return null.
50static Value *simplifyValueKnownNonZero(Value *V, InstCombinerImpl &IC,
                                      Instruction &CxtI) {
// If V has multiple uses, then we would have to do more analysis to determine
// if this is safe.  For example, the use could be in dynamically unreached
// code.
if (!V->hasOneUse()) return nullptr;

bool MadeChange = false;

// ((1 << A) >>u B) --> (1 << (A-B))
// Because V cannot be zero, we know that B is less than A.
Value *A = nullptr, *B = nullptr, *One = nullptr;
if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(One), m_Value(A))), m_Value(B))) &&
    match(One, m_One())) {
  A = IC.Builder.CreateSub(A, B);
  return IC.Builder.CreateShl(One, A);
}

// (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
// inexact.  Similarly for <<.
BinaryOperator *I = dyn_cast<BinaryOperator>(V);
if (I && I->isLogicalShift() &&
    IC.isKnownToBeAPowerOfTwo(I->getOperand(0), false, 0, &CxtI)) {
  // We know that this is an exact/nuw shift and that the input is a
  // non-zero context as well.
  if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC, CxtI)) {
    IC.replaceOperand(*I, 0, V2);
    MadeChange = true;
  }

  if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
    I->setIsExact();
    MadeChange = true;
  }

  if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
    I->setHasNoUnsignedWrap();
    MadeChange = true;
  }
}

// TODO: Lots more we could do here:
//    If V is a phi node, we can call this on each of its operands.
//    "select cond, X, 0" can simplify to "X".

return MadeChange ? V : nullptr;
96}

98// TODO: This is a specific form of a much more general pattern.
99//       We could detect a select with any binop identity constant, or we
100//       could use SimplifyBinOp to see if either arm of the select reduces.
101//       But that needs to be done carefully and/or while removing potential
102//       reverse canonicalizations as in InstCombiner::foldSelectIntoOp().
103static Value *foldMulSelectToNegate(BinaryOperator &I,
                                  InstCombiner::BuilderTy &Builder) {
Value *Cond, *OtherOp;

// mul (select Cond, 1, -1), OtherOp --> select Cond, OtherOp, -OtherOp
// mul OtherOp, (select Cond, 1, -1) --> select Cond, OtherOp, -OtherOp
if (match(&I, m_c_Mul(m_OneUse(m_Select(m_Value(Cond), m_One(), m_AllOnes())),
                      m_Value(OtherOp))))
  return Builder.CreateSelect(Cond, OtherOp, Builder.CreateNeg(OtherOp));

// mul (select Cond, -1, 1), OtherOp --> select Cond, -OtherOp, OtherOp
// mul OtherOp, (select Cond, -1, 1) --> select Cond, -OtherOp, OtherOp
if (match(&I, m_c_Mul(m_OneUse(m_Select(m_Value(Cond), m_AllOnes(), m_One())),
                      m_Value(OtherOp))))
  return Builder.CreateSelect(Cond, Builder.CreateNeg(OtherOp), OtherOp);

// fmul (select Cond, 1.0, -1.0), OtherOp --> select Cond, OtherOp, -OtherOp
// fmul OtherOp, (select Cond, 1.0, -1.0) --> select Cond, OtherOp, -OtherOp
if (match(&I, m_c_FMul(m_OneUse(m_Select(m_Value(Cond), m_SpecificFP(1.0),
                                         m_SpecificFP(-1.0))),
                       m_Value(OtherOp)))) {
  IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
  Builder.setFastMathFlags(I.getFastMathFlags());
  return Builder.CreateSelect(Cond, OtherOp, Builder.CreateFNeg(OtherOp));
}

// fmul (select Cond, -1.0, 1.0), OtherOp --> select Cond, -OtherOp, OtherOp
// fmul OtherOp, (select Cond, -1.0, 1.0) --> select Cond, -OtherOp, OtherOp
if (match(&I, m_c_FMul(m_OneUse(m_Select(m_Value(Cond), m_SpecificFP(-1.0),
                                         m_SpecificFP(1.0))),
                       m_Value(OtherOp)))) {
  IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
  Builder.setFastMathFlags(I.getFastMathFlags());
  return Builder.CreateSelect(Cond, Builder.CreateFNeg(OtherOp), OtherOp);
}

return nullptr;
140}

142Instruction *InstCombinerImpl::visitMul(BinaryOperator &I) {
if (Value *V = SimplifyMulInst(I.getOperand(0), I.getOperand(1),
                               SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (SimplifyAssociativeOrCommutative(I))
  return &I;

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

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

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
unsigned BitWidth = I.getType()->getScalarSizeInBits();

// X * -1 == 0 - X
if (match(Op1, m_AllOnes())) {
  BinaryOperator *BO = BinaryOperator::CreateNeg(Op0, I.getName());
  if (I.hasNoSignedWrap())
    BO->setHasNoSignedWrap();
  return BO;
}

// Also allow combining multiply instructions on vectors.
{
  Value *NewOp;
  Constant *C1, *C2;
  const APInt *IVal;
  if (match(&I, m_Mul(m_Shl(m_Value(NewOp), m_Constant(C2)),
                      m_Constant(C1))) &&
      match(C1, m_APInt(IVal))) {
    // ((X << C2)*C1) == (X * (C1 << C2))
    Constant *Shl = ConstantExpr::getShl(C1, C2);
    BinaryOperator *Mul = cast<BinaryOperator>(I.getOperand(0));
    BinaryOperator *BO = BinaryOperator::CreateMul(NewOp, Shl);
    if (I.hasNoUnsignedWrap() && Mul->hasNoUnsignedWrap())
      BO->setHasNoUnsignedWrap();
    if (I.hasNoSignedWrap() && Mul->hasNoSignedWrap() &&
        Shl->isNotMinSignedValue())
      BO->setHasNoSignedWrap();
    return BO;
  }

  if (match(&I, m_Mul(m_Value(NewOp), m_Constant(C1)))) {
    // Replace X*(2^C) with X << C, where C is either a scalar or a vector.
    if (Constant *NewCst = ConstantExpr::getExactLogBase2(C1)) {
      BinaryOperator *Shl = BinaryOperator::CreateShl(NewOp, NewCst);

      if (I.hasNoUnsignedWrap())
        Shl->setHasNoUnsignedWrap();
      if (I.hasNoSignedWrap()) {
        const APInt *V;
        if (match(NewCst, m_APInt(V)) && *V != V->getBitWidth() - 1)
          Shl->setHasNoSignedWrap();
      }

      return Shl;
    }
  }
}

if (Op0->hasOneUse() && match(Op1, m_NegatedPower2())) {
  // Interpret  X * (-1<<C)  as  (-X) * (1<<C)  and try to sink the negation.
  // The "* (1<<C)" thus becomes a potential shifting opportunity.
  if (Value *NegOp0 = Negator::Negate(/*IsNegation*/ true, Op0, *this))
    return BinaryOperator::CreateMul(
        NegOp0, ConstantExpr::getNeg(cast<Constant>(Op1)), I.getName());
}

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

if (Value *FoldedMul = foldMulSelectToNegate(I, Builder))
  return replaceInstUsesWith(I, FoldedMul);

// Simplify mul instructions with a constant RHS.
if (isa<Constant>(Op1)) {
  // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
  Value *X;
  Constant *C1;
  if (match(Op0, m_OneUse(m_Add(m_Value(X), m_Constant(C1))))) {
    Value *Mul = Builder.CreateMul(C1, Op1);
    // Only go forward with the transform if C1*CI simplifies to a tidier
    // constant.
    if (!match(Mul, m_Mul(m_Value(), m_Value())))
      return BinaryOperator::CreateAdd(Builder.CreateMul(X, Op1), Mul);
  }
}

// abs(X) * abs(X) -> X * X
// nabs(X) * nabs(X) -> X * X
if (Op0 == Op1) {
  Value *X, *Y;
  SelectPatternFlavor SPF = matchSelectPattern(Op0, X, Y).Flavor;
  if (SPF == SPF_ABS || SPF == SPF_NABS)
    return BinaryOperator::CreateMul(X, X);

  if (match(Op0, m_Intrinsic<Intrinsic::abs>(m_Value(X))))
    return BinaryOperator::CreateMul(X, X);
}

// -X * C --> X * -C
Value *X, *Y;
Constant *Op1C;
if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Constant(Op1C)))
  return BinaryOperator::CreateMul(X, ConstantExpr::getNeg(Op1C));

// -X * -Y --> X * Y
if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Neg(m_Value(Y)))) {
  auto *NewMul = BinaryOperator::CreateMul(X, Y);
  if (I.hasNoSignedWrap() &&
      cast<OverflowingBinaryOperator>(Op0)->hasNoSignedWrap() &&
      cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap())
    NewMul->setHasNoSignedWrap();
  return NewMul;
}

// -X * Y --> -(X * Y)
// X * -Y --> -(X * Y)
if (match(&I, m_c_Mul(m_OneUse(m_Neg(m_Value(X))), m_Value(Y))))
  return BinaryOperator::CreateNeg(Builder.CreateMul(X, Y));

// (X / Y) *  Y = X - (X % Y)
// (X / Y) * -Y = (X % Y) - X
{
  Value *Y = Op1;
  BinaryOperator *Div = dyn_cast<BinaryOperator>(Op0);
  if (!Div || (Div->getOpcode() != Instruction::UDiv &&
               Div->getOpcode() != Instruction::SDiv)) {
    Y = Op0;
    Div = dyn_cast<BinaryOperator>(Op1);
  }
  Value *Neg = dyn_castNegVal(Y);
  if (Div && Div->hasOneUse() &&
      (Div->getOperand(1) == Y || Div->getOperand(1) == Neg) &&
      (Div->getOpcode() == Instruction::UDiv ||
       Div->getOpcode() == Instruction::SDiv)) {
    Value *X = Div->getOperand(0), *DivOp1 = Div->getOperand(1);

    // If the division is exact, X % Y is zero, so we end up with X or -X.
    if (Div->isExact()) {
      if (DivOp1 == Y)
        return replaceInstUsesWith(I, X);
      return BinaryOperator::CreateNeg(X);
    }

    auto RemOpc = Div->getOpcode() == Instruction::UDiv ? Instruction::URem
                                                        : Instruction::SRem;
    Value *Rem = Builder.CreateBinOp(RemOpc, X, DivOp1);
    if (DivOp1 == Y)
      return BinaryOperator::CreateSub(X, Rem);
    return BinaryOperator::CreateSub(Rem, X);
  }
}

/// i1 mul -> i1 and.
if (I.getType()->isIntOrIntVectorTy(1))
  return BinaryOperator::CreateAnd(Op0, Op1);

// X*(1 << Y) --> X << Y
// (1 << Y)*X --> X << Y
{
  Value *Y;
  BinaryOperator *BO = nullptr;
  bool ShlNSW = false;
  if (match(Op0, m_Shl(m_One(), m_Value(Y)))) {
    BO = BinaryOperator::CreateShl(Op1, Y);
    ShlNSW = cast<ShlOperator>(Op0)->hasNoSignedWrap();
  } else if (match(Op1, m_Shl(m_One(), m_Value(Y)))) {
    BO = BinaryOperator::CreateShl(Op0, Y);
    ShlNSW = cast<ShlOperator>(Op1)->hasNoSignedWrap();
  }
  if (BO) {
    if (I.hasNoUnsignedWrap())
      BO->setHasNoUnsignedWrap();
    if (I.hasNoSignedWrap() && ShlNSW)
      BO->setHasNoSignedWrap();
    return BO;
  }
}

// (zext bool X) * (zext bool Y) --> zext (and X, Y)
// (sext bool X) * (sext bool Y) --> zext (and X, Y)
// Note: -1 * -1 == 1 * 1 == 1 (if the extends match, the result is the same)
if (((match(Op0, m_ZExt(m_Value(X))) && match(Op1, m_ZExt(m_Value(Y)))) ||
     (match(Op0, m_SExt(m_Value(X))) && match(Op1, m_SExt(m_Value(Y))))) &&
    X->getType()->isIntOrIntVectorTy(1) && X->getType() == Y->getType() &&
    (Op0->hasOneUse() || Op1->hasOneUse() || X == Y)) {
  Value *And = Builder.CreateAnd(X, Y, "mulbool");
  return CastInst::Create(Instruction::ZExt, And, I.getType());
}
// (sext bool X) * (zext bool Y) --> sext (and X, Y)
// (zext bool X) * (sext bool Y) --> sext (and X, Y)
// Note: -1 * 1 == 1 * -1  == -1
if (((match(Op0, m_SExt(m_Value(X))) && match(Op1, m_ZExt(m_Value(Y)))) ||
     (match(Op0, m_ZExt(m_Value(X))) && match(Op1, m_SExt(m_Value(Y))))) &&
    X->getType()->isIntOrIntVectorTy(1) && X->getType() == Y->getType() &&
    (Op0->hasOneUse() || Op1->hasOneUse())) {
  Value *And = Builder.CreateAnd(X, Y, "mulbool");
  return CastInst::Create(Instruction::SExt, And, I.getType());
}

// (bool X) * Y --> X ? Y : 0
// Y * (bool X) --> X ? Y : 0
if (match(Op0, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
  return SelectInst::Create(X, Op1, ConstantInt::get(I.getType(), 0));
if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
  return SelectInst::Create(X, Op0, ConstantInt::get(I.getType(), 0));

// (lshr X, 31) * Y --> (ashr X, 31) & Y
// Y * (lshr X, 31) --> (ashr X, 31) & Y
// TODO: We are not checking one-use because the elimination of the multiply
//       is better for analysis?
// TODO: Should we canonicalize to '(X < 0) ? Y : 0' instead? That would be
//       more similar to what we're doing above.
const APInt *C;
if (match(Op0, m_LShr(m_Value(X), m_APInt(C))) && *C == C->getBitWidth() - 1)
  return BinaryOperator::CreateAnd(Builder.CreateAShr(X, *C), Op1);
if (match(Op1, m_LShr(m_Value(X), m_APInt(C))) && *C == C->getBitWidth() - 1)
  return BinaryOperator::CreateAnd(Builder.CreateAShr(X, *C), Op0);

// ((ashr X, 31) | 1) * X --> abs(X)
// X * ((ashr X, 31) | 1) --> abs(X)
if (match(&I, m_c_BinOp(m_Or(m_AShr(m_Value(X),
                                  m_SpecificIntAllowUndef(BitWidth - 1)),
                           m_One()),
                      m_Deferred(X)))) {
  Value *Abs = Builder.CreateBinaryIntrinsic(
      Intrinsic::abs, X,
      ConstantInt::getBool(I.getContext(), I.hasNoSignedWrap()));
  Abs->takeName(&I);
  return replaceInstUsesWith(I, Abs);
}

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

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

if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedMul(Op0, Op1, I)) {
  Changed = true;
  I.setHasNoUnsignedWrap(true);
}

return Changed ? &I : nullptr;
393}

395Instruction *InstCombinerImpl::foldFPSignBitOps(BinaryOperator &I) {
BinaryOperator::BinaryOps Opcode = I.getOpcode();
assert((Opcode == Instruction::FMul || Opcode == Instruction::FDiv) &&((void)0)
       "Expected fmul or fdiv")((void)0);

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

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

// fabs(X) * fabs(X) -> X * X
// fabs(X) / fabs(X) -> X / X
if (Op0 == Op1 && match(Op0, m_FAbs(m_Value(X))))
  return BinaryOperator::CreateWithCopiedFlags(Opcode, X, X, &I);

// fabs(X) * fabs(Y) --> fabs(X * Y)
// fabs(X) / fabs(Y) --> fabs(X / Y)
if (match(Op0, m_FAbs(m_Value(X))) && match(Op1, m_FAbs(m_Value(Y))) &&
    (Op0->hasOneUse() || Op1->hasOneUse())) {
  IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
  Builder.setFastMathFlags(I.getFastMathFlags());
  Value *XY = Builder.CreateBinOp(Opcode, X, Y);
  Value *Fabs = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, XY);
  Fabs->takeName(&I);
  return replaceInstUsesWith(I, Fabs);
}

return nullptr;
426}

428Instruction *InstCombinerImpl::visitFMul(BinaryOperator &I) {
if (Value *V = SimplifyFMulInst(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 *FoldedMul = foldBinOpIntoSelectOrPhi(I))
  return FoldedMul;

if (Value *FoldedMul = foldMulSelectToNegate(I, Builder))
  return replaceInstUsesWith(I, FoldedMul);

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

// X * -1.0 --> -X
Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
if (match(Op1, m_SpecificFP(-1.0)))
  return UnaryOperator::CreateFNegFMF(Op0, &I);

// -X * C --> X * -C
Value *X, *Y;
Constant *C;
if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_Constant(C)))
  return BinaryOperator::CreateFMulFMF(X, ConstantExpr::getFNeg(C), &I);

// (select A, B, C) * (select A, D, E) --> select A, (B*D), (C*E)
if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
  return replaceInstUsesWith(I, V);

if (I.hasAllowReassoc()) {
  // Reassociate constant RHS with another constant to form constant
  // expression.
  if (match(Op1, m_Constant(C)) && C->isFiniteNonZeroFP()) {
    Constant *C1;
    if (match(Op0, m_OneUse(m_FDiv(m_Constant(C1), m_Value(X))))) {
      // (C1 / X) * C --> (C * C1) / X
      Constant *CC1 = ConstantExpr::getFMul(C, C1);
      if (CC1->isNormalFP())
        return BinaryOperator::CreateFDivFMF(CC1, X, &I);
    }
    if (match(Op0, m_FDiv(m_Value(X), m_Constant(C1)))) {
      // (X / C1) * C --> X * (C / C1)
      Constant *CDivC1 = ConstantExpr::getFDiv(C, C1);
      if (CDivC1->isNormalFP())
        return BinaryOperator::CreateFMulFMF(X, CDivC1, &I);

      // If the constant was a denormal, try reassociating differently.
      // (X / C1) * C --> X / (C1 / C)
      Constant *C1DivC = ConstantExpr::getFDiv(C1, C);
      if (Op0->hasOneUse() && C1DivC->isNormalFP())
        return BinaryOperator::CreateFDivFMF(X, C1DivC, &I);
    }

    // We do not need to match 'fadd C, X' and 'fsub X, C' because they are
    // canonicalized to 'fadd X, C'. Distributing the multiply may allow
    // further folds and (X * C) + C2 is 'fma'.
    if (match(Op0, m_OneUse(m_FAdd(m_Value(X), m_Constant(C1))))) {
      // (X + C1) * C --> (X * C) + (C * C1)
      Constant *CC1 = ConstantExpr::getFMul(C, C1);
      Value *XC = Builder.CreateFMulFMF(X, C, &I);
      return BinaryOperator::CreateFAddFMF(XC, CC1, &I);
    }
    if (match(Op0, m_OneUse(m_FSub(m_Constant(C1), m_Value(X))))) {
      // (C1 - X) * C --> (C * C1) - (X * C)
      Constant *CC1 = ConstantExpr::getFMul(C, C1);
      Value *XC = Builder.CreateFMulFMF(X, C, &I);
      return BinaryOperator::CreateFSubFMF(CC1, XC, &I);
    }
  }

  Value *Z;
  if (match(&I, m_c_FMul(m_OneUse(m_FDiv(m_Value(X), m_Value(Y))),
                         m_Value(Z)))) {
    // Sink division: (X / Y) * Z --> (X * Z) / Y
    Value *NewFMul = Builder.CreateFMulFMF(X, Z, &I);
    return BinaryOperator::CreateFDivFMF(NewFMul, Y, &I);
  }

  // sqrt(X) * sqrt(Y) -> sqrt(X * Y)
  // nnan disallows the possibility of returning a number if both operands are
  // negative (in that case, we should return NaN).
  if (I.hasNoNaNs() &&
      match(Op0, m_OneUse(m_Intrinsic<Intrinsic::sqrt>(m_Value(X)))) &&
      match(Op1, m_OneUse(m_Intrinsic<Intrinsic::sqrt>(m_Value(Y))))) {
    Value *XY = Builder.CreateFMulFMF(X, Y, &I);
    Value *Sqrt = Builder.CreateUnaryIntrinsic(Intrinsic::sqrt, XY, &I);
    return replaceInstUsesWith(I, Sqrt);
  }

  // The following transforms are done irrespective of the number of uses
  // for the expression "1.0/sqrt(X)".
  //  1) 1.0/sqrt(X) * X -> X/sqrt(X)
  //  2) X * 1.0/sqrt(X) -> X/sqrt(X)
  // We always expect the backend to reduce X/sqrt(X) to sqrt(X), if it
  // has the necessary (reassoc) fast-math-flags.
  if (I.hasNoSignedZeros() &&
      match(Op0, (m_FDiv(m_SpecificFP(1.0), m_Value(Y)))) &&
      match(Y, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) && Op1 == X)
    return BinaryOperator::CreateFDivFMF(X, Y, &I);
  if (I.hasNoSignedZeros() &&
      match(Op1, (m_FDiv(m_SpecificFP(1.0), m_Value(Y)))) &&
      match(Y, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) && Op0 == X)
    return BinaryOperator::CreateFDivFMF(X, Y, &I);

  // Like the similar transform in instsimplify, this requires 'nsz' because
  // sqrt(-0.0) = -0.0, and -0.0 * -0.0 does not simplify to -0.0.
  if (I.hasNoNaNs() && I.hasNoSignedZeros() && Op0 == Op1 &&
      Op0->hasNUses(2)) {
    // Peek through fdiv to find squaring of square root:
    // (X / sqrt(Y)) * (X / sqrt(Y)) --> (X * X) / Y
    if (match(Op0, m_FDiv(m_Value(X),
                          m_Intrinsic<Intrinsic::sqrt>(m_Value(Y))))) {
      Value *XX = Builder.CreateFMulFMF(X, X, &I);
      return BinaryOperator::CreateFDivFMF(XX, Y, &I);
    }
    // (sqrt(Y) / X) * (sqrt(Y) / X) --> Y / (X * X)
    if (match(Op0, m_FDiv(m_Intrinsic<Intrinsic::sqrt>(m_Value(Y)),
                          m_Value(X)))) {
      Value *XX = Builder.CreateFMulFMF(X, X, &I);
      return BinaryOperator::CreateFDivFMF(Y, XX, &I);
    }
  }

  if (I.isOnlyUserOfAnyOperand()) {
    // pow(x, y) * pow(x, z) -> pow(x, y + z)
    if (match(Op0, m_Intrinsic<Intrinsic::pow>(m_Value(X), m_Value(Y))) &&
        match(Op1, m_Intrinsic<Intrinsic::pow>(m_Specific(X), m_Value(Z)))) {
      auto *YZ = Builder.CreateFAddFMF(Y, Z, &I);
      auto *NewPow = Builder.CreateBinaryIntrinsic(Intrinsic::pow, X, YZ, &I);
      return replaceInstUsesWith(I, NewPow);
    }

    // exp(X) * exp(Y) -> exp(X + Y)
    if (match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X))) &&
        match(Op1, m_Intrinsic<Intrinsic::exp>(m_Value(Y)))) {
      Value *XY = Builder.CreateFAddFMF(X, Y, &I);
      Value *Exp = Builder.CreateUnaryIntrinsic(Intrinsic::exp, XY, &I);
      return replaceInstUsesWith(I, Exp);
    }

    // exp2(X) * exp2(Y) -> exp2(X + Y)
    if (match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X))) &&
        match(Op1, m_Intrinsic<Intrinsic::exp2>(m_Value(Y)))) {
      Value *XY = Builder.CreateFAddFMF(X, Y, &I);
      Value *Exp2 = Builder.CreateUnaryIntrinsic(Intrinsic::exp2, XY, &I);
      return replaceInstUsesWith(I, Exp2);
    }
  }

  // (X*Y) * X => (X*X) * Y where Y != X
  //  The purpose is two-fold:
  //   1) to form a power expression (of X).
  //   2) potentially shorten the critical path: After transformation, the
  //  latency of the instruction Y is amortized by the expression of X*X,
  //  and therefore Y is in a "less critical" position compared to what it
  //  was before the transformation.
  if (match(Op0, m_OneUse(m_c_FMul(m_Specific(Op1), m_Value(Y)))) &&
      Op1 != Y) {
    Value *XX = Builder.CreateFMulFMF(Op1, Op1, &I);
    return BinaryOperator::CreateFMulFMF(XX, Y, &I);
  }
  if (match(Op1, m_OneUse(m_c_FMul(m_Specific(Op0), m_Value(Y)))) &&
      Op0 != Y) {
    Value *XX = Builder.CreateFMulFMF(Op0, Op0, &I);
    return BinaryOperator::CreateFMulFMF(XX, Y, &I);
  }
}

// log2(X * 0.5) * Y = log2(X) * Y - Y
if (I.isFast()) {
  IntrinsicInst *Log2 = nullptr;
  if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::log2>(
          m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
    Log2 = cast<IntrinsicInst>(Op0);
    Y = Op1;
  }
  if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::log2>(
          m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
    Log2 = cast<IntrinsicInst>(Op1);
    Y = Op0;
  }
  if (Log2) {
    Value *Log2 = Builder.CreateUnaryIntrinsic(Intrinsic::log2, X, &I);
    Value *LogXTimesY = Builder.CreateFMulFMF(Log2, Y, &I);
    return BinaryOperator::CreateFSubFMF(LogXTimesY, Y, &I);
  }
}

return nullptr;
624}

626/// Fold a divide or remainder with a select instruction divisor when one of the
627/// select operands is zero. In that case, we can use the other select operand
628/// because div/rem by zero is undefined.
629bool InstCombinerImpl::simplifyDivRemOfSelectWithZeroOp(BinaryOperator &I) {
SelectInst *SI = dyn_cast<SelectInst>(I.getOperand(1));
if (!SI)
9
←
Assuming 'SI' is non-null→
10
←
Taking false branch→
  return false;

int NonNullOperand;
if (match(SI->getTrueValue(), m_Zero()))
11
←
Calling 'match<llvm::Value, llvm::PatternMatch::is_zero>'→
18
←
Returning from 'match<llvm::Value, llvm::PatternMatch::is_zero>'→
19
←
Assuming the condition is true→
20
←
Taking true branch→
  // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
  NonNullOperand = 2;
else if (match(SI->getFalseValue(), m_Zero()))
  // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
  NonNullOperand = 1;
else
  return false;

// Change the div/rem to use 'Y' instead of the select.
replaceOperand(I, 1, SI->getOperand(NonNullOperand));

// Okay, we know we replace the operand of the div/rem with 'Y' with no
// problem.  However, the select, or the condition of the select may have
// multiple uses.  Based on our knowledge that the operand must be non-zero,
// propagate the known value for the select into other uses of it, and
// propagate a known value of the condition into its other users.

// If the select and condition only have a single use, don't bother with this,
// early exit.
Value *SelectCond = SI->getCondition();
if (SI->use_empty() && SelectCond->hasOneUse())
21
←
Calling 'Value::use_empty'→
24
←
Returning from 'Value::use_empty'→
  return true;

// Scan the current block backward, looking for other uses of SI.
BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin();
Type *CondTy = SelectCond->getType();
while (BBI != BBFront) {
25
←
Calling 'operator!='→
28
←
Returning from 'operator!='→
29
←
Loop condition is true.  Entering loop body→
38
←
Calling 'operator!='→
41
←
Returning from 'operator!='→
42
←
Loop condition is true.  Entering loop body→
  --BBI;
  // If we found an instruction that we can't assume will return, so
  // information from below it cannot be propagated above it.
  if (!isGuaranteedToTransferExecutionToSuccessor(&*BBI))
30
←
Assuming the condition is false→
31
←
Taking false branch→
43
←
Assuming the condition is false→
44
←
Taking false branch→
    break;

  // Replace uses of the select or its condition with the known values.
  for (Use &Op : BBI->operands()) {
32
←
Assuming '__begin2' is equal to '__end2'→
45
←
Assuming '__begin2' is not equal to '__end2'→
    if (Op == SI) {
46
←
Assuming the condition is true→
47
←
Taking true branch→
      replaceUse(Op, SI->getOperand(NonNullOperand));
48
←
Called C++ object pointer is null
      Worklist.push(&*BBI);
    } else if (Op == SelectCond) {
      replaceUse(Op, NonNullOperand == 1 ? ConstantInt::getTrue(CondTy)
                                         : ConstantInt::getFalse(CondTy));
      Worklist.push(&*BBI);
    }
  }

  // If we past the instruction, quit looking for it.
  if (&*BBI == SI)
33
←
Assuming the condition is true→
34
←
Taking true branch→
    SI = nullptr;
35
←
Null pointer value stored to 'SI'→
  if (&*BBI == SelectCond)
36
←
Assuming the condition is false→
37
←
Taking false branch→
    SelectCond = nullptr;

  // If we ran out of things to eliminate, break out of the loop.
  if (!SelectCond37.1
'SelectCond' is non-null
1
'SelectCond' is non-null
1
'SelectCond' is non-null
1
'SelectCond' is non-null
 && !SI)
    break;

}
return true;
693}

695/// True if the multiply can not be expressed in an int this size.
696static bool multiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product,
                            bool IsSigned) {
bool Overflow;
Product = IsSigned ? C1.smul_ov(C2, Overflow) : C1.umul_ov(C2, Overflow);
return Overflow;
701}

703/// True if C1 is a multiple of C2. Quotient contains C1/C2.
704static bool isMultiple(const APInt &C1, const APInt &C2, APInt &Quotient,
                     bool IsSigned) {
assert(C1.getBitWidth() == C2.getBitWidth() && "Constant widths not equal")((void)0);

// Bail if we will divide by zero.
if (C2.isNullValue())
  return false;

// Bail if we would divide INT_MIN by -1.
if (IsSigned && C1.isMinSignedValue() && C2.isAllOnesValue())
  return false;

APInt Remainder(C1.getBitWidth(), /*val=*/0ULL, IsSigned);
if (IsSigned)
  APInt::sdivrem(C1, C2, Quotient, Remainder);
else
  APInt::udivrem(C1, C2, Quotient, Remainder);

return Remainder.isMinValue();
723}

725/// This function implements the transforms common to both integer division
726/// instructions (udiv and sdiv). It is called by the visitors to those integer
727/// division instructions.
728/// Common integer divide transforms
729Instruction *InstCombinerImpl::commonIDivTransforms(BinaryOperator &I) {
Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
bool IsSigned = I.getOpcode() == Instruction::SDiv;
Type *Ty = I.getType();

// The RHS is known non-zero.
if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I))
  return replaceOperand(I, 1, V);

// Handle cases involving: [su]div X, (select Cond, Y, Z)
// This does not apply for fdiv.
if (simplifyDivRemOfSelectWithZeroOp(I))
  return &I;

const APInt *C2;
if (match(Op1, m_APInt(C2))) {
  Value *X;
  const APInt *C1;

  // (X / C1) / C2  -> X / (C1*C2)
  if ((IsSigned && match(Op0, m_SDiv(m_Value(X), m_APInt(C1)))) ||
      (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_APInt(C1))))) {
    APInt Product(C1->getBitWidth(), /*val=*/0ULL, IsSigned);
    if (!multiplyOverflows(*C1, *C2, Product, IsSigned))
      return BinaryOperator::Create(I.getOpcode(), X,
                                    ConstantInt::get(Ty, Product));
  }

  if ((IsSigned && match(Op0, m_NSWMul(m_Value(X), m_APInt(C1)))) ||
      (!IsSigned && match(Op0, m_NUWMul(m_Value(X), m_APInt(C1))))) {
    APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned);

    // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1.
    if (isMultiple(*C2, *C1, Quotient, IsSigned)) {
      auto *NewDiv = BinaryOperator::Create(I.getOpcode(), X,
                                            ConstantInt::get(Ty, Quotient));
      NewDiv->setIsExact(I.isExact());
      return NewDiv;
    }

    // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2.
    if (isMultiple(*C1, *C2, Quotient, IsSigned)) {
      auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
                                         ConstantInt::get(Ty, Quotient));
      auto *OBO = cast<OverflowingBinaryOperator>(Op0);
      Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
      Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
      return Mul;
    }
  }

  if ((IsSigned && match(Op0, m_NSWShl(m_Value(X), m_APInt(C1))) &&
       *C1 != C1->getBitWidth() - 1) ||
      (!IsSigned && match(Op0, m_NUWShl(m_Value(X), m_APInt(C1))))) {
    APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned);
    APInt C1Shifted = APInt::getOneBitSet(
        C1->getBitWidth(), static_cast<unsigned>(C1->getLimitedValue()));

    // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of 1 << C1.
    if (isMultiple(*C2, C1Shifted, Quotient, IsSigned)) {
      auto *BO = BinaryOperator::Create(I.getOpcode(), X,
                                        ConstantInt::get(Ty, Quotient));
      BO->setIsExact(I.isExact());
      return BO;
    }

    // (X << C1) / C2 -> X * ((1 << C1) / C2) if 1 << C1 is a multiple of C2.
    if (isMultiple(C1Shifted, *C2, Quotient, IsSigned)) {
      auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
                                         ConstantInt::get(Ty, Quotient));
      auto *OBO = cast<OverflowingBinaryOperator>(Op0);
      Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
      Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
      return Mul;
    }
  }

  if (!C2->isNullValue()) // avoid X udiv 0
    if (Instruction *FoldedDiv = foldBinOpIntoSelectOrPhi(I))
      return FoldedDiv;
}

if (match(Op0, m_One())) {
  assert(!Ty->isIntOrIntVectorTy(1) && "i1 divide not removed?")((void)0);
  if (IsSigned) {
    // If Op1 is 0 then it's undefined behaviour, if Op1 is 1 then the
    // result is one, if Op1 is -1 then the result is minus one, otherwise
    // it's zero.
    Value *Inc = Builder.CreateAdd(Op1, Op0);
    Value *Cmp = Builder.CreateICmpULT(Inc, ConstantInt::get(Ty, 3));
    return SelectInst::Create(Cmp, Op1, ConstantInt::get(Ty, 0));
  } else {
    // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the
    // result is one, otherwise it's zero.
    return new ZExtInst(Builder.CreateICmpEQ(Op1, Op0), Ty);
  }
}

// See if we can fold away this div instruction.
if (SimplifyDemandedInstructionBits(I))
  return &I;

// (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
Value *X, *Z;
if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) // (X - Z) / Y; Y = Op1
  if ((IsSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
      (!IsSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
    return BinaryOperator::Create(I.getOpcode(), X, Op1);

// (X << Y) / X -> 1 << Y
Value *Y;
if (IsSigned && match(Op0, m_NSWShl(m_Specific(Op1), m_Value(Y))))
  return BinaryOperator::CreateNSWShl(ConstantInt::get(Ty, 1), Y);
if (!IsSigned && match(Op0, m_NUWShl(m_Specific(Op1), m_Value(Y))))
  return BinaryOperator::CreateNUWShl(ConstantInt::get(Ty, 1), Y);

// X / (X * Y) -> 1 / Y if the multiplication does not overflow.
if (match(Op1, m_c_Mul(m_Specific(Op0), m_Value(Y)))) {
  bool HasNSW = cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap();
  bool HasNUW = cast<OverflowingBinaryOperator>(Op1)->hasNoUnsignedWrap();
  if ((IsSigned && HasNSW) || (!IsSigned && HasNUW)) {
    replaceOperand(I, 0, ConstantInt::get(Ty, 1));
    replaceOperand(I, 1, Y);
    return &I;
  }
}

return nullptr;
857}

859static const unsigned MaxDepth = 6;

861namespace {

863using FoldUDivOperandCb = Instruction *(*)(Value *Op0, Value *Op1,
                                         const BinaryOperator &I,
                                         InstCombinerImpl &IC);

867/// Used to maintain state for visitUDivOperand().
868struct UDivFoldAction {
/// Informs visitUDiv() how to fold this operand.  This can be zero if this
/// action joins two actions together.
FoldUDivOperandCb FoldAction;

/// Which operand to fold.
Value *OperandToFold;

union {
  /// The instruction returned when FoldAction is invoked.
  Instruction *FoldResult;

  /// Stores the LHS action index if this action joins two actions together.
  size_t SelectLHSIdx;
};

UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand)
    : FoldAction(FA), OperandToFold(InputOperand), FoldResult(nullptr) {}
UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand, size_t SLHS)
    : FoldAction(FA), OperandToFold(InputOperand), SelectLHSIdx(SLHS) {}
888};

890} // end anonymous namespace

892// X udiv 2^C -> X >> C
893static Instruction *foldUDivPow2Cst(Value *Op0, Value *Op1,
                                  const BinaryOperator &I,
                                  InstCombinerImpl &IC) {
Constant *C1 = ConstantExpr::getExactLogBase2(cast<Constant>(Op1));
if (!C1)
  llvm_unreachable("Failed to constant fold udiv -> logbase2")__builtin_unreachable();
BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, C1);
if (I.isExact())
  LShr->setIsExact();
return LShr;
903}

905// X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
906// X udiv (zext (C1 << N)), where C1 is "1<<C2"  -->  X >> (N+C2)
907static Instruction *foldUDivShl(Value *Op0, Value *Op1, const BinaryOperator &I,
                              InstCombinerImpl &IC) {
Value *ShiftLeft;
if (!match(Op1, m_ZExt(m_Value(ShiftLeft))))
  ShiftLeft = Op1;

Constant *CI;
Value *N;
if (!match(ShiftLeft, m_Shl(m_Constant(CI), m_Value(N))))
  llvm_unreachable("match should never fail here!")__builtin_unreachable();
Constant *Log2Base = ConstantExpr::getExactLogBase2(CI);
if (!Log2Base)
  llvm_unreachable("getLogBase2 should never fail here!")__builtin_unreachable();
N = IC.Builder.CreateAdd(N, Log2Base);
if (Op1 != ShiftLeft)
  N = IC.Builder.CreateZExt(N, Op1->getType());
BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, N);
if (I.isExact())
  LShr->setIsExact();
return LShr;
927}

929// Recursively visits the possible right hand operands of a udiv
930// instruction, seeing through select instructions, to determine if we can
931// replace the udiv with something simpler.  If we find that an operand is not
932// able to simplify the udiv, we abort the entire transformation.
933static size_t visitUDivOperand(Value *Op0, Value *Op1, const BinaryOperator &I,
                             SmallVectorImpl<UDivFoldAction> &Actions,
                             unsigned Depth = 0) {
// FIXME: assert that Op1 isn't/doesn't contain undef.

// Check to see if this is an unsigned division with an exact power of 2,
// if so, convert to a right shift.
if (match(Op1, m_Power2())) {
  Actions.push_back(UDivFoldAction(foldUDivPow2Cst, Op1));
  return Actions.size();
}

// X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
if (match(Op1, m_Shl(m_Power2(), m_Value())) ||
    match(Op1, m_ZExt(m_Shl(m_Power2(), m_Value())))) {
  Actions.push_back(UDivFoldAction(foldUDivShl, Op1));
  return Actions.size();
}

// The remaining tests are all recursive, so bail out if we hit the limit.
if (Depth++ == MaxDepth)
  return 0;

if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
  // FIXME: missed optimization: if one of the hands of select is/contains
  //        undef, just directly pick the other one.
  // FIXME: can both hands contain undef?
  if (size_t LHSIdx =
          visitUDivOperand(Op0, SI->getOperand(1), I, Actions, Depth))
    if (visitUDivOperand(Op0, SI->getOperand(2), I, Actions, Depth)) {
      Actions.push_back(UDivFoldAction(nullptr, Op1, LHSIdx - 1));
      return Actions.size();
    }

return 0;
968}

970/// If we have zero-extended operands of an unsigned div or rem, we may be able
971/// to narrow the operation (sink the zext below the math).
972static Instruction *narrowUDivURem(BinaryOperator &I,
                                 InstCombiner::BuilderTy &Builder) {
Instruction::BinaryOps Opcode = I.getOpcode();
Value *N = I.getOperand(0);
Value *D = I.getOperand(1);
Type *Ty = I.getType();
Value *X, *Y;
if (match(N, m_ZExt(m_Value(X))) && match(D, m_ZExt(m_Value(Y))) &&
    X->getType() == Y->getType() && (N->hasOneUse() || D->hasOneUse())) {
  // udiv (zext X), (zext Y) --> zext (udiv X, Y)
  // urem (zext X), (zext Y) --> zext (urem X, Y)
  Value *NarrowOp = Builder.CreateBinOp(Opcode, X, Y);
  return new ZExtInst(NarrowOp, Ty);
}

Constant *C;
if ((match(N, m_OneUse(m_ZExt(m_Value(X)))) && match(D, m_Constant(C))) ||
    (match(D, m_OneUse(m_ZExt(m_Value(X)))) && match(N, m_Constant(C)))) {
  // If the constant is the same in the smaller type, use the narrow version.
  Constant *TruncC = ConstantExpr::getTrunc(C, X->getType());
  if (ConstantExpr::getZExt(TruncC, Ty) != C)
    return nullptr;

  // udiv (zext X), C --> zext (udiv X, C')
  // urem (zext X), C --> zext (urem X, C')
  // udiv C, (zext X) --> zext (udiv C', X)
  // urem C, (zext X) --> zext (urem C', X)
  Value *NarrowOp = isa<Constant>(D) ? Builder.CreateBinOp(Opcode, X, TruncC)
                                     : Builder.CreateBinOp(Opcode, TruncC, X);
  return new ZExtInst(NarrowOp, Ty);
}

return nullptr;
1005}

1007Instruction *InstCombinerImpl::visitUDiv(BinaryOperator &I) {
if (Value *V = SimplifyUDivInst(I.getOperand(0), I.getOperand(1),
                                SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

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

// Handle the integer div common cases
if (Instruction *Common = commonIDivTransforms(I))
  return Common;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Value *X;
const APInt *C1, *C2;
if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) && match(Op1, m_APInt(C2))) {
  // (X lshr C1) udiv C2 --> X udiv (C2 << C1)
  bool Overflow;
  APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow);
  if (!Overflow) {
    bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value()));
    BinaryOperator *BO = BinaryOperator::CreateUDiv(
        X, ConstantInt::get(X->getType(), C2ShlC1));
    if (IsExact)
      BO->setIsExact();
    return BO;
  }
}

// Op0 / C where C is large (negative) --> zext (Op0 >= C)
// TODO: Could use isKnownNegative() to handle non-constant values.
Type *Ty = I.getType();
if (match(Op1, m_Negative())) {
  Value *Cmp = Builder.CreateICmpUGE(Op0, Op1);
  return CastInst::CreateZExtOrBitCast(Cmp, Ty);
}
// Op0 / (sext i1 X) --> zext (Op0 == -1) (if X is 0, the div is undefined)
if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) {
  Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty));
  return CastInst::CreateZExtOrBitCast(Cmp, Ty);
}

if (Instruction *NarrowDiv = narrowUDivURem(I, Builder))
  return NarrowDiv;

// If the udiv operands are non-overflowing multiplies with a common operand,
// then eliminate the common factor:
// (A * B) / (A * X) --> B / X (and commuted variants)
// TODO: The code would be reduced if we had m_c_NUWMul pattern matching.
// TODO: If -reassociation handled this generally, we could remove this.
Value *A, *B;
if (match(Op0, m_NUWMul(m_Value(A), m_Value(B)))) {
  if (match(Op1, m_NUWMul(m_Specific(A), m_Value(X))) ||
      match(Op1, m_NUWMul(m_Value(X), m_Specific(A))))
    return BinaryOperator::CreateUDiv(B, X);
  if (match(Op1, m_NUWMul(m_Specific(B), m_Value(X))) ||
      match(Op1, m_NUWMul(m_Value(X), m_Specific(B))))
    return BinaryOperator::CreateUDiv(A, X);
}

// (LHS udiv (select (select (...)))) -> (LHS >> (select (select (...))))
SmallVector<UDivFoldAction, 6> UDivActions;
if (visitUDivOperand(Op0, Op1, I, UDivActions))
  for (unsigned i = 0, e = UDivActions.size(); i != e; ++i) {
    FoldUDivOperandCb Action = UDivActions[i].FoldAction;
    Value *ActionOp1 = UDivActions[i].OperandToFold;
    Instruction *Inst;
    if (Action)
      Inst = Action(Op0, ActionOp1, I, *this);
    else {
      // This action joins two actions together.  The RHS of this action is
      // simply the last action we processed, we saved the LHS action index in
      // the joining action.
      size_t SelectRHSIdx = i - 1;
      Value *SelectRHS = UDivActions[SelectRHSIdx].FoldResult;
      size_t SelectLHSIdx = UDivActions[i].SelectLHSIdx;
      Value *SelectLHS = UDivActions[SelectLHSIdx].FoldResult;
      Inst = SelectInst::Create(cast<SelectInst>(ActionOp1)->getCondition(),
                                SelectLHS, SelectRHS);
    }

    // If this is the last action to process, return it to the InstCombiner.
    // Otherwise, we insert it before the UDiv and record it so that we may
    // use it as part of a joining action (i.e., a SelectInst).
    if (e - i != 1) {
      Inst->insertBefore(&I);
      UDivActions[i].FoldResult = Inst;
    } else
      return Inst;
  }

return nullptr;
1099}

1101Instruction *InstCombinerImpl::visitSDiv(BinaryOperator &I) {
if (Value *V = SimplifySDivInst(I.getOperand(0), I.getOperand(1),
                                SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

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

// Handle the integer div common cases
if (Instruction *Common = commonIDivTransforms(I))
  return Common;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Type *Ty = I.getType();
Value *X;
// sdiv Op0, -1 --> -Op0
// sdiv Op0, (sext i1 X) --> -Op0 (because if X is 0, the op is undefined)
if (match(Op1, m_AllOnes()) ||
    (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
  return BinaryOperator::CreateNeg(Op0);

// X / INT_MIN --> X == INT_MIN
if (match(Op1, m_SignMask()))
  return new ZExtInst(Builder.CreateICmpEQ(Op0, Op1), Ty);

// sdiv exact X,  1<<C  -->    ashr exact X, C   iff  1<<C  is non-negative
// sdiv exact X, -1<<C  -->  -(ashr exact X, C)
if (I.isExact() && ((match(Op1, m_Power2()) && match(Op1, m_NonNegative())) ||
                    match(Op1, m_NegatedPower2()))) {
  bool DivisorWasNegative = match(Op1, m_NegatedPower2());
  if (DivisorWasNegative)
    Op1 = ConstantExpr::getNeg(cast<Constant>(Op1));
  auto *AShr = BinaryOperator::CreateExactAShr(
      Op0, ConstantExpr::getExactLogBase2(cast<Constant>(Op1)), I.getName());
  if (!DivisorWasNegative)
    return AShr;
  Builder.Insert(AShr);
  AShr->setName(I.getName() + ".neg");
  return BinaryOperator::CreateNeg(AShr, I.getName());
}

const APInt *Op1C;
if (match(Op1, m_APInt(Op1C))) {
  // If the dividend is sign-extended and the constant divisor is small enough
  // to fit in the source type, shrink the division to the narrower type:
  // (sext X) sdiv C --> sext (X sdiv C)
  Value *Op0Src;
  if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) &&
      Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) {

    // In the general case, we need to make sure that the dividend is not the
    // minimum signed value because dividing that by -1 is UB. But here, we
    // know that the -1 divisor case is already handled above.

    Constant *NarrowDivisor =
        ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType());
    Value *NarrowOp = Builder.CreateSDiv(Op0Src, NarrowDivisor);
    return new SExtInst(NarrowOp, Ty);
  }

  // -X / C --> X / -C (if the negation doesn't overflow).
  // TODO: This could be enhanced to handle arbitrary vector constants by
  //       checking if all elements are not the min-signed-val.
  if (!Op1C->isMinSignedValue() &&
      match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) {
    Constant *NegC = ConstantInt::get(Ty, -(*Op1C));
    Instruction *BO = BinaryOperator::CreateSDiv(X, NegC);
    BO->setIsExact(I.isExact());
    return BO;
  }
}

// -X / Y --> -(X / Y)
Value *Y;
if (match(&I, m_SDiv(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y))))
  return BinaryOperator::CreateNSWNeg(
      Builder.CreateSDiv(X, Y, I.getName(), I.isExact()));

// abs(X) / X --> X > -1 ? 1 : -1
// X / abs(X) --> X > -1 ? 1 : -1
if (match(&I, m_c_BinOp(
                  m_OneUse(m_Intrinsic<Intrinsic::abs>(m_Value(X), m_One())),
                  m_Deferred(X)))) {
  Constant *NegOne = ConstantInt::getAllOnesValue(Ty);
  Value *Cond = Builder.CreateICmpSGT(X, NegOne);
  return SelectInst::Create(Cond, ConstantInt::get(Ty, 1), NegOne);
}

// If the sign bits of both operands are zero (i.e. we can prove they are
// unsigned inputs), turn this into a udiv.
APInt Mask(APInt::getSignMask(Ty->getScalarSizeInBits()));
if (MaskedValueIsZero(Op0, Mask, 0, &I)) {
  if (MaskedValueIsZero(Op1, Mask, 0, &I)) {
    // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
    auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
    BO->setIsExact(I.isExact());
    return BO;
  }

  if (match(Op1, m_NegatedPower2())) {
    // X sdiv (-(1 << C)) -> -(X sdiv (1 << C)) ->
    //                    -> -(X udiv (1 << C)) -> -(X u>> C)
    return BinaryOperator::CreateNeg(Builder.Insert(foldUDivPow2Cst(
        Op0, ConstantExpr::getNeg(cast<Constant>(Op1)), I, *this)));
  }

  if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
    // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
    // Safe because the only negative value (1 << Y) can take on is
    // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
    // the sign bit set.
    auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
    BO->setIsExact(I.isExact());
    return BO;
  }
}

return nullptr;
1219}

1221/// Remove negation and try to convert division into multiplication.
1222static Instruction *foldFDivConstantDivisor(BinaryOperator &I) {
Constant *C;
if (!match(I.getOperand(1), m_Constant(C)))
  return nullptr;

// -X / C --> X / -C
Value *X;
if (match(I.getOperand(0), m_FNeg(m_Value(X))))
  return BinaryOperator::CreateFDivFMF(X, ConstantExpr::getFNeg(C), &I);

// If the constant divisor has an exact inverse, this is always safe. If not,
// then we can still create a reciprocal if fast-math-flags allow it and the
// constant is a regular number (not zero, infinite, or denormal).
if (!(C->hasExactInverseFP() || (I.hasAllowReciprocal() && C->isNormalFP())))
  return nullptr;

// Disallow denormal constants because we don't know what would happen
// on all targets.
// TODO: Use Intrinsic::canonicalize or let function attributes tell us that
// denorms are flushed?
auto *RecipC = ConstantExpr::getFDiv(ConstantFP::get(I.getType(), 1.0), C);
if (!RecipC->isNormalFP())
  return nullptr;

// X / C --> X * (1 / C)
return BinaryOperator::CreateFMulFMF(I.getOperand(0), RecipC, &I);
1248}

1250/// Remove negation and try to reassociate constant math.
1251static Instruction *foldFDivConstantDividend(BinaryOperator &I) {
Constant *C;
if (!match(I.getOperand(0), m_Constant(C)))
  return nullptr;

// C / -X --> -C / X
Value *X;
if (match(I.getOperand(1), m_FNeg(m_Value(X))))
  return BinaryOperator::CreateFDivFMF(ConstantExpr::getFNeg(C), X, &I);

if (!I.hasAllowReassoc() || !I.hasAllowReciprocal())
  return nullptr;

// Try to reassociate C / X expressions where X includes another constant.
Constant *C2, *NewC = nullptr;
if (match(I.getOperand(1), m_FMul(m_Value(X), m_Constant(C2)))) {
  // C / (X * C2) --> (C / C2) / X
  NewC = ConstantExpr::getFDiv(C, C2);
} else if (match(I.getOperand(1), m_FDiv(m_Value(X), m_Constant(C2)))) {
  // C / (X / C2) --> (C * C2) / X
  NewC = ConstantExpr::getFMul(C, C2);
}
// Disallow denormal constants because we don't know what would happen
// on all targets.
// TODO: Use Intrinsic::canonicalize or let function attributes tell us that
// denorms are flushed?
if (!NewC || !NewC->isNormalFP())
  return nullptr;

return BinaryOperator::CreateFDivFMF(NewC, X, &I);
1281}

1283/// Negate the exponent of pow/exp to fold division-by-pow() into multiply.
1284static Instruction *foldFDivPowDivisor(BinaryOperator &I,
                                     InstCombiner::BuilderTy &Builder) {
Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
auto *II = dyn_cast<IntrinsicInst>(Op1);
if (!II || !II->hasOneUse() || !I.hasAllowReassoc() ||
    !I.hasAllowReciprocal())
  return nullptr;

// Z / pow(X, Y) --> Z * pow(X, -Y)
// Z / exp{2}(Y) --> Z * exp{2}(-Y)
// In the general case, this creates an extra instruction, but fmul allows
// for better canonicalization and optimization than fdiv.
Intrinsic::ID IID = II->getIntrinsicID();
SmallVector<Value *> Args;
switch (IID) {
case Intrinsic::pow:
  Args.push_back(II->getArgOperand(0));
  Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(1), &I));
  break;
case Intrinsic::powi: {
  // Require 'ninf' assuming that makes powi(X, -INT_MIN) acceptable.
  // That is, X ** (huge negative number) is 0.0, ~1.0, or INF and so
  // dividing by that is INF, ~1.0, or 0.0. Code that uses powi allows
  // non-standard results, so this corner case should be acceptable if the
  // code rules out INF values.
  if (!I.hasNoInfs())
    return nullptr;
  Args.push_back(II->getArgOperand(0));
  Args.push_back(Builder.CreateNeg(II->getArgOperand(1)));
  Type *Tys[] = {I.getType(), II->getArgOperand(1)->getType()};
  Value *Pow = Builder.CreateIntrinsic(IID, Tys, Args, &I);
  return BinaryOperator::CreateFMulFMF(Op0, Pow, &I);
}
case Intrinsic::exp:
case Intrinsic::exp2:
  Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(0), &I));
  break;
default:
  return nullptr;
}
Value *Pow = Builder.CreateIntrinsic(IID, I.getType(), Args, &I);
return BinaryOperator::CreateFMulFMF(Op0, Pow, &I);
1326}

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

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

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

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

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

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
if (isa<Constant>(Op0))
  if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
    if (Instruction *R = FoldOpIntoSelect(I, SI))
      return R;

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

if (I.hasAllowReassoc() && I.hasAllowReciprocal()) {
  Value *X, *Y;
  if (match(Op0, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
      (!isa<Constant>(Y) || !isa<Constant>(Op1))) {
    // (X / Y) / Z => X / (Y * Z)
    Value *YZ = Builder.CreateFMulFMF(Y, Op1, &I);
    return BinaryOperator::CreateFDivFMF(X, YZ, &I);
  }
  if (match(Op1, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
      (!isa<Constant>(Y) || !isa<Constant>(Op0))) {
    // Z / (X / Y) => (Y * Z) / X
    Value *YZ = Builder.CreateFMulFMF(Y, Op0, &I);
    return BinaryOperator::CreateFDivFMF(YZ, X, &I);
  }
  // Z / (1.0 / Y) => (Y * Z)
  //
  // This is a special case of Z / (X / Y) => (Y * Z) / X, with X = 1.0. The
  // m_OneUse check is avoided because even in the case of the multiple uses
  // for 1.0/Y, the number of instructions remain the same and a division is
  // replaced by a multiplication.
  if (match(Op1, m_FDiv(m_SpecificFP(1.0), m_Value(Y))))
    return BinaryOperator::CreateFMulFMF(Y, Op0, &I);
}

if (I.hasAllowReassoc() && Op0->hasOneUse() && Op1->hasOneUse()) {
  // sin(X) / cos(X) -> tan(X)
  // cos(X) / sin(X) -> 1/tan(X) (cotangent)
  Value *X;
  bool IsTan = match(Op0, m_Intrinsic<Intrinsic::sin>(m_Value(X))) &&
               match(Op1, m_Intrinsic<Intrinsic::cos>(m_Specific(X)));
  bool IsCot =
      !IsTan && match(Op0, m_Intrinsic<Intrinsic::cos>(m_Value(X))) &&
                match(Op1, m_Intrinsic<Intrinsic::sin>(m_Specific(X)));

  if ((IsTan || IsCot) &&
      hasFloatFn(&TLI, I.getType(), LibFunc_tan, LibFunc_tanf, LibFunc_tanl)) {
    IRBuilder<> B(&I);
    IRBuilder<>::FastMathFlagGuard FMFGuard(B);
    B.setFastMathFlags(I.getFastMathFlags());
    AttributeList Attrs =
        cast<CallBase>(Op0)->getCalledFunction()->getAttributes();
    Value *Res = emitUnaryFloatFnCall(X, &TLI, LibFunc_tan, LibFunc_tanf,
                                      LibFunc_tanl, B, Attrs);
    if (IsCot)
      Res = B.CreateFDiv(ConstantFP::get(I.getType(), 1.0), Res);
    return replaceInstUsesWith(I, Res);
  }
}

// X / (X * Y) --> 1.0 / Y
// Reassociate to (X / X -> 1.0) is legal when NaNs are not allowed.
// We can ignore the possibility that X is infinity because INF/INF is NaN.
Value *X, *Y;
if (I.hasNoNaNs() && I.hasAllowReassoc() &&
    match(Op1, m_c_FMul(m_Specific(Op0), m_Value(Y)))) {
  replaceOperand(I, 0, ConstantFP::get(I.getType(), 1.0));
  replaceOperand(I, 1, Y);
  return &I;
}

// X / fabs(X) -> copysign(1.0, X)
// fabs(X) / X -> copysign(1.0, X)
if (I.hasNoNaNs() && I.hasNoInfs() &&
    (match(&I, m_FDiv(m_Value(X), m_FAbs(m_Deferred(X)))) ||
     match(&I, m_FDiv(m_FAbs(m_Value(X)), m_Deferred(X))))) {
  Value *V = Builder.CreateBinaryIntrinsic(
      Intrinsic::copysign, ConstantFP::get(I.getType(), 1.0), X, &I);
  return replaceInstUsesWith(I, V);
}

if (Instruction *Mul = foldFDivPowDivisor(I, Builder))
  return Mul;

return nullptr;
1431}

1433/// This function implements the transforms common to both integer remainder
1434/// instructions (urem and srem). It is called by the visitors to those integer
1435/// remainder instructions.
1436/// Common integer remainder transforms
1437Instruction *InstCombinerImpl::commonIRemTransforms(BinaryOperator &I) {
Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);

// The RHS is known non-zero.
if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I))
6
←
Assuming 'V' is null→
7
←
Taking false branch→
  return replaceOperand(I, 1, V);

// Handle cases involving: rem X, (select Cond, Y, Z)
if (simplifyDivRemOfSelectWithZeroOp(I))
8
←
Calling 'InstCombinerImpl::simplifyDivRemOfSelectWithZeroOp'→
  return &I;

if (isa<Constant>(Op1)) {
  if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
    if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
      if (Instruction *R = FoldOpIntoSelect(I, SI))
        return R;
    } else if (auto *PN = dyn_cast<PHINode>(Op0I)) {
      const APInt *Op1Int;
      if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() &&
          (I.getOpcode() == Instruction::URem ||
           !Op1Int->isMinSignedValue())) {
        // foldOpIntoPhi will speculate instructions to the end of the PHI's
        // predecessor blocks, so do this only if we know the srem or urem
        // will not fault.
        if (Instruction *NV = foldOpIntoPhi(I, PN))
          return NV;
      }
    }

    // See if we can fold away this rem instruction.
    if (SimplifyDemandedInstructionBits(I))
      return &I;
  }
}

return nullptr;
1473}

1475Instruction *InstCombinerImpl::visitURem(BinaryOperator &I) {
if (Value *V = SimplifyURemInst(I.getOperand(0), I.getOperand(1),
1
Assuming 'V' is null→
2
←
Taking false branch→
                                SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

if (Instruction *X = foldVectorBinop(I))
3
←
Assuming 'X' is null→
4
←
Taking false branch→
  return X;

if (Instruction *common = commonIRemTransforms(I))
5
←
Calling 'InstCombinerImpl::commonIRemTransforms'→
  return common;

if (Instruction *NarrowRem = narrowUDivURem(I, Builder))
  return NarrowRem;

// X urem Y -> X and Y-1, where Y is a power of 2,
Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Type *Ty = I.getType();
if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
  // This may increase instruction count, we don't enforce that Y is a
  // constant.
  Constant *N1 = Constant::getAllOnesValue(Ty);
  Value *Add = Builder.CreateAdd(Op1, N1);
  return BinaryOperator::CreateAnd(Op0, Add);
}

// 1 urem X -> zext(X != 1)
if (match(Op0, m_One())) {
  Value *Cmp = Builder.CreateICmpNE(Op1, ConstantInt::get(Ty, 1));
  return CastInst::CreateZExtOrBitCast(Cmp, Ty);
}

// X urem C -> X < C ? X : X - C, where C >= signbit.
if (match(Op1, m_Negative())) {
  Value *Cmp = Builder.CreateICmpULT(Op0, Op1);
  Value *Sub = Builder.CreateSub(Op0, Op1);
  return SelectInst::Create(Cmp, Op0, Sub);
}

// If the divisor is a sext of a boolean, then the divisor must be max
// unsigned value (-1). Therefore, the remainder is Op0 unless Op0 is also
// max unsigned value. In that case, the remainder is 0:
// urem Op0, (sext i1 X) --> (Op0 == -1) ? 0 : Op0
Value *X;
if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) {
  Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty));
  return SelectInst::Create(Cmp, ConstantInt::getNullValue(Ty), Op0);
}

return nullptr;
1524}

1526Instruction *InstCombinerImpl::visitSRem(BinaryOperator &I) {
if (Value *V = SimplifySRemInst(I.getOperand(0), I.getOperand(1),
                                SQ.getWithInstruction(&I)))
  return replaceInstUsesWith(I, V);

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

// Handle the integer rem common cases
if (Instruction *Common = commonIRemTransforms(I))
  return Common;

Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
{
  const APInt *Y;
  // X % -Y -> X % Y
  if (match(Op1, m_Negative(Y)) && !Y->isMinSignedValue())
    return replaceOperand(I, 1, ConstantInt::get(I.getType(), -*Y));
}

// -X srem Y --> -(X srem Y)
Value *X, *Y;
if (match(&I, m_SRem(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y))))
  return BinaryOperator::CreateNSWNeg(Builder.CreateSRem(X, Y));

// If the sign bits of both operands are zero (i.e. we can prove they are
// unsigned inputs), turn this into a urem.
APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
if (MaskedValueIsZero(Op1, Mask, 0, &I) &&
    MaskedValueIsZero(Op0, Mask, 0, &I)) {
  // X srem Y -> X urem Y, iff X and Y don't have sign bit set
  return BinaryOperator::CreateURem(Op0, Op1, I.getName());
}

// If it's a constant vector, flip any negative values positive.
if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
  Constant *C = cast<Constant>(Op1);
  unsigned VWidth = cast<FixedVectorType>(C->getType())->getNumElements();

  bool hasNegative = false;
  bool hasMissing = false;
  for (unsigned i = 0; i != VWidth; ++i) {
    Constant *Elt = C->getAggregateElement(i);
    if (!Elt) {
      hasMissing = true;
      break;
    }

    if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
      if (RHS->isNegative())
        hasNegative = true;
  }

  if (hasNegative && !hasMissing) {
    SmallVector<Constant *, 16> Elts(VWidth);
    for (unsigned i = 0; i != VWidth; ++i) {
      Elts[i] = C->getAggregateElement(i);  // Handle undef, etc.
      if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
        if (RHS->isNegative())
          Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
      }
    }

    Constant *NewRHSV = ConstantVector::get(Elts);
    if (NewRHSV != C)  // Don't loop on -MININT
      return replaceOperand(I, 1, NewRHSV);
  }
}

return nullptr;
1596}

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

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

return nullptr;
1608}

←

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

←

/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IR/Value.h

→

1//===- llvm/Value.h - Definition of the Value class -------------*- 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 declares the Value class.
10//
11//===----------------------------------------------------------------------===//

13#ifndef LLVM_IR_VALUE_H
14#define LLVM_IR_VALUE_H

16#include "llvm-c/Types.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/StringRef.h"
19#include "llvm/ADT/iterator_range.h"
20#include "llvm/IR/Use.h"
21#include "llvm/Support/Alignment.h"
22#include "llvm/Support/CBindingWrapping.h"
23#include "llvm/Support/Casting.h"
24#include <cassert>
25#include <iterator>
26#include <memory>

28namespace llvm {

30class APInt;
31class Argument;
32class BasicBlock;
33class Constant;
34class ConstantData;
35class ConstantAggregate;
36class DataLayout;
37class Function;
38class GlobalAlias;
39class GlobalIFunc;
40class GlobalIndirectSymbol;
41class GlobalObject;
42class GlobalValue;
43class GlobalVariable;
44class InlineAsm;
45class Instruction;
46class LLVMContext;
47class MDNode;
48class Module;
49class ModuleSlotTracker;
50class raw_ostream;
51template<typename ValueTy> class StringMapEntry;
52class Twine;
53class Type;
54class User;

56using ValueName = StringMapEntry<Value *>;

58//===----------------------------------------------------------------------===//
59//                                 Value Class
60//===----------------------------------------------------------------------===//

62/// LLVM Value Representation
63///
64/// This is a very important LLVM class. It is the base class of all values
65/// computed by a program that may be used as operands to other values. Value is
66/// the super class of other important classes such as Instruction and Function.
67/// All Values have a Type. Type is not a subclass of Value. Some values can
68/// have a name and they belong to some Module.  Setting the name on the Value
69/// automatically updates the module's symbol table.
70///
71/// Every value has a "use list" that keeps track of which other Values are
72/// using this Value.  A Value can also have an arbitrary number of ValueHandle
73/// objects that watch it and listen to RAUW and Destroy events.  See
74/// llvm/IR/ValueHandle.h for details.
75class Value {
Type *VTy;
Use *UseList;

friend class ValueAsMetadata; // Allow access to IsUsedByMD.
friend class ValueHandleBase;

const unsigned char SubclassID;   // Subclass identifier (for isa/dyn_cast)
unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?

85protected:
/// Hold subclass data that can be dropped.
///
/// This member is similar to SubclassData, however it is for holding
/// information which may be used to aid optimization, but which may be
/// cleared to zero without affecting conservative interpretation.
unsigned char SubclassOptionalData : 7;

93private:
/// Hold arbitrary subclass data.
///
/// This member is defined by this class, but is not used for anything.
/// Subclasses can use it to hold whatever state they find useful.  This
/// field is initialized to zero by the ctor.
unsigned short SubclassData;

101protected:
/// The number of operands in the subclass.
///
/// This member is defined by this class, but not used for anything.
/// Subclasses can use it to store their number of operands, if they have
/// any.
///
/// This is stored here to save space in User on 64-bit hosts.  Since most
/// instances of Value have operands, 32-bit hosts aren't significantly
/// affected.
///
/// Note, this should *NOT* be used directly by any class other than User.
/// User uses this value to find the Use list.
enum : unsigned { NumUserOperandsBits = 27 };
unsigned NumUserOperands : NumUserOperandsBits;

// Use the same type as the bitfield above so that MSVC will pack them.
unsigned IsUsedByMD : 1;
unsigned HasName : 1;
unsigned HasMetadata : 1; // Has metadata attached to this?
unsigned HasHungOffUses : 1;
unsigned HasDescriptor : 1;

124private:
template <typename UseT> // UseT == 'Use' or 'const Use'
class use_iterator_impl {
  friend class Value;

  UseT *U;

  explicit use_iterator_impl(UseT *u) : U(u) {}

public:
  using iterator_category = std::forward_iterator_tag;
  using value_type = UseT *;
  using difference_type = std::ptrdiff_t;
  using pointer = value_type *;
  using reference = value_type &;

  use_iterator_impl() : U() {}

  bool operator==(const use_iterator_impl &x) const { return U == x.U; }
  bool operator!=(const use_iterator_impl &x) const { return !operator==(x); }

  use_iterator_impl &operator++() { // Preincrement
    assert(U && "Cannot increment end iterator!")((void)0);
    U = U->getNext();
    return *this;
  }

  use_iterator_impl operator++(int) { // Postincrement
    auto tmp = *this;
    ++*this;
    return tmp;
  }

  UseT &operator*() const {
    assert(U && "Cannot dereference end iterator!")((void)0);
    return *U;
  }

  UseT *operator->() const { return &operator*(); }

  operator use_iterator_impl<const UseT>() const {
    return use_iterator_impl<const UseT>(U);
  }
};

template <typename UserTy> // UserTy == 'User' or 'const User'
class user_iterator_impl {
  use_iterator_impl<Use> UI;
  explicit user_iterator_impl(Use *U) : UI(U) {}
  friend class Value;

public:
  using iterator_category = std::forward_iterator_tag;
  using value_type = UserTy *;
  using difference_type = std::ptrdiff_t;
  using pointer = value_type *;
  using reference = value_type &;

  user_iterator_impl() = default;

  bool operator==(const user_iterator_impl &x) const { return UI == x.UI; }
  bool operator!=(const user_iterator_impl &x) const { return !operator==(x); }

  /// Returns true if this iterator is equal to user_end() on the value.
  bool atEnd() const { return *this == user_iterator_impl(); }

  user_iterator_impl &operator++() { // Preincrement
    ++UI;
    return *this;
  }

  user_iterator_impl operator++(int) { // Postincrement
    auto tmp = *this;
    ++*this;
    return tmp;
  }

  // Retrieve a pointer to the current User.
  UserTy *operator*() const {
    return UI->getUser();
  }

  UserTy *operator->() const { return operator*(); }

  operator user_iterator_impl<const UserTy>() const {
    return user_iterator_impl<const UserTy>(*UI);
  }

  Use &getUse() const { return *UI; }
};

215protected:
Value(Type *Ty, unsigned scid);

/// Value's destructor should be virtual by design, but that would require
/// that Value and all of its subclasses have a vtable that effectively
/// duplicates the information in the value ID. As a size optimization, the
/// destructor has been protected, and the caller should manually call
/// deleteValue.
~Value(); // Use deleteValue() to delete a generic Value.

225public:
Value(const Value &) = delete;
Value &operator=(const Value &) = delete;

/// Delete a pointer to a generic Value.
void deleteValue();

/// Support for debugging, callable in GDB: V->dump()
void dump() const;

/// Implement operator<< on Value.
/// @{
void print(raw_ostream &O, bool IsForDebug = false) const;
void print(raw_ostream &O, ModuleSlotTracker &MST,
           bool IsForDebug = false) const;
/// @}

/// Print the name of this Value out to the specified raw_ostream.
///
/// This is useful when you just want to print 'int %reg126', not the
/// instruction that generated it. If you specify a Module for context, then
/// even constanst get pretty-printed; for example, the type of a null
/// pointer is printed symbolically.
/// @{
void printAsOperand(raw_ostream &O, bool PrintType = true,
                    const Module *M = nullptr) const;
void printAsOperand(raw_ostream &O, bool PrintType,
                    ModuleSlotTracker &MST) const;
/// @}

/// All values are typed, get the type of this value.
Type *getType() const { return VTy; }

/// All values hold a context through their type.
LLVMContext &getContext() const;

// All values can potentially be named.
bool hasName() const { return HasName; }
ValueName *getValueName() const;
void setValueName(ValueName *VN);

266private:
void destroyValueName();
enum class ReplaceMetadataUses { No, Yes };
void doRAUW(Value *New, ReplaceMetadataUses);
void setNameImpl(const Twine &Name);

272public:
/// Return a constant reference to the value's name.
///
/// This guaranteed to return the same reference as long as the value is not
/// modified.  If the value has a name, this does a hashtable lookup, so it's
/// not free.
StringRef getName() const;

/// Change the name of the value.
///
/// Choose a new unique name if the provided name is taken.
///
/// \param Name The new name; or "" if the value's name should be removed.
void setName(const Twine &Name);

/// Transfer the name from V to this value.
///
/// After taking V's name, sets V's name to empty.
///
/// \note It is an error to call V->takeName(V).
void takeName(Value *V);

294#ifndef NDEBUG1
std::string getNameOrAsOperand() const;
296#endif

/// Change all uses of this to point to a new Value.
///
/// Go through the uses list for this definition and make each use point to
/// "V" instead of "this".  After this completes, 'this's use list is
/// guaranteed to be empty.
void replaceAllUsesWith(Value *V);

/// Change non-metadata uses of this to point to a new Value.
///
/// Go through the uses list for this definition and make each use point to
/// "V" instead of "this". This function skips metadata entries in the list.
void replaceNonMetadataUsesWith(Value *V);

/// Go through the uses list for this definition and make each use point
/// to "V" if the callback ShouldReplace returns true for the given Use.
/// Unlike replaceAllUsesWith() this function does not support basic block
/// values.
void replaceUsesWithIf(Value *New,
                       llvm::function_ref<bool(Use &U)> ShouldReplace);

/// replaceUsesOutsideBlock - Go through the uses list for this definition and
/// make each use point to "V" instead of "this" when the use is outside the
/// block. 'This's use list is expected to have at least one element.
/// Unlike replaceAllUsesWith() this function does not support basic block
/// values.
void replaceUsesOutsideBlock(Value *V, BasicBlock *BB);

//----------------------------------------------------------------------
// Methods for handling the chain of uses of this Value.
//
// Materializing a function can introduce new uses, so these methods come in
// two variants:
// The methods that start with materialized_ check the uses that are
// currently known given which functions are materialized. Be very careful
// when using them since you might not get all uses.
// The methods that don't start with materialized_ assert that modules is
// fully materialized.
void assertModuleIsMaterializedImpl() const;
// This indirection exists so we can keep assertModuleIsMaterializedImpl()
// around in release builds of Value.cpp to be linked with other code built
// in debug mode. But this avoids calling it in any of the release built code.
void assertModuleIsMaterialized() const {
340#ifndef NDEBUG1
  assertModuleIsMaterializedImpl();
342#endif
}

bool use_empty() const {
  assertModuleIsMaterialized();
  return UseList == nullptr;
22
←
Assuming the condition is false→
23
←
Returning zero, which participates in a condition later→
}

bool materialized_use_empty() const {
  return UseList == nullptr;
}

using use_iterator = use_iterator_impl<Use>;
using const_use_iterator = use_iterator_impl<const Use>;

use_iterator materialized_use_begin() { return use_iterator(UseList); }
const_use_iterator materialized_use_begin() const {
  return const_use_iterator(UseList);
}
use_iterator use_begin() {
  assertModuleIsMaterialized();
  return materialized_use_begin();
}
const_use_iterator use_begin() const {
  assertModuleIsMaterialized();
  return materialized_use_begin();
}
use_iterator use_end() { return use_iterator(); }
const_use_iterator use_end() const { return const_use_iterator(); }
iterator_range<use_iterator> materialized_uses() {
  return make_range(materialized_use_begin(), use_end());
}
iterator_range<const_use_iterator> materialized_uses() const {
  return make_range(materialized_use_begin(), use_end());
}
iterator_range<use_iterator> uses() {
  assertModuleIsMaterialized();
  return materialized_uses();
}
iterator_range<const_use_iterator> uses() const {
  assertModuleIsMaterialized();
  return materialized_uses();
}

bool user_empty() const {
  assertModuleIsMaterialized();
  return UseList == nullptr;
}

using user_iterator = user_iterator_impl<User>;
using const_user_iterator = user_iterator_impl<const User>;

user_iterator materialized_user_begin() { return user_iterator(UseList); }
const_user_iterator materialized_user_begin() const {
  return const_user_iterator(UseList);
}
user_iterator user_begin() {
  assertModuleIsMaterialized();
  return materialized_user_begin();
}
const_user_iterator user_begin() const {
  assertModuleIsMaterialized();
  return materialized_user_begin();
}
user_iterator user_end() { return user_iterator(); }
const_user_iterator user_end() const { return const_user_iterator(); }
User *user_back() {
  assertModuleIsMaterialized();
  return *materialized_user_begin();
}
const User *user_back() const {
  assertModuleIsMaterialized();
  return *materialized_user_begin();
}
iterator_range<user_iterator> materialized_users() {
  return make_range(materialized_user_begin(), user_end());
}
iterator_range<const_user_iterator> materialized_users() const {
  return make_range(materialized_user_begin(), user_end());
}
iterator_range<user_iterator> users() {
  assertModuleIsMaterialized();
  return materialized_users();
}
iterator_range<const_user_iterator> users() const {
  assertModuleIsMaterialized();
  return materialized_users();
}

/// Return true if there is exactly one use of this value.
///
/// This is specialized because it is a common request and does not require
/// traversing the whole use list.
bool hasOneUse() const { return hasSingleElement(uses()); }

/// Return true if this Value has exactly N uses.
bool hasNUses(unsigned N) const;

/// Return true if this value has N uses or more.
///
/// This is logically equivalent to getNumUses() >= N.
bool hasNUsesOrMore(unsigned N) const;

/// Return true if there is exactly one user of this value.
///
/// Note that this is not the same as "has one use". If a value has one use,
/// then there certainly is a single user. But if value has several uses,
/// it is possible that all uses are in a single user, or not.
///
/// This check is potentially costly, since it requires traversing,
/// in the worst case, the whole use list of a value.
bool hasOneUser() const;

/// Return true if there is exactly one use of this value that cannot be
/// dropped.
///
/// This is specialized because it is a common request and does not require
/// traversing the whole use list.
Use *getSingleUndroppableUse();
const Use *getSingleUndroppableUse() const {
  return const_cast<Value *>(this)->getSingleUndroppableUse();
}

/// Return true if there this value.
///
/// This is specialized because it is a common request and does not require
/// traversing the whole use list.
bool hasNUndroppableUses(unsigned N) const;

/// Return true if this value has N uses or more.
///
/// This is logically equivalent to getNumUses() >= N.
bool hasNUndroppableUsesOrMore(unsigned N) const;

/// Remove every uses that can safely be removed.
///
/// This will remove for example uses in llvm.assume.
/// This should be used when performing want to perform a tranformation but
/// some Droppable uses pervent it.
/// This function optionally takes a filter to only remove some droppable
/// uses.
void dropDroppableUses(llvm::function_ref<bool(const Use *)> ShouldDrop =
                           [](const Use *) { return true; });

/// Remove every use of this value in \p User that can safely be removed.
void dropDroppableUsesIn(User &Usr);

/// Remove the droppable use \p U.
static void dropDroppableUse(Use &U);

/// Check if this value is used in the specified basic block.
bool isUsedInBasicBlock(const BasicBlock *BB) const;

/// This method computes the number of uses of this Value.
///
/// This is a linear time operation.  Use hasOneUse, hasNUses, or
/// hasNUsesOrMore to check for specific values.
unsigned getNumUses() const;

/// This method should only be used by the Use class.
void addUse(Use &U) { U.addToList(&UseList); }

/// Concrete subclass of this.
///
/// An enumeration for keeping track of the concrete subclass of Value that
/// is actually instantiated. Values of this enumeration are kept in the
/// Value classes SubclassID field. They are used for concrete type
/// identification.
enum ValueTy {
511#define HANDLE_VALUE(Name) Name##Val,
512#include "llvm/IR/Value.def"

  // Markers:
515#define HANDLE_CONSTANT_MARKER(Marker, Constant) Marker = Constant##Val,
516#include "llvm/IR/Value.def"
};

/// Return an ID for the concrete type of this object.
///
/// This is used to implement the classof checks.  This should not be used
/// for any other purpose, as the values may change as LLVM evolves.  Also,
/// note that for instructions, the Instruction's opcode is added to
/// InstructionVal. So this means three things:
/// # there is no value with code InstructionVal (no opcode==0).
/// # there are more possible values for the value type than in ValueTy enum.
/// # the InstructionVal enumerator must be the highest valued enumerator in
///   the ValueTy enum.
unsigned getValueID() const {
  return SubclassID;
}

/// Return the raw optional flags value contained in this value.
///
/// This should only be used when testing two Values for equivalence.
unsigned getRawSubclassOptionalData() const {
  return SubclassOptionalData;
}

/// Clear the optional flags contained in this value.
void clearSubclassOptionalData() {
  SubclassOptionalData = 0;
}

/// Check the optional flags for equality.
bool hasSameSubclassOptionalData(const Value *V) const {
  return SubclassOptionalData == V->SubclassOptionalData;
}

/// Return true if there is a value handle associated with this value.
bool hasValueHandle() const { return HasValueHandle; }

/// Return true if there is metadata referencing this value.
bool isUsedByMetadata() const { return IsUsedByMD; }

// Return true if this value is only transitively referenced by metadata.
bool isTransitiveUsedByMetadataOnly() const;

559protected:
/// Get the current metadata attachments for the given kind, if any.
///
/// These functions require that the value have at most a single attachment
/// of the given kind, and return \c nullptr if such an attachment is missing.
/// @{
MDNode *getMetadata(unsigned KindID) const;
MDNode *getMetadata(StringRef Kind) const;
/// @}

/// Appends all attachments with the given ID to \c MDs in insertion order.
/// If the Value has no attachments with the given ID, or if ID is invalid,
/// leaves MDs unchanged.
/// @{
void getMetadata(unsigned KindID, SmallVectorImpl<MDNode *> &MDs) const;
void getMetadata(StringRef Kind, SmallVectorImpl<MDNode *> &MDs) const;
/// @}

/// Appends all metadata attached to this value to \c MDs, sorting by
/// KindID. The first element of each pair returned is the KindID, the second
/// element is the metadata value. Attachments with the same ID appear in
/// insertion order.
void
getAllMetadata(SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const;

/// Return true if this value has any metadata attached to it.
bool hasMetadata() const { return (bool)HasMetadata; }

/// Return true if this value has the given type of metadata attached.
/// @{
bool hasMetadata(unsigned KindID) const {
  return getMetadata(KindID) != nullptr;
}
bool hasMetadata(StringRef Kind) const {
  return getMetadata(Kind) != nullptr;
}
/// @}

/// Set a particular kind of metadata attachment.
///
/// Sets the given attachment to \c MD, erasing it if \c MD is \c nullptr or
/// replacing it if it already exists.
/// @{
void setMetadata(unsigned KindID, MDNode *Node);
void setMetadata(StringRef Kind, MDNode *Node);
/// @}

/// Add a metadata attachment.
/// @{
void addMetadata(unsigned KindID, MDNode &MD);
void addMetadata(StringRef Kind, MDNode &MD);
/// @}

/// Erase all metadata attachments with the given kind.
///
/// \returns true if any metadata was removed.
bool eraseMetadata(unsigned KindID);

/// Erase all metadata attached to this Value.
void clearMetadata();

620public:
/// Return true if this value is a swifterror value.
///
/// swifterror values can be either a function argument or an alloca with a
/// swifterror attribute.
bool isSwiftError() const;

/// Strip off pointer casts, all-zero GEPs and address space casts.
///
/// Returns the original uncasted value.  If this is called on a non-pointer
/// value, it returns 'this'.
const Value *stripPointerCasts() const;
Value *stripPointerCasts() {
  return const_cast<Value *>(
      static_cast<const Value *>(this)->stripPointerCasts());
}

/// Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
///
/// Returns the original uncasted value.  If this is called on a non-pointer
/// value, it returns 'this'.
const Value *stripPointerCastsAndAliases() const;
Value *stripPointerCastsAndAliases() {
  return const_cast<Value *>(
      static_cast<const Value *>(this)->stripPointerCastsAndAliases());
}

/// Strip off pointer casts, all-zero GEPs and address space casts
/// but ensures the representation of the result stays the same.
///
/// Returns the original uncasted value with the same representation. If this
/// is called on a non-pointer value, it returns 'this'.
const Value *stripPointerCastsSameRepresentation() const;
Value *stripPointerCastsSameRepresentation() {
  return const_cast<Value *>(static_cast<const Value *>(this)
                                 ->stripPointerCastsSameRepresentation());
}

/// Strip off pointer casts, all-zero GEPs, single-argument phi nodes and
/// invariant group info.
///
/// Returns the original uncasted value.  If this is called on a non-pointer
/// value, it returns 'this'. This function should be used only in
/// Alias analysis.
const Value *stripPointerCastsForAliasAnalysis() const;
Value *stripPointerCastsForAliasAnalysis() {
  return const_cast<Value *>(static_cast<const Value *>(this)
                                 ->stripPointerCastsForAliasAnalysis());
}

/// Strip off pointer casts and all-constant inbounds GEPs.
///
/// Returns the original pointer value.  If this is called on a non-pointer
/// value, it returns 'this'.
const Value *stripInBoundsConstantOffsets() const;
Value *stripInBoundsConstantOffsets() {
  return const_cast<Value *>(
            static_cast<const Value *>(this)->stripInBoundsConstantOffsets());
}

/// Accumulate the constant offset this value has compared to a base pointer.
/// Only 'getelementptr' instructions (GEPs) are accumulated but other
/// instructions, e.g., casts, are stripped away as well.
/// The accumulated constant offset is added to \p Offset and the base
/// pointer is returned.
///
/// The APInt \p Offset has to have a bit-width equal to the IntPtr type for
/// the address space of 'this' pointer value, e.g., use
/// DataLayout::getIndexTypeSizeInBits(Ty).
///
/// If \p AllowNonInbounds is true, offsets in GEPs are stripped and
/// accumulated even if the GEP is not "inbounds".
///
/// If \p ExternalAnalysis is provided it will be used to calculate a offset
/// when a operand of GEP is not constant.
/// For example, for a value \p ExternalAnalysis might try to calculate a
/// lower bound. If \p ExternalAnalysis is successful, it should return true.
///
/// If this is called on a non-pointer value, it returns 'this' and the
/// \p Offset is not modified.
///
/// Note that this function will never return a nullptr. It will also never
/// manipulate the \p Offset in a way that would not match the difference
/// between the underlying value and the returned one. Thus, if no constant
/// offset was found, the returned value is the underlying one and \p Offset
/// is unchanged.
const Value *stripAndAccumulateConstantOffsets(
    const DataLayout &DL, APInt &Offset, bool AllowNonInbounds,
    function_ref<bool(Value &Value, APInt &Offset)> ExternalAnalysis =
        nullptr) const;
Value *stripAndAccumulateConstantOffsets(const DataLayout &DL, APInt &Offset,
                                         bool AllowNonInbounds) {
  return const_cast<Value *>(
      static_cast<const Value *>(this)->stripAndAccumulateConstantOffsets(
          DL, Offset, AllowNonInbounds));
}

/// This is a wrapper around stripAndAccumulateConstantOffsets with the
/// in-bounds requirement set to false.
const Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
                                                       APInt &Offset) const {
  return stripAndAccumulateConstantOffsets(DL, Offset,
                                           /* AllowNonInbounds */ false);
}
Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
                                                 APInt &Offset) {
  return stripAndAccumulateConstantOffsets(DL, Offset,
                                           /* AllowNonInbounds */ false);
}

/// Strip off pointer casts and inbounds GEPs.
///
/// Returns the original pointer value.  If this is called on a non-pointer
/// value, it returns 'this'.
const Value *stripInBoundsOffsets(function_ref<void(const Value *)> Func =
                                      [](const Value *) {}) const;
inline Value *stripInBoundsOffsets(function_ref<void(const Value *)> Func =
                                [](const Value *) {}) {
  return const_cast<Value *>(
      static_cast<const Value *>(this)->stripInBoundsOffsets(Func));
}

/// Return true if the memory object referred to by V can by freed in the
/// scope for which the SSA value defining the allocation is statically
/// defined.  E.g.  deallocation after the static scope of a value does not
/// count, but a deallocation before that does.
bool canBeFreed() const;

/// Returns the number of bytes known to be dereferenceable for the
/// pointer value.
///
/// If CanBeNull is set by this function the pointer can either be null or be
/// dereferenceable up to the returned number of bytes.
///
/// IF CanBeFreed is true, the pointer is known to be dereferenceable at
/// point of definition only.  Caller must prove that allocation is not
/// deallocated between point of definition and use.
uint64_t getPointerDereferenceableBytes(const DataLayout &DL,
                                        bool &CanBeNull,
                                        bool &CanBeFreed) const;

/// Returns an alignment of the pointer value.
///
/// Returns an alignment which is either specified explicitly, e.g. via
/// align attribute of a function argument, or guaranteed by DataLayout.
Align getPointerAlignment(const DataLayout &DL) const;

/// Translate PHI node to its predecessor from the given basic block.
///
/// If this value is a PHI node with CurBB as its parent, return the value in
/// the PHI node corresponding to PredBB.  If not, return ourself.  This is
/// useful if you want to know the value something has in a predecessor
/// block.
const Value *DoPHITranslation(const BasicBlock *CurBB,
                              const BasicBlock *PredBB) const;
Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB) {
  return const_cast<Value *>(
           static_cast<const Value *>(this)->DoPHITranslation(CurBB, PredBB));
}

/// The maximum alignment for instructions.
///
/// This is the greatest alignment value supported by load, store, and alloca
/// instructions, and global values.
static const unsigned MaxAlignmentExponent = 29;
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent;

/// Mutate the type of this Value to be of the specified type.
///
/// Note that this is an extremely dangerous operation which can create
/// completely invalid IR very easily.  It is strongly recommended that you
/// recreate IR objects with the right types instead of mutating them in
/// place.
void mutateType(Type *Ty) {
  VTy = Ty;
}

/// Sort the use-list.
///
/// Sorts the Value's use-list by Cmp using a stable mergesort.  Cmp is
/// expected to compare two \a Use references.
template <class Compare> void sortUseList(Compare Cmp);

/// Reverse the use-list.
void reverseUseList();

806private:
/// Merge two lists together.
///
/// Merges \c L and \c R using \c Cmp.  To enable stable sorts, always pushes
/// "equal" items from L before items from R.
///
/// \return the first element in the list.
///
/// \note Completely ignores \a Use::Prev (doesn't read, doesn't update).
template <class Compare>
static Use *mergeUseLists(Use *L, Use *R, Compare Cmp) {
  Use *Merged;
  Use **Next = &Merged;

  while (true) {
    if (!L) {
      *Next = R;
      break;
    }
    if (!R) {
      *Next = L;
      break;
    }
    if (Cmp(*R, *L)) {
      *Next = R;
      Next = &R->Next;
      R = R->Next;
    } else {
      *Next = L;
      Next = &L->Next;
      L = L->Next;
    }
  }

  return Merged;
}

843protected:
unsigned short getSubclassDataFromValue() const { return SubclassData; }
void setValueSubclassData(unsigned short D) { SubclassData = D; }
846};

848struct ValueDeleter { void operator()(Value *V) { V->deleteValue(); } };

850/// Use this instead of std::unique_ptr<Value> or std::unique_ptr<Instruction>.
851/// Those don't work because Value and Instruction's destructors are protected,
852/// aren't virtual, and won't destroy the complete object.
853using unique_value = std::unique_ptr<Value, ValueDeleter>;

855inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
V.print(OS);
return OS;
858}

860void Use::set(Value *V) {
if (Val) removeFromList();
Val = V;
if (V) V->addUse(*this);
864}

866Value *Use::operator=(Value *RHS) {
set(RHS);
return RHS;
869}

871const Use &Use::operator=(const Use &RHS) {
set(RHS.Val);
return *this;
874}

876template <class Compare> void Value::sortUseList(Compare Cmp) {
if (!UseList || !UseList->Next)
  // No need to sort 0 or 1 uses.
  return;

// Note: this function completely ignores Prev pointers until the end when
// they're fixed en masse.

// Create a binomial vector of sorted lists, visiting uses one at a time and
// merging lists as necessary.
const unsigned MaxSlots = 32;
Use *Slots[MaxSlots];

// Collect the first use, turning it into a single-item list.
Use *Next = UseList->Next;
UseList->Next = nullptr;
unsigned NumSlots = 1;
Slots[0] = UseList;

// Collect all but the last use.
while (Next->Next) {
  Use *Current = Next;
  Next = Current->Next;

  // Turn Current into a single-item list.
  Current->Next = nullptr;

  // Save Current in the first available slot, merging on collisions.
  unsigned I;
  for (I = 0; I < NumSlots; ++I) {
    if (!Slots[I])
      break;

    // Merge two lists, doubling the size of Current and emptying slot I.
    //
    // Since the uses in Slots[I] originally preceded those in Current, send
    // Slots[I] in as the left parameter to maintain a stable sort.
    Current = mergeUseLists(Slots[I], Current, Cmp);
    Slots[I] = nullptr;
  }
  // Check if this is a new slot.
  if (I == NumSlots) {
    ++NumSlots;
    assert(NumSlots <= MaxSlots && "Use list bigger than 2^32")((void)0);
  }

  // Found an open slot.
  Slots[I] = Current;
}

// Merge all the lists together.
assert(Next && "Expected one more Use")((void)0);
assert(!Next->Next && "Expected only one Use")((void)0);
UseList = Next;
for (unsigned I = 0; I < NumSlots; ++I)
  if (Slots[I])
    // Since the uses in Slots[I] originally preceded those in UseList, send
    // Slots[I] in as the left parameter to maintain a stable sort.
    UseList = mergeUseLists(Slots[I], UseList, Cmp);

// Fix the Prev pointers.
for (Use *I = UseList, **Prev = &UseList; I; I = I->Next) {
  I->Prev = Prev;
  Prev = &I->Next;
}
941}

943// isa - Provide some specializations of isa so that we don't have to include
944// the subtype header files to test to see if the value is a subclass...
945//
946template <> struct isa_impl<Constant, Value> {
static inline bool doit(const Value &Val) {
  static_assert(Value::ConstantFirstVal == 0, "Val.getValueID() >= Value::ConstantFirstVal");
  return Val.getValueID() <= Value::ConstantLastVal;
}
951};

953template <> struct isa_impl<ConstantData, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() >= Value::ConstantDataFirstVal &&
         Val.getValueID() <= Value::ConstantDataLastVal;
}
958};

960template <> struct isa_impl<ConstantAggregate, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() >= Value::ConstantAggregateFirstVal &&
         Val.getValueID() <= Value::ConstantAggregateLastVal;
}
965};

967template <> struct isa_impl<Argument, Value> {
static inline bool doit (const Value &Val) {
  return Val.getValueID() == Value::ArgumentVal;
}
971};

973template <> struct isa_impl<InlineAsm, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::InlineAsmVal;
}
977};

979template <> struct isa_impl<Instruction, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() >= Value::InstructionVal;
}
983};

985template <> struct isa_impl<BasicBlock, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::BasicBlockVal;
}
989};

991template <> struct isa_impl<Function, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::FunctionVal;
}
995};

997template <> struct isa_impl<GlobalVariable, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::GlobalVariableVal;
}
1001};

1003template <> struct isa_impl<GlobalAlias, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::GlobalAliasVal;
}
1007};

1009template <> struct isa_impl<GlobalIFunc, Value> {
static inline bool doit(const Value &Val) {
  return Val.getValueID() == Value::GlobalIFuncVal;
}
1013};

1015template <> struct isa_impl<GlobalIndirectSymbol, Value> {
static inline bool doit(const Value &Val) {
  return isa<GlobalAlias>(Val) || isa<GlobalIFunc>(Val);
}
1019};

1021template <> struct isa_impl<GlobalValue, Value> {
static inline bool doit(const Value &Val) {
  return isa<GlobalObject>(Val) || isa<GlobalIndirectSymbol>(Val);
}
1025};

1027template <> struct isa_impl<GlobalObject, Value> {
static inline bool doit(const Value &Val) {
  return isa<GlobalVariable>(Val) || isa<Function>(Val);
}
1031};

1033// Create wrappers for C Binding types (see CBindingWrapping.h).
1034DEFINE_ISA_CONVERSION_FUNCTIONS(Value, LLVMValueRef)inline Value *unwrap(LLVMValueRef P) { return reinterpret_cast
<Value*>(P); } inline LLVMValueRef wrap(const Value *P)
 { return reinterpret_cast<LLVMValueRef>(const_cast<
Value*>(P)); } template<typename T> inline T *unwrap
(LLVMValueRef P) { return cast<T>(unwrap(P)); }

1036// Specialized opaque value conversions.
1037inline Value **unwrap(LLVMValueRef *Vals) {
return reinterpret_cast<Value**>(Vals);
1039}

1041template<typename T>
1042inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
1043#ifndef NDEBUG1
for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
  unwrap<T>(*I); // For side effect of calling assert on invalid usage.
1046#endif
(void)Length;
return reinterpret_cast<T**>(Vals);
1049}

1051inline LLVMValueRef *wrap(const Value **Vals) {
return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
1053}

1055} // end namespace llvm

1057#endif // LLVM_IR_VALUE_H

←

/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ADT/ilist_iterator.h

1//===- llvm/ADT/ilist_iterator.h - Intrusive List Iterator ------*- 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//===----------------------------------------------------------------------===//

9#ifndef LLVM_ADT_ILIST_ITERATOR_H
10#define LLVM_ADT_ILIST_ITERATOR_H

12#include "llvm/ADT/ilist_node.h"
13#include <cassert>
14#include <cstddef>
15#include <iterator>
16#include <type_traits>

18namespace llvm {

20namespace ilist_detail {

22/// Find const-correct node types.
23template <class OptionsT, bool IsConst> struct IteratorTraits;
24template <class OptionsT> struct IteratorTraits<OptionsT, false> {
using value_type = typename OptionsT::value_type;
using pointer = typename OptionsT::pointer;
using reference = typename OptionsT::reference;
using node_pointer = ilist_node_impl<OptionsT> *;
using node_reference = ilist_node_impl<OptionsT> &;
30};
31template <class OptionsT> struct IteratorTraits<OptionsT, true> {
using value_type = const typename OptionsT::value_type;
using pointer = typename OptionsT::const_pointer;
using reference = typename OptionsT::const_reference;
using node_pointer = const ilist_node_impl<OptionsT> *;
using node_reference = const ilist_node_impl<OptionsT> &;
37};

39template <bool IsReverse> struct IteratorHelper;
40template <> struct IteratorHelper<false> : ilist_detail::NodeAccess {
using Access = ilist_detail::NodeAccess;

template <class T> static void increment(T *&I) { I = Access::getNext(*I); }
template <class T> static void decrement(T *&I) { I = Access::getPrev(*I); }
45};
46template <> struct IteratorHelper<true> : ilist_detail::NodeAccess {
using Access = ilist_detail::NodeAccess;

template <class T> static void increment(T *&I) { I = Access::getPrev(*I); }
template <class T> static void decrement(T *&I) { I = Access::getNext(*I); }
51};

53} // end namespace ilist_detail

55/// Iterator for intrusive lists  based on ilist_node.
56template <class OptionsT, bool IsReverse, bool IsConst>
57class ilist_iterator : ilist_detail::SpecificNodeAccess<OptionsT> {
friend ilist_iterator<OptionsT, IsReverse, !IsConst>;
friend ilist_iterator<OptionsT, !IsReverse, IsConst>;
friend ilist_iterator<OptionsT, !IsReverse, !IsConst>;

using Traits = ilist_detail::IteratorTraits<OptionsT, IsConst>;
using Access = ilist_detail::SpecificNodeAccess<OptionsT>;

65public:
using value_type = typename Traits::value_type;
using pointer = typename Traits::pointer;
using reference = typename Traits::reference;
using difference_type = ptrdiff_t;
using iterator_category = std::bidirectional_iterator_tag;
using const_pointer = typename OptionsT::const_pointer;
using const_reference = typename OptionsT::const_reference;

74private:
using node_pointer = typename Traits::node_pointer;
using node_reference = typename Traits::node_reference;

node_pointer NodePtr = nullptr;

80public:
/// Create from an ilist_node.
explicit ilist_iterator(node_reference N) : NodePtr(&N) {}

explicit ilist_iterator(pointer NP) : NodePtr(Access::getNodePtr(NP)) {}
explicit ilist_iterator(reference NR) : NodePtr(Access::getNodePtr(&NR)) {}
ilist_iterator() = default;

// This is templated so that we can allow constructing a const iterator from
// a nonconst iterator...
template <bool RHSIsConst>
ilist_iterator(const ilist_iterator<OptionsT, IsReverse, RHSIsConst> &RHS,
               std::enable_if_t<IsConst || !RHSIsConst, void *> = nullptr)
    : NodePtr(RHS.NodePtr) {}

// This is templated so that we can allow assigning to a const iterator from
// a nonconst iterator...
template <bool RHSIsConst>
std::enable_if_t<IsConst || !RHSIsConst, ilist_iterator &>
operator=(const ilist_iterator<OptionsT, IsReverse, RHSIsConst> &RHS) {
  NodePtr = RHS.NodePtr;
  return *this;
}

/// Explicit conversion between forward/reverse iterators.
///
/// Translate between forward and reverse iterators without changing range
/// boundaries.  The resulting iterator will dereference (and have a handle)
/// to the previous node, which is somewhat unexpected; but converting the
/// two endpoints in a range will give the same range in reverse.
///
/// This matches std::reverse_iterator conversions.
explicit ilist_iterator(
    const ilist_iterator<OptionsT, !IsReverse, IsConst> &RHS)
    : ilist_iterator(++RHS.getReverse()) {}

/// Get a reverse iterator to the same node.
///
/// Gives a reverse iterator that will dereference (and have a handle) to the
/// same node.  Converting the endpoint iterators in a range will give a
/// different range; for range operations, use the explicit conversions.
ilist_iterator<OptionsT, !IsReverse, IsConst> getReverse() const {
  if (NodePtr)
    return ilist_iterator<OptionsT, !IsReverse, IsConst>(*NodePtr);
  return ilist_iterator<OptionsT, !IsReverse, IsConst>();
}

/// Const-cast.
ilist_iterator<OptionsT, IsReverse, false> getNonConst() const {
  if (NodePtr)
    return ilist_iterator<OptionsT, IsReverse, false>(
        const_cast<typename ilist_iterator<OptionsT, IsReverse,
                                           false>::node_reference>(*NodePtr));
  return ilist_iterator<OptionsT, IsReverse, false>();
}

// Accessors...
reference operator*() const {
  assert(!NodePtr->isKnownSentinel())((void)0);
  return *Access::getValuePtr(NodePtr);
}
pointer operator->() const { return &operator*(); }

// Comparison operators
friend bool operator==(const ilist_iterator &LHS, const ilist_iterator &RHS) {
  return LHS.NodePtr == RHS.NodePtr;
}
friend bool operator!=(const ilist_iterator &LHS, const ilist_iterator &RHS) {
  return LHS.NodePtr != RHS.NodePtr;
26
←
Assuming 'LHS.NodePtr' is not equal to 'RHS.NodePtr'→
27
←
Returning the value 1, which participates in a condition later→
39
←
Assuming 'LHS.NodePtr' is not equal to 'RHS.NodePtr'→
40
←
Returning the value 1, which participates in a condition later→
}

// Increment and decrement operators...
ilist_iterator &operator--() {
  NodePtr = IsReverse ? NodePtr->getNext() : NodePtr->getPrev();
  return *this;
}
ilist_iterator &operator++() {
  NodePtr = IsReverse ? NodePtr->getPrev() : NodePtr->getNext();
  return *this;
}
ilist_iterator operator--(int) {
  ilist_iterator tmp = *this;
  --*this;
  return tmp;
}
ilist_iterator operator++(int) {
  ilist_iterator tmp = *this;
  ++*this;
  return tmp;
}

/// Get the underlying ilist_node.
node_pointer getNodePtr() const { return static_cast<node_pointer>(NodePtr); }

/// Check for end.  Only valid if ilist_sentinel_tracking<true>.
bool isEnd() const { return NodePtr ? NodePtr->isSentinel() : false; }
176};

178template <typename From> struct simplify_type;

180/// Allow ilist_iterators to convert into pointers to a node automatically when
181/// used by the dyn_cast, cast, isa mechanisms...
182///
183/// FIXME: remove this, since there is no implicit conversion to NodeTy.
184template <class OptionsT, bool IsConst>
185struct simplify_type<ilist_iterator<OptionsT, false, IsConst>> {
using iterator = ilist_iterator<OptionsT, false, IsConst>;
using SimpleType = typename iterator::pointer;

static SimpleType getSimplifiedValue(const iterator &Node) { return &*Node; }
190};
191template <class OptionsT, bool IsConst>
192struct simplify_type<const ilist_iterator<OptionsT, false, IsConst>>
  : simplify_type<ilist_iterator<OptionsT, false, IsConst>> {};

195} // end namespace llvm

197#endif // LLVM_ADT_ILIST_ITERATOR_H