1 //===- SourceCoverageView.h - Code coverage view for source code ----------===// 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 /// \file This class implements rendering for code coverage of source code. 11 /// 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_COV_SOURCECOVERAGEVIEW_H 15 #define LLVM_COV_SOURCECOVERAGEVIEW_H 16 17 #include "CoverageViewOptions.h" 18 #include "llvm/ProfileData/Coverage/CoverageMapping.h" 19 #include "llvm/Support/MemoryBuffer.h" 20 #include <vector> 21 22 namespace llvm { 23 24 class SourceCoverageView; 25 26 /// \brief A view that represents a macro or include expansion. 27 struct ExpansionView { 28 coverage::CounterMappingRegion Region; 29 std::unique_ptr<SourceCoverageView> View; 30 31 ExpansionView(const coverage::CounterMappingRegion &Region, 32 std::unique_ptr<SourceCoverageView> View) 33 : Region(Region), View(std::move(View)) {} 34 ExpansionView(ExpansionView &&RHS) 35 : Region(std::move(RHS.Region)), View(std::move(RHS.View)) {} 36 ExpansionView &operator=(ExpansionView &&RHS) { 37 Region = std::move(RHS.Region); 38 View = std::move(RHS.View); 39 return *this; 40 } 41 42 unsigned getLine() const { return Region.LineStart; } 43 unsigned getStartCol() const { return Region.ColumnStart; } 44 unsigned getEndCol() const { return Region.ColumnEnd; } 45 46 friend bool operator<(const ExpansionView &LHS, const ExpansionView &RHS) { 47 return LHS.Region.startLoc() < RHS.Region.startLoc(); 48 } 49 }; 50 51 /// \brief A view that represents a function instantiation. 52 struct InstantiationView { 53 StringRef FunctionName; 54 unsigned Line; 55 std::unique_ptr<SourceCoverageView> View; 56 57 InstantiationView(StringRef FunctionName, unsigned Line, 58 std::unique_ptr<SourceCoverageView> View) 59 : FunctionName(FunctionName), Line(Line), View(std::move(View)) {} 60 InstantiationView(InstantiationView &&RHS) 61 : FunctionName(std::move(RHS.FunctionName)), Line(std::move(RHS.Line)), 62 View(std::move(RHS.View)) {} 63 InstantiationView &operator=(InstantiationView &&RHS) { 64 FunctionName = std::move(RHS.FunctionName); 65 Line = std::move(RHS.Line); 66 View = std::move(RHS.View); 67 return *this; 68 } 69 70 friend bool operator<(const InstantiationView &LHS, 71 const InstantiationView &RHS) { 72 return LHS.Line < RHS.Line; 73 } 74 }; 75 76 /// \brief Coverage statistics for a single line. 77 struct LineCoverageStats { 78 uint64_t ExecutionCount; 79 unsigned RegionCount; 80 bool Mapped; 81 82 LineCoverageStats() : ExecutionCount(0), RegionCount(0), Mapped(false) {} 83 84 bool isMapped() const { return Mapped; } 85 86 bool hasMultipleRegions() const { return RegionCount > 1; } 87 88 void addRegionStartCount(uint64_t Count) { 89 // The max of all region starts is the most interesting value. 90 addRegionCount(RegionCount ? std::max(ExecutionCount, Count) : Count); 91 ++RegionCount; 92 } 93 94 void addRegionCount(uint64_t Count) { 95 Mapped = true; 96 ExecutionCount = Count; 97 } 98 }; 99 100 /// \brief A file manager that handles format-aware file creation. 101 class CoveragePrinter { 102 const CoverageViewOptions &Opts; 103 104 public: 105 struct StreamDestructor { 106 void operator()(raw_ostream *OS) const; 107 }; 108 109 using OwnedStream = std::unique_ptr<raw_ostream, StreamDestructor>; 110 111 protected: 112 CoveragePrinter(const CoverageViewOptions &Opts) : Opts(Opts) {} 113 114 /// \brief Return `OutputDir/ToplevelDir/Path.Extension`. 115 std::string getOutputPath(StringRef Path, StringRef Extension, 116 bool InToplevel); 117 118 /// \brief If directory output is enabled, create a file in that directory 119 /// at the path given by getOutputPath(). Otherwise, return stdout. 120 Expected<OwnedStream> createOutputStream(StringRef Path, StringRef Extension, 121 bool InToplevel); 122 123 /// \brief Return the sub-directory name for file coverage reports. 124 static StringRef getCoverageDir() { return "coverage"; } 125 126 public: 127 static std::unique_ptr<CoveragePrinter> 128 create(const CoverageViewOptions &Opts); 129 130 virtual ~CoveragePrinter() {} 131 132 /// @name File Creation Interface 133 /// @{ 134 135 /// \brief Create a file to print a coverage view into. 136 virtual Expected<OwnedStream> createViewFile(StringRef Path, 137 bool InToplevel) = 0; 138 139 /// \brief Close a file which has been used to print a coverage view. 140 virtual void closeViewFile(OwnedStream OS) = 0; 141 142 /// \brief Create an index which lists reports for the given source files. 143 virtual Error createIndexFile(ArrayRef<StringRef> SourceFiles) = 0; 144 145 /// @} 146 }; 147 148 /// \brief A code coverage view of a source file or function. 149 /// 150 /// A source coverage view and its nested sub-views form a file-oriented 151 /// representation of code coverage data. This view can be printed out by a 152 /// renderer which implements the Rendering Interface. 153 class SourceCoverageView { 154 /// A function or file name. 155 StringRef SourceName; 156 157 /// A memory buffer backing the source on display. 158 const MemoryBuffer &File; 159 160 /// Various options to guide the coverage renderer. 161 const CoverageViewOptions &Options; 162 163 /// Complete coverage information about the source on display. 164 coverage::CoverageData CoverageInfo; 165 166 /// A container for all expansions (e.g macros) in the source on display. 167 std::vector<ExpansionView> ExpansionSubViews; 168 169 /// A container for all instantiations (e.g template functions) in the source 170 /// on display. 171 std::vector<InstantiationView> InstantiationSubViews; 172 173 protected: 174 struct LineRef { 175 StringRef Line; 176 int64_t LineNo; 177 178 LineRef(StringRef Line, int64_t LineNo) : Line(Line), LineNo(LineNo) {} 179 }; 180 181 using CoverageSegmentArray = ArrayRef<const coverage::CoverageSegment *>; 182 183 /// @name Rendering Interface 184 /// @{ 185 186 /// \brief Render the source name for the view. 187 virtual void renderSourceName(raw_ostream &OS) = 0; 188 189 /// \brief Render the line prefix at the given \p ViewDepth. 190 virtual void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) = 0; 191 192 /// \brief Render a view divider at the given \p ViewDepth. 193 virtual void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) = 0; 194 195 /// \brief Render a source line with highlighting. 196 virtual void renderLine(raw_ostream &OS, LineRef L, 197 const coverage::CoverageSegment *WrappedSegment, 198 CoverageSegmentArray Segments, unsigned ExpansionCol, 199 unsigned ViewDepth) = 0; 200 201 /// \brief Render the line's execution count column. 202 virtual void renderLineCoverageColumn(raw_ostream &OS, 203 const LineCoverageStats &Line) = 0; 204 205 /// \brief Render the line number column. 206 virtual void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) = 0; 207 208 /// \brief Render all the region's execution counts on a line. 209 virtual void renderRegionMarkers(raw_ostream &OS, 210 CoverageSegmentArray Segments, 211 unsigned ViewDepth) = 0; 212 213 /// \brief Render the site of an expansion. 214 virtual void 215 renderExpansionSite(raw_ostream &OS, ExpansionView &ESV, LineRef L, 216 const coverage::CoverageSegment *WrappedSegment, 217 CoverageSegmentArray Segments, unsigned ExpansionCol, 218 unsigned ViewDepth) = 0; 219 220 /// \brief Render an expansion view and any nested views. 221 virtual void renderExpansionView(raw_ostream &OS, ExpansionView &ESV, 222 unsigned ViewDepth) = 0; 223 224 /// \brief Render an instantiation view and any nested views. 225 virtual void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV, 226 unsigned ViewDepth) = 0; 227 228 /// @} 229 230 /// \brief Format a count using engineering notation with 3 significant 231 /// digits. 232 static std::string formatCount(uint64_t N); 233 234 SourceCoverageView(StringRef SourceName, const MemoryBuffer &File, 235 const CoverageViewOptions &Options, 236 coverage::CoverageData &&CoverageInfo) 237 : SourceName(SourceName), File(File), Options(Options), 238 CoverageInfo(std::move(CoverageInfo)) {} 239 240 public: 241 static std::unique_ptr<SourceCoverageView> 242 create(StringRef SourceName, const MemoryBuffer &File, 243 const CoverageViewOptions &Options, 244 coverage::CoverageData &&CoverageInfo); 245 246 virtual ~SourceCoverageView() {} 247 248 StringRef getSourceName() const { return SourceName; } 249 250 const CoverageViewOptions &getOptions() const { return Options; } 251 252 /// \brief Add an expansion subview to this view. 253 void addExpansion(const coverage::CounterMappingRegion &Region, 254 std::unique_ptr<SourceCoverageView> View); 255 256 /// \brief Add a function instantiation subview to this view. 257 void addInstantiation(StringRef FunctionName, unsigned Line, 258 std::unique_ptr<SourceCoverageView> View); 259 260 /// \brief Print the code coverage information for a specific portion of a 261 /// source file to the output stream. 262 void print(raw_ostream &OS, bool WholeFile, bool ShowSourceName, 263 unsigned ViewDepth = 0); 264 }; 265 266 } // namespace llvm 267 268 #endif // LLVM_COV_SOURCECOVERAGEVIEW_H 269