1 //===- ProfileInfoLoad.cpp - Load profile information from disk -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // The ProfileInfoLoader class is used to load and represent profiling
11 // information read in from the dump file.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Analysis/ProfileInfoLoader.h"
16 #include "llvm/Analysis/ProfileInfoTypes.h"
17 #include "llvm/Module.h"
18 #include "llvm/InstrTypes.h"
19 #include "llvm/Support/Streams.h"
24 // ByteSwap - Byteswap 'Var' if 'Really' is true.
26 static inline unsigned ByteSwap(unsigned Var, bool Really) {
27 if (!Really) return Var;
28 return ((Var & (255<< 0)) << 24) |
29 ((Var & (255<< 8)) << 8) |
30 ((Var & (255<<16)) >> 8) |
31 ((Var & (255<<24)) >> 24);
34 static void ReadProfilingBlock(const char *ToolName, FILE *F,
36 std::vector<unsigned> &Data) {
37 // Read the number of entries...
39 if (fread(&NumEntries, sizeof(unsigned), 1, F) != 1) {
40 cerr << ToolName << ": data packet truncated!\n";
44 NumEntries = ByteSwap(NumEntries, ShouldByteSwap);
47 std::vector<unsigned> TempSpace(NumEntries);
49 // Read in the block of data...
50 if (fread(&TempSpace[0], sizeof(unsigned)*NumEntries, 1, F) != 1) {
51 cerr << ToolName << ": data packet truncated!\n";
56 // Make sure we have enough space...
57 if (Data.size() < NumEntries)
58 Data.resize(NumEntries);
60 // Accumulate the data we just read into the data.
61 if (!ShouldByteSwap) {
62 for (unsigned i = 0; i != NumEntries; ++i)
63 Data[i] += TempSpace[i];
65 for (unsigned i = 0; i != NumEntries; ++i)
66 Data[i] += ByteSwap(TempSpace[i], true);
70 // ProfileInfoLoader ctor - Read the specified profiling data file, exiting the
71 // program if the file is invalid or broken.
73 ProfileInfoLoader::ProfileInfoLoader(const char *ToolName,
74 const std::string &Filename,
75 Module &TheModule) : M(TheModule) {
76 FILE *F = fopen(Filename.c_str(), "r");
78 cerr << ToolName << ": Error opening '" << Filename << "': ";
83 // Keep reading packets until we run out of them.
85 while (fread(&PacketType, sizeof(unsigned), 1, F) == 1) {
86 // If the low eight bits of the packet are zero, we must be dealing with an
87 // endianness mismatch. Byteswap all words read from the profiling
89 bool ShouldByteSwap = (char)PacketType == 0;
90 PacketType = ByteSwap(PacketType, ShouldByteSwap);
95 if (fread(&ArgLength, sizeof(unsigned), 1, F) != 1) {
96 cerr << ToolName << ": arguments packet truncated!\n";
100 ArgLength = ByteSwap(ArgLength, ShouldByteSwap);
102 // Read in the arguments...
103 std::vector<char> Chars(ArgLength+4);
106 if (fread(&Chars[0], (ArgLength+3) & ~3, 1, F) != 1) {
107 cerr << ToolName << ": arguments packet truncated!\n";
111 CommandLines.push_back(std::string(&Chars[0], &Chars[ArgLength]));
116 ReadProfilingBlock(ToolName, F, ShouldByteSwap, FunctionCounts);
120 ReadProfilingBlock(ToolName, F, ShouldByteSwap, BlockCounts);
124 ReadProfilingBlock(ToolName, F, ShouldByteSwap, EdgeCounts);
128 ReadProfilingBlock(ToolName, F, ShouldByteSwap, BBTrace);
132 cerr << ToolName << ": Unknown packet type #" << PacketType << "!\n";
141 // getFunctionCounts - This method is used by consumers of function counting
142 // information. If we do not directly have function count information, we
143 // compute it from other, more refined, types of profile information.
145 void ProfileInfoLoader::getFunctionCounts(std::vector<std::pair<Function*,
146 unsigned> > &Counts) {
147 if (FunctionCounts.empty()) {
148 if (hasAccurateBlockCounts()) {
149 // Synthesize function frequency information from the number of times
150 // their entry blocks were executed.
151 std::vector<std::pair<BasicBlock*, unsigned> > BlockCounts;
152 getBlockCounts(BlockCounts);
154 for (unsigned i = 0, e = BlockCounts.size(); i != e; ++i)
155 if (&BlockCounts[i].first->getParent()->front() == BlockCounts[i].first)
156 Counts.push_back(std::make_pair(BlockCounts[i].first->getParent(),
157 BlockCounts[i].second));
159 cerr << "Function counts are not available!\n";
164 unsigned Counter = 0;
165 for (Module::iterator I = M.begin(), E = M.end();
166 I != E && Counter != FunctionCounts.size(); ++I)
167 if (!I->isDeclaration())
168 Counts.push_back(std::make_pair(I, FunctionCounts[Counter++]));
171 // getBlockCounts - This method is used by consumers of block counting
172 // information. If we do not directly have block count information, we
173 // compute it from other, more refined, types of profile information.
175 void ProfileInfoLoader::getBlockCounts(std::vector<std::pair<BasicBlock*,
176 unsigned> > &Counts) {
177 if (BlockCounts.empty()) {
178 if (hasAccurateEdgeCounts()) {
179 // Synthesize block count information from edge frequency information.
180 // The block execution frequency is equal to the sum of the execution
181 // frequency of all outgoing edges from a block.
183 // If a block has no successors, this will not be correct, so we have to
184 // special case it. :(
185 std::vector<std::pair<Edge, unsigned> > EdgeCounts;
186 getEdgeCounts(EdgeCounts);
188 std::map<BasicBlock*, unsigned> InEdgeFreqs;
190 BasicBlock *LastBlock = 0;
191 TerminatorInst *TI = 0;
192 for (unsigned i = 0, e = EdgeCounts.size(); i != e; ++i) {
193 if (EdgeCounts[i].first.first != LastBlock) {
194 LastBlock = EdgeCounts[i].first.first;
195 TI = LastBlock->getTerminator();
196 Counts.push_back(std::make_pair(LastBlock, 0));
198 Counts.back().second += EdgeCounts[i].second;
199 unsigned SuccNum = EdgeCounts[i].first.second;
200 if (SuccNum >= TI->getNumSuccessors()) {
201 static bool Warned = false;
203 cerr << "WARNING: profile info doesn't seem to match"
204 << " the program!\n";
208 // If this successor has no successors of its own, we will never
209 // compute an execution count for that block. Remember the incoming
210 // edge frequencies to add later.
211 BasicBlock *Succ = TI->getSuccessor(SuccNum);
212 if (Succ->getTerminator()->getNumSuccessors() == 0)
213 InEdgeFreqs[Succ] += EdgeCounts[i].second;
217 // Now we have to accumulate information for those blocks without
218 // successors into our table.
219 for (std::map<BasicBlock*, unsigned>::iterator I = InEdgeFreqs.begin(),
220 E = InEdgeFreqs.end(); I != E; ++I) {
222 for (; i != Counts.size() && Counts[i].first != I->first; ++i)
224 if (i == Counts.size()) Counts.push_back(std::make_pair(I->first, 0));
225 Counts[i].second += I->second;
229 cerr << "Block counts are not available!\n";
234 unsigned Counter = 0;
235 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
236 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
237 Counts.push_back(std::make_pair(BB, BlockCounts[Counter++]));
238 if (Counter == BlockCounts.size())
243 // getEdgeCounts - This method is used by consumers of edge counting
244 // information. If we do not directly have edge count information, we compute
245 // it from other, more refined, types of profile information.
247 void ProfileInfoLoader::getEdgeCounts(std::vector<std::pair<Edge,
248 unsigned> > &Counts) {
249 if (EdgeCounts.empty()) {
250 cerr << "Edge counts not available, and no synthesis "
251 << "is implemented yet!\n";
255 unsigned Counter = 0;
256 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
257 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
258 for (unsigned i = 0, e = BB->getTerminator()->getNumSuccessors();
260 Counts.push_back(std::make_pair(Edge(BB, i), EdgeCounts[Counter++]));
261 if (Counter == EdgeCounts.size())
266 // getBBTrace - This method is used by consumers of basic-block trace
269 void ProfileInfoLoader::getBBTrace(std::vector<BasicBlock *> &Trace) {
270 if (BBTrace.empty ()) {
271 cerr << "Basic block trace is not available!\n";
274 cerr << "Basic block trace loading is not implemented yet!\n";