Creates a socket host object.

This patch moves the logic of many common socket operations into
its own class lldb_private::Socket.  It then modifies the
ConnectionFileDescriptor class, and a few users of that class,
to use this new Socket class instead of hardcoding socket logic
directly.

Finally, this patch creates a common interface called IOObject for
any objects that support reading and writing, so that endpoints
such as sockets and files can be treated the same.

Differential Revision: http://reviews.llvm.org/D4641

Reviewed by: Todd Fiala, Greg Clayton

llvm-svn: 214984
This commit is contained in:
Zachary Turner 2014-08-06 18:16:26 +00:00
parent 413297c53d
commit 98688922b7
16 changed files with 1082 additions and 1010 deletions

View File

@ -10,25 +10,23 @@
#ifndef liblldb_ConnectionFileDescriptor_h_
#define liblldb_ConnectionFileDescriptor_h_
// C Includes
#ifndef _WIN32
#include <sys/socket.h>
#include <sys/types.h>
#include <netinet/in.h>
#endif
// C++ Includes
#include <memory>
#include "lldb/lldb-forward.h"
// Other libraries and framework includes
// Project includes
#include "lldb/Core/Connection.h"
#include "lldb/Host/Mutex.h"
#include "lldb/Host/Pipe.h"
#include "lldb/Host/Predicate.h"
#include "lldb/Host/IOObject.h"
namespace lldb_private {
class Error;
class Socket;
class SocketAddress;
class ConnectionFileDescriptor :
@ -65,33 +63,18 @@ public:
lldb::ConnectionStatus &status,
Error *error_ptr);
// If the read file descriptor is a socket, then return
// the port number that is being used by the socket.
uint16_t
GetReadPort () const;
// If the write file descriptor is a socket, then return
// the port number that is being used by the socket.
uint16_t
GetWritePort () const;
uint16_t
GetBoundPort (uint32_t timeout_sec);
lldb::ConnectionStatus
BytesAvailable (uint32_t timeout_usec, Error *error_ptr);
bool
InterruptRead ();
protected:
lldb::IOObjectSP GetReadObject() { return m_read_sp; }
const lldb::IOObjectSP GetReadObject() const { return m_read_sp; }
typedef enum
{
eFDTypeFile, // Other FD requiring read/write
eFDTypeSocket, // Socket requiring send/recv
eFDTypeSocketUDP // Unconnected UDP socket requiring sendto/recvfrom
} FDType;
uint16_t GetListeningPort(uint32_t timeout_sec);
protected:
void
OpenCommandPipe ();
@ -101,47 +84,31 @@ protected:
lldb::ConnectionStatus
SocketListen (const char *host_and_port, Error *error_ptr);
lldb::ConnectionStatus
ConnectTCP (const char *host_and_port, Error *error_ptr);
lldb::ConnectionStatus
ConnectUDP (const char *args, Error *error_ptr);
lldb::ConnectionStatus
NamedSocketAccept (const char *socket_name, Error *error_ptr);
NamedSocketConnect (const char *socket_name, Error *error_ptr);
lldb::ConnectionStatus
NamedSocketConnect (const char *socket_name, Error *error_ptr);
NamedSocketAccept (const char *socket_name, Error *error_ptr);
lldb::ConnectionStatus
Close (int& fd, FDType type, Error *error);
int m_fd_send;
int m_fd_recv;
FDType m_fd_send_type;
FDType m_fd_recv_type;
std::unique_ptr<SocketAddress> m_udp_send_sockaddr;
uint32_t m_socket_timeout_usec;
lldb::IOObjectSP m_read_sp;
lldb::IOObjectSP m_write_sp;
Predicate<uint16_t> m_port_predicate; // Used when binding to port zero to wait for the thread
// that creates the socket, binds and listens to resolve
// the port number.
Pipe m_pipe;
Mutex m_mutex;
Predicate<uint16_t> m_port_predicate; // Used when binding to port zero to wait for the thread that creates the socket, binds and listens to resolve the port number
bool m_should_close_fd; // True if this class should close the file descriptor when it goes away.
bool m_shutting_down; // This marks that we are shutting down so if we get woken up from BytesAvailable
// to disconnect, we won't try to read again.
static uint16_t
GetSocketPort (int fd);
static int
GetSocketOption(int fd, int level, int option_name, int &option_value);
static int
SetSocketOption(int fd, int level, int option_name, int option_value);
bool
SetSocketReceiveTimeout (uint32_t timeout_usec);
bool m_shutting_down; // This marks that we are shutting down so if we get woken up from
// BytesAvailable to disconnect, we won't try to read again.
bool m_waiting_for_accept;
private:
DISALLOW_COPY_AND_ASSIGN (ConnectionFileDescriptor);
};

View File

