1 //===-- NativeProcessFreeBSD.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 liblldb_NativeProcessFreeBSD_H_
10 #define liblldb_NativeProcessFreeBSD_H_
11 
12 #include "Plugins/Process/POSIX/NativeProcessELF.h"
13 #include "Plugins/Process/Utility/NativeProcessSoftwareSingleStep.h"
14 
15 #include "lldb/Target/MemoryRegionInfo.h"
16 #include "lldb/Utility/ArchSpec.h"
17 #include "lldb/Utility/FileSpec.h"
18 
19 #include "NativeThreadFreeBSD.h"
20 
21 namespace lldb_private {
22 namespace process_freebsd {
23 /// \class NativeProcessFreeBSD
24 /// Manages communication with the inferior (debugee) process.
25 ///
26 /// Upon construction, this class prepares and launches an inferior process
27 /// for debugging.
28 ///
29 /// Changes in the inferior process state are broadcasted.
30 class NativeProcessFreeBSD : public NativeProcessELF,
31                              private NativeProcessSoftwareSingleStep {
32 public:
33   class Factory : public NativeProcessProtocol::Factory {
34   public:
35     llvm::Expected<std::unique_ptr<NativeProcessProtocol>>
36     Launch(ProcessLaunchInfo &launch_info, NativeDelegate &native_delegate,
37            MainLoop &mainloop) const override;
38 
39     llvm::Expected<std::unique_ptr<NativeProcessProtocol>>
40     Attach(lldb::pid_t pid, NativeDelegate &native_delegate,
41            MainLoop &mainloop) const override;
42   };
43 
44   // NativeProcessProtocol Interface
45   Status Resume(const ResumeActionList &resume_actions) override;
46 
47   Status Halt() override;
48 
49   Status Detach() override;
50 
51   Status Signal(int signo) override;
52 
53   Status Interrupt() override;
54 
55   Status Kill() override;
56 
57   Status GetMemoryRegionInfo(lldb::addr_t load_addr,
58                              MemoryRegionInfo &range_info) override;
59 
60   Status ReadMemory(lldb::addr_t addr, void *buf, size_t size,
61                     size_t &bytes_read) override;
62 
63   Status WriteMemory(lldb::addr_t addr, const void *buf, size_t size,
64                      size_t &bytes_written) override;
65 
66   size_t UpdateThreads() override;
67 
68   const ArchSpec &GetArchitecture() const override { return m_arch; }
69 
70   Status SetBreakpoint(lldb::addr_t addr, uint32_t size,
71                        bool hardware) override;
72 
73   // The two following methods are probably not necessary and probably
74   // will never be called.  Nevertheless, we implement them right now
75   // to reduce the differences between different platforms and reduce
76   // the risk of the lack of implementation actually breaking something,
77   // at least for the time being.
78   Status GetLoadedModuleFileSpec(const char *module_path,
79                                  FileSpec &file_spec) override;
80   Status GetFileLoadAddress(const llvm::StringRef &file_name,
81                             lldb::addr_t &load_addr) override;
82 
83   llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
84   GetAuxvData() const override;
85 
86   // Interface used by NativeRegisterContext-derived classes.
87   static Status PtraceWrapper(int req, lldb::pid_t pid, void *addr = nullptr,
88                               int data = 0, int *result = nullptr);
89 
90   bool SupportHardwareSingleStepping() const;
91 
92 protected:
93   llvm::Expected<llvm::ArrayRef<uint8_t>>
94   GetSoftwareBreakpointTrapOpcode(size_t size_hint) override;
95 
96 private:
97   MainLoop::SignalHandleUP m_sigchld_handle;
98   ArchSpec m_arch;
99   LazyBool m_supports_mem_region = eLazyBoolCalculate;
100   std::vector<std::pair<MemoryRegionInfo, FileSpec>> m_mem_region_cache;
101 
102   // Private Instance Methods
103   NativeProcessFreeBSD(::pid_t pid, int terminal_fd, NativeDelegate &delegate,
104                        const ArchSpec &arch, MainLoop &mainloop);
105 
106   bool HasThreadNoLock(lldb::tid_t thread_id);
107 
108   NativeThreadFreeBSD &AddThread(lldb::tid_t thread_id);
109   void RemoveThread(lldb::tid_t thread_id);
110 
111   void MonitorCallback(lldb::pid_t pid, int signal);
112   void MonitorExited(lldb::pid_t pid, WaitStatus status);
113   void MonitorSIGSTOP(lldb::pid_t pid);
114   void MonitorSIGTRAP(lldb::pid_t pid);
115   void MonitorSignal(lldb::pid_t pid, int signal);
116 
117   Status PopulateMemoryRegionCache();
118   void SigchldHandler();
119 
120   Status Attach();
121   Status SetupTrace();
122   Status ReinitializeThreads();
123 };
124 
125 } // namespace process_freebsd
126 } // namespace lldb_private
127 
128 #endif // #ifndef liblldb_NativeProcessFreeBSD_H_
129