cfilters.c 28 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031
  1. /***************************************************************************
  2. * _ _ ____ _
  3. * Project ___| | | | _ \| |
  4. * / __| | | | |_) | |
  5. * | (__| |_| | _ <| |___
  6. * \___|\___/|_| \_\_____|
  7. *
  8. * Copyright (C) Daniel Stenberg, <[email protected]>, et al.
  9. *
  10. * This software is licensed as described in the file COPYING, which
  11. * you should have received as part of this distribution. The terms
  12. * are also available at https://curl.se/docs/copyright.html.
  13. *
  14. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. * copies of the Software, and permit persons to whom the Software is
  16. * furnished to do so, under the terms of the COPYING file.
  17. *
  18. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. * KIND, either express or implied.
  20. *
  21. * SPDX-License-Identifier: curl
  22. *
  23. ***************************************************************************/
  24. #include "curl_setup.h"
  25. #include "urldata.h"
  26. #include "strerror.h"
  27. #include "cfilters.h"
  28. #include "connect.h"
  29. #include "url.h" /* for Curl_safefree() */
  30. #include "sendf.h"
  31. #include "sockaddr.h" /* required for Curl_sockaddr_storage */
  32. #include "multiif.h"
  33. #include "progress.h"
  34. #include "select.h"
  35. #include "warnless.h"
  36. /* The last 3 #include files should be in this order */
  37. #include "curl_printf.h"
  38. #include "curl_memory.h"
  39. #include "memdebug.h"
  40. #ifndef ARRAYSIZE
  41. #define ARRAYSIZE(A) (sizeof(A)/sizeof((A)[0]))
  42. #endif
  43. static void cf_cntrl_update_info(struct Curl_easy *data,
  44. struct connectdata *conn);
  45. #ifdef UNITTESTS
  46. /* used by unit2600.c */
  47. void Curl_cf_def_close(struct Curl_cfilter *cf, struct Curl_easy *data)
  48. {
  49. cf->connected = FALSE;
  50. if(cf->next)
  51. cf->next->cft->do_close(cf->next, data);
  52. }
  53. #endif
  54. CURLcode Curl_cf_def_shutdown(struct Curl_cfilter *cf,
  55. struct Curl_easy *data, bool *done)
  56. {
  57. (void)cf;
  58. (void)data;
  59. *done = TRUE;
  60. return CURLE_OK;
  61. }
  62. static void conn_report_connect_stats(struct Curl_easy *data,
  63. struct connectdata *conn);
  64. void Curl_cf_def_get_host(struct Curl_cfilter *cf, struct Curl_easy *data,
  65. const char **phost, const char **pdisplay_host,
  66. int *pport)
  67. {
  68. if(cf->next)
  69. cf->next->cft->get_host(cf->next, data, phost, pdisplay_host, pport);
  70. else {
  71. *phost = cf->conn->host.name;
  72. *pdisplay_host = cf->conn->host.dispname;
  73. *pport = cf->conn->primary.remote_port;
  74. }
  75. }
  76. void Curl_cf_def_adjust_pollset(struct Curl_cfilter *cf,
  77. struct Curl_easy *data,
  78. struct easy_pollset *ps)
  79. {
  80. /* NOP */
  81. (void)cf;
  82. (void)data;
  83. (void)ps;
  84. }
  85. bool Curl_cf_def_data_pending(struct Curl_cfilter *cf,
  86. const struct Curl_easy *data)
  87. {
  88. return cf->next ?
  89. cf->next->cft->has_data_pending(cf->next, data) : FALSE;
  90. }
  91. ssize_t Curl_cf_def_send(struct Curl_cfilter *cf, struct Curl_easy *data,
  92. const void *buf, size_t len, bool eos,
  93. CURLcode *err)
  94. {
  95. return cf->next ?
  96. cf->next->cft->do_send(cf->next, data, buf, len, eos, err) :
  97. CURLE_RECV_ERROR;
  98. }
  99. ssize_t Curl_cf_def_recv(struct Curl_cfilter *cf, struct Curl_easy *data,
  100. char *buf, size_t len, CURLcode *err)
  101. {
  102. return cf->next ?
  103. cf->next->cft->do_recv(cf->next, data, buf, len, err) :
  104. CURLE_SEND_ERROR;
  105. }
  106. bool Curl_cf_def_conn_is_alive(struct Curl_cfilter *cf,
  107. struct Curl_easy *data,
  108. bool *input_pending)
  109. {
  110. return cf->next ?
  111. cf->next->cft->is_alive(cf->next, data, input_pending) :
  112. FALSE; /* pessimistic in absence of data */
  113. }
  114. CURLcode Curl_cf_def_conn_keep_alive(struct Curl_cfilter *cf,
  115. struct Curl_easy *data)
  116. {
  117. return cf->next ?
  118. cf->next->cft->keep_alive(cf->next, data) :
  119. CURLE_OK;
  120. }
  121. CURLcode Curl_cf_def_query(struct Curl_cfilter *cf,
  122. struct Curl_easy *data,
  123. int query, int *pres1, void *pres2)
  124. {
  125. return cf->next ?
  126. cf->next->cft->query(cf->next, data, query, pres1, pres2) :
  127. CURLE_UNKNOWN_OPTION;
  128. }
  129. void Curl_conn_cf_discard_chain(struct Curl_cfilter **pcf,
  130. struct Curl_easy *data)
  131. {
  132. struct Curl_cfilter *cfn, *cf = *pcf;
  133. if(cf) {
  134. *pcf = NULL;
  135. while(cf) {
  136. cfn = cf->next;
  137. /* prevent destroying filter to mess with its sub-chain, since
  138. * we have the reference now and will call destroy on it.
  139. */
  140. cf->next = NULL;
  141. cf->cft->destroy(cf, data);
  142. free(cf);
  143. cf = cfn;
  144. }
  145. }
  146. }
  147. void Curl_conn_cf_discard_all(struct Curl_easy *data,
  148. struct connectdata *conn, int index)
  149. {
  150. Curl_conn_cf_discard_chain(&conn->cfilter[index], data);
  151. }
  152. void Curl_conn_close(struct Curl_easy *data, int index)
  153. {
  154. struct Curl_cfilter *cf;
  155. DEBUGASSERT(data->conn);
  156. /* it is valid to call that without filters being present */
  157. cf = data->conn->cfilter[index];
  158. if(cf) {
  159. cf->cft->do_close(cf, data);
  160. }
  161. Curl_shutdown_clear(data, index);
  162. }
  163. CURLcode Curl_conn_shutdown(struct Curl_easy *data, int sockindex, bool *done)
  164. {
  165. struct Curl_cfilter *cf;
  166. CURLcode result = CURLE_OK;
  167. timediff_t timeout_ms;
  168. struct curltime now;
  169. DEBUGASSERT(data->conn);
  170. /* Get the first connected filter that is not shut down already. */
  171. cf = data->conn->cfilter[sockindex];
  172. while(cf && (!cf->connected || cf->shutdown))
  173. cf = cf->next;
  174. if(!cf) {
  175. *done = TRUE;
  176. return CURLE_OK;
  177. }
  178. *done = FALSE;
  179. now = Curl_now();
  180. if(!Curl_shutdown_started(data, sockindex)) {
  181. DEBUGF(infof(data, "shutdown start on%s connection",
  182. sockindex ? " secondary" : ""));
  183. Curl_shutdown_start(data, sockindex, &now);
  184. }
  185. else {
  186. timeout_ms = Curl_shutdown_timeleft(data->conn, sockindex, &now);
  187. if(timeout_ms < 0) {
  188. /* info message, since this might be regarded as acceptable */
  189. infof(data, "shutdown timeout");
  190. return CURLE_OPERATION_TIMEDOUT;
  191. }
  192. }
  193. while(cf) {
  194. if(!cf->shutdown) {
  195. bool cfdone = FALSE;
  196. result = cf->cft->do_shutdown(cf, data, &cfdone);
  197. if(result) {
  198. CURL_TRC_CF(data, cf, "shut down failed with %d", result);
  199. return result;
  200. }
  201. else if(!cfdone) {
  202. CURL_TRC_CF(data, cf, "shut down not done yet");
  203. return CURLE_OK;
  204. }
  205. CURL_TRC_CF(data, cf, "shut down successfully");
  206. cf->shutdown = TRUE;
  207. }
  208. cf = cf->next;
  209. }
  210. *done = (!result);
  211. return result;
  212. }
  213. ssize_t Curl_cf_recv(struct Curl_easy *data, int num, char *buf,
  214. size_t len, CURLcode *code)
  215. {
  216. struct Curl_cfilter *cf;
  217. DEBUGASSERT(data);
  218. DEBUGASSERT(data->conn);
  219. *code = CURLE_OK;
  220. cf = data->conn->cfilter[num];
  221. while(cf && !cf->connected) {
  222. cf = cf->next;
  223. }
  224. if(cf) {
  225. ssize_t nread = cf->cft->do_recv(cf, data, buf, len, code);
  226. DEBUGASSERT(nread >= 0 || *code);
  227. DEBUGASSERT(nread < 0 || !*code);
  228. return nread;
  229. }
  230. failf(data, "recv: no filter connected");
  231. *code = CURLE_FAILED_INIT;
  232. return -1;
  233. }
  234. ssize_t Curl_cf_send(struct Curl_easy *data, int num,
  235. const void *mem, size_t len, bool eos,
  236. CURLcode *code)
  237. {
  238. struct Curl_cfilter *cf;
  239. DEBUGASSERT(data);
  240. DEBUGASSERT(data->conn);
  241. *code = CURLE_OK;
  242. cf = data->conn->cfilter[num];
  243. while(cf && !cf->connected) {
  244. cf = cf->next;
  245. }
  246. if(cf) {
  247. ssize_t nwritten = cf->cft->do_send(cf, data, mem, len, eos, code);
  248. DEBUGASSERT(nwritten >= 0 || *code);
  249. DEBUGASSERT(nwritten < 0 || !*code || !len);
  250. return nwritten;
  251. }
  252. failf(data, "send: no filter connected");
  253. DEBUGASSERT(0);
  254. *code = CURLE_FAILED_INIT;
  255. return -1;
  256. }
  257. CURLcode Curl_cf_create(struct Curl_cfilter **pcf,
  258. const struct Curl_cftype *cft,
  259. void *ctx)
  260. {
  261. struct Curl_cfilter *cf;
  262. CURLcode result = CURLE_OUT_OF_MEMORY;
  263. DEBUGASSERT(cft);
  264. cf = calloc(1, sizeof(*cf));
  265. if(!cf)
  266. goto out;
  267. cf->cft = cft;
  268. cf->ctx = ctx;
  269. result = CURLE_OK;
  270. out:
  271. *pcf = cf;
  272. return result;
  273. }
  274. void Curl_conn_cf_add(struct Curl_easy *data,
  275. struct connectdata *conn,
  276. int index,
  277. struct Curl_cfilter *cf)
  278. {
  279. (void)data;
  280. DEBUGASSERT(conn);
  281. DEBUGASSERT(!cf->conn);
  282. DEBUGASSERT(!cf->next);
  283. cf->next = conn->cfilter[index];
  284. cf->conn = conn;
  285. cf->sockindex = index;
  286. conn->cfilter[index] = cf;
  287. CURL_TRC_CF(data, cf, "added");
  288. }
  289. void Curl_conn_cf_insert_after(struct Curl_cfilter *cf_at,
  290. struct Curl_cfilter *cf_new)
  291. {
  292. struct Curl_cfilter *tail, **pnext;
  293. DEBUGASSERT(cf_at);
  294. DEBUGASSERT(cf_new);
  295. DEBUGASSERT(!cf_new->conn);
  296. tail = cf_at->next;
  297. cf_at->next = cf_new;
  298. do {
  299. cf_new->conn = cf_at->conn;
  300. cf_new->sockindex = cf_at->sockindex;
  301. pnext = &cf_new->next;
  302. cf_new = cf_new->next;
  303. } while(cf_new);
  304. *pnext = tail;
  305. }
  306. bool Curl_conn_cf_discard_sub(struct Curl_cfilter *cf,
  307. struct Curl_cfilter *discard,
  308. struct Curl_easy *data,
  309. bool destroy_always)
  310. {
  311. struct Curl_cfilter **pprev = &cf->next;
  312. bool found = FALSE;
  313. /* remove from sub-chain and destroy */
  314. DEBUGASSERT(cf);
  315. while(*pprev) {
  316. if(*pprev == cf) {
  317. *pprev = discard->next;
  318. discard->next = NULL;
  319. found = TRUE;
  320. break;
  321. }
  322. pprev = &((*pprev)->next);
  323. }
  324. if(found || destroy_always) {
  325. discard->next = NULL;
  326. discard->cft->destroy(discard, data);
  327. free(discard);
  328. }
  329. return found;
  330. }
  331. CURLcode Curl_conn_cf_connect(struct Curl_cfilter *cf,
  332. struct Curl_easy *data,
  333. bool blocking, bool *done)
  334. {
  335. if(cf)
  336. return cf->cft->do_connect(cf, data, blocking, done);
  337. return CURLE_FAILED_INIT;
  338. }
  339. void Curl_conn_cf_close(struct Curl_cfilter *cf, struct Curl_easy *data)
  340. {
  341. if(cf)
  342. cf->cft->do_close(cf, data);
  343. }
  344. ssize_t Curl_conn_cf_send(struct Curl_cfilter *cf, struct Curl_easy *data,
  345. const void *buf, size_t len, bool eos,
  346. CURLcode *err)
  347. {
  348. if(cf)
  349. return cf->cft->do_send(cf, data, buf, len, eos, err);
  350. *err = CURLE_SEND_ERROR;
  351. return -1;
  352. }
  353. ssize_t Curl_conn_cf_recv(struct Curl_cfilter *cf, struct Curl_easy *data,
  354. char *buf, size_t len, CURLcode *err)
  355. {
  356. if(cf)
  357. return cf->cft->do_recv(cf, data, buf, len, err);
  358. *err = CURLE_RECV_ERROR;
  359. return -1;
  360. }
  361. CURLcode Curl_conn_connect(struct Curl_easy *data,
  362. int sockindex,
  363. bool blocking,
  364. bool *done)
  365. {
  366. struct Curl_cfilter *cf;
  367. CURLcode result = CURLE_OK;
  368. DEBUGASSERT(data);
  369. DEBUGASSERT(data->conn);
  370. cf = data->conn->cfilter[sockindex];
  371. DEBUGASSERT(cf);
  372. if(!cf) {
  373. *done = FALSE;
  374. return CURLE_FAILED_INIT;
  375. }
  376. *done = cf->connected;
  377. if(!*done) {
  378. if(Curl_conn_needs_flush(data, sockindex)) {
  379. DEBUGF(infof(data, "Curl_conn_connect(index=%d), flush", sockindex));
  380. result = Curl_conn_flush(data, sockindex);
  381. if(result && (result != CURLE_AGAIN))
  382. return result;
  383. }
  384. result = cf->cft->do_connect(cf, data, blocking, done);
  385. if(!result && *done) {
  386. /* Now that the complete filter chain is connected, let all filters
  387. * persist information at the connection. E.g. cf-socket sets the
  388. * socket and ip related information. */
  389. cf_cntrl_update_info(data, data->conn);
  390. conn_report_connect_stats(data, data->conn);
  391. data->conn->keepalive = Curl_now();
  392. Curl_verboseconnect(data, data->conn, sockindex);
  393. }
  394. else if(result) {
  395. conn_report_connect_stats(data, data->conn);
  396. }
  397. }
  398. return result;
  399. }
  400. bool Curl_conn_is_connected(struct connectdata *conn, int sockindex)
  401. {
  402. struct Curl_cfilter *cf;
  403. cf = conn->cfilter[sockindex];
  404. return cf && cf->connected;
  405. }
  406. bool Curl_conn_is_ip_connected(struct Curl_easy *data, int sockindex)
  407. {
  408. struct Curl_cfilter *cf;
  409. cf = data->conn->cfilter[sockindex];
  410. while(cf) {
  411. if(cf->connected)
  412. return TRUE;
  413. if(cf->cft->flags & CF_TYPE_IP_CONNECT)
  414. return FALSE;
  415. cf = cf->next;
  416. }
  417. return FALSE;
  418. }
  419. bool Curl_conn_cf_is_ssl(struct Curl_cfilter *cf)
  420. {
  421. for(; cf; cf = cf->next) {
  422. if(cf->cft->flags & CF_TYPE_SSL)
  423. return TRUE;
  424. if(cf->cft->flags & CF_TYPE_IP_CONNECT)
  425. return FALSE;
  426. }
  427. return FALSE;
  428. }
  429. bool Curl_conn_is_ssl(struct connectdata *conn, int sockindex)
  430. {
  431. return conn ? Curl_conn_cf_is_ssl(conn->cfilter[sockindex]) : FALSE;
  432. }
  433. bool Curl_conn_is_multiplex(struct connectdata *conn, int sockindex)
  434. {
  435. struct Curl_cfilter *cf = conn ? conn->cfilter[sockindex] : NULL;
  436. for(; cf; cf = cf->next) {
  437. if(cf->cft->flags & CF_TYPE_MULTIPLEX)
  438. return TRUE;
  439. if(cf->cft->flags & (CF_TYPE_IP_CONNECT|CF_TYPE_SSL))
  440. return FALSE;
  441. }
  442. return FALSE;
  443. }
  444. unsigned char Curl_conn_http_version(struct Curl_easy *data)
  445. {
  446. struct Curl_cfilter *cf;
  447. CURLcode result = CURLE_UNKNOWN_OPTION;
  448. unsigned char v = 0;
  449. cf = data->conn ? data->conn->cfilter[FIRSTSOCKET] : NULL;
  450. for(; cf; cf = cf->next) {
  451. if(cf->cft->flags & CF_TYPE_HTTP) {
  452. int value = 0;
  453. result = cf->cft->query(cf, data, CF_QUERY_HTTP_VERSION, &value, NULL);
  454. if(!result && ((value < 0) || (value > 255)))
  455. result = CURLE_FAILED_INIT;
  456. else
  457. v = (unsigned char)value;
  458. break;
  459. }
  460. if(cf->cft->flags & (CF_TYPE_IP_CONNECT|CF_TYPE_SSL))
  461. break;
  462. }
  463. return (unsigned char)(result ? 0 : v);
  464. }
  465. bool Curl_conn_data_pending(struct Curl_easy *data, int sockindex)
  466. {
  467. struct Curl_cfilter *cf;
  468. (void)data;
  469. DEBUGASSERT(data);
  470. DEBUGASSERT(data->conn);
  471. cf = data->conn->cfilter[sockindex];
  472. while(cf && !cf->connected) {
  473. cf = cf->next;
  474. }
  475. if(cf) {
  476. return cf->cft->has_data_pending(cf, data);
  477. }
  478. return FALSE;
  479. }
  480. bool Curl_conn_cf_needs_flush(struct Curl_cfilter *cf,
  481. struct Curl_easy *data)
  482. {
  483. CURLcode result;
  484. int pending = 0;
  485. result = cf ? cf->cft->query(cf, data, CF_QUERY_NEED_FLUSH,
  486. &pending, NULL) : CURLE_UNKNOWN_OPTION;
  487. return (result || !pending) ? FALSE : TRUE;
  488. }
  489. bool Curl_conn_needs_flush(struct Curl_easy *data, int sockindex)
  490. {
  491. return Curl_conn_cf_needs_flush(data->conn->cfilter[sockindex], data);
  492. }
  493. void Curl_conn_cf_adjust_pollset(struct Curl_cfilter *cf,
  494. struct Curl_easy *data,
  495. struct easy_pollset *ps)
  496. {
  497. /* Get the lowest not-connected filter, if there are any */
  498. while(cf && !cf->connected && cf->next && !cf->next->connected)
  499. cf = cf->next;
  500. /* Skip all filters that have already shut down */
  501. while(cf && cf->shutdown)
  502. cf = cf->next;
  503. /* From there on, give all filters a chance to adjust the pollset.
  504. * Lower filters are called later, so they may override */
  505. while(cf) {
  506. cf->cft->adjust_pollset(cf, data, ps);
  507. cf = cf->next;
  508. }
  509. }
  510. void Curl_conn_adjust_pollset(struct Curl_easy *data,
  511. struct easy_pollset *ps)
  512. {
  513. int i;
  514. DEBUGASSERT(data);
  515. DEBUGASSERT(data->conn);
  516. for(i = 0; i < 2; ++i) {
  517. Curl_conn_cf_adjust_pollset(data->conn->cfilter[i], data, ps);
  518. }
  519. }
  520. int Curl_conn_cf_poll(struct Curl_cfilter *cf,
  521. struct Curl_easy *data,
  522. timediff_t timeout_ms)
  523. {
  524. struct easy_pollset ps;
  525. struct pollfd pfds[MAX_SOCKSPEREASYHANDLE];
  526. unsigned int i, npfds = 0;
  527. DEBUGASSERT(cf);
  528. DEBUGASSERT(data);
  529. DEBUGASSERT(data->conn);
  530. memset(&ps, 0, sizeof(ps));
  531. memset(pfds, 0, sizeof(pfds));
  532. Curl_conn_cf_adjust_pollset(cf, data, &ps);
  533. DEBUGASSERT(ps.num <= MAX_SOCKSPEREASYHANDLE);
  534. for(i = 0; i < ps.num; ++i) {
  535. short events = 0;
  536. if(ps.actions[i] & CURL_POLL_IN) {
  537. events |= POLLIN;
  538. }
  539. if(ps.actions[i] & CURL_POLL_OUT) {
  540. events |= POLLOUT;
  541. }
  542. if(events) {
  543. pfds[npfds].fd = ps.sockets[i];
  544. pfds[npfds].events = events;
  545. ++npfds;
  546. }
  547. }
  548. if(!npfds)
  549. DEBUGF(infof(data, "no sockets to poll!"));
  550. return Curl_poll(pfds, npfds, timeout_ms);
  551. }
  552. void Curl_conn_get_host(struct Curl_easy *data, int sockindex,
  553. const char **phost, const char **pdisplay_host,
  554. int *pport)
  555. {
  556. struct Curl_cfilter *cf;
  557. DEBUGASSERT(data->conn);
  558. cf = data->conn->cfilter[sockindex];
  559. if(cf) {
  560. cf->cft->get_host(cf, data, phost, pdisplay_host, pport);
  561. }
  562. else {
  563. /* Some filter ask during shutdown for this, mainly for debugging
  564. * purposes. We hand out the defaults, however this is not always
  565. * accurate, as the connection might be tunneled, etc. But all that
  566. * state is already gone here. */
  567. *phost = data->conn->host.name;
  568. *pdisplay_host = data->conn->host.dispname;
  569. *pport = data->conn->remote_port;
  570. }
  571. }
  572. CURLcode Curl_cf_def_cntrl(struct Curl_cfilter *cf,
  573. struct Curl_easy *data,
  574. int event, int arg1, void *arg2)
  575. {
  576. (void)cf;
  577. (void)data;
  578. (void)event;
  579. (void)arg1;
  580. (void)arg2;
  581. return CURLE_OK;
  582. }
  583. CURLcode Curl_conn_cf_cntrl(struct Curl_cfilter *cf,
  584. struct Curl_easy *data,
  585. bool ignore_result,
  586. int event, int arg1, void *arg2)
  587. {
  588. CURLcode result = CURLE_OK;
  589. for(; cf; cf = cf->next) {
  590. if(Curl_cf_def_cntrl == cf->cft->cntrl)
  591. continue;
  592. result = cf->cft->cntrl(cf, data, event, arg1, arg2);
  593. if(!ignore_result && result)
  594. break;
  595. }
  596. return result;
  597. }
  598. curl_socket_t Curl_conn_cf_get_socket(struct Curl_cfilter *cf,
  599. struct Curl_easy *data)
  600. {
  601. curl_socket_t sock;
  602. if(cf && !cf->cft->query(cf, data, CF_QUERY_SOCKET, NULL, &sock))
  603. return sock;
  604. return CURL_SOCKET_BAD;
  605. }
  606. CURLcode Curl_conn_cf_get_ip_info(struct Curl_cfilter *cf,
  607. struct Curl_easy *data,
  608. int *is_ipv6, struct ip_quadruple *ipquad)
  609. {
  610. if(cf)
  611. return cf->cft->query(cf, data, CF_QUERY_IP_INFO, is_ipv6, ipquad);
  612. return CURLE_UNKNOWN_OPTION;
  613. }
  614. curl_socket_t Curl_conn_get_socket(struct Curl_easy *data, int sockindex)
  615. {
  616. struct Curl_cfilter *cf;
  617. cf = data->conn ? data->conn->cfilter[sockindex] : NULL;
  618. /* if the top filter has not connected, ask it (and its sub-filters)
  619. * for the socket. Otherwise conn->sock[sockindex] should have it.
  620. */
  621. if(cf && !cf->connected)
  622. return Curl_conn_cf_get_socket(cf, data);
  623. return data->conn ? data->conn->sock[sockindex] : CURL_SOCKET_BAD;
  624. }
  625. void Curl_conn_forget_socket(struct Curl_easy *data, int sockindex)
  626. {
  627. if(data->conn) {
  628. struct Curl_cfilter *cf = data->conn->cfilter[sockindex];
  629. if(cf)
  630. (void)Curl_conn_cf_cntrl(cf, data, TRUE,
  631. CF_CTRL_FORGET_SOCKET, 0, NULL);
  632. fake_sclose(data->conn->sock[sockindex]);
  633. data->conn->sock[sockindex] = CURL_SOCKET_BAD;
  634. }
  635. }
  636. static CURLcode cf_cntrl_all(struct connectdata *conn,
  637. struct Curl_easy *data,
  638. bool ignore_result,
  639. int event, int arg1, void *arg2)
  640. {
  641. CURLcode result = CURLE_OK;
  642. size_t i;
  643. for(i = 0; i < ARRAYSIZE(conn->cfilter); ++i) {
  644. result = Curl_conn_cf_cntrl(conn->cfilter[i], data, ignore_result,
  645. event, arg1, arg2);
  646. if(!ignore_result && result)
  647. break;
  648. }
  649. return result;
  650. }
  651. CURLcode Curl_conn_ev_data_setup(struct Curl_easy *data)
  652. {
  653. return cf_cntrl_all(data->conn, data, FALSE,
  654. CF_CTRL_DATA_SETUP, 0, NULL);
  655. }
  656. CURLcode Curl_conn_ev_data_idle(struct Curl_easy *data)
  657. {
  658. return cf_cntrl_all(data->conn, data, FALSE,
  659. CF_CTRL_DATA_IDLE, 0, NULL);
  660. }
  661. CURLcode Curl_conn_flush(struct Curl_easy *data, int sockindex)
  662. {
  663. return Curl_conn_cf_cntrl(data->conn->cfilter[sockindex], data, FALSE,
  664. CF_CTRL_FLUSH, 0, NULL);
  665. }
  666. /**
  667. * Notify connection filters that the transfer represented by `data`
  668. * is done with sending data (e.g. has uploaded everything).
  669. */
  670. void Curl_conn_ev_data_done_send(struct Curl_easy *data)
  671. {
  672. cf_cntrl_all(data->conn, data, TRUE, CF_CTRL_DATA_DONE_SEND, 0, NULL);
  673. }
  674. /**
  675. * Notify connection filters that the transfer represented by `data`
  676. * is finished - eventually premature, e.g. before being complete.
  677. */
  678. void Curl_conn_ev_data_done(struct Curl_easy *data, bool premature)
  679. {
  680. cf_cntrl_all(data->conn, data, TRUE, CF_CTRL_DATA_DONE, premature, NULL);
  681. }
  682. CURLcode Curl_conn_ev_data_pause(struct Curl_easy *data, bool do_pause)
  683. {
  684. return cf_cntrl_all(data->conn, data, FALSE,
  685. CF_CTRL_DATA_PAUSE, do_pause, NULL);
  686. }
  687. static void cf_cntrl_update_info(struct Curl_easy *data,
  688. struct connectdata *conn)
  689. {
  690. cf_cntrl_all(conn, data, TRUE, CF_CTRL_CONN_INFO_UPDATE, 0, NULL);
  691. }
  692. /**
  693. * Update connection statistics
  694. */
  695. static void conn_report_connect_stats(struct Curl_easy *data,
  696. struct connectdata *conn)
  697. {
  698. struct Curl_cfilter *cf = conn->cfilter[FIRSTSOCKET];
  699. if(cf) {
  700. struct curltime connected;
  701. struct curltime appconnected;
  702. memset(&connected, 0, sizeof(connected));
  703. cf->cft->query(cf, data, CF_QUERY_TIMER_CONNECT, NULL, &connected);
  704. if(connected.tv_sec || connected.tv_usec)
  705. Curl_pgrsTimeWas(data, TIMER_CONNECT, connected);
  706. memset(&appconnected, 0, sizeof(appconnected));
  707. cf->cft->query(cf, data, CF_QUERY_TIMER_APPCONNECT, NULL, &appconnected);
  708. if(appconnected.tv_sec || appconnected.tv_usec)
  709. Curl_pgrsTimeWas(data, TIMER_APPCONNECT, appconnected);
  710. }
  711. }
  712. bool Curl_conn_is_alive(struct Curl_easy *data, struct connectdata *conn,
  713. bool *input_pending)
  714. {
  715. struct Curl_cfilter *cf = conn->cfilter[FIRSTSOCKET];
  716. return cf && !cf->conn->bits.close &&
  717. cf->cft->is_alive(cf, data, input_pending);
  718. }
  719. CURLcode Curl_conn_keep_alive(struct Curl_easy *data,
  720. struct connectdata *conn,
  721. int sockindex)
  722. {
  723. struct Curl_cfilter *cf = conn->cfilter[sockindex];
  724. return cf ? cf->cft->keep_alive(cf, data) : CURLE_OK;
  725. }
  726. size_t Curl_conn_get_max_concurrent(struct Curl_easy *data,
  727. struct connectdata *conn,
  728. int sockindex)
  729. {
  730. CURLcode result;
  731. int n = 0;
  732. struct Curl_cfilter *cf = conn->cfilter[sockindex];
  733. result = cf ? cf->cft->query(cf, data, CF_QUERY_MAX_CONCURRENT,
  734. &n, NULL) : CURLE_UNKNOWN_OPTION;
  735. return (result || n <= 0) ? 1 : (size_t)n;
  736. }
  737. int Curl_conn_get_stream_error(struct Curl_easy *data,
  738. struct connectdata *conn,
  739. int sockindex)
  740. {
  741. CURLcode result;
  742. int n = 0;
  743. struct Curl_cfilter *cf = conn->cfilter[sockindex];
  744. result = cf ? cf->cft->query(cf, data, CF_QUERY_STREAM_ERROR,
  745. &n, NULL) : CURLE_UNKNOWN_OPTION;
  746. return (result || n < 0) ? 0 : n;
  747. }
  748. int Curl_conn_sockindex(struct Curl_easy *data, curl_socket_t sockfd)
  749. {
  750. if(data && data->conn &&
  751. sockfd != CURL_SOCKET_BAD && sockfd == data->conn->sock[SECONDARYSOCKET])
  752. return SECONDARYSOCKET;
  753. return FIRSTSOCKET;
  754. }
  755. CURLcode Curl_conn_recv(struct Curl_easy *data, int sockindex,
  756. char *buf, size_t blen, ssize_t *n)
  757. {
  758. CURLcode result = CURLE_OK;
  759. ssize_t nread;
  760. DEBUGASSERT(data->conn);
  761. nread = data->conn->recv[sockindex](data, sockindex, buf, blen, &result);
  762. DEBUGASSERT(nread >= 0 || result);
  763. DEBUGASSERT(nread < 0 || !result);
  764. *n = (nread >= 0) ? (size_t)nread : 0;
  765. return result;
  766. }
  767. CURLcode Curl_conn_send(struct Curl_easy *data, int sockindex,
  768. const void *buf, size_t blen, bool eos,
  769. size_t *pnwritten)
  770. {
  771. size_t write_len = blen;
  772. ssize_t nwritten;
  773. CURLcode result = CURLE_OK;
  774. struct connectdata *conn;
  775. DEBUGASSERT(sockindex >= 0 && sockindex < 2);
  776. DEBUGASSERT(pnwritten);
  777. DEBUGASSERT(data);
  778. DEBUGASSERT(data->conn);
  779. conn = data->conn;
  780. #ifdef DEBUGBUILD
  781. {
  782. /* Allow debug builds to override this logic to force short sends
  783. */
  784. char *p = getenv("CURL_SMALLSENDS");
  785. if(p) {
  786. size_t altsize = (size_t)strtoul(p, NULL, 10);
  787. if(altsize)
  788. write_len = CURLMIN(write_len, altsize);
  789. }
  790. }
  791. #endif
  792. if(write_len != blen)
  793. eos = FALSE;
  794. nwritten = conn->send[sockindex](data, sockindex, buf, write_len, eos,
  795. &result);
  796. DEBUGASSERT((nwritten >= 0) || result);
  797. *pnwritten = (nwritten < 0) ? 0 : (size_t)nwritten;
  798. return result;
  799. }
  800. void Curl_pollset_reset(struct Curl_easy *data,
  801. struct easy_pollset *ps)
  802. {
  803. size_t i;
  804. (void)data;
  805. memset(ps, 0, sizeof(*ps));
  806. for(i = 0; i < MAX_SOCKSPEREASYHANDLE; i++)
  807. ps->sockets[i] = CURL_SOCKET_BAD;
  808. }
  809. /**
  810. *
  811. */
  812. void Curl_pollset_change(struct Curl_easy *data,
  813. struct easy_pollset *ps, curl_socket_t sock,
  814. int add_flags, int remove_flags)
  815. {
  816. unsigned int i;
  817. (void)data;
  818. DEBUGASSERT(VALID_SOCK(sock));
  819. if(!VALID_SOCK(sock))
  820. return;
  821. DEBUGASSERT(add_flags <= (CURL_POLL_IN|CURL_POLL_OUT));
  822. DEBUGASSERT(remove_flags <= (CURL_POLL_IN|CURL_POLL_OUT));
  823. DEBUGASSERT((add_flags&remove_flags) == 0); /* no overlap */
  824. for(i = 0; i < ps->num; ++i) {
  825. if(ps->sockets[i] == sock) {
  826. ps->actions[i] &= (unsigned char)(~remove_flags);
  827. ps->actions[i] |= (unsigned char)add_flags;
  828. /* all gone? remove socket */
  829. if(!ps->actions[i]) {
  830. if((i + 1) < ps->num) {
  831. memmove(&ps->sockets[i], &ps->sockets[i + 1],
  832. (ps->num - (i + 1)) * sizeof(ps->sockets[0]));
  833. memmove(&ps->actions[i], &ps->actions[i + 1],
  834. (ps->num - (i + 1)) * sizeof(ps->actions[0]));
  835. }
  836. --ps->num;
  837. }
  838. return;
  839. }
  840. }
  841. /* not present */
  842. if(add_flags) {
  843. /* Having more SOCKETS per easy handle than what is defined
  844. * is a programming error. This indicates that we need
  845. * to raise this limit, making easy_pollset larger.
  846. * Since we use this in tight loops, we do not want to make
  847. * the pollset dynamic unnecessarily.
  848. * The current maximum in practise is HTTP/3 eyeballing where
  849. * we have up to 4 sockets involved in connection setup.
  850. */
  851. DEBUGASSERT(i < MAX_SOCKSPEREASYHANDLE);
  852. if(i < MAX_SOCKSPEREASYHANDLE) {
  853. ps->sockets[i] = sock;
  854. ps->actions[i] = (unsigned char)add_flags;
  855. ps->num = i + 1;
  856. }
  857. }
  858. }
  859. void Curl_pollset_set(struct Curl_easy *data,
  860. struct easy_pollset *ps, curl_socket_t sock,
  861. bool do_in, bool do_out)
  862. {
  863. Curl_pollset_change(data, ps, sock,
  864. (do_in ? CURL_POLL_IN : 0)|
  865. (do_out ? CURL_POLL_OUT : 0),
  866. (!do_in ? CURL_POLL_IN : 0)|
  867. (!do_out ? CURL_POLL_OUT : 0));
  868. }
  869. static void ps_add(struct Curl_easy *data, struct easy_pollset *ps,
  870. int bitmap, curl_socket_t *socks)
  871. {
  872. if(bitmap) {
  873. int i;
  874. for(i = 0; i < MAX_SOCKSPEREASYHANDLE; ++i) {
  875. if(!(bitmap & GETSOCK_MASK_RW(i)) || !VALID_SOCK((socks[i]))) {
  876. break;
  877. }
  878. if(bitmap & GETSOCK_READSOCK(i)) {
  879. if(bitmap & GETSOCK_WRITESOCK(i))
  880. Curl_pollset_add_inout(data, ps, socks[i]);
  881. else
  882. /* is READ, since we checked MASK_RW above */
  883. Curl_pollset_add_in(data, ps, socks[i]);
  884. }
  885. else
  886. Curl_pollset_add_out(data, ps, socks[i]);
  887. }
  888. }
  889. }
  890. void Curl_pollset_add_socks(struct Curl_easy *data,
  891. struct easy_pollset *ps,
  892. int (*get_socks_cb)(struct Curl_easy *data,
  893. curl_socket_t *socks))
  894. {
  895. curl_socket_t socks[MAX_SOCKSPEREASYHANDLE];
  896. int bitmap;
  897. bitmap = get_socks_cb(data, socks);
  898. ps_add(data, ps, bitmap, socks);
  899. }
  900. void Curl_pollset_check(struct Curl_easy *data,
  901. struct easy_pollset *ps, curl_socket_t sock,
  902. bool *pwant_read, bool *pwant_write)
  903. {
  904. unsigned int i;
  905. (void)data;
  906. DEBUGASSERT(VALID_SOCK(sock));
  907. for(i = 0; i < ps->num; ++i) {
  908. if(ps->sockets[i] == sock) {
  909. *pwant_read = !!(ps->actions[i] & CURL_POLL_IN);
  910. *pwant_write = !!(ps->actions[i] & CURL_POLL_OUT);
  911. return;
  912. }
  913. }
  914. *pwant_read = *pwant_write = FALSE;
  915. }