1 //===-- NativeProcessNetBSD.h --------------------------------- -*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef liblldb_NativeProcessNetBSD_H_
11 #define liblldb_NativeProcessNetBSD_H_
12 
13 // C++ Includes
14 
15 // Other libraries and framework includes
16 
17 #include "lldb/Core/ArchSpec.h"
18 #include "lldb/Target/MemoryRegionInfo.h"
19 #include "lldb/Utility/FileSpec.h"
20 
21 #include "NativeThreadNetBSD.h"
22 #include "lldb/Host/common/NativeProcessProtocol.h"
23 
24 namespace lldb_private {
25 namespace process_netbsd {
26 /// @class NativeProcessNetBSD
27 /// @brief Manages communication with the inferior (debugee) process.
28 ///
29 /// Upon construction, this class prepares and launches an inferior process for
30 /// debugging.
31 ///
32 /// Changes in the inferior process state are broadcasted.
33 class NativeProcessNetBSD : public NativeProcessProtocol {
34   friend Error NativeProcessProtocol::Launch(
35       ProcessLaunchInfo &launch_info, NativeDelegate &native_delegate,
36       MainLoop &mainloop, NativeProcessProtocolSP &process_sp);
37 
38   friend Error NativeProcessProtocol::Attach(
39       lldb::pid_t pid, NativeProcessProtocol::NativeDelegate &native_delegate,
40       MainLoop &mainloop, NativeProcessProtocolSP &process_sp);
41 
42 public:
43   // ---------------------------------------------------------------------
44   // NativeProcessProtocol Interface
45   // ---------------------------------------------------------------------
46   Error Resume(const ResumeActionList &resume_actions) override;
47 
48   Error Halt() override;
49 
50   Error Detach() override;
51 
52   Error Signal(int signo) override;
53 
54   Error Kill() override;
55 
56   Error GetMemoryRegionInfo(lldb::addr_t load_addr,
57                             MemoryRegionInfo &range_info) override;
58 
59   Error ReadMemory(lldb::addr_t addr, void *buf, size_t size,
60                    size_t &bytes_read) override;
61 
62   Error ReadMemoryWithoutTrap(lldb::addr_t addr, void *buf, size_t size,
63                               size_t &bytes_read) override;
64 
65   Error WriteMemory(lldb::addr_t addr, const void *buf, size_t size,
66                     size_t &bytes_written) override;
67 
68   Error AllocateMemory(size_t size, uint32_t permissions,
69                        lldb::addr_t &addr) override;
70 
71   Error DeallocateMemory(lldb::addr_t addr) override;
72 
73   lldb::addr_t GetSharedLibraryInfoAddress() override;
74 
75   size_t UpdateThreads() override;
76 
77   bool GetArchitecture(ArchSpec &arch) const override;
78 
79   Error SetBreakpoint(lldb::addr_t addr, uint32_t size, bool hardware) override;
80 
81   Error GetLoadedModuleFileSpec(const char *module_path,
82                                 FileSpec &file_spec) override;
83 
84   Error GetFileLoadAddress(const llvm::StringRef &file_name,
85                            lldb::addr_t &load_addr) override;
86 
87   llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
88   GetAuxvData() const override;
89 
90   // ---------------------------------------------------------------------
91   // Interface used by NativeRegisterContext-derived classes.
92   // ---------------------------------------------------------------------
93   static Error PtraceWrapper(int req, lldb::pid_t pid, void *addr = nullptr,
94                              int data = 0, int *result = nullptr);
95 
96 protected:
97   // ---------------------------------------------------------------------
98   // NativeProcessProtocol protected interface
99   // ---------------------------------------------------------------------
100 
101   Error
102   GetSoftwareBreakpointTrapOpcode(size_t trap_opcode_size_hint,
103                                   size_t &actual_opcode_size,
104                                   const uint8_t *&trap_opcode_bytes) override;
105 
106 private:
107   MainLoop::SignalHandleUP m_sigchld_handle;
108   ArchSpec m_arch;
109   LazyBool m_supports_mem_region;
110   std::vector<std::pair<MemoryRegionInfo, FileSpec>> m_mem_region_cache;
111 
112   // ---------------------------------------------------------------------
113   // Private Instance Methods
114   // ---------------------------------------------------------------------
115   NativeProcessNetBSD();
116 
117   NativeThreadNetBSDSP AddThread(lldb::tid_t thread_id);
118 
119   Error LaunchInferior(MainLoop &mainloop, ProcessLaunchInfo &launch_info);
120   void AttachToInferior(MainLoop &mainloop, lldb::pid_t pid, Error &error);
121 
122   void MonitorCallback(lldb::pid_t pid, int signal);
123   void MonitorExited(lldb::pid_t pid, int signal, int status);
124   void MonitorSIGSTOP(lldb::pid_t pid);
125   void MonitorSIGTRAP(lldb::pid_t pid);
126   void MonitorSignal(lldb::pid_t pid, int signal);
127 
128   Error GetSoftwareBreakpointPCOffset(uint32_t &actual_opcode_size);
129   Error FixupBreakpointPCAsNeeded(NativeThreadNetBSD &thread);
130   Error PopulateMemoryRegionCache();
131   void SigchldHandler();
132 
133   ::pid_t Attach(lldb::pid_t pid, Error &error);
134 
135   Error ReinitializeThreads();
136 };
137 
138 } // namespace process_netbsd
139 } // namespace lldb_private
140 
141 #endif // #ifndef liblldb_NativeProcessNetBSD_H_
142