Added support for TCP fast open used with ADB-S.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -17,6 +17,8 @@ Thin Mode Changes
 #)  Added support for Oracle Database 23c feature that can improve the
     performance of connection creation by reducing the number of round trips
     required for all connections created.
+#)  Added support for Oracle Database 23c feature: use of TCP fast open for
+    clients connecting from within the OCI Cloud network.
 #)  Added support for Easy Connect strings found in tnsnames.ora files.
 #)  Added support for writing UTF-8 encoded bytes to CLOB and NCLOB values and
     writing strings to BLOB values in order to be consistent with what is done

src/oracledb/base_impl.pxd

@@ -349,6 +349,7 @@ cdef class Description(ConnectParamsNode):
         public str pool_boundary
         public uint32_t purity
         public bint ssl_server_dn_match
+        public bint use_tcp_fast_open
         public str ssl_server_cert_dn
         public str wallet_location
         str connection_id

src/oracledb/connect_params.py

@@ -95,6 +95,7 @@ def __init__(
         ssl_context: Any = None,
         sdu: int = 8192,
         pool_boundary: str = None,
+        use_tcp_fast_open: bool = False,
         handle: int = 0,
     ):
         """
@@ -261,6 +262,11 @@ def __init__(
           This requires the use of DRCP with Oracle Database 23.4 or higher
           (default: None)
 
+        - use_tcp_fast_open: boolean indicating whether to use TCP fast open.
+          This is an ADB-S specific property for clients connecting from within
+          OCI Cloud network. Please refer to the ADB-S documentation for more
+          information (default: False)
+
         - handle: an integer representing a pointer to a valid service context
           handle. This value is only used in thick mode. It should be used with
           extreme caution (default: 0)
@@ -306,7 +312,8 @@ def __repr__(self):
             + f"connection_id_prefix={self.connection_id_prefix!r}, "
             + f"ssl_context={self.ssl_context!r}, "
             + f"sdu={self.sdu!r}, "
-            + f"pool_boundary={self.pool_boundary!r}"
+            + f"pool_boundary={self.pool_boundary!r}, "
+            + f"use_tcp_fast_open={self.use_tcp_fast_open!r}"
             + ")"
         )
 
@@ -648,6 +655,16 @@ def user(self) -> str:
         """
         return self._impl.user
 
+    @property
+    @_description_attr
+    def use_tcp_fast_open(self) -> Union[list, bool]:
+        """
+        Boolean indicating whether to use TCP fast open. This is an ADB-S
+        specific property for clients connecting from within OCI Cloud network.
+        Please refer to the ADB-S documentation for more information.
+        """
+        return self._impl.use_tcp_fast_open
+
     @property
     @_description_attr
     def wallet_location(self) -> Union[list, str]:
@@ -737,6 +754,7 @@ def set(
         ssl_context: Any = None,
         sdu: int = None,
         pool_boundary: str = None,
+        use_tcp_fast_open: bool = None,
         handle: int = None,
     ):
         """
@@ -893,6 +911,11 @@ def set(
           indicating when pooled DRCP connections can be returned to the pool.
           This requires the use of DRCP with Oracle Database 23.4 or higher
 
+        - use_tcp_fast_open: boolean indicating whether to use TCP fast open.
+          This is an ADB-S specific property for clients connecting from within
+          OCI Cloud network. Please refer to the ADB-S documentation for more
+          information
+
         - handle: an integer representing a pointer to a valid service context
           handle. This value is only used in thick mode. It should be used with
           extreme caution

src/oracledb/connection.py

@@ -1198,6 +1198,7 @@ def connect(
     ssl_context: Any = None,
     sdu: int = 8192,
     pool_boundary: str = None,
+    use_tcp_fast_open: bool = False,
     handle: int = 0,
 ) -> Connection:
     """
