Bug Summary

File:src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/lldb/source/Breakpoint/Breakpoint.cpp
Warning:line 196, column 3
Value stored to 'success' is never read

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name Breakpoint.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model static -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/liblldbBreakpoint/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../include -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/obj -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/lldb/include -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/lldb/source -I /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/clang/include -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/liblldbBreakpoint/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -stack-protector 2 -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/liblldbBreakpoint/../../../llvm/lldb/source/Breakpoint/Breakpoint.cpp
1//===-- Breakpoint.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 "llvm/Support/Casting.h"
10
11#include "lldb/Breakpoint/Breakpoint.h"
12#include "lldb/Breakpoint/BreakpointLocation.h"
13#include "lldb/Breakpoint/BreakpointLocationCollection.h"
14#include "lldb/Breakpoint/BreakpointPrecondition.h"
15#include "lldb/Breakpoint/BreakpointResolver.h"
16#include "lldb/Breakpoint/BreakpointResolverFileLine.h"
17#include "lldb/Core/Address.h"
18#include "lldb/Core/Module.h"
19#include "lldb/Core/ModuleList.h"
20#include "lldb/Core/SearchFilter.h"
21#include "lldb/Core/Section.h"
22#include "lldb/Target/SectionLoadList.h"
23#include "lldb/Symbol/CompileUnit.h"
24#include "lldb/Symbol/Function.h"
25#include "lldb/Symbol/Symbol.h"
26#include "lldb/Symbol/SymbolContext.h"
27#include "lldb/Target/Target.h"
28#include "lldb/Target/ThreadSpec.h"
29#include "lldb/Utility/Log.h"
30#include "lldb/Utility/Stream.h"
31#include "lldb/Utility/StreamString.h"
32
33#include <memory>
34
35using namespace lldb;
36using namespace lldb_private;
37using namespace llvm;
38
39ConstString Breakpoint::GetEventIdentifier() {
40 static ConstString g_identifier("event-identifier.breakpoint.changed");
41 return g_identifier;
42}
43
44const char *Breakpoint::g_option_names[static_cast<uint32_t>(
45 Breakpoint::OptionNames::LastOptionName)]{"Names", "Hardware"};
46
47// Breakpoint constructor
48Breakpoint::Breakpoint(Target &target, SearchFilterSP &filter_sp,
49 BreakpointResolverSP &resolver_sp, bool hardware,
50 bool resolve_indirect_symbols)
51 : m_being_created(true), m_hardware(hardware), m_target(target),
52 m_filter_sp(filter_sp), m_resolver_sp(resolver_sp), m_options(true),
53 m_locations(*this), m_resolve_indirect_symbols(resolve_indirect_symbols),
54 m_hit_counter() {
55 m_being_created = false;
56}
57
58Breakpoint::Breakpoint(Target &new_target, const Breakpoint &source_bp)
59 : m_being_created(true), m_hardware(source_bp.m_hardware),
60 m_target(new_target), m_name_list(source_bp.m_name_list),
61 m_options(source_bp.m_options), m_locations(*this),
62 m_resolve_indirect_symbols(source_bp.m_resolve_indirect_symbols),
63 m_hit_counter() {}
64
65// Destructor
66Breakpoint::~Breakpoint() = default;
67
68BreakpointSP Breakpoint::CopyFromBreakpoint(TargetSP new_target,
69 const Breakpoint& bp_to_copy_from) {
70 if (!new_target)
71 return BreakpointSP();
72
73 BreakpointSP bp(new Breakpoint(*new_target, bp_to_copy_from));
74 // Now go through and copy the filter & resolver:
75 bp->m_resolver_sp = bp_to_copy_from.m_resolver_sp->CopyForBreakpoint(bp);
76 bp->m_filter_sp = bp_to_copy_from.m_filter_sp->CreateCopy(new_target);
77 return bp;
78}
79
80// Serialization
81StructuredData::ObjectSP Breakpoint::SerializeToStructuredData() {
82 // Serialize the resolver:
83 StructuredData::DictionarySP breakpoint_dict_sp(
84 new StructuredData::Dictionary());
85 StructuredData::DictionarySP breakpoint_contents_sp(
86 new StructuredData::Dictionary());
87
88 if (!m_name_list.empty()) {
89 StructuredData::ArraySP names_array_sp(new StructuredData::Array());
90 for (auto name : m_name_list) {
91 names_array_sp->AddItem(
92 StructuredData::StringSP(new StructuredData::String(name)));
93 }
94 breakpoint_contents_sp->AddItem(Breakpoint::GetKey(OptionNames::Names),
95 names_array_sp);
96 }
97
98 breakpoint_contents_sp->AddBooleanItem(
99 Breakpoint::GetKey(OptionNames::Hardware), m_hardware);
100
101 StructuredData::ObjectSP resolver_dict_sp(
102 m_resolver_sp->SerializeToStructuredData());
103 if (!resolver_dict_sp)
104 return StructuredData::ObjectSP();
105
106 breakpoint_contents_sp->AddItem(BreakpointResolver::GetSerializationKey(),
107 resolver_dict_sp);
108
109 StructuredData::ObjectSP filter_dict_sp(
110 m_filter_sp->SerializeToStructuredData());
111 if (!filter_dict_sp)
112 return StructuredData::ObjectSP();
113
114 breakpoint_contents_sp->AddItem(SearchFilter::GetSerializationKey(),
115 filter_dict_sp);
116
117 StructuredData::ObjectSP options_dict_sp(
118 m_options.SerializeToStructuredData());
119 if (!options_dict_sp)
120 return StructuredData::ObjectSP();
121
122 breakpoint_contents_sp->AddItem(BreakpointOptions::GetSerializationKey(),
123 options_dict_sp);
124
125 breakpoint_dict_sp->AddItem(GetSerializationKey(), breakpoint_contents_sp);
126 return breakpoint_dict_sp;
127}
128
129lldb::BreakpointSP Breakpoint::CreateFromStructuredData(
130 TargetSP target_sp, StructuredData::ObjectSP &object_data, Status &error) {
131 BreakpointSP result_sp;
132 if (!target_sp)
133 return result_sp;
134
135 StructuredData::Dictionary *breakpoint_dict = object_data->GetAsDictionary();
136
137 if (!breakpoint_dict || !breakpoint_dict->IsValid()) {
138 error.SetErrorString("Can't deserialize from an invalid data object.");
139 return result_sp;
140 }
141
142 StructuredData::Dictionary *resolver_dict;
143 bool success = breakpoint_dict->GetValueForKeyAsDictionary(
144 BreakpointResolver::GetSerializationKey(), resolver_dict);
145 if (!success) {
146 error.SetErrorString("Breakpoint data missing toplevel resolver key");
147 return result_sp;
148 }
149
150 Status create_error;
151 BreakpointResolverSP resolver_sp =
152 BreakpointResolver::CreateFromStructuredData(*resolver_dict,
153 create_error);
154 if (create_error.Fail()) {
155 error.SetErrorStringWithFormat(
156 "Error creating breakpoint resolver from data: %s.",
157 create_error.AsCString());
158 return result_sp;
159 }
160
161 StructuredData::Dictionary *filter_dict;
162 success = breakpoint_dict->GetValueForKeyAsDictionary(
163 SearchFilter::GetSerializationKey(), filter_dict);
164 SearchFilterSP filter_sp;
165 if (!success)
166 filter_sp =
167 std::make_shared<SearchFilterForUnconstrainedSearches>(target_sp);
168 else {
169 filter_sp = SearchFilter::CreateFromStructuredData(target_sp, *filter_dict,
170 create_error);
171 if (create_error.Fail()) {
172 error.SetErrorStringWithFormat(
173 "Error creating breakpoint filter from data: %s.",
174 create_error.AsCString());
175 return result_sp;
176 }
177 }
178
179 std::unique_ptr<BreakpointOptions> options_up;
180 StructuredData::Dictionary *options_dict;
181 Target& target = *target_sp;
182 success = breakpoint_dict->GetValueForKeyAsDictionary(
183 BreakpointOptions::GetSerializationKey(), options_dict);
184 if (success) {
185 options_up = BreakpointOptions::CreateFromStructuredData(
186 target, *options_dict, create_error);
187 if (create_error.Fail()) {
188 error.SetErrorStringWithFormat(
189 "Error creating breakpoint options from data: %s.",
190 create_error.AsCString());
191 return result_sp;
192 }
193 }
194
195 bool hardware = false;
196 success = breakpoint_dict->GetValueForKeyAsBoolean(
Value stored to 'success' is never read
197 Breakpoint::GetKey(OptionNames::Hardware), hardware);
198
199 result_sp = target.CreateBreakpoint(filter_sp, resolver_sp, false,
200 hardware, true);
201
202 if (result_sp && options_up) {
203 result_sp->m_options = *options_up;
204 }
205
206 StructuredData::Array *names_array;
207 success = breakpoint_dict->GetValueForKeyAsArray(
208 Breakpoint::GetKey(OptionNames::Names), names_array);
209 if (success && names_array) {
210 size_t num_names = names_array->GetSize();
211 for (size_t i = 0; i < num_names; i++) {
212 llvm::StringRef name;
213 Status error;
214 success = names_array->GetItemAtIndexAsString(i, name);
215 target.AddNameToBreakpoint(result_sp, name.str().c_str(), error);
216 }
217 }
218
219 return result_sp;
220}
221
222bool Breakpoint::SerializedBreakpointMatchesNames(
223 StructuredData::ObjectSP &bkpt_object_sp, std::vector<std::string> &names) {
224 if (!bkpt_object_sp)
225 return false;
226
227 StructuredData::Dictionary *bkpt_dict = bkpt_object_sp->GetAsDictionary();
228 if (!bkpt_dict)
229 return false;
230
231 if (names.empty())
232 return true;
233
234 StructuredData::Array *names_array;
235
236 bool success =
237 bkpt_dict->GetValueForKeyAsArray(GetKey(OptionNames::Names), names_array);
238 // If there are no names, it can't match these names;
239 if (!success)
240 return false;
241
242 size_t num_names = names_array->GetSize();
243
244 for (size_t i = 0; i < num_names; i++) {
245 llvm::StringRef name;
246 if (names_array->GetItemAtIndexAsString(i, name)) {
247 if (llvm::is_contained(names, name))
248 return true;
249 }
250 }
251 return false;
252}
253
254const lldb::TargetSP Breakpoint::GetTargetSP() {
255 return m_target.shared_from_this();
256}
257
258bool Breakpoint::IsInternal() const { return LLDB_BREAK_ID_IS_INTERNAL(m_bid)((m_bid) < 0); }
259
260BreakpointLocationSP Breakpoint::AddLocation(const Address &addr,
261 bool *new_location) {
262 return m_locations.AddLocation(addr, m_resolve_indirect_symbols,
263 new_location);
264}
265
266BreakpointLocationSP Breakpoint::FindLocationByAddress(const Address &addr) {
267 return m_locations.FindByAddress(addr);
268}
269
270break_id_t Breakpoint::FindLocationIDByAddress(const Address &addr) {
271 return m_locations.FindIDByAddress(addr);
272}
273
274BreakpointLocationSP Breakpoint::FindLocationByID(break_id_t bp_loc_id) {
275 return m_locations.FindByID(bp_loc_id);
276}
277
278BreakpointLocationSP Breakpoint::GetLocationAtIndex(size_t index) {
279 return m_locations.GetByIndex(index);
280}
281
282void Breakpoint::RemoveInvalidLocations(const ArchSpec &arch) {
283 m_locations.RemoveInvalidLocations(arch);
284}
285
286// For each of the overall options we need to decide how they propagate to the
287// location options. This will determine the precedence of options on the
288// breakpoint vs. its locations.
289
290// Disable at the breakpoint level should override the location settings. That
291// way you can conveniently turn off a whole breakpoint without messing up the
292// individual settings.
293
294void Breakpoint::SetEnabled(bool enable) {
295 if (enable == m_options.IsEnabled())
296 return;
297
298 m_options.SetEnabled(enable);
299 if (enable)
300 m_locations.ResolveAllBreakpointSites();
301 else
302 m_locations.ClearAllBreakpointSites();
303
304 SendBreakpointChangedEvent(enable ? eBreakpointEventTypeEnabled
305 : eBreakpointEventTypeDisabled);
306}
307
308bool Breakpoint::IsEnabled() { return m_options.IsEnabled(); }
309
310void Breakpoint::SetIgnoreCount(uint32_t n) {
311 if (m_options.GetIgnoreCount() == n)
312 return;
313
314 m_options.SetIgnoreCount(n);
315 SendBreakpointChangedEvent(eBreakpointEventTypeIgnoreChanged);
316}
317
318void Breakpoint::DecrementIgnoreCount() {
319 uint32_t ignore = m_options.GetIgnoreCount();
320 if (ignore != 0)
321 m_options.SetIgnoreCount(ignore - 1);
322}
323
324uint32_t Breakpoint::GetIgnoreCount() const {
325 return m_options.GetIgnoreCount();
326}
327
328uint32_t Breakpoint::GetHitCount() const { return m_hit_counter.GetValue(); }
329
330bool Breakpoint::IsOneShot() const { return m_options.IsOneShot(); }
331
332void Breakpoint::SetOneShot(bool one_shot) { m_options.SetOneShot(one_shot); }
333
334bool Breakpoint::IsAutoContinue() const { return m_options.IsAutoContinue(); }
335
336void Breakpoint::SetAutoContinue(bool auto_continue) {
337 m_options.SetAutoContinue(auto_continue);
338}
339
340void Breakpoint::SetThreadID(lldb::tid_t thread_id) {
341 if (m_options.GetThreadSpec()->GetTID() == thread_id)
342 return;
343
344 m_options.GetThreadSpec()->SetTID(thread_id);
345 SendBreakpointChangedEvent(eBreakpointEventTypeThreadChanged);
346}
347
348lldb::tid_t Breakpoint::GetThreadID() const {
349 if (m_options.GetThreadSpecNoCreate() == nullptr)
350 return LLDB_INVALID_THREAD_ID0;
351 else
352 return m_options.GetThreadSpecNoCreate()->GetTID();
353}
354
355void Breakpoint::SetThreadIndex(uint32_t index) {
356 if (m_options.GetThreadSpec()->GetIndex() == index)
357 return;
358
359 m_options.GetThreadSpec()->SetIndex(index);
360 SendBreakpointChangedEvent(eBreakpointEventTypeThreadChanged);
361}
362
363uint32_t Breakpoint::GetThreadIndex() const {
364 if (m_options.GetThreadSpecNoCreate() == nullptr)
365 return 0;
366 else
367 return m_options.GetThreadSpecNoCreate()->GetIndex();
368}
369
370void Breakpoint::SetThreadName(const char *thread_name) {
371 if (m_options.GetThreadSpec()->GetName() != nullptr &&
372 ::strcmp(m_options.GetThreadSpec()->GetName(), thread_name) == 0)
373 return;
374
375 m_options.GetThreadSpec()->SetName(thread_name);
376 SendBreakpointChangedEvent(eBreakpointEventTypeThreadChanged);
377}
378
379const char *Breakpoint::GetThreadName() const {
380 if (m_options.GetThreadSpecNoCreate() == nullptr)
381 return nullptr;
382 else
383 return m_options.GetThreadSpecNoCreate()->GetName();
384}
385
386void Breakpoint::SetQueueName(const char *queue_name) {
387 if (m_options.GetThreadSpec()->GetQueueName() != nullptr &&
388 ::strcmp(m_options.GetThreadSpec()->GetQueueName(), queue_name) == 0)
389 return;
390
391 m_options.GetThreadSpec()->SetQueueName(queue_name);
392 SendBreakpointChangedEvent(eBreakpointEventTypeThreadChanged);
393}
394
395const char *Breakpoint::GetQueueName() const {
396 if (m_options.GetThreadSpecNoCreate() == nullptr)
397 return nullptr;
398 else
399 return m_options.GetThreadSpecNoCreate()->GetQueueName();
400}
401
402void Breakpoint::SetCondition(const char *condition) {
403 m_options.SetCondition(condition);
404 SendBreakpointChangedEvent(eBreakpointEventTypeConditionChanged);
405}
406
407const char *Breakpoint::GetConditionText() const {
408 return m_options.GetConditionText();
409}
410
411// This function is used when "baton" doesn't need to be freed
412void Breakpoint::SetCallback(BreakpointHitCallback callback, void *baton,
413 bool is_synchronous) {
414 // The default "Baton" class will keep a copy of "baton" and won't free or
415 // delete it when it goes goes out of scope.
416 m_options.SetCallback(callback, std::make_shared<UntypedBaton>(baton),
417 is_synchronous);
418
419 SendBreakpointChangedEvent(eBreakpointEventTypeCommandChanged);
420}
421
422// This function is used when a baton needs to be freed and therefore is
423// contained in a "Baton" subclass.
424void Breakpoint::SetCallback(BreakpointHitCallback callback,
425 const BatonSP &callback_baton_sp,
426 bool is_synchronous) {
427 m_options.SetCallback(callback, callback_baton_sp, is_synchronous);
428}
429
430void Breakpoint::ClearCallback() { m_options.ClearCallback(); }
431
432bool Breakpoint::InvokeCallback(StoppointCallbackContext *context,
433 break_id_t bp_loc_id) {
434 return m_options.InvokeCallback(context, GetID(), bp_loc_id);
435}
436
437BreakpointOptions &Breakpoint::GetOptions() { return m_options; }
438
439const BreakpointOptions &Breakpoint::GetOptions() const { return m_options; }
440
441void Breakpoint::ResolveBreakpoint() {
442 if (m_resolver_sp)
443 m_resolver_sp->ResolveBreakpoint(*m_filter_sp);
444}
445
446void Breakpoint::ResolveBreakpointInModules(
447 ModuleList &module_list, BreakpointLocationCollection &new_locations) {
448 m_locations.StartRecordingNewLocations(new_locations);
449
450 m_resolver_sp->ResolveBreakpointInModules(*m_filter_sp, module_list);
451
452 m_locations.StopRecordingNewLocations();
453}
454
455void Breakpoint::ResolveBreakpointInModules(ModuleList &module_list,
456 bool send_event) {
457 if (m_resolver_sp) {
458 // If this is not an internal breakpoint, set up to record the new
459 // locations, then dispatch an event with the new locations.
460 if (!IsInternal() && send_event) {
461 BreakpointEventData *new_locations_event = new BreakpointEventData(
462 eBreakpointEventTypeLocationsAdded, shared_from_this());
463
464 ResolveBreakpointInModules(
465 module_list, new_locations_event->GetBreakpointLocationCollection());
466
467 if (new_locations_event->GetBreakpointLocationCollection().GetSize() !=
468 0) {
469 SendBreakpointChangedEvent(new_locations_event);
470 } else
471 delete new_locations_event;
472 } else {
473 m_resolver_sp->ResolveBreakpointInModules(*m_filter_sp, module_list);
474 }
475 }
476}
477
478void Breakpoint::ClearAllBreakpointSites() {
479 m_locations.ClearAllBreakpointSites();
480}
481
482// ModulesChanged: Pass in a list of new modules, and
483
484void Breakpoint::ModulesChanged(ModuleList &module_list, bool load,
485 bool delete_locations) {
486 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS(1u << 5)));
487 LLDB_LOGF(log,do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesChanged: num_modules: %zu load: %i "
"delete_locations: %i\n", module_list.GetSize(), load, delete_locations
); } while (0)
488 "Breakpoint::ModulesChanged: num_modules: %zu load: %i "do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesChanged: num_modules: %zu load: %i "
"delete_locations: %i\n", module_list.GetSize(), load, delete_locations
); } while (0)
489 "delete_locations: %i\n",do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesChanged: num_modules: %zu load: %i "
"delete_locations: %i\n", module_list.GetSize(), load, delete_locations
); } while (0)
490 module_list.GetSize(), load, delete_locations)do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesChanged: num_modules: %zu load: %i "
"delete_locations: %i\n", module_list.GetSize(), load, delete_locations
); } while (0);
491
492 if (load) {
493 // The logic for handling new modules is:
494 // 1) If the filter rejects this module, then skip it. 2) Run through the
495 // current location list and if there are any locations
496 // for that module, we mark the module as "seen" and we don't try to
497 // re-resolve
498 // breakpoint locations for that module.
499 // However, we do add breakpoint sites to these locations if needed.
500 // 3) If we don't see this module in our breakpoint location list, call
501 // ResolveInModules.
502
503 ModuleList new_modules; // We'll stuff the "unseen" modules in this list,
504 // and then resolve
505 // them after the locations pass. Have to do it this way because resolving
506 // breakpoints will add new locations potentially.
507
508 for (ModuleSP module_sp : module_list.Modules()) {
509 bool seen = false;
510 if (!m_filter_sp->ModulePasses(module_sp))
511 continue;
512
513 BreakpointLocationCollection locations_with_no_section;
514 for (BreakpointLocationSP break_loc_sp :
515 m_locations.BreakpointLocations()) {
516
517 // If the section for this location was deleted, that means it's Module
518 // has gone away but somebody forgot to tell us. Let's clean it up
519 // here.
520 Address section_addr(break_loc_sp->GetAddress());
521 if (section_addr.SectionWasDeleted()) {
522 locations_with_no_section.Add(break_loc_sp);
523 continue;
524 }
525
526 if (!break_loc_sp->IsEnabled())
527 continue;
528
529 SectionSP section_sp(section_addr.GetSection());
530
531 // If we don't have a Section, that means this location is a raw
532 // address that we haven't resolved to a section yet. So we'll have to
533 // look in all the new modules to resolve this location. Otherwise, if
534 // it was set in this module, re-resolve it here.
535 if (section_sp && section_sp->GetModule() == module_sp) {
536 if (!seen)
537 seen = true;
538
539 if (!break_loc_sp->ResolveBreakpointSite()) {
540 LLDB_LOGF(log,do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Warning: could not set breakpoint site for "
"breakpoint location %d of breakpoint %d.\n", break_loc_sp->
GetID(), GetID()); } while (0)
541 "Warning: could not set breakpoint site for "do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Warning: could not set breakpoint site for "
"breakpoint location %d of breakpoint %d.\n", break_loc_sp->
GetID(), GetID()); } while (0)
542 "breakpoint location %d of breakpoint %d.\n",do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Warning: could not set breakpoint site for "
"breakpoint location %d of breakpoint %d.\n", break_loc_sp->
GetID(), GetID()); } while (0)
543 break_loc_sp->GetID(), GetID())do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Warning: could not set breakpoint site for "
"breakpoint location %d of breakpoint %d.\n", break_loc_sp->
GetID(), GetID()); } while (0);
544 }
545 }
546 }
547
548 size_t num_to_delete = locations_with_no_section.GetSize();
549
550 for (size_t i = 0; i < num_to_delete; i++)
551 m_locations.RemoveLocation(locations_with_no_section.GetByIndex(i));
552
553 if (!seen)
554 new_modules.AppendIfNeeded(module_sp);
555 }
556
557 if (new_modules.GetSize() > 0) {
558 ResolveBreakpointInModules(new_modules);
559 }
560 } else {
561 // Go through the currently set locations and if any have breakpoints in
562 // the module list, then remove their breakpoint sites, and their locations
563 // if asked to.
564
565 BreakpointEventData *removed_locations_event;
566 if (!IsInternal())
567 removed_locations_event = new BreakpointEventData(
568 eBreakpointEventTypeLocationsRemoved, shared_from_this());
569 else
570 removed_locations_event = nullptr;
571
572 for (ModuleSP module_sp : module_list.Modules()) {
573 if (m_filter_sp->ModulePasses(module_sp)) {
574 size_t loc_idx = 0;
575 size_t num_locations = m_locations.GetSize();
576 BreakpointLocationCollection locations_to_remove;
577 for (loc_idx = 0; loc_idx < num_locations; loc_idx++) {
578 BreakpointLocationSP break_loc_sp(m_locations.GetByIndex(loc_idx));
579 SectionSP section_sp(break_loc_sp->GetAddress().GetSection());
580 if (section_sp && section_sp->GetModule() == module_sp) {
581 // Remove this breakpoint since the shared library is unloaded, but
582 // keep the breakpoint location around so we always get complete
583 // hit count and breakpoint lifetime info
584 break_loc_sp->ClearBreakpointSite();
585 if (removed_locations_event) {
586 removed_locations_event->GetBreakpointLocationCollection().Add(
587 break_loc_sp);
588 }
589 if (delete_locations)
590 locations_to_remove.Add(break_loc_sp);
591 }
592 }
593
594 if (delete_locations) {
595 size_t num_locations_to_remove = locations_to_remove.GetSize();
596 for (loc_idx = 0; loc_idx < num_locations_to_remove; loc_idx++)
597 m_locations.RemoveLocation(locations_to_remove.GetByIndex(loc_idx));
598 }
599 }
600 }
601 SendBreakpointChangedEvent(removed_locations_event);
602 }
603}
604
605namespace {
606static bool SymbolContextsMightBeEquivalent(SymbolContext &old_sc,
607 SymbolContext &new_sc) {
608 bool equivalent_scs = false;
609
610 if (old_sc.module_sp.get() == new_sc.module_sp.get()) {
611 // If these come from the same module, we can directly compare the
612 // pointers:
613 if (old_sc.comp_unit && new_sc.comp_unit &&
614 (old_sc.comp_unit == new_sc.comp_unit)) {
615 if (old_sc.function && new_sc.function &&
616 (old_sc.function == new_sc.function)) {
617 equivalent_scs = true;
618 }
619 } else if (old_sc.symbol && new_sc.symbol &&
620 (old_sc.symbol == new_sc.symbol)) {
621 equivalent_scs = true;
622 }
623 } else {
624 // Otherwise we will compare by name...
625 if (old_sc.comp_unit && new_sc.comp_unit) {
626 if (old_sc.comp_unit->GetPrimaryFile() ==
627 new_sc.comp_unit->GetPrimaryFile()) {
628 // Now check the functions:
629 if (old_sc.function && new_sc.function &&
630 (old_sc.function->GetName() == new_sc.function->GetName())) {
631 equivalent_scs = true;
632 }
633 }
634 } else if (old_sc.symbol && new_sc.symbol) {
635 if (Mangled::Compare(old_sc.symbol->GetMangled(),
636 new_sc.symbol->GetMangled()) == 0) {
637 equivalent_scs = true;
638 }
639 }
640 }
641 return equivalent_scs;
642}
643} // anonymous namespace
644
645void Breakpoint::ModuleReplaced(ModuleSP old_module_sp,
646 ModuleSP new_module_sp) {
647 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS(1u << 5)));
648 LLDB_LOGF(log, "Breakpoint::ModulesReplaced for %s\n",do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesReplaced for %s\n"
, old_module_sp->GetSpecificationDescription().c_str()); }
while (0)
649 old_module_sp->GetSpecificationDescription().c_str())do { ::lldb_private::Log *log_private = (log); if (log_private
) log_private->Printf("Breakpoint::ModulesReplaced for %s\n"
, old_module_sp->GetSpecificationDescription().c_str()); }
while (0);
650 // First find all the locations that are in the old module
651
652 BreakpointLocationCollection old_break_locs;
653 for (BreakpointLocationSP break_loc_sp : m_locations.BreakpointLocations()) {
654 SectionSP section_sp = break_loc_sp->GetAddress().GetSection();
655 if (section_sp && section_sp->GetModule() == old_module_sp) {
656 old_break_locs.Add(break_loc_sp);
657 }
658 }
659
660 size_t num_old_locations = old_break_locs.GetSize();
661
662 if (num_old_locations == 0) {
663 // There were no locations in the old module, so we just need to check if
664 // there were any in the new module.
665 ModuleList temp_list;
666 temp_list.Append(new_module_sp);
667 ResolveBreakpointInModules(temp_list);
668 } else {
669 // First search the new module for locations. Then compare this with the
670 // old list, copy over locations that "look the same" Then delete the old
671 // locations. Finally remember to post the creation event.
672 //
673 // Two locations are the same if they have the same comp unit & function
674 // (by name) and there are the same number of locations in the old function
675 // as in the new one.
676
677 ModuleList temp_list;
678 temp_list.Append(new_module_sp);
679 BreakpointLocationCollection new_break_locs;
680 ResolveBreakpointInModules(temp_list, new_break_locs);
681 BreakpointLocationCollection locations_to_remove;
682 BreakpointLocationCollection locations_to_announce;
683
684 size_t num_new_locations = new_break_locs.GetSize();
685
686 if (num_new_locations > 0) {
687 // Break out the case of one location -> one location since that's the
688 // most common one, and there's no need to build up the structures needed
689 // for the merge in that case.
690 if (num_new_locations == 1 && num_old_locations == 1) {
691 bool equivalent_locations = false;
692 SymbolContext old_sc, new_sc;
693 // The only way the old and new location can be equivalent is if they
694 // have the same amount of information:
695 BreakpointLocationSP old_loc_sp = old_break_locs.GetByIndex(0);
696 BreakpointLocationSP new_loc_sp = new_break_locs.GetByIndex(0);
697
698 if (old_loc_sp->GetAddress().CalculateSymbolContext(&old_sc) ==
699 new_loc_sp->GetAddress().CalculateSymbolContext(&new_sc)) {
700 equivalent_locations =
701 SymbolContextsMightBeEquivalent(old_sc, new_sc);
702 }
703
704 if (equivalent_locations) {
705 m_locations.SwapLocation(old_loc_sp, new_loc_sp);
706 } else {
707 locations_to_remove.Add(old_loc_sp);
708 locations_to_announce.Add(new_loc_sp);
709 }
710 } else {
711 // We don't want to have to keep computing the SymbolContexts for these
712 // addresses over and over, so lets get them up front:
713
714 typedef std::map<lldb::break_id_t, SymbolContext> IDToSCMap;
715 IDToSCMap old_sc_map;
716 for (size_t idx = 0; idx < num_old_locations; idx++) {
717 SymbolContext sc;
718 BreakpointLocationSP bp_loc_sp = old_break_locs.GetByIndex(idx);
719 lldb::break_id_t loc_id = bp_loc_sp->GetID();
720 bp_loc_sp->GetAddress().CalculateSymbolContext(&old_sc_map[loc_id]);
721 }
722
723 std::map<lldb::break_id_t, SymbolContext> new_sc_map;
724 for (size_t idx = 0; idx < num_new_locations; idx++) {
725 SymbolContext sc;
726 BreakpointLocationSP bp_loc_sp = new_break_locs.GetByIndex(idx);
727 lldb::break_id_t loc_id = bp_loc_sp->GetID();
728 bp_loc_sp->GetAddress().CalculateSymbolContext(&new_sc_map[loc_id]);
729 }
730 // Take an element from the old Symbol Contexts
731 while (old_sc_map.size() > 0) {
732 lldb::break_id_t old_id = old_sc_map.begin()->first;
733 SymbolContext &old_sc = old_sc_map.begin()->second;
734
735 // Count the number of entries equivalent to this SC for the old
736 // list:
737 std::vector<lldb::break_id_t> old_id_vec;
738 old_id_vec.push_back(old_id);
739
740 IDToSCMap::iterator tmp_iter;
741 for (tmp_iter = ++old_sc_map.begin(); tmp_iter != old_sc_map.end();
742 tmp_iter++) {
743 if (SymbolContextsMightBeEquivalent(old_sc, tmp_iter->second))
744 old_id_vec.push_back(tmp_iter->first);
745 }
746
747 // Now find all the equivalent locations in the new list.
748 std::vector<lldb::break_id_t> new_id_vec;
749 for (tmp_iter = new_sc_map.begin(); tmp_iter != new_sc_map.end();
750 tmp_iter++) {
751 if (SymbolContextsMightBeEquivalent(old_sc, tmp_iter->second))
752 new_id_vec.push_back(tmp_iter->first);
753 }
754
755 // Alright, if we have the same number of potentially equivalent
756 // locations in the old and new modules, we'll just map them one to
757 // one in ascending ID order (assuming the resolver's order would
758 // match the equivalent ones. Otherwise, we'll dump all the old ones,
759 // and just take the new ones, erasing the elements from both maps as
760 // we go.
761
762 if (old_id_vec.size() == new_id_vec.size()) {
763 llvm::sort(old_id_vec);
764 llvm::sort(new_id_vec);
765 size_t num_elements = old_id_vec.size();
766 for (size_t idx = 0; idx < num_elements; idx++) {
767 BreakpointLocationSP old_loc_sp =
768 old_break_locs.FindByIDPair(GetID(), old_id_vec[idx]);
769 BreakpointLocationSP new_loc_sp =
770 new_break_locs.FindByIDPair(GetID(), new_id_vec[idx]);
771 m_locations.SwapLocation(old_loc_sp, new_loc_sp);
772 old_sc_map.erase(old_id_vec[idx]);
773 new_sc_map.erase(new_id_vec[idx]);
774 }
775 } else {
776 for (lldb::break_id_t old_id : old_id_vec) {
777 locations_to_remove.Add(
778 old_break_locs.FindByIDPair(GetID(), old_id));
779 old_sc_map.erase(old_id);
780 }
781 for (lldb::break_id_t new_id : new_id_vec) {
782 locations_to_announce.Add(
783 new_break_locs.FindByIDPair(GetID(), new_id));
784 new_sc_map.erase(new_id);
785 }
786 }
787 }
788 }
789 }
790
791 // Now remove the remaining old locations, and cons up a removed locations
792 // event. Note, we don't put the new locations that were swapped with an
793 // old location on the locations_to_remove list, so we don't need to worry
794 // about telling the world about removing a location we didn't tell them
795 // about adding.
796
797 BreakpointEventData *locations_event;
798 if (!IsInternal())
799 locations_event = new BreakpointEventData(
800 eBreakpointEventTypeLocationsRemoved, shared_from_this());
801 else
802 locations_event = nullptr;
803
804 for (BreakpointLocationSP loc_sp :
805 locations_to_remove.BreakpointLocations()) {
806 m_locations.RemoveLocation(loc_sp);
807 if (locations_event)
808 locations_event->GetBreakpointLocationCollection().Add(loc_sp);
809 }
810 SendBreakpointChangedEvent(locations_event);
811
812 // And announce the new ones.
813
814 if (!IsInternal()) {
815 locations_event = new BreakpointEventData(
816 eBreakpointEventTypeLocationsAdded, shared_from_this());
817 for (BreakpointLocationSP loc_sp :
818 locations_to_announce.BreakpointLocations())
819 locations_event->GetBreakpointLocationCollection().Add(loc_sp);
820
821 SendBreakpointChangedEvent(locations_event);
822 }
823 m_locations.Compact();
824 }
825}
826
827void Breakpoint::Dump(Stream *) {}
828
829size_t Breakpoint::GetNumResolvedLocations() const {
830 // Return the number of breakpoints that are actually resolved and set down
831 // in the inferior process.
832 return m_locations.GetNumResolvedLocations();
833}
834
835bool Breakpoint::HasResolvedLocations() const {
836 return GetNumResolvedLocations() > 0;
837}
838
839size_t Breakpoint::GetNumLocations() const { return m_locations.GetSize(); }
840
841bool Breakpoint::AddName(llvm::StringRef new_name) {
842 m_name_list.insert(new_name.str().c_str());
843 return true;
844}
845
846void Breakpoint::GetDescription(Stream *s, lldb::DescriptionLevel level,
847 bool show_locations) {
848 assert(s != nullptr)((void)0);
849
850 if (!m_kind_description.empty()) {
851 if (level == eDescriptionLevelBrief) {
852 s->PutCString(GetBreakpointKind());
853 return;
854 } else
855 s->Printf("Kind: %s\n", GetBreakpointKind());
856 }
857
858 const size_t num_locations = GetNumLocations();
859 const size_t num_resolved_locations = GetNumResolvedLocations();
860
861 // They just made the breakpoint, they don't need to be told HOW they made
862 // it... Also, we'll print the breakpoint number differently depending on
863 // whether there is 1 or more locations.
864 if (level != eDescriptionLevelInitial) {
865 s->Printf("%i: ", GetID());
866 GetResolverDescription(s);
867 GetFilterDescription(s);
868 }
869
870 switch (level) {
871 case lldb::eDescriptionLevelBrief:
872 case lldb::eDescriptionLevelFull:
873 if (num_locations > 0) {
874 s->Printf(", locations = %" PRIu64"llu", (uint64_t)num_locations);
875 if (num_resolved_locations > 0)
876 s->Printf(", resolved = %" PRIu64"llu" ", hit count = %d",
877 (uint64_t)num_resolved_locations, GetHitCount());
878 } else {
879 // Don't print the pending notification for exception resolvers since we
880 // don't generally know how to set them until the target is run.
881 if (m_resolver_sp->getResolverID() !=
882 BreakpointResolver::ExceptionResolver)
883 s->Printf(", locations = 0 (pending)");
884 }
885
886 m_options.GetDescription(s, level);
887
888 if (m_precondition_sp)
889 m_precondition_sp->GetDescription(*s, level);
890
891 if (level == lldb::eDescriptionLevelFull) {
892 if (!m_name_list.empty()) {
893 s->EOL();
894 s->Indent();
895 s->Printf("Names:");
896 s->EOL();
897 s->IndentMore();
898 for (std::string name : m_name_list) {
899 s->Indent();
900 s->Printf("%s\n", name.c_str());
901 }
902 s->IndentLess();
903 }
904 s->IndentLess();
905 s->EOL();
906 }
907 break;
908
909 case lldb::eDescriptionLevelInitial:
910 s->Printf("Breakpoint %i: ", GetID());
911 if (num_locations == 0) {
912 s->Printf("no locations (pending).");
913 } else if (num_locations == 1 && !show_locations) {
914 // There is only one location, so we'll just print that location
915 // information.
916 GetLocationAtIndex(0)->GetDescription(s, level);
917 } else {
918 s->Printf("%" PRIu64"llu" " locations.", static_cast<uint64_t>(num_locations));
919 }
920 s->EOL();
921 break;
922
923 case lldb::eDescriptionLevelVerbose:
924 // Verbose mode does a debug dump of the breakpoint
925 Dump(s);
926 s->EOL();
927 // s->Indent();
928 m_options.GetDescription(s, level);
929 break;
930
931 default:
932 break;
933 }
934
935 // The brief description is just the location name (1.2 or whatever). That's
936 // pointless to show in the breakpoint's description, so suppress it.
937 if (show_locations && level != lldb::eDescriptionLevelBrief) {
938 s->IndentMore();
939 for (size_t i = 0; i < num_locations; ++i) {
940 BreakpointLocation *loc = GetLocationAtIndex(i).get();
941 loc->GetDescription(s, level);
942 s->EOL();
943 }
944 s->IndentLess();
945 }
946}
947
948void Breakpoint::GetResolverDescription(Stream *s) {
949 if (m_resolver_sp)
950 m_resolver_sp->GetDescription(s);
951}
952
953bool Breakpoint::GetMatchingFileLine(ConstString filename,
954 uint32_t line_number,
955 BreakpointLocationCollection &loc_coll) {
956 // TODO: To be correct, this method needs to fill the breakpoint location
957 // collection
958 // with the location IDs which match the filename and line_number.
959 //
960
961 if (m_resolver_sp) {
962 BreakpointResolverFileLine *resolverFileLine =
963 dyn_cast<BreakpointResolverFileLine>(m_resolver_sp.get());
964
965 // TODO: Handle SourceLocationSpec column information
966 if (resolverFileLine &&
967 resolverFileLine->m_location_spec.GetFileSpec().GetFilename() ==
968 filename &&
969 resolverFileLine->m_location_spec.GetLine() == line_number) {
970 return true;
971 }
972 }
973 return false;
974}
975
976void Breakpoint::GetFilterDescription(Stream *s) {
977 m_filter_sp->GetDescription(s);
978}
979
980bool Breakpoint::EvaluatePrecondition(StoppointCallbackContext &context) {
981 if (!m_precondition_sp)
982 return true;
983
984 return m_precondition_sp->EvaluatePrecondition(context);
985}
986
987void Breakpoint::SendBreakpointChangedEvent(
988 lldb::BreakpointEventType eventKind) {
989 if (!m_being_created && !IsInternal() &&
990 GetTarget().EventTypeHasListeners(
991 Target::eBroadcastBitBreakpointChanged)) {
992 BreakpointEventData *data =
993 new Breakpoint::BreakpointEventData(eventKind, shared_from_this());
994
995 GetTarget().BroadcastEvent(Target::eBroadcastBitBreakpointChanged, data);
996 }
997}
998
999void Breakpoint::SendBreakpointChangedEvent(BreakpointEventData *data) {
1000 if (data == nullptr)
1001 return;
1002
1003 if (!m_being_created && !IsInternal() &&
1004 GetTarget().EventTypeHasListeners(Target::eBroadcastBitBreakpointChanged))
1005 GetTarget().BroadcastEvent(Target::eBroadcastBitBreakpointChanged, data);
1006 else
1007 delete data;
1008}
1009
1010Breakpoint::BreakpointEventData::BreakpointEventData(
1011 BreakpointEventType sub_type, const BreakpointSP &new_breakpoint_sp)
1012 : EventData(), m_breakpoint_event(sub_type),
1013 m_new_breakpoint_sp(new_breakpoint_sp) {}
1014
1015Breakpoint::BreakpointEventData::~BreakpointEventData() = default;
1016
1017ConstString Breakpoint::BreakpointEventData::GetFlavorString() {
1018 static ConstString g_flavor("Breakpoint::BreakpointEventData");
1019 return g_flavor;
1020}
1021
1022ConstString Breakpoint::BreakpointEventData::GetFlavor() const {
1023 return BreakpointEventData::GetFlavorString();
1024}
1025
1026BreakpointSP &Breakpoint::BreakpointEventData::GetBreakpoint() {
1027 return m_new_breakpoint_sp;
1028}
1029
1030BreakpointEventType
1031Breakpoint::BreakpointEventData::GetBreakpointEventType() const {
1032 return m_breakpoint_event;
1033}
1034
1035void Breakpoint::BreakpointEventData::Dump(Stream *s) const {}
1036
1037const Breakpoint::BreakpointEventData *
1038Breakpoint::BreakpointEventData::GetEventDataFromEvent(const Event *event) {
1039 if (event) {
1040 const EventData *event_data = event->GetData();
1041 if (event_data &&
1042 event_data->GetFlavor() == BreakpointEventData::GetFlavorString())
1043 return static_cast<const BreakpointEventData *>(event->GetData());
1044 }
1045 return nullptr;
1046}
1047
1048BreakpointEventType
1049Breakpoint::BreakpointEventData::GetBreakpointEventTypeFromEvent(
1050 const EventSP &event_sp) {
1051 const BreakpointEventData *data = GetEventDataFromEvent(event_sp.get());
1052
1053 if (data == nullptr)
1054 return eBreakpointEventTypeInvalidType;
1055 else
1056 return data->GetBreakpointEventType();
1057}
1058
1059BreakpointSP Breakpoint::BreakpointEventData::GetBreakpointFromEvent(
1060 const EventSP &event_sp) {
1061 BreakpointSP bp_sp;
1062
1063 const BreakpointEventData *data = GetEventDataFromEvent(event_sp.get());
1064 if (data)
1065 bp_sp = data->m_new_breakpoint_sp;
1066
1067 return bp_sp;
1068}
1069
1070size_t Breakpoint::BreakpointEventData::GetNumBreakpointLocationsFromEvent(
1071 const EventSP &event_sp) {
1072 const BreakpointEventData *data = GetEventDataFromEvent(event_sp.get());
1073 if (data)
1074 return data->m_locations.GetSize();
1075
1076 return 0;
1077}
1078
1079lldb::BreakpointLocationSP
1080Breakpoint::BreakpointEventData::GetBreakpointLocationAtIndexFromEvent(
1081 const lldb::EventSP &event_sp, uint32_t bp_loc_idx) {
1082 lldb::BreakpointLocationSP bp_loc_sp;
1083
1084 const BreakpointEventData *data = GetEventDataFromEvent(event_sp.get());
1085 if (data) {
1086 bp_loc_sp = data->m_locations.GetByIndex(bp_loc_idx);
1087 }
1088
1089 return bp_loc_sp;
1090}