1 //===- SymbolizableObjectFile.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 // This file declares the SymbolizableObjectFile class. 10 // 11 //===----------------------------------------------------------------------===// 12 #ifndef LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H 13 #define LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H 14 15 #include "llvm/ADT/StringRef.h" 16 #include "llvm/DebugInfo/DIContext.h" 17 #include "llvm/DebugInfo/Symbolize/SymbolizableModule.h" 18 #include "llvm/Support/Error.h" 19 #include <cstdint> 20 #include <memory> 21 #include <string> 22 #include <utility> 23 #include <vector> 24 25 namespace llvm { 26 27 class DataExtractor; 28 29 namespace symbolize { 30 31 class SymbolizableObjectFile : public SymbolizableModule { 32 public: 33 static Expected<std::unique_ptr<SymbolizableObjectFile>> 34 create(const object::ObjectFile *Obj, std::unique_ptr<DIContext> DICtx, 35 bool UntagAddresses); 36 37 DILineInfo symbolizeCode(object::SectionedAddress ModuleOffset, 38 DILineInfoSpecifier LineInfoSpecifier, 39 bool UseSymbolTable) const override; 40 DIInliningInfo symbolizeInlinedCode(object::SectionedAddress ModuleOffset, 41 DILineInfoSpecifier LineInfoSpecifier, 42 bool UseSymbolTable) const override; 43 DIGlobal symbolizeData(object::SectionedAddress ModuleOffset) const override; 44 std::vector<DILocal> 45 symbolizeFrame(object::SectionedAddress ModuleOffset) const override; 46 std::vector<object::SectionedAddress> 47 findSymbol(StringRef Symbol, uint64_t Offset) const override; 48 49 // Return true if this is a 32-bit x86 PE COFF module. 50 bool isWin32Module() const override; 51 52 // Returns the preferred base of the module, i.e. where the loader would place 53 // it in memory assuming there were no conflicts. 54 uint64_t getModulePreferredBase() const override; 55 56 private: 57 bool shouldOverrideWithSymbolTable(FunctionNameKind FNKind, 58 bool UseSymbolTable) const; 59 60 bool getNameFromSymbolTable(uint64_t Address, std::string &Name, 61 uint64_t &Addr, uint64_t &Size, 62 std::string &FileName) const; 63 // For big-endian PowerPC64 ELF, OpdAddress is the address of the .opd 64 // (function descriptor) section and OpdExtractor refers to its contents. 65 Error addSymbol(const object::SymbolRef &Symbol, uint64_t SymbolSize, 66 DataExtractor *OpdExtractor = nullptr, 67 uint64_t OpdAddress = 0); 68 Error addCoffExportSymbols(const object::COFFObjectFile *CoffObj); 69 70 /// Search for the first occurence of specified Address in ObjectFile. 71 uint64_t getModuleSectionIndexForAddress(uint64_t Address) const; 72 73 const object::ObjectFile *Module; 74 std::unique_ptr<DIContext> DebugInfoContext; 75 bool UntagAddresses; 76 77 struct SymbolDesc { 78 uint64_t Addr; 79 // If size is 0, assume that symbol occupies the whole memory range up to 80 // the following symbol. 81 uint64_t Size; 82 83 StringRef Name; 84 // Non-zero if this is an ELF local symbol. See the comment in 85 // getNameFromSymbolTable. 86 uint32_t ELFLocalSymIdx; 87 88 bool operator<(const SymbolDesc &RHS) const { 89 return Addr != RHS.Addr ? Addr < RHS.Addr : Size < RHS.Size; 90 } 91 }; 92 std::vector<SymbolDesc> Symbols; 93 // (index, filename) pairs of ELF STT_FILE symbols. 94 std::vector<std::pair<uint32_t, StringRef>> FileSymbols; 95 96 SymbolizableObjectFile(const object::ObjectFile *Obj, 97 std::unique_ptr<DIContext> DICtx, 98 bool UntagAddresses); 99 }; 100 101 } // end namespace symbolize 102 103 } // end namespace llvm 104 105 #endif // LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H 106