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
|
/*
* Copyright (C) 2021-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/source/device_binary_format/zebin/debug_zebin.h"
#include "shared/source/device_binary_format/elf/elf_decoder.h"
#include "shared/source/device_binary_format/elf/elf_encoder.h"
#include "shared/source/device_binary_format/zebin/zebin_elf.h"
#include "shared/source/helpers/aligned_memory.h"
#include "shared/source/memory_manager/graphics_allocation.h"
#include "shared/source/utilities/shared_pool_allocation.h"
namespace NEO::Zebin::Debug {
using namespace NEO::Zebin::Elf;
Segments::Segments() {}
Segments::Segments(const SharedPoolAllocation *globalVarAlloc, const SharedPoolAllocation *globalConstAlloc, ArrayRef<const uint8_t> &globalStrings, std::vector<KernelNameIsaTupleT> &kernels) {
if (globalVarAlloc) {
varData = {static_cast<uintptr_t>(globalVarAlloc->getGpuAddress()), globalVarAlloc->getSize()};
}
if (globalConstAlloc) {
constData = {static_cast<uintptr_t>(globalConstAlloc->getGpuAddress()), globalConstAlloc->getSize()};
}
if (false == globalStrings.empty()) {
stringData = {reinterpret_cast<uintptr_t>(globalStrings.begin()), globalStrings.size()};
}
for (auto &[kernelName, isaSegment] : kernels) {
nameToSegMap.insert(std::pair(kernelName, isaSegment));
}
}
std::vector<uint8_t> createDebugZebin(ArrayRef<const uint8_t> zebinBin, const Segments &gpuSegments) {
std::string errors, warnings;
auto zebin = decodeElf(zebinBin, errors, warnings);
if (false == errors.empty()) {
return {};
}
auto dzc = DebugZebinCreator(zebin, gpuSegments);
dzc.createDebugZebin();
dzc.applyRelocations();
return dzc.getDebugZebin();
}
void DebugZebinCreator::createDebugZebin() {
ElfEncoder<EI_CLASS_64> elfEncoder(false, false, 8);
auto &header = elfEncoder.getElfFileHeader();
header.machine = zebin.elfFileHeader->machine;
header.flags = zebin.elfFileHeader->flags;
header.type = NEO::Elf::ET_EXEC;
header.version = zebin.elfFileHeader->version;
header.shStrNdx = zebin.elfFileHeader->shStrNdx;
for (uint32_t i = 0; i < zebin.sectionHeaders.size(); i++) {
const auto §ion = zebin.sectionHeaders[i];
auto sectionName = zebin.getSectionName(i);
ArrayRef<const uint8_t> sectionData = section.data;
if (section.header->type == SHT_SYMTAB) {
symTabShndx = i;
}
auto §ionHeader = elfEncoder.appendSection(section.header->type, sectionName, sectionData);
sectionHeader.link = section.header->link;
sectionHeader.info = section.header->info;
sectionHeader.name = section.header->name;
sectionHeader.flags = section.header->flags;
if (auto segment = getSegmentByName(sectionName)) {
if (!isCpuSegment(sectionName)) {
elfEncoder.appendProgramHeaderLoad(i, segment->address, segment->size);
}
sectionHeader.addr = segment->address;
}
}
debugZebin = elfEncoder.encode();
}
#pragma pack(push, 1)
template <typename T>
struct SafeType {
T value;
};
#pragma pack(pop)
template void patchWithValue<uint32_t>(uintptr_t addr, uint32_t value);
template void patchWithValue<uint64_t>(uintptr_t addr, uint64_t value);
template <typename T>
void patchWithValue(uintptr_t addr, T value) {
if (isAligned<sizeof(T)>(addr)) {
*reinterpret_cast<T *>(addr) = value;
} else {
reinterpret_cast<SafeType<T> *>(addr)->value = value;
}
}
void DebugZebinCreator::applyRelocation(uintptr_t addr, uint64_t value, RelocTypeZebin type) {
switch (type) {
default:
UNRECOVERABLE_IF(type != R_ZE_SYM_ADDR)
return patchWithValue<uint64_t>(addr, value);
case R_ZE_SYM_ADDR_32:
return patchWithValue<uint32_t>(addr, static_cast<uint32_t>(value & uint32_t(-1)));
case R_ZE_SYM_ADDR_32_HI:
return patchWithValue<uint32_t>(addr, static_cast<uint32_t>((value >> 32) & uint32_t(-1)));
}
}
void DebugZebinCreator::applyRelocations() {
if (symTabShndx == std::numeric_limits<uint32_t>::max()) {
return;
}
using ElfSymbolT = ElfSymbolEntry<EI_CLASS_64>;
std::string errors, warnings;
auto elf = decodeElf(debugZebin, errors, warnings);
auto symTabSecHdr = elf.sectionHeaders[symTabShndx].header;
size_t symbolsCount = static_cast<size_t>(symTabSecHdr->size) / static_cast<size_t>(symTabSecHdr->entsize);
ArrayRef<ElfSymbolT> symbols = {reinterpret_cast<ElfSymbolT *>(debugZebin.data() + symTabSecHdr->offset), symbolsCount};
for (auto &symbol : symbols) {
auto symbolSectionName = elf.getSectionName(symbol.shndx);
auto symbolName = elf.getSymbolName(symbol.name);
auto segment = getSegmentByName(symbolSectionName);
if (segment != nullptr) {
symbol.value += segment->address;
} else if (ConstStringRef(symbolSectionName).startsWith(SectionNames::debugPrefix.data()) &&
ConstStringRef(symbolName).startsWith(SectionNames::textPrefix.data())) {
symbol.value += getTextSegmentByName(symbolName)->address;
}
}
for (const auto *relocations : {&elf.getDebugInfoRelocations(), &elf.getRelocations()}) {
for (const auto &reloc : *relocations) {
auto relocType = static_cast<RelocTypeZebin>(reloc.relocType);
if (isRelocTypeSupported(relocType) == false) {
continue;
}
auto relocAddr = reinterpret_cast<uintptr_t>(debugZebin.data() + elf.getSectionOffset(reloc.targetSectionIndex) + reloc.offset);
uint64_t relocVal = symbols[reloc.symbolTableIndex].value + reloc.addend;
applyRelocation(relocAddr, relocVal, relocType);
}
}
}
bool DebugZebinCreator::isRelocTypeSupported(RelocTypeZebin type) {
return type == RelocTypeZebin::R_ZE_SYM_ADDR ||
type == RelocTypeZebin::R_ZE_SYM_ADDR_32 ||
type == RelocTypeZebin::R_ZE_SYM_ADDR_32_HI;
}
const Segments::Segment *DebugZebinCreator::getSegmentByName(ConstStringRef sectionName) {
if (sectionName.startsWith(SectionNames::textPrefix.data())) {
return getTextSegmentByName(sectionName);
} else if (sectionName == SectionNames::dataConst) {
return &segments.constData;
} else if (sectionName == SectionNames::dataGlobal) {
return &segments.varData;
} else if (sectionName == SectionNames::dataConstString) {
return &segments.stringData;
}
return nullptr;
}
const Segments::Segment *DebugZebinCreator::getTextSegmentByName(ConstStringRef sectionName) {
auto kernelName = sectionName.substr(SectionNames::textPrefix.length());
auto kernelSegmentIt = segments.nameToSegMap.find(kernelName.str());
UNRECOVERABLE_IF(kernelSegmentIt == segments.nameToSegMap.end());
return &kernelSegmentIt->second;
}
bool DebugZebinCreator::isCpuSegment(ConstStringRef sectionName) {
return (sectionName == SectionNames::dataConstString);
}
} // namespace NEO::Zebin::Debug
|
