multihandle.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. #ifndef HEADER_CURL_MULTIHANDLE_H
  2. #define HEADER_CURL_MULTIHANDLE_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, 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.haxx.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. ***************************************************************************/
  24. #include "conncache.h"
  25. #include "psl.h"
  26. #include "socketpair.h"
  27. struct Curl_message {
  28. struct curl_llist_element list;
  29. /* the 'CURLMsg' is the part that is visible to the external user */
  30. struct CURLMsg extmsg;
  31. };
  32. /* NOTE: if you add a state here, add the name to the statename[] array as
  33. well!
  34. */
  35. typedef enum {
  36. CURLM_STATE_INIT, /* 0 - start in this state */
  37. CURLM_STATE_CONNECT_PEND, /* 1 - no connections, waiting for one */
  38. CURLM_STATE_CONNECT, /* 2 - resolve/connect has been sent off */
  39. CURLM_STATE_WAITRESOLVE, /* 3 - awaiting the resolve to finalize */
  40. CURLM_STATE_WAITCONNECT, /* 4 - awaiting the TCP connect to finalize */
  41. CURLM_STATE_WAITPROXYCONNECT, /* 5 - awaiting HTTPS proxy SSL initialization
  42. to complete and/or proxy CONNECT to
  43. finalize */
  44. CURLM_STATE_SENDPROTOCONNECT, /* 6 - initiate protocol connect procedure */
  45. CURLM_STATE_PROTOCONNECT, /* 7 - completing the protocol-specific connect
  46. phase */
  47. CURLM_STATE_DO, /* 8 - start send off the request (part 1) */
  48. CURLM_STATE_DOING, /* 9 - sending off the request (part 1) */
  49. CURLM_STATE_DO_MORE, /* 10 - send off the request (part 2) */
  50. CURLM_STATE_DO_DONE, /* 11 - done sending off request */
  51. CURLM_STATE_PERFORM, /* 12 - transfer data */
  52. CURLM_STATE_TOOFAST, /* 13 - wait because limit-rate exceeded */
  53. CURLM_STATE_DONE, /* 14 - post data transfer operation */
  54. CURLM_STATE_COMPLETED, /* 15 - operation complete */
  55. CURLM_STATE_MSGSENT, /* 16 - the operation complete message is sent */
  56. CURLM_STATE_LAST /* 17 - not a true state, never use this */
  57. } CURLMstate;
  58. /* we support N sockets per easy handle. Set the corresponding bit to what
  59. action we should wait for */
  60. #define MAX_SOCKSPEREASYHANDLE 5
  61. #define GETSOCK_READABLE (0x00ff)
  62. #define GETSOCK_WRITABLE (0xff00)
  63. #define CURLPIPE_ANY (CURLPIPE_MULTIPLEX)
  64. #if defined(USE_SOCKETPAIR) && !defined(USE_BLOCKING_SOCKETS)
  65. #define ENABLE_WAKEUP
  66. #endif
  67. /* value for MAXIMUM CONCURRENT STREAMS upper limit */
  68. #define INITIAL_MAX_CONCURRENT_STREAMS ((1U << 31) - 1)
  69. /* This is the struct known as CURLM on the outside */
  70. struct Curl_multi {
  71. /* First a simple identifier to easier detect if a user mix up
  72. this multi handle with an easy handle. Set this to CURL_MULTI_HANDLE. */
  73. long type;
  74. /* We have a doubly-linked list with easy handles */
  75. struct Curl_easy *easyp;
  76. struct Curl_easy *easylp; /* last node */
  77. int num_easy; /* amount of entries in the linked list above. */
  78. int num_alive; /* amount of easy handles that are added but have not yet
  79. reached COMPLETE state */
  80. struct curl_llist msglist; /* a list of messages from completed transfers */
  81. struct curl_llist pending; /* Curl_easys that are in the
  82. CURLM_STATE_CONNECT_PEND state */
  83. /* callback function and user data pointer for the *socket() API */
  84. curl_socket_callback socket_cb;
  85. void *socket_userp;
  86. /* callback function and user data pointer for server push */
  87. curl_push_callback push_cb;
  88. void *push_userp;
  89. /* Hostname cache */
  90. struct curl_hash hostcache;
  91. #ifdef USE_LIBPSL
  92. /* PSL cache. */
  93. struct PslCache psl;
  94. #endif
  95. /* timetree points to the splay-tree of time nodes to figure out expire
  96. times of all currently set timers */
  97. struct Curl_tree *timetree;
  98. /* 'sockhash' is the lookup hash for socket descriptor => easy handles (note
  99. the pluralis form, there can be more than one easy handle waiting on the
  100. same actual socket) */
  101. struct curl_hash sockhash;
  102. /* Shared connection cache (bundles)*/
  103. struct conncache conn_cache;
  104. long maxconnects; /* if >0, a fixed limit of the maximum number of entries
  105. we're allowed to grow the connection cache to */
  106. long max_host_connections; /* if >0, a fixed limit of the maximum number
  107. of connections per host */
  108. long max_total_connections; /* if >0, a fixed limit of the maximum number
  109. of connections in total */
  110. /* timer callback and user data pointer for the *socket() API */
  111. curl_multi_timer_callback timer_cb;
  112. void *timer_userp;
  113. struct curltime timer_lastcall; /* the fixed time for the timeout for the
  114. previous callback */
  115. unsigned int max_concurrent_streams;
  116. #ifdef ENABLE_WAKEUP
  117. curl_socket_t wakeup_pair[2]; /* socketpair() used for wakeup
  118. 0 is used for read, 1 is used for write */
  119. #endif
  120. /* multiplexing wanted */
  121. bool multiplexing;
  122. bool recheckstate; /* see Curl_multi_connchanged */
  123. bool in_callback; /* true while executing a callback */
  124. bool ipv6_works;
  125. };
  126. #endif /* HEADER_CURL_MULTIHANDLE_H */