1 //===-- SymbolContext.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/Symbol/SymbolContext.h"
11 
12 #include "lldb/Core/Log.h"
13 #include "lldb/Core/Module.h"
14 #include "lldb/Core/ModuleSpec.h"
15 #include "lldb/Host/Host.h"
16 #include "lldb/Host/StringConvert.h"
17 #include "lldb/Symbol/Block.h"
18 #include "lldb/Symbol/ClangASTContext.h"
19 #include "lldb/Symbol/CompileUnit.h"
20 #include "lldb/Symbol/ObjectFile.h"
21 #include "lldb/Symbol/Symbol.h"
22 #include "lldb/Symbol/SymbolFile.h"
23 #include "lldb/Symbol/SymbolVendor.h"
24 #include "lldb/Symbol/Variable.h"
25 #include "lldb/Target/Target.h"
26 
27 using namespace lldb;
28 using namespace lldb_private;
29 
30 SymbolContext::SymbolContext() :
31     target_sp   (),
32     module_sp   (),
33     comp_unit   (nullptr),
34     function    (nullptr),
35     block       (nullptr),
36     line_entry  (),
37     symbol      (nullptr),
38     variable    (nullptr)
39 {
40 }
41 
42 SymbolContext::SymbolContext(const ModuleSP& m, CompileUnit *cu, Function *f, Block *b, LineEntry *le, Symbol *s) :
43     target_sp   (),
44     module_sp   (m),
45     comp_unit   (cu),
46     function    (f),
47     block       (b),
48     line_entry  (),
49     symbol      (s),
50     variable    (nullptr)
51 {
52     if (le)
53         line_entry = *le;
54 }
55 
56 SymbolContext::SymbolContext(const TargetSP &t, const ModuleSP& m, CompileUnit *cu, Function *f, Block *b, LineEntry *le, Symbol *s) :
57     target_sp   (t),
58     module_sp   (m),
59     comp_unit   (cu),
60     function    (f),
61     block       (b),
62     line_entry  (),
63     symbol      (s),
64     variable    (nullptr)
65 {
66     if (le)
67         line_entry = *le;
68 }
69 
70 SymbolContext::SymbolContext(const SymbolContext& rhs) :
71     target_sp   (rhs.target_sp),
72     module_sp   (rhs.module_sp),
73     comp_unit   (rhs.comp_unit),
74     function    (rhs.function),
75     block       (rhs.block),
76     line_entry  (rhs.line_entry),
77     symbol      (rhs.symbol),
78     variable    (rhs.variable)
79 {
80 }
81 
82 
83 SymbolContext::SymbolContext (SymbolContextScope *sc_scope) :
84     target_sp   (),
85     module_sp   (),
86     comp_unit   (nullptr),
87     function    (nullptr),
88     block       (nullptr),
89     line_entry  (),
90     symbol      (nullptr),
91     variable    (nullptr)
92 {
93     sc_scope->CalculateSymbolContext (this);
94 }
95 
96 SymbolContext::~SymbolContext ()
97 {
98 }
99 
100 const SymbolContext&
101 SymbolContext::operator= (const SymbolContext& rhs)
102 {
103     if (this != &rhs)
104     {
105         target_sp   = rhs.target_sp;
106         module_sp   = rhs.module_sp;
107         comp_unit   = rhs.comp_unit;
108         function    = rhs.function;
109         block       = rhs.block;
110         line_entry  = rhs.line_entry;
111         symbol      = rhs.symbol;
112         variable    = rhs.variable;
113     }
114     return *this;
115 }
116 
117 void
118 SymbolContext::Clear(bool clear_target)
119 {
120     if (clear_target)
121         target_sp.reset();
122     module_sp.reset();
123     comp_unit   = nullptr;
124     function    = nullptr;
125     block       = nullptr;
126     line_entry.Clear();
127     symbol      = nullptr;
128     variable    = nullptr;
129 }
130 
131 bool
132 SymbolContext::DumpStopContext (
133     Stream *s,
134     ExecutionContextScope *exe_scope,
135     const Address &addr,
136     bool show_fullpaths,
137     bool show_module,
138     bool show_inlined_frames,
139     bool show_function_arguments,
140     bool show_function_name
141 ) const
142 {
143     bool dumped_something = false;
144     if (show_module && module_sp)
145     {
146         if (show_fullpaths)
147             *s << module_sp->GetFileSpec();
148         else
149             *s << module_sp->GetFileSpec().GetFilename();
150         s->PutChar('`');
151         dumped_something = true;
152     }
153 
154     if (function != nullptr)
155     {
156         SymbolContext inline_parent_sc;
157         Address inline_parent_addr;
158         if (show_function_name == false)
159         {
160             s->Printf("<");
161             dumped_something = true;
162         }
163         else
164         {
165             ConstString name;
166             if (show_function_arguments == false)
167                 name = function->GetNameNoArguments();
168             if (!name)
169                 name = function->GetName();
170             if (name)
171                 name.Dump(s);
172         }
173 
174         if (addr.IsValid())
175         {
176             const addr_t function_offset = addr.GetOffset() - function->GetAddressRange().GetBaseAddress().GetOffset();
177             if (show_function_name == false)
178             {
179                 // Print +offset even if offset is 0
180                 dumped_something = true;
181                 s->Printf("+%" PRIu64 ">", function_offset);
182             }
183             else if (function_offset)
184             {
185                 dumped_something = true;
186                 s->Printf(" + %" PRIu64, function_offset);
187             }
188         }
189 
190         if (GetParentOfInlinedScope (addr, inline_parent_sc, inline_parent_addr))
191         {
192             dumped_something = true;
193             Block *inlined_block = block->GetContainingInlinedBlock();
194             const InlineFunctionInfo* inlined_block_info = inlined_block->GetInlinedFunctionInfo();
195             s->Printf (" [inlined] %s", inlined_block_info->GetName(function->GetLanguage()).GetCString());
196 
197             lldb_private::AddressRange block_range;
198             if (inlined_block->GetRangeContainingAddress(addr, block_range))
199             {
200                 const addr_t inlined_function_offset = addr.GetOffset() - block_range.GetBaseAddress().GetOffset();
201                 if (inlined_function_offset)
202                 {
203                     s->Printf(" + %" PRIu64, inlined_function_offset);
204                 }
205             }
206             const Declaration &call_site = inlined_block_info->GetCallSite();
207             if (call_site.IsValid())
208             {
209                 s->PutCString(" at ");
210                 call_site.DumpStopContext (s, show_fullpaths);
211             }
212             if (show_inlined_frames)
213             {
214                 s->EOL();
215                 s->Indent();
216                 const bool show_function_name = true;
217                 return inline_parent_sc.DumpStopContext (s, exe_scope, inline_parent_addr, show_fullpaths, show_module, show_inlined_frames, show_function_arguments, show_function_name);
218             }
219         }
220         else
221         {
222             if (line_entry.IsValid())
223             {
224                 dumped_something = true;
225                 s->PutCString(" at ");
226                 if (line_entry.DumpStopContext(s, show_fullpaths))
227                     dumped_something = true;
228             }
229         }
230     }
231     else if (symbol != nullptr)
232     {
233         if (show_function_name == false)
234         {
235             s->Printf("<");
236             dumped_something = true;
237         }
238         else if (symbol->GetName())
239         {
240             dumped_something = true;
241             if (symbol->GetType() == eSymbolTypeTrampoline)
242                 s->PutCString("symbol stub for: ");
243             symbol->GetName().Dump(s);
244         }
245 
246         if (addr.IsValid() && symbol->ValueIsAddress())
247         {
248             const addr_t symbol_offset = addr.GetOffset() - symbol->GetAddressRef().GetOffset();
249             if (show_function_name == false)
250             {
251                 // Print +offset even if offset is 0
252                 dumped_something = true;
253                 s->Printf("+%" PRIu64 ">", symbol_offset);
254             }
255             else if (symbol_offset)
256             {
257                 dumped_something = true;
258                 s->Printf(" + %" PRIu64, symbol_offset);
259             }
260         }
261     }
262     else if (addr.IsValid())
263     {
264         addr.Dump(s, exe_scope, Address::DumpStyleModuleWithFileAddress);
265         dumped_something = true;
266     }
267     return dumped_something;
268 }
269 
270 void
271 SymbolContext::GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target) const
272 {
273     if (module_sp)
274     {
275         s->Indent("     Module: file = \"");
276         module_sp->GetFileSpec().Dump(s);
277         *s << '"';
278         if (module_sp->GetArchitecture().IsValid())
279             s->Printf (", arch = \"%s\"", module_sp->GetArchitecture().GetArchitectureName());
280         s->EOL();
281     }
282 
283     if (comp_unit != nullptr)
284     {
285         s->Indent("CompileUnit: ");
286         comp_unit->GetDescription (s, level);
287         s->EOL();
288     }
289 
290     if (function != nullptr)
291     {
292         s->Indent("   Function: ");
293         function->GetDescription (s, level, target);
294         s->EOL();
295 
296         Type *func_type = function->GetType();
297         if (func_type)
298         {
299             s->Indent("   FuncType: ");
300             func_type->GetDescription (s, level, false);
301             s->EOL();
302         }
303     }
304 
305     if (block != nullptr)
306     {
307         std::vector<Block *> blocks;
308         blocks.push_back (block);
309         Block *parent_block = block->GetParent();
310 
311         while (parent_block)
312         {
313             blocks.push_back (parent_block);
314             parent_block = parent_block->GetParent();
315         }
316         std::vector<Block *>::reverse_iterator pos;
317         std::vector<Block *>::reverse_iterator begin = blocks.rbegin();
318         std::vector<Block *>::reverse_iterator end = blocks.rend();
319         for (pos = begin; pos != end; ++pos)
320         {
321             if (pos == begin)
322                 s->Indent("     Blocks: ");
323             else
324                 s->Indent("             ");
325             (*pos)->GetDescription(s, function, level, target);
326             s->EOL();
327         }
328     }
329 
330     if (line_entry.IsValid())
331     {
332         s->Indent("  LineEntry: ");
333         line_entry.GetDescription (s, level, comp_unit, target, false);
334         s->EOL();
335     }
336 
337     if (symbol != nullptr)
338     {
339         s->Indent("     Symbol: ");
340         symbol->GetDescription(s, level, target);
341         s->EOL();
342     }
343 
344     if (variable != nullptr)
345     {
346         s->Indent("   Variable: ");
347 
348         s->Printf("id = {0x%8.8" PRIx64 "}, ", variable->GetID());
349 
350         switch (variable->GetScope())
351         {
352             case eValueTypeVariableGlobal:
353                 s->PutCString("kind = global, ");
354                 break;
355 
356             case eValueTypeVariableStatic:
357                 s->PutCString("kind = static, ");
358                 break;
359 
360             case eValueTypeVariableArgument:
361                 s->PutCString("kind = argument, ");
362                 break;
363 
364             case eValueTypeVariableLocal:
365                 s->PutCString("kind = local, ");
366                 break;
367 
368             default:
369                 break;
370         }
371 
372         s->Printf ("name = \"%s\"\n", variable->GetName().GetCString());
373     }
374 }
375 
376 uint32_t
377 SymbolContext::GetResolvedMask () const
378 {
379     uint32_t resolved_mask = 0;
380     if (target_sp)              resolved_mask |= eSymbolContextTarget;
381     if (module_sp)              resolved_mask |= eSymbolContextModule;
382     if (comp_unit)              resolved_mask |= eSymbolContextCompUnit;
383     if (function)               resolved_mask |= eSymbolContextFunction;
384     if (block)                  resolved_mask |= eSymbolContextBlock;
385     if (line_entry.IsValid())   resolved_mask |= eSymbolContextLineEntry;
386     if (symbol)                 resolved_mask |= eSymbolContextSymbol;
387     if (variable)               resolved_mask |= eSymbolContextVariable;
388     return resolved_mask;
389 }
390 
391 void
392 SymbolContext::Dump(Stream *s, Target *target) const
393 {
394     *s << this << ": ";
395     s->Indent();
396     s->PutCString("SymbolContext");
397     s->IndentMore();
398     s->EOL();
399     s->IndentMore();
400     s->Indent();
401     *s << "Module       = " << module_sp.get() << ' ';
402     if (module_sp)
403         module_sp->GetFileSpec().Dump(s);
404     s->EOL();
405     s->Indent();
406     *s << "CompileUnit  = " << comp_unit;
407     if (comp_unit != nullptr)
408         *s << " {0x" << comp_unit->GetID() << "} " << *(static_cast<FileSpec*> (comp_unit));
409     s->EOL();
410     s->Indent();
411     *s << "Function     = " << function;
412     if (function != nullptr)
413     {
414         *s << " {0x" << function->GetID() << "} " << function->GetType()->GetName() << ", address-range = ";
415         function->GetAddressRange().Dump(s, target, Address::DumpStyleLoadAddress, Address::DumpStyleModuleWithFileAddress);
416         s->EOL();
417         s->Indent();
418         Type* func_type = function->GetType();
419         if (func_type)
420         {
421             *s << "        Type = ";
422             func_type->Dump (s, false);
423         }
424     }
425     s->EOL();
426     s->Indent();
427     *s << "Block        = " << block;
428     if (block != nullptr)
429         *s << " {0x" << block->GetID() << '}';
430     // Dump the block and pass it a negative depth to we print all the parent blocks
431     //if (block != NULL)
432     //  block->Dump(s, function->GetFileAddress(), INT_MIN);
433     s->EOL();
434     s->Indent();
435     *s << "LineEntry    = ";
436     line_entry.Dump (s, target, true, Address::DumpStyleLoadAddress, Address::DumpStyleModuleWithFileAddress, true);
437     s->EOL();
438     s->Indent();
439     *s << "Symbol       = " << symbol;
440     if (symbol != nullptr && symbol->GetMangled())
441         *s << ' ' << symbol->GetName().AsCString();
442     s->EOL();
443     *s << "Variable     = " << variable;
444     if (variable != nullptr)
445     {
446         *s << " {0x" << variable->GetID() << "} " << variable->GetType()->GetName();
447         s->EOL();
448     }
449     s->IndentLess();
450     s->IndentLess();
451 }
452 
453 bool
454 lldb_private::operator== (const SymbolContext& lhs, const SymbolContext& rhs)
455 {
456     return  lhs.function == rhs.function
457             && lhs.symbol == rhs.symbol
458             && lhs.module_sp.get() == rhs.module_sp.get()
459             && lhs.comp_unit == rhs.comp_unit
460             && lhs.target_sp.get() == rhs.target_sp.get()
461             && LineEntry::Compare(lhs.line_entry, rhs.line_entry) == 0
462             && lhs.variable == rhs.variable;
463 }
464 
465 bool
466 lldb_private::operator!= (const SymbolContext& lhs, const SymbolContext& rhs)
467 {
468     return  lhs.function != rhs.function
469             || lhs.symbol != rhs.symbol
470             || lhs.module_sp.get() != rhs.module_sp.get()
471             || lhs.comp_unit != rhs.comp_unit
472             || lhs.target_sp.get() != rhs.target_sp.get()
473             || LineEntry::Compare(lhs.line_entry, rhs.line_entry) != 0
474             || lhs.variable != rhs.variable;
475 }
476 
477 bool
478 SymbolContext::GetAddressRange (uint32_t scope,
479                                 uint32_t range_idx,
480                                 bool use_inline_block_range,
481                                 AddressRange &range) const
482 {
483     if ((scope & eSymbolContextLineEntry) && line_entry.IsValid())
484     {
485         range = line_entry.range;
486         return true;
487     }
488 
489     if ((scope & eSymbolContextBlock) && (block != nullptr))
490     {
491         if (use_inline_block_range)
492         {
493             Block *inline_block = block->GetContainingInlinedBlock();
494             if (inline_block)
495                 return inline_block->GetRangeAtIndex (range_idx, range);
496         }
497         else
498         {
499             return block->GetRangeAtIndex (range_idx, range);
500         }
501     }
502 
503     if ((scope & eSymbolContextFunction) && (function != nullptr))
504     {
505         if (range_idx == 0)
506         {
507             range = function->GetAddressRange();
508             return true;
509         }
510     }
511 
512     if ((scope & eSymbolContextSymbol) && (symbol != nullptr))
513     {
514         if (range_idx == 0)
515         {
516             if (symbol->ValueIsAddress())
517             {
518                 range.GetBaseAddress() = symbol->GetAddressRef();
519                 range.SetByteSize (symbol->GetByteSize());
520                 return true;
521             }
522         }
523     }
524     range.Clear();
525     return false;
526 }
527 
528 bool
529 SymbolContext::GetParentOfInlinedScope (const Address &curr_frame_pc,
530                                         SymbolContext &next_frame_sc,
531                                         Address &next_frame_pc) const
532 {
533     next_frame_sc.Clear(false);
534     next_frame_pc.Clear();
535 
536     if (block)
537     {
538         //const addr_t curr_frame_file_addr = curr_frame_pc.GetFileAddress();
539 
540         // In order to get the parent of an inlined function we first need to
541         // see if we are in an inlined block as "this->block" could be an
542         // inlined block, or a parent of "block" could be. So lets check if
543         // this block or one of this blocks parents is an inlined function.
544         Block *curr_inlined_block = block->GetContainingInlinedBlock();
545         if (curr_inlined_block)
546         {
547             // "this->block" is contained in an inline function block, so to
548             // get the scope above the inlined block, we get the parent of the
549             // inlined block itself
550             Block *next_frame_block = curr_inlined_block->GetParent();
551             // Now calculate the symbol context of the containing block
552             next_frame_block->CalculateSymbolContext (&next_frame_sc);
553 
554             // If we get here we weren't able to find the return line entry using the nesting of the blocks and
555             // the line table.  So just use the call site info from our inlined block.
556 
557             AddressRange range;
558             if (curr_inlined_block->GetRangeContainingAddress (curr_frame_pc, range))
559             {
560                 // To see there this new frame block it, we need to look at the
561                 // call site information from
562                 const InlineFunctionInfo* curr_inlined_block_inlined_info = curr_inlined_block->GetInlinedFunctionInfo();
563                 next_frame_pc = range.GetBaseAddress();
564                 next_frame_sc.line_entry.range.GetBaseAddress() = next_frame_pc;
565                 next_frame_sc.line_entry.file = curr_inlined_block_inlined_info->GetCallSite().GetFile();
566                 next_frame_sc.line_entry.line = curr_inlined_block_inlined_info->GetCallSite().GetLine();
567                 next_frame_sc.line_entry.column = curr_inlined_block_inlined_info->GetCallSite().GetColumn();
568                 return true;
569             }
570             else
571             {
572                 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_SYMBOLS));
573 
574                 if (log)
575                 {
576                     log->Printf ("warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64,
577                                  curr_inlined_block->GetID(), curr_frame_pc.GetFileAddress());
578                 }
579 #ifdef LLDB_CONFIGURATION_DEBUG
580                 else
581                 {
582                     ObjectFile *objfile = NULL;
583                     if (module_sp)
584                     {
585                         SymbolVendor *symbol_vendor = module_sp->GetSymbolVendor();
586                         if (symbol_vendor)
587                         {
588                             SymbolFile *symbol_file = symbol_vendor->GetSymbolFile();
589                             if (symbol_file)
590                                 objfile = symbol_file->GetObjectFile();
591                         }
592                     }
593                     if (objfile)
594                     {
595                         Host::SystemLog (Host::eSystemLogWarning,
596                                          "warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64 " in %s\n",
597                                          curr_inlined_block->GetID(),
598                                          curr_frame_pc.GetFileAddress(),
599                                          objfile->GetFileSpec().GetPath().c_str());
600                     }
601                     else
602                     {
603                         Host::SystemLog (Host::eSystemLogWarning,
604                                          "warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64 "\n",
605                                          curr_inlined_block->GetID(),
606                                          curr_frame_pc.GetFileAddress());
607                     }
608                 }
609 #endif
610             }
611         }
612     }
613 
614     return false;
615 }
616 
617 Block *
618 SymbolContext::GetFunctionBlock ()
619 {
620     if (function)
621     {
622         if (block)
623         {
624             // If this symbol context has a block, check to see if this block
625             // is itself, or is contained within a block with inlined function
626             // information. If so, then the inlined block is the block that
627             // defines the function.
628             Block *inlined_block = block->GetContainingInlinedBlock();
629             if (inlined_block)
630                 return inlined_block;
631 
632             // The block in this symbol context is not inside an inlined
633             // block, so the block that defines the function is the function's
634             // top level block, which is returned below.
635         }
636 
637         // There is no block information in this symbol context, so we must
638         // assume that the block that is desired is the top level block of
639         // the function itself.
640         return &function->GetBlock(true);
641     }
642     return nullptr;
643 }
644 
645 bool
646 SymbolContext::GetFunctionMethodInfo (lldb::LanguageType &language,
647                                       bool &is_instance_method,
648                                       ConstString &language_object_name)
649 
650 
651 {
652     Block *function_block = GetFunctionBlock();
653     if (function_block)
654     {
655         CompilerDeclContext decl_ctx = function_block->GetDeclContext();
656         if (decl_ctx)
657             return decl_ctx.IsClassMethod(&language, &is_instance_method, &language_object_name);
658     }
659     return false;
660 }
661 
662 ConstString
663 SymbolContext::GetFunctionName (Mangled::NamePreference preference) const
664 {
665     if (function)
666     {
667         if (block)
668         {
669             Block *inlined_block = block->GetContainingInlinedBlock();
670 
671             if (inlined_block)
672             {
673                 const InlineFunctionInfo *inline_info = inlined_block->GetInlinedFunctionInfo();
674                 if (inline_info)
675                     return inline_info->GetName(function->GetLanguage());
676             }
677         }
678         return function->GetMangled().GetName(function->GetLanguage(), preference);
679     }
680     else if (symbol && symbol->ValueIsAddress())
681     {
682         return symbol->GetMangled().GetName(symbol->GetLanguage(), preference);
683     }
684     else
685     {
686         // No function, return an empty string.
687         return ConstString();
688     }
689 }
690 
691 LineEntry
692 SymbolContext::GetFunctionStartLineEntry () const
693 {
694     LineEntry line_entry;
695     Address start_addr;
696     if (block)
697     {
698         Block *inlined_block = block->GetContainingInlinedBlock();
699         if (inlined_block)
700         {
701             if (inlined_block->GetStartAddress (start_addr))
702             {
703                 if (start_addr.CalculateSymbolContextLineEntry (line_entry))
704                     return line_entry;
705             }
706             return LineEntry();
707         }
708     }
709 
710     if (function)
711     {
712         if (function->GetAddressRange().GetBaseAddress().CalculateSymbolContextLineEntry(line_entry))
713             return line_entry;
714     }
715     return LineEntry();
716 }
717 
718 //----------------------------------------------------------------------
719 //
720 //  SymbolContextSpecifier
721 //
722 //----------------------------------------------------------------------
723 
724 SymbolContextSpecifier::SymbolContextSpecifier (const TargetSP &target_sp) :
725     m_target_sp (target_sp),
726     m_module_spec (),
727     m_module_sp (),
728     m_file_spec_ap (),
729     m_start_line (0),
730     m_end_line (0),
731     m_function_spec (),
732     m_class_name (),
733     m_address_range_ap (),
734     m_type (eNothingSpecified)
735 {
736 }
737 
738 SymbolContextSpecifier::~SymbolContextSpecifier()
739 {
740 }
741 
742 bool
743 SymbolContextSpecifier::AddLineSpecification (uint32_t line_no, SpecificationType type)
744 {
745     bool return_value = true;
746     switch (type)
747     {
748     case eNothingSpecified:
749         Clear();
750         break;
751     case eLineStartSpecified:
752         m_start_line = line_no;
753         m_type |= eLineStartSpecified;
754         break;
755     case eLineEndSpecified:
756         m_end_line = line_no;
757         m_type |= eLineEndSpecified;
758         break;
759     default:
760         return_value = false;
761         break;
762     }
763     return return_value;
764 }
765 
766 bool
767 SymbolContextSpecifier::AddSpecification (const char *spec_string, SpecificationType type)
768 {
769     bool return_value = true;
770     switch (type)
771     {
772     case eNothingSpecified:
773         Clear();
774         break;
775     case eModuleSpecified:
776         {
777             // See if we can find the Module, if so stick it in the SymbolContext.
778             FileSpec module_file_spec(spec_string, false);
779             ModuleSpec module_spec (module_file_spec);
780             lldb::ModuleSP module_sp (m_target_sp->GetImages().FindFirstModule (module_spec));
781             m_type |= eModuleSpecified;
782             if (module_sp)
783                 m_module_sp = module_sp;
784             else
785                 m_module_spec.assign (spec_string);
786         }
787         break;
788     case eFileSpecified:
789         // CompUnits can't necessarily be resolved here, since an inlined function might show up in
790         // a number of CompUnits.  Instead we just convert to a FileSpec and store it away.
791         m_file_spec_ap.reset (new FileSpec (spec_string, false));
792         m_type |= eFileSpecified;
793         break;
794     case eLineStartSpecified:
795         m_start_line = StringConvert::ToSInt32(spec_string, 0, 0, &return_value);
796         if (return_value)
797             m_type |= eLineStartSpecified;
798         break;
799     case eLineEndSpecified:
800         m_end_line = StringConvert::ToSInt32(spec_string, 0, 0, &return_value);
801         if (return_value)
802             m_type |= eLineEndSpecified;
803         break;
804     case eFunctionSpecified:
805         m_function_spec.assign(spec_string);
806         m_type |= eFunctionSpecified;
807         break;
808     case eClassOrNamespaceSpecified:
809         Clear();
810         m_class_name.assign (spec_string);
811         m_type = eClassOrNamespaceSpecified;
812         break;
813     case eAddressRangeSpecified:
814         // Not specified yet...
815         break;
816     }
817 
818     return return_value;
819 }
820 
821 void
822 SymbolContextSpecifier::Clear()
823 {
824     m_module_spec.clear();
825     m_file_spec_ap.reset();
826     m_function_spec.clear();
827     m_class_name.clear();
828     m_start_line = 0;
829     m_end_line = 0;
830     m_address_range_ap.reset();
831 
832     m_type = eNothingSpecified;
833 }
834 
835 bool
836 SymbolContextSpecifier::SymbolContextMatches(SymbolContext &sc)
837 {
838     if (m_type == eNothingSpecified)
839         return true;
840 
841     if (m_target_sp.get() != sc.target_sp.get())
842         return false;
843 
844     if (m_type & eModuleSpecified)
845     {
846         if (sc.module_sp)
847         {
848             if (m_module_sp.get() != nullptr)
849             {
850                 if (m_module_sp.get() != sc.module_sp.get())
851                     return false;
852             }
853             else
854             {
855                 FileSpec module_file_spec (m_module_spec.c_str(), false);
856                 if (!FileSpec::Equal (module_file_spec, sc.module_sp->GetFileSpec(), false))
857                     return false;
858             }
859         }
860     }
861     if (m_type & eFileSpecified)
862     {
863         if (m_file_spec_ap.get())
864         {
865             // If we don't have a block or a comp_unit, then we aren't going to match a source file.
866             if (sc.block == nullptr && sc.comp_unit == nullptr)
867                 return false;
868 
869             // Check if the block is present, and if so is it inlined:
870             bool was_inlined = false;
871             if (sc.block != nullptr)
872             {
873                 const InlineFunctionInfo *inline_info = sc.block->GetInlinedFunctionInfo();
874                 if (inline_info != nullptr)
875                 {
876                     was_inlined = true;
877                     if (!FileSpec::Equal (inline_info->GetDeclaration().GetFile(), *(m_file_spec_ap.get()), false))
878                         return false;
879                 }
880             }
881 
882             // Next check the comp unit, but only if the SymbolContext was not inlined.
883             if (!was_inlined && sc.comp_unit != nullptr)
884             {
885                 if (!FileSpec::Equal (*(sc.comp_unit), *(m_file_spec_ap.get()), false))
886                     return false;
887             }
888         }
889     }
890     if (m_type & eLineStartSpecified
891         || m_type & eLineEndSpecified)
892     {
893         if (sc.line_entry.line < m_start_line || sc.line_entry.line > m_end_line)
894             return false;
895     }
896 
897     if (m_type & eFunctionSpecified)
898     {
899         // First check the current block, and if it is inlined, get the inlined function name:
900         bool was_inlined = false;
901         ConstString func_name(m_function_spec.c_str());
902 
903         if (sc.block != nullptr)
904         {
905             const InlineFunctionInfo *inline_info = sc.block->GetInlinedFunctionInfo();
906             if (inline_info != nullptr)
907             {
908                 was_inlined = true;
909                 const Mangled &name = inline_info->GetMangled();
910                 if (!name.NameMatches (func_name, sc.function->GetLanguage()))
911                     return false;
912             }
913         }
914         //  If it wasn't inlined, check the name in the function or symbol:
915         if (!was_inlined)
916         {
917             if (sc.function != nullptr)
918             {
919                 if (!sc.function->GetMangled().NameMatches(func_name, sc.function->GetLanguage()))
920                     return false;
921             }
922             else if (sc.symbol != nullptr)
923             {
924                 if (!sc.symbol->GetMangled().NameMatches(func_name, sc.function->GetLanguage()))
925                     return false;
926             }
927         }
928 
929 
930     }
931 
932     return true;
933 }
934 
935 bool
936 SymbolContextSpecifier::AddressMatches(lldb::addr_t addr)
937 {
938     if (m_type & eAddressRangeSpecified)
939     {
940 
941     }
942     else
943     {
944         Address match_address (addr, nullptr);
945         SymbolContext sc;
946         m_target_sp->GetImages().ResolveSymbolContextForAddress(match_address, eSymbolContextEverything, sc);
947         return SymbolContextMatches(sc);
948     }
949     return true;
950 }
951 
952 void
953 SymbolContextSpecifier::GetDescription (Stream *s, lldb::DescriptionLevel level) const
954 {
955     char path_str[PATH_MAX + 1];
956 
957     if (m_type == eNothingSpecified)
958     {
959         s->Printf ("Nothing specified.\n");
960     }
961 
962     if (m_type == eModuleSpecified)
963     {
964         s->Indent();
965         if (m_module_sp)
966         {
967             m_module_sp->GetFileSpec().GetPath (path_str, PATH_MAX);
968             s->Printf ("Module: %s\n", path_str);
969         }
970         else
971             s->Printf ("Module: %s\n", m_module_spec.c_str());
972     }
973 
974     if (m_type == eFileSpecified  && m_file_spec_ap.get() != nullptr)
975     {
976         m_file_spec_ap->GetPath (path_str, PATH_MAX);
977         s->Indent();
978         s->Printf ("File: %s", path_str);
979         if (m_type == eLineStartSpecified)
980         {
981             s->Printf (" from line %" PRIu64 "", (uint64_t)m_start_line);
982             if (m_type == eLineEndSpecified)
983                 s->Printf ("to line %" PRIu64 "", (uint64_t)m_end_line);
984             else
985                 s->Printf ("to end");
986         }
987         else if (m_type == eLineEndSpecified)
988         {
989             s->Printf (" from start to line %" PRIu64 "", (uint64_t)m_end_line);
990         }
991         s->Printf (".\n");
992     }
993 
994     if (m_type == eLineStartSpecified)
995     {
996         s->Indent();
997         s->Printf ("From line %" PRIu64 "", (uint64_t)m_start_line);
998         if (m_type == eLineEndSpecified)
999             s->Printf ("to line %" PRIu64 "", (uint64_t)m_end_line);
1000         else
1001             s->Printf ("to end");
1002         s->Printf (".\n");
1003     }
1004     else if (m_type == eLineEndSpecified)
1005     {
1006         s->Printf ("From start to line %" PRIu64 ".\n", (uint64_t)m_end_line);
1007     }
1008 
1009     if (m_type == eFunctionSpecified)
1010     {
1011         s->Indent();
1012         s->Printf ("Function: %s.\n", m_function_spec.c_str());
1013     }
1014 
1015     if (m_type == eClassOrNamespaceSpecified)
1016     {
1017         s->Indent();
1018         s->Printf ("Class name: %s.\n", m_class_name.c_str());
1019     }
1020 
1021     if (m_type == eAddressRangeSpecified && m_address_range_ap.get() != nullptr)
1022     {
1023         s->Indent();
1024         s->PutCString ("Address range: ");
1025         m_address_range_ap->Dump (s, m_target_sp.get(), Address::DumpStyleLoadAddress, Address::DumpStyleFileAddress);
1026         s->PutCString ("\n");
1027     }
1028 }
1029 
1030 //----------------------------------------------------------------------
1031 //
1032 //  SymbolContextList
1033 //
1034 //----------------------------------------------------------------------
1035 
1036 
1037 SymbolContextList::SymbolContextList() :
1038     m_symbol_contexts()
1039 {
1040 }
1041 
1042 SymbolContextList::~SymbolContextList()
1043 {
1044 }
1045 
1046 void
1047 SymbolContextList::Append(const SymbolContext& sc)
1048 {
1049     m_symbol_contexts.push_back(sc);
1050 }
1051 
1052 void
1053 SymbolContextList::Append (const SymbolContextList& sc_list)
1054 {
1055     collection::const_iterator pos, end = sc_list.m_symbol_contexts.end();
1056     for (pos = sc_list.m_symbol_contexts.begin(); pos != end; ++pos)
1057         m_symbol_contexts.push_back (*pos);
1058 }
1059 
1060 
1061 uint32_t
1062 SymbolContextList::AppendIfUnique (const SymbolContextList& sc_list, bool merge_symbol_into_function)
1063 {
1064     uint32_t unique_sc_add_count = 0;
1065     collection::const_iterator pos, end = sc_list.m_symbol_contexts.end();
1066     for (pos = sc_list.m_symbol_contexts.begin(); pos != end; ++pos)
1067     {
1068         if (AppendIfUnique (*pos, merge_symbol_into_function))
1069             ++unique_sc_add_count;
1070     }
1071     return unique_sc_add_count;
1072 }
1073 
1074 bool
1075 SymbolContextList::AppendIfUnique (const SymbolContext& sc, bool merge_symbol_into_function)
1076 {
1077     collection::iterator pos, end = m_symbol_contexts.end();
1078     for (pos = m_symbol_contexts.begin(); pos != end; ++pos)
1079     {
1080         if (*pos == sc)
1081             return false;
1082     }
1083     if (merge_symbol_into_function
1084         && sc.symbol    != nullptr
1085         && sc.comp_unit == nullptr
1086         && sc.function  == nullptr
1087         && sc.block     == nullptr
1088         && sc.line_entry.IsValid() == false)
1089     {
1090         if (sc.symbol->ValueIsAddress())
1091         {
1092             for (pos = m_symbol_contexts.begin(); pos != end; ++pos)
1093             {
1094                 // Don't merge symbols into inlined function symbol contexts
1095                 if (pos->block && pos->block->GetContainingInlinedBlock())
1096                     continue;
1097 
1098                 if (pos->function)
1099                 {
1100                     if (pos->function->GetAddressRange().GetBaseAddress() == sc.symbol->GetAddressRef())
1101                     {
1102                         // Do we already have a function with this symbol?
1103                         if (pos->symbol == sc.symbol)
1104                             return false;
1105                         if (pos->symbol == nullptr)
1106                         {
1107                             pos->symbol = sc.symbol;
1108                             return false;
1109                         }
1110                     }
1111                 }
1112             }
1113         }
1114     }
1115     m_symbol_contexts.push_back(sc);
1116     return true;
1117 }
1118 
1119 bool
1120 SymbolContextList::MergeSymbolContextIntoFunctionContext (const SymbolContext& symbol_sc,
1121                                                           uint32_t start_idx,
1122                                                           uint32_t stop_idx)
1123 {
1124     if (symbol_sc.symbol    != nullptr
1125         && symbol_sc.comp_unit == nullptr
1126         && symbol_sc.function  == nullptr
1127         && symbol_sc.block     == nullptr
1128         && symbol_sc.line_entry.IsValid() == false)
1129     {
1130         if (symbol_sc.symbol->ValueIsAddress())
1131         {
1132             const size_t end = std::min<size_t>(m_symbol_contexts.size(), stop_idx);
1133             for (size_t i=start_idx; i<end; ++i)
1134             {
1135                 const SymbolContext &function_sc = m_symbol_contexts[i];
1136                 // Don't merge symbols into inlined function symbol contexts
1137                 if (function_sc.block && function_sc.block->GetContainingInlinedBlock())
1138                     continue;
1139 
1140                 if (function_sc.function)
1141                 {
1142                     if (function_sc.function->GetAddressRange().GetBaseAddress() == symbol_sc.symbol->GetAddressRef())
1143                     {
1144                         // Do we already have a function with this symbol?
1145                         if (function_sc.symbol == symbol_sc.symbol)
1146                             return true; // Already have a symbol context with this symbol, return true
1147 
1148                         if (function_sc.symbol == nullptr)
1149                         {
1150                             // We successfully merged this symbol into an existing symbol context
1151                             m_symbol_contexts[i].symbol = symbol_sc.symbol;
1152                             return true;
1153                         }
1154                     }
1155                 }
1156             }
1157         }
1158     }
1159     return false;
1160 }
1161 
1162 void
1163 SymbolContextList::Clear()
1164 {
1165     m_symbol_contexts.clear();
1166 }
1167 
1168 void
1169 SymbolContextList::Dump(Stream *s, Target *target) const
1170 {
1171 
1172     *s << this << ": ";
1173     s->Indent();
1174     s->PutCString("SymbolContextList");
1175     s->EOL();
1176     s->IndentMore();
1177 
1178     collection::const_iterator pos, end = m_symbol_contexts.end();
1179     for (pos = m_symbol_contexts.begin(); pos != end; ++pos)
1180     {
1181         //pos->Dump(s, target);
1182         pos->GetDescription(s, eDescriptionLevelVerbose, target);
1183     }
1184     s->IndentLess();
1185 }
1186 
1187 bool
1188 SymbolContextList::GetContextAtIndex(size_t idx, SymbolContext& sc) const
1189 {
1190     if (idx < m_symbol_contexts.size())
1191     {
1192         sc = m_symbol_contexts[idx];
1193         return true;
1194     }
1195     return false;
1196 }
1197 
1198 bool
1199 SymbolContextList::GetLastContext(SymbolContext& sc) const
1200 {
1201     if (!m_symbol_contexts.empty())
1202     {
1203         sc = m_symbol_contexts.back();
1204         return true;
1205     }
1206     return false;
1207 }
1208 
1209 bool
1210 SymbolContextList::RemoveContextAtIndex (size_t idx)
1211 {
1212     if (idx < m_symbol_contexts.size())
1213     {
1214         m_symbol_contexts.erase(m_symbol_contexts.begin() + idx);
1215         return true;
1216     }
1217     return false;
1218 }
1219 
1220 uint32_t
1221 SymbolContextList::GetSize() const
1222 {
1223     return m_symbol_contexts.size();
1224 }
1225 
1226 uint32_t
1227 SymbolContextList::NumLineEntriesWithLine (uint32_t line) const
1228 {
1229     uint32_t match_count = 0;
1230     const size_t size = m_symbol_contexts.size();
1231     for (size_t idx = 0; idx<size; ++idx)
1232     {
1233         if (m_symbol_contexts[idx].line_entry.line == line)
1234             ++match_count;
1235     }
1236     return match_count;
1237 }
1238 
1239 void
1240 SymbolContextList::GetDescription(Stream *s,
1241                                   lldb::DescriptionLevel level,
1242                                   Target *target) const
1243 {
1244     const size_t size = m_symbol_contexts.size();
1245     for (size_t idx = 0; idx<size; ++idx)
1246         m_symbol_contexts[idx].GetDescription (s, level, target);
1247 }
1248 
1249 bool
1250 lldb_private::operator== (const SymbolContextList& lhs, const SymbolContextList& rhs)
1251 {
1252     const uint32_t size = lhs.GetSize();
1253     if (size != rhs.GetSize())
1254         return false;
1255 
1256     SymbolContext lhs_sc;
1257     SymbolContext rhs_sc;
1258     for (uint32_t i=0; i<size; ++i)
1259     {
1260         lhs.GetContextAtIndex(i, lhs_sc);
1261         rhs.GetContextAtIndex(i, rhs_sc);
1262         if (lhs_sc != rhs_sc)
1263             return false;
1264     }
1265     return true;
1266 }
1267 
1268 bool
1269 lldb_private::operator!= (const SymbolContextList& lhs, const SymbolContextList& rhs)
1270 {
1271     return !(lhs == rhs);
1272 }
1273 
1274