LLVM  14.0.0git
DebugLinesSubsection.h
Go to the documentation of this file.
1 //===- DebugLinesSubsection.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_DEBUGLINESSUBSECTION_H
10 #define LLVM_DEBUGINFO_CODEVIEW_DEBUGLINESSUBSECTION_H
11 
12 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/Endian.h"
20 #include "llvm/Support/Error.h"
21 #include <cstdint>
22 #include <vector>
23 
24 namespace llvm {
25 namespace codeview {
26 
27 class DebugChecksumsSubsection;
28 class DebugStringTableSubsection;
29 
30 // Corresponds to the `CV_DebugSLinesHeader_t` structure.
32  support::ulittle32_t RelocOffset; // Code offset of line contribution.
33  support::ulittle16_t RelocSegment; // Code segment of line contribution.
34  support::ulittle16_t Flags; // See LineFlags enumeration.
35  support::ulittle32_t CodeSize; // Code size of this line contribution.
36 };
37 
38 // Corresponds to the `CV_DebugSLinesFileBlockHeader_t` structure.
40  support::ulittle32_t NameIndex; // Offset of FileChecksum entry in File
41  // checksums buffer. The checksum entry then
42  // contains another offset into the string
43  // table of the actual name.
44  support::ulittle32_t NumLines; // Number of lines
45  support::ulittle32_t BlockSize; // Code size of block, in bytes.
46  // The following two variable length arrays appear immediately after the
47  // header. The structure definitions follow.
48  // LineNumberEntry Lines[NumLines];
49  // ColumnNumberEntry Columns[NumLines];
50 };
51 
52 // Corresponds to `CV_Line_t` structure
54  support::ulittle32_t Offset; // Offset to start of code bytes for line number
55  support::ulittle32_t Flags; // Start:24, End:7, IsStatement:1
56 };
57 
58 // Corresponds to `CV_Column_t` structure
62 };
63 
68 };
69 
71 public:
73  LineColumnEntry &Item);
74 
75  const LineFragmentHeader *Header = nullptr;
76 };
77 
79  friend class LineColumnExtractor;
80 
83 
84 public:
86 
87  static bool classof(const DebugSubsectionRef *S) {
88  return S->kind() == DebugSubsectionKind::Lines;
89  }
90 
92 
93  Iterator begin() const { return LinesAndColumns.begin(); }
94  Iterator end() const { return LinesAndColumns.end(); }
95 
96  const LineFragmentHeader *header() const { return Header; }
97 
98  bool hasColumnInfo() const;
99 
100 private:
101  const LineFragmentHeader *Header = nullptr;
102  LineInfoArray LinesAndColumns;
103 };
104 
105 class DebugLinesSubsection final : public DebugSubsection {
106  struct Block {
107  Block(uint32_t ChecksumBufferOffset)
108  : ChecksumBufferOffset(ChecksumBufferOffset) {}
109 
110  uint32_t ChecksumBufferOffset;
111  std::vector<LineNumberEntry> Lines;
112  std::vector<ColumnNumberEntry> Columns;
113  };
114 
115 public:
117  DebugStringTableSubsection &Strings);
118 
119  static bool classof(const DebugSubsection *S) {
120  return S->kind() == DebugSubsectionKind::Lines;
121  }
122 
123  void createBlock(StringRef FileName);
124  void addLineInfo(uint32_t Offset, const LineInfo &Line);
126  uint32_t ColStart, uint32_t ColEnd);
127 
128  uint32_t calculateSerializedSize() const override;
129  Error commit(BinaryStreamWriter &Writer) const override;
130 
132  void setCodeSize(uint32_t Size);
133  void setFlags(LineFlags Flags);
134 
135  bool hasColumnInfo() const;
136 
137 private:
138  DebugChecksumsSubsection &Checksums;
139  uint32_t RelocOffset = 0;
140  uint16_t RelocSegment = 0;
141  uint32_t CodeSize = 0;
142  LineFlags Flags = LF_None;
143  std::vector<Block> Blocks;
144 };
145 
146 } // end namespace codeview
147 } // end namespace llvm
148 
149 #endif // LLVM_DEBUGINFO_CODEVIEW_DEBUGLINESSUBSECTION_H
llvm::Check::Size
@ Size
Definition: FileCheck.h:73
BinaryStreamReader.h
llvm::codeview::DebugLinesSubsection::createBlock
void createBlock(StringRef FileName)
Definition: DebugLinesSubsection.cpp:75
llvm::codeview::DebugLinesSubsection::commit
Error commit(BinaryStreamWriter &Writer) const override
Definition: DebugLinesSubsection.cpp:103
llvm::codeview::LineBlockFragmentHeader::NumLines
support::ulittle32_t NumLines
Definition: DebugLinesSubsection.h:44
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::codeview::LineColumnEntry::Columns
FixedStreamArray< ColumnNumberEntry > Columns
Definition: DebugLinesSubsection.h:67
llvm::codeview::LineBlockFragmentHeader
Definition: DebugLinesSubsection.h:39
llvm::codeview::DebugSubsectionKind::Lines
@ Lines
llvm::codeview::DebugChecksumsSubsection
Definition: DebugChecksumsSubsection.h:75
llvm::support::detail::packed_endian_specific_integral
Definition: Endian.h:206
llvm::codeview::LineBlockFragmentHeader::BlockSize
support::ulittle32_t BlockSize
Definition: DebugLinesSubsection.h:45
llvm::codeview::DebugLinesSubsectionRef::initialize
Error initialize(BinaryStreamReader Reader)
Definition: DebugLinesSubsection.cpp:56
StringRef.h
llvm::BinaryStreamWriter
Provides write only access to a subclass of WritableBinaryStream.
Definition: BinaryStreamWriter.h:31
llvm::codeview::Line
Definition: Line.h:91
llvm::codeview::DebugLinesSubsection::classof
static bool classof(const DebugSubsection *S)
Definition: DebugLinesSubsection.h:119
Error.h
llvm::codeview::LineNumberEntry::Flags
support::ulittle32_t Flags
Definition: DebugLinesSubsection.h:55
llvm::codeview::DebugLinesSubsectionRef::DebugLinesSubsectionRef
DebugLinesSubsectionRef()
Definition: DebugLinesSubsection.cpp:53
llvm::codeview::LineFragmentHeader::RelocSegment
support::ulittle16_t RelocSegment
Definition: DebugLinesSubsection.h:33
llvm::codeview::DebugStringTableSubsection
Represents a read-write view of a CodeView string table.
Definition: DebugStringTableSubsection.h:56
llvm::codeview::ColumnNumberEntry
Definition: DebugLinesSubsection.h:59
Offset
uint64_t Offset
Definition: ELFObjHandler.cpp:81
llvm::VarStreamArray::end
Iterator end() const
Definition: BinaryStreamArray.h:115
llvm::codeview::DebugLinesSubsection::setFlags
void setFlags(LineFlags Flags)
Definition: DebugLinesSubsection.cpp:156
llvm::FixedStreamArray
FixedStreamArray is similar to VarStreamArray, except with each record having a fixed-length.
Definition: BinaryStreamArray.h:262
llvm::codeview::DebugLinesSubsection::hasColumnInfo
bool hasColumnInfo() const
Definition: DebugLinesSubsection.cpp:158
llvm::codeview::ColumnNumberEntry::StartColumn
support::ulittle16_t StartColumn
Definition: DebugLinesSubsection.h:60
llvm::codeview::DebugLinesSubsectionRef::end
Iterator end() const
Definition: DebugLinesSubsection.h:94
llvm::codeview::LineColumnEntry
Definition: DebugLinesSubsection.h:64
llvm::codeview::LineColumnExtractor::operator()
Error operator()(BinaryStreamRef Stream, uint32_t &Len, LineColumnEntry &Item)
Definition: DebugLinesSubsection.cpp:23
llvm::VarStreamArray< LineColumnEntry, LineColumnExtractor >
llvm::codeview::LineBlockFragmentHeader::NameIndex
support::ulittle32_t NameIndex
Definition: DebugLinesSubsection.h:40
llvm::codeview::LineColumnEntry::NameIndex
support::ulittle32_t NameIndex
Definition: DebugLinesSubsection.h:65
llvm::codeview::DebugSubsectionRef
Definition: DebugSubsection.h:19
llvm::VarStreamArray< LineColumnEntry, LineColumnExtractor >::Iterator
VarStreamArrayIterator< LineColumnEntry, LineColumnExtractor > Iterator
Definition: BinaryStreamArray.h:96
llvm::codeview::LineNumberEntry
Definition: DebugLinesSubsection.h:53
CodeView.h
llvm::BinaryStreamReader
Provides read only access to a subclass of BinaryStream.
Definition: BinaryStreamReader.h:31
Line.h
llvm::codeview::LineFragmentHeader
Definition: DebugLinesSubsection.h:31
DebugSubsection.h
llvm::codeview::DebugLinesSubsection::addLineInfo
void addLineInfo(uint32_t Offset, const LineInfo &Line)
Definition: DebugLinesSubsection.cpp:81
llvm::codeview::LineNumberEntry::Offset
support::ulittle32_t Offset
Definition: DebugLinesSubsection.h:54
llvm::codeview::DebugLinesSubsectionRef
Definition: DebugLinesSubsection.h:78
BinaryStreamArray.h
llvm::VarStreamArrayIterator
VarStreamArray represents an array of variable length records backed by a stream.
Definition: BinaryStreamArray.h:88
llvm::codeview::DebugLinesSubsection::addLineAndColumnInfo
void addLineAndColumnInfo(uint32_t Offset, const LineInfo &Line, uint32_t ColStart, uint32_t ColEnd)
Definition: DebugLinesSubsection.cpp:89
llvm::codeview::LineColumnExtractor::Header
const LineFragmentHeader * Header
Definition: DebugLinesSubsection.h:75
llvm::codeview::DebugLinesSubsection::setRelocationAddress
void setRelocationAddress(uint16_t Segment, uint32_t Offset)
Definition: DebugLinesSubsection.cpp:148
llvm::codeview::LineColumnExtractor
Definition: DebugLinesSubsection.h:70
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
BinaryStreamRef.h
llvm::codeview::LineColumnEntry::LineNumbers
FixedStreamArray< LineNumberEntry > LineNumbers
Definition: DebugLinesSubsection.h:66
llvm::codeview::DebugLinesSubsection
Definition: DebugLinesSubsection.h:105
uint32_t
S
add sub stmia L5 ldr r0 bl L_printf $stub Instead of a and a wouldn t it be better to do three moves *Return an aggregate type is even return S
Definition: README.txt:210
llvm::codeview::ColumnNumberEntry::EndColumn
support::ulittle16_t EndColumn
Definition: DebugLinesSubsection.h:61
llvm::VarStreamArray::begin
Iterator begin(bool *HadError=nullptr) const
Definition: BinaryStreamArray.h:108
llvm::codeview::LineInfo
Definition: Line.h:21
llvm::codeview::DebugSubsection
Definition: DebugSubsection.h:32
uint16_t
llvm::codeview::LineFragmentHeader::RelocOffset
support::ulittle32_t RelocOffset
Definition: DebugLinesSubsection.h:32
llvm::codeview::DebugLinesSubsectionRef::classof
static bool classof(const DebugSubsectionRef *S)
Definition: DebugLinesSubsection.h:87
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
llvm::codeview::DebugLinesSubsectionRef::hasColumnInfo
bool hasColumnInfo() const
Definition: DebugLinesSubsection.cpp:67
llvm::codeview::DebugLinesSubsectionRef::header
const LineFragmentHeader * header() const
Definition: DebugLinesSubsection.h:96
llvm::codeview::LineFragmentHeader::CodeSize
support::ulittle32_t CodeSize
Definition: DebugLinesSubsection.h:35
llvm::codeview::LineFragmentHeader::Flags
support::ulittle16_t Flags
Definition: DebugLinesSubsection.h:34
llvm::codeview::DebugLinesSubsection::calculateSerializedSize
uint32_t calculateSerializedSize() const override
Definition: DebugLinesSubsection.cpp:137
llvm::codeview::DebugLinesSubsectionRef::begin
Iterator begin() const
Definition: DebugLinesSubsection.h:93
llvm::codeview::DebugLinesSubsection::DebugLinesSubsection
DebugLinesSubsection(DebugChecksumsSubsection &Checksums, DebugStringTableSubsection &Strings)
Definition: DebugLinesSubsection.cpp:71
Endian.h
llvm::codeview::LineFlags
LineFlags
Definition: CodeView.h:566
llvm::codeview::DebugLinesSubsection::setCodeSize
void setCodeSize(uint32_t Size)
Definition: DebugLinesSubsection.cpp:154
llvm::codeview::LF_None
@ LF_None
Definition: CodeView.h:567
llvm::BinaryStreamRef
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array.
Definition: BinaryStreamRef.h:156