cfilters.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646
  1. #ifndef HEADER_CURL_CFILTERS_H
  2. #define HEADER_CURL_CFILTERS_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 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.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. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. struct Curl_cfilter;
  27. struct Curl_easy;
  28. struct Curl_dns_entry;
  29. struct connectdata;
  30. /* Callback to destroy resources held by this filter instance.
  31. * Implementations MUST NOT chain calls to cf->next.
  32. */
  33. typedef void Curl_cft_destroy_this(struct Curl_cfilter *cf,
  34. struct Curl_easy *data);
  35. typedef void Curl_cft_close(struct Curl_cfilter *cf,
  36. struct Curl_easy *data);
  37. typedef CURLcode Curl_cft_connect(struct Curl_cfilter *cf,
  38. struct Curl_easy *data,
  39. bool blocking, bool *done);
  40. /* Return the hostname and port the connection goes to.
  41. * This may change with the connection state of filters when tunneling
  42. * is involved.
  43. * @param cf the filter to ask
  44. * @param data the easy handle currently active
  45. * @param phost on return, points to the relevant, real hostname.
  46. * this is owned by the connection.
  47. * @param pdisplay_host on return, points to the printable hostname.
  48. * this is owned by the connection.
  49. * @param pport on return, contains the port number
  50. */
  51. typedef void Curl_cft_get_host(struct Curl_cfilter *cf,
  52. struct Curl_easy *data,
  53. const char **phost,
  54. const char **pdisplay_host,
  55. int *pport);
  56. struct easy_pollset;
  57. /* Passing in an easy_pollset for monitoring of sockets, let
  58. * filters add or remove sockets actions (CURL_POLL_OUT, CURL_POLL_IN).
  59. * This may add a socket or, in case no actions remain, remove
  60. * a socket from the set.
  61. *
  62. * Filter implementations need to call filters "below" *after* they have
  63. * made their adjustments. This allows lower filters to override "upper"
  64. * actions. If a "lower" filter is unable to write, it needs to be able
  65. * to disallow POLL_OUT.
  66. *
  67. * A filter without own restrictions/preferences should not modify
  68. * the pollset. Filters, whose filter "below" is not connected, should
  69. * also do no adjustments.
  70. *
  71. * Examples: a TLS handshake, while ongoing, might remove POLL_IN
  72. * when it needs to write, or vice versa. A HTTP/2 filter might remove
  73. * POLL_OUT when a stream window is exhausted and a WINDOW_UPDATE needs
  74. * to be received first and add instead POLL_IN.
  75. *
  76. * @param cf the filter to ask
  77. * @param data the easy handle the pollset is about
  78. * @param ps the pollset (inout) for the easy handle
  79. */
  80. typedef void Curl_cft_adjust_pollset(struct Curl_cfilter *cf,
  81. struct Curl_easy *data,
  82. struct easy_pollset *ps);
  83. typedef bool Curl_cft_data_pending(struct Curl_cfilter *cf,
  84. const struct Curl_easy *data);
  85. typedef ssize_t Curl_cft_send(struct Curl_cfilter *cf,
  86. struct Curl_easy *data, /* transfer */
  87. const void *buf, /* data to write */
  88. size_t len, /* amount to write */
  89. CURLcode *err); /* error to return */
  90. typedef ssize_t Curl_cft_recv(struct Curl_cfilter *cf,
  91. struct Curl_easy *data, /* transfer */
  92. char *buf, /* store data here */
  93. size_t len, /* amount to read */
  94. CURLcode *err); /* error to return */
  95. typedef bool Curl_cft_conn_is_alive(struct Curl_cfilter *cf,
  96. struct Curl_easy *data,
  97. bool *input_pending);
  98. typedef CURLcode Curl_cft_conn_keep_alive(struct Curl_cfilter *cf,
  99. struct Curl_easy *data);
  100. /**
  101. * Events/controls for connection filters, their arguments and
  102. * return code handling. Filter callbacks are invoked "top down".
  103. * Return code handling:
  104. * "first fail" meaning that the first filter returning != CURLE_OK, will
  105. * abort further event distribution and determine the result.
  106. * "ignored" meaning return values are ignored and the event is distributed
  107. * to all filters in the chain. Overall result is always CURLE_OK.
  108. */
  109. /* data event arg1 arg2 return */
  110. #define CF_CTRL_DATA_ATTACH 1 /* 0 NULL ignored */
  111. #define CF_CTRL_DATA_DETACH 2 /* 0 NULL ignored */
  112. #define CF_CTRL_DATA_SETUP 4 /* 0 NULL first fail */
  113. #define CF_CTRL_DATA_IDLE 5 /* 0 NULL first fail */
  114. #define CF_CTRL_DATA_PAUSE 6 /* on/off NULL first fail */
  115. #define CF_CTRL_DATA_DONE 7 /* premature NULL ignored */
  116. #define CF_CTRL_DATA_DONE_SEND 8 /* 0 NULL ignored */
  117. /* update conn info at connection and data */
  118. #define CF_CTRL_CONN_INFO_UPDATE (256+0) /* 0 NULL ignored */
  119. #define CF_CTRL_FORGET_SOCKET (256+1) /* 0 NULL ignored */
  120. /**
  121. * Handle event/control for the filter.
  122. * Implementations MUST NOT chain calls to cf->next.
  123. */
  124. typedef CURLcode Curl_cft_cntrl(struct Curl_cfilter *cf,
  125. struct Curl_easy *data,
  126. int event, int arg1, void *arg2);
  127. /**
  128. * Queries to ask via a `Curl_cft_query *query` method on a cfilter chain.
  129. * - MAX_CONCURRENT: the maximum number of parallel transfers the filter
  130. * chain expects to handle at the same time.
  131. * default: 1 if no filter overrides.
  132. * - CONNECT_REPLY_MS: milliseconds until the first indication of a server
  133. * response was received on a connect. For TCP, this
  134. * reflects the time until the socket connected. On UDP
  135. * this gives the time the first bytes from the server
  136. * were received.
  137. * -1 if not determined yet.
  138. * - CF_QUERY_SOCKET: the socket used by the filter chain
  139. */
  140. /* query res1 res2 */
  141. #define CF_QUERY_MAX_CONCURRENT 1 /* number - */
  142. #define CF_QUERY_CONNECT_REPLY_MS 2 /* number - */
  143. #define CF_QUERY_SOCKET 3 /* - curl_socket_t */
  144. #define CF_QUERY_TIMER_CONNECT 4 /* - struct curltime */
  145. #define CF_QUERY_TIMER_APPCONNECT 5 /* - struct curltime */
  146. #define CF_QUERY_STREAM_ERROR 6 /* error code - */
  147. /**
  148. * Query the cfilter for properties. Filters ignorant of a query will
  149. * pass it "down" the filter chain.
  150. */
  151. typedef CURLcode Curl_cft_query(struct Curl_cfilter *cf,
  152. struct Curl_easy *data,
  153. int query, int *pres1, void *pres2);
  154. /**
  155. * Type flags for connection filters. A filter can have none, one or
  156. * many of those. Use to evaluate state/capabilities of a filter chain.
  157. *
  158. * CF_TYPE_IP_CONNECT: provides an IP connection or sth equivalent, like
  159. * a CONNECT tunnel, a UNIX domain socket, a QUIC
  160. * connection, etc.
  161. * CF_TYPE_SSL: provide SSL/TLS
  162. * CF_TYPE_MULTIPLEX: provides multiplexing of easy handles
  163. * CF_TYPE_PROXY provides proxying
  164. */
  165. #define CF_TYPE_IP_CONNECT (1 << 0)
  166. #define CF_TYPE_SSL (1 << 1)
  167. #define CF_TYPE_MULTIPLEX (1 << 2)
  168. #define CF_TYPE_PROXY (1 << 3)
  169. /* A connection filter type, e.g. specific implementation. */
  170. struct Curl_cftype {
  171. const char *name; /* name of the filter type */
  172. int flags; /* flags of filter type */
  173. int log_level; /* log level for such filters */
  174. Curl_cft_destroy_this *destroy; /* destroy resources of this cf */
  175. Curl_cft_connect *do_connect; /* establish connection */
  176. Curl_cft_close *do_close; /* close conn */
  177. Curl_cft_get_host *get_host; /* host filter talks to */
  178. Curl_cft_adjust_pollset *adjust_pollset; /* adjust transfer poll set */
  179. Curl_cft_data_pending *has_data_pending;/* conn has data pending */
  180. Curl_cft_send *do_send; /* send data */
  181. Curl_cft_recv *do_recv; /* receive data */
  182. Curl_cft_cntrl *cntrl; /* events/control */
  183. Curl_cft_conn_is_alive *is_alive; /* FALSE if conn is dead, Jim! */
  184. Curl_cft_conn_keep_alive *keep_alive; /* try to keep it alive */
  185. Curl_cft_query *query; /* query filter chain */
  186. };
  187. /* A connection filter instance, e.g. registered at a connection */
  188. struct Curl_cfilter {
  189. const struct Curl_cftype *cft; /* the type providing implementation */
  190. struct Curl_cfilter *next; /* next filter in chain */
  191. void *ctx; /* filter type specific settings */
  192. struct connectdata *conn; /* the connection this filter belongs to */
  193. int sockindex; /* the index the filter is installed at */
  194. BIT(connected); /* != 0 iff this filter is connected */
  195. };
  196. /* Default implementations for the type functions, implementing nop. */
  197. void Curl_cf_def_destroy_this(struct Curl_cfilter *cf,
  198. struct Curl_easy *data);
  199. /* Default implementations for the type functions, implementing pass-through
  200. * the filter chain. */
  201. void Curl_cf_def_get_host(struct Curl_cfilter *cf, struct Curl_easy *data,
  202. const char **phost, const char **pdisplay_host,
  203. int *pport);
  204. void Curl_cf_def_adjust_pollset(struct Curl_cfilter *cf,
  205. struct Curl_easy *data,
  206. struct easy_pollset *ps);
  207. bool Curl_cf_def_data_pending(struct Curl_cfilter *cf,
  208. const struct Curl_easy *data);
  209. ssize_t Curl_cf_def_send(struct Curl_cfilter *cf, struct Curl_easy *data,
  210. const void *buf, size_t len, CURLcode *err);
  211. ssize_t Curl_cf_def_recv(struct Curl_cfilter *cf, struct Curl_easy *data,
  212. char *buf, size_t len, CURLcode *err);
  213. CURLcode Curl_cf_def_cntrl(struct Curl_cfilter *cf,
  214. struct Curl_easy *data,
  215. int event, int arg1, void *arg2);
  216. bool Curl_cf_def_conn_is_alive(struct Curl_cfilter *cf,
  217. struct Curl_easy *data,
  218. bool *input_pending);
  219. CURLcode Curl_cf_def_conn_keep_alive(struct Curl_cfilter *cf,
  220. struct Curl_easy *data);
  221. CURLcode Curl_cf_def_query(struct Curl_cfilter *cf,
  222. struct Curl_easy *data,
  223. int query, int *pres1, void *pres2);
  224. /**
  225. * Create a new filter instance, unattached to the filter chain.
  226. * Use Curl_conn_cf_add() to add it to the chain.
  227. * @param pcf on success holds the created instance
  228. * @param cft the filter type
  229. * @param ctx the type specific context to use
  230. */
  231. CURLcode Curl_cf_create(struct Curl_cfilter **pcf,
  232. const struct Curl_cftype *cft,
  233. void *ctx);
  234. /**
  235. * Add a filter instance to the `sockindex` filter chain at connection
  236. * `conn`. The filter must not already be attached. It is inserted at
  237. * the start of the chain (top).
  238. */
  239. void Curl_conn_cf_add(struct Curl_easy *data,
  240. struct connectdata *conn,
  241. int sockindex,
  242. struct Curl_cfilter *cf);
  243. /**
  244. * Insert a filter (chain) after `cf_at`.
  245. * `cf_new` must not already be attached.
  246. */
  247. void Curl_conn_cf_insert_after(struct Curl_cfilter *cf_at,
  248. struct Curl_cfilter *cf_new);
  249. /**
  250. * Discard, e.g. remove and destroy `discard` iff
  251. * it still is in the filter chain below `cf`. If `discard`
  252. * is no longer found beneath `cf` return FALSE.
  253. * if `destroy_always` is TRUE, will call `discard`s destroy
  254. * function and free it even if not found in the subchain.
  255. */
  256. bool Curl_conn_cf_discard_sub(struct Curl_cfilter *cf,
  257. struct Curl_cfilter *discard,
  258. struct Curl_easy *data,
  259. bool destroy_always);
  260. /**
  261. * Discard all cfilters starting with `*pcf` and clearing it afterwards.
  262. */
  263. void Curl_conn_cf_discard_chain(struct Curl_cfilter **pcf,
  264. struct Curl_easy *data);
  265. /**
  266. * Remove and destroy all filters at chain `sockindex` on connection `conn`.
  267. */
  268. void Curl_conn_cf_discard_all(struct Curl_easy *data,
  269. struct connectdata *conn,
  270. int sockindex);
  271. CURLcode Curl_conn_cf_connect(struct Curl_cfilter *cf,
  272. struct Curl_easy *data,
  273. bool blocking, bool *done);
  274. void Curl_conn_cf_close(struct Curl_cfilter *cf, struct Curl_easy *data);
  275. ssize_t Curl_conn_cf_send(struct Curl_cfilter *cf, struct Curl_easy *data,
  276. const void *buf, size_t len, CURLcode *err);
  277. ssize_t Curl_conn_cf_recv(struct Curl_cfilter *cf, struct Curl_easy *data,
  278. char *buf, size_t len, CURLcode *err);
  279. CURLcode Curl_conn_cf_cntrl(struct Curl_cfilter *cf,
  280. struct Curl_easy *data,
  281. bool ignore_result,
  282. int event, int arg1, void *arg2);
  283. /**
  284. * Determine if the connection filter chain is using SSL to the remote host
  285. * (or will be once connected).
  286. */
  287. bool Curl_conn_cf_is_ssl(struct Curl_cfilter *cf);
  288. /**
  289. * Get the socket used by the filter chain starting at `cf`.
  290. * Returns CURL_SOCKET_BAD if not available.
  291. */
  292. curl_socket_t Curl_conn_cf_get_socket(struct Curl_cfilter *cf,
  293. struct Curl_easy *data);
  294. #define CURL_CF_SSL_DEFAULT -1
  295. #define CURL_CF_SSL_DISABLE 0
  296. #define CURL_CF_SSL_ENABLE 1
  297. /**
  298. * Bring the filter chain at `sockindex` for connection `data->conn` into
  299. * connected state. Which will set `*done` to TRUE.
  300. * This can be called on an already connected chain with no side effects.
  301. * When not `blocking`, calls may return without error and `*done != TRUE`,
  302. * while the individual filters negotiated the connection.
  303. */
  304. CURLcode Curl_conn_connect(struct Curl_easy *data, int sockindex,
  305. bool blocking, bool *done);
  306. /**
  307. * Check if the filter chain at `sockindex` for connection `conn` is
  308. * completely connected.
  309. */
  310. bool Curl_conn_is_connected(struct connectdata *conn, int sockindex);
  311. /**
  312. * Determine if we have reached the remote host on IP level, e.g.
  313. * have a TCP connection. This turns TRUE before a possible SSL
  314. * handshake has been started/done.
  315. */
  316. bool Curl_conn_is_ip_connected(struct Curl_easy *data, int sockindex);
  317. /**
  318. * Determine if the connection is using SSL to the remote host
  319. * (or will be once connected). This will return FALSE, if SSL
  320. * is only used in proxying and not for the tunnel itself.
  321. */
  322. bool Curl_conn_is_ssl(struct connectdata *conn, int sockindex);
  323. /**
  324. * Connection provides multiplexing of easy handles at `socketindex`.
  325. */
  326. bool Curl_conn_is_multiplex(struct connectdata *conn, int sockindex);
  327. /**
  328. * Close the filter chain at `sockindex` for connection `data->conn`.
  329. * Filters remain in place and may be connected again afterwards.
  330. */
  331. void Curl_conn_close(struct Curl_easy *data, int sockindex);
  332. /**
  333. * Return if data is pending in some connection filter at chain
  334. * `sockindex` for connection `data->conn`.
  335. */
  336. bool Curl_conn_data_pending(struct Curl_easy *data,
  337. int sockindex);
  338. /**
  339. * Return the socket used on data's connection for the index.
  340. * Returns CURL_SOCKET_BAD if not available.
  341. */
  342. curl_socket_t Curl_conn_get_socket(struct Curl_easy *data, int sockindex);
  343. /**
  344. * Tell filters to forget about the socket at sockindex.
  345. */
  346. void Curl_conn_forget_socket(struct Curl_easy *data, int sockindex);
  347. /**
  348. * Adjust the pollset for the filter chain startgin at `cf`.
  349. */
  350. void Curl_conn_cf_adjust_pollset(struct Curl_cfilter *cf,
  351. struct Curl_easy *data,
  352. struct easy_pollset *ps);
  353. /**
  354. * Adjust pollset from filters installed at transfer's connection.
  355. */
  356. void Curl_conn_adjust_pollset(struct Curl_easy *data,
  357. struct easy_pollset *ps);
  358. /**
  359. * Receive data through the filter chain at `sockindex` for connection
  360. * `data->conn`. Copy at most `len` bytes into `buf`. Return the
  361. * actual number of bytes copied or a negative value on error.
  362. * The error code is placed into `*code`.
  363. */
  364. ssize_t Curl_cf_recv(struct Curl_easy *data, int sockindex, char *buf,
  365. size_t len, CURLcode *code);
  366. /**
  367. * Send `len` bytes of data from `buf` through the filter chain `sockindex`
  368. * at connection `data->conn`. Return the actual number of bytes written
  369. * or a negative value on error.
  370. * The error code is placed into `*code`.
  371. */
  372. ssize_t Curl_cf_send(struct Curl_easy *data, int sockindex,
  373. const void *buf, size_t len, CURLcode *code);
  374. /**
  375. * The easy handle `data` is being attached to `conn`. This does
  376. * not mean that data will actually do a transfer. Attachment is
  377. * also used for temporary actions on the connection.
  378. */
  379. void Curl_conn_ev_data_attach(struct connectdata *conn,
  380. struct Curl_easy *data);
  381. /**
  382. * The easy handle `data` is being detached (no longer served)
  383. * by connection `conn`. All filters are informed to release any resources
  384. * related to `data`.
  385. * Note: there may be several `data` attached to a connection at the same
  386. * time.
  387. */
  388. void Curl_conn_ev_data_detach(struct connectdata *conn,
  389. struct Curl_easy *data);
  390. /**
  391. * Notify connection filters that they need to setup data for
  392. * a transfer.
  393. */
  394. CURLcode Curl_conn_ev_data_setup(struct Curl_easy *data);
  395. /**
  396. * Notify connection filters that now would be a good time to
  397. * perform any idle, e.g. time related, actions.
  398. */
  399. CURLcode Curl_conn_ev_data_idle(struct Curl_easy *data);
  400. /**
  401. * Notify connection filters that the transfer represented by `data`
  402. * is done with sending data (e.g. has uploaded everything).
  403. */
  404. void Curl_conn_ev_data_done_send(struct Curl_easy *data);
  405. /**
  406. * Notify connection filters that the transfer represented by `data`
  407. * is finished - eventually premature, e.g. before being complete.
  408. */
  409. void Curl_conn_ev_data_done(struct Curl_easy *data, bool premature);
  410. /**
  411. * Notify connection filters that the transfer of data is paused/unpaused.
  412. */
  413. CURLcode Curl_conn_ev_data_pause(struct Curl_easy *data, bool do_pause);
  414. /**
  415. * Inform connection filters to update their info in `conn`.
  416. */
  417. void Curl_conn_ev_update_info(struct Curl_easy *data,
  418. struct connectdata *conn);
  419. /**
  420. * Check if FIRSTSOCKET's cfilter chain deems connection alive.
  421. */
  422. bool Curl_conn_is_alive(struct Curl_easy *data, struct connectdata *conn,
  423. bool *input_pending);
  424. /**
  425. * Try to upkeep the connection filters at sockindex.
  426. */
  427. CURLcode Curl_conn_keep_alive(struct Curl_easy *data,
  428. struct connectdata *conn,
  429. int sockindex);
  430. #ifdef UNITTESTS
  431. void Curl_cf_def_close(struct Curl_cfilter *cf, struct Curl_easy *data);
  432. #endif
  433. void Curl_conn_get_host(struct Curl_easy *data, int sockindex,
  434. const char **phost, const char **pdisplay_host,
  435. int *pport);
  436. /**
  437. * Get the maximum number of parallel transfers the connection
  438. * expects to be able to handle at `sockindex`.
  439. */
  440. size_t Curl_conn_get_max_concurrent(struct Curl_easy *data,
  441. struct connectdata *conn,
  442. int sockindex);
  443. /**
  444. * Get the underlying error code for a transfer stream or 0 if not known.
  445. */
  446. int Curl_conn_get_stream_error(struct Curl_easy *data,
  447. struct connectdata *conn,
  448. int sockindex);
  449. /**
  450. * Get the index of the given socket in the connection's sockets.
  451. * Useful in calling `Curl_conn_send()/Curl_conn_recv()` with the
  452. * correct socket index.
  453. */
  454. int Curl_conn_sockindex(struct Curl_easy *data, curl_socket_t sockfd);
  455. /*
  456. * Receive data on the connection, using FIRSTSOCKET/SECONDARYSOCKET.
  457. * Will return CURLE_AGAIN iff blocked on receiving.
  458. */
  459. CURLcode Curl_conn_recv(struct Curl_easy *data, int sockindex,
  460. char *buf, size_t buffersize,
  461. ssize_t *pnread);
  462. /*
  463. * Send data on the connection, using FIRSTSOCKET/SECONDARYSOCKET.
  464. * Will return CURLE_AGAIN iff blocked on sending.
  465. */
  466. CURLcode Curl_conn_send(struct Curl_easy *data, int sockindex,
  467. const void *buf, size_t blen,
  468. size_t *pnwritten);
  469. void Curl_pollset_reset(struct Curl_easy *data,
  470. struct easy_pollset *ps);
  471. /* Change the poll flags (CURL_POLL_IN/CURL_POLL_OUT) to the poll set for
  472. * socket `sock`. If the socket is not already part of the poll set, it
  473. * will be added.
  474. * If the socket is present and all poll flags are cleared, it will be removed.
  475. */
  476. void Curl_pollset_change(struct Curl_easy *data,
  477. struct easy_pollset *ps, curl_socket_t sock,
  478. int add_flags, int remove_flags);
  479. void Curl_pollset_set(struct Curl_easy *data,
  480. struct easy_pollset *ps, curl_socket_t sock,
  481. bool do_in, bool do_out);
  482. #define Curl_pollset_add_in(data, ps, sock) \
  483. Curl_pollset_change((data), (ps), (sock), CURL_POLL_IN, 0)
  484. #define Curl_pollset_add_out(data, ps, sock) \
  485. Curl_pollset_change((data), (ps), (sock), CURL_POLL_OUT, 0)
  486. #define Curl_pollset_add_inout(data, ps, sock) \
  487. Curl_pollset_change((data), (ps), (sock), \
  488. CURL_POLL_IN|CURL_POLL_OUT, 0)
  489. #define Curl_pollset_set_in_only(data, ps, sock) \
  490. Curl_pollset_change((data), (ps), (sock), \
  491. CURL_POLL_IN, CURL_POLL_OUT)
  492. #define Curl_pollset_set_out_only(data, ps, sock) \
  493. Curl_pollset_change((data), (ps), (sock), \
  494. CURL_POLL_OUT, CURL_POLL_IN)
  495. void Curl_pollset_add_socks(struct Curl_easy *data,
  496. struct easy_pollset *ps,
  497. int (*get_socks_cb)(struct Curl_easy *data,
  498. curl_socket_t *socks));
  499. /**
  500. * Check if the pollset, as is, wants to read and/or write regarding
  501. * the given socket.
  502. */
  503. void Curl_pollset_check(struct Curl_easy *data,
  504. struct easy_pollset *ps, curl_socket_t sock,
  505. bool *pwant_read, bool *pwant_write);
  506. /**
  507. * Types and macros used to keep the current easy handle in filter calls,
  508. * allowing for nested invocations. See #10336.
  509. *
  510. * `cf_call_data` is intended to be a member of the cfilter's `ctx` type.
  511. * A filter defines the macro `CF_CTX_CALL_DATA` to give access to that.
  512. *
  513. * With all values 0, the default, this indicates that there is no cfilter
  514. * call with `data` ongoing.
  515. * Macro `CF_DATA_SAVE` preserves the current `cf_call_data` in a local
  516. * variable and sets the `data` given, incrementing the `depth` counter.
  517. *
  518. * Macro `CF_DATA_RESTORE` restores the old values from the local variable,
  519. * while checking that `depth` values are as expected (debug build), catching
  520. * cases where a "lower" RESTORE was not called.
  521. *
  522. * Finally, macro `CF_DATA_CURRENT` gives the easy handle of the current
  523. * invocation.
  524. */
  525. struct cf_call_data {
  526. struct Curl_easy *data;
  527. #ifdef DEBUGBUILD
  528. int depth;
  529. #endif
  530. };
  531. /**
  532. * define to access the `struct cf_call_data for a cfilter. Normally
  533. * a member in the cfilter's `ctx`.
  534. *
  535. * #define CF_CTX_CALL_DATA(cf) -> struct cf_call_data instance
  536. */
  537. #ifdef DEBUGBUILD
  538. #define CF_DATA_SAVE(save, cf, data) \
  539. do { \
  540. (save) = CF_CTX_CALL_DATA(cf); \
  541. DEBUGASSERT((save).data == NULL || (save).depth > 0); \
  542. CF_CTX_CALL_DATA(cf).depth++; \
  543. CF_CTX_CALL_DATA(cf).data = (struct Curl_easy *)data; \
  544. } while(0)
  545. #define CF_DATA_RESTORE(cf, save) \
  546. do { \
  547. DEBUGASSERT(CF_CTX_CALL_DATA(cf).depth == (save).depth + 1); \
  548. DEBUGASSERT((save).data == NULL || (save).depth > 0); \
  549. CF_CTX_CALL_DATA(cf) = (save); \
  550. } while(0)
  551. #else /* DEBUGBUILD */
  552. #define CF_DATA_SAVE(save, cf, data) \
  553. do { \
  554. (save) = CF_CTX_CALL_DATA(cf); \
  555. CF_CTX_CALL_DATA(cf).data = (struct Curl_easy *)data; \
  556. } while(0)
  557. #define CF_DATA_RESTORE(cf, save) \
  558. do { \
  559. CF_CTX_CALL_DATA(cf) = (save); \
  560. } while(0)
  561. #endif /* !DEBUGBUILD */
  562. #define CF_DATA_CURRENT(cf) \
  563. ((cf)? (CF_CTX_CALL_DATA(cf).data) : NULL)
  564. #endif /* HEADER_CURL_CFILTERS_H */