#include <TraceIntelPTBundleLoader.h>

Classes
struct	ParsedProcess
	Helper struct holding the objects created when parsing a process. More...

Public Member Functions
	TraceIntelPTBundleLoader (Debugger &debugger, const llvm::json::Value &bundle_description, llvm::StringRef bundle_dir)

llvm::Expected< lldb::TraceSP >	Load ()
	Parse the trace bundle description and create the corresponding Target objects.

Static Public Member Functions
static llvm::StringRef	GetSchema ()

Private Member Functions
FileSpec	NormalizePath (const std::string &path)
	Resolve non-absolute paths relative to the bundle folder.

lldb::ThreadPostMortemTraceSP	ParseThread (Process &process, const JSONThread &thread)
	Create a post-mortem thread associated with the given `process` using the definition from `thread`.

llvm::Expected< lldb::TraceSP >	CreateTraceIntelPTInstance (JSONTraceBundleDescription &bundle_description, std::vector< ParsedProcess > &parsed_processes)
	Given a bundle description and a list of fully parsed processes, create an actual Trace instance that "traces" these processes.

llvm::Expected< ParsedProcess >	CreateEmptyProcess (lldb::pid_t pid, llvm::StringRef triple)
	Create an empty Process object with given pid and target.

llvm::Expected< ParsedProcess >	ParseProcess (const JSONProcess &process)
	Create the corresponding Threads and Process objects given the JSON process definition.

llvm::Error	ParseModule (Target &target, const JSONModule &module)
	Create a module associated with the given `target` using the definition from `module`.

llvm::Expected< ParsedProcess >	ParseKernel (const JSONTraceBundleDescription &bundle_description)
	Create a kernel process and cpu threads given the JSON kernel definition.

llvm::Error	CreateJSONError (llvm::json::Path::Root &root, const llvm::json::Value &value)
	Create a user-friendly error message upon a JSON-parsing failure using the json::ObjectMapper functionality.

llvm::Expected< std::vector< ParsedProcess > >	LoadBundle (const JSONTraceBundleDescription &bundle_description)
	Create the corresponding Process, Thread and Module objects given this bundle description.

llvm::Error	AugmentThreadsFromContextSwitches (JSONTraceBundleDescription &bundle_description)
	When applicable, augment the list of threads in the trace bundle by inspecting the context switch trace.

void	NormalizeAllPaths (JSONTraceBundleDescription &bundle_description)
	Modifiy the bundle description by normalizing all the paths relative to the session file directory.

Private Attributes
Debugger &	m_debugger

const llvm::json::Value &	m_bundle_description

const std::string	m_bundle_dir

Detailed Description

Definition at line 20 of file TraceIntelPTBundleLoader.h.

Constructor & Destructor Documentation

◆ TraceIntelPTBundleLoader()

lldb_private::trace_intel_pt::TraceIntelPTBundleLoader::TraceIntelPTBundleLoader	(	Debugger &	debugger,
		const llvm::json::Value &	bundle_description,
		llvm::StringRef	bundle_dir
	)

inline

Parameters

[in]	debugger	The debugger that will own the targets to create.
[in]	bundle_description	The JSON description of a trace bundle that follows the schema of the intel pt trace plug-in.
[in]	bundle_dir	The folder where the trace bundle is located.

Definition at line 37 of file TraceIntelPTBundleLoader.h.

Member Function Documentation

◆ AugmentThreadsFromContextSwitches()

Error TraceIntelPTBundleLoader::AugmentThreadsFromContextSwitches ( JSONTraceBundleDescription & bundle_description )

private

When applicable, augment the list of threads in the trace bundle by inspecting the context switch trace.

This only applies for threads of processes already specified in this bundle description.

Returns: An llvm::Error in case if failures, or llvm::Error::success otherwise.

Definition at line 321 of file TraceIntelPTBundleLoader.cpp.

References lldb_private::trace_intel_pt::JSONCpu::context_switch_trace, lldb_private::trace_intel_pt::JSONTraceBundleDescription::cpus, lldb_private::Trace::OnDataFileRead(), lldb_private::trace_intel_pt::JSONProcess::pid, lldb_private::trace_intel_pt::JSONTraceBundleDescription::processes, lldb_private::trace_intel_pt::JSONProcess::threads, lldb_private::trace_intel_pt::JSONThread::tid, and lldb_private::trace_intel_pt::JSONTraceBundleDescription::tsc_perf_zero_conversion.

