blob: e9221ae2b775f26c6f1ec7a7ec78346434a28e11 [file] [log] [blame]
Willy Tarreaudd815982007-10-16 12:25:14 +02001/*
Willy Tarreaud1d54542012-09-12 22:58:11 +02002 * Listener management functions.
Willy Tarreaudd815982007-10-16 12:25:14 +02003 *
Willy Tarreau0ccb7442013-01-07 22:54:17 +01004 * Copyright 2000-2013 Willy Tarreau <w@1wt.eu>
Willy Tarreaudd815982007-10-16 12:25:14 +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
Willy Tarreau6ae1ba62014-05-07 19:01:58 +020013#include <ctype.h>
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020014#include <errno.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020015#include <stdio.h>
16#include <string.h>
Willy Tarreau95ccdde2014-02-01 09:28:36 +010017#include <unistd.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020018
Willy Tarreaudcc048a2020-06-04 19:11:43 +020019#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020020#include <haproxy/api.h>
Willy Tarreau5d9ddc52021-10-06 19:54:09 +020021#include <haproxy/activity.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020022#include <haproxy/cfgparse.h>
Willy Tarreaudbf78022021-10-06 09:05:08 +020023#include <haproxy/cli-t.h>
Willy Tarreau7ea393d2020-06-04 18:02:10 +020024#include <haproxy/connection.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020025#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020026#include <haproxy/fd.h>
27#include <haproxy/freq_ctr.h>
Amaury Denoyelle8ee9fc72023-10-25 15:32:28 +020028#include <haproxy/frontend.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020029#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020030#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020031#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020032#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/protocol.h>
Willy Tarreau5958c432021-05-08 20:30:37 +020034#include <haproxy/proxy.h>
Frédéric Lécaille748ece62022-05-21 23:58:40 +020035#include <haproxy/quic_tp.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020036#include <haproxy/sample.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020037#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020038#include <haproxy/task.h>
Willy Tarreau9310f482021-10-06 16:18:40 +020039#include <haproxy/ticks.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/tools.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020041
Willy Tarreaub648d632007-10-28 22:13:50 +010042
Willy Tarreau26982662012-09-12 23:17:10 +020043/* List head of all known bind keywords */
Willy Tarreauca1acd62022-03-29 15:02:44 +020044struct bind_kw_list bind_keywords = {
Willy Tarreau26982662012-09-12 23:17:10 +020045 .list = LIST_HEAD_INIT(bind_keywords.list)
46};
47
Willy Tarreaua1d97f82019-12-10 11:18:41 +010048/* list of the temporarily limited listeners because of lack of resource */
49static struct mt_list global_listener_queue = MT_LIST_HEAD_INIT(global_listener_queue);
50static struct task *global_listener_queue_task;
Willy Tarreau96151022023-05-11 13:51:31 +020051/* number of times an accepted connection resulted in maxconn being reached */
52ullong maxconn_reached = 0;
Willy Tarreau469fa472022-11-22 09:08:23 +010053__decl_thread(static HA_RWLOCK_T global_listener_rwlock);
Willy Tarreaua1d97f82019-12-10 11:18:41 +010054
William Dauchy3679d0c2021-02-14 23:22:55 +010055/* listener status for stats */
56const char* li_status_st[LI_STATE_COUNT] = {
57 [LI_STATUS_WAITING] = "WAITING",
58 [LI_STATUS_OPEN] = "OPEN",
59 [LI_STATUS_FULL] = "FULL",
60};
Willy Tarreaua1d97f82019-12-10 11:18:41 +010061
Willy Tarreau1efafce2019-01-27 15:37:19 +010062#if defined(USE_THREAD)
63
64struct accept_queue_ring accept_queue_rings[MAX_THREADS] __attribute__((aligned(64))) = { };
65
66/* dequeue and process a pending connection from the local accept queue (single
Willy Tarreau83efc322020-10-14 17:37:17 +020067 * consumer). Returns the accepted connection or NULL if none was found.
Willy Tarreau1efafce2019-01-27 15:37:19 +010068 */
Willy Tarreau83efc322020-10-14 17:37:17 +020069struct connection *accept_queue_pop_sc(struct accept_queue_ring *ring)
Willy Tarreau1efafce2019-01-27 15:37:19 +010070{
Willy Tarreau1efafce2019-01-27 15:37:19 +010071 unsigned int pos, next;
Willy Tarreau83efc322020-10-14 17:37:17 +020072 struct connection *ptr;
73 struct connection **e;
Willy Tarreaue6f5ab52023-04-20 11:05:28 +020074 uint32_t idx = _HA_ATOMIC_LOAD(&ring->idx); /* (head << 16) + tail */
Willy Tarreau1efafce2019-01-27 15:37:19 +010075
Willy Tarreaue6f5ab52023-04-20 11:05:28 +020076 pos = idx >> 16;
77 if (pos == (uint16_t)idx)
Willy Tarreau83efc322020-10-14 17:37:17 +020078 return NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +010079
80 next = pos + 1;
81 if (next >= ACCEPT_QUEUE_SIZE)
82 next = 0;
83
84 e = &ring->entry[pos];
85
86 /* wait for the producer to update the listener's pointer */
87 while (1) {
Willy Tarreau83efc322020-10-14 17:37:17 +020088 ptr = *e;
Willy Tarreau1efafce2019-01-27 15:37:19 +010089 __ha_barrier_load();
90 if (ptr)
91 break;
92 pl_cpu_relax();
93 }
94
Willy Tarreau1efafce2019-01-27 15:37:19 +010095 /* release the entry */
Willy Tarreau83efc322020-10-14 17:37:17 +020096 *e = NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +010097
98 __ha_barrier_store();
Willy Tarreaue6f5ab52023-04-20 11:05:28 +020099 do {
100 pos = (next << 16) | (idx & 0xffff);
101 } while (unlikely(!HA_ATOMIC_CAS(&ring->idx, &idx, pos) && __ha_cpu_relax()));
102
Willy Tarreau83efc322020-10-14 17:37:17 +0200103 return ptr;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100104}
105
106
Willy Tarreau83efc322020-10-14 17:37:17 +0200107/* tries to push a new accepted connection <conn> into ring <ring>. Returns
108 * non-zero if it succeeds, or zero if the ring is full. Supports multiple
109 * producers.
Willy Tarreau1efafce2019-01-27 15:37:19 +0100110 */
Willy Tarreau83efc322020-10-14 17:37:17 +0200111int accept_queue_push_mp(struct accept_queue_ring *ring, struct connection *conn)
Willy Tarreau1efafce2019-01-27 15:37:19 +0100112{
Willy Tarreau1efafce2019-01-27 15:37:19 +0100113 unsigned int pos, next;
Willy Tarreaue6f5ab52023-04-20 11:05:28 +0200114 uint32_t idx = _HA_ATOMIC_LOAD(&ring->idx); /* (head << 16) + tail */
Willy Tarreau1efafce2019-01-27 15:37:19 +0100115
Willy Tarreau1efafce2019-01-27 15:37:19 +0100116 do {
Willy Tarreaue6f5ab52023-04-20 11:05:28 +0200117 pos = (uint16_t)idx;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100118 next = pos + 1;
119 if (next >= ACCEPT_QUEUE_SIZE)
120 next = 0;
Willy Tarreaue6f5ab52023-04-20 11:05:28 +0200121 if (next == (idx >> 16))
Willy Tarreau1efafce2019-01-27 15:37:19 +0100122 return 0; // ring full
Willy Tarreaue6f5ab52023-04-20 11:05:28 +0200123 next |= (idx & 0xffff0000U);
124 } while (unlikely(!_HA_ATOMIC_CAS(&ring->idx, &idx, next) && __ha_cpu_relax()));
Willy Tarreau1efafce2019-01-27 15:37:19 +0100125
Willy Tarreau83efc322020-10-14 17:37:17 +0200126 ring->entry[pos] = conn;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100127 __ha_barrier_store();
Willy Tarreau1efafce2019-01-27 15:37:19 +0100128 return 1;
129}
130
Willy Tarreaufb5401f2021-01-29 12:25:23 +0100131/* proceed with accepting new connections. Don't mark it static so that it appears
132 * in task dumps.
133 */
Willy Tarreau144f84a2021-03-02 16:09:26 +0100134struct task *accept_queue_process(struct task *t, void *context, unsigned int state)
Willy Tarreau1efafce2019-01-27 15:37:19 +0100135{
136 struct accept_queue_ring *ring = context;
Willy Tarreau83efc322020-10-14 17:37:17 +0200137 struct connection *conn;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100138 struct listener *li;
Christopher Faulet102854c2019-04-30 12:17:13 +0200139 unsigned int max_accept;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100140 int ret;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100141
Christopher Faulet102854c2019-04-30 12:17:13 +0200142 /* if global.tune.maxaccept is -1, then max_accept is UINT_MAX. It
143 * is not really illimited, but it is probably enough.
144 */
Willy Tarreau66161322021-02-19 15:50:27 +0100145 max_accept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
Christopher Faulet102854c2019-04-30 12:17:13 +0200146 for (; max_accept; max_accept--) {
Willy Tarreau83efc322020-10-14 17:37:17 +0200147 conn = accept_queue_pop_sc(ring);
148 if (!conn)
Willy Tarreau1efafce2019-01-27 15:37:19 +0100149 break;
150
Willy Tarreau83efc322020-10-14 17:37:17 +0200151 li = __objt_listener(conn->target);
Willy Tarreaufea8c192023-02-28 10:25:57 +0100152 _HA_ATOMIC_INC(&li->thr_conn[ti->ltid]);
Willy Tarreau30836152023-01-12 19:10:17 +0100153 ret = li->bind_conf->accept(conn);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100154 if (ret <= 0) {
155 /* connection was terminated by the application */
156 continue;
157 }
158
159 /* increase the per-process number of cumulated sessions, this
Willy Tarreau30836152023-01-12 19:10:17 +0100160 * may only be done once l->bind_conf->accept() has accepted the
161 * connection.
Willy Tarreau1efafce2019-01-27 15:37:19 +0100162 */
Willy Tarreau17146802023-01-12 19:58:42 +0100163 if (!(li->bind_conf->options & BC_O_UNLIMITED)) {
Willy Tarreau1efafce2019-01-27 15:37:19 +0100164 HA_ATOMIC_UPDATE_MAX(&global.sps_max,
165 update_freq_ctr(&global.sess_per_sec, 1));
Ilya Shipitsin83f54b92023-04-26 21:05:12 +0200166 if (li->bind_conf->options & BC_O_USE_SSL) {
Willy Tarreau1efafce2019-01-27 15:37:19 +0100167 HA_ATOMIC_UPDATE_MAX(&global.ssl_max,
168 update_freq_ctr(&global.ssl_per_sec, 1));
169 }
170 }
171 }
172
173 /* ran out of budget ? Let's come here ASAP */
Christopher Faulet102854c2019-04-30 12:17:13 +0200174 if (!max_accept)
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200175 tasklet_wakeup(ring->tasklet);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100176
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200177 return NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100178}
179
180/* Initializes the accept-queues. Returns 0 on success, otherwise ERR_* flags */
181static int accept_queue_init()
182{
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200183 struct tasklet *t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100184 int i;
185
186 for (i = 0; i < global.nbthread; i++) {
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200187 t = tasklet_new();
Willy Tarreau1efafce2019-01-27 15:37:19 +0100188 if (!t) {
189 ha_alert("Out of memory while initializing accept queue for thread %d\n", i);
190 return ERR_FATAL|ERR_ABORT;
191 }
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200192 t->tid = i;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100193 t->process = accept_queue_process;
194 t->context = &accept_queue_rings[i];
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200195 accept_queue_rings[i].tasklet = t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100196 }
197 return 0;
198}
199
200REGISTER_CONFIG_POSTPARSER("multi-threaded accept queue", accept_queue_init);
201
Willy Tarreaue01b08d2022-04-27 18:42:47 +0200202static void accept_queue_deinit()
203{
204 int i;
205
206 for (i = 0; i < global.nbthread; i++) {
Tim Duesterhusb1ec21d2023-04-22 17:47:32 +0200207 tasklet_free(accept_queue_rings[i].tasklet);
Willy Tarreaue01b08d2022-04-27 18:42:47 +0200208 }
209}
210
211REGISTER_POST_DEINIT(accept_queue_deinit);
212
Willy Tarreau1efafce2019-01-27 15:37:19 +0100213#endif // USE_THREAD
214
Willy Tarreau6a4d48b2023-04-21 10:46:45 +0200215/* Memory allocation and initialization of the per_thr field (one entry per
216 * bound thread).
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100217 * Returns 0 if the field has been successfully initialized, -1 on failure.
218 */
219int li_init_per_thr(struct listener *li)
220{
Willy Tarreau6a4d48b2023-04-21 10:46:45 +0200221 int nbthr = MIN(global.nbthread, MAX_THREADS_PER_GROUP);
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100222 int i;
223
224 /* allocate per-thread elements for listener */
Willy Tarreau6a4d48b2023-04-21 10:46:45 +0200225 li->per_thr = calloc(nbthr, sizeof(*li->per_thr));
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100226 if (!li->per_thr)
227 return -1;
228
Willy Tarreau6a4d48b2023-04-21 10:46:45 +0200229 for (i = 0; i < nbthr; ++i) {
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100230 MT_LIST_INIT(&li->per_thr[i].quic_accept.list);
231 MT_LIST_INIT(&li->per_thr[i].quic_accept.conns);
232
233 li->per_thr[i].li = li;
234 }
235
236 return 0;
237}
238
William Dauchy3679d0c2021-02-14 23:22:55 +0100239/* helper to get listener status for stats */
240enum li_status get_li_status(struct listener *l)
241{
Willy Tarreau758c69d2023-01-12 18:59:37 +0100242 if (!l->bind_conf->maxconn || l->nbconn < l->bind_conf->maxconn) {
William Dauchy3679d0c2021-02-14 23:22:55 +0100243 if (l->state == LI_LIMITED)
244 return LI_STATUS_WAITING;
245 else
246 return LI_STATUS_OPEN;
247 }
248 return LI_STATUS_FULL;
249}
250
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200251/* adjust the listener's state and its proxy's listener counters if needed.
252 * It must be called under the listener's lock, but uses atomic ops to change
253 * the proxy's counters so that the proxy lock is not needed.
254 */
Willy Tarreaua37b2442020-09-24 07:23:45 +0200255void listener_set_state(struct listener *l, enum li_state st)
256{
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200257 struct proxy *px = l->bind_conf->frontend;
258
259 if (px) {
260 /* from state */
261 switch (l->state) {
262 case LI_NEW: /* first call */
Willy Tarreau4781b152021-04-06 13:53:36 +0200263 _HA_ATOMIC_INC(&px->li_all);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200264 break;
265 case LI_INIT:
266 case LI_ASSIGNED:
267 break;
268 case LI_PAUSED:
Willy Tarreau4781b152021-04-06 13:53:36 +0200269 _HA_ATOMIC_DEC(&px->li_paused);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200270 break;
271 case LI_LISTEN:
Willy Tarreau4781b152021-04-06 13:53:36 +0200272 _HA_ATOMIC_DEC(&px->li_bound);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200273 break;
274 case LI_READY:
275 case LI_FULL:
276 case LI_LIMITED:
Willy Tarreau4781b152021-04-06 13:53:36 +0200277 _HA_ATOMIC_DEC(&px->li_ready);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200278 break;
279 }
280
281 /* to state */
282 switch (st) {
283 case LI_NEW:
284 case LI_INIT:
285 case LI_ASSIGNED:
286 break;
287 case LI_PAUSED:
Willy Tarreau95a34602020-10-08 15:32:21 +0200288 BUG_ON(l->rx.fd == -1);
Willy Tarreau4781b152021-04-06 13:53:36 +0200289 _HA_ATOMIC_INC(&px->li_paused);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200290 break;
291 case LI_LISTEN:
Willy Tarreau95a34602020-10-08 15:32:21 +0200292 BUG_ON(l->rx.fd == -1);
Willy Tarreau4781b152021-04-06 13:53:36 +0200293 _HA_ATOMIC_INC(&px->li_bound);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200294 break;
295 case LI_READY:
296 case LI_FULL:
297 case LI_LIMITED:
Willy Tarreau95a34602020-10-08 15:32:21 +0200298 BUG_ON(l->rx.fd == -1);
Willy Tarreau4781b152021-04-06 13:53:36 +0200299 _HA_ATOMIC_INC(&px->li_ready);
Aurelien DARRAGON23705992023-02-14 08:51:14 +0100300 l->flags |= LI_F_FINALIZED;
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200301 break;
302 }
303 }
Willy Tarreaua37b2442020-09-24 07:23:45 +0200304 l->state = st;
305}
306
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100307/* This function adds the specified listener's file descriptor to the polling
308 * lists if it is in the LI_LISTEN state. The listener enters LI_READY or
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500309 * LI_FULL state depending on its number of connections. In daemon mode, we
Willy Tarreauae302532014-05-07 19:22:24 +0200310 * also support binding only the relevant processes to their respective
311 * listeners. We don't do that in debug mode however.
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100312 */
Willy Tarreau7834a3f2020-09-25 16:40:18 +0200313void enable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100314{
Willy Tarreau08b6f962022-02-01 16:23:00 +0100315 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaud6afb532020-10-09 10:35:40 +0200316
317 /* If this listener is supposed to be only in the master, close it in
318 * the workers. Conversely, if it's supposed to be only in the workers
319 * close it in the master.
320 */
Willy Tarreau18c20d22020-10-09 16:11:46 +0200321 if (!!master != !!(listener->rx.flags & RX_F_MWORKER))
Willy Tarreau75c98d12020-10-09 15:55:23 +0200322 do_unbind_listener(listener);
Willy Tarreaud6afb532020-10-09 10:35:40 +0200323
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100324 if (listener->state == LI_LISTEN) {
Willy Tarreau95a34602020-10-08 15:32:21 +0200325 BUG_ON(listener->rx.fd == -1);
William Lallemand095ba4c2017-06-01 17:38:50 +0200326 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau72faef32021-06-15 08:36:30 +0200327 (!!master != !!(listener->rx.flags & RX_F_MWORKER))) {
Willy Tarreauae302532014-05-07 19:22:24 +0200328 /* we don't want to enable this listener and don't
329 * want any fd event to reach it.
330 */
Willy Tarreau75c98d12020-10-09 15:55:23 +0200331 do_unbind_listener(listener);
Willy Tarreauae302532014-05-07 19:22:24 +0200332 }
Willy Tarreau758c69d2023-01-12 18:59:37 +0100333 else if (!listener->bind_conf->maxconn || listener->nbconn < listener->bind_conf->maxconn) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200334 listener->rx.proto->enable(listener);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200335 listener_set_state(listener, LI_READY);
Willy Tarreauae302532014-05-07 19:22:24 +0200336 }
337 else {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200338 listener_set_state(listener, LI_FULL);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100339 }
340 }
Willy Tarreaud6afb532020-10-09 10:35:40 +0200341
Willy Tarreau08b6f962022-02-01 16:23:00 +0100342 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100343}
344
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200345/*
Aurelien DARRAGON187396e2022-09-11 16:19:49 +0200346 * This function completely stops a listener.
347 * The proxy's listeners count is updated and the proxy is
348 * disabled and woken up after the last one is gone.
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100349 * It will need to operate under the proxy's lock, the protocol's lock and
350 * the listener's lock. The caller is responsible for indicating in lpx,
351 * lpr, lli whether the respective locks are already held (non-zero) or
352 * not (zero) so that the function picks the missing ones, in this order.
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200353 */
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100354void stop_listener(struct listener *l, int lpx, int lpr, int lli)
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200355{
356 struct proxy *px = l->bind_conf->frontend;
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200357
Willy Tarreau17146802023-01-12 19:58:42 +0100358 if (l->bind_conf->options & BC_O_NOSTOP) {
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200359 /* master-worker sockpairs are never closed but don't count as a
360 * job.
361 */
362 return;
363 }
364
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200365 if (!lpx && px)
Willy Tarreauac66d6b2020-10-20 17:24:27 +0200366 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200367
368 if (!lpr)
369 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
370
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100371 if (!lli)
372 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200373
374 if (l->state > LI_INIT) {
Willy Tarreau75c98d12020-10-09 15:55:23 +0200375 do_unbind_listener(l);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200376
377 if (l->state >= LI_ASSIGNED)
378 __delete_listener(l);
379
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200380 if (px)
381 proxy_cond_disable(px);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200382 }
383
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100384 if (!lli)
385 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200386
387 if (!lpr)
388 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
389
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200390 if (!lpx && px)
Willy Tarreauac66d6b2020-10-20 17:24:27 +0200391 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200392}
393
Willy Tarreaud1f250f2020-12-04 15:03:36 +0100394/* This function adds the specified <listener> to the protocol <proto>. It
395 * does nothing if the protocol was already added. The listener's state is
396 * automatically updated from LI_INIT to LI_ASSIGNED. The number of listeners
397 * for the protocol is updated. This must be called with the proto lock held.
398 */
399void default_add_listener(struct protocol *proto, struct listener *listener)
400{
401 if (listener->state != LI_INIT)
402 return;
403 listener_set_state(listener, LI_ASSIGNED);
404 listener->rx.proto = proto;
Willy Tarreau2b718102021-04-21 07:32:39 +0200405 LIST_APPEND(&proto->receivers, &listener->rx.proto_list);
Willy Tarreaud1f250f2020-12-04 15:03:36 +0100406 proto->nb_receivers++;
407}
408
Willy Tarreaue03204c2020-10-09 17:02:21 +0200409/* default function called to suspend a listener: it simply passes the call to
410 * the underlying receiver. This is find for most socket-based protocols. This
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100411 * must be called under the listener's lock. It will return < 0 in case of
412 * failure, 0 if the listener was totally stopped, or > 0 if correctly paused..
413 * If no receiver-level suspend is provided, the operation is assumed
414 * to succeed.
Willy Tarreaue03204c2020-10-09 17:02:21 +0200415 */
416int default_suspend_listener(struct listener *l)
417{
Willy Tarreaue03204c2020-10-09 17:02:21 +0200418 if (!l->rx.proto->rx_suspend)
419 return 1;
420
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100421 return l->rx.proto->rx_suspend(&l->rx);
Willy Tarreaue03204c2020-10-09 17:02:21 +0200422}
423
424
425/* Tries to resume a suspended listener, and returns non-zero on success or
426 * zero on failure. On certain errors, an alert or a warning might be displayed.
427 * It must be called with the listener's lock held. Depending on the listener's
428 * state and protocol, a listen() call might be used to resume operations, or a
429 * call to the receiver's resume() function might be used as well. This is
430 * suitable as a default function for TCP and UDP. This must be called with the
431 * listener's lock held.
432 */
433int default_resume_listener(struct listener *l)
434{
435 int ret = 1;
436
437 if (l->state == LI_ASSIGNED) {
438 char msg[100];
Aurelien DARRAGON046a75e2023-02-07 12:17:20 +0100439 char *errmsg;
Willy Tarreaue03204c2020-10-09 17:02:21 +0200440 int err;
441
Aurelien DARRAGON046a75e2023-02-07 12:17:20 +0100442 /* first, try to bind the receiver */
443 err = l->rx.proto->fam->bind(&l->rx, &errmsg);
444 if (err != ERR_NONE) {
445 if (err & ERR_WARN)
446 ha_warning("Resuming listener: %s\n", errmsg);
447 else if (err & ERR_ALERT)
448 ha_alert("Resuming listener: %s\n", errmsg);
449 ha_free(&errmsg);
450 if (err & (ERR_FATAL | ERR_ABORT)) {
451 ret = 0;
452 goto end;
453 }
454 }
455
456 /* then, try to listen:
457 * for now there's still always a listening function
458 * (same check performed in protocol_bind_all()
459 */
460 BUG_ON(!l->rx.proto->listen);
Willy Tarreaue03204c2020-10-09 17:02:21 +0200461 err = l->rx.proto->listen(l, msg, sizeof(msg));
462 if (err & ERR_ALERT)
463 ha_alert("Resuming listener: %s\n", msg);
464 else if (err & ERR_WARN)
465 ha_warning("Resuming listener: %s\n", msg);
466
467 if (err & (ERR_FATAL | ERR_ABORT)) {
468 ret = 0;
469 goto end;
470 }
471 }
472
473 if (l->state < LI_PAUSED) {
474 ret = 0;
475 goto end;
476 }
477
478 if (l->state == LI_PAUSED && l->rx.proto->rx_resume &&
479 l->rx.proto->rx_resume(&l->rx) <= 0)
480 ret = 0;
481 end:
482 return ret;
483}
484
485
Willy Tarreaube58c382011-07-24 18:28:10 +0200486/* This function tries to temporarily disable a listener, depending on the OS
487 * capabilities. Linux unbinds the listen socket after a SHUT_RD, and ignores
488 * SHUT_WR. Solaris refuses either shutdown(). OpenBSD ignores SHUT_RD but
489 * closes upon SHUT_WR and refuses to rebind. So a common validation path
490 * involves SHUT_WR && listen && SHUT_RD. In case of success, the FD's polling
491 * is disabled. It normally returns non-zero, unless an error is reported.
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +0100492 * suspend() may totally stop a listener if it doesn't support the PAUSED
493 * state, in which case state will be set to ASSIGNED.
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100494 * It will need to operate under the proxy's lock and the listener's lock.
495 * The caller is responsible for indicating in lpx, lli whether the respective
496 * locks are already held (non-zero) or not (zero) so that the function pick
497 * the missing ones, in this order.
Willy Tarreaube58c382011-07-24 18:28:10 +0200498 */
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +0100499int suspend_listener(struct listener *l, int lpx, int lli)
Willy Tarreaube58c382011-07-24 18:28:10 +0200500{
Willy Tarreau58651b42020-09-24 16:03:29 +0200501 struct proxy *px = l->bind_conf->frontend;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200502 int ret = 1;
503
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200504 if (!lpx && px)
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200505 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
506
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100507 if (!lli)
508 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200509
Aurelien DARRAGON23705992023-02-14 08:51:14 +0100510 if (!(l->flags & LI_F_FINALIZED) || l->state <= LI_PAUSED)
Willy Tarreau9b3a9322020-09-24 14:46:34 +0200511 goto end;
512
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100513 if (l->rx.proto->suspend) {
Willy Tarreaue03204c2020-10-09 17:02:21 +0200514 ret = l->rx.proto->suspend(l);
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100515 /* if the suspend() fails, we don't want to change the
516 * current listener state
517 */
518 if (ret < 0)
519 goto end;
520 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200521
Willy Tarreau2b718102021-04-21 07:32:39 +0200522 MT_LIST_DELETE(&l->wait_queue);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200523
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100524 /* ret == 0 means that the suspend() has been turned into
525 * an unbind(), meaning the listener is now stopped (ie: ABNS), we need
526 * to report this state change properly
527 */
528 listener_set_state(l, ((ret) ? LI_PAUSED : LI_ASSIGNED));
529
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +0100530 if (px && !(l->flags & LI_F_SUSPENDED))
531 px->li_suspended++;
532 l->flags |= LI_F_SUSPENDED;
533
Aurelien DARRAGON7a15fa52023-02-07 11:23:38 +0100534 /* at this point, everything is under control, no error should be
535 * returned to calling function
536 */
537 ret = 1;
Willy Tarreau58651b42020-09-24 16:03:29 +0200538
Aurelien DARRAGONca8a4b22023-02-07 12:36:27 +0100539 if (px && !(px->flags & PR_FL_PAUSED) && !px->li_ready) {
Aurelien DARRAGONd46f4372022-09-09 15:51:37 +0200540 /* PROXY_LOCK is required */
541 proxy_cond_pause(px);
Willy Tarreau58651b42020-09-24 16:03:29 +0200542 ha_warning("Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
543 send_log(px, LOG_WARNING, "Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
544 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200545 end:
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100546 if (!lli)
547 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200548
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200549 if (!lpx && px)
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200550 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
551
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200552 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200553}
554
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200555/* This function tries to resume a temporarily disabled listener. Paused, full,
556 * limited and disabled listeners are handled, which means that this function
557 * may replace enable_listener(). The resulting state will either be LI_READY
558 * or LI_FULL. 0 is returned in case of failure to resume (eg: dead socket).
Willy Tarreauae302532014-05-07 19:22:24 +0200559 * Listeners bound to a different process are not woken up unless we're in
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200560 * foreground mode, and are ignored. If the listener was only in the assigned
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +0100561 * state, it's totally rebound. This can happen if a suspend() has completely
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200562 * stopped it. If the resume fails, 0 is returned and an error might be
563 * displayed.
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100564 * It will need to operate under the proxy's lock and the listener's lock.
565 * The caller is responsible for indicating in lpx, lli whether the respective
566 * locks are already held (non-zero) or not (zero) so that the function pick
567 * the missing ones, in this order.
Willy Tarreaube58c382011-07-24 18:28:10 +0200568 */
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100569int resume_listener(struct listener *l, int lpx, int lli)
Willy Tarreaube58c382011-07-24 18:28:10 +0200570{
Willy Tarreau58651b42020-09-24 16:03:29 +0200571 struct proxy *px = l->bind_conf->frontend;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200572 int ret = 1;
573
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200574 if (!lpx && px)
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200575 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
576
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100577 if (!lli)
578 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200579
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200580 /* check that another thread didn't to the job in parallel (e.g. at the
581 * end of listen_accept() while we'd come from dequeue_all_listeners().
582 */
Willy Tarreau2b718102021-04-21 07:32:39 +0200583 if (MT_LIST_INLIST(&l->wait_queue))
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200584 goto end;
585
Aurelien DARRAGON23705992023-02-14 08:51:14 +0100586 if (!(l->flags & LI_F_FINALIZED) || l->state == LI_READY)
Willy Tarreau5d7f9ce2020-09-24 18:54:11 +0200587 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200588
Aurelien DARRAGON3bb2a382023-02-07 13:26:14 +0100589 if (l->rx.proto->resume) {
Willy Tarreaue03204c2020-10-09 17:02:21 +0200590 ret = l->rx.proto->resume(l);
Aurelien DARRAGON3bb2a382023-02-07 13:26:14 +0100591 if (!ret)
592 goto end; /* failure to resume */
593 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200594
Willy Tarreau758c69d2023-01-12 18:59:37 +0100595 if (l->bind_conf->maxconn && l->nbconn >= l->bind_conf->maxconn) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200596 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200597 listener_set_state(l, LI_FULL);
Willy Tarreau58651b42020-09-24 16:03:29 +0200598 goto done;
Willy Tarreaube58c382011-07-24 18:28:10 +0200599 }
600
Willy Tarreau4b51f422020-09-25 20:32:28 +0200601 l->rx.proto->enable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200602 listener_set_state(l, LI_READY);
Willy Tarreau58651b42020-09-24 16:03:29 +0200603
604 done:
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +0100605 if (px && (l->flags & LI_F_SUSPENDED))
606 px->li_suspended--;
607 l->flags &= ~LI_F_SUSPENDED;
608
Aurelien DARRAGONca8a4b22023-02-07 12:36:27 +0100609 if (px && (px->flags & PR_FL_PAUSED) && !px->li_suspended) {
Aurelien DARRAGONd46f4372022-09-09 15:51:37 +0200610 /* PROXY_LOCK is required */
611 proxy_cond_resume(px);
Willy Tarreau58651b42020-09-24 16:03:29 +0200612 ha_warning("Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
613 send_log(px, LOG_WARNING, "Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
614 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200615 end:
Aurelien DARRAGON4059e092023-02-06 17:06:03 +0100616 if (!lli)
617 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200618
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +0200619 if (!lpx && px)
Aurelien DARRAGON00132882022-09-09 15:32:57 +0200620 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
621
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200622 return ret;
623}
624
Aurelien DARRAGONbcad7e62023-02-15 09:30:54 +0100625/* Same as resume_listener(), but will only work to resume from
626 * LI_FULL or LI_LIMITED states because we try to relax listeners that
627 * were temporarily restricted and not to resume inactive listeners that
628 * may have been paused or completely stopped in the meantime.
629 * Returns positive value for success and 0 for failure.
630 * It will need to operate under the proxy's lock and the listener's lock.
631 * The caller is responsible for indicating in lpx, lli whether the respective
632 * locks are already held (non-zero) or not (zero) so that the function pick
633 * the missing ones, in this order.
634 */
635int relax_listener(struct listener *l, int lpx, int lli)
636{
Christopher Faulet6844af62023-07-20 14:53:50 +0200637 struct proxy *px = l->bind_conf->frontend;
Aurelien DARRAGONbcad7e62023-02-15 09:30:54 +0100638 int ret = 1;
639
Christopher Faulet6844af62023-07-20 14:53:50 +0200640 if (!lpx && px)
641 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
642
Aurelien DARRAGONbcad7e62023-02-15 09:30:54 +0100643 if (!lli)
644 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
645
646 if (l->state != LI_FULL && l->state != LI_LIMITED)
647 goto end; /* listener may be suspended or even stopped */
Christopher Faulet6844af62023-07-20 14:53:50 +0200648 ret = resume_listener(l, 1, 1);
Aurelien DARRAGONbcad7e62023-02-15 09:30:54 +0100649
650 end:
651 if (!lli)
652 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet6844af62023-07-20 14:53:50 +0200653
654 if (!lpx && px)
655 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
656
Aurelien DARRAGONbcad7e62023-02-15 09:30:54 +0100657 return ret;
658}
659
Willy Tarreau87b09662015-04-03 00:22:06 +0200660/* Marks a ready listener as full so that the stream code tries to re-enable
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +0100661 * it upon next close() using relax_listener().
Willy Tarreau62793712011-07-24 19:23:38 +0200662 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200663static void listener_full(struct listener *l)
Willy Tarreau62793712011-07-24 19:23:38 +0200664{
Willy Tarreau08b6f962022-02-01 16:23:00 +0100665 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200666 if (l->state >= LI_READY) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200667 MT_LIST_DELETE(&l->wait_queue);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100668 if (l->state != LI_FULL) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200669 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200670 listener_set_state(l, LI_FULL);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100671 }
Willy Tarreau62793712011-07-24 19:23:38 +0200672 }
Willy Tarreau08b6f962022-02-01 16:23:00 +0100673 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200674}
675
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200676/* Marks a ready listener as limited so that we only try to re-enable it when
677 * resources are free again. It will be queued into the specified queue.
678 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200679static void limit_listener(struct listener *l, struct mt_list *list)
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200680{
Willy Tarreau08b6f962022-02-01 16:23:00 +0100681 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200682 if (l->state == LI_READY) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200683 MT_LIST_TRY_APPEND(list, &l->wait_queue);
Willy Tarreau4b51f422020-09-25 20:32:28 +0200684 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200685 listener_set_state(l, LI_LIMITED);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200686 }
Willy Tarreau08b6f962022-02-01 16:23:00 +0100687 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200688}
689
Willy Tarreau241797a2019-12-10 14:10:52 +0100690/* Dequeues all listeners waiting for a resource the global wait queue */
691void dequeue_all_listeners()
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200692{
Willy Tarreau01abd022019-02-28 10:27:18 +0100693 struct listener *listener;
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200694
Willy Tarreau241797a2019-12-10 14:10:52 +0100695 while ((listener = MT_LIST_POP(&global_listener_queue, struct listener *, wait_queue))) {
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200696 /* This cannot fail because the listeners are by definition in
Willy Tarreau01abd022019-02-28 10:27:18 +0100697 * the LI_LIMITED state.
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200698 */
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +0100699 relax_listener(listener, 0, 0);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200700 }
701}
702
Willy Tarreau241797a2019-12-10 14:10:52 +0100703/* Dequeues all listeners waiting for a resource in proxy <px>'s queue */
704void dequeue_proxy_listeners(struct proxy *px)
705{
706 struct listener *listener;
707
708 while ((listener = MT_LIST_POP(&px->listener_queue, struct listener *, wait_queue))) {
709 /* This cannot fail because the listeners are by definition in
710 * the LI_LIMITED state.
711 */
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +0100712 relax_listener(listener, 0, 0);
Willy Tarreau241797a2019-12-10 14:10:52 +0100713 }
714}
715
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200716
717/* default function used to unbind a listener. This is for use by standard
718 * protocols working on top of accepted sockets. The receiver's rx_unbind()
719 * will automatically be used after the listener is disabled if the socket is
720 * still bound. This must be used under the listener's lock.
Christopher Faulet510c0d62018-03-16 10:04:47 +0100721 */
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200722void default_unbind_listener(struct listener *listener)
Willy Tarreaub648d632007-10-28 22:13:50 +0100723{
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200724 if (listener->state <= LI_ASSIGNED)
725 goto out_close;
726
727 if (listener->rx.fd == -1) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200728 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200729 goto out_close;
730 }
731
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200732 if (listener->state >= LI_READY) {
733 listener->rx.proto->disable(listener);
734 if (listener->rx.flags & RX_F_BOUND)
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200735 listener_set_state(listener, LI_LISTEN);
Willy Tarreaub6607bf2020-09-23 16:24:23 +0200736 }
737
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200738 out_close:
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200739 if (listener->rx.flags & RX_F_BOUND)
740 listener->rx.proto->rx_unbind(&listener->rx);
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200741}
742
743/* This function closes the listening socket for the specified listener,
744 * provided that it's already in a listening state. The protocol's unbind()
745 * is called to put the listener into LI_ASSIGNED or LI_LISTEN and handle
746 * the unbinding tasks. The listener enters then the LI_ASSIGNED state if
747 * the receiver is unbound. Must be called with the lock held.
748 */
749void do_unbind_listener(struct listener *listener)
750{
Willy Tarreau2b718102021-04-21 07:32:39 +0200751 MT_LIST_DELETE(&listener->wait_queue);
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200752
753 if (listener->rx.proto->unbind)
754 listener->rx.proto->unbind(listener);
Willy Tarreau374e9af2020-10-09 15:47:17 +0200755
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200756 /* we may have to downgrade the listener if the rx was closed */
757 if (!(listener->rx.flags & RX_F_BOUND) && listener->state > LI_ASSIGNED)
Willy Tarreau374e9af2020-10-09 15:47:17 +0200758 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100759}
760
Olivier Houchard1fc05162017-04-06 01:05:05 +0200761/* This function closes the listening socket for the specified listener,
762 * provided that it's already in a listening state. The listener enters the
Willy Tarreau75c98d12020-10-09 15:55:23 +0200763 * LI_ASSIGNED state, except if the FD is not closed, in which case it may
764 * remain in LI_LISTEN. This function is intended to be used as a generic
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100765 * function for standard protocols.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200766 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100767void unbind_listener(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200768{
Willy Tarreau08b6f962022-02-01 16:23:00 +0100769 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau75c98d12020-10-09 15:55:23 +0200770 do_unbind_listener(listener);
Willy Tarreau08b6f962022-02-01 16:23:00 +0100771 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200772}
773
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200774/* creates one or multiple listeners for bind_conf <bc> on sockaddr <ss> on port
775 * range <portl> to <porth>, and possibly attached to fd <fd> (or -1 for auto
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200776 * allocation). The address family is taken from ss->ss_family, and the protocol
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200777 * passed in <proto> must be usable on this family. The protocol's default iocb
778 * is automatically preset as the receivers' iocb. The number of jobs and
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200779 * listeners is automatically increased by the number of listeners created. It
780 * returns non-zero on success, zero on error with the error message set in <err>.
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200781 */
782int create_listeners(struct bind_conf *bc, const struct sockaddr_storage *ss,
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200783 int portl, int porth, int fd, struct protocol *proto, char **err)
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200784{
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200785 struct listener *l;
786 int port;
787
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200788 for (port = portl; port <= porth; port++) {
789 l = calloc(1, sizeof(*l));
790 if (!l) {
791 memprintf(err, "out of memory");
792 return 0;
793 }
794 l->obj_type = OBJ_TYPE_LISTENER;
Willy Tarreau2b718102021-04-21 07:32:39 +0200795 LIST_APPEND(&bc->frontend->conf.listeners, &l->by_fe);
796 LIST_APPEND(&bc->listeners, &l->by_bind);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200797 l->bind_conf = bc;
Willy Tarreau0fce6bc2020-09-03 07:46:06 +0200798 l->rx.settings = &bc->settings;
Willy Tarreaueef45422020-09-03 10:05:03 +0200799 l->rx.owner = l;
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200800 l->rx.iocb = proto->default_iocb;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200801 l->rx.fd = fd;
Willy Tarreau07400c52020-12-04 14:49:11 +0100802
Willy Tarreau37159062020-08-27 07:48:42 +0200803 memcpy(&l->rx.addr, ss, sizeof(*ss));
Willy Tarreaud1f250f2020-12-04 15:03:36 +0100804 if (proto->fam->set_port)
805 proto->fam->set_port(&l->rx.addr, port);
Willy Tarreau07400c52020-12-04 14:49:11 +0100806
Olivier Houchard859dc802019-08-08 15:47:21 +0200807 MT_LIST_INIT(&l->wait_queue);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200808 listener_set_state(l, LI_INIT);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200809
Willy Tarreaud1f250f2020-12-04 15:03:36 +0100810 proto->add(proto, l);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200811
Willy Tarreau909c23b2020-09-15 13:50:58 +0200812 if (fd != -1)
Willy Tarreau43046fa2020-09-01 15:41:59 +0200813 l->rx.flags |= RX_F_INHERITED;
William Lallemand75ea0a02017-11-15 19:02:58 +0100814
Amaury Denoyelle7f8f6cb2020-11-10 14:24:31 +0100815 l->extra_counters = NULL;
816
Willy Tarreau08b6f962022-02-01 16:23:00 +0100817 HA_RWLOCK_INIT(&l->lock);
Willy Tarreau4781b152021-04-06 13:53:36 +0200818 _HA_ATOMIC_INC(&jobs);
819 _HA_ATOMIC_INC(&listeners);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200820 }
821 return 1;
822}
823
Willy Tarreauaae18102023-03-01 18:25:58 +0100824/* Optionally allocates a new shard info (if si == NULL) for receiver rx and
825 * assigns it to it, or attaches to an existing one. If the rx already had a
826 * shard_info, it is simply returned. It is illegal to call this function with
827 * an rx that's part of a group that is already attached. Attaching means the
828 * shard_info's thread count and group count are updated so the rx's group is
829 * added to the shard_info's group mask. The rx are added to the members in the
830 * attachment order, though it must not matter. It is meant for boot time setup
831 * and is not thread safe. NULL is returned on allocation failure.
832 */
833struct shard_info *shard_info_attach(struct receiver *rx, struct shard_info *si)
834{
835 if (rx->shard_info)
836 return rx->shard_info;
837
838 if (!si) {
839 si = calloc(1, sizeof(*si));
840 if (!si)
841 return NULL;
842
843 si->ref = rx;
844 }
845
846 rx->shard_info = si;
847 BUG_ON (si->tgroup_mask & 1UL << (rx->bind_tgroup - 1));
848 si->tgroup_mask |= 1UL << (rx->bind_tgroup - 1);
849 si->nbgroups = my_popcountl(si->tgroup_mask);
850 si->nbthreads += my_popcountl(rx->bind_thread);
851 si->members[si->nbgroups - 1] = rx;
852 return si;
853}
854
855/* Detaches the rx from an optional shard_info it may be attached to. If so,
856 * the thread counts, group masks and refcounts are updated. The members list
857 * remains contiguous by replacing the current entry with the last one. The
858 * reference continues to point to the first receiver. If the group count
859 * reaches zero, the shard_info is automatically released.
860 */
861void shard_info_detach(struct receiver *rx)
862{
863 struct shard_info *si = rx->shard_info;
864 uint gr;
865
866 if (!si)
867 return;
868
869 rx->shard_info = NULL;
870
871 /* find the member slot this rx was attached to */
872 for (gr = 0; gr < MAX_TGROUPS && si->members[gr] != rx; gr++)
873 ;
874
875 BUG_ON(gr == MAX_TGROUPS);
876
877 si->nbthreads -= my_popcountl(rx->bind_thread);
878 si->tgroup_mask &= ~(1UL << (rx->bind_tgroup - 1));
879 si->nbgroups = my_popcountl(si->tgroup_mask);
880
881 /* replace the member by the last one. If we removed the reference, we
882 * have to switch to another one. It's always the first entry so we can
883 * simply enforce it upon every removal.
884 */
885 si->members[gr] = si->members[si->nbgroups];
886 si->members[si->nbgroups] = NULL;
887 si->ref = si->members[0];
888
889 if (!si->nbgroups)
890 free(si);
891}
892
Willy Tarreau59a877d2021-10-12 09:36:10 +0200893/* clones listener <src> and returns the new one. All dynamically allocated
894 * fields are reallocated (name for now). The new listener is inserted before
895 * the original one in the bind_conf and frontend lists. This allows it to be
896 * duplicated while iterating over the current list. The original listener must
897 * only be in the INIT or ASSIGNED states, and the new listener will only be
898 * placed into the INIT state. The counters are always set to NULL. Maxsock is
Willy Tarreauaae18102023-03-01 18:25:58 +0100899 * updated. Returns NULL on allocation error. The shard_info is never taken so
900 * that the caller can decide what to do with it depending on how it intends to
901 * clone the listener.
Willy Tarreau59a877d2021-10-12 09:36:10 +0200902 */
903struct listener *clone_listener(struct listener *src)
904{
905 struct listener *l;
906
907 l = calloc(1, sizeof(*l));
908 if (!l)
909 goto oom1;
910 memcpy(l, src, sizeof(*l));
911
912 if (l->name) {
913 l->name = strdup(l->name);
914 if (!l->name)
915 goto oom2;
916 }
917
918 l->rx.owner = l;
Willy Tarreauaae18102023-03-01 18:25:58 +0100919 l->rx.shard_info = NULL;
Willy Tarreau59a877d2021-10-12 09:36:10 +0200920 l->state = LI_INIT;
921 l->counters = NULL;
922 l->extra_counters = NULL;
923
924 LIST_APPEND(&src->by_fe, &l->by_fe);
925 LIST_APPEND(&src->by_bind, &l->by_bind);
926
927 MT_LIST_INIT(&l->wait_queue);
928
929 l->rx.proto->add(l->rx.proto, l);
930
Willy Tarreau08b6f962022-02-01 16:23:00 +0100931 HA_RWLOCK_INIT(&l->lock);
Willy Tarreau59a877d2021-10-12 09:36:10 +0200932 _HA_ATOMIC_INC(&jobs);
933 _HA_ATOMIC_INC(&listeners);
934 global.maxsock++;
935 return l;
936
Willy Tarreau59a877d2021-10-12 09:36:10 +0200937 oom2:
938 free(l);
939 oom1:
Willy Tarreaua1462892021-10-16 14:45:29 +0200940 return NULL;
Willy Tarreau59a877d2021-10-12 09:36:10 +0200941}
942
Willy Tarreau1a64d162007-10-28 22:26:05 +0100943/* Delete a listener from its protocol's list of listeners. The listener's
944 * state is automatically updated from LI_ASSIGNED to LI_INIT. The protocol's
Willy Tarreau2cc5bae2017-09-15 08:18:11 +0200945 * number of listeners is updated, as well as the global number of listeners
946 * and jobs. Note that the listener must have previously been unbound. This
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200947 * is a low-level function expected to be called with the proto_lock and the
948 * listener's lock held.
Willy Tarreau1a64d162007-10-28 22:26:05 +0100949 */
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200950void __delete_listener(struct listener *listener)
Willy Tarreau1a64d162007-10-28 22:26:05 +0100951{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100952 if (listener->state == LI_ASSIGNED) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200953 listener_set_state(listener, LI_INIT);
Willy Tarreau2b718102021-04-21 07:32:39 +0200954 LIST_DELETE(&listener->rx.proto_list);
Willy Tarreauaae18102023-03-01 18:25:58 +0100955 shard_info_detach(&listener->rx);
Willy Tarreaud7f331c2020-09-25 17:01:43 +0200956 listener->rx.proto->nb_receivers--;
Willy Tarreau4781b152021-04-06 13:53:36 +0200957 _HA_ATOMIC_DEC(&jobs);
958 _HA_ATOMIC_DEC(&listeners);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100959 }
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200960}
961
962/* Delete a listener from its protocol's list of listeners (please check
963 * __delete_listener() above). The proto_lock and the listener's lock will
964 * be grabbed in this order.
965 */
966void delete_listener(struct listener *listener)
967{
968 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Willy Tarreau08b6f962022-02-01 16:23:00 +0100969 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200970 __delete_listener(listener);
Willy Tarreau08b6f962022-02-01 16:23:00 +0100971 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau6ee9f8d2019-08-26 10:55:52 +0200972 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100973}
974
Willy Tarreaue2711c72019-02-27 15:39:41 +0100975/* Returns a suitable value for a listener's backlog. It uses the listener's,
976 * otherwise the frontend's backlog, otherwise the listener's maxconn,
977 * otherwise the frontend's maxconn, otherwise 1024.
978 */
979int listener_backlog(const struct listener *l)
980{
Willy Tarreau1920f892023-01-12 18:55:13 +0100981 if (l->bind_conf->backlog)
982 return l->bind_conf->backlog;
Willy Tarreaue2711c72019-02-27 15:39:41 +0100983
984 if (l->bind_conf->frontend->backlog)
985 return l->bind_conf->frontend->backlog;
986
Willy Tarreau758c69d2023-01-12 18:59:37 +0100987 if (l->bind_conf->maxconn)
988 return l->bind_conf->maxconn;
Willy Tarreaue2711c72019-02-27 15:39:41 +0100989
990 if (l->bind_conf->frontend->maxconn)
991 return l->bind_conf->frontend->maxconn;
992
993 return 1024;
994}
995
Amaury Denoyelle331b8b12023-10-25 10:52:23 +0200996/* Returns true if listener <l> must check maxconn limit prior to accept. */
997static inline int listener_uses_maxconn(const struct listener *l)
998{
999 return !(l->bind_conf->options & (BC_O_UNLIMITED|BC_O_XPRT_MAXCONN));
1000}
1001
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001002/* This function is called on a read event from a listening socket, corresponding
1003 * to an accept. It tries to accept as many connections as possible, and for each
1004 * calls the listener's accept handler (generally the frontend's accept handler).
1005 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001006void listener_accept(struct listener *l)
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001007{
Willy Tarreau83efc322020-10-14 17:37:17 +02001008 struct connection *cli_conn;
Olivier Houchardd16a9df2019-02-25 16:18:16 +01001009 struct proxy *p;
Christopher Faulet102854c2019-04-30 12:17:13 +02001010 unsigned int max_accept;
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001011 int next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +01001012 int next_feconn = 0;
1013 int next_actconn = 0;
Willy Tarreaubb660302014-05-07 19:47:02 +02001014 int expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001015 int ret;
1016
Olivier Houchardd16a9df2019-02-25 16:18:16 +01001017 p = l->bind_conf->frontend;
Christopher Faulet102854c2019-04-30 12:17:13 +02001018
Willy Tarreau882f2482023-01-12 18:52:23 +01001019 /* if l->bind_conf->maxaccept is -1, then max_accept is UINT_MAX. It is
1020 * not really illimited, but it is probably enough.
Christopher Faulet102854c2019-04-30 12:17:13 +02001021 */
Willy Tarreau882f2482023-01-12 18:52:23 +01001022 max_accept = l->bind_conf->maxaccept ? l->bind_conf->maxaccept : 1;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001023
Willy Tarreau17146802023-01-12 19:58:42 +01001024 if (!(l->bind_conf->options & BC_O_UNLIMITED) && global.sps_lim) {
Willy Tarreau93e7c002013-10-07 18:51:07 +02001025 int max = freq_ctr_remain(&global.sess_per_sec, global.sps_lim, 0);
Willy Tarreau93e7c002013-10-07 18:51:07 +02001026
1027 if (unlikely(!max)) {
1028 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +02001029 expire = tick_add(now_ms, next_event_delay(&global.sess_per_sec, global.sps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +01001030 goto limit_global;
Willy Tarreau93e7c002013-10-07 18:51:07 +02001031 }
1032
1033 if (max_accept > max)
1034 max_accept = max;
1035 }
1036
Willy Tarreau17146802023-01-12 19:58:42 +01001037 if (!(l->bind_conf->options & BC_O_UNLIMITED) && global.cps_lim) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001038 int max = freq_ctr_remain(&global.conn_per_sec, global.cps_lim, 0);
1039
1040 if (unlikely(!max)) {
1041 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +02001042 expire = tick_add(now_ms, next_event_delay(&global.conn_per_sec, global.cps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +01001043 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001044 }
1045
1046 if (max_accept > max)
1047 max_accept = max;
1048 }
Willy Tarreaue43d5322013-10-07 20:01:52 +02001049#ifdef USE_OPENSSL
Willy Tarreau17146802023-01-12 19:58:42 +01001050 if (!(l->bind_conf->options & BC_O_UNLIMITED) && global.ssl_lim &&
Willy Tarreau11ba4042022-05-20 15:56:32 +02001051 l->bind_conf && l->bind_conf->options & BC_O_USE_SSL) {
Willy Tarreaue43d5322013-10-07 20:01:52 +02001052 int max = freq_ctr_remain(&global.ssl_per_sec, global.ssl_lim, 0);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001053
Willy Tarreaue43d5322013-10-07 20:01:52 +02001054 if (unlikely(!max)) {
1055 /* frontend accept rate limit was reached */
Willy Tarreaue43d5322013-10-07 20:01:52 +02001056 expire = tick_add(now_ms, next_event_delay(&global.ssl_per_sec, global.ssl_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +01001057 goto limit_global;
Willy Tarreaue43d5322013-10-07 20:01:52 +02001058 }
1059
1060 if (max_accept > max)
1061 max_accept = max;
1062 }
1063#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001064 if (p && p->fe_sps_lim) {
1065 int max = freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0);
1066
1067 if (unlikely(!max)) {
1068 /* frontend accept rate limit was reached */
Willy Tarreau0591bf72019-12-10 12:01:21 +01001069 expire = tick_add(now_ms, next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0));
1070 goto limit_proxy;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001071 }
1072
1073 if (max_accept > max)
1074 max_accept = max;
1075 }
1076
1077 /* Note: if we fail to allocate a connection because of configured
1078 * limits, we'll schedule a new attempt worst 1 second later in the
1079 * worst case. If we fail due to system limits or temporary resource
1080 * shortage, we try again 100ms later in the worst case.
1081 */
Willy Tarreau02757d02021-01-28 18:07:24 +01001082 for (; max_accept; next_conn = next_feconn = next_actconn = 0, max_accept--) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001083 unsigned int count;
Willy Tarreau9378bbe2020-10-15 10:09:31 +02001084 int status;
Willy Tarreau0aa5a5b2020-10-16 17:43:04 +02001085 __decl_thread(unsigned long mask);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001086
Willy Tarreau82c97892019-02-27 19:32:32 +01001087 /* pre-increase the number of connections without going too far.
1088 * We process the listener, then the proxy, then the process.
1089 * We know which ones to unroll based on the next_xxx value.
1090 */
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001091 do {
1092 count = l->nbconn;
Willy Tarreau758c69d2023-01-12 18:59:37 +01001093 if (unlikely(l->bind_conf->maxconn && count >= l->bind_conf->maxconn)) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001094 /* the listener was marked full or another
1095 * thread is going to do it.
1096 */
1097 next_conn = 0;
Willy Tarreau93604ed2019-11-15 10:20:07 +01001098 listener_full(l);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001099 goto end;
1100 }
1101 next_conn = count + 1;
David Carlier56716622019-03-27 16:08:42 +00001102 } while (!_HA_ATOMIC_CAS(&l->nbconn, (int *)(&count), next_conn));
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001103
Willy Tarreau82c97892019-02-27 19:32:32 +01001104 if (p) {
1105 do {
1106 count = p->feconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +01001107 if (unlikely(count >= p->maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +01001108 /* the frontend was marked full or another
1109 * thread is going to do it.
1110 */
1111 next_feconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +01001112 expire = TICK_ETERNITY;
1113 goto limit_proxy;
Willy Tarreau82c97892019-02-27 19:32:32 +01001114 }
1115 next_feconn = count + 1;
Olivier Houchard64213e92019-03-08 18:52:57 +01001116 } while (!_HA_ATOMIC_CAS(&p->feconn, &count, next_feconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001117 }
1118
Amaury Denoyelle331b8b12023-10-25 10:52:23 +02001119 if (listener_uses_maxconn(l)) {
Amaury Denoyelle8ee9fc72023-10-25 15:32:28 +02001120 next_actconn = increment_actconn();
1121 if (!next_actconn) {
1122 /* the process was marked full or another
1123 * thread is going to do it.
1124 */
1125 expire = tick_add(now_ms, 1000); /* try again in 1 second */
1126 goto limit_global;
1127 }
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001128 }
1129
Willy Tarreaufed93d32022-02-01 16:37:00 +01001130 /* be careful below, the listener might be shutting down in
1131 * another thread on error and we must not dereference its
1132 * FD without a bit of protection.
1133 */
1134 cli_conn = NULL;
1135 status = CO_AC_PERMERR;
1136
1137 HA_RWLOCK_RDLOCK(LISTENER_LOCK, &l->lock);
1138 if (l->rx.flags & RX_F_BOUND)
1139 cli_conn = l->rx.proto->accept_conn(l, &status);
1140 HA_RWLOCK_RDUNLOCK(LISTENER_LOCK, &l->lock);
1141
Willy Tarreau9378bbe2020-10-15 10:09:31 +02001142 if (!cli_conn) {
1143 switch (status) {
1144 case CO_AC_DONE:
1145 goto end;
Willy Tarreau818dca52014-01-31 19:40:19 +01001146
Willy Tarreau9378bbe2020-10-15 10:09:31 +02001147 case CO_AC_RETRY: /* likely a signal */
Willy Tarreau4781b152021-04-06 13:53:36 +02001148 _HA_ATOMIC_DEC(&l->nbconn);
Willy Tarreau82c97892019-02-27 19:32:32 +01001149 if (p)
Willy Tarreau4781b152021-04-06 13:53:36 +02001150 _HA_ATOMIC_DEC(&p->feconn);
Amaury Denoyelle331b8b12023-10-25 10:52:23 +02001151 if (listener_uses_maxconn(l))
Willy Tarreau4781b152021-04-06 13:53:36 +02001152 _HA_ATOMIC_DEC(&actconn);
Willy Tarreaua593ec52014-01-20 21:21:30 +01001153 continue;
Willy Tarreau9378bbe2020-10-15 10:09:31 +02001154
1155 case CO_AC_YIELD:
Willy Tarreau92079932019-12-10 09:30:05 +01001156 max_accept = 0;
1157 goto end;
William Lallemandd9138002018-11-27 12:02:39 +01001158
Willy Tarreau9378bbe2020-10-15 10:09:31 +02001159 default:
1160 goto transient_error;
Willy Tarreau83efc322020-10-14 17:37:17 +02001161 }
1162 }
1163
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001164 /* The connection was accepted, it must be counted as such */
1165 if (l->counters)
1166 HA_ATOMIC_UPDATE_MAX(&l->counters->conn_max, next_conn);
1167
Willy Tarreaud8679342022-05-09 20:41:54 +02001168 if (p) {
Willy Tarreau82c97892019-02-27 19:32:32 +01001169 HA_ATOMIC_UPDATE_MAX(&p->fe_counters.conn_max, next_feconn);
Willy Tarreaud8679342022-05-09 20:41:54 +02001170 proxy_inc_fe_conn_ctr(l, p);
1171 }
Willy Tarreau82c97892019-02-27 19:32:32 +01001172
Willy Tarreau17146802023-01-12 19:58:42 +01001173 if (!(l->bind_conf->options & BC_O_UNLIMITED)) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001174 count = update_freq_ctr(&global.conn_per_sec, 1);
1175 HA_ATOMIC_UPDATE_MAX(&global.cps_max, count);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001176 }
1177
Willy Tarreau4781b152021-04-06 13:53:36 +02001178 _HA_ATOMIC_INC(&activity[tid].accepted);
Willy Tarreau64a9c052019-04-12 15:27:17 +02001179
Willy Tarreau96151022023-05-11 13:51:31 +02001180 /* count the number of times an accepted connection resulted in
1181 * maxconn being reached.
1182 */
1183 if (unlikely(_HA_ATOMIC_LOAD(&actconn) + 1 >= global.maxconn))
1184 _HA_ATOMIC_INC(&maxconn_reached);
1185
Willy Tarreau30836152023-01-12 19:10:17 +01001186 /* past this point, l->bind_conf->accept() will automatically decrement
Willy Tarreau82c97892019-02-27 19:32:32 +01001187 * l->nbconn, feconn and actconn once done. Setting next_*conn=0
1188 * allows the error path not to rollback on nbconn. It's more
1189 * convenient than duplicating all exit labels.
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001190 */
1191 next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +01001192 next_feconn = 0;
1193 next_actconn = 0;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001194
Willy Tarreau83efc322020-10-14 17:37:17 +02001195
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001196#if defined(USE_THREAD)
Willy Tarreau9d360602023-03-27 10:38:51 +02001197 if (!(global.tune.options & GTUNE_LISTENER_MQ_ANY) || stopping)
1198 goto local_accept;
1199
1200 /* we want to perform thread rebalancing if the listener is
1201 * bound to more than one thread or if it's part of a shard
1202 * with more than one listener.
1203 */
Willy Tarreaub2f38c12023-01-19 19:14:18 +01001204 mask = l->rx.bind_thread & _HA_ATOMIC_LOAD(&tg->threads_enabled);
Willy Tarreau9d360602023-03-27 10:38:51 +02001205 if (l->rx.shard_info || atleast2(mask)) {
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001206 struct accept_queue_ring *ring;
Willy Tarreau9d360602023-03-27 10:38:51 +02001207 struct listener *new_li;
Willy Tarreauff185042023-04-20 16:52:21 +02001208 uint r1, r2, t, t1, t2;
1209 ulong n0, n1;
Willy Tarreau9d360602023-03-27 10:38:51 +02001210 const struct tgroup_info *g1, *g2;
1211 ulong m1, m2;
Willy Tarreauff185042023-04-20 16:52:21 +02001212 ulong *thr_idx_ptr;
Willy Tarreaufc630bd2019-03-04 19:57:34 +01001213
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001214 /* The principle is that we have two running indexes,
1215 * each visiting in turn all threads bound to this
Willy Tarreau9d360602023-03-27 10:38:51 +02001216 * listener's shard. The connection will be assigned to
1217 * the one with the least connections, and the other
1218 * one will be updated. This provides a good fairness
1219 * on short connections (round robin) and on long ones
1220 * (conn count), without ever missing any idle thread.
1221 * Each thread number is encoded as a combination of
1222 * times the receiver number and its local thread
1223 * number from 0 to MAX_THREADS_PER_GROUP - 1. The two
Willy Tarreauff185042023-04-20 16:52:21 +02001224 * indexes are stored as 10/12 bit numbers in the thr_idx
1225 * array, since there are up to LONGBITS threads and
1226 * groups that can be represented. They are represented
1227 * like this:
1228 * 31:20 19:15 14:10 9:5 4:0
1229 * 32b: [ counter | r2num | t2num | r1num | t1num ]
1230 *
1231 * 63:24 23:18 17:12 11:6 5:0
1232 * 64b: [ counter | r2num | t2num | r1num | t1num ]
1233 *
1234 * The change counter is only used to avoid swapping too
1235 * old a value when the value loops back.
Willy Tarreau9d360602023-03-27 10:38:51 +02001236 *
1237 * In the loop below we have this for each index:
1238 * - n is the thread index
1239 * - r is the receiver number
1240 * - g is the receiver's thread group
1241 * - t is the thread number in this receiver
1242 * - m is the receiver's thread mask shifted by the thread number
Willy Tarreaufc630bd2019-03-04 19:57:34 +01001243 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001244
1245 /* keep a copy for the final update. thr_idx is composite
Willy Tarreau9d360602023-03-27 10:38:51 +02001246 * and made of (n2<<16) + n1.
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001247 */
Willy Tarreaub6574922023-03-29 17:02:17 +02001248 thr_idx_ptr = l->rx.shard_info ? &((struct listener *)(l->rx.shard_info->ref->owner))->thr_idx : &l->thr_idx;
Willy Tarreau9d360602023-03-27 10:38:51 +02001249 while (1) {
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001250 int q0, q1, q2;
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001251
Willy Tarreauff185042023-04-20 16:52:21 +02001252 /* calculate r1/g1/t1 first (ascending idx) */
1253 n0 = _HA_ATOMIC_LOAD(thr_idx_ptr);
Willy Tarreau9d360602023-03-27 10:38:51 +02001254 new_li = NULL;
1255
Willy Tarreauff185042023-04-20 16:52:21 +02001256 t1 = (uint)n0 & (LONGBITS - 1);
1257 r1 = ((uint)n0 / LONGBITS) & (LONGBITS - 1);
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001258
Willy Tarreau9d360602023-03-27 10:38:51 +02001259 while (1) {
1260 if (l->rx.shard_info) {
1261 /* multiple listeners, take the group into account */
1262 if (r1 >= l->rx.shard_info->nbgroups)
1263 r1 = 0;
1264
1265 g1 = &ha_tgroup_info[l->rx.shard_info->members[r1]->bind_tgroup - 1];
1266 m1 = l->rx.shard_info->members[r1]->bind_thread;
1267 } else {
1268 /* single listener */
1269 r1 = 0;
1270 g1 = tg;
1271 m1 = l->rx.bind_thread;
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001272 }
Willy Tarreau9d360602023-03-27 10:38:51 +02001273 m1 &= _HA_ATOMIC_LOAD(&g1->threads_enabled);
1274 m1 >>= t1;
1275
1276 /* find first existing thread */
1277 if (unlikely(!(m1 & 1))) {
1278 m1 &= ~1UL;
1279 if (!m1) {
1280 /* no more threads here, switch to
1281 * first thread of next group.
1282 */
1283 t1 = 0;
1284 if (l->rx.shard_info)
1285 r1++;
1286 /* loop again */
1287 continue;
1288 }
1289 t1 += my_ffsl(m1) - 1;
1290 }
1291 /* done: r1 and t1 are OK */
1292 break;
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001293 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001294
Willy Tarreauff185042023-04-20 16:52:21 +02001295 /* now r2/g2/t2 (descending idx) */
1296 t2 = ((uint)n0 / LONGBITS / LONGBITS) & (LONGBITS - 1);
1297 r2 = ((uint)n0 / LONGBITS / LONGBITS / LONGBITS) & (LONGBITS - 1);
Willy Tarreau9d360602023-03-27 10:38:51 +02001298
Willy Tarreau84fe1f42023-04-20 15:40:38 +02001299 /* if running in round-robin mode ("fair"), we don't need
1300 * to go further.
1301 */
1302 if ((global.tune.options & GTUNE_LISTENER_MQ_ANY) == GTUNE_LISTENER_MQ_FAIR) {
Willy Tarreau9d360602023-03-27 10:38:51 +02001303 t = g1->base + t1;
1304 if (l->rx.shard_info && t != tid)
1305 new_li = l->rx.shard_info->members[r1]->owner;
Willy Tarreau84fe1f42023-04-20 15:40:38 +02001306 goto updt_t1;
1307 }
1308
Willy Tarreau9d360602023-03-27 10:38:51 +02001309 while (1) {
1310 if (l->rx.shard_info) {
1311 /* multiple listeners, take the group into account */
1312 if (r2 >= l->rx.shard_info->nbgroups)
1313 r2 = l->rx.shard_info->nbgroups - 1;
Willy Tarreau85d04242019-04-16 18:09:13 +02001314
Willy Tarreau9d360602023-03-27 10:38:51 +02001315 g2 = &ha_tgroup_info[l->rx.shard_info->members[r2]->bind_tgroup - 1];
1316 m2 = l->rx.shard_info->members[r2]->bind_thread;
1317 } else {
1318 /* single listener */
1319 r2 = 0;
1320 g2 = tg;
1321 m2 = l->rx.bind_thread;
1322 }
1323 m2 &= _HA_ATOMIC_LOAD(&g2->threads_enabled);
1324 m2 &= nbits(t2 + 1);
1325
1326 /* find previous existing thread */
1327 if (unlikely(!(m2 & (1UL << t2)) || (g1 == g2 && t1 == t2))) {
1328 /* highest bit not set or colliding threads, let's check
1329 * if we still have other threads available after this
1330 * one.
1331 */
1332 m2 &= ~(1UL << t2);
1333 if (!m2) {
1334 /* no more threads here, switch to
1335 * last thread of previous group.
1336 */
1337 t2 = MAX_THREADS_PER_GROUP - 1;
1338 if (l->rx.shard_info)
1339 r2--;
1340 /* loop again */
1341 continue;
1342 }
1343 t2 = my_flsl(m2) - 1;
1344 }
1345 /* done: r2 and t2 are OK */
1346 break;
Willy Tarreau85d04242019-04-16 18:09:13 +02001347 }
1348
Willy Tarreau77e33502023-04-19 17:19:28 +02001349 /* tests show that it's worth checking that other threads have not
1350 * already changed the index to save the rest of the calculation,
1351 * or we'd have to redo it anyway.
1352 */
Willy Tarreauff185042023-04-20 16:52:21 +02001353 if (n0 != _HA_ATOMIC_LOAD(thr_idx_ptr))
Willy Tarreau77e33502023-04-19 17:19:28 +02001354 continue;
Willy Tarreau77e33502023-04-19 17:19:28 +02001355
Willy Tarreau9d360602023-03-27 10:38:51 +02001356 /* here we have (r1,g1,t1) that designate the first receiver, its
1357 * thread group and local thread, and (r2,g2,t2) that designate
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001358 * the second receiver, its thread group and local thread. We'll
1359 * also consider the local thread with q0.
Willy Tarreau9d360602023-03-27 10:38:51 +02001360 */
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001361 q0 = accept_queue_ring_len(&accept_queue_rings[tid]);
Willy Tarreau9d360602023-03-27 10:38:51 +02001362 q1 = accept_queue_ring_len(&accept_queue_rings[g1->base + t1]);
1363 q2 = accept_queue_ring_len(&accept_queue_rings[g2->base + t2]);
1364
1365 /* add to this the currently active connections */
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001366 q0 += _HA_ATOMIC_LOAD(&l->thr_conn[ti->ltid]);
Willy Tarreau9d360602023-03-27 10:38:51 +02001367 if (l->rx.shard_info) {
1368 q1 += _HA_ATOMIC_LOAD(&((struct listener *)l->rx.shard_info->members[r1]->owner)->thr_conn[t1]);
1369 q2 += _HA_ATOMIC_LOAD(&((struct listener *)l->rx.shard_info->members[r2]->owner)->thr_conn[t2]);
1370 } else {
1371 q1 += _HA_ATOMIC_LOAD(&l->thr_conn[t1]);
1372 q2 += _HA_ATOMIC_LOAD(&l->thr_conn[t2]);
1373 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001374
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001375 /* we have 3 possibilities now :
1376 * q1 < q2 : t1 is less loaded than t2, so we pick it
1377 * and update t2 (since t1 might still be
1378 * lower than another thread)
1379 * q1 > q2 : t2 is less loaded than t1, so we pick it
1380 * and update t1 (since t2 might still be
1381 * lower than another thread)
1382 * q1 = q2 : both are equally loaded, thus we pick t1
1383 * and update t1 as it will become more loaded
1384 * than t2.
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001385 * On top of that, if in the end the current thread appears
1386 * to be as good of a deal, we'll prefer it over a foreign
1387 * one as it will improve locality and avoid a migration.
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001388 */
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001389
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001390 if (q1 - q2 < 0) {
Willy Tarreau9d360602023-03-27 10:38:51 +02001391 t = g1->base + t1;
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001392 if (q0 <= q1)
1393 t = tid;
Willy Tarreau9d360602023-03-27 10:38:51 +02001394
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001395 if (l->rx.shard_info && t != tid)
Willy Tarreau9d360602023-03-27 10:38:51 +02001396 new_li = l->rx.shard_info->members[r1]->owner;
1397
1398 t2--;
1399 if (t2 >= MAX_THREADS_PER_GROUP) {
1400 if (l->rx.shard_info)
1401 r2--;
1402 t2 = MAX_THREADS_PER_GROUP - 1;
1403 }
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001404 }
1405 else if (q1 - q2 > 0) {
Willy Tarreau9d360602023-03-27 10:38:51 +02001406 t = g2->base + t2;
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001407 if (q0 <= q2)
1408 t = tid;
Willy Tarreau9d360602023-03-27 10:38:51 +02001409
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001410 if (l->rx.shard_info && t != tid)
Willy Tarreau9d360602023-03-27 10:38:51 +02001411 new_li = l->rx.shard_info->members[r2]->owner;
1412 goto updt_t1;
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001413 }
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001414 else { // q1 == q2
Willy Tarreau9d360602023-03-27 10:38:51 +02001415 t = g1->base + t1;
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001416 if (q0 < q1) // local must be strictly better than both
1417 t = tid;
Willy Tarreau9d360602023-03-27 10:38:51 +02001418
Willy Tarreau8adffaa2023-04-19 18:06:16 +02001419 if (l->rx.shard_info && t != tid)
Willy Tarreau9d360602023-03-27 10:38:51 +02001420 new_li = l->rx.shard_info->members[r1]->owner;
Willy Tarreau84fe1f42023-04-20 15:40:38 +02001421 updt_t1:
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001422 t1++;
Willy Tarreau9d360602023-03-27 10:38:51 +02001423 if (t1 >= MAX_THREADS_PER_GROUP) {
1424 if (l->rx.shard_info)
1425 r1++;
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001426 t1 = 0;
Willy Tarreau9d360602023-03-27 10:38:51 +02001427 }
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001428 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001429
Willy Tarreauff185042023-04-20 16:52:21 +02001430 /* The target thread number is in <t> now. Let's
1431 * compute the new index and try to update it.
1432 */
Willy Tarreau9d360602023-03-27 10:38:51 +02001433
Willy Tarreauff185042023-04-20 16:52:21 +02001434 /* take previous counter and increment it */
1435 n1 = n0 & -(ulong)(LONGBITS * LONGBITS * LONGBITS * LONGBITS);
1436 n1 += LONGBITS * LONGBITS * LONGBITS * LONGBITS;
1437 n1 += (((r2 * LONGBITS) + t2) * LONGBITS * LONGBITS);
1438 n1 += (r1 * LONGBITS) + t1;
Willy Tarreaub6574922023-03-29 17:02:17 +02001439 if (likely(_HA_ATOMIC_CAS(thr_idx_ptr, &n0, n1)))
Willy Tarreau9d360602023-03-27 10:38:51 +02001440 break;
Willy Tarreauff185042023-04-20 16:52:21 +02001441
1442 /* bah we lost the race, try again */
1443 __ha_cpu_relax();
Willy Tarreau9d360602023-03-27 10:38:51 +02001444 } /* end of main while() loop */
1445
1446 /* we may need to update the listener in the connection
1447 * if we switched to another group.
1448 */
1449 if (new_li)
1450 cli_conn->target = &new_li->obj_type;
1451
1452 /* here we have the target thread number in <t> and we hold a
1453 * reservation in the target ring.
1454 */
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001455
Amaury Denoyellea66e0432023-04-05 18:16:28 +02001456 if (l->rx.proto && l->rx.proto->set_affinity) {
Willy Tarreau9d360602023-03-27 10:38:51 +02001457 if (l->rx.proto->set_affinity(cli_conn, t)) {
Amaury Denoyellea66e0432023-04-05 18:16:28 +02001458 /* Failed migration, stay on the same thread. */
1459 goto local_accept;
1460 }
1461 }
1462
Willy Tarreau0fe703b2019-03-05 08:46:28 +01001463 /* We successfully selected the best thread "t" for this
1464 * connection. We use deferred accepts even if it's the
1465 * local thread because tests show that it's the best
1466 * performing model, likely due to better cache locality
1467 * when processing this loop.
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001468 */
Willy Tarreau9d360602023-03-27 10:38:51 +02001469 ring = &accept_queue_rings[t];
Willy Tarreau83efc322020-10-14 17:37:17 +02001470 if (accept_queue_push_mp(ring, cli_conn)) {
Willy Tarreau9d360602023-03-27 10:38:51 +02001471 _HA_ATOMIC_INC(&activity[t].accq_pushed);
Willy Tarreau2bd65a72019-09-24 06:55:18 +02001472 tasklet_wakeup(ring->tasklet);
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001473 continue;
1474 }
1475 /* If the ring is full we do a synchronous accept on
1476 * the local thread here.
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001477 */
Willy Tarreau9d360602023-03-27 10:38:51 +02001478 _HA_ATOMIC_INC(&activity[t].accq_full);
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001479 }
1480#endif // USE_THREAD
1481
Amaury Denoyelle7f7713d2022-01-19 11:37:50 +01001482 local_accept:
Willy Tarreau9d360602023-03-27 10:38:51 +02001483 /* restore the connection's listener in case we failed to migrate above */
1484 cli_conn->target = &l->obj_type;
Willy Tarreaufea8c192023-02-28 10:25:57 +01001485 _HA_ATOMIC_INC(&l->thr_conn[ti->ltid]);
Willy Tarreau30836152023-01-12 19:10:17 +01001486 ret = l->bind_conf->accept(cli_conn);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001487 if (unlikely(ret <= 0)) {
Willy Tarreau87b09662015-04-03 00:22:06 +02001488 /* The connection was closed by stream_accept(). Either
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001489 * we just have to ignore it (ret == 0) or it's a critical
1490 * error due to a resource shortage, and we must stop the
1491 * listener (ret < 0).
1492 */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001493 if (ret == 0) /* successful termination */
1494 continue;
1495
Willy Tarreaubb660302014-05-07 19:47:02 +02001496 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001497 }
1498
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001499 /* increase the per-process number of cumulated sessions, this
Willy Tarreau30836152023-01-12 19:10:17 +01001500 * may only be done once l->bind_conf->accept() has accepted the
1501 * connection.
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001502 */
Willy Tarreau17146802023-01-12 19:58:42 +01001503 if (!(l->bind_conf->options & BC_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001504 count = update_freq_ctr(&global.sess_per_sec, 1);
1505 HA_ATOMIC_UPDATE_MAX(&global.sps_max, count);
Willy Tarreau93e7c002013-10-07 18:51:07 +02001506 }
Willy Tarreaue43d5322013-10-07 20:01:52 +02001507#ifdef USE_OPENSSL
Willy Tarreau17146802023-01-12 19:58:42 +01001508 if (!(l->bind_conf->options & BC_O_UNLIMITED) &&
Willy Tarreau11ba4042022-05-20 15:56:32 +02001509 l->bind_conf && l->bind_conf->options & BC_O_USE_SSL) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001510 count = update_freq_ctr(&global.ssl_per_sec, 1);
1511 HA_ATOMIC_UPDATE_MAX(&global.ssl_max, count);
Willy Tarreaue43d5322013-10-07 20:01:52 +02001512 }
1513#endif
Willy Tarreau93e7c002013-10-07 18:51:07 +02001514
Willy Tarreaubdcd3252022-06-22 09:19:46 +02001515 _HA_ATOMIC_AND(&th_ctx->flags, ~TH_FL_STUCK); // this thread is still running
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001516 } /* end of for (max_accept--) */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001517
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001518 end:
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001519 if (next_conn)
Willy Tarreau4781b152021-04-06 13:53:36 +02001520 _HA_ATOMIC_DEC(&l->nbconn);
Willy Tarreau741b4d62019-02-25 15:02:04 +01001521
Willy Tarreau82c97892019-02-27 19:32:32 +01001522 if (p && next_feconn)
Willy Tarreau4781b152021-04-06 13:53:36 +02001523 _HA_ATOMIC_DEC(&p->feconn);
Willy Tarreau82c97892019-02-27 19:32:32 +01001524
1525 if (next_actconn)
Willy Tarreau4781b152021-04-06 13:53:36 +02001526 _HA_ATOMIC_DEC(&actconn);
Willy Tarreau82c97892019-02-27 19:32:32 +01001527
Willy Tarreau758c69d2023-01-12 18:59:37 +01001528 if ((l->state == LI_FULL && (!l->bind_conf->maxconn || l->nbconn < l->bind_conf->maxconn)) ||
Willy Tarreau02757d02021-01-28 18:07:24 +01001529 (l->state == LI_LIMITED &&
Willy Tarreaucdcba112019-12-11 15:06:30 +01001530 ((!p || p->feconn < p->maxconn) && (actconn < global.maxconn) &&
1531 (!tick_isset(global_listener_queue_task->expire) ||
1532 tick_is_expired(global_listener_queue_task->expire, now_ms))))) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001533 /* at least one thread has to this when quitting */
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +01001534 relax_listener(l, 0, 0);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001535
Willy Tarreau02757d02021-01-28 18:07:24 +01001536 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001537 dequeue_all_listeners();
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001538
Olivier Houchard859dc802019-08-08 15:47:21 +02001539 if (p && !MT_LIST_ISEMPTY(&p->listener_queue) &&
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001540 (!p->fe_sps_lim || freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0) > 0))
Willy Tarreau241797a2019-12-10 14:10:52 +01001541 dequeue_proxy_listeners(p);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001542 }
Willy Tarreau0591bf72019-12-10 12:01:21 +01001543 return;
1544
1545 transient_error:
1546 /* pause the listener for up to 100 ms */
1547 expire = tick_add(now_ms, 100);
1548
Willy Tarreau258b3512020-10-13 17:46:05 +02001549 /* This may be a shared socket that was paused by another process.
1550 * Let's put it to pause in this case.
1551 */
1552 if (l->rx.proto && l->rx.proto->rx_listening(&l->rx) == 0) {
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +01001553 suspend_listener(l, 0, 0);
Willy Tarreau258b3512020-10-13 17:46:05 +02001554 goto end;
1555 }
1556
Willy Tarreau0591bf72019-12-10 12:01:21 +01001557 limit_global:
1558 /* (re-)queue the listener to the global queue and set it to expire no
1559 * later than <expire> ahead. The listener turns to LI_LIMITED.
1560 */
1561 limit_listener(l, &global_listener_queue);
Christopher Faulet13e86d92022-11-17 14:40:20 +01001562 HA_RWLOCK_RDLOCK(LISTENER_LOCK, &global_listener_rwlock);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001563 task_schedule(global_listener_queue_task, expire);
Christopher Faulet13e86d92022-11-17 14:40:20 +01001564 HA_RWLOCK_RDUNLOCK(LISTENER_LOCK, &global_listener_rwlock);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001565 goto end;
1566
1567 limit_proxy:
1568 /* (re-)queue the listener to the proxy's queue and set it to expire no
1569 * later than <expire> ahead. The listener turns to LI_LIMITED.
1570 */
1571 limit_listener(l, &p->listener_queue);
Willy Tarreaueeea8082020-01-08 19:15:07 +01001572 if (p->task && tick_isset(expire))
1573 task_schedule(p->task, expire);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001574 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001575}
1576
Willy Tarreau05f50472017-09-15 09:19:58 +02001577/* Notify the listener that a connection initiated from it was released. This
1578 * is used to keep the connection count consistent and to possibly re-open
1579 * listening when it was limited.
1580 */
1581void listener_release(struct listener *l)
1582{
1583 struct proxy *fe = l->bind_conf->frontend;
1584
Amaury Denoyelle331b8b12023-10-25 10:52:23 +02001585 if (listener_uses_maxconn(l))
Willy Tarreau4781b152021-04-06 13:53:36 +02001586 _HA_ATOMIC_DEC(&actconn);
Willy Tarreau82c97892019-02-27 19:32:32 +01001587 if (fe)
Willy Tarreau4781b152021-04-06 13:53:36 +02001588 _HA_ATOMIC_DEC(&fe->feconn);
1589 _HA_ATOMIC_DEC(&l->nbconn);
Willy Tarreaufea8c192023-02-28 10:25:57 +01001590 _HA_ATOMIC_DEC(&l->thr_conn[ti->ltid]);
Willy Tarreau82c97892019-02-27 19:32:32 +01001591
1592 if (l->state == LI_FULL || l->state == LI_LIMITED)
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +01001593 relax_listener(l, 0, 0);
Willy Tarreau05f50472017-09-15 09:19:58 +02001594
Willy Tarreau02757d02021-01-28 18:07:24 +01001595 /* Dequeues all of the listeners waiting for a resource */
1596 dequeue_all_listeners();
1597
Aurelien DARRAGONa57786e2022-09-12 09:26:21 +02001598 if (fe && !MT_LIST_ISEMPTY(&fe->listener_queue) &&
Willy Tarreau05f50472017-09-15 09:19:58 +02001599 (!fe->fe_sps_lim || freq_ctr_remain(&fe->fe_sess_per_sec, fe->fe_sps_lim, 0) > 0))
Willy Tarreau241797a2019-12-10 14:10:52 +01001600 dequeue_proxy_listeners(fe);
Christopher Faulet42b71d92024-03-12 07:31:56 +01001601 else {
1602 unsigned int wait;
1603 int expire = TICK_ETERNITY;
1604
Christopher Faulet07838f72024-03-14 09:29:09 +01001605 if (fe->task && fe->fe_sps_lim &&
Christopher Faulet42b71d92024-03-12 07:31:56 +01001606 (wait = next_event_delay(&fe->fe_sess_per_sec,fe->fe_sps_lim, 0))) {
1607 /* we're blocking because a limit was reached on the number of
1608 * requests/s on the frontend. We want to re-check ASAP, which
1609 * means in 1 ms before estimated expiration date, because the
1610 * timer will have settled down.
1611 */
1612 expire = tick_first(fe->task->expire, tick_add(now_ms, wait));
Christopher Faulet07838f72024-03-14 09:29:09 +01001613 if (tick_isset(expire))
Christopher Faulet42b71d92024-03-12 07:31:56 +01001614 task_schedule(fe->task, expire);
1615 }
1616 }
Willy Tarreau05f50472017-09-15 09:19:58 +02001617}
1618
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001619/* Initializes the listener queues. Returns 0 on success, otherwise ERR_* flags */
1620static int listener_queue_init()
1621{
Willy Tarreaubeeabf52021-10-01 18:23:30 +02001622 global_listener_queue_task = task_new_anywhere();
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001623 if (!global_listener_queue_task) {
1624 ha_alert("Out of memory when initializing global listener queue\n");
1625 return ERR_FATAL|ERR_ABORT;
1626 }
1627 /* very simple initialization, users will queue the task if needed */
1628 global_listener_queue_task->context = NULL; /* not even a context! */
1629 global_listener_queue_task->process = manage_global_listener_queue;
Christopher Faulet13e86d92022-11-17 14:40:20 +01001630 HA_RWLOCK_INIT(&global_listener_rwlock);
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001631
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001632 return 0;
1633}
1634
1635static void listener_queue_deinit()
1636{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001637 task_destroy(global_listener_queue_task);
1638 global_listener_queue_task = NULL;
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001639}
1640
1641REGISTER_CONFIG_POSTPARSER("multi-threaded listener queue", listener_queue_init);
1642REGISTER_POST_DEINIT(listener_queue_deinit);
1643
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001644
1645/* This is the global management task for listeners. It enables listeners waiting
1646 * for global resources when there are enough free resource, or at least once in
Willy Tarreaud597ec22021-01-29 14:29:06 +01001647 * a while. It is designed to be called as a task. It's exported so that it's easy
1648 * to spot in "show tasks" or "show profiling".
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001649 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001650struct task *manage_global_listener_queue(struct task *t, void *context, unsigned int state)
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001651{
1652 /* If there are still too many concurrent connections, let's wait for
1653 * some of them to go away. We don't need to re-arm the timer because
1654 * each of them will scan the queue anyway.
1655 */
1656 if (unlikely(actconn >= global.maxconn))
1657 goto out;
1658
1659 /* We should periodically try to enable listeners waiting for a global
1660 * resource here, because it is possible, though very unlikely, that
1661 * they have been blocked by a temporary lack of global resource such
1662 * as a file descriptor or memory and that the temporary condition has
1663 * disappeared.
1664 */
1665 dequeue_all_listeners();
1666
1667 out:
Christopher Faulet13e86d92022-11-17 14:40:20 +01001668 HA_RWLOCK_WRLOCK(LISTENER_LOCK, &global_listener_rwlock);
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001669 t->expire = TICK_ETERNITY;
Christopher Faulet13e86d92022-11-17 14:40:20 +01001670 HA_RWLOCK_WRUNLOCK(LISTENER_LOCK, &global_listener_rwlock);
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001671 return t;
1672}
1673
Willy Tarreauf6a84442023-04-22 23:25:38 +02001674/* Applies the thread mask, shards etc to the bind_conf. It normally returns 0
1675 * otherwie the number of errors. Upon error it may set error codes (ERR_*) in
1676 * err_code. It is supposed to be called only once very late in the boot process
1677 * after the bind_conf's thread_set is fixed. The function may emit warnings and
1678 * alerts. Extra listeners may be created on the fly.
1679 */
1680int bind_complete_thread_setup(struct bind_conf *bind_conf, int *err_code)
1681{
1682 struct proxy *fe = bind_conf->frontend;
1683 struct listener *li, *new_li, *ref;
1684 struct thread_set new_ts;
1685 int shard, shards, todo, done, grp, dups;
1686 ulong mask, gmask, bit;
1687 int cfgerr = 0;
1688 char *err;
1689
1690 err = NULL;
Willy Tarreauc38499c2023-04-22 22:27:31 +02001691 if (thread_resolve_group_mask(&bind_conf->thread_set, 0, &err) < 0) {
Willy Tarreaua22db652023-04-22 23:52:17 +02001692 ha_alert("%s '%s': %s in 'bind %s' at [%s:%d].\n",
1693 proxy_type_str(fe),
Willy Tarreauf6a84442023-04-22 23:25:38 +02001694 fe->id, err, bind_conf->arg, bind_conf->file, bind_conf->line);
1695 free(err);
1696 cfgerr++;
1697 return cfgerr;
1698 }
1699
1700 /* apply thread masks and groups to all receivers */
1701 list_for_each_entry(li, &bind_conf->listeners, by_bind) {
1702 shards = bind_conf->settings.shards;
1703 todo = thread_set_count(&bind_conf->thread_set);
1704
1705 /* special values: -1 = "by-thread", -2 = "by-group" */
Willy Tarreauc1fbdd62023-04-22 11:38:55 +02001706 if (shards == -1) {
Willy Tarreau8a5e6f42023-04-22 17:39:30 +02001707 if (protocol_supports_flag(li->rx.proto, PROTO_F_REUSEPORT_SUPPORTED))
Willy Tarreauc1fbdd62023-04-22 11:38:55 +02001708 shards = todo;
1709 else {
1710 if (fe != global.cli_fe)
1711 ha_diag_warning("[%s:%d]: Disabling per-thread sharding for listener in"
1712 " %s '%s' because SO_REUSEPORT is disabled\n",
1713 bind_conf->file, bind_conf->line, proxy_type_str(fe), fe->id);
1714 shards = 1;
1715 }
1716 }
Willy Tarreauf6a84442023-04-22 23:25:38 +02001717 else if (shards == -2)
Willy Tarreau8a5e6f42023-04-22 17:39:30 +02001718 shards = protocol_supports_flag(li->rx.proto, PROTO_F_REUSEPORT_SUPPORTED) ? my_popcountl(bind_conf->thread_set.grps) : 1;
Willy Tarreauf6a84442023-04-22 23:25:38 +02001719
1720 /* no more shards than total threads */
1721 if (shards > todo)
1722 shards = todo;
1723
Willy Tarreauc1fbdd62023-04-22 11:38:55 +02001724 /* We also need to check if an explicit shards count was set and cannot be honored */
Willy Tarreau8a5e6f42023-04-22 17:39:30 +02001725 if (shards > 1 && !protocol_supports_flag(li->rx.proto, PROTO_F_REUSEPORT_SUPPORTED)) {
Willy Tarreauc1fbdd62023-04-22 11:38:55 +02001726 ha_warning("[%s:%d]: Disabling sharding for listener in %s '%s' because SO_REUSEPORT is disabled\n",
1727 bind_conf->file, bind_conf->line, proxy_type_str(fe), fe->id);
1728 shards = 1;
1729 }
1730
Willy Tarreauf6a84442023-04-22 23:25:38 +02001731 shard = done = grp = bit = mask = 0;
1732 new_li = li;
1733
1734 while (shard < shards) {
1735 memset(&new_ts, 0, sizeof(new_ts));
1736 while (grp < global.nbtgroups && done < todo) {
1737 /* enlarge mask to cover next bit of bind_thread till we
1738 * have enough bits for one shard. We restart from the
1739 * current grp+bit.
1740 */
1741
1742 /* first let's find the first non-empty group starting at <mask> */
1743 if (!(bind_conf->thread_set.rel[grp] & ha_tgroup_info[grp].threads_enabled & ~mask)) {
1744 grp++;
1745 mask = 0;
1746 continue;
1747 }
1748
1749 /* take next unassigned bit */
1750 bit = (bind_conf->thread_set.rel[grp] & ~mask) & -(bind_conf->thread_set.rel[grp] & ~mask);
1751 new_ts.rel[grp] |= bit;
1752 mask |= bit;
1753 new_ts.grps |= 1UL << grp;
1754
1755 done += shards;
1756 };
1757
1758 BUG_ON(!new_ts.grps); // no more bits left unassigned
1759
1760 /* Create all required listeners for all bound groups. If more than one group is
1761 * needed, the first receiver serves as a reference, and subsequent ones point to
1762 * it. We already have a listener available in new_li() so we only allocate a new
1763 * one if we're not on the last one. We count the remaining groups by copying their
1764 * mask into <gmask> and dropping the lowest bit at the end of the loop until there
1765 * is no more. Ah yes, it's not pretty :-/
1766 */
1767 ref = new_li;
1768 gmask = new_ts.grps;
1769 for (dups = 0; gmask; dups++) {
1770 /* assign the first (and only) thread and group */
1771 new_li->rx.bind_thread = thread_set_nth_tmask(&new_ts, dups);
1772 new_li->rx.bind_tgroup = thread_set_nth_group(&new_ts, dups);
1773
1774 if (dups) {
1775 /* it has been allocated already in the previous round */
1776 shard_info_attach(&new_li->rx, ref->rx.shard_info);
1777 new_li->rx.flags |= RX_F_MUST_DUP;
1778 }
1779
1780 gmask &= gmask - 1; // drop lowest bit
1781 if (gmask) {
1782 /* yet another listener expected in this shard, let's
1783 * chain it.
1784 */
1785 struct listener *tmp_li = clone_listener(new_li);
1786
1787 if (!tmp_li) {
1788 ha_alert("Out of memory while trying to allocate extra listener for group %u of shard %d in %s %s\n",
1789 new_li->rx.bind_tgroup, shard, proxy_type_str(fe), fe->id);
1790 cfgerr++;
1791 *err_code |= ERR_FATAL | ERR_ALERT;
1792 return cfgerr;
1793 }
1794
1795 /* if we're forced to create at least two listeners, we have to
1796 * allocate a shared shard_info that's linked to from the reference
1797 * and each other listener, so we'll create it here.
1798 */
1799 if (!shard_info_attach(&ref->rx, NULL)) {
1800 ha_alert("Out of memory while trying to allocate shard_info for listener for group %u of shard %d in %s %s\n",
1801 new_li->rx.bind_tgroup, shard, proxy_type_str(fe), fe->id);
1802 cfgerr++;
1803 *err_code |= ERR_FATAL | ERR_ALERT;
1804 return cfgerr;
1805 }
1806 new_li = tmp_li;
1807 }
1808 }
1809 done -= todo;
1810
1811 shard++;
1812 if (shard >= shards)
1813 break;
1814
1815 /* create another listener for new shards */
1816 new_li = clone_listener(li);
1817 if (!new_li) {
1818 ha_alert("Out of memory while trying to allocate extra listener for shard %d in %s %s\n",
1819 shard, proxy_type_str(fe), fe->id);
1820 cfgerr++;
1821 *err_code |= ERR_FATAL | ERR_ALERT;
1822 return cfgerr;
1823 }
1824 }
1825 }
1826
1827 /* success */
1828 return cfgerr;
1829}
1830
Willy Tarreau26982662012-09-12 23:17:10 +02001831/*
1832 * Registers the bind keyword list <kwl> as a list of valid keywords for next
1833 * parsing sessions.
1834 */
1835void bind_register_keywords(struct bind_kw_list *kwl)
1836{
Willy Tarreau2b718102021-04-21 07:32:39 +02001837 LIST_APPEND(&bind_keywords.list, &kwl->list);
Willy Tarreau26982662012-09-12 23:17:10 +02001838}
1839
1840/* Return a pointer to the bind keyword <kw>, or NULL if not found. If the
1841 * keyword is found with a NULL ->parse() function, then an attempt is made to
1842 * find one with a valid ->parse() function. This way it is possible to declare
1843 * platform-dependant, known keywords as NULL, then only declare them as valid
1844 * if some options are met. Note that if the requested keyword contains an
1845 * opening parenthesis, everything from this point is ignored.
1846 */
1847struct bind_kw *bind_find_kw(const char *kw)
1848{
1849 int index;
1850 const char *kwend;
1851 struct bind_kw_list *kwl;
1852 struct bind_kw *ret = NULL;
1853
1854 kwend = strchr(kw, '(');
1855 if (!kwend)
1856 kwend = kw + strlen(kw);
1857
1858 list_for_each_entry(kwl, &bind_keywords.list, list) {
1859 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1860 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
1861 kwl->kw[index].kw[kwend-kw] == 0) {
1862 if (kwl->kw[index].parse)
1863 return &kwl->kw[index]; /* found it !*/
1864 else
1865 ret = &kwl->kw[index]; /* may be OK */
1866 }
1867 }
1868 }
1869 return ret;
1870}
1871
Willy Tarreau8638f482012-09-18 18:01:17 +02001872/* Dumps all registered "bind" keywords to the <out> string pointer. The
1873 * unsupported keywords are only dumped if their supported form was not
1874 * found.
1875 */
1876void bind_dump_kws(char **out)
1877{
1878 struct bind_kw_list *kwl;
1879 int index;
1880
Christopher Faulet784063e2020-05-18 12:14:18 +02001881 if (!out)
1882 return;
1883
Willy Tarreau8638f482012-09-18 18:01:17 +02001884 *out = NULL;
1885 list_for_each_entry(kwl, &bind_keywords.list, list) {
1886 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1887 if (kwl->kw[index].parse ||
1888 bind_find_kw(kwl->kw[index].kw) == &kwl->kw[index]) {
Willy Tarreau51fb7652012-09-18 18:24:39 +02001889 memprintf(out, "%s[%4s] %s%s%s\n", *out ? *out : "",
1890 kwl->scope,
Willy Tarreau8638f482012-09-18 18:01:17 +02001891 kwl->kw[index].kw,
Willy Tarreau51fb7652012-09-18 18:24:39 +02001892 kwl->kw[index].skip ? " <arg>" : "",
1893 kwl->kw[index].parse ? "" : " (not supported)");
Willy Tarreau8638f482012-09-18 18:01:17 +02001894 }
1895 }
1896 }
1897}
1898
Willy Tarreau433b05f2021-03-12 10:14:07 +01001899/* Try to find in srv_keyword the word that looks closest to <word> by counting
1900 * transitions between letters, digits and other characters. Will return the
1901 * best matching word if found, otherwise NULL.
1902 */
1903const char *bind_find_best_kw(const char *word)
1904{
1905 uint8_t word_sig[1024];
1906 uint8_t list_sig[1024];
1907 const struct bind_kw_list *kwl;
1908 const char *best_ptr = NULL;
1909 int dist, best_dist = INT_MAX;
1910 int index;
1911
1912 make_word_fingerprint(word_sig, word);
1913 list_for_each_entry(kwl, &bind_keywords.list, list) {
1914 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1915 make_word_fingerprint(list_sig, kwl->kw[index].kw);
1916 dist = word_fingerprint_distance(word_sig, list_sig);
1917 if (dist < best_dist) {
1918 best_dist = dist;
1919 best_ptr = kwl->kw[index].kw;
1920 }
1921 }
1922 }
1923
1924 if (best_dist > 2 * strlen(word) || (best_ptr && best_dist > 2 * strlen(best_ptr)))
1925 best_ptr = NULL;
1926
1927 return best_ptr;
1928}
1929
Willy Tarreaudbf78022021-10-06 09:05:08 +02001930/* allocate an bind_conf struct for a bind line, and chain it to the frontend <fe>.
1931 * If <arg> is not NULL, it is duplicated into ->arg to store useful config
1932 * information for error reporting. NULL is returned on error.
1933 */
1934struct bind_conf *bind_conf_alloc(struct proxy *fe, const char *file,
1935 int line, const char *arg, struct xprt_ops *xprt)
1936{
1937 struct bind_conf *bind_conf = calloc(1, sizeof(*bind_conf));
1938
1939 if (!bind_conf)
1940 goto err;
1941
1942 bind_conf->file = strdup(file);
1943 if (!bind_conf->file)
1944 goto err;
1945 bind_conf->line = line;
1946 if (arg) {
1947 bind_conf->arg = strdup(arg);
1948 if (!bind_conf->arg)
1949 goto err;
1950 }
1951
1952 LIST_APPEND(&fe->conf.bind, &bind_conf->by_fe);
1953 bind_conf->settings.ux.uid = -1;
1954 bind_conf->settings.ux.gid = -1;
1955 bind_conf->settings.ux.mode = 0;
Willy Tarreau73101642023-04-22 22:06:23 +02001956 bind_conf->settings.shards = global.tune.default_shards;
Willy Tarreaudbf78022021-10-06 09:05:08 +02001957 bind_conf->xprt = xprt;
1958 bind_conf->frontend = fe;
Willy Tarreau7866e8e2023-01-12 18:39:42 +01001959 bind_conf->analysers = fe->fe_req_ana;
Willy Tarreaudbf78022021-10-06 09:05:08 +02001960 bind_conf->severity_output = CLI_SEVERITY_NONE;
1961#ifdef USE_OPENSSL
1962 HA_RWLOCK_INIT(&bind_conf->sni_lock);
1963 bind_conf->sni_ctx = EB_ROOT;
1964 bind_conf->sni_w_ctx = EB_ROOT;
1965#endif
1966 LIST_INIT(&bind_conf->listeners);
1967 return bind_conf;
1968
1969 err:
1970 if (bind_conf) {
1971 ha_free(&bind_conf->file);
1972 ha_free(&bind_conf->arg);
1973 }
1974 ha_free(&bind_conf);
1975 return NULL;
1976}
1977
1978const char *listener_state_str(const struct listener *l)
1979{
1980 static const char *states[8] = {
1981 "NEW", "INI", "ASS", "PAU", "LIS", "RDY", "FUL", "LIM",
1982 };
1983 unsigned int st = l->state;
1984
1985 if (st >= sizeof(states) / sizeof(*states))
1986 return "INVALID";
1987 return states[st];
1988}
1989
Willy Tarreau645513a2010-05-24 20:55:15 +02001990/************************************************************************/
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001991/* All supported sample and ACL keywords must be declared here. */
Willy Tarreau645513a2010-05-24 20:55:15 +02001992/************************************************************************/
1993
Willy Tarreaua5e37562011-12-16 17:06:15 +01001994/* set temp integer to the number of connexions to the same listening socket */
Willy Tarreau645513a2010-05-24 20:55:15 +02001995static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001996smp_fetch_dconn(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau645513a2010-05-24 20:55:15 +02001997{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001998 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001999 smp->data.u.sint = smp->sess->listener->nbconn;
Willy Tarreau645513a2010-05-24 20:55:15 +02002000 return 1;
2001}
2002
Willy Tarreaua5e37562011-12-16 17:06:15 +01002003/* set temp integer to the id of the socket (listener) */
Willy Tarreau645513a2010-05-24 20:55:15 +02002004static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02002005smp_fetch_so_id(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau37406352012-04-23 16:16:37 +02002006{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02002007 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02002008 smp->data.u.sint = smp->sess->listener->luid;
Willy Tarreau645513a2010-05-24 20:55:15 +02002009 return 1;
2010}
Jerome Magnineb421b22020-03-27 22:08:40 +01002011static int
2012smp_fetch_so_name(const struct arg *args, struct sample *smp, const char *kw, void *private)
2013{
2014 smp->data.u.str.area = smp->sess->listener->name;
2015 if (!smp->data.u.str.area)
2016 return 0;
2017
2018 smp->data.type = SMP_T_STR;
2019 smp->flags = SMP_F_CONST;
2020 smp->data.u.str.data = strlen(smp->data.u.str.area);
2021 return 1;
2022}
Willy Tarreau645513a2010-05-24 20:55:15 +02002023
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002024/* parse the "accept-proxy" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002025static int bind_parse_accept_proxy(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002026{
Willy Tarreauf1b47302023-01-12 19:48:50 +01002027 conf->options |= BC_O_ACC_PROXY;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002028 return 0;
2029}
2030
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01002031/* parse the "accept-netscaler-cip" bind keyword */
2032static int bind_parse_accept_netscaler_cip(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2033{
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01002034 uint32_t val;
2035
2036 if (!*args[cur_arg + 1]) {
2037 memprintf(err, "'%s' : missing value", args[cur_arg]);
2038 return ERR_ALERT | ERR_FATAL;
2039 }
2040
2041 val = atol(args[cur_arg + 1]);
2042 if (val <= 0) {
Willy Tarreaue2711c72019-02-27 15:39:41 +01002043 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01002044 return ERR_ALERT | ERR_FATAL;
2045 }
2046
Willy Tarreauf1b47302023-01-12 19:48:50 +01002047 conf->options |= BC_O_ACC_CIP;
2048 conf->ns_cip_magic = val;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01002049 return 0;
2050}
2051
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002052/* parse the "backlog" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002053static int bind_parse_backlog(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002054{
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002055 int val;
2056
2057 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002058 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002059 return ERR_ALERT | ERR_FATAL;
2060 }
2061
2062 val = atol(args[cur_arg + 1]);
Willy Tarreaue2711c72019-02-27 15:39:41 +01002063 if (val < 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002064 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002065 return ERR_ALERT | ERR_FATAL;
2066 }
2067
Willy Tarreau1920f892023-01-12 18:55:13 +01002068 conf->backlog = val;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002069 return 0;
2070}
2071
2072/* parse the "id" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002073static int bind_parse_id(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002074{
2075 struct eb32_node *node;
Willy Tarreau4348fad2012-09-20 16:48:07 +02002076 struct listener *l, *new;
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01002077 char *error;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002078
Willy Tarreau4348fad2012-09-20 16:48:07 +02002079 if (conf->listeners.n != conf->listeners.p) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002080 memprintf(err, "'%s' can only be used with a single socket", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002081 return ERR_ALERT | ERR_FATAL;
2082 }
2083
2084 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002085 memprintf(err, "'%s' : expects an integer argument", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002086 return ERR_ALERT | ERR_FATAL;
2087 }
2088
Willy Tarreau4348fad2012-09-20 16:48:07 +02002089 new = LIST_NEXT(&conf->listeners, struct listener *, by_bind);
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01002090 new->luid = strtol(args[cur_arg + 1], &error, 10);
2091 if (*error != '\0') {
2092 memprintf(err, "'%s' : expects an integer argument, found '%s'", args[cur_arg], args[cur_arg + 1]);
2093 return ERR_ALERT | ERR_FATAL;
2094 }
Willy Tarreau4348fad2012-09-20 16:48:07 +02002095 new->conf.id.key = new->luid;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002096
Willy Tarreau4348fad2012-09-20 16:48:07 +02002097 if (new->luid <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002098 memprintf(err, "'%s' : custom id has to be > 0", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002099 return ERR_ALERT | ERR_FATAL;
2100 }
2101
Willy Tarreau4348fad2012-09-20 16:48:07 +02002102 node = eb32_lookup(&px->conf.used_listener_id, new->luid);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002103 if (node) {
2104 l = container_of(node, struct listener, conf.id);
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002105 memprintf(err, "'%s' : custom id %d already used at %s:%d ('bind %s')",
2106 args[cur_arg], l->luid, l->bind_conf->file, l->bind_conf->line,
2107 l->bind_conf->arg);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002108 return ERR_ALERT | ERR_FATAL;
2109 }
2110
Willy Tarreau4348fad2012-09-20 16:48:07 +02002111 eb32_insert(&px->conf.used_listener_id, &new->conf.id);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002112 return 0;
2113}
2114
Willy Tarreau3882d2a2022-05-20 15:41:45 +02002115/* Complete a bind_conf by parsing the args after the address. <args> is the
2116 * arguments array, <cur_arg> is the first one to be considered. <section> is
2117 * the section name to report in error messages, and <file> and <linenum> are
2118 * the file name and line number respectively. Note that args[0..1] are used
2119 * in error messages to provide some context. The return value is an error
2120 * code, zero on success or an OR of ERR_{FATAL,ABORT,ALERT,WARN}.
2121 */
2122int bind_parse_args_list(struct bind_conf *bind_conf, char **args, int cur_arg, const char *section, const char *file, int linenum)
2123{
2124 int err_code = 0;
2125
2126 while (*(args[cur_arg])) {
2127 struct bind_kw *kw;
2128 const char *best;
2129
2130 kw = bind_find_kw(args[cur_arg]);
2131 if (kw) {
2132 char *err = NULL;
2133 int code;
2134
2135 if (!kw->parse) {
2136 ha_alert("parsing [%s:%d] : '%s %s' in section '%s' : '%s' option is not implemented in this version (check build options).\n",
2137 file, linenum, args[0], args[1], section, args[cur_arg]);
2138 cur_arg += 1 + kw->skip ;
2139 err_code |= ERR_ALERT | ERR_FATAL;
2140 goto out;
2141 }
2142
2143 code = kw->parse(args, cur_arg, bind_conf->frontend, bind_conf, &err);
2144 err_code |= code;
2145
2146 if (code) {
2147 if (err && *err) {
2148 indent_msg(&err, 2);
2149 if (((code & (ERR_WARN|ERR_ALERT)) == ERR_WARN))
2150 ha_warning("parsing [%s:%d] : '%s %s' in section '%s' : %s\n", file, linenum, args[0], args[1], section, err);
2151 else
2152 ha_alert("parsing [%s:%d] : '%s %s' in section '%s' : %s\n", file, linenum, args[0], args[1], section, err);
2153 }
2154 else
2155 ha_alert("parsing [%s:%d] : '%s %s' in section '%s' : error encountered while processing '%s'.\n",
2156 file, linenum, args[0], args[1], section, args[cur_arg]);
2157 if (code & ERR_FATAL) {
2158 free(err);
2159 cur_arg += 1 + kw->skip;
2160 goto out;
2161 }
2162 }
2163 free(err);
2164 cur_arg += 1 + kw->skip;
2165 continue;
2166 }
2167
2168 best = bind_find_best_kw(args[cur_arg]);
2169 if (best)
2170 ha_alert("parsing [%s:%d] : '%s %s' in section '%s': unknown keyword '%s'; did you mean '%s' maybe ?\n",
2171 file, linenum, args[0], args[1], section, args[cur_arg], best);
2172 else
2173 ha_alert("parsing [%s:%d] : '%s %s' in section '%s': unknown keyword '%s'.\n",
2174 file, linenum, args[0], args[1], section, args[cur_arg]);
2175
2176 err_code |= ERR_ALERT | ERR_FATAL;
2177 goto out;
2178 }
Willy Tarreau64306cc2022-05-20 16:20:52 +02002179
2180 if ((bind_conf->options & (BC_O_USE_SOCK_DGRAM|BC_O_USE_SOCK_STREAM)) == (BC_O_USE_SOCK_DGRAM|BC_O_USE_SOCK_STREAM) ||
2181 (bind_conf->options & (BC_O_USE_XPRT_DGRAM|BC_O_USE_XPRT_STREAM)) == (BC_O_USE_XPRT_DGRAM|BC_O_USE_XPRT_STREAM)) {
2182 ha_alert("parsing [%s:%d] : '%s %s' in section '%s' : cannot mix datagram and stream protocols.\n",
2183 file, linenum, args[0], args[1], section);
2184 err_code |= ERR_ALERT | ERR_FATAL;
2185 goto out;
2186 }
2187
Willy Tarreau78d0dcd2022-05-20 17:10:00 +02002188 /* The transport layer automatically switches to QUIC when QUIC is
2189 * selected, regardless of bind_conf settings. We then need to
2190 * initialize QUIC params.
2191 */
2192 if ((bind_conf->options & (BC_O_USE_SOCK_DGRAM|BC_O_USE_XPRT_STREAM)) == (BC_O_USE_SOCK_DGRAM|BC_O_USE_XPRT_STREAM)) {
2193#ifdef USE_QUIC
Amaury Denoyellec13d9e12024-02-16 15:40:06 +01002194 struct listener *l __maybe_unused;
2195 int listener_count __maybe_unused = 0;
2196
Willy Tarreau78d0dcd2022-05-20 17:10:00 +02002197 bind_conf->xprt = xprt_get(XPRT_QUIC);
Willy Tarreau287f32f2022-05-20 18:16:52 +02002198 if (!(bind_conf->options & BC_O_USE_SSL)) {
2199 bind_conf->options |= BC_O_USE_SSL;
2200 ha_warning("parsing [%s:%d] : '%s %s' in section '%s' : QUIC protocol detected, enabling ssl. Use 'ssl' to shut this warning.\n",
2201 file, linenum, args[0], args[1], section);
2202 }
Willy Tarreau78d0dcd2022-05-20 17:10:00 +02002203 quic_transport_params_init(&bind_conf->quic_params, 1);
Amaury Denoyellec13d9e12024-02-16 15:40:06 +01002204
2205#if (!defined(IP_PKTINFO) && !defined(IP_RECVDSTADDR)) || !defined(IPV6_RECVPKTINFO)
2206 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
2207 if (++listener_count > 1 || !is_inet_addr(&l->rx.addr)) {
2208 ha_diag_warning("parsing [%s:%d] : '%s %s' in section '%s' : UDP binding on multiple addresses without IP_PKTINFO or equivalent support may be unreliable.\n",
2209 file, linenum, args[0], args[1], section);
2210 break;
2211 }
2212 }
2213#endif /* (!IP_PKTINFO && !IP_RECVDSTADDR) || !IPV6_RECVPKTINFO */
2214
Willy Tarreau78d0dcd2022-05-20 17:10:00 +02002215#else
2216 ha_alert("parsing [%s:%d] : '%s %s' in section '%s' : QUIC protocol selected but support not compiled in (check build options).\n",
2217 file, linenum, args[0], args[1], section);
2218 err_code |= ERR_ALERT | ERR_FATAL;
2219 goto out;
2220#endif
2221 }
Willy Tarreau2071a992022-05-20 17:14:31 +02002222 else if (bind_conf->options & BC_O_USE_SSL) {
2223 bind_conf->xprt = xprt_get(XPRT_SSL);
2224 }
Willy Tarreau78d0dcd2022-05-20 17:10:00 +02002225
Willy Tarreau3882d2a2022-05-20 15:41:45 +02002226 out:
2227 return err_code;
2228}
2229
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002230/* parse the "maxconn" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002231static int bind_parse_maxconn(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002232{
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002233 int val;
2234
2235 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002236 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002237 return ERR_ALERT | ERR_FATAL;
2238 }
2239
2240 val = atol(args[cur_arg + 1]);
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01002241 if (val < 0) {
2242 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002243 return ERR_ALERT | ERR_FATAL;
2244 }
2245
Willy Tarreau758c69d2023-01-12 18:59:37 +01002246 conf->maxconn = val;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002247 return 0;
2248}
2249
2250/* parse the "name" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002251static int bind_parse_name(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002252{
2253 struct listener *l;
2254
2255 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002256 memprintf(err, "'%s' : missing name", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002257 return ERR_ALERT | ERR_FATAL;
2258 }
2259
Willy Tarreau4348fad2012-09-20 16:48:07 +02002260 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002261 l->name = strdup(args[cur_arg + 1]);
2262
2263 return 0;
2264}
2265
2266/* parse the "nice" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02002267static int bind_parse_nice(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002268{
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002269 int val;
2270
2271 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002272 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002273 return ERR_ALERT | ERR_FATAL;
2274 }
2275
2276 val = atol(args[cur_arg + 1]);
2277 if (val < -1024 || val > 1024) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02002278 memprintf(err, "'%s' : invalid value %d, allowed range is -1024..1024", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002279 return ERR_ALERT | ERR_FATAL;
2280 }
2281
Willy Tarreau7dbd4182023-01-12 19:32:45 +01002282 conf->nice = val;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002283 return 0;
2284}
2285
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02002286/* parse the "process" bind keyword */
2287static int bind_parse_process(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2288{
Willy Tarreauacd64412022-07-15 17:16:01 +02002289 memprintf(err, "'process %s' on 'bind' lines is not supported anymore, please use 'thread' instead.", args[cur_arg+1]);
2290 return ERR_ALERT | ERR_FATAL;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02002291}
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002292
Christopher Fauleta717b992018-04-10 14:43:00 +02002293/* parse the "proto" bind keyword */
2294static int bind_parse_proto(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2295{
2296 struct ist proto;
2297
2298 if (!*args[cur_arg + 1]) {
2299 memprintf(err, "'%s' : missing value", args[cur_arg]);
2300 return ERR_ALERT | ERR_FATAL;
2301 }
2302
Tim Duesterhusdcf753a2021-03-04 17:31:47 +01002303 proto = ist(args[cur_arg + 1]);
Christopher Fauleta717b992018-04-10 14:43:00 +02002304 conf->mux_proto = get_mux_proto(proto);
2305 if (!conf->mux_proto) {
2306 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[cur_arg], args[cur_arg+1]);
2307 return ERR_ALERT | ERR_FATAL;
2308 }
Willy Tarreauc8cac042021-09-21 14:31:29 +02002309 return 0;
2310}
2311
Willy Tarreaua07635e2023-04-13 17:25:43 +02002312/* parse the "shards" bind keyword. Takes an integer, "by-thread", or "by-group" */
Willy Tarreau6dfbef42021-10-12 15:23:03 +02002313static int bind_parse_shards(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2314{
2315 int val;
2316
2317 if (!*args[cur_arg + 1]) {
2318 memprintf(err, "'%s' : missing value", args[cur_arg]);
2319 return ERR_ALERT | ERR_FATAL;
2320 }
2321
2322 if (strcmp(args[cur_arg + 1], "by-thread") == 0) {
Willy Tarreaud30e82b2023-04-13 17:11:23 +02002323 val = -1; /* -1 = "by-thread", will be fixed in check_config_validity() */
Willy Tarreaua07635e2023-04-13 17:25:43 +02002324 } else if (strcmp(args[cur_arg + 1], "by-group") == 0) {
2325 val = -2; /* -2 = "by-group", will be fixed in check_config_validity() */
Willy Tarreau6dfbef42021-10-12 15:23:03 +02002326 } else {
2327 val = atol(args[cur_arg + 1]);
2328 if (val < 1 || val > MAX_THREADS) {
2329 memprintf(err, "'%s' : invalid value %d, allowed range is %d..%d or 'by-thread'", args[cur_arg], val, 1, MAX_THREADS);
2330 return ERR_ALERT | ERR_FATAL;
2331 }
2332 }
2333
2334 conf->settings.shards = val;
2335 return 0;
2336}
2337
Willy Tarreauf0de8ca2023-01-31 19:31:27 +01002338/* parse the "thread" bind keyword. This will replace any preset thread_set */
Willy Tarreauc8cac042021-09-21 14:31:29 +02002339static int bind_parse_thread(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2340{
Willy Tarreauf0de8ca2023-01-31 19:31:27 +01002341 /* note that the thread set is zeroed before first call, and we don't
2342 * want to reset it so that it remains possible to chain multiple
2343 * "thread" directives.
2344 */
2345 if (parse_thread_set(args[cur_arg+1], &conf->thread_set, err) < 0)
Willy Tarreauc8cac042021-09-21 14:31:29 +02002346 return ERR_ALERT | ERR_FATAL;
Christopher Fauleta717b992018-04-10 14:43:00 +02002347 return 0;
2348}
2349
Willy Tarreau73101642023-04-22 22:06:23 +02002350/* config parser for global "tune.listener.default-shards" */
2351static int cfg_parse_tune_listener_shards(char **args, int section_type, struct proxy *curpx,
2352 const struct proxy *defpx, const char *file, int line,
2353 char **err)
2354{
2355 if (too_many_args(1, args, err, NULL))
2356 return -1;
2357
2358 if (strcmp(args[1], "by-thread") == 0)
2359 global.tune.default_shards = -1;
2360 else if (strcmp(args[1], "by-group") == 0)
2361 global.tune.default_shards = -2;
2362 else if (strcmp(args[1], "by-process") == 0)
2363 global.tune.default_shards = 1;
2364 else {
2365 memprintf(err, "'%s' expects either 'by-process', 'by-group', or 'by-thread' but got '%s'.", args[0], args[1]);
2366 return -1;
2367 }
2368 return 0;
2369}
2370
Willy Tarreau84fe1f42023-04-20 15:40:38 +02002371/* config parser for global "tune.listener.multi-queue", accepts "on", "fair" or "off" */
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002372static int cfg_parse_tune_listener_mq(char **args, int section_type, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002373 const struct proxy *defpx, const char *file, int line,
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002374 char **err)
2375{
2376 if (too_many_args(1, args, err, NULL))
2377 return -1;
2378
2379 if (strcmp(args[1], "on") == 0)
Willy Tarreau84fe1f42023-04-20 15:40:38 +02002380 global.tune.options = (global.tune.options & ~GTUNE_LISTENER_MQ_ANY) | GTUNE_LISTENER_MQ_OPT;
2381 else if (strcmp(args[1], "fair") == 0)
2382 global.tune.options = (global.tune.options & ~GTUNE_LISTENER_MQ_ANY) | GTUNE_LISTENER_MQ_FAIR;
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002383 else if (strcmp(args[1], "off") == 0)
Willy Tarreau84fe1f42023-04-20 15:40:38 +02002384 global.tune.options &= ~GTUNE_LISTENER_MQ_ANY;
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002385 else {
Willy Tarreau84fe1f42023-04-20 15:40:38 +02002386 memprintf(err, "'%s' expects either 'on', 'fair', or 'off' but got '%s'.", args[0], args[1]);
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002387 return -1;
2388 }
2389 return 0;
2390}
2391
Willy Tarreau61612d42012-04-19 18:42:05 +02002392/* Note: must not be declared <const> as its list will be overwritten.
2393 * Please take care of keeping this list alphabetically sorted.
2394 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02002395static struct sample_fetch_kw_list smp_kws = {ILH, {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02002396 { "dst_conn", smp_fetch_dconn, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
2397 { "so_id", smp_fetch_so_id, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
Jerome Magnineb421b22020-03-27 22:08:40 +01002398 { "so_name", smp_fetch_so_name, 0, NULL, SMP_T_STR, SMP_USE_FTEND, },
Willy Tarreau0ccb7442013-01-07 22:54:17 +01002399 { /* END */ },
2400}};
2401
Willy Tarreau0108d902018-11-25 19:14:37 +01002402INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
2403
Willy Tarreau0ccb7442013-01-07 22:54:17 +01002404/* Note: must not be declared <const> as its list will be overwritten.
2405 * Please take care of keeping this list alphabetically sorted.
2406 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02002407static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreau0ccb7442013-01-07 22:54:17 +01002408 { /* END */ },
Willy Tarreau645513a2010-05-24 20:55:15 +02002409}};
2410
Willy Tarreau0108d902018-11-25 19:14:37 +01002411INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
2412
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002413/* Note: must not be declared <const> as its list will be overwritten.
2414 * Please take care of keeping this list alphabetically sorted, doing so helps
2415 * all code contributors.
2416 * Optional keywords are also declared with a NULL ->parse() function so that
2417 * the config parser can report an appropriate error when a known keyword was
2418 * not enabled.
2419 */
Willy Tarreau51fb7652012-09-18 18:24:39 +02002420static struct bind_kw_list bind_kws = { "ALL", { }, {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01002421 { "accept-netscaler-cip", bind_parse_accept_netscaler_cip, 1 }, /* enable NetScaler Client IP insertion protocol */
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002422 { "accept-proxy", bind_parse_accept_proxy, 0 }, /* enable PROXY protocol */
2423 { "backlog", bind_parse_backlog, 1 }, /* set backlog of listening socket */
2424 { "id", bind_parse_id, 1 }, /* set id of listening socket */
2425 { "maxconn", bind_parse_maxconn, 1 }, /* set maxconn of listening socket */
2426 { "name", bind_parse_name, 1 }, /* set name of listening socket */
2427 { "nice", bind_parse_nice, 1 }, /* set nice of listening socket */
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02002428 { "process", bind_parse_process, 1 }, /* set list of allowed process for this socket */
Christopher Fauleta717b992018-04-10 14:43:00 +02002429 { "proto", bind_parse_proto, 1 }, /* set the proto to use for all incoming connections */
Willy Tarreau6dfbef42021-10-12 15:23:03 +02002430 { "shards", bind_parse_shards, 1 }, /* set number of shards */
Willy Tarreauc8cac042021-09-21 14:31:29 +02002431 { "thread", bind_parse_thread, 1 }, /* set list of allowed threads for this socket */
Willy Tarreau0ccb7442013-01-07 22:54:17 +01002432 { /* END */ },
Willy Tarreau3dcc3412012-09-18 17:17:28 +02002433}};
2434
Willy Tarreau0108d902018-11-25 19:14:37 +01002435INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
2436
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002437/* config keyword parsers */
2438static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau73101642023-04-22 22:06:23 +02002439 { CFG_GLOBAL, "tune.listener.default-shards", cfg_parse_tune_listener_shards },
Willy Tarreau7ac908b2019-02-27 12:02:18 +01002440 { CFG_GLOBAL, "tune.listener.multi-queue", cfg_parse_tune_listener_mq },
2441 { 0, NULL, NULL }
2442}};
2443
2444INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2445
Willy Tarreau645513a2010-05-24 20:55:15 +02002446/*
2447 * Local variables:
2448 * c-indent-level: 8
2449 * c-basic-offset: 8
2450 * End:
2451 */