1 //===-- BreakpointResolverAddress.cpp -------------------------------------===//
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/Breakpoint/BreakpointResolverAddress.h"
10 #include "lldb/Breakpoint/BreakpointLocation.h"
11 #include "lldb/Core/Module.h"
12 #include "lldb/Core/Section.h"
13 #include "lldb/Target/Process.h"
14 #include "lldb/Target/Target.h"
15 #include "lldb/Utility/LLDBLog.h"
16 #include "lldb/Utility/StreamString.h"
17
18 using namespace lldb;
19 using namespace lldb_private;
20
21 // BreakpointResolverAddress:
BreakpointResolverAddress(const BreakpointSP & bkpt,const Address & addr,const FileSpec & module_spec)22 BreakpointResolverAddress::BreakpointResolverAddress(
23 const BreakpointSP &bkpt, const Address &addr, const FileSpec &module_spec)
24 : BreakpointResolver(bkpt, BreakpointResolver::AddressResolver),
25 m_addr(addr), m_resolved_addr(LLDB_INVALID_ADDRESS),
26 m_module_filespec(module_spec) {}
27
BreakpointResolverAddress(const BreakpointSP & bkpt,const Address & addr)28 BreakpointResolverAddress::BreakpointResolverAddress(const BreakpointSP &bkpt,
29 const Address &addr)
30 : BreakpointResolver(bkpt, BreakpointResolver::AddressResolver),
31 m_addr(addr), m_resolved_addr(LLDB_INVALID_ADDRESS) {}
32
CreateFromStructuredData(const StructuredData::Dictionary & options_dict,Status & error)33 BreakpointResolverSP BreakpointResolverAddress::CreateFromStructuredData(
34 const StructuredData::Dictionary &options_dict, Status &error) {
35 llvm::StringRef module_name;
36 lldb::offset_t addr_offset;
37 FileSpec module_filespec;
38 bool success;
39
40 success = options_dict.GetValueForKeyAsInteger(
41 GetKey(OptionNames::AddressOffset), addr_offset);
42 if (!success) {
43 error = Status::FromErrorString(
44 "BRFL::CFSD: Couldn't find address offset entry.");
45 return nullptr;
46 }
47 Address address(addr_offset);
48
49 success = options_dict.HasKey(GetKey(OptionNames::ModuleName));
50 if (success) {
51 success = options_dict.GetValueForKeyAsString(
52 GetKey(OptionNames::ModuleName), module_name);
53 if (!success) {
54 error = Status::FromErrorString(
55 "BRA::CFSD: Couldn't read module name entry.");
56 return nullptr;
57 }
58 module_filespec.SetFile(module_name, FileSpec::Style::native);
59 }
60 return std::make_shared<BreakpointResolverAddress>(nullptr, address,
61 module_filespec);
62 }
63
64 StructuredData::ObjectSP
SerializeToStructuredData()65 BreakpointResolverAddress::SerializeToStructuredData() {
66 StructuredData::DictionarySP options_dict_sp(
67 new StructuredData::Dictionary());
68 SectionSP section_sp = m_addr.GetSection();
69 if (section_sp) {
70 if (ModuleSP module_sp = section_sp->GetModule()) {
71 const FileSpec &module_fspec = module_sp->GetFileSpec();
72 options_dict_sp->AddStringItem(GetKey(OptionNames::ModuleName),
73 module_fspec.GetPath().c_str());
74 }
75 options_dict_sp->AddIntegerItem(GetKey(OptionNames::AddressOffset),
76 m_addr.GetOffset());
77 } else {
78 options_dict_sp->AddIntegerItem(GetKey(OptionNames::AddressOffset),
79 m_addr.GetOffset());
80 if (m_module_filespec) {
81 options_dict_sp->AddStringItem(GetKey(OptionNames::ModuleName),
82 m_module_filespec.GetPath());
83 }
84 }
85
86 return WrapOptionsDict(options_dict_sp);
87 }
88
ResolveBreakpoint(SearchFilter & filter)89 void BreakpointResolverAddress::ResolveBreakpoint(SearchFilter &filter) {
90 // If the address is not section relative, then we should not try to re-
91 // resolve it, it is just some random address and we wouldn't know what to do
92 // on reload. But if it is section relative, we need to re-resolve it since
93 // the section it's in may have shifted on re-run.
94 bool re_resolve = false;
95 if (m_addr.GetSection() || m_module_filespec)
96 re_resolve = true;
97 else if (GetBreakpoint()->GetNumLocations() == 0)
98 re_resolve = true;
99
100 if (re_resolve)
101 BreakpointResolver::ResolveBreakpoint(filter);
102 }
103
ResolveBreakpointInModules(SearchFilter & filter,ModuleList & modules)104 void BreakpointResolverAddress::ResolveBreakpointInModules(
105 SearchFilter &filter, ModuleList &modules) {
106 // See comment in ResolveBreakpoint.
107 bool re_resolve = false;
108 if (m_addr.GetSection())
109 re_resolve = true;
110 else if (GetBreakpoint()->GetNumLocations() == 0)
111 re_resolve = true;
112
113 if (re_resolve)
114 BreakpointResolver::ResolveBreakpointInModules(filter, modules);
115 }
116
SearchCallback(SearchFilter & filter,SymbolContext & context,Address * addr)117 Searcher::CallbackReturn BreakpointResolverAddress::SearchCallback(
118 SearchFilter &filter, SymbolContext &context, Address *addr) {
119 Log *log = GetLog(LLDBLog::Breakpoints);
120 BreakpointSP breakpoint_sp = GetBreakpoint();
121 Breakpoint &breakpoint = *breakpoint_sp;
122
123 if (filter.AddressPasses(m_addr)) {
124 if (breakpoint.GetNumLocations() == 0) {
125 // If the address is just an offset, and we're given a module, see if we
126 // can find the appropriate module loaded in the binary, and fix up
127 // m_addr to use that.
128 if (!m_addr.IsSectionOffset() && m_module_filespec) {
129 Target &target = breakpoint.GetTarget();
130 ModuleSpec module_spec(m_module_filespec);
131 ModuleSP module_sp = target.GetImages().FindFirstModule(module_spec);
132 if (module_sp) {
133 Address tmp_address;
134 if (module_sp->ResolveFileAddress(m_addr.GetOffset(), tmp_address))
135 m_addr = tmp_address;
136 }
137 }
138
139 m_resolved_addr = m_addr.GetLoadAddress(&breakpoint.GetTarget());
140 BreakpointLocationSP bp_loc_sp(AddLocation(m_addr));
141 if (bp_loc_sp && !breakpoint.IsInternal()) {
142 StreamString s;
143 bp_loc_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
144 LLDB_LOGF(log, "Added location: %s\n", s.GetData());
145 }
146 } else {
147 BreakpointLocationSP loc_sp = breakpoint.GetLocationAtIndex(0);
148 lldb::addr_t cur_load_location =
149 m_addr.GetLoadAddress(&breakpoint.GetTarget());
150 if (cur_load_location != m_resolved_addr) {
151 m_resolved_addr = cur_load_location;
152 if (llvm::Error error = loc_sp->ClearBreakpointSite())
153 LLDB_LOG_ERROR(log, std::move(error), "{0}");
154 if (llvm::Error error = loc_sp->ResolveBreakpointSite())
155 LLDB_LOG_ERROR(log, std::move(error), "{0}");
156 }
157 }
158 }
159 return Searcher::eCallbackReturnStop;
160 }
161
GetDepth()162 lldb::SearchDepth BreakpointResolverAddress::GetDepth() {
163 return lldb::eSearchDepthTarget;
164 }
165
GetDescription(Stream * s)166 void BreakpointResolverAddress::GetDescription(Stream *s) {
167 s->PutCString("address = ");
168 m_addr.Dump(s, GetBreakpoint()->GetTarget().GetProcessSP().get(),
169 Address::DumpStyleModuleWithFileAddress,
170 Address::DumpStyleLoadAddress);
171 }
172
Dump(Stream * s) const173 void BreakpointResolverAddress::Dump(Stream *s) const {}
174
175 lldb::BreakpointResolverSP
CopyForBreakpoint(BreakpointSP & breakpoint)176 BreakpointResolverAddress::CopyForBreakpoint(BreakpointSP &breakpoint) {
177 lldb::BreakpointResolverSP ret_sp(
178 new BreakpointResolverAddress(breakpoint, m_addr));
179 return ret_sp;
180 }
181