LLVM 19.0.0git
NamedStreamMap.cpp
Go to the documentation of this file.
1//===- NamedStreamMap.cpp - PDB Named Stream Map --------------------------===//
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
10#include "llvm/ADT/StringMap.h"
11#include "llvm/ADT/StringRef.h"
17#include "llvm/Support/Endian.h"
18#include "llvm/Support/Error.h"
19#include <algorithm>
20#include <cassert>
21#include <cstdint>
22
23using namespace llvm;
24using namespace llvm::pdb;
25
27
29 // In the reference implementation, this uses
30 // HASH Hasher<ULONG*, USHORT*>::hashPbCb(PB pb, size_t cb, ULONG ulMod).
31 // Here, the type HASH is a typedef of unsigned short.
32 // ** It is not a bug that we truncate the result of hashStringV1, in fact
33 // it is a bug if we do not! **
34 // See NMTNI::hash() in the reference implementation.
35 return static_cast<uint16_t>(hashStringV1(S));
36}
37
39 return NS->getString(Offset);
40}
41
43 return NS->appendStringData(S);
44}
45
46NamedStreamMap::NamedStreamMap() : HashTraits(*this), OffsetIndexMap(1) {}
47
49 uint32_t StringBufferSize;
50 if (auto EC = Stream.readInteger(StringBufferSize))
51 return joinErrors(std::move(EC),
52 make_error<RawError>(raw_error_code::corrupt_file,
53 "Expected string buffer size"));
54
55 StringRef Buffer;
56 if (auto EC = Stream.readFixedString(Buffer, StringBufferSize))
57 return EC;
58 NamesBuffer.assign(Buffer.begin(), Buffer.end());
59
60 return OffsetIndexMap.load(Stream);
61}
62
64 // The first field is the number of bytes of string data.
65 if (auto EC = Writer.writeInteger<uint32_t>(NamesBuffer.size()))
66 return EC;
67
68 // Then the actual string data.
69 StringRef Data(NamesBuffer.data(), NamesBuffer.size());
70 if (auto EC = Writer.writeFixedString(Data))
71 return EC;
72
73 // And finally the Offset Index map.
74 if (auto EC = OffsetIndexMap.commit(Writer))
75 return EC;
76
77 return Error::success();
78}
79
81 return sizeof(uint32_t) // String data size
82 + NamesBuffer.size() // String data
83 + OffsetIndexMap.calculateSerializedLength(); // Offset Index Map
84}
85
86uint32_t NamedStreamMap::size() const { return OffsetIndexMap.size(); }
87
89 assert(NamesBuffer.size() > Offset);
90 return StringRef(NamesBuffer.data() + Offset);
91}
92
95}
96
97bool NamedStreamMap::get(StringRef Stream, uint32_t &StreamNo) const {
98 auto Iter = OffsetIndexMap.find_as(Stream, HashTraits);
99 if (Iter == OffsetIndexMap.end())
100 return false;
101 StreamNo = (*Iter).second;
102 return true;
103}
104
106 StringMap<uint32_t> Result;
107 for (const auto &Entry : OffsetIndexMap) {
108 StringRef Stream(NamesBuffer.data() + Entry.first);
109 Result.try_emplace(Stream, Entry.second);
110 }
111 return Result;
112}
113
115 uint32_t Offset = NamesBuffer.size();
116 llvm::append_range(NamesBuffer, S);
117 NamesBuffer.push_back('\0');
118 return Offset;
119}
120
121void NamedStreamMap::set(StringRef Stream, uint32_t StreamNo) {
122 OffsetIndexMap.set_as(Stream, support::ulittle32_t(StreamNo), HashTraits);
123}
This file defines the StringMap class.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
Provides read only access to a subclass of BinaryStream.
Error readInteger(T &Dest)
Read an integer of the specified endianness into Dest and update the stream's offset.
Error readFixedString(StringRef &Dest, uint32_t Length)
Read a Length byte string into Dest.
Provides write only access to a subclass of WritableBinaryStream.
Error writeInteger(T Value)
Write the integer Value to the underlying stream in the specified endianness.
Error writeFixedString(StringRef Str)
Write the string Str to the underlying stream without a null terminator.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
static ErrorSuccess success()
Create a success value.
Definition: Error.h:334
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition: StringMap.h:128
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
iterator begin() const
Definition: StringRef.h:111
iterator end() const
Definition: StringRef.h:113
void set(StringRef Stream, uint32_t StreamNo)
Error load(BinaryStreamReader &Stream)
StringMap< uint32_t > entries() const
Error commit(BinaryStreamWriter &Writer) const
uint32_t hashString(uint32_t Offset) const
uint32_t appendStringData(StringRef S)
bool get(StringRef Stream, uint32_t &StreamNo) const
StringRef getString(uint32_t Offset) const
uint32_t calculateSerializedLength() const
uint32_t hashStringV1(StringRef Str)
Definition: Hash.cpp:20
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition: STLExtras.h:2067
Error joinErrors(Error E1, Error E2)
Concatenate errors.
Definition: Error.h:431
NamedStreamMapTraits(NamedStreamMap &NS)
uint16_t hashLookupKey(StringRef S) const
uint32_t lookupKeyToStorageKey(StringRef S)
StringRef storageKeyToLookupKey(uint32_t Offset) const