contrib/llvm/tools/lldb/source/Breakpoint/Breakpoint.cpp

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