1//===- LowerAllowCheckPass.cpp ----------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/Transforms/Instrumentation/LowerAllowCheckPass.h"
10#include "InstrumentationOptions.h"
11
12#include "llvm/ADT/SmallVector.h"
13#include "llvm/ADT/Statistic.h"
14#include "llvm/ADT/StringExtras.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/Analysis/OptimizationRemarkEmitter.h"
17#include "llvm/Analysis/ProfileSummaryInfo.h"
18#include "llvm/IR/Constants.h"
19#include "llvm/IR/DiagnosticInfo.h"
20#include "llvm/IR/InstIterator.h"
21#include "llvm/IR/Instructions.h"
22#include "llvm/IR/IntrinsicInst.h"
23#include "llvm/IR/Intrinsics.h"
24#include "llvm/IR/Metadata.h"
25#include "llvm/IR/Module.h"
26#include "llvm/Support/Debug.h"
27#include "llvm/Support/RandomNumberGenerator.h"
28#include <memory>
29#include <optional>
30#include <random>
31
32using namespace llvm;
33
34#define DEBUG_TYPE "lower-allow-check"
35
36STATISTIC(NumChecksTotal, "Number of checks");
37STATISTIC(NumChecksRemoved, "Number of removed checks");
38
39struct RemarkInfo {
40 ore::NV Kind;
41 ore::NV F;
42 ore::NV BB;
43 explicit RemarkInfo(IntrinsicInst *II)
44 : Kind("Kind", II->getArgOperand(i: 0)),
45 F("Function", II->getParent()->getParent()),
46 BB("Block", II->getParent()->getName()) {}
47};
48
49static void emitRemark(IntrinsicInst *II, OptimizationRemarkEmitter &ORE,
50 bool Removed) {
51 if (Removed) {
52 ORE.emit(RemarkBuilder: [&]() {
53 RemarkInfo Info(II);
54 return OptimizationRemark(DEBUG_TYPE, "Removed", II)
55 << "Removed check: Kind=" << Info.Kind << " F=" << Info.F
56 << " BB=" << Info.BB;
57 });
58 } else {
59 ORE.emit(RemarkBuilder: [&]() {
60 RemarkInfo Info(II);
61 return OptimizationRemarkMissed(DEBUG_TYPE, "Allowed", II)
62 << "Allowed check: Kind=" << Info.Kind << " F=" << Info.F
63 << " BB=" << Info.BB;
64 });
65 }
66}
67
68static bool lowerAllowChecks(Function &F, FunctionAnalysisManager &AM,
69 const LowerAllowCheckPass::Options &Opts) {
70 const InstrumentationOptions &CLOpts = getInstrumentationOptions(F);
71 // Lazy analysis getters.
72 auto GetBFI = [&AM, &F, BFI = (BlockFrequencyInfo *)nullptr]() mutable
73 -> const BlockFrequencyInfo & {
74 if (!BFI)
75 BFI = &AM.getResult<BlockFrequencyAnalysis>(IR&: F);
76 return *BFI;
77 };
78 auto GetPSI = [&AM, &F, PSI = std::optional<ProfileSummaryInfo *>()]() mutable
79 -> const ProfileSummaryInfo * {
80 if (!PSI.has_value()) {
81 auto &MAMProxy = AM.getResult<ModuleAnalysisManagerFunctionProxy>(IR&: F);
82 PSI = MAMProxy.getCachedResult<ProfileSummaryAnalysis>(IR&: *F.getParent());
83 }
84 return *PSI;
85 };
86 auto GetORE = [&AM, &F, ORE = (OptimizationRemarkEmitter *)nullptr]() mutable
87 -> OptimizationRemarkEmitter & {
88 if (!ORE)
89 ORE = &AM.getResult<OptimizationRemarkEmitterAnalysis>(IR&: F);
90 return *ORE;
91 };
92
93 // List of intrinsics and the constant value they should be lowered to.
94 SmallVector<std::pair<IntrinsicInst *, bool>, 16> ReplaceWithValue;
95 std::unique_ptr<RandomNumberGenerator> Rng;
96
97 auto GetRng = [&]() -> RandomNumberGenerator & {
98 if (!Rng)
99 Rng = F.getParent()->createRNG(Name: F.getName());
100 return *Rng;
101 };
102
103 auto GetCutoff = [&](const IntrinsicInst *II) -> unsigned {
104 if (CLOpts.lower_allow_check_percentile_cutoff_hot)
105 return *CLOpts.lower_allow_check_percentile_cutoff_hot;
106 else if (II->getIntrinsicID() == Intrinsic::allow_ubsan_check) {
107 auto *Kind = cast<ConstantInt>(Val: II->getArgOperand(i: 0));
108 if (Kind->getZExtValue() < Opts.cutoffs.size())
109 return Opts.cutoffs[Kind->getZExtValue()];
110 } else if (II->getIntrinsicID() == Intrinsic::allow_runtime_check) {
111 return Opts.runtime_check;
112 }
113
114 return 0;
115 };
116
117 auto ShouldRemoveHot = [&](const BasicBlock &BB, unsigned int cutoff) {
118 if (cutoff == 1000000)
119 return true;
120 const ProfileSummaryInfo *PSI = GetPSI();
121 return PSI && PSI->isHotCountNthPercentile(
122 PercentileCutoff: cutoff, C: GetBFI().getBlockProfileCount(BB: &BB).value_or(u: 0));
123 };
124
125 auto ShouldRemoveRandom = [&]() {
126 return CLOpts.lower_allow_check_random_rate &&
127 !std::bernoulli_distribution(*CLOpts.lower_allow_check_random_rate)(
128 GetRng());
129 };
130
131 auto ShouldRemove = [&](const IntrinsicInst *II) {
132 unsigned int cutoff = GetCutoff(II);
133 return ShouldRemoveRandom() || ShouldRemoveHot(*(II->getParent()), cutoff);
134 };
135
136 for (Instruction &I : instructions(F)) {
137 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Val: &I);
138 if (!II)
139 continue;
140 auto ID = II->getIntrinsicID();
141 switch (ID) {
142 case Intrinsic::allow_ubsan_check:
143 case Intrinsic::allow_runtime_check: {
144 bool ToRemove = ShouldRemove(II);
145
146 ReplaceWithValue.push_back(Elt: {
147 II,
148 !ToRemove,
149 });
150 emitRemark(II, ORE&: GetORE(), Removed: ToRemove);
151 break;
152 }
153 case Intrinsic::allow_sanitize_address:
154 ReplaceWithValue.push_back(
155 Elt: {II, F.hasFnAttribute(Kind: Attribute::SanitizeAddress)});
156 break;
157 case Intrinsic::allow_sanitize_thread:
158 ReplaceWithValue.push_back(
159 Elt: {II, F.hasFnAttribute(Kind: Attribute::SanitizeThread)});
160 break;
161 case Intrinsic::allow_sanitize_memory:
162 ReplaceWithValue.push_back(
163 Elt: {II, F.hasFnAttribute(Kind: Attribute::SanitizeMemory)});
164 break;
165 case Intrinsic::allow_sanitize_hwaddress:
166 ReplaceWithValue.push_back(
167 Elt: {II, F.hasFnAttribute(Kind: Attribute::SanitizeHWAddress)});
168 break;
169 default:
170 break;
171 }
172 }
173
174 for (auto [I, V] : ReplaceWithValue) {
175 ++NumChecksTotal;
176 if (!V) // If the final value is false, the check is considered removed.
177 ++NumChecksRemoved;
178 I->replaceAllUsesWith(V: ConstantInt::getBool(Ty: I->getType(), V));
179 I->eraseFromParent();
180 }
181
182 return !ReplaceWithValue.empty();
183}
184
185PreservedAnalyses LowerAllowCheckPass::run(Function &F,
186 FunctionAnalysisManager &AM) {
187 if (F.isDeclaration())
188 return PreservedAnalyses::all();
189
190 return lowerAllowChecks(F, AM, Opts)
191 // We do not change the CFG, we only replace the intrinsics with
192 // true or false.
193 ? PreservedAnalyses::none().preserveSet<CFGAnalyses>()
194 : PreservedAnalyses::all();
195}
196
197bool LowerAllowCheckPass::isRequested(
198 const cl::LibraryOptionsContext &LibraryOptions) {
199 const InstrumentationOptions &CLOpts =
200 LibraryOptions.get<InstrumentationOptions>();
201 return CLOpts.lower_allow_check_random_rate ||
202 CLOpts.lower_allow_check_percentile_cutoff_hot;
203}
204
205void LowerAllowCheckPass::printPipeline(
206 raw_ostream &OS, function_ref<StringRef(StringRef)> MapClassName2PassName) {
207 static_cast<PassInfoMixin<LowerAllowCheckPass> *>(this)->printPipeline(
208 OS, MapClassName2PassName);
209 OS << "<";
210
211 // Format is <cutoffs[0,1,2]=70000;cutoffs[5,6,8]=90000>
212 // but it's equally valid to specify
213 // cutoffs[0]=70000;cutoffs[1]=70000;cutoffs[2]=70000;cutoffs[5]=90000;...
214 // and that's what we do here. It is verbose but valid and easy to verify
215 // correctness.
216 // TODO: print shorter output by combining adjacent runs, etc.
217 int i = 0;
218 ListSeparator LS(";");
219 for (unsigned int cutoff : Opts.cutoffs) {
220 if (cutoff > 0)
221 OS << LS << "cutoffs[" << i << "]=" << cutoff;
222 i++;
223 }
224 if (Opts.runtime_check)
225 OS << LS << "runtime_check=" << Opts.runtime_check;
226
227 OS << '>';
228}
229