[Lldb-commits] [lldb] a6daf99 - [lldb] [Host] Refactor Socket::DecodeHostAndPort() to use LLVM API

Michał Górny via lldb-commits lldb-commits at lists.llvm.org
Fri Sep 24 04:25:05 PDT 2021


Author: Michał Górny
Date: 2021-09-24T13:24:58+02:00
New Revision: a6daf99228bc16fb7f2596d67a0d00fef327ace5

URL: https://github.com/llvm/llvm-project/commit/a6daf99228bc16fb7f2596d67a0d00fef327ace5
DIFF: https://github.com/llvm/llvm-project/commit/a6daf99228bc16fb7f2596d67a0d00fef327ace5.diff

LOG: [lldb] [Host] Refactor Socket::DecodeHostAndPort() to use LLVM API

Refactor Socket::DecodeHostAndPort() to use LLVM API over redundant
LLDB API.  In particular, this means llvm::Regex, llvm::Error return
type and llvm::to_integer().

While at it, change the port type from int32_t to uint16_t.  The method
never returns any value outside this range, and using the correct type
allows us to rely on getAsInteger()'s implicit overflow check.

Differential Revision: https://reviews.llvm.org/D110391

Added: 
    

Modified: 
    lldb/include/lldb/Host/Socket.h
    lldb/source/Host/common/Socket.cpp
    lldb/source/Host/common/TCPSocket.cpp
    lldb/source/Host/common/UDPSocket.cpp
    lldb/tools/lldb-server/Acceptor.cpp
    lldb/unittests/Host/SocketTest.cpp

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Host/Socket.h b/lldb/include/lldb/Host/Socket.h
index 36db0ec63e9d8..12ddc11be4f84 100644
--- a/lldb/include/lldb/Host/Socket.h
+++ b/lldb/include/lldb/Host/Socket.h
@@ -103,9 +103,9 @@ class Socket : public IOObject {
   bool IsValid() const override { return m_socket != kInvalidSocketValue; }
   WaitableHandle GetWaitableHandle() override;
 
-  static bool DecodeHostAndPort(llvm::StringRef host_and_port,
-                                std::string &host_str, std::string &port_str,
-                                int32_t &port, Status *error_ptr);
+  static llvm::Error DecodeHostAndPort(llvm::StringRef host_and_port,
+                                       std::string &host_str,
+                                       std::string &port_str, uint16_t &port);
 
   // If this Socket is connected then return the URI used to connect.
   virtual std::string GetRemoteConnectionURI() const { return ""; };

diff  --git a/lldb/source/Host/common/Socket.cpp b/lldb/source/Host/common/Socket.cpp
index d1c327dcb7905..eb2495b1c0e9e 100644
--- a/lldb/source/Host/common/Socket.cpp
+++ b/lldb/source/Host/common/Socket.cpp
@@ -11,11 +11,9 @@
 #include "lldb/Host/Config.h"
 #include "lldb/Host/Host.h"
 #include "lldb/Host/SocketAddress.h"
-#include "lldb/Host/StringConvert.h"
 #include "lldb/Host/common/TCPSocket.h"
 #include "lldb/Host/common/UDPSocket.h"
 #include "lldb/Utility/Log.h"
-#include "lldb/Utility/RegularExpression.h"
 
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/Support/Errno.h"
@@ -172,17 +170,17 @@ Socket::TcpListen(llvm::StringRef host_and_port, bool child_processes_inherit,
   Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_CONNECTION));
   LLDB_LOG(log, "host_and_port = {0}", host_and_port);
 
-  Status 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.ToError();
+  uint16_t port;
+  if (llvm::Error decode_error =
+          DecodeHostAndPort(host_and_port, host_str, port_str, port))
+    return decode_error;
 
   std::unique_ptr<TCPSocket> listen_socket(
       new TCPSocket(true, child_processes_inherit));
 
-  error = listen_socket->Listen(host_and_port, backlog);
+  Status error = listen_socket->Listen(host_and_port, backlog);
   if (error.Fail())
     return error.ToError();
 
@@ -272,47 +270,33 @@ Status Socket::UnixAbstractAccept(llvm::StringRef name,
   return error;
 }
 
