c9b95c0bb3
When libcurl discards a connection there are two phases this may go through: "shutdown" and "closing". If a connection is aborted, the shutdown phase is skipped and it is closed right away. The connection filters attached to the connection implement the phases in their `do_shutdown()` and `do_close()` callbacks. Filters carry now a `shutdown` flags next to `connected` to keep track of the shutdown operation. Filters are shut down from top to bottom. If a filter is not connected, its shutdown is skipped. Notable filters that *do* something during shutdown are HTTP/2 and TLS. HTTP/2 sends the GOAWAY frame. TLS sends its close notify and expects to receive a close notify from the server. As sends and receives may EAGAIN on the network, a shutdown is often not successful right away and needs to poll the connection's socket(s). To facilitate this, such connections are placed on a new shutdown list inside the connection cache. Since managing this list requires the cooperation of a multi handle, only the connection cache belonging to a multi handle is used. If a connection was in another cache when being discarded, it is removed there and added to the multi's cache. If no multi handle is available at that time, the connection is shutdown and closed in a one-time, best-effort attempt. When a multi handle is destroyed, all connection still on the shutdown list are discarded with a final shutdown attempt and close. In curl debug builds, the environment variable `CURL_GRACEFUL_SHUTDOWN` can be set to make this graceful with a timeout in milliseconds given by the variable. The shutdown list is limited to the max number of connections configured for a multi cache. Set via CURLMOPT_MAX_TOTAL_CONNECTIONS. When the limit is reached, the oldest connection on the shutdown list is discarded. - In multi_wait() and multi_waitfds(), collect all connection caches involved (each transfer might carry its own) into a temporary list. Let each connection cache on the list contribute sockets and POLLIN/OUT events it's connections are waiting for. - in multi_perform() collect the connection caches the same way and let them peform their maintenance. This will make another non-blocking attempt to shutdown all connections on its shutdown list. - for event based multis (multi->socket_cb set), add the sockets and their poll events via the callback. When `multi_socket()` is invoked for a socket not known by an active transfer, forward this to the multi's cache for processing. On closing a connection, remove its socket(s) via the callback. TLS connection filters MUST NOT send close nofity messages in their `do_close()` implementation. The reason is that a TLS close notify signals a success. When a connection is aborted and skips its shutdown phase, the server needs to see a missing close notify to detect something has gone wrong. A graceful shutdown of FTP's data connection is performed implicitly before regarding the upload/download as complete and continuing on the control connection. For FTP without TLS, there is just the socket close happening. But with TLS, the sent/received close notify signals that the transfer is complete and healthy. Servers like `vsftpd` verify that and reject uploads without a TLS close notify. - added test_19_* for shutdown related tests - test_19_01 and test_19_02 test for TCP RST packets which happen without a graceful shutdown and should no longer appear otherwise. - add test_19_03 for handling shutdowns by the server - add test_19_04 for handling shutdowns by curl - add test_19_05 for event based shutdowny by server - add test_30_06/07 and test_31_06/07 for shutdown checks on FTP up- and downloads. Closes #13976
157 lines
6.6 KiB
Python
157 lines
6.6 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
#
|
|
# This software is licensed as described in the file COPYING, which
|
|
# you should have received as part of this distribution. The terms
|
|
# are also available at https://curl.se/docs/copyright.html.
|
|
#
|
|
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
# copies of the Software, and permit persons to whom the Software is
|
|
# furnished to do so, under the terms of the COPYING file.
|
|
#
|
|
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
# KIND, either express or implied.
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
#
|
|
###########################################################################
|
|
#
|
|
import difflib
|
|
import filecmp
|
|
import logging
|
|
import os
|
|
import re
|
|
from datetime import timedelta
|
|
import pytest
|
|
|
|
from testenv import Env, CurlClient, LocalClient
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class TestShutdown:
|
|
|
|
@pytest.fixture(autouse=True, scope='class')
|
|
def _class_scope(self, env, httpd, nghttpx):
|
|
if env.have_h3():
|
|
nghttpx.start_if_needed()
|
|
httpd.clear_extra_configs()
|
|
httpd.reload()
|
|
|
|
@pytest.fixture(autouse=True, scope='class')
|
|
def _class_scope(self, env, httpd):
|
|
indir = httpd.docs_dir
|
|
env.make_data_file(indir=indir, fname="data-10k", fsize=10*1024)
|
|
env.make_data_file(indir=indir, fname="data-100k", fsize=100*1024)
|
|
env.make_data_file(indir=indir, fname="data-1m", fsize=1024*1024)
|
|
|
|
# check with `tcpdump` that we see curl TCP RST packets
|
|
@pytest.mark.skipif(condition=not Env.tcpdump(), reason="tcpdump not available")
|
|
@pytest.mark.parametrize("proto", ['http/1.1'])
|
|
def test_19_01_check_tcp_rst(self, env: Env, httpd, repeat, proto):
|
|
if env.ci_run:
|
|
pytest.skip("seems not to work in CI")
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-1]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, with_tcpdump=True, extra_args=[
|
|
'--parallel'
|
|
])
|
|
r.check_response(http_status=200, count=2)
|
|
assert r.tcpdump
|
|
assert len(r.tcpdump.stats) != 0, f'Expected TCP RSTs packets: {r.tcpdump.stderr}'
|
|
|
|
# check with `tcpdump` that we do NOT see TCP RST when CURL_GRACEFUL_SHUTDOWN set
|
|
@pytest.mark.skipif(condition=not Env.tcpdump(), reason="tcpdump not available")
|
|
@pytest.mark.parametrize("proto", ['http/1.1', 'h2'])
|
|
def test_19_02_check_shutdown(self, env: Env, httpd, repeat, proto):
|
|
if not env.curl_is_debug():
|
|
pytest.skip('only works for curl debug builds')
|
|
curl = CurlClient(env=env, run_env={
|
|
'CURL_GRACEFUL_SHUTDOWN': '2000',
|
|
'CURL_DEBUG': 'ssl'
|
|
})
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-1]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, with_tcpdump=True, extra_args=[
|
|
'--parallel'
|
|
])
|
|
r.check_response(http_status=200, count=2)
|
|
assert r.tcpdump
|
|
assert len(r.tcpdump.stats) == 0, f'Unexpected TCP RSTs packets'
|
|
|
|
# run downloads where the server closes the connection after each request
|
|
@pytest.mark.parametrize("proto", ['http/1.1'])
|
|
def test_19_03_shutdown_by_server(self, env: Env, httpd, repeat, proto):
|
|
if not env.curl_is_debug():
|
|
pytest.skip('only works for curl debug builds')
|
|
count = 10
|
|
curl = CurlClient(env=env, run_env={
|
|
'CURL_GRACEFUL_SHUTDOWN': '2000',
|
|
'CURL_DEBUG': 'ssl'
|
|
})
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/tweak/?'\
|
|
f'id=[0-{count-1}]&with_cl&close'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto)
|
|
r.check_response(http_status=200, count=count)
|
|
shutdowns = [l for l in r.trace_lines if re.match(r'.*CCACHE\] shutdown #\d+, done=1', l)]
|
|
assert len(shutdowns) == count, f'{shutdowns}'
|
|
|
|
# run downloads with CURLOPT_FORBID_REUSE set, meaning *we* close
|
|
# the connection after each request
|
|
@pytest.mark.parametrize("proto", ['http/1.1'])
|
|
def test_19_04_shutdown_by_curl(self, env: Env, httpd, proto, repeat):
|
|
if not env.curl_is_debug():
|
|
pytest.skip('only works for curl debug builds')
|
|
count = 10
|
|
docname = 'data.json'
|
|
url = f'https://localhost:{env.https_port}/{docname}'
|
|
client = LocalClient(name='h2-download', env=env, run_env={
|
|
'CURL_GRACEFUL_SHUTDOWN': '2000',
|
|
'CURL_DEBUG': 'ssl'
|
|
})
|
|
if not client.exists():
|
|
pytest.skip(f'example client not built: {client.name}')
|
|
r = client.run(args=[
|
|
'-n', f'{count}', '-f', '-V', proto, url
|
|
])
|
|
r.check_exit_code(0)
|
|
shutdowns = [l for l in r.trace_lines if re.match(r'.*CCACHE\] shutdown #\d+, done=1', l)]
|
|
assert len(shutdowns) == count, f'{shutdowns}'
|
|
|
|
# run event-based downloads with CURLOPT_FORBID_REUSE set, meaning *we* close
|
|
# the connection after each request
|
|
@pytest.mark.parametrize("proto", ['http/1.1'])
|
|
def test_19_05_event_shutdown_by_server(self, env: Env, httpd, proto, repeat):
|
|
if not env.curl_is_debug():
|
|
pytest.skip('only works for curl debug builds')
|
|
count = 10
|
|
curl = CurlClient(env=env, run_env={
|
|
# forbid connection reuse to trigger shutdowns after transfer
|
|
'CURL_FORBID_REUSE': '1',
|
|
# make socket receives block 50% of the time to delay shutdown
|
|
'CURL_DBG_SOCK_RBLOCK': '50',
|
|
'CURL_DEBUG': 'ssl'
|
|
})
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/tweak/?'\
|
|
f'id=[0-{count-1}]&with_cl&'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--test-event'
|
|
])
|
|
r.check_response(http_status=200, count=count)
|
|
# check that we closed all connections
|
|
closings = [l for l in r.trace_lines if re.match(r'.*CCACHE\] closing #\d+', l)]
|
|
assert len(closings) == count, f'{closings}'
|
|
# check that all connection sockets were removed from event
|
|
removes = [l for l in r.trace_lines if re.match(r'.*socket cb: socket \d+ REMOVED', l)]
|
|
assert len(removes) == count, f'{removes}'
|
|
|
|
|