1 //===-- ProcessTrace.cpp --------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Target/ProcessTrace.h"
10 
11 #include <memory>
12 
13 #include "lldb/Core/Module.h"
14 #include "lldb/Core/PluginManager.h"
15 #include "lldb/Core/Section.h"
16 #include "lldb/Target/ABI.h"
17 #include "lldb/Target/SectionLoadList.h"
18 #include "lldb/Target/Target.h"
19 
20 using namespace lldb;
21 using namespace lldb_private;
22 
23 LLDB_PLUGIN_DEFINE(ProcessTrace)
24 
25 llvm::StringRef ProcessTrace::GetPluginDescriptionStatic() {
26   return "Trace process plug-in.";
27 }
28 
29 void ProcessTrace::Terminate() {
30   PluginManager::UnregisterPlugin(ProcessTrace::CreateInstance);
31 }
32 
33 ProcessSP ProcessTrace::CreateInstance(TargetSP target_sp,
34                                        ListenerSP listener_sp,
35                                        const FileSpec *crash_file,
36                                        bool can_connect) {
37   if (can_connect)
38     return nullptr;
39   return std::make_shared<ProcessTrace>(target_sp, listener_sp);
40 }
41 
42 bool ProcessTrace::CanDebug(TargetSP target_sp, bool plugin_specified_by_name) {
43   return plugin_specified_by_name;
44 }
45 
46 ProcessTrace::ProcessTrace(TargetSP target_sp, ListenerSP listener_sp)
47     : PostMortemProcess(target_sp, listener_sp) {}
48 
49 ProcessTrace::~ProcessTrace() {
50   Clear();
51   // We need to call finalize on the process before destroying ourselves to
52   // make sure all of the broadcaster cleanup goes as planned. If we destruct
53   // this class, then Process::~Process() might have problems trying to fully
54   // destroy the broadcaster.
55   Finalize(true /* destructing */);
56 }
57 
58 void ProcessTrace::DidAttach(ArchSpec &process_arch) {
59   ListenerSP listener_sp(
60       Listener::MakeListener("lldb.process_trace.did_attach_listener"));
61   HijackProcessEvents(listener_sp);
62 
63   SetCanJIT(false);
64   StartPrivateStateThread();
65   SetPrivateState(eStateStopped);
66 
67   EventSP event_sp;
68   WaitForProcessToStop(std::nullopt, &event_sp, true, listener_sp);
69 
70   RestoreProcessEvents();
71 
72   Process::DidAttach(process_arch);
73 }
74 
75 bool ProcessTrace::DoUpdateThreadList(ThreadList &old_thread_list,
76                                       ThreadList &new_thread_list) {
77   return false;
78 }
79 
80 void ProcessTrace::RefreshStateAfterStop() {}
81 
82 Status ProcessTrace::DoDestroy() { return Status(); }
83 
84 size_t ProcessTrace::ReadMemory(addr_t addr, void *buf, size_t size,
85                                 Status &error) {
86   if (const ABISP &abi = GetABI())
87     addr = abi->FixAnyAddress(addr);
88 
89   // Don't allow the caching that lldb_private::Process::ReadMemory does since
90   // we have it all cached in the trace files.
91   return DoReadMemory(addr, buf, size, error);
92 }
93 
94 void ProcessTrace::Clear() { m_thread_list.Clear(); }
95 
96 void ProcessTrace::Initialize() {
97   static llvm::once_flag g_once_flag;
98 
99   llvm::call_once(g_once_flag, []() {
100     PluginManager::RegisterPlugin(GetPluginNameStatic(),
101                                   GetPluginDescriptionStatic(), CreateInstance);
102   });
103 }
104 
105 ArchSpec ProcessTrace::GetArchitecture() {
106   return GetTarget().GetArchitecture();
107 }
108 
109 bool ProcessTrace::GetProcessInfo(ProcessInstanceInfo &info) {
110   info.Clear();
111   info.SetProcessID(GetID());
112   info.SetArchitecture(GetArchitecture());
113   ModuleSP module_sp = GetTarget().GetExecutableModule();
114   if (module_sp) {
115     const bool add_exe_file_as_first_arg = false;
116     info.SetExecutableFile(GetTarget().GetExecutableModule()->GetFileSpec(),
117                            add_exe_file_as_first_arg);
118   }
119   return true;
120 }
121 
122 size_t ProcessTrace::DoReadMemory(addr_t addr, void *buf, size_t size,
123                                   Status &error) {
124   Address resolved_address;
125   GetTarget().GetSectionLoadList().ResolveLoadAddress(addr, resolved_address);
126 
127   return GetTarget().ReadMemoryFromFileCache(resolved_address, buf, size,
128                                              error);
129 }
130