maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[Remarks] Make memsize remarks report as an analysis, not a missed opportunity. 

Differential revision: https://reviews.llvm.org/D104078
This commit is contained in:
Jon Roelofs 2021-06-10 16:48:45 -07:00
parent a0d96fdd3a
commit 493d6928fe
4 changed files with 74 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
llvm/include/llvm/Transforms/Utils/MemoryOpRemark.h
View File

@ -17,6 +17,7 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/IR/DiagnosticInfo.h"
namespace llvm {
@ -28,6 +29,7 @@ class IntrinsicInst;
class Value;
class OptimizationRemarkEmitter;
class OptimizationRemarkMissed;
class OptimizationRemarkAnalysis;
class StoreInst;
// FIXME: Once we get to more remarks like this one, we need to re-evaluate how
@ -50,12 +52,17 @@ struct MemoryOpRemark {
void visit(const Instruction *I);
protected:
virtual std::string explainSource(StringRef Type);
virtual std::string explainSource(StringRef Type) const;
enum RemarkKind { RK_Store, RK_Unknown, RK_IntrinsicCall, RK_Call };
virtual StringRef remarkName(RemarkKind RK);
virtual StringRef remarkName(RemarkKind RK) const;
virtual DiagnosticKind diagnosticKind() const { return DK_OptimizationRemarkAnalysis; }
private:
template<typename ...Ts>
std::unique_ptr<DiagnosticInfoIROptimization> makeRemark(Ts... Args);
/// Emit a remark using information from the store's destination, size, etc.
void visitStore(const StoreInst &SI);
/// Emit a generic auto-init remark.
@ -68,13 +75,13 @@ private:
/// Add callee information to a remark: whether it's known, the function name,
/// etc.
template <typename FTy>
void visitCallee(FTy F, bool KnownLibCall, OptimizationRemarkMissed &R);
void visitCallee(FTy F, bool KnownLibCall, DiagnosticInfoIROptimization &R);
/// Add operand information to a remark based on knowledge we have for known
/// libcalls.
void visitKnownLibCall(const CallInst &CI, LibFunc LF,
OptimizationRemarkMissed &R);
DiagnosticInfoIROptimization &R);
/// Add the memory operation size to a remark.
void visitSizeOperand(Value *V, OptimizationRemarkMissed &R);
void visitSizeOperand(Value *V, DiagnosticInfoIROptimization &R);
struct VariableInfo {
Optional<StringRef> Name;
@ -84,7 +91,7 @@ private:
/// Gather more information about \p V as a variable. This can be debug info,
/// information from the alloca, etc. Since \p V can represent more than a
/// single variable, they will all be added to the remark.
void visitPtr(Value *V, bool IsSrc, OptimizationRemarkMissed &R);
void visitPtr(Value *V, bool IsSrc, DiagnosticInfoIROptimization &R);
void visitVariable(const Value *V, SmallVectorImpl<VariableInfo> &Result);
};
@ -98,8 +105,11 @@ struct AutoInitRemark : public MemoryOpRemark {
static bool canHandle(const Instruction *I);
protected:
virtual std::string explainSource(StringRef Type) override;
virtual StringRef remarkName(RemarkKind RK) override;
virtual std::string explainSource(StringRef Type) const override;
virtual StringRef remarkName(RemarkKind RK) const override;
virtual DiagnosticKind diagnosticKind() const override {
return DK_OptimizationRemarkMissed;
}
};
} // namespace llvm

4
llvm/lib/CodeGen/GlobalISel/IRTranslator.cpp
View File

@ -1824,7 +1824,7 @@ bool IRTranslator::translateKnownIntrinsic(const CallInst &CI, Intrinsic::ID ID,
const Function &F = *MI->getParent()->getParent();
auto &TLI = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F);
if (MemoryOpRemark::canHandle(MI, TLI)) {
MemoryOpRemark R(*ORE, "memsize", *DL, TLI);
MemoryOpRemark R(*ORE, "gisel-irtranslator-memsize", *DL, TLI);
R.visit(MI);
}
}
@ -2263,7 +2263,7 @@ bool IRTranslator::translateCallBase(const CallBase &CB,
const Function &F = *CI->getParent()->getParent();
auto &TLI = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F);
if (MemoryOpRemark::canHandle(CI, TLI)) {
MemoryOpRemark R(*ORE, "memsize", *DL, TLI);
MemoryOpRemark R(*ORE, "gisel-irtranslator-memsize", *DL, TLI);
R.visit(CI);
}
}

