mirror of
https://github.com/curl/curl.git
synced 2025-03-07 15:27:17 +08:00
1be704e17e
This is a better match for what they do and the general "cpool" var/function prefix works well. The pool now handles very long hostnames correctly. The following changes have been made: * 'struct connectdata', e.g. connections, keep new members named `destination` and ' destination_len' that fully specifies interface+port+hostname of where the connection is going to. This is used in the pool for "bundling" of connections with the same destination. There is no limit on the length any more. * Locking: all locks are done inside conncache.c when calling into the pool and released on return. This eliminates hazards of the callers keeping track. * 'struct connectbundle' is now internal to the pool. It is no longer referenced by a connection. * 'bundle->multiuse' no longer exists. HTTP/2 and 3 and TLS filters no longer need to set it. Instead, the multi checks on leaving MSTATE_CONNECT or MSTATE_CONNECTING if the connection is now multiplexed and new, e.g. not conn->bits.reuse. In that case the processing of pending handles is triggered. * The pool's init is provided with a callback to invoke on all connections being discarded. This allows the cleanups in `Curl_disconnect` to run, wherever it is decided to retire a connection. * Several pool operations can now be fully done with one call. Pruning dead connections, upkeep and checks on pool limits can now directly discard connections and need no longer return those to the caller for doing that (as we have now the callback described above). * Finding a connection for reuse is now done via `Curl_cpool_find()` and the caller provides callbacks to evaluate the connection candidates. * The 'Curl_cpool_check_limits()' now directly uses the max values that may be set in the transfer's multi. No need to pass them around. Curl_multi_max_host_connections() and Curl_multi_max_total_connections() are gone. * Add method 'Curl_node_llist()' to get the llist a node is in. Used in cpool to verify connection are indeed in the list (or not in any list) as they need to. I left the conncache.[ch] as is for now and also did not touch the documentation. If we update that outside the feature window, we can do this in a separate PR. Multi-thread safety is not achieved by this PR, but since more details on how pools operate are now "internal" it is a better starting point to go for this in the future. Closes #14662
190 lines
7.5 KiB
C
190 lines
7.5 KiB
C
#ifndef HEADER_CURL_MULTIHANDLE_H
|
|
#define HEADER_CURL_MULTIHANDLE_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 "llist.h"
|
|
#include "hash.h"
|
|
#include "conncache.h"
|
|
#include "psl.h"
|
|
#include "socketpair.h"
|
|
|
|
struct connectdata;
|
|
|
|
struct Curl_message {
|
|
struct Curl_llist_node list;
|
|
/* the 'CURLMsg' is the part that is visible to the external user */
|
|
struct CURLMsg extmsg;
|
|
};
|
|
|
|
/* NOTE: if you add a state here, add the name to the statename[] array as
|
|
well!
|
|
*/
|
|
typedef enum {
|
|
MSTATE_INIT, /* 0 - start in this state */
|
|
MSTATE_PENDING, /* 1 - no connections, waiting for one */
|
|
MSTATE_SETUP, /* 2 - start a new transfer */
|
|
MSTATE_CONNECT, /* 3 - resolve/connect has been sent off */
|
|
MSTATE_RESOLVING, /* 4 - awaiting the resolve to finalize */
|
|
MSTATE_CONNECTING, /* 5 - awaiting the TCP connect to finalize */
|
|
MSTATE_TUNNELING, /* 6 - awaiting HTTPS proxy SSL initialization to
|
|
complete and/or proxy CONNECT to finalize */
|
|
MSTATE_PROTOCONNECT, /* 7 - initiate protocol connect procedure */
|
|
MSTATE_PROTOCONNECTING, /* 8 - completing the protocol-specific connect
|
|
phase */
|
|
MSTATE_DO, /* 9 - start send off the request (part 1) */
|
|
MSTATE_DOING, /* 10 - sending off the request (part 1) */
|
|
MSTATE_DOING_MORE, /* 11 - send off the request (part 2) */
|
|
MSTATE_DID, /* 12 - done sending off request */
|
|
MSTATE_PERFORMING, /* 13 - transfer data */
|
|
MSTATE_RATELIMITING, /* 14 - wait because limit-rate exceeded */
|
|
MSTATE_DONE, /* 15 - post data transfer operation */
|
|
MSTATE_COMPLETED, /* 16 - operation complete */
|
|
MSTATE_MSGSENT, /* 17 - the operation complete message is sent */
|
|
MSTATE_LAST /* 18 - not a true state, never use this */
|
|
} CURLMstate;
|
|
|
|
/* we support N sockets per easy handle. Set the corresponding bit to what
|
|
action we should wait for */
|
|
#define MAX_SOCKSPEREASYHANDLE 5
|
|
#define GETSOCK_READABLE (0x00ff)
|
|
#define GETSOCK_WRITABLE (0xff00)
|
|
|
|
#define CURLPIPE_ANY (CURLPIPE_MULTIPLEX)
|
|
|
|
#if !defined(CURL_DISABLE_SOCKETPAIR)
|
|
#define ENABLE_WAKEUP
|
|
#endif
|
|
|
|
/* value for MAXIMUM CONCURRENT STREAMS upper limit */
|
|
#define INITIAL_MAX_CONCURRENT_STREAMS ((1U << 31) - 1)
|
|
|
|
/* This is the struct known as CURLM on the outside */
|
|
struct Curl_multi {
|
|
/* First a simple identifier to easier detect if a user mix up
|
|
this multi handle with an easy handle. Set this to CURL_MULTI_HANDLE. */
|
|
unsigned int magic;
|
|
|
|
unsigned int num_easy; /* amount of entries in the linked list above. */
|
|
unsigned int num_alive; /* amount of easy handles that are added but have
|
|
not yet reached COMPLETE state */
|
|
|
|
struct Curl_llist msglist; /* a list of messages from completed transfers */
|
|
|
|
/* Each added easy handle is added to ONE of these three lists */
|
|
struct Curl_llist process; /* not in PENDING or MSGSENT */
|
|
struct Curl_llist pending; /* in PENDING */
|
|
struct Curl_llist msgsent; /* in MSGSENT */
|
|
curl_off_t next_easy_mid; /* next multi-id for easy handle added */
|
|
|
|
/* callback function and user data pointer for the *socket() API */
|
|
curl_socket_callback socket_cb;
|
|
void *socket_userp;
|
|
|
|
/* callback function and user data pointer for server push */
|
|
curl_push_callback push_cb;
|
|
void *push_userp;
|
|
|
|
/* Hostname cache */
|
|
struct Curl_hash hostcache;
|
|
|
|
#ifdef USE_LIBPSL
|
|
/* PSL cache. */
|
|
struct PslCache psl;
|
|
#endif
|
|
|
|
/* timetree points to the splay-tree of time nodes to figure out expire
|
|
times of all currently set timers */
|
|
struct Curl_tree *timetree;
|
|
|
|
/* buffer used for transfer data, lazy initialized */
|
|
char *xfer_buf; /* the actual buffer */
|
|
size_t xfer_buf_len; /* the allocated length */
|
|
/* buffer used for upload data, lazy initialized */
|
|
char *xfer_ulbuf; /* the actual buffer */
|
|
size_t xfer_ulbuf_len; /* the allocated length */
|
|
|
|
/* 'sockhash' is the lookup hash for socket descriptor => easy handles (note
|
|
the pluralis form, there can be more than one easy handle waiting on the
|
|
same actual socket) */
|
|
struct Curl_hash sockhash;
|
|
/* `proto_hash` is a general key-value store for protocol implementations
|
|
* with the lifetime of the multi handle. The number of elements kept here
|
|
* should be in the order of supported protocols (and sub-protocols like
|
|
* TLS), *not* in the order of connections or current transfers!
|
|
* Elements need to be added with their own destructor to be invoked when
|
|
* the multi handle is cleaned up (see Curl_hash_add2()).*/
|
|
struct Curl_hash proto_hash;
|
|
|
|
/* Shared connection cache (bundles)*/
|
|
struct cpool cpool;
|
|
|
|
long max_host_connections; /* if >0, a fixed limit of the maximum number
|
|
of connections per host */
|
|
|
|
long max_total_connections; /* if >0, a fixed limit of the maximum number
|
|
of connections in total */
|
|
long max_shutdown_connections; /* if >0, a fixed limit of the maximum number
|
|
of connections in shutdown handling */
|
|
|
|
/* timer callback and user data pointer for the *socket() API */
|
|
curl_multi_timer_callback timer_cb;
|
|
void *timer_userp;
|
|
long last_timeout_ms; /* the last timeout value set via timer_cb */
|
|
struct curltime last_expire_ts; /* timestamp of last expiry */
|
|
|
|
#ifdef USE_WINSOCK
|
|
WSAEVENT wsa_event; /* Winsock event used for waits */
|
|
#else
|
|
#ifdef ENABLE_WAKEUP
|
|
curl_socket_t wakeup_pair[2]; /* eventfd()/pipe()/socketpair() used for
|
|
wakeup 0 is used for read, 1 is used
|
|
for write */
|
|
#endif
|
|
#endif
|
|
unsigned int max_concurrent_streams;
|
|
unsigned int maxconnects; /* if >0, a fixed limit of the maximum number of
|
|
entries we are allowed to grow the connection
|
|
cache to */
|
|
#define IPV6_UNKNOWN 0
|
|
#define IPV6_DEAD 1
|
|
#define IPV6_WORKS 2
|
|
unsigned char ipv6_up; /* IPV6_* defined */
|
|
BIT(multiplexing); /* multiplexing wanted */
|
|
BIT(recheckstate); /* see Curl_multi_connchanged */
|
|
BIT(in_callback); /* true while executing a callback */
|
|
#ifdef USE_OPENSSL
|
|
BIT(ssl_seeded);
|
|
#endif
|
|
BIT(dead); /* a callback returned error, everything needs to crash and
|
|
burn */
|
|
BIT(xfer_buf_borrowed); /* xfer_buf is currently being borrowed */
|
|
BIT(xfer_ulbuf_borrowed); /* xfer_ulbuf is currently being borrowed */
|
|
#ifdef DEBUGBUILD
|
|
BIT(warned); /* true after user warned of DEBUGBUILD */
|
|
#endif
|
|
};
|
|
|
|
#endif /* HEADER_CURL_MULTIHANDLE_H */
|