172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer//===-- DWARFCompileUnit.h --------------------------------------*- C++ -*-===// 272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// 372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// The LLVM Compiler Infrastructure 472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// 572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// This file is distributed under the University of Illinois Open Source 672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// License. See LICENSE.TXT for details. 772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer// 872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer//===----------------------------------------------------------------------===// 972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 1072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#ifndef LLVM_DEBUGINFO_DWARFCOMPILEUNIT_H 1172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#define LLVM_DEBUGINFO_DWARFCOMPILEUNIT_H 1272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 1372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#include "DWARFDebugAbbrev.h" 1472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#include "DWARFDebugInfoEntry.h" 155eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov#include "DWARFDebugRangeList.h" 1672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#include <vector> 1772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 1872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramernamespace llvm { 1972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 2072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramerclass DWARFContext; 2172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramerclass raw_ostream; 2272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 2372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramerclass DWARFCompileUnit { 2472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DWARFContext &Context; 2572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 2672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t Offset; 2772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t Length; 2872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint16_t Version; 2972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer const DWARFAbbreviationDeclarationSet *Abbrevs; 3072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint8_t AddrSize; 3172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint64_t BaseAddr; 3272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // The compile unit debug information entry item. 3372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer std::vector<DWARFDebugInfoEntryMinimal> DieArray; 3472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramerpublic: 3572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DWARFCompileUnit(DWARFContext &context) : Context(context) { 3672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer clear(); 3772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer } 3872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 3972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DWARFContext &getContext() const { return Context; } 4072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DataExtractor getDebugInfoExtractor() const; 4172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 4272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer bool extract(DataExtractor debug_info, uint32_t* offset_ptr); 4372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t extract(uint32_t offset, DataExtractor debug_info_data, 4472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer const DWARFAbbreviationDeclarationSet *abbrevs); 4572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 4672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// extractDIEsIfNeeded - Parses a compile unit and indexes its DIEs if it 47a9543aadffcee08d1e49ec9b6904db55671f71f3Alexey Samsonov /// hasn't already been done. Returns the number of DIEs parsed at this call. 4872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer size_t extractDIEsIfNeeded(bool cu_die_only); 495eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov /// extractRangeList - extracts the range list referenced by this compile 505eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov /// unit from .debug_ranges section. Returns true on success. 515eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov /// Requires that compile unit is already extracted. 525eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov bool extractRangeList(uint32_t RangeListOffset, 535eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov DWARFDebugRangeList &RangeList) const; 5472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer void clear(); 5572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer void dump(raw_ostream &OS); 5672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t getOffset() const { return Offset; } 5772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// Size in bytes of the compile unit header. 5872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t getSize() const { return 11; } 5972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer bool containsDIEOffset(uint32_t die_offset) const { 6072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer return die_offset >= getFirstDIEOffset() && 6172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer die_offset < getNextCompileUnitOffset(); 6272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer } 6372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t getFirstDIEOffset() const { return Offset + getSize(); } 6472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t getNextCompileUnitOffset() const { return Offset + Length + 4; } 6572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// Size in bytes of the .debug_info data associated with this compile unit. 6672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer size_t getDebugInfoSize() const { return Length + 4 - getSize(); } 6772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint32_t getLength() const { return Length; } 6872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint16_t getVersion() const { return Version; } 6972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer const DWARFAbbreviationDeclarationSet *getAbbreviations() const { 7072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer return Abbrevs; 7172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer } 7272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint8_t getAddressByteSize() const { return AddrSize; } 7372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer uint64_t getBaseAddress() const { return BaseAddr; } 7472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 7572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer void setBaseAddress(uint64_t base_addr) { 7672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer BaseAddr = base_addr; 7772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer } 7872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 79fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer const DWARFDebugInfoEntryMinimal * 80fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer getCompileUnitDIE(bool extract_cu_die_only = true) { 81fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer extractDIEsIfNeeded(extract_cu_die_only); 82fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer if (DieArray.empty()) 83fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer return NULL; 84fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer return &DieArray[0]; 85fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer } 86fe80f1da404d25f93e4a2492b127554a882bd5bbBenjamin Kramer 8771d94f805514f28730bf39143ee227648d521d09Alexey Samsonov const char *getCompilationDir(); 8871d94f805514f28730bf39143ee227648d521d09Alexey Samsonov 8972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// setDIERelations - We read in all of the DIE entries into our flat list 9072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// of DIE entries and now we need to go back through all of them and set the 9172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer /// parent, sibling and child pointers for quick DIE navigation. 9272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer void setDIERelations(); 9372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 9472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer void addDIE(DWARFDebugInfoEntryMinimal &die) { 9572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // The average bytes per DIE entry has been seen to be 9672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // around 14-20 so lets pre-reserve the needed memory for 9772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // our DIE entries accordingly. Search forward for "Compute 9872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // average bytes per DIE" to see #if'ed out code that does 9972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // that determination. 10072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 10172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // Only reserve the memory if we are adding children of 10272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // the main compile unit DIE. The compile unit DIE is always 10372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // the first entry, so if our size is 1, then we are adding 10472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // the first compile unit child DIE and should reserve 10572c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer // the memory. 10672c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer if (DieArray.empty()) 10772c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DieArray.reserve(getDebugInfoSize() / 14); 10872c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer DieArray.push_back(die); 10972c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer } 11010df80692cc1594fb06fc02cae6eba177123cfd9Benjamin Kramer 11110df80692cc1594fb06fc02cae6eba177123cfd9Benjamin Kramer void clearDIEs(bool keep_compile_unit_die); 11210df80692cc1594fb06fc02cae6eba177123cfd9Benjamin Kramer 11310df80692cc1594fb06fc02cae6eba177123cfd9Benjamin Kramer void buildAddressRangeTable(DWARFDebugAranges *debug_aranges, 11410df80692cc1594fb06fc02cae6eba177123cfd9Benjamin Kramer bool clear_dies_if_already_not_parsed); 1155eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov 1165eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov /// getInlinedChainForAddress - fetches inlined chain for a given address. 1175eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov /// Returns empty chain if there is no subprogram containing address. 1185eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov DWARFDebugInfoEntryMinimal::InlinedChain getInlinedChainForAddress( 1195eae90d727c64ca5b4b43b110521b38dcd9f0de6Alexey Samsonov uint64_t Address); 12072c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer}; 12172c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 12272c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer} 12372c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer 12472c0d7fdd3d0930c7507060e96aec7d7429a8190Benjamin Kramer#endif 125