Utilities/cmcurl/lib/multihandle.h

   1 #ifndef HEADER_CURL_MULTIHANDLE_H
   2 #define HEADER_CURL_MULTIHANDLE_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2022, 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
  27 #include "llist.h"
  28 #include "hash.h"
  29 #include "conncache.h"
  30 #include "psl.h"
  31 #include "socketpair.h"
  32
  33 struct connectdata;
  34
  35 struct Curl_message {
  36   struct Curl_llist_element list;
  37   /* the 'CURLMsg' is the part that is visible to the external user */
  38   struct CURLMsg extmsg;
  39 };
  40
  41 /* NOTE: if you add a state here, add the name to the statename[] array as
  42    well!
  43 */
  44 typedef enum {
  45   MSTATE_INIT,         /* 0 - start in this state */
  46   MSTATE_PENDING,      /* 1 - no connections, waiting for one */
  47   MSTATE_CONNECT,      /* 2 - resolve/connect has been sent off */
  48   MSTATE_RESOLVING,    /* 3 - awaiting the resolve to finalize */
  49   MSTATE_CONNECTING,   /* 4 - awaiting the TCP connect to finalize */
  50   MSTATE_TUNNELING,    /* 5 - awaiting HTTPS proxy SSL initialization to
  51                           complete and/or proxy CONNECT to finalize */
  52   MSTATE_PROTOCONNECT, /* 6 - initiate protocol connect procedure */
  53   MSTATE_PROTOCONNECTING, /* 7 - completing the protocol-specific connect
  54                              phase */
  55   MSTATE_DO,           /* 8 - start send off the request (part 1) */
  56   MSTATE_DOING,        /* 9 - sending off the request (part 1) */
  57   MSTATE_DOING_MORE,   /* 10 - send off the request (part 2) */
  58   MSTATE_DID,          /* 11 - done sending off request */
  59   MSTATE_PERFORMING,   /* 12 - transfer data */
  60   MSTATE_RATELIMITING, /* 13 - wait because limit-rate exceeded */
  61   MSTATE_DONE,         /* 14 - post data transfer operation */
  62   MSTATE_COMPLETED,    /* 15 - operation complete */
  63   MSTATE_MSGSENT,      /* 16 - the operation complete message is sent */
  64   MSTATE_LAST          /* 17 - not a true state, never use this */
  65 } CURLMstate;
  66
  67 /* we support N sockets per easy handle. Set the corresponding bit to what
  68    action we should wait for */
  69 #define MAX_SOCKSPEREASYHANDLE 5
  70 #define GETSOCK_READABLE (0x00ff)
  71 #define GETSOCK_WRITABLE (0xff00)
  72
  73 #define CURLPIPE_ANY (CURLPIPE_MULTIPLEX)
  74
  75 #if !defined(CURL_DISABLE_SOCKETPAIR)
  76 #define ENABLE_WAKEUP
  77 #endif
  78
  79 /* value for MAXIMUM CONCURRENT STREAMS upper limit */
  80 #define INITIAL_MAX_CONCURRENT_STREAMS ((1U << 31) - 1)
  81
  82 /* This is the struct known as CURLM on the outside */
  83 struct Curl_multi {
  84   /* First a simple identifier to easier detect if a user mix up
  85      this multi handle with an easy handle. Set this to CURL_MULTI_HANDLE. */
  86   unsigned int magic;
  87
  88   /* We have a doubly-linked list with easy handles */
  89   struct Curl_easy *easyp;
  90   struct Curl_easy *easylp; /* last node */
  91
  92   int num_easy; /* amount of entries in the linked list above. */
  93   int num_alive; /* amount of easy handles that are added but have not yet
  94                     reached COMPLETE state */
  95
  96   struct Curl_llist msglist; /* a list of messages from completed transfers */
  97
  98   struct Curl_llist pending; /* Curl_easys that are in the
  99                                 MSTATE_PENDING state */
 100
 101   /* callback function and user data pointer for the *socket() API */
 102   curl_socket_callback socket_cb;
 103   void *socket_userp;
 104
 105   /* callback function and user data pointer for server push */
 106   curl_push_callback push_cb;
 107   void *push_userp;
 108
 109   /* Hostname cache */
 110   struct Curl_hash hostcache;
 111
 112 #ifdef USE_LIBPSL
 113   /* PSL cache. */
 114   struct PslCache psl;
 115 #endif
 116
 117   /* timetree points to the splay-tree of time nodes to figure out expire
 118      times of all currently set timers */
 119   struct Curl_tree *timetree;
 120
 121   /* 'sockhash' is the lookup hash for socket descriptor => easy handles (note
 122      the pluralis form, there can be more than one easy handle waiting on the
 123      same actual socket) */
 124   struct Curl_hash sockhash;
 125
 126   /* Shared connection cache (bundles)*/
 127   struct conncache conn_cache;
 128
 129   long maxconnects; /* if >0, a fixed limit of the maximum number of entries
 130                        we're allowed to grow the connection cache to */
 131
 132   long max_host_connections; /* if >0, a fixed limit of the maximum number
 133                                 of connections per host */
 134
 135   long max_total_connections; /* if >0, a fixed limit of the maximum number
 136                                  of connections in total */
 137
 138   /* timer callback and user data pointer for the *socket() API */
 139   curl_multi_timer_callback timer_cb;
 140   void *timer_userp;
 141   struct curltime timer_lastcall; /* the fixed time for the timeout for the
 142                                     previous callback */
 143   unsigned int max_concurrent_streams;
 144
 145 #ifdef USE_WINSOCK
 146   WSAEVENT wsa_event; /* winsock event used for waits */
 147 #else
 148 #ifdef ENABLE_WAKEUP
 149   curl_socket_t wakeup_pair[2]; /* socketpair() used for wakeup
 150                                    0 is used for read, 1 is used for write */
 151 #endif
 152 #endif
 153 #define IPV6_UNKNOWN 0
 154 #define IPV6_DEAD    1
 155 #define IPV6_WORKS   2
 156   unsigned char ipv6_up;       /* IPV6_* defined */
 157   bool multiplexing;           /* multiplexing wanted */
 158   bool recheckstate;           /* see Curl_multi_connchanged */
 159   bool in_callback;            /* true while executing a callback */
 160 #ifdef USE_OPENSSL
 161   bool ssl_seeded;
 162 #endif
 163   bool dead; /* a callback returned error, everything needs to crash and
 164                 burn */
 165 };
 166
 167 #endif /* HEADER_CURL_MULTIHANDLE_H */