LLDB mainline
BreakpointResolverScripted.cpp
Go to the documentation of this file.
1//===-- BreakpointResolverScripted.cpp ------------------------------------===//
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
10
11
13#include "lldb/Core/Debugger.h"
14#include "lldb/Core/Module.h"
15#include "lldb/Core/Section.h"
19#include "lldb/Target/Process.h"
20#include "lldb/Target/Target.h"
21#include "lldb/Utility/Log.h"
23
24using namespace lldb;
25using namespace lldb_private;
26
27// BreakpointResolverScripted:
29 const BreakpointSP &bkpt, const llvm::StringRef class_name,
30 lldb::SearchDepth depth, const StructuredDataImpl &args_data)
31 : BreakpointResolver(bkpt, BreakpointResolver::PythonResolver),
32 m_class_name(std::string(class_name)), m_depth(depth), m_args(args_data) {
33 CreateImplementationIfNeeded(bkpt);
34}
35
37 BreakpointSP breakpoint_sp) {
39 return;
40
41 if (m_class_name.empty())
42 return;
43
44 if (!breakpoint_sp)
45 return;
46
47 TargetSP target_sp = breakpoint_sp->GetTargetSP();
48 ScriptInterpreter *script_interp = target_sp->GetDebugger()
49 .GetScriptInterpreter();
50 if (!script_interp)
51 return;
52
54 m_class_name.c_str(), m_args, breakpoint_sp);
55}
56
59}
60
63 const BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict,
64 Status &error) {
65 llvm::StringRef class_name;
66 bool success;
67
68 success = options_dict.GetValueForKeyAsString(
70 if (!success) {
71 error.SetErrorString("BRFL::CFSD: Couldn't find class name entry.");
72 return nullptr;
73 }
74 // The Python function will actually provide the search depth, this is a
75 // placeholder.
77
78 StructuredDataImpl args_data_impl;
79 StructuredData::Dictionary *args_dict = nullptr;
81 args_dict))
82 args_data_impl.SetObjectSP(args_dict->shared_from_this());
83 return new BreakpointResolverScripted(bkpt, class_name, depth,
84 args_data_impl);
85}
86
89 StructuredData::DictionarySP options_dict_sp(
91
92 options_dict_sp->AddStringItem(GetKey(OptionNames::PythonClassName),
94 if (m_args.IsValid())
95 options_dict_sp->AddItem(GetKey(OptionNames::ScriptArgs),
97
98 return WrapOptionsDict(options_dict_sp);
99}
100
102 return GetBreakpoint()->GetTarget().GetDebugger().GetScriptInterpreter();
103}
104
106 SearchFilter &filter, SymbolContext &context, Address *addr) {
107 bool should_continue = true;
110
112 should_continue = interp->ScriptedBreakpointResolverSearchCallback(
114 &context);
115 if (should_continue)
117
119}
120
128 }
129 return depth;
130}
131
133 StructuredData::GenericSP generic_sp;
134 std::string short_help;
135
139 short_help);
140 }
141 if (!short_help.empty())
142 s->PutCString(short_help.c_str());
143 else
144 s->Printf("python class = %s", m_class_name.c_str());
145}
146
148
149lldb::BreakpointResolverSP
151 return std::make_shared<BreakpointResolverScripted>(breakpoint, m_class_name,
152 m_depth, m_args);
153}
static llvm::raw_ostream & error(Stream &strm)
A section + offset based address class.
Definition: Address.h:59
"lldb/Breakpoint/BreakpointResolverScripted.h" This class sets breakpoints on a given Address.
lldb::BreakpointResolverSP CopyForBreakpoint(lldb::BreakpointSP &breakpoint) override
void GetDescription(Stream *s) override
Prints a canonical description for the breakpoint to the stream s.
StructuredData::ObjectSP SerializeToStructuredData() override
void Dump(Stream *s) const override
Standard "Dump" method. At present it does nothing.
Searcher::CallbackReturn SearchCallback(SearchFilter &filter, SymbolContext &context, Address *addr) override
void CreateImplementationIfNeeded(lldb::BreakpointSP bkpt)
BreakpointResolverScripted(const lldb::BreakpointSP &bkpt, const llvm::StringRef class_name, lldb::SearchDepth depth, const StructuredDataImpl &args_data)
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
General Outline: The BreakpointResolver is a Searcher.
static const char * GetKey(OptionNames enum_value)
StructuredData::DictionarySP WrapOptionsDict(StructuredData::DictionarySP options_dict_sp)
lldb::BreakpointSP GetBreakpoint() const
This gets the breakpoint for this resolver.
virtual bool ScriptedBreakpointResolverSearchCallback(StructuredData::GenericSP implementor_sp, SymbolContext *sym_ctx)
virtual lldb::SearchDepth ScriptedBreakpointResolverSearchDepth(StructuredData::GenericSP implementor_sp)
virtual bool GetShortHelpForCommandObject(StructuredData::GenericSP cmd_obj_sp, std::string &dest)
virtual StructuredData::GenericSP CreateScriptedBreakpointResolver(const char *class_name, const StructuredDataImpl &args_data, lldb::BreakpointSP &bkpt_sp)
General Outline: Provides the callback and search depth for the SearchFilter search.
Definition: SearchFilter.h:83
An error handling class.
Definition: Status.h:44
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:63
void SetObjectSP(const StructuredData::ObjectSP &obj)
StructuredData::ObjectSP GetObjectSP()
bool GetValueForKeyAsString(llvm::StringRef key, llvm::StringRef &result) const
bool GetValueForKeyAsDictionary(llvm::StringRef key, Dictionary *&result) const
std::shared_ptr< Generic > GenericSP
std::shared_ptr< Dictionary > DictionarySP
std::shared_ptr< Object > ObjectSP
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:33
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
@ eSearchDepthTarget
@ eSearchDepthModule