Coverage Report

Created: 2026-09-01 06:59

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/curl/lib/curl_share.h
Line
Count
Source
1
#ifndef HEADER_CURL_SHARE_H
2
#define HEADER_CURL_SHARE_H
3
/***************************************************************************
4
 *                                  _   _ ____  _
5
 *  Project                     ___| | | |  _ \| |
6
 *                             / __| | | | |_) | |
7
 *                            | (__| |_| |  _ <| |___
8
 *                             \___|\___/|_| \_\_____|
9
 *
10
 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11
 *
12
 * This software is licensed as described in the file COPYING, which
13
 * you should have received as part of this distribution. The terms
14
 * are also available at https://curl.se/docs/copyright.html.
15
 *
16
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17
 * copies of the Software, and permit persons to whom the Software is
18
 * furnished to do so, under the terms of the COPYING file.
19
 *
20
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21
 * KIND, either express or implied.
22
 *
23
 * SPDX-License-Identifier: curl
24
 *
25
 ***************************************************************************/
26
#include "curl_setup.h"
27
28
#include "curl_threads.h"
29
#include "cookie.h"
30
#include "psl.h"
31
#include "urldata.h"
32
#include "conncache.h"
33
34
struct Curl_easy;
35
struct Curl_ssl_scache;
36
37
0
#define CURL_GOOD_SHARE 0x7e117a1e
38
0
#define GOOD_SHARE_HANDLE(x) ((x) && (x)->magic == CURL_GOOD_SHARE)
39
40
#define CURL_SHARE_KEEP_CONNECT(s)                          \
41
100k
  ((s) && ((s)->specifier & (1 << CURL_LOCK_DATA_CONNECT)))
42
43
/* this struct is libcurl-private, do not export details */
44
struct Curl_share {
45
  unsigned int magic; /* CURL_GOOD_SHARE */
46
  unsigned int specifier;
47
48
  uint32_t ref_count;
49
#ifdef USE_MUTEX
50
   /* do `ref_count` and `has_been_shared` checks using this mutex. */
51
  curl_mutex_t lock;
52
  int has_been_shared;
53
#else
54
  /* this only ever goes from FALSE -> TRUE once. We need to check
55
   * this without being able to use the `lockfunc`. */
56
  volatile int has_been_shared;
57
#endif
58
  curl_lock_function lockfunc;
59
  curl_unlock_function unlockfunc;
60
  void *clientdata;
61
  struct Curl_easy *admin;
62
63
  struct cpool cpool;
64
  struct Curl_dnscache dnscache; /* DNS cache */
65
#if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
66
  struct CookieInfo *cookies;
67
#endif
68
#ifdef USE_LIBPSL
69
  struct PslCache psl;
70
#endif
71
#ifndef CURL_DISABLE_HSTS
72
  struct hsts *hsts;
73
#endif
74
#ifdef USE_SSL
75
  struct Curl_ssl_scache *ssl_scache;
76
#endif
77
};
78
79
CURLSHcode Curl_share_lock(struct Curl_easy *data, curl_lock_data type,
80
                           curl_lock_access accesstype);
81
CURLSHcode Curl_share_unlock(struct Curl_easy *data, curl_lock_data type);
82
83
CURLSHcode Curl_share_lock_share(struct Curl_share *share,
84
                                 struct Curl_easy *data,
85
                                 curl_lock_data type,
86
                                 curl_lock_access accesstype);
87
CURLSHcode Curl_share_unlock_share(struct Curl_share *share,
88
                                   struct Curl_easy *data,
89
                                   curl_lock_data type);
90
91
/* convenience macro to check if this handle is using a shared SSL spool */
92
#define CURL_SHARE_ssl_scache(data)                                \
93
0
  ((data)->share &&                                                \
94
0
   ((data)->share->specifier & (1 << CURL_LOCK_DATA_SSL_SESSION)))
95
96
CURLcode Curl_share_easy_unlink(struct Curl_easy *data);
97
CURLcode Curl_share_easy_link(struct Curl_easy *data,
98
                              struct Curl_share *share);
99
100
#endif /* HEADER_CURL_SHARE_H */