1 //===-- BreakpointResolverName.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 // Project includes
14 #include "lldb/Breakpoint/BreakpointResolverName.h"
15 
16 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
17 #include "Plugins/Language/ObjC/ObjCLanguage.h"
18 #include "lldb/Breakpoint/BreakpointLocation.h"
19 #include "lldb/Core/Log.h"
20 #include "lldb/Core/Module.h"
21 #include "lldb/Core/StreamString.h"
22 #include "lldb/Symbol/Block.h"
23 #include "lldb/Symbol/Function.h"
24 #include "lldb/Symbol/Symbol.h"
25 #include "lldb/Symbol/SymbolContext.h"
26 
27 using namespace lldb;
28 using namespace lldb_private;
29 
30 BreakpointResolverName::BreakpointResolverName(
31     Breakpoint *bkpt, const char *name_cstr, uint32_t name_type_mask,
32     LanguageType language, Breakpoint::MatchType type, lldb::addr_t offset,
33     bool skip_prologue)
34     : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset),
35       m_class_name(), m_regex(), m_match_type(type), m_language(language),
36       m_skip_prologue(skip_prologue) {
37   if (m_match_type == Breakpoint::Regexp) {
38     if (!m_regex.Compile(name_cstr)) {
39       Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS));
40 
41       if (log)
42         log->Warning("function name regexp: \"%s\" did not compile.",
43                      name_cstr);
44     }
45   } else {
46     AddNameLookup(ConstString(name_cstr), name_type_mask);
47   }
48 }
49 
50 BreakpointResolverName::BreakpointResolverName(
51     Breakpoint *bkpt, const char *names[], size_t num_names,
52     uint32_t name_type_mask, LanguageType language, lldb::addr_t offset,
53     bool skip_prologue)
54     : BreakpointResolver(bkpt, BreakpointResolver::NameResolver, offset),
55       m_match_type(Breakpoint::Exact), m_language(language),
56       m_skip_prologue(skip_prologue) {
57   for (size_t i = 0; i < num_names; i++) {
58     AddNameLookup(ConstString(names[i]), name_type_mask);
59   }
60 }
61 
62 BreakpointResolverName::BreakpointResolverName(
63     Breakpoint *bkpt, std::vector<std::string> names, uint32_t name_type_mask,
64     LanguageType language, lldb::addr_t offset, 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(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, StructuredData::Dictionary &options_dict, Error &error) {
95   LanguageType language = eLanguageTypeUnknown;
96   std::string language_name;
97   bool success = options_dict.GetValueForKeyAsString(
98       GetKey(OptionNames::LanguageName), language_name);
99   if (success) {
100     language = Language::GetLanguageTypeFromString(language_name.c_str());
101     if (language == eLanguageTypeUnknown) {
102       error.SetErrorStringWithFormat("BRN::CFSD: Unknown language: %s.",
103                                      language_name.c_str());
104       return nullptr;
105     }
106   }
107 
108   lldb::addr_t offset = 0;
109   success =
110       options_dict.GetValueForKeyAsInteger(GetKey(OptionNames::Offset), offset);
111   if (!success) {
112     error.SetErrorStringWithFormat("BRN::CFSD: Missing offset entry.");
113     return nullptr;
114   }
115 
116   bool skip_prologue;
117   success = options_dict.GetValueForKeyAsBoolean(
118       GetKey(OptionNames::SkipPrologue), skip_prologue);
119   if (!success) {
120     error.SetErrorStringWithFormat("BRN::CFSD: Missing Skip prologue entry.");
121     return nullptr;
122   }
123 
124   std::string regex_text;
125   success = options_dict.GetValueForKeyAsString(
126       GetKey(OptionNames::RegexString), regex_text);
127   if (success) {
128     RegularExpression regex(regex_text.c_str());
129     return new BreakpointResolverName(bkpt, regex, language, offset,
130                                       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<uint32_t> name_masks;
162     for (size_t i = 0; i < num_elem; i++) {
163       uint32_t name_mask;
164       std::string name;
165 
166       success = names_array->GetItemAtIndexAsString(i, name);
167       if (!success) {
168         error.SetErrorString("BRN::CFSD: name entry is not a string.");
169         return nullptr;
170       }
171       success = names_mask_array->GetItemAtIndexAsInteger(i, name_mask);
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(name_mask);
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(const ConstString &name,
220                                            uint32_t name_type_mask) {
221   ObjCLanguage::MethodName objc_method(name.GetCString(), false);
222   if (objc_method.IsValid(false)) {
223     std::vector<ConstString> objc_names;
224     objc_method.GetFullNames(objc_names, true);
225     for (ConstString objc_name : objc_names) {
226       Module::LookupInfo lookup;
227       lookup.SetName(name);
228       lookup.SetLookupName(objc_name);
229       lookup.SetNameTypeMask(eFunctionNameTypeFull);
230       m_lookups.push_back(lookup);
231     }
232   } else {
233     Module::LookupInfo lookup(name, name_type_mask, m_language);
234     m_lookups.push_back(lookup);
235   }
236 }
237 
238 // FIXME: Right now we look at the module level, and call the module's
239 // "FindFunctions".
240 // Greg says he will add function tables, maybe at the CompileUnit level to
241 // accelerate function
242 // lookup.  At that point, we should switch the depth to CompileUnit, and look
243 // in these tables.
244 
245 Searcher::CallbackReturn
246 BreakpointResolverName::SearchCallback(SearchFilter &filter,
247                                        SymbolContext &context, Address *addr,
248                                        bool containing) {
249   SymbolContextList func_list;
250   // SymbolContextList sym_list;
251 
252   uint32_t i;
253   bool new_location;
254   Address break_addr;
255   assert(m_breakpoint != nullptr);
256 
257   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_BREAKPOINTS));
258 
259   if (m_class_name) {
260     if (log)
261       log->Warning("Class/method function specification not supported yet.\n");
262     return Searcher::eCallbackReturnStop;
263   }
264   bool filter_by_cu =
265       (filter.GetFilterRequiredItems() & eSymbolContextCompUnit) != 0;
266   bool filter_by_language = (m_language != eLanguageTypeUnknown);
267   const bool include_symbols = !filter_by_cu;
268   const bool include_inlines = true;
269   const bool append = true;
270 
271   switch (m_match_type) {
272   case Breakpoint::Exact:
273     if (context.module_sp) {
274       for (const auto &lookup : m_lookups) {
275         const size_t start_func_idx = func_list.GetSize();
276         context.module_sp->FindFunctions(
277             lookup.GetLookupName(), nullptr, lookup.GetNameTypeMask(),
278             include_symbols, include_inlines, append, func_list);
279 
280         const size_t end_func_idx = func_list.GetSize();
281 
282         if (start_func_idx < end_func_idx)
283           lookup.Prune(func_list, start_func_idx);
284       }
285     }
286     break;
287   case Breakpoint::Regexp:
288     if (context.module_sp) {
289       context.module_sp->FindFunctions(
290           m_regex,
291           !filter_by_cu, // include symbols only if we aren't filtering by CU
292           include_inlines, append, func_list);
293     }
294     break;
295   case Breakpoint::Glob:
296     if (log)
297       log->Warning("glob is not supported yet.");
298     break;
299   }
300 
301   // If the filter specifies a Compilation Unit, remove the ones that don't pass
302   // at this point.
303   if (filter_by_cu || filter_by_language) {
304     uint32_t num_functions = func_list.GetSize();
305 
306     for (size_t idx = 0; idx < num_functions; idx++) {
307       bool remove_it = false;
308       SymbolContext sc;
309       func_list.GetContextAtIndex(idx, sc);
310       if (filter_by_cu) {
311         if (!sc.comp_unit || !filter.CompUnitPasses(*sc.comp_unit))
312           remove_it = true;
313       }
314 
315       if (filter_by_language) {
316         LanguageType sym_language = sc.GetLanguage();
317         if ((Language::GetPrimaryLanguage(sym_language) !=
318              Language::GetPrimaryLanguage(m_language)) &&
319             (sym_language != eLanguageTypeUnknown)) {
320           remove_it = true;
321         }
322       }
323 
324       if (remove_it) {
325         func_list.RemoveContextAtIndex(idx);
326         num_functions--;
327         idx--;
328       }
329     }
330   }
331 
332   // Remove any duplicates between the function list and the symbol list
333   SymbolContext sc;
334   if (func_list.GetSize()) {
335     for (i = 0; i < func_list.GetSize(); i++) {
336       if (func_list.GetContextAtIndex(i, sc)) {
337         bool is_reexported = false;
338 
339         if (sc.block && sc.block->GetInlinedFunctionInfo()) {
340           if (!sc.block->GetStartAddress(break_addr))
341             break_addr.Clear();
342         } else if (sc.function) {
343           break_addr = sc.function->GetAddressRange().GetBaseAddress();
344           if (m_skip_prologue && break_addr.IsValid()) {
345             const uint32_t prologue_byte_size =
346                 sc.function->GetPrologueByteSize();
347             if (prologue_byte_size)
348               break_addr.SetOffset(break_addr.GetOffset() + prologue_byte_size);
349           }
350         } else if (sc.symbol) {
351           if (sc.symbol->GetType() == eSymbolTypeReExported) {
352             const Symbol *actual_symbol =
353                 sc.symbol->ResolveReExportedSymbol(m_breakpoint->GetTarget());
354             if (actual_symbol) {
355               is_reexported = true;
356               break_addr = actual_symbol->GetAddress();
357             }
358           } else {
359             break_addr = sc.symbol->GetAddress();
360           }
361 
362           if (m_skip_prologue && break_addr.IsValid()) {
363             const uint32_t prologue_byte_size =
364                 sc.symbol->GetPrologueByteSize();
365             if (prologue_byte_size)
366               break_addr.SetOffset(break_addr.GetOffset() + prologue_byte_size);
367           }
368         }
369 
370         if (break_addr.IsValid()) {
371           if (filter.AddressPasses(break_addr)) {
372             BreakpointLocationSP bp_loc_sp(
373                 AddLocation(break_addr, &new_location));
374             bp_loc_sp->SetIsReExported(is_reexported);
375             if (bp_loc_sp && new_location && !m_breakpoint->IsInternal()) {
376               if (log) {
377                 StreamString s;
378                 bp_loc_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
379                 log->Printf("Added location: %s\n", s.GetData());
380               }
381             }
382           }
383         }
384       }
385     }
386   }
387 
388   return Searcher::eCallbackReturnContinue;
389 }
390 
391 Searcher::Depth BreakpointResolverName::GetDepth() {
392   return Searcher::eDepthModule;
393 }
394 
395 void BreakpointResolverName::GetDescription(Stream *s) {
396   if (m_match_type == Breakpoint::Regexp)
397     s->Printf("regex = '%s'", m_regex.GetText());
398   else {
399     size_t num_names = m_lookups.size();
400     if (num_names == 1)
401       s->Printf("name = '%s'", m_lookups[0].GetName().GetCString());
402     else {
403       s->Printf("names = {");
404       for (size_t i = 0; i < num_names; i++) {
405         s->Printf("%s'%s'", (i == 0 ? "" : ", "),
406                   m_lookups[i].GetName().GetCString());
407       }
408       s->Printf("}");
409     }
410   }
411   if (m_language != eLanguageTypeUnknown) {
412     s->Printf(", language = %s", Language::GetNameForLanguageType(m_language));
413   }
414 }
415 
416 void BreakpointResolverName::Dump(Stream *s) const {}
417 
418 lldb::BreakpointResolverSP
419 BreakpointResolverName::CopyForBreakpoint(Breakpoint &breakpoint) {
420   lldb::BreakpointResolverSP ret_sp(new BreakpointResolverName(*this));
421   ret_sp->SetBreakpoint(&breakpoint);
422   return ret_sp;
423 }
424