1 //===- GCOV.h - LLVM coverage tool ----------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header provides the interface to read and write coverage files that
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SUPPORT_GCOV_H
16 #define LLVM_SUPPORT_GCOV_H
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/MapVector.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/raw_ostream.h"
36 } // end GCOV namespace
38 /// GCOVOptions - A struct for passing gcov options between functions.
40 GCOVOptions(bool A, bool B, bool C, bool F, bool P, bool U)
41 : AllBlocks(A), BranchInfo(B), BranchCount(C), FuncCoverage(F),
42 PreservePaths(P), UncondBranch(U) {}
52 /// GCOVBuffer - A wrapper around MemoryBuffer to provide GCOV specific
56 GCOVBuffer(MemoryBuffer *B) : Buffer(B), Cursor(0) {}
58 /// readGCNOFormat - Check GCNO signature is valid at the beginning of buffer.
59 bool readGCNOFormat() {
60 StringRef File = Buffer->getBuffer().slice(0, 4);
62 errs() << "Unexpected file type: " << File << ".\n";
69 /// readGCDAFormat - Check GCDA signature is valid at the beginning of buffer.
70 bool readGCDAFormat() {
71 StringRef File = Buffer->getBuffer().slice(0, 4);
73 errs() << "Unexpected file type: " << File << ".\n";
80 /// readGCOVVersion - Read GCOV version.
81 bool readGCOVVersion(GCOV::GCOVVersion &Version) {
82 StringRef VersionStr = Buffer->getBuffer().slice(Cursor, Cursor+4);
83 if (VersionStr == "*204") {
88 if (VersionStr == "*404") {
93 errs() << "Unexpected version: " << VersionStr << ".\n";
97 /// readFunctionTag - If cursor points to a function tag then increment the
98 /// cursor and return true otherwise return false.
99 bool readFunctionTag() {
100 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
102 Tag[0] != '\0' || Tag[1] != '\0' ||
103 Tag[2] != '\0' || Tag[3] != '\1') {
110 /// readBlockTag - If cursor points to a block tag then increment the
111 /// cursor and return true otherwise return false.
112 bool readBlockTag() {
113 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
115 Tag[0] != '\0' || Tag[1] != '\0' ||
116 Tag[2] != '\x41' || Tag[3] != '\x01') {
123 /// readEdgeTag - If cursor points to an edge tag then increment the
124 /// cursor and return true otherwise return false.
126 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
128 Tag[0] != '\0' || Tag[1] != '\0' ||
129 Tag[2] != '\x43' || Tag[3] != '\x01') {
136 /// readLineTag - If cursor points to a line tag then increment the
137 /// cursor and return true otherwise return false.
139 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
141 Tag[0] != '\0' || Tag[1] != '\0' ||
142 Tag[2] != '\x45' || Tag[3] != '\x01') {
149 /// readArcTag - If cursor points to an gcda arc tag then increment the
150 /// cursor and return true otherwise return false.
152 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
154 Tag[0] != '\0' || Tag[1] != '\0' ||
155 Tag[2] != '\xa1' || Tag[3] != '\1') {
162 /// readObjectTag - If cursor points to an object summary tag then increment
163 /// the cursor and return true otherwise return false.
164 bool readObjectTag() {
165 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
167 Tag[0] != '\0' || Tag[1] != '\0' ||
168 Tag[2] != '\0' || Tag[3] != '\xa1') {
175 /// readProgramTag - If cursor points to a program summary tag then increment
176 /// the cursor and return true otherwise return false.
177 bool readProgramTag() {
178 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
180 Tag[0] != '\0' || Tag[1] != '\0' ||
181 Tag[2] != '\0' || Tag[3] != '\xa3') {
188 bool readInt(uint32_t &Val) {
189 if (Buffer->getBuffer().size() < Cursor+4) {
190 errs() << "Unexpected end of memory buffer: " << Cursor+4 << ".\n";
193 StringRef Str = Buffer->getBuffer().slice(Cursor, Cursor+4);
195 Val = *(const uint32_t *)(Str.data());
199 bool readInt64(uint64_t &Val) {
201 if (!readInt(Lo) || !readInt(Hi)) return false;
202 Val = ((uint64_t)Hi << 32) | Lo;
206 bool readString(StringRef &Str) {
208 // Keep reading until we find a non-zero length. This emulates gcov's
209 // behaviour, which appears to do the same.
211 if (!readInt(Len)) return false;
213 if (Buffer->getBuffer().size() < Cursor+Len) {
214 errs() << "Unexpected end of memory buffer: " << Cursor+Len << ".\n";
217 Str = Buffer->getBuffer().slice(Cursor, Cursor+Len).split('\0').first;
222 uint64_t getCursor() const { return Cursor; }
223 void advanceCursor(uint32_t n) { Cursor += n*4; }
225 MemoryBuffer *Buffer;
229 /// GCOVFile - Collects coverage information for one pair of coverage file
230 /// (.gcno and .gcda).
233 GCOVFile() : GCNOInitialized(false), Checksum(0), Functions(), RunCount(0),
235 bool readGCNO(GCOVBuffer &Buffer);
236 bool readGCDA(GCOVBuffer &Buffer);
237 uint32_t getChecksum() const { return Checksum; }
239 void collectLineCounts(FileInfo &FI);
241 bool GCNOInitialized;
242 GCOV::GCOVVersion Version;
244 SmallVector<std::unique_ptr<GCOVFunction>, 16> Functions;
246 uint32_t ProgramCount;
249 /// GCOVEdge - Collects edge information.
251 GCOVEdge(GCOVBlock &S, GCOVBlock &D) : Src(S), Dst(D), Count(0) {}
258 /// GCOVFunction - Collects function information.
261 typedef SmallVectorImpl<std::unique_ptr<GCOVBlock>>::const_iterator
264 GCOVFunction(GCOVFile &P) : Parent(P), Ident(0), LineNumber(0) {}
265 bool readGCNO(GCOVBuffer &Buffer, GCOV::GCOVVersion Version);
266 bool readGCDA(GCOVBuffer &Buffer, GCOV::GCOVVersion Version);
267 StringRef getName() const { return Name; }
268 StringRef getFilename() const { return Filename; }
269 size_t getNumBlocks() const { return Blocks.size(); }
270 uint64_t getEntryCount() const;
271 uint64_t getExitCount() const;
273 BlockIterator block_begin() const { return Blocks.begin(); }
274 BlockIterator block_end() const { return Blocks.end(); }
277 void collectLineCounts(FileInfo &FI);
285 SmallVector<std::unique_ptr<GCOVBlock>, 16> Blocks;
286 SmallVector<std::unique_ptr<GCOVEdge>, 16> Edges;
289 /// GCOVBlock - Collects block information.
292 EdgeWeight(GCOVBlock *D): Dst(D), Count(0) {}
298 struct SortDstEdgesFunctor {
299 bool operator()(const GCOVEdge *E1, const GCOVEdge *E2) {
300 return E1->Dst.Number < E2->Dst.Number;
304 typedef SmallVectorImpl<GCOVEdge *>::const_iterator EdgeIterator;
306 GCOVBlock(GCOVFunction &P, uint32_t N) : Parent(P), Number(N), Counter(0),
307 DstEdgesAreSorted(true), SrcEdges(), DstEdges(), Lines() {}
309 const GCOVFunction &getParent() const { return Parent; }
310 void addLine(uint32_t N) { Lines.push_back(N); }
311 uint32_t getLastLine() const { return Lines.back(); }
312 void addCount(size_t DstEdgeNo, uint64_t N);
313 uint64_t getCount() const { return Counter; }
315 void addSrcEdge(GCOVEdge *Edge) {
316 assert(&Edge->Dst == this); // up to caller to ensure edge is valid
317 SrcEdges.push_back(Edge);
319 void addDstEdge(GCOVEdge *Edge) {
320 assert(&Edge->Src == this); // up to caller to ensure edge is valid
321 // Check if adding this edge causes list to become unsorted.
322 if (DstEdges.size() && DstEdges.back()->Dst.Number > Edge->Dst.Number)
323 DstEdgesAreSorted = false;
324 DstEdges.push_back(Edge);
326 size_t getNumSrcEdges() const { return SrcEdges.size(); }
327 size_t getNumDstEdges() const { return DstEdges.size(); }
330 EdgeIterator src_begin() const { return SrcEdges.begin(); }
331 EdgeIterator src_end() const { return SrcEdges.end(); }
332 EdgeIterator dst_begin() const { return DstEdges.begin(); }
333 EdgeIterator dst_end() const { return DstEdges.end(); }
336 void collectLineCounts(FileInfo &FI);
338 GCOVFunction &Parent;
341 bool DstEdgesAreSorted;
342 SmallVector<GCOVEdge *, 16> SrcEdges;
343 SmallVector<GCOVEdge *, 16> DstEdges;
344 SmallVector<uint32_t, 16> Lines;
348 // It is unlikely--but possible--for multiple functions to be on the same line.
349 // Therefore this typedef allows LineData.Functions to store multiple functions
350 // per instance. This is rare, however, so optimize for the common case.
351 typedef SmallVector<const GCOVFunction *, 1> FunctionVector;
352 typedef DenseMap<uint32_t, FunctionVector> FunctionLines;
353 typedef SmallVector<const GCOVBlock *, 4> BlockVector;
354 typedef DenseMap<uint32_t, BlockVector> BlockLines;
358 FunctionLines Functions;
361 struct GCOVCoverage {
362 GCOVCoverage(StringRef Name) :
363 Name(Name), LogicalLines(0), LinesExec(0), Branches(0), BranchesExec(0),
368 uint32_t LogicalLines;
372 uint32_t BranchesExec;
373 uint32_t BranchesTaken;
376 FileInfo(const GCOVOptions &Options) :
377 Options(Options), LineInfo(), RunCount(0), ProgramCount(0) {}
379 void addBlockLine(StringRef Filename, uint32_t Line, const GCOVBlock *Block) {
380 LineInfo[Filename].Blocks[Line-1].push_back(Block);
382 void addFunctionLine(StringRef Filename, uint32_t Line,
383 const GCOVFunction *Function) {
384 LineInfo[Filename].Functions[Line-1].push_back(Function);
386 void setRunCount(uint32_t Runs) { RunCount = Runs; }
387 void setProgramCount(uint32_t Programs) { ProgramCount = Programs; }
388 void print(StringRef GCNOFile, StringRef GCDAFile);
390 void printFunctionSummary(raw_fd_ostream &OS,
391 const FunctionVector &Funcs) const;
392 void printBlockInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
393 uint32_t LineIndex, uint32_t &BlockNo) const;
394 void printBranchInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
395 GCOVCoverage &Coverage, uint32_t &EdgeNo);
396 void printUncondBranchInfo(raw_fd_ostream &OS, uint32_t &EdgeNo,
397 uint64_t Count) const;
399 void printCoverage(const GCOVCoverage &Coverage) const;
400 void printFuncCoverage() const;
401 void printFileCoverage() const;
403 const GCOVOptions &Options;
404 StringMap<LineData> LineInfo;
406 uint32_t ProgramCount;
408 typedef SmallVector<std::pair<std::string, GCOVCoverage>, 4>
410 typedef MapVector<const GCOVFunction *, GCOVCoverage> FuncCoverageMap;
412 FileCoverageList FileCoverages;
413 FuncCoverageMap FuncCoverages;