contrib/llvm/tools/clang/lib/CodeGen/CoverageMappingGen.h

   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"
  18 #include "clang/Basic/SourceLocation.h"
  19 #include "clang/Frontend/CodeGenOptions.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.
  38 class CoverageSourceInfo : public PPCallbacks {
  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.
  52 class CoverageMappingModuleGen {
  53   CodeGenModule &CGM;
  54   CoverageSourceInfo &SourceInfo;
  55   llvm::SmallDenseMap<const FileEntry *, unsigned, 8> FileEntries;
  56   std::vector<llvm::Constant *> FunctionRecords;
  57   llvm::StructType *FunctionRecordTy;
  58   std::string CoverageMappings;
  59
  60 public:
  61   CoverageMappingModuleGen(CodeGenModule &CGM, CoverageSourceInfo &SourceInfo)
  62       : CGM(CGM), SourceInfo(SourceInfo), FunctionRecordTy(nullptr) {}
  63
  64   CoverageSourceInfo &getSourceInfo() const {
  65     return SourceInfo;
  66   }
  67
  68   /// \brief Add a function's coverage mapping record to the collection of the
  69   /// function mapping records.
  70   void addFunctionMappingRecord(llvm::GlobalVariable *FunctionName,
  71                                 StringRef FunctionNameValue,
  72                                 uint64_t FunctionHash,
  73                                 const std::string &CoverageMapping);
  74
  75   /// \brief Emit the coverage mapping data for a translation unit.
  76   void emit();
  77
  78   /// \brief Return the coverage mapping translation unit file id
  79   /// for the given file.
  80   unsigned getFileID(const FileEntry *File);
  81 };
  82
  83 /// \brief Organizes the per-function state that is used while generating
  84 /// code coverage mapping data.
  85 class CoverageMappingGen {
  86   CoverageMappingModuleGen &CVM;
  87   SourceManager &SM;
  88   const LangOptions &LangOpts;
  89   llvm::DenseMap<const Stmt *, unsigned> *CounterMap;
  90
  91 public:
  92   CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM,
  93                      const LangOptions &LangOpts)
  94       : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(nullptr) {}
  95
  96   CoverageMappingGen(CoverageMappingModuleGen &CVM, SourceManager &SM,
  97                      const LangOptions &LangOpts,
  98                      llvm::DenseMap<const Stmt *, unsigned> *CounterMap)
  99       : CVM(CVM), SM(SM), LangOpts(LangOpts), CounterMap(CounterMap) {}
 100
 101   /// \brief Emit the coverage mapping data which maps the regions of
 102   /// code to counters that will be used to find the execution
 103   /// counts for those regions.
 104   void emitCounterMapping(const Decl *D, llvm::raw_ostream &OS);
 105
 106   /// \brief Emit the coverage mapping data for an unused function.
 107   /// It creates mapping regions with the counter of zero.
 108   void emitEmptyMapping(const Decl *D, llvm::raw_ostream &OS);
 109 };
 110
 111 } // end namespace CodeGen
 112 } // end namespace clang
 113
 114 #endif