bf9f21a28b
This adds a basic SB API for creating and stopping traces. Note: This doesn't add any APIs for inspecting individual instructions. That'd be a more complicated change and it might be better to enhande the dump functionality to output the data in binary format. I'll leave that for a later diff. This also enhances the existing tests so that they test the same flow using both the command interface and the SB API. I also did some cleanup of legacy code. Differential Revision: https://reviews.llvm.org/D103500
100 lines
3.7 KiB
Python
100 lines
3.7 KiB
Python
from lldbsuite.test.lldbtest import *
|
|
import os
|
|
import time
|
|
import json
|
|
|
|
ADDRESS_REGEX = '0x[0-9a-fA-F]*'
|
|
|
|
# Decorator that runs a test with both modes of USE_SB_API.
|
|
# It assumes that no tests can be executed in parallel.
|
|
def testSBAPIAndCommands(func):
|
|
def wrapper(*args, **kwargs):
|
|
TraceIntelPTTestCaseBase.USE_SB_API = True
|
|
func(*args, **kwargs)
|
|
TraceIntelPTTestCaseBase.USE_SB_API = False
|
|
func(*args, **kwargs)
|
|
return wrapper
|
|
|
|
# Class that should be used by all python Intel PT tests.
|
|
#
|
|
# It has a handy check that skips the test if the intel-pt plugin is not enabled.
|
|
#
|
|
# It also contains many functions that can test both the SB API or the command line version
|
|
# of the most important tracing actions.
|
|
class TraceIntelPTTestCaseBase(TestBase):
|
|
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
# If True, the trace test methods will use the SB API, otherwise they'll use raw commands.
|
|
USE_SB_API = False
|
|
|
|
def setUp(self):
|
|
TestBase.setUp(self)
|
|
if 'intel-pt' not in configuration.enabled_plugins:
|
|
self.skipTest("The intel-pt test plugin is not enabled")
|
|
|
|
def getTraceOrCreate(self):
|
|
if not self.target().GetTrace().IsValid():
|
|
error = lldb.SBError()
|
|
self.target().CreateTrace(error)
|
|
return self.target().GetTrace()
|
|
|
|
def assertSBError(self, sberror, error=False):
|
|
if error:
|
|
self.assertTrue(sberror.Fail())
|
|
else:
|
|
self.assertSuccess(sberror)
|
|
|
|
def createConfiguration(self, threadBufferSize=None, processBufferSizeLimit=None):
|
|
obj = {}
|
|
if processBufferSizeLimit is not None:
|
|
obj["processBufferSizeLimit"] = processBufferSizeLimit
|
|
if threadBufferSize is not None:
|
|
obj["threadBufferSize"] = threadBufferSize
|
|
|
|
configuration = lldb.SBStructuredData()
|
|
configuration.SetFromJSON(json.dumps(obj))
|
|
return configuration
|
|
|
|
def traceStartThread(self, thread=None, error=False, substrs=None, threadBufferSize=None):
|
|
if self.USE_SB_API:
|
|
trace = self.getTraceOrCreate()
|
|
thread = thread if thread is not None else self.thread()
|
|
configuration = self.createConfiguration(threadBufferSize=threadBufferSize)
|
|
self.assertSBError(trace.Start(thread, configuration), error)
|
|
else:
|
|
command = "thread trace start"
|
|
if thread is not None:
|
|
command += " " + str(thread.GetIndexID())
|
|
if threadBufferSize is not None:
|
|
command += " -s " + str(threadBufferSize)
|
|
self.expect(command, error=error, substrs=substrs)
|
|
|
|
def traceStartProcess(self, processBufferSizeLimit=None, error=False, substrs=None):
|
|
if self.USE_SB_API:
|
|
trace = self.getTraceOrCreate()
|
|
configuration = self.createConfiguration(processBufferSizeLimit=processBufferSizeLimit)
|
|
self.assertSBError(trace.Start(configuration), error=error)
|
|
else:
|
|
command = "process trace start"
|
|
if processBufferSizeLimit != None:
|
|
command += " -l " + str(processBufferSizeLimit)
|
|
self.expect(command, error=error, substrs=substrs)
|
|
|
|
def traceStopProcess(self):
|
|
if self.USE_SB_API:
|
|
self.assertSuccess(self.target().GetTrace().Stop())
|
|
else:
|
|
self.expect("process trace stop")
|
|
|
|
def traceStopThread(self, thread=None, error=False):
|
|
if self.USE_SB_API:
|
|
thread = thread if thread is not None else self.thread()
|
|
self.assertSBError(self.target().GetTrace().Stop(thread), error)
|
|
|
|
else:
|
|
command = "thread trace stop"
|
|
if thread is not None:
|
|
command += " " + str(thread.GetIndexID())
|
|
self.expect(command, error=error)
|