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