Adding keep_idle config value to socket

User can cofigure KEEPIDLE time for sockets in TCP connection.
The default value is the old value which is 600.

Change-Id: Ib7fb166deb8a87ae4e97ba0671048b1ec079a2ef
Closes-Bug:1759606

doc/manpages/account-server.conf.5

@@ -57,6 +57,8 @@ IP address the account server should bind to. The default is 0.0.0.0 which will
 it bind to all available addresses.
 .IP "\fBbind_port\fR"
 TCP port the account server should bind to. The default is 6202.
+.IP "\fBkeep_idle\fR"
+Value to set for socket TCP_KEEPIDLE. The default value is 600.
 .IP "\fBbind_timeout\fR"
 Timeout to bind socket. The default is 30.
 .IP \fBbacklog\fR

doc/manpages/container-server.conf.5

@@ -57,6 +57,8 @@ IP address the container server should bind to. The default is 0.0.0.0 which wil
 it bind to all available addresses.
 .IP "\fBbind_port\fR"
 TCP port the container server should bind to. The default is 6201.
+.IP "\fBkeep_idle\fR"
+Value to set for socket TCP_KEEPIDLE. The default value is 600.
 .IP "\fBbind_timeout\fR"
 Timeout to bind socket. The default is 30.
 .IP \fBbacklog\fR

doc/manpages/object-server.conf.5

@@ -57,6 +57,8 @@ IP address the object server should bind to. The default is 0.0.0.0 which will m
 it bind to all available addresses.
 .IP "\fBbind_port\fR"
 TCP port the object server should bind to. The default is 6200.
+.IP "\fBkeep_idle\fR"
+Value to set for socket TCP_KEEPIDLE. The default value is 600.
 .IP "\fBbind_timeout\fR"
 Timeout to bind socket. The default is 30.
 .IP \fBbacklog\fR

doc/manpages/proxy-server.conf.5

@@ -56,6 +56,8 @@ IP address the proxy server should bind to. The default is 0.0.0.0 which will ma
 it bind to all available addresses.
 .IP "\fBbind_port\fR"
 TCP port the proxy server should bind to. The default is 80.
+.IP "\fBkeep_idle\fR"
+Value to set for socket TCP_KEEPIDLE. The default value is 600.
 .IP "\fBbind_timeout\fR"
 Timeout to bind socket. The default is 30.
 .IP \fBbacklog\fR

doc/source/deployment_guide.rst

@@ -437,6 +437,7 @@ mount_check                      true        Whether or not check if the devices
                                              to the root device
 bind_ip                          0.0.0.0     IP Address for server to bind to
 bind_port                        6200        Port for server to bind to
+keep_idle                        600         Value to set for socket TCP_KEEPIDLE
 bind_timeout                     30          Seconds to attempt bind before giving up
 backlog                          4096        Maximum number of allowed pending
                                              connections
@@ -1032,6 +1033,7 @@ mount_check                      true        Whether or not check if the devices
                                              to the root device
 bind_ip                          0.0.0.0     IP Address for server to bind to
 bind_port                        6201        Port for server to bind to
+keep_idle                        600         Value to set for socket TCP_KEEPIDLE
 bind_timeout                     30          Seconds to attempt bind before giving up
 backlog                          4096        Maximum number of allowed pending
                                              connections
@@ -1385,6 +1387,7 @@ mount_check                      true        Whether or not check if the devices
                                              to the root device
 bind_ip                          0.0.0.0     IP Address for server to bind to
 bind_port                        6202        Port for server to bind to
+keep_idle                        600         Value to set for socket TCP_KEEPIDLE
 bind_timeout                     30          Seconds to attempt bind before giving up
 backlog                          4096        Maximum number of allowed pending
                                              connections
@@ -1731,6 +1734,7 @@ Option                                Default                   Description
 bind_ip                               0.0.0.0                   IP Address for server to
                                                                 bind to
 bind_port                             80                        Port for server to bind to
