LLVM  14.0.0git
RemarkSerializer.h
Go to the documentation of this file.
1 //===-- RemarkSerializer.h - Remark serialization interface -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file provides an interface for serializing remarks to different formats.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_REMARKS_REMARKSERIALIZER_H
14 #define LLVM_REMARKS_REMARKSERIALIZER_H
15 
16 #include "llvm/Remarks/Remark.h"
20 
21 namespace llvm {
22 namespace remarks {
23 
24 enum class SerializerMode {
25  Separate, // A mode where the metadata is serialized separately from the
26  // remarks. Typically, this is used when the remarks need to be
27  // streamed to a side file and the metadata is embedded into the
28  // final result of the compilation.
29  Standalone // A mode where everything can be retrieved in the same
30  // file/buffer. Typically, this is used for storing remarks for
31  // later use.
32 };
33 
34 struct MetaSerializer;
35 
36 /// This is the base class for a remark serializer.
37 /// It includes support for using a string table while emitting.
39  /// The format of the serializer.
41  /// The open raw_ostream that the remark diagnostics are emitted to.
43  /// The serialization mode.
45  /// The string table containing all the unique strings used in the output.
46  /// The table can be serialized to be consumed after the compilation.
48 
52 
53  /// This is just an interface.
54  virtual ~RemarkSerializer() = default;
55  /// Emit a remark to the stream.
56  virtual void emit(const Remark &Remark) = 0;
57  /// Return the corresponding metadata serializer.
58  virtual std::unique_ptr<MetaSerializer>
60  Optional<StringRef> ExternalFilename = None) = 0;
61 };
62 
63 /// This is the base class for a remark metadata serializer.
65  /// The open raw_ostream that the metadata is emitted to.
67 
69 
70  /// This is just an interface.
71  virtual ~MetaSerializer() = default;
72  virtual void emit() = 0;
73 };
74 
75 /// Create a remark serializer.
78  raw_ostream &OS);
79 
80 /// Create a remark serializer that uses a pre-filled string table.
83  raw_ostream &OS, remarks::StringTable StrTab);
84 
85 } // end namespace remarks
86 } // end namespace llvm
87 
88 #endif // LLVM_REMARKS_REMARKSERIALIZER_H
llvm::remarks::SerializerMode
SerializerMode
Definition: RemarkSerializer.h:24
llvm::remarks::MetaSerializer::~MetaSerializer
virtual ~MetaSerializer()=default
This is just an interface.
llvm::remarks::createRemarkSerializer
Expected< std::unique_ptr< RemarkSerializer > > createRemarkSerializer(Format RemarksFormat, SerializerMode Mode, raw_ostream &OS)
Create a remark serializer.
Definition: RemarkSerializer.cpp:21
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::remarks::StringTable
The string table used for serializing remarks.
Definition: RemarkStringTable.h:36
llvm::remarks::SerializerMode::Standalone
@ Standalone
RemarkStringTable.h
llvm::remarks::SerializerMode::Separate
@ Separate
llvm::remarks::RemarkSerializer::StrTab
Optional< StringTable > StrTab
The string table containing all the unique strings used in the output.
Definition: RemarkSerializer.h:47
llvm::Optional
Definition: APInt.h:33
llvm::remarks::RemarkSerializer::OS
raw_ostream & OS
The open raw_ostream that the remark diagnostics are emitted to.
Definition: RemarkSerializer.h:42
llvm::Expected
Tagged union holding either a T or a Error.
Definition: APFloat.h:42
llvm::remarks::RemarkSerializer::SerializerFormat
Format SerializerFormat
The format of the serializer.
Definition: RemarkSerializer.h:40
llvm::remarks::RemarkSerializer::Mode
SerializerMode Mode
The serialization mode.
Definition: RemarkSerializer.h:44
Remark.h
remarks
annotation remarks
Definition: AnnotationRemarks.cpp:117
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
llvm::remarks::Remark
A remark type used for both emission and parsing.
Definition: Remark.h:67
llvm::remarks::MetaSerializer::emit
virtual void emit()=0
llvm::remarks::RemarkSerializer
This is the base class for a remark serializer.
Definition: RemarkSerializer.h:38
RemarkFormat.h
llvm::RemarksFormat
cl::opt< std::string > RemarksFormat("lto-pass-remarks-format", cl::desc("The format used for serializing remarks (default: YAML)"), cl::value_desc("format"), cl::init("yaml"))
Definition: ThinLTOCodeGenerator.cpp:85
llvm::remarks::RemarkSerializer::emit
virtual void emit(const Remark &Remark)=0
Emit a remark to the stream.
Mode
SI Whole Quad Mode
Definition: SIWholeQuadMode.cpp:262
llvm::remarks::RemarkSerializer::metaSerializer
virtual std::unique_ptr< MetaSerializer > metaSerializer(raw_ostream &OS, Optional< StringRef > ExternalFilename=None)=0
Return the corresponding metadata serializer.
llvm::remarks::MetaSerializer::OS
raw_ostream & OS
The open raw_ostream that the metadata is emitted to.
Definition: RemarkSerializer.h:66
llvm::remarks::RemarkSerializer::~RemarkSerializer
virtual ~RemarkSerializer()=default
This is just an interface.
llvm::remarks::MetaSerializer
This is the base class for a remark metadata serializer.
Definition: RemarkSerializer.h:64
llvm::remarks::MetaSerializer::MetaSerializer
MetaSerializer(raw_ostream &OS)
Definition: RemarkSerializer.h:68
raw_ostream.h
llvm::remarks::RemarkSerializer::RemarkSerializer
RemarkSerializer(Format SerializerFormat, raw_ostream &OS, SerializerMode Mode)
Definition: RemarkSerializer.h:49
llvm::remarks::Format
Format
The format used for serializing/deserializing remarks.
Definition: RemarkFormat.h:25