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   uint32_t GetPluginVersion() override;
67 
68   SystemRuntime *GetSystemRuntime() override { return nullptr; }
69 
70   Status DoLoadCore() override;
71 
72   Status DoLaunch(Module *exe_module, ProcessLaunchInfo &launch_info) override;
73 
74   void DidLaunch() override;
75 
76   Status DoResume() override;
77 
78   Status DoDestroy() override;
79 
80   void RefreshStateAfterStop() override{};
81 
82   bool IsAlive() override;
83 
84   size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
85                       Status &error) override;
86 
87   ArchSpec GetArchitecture();
88 
89   Status GetMemoryRegionInfo(lldb::addr_t load_addr,
90                              MemoryRegionInfo &range_info) override;
91 
92   Status
93   GetMemoryRegions(lldb_private::MemoryRegionInfos &region_list) override;
94 
95   bool GetProcessInfo(ProcessInstanceInfo &info) override;
96 
97 protected:
98   Status DoStop();
99 
100   void Clear();
101 
102   bool DoUpdateThreadList(ThreadList &old_thread_list,
103                           ThreadList &new_thread_list) override;
104 
105 private:
106   void CheckInterpreterAndScriptObject() const;
107   ScriptedProcessInterface &GetInterface() const;
108   static bool IsScriptLanguageSupported(lldb::ScriptLanguage language);
109 
110   // Member variables.
111   const ScriptedProcessInfo m_scripted_process_info;
112   lldb_private::ScriptInterpreter *m_interpreter = nullptr;
113   lldb_private::StructuredData::ObjectSP m_script_object_sp = nullptr;
114   //@}
115 };
116 
117 } // namespace lldb_private
118 
119 #endif // LLDB_SOURCE_PLUGINS_SCRIPTED_PROCESS_H
120