@ -27,6 +27,7 @@
#include "lldb/Host/Condition.h"
#include "lldb/Host/FileSpec.h"
#include "lldb/Host/Mutex.h"
#include "lldb/Host/Predicate.h"
namespace lldb_private {

View File

@ -16,6 +16,7 @@
#include <sys/types.h>
#include "lldb/lldb-private.h"
#include "lldb/Host/IOObject.h"
namespace lldb_private {
@ -26,7 +27,7 @@ namespace lldb_private {
/// A file class that divides abstracts the LLDB core from host file
/// functionality.
//----------------------------------------------------------------------
class File
class File : public IOObject
{
public:
static int kInvalidDescriptor;
@ -48,22 +49,22 @@ public:
ConvertOpenOptionsForPOSIXOpen (uint32_t open_options);
File() :
IOObject(eFDTypeFile, false),
m_descriptor (kInvalidDescriptor),
m_stream (kInvalidStream),
m_options (0),
m_own_stream (false),
m_own_descriptor (false),
m_is_interactive (eLazyBoolCalculate),
m_is_real_terminal (eLazyBoolCalculate)
{
}
File (FILE *fh, bool transfer_ownership) :
IOObject(eFDTypeFile, false),
m_descriptor (kInvalidDescriptor),
m_stream (fh),
m_options (0),
m_own_stream (transfer_ownership),
m_own_descriptor (false),
m_is_interactive (eLazyBoolCalculate),
m_is_real_terminal (eLazyBoolCalculate)
{
@ -118,11 +119,11 @@ public:
uint32_t permissions = lldb::eFilePermissionsFileDefault);
File (int fd, bool transfer_ownership) :
IOObject(eFDTypeFile, transfer_ownership),
m_descriptor (fd),
m_stream (kInvalidStream),
m_options (0),
m_own_stream (false),
m_own_descriptor (transfer_ownership)
m_own_stream (false)
{
}
@ -222,6 +223,10 @@ public:
int
GetDescriptor() const;
WaitableHandle
GetWaitableHandle();
void
SetDescriptor(int fd, bool transfer_ownership);
@ -541,7 +546,6 @@ protected:
FILE *m_stream;
uint32_t m_options;
bool m_own_stream;
bool m_own_descriptor;
LazyBool m_is_interactive;
LazyBool m_is_real_terminal;
};

View File

@ -0,0 +1,61 @@
//===-- IOObject.h ----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_Host_Common_IOObject_h_
#define liblldb_Host_Common_IOObject_h_
#include <stdarg.h>
#include <stdio.h>
#include <sys/types.h>
#include "lldb/lldb-private.h"
namespace lldb_private {
class IOObject
{
public:
typedef enum
{
eFDTypeFile, // Other FD requiring read/write
eFDTypeSocket, // Socket requiring send/recv
} FDType;
// TODO: On Windows this should be a HANDLE, and wait should use
// WaitForMultipleObjects
typedef int WaitableHandle;
static const WaitableHandle kInvalidHandleValue;
IOObject(FDType type, bool should_close)
: m_fd_type(type)
, m_should_close_fd(should_close)
{
}
virtual ~IOObject() {}
virtual Error Read (void *buf, size_t &num_bytes) = 0;
virtual Error Write (const void *buf, size_t &num_bytes) = 0;
virtual bool IsValid() const = 0;
virtual Error Close() = 0;
FDType GetFdType() const { return m_fd_type; }
virtual WaitableHandle GetWaitableHandle() = 0;
protected:
FDType m_fd_type;
bool m_should_close_fd; // True if this class should close the file descriptor when it goes away.
private:
DISALLOW_COPY_AND_ASSIGN (IOObject);
};
}
#endif

View File

@ -0,0 +1,103 @@
//===-- Socket.h ------------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_Host_Socket_h_
#define liblldb_Host_Socket_h_
#include <string>
#include "lldb/lldb-private.h"
#include "lldb/Core/Error.h"
#include "lldb/Host/IOObject.h"
#include "lldb/Host/Predicate.h"
#include "lldb/Host/SocketAddress.h"
#ifdef _WIN32
#include "lldb/Host/windows/windows.h"
#include <winsock2.h>
#include <ws2tcpip.h>
#endif
namespace llvm
{
class StringRef;
}
namespace lldb_private {
#if defined(_MSC_VER)
typedef SOCKET NativeSocket;
#else
typedef int NativeSocket;
#endif
class Socket : public IOObject
{
public:
typedef enum
{
ProtocolTcp,
ProtocolUdp,
ProtocolUnixDomain
} SocketProtocol;
static const NativeSocket kInvalidSocketValue;
Socket(NativeSocket socket, SocketProtocol protocol, bool should_close);
~Socket();
// Initialize a Tcp Socket object in listening mode. listen and accept are implemented
// separately because the caller may wish to manipulate or query the socket after it is
// initialized, but before entering a blocking accept.
static Error TcpListen(llvm::StringRef host_and_port, Socket *&socket, Predicate<uint16_t>* predicate);
static Error TcpConnect(llvm::StringRef host_and_port, Socket *&socket);
static Error UdpConnect(llvm::StringRef host_and_port, Socket *&send_socket, Socket *&recv_socket);
static Error UnixDomainConnect(llvm::StringRef host_and_port, Socket *&socket);
static Error UnixDomainAccept(llvm::StringRef host_and_port, Socket *&socket);
// Blocks on a listening socket until a connection is received. This method assumes that
// |this->m_socket| is a listening socket, created via either TcpListen() or via the native
// constructor that takes a NativeSocket, which itself was created via a call to |listen()|
Error BlockingAccept(llvm::StringRef host_and_port, Socket *&socket);
int GetOption (int level, int option_name, int &option_value);
int SetOption (int level, int option_name, int option_value);
static uint16_t GetPortNumber(const NativeSocket& socket);
uint16_t GetPortNumber () const;
NativeSocket GetNativeSocket () const { return m_socket; }
SocketProtocol GetSocketProtocol() const { return m_protocol; }
virtual Error Read (void *buf, size_t &num_bytes);
virtual Error Write (const void *buf, size_t &num_bytes);
virtual Error PreDisconnect();
virtual Error Close();
virtual bool IsValid() const { return m_socket != kInvalidSocketValue; }
virtual WaitableHandle GetWaitableHandle();
protected:
static bool
DecodeHostAndPort (llvm::StringRef host_and_port,
std::string &host_str,
std::string &port_str,
int32_t& port,
Error *error_ptr);
SocketProtocol m_protocol;
NativeSocket m_socket;
SocketAddress m_udp_send_sockaddr; // Send address used for UDP connections.
};
}
#endif

View File

@ -106,6 +106,7 @@ class InlineFunctionInfo;
class Instruction;
class InstructionList;
class IOHandler;
class IOObject;
class IRExecutionUnit;
class JITLoader;
class LanguageRuntime;
@ -310,6 +311,7 @@ namespace lldb {
typedef std::shared_ptr<lldb_private::InlineFunctionInfo> InlineFunctionInfoSP;
typedef std::shared_ptr<lldb_private::Instruction> InstructionSP;
typedef std::shared_ptr<lldb_private::IOHandler> IOHandlerSP;
typedef std::shared_ptr<lldb_private::IOObject> IOObjectSP;
typedef std::shared_ptr<lldb_private::JITLoader> JITLoaderSP;
typedef std::shared_ptr<lldb_private::LanguageRuntime> LanguageRuntimeSP;
typedef std::shared_ptr<lldb_private::SystemRuntime> SystemRuntimeSP;

View File

@ -67,6 +67,8 @@
232CB61E191E00CD00EF39FC /* SoftwareBreakpoint.h in Headers */ = {isa = PBXBuildFile; fileRef = 232CB614191E00CD00EF39FC /* SoftwareBreakpoint.h */; };
233B007D1960C9F90090E598 /* ProcessInfo.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 233B007B1960C9E60090E598 /* ProcessInfo.cpp */; };
233B007F1960CB280090E598 /* ProcessLaunchInfo.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 233B007E1960CB280090E598 /* ProcessLaunchInfo.cpp */; };
236124A41986B4E2004EFC37 /* IoObject.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 236124A21986B4E2004EFC37 /* IoObject.cpp */; };
236124A51986B4E2004EFC37 /* Socket.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 236124A31986B4E2004EFC37 /* Socket.cpp */; };
23DDF226196C3EE600BB8417 /* CommandOptionValidators.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 23DDF224196C3EE600BB8417 /* CommandOptionValidators.cpp */; };
23EDE33319269E7C00F6A132 /* NativeRegisterContext.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 23EDE3301926839700F6A132 /* NativeRegisterContext.cpp */; };
23EFE389193D1ABC00E54E54 /* SBTypeEnumMember.h in Headers */ = {isa = PBXBuildFile; fileRef = 23EFE388193D1ABC00E54E54 /* SBTypeEnumMember.h */; settings = {ATTRIBUTES = (Public, ); }; };
@ -929,6 +931,10 @@
233B00A919622F3F0090E598 /* NativeRegisterContextLinux_x86_64.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = NativeRegisterContextLinux_x86_64.cpp; sourceTree = "<group>"; };
233B00AA19622F3F0090E598 /* NativeRegisterContextLinux_x86_64.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = NativeRegisterContextLinux_x86_64.h; sourceTree = "<group>"; };
2360092C193FB21500189DB1 /* MemoryRegionInfo.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = MemoryRegionInfo.h; path = include/lldb/Target/MemoryRegionInfo.h; sourceTree = "<group>"; };
236124A21986B4E2004EFC37 /* IoObject.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = IoObject.cpp; sourceTree = "<group>"; };
236124A31986B4E2004EFC37 /* Socket.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Socket.cpp; sourceTree = "<group>"; };
236124A61986B50E004EFC37 /* IoObject.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = IoObject.h; path = include/lldb/Host/IoObject.h; sourceTree = "<group>"; };
236124A71986B50E004EFC37 /* Socket.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = Socket.h; path = include/lldb/Host/Socket.h; sourceTree = "<group>"; };
23DDF224196C3EE600BB8417 /* CommandOptionValidators.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = CommandOptionValidators.cpp; path = source/Interpreter/CommandOptionValidators.cpp; sourceTree = "<group>"; };
23EDE3301926839700F6A132 /* NativeRegisterContext.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; name = NativeRegisterContext.cpp; path = source/Target/NativeRegisterContext.cpp; sourceTree = "<group>"; };
23EDE3311926843600F6A132 /* NativeRegisterContext.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = NativeRegisterContext.h; path = include/lldb/Target/NativeRegisterContext.h; sourceTree = "<group>"; };
@ -3421,6 +3427,7 @@
260C6EA013011578005E16B0 /* File.h */,
26FA4315130103F400E71120 /* FileSpec.h */,
26BC7DD410F1B7D500F91463 /* Host.h */,
236124A61986B50E004EFC37 /* IoObject.h */,
26BC7DD510F1B7D500F91463 /* Mutex.h */,
232CB60B191E00CC00EF39FC /* NativeBreakpoint.cpp */,
232CB60C191E00CC00EF39FC /* NativeBreakpoint.h */,
@ -3433,6 +3440,7 @@
A36FF33D17D8E98800244D40 /* OptionParser.h */,
260A39A519647A3A004B4130 /* Pipe.h */,
26BC7DD610F1B7D500F91463 /* Predicate.h */,
236124A71986B50E004EFC37 /* Socket.h */,
26D7E45B13D5E2F9007FD12B /* SocketAddress.h */,
26D7E45C13D5E30A007FD12B /* SocketAddress.cpp */,
232CB613191E00CC00EF39FC /* SoftwareBreakpoint.cpp */,
@ -3957,9 +3965,11 @@
26FA43171301048600E71120 /* FileSpec.cpp */,
69A01E1B1236C5D400C660B5 /* Condition.cpp */,
69A01E1C1236C5D400C660B5 /* Host.cpp */,
236124A21986B4E2004EFC37 /* IoObject.cpp */,
69A01E1E1236C5D400C660B5 /* Mutex.cpp */,
A36FF33B17D8E94600244D40 /* OptionParser.cpp */,
260A39A719647A4E004B4130 /* Pipe.cpp */,
236124A31986B4E2004EFC37 /* Socket.cpp */,
69A01E1F1236C5D400C660B5 /* Symbols.cpp */,
268DA873130095ED00C9483A /* Terminal.cpp */,
69A01E201236C5D400C660B5 /* TimeValue.cpp */,
@ -4696,6 +4706,7 @@
2689002913353DDE00698AC0 /* CommandObjectVersion.cpp in Sources */,
2689002A13353E0400698AC0 /* Address.cpp in Sources */,
2689002B13353E0400698AC0 /* AddressRange.cpp in Sources */,
236124A41986B4E2004EFC37 /* IoObject.cpp in Sources */,
2689002C13353E0400698AC0 /* AddressResolver.cpp in Sources */,
2689002D13353E0400698AC0 /* AddressResolverFileLine.cpp in Sources */,
2689002E13353E0400698AC0 /* AddressResolverName.cpp in Sources */,
@ -4712,6 +4723,7 @@
2689003813353E0400698AC0 /* DataExtractor.cpp in Sources */,
2689003913353E0400698AC0 /* Debugger.cpp in Sources */,
2689003A13353E0400698AC0 /* Disassembler.cpp in Sources */,
236124A51986B4E2004EFC37 /* Socket.cpp in Sources */,
AF1729D7182C907200E0AB97 /* HistoryUnwind.cpp in Sources */,
2689003B13353E0400698AC0 /* EmulateInstruction.cpp in Sources */,
2689003C13353E0400698AC0 /* Error.cpp in Sources */,

