blob: 4f53920c418579de034ecc69289c411b195d2af0 [file] [log] [blame]
Willy Tarreau53a47662017-08-28 10:53:00 +02001/*
2 * Pass-through mux-demux for connections
3 *
4 * Copyright 2017 Willy Tarreau <w@1wt.eu>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
13#include <common/config.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010014#include <common/initcall.h>
Willy Tarreau53a47662017-08-28 10:53:00 +020015#include <proto/connection.h>
16#include <proto/stream.h>
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010017#include <proto/task.h>
18
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010019struct mux_pt_ctx {
20 struct conn_stream *cs;
21 struct connection *conn;
22 struct wait_event wait_event;
23};
24
Willy Tarreau8ceae722018-11-26 11:58:30 +010025DECLARE_STATIC_POOL(pool_head_pt_ctx, "mux_pt", sizeof(struct mux_pt_ctx));
26
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010027static void mux_pt_destroy(struct mux_pt_ctx *ctx)
28{
29 struct connection *conn = ctx->conn;
30
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010031 conn_stop_tracking(conn);
32 conn_full_close(conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +010033 tasklet_free(ctx->wait_event.task);
34 conn->mux = NULL;
Willy Tarreau3d2ee552018-12-19 14:12:10 +010035 conn->ctx = NULL;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010036 if (conn->destroy_cb)
37 conn->destroy_cb(conn);
38 /* We don't bother unsubscribing here, as we're about to destroy
39 * both the connection and the mux_pt_ctx
40 */
41 conn_free(conn);
42 pool_free(pool_head_pt_ctx, ctx);
43}
44
45/* Callback, used when we get I/Os while in idle mode */
46static struct task *mux_pt_io_cb(struct task *t, void *tctx, unsigned short status)
47{
48 struct mux_pt_ctx *ctx = tctx;
49
50 conn_sock_drain(ctx->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +010051 if (ctx->conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH))
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010052 mux_pt_destroy(ctx);
53 else
Willy Tarreau4f6516d2018-12-19 13:59:17 +010054 ctx->conn->xprt->subscribe(ctx->conn, SUB_RETRY_RECV,
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010055 &ctx->wait_event);
56
57 return NULL;
58}
Willy Tarreau53a47662017-08-28 10:53:00 +020059
Willy Tarreau3d2ee552018-12-19 14:12:10 +010060/* Initialize the mux once it's attached. It is expected that conn->ctx
Olivier Houchard9aaf7782017-09-13 18:30:23 +020061 * points to the existing conn_stream (for outgoing connections) or NULL (for
62 * incoming ones, in which case one will be allocated and a new stream will be
63 * instanciated). Returns < 0 on error.
Willy Tarreau53a47662017-08-28 10:53:00 +020064 */
Olivier Houchardf502aca2018-12-14 19:42:40 +010065static int mux_pt_init(struct connection *conn, struct proxy *prx, struct session *sess)
Willy Tarreau53a47662017-08-28 10:53:00 +020066{
Willy Tarreau3d2ee552018-12-19 14:12:10 +010067 struct conn_stream *cs = conn->ctx;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010068 struct mux_pt_ctx *ctx = pool_alloc(pool_head_pt_ctx);
69
70 if (!ctx)
71 goto fail;
72
73 ctx->wait_event.task = tasklet_new();
74 if (!ctx->wait_event.task)
75 goto fail_free_ctx;
76 ctx->wait_event.task->context = ctx;
77 ctx->wait_event.task->process = mux_pt_io_cb;
Willy Tarreau4f6516d2018-12-19 13:59:17 +010078 ctx->wait_event.events = 0;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010079 ctx->conn = conn;
Olivier Houchard9aaf7782017-09-13 18:30:23 +020080
81 if (!cs) {
82 cs = cs_new(conn);
83 if (!cs)
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010084 goto fail_free_ctx;
Olivier Houchard9aaf7782017-09-13 18:30:23 +020085
86 if (stream_create_from_cs(cs) < 0)
87 goto fail_free;
88
Olivier Houchard9aaf7782017-09-13 18:30:23 +020089 }
Willy Tarreau3d2ee552018-12-19 14:12:10 +010090 conn->ctx = ctx;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010091 ctx->cs = cs;
Olivier Houchard8706c812018-12-04 19:17:25 +010092 cs->flags |= CS_FL_RCV_MORE;
Willy Tarreau53a47662017-08-28 10:53:00 +020093 return 0;
Olivier Houchard9aaf7782017-09-13 18:30:23 +020094
95 fail_free:
96 cs_free(cs);
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010097fail_free_ctx:
98 if (ctx->wait_event.task)
99 tasklet_free(ctx->wait_event.task);
100 pool_free(pool_head_pt_ctx, ctx);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200101 fail:
102 return -1;
Willy Tarreau53a47662017-08-28 10:53:00 +0200103}
104
105/* callback to be used by default for the pass-through mux. It calls the data
106 * layer wake() callback if it is set otherwise returns 0.
107 */
108static int mux_pt_wake(struct connection *conn)
109{
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100110 struct mux_pt_ctx *ctx = conn->ctx;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100111 struct conn_stream *cs = ctx->cs;
112 int ret = 0;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200113
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100114 if (cs) {
115 ret = cs->data_cb->wake ? cs->data_cb->wake(cs) : 0;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200116
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100117 if (ret < 0)
118 return ret;
119 } else {
120 conn_sock_drain(conn);
121 if (conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH)) {
122 mux_pt_destroy(ctx);
123 return -1;
124 }
125 }
Willy Tarreauad7f0ad2018-08-24 15:48:59 +0200126
Olivier Houchard7fc96d52017-11-23 18:25:47 +0100127 /* If we had early data, and we're done with the handshake
128 * then whe know the data are safe, and we can remove the flag.
129 */
130 if ((conn->flags & (CO_FL_EARLY_DATA | CO_FL_EARLY_SSL_HS | CO_FL_HANDSHAKE)) ==
131 CO_FL_EARLY_DATA)
132 conn->flags &= ~CO_FL_EARLY_DATA;
Willy Tarreaued339a32017-11-03 15:55:24 +0100133 return ret;
Willy Tarreau53a47662017-08-28 10:53:00 +0200134}
135
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200136/*
137 * Attach a new stream to a connection
138 * (Used for outgoing connections)
139 */
Olivier Houchardf502aca2018-12-14 19:42:40 +0100140static struct conn_stream *mux_pt_attach(struct connection *conn, struct session *sess)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200141{
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100142 struct conn_stream *cs;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100143 struct mux_pt_ctx *ctx = conn->ctx;
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100144
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100145 conn->xprt->unsubscribe(conn, SUB_RETRY_RECV, &ctx->wait_event);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100146 cs = cs_new(conn);
147 if (!cs)
148 goto fail;
149
150 ctx->cs = cs;
Olivier Houchard8706c812018-12-04 19:17:25 +0100151 cs->flags |= CS_FL_RCV_MORE;
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100152 return (cs);
153fail:
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200154 return NULL;
155}
156
Willy Tarreaufafd3982018-11-18 21:29:20 +0100157/* Retrieves a valid conn_stream from this connection, or returns NULL. For
158 * this mux, it's easy as we can only store a single conn_stream.
159 */
160static const struct conn_stream *mux_pt_get_first_cs(const struct connection *conn)
161{
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100162 struct mux_pt_ctx *ctx = conn->ctx;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100163 struct conn_stream *cs = ctx->cs;
Willy Tarreaufafd3982018-11-18 21:29:20 +0100164
165 return cs;
166}
167
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100168/* Destroy the mux and the associated connection, if no longer used */
Olivier Houchard060ed432018-11-06 16:32:42 +0100169static void mux_pt_destroy_meth(struct connection *conn)
170{
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100171 struct mux_pt_ctx *ctx = conn->ctx;
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100172
173 if (!(ctx->cs))
174 mux_pt_destroy(ctx);
Olivier Houchard060ed432018-11-06 16:32:42 +0100175}
176
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200177/*
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200178 * Detach the stream from the connection and possibly release the connection.
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200179 */
180static void mux_pt_detach(struct conn_stream *cs)
181{
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200182 struct connection *conn = cs->conn;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100183 struct mux_pt_ctx *ctx = cs->conn->ctx;
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200184
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100185 /* Subscribe, to know if we got disconnected */
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100186 if (conn->owner != NULL &&
187 !(conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH))) {
188 ctx->cs = NULL;
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100189 conn->xprt->subscribe(conn, SUB_RETRY_RECV, &ctx->wait_event);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100190 } else
191 /* There's no session attached to that connection, destroy it */
192 mux_pt_destroy(ctx);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200193}
194
Willy Tarreau00f18a32019-01-26 12:19:01 +0100195/* returns the number of streams in use on a connection */
196static int mux_pt_used_streams(struct connection *conn)
Olivier Houchardd540b362018-11-05 18:37:53 +0100197{
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100198 struct mux_pt_ctx *ctx = conn->ctx;
Olivier Houchardd540b362018-11-05 18:37:53 +0100199
Willy Tarreau00f18a32019-01-26 12:19:01 +0100200 return ctx->cs ? 1 : 0;
Olivier Houchardd540b362018-11-05 18:37:53 +0100201}
202
Willy Tarreau00f18a32019-01-26 12:19:01 +0100203/* returns the number of streams still available on a connection */
204static int mux_pt_avail_streams(struct connection *conn)
Olivier Houchard8defe4b2018-12-02 01:31:17 +0100205{
Willy Tarreau00f18a32019-01-26 12:19:01 +0100206 return 1 - mux_pt_used_streams(conn);
Olivier Houchard8defe4b2018-12-02 01:31:17 +0100207}
208
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200209static void mux_pt_shutr(struct conn_stream *cs, enum cs_shr_mode mode)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200210{
Willy Tarreau4b795242017-10-05 18:47:38 +0200211 if (cs->flags & CS_FL_SHR)
212 return;
Christopher Fauletd94f8772018-12-17 13:21:02 +0100213 cs->flags &= ~(CS_FL_RCV_MORE | CS_FL_WANT_ROOM);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200214 if (conn_xprt_ready(cs->conn) && cs->conn->xprt->shutr)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200215 cs->conn->xprt->shutr(cs->conn, (mode == CS_SHR_DRAIN));
Willy Tarreau4b795242017-10-05 18:47:38 +0200216 if (cs->flags & CS_FL_SHW)
217 conn_full_close(cs->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100218 /* Maybe we've been put in the list of available idle connections,
219 * get ouf of here
220 */
221 LIST_DEL(&cs->conn->list);
222 LIST_INIT(&cs->conn->list);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200223}
224
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200225static void mux_pt_shutw(struct conn_stream *cs, enum cs_shw_mode mode)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200226{
Willy Tarreau4b795242017-10-05 18:47:38 +0200227 if (cs->flags & CS_FL_SHW)
228 return;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200229 if (conn_xprt_ready(cs->conn) && cs->conn->xprt->shutw)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200230 cs->conn->xprt->shutw(cs->conn, (mode == CS_SHW_NORMAL));
Willy Tarreau4b795242017-10-05 18:47:38 +0200231 if (!(cs->flags & CS_FL_SHR))
Willy Tarreaua48c1412017-12-22 18:46:33 +0100232 conn_sock_shutw(cs->conn, (mode == CS_SHW_NORMAL));
Willy Tarreau4b795242017-10-05 18:47:38 +0200233 else
234 conn_full_close(cs->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100235 /* Maybe we've been put in the list of available idle connections,
236 * get ouf of here
237 */
238 LIST_DEL(&cs->conn->list);
239 LIST_INIT(&cs->conn->list);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200240}
241
242/*
243 * Called from the upper layer, to get more data
244 */
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200245static size_t mux_pt_rcv_buf(struct conn_stream *cs, struct buffer *buf, size_t count, int flags)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200246{
Willy Tarreaud9cf5402018-07-18 11:29:06 +0200247 size_t ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200248
Christopher Faulet4eb7d742018-10-11 15:29:21 +0200249 if (!count) {
Christopher Fauletd94f8772018-12-17 13:21:02 +0100250 cs->flags |= (CS_FL_RCV_MORE | CS_FL_WANT_ROOM);
Christopher Faulet4eb7d742018-10-11 15:29:21 +0200251 return 0;
252 }
Willy Tarreaue0f24ee2018-12-14 10:51:23 +0100253 b_realign_if_empty(buf);
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200254 ret = cs->conn->xprt->rcv_buf(cs->conn, buf, count, flags);
Olivier Houchard8706c812018-12-04 19:17:25 +0100255 if (conn_xprt_read0_pending(cs->conn)) {
256 if (ret == 0)
Christopher Fauletd94f8772018-12-17 13:21:02 +0100257 cs->flags &= ~(CS_FL_RCV_MORE | CS_FL_WANT_ROOM);
Christopher Faulet87a8f352019-03-22 14:51:36 +0100258 cs->flags |= CS_FL_EOS;
Olivier Houchard8706c812018-12-04 19:17:25 +0100259 }
260 if (cs->conn->flags & CO_FL_ERROR) {
261 if (ret == 0)
Christopher Fauletd94f8772018-12-17 13:21:02 +0100262 cs->flags &= ~(CS_FL_RCV_MORE | CS_FL_WANT_ROOM);
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200263 cs->flags |= CS_FL_ERROR;
Olivier Houchard8706c812018-12-04 19:17:25 +0100264 }
Willy Tarreaud9cf5402018-07-18 11:29:06 +0200265 return ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200266}
267
268/* Called from the upper layer, to send data */
Christopher Fauletd44a9b32018-07-27 11:59:41 +0200269static size_t mux_pt_snd_buf(struct conn_stream *cs, struct buffer *buf, size_t count, int flags)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200270{
Olivier Houchardb72d98a2018-11-30 13:17:48 +0100271 size_t ret;
272
273 if (cs->conn->flags & CO_FL_HANDSHAKE)
274 return 0;
275 ret = cs->conn->xprt->snd_buf(cs->conn, buf, count, flags);
Christopher Fauletd44a9b32018-07-27 11:59:41 +0200276
277 if (ret > 0)
278 b_del(buf, ret);
279 return ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200280}
281
Olivier Houchard6ff20392018-07-17 18:46:31 +0200282/* Called from the upper layer, to subscribe to events */
283static int mux_pt_subscribe(struct conn_stream *cs, int event_type, void *param)
284{
285 return (cs->conn->xprt->subscribe(cs->conn, event_type, param));
286}
287
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200288static int mux_pt_unsubscribe(struct conn_stream *cs, int event_type, void *param)
289{
290 return (cs->conn->xprt->unsubscribe(cs->conn, event_type, param));
291}
292
Olivier Houchard7da120b2017-11-01 13:55:10 +0100293#if defined(CONFIG_HAP_LINUX_SPLICE)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200294/* Send and get, using splicing */
295static int mux_pt_rcv_pipe(struct conn_stream *cs, struct pipe *pipe, unsigned int count)
296{
297 int ret;
298
299 ret = cs->conn->xprt->rcv_pipe(cs->conn, pipe, count);
300 if (conn_xprt_read0_pending(cs->conn))
Christopher Faulet87a8f352019-03-22 14:51:36 +0100301 cs->flags |= CS_FL_EOS;
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200302 if (cs->conn->flags & CO_FL_ERROR)
303 cs->flags |= CS_FL_ERROR;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200304 return (ret);
305}
306
307static int mux_pt_snd_pipe(struct conn_stream *cs, struct pipe *pipe)
308{
309 return (cs->conn->xprt->snd_pipe(cs->conn, pipe));
310}
Olivier Houchard7da120b2017-11-01 13:55:10 +0100311#endif
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200312
Willy Tarreau53a47662017-08-28 10:53:00 +0200313/* The mux operations */
314const struct mux_ops mux_pt_ops = {
315 .init = mux_pt_init,
Willy Tarreau53a47662017-08-28 10:53:00 +0200316 .wake = mux_pt_wake,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200317 .rcv_buf = mux_pt_rcv_buf,
318 .snd_buf = mux_pt_snd_buf,
Olivier Houchard6ff20392018-07-17 18:46:31 +0200319 .subscribe = mux_pt_subscribe,
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200320 .unsubscribe = mux_pt_unsubscribe,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200321#if defined(CONFIG_HAP_LINUX_SPLICE)
322 .rcv_pipe = mux_pt_rcv_pipe,
323 .snd_pipe = mux_pt_snd_pipe,
324#endif
325 .attach = mux_pt_attach,
Willy Tarreaufafd3982018-11-18 21:29:20 +0100326 .get_first_cs = mux_pt_get_first_cs,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200327 .detach = mux_pt_detach,
Olivier Houchardd540b362018-11-05 18:37:53 +0100328 .avail_streams = mux_pt_avail_streams,
Willy Tarreau00f18a32019-01-26 12:19:01 +0100329 .used_streams = mux_pt_used_streams,
Olivier Houchard060ed432018-11-06 16:32:42 +0100330 .destroy = mux_pt_destroy_meth,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200331 .shutr = mux_pt_shutr,
332 .shutw = mux_pt_shutw,
Willy Tarreau28f1cb92017-12-20 16:14:44 +0100333 .flags = MX_FL_NONE,
Willy Tarreau53a47662017-08-28 10:53:00 +0200334 .name = "PASS",
335};
Willy Tarreauf6490822017-09-21 19:43:21 +0200336
Christopher Faulet32f61c02018-04-10 14:33:41 +0200337/* PROT selection : default mux has empty name */
338static struct mux_proto_list mux_proto_pt =
339 { .token = IST(""), .mode = PROTO_MODE_ANY, .side = PROTO_SIDE_BOTH, .mux = &mux_pt_ops };
Willy Tarreauf6490822017-09-21 19:43:21 +0200340
Willy Tarreau0108d902018-11-25 19:14:37 +0100341INITCALL1(STG_REGISTER, register_mux_proto, &mux_proto_pt);