1 //===-- Address.cpp ---------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Core/Address.h"
10 #include "lldb/Core/DumpDataExtractor.h"
11 #include "lldb/Core/Module.h"
12 #include "lldb/Core/ModuleList.h"
13 #include "lldb/Core/Section.h"
14 #include "lldb/Symbol/Block.h"
15 #include "lldb/Symbol/Declaration.h"
16 #include "lldb/Symbol/LineEntry.h"
17 #include "lldb/Symbol/ObjectFile.h"
18 #include "lldb/Symbol/Symbol.h"
19 #include "lldb/Symbol/SymbolContext.h"
20 #include "lldb/Symbol/SymbolVendor.h"
21 #include "lldb/Symbol/Symtab.h"
22 #include "lldb/Symbol/Type.h"
23 #include "lldb/Symbol/Variable.h"
24 #include "lldb/Symbol/VariableList.h"
25 #include "lldb/Target/ExecutionContext.h"
26 #include "lldb/Target/ExecutionContextScope.h"
27 #include "lldb/Target/Process.h"
28 #include "lldb/Target/SectionLoadList.h"
29 #include "lldb/Target/Target.h"
30 #include "lldb/Utility/ConstString.h"
31 #include "lldb/Utility/DataExtractor.h"
32 #include "lldb/Utility/Endian.h"
33 #include "lldb/Utility/FileSpec.h"
34 #include "lldb/Utility/Status.h"
35 #include "lldb/Utility/Stream.h"
36 #include "lldb/Utility/StreamString.h"
37 
38 #include "llvm/ADT/StringRef.h"
39 #include "llvm/ADT/Triple.h"
40 #include "llvm/Support/Compiler.h"
41 
42 #include <cstdint>
43 #include <memory>
44 #include <vector>
45 
46 #include <assert.h>
47 #include <inttypes.h>
48 #include <string.h>
49 
50 namespace lldb_private {
51 class CompileUnit;
52 }
53 namespace lldb_private {
54 class Function;
55 }
56 
57 using namespace lldb;
58 using namespace lldb_private;
59 
60 static size_t ReadBytes(ExecutionContextScope *exe_scope,
61                         const Address &address, void *dst, size_t dst_len) {
62   if (exe_scope == nullptr)
63     return 0;
64 
65   TargetSP target_sp(exe_scope->CalculateTarget());
66   if (target_sp) {
67     Status error;
68     bool prefer_file_cache = false;
69     return target_sp->ReadMemory(address, prefer_file_cache, dst, dst_len,
70                                  error);
71   }
72   return 0;
73 }
74 
75 static bool GetByteOrderAndAddressSize(ExecutionContextScope *exe_scope,
76                                        const Address &address,
77                                        ByteOrder &byte_order,
78                                        uint32_t &addr_size) {
79   byte_order = eByteOrderInvalid;
80   addr_size = 0;
81   if (exe_scope == nullptr)
82     return false;
83 
84   TargetSP target_sp(exe_scope->CalculateTarget());
85   if (target_sp) {
86     byte_order = target_sp->GetArchitecture().GetByteOrder();
87     addr_size = target_sp->GetArchitecture().GetAddressByteSize();
88   }
89 
90   if (byte_order == eByteOrderInvalid || addr_size == 0) {
91     ModuleSP module_sp(address.GetModule());
92     if (module_sp) {
93       byte_order = module_sp->GetArchitecture().GetByteOrder();
94       addr_size = module_sp->GetArchitecture().GetAddressByteSize();
95     }
96   }
97   return byte_order != eByteOrderInvalid && addr_size != 0;
98 }
99 
100 static uint64_t ReadUIntMax64(ExecutionContextScope *exe_scope,
101                               const Address &address, uint32_t byte_size,
102                               bool &success) {
103   uint64_t uval64 = 0;
104   if (exe_scope == nullptr || byte_size > sizeof(uint64_t)) {
105     success = false;
106     return 0;
107   }
108   uint64_t buf = 0;
109 
110   success = ReadBytes(exe_scope, address, &buf, byte_size) == byte_size;
111   if (success) {
112     ByteOrder byte_order = eByteOrderInvalid;
113     uint32_t addr_size = 0;
114     if (GetByteOrderAndAddressSize(exe_scope, address, byte_order, addr_size)) {
115       DataExtractor data(&buf, sizeof(buf), byte_order, addr_size);
116       lldb::offset_t offset = 0;
117       uval64 = data.GetU64(&offset);
118     } else
119       success = false;
120   }
121   return uval64;
122 }
123 
124 static bool ReadAddress(ExecutionContextScope *exe_scope,
125                         const Address &address, uint32_t pointer_size,
126                         Address &deref_so_addr) {
127   if (exe_scope == nullptr)
128     return false;
129 
130   bool success = false;
131   addr_t deref_addr = ReadUIntMax64(exe_scope, address, pointer_size, success);
132   if (success) {
133     ExecutionContext exe_ctx;
134     exe_scope->CalculateExecutionContext(exe_ctx);
135     // If we have any sections that are loaded, try and resolve using the
136     // section load list
137     Target *target = exe_ctx.GetTargetPtr();
138     if (target && !target->GetSectionLoadList().IsEmpty()) {
139       if (target->GetSectionLoadList().ResolveLoadAddress(deref_addr,
140                                                           deref_so_addr))
141         return true;
142     } else {
143       // If we were not running, yet able to read an integer, we must have a
144       // module
145       ModuleSP module_sp(address.GetModule());
146 
147       assert(module_sp);
148       if (module_sp->ResolveFileAddress(deref_addr, deref_so_addr))
149         return true;
150     }
151 
152     // We couldn't make "deref_addr" into a section offset value, but we were
153     // able to read the address, so we return a section offset address with no
154     // section and "deref_addr" as the offset (address).
155     deref_so_addr.SetRawAddress(deref_addr);
156     return true;
157   }
158   return false;
159 }
160 
161 static bool DumpUInt(ExecutionContextScope *exe_scope, const Address &address,
162                      uint32_t byte_size, Stream *strm) {
163   if (exe_scope == nullptr || byte_size == 0)
164     return false;
165   std::vector<uint8_t> buf(byte_size, 0);
166 
167   if (ReadBytes(exe_scope, address, &buf[0], buf.size()) == buf.size()) {
168     ByteOrder byte_order = eByteOrderInvalid;
169     uint32_t addr_size = 0;
170     if (GetByteOrderAndAddressSize(exe_scope, address, byte_order, addr_size)) {
171       DataExtractor data(&buf.front(), buf.size(), byte_order, addr_size);
172 
173       DumpDataExtractor(data, strm,
174                         0,                    // Start offset in "data"
175                         eFormatHex,           // Print as characters
176                         buf.size(),           // Size of item
177                         1,                    // Items count
178                         UINT32_MAX,           // num per line
179                         LLDB_INVALID_ADDRESS, // base address
180                         0,                    // bitfield bit size
181                         0);                   // bitfield bit offset
182 
183       return true;
184     }
185   }
186   return false;
187 }
188 
189 static size_t ReadCStringFromMemory(ExecutionContextScope *exe_scope,
190                                     const Address &address, Stream *strm) {
191   if (exe_scope == nullptr)
192     return 0;
193   const size_t k_buf_len = 256;
194   char buf[k_buf_len + 1];
195   buf[k_buf_len] = '\0'; // NULL terminate
196 
197   // Byte order and address size don't matter for C string dumping..
198   DataExtractor data(buf, sizeof(buf), endian::InlHostByteOrder(), 4);
199   size_t total_len = 0;
200   size_t bytes_read;
201   Address curr_address(address);
202   strm->PutChar('"');
203   while ((bytes_read = ReadBytes(exe_scope, curr_address, buf, k_buf_len)) >
204          0) {
205     size_t len = strlen(buf);
206     if (len == 0)
207       break;
208     if (len > bytes_read)
209       len = bytes_read;
210 
211     DumpDataExtractor(data, strm,
212                       0,                    // Start offset in "data"
213                       eFormatChar,          // Print as characters
214                       1,                    // Size of item (1 byte for a char!)
215                       len,                  // How many bytes to print?
216                       UINT32_MAX,           // num per line
217                       LLDB_INVALID_ADDRESS, // base address
218                       0,                    // bitfield bit size
219 
220                       0); // bitfield bit offset
221 
222     total_len += bytes_read;
223 
224     if (len < k_buf_len)
225       break;
226     curr_address.SetOffset(curr_address.GetOffset() + bytes_read);
227   }
228   strm->PutChar('"');
229   return total_len;
230 }
231 
232 Address::Address(lldb::addr_t abs_addr) : m_section_wp(), m_offset(abs_addr) {}
233 
234 Address::Address(addr_t address, const SectionList *section_list)
235     : m_section_wp(), m_offset(LLDB_INVALID_ADDRESS) {
236   ResolveAddressUsingFileSections(address, section_list);
237 }
238 
239 const Address &Address::operator=(const Address &rhs) {
240   if (this != &rhs) {
241     m_section_wp = rhs.m_section_wp;
242     m_offset = rhs.m_offset;
243   }
244   return *this;
245 }
246 
247 bool Address::ResolveAddressUsingFileSections(addr_t file_addr,
248                                               const SectionList *section_list) {
249   if (section_list) {
250     SectionSP section_sp(
251         section_list->FindSectionContainingFileAddress(file_addr));
252     m_section_wp = section_sp;
253     if (section_sp) {
254       assert(section_sp->ContainsFileAddress(file_addr));
255       m_offset = file_addr - section_sp->GetFileAddress();
256       return true; // Successfully transformed addr into a section offset
257                    // address
258     }
259   }
260   m_offset = file_addr;
261   return false; // Failed to resolve this address to a section offset value
262 }
263 
264 /// if "addr_range_ptr" is not NULL, then fill in with the address range of the function.
265 bool Address::ResolveFunctionScope(SymbolContext &sym_ctx,
266                                    AddressRange *addr_range_ptr) {
267   constexpr SymbolContextItem resolve_scope =
268     eSymbolContextFunction | eSymbolContextSymbol;
269 
270   if (!(CalculateSymbolContext(&sym_ctx, resolve_scope) & resolve_scope)) {
271     if (addr_range_ptr)
272       addr_range_ptr->Clear();
273    return false;
274   }
275 
276   if (!addr_range_ptr)
277     return true;
278 
279   return sym_ctx.GetAddressRange(resolve_scope, 0, false, *addr_range_ptr);
280 }
281 
282 ModuleSP Address::GetModule() const {
283   lldb::ModuleSP module_sp;
284   SectionSP section_sp(GetSection());
285   if (section_sp)
286     module_sp = section_sp->GetModule();
287   return module_sp;
288 }
289 
290 addr_t Address::GetFileAddress() const {
291   SectionSP section_sp(GetSection());
292   if (section_sp) {
293     addr_t sect_file_addr = section_sp->GetFileAddress();
294     if (sect_file_addr == LLDB_INVALID_ADDRESS) {
295       // Section isn't resolved, we can't return a valid file address
296       return LLDB_INVALID_ADDRESS;
297     }
298     // We have a valid file range, so we can return the file based address by
299     // adding the file base address to our offset
300     return sect_file_addr + m_offset;
301   } else if (SectionWasDeletedPrivate()) {
302     // Used to have a valid section but it got deleted so the offset doesn't
303     // mean anything without the section
304     return LLDB_INVALID_ADDRESS;
305   }
306   // No section, we just return the offset since it is the value in this case
307   return m_offset;
308 }
309 
310 addr_t Address::GetLoadAddress(Target *target) const {
311   SectionSP section_sp(GetSection());
312   if (section_sp) {
313     if (target) {
314       addr_t sect_load_addr = section_sp->GetLoadBaseAddress(target);
315 
316       if (sect_load_addr != LLDB_INVALID_ADDRESS) {
317         // We have a valid file range, so we can return the file based address
318         // by adding the file base address to our offset
319         return sect_load_addr + m_offset;
320       }
321     }
322   } else if (SectionWasDeletedPrivate()) {
323     // Used to have a valid section but it got deleted so the offset doesn't
324     // mean anything without the section
325     return LLDB_INVALID_ADDRESS;
326   } else {
327     // We don't have a section so the offset is the load address
328     return m_offset;
329   }
330   // The section isn't resolved or an invalid target was passed in so we can't
331   // return a valid load address.
332   return LLDB_INVALID_ADDRESS;
333 }
334 
335 addr_t Address::GetCallableLoadAddress(Target *target, bool is_indirect) const {
336   addr_t code_addr = LLDB_INVALID_ADDRESS;
337 
338   if (is_indirect && target) {
339     ProcessSP processSP = target->GetProcessSP();
340     Status error;
341     if (processSP) {
342       code_addr = processSP->ResolveIndirectFunction(this, error);
343       if (!error.Success())
344         code_addr = LLDB_INVALID_ADDRESS;
345     }
346   } else {
347     code_addr = GetLoadAddress(target);
348   }
349 
350   if (code_addr == LLDB_INVALID_ADDRESS)
351     return code_addr;
352 
353   if (target)
354     return target->GetCallableLoadAddress(code_addr, GetAddressClass());
355   return code_addr;
356 }
357 
358 bool Address::SetCallableLoadAddress(lldb::addr_t load_addr, Target *target) {
359   if (SetLoadAddress(load_addr, target)) {
360     if (target)
361       m_offset = target->GetCallableLoadAddress(m_offset, GetAddressClass());
362     return true;
363   }
364   return false;
365 }
366 
367 addr_t Address::GetOpcodeLoadAddress(Target *target,
368                                      AddressClass addr_class) const {
369   addr_t code_addr = GetLoadAddress(target);
370   if (code_addr != LLDB_INVALID_ADDRESS) {
371     if (addr_class == AddressClass::eInvalid)
372       addr_class = GetAddressClass();
373     code_addr = target->GetOpcodeLoadAddress(code_addr, addr_class);
374   }
375   return code_addr;
376 }
377 
378 bool Address::SetOpcodeLoadAddress(lldb::addr_t load_addr, Target *target,
379                                    AddressClass addr_class,
380                                    bool allow_section_end) {
381   if (SetLoadAddress(load_addr, target, allow_section_end)) {
382     if (target) {
383       if (addr_class == AddressClass::eInvalid)
384         addr_class = GetAddressClass();
385       m_offset = target->GetOpcodeLoadAddress(m_offset, addr_class);
386     }
387     return true;
388   }
389   return false;
390 }
391 
392 bool Address::Dump(Stream *s, ExecutionContextScope *exe_scope, DumpStyle style,
393                    DumpStyle fallback_style, uint32_t addr_size) const {
394   // If the section was nullptr, only load address is going to work unless we
395   // are trying to deref a pointer
396   SectionSP section_sp(GetSection());
397   if (!section_sp && style != DumpStyleResolvedPointerDescription)
398     style = DumpStyleLoadAddress;
399 
400   ExecutionContext exe_ctx(exe_scope);
401   Target *target = exe_ctx.GetTargetPtr();
402   // If addr_byte_size is UINT32_MAX, then determine the correct address byte
403   // size for the process or default to the size of addr_t
404   if (addr_size == UINT32_MAX) {
405     if (target)
406       addr_size = target->GetArchitecture().GetAddressByteSize();
407     else
408       addr_size = sizeof(addr_t);
409   }
410 
411   Address so_addr;
412   switch (style) {
413   case DumpStyleInvalid:
414     return false;
415 
416   case DumpStyleSectionNameOffset:
417     if (section_sp) {
418       section_sp->DumpName(s);
419       s->Printf(" + %" PRIu64, m_offset);
420     } else {
421       s->Address(m_offset, addr_size);
422     }
423     break;
424 
425   case DumpStyleSectionPointerOffset:
426     s->Printf("(Section *)%p + ", static_cast<void *>(section_sp.get()));
427     s->Address(m_offset, addr_size);
428     break;
429 
430   case DumpStyleModuleWithFileAddress:
431     if (section_sp) {
432       ModuleSP module_sp = section_sp->GetModule();
433       if (module_sp)
434         s->Printf("%s[", module_sp->GetFileSpec().GetFilename().AsCString(
435                              "<Unknown>"));
436       else
437         s->Printf("%s[", "<Unknown>");
438     }
439     LLVM_FALLTHROUGH;
440   case DumpStyleFileAddress: {
441     addr_t file_addr = GetFileAddress();
442     if (file_addr == LLDB_INVALID_ADDRESS) {
443       if (fallback_style != DumpStyleInvalid)
444         return Dump(s, exe_scope, fallback_style, DumpStyleInvalid, addr_size);
445       return false;
446     }
447     s->Address(file_addr, addr_size);
448     if (style == DumpStyleModuleWithFileAddress && section_sp)
449       s->PutChar(']');
450   } break;
451 
452   case DumpStyleLoadAddress: {
453     addr_t load_addr = GetLoadAddress(target);
454 
455     /*
456      * MIPS:
457      * Display address in compressed form for MIPS16 or microMIPS
458      * if the address belongs to AddressClass::eCodeAlternateISA.
459     */
460     if (target) {
461       const llvm::Triple::ArchType llvm_arch =
462           target->GetArchitecture().GetMachine();
463       if (llvm_arch == llvm::Triple::mips ||
464           llvm_arch == llvm::Triple::mipsel ||
465           llvm_arch == llvm::Triple::mips64 ||
466           llvm_arch == llvm::Triple::mips64el)
467         load_addr = GetCallableLoadAddress(target);
468     }
469 
470     if (load_addr == LLDB_INVALID_ADDRESS) {
471       if (fallback_style != DumpStyleInvalid)
472         return Dump(s, exe_scope, fallback_style, DumpStyleInvalid, addr_size);
473       return false;
474     }
475     s->Address(load_addr, addr_size);
476   } break;
477 
478   case DumpStyleResolvedDescription:
479   case DumpStyleResolvedDescriptionNoModule:
480   case DumpStyleResolvedDescriptionNoFunctionArguments:
481   case DumpStyleNoFunctionName:
482     if (IsSectionOffset()) {
483       uint32_t pointer_size = 4;
484       ModuleSP module_sp(GetModule());
485       if (target)
486         pointer_size = target->GetArchitecture().GetAddressByteSize();
487       else if (module_sp)
488         pointer_size = module_sp->GetArchitecture().GetAddressByteSize();
489 
490       bool showed_info = false;
491       if (section_sp) {
492         SectionType sect_type = section_sp->GetType();
493         switch (sect_type) {
494         case eSectionTypeData:
495           if (module_sp) {
496             SymbolVendor *sym_vendor = module_sp->GetSymbolVendor();
497             if (sym_vendor) {
498               Symtab *symtab = sym_vendor->GetSymtab();
499               if (symtab) {
500                 const addr_t file_Addr = GetFileAddress();
501                 Symbol *symbol =
502                     symtab->FindSymbolContainingFileAddress(file_Addr);
503                 if (symbol) {
504                   const char *symbol_name = symbol->GetName().AsCString();
505                   if (symbol_name) {
506                     s->PutCString(symbol_name);
507                     addr_t delta =
508                         file_Addr - symbol->GetAddressRef().GetFileAddress();
509                     if (delta)
510                       s->Printf(" + %" PRIu64, delta);
511                     showed_info = true;
512                   }
513                 }
514               }
515             }
516           }
517           break;
518 
519         case eSectionTypeDataCString:
520           // Read the C string from memory and display it
521           showed_info = true;
522           ReadCStringFromMemory(exe_scope, *this, s);
523           break;
524 
525         case eSectionTypeDataCStringPointers:
526           if (ReadAddress(exe_scope, *this, pointer_size, so_addr)) {
527 #if VERBOSE_OUTPUT
528             s->PutCString("(char *)");
529             so_addr.Dump(s, exe_scope, DumpStyleLoadAddress,
530                          DumpStyleFileAddress);
531             s->PutCString(": ");
532 #endif
533             showed_info = true;
534             ReadCStringFromMemory(exe_scope, so_addr, s);
535           }
536           break;
537 
538         case eSectionTypeDataObjCMessageRefs:
539           if (ReadAddress(exe_scope, *this, pointer_size, so_addr)) {
540             if (target && so_addr.IsSectionOffset()) {
541               SymbolContext func_sc;
542               target->GetImages().ResolveSymbolContextForAddress(
543                   so_addr, eSymbolContextEverything, func_sc);
544               if (func_sc.function != nullptr || func_sc.symbol != nullptr) {
545                 showed_info = true;
546 #if VERBOSE_OUTPUT
547                 s->PutCString("(objc_msgref *) -> { (func*)");
548                 so_addr.Dump(s, exe_scope, DumpStyleLoadAddress,
549                              DumpStyleFileAddress);
550 #else
551                 s->PutCString("{ ");
552 #endif
553                 Address cstr_addr(*this);
554                 cstr_addr.SetOffset(cstr_addr.GetOffset() + pointer_size);
555                 func_sc.DumpStopContext(s, exe_scope, so_addr, true, true,
556                                         false, true, true);
557                 if (ReadAddress(exe_scope, cstr_addr, pointer_size, so_addr)) {
558 #if VERBOSE_OUTPUT
559                   s->PutCString("), (char *)");
560                   so_addr.Dump(s, exe_scope, DumpStyleLoadAddress,
561                                DumpStyleFileAddress);
562                   s->PutCString(" (");
563 #else
564                   s->PutCString(", ");
565 #endif
566                   ReadCStringFromMemory(exe_scope, so_addr, s);
567                 }
568 #if VERBOSE_OUTPUT
569                 s->PutCString(") }");
570 #else
571                 s->PutCString(" }");
572 #endif
573               }
574             }
575           }
576           break;
577 
578         case eSectionTypeDataObjCCFStrings: {
579           Address cfstring_data_addr(*this);
580           cfstring_data_addr.SetOffset(cfstring_data_addr.GetOffset() +
581                                        (2 * pointer_size));
582           if (ReadAddress(exe_scope, cfstring_data_addr, pointer_size,
583                           so_addr)) {
584 #if VERBOSE_OUTPUT
585             s->PutCString("(CFString *) ");
586             cfstring_data_addr.Dump(s, exe_scope, DumpStyleLoadAddress,
587                                     DumpStyleFileAddress);
588             s->PutCString(" -> @");
589 #else
590             s->PutChar('@');
591 #endif
592             if (so_addr.Dump(s, exe_scope, DumpStyleResolvedDescription))
593               showed_info = true;
594           }
595         } break;
596 
597         case eSectionTypeData4:
598           // Read the 4 byte data and display it
599           showed_info = true;
600           s->PutCString("(uint32_t) ");
601           DumpUInt(exe_scope, *this, 4, s);
602           break;
603 
604         case eSectionTypeData8:
605           // Read the 8 byte data and display it
606           showed_info = true;
607           s->PutCString("(uint64_t) ");
608           DumpUInt(exe_scope, *this, 8, s);
609           break;
610 
611         case eSectionTypeData16:
612           // Read the 16 byte data and display it
613           showed_info = true;
614           s->PutCString("(uint128_t) ");
615           DumpUInt(exe_scope, *this, 16, s);
616           break;
617 
618         case eSectionTypeDataPointers:
619           // Read the pointer data and display it
620           if (ReadAddress(exe_scope, *this, pointer_size, so_addr)) {
621             s->PutCString("(void *)");
622             so_addr.Dump(s, exe_scope, DumpStyleLoadAddress,
623                          DumpStyleFileAddress);
624 
625             showed_info = true;
626             if (so_addr.IsSectionOffset()) {
627               SymbolContext pointer_sc;
628               if (target) {
629                 target->GetImages().ResolveSymbolContextForAddress(
630                     so_addr, eSymbolContextEverything, pointer_sc);
631                 if (pointer_sc.function != nullptr ||
632                     pointer_sc.symbol != nullptr) {
633                   s->PutCString(": ");
634                   pointer_sc.DumpStopContext(s, exe_scope, so_addr, true, false,
635                                              false, true, true);
636                 }
637               }
638             }
639           }
640           break;
641 
642         default:
643           break;
644         }
645       }
646 
647       if (!showed_info) {
648         if (module_sp) {
649           SymbolContext sc;
650           module_sp->ResolveSymbolContextForAddress(
651               *this, eSymbolContextEverything, sc);
652           if (sc.function || sc.symbol) {
653             bool show_stop_context = true;
654             const bool show_module = (style == DumpStyleResolvedDescription);
655             const bool show_fullpaths = false;
656             const bool show_inlined_frames = true;
657             const bool show_function_arguments =
658                 (style != DumpStyleResolvedDescriptionNoFunctionArguments);
659             const bool show_function_name = (style != DumpStyleNoFunctionName);
660             if (sc.function == nullptr && sc.symbol != nullptr) {
661               // If we have just a symbol make sure it is in the right section
662               if (sc.symbol->ValueIsAddress()) {
663                 if (sc.symbol->GetAddressRef().GetSection() != GetSection()) {
664                   // don't show the module if the symbol is a trampoline symbol
665                   show_stop_context = false;
666                 }
667               }
668             }
669             if (show_stop_context) {
670               // We have a function or a symbol from the same sections as this
671               // address.
672               sc.DumpStopContext(s, exe_scope, *this, show_fullpaths,
673                                  show_module, show_inlined_frames,
674                                  show_function_arguments, show_function_name);
675             } else {
676               // We found a symbol but it was in a different section so it
677               // isn't the symbol we should be showing, just show the section
678               // name + offset
679               Dump(s, exe_scope, DumpStyleSectionNameOffset);
680             }
681           }
682         }
683       }
684     } else {
685       if (fallback_style != DumpStyleInvalid)
686         return Dump(s, exe_scope, fallback_style, DumpStyleInvalid, addr_size);
687       return false;
688     }
689     break;
690 
691   case DumpStyleDetailedSymbolContext:
692     if (IsSectionOffset()) {
693       ModuleSP module_sp(GetModule());
694       if (module_sp) {
695         SymbolContext sc;
696         module_sp->ResolveSymbolContextForAddress(
697             *this, eSymbolContextEverything | eSymbolContextVariable, sc);
698         if (sc.symbol) {
699           // If we have just a symbol make sure it is in the same section as
700           // our address. If it isn't, then we might have just found the last
701           // symbol that came before the address that we are looking up that
702           // has nothing to do with our address lookup.
703           if (sc.symbol->ValueIsAddress() &&
704               sc.symbol->GetAddressRef().GetSection() != GetSection())
705             sc.symbol = nullptr;
706         }
707         sc.GetDescription(s, eDescriptionLevelBrief, target);
708 
709         if (sc.block) {
710           bool can_create = true;
711           bool get_parent_variables = true;
712           bool stop_if_block_is_inlined_function = false;
713           VariableList variable_list;
714           sc.block->AppendVariables(can_create, get_parent_variables,
715                                     stop_if_block_is_inlined_function,
716                                     [](Variable *) { return true; },
717                                     &variable_list);
718 
719           const size_t num_variables = variable_list.GetSize();
720           for (size_t var_idx = 0; var_idx < num_variables; ++var_idx) {
721             Variable *var = variable_list.GetVariableAtIndex(var_idx).get();
722             if (var && var->LocationIsValidForAddress(*this)) {
723               s->Indent();
724               s->Printf("   Variable: id = {0x%8.8" PRIx64 "}, name = \"%s\"",
725                         var->GetID(), var->GetName().GetCString());
726               Type *type = var->GetType();
727               if (type)
728                 s->Printf(", type = \"%s\"", type->GetName().GetCString());
729               else
730                 s->PutCString(", type = <unknown>");
731               s->PutCString(", location = ");
732               var->DumpLocationForAddress(s, *this);
733               s->PutCString(", decl = ");
734               var->GetDeclaration().DumpStopContext(s, false);
735               s->EOL();
736             }
737           }
738         }
739       }
740     } else {
741       if (fallback_style != DumpStyleInvalid)
742         return Dump(s, exe_scope, fallback_style, DumpStyleInvalid, addr_size);
743       return false;
744     }
745     break;
746 
747   case DumpStyleResolvedPointerDescription: {
748     Process *process = exe_ctx.GetProcessPtr();
749     if (process) {
750       addr_t load_addr = GetLoadAddress(target);
751       if (load_addr != LLDB_INVALID_ADDRESS) {
752         Status memory_error;
753         addr_t dereferenced_load_addr =
754             process->ReadPointerFromMemory(load_addr, memory_error);
755         if (dereferenced_load_addr != LLDB_INVALID_ADDRESS) {
756           Address dereferenced_addr;
757           if (dereferenced_addr.SetLoadAddress(dereferenced_load_addr,
758                                                target)) {
759             StreamString strm;
760             if (dereferenced_addr.Dump(&strm, exe_scope,
761                                        DumpStyleResolvedDescription,
762                                        DumpStyleInvalid, addr_size)) {
763               s->Address(dereferenced_load_addr, addr_size, " -> ", " ");
764               s->Write(strm.GetString().data(), strm.GetSize());
765               return true;
766             }
767           }
768         }
769       }
770     }
771     if (fallback_style != DumpStyleInvalid)
772       return Dump(s, exe_scope, fallback_style, DumpStyleInvalid, addr_size);
773     return false;
774   } break;
775   }
776 
777   return true;
778 }
779 
780 bool Address::SectionWasDeleted() const {
781   if (GetSection())
782     return false;
783   return SectionWasDeletedPrivate();
784 }
785 
786 bool Address::SectionWasDeletedPrivate() const {
787   lldb::SectionWP empty_section_wp;
788 
789   // If either call to "std::weak_ptr::owner_before(...) value returns true,
790   // this indicates that m_section_wp once contained (possibly still does) a
791   // reference to a valid shared pointer. This helps us know if we had a valid
792   // reference to a section which is now invalid because the module it was in
793   // was unloaded/deleted, or if the address doesn't have a valid reference to
794   // a section.
795   return empty_section_wp.owner_before(m_section_wp) ||
796          m_section_wp.owner_before(empty_section_wp);
797 }
798 
799 uint32_t
800 Address::CalculateSymbolContext(SymbolContext *sc,
801                                 SymbolContextItem resolve_scope) const {
802   sc->Clear(false);
803   // Absolute addresses don't have enough information to reconstruct even their
804   // target.
805 
806   SectionSP section_sp(GetSection());
807   if (section_sp) {
808     ModuleSP module_sp(section_sp->GetModule());
809     if (module_sp) {
810       sc->module_sp = module_sp;
811       if (sc->module_sp)
812         return sc->module_sp->ResolveSymbolContextForAddress(
813             *this, resolve_scope, *sc);
814     }
815   }
816   return 0;
817 }
818 
819 ModuleSP Address::CalculateSymbolContextModule() const {
820   SectionSP section_sp(GetSection());
821   if (section_sp)
822     return section_sp->GetModule();
823   return ModuleSP();
824 }
825 
826 CompileUnit *Address::CalculateSymbolContextCompileUnit() const {
827   SectionSP section_sp(GetSection());
828   if (section_sp) {
829     SymbolContext sc;
830     sc.module_sp = section_sp->GetModule();
831     if (sc.module_sp) {
832       sc.module_sp->ResolveSymbolContextForAddress(*this,
833                                                    eSymbolContextCompUnit, sc);
834       return sc.comp_unit;
835     }
836   }
837   return nullptr;
838 }
839 
840 Function *Address::CalculateSymbolContextFunction() const {
841   SectionSP section_sp(GetSection());
842   if (section_sp) {
843     SymbolContext sc;
844     sc.module_sp = section_sp->GetModule();
845     if (sc.module_sp) {
846       sc.module_sp->ResolveSymbolContextForAddress(*this,
847                                                    eSymbolContextFunction, sc);
848       return sc.function;
849     }
850   }
851   return nullptr;
852 }
853 
854 Block *Address::CalculateSymbolContextBlock() const {
855   SectionSP section_sp(GetSection());
856   if (section_sp) {
857     SymbolContext sc;
858     sc.module_sp = section_sp->GetModule();
859     if (sc.module_sp) {
860       sc.module_sp->ResolveSymbolContextForAddress(*this, eSymbolContextBlock,
861                                                    sc);
862       return sc.block;
863     }
864   }
865   return nullptr;
866 }
867 
868 Symbol *Address::CalculateSymbolContextSymbol() const {
869   SectionSP section_sp(GetSection());
870   if (section_sp) {
871     SymbolContext sc;
872     sc.module_sp = section_sp->GetModule();
873     if (sc.module_sp) {
874       sc.module_sp->ResolveSymbolContextForAddress(*this, eSymbolContextSymbol,
875                                                    sc);
876       return sc.symbol;
877     }
878   }
879   return nullptr;
880 }
881 
882 bool Address::CalculateSymbolContextLineEntry(LineEntry &line_entry) const {
883   SectionSP section_sp(GetSection());
884   if (section_sp) {
885     SymbolContext sc;
886     sc.module_sp = section_sp->GetModule();
887     if (sc.module_sp) {
888       sc.module_sp->ResolveSymbolContextForAddress(*this,
889                                                    eSymbolContextLineEntry, sc);
890       if (sc.line_entry.IsValid()) {
891         line_entry = sc.line_entry;
892         return true;
893       }
894     }
895   }
896   line_entry.Clear();
897   return false;
898 }
899 
900 int Address::CompareFileAddress(const Address &a, const Address &b) {
901   addr_t a_file_addr = a.GetFileAddress();
902   addr_t b_file_addr = b.GetFileAddress();
903   if (a_file_addr < b_file_addr)
904     return -1;
905   if (a_file_addr > b_file_addr)
906     return +1;
907   return 0;
908 }
909 
910 int Address::CompareLoadAddress(const Address &a, const Address &b,
911                                 Target *target) {
912   assert(target != nullptr);
913   addr_t a_load_addr = a.GetLoadAddress(target);
914   addr_t b_load_addr = b.GetLoadAddress(target);
915   if (a_load_addr < b_load_addr)
916     return -1;
917   if (a_load_addr > b_load_addr)
918     return +1;
919   return 0;
920 }
921 
922 int Address::CompareModulePointerAndOffset(const Address &a, const Address &b) {
923   ModuleSP a_module_sp(a.GetModule());
924   ModuleSP b_module_sp(b.GetModule());
925   Module *a_module = a_module_sp.get();
926   Module *b_module = b_module_sp.get();
927   if (a_module < b_module)
928     return -1;
929   if (a_module > b_module)
930     return +1;
931   // Modules are the same, just compare the file address since they should be
932   // unique
933   addr_t a_file_addr = a.GetFileAddress();
934   addr_t b_file_addr = b.GetFileAddress();
935   if (a_file_addr < b_file_addr)
936     return -1;
937   if (a_file_addr > b_file_addr)
938     return +1;
939   return 0;
940 }
941 
942 size_t Address::MemorySize() const {
943   // Noting special for the memory size of a single Address object, it is just
944   // the size of itself.
945   return sizeof(Address);
946 }
947 
948 // NOTE: Be careful using this operator. It can correctly compare two
949 // addresses from the same Module correctly. It can't compare two addresses
950 // from different modules in any meaningful way, but it will compare the module
951 // pointers.
952 //
953 // To sum things up:
954 // - works great for addresses within the same module - it works for addresses
955 // across multiple modules, but don't expect the
956 //   address results to make much sense
957 //
958 // This basically lets Address objects be used in ordered collection classes.
959 
960 bool lldb_private::operator<(const Address &lhs, const Address &rhs) {
961   ModuleSP lhs_module_sp(lhs.GetModule());
962   ModuleSP rhs_module_sp(rhs.GetModule());
963   Module *lhs_module = lhs_module_sp.get();
964   Module *rhs_module = rhs_module_sp.get();
965   if (lhs_module == rhs_module) {
966     // Addresses are in the same module, just compare the file addresses
967     return lhs.GetFileAddress() < rhs.GetFileAddress();
968   } else {
969     // The addresses are from different modules, just use the module pointer
970     // value to get consistent ordering
971     return lhs_module < rhs_module;
972   }
973 }
974 
975 bool lldb_private::operator>(const Address &lhs, const Address &rhs) {
976   ModuleSP lhs_module_sp(lhs.GetModule());
977   ModuleSP rhs_module_sp(rhs.GetModule());
978   Module *lhs_module = lhs_module_sp.get();
979   Module *rhs_module = rhs_module_sp.get();
980   if (lhs_module == rhs_module) {
981     // Addresses are in the same module, just compare the file addresses
982     return lhs.GetFileAddress() > rhs.GetFileAddress();
983   } else {
984     // The addresses are from different modules, just use the module pointer
985     // value to get consistent ordering
986     return lhs_module > rhs_module;
987   }
988 }
989 
990 // The operator == checks for exact equality only (same section, same offset)
991 bool lldb_private::operator==(const Address &a, const Address &rhs) {
992   return a.GetOffset() == rhs.GetOffset() && a.GetSection() == rhs.GetSection();
993 }
994 
995 // The operator != checks for exact inequality only (differing section, or
996 // different offset)
997 bool lldb_private::operator!=(const Address &a, const Address &rhs) {
998   return a.GetOffset() != rhs.GetOffset() || a.GetSection() != rhs.GetSection();
999 }
1000 
1001 AddressClass Address::GetAddressClass() const {
1002   ModuleSP module_sp(GetModule());
1003   if (module_sp) {
1004     ObjectFile *obj_file = module_sp->GetObjectFile();
1005     if (obj_file) {
1006       // Give the symbol vendor a chance to add to the unified section list
1007       // and to symtab from symbol file
1008       if (SymbolVendor *vendor = module_sp->GetSymbolVendor())
1009         vendor->GetSymtab();
1010       return obj_file->GetAddressClass(GetFileAddress());
1011     }
1012   }
1013   return AddressClass::eUnknown;
1014 }
1015 
1016 bool Address::SetLoadAddress(lldb::addr_t load_addr, Target *target,
1017                              bool allow_section_end) {
1018   if (target && target->GetSectionLoadList().ResolveLoadAddress(
1019                     load_addr, *this, allow_section_end))
1020     return true;
1021   m_section_wp.reset();
1022   m_offset = load_addr;
1023   return false;
1024 }
1025