File diff suppressed because it is too large Load Diff

View File

@ -7,6 +7,7 @@ add_lldb_library(lldbHostCommon
File.cpp
FileSpec.cpp
Host.cpp
IOObject.cpp
Mutex.cpp
NativeBreakpoint.cpp
NativeBreakpointList.cpp
@ -15,6 +16,7 @@ add_lldb_library(lldbHostCommon
OptionParser.cpp
Pipe.cpp
ProcessRunLock.cpp
Socket.cpp
SocketAddress.cpp
SoftwareBreakpoint.cpp
Symbols.cpp

View File

@ -24,6 +24,7 @@
#include "lldb/Core/DataBufferHeap.h"
#include "lldb/Core/Error.h"
#include "lldb/Core/Log.h"
#include "lldb/Host/Config.h"
#include "lldb/Host/FileSpec.h"
@ -77,11 +78,11 @@ int File::kInvalidDescriptor = -1;
FILE * File::kInvalidStream = NULL;
File::File(const char *path, uint32_t options, uint32_t permissions) :
IOObject(eFDTypeFile, false),
m_descriptor (kInvalidDescriptor),
m_stream (kInvalidStream),
m_options (),
m_own_stream (false),
m_own_descriptor (false),
m_is_interactive (eLazyBoolCalculate),
m_is_real_terminal (eLazyBoolCalculate)
{
@ -91,11 +92,11 @@ File::File(const char *path, uint32_t options, uint32_t permissions) :
File::File (const FileSpec& filespec,
uint32_t options,
uint32_t permissions) :
IOObject(eFDTypeFile, false),
m_descriptor (kInvalidDescriptor),
m_stream (kInvalidStream),
m_options (0),
m_own_stream (false),
m_own_descriptor (false),
m_is_interactive (eLazyBoolCalculate),
m_is_real_terminal (eLazyBoolCalculate)
@ -107,11 +108,11 @@ File::File (const FileSpec& filespec,
}
File::File (const File &rhs) :
IOObject(eFDTypeFile, false),
m_descriptor (kInvalidDescriptor),
m_stream (kInvalidStream),
m_options (0),
m_own_stream (false),
m_own_descriptor (false),
m_is_interactive (eLazyBoolCalculate),
m_is_real_terminal (eLazyBoolCalculate)
{
@ -148,13 +149,20 @@ File::GetDescriptor() const
return kInvalidDescriptor;
}
IOObject::WaitableHandle
File::GetWaitableHandle()
{
return m_descriptor;
}
void
File::SetDescriptor (int fd, bool transfer_ownership)
{
if (IsValid())
Close();
m_descriptor = fd;
m_own_descriptor = transfer_ownership;
m_should_close_fd = transfer_ownership;
}
@ -168,7 +176,7 @@ File::GetStream ()
const char *mode = GetStreamOpenModeFromOptions (m_options);
if (mode)
{
if (!m_own_descriptor)
if (!m_should_close_fd)
{
// We must duplicate the file descriptor if we don't own it because
// when you call fdopen, the stream will own the fd
@ -177,7 +185,7 @@ File::GetStream ()
#else
m_descriptor = ::fcntl(GetDescriptor(), F_DUPFD);
#endif
m_own_descriptor = true;
m_should_close_fd = true;
}
do
@ -191,7 +199,7 @@ File::GetStream ()
if (m_stream)
{
m_own_stream = true;
m_own_descriptor = false;
m_should_close_fd = false;
}
}
}
@ -228,7 +236,7 @@ File::Duplicate (const File &rhs)
else
{
m_options = rhs.m_options;
m_own_descriptor = true;
m_should_close_fd = true;
}
}
else
@ -307,7 +315,7 @@ File::Open (const char *path, uint32_t options, uint32_t permissions)
error.SetErrorToErrno();
else
{
m_own_descriptor = true;
m_should_close_fd = true;
m_options = options;
}
@ -371,7 +379,7 @@ File::Close ()
error.SetErrorToErrno();
}
if (DescriptorIsValid() && m_own_descriptor)
if (DescriptorIsValid() && m_should_close_fd)
{
if (::close (m_descriptor) != 0)
error.SetErrorToErrno();
@ -380,7 +388,7 @@ File::Close ()
m_stream = kInvalidStream;
m_options = 0;
m_own_stream = false;
m_own_descriptor = false;
m_should_close_fd = false;
m_is_interactive = eLazyBoolCalculate;
m_is_real_terminal = eLazyBoolCalculate;
return error;
@ -669,6 +677,7 @@ File::Write (const void *buf, size_t &num_bytes)
num_bytes = 0;
error.SetErrorString("invalid file handle");
}
return error;
}

