include/lldb/Symbol/Symtab.h

   1 //===-- Symtab.h ------------------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10
  11 #ifndef liblldb_Symtab_h_
  12 #define liblldb_Symtab_h_
  13
  14 #include <vector>
  15
  16 #include "lldb/lldb-private.h"
  17 #include "lldb/Core/RangeMap.h"
  18 #include "lldb/Core/UniqueCStringMap.h"
  19 #include "lldb/Host/Mutex.h"
  20 #include "lldb/Symbol/Symbol.h"
  21
  22 namespace lldb_private {
  23
  24 class Symtab
  25 {
  26 public:
  27     typedef std::vector<uint32_t> IndexCollection;
  28     typedef UniqueCStringMap<uint32_t> NameToIndexMap;
  29
  30     typedef enum Debug {
  31         eDebugNo,   // Not a debug symbol
  32         eDebugYes,  // A debug symbol
  33         eDebugAny
  34     } Debug;
  35
  36     typedef enum Visibility {
  37         eVisibilityAny,
  38         eVisibilityExtern,
  39         eVisibilityPrivate
  40     } Visibility;
  41
  42                         Symtab(ObjectFile *objfile);
  43                         ~Symtab();
  44
  45             void        Reserve (size_t count);
  46             Symbol *    Resize (size_t count);
  47             uint32_t    AddSymbol(const Symbol& symbol);
  48             size_t      GetNumSymbols() const;
  49             void        SectionFileAddressesChanged ();
  50             void        Dump(Stream *s, Target *target, SortOrder sort_type);
  51             void        Dump(Stream *s, Target *target, std::vector<uint32_t>& indexes) const;
  52             uint32_t    GetIndexForSymbol (const Symbol *symbol) const;
  53             Mutex &     GetMutex ()
  54                         {
  55                             return m_mutex;
  56                         }
  57             Symbol *    FindSymbolByID (lldb::user_id_t uid) const;
  58             Symbol *    SymbolAtIndex (size_t idx);
  59     const   Symbol *    SymbolAtIndex (size_t idx) const;
  60             Symbol *    FindSymbolWithType (lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, uint32_t &start_idx);
  61             //----------------------------------------------------------------------
  62             /// Get the parent symbol for the given symbol.
  63             ///
  64             /// Many symbols in symbol tables are scoped by other symbols that
  65             /// contain one or more symbol. This function will look for such a
  66             /// containing symbol and return it if there is one.
  67             //----------------------------------------------------------------------
  68     const   Symbol *    GetParent (Symbol *symbol) const;
  69             uint32_t    AppendSymbolIndexesWithType (lldb::SymbolType symbol_type, std::vector<uint32_t>& indexes, uint32_t start_idx = 0, uint32_t end_index = UINT32_MAX) const;
  70             uint32_t    AppendSymbolIndexesWithTypeAndFlagsValue (lldb::SymbolType symbol_type, uint32_t flags_value, std::vector<uint32_t>& indexes, uint32_t start_idx = 0, uint32_t end_index = UINT32_MAX) const;
  71             uint32_t    AppendSymbolIndexesWithType (lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& matches, uint32_t start_idx = 0, uint32_t end_index = UINT32_MAX) const;
  72             uint32_t    AppendSymbolIndexesWithName (const ConstString& symbol_name, std::vector<uint32_t>& matches);
  73             uint32_t    AppendSymbolIndexesWithName (const ConstString& symbol_name, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& matches);
  74             uint32_t    AppendSymbolIndexesWithNameAndType (const ConstString& symbol_name, lldb::SymbolType symbol_type, std::vector<uint32_t>& matches);
  75             uint32_t    AppendSymbolIndexesWithNameAndType (const ConstString& symbol_name, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& matches);
  76             uint32_t    AppendSymbolIndexesMatchingRegExAndType (const RegularExpression &regex, lldb::SymbolType symbol_type, std::vector<uint32_t>& indexes);
  77             uint32_t    AppendSymbolIndexesMatchingRegExAndType (const RegularExpression &regex, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& indexes);
  78             size_t      FindAllSymbolsWithNameAndType (const ConstString &name, lldb::SymbolType symbol_type, std::vector<uint32_t>& symbol_indexes);
  79             size_t      FindAllSymbolsWithNameAndType (const ConstString &name, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& symbol_indexes);
  80             size_t      FindAllSymbolsMatchingRexExAndType (const RegularExpression &regex, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility, std::vector<uint32_t>& symbol_indexes);
  81             Symbol *    FindFirstSymbolWithNameAndType (const ConstString &name, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility);
  82             Symbol *    FindSymbolContainingFileAddress (lldb::addr_t file_addr, const uint32_t* indexes, uint32_t num_indexes);
  83             Symbol *    FindSymbolContainingFileAddress (lldb::addr_t file_addr);
  84             size_t      FindFunctionSymbols (const ConstString &name, uint32_t name_type_mask, SymbolContextList& sc_list);
  85             void        CalculateSymbolSizes ();
  86
  87             void        SortSymbolIndexesByValue (std::vector<uint32_t>& indexes, bool remove_duplicates) const;
  88
  89     static  void        DumpSymbolHeader (Stream *s);
  90
  91
  92             void        Finalize ()
  93                         {
  94                             // Shrink to fit the symbols so we don't waste memory
  95                             if (m_symbols.capacity() > m_symbols.size())
  96                             {
  97                                 collection new_symbols (m_symbols.begin(), m_symbols.end());
  98                                 m_symbols.swap (new_symbols);
  99                             }
 100                         }
 101
 102             void        AppendSymbolNamesToMap (const IndexCollection &indexes,
 103                                                 bool add_demangled,
 104                                                 bool add_mangled,
 105                                                 NameToIndexMap &name_to_index_map) const;
 106
 107     ObjectFile *        GetObjectFile()
 108                         {
 109                             return m_objfile;
 110                         }
 111 protected:
 112     typedef std::vector<Symbol>         collection;
 113     typedef collection::iterator        iterator;
 114     typedef collection::const_iterator  const_iterator;
 115     typedef RangeDataVector<lldb::addr_t, lldb::addr_t, uint32_t> FileRangeToIndexMap;
 116             void        InitNameIndexes ();
 117             void        InitAddressIndexes ();
 118
 119     ObjectFile *        m_objfile;
 120     collection          m_symbols;
 121     FileRangeToIndexMap m_file_addr_to_index;
 122     UniqueCStringMap<uint32_t> m_name_to_index;
 123     UniqueCStringMap<uint32_t> m_basename_to_index;
 124     UniqueCStringMap<uint32_t> m_method_to_index;
 125     UniqueCStringMap<uint32_t> m_selector_to_index;
 126     mutable Mutex       m_mutex; // Provide thread safety for this symbol table
 127     bool                m_file_addr_to_index_computed:1,
 128                         m_name_indexes_computed:1;
 129 private:
 130
 131     bool
 132     CheckSymbolAtIndex (size_t idx, Debug symbol_debug_type, Visibility symbol_visibility) const
 133     {
 134         switch (symbol_debug_type)
 135         {
 136         case eDebugNo:
 137             if (m_symbols[idx].IsDebug() == true)
 138                 return false;
 139             break;
 140
 141         case eDebugYes:
 142             if (m_symbols[idx].IsDebug() == false)
 143                 return false;
 144             break;
 145
 146         case eDebugAny:
 147             break;
 148         }
 149
 150         switch (symbol_visibility)
 151         {
 152         case eVisibilityAny:
 153             return true;
 154
 155         case eVisibilityExtern:
 156             return m_symbols[idx].IsExternal();
 157
 158         case eVisibilityPrivate:
 159             return !m_symbols[idx].IsExternal();
 160         }
 161         return false;
 162     }
 163
 164     void
 165     SymbolIndicesToSymbolContextList (std::vector<uint32_t> &symbol_indexes,
 166                                       SymbolContextList &sc_list);
 167
 168     DISALLOW_COPY_AND_ASSIGN (Symtab);
 169 };
 170
 171 } // namespace lldb_private
 172
 173 #endif  // liblldb_Symtab_h_