blob: 890bfb8ec613db21e4a3b92f3e00f940e118a50c [file] [log] [blame]
Willy Tarreaucff64112008-11-03 06:26:53 +01001/*
Willy Tarreau8e89b842009-10-18 23:56:35 +02002 * include/proto/stream_interface.h
3 * This file contains stream_interface function prototypes
4 *
Willy Tarreau2bb4a962014-11-28 11:11:05 +01005 * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu
Willy Tarreau8e89b842009-10-18 23:56:35 +02006 *
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 Tarreaucff64112008-11-03 06:26:53 +010021
22#ifndef _PROTO_STREAM_INTERFACE_H
23#define _PROTO_STREAM_INTERFACE_H
24
25#include <stdlib.h>
26
27#include <common/config.h>
Willy Tarreau323a2d92015-08-04 19:00:17 +020028#include <types/server.h>
Willy Tarreau87b09662015-04-03 00:22:06 +020029#include <types/stream.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010030#include <types/stream_interface.h>
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020031#include <proto/applet.h>
Willy Tarreau14f8e862012-08-30 22:23:13 +020032#include <proto/channel.h>
Willy Tarreauf9dabec2012-08-17 17:33:53 +020033#include <proto/connection.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010034
35
36/* main event functions used to move data between sockets and buffers */
Willy Tarreau269358d2009-09-20 20:14:49 +020037int stream_int_check_timeouts(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010038void stream_int_report_error(struct stream_interface *si);
Willy Tarreaudded32d2008-11-30 19:48:07 +010039void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg);
Willy Tarreau2c6be842012-07-06 17:12:34 +020040int conn_si_send_proxy(struct connection *conn, unsigned int flag);
Willy Tarreau9bf9c142012-08-20 15:38:41 +020041void stream_sock_read0(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010042
Willy Tarreauc5788912012-08-24 18:12:41 +020043extern struct si_ops si_embedded_ops;
Willy Tarreauc5788912012-08-24 18:12:41 +020044extern struct si_ops si_conn_ops;
Willy Tarreaud45b9f82015-04-13 16:30:14 +020045extern struct si_ops si_applet_ops;
Willy Tarreau74beec32012-10-03 00:41:04 +020046extern struct data_cb si_conn_cb;
Willy Tarreau27375622013-12-17 00:00:28 +010047extern struct data_cb si_idle_conn_cb;
Willy Tarreau5c979a92012-05-07 17:15:39 +020048
Willy Tarreau30576452015-04-13 13:50:30 +020049struct appctx *stream_int_register_handler(struct stream_interface *si, struct applet *app);
Willy Tarreaue5f86492015-04-19 15:16:35 +020050void si_applet_done(struct stream_interface *si);
Willy Tarreau25f13102015-09-24 11:32:22 +020051void stream_int_update(struct stream_interface *si);
Willy Tarreaufb90d942009-09-05 20:57:35 +020052
Willy Tarreau2bb4a962014-11-28 11:11:05 +010053/* returns the channel which receives data from this stream interface (input channel) */
54static inline struct channel *si_ic(struct stream_interface *si)
55{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010056 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020057 return &LIST_ELEM(si, struct stream *, si[1])->res;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010058 else
Willy Tarreau87b09662015-04-03 00:22:06 +020059 return &LIST_ELEM(si, struct stream *, si[0])->req;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010060}
61
62/* returns the channel which feeds data to this stream interface (output channel) */
63static inline struct channel *si_oc(struct stream_interface *si)
64{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010065 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020066 return &LIST_ELEM(si, struct stream *, si[1])->req;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010067 else
Willy Tarreau87b09662015-04-03 00:22:06 +020068 return &LIST_ELEM(si, struct stream *, si[0])->res;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010069}
70
Willy Tarreau4e4292b2014-11-28 12:18:45 +010071/* returns the buffer which receives data from this stream interface (input channel's buffer) */
72static inline struct buffer *si_ib(struct stream_interface *si)
73{
74 return si_ic(si)->buf;
75}
76
77/* returns the buffer which feeds data to this stream interface (output channel's buffer) */
78static inline struct buffer *si_ob(struct stream_interface *si)
79{
80 return si_oc(si)->buf;
81}
82
Willy Tarreau87b09662015-04-03 00:22:06 +020083/* returns the stream associated to a stream interface */
84static inline struct stream *si_strm(struct stream_interface *si)
Willy Tarreauaefd7902014-11-28 12:03:32 +010085{
86 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020087 return LIST_ELEM(si, struct stream *, si[1]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010088 else
Willy Tarreau87b09662015-04-03 00:22:06 +020089 return LIST_ELEM(si, struct stream *, si[0]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010090}
91
Willy Tarreau07373b82014-11-28 12:08:47 +010092/* returns the task associated to this stream interface */
93static inline struct task *si_task(struct stream_interface *si)
94{
95 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020096 return LIST_ELEM(si, struct stream *, si[1])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +010097 else
Willy Tarreau87b09662015-04-03 00:22:06 +020098 return LIST_ELEM(si, struct stream *, si[0])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +010099}
100
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100101/* returns the stream interface on the other side. Used during forwarding. */
102static inline struct stream_interface *si_opposite(struct stream_interface *si)
103{
104 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +0200105 return &LIST_ELEM(si, struct stream *, si[1])->si[0];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100106 else
Willy Tarreau87b09662015-04-03 00:22:06 +0200107 return &LIST_ELEM(si, struct stream *, si[0])->si[1];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100108}
109
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200110/* initializes a stream interface in the SI_ST_INI state. It's detached from
Willy Tarreau819d3322014-11-28 12:12:34 +0100111 * any endpoint and only keeps its side which is expected to have already been
112 * set.
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200113 */
Willy Tarreau819d3322014-11-28 12:12:34 +0100114static inline void si_reset(struct stream_interface *si)
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200115{
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200116 si->err_type = SI_ET_NONE;
117 si->conn_retries = 0; /* used for logging too */
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200118 si->exp = TICK_ETERNITY;
Willy Tarreaua5f5d8d2014-11-28 11:26:07 +0100119 si->flags &= SI_FL_ISBACK;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200120 si->end = NULL;
121 si->state = si->prev_state = SI_ST_INI;
Willy Tarreau7365dad2015-04-20 01:03:17 +0200122 si->ops = &si_embedded_ops;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200123}
124
125/* sets the current and previous state of a stream interface to <state>. This
126 * is mainly used to create one in the established state on incoming
127 * conncetions.
128 */
129static inline void si_set_state(struct stream_interface *si, int state)
130{
131 si->state = si->prev_state = state;
132}
133
Willy Tarreau41b09f42015-08-04 20:44:05 +0200134/* only detaches the endpoint from the SI, which means that it's set to
135 * NULL and that ->ops is mapped to si_embedded_ops. The previous endpoint
136 * is returned.
137 */
138static inline enum obj_type *si_detach_endpoint(struct stream_interface *si)
139{
140 enum obj_type *prev = si->end;
141
142 si->end = NULL;
143 si->ops = &si_embedded_ops;
144 return prev;
145}
146
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100147/* Release the endpoint if it's a connection or an applet, then nullify it.
148 * Note: released connections are closed then freed.
149 */
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200150static inline void si_release_endpoint(struct stream_interface *si)
Willy Tarreau372d6702013-09-29 17:19:56 +0200151{
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200152 struct connection *conn;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100153 struct appctx *appctx;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200154
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100155 if (!si->end)
156 return;
157
158 if ((conn = objt_conn(si->end))) {
Willy Tarreau323a2d92015-08-04 19:00:17 +0200159 LIST_DEL(&conn->list);
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100160 conn_force_close(conn);
161 conn_free(conn);
162 }
163 else if ((appctx = objt_appctx(si->end))) {
164 if (appctx->applet->release)
Willy Tarreau00a37f02015-04-13 12:05:19 +0200165 appctx->applet->release(appctx);
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100166 appctx_free(appctx); /* we share the connection pool */
167 }
Willy Tarreau41b09f42015-08-04 20:44:05 +0200168 si_detach_endpoint(si);
Willy Tarreau372d6702013-09-29 17:19:56 +0200169}
170
Willy Tarreau4320eaa2015-08-05 11:08:30 +0200171/* Turn an existing connection endpoint of stream interface <si> to idle mode,
172 * which means that the connection will be polled for incoming events and might
173 * be killed by the underlying I/O handler. If <pool> is not null, the
174 * connection will also be added at the head of this list. This connection
175 * remains assigned to the stream interface it is currently attached to.
Willy Tarreau27375622013-12-17 00:00:28 +0100176 */
Willy Tarreau323a2d92015-08-04 19:00:17 +0200177static inline void si_idle_conn(struct stream_interface *si, struct list *pool)
Willy Tarreau27375622013-12-17 00:00:28 +0100178{
Willy Tarreau4320eaa2015-08-05 11:08:30 +0200179 struct connection *conn = __objt_conn(si->end);
Willy Tarreau27375622013-12-17 00:00:28 +0100180
Willy Tarreau323a2d92015-08-04 19:00:17 +0200181 if (pool)
182 LIST_ADD(pool, &conn->list);
183
Willy Tarreau27375622013-12-17 00:00:28 +0100184 conn_attach(conn, si, &si_idle_conn_cb);
185 conn_data_want_recv(conn);
186}
187
Willy Tarreau2a6e8802013-10-24 15:50:53 +0200188/* Attach connection <conn> to the stream interface <si>. The stream interface
189 * is configured to work with a connection and the connection it configured
190 * with a stream interface data layer.
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200191 */
Willy Tarreau2a6e8802013-10-24 15:50:53 +0200192static inline void si_attach_conn(struct stream_interface *si, struct connection *conn)
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200193{
194 si->ops = &si_conn_ops;
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200195 si->end = &conn->obj_type;
Willy Tarreau7abddb52013-10-24 15:31:04 +0200196 conn_attach(conn, si, &si_conn_cb);
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200197}
198
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100199/* Returns true if a connection is attached to the stream interface <si> and
200 * if this connection is ready.
201 */
202static inline int si_conn_ready(struct stream_interface *si)
203{
204 struct connection *conn = objt_conn(si->end);
205
206 return conn && conn_ctrl_ready(conn) && conn_xprt_ready(conn);
207}
208
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100209/* Attach appctx <appctx> to the stream interface <si>. The stream interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200210 * is configured to work with an applet context.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100211 */
212static inline void si_attach_appctx(struct stream_interface *si, struct appctx *appctx)
Willy Tarreauc5788912012-08-24 18:12:41 +0200213{
Willy Tarreaud45b9f82015-04-13 16:30:14 +0200214 si->ops = &si_applet_ops;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100215 si->end = &appctx->obj_type;
Willy Tarreau19c81612015-04-13 11:48:16 +0200216 appctx->owner = si;
Willy Tarreauc5788912012-08-24 18:12:41 +0200217}
218
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100219/* returns a pointer to the appctx being run in the SI or NULL if none */
220static inline struct appctx *si_appctx(struct stream_interface *si)
221{
222 return objt_appctx(si->end);
223}
224
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200225/* call the applet's release function if any. Needs to be called upon close() */
226static inline void si_applet_release(struct stream_interface *si)
227{
Willy Tarreau00a37f02015-04-13 12:05:19 +0200228 struct appctx *appctx;
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200229
Willy Tarreau00a37f02015-04-13 12:05:19 +0200230 appctx = si_appctx(si);
231 if (appctx && appctx->applet->release)
232 appctx->applet->release(appctx);
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200233}
234
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200235/* let an applet indicate that it wants to put some data into the input buffer */
236static inline void si_applet_want_put(struct stream_interface *si)
237{
238 si->flags |= SI_FL_WANT_PUT;
239}
240
241/* let an applet indicate that it wanted to put some data into the input buffer
242 * but it couldn't.
243 */
244static inline void si_applet_cant_put(struct stream_interface *si)
245{
246 si->flags |= SI_FL_WANT_PUT | SI_FL_WAIT_ROOM;
247}
248
249/* let an applet indicate that it doesn't want to put data into the input buffer */
250static inline void si_applet_stop_put(struct stream_interface *si)
251{
252 si->flags &= ~SI_FL_WANT_PUT;
253}
254
255/* let an applet indicate that it wants to get some data from the output buffer */
256static inline void si_applet_want_get(struct stream_interface *si)
257{
258 si->flags |= SI_FL_WANT_GET;
259}
260
261/* let an applet indicate that it wanted to get some data from the output buffer
262 * but it couldn't.
263 */
264static inline void si_applet_cant_get(struct stream_interface *si)
265{
266 si->flags |= SI_FL_WANT_GET | SI_FL_WAIT_DATA;
267}
268
269/* let an applet indicate that it doesn't want to get data from the input buffer */
270static inline void si_applet_stop_get(struct stream_interface *si)
271{
272 si->flags &= ~SI_FL_WANT_GET;
273}
274
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100275/* Try to allocate a new connection and assign it to the interface. If
Willy Tarreau973a5422015-08-05 21:47:23 +0200276 * an endpoint was previously allocated, it is released first. The newly
277 * allocated connection is initialized, assigned to the stream interface,
278 * and returned.
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100279 */
Willy Tarreau973a5422015-08-05 21:47:23 +0200280static inline struct connection *si_alloc_conn(struct stream_interface *si)
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200281{
282 struct connection *conn;
283
Willy Tarreau973a5422015-08-05 21:47:23 +0200284 si_release_endpoint(si);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200285
286 conn = conn_new();
287 if (conn)
288 si_attach_conn(si, conn);
289
290 return conn;
291}
292
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100293/* Release the interface's existing endpoint (connection or appctx) and
294 * allocate then initialize a new appctx which is assigned to the interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200295 * and returned. NULL may be returned upon memory shortage. Applet <applet>
296 * is assigned to the appctx, but it may be NULL.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100297 */
Willy Tarreau30576452015-04-13 13:50:30 +0200298static inline struct appctx *si_alloc_appctx(struct stream_interface *si, struct applet *applet)
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100299{
300 struct appctx *appctx;
301
302 si_release_endpoint(si);
Willy Tarreaua7513f52015-04-05 00:15:26 +0200303 appctx = appctx_new(applet);
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100304 if (appctx)
305 si_attach_appctx(si, appctx);
306
307 return appctx;
308}
309
Willy Tarreau73b013b2012-05-21 16:31:45 +0200310/* Sends a shutr to the connection using the data layer */
311static inline void si_shutr(struct stream_interface *si)
312{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200313 si->ops->shutr(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200314}
315
316/* Sends a shutw to the connection using the data layer */
317static inline void si_shutw(struct stream_interface *si)
318{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200319 si->ops->shutw(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200320}
321
322/* Calls the data state update on the stream interfaace */
323static inline void si_update(struct stream_interface *si)
324{
Willy Tarreauc5788912012-08-24 18:12:41 +0200325 si->ops->update(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200326}
327
328/* Calls chk_rcv on the connection using the data layer */
329static inline void si_chk_rcv(struct stream_interface *si)
330{
Willy Tarreauc5788912012-08-24 18:12:41 +0200331 si->ops->chk_rcv(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200332}
333
334/* Calls chk_snd on the connection using the data layer */
335static inline void si_chk_snd(struct stream_interface *si)
336{
Willy Tarreauc5788912012-08-24 18:12:41 +0200337 si->ops->chk_snd(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200338}
339
340/* Calls chk_snd on the connection using the ctrl layer */
341static inline int si_connect(struct stream_interface *si)
342{
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200343 struct connection *conn = objt_conn(si->end);
Willy Tarreaue7dff022015-04-03 01:14:29 +0200344 int ret = SF_ERR_NONE;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200345
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200346 if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect))
Willy Tarreaue7dff022015-04-03 01:14:29 +0200347 return SF_ERR_INTERNAL;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200348
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100349 if (!conn_ctrl_ready(conn) || !conn_xprt_ready(conn)) {
Willy Tarreau2bb4a962014-11-28 11:11:05 +0100350 ret = conn->ctrl->connect(conn, !channel_is_empty(si_oc(si)), 0);
Willy Tarreaue7dff022015-04-03 01:14:29 +0200351 if (ret != SF_ERR_NONE)
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100352 return ret;
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100353
354 /* we need to be notified about connection establishment */
355 conn->flags |= CO_FL_WAKE_DATA;
356
357 /* we're in the process of establishing a connection */
358 si->state = SI_ST_CON;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100359 }
Willy Tarreau2bb4a962014-11-28 11:11:05 +0100360 else if (!channel_is_empty(si_oc(si))) {
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100361 /* reuse the existing connection, we'll have to send a
362 * request there.
363 */
364 conn_data_want_send(conn);
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100365
366 /* the connection is established */
367 si->state = SI_ST_EST;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100368 }
Willy Tarreau14f8e862012-08-30 22:23:13 +0200369
370 /* needs src ip/port for logging */
371 if (si->flags & SI_FL_SRC_ADDR)
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200372 conn_get_from_addr(conn);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200373
Willy Tarreau14f8e862012-08-30 22:23:13 +0200374 return ret;
Willy Tarreau73b013b2012-05-21 16:31:45 +0200375}
Willy Tarreau59b94792012-05-11 16:16:40 +0200376
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100377/* for debugging, reports the stream interface state name */
378static inline const char *si_state_str(int state)
379{
380 switch (state) {
381 case SI_ST_INI: return "INI";
382 case SI_ST_REQ: return "REQ";
383 case SI_ST_QUE: return "QUE";
384 case SI_ST_TAR: return "TAR";
385 case SI_ST_ASS: return "ASS";
386 case SI_ST_CON: return "CON";
387 case SI_ST_CER: return "CER";
388 case SI_ST_EST: return "EST";
389 case SI_ST_DIS: return "DIS";
390 case SI_ST_CLO: return "CLO";
391 default: return "???";
392 }
393}
394
Willy Tarreaucff64112008-11-03 06:26:53 +0100395#endif /* _PROTO_STREAM_INTERFACE_H */
396
397/*
398 * Local variables:
399 * c-indent-level: 8
400 * c-basic-offset: 8
401 * End:
402 */