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
18using namespace lldb;
19using namespace lldb_private;
20
21// BreakpointResolverAddress:
22BreakpointResolverAddress::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
28BreakpointResolverAddress::BreakpointResolverAddress(const BreakpointSP &bkpt,
29 const Address &addr)
30 : BreakpointResolver(bkpt, BreakpointResolver::AddressResolver),
31 m_addr(addr), m_resolved_addr(LLDB_INVALID_ADDRESS) {}
32
33BreakpointResolverSP 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 key: GetKey(enum_value: OptionNames::AddressOffset), result&: addr_offset);
42 if (!success) {
43 error = Status::FromErrorString(
44 str: "BRFL::CFSD: Couldn't find address offset entry.");
45 return nullptr;
46 }
47 Address address(addr_offset);
48
49 success = options_dict.HasKey(key: GetKey(enum_value: OptionNames::ModuleName));
50 if (success) {
51 success = options_dict.GetValueForKeyAsString(
52 key: GetKey(enum_value: OptionNames::ModuleName), result&: module_name);
53 if (!success) {
54 error = Status::FromErrorString(
55 str: "BRA::CFSD: Couldn't read module name entry.");
56 return nullptr;
57 }
58 module_filespec.SetFile(path: module_name, style: FileSpec::Style::native);
59 }
60 return std::make_shared<BreakpointResolverAddress>(args: nullptr, args&: address,
61 args&: module_filespec);
62}
63
64StructuredData::ObjectSP
65BreakpointResolverAddress::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(key: GetKey(enum_value: OptionNames::ModuleName),
73 value: module_fspec.GetPath().c_str());
74 }
75 options_dict_sp->AddIntegerItem(key: GetKey(enum_value: OptionNames::AddressOffset),
76 value: m_addr.GetOffset());
77 } else {
78 options_dict_sp->AddIntegerItem(key: GetKey(enum_value: OptionNames::AddressOffset),
79 value: m_addr.GetOffset());
80 if (m_module_filespec) {
81 options_dict_sp->AddStringItem(key: GetKey(enum_value: OptionNames::ModuleName),
82 value: m_module_filespec.GetPath());
83 }
84 }
85
86 return WrapOptionsDict(options_dict_sp);
87}
88
89void 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
104void 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
117Searcher::CallbackReturn BreakpointResolverAddress::SearchCallback(
118 SearchFilter &filter, SymbolContext &context, Address *addr) {
119 BreakpointSP breakpoint_sp = GetBreakpoint();
120 Breakpoint &breakpoint = *breakpoint_sp;
121
122 if (filter.AddressPasses(addr&: m_addr)) {
123 if (breakpoint.GetNumLocations() == 0) {
124 // If the address is just an offset, and we're given a module, see if we
125 // can find the appropriate module loaded in the binary, and fix up
126 // m_addr to use that.
127 if (!m_addr.IsSectionOffset() && m_module_filespec) {
128 Target &target = breakpoint.GetTarget();
129 ModuleSpec module_spec(m_module_filespec);
130 ModuleSP module_sp = target.GetImages().FindFirstModule(module_spec);
131 if (module_sp) {
132 Address tmp_address;
133 if (module_sp->ResolveFileAddress(vm_addr: m_addr.GetOffset(), so_addr&: tmp_address))
134 m_addr = tmp_address;
135 }
136 }
137
138 m_resolved_addr = m_addr.GetLoadAddress(target: &breakpoint.GetTarget());
139 BreakpointLocationSP bp_loc_sp(AddLocation(loc_addr: m_addr));
140 if (bp_loc_sp && !breakpoint.IsInternal()) {
141 StreamString s;
142 bp_loc_sp->GetDescription(s: &s, level: lldb::eDescriptionLevelVerbose);
143 Log *log = GetLog(mask: LLDBLog::Breakpoints);
144 LLDB_LOGF(log, "Added location: %s\n", s.GetData());
145 }
146 } else {
147 BreakpointLocationSP loc_sp = breakpoint.GetLocationAtIndex(index: 0);
148 lldb::addr_t cur_load_location =
149 m_addr.GetLoadAddress(target: &breakpoint.GetTarget());
150 if (cur_load_location != m_resolved_addr) {
151 m_resolved_addr = cur_load_location;
152 loc_sp->ClearBreakpointSite();
153 loc_sp->ResolveBreakpointSite();
154 }
155 }
156 }
157 return Searcher::eCallbackReturnStop;
158}
159
160lldb::SearchDepth BreakpointResolverAddress::GetDepth() {
161 return lldb::eSearchDepthTarget;
162}
163
164void BreakpointResolverAddress::GetDescription(Stream *s) {
165 s->PutCString(cstr: "address = ");
166 m_addr.Dump(s, exe_scope: GetBreakpoint()->GetTarget().GetProcessSP().get(),
167 style: Address::DumpStyleModuleWithFileAddress,
168 fallback_style: Address::DumpStyleLoadAddress);
169}
170
171void BreakpointResolverAddress::Dump(Stream *s) const {}
172
173lldb::BreakpointResolverSP
174BreakpointResolverAddress::CopyForBreakpoint(BreakpointSP &breakpoint) {
175 lldb::BreakpointResolverSP ret_sp(
176 new BreakpointResolverAddress(breakpoint, m_addr));
177 return ret_sp;
178}
179

source code of lldb/source/Breakpoint/BreakpointResolverAddress.cpp