7406d236d8
This starts to fix the other half of the lifetime problems in this code -- dangling references. SB objects created on the stack will go away when the function returns, which is a problem if the python code they were meant for stashes a reference to them somewhere. Most of the time this goes by unnoticed, as the code rarely has a reason to store these, but in case it does, we shouldn't respond by crashing. This patch fixes the management for a couple of SB objects (Debugger, Frame, Thread). The SB objects are now created on the heap, and their ownership is immediately passed on to SWIG, which will ensure they are destroyed when the last python reference goes away. I will handle the other objects in separate patches. I include one test which demonstrates the lifetime issue for SBDebugger. Strictly speaking, one should create a test case for each of these objects and each of the contexts they are being used. That would require figuring out how to persist (and later access) each of these objects. Some of those may involve a lot of hoop-jumping (we can run python code from within a frame-format string). I don't think that is necessary/worth it since the new wrapper functions make it very hard to get this wrong. Differential Revision: https://reviews.llvm.org/D115925
174 lines
6.7 KiB
Python
174 lines
6.7 KiB
Python
"""
|
|
Test lldb Python commands.
|
|
"""
|
|
|
|
|
|
import sys
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
|
|
|
|
class CmdPythonTestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
def test(self):
|
|
self.build()
|
|
self.pycmd_tests()
|
|
|
|
def pycmd_tests(self):
|
|
self.runCmd("command source py_import")
|
|
|
|
# Test a bunch of different kinds of python callables with
|
|
# both 4 and 5 positional arguments.
|
|
self.expect("foobar", substrs=["All good"])
|
|
self.expect("foobar4", substrs=["All good"])
|
|
self.expect("vfoobar", substrs=["All good"])
|
|
self.expect("v5foobar", substrs=["All good"])
|
|
self.expect("sfoobar", substrs=["All good"])
|
|
self.expect("cfoobar", substrs=["All good"])
|
|
self.expect("ifoobar", substrs=["All good"])
|
|
self.expect("sfoobar4", substrs=["All good"])
|
|
self.expect("cfoobar4", substrs=["All good"])
|
|
self.expect("ifoobar4", substrs=["All good"])
|
|
self.expect("ofoobar", substrs=["All good"])
|
|
self.expect("ofoobar4", substrs=["All good"])
|
|
|
|
# Verify command that specifies eCommandRequiresTarget returns failure
|
|
# without a target.
|
|
self.expect('targetname',
|
|
substrs=['a.out'], matching=False, error=True)
|
|
|
|
exe = self.getBuildArtifact("a.out")
|
|
self.expect("file " + exe,
|
|
patterns=["Current executable set to .*a.out"])
|
|
|
|
self.expect('targetname',
|
|
substrs=['a.out'], matching=True, error=False)
|
|
|
|
# This is the function to remove the custom commands in order to have a
|
|
# clean slate for the next test case.
|
|
def cleanup():
|
|
self.runCmd('command script delete welcome', check=False)
|
|
self.runCmd('command script delete targetname', check=False)
|
|
self.runCmd('command script delete longwait', check=False)
|
|
self.runCmd('command script delete mysto', check=False)
|
|
self.runCmd('command script delete tell_sync', check=False)
|
|
self.runCmd('command script delete tell_async', check=False)
|
|
self.runCmd('command script delete tell_curr', check=False)
|
|
self.runCmd('command script delete bug11569', check=False)
|
|
self.runCmd('command script delete takes_exe_ctx', check=False)
|
|
self.runCmd('command script delete decorated', check=False)
|
|
|
|
# Execute the cleanup function during test case tear down.
|
|
self.addTearDownHook(cleanup)
|
|
|
|
# Interact with debugger in synchronous mode
|
|
self.setAsync(False)
|
|
|
|
# We don't want to display the stdout if not in TraceOn() mode.
|
|
if not self.TraceOn():
|
|
self.HideStdout()
|
|
|
|
self.expect('welcome Enrico',
|
|
substrs=['Hello Enrico, welcome to LLDB'])
|
|
|
|
self.expect("help welcome",
|
|
substrs=['Just a docstring for welcome_impl',
|
|
'A command that says hello to LLDB users'])
|
|
|
|
decorated_commands = ["decorated" + str(n) for n in range(1, 5)]
|
|
for name in decorated_commands:
|
|
self.expect(name, substrs=["hello from " + name])
|
|
self.expect("help " + name,
|
|
substrs=["Python command defined by @lldb.command"])
|
|
|
|
self.expect("help",
|
|
substrs=['For more information run']
|
|
+ decorated_commands + ['welcome'])
|
|
|
|
self.expect("help -a",
|
|
substrs=['For more information run']
|
|
+ decorated_commands + ['welcome'])
|
|
|
|
self.expect("help -u", matching=False,
|
|
substrs=['For more information run'])
|
|
|
|
self.runCmd("command script delete welcome")
|
|
|
|
self.expect('welcome Enrico', matching=False, error=True,
|
|
substrs=['Hello Enrico, welcome to LLDB'])
|
|
|
|
self.expect('targetname fail', error=True,
|
|
substrs=['a test for error in command'])
|
|
|
|
self.expect('command script list',
|
|
substrs=['targetname',
|
|
'For more information run'])
|
|
|
|
self.expect("help targetname",
|
|
substrs=['Expects', '\'raw\'', 'input',
|
|
'help', 'raw-input'])
|
|
|
|
self.expect("longwait",
|
|
substrs=['Done; if you saw the delays I am doing OK'])
|
|
|
|
self.runCmd("b main")
|
|
self.runCmd("run")
|
|
self.runCmd("mysto 3")
|
|
self.expect("frame variable array",
|
|
substrs=['[0] = 79630', '[1] = 388785018', '[2] = 0'])
|
|
self.runCmd("mysto 3")
|
|
self.expect("frame variable array",
|
|
substrs=['[0] = 79630', '[4] = 388785018', '[5] = 0'])
|
|
|
|
# we cannot use the stepover command to check for async execution mode since LLDB
|
|
# seems to get confused when events start to queue up
|
|
self.expect("tell_sync",
|
|
substrs=['running sync'])
|
|
self.expect("tell_async",
|
|
substrs=['running async'])
|
|
self.expect("tell_curr",
|
|
substrs=['I am running sync'])
|
|
|
|
# check that the execution context is passed in to commands that ask for it
|
|
self.expect("takes_exe_ctx", substrs=["a.out"])
|
|
|
|
# Test that a python command can redefine itself
|
|
self.expect('command script add -f foobar welcome -h "just some help"')
|
|
|
|
self.runCmd("command script clear")
|
|
|
|
# Test that re-defining an existing command works
|
|
self.runCmd(
|
|
'command script add my_command --class welcome.WelcomeCommand')
|
|
self.expect('my_command Blah', substrs=['Hello Blah, welcome to LLDB'])
|
|
|
|
self.runCmd(
|
|
'command script add my_command -o --class welcome.TargetnameCommand')
|
|
self.expect('my_command', substrs=['a.out'])
|
|
|
|
self.runCmd("command script clear")
|
|
|
|
self.expect('command script list', matching=False,
|
|
substrs=['targetname',
|
|
'longwait'])
|
|
|
|
self.expect('command script add -f foobar frame', error=True,
|
|
substrs=['cannot add command'])
|
|
|
|
# http://llvm.org/bugs/show_bug.cgi?id=11569
|
|
# LLDBSwigPythonCallCommand crashes when a command script returns an
|
|
# object
|
|
self.runCmd('command script add -f bug11569 bug11569')
|
|
# This should not crash.
|
|
self.runCmd('bug11569', check=False)
|
|
|
|
def test_persistence(self):
|
|
self.runCmd("command script import persistence.py")
|
|
self.runCmd("command script add -f persistence.save_debugger save_debugger")
|
|
self.expect("save_debugger", substrs=[str(self.dbg)])
|
|
self.expect("script str(persistence.debugger_copy)", substrs=[str(self.dbg)])
|