1 //===- DWARFObject.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 LLVM_DEBUGINFO_DWARF_DWARFOBJECT_H
10 #define LLVM_DEBUGINFO_DWARF_DWARFOBJECT_H
11 
12 #include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"
13 #include "llvm/DebugInfo/DWARF/DWARFSection.h"
14 #include "llvm/Object/ObjectFile.h"
15 
16 namespace llvm {
17 // This is responsible for low level access to the object file. It
18 // knows how to find the required sections and compute relocated
19 // values.
20 // The default implementations of the get<Section> methods return dummy values.
21 // This is to allow clients that only need some of those to implement just the
22 // ones they need. We can't use unreachable for as many cases because the parser
23 // implementation is eager and will call some of these methods even if the
24 // result is not used.
25 class DWARFObject {
26   DWARFSection Dummy;
27 
28 public:
29   virtual ~DWARFObject() = default;
getFileName()30   virtual StringRef getFileName() const { llvm_unreachable("unimplemented"); }
getFile()31   virtual const object::ObjectFile *getFile() const { return nullptr; }
getSectionNames()32   virtual ArrayRef<SectionName> getSectionNames() const { return {}; }
33   virtual bool isLittleEndian() const = 0;
getAddressSize()34   virtual uint8_t getAddressSize() const { llvm_unreachable("unimplemented"); }
35   virtual void
forEachInfoSections(function_ref<void (const DWARFSection &)> F)36   forEachInfoSections(function_ref<void(const DWARFSection &)> F) const {}
37   virtual void
forEachTypesSections(function_ref<void (const DWARFSection &)> F)38   forEachTypesSections(function_ref<void(const DWARFSection &)> F) const {}
getAbbrevSection()39   virtual StringRef getAbbrevSection() const { return ""; }
getLocSection()40   virtual const DWARFSection &getLocSection() const { return Dummy; }
getLoclistsSection()41   virtual const DWARFSection &getLoclistsSection() const { return Dummy; }
getArangesSection()42   virtual StringRef getArangesSection() const { return ""; }
getFrameSection()43   virtual const DWARFSection &getFrameSection() const { return Dummy; }
getEHFrameSection()44   virtual const DWARFSection &getEHFrameSection() const { return Dummy; }
getLineSection()45   virtual const DWARFSection &getLineSection() const { return Dummy; }
getLineStrSection()46   virtual StringRef getLineStrSection() const { return ""; }
getStrSection()47   virtual StringRef getStrSection() const { return ""; }
getRangesSection()48   virtual const DWARFSection &getRangesSection() const { return Dummy; }
getRnglistsSection()49   virtual const DWARFSection &getRnglistsSection() const { return Dummy; }
getMacroSection()50   virtual const DWARFSection &getMacroSection() const { return Dummy; }
getMacroDWOSection()51   virtual StringRef getMacroDWOSection() const { return ""; }
getMacinfoSection()52   virtual StringRef getMacinfoSection() const { return ""; }
getMacinfoDWOSection()53   virtual StringRef getMacinfoDWOSection() const { return ""; }
getPubnamesSection()54   virtual const DWARFSection &getPubnamesSection() const { return Dummy; }
getPubtypesSection()55   virtual const DWARFSection &getPubtypesSection() const { return Dummy; }
getGnuPubnamesSection()56   virtual const DWARFSection &getGnuPubnamesSection() const { return Dummy; }
getGnuPubtypesSection()57   virtual const DWARFSection &getGnuPubtypesSection() const { return Dummy; }
getStrOffsetsSection()58   virtual const DWARFSection &getStrOffsetsSection() const { return Dummy; }
59   virtual void
forEachInfoDWOSections(function_ref<void (const DWARFSection &)> F)60   forEachInfoDWOSections(function_ref<void(const DWARFSection &)> F) const {}
61   virtual void
forEachTypesDWOSections(function_ref<void (const DWARFSection &)> F)62   forEachTypesDWOSections(function_ref<void(const DWARFSection &)> F) const {}
getAbbrevDWOSection()63   virtual StringRef getAbbrevDWOSection() const { return ""; }
getLineDWOSection()64   virtual const DWARFSection &getLineDWOSection() const { return Dummy; }
getLocDWOSection()65   virtual const DWARFSection &getLocDWOSection() const { return Dummy; }
getLoclistsDWOSection()66   virtual const DWARFSection &getLoclistsDWOSection() const { return Dummy; }
getStrDWOSection()67   virtual StringRef getStrDWOSection() const { return ""; }
getStrOffsetsDWOSection()68   virtual const DWARFSection &getStrOffsetsDWOSection() const {
69     return Dummy;
70   }
getRangesDWOSection()71   virtual const DWARFSection &getRangesDWOSection() const { return Dummy; }
getRnglistsDWOSection()72   virtual const DWARFSection &getRnglistsDWOSection() const { return Dummy; }
getAddrSection()73   virtual const DWARFSection &getAddrSection() const { return Dummy; }
getAppleNamesSection()74   virtual const DWARFSection &getAppleNamesSection() const { return Dummy; }
getAppleTypesSection()75   virtual const DWARFSection &getAppleTypesSection() const { return Dummy; }
getAppleNamespacesSection()76   virtual const DWARFSection &getAppleNamespacesSection() const {
77     return Dummy;
78   }
getNamesSection()79   virtual const DWARFSection &getNamesSection() const { return Dummy; }
getAppleObjCSection()80   virtual const DWARFSection &getAppleObjCSection() const { return Dummy; }
getCUIndexSection()81   virtual StringRef getCUIndexSection() const { return ""; }
getGdbIndexSection()82   virtual StringRef getGdbIndexSection() const { return ""; }
getTUIndexSection()83   virtual StringRef getTUIndexSection() const { return ""; }
84   virtual Optional<RelocAddrEntry> find(const DWARFSection &Sec,
85                                         uint64_t Pos) const = 0;
86 };
87 
88 } // namespace llvm
89 #endif
90