1f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar//===- SampleProfile.cpp - Incorporate sample profiles into the IR --------===// 2f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 3f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// The LLVM Compiler Infrastructure 4f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 5f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// This file is distributed under the University of Illinois Open Source 6f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// License. See LICENSE.TXT for details. 7f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 8f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar//===----------------------------------------------------------------------===// 9f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 10f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// This file implements the SampleProfileLoader transformation. This pass 11f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// reads a profile file generated by a sampling profiler (e.g. Linux Perf - 12f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// http://perf.wiki.kernel.org/) and generates IR metadata to reflect the 13f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// profile information in the given profile. 14f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 15f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// This pass generates branch weight annotations on the IR: 16f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 17f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// - prof: Represents branch weights. This annotation is added to branches 18f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// to indicate the weights of each edge coming out of the branch. 19f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// The weight of each edge is the weight of the target block for 20f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// that edge. The weight of a block B is computed as the maximum 21f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// number of samples found in B. 22f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// 23f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar//===----------------------------------------------------------------------===// 24f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 25de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/Transforms/SampleProfile.h" 26f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/DenseMap.h" 27f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/SmallPtrSet.h" 28f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/SmallSet.h" 29f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/StringRef.h" 30de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/Analysis/AssumptionCache.h" 31f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Analysis/LoopInfo.h" 32f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Analysis/PostDominators.h" 33f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Constants.h" 34f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/DebugInfo.h" 35f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/DiagnosticInfo.h" 36f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Dominators.h" 37f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Function.h" 38f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/InstIterator.h" 39f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Instructions.h" 40de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/IR/IntrinsicInst.h" 41f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/LLVMContext.h" 42f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/MDBuilder.h" 43f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Metadata.h" 44f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/IR/Module.h" 45f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Pass.h" 46f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ProfileData/SampleProfReader.h" 47f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/CommandLine.h" 48f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/Debug.h" 49f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/ErrorOr.h" 50f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/Format.h" 51f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/raw_ostream.h" 52f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Transforms/IPO.h" 53f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Transforms/Utils/Cloning.h" 54f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include <cctype> 55f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 56f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarusing namespace llvm; 57f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarusing namespace sampleprof; 58f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 59f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#define DEBUG_TYPE "sample-profile" 60f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 61f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// Command line option to specify the file to read samples from. This is 62f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar// mainly used for debugging. 63f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarstatic cl::opt<std::string> SampleProfileFile( 64f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample-profile-file", cl::init(""), cl::value_desc("filename"), 65f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar cl::desc("Profile file loaded by -sample-profile"), cl::Hidden); 66f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarstatic cl::opt<unsigned> SampleProfileMaxPropagateIterations( 67f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample-profile-max-propagate-iterations", cl::init(100), 68f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar cl::desc("Maximum number of iterations to go through when propagating " 69f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample block/edge weights through the CFG.")); 70f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarstatic cl::opt<unsigned> SampleProfileRecordCoverage( 71f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample-profile-check-record-coverage", cl::init(0), cl::value_desc("N"), 72f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar cl::desc("Emit a warning if less than N% of records in the input profile " 73f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "are matched to the IR.")); 74f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarstatic cl::opt<unsigned> SampleProfileSampleCoverage( 75f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample-profile-check-sample-coverage", cl::init(0), cl::value_desc("N"), 76f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar cl::desc("Emit a warning if less than N% of samples in the input profile " 77f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "are matched to the IR.")); 78f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarstatic cl::opt<double> SampleProfileHotThreshold( 79f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "sample-profile-inline-hot-threshold", cl::init(0.1), cl::value_desc("N"), 80f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar cl::desc("Inlined functions that account for more than N% of all samples " 81f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "collected in the parent function, will be inlined again.")); 82f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 83f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarnamespace { 84f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainartypedef DenseMap<const BasicBlock *, uint64_t> BlockWeightMap; 85f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainartypedef DenseMap<const BasicBlock *, const BasicBlock *> EquivalenceClassMap; 86f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainartypedef std::pair<const BasicBlock *, const BasicBlock *> Edge; 87f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainartypedef DenseMap<Edge, uint64_t> EdgeWeightMap; 88f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainartypedef DenseMap<const BasicBlock *, SmallVector<const BasicBlock *, 8>> 89f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockEdgeMap; 90f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 91f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Sample profile pass. 92f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 93f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This pass reads profile data from the file specified by 94f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// -sample-profile-file and annotates every affected function with the 95f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// profile information found in that file. 96de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass SampleProfileLoader { 97f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarpublic: 98f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SampleProfileLoader(StringRef Name = SampleProfileFile) 99de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar : DT(nullptr), PDT(nullptr), LI(nullptr), ACT(nullptr), Reader(), 100f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Samples(nullptr), Filename(Name), ProfileIsValid(false), 101de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar TotalCollectedSamples(0) {} 102f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 103de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool doInitialization(Module &M); 104de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool runOnModule(Module &M); 105de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setACT(AssumptionCacheTracker *A) { ACT = A; } 106f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 107f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void dump() { Reader->dump(); } 108f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 109f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarprotected: 110f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool runOnFunction(Function &F); 111f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned getFunctionLoc(Function &F); 112f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool emitAnnotations(Function &F); 113f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ErrorOr<uint64_t> getInstWeight(const Instruction &I) const; 114f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ErrorOr<uint64_t> getBlockWeight(const BasicBlock *BB) const; 115f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *findCalleeFunctionSamples(const CallInst &I) const; 116f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *findFunctionSamples(const Instruction &I) const; 117f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool inlineHotFunctions(Function &F); 118f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void printEdgeWeight(raw_ostream &OS, Edge E); 119f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void printBlockWeight(raw_ostream &OS, const BasicBlock *BB) const; 120f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void printBlockEquivalence(raw_ostream &OS, const BasicBlock *BB); 121f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool computeBlockWeights(Function &F); 122f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void findEquivalenceClasses(Function &F); 123de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void findEquivalencesFor(BasicBlock *BB1, ArrayRef<BasicBlock *> Descendants, 124f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DominatorTreeBase<BasicBlock> *DomTree); 125f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void propagateWeights(Function &F); 126f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t visitEdge(Edge E, unsigned *NumUnknownEdges, Edge *UnknownEdge); 127f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void buildEdges(Function &F); 128f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool propagateThroughEdges(Function &F); 129f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void computeDominanceAndLoopInfo(Function &F); 130f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned getOffset(unsigned L, unsigned H) const; 131f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void clearFunctionData(); 132f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 133f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Map basic blocks to their computed weights. 134f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 135f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// The weight of a basic block is defined to be the maximum 136f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// of all the instruction weights in that block. 137f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockWeightMap BlockWeights; 138f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 139f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Map edges to their computed weights. 140f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 141f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Edge weights are computed by propagating basic block weights in 142f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// SampleProfile::propagateWeights. 143f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeightMap EdgeWeights; 144f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 145f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Set of visited blocks during propagation. 146de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SmallPtrSet<const BasicBlock *, 32> VisitedBlocks; 147f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 148f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Set of visited edges during propagation. 149de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SmallSet<Edge, 32> VisitedEdges; 150f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 151f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Equivalence classes for block weights. 152f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 153f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Two blocks BB1 and BB2 are in the same equivalence class if they 154f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// dominate and post-dominate each other, and they are in the same loop 155f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// nest. When this happens, the two blocks are guaranteed to execute 156f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// the same number of times. 157f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EquivalenceClassMap EquivalenceClass; 158f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 159f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Dominance, post-dominance and loop information. 160f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar std::unique_ptr<DominatorTree> DT; 161f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar std::unique_ptr<DominatorTreeBase<BasicBlock>> PDT; 162f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar std::unique_ptr<LoopInfo> LI; 163f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 164de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AssumptionCacheTracker *ACT; 165de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 166f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Predecessors for each basic block in the CFG. 167f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockEdgeMap Predecessors; 168f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 169f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Successors for each basic block in the CFG. 170f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockEdgeMap Successors; 171f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 172f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Profile reader object. 173f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar std::unique_ptr<SampleProfileReader> Reader; 174f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 175f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Samples collected for the body of this function. 176f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar FunctionSamples *Samples; 177f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 178f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Name of the profile file to load. 179f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar StringRef Filename; 180f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 181f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Flag indicating whether the profile input loaded successfully. 182f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool ProfileIsValid; 183f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 184f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Total number of samples collected in this profile. 185f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 186f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// This is the sum of all the samples collected in all the functions executed 187f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// at runtime. 188f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t TotalCollectedSamples; 189f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar}; 190f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 191de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass SampleProfileLoaderLegacyPass : public ModulePass { 192de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarpublic: 193de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Class identification, replacement for typeinfo 194de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar static char ID; 195de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 196de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SampleProfileLoaderLegacyPass(StringRef Name = SampleProfileFile) 197de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar : ModulePass(ID), SampleLoader(Name) { 198de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar initializeSampleProfileLoaderLegacyPassPass( 199de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar *PassRegistry::getPassRegistry()); 200de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 201de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 202de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void dump() { SampleLoader.dump(); } 203de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 204de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool doInitialization(Module &M) override { 205de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return SampleLoader.doInitialization(M); 206de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 207de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const char *getPassName() const override { return "Sample profile pass"; } 208de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool runOnModule(Module &M) override; 209de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 210de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void getAnalysisUsage(AnalysisUsage &AU) const override { 211de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AU.addRequired<AssumptionCacheTracker>(); 212de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 213de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarprivate: 214de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SampleProfileLoader SampleLoader; 215de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar}; 216de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 217f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarclass SampleCoverageTracker { 218f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarpublic: 219f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SampleCoverageTracker() : SampleCoverage(), TotalUsedSamples(0) {} 220f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 221f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool markSamplesUsed(const FunctionSamples *FS, uint32_t LineOffset, 222f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t Discriminator, uint64_t Samples); 223f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned computeCoverage(unsigned Used, unsigned Total) const; 224f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned countUsedRecords(const FunctionSamples *FS) const; 225f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned countBodyRecords(const FunctionSamples *FS) const; 226f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t getTotalUsedSamples() const { return TotalUsedSamples; } 227f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t countBodySamples(const FunctionSamples *FS) const; 228f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void clear() { 229f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SampleCoverage.clear(); 230f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TotalUsedSamples = 0; 231f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 232f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 233f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarprivate: 234f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar typedef std::map<LineLocation, unsigned> BodySampleCoverageMap; 235f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar typedef DenseMap<const FunctionSamples *, BodySampleCoverageMap> 236f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar FunctionSamplesCoverageMap; 237f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 238f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Coverage map for sampling records. 239f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 240f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// This map keeps a record of sampling records that have been matched to 241f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// an IR instruction. This is used to detect some form of staleness in 242f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// profiles (see flag -sample-profile-check-coverage). 243f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 244f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Each entry in the map corresponds to a FunctionSamples instance. This is 245f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// another map that counts how many times the sample record at the 246f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// given location has been used. 247f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar FunctionSamplesCoverageMap SampleCoverage; 248f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 249f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Number of samples used from the profile. 250f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 251f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// When a sampling record is used for the first time, the samples from 252f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// that record are added to this accumulator. Coverage is later computed 253f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// based on the total number of samples available in this function and 254f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// its callsites. 255f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// 256f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Note that this accumulator tracks samples used from a single function 257f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// and all the inlined callsites. Strictly, we should have a map of counters 258f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// keyed by FunctionSamples pointers, but these stats are cleared after 259f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// every function, so we just need to keep a single counter. 260f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t TotalUsedSamples; 261f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar}; 262f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 263f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleCoverageTracker CoverageTracker; 264f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 265f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Return true if the given callsite is hot wrt to its caller. 266f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 267f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Functions that were inlined in the original binary will be represented 268f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// in the inline stack in the sample profile. If the profile shows that 269f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the original inline decision was "good" (i.e., the callsite is executed 270f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// frequently), then we will recreate the inline decision and apply the 271f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// profile from the inlined callsite. 272f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 273f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// To decide whether an inlined callsite is hot, we compute the fraction 274f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// of samples used by the callsite with respect to the total number of samples 275f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// collected in the caller. 276f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 277f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// If that fraction is larger than the default given by 278f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// SampleProfileHotThreshold, the callsite will be inlined again. 279f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool callsiteIsHot(const FunctionSamples *CallerFS, 280f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *CallsiteFS) { 281f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!CallsiteFS) 282f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; // The callsite was not inlined in the original binary. 283f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 284f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t ParentTotalSamples = CallerFS->getTotalSamples(); 285f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (ParentTotalSamples == 0) 286f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; // Avoid division by zero. 287f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 288f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t CallsiteTotalSamples = CallsiteFS->getTotalSamples(); 289f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (CallsiteTotalSamples == 0) 290f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; // Callsite is trivially cold. 291f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 292f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar double PercentSamples = 293f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar (double)CallsiteTotalSamples / (double)ParentTotalSamples * 100.0; 294f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return PercentSamples >= SampleProfileHotThreshold; 295f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 296f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 297f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 298f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Mark as used the sample record for the given function samples at 299f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// (LineOffset, Discriminator). 300f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 301f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns true if this is the first time we mark the given record. 302f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleCoverageTracker::markSamplesUsed(const FunctionSamples *FS, 303f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t LineOffset, 304f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t Discriminator, 305f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Samples) { 306f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LineLocation Loc(LineOffset, Discriminator); 307f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned &Count = SampleCoverage[FS][Loc]; 308f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool FirstTime = (++Count == 1); 309f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (FirstTime) 310f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TotalUsedSamples += Samples; 311f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return FirstTime; 312f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 313f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 314f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Return the number of sample records that were applied from this profile. 315f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 316f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This count does not include records from cold inlined callsites. 317f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarunsigned 318f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleCoverageTracker::countUsedRecords(const FunctionSamples *FS) const { 319f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar auto I = SampleCoverage.find(FS); 320f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 321f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // The size of the coverage map for FS represents the number of records 322f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // that were marked used at least once. 323f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Count = (I != SampleCoverage.end()) ? I->second.size() : 0; 324f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 325f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If there are inlined callsites in this function, count the samples found 326f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // in the respective bodies. However, do not bother counting callees with 0 327f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // total samples, these are callees that were never invoked at runtime. 328f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &I : FS->getCallsiteSamples()) { 329f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *CalleeSamples = &I.second; 330f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (callsiteIsHot(FS, CalleeSamples)) 331f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Count += countUsedRecords(CalleeSamples); 332f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 333f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 334f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Count; 335f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 336f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 337f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Return the number of sample records in the body of this profile. 338f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 339f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This count does not include records from cold inlined callsites. 340f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarunsigned 341f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleCoverageTracker::countBodyRecords(const FunctionSamples *FS) const { 342f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Count = FS->getBodySamples().size(); 343f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 344f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Only count records in hot callsites. 345f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &I : FS->getCallsiteSamples()) { 346f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *CalleeSamples = &I.second; 347f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (callsiteIsHot(FS, CalleeSamples)) 348f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Count += countBodyRecords(CalleeSamples); 349f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 350f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 351f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Count; 352f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 353f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 354f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Return the number of samples collected in the body of this profile. 355f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 356f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This count does not include samples from cold inlined callsites. 357f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainaruint64_t 358f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleCoverageTracker::countBodySamples(const FunctionSamples *FS) const { 359f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Total = 0; 360f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &I : FS->getBodySamples()) 361f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Total += I.second.getSamples(); 362f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 363f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Only count samples in hot callsites. 364f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &I : FS->getCallsiteSamples()) { 365f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *CalleeSamples = &I.second; 366f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (callsiteIsHot(FS, CalleeSamples)) 367f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Total += countBodySamples(CalleeSamples); 368f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 369f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 370f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Total; 371f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 372f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 373f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Return the fraction of sample records used in this profile. 374f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 375f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The returned value is an unsigned integer in the range 0-100 indicating 376f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the percentage of sample records that were used while applying this 377f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// profile to the associated function. 378f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarunsigned SampleCoverageTracker::computeCoverage(unsigned Used, 379f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Total) const { 380f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar assert(Used <= Total && 381f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "number of used records cannot exceed the total number of records"); 382f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Total > 0 ? Used * 100 / Total : 100; 383f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 384f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 385f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Clear all the per-function data used to load samples and propagate weights. 386f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::clearFunctionData() { 387f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockWeights.clear(); 388f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeights.clear(); 389f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar VisitedBlocks.clear(); 390f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar VisitedEdges.clear(); 391f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EquivalenceClass.clear(); 392f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DT = nullptr; 393f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar PDT = nullptr; 394f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LI = nullptr; 395f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Predecessors.clear(); 396f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Successors.clear(); 397f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar CoverageTracker.clear(); 398f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 399f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 400f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Returns the offset of lineno \p L to head_lineno \p H 401f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 402f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param L Lineno 403f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param H Header lineno of the function 404f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 405f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns offset to the header lineno. 16 bits are used to represent offset. 406f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// We assume that a single function will not exceed 65535 LOC. 407f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarunsigned SampleProfileLoader::getOffset(unsigned L, unsigned H) const { 408f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return (L - H) & 0xffff; 409f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 410f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 411f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Print the weight of edge \p E on stream \p OS. 412f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 413f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param OS Stream to emit the output to. 414f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param E Edge to print. 415f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::printEdgeWeight(raw_ostream &OS, Edge E) { 416f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar OS << "weight[" << E.first->getName() << "->" << E.second->getName() 417f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << "]: " << EdgeWeights[E] << "\n"; 418f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 419f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 420f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Print the equivalence class of block \p BB on stream \p OS. 421f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 422f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param OS Stream to emit the output to. 423f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param BB Block to print. 424f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::printBlockEquivalence(raw_ostream &OS, 425f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *BB) { 426f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *Equiv = EquivalenceClass[BB]; 427f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar OS << "equivalence[" << BB->getName() 428f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << "]: " << ((Equiv) ? EquivalenceClass[BB]->getName() : "NONE") << "\n"; 429f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 430f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 431f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Print the weight of block \p BB on stream \p OS. 432f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 433f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param OS Stream to emit the output to. 434f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param BB Block to print. 435f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::printBlockWeight(raw_ostream &OS, 436f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *BB) const { 437f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const auto &I = BlockWeights.find(BB); 438f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t W = (I == BlockWeights.end() ? 0 : I->second); 439f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar OS << "weight[" << BB->getName() << "]: " << W << "\n"; 440f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 441f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 442f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Get the weight for an instruction. 443f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 444f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The "weight" of an instruction \p Inst is the number of samples 445f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// collected on that instruction at runtime. To retrieve it, we 446f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// need to compute the line number of \p Inst relative to the start of its 447f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// function. We use HeaderLineno to compute the offset. We then 448f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// look up the samples collected for \p Inst using BodySamples. 449f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 450f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param Inst Instruction to query. 451f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 452f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns the weight of \p Inst. 453f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarErrorOr<uint64_t> 454f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleProfileLoader::getInstWeight(const Instruction &Inst) const { 455de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const DebugLoc &DLoc = Inst.getDebugLoc(); 456f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!DLoc) 457f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return std::error_code(); 458f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 459f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *FS = findFunctionSamples(Inst); 460f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!FS) 461f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return std::error_code(); 462f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 463de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Ignore all dbg_value intrinsics. 464de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const IntrinsicInst *II = dyn_cast<IntrinsicInst>(&Inst); 465de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (II && II->getIntrinsicID() == Intrinsic::dbg_value) 466de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return std::error_code(); 467de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 468f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const DILocation *DIL = DLoc; 469f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Lineno = DLoc.getLine(); 470f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned HeaderLineno = DIL->getScope()->getSubprogram()->getLine(); 471f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 472f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t LineOffset = getOffset(Lineno, HeaderLineno); 473f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t Discriminator = DIL->getDiscriminator(); 474f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ErrorOr<uint64_t> R = FS->findSamplesAt(LineOffset, Discriminator); 475f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (R) { 476f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool FirstMark = 477f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar CoverageTracker.markSamplesUsed(FS, LineOffset, Discriminator, R.get()); 478f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (FirstMark) { 479f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const Function *F = Inst.getParent()->getParent(); 480f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LLVMContext &Ctx = F->getContext(); 481f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar emitOptimizationRemark( 482f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Ctx, DEBUG_TYPE, *F, DLoc, 483f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine("Applied ") + Twine(*R) + " samples from profile (offset: " + 484f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(LineOffset) + 485f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ((Discriminator) ? Twine(".") + Twine(Discriminator) : "") + ")"); 486f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 487f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << " " << Lineno << "." << DIL->getDiscriminator() << ":" 488f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << Inst << " (line offset: " << Lineno - HeaderLineno << "." 489f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << DIL->getDiscriminator() << " - weight: " << R.get() 490f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << ")\n"); 491de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } else { 492de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // If a call instruction is inlined in profile, but not inlined here, 493de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // it means that the inlined callsite has no sample, thus the call 494de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // instruction should have 0 count. 495de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const CallInst *CI = dyn_cast<CallInst>(&Inst); 496de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (CI && findCalleeFunctionSamples(*CI)) 497de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar R = 0; 498f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 499f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return R; 500f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 501f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 502f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Compute the weight of a basic block. 503f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 504f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The weight of basic block \p BB is the maximum weight of all the 505f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// instructions in BB. 506f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 507f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param BB The basic block to query. 508f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 509f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns the weight for \p BB. 510f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarErrorOr<uint64_t> 511f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleProfileLoader::getBlockWeight(const BasicBlock *BB) const { 512de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar DenseMap<uint64_t, uint64_t> CM; 513f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &I : BB->getInstList()) { 514f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const ErrorOr<uint64_t> &R = getInstWeight(I); 515de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (R) CM[R.get()]++; 516de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 517de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (CM.size() == 0) return std::error_code(); 518de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar uint64_t W = 0, C = 0; 519de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar for (const auto &C_W : CM) { 520de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (C_W.second == W) { 521de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar C = std::max(C, C_W.first); 522de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } else if (C_W.second > W) { 523de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar C = C_W.first; 524de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar W = C_W.second; 525f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 526f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 527de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return C; 528f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 529f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 530f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Compute and store the weights of every basic block. 531f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 532f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This populates the BlockWeights map by computing 533f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the weights of every basic block in the CFG. 534f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 535f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F The function to query. 536f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::computeBlockWeights(Function &F) { 537f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool Changed = false; 538f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "Block weights\n"); 539f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &BB : F) { 540f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ErrorOr<uint64_t> Weight = getBlockWeight(&BB); 541f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Weight) { 542f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockWeights[&BB] = Weight.get(); 543f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar VisitedBlocks.insert(&BB); 544f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = true; 545f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 546f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(printBlockWeight(dbgs(), &BB)); 547f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 548f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 549f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Changed; 550f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 551f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 552f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Get the FunctionSamples for a call instruction. 553f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 554f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The FunctionSamples of a call instruction \p Inst is the inlined 555f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// instance in which that call instruction is calling to. It contains 556f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// all samples that resides in the inlined instance. We first find the 557f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// inlined instance in which the call instruction is from, then we 558f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// traverse its children to find the callsite with the matching 559f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// location and callee function name. 560f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 561f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param Inst Call instruction to query. 562f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 563f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns The FunctionSamples pointer to the inlined instance. 564f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarconst FunctionSamples * 565f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleProfileLoader::findCalleeFunctionSamples(const CallInst &Inst) const { 566f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const DILocation *DIL = Inst.getDebugLoc(); 567f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!DIL) { 568f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return nullptr; 569f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 570f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DISubprogram *SP = DIL->getScope()->getSubprogram(); 571f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!SP) 572f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return nullptr; 573f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 574f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *FS = findFunctionSamples(Inst); 575f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (FS == nullptr) 576f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return nullptr; 577f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 578de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return FS->findFunctionSamplesAt(LineLocation( 579de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar getOffset(DIL->getLine(), SP->getLine()), DIL->getDiscriminator())); 580f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 581f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 582f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Get the FunctionSamples for an instruction. 583f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 584f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The FunctionSamples of an instruction \p Inst is the inlined instance 585f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// in which that instruction is coming from. We traverse the inline stack 586f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// of that instruction, and match it with the tree nodes in the profile. 587f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 588f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param Inst Instruction to query. 589f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 590f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns the FunctionSamples pointer to the inlined instance. 591f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarconst FunctionSamples * 592f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarSampleProfileLoader::findFunctionSamples(const Instruction &Inst) const { 593de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SmallVector<LineLocation, 10> S; 594f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const DILocation *DIL = Inst.getDebugLoc(); 595f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!DIL) { 596f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Samples; 597f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 598de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar for (DIL = DIL->getInlinedAt(); DIL; DIL = DIL->getInlinedAt()) { 599f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DISubprogram *SP = DIL->getScope()->getSubprogram(); 600f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!SP) 601f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return nullptr; 602de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar S.push_back(LineLocation(getOffset(DIL->getLine(), SP->getLine()), 603de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar DIL->getDiscriminator())); 604f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 605f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (S.size() == 0) 606f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Samples; 607f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const FunctionSamples *FS = Samples; 608f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (int i = S.size() - 1; i >= 0 && FS != nullptr; i--) { 609f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar FS = FS->findFunctionSamplesAt(S[i]); 610f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 611f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return FS; 612f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 613f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 614f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 615f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Iteratively inline hot callsites of a function. 616f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 617f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Iteratively traverse all callsites of the function \p F, and find if 618f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the corresponding inlined instance exists and is hot in profile. If 619f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// it is hot enough, inline the callsites and adds new callsites of the 620f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// callee into the caller. 621f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 622f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// TODO: investigate the possibility of not invoking InlineFunction directly. 623f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 624f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F function to perform iterative inlining. 625f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 626f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns True if there is any inline happened. 627f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::inlineHotFunctions(Function &F) { 628f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool Changed = false; 629f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LLVMContext &Ctx = F.getContext(); 630f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar while (true) { 631f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool LocalChanged = false; 632f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SmallVector<CallInst *, 10> CIS; 633f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &BB : F) { 634f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &I : BB.getInstList()) { 635f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar CallInst *CI = dyn_cast<CallInst>(&I); 636f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (CI && callsiteIsHot(Samples, findCalleeFunctionSamples(*CI))) 637f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar CIS.push_back(CI); 638f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 639f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 640f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto CI : CIS) { 641de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar InlineFunctionInfo IFI(nullptr, ACT); 642f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Function *CalledFunction = CI->getCalledFunction(); 643f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DebugLoc DLoc = CI->getDebugLoc(); 644f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t NumSamples = findCalleeFunctionSamples(*CI)->getTotalSamples(); 645f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (InlineFunction(CI, IFI)) { 646f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LocalChanged = true; 647f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar emitOptimizationRemark(Ctx, DEBUG_TYPE, F, DLoc, 648f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine("inlined hot callee '") + 649f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar CalledFunction->getName() + "' with " + 650f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(NumSamples) + " samples into '" + 651f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar F.getName() + "'"); 652f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 653f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 654f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (LocalChanged) { 655f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = true; 656f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } else { 657f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar break; 658f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 659f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 660f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Changed; 661f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 662f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 663f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Find equivalence classes for the given block. 664f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 665f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This finds all the blocks that are guaranteed to execute the same 666f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// number of times as \p BB1. To do this, it traverses all the 667f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// descendants of \p BB1 in the dominator or post-dominator tree. 668f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 669f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// A block BB2 will be in the same equivalence class as \p BB1 if 670f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the following holds: 671f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 672f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1- \p BB1 is a descendant of BB2 in the opposite tree. So, if BB2 673f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// is a descendant of \p BB1 in the dominator tree, then BB2 should 674f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// dominate BB1 in the post-dominator tree. 675f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 676f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 2- Both BB2 and \p BB1 must be in the same loop. 677f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 678f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// For every block BB2 that meets those two requirements, we set BB2's 679f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// equivalence class to \p BB1. 680f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 681f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param BB1 Block to check. 682f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param Descendants Descendants of \p BB1 in either the dom or pdom tree. 683f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param DomTree Opposite dominator tree. If \p Descendants is filled 684f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// with blocks from \p BB1's dominator tree, then 685f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// this is the post-dominator tree, and vice versa. 686f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::findEquivalencesFor( 687de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar BasicBlock *BB1, ArrayRef<BasicBlock *> Descendants, 688f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DominatorTreeBase<BasicBlock> *DomTree) { 689f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *EC = EquivalenceClass[BB1]; 690f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Weight = BlockWeights[EC]; 691f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto *BB2 : Descendants) { 692f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool IsDomParent = DomTree->dominates(BB2, BB1); 693f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool IsInSameLoop = LI->getLoopFor(BB1) == LI->getLoopFor(BB2); 694f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (BB1 != BB2 && IsDomParent && IsInSameLoop) { 695f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EquivalenceClass[BB2] = EC; 696f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 697f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If BB2 is heavier than BB1, make BB2 have the same weight 698f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // as BB1. 699f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 700f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Note that we don't worry about the opposite situation here 701f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // (when BB2 is lighter than BB1). We will deal with this 702f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // during the propagation phase. Right now, we just want to 703f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // make sure that BB1 has the largest weight of all the 704f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // members of its equivalence set. 705f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Weight = std::max(Weight, BlockWeights[BB2]); 706f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 707f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 708f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockWeights[EC] = Weight; 709f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 710f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 711f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Find equivalence classes. 712f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 713f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Since samples may be missing from blocks, we can fill in the gaps by setting 714f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the weights of all the blocks in the same equivalence class to the same 715f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// weight. To compute the concept of equivalence, we use dominance and loop 716f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// information. Two blocks B1 and B2 are in the same equivalence class if B1 717f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// dominates B2, B2 post-dominates B1 and both are in the same loop. 718f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 719f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F The function to query. 720f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::findEquivalenceClasses(Function &F) { 721f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SmallVector<BasicBlock *, 8> DominatedBBs; 722f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\nBlock equivalence classes\n"); 723f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Find equivalence sets based on dominance and post-dominance information. 724f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &BB : F) { 725f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *BB1 = &BB; 726f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 727f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Compute BB1's equivalence class once. 728f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (EquivalenceClass.count(BB1)) { 729f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(printBlockEquivalence(dbgs(), BB1)); 730f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar continue; 731f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 732f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 733f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // By default, blocks are in their own equivalence class. 734f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EquivalenceClass[BB1] = BB1; 735f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 736f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Traverse all the blocks dominated by BB1. We are looking for 737f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // every basic block BB2 such that: 738f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 739f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 1- BB1 dominates BB2. 740f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 2- BB2 post-dominates BB1. 741f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 3- BB1 and BB2 are in the same loop nest. 742f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 743f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If all those conditions hold, it means that BB2 is executed 744f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // as many times as BB1, so they are placed in the same equivalence 745f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // class by making BB2's equivalence class be BB1. 746f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DominatedBBs.clear(); 747f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DT->getDescendants(BB1, DominatedBBs); 748f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar findEquivalencesFor(BB1, DominatedBBs, PDT.get()); 749f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 750f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(printBlockEquivalence(dbgs(), BB1)); 751f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 752f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 753f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Assign weights to equivalence classes. 754f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 755f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // All the basic blocks in the same equivalence class will execute 756f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // the same number of times. Since we know that the head block in 757f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // each equivalence class has the largest weight, assign that weight 758f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // to all the blocks in that equivalence class. 759f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\nAssign the same weight to all blocks in the same class\n"); 760f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &BI : F) { 761f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *BB = &BI; 762f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *EquivBB = EquivalenceClass[BB]; 763f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (BB != EquivBB) 764f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BlockWeights[BB] = BlockWeights[EquivBB]; 765f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(printBlockWeight(dbgs(), BB)); 766f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 767f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 768f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 769f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Visit the given edge to decide if it has a valid weight. 770f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 771f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// If \p E has not been visited before, we copy to \p UnknownEdge 772f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// and increment the count of unknown edges. 773f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 774f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param E Edge to visit. 775f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param NumUnknownEdges Current number of unknown edges. 776f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param UnknownEdge Set if E has not been visited before. 777f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 778f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns E's weight, if known. Otherwise, return 0. 779f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainaruint64_t SampleProfileLoader::visitEdge(Edge E, unsigned *NumUnknownEdges, 780f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Edge *UnknownEdge) { 781f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!VisitedEdges.count(E)) { 782f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar (*NumUnknownEdges)++; 783f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar *UnknownEdge = E; 784f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return 0; 785f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 786f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 787f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return EdgeWeights[E]; 788f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 789f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 790f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Propagate weights through incoming/outgoing edges. 791f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 792f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// If the weight of a basic block is known, and there is only one edge 793f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// with an unknown weight, we can calculate the weight of that edge. 794f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 795f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Similarly, if all the edges have a known count, we can calculate the 796f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// count of the basic block, if needed. 797f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 798f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F Function to process. 799f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 800f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns True if new weights were assigned to edges or blocks. 801f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::propagateThroughEdges(Function &F) { 802f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool Changed = false; 803f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\nPropagation through edges\n"); 804f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &BI : F) { 805f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *BB = &BI; 806f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BasicBlock *EC = EquivalenceClass[BB]; 807f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 808f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Visit all the predecessor and successor edges to determine 809f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // which ones have a weight assigned already. Note that it doesn't 810f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // matter that we only keep track of a single unknown edge. The 811f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // only case we are interested in handling is when only a single 812f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // edge is unknown (see setEdgeOrBlockWeight). 813f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (unsigned i = 0; i < 2; i++) { 814f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t TotalWeight = 0; 815de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar unsigned NumUnknownEdges = 0, NumTotalEdges = 0; 816de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Edge UnknownEdge, SelfReferentialEdge, SingleEdge; 817f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 818f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (i == 0) { 819f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // First, visit all predecessor edges. 820de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar NumTotalEdges = Predecessors[BB].size(); 821f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto *Pred : Predecessors[BB]) { 822f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Edge E = std::make_pair(Pred, BB); 823f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TotalWeight += visitEdge(E, &NumUnknownEdges, &UnknownEdge); 824f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (E.first == E.second) 825f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SelfReferentialEdge = E; 826f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 827de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (NumTotalEdges == 1) { 828de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SingleEdge = std::make_pair(Predecessors[BB][0], BB); 829de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 830f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } else { 831f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // On the second round, visit all successor edges. 832de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar NumTotalEdges = Successors[BB].size(); 833f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto *Succ : Successors[BB]) { 834f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Edge E = std::make_pair(BB, Succ); 835f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TotalWeight += visitEdge(E, &NumUnknownEdges, &UnknownEdge); 836f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 837de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (NumTotalEdges == 1) { 838de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SingleEdge = std::make_pair(BB, Successors[BB][0]); 839de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 840f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 841f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 842f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // After visiting all the edges, there are three cases that we 843f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // can handle immediately: 844f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 845f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // - All the edge weights are known (i.e., NumUnknownEdges == 0). 846f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // In this case, we simply check that the sum of all the edges 847f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // is the same as BB's weight. If not, we change BB's weight 848f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // to match. Additionally, if BB had not been visited before, 849f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // we mark it visited. 850f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 851f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // - Only one edge is unknown and BB has already been visited. 852f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // In this case, we can compute the weight of the edge by 853f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // subtracting the total block weight from all the known 854f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // edge weights. If the edges weight more than BB, then the 855f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // edge of the last remaining edge is set to zero. 856f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 857f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // - There exists a self-referential edge and the weight of BB is 858f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // known. In this case, this edge can be based on BB's weight. 859f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // We add up all the other known edges and set the weight on 860f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // the self-referential edge as we did in the previous case. 861f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // 862f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // In any other case, we must continue iterating. Eventually, 863f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // all edges will get a weight, or iteration will stop when 864f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // it reaches SampleProfileMaxPropagateIterations. 865f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (NumUnknownEdges <= 1) { 866f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t &BBWeight = BlockWeights[EC]; 867f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (NumUnknownEdges == 0) { 868de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (!VisitedBlocks.count(EC)) { 869de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // If we already know the weight of all edges, the weight of the 870de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // basic block can be computed. It should be no larger than the sum 871de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // of all edge weights. 872de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (TotalWeight > BBWeight) { 873de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar BBWeight = TotalWeight; 874de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Changed = true; 875de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar DEBUG(dbgs() << "All edge weights for " << BB->getName() 876de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar << " known. Set weight for block: "; 877de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar printBlockWeight(dbgs(), BB);); 878de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 879de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } else if (NumTotalEdges == 1 && 880de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar EdgeWeights[SingleEdge] < BlockWeights[EC]) { 881de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // If there is only one edge for the visited basic block, use the 882de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // block weight to adjust edge weight if edge weight is smaller. 883de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar EdgeWeights[SingleEdge] = BlockWeights[EC]; 884f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = true; 885f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 886f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } else if (NumUnknownEdges == 1 && VisitedBlocks.count(EC)) { 887f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If there is a single unknown edge and the block has been 888f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // visited, then we can compute E's weight. 889f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (BBWeight >= TotalWeight) 890f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeights[UnknownEdge] = BBWeight - TotalWeight; 891f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar else 892f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeights[UnknownEdge] = 0; 893f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar VisitedEdges.insert(UnknownEdge); 894f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = true; 895f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "Set weight for edge: "; 896f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar printEdgeWeight(dbgs(), UnknownEdge)); 897f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 898f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } else if (SelfReferentialEdge.first && VisitedBlocks.count(EC)) { 899f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t &BBWeight = BlockWeights[BB]; 900f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // We have a self-referential edge and the weight of BB is known. 901f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (BBWeight >= TotalWeight) 902f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeights[SelfReferentialEdge] = BBWeight - TotalWeight; 903f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar else 904f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EdgeWeights[SelfReferentialEdge] = 0; 905f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar VisitedEdges.insert(SelfReferentialEdge); 906f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = true; 907f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "Set self-referential edge weight to: "; 908f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar printEdgeWeight(dbgs(), SelfReferentialEdge)); 909f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 910f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 911f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 912f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 913f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Changed; 914f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 915f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 916f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Build in/out edge lists for each basic block in the CFG. 917f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 918f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// We are interested in unique edges. If a block B1 has multiple 919f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// edges to another block B2, we only add a single B1->B2 edge. 920f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::buildEdges(Function &F) { 921f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &BI : F) { 922f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *B1 = &BI; 923f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 924f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Add predecessors for B1. 925f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SmallPtrSet<BasicBlock *, 16> Visited; 926f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!Predecessors[B1].empty()) 927f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar llvm_unreachable("Found a stale predecessors list in a basic block."); 928f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (pred_iterator PI = pred_begin(B1), PE = pred_end(B1); PI != PE; ++PI) { 929f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *B2 = *PI; 930f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Visited.insert(B2).second) 931f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Predecessors[B1].push_back(B2); 932f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 933f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 934f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Add successors for B1. 935f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Visited.clear(); 936f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!Successors[B1].empty()) 937f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar llvm_unreachable("Found a stale successors list in a basic block."); 938f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (succ_iterator SI = succ_begin(B1), SE = succ_end(B1); SI != SE; ++SI) { 939f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *B2 = *SI; 940f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Visited.insert(B2).second) 941f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Successors[B1].push_back(B2); 942f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 943f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 944f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 945f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 946f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Propagate weights into edges 947f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 948f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// The following rules are applied to every block BB in the CFG: 949f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 950f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If BB has a single predecessor/successor, then the weight 951f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// of that edge is the weight of the block. 952f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 953f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If all incoming or outgoing edges are known except one, and the 954f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// weight of the block is already known, the weight of the unknown 955f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// edge will be the weight of the block minus the sum of all the known 956f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// edges. If the sum of all the known edges is larger than BB's weight, 957f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// we set the unknown edge weight to zero. 958f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 959f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If there is a self-referential edge, and the weight of the block is 960f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// known, the weight for that edge is set to the weight of the block 961f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// minus the weight of the other incoming edges to that block (if 962f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// known). 963f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::propagateWeights(Function &F) { 964f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool Changed = true; 965f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned I = 0; 966f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 967f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Add an entry count to the function using the samples gathered 968f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // at the function entry. 969f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar F.setEntryCount(Samples->getHeadSamples()); 970f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 971f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Before propagation starts, build, for each block, a list of 972f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // unique predecessors and successors. This is necessary to handle 973f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // identical edges in multiway branches. Since we visit all blocks and all 974f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // edges of the CFG, it is cleaner to build these lists once at the start 975f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // of the pass. 976f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar buildEdges(F); 977f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 978f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Propagate until we converge or we go past the iteration limit. 979f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar while (Changed && I++ < SampleProfileMaxPropagateIterations) { 980f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed = propagateThroughEdges(F); 981f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 982f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 983f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Generate MD_prof metadata for every branch instruction using the 984f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // edge weights computed during propagation. 985f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\nPropagation complete. Setting branch weights\n"); 986f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LLVMContext &Ctx = F.getContext(); 987f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar MDBuilder MDB(Ctx); 988f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &BI : F) { 989f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *BB = &BI; 990de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 991de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (BlockWeights[BB]) { 992de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar for (auto &I : BB->getInstList()) { 993de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (CallInst *CI = dyn_cast<CallInst>(&I)) { 994de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (!dyn_cast<IntrinsicInst>(&I)) { 995de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SmallVector<uint32_t, 1> Weights; 996de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Weights.push_back(BlockWeights[BB]); 997de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar CI->setMetadata(LLVMContext::MD_prof, 998de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar MDB.createBranchWeights(Weights)); 999de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 1000de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 1001de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 1002de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 1003f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TerminatorInst *TI = BB->getTerminator(); 1004f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (TI->getNumSuccessors() == 1) 1005f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar continue; 1006f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!isa<BranchInst>(TI) && !isa<SwitchInst>(TI)) 1007f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar continue; 1008f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1009f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\nGetting weights for branch at line " 1010f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << TI->getDebugLoc().getLine() << ".\n"); 1011f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar SmallVector<uint32_t, 4> Weights; 1012f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint32_t MaxWeight = 0; 1013f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DebugLoc MaxDestLoc; 1014f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (unsigned I = 0; I < TI->getNumSuccessors(); ++I) { 1015f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BasicBlock *Succ = TI->getSuccessor(I); 1016f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Edge E = std::make_pair(BB, Succ); 1017f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Weight = EdgeWeights[E]; 1018f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "\t"; printEdgeWeight(dbgs(), E)); 1019f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Use uint32_t saturated arithmetic to adjust the incoming weights, 1020f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // if needed. Sample counts in profiles are 64-bit unsigned values, 1021f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // but internally branch weights are expressed as 32-bit values. 1022f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Weight > std::numeric_limits<uint32_t>::max()) { 1023f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << " (saturated due to uint32_t overflow)"); 1024f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Weight = std::numeric_limits<uint32_t>::max(); 1025f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1026f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Weights.push_back(static_cast<uint32_t>(Weight)); 1027f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Weight != 0) { 1028f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Weight > MaxWeight) { 1029f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar MaxWeight = Weight; 1030f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar MaxDestLoc = Succ->getFirstNonPHIOrDbgOrLifetime()->getDebugLoc(); 1031f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1032f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1033f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1034f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1035f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Only set weights if there is at least one non-zero weight. 1036f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // In any other case, let the analyzer set weights. 1037f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (MaxWeight > 0) { 1038f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "SUCCESS. Found non-zero weights.\n"); 1039f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TI->setMetadata(llvm::LLVMContext::MD_prof, 1040f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar MDB.createBranchWeights(Weights)); 1041f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DebugLoc BranchLoc = TI->getDebugLoc(); 1042f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar emitOptimizationRemark( 1043f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Ctx, DEBUG_TYPE, F, MaxDestLoc, 1044f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine("most popular destination for conditional branches at ") + 1045f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ((BranchLoc) ? Twine(BranchLoc->getFilename() + ":" + 1046f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(BranchLoc.getLine()) + ":" + 1047f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(BranchLoc.getCol())) 1048f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar : Twine("<UNKNOWN LOCATION>"))); 1049f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } else { 1050f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "SKIPPED. All branch weights are zero.\n"); 1051f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1052f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1053f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1054f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1055f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Get the line number for the function header. 1056f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1057f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// This looks up function \p F in the current compilation unit and 1058f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// retrieves the line number where the function is defined. This is 1059f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// line 0 for all the samples read from the profile file. Every line 1060f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// number is relative to this line. 1061f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1062f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F Function object to query. 1063f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1064f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns the line number where \p F is defined. If it returns 0, 1065f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// it means that there is no debug information available for \p F. 1066f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarunsigned SampleProfileLoader::getFunctionLoc(Function &F) { 1067de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (DISubprogram *S = F.getSubprogram()) 1068f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return S->getLine(); 1069f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1070f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If the start of \p F is missing, emit a diagnostic to inform the user 1071f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // about the missed opportunity. 1072f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar F.getContext().diagnose(DiagnosticInfoSampleProfile( 1073f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "No debug information found in function " + F.getName() + 1074f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ": Function profile not used", 1075f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DS_Warning)); 1076f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return 0; 1077f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1078f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1079f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarvoid SampleProfileLoader::computeDominanceAndLoopInfo(Function &F) { 1080f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DT.reset(new DominatorTree); 1081f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DT->recalculate(F); 1082f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1083f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar PDT.reset(new DominatorTreeBase<BasicBlock>(true)); 1084f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar PDT->recalculate(F); 1085f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1086f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LI.reset(new LoopInfo); 1087f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar LI->analyze(*DT); 1088f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1089f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1090f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \brief Generate branch weight metadata for all branches in \p F. 1091f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1092f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Branch weights are computed out of instruction samples using a 1093f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// propagation heuristic. Propagation proceeds in 3 phases: 1094f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1095f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1- Assignment of block weights. All the basic blocks in the function 1096f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// are initial assigned the same weight as their most frequently 1097f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// executed instruction. 1098f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1099f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 2- Creation of equivalence classes. Since samples may be missing from 1100f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// blocks, we can fill in the gaps by setting the weights of all the 1101f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// blocks in the same equivalence class to the same weight. To compute 1102f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the concept of equivalence, we use dominance and loop information. 1103f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Two blocks B1 and B2 are in the same equivalence class if B1 1104f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// dominates B2, B2 post-dominates B1 and both are in the same loop. 1105f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1106f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 3- Propagation of block weights into edges. This uses a simple 1107f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// propagation heuristic. The following rules are applied to every 1108f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// block BB in the CFG: 1109f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1110f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If BB has a single predecessor/successor, then the weight 1111f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// of that edge is the weight of the block. 1112f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1113f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If all the edges are known except one, and the weight of the 1114f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// block is already known, the weight of the unknown edge will 1115f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// be the weight of the block minus the sum of all the known 1116f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// edges. If the sum of all the known edges is larger than BB's weight, 1117f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// we set the unknown edge weight to zero. 1118f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1119f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// - If there is a self-referential edge, and the weight of the block is 1120f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// known, the weight for that edge is set to the weight of the block 1121f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// minus the weight of the other incoming edges to that block (if 1122f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// known). 1123f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1124f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Since this propagation is not guaranteed to finalize for every CFG, we 1125f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// only allow it to proceed for a limited number of iterations (controlled 1126f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// by -sample-profile-max-propagate-iterations). 1127f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1128f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// FIXME: Try to replace this propagation heuristic with a scheme 1129f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// that is guaranteed to finalize. A work-list approach similar to 1130f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// the standard value propagation algorithm used by SSA-CCP might 1131f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// work here. 1132f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1133f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// Once all the branch weights are computed, we emit the MD_prof 1134f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// metadata on BB using the computed values for each of its branches. 1135f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1136f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \param F The function to query. 1137f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// 1138f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar/// \returns true if \p F was modified. Returns false, otherwise. 1139f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::emitAnnotations(Function &F) { 1140f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool Changed = false; 1141f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1142f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (getFunctionLoc(F) == 0) 1143f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; 1144f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1145f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DEBUG(dbgs() << "Line number for the first instruction in " << F.getName() 1146f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar << ": " << getFunctionLoc(F) << "\n"); 1147f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1148f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed |= inlineHotFunctions(F); 1149f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1150f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Compute basic block weights. 1151f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Changed |= computeBlockWeights(F); 1152f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1153f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Changed) { 1154f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Compute dominance and loop info needed for propagation. 1155f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar computeDominanceAndLoopInfo(F); 1156f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1157f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Find equivalence classes. 1158f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar findEquivalenceClasses(F); 1159f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1160f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Propagate weights to all edges. 1161f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar propagateWeights(F); 1162f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1163f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1164f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // If coverage checking was requested, compute it now. 1165f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (SampleProfileRecordCoverage) { 1166f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Used = CoverageTracker.countUsedRecords(Samples); 1167f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Total = CoverageTracker.countBodyRecords(Samples); 1168f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Coverage = CoverageTracker.computeCoverage(Used, Total); 1169f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Coverage < SampleProfileRecordCoverage) { 1170f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar F.getContext().diagnose(DiagnosticInfoSampleProfile( 1171de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar F.getSubprogram()->getFilename(), getFunctionLoc(F), 1172f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(Used) + " of " + Twine(Total) + " available profile records (" + 1173f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(Coverage) + "%) were applied", 1174f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DS_Warning)); 1175f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1176f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1177f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1178f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (SampleProfileSampleCoverage) { 1179f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Used = CoverageTracker.getTotalUsedSamples(); 1180f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t Total = CoverageTracker.countBodySamples(Samples); 1181f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned Coverage = CoverageTracker.computeCoverage(Used, Total); 1182f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Coverage < SampleProfileSampleCoverage) { 1183f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar F.getContext().diagnose(DiagnosticInfoSampleProfile( 1184de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar F.getSubprogram()->getFilename(), getFunctionLoc(F), 1185f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(Used) + " of " + Twine(Total) + " available profile samples (" + 1186f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Twine(Coverage) + "%) were applied", 1187f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar DS_Warning)); 1188f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1189f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1190f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return Changed; 1191f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1192f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1193de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarchar SampleProfileLoaderLegacyPass::ID = 0; 1194de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga NainarINITIALIZE_PASS_BEGIN(SampleProfileLoaderLegacyPass, "sample-profile", 1195de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar "Sample Profile loader", false, false) 1196de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga NainarINITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 1197de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga NainarINITIALIZE_PASS_END(SampleProfileLoaderLegacyPass, "sample-profile", 1198de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar "Sample Profile loader", false, false) 1199f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1200f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::doInitialization(Module &M) { 1201f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar auto &Ctx = M.getContext(); 1202f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar auto ReaderOrErr = SampleProfileReader::create(Filename, Ctx); 1203f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (std::error_code EC = ReaderOrErr.getError()) { 1204f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar std::string Msg = "Could not open profile: " + EC.message(); 1205f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Ctx.diagnose(DiagnosticInfoSampleProfile(Filename, Msg)); 1206f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; 1207f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1208f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Reader = std::move(ReaderOrErr.get()); 1209f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar ProfileIsValid = (Reader->read() == sampleprof_error::success); 1210f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return true; 1211f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1212f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1213f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarModulePass *llvm::createSampleProfileLoaderPass() { 1214de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return new SampleProfileLoaderLegacyPass(SampleProfileFile); 1215f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1216f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1217f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga NainarModulePass *llvm::createSampleProfileLoaderPass(StringRef Name) { 1218de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return new SampleProfileLoaderLegacyPass(Name); 1219f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1220f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1221f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::runOnModule(Module &M) { 1222f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!ProfileIsValid) 1223f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; 1224f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1225f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar // Compute the total number of samples collected in this profile. 1226f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (const auto &I : Reader->getProfiles()) 1227f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar TotalCollectedSamples += I.second.getTotalSamples(); 1228f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1229f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar bool retval = false; 1230f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (auto &F : M) 1231f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!F.isDeclaration()) { 1232f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar clearFunctionData(); 1233f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar retval |= runOnFunction(F); 1234f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 1235de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar M.setProfileSummary(Reader->getSummary().getMD(M.getContext())); 1236f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return retval; 1237f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1238f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 1239de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarbool SampleProfileLoaderLegacyPass::runOnModule(Module &M) { 1240de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // FIXME: pass in AssumptionCache correctly for the new pass manager. 1241de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SampleLoader.setACT(&getAnalysis<AssumptionCacheTracker>()); 1242de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return SampleLoader.runOnModule(M); 1243de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar} 1244de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1245f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainarbool SampleProfileLoader::runOnFunction(Function &F) { 1246de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar F.setEntryCount(0); 1247f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Samples = Reader->getSamplesFor(F); 1248f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (!Samples->empty()) 1249f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return emitAnnotations(F); 1250f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return false; 1251f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar} 1252de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1253de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga NainarPreservedAnalyses SampleProfileLoaderPass::run(Module &M, 1254de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisManager<Module> &AM) { 1255de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1256de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SampleProfileLoader SampleLoader(SampleProfileFile); 1257de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1258de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar SampleLoader.doInitialization(M); 1259de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1260de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (!SampleLoader.runOnModule(M)) 1261de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return PreservedAnalyses::all(); 1262de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 1263de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return PreservedAnalyses::none(); 1264de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar} 1265