1 //===-- CPlusPlusLanguage.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 #include "CPlusPlusLanguage.h" 11 12 // C Includes 13 #include <cctype> 14 #include <cstring> 15 16 // C++ Includes 17 #include <functional> 18 #include <memory> 19 #include <mutex> 20 #include <set> 21 22 // Other libraries and framework includes 23 #include "llvm/ADT/StringRef.h" 24 #include "llvm/Demangle/Demangle.h" 25 26 // Project includes 27 #include "lldb/Core/PluginManager.h" 28 #include "lldb/Core/UniqueCStringMap.h" 29 #include "lldb/DataFormatters/CXXFunctionPointer.h" 30 #include "lldb/DataFormatters/DataVisualization.h" 31 #include "lldb/DataFormatters/FormattersHelpers.h" 32 #include "lldb/DataFormatters/VectorType.h" 33 #include "lldb/Utility/ConstString.h" 34 #include "lldb/Utility/Log.h" 35 #include "lldb/Utility/RegularExpression.h" 36 37 #include "BlockPointer.h" 38 #include "CPlusPlusNameParser.h" 39 #include "CxxStringTypes.h" 40 #include "LibCxx.h" 41 #include "LibCxxAtomic.h" 42 #include "LibStdcpp.h" 43 44 using namespace lldb; 45 using namespace lldb_private; 46 using namespace lldb_private::formatters; 47 48 void CPlusPlusLanguage::Initialize() { 49 PluginManager::RegisterPlugin(GetPluginNameStatic(), "C++ Language", 50 CreateInstance); 51 } 52 53 void CPlusPlusLanguage::Terminate() { 54 PluginManager::UnregisterPlugin(CreateInstance); 55 } 56 57 lldb_private::ConstString CPlusPlusLanguage::GetPluginNameStatic() { 58 static ConstString g_name("cplusplus"); 59 return g_name; 60 } 61 62 //------------------------------------------------------------------ 63 // PluginInterface protocol 64 //------------------------------------------------------------------ 65 66 lldb_private::ConstString CPlusPlusLanguage::GetPluginName() { 67 return GetPluginNameStatic(); 68 } 69 70 uint32_t CPlusPlusLanguage::GetPluginVersion() { return 1; } 71 72 //------------------------------------------------------------------ 73 // Static Functions 74 //------------------------------------------------------------------ 75 76 Language *CPlusPlusLanguage::CreateInstance(lldb::LanguageType language) { 77 if (Language::LanguageIsCPlusPlus(language)) 78 return new CPlusPlusLanguage(); 79 return nullptr; 80 } 81 82 void CPlusPlusLanguage::MethodName::Clear() { 83 m_full.Clear(); 84 m_basename = llvm::StringRef(); 85 m_context = llvm::StringRef(); 86 m_arguments = llvm::StringRef(); 87 m_qualifiers = llvm::StringRef(); 88 m_parsed = false; 89 m_parse_error = false; 90 } 91 92 static bool ReverseFindMatchingChars(const llvm::StringRef &s, 93 const llvm::StringRef &left_right_chars, 94 size_t &left_pos, size_t &right_pos, 95 size_t pos = llvm::StringRef::npos) { 96 assert(left_right_chars.size() == 2); 97 left_pos = llvm::StringRef::npos; 98 const char left_char = left_right_chars[0]; 99 const char right_char = left_right_chars[1]; 100 pos = s.find_last_of(left_right_chars, pos); 101 if (pos == llvm::StringRef::npos || s[pos] == left_char) 102 return false; 103 right_pos = pos; 104 uint32_t depth = 1; 105 while (pos > 0 && depth > 0) { 106 pos = s.find_last_of(left_right_chars, pos); 107 if (pos == llvm::StringRef::npos) 108 return false; 109 if (s[pos] == left_char) { 110 if (--depth == 0) { 111 left_pos = pos; 112 return left_pos < right_pos; 113 } 114 } else if (s[pos] == right_char) { 115 ++depth; 116 } 117 } 118 return false; 119 } 120 121 static bool IsTrivialBasename(const llvm::StringRef &basename) { 122 // Check that the basename matches with the following regular expression 123 // "^~?([A-Za-z_][A-Za-z_0-9]*)$" We are using a hand written implementation 124 // because it is significantly more efficient then using the general purpose 125 // regular expression library. 126 size_t idx = 0; 127 if (basename.size() > 0 && basename[0] == '~') 128 idx = 1; 129 130 if (basename.size() <= idx) 131 return false; // Empty string or "~" 132 133 if (!std::isalpha(basename[idx]) && basename[idx] != '_') 134 return false; // First charater (after removing the possible '~'') isn't in 135 // [A-Za-z_] 136 137 // Read all characters matching [A-Za-z_0-9] 138 ++idx; 139 while (idx < basename.size()) { 140 if (!std::isalnum(basename[idx]) && basename[idx] != '_') 141 break; 142 ++idx; 143 } 144 145 // We processed all characters. It is a vaild basename. 146 if (idx == basename.size()) 147 return true; 148 149 return false; 150 } 151 152 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() { 153 // This method tries to parse simple method definitions which are presumably 154 // most comman in user programs. Definitions that can be parsed by this 155 // function don't have return types and templates in the name. 156 // A::B::C::fun(std::vector<T> &) const 157 size_t arg_start, arg_end; 158 llvm::StringRef full(m_full.GetCString()); 159 llvm::StringRef parens("()", 2); 160 if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) { 161 m_arguments = full.substr(arg_start, arg_end - arg_start + 1); 162 if (arg_end + 1 < full.size()) 163 m_qualifiers = full.substr(arg_end + 1).ltrim(); 164 165 if (arg_start == 0) 166 return false; 167 size_t basename_end = arg_start; 168 size_t context_start = 0; 169 size_t context_end = full.rfind(':', basename_end); 170 if (context_end == llvm::StringRef::npos) 171 m_basename = full.substr(0, basename_end); 172 else { 173 if (context_start < context_end) 174 m_context = full.substr(context_start, context_end - 1 - context_start); 175 const size_t basename_begin = context_end + 1; 176 m_basename = full.substr(basename_begin, basename_end - basename_begin); 177 } 178 179 if (IsTrivialBasename(m_basename)) { 180 return true; 181 } else { 182 // The C++ basename doesn't match our regular expressions so this can't 183 // be a valid C++ method, clear everything out and indicate an error 184 m_context = llvm::StringRef(); 185 m_basename = llvm::StringRef(); 186 m_arguments = llvm::StringRef(); 187 m_qualifiers = llvm::StringRef(); 188 return false; 189 } 190 } 191 return false; 192 } 193 194 void CPlusPlusLanguage::MethodName::Parse() { 195 if (!m_parsed && m_full) { 196 if (TrySimplifiedParse()) { 197 m_parse_error = false; 198 } else { 199 CPlusPlusNameParser parser(m_full.GetStringRef()); 200 if (auto function = parser.ParseAsFunctionDefinition()) { 201 m_basename = function.getValue().name.basename; 202 m_context = function.getValue().name.context; 203 m_arguments = function.getValue().arguments; 204 m_qualifiers = function.getValue().qualifiers; 205 m_parse_error = false; 206 } else { 207 m_parse_error = true; 208 } 209 } 210 m_parsed = true; 211 } 212 } 213 214 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() { 215 if (!m_parsed) 216 Parse(); 217 return m_basename; 218 } 219 220 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() { 221 if (!m_parsed) 222 Parse(); 223 return m_context; 224 } 225 226 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() { 227 if (!m_parsed) 228 Parse(); 229 return m_arguments; 230 } 231 232 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() { 233 if (!m_parsed) 234 Parse(); 235 return m_qualifiers; 236 } 237 238 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() { 239 if (!m_parsed) 240 Parse(); 241 if (m_context.empty()) 242 return m_basename; 243 244 std::string res; 245 res += m_context; 246 res += "::"; 247 res += m_basename; 248 return res; 249 } 250 251 bool CPlusPlusLanguage::IsCPPMangledName(const char *name) { 252 // FIXME!! we should really run through all the known C++ Language plugins 253 // and ask each one if this is a C++ mangled name 254 255 if (name == nullptr) 256 return false; 257 258 // MSVC style mangling 259 if (name[0] == '?') 260 return true; 261 262 return (name[0] != '\0' && name[0] == '_' && name[1] == 'Z'); 263 } 264 265 bool CPlusPlusLanguage::ExtractContextAndIdentifier( 266 const char *name, llvm::StringRef &context, llvm::StringRef &identifier) { 267 CPlusPlusNameParser parser(name); 268 if (auto full_name = parser.ParseAsFullName()) { 269 identifier = full_name.getValue().basename; 270 context = full_name.getValue().context; 271 return true; 272 } 273 return false; 274 } 275 276 /// Given a mangled function `mangled`, replace all the primitive function type 277 /// arguments of `search` with type `replace`. 278 static ConstString SubsPrimitiveParmItanium(llvm::StringRef mangled, 279 llvm::StringRef search, 280 llvm::StringRef replace) { 281 class PrimitiveParmSubs { 282 llvm::StringRef mangled; 283 llvm::StringRef search; 284 llvm::StringRef replace; 285 ptrdiff_t read_pos; 286 std::string output; 287 std::back_insert_iterator<std::string> writer; 288 289 public: 290 PrimitiveParmSubs(llvm::StringRef m, llvm::StringRef s, llvm::StringRef r) 291 : mangled(m), search(s), replace(r), read_pos(0), 292 writer(std::back_inserter(output)) {} 293 294 void Substitute(llvm::StringRef tail) { 295 assert(tail.data() >= mangled.data() && 296 tail.data() < mangled.data() + mangled.size() && 297 "tail must point into range of mangled"); 298 299 if (tail.startswith(search)) { 300 auto reader = mangled.begin() + read_pos; 301 ptrdiff_t read_len = tail.data() - (mangled.data() + read_pos); 302 303 // First write the unmatched part of the original. Then write the 304 // replacement string. Finally skip the search string in the original. 305 writer = std::copy(reader, reader + read_len, writer); 306 writer = std::copy(replace.begin(), replace.end(), writer); 307 read_pos += read_len + search.size(); 308 } 309 } 310 311 ConstString Finalize() { 312 // If we did a substitution, write the remaining part of the original. 313 if (read_pos > 0) { 314 writer = std::copy(mangled.begin() + read_pos, mangled.end(), writer); 315 read_pos = mangled.size(); 316 } 317 318 return ConstString(output); 319 } 320 321 static void Callback(void *context, const char *match) { 322 ((PrimitiveParmSubs *)context)->Substitute(llvm::StringRef(match)); 323 } 324 }; 325 326 // FastDemangle will call back for each instance of a primitive type, 327 // allowing us to perform substitution 328 PrimitiveParmSubs parmSubs(mangled, search, replace); 329 assert(mangled.data()[mangled.size()] == '\0' && "Expect C-String"); 330 bool err = llvm::itaniumFindTypesInMangledName(mangled.data(), &parmSubs, 331 PrimitiveParmSubs::Callback); 332 ConstString result = parmSubs.Finalize(); 333 334 if (Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE)) { 335 if (err) 336 LLDB_LOG(log, "Failed to substitute mangling in {0}", mangled); 337 else if (result) 338 LLDB_LOG(log, "Substituted mangling {0} -> {1}", mangled, result); 339 } 340 341 return result; 342 } 343 344 uint32_t CPlusPlusLanguage::FindAlternateFunctionManglings( 345 const ConstString mangled_name, std::set<ConstString> &alternates) { 346 const auto start_size = alternates.size(); 347 /// Get a basic set of alternative manglings for the given symbol `name`, by 348 /// making a few basic possible substitutions on basic types, storage duration 349 /// and `const`ness for the given symbol. The output parameter `alternates` 350 /// is filled with a best-guess, non-exhaustive set of different manglings 351 /// for the given name. 352 353 // Maybe we're looking for a const symbol but the debug info told us it was 354 // non-const... 355 if (!strncmp(mangled_name.GetCString(), "_ZN", 3) && 356 strncmp(mangled_name.GetCString(), "_ZNK", 4)) { 357 std::string fixed_scratch("_ZNK"); 358 fixed_scratch.append(mangled_name.GetCString() + 3); 359 alternates.insert(ConstString(fixed_scratch)); 360 } 361 362 // Maybe we're looking for a static symbol but we thought it was global... 363 if (!strncmp(mangled_name.GetCString(), "_Z", 2) && 364 strncmp(mangled_name.GetCString(), "_ZL", 3)) { 365 std::string fixed_scratch("_ZL"); 366 fixed_scratch.append(mangled_name.GetCString() + 2); 367 alternates.insert(ConstString(fixed_scratch)); 368 } 369 370 // `char` is implementation defined as either `signed` or `unsigned`. As a 371 // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed 372 // char, 'h'-unsigned char. If we're looking for symbols with a signed char 373 // parameter, try finding matches which have the general case 'c'. 374 if (ConstString char_fixup = 375 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "a", "c")) 376 alternates.insert(char_fixup); 377 378 // long long parameter mangling 'x', may actually just be a long 'l' argument 379 if (ConstString long_fixup = 380 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "x", "l")) 381 alternates.insert(long_fixup); 382 383 // unsigned long long parameter mangling 'y', may actually just be unsigned 384 // long 'm' argument 385 if (ConstString ulong_fixup = 386 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "y", "m")) 387 alternates.insert(ulong_fixup); 388 389 return alternates.size() - start_size; 390 } 391 392 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 393 if (!cpp_category_sp) 394 return; 395 396 TypeSummaryImpl::Flags stl_summary_flags; 397 stl_summary_flags.SetCascades(true) 398 .SetSkipPointers(false) 399 .SetSkipReferences(false) 400 .SetDontShowChildren(true) 401 .SetDontShowValue(true) 402 .SetShowMembersOneLiner(false) 403 .SetHideItemNames(false); 404 405 #ifndef LLDB_DISABLE_PYTHON 406 lldb::TypeSummaryImplSP std_string_summary_sp(new CXXFunctionSummaryFormat( 407 stl_summary_flags, lldb_private::formatters::LibcxxStringSummaryProvider, 408 "std::string summary provider")); 409 lldb::TypeSummaryImplSP std_wstring_summary_sp(new CXXFunctionSummaryFormat( 410 stl_summary_flags, lldb_private::formatters::LibcxxWStringSummaryProvider, 411 "std::wstring summary provider")); 412 413 cpp_category_sp->GetTypeSummariesContainer()->Add( 414 ConstString("std::__1::string"), std_string_summary_sp); 415 cpp_category_sp->GetTypeSummariesContainer()->Add( 416 ConstString("std::__ndk1::string"), std_string_summary_sp); 417 cpp_category_sp->GetTypeSummariesContainer()->Add( 418 ConstString("std::__1::basic_string<char, std::__1::char_traits<char>, " 419 "std::__1::allocator<char> >"), 420 std_string_summary_sp); 421 cpp_category_sp->GetTypeSummariesContainer()->Add( 422 ConstString("std::__ndk1::basic_string<char, " 423 "std::__ndk1::char_traits<char>, " 424 "std::__ndk1::allocator<char> >"), 425 std_string_summary_sp); 426 427 cpp_category_sp->GetTypeSummariesContainer()->Add( 428 ConstString("std::__1::wstring"), std_wstring_summary_sp); 429 cpp_category_sp->GetTypeSummariesContainer()->Add( 430 ConstString("std::__ndk1::wstring"), std_wstring_summary_sp); 431 cpp_category_sp->GetTypeSummariesContainer()->Add( 432 ConstString("std::__1::basic_string<wchar_t, " 433 "std::__1::char_traits<wchar_t>, " 434 "std::__1::allocator<wchar_t> >"), 435 std_wstring_summary_sp); 436 cpp_category_sp->GetTypeSummariesContainer()->Add( 437 ConstString("std::__ndk1::basic_string<wchar_t, " 438 "std::__ndk1::char_traits<wchar_t>, " 439 "std::__ndk1::allocator<wchar_t> >"), 440 std_wstring_summary_sp); 441 442 SyntheticChildren::Flags stl_synth_flags; 443 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 444 false); 445 SyntheticChildren::Flags stl_deref_flags = stl_synth_flags; 446 stl_deref_flags.SetFrontEndWantsDereference(); 447 448 AddCXXSynthetic( 449 cpp_category_sp, 450 lldb_private::formatters::LibcxxBitsetSyntheticFrontEndCreator, 451 "libc++ std::bitset synthetic children", 452 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), stl_deref_flags, 453 true); 454 AddCXXSynthetic( 455 cpp_category_sp, 456 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator, 457 "libc++ std::vector synthetic children", 458 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), stl_deref_flags, 459 true); 460 AddCXXSynthetic( 461 cpp_category_sp, 462 lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator, 463 "libc++ std::forward_list synthetic children", 464 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 465 stl_synth_flags, true); 466 AddCXXSynthetic( 467 cpp_category_sp, 468 lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator, 469 "libc++ std::list synthetic children", 470 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), stl_synth_flags, true); 471 AddCXXSynthetic( 472 cpp_category_sp, 473 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 474 "libc++ std::map synthetic children", 475 ConstString("^std::__(ndk)?1::map<.+> >(( )?&)?$"), stl_synth_flags, 476 true); 477 AddCXXSynthetic( 478 cpp_category_sp, 479 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 480 "libc++ std::set synthetic children", 481 ConstString("^std::__(ndk)?1::set<.+> >(( )?&)?$"), stl_deref_flags, 482 true); 483 AddCXXSynthetic( 484 cpp_category_sp, 485 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 486 "libc++ std::multiset synthetic children", 487 ConstString("^std::__(ndk)?1::multiset<.+> >(( )?&)?$"), stl_deref_flags, 488 true); 489 AddCXXSynthetic( 490 cpp_category_sp, 491 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 492 "libc++ std::multimap synthetic children", 493 ConstString("^std::__(ndk)?1::multimap<.+> >(( )?&)?$"), stl_synth_flags, 494 true); 495 AddCXXSynthetic( 496 cpp_category_sp, 497 lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator, 498 "libc++ std::unordered containers synthetic children", 499 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 500 stl_synth_flags, true); 501 AddCXXSynthetic( 502 cpp_category_sp, 503 lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator, 504 "libc++ std::initializer_list synthetic children", 505 ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags, 506 true); 507 AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator, 508 "libc++ std::queue synthetic children", 509 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 510 stl_synth_flags, true); 511 AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator, 512 "libc++ std::tuple synthetic children", 513 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_synth_flags, 514 true); 515 AddCXXSynthetic( 516 cpp_category_sp, 517 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator, 518 "libc++ std::atomic synthetic children", 519 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true); 520 521 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 522 RegularExpressionSP(new RegularExpression( 523 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))), 524 SyntheticChildrenSP(new ScriptedSyntheticChildren( 525 stl_synth_flags, 526 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider"))); 527 528 AddCXXSynthetic( 529 cpp_category_sp, 530 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 531 "shared_ptr synthetic children", 532 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"), 533 stl_synth_flags, true); 534 AddCXXSynthetic( 535 cpp_category_sp, 536 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 537 "weak_ptr synthetic children", 538 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, 539 true); 540 541 stl_summary_flags.SetDontShowChildren(false); 542 stl_summary_flags.SetSkipPointers(false); 543 AddCXXSummary(cpp_category_sp, 544 lldb_private::formatters::LibcxxContainerSummaryProvider, 545 "libc++ std::bitset summary provider", 546 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), 547 stl_summary_flags, true); 548 AddCXXSummary(cpp_category_sp, 549 lldb_private::formatters::LibcxxContainerSummaryProvider, 550 "libc++ std::vector summary provider", 551 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), 552 stl_summary_flags, true); 553 AddCXXSummary(cpp_category_sp, 554 lldb_private::formatters::LibcxxContainerSummaryProvider, 555 "libc++ std::list summary provider", 556 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 557 stl_summary_flags, true); 558 AddCXXSummary(cpp_category_sp, 559 lldb_private::formatters::LibcxxContainerSummaryProvider, 560 "libc++ std::list summary provider", 561 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), 562 stl_summary_flags, true); 563 AddCXXSummary(cpp_category_sp, 564 lldb_private::formatters::LibcxxContainerSummaryProvider, 565 "libc++ std::map summary provider", 566 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"), 567 stl_summary_flags, true); 568 AddCXXSummary(cpp_category_sp, 569 lldb_private::formatters::LibcxxContainerSummaryProvider, 570 "libc++ std::deque summary provider", 571 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"), 572 stl_summary_flags, true); 573 AddCXXSummary(cpp_category_sp, 574 lldb_private::formatters::LibcxxContainerSummaryProvider, 575 "libc++ std::queue summary provider", 576 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 577 stl_summary_flags, true); 578 AddCXXSummary(cpp_category_sp, 579 lldb_private::formatters::LibcxxContainerSummaryProvider, 580 "libc++ std::set summary provider", 581 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"), 582 stl_summary_flags, true); 583 AddCXXSummary(cpp_category_sp, 584 lldb_private::formatters::LibcxxContainerSummaryProvider, 585 "libc++ std::multiset summary provider", 586 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"), 587 stl_summary_flags, true); 588 AddCXXSummary(cpp_category_sp, 589 lldb_private::formatters::LibcxxContainerSummaryProvider, 590 "libc++ std::multimap summary provider", 591 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"), 592 stl_summary_flags, true); 593 AddCXXSummary( 594 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, 595 "libc++ std::unordered containers summary provider", 596 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 597 stl_summary_flags, true); 598 AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider, 599 "libc++ std::tuple summary provider", 600 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_summary_flags, 601 true); 602 AddCXXSummary( 603 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider, 604 "libc++ std::atomic summary provider", 605 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true); 606 607 stl_summary_flags.SetSkipPointers(true); 608 609 AddCXXSummary(cpp_category_sp, 610 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 611 "libc++ std::shared_ptr summary provider", 612 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"), 613 stl_summary_flags, true); 614 AddCXXSummary(cpp_category_sp, 615 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 616 "libc++ std::weak_ptr summary provider", 617 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"), 618 stl_summary_flags, true); 619 620 AddCXXSynthetic( 621 cpp_category_sp, 622 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, 623 "std::vector iterator synthetic children", 624 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true); 625 626 AddCXXSynthetic( 627 cpp_category_sp, 628 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, 629 "std::map iterator synthetic children", 630 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags, 631 true); 632 633 AddCXXSynthetic( 634 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator, 635 "std::function synthetic value provider", 636 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true); 637 #endif 638 } 639 640 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 641 if (!cpp_category_sp) 642 return; 643 644 TypeSummaryImpl::Flags stl_summary_flags; 645 stl_summary_flags.SetCascades(true) 646 .SetSkipPointers(false) 647 .SetSkipReferences(false) 648 .SetDontShowChildren(true) 649 .SetDontShowValue(true) 650 .SetShowMembersOneLiner(false) 651 .SetHideItemNames(false); 652 653 lldb::TypeSummaryImplSP std_string_summary_sp( 654 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}")); 655 656 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat( 657 stl_summary_flags, LibStdcppStringSummaryProvider, 658 "libstdc++ c++11 std::string summary provider")); 659 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat( 660 stl_summary_flags, LibStdcppWStringSummaryProvider, 661 "libstdc++ c++11 std::wstring summary provider")); 662 663 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"), 664 std_string_summary_sp); 665 cpp_category_sp->GetTypeSummariesContainer()->Add( 666 ConstString("std::basic_string<char>"), std_string_summary_sp); 667 cpp_category_sp->GetTypeSummariesContainer()->Add( 668 ConstString("std::basic_string<char,std::char_traits<char>,std::" 669 "allocator<char> >"), 670 std_string_summary_sp); 671 cpp_category_sp->GetTypeSummariesContainer()->Add( 672 ConstString("std::basic_string<char, std::char_traits<char>, " 673 "std::allocator<char> >"), 674 std_string_summary_sp); 675 676 cpp_category_sp->GetTypeSummariesContainer()->Add( 677 ConstString("std::__cxx11::string"), cxx11_string_summary_sp); 678 cpp_category_sp->GetTypeSummariesContainer()->Add( 679 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, " 680 "std::allocator<char> >"), 681 cxx11_string_summary_sp); 682 683 // making sure we force-pick the summary for printing wstring (_M_p is a 684 // wchar_t*) 685 lldb::TypeSummaryImplSP std_wstring_summary_sp( 686 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}")); 687 688 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"), 689 std_wstring_summary_sp); 690 cpp_category_sp->GetTypeSummariesContainer()->Add( 691 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp); 692 cpp_category_sp->GetTypeSummariesContainer()->Add( 693 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::" 694 "allocator<wchar_t> >"), 695 std_wstring_summary_sp); 696 cpp_category_sp->GetTypeSummariesContainer()->Add( 697 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, " 698 "std::allocator<wchar_t> >"), 699 std_wstring_summary_sp); 700 701 cpp_category_sp->GetTypeSummariesContainer()->Add( 702 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp); 703 cpp_category_sp->GetTypeSummariesContainer()->Add( 704 ConstString("std::__cxx11::basic_string<wchar_t, " 705 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"), 706 cxx11_wstring_summary_sp); 707 708 #ifndef LLDB_DISABLE_PYTHON 709 710 SyntheticChildren::Flags stl_synth_flags; 711 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 712 false); 713 714 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 715 RegularExpressionSP( 716 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 717 SyntheticChildrenSP(new ScriptedSyntheticChildren( 718 stl_synth_flags, 719 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider"))); 720 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 721 RegularExpressionSP( 722 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 723 SyntheticChildrenSP(new ScriptedSyntheticChildren( 724 stl_synth_flags, 725 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider"))); 726 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 727 RegularExpressionSP(new RegularExpression( 728 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 729 SyntheticChildrenSP(new ScriptedSyntheticChildren( 730 stl_synth_flags, 731 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider"))); 732 stl_summary_flags.SetDontShowChildren(false); 733 stl_summary_flags.SetSkipPointers(true); 734 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 735 RegularExpressionSP( 736 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 737 TypeSummaryImplSP( 738 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 739 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 740 RegularExpressionSP( 741 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 742 TypeSummaryImplSP( 743 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 744 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 745 RegularExpressionSP(new RegularExpression( 746 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 747 TypeSummaryImplSP( 748 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 749 750 AddCXXSynthetic( 751 cpp_category_sp, 752 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, 753 "std::vector iterator synthetic children", 754 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true); 755 756 AddCXXSynthetic( 757 cpp_category_sp, 758 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, 759 "std::map iterator synthetic children", 760 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true); 761 762 AddCXXSynthetic( 763 cpp_category_sp, 764 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator, 765 "std::unique_ptr synthetic children", 766 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 767 AddCXXSynthetic( 768 cpp_category_sp, 769 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 770 "std::shared_ptr synthetic children", 771 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 772 AddCXXSynthetic( 773 cpp_category_sp, 774 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 775 "std::weak_ptr synthetic children", 776 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 777 AddCXXSynthetic( 778 cpp_category_sp, 779 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator, 780 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"), 781 stl_synth_flags, true); 782 783 AddCXXSummary(cpp_category_sp, 784 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider, 785 "libstdc++ std::unique_ptr summary provider", 786 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags, 787 true); 788 AddCXXSummary(cpp_category_sp, 789 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 790 "libstdc++ std::shared_ptr summary provider", 791 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, 792 true); 793 AddCXXSummary(cpp_category_sp, 794 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 795 "libstdc++ std::weak_ptr summary provider", 796 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, 797 true); 798 #endif 799 } 800 801 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 802 if (!cpp_category_sp) 803 return; 804 805 TypeSummaryImpl::Flags string_flags; 806 string_flags.SetCascades(true) 807 .SetSkipPointers(true) 808 .SetSkipReferences(false) 809 .SetDontShowChildren(true) 810 .SetDontShowValue(false) 811 .SetShowMembersOneLiner(false) 812 .SetHideItemNames(false); 813 814 TypeSummaryImpl::Flags string_array_flags; 815 string_array_flags.SetCascades(true) 816 .SetSkipPointers(true) 817 .SetSkipReferences(false) 818 .SetDontShowChildren(true) 819 .SetDontShowValue(true) 820 .SetShowMembersOneLiner(false) 821 .SetHideItemNames(false); 822 823 #ifndef LLDB_DISABLE_PYTHON 824 // FIXME because of a bug in the FormattersContainer we need to add a summary 825 // for both X* and const X* (<rdar://problem/12717717>) 826 AddCXXSummary( 827 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 828 "char16_t * summary provider", ConstString("char16_t *"), string_flags); 829 AddCXXSummary(cpp_category_sp, 830 lldb_private::formatters::Char16StringSummaryProvider, 831 "char16_t [] summary provider", 832 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true); 833 834 AddCXXSummary( 835 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider, 836 "char32_t * summary provider", ConstString("char32_t *"), string_flags); 837 AddCXXSummary(cpp_category_sp, 838 lldb_private::formatters::Char32StringSummaryProvider, 839 "char32_t [] summary provider", 840 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true); 841 842 AddCXXSummary( 843 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider, 844 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags); 845 AddCXXSummary(cpp_category_sp, 846 lldb_private::formatters::WCharStringSummaryProvider, 847 "wchar_t * summary provider", 848 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true); 849 850 AddCXXSummary( 851 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 852 "unichar * summary provider", ConstString("unichar *"), string_flags); 853 854 TypeSummaryImpl::Flags widechar_flags; 855 widechar_flags.SetDontShowValue(true) 856 .SetSkipPointers(true) 857 .SetSkipReferences(false) 858 .SetCascades(true) 859 .SetDontShowChildren(true) 860 .SetHideItemNames(true) 861 .SetShowMembersOneLiner(false); 862 863 AddCXXSummary( 864 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 865 "char16_t summary provider", ConstString("char16_t"), widechar_flags); 866 AddCXXSummary( 867 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider, 868 "char32_t summary provider", ConstString("char32_t"), widechar_flags); 869 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider, 870 "wchar_t summary provider", ConstString("wchar_t"), 871 widechar_flags); 872 873 AddCXXSummary( 874 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 875 "unichar summary provider", ConstString("unichar"), widechar_flags); 876 #endif 877 } 878 879 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() { 880 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger { 881 public: 882 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override { 883 LanguageType lang_type(candidate.GetMinimumLanguage()); 884 if (!Language::LanguageIsC(lang_type) && 885 !Language::LanguageIsCPlusPlus(lang_type)) 886 return CompilerType(); 887 if (candidate.IsTypedefType()) 888 return candidate.GetTypedefedType(); 889 return candidate; 890 } 891 }; 892 893 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger()); 894 } 895 896 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() { 897 static llvm::once_flag g_initialize; 898 static TypeCategoryImplSP g_category; 899 900 llvm::call_once(g_initialize, [this]() -> void { 901 DataVisualization::Categories::GetCategory(GetPluginName(), g_category); 902 if (g_category) { 903 LoadLibCxxFormatters(g_category); 904 LoadLibStdcppFormatters(g_category); 905 LoadSystemFormatters(g_category); 906 } 907 }); 908 return g_category; 909 } 910 911 HardcodedFormatters::HardcodedSummaryFinder 912 CPlusPlusLanguage::GetHardcodedSummaries() { 913 static llvm::once_flag g_initialize; 914 static ConstString g_vectortypes("VectorTypes"); 915 static HardcodedFormatters::HardcodedSummaryFinder g_formatters; 916 917 llvm::call_once(g_initialize, []() -> void { 918 g_formatters.push_back( 919 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 920 FormatManager &) -> TypeSummaryImpl::SharedPointer { 921 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 922 new CXXFunctionSummaryFormat( 923 TypeSummaryImpl::Flags(), 924 lldb_private::formatters::CXXFunctionPointerSummaryProvider, 925 "Function pointer summary provider")); 926 if (valobj.GetCompilerType().IsFunctionPointerType()) { 927 return formatter_sp; 928 } 929 return nullptr; 930 }); 931 g_formatters.push_back( 932 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 933 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 934 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 935 new CXXFunctionSummaryFormat( 936 TypeSummaryImpl::Flags() 937 .SetCascades(true) 938 .SetDontShowChildren(true) 939 .SetHideItemNames(true) 940 .SetShowMembersOneLiner(true) 941 .SetSkipPointers(true) 942 .SetSkipReferences(false), 943 lldb_private::formatters::VectorTypeSummaryProvider, 944 "vector_type pointer summary provider")); 945 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 946 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 947 return formatter_sp; 948 } 949 return nullptr; 950 }); 951 g_formatters.push_back( 952 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 953 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 954 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 955 new CXXFunctionSummaryFormat( 956 TypeSummaryImpl::Flags() 957 .SetCascades(true) 958 .SetDontShowChildren(true) 959 .SetHideItemNames(true) 960 .SetShowMembersOneLiner(true) 961 .SetSkipPointers(true) 962 .SetSkipReferences(false), 963 lldb_private::formatters::BlockPointerSummaryProvider, 964 "block pointer summary provider")); 965 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 966 return formatter_sp; 967 } 968 return nullptr; 969 }); 970 }); 971 972 return g_formatters; 973 } 974 975 HardcodedFormatters::HardcodedSyntheticFinder 976 CPlusPlusLanguage::GetHardcodedSynthetics() { 977 static llvm::once_flag g_initialize; 978 static ConstString g_vectortypes("VectorTypes"); 979 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters; 980 981 llvm::call_once(g_initialize, []() -> void { 982 g_formatters.push_back([](lldb_private::ValueObject &valobj, 983 lldb::DynamicValueType, 984 FormatManager & 985 fmt_mgr) -> SyntheticChildren::SharedPointer { 986 static CXXSyntheticChildren::SharedPointer formatter_sp( 987 new CXXSyntheticChildren( 988 SyntheticChildren::Flags() 989 .SetCascades(true) 990 .SetSkipPointers(true) 991 .SetSkipReferences(true) 992 .SetNonCacheable(true), 993 "vector_type synthetic children", 994 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator)); 995 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 996 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 997 return formatter_sp; 998 } 999 return nullptr; 1000 }); 1001 g_formatters.push_back([](lldb_private::ValueObject &valobj, 1002 lldb::DynamicValueType, 1003 FormatManager & 1004 fmt_mgr) -> SyntheticChildren::SharedPointer { 1005 static CXXSyntheticChildren::SharedPointer formatter_sp( 1006 new CXXSyntheticChildren( 1007 SyntheticChildren::Flags() 1008 .SetCascades(true) 1009 .SetSkipPointers(true) 1010 .SetSkipReferences(true) 1011 .SetNonCacheable(true), 1012 "block pointer synthetic children", 1013 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator)); 1014 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 1015 return formatter_sp; 1016 } 1017 return nullptr; 1018 }); 1019 1020 }); 1021 1022 return g_formatters; 1023 } 1024 1025 bool CPlusPlusLanguage::IsSourceFile(llvm::StringRef file_path) const { 1026 const auto suffixes = {".cpp", ".cxx", ".c++", ".cc", ".c", 1027 ".h", ".hh", ".hpp", ".hxx", ".h++"}; 1028 for (auto suffix : suffixes) { 1029 if (file_path.endswith_lower(suffix)) 1030 return true; 1031 } 1032 1033 // Check if we're in a STL path (where the files usually have no extension 1034 // that we could check for. 1035 return file_path.contains("/usr/include/c++/"); 1036 } 1037