SymbolFile.h revision c617a4cb4a451be9d7e97d7af6e165d282b5390f
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), 3324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner CompileUnits = (1 << 6), 3424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner LineTables = (1 << 7), 3524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner LineColumns = (1 << 8), 3624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner Functions = (1 << 9), 3724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner Blocks = (1 << 10), 3824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner GlobalVariables = (1 << 11), 3924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner LocalVariables = (1 << 12), 4024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner VariableTypes = (1 << 13) 4124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner }; 4224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 4324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner static SymbolFile * 4424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner FindPlugin (ObjectFile* obj_file); 4524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 4624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 4724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Constructors and Destructors 4824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 4924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner SymbolFile(ObjectFile* obj_file) : 5024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner m_obj_file(obj_file) 5124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner { 5224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner } 5324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 5424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual 5524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner ~SymbolFile() 5624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner { 5724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner } 5824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 59b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 60b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Get a mask of what this symbol file supports for the object file 61b01000fd063629facd45044f137446fb748ee179Greg Clayton /// that it was constructed with. 62b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 63b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Each symbol file gets to respond with a mask of abilities that 64b01000fd063629facd45044f137446fb748ee179Greg Clayton /// it supports for each object file. This happens when we are 65b01000fd063629facd45044f137446fb748ee179Greg Clayton /// trying to figure out which symbol file plug-in will get used 66b01000fd063629facd45044f137446fb748ee179Greg Clayton /// for a given object file. The plug-in that resoonds with the 67b01000fd063629facd45044f137446fb748ee179Greg Clayton /// best mix of "SymbolFile::Abilities" bits set, will get chosen to 68b01000fd063629facd45044f137446fb748ee179Greg Clayton /// be the symbol file parser. This allows each plug-in to check for 69b01000fd063629facd45044f137446fb748ee179Greg Clayton /// sections that contain data a symbol file plug-in would need. For 70b01000fd063629facd45044f137446fb748ee179Greg Clayton /// example the DWARF plug-in requires DWARF sections in a file that 71b01000fd063629facd45044f137446fb748ee179Greg Clayton /// contain debug information. If the DWARF plug-in doesn't find 72b01000fd063629facd45044f137446fb748ee179Greg Clayton /// these sections, it won't respond with many ability bits set, and 73b01000fd063629facd45044f137446fb748ee179Greg Clayton /// we will probably fall back to the symbol table SymbolFile plug-in 74b01000fd063629facd45044f137446fb748ee179Greg Clayton /// which uses any information in the symbol table. Also, plug-ins 75b01000fd063629facd45044f137446fb748ee179Greg Clayton /// might check for some specific symbols in a symbol table in the 76b01000fd063629facd45044f137446fb748ee179Greg Clayton /// case where the symbol table contains debug information (STABS 77b01000fd063629facd45044f137446fb748ee179Greg Clayton /// and COFF). Not a lot of work should happen in these functions 78b01000fd063629facd45044f137446fb748ee179Greg Clayton /// as the plug-in might not get selected due to another plug-in 79b01000fd063629facd45044f137446fb748ee179Greg Clayton /// having more abilities. Any initialization work should be saved 80b01000fd063629facd45044f137446fb748ee179Greg Clayton /// for "void SymbolFile::InitializeObject()" which will get called 81b01000fd063629facd45044f137446fb748ee179Greg Clayton /// on the SymbolFile object with the best set of abilities. 82b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 83b01000fd063629facd45044f137446fb748ee179Greg Clayton /// @return 84b01000fd063629facd45044f137446fb748ee179Greg Clayton /// A uint32_t mask containing bits from the SymbolFile::Abilities 85b01000fd063629facd45044f137446fb748ee179Greg Clayton /// enumeration. Any bits that are set represent an ability that 86b01000fd063629facd45044f137446fb748ee179Greg Clayton /// this symbol plug-in can parse from the object file. 87b01000fd063629facd45044f137446fb748ee179Greg Clayton ///------------------------------------------------------------------ 8824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t GetAbilities () = 0; 89b01000fd063629facd45044f137446fb748ee179Greg Clayton 90b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 91b01000fd063629facd45044f137446fb748ee179Greg Clayton /// Initialize the SymbolFile object. 92b01000fd063629facd45044f137446fb748ee179Greg Clayton /// 93b01000fd063629facd45044f137446fb748ee179Greg Clayton /// The SymbolFile object with the best set of abilities (detected 94b01000fd063629facd45044f137446fb748ee179Greg Clayton /// in "uint32_t SymbolFile::GetAbilities()) will have this function 95b01000fd063629facd45044f137446fb748ee179Greg Clayton /// called if it is chosen to parse an object file. More complete 96b01000fd063629facd45044f137446fb748ee179Greg Clayton /// initialization can happen in this function which will get called 97b01000fd063629facd45044f137446fb748ee179Greg Clayton /// prior to any other functions in the SymbolFile protocol. 98b01000fd063629facd45044f137446fb748ee179Greg Clayton //------------------------------------------------------------------ 99b01000fd063629facd45044f137446fb748ee179Greg Clayton virtual void InitializeObject() {} 10024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 10124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 10224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Compile Unit function calls 10324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 10424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Approach 1 - iterator 10524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t GetNumCompileUnits() = 0; 10624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) = 0; 10724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 10824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseCompileUnitFunctions (const SymbolContext& sc) = 0; 10924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual bool ParseCompileUnitLineTable (const SymbolContext& sc) = 0; 11024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual bool ParseCompileUnitSupportFiles (const SymbolContext& sc, FileSpecList& support_files) = 0; 11124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseFunctionBlocks (const SymbolContext& sc) = 0; 11224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseTypes (const SymbolContext& sc) = 0; 11324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual size_t ParseVariablesForContext (const SymbolContext& sc) = 0; 11424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual Type* ResolveTypeUID (lldb::user_id_t type_uid) = 0; 115462d4147f3bb9141bf62d904f58a623db00669dfGreg Clayton virtual lldb::clang_type_t ResolveClangOpaqueTypeDefinition (lldb::clang_type_t clang_type) = 0; 116c617a4cb4a451be9d7e97d7af6e165d282b5390fSean Callanan virtual clang::DeclContext* GetClangDeclContextForTypeUID (const lldb_private::SymbolContext &sc, lldb::user_id_t type_uid) { return NULL; } 117c617a4cb4a451be9d7e97d7af6e165d282b5390fSean Callanan virtual clang::DeclContext* GetClangDeclContextContainingTypeUID (lldb::user_id_t type_uid) { return NULL; } 11824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t ResolveSymbolContext (const Address& so_addr, uint32_t resolve_scope, SymbolContext& sc) = 0; 11924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t ResolveSymbolContext (const FileSpec& file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list) = 0; 12024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t FindGlobalVariables (const ConstString &name, bool append, uint32_t max_matches, VariableList& variables) = 0; 12124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t FindGlobalVariables (const RegularExpression& regex, bool append, uint32_t max_matches, VariableList& variables) = 0; 12212bec71b323dc520f0e985a86e09c4712559e115Greg Clayton virtual uint32_t FindFunctions (const ConstString &name, uint32_t name_type_mask, bool append, SymbolContextList& sc_list) = 0; 12324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual uint32_t FindFunctions (const RegularExpression& regex, bool append, SymbolContextList& sc_list) = 0; 124960d6a40711f05effe6fcc5b66f0952450f79ea2Greg Clayton virtual uint32_t FindTypes (const SymbolContext& sc, const ConstString &name, bool append, uint32_t max_matches, TypeList& types) = 0; 125960d6a40711f05effe6fcc5b66f0952450f79ea2Greg Clayton// virtual uint32_t FindTypes (const SymbolContext& sc, const RegularExpression& regex, bool append, uint32_t max_matches, TypeList& types) = 0; 126e98ac25604b3d967158917f6fdd5289b3096fd80Greg Clayton virtual TypeList * GetTypeList (); 127b01000fd063629facd45044f137446fb748ee179Greg Clayton virtual ClangASTContext & 128b01000fd063629facd45044f137446fb748ee179Greg Clayton GetClangASTContext (); 1296916e358c9725b75ed91f31236c147f26c9af10eGreg Clayton virtual ClangNamespaceDecl 130d7cb26e87841731c6452a9f2e997ed0f9c92625cGreg Clayton FindNamespace (const SymbolContext& sc, 131d7cb26e87841731c6452a9f2e997ed0f9c92625cGreg Clayton const ConstString &name) = 0; 13224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 133960d6a40711f05effe6fcc5b66f0952450f79ea2Greg Clayton ObjectFile* GetObjectFile() { return m_obj_file; } 13424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner const ObjectFile* GetObjectFile() const { return m_obj_file; } 13524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerprotected: 136b01000fd063629facd45044f137446fb748ee179Greg Clayton ObjectFile* m_obj_file; // The object file that symbols can be extracted from. 13724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 13824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerprivate: 13924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner DISALLOW_COPY_AND_ASSIGN (SymbolFile); 14024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner}; 14124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 14224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 14324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner} // namespace lldb_private 14424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 14524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#endif // liblldb_SymbolFile_h_ 146