1 //===-- ScriptedProcess.h ------------------------------------- -*- C++ -*-===//
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 #ifndef LLDB_SOURCE_PLUGINS_SCRIPTED_PROCESS_H
10 #define LLDB_SOURCE_PLUGINS_SCRIPTED_PROCESS_H
11 
12 #include "lldb/Target/Process.h"
13 #include "lldb/Utility/ConstString.h"
14 #include "lldb/Utility/Status.h"
15 
16 #include <mutex>
17 
18 namespace lldb_private {
19 
20 class ScriptedProcess : public Process {
21 protected:
22   class ScriptedProcessInfo {
23   public:
24     ScriptedProcessInfo(const ProcessLaunchInfo &launch_info) {
25       m_class_name = launch_info.GetScriptedProcessClassName();
26       m_dictionary_sp = launch_info.GetScriptedProcessDictionarySP();
27     }
28 
29     std::string GetClassName() const { return m_class_name; }
30     StructuredData::DictionarySP GetDictionarySP() const {
31       return m_dictionary_sp;
32     }
33 
34   private:
35     std::string m_class_name;
36     StructuredData::DictionarySP m_dictionary_sp;
37   };
38 
39 public:
40   static lldb::ProcessSP CreateInstance(lldb::TargetSP target_sp,
41                                         lldb::ListenerSP listener_sp,
42                                         const FileSpec *crash_file_path,
43                                         bool can_connect);
44 
45   static void Initialize();
46 
47   static void Terminate();
48 
49   static ConstString GetPluginNameStatic();
50 
51   static const char *GetPluginDescriptionStatic();
52 
53   ScriptedProcess(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp,
54                   const ScriptedProcess::ScriptedProcessInfo &launch_info,
55                   Status &error);
56 
57   ~ScriptedProcess() override;
58 
59   bool CanDebug(lldb::TargetSP target_sp,
60                 bool plugin_specified_by_name) override;
61 
62   DynamicLoader *GetDynamicLoader() override { return nullptr; }
63 
64   ConstString GetPluginName() override;
65 
66   SystemRuntime *GetSystemRuntime() override { return nullptr; }
67 
68   Status DoLoadCore() override;
69 
70   Status DoLaunch(Module *exe_module, ProcessLaunchInfo &launch_info) override;
71 
72   void DidLaunch() override;
73 
74   Status DoResume() override;
75 
76   Status DoDestroy() override;
77 
78   void RefreshStateAfterStop() override{};
79 
80   bool IsAlive() override;
81 
82   size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
83                       Status &error) override;
84 
85   ArchSpec GetArchitecture();
86 
87   Status GetMemoryRegionInfo(lldb::addr_t load_addr,
88                              MemoryRegionInfo &range_info) override;
89 
90   Status
91   GetMemoryRegions(lldb_private::MemoryRegionInfos &region_list) override;
92 
93   bool GetProcessInfo(ProcessInstanceInfo &info) override;
94 
95 protected:
96   Status DoStop();
97 
98   void Clear();
99 
100   bool DoUpdateThreadList(ThreadList &old_thread_list,
101                           ThreadList &new_thread_list) override;
102 
103 private:
104   void CheckInterpreterAndScriptObject() const;
105   ScriptedProcessInterface &GetInterface() const;
106   static bool IsScriptLanguageSupported(lldb::ScriptLanguage language);
107 
108   // Member variables.
109   const ScriptedProcessInfo m_scripted_process_info;
110   lldb_private::ScriptInterpreter *m_interpreter = nullptr;
111   lldb_private::StructuredData::ObjectSP m_script_object_sp = nullptr;
112   //@}
113 };
114 
115 } // namespace lldb_private
116 
117 #endif // LLDB_SOURCE_PLUGINS_SCRIPTED_PROCESS_H
118