1//===---- CoverageMappingGen.h - Coverage mapping generation ----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Instrumentation-based code coverage mapping generator
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_LIB_CODEGEN_COVERAGEMAPPINGGEN_H
14#define LLVM_CLANG_LIB_CODEGEN_COVERAGEMAPPINGGEN_H
15
16#include "clang/Basic/LLVM.h"
17#include "clang/Basic/SourceLocation.h"
18#include "clang/Lex/PPCallbacks.h"
19#include "clang/Lex/Preprocessor.h"
20#include "llvm/ADT/DenseMap.h"
21#include "llvm/IR/GlobalValue.h"
22#include "llvm/Support/raw_ostream.h"
23
24namespace clang {
25
26class LangOptions;
27class SourceManager;
28class FileEntry;
29class Preprocessor;
30class Decl;
31class Stmt;
32
33struct SkippedRange {
34 enum Kind {
35 PPIfElse, // Preprocessor #if/#else ...
36 EmptyLine,
37 Comment,
38 };
39
40 SourceRange Range;
41 // The location of token before the skipped source range.
42 SourceLocation PrevTokLoc;
43 // The location of token after the skipped source range.
44 SourceLocation NextTokLoc;
45 // The nature of this skipped range
46 Kind RangeKind;
47
48 bool isComment() { return RangeKind == Comment; }
49 bool isEmptyLine() { return RangeKind == EmptyLine; }
50 bool isPPIfElse() { return RangeKind == PPIfElse; }
51
52 SkippedRange(SourceRange Range, Kind K,
53 SourceLocation PrevTokLoc = SourceLocation(),
54 SourceLocation NextTokLoc = SourceLocation())
55 : Range(Range), PrevTokLoc(PrevTokLoc), NextTokLoc(NextTokLoc),
56 RangeKind(K) {}
57};
58
59/// Stores additional source code information like skipped ranges which
60/// is required by the coverage mapping generator and is obtained from
61/// the preprocessor.
62class CoverageSourceInfo : public PPCallbacks,
63 public CommentHandler,
64 public EmptylineHandler {
65 // A vector of skipped source ranges and PrevTokLoc with NextTokLoc.
66 std::vector<SkippedRange> SkippedRanges;
67
68 SourceManager &SourceMgr;
69
70public:
71 // Location of the token parsed before HandleComment is called. This is
72 // updated every time Preprocessor::Lex lexes a new token.
73 SourceLocation PrevTokLoc;
74
75 CoverageSourceInfo(SourceManager &SourceMgr) : SourceMgr(SourceMgr) {}
76
77 std::vector<SkippedRange> &getSkippedRanges() { return SkippedRanges; }
78
79 void AddSkippedRange(SourceRange Range, SkippedRange::Kind RangeKind);
80
81 void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc) override;
82
83 void HandleEmptyline(SourceRange Range) override;
84
85 bool HandleComment(Preprocessor &PP, SourceRange Range) override;
86
87 void updateNextTokLoc(SourceLocation Loc);
88};
89
90namespace CodeGen {
91
92class CodeGenModule;
93
94/// Organizes the cross-function state that is used while generating
95/// code coverage mapping data.
96class CoverageMappingModuleGen {
97 /// Information needed to emit a coverage record for a function.
98 struct FunctionInfo {
99 uint64_t NameHash;
100 uint64_t FuncHash;
101 std::string CoverageMapping;
102 bool IsUsed;
103 };
104
105 CodeGenModule &CGM;
106 CoverageSourceInfo &SourceInfo;
107 llvm::SmallDenseMap<const FileEntry *, unsigned, 8> FileEntries;
108 std::vector<llvm::Constant *> FunctionNames;
109 std::vector<FunctionInfo> FunctionRecords;
110
111 std::string getCurrentDirname();
112 std::string normalizeFilename(StringRef Filename);
113
114 /// Emit a function record.
115 void emitFunctionMappingRecord(const FunctionInfo &Info,
116 uint64_t FilenamesRef);
117
118public:
119 static CoverageSourceInfo *setUpCoverageCallbacks(Preprocessor &PP);
120
121 CoverageMappingModuleGen(CodeGenModule &CGM, CoverageSourceInfo &SourceInfo);
122
123 CoverageSourceInfo &getSourceInfo() const {
124 return SourceInfo;
125 }
126
127 /// Add a function's coverage mapping record to the collection of the
128 /// function mapping records.
129 void addFunctionMappingRecord(llvm::GlobalVariable *FunctionName,
130 StringRef FunctionNameValue,
131 uint64_t FunctionHash,
132 const std::string &CoverageMapping,
133 bool IsUsed = true);
134
135 /// Emit the coverage mapping data for a translation unit.
136 void emit();
137
138 /// Return the coverage mapping translation unit file id
139 /// for the given file.
140 unsigned getFileID(const FileEntry *File);
141
142 /// Return an interface into CodeGenModule.
143 CodeGenModule &getCodeGenModule() { return CGM; }
144};
145
146/// Organizes the per-function state that is used while generating
147/// code coverage mapping data.
148class CoverageMappingGen {
149 CoverageMappingModuleGen &CVM;
150 SourceManager &SM;
151 const LangOptions &LangOpts;
152 llvm::DenseMap<const Stmt *, unsigned> *CounterMap;
153
154public:
155 CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM,
156 const LangOptions &LangOpts)
157 : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(nullptr) {}
158
159 CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM,
160 const LangOptions &LangOpts,
161 llvm::DenseMap<const Stmt *, unsigned> *CounterMap)
162 : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(CounterMap) {}
163
164 /// Emit the coverage mapping data which maps the regions of
165 /// code to counters that will be used to find the execution
166 /// counts for those regions.
167 void emitCounterMapping(const Decl *D, llvm::raw_ostream &OS);
168
169 /// Emit the coverage mapping data for an unused function.
170 /// It creates mapping regions with the counter of zero.
171 void emitEmptyMapping(const Decl *D, llvm::raw_ostream &OS);
172};
173
174} // end namespace CodeGen
175} // end namespace clang
176
177#endif
178