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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
/*
* Copyright (C) 2020-2022 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/source/compiler_interface/linker.h"
#include "shared/source/device_binary_format/patchtokens_decoder.h"
#include "shared/source/program/kernel_info.h"
#include "shared/source/program/program_info.h"
#include "shared/source/program/program_info_from_patchtokens.h"
#include "shared/test/common/compiler_interface/linker_mock.h"
#include "shared/test/common/device_binary_format/patchtokens_tests.h"
#include "RelocationInfo.h"
#include "gtest/gtest.h"
TEST(PopulateProgramInfoFromPatchtokensTests, WhenRequiresLocalMemoryWindowVAIsCalledThenReturnsTrueOnlyIfAnyOfKernelsRequireLocalMemoryWindowVA) {
NEO::PatchTokenBinary::ProgramFromPatchtokens emptyProgram;
EXPECT_FALSE(NEO::requiresLocalMemoryWindowVA(emptyProgram));
NEO::PatchTokenBinary::KernelFromPatchtokens kernelWithoutRequirementForLocalMemoryWindowWA;
NEO::PatchTokenBinary::KernelFromPatchtokens kernelWithRequirementForLocalMemoryWindowWA;
iOpenCL::SPatchDataParameterBuffer param;
kernelWithRequirementForLocalMemoryWindowWA.tokens.crossThreadPayloadArgs.localMemoryStatelessWindowStartAddress = ¶m;
NEO::PatchTokenBinary::ProgramFromPatchtokens programWithOneKernelWithoutLocalMemWindow;
programWithOneKernelWithoutLocalMemWindow.kernels.push_back(kernelWithoutRequirementForLocalMemoryWindowWA);
EXPECT_FALSE(NEO::requiresLocalMemoryWindowVA(programWithOneKernelWithoutLocalMemWindow));
NEO::PatchTokenBinary::ProgramFromPatchtokens programWithOneKernelWithLocalMemWindow;
programWithOneKernelWithLocalMemWindow.kernels.push_back(kernelWithRequirementForLocalMemoryWindowWA);
EXPECT_TRUE(NEO::requiresLocalMemoryWindowVA(programWithOneKernelWithLocalMemWindow));
NEO::PatchTokenBinary::ProgramFromPatchtokens programWithTwoKernelsWithLocalMemWindow;
programWithTwoKernelsWithLocalMemWindow.kernels.push_back(kernelWithoutRequirementForLocalMemoryWindowWA);
programWithTwoKernelsWithLocalMemWindow.kernels.push_back(kernelWithRequirementForLocalMemoryWindowWA);
EXPECT_TRUE(NEO::requiresLocalMemoryWindowVA(programWithTwoKernelsWithLocalMemWindow));
std::swap(programWithTwoKernelsWithLocalMemWindow.kernels[0], programWithTwoKernelsWithLocalMemWindow.kernels[1]);
EXPECT_TRUE(NEO::requiresLocalMemoryWindowVA(programWithTwoKernelsWithLocalMemWindow));
}
TEST(PopulateProgramInfoFromPatchtokensTests, WhenProgramRequiresGlobalConstantsSurfaceThenGlobalConstantsSectionIsPopulated) {
PatchTokensTestData::ValidProgramWithConstantSurface programTokens;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programTokens);
EXPECT_EQ(programInfo.globalConstants.size, programTokens.programScopeTokens.allocateConstantMemorySurface[0]->InlineDataSize);
EXPECT_EQ(programInfo.globalConstants.initData, NEO::PatchTokenBinary::getInlineData(programTokens.programScopeTokens.allocateConstantMemorySurface[0]));
EXPECT_TRUE(programInfo.kernelInfos.empty());
EXPECT_EQ(nullptr, programInfo.linkerInput);
}
TEST(PopulateProgramInfoFromPatchtokensTests, WhenProgramRequiresGlobalVariablesSurfaceThenGlobalConstantsSectionIsPopulated) {
PatchTokensTestData::ValidProgramWithGlobalSurface programTokens;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programTokens);
EXPECT_EQ(programInfo.globalVariables.size, programTokens.programScopeTokens.allocateGlobalMemorySurface[0]->InlineDataSize);
EXPECT_EQ(programInfo.globalVariables.initData, NEO::PatchTokenBinary::getInlineData(programTokens.programScopeTokens.allocateGlobalMemorySurface[0]));
EXPECT_TRUE(programInfo.kernelInfos.empty());
EXPECT_EQ(nullptr, programInfo.linkerInput);
}
TEST(PopulateProgramInfoFromPatchtokensTests, WhenProgramRequiresGlobalConstantsPointersThenLinkerInputContainsProperRelocations) {
PatchTokensTestData::ValidProgramWithConstantSurfaceAndPointer programFromTokens;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programFromTokens);
EXPECT_TRUE(programInfo.kernelInfos.empty());
ASSERT_NE(nullptr, programInfo.linkerInput);
ASSERT_EQ(1U, programInfo.linkerInput->getDataRelocations().size());
auto relocation = programInfo.linkerInput->getDataRelocations()[0];
EXPECT_EQ(programFromTokens.programScopeTokens.constantPointer[0]->ConstantPointerOffset, relocation.offset);
EXPECT_EQ(NEO::SegmentType::GlobalConstants, relocation.relocationSegment);
auto symbol = programInfo.linkerInput->getSymbols().find(relocation.symbolName);
EXPECT_TRUE(symbol != programInfo.linkerInput->getSymbols().end());
EXPECT_EQ(NEO::SegmentType::GlobalConstants, symbol->second.segment);
EXPECT_EQ(NEO::LinkerInput::RelocationInfo::Type::Address, relocation.type);
}
TEST(PopulateProgramInfoFromPatchtokensTests, WhenProgramRequiresGlobalVariablesPointersThenLinkerInputContainsProperRelocations) {
PatchTokensTestData::ValidProgramWithGlobalSurfaceAndPointer programFromTokens;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programFromTokens);
EXPECT_TRUE(programInfo.kernelInfos.empty());
ASSERT_NE(nullptr, programInfo.linkerInput);
ASSERT_EQ(1U, programInfo.linkerInput->getDataRelocations().size());
auto relocation = programInfo.linkerInput->getDataRelocations()[0];
EXPECT_EQ(NEO::readMisalignedUint64(&programFromTokens.programScopeTokens.globalPointer[0]->GlobalPointerOffset), relocation.offset);
EXPECT_EQ(NEO::SegmentType::GlobalVariables, relocation.relocationSegment);
auto symbol = programInfo.linkerInput->getSymbols().find(relocation.symbolName);
EXPECT_TRUE(symbol != programInfo.linkerInput->getSymbols().end());
EXPECT_EQ(NEO::SegmentType::GlobalVariables, symbol->second.segment);
EXPECT_EQ(NEO::LinkerInput::RelocationInfo::Type::Address, relocation.type);
}
TEST(PopulateProgramInfoFromPatchtokensTests, WhenProgramRequiresMixedGlobalVarAndConstPointersThenLinkerInputContainsProperRelocations) {
PatchTokensTestData::ValidProgramWithMixedGlobalVarAndConstSurfacesAndPointers programFromTokens;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programFromTokens);
EXPECT_TRUE(programInfo.kernelInfos.empty());
ASSERT_NE(nullptr, programInfo.linkerInput);
const NEO::LinkerInput::RelocationInfo *relocationGlobalConst, *relocationGlobalVar;
ASSERT_EQ(2U, programInfo.linkerInput->getDataRelocations().size());
for (const auto &reloc : programInfo.linkerInput->getDataRelocations()) {
switch (reloc.relocationSegment) {
default:
break;
case NEO::SegmentType::GlobalConstants:
relocationGlobalConst = &reloc;
break;
case NEO::SegmentType::GlobalVariables:
relocationGlobalVar = &reloc;
break;
}
}
ASSERT_NE(nullptr, relocationGlobalConst);
EXPECT_EQ(NEO::readMisalignedUint64(&programFromTokens.programScopeTokens.constantPointer[0]->ConstantPointerOffset), relocationGlobalConst->offset);
EXPECT_FALSE(relocationGlobalConst->symbolName.empty());
EXPECT_EQ(NEO::SegmentType::GlobalConstants, relocationGlobalConst->relocationSegment);
auto symbol1 = programInfo.linkerInput->getSymbols().find(relocationGlobalConst->symbolName);
EXPECT_TRUE(symbol1 != programInfo.linkerInput->getSymbols().end());
EXPECT_EQ(NEO::SegmentType::GlobalVariables, symbol1->second.segment);
ASSERT_NE(nullptr, relocationGlobalVar);
EXPECT_EQ(NEO::readMisalignedUint64(&programFromTokens.programScopeTokens.globalPointer[0]->GlobalPointerOffset), relocationGlobalVar->offset);
EXPECT_FALSE(relocationGlobalVar->symbolName.empty());
EXPECT_EQ(NEO::SegmentType::GlobalVariables, relocationGlobalVar->relocationSegment);
auto symbol2 = programInfo.linkerInput->getSymbols().find(relocationGlobalVar->symbolName);
EXPECT_TRUE(symbol2 != programInfo.linkerInput->getSymbols().end());
EXPECT_EQ(NEO::SegmentType::GlobalConstants, symbol2->second.segment);
EXPECT_EQ(NEO::LinkerInput::RelocationInfo::Type::Address, relocationGlobalVar->type);
}
TEST(PopulateProgramInfoFromPatchtokensTests, GivenProgramWithSpecificPointerSizeThenLinkerIsUpdatedToUseRequiredPointerSize) {
PatchTokensTestData::ValidProgramWithMixedGlobalVarAndConstSurfacesAndPointers programFromTokens;
{
programFromTokens.headerMutable->GPUPointerSizeInBytes = 8;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_NE(nullptr, programInfo.linkerInput);
EXPECT_EQ(NEO::LinkerInput::Traits::Ptr64bit, programInfo.linkerInput->getTraits().pointerSize);
}
{
programFromTokens.headerMutable->GPUPointerSizeInBytes = 4;
NEO::ProgramInfo programInfo;
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_NE(nullptr, programInfo.linkerInput);
EXPECT_EQ(NEO::LinkerInput::Traits::Ptr32bit, programInfo.linkerInput->getTraits().pointerSize);
}
}
TEST(PopulateProgramInfoFromPatchtokensTests, GivenProgramWithProgramSymbolTableThenLinkerDecodesAllSymbolsCorrectly) {
PatchTokensTestData::ValidEmptyProgram programFromTokens;
NEO::ProgramInfo programInfo = {};
Mock<NEO::LinkerInput> *mockLinkerInput = new Mock<NEO::LinkerInput>;
programInfo.linkerInput.reset(mockLinkerInput);
vISA::GenSymEntry entry[1] = {};
iOpenCL::SPatchFunctionTableInfo symbolTable = {};
symbolTable.NumEntries = 1;
std::vector<uint8_t> symbolTableTokenStorage = {};
symbolTableTokenStorage.insert(symbolTableTokenStorage.end(),
reinterpret_cast<uint8_t *>(&symbolTable), reinterpret_cast<uint8_t *>(&symbolTable + 1));
symbolTableTokenStorage.insert(symbolTableTokenStorage.end(),
reinterpret_cast<uint8_t *>(entry), reinterpret_cast<uint8_t *>(entry + 1));
programFromTokens.programScopeTokens.symbolTable = reinterpret_cast<iOpenCL::SPatchFunctionTableInfo *>(symbolTableTokenStorage.data());
const void *receivedData = nullptr;
uint32_t receivedNumEntries = 0U;
mockLinkerInput->decodeGlobalVariablesSymbolTableMockConfig.overrideFunc = [&](Mock<NEO::LinkerInput> *, const void *data, uint32_t numEntries) -> bool {
receivedData = data;
receivedNumEntries = numEntries;
return true;
};
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_EQ(mockLinkerInput, programInfo.linkerInput.get());
EXPECT_EQ(1U, mockLinkerInput->decodeGlobalVariablesSymbolTableMockConfig.timesCalled);
EXPECT_EQ(reinterpret_cast<void *>(symbolTableTokenStorage.data() + sizeof(iOpenCL::SPatchFunctionTableInfo)), receivedData);
EXPECT_EQ(1U, receivedNumEntries);
}
TEST(PopulateProgramInfoFromPatchtokensTests, GivenProgramWithKernelsThenKernelInfosIsProperlyPopulated) {
PatchTokensTestData::ValidProgramWithKernel programFromTokens;
programFromTokens.kernels.push_back(programFromTokens.kernels[0]);
programFromTokens.kernels.push_back(programFromTokens.kernels[0]);
NEO::ProgramInfo programInfo = {};
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_EQ(3U, programInfo.kernelInfos.size());
EXPECT_EQ(programFromTokens.header->GPUPointerSizeInBytes, programInfo.kernelInfos[0]->kernelDescriptor.kernelAttributes.gpuPointerSize);
EXPECT_EQ(programFromTokens.header->GPUPointerSizeInBytes, programInfo.kernelInfos[1]->kernelDescriptor.kernelAttributes.gpuPointerSize);
EXPECT_EQ(programFromTokens.header->GPUPointerSizeInBytes, programInfo.kernelInfos[2]->kernelDescriptor.kernelAttributes.gpuPointerSize);
}
TEST(PopulateProgramInfoFromPatchtokensTests, GivenProgramWithKernelsWhenKernelHasSymbolTableThenLinkerIsUpdatedWithAdditionalSymbolInfo) {
NEO::ProgramInfo programInfo = {};
Mock<NEO::LinkerInput> *mockLinkerInput = new Mock<NEO::LinkerInput>;
programInfo.linkerInput.reset(mockLinkerInput);
PatchTokensTestData::ValidProgramWithKernel programFromTokens;
programFromTokens.kernels.push_back(programFromTokens.kernels[0]);
vISA::GenSymEntry entryA[1] = {};
iOpenCL::SPatchFunctionTableInfo symbolTableA = {};
symbolTableA.NumEntries = 1;
std::vector<uint8_t> symbolTableATokenStorage = {};
symbolTableATokenStorage.insert(symbolTableATokenStorage.end(),
reinterpret_cast<uint8_t *>(&symbolTableA), reinterpret_cast<uint8_t *>(&symbolTableA + 1));
symbolTableATokenStorage.insert(symbolTableATokenStorage.end(),
reinterpret_cast<uint8_t *>(entryA), reinterpret_cast<uint8_t *>(entryA + 1));
programFromTokens.kernels[0].tokens.programSymbolTable = reinterpret_cast<iOpenCL::SPatchFunctionTableInfo *>(symbolTableATokenStorage.data());
vISA::GenSymEntry entryB[2] = {};
iOpenCL::SPatchFunctionTableInfo symbolTableB = {};
symbolTableB.NumEntries = 2;
std::vector<uint8_t> symbolTableBTokenStorage = {};
symbolTableBTokenStorage.insert(symbolTableBTokenStorage.end(),
reinterpret_cast<uint8_t *>(&symbolTableB), reinterpret_cast<uint8_t *>(&symbolTableB + 1));
symbolTableBTokenStorage.insert(symbolTableBTokenStorage.end(),
reinterpret_cast<uint8_t *>(entryB), reinterpret_cast<uint8_t *>(entryB + 2));
programFromTokens.kernels[1].tokens.programSymbolTable = reinterpret_cast<iOpenCL::SPatchFunctionTableInfo *>(symbolTableBTokenStorage.data());
std::vector<const void *> receivedData;
std::vector<uint32_t> receivedNumEntries;
std::vector<uint32_t> receivedSegmentIds;
mockLinkerInput->decodeExportedFunctionsSymbolTableMockConfig.overrideFunc = [&](Mock<NEO::LinkerInput> *, const void *data, uint32_t numEntries, uint32_t instructionsSegmentId) -> bool {
receivedData.push_back(data);
receivedNumEntries.push_back(numEntries);
receivedSegmentIds.push_back(instructionsSegmentId);
return true;
};
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_EQ(2U, mockLinkerInput->decodeExportedFunctionsSymbolTableMockConfig.timesCalled);
ASSERT_EQ(2U, receivedData.size());
EXPECT_EQ(1U, receivedNumEntries[0]);
EXPECT_EQ(2U, receivedNumEntries[1]);
EXPECT_EQ(reinterpret_cast<void *>(symbolTableATokenStorage.data() + sizeof(iOpenCL::SPatchFunctionTableInfo)), receivedData[0]);
EXPECT_EQ(reinterpret_cast<void *>(symbolTableBTokenStorage.data() + sizeof(iOpenCL::SPatchFunctionTableInfo)), receivedData[1]);
EXPECT_EQ(0U, receivedSegmentIds[0]);
EXPECT_EQ(1U, receivedSegmentIds[1]);
}
TEST(PopulateProgramInfoFromPatchtokensTests, GivenProgramWithKernelsWhenKernelHasRelocationTableThenLinkerIsUpdatedWithAdditionalRelocationInfo) {
NEO::ProgramInfo programInfo = {};
Mock<NEO::LinkerInput> *mockLinkerInput = new Mock<NEO::LinkerInput>;
programInfo.linkerInput.reset(mockLinkerInput);
PatchTokensTestData::ValidProgramWithKernel programFromTokens;
programFromTokens.kernels.push_back(programFromTokens.kernels[0]);
vISA::GenRelocEntry entryA[1] = {};
iOpenCL::SPatchFunctionTableInfo relocationTableA = {};
relocationTableA.NumEntries = 1;
std::vector<uint8_t> relocationTableATokenStorage = {};
relocationTableATokenStorage.insert(relocationTableATokenStorage.end(),
reinterpret_cast<uint8_t *>(&relocationTableA), reinterpret_cast<uint8_t *>(&relocationTableA + 1));
relocationTableATokenStorage.insert(relocationTableATokenStorage.end(),
reinterpret_cast<uint8_t *>(entryA), reinterpret_cast<uint8_t *>(entryA + 1));
programFromTokens.kernels[0].tokens.programRelocationTable = reinterpret_cast<iOpenCL::SPatchFunctionTableInfo *>(relocationTableATokenStorage.data());
vISA::GenRelocEntry entryB[2] = {};
iOpenCL::SPatchFunctionTableInfo relocationTableB = {};
relocationTableB.NumEntries = 2;
std::vector<uint8_t> relocationTableBTokenStorage = {};
relocationTableBTokenStorage.insert(relocationTableBTokenStorage.end(),
reinterpret_cast<uint8_t *>(&relocationTableB), reinterpret_cast<uint8_t *>(&relocationTableB + 1));
relocationTableBTokenStorage.insert(relocationTableBTokenStorage.end(),
reinterpret_cast<uint8_t *>(entryB), reinterpret_cast<uint8_t *>(entryB + 2));
programFromTokens.kernels[1].tokens.programRelocationTable = reinterpret_cast<iOpenCL::SPatchFunctionTableInfo *>(relocationTableBTokenStorage.data());
std::vector<const void *> receivedData;
std::vector<uint32_t> receivedNumEntries;
std::vector<uint32_t> receivedSegmentIds;
mockLinkerInput->decodeRelocationTableMockConfig.overrideFunc = [&](Mock<NEO::LinkerInput> *, const void *data, uint32_t numEntries, uint32_t instructionsSegmentId) -> bool {
receivedData.push_back(data);
receivedNumEntries.push_back(numEntries);
receivedSegmentIds.push_back(instructionsSegmentId);
return true;
};
NEO::populateProgramInfo(programInfo, programFromTokens);
ASSERT_EQ(2U, mockLinkerInput->decodeRelocationTableMockConfig.timesCalled);
ASSERT_EQ(2U, receivedData.size());
EXPECT_EQ(1U, receivedNumEntries[0]);
EXPECT_EQ(2U, receivedNumEntries[1]);
EXPECT_EQ(reinterpret_cast<void *>(relocationTableATokenStorage.data() + sizeof(iOpenCL::SPatchFunctionTableInfo)), receivedData[0]);
EXPECT_EQ(reinterpret_cast<void *>(relocationTableBTokenStorage.data() + sizeof(iOpenCL::SPatchFunctionTableInfo)), receivedData[1]);
EXPECT_EQ(0U, receivedSegmentIds[0]);
EXPECT_EQ(1U, receivedSegmentIds[1]);
}
TEST(PopulateProgramInfoFromPatchtokensTests, givenProgramWithKernelWhenKernelHasHostAccessTableThenPopulateDeviceHostNameMapCorrectly) {
PatchTokensTestData::ValidProgramWithKernelUsingHostAccessTable programToEncode;
programToEncode.headerMutable->NumberOfKernels = 1;
std::vector<uint8_t> copiedKernelInfo(programToEncode.kernels[0].blobs.kernelInfo.begin(), programToEncode.kernels[0].blobs.kernelInfo.end());
programToEncode.storage.insert(programToEncode.storage.end(), copiedKernelInfo.begin(), copiedKernelInfo.end());
NEO::PatchTokenBinary::ProgramFromPatchtokens decodedProgram;
bool decodeSuccess = NEO::PatchTokenBinary::decodeProgramFromPatchtokensBlob(programToEncode.storage, decodedProgram);
EXPECT_TRUE(decodeSuccess);
NEO::ProgramInfo programInfo = {};
NEO::populateProgramInfo(programInfo, decodedProgram);
EXPECT_EQ(2u, programInfo.globalsDeviceToHostNameMap.size());
EXPECT_STREQ("hostNameOne", programInfo.globalsDeviceToHostNameMap["deviceNameOne"].c_str());
EXPECT_STREQ("hostNameTwo", programInfo.globalsDeviceToHostNameMap["deviceNameTwo"].c_str());
}
|
