LLVM 17.0.0git
DebugSubsectionRecord.h
Go to the documentation of this file.
1//===- DebugSubsectionRecord.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_DEBUGSUBSECTIONRECORD_H
10#define LLVM_DEBUGINFO_CODEVIEW_DEBUGSUBSECTIONRECORD_H
11
15#include "llvm/Support/Endian.h"
16#include "llvm/Support/Error.h"
18#include <cstdint>
19#include <memory>
20
21namespace llvm {
22
23class BinaryStreamWriter;
24
25namespace codeview {
26
27class DebugSubsection;
28
29// Corresponds to the `CV_DebugSSubsectionHeader_t` structure.
31 support::ulittle32_t Kind; // codeview::DebugSubsectionKind enum
32 support::ulittle32_t Length; // number of bytes occupied by this record.
33};
34
36public:
39
41
45
46private:
48 BinaryStreamRef Data;
49};
50
52public:
53 DebugSubsectionRecordBuilder(std::shared_ptr<DebugSubsection> Subsection);
54
55 /// Use this to copy existing subsections directly from source to destination.
56 /// For example, line table subsections in an object file only need to be
57 /// relocated before being copied into the PDB.
59
61 Error commit(BinaryStreamWriter &Writer, CodeViewContainer Container) const;
62
63private:
64 /// The subsection to build. Will be null if Contents is non-empty.
65 std::shared_ptr<DebugSubsection> Subsection;
66
67 /// The bytes of the subsection. Only non-empty if Subsection is null.
68 /// FIXME: Reduce the size of this.
69 DebugSubsectionRecord Contents;
70};
71
72} // end namespace codeview
73
74template <> struct VarStreamArrayExtractor<codeview::DebugSubsectionRecord> {
77 // FIXME: We need to pass the container type through to this function. In
78 // practice this isn't super important since the subsection header describes
79 // its length and we can just skip it. It's more important when writing.
81 return EC;
82 Length = alignTo(Info.getRecordLength(), 4);
83 return Error::success();
84 }
85};
86
87namespace codeview {
88
90
91} // end namespace codeview
92
93} // end namespace llvm
94
95#endif // LLVM_DEBUGINFO_CODEVIEW_DEBUGSUBSECTIONRECORD_H
Lightweight arrays that are backed by an arbitrary BinaryStream.
Analysis containing CSE Info
Definition: CSEInfo.cpp:27
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array.
Provides write only access to a subclass of WritableBinaryStream.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
static ErrorSuccess success()
Create a success value.
Definition: Error.h:330
Error commit(BinaryStreamWriter &Writer, CodeViewContainer Container) const
static Error initialize(BinaryStreamRef Stream, DebugSubsectionRecord &Info)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Length
Definition: DWP.cpp:406
uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition: Alignment.h:155
Error operator()(BinaryStreamRef Stream, uint32_t &Length, codeview::DebugSubsectionRecord &Info)
VarStreamArrayExtractor is intended to be specialized to provide customized extraction logic.