10b57cec5SDimitry Andric //===- ModuleSummaryAnalysis.cpp - Module summary index builder -----------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This pass builds a ModuleSummaryIndex object for the module, to be written
100b57cec5SDimitry Andric // to bitcode or LLVM assembly.
110b57cec5SDimitry Andric //
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric
140b57cec5SDimitry Andric #include "llvm/Analysis/ModuleSummaryAnalysis.h"
150b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
160b57cec5SDimitry Andric #include "llvm/ADT/DenseSet.h"
170b57cec5SDimitry Andric #include "llvm/ADT/MapVector.h"
180b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h"
190b57cec5SDimitry Andric #include "llvm/ADT/SetVector.h"
200b57cec5SDimitry Andric #include "llvm/ADT/SmallPtrSet.h"
210b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h"
220b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
230b57cec5SDimitry Andric #include "llvm/Analysis/BlockFrequencyInfo.h"
240b57cec5SDimitry Andric #include "llvm/Analysis/BranchProbabilityInfo.h"
250b57cec5SDimitry Andric #include "llvm/Analysis/IndirectCallPromotionAnalysis.h"
260b57cec5SDimitry Andric #include "llvm/Analysis/LoopInfo.h"
27bdd1243dSDimitry Andric #include "llvm/Analysis/MemoryProfileInfo.h"
280b57cec5SDimitry Andric #include "llvm/Analysis/ProfileSummaryInfo.h"
295ffd83dbSDimitry Andric #include "llvm/Analysis/StackSafetyAnalysis.h"
300b57cec5SDimitry Andric #include "llvm/Analysis/TypeMetadataUtils.h"
310b57cec5SDimitry Andric #include "llvm/IR/Attributes.h"
320b57cec5SDimitry Andric #include "llvm/IR/BasicBlock.h"
330b57cec5SDimitry Andric #include "llvm/IR/Constant.h"
340b57cec5SDimitry Andric #include "llvm/IR/Constants.h"
350b57cec5SDimitry Andric #include "llvm/IR/Dominators.h"
360b57cec5SDimitry Andric #include "llvm/IR/Function.h"
370b57cec5SDimitry Andric #include "llvm/IR/GlobalAlias.h"
380b57cec5SDimitry Andric #include "llvm/IR/GlobalValue.h"
390b57cec5SDimitry Andric #include "llvm/IR/GlobalVariable.h"
400b57cec5SDimitry Andric #include "llvm/IR/Instructions.h"
410b57cec5SDimitry Andric #include "llvm/IR/IntrinsicInst.h"
420b57cec5SDimitry Andric #include "llvm/IR/Metadata.h"
430b57cec5SDimitry Andric #include "llvm/IR/Module.h"
440b57cec5SDimitry Andric #include "llvm/IR/ModuleSummaryIndex.h"
450b57cec5SDimitry Andric #include "llvm/IR/Use.h"
460b57cec5SDimitry Andric #include "llvm/IR/User.h"
47480093f4SDimitry Andric #include "llvm/InitializePasses.h"
480b57cec5SDimitry Andric #include "llvm/Object/ModuleSymbolTable.h"
490b57cec5SDimitry Andric #include "llvm/Object/SymbolicFile.h"
500b57cec5SDimitry Andric #include "llvm/Pass.h"
510b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
520b57cec5SDimitry Andric #include "llvm/Support/CommandLine.h"
53fe6060f1SDimitry Andric #include "llvm/Support/FileSystem.h"
540b57cec5SDimitry Andric #include <algorithm>
550b57cec5SDimitry Andric #include <cassert>
560b57cec5SDimitry Andric #include <cstdint>
570b57cec5SDimitry Andric #include <vector>
580b57cec5SDimitry Andric
590b57cec5SDimitry Andric using namespace llvm;
60bdd1243dSDimitry Andric using namespace llvm::memprof;
610b57cec5SDimitry Andric
620b57cec5SDimitry Andric #define DEBUG_TYPE "module-summary-analysis"
630b57cec5SDimitry Andric
640b57cec5SDimitry Andric // Option to force edges cold which will block importing when the
650b57cec5SDimitry Andric // -import-cold-multiplier is set to 0. Useful for debugging.
66bdd1243dSDimitry Andric namespace llvm {
670b57cec5SDimitry Andric FunctionSummary::ForceSummaryHotnessType ForceSummaryEdgesCold =
680b57cec5SDimitry Andric FunctionSummary::FSHT_None;
69bdd1243dSDimitry Andric } // namespace llvm
70bdd1243dSDimitry Andric
71bdd1243dSDimitry Andric static cl::opt<FunctionSummary::ForceSummaryHotnessType, true> FSEC(
720b57cec5SDimitry Andric "force-summary-edges-cold", cl::Hidden, cl::location(ForceSummaryEdgesCold),
730b57cec5SDimitry Andric cl::desc("Force all edges in the function summary to cold"),
740b57cec5SDimitry Andric cl::values(clEnumValN(FunctionSummary::FSHT_None, "none", "None."),
750b57cec5SDimitry Andric clEnumValN(FunctionSummary::FSHT_AllNonCritical,
760b57cec5SDimitry Andric "all-non-critical", "All non-critical edges."),
770b57cec5SDimitry Andric clEnumValN(FunctionSummary::FSHT_All, "all", "All edges.")));
780b57cec5SDimitry Andric
79bdd1243dSDimitry Andric static cl::opt<std::string> ModuleSummaryDotFile(
80bdd1243dSDimitry Andric "module-summary-dot-file", cl::Hidden, cl::value_desc("filename"),
81bdd1243dSDimitry Andric cl::desc("File to emit dot graph of new summary into"));
820b57cec5SDimitry Andric
83fe013be4SDimitry Andric extern cl::opt<bool> ScalePartialSampleProfileWorkingSetSize;
84fe013be4SDimitry Andric
850b57cec5SDimitry Andric // Walk through the operands of a given User via worklist iteration and populate
860b57cec5SDimitry Andric // the set of GlobalValue references encountered. Invoked either on an
870b57cec5SDimitry Andric // Instruction or a GlobalVariable (which walks its initializer).
880b57cec5SDimitry Andric // Return true if any of the operands contains blockaddress. This is important
890b57cec5SDimitry Andric // to know when computing summary for global var, because if global variable
900b57cec5SDimitry Andric // references basic block address we can't import it separately from function
910b57cec5SDimitry Andric // containing that basic block. For simplicity we currently don't import such
920b57cec5SDimitry Andric // global vars at all. When importing function we aren't interested if any
930b57cec5SDimitry Andric // instruction in it takes an address of any basic block, because instruction
940b57cec5SDimitry Andric // can only take an address of basic block located in the same function.
findRefEdges(ModuleSummaryIndex & Index,const User * CurUser,SetVector<ValueInfo,std::vector<ValueInfo>> & RefEdges,SmallPtrSet<const User *,8> & Visited)950b57cec5SDimitry Andric static bool findRefEdges(ModuleSummaryIndex &Index, const User *CurUser,
96*c9157d92SDimitry Andric SetVector<ValueInfo, std::vector<ValueInfo>> &RefEdges,
970b57cec5SDimitry Andric SmallPtrSet<const User *, 8> &Visited) {
980b57cec5SDimitry Andric bool HasBlockAddress = false;
990b57cec5SDimitry Andric SmallVector<const User *, 32> Worklist;
100fe6060f1SDimitry Andric if (Visited.insert(CurUser).second)
1010b57cec5SDimitry Andric Worklist.push_back(CurUser);
1020b57cec5SDimitry Andric
1030b57cec5SDimitry Andric while (!Worklist.empty()) {
1040b57cec5SDimitry Andric const User *U = Worklist.pop_back_val();
1055ffd83dbSDimitry Andric const auto *CB = dyn_cast<CallBase>(U);
1060b57cec5SDimitry Andric
1070b57cec5SDimitry Andric for (const auto &OI : U->operands()) {
1080b57cec5SDimitry Andric const User *Operand = dyn_cast<User>(OI);
1090b57cec5SDimitry Andric if (!Operand)
1100b57cec5SDimitry Andric continue;
1110b57cec5SDimitry Andric if (isa<BlockAddress>(Operand)) {
1120b57cec5SDimitry Andric HasBlockAddress = true;
1130b57cec5SDimitry Andric continue;
1140b57cec5SDimitry Andric }
1150b57cec5SDimitry Andric if (auto *GV = dyn_cast<GlobalValue>(Operand)) {
1160b57cec5SDimitry Andric // We have a reference to a global value. This should be added to
1170b57cec5SDimitry Andric // the reference set unless it is a callee. Callees are handled
1180b57cec5SDimitry Andric // specially by WriteFunction and are added to a separate list.
1195ffd83dbSDimitry Andric if (!(CB && CB->isCallee(&OI)))
1200b57cec5SDimitry Andric RefEdges.insert(Index.getOrInsertValueInfo(GV));
1210b57cec5SDimitry Andric continue;
1220b57cec5SDimitry Andric }
123fe6060f1SDimitry Andric if (Visited.insert(Operand).second)
1240b57cec5SDimitry Andric Worklist.push_back(Operand);
1250b57cec5SDimitry Andric }
1260b57cec5SDimitry Andric }
1270b57cec5SDimitry Andric return HasBlockAddress;
1280b57cec5SDimitry Andric }
1290b57cec5SDimitry Andric
getHotness(uint64_t ProfileCount,ProfileSummaryInfo * PSI)1300b57cec5SDimitry Andric static CalleeInfo::HotnessType getHotness(uint64_t ProfileCount,
1310b57cec5SDimitry Andric ProfileSummaryInfo *PSI) {
1320b57cec5SDimitry Andric if (!PSI)
1330b57cec5SDimitry Andric return CalleeInfo::HotnessType::Unknown;
1340b57cec5SDimitry Andric if (PSI->isHotCount(ProfileCount))
1350b57cec5SDimitry Andric return CalleeInfo::HotnessType::Hot;
1360b57cec5SDimitry Andric if (PSI->isColdCount(ProfileCount))
1370b57cec5SDimitry Andric return CalleeInfo::HotnessType::Cold;
1380b57cec5SDimitry Andric return CalleeInfo::HotnessType::None;
1390b57cec5SDimitry Andric }
1400b57cec5SDimitry Andric
isNonRenamableLocal(const GlobalValue & GV)1410b57cec5SDimitry Andric static bool isNonRenamableLocal(const GlobalValue &GV) {
1420b57cec5SDimitry Andric return GV.hasSection() && GV.hasLocalLinkage();
1430b57cec5SDimitry Andric }
1440b57cec5SDimitry Andric
1450b57cec5SDimitry Andric /// Determine whether this call has all constant integer arguments (excluding
1460b57cec5SDimitry Andric /// "this") and summarize it to VCalls or ConstVCalls as appropriate.
addVCallToSet(DevirtCallSite Call,GlobalValue::GUID Guid,SetVector<FunctionSummary::VFuncId,std::vector<FunctionSummary::VFuncId>> & VCalls,SetVector<FunctionSummary::ConstVCall,std::vector<FunctionSummary::ConstVCall>> & ConstVCalls)147*c9157d92SDimitry Andric static void addVCallToSet(
148*c9157d92SDimitry Andric DevirtCallSite Call, GlobalValue::GUID Guid,
149*c9157d92SDimitry Andric SetVector<FunctionSummary::VFuncId, std::vector<FunctionSummary::VFuncId>>
150*c9157d92SDimitry Andric &VCalls,
151*c9157d92SDimitry Andric SetVector<FunctionSummary::ConstVCall,
152*c9157d92SDimitry Andric std::vector<FunctionSummary::ConstVCall>> &ConstVCalls) {
1530b57cec5SDimitry Andric std::vector<uint64_t> Args;
1540b57cec5SDimitry Andric // Start from the second argument to skip the "this" pointer.
155e8d8bef9SDimitry Andric for (auto &Arg : drop_begin(Call.CB.args())) {
1560b57cec5SDimitry Andric auto *CI = dyn_cast<ConstantInt>(Arg);
1570b57cec5SDimitry Andric if (!CI || CI->getBitWidth() > 64) {
1580b57cec5SDimitry Andric VCalls.insert({Guid, Call.Offset});
1590b57cec5SDimitry Andric return;
1600b57cec5SDimitry Andric }
1610b57cec5SDimitry Andric Args.push_back(CI->getZExtValue());
1620b57cec5SDimitry Andric }
1630b57cec5SDimitry Andric ConstVCalls.insert({{Guid, Call.Offset}, std::move(Args)});
1640b57cec5SDimitry Andric }
1650b57cec5SDimitry Andric
1660b57cec5SDimitry Andric /// If this intrinsic call requires that we add information to the function
1670b57cec5SDimitry Andric /// summary, do so via the non-constant reference arguments.
addIntrinsicToSummary(const CallInst * CI,SetVector<GlobalValue::GUID,std::vector<GlobalValue::GUID>> & TypeTests,SetVector<FunctionSummary::VFuncId,std::vector<FunctionSummary::VFuncId>> & TypeTestAssumeVCalls,SetVector<FunctionSummary::VFuncId,std::vector<FunctionSummary::VFuncId>> & TypeCheckedLoadVCalls,SetVector<FunctionSummary::ConstVCall,std::vector<FunctionSummary::ConstVCall>> & TypeTestAssumeConstVCalls,SetVector<FunctionSummary::ConstVCall,std::vector<FunctionSummary::ConstVCall>> & TypeCheckedLoadConstVCalls,DominatorTree & DT)1680b57cec5SDimitry Andric static void addIntrinsicToSummary(
169*c9157d92SDimitry Andric const CallInst *CI,
170*c9157d92SDimitry Andric SetVector<GlobalValue::GUID, std::vector<GlobalValue::GUID>> &TypeTests,
171*c9157d92SDimitry Andric SetVector<FunctionSummary::VFuncId, std::vector<FunctionSummary::VFuncId>>
172*c9157d92SDimitry Andric &TypeTestAssumeVCalls,
173*c9157d92SDimitry Andric SetVector<FunctionSummary::VFuncId, std::vector<FunctionSummary::VFuncId>>
174*c9157d92SDimitry Andric &TypeCheckedLoadVCalls,
175*c9157d92SDimitry Andric SetVector<FunctionSummary::ConstVCall,
176*c9157d92SDimitry Andric std::vector<FunctionSummary::ConstVCall>>
177*c9157d92SDimitry Andric &TypeTestAssumeConstVCalls,
178*c9157d92SDimitry Andric SetVector<FunctionSummary::ConstVCall,
179*c9157d92SDimitry Andric std::vector<FunctionSummary::ConstVCall>>
180*c9157d92SDimitry Andric &TypeCheckedLoadConstVCalls,
1810b57cec5SDimitry Andric DominatorTree &DT) {
1820b57cec5SDimitry Andric switch (CI->getCalledFunction()->getIntrinsicID()) {
183972a253aSDimitry Andric case Intrinsic::type_test:
184972a253aSDimitry Andric case Intrinsic::public_type_test: {
1850b57cec5SDimitry Andric auto *TypeMDVal = cast<MetadataAsValue>(CI->getArgOperand(1));
1860b57cec5SDimitry Andric auto *TypeId = dyn_cast<MDString>(TypeMDVal->getMetadata());
1870b57cec5SDimitry Andric if (!TypeId)
1880b57cec5SDimitry Andric break;
1890b57cec5SDimitry Andric GlobalValue::GUID Guid = GlobalValue::getGUID(TypeId->getString());
1900b57cec5SDimitry Andric
1910b57cec5SDimitry Andric // Produce a summary from type.test intrinsics. We only summarize type.test
1920b57cec5SDimitry Andric // intrinsics that are used other than by an llvm.assume intrinsic.
1930b57cec5SDimitry Andric // Intrinsics that are assumed are relevant only to the devirtualization
1940b57cec5SDimitry Andric // pass, not the type test lowering pass.
1950b57cec5SDimitry Andric bool HasNonAssumeUses = llvm::any_of(CI->uses(), [](const Use &CIU) {
196fe6060f1SDimitry Andric return !isa<AssumeInst>(CIU.getUser());
1970b57cec5SDimitry Andric });
1980b57cec5SDimitry Andric if (HasNonAssumeUses)
1990b57cec5SDimitry Andric TypeTests.insert(Guid);
2000b57cec5SDimitry Andric
2010b57cec5SDimitry Andric SmallVector<DevirtCallSite, 4> DevirtCalls;
2020b57cec5SDimitry Andric SmallVector<CallInst *, 4> Assumes;
2030b57cec5SDimitry Andric findDevirtualizableCallsForTypeTest(DevirtCalls, Assumes, CI, DT);
2040b57cec5SDimitry Andric for (auto &Call : DevirtCalls)
2050b57cec5SDimitry Andric addVCallToSet(Call, Guid, TypeTestAssumeVCalls,
2060b57cec5SDimitry Andric TypeTestAssumeConstVCalls);
2070b57cec5SDimitry Andric
2080b57cec5SDimitry Andric break;
2090b57cec5SDimitry Andric }
2100b57cec5SDimitry Andric
211fe013be4SDimitry Andric case Intrinsic::type_checked_load_relative:
2120b57cec5SDimitry Andric case Intrinsic::type_checked_load: {
2130b57cec5SDimitry Andric auto *TypeMDVal = cast<MetadataAsValue>(CI->getArgOperand(2));
2140b57cec5SDimitry Andric auto *TypeId = dyn_cast<MDString>(TypeMDVal->getMetadata());
2150b57cec5SDimitry Andric if (!TypeId)
2160b57cec5SDimitry Andric break;
2170b57cec5SDimitry Andric GlobalValue::GUID Guid = GlobalValue::getGUID(TypeId->getString());
2180b57cec5SDimitry Andric
2190b57cec5SDimitry Andric SmallVector<DevirtCallSite, 4> DevirtCalls;
2200b57cec5SDimitry Andric SmallVector<Instruction *, 4> LoadedPtrs;
2210b57cec5SDimitry Andric SmallVector<Instruction *, 4> Preds;
2220b57cec5SDimitry Andric bool HasNonCallUses = false;
2230b57cec5SDimitry Andric findDevirtualizableCallsForTypeCheckedLoad(DevirtCalls, LoadedPtrs, Preds,
2240b57cec5SDimitry Andric HasNonCallUses, CI, DT);
2250b57cec5SDimitry Andric // Any non-call uses of the result of llvm.type.checked.load will
2260b57cec5SDimitry Andric // prevent us from optimizing away the llvm.type.test.
2270b57cec5SDimitry Andric if (HasNonCallUses)
2280b57cec5SDimitry Andric TypeTests.insert(Guid);
2290b57cec5SDimitry Andric for (auto &Call : DevirtCalls)
2300b57cec5SDimitry Andric addVCallToSet(Call, Guid, TypeCheckedLoadVCalls,
2310b57cec5SDimitry Andric TypeCheckedLoadConstVCalls);
2320b57cec5SDimitry Andric
2330b57cec5SDimitry Andric break;
2340b57cec5SDimitry Andric }
2350b57cec5SDimitry Andric default:
2360b57cec5SDimitry Andric break;
2370b57cec5SDimitry Andric }
2380b57cec5SDimitry Andric }
2390b57cec5SDimitry Andric
isNonVolatileLoad(const Instruction * I)2400b57cec5SDimitry Andric static bool isNonVolatileLoad(const Instruction *I) {
2410b57cec5SDimitry Andric if (const auto *LI = dyn_cast<LoadInst>(I))
2420b57cec5SDimitry Andric return !LI->isVolatile();
2430b57cec5SDimitry Andric
2440b57cec5SDimitry Andric return false;
2450b57cec5SDimitry Andric }
2460b57cec5SDimitry Andric
isNonVolatileStore(const Instruction * I)2470b57cec5SDimitry Andric static bool isNonVolatileStore(const Instruction *I) {
2480b57cec5SDimitry Andric if (const auto *SI = dyn_cast<StoreInst>(I))
2490b57cec5SDimitry Andric return !SI->isVolatile();
2500b57cec5SDimitry Andric
2510b57cec5SDimitry Andric return false;
2520b57cec5SDimitry Andric }
2530b57cec5SDimitry Andric
2540eae32dcSDimitry Andric // Returns true if the function definition must be unreachable.
2550eae32dcSDimitry Andric //
2560eae32dcSDimitry Andric // Note if this helper function returns true, `F` is guaranteed
2570eae32dcSDimitry Andric // to be unreachable; if it returns false, `F` might still
2580eae32dcSDimitry Andric // be unreachable but not covered by this helper function.
mustBeUnreachableFunction(const Function & F)2590eae32dcSDimitry Andric static bool mustBeUnreachableFunction(const Function &F) {
2600eae32dcSDimitry Andric // A function must be unreachable if its entry block ends with an
2610eae32dcSDimitry Andric // 'unreachable'.
2620eae32dcSDimitry Andric assert(!F.isDeclaration());
2630eae32dcSDimitry Andric return isa<UnreachableInst>(F.getEntryBlock().getTerminator());
2640eae32dcSDimitry Andric }
2650eae32dcSDimitry Andric
computeFunctionSummary(ModuleSummaryIndex & Index,const Module & M,const Function & F,BlockFrequencyInfo * BFI,ProfileSummaryInfo * PSI,DominatorTree & DT,bool HasLocalsInUsedOrAsm,DenseSet<GlobalValue::GUID> & CantBePromoted,bool IsThinLTO,std::function<const StackSafetyInfo * (const Function & F)> GetSSICallback)2665ffd83dbSDimitry Andric static void computeFunctionSummary(
2675ffd83dbSDimitry Andric ModuleSummaryIndex &Index, const Module &M, const Function &F,
2685ffd83dbSDimitry Andric BlockFrequencyInfo *BFI, ProfileSummaryInfo *PSI, DominatorTree &DT,
2695ffd83dbSDimitry Andric bool HasLocalsInUsedOrAsm, DenseSet<GlobalValue::GUID> &CantBePromoted,
2705ffd83dbSDimitry Andric bool IsThinLTO,
2715ffd83dbSDimitry Andric std::function<const StackSafetyInfo *(const Function &F)> GetSSICallback) {
2720b57cec5SDimitry Andric // Summary not currently supported for anonymous functions, they should
2730b57cec5SDimitry Andric // have been named.
2740b57cec5SDimitry Andric assert(F.hasName());
2750b57cec5SDimitry Andric
2760b57cec5SDimitry Andric unsigned NumInsts = 0;
2770b57cec5SDimitry Andric // Map from callee ValueId to profile count. Used to accumulate profile
2780b57cec5SDimitry Andric // counts for all static calls to a given callee.
279fe013be4SDimitry Andric MapVector<ValueInfo, CalleeInfo, DenseMap<ValueInfo, unsigned>,
280fe013be4SDimitry Andric std::vector<std::pair<ValueInfo, CalleeInfo>>>
281fe013be4SDimitry Andric CallGraphEdges;
282*c9157d92SDimitry Andric SetVector<ValueInfo, std::vector<ValueInfo>> RefEdges, LoadRefEdges,
283*c9157d92SDimitry Andric StoreRefEdges;
284*c9157d92SDimitry Andric SetVector<GlobalValue::GUID, std::vector<GlobalValue::GUID>> TypeTests;
285*c9157d92SDimitry Andric SetVector<FunctionSummary::VFuncId, std::vector<FunctionSummary::VFuncId>>
286*c9157d92SDimitry Andric TypeTestAssumeVCalls, TypeCheckedLoadVCalls;
287*c9157d92SDimitry Andric SetVector<FunctionSummary::ConstVCall,
288*c9157d92SDimitry Andric std::vector<FunctionSummary::ConstVCall>>
289*c9157d92SDimitry Andric TypeTestAssumeConstVCalls, TypeCheckedLoadConstVCalls;
2900b57cec5SDimitry Andric ICallPromotionAnalysis ICallAnalysis;
2910b57cec5SDimitry Andric SmallPtrSet<const User *, 8> Visited;
2920b57cec5SDimitry Andric
2930b57cec5SDimitry Andric // Add personality function, prefix data and prologue data to function's ref
2940b57cec5SDimitry Andric // list.
2950b57cec5SDimitry Andric findRefEdges(Index, &F, RefEdges, Visited);
2960b57cec5SDimitry Andric std::vector<const Instruction *> NonVolatileLoads;
2970b57cec5SDimitry Andric std::vector<const Instruction *> NonVolatileStores;
2980b57cec5SDimitry Andric
299bdd1243dSDimitry Andric std::vector<CallsiteInfo> Callsites;
300bdd1243dSDimitry Andric std::vector<AllocInfo> Allocs;
301bdd1243dSDimitry Andric
302fe013be4SDimitry Andric #ifndef NDEBUG
303fe013be4SDimitry Andric DenseSet<const CallBase *> CallsThatMayHaveMemprofSummary;
304fe013be4SDimitry Andric #endif
305fe013be4SDimitry Andric
3060b57cec5SDimitry Andric bool HasInlineAsmMaybeReferencingInternal = false;
307349cc55cSDimitry Andric bool HasIndirBranchToBlockAddress = false;
308*c9157d92SDimitry Andric bool HasIFuncCall = false;
309349cc55cSDimitry Andric bool HasUnknownCall = false;
310349cc55cSDimitry Andric bool MayThrow = false;
311349cc55cSDimitry Andric for (const BasicBlock &BB : F) {
312349cc55cSDimitry Andric // We don't allow inlining of function with indirect branch to blockaddress.
313349cc55cSDimitry Andric // If the blockaddress escapes the function, e.g., via a global variable,
314349cc55cSDimitry Andric // inlining may lead to an invalid cross-function reference. So we shouldn't
315349cc55cSDimitry Andric // import such function either.
316349cc55cSDimitry Andric if (BB.hasAddressTaken()) {
317349cc55cSDimitry Andric for (User *U : BlockAddress::get(const_cast<BasicBlock *>(&BB))->users())
318349cc55cSDimitry Andric if (!isa<CallBrInst>(*U)) {
319349cc55cSDimitry Andric HasIndirBranchToBlockAddress = true;
320349cc55cSDimitry Andric break;
321349cc55cSDimitry Andric }
322349cc55cSDimitry Andric }
323349cc55cSDimitry Andric
3240b57cec5SDimitry Andric for (const Instruction &I : BB) {
325349cc55cSDimitry Andric if (I.isDebugOrPseudoInst())
3260b57cec5SDimitry Andric continue;
3270b57cec5SDimitry Andric ++NumInsts;
328349cc55cSDimitry Andric
3290b57cec5SDimitry Andric // Regular LTO module doesn't participate in ThinLTO import,
3300b57cec5SDimitry Andric // so no reference from it can be read/writeonly, since this
3310b57cec5SDimitry Andric // would require importing variable as local copy
3320b57cec5SDimitry Andric if (IsThinLTO) {
3330b57cec5SDimitry Andric if (isNonVolatileLoad(&I)) {
3340b57cec5SDimitry Andric // Postpone processing of non-volatile load instructions
3350b57cec5SDimitry Andric // See comments below
3360b57cec5SDimitry Andric Visited.insert(&I);
3370b57cec5SDimitry Andric NonVolatileLoads.push_back(&I);
3380b57cec5SDimitry Andric continue;
3390b57cec5SDimitry Andric } else if (isNonVolatileStore(&I)) {
3400b57cec5SDimitry Andric Visited.insert(&I);
3410b57cec5SDimitry Andric NonVolatileStores.push_back(&I);
3420b57cec5SDimitry Andric // All references from second operand of store (destination address)
3430b57cec5SDimitry Andric // can be considered write-only if they're not referenced by any
3440b57cec5SDimitry Andric // non-store instruction. References from first operand of store
3450b57cec5SDimitry Andric // (stored value) can't be treated either as read- or as write-only
3460b57cec5SDimitry Andric // so we add them to RefEdges as we do with all other instructions
3470b57cec5SDimitry Andric // except non-volatile load.
3480b57cec5SDimitry Andric Value *Stored = I.getOperand(0);
3490b57cec5SDimitry Andric if (auto *GV = dyn_cast<GlobalValue>(Stored))
3500b57cec5SDimitry Andric // findRefEdges will try to examine GV operands, so instead
3510b57cec5SDimitry Andric // of calling it we should add GV to RefEdges directly.
3520b57cec5SDimitry Andric RefEdges.insert(Index.getOrInsertValueInfo(GV));
3530b57cec5SDimitry Andric else if (auto *U = dyn_cast<User>(Stored))
3540b57cec5SDimitry Andric findRefEdges(Index, U, RefEdges, Visited);
3550b57cec5SDimitry Andric continue;
3560b57cec5SDimitry Andric }
3570b57cec5SDimitry Andric }
3580b57cec5SDimitry Andric findRefEdges(Index, &I, RefEdges, Visited);
3595ffd83dbSDimitry Andric const auto *CB = dyn_cast<CallBase>(&I);
360349cc55cSDimitry Andric if (!CB) {
361349cc55cSDimitry Andric if (I.mayThrow())
362349cc55cSDimitry Andric MayThrow = true;
3630b57cec5SDimitry Andric continue;
364349cc55cSDimitry Andric }
3650b57cec5SDimitry Andric
3660b57cec5SDimitry Andric const auto *CI = dyn_cast<CallInst>(&I);
3670b57cec5SDimitry Andric // Since we don't know exactly which local values are referenced in inline
3680b57cec5SDimitry Andric // assembly, conservatively mark the function as possibly referencing
3690b57cec5SDimitry Andric // a local value from inline assembly to ensure we don't export a
3700b57cec5SDimitry Andric // reference (which would require renaming and promotion of the
3710b57cec5SDimitry Andric // referenced value).
3720b57cec5SDimitry Andric if (HasLocalsInUsedOrAsm && CI && CI->isInlineAsm())
3730b57cec5SDimitry Andric HasInlineAsmMaybeReferencingInternal = true;
3740b57cec5SDimitry Andric
3755ffd83dbSDimitry Andric auto *CalledValue = CB->getCalledOperand();
3765ffd83dbSDimitry Andric auto *CalledFunction = CB->getCalledFunction();
3770b57cec5SDimitry Andric if (CalledValue && !CalledFunction) {
3788bcb0991SDimitry Andric CalledValue = CalledValue->stripPointerCasts();
3790b57cec5SDimitry Andric // Stripping pointer casts can reveal a called function.
3800b57cec5SDimitry Andric CalledFunction = dyn_cast<Function>(CalledValue);
3810b57cec5SDimitry Andric }
3820b57cec5SDimitry Andric // Check if this is an alias to a function. If so, get the
3830b57cec5SDimitry Andric // called aliasee for the checks below.
3840b57cec5SDimitry Andric if (auto *GA = dyn_cast<GlobalAlias>(CalledValue)) {
3850b57cec5SDimitry Andric assert(!CalledFunction && "Expected null called function in callsite for alias");
386349cc55cSDimitry Andric CalledFunction = dyn_cast<Function>(GA->getAliaseeObject());
3870b57cec5SDimitry Andric }
3880b57cec5SDimitry Andric // Check if this is a direct call to a known function or a known
3890b57cec5SDimitry Andric // intrinsic, or an indirect call with profile data.
3900b57cec5SDimitry Andric if (CalledFunction) {
3910b57cec5SDimitry Andric if (CI && CalledFunction->isIntrinsic()) {
3920b57cec5SDimitry Andric addIntrinsicToSummary(
3930b57cec5SDimitry Andric CI, TypeTests, TypeTestAssumeVCalls, TypeCheckedLoadVCalls,
3940b57cec5SDimitry Andric TypeTestAssumeConstVCalls, TypeCheckedLoadConstVCalls, DT);
3950b57cec5SDimitry Andric continue;
3960b57cec5SDimitry Andric }
3970b57cec5SDimitry Andric // We should have named any anonymous globals
3980b57cec5SDimitry Andric assert(CalledFunction->hasName());
3995ffd83dbSDimitry Andric auto ScaledCount = PSI->getProfileCount(*CB, BFI);
40081ad6265SDimitry Andric auto Hotness = ScaledCount ? getHotness(*ScaledCount, PSI)
4010b57cec5SDimitry Andric : CalleeInfo::HotnessType::Unknown;
4020b57cec5SDimitry Andric if (ForceSummaryEdgesCold != FunctionSummary::FSHT_None)
4030b57cec5SDimitry Andric Hotness = CalleeInfo::HotnessType::Cold;
4040b57cec5SDimitry Andric
4050b57cec5SDimitry Andric // Use the original CalledValue, in case it was an alias. We want
4060b57cec5SDimitry Andric // to record the call edge to the alias in that case. Eventually
4070b57cec5SDimitry Andric // an alias summary will be created to associate the alias and
4080b57cec5SDimitry Andric // aliasee.
4090b57cec5SDimitry Andric auto &ValueInfo = CallGraphEdges[Index.getOrInsertValueInfo(
4100b57cec5SDimitry Andric cast<GlobalValue>(CalledValue))];
4110b57cec5SDimitry Andric ValueInfo.updateHotness(Hotness);
412*c9157d92SDimitry Andric if (CB->isTailCall())
413*c9157d92SDimitry Andric ValueInfo.setHasTailCall(true);
4140b57cec5SDimitry Andric // Add the relative block frequency to CalleeInfo if there is no profile
4150b57cec5SDimitry Andric // information.
4160b57cec5SDimitry Andric if (BFI != nullptr && Hotness == CalleeInfo::HotnessType::Unknown) {
4170b57cec5SDimitry Andric uint64_t BBFreq = BFI->getBlockFreq(&BB).getFrequency();
418*c9157d92SDimitry Andric uint64_t EntryFreq = BFI->getEntryFreq().getFrequency();
4190b57cec5SDimitry Andric ValueInfo.updateRelBlockFreq(BBFreq, EntryFreq);
4200b57cec5SDimitry Andric }
4210b57cec5SDimitry Andric } else {
422349cc55cSDimitry Andric HasUnknownCall = true;
423*c9157d92SDimitry Andric // If F is imported, a local linkage ifunc (e.g. target_clones on a
424*c9157d92SDimitry Andric // static function) called by F will be cloned. Since summaries don't
425*c9157d92SDimitry Andric // track ifunc, we do not know implementation functions referenced by
426*c9157d92SDimitry Andric // the ifunc resolver need to be promoted in the exporter, and we will
427*c9157d92SDimitry Andric // get linker errors due to cloned declarations for implementation
428*c9157d92SDimitry Andric // functions. As a simple fix, just mark F as not eligible for import.
429*c9157d92SDimitry Andric // Non-local ifunc is not cloned and does not have the issue.
430*c9157d92SDimitry Andric if (auto *GI = dyn_cast_if_present<GlobalIFunc>(CalledValue))
431*c9157d92SDimitry Andric if (GI->hasLocalLinkage())
432*c9157d92SDimitry Andric HasIFuncCall = true;
4330b57cec5SDimitry Andric // Skip inline assembly calls.
4340b57cec5SDimitry Andric if (CI && CI->isInlineAsm())
4350b57cec5SDimitry Andric continue;
4360b57cec5SDimitry Andric // Skip direct calls.
4370b57cec5SDimitry Andric if (!CalledValue || isa<Constant>(CalledValue))
4380b57cec5SDimitry Andric continue;
4390b57cec5SDimitry Andric
4400b57cec5SDimitry Andric // Check if the instruction has a callees metadata. If so, add callees
4410b57cec5SDimitry Andric // to CallGraphEdges to reflect the references from the metadata, and
4420b57cec5SDimitry Andric // to enable importing for subsequent indirect call promotion and
4430b57cec5SDimitry Andric // inlining.
4440b57cec5SDimitry Andric if (auto *MD = I.getMetadata(LLVMContext::MD_callees)) {
445fcaf7f86SDimitry Andric for (const auto &Op : MD->operands()) {
4460b57cec5SDimitry Andric Function *Callee = mdconst::extract_or_null<Function>(Op);
4470b57cec5SDimitry Andric if (Callee)
4480b57cec5SDimitry Andric CallGraphEdges[Index.getOrInsertValueInfo(Callee)];
4490b57cec5SDimitry Andric }
4500b57cec5SDimitry Andric }
4510b57cec5SDimitry Andric
4520b57cec5SDimitry Andric uint32_t NumVals, NumCandidates;
4530b57cec5SDimitry Andric uint64_t TotalCount;
4540b57cec5SDimitry Andric auto CandidateProfileData =
4550b57cec5SDimitry Andric ICallAnalysis.getPromotionCandidatesForInstruction(
4560b57cec5SDimitry Andric &I, NumVals, TotalCount, NumCandidates);
457fcaf7f86SDimitry Andric for (const auto &Candidate : CandidateProfileData)
4580b57cec5SDimitry Andric CallGraphEdges[Index.getOrInsertValueInfo(Candidate.Value)]
4590b57cec5SDimitry Andric .updateHotness(getHotness(Candidate.Count, PSI));
4600b57cec5SDimitry Andric }
461bdd1243dSDimitry Andric
462fe013be4SDimitry Andric // Summarize memprof related metadata. This is only needed for ThinLTO.
463fe013be4SDimitry Andric if (!IsThinLTO)
464fe013be4SDimitry Andric continue;
465fe013be4SDimitry Andric
466bdd1243dSDimitry Andric // TODO: Skip indirect calls for now. Need to handle these better, likely
467bdd1243dSDimitry Andric // by creating multiple Callsites, one per target, then speculatively
468bdd1243dSDimitry Andric // devirtualize while applying clone info in the ThinLTO backends. This
469bdd1243dSDimitry Andric // will also be important because we will have a different set of clone
470bdd1243dSDimitry Andric // versions per target. This handling needs to match that in the ThinLTO
471bdd1243dSDimitry Andric // backend so we handle things consistently for matching of callsite
472bdd1243dSDimitry Andric // summaries to instructions.
473bdd1243dSDimitry Andric if (!CalledFunction)
474bdd1243dSDimitry Andric continue;
475bdd1243dSDimitry Andric
476fe013be4SDimitry Andric // Ensure we keep this analysis in sync with the handling in the ThinLTO
477fe013be4SDimitry Andric // backend (see MemProfContextDisambiguation::applyImport). Save this call
478fe013be4SDimitry Andric // so that we can skip it in checking the reverse case later.
479fe013be4SDimitry Andric assert(mayHaveMemprofSummary(CB));
480fe013be4SDimitry Andric #ifndef NDEBUG
481fe013be4SDimitry Andric CallsThatMayHaveMemprofSummary.insert(CB);
482fe013be4SDimitry Andric #endif
483fe013be4SDimitry Andric
484bdd1243dSDimitry Andric // Compute the list of stack ids first (so we can trim them from the stack
485bdd1243dSDimitry Andric // ids on any MIBs).
486bdd1243dSDimitry Andric CallStack<MDNode, MDNode::op_iterator> InstCallsite(
487bdd1243dSDimitry Andric I.getMetadata(LLVMContext::MD_callsite));
488bdd1243dSDimitry Andric auto *MemProfMD = I.getMetadata(LLVMContext::MD_memprof);
489bdd1243dSDimitry Andric if (MemProfMD) {
490bdd1243dSDimitry Andric std::vector<MIBInfo> MIBs;
491bdd1243dSDimitry Andric for (auto &MDOp : MemProfMD->operands()) {
492bdd1243dSDimitry Andric auto *MIBMD = cast<const MDNode>(MDOp);
493bdd1243dSDimitry Andric MDNode *StackNode = getMIBStackNode(MIBMD);
494bdd1243dSDimitry Andric assert(StackNode);
495bdd1243dSDimitry Andric SmallVector<unsigned> StackIdIndices;
496bdd1243dSDimitry Andric CallStack<MDNode, MDNode::op_iterator> StackContext(StackNode);
497bdd1243dSDimitry Andric // Collapse out any on the allocation call (inlining).
498bdd1243dSDimitry Andric for (auto ContextIter =
499bdd1243dSDimitry Andric StackContext.beginAfterSharedPrefix(InstCallsite);
500bdd1243dSDimitry Andric ContextIter != StackContext.end(); ++ContextIter) {
501bdd1243dSDimitry Andric unsigned StackIdIdx = Index.addOrGetStackIdIndex(*ContextIter);
502bdd1243dSDimitry Andric // If this is a direct recursion, simply skip the duplicate
503bdd1243dSDimitry Andric // entries. If this is mutual recursion, handling is left to
504bdd1243dSDimitry Andric // the LTO link analysis client.
505bdd1243dSDimitry Andric if (StackIdIndices.empty() || StackIdIndices.back() != StackIdIdx)
506bdd1243dSDimitry Andric StackIdIndices.push_back(StackIdIdx);
507bdd1243dSDimitry Andric }
508bdd1243dSDimitry Andric MIBs.push_back(
509bdd1243dSDimitry Andric MIBInfo(getMIBAllocType(MIBMD), std::move(StackIdIndices)));
510bdd1243dSDimitry Andric }
511bdd1243dSDimitry Andric Allocs.push_back(AllocInfo(std::move(MIBs)));
512bdd1243dSDimitry Andric } else if (!InstCallsite.empty()) {
513bdd1243dSDimitry Andric SmallVector<unsigned> StackIdIndices;
514bdd1243dSDimitry Andric for (auto StackId : InstCallsite)
515bdd1243dSDimitry Andric StackIdIndices.push_back(Index.addOrGetStackIdIndex(StackId));
516bdd1243dSDimitry Andric // Use the original CalledValue, in case it was an alias. We want
517bdd1243dSDimitry Andric // to record the call edge to the alias in that case. Eventually
518bdd1243dSDimitry Andric // an alias summary will be created to associate the alias and
519bdd1243dSDimitry Andric // aliasee.
520bdd1243dSDimitry Andric auto CalleeValueInfo =
521bdd1243dSDimitry Andric Index.getOrInsertValueInfo(cast<GlobalValue>(CalledValue));
522bdd1243dSDimitry Andric Callsites.push_back({CalleeValueInfo, StackIdIndices});
523bdd1243dSDimitry Andric }
5240b57cec5SDimitry Andric }
525349cc55cSDimitry Andric }
526fe013be4SDimitry Andric
527fe013be4SDimitry Andric if (PSI->hasPartialSampleProfile() && ScalePartialSampleProfileWorkingSetSize)
5285ffd83dbSDimitry Andric Index.addBlockCount(F.size());
5290b57cec5SDimitry Andric
5300b57cec5SDimitry Andric std::vector<ValueInfo> Refs;
5310b57cec5SDimitry Andric if (IsThinLTO) {
5320b57cec5SDimitry Andric auto AddRefEdges = [&](const std::vector<const Instruction *> &Instrs,
533*c9157d92SDimitry Andric SetVector<ValueInfo, std::vector<ValueInfo>> &Edges,
5340b57cec5SDimitry Andric SmallPtrSet<const User *, 8> &Cache) {
5350b57cec5SDimitry Andric for (const auto *I : Instrs) {
5360b57cec5SDimitry Andric Cache.erase(I);
5370b57cec5SDimitry Andric findRefEdges(Index, I, Edges, Cache);
5380b57cec5SDimitry Andric }
5390b57cec5SDimitry Andric };
5400b57cec5SDimitry Andric
5410b57cec5SDimitry Andric // By now we processed all instructions in a function, except
5420b57cec5SDimitry Andric // non-volatile loads and non-volatile value stores. Let's find
5430b57cec5SDimitry Andric // ref edges for both of instruction sets
5440b57cec5SDimitry Andric AddRefEdges(NonVolatileLoads, LoadRefEdges, Visited);
5450b57cec5SDimitry Andric // We can add some values to the Visited set when processing load
5460b57cec5SDimitry Andric // instructions which are also used by stores in NonVolatileStores.
5470b57cec5SDimitry Andric // For example this can happen if we have following code:
5480b57cec5SDimitry Andric //
5490b57cec5SDimitry Andric // store %Derived* @foo, %Derived** bitcast (%Base** @bar to %Derived**)
5500b57cec5SDimitry Andric // %42 = load %Derived*, %Derived** bitcast (%Base** @bar to %Derived**)
5510b57cec5SDimitry Andric //
5520b57cec5SDimitry Andric // After processing loads we'll add bitcast to the Visited set, and if
5530b57cec5SDimitry Andric // we use the same set while processing stores, we'll never see store
5540b57cec5SDimitry Andric // to @bar and @bar will be mistakenly treated as readonly.
5550b57cec5SDimitry Andric SmallPtrSet<const llvm::User *, 8> StoreCache;
5560b57cec5SDimitry Andric AddRefEdges(NonVolatileStores, StoreRefEdges, StoreCache);
5570b57cec5SDimitry Andric
5580b57cec5SDimitry Andric // If both load and store instruction reference the same variable
5590b57cec5SDimitry Andric // we won't be able to optimize it. Add all such reference edges
5600b57cec5SDimitry Andric // to RefEdges set.
561fcaf7f86SDimitry Andric for (const auto &VI : StoreRefEdges)
5620b57cec5SDimitry Andric if (LoadRefEdges.remove(VI))
5630b57cec5SDimitry Andric RefEdges.insert(VI);
5640b57cec5SDimitry Andric
5650b57cec5SDimitry Andric unsigned RefCnt = RefEdges.size();
5660b57cec5SDimitry Andric // All new reference edges inserted in two loops below are either
5670b57cec5SDimitry Andric // read or write only. They will be grouped in the end of RefEdges
5680b57cec5SDimitry Andric // vector, so we can use a single integer value to identify them.
569fcaf7f86SDimitry Andric for (const auto &VI : LoadRefEdges)
5700b57cec5SDimitry Andric RefEdges.insert(VI);
5710b57cec5SDimitry Andric
5720b57cec5SDimitry Andric unsigned FirstWORef = RefEdges.size();
573fcaf7f86SDimitry Andric for (const auto &VI : StoreRefEdges)
5740b57cec5SDimitry Andric RefEdges.insert(VI);
5750b57cec5SDimitry Andric
5760b57cec5SDimitry Andric Refs = RefEdges.takeVector();
5770b57cec5SDimitry Andric for (; RefCnt < FirstWORef; ++RefCnt)
5780b57cec5SDimitry Andric Refs[RefCnt].setReadOnly();
5790b57cec5SDimitry Andric
5800b57cec5SDimitry Andric for (; RefCnt < Refs.size(); ++RefCnt)
5810b57cec5SDimitry Andric Refs[RefCnt].setWriteOnly();
5820b57cec5SDimitry Andric } else {
5830b57cec5SDimitry Andric Refs = RefEdges.takeVector();
5840b57cec5SDimitry Andric }
5850b57cec5SDimitry Andric // Explicit add hot edges to enforce importing for designated GUIDs for
5860b57cec5SDimitry Andric // sample PGO, to enable the same inlines as the profiled optimized binary.
5870b57cec5SDimitry Andric for (auto &I : F.getImportGUIDs())
5880b57cec5SDimitry Andric CallGraphEdges[Index.getOrInsertValueInfo(I)].updateHotness(
5890b57cec5SDimitry Andric ForceSummaryEdgesCold == FunctionSummary::FSHT_All
5900b57cec5SDimitry Andric ? CalleeInfo::HotnessType::Cold
5910b57cec5SDimitry Andric : CalleeInfo::HotnessType::Critical);
5920b57cec5SDimitry Andric
593fe013be4SDimitry Andric #ifndef NDEBUG
594fe013be4SDimitry Andric // Make sure that all calls we decided could not have memprof summaries get a
595fe013be4SDimitry Andric // false value for mayHaveMemprofSummary, to ensure that this handling remains
596fe013be4SDimitry Andric // in sync with the ThinLTO backend handling.
597fe013be4SDimitry Andric if (IsThinLTO) {
598fe013be4SDimitry Andric for (const BasicBlock &BB : F) {
599fe013be4SDimitry Andric for (const Instruction &I : BB) {
600fe013be4SDimitry Andric const auto *CB = dyn_cast<CallBase>(&I);
601fe013be4SDimitry Andric if (!CB)
602fe013be4SDimitry Andric continue;
603fe013be4SDimitry Andric // We already checked these above.
604fe013be4SDimitry Andric if (CallsThatMayHaveMemprofSummary.count(CB))
605fe013be4SDimitry Andric continue;
606fe013be4SDimitry Andric assert(!mayHaveMemprofSummary(CB));
607fe013be4SDimitry Andric }
608fe013be4SDimitry Andric }
609fe013be4SDimitry Andric }
610fe013be4SDimitry Andric #endif
611fe013be4SDimitry Andric
6120b57cec5SDimitry Andric bool NonRenamableLocal = isNonRenamableLocal(F);
613349cc55cSDimitry Andric bool NotEligibleForImport = NonRenamableLocal ||
614349cc55cSDimitry Andric HasInlineAsmMaybeReferencingInternal ||
615*c9157d92SDimitry Andric HasIndirBranchToBlockAddress || HasIFuncCall;
616fe6060f1SDimitry Andric GlobalValueSummary::GVFlags Flags(
617fe6060f1SDimitry Andric F.getLinkage(), F.getVisibility(), NotEligibleForImport,
61881ad6265SDimitry Andric /* Live = */ false, F.isDSOLocal(), F.canBeOmittedFromSymbolTable());
6190b57cec5SDimitry Andric FunctionSummary::FFlags FunFlags{
620bdd1243dSDimitry Andric F.doesNotAccessMemory(), F.onlyReadsMemory() && !F.doesNotAccessMemory(),
6210b57cec5SDimitry Andric F.hasFnAttribute(Attribute::NoRecurse), F.returnDoesNotAlias(),
6220b57cec5SDimitry Andric // FIXME: refactor this to use the same code that inliner is using.
6230b57cec5SDimitry Andric // Don't try to import functions with noinline attribute.
624349cc55cSDimitry Andric F.getAttributes().hasFnAttr(Attribute::NoInline),
625349cc55cSDimitry Andric F.hasFnAttribute(Attribute::AlwaysInline),
6260eae32dcSDimitry Andric F.hasFnAttribute(Attribute::NoUnwind), MayThrow, HasUnknownCall,
6270eae32dcSDimitry Andric mustBeUnreachableFunction(F)};
6285ffd83dbSDimitry Andric std::vector<FunctionSummary::ParamAccess> ParamAccesses;
6295ffd83dbSDimitry Andric if (auto *SSI = GetSSICallback(F))
630e8d8bef9SDimitry Andric ParamAccesses = SSI->getParamAccesses(Index);
6318bcb0991SDimitry Andric auto FuncSummary = std::make_unique<FunctionSummary>(
6320b57cec5SDimitry Andric Flags, NumInsts, FunFlags, /*EntryCount=*/0, std::move(Refs),
6330b57cec5SDimitry Andric CallGraphEdges.takeVector(), TypeTests.takeVector(),
6340b57cec5SDimitry Andric TypeTestAssumeVCalls.takeVector(), TypeCheckedLoadVCalls.takeVector(),
6350b57cec5SDimitry Andric TypeTestAssumeConstVCalls.takeVector(),
636bdd1243dSDimitry Andric TypeCheckedLoadConstVCalls.takeVector(), std::move(ParamAccesses),
637bdd1243dSDimitry Andric std::move(Callsites), std::move(Allocs));
6380b57cec5SDimitry Andric if (NonRenamableLocal)
6390b57cec5SDimitry Andric CantBePromoted.insert(F.getGUID());
6400b57cec5SDimitry Andric Index.addGlobalValueSummary(F, std::move(FuncSummary));
6410b57cec5SDimitry Andric }
6420b57cec5SDimitry Andric
6430b57cec5SDimitry Andric /// Find function pointers referenced within the given vtable initializer
6440b57cec5SDimitry Andric /// (or subset of an initializer) \p I. The starting offset of \p I within
6450b57cec5SDimitry Andric /// the vtable initializer is \p StartingOffset. Any discovered function
6460b57cec5SDimitry Andric /// pointers are added to \p VTableFuncs along with their cumulative offset
6470b57cec5SDimitry Andric /// within the initializer.
findFuncPointers(const Constant * I,uint64_t StartingOffset,const Module & M,ModuleSummaryIndex & Index,VTableFuncList & VTableFuncs)6480b57cec5SDimitry Andric static void findFuncPointers(const Constant *I, uint64_t StartingOffset,
6490b57cec5SDimitry Andric const Module &M, ModuleSummaryIndex &Index,
6500b57cec5SDimitry Andric VTableFuncList &VTableFuncs) {
6510b57cec5SDimitry Andric // First check if this is a function pointer.
6520b57cec5SDimitry Andric if (I->getType()->isPointerTy()) {
653fe013be4SDimitry Andric auto C = I->stripPointerCasts();
654fe013be4SDimitry Andric auto A = dyn_cast<GlobalAlias>(C);
655fe013be4SDimitry Andric if (isa<Function>(C) || (A && isa<Function>(A->getAliasee()))) {
656fe013be4SDimitry Andric auto GV = dyn_cast<GlobalValue>(C);
657fe013be4SDimitry Andric assert(GV);
6580b57cec5SDimitry Andric // We can disregard __cxa_pure_virtual as a possible call target, as
6590b57cec5SDimitry Andric // calls to pure virtuals are UB.
660fe013be4SDimitry Andric if (GV && GV->getName() != "__cxa_pure_virtual")
661fe013be4SDimitry Andric VTableFuncs.push_back({Index.getOrInsertValueInfo(GV), StartingOffset});
6620b57cec5SDimitry Andric return;
6630b57cec5SDimitry Andric }
664fe013be4SDimitry Andric }
6650b57cec5SDimitry Andric
6660b57cec5SDimitry Andric // Walk through the elements in the constant struct or array and recursively
6670b57cec5SDimitry Andric // look for virtual function pointers.
6680b57cec5SDimitry Andric const DataLayout &DL = M.getDataLayout();
6690b57cec5SDimitry Andric if (auto *C = dyn_cast<ConstantStruct>(I)) {
6700b57cec5SDimitry Andric StructType *STy = dyn_cast<StructType>(C->getType());
6710b57cec5SDimitry Andric assert(STy);
6720b57cec5SDimitry Andric const StructLayout *SL = DL.getStructLayout(C->getType());
6730b57cec5SDimitry Andric
674fe6060f1SDimitry Andric for (auto EI : llvm::enumerate(STy->elements())) {
675fe6060f1SDimitry Andric auto Offset = SL->getElementOffset(EI.index());
6760b57cec5SDimitry Andric unsigned Op = SL->getElementContainingOffset(Offset);
6770b57cec5SDimitry Andric findFuncPointers(cast<Constant>(I->getOperand(Op)),
6780b57cec5SDimitry Andric StartingOffset + Offset, M, Index, VTableFuncs);
6790b57cec5SDimitry Andric }
6800b57cec5SDimitry Andric } else if (auto *C = dyn_cast<ConstantArray>(I)) {
6810b57cec5SDimitry Andric ArrayType *ATy = C->getType();
6820b57cec5SDimitry Andric Type *EltTy = ATy->getElementType();
6830b57cec5SDimitry Andric uint64_t EltSize = DL.getTypeAllocSize(EltTy);
6840b57cec5SDimitry Andric for (unsigned i = 0, e = ATy->getNumElements(); i != e; ++i) {
6850b57cec5SDimitry Andric findFuncPointers(cast<Constant>(I->getOperand(i)),
6860b57cec5SDimitry Andric StartingOffset + i * EltSize, M, Index, VTableFuncs);
6870b57cec5SDimitry Andric }
6880b57cec5SDimitry Andric }
6890b57cec5SDimitry Andric }
6900b57cec5SDimitry Andric
6910b57cec5SDimitry Andric // Identify the function pointers referenced by vtable definition \p V.
computeVTableFuncs(ModuleSummaryIndex & Index,const GlobalVariable & V,const Module & M,VTableFuncList & VTableFuncs)6920b57cec5SDimitry Andric static void computeVTableFuncs(ModuleSummaryIndex &Index,
6930b57cec5SDimitry Andric const GlobalVariable &V, const Module &M,
6940b57cec5SDimitry Andric VTableFuncList &VTableFuncs) {
6950b57cec5SDimitry Andric if (!V.isConstant())
6960b57cec5SDimitry Andric return;
6970b57cec5SDimitry Andric
6980b57cec5SDimitry Andric findFuncPointers(V.getInitializer(), /*StartingOffset=*/0, M, Index,
6990b57cec5SDimitry Andric VTableFuncs);
7000b57cec5SDimitry Andric
7010b57cec5SDimitry Andric #ifndef NDEBUG
7020b57cec5SDimitry Andric // Validate that the VTableFuncs list is ordered by offset.
7030b57cec5SDimitry Andric uint64_t PrevOffset = 0;
7040b57cec5SDimitry Andric for (auto &P : VTableFuncs) {
7050b57cec5SDimitry Andric // The findVFuncPointers traversal should have encountered the
7060b57cec5SDimitry Andric // functions in offset order. We need to use ">=" since PrevOffset
7070b57cec5SDimitry Andric // starts at 0.
7080b57cec5SDimitry Andric assert(P.VTableOffset >= PrevOffset);
7090b57cec5SDimitry Andric PrevOffset = P.VTableOffset;
7100b57cec5SDimitry Andric }
7110b57cec5SDimitry Andric #endif
7120b57cec5SDimitry Andric }
7130b57cec5SDimitry Andric
7140b57cec5SDimitry Andric /// Record vtable definition \p V for each type metadata it references.
7150b57cec5SDimitry Andric static void
recordTypeIdCompatibleVtableReferences(ModuleSummaryIndex & Index,const GlobalVariable & V,SmallVectorImpl<MDNode * > & Types)7160b57cec5SDimitry Andric recordTypeIdCompatibleVtableReferences(ModuleSummaryIndex &Index,
7170b57cec5SDimitry Andric const GlobalVariable &V,
7180b57cec5SDimitry Andric SmallVectorImpl<MDNode *> &Types) {
7190b57cec5SDimitry Andric for (MDNode *Type : Types) {
7200b57cec5SDimitry Andric auto TypeID = Type->getOperand(1).get();
7210b57cec5SDimitry Andric
7220b57cec5SDimitry Andric uint64_t Offset =
7230b57cec5SDimitry Andric cast<ConstantInt>(
7240b57cec5SDimitry Andric cast<ConstantAsMetadata>(Type->getOperand(0))->getValue())
7250b57cec5SDimitry Andric ->getZExtValue();
7260b57cec5SDimitry Andric
7270b57cec5SDimitry Andric if (auto *TypeId = dyn_cast<MDString>(TypeID))
7280b57cec5SDimitry Andric Index.getOrInsertTypeIdCompatibleVtableSummary(TypeId->getString())
7290b57cec5SDimitry Andric .push_back({Offset, Index.getOrInsertValueInfo(&V)});
7300b57cec5SDimitry Andric }
7310b57cec5SDimitry Andric }
7320b57cec5SDimitry Andric
computeVariableSummary(ModuleSummaryIndex & Index,const GlobalVariable & V,DenseSet<GlobalValue::GUID> & CantBePromoted,const Module & M,SmallVectorImpl<MDNode * > & Types)7330b57cec5SDimitry Andric static void computeVariableSummary(ModuleSummaryIndex &Index,
7340b57cec5SDimitry Andric const GlobalVariable &V,
7350b57cec5SDimitry Andric DenseSet<GlobalValue::GUID> &CantBePromoted,
7360b57cec5SDimitry Andric const Module &M,
7370b57cec5SDimitry Andric SmallVectorImpl<MDNode *> &Types) {
738*c9157d92SDimitry Andric SetVector<ValueInfo, std::vector<ValueInfo>> RefEdges;
7390b57cec5SDimitry Andric SmallPtrSet<const User *, 8> Visited;
7400b57cec5SDimitry Andric bool HasBlockAddress = findRefEdges(Index, &V, RefEdges, Visited);
7410b57cec5SDimitry Andric bool NonRenamableLocal = isNonRenamableLocal(V);
742fe6060f1SDimitry Andric GlobalValueSummary::GVFlags Flags(
743fe6060f1SDimitry Andric V.getLinkage(), V.getVisibility(), NonRenamableLocal,
74481ad6265SDimitry Andric /* Live = */ false, V.isDSOLocal(), V.canBeOmittedFromSymbolTable());
7450b57cec5SDimitry Andric
7460b57cec5SDimitry Andric VTableFuncList VTableFuncs;
7470b57cec5SDimitry Andric // If splitting is not enabled, then we compute the summary information
7480b57cec5SDimitry Andric // necessary for index-based whole program devirtualization.
7490b57cec5SDimitry Andric if (!Index.enableSplitLTOUnit()) {
7500b57cec5SDimitry Andric Types.clear();
7510b57cec5SDimitry Andric V.getMetadata(LLVMContext::MD_type, Types);
7520b57cec5SDimitry Andric if (!Types.empty()) {
7530b57cec5SDimitry Andric // Identify the function pointers referenced by this vtable definition.
7540b57cec5SDimitry Andric computeVTableFuncs(Index, V, M, VTableFuncs);
7550b57cec5SDimitry Andric
7560b57cec5SDimitry Andric // Record this vtable definition for each type metadata it references.
7570b57cec5SDimitry Andric recordTypeIdCompatibleVtableReferences(Index, V, Types);
7580b57cec5SDimitry Andric }
7590b57cec5SDimitry Andric }
7600b57cec5SDimitry Andric
7610b57cec5SDimitry Andric // Don't mark variables we won't be able to internalize as read/write-only.
7620b57cec5SDimitry Andric bool CanBeInternalized =
7630b57cec5SDimitry Andric !V.hasComdat() && !V.hasAppendingLinkage() && !V.isInterposable() &&
7640b57cec5SDimitry Andric !V.hasAvailableExternallyLinkage() && !V.hasDLLExportStorageClass();
7655ffd83dbSDimitry Andric bool Constant = V.isConstant();
7665ffd83dbSDimitry Andric GlobalVarSummary::GVarFlags VarFlags(CanBeInternalized,
7675ffd83dbSDimitry Andric Constant ? false : CanBeInternalized,
7685ffd83dbSDimitry Andric Constant, V.getVCallVisibility());
7698bcb0991SDimitry Andric auto GVarSummary = std::make_unique<GlobalVarSummary>(Flags, VarFlags,
7700b57cec5SDimitry Andric RefEdges.takeVector());
7710b57cec5SDimitry Andric if (NonRenamableLocal)
7720b57cec5SDimitry Andric CantBePromoted.insert(V.getGUID());
7730b57cec5SDimitry Andric if (HasBlockAddress)
7740b57cec5SDimitry Andric GVarSummary->setNotEligibleToImport();
7750b57cec5SDimitry Andric if (!VTableFuncs.empty())
7760b57cec5SDimitry Andric GVarSummary->setVTableFuncs(VTableFuncs);
7770b57cec5SDimitry Andric Index.addGlobalValueSummary(V, std::move(GVarSummary));
7780b57cec5SDimitry Andric }
7790b57cec5SDimitry Andric
computeAliasSummary(ModuleSummaryIndex & Index,const GlobalAlias & A,DenseSet<GlobalValue::GUID> & CantBePromoted)780fcaf7f86SDimitry Andric static void computeAliasSummary(ModuleSummaryIndex &Index, const GlobalAlias &A,
7810b57cec5SDimitry Andric DenseSet<GlobalValue::GUID> &CantBePromoted) {
782fcaf7f86SDimitry Andric // Skip summary for indirect function aliases as summary for aliasee will not
783fcaf7f86SDimitry Andric // be emitted.
784fcaf7f86SDimitry Andric const GlobalObject *Aliasee = A.getAliaseeObject();
785fcaf7f86SDimitry Andric if (isa<GlobalIFunc>(Aliasee))
786fcaf7f86SDimitry Andric return;
7870b57cec5SDimitry Andric bool NonRenamableLocal = isNonRenamableLocal(A);
788fe6060f1SDimitry Andric GlobalValueSummary::GVFlags Flags(
789fe6060f1SDimitry Andric A.getLinkage(), A.getVisibility(), NonRenamableLocal,
79081ad6265SDimitry Andric /* Live = */ false, A.isDSOLocal(), A.canBeOmittedFromSymbolTable());
7918bcb0991SDimitry Andric auto AS = std::make_unique<AliasSummary>(Flags);
7920b57cec5SDimitry Andric auto AliaseeVI = Index.getValueInfo(Aliasee->getGUID());
7930b57cec5SDimitry Andric assert(AliaseeVI && "Alias expects aliasee summary to be available");
7940b57cec5SDimitry Andric assert(AliaseeVI.getSummaryList().size() == 1 &&
7950b57cec5SDimitry Andric "Expected a single entry per aliasee in per-module index");
7960b57cec5SDimitry Andric AS->setAliasee(AliaseeVI, AliaseeVI.getSummaryList()[0].get());
7970b57cec5SDimitry Andric if (NonRenamableLocal)
7980b57cec5SDimitry Andric CantBePromoted.insert(A.getGUID());
7990b57cec5SDimitry Andric Index.addGlobalValueSummary(A, std::move(AS));
8000b57cec5SDimitry Andric }
8010b57cec5SDimitry Andric
8020b57cec5SDimitry Andric // Set LiveRoot flag on entries matching the given value name.
setLiveRoot(ModuleSummaryIndex & Index,StringRef Name)8030b57cec5SDimitry Andric static void setLiveRoot(ModuleSummaryIndex &Index, StringRef Name) {
8040b57cec5SDimitry Andric if (ValueInfo VI = Index.getValueInfo(GlobalValue::getGUID(Name)))
805fcaf7f86SDimitry Andric for (const auto &Summary : VI.getSummaryList())
8060b57cec5SDimitry Andric Summary->setLive(true);
8070b57cec5SDimitry Andric }
8080b57cec5SDimitry Andric
buildModuleSummaryIndex(const Module & M,std::function<BlockFrequencyInfo * (const Function & F)> GetBFICallback,ProfileSummaryInfo * PSI,std::function<const StackSafetyInfo * (const Function & F)> GetSSICallback)8090b57cec5SDimitry Andric ModuleSummaryIndex llvm::buildModuleSummaryIndex(
8100b57cec5SDimitry Andric const Module &M,
8110b57cec5SDimitry Andric std::function<BlockFrequencyInfo *(const Function &F)> GetBFICallback,
8125ffd83dbSDimitry Andric ProfileSummaryInfo *PSI,
8135ffd83dbSDimitry Andric std::function<const StackSafetyInfo *(const Function &F)> GetSSICallback) {
8140b57cec5SDimitry Andric assert(PSI);
8150b57cec5SDimitry Andric bool EnableSplitLTOUnit = false;
816fe013be4SDimitry Andric bool UnifiedLTO = false;
8170b57cec5SDimitry Andric if (auto *MD = mdconst::extract_or_null<ConstantInt>(
8180b57cec5SDimitry Andric M.getModuleFlag("EnableSplitLTOUnit")))
8190b57cec5SDimitry Andric EnableSplitLTOUnit = MD->getZExtValue();
820fe013be4SDimitry Andric if (auto *MD =
821fe013be4SDimitry Andric mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("UnifiedLTO")))
822fe013be4SDimitry Andric UnifiedLTO = MD->getZExtValue();
823fe013be4SDimitry Andric ModuleSummaryIndex Index(/*HaveGVs=*/true, EnableSplitLTOUnit, UnifiedLTO);
8240b57cec5SDimitry Andric
8250b57cec5SDimitry Andric // Identify the local values in the llvm.used and llvm.compiler.used sets,
8260b57cec5SDimitry Andric // which should not be exported as they would then require renaming and
8270b57cec5SDimitry Andric // promotion, but we may have opaque uses e.g. in inline asm. We collect them
8280b57cec5SDimitry Andric // here because we use this information to mark functions containing inline
8290b57cec5SDimitry Andric // assembly calls as not importable.
830fe6060f1SDimitry Andric SmallPtrSet<GlobalValue *, 4> LocalsUsed;
831fe6060f1SDimitry Andric SmallVector<GlobalValue *, 4> Used;
8320b57cec5SDimitry Andric // First collect those in the llvm.used set.
833fe6060f1SDimitry Andric collectUsedGlobalVariables(M, Used, /*CompilerUsed=*/false);
8340b57cec5SDimitry Andric // Next collect those in the llvm.compiler.used set.
835fe6060f1SDimitry Andric collectUsedGlobalVariables(M, Used, /*CompilerUsed=*/true);
8360b57cec5SDimitry Andric DenseSet<GlobalValue::GUID> CantBePromoted;
8370b57cec5SDimitry Andric for (auto *V : Used) {
8380b57cec5SDimitry Andric if (V->hasLocalLinkage()) {
8390b57cec5SDimitry Andric LocalsUsed.insert(V);
8400b57cec5SDimitry Andric CantBePromoted.insert(V->getGUID());
8410b57cec5SDimitry Andric }
8420b57cec5SDimitry Andric }
8430b57cec5SDimitry Andric
8440b57cec5SDimitry Andric bool HasLocalInlineAsmSymbol = false;
8450b57cec5SDimitry Andric if (!M.getModuleInlineAsm().empty()) {
8460b57cec5SDimitry Andric // Collect the local values defined by module level asm, and set up
8470b57cec5SDimitry Andric // summaries for these symbols so that they can be marked as NoRename,
8480b57cec5SDimitry Andric // to prevent export of any use of them in regular IR that would require
8490b57cec5SDimitry Andric // renaming within the module level asm. Note we don't need to create a
8500b57cec5SDimitry Andric // summary for weak or global defs, as they don't need to be flagged as
8510b57cec5SDimitry Andric // NoRename, and defs in module level asm can't be imported anyway.
8520b57cec5SDimitry Andric // Also, any values used but not defined within module level asm should
8530b57cec5SDimitry Andric // be listed on the llvm.used or llvm.compiler.used global and marked as
8540b57cec5SDimitry Andric // referenced from there.
8550b57cec5SDimitry Andric ModuleSymbolTable::CollectAsmSymbols(
8560b57cec5SDimitry Andric M, [&](StringRef Name, object::BasicSymbolRef::Flags Flags) {
8570b57cec5SDimitry Andric // Symbols not marked as Weak or Global are local definitions.
8580b57cec5SDimitry Andric if (Flags & (object::BasicSymbolRef::SF_Weak |
8590b57cec5SDimitry Andric object::BasicSymbolRef::SF_Global))
8600b57cec5SDimitry Andric return;
8610b57cec5SDimitry Andric HasLocalInlineAsmSymbol = true;
8620b57cec5SDimitry Andric GlobalValue *GV = M.getNamedValue(Name);
8630b57cec5SDimitry Andric if (!GV)
8640b57cec5SDimitry Andric return;
8650b57cec5SDimitry Andric assert(GV->isDeclaration() && "Def in module asm already has definition");
866fe6060f1SDimitry Andric GlobalValueSummary::GVFlags GVFlags(
867fe6060f1SDimitry Andric GlobalValue::InternalLinkage, GlobalValue::DefaultVisibility,
8680b57cec5SDimitry Andric /* NotEligibleToImport = */ true,
8690b57cec5SDimitry Andric /* Live = */ true,
87081ad6265SDimitry Andric /* Local */ GV->isDSOLocal(), GV->canBeOmittedFromSymbolTable());
8710b57cec5SDimitry Andric CantBePromoted.insert(GV->getGUID());
8720b57cec5SDimitry Andric // Create the appropriate summary type.
8730b57cec5SDimitry Andric if (Function *F = dyn_cast<Function>(GV)) {
8740b57cec5SDimitry Andric std::unique_ptr<FunctionSummary> Summary =
8758bcb0991SDimitry Andric std::make_unique<FunctionSummary>(
8760b57cec5SDimitry Andric GVFlags, /*InstCount=*/0,
8770b57cec5SDimitry Andric FunctionSummary::FFlags{
8780b57cec5SDimitry Andric F->hasFnAttribute(Attribute::ReadNone),
8790b57cec5SDimitry Andric F->hasFnAttribute(Attribute::ReadOnly),
8800b57cec5SDimitry Andric F->hasFnAttribute(Attribute::NoRecurse),
8810b57cec5SDimitry Andric F->returnDoesNotAlias(),
882480093f4SDimitry Andric /* NoInline = */ false,
883349cc55cSDimitry Andric F->hasFnAttribute(Attribute::AlwaysInline),
884349cc55cSDimitry Andric F->hasFnAttribute(Attribute::NoUnwind),
885349cc55cSDimitry Andric /* MayThrow */ true,
8860eae32dcSDimitry Andric /* HasUnknownCall */ true,
8870eae32dcSDimitry Andric /* MustBeUnreachable */ false},
8880b57cec5SDimitry Andric /*EntryCount=*/0, ArrayRef<ValueInfo>{},
8890b57cec5SDimitry Andric ArrayRef<FunctionSummary::EdgeTy>{},
8900b57cec5SDimitry Andric ArrayRef<GlobalValue::GUID>{},
8910b57cec5SDimitry Andric ArrayRef<FunctionSummary::VFuncId>{},
8920b57cec5SDimitry Andric ArrayRef<FunctionSummary::VFuncId>{},
8930b57cec5SDimitry Andric ArrayRef<FunctionSummary::ConstVCall>{},
8945ffd83dbSDimitry Andric ArrayRef<FunctionSummary::ConstVCall>{},
895bdd1243dSDimitry Andric ArrayRef<FunctionSummary::ParamAccess>{},
896bdd1243dSDimitry Andric ArrayRef<CallsiteInfo>{}, ArrayRef<AllocInfo>{});
8970b57cec5SDimitry Andric Index.addGlobalValueSummary(*GV, std::move(Summary));
8980b57cec5SDimitry Andric } else {
8990b57cec5SDimitry Andric std::unique_ptr<GlobalVarSummary> Summary =
9008bcb0991SDimitry Andric std::make_unique<GlobalVarSummary>(
9015ffd83dbSDimitry Andric GVFlags,
9025ffd83dbSDimitry Andric GlobalVarSummary::GVarFlags(
9035ffd83dbSDimitry Andric false, false, cast<GlobalVariable>(GV)->isConstant(),
9045ffd83dbSDimitry Andric GlobalObject::VCallVisibilityPublic),
9050b57cec5SDimitry Andric ArrayRef<ValueInfo>{});
9060b57cec5SDimitry Andric Index.addGlobalValueSummary(*GV, std::move(Summary));
9070b57cec5SDimitry Andric }
9080b57cec5SDimitry Andric });
9090b57cec5SDimitry Andric }
9100b57cec5SDimitry Andric
9110b57cec5SDimitry Andric bool IsThinLTO = true;
9120b57cec5SDimitry Andric if (auto *MD =
9130b57cec5SDimitry Andric mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("ThinLTO")))
9140b57cec5SDimitry Andric IsThinLTO = MD->getZExtValue();
9150b57cec5SDimitry Andric
9160b57cec5SDimitry Andric // Compute summaries for all functions defined in module, and save in the
9170b57cec5SDimitry Andric // index.
918fcaf7f86SDimitry Andric for (const auto &F : M) {
9190b57cec5SDimitry Andric if (F.isDeclaration())
9200b57cec5SDimitry Andric continue;
9210b57cec5SDimitry Andric
9220b57cec5SDimitry Andric DominatorTree DT(const_cast<Function &>(F));
9230b57cec5SDimitry Andric BlockFrequencyInfo *BFI = nullptr;
9240b57cec5SDimitry Andric std::unique_ptr<BlockFrequencyInfo> BFIPtr;
9250b57cec5SDimitry Andric if (GetBFICallback)
9260b57cec5SDimitry Andric BFI = GetBFICallback(F);
9270b57cec5SDimitry Andric else if (F.hasProfileData()) {
9280b57cec5SDimitry Andric LoopInfo LI{DT};
9290b57cec5SDimitry Andric BranchProbabilityInfo BPI{F, LI};
9308bcb0991SDimitry Andric BFIPtr = std::make_unique<BlockFrequencyInfo>(F, BPI, LI);
9310b57cec5SDimitry Andric BFI = BFIPtr.get();
9320b57cec5SDimitry Andric }
9330b57cec5SDimitry Andric
9340b57cec5SDimitry Andric computeFunctionSummary(Index, M, F, BFI, PSI, DT,
9350b57cec5SDimitry Andric !LocalsUsed.empty() || HasLocalInlineAsmSymbol,
9365ffd83dbSDimitry Andric CantBePromoted, IsThinLTO, GetSSICallback);
9370b57cec5SDimitry Andric }
9380b57cec5SDimitry Andric
9390b57cec5SDimitry Andric // Compute summaries for all variables defined in module, and save in the
9400b57cec5SDimitry Andric // index.
9410b57cec5SDimitry Andric SmallVector<MDNode *, 2> Types;
9420b57cec5SDimitry Andric for (const GlobalVariable &G : M.globals()) {
9430b57cec5SDimitry Andric if (G.isDeclaration())
9440b57cec5SDimitry Andric continue;
9450b57cec5SDimitry Andric computeVariableSummary(Index, G, CantBePromoted, M, Types);
9460b57cec5SDimitry Andric }
9470b57cec5SDimitry Andric
9480b57cec5SDimitry Andric // Compute summaries for all aliases defined in module, and save in the
9490b57cec5SDimitry Andric // index.
9500b57cec5SDimitry Andric for (const GlobalAlias &A : M.aliases())
9510b57cec5SDimitry Andric computeAliasSummary(Index, A, CantBePromoted);
9520b57cec5SDimitry Andric
953fcaf7f86SDimitry Andric // Iterate through ifuncs, set their resolvers all alive.
954fcaf7f86SDimitry Andric for (const GlobalIFunc &I : M.ifuncs()) {
955fcaf7f86SDimitry Andric I.applyAlongResolverPath([&Index](const GlobalValue &GV) {
956fcaf7f86SDimitry Andric Index.getGlobalValueSummary(GV)->setLive(true);
957fcaf7f86SDimitry Andric });
958fcaf7f86SDimitry Andric }
959fcaf7f86SDimitry Andric
9600b57cec5SDimitry Andric for (auto *V : LocalsUsed) {
9610b57cec5SDimitry Andric auto *Summary = Index.getGlobalValueSummary(*V);
9620b57cec5SDimitry Andric assert(Summary && "Missing summary for global value");
9630b57cec5SDimitry Andric Summary->setNotEligibleToImport();
9640b57cec5SDimitry Andric }
9650b57cec5SDimitry Andric
9660b57cec5SDimitry Andric // The linker doesn't know about these LLVM produced values, so we need
9670b57cec5SDimitry Andric // to flag them as live in the index to ensure index-based dead value
9680b57cec5SDimitry Andric // analysis treats them as live roots of the analysis.
9690b57cec5SDimitry Andric setLiveRoot(Index, "llvm.used");
9700b57cec5SDimitry Andric setLiveRoot(Index, "llvm.compiler.used");
9710b57cec5SDimitry Andric setLiveRoot(Index, "llvm.global_ctors");
9720b57cec5SDimitry Andric setLiveRoot(Index, "llvm.global_dtors");
9730b57cec5SDimitry Andric setLiveRoot(Index, "llvm.global.annotations");
9740b57cec5SDimitry Andric
9750b57cec5SDimitry Andric for (auto &GlobalList : Index) {
9760b57cec5SDimitry Andric // Ignore entries for references that are undefined in the current module.
9770b57cec5SDimitry Andric if (GlobalList.second.SummaryList.empty())
9780b57cec5SDimitry Andric continue;
9790b57cec5SDimitry Andric
9800b57cec5SDimitry Andric assert(GlobalList.second.SummaryList.size() == 1 &&
9810b57cec5SDimitry Andric "Expected module's index to have one summary per GUID");
9820b57cec5SDimitry Andric auto &Summary = GlobalList.second.SummaryList[0];
9830b57cec5SDimitry Andric if (!IsThinLTO) {
9840b57cec5SDimitry Andric Summary->setNotEligibleToImport();
9850b57cec5SDimitry Andric continue;
9860b57cec5SDimitry Andric }
9870b57cec5SDimitry Andric
9880b57cec5SDimitry Andric bool AllRefsCanBeExternallyReferenced =
9890b57cec5SDimitry Andric llvm::all_of(Summary->refs(), [&](const ValueInfo &VI) {
9900b57cec5SDimitry Andric return !CantBePromoted.count(VI.getGUID());
9910b57cec5SDimitry Andric });
9920b57cec5SDimitry Andric if (!AllRefsCanBeExternallyReferenced) {
9930b57cec5SDimitry Andric Summary->setNotEligibleToImport();
9940b57cec5SDimitry Andric continue;
9950b57cec5SDimitry Andric }
9960b57cec5SDimitry Andric
9970b57cec5SDimitry Andric if (auto *FuncSummary = dyn_cast<FunctionSummary>(Summary.get())) {
9980b57cec5SDimitry Andric bool AllCallsCanBeExternallyReferenced = llvm::all_of(
9990b57cec5SDimitry Andric FuncSummary->calls(), [&](const FunctionSummary::EdgeTy &Edge) {
10000b57cec5SDimitry Andric return !CantBePromoted.count(Edge.first.getGUID());
10010b57cec5SDimitry Andric });
10020b57cec5SDimitry Andric if (!AllCallsCanBeExternallyReferenced)
10030b57cec5SDimitry Andric Summary->setNotEligibleToImport();
10040b57cec5SDimitry Andric }
10050b57cec5SDimitry Andric }
10060b57cec5SDimitry Andric
10070b57cec5SDimitry Andric if (!ModuleSummaryDotFile.empty()) {
10080b57cec5SDimitry Andric std::error_code EC;
10098bcb0991SDimitry Andric raw_fd_ostream OSDot(ModuleSummaryDotFile, EC, sys::fs::OpenFlags::OF_None);
10100b57cec5SDimitry Andric if (EC)
10110b57cec5SDimitry Andric report_fatal_error(Twine("Failed to open dot file ") +
10120b57cec5SDimitry Andric ModuleSummaryDotFile + ": " + EC.message() + "\n");
1013480093f4SDimitry Andric Index.exportToDot(OSDot, {});
10140b57cec5SDimitry Andric }
10150b57cec5SDimitry Andric
10160b57cec5SDimitry Andric return Index;
10170b57cec5SDimitry Andric }
10180b57cec5SDimitry Andric
10190b57cec5SDimitry Andric AnalysisKey ModuleSummaryIndexAnalysis::Key;
10200b57cec5SDimitry Andric
10210b57cec5SDimitry Andric ModuleSummaryIndex
run(Module & M,ModuleAnalysisManager & AM)10220b57cec5SDimitry Andric ModuleSummaryIndexAnalysis::run(Module &M, ModuleAnalysisManager &AM) {
10230b57cec5SDimitry Andric ProfileSummaryInfo &PSI = AM.getResult<ProfileSummaryAnalysis>(M);
10240b57cec5SDimitry Andric auto &FAM = AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
10255ffd83dbSDimitry Andric bool NeedSSI = needsParamAccessSummary(M);
10260b57cec5SDimitry Andric return buildModuleSummaryIndex(
10270b57cec5SDimitry Andric M,
10280b57cec5SDimitry Andric [&FAM](const Function &F) {
10290b57cec5SDimitry Andric return &FAM.getResult<BlockFrequencyAnalysis>(
10300b57cec5SDimitry Andric *const_cast<Function *>(&F));
10310b57cec5SDimitry Andric },
10325ffd83dbSDimitry Andric &PSI,
10335ffd83dbSDimitry Andric [&FAM, NeedSSI](const Function &F) -> const StackSafetyInfo * {
10345ffd83dbSDimitry Andric return NeedSSI ? &FAM.getResult<StackSafetyAnalysis>(
10355ffd83dbSDimitry Andric const_cast<Function &>(F))
10365ffd83dbSDimitry Andric : nullptr;
10375ffd83dbSDimitry Andric });
10380b57cec5SDimitry Andric }
10390b57cec5SDimitry Andric
10400b57cec5SDimitry Andric char ModuleSummaryIndexWrapperPass::ID = 0;
10410b57cec5SDimitry Andric
10420b57cec5SDimitry Andric INITIALIZE_PASS_BEGIN(ModuleSummaryIndexWrapperPass, "module-summary-analysis",
10430b57cec5SDimitry Andric "Module Summary Analysis", false, true)
INITIALIZE_PASS_DEPENDENCY(BlockFrequencyInfoWrapperPass)10440b57cec5SDimitry Andric INITIALIZE_PASS_DEPENDENCY(BlockFrequencyInfoWrapperPass)
10450b57cec5SDimitry Andric INITIALIZE_PASS_DEPENDENCY(ProfileSummaryInfoWrapperPass)
10465ffd83dbSDimitry Andric INITIALIZE_PASS_DEPENDENCY(StackSafetyInfoWrapperPass)
10470b57cec5SDimitry Andric INITIALIZE_PASS_END(ModuleSummaryIndexWrapperPass, "module-summary-analysis",
10480b57cec5SDimitry Andric "Module Summary Analysis", false, true)
10490b57cec5SDimitry Andric
10500b57cec5SDimitry Andric ModulePass *llvm::createModuleSummaryIndexWrapperPass() {
10510b57cec5SDimitry Andric return new ModuleSummaryIndexWrapperPass();
10520b57cec5SDimitry Andric }
10530b57cec5SDimitry Andric
ModuleSummaryIndexWrapperPass()10540b57cec5SDimitry Andric ModuleSummaryIndexWrapperPass::ModuleSummaryIndexWrapperPass()
10550b57cec5SDimitry Andric : ModulePass(ID) {
10560b57cec5SDimitry Andric initializeModuleSummaryIndexWrapperPassPass(*PassRegistry::getPassRegistry());
10570b57cec5SDimitry Andric }
10580b57cec5SDimitry Andric
runOnModule(Module & M)10590b57cec5SDimitry Andric bool ModuleSummaryIndexWrapperPass::runOnModule(Module &M) {
10600b57cec5SDimitry Andric auto *PSI = &getAnalysis<ProfileSummaryInfoWrapperPass>().getPSI();
10615ffd83dbSDimitry Andric bool NeedSSI = needsParamAccessSummary(M);
10620b57cec5SDimitry Andric Index.emplace(buildModuleSummaryIndex(
10630b57cec5SDimitry Andric M,
10640b57cec5SDimitry Andric [this](const Function &F) {
10650b57cec5SDimitry Andric return &(this->getAnalysis<BlockFrequencyInfoWrapperPass>(
10660b57cec5SDimitry Andric *const_cast<Function *>(&F))
10670b57cec5SDimitry Andric .getBFI());
10680b57cec5SDimitry Andric },
10695ffd83dbSDimitry Andric PSI,
10705ffd83dbSDimitry Andric [&](const Function &F) -> const StackSafetyInfo * {
10715ffd83dbSDimitry Andric return NeedSSI ? &getAnalysis<StackSafetyInfoWrapperPass>(
10725ffd83dbSDimitry Andric const_cast<Function &>(F))
10735ffd83dbSDimitry Andric .getResult()
10745ffd83dbSDimitry Andric : nullptr;
10755ffd83dbSDimitry Andric }));
10760b57cec5SDimitry Andric return false;
10770b57cec5SDimitry Andric }
10780b57cec5SDimitry Andric
doFinalization(Module & M)10790b57cec5SDimitry Andric bool ModuleSummaryIndexWrapperPass::doFinalization(Module &M) {
10800b57cec5SDimitry Andric Index.reset();
10810b57cec5SDimitry Andric return false;
10820b57cec5SDimitry Andric }
10830b57cec5SDimitry Andric
getAnalysisUsage(AnalysisUsage & AU) const10840b57cec5SDimitry Andric void ModuleSummaryIndexWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
10850b57cec5SDimitry Andric AU.setPreservesAll();
10860b57cec5SDimitry Andric AU.addRequired<BlockFrequencyInfoWrapperPass>();
10870b57cec5SDimitry Andric AU.addRequired<ProfileSummaryInfoWrapperPass>();
10885ffd83dbSDimitry Andric AU.addRequired<StackSafetyInfoWrapperPass>();
10890b57cec5SDimitry Andric }
10905ffd83dbSDimitry Andric
10915ffd83dbSDimitry Andric char ImmutableModuleSummaryIndexWrapperPass::ID = 0;
10925ffd83dbSDimitry Andric
ImmutableModuleSummaryIndexWrapperPass(const ModuleSummaryIndex * Index)10935ffd83dbSDimitry Andric ImmutableModuleSummaryIndexWrapperPass::ImmutableModuleSummaryIndexWrapperPass(
10945ffd83dbSDimitry Andric const ModuleSummaryIndex *Index)
10955ffd83dbSDimitry Andric : ImmutablePass(ID), Index(Index) {
10965ffd83dbSDimitry Andric initializeImmutableModuleSummaryIndexWrapperPassPass(
10975ffd83dbSDimitry Andric *PassRegistry::getPassRegistry());
10985ffd83dbSDimitry Andric }
10995ffd83dbSDimitry Andric
getAnalysisUsage(AnalysisUsage & AU) const11005ffd83dbSDimitry Andric void ImmutableModuleSummaryIndexWrapperPass::getAnalysisUsage(
11015ffd83dbSDimitry Andric AnalysisUsage &AU) const {
11025ffd83dbSDimitry Andric AU.setPreservesAll();
11035ffd83dbSDimitry Andric }
11045ffd83dbSDimitry Andric
createImmutableModuleSummaryIndexWrapperPass(const ModuleSummaryIndex * Index)11055ffd83dbSDimitry Andric ImmutablePass *llvm::createImmutableModuleSummaryIndexWrapperPass(
11065ffd83dbSDimitry Andric const ModuleSummaryIndex *Index) {
11075ffd83dbSDimitry Andric return new ImmutableModuleSummaryIndexWrapperPass(Index);
11085ffd83dbSDimitry Andric }
11095ffd83dbSDimitry Andric
11105ffd83dbSDimitry Andric INITIALIZE_PASS(ImmutableModuleSummaryIndexWrapperPass, "module-summary-info",
11115ffd83dbSDimitry Andric "Module summary info", false, true)
1112fe013be4SDimitry Andric
mayHaveMemprofSummary(const CallBase * CB)1113fe013be4SDimitry Andric bool llvm::mayHaveMemprofSummary(const CallBase *CB) {
1114fe013be4SDimitry Andric if (!CB)
1115fe013be4SDimitry Andric return false;
1116fe013be4SDimitry Andric if (CB->isDebugOrPseudoInst())
1117fe013be4SDimitry Andric return false;
1118fe013be4SDimitry Andric auto *CI = dyn_cast<CallInst>(CB);
1119fe013be4SDimitry Andric auto *CalledValue = CB->getCalledOperand();
1120fe013be4SDimitry Andric auto *CalledFunction = CB->getCalledFunction();
1121fe013be4SDimitry Andric if (CalledValue && !CalledFunction) {
1122fe013be4SDimitry Andric CalledValue = CalledValue->stripPointerCasts();
1123fe013be4SDimitry Andric // Stripping pointer casts can reveal a called function.
1124fe013be4SDimitry Andric CalledFunction = dyn_cast<Function>(CalledValue);
1125fe013be4SDimitry Andric }
1126fe013be4SDimitry Andric // Check if this is an alias to a function. If so, get the
1127fe013be4SDimitry Andric // called aliasee for the checks below.
1128fe013be4SDimitry Andric if (auto *GA = dyn_cast<GlobalAlias>(CalledValue)) {
1129fe013be4SDimitry Andric assert(!CalledFunction &&
1130fe013be4SDimitry Andric "Expected null called function in callsite for alias");
1131fe013be4SDimitry Andric CalledFunction = dyn_cast<Function>(GA->getAliaseeObject());
1132fe013be4SDimitry Andric }
1133fe013be4SDimitry Andric // Check if this is a direct call to a known function or a known
1134fe013be4SDimitry Andric // intrinsic, or an indirect call with profile data.
1135fe013be4SDimitry Andric if (CalledFunction) {
1136fe013be4SDimitry Andric if (CI && CalledFunction->isIntrinsic())
1137fe013be4SDimitry Andric return false;
1138fe013be4SDimitry Andric } else {
1139fe013be4SDimitry Andric // TODO: For now skip indirect calls. See comments in
1140fe013be4SDimitry Andric // computeFunctionSummary for what is needed to handle this.
1141fe013be4SDimitry Andric return false;
1142fe013be4SDimitry Andric }
1143fe013be4SDimitry Andric return true;
1144fe013be4SDimitry Andric }
1145