1//===-- DIERef.h ------------------------------------------------*- C++ -*-===// 2// 3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4// See https://llvm.org/LICENSE.txt for license information. 5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6// 7//===----------------------------------------------------------------------===// 8 9#ifndef SymbolFileDWARF_DIERef_h_ 10#define SymbolFileDWARF_DIERef_h_ 11 12#include "lldb/Core/dwarf.h" 13#include "llvm/ADT/Optional.h" 14#include "llvm/Support/FormatProviders.h" 15#include <cassert> 16#include <vector> 17 18/// Identifies a DWARF debug info entry within a given Module. It contains three 19/// "coordinates": 20/// - dwo_num: identifies the dwo file in the Module. If this field is not set, 21/// the DIERef references the main file. 22/// - section: identifies the section of the debug info entry in the given file: 23/// debug_info or debug_types. 24/// - die_offset: The offset of the debug info entry as an absolute offset from 25/// the beginning of the section specified in the section field. 26class DIERef { 27public: 28 enum Section : uint8_t { DebugInfo, DebugTypes }; 29 30 DIERef(llvm::Optional<uint32_t> dwo_num, Section section, 31 dw_offset_t die_offset) 32 : m_dwo_num(dwo_num.getValueOr(0)), m_dwo_num_valid(bool(dwo_num)), 33 m_section(section), m_die_offset(die_offset) { 34 assert(this->dwo_num() == dwo_num && "Dwo number out of range?"); 35 } 36 37 llvm::Optional<uint32_t> dwo_num() const { 38 if (m_dwo_num_valid) 39 return m_dwo_num; 40 return llvm::None; 41 } 42 43 Section section() const { return static_cast<Section>(m_section); } 44 45 dw_offset_t die_offset() const { return m_die_offset; } 46 47private: 48 uint32_t m_dwo_num : 30; 49 uint32_t m_dwo_num_valid : 1; 50 uint32_t m_section : 1; 51 dw_offset_t m_die_offset; 52}; 53static_assert(sizeof(DIERef) == 8, ""); 54 55typedef std::vector<DIERef> DIEArray; 56 57namespace llvm { 58template<> struct format_provider<DIERef> { 59 static void format(const DIERef &ref, raw_ostream &OS, StringRef Style); 60}; 61} // namespace llvm 62 63#endif // SymbolFileDWARF_DIERef_h_ 64