74
llvm/lib/Transforms/Utils/MemoryOpRemark.cpp
View File

@ -105,11 +105,11 @@ void MemoryOpRemark::visit(const Instruction *I) {
visitUnknown(*I);
}
std::string MemoryOpRemark::explainSource(StringRef Type) {
std::string MemoryOpRemark::explainSource(StringRef Type) const {
return (Type + ".").str();
}
StringRef MemoryOpRemark::remarkName(RemarkKind RK) {
StringRef MemoryOpRemark::remarkName(RemarkKind RK) const {
switch (RK) {
case RK_Store:
return "MemoryOpStore";
@ -125,7 +125,7 @@ StringRef MemoryOpRemark::remarkName(RemarkKind RK) {
static void inlineVolatileOrAtomicWithExtraArgs(bool *Inline, bool Volatile,
bool Atomic,
OptimizationRemarkMissed &R) {
DiagnosticInfoIROptimization &R) {
if (Inline && *Inline)
R << " Inlined: " << NV("StoreInlined", true) << ".";
if (Volatile)
@ -150,23 +150,36 @@ static Optional<uint64_t> getSizeInBytes(Optional<uint64_t> SizeInBits) {
return *SizeInBits / 8;
}
template<typename ...Ts>
std::unique_ptr<DiagnosticInfoIROptimization>
MemoryOpRemark::makeRemark(Ts... Args) {
switch (diagnosticKind()) {
case DK_OptimizationRemarkAnalysis:
return std::make_unique<OptimizationRemarkAnalysis>(Args...);
case DK_OptimizationRemarkMissed:
return std::make_unique<OptimizationRemarkMissed>(Args...);
default:
llvm_unreachable("unexpected DiagnosticKind");
}
}
void MemoryOpRemark::visitStore(const StoreInst &SI) {
bool Volatile = SI.isVolatile();
bool Atomic = SI.isAtomic();
int64_t Size = DL.getTypeStoreSize(SI.getOperand(0)->getType());
OptimizationRemarkMissed R(RemarkPass.data(), remarkName(RK_Store), &SI);
R << explainSource("Store") << "\nStore size: " << NV("StoreSize", Size)
<< " bytes.";
visitPtr(SI.getOperand(1), /*IsRead=*/false, R);
inlineVolatileOrAtomicWithExtraArgs(nullptr, Volatile, Atomic, R);
ORE.emit(R);
auto R = makeRemark(RemarkPass.data(), remarkName(RK_Store), &SI);
*R << explainSource("Store") << "\nStore size: " << NV("StoreSize", Size)
<< " bytes.";
visitPtr(SI.getOperand(1), /*IsRead=*/false, *R);
inlineVolatileOrAtomicWithExtraArgs(nullptr, Volatile, Atomic, *R);
ORE.emit(*R);
}
void MemoryOpRemark::visitUnknown(const Instruction &I) {
OptimizationRemarkMissed R(RemarkPass.data(), remarkName(RK_Unknown), &I);
R << explainSource("Initialization");
ORE.emit(R);
auto R = makeRemark(RemarkPass.data(), remarkName(RK_Unknown), &I);
*R << explainSource("Initialization");
ORE.emit(*R);
}
void MemoryOpRemark::visitIntrinsicCall(const IntrinsicInst &II) {
@ -203,10 +216,9 @@ void MemoryOpRemark::visitIntrinsicCall(const IntrinsicInst &II) {
return visitUnknown(II);
}
OptimizationRemarkMissed R(RemarkPass.data(), remarkName(RK_IntrinsicCall),
&II);
visitCallee(StringRef(CallTo), /*KnownLibCall=*/true, R);
visitSizeOperand(II.getOperand(2), R);
auto R = makeRemark(RemarkPass.data(), remarkName(RK_IntrinsicCall), &II);
visitCallee(StringRef(CallTo), /*KnownLibCall=*/true, *R);
visitSizeOperand(II.getOperand(2), *R);
auto *CIVolatile = dyn_cast<ConstantInt>(II.getOperand(3));
// No such thing as a memory intrinsic that is both atomic and volatile.
@ -216,16 +228,16 @@ void MemoryOpRemark::visitIntrinsicCall(const IntrinsicInst &II) {
case Intrinsic::memcpy:
case Intrinsic::memmove:
case Intrinsic::memcpy_element_unordered_atomic:
visitPtr(II.getOperand(1), /*IsRead=*/true, R);
visitPtr(II.getOperand(0), /*IsRead=*/false, R);
visitPtr(II.getOperand(1), /*IsRead=*/true, *R);
visitPtr(II.getOperand(0), /*IsRead=*/false, *R);
break;
case Intrinsic::memset:
case Intrinsic::memset_element_unordered_atomic:
visitPtr(II.getOperand(0), /*IsRead=*/false, R);
visitPtr(II.getOperand(0), /*IsRead=*/false, *R);
break;
}
inlineVolatileOrAtomicWithExtraArgs(&Inline, Volatile, Atomic, R);
ORE.emit(R);
inlineVolatileOrAtomicWithExtraArgs(&Inline, Volatile, Atomic, *R);
ORE.emit(*R);
}
void MemoryOpRemark::visitCall(const CallInst &CI) {
@ -235,15 +247,15 @@ void MemoryOpRemark::visitCall(const CallInst &CI) {
LibFunc LF;
bool KnownLibCall = TLI.getLibFunc(*F, LF) && TLI.has(LF);
OptimizationRemarkMissed R(RemarkPass.data(), remarkName(RK_Call), &CI);
visitCallee(F, KnownLibCall, R);
visitKnownLibCall(CI, LF, R);
ORE.emit(R);
auto R = makeRemark(RemarkPass.data(), remarkName(RK_Call), &CI);
visitCallee(F, KnownLibCall, *R);
visitKnownLibCall(CI, LF, *R);
ORE.emit(*R);
}
template <typename FTy>
void MemoryOpRemark::visitCallee(FTy F, bool KnownLibCall,
OptimizationRemarkMissed &R) {
DiagnosticInfoIROptimization &R) {
R << "Call to ";
if (!KnownLibCall)
R << NV("UnknownLibCall", "unknown") << " function ";
@ -251,7 +263,7 @@ void MemoryOpRemark::visitCallee(FTy F, bool KnownLibCall,
}
void MemoryOpRemark::visitKnownLibCall(const CallInst &CI, LibFunc LF,
OptimizationRemarkMissed &R) {
DiagnosticInfoIROptimization &R) {
switch (LF) {
default:
return;
@ -278,7 +290,7 @@ void MemoryOpRemark::visitKnownLibCall(const CallInst &CI, LibFunc LF,
}
}
void MemoryOpRemark::visitSizeOperand(Value *V, OptimizationRemarkMissed &R) {
void MemoryOpRemark::visitSizeOperand(Value *V, DiagnosticInfoIROptimization &R) {
if (auto *Len = dyn_cast<ConstantInt>(V)) {
uint64_t Size = Len->getZExtValue();
R << " Memory operation size: " << NV("StoreSize", Size) << " bytes.";
@ -335,7 +347,7 @@ void MemoryOpRemark::visitVariable(const Value *V,
Result.push_back(std::move(Var));
}
void MemoryOpRemark::visitPtr(Value *Ptr, bool IsRead, OptimizationRemarkMissed &R) {
void MemoryOpRemark::visitPtr(Value *Ptr, bool IsRead, DiagnosticInfoIROptimization &R) {
// Find if Ptr is a known variable we can give more information on.
SmallVector<Value *, 2> Objects;
getUnderlyingObjectsForCodeGen(Ptr, Objects);
@ -377,11 +389,11 @@ bool AutoInitRemark::canHandle(const Instruction *I) {
});
}
std::string AutoInitRemark::explainSource(StringRef Type) {
std::string AutoInitRemark::explainSource(StringRef Type) const {
return (Type + " inserted by -ftrivial-auto-var-init.").str();
}
StringRef AutoInitRemark::remarkName(RemarkKind RK) {
StringRef AutoInitRemark::remarkName(RemarkKind RK) const {
switch (RK) {
case RK_Store:
return "AutoInitStore";

22
llvm/test/CodeGen/AArch64/memsize-remarks.ll
View File

@ -1,4 +1,4 @@
; RUN: llc %s -pass-remarks-missed=memsize -pass-remarks-output=%t.opt.yaml -pass-remarks-filter=memsize -global-isel -o /dev/null 2>&1 | FileCheck %s --check-prefix=GISEL --implicit-check-not=GISEL
; RUN: llc %s -pass-remarks-analysis=gisel-irtranslator-memsize -pass-remarks-output=%t.opt.yaml -pass-remarks-filter=gisel-irtranslator-memsize -global-isel -o /dev/null 2>&1 | FileCheck %s --check-prefix=GISEL --implicit-check-not=GISEL
; RUN: cat %t.opt.yaml | FileCheck -check-prefix=YAML %s
source_filename = "memsize.c"
@ -143,8 +143,8 @@ define void @known_call_with_dereferenceable_bytes(i8* dereferenceable(42) %dst,
; GISEL: Call to memset. Memory operation size: 1 bytes.
; GISEL-NOT: Read Variables:
; GISEL-NEXT: Written Variables: <unknown> (42 bytes).
; YAML: --- !Missed
; YAML: Pass: memsize
; YAML: --- !Analysis
; YAML: gisel-irtranslator-memsize
; YAML: Name: MemoryOpIntrinsicCall
; YAML-LABEL: Function: known_call_with_dereferenceable_bytes
; YAML-NEXT: Args:
@ -175,8 +175,8 @@ define void @known_call_with_dereferenceable_bytes(i8* dereferenceable(42) %dst,
; GISEL: Call to memcpy. Memory operation size: 1 bytes.
; GISEL-NEXT: Read Variables: <unknown> (314 bytes).
; GISEL-NEXT: Written Variables: <unknown> (42 bytes).
; YAML: --- !Missed
; YAML: Pass: memsize
; YAML: --- !Analysis
; YAML: gisel-irtranslator-memsize
; YAML: Name: MemoryOpIntrinsicCall
; YAML-LABEL: Function: known_call_with_dereferenceable_bytes
; YAML-NEXT: Args:
@ -213,8 +213,8 @@ define void @known_call_with_dereferenceable_bytes(i8* dereferenceable(42) %dst,
; GISEL: Call to memmove. Memory operation size: 1 bytes.
; GISEL-NEXT: Read Variables: <unknown> (314 bytes).
; GISEL-NEXT: Written Variables: <unknown> (42 bytes).
; YAML: --- !Missed
; YAML: Pass: memsize
; YAML: --- !Analysis
; YAML: gisel-irtranslator-memsize
; YAML: Name: MemoryOpIntrinsicCall
; YAML-LABEL: Function: known_call_with_dereferenceable_bytes
; YAML-NEXT: Args:
@ -251,8 +251,8 @@ define void @known_call_with_dereferenceable_bytes(i8* dereferenceable(42) %dst,
; GISEL: Call to bzero. Memory operation size: 1 bytes.
; GISEL-NOT: Read Variables:
; GISEL-NEXT: Written Variables: <unknown> (42 bytes).
; YAML: --- !Missed
; YAML: Pass: memsize
; YAML: --- !Analysis
; YAML: gisel-irtranslator-memsize
; YAML: Name: MemoryOpCall
; YAML-LABEL: Function: known_call_with_dereferenceable_bytes
; YAML-NEXT: Args:
@ -274,8 +274,8 @@ define void @known_call_with_dereferenceable_bytes(i8* dereferenceable(42) %dst,
; GISEL: Call to bcopy. Memory operation size: 1 bytes.
; GISEL-NEXT: Read Variables: <unknown> (314 bytes).
; GISEL-NEXT: Written Variables: <unknown> (42 bytes).
; YAML: --- !Missed
; YAML: Pass: memsize
; YAML: --- !Analysis
; YAML: gisel-irtranslator-memsize
; YAML: Name: MemoryOpCall
; YAML-LABEL: Function: known_call_with_dereferenceable_bytes
; YAML-NEXT: Args: