Module.cpp revision 808e92a12cf2b15ed5cb75e63de4ae0cbe997998 
1//===-- Module.cpp ----------------------------------------------*- 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#include "lldb/Core/Module.h"
11#include "lldb/Core/DataBuffer.h"
12#include "lldb/Core/DataBufferHeap.h"
13#include "lldb/Core/Log.h"
14#include "lldb/Core/ModuleList.h"
15#include "lldb/Core/RegularExpression.h"
16#include "lldb/Core/StreamString.h"
17#include "lldb/Core/Timer.h"
18#include "lldb/Host/Host.h"
19#include "lldb/lldb-private-log.h"
20#include "lldb/Symbol/ObjectFile.h"
21#include "lldb/Symbol/SymbolContext.h"
22#include "lldb/Symbol/SymbolVendor.h"
23#include "lldb/Target/Process.h"
24#include "lldb/Target/Target.h"
25
26using namespace lldb;
27using namespace lldb_private;
28
29// Shared pointers to modules track module lifetimes in
30// targets and in the global module, but this collection
31// will track all module objects that are still alive
32typedef std::vector<Module *> ModuleCollection;
33
34static ModuleCollection &
35GetModuleCollection()
36{
37    // This module collection needs to live past any module, so we could either make it a
38    // shared pointer in each module or just leak is.  Since it is only an empty vector by
39    // the time all the modules have gone away, we just leak it for now.  If we decide this
40    // is a big problem we can introduce a Finalize method that will tear everything down in
41    // a predictable order.
42
43    static ModuleCollection *g_module_collection = NULL;
44    if (g_module_collection == NULL)
45        g_module_collection = new ModuleCollection();
46
47    return *g_module_collection;
48}
49
50Mutex *
51Module::GetAllocationModuleCollectionMutex()
52{
53    // NOTE: The mutex below must be leaked since the global module list in
54    // the ModuleList class will get torn at some point, and we can't know
55    // if it will tear itself down before the "g_module_collection_mutex" below
56    // will. So we leak a Mutex object below to safeguard against that
57
58    static Mutex *g_module_collection_mutex = NULL;
59    if (g_module_collection_mutex == NULL)
60        g_module_collection_mutex = new Mutex (Mutex::eMutexTypeRecursive); // NOTE: known leak
61    return g_module_collection_mutex;
62}
63
64size_t
65Module::GetNumberAllocatedModules ()
66{
67    Mutex::Locker locker (GetAllocationModuleCollectionMutex());
68    return GetModuleCollection().size();
69}
70
71Module *
72Module::GetAllocatedModuleAtIndex (size_t idx)
73{
74    Mutex::Locker locker (GetAllocationModuleCollectionMutex());
75    ModuleCollection &modules = GetModuleCollection();
76    if (idx < modules.size())
77        return modules[idx];
78    return NULL;
79}
80#if 0
81
82// These functions help us to determine if modules are still loaded, yet don't require that
83// you have a command interpreter and can easily be called from an external debugger.
84namespace lldb {
85
86    void
87    ClearModuleInfo (void)
88    {
89        const bool mandatory = true;
90        ModuleList::RemoveOrphanSharedModules(mandatory);
91    }
92
93    void
94    DumpModuleInfo (void)
95    {
96        Mutex::Locker locker (Module::GetAllocationModuleCollectionMutex());
97        ModuleCollection &modules = GetModuleCollection();
98        const size_t count = modules.size();
99        printf ("%s: %zu modules:\n", __PRETTY_FUNCTION__, count);
100        for (size_t i=0; i<count; ++i)
101        {
102
103            StreamString strm;
104            Module *module = modules[i];
105            const bool in_shared_module_list = ModuleList::ModuleIsInCache (module);
106            module->GetDescription(&strm, eDescriptionLevelFull);
107            printf ("%p: shared = %i, ref_count = %3u, module = %s\n",
108                    module,
109                    in_shared_module_list,
110                    (uint32_t)module->use_count(),
111                    strm.GetString().c_str());
112        }
113    }
114}
115
116#endif
117
118Module::Module (const ModuleSpec &module_spec) :
119    m_mutex (Mutex::eMutexTypeRecursive),
120    m_mod_time (module_spec.GetFileSpec().GetModificationTime()),
121    m_arch (module_spec.GetArchitecture()),
122    m_uuid (),
123    m_file (module_spec.GetFileSpec()),
124    m_platform_file(module_spec.GetPlatformFileSpec()),
125    m_symfile_spec (module_spec.GetSymbolFileSpec()),
126    m_object_name (module_spec.GetObjectName()),
127    m_object_offset (module_spec.GetObjectOffset()),
128    m_objfile_sp (),
129    m_symfile_ap (),
130    m_ast (),
131    m_source_mappings (),
132    m_did_load_objfile (false),
133    m_did_load_symbol_vendor (false),
134    m_did_parse_uuid (false),
135    m_did_init_ast (false),
136    m_is_dynamic_loader_module (false),
137    m_was_modified (false)
138{
139    // Scope for locker below...
140    {
141        Mutex::Locker locker (GetAllocationModuleCollectionMutex());
142        GetModuleCollection().push_back(this);
143    }
144
145    LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
146    if (log)
147        log->Printf ("%p Module::Module((%s) '%s/%s%s%s%s')",
148                     this,
149                     m_arch.GetArchitectureName(),
150                     m_file.GetDirectory().AsCString(""),
151                     m_file.GetFilename().AsCString(""),
152                     m_object_name.IsEmpty() ? "" : "(",
153                     m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
154                     m_object_name.IsEmpty() ? "" : ")");
155}
156
157Module::Module(const FileSpec& file_spec,
158               const ArchSpec& arch,
159               const ConstString *object_name,
160               off_t object_offset) :
161    m_mutex (Mutex::eMutexTypeRecursive),
162    m_mod_time (file_spec.GetModificationTime()),
163    m_arch (arch),
164    m_uuid (),
165    m_file (file_spec),
166    m_platform_file(),
167    m_symfile_spec (),
168    m_object_name (),
169    m_object_offset (object_offset),
170    m_objfile_sp (),
171    m_symfile_ap (),
172    m_ast (),
173    m_source_mappings (),
174    m_did_load_objfile (false),
175    m_did_load_symbol_vendor (false),
176    m_did_parse_uuid (false),
177    m_did_init_ast (false),
178    m_is_dynamic_loader_module (false),
179    m_was_modified (false)
180{
181    // Scope for locker below...
182    {
183        Mutex::Locker locker (GetAllocationModuleCollectionMutex());
184        GetModuleCollection().push_back(this);
185    }
186
187    if (object_name)
188        m_object_name = *object_name;
189    LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
190    if (log)
191        log->Printf ("%p Module::Module((%s) '%s/%s%s%s%s')",
192                     this,
193                     m_arch.GetArchitectureName(),
194                     m_file.GetDirectory().AsCString(""),
195                     m_file.GetFilename().AsCString(""),
196                     m_object_name.IsEmpty() ? "" : "(",
197                     m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
198                     m_object_name.IsEmpty() ? "" : ")");
199}
200
201Module::~Module()
202{
203    // Scope for locker below...
204    {
205        Mutex::Locker locker (GetAllocationModuleCollectionMutex());
206        ModuleCollection &modules = GetModuleCollection();
207        ModuleCollection::iterator end = modules.end();
208        ModuleCollection::iterator pos = std::find(modules.begin(), end, this);
209        if (pos != end)
210            modules.erase(pos);
211    }
212    LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
213    if (log)
214        log->Printf ("%p Module::~Module((%s) '%s/%s%s%s%s')",
215                     this,
216                     m_arch.GetArchitectureName(),
217                     m_file.GetDirectory().AsCString(""),
218                     m_file.GetFilename().AsCString(""),
219                     m_object_name.IsEmpty() ? "" : "(",
220                     m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
221                     m_object_name.IsEmpty() ? "" : ")");
222    // Release any auto pointers before we start tearing down our member
223    // variables since the object file and symbol files might need to make
224    // function calls back into this module object. The ordering is important
225    // here because symbol files can require the module object file. So we tear
226    // down the symbol file first, then the object file.
227    m_symfile_ap.reset();
228    m_objfile_sp.reset();
229}
230
231ObjectFile *
232Module::GetMemoryObjectFile (const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, Error &error)
233{
234    if (m_objfile_sp)
235    {
236        error.SetErrorString ("object file already exists");
237    }
238    else
239    {
240        Mutex::Locker locker (m_mutex);
241        if (process_sp)
242        {
243            m_did_load_objfile = true;
244            std::auto_ptr<DataBufferHeap> data_ap (new DataBufferHeap (512, 0));
245            Error readmem_error;
246            const size_t bytes_read = process_sp->ReadMemory (header_addr,
247                                                              data_ap->GetBytes(),
248                                                              data_ap->GetByteSize(),
249                                                              readmem_error);
250            if (bytes_read == 512)
251            {
252                DataBufferSP data_sp(data_ap.release());
253                m_objfile_sp = ObjectFile::FindPlugin(shared_from_this(), process_sp, header_addr, data_sp);
254                if (m_objfile_sp)
255                {
256                    StreamString s;
257                    s.Printf("0x%16.16llx", header_addr);
258                    m_object_name.SetCString (s.GetData());
259
260                    // Once we get the object file, update our module with the object file's
261                    // architecture since it might differ in vendor/os if some parts were
262                    // unknown.
263                    m_objfile_sp->GetArchitecture (m_arch);
264                }
265                else
266                {
267                    error.SetErrorString ("unable to find suitable object file plug-in");
268                }
269            }
270            else
271            {
272                error.SetErrorStringWithFormat ("unable to read header from memory: %s", readmem_error.AsCString());
273            }
274        }
275        else
276        {
277            error.SetErrorString ("invalid process");
278        }
279    }
280    return m_objfile_sp.get();
281}
282
283
284const lldb_private::UUID&
285Module::GetUUID()
286{
287    Mutex::Locker locker (m_mutex);
288    if (m_did_parse_uuid == false)
289    {
290        ObjectFile * obj_file = GetObjectFile ();
291
292        if (obj_file != NULL)
293        {
294            obj_file->GetUUID(&m_uuid);
295            m_did_parse_uuid = true;
296        }
297    }
298    return m_uuid;
299}
300
301ClangASTContext &
302Module::GetClangASTContext ()
303{
304    Mutex::Locker locker (m_mutex);
305    if (m_did_init_ast == false)
306    {
307        ObjectFile * objfile = GetObjectFile();
308        ArchSpec object_arch;
309        if (objfile && objfile->GetArchitecture(object_arch))
310        {
311            m_did_init_ast = true;
312            m_ast.SetArchitecture (object_arch);
313        }
314    }
315    return m_ast;
316}
317
318void
319Module::ParseAllDebugSymbols()
320{
321    Mutex::Locker locker (m_mutex);
322    uint32_t num_comp_units = GetNumCompileUnits();
323    if (num_comp_units == 0)
324        return;
325
326    SymbolContext sc;
327    sc.module_sp = shared_from_this();
328    uint32_t cu_idx;
329    SymbolVendor *symbols = GetSymbolVendor ();
330
331    for (cu_idx = 0; cu_idx < num_comp_units; cu_idx++)
332    {
333        sc.comp_unit = symbols->GetCompileUnitAtIndex(cu_idx).get();
334        if (sc.comp_unit)
335        {
336            sc.function = NULL;
337            symbols->ParseVariablesForContext(sc);
338
339            symbols->ParseCompileUnitFunctions(sc);
340
341            uint32_t func_idx;
342            for (func_idx = 0; (sc.function = sc.comp_unit->GetFunctionAtIndex(func_idx).get()) != NULL; ++func_idx)
343            {
344                symbols->ParseFunctionBlocks(sc);
345
346                // Parse the variables for this function and all its blocks
347                symbols->ParseVariablesForContext(sc);
348            }
349
350
351            // Parse all types for this compile unit
352            sc.function = NULL;
353            symbols->ParseTypes(sc);
354        }
355    }
356}
357
358void
359Module::CalculateSymbolContext(SymbolContext* sc)
360{
361    sc->module_sp = shared_from_this();
362}
363
364ModuleSP
365Module::CalculateSymbolContextModule ()
366{
367    return shared_from_this();
368}
369
370void
371Module::DumpSymbolContext(Stream *s)
372{
373    s->Printf(", Module{%p}", this);
374}
375
376uint32_t
377Module::GetNumCompileUnits()
378{
379    Mutex::Locker locker (m_mutex);
380    Timer scoped_timer(__PRETTY_FUNCTION__, "Module::GetNumCompileUnits (module = %p)", this);
381    SymbolVendor *symbols = GetSymbolVendor ();
382    if (symbols)
383        return symbols->GetNumCompileUnits();
384    return 0;
385}
386
387CompUnitSP
388Module::GetCompileUnitAtIndex (uint32_t index)
389{
390    Mutex::Locker locker (m_mutex);
391    uint32_t num_comp_units = GetNumCompileUnits ();
392    CompUnitSP cu_sp;
393
394    if (index < num_comp_units)
395    {
396        SymbolVendor *symbols = GetSymbolVendor ();
397        if (symbols)
398            cu_sp = symbols->GetCompileUnitAtIndex(index);
399    }
400    return cu_sp;
401}
402
403bool
404Module::ResolveFileAddress (lldb::addr_t vm_addr, Address& so_addr)
405{
406    Mutex::Locker locker (m_mutex);
407    Timer scoped_timer(__PRETTY_FUNCTION__, "Module::ResolveFileAddress (vm_addr = 0x%llx)", vm_addr);
408    ObjectFile* ofile = GetObjectFile();
409    if (ofile)
410        return so_addr.ResolveAddressUsingFileSections(vm_addr, ofile->GetSectionList());
411    return false;
412}
413
414uint32_t
415Module::ResolveSymbolContextForAddress (const Address& so_addr, uint32_t resolve_scope, SymbolContext& sc)
416{
417    Mutex::Locker locker (m_mutex);
418    uint32_t resolved_flags = 0;
419
420    // Clear the result symbol context in case we don't find anything
421    sc.Clear();
422
423    // Get the section from the section/offset address.
424    SectionSP section_sp (so_addr.GetSection());
425
426    // Make sure the section matches this module before we try and match anything
427    if (section_sp && section_sp->GetModule().get() == this)
428    {
429        // If the section offset based address resolved itself, then this
430        // is the right module.
431        sc.module_sp = shared_from_this();
432        resolved_flags |= eSymbolContextModule;
433
434        // Resolve the compile unit, function, block, line table or line
435        // entry if requested.
436        if (resolve_scope & eSymbolContextCompUnit    ||
437            resolve_scope & eSymbolContextFunction    ||
438            resolve_scope & eSymbolContextBlock       ||
439            resolve_scope & eSymbolContextLineEntry   )
440        {
441            SymbolVendor *symbols = GetSymbolVendor ();
442            if (symbols)
443                resolved_flags |= symbols->ResolveSymbolContext (so_addr, resolve_scope, sc);
444        }
445
446        // Resolve the symbol if requested, but don't re-look it up if we've already found it.
447        if (resolve_scope & eSymbolContextSymbol && !(resolved_flags & eSymbolContextSymbol))
448        {
449            ObjectFile* ofile = GetObjectFile();
450            if (ofile)
451            {
452                Symtab *symtab = ofile->GetSymtab();
453                if (symtab)
454                {
455                    if (so_addr.IsSectionOffset())
456                    {
457                        sc.symbol = symtab->FindSymbolContainingFileAddress(so_addr.GetFileAddress());
458                        if (sc.symbol)
459                            resolved_flags |= eSymbolContextSymbol;
460                    }
461                }
462            }
463        }
464    }
465    return resolved_flags;
466}
467
468uint32_t
469Module::ResolveSymbolContextForFilePath
470(
471    const char *file_path,
472    uint32_t line,
473    bool check_inlines,
474    uint32_t resolve_scope,
475    SymbolContextList& sc_list
476)
477{
478    FileSpec file_spec(file_path, false);
479    return ResolveSymbolContextsForFileSpec (file_spec, line, check_inlines, resolve_scope, sc_list);
480}
481
482uint32_t
483Module::ResolveSymbolContextsForFileSpec (const FileSpec &file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list)
484{
485    Mutex::Locker locker (m_mutex);
486    Timer scoped_timer(__PRETTY_FUNCTION__,
487                       "Module::ResolveSymbolContextForFilePath (%s%s%s:%u, check_inlines = %s, resolve_scope = 0x%8.8x)",
488                       file_spec.GetDirectory().AsCString(""),
489                       file_spec.GetDirectory() ? "/" : "",
490                       file_spec.GetFilename().AsCString(""),
491                       line,
492                       check_inlines ? "yes" : "no",
493                       resolve_scope);
494
495    const uint32_t initial_count = sc_list.GetSize();
496
497    SymbolVendor *symbols = GetSymbolVendor  ();
498    if (symbols)
499        symbols->ResolveSymbolContext (file_spec, line, check_inlines, resolve_scope, sc_list);
500
501    return sc_list.GetSize() - initial_count;
502}
503
504
505uint32_t
506Module::FindGlobalVariables(const ConstString &name, const ClangNamespaceDecl *namespace_decl, bool append, uint32_t max_matches, VariableList& variables)
507{
508    SymbolVendor *symbols = GetSymbolVendor ();
509    if (symbols)
510        return symbols->FindGlobalVariables(name, namespace_decl, append, max_matches, variables);
511    return 0;
512}
513uint32_t
514Module::FindGlobalVariables(const RegularExpression& regex, bool append, uint32_t max_matches, VariableList& variables)
515{
516    SymbolVendor *symbols = GetSymbolVendor ();
517    if (symbols)
518        return symbols->FindGlobalVariables(regex, append, max_matches, variables);
519    return 0;
520}
521
522uint32_t
523Module::FindCompileUnits (const FileSpec &path,
524                          bool append,
525                          SymbolContextList &sc_list)
526{
527    if (!append)
528        sc_list.Clear();
529
530    const uint32_t start_size = sc_list.GetSize();
531    const uint32_t num_compile_units = GetNumCompileUnits();
532    SymbolContext sc;
533    sc.module_sp = shared_from_this();
534    const bool compare_directory = path.GetDirectory();
535    for (uint32_t i=0; i<num_compile_units; ++i)
536    {
537        sc.comp_unit = GetCompileUnitAtIndex(i).get();
538        if (FileSpec::Equal (*sc.comp_unit, path, compare_directory))
539            sc_list.Append(sc);
540    }
541    return sc_list.GetSize() - start_size;
542}
543
544uint32_t
545Module::FindFunctions (const ConstString &name,
546                       const ClangNamespaceDecl *namespace_decl,
547                       uint32_t name_type_mask,
548                       bool include_symbols,
549                       bool include_inlines,
550                       bool append,
551                       SymbolContextList& sc_list)
552{
553    if (!append)
554        sc_list.Clear();
555
556    const uint32_t start_size = sc_list.GetSize();
557
558    // Find all the functions (not symbols, but debug information functions...
559    SymbolVendor *symbols = GetSymbolVendor ();
560    if (symbols)
561        symbols->FindFunctions(name, namespace_decl, name_type_mask, include_inlines, append, sc_list);
562
563    // Now check our symbol table for symbols that are code symbols if requested
564    if (include_symbols)
565    {
566        ObjectFile *objfile = GetObjectFile();
567        if (objfile)
568        {
569            Symtab *symtab = objfile->GetSymtab();
570            if (symtab)
571            {
572                std::vector<uint32_t> symbol_indexes;
573                symtab->FindAllSymbolsWithNameAndType (name, eSymbolTypeCode, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes);
574                const uint32_t num_matches = symbol_indexes.size();
575                if (num_matches)
576                {
577                    const bool merge_symbol_into_function = true;
578                    SymbolContext sc(this);
579                    for (uint32_t i=0; i<num_matches; i++)
580                    {
581                        sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
582                        sc_list.AppendIfUnique (sc, merge_symbol_into_function);
583                    }
584                }
585            }
586        }
587    }
588    return sc_list.GetSize() - start_size;
589}
590
591uint32_t
592Module::FindFunctions (const RegularExpression& regex,
593                       bool include_symbols,
594                       bool include_inlines,
595                       bool append,
596                       SymbolContextList& sc_list)
597{
598    if (!append)
599        sc_list.Clear();
600
601    const uint32_t start_size = sc_list.GetSize();
602
603    SymbolVendor *symbols = GetSymbolVendor ();
604    if (symbols)
605        symbols->FindFunctions(regex, include_inlines, append, sc_list);
606    // Now check our symbol table for symbols that are code symbols if requested
607    if (include_symbols)
608    {
609        ObjectFile *objfile = GetObjectFile();
610        if (objfile)
611        {
612            Symtab *symtab = objfile->GetSymtab();
613            if (symtab)
614            {
615                std::vector<uint32_t> symbol_indexes;
616                symtab->AppendSymbolIndexesMatchingRegExAndType (regex, eSymbolTypeCode, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes);
617                const uint32_t num_matches = symbol_indexes.size();
618                if (num_matches)
619                {
620                    const bool merge_symbol_into_function = true;
621                    SymbolContext sc(this);
622                    for (uint32_t i=0; i<num_matches; i++)
623                    {
624                        sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
625                        sc_list.AppendIfUnique (sc, merge_symbol_into_function);
626                    }
627                }
628            }
629        }
630    }
631    return sc_list.GetSize() - start_size;
632}
633
634uint32_t
635Module::FindTypes_Impl (const SymbolContext& sc,
636                        const ConstString &name,
637                        const ClangNamespaceDecl *namespace_decl,
638                        bool append,
639                        uint32_t max_matches,
640                        TypeList& types)
641{
642    Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
643    if (sc.module_sp.get() == NULL || sc.module_sp.get() == this)
644    {
645        SymbolVendor *symbols = GetSymbolVendor ();
646        if (symbols)
647            return symbols->FindTypes(sc, name, namespace_decl, append, max_matches, types);
648    }
649    return 0;
650}
651
652uint32_t
653Module::FindTypesInNamespace (const SymbolContext& sc,
654                              const ConstString &type_name,
655                              const ClangNamespaceDecl *namespace_decl,
656                              uint32_t max_matches,
657                              TypeList& type_list)
658{
659    const bool append = true;
660    return FindTypes_Impl(sc, type_name, namespace_decl, append, max_matches, type_list);
661}
662
663uint32_t
664Module::FindTypes (const SymbolContext& sc,
665                   const ConstString &name,
666                   bool exact_match,
667                   uint32_t max_matches,
668                   TypeList& types)
669{
670    uint32_t num_matches = 0;
671    const char *type_name_cstr = name.GetCString();
672    std::string type_scope;
673    std::string type_basename;
674    const bool append = true;
675    if (Type::GetTypeScopeAndBasename (type_name_cstr, type_scope, type_basename))
676    {
677        // Check if "name" starts with "::" which means the qualified type starts
678        // from the root namespace and implies and exact match. The typenames we
679        // get back from clang do not start with "::" so we need to strip this off
680        // in order to get the qualfied names to match
681
682        if (type_scope.size() >= 2 && type_scope[0] == ':' && type_scope[1] == ':')
683        {
684            type_scope.erase(0,2);
685            exact_match = true;
686        }
687        ConstString type_basename_const_str (type_basename.c_str());
688        if (FindTypes_Impl(sc, type_basename_const_str, NULL, append, max_matches, types))
689        {
690            types.RemoveMismatchedTypes (type_scope, type_basename, exact_match);
691            num_matches = types.GetSize();
692        }
693        else
694        {
695            types.Clear();
696        }
697    }
698    else
699    {
700        // The type is not in a namespace/class scope, just search for it by basename
701        num_matches = FindTypes_Impl(sc, name, NULL, append, max_matches, types);
702    }
703
704    return num_matches;
705
706}
707
708//uint32_t
709//Module::FindTypes(const SymbolContext& sc, const RegularExpression& regex, bool append, uint32_t max_matches, Type::Encoding encoding, const char *udt_name, TypeList& types)
710//{
711//  Timer scoped_timer(__PRETTY_FUNCTION__);
712//  SymbolVendor *symbols = GetSymbolVendor ();
713//  if (symbols)
714//      return symbols->FindTypes(sc, regex, append, max_matches, encoding, udt_name, types);
715//  return 0;
716//
717//}
718
719SymbolVendor*
720Module::GetSymbolVendor (bool can_create)
721{
722    Mutex::Locker locker (m_mutex);
723    if (m_did_load_symbol_vendor == false && can_create)
724    {
725        ObjectFile *obj_file = GetObjectFile ();
726        if (obj_file != NULL)
727        {
728            Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
729            m_symfile_ap.reset(SymbolVendor::FindPlugin(shared_from_this()));
730            m_did_load_symbol_vendor = true;
731        }
732    }
733    return m_symfile_ap.get();
734}
735
736void
737Module::SetFileSpecAndObjectName (const FileSpec &file, const ConstString &object_name)
738{
739    // Container objects whose paths do not specify a file directly can call
740    // this function to correct the file and object names.
741    m_file = file;
742    m_mod_time = file.GetModificationTime();
743    m_object_name = object_name;
744}
745
746const ArchSpec&
747Module::GetArchitecture () const
748{
749    return m_arch;
750}
751
752void
753Module::GetDescription (Stream *s, lldb::DescriptionLevel level)
754{
755    Mutex::Locker locker (m_mutex);
756
757    if (level >= eDescriptionLevelFull)
758    {
759        if (m_arch.IsValid())
760            s->Printf("(%s) ", m_arch.GetArchitectureName());
761    }
762
763    if (level == eDescriptionLevelBrief)
764    {
765        const char *filename = m_file.GetFilename().GetCString();
766        if (filename)
767            s->PutCString (filename);
768    }
769    else
770    {
771        char path[PATH_MAX];
772        if (m_file.GetPath(path, sizeof(path)))
773            s->PutCString(path);
774    }
775
776    const char *object_name = m_object_name.GetCString();
777    if (object_name)
778        s->Printf("(%s)", object_name);
779}
780
781void
782Module::ReportError (const char *format, ...)
783{
784    if (format && format[0])
785    {
786        StreamString strm;
787        strm.PutCString("error: ");
788        GetDescription(&strm, lldb::eDescriptionLevelBrief);
789        strm.PutChar (' ');
790        va_list args;
791        va_start (args, format);
792        strm.PrintfVarArg(format, args);
793        va_end (args);
794
795        const int format_len = strlen(format);
796        if (format_len > 0)
797        {
798            const char last_char = format[format_len-1];
799            if (last_char != '\n' || last_char != '\r')
800                strm.EOL();
801        }
802        Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str());
803
804    }
805}
806
807void
808Module::ReportErrorIfModifyDetected (const char *format, ...)
809{
810    if (!GetModified(true) && GetModified(false))
811    {
812        if (format)
813        {
814            StreamString strm;
815            strm.PutCString("error: the object file ");
816            GetDescription(&strm, lldb::eDescriptionLevelFull);
817            strm.PutCString (" has been modified\n");
818
819            va_list args;
820            va_start (args, format);
821            strm.PrintfVarArg(format, args);
822            va_end (args);
823
824            const int format_len = strlen(format);
825            if (format_len > 0)
826            {
827                const char last_char = format[format_len-1];
828                if (last_char != '\n' || last_char != '\r')
829                    strm.EOL();
830            }
831            strm.PutCString("The debug session should be aborted as the original debug information has been overwritten.\n");
832            Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str());
833        }
834    }
835}
836
837void
838Module::ReportWarning (const char *format, ...)
839{
840    if (format && format[0])
841    {
842        StreamString strm;
843        strm.PutCString("warning: ");
844        GetDescription(&strm, lldb::eDescriptionLevelFull);
845        strm.PutChar (' ');
846
847        va_list args;
848        va_start (args, format);
849        strm.PrintfVarArg(format, args);
850        va_end (args);
851
852        const int format_len = strlen(format);
853        if (format_len > 0)
854        {
855            const char last_char = format[format_len-1];
856            if (last_char != '\n' || last_char != '\r')
857                strm.EOL();
858        }
859        Host::SystemLog (Host::eSystemLogWarning, "%s", strm.GetString().c_str());
860    }
861}
862
863void
864Module::LogMessage (Log *log, const char *format, ...)
865{
866    if (log)
867    {
868        StreamString log_message;
869        GetDescription(&log_message, lldb::eDescriptionLevelFull);
870        log_message.PutCString (": ");
871        va_list args;
872        va_start (args, format);
873        log_message.PrintfVarArg (format, args);
874        va_end (args);
875        log->PutCString(log_message.GetString().c_str());
876    }
877}
878
879bool
880Module::GetModified (bool use_cached_only)
881{
882    if (m_was_modified == false && use_cached_only == false)
883    {
884        TimeValue curr_mod_time (m_file.GetModificationTime());
885        m_was_modified = curr_mod_time != m_mod_time;
886    }
887    return m_was_modified;
888}
889
890bool
891Module::SetModified (bool b)
892{
893    const bool prev_value = m_was_modified;
894    m_was_modified = b;
895    return prev_value;
896}
897
898
899void
900Module::Dump(Stream *s)
901{
902    Mutex::Locker locker (m_mutex);
903    //s->Printf("%.*p: ", (int)sizeof(void*) * 2, this);
904    s->Indent();
905    s->Printf("Module %s/%s%s%s%s\n",
906              m_file.GetDirectory().AsCString(),
907              m_file.GetFilename().AsCString(),
908              m_object_name ? "(" : "",
909              m_object_name ? m_object_name.GetCString() : "",
910              m_object_name ? ")" : "");
911
912    s->IndentMore();
913    ObjectFile *objfile = GetObjectFile ();
914
915    if (objfile)
916        objfile->Dump(s);
917
918    SymbolVendor *symbols = GetSymbolVendor ();
919
920    if (symbols)
921        symbols->Dump(s);
922
923    s->IndentLess();
924}
925
926
927TypeList*
928Module::GetTypeList ()
929{
930    SymbolVendor *symbols = GetSymbolVendor ();
931    if (symbols)
932        return &symbols->GetTypeList();
933    return NULL;
934}
935
936const ConstString &
937Module::GetObjectName() const
938{
939    return m_object_name;
940}
941
942ObjectFile *
943Module::GetObjectFile()
944{
945    Mutex::Locker locker (m_mutex);
946    if (m_did_load_objfile == false)
947    {
948        m_did_load_objfile = true;
949        Timer scoped_timer(__PRETTY_FUNCTION__,
950                           "Module::GetObjectFile () module = %s", GetFileSpec().GetFilename().AsCString(""));
951        DataBufferSP file_data_sp;
952        m_objfile_sp = ObjectFile::FindPlugin (shared_from_this(),
953                                               &m_file,
954                                               m_object_offset,
955                                               m_file.GetByteSize(),
956                                               file_data_sp);
957        if (m_objfile_sp)
958        {
959			// Once we get the object file, update our module with the object file's
960			// architecture since it might differ in vendor/os if some parts were
961			// unknown.
962            m_objfile_sp->GetArchitecture (m_arch);
963        }
964    }
965    return m_objfile_sp.get();
966}
967
968
969const Symbol *
970Module::FindFirstSymbolWithNameAndType (const ConstString &name, SymbolType symbol_type)
971{
972    Timer scoped_timer(__PRETTY_FUNCTION__,
973                       "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)",
974                       name.AsCString(),
975                       symbol_type);
976    ObjectFile *objfile = GetObjectFile();
977    if (objfile)
978    {
979        Symtab *symtab = objfile->GetSymtab();
980        if (symtab)
981            return symtab->FindFirstSymbolWithNameAndType (name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny);
982    }
983    return NULL;
984}
985void
986Module::SymbolIndicesToSymbolContextList (Symtab *symtab, std::vector<uint32_t> &symbol_indexes, SymbolContextList &sc_list)
987{
988    // No need to protect this call using m_mutex all other method calls are
989    // already thread safe.
990
991    size_t num_indices = symbol_indexes.size();
992    if (num_indices > 0)
993    {
994        SymbolContext sc;
995        CalculateSymbolContext (&sc);
996        for (size_t i = 0; i < num_indices; i++)
997        {
998            sc.symbol = symtab->SymbolAtIndex (symbol_indexes[i]);
999            if (sc.symbol)
1000                sc_list.Append (sc);
1001        }
1002    }
1003}
1004
1005size_t
1006Module::FindSymbolsWithNameAndType (const ConstString &name, SymbolType symbol_type, SymbolContextList &sc_list)
1007{
1008    // No need to protect this call using m_mutex all other method calls are
1009    // already thread safe.
1010
1011
1012    Timer scoped_timer(__PRETTY_FUNCTION__,
1013                       "Module::FindSymbolsWithNameAndType (name = %s, type = %i)",
1014                       name.AsCString(),
1015                       symbol_type);
1016    const size_t initial_size = sc_list.GetSize();
1017    ObjectFile *objfile = GetObjectFile ();
1018    if (objfile)
1019    {
1020        Symtab *symtab = objfile->GetSymtab();
1021        if (symtab)
1022        {
1023            std::vector<uint32_t> symbol_indexes;
1024            symtab->FindAllSymbolsWithNameAndType (name, symbol_type, symbol_indexes);
1025            SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list);
1026        }
1027    }
1028    return sc_list.GetSize() - initial_size;
1029}
1030
1031size_t
1032Module::FindSymbolsMatchingRegExAndType (const RegularExpression &regex, SymbolType symbol_type, SymbolContextList &sc_list)
1033{
1034    // No need to protect this call using m_mutex all other method calls are
1035    // already thread safe.
1036
1037    Timer scoped_timer(__PRETTY_FUNCTION__,
1038                       "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)",
1039                       regex.GetText(),
1040                       symbol_type);
1041    const size_t initial_size = sc_list.GetSize();
1042    ObjectFile *objfile = GetObjectFile ();
1043    if (objfile)
1044    {
1045        Symtab *symtab = objfile->GetSymtab();
1046        if (symtab)
1047        {
1048            std::vector<uint32_t> symbol_indexes;
1049            symtab->FindAllSymbolsMatchingRexExAndType (regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes);
1050            SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list);
1051        }
1052    }
1053    return sc_list.GetSize() - initial_size;
1054}
1055
1056const TimeValue &
1057Module::GetModificationTime () const
1058{
1059    return m_mod_time;
1060}
1061
1062bool
1063Module::IsExecutable ()
1064{
1065    if (GetObjectFile() == NULL)
1066        return false;
1067    else
1068        return GetObjectFile()->IsExecutable();
1069}
1070
1071bool
1072Module::IsLoadedInTarget (Target *target)
1073{
1074    ObjectFile *obj_file = GetObjectFile();
1075    if (obj_file)
1076    {
1077        SectionList *sections = obj_file->GetSectionList();
1078        if (sections != NULL)
1079        {
1080            size_t num_sections = sections->GetSize();
1081            for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++)
1082            {
1083                SectionSP section_sp = sections->GetSectionAtIndex(sect_idx);
1084                if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS)
1085                {
1086                    return true;
1087                }
1088            }
1089        }
1090    }
1091    return false;
1092}
1093bool
1094Module::SetArchitecture (const ArchSpec &new_arch)
1095{
1096    if (!m_arch.IsValid())
1097    {
1098        m_arch = new_arch;
1099        return true;
1100    }
1101    return m_arch == new_arch;
1102}
1103
1104bool
1105Module::SetLoadAddress (Target &target, lldb::addr_t offset, bool &changed)
1106{
1107    size_t num_loaded_sections = 0;
1108    ObjectFile *objfile = GetObjectFile();
1109    if (objfile)
1110    {
1111        SectionList *section_list = objfile->GetSectionList ();
1112        if (section_list)
1113        {
1114            const size_t num_sections = section_list->GetSize();
1115            size_t sect_idx = 0;
1116            for (sect_idx = 0; sect_idx < num_sections; ++sect_idx)
1117            {
1118                // Iterate through the object file sections to find the
1119                // first section that starts of file offset zero and that
1120                // has bytes in the file...
1121                Section *section = section_list->GetSectionAtIndex (sect_idx).get();
1122                // Only load non-thread specific sections when given a slide
1123                if (section && !section->IsThreadSpecific())
1124                {
1125                    if (target.GetSectionLoadList().SetSectionLoadAddress (section, section->GetFileAddress() + offset))
1126                        ++num_loaded_sections;
1127                }
1128            }
1129        }
1130    }
1131    changed = num_loaded_sections > 0;
1132    return num_loaded_sections > 0;
1133}
1134
1135
1136bool
1137Module::MatchesModuleSpec (const ModuleSpec &module_ref)
1138{
1139    const UUID &uuid = module_ref.GetUUID();
1140
1141    if (uuid.IsValid())
1142    {
1143        // If the UUID matches, then nothing more needs to match...
1144        if (uuid == GetUUID())
1145            return true;
1146        else
1147            return false;
1148    }
1149
1150    const FileSpec &file_spec = module_ref.GetFileSpec();
1151    if (file_spec)
1152    {
1153        if (!FileSpec::Equal (file_spec, m_file, file_spec.GetDirectory()))
1154            return false;
1155    }
1156
1157    const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec();
1158    if (platform_file_spec)
1159    {
1160        if (!FileSpec::Equal (platform_file_spec, m_platform_file, platform_file_spec.GetDirectory()))
1161            return false;
1162    }
1163
1164    const ArchSpec &arch = module_ref.GetArchitecture();
1165    if (arch.IsValid())
1166    {
1167        if (m_arch != arch)
1168            return false;
1169    }
1170
1171    const ConstString &object_name = module_ref.GetObjectName();
1172    if (object_name)
1173    {
1174        if (object_name != GetObjectName())
1175            return false;
1176    }
1177    return true;
1178}
1179
1180bool
1181Module::FindSourceFile (const FileSpec &orig_spec, FileSpec &new_spec) const
1182{
1183    Mutex::Locker locker (m_mutex);
1184    return m_source_mappings.FindFile (orig_spec, new_spec);
1185}
1186
1187bool
1188Module::RemapSourceFile (const char *path, std::string &new_path) const
1189{
1190    Mutex::Locker locker (m_mutex);
1191    return m_source_mappings.RemapPath(path, new_path);
1192}
1193
1194