2014-12-13 01:31:24 +08:00
|
|
|
//===- tools/dsymutil/MachODebugMapParser.cpp - Parse STABS debug maps ----===//
|
|
|
|
//
|
|
|
|
// The LLVM Linker
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
#include "BinaryHolder.h"
|
2014-12-13 01:31:24 +08:00
|
|
|
#include "DebugMap.h"
|
|
|
|
#include "dsymutil.h"
|
|
|
|
#include "llvm/Object/MachO.h"
|
|
|
|
#include "llvm/Support/Path.h"
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
using namespace llvm;
|
|
|
|
using namespace llvm::dsymutil;
|
|
|
|
using namespace llvm::object;
|
|
|
|
|
|
|
|
class MachODebugMapParser {
|
|
|
|
public:
|
2015-01-06 05:29:28 +08:00
|
|
|
MachODebugMapParser(StringRef BinaryPath, StringRef PathPrefix = "",
|
|
|
|
bool Verbose = false)
|
2014-12-18 08:45:32 +08:00
|
|
|
: BinaryPath(BinaryPath), PathPrefix(PathPrefix),
|
2015-01-08 05:13:30 +08:00
|
|
|
MainBinaryHolder(Verbose), CurrentObjectHolder(Verbose),
|
|
|
|
CurrentDebugMapObject(nullptr) {}
|
2014-12-13 01:31:24 +08:00
|
|
|
|
|
|
|
/// \brief Parses and returns the DebugMap of the input binary.
|
|
|
|
/// \returns an error in case the provided BinaryPath doesn't exist
|
|
|
|
/// or isn't of a supported type.
|
|
|
|
ErrorOr<std::unique_ptr<DebugMap>> parse();
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::string BinaryPath;
|
|
|
|
std::string PathPrefix;
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
/// Owns the MemoryBuffer for the main binary.
|
|
|
|
BinaryHolder MainBinaryHolder;
|
2014-12-13 01:31:24 +08:00
|
|
|
/// Map of the binary symbol addresses.
|
|
|
|
StringMap<uint64_t> MainBinarySymbolAddresses;
|
2014-12-17 04:21:34 +08:00
|
|
|
StringRef MainBinaryStrings;
|
2014-12-13 01:31:24 +08:00
|
|
|
/// The constructed DebugMap.
|
|
|
|
std::unique_ptr<DebugMap> Result;
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
/// Owns the MemoryBuffer for the currently handled object file.
|
|
|
|
BinaryHolder CurrentObjectHolder;
|
2014-12-13 01:31:24 +08:00
|
|
|
/// Map of the currently processed object file symbol addresses.
|
|
|
|
StringMap<uint64_t> CurrentObjectAddresses;
|
|
|
|
/// Element of the debug map corresponfing to the current object file.
|
|
|
|
DebugMapObject *CurrentDebugMapObject;
|
|
|
|
|
2015-03-15 09:29:30 +08:00
|
|
|
/// Holds function info while function scope processing.
|
|
|
|
const char *CurrentFunctionName;
|
|
|
|
uint64_t CurrentFunctionAddress;
|
|
|
|
|
2014-12-13 01:31:24 +08:00
|
|
|
void switchToNewDebugMapObject(StringRef Filename);
|
|
|
|
void resetParserState();
|
|
|
|
uint64_t getMainBinarySymbolAddress(StringRef Name);
|
|
|
|
void loadMainBinarySymbols();
|
|
|
|
void loadCurrentObjectFileSymbols();
|
|
|
|
void handleStabSymbolTableEntry(uint32_t StringIndex, uint8_t Type,
|
|
|
|
uint8_t SectionIndex, uint16_t Flags,
|
|
|
|
uint64_t Value);
|
|
|
|
|
|
|
|
template <typename STEType> void handleStabDebugMapEntry(const STEType &STE) {
|
|
|
|
handleStabSymbolTableEntry(STE.n_strx, STE.n_type, STE.n_sect, STE.n_desc,
|
|
|
|
STE.n_value);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
static void Warning(const Twine &Msg) { errs() << "warning: " + Msg + "\n"; }
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Reset the parser state coresponding to the current object
|
|
|
|
/// file. This is to be called after an object file is finished
|
|
|
|
/// processing.
|
|
|
|
void MachODebugMapParser::resetParserState() {
|
|
|
|
CurrentObjectAddresses.clear();
|
|
|
|
CurrentDebugMapObject = nullptr;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Create a new DebugMapObject. This function resets the state of the
|
|
|
|
/// parser that was referring to the last object file and sets
|
|
|
|
/// everything up to add symbols to the new one.
|
|
|
|
void MachODebugMapParser::switchToNewDebugMapObject(StringRef Filename) {
|
|
|
|
resetParserState();
|
|
|
|
|
|
|
|
SmallString<80> Path(PathPrefix);
|
|
|
|
sys::path::append(Path, Filename);
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
auto MachOOrError = CurrentObjectHolder.GetFileAs<MachOObjectFile>(Path);
|
2014-12-13 01:31:24 +08:00
|
|
|
if (auto Error = MachOOrError.getError()) {
|
|
|
|
Warning(Twine("cannot open debug object \"") + Path.str() + "\": " +
|
|
|
|
Error.message() + "\n");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
loadCurrentObjectFileSymbols();
|
|
|
|
CurrentDebugMapObject = &Result->addDebugMapObject(Path);
|
|
|
|
}
|
|
|
|
|
2015-01-20 07:33:14 +08:00
|
|
|
static Triple getTriple(const object::MachOObjectFile &Obj) {
|
|
|
|
Triple TheTriple("unknown-unknown-unknown");
|
|
|
|
TheTriple.setArch(Triple::ArchType(Obj.getArch()));
|
|
|
|
TheTriple.setObjectFormat(Triple::MachO);
|
|
|
|
return TheTriple;
|
|
|
|
}
|
|
|
|
|
2014-12-13 01:31:24 +08:00
|
|
|
/// This main parsing routine tries to open the main binary and if
|
|
|
|
/// successful iterates over the STAB entries. The real parsing is
|
|
|
|
/// done in handleStabSymbolTableEntry.
|
|
|
|
ErrorOr<std::unique_ptr<DebugMap>> MachODebugMapParser::parse() {
|
2015-01-06 05:29:28 +08:00
|
|
|
auto MainBinOrError = MainBinaryHolder.GetFileAs<MachOObjectFile>(BinaryPath);
|
|
|
|
if (auto Error = MainBinOrError.getError())
|
2014-12-13 01:31:24 +08:00
|
|
|
return Error;
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
const MachOObjectFile &MainBinary = *MainBinOrError;
|
2014-12-13 01:31:24 +08:00
|
|
|
loadMainBinarySymbols();
|
2015-01-20 07:33:14 +08:00
|
|
|
Result = make_unique<DebugMap>(getTriple(MainBinary));
|
2014-12-17 04:21:34 +08:00
|
|
|
MainBinaryStrings = MainBinary.getStringTableData();
|
2014-12-13 01:31:24 +08:00
|
|
|
for (const SymbolRef &Symbol : MainBinary.symbols()) {
|
|
|
|
const DataRefImpl &DRI = Symbol.getRawDataRefImpl();
|
|
|
|
if (MainBinary.is64Bit())
|
|
|
|
handleStabDebugMapEntry(MainBinary.getSymbol64TableEntry(DRI));
|
|
|
|
else
|
|
|
|
handleStabDebugMapEntry(MainBinary.getSymbolTableEntry(DRI));
|
|
|
|
}
|
|
|
|
|
|
|
|
resetParserState();
|
|
|
|
return std::move(Result);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Interpret the STAB entries to fill the DebugMap.
|
|
|
|
void MachODebugMapParser::handleStabSymbolTableEntry(uint32_t StringIndex,
|
|
|
|
uint8_t Type,
|
|
|
|
uint8_t SectionIndex,
|
|
|
|
uint16_t Flags,
|
|
|
|
uint64_t Value) {
|
|
|
|
if (!(Type & MachO::N_STAB))
|
|
|
|
return;
|
|
|
|
|
2014-12-17 04:21:34 +08:00
|
|
|
const char *Name = &MainBinaryStrings.data()[StringIndex];
|
2014-12-13 01:31:24 +08:00
|
|
|
|
|
|
|
// An N_OSO entry represents the start of a new object file description.
|
|
|
|
if (Type == MachO::N_OSO)
|
|
|
|
return switchToNewDebugMapObject(Name);
|
|
|
|
|
|
|
|
// If the last N_OSO object file wasn't found,
|
|
|
|
// CurrentDebugMapObject will be null. Do not update anything
|
|
|
|
// until we find the next valid N_OSO entry.
|
|
|
|
if (!CurrentDebugMapObject)
|
|
|
|
return;
|
|
|
|
|
2015-03-15 09:29:30 +08:00
|
|
|
uint32_t Size = 0;
|
2014-12-13 01:31:24 +08:00
|
|
|
switch (Type) {
|
|
|
|
case MachO::N_GSYM:
|
|
|
|
// This is a global variable. We need to query the main binary
|
|
|
|
// symbol table to find its address as it might not be in the
|
|
|
|
// debug map (for common symbols).
|
|
|
|
Value = getMainBinarySymbolAddress(Name);
|
|
|
|
if (Value == UnknownAddressOrSize)
|
|
|
|
return;
|
|
|
|
break;
|
|
|
|
case MachO::N_FUN:
|
2015-03-15 09:29:30 +08:00
|
|
|
// Functions are scopes in STABS. They have an end marker that
|
|
|
|
// contains the function size.
|
|
|
|
if (Name[0] == '\0') {
|
|
|
|
Size = Value;
|
|
|
|
Value = CurrentFunctionAddress;
|
|
|
|
Name = CurrentFunctionName;
|
|
|
|
break;
|
|
|
|
} else {
|
|
|
|
CurrentFunctionName = Name;
|
|
|
|
CurrentFunctionAddress = Value;
|
2014-12-13 01:31:24 +08:00
|
|
|
return;
|
2015-03-15 09:29:30 +08:00
|
|
|
}
|
2014-12-13 01:31:24 +08:00
|
|
|
case MachO::N_STSYM:
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
auto ObjectSymIt = CurrentObjectAddresses.find(Name);
|
|
|
|
if (ObjectSymIt == CurrentObjectAddresses.end())
|
|
|
|
return Warning("could not find object file symbol for symbol " +
|
|
|
|
Twine(Name));
|
2015-03-15 09:29:30 +08:00
|
|
|
if (!CurrentDebugMapObject->addSymbol(Name, ObjectSymIt->getValue(), Value,
|
|
|
|
Size))
|
2014-12-13 01:31:24 +08:00
|
|
|
return Warning(Twine("failed to insert symbol '") + Name +
|
|
|
|
"' in the debug map.");
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Load the current object file symbols into CurrentObjectAddresses.
|
|
|
|
void MachODebugMapParser::loadCurrentObjectFileSymbols() {
|
|
|
|
CurrentObjectAddresses.clear();
|
|
|
|
|
2015-01-06 05:29:28 +08:00
|
|
|
for (auto Sym : CurrentObjectHolder.Get().symbols()) {
|
2014-12-13 01:31:24 +08:00
|
|
|
StringRef Name;
|
|
|
|
uint64_t Addr;
|
|
|
|
if (Sym.getAddress(Addr) || Addr == UnknownAddressOrSize ||
|
|
|
|
Sym.getName(Name))
|
|
|
|
continue;
|
|
|
|
CurrentObjectAddresses[Name] = Addr;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Lookup a symbol address in the main binary symbol table. The
|
|
|
|
/// parser only needs to query common symbols, thus not every symbol's
|
|
|
|
/// address is available through this function.
|
|
|
|
uint64_t MachODebugMapParser::getMainBinarySymbolAddress(StringRef Name) {
|
|
|
|
auto Sym = MainBinarySymbolAddresses.find(Name);
|
|
|
|
if (Sym == MainBinarySymbolAddresses.end())
|
|
|
|
return UnknownAddressOrSize;
|
|
|
|
return Sym->second;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Load the interesting main binary symbols' addresses into
|
|
|
|
/// MainBinarySymbolAddresses.
|
|
|
|
void MachODebugMapParser::loadMainBinarySymbols() {
|
2015-01-06 05:29:28 +08:00
|
|
|
const MachOObjectFile &MainBinary = MainBinaryHolder.GetAs<MachOObjectFile>();
|
|
|
|
section_iterator Section = MainBinary.section_end();
|
|
|
|
for (const auto &Sym : MainBinary.symbols()) {
|
2014-12-13 01:31:24 +08:00
|
|
|
SymbolRef::Type Type;
|
|
|
|
// Skip undefined and STAB entries.
|
|
|
|
if (Sym.getType(Type) || (Type & SymbolRef::ST_Debug) ||
|
|
|
|
(Type & SymbolRef::ST_Unknown))
|
|
|
|
continue;
|
|
|
|
StringRef Name;
|
|
|
|
uint64_t Addr;
|
|
|
|
// The only symbols of interest are the global variables. These
|
|
|
|
// are the only ones that need to be queried because the address
|
|
|
|
// of common data won't be described in the debug map. All other
|
|
|
|
// addresses should be fetched for the debug map.
|
|
|
|
if (Sym.getAddress(Addr) || Addr == UnknownAddressOrSize ||
|
|
|
|
!(Sym.getFlags() & SymbolRef::SF_Global) || Sym.getSection(Section) ||
|
|
|
|
Section->isText() || Sym.getName(Name) || Name.size() == 0 ||
|
|
|
|
Name[0] == '\0')
|
|
|
|
continue;
|
|
|
|
MainBinarySymbolAddresses[Name] = Addr;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
namespace dsymutil {
|
2015-02-28 08:29:05 +08:00
|
|
|
llvm::ErrorOr<std::unique_ptr<DebugMap>>
|
|
|
|
parseDebugMap(StringRef InputFile, StringRef PrependPath, bool Verbose) {
|
2015-01-06 05:29:28 +08:00
|
|
|
MachODebugMapParser Parser(InputFile, PrependPath, Verbose);
|
2014-12-13 01:31:24 +08:00
|
|
|
return Parser.parse();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|