@@ -1384,6 +1385,11 @@ def connect(
       when pooled DRCP connections can be returned to the pool. This requires
       the use of DRCP with Oracle Database 23.4 or higher (default: None)
 
+    - use_tcp_fast_open: boolean indicating whether to use TCP fast open. This
+      is an ADB-S specific property for clients connecting from within OCI
+      Cloud network. Please refer to the ADB-S documentation for more
+      information (default: False)
+
     - handle: an integer representing a pointer to a valid service context
       handle. This value is only used in thick mode. It should be used with
       extreme caution (default: 0)
@@ -1768,6 +1774,7 @@ def connect_async(
     ssl_context: Any = None,
     sdu: int = 8192,
     pool_boundary: str = None,
+    use_tcp_fast_open: bool = False,
     handle: int = 0,
 ) -> AsyncConnection:
     """
@@ -1954,6 +1961,11 @@ def connect_async(
       when pooled DRCP connections can be returned to the pool. This requires
       the use of DRCP with Oracle Database 23.4 or higher (default: None)
 
+    - use_tcp_fast_open: boolean indicating whether to use TCP fast open. This
+      is an ADB-S specific property for clients connecting from within OCI
+      Cloud network. Please refer to the ADB-S documentation for more
+      information (default: False)
+
     - handle: an integer representing a pointer to a valid service context
       handle. This value is only used in thick mode. It should be used with
       extreme caution (default: 0)

src/oracledb/impl/base/connect_params.pyx

@@ -871,6 +871,8 @@ cdef class Description(ConnectParamsNode):
             temp_parts.append(f"(SID={self.sid})")
         if self.server_type is not None:
             temp_parts.append(f"(SERVER={self.server_type})")
+        if self.use_tcp_fast_open:
+            temp_parts.append("(USE_TCP_FAST_OPEN=ON)")
         if self.pool_boundary is not None:
             temp_parts.append(f"(POOL_BOUNDARY={self.pool_boundary})")
         if cid is not None:
@@ -925,6 +927,7 @@ cdef class Description(ConnectParamsNode):
         description.ssl_server_cert_dn = self.ssl_server_cert_dn
         description.wallet_location = self.wallet_location
         description.connection_id_prefix = self.connection_id_prefix
+        description.use_tcp_fast_open = self.use_tcp_fast_open
         return description
 
     def set_from_connect_data_args(self, dict args):
@@ -939,6 +942,7 @@ cdef class Description(ConnectParamsNode):
         _set_purity_param(args, "purity", &self.purity)
         _set_pool_boundary_param(args, "pool_boundary", self)
         _set_str_param(args, "connection_id_prefix", self)
+        _set_bool_param(args, "use_tcp_fast_open", &self.use_tcp_fast_open)
 
     def set_from_description_args(self, dict args):
         """

src/oracledb/impl/thin/protocol.pyx

@@ -218,7 +218,8 @@ cdef class Protocol(BaseProtocol):
         # establish initial TCP connection and get initial connect string
         host = address.host
         port = address.port
-        self._connect_tcp(params, description, address, host, port)
+        self._connect_tcp(params, description, address, host, port,
+                          connect_string)
 
         # send connect message and process response; this may request the
         # message to be resent multiple times; if a redirect packet is
@@ -251,7 +252,8 @@ cdef class Protocol(BaseProtocol):
                 host = temp_address.host
                 port = temp_address.port
                 connect_string = redirect_data[pos + 1:]
-                self._connect_tcp(params, description, address, host, port)
+                self._connect_tcp(params, description, address, host, port,
+                                  connect_string)
                 connect_message = None
                 packet_flags = TNS_PACKET_FLAG_REDIRECT
             elif packet_type == TNS_PACKET_TYPE_ACCEPT:
@@ -325,7 +327,7 @@ cdef class Protocol(BaseProtocol):
 
     cdef int _connect_tcp(self, ConnectParamsImpl params,
                           Description description, Address address, str host,
-                          int port) except -1:
+                          int port, str connect_string) except -1:
         """
         Creates a socket on which to communicate using the provided parameters.
         If a proxy is configured, a connection to the proxy is established and
@@ -347,7 +349,12 @@ cdef class Protocol(BaseProtocol):
             if not use_tcps and (params._token is not None
                     or params.access_token_callback is not None):
                 errors._raise_err(errors.ERR_ACCESS_TOKEN_REQUIRES_TCPS)
-        sock = socket.create_connection(connect_info, timeout)
+        if description.use_tcp_fast_open:
+            sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            sock.sendto(connect_string.encode(), socket.MSG_FASTOPEN,
+                        connect_info)
+        else:
+            sock = socket.create_connection(connect_info, timeout)
 
         # complete connection through proxy, if applicable
         if use_proxy:

src/oracledb/pool.py

@@ -634,6 +634,7 @@ def create_pool(
     ssl_context: Any = None,
     sdu: int = 8192,
     pool_boundary: str = None,
+    use_tcp_fast_open: bool = False,
     handle: int = 0,
 ) -> ConnectionPool:
     """
