1//===---- BDCE.cpp - Bit-tracking dead code elimination -------------------===//
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
7//===----------------------------------------------------------------------===//
9// This file implements the Bit-Tracking Dead Code Elimination pass. Some
10// instructions (shifts, some ands, ors, etc.) kill some of their input bits.
11// We track these dead bits and remove instructions that compute only these
12// dead bits. We also simplify sext that generates unused extension bits,
13// converting it to a zext.
15//===----------------------------------------------------------------------===//
34 #define DEBUG_TYPE "bdce"
36 STATISTIC(NumRemoved,
"Number of instructions removed (unused)");
37 STATISTIC(NumSimplified,
"Number of instructions trivialized (dead bits)");
39 "Number of sign extension instructions converted to zero extension");
41/// If an instruction is trivialized (dead), then the chain of users of that
42/// instruction may need to be cleared of assumptions that can no longer be
43/// guaranteed correct.
45 assert(
I->getType()->isIntOrIntVectorTy() &&
46 "Trivializing a non-integer value?");
48 // If all bits of a user are demanded, then we know that nothing below that
49 // in the def-use chain needs to be changed.
50 if (DB.getDemandedBits(
I).isAllOnes())
53 // Initialize the worklist with eligible direct users.
56 for (
User *JU :
I->users()) {
58 if (J->getType()->isIntOrIntVectorTy()) {
63 // Note that we need to check for non-int types above before asking for
64 // demanded bits. Normally, the only way to reach an instruction with an
65 // non-int type is via an instruction that has side effects (or otherwise
66 // will demand its input bits). However, if we have a readnone function
67 // that returns an unsized type (e.g., void), we must avoid asking for the
68 // demanded bits of the function call's return value. A void-returning
69 // readnone function is always dead (and so we can stop walking the use/def
70 // chain here), but the check is necessary to avoid asserting.
73 // DFS through subsequent users while tracking visits to avoid cycles.
74 while (!WorkList.
empty()) {
77 // NSW, NUW, and exact are based on operands that might have changed.
80 // We do not have to worry about llvm.assume, because it demands its
81 // operand, so trivializing can't change it.
83 // If all bits of a user are demanded, then we know that nothing below
84 // that in the def-use chain needs to be changed.
85 if (DB.getDemandedBits(J).isAllOnes())
90 if (Visited.
insert(K).second && K->getType()->isIntOrIntVectorTy())
100 // If the instruction has side effects and no non-dbg uses,
101 // skip it. This way we avoid computing known bits on an instruction
102 // that will not help us.
103 if (
I.mayHaveSideEffects() &&
I.use_empty())
106 // Remove instructions that are dead, either because they were not reached
107 // during analysis or have no demanded bits.
108 if (DB.isInstructionDead(&
I) ||
109 (
I.getType()->isIntOrIntVectorTy() && DB.getDemandedBits(&
I).isZero() &&
116 // Convert SExt into ZExt if none of the extension bits is required
118 APInt Demanded = DB.getDemandedBits(SE);
119 const uint32_t SrcBitSize = SE->getSrcTy()->getScalarSizeInBits();
120 auto *
const DstTy = SE->getDestTy();
121 const uint32_t DestBitSize = DstTy->getScalarSizeInBits();
122 if (Demanded.
countl_zero() >= (DestBitSize - SrcBitSize)) {
125 I.replaceAllUsesWith(
126 Builder.CreateZExt(SE->getOperand(0), DstTy, SE->getName()));
134 // Simplify and, or, xor when their mask does not affect the demanded bits.
136 APInt Demanded = DB.getDemandedBits(BO);
140 bool CanBeSimplified =
false;
141 switch (BO->getOpcode()) {
142 case Instruction::Or:
143 case Instruction::Xor:
144 CanBeSimplified = !Demanded.
intersects(*Mask);
146 case Instruction::And:
150 // TODO: Handle more cases here.
154 if (CanBeSimplified) {
156 BO->replaceAllUsesWith(BO->getOperand(0));
166 for (
Use &U :
I.operands()) {
167 // DemandedBits only detects dead integer uses.
168 if (!U->getType()->isIntOrIntVectorTy())
174 if (!DB.isUseDead(&U))
177 LLVM_DEBUG(
dbgs() <<
"BDCE: Trivializing: " << U <<
" (all bits dead)\n");
181 // Substitute all uses with zero. In theory we could use `freeze poison`
182 // instead, but that seems unlikely to be profitable.
183 U.set(ConstantInt::get(U->getType(), 0));
191 I->dropAllReferences();
196 I->eraseFromParent();
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
Expand Atomic instructions
static void clearAssumptionsOfUsers(Instruction *I, DemandedBits &DB)
If an instruction is trivialized (dead), then the chain of users of that instruction may need to be c...
static bool bitTrackingDCE(Function &F, DemandedBits &DB)
This is the interface for a simple mod/ref and alias analysis over globals.
This file defines the SmallPtrSet class.
This file defines the SmallVector class.
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
Class for arbitrary precision integers.
bool isAllOnes() const
Determine if all bits are set. This is true for zero-width values.
bool intersects(const APInt &RHS) const
This operation tests if there are any pairs of corresponding bits between this APInt and RHS that are...
unsigned countl_zero() const
The APInt version of std::countl_zero.
bool isSubsetOf(const APInt &RHS) const
This operation checks that all bits set in this APInt are also set in RHS.
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Represents analyses that only rely on functions' control flow.
An analysis that produces DemandedBits for a function.
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
void dropPoisonGeneratingAnnotations()
Drops flags, return attributes and metadata that may generate poison.
A set of analyses that are preserved following a run of a transformation pass.
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
PreservedAnalyses & preserveSet()
Mark an analysis set as preserved.
This class represents a sign extension of integer types.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
A Use represents the edge between a Value definition and its users.
iterator_range< user_iterator > users()
ap_match< APInt > m_APInt(const APInt *&Res)
Match a ConstantInt or splatted ConstantVector, binding the specified pointer to the contained APInt.
bool match(Val *V, const Pattern &P)
This is an optimization pass for GlobalISel generic memory operations.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
LLVM_ABI void salvageDebugInfo(const MachineRegisterInfo &MRI, MachineInstr &MI)
Assuming the instruction MI is going to be deleted, attempt to salvage debug users of MI by writing t...
auto reverse(ContainerTy &&C)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
LLVM_ABI bool wouldInstructionBeTriviallyDead(const Instruction *I, const TargetLibraryInfo *TLI=nullptr)
Return true if the result produced by the instruction would have no side effects if it was not used.
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)