updated to support SO_BINDTODEVICE and bind client_host.

Author: wenjiecn

src/brpc/channel.cpp

@@ -77,6 +77,7 @@ ChannelSSLOptions* ChannelOptions::mutable_ssl_options() {
 static ChannelSignature ComputeChannelSignature(const ChannelOptions& opt) {
     if (opt.auth == NULL &&
         !opt.has_ssl_options() &&
+        opt.client_host.empty() &&
         opt.device_name.empty() &&
         opt.connection_group.empty() &&
         opt.hc_option.health_check_path.empty()) {
@@ -95,6 +96,10 @@ static ChannelSignature ComputeChannelSignature(const ChannelOptions& opt) {
             buf.append("|conng=");
             buf.append(opt.connection_group);
         }
+        if (!opt.client_host.empty()) {
+            buf.append("|clih=");
+            buf.append(opt.client_host);
+        }
         if (!opt.device_name.empty()) {
             buf.append("|devn=");
             buf.append(opt.device_name);
@@ -367,6 +372,13 @@ int Channel::InitSingle(const butil::EndPoint& server_addr_and_port,
         LOG(ERROR) << "Invalid port=" << port;
         return -1;
     }
+    butil::EndPoint client_endpoint;
+    if (!_options.client_host.empty() &&
+        butil::str2ip(_options.client_host.c_str(), &client_endpoint.ip) != 0 &&
+        butil::hostname2ip(_options.client_host.c_str(), &client_endpoint.ip) != 0) {
+        LOG(ERROR) << "Invalid client host=`" << _options.client_host << '\'';
+        return -1;
+    }
     _server_address = server_addr_and_port;
     const ChannelSignature sig = ComputeChannelSignature(_options);
     std::shared_ptr<SocketSSLContext> ssl_ctx;
@@ -375,7 +387,8 @@ int Channel::InitSingle(const butil::EndPoint& server_addr_and_port,
     }
     if (SocketMapInsert(SocketMapKey(server_addr_and_port, sig),
                         &_server_id, ssl_ctx, _options.use_rdma,
-                        _options.hc_option, _options.device_name) != 0) {
+                        _options.hc_option, client_endpoint,
+                        _options.device_name) != 0) {
         LOG(ERROR) << "Fail to insert into SocketMap";
         return -1;
     }
@@ -403,6 +416,13 @@ int Channel::Init(const char* ns_url,
             _options.mutable_ssl_options()->sni_name = _service_name;
         }
     }
+    butil::EndPoint client_endpoint;
+    if (!_options.client_host.empty() &&
+        butil::str2ip(_options.client_host.c_str(), &client_endpoint.ip) != 0 &&
+        butil::hostname2ip(_options.client_host.c_str(), &client_endpoint.ip) != 0) {
+        LOG(ERROR) << "Invalid client host=`" << _options.client_host << '\'';
+        return -1;
+    }
     std::unique_ptr<LoadBalancerWithNaming> lb(new (std::nothrow)
                                                    LoadBalancerWithNaming);
     if (NULL == lb) {
@@ -415,6 +435,7 @@ int Channel::Init(const char* ns_url,
     ns_opt.use_rdma = _options.use_rdma;
     ns_opt.channel_signature = ComputeChannelSignature(_options);
     ns_opt.hc_option =  _options.hc_option;
+    ns_opt.client_endpoint = client_endpoint;
     ns_opt.device_name = _options.device_name;
     if (CreateSocketSSLContext(_options, &ns_opt.ssl_ctx) != 0) {
         return -1;

src/brpc/channel.h

@@ -149,6 +149,11 @@ struct ChannelOptions {
     // When it is not set, FLAGS_health_check_path and FLAGS_health_check_timeout_ms will take effect.
     HealthCheckOption hc_option;
 
+    // IP address or host name of the client.
+    // if the client_host is "", the client IP address is determined by the OS.
+    // Default: ""
+    std::string client_host;
+
     // The device name of the client's network adapter.
     // if the device_name is "", the flow control is determined by the OS.
     // Default: ""

src/brpc/details/naming_service_thread.cpp

@@ -127,6 +127,7 @@ void NamingServiceThread::Actions::ResetServers(
         const SocketMapKey key(_added[i], _owner->_options.channel_signature);
         CHECK_EQ(0, SocketMapInsert(key, &tagged_id.id, _owner->_options.ssl_ctx,
                                     _owner->_options.use_rdma, _owner->_options.hc_option,
+                                    _owner->_options.client_endpoint,
                                     _owner->_options.device_name));
         _added_sockets.push_back(tagged_id);
     }

src/brpc/details/naming_service_thread.h

@@ -53,6 +53,7 @@ struct GetNamingServiceThreadOptions {
     HealthCheckOption hc_option;
     ChannelSignature channel_signature;
     std::shared_ptr<SocketSSLContext> ssl_ctx;
+    butil::EndPoint client_endpoint;
     std::string device_name;
 };
 

src/brpc/socket.cpp

@@ -728,7 +728,7 @@ int Socket::OnCreated(const SocketOptions& options) {
     _keytable_pool = options.keytable_pool;
     _tos = 0;
     _remote_side = options.remote_side;
-    _local_side = butil::EndPoint();
+    _local_side = options.local_side;
     _device_name = options.device_name;
     _on_edge_triggered_events = options.on_edge_triggered_events;
     _user = options.user;
@@ -1305,6 +1305,17 @@ int Socket::Connect(const timespec* abstime,
             return -1;
         }
     }
+    if (local_side().ip != butil::IP_ANY) {
+        struct sockaddr_storage cli_addr;
+        if (butil::endpoint2sockaddr(local_side(), &cli_addr, &addr_size) != 0) {
+            PLOG(ERROR) << "Fail to get client sockaddr";
+            return -1;
+        }
+        if (::bind(sockfd, (struct sockaddr*)&cli_addr, addr_size) != 0) {
+            PLOG(ERROR) << "Fail to bind client socket, errno=" << strerror(errno);
+            return -1;
+        }
+    }
     const int rc = ::connect(
         sockfd, (struct sockaddr*)&serv_addr, addr_size);
     if (rc != 0 && errno != EINPROGRESS) {
@@ -2819,6 +2830,7 @@ int Socket::GetPooledSocket(SocketUniquePtr* pooled_socket) {
     if (socket_pool == NULL) {
         SocketOptions opt;
         opt.remote_side = remote_side();
+        opt.local_side = butil::EndPoint(local_side().ip, 0);
         opt.user = user();
         opt.on_edge_triggered_events = _on_edge_triggered_events;
         opt.initial_ssl_ctx = _ssl_ctx;
@@ -2920,6 +2932,7 @@ int Socket::GetShortSocket(SocketUniquePtr* short_socket) {
     SocketId id;
     SocketOptions opt;
     opt.remote_side = remote_side();
+    opt.local_side = butil::EndPoint(local_side().ip, 0);
     opt.user = user();
     opt.on_edge_triggered_events = _on_edge_triggered_events;
     opt.initial_ssl_ctx = _ssl_ctx;

src/brpc/socket.h

@@ -250,6 +250,7 @@ struct SocketOptions {
     // user->BeforeRecycle() before recycling.
     int fd{-1};
     butil::EndPoint remote_side;
+    butil::EndPoint local_side;
     std::string device_name;
     // If `connect_on_create' is true and `fd' is less than 0,
     // a client connection will be established to remote_side()

src/brpc/socket_map.cpp

@@ -93,8 +93,9 @@ int SocketMapInsert(const SocketMapKey& key, SocketId* id,
                     const std::shared_ptr<SocketSSLContext>& ssl_ctx,
                     bool use_rdma,
                     const HealthCheckOption& hc_option,
+                    const butil::EndPoint& client_endpoint,
                     const std::string& device_name) {
-    return get_or_new_client_side_socket_map()->Insert(key, id, ssl_ctx, use_rdma, hc_option, device_name);
+    return get_or_new_client_side_socket_map()->Insert(key, id, ssl_ctx, use_rdma, hc_option, client_endpoint, device_name);
 }    
 
 int SocketMapFind(const SocketMapKey& key, SocketId* id) {
@@ -231,6 +232,7 @@ int SocketMap::Insert(const SocketMapKey& key, SocketId* id,
                       const std::shared_ptr<SocketSSLContext>& ssl_ctx,
                       bool use_rdma,
                       const HealthCheckOption& hc_option,
+                      const butil::EndPoint& client_endpoint,
                       const std::string& device_name) {
     ShowSocketMapInBvarIfNeed();
 
@@ -253,6 +255,7 @@ int SocketMap::Insert(const SocketMapKey& key, SocketId* id,
     SocketId tmp_id;
     SocketOptions opt;
     opt.remote_side = key.peer.addr;
+    opt.local_side = client_endpoint;
     opt.device_name = device_name;
     opt.initial_ssl_ctx = ssl_ctx;
     opt.use_rdma = use_rdma;

src/brpc/socket_map.h

@@ -83,18 +83,21 @@ int SocketMapInsert(const SocketMapKey& key, SocketId* id,
                     const std::shared_ptr<SocketSSLContext>& ssl_ctx,
                     bool use_rdma,
                     const HealthCheckOption& hc_option,
+                    const butil::EndPoint& client_endpoint,
                     const std::string& device_name);
 
 inline int SocketMapInsert(const SocketMapKey& key, SocketId* id,
                     const std::shared_ptr<SocketSSLContext>& ssl_ctx) {
     HealthCheckOption hc_option;
-    return SocketMapInsert(key, id, ssl_ctx, false, hc_option, "");
+    butil::EndPoint endpoint;
+    return SocketMapInsert(key, id, ssl_ctx, false, hc_option, endpoint, "");
 }
 
 inline int SocketMapInsert(const SocketMapKey& key, SocketId* id) {
     std::shared_ptr<SocketSSLContext> empty_ptr;
     HealthCheckOption hc_option;
-    return SocketMapInsert(key, id, empty_ptr, false, hc_option, "");
+    butil::EndPoint endpoint;
+    return SocketMapInsert(key, id, empty_ptr, false, hc_option, endpoint, "");
 }
 
 // Find the SocketId associated with `key'.
@@ -157,17 +160,20 @@ class SocketMap {
                const std::shared_ptr<SocketSSLContext>& ssl_ctx,
                bool use_rdma,
                const HealthCheckOption& hc_option,
+               const butil::EndPoint& client_endpoint,
                const std::string& device_name);
 
     int Insert(const SocketMapKey& key, SocketId* id,
                const std::shared_ptr<SocketSSLContext>& ssl_ctx) {
         HealthCheckOption hc_option;
-        return Insert(key, id, ssl_ctx, false, hc_option, "");   
+        butil::EndPoint endpoint;
+        return Insert(key, id, ssl_ctx, false, hc_option, endpoint, "");   
     }
     int Insert(const SocketMapKey& key, SocketId* id) {
         std::shared_ptr<SocketSSLContext> empty_ptr;
         HealthCheckOption hc_option;
-        return Insert(key, id, empty_ptr, false, hc_option, "");
+        butil::EndPoint endpoint;
+        return Insert(key, id, empty_ptr, false, hc_option, endpoint, "");
     }
 
     void Remove(const SocketMapKey& key, SocketId expected_id);

test/brpc_server_unittest.cpp

@@ -2087,7 +2087,7 @@ void TestClientHost(const butil::EndPoint& ep,
     ASSERT_EQ(cntl.ErrorCode(), error_code);
 }
 
-TEST_F(ServerTest, network_device_name) {
+TEST_F(ServerTest, bind_client_host_and_network_device) {
     butil::EndPoint ep;
     ASSERT_EQ(0, str2endpoint("127.0.0.1:8613", &ep));
     brpc::Server server;
@@ -2098,6 +2098,7 @@ TEST_F(ServerTest, network_device_name) {
 
     brpc::Controller cntl;
     brpc::ChannelOptions copt;
+    copt.client_host = "localhost";
     copt.device_name = "lo";
     std::vector<brpc::ConnectionType> connection_types = {
         brpc::CONNECTION_TYPE_SINGLE,