c78044c07e
- Make curl_multi_waitfds consistent with the documentation. Issue Addressed: - The documentation of curl_multi_waitfds indicates that users should be able to call curl_multi_waitfds with a NULL ufds. However, before this change, the function would return CURLM_BAD_FUNCTION_ARGUMENT. - Additionally, the documentation suggests that users can use this function to determine the number of file descriptors (fds) needed. However, the function would stop counting fds if the supplied fds were exhausted. Changes Made: - NULL ufds Handling: curl_multi_waitfds can now accept a NULL ufds if size is also zero. - Counting File Descriptors: If curl_multi_waitfds is passed a NULL ufds, or the size of ufds is insufficient, the output parameter fd_count will return the number of fds needed. This value may be higher than actually needed but never lower. Testing: - Test 2405 has been updated to cover the usage scenarios described above. Fixes https://github.com/curl/curl/issues/15146 Closes https://github.com/curl/curl/pull/15155
147 lines
4.1 KiB
C
147 lines
4.1 KiB
C
#ifndef HEADER_CURL_SELECT_H
|
|
#define HEADER_CURL_SELECT_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"
|
|
|
|
#ifdef HAVE_POLL_H
|
|
#include <poll.h>
|
|
#elif defined(HAVE_SYS_POLL_H)
|
|
#include <sys/poll.h>
|
|
#endif
|
|
|
|
/*
|
|
* Definition of pollfd struct and constants for platforms lacking them.
|
|
*/
|
|
|
|
#if !defined(HAVE_SYS_POLL_H) && \
|
|
!defined(HAVE_POLL_H) && \
|
|
!defined(POLLIN)
|
|
|
|
#define POLLIN 0x01
|
|
#define POLLPRI 0x02
|
|
#define POLLOUT 0x04
|
|
#define POLLERR 0x08
|
|
#define POLLHUP 0x10
|
|
#define POLLNVAL 0x20
|
|
|
|
struct pollfd
|
|
{
|
|
curl_socket_t fd;
|
|
short events;
|
|
short revents;
|
|
};
|
|
|
|
#endif
|
|
|
|
#ifndef POLLRDNORM
|
|
#define POLLRDNORM POLLIN
|
|
#endif
|
|
|
|
#ifndef POLLWRNORM
|
|
#define POLLWRNORM POLLOUT
|
|
#endif
|
|
|
|
#ifndef POLLRDBAND
|
|
#define POLLRDBAND POLLPRI
|
|
#endif
|
|
|
|
/* there are three CSELECT defines that are defined in the public header that
|
|
are exposed to users, but this *IN2 bit is only ever used internally and
|
|
therefore defined here */
|
|
#define CURL_CSELECT_IN2 (CURL_CSELECT_ERR << 1)
|
|
|
|
int Curl_socket_check(curl_socket_t readfd, curl_socket_t readfd2,
|
|
curl_socket_t writefd,
|
|
timediff_t timeout_ms);
|
|
#define SOCKET_READABLE(x,z) \
|
|
Curl_socket_check(x, CURL_SOCKET_BAD, CURL_SOCKET_BAD, z)
|
|
#define SOCKET_WRITABLE(x,z) \
|
|
Curl_socket_check(CURL_SOCKET_BAD, CURL_SOCKET_BAD, x, z)
|
|
|
|
int Curl_poll(struct pollfd ufds[], unsigned int nfds, timediff_t timeout_ms);
|
|
int Curl_wait_ms(timediff_t timeout_ms);
|
|
|
|
/*
|
|
With Winsock the valid range is [0..INVALID_SOCKET-1] according to
|
|
https://docs.microsoft.com/en-us/windows/win32/winsock/socket-data-type-2
|
|
*/
|
|
#ifdef USE_WINSOCK
|
|
#define VALID_SOCK(s) ((s) < INVALID_SOCKET)
|
|
#define FDSET_SOCK(x) 1
|
|
#define VERIFY_SOCK(x) do { \
|
|
if(!VALID_SOCK(x)) { \
|
|
SET_SOCKERRNO(WSAEINVAL); \
|
|
return -1; \
|
|
} \
|
|
} while(0)
|
|
#else
|
|
#define VALID_SOCK(s) ((s) >= 0)
|
|
|
|
/* If the socket is small enough to get set or read from an fdset */
|
|
#define FDSET_SOCK(s) ((s) < FD_SETSIZE)
|
|
|
|
#define VERIFY_SOCK(x) do { \
|
|
if(!VALID_SOCK(x) || !FDSET_SOCK(x)) { \
|
|
SET_SOCKERRNO(EINVAL); \
|
|
return -1; \
|
|
} \
|
|
} while(0)
|
|
#endif
|
|
|
|
struct curl_pollfds {
|
|
struct pollfd *pfds;
|
|
unsigned int n;
|
|
unsigned int count;
|
|
BIT(allocated_pfds);
|
|
};
|
|
|
|
void Curl_pollfds_init(struct curl_pollfds *cpfds,
|
|
struct pollfd *static_pfds,
|
|
unsigned int static_count);
|
|
|
|
void Curl_pollfds_cleanup(struct curl_pollfds *cpfds);
|
|
|
|
CURLcode Curl_pollfds_add_ps(struct curl_pollfds *cpfds,
|
|
struct easy_pollset *ps);
|
|
|
|
CURLcode Curl_pollfds_add_sock(struct curl_pollfds *cpfds,
|
|
curl_socket_t sock, short events);
|
|
|
|
struct curl_waitfds {
|
|
struct curl_waitfd *wfds;
|
|
unsigned int n;
|
|
unsigned int count;
|
|
};
|
|
|
|
void Curl_waitfds_init(struct curl_waitfds *cwfds,
|
|
struct curl_waitfd *static_wfds,
|
|
unsigned int static_count);
|
|
|
|
unsigned int Curl_waitfds_add_ps(struct curl_waitfds *cwfds,
|
|
struct easy_pollset *ps);
|
|
|
|
#endif /* HEADER_CURL_SELECT_H */
|