blob: eb40140f7c126020d47f29319fa3f46a6ef46b65 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreauc7e42382012-08-24 19:22:53 +02002 * include/proto/channel.h
3 * Channel management definitions, macros and inline functions.
Willy Tarreau7c3c5412009-12-13 15:53:05 +01004 *
Willy Tarreau9dab5fc2012-05-07 11:56:55 +02005 * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
Willy Tarreau7c3c5412009-12-13 15:53:05 +01006 *
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 Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreauc7e42382012-08-24 19:22:53 +020022#ifndef _PROTO_CHANNEL_H
23#define _PROTO_CHANNEL_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Willy Tarreau7341d942007-05-13 19:56:02 +020025#include <stdio.h>
Willy Tarreau0f772532006-12-23 20:51:41 +010026#include <stdlib.h>
Willy Tarreau7341d942007-05-13 19:56:02 +020027#include <string.h>
Willy Tarreau0f772532006-12-23 20:51:41 +010028
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020029#include <common/config.h>
Willy Tarreauc7e42382012-08-24 19:22:53 +020030#include <common/chunk.h>
Willy Tarreau7341d942007-05-13 19:56:02 +020031#include <common/memory.h>
Willy Tarreau0c303ee2008-07-07 00:09:58 +020032#include <common/ticks.h>
Willy Tarreaufa645582007-06-03 15:59:52 +020033#include <common/time.h>
34
Willy Tarreau7c3c5412009-12-13 15:53:05 +010035#include <types/global.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020036
Willy Tarreau8263d2b2012-08-28 00:06:31 +020037extern struct pool_head *pool2_channel;
Willy Tarreau7341d942007-05-13 19:56:02 +020038
39/* perform minimal intializations, report 0 in case of error, 1 if OK. */
Willy Tarreau8263d2b2012-08-28 00:06:31 +020040int init_channel();
Willy Tarreau7341d942007-05-13 19:56:02 +020041
Willy Tarreau55a69062012-10-26 00:21:52 +020042unsigned long long __channel_forward(struct channel *chn, unsigned long long bytes);
Willy Tarreau8263d2b2012-08-28 00:06:31 +020043
44/* SI-to-channel functions working with buffers */
Willy Tarreau974ced62012-10-12 23:11:02 +020045int bi_putblk(struct channel *chn, const char *str, int len);
46int bi_putchr(struct channel *chn, char c);
47int bo_inject(struct channel *chn, const char *msg, int len);
48int bo_getline(struct channel *chn, char *str, int len);
49int bo_getblk(struct channel *chn, char *blk, int len, int offset);
Willy Tarreau74b08c92010-09-08 17:04:31 +020050
Willy Tarreau8263d2b2012-08-28 00:06:31 +020051/* Initialize all fields in the channel. */
Willy Tarreau974ced62012-10-12 23:11:02 +020052static inline void channel_init(struct channel *chn)
Willy Tarreau54469402006-07-29 16:59:06 +020053{
Willy Tarreau9b28e032012-10-12 23:49:43 +020054 chn->buf->o = 0;
55 chn->buf->i = 0;
56 chn->buf->p = chn->buf->data;
Willy Tarreau974ced62012-10-12 23:11:02 +020057 chn->to_forward = 0;
58 chn->total = 0;
59 chn->pipe = NULL;
60 chn->analysers = 0;
61 chn->cons = NULL;
62 chn->flags = 0;
Willy Tarreau54469402006-07-29 16:59:06 +020063}
64
Willy Tarreau55a69062012-10-26 00:21:52 +020065/* Schedule up to <bytes> more bytes to be forwarded via the channel without
66 * notifying the owner task. Any data pending in the buffer are scheduled to be
67 * sent as well, in the limit of the number of bytes to forward. This must be
68 * the only method to use to schedule bytes to be forwarded. If the requested
69 * number is too large, it is automatically adjusted. The number of bytes taken
70 * into account is returned. Directly touching ->to_forward will cause lockups
71 * when buf->o goes down to zero if nobody is ready to push the remaining data.
72 */
73static inline unsigned long long channel_forward(struct channel *chn, unsigned long long bytes)
74{
75 /* hint: avoid comparisons on long long for the fast case, since if the
76 * length does not fit in an unsigned it, it will never be forwarded at
77 * once anyway.
78 */
79 if (bytes <= ~0U) {
80 unsigned int bytes32 = bytes;
81
82 if (bytes32 <= chn->buf->i) {
83 /* OK this amount of bytes might be forwarded at once */
84 b_adv(chn->buf, bytes32);
85 return bytes;
86 }
87 }
88 return __channel_forward(chn, bytes);
89}
90
Willy Tarreau8263d2b2012-08-28 00:06:31 +020091/*********************************************************************/
92/* These functions are used to compute various channel content sizes */
93/*********************************************************************/
Willy Tarreau4b517ca2011-11-25 20:33:58 +010094
Willy Tarreau8e21bb92012-08-24 22:40:29 +020095/* Reports non-zero if the channel is empty, which means both its
96 * buffer and pipe are empty. The construct looks strange but is
97 * jump-less and much more efficient on both 32 and 64-bit than
98 * the boolean test.
99 */
100static inline unsigned int channel_is_empty(struct channel *c)
101{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200102 return !(c->buf->o | (long)c->pipe);
Willy Tarreau8e21bb92012-08-24 22:40:29 +0200103}
104
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200105/* 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 Tarreau4b517ca2011-11-25 20:33:58 +0100109 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200110static inline int channel_full(const struct channel *chn)
Willy Tarreau4b517ca2011-11-25 20:33:58 +0100111{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200112 int rem = chn->buf->size;
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200113
Willy Tarreau9b28e032012-10-12 23:49:43 +0200114 rem -= chn->buf->o;
115 rem -= chn->buf->i;
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200116 if (!rem)
117 return 1; /* buffer already full */
118
Willy Tarreau9b28e032012-10-12 23:49:43 +0200119 if (chn->to_forward >= chn->buf->size ||
120 (CHN_INFINITE_FORWARD < MAX_RANGE(typeof(chn->buf->size)) && // just there to ensure gcc
Willy Tarreau974ced62012-10-12 23:11:02 +0200121 chn->to_forward == CHN_INFINITE_FORWARD)) // avoids the useless second
122 return 0; // test whenever possible
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200123
124 rem -= global.tune.maxrewrite;
Willy Tarreau9b28e032012-10-12 23:49:43 +0200125 rem += chn->buf->o;
Willy Tarreau974ced62012-10-12 23:11:02 +0200126 rem += chn->to_forward;
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200127 return rem <= 0;
Willy Tarreau4b517ca2011-11-25 20:33:58 +0100128}
129
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200130/* Returns true if the channel's input is already closed */
Willy Tarreau974ced62012-10-12 23:11:02 +0200131static inline int channel_input_closed(struct channel *chn)
Willy Tarreau74b08c92010-09-08 17:04:31 +0200132{
Willy Tarreau974ced62012-10-12 23:11:02 +0200133 return ((chn->flags & CF_SHUTR) != 0);
Willy Tarreau74b08c92010-09-08 17:04:31 +0200134}
135
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200136/* Returns true if the channel's output is already closed */
Willy Tarreau974ced62012-10-12 23:11:02 +0200137static inline int channel_output_closed(struct channel *chn)
Willy Tarreau74b08c92010-09-08 17:04:31 +0200138{
Willy Tarreau974ced62012-10-12 23:11:02 +0200139 return ((chn->flags & CF_SHUTW) != 0);
Willy Tarreau74b08c92010-09-08 17:04:31 +0200140}
141
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200142/* Check channel timeouts, and set the corresponding flags. The likely/unlikely
143 * have been optimized for fastest normal path. The read/write timeouts are not
144 * set if there was activity on the channel. That way, we don't have to update
145 * the timeout on every I/O. Note that the analyser timeout is always checked.
Willy Tarreau2eb52f02008-09-04 09:14:08 +0200146 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200147static inline void channel_check_timeouts(struct channel *chn)
Willy Tarreau2eb52f02008-09-04 09:14:08 +0200148{
Willy Tarreau974ced62012-10-12 23:11:02 +0200149 if (likely(!(chn->flags & (CF_SHUTR|CF_READ_TIMEOUT|CF_READ_ACTIVITY|CF_READ_NOEXP))) &&
150 unlikely(tick_is_expired(chn->rex, now_ms)))
151 chn->flags |= CF_READ_TIMEOUT;
Willy Tarreau2eb52f02008-09-04 09:14:08 +0200152
Willy Tarreau974ced62012-10-12 23:11:02 +0200153 if (likely(!(chn->flags & (CF_SHUTW|CF_WRITE_TIMEOUT|CF_WRITE_ACTIVITY))) &&
154 unlikely(tick_is_expired(chn->wex, now_ms)))
155 chn->flags |= CF_WRITE_TIMEOUT;
Willy Tarreau2eb52f02008-09-04 09:14:08 +0200156
Willy Tarreau974ced62012-10-12 23:11:02 +0200157 if (likely(!(chn->flags & CF_ANA_TIMEOUT)) &&
158 unlikely(tick_is_expired(chn->analyse_exp, now_ms)))
159 chn->flags |= CF_ANA_TIMEOUT;
Willy Tarreau2eb52f02008-09-04 09:14:08 +0200160}
161
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200162/* Erase any content from channel <buf> and adjusts flags accordingly. Note
Willy Tarreau0abebcc2009-01-08 00:09:41 +0100163 * that any spliced data is not affected since we may not have any access to
164 * it.
Willy Tarreaue393fe22008-08-16 22:18:07 +0200165 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200166static inline void channel_erase(struct channel *chn)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200167{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200168 chn->buf->o = 0;
169 chn->buf->i = 0;
Willy Tarreau974ced62012-10-12 23:11:02 +0200170 chn->to_forward = 0;
Willy Tarreau9b28e032012-10-12 23:49:43 +0200171 chn->buf->p = chn->buf->data;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200172}
173
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200174/* marks the channel as "shutdown" ASAP for reads */
Willy Tarreau974ced62012-10-12 23:11:02 +0200175static inline void channel_shutr_now(struct channel *chn)
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200176{
Willy Tarreau974ced62012-10-12 23:11:02 +0200177 chn->flags |= CF_SHUTR_NOW;
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200178}
179
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200180/* marks the channel as "shutdown" ASAP for writes */
Willy Tarreau974ced62012-10-12 23:11:02 +0200181static inline void channel_shutw_now(struct channel *chn)
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200182{
Willy Tarreau974ced62012-10-12 23:11:02 +0200183 chn->flags |= CF_SHUTW_NOW;
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200184}
185
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200186/* marks the channel as "shutdown" ASAP in both directions */
Willy Tarreau974ced62012-10-12 23:11:02 +0200187static inline void channel_abort(struct channel *chn)
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200188{
Willy Tarreau974ced62012-10-12 23:11:02 +0200189 chn->flags |= CF_SHUTR_NOW | CF_SHUTW_NOW;
190 chn->flags &= ~CF_AUTO_CONNECT;
Willy Tarreaufa7e1022008-10-19 07:30:41 +0200191}
192
Willy Tarreau520d95e2009-09-19 21:04:57 +0200193/* allow the consumer to try to establish a new connection. */
Willy Tarreau974ced62012-10-12 23:11:02 +0200194static inline void channel_auto_connect(struct channel *chn)
Willy Tarreau3da77c52008-08-29 09:58:42 +0200195{
Willy Tarreau974ced62012-10-12 23:11:02 +0200196 chn->flags |= CF_AUTO_CONNECT;
Willy Tarreau3da77c52008-08-29 09:58:42 +0200197}
198
Willy Tarreau520d95e2009-09-19 21:04:57 +0200199/* prevent the consumer from trying to establish a new connection, and also
200 * disable auto shutdown forwarding.
201 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200202static inline void channel_dont_connect(struct channel *chn)
Willy Tarreau3da77c52008-08-29 09:58:42 +0200203{
Willy Tarreau974ced62012-10-12 23:11:02 +0200204 chn->flags &= ~(CF_AUTO_CONNECT|CF_AUTO_CLOSE);
Willy Tarreau3da77c52008-08-29 09:58:42 +0200205}
206
Willy Tarreau520d95e2009-09-19 21:04:57 +0200207/* allow the producer to forward shutdown requests */
Willy Tarreau974ced62012-10-12 23:11:02 +0200208static inline void channel_auto_close(struct channel *chn)
Willy Tarreau0a5d5dd2008-11-23 19:31:35 +0100209{
Willy Tarreau974ced62012-10-12 23:11:02 +0200210 chn->flags |= CF_AUTO_CLOSE;
Willy Tarreau0a5d5dd2008-11-23 19:31:35 +0100211}
212
Willy Tarreau520d95e2009-09-19 21:04:57 +0200213/* prevent the producer from forwarding shutdown requests */
Willy Tarreau974ced62012-10-12 23:11:02 +0200214static inline void channel_dont_close(struct channel *chn)
Willy Tarreau0a5d5dd2008-11-23 19:31:35 +0100215{
Willy Tarreau974ced62012-10-12 23:11:02 +0200216 chn->flags &= ~CF_AUTO_CLOSE;
Willy Tarreau0a5d5dd2008-11-23 19:31:35 +0100217}
218
Willy Tarreau90deb182010-01-07 00:20:41 +0100219/* allow the producer to read / poll the input */
Willy Tarreau974ced62012-10-12 23:11:02 +0200220static inline void channel_auto_read(struct channel *chn)
Willy Tarreau90deb182010-01-07 00:20:41 +0100221{
Willy Tarreau974ced62012-10-12 23:11:02 +0200222 chn->flags &= ~CF_DONT_READ;
Willy Tarreau90deb182010-01-07 00:20:41 +0100223}
224
225/* prevent the producer from read / poll the input */
Willy Tarreau974ced62012-10-12 23:11:02 +0200226static inline void channel_dont_read(struct channel *chn)
Willy Tarreau90deb182010-01-07 00:20:41 +0100227{
Willy Tarreau974ced62012-10-12 23:11:02 +0200228 chn->flags |= CF_DONT_READ;
Willy Tarreau90deb182010-01-07 00:20:41 +0100229}
230
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200231
232/*************************************************/
233/* Buffer operations in the context of a channel */
234/*************************************************/
235
236
237/* Return the number of reserved bytes in the channel's visible
238 * buffer, which ensures that once all pending data are forwarded, the
239 * buffer still has global.tune.maxrewrite bytes free. The result is
240 * between 0 and global.tune.maxrewrite, which is itself smaller than
Willy Tarreau974ced62012-10-12 23:11:02 +0200241 * any chn->size.
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200242 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200243static inline int buffer_reserved(const struct channel *chn)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200244{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200245 int ret = global.tune.maxrewrite - chn->to_forward - chn->buf->o;
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200246
Willy Tarreau974ced62012-10-12 23:11:02 +0200247 if (chn->to_forward == CHN_INFINITE_FORWARD)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200248 return 0;
249 if (ret <= 0)
250 return 0;
251 return ret;
252}
253
254/* Return the max number of bytes the buffer can contain so that once all the
255 * pending bytes are forwarded, the buffer still has global.tune.maxrewrite
Willy Tarreau974ced62012-10-12 23:11:02 +0200256 * bytes free. The result sits between chn->size - maxrewrite and chn->size.
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200257 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200258static inline int buffer_max_len(const struct channel *chn)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200259{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200260 return chn->buf->size - buffer_reserved(chn);
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200261}
262
263/* Return the amount of bytes that can be written into the buffer at once,
264 * excluding reserved space, which is preserved.
265 */
266static inline int buffer_contig_space_res(const struct channel *chn)
267{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200268 return buffer_contig_space_with_res(chn->buf, buffer_reserved(chn));
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200269}
270
271/* Returns the amount of space available at the input of the buffer, taking the
272 * reserved space into account if ->to_forward indicates that an end of transfer
273 * is close to happen. The test is optimized to avoid as many operations as
274 * possible for the fast case.
275 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200276static inline int bi_avail(const struct channel *chn)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200277{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200278 int rem = chn->buf->size;
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200279 int rem2;
280
Willy Tarreau9b28e032012-10-12 23:49:43 +0200281 rem -= chn->buf->o;
282 rem -= chn->buf->i;
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200283 if (!rem)
284 return rem; /* buffer already full */
285
Willy Tarreau9b28e032012-10-12 23:49:43 +0200286 if (chn->to_forward >= chn->buf->size ||
287 (CHN_INFINITE_FORWARD < MAX_RANGE(typeof(chn->buf->size)) && // just there to ensure gcc
Willy Tarreau974ced62012-10-12 23:11:02 +0200288 chn->to_forward == CHN_INFINITE_FORWARD)) // avoids the useless second
289 return rem; // test whenever possible
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200290
291 rem2 = rem - global.tune.maxrewrite;
Willy Tarreau9b28e032012-10-12 23:49:43 +0200292 rem2 += chn->buf->o;
Willy Tarreau974ced62012-10-12 23:11:02 +0200293 rem2 += chn->to_forward;
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200294
295 if (rem > rem2)
296 rem = rem2;
297 if (rem > 0)
298 return rem;
299 return 0;
300}
301
302/* Cut the "tail" of the channel's buffer, which means strip it to the length
303 * of unsent data only, and kill any remaining unsent data. Any scheduled
304 * forwarding is stopped. This is mainly to be used to send error messages
305 * after existing data.
306 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200307static inline void bi_erase(struct channel *chn)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200308{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200309 if (!chn->buf->o)
Willy Tarreau974ced62012-10-12 23:11:02 +0200310 return channel_erase(chn);
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200311
Willy Tarreau974ced62012-10-12 23:11:02 +0200312 chn->to_forward = 0;
Willy Tarreau9b28e032012-10-12 23:49:43 +0200313 if (!chn->buf->i)
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200314 return;
315
Willy Tarreau9b28e032012-10-12 23:49:43 +0200316 chn->buf->i = 0;
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200317}
318
Willy Tarreaubaaee002006-06-26 02:48:02 +0200319/*
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200320 * Advance the channel buffer's read pointer by <len> bytes. This is useful
321 * when data have been read directly from the buffer. It is illegal to call
322 * this function with <len> causing a wrapping at the end of the buffer. It's
323 * the caller's responsibility to ensure that <len> is never larger than
Willy Tarreau974ced62012-10-12 23:11:02 +0200324 * chn->o. Channel flag WRITE_PARTIAL is set.
Willy Tarreau2b7addc2009-08-31 07:37:22 +0200325 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200326static inline void bo_skip(struct channel *chn, int len)
Willy Tarreau2b7addc2009-08-31 07:37:22 +0200327{
Willy Tarreau9b28e032012-10-12 23:49:43 +0200328 chn->buf->o -= len;
Willy Tarreau9dab5fc2012-05-07 11:56:55 +0200329
Willy Tarreau9b28e032012-10-12 23:49:43 +0200330 if (buffer_len(chn->buf) == 0)
331 chn->buf->p = chn->buf->data;
Willy Tarreau2b7addc2009-08-31 07:37:22 +0200332
Willy Tarreaufb0e9202009-09-23 23:47:55 +0200333 /* notify that some data was written to the SI from the buffer */
Willy Tarreau974ced62012-10-12 23:11:02 +0200334 chn->flags |= CF_WRITE_PARTIAL;
Willy Tarreau2b7addc2009-08-31 07:37:22 +0200335}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200336
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200337/* Tries to copy chunk <chunk> into the channel's buffer after length controls.
Willy Tarreau974ced62012-10-12 23:11:02 +0200338 * The chn->o and to_forward pointers are updated. If the channel's input is
Willy Tarreau74b08c92010-09-08 17:04:31 +0200339 * closed, -2 is returned. If the block is too large for this buffer, -3 is
340 * returned. If there is not enough room left in the buffer, -1 is returned.
341 * Otherwise the number of bytes copied is returned (0 being a valid number).
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200342 * Channel flag READ_PARTIAL is updated if some data can be transferred. The
Willy Tarreauf941cf22012-08-27 20:53:34 +0200343 * chunk's length is updated with the number of bytes sent.
Willy Tarreauaeac3192009-08-31 08:09:57 +0200344 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200345static inline int bi_putchk(struct channel *chn, struct chunk *chunk)
Willy Tarreauaeac3192009-08-31 08:09:57 +0200346{
347 int ret;
348
Willy Tarreau974ced62012-10-12 23:11:02 +0200349 ret = bi_putblk(chn, chunk->str, chunk->len);
Willy Tarreau74b08c92010-09-08 17:04:31 +0200350 if (ret > 0)
351 chunk->len -= ret;
Willy Tarreauaeac3192009-08-31 08:09:57 +0200352 return ret;
353}
354
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200355/* Tries to copy string <str> at once into the channel's buffer after length
Willy Tarreau974ced62012-10-12 23:11:02 +0200356 * controls. The chn->o and to_forward pointers are updated. If the channel's
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200357 * input is closed, -2 is returned. If the block is too large for this buffer,
358 * -3 is returned. If there is not enough room left in the buffer, -1 is
359 * returned. Otherwise the number of bytes copied is returned (0 being a valid
360 * number). Channel flag READ_PARTIAL is updated if some data can be
361 * transferred.
Willy Tarreau74b08c92010-09-08 17:04:31 +0200362 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200363static inline int bi_putstr(struct channel *chn, const char *str)
Willy Tarreau74b08c92010-09-08 17:04:31 +0200364{
Willy Tarreau974ced62012-10-12 23:11:02 +0200365 return bi_putblk(chn, str, strlen(str));
Willy Tarreau74b08c92010-09-08 17:04:31 +0200366}
367
368/*
Willy Tarreau8263d2b2012-08-28 00:06:31 +0200369 * Return one char from the channel's buffer. If the buffer is empty and the
370 * channel is closed, return -2. If the buffer is just empty, return -1. The
371 * buffer's pointer is not advanced, it's up to the caller to call bo_skip(buf,
372 * 1) when it has consumed the char. Also note that this function respects the
Willy Tarreau974ced62012-10-12 23:11:02 +0200373 * chn->o limit.
Willy Tarreau74b08c92010-09-08 17:04:31 +0200374 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200375static inline int bo_getchr(struct channel *chn)
Willy Tarreau74b08c92010-09-08 17:04:31 +0200376{
377 /* closed or empty + imminent close = -2; empty = -1 */
Willy Tarreau974ced62012-10-12 23:11:02 +0200378 if (unlikely((chn->flags & CF_SHUTW) || channel_is_empty(chn))) {
379 if (chn->flags & (CF_SHUTW|CF_SHUTW_NOW))
Willy Tarreau74b08c92010-09-08 17:04:31 +0200380 return -2;
381 return -1;
382 }
Willy Tarreau9b28e032012-10-12 23:49:43 +0200383 return *buffer_wrap_sub(chn->buf, chn->buf->p - chn->buf->o);
Willy Tarreau74b08c92010-09-08 17:04:31 +0200384}
385
Willy Tarreaubaaee002006-06-26 02:48:02 +0200386
Willy Tarreauc7e42382012-08-24 19:22:53 +0200387#endif /* _PROTO_CHANNEL_H */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200388
389/*
390 * Local variables:
391 * c-indent-level: 8
392 * c-basic-offset: 8
393 * End:
394 */