Implemented send & receive timeouts in fbclient

Author: AlexPeshkoff

src/include/firebird/impl/consts_pub.h

@@ -138,6 +138,8 @@
 #define isc_dpb_search_path				 105
 #define isc_dpb_blr_request_search_path	 106
 #define isc_dpb_gbak_restore_has_schema	 107
+#define isc_dpb_send_timeout             108
+#define isc_dpb_receive_timeout          109
 
 
 /**************************************************/
@@ -329,6 +331,8 @@
 #define isc_spb_os_user                   122
 #define isc_spb_config					  123
 #define isc_spb_expected_db				  124
+#define isc_spb_send_timeout			  125
+#define isc_spb_receive_timeout			  126
 
 #define isc_spb_connect_timeout           isc_dpb_connect_timeout
 #define isc_spb_dummy_packet_interval     isc_dpb_dummy_packet_interval

src/include/gen/Firebird.pas

@@ -4341,6 +4341,8 @@ 	IPerformanceStatsImpl = class(IPerformanceStats)
 	isc_dpb_search_path = byte(105);
 	isc_dpb_blr_request_search_path = byte(106);
 	isc_dpb_gbak_restore_has_schema = byte(107);
+	isc_dpb_send_timeout = byte(108);
+	isc_dpb_receive_timeout = byte(109);
 	isc_dpb_address = byte(1);
 	isc_dpb_addr_protocol = byte(1);
 	isc_dpb_addr_endpoint = byte(2);
@@ -4432,6 +4434,8 @@ 	IPerformanceStatsImpl = class(IPerformanceStats)
 	isc_spb_os_user = byte(122);
 	isc_spb_config = byte(123);
 	isc_spb_expected_db = byte(124);
+	isc_spb_send_timeout = byte(125);
+	isc_spb_receive_timeout = byte(126);
 	isc_action_svc_backup = byte(1);
 	isc_action_svc_restore = byte(2);
 	isc_action_svc_repair = byte(3);

src/remote/client/interface.cpp

@@ -7988,7 +7988,7 @@ static rem_port* analyze(ClntAuthBlock& cBlock, PathName& attach_name, unsigned
 			{
 				ISC_utf8ToSystem(node_name);
 				port = INET_analyze(&cBlock, attach_name, node_name.c_str(), flags & ANALYZE_USER_VFY, pb,
-					cBlock.getConfig(), ref_db_name, cryptCb, AF_UNIX);
+					&parSet, cBlock.getConfig(), ref_db_name, cryptCb, AF_UNIX);
 			}
 			else
 #endif
@@ -8011,7 +8011,7 @@ static rem_port* analyze(ClntAuthBlock& cBlock, PathName& attach_name, unsigned
 				}
 
 				port = INET_analyze(&cBlock, attach_name, node_name.c_str(), flags & ANALYZE_USER_VFY, pb,
-					cBlock.getConfig(), ref_db_name, cryptCb, inet_af);
+					&parSet, cBlock.getConfig(), ref_db_name, cryptCb, inet_af);
 			}
 
 			// We have a local connection string. If it's a file on a network share,
@@ -8028,7 +8028,7 @@ static rem_port* analyze(ClntAuthBlock& cBlock, PathName& attach_name, unsigned
 						ISC_utf8ToSystem(node_name);
 
 						port = INET_analyze(&cBlock, expanded_name, node_name.c_str(), flags & ANALYZE_USER_VFY, pb,
-							cBlock.getConfig(), ref_db_name, cryptCb);
+							&parSet, cBlock.getConfig(), ref_db_name, cryptCb);
 					}
 				}
 #endif
@@ -8043,7 +8043,7 @@ static rem_port* analyze(ClntAuthBlock& cBlock, PathName& attach_name, unsigned
 						ISC_utf8ToSystem(node_name);
 
 						port = INET_analyze(&cBlock, expanded_name, node_name.c_str(), flags & ANALYZE_USER_VFY, pb,
-							cBlock.getConfig(), ref_db_name, cryptCb);
+							&parSet, cBlock.getConfig(), ref_db_name, cryptCb);
 					}
 				}
 #endif
@@ -8066,7 +8066,7 @@ static rem_port* analyze(ClntAuthBlock& cBlock, PathName& attach_name, unsigned
 					if (!port)
 					{
 						port = INET_analyze(&cBlock, attach_name, INET_LOCALHOST, flags & ANALYZE_USER_VFY, pb,
-							cBlock.getConfig(), ref_db_name, cryptCb);
+							&parSet, cBlock.getConfig(), ref_db_name, cryptCb);
 					}
 				}
 			}

