This is an automated email from the ASF dual-hosted git repository.
laiyingchun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus.git
The following commit(s) were added to refs/heads/master by this push:
new 3f55ed619 refactor(host_port): Unify the hostname lookup function
(#2023)
3f55ed619 is described below
commit 3f55ed6196df2d15093894e0b06352c1b1c4c10c
Author: Yingchun Lai <[email protected]>
AuthorDate: Mon May 27 11:58:59 2024 +0800
refactor(host_port): Unify the hostname lookup function (#2023)
Move lookup_hostname() from utils/utils.h to rpc_host_port, and remove the
use
less addr2host() in src/base/pegasus_utils.h
There is no functionality changes.
---
src/base/pegasus_utils.cpp | 21 ----------
src/base/pegasus_utils.h | 9 +----
src/runtime/rpc/rpc_host_port.cpp | 39 ++++++++++++++++--
src/runtime/rpc/rpc_host_port.h | 4 ++
src/runtime/test/host_port_test.cpp | 17 ++++++++
src/utils/test/hostname_test.cpp | 42 -------------------
src/utils/utils.cpp | 80 -------------------------------------
src/utils/utils.h | 15 -------
8 files changed, 57 insertions(+), 170 deletions(-)
diff --git a/src/base/pegasus_utils.cpp b/src/base/pegasus_utils.cpp
index e0859fe3d..d0cd36034 100644
--- a/src/base/pegasus_utils.cpp
+++ b/src/base/pegasus_utils.cpp
@@ -19,35 +19,14 @@
#include "pegasus_utils.h"
-#include <arpa/inet.h>
-#include <netdb.h>
-#include <netinet/in.h>
#include <stdio.h>
-#include <sys/socket.h>
#include <cctype>
-#include "runtime/rpc/rpc_address.h"
#include "utils/fmt_logging.h"
namespace pegasus {
namespace utils {
-void addr2host(const ::dsn::rpc_address &addr, char *str, int len /* = 100*/)
-{
- struct sockaddr_in addr2;
- addr2.sin_addr.s_addr = htonl(addr.ip());
- addr2.sin_family = AF_INET;
- if (getnameinfo((struct sockaddr *)&addr2,
- sizeof(sockaddr),
- str,
- sizeof(char *) * len,
- nullptr,
- 0,
- NI_NAMEREQD)) {
- inet_ntop(AF_INET, &(addr2.sin_addr), str, 100);
- }
-}
-
size_t
c_escape_string(const char *src, size_t src_len, char *dest, size_t dest_len,
bool always_escape)
{
diff --git a/src/base/pegasus_utils.h b/src/base/pegasus_utils.h
index 0df0bee3e..a6ea381f7 100644
--- a/src/base/pegasus_utils.h
+++ b/src/base/pegasus_utils.h
@@ -28,15 +28,11 @@
#include <string>
#include <vector>
-#include "utils/flags.h"
#include "absl/strings/string_view.h"
+#include "utils/flags.h"
DSN_DECLARE_bool(encrypt_data_at_rest);
-namespace dsn {
-class rpc_address;
-} // namespace dsn
-
namespace pegasus {
namespace utils {
@@ -45,9 +41,6 @@ const uint32_t epoch_begin = 1451606400;
inline uint32_t epoch_now() { return time(nullptr) - epoch_begin; }
const static std::string kRedactedString = "<redacted>";
-// extract "host" from rpc_address
-void addr2host(const ::dsn::rpc_address &addr, char *str, int len);
-
template <typename elem_type, typename compare = std::less<elem_type>>
class top_n
{
diff --git a/src/runtime/rpc/rpc_host_port.cpp
b/src/runtime/rpc/rpc_host_port.cpp
index 01a047417..1e8583da6 100644
--- a/src/runtime/rpc/rpc_host_port.cpp
+++ b/src/runtime/rpc/rpc_host_port.cpp
@@ -18,6 +18,7 @@
*/
#include <arpa/inet.h>
+#include <errno.h>
#include <netdb.h>
#include <netinet/in.h>
#include <sys/socket.h>
@@ -32,9 +33,9 @@
#include "utils/api_utilities.h"
#include "utils/error_code.h"
#include "utils/ports.h"
+#include "utils/safe_strerror_posix.h"
#include "utils/string_conv.h"
#include "utils/timer.h"
-#include "utils/utils.h"
namespace dsn {
@@ -57,9 +58,9 @@ host_port host_port::from_address(rpc_address addr)
WARNING, 100, "construct host_port '{}' from rpc_address '{}'", hp,
addr);
switch (addr.type()) {
case HOST_TYPE_IPV4: {
- CHECK(utils::hostname_from_ip(htonl(addr.ip()), &hp._host),
- "invalid host_port {}",
- addr.ipv4_str());
+ CHECK_OK(lookup_hostname(htonl(addr.ip()), &hp._host),
+ "lookup_hostname failed for {}",
+ addr.ipv4_str());
hp._port = addr.port();
} break;
case HOST_TYPE_GROUP: {
@@ -216,4 +217,34 @@ error_s
host_port::resolve_addresses(std::vector<rpc_address> &addresses) const
return error_s::ok();
}
+error_s host_port::lookup_hostname(uint32_t ip, std::string *hostname)
+{
+ struct sockaddr_in addr_in;
+ addr_in.sin_family = AF_INET;
+ addr_in.sin_port = 0;
+ addr_in.sin_addr.s_addr = ip;
+ char host[NI_MAXHOST];
+ int rc = ::getnameinfo((struct sockaddr *)(&addr_in),
+ sizeof(struct sockaddr),
+ host,
+ sizeof(host),
+ nullptr,
+ 0,
+ NI_NAMEREQD);
+ if (dsn_unlikely(rc != 0)) {
+ if (rc == EAI_SYSTEM) {
+ return error_s::make(dsn::ERR_NETWORK_FAILURE,
+ fmt::format("{}: {}: getnameinfo failed",
+ gai_strerror(rc),
+
dsn::utils::safe_strerror(errno)));
+ }
+
+ return error_s::make(dsn::ERR_NETWORK_FAILURE,
+ fmt::format("{}: getnameinfo failed",
gai_strerror(rc)));
+ }
+
+ *hostname = host;
+ return error_s::ok();
+}
+
} // namespace dsn
diff --git a/src/runtime/rpc/rpc_host_port.h b/src/runtime/rpc/rpc_host_port.h
index 67fae8843..2a643bb4e 100644
--- a/src/runtime/rpc/rpc_host_port.h
+++ b/src/runtime/rpc/rpc_host_port.h
@@ -313,6 +313,7 @@ public:
private:
friend class dns_resolver;
friend class rpc_group_host_port;
+ FRIEND_TEST(host_port_test, lookup_hostname);
FRIEND_TEST(host_port_test, transfer_rpc_address);
static const host_port s_invalid_host_port;
@@ -321,6 +322,9 @@ private:
// There may be multiple rpc_addresses for one host_port.
error_s resolve_addresses(std::vector<rpc_address> &addresses) const;
+ // Does reverse DNS lookup of the address and stores it in hostname.
+ static error_s lookup_hostname(uint32_t ip, std::string *hostname);
+
std::string _host;
uint16_t _port = 0;
dsn_host_type_t _type = HOST_TYPE_INVALID;
diff --git a/src/runtime/test/host_port_test.cpp
b/src/runtime/test/host_port_test.cpp
index a6e7334cf..b64622189 100644
--- a/src/runtime/test/host_port_test.cpp
+++ b/src/runtime/test/host_port_test.cpp
@@ -17,7 +17,9 @@
* under the License.
*/
+#include <arpa/inet.h> // IWYU pragma: keep
#include <fmt/core.h>
+#include <netinet/in.h>
#include <map>
#include <memory>
#include <string>
@@ -262,6 +264,21 @@ TEST(host_port_test, thrift_parser)
send_and_check_host_port_by_serialize(hp2, DSF_THRIFT_JSON);
}
+TEST(host_port_test, lookup_hostname)
+{
+ const std::string valid_ip = "127.0.0.1";
+ const std::string expected_hostname = "localhost";
+
+ const auto rpc_example_valid = rpc_address::from_ip_port(valid_ip, 23010);
+ std::string hostname;
+ auto es = host_port::lookup_hostname(htonl(rpc_example_valid.ip()),
&hostname);
+ ASSERT_TRUE(es.is_ok()) << es.description();
+ ASSERT_EQ(expected_hostname, hostname);
+
+ es = host_port::lookup_hostname(12321, &hostname);
+ ASSERT_FALSE(es.is_ok());
+}
+
TEST(host_port_test, test_macros)
{
static const host_port kHp1("localhost", 8081);
diff --git a/src/utils/test/hostname_test.cpp b/src/utils/test/hostname_test.cpp
deleted file mode 100644
index 29c94aa2d..000000000
--- a/src/utils/test/hostname_test.cpp
+++ /dev/null
@@ -1,42 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-#include <netinet/in.h>
-#include <string>
-
-#include "gtest/gtest.h"
-#include "runtime/rpc/rpc_address.h"
-#include "utils/utils.h"
-
-namespace dsn {
-namespace replication {
-
-TEST(ip_to_hostname, localhost)
-{
- const std::string valid_ip = "127.0.0.1";
- const std::string expected_hostname = "localhost";
-
- const auto rpc_example_valid = rpc_address::from_ip_port(valid_ip, 23010);
-
- // bool hostname_from_ip(uint32_t ip, std::string *hostname_result)
- std::string hostname_result;
- ASSERT_TRUE(dsn::utils::hostname_from_ip(htonl(rpc_example_valid.ip()),
&hostname_result));
- ASSERT_EQ(expected_hostname, hostname_result);
-}
-
-} // namespace replication
-} // namespace dsn
diff --git a/src/utils/utils.cpp b/src/utils/utils.cpp
deleted file mode 100644
index 749933ffe..000000000
--- a/src/utils/utils.cpp
+++ /dev/null
@@ -1,80 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 Microsoft Corporation
- *
- * -=- Robust Distributed System Nucleus (rDSN) -=-
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-
-#include "utils/utils.h"
-
-#include <arpa/inet.h>
-#include <errno.h>
-#include <netdb.h>
-#include <netinet/in.h>
-#include <string.h>
-#include <sys/socket.h>
-#include <memory>
-
-#include "utils/fmt_logging.h"
-
-#if defined(__linux__)
-#elif defined(__FreeBSD__)
-#include <sys/thr.h>
-#elif defined(__APPLE__)
-#include <pthread.h>
-#endif
-
-namespace dsn {
-namespace utils {
-
-bool hostname_from_ip(uint32_t ip, std::string *hostname_result)
-{
- struct sockaddr_in addr_in;
- addr_in.sin_family = AF_INET;
- addr_in.sin_port = 0;
- addr_in.sin_addr.s_addr = ip;
- char hostname[256];
- int err = getnameinfo((struct sockaddr *)(&addr_in),
- sizeof(struct sockaddr),
- hostname,
- sizeof(hostname),
- nullptr,
- 0,
- NI_NAMEREQD);
- if (err != 0) {
- struct in_addr net_addr;
- net_addr.s_addr = ip;
- char ip_str[256];
- inet_ntop(AF_INET, &net_addr, ip_str, sizeof(ip_str));
- if (err == EAI_SYSTEM) {
- LOG_WARNING("got error {} when try to resolve {}",
strerror(errno), ip_str);
- } else {
- LOG_WARNING("return error({}) when try to resolve {}",
gai_strerror(err), ip_str);
- }
- return false;
- } else {
- *hostname_result = std::string(hostname);
- return true;
- }
-}
-} // namespace utils
-} // namespace dsn
diff --git a/src/utils/utils.h b/src/utils/utils.h
index d8e90c961..3b97c9a1b 100644
--- a/src/utils/utils.h
+++ b/src/utils/utils.h
@@ -67,21 +67,6 @@ std::shared_ptr<T> make_shared_array(size_t size)
return std::shared_ptr<T>(new T[size], std::default_delete<T[]>());
}
-// get host name from ip series
-// if can't get a hostname from ip(maybe no hostname or other errors), return
false, and
-// hostname_result will be invalid value
-// if multiple hostname got and all of them are resolvable return true,
otherwise return false.
-// and the hostname_result will be "hostname1,hostname2(or ip_address or )..."
-// we only support ipv4 currently
-// check if a.b.c.d:port can be resolved to hostname:port. If it can be
resolved, return true
-// and hostname_result
-// will be the hostname, or it will be ip address or error message
-
-// TODO(yingchun): Consider to move it to rpc_address.
-// valid_ip_network_order -> return TRUE && hostname_result=hostname |
-// invalid_ip_network_order -> return FALSE
-bool hostname_from_ip(uint32_t ip, std::string *hostname_result);
-
template <typename A, typename B>
std::multimap<B, A> flip_map(const std::map<A, B> &source)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
