1314564Sdim//===-- BreakpointResolverFileRegex.cpp -------------------------*- C++-*-===// 2254721Semaste// 3353358Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim// See https://llvm.org/LICENSE.txt for license information. 5353358Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6254721Semaste// 7254721Semaste//===----------------------------------------------------------------------===// 8254721Semaste 9254721Semaste#include "lldb/Breakpoint/BreakpointResolverFileRegex.h" 10254721Semaste 11254721Semaste#include "lldb/Breakpoint/BreakpointLocation.h" 12254721Semaste#include "lldb/Core/SourceManager.h" 13254721Semaste#include "lldb/Symbol/CompileUnit.h" 14254721Semaste#include "lldb/Target/Target.h" 15321369Sdim#include "lldb/Utility/Log.h" 16321369Sdim#include "lldb/Utility/StreamString.h" 17254721Semaste 18254721Semasteusing namespace lldb; 19254721Semasteusing namespace lldb_private; 20254721Semaste 21254721Semaste// BreakpointResolverFileRegex: 22314564SdimBreakpointResolverFileRegex::BreakpointResolverFileRegex( 23360784Sdim Breakpoint *bkpt, RegularExpression regex, 24314564Sdim const std::unordered_set<std::string> &func_names, bool exact_match) 25314564Sdim : BreakpointResolver(bkpt, BreakpointResolver::FileRegexResolver), 26360784Sdim m_regex(std::move(regex)), m_exact_match(exact_match), 27360784Sdim m_function_names(func_names) {} 28254721Semaste 29314564SdimBreakpointResolverFileRegex::~BreakpointResolverFileRegex() {} 30314564Sdim 31314564SdimBreakpointResolver *BreakpointResolverFileRegex::CreateFromStructuredData( 32314564Sdim Breakpoint *bkpt, const StructuredData::Dictionary &options_dict, 33321369Sdim Status &error) { 34314564Sdim bool success; 35314564Sdim 36321369Sdim llvm::StringRef regex_string; 37314564Sdim success = options_dict.GetValueForKeyAsString( 38314564Sdim GetKey(OptionNames::RegexString), regex_string); 39314564Sdim if (!success) { 40314564Sdim error.SetErrorString("BRFR::CFSD: Couldn't find regex entry."); 41314564Sdim return nullptr; 42314564Sdim } 43314564Sdim RegularExpression regex(regex_string); 44314564Sdim 45314564Sdim bool exact_match; 46314564Sdim success = options_dict.GetValueForKeyAsBoolean( 47314564Sdim GetKey(OptionNames::ExactMatch), exact_match); 48314564Sdim if (!success) { 49314564Sdim error.SetErrorString("BRFL::CFSD: Couldn't find exact match entry."); 50314564Sdim return nullptr; 51314564Sdim } 52314564Sdim 53314564Sdim // The names array is optional: 54314564Sdim std::unordered_set<std::string> names_set; 55314564Sdim StructuredData::Array *names_array; 56314564Sdim success = options_dict.GetValueForKeyAsArray( 57314564Sdim GetKey(OptionNames::SymbolNameArray), names_array); 58314564Sdim if (success && names_array) { 59314564Sdim size_t num_names = names_array->GetSize(); 60314564Sdim for (size_t i = 0; i < num_names; i++) { 61321369Sdim llvm::StringRef name; 62314564Sdim success = names_array->GetItemAtIndexAsString(i, name); 63314564Sdim if (!success) { 64314564Sdim error.SetErrorStringWithFormat( 65314564Sdim "BRFR::CFSD: Malformed element %zu in the names array.", i); 66314564Sdim return nullptr; 67314564Sdim } 68314564Sdim names_set.insert(name); 69314564Sdim } 70314564Sdim } 71314564Sdim 72360784Sdim return new BreakpointResolverFileRegex(bkpt, std::move(regex), names_set, 73360784Sdim exact_match); 74254721Semaste} 75254721Semaste 76314564SdimStructuredData::ObjectSP 77314564SdimBreakpointResolverFileRegex::SerializeToStructuredData() { 78314564Sdim StructuredData::DictionarySP options_dict_sp( 79314564Sdim new StructuredData::Dictionary()); 80314564Sdim 81314564Sdim options_dict_sp->AddStringItem(GetKey(OptionNames::RegexString), 82314564Sdim m_regex.GetText()); 83314564Sdim options_dict_sp->AddBooleanItem(GetKey(OptionNames::ExactMatch), 84314564Sdim m_exact_match); 85314564Sdim if (!m_function_names.empty()) { 86314564Sdim StructuredData::ArraySP names_array_sp(new StructuredData::Array()); 87314564Sdim for (std::string name : m_function_names) { 88314564Sdim StructuredData::StringSP item(new StructuredData::String(name)); 89314564Sdim names_array_sp->AddItem(item); 90314564Sdim } 91314564Sdim options_dict_sp->AddItem(GetKey(OptionNames::LineNumber), names_array_sp); 92314564Sdim } 93314564Sdim 94314564Sdim return WrapOptionsDict(options_dict_sp); 95314564Sdim} 96314564Sdim 97360784SdimSearcher::CallbackReturn BreakpointResolverFileRegex::SearchCallback( 98360784Sdim SearchFilter &filter, SymbolContext &context, Address *addr) { 99254721Semaste 100353358Sdim assert(m_breakpoint != nullptr); 101314564Sdim if (!context.target_sp) 102314564Sdim return eCallbackReturnContinue; 103254721Semaste 104314564Sdim CompileUnit *cu = context.comp_unit; 105360784Sdim FileSpec cu_file_spec = cu->GetPrimaryFile(); 106314564Sdim std::vector<uint32_t> line_matches; 107314564Sdim context.target_sp->GetSourceManager().FindLinesMatchingRegex( 108314564Sdim cu_file_spec, m_regex, 1, UINT32_MAX, line_matches); 109314564Sdim 110314564Sdim uint32_t num_matches = line_matches.size(); 111314564Sdim for (uint32_t i = 0; i < num_matches; i++) { 112314564Sdim SymbolContextList sc_list; 113314564Sdim const bool search_inlines = false; 114314564Sdim 115314564Sdim cu->ResolveSymbolContext(cu_file_spec, line_matches[i], search_inlines, 116314564Sdim m_exact_match, eSymbolContextEverything, sc_list); 117314564Sdim // Find all the function names: 118314564Sdim if (!m_function_names.empty()) { 119314564Sdim std::vector<size_t> sc_to_remove; 120314564Sdim for (size_t i = 0; i < sc_list.GetSize(); i++) { 121314564Sdim SymbolContext sc_ctx; 122314564Sdim sc_list.GetContextAtIndex(i, sc_ctx); 123314564Sdim std::string name( 124314564Sdim sc_ctx 125314564Sdim .GetFunctionName( 126314564Sdim Mangled::NamePreference::ePreferDemangledWithoutArguments) 127314564Sdim .AsCString()); 128314564Sdim if (!m_function_names.count(name)) { 129314564Sdim sc_to_remove.push_back(i); 130309124Sdim } 131314564Sdim } 132314564Sdim 133314564Sdim if (!sc_to_remove.empty()) { 134314564Sdim std::vector<size_t>::reverse_iterator iter; 135314564Sdim std::vector<size_t>::reverse_iterator rend = sc_to_remove.rend(); 136314564Sdim for (iter = sc_to_remove.rbegin(); iter != rend; iter++) { 137314564Sdim sc_list.RemoveContextAtIndex(*iter); 138314564Sdim } 139314564Sdim } 140254721Semaste } 141254721Semaste 142314564Sdim const bool skip_prologue = true; 143314564Sdim 144314564Sdim BreakpointResolver::SetSCMatchesByLine(filter, sc_list, skip_prologue, 145314564Sdim m_regex.GetText()); 146314564Sdim } 147353358Sdim assert(m_breakpoint != nullptr); 148314564Sdim 149314564Sdim return Searcher::eCallbackReturnContinue; 150254721Semaste} 151254721Semaste 152344779Sdimlldb::SearchDepth BreakpointResolverFileRegex::GetDepth() { 153344779Sdim return lldb::eSearchDepthCompUnit; 154254721Semaste} 155254721Semaste 156314564Sdimvoid BreakpointResolverFileRegex::GetDescription(Stream *s) { 157314564Sdim s->Printf("source regex = \"%s\", exact_match = %d", 158314564Sdim m_regex.GetText().str().c_str(), m_exact_match); 159254721Semaste} 160254721Semaste 161314564Sdimvoid BreakpointResolverFileRegex::Dump(Stream *s) const {} 162254721Semaste 163280031Sdimlldb::BreakpointResolverSP 164314564SdimBreakpointResolverFileRegex::CopyForBreakpoint(Breakpoint &breakpoint) { 165314564Sdim lldb::BreakpointResolverSP ret_sp(new BreakpointResolverFileRegex( 166314564Sdim &breakpoint, m_regex, m_function_names, m_exact_match)); 167314564Sdim return ret_sp; 168280031Sdim} 169280031Sdim 170314564Sdimvoid BreakpointResolverFileRegex::AddFunctionName(const char *func_name) { 171314564Sdim m_function_names.insert(func_name); 172309124Sdim} 173