compute-runtime/shared/source/device_binary_format/elf/elf_decoder.h

137 lines
4.4 KiB
C++

/*
* Copyright (C) 2020-2021 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "shared/source/device_binary_format/elf/elf.h"
#include "shared/source/utilities/arrayref.h"
#include "shared/source/utilities/const_stringref.h"
#include "shared/source/utilities/stackvec.h"
#include <cstdint>
namespace NEO {
namespace Elf {
enum class RELOCATION_X8664_TYPE : uint32_t {
R_X8664_64 = 0x1,
R_X8664_32 = 0xa
};
template <ELF_IDENTIFIER_CLASS NumBits = EI_CLASS_64>
struct Elf {
struct ProgramHeaderAndData {
const ElfProgramHeader<NumBits> *header = nullptr;
ArrayRef<const uint8_t> data;
};
struct SectionHeaderAndData {
const ElfSectionHeader<NumBits> *header;
ArrayRef<const uint8_t> data;
};
struct RelocationInfo {
int symbolSectionIndex;
int symbolTableIndex;
int targetSectionIndex;
int64_t addend;
uint64_t offset;
uint32_t relocType;
std::string symbolName;
};
using Relocations = std::vector<RelocationInfo>;
using SymbolsTable = std::vector<ElfSymbolEntry<NumBits>>;
bool decodeSections(std::string &outError);
template <class ElfReloc>
int extractSymbolIndex(const ElfReloc &elfReloc) const;
template <class ElfReloc>
uint32_t extractRelocType(const ElfReloc &elfReloc) const;
template <class ElfSymbol>
uint32_t extractSymbolType(const ElfSymbol &elfSymbol) const {
return elfSymbol.info & 0xf;
}
template <class ElfSymbol>
uint32_t extractSymbolBind(const ElfSymbol &elfSymbol) const {
return (elfSymbol.info >> 4) & 0xf;
}
MOCKABLE_VIRTUAL std::string getSectionName(uint32_t id) const {
auto sectionHeaderNamesData = sectionHeaders[elfFileHeader->shStrNdx].data;
return std::string(reinterpret_cast<const char *>(sectionHeaderNamesData.begin()) + sectionHeaders[id].header->name);
}
MOCKABLE_VIRTUAL std::string getSymbolName(uint32_t nameOffset) const {
auto sectionHeaderNamesData = sectionHeaders[elfFileHeader->shStrNdx].data;
return std::string(reinterpret_cast<const char *>(sectionHeaderNamesData.begin()) + nameOffset);
}
decltype(ElfSymbolEntry<NumBits>::value) getSymbolAddress(uint32_t idx) const {
return symbolTable[idx].value;
}
const Relocations &getRelocations() const {
return relocations;
}
const Relocations &getDebugInfoRelocations() const {
return debugInfoRelocations;
}
const SymbolsTable &getSymbols() const {
return symbolTable;
}
const ElfFileHeader<NumBits> *elfFileHeader = nullptr;
StackVec<ProgramHeaderAndData, 32> programHeaders;
StackVec<SectionHeaderAndData, 32> sectionHeaders;
protected:
bool decodeSymTab(SectionHeaderAndData &sectionHeaderData, std::string &outError);
bool decodeRelocations(SectionHeaderAndData &sectionHeaderData, std::string &outError);
bool isDebugDataRelocation(ConstStringRef sectionName);
SymbolsTable symbolTable;
Relocations relocations;
Relocations debugInfoRelocations;
};
template <ELF_IDENTIFIER_CLASS NumBits = EI_CLASS_64>
const ElfFileHeader<NumBits> *decodeElfFileHeader(const ArrayRef<const uint8_t> binary);
extern template const ElfFileHeader<EI_CLASS_32> *decodeElfFileHeader<EI_CLASS_32>(const ArrayRef<const uint8_t>);
extern template const ElfFileHeader<EI_CLASS_64> *decodeElfFileHeader<EI_CLASS_64>(const ArrayRef<const uint8_t>);
template <ELF_IDENTIFIER_CLASS NumBits = EI_CLASS_64>
Elf<NumBits> decodeElf(const ArrayRef<const uint8_t> binary, std::string &outErrReason, std::string &outWarning);
extern template Elf<EI_CLASS_32> decodeElf<EI_CLASS_32>(const ArrayRef<const uint8_t>, std::string &, std::string &);
extern template Elf<EI_CLASS_64> decodeElf<EI_CLASS_64>(const ArrayRef<const uint8_t>, std::string &, std::string &);
template <ELF_IDENTIFIER_CLASS NumBits>
inline bool isElf(const ArrayRef<const uint8_t> binary) {
return (nullptr != decodeElfFileHeader<NumBits>(binary));
}
inline bool isElf(const ArrayRef<const uint8_t> binary) {
return isElf<EI_CLASS_32>(binary) || isElf<EI_CLASS_64>(binary);
}
inline ELF_IDENTIFIER_CLASS getElfNumBits(const ArrayRef<const uint8_t> binary) {
if (isElf<EI_CLASS_32>(binary)) {
return EI_CLASS_32;
} else if (isElf<EI_CLASS_64>(binary)) {
return EI_CLASS_64;
}
return EI_CLASS_NONE;
}
} // namespace Elf
} // namespace NEO