SymbolFile.h revision d0b7cfa22722fdaf4111a61d6eeb02a587710e16
124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//===-- SymbolFile.h --------------------------------------------*- C++ -*-===// 224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// The LLVM Compiler Infrastructure 424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// This file is distributed under the University of Illinois Open Source 624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// License. See LICENSE.TXT for details. 724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//===----------------------------------------------------------------------===// 924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#ifndef liblldb_SymbolFile_h_ 1124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#define liblldb_SymbolFile_h_ 1224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#include "lldb/lldb-private.h" 1424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#include "lldb/Core/PluginInterface.h" 156916e358c9725b75ed91f31236c147f26c9af10eGreg Clayton#include "lldb/Symbol/ClangASTType.h" 166916e358c9725b75ed91f31236c147f26c9af10eGreg Clayton#include "lldb/Symbol/ClangNamespaceDecl.h" 1724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#include "lldb/Symbol/Type.h" 1824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnernamespace lldb_private { 2024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 2124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerclass SymbolFile : 2224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner public PluginInterface 2324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner{ 2424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerpublic: 2524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner enum Abilities 2624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner { 2724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner Labels = (1 << 0), 2824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner AddressAcceleratorTable = (1 << 1), 2924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner FunctionAcceleratorTable = (1 << 2), 3024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner TypeAcceleratorTable = (1 << 3), 3124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner MacroInformation = (1 << 4), 3224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner CallFrameInformation = (1 << 5), 33673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan RuntimeTypes = (1 << 6), 34673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan CompileUnits = (1 << 7), 35673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan LineTables = (1 << 8), 36673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan LineColumns = (1 << 9), 37673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan Functions = (1 << 10), 38673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan Blocks = (1 << 11), 39673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan GlobalVariables = (1 << 12), 40673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan LocalVariables = (1 << 13), 41673f3dbea64b116166dfa668006cdc84224a27c0Sean Callanan VariableTypes = (1 << 14), 4224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner }; 4324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 4424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner static SymbolFile * 4524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner FindPlugin (ObjectFile* obj_file); 4624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 4724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 4824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Constructors and Destructors 4924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 5024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner SymbolFile(ObjectFile* obj_file) : 51d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan m_obj_file(obj_file), 52d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan m_abilities(0), 53d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan m_calculated_abilities(false) 5424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner { 5524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner } 5624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 5724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual 5824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner ~SymbolFile() 5924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner { 6024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner } 6124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 62b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 63b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Get a mask of what this symbol file supports for the object file 64b01000fd063629facd45044f137446fb748ee179Greg Clayton /// that it was constructed with. 65b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 66b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Each symbol file gets to respond with a mask of abilities that 67b01000fd063629facd45044f137446fb748ee179Greg Clayton /// it supports for each object file. This happens when we are 68b01000fd063629facd45044f137446fb748ee179Greg Clayton /// trying to figure out which symbol file plug-in will get used 69b01000fd063629facd45044f137446fb748ee179Greg Clayton /// for a given object file. The plug-in that resoonds with the 70b01000fd063629facd45044f137446fb748ee179Greg Clayton /// best mix of "SymbolFile::Abilities" bits set, will get chosen to 71b01000fd063629facd45044f137446fb748ee179Greg Clayton /// be the symbol file parser. This allows each plug-in to check for 72b01000fd063629facd45044f137446fb748ee179Greg Clayton /// sections that contain data a symbol file plug-in would need. For 73b01000fd063629facd45044f137446fb748ee179Greg Clayton /// example the DWARF plug-in requires DWARF sections in a file that 74b01000fd063629facd45044f137446fb748ee179Greg Clayton /// contain debug information. If the DWARF plug-in doesn't find 75b01000fd063629facd45044f137446fb748ee179Greg Clayton /// these sections, it won't respond with many ability bits set, and 76b01000fd063629facd45044f137446fb748ee179Greg Clayton /// we will probably fall back to the symbol table SymbolFile plug-in 77b01000fd063629facd45044f137446fb748ee179Greg Clayton /// which uses any information in the symbol table. Also, plug-ins 78b01000fd063629facd45044f137446fb748ee179Greg Clayton /// might check for some specific symbols in a symbol table in the 79b01000fd063629facd45044f137446fb748ee179Greg Clayton /// case where the symbol table contains debug information (STABS 80b01000fd063629facd45044f137446fb748ee179Greg Clayton /// and COFF). Not a lot of work should happen in these functions 81b01000fd063629facd45044f137446fb748ee179Greg Clayton /// as the plug-in might not get selected due to another plug-in 82b01000fd063629facd45044f137446fb748ee179Greg Clayton /// having more abilities. Any initialization work should be saved 83b01000fd063629facd45044f137446fb748ee179Greg Clayton /// for "void SymbolFile::InitializeObject()" which will get called 84b01000fd063629facd45044f137446fb748ee179Greg Clayton /// on the SymbolFile object with the best set of abilities. 85b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 86b01000fd063629facd45044f137446fb748ee179Greg Clayton /// @return 87b01000fd063629facd45044f137446fb748ee179Greg Clayton /// A uint32_t mask containing bits from the SymbolFile::Abilities 88b01000fd063629facd45044f137446fb748ee179Greg Clayton /// enumeration. Any bits that are set represent an ability that 89b01000fd063629facd45044f137446fb748ee179Greg Clayton /// this symbol plug-in can parse from the object file. 90b01000fd063629facd45044f137446fb748ee179Greg Clayton ///------------------------------------------------------------------ 91d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan uint32_t GetAbilities () 92d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan { 93d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan if (!m_calculated_abilities) 94d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan { 95d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan m_abilities = CalculateAbilities(); 96d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan m_calculated_abilities = true; 97d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan } 98d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan 99d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan return m_abilities; 100d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan } 101d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan 102d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan virtual uint32_t CalculateAbilities() = 0; 103b01000fd063629facd45044f137446fb748ee179Greg Clayton 104b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 105b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Initialize the SymbolFile object. 106b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 107b01000fd063629facd45044f137446fb748ee179Greg Clayton /// The SymbolFile object with the best set of abilities (detected 108b01000fd063629facd45044f137446fb748ee179Greg Clayton /// in "uint32_t SymbolFile::GetAbilities()) will have this function 109b01000fd063629facd45044f137446fb748ee179Greg Clayton /// called if it is chosen to parse an object file. More complete 110b01000fd063629facd45044f137446fb748ee179Greg Clayton /// initialization can happen in this function which will get called 111b01000fd063629facd45044f137446fb748ee179Greg Clayton /// prior to any other functions in the SymbolFile protocol. 112b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 113b01000fd063629facd45044f137446fb748ee179Greg Clayton virtual void InitializeObject() {} 11424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 11524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 11624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Compile Unit function calls 11724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 11824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Approach 1 - iterator 11924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t GetNumCompileUnits() = 0; 12024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) = 0; 12124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 12224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseCompileUnitFunctions (const SymbolContext& sc) = 0; 12324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual bool ParseCompileUnitLineTable (const SymbolContext& sc) = 0; 12424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual bool ParseCompileUnitSupportFiles (const SymbolContext& sc, FileSpecList& support_files) = 0; 12524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseFunctionBlocks (const SymbolContext& sc) = 0; 12624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseTypes (const SymbolContext& sc) = 0; 12724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseVariablesForContext (const SymbolContext& sc) = 0; 12824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual Type* ResolveTypeUID (lldb::user_id_t type_uid) = 0; 129462d4147f3bb9141bf62d904f58a623db00669dfGreg Clayton virtual lldb::clang_type_t ResolveClangOpaqueTypeDefinition (lldb::clang_type_t clang_type) = 0; 130c617a4cb4a451be9d7e97d7af6e165d282b5390fSean Callanan virtual clang::DeclContext* GetClangDeclContextForTypeUID (const lldb_private::SymbolContext &sc, lldb::user_id_t type_uid) { return NULL; } 131c617a4cb4a451be9d7e97d7af6e165d282b5390fSean Callanan virtual clang::DeclContext* GetClangDeclContextContainingTypeUID (lldb::user_id_t type_uid) { return NULL; } 13224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t ResolveSymbolContext (const Address& so_addr, uint32_t resolve_scope, SymbolContext& sc) = 0; 13324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t ResolveSymbolContext (const FileSpec& file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list) = 0; 1340fcec13c6639ab49216fa9447b25888b7bc9ff59Sean Callanan virtual uint32_t FindGlobalVariables (const ConstString &name, const ClangNamespaceDecl *namespace_decl, bool append, uint32_t max_matches, VariableList& variables) = 0; 13524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t FindGlobalVariables (const RegularExpression& regex, bool append, uint32_t max_matches, VariableList& variables) = 0; 1360fcec13c6639ab49216fa9447b25888b7bc9ff59Sean Callanan virtual uint32_t FindFunctions (const ConstString &name, const ClangNamespaceDecl *namespace_decl, uint32_t name_type_mask, bool append, SymbolContextList& sc_list) = 0; 13724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t FindFunctions (const RegularExpression& regex, bool append, SymbolContextList& sc_list) = 0; 1380fcec13c6639ab49216fa9447b25888b7bc9ff59Sean Callanan virtual uint32_t FindTypes (const SymbolContext& sc, const ConstString &name, const ClangNamespaceDecl *namespace_decl, bool append, uint32_t max_matches, TypeList& types) = 0; 139960d6a40711f05effe6fcc5b66f0952450f79ea2Greg Clayton// virtual uint32_t FindTypes (const SymbolContext& sc, const RegularExpression& regex, bool append, uint32_t max_matches, TypeList& types) = 0; 140e98ac25604b3d967158917f6fdd5289b3096fd80Greg Clayton virtual TypeList * GetTypeList (); 141b01000fd063629facd45044f137446fb748ee179Greg Clayton virtual ClangASTContext & 142b01000fd063629facd45044f137446fb748ee179Greg Clayton GetClangASTContext (); 1436916e358c9725b75ed91f31236c147f26c9af10eGreg Clayton virtual ClangNamespaceDecl 144d7cb26e87841731c6452a9f2e997ed0f9c92625cGreg Clayton FindNamespace (const SymbolContext& sc, 1450fcec13c6639ab49216fa9447b25888b7bc9ff59Sean Callanan const ConstString &name, 1460fcec13c6639ab49216fa9447b25888b7bc9ff59Sean Callanan const ClangNamespaceDecl *parent_namespace_decl) = 0; 14724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 148960d6a40711f05effe6fcc5b66f0952450f79ea2Greg Clayton ObjectFile* GetObjectFile() { return m_obj_file; } 14924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner const ObjectFile* GetObjectFile() const { return m_obj_file; } 15075d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton 15175d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton // Special error functions that can do printf style formatting that will prepend the message with 15275d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton // something appropriate for this symbol file (like the architecture, path and object name). This 15375d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton // centralizes code so that everyone doesn't need to format their error and log messages on their 15475d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton // own and keeps the output a bit more consistent. 15575d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton void LogMessage (Log *log, const char *format, ...) __attribute__ ((format (printf, 3, 4))); 15675d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton void ReportWarning (const char *format, ...) __attribute__ ((format (printf, 2, 3))); 15775d8c2591f6c56a09338bf4967a41510165a907eGreg Clayton void ReportError (const char *format, ...) __attribute__ ((format (printf, 2, 3))); 15824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerprotected: 159b01000fd063629facd45044f137446fb748ee179Greg Clayton ObjectFile* m_obj_file; // The object file that symbols can be extracted from. 160d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan uint32_t m_abilities; 161d0b7cfa22722fdaf4111a61d6eeb02a587710e16Sean Callanan bool m_calculated_abilities; 16224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerprivate: 16324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner DISALLOW_COPY_AND_ASSIGN (SymbolFile); 16424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner}; 16524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 16624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 16724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner} // namespace lldb_private 16824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 16924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#endif // liblldb_SymbolFile_h_ 170