llvm-6502/include/llvm/MC/MCObjectDisassembler.h
Ahmed Bougacha 484a6eb9cc MC CFG: Add "dynamic disassembly" support to MCObjectDisassembler.
It can now disassemble code in situations where the effective load
address is different than the load address declared in the object file.
This happens for PIC, hence "dynamic".

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@188884 91177308-0d34-0410-b5e6-96231b3b80d8
2013-08-21 07:28:37 +00:00

106 lines
4.1 KiB
C++

//===-- llvm/MC/MCObjectDisassembler.h --------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains the declaration of the MCObjectDisassembler class, which
// can be used to construct an MCModule and an MC CFG from an ObjectFile.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_MC_MCOBJECTDISASSEMBLER_H
#define LLVM_MC_MCOBJECTDISASSEMBLER_H
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/DataTypes.h"
namespace llvm {
namespace object {
class ObjectFile;
}
class MCBasicBlock;
class MCDisassembler;
class MCFunction;
class MCInstrAnalysis;
class MCModule;
/// \brief Disassemble an ObjectFile to an MCModule and MCFunctions.
/// This class builds on MCDisassembler to disassemble whole sections, creating
/// MCAtom (MCTextAtom for disassembled sections and MCDataAtom for raw data).
/// It can also be used to create a control flow graph consisting of MCFunctions
/// and MCBasicBlocks.
class MCObjectDisassembler {
public:
MCObjectDisassembler(const object::ObjectFile &Obj,
const MCDisassembler &Dis,
const MCInstrAnalysis &MIA);
virtual ~MCObjectDisassembler() {}
/// \brief Build an MCModule, creating atoms and optionally functions.
/// \param withCFG Also build a CFG by adding MCFunctions to the Module.
/// If withCFG is false, the MCModule built only contains atoms, representing
/// what was found in the object file. If withCFG is true, MCFunctions are
/// created, containing MCBasicBlocks. All text atoms are split to form basic
/// block atoms, which then each back an MCBasicBlock.
MCModule *buildModule(bool withCFG = false);
MCModule *buildEmptyModule();
/// \brief Get the effective address of the entrypoint, or 0 if there is none.
virtual uint64_t getEntrypoint();
/// \name Get the addresses of static constructors/destructors in the object.
/// The caller is expected to know how to interpret the addresses;
/// for example, Mach-O init functions expect 5 arguments, not for ELF.
/// The addresses are original object file load addresses, not effective.
/// @{
virtual ArrayRef<uint64_t> getStaticInitFunctions();
virtual ArrayRef<uint64_t> getStaticExitFunctions();
/// @}
/// \name Translation between effective and objectfile load address.
/// @{
/// \brief Compute the effective load address, from an objectfile virtual
/// address. This is implemented in a format-specific way, to take into
/// account things like PIE/ASLR when doing dynamic disassembly.
/// For example, on Mach-O this would be done by adding the VM addr slide,
/// on glibc ELF by keeping a map between segment load addresses, filled
/// using dl_iterate_phdr, etc..
/// In most static situations and in the default impl., this returns \p Addr.
virtual uint64_t getEffectiveLoadAddr(uint64_t Addr);
/// \brief Compute the original load address, as specified in the objectfile.
/// This is the inverse of getEffectiveLoadAddr.
virtual uint64_t getOriginalLoadAddr(uint64_t EffectiveAddr);
/// @}
protected:
const object::ObjectFile &Obj;
const MCDisassembler &Dis;
const MCInstrAnalysis &MIA;
private:
/// \brief Fill \p Module by creating an atom for each section.
/// This could be made much smarter, using information like symbols, but also
/// format-specific features, like mach-o function_start or data_in_code LCs.
void buildSectionAtoms(MCModule *Module);
/// \brief Enrich \p Module with a CFG consisting of MCFunctions.
/// \param Module An MCModule returned by buildModule, with no CFG.
/// NOTE: Each MCBasicBlock in a MCFunction is backed by a single MCTextAtom.
/// When the CFG is built, contiguous instructions that were previously in a
/// single MCTextAtom will be split in multiple basic block atoms.
void buildCFG(MCModule *Module);
};
}
#endif