contrib/llvm/tools/lldb/include/lldb/Host/Socket.h

   1 //===-- Socket.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_Host_Socket_h_
  11 #define liblldb_Host_Socket_h_
  12
  13 #include <memory>
  14 #include <string>
  15
  16 #include "lldb/lldb-private.h"
  17
  18 #include "lldb/Host/Predicate.h"
  19 #include "lldb/Host/SocketAddress.h"
  20 #include "lldb/Utility/IOObject.h"
  21 #include "lldb/Utility/Status.h"
  22
  23 #ifdef _WIN32
  24 #include "lldb/Host/windows/windows.h"
  25 #include <winsock2.h>
  26 #include <ws2tcpip.h>
  27 #endif
  28
  29 namespace llvm {
  30 class StringRef;
  31 }
  32
  33 namespace lldb_private {
  34
  35 #if defined(_MSC_VER)
  36 typedef SOCKET NativeSocket;
  37 #else
  38 typedef int NativeSocket;
  39 #endif
  40
  41 class Socket : public IOObject {
  42 public:
  43   typedef enum {
  44     ProtocolTcp,
  45     ProtocolUdp,
  46     ProtocolUnixDomain,
  47     ProtocolUnixAbstract
  48   } SocketProtocol;
  49
  50   static const NativeSocket kInvalidSocketValue;
  51
  52   ~Socket() override;
  53
  54   static std::unique_ptr<Socket> Create(const SocketProtocol protocol,
  55                                         bool child_processes_inherit,
  56                                         Status &error);
  57
  58   virtual Status Connect(llvm::StringRef name) = 0;
  59   virtual Status Listen(llvm::StringRef name, int backlog) = 0;
  60   virtual Status Accept(Socket *&socket) = 0;
  61
  62   // Initialize a Tcp Socket object in listening mode.  listen and accept are
  63   // implemented
  64   // separately because the caller may wish to manipulate or query the socket
  65   // after it is
  66   // initialized, but before entering a blocking accept.
  67   static Status TcpListen(llvm::StringRef host_and_port,
  68                           bool child_processes_inherit, Socket *&socket,
  69                           Predicate<uint16_t> *predicate, int backlog = 5);
  70   static Status TcpConnect(llvm::StringRef host_and_port,
  71                            bool child_processes_inherit, Socket *&socket);
  72   static Status UdpConnect(llvm::StringRef host_and_port,
  73                            bool child_processes_inherit, Socket *&socket);
  74   static Status UnixDomainConnect(llvm::StringRef host_and_port,
  75                                   bool child_processes_inherit,
  76                                   Socket *&socket);
  77   static Status UnixDomainAccept(llvm::StringRef host_and_port,
  78                                  bool child_processes_inherit, Socket *&socket);
  79   static Status UnixAbstractConnect(llvm::StringRef host_and_port,
  80                                     bool child_processes_inherit,
  81                                     Socket *&socket);
  82   static Status UnixAbstractAccept(llvm::StringRef host_and_port,
  83                                    bool child_processes_inherit,
  84                                    Socket *&socket);
  85
  86   int GetOption(int level, int option_name, int &option_value);
  87   int SetOption(int level, int option_name, int option_value);
  88
  89   NativeSocket GetNativeSocket() const { return m_socket; }
  90   SocketProtocol GetSocketProtocol() const { return m_protocol; }
  91
  92   Status Read(void *buf, size_t &num_bytes) override;
  93   Status Write(const void *buf, size_t &num_bytes) override;
  94
  95   virtual Status PreDisconnect();
  96   Status Close() override;
  97
  98   bool IsValid() const override { return m_socket != kInvalidSocketValue; }
  99   WaitableHandle GetWaitableHandle() override;
 100
 101   static bool DecodeHostAndPort(llvm::StringRef host_and_port,
 102                                 std::string &host_str, std::string &port_str,
 103                                 int32_t &port, Status *error_ptr);
 104
 105 protected:
 106   Socket(SocketProtocol protocol, bool should_close,
 107          bool m_child_process_inherit);
 108
 109   virtual size_t Send(const void *buf, const size_t num_bytes);
 110
 111   static void SetLastError(Status &error);
 112   static NativeSocket CreateSocket(const int domain, const int type,
 113                                    const int protocol,
 114                                    bool child_processes_inherit, Status &error);
 115   static NativeSocket AcceptSocket(NativeSocket sockfd, struct sockaddr *addr,
 116                                    socklen_t *addrlen,
 117                                    bool child_processes_inherit, Status &error);
 118
 119   SocketProtocol m_protocol;
 120   NativeSocket m_socket;
 121   bool m_child_processes_inherit;
 122 };
 123
 124 } // namespace lldb_private
 125
 126 #endif // liblldb_Host_Socket_h_