blob: 9dec132163b1df539505db47c77aad2429f3901d [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
31 LIST_DEL(&conn->list);
32 conn_stop_tracking(conn);
33 conn_full_close(conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +010034 tasklet_free(ctx->wait_event.task);
35 conn->mux = NULL;
36 conn->mux_ctx = NULL;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010037 if (conn->destroy_cb)
38 conn->destroy_cb(conn);
39 /* We don't bother unsubscribing here, as we're about to destroy
40 * both the connection and the mux_pt_ctx
41 */
42 conn_free(conn);
43 pool_free(pool_head_pt_ctx, ctx);
44}
45
46/* Callback, used when we get I/Os while in idle mode */
47static struct task *mux_pt_io_cb(struct task *t, void *tctx, unsigned short status)
48{
49 struct mux_pt_ctx *ctx = tctx;
50
51 conn_sock_drain(ctx->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +010052 if (ctx->conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH))
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010053 mux_pt_destroy(ctx);
54 else
55 ctx->conn->xprt->subscribe(ctx->conn, SUB_CAN_RECV,
56 &ctx->wait_event);
57
58 return NULL;
59}
Willy Tarreau53a47662017-08-28 10:53:00 +020060
Olivier Houchard9aaf7782017-09-13 18:30:23 +020061/* Initialize the mux once it's attached. It is expected that conn->mux_ctx
62 * points to the existing conn_stream (for outgoing connections) or NULL (for
63 * incoming ones, in which case one will be allocated and a new stream will be
64 * instanciated). Returns < 0 on error.
Willy Tarreau53a47662017-08-28 10:53:00 +020065 */
Willy Tarreau175a2bb2018-09-12 12:02:05 +020066static int mux_pt_init(struct connection *conn, struct proxy *prx)
Willy Tarreau53a47662017-08-28 10:53:00 +020067{
Olivier Houchard9aaf7782017-09-13 18:30:23 +020068 struct conn_stream *cs = conn->mux_ctx;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010069 struct mux_pt_ctx *ctx = pool_alloc(pool_head_pt_ctx);
70
71 if (!ctx)
72 goto fail;
73
74 ctx->wait_event.task = tasklet_new();
75 if (!ctx->wait_event.task)
76 goto fail_free_ctx;
77 ctx->wait_event.task->context = ctx;
78 ctx->wait_event.task->process = mux_pt_io_cb;
79 ctx->wait_event.wait_reason = 0;
80 ctx->conn = conn;
Olivier Houchard9aaf7782017-09-13 18:30:23 +020081
82 if (!cs) {
83 cs = cs_new(conn);
84 if (!cs)
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010085 goto fail_free_ctx;
Olivier Houchard9aaf7782017-09-13 18:30:23 +020086
87 if (stream_create_from_cs(cs) < 0)
88 goto fail_free;
89
Olivier Houchard9aaf7782017-09-13 18:30:23 +020090 }
Olivier Houchardb6c32ee2018-11-05 18:28:43 +010091 conn->mux_ctx = ctx;
92 ctx->cs = cs;
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{
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100110 struct mux_pt_ctx *ctx = conn->mux_ctx;
111 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 */
140static struct conn_stream *mux_pt_attach(struct connection *conn)
141{
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100142 struct conn_stream *cs;
143 struct mux_pt_ctx *ctx = conn->mux_ctx;
144
Olivier Houchard1ced4852018-11-29 13:49:59 +0100145 conn->xprt->unsubscribe(conn, SUB_CAN_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;
151 return (cs);
152fail:
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200153 return NULL;
154}
155
Willy Tarreaufafd3982018-11-18 21:29:20 +0100156/* Retrieves a valid conn_stream from this connection, or returns NULL. For
157 * this mux, it's easy as we can only store a single conn_stream.
158 */
159static const struct conn_stream *mux_pt_get_first_cs(const struct connection *conn)
160{
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100161 struct mux_pt_ctx *ctx = conn->mux_ctx;
162 struct conn_stream *cs = ctx->cs;
Willy Tarreaufafd3982018-11-18 21:29:20 +0100163
164 return cs;
165}
166
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100167/* Destroy the mux and the associated connection, if no longer used */
Olivier Houchard060ed432018-11-06 16:32:42 +0100168static void mux_pt_destroy_meth(struct connection *conn)
169{
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100170 struct mux_pt_ctx *ctx = conn->mux_ctx;
171
172 if (!(ctx->cs))
173 mux_pt_destroy(ctx);
Olivier Houchard060ed432018-11-06 16:32:42 +0100174}
175
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200176/*
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200177 * Detach the stream from the connection and possibly release the connection.
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200178 */
179static void mux_pt_detach(struct conn_stream *cs)
180{
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200181 struct connection *conn = cs->conn;
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100182 struct mux_pt_ctx *ctx = cs->conn->mux_ctx;
Willy Tarreau2c52a2b2017-10-08 11:00:17 +0200183
Olivier Houchardb6c32ee2018-11-05 18:28:43 +0100184 /* Subscribe, to know if we got disconnected */
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100185 if (conn->owner != NULL &&
186 !(conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH))) {
187 ctx->cs = NULL;
188 conn->xprt->subscribe(conn, SUB_CAN_RECV, &ctx->wait_event);
189 } else
190 /* There's no session attached to that connection, destroy it */
191 mux_pt_destroy(ctx);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200192}
193
Olivier Houchardd540b362018-11-05 18:37:53 +0100194static int mux_pt_avail_streams(struct connection *conn)
195{
196 struct mux_pt_ctx *ctx = conn->mux_ctx;
197
198 return (ctx->cs == NULL ? 1 : 0);
199}
200
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200201static void mux_pt_shutr(struct conn_stream *cs, enum cs_shr_mode mode)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200202{
Willy Tarreau4b795242017-10-05 18:47:38 +0200203 if (cs->flags & CS_FL_SHR)
204 return;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200205 if (conn_xprt_ready(cs->conn) && cs->conn->xprt->shutr)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200206 cs->conn->xprt->shutr(cs->conn, (mode == CS_SHR_DRAIN));
Willy Tarreau4b795242017-10-05 18:47:38 +0200207 if (cs->flags & CS_FL_SHW)
208 conn_full_close(cs->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100209 /* Maybe we've been put in the list of available idle connections,
210 * get ouf of here
211 */
212 LIST_DEL(&cs->conn->list);
213 LIST_INIT(&cs->conn->list);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200214}
215
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200216static void mux_pt_shutw(struct conn_stream *cs, enum cs_shw_mode mode)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200217{
Willy Tarreau4b795242017-10-05 18:47:38 +0200218 if (cs->flags & CS_FL_SHW)
219 return;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200220 if (conn_xprt_ready(cs->conn) && cs->conn->xprt->shutw)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200221 cs->conn->xprt->shutw(cs->conn, (mode == CS_SHW_NORMAL));
Willy Tarreau4b795242017-10-05 18:47:38 +0200222 if (!(cs->flags & CS_FL_SHR))
Willy Tarreaua48c1412017-12-22 18:46:33 +0100223 conn_sock_shutw(cs->conn, (mode == CS_SHW_NORMAL));
Willy Tarreau4b795242017-10-05 18:47:38 +0200224 else
225 conn_full_close(cs->conn);
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100226 /* Maybe we've been put in the list of available idle connections,
227 * get ouf of here
228 */
229 LIST_DEL(&cs->conn->list);
230 LIST_INIT(&cs->conn->list);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200231}
232
233/*
234 * Called from the upper layer, to get more data
235 */
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200236static 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 +0200237{
Willy Tarreaud9cf5402018-07-18 11:29:06 +0200238 size_t ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200239
Christopher Faulet4eb7d742018-10-11 15:29:21 +0200240 if (!count) {
241 cs->flags |= CS_FL_RCV_MORE;
242 return 0;
243 }
244 cs->flags &= ~CS_FL_RCV_MORE;
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200245 ret = cs->conn->xprt->rcv_buf(cs->conn, buf, count, flags);
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200246 if (conn_xprt_read0_pending(cs->conn))
247 cs->flags |= CS_FL_EOS;
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200248 if (cs->conn->flags & CO_FL_ERROR)
249 cs->flags |= CS_FL_ERROR;
Willy Tarreaud9cf5402018-07-18 11:29:06 +0200250 return ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200251}
252
253/* Called from the upper layer, to send data */
Christopher Fauletd44a9b32018-07-27 11:59:41 +0200254static 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 +0200255{
Olivier Houchardb72d98a2018-11-30 13:17:48 +0100256 size_t ret;
257
258 if (cs->conn->flags & CO_FL_HANDSHAKE)
259 return 0;
260 ret = cs->conn->xprt->snd_buf(cs->conn, buf, count, flags);
Christopher Fauletd44a9b32018-07-27 11:59:41 +0200261
262 if (ret > 0)
263 b_del(buf, ret);
264 return ret;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200265}
266
Olivier Houchard6ff20392018-07-17 18:46:31 +0200267/* Called from the upper layer, to subscribe to events */
268static int mux_pt_subscribe(struct conn_stream *cs, int event_type, void *param)
269{
270 return (cs->conn->xprt->subscribe(cs->conn, event_type, param));
271}
272
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200273static int mux_pt_unsubscribe(struct conn_stream *cs, int event_type, void *param)
274{
275 return (cs->conn->xprt->unsubscribe(cs->conn, event_type, param));
276}
277
Olivier Houchard7da120b2017-11-01 13:55:10 +0100278#if defined(CONFIG_HAP_LINUX_SPLICE)
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200279/* Send and get, using splicing */
280static int mux_pt_rcv_pipe(struct conn_stream *cs, struct pipe *pipe, unsigned int count)
281{
282 int ret;
283
284 ret = cs->conn->xprt->rcv_pipe(cs->conn, pipe, count);
285 if (conn_xprt_read0_pending(cs->conn))
286 cs->flags |= CS_FL_EOS;
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200287 if (cs->conn->flags & CO_FL_ERROR)
288 cs->flags |= CS_FL_ERROR;
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200289 return (ret);
290}
291
292static int mux_pt_snd_pipe(struct conn_stream *cs, struct pipe *pipe)
293{
294 return (cs->conn->xprt->snd_pipe(cs->conn, pipe));
295}
Olivier Houchard7da120b2017-11-01 13:55:10 +0100296#endif
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200297
Willy Tarreau53a47662017-08-28 10:53:00 +0200298/* The mux operations */
299const struct mux_ops mux_pt_ops = {
300 .init = mux_pt_init,
Willy Tarreau53a47662017-08-28 10:53:00 +0200301 .wake = mux_pt_wake,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200302 .rcv_buf = mux_pt_rcv_buf,
303 .snd_buf = mux_pt_snd_buf,
Olivier Houchard6ff20392018-07-17 18:46:31 +0200304 .subscribe = mux_pt_subscribe,
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200305 .unsubscribe = mux_pt_unsubscribe,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200306#if defined(CONFIG_HAP_LINUX_SPLICE)
307 .rcv_pipe = mux_pt_rcv_pipe,
308 .snd_pipe = mux_pt_snd_pipe,
309#endif
310 .attach = mux_pt_attach,
Willy Tarreaufafd3982018-11-18 21:29:20 +0100311 .get_first_cs = mux_pt_get_first_cs,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200312 .detach = mux_pt_detach,
Olivier Houchardd540b362018-11-05 18:37:53 +0100313 .avail_streams = mux_pt_avail_streams,
Olivier Houchard060ed432018-11-06 16:32:42 +0100314 .destroy = mux_pt_destroy_meth,
Olivier Houchard7a3f0df2017-09-13 18:30:23 +0200315 .shutr = mux_pt_shutr,
316 .shutw = mux_pt_shutw,
Willy Tarreau28f1cb92017-12-20 16:14:44 +0100317 .flags = MX_FL_NONE,
Willy Tarreau53a47662017-08-28 10:53:00 +0200318 .name = "PASS",
319};
Willy Tarreauf6490822017-09-21 19:43:21 +0200320
Christopher Faulet32f61c02018-04-10 14:33:41 +0200321/* PROT selection : default mux has empty name */
322static struct mux_proto_list mux_proto_pt =
323 { .token = IST(""), .mode = PROTO_MODE_ANY, .side = PROTO_SIDE_BOTH, .mux = &mux_pt_ops };
Willy Tarreauf6490822017-09-21 19:43:21 +0200324
Willy Tarreau0108d902018-11-25 19:14:37 +0100325INITCALL1(STG_REGISTER, register_mux_proto, &mux_proto_pt);