In order to provide simple scripting support on top of instruction traces, a simple solution is to enhance the `dump instructions` command and allow printing in json and directly to a file. The format is verbose and not space efficient, but it's not supposed to be used for really large traces, in which case the TraceCursor API is the way to go.
- add a -j option for printing the dump in json
- add a -J option for pretty printing the json output
- add a -F option for specifying an output file
- add a -a option for dumping all the instructions available starting at the initial point configured with the other flags
- add tests for all cases
- refactored the instruction dumper and abstracted the actual "printing" logic. There are two writer implementations: CLI and JSON. This made the dumper itself much more readable and maintanable
sample output:
```
(lldb) thread trace dump instructions -t -a --id 100 -J
[
{
"id": 100,
"tsc": "43591204528448966"
"loadAddress": "0x407a91",
"module": "a.out",
"symbol": "void std::deque<Foo, std::allocator<Foo>>::_M_push_back_aux<Foo>(Foo&&)",
"mnemonic": "movq",
"source": "/usr/include/c++/8/bits/deque.tcc",
"line": 492,
"column": 30
},
...
```
Differential Revision: https://reviews.llvm.org/D128316
133 lines
4.9 KiB
Python
133 lines
4.9 KiB
Python
import lldb
|
|
from intelpt_testcase import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
from lldbsuite.test.decorators import *
|
|
|
|
class TestTraceTimestampCounters(TraceIntelPTTestCaseBase):
|
|
|
|
@testSBAPIAndCommands
|
|
@skipIf(oslist=no_match(['linux']), archs=no_match(['i386', 'x86_64']))
|
|
def testTscPerThread(self):
|
|
self.expect("file " + os.path.join(self.getSourceDir(), "intelpt-trace", "a.out"))
|
|
self.expect("b main")
|
|
self.expect("r")
|
|
|
|
self.traceStartThread(enableTsc=True)
|
|
|
|
self.expect("n")
|
|
self.expect("thread trace dump instructions --tsc -c 1",
|
|
patterns=["0: \[tsc=\d+\] 0x0000000000400511 movl"])
|
|
|
|
@testSBAPIAndCommands
|
|
@skipIf(oslist=no_match(['linux']), archs=no_match(['i386', 'x86_64']))
|
|
def testMultipleTscsPerThread(self):
|
|
self.expect("file " + os.path.join(self.getSourceDir(), "intelpt-trace", "a.out"))
|
|
self.expect("b main")
|
|
self.expect("r")
|
|
|
|
self.traceStartThread(enableTsc=True)
|
|
|
|
# After each stop there'll be a new TSC
|
|
self.expect("n")
|
|
self.expect("n")
|
|
self.expect("n")
|
|
|
|
# We'll get the most recent instructions, with at least 3 different TSCs
|
|
self.runCmd("thread trace dump instructions --tsc --raw")
|
|
id_to_tsc = {}
|
|
for line in self.res.GetOutput().splitlines():
|
|
m = re.search(" (.+): \[tsc=(.+)\].*", line)
|
|
if m:
|
|
id_to_tsc[int(m.group(1))] = m.group(2)
|
|
self.assertEqual(len(id_to_tsc), 6)
|
|
|
|
# We check that the values are right when dumping a specific id
|
|
for id in range(0, 6):
|
|
self.expect(f"thread trace dump instructions --tsc --id {id} -c 1",
|
|
substrs=[f"{id}: [tsc={id_to_tsc[id]}]"])
|
|
|
|
@testSBAPIAndCommands
|
|
@skipIf(oslist=no_match(['linux']), archs=no_match(['i386', 'x86_64']))
|
|
def testTscPerProcess(self):
|
|
self.expect("file " + os.path.join(self.getSourceDir(), "intelpt-trace", "a.out"))
|
|
self.expect("b main")
|
|
self.expect("r")
|
|
|
|
self.traceStartProcess(enableTsc=True)
|
|
|
|
self.expect("n")
|
|
self.expect("thread trace dump instructions --tsc -c 1",
|
|
patterns=["0: \[tsc=\d+\] 0x0000000000400511 movl"])
|
|
|
|
self.expect("thread trace dump instructions --tsc -c 1 --pretty-json",
|
|
patterns=['''"tsc": "\d+"'''])
|
|
|
|
@testSBAPIAndCommands
|
|
@skipIf(oslist=no_match(['linux']), archs=no_match(['i386', 'x86_64']))
|
|
def testDumpingAfterTracingWithoutTsc(self):
|
|
self.expect("file " + os.path.join(self.getSourceDir(), "intelpt-trace", "a.out"))
|
|
self.expect("b main")
|
|
self.expect("r")
|
|
|
|
self.traceStartThread(enableTsc=False)
|
|
|
|
self.expect("n")
|
|
self.expect("thread trace dump instructions --tsc -c 1",
|
|
patterns=["0: \[tsc=unavailable\] 0x0000000000400511 movl"])
|
|
|
|
self.expect("thread trace dump instructions --tsc -c 1 --json",
|
|
patterns=['''"tsc":null'''])
|
|
|
|
@testSBAPIAndCommands
|
|
@skipIf(oslist=no_match(['linux']), archs=no_match(['i386', 'x86_64']))
|
|
def testPSBPeriod(self):
|
|
def isPSBSupported():
|
|
caps_file = "/sys/bus/event_source/devices/intel_pt/caps/psb_cyc"
|
|
if not os.path.exists(caps_file):
|
|
return False
|
|
with open(caps_file, "r") as f:
|
|
val = int(f.readline())
|
|
if val != 1:
|
|
return False
|
|
return True
|
|
|
|
def getValidPSBValues():
|
|
values_file = "/sys/bus/event_source/devices/intel_pt/caps/psb_periods"
|
|
values = []
|
|
with open(values_file, "r") as f:
|
|
mask = int(f.readline(), 16)
|
|
for i in range(0, 32):
|
|
if (1 << i) & mask:
|
|
values.append(i)
|
|
return values
|
|
|
|
|
|
if not isPSBSupported():
|
|
self.skipTest("PSB period unsupported")
|
|
|
|
valid_psb_values = getValidPSBValues()
|
|
# 0 should always be valid, and it's assumed by lldb-server
|
|
self.assertEqual(valid_psb_values[0], 0)
|
|
|
|
self.expect("file " + (os.path.join(self.getSourceDir(), "intelpt-trace", "a.out")))
|
|
self.expect("b main")
|
|
self.expect("r")
|
|
|
|
# it's enough to test with two valid values
|
|
for psb_period in (valid_psb_values[0], valid_psb_values[-1]):
|
|
# we first test at thread level
|
|
self.traceStartThread(psbPeriod=psb_period)
|
|
self.traceStopThread()
|
|
|
|
# we now test at process level
|
|
self.traceStartProcess(psbPeriod=psb_period)
|
|
self.traceStopProcess()
|
|
|
|
# we now test invalid values
|
|
self.traceStartThread(psbPeriod=valid_psb_values[-1] + 1, error=True,
|
|
substrs=["Invalid psb_period. Valid values are: 0"])
|
|
|
|
# TODO: dump the perf_event_attr.config as part of the upcoming "trace dump info"
|
|
# command and check that the psb period is included there.
|