blob: f73faee70536194dc5d7e76fe8ccd12f44096878 [file] [log] [blame]
Willy Tarreau92fb9832007-10-16 17:34:28 +02001/*
2 * UNIX SOCK_STREAM protocol layer (uxst)
3 *
Willy Tarreaueb472682010-05-28 18:46:57 +02004 * Copyright 2000-2010 Willy Tarreau <w@1wt.eu>
Willy Tarreau92fb9832007-10-16 17:34:28 +02005 *
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 <ctype.h>
14#include <errno.h>
15#include <fcntl.h>
16#include <stdio.h>
17#include <stdlib.h>
18#include <string.h>
19#include <syslog.h>
20#include <time.h>
21
Willy Tarreau92fb9832007-10-16 17:34:28 +020022#include <sys/socket.h>
23#include <sys/stat.h>
24#include <sys/types.h>
25#include <sys/un.h>
26
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020027#include <haproxy/api.h>
Willy Tarreau7ea393d2020-06-04 18:02:10 +020028#include <haproxy/connection.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020029#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020030#include <haproxy/fd.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020031#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020032#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020033#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020034#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020035#include <haproxy/protocol.h>
Willy Tarreaub9b2fd72020-12-08 14:13:11 +010036#include <haproxy/proto_uxst.h>
Willy Tarreau18b7df72020-08-28 12:07:22 +020037#include <haproxy/sock.h>
Willy Tarreauf1725582020-08-28 15:30:11 +020038#include <haproxy/sock_unix.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020039#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020041#include <haproxy/version.h>
Willy Tarreau92fb9832007-10-16 17:34:28 +020042
Willy Tarreau92fb9832007-10-16 17:34:28 +020043
Emeric Bruncf20bf12010-10-22 16:06:11 +020044static int uxst_bind_listener(struct listener *listener, char *errmsg, int errlen);
Olivier Houchardfdcb0072019-05-06 18:32:29 +020045static int uxst_connect_server(struct connection *conn, int flags);
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +020046static void uxst_enable_listener(struct listener *listener);
47static void uxst_disable_listener(struct listener *listener);
Willy Tarreaucb66ea62020-09-25 17:12:32 +020048static int uxst_suspend_receiver(struct receiver *rx);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010049
50/* Note: must not be declared <const> as its list will be overwritten */
Willy Tarreaub9b2fd72020-12-08 14:13:11 +010051struct protocol proto_uxst = {
Willy Tarreaub366c9a2020-12-08 14:54:20 +010052 .name = "unix_stream",
53
54 /* connection layer */
55 .ctrl_type = SOCK_STREAM,
56 .listen = uxst_bind_listener,
57 .enable = uxst_enable_listener,
58 .disable = uxst_disable_listener,
59 .add = default_add_listener,
60 .unbind = default_unbind_listener,
61 .suspend = default_suspend_listener,
62 .accept_conn = sock_accept_conn,
Willy Tarreaude471c42020-12-08 15:50:56 +010063 .ctrl_init = sock_conn_ctrl_init,
64 .ctrl_close = sock_conn_ctrl_close,
Willy Tarreaub366c9a2020-12-08 14:54:20 +010065 .connect = uxst_connect_server,
Willy Tarreau427c8462020-12-11 16:19:12 +010066 .drain = sock_drain,
Willy Tarreau472125b2020-12-11 17:02:50 +010067 .check_events = sock_check_events,
68 .ignore_events = sock_ignore_events,
Willy Tarreaub366c9a2020-12-08 14:54:20 +010069
70 /* binding layer */
71 .rx_suspend = uxst_suspend_receiver,
72
73 /* address family */
74 .fam = &proto_fam_unix,
75
76 /* socket layer */
77 .sock_type = SOCK_STREAM,
78 .sock_prot = 0,
79 .rx_enable = sock_enable,
80 .rx_disable = sock_disable,
81 .rx_unbind = sock_unbind,
82 .rx_listening = sock_accepting_conn,
83 .default_iocb = sock_accept_iocb,
84 .receivers = LIST_HEAD_INIT(proto_uxst.receivers),
85 .nb_receivers = 0,
Willy Tarreaudabf2e22007-10-28 21:59:24 +010086};
87
Willy Tarreaub9b2fd72020-12-08 14:13:11 +010088INITCALL1(STG_REGISTER, protocol_register, &proto_uxst);
Willy Tarreau0108d902018-11-25 19:14:37 +010089
Willy Tarreaudabf2e22007-10-28 21:59:24 +010090/********************************
91 * 1) low-level socket functions
92 ********************************/
93
94
Cyril Bonté1f5848a2010-11-14 17:03:19 +010095/********************************
96 * 2) listener-oriented functions
97 ********************************/
98
Cyril Bonté1f5848a2010-11-14 17:03:19 +010099/* This function creates a UNIX socket associated to the listener. It changes
100 * the state from ASSIGNED to LISTEN. The socket is NOT enabled for polling.
Willy Tarreau8ab505b2013-01-24 01:41:38 +0100101 * The return value is composed from ERR_NONE, ERR_RETRYABLE and ERR_FATAL. It
102 * may return a warning or an error message in <errmsg> if the message is at
103 * most <errlen> bytes long (including '\0'). Note that <errmsg> may be NULL if
104 * <errlen> is also zero.
Willy Tarreau92fb9832007-10-16 17:34:28 +0200105 */
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100106static int uxst_bind_listener(struct listener *listener, char *errmsg, int errlen)
Willy Tarreau92fb9832007-10-16 17:34:28 +0200107{
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200108 int fd, err;
109 int ready;
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200110 char *msg = NULL;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200111
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200112 err = ERR_NONE;
113
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100114 /* ensure we never return garbage */
Willy Tarreau8ab505b2013-01-24 01:41:38 +0100115 if (errlen)
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100116 *errmsg = 0;
117
118 if (listener->state != LI_ASSIGNED)
119 return ERR_NONE; /* already bound */
Willy Tarreau0b915012020-09-01 10:47:07 +0200120
Willy Tarreauad33acf2020-09-02 18:40:02 +0200121 if (!(listener->rx.flags & RX_F_BOUND)) {
122 msg = "receiving socket not bound";
Aurelien DARRAGON98c44d32023-02-06 18:50:51 +0100123 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreauad33acf2020-09-02 18:40:02 +0200124 goto uxst_return;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200125 }
126
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200127 fd = listener->rx.fd;
Willy Tarreau7d053e42020-10-15 09:19:43 +0200128 ready = sock_accepting_conn(&listener->rx) > 0;
Willy Tarreau40aa0702013-03-10 23:51:38 +0100129
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200130 if (!ready && /* only listen if not already done by external process */
Willy Tarreaue2711c72019-02-27 15:39:41 +0100131 listen(fd, listener_backlog(listener)) < 0) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200132 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100133 msg = "cannot listen to UNIX socket";
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200134 goto uxst_close_return;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200135 }
136
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100137 /* the socket is now listening */
Willy Tarreaua37b2442020-09-24 07:23:45 +0200138 listener_set_state(listener, LI_LISTEN);
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200139 return err;
140
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200141 uxst_close_return:
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100142 close(fd);
Willy Tarreauad33acf2020-09-02 18:40:02 +0200143 uxst_return:
Willy Tarreau40aa0702013-03-10 23:51:38 +0100144 if (msg && errlen) {
Willy Tarreaucd5e5ea2020-09-02 17:21:02 +0200145 const char *path = ((struct sockaddr_un *)&listener->rx.addr)->sun_path;
146 snprintf(errmsg, errlen, "%s [%s]", msg, path);
Willy Tarreau40aa0702013-03-10 23:51:38 +0100147 }
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200148 return err;
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100149}
150
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +0200151/* Enable receipt of incoming connections for listener <l>. The receiver must
Willy Tarreaua4380b22020-11-04 13:59:04 +0100152 * still be valid.
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +0200153 */
154static void uxst_enable_listener(struct listener *l)
155{
Willy Tarreaua4380b22020-11-04 13:59:04 +0100156 fd_want_recv_safe(l->rx.fd);
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +0200157}
158
159/* Disable receipt of incoming connections for listener <l>. The receiver must
Willy Tarreaua4380b22020-11-04 13:59:04 +0100160 * still be valid.
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +0200161 */
162static void uxst_disable_listener(struct listener *l)
163{
Willy Tarreaua4380b22020-11-04 13:59:04 +0100164 fd_stop_recv(l->rx.fd);
Willy Tarreau5ddf1ce2020-09-25 19:27:39 +0200165}
166
Willy Tarreaucb66ea62020-09-25 17:12:32 +0200167/* Suspend a receiver. Returns < 0 in case of failure, 0 if the receiver
168 * was totally stopped, or > 0 if correctly suspended. Nothing is done for
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200169 * plain unix sockets since currently it's the new process which handles
Willy Tarreaue53608b2020-09-24 18:20:37 +0200170 * the renaming. Abstract sockets are completely unbound and closed so
171 * there's no need to stop the poller.
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200172 */
Willy Tarreaucb66ea62020-09-25 17:12:32 +0200173static int uxst_suspend_receiver(struct receiver *rx)
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200174{
Willy Tarreaucb66ea62020-09-25 17:12:32 +0200175 struct listener *l = LIST_ELEM(rx, struct listener *, rx);
176
177 if (((struct sockaddr_un *)&rx->addr)->sun_path[0])
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200178 return 1;
179
Christopher Faulet510c0d62018-03-16 10:04:47 +0100180 /* Listener's lock already held. Call lockless version of
181 * unbind_listener. */
Willy Tarreau75c98d12020-10-09 15:55:23 +0200182 do_unbind_listener(l);
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200183 return 0;
184}
185
Willy Tarreau47f48c42014-05-09 22:57:47 +0200186
187/*
188 * This function initiates a UNIX connection establishment to the target assigned
Willy Tarreauca9f5a92019-07-17 16:40:37 +0200189 * to connection <conn> using (si->{target,dst}). The source address is ignored
Willy Tarreau47f48c42014-05-09 22:57:47 +0200190 * and will be selected by the system. conn->target may point either to a valid
191 * server or to a backend, depending on conn->target. Only OBJ_TYPE_PROXY and
192 * OBJ_TYPE_SERVER are supported. The <data> parameter is a boolean indicating
193 * whether there are data waiting for being sent or not, in order to adjust data
194 * write polling and on some platforms. The <delack> argument is ignored.
195 *
196 * Note that a pending send_proxy message accounts for data.
197 *
198 * It can return one of :
Willy Tarreaue7dff022015-04-03 01:14:29 +0200199 * - SF_ERR_NONE if everything's OK
200 * - SF_ERR_SRVTO if there are no more servers
201 * - SF_ERR_SRVCL if the connection was refused by the server
202 * - SF_ERR_PRXCOND if the connection has been limited by the proxy (maxconn)
203 * - SF_ERR_RESOURCE if a system resource is lacking (eg: fd limits, ports, ...)
204 * - SF_ERR_INTERNAL for any other purely internal errors
Tim Düsterhus4896c442016-11-29 02:15:19 +0100205 * Additionally, in the case of SF_ERR_RESOURCE, an emergency log will be emitted.
Willy Tarreau47f48c42014-05-09 22:57:47 +0200206 *
Willy Tarreaue7dff022015-04-03 01:14:29 +0200207 * The connection's fd is inserted only when SF_ERR_NONE is returned, otherwise
Willy Tarreau47f48c42014-05-09 22:57:47 +0200208 * it's invalid and the caller has nothing to do.
209 */
Olivier Houchardfdcb0072019-05-06 18:32:29 +0200210static int uxst_connect_server(struct connection *conn, int flags)
Willy Tarreau47f48c42014-05-09 22:57:47 +0200211{
212 int fd;
213 struct server *srv;
214 struct proxy *be;
215
Willy Tarreau47f48c42014-05-09 22:57:47 +0200216 switch (obj_type(conn->target)) {
217 case OBJ_TYPE_PROXY:
Willy Tarreau66182592021-12-06 07:01:02 +0000218 be = __objt_proxy(conn->target);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200219 srv = NULL;
220 break;
221 case OBJ_TYPE_SERVER:
Willy Tarreau66182592021-12-06 07:01:02 +0000222 srv = __objt_server(conn->target);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200223 be = srv->proxy;
224 break;
225 default:
226 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200227 return SF_ERR_INTERNAL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200228 }
229
Willy Tarreau585744b2017-08-24 14:31:19 +0200230 if ((fd = conn->handle.fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1) {
Willy Tarreau47f48c42014-05-09 22:57:47 +0200231 qfprintf(stderr, "Cannot get a server socket.\n");
232
233 if (errno == ENFILE) {
234 conn->err_code = CO_ER_SYS_FDLIM;
235 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100236 "Proxy %s reached system FD limit (maxsock=%d). Please check system tunables.\n",
237 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200238 }
239 else if (errno == EMFILE) {
240 conn->err_code = CO_ER_PROC_FDLIM;
241 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100242 "Proxy %s reached process FD limit (maxsock=%d). Please check 'ulimit-n' and restart.\n",
243 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200244 }
245 else if (errno == ENOBUFS || errno == ENOMEM) {
246 conn->err_code = CO_ER_SYS_MEMLIM;
247 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100248 "Proxy %s reached system memory limit (maxsock=%d). Please check system tunables.\n",
249 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200250 }
251 else if (errno == EAFNOSUPPORT || errno == EPROTONOSUPPORT) {
252 conn->err_code = CO_ER_NOPROTO;
253 }
254 else
255 conn->err_code = CO_ER_SOCK_ERR;
256
257 /* this is a resource error */
258 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200259 return SF_ERR_RESOURCE;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200260 }
261
262 if (fd >= global.maxsock) {
263 /* do not log anything there, it's a normal condition when this option
264 * is used to serialize connections to a server !
265 */
Christopher Faulet767a84b2017-11-24 16:50:31 +0100266 ha_alert("socket(): not enough free sockets. Raise -n argument. Giving up.\n");
Willy Tarreau47f48c42014-05-09 22:57:47 +0200267 close(fd);
268 conn->err_code = CO_ER_CONF_FDLIM;
269 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200270 return SF_ERR_PRXCOND; /* it is a configuration limit */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200271 }
272
273 if (fcntl(fd, F_SETFL, O_NONBLOCK) == -1) {
274 qfprintf(stderr,"Cannot set client socket to non blocking mode.\n");
275 close(fd);
276 conn->err_code = CO_ER_SOCK_ERR;
277 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200278 return SF_ERR_INTERNAL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200279 }
280
William Lallemandc03eb012018-11-27 12:02:37 +0100281 if (master == 1 && (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)) {
282 ha_alert("Cannot set CLOEXEC on client socket.\n");
283 close(fd);
284 conn->err_code = CO_ER_SOCK_ERR;
285 conn->flags |= CO_FL_ERROR;
286 return SF_ERR_INTERNAL;
287 }
288
Willy Tarreau47f48c42014-05-09 22:57:47 +0200289 if (global.tune.server_sndbuf)
290 setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &global.tune.server_sndbuf, sizeof(global.tune.server_sndbuf));
291
292 if (global.tune.server_rcvbuf)
293 setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &global.tune.server_rcvbuf, sizeof(global.tune.server_rcvbuf));
294
Willy Tarreauca9f5a92019-07-17 16:40:37 +0200295 if (connect(fd, (struct sockaddr *)conn->dst, get_addr_len(conn->dst)) == -1) {
Willy Tarreau94841792017-01-25 14:27:38 +0100296 if (errno == EINPROGRESS || errno == EALREADY) {
Willy Tarreau7bb21532014-05-10 09:48:28 +0200297 conn->flags |= CO_FL_WAIT_L4_CONN;
298 }
Willy Tarreau94841792017-01-25 14:27:38 +0100299 else if (errno == EISCONN) {
300 conn->flags &= ~CO_FL_WAIT_L4_CONN;
301 }
Willy Tarreau7bb21532014-05-10 09:48:28 +0200302 else if (errno == EAGAIN || errno == EADDRINUSE || errno == EADDRNOTAVAIL) {
Willy Tarreau47f48c42014-05-09 22:57:47 +0200303 char *msg;
304 if (errno == EAGAIN || errno == EADDRNOTAVAIL) {
Lukas Tribus9f256d42016-01-26 20:33:14 +0100305 msg = "can't connect to destination unix socket, check backlog size on the server";
Willy Tarreau47f48c42014-05-09 22:57:47 +0200306 conn->err_code = CO_ER_FREE_PORTS;
307 }
308 else {
309 msg = "local address already in use";
310 conn->err_code = CO_ER_ADDR_INUSE;
311 }
312
313 qfprintf(stderr,"Connect() failed for backend %s: %s.\n", be->id, msg);
314 close(fd);
315 send_log(be, LOG_ERR, "Connect() failed for backend %s: %s.\n", be->id, msg);
316 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200317 return SF_ERR_RESOURCE;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200318 }
319 else if (errno == ETIMEDOUT) {
320 close(fd);
321 conn->err_code = CO_ER_SOCK_ERR;
322 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200323 return SF_ERR_SRVTO;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200324 }
325 else { // (errno == ECONNREFUSED || errno == ENETUNREACH || errno == EACCES || errno == EPERM)
326 close(fd);
327 conn->err_code = CO_ER_SOCK_ERR;
328 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200329 return SF_ERR_SRVCL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200330 }
331 }
Willy Tarreau7bb21532014-05-10 09:48:28 +0200332 else {
333 /* connect() already succeeded, which is quite usual for unix
Willy Tarreau94841792017-01-25 14:27:38 +0100334 * sockets. Let's avoid a second connect() probe to complete it.
Willy Tarreau7bb21532014-05-10 09:48:28 +0200335 */
336 conn->flags &= ~CO_FL_WAIT_L4_CONN;
Willy Tarreau7bb21532014-05-10 09:48:28 +0200337 }
Willy Tarreau47f48c42014-05-09 22:57:47 +0200338
339 conn->flags |= CO_FL_ADDR_TO_SET;
340
341 /* Prepare to send a few handshakes related to the on-wire protocol. */
342 if (conn->send_proxy_ofs)
343 conn->flags |= CO_FL_SEND_PROXY;
344
345 conn_ctrl_init(conn); /* registers the FD */
Willy Tarreaub41a6e92021-04-06 17:49:19 +0200346 HA_ATOMIC_AND(&fdtab[fd].state, ~FD_LINGER_RISK); /* no need to disable lingering */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200347
Willy Tarreau4c69cff2020-03-04 16:38:00 +0100348 if (conn->flags & CO_FL_WAIT_L4_CONN) {
349 fd_want_send(fd);
350 fd_cant_send(fd);
Willy Tarreau8dbd1a22020-07-31 08:59:09 +0200351 fd_cant_recv(fd);
Willy Tarreau4c69cff2020-03-04 16:38:00 +0100352 }
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200353
Willy Tarreaue7dff022015-04-03 01:14:29 +0200354 return SF_ERR_NONE; /* connection is OK */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200355}
356
Willy Tarreau92fb9832007-10-16 17:34:28 +0200357/*
358 * Local variables:
359 * c-indent-level: 8
360 * c-basic-offset: 8
361 * End:
362 */