@@ -866,6 +867,11 @@ def create_pool(
       when pooled DRCP connections can be returned to the pool. This requires
       the use of DRCP with Oracle Database 23.4 or higher (default: None)
 
+    - use_tcp_fast_open: boolean indicating whether to use TCP fast open. This
+      is an ADB-S specific property for clients connecting from within OCI
+      Cloud network. Please refer to the ADB-S documentation for more
+      information (default: False)
+
     - handle: an integer representing a pointer to a valid service context
       handle. This value is only used in thick mode. It should be used with
       extreme caution (default: 0)
@@ -1086,6 +1092,7 @@ def create_pool_async(
     ssl_context: Any = None,
     sdu: int = 8192,
     pool_boundary: str = None,
+    use_tcp_fast_open: bool = False,
     handle: int = 0,
 ) -> AsyncConnectionPool:
     """
@@ -1318,6 +1325,11 @@ def create_pool_async(
       when pooled DRCP connections can be returned to the pool. This requires
       the use of DRCP with Oracle Database 23.4 or higher (default: None)
 
+    - use_tcp_fast_open: boolean indicating whether to use TCP fast open. This
+      is an ADB-S specific property for clients connecting from within OCI
+      Cloud network. Please refer to the ADB-S documentation for more
+      information (default: False)
+
     - handle: an integer representing a pointer to a valid service context
       handle. This value is only used in thick mode. It should be used with
       extreme caution (default: 0)

src/oracledb/pool_params.py

@@ -107,6 +107,7 @@ def __init__(
         ssl_context: Any = None,
         sdu: int = 8192,
         pool_boundary: str = None,
+        use_tcp_fast_open: bool = False,
         handle: int = 0,
     ):
         """
@@ -324,6 +325,11 @@ def __init__(
           This requires the use of DRCP with Oracle Database 23.4 or higher
           (default: None)
 
+        - use_tcp_fast_open: boolean indicating whether to use TCP fast open.
+          This is an ADB-S specific property for clients connecting from within
+          OCI Cloud network. Please refer to the ADB-S documentation for more
+          information (default: False)
+
         - handle: an integer representing a pointer to a valid service context
           handle. This value is only used in thick mode. It should be used with
           extreme caution (default: 0)
@@ -382,7 +388,8 @@ def __repr__(self):
             + f"connection_id_prefix={self.connection_id_prefix!r}, "
             + f"ssl_context={self.ssl_context!r}, "
             + f"sdu={self.sdu!r}, "
-            + f"pool_boundary={self.pool_boundary!r}"
+            + f"pool_boundary={self.pool_boundary!r}, "
+            + f"use_tcp_fast_open={self.use_tcp_fast_open!r}"
             + ")"
         )
 
@@ -562,6 +569,7 @@ def set(
         ssl_context: Any = None,
         sdu: int = None,
         pool_boundary: str = None,
+        use_tcp_fast_open: bool = None,
         handle: int = None,
     ):
         """
@@ -765,6 +773,11 @@ def set(
           indicating when pooled DRCP connections can be returned to the pool.
           This requires the use of DRCP with Oracle Database 23.4 or higher
 
+        - use_tcp_fast_open: boolean indicating whether to use TCP fast open.
+          This is an ADB-S specific property for clients connecting from within
+          OCI Cloud network. Please refer to the ADB-S documentation for more
+          information
+
         - handle: an integer representing a pointer to a valid service context
           handle. This value is only used in thick mode. It should be used with
           extreme caution

tests/test_4500_connect_params.py

@@ -713,6 +713,7 @@ def test_4564(self):
             ("ssl_context", None),
             ("sdu", 16384),
             ("pool_boundary", "statement"),
+            ("use_tcp_fast_open", True),
         ]
         params = oracledb.ConnectParams(**dict(values))
         parts = [f"{name}={value!r}" for name, value in values]

tests/test_4700_pool_params.py

@@ -115,6 +115,7 @@ def test_4701(self):
             ("ssl_context", None),
             ("sdu", 16384),
             ("pool_boundary", "transaction"),
+            ("use_tcp_fast_open", True),
         ]
         params = oracledb.PoolParams(**dict(values))
         parts = [f"{name}={value!r}" for name, value in values]