-bool Socket::DecodeHostAndPort(llvm::StringRef host_and_port,
-                               std::string &host_str, std::string &port_str,
-                               int32_t &port, Status *error_ptr) {
-  static RegularExpression g_regex(
-      llvm::StringRef("([^:]+|\\[[0-9a-fA-F:]+.*\\]):([0-9]+)"));
+llvm::Error Socket::DecodeHostAndPort(llvm::StringRef host_and_port,
+                                      std::string &host_str,
+                                      std::string &port_str, uint16_t &port) {
+  static llvm::Regex g_regex("([^:]+|\\[[0-9a-fA-F:]+.*\\]):([0-9]+)");
   llvm::SmallVector<llvm::StringRef, 3> matches;
-  if (g_regex.Execute(host_and_port, &matches)) {
+  if (g_regex.match(host_and_port, &matches)) {
     host_str = matches[1].str();
     port_str = matches[2].str();
     // IPv6 addresses are wrapped in [] when specified with ports
     if (host_str.front() == '[' && host_str.back() == ']')
       host_str = host_str.substr(1, host_str.size() - 2);
-    bool ok = false;
-    port = StringConvert::ToUInt32(port_str.c_str(), UINT32_MAX, 10, &ok);
-    if (ok && port <= UINT16_MAX) {
-      if (error_ptr)
-        error_ptr->Clear();
-      return true;
+    if (to_integer(matches[2], port, 10))
+      return llvm::Error::success();
+  } else {
+    // 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();
+    if (to_integer(host_and_port, port, 10)) {
+      port_str = host_and_port.str();
+      return llvm::Error::success();
     }
-    // port is too large
-    if (error_ptr)
-      error_ptr->SetErrorStringWithFormat(
-          "invalid host:port specification: '%s'", host_and_port.str().c_str());
-    return false;
-  }
-
-  // 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();
-  if (to_integer(host_and_port, port, 10) && port < UINT16_MAX) {
-    port_str = std::string(host_and_port);
-    if (error_ptr)
-      error_ptr->Clear();
-    return true;
   }
 
-  if (error_ptr)
-    error_ptr->SetErrorStringWithFormat("invalid host:port specification: '%s'",
-                                        host_and_port.str().c_str());
-  return false;
+  return llvm::createStringError(llvm::inconvertibleErrorCode(),
+                                 "invalid host:port specification: '%s'",
+                                 host_and_port.str().c_str());
 }
 
 IOObject::WaitableHandle Socket::GetWaitableHandle() {

diff  --git a/lldb/source/Host/common/TCPSocket.cpp b/lldb/source/Host/common/TCPSocket.cpp
index ea7377edbd454..d7051718db432 100644
--- a/lldb/source/Host/common/TCPSocket.cpp
+++ b/lldb/source/Host/common/TCPSocket.cpp
@@ -156,9 +156,10 @@ Status TCPSocket::Connect(llvm::StringRef name) {
   Status error;
   std::string host_str;
   std::string port_str;
-  int32_t port = INT32_MIN;
-  if (!DecodeHostAndPort(name, host_str, port_str, port, &error))
-    return error;
+  uint16_t port;
+  if (llvm::Error decode_error =
+          DecodeHostAndPort(name, host_str, port_str, port))
+    return Status(std::move(decode_error));
 
   std::vector<SocketAddress> addresses = SocketAddress::GetAddressInfo(
       host_str.c_str(), nullptr, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
@@ -192,9 +193,10 @@ Status TCPSocket::Listen(llvm::StringRef name, int backlog) {
   Status error;
   std::string host_str;
   std::string port_str;
-  int32_t port = INT32_MIN;
-  if (!DecodeHostAndPort(name, host_str, port_str, port, &error))
-    return error;
+  uint16_t port;
+  if (llvm::Error decode_error =
+          DecodeHostAndPort(name, host_str, port_str, port))
+    return Status(std::move(decode_error));
 
   if (host_str == "*")
     host_str = "0.0.0.0";

diff  --git a/lldb/source/Host/common/UDPSocket.cpp b/lldb/source/Host/common/UDPSocket.cpp
index 0b537b3a9b131..de4f4f2206c54 100644
--- a/lldb/source/Host/common/UDPSocket.cpp
+++ b/lldb/source/Host/common/UDPSocket.cpp
@@ -63,9 +63,10 @@ UDPSocket::Connect(llvm::StringRef name, bool child_processes_inherit) {
   Status error;
   std::string host_str;
   std::string port_str;
-  int32_t port = INT32_MIN;
-  if (!DecodeHostAndPort(name, host_str, port_str, port, &error))
-    return error.ToError();
+  uint16_t port;
+  if (llvm::Error decode_error =
+          DecodeHostAndPort(name, host_str, port_str, port))
+    return decode_error;
 
   // At this point we have setup the receive port, now we need to setup the UDP
   // send socket

diff  --git a/lldb/tools/lldb-server/Acceptor.cpp b/lldb/tools/lldb-server/Acceptor.cpp
index b8be9c5c26617..16ecc542cd47f 100644
--- a/lldb/tools/lldb-server/Acceptor.cpp
+++ b/lldb/tools/lldb-server/Acceptor.cpp
@@ -96,9 +96,10 @@ std::unique_ptr<Acceptor> Acceptor::Create(StringRef name,
   } else {
     std::string host_str;
     std::string port_str;
-    int32_t port = INT32_MIN;
+    uint16_t port;
     // Try to match socket name as $host:port - e.g., localhost:5555
-    if (Socket::DecodeHostAndPort(name, host_str, port_str, port, nullptr))
+    if (!llvm::errorToBool(
+            Socket::DecodeHostAndPort(name, host_str, port_str, port)))
       socket_protocol = Socket::ProtocolTcp;
   }
 

diff  --git a/lldb/unittests/Host/SocketTest.cpp b/lldb/unittests/Host/SocketTest.cpp
index 5593b7726919b..6b9fb42b4b166 100644
--- a/lldb/unittests/Host/SocketTest.cpp
+++ b/lldb/unittests/Host/SocketTest.cpp
@@ -10,6 +10,7 @@
 #include "TestingSupport/SubsystemRAII.h"
 #include "lldb/Host/Config.h"
 #include "lldb/Utility/UriParser.h"
+#include "llvm/Testing/Support/Error.h"
 #include "gtest/gtest.h"
 
 using namespace lldb_private;
@@ -34,67 +35,63 @@ class SocketTest : public testing::TestWithParam<SocketTestParams> {
 TEST_P(SocketTest, DecodeHostAndPort) {
   std::string host_str;
   std::string port_str;
-  int32_t port;
-  Status error;
-  EXPECT_TRUE(Socket::DecodeHostAndPort("localhost:1138", host_str, port_str,
-                                        port, &error));
+  uint16_t port;
+
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("localhost:1138", host_str, port_str, port),
+      llvm::Succeeded());
   EXPECT_STREQ("localhost", host_str.c_str());
   EXPECT_STREQ("1138", port_str.c_str());
   EXPECT_EQ(1138, port);
-  EXPECT_TRUE(error.Success());
-
-  EXPECT_FALSE(Socket::DecodeHostAndPort("google.com:65536", host_str, port_str,
-                                         port, &error));
-  EXPECT_TRUE(error.Fail());
-  EXPECT_STREQ("invalid host:port specification: 'google.com:65536'",
-               error.AsCString());
-
-  EXPECT_FALSE(Socket::DecodeHostAndPort("google.com:-1138", host_str, port_str,
-                                         port, &error));
-  EXPECT_TRUE(error.Fail());
-  EXPECT_STREQ("invalid host:port specification: 'google.com:-1138'",
-               error.AsCString());
-
-  EXPECT_FALSE(Socket::DecodeHostAndPort("google.com:65536", host_str, port_str,
-                                         port, &error));
-  EXPECT_TRUE(error.Fail());
-  EXPECT_STREQ("invalid host:port specification: 'google.com:65536'",
-               error.AsCString());
-
-  EXPECT_TRUE(
-      Socket::DecodeHostAndPort("12345", host_str, port_str, port, &error));
+
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("google.com:65536", host_str, port_str, port),
+      llvm::FailedWithMessage(
+          "invalid host:port specification: 'google.com:65536'"));
+
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("google.com:-1138", host_str, port_str, port),
+      llvm::FailedWithMessage(
+          "invalid host:port specification: 'google.com:-1138'"));
+
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("google.com:65536", host_str, port_str, port),
+      llvm::FailedWithMessage(
+          "invalid host:port specification: 'google.com:65536'"));
+
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("12345", host_str, port_str, port),
+      llvm::Succeeded());
   EXPECT_STREQ("", host_str.c_str());
   EXPECT_STREQ("12345", port_str.c_str());
   EXPECT_EQ(12345, port);
-  EXPECT_TRUE(error.Success());
 
-  EXPECT_TRUE(
-      Socket::DecodeHostAndPort("*:0", host_str, port_str, port, &error));
+  EXPECT_THAT_ERROR(Socket::DecodeHostAndPort("*:0", host_str, port_str, port),
+                    llvm::Succeeded());
   EXPECT_STREQ("*", host_str.c_str());
   EXPECT_STREQ("0", port_str.c_str());
   EXPECT_EQ(0, port);
-  EXPECT_TRUE(error.Success());
 
-  EXPECT_TRUE(
-      Socket::DecodeHostAndPort("*:65535", host_str, port_str, port, &error));
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("*:65535", host_str, port_str, port),
+      llvm::Succeeded());
   EXPECT_STREQ("*", host_str.c_str());
   EXPECT_STREQ("65535", port_str.c_str());
   EXPECT_EQ(65535, port);
-  EXPECT_TRUE(error.Success());
 
-  EXPECT_TRUE(
-      Socket::DecodeHostAndPort("[::1]:12345", host_str, port_str, port, &error));
+  EXPECT_THAT_ERROR(
+      Socket::DecodeHostAndPort("[::1]:12345", host_str, port_str, port),
+      llvm::Succeeded());
   EXPECT_STREQ("::1", host_str.c_str());
   EXPECT_STREQ("12345", port_str.c_str());
   EXPECT_EQ(12345, port);
-  EXPECT_TRUE(error.Success());
 
-  EXPECT_TRUE(
-      Socket::DecodeHostAndPort("[abcd:12fg:AF58::1]:12345", host_str, port_str, port, &error));
+  EXPECT_THAT_ERROR(Socket::DecodeHostAndPort("[abcd:12fg:AF58::1]:12345",
+                                              host_str, port_str, port),
+                    llvm::Succeeded());
   EXPECT_STREQ("abcd:12fg:AF58::1", host_str.c_str());
   EXPECT_STREQ("12345", port_str.c_str());
   EXPECT_EQ(12345, port);
-  EXPECT_TRUE(error.Success());
 }
 
 #if LLDB_ENABLE_POSIX


        


More information about the lldb-commits mailing list