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 | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 5 | * Copyright (C) 2000-2012 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 | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 25 | #include <stdio.h> |
Willy Tarreau | 0f77253 | 2006-12-23 20:51:41 +0100 | [diff] [blame] | 26 | #include <stdlib.h> |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 27 | #include <string.h> |
Willy Tarreau | 0f77253 | 2006-12-23 20:51:41 +0100 | [diff] [blame] | 28 | |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 29 | #include <common/config.h> |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 30 | #include <common/chunk.h> |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 31 | #include <common/memory.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 | |
Willy Tarreau | 7c3c541 | 2009-12-13 15:53:05 +0100 | [diff] [blame] | 35 | #include <types/global.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 36 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 37 | extern struct pool_head *pool2_channel; |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 38 | |
| 39 | /* perform minimal intializations, report 0 in case of error, 1 if OK. */ |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 40 | int init_channel(); |
Willy Tarreau | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 41 | |
Willy Tarreau | 55a6906 | 2012-10-26 00:21:52 +0200 | [diff] [blame] | 42 | unsigned long long __channel_forward(struct channel *chn, unsigned long long bytes); |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 43 | |
| 44 | /* SI-to-channel functions working with buffers */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 45 | int bi_putblk(struct channel *chn, const char *str, int len); |
| 46 | int bi_putchr(struct channel *chn, char c); |
| 47 | int bo_inject(struct channel *chn, const char *msg, int len); |
| 48 | int bo_getline(struct channel *chn, char *str, int len); |
| 49 | int bo_getblk(struct channel *chn, char *blk, int len, int offset); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 50 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 51 | /* Initialize all fields in the channel. */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 52 | static inline void channel_init(struct channel *chn) |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 53 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 54 | chn->buf->o = 0; |
| 55 | chn->buf->i = 0; |
| 56 | chn->buf->p = chn->buf->data; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 57 | chn->to_forward = 0; |
Willy Tarreau | b145c78 | 2014-02-09 17:45:16 +0100 | [diff] [blame] | 58 | chn->last_read = now_ms; |
Willy Tarreau | 8f39dcd | 2014-02-09 08:31:49 +0100 | [diff] [blame] | 59 | chn->xfer_small = chn->xfer_large = 0; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 60 | chn->total = 0; |
| 61 | chn->pipe = NULL; |
| 62 | chn->analysers = 0; |
| 63 | chn->cons = NULL; |
| 64 | chn->flags = 0; |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 65 | } |
| 66 | |
Willy Tarreau | 55a6906 | 2012-10-26 00:21:52 +0200 | [diff] [blame] | 67 | /* Schedule up to <bytes> more bytes to be forwarded via the channel without |
| 68 | * notifying the owner task. Any data pending in the buffer are scheduled to be |
| 69 | * sent as well, in the limit of the number of bytes to forward. This must be |
| 70 | * the only method to use to schedule bytes to be forwarded. If the requested |
| 71 | * number is too large, it is automatically adjusted. The number of bytes taken |
| 72 | * into account is returned. Directly touching ->to_forward will cause lockups |
| 73 | * when buf->o goes down to zero if nobody is ready to push the remaining data. |
| 74 | */ |
| 75 | static inline unsigned long long channel_forward(struct channel *chn, unsigned long long bytes) |
| 76 | { |
| 77 | /* hint: avoid comparisons on long long for the fast case, since if the |
| 78 | * length does not fit in an unsigned it, it will never be forwarded at |
| 79 | * once anyway. |
| 80 | */ |
| 81 | if (bytes <= ~0U) { |
| 82 | unsigned int bytes32 = bytes; |
| 83 | |
| 84 | if (bytes32 <= chn->buf->i) { |
| 85 | /* OK this amount of bytes might be forwarded at once */ |
| 86 | b_adv(chn->buf, bytes32); |
| 87 | return bytes; |
| 88 | } |
| 89 | } |
| 90 | return __channel_forward(chn, bytes); |
| 91 | } |
| 92 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 93 | /*********************************************************************/ |
| 94 | /* These functions are used to compute various channel content sizes */ |
| 95 | /*********************************************************************/ |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 96 | |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 97 | /* Reports non-zero if the channel is empty, which means both its |
| 98 | * buffer and pipe are empty. The construct looks strange but is |
| 99 | * jump-less and much more efficient on both 32 and 64-bit than |
| 100 | * the boolean test. |
| 101 | */ |
| 102 | static inline unsigned int channel_is_empty(struct channel *c) |
| 103 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 104 | return !(c->buf->o | (long)c->pipe); |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 105 | } |
| 106 | |
Willy Tarreau | 379357a | 2013-06-08 12:55:46 +0200 | [diff] [blame] | 107 | /* Returns non-zero if the buffer input has all of its reserve available. This |
| 108 | * is used to decide when a request or response may be parsed when some data |
| 109 | * from a previous exchange might still be present. |
| 110 | */ |
| 111 | static inline int channel_reserved(const struct channel *chn) |
| 112 | { |
| 113 | int rem = chn->buf->size; |
| 114 | |
| 115 | rem -= chn->buf->o; |
| 116 | rem -= chn->buf->i; |
| 117 | rem -= global.tune.maxrewrite; |
| 118 | return rem >= 0; |
| 119 | } |
| 120 | |
Willy Tarreau | ca12910 | 2015-01-14 16:08:45 +0100 | [diff] [blame] | 121 | /* Tells whether data are likely to leave the buffer. This is used to know when |
| 122 | * we can safely ignore the reserve since we know we cannot retry a connection. |
| 123 | * It returns zero if data are blocked, non-zero otherwise. |
| 124 | */ |
| 125 | static inline int channel_may_send(const struct channel *chn) |
| 126 | { |
| 127 | return chn->cons->state == SI_ST_EST; |
| 128 | } |
| 129 | |
Willy Tarreau | 379357a | 2013-06-08 12:55:46 +0200 | [diff] [blame] | 130 | /* Returns non-zero if the buffer input is considered full. This is used to |
| 131 | * decide when to stop reading into a buffer when we want to ensure that we |
| 132 | * leave the reserve untouched after all pending outgoing data are forwarded. |
| 133 | * The reserved space is taken into account if ->to_forward indicates that an |
| 134 | * end of transfer is close to happen. Note that both ->buf->o and ->to_forward |
| 135 | * are considered as available since they're supposed to leave the buffer. The |
| 136 | * test is optimized to avoid as many operations as possible for the fast case |
| 137 | * and to be used as an "if" condition. |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 138 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 139 | static inline int channel_full(const struct channel *chn) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 140 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 141 | int rem = chn->buf->size; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 142 | |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 143 | rem -= chn->buf->o; |
| 144 | rem -= chn->buf->i; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 145 | if (!rem) |
| 146 | return 1; /* buffer already full */ |
| 147 | |
Willy Tarreau | 5aea838 | 2015-01-13 19:07:23 +0100 | [diff] [blame] | 148 | /* now we know there's some room left, verify if we're touching |
| 149 | * the reserve with some permanent input data. |
| 150 | */ |
| 151 | if (chn->to_forward >= chn->buf->i || |
| 152 | (CHN_INFINITE_FORWARD < MAX_RANGE(typeof(chn->buf->i)) && // just there to ensure gcc |
| 153 | chn->to_forward == CHN_INFINITE_FORWARD)) // avoids the useless second |
| 154 | return 0; // test whenever possible |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 155 | |
| 156 | rem -= global.tune.maxrewrite; |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 157 | rem += chn->buf->o; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 158 | rem += chn->to_forward; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 159 | return rem <= 0; |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 160 | } |
| 161 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 162 | /* Returns true if the channel's input is already closed */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 163 | static inline int channel_input_closed(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 164 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 165 | return ((chn->flags & CF_SHUTR) != 0); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 166 | } |
| 167 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 168 | /* Returns true if the channel's output is already closed */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 169 | static inline int channel_output_closed(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 170 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 171 | return ((chn->flags & CF_SHUTW) != 0); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 172 | } |
| 173 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 174 | /* Check channel timeouts, and set the corresponding flags. The likely/unlikely |
| 175 | * have been optimized for fastest normal path. The read/write timeouts are not |
| 176 | * set if there was activity on the channel. That way, we don't have to update |
| 177 | * 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] | 178 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 179 | static inline void channel_check_timeouts(struct channel *chn) |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 180 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 181 | if (likely(!(chn->flags & (CF_SHUTR|CF_READ_TIMEOUT|CF_READ_ACTIVITY|CF_READ_NOEXP))) && |
| 182 | unlikely(tick_is_expired(chn->rex, now_ms))) |
| 183 | chn->flags |= CF_READ_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 184 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 185 | if (likely(!(chn->flags & (CF_SHUTW|CF_WRITE_TIMEOUT|CF_WRITE_ACTIVITY))) && |
| 186 | unlikely(tick_is_expired(chn->wex, now_ms))) |
| 187 | chn->flags |= CF_WRITE_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 188 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 189 | if (likely(!(chn->flags & CF_ANA_TIMEOUT)) && |
| 190 | unlikely(tick_is_expired(chn->analyse_exp, now_ms))) |
| 191 | chn->flags |= CF_ANA_TIMEOUT; |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 192 | } |
| 193 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 194 | /* Erase any content from channel <buf> and adjusts flags accordingly. Note |
Willy Tarreau | 0abebcc | 2009-01-08 00:09:41 +0100 | [diff] [blame] | 195 | * that any spliced data is not affected since we may not have any access to |
| 196 | * it. |
Willy Tarreau | e393fe2 | 2008-08-16 22:18:07 +0200 | [diff] [blame] | 197 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 198 | static inline void channel_erase(struct channel *chn) |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 199 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 200 | chn->buf->o = 0; |
| 201 | chn->buf->i = 0; |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 202 | chn->to_forward = 0; |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 203 | chn->buf->p = chn->buf->data; |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 204 | } |
| 205 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 206 | /* marks the channel as "shutdown" ASAP for reads */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 207 | static inline void channel_shutr_now(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 208 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 209 | chn->flags |= CF_SHUTR_NOW; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 210 | } |
| 211 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 212 | /* marks the channel as "shutdown" ASAP for writes */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 213 | static inline void channel_shutw_now(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 214 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 215 | chn->flags |= CF_SHUTW_NOW; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 216 | } |
| 217 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 218 | /* marks the channel as "shutdown" ASAP in both directions */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 219 | static inline void channel_abort(struct channel *chn) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 220 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 221 | chn->flags |= CF_SHUTR_NOW | CF_SHUTW_NOW; |
| 222 | chn->flags &= ~CF_AUTO_CONNECT; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 223 | } |
| 224 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 225 | /* allow the consumer to try to establish a new connection. */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 226 | static inline void channel_auto_connect(struct channel *chn) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 227 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 228 | chn->flags |= CF_AUTO_CONNECT; |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 229 | } |
| 230 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 231 | /* prevent the consumer from trying to establish a new connection, and also |
| 232 | * disable auto shutdown forwarding. |
| 233 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 234 | static inline void channel_dont_connect(struct channel *chn) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 235 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 236 | chn->flags &= ~(CF_AUTO_CONNECT|CF_AUTO_CLOSE); |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 237 | } |
| 238 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 239 | /* allow the producer to forward shutdown requests */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 240 | static inline void channel_auto_close(struct channel *chn) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 241 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 242 | chn->flags |= CF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 243 | } |
| 244 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 245 | /* prevent the producer from forwarding shutdown requests */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 246 | static inline void channel_dont_close(struct channel *chn) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 247 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 248 | chn->flags &= ~CF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 249 | } |
| 250 | |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 251 | /* allow the producer to read / poll the input */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 252 | static inline void channel_auto_read(struct channel *chn) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 253 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 254 | chn->flags &= ~CF_DONT_READ; |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 255 | } |
| 256 | |
| 257 | /* prevent the producer from read / poll the input */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 258 | static inline void channel_dont_read(struct channel *chn) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 259 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 260 | chn->flags |= CF_DONT_READ; |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 261 | } |
| 262 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 263 | |
| 264 | /*************************************************/ |
| 265 | /* Buffer operations in the context of a channel */ |
| 266 | /*************************************************/ |
| 267 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 268 | |
| 269 | /* Return the max number of bytes the buffer can contain so that once all the |
| 270 | * pending bytes are forwarded, the buffer still has global.tune.maxrewrite |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 271 | * bytes free. The result sits between chn->size - maxrewrite and chn->size. |
Willy Tarreau | 7610073 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 272 | * The principle is the following : |
| 273 | * - a non-connected buffer cannot touch the reserve |
| 274 | * - infinite forward can fill the buffer |
| 275 | * - all output bytes are ignored, they're leaving |
| 276 | * - all input bytes covered by to_forward are considered in transit and |
| 277 | * virtually don't take room |
| 278 | * - the reserve may be covered up to the min of (fwd-transit) since these |
| 279 | * bytes will be in transit later thus will only take temporary space. |
| 280 | * |
| 281 | * So the formula is to return this limit is : |
| 282 | * size - maxrewrite + min(fwd - min(i, fwd), maxrewrite) |
| 283 | * = size - maxrewrite + min( min(fwd - i, 0), maxrewrite) |
| 284 | * |
| 285 | * The code isn't written the most obvious way because we help the compiler |
| 286 | * optimise it as it cannot guess how to factor the result out. The most common |
| 287 | * path is jumpless. |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 288 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 289 | static inline int buffer_max_len(const struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 290 | { |
Willy Tarreau | 7610073 | 2016-01-25 01:09:11 +0100 | [diff] [blame] | 291 | int transit; |
| 292 | int reserve; |
| 293 | |
| 294 | /* return size - maxrewrite if we can't send */ |
| 295 | reserve = global.tune.maxrewrite; |
| 296 | if (unlikely(!channel_may_send(chn))) |
| 297 | goto end; |
| 298 | |
| 299 | /* This apparently tricky check is just a hint to let the compiler |
| 300 | * optimize all this code away as long as we don't change the types. |
| 301 | */ |
| 302 | reserve = 0; |
| 303 | if (CHN_INFINITE_FORWARD < MAX_RANGE(typeof(chn->buf->i)) && |
| 304 | chn->to_forward == CHN_INFINITE_FORWARD) |
| 305 | goto end; |
| 306 | |
| 307 | transit = chn->to_forward - chn->buf->i; |
| 308 | if (transit < 0) |
| 309 | transit = 0; |
| 310 | |
| 311 | reserve = global.tune.maxrewrite - transit; |
| 312 | if (reserve < 0) |
| 313 | reserve = 0; |
| 314 | end: |
| 315 | return chn->buf->size - reserve; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 316 | } |
| 317 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 318 | /* Returns the amount of space available at the input of the buffer, taking the |
| 319 | * reserved space into account if ->to_forward indicates that an end of transfer |
| 320 | * is close to happen. The test is optimized to avoid as many operations as |
| 321 | * possible for the fast case. |
| 322 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 323 | static inline int bi_avail(const struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 324 | { |
Willy Tarreau | 18b09d0 | 2015-01-14 15:56:50 +0100 | [diff] [blame] | 325 | int ret; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 326 | |
Willy Tarreau | 18b09d0 | 2015-01-14 15:56:50 +0100 | [diff] [blame] | 327 | ret = buffer_max_len(chn) - chn->buf->i - chn->buf->o; |
| 328 | if (ret < 0) |
| 329 | ret = 0; |
| 330 | return ret; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 331 | } |
| 332 | |
| 333 | /* Cut the "tail" of the channel's buffer, which means strip it to the length |
| 334 | * of unsent data only, and kill any remaining unsent data. Any scheduled |
| 335 | * forwarding is stopped. This is mainly to be used to send error messages |
| 336 | * after existing data. |
| 337 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 338 | static inline void bi_erase(struct channel *chn) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 339 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 340 | if (!chn->buf->o) |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 341 | return channel_erase(chn); |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 342 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 343 | chn->to_forward = 0; |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 344 | if (!chn->buf->i) |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 345 | return; |
| 346 | |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 347 | chn->buf->i = 0; |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 348 | } |
| 349 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 350 | /* |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 351 | * Advance the channel buffer's read pointer by <len> bytes. This is useful |
| 352 | * when data have been read directly from the buffer. It is illegal to call |
| 353 | * this function with <len> causing a wrapping at the end of the buffer. It's |
| 354 | * the caller's responsibility to ensure that <len> is never larger than |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 355 | * chn->o. Channel flag WRITE_PARTIAL is set. |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 356 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 357 | static inline void bo_skip(struct channel *chn, int len) |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 358 | { |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 359 | chn->buf->o -= len; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 360 | |
Willy Tarreau | 5fb3803 | 2012-12-16 19:39:09 +0100 | [diff] [blame] | 361 | if (buffer_empty(chn->buf)) |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 362 | chn->buf->p = chn->buf->data; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 363 | |
Willy Tarreau | fb0e920 | 2009-09-23 23:47:55 +0200 | [diff] [blame] | 364 | /* notify that some data was written to the SI from the buffer */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 365 | chn->flags |= CF_WRITE_PARTIAL; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 366 | } |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 367 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 368 | /* 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] | 369 | * 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] | 370 | * closed, -2 is returned. If the block is too large for this buffer, -3 is |
| 371 | * returned. If there is not enough room left in the buffer, -1 is returned. |
| 372 | * 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] | 373 | * 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] | 374 | * chunk's length is updated with the number of bytes sent. |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 375 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 376 | static inline int bi_putchk(struct channel *chn, struct chunk *chunk) |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 377 | { |
| 378 | int ret; |
| 379 | |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 380 | ret = bi_putblk(chn, chunk->str, chunk->len); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 381 | if (ret > 0) |
| 382 | chunk->len -= ret; |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 383 | return ret; |
| 384 | } |
| 385 | |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 386 | /* 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] | 387 | * 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] | 388 | * input is closed, -2 is returned. If the block is too large for this buffer, |
| 389 | * -3 is returned. If there is not enough room left in the buffer, -1 is |
| 390 | * returned. Otherwise the number of bytes copied is returned (0 being a valid |
| 391 | * number). Channel flag READ_PARTIAL is updated if some data can be |
| 392 | * transferred. |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 393 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 394 | static inline int bi_putstr(struct channel *chn, const char *str) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 395 | { |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 396 | return bi_putblk(chn, str, strlen(str)); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 397 | } |
| 398 | |
| 399 | /* |
Willy Tarreau | 8263d2b | 2012-08-28 00:06:31 +0200 | [diff] [blame] | 400 | * Return one char from the channel's buffer. If the buffer is empty and the |
| 401 | * channel is closed, return -2. If the buffer is just empty, return -1. The |
| 402 | * buffer's pointer is not advanced, it's up to the caller to call bo_skip(buf, |
| 403 | * 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] | 404 | * chn->o limit. |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 405 | */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 406 | static inline int bo_getchr(struct channel *chn) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 407 | { |
| 408 | /* closed or empty + imminent close = -2; empty = -1 */ |
Willy Tarreau | 974ced6 | 2012-10-12 23:11:02 +0200 | [diff] [blame] | 409 | if (unlikely((chn->flags & CF_SHUTW) || channel_is_empty(chn))) { |
| 410 | if (chn->flags & (CF_SHUTW|CF_SHUTW_NOW)) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 411 | return -2; |
| 412 | return -1; |
| 413 | } |
Willy Tarreau | 9b28e03 | 2012-10-12 23:49:43 +0200 | [diff] [blame] | 414 | return *buffer_wrap_sub(chn->buf, chn->buf->p - chn->buf->o); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 415 | } |
| 416 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 417 | |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 418 | #endif /* _PROTO_CHANNEL_H */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 419 | |
| 420 | /* |
| 421 | * Local variables: |
| 422 | * c-indent-level: 8 |
| 423 | * c-basic-offset: 8 |
| 424 | * End: |
| 425 | */ |