multi: fix curl_multi_waitfds reporting of fd_count

- 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
This commit is contained in:
Christopher Dannemiller 2024-10-04 09:31:59 -07:00 committed by Jay Satiro
parent 7d6edf1d8d
commit c78044c07e
7 changed files with 120 additions and 43 deletions

View file

@ -1200,8 +1200,9 @@ CURLMcode curl_multi_waitfds(CURLM *m,
CURLMcode result = CURLM_OK;
struct Curl_llist_node *e;
struct Curl_multi *multi = m;
unsigned int need = 0;
if(!ufds)
if(!ufds && (size || !fd_count))
return CURLM_BAD_FUNCTION_ARGUMENT;
if(!GOOD_MULTI_HANDLE(multi))
@ -1214,20 +1215,17 @@ CURLMcode curl_multi_waitfds(CURLM *m,
for(e = Curl_llist_head(&multi->process); e; e = Curl_node_next(e)) {
struct Curl_easy *data = Curl_node_elem(e);
multi_getsock(data, &data->last_poll);
if(Curl_waitfds_add_ps(&cwfds, &data->last_poll)) {
result = CURLM_OUT_OF_MEMORY;
goto out;
}
need += Curl_waitfds_add_ps(&cwfds, &data->last_poll);
}
if(Curl_cpool_add_waitfds(&multi->cpool, &cwfds)) {
need += Curl_cpool_add_waitfds(&multi->cpool, &cwfds);
if(need != cwfds.n && ufds) {
result = CURLM_OUT_OF_MEMORY;
goto out;
}
out:
if(fd_count)
*fd_count = cwfds.n;
*fd_count = need;
return result;
}