1 //===- SampleProfWriter.h - Write LLVM sample profile data ----------------===// 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 // This file contains definitions needed for writing sample profiles. 11 // 12 //===----------------------------------------------------------------------===// 13 #ifndef LLVM_PROFILEDATA_SAMPLEPROFWRITER_H 14 #define LLVM_PROFILEDATA_SAMPLEPROFWRITER_H 15 16 #include "llvm/ADT/MapVector.h" 17 #include "llvm/ADT/StringRef.h" 18 #include "llvm/ProfileData/ProfileCommon.h" 19 #include "llvm/ProfileData/SampleProf.h" 20 #include "llvm/Support/ErrorOr.h" 21 #include "llvm/Support/FileSystem.h" 22 #include "llvm/Support/raw_ostream.h" 23 24 namespace llvm { 25 26 namespace sampleprof { 27 28 enum SampleProfileFormat { SPF_None = 0, SPF_Text, SPF_Binary, SPF_GCC }; 29 30 /// \brief Sample-based profile writer. Base class. 31 class SampleProfileWriter { 32 public: ~SampleProfileWriter()33 virtual ~SampleProfileWriter() {} 34 35 /// Write sample profiles in \p S. 36 /// 37 /// \returns status code of the file update operation. 38 virtual std::error_code write(const FunctionSamples &S) = 0; 39 40 /// Write all the sample profiles in the given map of samples. 41 /// 42 /// \returns status code of the file update operation. write(const StringMap<FunctionSamples> & ProfileMap)43 std::error_code write(const StringMap<FunctionSamples> &ProfileMap) { 44 if (std::error_code EC = writeHeader(ProfileMap)) 45 return EC; 46 for (const auto &I : ProfileMap) { 47 const FunctionSamples &Profile = I.second; 48 if (std::error_code EC = write(Profile)) 49 return EC; 50 } 51 return sampleprof_error::success; 52 } 53 getOutputStream()54 raw_ostream &getOutputStream() { return *OutputStream; } 55 56 /// Profile writer factory. 57 /// 58 /// Create a new file writer based on the value of \p Format. 59 static ErrorOr<std::unique_ptr<SampleProfileWriter>> 60 create(StringRef Filename, SampleProfileFormat Format); 61 62 /// Create a new stream writer based on the value of \p Format. 63 /// For testing. 64 static ErrorOr<std::unique_ptr<SampleProfileWriter>> 65 create(std::unique_ptr<raw_ostream> &OS, SampleProfileFormat Format); 66 67 protected: SampleProfileWriter(std::unique_ptr<raw_ostream> & OS)68 SampleProfileWriter(std::unique_ptr<raw_ostream> &OS) 69 : OutputStream(std::move(OS)) {} 70 71 /// \brief Write a file header for the profile file. 72 virtual std::error_code 73 writeHeader(const StringMap<FunctionSamples> &ProfileMap) = 0; 74 75 /// \brief Output stream where to emit the profile to. 76 std::unique_ptr<raw_ostream> OutputStream; 77 78 /// \brief Profile summary. 79 std::unique_ptr<ProfileSummary> Summary; 80 81 /// \brief Compute summary for this profile. 82 void computeSummary(const StringMap<FunctionSamples> &ProfileMap); 83 }; 84 85 /// \brief Sample-based profile writer (text format). 86 class SampleProfileWriterText : public SampleProfileWriter { 87 public: 88 std::error_code write(const FunctionSamples &S) override; 89 90 protected: SampleProfileWriterText(std::unique_ptr<raw_ostream> & OS)91 SampleProfileWriterText(std::unique_ptr<raw_ostream> &OS) 92 : SampleProfileWriter(OS), Indent(0) {} 93 94 std::error_code writeHeader(const StringMap<FunctionSamples> & ProfileMap)95 writeHeader(const StringMap<FunctionSamples> &ProfileMap) override { 96 return sampleprof_error::success; 97 } 98 99 private: 100 /// Indent level to use when writing. 101 /// 102 /// This is used when printing inlined callees. 103 unsigned Indent; 104 105 friend ErrorOr<std::unique_ptr<SampleProfileWriter>> 106 SampleProfileWriter::create(std::unique_ptr<raw_ostream> &OS, 107 SampleProfileFormat Format); 108 }; 109 110 /// \brief Sample-based profile writer (binary format). 111 class SampleProfileWriterBinary : public SampleProfileWriter { 112 public: 113 std::error_code write(const FunctionSamples &S) override; 114 115 protected: SampleProfileWriterBinary(std::unique_ptr<raw_ostream> & OS)116 SampleProfileWriterBinary(std::unique_ptr<raw_ostream> &OS) 117 : SampleProfileWriter(OS), NameTable() {} 118 119 std::error_code 120 writeHeader(const StringMap<FunctionSamples> &ProfileMap) override; 121 std::error_code writeSummary(); 122 std::error_code writeNameIdx(StringRef FName); 123 std::error_code writeBody(const FunctionSamples &S); 124 125 private: 126 void addName(StringRef FName); 127 void addNames(const FunctionSamples &S); 128 129 MapVector<StringRef, uint32_t> NameTable; 130 131 friend ErrorOr<std::unique_ptr<SampleProfileWriter>> 132 SampleProfileWriter::create(std::unique_ptr<raw_ostream> &OS, 133 SampleProfileFormat Format); 134 }; 135 136 } // End namespace sampleprof 137 138 } // End namespace llvm 139 140 #endif // LLVM_PROFILEDATA_SAMPLEPROFWRITER_H 141