View File

@ -0,0 +1,14 @@
//===-- IOObject.cpp --------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "lldb/Host/IOObject.h"
using namespace lldb_private;
const IOObject::WaitableHandle IOObject::kInvalidHandleValue = -1;

View File

@ -0,0 +1,661 @@
//===-- Socket.cpp ----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "lldb/Host/Socket.h"
#include "lldb/Core/Log.h"
#include "lldb/Core/RegularExpression.h"
#include "lldb/Host/Config.h"
#include "lldb/Host/Host.h"
#include "lldb/Host/SocketAddress.h"
#include "lldb/Host/TimeValue.h"
#include "lldb/Interpreter/Args.h"
#ifndef LLDB_DISABLE_POSIX
#include <arpa/inet.h>
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <sys/socket.h>
#include <sys/un.h>
#endif
using namespace lldb;
using namespace lldb_private;
#if defined(_WIN32)
typedef const char * set_socket_option_arg_type;
typedef char * get_socket_option_arg_type;
const NativeSocket Socket::kInvalidSocketValue = INVALID_SOCKET;
#else // #if defined(_WIN32)
typedef const void * set_socket_option_arg_type;
typedef void * get_socket_option_arg_type;
const NativeSocket Socket::kInvalidSocketValue = -1;
#endif // #if defined(_WIN32)
Socket::Socket(NativeSocket socket, SocketProtocol protocol, bool should_close)
: IOObject(eFDTypeSocket, should_close)
, m_protocol(protocol)
, m_socket(socket)
{
}
Socket::~Socket()
{
Close();
}
Error Socket::TcpConnect(llvm::StringRef host_and_port, Socket *&socket)
{
// Store the result in a unique_ptr in case we error out, the memory will get correctly freed.
std::unique_ptr<Socket> final_socket;
NativeSocket sock = kInvalidSocketValue;
Error error;
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_HOST));
if (log)
log->Printf ("Socket::TcpConnect (host/port = %s)", host_and_port.data());
std::string host_str;
std::string port_str;
int32_t port = INT32_MIN;
if (!DecodeHostAndPort (host_and_port, host_str, port_str, port, &error))
return error;
// Create the socket
sock = ::socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (sock == kInvalidSocketValue)
{
// TODO: On Windows, use WSAGetLastError().
error.SetErrorToErrno();
return error;
}
// Since they both refer to the same socket descriptor, arbitrarily choose the send socket to
// be the owner.
final_socket.reset(new Socket(sock, ProtocolTcp, true));
// Enable local address reuse
final_socket->SetOption(SOL_SOCKET, SO_REUSEADDR, 1);
struct sockaddr_in sa;
::memset (&sa, 0, sizeof (sa));
sa.sin_family = AF_INET;
sa.sin_port = htons (port);
int inet_pton_result = ::inet_pton (AF_INET, host_str.c_str(), &sa.sin_addr);
if (inet_pton_result <= 0)
{
struct hostent *host_entry = gethostbyname (host_str.c_str());
if (host_entry)
host_str = ::inet_ntoa (*(struct in_addr *)*host_entry->h_addr_list);
inet_pton_result = ::inet_pton (AF_INET, host_str.c_str(), &sa.sin_addr);
if (inet_pton_result <= 0)
{
// TODO: On Windows, use WSAGetLastError()
if (inet_pton_result == -1)
error.SetErrorToErrno();
else
error.SetErrorStringWithFormat("invalid host string: '%s'", host_str.c_str());
return error;
}
}
if (-1 == ::connect (sock, (const struct sockaddr *)&sa, sizeof(sa)))
{
// TODO: On Windows, use WSAGetLastError()
error.SetErrorToErrno();
return error;
}
// Keep our TCP packets coming without any delays.
final_socket->SetOption(IPPROTO_TCP, TCP_NODELAY, 1);
error.Clear();
socket = final_socket.release();
return error;
}
Error Socket::TcpListen(llvm::StringRef host_and_port, Socket *&socket, Predicate<uint16_t>* predicate)
{
std::unique_ptr<Socket> listen_socket;
NativeSocket listen_sock = kInvalidSocketValue;
Error error;
const sa_family_t family = AF_INET;
const int socktype = SOCK_STREAM;
const int protocol = IPPROTO_TCP;
listen_sock = ::socket (family, socktype, protocol);
if (listen_sock == kInvalidSocketValue)
{
error.SetErrorToErrno();
return error;
}
listen_socket.reset(new Socket(listen_sock, ProtocolTcp, true));
// enable local address reuse
listen_socket->SetOption(SOL_SOCKET, SO_REUSEADDR, 1);
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_CONNECTION));
if (log)
log->Printf ("ConnectionFileDescriptor::SocketListen (%s)", host_and_port.data());
std::string host_str;
std::string port_str;
int32_t port = INT32_MIN;
if (!DecodeHostAndPort (host_and_port, host_str, port_str, port, &error))
return error;
SocketAddress anyaddr;
if (anyaddr.SetToAnyAddress (family, port))
{
int err = ::bind (listen_sock, anyaddr, anyaddr.GetLength());
if (err == -1)
{
// TODO: On Windows, use WSAGetLastError()
error.SetErrorToErrno();
return error;
}
err = ::listen (listen_sock, 1);
if (err == -1)
{
// TODO: On Windows, use WSAGetLastError()
error.SetErrorToErrno();
return error;
}
// We were asked to listen on port zero which means we
// must now read the actual port that was given to us
// as port zero is a special code for "find an open port
// for me".
if (port == 0)
port = listen_socket->GetPortNumber();
// Set the port predicate since when doing a listen://<host>:<port>
// it often needs to accept the incoming connection which is a blocking
// system call. Allowing access to the bound port using a predicate allows
// us to wait for the port predicate to be set to a non-zero value from
// another thread in an efficient manor.
if (predicate)
predicate->SetValue(port, eBroadcastAlways);
socket = listen_socket.release();
}
return error;
}
Error Socket::BlockingAccept(llvm::StringRef host_and_port, Socket *&socket)
{
Error error;
std::string host_str;
std::string port_str;
int32_t port;
if (!DecodeHostAndPort(host_and_port, host_str, port_str, port, &error))
return error;
const sa_family_t family = AF_INET;
const int socktype = SOCK_STREAM;
const int protocol = IPPROTO_TCP;
SocketAddress listen_addr;
if (host_str.empty())
listen_addr.SetToLocalhost(family, port);
else if (host_str.compare("*") == 0)
listen_addr.SetToAnyAddress(family, port);
else
{
if (!listen_addr.getaddrinfo(host_str.c_str(), port_str.c_str(), family, socktype, protocol))
{
error.SetErrorStringWithFormat("unable to resolve hostname '%s'", host_str.c_str());
return error;
}
}
bool accept_connection = false;
std::unique_ptr<Socket> accepted_socket;
// Loop until we are happy with our connection
while (!accept_connection)
{
struct sockaddr_in accept_addr;
::memset (&accept_addr, 0, sizeof accept_addr);
#if !(defined (__linux__) || defined(_WIN32))
accept_addr.sin_len = sizeof accept_addr;
#endif
socklen_t accept_addr_len = sizeof accept_addr;
int sock = ::accept (this->GetNativeSocket(), (struct sockaddr *)&accept_addr, &accept_addr_len);
if (sock == kInvalidSocketValue)
{
// TODO: On Windows, use WSAGetLastError()
error.SetErrorToErrno();
break;
}
bool is_same_addr = true;
#if !(defined(__linux__) || (defined(_WIN32)))
is_same_addr = (accept_addr_len == listen_addr.sockaddr_in().sin_len);
#endif
if (is_same_addr)
is_same_addr = (accept_addr.sin_addr.s_addr == listen_addr.sockaddr_in().sin_addr.s_addr);
if (is_same_addr || (listen_addr.sockaddr_in().sin_addr.s_addr == INADDR_ANY))
{
accept_connection = true;
// Since both sockets have the same descriptor, arbitrarily choose the send
// socket to be the owner.
accepted_socket.reset(new Socket(sock, ProtocolTcp, true));
}
else
{
const uint8_t *accept_ip = (const uint8_t *)&accept_addr.sin_addr.s_addr;
const uint8_t *listen_ip = (const uint8_t *)&listen_addr.sockaddr_in().sin_addr.s_addr;
::fprintf (stderr, "error: rejecting incoming connection from %u.%u.%u.%u (expecting %u.%u.%u.%u)\n",
accept_ip[0], accept_ip[1], accept_ip[2], accept_ip[3],
listen_ip[0], listen_ip[1], listen_ip[2], listen_ip[3]);
accepted_socket.reset();
}
}
if (!accepted_socket)
return error;
// Keep our TCP packets coming without any delays.
accepted_socket->SetOption (IPPROTO_TCP, TCP_NODELAY, 1);
error.Clear();
socket = accepted_socket.release();
return error;
}
Error Socket::UdpConnect(llvm::StringRef host_and_port, Socket *&send_socket, Socket *&recv_socket)
{
std::unique_ptr<Socket> final_send_socket;
std::unique_ptr<Socket> final_recv_socket;
NativeSocket final_send_fd = kInvalidSocketValue;
NativeSocket final_recv_fd = kInvalidSocketValue;
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_CONNECTION));
if (log)
log->Printf ("Socket::UdpConnect (host/port = %s)", host_and_port.data());
Error error;
std::string host_str;
std::string port_str;
int32_t port = INT32_MIN;
if (!DecodeHostAndPort (host_and_port, host_str, port_str, port, &error))
return error;
// Setup the receiving end of the UDP connection on this localhost
// on port zero. After we bind to port zero we can read the port.
final_recv_fd = ::socket (AF_INET, SOCK_DGRAM, 0);
if (final_recv_fd == kInvalidSocketValue)
{
// Socket creation failed...
// TODO: On Windows, use WSAGetLastError().
error.SetErrorToErrno();
}
else
{
final_recv_socket.reset(new Socket(final_recv_fd, ProtocolUdp, true));
// Socket was created, now lets bind to the requested port
SocketAddress addr;
addr.SetToAnyAddress (AF_INET, 0);
if (::bind (final_recv_fd, addr, addr.GetLength()) == -1)
{
// Bind failed...
// TODO: On Windows use WSAGetLastError()
error.SetErrorToErrno();
}
}
assert(error.Fail() == !(final_recv_socket && final_recv_socket->IsValid()));
if (error.Fail())
return error;
// At this point we have setup the receive port, now we need to
// setup the UDP send socket
struct addrinfo hints;
struct addrinfo *service_info_list = NULL;
::memset (&hints, 0, sizeof(hints));
hints.ai_family = AF_INET;
hints.ai_socktype = SOCK_DGRAM;
int err = ::getaddrinfo (host_str.c_str(), port_str.c_str(), &hints, &service_info_list);
if (err != 0)
{
error.SetErrorStringWithFormat("getaddrinfo(%s, %s, &hints, &info) returned error %i (%s)",
host_str.c_str(),
port_str.c_str(),
err,
gai_strerror(err));
return error;
}
for (struct addrinfo *service_info_ptr = service_info_list;
service_info_ptr != NULL;
service_info_ptr = service_info_ptr->ai_next)
{
final_send_fd = ::socket (service_info_ptr->ai_family,
service_info_ptr->ai_socktype,
service_info_ptr->ai_protocol);
if (final_send_fd != kInvalidSocketValue)
{
final_send_socket.reset(new Socket(final_send_fd, ProtocolUdp, true));
final_send_socket->m_udp_send_sockaddr = service_info_ptr;
break;
}
else
continue;
}
:: freeaddrinfo (service_info_list);
if (final_send_fd == kInvalidSocketValue)
{
// TODO: On Windows, use WSAGetLastError().
error.SetErrorToErrno();
return error;
}
send_socket = final_send_socket.release();
recv_socket = final_recv_socket.release();
error.Clear();
return error;
}
Error Socket::UnixDomainConnect(llvm::StringRef name, Socket *&socket)
{
Error error;
#ifndef LLDB_DISABLE_POSIX
std::unique_ptr<Socket> final_socket;
// Open the socket that was passed in as an option
struct sockaddr_un saddr_un;
int fd = ::socket (AF_UNIX, SOCK_STREAM, 0);
if (fd == kInvalidSocketValue)
{
error.SetErrorToErrno();
return error;
}
final_socket.reset(new Socket(fd, ProtocolUnixDomain, true));
saddr_un.sun_family = AF_UNIX;
::strncpy(saddr_un.sun_path, name.data(), sizeof(saddr_un.sun_path) - 1);
saddr_un.sun_path[sizeof(saddr_un.sun_path) - 1] = '\0';
#if defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__)
saddr_un.sun_len = SUN_LEN (&saddr_un);
#endif
if (::connect (fd, (struct sockaddr *)&saddr_un, SUN_LEN (&saddr_un)) < 0)
{
error.SetErrorToErrno();
return error;
}
socket = final_socket.release();
#else
error.SetErrorString("Unix domain sockets are not supported on this platform.");
#endif
return error;
}
Error Socket::UnixDomainAccept(llvm::StringRef name, Socket *&socket)
{
Error error;
#ifndef LLDB_DISABLE_POSIX
struct sockaddr_un saddr_un;
std::unique_ptr<Socket> listen_socket;
std::unique_ptr<Socket> final_socket;
NativeSocket listen_fd = kInvalidSocketValue;
NativeSocket socket_fd = kInvalidSocketValue;
listen_fd = ::socket (AF_UNIX, SOCK_STREAM, 0);
if (listen_fd == kInvalidSocketValue)
{
error.SetErrorToErrno();
return error;
}
listen_socket.reset(new Socket(listen_fd, ProtocolUnixDomain, true));
saddr_un.sun_family = AF_UNIX;
::strncpy(saddr_un.sun_path, name.data(), sizeof(saddr_un.sun_path) - 1);
saddr_un.sun_path[sizeof(saddr_un.sun_path) - 1] = '\0';
#if defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__)
saddr_un.sun_len = SUN_LEN (&saddr_un);
#endif
Host::Unlink (name.data());
bool success = false;
if (::bind (listen_fd, (struct sockaddr *)&saddr_un, SUN_LEN (&saddr_un)) == 0)
{
if (::listen (listen_fd, 5) == 0)
{
socket_fd = ::accept (listen_fd, NULL, 0);
if (socket_fd > 0)
{
final_socket.reset(new Socket(socket_fd, ProtocolUnixDomain, true));
success = true;
}
}
}
if (!success)
{
error.SetErrorToErrno();
return error;
}
// We are done with the listen port
listen_socket.reset();
socket = final_socket.release();
#else
error.SetErrorString("Unix domain sockets are not supported on this platform.");
#endif
return error;
}
bool
Socket::DecodeHostAndPort(llvm::StringRef host_and_port,
std::string &host_str,
std::string &port_str,
int32_t& port,
Error *error_ptr)
{
static RegularExpression g_regex ("([^:]+):([0-9]+)");
RegularExpression::Match regex_match(2);
if (g_regex.Execute (host_and_port.data(), &regex_match))
{
if (regex_match.GetMatchAtIndex (host_and_port.data(), 1, host_str) &&
regex_match.GetMatchAtIndex (host_and_port.data(), 2, port_str))
{
port = Args::StringToSInt32 (port_str.c_str(), INT32_MIN);
if (port != INT32_MIN)
{
if (error_ptr)
error_ptr->Clear();
return true;
}
}
}
// If this was unsuccessful, then check if it's simply a signed 32-bit integer, representing
// a port with an empty host.
host_str.clear();
port_str.clear();
port = Args::StringToSInt32(host_and_port.data(), INT32_MIN);
if (port != INT32_MIN)
{
port_str = host_and_port;
return true;
}
if (error_ptr)
error_ptr->SetErrorStringWithFormat("invalid host:port specification: '%s'", host_and_port.data());
return false;
}
IOObject::WaitableHandle Socket::GetWaitableHandle()
{
// TODO: On Windows, use WSAEventSelect
return m_socket;
}
Error Socket::Read (void *buf, size_t &num_bytes)
{
Error error;
int bytes_received = 0;
do
{
bytes_received = ::recv (m_socket, static_cast<char *>(buf), num_bytes, 0);
// TODO: Use WSAGetLastError on windows.
} while (bytes_received < 0 && errno == EINTR);
if (bytes_received < 0)
{
error.SetErrorToErrno();
num_bytes = 0;
}
else
num_bytes = bytes_received;
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_HOST | LIBLLDB_LOG_COMMUNICATION));
if (log)
{
log->Printf ("%p Socket::Read() (socket = %" PRIu64 ", src = %p, src_len = %" PRIu64 ", flags = 0) => %" PRIi64 " (error = %s)",
static_cast<void*>(this),
static_cast<uint64_t>(m_socket),
buf,
static_cast<uint64_t>(num_bytes),
static_cast<int64_t>(bytes_received),
error.AsCString());
}
return error;
}
Error Socket::Write (const void *buf, size_t &num_bytes)
{
Error error;
int bytes_sent = 0;
do
{
if (m_protocol == ProtocolUdp)
{
bytes_sent = ::sendto (m_socket,
static_cast<const char*>(buf),
num_bytes,
0,
m_udp_send_sockaddr,
m_udp_send_sockaddr.GetLength());
}
else
bytes_sent = ::send (m_socket, static_cast<const char *>(buf), num_bytes, 0);
// TODO: Use WSAGetLastError on windows.
} while (bytes_sent < 0 && errno == EINTR);
if (bytes_sent < 0)
{
// TODO: On Windows, use WSAGEtLastError.
error.SetErrorToErrno();
num_bytes = 0;
}
else
num_bytes = bytes_sent;
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_HOST));
if (log)
{
log->Printf ("%p Socket::Write() (socket = %" PRIu64 ", src = %p, src_len = %" PRIu64 ", flags = 0) => %" PRIi64 " (error = %s)",
static_cast<void*>(this),
static_cast<uint64_t>(m_socket),
buf,
static_cast<uint64_t>(num_bytes),
static_cast<int64_t>(bytes_sent),
error.AsCString());
}
return error;
}
Error Socket::PreDisconnect()
{
Error error;
return error;
}
Error Socket::Close()
{
Error error;
if (!IsValid() || !m_should_close_fd)
return error;
Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_CONNECTION));
if (log)
log->Printf ("%p Socket::Close (fd = %i)", static_cast<void*>(this), m_socket);
#if defined(_WIN32)
bool success = !!closesocket(m_socket);
#else
bool success = !!::close (m_socket);
#endif
// A reference to a FD was passed in, set it to an invalid value
m_socket = kInvalidSocketValue;
if (!success)
{
// TODO: On Windows, use WSAGetLastError().
error.SetErrorToErrno();
}
return error;
}
int Socket::GetOption(int level, int option_name, int &option_value)
{
get_socket_option_arg_type option_value_p = reinterpret_cast<get_socket_option_arg_type>(&option_value);
socklen_t option_value_size = sizeof(int);
return ::getsockopt(m_socket, level, option_name, option_value_p, &option_value_size);
}
int Socket::SetOption(int level, int option_name, int option_value)
{
set_socket_option_arg_type option_value_p = reinterpret_cast<get_socket_option_arg_type>(&option_value);
return ::setsockopt(m_socket, level, option_name, option_value_p, sizeof(option_value));
}
uint16_t Socket::GetPortNumber(const NativeSocket& socket)
{
// We bound to port zero, so we need to figure out which port we actually bound to
if (socket >= 0)
{
SocketAddress sock_addr;
socklen_t sock_addr_len = sock_addr.GetMaxLength ();
if (::getsockname (socket, sock_addr, &sock_addr_len) == 0)
return sock_addr.GetPort ();
}
return 0;
}
// Return the port number that is being used by the socket.
uint16_t Socket::GetPortNumber() const
{
return GetPortNumber(m_socket);
}