src/remote/inet.cpp

@@ -77,6 +77,9 @@
 #include <unistd.h>
 #endif
 
+#ifdef HAVE_SYS_TIME_H
+#include <sys/time.h>
+#endif
 
 
 #ifdef	WIN_NT
@@ -632,6 +635,7 @@ static rem_port*		inet_try_connect(	PACKET*,
 									const PathName&,
 									const TEXT*,
 									ClumpletReader&,
+									const ParametersSet*,
 									RefPtr<const Config>*,
 									const PathName*,
 									int);
@@ -657,7 +661,7 @@ static int		send_partial(rem_port*, PACKET *);
 
 static RemoteXdr*		xdrinet_create(rem_port*, UCHAR *, USHORT, enum xdr_op);
 static bool		setNoNagleOption(rem_port*);
-static bool		setKeepAlive(SOCKET);
+static bool		setKeepAlive(SOCKET, rem_port* = nullptr);
 static FPTR_INT	tryStopMainThread = 0;
 
 
@@ -797,6 +801,7 @@ rem_port* INET_analyze(ClntAuthBlock* cBlock,
 					   const TEXT* node_name,
 					   bool uv_flag,
 					   ClumpletReader &dpb,
+					   const ParametersSet* par,
 					   RefPtr<const Config>* config,
 					   const PathName* ref_db_name,
 					   ICryptKeyCallback* cryptCb,
@@ -900,7 +905,7 @@ rem_port* INET_analyze(ClntAuthBlock* cBlock,
 		}
 	}
 
-	rem_port* port = inet_try_connect(packet, rdb, file_name, node_name, dpb, config, ref_db_name, af);
+	rem_port* port = inet_try_connect(packet, rdb, file_name, node_name, dpb, par, config, ref_db_name, af);
 	P_ACPT* accept;
 
 	for (;;)
@@ -1032,6 +1037,7 @@ rem_port* INET_connect(const TEXT* name,
 					   PACKET* packet,
 					   USHORT flag,
 					   ClumpletReader* dpb,
+					   const ParametersSet* par,
 					   RefPtr<const Config>* config,
 					   int af,
 					   bool disableTcp)
