1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
//===- ElimAvailExtern.cpp - DCE unreachable internal functions -----------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This transform is designed to eliminate available external global
// definitions from the program, turning them into declarations.
//
//===----------------------------------------------------------------------===//
#include "llvm/Transforms/IPO/ElimAvailExtern.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/CtxProfAnalysis.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalValue.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/Module.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Transforms/Utils/GlobalStatus.h"
#include "llvm/Transforms/Utils/ModuleUtils.h"
using namespace llvm;
#define DEBUG_TYPE "elim-avail-extern"
static cl::opt<bool> ConvertToLocal(
"avail-extern-to-local", cl::Hidden,
cl::desc("Convert available_externally into locals, renaming them "
"to avoid link-time clashes."));
// This option was originally introduced to correctly support the lowering of
// LDS variables for AMDGPU when ThinLTO is enabled. It can be utilized for
// other purposes, but make sure it is safe to do so, as privatizing global
// variables is generally not safe.
static cl::opt<unsigned> ConvertGlobalVariableInAddrSpace(
"avail-extern-gv-in-addrspace-to-local", cl::Hidden,
cl::desc(
"Convert available_externally global variables into locals if they are "
"in specificed addrspace, renaming them to avoid link-time clashes."));
STATISTIC(NumRemovals, "Number of functions removed");
STATISTIC(NumFunctionsConverted, "Number of functions converted");
STATISTIC(NumGlobalVariablesConverted, "Number of global variables converted");
STATISTIC(NumVariables, "Number of global variables removed");
void deleteFunction(Function &F) {
// This will set the linkage to external
F.deleteBody();
++NumRemovals;
}
static std::string getNewName(Module &M, const GlobalValue &GV) {
return GV.getName().str() + ".__uniq" + getUniqueModuleId(&M);
}
/// Create a copy of the thinlto import, mark it local, and redirect direct
/// calls to the copy. Only direct calls are replaced, so that e.g. indirect
/// call function pointer tests would use the global identity of the function.
///
/// Currently, Value Profiling ("VP") MD_prof data isn't updated to refer to the
/// clone's GUID (which will be different, because the name and linkage is
/// different), under the assumption that the last consumer of this data is
/// upstream the pipeline (e.g. ICP).
static void convertToLocalCopy(Module &M, Function &F) {
assert(F.hasAvailableExternallyLinkage());
assert(!F.isDeclaration());
// If we can't find a single use that's a call, just delete the function.
if (F.uses().end() == llvm::find_if(F.uses(), [&](Use &U) {
return isa<CallBase>(U.getUser());
}))
return deleteFunction(F);
auto OrigName = F.getName().str();
// Build a new name. We still need the old name (see below).
// We could just rely on internal linking allowing 2 modules have internal
// functions with the same name, but that just creates more trouble than
// necessary e.g. distinguishing profiles or debugging. Instead, we append the
// module identifier.
std::string NewName = getNewName(M, F);
F.setName(NewName);
if (auto *SP = F.getSubprogram())
SP->replaceLinkageName(MDString::get(F.getParent()->getContext(), NewName));
F.setLinkage(GlobalValue::InternalLinkage);
// Now make a declaration for the old name. We'll use it if there are non-call
// uses. For those, it would be incorrect to replace them with the local copy:
// for example, one such use could be taking the address of the function and
// passing it to an external function, which, in turn, might compare the
// function pointer to the original (non-local) function pointer, e.g. as part
// of indirect call promotion.
auto *Decl =
Function::Create(F.getFunctionType(), GlobalValue::ExternalLinkage,
F.getAddressSpace(), OrigName, F.getParent());
F.replaceUsesWithIf(Decl,
[&](Use &U) { return !isa<CallBase>(U.getUser()); });
++NumFunctionsConverted;
}
/// Similar to the function above, this is to convert an externally available
/// global variable to local.
static void convertToLocalCopy(Module &M, GlobalVariable &GV) {
assert(GV.hasAvailableExternallyLinkage());
GV.setName(getNewName(M, GV));
GV.setLinkage(GlobalValue::InternalLinkage);
++NumGlobalVariablesConverted;
}
static bool eliminateAvailableExternally(Module &M, bool Convert) {
bool Changed = false;
// If a global variable is available externally and in the specified address
// space, convert it to local linkage; otherwise, drop its initializer.
for (GlobalVariable &GV : M.globals()) {
if (!GV.hasAvailableExternallyLinkage())
continue;
if (ConvertGlobalVariableInAddrSpace.getNumOccurrences() &&
GV.getAddressSpace() == ConvertGlobalVariableInAddrSpace &&
!GV.use_empty()) {
convertToLocalCopy(M, GV);
Changed = true;
continue;
}
if (GV.hasInitializer()) {
Constant *Init = GV.getInitializer();
GV.setInitializer(nullptr);
if (isSafeToDestroyConstant(Init))
Init->destroyConstant();
}
GV.removeDeadConstantUsers();
GV.setLinkage(GlobalValue::ExternalLinkage);
++NumVariables;
Changed = true;
}
// Drop the bodies of available externally functions.
for (Function &F : llvm::make_early_inc_range(M)) {
if (F.isDeclaration() || !F.hasAvailableExternallyLinkage())
continue;
if (Convert || ConvertToLocal)
convertToLocalCopy(M, F);
else
deleteFunction(F);
F.removeDeadConstantUsers();
Changed = true;
}
return Changed;
}
PreservedAnalyses
EliminateAvailableExternallyPass::run(Module &M, ModuleAnalysisManager &MAM) {
auto *CtxProf = MAM.getCachedResult<CtxProfAnalysis>(M);
// Convert to local instead of eliding if we use contextual profiling in this
// module. This is because the IPO decisions performed with contextual
// information will likely differ from decisions made without. For a function
// that's imported, its optimizations will, thus, differ, and be specialized
// for this contextual information. Eliding it in favor of the original would
// undo these optimizations.
if (!eliminateAvailableExternally(
M, /*Convert=*/(CtxProf && CtxProf->isInSpecializedModule())))
return PreservedAnalyses::all();
return PreservedAnalyses::none();
}
|
