1 //===-- GDBRemoteCommunicationServerPlatform.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_GDBRemoteCommunicationServerPlatform_h_
11 #define liblldb_GDBRemoteCommunicationServerPlatform_h_
12 
13 // C Includes
14 // C++ Includes
15 #include <map>
16 #include <set>
17 
18 // Other libraries and framework includes
19 // Project includes
20 #include "GDBRemoteCommunicationServerCommon.h"
21 #include "lldb/Host/Socket.h"
22 
23 namespace lldb_private {
24 namespace process_gdb_remote {
25 
26 class GDBRemoteCommunicationServerPlatform :
27     public GDBRemoteCommunicationServerCommon
28 {
29 public:
30     typedef std::map<uint16_t, lldb::pid_t> PortMap;
31 
32     GDBRemoteCommunicationServerPlatform(const Socket::SocketProtocol socket_protocol,
33                                          const char* socket_scheme);
34 
35     ~GDBRemoteCommunicationServerPlatform() override;
36 
37     Error
38     LaunchProcess () override;
39 
40     // Set both ports to zero to let the platform automatically bind to
41     // a port chosen by the OS.
42     void
43     SetPortMap (PortMap &&port_map);
44 
45     //----------------------------------------------------------------------
46     // If we are using a port map where we can only use certain ports,
47     // get the next available port.
48     //
49     // If we are using a port map and we are out of ports, return UINT16_MAX
50     //
51     // If we aren't using a port map, return 0 to indicate we should bind to
52     // port 0 and then figure out which port we used.
53     //----------------------------------------------------------------------
54     uint16_t
55     GetNextAvailablePort ();
56 
57     bool
58     AssociatePortWithProcess (uint16_t port, lldb::pid_t pid);
59 
60     bool
61     FreePort (uint16_t port);
62 
63     bool
64     FreePortForProcess (lldb::pid_t pid);
65 
66     void
67     SetPortOffset (uint16_t port_offset);
68 
69     void
70     SetInferiorArguments (const lldb_private::Args& args);
71 
72     Error
73     LaunchGDBServer(const lldb_private::Args& args,
74                     std::string hostname,
75                     lldb::pid_t& pid,
76                     uint16_t& port,
77                     std::string& socket_name);
78 
79     void
80     SetPendingGdbServer(lldb::pid_t pid, uint16_t port, const std::string& socket_name);
81 
82 protected:
83     const Socket::SocketProtocol m_socket_protocol;
84     const std::string m_socket_scheme;
85     Mutex m_spawned_pids_mutex;
86     std::set<lldb::pid_t> m_spawned_pids;
87     lldb::PlatformSP m_platform_sp;
88 
89     PortMap m_port_map;
90     uint16_t m_port_offset;
91     struct { lldb::pid_t pid; uint16_t port; std::string socket_name; } m_pending_gdb_server;
92 
93     PacketResult
94     Handle_qLaunchGDBServer (StringExtractorGDBRemote &packet);
95 
96     PacketResult
97     Handle_qQueryGDBServer (StringExtractorGDBRemote &packet);
98 
99     PacketResult
100     Handle_qKillSpawnedProcess (StringExtractorGDBRemote &packet);
101 
102     PacketResult
103     Handle_qProcessInfo (StringExtractorGDBRemote &packet);
104 
105     PacketResult
106     Handle_qGetWorkingDir (StringExtractorGDBRemote &packet);
107 
108     PacketResult
109     Handle_QSetWorkingDir (StringExtractorGDBRemote &packet);
110 
111     PacketResult
112     Handle_qC (StringExtractorGDBRemote &packet);
113 
114     PacketResult
115     Handle_jSignalsInfo(StringExtractorGDBRemote &packet);
116 
117 private:
118     bool
119     KillSpawnedProcess (lldb::pid_t pid);
120 
121     bool
122     DebugserverProcessReaped (lldb::pid_t pid);
123 
124     static bool
125     ReapDebugserverProcess (void *callback_baton,
126                             lldb::pid_t pid,
127                             bool exited,
128                             int signal,
129                             int status);
130 
131     static const FileSpec&
132     GetDomainSocketDir();
133 
134     static FileSpec
135     GetDomainSocketPath(const char* prefix);
136 
137     DISALLOW_COPY_AND_ASSIGN (GDBRemoteCommunicationServerPlatform);
138 };
139 
140 } // namespace process_gdb_remote
141 } // namespace lldb_private
142 
143 #endif // liblldb_GDBRemoteCommunicationServerPlatform_h_
144