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 | 7341d94 | 2007-05-13 19:56:02 +0200 | [diff] [blame] | 37 | extern struct pool_head *pool2_buffer; |
| 38 | |
| 39 | /* perform minimal intializations, report 0 in case of error, 1 if OK. */ |
| 40 | int init_buffer(); |
| 41 | |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 42 | /* SI-to-buffer functions : buffer_{get,put}_{char,block,string,chunk} */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 43 | int bo_inject(struct channel *buf, const char *msg, int len); |
| 44 | int bi_putblk(struct channel *buf, const char *str, int len); |
| 45 | int bi_putchr(struct channel *buf, char c); |
| 46 | int bo_getline(struct channel *buf, char *str, int len); |
| 47 | int bo_getblk(struct channel *buf, char *blk, int len, int offset); |
| 48 | int buffer_replace2(struct channel *b, char *pos, char *end, const char *str, int len); |
| 49 | int buffer_insert_line2(struct channel *b, char *pos, const char *str, int len); |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 50 | unsigned long long buffer_forward(struct channel *buf, unsigned long long bytes); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 51 | |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 52 | /* Initialize all fields in the buffer. */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 53 | static inline void buffer_init(struct channel *buf) |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 54 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 55 | buf->buf.o = 0; |
| 56 | buf->buf.i = 0; |
| 57 | buf->buf.p = buf->buf.data; |
Willy Tarreau | 6b66f3e | 2008-12-14 17:31:54 +0100 | [diff] [blame] | 58 | buf->to_forward = 0; |
Willy Tarreau | 02d6cfc | 2012-03-01 18:19:58 +0100 | [diff] [blame] | 59 | buf->total = 0; |
Willy Tarreau | 3eba98a | 2009-01-25 13:56:13 +0100 | [diff] [blame] | 60 | buf->pipe = NULL; |
Willy Tarreau | 2df28e8 | 2008-08-17 15:20:19 +0200 | [diff] [blame] | 61 | buf->analysers = 0; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 62 | buf->cons = NULL; |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 63 | buf->flags = 0; |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 64 | } |
| 65 | |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 66 | /*****************************************************************/ |
| 67 | /* These functions are used to compute various buffer area sizes */ |
| 68 | /*****************************************************************/ |
| 69 | |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 70 | /* Reports non-zero if the channel is empty, which means both its |
| 71 | * buffer and pipe are empty. The construct looks strange but is |
| 72 | * jump-less and much more efficient on both 32 and 64-bit than |
| 73 | * the boolean test. |
| 74 | */ |
| 75 | static inline unsigned int channel_is_empty(struct channel *c) |
| 76 | { |
| 77 | return !(c->buf.o | (long)c->pipe); |
| 78 | } |
| 79 | |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 80 | /* Return the number of reserved bytes in the buffer, which ensures that once |
| 81 | * all pending data are forwarded, the buffer still has global.tune.maxrewrite |
| 82 | * bytes free. The result is between 0 and global.maxrewrite, which is itself |
| 83 | * smaller than any buf->size. |
| 84 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 85 | static inline int buffer_reserved(const struct channel *buf) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 86 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 87 | int ret = global.tune.maxrewrite - buf->to_forward - buf->buf.o; |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 88 | |
| 89 | if (buf->to_forward == BUF_INFINITE_FORWARD) |
| 90 | return 0; |
| 91 | if (ret <= 0) |
| 92 | return 0; |
| 93 | return ret; |
| 94 | } |
| 95 | |
Willy Tarreau | 7c3c541 | 2009-12-13 15:53:05 +0100 | [diff] [blame] | 96 | /* Return the max number of bytes the buffer can contain so that once all the |
| 97 | * pending bytes are forwarded, the buffer still has global.tune.maxrewrite |
| 98 | * bytes free. The result sits between buf->size - maxrewrite and buf->size. |
| 99 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 100 | static inline int buffer_max_len(const struct channel *buf) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 101 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 102 | return buf->buf.size - buffer_reserved(buf); |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 103 | } |
| 104 | |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 105 | /* Returns non-zero if the buffer input is considered full. The reserved space |
| 106 | * is taken into account if ->to_forward indicates that an end of transfer is |
| 107 | * close to happen. The test is optimized to avoid as many operations as |
| 108 | * possible for the fast case and to be used as an "if" condition. |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 109 | */ |
Willy Tarreau | ad1cc3d | 2012-08-27 18:54:20 +0200 | [diff] [blame^] | 110 | static inline int channel_full(const struct channel *b) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 111 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 112 | int rem = b->buf.size; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 113 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 114 | rem -= b->buf.o; |
| 115 | rem -= b->buf.i; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 116 | if (!rem) |
| 117 | return 1; /* buffer already full */ |
| 118 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 119 | if (b->to_forward >= b->buf.size || |
| 120 | (BUF_INFINITE_FORWARD < MAX_RANGE(typeof(b->buf.size)) && // just there to ensure gcc |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 121 | b->to_forward == BUF_INFINITE_FORWARD)) // avoids the useless second |
| 122 | return 0; // test whenever possible |
| 123 | |
| 124 | rem -= global.tune.maxrewrite; |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 125 | rem += b->buf.o; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 126 | rem += b->to_forward; |
| 127 | return rem <= 0; |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 128 | } |
| 129 | |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 130 | /* Returns the amount of space available at the input of the buffer, taking the |
| 131 | * reserved space into account if ->to_forward indicates that an end of transfer |
| 132 | * is close to happen. The test is optimized to avoid as many operations as |
| 133 | * possible for the fast case. |
| 134 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 135 | static inline int bi_avail(const struct channel *b) |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 136 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 137 | int rem = b->buf.size; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 138 | int rem2; |
| 139 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 140 | rem -= b->buf.o; |
| 141 | rem -= b->buf.i; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 142 | if (!rem) |
| 143 | return rem; /* buffer already full */ |
| 144 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 145 | if (b->to_forward >= b->buf.size || |
| 146 | (BUF_INFINITE_FORWARD < MAX_RANGE(typeof(b->buf.size)) && // just there to ensure gcc |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 147 | b->to_forward == BUF_INFINITE_FORWARD)) // avoids the useless second |
| 148 | return rem; // test whenever possible |
| 149 | |
| 150 | rem2 = rem - global.tune.maxrewrite; |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 151 | rem2 += b->buf.o; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 152 | rem2 += b->to_forward; |
| 153 | |
| 154 | if (rem > rem2) |
| 155 | rem = rem2; |
| 156 | if (rem > 0) |
| 157 | return rem; |
| 158 | return 0; |
| 159 | } |
| 160 | |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 161 | /* Return the amount of bytes that can be written into the buffer at once, |
Willy Tarreau | 363a5bb | 2012-03-02 20:14:45 +0100 | [diff] [blame] | 162 | * excluding reserved space, which is preserved. |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 163 | */ |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 164 | static inline int buffer_contig_space_res(const struct channel *chn) |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 165 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 166 | return buffer_contig_space_with_res(&chn->buf, buffer_reserved(chn)); |
Willy Tarreau | 4b517ca | 2011-11-25 20:33:58 +0100 | [diff] [blame] | 167 | } |
| 168 | |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 169 | /* Returns true if the buffer's input is already closed */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 170 | static inline int buffer_input_closed(struct channel *buf) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 171 | { |
| 172 | return ((buf->flags & BF_SHUTR) != 0); |
| 173 | } |
| 174 | |
| 175 | /* Returns true if the buffer's output is already closed */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 176 | static inline int buffer_output_closed(struct channel *buf) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 177 | { |
| 178 | return ((buf->flags & BF_SHUTW) != 0); |
| 179 | } |
| 180 | |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 181 | /* Check buffer timeouts, and set the corresponding flags. The |
| 182 | * likely/unlikely have been optimized for fastest normal path. |
Willy Tarreau | dd80c6f | 2008-12-13 22:25:59 +0100 | [diff] [blame] | 183 | * The read/write timeouts are not set if there was activity on the buffer. |
| 184 | * That way, we don't have to update the timeout on every I/O. Note that the |
| 185 | * analyser timeout is always checked. |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 186 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 187 | static inline void buffer_check_timeouts(struct channel *b) |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 188 | { |
Willy Tarreau | 86491c3 | 2008-12-14 09:04:47 +0100 | [diff] [blame] | 189 | if (likely(!(b->flags & (BF_SHUTR|BF_READ_TIMEOUT|BF_READ_ACTIVITY|BF_READ_NOEXP))) && |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 190 | unlikely(tick_is_expired(b->rex, now_ms))) |
| 191 | b->flags |= BF_READ_TIMEOUT; |
| 192 | |
Willy Tarreau | dd80c6f | 2008-12-13 22:25:59 +0100 | [diff] [blame] | 193 | if (likely(!(b->flags & (BF_SHUTW|BF_WRITE_TIMEOUT|BF_WRITE_ACTIVITY))) && |
Willy Tarreau | 2eb52f0 | 2008-09-04 09:14:08 +0200 | [diff] [blame] | 194 | unlikely(tick_is_expired(b->wex, now_ms))) |
| 195 | b->flags |= BF_WRITE_TIMEOUT; |
| 196 | |
| 197 | if (likely(!(b->flags & BF_ANA_TIMEOUT)) && |
| 198 | unlikely(tick_is_expired(b->analyse_exp, now_ms))) |
| 199 | b->flags |= BF_ANA_TIMEOUT; |
| 200 | } |
| 201 | |
Willy Tarreau | 6f0aa47 | 2009-03-08 20:33:29 +0100 | [diff] [blame] | 202 | /* Erase any content from buffer <buf> and adjusts flags accordingly. Note |
Willy Tarreau | 0abebcc | 2009-01-08 00:09:41 +0100 | [diff] [blame] | 203 | * that any spliced data is not affected since we may not have any access to |
| 204 | * it. |
Willy Tarreau | e393fe2 | 2008-08-16 22:18:07 +0200 | [diff] [blame] | 205 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 206 | static inline void buffer_erase(struct channel *buf) |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 207 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 208 | buf->buf.o = 0; |
| 209 | buf->buf.i = 0; |
Willy Tarreau | 6b66f3e | 2008-12-14 17:31:54 +0100 | [diff] [blame] | 210 | buf->to_forward = 0; |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 211 | buf->buf.p = buf->buf.data; |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 212 | buf->flags &= ~BF_FULL; |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 213 | } |
| 214 | |
Willy Tarreau | 9cb8daa | 2009-09-15 21:22:24 +0200 | [diff] [blame] | 215 | /* Cut the "tail" of the buffer, which means strip it to the length of unsent |
| 216 | * data only, and kill any remaining unsent data. Any scheduled forwarding is |
| 217 | * stopped. This is mainly to be used to send error messages after existing |
| 218 | * data. |
| 219 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 220 | static inline void bi_erase(struct channel *buf) |
Willy Tarreau | 9cb8daa | 2009-09-15 21:22:24 +0200 | [diff] [blame] | 221 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 222 | if (!buf->buf.o) |
Willy Tarreau | 9cb8daa | 2009-09-15 21:22:24 +0200 | [diff] [blame] | 223 | return buffer_erase(buf); |
| 224 | |
| 225 | buf->to_forward = 0; |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 226 | if (!buf->buf.i) |
Willy Tarreau | 9cb8daa | 2009-09-15 21:22:24 +0200 | [diff] [blame] | 227 | return; |
| 228 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 229 | buf->buf.i = 0; |
Willy Tarreau | ba0b63d | 2009-09-20 08:09:44 +0200 | [diff] [blame] | 230 | buf->flags &= ~BF_FULL; |
Willy Tarreau | 9cb8daa | 2009-09-15 21:22:24 +0200 | [diff] [blame] | 231 | } |
| 232 | |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 233 | /* marks the buffer as "shutdown" ASAP for reads */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 234 | static inline void buffer_shutr_now(struct channel *buf) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 235 | { |
Willy Tarreau | fe3718a | 2008-11-30 18:14:12 +0100 | [diff] [blame] | 236 | buf->flags |= BF_SHUTR_NOW; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 237 | } |
| 238 | |
| 239 | /* marks the buffer as "shutdown" ASAP for writes */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 240 | static inline void buffer_shutw_now(struct channel *buf) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 241 | { |
| 242 | buf->flags |= BF_SHUTW_NOW; |
| 243 | } |
| 244 | |
| 245 | /* marks the buffer as "shutdown" ASAP in both directions */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 246 | static inline void buffer_abort(struct channel *buf) |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 247 | { |
Willy Tarreau | fe3718a | 2008-11-30 18:14:12 +0100 | [diff] [blame] | 248 | buf->flags |= BF_SHUTR_NOW | BF_SHUTW_NOW; |
Willy Tarreau | e459976 | 2010-03-21 23:25:09 +0100 | [diff] [blame] | 249 | buf->flags &= ~BF_AUTO_CONNECT; |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 250 | } |
| 251 | |
Willy Tarreau | 01bf867 | 2008-12-07 18:03:29 +0100 | [diff] [blame] | 252 | /* Installs <func> as a hijacker on the buffer <b> for session <s>. The hijack |
| 253 | * flag is set, and the function called once. The function is responsible for |
| 254 | * clearing the hijack bit. It is possible that the function clears the flag |
| 255 | * during this first call. |
| 256 | */ |
| 257 | static inline void buffer_install_hijacker(struct session *s, |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 258 | struct channel *b, |
| 259 | void (*func)(struct session *, struct channel *)) |
Willy Tarreau | 72b179a | 2008-08-28 16:01:32 +0200 | [diff] [blame] | 260 | { |
Willy Tarreau | 01bf867 | 2008-12-07 18:03:29 +0100 | [diff] [blame] | 261 | b->hijacker = func; |
| 262 | b->flags |= BF_HIJACK; |
| 263 | func(s, b); |
Willy Tarreau | 72b179a | 2008-08-28 16:01:32 +0200 | [diff] [blame] | 264 | } |
| 265 | |
Willy Tarreau | 01bf867 | 2008-12-07 18:03:29 +0100 | [diff] [blame] | 266 | /* Releases the buffer from hijacking mode. Often used by the hijack function */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 267 | static inline void buffer_stop_hijack(struct channel *buf) |
Willy Tarreau | 72b179a | 2008-08-28 16:01:32 +0200 | [diff] [blame] | 268 | { |
| 269 | buf->flags &= ~BF_HIJACK; |
| 270 | } |
| 271 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 272 | /* allow the consumer to try to establish a new connection. */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 273 | static inline void buffer_auto_connect(struct channel *buf) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 274 | { |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 275 | buf->flags |= BF_AUTO_CONNECT; |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 276 | } |
| 277 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 278 | /* prevent the consumer from trying to establish a new connection, and also |
| 279 | * disable auto shutdown forwarding. |
| 280 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 281 | static inline void buffer_dont_connect(struct channel *buf) |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 282 | { |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 283 | buf->flags &= ~(BF_AUTO_CONNECT|BF_AUTO_CLOSE); |
Willy Tarreau | 3da77c5 | 2008-08-29 09:58:42 +0200 | [diff] [blame] | 284 | } |
| 285 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 286 | /* allow the producer to forward shutdown requests */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 287 | static inline void buffer_auto_close(struct channel *buf) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 288 | { |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 289 | buf->flags |= BF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 290 | } |
| 291 | |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 292 | /* prevent the producer from forwarding shutdown requests */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 293 | static inline void buffer_dont_close(struct channel *buf) |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 294 | { |
Willy Tarreau | 520d95e | 2009-09-19 21:04:57 +0200 | [diff] [blame] | 295 | buf->flags &= ~BF_AUTO_CLOSE; |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 296 | } |
| 297 | |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 298 | /* allow the producer to read / poll the input */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 299 | static inline void buffer_auto_read(struct channel *buf) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 300 | { |
| 301 | buf->flags &= ~BF_DONT_READ; |
| 302 | } |
| 303 | |
| 304 | /* prevent the producer from read / poll the input */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 305 | static inline void buffer_dont_read(struct channel *buf) |
Willy Tarreau | 90deb18 | 2010-01-07 00:20:41 +0100 | [diff] [blame] | 306 | { |
| 307 | buf->flags |= BF_DONT_READ; |
| 308 | } |
| 309 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 310 | /* |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 311 | * Advance the buffer's read pointer by <len> bytes. This is useful when data |
| 312 | * have been read directly from the buffer. It is illegal to call this function |
| 313 | * with <len> causing a wrapping at the end of the buffer. It's the caller's |
Willy Tarreau | 2e046c6 | 2012-03-01 16:08:30 +0100 | [diff] [blame] | 314 | * responsibility to ensure that <len> is never larger than buf->o. |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 315 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 316 | static inline void bo_skip(struct channel *buf, int len) |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 317 | { |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 318 | buf->buf.o -= len; |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 319 | |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 320 | if (buffer_len(&buf->buf) == 0) |
| 321 | buf->buf.p = buf->buf.data; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 322 | |
Willy Tarreau | ad1cc3d | 2012-08-27 18:54:20 +0200 | [diff] [blame^] | 323 | if (!channel_full(buf)) |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 324 | buf->flags &= ~BF_FULL; |
| 325 | |
Willy Tarreau | fb0e920 | 2009-09-23 23:47:55 +0200 | [diff] [blame] | 326 | /* notify that some data was written to the SI from the buffer */ |
| 327 | buf->flags |= BF_WRITE_PARTIAL; |
Willy Tarreau | 2b7addc | 2009-08-31 07:37:22 +0200 | [diff] [blame] | 328 | } |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 329 | |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 330 | /* Tries to copy chunk <chunk> into buffer <buf> after length controls. |
Willy Tarreau | 2e046c6 | 2012-03-01 16:08:30 +0100 | [diff] [blame] | 331 | * The ->o and to_forward pointers are updated. If the buffer's input is |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 332 | * closed, -2 is returned. If the block is too large for this buffer, -3 is |
| 333 | * returned. If there is not enough room left in the buffer, -1 is returned. |
| 334 | * Otherwise the number of bytes copied is returned (0 being a valid number). |
| 335 | * Buffer flags FULL, EMPTY and READ_PARTIAL are updated if some data can be |
| 336 | * transferred. The chunk's length is updated with the number of bytes sent. |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 337 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 338 | static inline int bi_putchk(struct channel *buf, struct chunk *chunk) |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 339 | { |
| 340 | int ret; |
| 341 | |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 342 | ret = bi_putblk(buf, chunk->str, chunk->len); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 343 | if (ret > 0) |
| 344 | chunk->len -= ret; |
Willy Tarreau | aeac319 | 2009-08-31 08:09:57 +0200 | [diff] [blame] | 345 | return ret; |
| 346 | } |
| 347 | |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 348 | /* Tries to copy string <str> at once into buffer <buf> after length controls. |
Willy Tarreau | 2e046c6 | 2012-03-01 16:08:30 +0100 | [diff] [blame] | 349 | * The ->o and to_forward pointers are updated. If the buffer's input is |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 350 | * closed, -2 is returned. If the block is too large for this buffer, -3 is |
| 351 | * returned. If there is not enough room left in the buffer, -1 is returned. |
| 352 | * Otherwise the number of bytes copied is returned (0 being a valid number). |
| 353 | * Buffer flags FULL, EMPTY and READ_PARTIAL are updated if some data can be |
| 354 | * transferred. |
| 355 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 356 | static inline int bi_putstr(struct channel *buf, const char *str) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 357 | { |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 358 | return bi_putblk(buf, str, strlen(str)); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 359 | } |
| 360 | |
| 361 | /* |
| 362 | * Return one char from the buffer. If the buffer is empty and closed, return -2. |
| 363 | * If the buffer is just empty, return -1. The buffer's pointer is not advanced, |
Willy Tarreau | 9dab5fc | 2012-05-07 11:56:55 +0200 | [diff] [blame] | 364 | * it's up to the caller to call bo_skip(buf, 1) when it has consumed the char. |
Willy Tarreau | 2e046c6 | 2012-03-01 16:08:30 +0100 | [diff] [blame] | 365 | * Also note that this function respects the ->o limit. |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 366 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 367 | static inline int bo_getchr(struct channel *buf) |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 368 | { |
| 369 | /* closed or empty + imminent close = -2; empty = -1 */ |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 370 | if (unlikely((buf->flags & BF_SHUTW) || channel_is_empty(buf))) { |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 371 | if (buf->flags & (BF_SHUTW|BF_SHUTW_NOW)) |
| 372 | return -2; |
| 373 | return -1; |
| 374 | } |
Willy Tarreau | 572bf90 | 2012-07-02 17:01:20 +0200 | [diff] [blame] | 375 | return *buffer_wrap_sub(&buf->buf, buf->buf.p - buf->buf.o); |
Willy Tarreau | 74b08c9 | 2010-09-08 17:04:31 +0200 | [diff] [blame] | 376 | } |
| 377 | |
Willy Tarreau | 19ae56b | 2011-11-28 10:36:13 +0100 | [diff] [blame] | 378 | /* This function writes the string <str> at position <pos> which must be in |
| 379 | * buffer <b>, and moves <end> just after the end of <str>. <b>'s parameters |
| 380 | * (l, r, lr) are updated to be valid after the shift. the shift value |
| 381 | * (positive or negative) is returned. If there's no space left, the move is |
Willy Tarreau | 8e21bb9 | 2012-08-24 22:40:29 +0200 | [diff] [blame] | 382 | * not done. The function does not adjust ->o because it does not make sense |
| 383 | * to use it on data scheduled to be sent. |
Willy Tarreau | 19ae56b | 2011-11-28 10:36:13 +0100 | [diff] [blame] | 384 | */ |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 385 | static inline int buffer_replace(struct channel *b, char *pos, char *end, const char *str) |
Willy Tarreau | 19ae56b | 2011-11-28 10:36:13 +0100 | [diff] [blame] | 386 | { |
| 387 | return buffer_replace2(b, pos, end, str, strlen(str)); |
| 388 | } |
| 389 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 390 | |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 391 | #endif /* _PROTO_CHANNEL_H */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 392 | |
| 393 | /* |
| 394 | * Local variables: |
| 395 | * c-indent-level: 8 |
| 396 | * c-basic-offset: 8 |
| 397 | * End: |
| 398 | */ |