mirror of
https://github.com/curl/curl.git
synced 2026-04-13 12:41:42 +08:00
909af1a43b
Change multi's book keeping of transfers to no longer use lists, but a special table and bitsets for unsigned int values. `multi-xfers` is the `uint_tbl` where `multi_add_handle()` inserts a new transfer which assigns it a unique identifier `mid`. Use bitsets to keep track of transfers that are in state "process" or "pending" or "msgsent". Use sparse bitsets to replace `conn->easyq` and event handlings tracking of transfers per socket. Instead of pointers, keep the mids involved. Provide base data structures and document them in docs/internal: * `uint_tbl`: a table of transfers with `mid` as lookup key, handing out a mid for adds between 0 - capacity. * `uint_bset`: a bitset keeping unsigned ints from 0 - capacity. * `uint_spbset`: a sparse bitset for keeping a small number of unsigned int values * `uint_hash`: for associating `mid`s with a pointer. This makes the `mid` the recommended way to refer to transfers inside the same multi without risk of running into a UAF. Modifying table and bitsets is safe while iterating over them. Overall memory requirements are lower as with the double linked list apprach. Closes #16761
177 lines
7.3 KiB
C
177 lines
7.3 KiB
C
#ifndef HEADER_CURL_MULTIIF_H
|
|
#define HEADER_CURL_MULTIIF_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
|
|
*
|
|
***************************************************************************/
|
|
|
|
/*
|
|
* Prototypes for library-wide functions provided by multi.c
|
|
*/
|
|
|
|
void Curl_expire(struct Curl_easy *data, timediff_t milli, expire_id);
|
|
void Curl_expire_ex(struct Curl_easy *data,
|
|
const struct curltime *nowp,
|
|
timediff_t milli, expire_id id);
|
|
bool Curl_expire_clear(struct Curl_easy *data);
|
|
void Curl_expire_done(struct Curl_easy *data, expire_id id);
|
|
CURLMcode Curl_update_timer(struct Curl_multi *multi) WARN_UNUSED_RESULT;
|
|
void Curl_attach_connection(struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
void Curl_detach_connection(struct Curl_easy *data);
|
|
bool Curl_multiplex_wanted(const struct Curl_multi *multi);
|
|
void Curl_set_in_callback(struct Curl_easy *data, bool value);
|
|
bool Curl_is_in_callback(struct Curl_easy *data);
|
|
CURLcode Curl_preconnect(struct Curl_easy *data);
|
|
|
|
void Curl_multi_connchanged(struct Curl_multi *multi);
|
|
|
|
/* Internal version of curl_multi_init() accepts size parameters for the
|
|
socket, connection and dns hashes */
|
|
struct Curl_multi *Curl_multi_handle(unsigned int xfer_table_size,
|
|
size_t hashsize,
|
|
size_t chashsize,
|
|
size_t dnssize,
|
|
size_t sesssize);
|
|
|
|
/* the write bits start at bit 16 for the *getsock() bitmap */
|
|
#define GETSOCK_WRITEBITSTART 16
|
|
|
|
#define GETSOCK_BLANK 0 /* no bits set */
|
|
|
|
/* set the bit for the given sock number to make the bitmap for writable */
|
|
#define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x)))
|
|
|
|
/* set the bit for the given sock number to make the bitmap for readable */
|
|
#define GETSOCK_READSOCK(x) (1 << (x))
|
|
|
|
/* mask for checking if read and/or write is set for index x */
|
|
#define GETSOCK_MASK_RW(x) (GETSOCK_READSOCK(x)|GETSOCK_WRITESOCK(x))
|
|
|
|
/**
|
|
* Let the multi handle know that the socket is about to be closed.
|
|
* The multi will then remove anything it knows about the socket, so
|
|
* when the OS is using this socket (number) again subsequently,
|
|
* the internal book keeping will not get confused.
|
|
*/
|
|
void Curl_multi_will_close(struct Curl_easy *data, curl_socket_t s);
|
|
|
|
/*
|
|
* Add a handle and move it into PERFORM state at once. For pushed streams.
|
|
*/
|
|
CURLMcode Curl_multi_add_perform(struct Curl_multi *multi,
|
|
struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
|
|
|
|
/* Return the value of the CURLMOPT_MAX_CONCURRENT_STREAMS option */
|
|
unsigned int Curl_multi_max_concurrent_streams(struct Curl_multi *multi);
|
|
|
|
void Curl_multi_getsock(struct Curl_easy *data,
|
|
struct easy_pollset *ps,
|
|
const char *caller);
|
|
|
|
/**
|
|
* Borrow the transfer buffer from the multi, suitable
|
|
* for the given transfer `data`. The buffer may only be used in one
|
|
* multi processing of the easy handle. It MUST be returned to the
|
|
* multi before it can be borrowed again.
|
|
* Pointers into the buffer remain only valid as long as it is borrowed.
|
|
*
|
|
* @param data the easy handle
|
|
* @param pbuf on return, the buffer to use or NULL on error
|
|
* @param pbuflen on return, the size of *pbuf or 0 on error
|
|
* @return CURLE_OK when buffer is available and is returned.
|
|
* CURLE_OUT_OF_MEMORy on failure to allocate the buffer,
|
|
* CURLE_FAILED_INIT if the easy handle is without multi.
|
|
* CURLE_AGAIN if the buffer is borrowed already.
|
|
*/
|
|
CURLcode Curl_multi_xfer_buf_borrow(struct Curl_easy *data,
|
|
char **pbuf, size_t *pbuflen);
|
|
/**
|
|
* Release the borrowed buffer. All references into the buffer become
|
|
* invalid after this.
|
|
* @param buf the buffer pointer borrowed for coding error checks.
|
|
*/
|
|
void Curl_multi_xfer_buf_release(struct Curl_easy *data, char *buf);
|
|
|
|
/**
|
|
* Borrow the upload buffer from the multi, suitable
|
|
* for the given transfer `data`. The buffer may only be used in one
|
|
* multi processing of the easy handle. It MUST be returned to the
|
|
* multi before it can be borrowed again.
|
|
* Pointers into the buffer remain only valid as long as it is borrowed.
|
|
*
|
|
* @param data the easy handle
|
|
* @param pbuf on return, the buffer to use or NULL on error
|
|
* @param pbuflen on return, the size of *pbuf or 0 on error
|
|
* @return CURLE_OK when buffer is available and is returned.
|
|
* CURLE_OUT_OF_MEMORy on failure to allocate the buffer,
|
|
* CURLE_FAILED_INIT if the easy handle is without multi.
|
|
* CURLE_AGAIN if the buffer is borrowed already.
|
|
*/
|
|
CURLcode Curl_multi_xfer_ulbuf_borrow(struct Curl_easy *data,
|
|
char **pbuf, size_t *pbuflen);
|
|
|
|
/**
|
|
* Release the borrowed upload buffer. All references into the buffer become
|
|
* invalid after this.
|
|
* @param buf the upload buffer pointer borrowed for coding error checks.
|
|
*/
|
|
void Curl_multi_xfer_ulbuf_release(struct Curl_easy *data, char *buf);
|
|
|
|
/**
|
|
* Borrow the socket scratch buffer from the multi, suitable
|
|
* for the given transfer `data`. The buffer may only be used for
|
|
* direct socket I/O operation by one connection at a time and MUST be
|
|
* returned to the multi before the I/O call returns.
|
|
* Pointers into the buffer remain only valid as long as it is borrowed.
|
|
*
|
|
* @param data the easy handle
|
|
* @param blen requested length of the buffer
|
|
* @param pbuf on return, the buffer to use or NULL on error
|
|
* @return CURLE_OK when buffer is available and is returned.
|
|
* CURLE_OUT_OF_MEMORy on failure to allocate the buffer,
|
|
* CURLE_FAILED_INIT if the easy handle is without multi.
|
|
* CURLE_AGAIN if the buffer is borrowed already.
|
|
*/
|
|
CURLcode Curl_multi_xfer_sockbuf_borrow(struct Curl_easy *data,
|
|
size_t blen, char **pbuf);
|
|
/**
|
|
* Release the borrowed buffer. All references into the buffer become
|
|
* invalid after this.
|
|
* @param buf the buffer pointer borrowed for coding error checks.
|
|
*/
|
|
void Curl_multi_xfer_sockbuf_release(struct Curl_easy *data, char *buf);
|
|
|
|
/**
|
|
* Get the easy handle for the given mid.
|
|
* Returns NULL if not found.
|
|
*/
|
|
struct Curl_easy *Curl_multi_get_easy(struct Curl_multi *multi,
|
|
unsigned int mid);
|
|
|
|
/* Get the # of transfers current in process/pending. */
|
|
unsigned int Curl_multi_xfers_running(struct Curl_multi *multi);
|
|
|
|
#endif /* HEADER_CURL_MULTIIF_H */
|