LLVM 17.0.0git
DebugStringTableSubsection.h
Go to the documentation of this file.
1//===- DebugStringTableSubsection.h - CodeView String Table -----*- 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_DEBUGSTRINGTABLESUBSECTION_H
10#define LLVM_DEBUGINFO_CODEVIEW_DEBUGSTRINGTABLESUBSECTION_H
11
12#include "llvm/ADT/DenseMap.h"
13#include "llvm/ADT/StringMap.h"
14#include "llvm/ADT/StringRef.h"
18#include "llvm/Support/Error.h"
19#include <cstdint>
20
21namespace llvm {
22
23class BinaryStreamReader;
24
25namespace codeview {
26
27/// Represents a read-only view of a CodeView string table. This is a very
28/// simple flat buffer consisting of null-terminated strings, where strings
29/// are retrieved by their offset in the buffer. DebugStringTableSubsectionRef
30/// does not own the underlying storage for the buffer.
32public:
34
35 static bool classof(const DebugSubsectionRef *S) {
37 }
38
41
43
44 bool valid() const { return Stream.valid(); }
45
46 BinaryStreamRef getBuffer() const { return Stream; }
47
48private:
49 BinaryStreamRef Stream;
50};
51
52/// Represents a read-write view of a CodeView string table.
53/// DebugStringTableSubsection owns the underlying storage for the table, and is
54/// capable of serializing the string table into a format understood by
55/// DebugStringTableSubsectionRef.
57public:
59
60 static bool classof(const DebugSubsection *S) {
62 }
63
64 // If string S does not exist in the string table, insert it.
65 // Returns the ID for S.
67
68 // Return the ID for string S. Assumes S exists in the table.
70
72
73 uint32_t calculateSerializedSize() const override;
74 Error commit(BinaryStreamWriter &Writer) const override;
75
76 uint32_t size() const;
77
79 return StringToId.begin();
80 }
81
82 StringMap<uint32_t>::const_iterator end() const { return StringToId.end(); }
83
84 std::vector<uint32_t> sortedIds() const;
85
86private:
88 StringMap<uint32_t> StringToId;
89 uint32_t StringSize = 1;
90};
91
92} // end namespace codeview
93
94} // end namespace llvm
95
96#endif // LLVM_DEBUGINFO_CODEVIEW_DEBUGSTRINGTABLESUBSECTION_H
This file defines the StringMap class.
This file defines the DenseMap class.
Provides read only access to a subclass of BinaryStream.
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
Tagged union holding either a T or a Error.
Definition: Error.h:470
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition: StringMap.h:111
iterator end()
Definition: StringMap.h:204
iterator begin()
Definition: StringMap.h:203
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Represents a read-only view of a CodeView string table.
static bool classof(const DebugSubsectionRef *S)
Expected< StringRef > getString(uint32_t Offset) const
Represents a read-write view of a CodeView string table.
StringMap< uint32_t >::const_iterator begin() const
StringMap< uint32_t >::const_iterator end() const
static bool classof(const DebugSubsection *S)
Error commit(BinaryStreamWriter &Writer) const override
DebugSubsectionKind kind() const
DebugSubsectionKind kind() const
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:406