+keep_idle                             600                       Value to set for socket TCP_KEEPIDLE
 bind_timeout                          30                        Seconds to attempt bind before
                                                                 giving up
 backlog                               4096                      Maximum number of allowed pending

etc/account-server.conf-sample

@@ -1,6 +1,7 @@
 [DEFAULT]
 # bind_ip = 0.0.0.0
 bind_port = 6202
+# keep_idle = 600
 # bind_timeout = 30
 # backlog = 4096
 # user = swift

etc/container-server.conf-sample

@@ -1,6 +1,7 @@
 [DEFAULT]
 # bind_ip = 0.0.0.0
 bind_port = 6201
+# keep_idle = 600
 # bind_timeout = 30
 # backlog = 4096
 # user = swift

etc/object-server.conf-sample

@@ -1,6 +1,7 @@
 [DEFAULT]
 # bind_ip = 0.0.0.0
 bind_port = 6200
+# keep_idle = 600
 # bind_timeout = 30
 # backlog = 4096
 # user = swift

etc/proxy-server.conf-sample

@@ -1,6 +1,7 @@
 [DEFAULT]
 # bind_ip = 0.0.0.0
 bind_port = 8080
+# keep_idle = 600
 # bind_timeout = 30
 # backlog = 4096
 # swift_dir = /etc/swift

swift/common/wsgi.py

@@ -193,6 +193,14 @@ def get_socket(conf):
     bind_timeout = int(conf.get('bind_timeout', 30))
     retry_until = time.time() + bind_timeout
     warn_ssl = False
+
+    try:
+        keepidle = int(conf.get('keep_idle', 600))
+        if keepidle <= 0 or keepidle >= 2 ** 15 - 1:
+            raise ValueError()
+    except (ValueError, KeyError, TypeError):
+        raise ConfigFileError()
+
     while not sock and time.time() < retry_until:
         try:
             sock = listen(bind_addr, backlog=int(conf.get('backlog', 4096)),
@@ -214,7 +222,7 @@ def get_socket(conf):
     sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
     sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
     if hasattr(socket, 'TCP_KEEPIDLE'):
-        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 600)
+        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, keepidle)
     if warn_ssl:
         ssl_warning_message = _('WARNING: SSL should only be enabled for '
                                 'testing purposes. Use external SSL '

test/unit/common/test_wsgi.py

@@ -404,6 +404,39 @@ class TestWSGI(unittest.TestCase):
                 'keyfile': '',
             }
             self.assertEqual(wsgi.ssl.wrap_socket_called, [expected_kwargs])
+
+            # test keep_idle value
+            keepIdle_value = 700
+            conf['keep_idle'] = keepIdle_value
+            sock = wsgi.get_socket(conf)
+            # assert
+            if hasattr(socket, 'TCP_KEEPIDLE'):
+                expected_socket_opts[socket.IPPROTO_TCP][
+                    socket.TCP_KEEPIDLE] = keepIdle_value
+            self.assertEqual(sock.opts, expected_socket_opts)
+
+            # test keep_idle for str -> int conversion
+            keepIdle_value = '800'
+            conf['keep_idle'] = keepIdle_value
+            sock = wsgi.get_socket(conf)
+            # assert
+            if hasattr(socket, 'TCP_KEEPIDLE'):
+                expected_socket_opts[socket.IPPROTO_TCP][
+                    socket.TCP_KEEPIDLE] = int(keepIdle_value)
+            self.assertEqual(sock.opts, expected_socket_opts)
+
+            # test keep_idle for negative value
+            conf['keep_idle'] = -600
+            self.assertRaises(wsgi.ConfigFileError, wsgi.get_socket, conf)
+
+            # test keep_idle for upperbound value
+            conf['keep_idle'] = 2 ** 15
+            self.assertRaises(wsgi.ConfigFileError, wsgi.get_socket, conf)
+
+            # test keep_idle for Type mismatch
+            conf['keep_idle'] = 'foobar'
+            self.assertRaises(wsgi.ConfigFileError, wsgi.get_socket, conf)
+
         finally:
             wsgi.listen = old_listen
             wsgi.ssl = old_ssl