LLVM  17.0.0git
SymbolSerializer.h
Go to the documentation of this file.
1 //===- SymbolSerializer.h ---------------------------------------*- 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 #ifndef LLVM_DEBUGINFO_CODEVIEW_SYMBOLSERIALIZER_H
10 #define LLVM_DEBUGINFO_CODEVIEW_SYMBOLSERIALIZER_H
11 
17 #include "llvm/Support/Allocator.h"
20 #include "llvm/Support/Endian.h"
21 #include "llvm/Support/Error.h"
22 #include <array>
23 #include <cstdint>
24 
25 namespace llvm {
26 namespace codeview {
27 
29  BumpPtrAllocator &Storage;
30  // Since this is a fixed size buffer, use a stack allocated buffer. This
31  // yields measurable performance increase over the repeated heap allocations
32  // when serializing many independent records via writeOneSymbol.
33  std::array<uint8_t, MaxRecordLength> RecordBuffer;
35  BinaryStreamWriter Writer;
36  SymbolRecordMapping Mapping;
37  std::optional<SymbolKind> CurrentSymbol;
38 
39  Error writeRecordPrefix(SymbolKind Kind) {
41  Prefix.RecordKind = Kind;
42  Prefix.RecordLen = 0;
43  if (auto EC = Writer.writeObject(Prefix))
44  return EC;
45  return Error::success();
46  }
47 
48 public:
50 
51  template <typename SymType>
52  static CVSymbol writeOneSymbol(SymType &Sym, BumpPtrAllocator &Storage,
53  CodeViewContainer Container) {
54  RecordPrefix Prefix{uint16_t(Sym.Kind)};
55  CVSymbol Result(&Prefix, sizeof(Prefix));
56  SymbolSerializer Serializer(Storage, Container);
57  consumeError(Serializer.visitSymbolBegin(Result));
58  consumeError(Serializer.visitKnownRecord(Result, Sym));
59  consumeError(Serializer.visitSymbolEnd(Result));
60  return Result;
61  }
62 
65 
66 #define SYMBOL_RECORD(EnumName, EnumVal, Name) \
67  Error visitKnownRecord(CVSymbol &CVR, Name &Record) override { \
68  return visitKnownRecordImpl(CVR, Record); \
69  }
70 #define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, Name, AliasName)
71 #include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
72 
73 private:
74  template <typename RecordKind>
75  Error visitKnownRecordImpl(CVSymbol &CVR, RecordKind &Record) {
76  return Mapping.visitKnownRecord(CVR, Record);
77  }
78 };
79 
80 } // end namespace codeview
81 } // end namespace llvm
82 
83 #endif // LLVM_DEBUGINFO_CODEVIEW_SYMBOLSERIALIZER_H
SymbolRecordMapping.h
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::MutableBinaryByteStream
An implementation of BinaryStream which holds its entire data set in a single contiguous buffer.
Definition: BinaryByteStream.h:88
RecordSerialization.h
llvm::cl::Prefix
@ Prefix
Definition: CommandLine.h:159
BinaryByteStream.h
llvm::codeview::SymbolKind
SymbolKind
Duplicate copy of the above enum, but using the official CV names.
Definition: CodeView.h:47
llvm::BinaryStreamWriter
Provides write only access to a subclass of WritableBinaryStream.
Definition: BinaryStreamWriter.h:30
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:330
Allocator.h
Error.h
llvm::codeview::SymbolSerializer::visitSymbolBegin
Error visitSymbolBegin(CVSymbol &Record) override
Definition: SymbolSerializer.cpp:26
llvm::codeview::RecordPrefix
Definition: RecordSerialization.h:32
llvm::consumeError
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1043
llvm::codeview::SymbolRecordMapping
Definition: SymbolRecordMapping.h:20
llvm::codeview::SymbolSerializer::visitSymbolEnd
Error visitSymbolEnd(CVSymbol &Record) override
Definition: SymbolSerializer.cpp:41
llvm::codeview::CVSymbol
CVRecord< SymbolKind > CVSymbol
Definition: CVRecord.h:65
llvm::codeview::SymbolSerializer::writeOneSymbol
static CVSymbol writeOneSymbol(SymType &Sym, BumpPtrAllocator &Storage, CodeViewContainer Container)
Definition: SymbolSerializer.h:52
SymbolVisitorCallbacks.h
llvm::codeview::SymbolSerializer::SymbolSerializer
SymbolSerializer(BumpPtrAllocator &Storage, CodeViewContainer Container)
Definition: SymbolSerializer.cpp:21
llvm::codeview::SymbolSerializer
Definition: SymbolSerializer.h:28
CodeView.h
llvm::codeview::SymbolVisitorCallbacks
Definition: SymbolVisitorCallbacks.h:18
llvm::BumpPtrAllocatorImpl
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:63
llvm::codeview::CompileSym2Flags::EC
@ EC
llvm::Record
Definition: Record.h:1577
llvm::BinaryStreamWriter::writeObject
Error writeObject(const T &Obj)
Writes the object Obj to the underlying stream, as if by using memcpy.
Definition: BinaryStreamWriter.h:129
llvm::codeview::CVRecord
CVRecord is a fat pointer (base + size pair) to a symbol or type record.
Definition: CVRecord.h:29
uint16_t
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
CVRecord.h
llvm::codeview::CodeViewContainer
CodeViewContainer
Definition: CodeView.h:609
BinaryStreamWriter.h
Endian.h