1 //===-- BreakpointResolverName.cpp ------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "lldb/Breakpoint/BreakpointResolverName.h" 10 11 #include "lldb/Breakpoint/BreakpointLocation.h" 12 #include "lldb/Core/Architecture.h" 13 #include "lldb/Core/Module.h" 14 #include "lldb/Symbol/Block.h" 15 #include "lldb/Symbol/Function.h" 16 #include "lldb/Symbol/Symbol.h" 17 #include "lldb/Symbol/SymbolContext.h" 18 #include "lldb/Target/Target.h" 19 #include "lldb/Target/Language.h" 20 #include "lldb/Utility/Log.h" 21 #include "lldb/Utility/StreamString.h" 22 23 using namespace lldb; 24 using namespace lldb_private; 25 26 BreakpointResolverName::BreakpointResolverName( 27 Breakpoint *bkpt, const char *name_cstr, FunctionNameType name_type_mask, 28 LanguageType language, Breakpoint::MatchType type, lldb::addr_t offset, 29 bool skip_prologue) 30 : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset), 31 m_class_name(), m_regex(), m_match_type(type), m_language(language), 32 m_skip_prologue(skip_prologue) { 33 if (m_match_type == Breakpoint::Regexp) { 34 m_regex = RegularExpression(llvm::StringRef::withNullAsEmpty(name_cstr)); 35 if (!m_regex.IsValid()) { 36 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS)); 37 38 if (log) 39 log->Warning("function name regexp: \"%s\" did not compile.", 40 name_cstr); 41 } 42 } else { 43 AddNameLookup(ConstString(name_cstr), name_type_mask); 44 } 45 } 46 47 BreakpointResolverName::BreakpointResolverName( 48 Breakpoint *bkpt, const char *names[], size_t num_names, 49 FunctionNameType name_type_mask, LanguageType language, lldb::addr_t offset, 50 bool skip_prologue) 51 : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset), 52 m_match_type(Breakpoint::Exact), m_language(language), 53 m_skip_prologue(skip_prologue) { 54 for (size_t i = 0; i < num_names; i++) { 55 AddNameLookup(ConstString(names[i]), name_type_mask); 56 } 57 } 58 59 BreakpointResolverName::BreakpointResolverName(Breakpoint *bkpt, 60 std::vector<std::string> names, 61 FunctionNameType name_type_mask, 62 LanguageType language, 63 lldb::addr_t offset, 64 bool skip_prologue) 65 : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset), 66 m_match_type(Breakpoint::Exact), m_language(language), 67 m_skip_prologue(skip_prologue) { 68 for (const std::string &name : names) { 69 AddNameLookup(ConstString(name.c_str(), name.size()), name_type_mask); 70 } 71 } 72 73 BreakpointResolverName::BreakpointResolverName(Breakpoint *bkpt, 74 RegularExpression func_regex, 75 lldb::LanguageType language, 76 lldb::addr_t offset, 77 bool skip_prologue) 78 : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset), 79 m_class_name(nullptr), m_regex(std::move(func_regex)), 80 m_match_type(Breakpoint::Regexp), m_language(language), 81 m_skip_prologue(skip_prologue) {} 82 83 BreakpointResolverName::~BreakpointResolverName() = default; 84 85 BreakpointResolverName::BreakpointResolverName( 86 const BreakpointResolverName &rhs) 87 : BreakpointResolver(rhs.m_breakpoint, BreakpointResolver::NameResolver, 88 rhs.m_offset), 89 m_lookups(rhs.m_lookups), m_class_name(rhs.m_class_name), 90 m_regex(rhs.m_regex), m_match_type(rhs.m_match_type), 91 m_language(rhs.m_language), m_skip_prologue(rhs.m_skip_prologue) {} 92 93 BreakpointResolver *BreakpointResolverName::CreateFromStructuredData( 94 Breakpoint *bkpt, const StructuredData::Dictionary &options_dict, 95 Status &error) { 96 LanguageType language = eLanguageTypeUnknown; 97 llvm::StringRef language_name; 98 bool success = options_dict.GetValueForKeyAsString( 99 GetKey(OptionNames::LanguageName), language_name); 100 if (success) { 101 language = Language::GetLanguageTypeFromString(language_name); 102 if (language == eLanguageTypeUnknown) { 103 error.SetErrorStringWithFormatv("BRN::CFSD: Unknown language: {0}.", 104 language_name); 105 return nullptr; 106 } 107 } 108 109 lldb::addr_t offset = 0; 110 success = 111 options_dict.GetValueForKeyAsInteger(GetKey(OptionNames::Offset), offset); 112 if (!success) { 113 error.SetErrorStringWithFormat("BRN::CFSD: Missing offset entry."); 114 return nullptr; 115 } 116 117 bool skip_prologue; 118 success = options_dict.GetValueForKeyAsBoolean( 119 GetKey(OptionNames::SkipPrologue), skip_prologue); 120 if (!success) { 121 error.SetErrorStringWithFormat("BRN::CFSD: Missing Skip prologue entry."); 122 return nullptr; 123 } 124 125 llvm::StringRef regex_text; 126 success = options_dict.GetValueForKeyAsString( 127 GetKey(OptionNames::RegexString), regex_text); 128 if (success) { 129 return new BreakpointResolverName(bkpt, RegularExpression(regex_text), 130 language, offset, skip_prologue); 131 } else { 132 StructuredData::Array *names_array; 133 success = options_dict.GetValueForKeyAsArray( 134 GetKey(OptionNames::SymbolNameArray), names_array); 135 if (!success) { 136 error.SetErrorStringWithFormat("BRN::CFSD: Missing symbol names entry."); 137 return nullptr; 138 } 139 StructuredData::Array *names_mask_array; 140 success = options_dict.GetValueForKeyAsArray( 141 GetKey(OptionNames::NameMaskArray), names_mask_array); 142 if (!success) { 143 error.SetErrorStringWithFormat( 144 "BRN::CFSD: Missing symbol names mask entry."); 145 return nullptr; 146 } 147 148 size_t num_elem = names_array->GetSize(); 149 if (num_elem != names_mask_array->GetSize()) { 150 error.SetErrorString( 151 "BRN::CFSD: names and names mask arrays have different sizes."); 152 return nullptr; 153 } 154 155 if (num_elem == 0) { 156 error.SetErrorString( 157 "BRN::CFSD: no name entry in a breakpoint by name breakpoint."); 158 return nullptr; 159 } 160 std::vector<std::string> names; 161 std::vector<FunctionNameType> name_masks; 162 for (size_t i = 0; i < num_elem; i++) { 163 llvm::StringRef name; 164 165 success = names_array->GetItemAtIndexAsString(i, name); 166 if (!success) { 167 error.SetErrorString("BRN::CFSD: name entry is not a string."); 168 return nullptr; 169 } 170 std::underlying_type<FunctionNameType>::type fnt; 171 success = names_mask_array->GetItemAtIndexAsInteger(i, fnt); 172 if (!success) { 173 error.SetErrorString("BRN::CFSD: name mask entry is not an integer."); 174 return nullptr; 175 } 176 names.push_back(name); 177 name_masks.push_back(static_cast<FunctionNameType>(fnt)); 178 } 179 180 BreakpointResolverName *resolver = new BreakpointResolverName( 181 bkpt, names[0].c_str(), name_masks[0], language, 182 Breakpoint::MatchType::Exact, offset, skip_prologue); 183 for (size_t i = 1; i < num_elem; i++) { 184 resolver->AddNameLookup(ConstString(names[i]), name_masks[i]); 185 } 186 return resolver; 187 } 188 } 189 190 StructuredData::ObjectSP BreakpointResolverName::SerializeToStructuredData() { 191 StructuredData::DictionarySP options_dict_sp( 192 new StructuredData::Dictionary()); 193 194 if (m_regex.IsValid()) { 195 options_dict_sp->AddStringItem(GetKey(OptionNames::RegexString), 196 m_regex.GetText()); 197 } else { 198 StructuredData::ArraySP names_sp(new StructuredData::Array()); 199 StructuredData::ArraySP name_masks_sp(new StructuredData::Array()); 200 for (auto lookup : m_lookups) { 201 names_sp->AddItem(StructuredData::StringSP( 202 new StructuredData::String(lookup.GetName().AsCString()))); 203 name_masks_sp->AddItem(StructuredData::IntegerSP( 204 new StructuredData::Integer(lookup.GetNameTypeMask()))); 205 } 206 options_dict_sp->AddItem(GetKey(OptionNames::SymbolNameArray), names_sp); 207 options_dict_sp->AddItem(GetKey(OptionNames::NameMaskArray), name_masks_sp); 208 } 209 if (m_language != eLanguageTypeUnknown) 210 options_dict_sp->AddStringItem( 211 GetKey(OptionNames::LanguageName), 212 Language::GetNameForLanguageType(m_language)); 213 options_dict_sp->AddBooleanItem(GetKey(OptionNames::SkipPrologue), 214 m_skip_prologue); 215 216 return WrapOptionsDict(options_dict_sp); 217 } 218 219 void BreakpointResolverName::AddNameLookup(ConstString name, 220 FunctionNameType name_type_mask) { 221 222 Module::LookupInfo lookup(name, name_type_mask, m_language); 223 m_lookups.emplace_back(lookup); 224 225 auto add_variant_funcs = [&](Language *lang) { 226 for (ConstString variant_name : lang->GetMethodNameVariants(name)) { 227 Module::LookupInfo variant_lookup(name, name_type_mask, 228 lang->GetLanguageType()); 229 variant_lookup.SetLookupName(variant_name); 230 m_lookups.emplace_back(variant_lookup); 231 } 232 return true; 233 }; 234 235 if (Language *lang = Language::FindPlugin(m_language)) { 236 add_variant_funcs(lang); 237 } else { 238 // Most likely m_language is eLanguageTypeUnknown. We check each language for 239 // possible variants or more qualified names and create lookups for those as 240 // well. 241 Language::ForEach(add_variant_funcs); 242 } 243 } 244 245 // FIXME: Right now we look at the module level, and call the module's 246 // "FindFunctions". 247 // Greg says he will add function tables, maybe at the CompileUnit level to 248 // accelerate function lookup. At that point, we should switch the depth to 249 // CompileUnit, and look in these tables. 250 251 Searcher::CallbackReturn 252 BreakpointResolverName::SearchCallback(SearchFilter &filter, 253 SymbolContext &context, Address *addr) { 254 SymbolContextList func_list; 255 // SymbolContextList sym_list; 256 257 uint32_t i; 258 bool new_location; 259 Address break_addr; 260 assert(m_breakpoint != nullptr); 261 262 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS)); 263 264 if (m_class_name) { 265 if (log) 266 log->Warning("Class/method function specification not supported yet.\n"); 267 return Searcher::eCallbackReturnStop; 268 } 269 bool filter_by_cu = 270 (filter.GetFilterRequiredItems() & eSymbolContextCompUnit) != 0; 271 bool filter_by_language = (m_language != eLanguageTypeUnknown); 272 const bool include_symbols = !filter_by_cu; 273 const bool include_inlines = true; 274 275 switch (m_match_type) { 276 case Breakpoint::Exact: 277 if (context.module_sp) { 278 for (const auto &lookup : m_lookups) { 279 const size_t start_func_idx = func_list.GetSize(); 280 context.module_sp->FindFunctions( 281 lookup.GetLookupName(), nullptr, lookup.GetNameTypeMask(), 282 include_symbols, include_inlines, func_list); 283 284 const size_t end_func_idx = func_list.GetSize(); 285 286 if (start_func_idx < end_func_idx) 287 lookup.Prune(func_list, start_func_idx); 288 } 289 } 290 break; 291 case Breakpoint::Regexp: 292 if (context.module_sp) { 293 context.module_sp->FindFunctions( 294 m_regex, 295 !filter_by_cu, // include symbols only if we aren't filtering by CU 296 include_inlines, func_list); 297 } 298 break; 299 case Breakpoint::Glob: 300 if (log) 301 log->Warning("glob is not supported yet."); 302 break; 303 } 304 305 // If the filter specifies a Compilation Unit, remove the ones that don't 306 // pass at this point. 307 if (filter_by_cu || filter_by_language) { 308 uint32_t num_functions = func_list.GetSize(); 309 310 for (size_t idx = 0; idx < num_functions; idx++) { 311 bool remove_it = false; 312 SymbolContext sc; 313 func_list.GetContextAtIndex(idx, sc); 314 if (filter_by_cu) { 315 if (!sc.comp_unit || !filter.CompUnitPasses(*sc.comp_unit)) 316 remove_it = true; 317 } 318 319 if (filter_by_language) { 320 LanguageType sym_language = sc.GetLanguage(); 321 if ((Language::GetPrimaryLanguage(sym_language) != 322 Language::GetPrimaryLanguage(m_language)) && 323 (sym_language != eLanguageTypeUnknown)) { 324 remove_it = true; 325 } 326 } 327 328 if (remove_it) { 329 func_list.RemoveContextAtIndex(idx); 330 num_functions--; 331 idx--; 332 } 333 } 334 } 335 336 // Remove any duplicates between the function list and the symbol list 337 SymbolContext sc; 338 if (func_list.GetSize()) { 339 for (i = 0; i < func_list.GetSize(); i++) { 340 if (func_list.GetContextAtIndex(i, sc)) { 341 bool is_reexported = false; 342 343 if (sc.block && sc.block->GetInlinedFunctionInfo()) { 344 if (!sc.block->GetStartAddress(break_addr)) 345 break_addr.Clear(); 346 } else if (sc.function) { 347 break_addr = sc.function->GetAddressRange().GetBaseAddress(); 348 if (m_skip_prologue && break_addr.IsValid()) { 349 const uint32_t prologue_byte_size = 350 sc.function->GetPrologueByteSize(); 351 if (prologue_byte_size) 352 break_addr.SetOffset(break_addr.GetOffset() + prologue_byte_size); 353 } 354 } else if (sc.symbol) { 355 if (sc.symbol->GetType() == eSymbolTypeReExported) { 356 const Symbol *actual_symbol = 357 sc.symbol->ResolveReExportedSymbol(m_breakpoint->GetTarget()); 358 if (actual_symbol) { 359 is_reexported = true; 360 break_addr = actual_symbol->GetAddress(); 361 } 362 } else { 363 break_addr = sc.symbol->GetAddress(); 364 } 365 366 if (m_skip_prologue && break_addr.IsValid()) { 367 const uint32_t prologue_byte_size = 368 sc.symbol->GetPrologueByteSize(); 369 if (prologue_byte_size) 370 break_addr.SetOffset(break_addr.GetOffset() + prologue_byte_size); 371 else { 372 const Architecture *arch = 373 m_breakpoint->GetTarget().GetArchitecturePlugin(); 374 if (arch) 375 arch->AdjustBreakpointAddress(*sc.symbol, break_addr); 376 } 377 } 378 } 379 380 if (break_addr.IsValid()) { 381 if (filter.AddressPasses(break_addr)) { 382 BreakpointLocationSP bp_loc_sp( 383 AddLocation(break_addr, &new_location)); 384 bp_loc_sp->SetIsReExported(is_reexported); 385 if (bp_loc_sp && new_location && !m_breakpoint->IsInternal()) { 386 if (log) { 387 StreamString s; 388 bp_loc_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose); 389 LLDB_LOGF(log, "Added location: %s\n", s.GetData()); 390 } 391 } 392 } 393 } 394 } 395 } 396 } 397 398 return Searcher::eCallbackReturnContinue; 399 } 400 401 lldb::SearchDepth BreakpointResolverName::GetDepth() { 402 return lldb::eSearchDepthModule; 403 } 404 405 void BreakpointResolverName::GetDescription(Stream *s) { 406 if (m_match_type == Breakpoint::Regexp) 407 s->Printf("regex = '%s'", m_regex.GetText().str().c_str()); 408 else { 409 size_t num_names = m_lookups.size(); 410 if (num_names == 1) 411 s->Printf("name = '%s'", m_lookups[0].GetName().GetCString()); 412 else { 413 s->Printf("names = {"); 414 for (size_t i = 0; i < num_names; i++) { 415 s->Printf("%s'%s'", (i == 0 ? "" : ", "), 416 m_lookups[i].GetName().GetCString()); 417 } 418 s->Printf("}"); 419 } 420 } 421 if (m_language != eLanguageTypeUnknown) { 422 s->Printf(", language = %s", Language::GetNameForLanguageType(m_language)); 423 } 424 } 425 426 void BreakpointResolverName::Dump(Stream *s) const {} 427 428 lldb::BreakpointResolverSP 429 BreakpointResolverName::CopyForBreakpoint(Breakpoint &breakpoint) { 430 lldb::BreakpointResolverSP ret_sp(new BreakpointResolverName(*this)); 431 ret_sp->SetBreakpoint(&breakpoint); 432 return ret_sp; 433 } 434