View File

@ -272,7 +272,8 @@ ProcessKDP::DoConnectRemote (Stream *strm, const char *remote_url)
if (conn_ap->IsConnected())
{
const uint16_t reply_port = conn_ap->GetReadPort ();
const Socket& socket = static_cast<const Socket&>(conn_ap->GetReadObject());
const uint16_t reply_port = socket.GetPort();
if (reply_port != 0)
{

View File

@ -23,6 +23,7 @@
#include "lldb/Core/StreamString.h"
#include "lldb/Host/FileSpec.h"
#include "lldb/Host/Host.h"
#include "lldb/Host/Socket.h"
#include "lldb/Host/TimeValue.h"
#include "lldb/Target/Process.h"
@ -786,7 +787,7 @@ GDBRemoteCommunication::StartDebugserverProcess (const char *hostname,
ConnectionFileDescriptor *connection = (ConnectionFileDescriptor *)GetConnection ();
// Wait for 10 seconds to resolve the bound port
out_port = connection->GetBoundPort(10);
out_port = connection->GetListeningPort(10);
if (out_port > 0)
{
char port_cstr[32];
@ -802,7 +803,6 @@ GDBRemoteCommunication::StartDebugserverProcess (const char *hostname,
return error;
}
}
const char *env_debugserver_log_file = getenv("LLDB_DEBUGSERVER_LOG_FILE");
if (env_debugserver_log_file)

View File

@ -33,6 +33,7 @@
#include "lldb/Core/PluginManager.h"
#include "lldb/Core/StreamFile.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Host/Socket.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "Plugins/Process/gdb-remote/GDBRemoteCommunicationServer.h"
@ -401,9 +402,9 @@ ConnectToRemote (GDBRemoteCommunicationServer &gdb_server, bool reverse_connect,
{
// FIXME use new generic named pipe support.
int fd = ::open(named_pipe_path, O_WRONLY);
if (fd > -1)
const uint16_t bound_port = s_listen_connection_up->GetListeningPort(10);
if (fd > -1 && bound_port > 0)
{
const uint16_t bound_port = s_listen_connection_up->GetBoundPort (10);
char port_str[64];
const ssize_t port_str_len = ::snprintf (port_str, sizeof(port_str), "%u", bound_port);
@ -413,7 +414,10 @@ ConnectToRemote (GDBRemoteCommunicationServer &gdb_server, bool reverse_connect,
}
else
{
fprintf (stderr, "failed to open named pipe '%s' for writing\n", named_pipe_path);
if (fd < 0)
fprintf (stderr, "failed to open named pipe '%s' for writing\n", named_pipe_path);
else
fprintf(stderr, "unable to get the bound port for the listening connection\n");
}
}

View File

@ -11,7 +11,9 @@
// C Includes
#include <errno.h>
#include "lldb/Host/HostGetOpt.h"
#if defined(__APPLE__)
#include <netinet/in.h>
#endif
#include <signal.h>
#include <stdint.h>
#include <stdio.h>
@ -27,6 +29,7 @@
#include "lldb/Core/ConnectionMachPort.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Core/StreamFile.h"
#include "lldb/Host/HostGetOpt.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandReturnObject.h"