Referenced by Load().

◆ CreateEmptyProcess()

Expected< TraceIntelPTBundleLoader::ParsedProcess > TraceIntelPTBundleLoader::CreateEmptyProcess	(	lldb::pid_t	pid,
		llvm::StringRef	triple
	)

private

Create an empty Process object with given pid and target.

Definition at line 93 of file TraceIntelPTBundleLoader.cpp.

References lldb_private::TargetList::CreateTarget(), lldb_private::eLoadDependentsNo, error(), lldb_private::Debugger::GetTargetList(), m_debugger, and lldb_private::trace_intel_pt::TraceIntelPTBundleLoader::ParsedProcess::target_sp.

Referenced by ParseKernel(), and ParseProcess().

◆ CreateJSONError()

Error TraceIntelPTBundleLoader::CreateJSONError	(	llvm::json::Path::Root &	root,
		const llvm::json::Value &	value
	)

private

Create a user-friendly error message upon a JSON-parsing failure using the json::ObjectMapper functionality.

Parameters

[in]	root	The llvm::json::Path::Root used to parse the JSON value.
[in]	value	The json value that failed to parse.

Returns: An llvm::Error containing the user-friendly error message.

Definition at line 67 of file TraceIntelPTBundleLoader.cpp.

References GetSchema(), and lldb_private::toString().

Referenced by Load().

◆ CreateTraceIntelPTInstance()

Expected< TraceSP > TraceIntelPTBundleLoader::CreateTraceIntelPTInstance	(	JSONTraceBundleDescription &	bundle_description,
		std::vector< ParsedProcess > &	parsed_processes
	)

private

Given a bundle description and a list of fully parsed processes, create an actual Trace instance that "traces" these processes.

Definition at line 369 of file TraceIntelPTBundleLoader.cpp.

References lldb_private::trace_intel_pt::TraceIntelPT::CreateInstanceForPostmortemTrace(), lldb_private::trace_intel_pt::JSONTraceBundleDescription::kernel, lldb_private::trace_intel_pt::TraceIntelPT::KernelMode, and lldb_private::trace_intel_pt::TraceIntelPT::UserMode.

Referenced by Load().

◆ GetSchema()

StringRef TraceIntelPTBundleLoader::GetSchema ( )

static

Returns: The JSON schema for the bundle description.

Definition at line 228 of file TraceIntelPTBundleLoader.cpp.

Referenced by CreateJSONError(), lldb_private::trace_intel_pt::TraceIntelPT::GetSchema(), and lldb_private::trace_intel_pt::TraceIntelPT::Initialize().

◆ Load()

Expected< TraceSP > TraceIntelPTBundleLoader::Load ( )

Parse the trace bundle description and create the corresponding Target objects.

In case of an error, no targets are created.

Returns: A lldb::TraceSP instance created according to the trace bundle information. In case of errors, return a null pointer.

Definition at line 420 of file TraceIntelPTBundleLoader.cpp.

References AugmentThreadsFromContextSwitches(), CreateJSONError(), CreateTraceIntelPTInstance(), lldb_private::trace_intel_pt::fromJSON(), LoadBundle(), m_bundle_description, and NormalizeAllPaths().

◆ LoadBundle()

Expected< std::vector< TraceIntelPTBundleLoader::ParsedProcess > > TraceIntelPTBundleLoader::LoadBundle ( const JSONTraceBundleDescription & bundle_description )

private

Create the corresponding Process, Thread and Module objects given this bundle description.

Definition at line 197 of file TraceIntelPTBundleLoader.cpp.

References lldb_private::TargetList::DeleteTarget(), lldb_private::Debugger::GetTargetList(), lldb_private::trace_intel_pt::JSONTraceBundleDescription::kernel, m_debugger, ParseKernel(), ParseProcess(), and lldb_private::trace_intel_pt::JSONTraceBundleDescription::processes.

Referenced by Load().