curl/lib/share.h
Stefan Eissing 9b1037ea73
Split shutdown handling from connection pool
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 dogfoof" related fix.
2025-02-28 11:18:12 +01:00

79 lines
2.5 KiB
C

#ifndef HEADER_CURL_SHARE_H
#define HEADER_CURL_SHARE_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 <curl/curl.h>
#include "cookie.h"
#include "psl.h"
#include "urldata.h"
#include "conncache.h"
struct Curl_easy;
struct Curl_ssl_scache;
#define CURL_GOOD_SHARE 0x7e117a1e
#define GOOD_SHARE_HANDLE(x) ((x) && (x)->magic == CURL_GOOD_SHARE)
#define CURL_SHARE_KEEP_CONNECT(s) \
((s) && ((s)->specifier & (1<< CURL_LOCK_DATA_CONNECT)))
/* this struct is libcurl-private, do not export details */
struct Curl_share {
unsigned int magic; /* CURL_GOOD_SHARE */
unsigned int specifier;
volatile unsigned int dirty;
curl_lock_function lockfunc;
curl_unlock_function unlockfunc;
void *clientdata;
struct Curl_easy *admin;
struct cpool cpool;
struct Curl_hash hostcache;
#if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
struct CookieInfo *cookies;
#endif
#ifdef USE_LIBPSL
struct PslCache psl;
#endif
#ifndef CURL_DISABLE_HSTS
struct hsts *hsts;
#endif
#ifdef USE_SSL
struct Curl_ssl_scache *ssl_scache;
#endif
};
CURLSHcode Curl_share_lock(struct Curl_easy *, curl_lock_data,
curl_lock_access);
CURLSHcode Curl_share_unlock(struct Curl_easy *, curl_lock_data);
/* convenience macro to check if this handle is using a shared SSL spool */
#define CURL_SHARE_ssl_scache(data) (data->share && \
(data->share->specifier & \
(1<<CURL_LOCK_DATA_SSL_SESSION)))
#endif /* HEADER_CURL_SHARE_H */