mirror of
https://github.com/curl/curl.git
synced 2026-04-14 13:01:42 +08:00
Further testing with timeouts in event based processing revealed that our current shutdown handling in the connection pool was not clear enough. Graceful shutdowns can only happen inside a multi handle and it was confusing to track in the code which situation actually applies. It seems better to split the shutdown handling off and have that code always be part of a multi handle. Add `cshutdn.[ch]` with its own struct to maintain connections being shut down. A `cshutdn` always belongs to a multi handle and uses that for socket/timeout monitoring. The `cpool`, which can be part of a multi or share, either passes connections to a `cshutdn` or terminates them with a one-time, best effort. Add an `admin` easy handle to each multi and share. This is used to perform all maintenance operations where no "real" easy handle is available. This solves the problem that the multi admin handle requires some additional initialisation (e.g. timeout list). The share needs its admin handle as it is often cleaned up when no other transfer or multi handle exists any more. But we need a `data` in almost every call. Fix file:// handling of errors when adding a new connection to the pool. Changes in `curl` itself: - for parallel transfers, do not set a connection pool in the share, rely on the multi's connection pool instead. While not a requirement for the new `cshutdn` to work, this is a) helpful in testing to trigger graceful shutdowns b) a broader code coverage of libcurl via the curl tool - on test_event with uv, cleanup the multi handle before returning from parallel_event(). The uv struct is on the stack, cleanup of the multi later will crash when it tries to register sockets. This is a "eat your own dogfood" related fix. Closes #16508
153 lines
5.9 KiB
C
153 lines
5.9 KiB
C
#ifndef HEADER_CURL_CONNECT_H
|
|
#define HEADER_CURL_CONNECT_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* 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
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
#include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */
|
|
#include "sockaddr.h"
|
|
#include "timeval.h"
|
|
|
|
struct Curl_dns_entry;
|
|
struct ip_quadruple;
|
|
|
|
enum alpnid Curl_alpn2alpnid(const char *name, size_t len);
|
|
|
|
/* generic function that returns how much time there is left to run, according
|
|
to the timeouts set */
|
|
timediff_t Curl_timeleft(struct Curl_easy *data,
|
|
struct curltime *nowp,
|
|
bool duringconnect);
|
|
|
|
#define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */
|
|
|
|
#define DEFAULT_SHUTDOWN_TIMEOUT_MS (2 * 1000)
|
|
|
|
void Curl_shutdown_start(struct Curl_easy *data, int sockindex,
|
|
int timeout_ms, struct curltime *nowp);
|
|
|
|
/* return how much time there is left to shutdown the connection at
|
|
* sockindex. Returns 0 if there is no limit or shutdown has not started. */
|
|
timediff_t Curl_shutdown_timeleft(struct connectdata *conn, int sockindex,
|
|
struct curltime *nowp);
|
|
|
|
/* return how much time there is left to shutdown the connection.
|
|
* Returns 0 if there is no limit or shutdown has not started. */
|
|
timediff_t Curl_conn_shutdown_timeleft(struct connectdata *conn,
|
|
struct curltime *nowp);
|
|
|
|
void Curl_shutdown_clear(struct Curl_easy *data, int sockindex);
|
|
|
|
/* TRUE iff shutdown has been started */
|
|
bool Curl_shutdown_started(struct Curl_easy *data, int sockindex);
|
|
|
|
/*
|
|
* Used to extract socket and connectdata struct for the most recent
|
|
* transfer on the given Curl_easy.
|
|
*
|
|
* The returned socket will be CURL_SOCKET_BAD in case of failure!
|
|
*/
|
|
curl_socket_t Curl_getconnectinfo(struct Curl_easy *data,
|
|
struct connectdata **connp);
|
|
|
|
bool Curl_addr2string(struct sockaddr *sa, curl_socklen_t salen,
|
|
char *addr, int *port);
|
|
|
|
/*
|
|
* Curl_conncontrol() marks the end of a connection/stream. The 'closeit'
|
|
* argument specifies if it is the end of a connection or a stream.
|
|
*
|
|
* For stream-based protocols (such as HTTP/2), a stream close will not cause
|
|
* a connection close. Other protocols will close the connection for both
|
|
* cases.
|
|
*
|
|
* It sets the bit.close bit to TRUE (with an explanation for debug builds),
|
|
* when the connection will close.
|
|
*/
|
|
|
|
#define CONNCTRL_KEEP 0 /* undo a marked closure */
|
|
#define CONNCTRL_CONNECTION 1
|
|
#define CONNCTRL_STREAM 2
|
|
|
|
void Curl_conncontrol(struct connectdata *conn,
|
|
int closeit
|
|
#if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
|
|
, const char *reason
|
|
#endif
|
|
);
|
|
|
|
#if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
|
|
#define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y)
|
|
#define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y)
|
|
#define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y)
|
|
#else /* if !DEBUGBUILD || CURL_DISABLE_VERBOSE_STRINGS */
|
|
#define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM)
|
|
#define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION)
|
|
#define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP)
|
|
#endif
|
|
|
|
/**
|
|
* Create a cfilter for making an "ip" connection to the
|
|
* given address, using parameters from `conn`. The "ip" connection
|
|
* can be a TCP socket, a UDP socket or even a QUIC connection.
|
|
*
|
|
* It MUST use only the supplied `ai` for its connection attempt.
|
|
*
|
|
* Such a filter may be used in "happy eyeball" scenarios, and its
|
|
* `connect` implementation needs to support non-blocking. Once connected,
|
|
* it MAY be installed in the connection filter chain to serve transfers.
|
|
*/
|
|
typedef CURLcode cf_ip_connect_create(struct Curl_cfilter **pcf,
|
|
struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
const struct Curl_addrinfo *ai,
|
|
int transport);
|
|
|
|
CURLcode Curl_cf_setup_insert_after(struct Curl_cfilter *cf_at,
|
|
struct Curl_easy *data,
|
|
const struct Curl_dns_entry *remotehost,
|
|
int transport,
|
|
int ssl_mode);
|
|
|
|
/**
|
|
* Setup the cfilters at `sockindex` in connection `conn`.
|
|
* If no filter chain is installed yet, inspects the configuration
|
|
* in `data` and `conn? to install a suitable filter chain.
|
|
*/
|
|
CURLcode Curl_conn_setup(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
int sockindex,
|
|
const struct Curl_dns_entry *remotehost,
|
|
int ssl_mode);
|
|
|
|
extern struct Curl_cftype Curl_cft_happy_eyeballs;
|
|
extern struct Curl_cftype Curl_cft_setup;
|
|
|
|
#ifdef UNITTESTS
|
|
void Curl_debug_set_transport_provider(int transport,
|
|
cf_ip_connect_create *cf_create);
|
|
#endif
|
|
|
|
#endif /* HEADER_CURL_CONNECT_H */
|