1 //===- GCOVr.cpp - 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 // GCOV implements the interface to read and write coverage files that use
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Support/Debug.h"
16 #include "llvm/Support/GCOV.h"
17 #include "llvm/ADT/OwningPtr.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/Support/MemoryObject.h"
21 #include "llvm/Support/system_error.h"
24 //===----------------------------------------------------------------------===//
25 // GCOVFile implementation.
27 /// ~GCOVFile - Delete GCOVFile and its content.
28 GCOVFile::~GCOVFile() {
29 DeleteContainerPointers(Functions);
32 /// isGCDAFile - Return true if Format identifies a .gcda file.
33 static bool isGCDAFile(GCOV::GCOVFormat Format) {
34 return Format == GCOV::GCDA_402 || Format == GCOV::GCDA_404;
37 /// isGCNOFile - Return true if Format identifies a .gcno file.
38 static bool isGCNOFile(GCOV::GCOVFormat Format) {
39 return Format == GCOV::GCNO_402 || Format == GCOV::GCNO_404;
42 /// read - Read GCOV buffer.
43 bool GCOVFile::read(GCOVBuffer &Buffer) {
44 GCOV::GCOVFormat Format = Buffer.readGCOVFormat();
45 if (Format == GCOV::InvalidGCOV)
48 if (isGCNOFile(Format)) {
50 if (!Buffer.readFunctionTag()) break;
51 GCOVFunction *GFun = new GCOVFunction();
52 if (!GFun->read(Buffer, Format))
54 Functions.push_back(GFun);
57 else if (isGCDAFile(Format)) {
58 for (size_t i = 0, e = Functions.size(); i < e; ++i) {
59 if (!Buffer.readFunctionTag()) {
60 errs() << "Unexpected number of functions.\n";
63 if (!Functions[i]->read(Buffer, Format))
66 if (Buffer.readObjectTag()) {
69 if (!Buffer.readInt(Length)) return false;
70 if (!Buffer.readInt(Dummy)) return false; // checksum
71 if (!Buffer.readInt(Dummy)) return false; // num
72 if (!Buffer.readInt(RunCount)) return false;;
73 Buffer.advanceCursor(Length-3);
75 while (Buffer.readProgramTag()) {
77 if (!Buffer.readInt(Length)) return false;
78 Buffer.advanceCursor(Length);
86 /// dump - Dump GCOVFile content to dbgs() for debugging purposes.
87 void GCOVFile::dump() {
88 for (SmallVectorImpl<GCOVFunction *>::iterator I = Functions.begin(),
89 E = Functions.end(); I != E; ++I)
93 /// collectLineCounts - Collect line counts. This must be used after
94 /// reading .gcno and .gcda files.
95 void GCOVFile::collectLineCounts(FileInfo &FI) {
96 for (SmallVectorImpl<GCOVFunction *>::iterator I = Functions.begin(),
97 E = Functions.end(); I != E; ++I)
98 (*I)->collectLineCounts(FI);
99 FI.setRunCount(RunCount);
100 FI.setProgramCount(ProgramCount);
103 //===----------------------------------------------------------------------===//
104 // GCOVFunction implementation.
106 /// ~GCOVFunction - Delete GCOVFunction and its content.
107 GCOVFunction::~GCOVFunction() {
108 DeleteContainerPointers(Blocks);
111 /// read - Read a function from the buffer. Return false if buffer cursor
112 /// does not point to a function tag.
113 bool GCOVFunction::read(GCOVBuffer &Buff, GCOV::GCOVFormat Format) {
115 if (!Buff.readInt(Dummy)) return false; // Function header length
116 if (!Buff.readInt(Ident)) return false;
117 if (!Buff.readInt(Dummy)) return false; // Checksum #1
118 if (Format != GCOV::GCNO_402 && Format != GCOV::GCDA_402)
119 if (!Buff.readInt(Dummy)) return false; // Checksum #2
121 if (!Buff.readString(Name)) return false;
123 if (Format == GCOV::GCNO_402 || Format == GCOV::GCNO_404)
124 if (!Buff.readString(Filename)) return false;
126 if (Format == GCOV::GCDA_402 || Format == GCOV::GCDA_404) {
127 if (!Buff.readArcTag()) {
128 errs() << "Arc tag not found.\n";
132 if (!Buff.readInt(Count)) return false;
135 // This for loop adds the counts for each block. A second nested loop is
136 // required to combine the edge counts that are contained in the GCDA file.
137 for (uint32_t Line = 0; Count > 0; ++Line) {
138 if (Line >= Blocks.size()) {
139 errs() << "Unexpected number of edges.\n";
142 GCOVBlock &Block = *Blocks[Line];
143 for (size_t Edge = 0, End = Block.getNumEdges(); Edge < End; ++Edge) {
145 errs() << "Unexpected number of edges.\n";
149 if (!Buff.readInt64(ArcCount)) return false;
150 Block.addCount(ArcCount);
157 if (!Buff.readInt(LineNumber)) return false;
160 if (!Buff.readBlockTag()) {
161 errs() << "Block tag not found.\n";
165 if (!Buff.readInt(BlockCount)) return false;
166 for (uint32_t i = 0, e = BlockCount; i != e; ++i) {
167 if (!Buff.readInt(Dummy)) return false; // Block flags;
168 Blocks.push_back(new GCOVBlock(*this, i));
172 while (Buff.readEdgeTag()) {
174 if (!Buff.readInt(EdgeCount)) return false;
175 EdgeCount = (EdgeCount - 1) / 2;
177 if (!Buff.readInt(BlockNo)) return false;
178 if (BlockNo >= BlockCount) {
179 errs() << "Unexpected block number.\n";
182 for (uint32_t i = 0, e = EdgeCount; i != e; ++i) {
184 if (!Buff.readInt(Dst)) return false;
185 Blocks[BlockNo]->addEdge(Dst);
186 if (!Buff.readInt(Dummy)) return false; // Edge flag
191 while (Buff.readLineTag()) {
192 uint32_t LineTableLength;
193 if (!Buff.readInt(LineTableLength)) return false;
194 uint32_t EndPos = Buff.getCursor() + LineTableLength*4;
196 if (!Buff.readInt(BlockNo)) return false;
197 if (BlockNo >= BlockCount) {
198 errs() << "Unexpected block number.\n";
201 GCOVBlock *Block = Blocks[BlockNo];
202 if (!Buff.readInt(Dummy)) return false; // flag
203 while (Buff.getCursor() != (EndPos - 4)) {
205 if (!Buff.readString(F)) return false;
207 errs() << "Multiple sources for a single basic block.\n";
210 if (Buff.getCursor() == (EndPos - 4)) break;
213 if (!Buff.readInt(Line)) return false;
215 Block->addLine(Line);
218 if (!Buff.readInt(Dummy)) return false; // flag
223 /// dump - Dump GCOVFunction content to dbgs() for debugging purposes.
224 void GCOVFunction::dump() {
225 dbgs() << "===== " << Name << " @ " << Filename << ":" << LineNumber << "\n";
226 for (SmallVectorImpl<GCOVBlock *>::iterator I = Blocks.begin(),
227 E = Blocks.end(); I != E; ++I)
231 /// collectLineCounts - Collect line counts. This must be used after
232 /// reading .gcno and .gcda files.
233 void GCOVFunction::collectLineCounts(FileInfo &FI) {
234 for (SmallVectorImpl<GCOVBlock *>::iterator I = Blocks.begin(),
235 E = Blocks.end(); I != E; ++I)
236 (*I)->collectLineCounts(FI);
239 //===----------------------------------------------------------------------===//
240 // GCOVBlock implementation.
242 /// ~GCOVBlock - Delete GCOVBlock and its content.
243 GCOVBlock::~GCOVBlock() {
248 /// collectLineCounts - Collect line counts. This must be used after
249 /// reading .gcno and .gcda files.
250 void GCOVBlock::collectLineCounts(FileInfo &FI) {
251 for (SmallVectorImpl<uint32_t>::iterator I = Lines.begin(),
252 E = Lines.end(); I != E; ++I)
253 FI.addLineCount(Parent.getFilename(), *I, Counter);
256 /// dump - Dump GCOVBlock content to dbgs() for debugging purposes.
257 void GCOVBlock::dump() {
258 dbgs() << "Block : " << Number << " Counter : " << Counter << "\n";
259 if (!Edges.empty()) {
260 dbgs() << "\tEdges : ";
261 for (SmallVectorImpl<uint32_t>::iterator I = Edges.begin(), E = Edges.end();
263 dbgs() << (*I) << ",";
266 if (!Lines.empty()) {
267 dbgs() << "\tLines : ";
268 for (SmallVectorImpl<uint32_t>::iterator I = Lines.begin(),
269 E = Lines.end(); I != E; ++I)
270 dbgs() << (*I) << ",";
275 //===----------------------------------------------------------------------===//
276 // FileInfo implementation.
278 /// print - Print source files with collected line count information.
279 void FileInfo::print(raw_fd_ostream &OS, StringRef gcnoFile,
280 StringRef gcdaFile) {
281 for (StringMap<LineCounts>::iterator I = LineInfo.begin(), E = LineInfo.end();
283 StringRef Filename = I->first();
284 OS << " -: 0:Source:" << Filename << "\n";
285 OS << " -: 0:Graph:" << gcnoFile << "\n";
286 OS << " -: 0:Data:" << gcdaFile << "\n";
287 OS << " -: 0:Runs:" << RunCount << "\n";
288 OS << " -: 0:Programs:" << ProgramCount << "\n";
289 LineCounts &L = LineInfo[Filename];
290 OwningPtr<MemoryBuffer> Buff;
291 if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
292 errs() << Filename << ": " << ec.message() << "\n";
295 StringRef AllLines = Buff.take()->getBuffer();
297 while (!AllLines.empty()) {
298 if (L.find(i) != L.end()) {
302 OS << format("%9" PRIu64 ":", L[i]);
306 std::pair<StringRef, StringRef> P = AllLines.split('\n');
307 if (AllLines != P.first)
308 OS << format("%5u:", i+1) << P.first;