602497d672
added new command "process trace save -d <directory>". -it saves a JSON file as <directory>/trace.json, with the main properties of the trace session. -it saves binary Intel-pt trace as <directory>/thread_id.trace; each file saves each thread. -it saves modules to the directory <directory>/modules . -it only works for live process and it only support Intel-pt right now. Example: ``` b main run process trace start n process trace save -d /tmp/mytrace ``` A file named trace.json and xxx.trace should be generated in /tmp/mytrace. To load the trace that was just saved: ``` trace load /tmp/mytrace thread trace dump instructions ``` You should see the instructions of the trace got printed. To run a test: ``` cd ~/llvm-sand/build/Release/fbcode-x86_64/toolchain ninja lldb-dotest ./bin/lldb-dotest -p TestTraceSave ``` Reviewed By: wallace Differential Revision: https://reviews.llvm.org/D107669
113 lines
4.3 KiB
C++
113 lines
4.3 KiB
C++
//===-- SessionSaver.h ----------------------------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_TARGET_TRACESESSIONSAVER_H
|
|
#define LLDB_TARGET_TRACESESSIONSAVER_H
|
|
|
|
#include "TraceJSONStructs.h"
|
|
|
|
namespace lldb_private {
|
|
|
|
class TraceSessionSaver {
|
|
|
|
public:
|
|
/// Save the trace session description JSON object inside the given directory
|
|
/// as a file named \a trace.json.
|
|
///
|
|
/// \param[in] trace_session_description
|
|
/// The trace's session, as JSON Object.
|
|
///
|
|
/// \param[in] directory
|
|
/// The directory where the JSON file will be saved.
|
|
///
|
|
/// \return
|
|
/// \a llvm::success if the operation was successful, or an \a llvm::Error
|
|
/// otherwise.
|
|
static llvm::Error
|
|
WriteSessionToFile(const llvm::json::Value &trace_session_description,
|
|
FileSpec directory);
|
|
|
|
/// Build the processes section of the trace session description file. Besides
|
|
/// returning the processes information, this method saves to disk all modules
|
|
/// and raw traces corresponding to the traced threads of the given process.
|
|
///
|
|
/// \param[in] live_process
|
|
/// The process being traced.
|
|
///
|
|
/// \param[in] raw_trace_fetcher
|
|
/// Callback function that receives a thread ID and returns its raw trace.
|
|
/// This callback should return \a None if the thread is not being traced.
|
|
/// Otherwise, it should return the raw trace in bytes or an
|
|
/// \a llvm::Error in case of failures.
|
|
///
|
|
/// \param[in] directory
|
|
/// The directory where files will be saved when building the processes
|
|
/// section.
|
|
///
|
|
/// \return
|
|
/// The processes section or \a llvm::Error in case of failures.
|
|
static llvm::Expected<JSONTraceSessionBase> BuildProcessesSection(
|
|
Process &live_process,
|
|
std::function<
|
|
llvm::Expected<llvm::Optional<std::vector<uint8_t>>>(lldb::tid_t tid)>
|
|
raw_trace_fetcher,
|
|
FileSpec directory);
|
|
|
|
/// Build the threads sub-section of the trace session description file.
|
|
/// For each traced thread, its raw trace is also written to the file
|
|
/// \a thread_id_.trace inside of the given directory.
|
|
///
|
|
/// \param[in] live_process
|
|
/// The process being traced.
|
|
///
|
|
/// \param[in] raw_trace_fetcher
|
|
/// Callback function that receives a thread ID and returns its raw trace.
|
|
/// This callback should return \a None if the thread is not being traced.
|
|
/// Otherwise, it should return the raw trace in bytes or an
|
|
/// \a llvm::Error in case of failures.
|
|
///
|
|
/// \param[in] directory
|
|
/// The directory where files will be saved when building the threads
|
|
/// section.
|
|
///
|
|
/// \return
|
|
/// The threads section or \a llvm::Error in case of failures.
|
|
static llvm::Expected<std::vector<JSONThread>> BuildThreadsSection(
|
|
Process &live_process,
|
|
std::function<
|
|
llvm::Expected<llvm::Optional<std::vector<uint8_t>>>(lldb::tid_t tid)>
|
|
raw_trace_fetcher,
|
|
FileSpec directory);
|
|
|
|
/// Build modules sub-section of the trace's session. The original modules
|
|
/// will be copied over to the \a <directory/modules> folder. Invalid modules
|
|
/// are skipped.
|
|
/// Copying the modules has the benefit of making these trace session
|
|
/// directories self-contained, as the raw traces and modules are part of the
|
|
/// output directory and can be sent to another machine, where lldb can load
|
|
/// them and replicate exactly the same trace session.
|
|
///
|
|
/// \param[in] live_process
|
|
/// The process being traced.
|
|
///
|
|
/// \param[in] directory
|
|
/// The directory where the modules files will be saved when building
|
|
/// the modules section.
|
|
/// Example: If a module \a libbar.so exists in the path
|
|
/// \a /usr/lib/foo/libbar.so, then it will be copied to
|
|
/// \a <directory>/modules/usr/lib/foo/libbar.so.
|
|
///
|
|
/// \return
|
|
/// The modules section or \a llvm::Error in case of failures.
|
|
static llvm::Expected<std::vector<JSONModule>>
|
|
BuildModulesSection(Process &live_process, FileSpec directory);
|
|
};
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_TARGET_TRACESESSIONSAVER_H
|