clang  3.9.0
CoverageMappingGen.h
Go to the documentation of this file.
1 //===---- CoverageMappingGen.h - Coverage mapping generation ----*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Instrumentation-based code coverage mapping generator
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_CODEGEN_COVERAGEMAPPINGGEN_H
15 #define LLVM_CLANG_LIB_CODEGEN_COVERAGEMAPPINGGEN_H
16 
17 #include "clang/Basic/LLVM.h"
20 #include "clang/Lex/PPCallbacks.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/IR/GlobalValue.h"
24 #include "llvm/Support/raw_ostream.h"
25 
26 namespace clang {
27 
28 class LangOptions;
29 class SourceManager;
30 class FileEntry;
31 class Preprocessor;
32 class Decl;
33 class Stmt;
34 
35 /// \brief Stores additional source code information like skipped ranges which
36 /// is required by the coverage mapping generator and is obtained from
37 /// the preprocessor.
39  std::vector<SourceRange> SkippedRanges;
40 public:
41  ArrayRef<SourceRange> getSkippedRanges() const { return SkippedRanges; }
42 
43  void SourceRangeSkipped(SourceRange Range) override;
44 };
45 
46 namespace CodeGen {
47 
48 class CodeGenModule;
49 
50 /// \brief Organizes the cross-function state that is used while generating
51 /// code coverage mapping data.
53  CodeGenModule &CGM;
54  CoverageSourceInfo &SourceInfo;
55  llvm::SmallDenseMap<const FileEntry *, unsigned, 8> FileEntries;
56  std::vector<llvm::Constant *> FunctionRecords;
57  std::vector<llvm::Constant *> FunctionNames;
58  llvm::StructType *FunctionRecordTy;
59  std::vector<std::string> CoverageMappings;
60 
61 public:
63  : CGM(CGM), SourceInfo(SourceInfo), FunctionRecordTy(nullptr) {}
64 
66  return SourceInfo;
67  }
68 
69  /// \brief Add a function's coverage mapping record to the collection of the
70  /// function mapping records.
71  void addFunctionMappingRecord(llvm::GlobalVariable *FunctionName,
72  StringRef FunctionNameValue,
73  uint64_t FunctionHash,
74  const std::string &CoverageMapping,
75  bool IsUsed = true);
76 
77  /// \brief Emit the coverage mapping data for a translation unit.
78  void emit();
79 
80  /// \brief Return the coverage mapping translation unit file id
81  /// for the given file.
82  unsigned getFileID(const FileEntry *File);
83 };
84 
85 /// \brief Organizes the per-function state that is used while generating
86 /// code coverage mapping data.
89  SourceManager &SM;
90  const LangOptions &LangOpts;
91  llvm::DenseMap<const Stmt *, unsigned> *CounterMap;
92 
93 public:
95  const LangOptions &LangOpts)
96  : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(nullptr) {}
97 
99  const LangOptions &LangOpts,
100  llvm::DenseMap<const Stmt *, unsigned> *CounterMap)
101  : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(CounterMap) {}
102 
103  /// \brief Emit the coverage mapping data which maps the regions of
104  /// code to counters that will be used to find the execution
105  /// counts for those regions.
106  void emitCounterMapping(const Decl *D, llvm::raw_ostream &OS);
107 
108  /// \brief Emit the coverage mapping data for an unused function.
109  /// It creates mapping regions with the counter of zero.
110  void emitEmptyMapping(const Decl *D, llvm::raw_ostream &OS);
111 };
112 
113 } // end namespace CodeGen
114 } // end namespace clang
115 
116 #endif
Organizes the per-function state that is used while generating code coverage mapping data...
CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM, const LangOptions &LangOpts, llvm::DenseMap< const Stmt *, unsigned > *CounterMap)
Stores additional source code information like skipped ranges which is required by the coverage mappi...
This interface provides a way to observe the actions of the preprocessor as it does its thing...
Definition: PPCallbacks.h:38
void emit()
Emit the coverage mapping data for a translation unit.
CoverageSourceInfo & getSourceInfo() const
void addFunctionMappingRecord(llvm::GlobalVariable *FunctionName, StringRef FunctionNameValue, uint64_t FunctionHash, const std::string &CoverageMapping, bool IsUsed=true)
Add a function's coverage mapping record to the collection of the function mapping records...
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:48
ArrayRef< SourceRange > getSkippedRanges() const
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
Organizes the cross-function state that is used while generating code coverage mapping data...
CoverageMappingModuleGen(CodeGenModule &CGM, CoverageSourceInfo &SourceInfo)
unsigned getFileID(const FileEntry *File)
Return the coverage mapping translation unit file id for the given file.
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:53
void SourceRangeSkipped(SourceRange Range) override
Hook called when a source range is skipped.
This class organizes the cross-function state that is used while generating LLVM code.
CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM, const LangOptions &LangOpts)
Defines the PPCallbacks interface.
void emitCounterMapping(const Decl *D, llvm::raw_ostream &OS)
Emit the coverage mapping data which maps the regions of code to counters that will be used to find t...
Defines the clang::SourceLocation class and associated facilities.
A trivial tuple used to represent a source range.
void emitEmptyMapping(const Decl *D, llvm::raw_ostream &OS)
Emit the coverage mapping data for an unused function.
This class handles loading and caching of source files into memory.