ProcessTrace.cpp

Go to the documentation of this file.

//===-- ProcessTrace.cpp --------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
 
#include "lldb/Target/ProcessTrace.h"
 
#include <memory>
 
#include "lldb/Core/Module.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Core/Section.h"
#include "lldb/Target/SectionLoadList.h"
#include "lldb/Target/Target.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Log.h"
 
using namespace lldb;
using namespace lldb_private;
 
LLDB_PLUGIN_DEFINE(ProcessTrace)
 
llvm::StringRef ProcessTrace::GetPluginDescriptionStatic() {
  return "Trace process plug-in.";
}
 
void ProcessTrace::Terminate() {
  PluginManager::UnregisterPlugin(ProcessTrace::CreateInstance);
}
 
ProcessSP ProcessTrace::CreateInstance(TargetSP target_sp,
                                       ListenerSP listener_sp,
                                       const FileSpec *crash_file,
                                       bool can_connect) {
  if (can_connect)
    return nullptr;
  return std::make_shared<ProcessTrace>(target_sp, listener_sp,
                                        crash_file ? *crash_file : FileSpec());
}
 
bool ProcessTrace::CanDebug(TargetSP target_sp, bool plugin_specified_by_name) {
  return plugin_specified_by_name;
}
 
ProcessTrace::ProcessTrace(TargetSP target_sp, ListenerSP listener_sp,
                           const FileSpec &core_file)
    : PostMortemProcess(target_sp, listener_sp, core_file) {}
 
ProcessTrace::~ProcessTrace() {
  Clear();
  // We need to call finalize on the process before destroying ourselves to
  // make sure all of the broadcaster cleanup goes as planned. If we destruct
  // this class, then Process::~Process() might have problems trying to fully
  // destroy the broadcaster.
  Finalize(true /* destructing */);
}
 
void ProcessTrace::DidAttach(ArchSpec &process_arch) {
  ListenerSP listener_sp(
      Listener::MakeListener("lldb.process_trace.did_attach_listener"));
  HijackProcessEvents(listener_sp);
 
  SetCanJIT(false);
  StartPrivateStateThread(lldb::eStateStopped, false);
  if (!m_current_private_state_thread_sp) {
    LLDB_LOG(GetLog(LLDBLog::Process), "ProcessTrace: failed to start private "
                                       "state thread.");
    return;
  }
 
  // Pretend we stopped so we can show all of the threads
  // in the trace and explore the final state.
  SetPrivateState(lldb::eStateStopped);
 
  EventSP event_sp;
  WaitForProcessToStop(std::nullopt, &event_sp, true, listener_sp);
 
  RestoreProcessEvents();
 
  Process::DidAttach(process_arch);
}
 
bool ProcessTrace::DoUpdateThreadList(ThreadList &old_thread_list,
                                      ThreadList &new_thread_list) {
  return false;
}
 
void ProcessTrace::RefreshStateAfterStop() {}
 
Status ProcessTrace::DoDestroy() { return Status(); }
 
bool ProcessTrace::ShouldUseMemoryCache(const ProcessAddress &process_addr) {
  // The trace files are already a local copy of this memory.
  return false;
}
 
void ProcessTrace::Clear() { m_thread_list.Clear(); }
 
void ProcessTrace::Initialize() {
  PluginManager::RegisterPlugin(GetPluginNameStatic(),
                                GetPluginDescriptionStatic(), CreateInstance);
}
 
ArchSpec ProcessTrace::GetArchitecture() {
  return GetTarget().GetArchitecture();
}
 
bool ProcessTrace::GetProcessInfo(ProcessInstanceInfo &info) {
  info.Clear();
  info.SetProcessID(GetID());
  info.SetArchitecture(GetArchitecture());
  ModuleSP module_sp = GetTarget().GetExecutableModule();
  if (module_sp) {
    const bool add_exe_file_as_first_arg = false;
    info.SetExecutableFile(GetTarget().GetExecutableModule()->GetFileSpec(),
                           add_exe_file_as_first_arg);
  }
  return true;
}
 
size_t ProcessTrace::DoReadMemory(const ProcessAddress &process_addr, void *buf,
                                  size_t size, Status &error) {
  lldb::addr_t addr = process_addr.GetValue();
  Address resolved_address;
  GetTarget().ResolveLoadAddress(addr, resolved_address);
 
  return GetTarget().ReadMemoryFromFileCache(resolved_address, buf, size,
                                             error);
}