Bug Summary

File:lib/Transforms/IPO/MergeFunctions.cpp
Warning:line 714, column 23
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name MergeFunctions.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 -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-9/lib/clang/9.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-9~svn358520/build-llvm/lib/Transforms/IPO -I /build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO -I /build/llvm-toolchain-snapshot-9~svn358520/build-llvm/include -I /build/llvm-toolchain-snapshot-9~svn358520/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/9.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-9/lib/clang/9.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-9~svn358520/build-llvm/lib/Transforms/IPO -fdebug-prefix-map=/build/llvm-toolchain-snapshot-9~svn358520=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2019-04-17-050842-1547-1 -x c++ /build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp -faddrsig
1//===- MergeFunctions.cpp - Merge identical functions ---------------------===//
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 pass looks for equivalent functions that are mergable and folds them.
10//
11// Order relation is defined on set of functions. It was made through
12// special function comparison procedure that returns
13// 0 when functions are equal,
14// -1 when Left function is less than right function, and
15// 1 for opposite case. We need total-ordering, so we need to maintain
16// four properties on the functions set:
17// a <= a (reflexivity)
18// if a <= b and b <= a then a = b (antisymmetry)
19// if a <= b and b <= c then a <= c (transitivity).
20// for all a and b: a <= b or b <= a (totality).
21//
22// Comparison iterates through each instruction in each basic block.
23// Functions are kept on binary tree. For each new function F we perform
24// lookup in binary tree.
25// In practice it works the following way:
26// -- We define Function* container class with custom "operator<" (FunctionPtr).
27// -- "FunctionPtr" instances are stored in std::set collection, so every
28// std::set::insert operation will give you result in log(N) time.
29//
30// As an optimization, a hash of the function structure is calculated first, and
31// two functions are only compared if they have the same hash. This hash is
32// cheap to compute, and has the property that if function F == G according to
33// the comparison function, then hash(F) == hash(G). This consistency property
34// is critical to ensuring all possible merging opportunities are exploited.
35// Collisions in the hash affect the speed of the pass but not the correctness
36// or determinism of the resulting transformation.
37//
38// When a match is found the functions are folded. If both functions are
39// overridable, we move the functionality into a new internal function and
40// leave two overridable thunks to it.
41//
42//===----------------------------------------------------------------------===//
43//
44// Future work:
45//
46// * virtual functions.
47//
48// Many functions have their address taken by the virtual function table for
49// the object they belong to. However, as long as it's only used for a lookup
50// and call, this is irrelevant, and we'd like to fold such functions.
51//
52// * be smarter about bitcasts.
53//
54// In order to fold functions, we will sometimes add either bitcast instructions
55// or bitcast constant expressions. Unfortunately, this can confound further
56// analysis since the two functions differ where one has a bitcast and the
57// other doesn't. We should learn to look through bitcasts.
58//
59// * Compare complex types with pointer types inside.
60// * Compare cross-reference cases.
61// * Compare complex expressions.
62//
63// All the three issues above could be described as ability to prove that
64// fA == fB == fC == fE == fF == fG in example below:
65//
66// void fA() {
67// fB();
68// }
69// void fB() {
70// fA();
71// }
72//
73// void fE() {
74// fF();
75// }
76// void fF() {
77// fG();
78// }
79// void fG() {
80// fE();
81// }
82//
83// Simplest cross-reference case (fA <--> fB) was implemented in previous
84// versions of MergeFunctions, though it presented only in two function pairs
85// in test-suite (that counts >50k functions)
86// Though possibility to detect complex cross-referencing (e.g.: A->B->C->D->A)
87// could cover much more cases.
88//
89//===----------------------------------------------------------------------===//
90
91#include "llvm/ADT/ArrayRef.h"
92#include "llvm/ADT/SmallPtrSet.h"
93#include "llvm/ADT/SmallVector.h"
94#include "llvm/ADT/Statistic.h"
95#include "llvm/IR/Argument.h"
96#include "llvm/IR/Attributes.h"
97#include "llvm/IR/BasicBlock.h"
98#include "llvm/IR/CallSite.h"
99#include "llvm/IR/Constant.h"
100#include "llvm/IR/Constants.h"
101#include "llvm/IR/DebugInfoMetadata.h"
102#include "llvm/IR/DebugLoc.h"
103#include "llvm/IR/DerivedTypes.h"
104#include "llvm/IR/Function.h"
105#include "llvm/IR/GlobalValue.h"
106#include "llvm/IR/IRBuilder.h"
107#include "llvm/IR/InstrTypes.h"
108#include "llvm/IR/Instruction.h"
109#include "llvm/IR/Instructions.h"
110#include "llvm/IR/IntrinsicInst.h"
111#include "llvm/IR/Module.h"
112#include "llvm/IR/Type.h"
113#include "llvm/IR/Use.h"
114#include "llvm/IR/User.h"
115#include "llvm/IR/Value.h"
116#include "llvm/IR/ValueHandle.h"
117#include "llvm/IR/ValueMap.h"
118#include "llvm/Pass.h"
119#include "llvm/Support/Casting.h"
120#include "llvm/Support/CommandLine.h"
121#include "llvm/Support/Debug.h"
122#include "llvm/Support/raw_ostream.h"
123#include "llvm/Transforms/IPO.h"
124#include "llvm/Transforms/Utils/FunctionComparator.h"
125#include <algorithm>
126#include <cassert>
127#include <iterator>
128#include <set>
129#include <utility>
130#include <vector>
131
132using namespace llvm;
133
134#define DEBUG_TYPE"mergefunc" "mergefunc"
135
136STATISTIC(NumFunctionsMerged, "Number of functions merged")static llvm::Statistic NumFunctionsMerged = {"mergefunc", "NumFunctionsMerged"
, "Number of functions merged", {0}, {false}}
;
137STATISTIC(NumThunksWritten, "Number of thunks generated")static llvm::Statistic NumThunksWritten = {"mergefunc", "NumThunksWritten"
, "Number of thunks generated", {0}, {false}}
;
138STATISTIC(NumAliasesWritten, "Number of aliases generated")static llvm::Statistic NumAliasesWritten = {"mergefunc", "NumAliasesWritten"
, "Number of aliases generated", {0}, {false}}
;
139STATISTIC(NumDoubleWeak, "Number of new functions created")static llvm::Statistic NumDoubleWeak = {"mergefunc", "NumDoubleWeak"
, "Number of new functions created", {0}, {false}}
;
140
141static cl::opt<unsigned> NumFunctionsForSanityCheck(
142 "mergefunc-sanity",
143 cl::desc("How many functions in module could be used for "
144 "MergeFunctions pass sanity check. "
145 "'0' disables this check. Works only with '-debug' key."),
146 cl::init(0), cl::Hidden);
147
148// Under option -mergefunc-preserve-debug-info we:
149// - Do not create a new function for a thunk.
150// - Retain the debug info for a thunk's parameters (and associated
151// instructions for the debug info) from the entry block.
152// Note: -debug will display the algorithm at work.
153// - Create debug-info for the call (to the shared implementation) made by
154// a thunk and its return value.
155// - Erase the rest of the function, retaining the (minimally sized) entry
156// block to create a thunk.
157// - Preserve a thunk's call site to point to the thunk even when both occur
158// within the same translation unit, to aid debugability. Note that this
159// behaviour differs from the underlying -mergefunc implementation which
160// modifies the thunk's call site to point to the shared implementation
161// when both occur within the same translation unit.
162static cl::opt<bool>
163 MergeFunctionsPDI("mergefunc-preserve-debug-info", cl::Hidden,
164 cl::init(false),
165 cl::desc("Preserve debug info in thunk when mergefunc "
166 "transformations are made."));
167
168static cl::opt<bool>
169 MergeFunctionsAliases("mergefunc-use-aliases", cl::Hidden,
170 cl::init(false),
171 cl::desc("Allow mergefunc to create aliases"));
172
173namespace {
174
175class FunctionNode {
176 mutable AssertingVH<Function> F;
177 FunctionComparator::FunctionHash Hash;
178
179public:
180 // Note the hash is recalculated potentially multiple times, but it is cheap.
181 FunctionNode(Function *F)
182 : F(F), Hash(FunctionComparator::functionHash(*F)) {}
183
184 Function *getFunc() const { return F; }
185 FunctionComparator::FunctionHash getHash() const { return Hash; }
186
187 /// Replace the reference to the function F by the function G, assuming their
188 /// implementations are equal.
189 void replaceBy(Function *G) const {
190 F = G;
191 }
192
193 void release() { F = nullptr; }
194};
195
196/// MergeFunctions finds functions which will generate identical machine code,
197/// by considering all pointer types to be equivalent. Once identified,
198/// MergeFunctions will fold them by replacing a call to one to a call to a
199/// bitcast of the other.
200class MergeFunctions : public ModulePass {
201public:
202 static char ID;
203
204 MergeFunctions()
205 : ModulePass(ID), FnTree(FunctionNodeCmp(&GlobalNumbers)) {
206 initializeMergeFunctionsPass(*PassRegistry::getPassRegistry());
207 }
208
209 bool runOnModule(Module &M) override;
210
211private:
212 // The function comparison operator is provided here so that FunctionNodes do
213 // not need to become larger with another pointer.
214 class FunctionNodeCmp {
215 GlobalNumberState* GlobalNumbers;
216
217 public:
218 FunctionNodeCmp(GlobalNumberState* GN) : GlobalNumbers(GN) {}
219
220 bool operator()(const FunctionNode &LHS, const FunctionNode &RHS) const {
221 // Order first by hashes, then full function comparison.
222 if (LHS.getHash() != RHS.getHash())
223 return LHS.getHash() < RHS.getHash();
224 FunctionComparator FCmp(LHS.getFunc(), RHS.getFunc(), GlobalNumbers);
225 return FCmp.compare() == -1;
226 }
227 };
228 using FnTreeType = std::set<FunctionNode, FunctionNodeCmp>;
229
230 GlobalNumberState GlobalNumbers;
231
232 /// A work queue of functions that may have been modified and should be
233 /// analyzed again.
234 std::vector<WeakTrackingVH> Deferred;
235
236#ifndef NDEBUG
237 /// Checks the rules of order relation introduced among functions set.
238 /// Returns true, if sanity check has been passed, and false if failed.
239 bool doSanityCheck(std::vector<WeakTrackingVH> &Worklist);
240#endif
241
242 /// Insert a ComparableFunction into the FnTree, or merge it away if it's
243 /// equal to one that's already present.
244 bool insert(Function *NewFunction);
245
246 /// Remove a Function from the FnTree and queue it up for a second sweep of
247 /// analysis.
248 void remove(Function *F);
249
250 /// Find the functions that use this Value and remove them from FnTree and
251 /// queue the functions.
252 void removeUsers(Value *V);
253
254 /// Replace all direct calls of Old with calls of New. Will bitcast New if
255 /// necessary to make types match.
256 void replaceDirectCallers(Function *Old, Function *New);
257
258 /// Merge two equivalent functions. Upon completion, G may be deleted, or may
259 /// be converted into a thunk. In either case, it should never be visited
260 /// again.
261 void mergeTwoFunctions(Function *F, Function *G);
262
263 /// Fill PDIUnrelatedWL with instructions from the entry block that are
264 /// unrelated to parameter related debug info.
265 void filterInstsUnrelatedToPDI(BasicBlock *GEntryBlock,
266 std::vector<Instruction *> &PDIUnrelatedWL);
267
268 /// Erase the rest of the CFG (i.e. barring the entry block).
269 void eraseTail(Function *G);
270
271 /// Erase the instructions in PDIUnrelatedWL as they are unrelated to the
272 /// parameter debug info, from the entry block.
273 void eraseInstsUnrelatedToPDI(std::vector<Instruction *> &PDIUnrelatedWL);
274
275 /// Replace G with a simple tail call to bitcast(F). Also (unless
276 /// MergeFunctionsPDI holds) replace direct uses of G with bitcast(F),
277 /// delete G.
278 void writeThunk(Function *F, Function *G);
279
280 // Replace G with an alias to F (deleting function G)
281 void writeAlias(Function *F, Function *G);
282
283 // Replace G with an alias to F if possible, or a thunk to F if possible.
284 // Returns false if neither is the case.
285 bool writeThunkOrAlias(Function *F, Function *G);
286
287 /// Replace function F with function G in the function tree.
288 void replaceFunctionInTree(const FunctionNode &FN, Function *G);
289
290 /// The set of all distinct functions. Use the insert() and remove() methods
291 /// to modify it. The map allows efficient lookup and deferring of Functions.
292 FnTreeType FnTree;
293
294 // Map functions to the iterators of the FunctionNode which contains them
295 // in the FnTree. This must be updated carefully whenever the FnTree is
296 // modified, i.e. in insert(), remove(), and replaceFunctionInTree(), to avoid
297 // dangling iterators into FnTree. The invariant that preserves this is that
298 // there is exactly one mapping F -> FN for each FunctionNode FN in FnTree.
299 DenseMap<AssertingVH<Function>, FnTreeType::iterator> FNodesInTree;
300};
301
302} // end anonymous namespace
303
304char MergeFunctions::ID = 0;
305
306INITIALIZE_PASS(MergeFunctions, "mergefunc", "Merge Functions", false, false)static void *initializeMergeFunctionsPassOnce(PassRegistry &
Registry) { PassInfo *PI = new PassInfo( "Merge Functions", "mergefunc"
, &MergeFunctions::ID, PassInfo::NormalCtor_t(callDefaultCtor
<MergeFunctions>), false, false); Registry.registerPass
(*PI, true); return PI; } static llvm::once_flag InitializeMergeFunctionsPassFlag
; void llvm::initializeMergeFunctionsPass(PassRegistry &Registry
) { llvm::call_once(InitializeMergeFunctionsPassFlag, initializeMergeFunctionsPassOnce
, std::ref(Registry)); }
307
308ModulePass *llvm::createMergeFunctionsPass() {
309 return new MergeFunctions();
310}
311
312#ifndef NDEBUG
313bool MergeFunctions::doSanityCheck(std::vector<WeakTrackingVH> &Worklist) {
314 if (const unsigned Max = NumFunctionsForSanityCheck) {
315 unsigned TripleNumber = 0;
316 bool Valid = true;
317
318 dbgs() << "MERGEFUNC-SANITY: Started for first " << Max << " functions.\n";
319
320 unsigned i = 0;
321 for (std::vector<WeakTrackingVH>::iterator I = Worklist.begin(),
322 E = Worklist.end();
323 I != E && i < Max; ++I, ++i) {
324 unsigned j = i;
325 for (std::vector<WeakTrackingVH>::iterator J = I; J != E && j < Max;
326 ++J, ++j) {
327 Function *F1 = cast<Function>(*I);
328 Function *F2 = cast<Function>(*J);
329 int Res1 = FunctionComparator(F1, F2, &GlobalNumbers).compare();
330 int Res2 = FunctionComparator(F2, F1, &GlobalNumbers).compare();
331
332 // If F1 <= F2, then F2 >= F1, otherwise report failure.
333 if (Res1 != -Res2) {
334 dbgs() << "MERGEFUNC-SANITY: Non-symmetric; triple: " << TripleNumber
335 << "\n";
336 dbgs() << *F1 << '\n' << *F2 << '\n';
337 Valid = false;
338 }
339
340 if (Res1 == 0)
341 continue;
342
343 unsigned k = j;
344 for (std::vector<WeakTrackingVH>::iterator K = J; K != E && k < Max;
345 ++k, ++K, ++TripleNumber) {
346 if (K == J)
347 continue;
348
349 Function *F3 = cast<Function>(*K);
350 int Res3 = FunctionComparator(F1, F3, &GlobalNumbers).compare();
351 int Res4 = FunctionComparator(F2, F3, &GlobalNumbers).compare();
352
353 bool Transitive = true;
354
355 if (Res1 != 0 && Res1 == Res4) {
356 // F1 > F2, F2 > F3 => F1 > F3
357 Transitive = Res3 == Res1;
358 } else if (Res3 != 0 && Res3 == -Res4) {
359 // F1 > F3, F3 > F2 => F1 > F2
360 Transitive = Res3 == Res1;
361 } else if (Res4 != 0 && -Res3 == Res4) {
362 // F2 > F3, F3 > F1 => F2 > F1
363 Transitive = Res4 == -Res1;
364 }
365
366 if (!Transitive) {
367 dbgs() << "MERGEFUNC-SANITY: Non-transitive; triple: "
368 << TripleNumber << "\n";
369 dbgs() << "Res1, Res3, Res4: " << Res1 << ", " << Res3 << ", "
370 << Res4 << "\n";
371 dbgs() << *F1 << '\n' << *F2 << '\n' << *F3 << '\n';
372 Valid = false;
373 }
374 }
375 }
376 }
377
378 dbgs() << "MERGEFUNC-SANITY: " << (Valid ? "Passed." : "Failed.") << "\n";
379 return Valid;
380 }
381 return true;
382}
383#endif
384
385/// Check whether \p F is eligible for function merging.
386static bool isEligibleForMerging(Function &F) {
387 return !F.isDeclaration() && !F.hasAvailableExternallyLinkage();
388}
389
390bool MergeFunctions::runOnModule(Module &M) {
391 if (skipModule(M))
1
Assuming the condition is false
2
Taking false branch
392 return false;
393
394 bool Changed = false;
395
396 // All functions in the module, ordered by hash. Functions with a unique
397 // hash value are easily eliminated.
398 std::vector<std::pair<FunctionComparator::FunctionHash, Function *>>
399 HashedFuncs;
400 for (Function &Func : M) {
401 if (isEligibleForMerging(Func)) {
402 HashedFuncs.push_back({FunctionComparator::functionHash(Func), &Func});
403 }
404 }
405
406 std::stable_sort(
407 HashedFuncs.begin(), HashedFuncs.end(),
408 [](const std::pair<FunctionComparator::FunctionHash, Function *> &a,
409 const std::pair<FunctionComparator::FunctionHash, Function *> &b) {
410 return a.first < b.first;
411 });
412
413 auto S = HashedFuncs.begin();
414 for (auto I = HashedFuncs.begin(), IE = HashedFuncs.end(); I != IE; ++I) {
3
Loop condition is false. Execution continues on line 424
415 // If the hash value matches the previous value or the next one, we must
416 // consider merging it. Otherwise it is dropped and never considered again.
417 if ((I != S && std::prev(I)->first == I->first) ||
418 (std::next(I) != IE && std::next(I)->first == I->first) ) {
419 Deferred.push_back(WeakTrackingVH(I->second));
420 }
421 }
422
423 do {
424 std::vector<WeakTrackingVH> Worklist;
425 Deferred.swap(Worklist);
426
427 LLVM_DEBUG(doSanityCheck(Worklist))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { doSanityCheck(Worklist); } } while (false)
;
4
Assuming 'DebugFlag' is 0
5
Loop condition is false. Exiting loop
428
429 LLVM_DEBUG(dbgs() << "size of module: " << M.size() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "size of module: " << M
.size() << '\n'; } } while (false)
;
6
Loop condition is false. Exiting loop
430 LLVM_DEBUG(dbgs() << "size of worklist: " << Worklist.size() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "size of worklist: " <<
Worklist.size() << '\n'; } } while (false)
;
7
Loop condition is false. Exiting loop
431
432 // Insert functions and merge them.
433 for (WeakTrackingVH &I : Worklist) {
434 if (!I)
8
Assuming the condition is false
9
Taking false branch
435 continue;
436 Function *F = cast<Function>(I);
437 if (!F->isDeclaration() && !F->hasAvailableExternallyLinkage()) {
10
Assuming the condition is true
11
Taking true branch
438 Changed |= insert(F);
12
Calling 'MergeFunctions::insert'
439 }
440 }
441 LLVM_DEBUG(dbgs() << "size of FnTree: " << FnTree.size() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "size of FnTree: " << FnTree
.size() << '\n'; } } while (false)
;
442 } while (!Deferred.empty());
443
444 FnTree.clear();
445 FNodesInTree.clear();
446 GlobalNumbers.clear();
447
448 return Changed;
449}
450
451// Replace direct callers of Old with New.
452void MergeFunctions::replaceDirectCallers(Function *Old, Function *New) {
453 Constant *BitcastNew = ConstantExpr::getBitCast(New, Old->getType());
454 for (auto UI = Old->use_begin(), UE = Old->use_end(); UI != UE;) {
455 Use *U = &*UI;
456 ++UI;
457 CallSite CS(U->getUser());
458 if (CS && CS.isCallee(U)) {
459 // Transfer the called function's attributes to the call site. Due to the
460 // bitcast we will 'lose' ABI changing attributes because the 'called
461 // function' is no longer a Function* but the bitcast. Code that looks up
462 // the attributes from the called function will fail.
463
464 // FIXME: This is not actually true, at least not anymore. The callsite
465 // will always have the same ABI affecting attributes as the callee,
466 // because otherwise the original input has UB. Note that Old and New
467 // always have matching ABI, so no attributes need to be changed.
468 // Transferring other attributes may help other optimizations, but that
469 // should be done uniformly and not in this ad-hoc way.
470 auto &Context = New->getContext();
471 auto NewPAL = New->getAttributes();
472 SmallVector<AttributeSet, 4> NewArgAttrs;
473 for (unsigned argIdx = 0; argIdx < CS.arg_size(); argIdx++)
474 NewArgAttrs.push_back(NewPAL.getParamAttributes(argIdx));
475 // Don't transfer attributes from the function to the callee. Function
476 // attributes typically aren't relevant to the calling convention or ABI.
477 CS.setAttributes(AttributeList::get(Context, /*FnAttrs=*/AttributeSet(),
478 NewPAL.getRetAttributes(),
479 NewArgAttrs));
480
481 remove(CS.getInstruction()->getFunction());
482 U->set(BitcastNew);
483 }
484 }
485}
486
487// Helper for writeThunk,
488// Selects proper bitcast operation,
489// but a bit simpler then CastInst::getCastOpcode.
490static Value *createCast(IRBuilder<> &Builder, Value *V, Type *DestTy) {
491 Type *SrcTy = V->getType();
492 if (SrcTy->isStructTy()) {
493 assert(DestTy->isStructTy())((DestTy->isStructTy()) ? static_cast<void> (0) : __assert_fail
("DestTy->isStructTy()", "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 493, __PRETTY_FUNCTION__))
;
494 assert(SrcTy->getStructNumElements() == DestTy->getStructNumElements())((SrcTy->getStructNumElements() == DestTy->getStructNumElements
()) ? static_cast<void> (0) : __assert_fail ("SrcTy->getStructNumElements() == DestTy->getStructNumElements()"
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 494, __PRETTY_FUNCTION__))
;
495 Value *Result = UndefValue::get(DestTy);
496 for (unsigned int I = 0, E = SrcTy->getStructNumElements(); I < E; ++I) {
497 Value *Element = createCast(
498 Builder, Builder.CreateExtractValue(V, makeArrayRef(I)),
499 DestTy->getStructElementType(I));
500
501 Result =
502 Builder.CreateInsertValue(Result, Element, makeArrayRef(I));
503 }
504 return Result;
505 }
506 assert(!DestTy->isStructTy())((!DestTy->isStructTy()) ? static_cast<void> (0) : __assert_fail
("!DestTy->isStructTy()", "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 506, __PRETTY_FUNCTION__))
;
507 if (SrcTy->isIntegerTy() && DestTy->isPointerTy())
508 return Builder.CreateIntToPtr(V, DestTy);
509 else if (SrcTy->isPointerTy() && DestTy->isIntegerTy())
510 return Builder.CreatePtrToInt(V, DestTy);
511 else
512 return Builder.CreateBitCast(V, DestTy);
513}
514
515// Erase the instructions in PDIUnrelatedWL as they are unrelated to the
516// parameter debug info, from the entry block.
517void MergeFunctions::eraseInstsUnrelatedToPDI(
518 std::vector<Instruction *> &PDIUnrelatedWL) {
519 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Erasing instructions (in reverse order of appearance in "
"entry block) unrelated to parameter debug info from entry "
"block: {\n"; } } while (false)
520 dbgs() << " Erasing instructions (in reverse order of appearance in "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Erasing instructions (in reverse order of appearance in "
"entry block) unrelated to parameter debug info from entry "
"block: {\n"; } } while (false)
521 "entry block) unrelated to parameter debug info from entry "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Erasing instructions (in reverse order of appearance in "
"entry block) unrelated to parameter debug info from entry "
"block: {\n"; } } while (false)
522 "block: {\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Erasing instructions (in reverse order of appearance in "
"entry block) unrelated to parameter debug info from entry "
"block: {\n"; } } while (false)
;
523 while (!PDIUnrelatedWL.empty()) {
524 Instruction *I = PDIUnrelatedWL.back();
525 LLVM_DEBUG(dbgs() << " Deleting Instruction: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Deleting Instruction: "; }
} while (false)
;
526 LLVM_DEBUG(I->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { I->print(dbgs()); } } while (false)
;
527 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
528 I->eraseFromParent();
529 PDIUnrelatedWL.pop_back();
530 }
531 LLVM_DEBUG(dbgs() << " } // Done erasing instructions unrelated to parameter "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " } // Done erasing instructions unrelated to parameter "
"debug info from entry block. \n"; } } while (false)
532 "debug info from entry block. \n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " } // Done erasing instructions unrelated to parameter "
"debug info from entry block. \n"; } } while (false)
;
533}
534
535// Reduce G to its entry block.
536void MergeFunctions::eraseTail(Function *G) {
537 std::vector<BasicBlock *> WorklistBB;
538 for (Function::iterator BBI = std::next(G->begin()), BBE = G->end();
539 BBI != BBE; ++BBI) {
540 BBI->dropAllReferences();
541 WorklistBB.push_back(&*BBI);
542 }
543 while (!WorklistBB.empty()) {
544 BasicBlock *BB = WorklistBB.back();
545 BB->eraseFromParent();
546 WorklistBB.pop_back();
547 }
548}
549
550// We are interested in the following instructions from the entry block as being
551// related to parameter debug info:
552// - @llvm.dbg.declare
553// - stores from the incoming parameters to locations on the stack-frame
554// - allocas that create these locations on the stack-frame
555// - @llvm.dbg.value
556// - the entry block's terminator
557// The rest are unrelated to debug info for the parameters; fill up
558// PDIUnrelatedWL with such instructions.
559void MergeFunctions::filterInstsUnrelatedToPDI(
560 BasicBlock *GEntryBlock, std::vector<Instruction *> &PDIUnrelatedWL) {
561 std::set<Instruction *> PDIRelated;
562 for (BasicBlock::iterator BI = GEntryBlock->begin(), BIE = GEntryBlock->end();
563 BI != BIE; ++BI) {
564 if (auto *DVI = dyn_cast<DbgValueInst>(&*BI)) {
565 LLVM_DEBUG(dbgs() << " Deciding: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Deciding: "; } } while (false
)
;
566 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
567 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
568 DILocalVariable *DILocVar = DVI->getVariable();
569 if (DILocVar->isParameter()) {
570 LLVM_DEBUG(dbgs() << " Include (parameter): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Include (parameter): "; }
} while (false)
;
571 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
572 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
573 PDIRelated.insert(&*BI);
574 } else {
575 LLVM_DEBUG(dbgs() << " Delete (!parameter): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Delete (!parameter): "; }
} while (false)
;
576 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
577 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
578 }
579 } else if (auto *DDI = dyn_cast<DbgDeclareInst>(&*BI)) {
580 LLVM_DEBUG(dbgs() << " Deciding: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Deciding: "; } } while (false
)
;
581 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
582 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
583 DILocalVariable *DILocVar = DDI->getVariable();
584 if (DILocVar->isParameter()) {
585 LLVM_DEBUG(dbgs() << " Parameter: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Parameter: "; } } while (
false)
;
586 LLVM_DEBUG(DILocVar->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { DILocVar->print(dbgs()); } } while (false
)
;
587 AllocaInst *AI = dyn_cast_or_null<AllocaInst>(DDI->getAddress());
588 if (AI) {
589 LLVM_DEBUG(dbgs() << " Processing alloca users: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Processing alloca users: "
; } } while (false)
;
590 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
591 for (User *U : AI->users()) {
592 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
593 if (Value *Arg = SI->getValueOperand()) {
594 if (dyn_cast<Argument>(Arg)) {
595 LLVM_DEBUG(dbgs() << " Include: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Include: "; } } while (false
)
;
596 LLVM_DEBUG(AI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { AI->print(dbgs()); } } while (false)
;
597 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
598 PDIRelated.insert(AI);
599 LLVM_DEBUG(dbgs() << " Include (parameter): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Include (parameter): "; }
} while (false)
;
600 LLVM_DEBUG(SI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { SI->print(dbgs()); } } while (false)
;
601 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
602 PDIRelated.insert(SI);
603 LLVM_DEBUG(dbgs() << " Include: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Include: "; } } while (false
)
;
604 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
605 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
606 PDIRelated.insert(&*BI);
607 } else {
608 LLVM_DEBUG(dbgs() << " Delete (!parameter): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Delete (!parameter): "; }
} while (false)
;
609 LLVM_DEBUG(SI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { SI->print(dbgs()); } } while (false)
;
610 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
611 }
612 }
613 } else {
614 LLVM_DEBUG(dbgs() << " Defer: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Defer: "; } } while (false
)
;
615 LLVM_DEBUG(U->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { U->print(dbgs()); } } while (false)
;
616 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
617 }
618 }
619 } else {
620 LLVM_DEBUG(dbgs() << " Delete (alloca NULL): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Delete (alloca NULL): "; }
} while (false)
;
621 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
622 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
623 }
624 } else {
625 LLVM_DEBUG(dbgs() << " Delete (!parameter): ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Delete (!parameter): "; }
} while (false)
;
626 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
627 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
628 }
629 } else if (BI->isTerminator() && &*BI == GEntryBlock->getTerminator()) {
630 LLVM_DEBUG(dbgs() << " Will Include Terminator: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Will Include Terminator: "
; } } while (false)
;
631 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
632 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
633 PDIRelated.insert(&*BI);
634 } else {
635 LLVM_DEBUG(dbgs() << " Defer: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Defer: "; } } while (false
)
;
636 LLVM_DEBUG(BI->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { BI->print(dbgs()); } } while (false)
;
637 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
638 }
639 }
640 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Report parameter debug info related/related instructions: {\n"
; } } while (false)
641 dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Report parameter debug info related/related instructions: {\n"
; } } while (false)
642 << " Report parameter debug info related/related instructions: {\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " Report parameter debug info related/related instructions: {\n"
; } } while (false)
;
643 for (BasicBlock::iterator BI = GEntryBlock->begin(), BE = GEntryBlock->end();
644 BI != BE; ++BI) {
645
646 Instruction *I = &*BI;
647 if (PDIRelated.find(I) == PDIRelated.end()) {
648 LLVM_DEBUG(dbgs() << " !PDIRelated: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " !PDIRelated: "; } } while
(false)
;
649 LLVM_DEBUG(I->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { I->print(dbgs()); } } while (false)
;
650 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
651 PDIUnrelatedWL.push_back(I);
652 } else {
653 LLVM_DEBUG(dbgs() << " PDIRelated: ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " PDIRelated: "; } } while
(false)
;
654 LLVM_DEBUG(I->print(dbgs()))do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { I->print(dbgs()); } } while (false)
;
655 LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "\n"; } } while (false)
;
656 }
657 }
658 LLVM_DEBUG(dbgs() << " }\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " }\n"; } } while (false)
;
659}
660
661/// Whether this function may be replaced by a forwarding thunk.
662static bool canCreateThunkFor(Function *F) {
663 if (F->isVarArg())
664 return false;
665
666 // Don't merge tiny functions using a thunk, since it can just end up
667 // making the function larger.
668 if (F->size() == 1) {
669 if (F->front().size() <= 2) {
670 LLVM_DEBUG(dbgs() << "canCreateThunkFor: " << F->getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "canCreateThunkFor: " <<
F->getName() << " is too small to bother creating a thunk for\n"
; } } while (false)
671 << " is too small to bother creating a thunk for\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "canCreateThunkFor: " <<
F->getName() << " is too small to bother creating a thunk for\n"
; } } while (false)
;
672 return false;
673 }
674 }
675 return true;
676}
677
678// Replace G with a simple tail call to bitcast(F). Also (unless
679// MergeFunctionsPDI holds) replace direct uses of G with bitcast(F),
680// delete G. Under MergeFunctionsPDI, we use G itself for creating
681// the thunk as we preserve the debug info (and associated instructions)
682// from G's entry block pertaining to G's incoming arguments which are
683// passed on as corresponding arguments in the call that G makes to F.
684// For better debugability, under MergeFunctionsPDI, we do not modify G's
685// call sites to point to F even when within the same translation unit.
686void MergeFunctions::writeThunk(Function *F, Function *G) {
687 BasicBlock *GEntryBlock = nullptr;
688 std::vector<Instruction *> PDIUnrelatedWL;
689 BasicBlock *BB = nullptr;
690 Function *NewG = nullptr;
27
'NewG' initialized to a null pointer value
691 if (MergeFunctionsPDI) {
28
Assuming the condition is true
29
Taking true branch
692 LLVM_DEBUG(dbgs() << "writeThunk: (MergeFunctionsPDI) Do not create a new "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) Do not create a new "
"function as thunk; retain original: " << G->getName
() << "()\n"; } } while (false)
30
Assuming 'DebugFlag' is 0
31
Loop condition is false. Exiting loop
693 "function as thunk; retain original: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) Do not create a new "
"function as thunk; retain original: " << G->getName
() << "()\n"; } } while (false)
694 << G->getName() << "()\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) Do not create a new "
"function as thunk; retain original: " << G->getName
() << "()\n"; } } while (false)
;
695 GEntryBlock = &G->getEntryBlock();
696 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) filter parameter related "
"debug info for " << G->getName() << "() {\n"
; } } while (false)
32
Assuming 'DebugFlag' is 0
33
Loop condition is false. Exiting loop
697 dbgs() << "writeThunk: (MergeFunctionsPDI) filter parameter related "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) filter parameter related "
"debug info for " << G->getName() << "() {\n"
; } } while (false)
698 "debug info for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) filter parameter related "
"debug info for " << G->getName() << "() {\n"
; } } while (false)
699 << G->getName() << "() {\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) filter parameter related "
"debug info for " << G->getName() << "() {\n"
; } } while (false)
;
700 filterInstsUnrelatedToPDI(GEntryBlock, PDIUnrelatedWL);
701 GEntryBlock->getTerminator()->eraseFromParent();
702 BB = GEntryBlock;
703 } else {
704 NewG = Function::Create(G->getFunctionType(), G->getLinkage(),
705 G->getAddressSpace(), "", G->getParent());
706 BB = BasicBlock::Create(F->getContext(), "", NewG);
707 }
708
709 IRBuilder<> Builder(BB);
710 Function *H = MergeFunctionsPDI ? G : NewG;
34
Assuming the condition is false
35
'?' condition is false
36
'H' initialized to a null pointer value
711 SmallVector<Value *, 16> Args;
712 unsigned i = 0;
713 FunctionType *FFTy = F->getFunctionType();
714 for (Argument &AI : H->args()) {
37
Called C++ object pointer is null
715 Args.push_back(createCast(Builder, &AI, FFTy->getParamType(i)));
716 ++i;
717 }
718
719 CallInst *CI = Builder.CreateCall(F, Args);
720 ReturnInst *RI = nullptr;
721 CI->setTailCall();
722 CI->setCallingConv(F->getCallingConv());
723 CI->setAttributes(F->getAttributes());
724 if (H->getReturnType()->isVoidTy()) {
725 RI = Builder.CreateRetVoid();
726 } else {
727 RI = Builder.CreateRet(createCast(Builder, CI, H->getReturnType()));
728 }
729
730 if (MergeFunctionsPDI) {
731 DISubprogram *DIS = G->getSubprogram();
732 if (DIS) {
733 DebugLoc CIDbgLoc = DebugLoc::get(DIS->getScopeLine(), 0, DIS);
734 DebugLoc RIDbgLoc = DebugLoc::get(DIS->getScopeLine(), 0, DIS);
735 CI->setDebugLoc(CIDbgLoc);
736 RI->setDebugLoc(RIDbgLoc);
737 } else {
738 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) No DISubprogram for "
<< G->getName() << "()\n"; } } while (false)
739 dbgs() << "writeThunk: (MergeFunctionsPDI) No DISubprogram for "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) No DISubprogram for "
<< G->getName() << "()\n"; } } while (false)
740 << G->getName() << "()\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: (MergeFunctionsPDI) No DISubprogram for "
<< G->getName() << "()\n"; } } while (false)
;
741 }
742 eraseTail(G);
743 eraseInstsUnrelatedToPDI(PDIUnrelatedWL);
744 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "} // End of parameter related debug info filtering for: "
<< G->getName() << "()\n"; } } while (false)
745 dbgs() << "} // End of parameter related debug info filtering for: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "} // End of parameter related debug info filtering for: "
<< G->getName() << "()\n"; } } while (false)
746 << G->getName() << "()\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "} // End of parameter related debug info filtering for: "
<< G->getName() << "()\n"; } } while (false)
;
747 } else {
748 NewG->copyAttributesFrom(G);
749 NewG->takeName(G);
750 removeUsers(G);
751 G->replaceAllUsesWith(NewG);
752 G->eraseFromParent();
753 }
754
755 LLVM_DEBUG(dbgs() << "writeThunk: " << H->getName() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeThunk: " << H->
getName() << '\n'; } } while (false)
;
756 ++NumThunksWritten;
757}
758
759// Whether this function may be replaced by an alias
760static bool canCreateAliasFor(Function *F) {
761 if (!MergeFunctionsAliases || !F->hasGlobalUnnamedAddr())
762 return false;
763
764 // We should only see linkages supported by aliases here
765 assert(F->hasLocalLinkage() || F->hasExternalLinkage()((F->hasLocalLinkage() || F->hasExternalLinkage() || F->
hasWeakLinkage() || F->hasLinkOnceLinkage()) ? static_cast
<void> (0) : __assert_fail ("F->hasLocalLinkage() || F->hasExternalLinkage() || F->hasWeakLinkage() || F->hasLinkOnceLinkage()"
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 766, __PRETTY_FUNCTION__))
766 || F->hasWeakLinkage() || F->hasLinkOnceLinkage())((F->hasLocalLinkage() || F->hasExternalLinkage() || F->
hasWeakLinkage() || F->hasLinkOnceLinkage()) ? static_cast
<void> (0) : __assert_fail ("F->hasLocalLinkage() || F->hasExternalLinkage() || F->hasWeakLinkage() || F->hasLinkOnceLinkage()"
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 766, __PRETTY_FUNCTION__))
;
767 return true;
768}
769
770// Replace G with an alias to F (deleting function G)
771void MergeFunctions::writeAlias(Function *F, Function *G) {
772 Constant *BitcastF = ConstantExpr::getBitCast(F, G->getType());
773 PointerType *PtrType = G->getType();
774 auto *GA = GlobalAlias::create(
775 PtrType->getElementType(), PtrType->getAddressSpace(),
776 G->getLinkage(), "", BitcastF, G->getParent());
777
778 F->setAlignment(std::max(F->getAlignment(), G->getAlignment()));
779 GA->takeName(G);
780 GA->setVisibility(G->getVisibility());
781 GA->setUnnamedAddr(GlobalValue::UnnamedAddr::Global);
782
783 removeUsers(G);
784 G->replaceAllUsesWith(GA);
785 G->eraseFromParent();
786
787 LLVM_DEBUG(dbgs() << "writeAlias: " << GA->getName() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "writeAlias: " << GA->
getName() << '\n'; } } while (false)
;
788 ++NumAliasesWritten;
789}
790
791// Replace G with an alias to F if possible, or a thunk to F if
792// profitable. Returns false if neither is the case.
793bool MergeFunctions::writeThunkOrAlias(Function *F, Function *G) {
794 if (canCreateAliasFor(G)) {
24
Taking false branch
795 writeAlias(F, G);
796 return true;
797 }
798 if (canCreateThunkFor(F)) {
25
Taking true branch
799 writeThunk(F, G);
26
Calling 'MergeFunctions::writeThunk'
800 return true;
801 }
802 return false;
803}
804
805// Merge two equivalent functions. Upon completion, Function G is deleted.
806void MergeFunctions::mergeTwoFunctions(Function *F, Function *G) {
807 if (F->isInterposable()) {
19
Taking false branch
808 assert(G->isInterposable())((G->isInterposable()) ? static_cast<void> (0) : __assert_fail
("G->isInterposable()", "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 808, __PRETTY_FUNCTION__))
;
809
810 // Both writeThunkOrAlias() calls below must succeed, either because we can
811 // create aliases for G and NewF, or because a thunk for F is profitable.
812 // F here has the same signature as NewF below, so that's what we check.
813 if (!canCreateThunkFor(F) &&
814 (!canCreateAliasFor(F) || !canCreateAliasFor(G)))
815 return;
816
817 // Make them both thunks to the same internal function.
818 Function *NewF = Function::Create(F->getFunctionType(), F->getLinkage(),
819 F->getAddressSpace(), "", F->getParent());
820 NewF->copyAttributesFrom(F);
821 NewF->takeName(F);
822 removeUsers(F);
823 F->replaceAllUsesWith(NewF);
824
825 unsigned MaxAlignment = std::max(G->getAlignment(), NewF->getAlignment());
826
827 writeThunkOrAlias(F, G);
828 writeThunkOrAlias(F, NewF);
829
830 F->setAlignment(MaxAlignment);
831 F->setLinkage(GlobalValue::PrivateLinkage);
832 ++NumDoubleWeak;
833 ++NumFunctionsMerged;
834 } else {
835 // For better debugability, under MergeFunctionsPDI, we do not modify G's
836 // call sites to point to F even when within the same translation unit.
837 if (!G->isInterposable() && !MergeFunctionsPDI) {
20
Assuming the condition is false
21
Taking false branch
838 if (G->hasGlobalUnnamedAddr()) {
839 // G might have been a key in our GlobalNumberState, and it's illegal
840 // to replace a key in ValueMap<GlobalValue *> with a non-global.
841 GlobalNumbers.erase(G);
842 // If G's address is not significant, replace it entirely.
843 Constant *BitcastF = ConstantExpr::getBitCast(F, G->getType());
844 removeUsers(G);
845 G->replaceAllUsesWith(BitcastF);
846 } else {
847 // Redirect direct callers of G to F. (See note on MergeFunctionsPDI
848 // above).
849 replaceDirectCallers(G, F);
850 }
851 }
852
853 // If G was internal then we may have replaced all uses of G with F. If so,
854 // stop here and delete G. There's no need for a thunk. (See note on
855 // MergeFunctionsPDI above).
856 if (G->isDiscardableIfUnused() && G->use_empty() && !MergeFunctionsPDI) {
22
Assuming the condition is false
857 G->eraseFromParent();
858 ++NumFunctionsMerged;
859 return;
860 }
861
862 if (writeThunkOrAlias(F, G)) {
23
Calling 'MergeFunctions::writeThunkOrAlias'
863 ++NumFunctionsMerged;
864 }
865 }
866}
867
868/// Replace function F by function G.
869void MergeFunctions::replaceFunctionInTree(const FunctionNode &FN,
870 Function *G) {
871 Function *F = FN.getFunc();
872 assert(FunctionComparator(F, G, &GlobalNumbers).compare() == 0 &&((FunctionComparator(F, G, &GlobalNumbers).compare() == 0
&& "The two functions must be equal") ? static_cast<
void> (0) : __assert_fail ("FunctionComparator(F, G, &GlobalNumbers).compare() == 0 && \"The two functions must be equal\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 873, __PRETTY_FUNCTION__))
873 "The two functions must be equal")((FunctionComparator(F, G, &GlobalNumbers).compare() == 0
&& "The two functions must be equal") ? static_cast<
void> (0) : __assert_fail ("FunctionComparator(F, G, &GlobalNumbers).compare() == 0 && \"The two functions must be equal\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 873, __PRETTY_FUNCTION__))
;
874
875 auto I = FNodesInTree.find(F);
876 assert(I != FNodesInTree.end() && "F should be in FNodesInTree")((I != FNodesInTree.end() && "F should be in FNodesInTree"
) ? static_cast<void> (0) : __assert_fail ("I != FNodesInTree.end() && \"F should be in FNodesInTree\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 876, __PRETTY_FUNCTION__))
;
877 assert(FNodesInTree.count(G) == 0 && "FNodesInTree should not contain G")((FNodesInTree.count(G) == 0 && "FNodesInTree should not contain G"
) ? static_cast<void> (0) : __assert_fail ("FNodesInTree.count(G) == 0 && \"FNodesInTree should not contain G\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 877, __PRETTY_FUNCTION__))
;
878
879 FnTreeType::iterator IterToFNInFnTree = I->second;
880 assert(&(*IterToFNInFnTree) == &FN && "F should map to FN in FNodesInTree.")((&(*IterToFNInFnTree) == &FN && "F should map to FN in FNodesInTree."
) ? static_cast<void> (0) : __assert_fail ("&(*IterToFNInFnTree) == &FN && \"F should map to FN in FNodesInTree.\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 880, __PRETTY_FUNCTION__))
;
881 // Remove F -> FN and insert G -> FN
882 FNodesInTree.erase(I);
883 FNodesInTree.insert({G, IterToFNInFnTree});
884 // Replace F with G in FN, which is stored inside the FnTree.
885 FN.replaceBy(G);
886}
887
888// Ordering for functions that are equal under FunctionComparator
889static bool isFuncOrderCorrect(const Function *F, const Function *G) {
890 if (F->isInterposable() != G->isInterposable()) {
891 // Strong before weak, because the weak function may call the strong
892 // one, but not the other way around.
893 return !F->isInterposable();
894 }
895 if (F->hasLocalLinkage() != G->hasLocalLinkage()) {
896 // External before local, because we definitely have to keep the external
897 // function, but may be able to drop the local one.
898 return !F->hasLocalLinkage();
899 }
900 // Impose a total order (by name) on the replacement of functions. This is
901 // important when operating on more than one module independently to prevent
902 // cycles of thunks calling each other when the modules are linked together.
903 return F->getName() <= G->getName();
904}
905
906// Insert a ComparableFunction into the FnTree, or merge it away if equal to one
907// that was already inserted.
908bool MergeFunctions::insert(Function *NewFunction) {
909 std::pair<FnTreeType::iterator, bool> Result =
910 FnTree.insert(FunctionNode(NewFunction));
911
912 if (Result.second) {
13
Assuming the condition is false
14
Taking false branch
913 assert(FNodesInTree.count(NewFunction) == 0)((FNodesInTree.count(NewFunction) == 0) ? static_cast<void
> (0) : __assert_fail ("FNodesInTree.count(NewFunction) == 0"
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 913, __PRETTY_FUNCTION__))
;
914 FNodesInTree.insert({NewFunction, Result.first});
915 LLVM_DEBUG(dbgs() << "Inserting as unique: " << NewFunction->getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "Inserting as unique: " <<
NewFunction->getName() << '\n'; } } while (false)
916 << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "Inserting as unique: " <<
NewFunction->getName() << '\n'; } } while (false)
;
917 return false;
918 }
919
920 const FunctionNode &OldF = *Result.first;
921
922 if (!isFuncOrderCorrect(OldF.getFunc(), NewFunction)) {
15
Taking false branch
923 // Swap the two functions.
924 Function *F = OldF.getFunc();
925 replaceFunctionInTree(*Result.first, NewFunction);
926 NewFunction = F;
927 assert(OldF.getFunc() != F && "Must have swapped the functions.")((OldF.getFunc() != F && "Must have swapped the functions."
) ? static_cast<void> (0) : __assert_fail ("OldF.getFunc() != F && \"Must have swapped the functions.\""
, "/build/llvm-toolchain-snapshot-9~svn358520/lib/Transforms/IPO/MergeFunctions.cpp"
, 927, __PRETTY_FUNCTION__))
;
928 }
929
930 LLVM_DEBUG(dbgs() << " " << OldF.getFunc()->getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " " << OldF.getFunc()
->getName() << " == " << NewFunction->getName
() << '\n'; } } while (false)
16
Assuming 'DebugFlag' is 0
17
Loop condition is false. Exiting loop
931 << " == " << NewFunction->getName() << '\n')do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << " " << OldF.getFunc()
->getName() << " == " << NewFunction->getName
() << '\n'; } } while (false)
;
932
933 Function *DeleteF = NewFunction;
934 mergeTwoFunctions(OldF.getFunc(), DeleteF);
18
Calling 'MergeFunctions::mergeTwoFunctions'
935 return true;
936}
937
938// Remove a function from FnTree. If it was already in FnTree, add
939// it to Deferred so that we'll look at it in the next round.
940void MergeFunctions::remove(Function *F) {
941 auto I = FNodesInTree.find(F);
942 if (I != FNodesInTree.end()) {
943 LLVM_DEBUG(dbgs() << "Deferred " << F->getName() << ".\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("mergefunc")) { dbgs() << "Deferred " << F->getName
() << ".\n"; } } while (false)
;
944 FnTree.erase(I->second);
945 // I->second has been invalidated, remove it from the FNodesInTree map to
946 // preserve the invariant.
947 FNodesInTree.erase(I);
948 Deferred.emplace_back(F);
949 }
950}
951
952// For each instruction used by the value, remove() the function that contains
953// the instruction. This should happen right before a call to RAUW.
954void MergeFunctions::removeUsers(Value *V) {
955 std::vector<Value *> Worklist;
956 Worklist.push_back(V);
957 SmallPtrSet<Value*, 8> Visited;
958 Visited.insert(V);
959 while (!Worklist.empty()) {
960 Value *V = Worklist.back();
961 Worklist.pop_back();
962
963 for (User *U : V->users()) {
964 if (Instruction *I = dyn_cast<Instruction>(U)) {
965 remove(I->getFunction());
966 } else if (isa<GlobalValue>(U)) {
967 // do nothing
968 } else if (Constant *C = dyn_cast<Constant>(U)) {
969 for (User *UU : C->users()) {
970 if (!Visited.insert(UU).second)
971 Worklist.push_back(UU);
972 }
973 }
974 }
975 }
976}