1 //===- SampleProfWriter.h - Write LLVM sample profile data ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains definitions needed for writing sample profiles.
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_PROFILEDATA_SAMPLEPROFWRITER_H
14 #define LLVM_PROFILEDATA_SAMPLEPROFWRITER_H
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/IR/Function.h"
18 #include "llvm/IR/Module.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"
26 namespace sampleprof {
28 enum SampleProfileFormat { SPF_None = 0, SPF_Text, SPF_Binary, SPF_GCC };
30 /// \brief Sample-based profile writer. Base class.
31 class SampleProfileWriter {
33 SampleProfileWriter(StringRef Filename, std::error_code &EC,
34 sys::fs::OpenFlags Flags)
35 : OS(Filename, EC, Flags) {}
36 virtual ~SampleProfileWriter() {}
38 /// \brief Write sample profiles in \p S for function \p FName.
40 /// \returns true if the file was updated successfully. False, otherwise.
41 virtual bool write(StringRef FName, const FunctionSamples &S) = 0;
43 /// \brief Write all the sample profiles in the given map of samples.
45 /// \returns true if the file was updated successfully. False, otherwise.
46 bool write(StringMap<FunctionSamples> &ProfileMap) {
47 for (auto &I : ProfileMap) {
48 StringRef FName = I.first();
49 FunctionSamples &Profile = I.second;
50 if (!write(FName, Profile))
56 /// \brief Profile writer factory. Create a new writer based on the value of
58 static ErrorOr<std::unique_ptr<SampleProfileWriter>>
59 create(StringRef Filename, SampleProfileFormat Format);
62 /// \brief Output stream where to emit the profile to.
66 /// \brief Sample-based profile writer (text format).
67 class SampleProfileWriterText : public SampleProfileWriter {
69 SampleProfileWriterText(StringRef F, std::error_code &EC)
70 : SampleProfileWriter(F, EC, sys::fs::F_Text), Indent(0) {}
72 bool write(StringRef FName, const FunctionSamples &S) override;
75 /// Indent level to use when writing.
77 /// This is used when printing inlined callees.
81 /// \brief Sample-based profile writer (binary format).
82 class SampleProfileWriterBinary : public SampleProfileWriter {
84 SampleProfileWriterBinary(StringRef F, std::error_code &EC);
86 bool write(StringRef F, const FunctionSamples &S) override;
89 } // End namespace sampleprof
91 } // End namespace llvm
93 #endif // LLVM_PROFILEDATA_SAMPLEPROFWRITER_H