Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 2 | * include/proto/channel.h |
| 3 | * Channel management definitions, macros and inline functions. |
Willy Tarreau | 7c3c541 | 2009-12-13 15:53:05 +0100 | [diff] [blame] | 4 | * |
Willy Tarreau | a27dc19 | 2014-11-27 22:10:04 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 7c3c541 | 2009-12-13 15:53:05 +0100 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 21 | |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 22 | #ifndef _PROTO_CHANNEL_H |
| 23 | #define _PROTO_CHANNEL_H |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 24 | |
Willy Tarreau | 08d5ac8 | 2018-06-06 15:09:28 +0200 | [diff] [blame] | 25 | #include <stdint.h> |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 26 | #include <stdio.h> |
Willy Tarreau | 0f77253 | 2006-12-23 20:51:41 +0100 | [diff] [blame] | 27 | #include <stdlib.h> |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 28 | #include <string.h> |
Willy Tarreau | 0f77253 | 2006-12-23 20:51:41 +0100 | [diff] [blame] | 29 | |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 30 | #include <common/config.h> |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 31 | #include <common/chunk.h> |
Willy Tarreau | 0c303ee | 2008-07-07 00:09:58 +0200 | [diff] [blame] | 32 | #include <common/ticks.h> |
Willy Tarreau | fa64558 | 2007-06-03 15:59:52 +0200 | [diff] [blame] | 33 | #include <common/time.h> |
| 34 | |
Thierry FOURNIER | ac836ba | 2014-12-16 15:41:18 +0100 | [diff] [blame] | 35 | #include <types/channel.h> |
Willy Tarreau | 7c3c541 | 2009-12-13 15:53:05 +0100 | [diff] [blame] | 36 | #include <types/global.h> |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 37 | #include <types/stream.h> |
Willy Tarreau | 7379653 | 2014-11-28 14:10:28 +0100 | [diff] [blame] | 38 | #include <types/stream_interface.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 39 | |
Christopher Faulet | a73e59b | 2016-12-09 17:30:18 +0100 | [diff] [blame] | 40 | #include <proto/task.h> |
| 41 | |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 42 | /* perform minimal intializations, report 0 in case of error, 1 if OK. */ |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 43 | int init_channel(); |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 44 | |
Willy Tarreau | 55a6906 | 2012-10-26 00:21:52 +0200 | [diff] [blame] | 45 | unsigned long long __channel_forward(struct channel *chn, unsigned long long bytes); |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 46 | |
| 47 | /* SI-to-channel functions working with buffers */ |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 48 | int ci_putblk(struct channel *chn, const char *str, int len); |
| 49 | struct buffer *ci_swpbuf(struct channel *chn, struct buffer *buf); |
| 50 | int ci_putchr(struct channel *chn, char c); |
Willy Tarreau | 41ab868 | 2017-10-19 14:58:40 +0200 | [diff] [blame] | 51 | int ci_getline_nc(const struct channel *chn, char **blk1, int *len1, char **blk2, int *len2); |
| 52 | int ci_getblk_nc(const struct channel *chn, char **blk1, int *len1, char **blk2, int *len2); |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 53 | int co_inject(struct channel *chn, const char *msg, int len); |
Willy Tarreau | 41ab868 | 2017-10-19 14:58:40 +0200 | [diff] [blame] | 54 | int co_getline(const struct channel *chn, char *str, int len); |
| 55 | int co_getblk(const struct channel *chn, char *blk, int len, int offset); |
Willy Tarreau | 206ba83 | 2018-06-14 15:27:31 +0200 | [diff] [blame^] | 56 | int co_getline_nc(const struct channel *chn, const char **blk1, int *len1, const char **blk2, int *len2); |
| 57 | int co_getblk_nc(const struct channel *chn, const char **blk1, int *len1, const char **blk2, int *len2); |
Thierry FOURNIER | ca16b03 | 2015-02-16 19:26:48 +0100 | [diff] [blame] | 58 | |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 59 | |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 60 | /* returns a pointer to the stream the channel belongs to */ |
Thierry FOURNIER | 27929fb | 2015-09-25 08:36:11 +0200 | [diff] [blame] | 61 | static inline struct stream *chn_strm(const struct channel *chn) |
Willy Tarreau | d5ccfa3 | 2014-12-28 13:03:53 +0100 | [diff] [blame] | 62 | { |
| 63 | if (chn->flags & CF_ISRESP) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 64 | return LIST_ELEM(chn, struct stream *, res); |
Willy Tarreau | d5ccfa3 | 2014-12-28 13:03:53 +0100 | [diff] [blame] | 65 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 66 | return LIST_ELEM(chn, struct stream *, req); |
Willy Tarreau | d5ccfa3 | 2014-12-28 13:03:53 +0100 | [diff] [blame] | 67 | } |
| 68 | |
Willy Tarreau | 7379653 | 2014-11-28 14:10:28 +0100 | [diff] [blame] | 69 | /* returns a pointer to the stream interface feeding the channel (producer) */ |
| 70 | static inline struct stream_interface *chn_prod(const struct channel *chn) |
| 71 | { |
Willy Tarreau | 5decc05 | 2014-11-28 14:22:12 +0100 | [diff] [blame] | 72 | if (chn->flags & CF_ISRESP) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 73 | return &LIST_ELEM(chn, struct stream *, res)->si[1]; |
Willy Tarreau | 5decc05 | 2014-11-28 14:22:12 +0100 | [diff] [blame] | 74 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 75 | return &LIST_ELEM(chn, struct stream *, req)->si[0]; |
Willy Tarreau | 7379653 | 2014-11-28 14:10:28 +0100 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | /* returns a pointer to the stream interface consuming the channel (producer) */ |
| 79 | static inline struct stream_interface *chn_cons(const struct channel *chn) |
| 80 | { |
Willy Tarreau | 5decc05 | 2014-11-28 14:22:12 +0100 | [diff] [blame] | 81 | if (chn->flags & CF_ISRESP) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 82 | return &LIST_ELEM(chn, struct stream *, res)->si[0]; |
Willy Tarreau | 5decc05 | 2014-11-28 14:22:12 +0100 | [diff] [blame] | 83 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 84 | return &LIST_ELEM(chn, struct stream *, req)->si[1]; |
Willy Tarreau | 7379653 | 2014-11-28 14:10:28 +0100 | [diff] [blame] | 85 | } |
| 86 | |
Willy Tarreau | 08d5ac8 | 2018-06-06 15:09:28 +0200 | [diff] [blame] | 87 | /* c_orig() : returns the pointer to the channel buffer's origin */ |
| 88 | static inline char *c_orig(const struct channel *c) |
| 89 | { |
| 90 | return b_orig(c->buf); |
| 91 | } |
| 92 | |
| 93 | /* c_size() : returns the size of the channel's buffer */ |
| 94 | static inline size_t c_size(const struct channel *c) |
| 95 | { |
| 96 | return b_size(c->buf); |
| 97 | } |
| 98 | |
| 99 | /* c_wrap() : returns the pointer to the channel buffer's wrapping point */ |
| 100 | static inline char *c_wrap(const struct channel *c) |
| 101 | { |
| 102 | return b_wrap(c->buf); |
| 103 | } |
| 104 | |
| 105 | /* c_data() : returns the amount of data in the channel's buffer */ |
| 106 | static inline size_t c_data(const struct channel *c) |
| 107 | { |
| 108 | return b_data(c->buf); |
| 109 | } |
| 110 | |
| 111 | /* c_room() : returns the room left in the channel's buffer */ |
| 112 | static inline size_t c_room(const struct channel *c) |
| 113 | { |
| 114 | return b_size(c->buf) - b_data(c->buf); |
| 115 | } |
| 116 | |
| 117 | /* c_empty() : returns a boolean indicating if the channel's buffer is empty */ |
| 118 | static inline size_t c_empty(const struct channel *c) |
| 119 | { |
| 120 | return !c_data(c); |
| 121 | } |
| 122 | |
| 123 | /* c_full() : returns a boolean indicating if the channel's buffer is full */ |
| 124 | static inline size_t c_full(const struct channel *c) |
| 125 | { |
| 126 | return !c_room(c); |
| 127 | } |
| 128 | |
| 129 | /* co_data() : returns the amount of output data in the channel's buffer */ |
| 130 | static inline size_t co_data(const struct channel *c) |
| 131 | { |
| 132 | return c->buf->o; |
| 133 | } |
| 134 | |
| 135 | /* ci_data() : returns the amount of input data in the channel's buffer */ |
| 136 | static inline size_t ci_data(const struct channel *c) |
| 137 | { |
| 138 | return c->buf->i; |
| 139 | } |
| 140 | |
| 141 | /* ci_next() : for an absolute pointer <p> or a relative offset <o> pointing to |
| 142 | * a valid location within channel <c>'s buffer, returns either the absolute |
| 143 | * pointer or the relative offset pointing to the next byte, which usually is |
| 144 | * at (p + 1) unless p reaches the wrapping point and wrapping is needed. |
| 145 | */ |
| 146 | static inline size_t ci_next_ofs(const struct channel *c, size_t o) |
| 147 | { |
| 148 | return b_next_ofs(c->buf, o); |
| 149 | } |
| 150 | static inline char *ci_next(const struct channel *c, const char *p) |
| 151 | { |
| 152 | return b_next(c->buf, p); |
| 153 | } |
| 154 | |
| 155 | |
| 156 | /* c_ptr() : returns a pointer to an offset relative to the beginning of the |
| 157 | * input data in the buffer. If instead the offset is negative, a pointer to |
| 158 | * existing output data is returned. The function only takes care of wrapping, |
| 159 | * it's up to the caller to ensure the offset is always within byte count |
| 160 | * bounds. |
| 161 | */ |
| 162 | static inline char *c_ptr(const struct channel *c, ssize_t ofs) |
| 163 | { |
| 164 | return b_peek(c->buf, co_data(c) + ofs); |
| 165 | } |
| 166 | |
| 167 | /* c_adv() : advances the channel's buffer by <adv> bytes, which means that the |
| 168 | * buffer's pointer advances, and that as many bytes from in are transferred |
| 169 | * from in to out. The caller is responsible for ensuring that adv is always |
| 170 | * smaller than or equal to b->i. |
| 171 | */ |
| 172 | static inline void c_adv(struct channel *c, size_t adv) |
| 173 | { |
| 174 | struct buffer *b = c->buf; |
| 175 | |
| 176 | b->p = c_ptr(c, adv); |
| 177 | b->i -= adv; |
| 178 | b->o += adv; |
| 179 | } |
| 180 | |
| 181 | /* c_rew() : rewinds the channel's buffer by <adv> bytes, which means that the |
| 182 | * buffer's pointer goes backwards, and that as many bytes from out are moved |
| 183 | * to in. The caller is responsible for ensuring that adv is always smaller |
| 184 | * than or equal to b->o. |
| 185 | */ |
| 186 | static inline void c_rew(struct channel *c, size_t adv) |
| 187 | { |
| 188 | struct buffer *b = c->buf; |
| 189 | |
| 190 | b->p = c_ptr(c, (int)-adv); |
| 191 | b->i += adv; |
| 192 | b->o -= adv; |
| 193 | } |
| 194 | |
| 195 | /* c_realign_if_empty() : realign the channel's buffer if it's empty */ |
| 196 | static inline void c_realign_if_empty(struct channel *chn) |
| 197 | { |
| 198 | b_realign_if_empty(chn->buf); |
| 199 | } |
| 200 | |
| 201 | |
| 202 | /* co_head() : returns a pointer to the beginning of output data in the buffer. |
| 203 | * The "__" variants don't support wrapping, "ofs" are relative to |
| 204 | * the buffer's origin. |
| 205 | */ |
| 206 | static inline size_t __co_head_ofs(const struct channel *c) |
| 207 | { |
| 208 | return __b_peek_ofs(c->buf, 0); |
| 209 | } |
| 210 | static inline char *__co_head(const struct channel *c) |
| 211 | { |
| 212 | return __b_peek(c->buf, 0); |
| 213 | } |
| 214 | static inline size_t co_head_ofs(const struct channel *c) |
| 215 | { |
| 216 | return b_peek_ofs(c->buf, 0); |
| 217 | } |
| 218 | static inline char *co_head(const struct channel *c) |
| 219 | { |
| 220 | return b_peek(c->buf, 0); |
| 221 | } |
| 222 | |
| 223 | |
| 224 | /* co_tail() : returns a pointer to the end of output data in the buffer. |
| 225 | * The "__" variants don't support wrapping, "ofs" are relative to |
| 226 | * the buffer's origin. |
| 227 | */ |
| 228 | static inline size_t __co_tail_ofs(const struct channel *c) |
| 229 | { |
| 230 | return __b_peek_ofs(c->buf, co_data(c)); |
| 231 | } |
| 232 | static inline char *__co_tail(const struct channel *c) |
| 233 | { |
| 234 | return __b_peek(c->buf, co_data(c)); |
| 235 | } |
| 236 | static inline size_t co_tail_ofs(const struct channel *c) |
| 237 | { |
| 238 | return b_peek_ofs(c->buf, co_data(c)); |
| 239 | } |
| 240 | static inline char *co_tail(const struct channel *c) |
| 241 | { |
| 242 | return b_peek(c->buf, co_data(c)); |
| 243 | } |
| 244 | |
| 245 | |
| 246 | /* ci_head() : returns a pointer to the beginning of input data in the buffer. |
| 247 | * The "__" variants don't support wrapping, "ofs" are relative to |
| 248 | * the buffer's origin. |
| 249 | */ |
| 250 | static inline size_t __ci_head_ofs(const struct channel *c) |
| 251 | { |
| 252 | return __b_peek_ofs(c->buf, co_data(c)); |
| 253 | } |
| 254 | static inline char *__ci_head(const struct channel *c) |
| 255 | { |
| 256 | return __b_peek(c->buf, co_data(c)); |
| 257 | } |
| 258 | static inline size_t ci_head_ofs(const struct channel *c) |
| 259 | { |
| 260 | return b_peek_ofs(c->buf, co_data(c)); |
| 261 | } |
| 262 | static inline char *ci_head(const struct channel *c) |
| 263 | { |
| 264 | return b_peek(c->buf, co_data(c)); |
| 265 | } |
| 266 | |
| 267 | |
| 268 | /* ci_tail() : returns a pointer to the end of input data in the buffer. |
| 269 | * The "__" variants don't support wrapping, "ofs" are relative to |
| 270 | * the buffer's origin. |
| 271 | */ |
| 272 | static inline size_t __ci_tail_ofs(const struct channel *c) |
| 273 | { |
| 274 | return __b_peek_ofs(c->buf, c_data(c)); |
| 275 | } |
| 276 | static inline char *__ci_tail(const struct channel *c) |
| 277 | { |
| 278 | return __b_peek(c->buf, c_data(c)); |
| 279 | } |
| 280 | static inline size_t ci_tail_ofs(const struct channel *c) |
| 281 | { |
| 282 | return b_peek_ofs(c->buf, c_data(c)); |
| 283 | } |
| 284 | static inline char *ci_tail(const struct channel *c) |
| 285 | { |
| 286 | return b_peek(c->buf, c_data(c)); |
| 287 | } |
| 288 | |
| 289 | |
| 290 | /* ci_stop() : returns the pointer to the byte following the end of input data |
| 291 | * in the channel buffer. It may be out of the buffer. It's used to |
| 292 | * compute lengths or stop pointers. |
| 293 | */ |
| 294 | static inline size_t __ci_stop_ofs(const struct channel *c) |
| 295 | { |
| 296 | return __b_stop_ofs(c->buf); |
| 297 | } |
| 298 | static inline const char *__ci_stop(const struct channel *c) |
| 299 | { |
| 300 | return __b_stop(c->buf); |
| 301 | } |
| 302 | static inline size_t ci_stop_ofs(const struct channel *c) |
| 303 | { |
| 304 | return b_stop_ofs(c->buf); |
| 305 | } |
| 306 | static inline const char *ci_stop(const struct channel *c) |
| 307 | { |
| 308 | return b_stop(c->buf); |
| 309 | } |
| 310 | |
| 311 | |
Willy Tarreau | 7194d3c | 2018-06-06 16:55:45 +0200 | [diff] [blame] | 312 | /* Returns the amount of input data that can contiguously be read at once */ |
| 313 | static inline size_t ci_contig_data(const struct channel *c) |
| 314 | { |
| 315 | return b_contig_data(c->buf, co_data(c)); |
| 316 | } |
| 317 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 318 | /* Initialize all fields in the channel. */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 319 | static inline void channel_init(struct channel *chn) |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 320 | { |
Willy Tarreau | 2a4b543 | 2014-11-24 11:39:34 +0100 | [diff] [blame] | 321 | chn->buf = &buf_empty; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 322 | chn->to_forward = 0; |
Willy Tarreau | b145c78 | 2014-02-09 17:45:16 +0100 | [diff] [blame] | 323 | chn->last_read = now_ms; |
Willy Tarreau | 8f39dcd | 2014-02-09 08:31:49 +0100 | [diff] [blame] | 324 | chn->xfer_small = chn->xfer_large = 0; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 325 | chn->total = 0; |
| 326 | chn->pipe = NULL; |
| 327 | chn->analysers = 0; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 328 | chn->flags = 0; |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 329 | } |
| 330 | |
Willy Tarreau | 55a6906 | 2012-10-26 00:21:52 +0200 | [diff] [blame] | 331 | /* Schedule up to <bytes> more bytes to be forwarded via the channel without |
| 332 | * notifying the owner task. Any data pending in the buffer are scheduled to be |
| 333 | * sent as well, in the limit of the number of bytes to forward. This must be |
| 334 | * the only method to use to schedule bytes to be forwarded. If the requested |
| 335 | * number is too large, it is automatically adjusted. The number of bytes taken |
| 336 | * into account is returned. Directly touching ->to_forward will cause lockups |
| 337 | * when buf->o goes down to zero if nobody is ready to push the remaining data. |
| 338 | */ |
| 339 | static inline unsigned long long channel_forward(struct channel *chn, unsigned long long bytes) |
| 340 | { |
| 341 | /* hint: avoid comparisons on long long for the fast case, since if the |
| 342 | * length does not fit in an unsigned it, it will never be forwarded at |
| 343 | * once anyway. |
| 344 | */ |
| 345 | if (bytes <= ~0U) { |
| 346 | unsigned int bytes32 = bytes; |
| 347 | |
| 348 | if (bytes32 <= chn->buf->i) { |
| 349 | /* OK this amount of bytes might be forwarded at once */ |
Willy Tarreau | bcbd393 | 2018-06-06 07:13:22 +0200 | [diff] [blame] | 350 | c_adv(chn, bytes32); |
Willy Tarreau | 55a6906 | 2012-10-26 00:21:52 +0200 | [diff] [blame] | 351 | return bytes; |
| 352 | } |
| 353 | } |
| 354 | return __channel_forward(chn, bytes); |
| 355 | } |
| 356 | |
Willy Tarreau | 8bf242b | 2016-05-04 14:05:58 +0200 | [diff] [blame] | 357 | /* Forwards any input data and marks the channel for permanent forwarding */ |
| 358 | static inline void channel_forward_forever(struct channel *chn) |
| 359 | { |
Willy Tarreau | bcbd393 | 2018-06-06 07:13:22 +0200 | [diff] [blame] | 360 | c_adv(chn, chn->buf->i); |
Willy Tarreau | 8bf242b | 2016-05-04 14:05:58 +0200 | [diff] [blame] | 361 | chn->to_forward = CHN_INFINITE_FORWARD; |
| 362 | } |
| 363 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 364 | /*********************************************************************/ |
| 365 | /* These functions are used to compute various channel content sizes */ |
| 366 | /*********************************************************************/ |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 367 | |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 368 | /* Reports non-zero if the channel is empty, which means both its |
| 369 | * buffer and pipe are empty. The construct looks strange but is |
| 370 | * jump-less and much more efficient on both 32 and 64-bit than |
| 371 | * the boolean test. |
| 372 | */ |
Willy Tarreau | 41ab868 | 2017-10-19 14:58:40 +0200 | [diff] [blame] | 373 | static inline unsigned int channel_is_empty(const struct channel *c) |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 374 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 375 | return !(c->buf->o | (long)c->pipe); |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 376 | } |
| 377 | |
Willy Tarreau | ba0902e | 2015-01-13 14:39:16 +0100 | [diff] [blame] | 378 | /* Returns non-zero if the channel is rewritable, which means that the buffer |
| 379 | * it is attached to has at least <maxrewrite> bytes immediately available. |
| 380 | * This is used to decide when a request or response may be parsed when some |
| 381 | * data from a previous exchange might still be present. |
Willy Tarreau | 379357a | 2013-06-08 12:55:46 +0200 | [diff] [blame] | 382 | */ |
Willy Tarreau | ba0902e | 2015-01-13 14:39:16 +0100 | [diff] [blame] | 383 | static inline int channel_is_rewritable(const struct channel *chn) |
Willy Tarreau | 379357a | 2013-06-08 12:55:46 +0200 | [diff] [blame] | 384 | { |
| 385 | int rem = chn->buf->size; |
| 386 | |
| 387 | rem -= chn->buf->o; |
| 388 | rem -= chn->buf->i; |
| 389 | rem -= global.tune.maxrewrite; |
| 390 | return rem >= 0; |
| 391 | } |
| 392 | |
Willy Tarreau | 9c06ee4 | 2015-01-14 16:08:45 +0100 | [diff] [blame] | 393 | /* Tells whether data are likely to leave the buffer. This is used to know when |
| 394 | * we can safely ignore the reserve since we know we cannot retry a connection. |
| 395 | * It returns zero if data are blocked, non-zero otherwise. |
| 396 | */ |
| 397 | static inline int channel_may_send(const struct channel *chn) |
| 398 | { |
Willy Tarreau | 7379653 | 2014-11-28 14:10:28 +0100 | [diff] [blame] | 399 | return chn_cons(chn)->state == SI_ST_EST; |
Willy Tarreau | 9c06ee4 | 2015-01-14 16:08:45 +0100 | [diff] [blame] | 400 | } |
| 401 | |
Willy Tarreau | 3889fff | 2015-01-13 20:20:10 +0100 | [diff] [blame] | 402 | /* Returns non-zero if the channel can still receive data. This is used to |
Willy Tarreau | 379357a | 2013-06-08 12:55:46 +0200 | [diff] [blame] | 403 | * decide when to stop reading into a buffer when we want to ensure that we |
| 404 | * leave the reserve untouched after all pending outgoing data are forwarded. |
| 405 | * The reserved space is taken into account if ->to_forward indicates that an |
| 406 | * end of transfer is close to happen. Note that both ->buf->o and ->to_forward |
| 407 | * are considered as available since they're supposed to leave the buffer. The |
| 408 | * test is optimized to avoid as many operations as possible for the fast case |
Willy Tarreau | 4b46a3e | 2016-04-20 20:09:22 +0200 | [diff] [blame] | 409 | * and to be used as an "if" condition. Just like channel_recv_limit(), we |
| 410 | * never allow to overwrite the reserve until the output stream interface is |
| 411 | * connected, otherwise we could spin on a POST with http-send-name-header. |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 412 | */ |
Willy Tarreau | 3889fff | 2015-01-13 20:20:10 +0100 | [diff] [blame] | 413 | static inline int channel_may_recv(const struct channel *chn) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 414 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 415 | int rem = chn->buf->size; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 416 | |
Willy Tarreau | 4428a29 | 2014-11-28 20:54:13 +0100 | [diff] [blame] | 417 | if (chn->buf == &buf_empty) |
Willy Tarreau | 3889fff | 2015-01-13 20:20:10 +0100 | [diff] [blame] | 418 | return 1; |
Willy Tarreau | 4428a29 | 2014-11-28 20:54:13 +0100 | [diff] [blame] | 419 | |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 420 | rem -= chn->buf->o; |
| 421 | rem -= chn->buf->i; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 422 | if (!rem) |
Willy Tarreau | 3889fff | 2015-01-13 20:20:10 +0100 | [diff] [blame] | 423 | return 0; /* buffer already full */ |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 424 | |
Willy Tarreau | 93dc478 | 2016-04-21 12:12:45 +0200 | [diff] [blame] | 425 | if (rem > global.tune.maxrewrite) |
| 426 | return 1; /* reserve not yet reached */ |
Willy Tarreau | 4b46a3e | 2016-04-20 20:09:22 +0200 | [diff] [blame] | 427 | |
Willy Tarreau | 93dc478 | 2016-04-21 12:12:45 +0200 | [diff] [blame] | 428 | if (!channel_may_send(chn)) |
| 429 | return 0; /* don't touch reserve until we can send */ |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 430 | |
Willy Tarreau | 93dc478 | 2016-04-21 12:12:45 +0200 | [diff] [blame] | 431 | /* Now we know there's some room left in the reserve and we may |
| 432 | * forward. As long as i-to_fwd < size-maxrw, we may still |
| 433 | * receive. This is equivalent to i+maxrw-size < to_fwd, |
| 434 | * which is logical since i+maxrw-size is what overlaps with |
| 435 | * the reserve, and we want to ensure they're covered by scheduled |
| 436 | * forwards. |
| 437 | */ |
| 438 | rem = chn->buf->i + global.tune.maxrewrite - chn->buf->size; |
| 439 | return rem < 0 || (unsigned int)rem < chn->to_forward; |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 440 | } |
| 441 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 442 | /* Returns true if the channel's input is already closed */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 443 | static inline int channel_input_closed(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 444 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 445 | return ((chn->flags & CF_SHUTR) != 0); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 446 | } |
| 447 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 448 | /* Returns true if the channel's output is already closed */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 449 | static inline int channel_output_closed(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 450 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 451 | return ((chn->flags & CF_SHUTW) != 0); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 452 | } |
| 453 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 454 | /* Check channel timeouts, and set the corresponding flags. The likely/unlikely |
| 455 | * have been optimized for fastest normal path. The read/write timeouts are not |
| 456 | * set if there was activity on the channel. That way, we don't have to update |
| 457 | * the timeout on every I/O. Note that the analyser timeout is always checked. |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 458 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 459 | static inline void channel_check_timeouts(struct channel *chn) |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 460 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 461 | if (likely(!(chn->flags & (CF_SHUTR|CF_READ_TIMEOUT|CF_READ_ACTIVITY|CF_READ_NOEXP))) && |
| 462 | unlikely(tick_is_expired(chn->rex, now_ms))) |
| 463 | chn->flags |= CF_READ_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 464 | |
Christopher Faulet | c5a9d5b | 2017-11-09 09:36:43 +0100 | [diff] [blame] | 465 | if (likely(!(chn->flags & (CF_SHUTW|CF_WRITE_TIMEOUT|CF_WRITE_ACTIVITY|CF_WRITE_EVENT))) && |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 466 | unlikely(tick_is_expired(chn->wex, now_ms))) |
| 467 | chn->flags |= CF_WRITE_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 468 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 469 | if (likely(!(chn->flags & CF_ANA_TIMEOUT)) && |
| 470 | unlikely(tick_is_expired(chn->analyse_exp, now_ms))) |
| 471 | chn->flags |= CF_ANA_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 472 | } |
| 473 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 474 | /* Erase any content from channel <buf> and adjusts flags accordingly. Note |
Willy Tarreau | 0abebcc | 2009-01-08 00:09:41 +0100 | [diff] [blame] | 475 | * that any spliced data is not affected since we may not have any access to |
| 476 | * it. |
Willy Tarreau | e393fe2 | 2008-08-16 22:18:07 +0200 | [diff] [blame] | 477 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 478 | static inline void channel_erase(struct channel *chn) |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 479 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 480 | chn->to_forward = 0; |
Willy Tarreau | 474cf54 | 2014-11-24 10:54:47 +0100 | [diff] [blame] | 481 | b_reset(chn->buf); |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 482 | } |
| 483 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 484 | /* marks the channel as "shutdown" ASAP for reads */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 485 | static inline void channel_shutr_now(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 486 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 487 | chn->flags |= CF_SHUTR_NOW; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 488 | } |
| 489 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 490 | /* marks the channel as "shutdown" ASAP for writes */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 491 | static inline void channel_shutw_now(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 492 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 493 | chn->flags |= CF_SHUTW_NOW; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 494 | } |
| 495 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 496 | /* marks the channel as "shutdown" ASAP in both directions */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 497 | static inline void channel_abort(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 498 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 499 | chn->flags |= CF_SHUTR_NOW | CF_SHUTW_NOW; |
| 500 | chn->flags &= ~CF_AUTO_CONNECT; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 501 | } |
| 502 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 503 | /* allow the consumer to try to establish a new connection. */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 504 | static inline void channel_auto_connect(struct channel *chn) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 505 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 506 | chn->flags |= CF_AUTO_CONNECT; |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 507 | } |
| 508 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 509 | /* prevent the consumer from trying to establish a new connection, and also |
| 510 | * disable auto shutdown forwarding. |
| 511 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 512 | static inline void channel_dont_connect(struct channel *chn) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 513 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 514 | chn->flags &= ~(CF_AUTO_CONNECT|CF_AUTO_CLOSE); |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 515 | } |
| 516 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 517 | /* allow the producer to forward shutdown requests */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 518 | static inline void channel_auto_close(struct channel *chn) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 519 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 520 | chn->flags |= CF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 521 | } |
| 522 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 523 | /* prevent the producer from forwarding shutdown requests */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 524 | static inline void channel_dont_close(struct channel *chn) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 525 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 526 | chn->flags &= ~CF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 527 | } |
| 528 | |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 529 | /* allow the producer to read / poll the input */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 530 | static inline void channel_auto_read(struct channel *chn) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 531 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 532 | chn->flags &= ~CF_DONT_READ; |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 533 | } |
| 534 | |
| 535 | /* prevent the producer from read / poll the input */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 536 | static inline void channel_dont_read(struct channel *chn) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 537 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 538 | chn->flags |= CF_DONT_READ; |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 539 | } |
| 540 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 541 | |
| 542 | /*************************************************/ |
| 543 | /* Buffer operations in the context of a channel */ |
| 544 | /*************************************************/ |
| 545 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 546 | |
| 547 | /* Return the max number of bytes the buffer can contain so that once all the |
Willy Tarreau | 169c470 | 2016-04-20 18:05:17 +0200 | [diff] [blame] | 548 | * pending bytes are forwarded, the buffer still has global.tune.maxrewrite |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 549 | * bytes free. The result sits between chn->size - maxrewrite and chn->size. |
Willy Tarreau | 169c470 | 2016-04-20 18:05:17 +0200 | [diff] [blame] | 550 | * It is important to mention that if buf->i is already larger than size-maxrw |
| 551 | * the condition above cannot be satisfied and the lowest size will be returned |
| 552 | * anyway. The principles are the following : |
| 553 | * 0) the empty buffer has a limit of zero |
| 554 | * 1) a non-connected buffer cannot touch the reserve |
| 555 | * 2) infinite forward can always fill the buffer since all data will leave |
| 556 | * 3) all output bytes are considered in transit since they're leaving |
| 557 | * 4) all input bytes covered by to_forward are considered in transit since |
| 558 | * they'll be converted to output bytes. |
| 559 | * 5) all input bytes not covered by to_forward as considered remaining |
| 560 | * 6) all bytes scheduled to be forwarded minus what is already in the input |
| 561 | * buffer will be in transit during future rounds. |
| 562 | * 7) 4+5+6 imply that the amount of input bytes (i) is irrelevant to the max |
| 563 | * usable length, only to_forward and output count. The difference is |
| 564 | * visible when to_forward > i. |
| 565 | * 8) the reserve may be covered up to the amount of bytes in transit since |
| 566 | * these bytes will only take temporary space. |
Willy Tarreau | 999f643 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 567 | * |
Willy Tarreau | 169c470 | 2016-04-20 18:05:17 +0200 | [diff] [blame] | 568 | * A typical buffer looks like this : |
Willy Tarreau | 999f643 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 569 | * |
Willy Tarreau | 169c470 | 2016-04-20 18:05:17 +0200 | [diff] [blame] | 570 | * <-------------- max_len -----------> |
| 571 | * <---- o ----><----- i -----> <--- 0..maxrewrite ---> |
| 572 | * +------------+--------------+-------+----------------------+ |
| 573 | * |////////////|\\\\\\\\\\\\\\|xxxxxxx| reserve | |
| 574 | * +------------+--------+-----+-------+----------------------+ |
| 575 | * <- fwd -> <-avail-> |
| 576 | * |
| 577 | * Or when to_forward > i : |
| 578 | * |
| 579 | * <-------------- max_len -----------> |
| 580 | * <---- o ----><----- i -----> <--- 0..maxrewrite ---> |
| 581 | * +------------+--------------+-------+----------------------+ |
| 582 | * |////////////|\\\\\\\\\\\\\\|xxxxxxx| reserve | |
| 583 | * +------------+--------+-----+-------+----------------------+ |
| 584 | * <-avail-> |
| 585 | * <------------------ fwd ----------------> |
| 586 | * |
| 587 | * - the amount of buffer bytes in transit is : min(i, fwd) + o |
| 588 | * - some scheduled bytes may be in transit (up to fwd - i) |
| 589 | * - the reserve is max(0, maxrewrite - transit) |
| 590 | * - the maximum usable buffer length is size - reserve. |
| 591 | * - the available space is max_len - i - o |
| 592 | * |
| 593 | * So the formula to compute the buffer's maximum length to protect the reserve |
| 594 | * when reading new data is : |
| 595 | * |
| 596 | * max = size - maxrewrite + min(maxrewrite, transit) |
| 597 | * = size - max(maxrewrite - transit, 0) |
| 598 | * |
| 599 | * But WARNING! The conditions might change during the transfer and it could |
| 600 | * very well happen that a buffer would contain more bytes than max_len due to |
| 601 | * i+o already walking over the reserve (eg: after a header rewrite), including |
| 602 | * i or o alone hitting the limit. So it is critical to always consider that |
| 603 | * bounds may have already been crossed and that available space may be negative |
| 604 | * for example. Due to this it is perfectly possible for this function to return |
| 605 | * a value that is lower than current i+o. |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 606 | */ |
Willy Tarreau | 3f5096d | 2015-01-14 20:21:43 +0100 | [diff] [blame] | 607 | static inline int channel_recv_limit(const struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 608 | { |
Willy Tarreau | ef907fe | 2016-05-03 17:46:24 +0200 | [diff] [blame] | 609 | unsigned int transit; |
Willy Tarreau | 999f643 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 610 | int reserve; |
| 611 | |
| 612 | /* return zero if empty */ |
| 613 | reserve = chn->buf->size; |
| 614 | if (chn->buf == &buf_empty) |
| 615 | goto end; |
| 616 | |
| 617 | /* return size - maxrewrite if we can't send */ |
| 618 | reserve = global.tune.maxrewrite; |
| 619 | if (unlikely(!channel_may_send(chn))) |
| 620 | goto end; |
| 621 | |
Willy Tarreau | ef907fe | 2016-05-03 17:46:24 +0200 | [diff] [blame] | 622 | /* We need to check what remains of the reserve after o and to_forward |
| 623 | * have been transmitted, but they can overflow together and they can |
| 624 | * cause an integer underflow in the comparison since both are unsigned |
| 625 | * while maxrewrite is signed. |
| 626 | * The code below has been verified for being a valid check for this : |
| 627 | * - if (o + to_forward) overflow => return size [ large enough ] |
| 628 | * - if o + to_forward >= maxrw => return size [ large enough ] |
| 629 | * - otherwise return size - (maxrw - (o + to_forward)) |
Willy Tarreau | 999f643 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 630 | */ |
Willy Tarreau | ef907fe | 2016-05-03 17:46:24 +0200 | [diff] [blame] | 631 | transit = chn->buf->o + chn->to_forward; |
| 632 | reserve -= transit; |
| 633 | if (transit < chn->to_forward || // addition overflow |
| 634 | transit >= (unsigned)global.tune.maxrewrite) // enough transit data |
Willy Tarreau | 169c470 | 2016-04-20 18:05:17 +0200 | [diff] [blame] | 635 | return chn->buf->size; |
Willy Tarreau | 999f643 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 636 | end: |
| 637 | return chn->buf->size - reserve; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 638 | } |
| 639 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 640 | /* Returns the amount of space available at the input of the buffer, taking the |
| 641 | * reserved space into account if ->to_forward indicates that an end of transfer |
| 642 | * is close to happen. The test is optimized to avoid as many operations as |
| 643 | * possible for the fast case. |
| 644 | */ |
Willy Tarreau | b5051f8 | 2015-01-14 20:25:34 +0100 | [diff] [blame] | 645 | static inline int channel_recv_max(const struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 646 | { |
Willy Tarreau | 27bb0e1 | 2015-01-14 15:56:50 +0100 | [diff] [blame] | 647 | int ret; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 648 | |
Willy Tarreau | 3f5096d | 2015-01-14 20:21:43 +0100 | [diff] [blame] | 649 | ret = channel_recv_limit(chn) - chn->buf->i - chn->buf->o; |
Willy Tarreau | 27bb0e1 | 2015-01-14 15:56:50 +0100 | [diff] [blame] | 650 | if (ret < 0) |
| 651 | ret = 0; |
| 652 | return ret; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 653 | } |
| 654 | |
Christopher Faulet | a73e59b | 2016-12-09 17:30:18 +0100 | [diff] [blame] | 655 | /* Allocates a buffer for channel <chn>, but only if it's guaranteed that it's |
| 656 | * not the last available buffer or it's the response buffer. Unless the buffer |
| 657 | * is the response buffer, an extra control is made so that we always keep |
| 658 | * <tune.buffers.reserved> buffers available after this allocation. Returns 0 in |
| 659 | * case of failure, non-zero otherwise. |
| 660 | * |
| 661 | * If no buffer are available, the requester, represented by <wait> pointer, |
| 662 | * will be added in the list of objects waiting for an available buffer. |
| 663 | */ |
| 664 | static inline int channel_alloc_buffer(struct channel *chn, struct buffer_wait *wait) |
| 665 | { |
| 666 | int margin = 0; |
| 667 | |
| 668 | if (!(chn->flags & CF_ISRESP)) |
| 669 | margin = global.tune.reserved_bufs; |
| 670 | |
| 671 | if (b_alloc_margin(&chn->buf, margin) != NULL) |
| 672 | return 1; |
| 673 | |
Emeric Brun | a1dd243 | 2017-06-21 15:42:52 +0200 | [diff] [blame] | 674 | if (LIST_ISEMPTY(&wait->list)) { |
Christopher Faulet | 2a944ee | 2017-11-07 10:42:54 +0100 | [diff] [blame] | 675 | HA_SPIN_LOCK(BUF_WQ_LOCK, &buffer_wq_lock); |
Christopher Faulet | a73e59b | 2016-12-09 17:30:18 +0100 | [diff] [blame] | 676 | LIST_ADDQ(&buffer_wq, &wait->list); |
Christopher Faulet | 2a944ee | 2017-11-07 10:42:54 +0100 | [diff] [blame] | 677 | HA_SPIN_UNLOCK(BUF_WQ_LOCK, &buffer_wq_lock); |
Emeric Brun | a1dd243 | 2017-06-21 15:42:52 +0200 | [diff] [blame] | 678 | } |
| 679 | |
Christopher Faulet | a73e59b | 2016-12-09 17:30:18 +0100 | [diff] [blame] | 680 | return 0; |
| 681 | } |
| 682 | |
| 683 | /* Releases a possibly allocated buffer for channel <chn>. If it was not |
| 684 | * allocated, this function does nothing. Else the buffer is released and we try |
| 685 | * to wake up as many streams/applets as possible. */ |
| 686 | static inline void channel_release_buffer(struct channel *chn, struct buffer_wait *wait) |
| 687 | { |
| 688 | if (chn->buf->size && buffer_empty(chn->buf)) { |
| 689 | b_free(&chn->buf); |
Olivier Houchard | 673867c | 2018-05-25 16:58:52 +0200 | [diff] [blame] | 690 | offer_buffers(wait->target, tasks_run_queue); |
Christopher Faulet | a73e59b | 2016-12-09 17:30:18 +0100 | [diff] [blame] | 691 | } |
| 692 | } |
| 693 | |
Willy Tarreau | 319f745 | 2015-01-14 20:32:59 +0100 | [diff] [blame] | 694 | /* Truncate any unread data in the channel's buffer, and disable forwarding. |
| 695 | * Outgoing data are left intact. This is mainly to be used to send error |
| 696 | * messages after existing data. |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 697 | */ |
Willy Tarreau | 319f745 | 2015-01-14 20:32:59 +0100 | [diff] [blame] | 698 | static inline void channel_truncate(struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 699 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 700 | if (!chn->buf->o) |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 701 | return channel_erase(chn); |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 702 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 703 | chn->to_forward = 0; |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 704 | if (!chn->buf->i) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 705 | return; |
| 706 | |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 707 | chn->buf->i = 0; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 708 | } |
| 709 | |
Willy Tarreau | 4cf1300 | 2018-06-06 06:53:15 +0200 | [diff] [blame] | 710 | /* This function realigns a possibly wrapping channel buffer so that the input |
| 711 | * part is contiguous and starts at the beginning of the buffer and the output |
| 712 | * part ends at the end of the buffer. This provides the best conditions since |
| 713 | * it allows the largest inputs to be processed at once and ensures that once |
| 714 | * the output data leaves, the whole buffer is available at once. |
| 715 | */ |
Willy Tarreau | fd8d42f | 2018-07-12 10:57:15 +0200 | [diff] [blame] | 716 | static inline void channel_slow_realign(struct channel *chn, char *swap) |
Willy Tarreau | 4cf1300 | 2018-06-06 06:53:15 +0200 | [diff] [blame] | 717 | { |
Willy Tarreau | fd8d42f | 2018-07-12 10:57:15 +0200 | [diff] [blame] | 718 | return b_slow_realign(chn->buf, swap, co_data(chn)); |
Willy Tarreau | 4cf1300 | 2018-06-06 06:53:15 +0200 | [diff] [blame] | 719 | } |
| 720 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 721 | /* |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 722 | * Advance the channel buffer's read pointer by <len> bytes. This is useful |
| 723 | * when data have been read directly from the buffer. It is illegal to call |
| 724 | * this function with <len> causing a wrapping at the end of the buffer. It's |
| 725 | * the caller's responsibility to ensure that <len> is never larger than |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 726 | * chn->o. Channel flag WRITE_PARTIAL is set. |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 727 | */ |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 728 | static inline void co_skip(struct channel *chn, int len) |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 729 | { |
Willy Tarreau | e5f12ce | 2018-06-15 10:28:05 +0200 | [diff] [blame] | 730 | b_del(chn->buf, len); |
Willy Tarreau | 5fb3803 | 2012-12-16 19:39:09 +0100 | [diff] [blame] | 731 | if (buffer_empty(chn->buf)) |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 732 | chn->buf->p = chn->buf->data; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 733 | |
Willy Tarreau | fb0e920 | 2009-09-23 23:47:55 +0200 | [diff] [blame] | 734 | /* notify that some data was written to the SI from the buffer */ |
Christopher Faulet | c5a9d5b | 2017-11-09 09:36:43 +0100 | [diff] [blame] | 735 | chn->flags |= CF_WRITE_PARTIAL | CF_WRITE_EVENT; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 736 | } |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 737 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 738 | /* Tries to copy chunk <chunk> into the channel's buffer after length controls. |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 739 | * The chn->o and to_forward pointers are updated. If the channel's input is |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 740 | * closed, -2 is returned. If the block is too large for this buffer, -3 is |
| 741 | * returned. If there is not enough room left in the buffer, -1 is returned. |
| 742 | * Otherwise the number of bytes copied is returned (0 being a valid number). |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 743 | * Channel flag READ_PARTIAL is updated if some data can be transferred. The |
Willy Tarreau | f941cf2 | 2012-08-27 20:53:34 +0200 | [diff] [blame] | 744 | * chunk's length is updated with the number of bytes sent. |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 745 | */ |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 746 | static inline int ci_putchk(struct channel *chn, struct chunk *chunk) |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 747 | { |
| 748 | int ret; |
| 749 | |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 750 | ret = ci_putblk(chn, chunk->str, chunk->len); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 751 | if (ret > 0) |
| 752 | chunk->len -= ret; |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 753 | return ret; |
| 754 | } |
| 755 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 756 | /* Tries to copy string <str> at once into the channel's buffer after length |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 757 | * controls. The chn->o and to_forward pointers are updated. If the channel's |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 758 | * input is closed, -2 is returned. If the block is too large for this buffer, |
| 759 | * -3 is returned. If there is not enough room left in the buffer, -1 is |
| 760 | * returned. Otherwise the number of bytes copied is returned (0 being a valid |
| 761 | * number). Channel flag READ_PARTIAL is updated if some data can be |
| 762 | * transferred. |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 763 | */ |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 764 | static inline int ci_putstr(struct channel *chn, const char *str) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 765 | { |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 766 | return ci_putblk(chn, str, strlen(str)); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 767 | } |
| 768 | |
| 769 | /* |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 770 | * Return one char from the channel's buffer. If the buffer is empty and the |
| 771 | * channel is closed, return -2. If the buffer is just empty, return -1. The |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 772 | * buffer's pointer is not advanced, it's up to the caller to call co_skip(buf, |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 773 | * 1) when it has consumed the char. Also note that this function respects the |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 774 | * chn->o limit. |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 775 | */ |
Willy Tarreau | 06d80a9 | 2017-10-19 14:32:15 +0200 | [diff] [blame] | 776 | static inline int co_getchr(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 777 | { |
| 778 | /* closed or empty + imminent close = -2; empty = -1 */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 779 | if (unlikely((chn->flags & CF_SHUTW) || channel_is_empty(chn))) { |
| 780 | if (chn->flags & (CF_SHUTW|CF_SHUTW_NOW)) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 781 | return -2; |
| 782 | return -1; |
| 783 | } |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 784 | return *buffer_wrap_sub(chn->buf, chn->buf->p - chn->buf->o); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 785 | } |
| 786 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 787 | |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 788 | #endif /* _PROTO_CHANNEL_H */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 789 | |
| 790 | /* |
| 791 | * Local variables: |
| 792 | * c-indent-level: 8 |
| 793 | * c-basic-offset: 8 |
| 794 | * End: |
| 795 | */ |