04a2e12612
The ELF spec says: > STT_FILE: Conventionally, the symbol's name gives the name of the source file associated with the object file. A file symbol has STB_LOCAL binding, its section index is SHN_ABS, and it precedes the other STB_LOCAL symbols for the file, if it is present. For a local symbol, the preceding STT_FILE symbol is almost always in the same file[1]. GNU addr2line uses this heuristic to retrieve the filename associated with a local symbol (e.g. internal linkage functions in C/C++). GNU addr2line can assign STT_FILE filename to a non-local symbol, too, but the trick only works if no regular symbol precede STT_FILE. This patch does not implement this corner case (not useful for most executables which have more than one files). In case of filename mismatch between .debug_line & .symtab, arbitrarily make .debug_line win. [1]: LLD does not synthesize STT_FILE symbols (https://bugs.llvm.org/show_bug.cgi?id=48023 see also https://sourceware.org/bugzilla/show_bug.cgi?id=26822). An assembly file without `.file` directives can cause mis-attribution. This is an edge case. Differential Revision: https://reviews.llvm.org/D95927
105 lines
3.9 KiB
C++
105 lines
3.9 KiB
C++
//===- SymbolizableObjectFile.h ---------------------------------*- C++ -*-===//
|
|
//
|
|
// 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 file declares the SymbolizableObjectFile class.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef LLVM_LIB_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H
|
|
#define LLVM_LIB_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/DebugInfo/DIContext.h"
|
|
#include "llvm/DebugInfo/Symbolize/SymbolizableModule.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include <cstdint>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
|
|
class DataExtractor;
|
|
|
|
namespace symbolize {
|
|
|
|
class SymbolizableObjectFile : public SymbolizableModule {
|
|
public:
|
|
static Expected<std::unique_ptr<SymbolizableObjectFile>>
|
|
create(const object::ObjectFile *Obj, std::unique_ptr<DIContext> DICtx,
|
|
bool UntagAddresses);
|
|
|
|
DILineInfo symbolizeCode(object::SectionedAddress ModuleOffset,
|
|
DILineInfoSpecifier LineInfoSpecifier,
|
|
bool UseSymbolTable) const override;
|
|
DIInliningInfo symbolizeInlinedCode(object::SectionedAddress ModuleOffset,
|
|
DILineInfoSpecifier LineInfoSpecifier,
|
|
bool UseSymbolTable) const override;
|
|
DIGlobal symbolizeData(object::SectionedAddress ModuleOffset) const override;
|
|
std::vector<DILocal>
|
|
symbolizeFrame(object::SectionedAddress ModuleOffset) const override;
|
|
|
|
// Return true if this is a 32-bit x86 PE COFF module.
|
|
bool isWin32Module() const override;
|
|
|
|
// Returns the preferred base of the module, i.e. where the loader would place
|
|
// it in memory assuming there were no conflicts.
|
|
uint64_t getModulePreferredBase() const override;
|
|
|
|
private:
|
|
bool shouldOverrideWithSymbolTable(FunctionNameKind FNKind,
|
|
bool UseSymbolTable) const;
|
|
|
|
bool getNameFromSymbolTable(object::SymbolRef::Type Type, uint64_t Address,
|
|
std::string &Name, uint64_t &Addr, uint64_t &Size,
|
|
std::string &FileName) const;
|
|
// For big-endian PowerPC64 ELF, OpdAddress is the address of the .opd
|
|
// (function descriptor) section and OpdExtractor refers to its contents.
|
|
Error addSymbol(const object::SymbolRef &Symbol, uint64_t SymbolSize,
|
|
DataExtractor *OpdExtractor = nullptr,
|
|
uint64_t OpdAddress = 0);
|
|
Error addCoffExportSymbols(const object::COFFObjectFile *CoffObj);
|
|
|
|
/// Search for the first occurence of specified Address in ObjectFile.
|
|
uint64_t getModuleSectionIndexForAddress(uint64_t Address) const;
|
|
|
|
const object::ObjectFile *Module;
|
|
std::unique_ptr<DIContext> DebugInfoContext;
|
|
bool UntagAddresses;
|
|
|
|
struct SymbolDesc {
|
|
uint64_t Addr;
|
|
// If size is 0, assume that symbol occupies the whole memory range up to
|
|
// the following symbol.
|
|
uint64_t Size;
|
|
|
|
StringRef Name;
|
|
// Non-zero if this is an ELF local symbol. See the comment in
|
|
// getNameFromSymbolTable.
|
|
uint32_t ELFLocalSymIdx;
|
|
|
|
bool operator<(const SymbolDesc &RHS) const {
|
|
return Addr != RHS.Addr ? Addr < RHS.Addr : Size < RHS.Size;
|
|
}
|
|
};
|
|
std::vector<SymbolDesc> Functions;
|
|
std::vector<SymbolDesc> Objects;
|
|
// (index, filename) pairs of ELF STT_FILE symbols.
|
|
std::vector<std::pair<uint32_t, StringRef>> FileSymbols;
|
|
|
|
SymbolizableObjectFile(const object::ObjectFile *Obj,
|
|
std::unique_ptr<DIContext> DICtx,
|
|
bool UntagAddresses);
|
|
};
|
|
|
|
} // end namespace symbolize
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_LIB_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H
|