2011-09-13 19:42:23 +00:00
|
|
|
//===-- DIContext.h ---------------------------------------------*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2011-09-15 20:43:22 +00:00
|
|
|
// This file defines DIContext, an abstract data structure that holds
|
2011-09-13 19:42:23 +00:00
|
|
|
// debug information data.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_DEBUGINFO_DICONTEXT_H
|
|
|
|
#define LLVM_DEBUGINFO_DICONTEXT_H
|
|
|
|
|
2012-11-07 23:22:07 +00:00
|
|
|
#include "llvm/ADT/DenseMap.h"
|
2012-12-03 17:02:12 +00:00
|
|
|
#include "llvm/ADT/SmallVector.h"
|
2012-11-12 21:40:38 +00:00
|
|
|
#include "llvm/Object/ObjectFile.h"
|
|
|
|
#include "llvm/Object/RelocVisitor.h"
|
2013-08-06 10:32:39 +00:00
|
|
|
#include "llvm/Support/Casting.h"
|
2011-09-15 22:26:16 +00:00
|
|
|
#include "llvm/Support/DataTypes.h"
|
2011-09-13 19:42:23 +00:00
|
|
|
|
2014-04-18 21:36:39 +00:00
|
|
|
#include <string>
|
|
|
|
|
2011-09-13 19:42:23 +00:00
|
|
|
namespace llvm {
|
|
|
|
|
|
|
|
class raw_ostream;
|
|
|
|
|
2011-09-15 20:43:22 +00:00
|
|
|
/// DILineInfo - a format-neutral container for source line information.
|
2014-04-18 21:36:39 +00:00
|
|
|
struct DILineInfo {
|
|
|
|
std::string FileName;
|
|
|
|
std::string FunctionName;
|
2011-09-15 20:43:22 +00:00
|
|
|
uint32_t Line;
|
|
|
|
uint32_t Column;
|
|
|
|
|
2014-04-18 21:36:39 +00:00
|
|
|
DILineInfo()
|
|
|
|
: FileName("<invalid>"), FunctionName("<invalid>"), Line(0), Column(0) {}
|
2011-09-21 01:13:16 +00:00
|
|
|
|
|
|
|
bool operator==(const DILineInfo &RHS) const {
|
|
|
|
return Line == RHS.Line && Column == RHS.Column &&
|
2014-04-18 21:36:39 +00:00
|
|
|
FileName == RHS.FileName && FunctionName == RHS.FunctionName;
|
2011-09-21 01:13:16 +00:00
|
|
|
}
|
|
|
|
bool operator!=(const DILineInfo &RHS) const {
|
|
|
|
return !(*this == RHS);
|
|
|
|
}
|
2011-09-15 20:43:22 +00:00
|
|
|
};
|
|
|
|
|
2013-01-26 00:28:05 +00:00
|
|
|
typedef SmallVector<std::pair<uint64_t, DILineInfo>, 16> DILineInfoTable;
|
|
|
|
|
2012-09-04 08:12:33 +00:00
|
|
|
/// DIInliningInfo - a format-neutral container for inlined code description.
|
|
|
|
class DIInliningInfo {
|
|
|
|
SmallVector<DILineInfo, 4> Frames;
|
|
|
|
public:
|
|
|
|
DIInliningInfo() {}
|
|
|
|
DILineInfo getFrame(unsigned Index) const {
|
|
|
|
assert(Index < Frames.size());
|
|
|
|
return Frames[Index];
|
|
|
|
}
|
|
|
|
uint32_t getNumberOfFrames() const {
|
|
|
|
return Frames.size();
|
|
|
|
}
|
|
|
|
void addFrame(const DILineInfo &Frame) {
|
|
|
|
Frames.push_back(Frame);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-07-02 05:54:45 +00:00
|
|
|
/// DILineInfoSpecifier - controls which fields of DILineInfo container
|
|
|
|
/// should be filled with data.
|
2014-05-15 21:24:32 +00:00
|
|
|
struct DILineInfoSpecifier {
|
|
|
|
enum class FileLineInfoKind { None, Default, AbsoluteFilePath };
|
2014-05-17 00:07:48 +00:00
|
|
|
enum class FunctionNameKind { None, ShortName, LinkageName };
|
2014-05-15 21:24:32 +00:00
|
|
|
|
|
|
|
FileLineInfoKind FLIKind;
|
|
|
|
FunctionNameKind FNKind;
|
|
|
|
|
|
|
|
DILineInfoSpecifier(FileLineInfoKind FLIKind = FileLineInfoKind::Default,
|
|
|
|
FunctionNameKind FNKind = FunctionNameKind::None)
|
|
|
|
: FLIKind(FLIKind), FNKind(FNKind) {}
|
2012-07-02 05:54:45 +00:00
|
|
|
};
|
|
|
|
|
2013-01-25 20:26:43 +00:00
|
|
|
/// Selects which debug sections get dumped.
|
|
|
|
enum DIDumpType {
|
|
|
|
DIDT_Null,
|
|
|
|
DIDT_All,
|
|
|
|
DIDT_Abbrev,
|
|
|
|
DIDT_AbbrevDwo,
|
|
|
|
DIDT_Aranges,
|
2013-02-05 23:30:58 +00:00
|
|
|
DIDT_Frames,
|
2013-01-25 20:26:43 +00:00
|
|
|
DIDT_Info,
|
|
|
|
DIDT_InfoDwo,
|
2013-09-23 22:44:47 +00:00
|
|
|
DIDT_Types,
|
2014-01-09 05:08:24 +00:00
|
|
|
DIDT_TypesDwo,
|
2013-01-25 20:26:43 +00:00
|
|
|
DIDT_Line,
|
2014-02-24 23:58:54 +00:00
|
|
|
DIDT_LineDwo,
|
2013-06-19 21:37:13 +00:00
|
|
|
DIDT_Loc,
|
2014-03-25 01:44:02 +00:00
|
|
|
DIDT_LocDwo,
|
2013-01-25 20:26:43 +00:00
|
|
|
DIDT_Ranges,
|
2013-02-12 16:20:28 +00:00
|
|
|
DIDT_Pubnames,
|
2013-09-25 23:02:41 +00:00
|
|
|
DIDT_Pubtypes,
|
2013-09-19 23:01:29 +00:00
|
|
|
DIDT_GnuPubnames,
|
2013-09-24 19:50:00 +00:00
|
|
|
DIDT_GnuPubtypes,
|
2013-01-25 20:26:43 +00:00
|
|
|
DIDT_Str,
|
|
|
|
DIDT_StrDwo,
|
|
|
|
DIDT_StrOffsetsDwo
|
|
|
|
};
|
|
|
|
|
2012-11-07 23:22:07 +00:00
|
|
|
// In place of applying the relocations to the data we've read from disk we use
|
2012-11-07 23:38:51 +00:00
|
|
|
// a separate mapping table to the side and checking that at locations in the
|
|
|
|
// dwarf where we expect relocated values. This adds a bit of complexity to the
|
|
|
|
// dwarf parsing/extraction at the benefit of not allocating memory for the
|
|
|
|
// entire size of the debug info sections.
|
2012-11-07 23:22:07 +00:00
|
|
|
typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
|
|
|
|
|
2011-09-13 19:42:23 +00:00
|
|
|
class DIContext {
|
|
|
|
public:
|
2013-08-06 10:32:39 +00:00
|
|
|
enum DIContextKind {
|
|
|
|
CK_DWARF
|
|
|
|
};
|
|
|
|
DIContextKind getKind() const { return Kind; }
|
|
|
|
|
|
|
|
DIContext(DIContextKind K) : Kind(K) {}
|
2011-09-13 19:42:23 +00:00
|
|
|
virtual ~DIContext();
|
|
|
|
|
|
|
|
/// getDWARFContext - get a context for binary DWARF data.
|
2014-07-31 20:19:36 +00:00
|
|
|
static DIContext *getDWARFContext(object::ObjectFile &);
|
2011-09-13 19:42:23 +00:00
|
|
|
|
2013-01-25 20:26:43 +00:00
|
|
|
virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) = 0;
|
2011-09-15 20:43:22 +00:00
|
|
|
|
2012-09-04 08:12:33 +00:00
|
|
|
virtual DILineInfo getLineInfoForAddress(uint64_t Address,
|
|
|
|
DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
|
2013-01-26 00:28:05 +00:00
|
|
|
virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
|
|
|
|
uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
|
2012-09-04 08:12:33 +00:00
|
|
|
virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
|
|
|
|
DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
|
2013-08-06 10:32:39 +00:00
|
|
|
private:
|
|
|
|
const DIContextKind Kind;
|
2011-09-13 19:42:23 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|