mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-26 09:16:08 +00:00
738af7a624
For example, it is pretty easy to write a breakpoint command that implements "stop when my caller is Foo", and
it is pretty easy to write a breakpoint command that implements "stop when my caller is Bar". But there's no
way to write a generic "stop when my caller is..." function, and then specify the caller when you add the
command to a breakpoint.
With this patch, you can pass this data in a SBStructuredData dictionary. That will get stored in
the PythonCommandBaton for the breakpoint, and passed to the implementation function (if it has the right
signature) when the breakpoint is hit. Then in lldb, you can say:
(lldb) break com add -F caller_is -k caller_name -v Foo
More generally this will allow us to write reusable Python breakpoint commands.
Differential Revision: https://reviews.llvm.org/D68671
140 lines
3.7 KiB
C++
140 lines
3.7 KiB
C++
//===-- SWIG Interface for SBBreakpointLocation -----------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"Represents one unique instance (by address) of a logical breakpoint.
|
|
|
|
A breakpoint location is defined by the breakpoint that produces it,
|
|
and the address that resulted in this particular instantiation.
|
|
Each breakpoint location has its settable options.
|
|
|
|
SBBreakpoint contains SBBreakpointLocation(s). See docstring of SBBreakpoint
|
|
for retrieval of an SBBreakpointLocation from an SBBreakpoint."
|
|
) SBBreakpointLocation;
|
|
class SBBreakpointLocation
|
|
{
|
|
public:
|
|
|
|
SBBreakpointLocation ();
|
|
|
|
SBBreakpointLocation (const lldb::SBBreakpointLocation &rhs);
|
|
|
|
~SBBreakpointLocation ();
|
|
|
|
break_id_t
|
|
GetID ();
|
|
|
|
bool
|
|
IsValid() const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
lldb::SBAddress
|
|
GetAddress();
|
|
|
|
lldb::addr_t
|
|
GetLoadAddress ();
|
|
|
|
void
|
|
SetEnabled(bool enabled);
|
|
|
|
bool
|
|
IsEnabled ();
|
|
|
|
uint32_t
|
|
GetHitCount ();
|
|
|
|
uint32_t
|
|
GetIgnoreCount ();
|
|
|
|
void
|
|
SetIgnoreCount (uint32_t n);
|
|
|
|
%feature("docstring", "
|
|
The breakpoint location stops only if the condition expression evaluates
|
|
to true.") SetCondition;
|
|
void
|
|
SetCondition (const char *condition);
|
|
|
|
%feature("docstring", "
|
|
Get the condition expression for the breakpoint location.") GetCondition;
|
|
const char *
|
|
GetCondition ();
|
|
|
|
bool GetAutoContinue();
|
|
|
|
void SetAutoContinue(bool auto_continue);
|
|
|
|
%feature("docstring", "
|
|
Set the callback to the given Python function name.
|
|
The function takes three arguments (frame, bp_loc, dict).") SetScriptCallbackFunction;
|
|
void
|
|
SetScriptCallbackFunction (const char *callback_function_name);
|
|
|
|
%feature("docstring", "
|
|
Set the name of the script function to be called when the breakpoint is hit.
|
|
To use this variant, the function should take (frame, bp_loc, extra_args, dict) and
|
|
when the breakpoint is hit the extra_args will be passed to the callback function.") SetScriptCallbackFunction;
|
|
SBError
|
|
SetScriptCallbackFunction (const char *callback_function_name,
|
|
SBStructuredData &extra_args);
|
|
|
|
%feature("docstring", "
|
|
Provide the body for the script function to be called when the breakpoint location is hit.
|
|
The body will be wrapped in a function, which be passed two arguments:
|
|
'frame' - which holds the bottom-most SBFrame of the thread that hit the breakpoint
|
|
'bpno' - which is the SBBreakpointLocation to which the callback was attached.
|
|
|
|
The error parameter is currently ignored, but will at some point hold the Python
|
|
compilation diagnostics.
|
|
Returns true if the body compiles successfully, false if not.") SetScriptCallbackBody;
|
|
SBError
|
|
SetScriptCallbackBody (const char *script_body_text);
|
|
|
|
void SetCommandLineCommands(SBStringList &commands);
|
|
|
|
bool GetCommandLineCommands(SBStringList &commands);
|
|
|
|
void
|
|
SetThreadID (lldb::tid_t sb_thread_id);
|
|
|
|
lldb::tid_t
|
|
GetThreadID ();
|
|
|
|
void
|
|
SetThreadIndex (uint32_t index);
|
|
|
|
uint32_t
|
|
GetThreadIndex() const;
|
|
|
|
void
|
|
SetThreadName (const char *thread_name);
|
|
|
|
const char *
|
|
GetThreadName () const;
|
|
|
|
void
|
|
SetQueueName (const char *queue_name);
|
|
|
|
const char *
|
|
GetQueueName () const;
|
|
|
|
bool
|
|
IsResolved ();
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description, DescriptionLevel level);
|
|
|
|
SBBreakpoint
|
|
GetBreakpoint ();
|
|
};
|
|
|
|
} // namespace lldb
|