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 U) :
41 AllBlocks(A), BranchInfo(B), BranchCount(C), FuncCoverage(F), UncondBranch(U)
51 /// GCOVBuffer - A wrapper around MemoryBuffer to provide GCOV specific
55 GCOVBuffer(MemoryBuffer *B) : Buffer(B), Cursor(0) {}
57 /// readGCNOFormat - Check GCNO signature is valid at the beginning of buffer.
58 bool readGCNOFormat() {
59 StringRef File = Buffer->getBuffer().slice(0, 4);
61 errs() << "Unexpected file type: " << File << ".\n";
68 /// readGCDAFormat - Check GCDA signature is valid at the beginning of buffer.
69 bool readGCDAFormat() {
70 StringRef File = Buffer->getBuffer().slice(0, 4);
72 errs() << "Unexpected file type: " << File << ".\n";
79 /// readGCOVVersion - Read GCOV version.
80 bool readGCOVVersion(GCOV::GCOVVersion &Version) {
81 StringRef VersionStr = Buffer->getBuffer().slice(Cursor, Cursor+4);
82 if (VersionStr == "*204") {
87 if (VersionStr == "*404") {
92 errs() << "Unexpected version: " << VersionStr << ".\n";
96 /// readFunctionTag - If cursor points to a function tag then increment the
97 /// cursor and return true otherwise return false.
98 bool readFunctionTag() {
99 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
101 Tag[0] != '\0' || Tag[1] != '\0' ||
102 Tag[2] != '\0' || Tag[3] != '\1') {
109 /// readBlockTag - If cursor points to a block tag then increment the
110 /// cursor and return true otherwise return false.
111 bool readBlockTag() {
112 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
114 Tag[0] != '\0' || Tag[1] != '\0' ||
115 Tag[2] != '\x41' || Tag[3] != '\x01') {
122 /// readEdgeTag - If cursor points to an edge tag then increment the
123 /// cursor and return true otherwise return false.
125 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
127 Tag[0] != '\0' || Tag[1] != '\0' ||
128 Tag[2] != '\x43' || Tag[3] != '\x01') {
135 /// readLineTag - If cursor points to a line tag then increment the
136 /// cursor and return true otherwise return false.
138 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
140 Tag[0] != '\0' || Tag[1] != '\0' ||
141 Tag[2] != '\x45' || Tag[3] != '\x01') {
148 /// readArcTag - If cursor points to an gcda arc tag then increment the
149 /// cursor and return true otherwise return false.
151 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
153 Tag[0] != '\0' || Tag[1] != '\0' ||
154 Tag[2] != '\xa1' || Tag[3] != '\1') {
161 /// readObjectTag - If cursor points to an object summary tag then increment
162 /// the cursor and return true otherwise return false.
163 bool readObjectTag() {
164 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
166 Tag[0] != '\0' || Tag[1] != '\0' ||
167 Tag[2] != '\0' || Tag[3] != '\xa1') {
174 /// readProgramTag - If cursor points to a program summary tag then increment
175 /// the cursor and return true otherwise return false.
176 bool readProgramTag() {
177 StringRef Tag = Buffer->getBuffer().slice(Cursor, Cursor+4);
179 Tag[0] != '\0' || Tag[1] != '\0' ||
180 Tag[2] != '\0' || Tag[3] != '\xa3') {
187 bool readInt(uint32_t &Val) {
188 if (Buffer->getBuffer().size() < Cursor+4) {
189 errs() << "Unexpected end of memory buffer: " << Cursor+4 << ".\n";
192 StringRef Str = Buffer->getBuffer().slice(Cursor, Cursor+4);
194 Val = *(const uint32_t *)(Str.data());
198 bool readInt64(uint64_t &Val) {
200 if (!readInt(Lo) || !readInt(Hi)) return false;
201 Val = ((uint64_t)Hi << 32) | Lo;
205 bool readString(StringRef &Str) {
207 if (!readInt(Len)) return false;
209 if (Buffer->getBuffer().size() < Cursor+Len) {
210 errs() << "Unexpected end of memory buffer: " << Cursor+Len << ".\n";
213 Str = Buffer->getBuffer().slice(Cursor, Cursor+Len).split('\0').first;
218 uint64_t getCursor() const { return Cursor; }
219 void advanceCursor(uint32_t n) { Cursor += n*4; }
221 MemoryBuffer *Buffer;
225 /// GCOVFile - Collects coverage information for one pair of coverage file
226 /// (.gcno and .gcda).
229 GCOVFile() : GCNOInitialized(false), Checksum(0), Functions(), RunCount(0),
232 bool readGCNO(GCOVBuffer &Buffer);
233 bool readGCDA(GCOVBuffer &Buffer);
234 uint32_t getChecksum() const { return Checksum; }
236 void collectLineCounts(FileInfo &FI);
238 bool GCNOInitialized;
239 GCOV::GCOVVersion Version;
241 SmallVector<GCOVFunction *, 16> Functions;
243 uint32_t ProgramCount;
246 /// GCOVEdge - Collects edge information.
248 GCOVEdge(GCOVBlock *S, GCOVBlock *D): Src(S), Dst(D), Count(0) {}
255 /// GCOVFunction - Collects function information.
258 typedef SmallVectorImpl<GCOVBlock *>::const_iterator BlockIterator;
260 GCOVFunction(GCOVFile &P) : Parent(P), Ident(0), LineNumber(0) {}
262 bool readGCNO(GCOVBuffer &Buffer, GCOV::GCOVVersion Version);
263 bool readGCDA(GCOVBuffer &Buffer, GCOV::GCOVVersion Version);
264 StringRef getName() const { return Name; }
265 StringRef getFilename() const { return Filename; }
266 size_t getNumBlocks() const { return Blocks.size(); }
267 uint64_t getEntryCount() const;
268 uint64_t getExitCount() const;
270 BlockIterator block_begin() const { return Blocks.begin(); }
271 BlockIterator block_end() const { return Blocks.end(); }
274 void collectLineCounts(FileInfo &FI);
282 SmallVector<GCOVBlock *, 16> Blocks;
283 SmallVector<GCOVEdge *, 16> Edges;
286 /// GCOVBlock - Collects block information.
289 EdgeWeight(GCOVBlock *D): Dst(D), Count(0) {}
295 struct SortDstEdgesFunctor {
296 bool operator()(const GCOVEdge *E1, const GCOVEdge *E2) {
297 return E1->Dst->Number < E2->Dst->Number;
301 typedef SmallVectorImpl<GCOVEdge *>::const_iterator EdgeIterator;
303 GCOVBlock(GCOVFunction &P, uint32_t N) : Parent(P), Number(N), Counter(0),
304 DstEdgesAreSorted(true), SrcEdges(), DstEdges(), Lines() {}
306 const GCOVFunction &getParent() const { return Parent; }
307 void addLine(uint32_t N) { Lines.push_back(N); }
308 uint32_t getLastLine() const { return Lines.back(); }
309 void addCount(size_t DstEdgeNo, uint64_t N);
310 uint64_t getCount() const { return Counter; }
312 void addSrcEdge(GCOVEdge *Edge) {
313 assert(Edge->Dst == this); // up to caller to ensure edge is valid
314 SrcEdges.push_back(Edge);
316 void addDstEdge(GCOVEdge *Edge) {
317 assert(Edge->Src == this); // up to caller to ensure edge is valid
318 // Check if adding this edge causes list to become unsorted.
319 if (DstEdges.size() && DstEdges.back()->Dst->Number > Edge->Dst->Number)
320 DstEdgesAreSorted = false;
321 DstEdges.push_back(Edge);
323 size_t getNumSrcEdges() const { return SrcEdges.size(); }
324 size_t getNumDstEdges() const { return DstEdges.size(); }
327 EdgeIterator src_begin() const { return SrcEdges.begin(); }
328 EdgeIterator src_end() const { return SrcEdges.end(); }
329 EdgeIterator dst_begin() const { return DstEdges.begin(); }
330 EdgeIterator dst_end() const { return DstEdges.end(); }
333 void collectLineCounts(FileInfo &FI);
335 GCOVFunction &Parent;
338 bool DstEdgesAreSorted;
339 SmallVector<GCOVEdge *, 16> SrcEdges;
340 SmallVector<GCOVEdge *, 16> DstEdges;
341 SmallVector<uint32_t, 16> Lines;
345 // It is unlikely--but possible--for multiple functions to be on the same line.
346 // Therefore this typedef allows LineData.Functions to store multiple functions
347 // per instance. This is rare, however, so optimize for the common case.
348 typedef SmallVector<const GCOVFunction *, 1> FunctionVector;
349 typedef DenseMap<uint32_t, FunctionVector> FunctionLines;
350 typedef SmallVector<const GCOVBlock *, 4> BlockVector;
351 typedef DenseMap<uint32_t, BlockVector> BlockLines;
355 FunctionLines Functions;
358 struct GCOVCoverage {
359 GCOVCoverage(StringRef Name) :
360 Name(Name), LogicalLines(0), LinesExec(0), Branches(0), BranchesExec(0),
365 uint32_t LogicalLines;
369 uint32_t BranchesExec;
370 uint32_t BranchesTaken;
373 FileInfo(const GCOVOptions &Options) :
374 Options(Options), LineInfo(), RunCount(0), ProgramCount(0) {}
376 void addBlockLine(StringRef Filename, uint32_t Line, const GCOVBlock *Block) {
377 LineInfo[Filename].Blocks[Line-1].push_back(Block);
379 void addFunctionLine(StringRef Filename, uint32_t Line,
380 const GCOVFunction *Function) {
381 LineInfo[Filename].Functions[Line-1].push_back(Function);
383 void setRunCount(uint32_t Runs) { RunCount = Runs; }
384 void setProgramCount(uint32_t Programs) { ProgramCount = Programs; }
385 void print(StringRef GCNOFile, StringRef GCDAFile);
387 void printFunctionSummary(raw_fd_ostream &OS,
388 const FunctionVector &Funcs) const;
389 void printBlockInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
390 uint32_t LineIndex, uint32_t &BlockNo) const;
391 void printBranchInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
392 GCOVCoverage &Coverage, uint32_t &EdgeNo);
393 void printUncondBranchInfo(raw_fd_ostream &OS, uint32_t &EdgeNo,
394 uint64_t Count) const;
396 void printCoverage(const GCOVCoverage &Coverage) const;
397 void printFuncCoverage() const;
398 void printFileCoverage() const;
400 const GCOVOptions &Options;
401 StringMap<LineData> LineInfo;
403 uint32_t ProgramCount;
404 SmallVector<GCOVCoverage, 4> FileCoverages;
405 MapVector<const GCOVFunction *, GCOVCoverage> FuncCoverages;