1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
//===-- StableFunctionMapRecord.cpp ---------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This implements the functionality for the StableFunctionMapRecord class,
// including methods for serialization and deserialization of stable function
// maps to and from raw and YAML streams. It also includes utilities for
// managing function entries and their metadata.
//
//===----------------------------------------------------------------------===//
#include "llvm/CGData/StableFunctionMapRecord.h"
#include "llvm/Support/EndianStream.h"
#define DEBUG_TYPE "stable-function-map-record"
using namespace llvm;
using namespace llvm::support;
LLVM_YAML_IS_SEQUENCE_VECTOR(IndexPairHash)
LLVM_YAML_IS_SEQUENCE_VECTOR(StableFunction)
namespace llvm {
namespace yaml {
template <> struct MappingTraits<IndexPairHash> {
static void mapping(IO &IO, IndexPairHash &Key) {
IO.mapRequired("InstIndex", Key.first.first);
IO.mapRequired("OpndIndex", Key.first.second);
IO.mapRequired("OpndHash", Key.second);
}
};
template <> struct MappingTraits<StableFunction> {
static void mapping(IO &IO, StableFunction &Func) {
IO.mapRequired("Hash", Func.Hash);
IO.mapRequired("FunctionName", Func.FunctionName);
IO.mapRequired("ModuleName", Func.ModuleName);
IO.mapRequired("InstCount", Func.InstCount);
IO.mapRequired("IndexOperandHashes", Func.IndexOperandHashes);
}
};
} // namespace yaml
} // namespace llvm
// Get a sorted vector of StableFunctionEntry pointers.
static SmallVector<const StableFunctionMap::StableFunctionEntry *>
getStableFunctionEntries(const StableFunctionMap &SFM) {
SmallVector<const StableFunctionMap::StableFunctionEntry *> FuncEntries;
for (const auto &P : SFM.getFunctionMap())
for (auto &Func : P.second)
FuncEntries.emplace_back(Func.get());
llvm::stable_sort(
FuncEntries, [&](auto &A, auto &B) {
return std::tuple(A->Hash, SFM.getNameForId(A->ModuleNameId),
SFM.getNameForId(A->FunctionNameId)) <
std::tuple(B->Hash, SFM.getNameForId(B->ModuleNameId),
SFM.getNameForId(B->FunctionNameId));
});
return FuncEntries;
}
// Get a sorted vector of IndexOperandHashes.
static IndexOperandHashVecType getStableIndexOperandHashes(
const StableFunctionMap::StableFunctionEntry *FuncEntry) {
IndexOperandHashVecType IndexOperandHashes;
for (auto &[Indices, OpndHash] : *FuncEntry->IndexOperandHashMap)
IndexOperandHashes.emplace_back(Indices, OpndHash);
// The indices are unique, so we can just sort by the first.
llvm::sort(IndexOperandHashes);
return IndexOperandHashes;
}
void StableFunctionMapRecord::serialize(
raw_ostream &OS, std::vector<CGDataPatchItem> &PatchItems) const {
serialize(OS, FunctionMap.get(), PatchItems);
}
void StableFunctionMapRecord::serialize(
raw_ostream &OS, const StableFunctionMap *FunctionMap,
std::vector<CGDataPatchItem> &PatchItems) {
support::endian::Writer Writer(OS, endianness::little);
// Write Names.
ArrayRef<std::string> Names = FunctionMap->getNames();
Writer.write<uint32_t>(Names.size());
// Remember the position, write back the total size of Names, so we can skip
// reading them if needed.
const uint64_t NamesByteSizeOffset = Writer.OS.tell();
Writer.write<uint64_t>(0);
for (auto &Name : Names)
Writer.OS << Name << '\0';
// Align current position to 4 bytes.
uint32_t Padding = offsetToAlignment(Writer.OS.tell(), Align(4));
for (uint32_t I = 0; I < Padding; ++I)
Writer.OS << '\0';
const auto NamesByteSize =
Writer.OS.tell() - NamesByteSizeOffset - sizeof(NamesByteSizeOffset);
PatchItems.emplace_back(NamesByteSizeOffset, &NamesByteSize, 1);
// Write StableFunctionEntries whose pointers are sorted.
auto FuncEntries = getStableFunctionEntries(*FunctionMap);
Writer.write<uint32_t>(FuncEntries.size());
for (const auto *FuncRef : FuncEntries) {
Writer.write<stable_hash>(FuncRef->Hash);
Writer.write<uint32_t>(FuncRef->FunctionNameId);
Writer.write<uint32_t>(FuncRef->ModuleNameId);
Writer.write<uint32_t>(FuncRef->InstCount);
// Emit IndexOperandHashes sorted from IndexOperandHashMap.
IndexOperandHashVecType IndexOperandHashes =
getStableIndexOperandHashes(FuncRef);
Writer.write<uint32_t>(IndexOperandHashes.size());
for (auto &IndexOperandHash : IndexOperandHashes) {
Writer.write<uint32_t>(IndexOperandHash.first.first);
Writer.write<uint32_t>(IndexOperandHash.first.second);
Writer.write<stable_hash>(IndexOperandHash.second);
}
}
}
void StableFunctionMapRecord::deserialize(const unsigned char *&Ptr,
bool ReadStableFunctionMapNames) {
// Assert that Ptr is 4-byte aligned
assert(((uintptr_t)Ptr % 4) == 0);
// Read Names.
auto NumNames =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
// Early exit if there is no name.
if (NumNames == 0)
return;
const auto NamesByteSize =
endian::readNext<uint64_t, endianness::little, unaligned>(Ptr);
const auto NamesOffset = reinterpret_cast<uintptr_t>(Ptr);
if (ReadStableFunctionMapNames) {
for (unsigned I = 0; I < NumNames; ++I) {
StringRef Name(reinterpret_cast<const char *>(Ptr));
Ptr += Name.size() + 1;
FunctionMap->getIdOrCreateForName(Name);
}
// Align Ptr to 4 bytes.
Ptr = reinterpret_cast<const uint8_t *>(alignAddr(Ptr, Align(4)));
assert(reinterpret_cast<uintptr_t>(Ptr) - NamesOffset == NamesByteSize &&
"NamesByteSize does not match the actual size of names");
} else {
// skip reading Names by advancing the pointer.
Ptr = reinterpret_cast<const uint8_t *>(NamesOffset + NamesByteSize);
}
// Read StableFunctionEntries.
auto NumFuncs =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
for (unsigned I = 0; I < NumFuncs; ++I) {
auto Hash =
endian::readNext<stable_hash, endianness::little, unaligned>(Ptr);
auto FunctionNameId =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
assert(FunctionMap->getNameForId(FunctionNameId) &&
"FunctionNameId out of range");
auto ModuleNameId =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
assert(FunctionMap->getNameForId(ModuleNameId) &&
"ModuleNameId out of range");
auto InstCount =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
// Read IndexOperandHashes to build IndexOperandHashMap
auto NumIndexOperandHashes =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
auto IndexOperandHashMap = std::make_unique<IndexOperandHashMapType>();
for (unsigned J = 0; J < NumIndexOperandHashes; ++J) {
auto InstIndex =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
auto OpndIndex =
endian::readNext<uint32_t, endianness::little, unaligned>(Ptr);
auto OpndHash =
endian::readNext<stable_hash, endianness::little, unaligned>(Ptr);
assert(InstIndex < InstCount && "InstIndex out of range");
IndexOperandHashMap->try_emplace({InstIndex, OpndIndex}, OpndHash);
}
// Insert a new StableFunctionEntry into the map.
auto FuncEntry = std::make_unique<StableFunctionMap::StableFunctionEntry>(
Hash, FunctionNameId, ModuleNameId, InstCount,
std::move(IndexOperandHashMap));
FunctionMap->insert(std::move(FuncEntry));
}
}
void StableFunctionMapRecord::serializeYAML(yaml::Output &YOS) const {
auto FuncEntries = getStableFunctionEntries(*FunctionMap);
SmallVector<StableFunction> Functions;
for (const auto *FuncEntry : FuncEntries) {
auto IndexOperandHashes = getStableIndexOperandHashes(FuncEntry);
Functions.emplace_back(
FuncEntry->Hash, *FunctionMap->getNameForId(FuncEntry->FunctionNameId),
*FunctionMap->getNameForId(FuncEntry->ModuleNameId),
FuncEntry->InstCount, std::move(IndexOperandHashes));
}
YOS << Functions;
}
void StableFunctionMapRecord::deserializeYAML(yaml::Input &YIS) {
std::vector<StableFunction> Funcs;
YIS >> Funcs;
for (auto &Func : Funcs)
FunctionMap->insert(Func);
YIS.nextDocument();
}
|