@@ -1069,7 +1075,7 @@ rem_port* INET_connect(const TEXT* name,
 	{
 		port->port_config = *config;
 	}
-	REMOTE_get_timeout_params(port, dpb);
+	REMOTE_get_timeout_params(port, dpb, par);
 
 	const RefPtr<const Config> portConfig = port->getPortConfig();
 	const bool explicitTcpPort = !packet && name && name[0];
@@ -1225,7 +1231,7 @@ rem_port* INET_connect(const TEXT* name,
 			return listener_socket(port, flag, pai);
 
 		// client
-		if (!setKeepAlive(port->port_handle))
+		if (!setKeepAlive(port->port_handle, port))
 			gds__log("setsockopt: error setting SO_KEEPALIVE");
 
 		if (!setNoNagleOption(port))
@@ -1553,7 +1559,7 @@ static rem_port* listener_socket(rem_port* port, USHORT flag, const addrinfo* pa
 	}
 	else
 	{
-		if (! setKeepAlive(port->port_handle))
+		if (! setKeepAlive(port->port_handle, port))
 		{
 			inet_error(true, port, "setsockopt SO_KEEPALIVE", isc_net_connect_listen_err, INET_ERRNO);
 		}
@@ -1701,7 +1707,7 @@ rem_port* INET_reconnect(SOCKET handle, bool unixSocket)
 	else
 #endif
 	{
-		if (! setKeepAlive(port->port_handle)) {
+		if (! setKeepAlive(port->port_handle, port)) {
 			gds__log("inet server err: setting KEEPALIVE socket option \n");
 		}
 
@@ -1731,7 +1737,7 @@ rem_port* INET_server(SOCKET sock)
 	port->port_server_flags |= SRVR_server;
 	port->port_handle = sock;
 
-	if (! setKeepAlive(port->port_handle)) {
+	if (! setKeepAlive(port->port_handle, port)) {
 		gds__log("inet server err: setting KEEPALIVE socket option \n");
 	}
 
@@ -1870,7 +1876,7 @@ static rem_port* alloc_port(rem_port* const parent, const USHORT flags)
 	}
 
 	rem_port* const port = FB_NEW rem_port(rem_port::INET, INET_remote_buffer * 2);
-	REMOTE_get_timeout_params(port, 0);
+	REMOTE_get_timeout_params(port, nullptr, nullptr);
 
 	TEXT buffer[BUFFER_SMALL];
 	gethostname(buffer, sizeof(buffer));
@@ -3397,6 +3403,7 @@ static rem_port* inet_try_connect(PACKET* packet,
 								  const PathName& file_name,
 								  const TEXT* node_name,
 								  ClumpletReader& dpb,
+								  const ParametersSet* par,
 								  RefPtr<const Config>* config,
 								  const PathName* ref_db_name,
 								  int af)
@@ -3431,7 +3438,7 @@ static rem_port* inet_try_connect(PACKET* packet,
 	rem_port* port = NULL;
 	try
 	{
-		port = INET_connect(node_name, packet, false, &dpb, config, af);
+		port = INET_connect(node_name, packet, false, &dpb, par, config, af);
 	}
 	catch (const Exception&)
 	{
@@ -3534,21 +3541,26 @@ static bool packet_receive(rem_port* port, UCHAR* buffer, SSHORT buffer_length,
 	}
 
 	timeval timeout{};
-	timeval* time_ptr = NULL;
+	timeval* time_ptr = &timeout;
 
-	if (port->port_protocol == 0)
+	if (port->port_protocol == 0 && port->port_connect_timeout)
 	{
 		// If the protocol is 0 we are still in the process of establishing
 		// a connection. Add a time out to the wait.
 		timeout.tv_sec = port->port_connect_timeout;
-		time_ptr = &timeout;
+	}
+	else if (port->port_receive_timeout)
+	{
+		// Should stop waiting and report error
+		timeout.tv_sec = port->port_receive_timeout;
 	}
 	else if (port->port_dummy_packet_interval > 0)
 	{
 		// Set the time interval for sending dummy packets to the client
 		timeout.tv_sec = port->port_dummy_packet_interval;
-		time_ptr = &timeout;
 	}
+	else
+		time_ptr = nullptr;
 
 	// On Linux systems (and possibly others too) select will eventually
 	// change timout values so save it here for later reuse.
@@ -3623,7 +3635,7 @@ static bool packet_receive(rem_port* port, UCHAR* buffer, SSHORT buffer_length,
 
 			if (!slct_count)
 			{
-				if (port->port_protocol == 0)
+				if (port->port_protocol == 0 || port->port_receive_timeout)
 					return false;
 
 #ifdef DEBUG
@@ -3905,7 +3917,19 @@ static bool setNoNagleOption(rem_port* port)
 	return true;
 }
 
-static bool setKeepAlive(SOCKET s)
+static bool setTimeout(SOCKET s, int timeout, int optname)
+{
+#ifdef WIN_NT
+	DWORD tv = timeout * 1000;
+#else
+	struct timeval tv;
+	tv.tv_sec = timeout;
+	tv.tv_usec = 0;
+#endif
+	return setsockopt(s, SOL_SOCKET, optname, &tv, sizeof(tv)) >= 0;
+}
+
+static bool setKeepAlive(SOCKET s, rem_port* port)
 {
 /**************************************
  *
@@ -3914,14 +3938,32 @@ static bool setKeepAlive(SOCKET s)
  **************************************
  *
  * Functional description
- *      Set SO_KEEPALIVE, return false
- *		in case of unexpected error
+ *      Set SO_KEEPALIVE, SO_SNDTIMEO & SO_RCVTIMEO,
+ *		return false in case of unexpected error.
  *
  **************************************/
 	constexpr int optval = 1;
 	const int n = setsockopt(s, SOL_SOCKET, SO_KEEPALIVE,
 					   (SCHAR*) &optval, sizeof(optval));
-	return n != -1;
+	if (n < 0)
+		return false;
+
+	if (port)
+	{
+		if (port->port_send_timeout)
+		{
+			if (!setTimeout(s, port->port_send_timeout, SO_SNDTIMEO))
+				return false;
+		}
+
+		if (port->port_receive_timeout)
+		{
+			if (!setTimeout(s, port->port_receive_timeout, SO_RCVTIMEO))
+				return false;
+		}
+	}
+
+	return true;
 }
 
 void setStopMainThread(FPTR_INT func)

src/remote/inet_proto.h

@@ -33,12 +33,14 @@ namespace Firebird
 	class ClumpletReader;
 }
 
-rem_port*	INET_analyze(ClntAuthBlock*, const Firebird::PathName&, const TEXT*,
-						 bool, Firebird::ClumpletReader&, Firebird::RefPtr<const Firebird::Config>*,
+struct ParametersSet;
+
+rem_port*	INET_analyze(ClntAuthBlock*, const Firebird::PathName&, const TEXT*, bool,
+						 Firebird::ClumpletReader&, const ParametersSet*, Firebird::RefPtr<const Firebird::Config>*,
 						 const Firebird::PathName*, Firebird::ICryptKeyCallback*, int af = AF_UNSPEC);
 rem_port*	INET_connect(const TEXT*, struct packet*, USHORT, Firebird::ClumpletReader*,
-						 Firebird::RefPtr<const Firebird::Config>*, int af = AF_UNSPEC,
-						 bool disableTcp = false);
+						 const ParametersSet* par, Firebird::RefPtr<const Firebird::Config>*,
+						 int af = AF_UNSPEC, bool disableTcp = false);
 bool		INET_shouldListenUnix(const TEXT*, bool disableTcp);
 rem_port*	INET_listenUnix(USHORT);
 void		INET_addUnixListener(rem_port*, USHORT);

src/remote/remot_proto.h

@@ -49,14 +49,15 @@ struct RemoteXdr : public xdr_t
 
 struct rem_fmt;
 struct Rdb;
+struct ParametersSet;
 typedef bool PacketReceive(rem_port*, UCHAR*, SSHORT, SSHORT*);
 typedef bool PacketSend(rem_port*, const SCHAR*, SSHORT);
 typedef bool ProtoWrite(RemoteXdr*);
 enum LegacyPlugin {PLUGIN_NEW = 0, PLUGIN_LEGACY, PLUGIN_TRUSTED};
 
 void		REMOTE_cleanup_transaction (struct Rtr *);
 USHORT		REMOTE_compute_batch_size(const rem_port*, USHORT, P_OP, const rem_fmt*) noexcept;
-void		REMOTE_get_timeout_params(rem_port* port, Firebird::ClumpletReader* pb);
+void		REMOTE_get_timeout_params(rem_port* port, Firebird::ClumpletReader* pb, const ParametersSet* par);
 struct Rrq*	REMOTE_find_request (struct Rrq *, USHORT);
 void		REMOTE_free_packet(rem_port*, PACKET*, bool = false);
 struct rem_str*	REMOTE_make_string (const SCHAR*);

src/remote/remote.cpp

@@ -72,7 +72,10 @@ const ParametersSet dpbParam =
 	isc_dpb_os_user,
 	isc_dpb_config,
 	isc_dpb_utf8_filename,
-	isc_dpb_map_attach
+	isc_dpb_map_attach,
+	isc_dpb_connect_timeout,
+	isc_dpb_send_timeout,
+	isc_dpb_receive_timeout
 };
 
 const ParametersSet spbParam =
@@ -96,7 +99,10 @@ const ParametersSet spbParam =
 	isc_spb_os_user,
 	isc_spb_config,
 	isc_spb_utf8_filename,
-	0
+	0,
+	isc_spb_connect_timeout,
+	isc_spb_send_timeout,
+	isc_spb_receive_timeout
 };
 
 const ParametersSet connectParam =
@@ -120,6 +126,9 @@ const ParametersSet connectParam =
 	CNCT_user,
 	0,
 	0,
+	0,
+	0,
+	0,
 	0
 };
 
@@ -352,7 +361,7 @@ void REMOTE_free_packet(rem_port* port, PACKET* packet, bool partial)
 }
 
 
-void REMOTE_get_timeout_params(rem_port* port, ClumpletReader* pb)
+void REMOTE_get_timeout_params(rem_port* port, ClumpletReader* pb, const ParametersSet* par)
 {
 /**************************************
  *
@@ -368,13 +377,12 @@ void REMOTE_get_timeout_params(rem_port* port, ClumpletReader* pb)
  *	is no other specification.
  *
  **************************************/
-	//bool got_dpb_connect_timeout = false;
-
-	fb_assert(isc_dpb_connect_timeout == isc_spb_connect_timeout);
-
-	port->port_connect_timeout = pb && pb->find(isc_dpb_connect_timeout) ?
+	port->port_connect_timeout = pb && pb->find(par->connect_timeout) ?
 		pb->getInt() : port->getPortConfig()->getConnectionTimeout();
 
+	port->port_send_timeout = pb && pb->find(par->send_timeout) ? pb->getInt() : 0;
+	port->port_receive_timeout = pb && pb->find(par->receive_timeout) ? pb->getInt() : 0;
+
 	port->port_flags |= PORT_dummy_pckt_set;
 	port->port_dummy_packet_interval = port->getPortConfig()->getDummyPacketInterval();
 	if (port->port_dummy_packet_interval < 0)