DWARFDebugFrame.cpp revision d9a8d43ed3e7c6c32f52ab5d0f627f7b1cdb6aac
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===-- DWARFDebugFrame.h - Parsing of .debug_frame -------------*- C++ -*-===// 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The LLVM Compiler Infrastructure 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is distributed under the University of Illinois Open Source 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// License. See LICENSE.TXT for details. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "DWARFDebugFrame.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "llvm/ADT/SmallString.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "llvm/Support/DataTypes.h" 13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/Support/Dwarf.h" 14c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "llvm/Support/Format.h" 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using namespace llvm; 17c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)using namespace dwarf; 18a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 19a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)/// \brief Abstract frame entry defining the common interface concrete 21a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)/// entries implement. 22a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class llvm::FrameEntry { 23a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)public: 24a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) enum FrameKind {FK_CIE, FK_FDE}; 25a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) FrameEntry(FrameKind K, DataExtractor D, uint64_t Offset, uint64_t Length) 26a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) : Kind(K), Data(D), Offset(Offset), Length(Length) {} 27a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 28a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual ~FrameEntry() { 29a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) } 30a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 31a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) FrameKind getKind() const { return Kind; } 32a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 33a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void dumpHeader(raw_ostream &OS) const = 0; 34a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 35a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)protected: 36a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const FrameKind Kind; 37a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 38a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) /// \brief The data stream holding the section from which the entry was 39a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) /// parsed. 40a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) DataExtractor Data; 41a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 42a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) /// \brief Offset of this entry in the section. 43a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) uint64_t Offset; 44a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 45a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) /// \brief Entry length as specified in DWARF. 46a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) uint64_t Length; 47a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)}; 485e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles) 49a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 50a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)/// \brief DWARF Common Information Entry (CIE) 51a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class CIE : public FrameEntry { 524ad1aa43a48567659193a298fad74f55e00b3dd9Ben Murdochpublic: 534ad1aa43a48567659193a298fad74f55e00b3dd9Ben Murdoch // CIEs (and FDEs) are simply container classes, so the only sensible way to 54a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // create them is by providing the full parsed contents in the constructor. 55a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) CIE(DataExtractor D, uint64_t Offset, uint64_t Length, uint8_t Version, 56a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) SmallString<8> Augmentation, uint64_t CodeAlignmentFactor, 57a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) int64_t DataAlignmentFactor, uint64_t ReturnAddressRegister) 58a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) : FrameEntry(FK_CIE, D, Offset, Length), Version(Version), 59a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) Augmentation(Augmentation), CodeAlignmentFactor(CodeAlignmentFactor), 60a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) DataAlignmentFactor(DataAlignmentFactor), 61a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) ReturnAddressRegister(ReturnAddressRegister) {} 62a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 63a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) ~CIE() { 64a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) } 65a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 66a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) void dumpHeader(raw_ostream &OS) const { 67a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) OS << format("%08x %08x %08x CIE", 685c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu (uint32_t)Offset, (uint32_t)Length, DW_CIE_ID) 695c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu << "\n"; 705c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu OS << format(" Version: %d\n", Version); 71a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) OS << " Augmentation: \"" << Augmentation << "\"\n"; 72a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) OS << format(" Code alignment factor: %u\n", CodeAlignmentFactor); 73a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) OS << format(" Data alignment factor: %d\n", DataAlignmentFactor); 74effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch OS << format(" Return address column: %d\n", ReturnAddressRegister); 75effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch OS << "\n"; 76effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch } 77a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 78a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) static bool classof(const FrameEntry *FE) { 79a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) return FE->getKind() == FK_CIE; 8078901d17b47ef1f8d6d0a89eaf37f9523ba1de85Ben Murdoch } 8178901d17b47ef1f8d6d0a89eaf37f9523ba1de85Ben Murdoch 8278901d17b47ef1f8d6d0a89eaf37f9523ba1de85Ben Murdochprivate: 83a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) /// The following fields are defined in section 6.4.1 of the DWARF standard v3 84 uint8_t Version; 85 SmallString<8> Augmentation; 86 uint64_t CodeAlignmentFactor; 87 int64_t DataAlignmentFactor; 88 uint64_t ReturnAddressRegister; 89}; 90 91 92/// \brief DWARF Frame Description Entry (FDE) 93class FDE : public FrameEntry { 94public: 95 // Each FDE has a CIE it's "linked to". Our FDE contains is constructed with 96 // an offset to the CIE (provided by parsing the FDE header). The CIE itself 97 // is obtained lazily once it's actually required. 98 FDE(DataExtractor D, uint64_t Offset, uint64_t Length, 99 int64_t LinkedCIEOffset, uint64_t InitialLocation, uint64_t AddressRange) 100 : FrameEntry(FK_FDE, D, Offset, Length), LinkedCIEOffset(LinkedCIEOffset), 101 InitialLocation(InitialLocation), AddressRange(AddressRange), 102 LinkedCIE(NULL) {} 103 104 ~FDE() { 105 } 106 107 void dumpHeader(raw_ostream &OS) const { 108 OS << format("%08x %08x %08x FDE ", 109 (uint32_t)Offset, (uint32_t)Length, (int32_t)LinkedCIEOffset); 110 OS << format("cie=%08x pc=%08x...%08x\n", 111 (int32_t)LinkedCIEOffset, 112 (uint32_t)InitialLocation, 113 (uint32_t)InitialLocation + (uint32_t)AddressRange); 114 OS << "\n"; 115 if (LinkedCIE) { 116 OS << format("%p\n", LinkedCIE); 117 } 118 } 119 120 static bool classof(const FrameEntry *FE) { 121 return FE->getKind() == FK_FDE; 122 } 123private: 124 125 /// The following fields are defined in section 6.4.1 of the DWARF standard v3 126 uint64_t LinkedCIEOffset; 127 uint64_t InitialLocation; 128 uint64_t AddressRange; 129 CIE *LinkedCIE; 130}; 131 132 133DWARFDebugFrame::DWARFDebugFrame() { 134} 135 136 137DWARFDebugFrame::~DWARFDebugFrame() { 138 for (EntryVector::iterator I = Entries.begin(), E = Entries.end(); 139 I != E; ++I) { 140 delete *I; 141 } 142} 143 144 145static void LLVM_ATTRIBUTE_UNUSED dumpDataAux(DataExtractor Data, 146 uint32_t Offset, int Length) { 147 errs() << "DUMP: "; 148 for (int i = 0; i < Length; ++i) { 149 uint8_t c = Data.getU8(&Offset); 150 errs().write_hex(c); errs() << " "; 151 } 152 errs() << "\n"; 153} 154 155 156void DWARFDebugFrame::parse(DataExtractor Data) { 157 uint32_t Offset = 0; 158 159 while (Data.isValidOffset(Offset)) { 160 uint32_t StartOffset = Offset; 161 162 bool IsDWARF64 = false; 163 uint64_t Length = Data.getU32(&Offset); 164 uint64_t Id; 165 166 if (Length == UINT32_MAX) { 167 // DWARF-64 is distinguished by the first 32 bits of the initial length 168 // field being 0xffffffff. Then, the next 64 bits are the actual entry 169 // length. 170 IsDWARF64 = true; 171 Length = Data.getU64(&Offset); 172 } 173 174 // At this point, Offset points to the next field after Length. 175 // Length is the structure size excluding itself. Compute an offset one 176 // past the end of the structure (needed to know how many instructions to 177 // read). 178 // TODO: For honest DWARF64 support, DataExtractor will have to treat 179 // offset_ptr as uint64_t* 180 uint32_t EndStructureOffset = Offset + static_cast<uint32_t>(Length); 181 182 // The Id field's size depends on the DWARF format 183 Id = Data.getUnsigned(&Offset, IsDWARF64 ? 8 : 4); 184 bool IsCIE = ((IsDWARF64 && Id == DW64_CIE_ID) || Id == DW_CIE_ID); 185 186 if (IsCIE) { 187 // Note: this is specifically DWARFv3 CIE header structure. It was 188 // changed in DWARFv4. 189 uint8_t Version = Data.getU8(&Offset); 190 const char *Augmentation = Data.getCStr(&Offset); 191 uint64_t CodeAlignmentFactor = Data.getULEB128(&Offset); 192 int64_t DataAlignmentFactor = Data.getSLEB128(&Offset); 193 uint64_t ReturnAddressRegister = Data.getULEB128(&Offset); 194 195 CIE *NewCIE = new CIE(Data, StartOffset, Length, Version, 196 StringRef(Augmentation), CodeAlignmentFactor, 197 DataAlignmentFactor, ReturnAddressRegister); 198 Entries.push_back(NewCIE); 199 } else { 200 // FDE 201 uint64_t CIEPointer = Id; 202 uint64_t InitialLocation = Data.getAddress(&Offset); 203 uint64_t AddressRange = Data.getAddress(&Offset); 204 205 FDE *NewFDE = new FDE(Data, StartOffset, Length, CIEPointer, 206 InitialLocation, AddressRange); 207 Entries.push_back(NewFDE); 208 } 209 210 Offset = EndStructureOffset; 211 } 212} 213 214 215void DWARFDebugFrame::dump(raw_ostream &OS) const { 216 OS << "\n"; 217 for (EntryVector::const_iterator I = Entries.begin(), E = Entries.end(); 218 I != E; ++I) { 219 (*I)->dumpHeader(OS); 220 } 221} 222 223