blob: 7689ceb5b9619256505edc24e83e006baba0a571 [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>
18#include <fcntl.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020019
Willy Tarreaudcc048a2020-06-04 19:11:43 +020020#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020021#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020022#include <haproxy/cfgparse.h>
Willy Tarreau7ea393d2020-06-04 18:02:10 +020023#include <haproxy/connection.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020024#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/fd.h>
26#include <haproxy/freq_ctr.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020027#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020028#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020029#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020030#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/protocol-t.h>
32#include <haproxy/protocol.h>
33#include <haproxy/sample.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020034#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020035#include <haproxy/task.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020036#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/tools.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020038
Willy Tarreaub648d632007-10-28 22:13:50 +010039
Willy Tarreau26982662012-09-12 23:17:10 +020040/* List head of all known bind keywords */
41static struct bind_kw_list bind_keywords = {
42 .list = LIST_HEAD_INIT(bind_keywords.list)
43};
44
Willy Tarreaua1d97f82019-12-10 11:18:41 +010045/* list of the temporarily limited listeners because of lack of resource */
46static struct mt_list global_listener_queue = MT_LIST_HEAD_INIT(global_listener_queue);
47static struct task *global_listener_queue_task;
48static struct task *manage_global_listener_queue(struct task *t, void *context, unsigned short state);
49
50
Willy Tarreau1efafce2019-01-27 15:37:19 +010051#if defined(USE_THREAD)
52
53struct accept_queue_ring accept_queue_rings[MAX_THREADS] __attribute__((aligned(64))) = { };
54
55/* dequeue and process a pending connection from the local accept queue (single
Willy Tarreau83efc322020-10-14 17:37:17 +020056 * consumer). Returns the accepted connection or NULL if none was found.
Willy Tarreau1efafce2019-01-27 15:37:19 +010057 */
Willy Tarreau83efc322020-10-14 17:37:17 +020058struct connection *accept_queue_pop_sc(struct accept_queue_ring *ring)
Willy Tarreau1efafce2019-01-27 15:37:19 +010059{
Willy Tarreau1efafce2019-01-27 15:37:19 +010060 unsigned int pos, next;
Willy Tarreau83efc322020-10-14 17:37:17 +020061 struct connection *ptr;
62 struct connection **e;
Willy Tarreau1efafce2019-01-27 15:37:19 +010063
64 pos = ring->head;
65
66 if (pos == ring->tail)
Willy Tarreau83efc322020-10-14 17:37:17 +020067 return NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +010068
69 next = pos + 1;
70 if (next >= ACCEPT_QUEUE_SIZE)
71 next = 0;
72
73 e = &ring->entry[pos];
74
75 /* wait for the producer to update the listener's pointer */
76 while (1) {
Willy Tarreau83efc322020-10-14 17:37:17 +020077 ptr = *e;
Willy Tarreau1efafce2019-01-27 15:37:19 +010078 __ha_barrier_load();
79 if (ptr)
80 break;
81 pl_cpu_relax();
82 }
83
Willy Tarreau1efafce2019-01-27 15:37:19 +010084 /* release the entry */
Willy Tarreau83efc322020-10-14 17:37:17 +020085 *e = NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +010086
87 __ha_barrier_store();
88 ring->head = next;
Willy Tarreau83efc322020-10-14 17:37:17 +020089 return ptr;
Willy Tarreau1efafce2019-01-27 15:37:19 +010090}
91
92
Willy Tarreau83efc322020-10-14 17:37:17 +020093/* tries to push a new accepted connection <conn> into ring <ring>. Returns
94 * non-zero if it succeeds, or zero if the ring is full. Supports multiple
95 * producers.
Willy Tarreau1efafce2019-01-27 15:37:19 +010096 */
Willy Tarreau83efc322020-10-14 17:37:17 +020097int accept_queue_push_mp(struct accept_queue_ring *ring, struct connection *conn)
Willy Tarreau1efafce2019-01-27 15:37:19 +010098{
Willy Tarreau1efafce2019-01-27 15:37:19 +010099 unsigned int pos, next;
100
101 pos = ring->tail;
102 do {
103 next = pos + 1;
104 if (next >= ACCEPT_QUEUE_SIZE)
105 next = 0;
106 if (next == ring->head)
107 return 0; // ring full
Olivier Houchard64213e92019-03-08 18:52:57 +0100108 } while (unlikely(!_HA_ATOMIC_CAS(&ring->tail, &pos, next)));
Willy Tarreau1efafce2019-01-27 15:37:19 +0100109
Willy Tarreau83efc322020-10-14 17:37:17 +0200110 ring->entry[pos] = conn;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100111 __ha_barrier_store();
Willy Tarreau1efafce2019-01-27 15:37:19 +0100112 return 1;
113}
114
115/* proceed with accepting new connections */
116static struct task *accept_queue_process(struct task *t, void *context, unsigned short state)
117{
118 struct accept_queue_ring *ring = context;
Willy Tarreau83efc322020-10-14 17:37:17 +0200119 struct connection *conn;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100120 struct listener *li;
Christopher Faulet102854c2019-04-30 12:17:13 +0200121 unsigned int max_accept;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100122 int ret;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100123
Christopher Faulet102854c2019-04-30 12:17:13 +0200124 /* if global.tune.maxaccept is -1, then max_accept is UINT_MAX. It
125 * is not really illimited, but it is probably enough.
126 */
127 max_accept = global.tune.maxaccept ? global.tune.maxaccept : 64;
128 for (; max_accept; max_accept--) {
Willy Tarreau83efc322020-10-14 17:37:17 +0200129 conn = accept_queue_pop_sc(ring);
130 if (!conn)
Willy Tarreau1efafce2019-01-27 15:37:19 +0100131 break;
132
Willy Tarreau83efc322020-10-14 17:37:17 +0200133 li = __objt_listener(conn->target);
Olivier Houchard64213e92019-03-08 18:52:57 +0100134 _HA_ATOMIC_ADD(&li->thr_conn[tid], 1);
Willy Tarreau83efc322020-10-14 17:37:17 +0200135 ret = li->accept(conn);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100136 if (ret <= 0) {
137 /* connection was terminated by the application */
138 continue;
139 }
140
141 /* increase the per-process number of cumulated sessions, this
142 * may only be done once l->accept() has accepted the connection.
143 */
144 if (!(li->options & LI_O_UNLIMITED)) {
145 HA_ATOMIC_UPDATE_MAX(&global.sps_max,
146 update_freq_ctr(&global.sess_per_sec, 1));
147 if (li->bind_conf && li->bind_conf->is_ssl) {
148 HA_ATOMIC_UPDATE_MAX(&global.ssl_max,
149 update_freq_ctr(&global.ssl_per_sec, 1));
150 }
151 }
152 }
153
154 /* ran out of budget ? Let's come here ASAP */
Christopher Faulet102854c2019-04-30 12:17:13 +0200155 if (!max_accept)
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200156 tasklet_wakeup(ring->tasklet);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100157
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200158 return NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100159}
160
161/* Initializes the accept-queues. Returns 0 on success, otherwise ERR_* flags */
162static int accept_queue_init()
163{
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200164 struct tasklet *t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100165 int i;
166
167 for (i = 0; i < global.nbthread; i++) {
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200168 t = tasklet_new();
Willy Tarreau1efafce2019-01-27 15:37:19 +0100169 if (!t) {
170 ha_alert("Out of memory while initializing accept queue for thread %d\n", i);
171 return ERR_FATAL|ERR_ABORT;
172 }
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200173 t->tid = i;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100174 t->process = accept_queue_process;
175 t->context = &accept_queue_rings[i];
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200176 accept_queue_rings[i].tasklet = t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100177 }
178 return 0;
179}
180
181REGISTER_CONFIG_POSTPARSER("multi-threaded accept queue", accept_queue_init);
182
183#endif // USE_THREAD
184
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200185/* adjust the listener's state and its proxy's listener counters if needed.
186 * It must be called under the listener's lock, but uses atomic ops to change
187 * the proxy's counters so that the proxy lock is not needed.
188 */
Willy Tarreaua37b2442020-09-24 07:23:45 +0200189void listener_set_state(struct listener *l, enum li_state st)
190{
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200191 struct proxy *px = l->bind_conf->frontend;
192
193 if (px) {
194 /* from state */
195 switch (l->state) {
196 case LI_NEW: /* first call */
197 _HA_ATOMIC_ADD(&px->li_all, 1);
198 break;
199 case LI_INIT:
200 case LI_ASSIGNED:
201 break;
202 case LI_PAUSED:
203 _HA_ATOMIC_SUB(&px->li_paused, 1);
204 break;
205 case LI_LISTEN:
206 _HA_ATOMIC_SUB(&px->li_bound, 1);
207 break;
208 case LI_READY:
209 case LI_FULL:
210 case LI_LIMITED:
211 _HA_ATOMIC_SUB(&px->li_ready, 1);
212 break;
213 }
214
215 /* to state */
216 switch (st) {
217 case LI_NEW:
218 case LI_INIT:
219 case LI_ASSIGNED:
220 break;
221 case LI_PAUSED:
Willy Tarreau95a34602020-10-08 15:32:21 +0200222 BUG_ON(l->rx.fd == -1);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200223 _HA_ATOMIC_ADD(&px->li_paused, 1);
224 break;
225 case LI_LISTEN:
Willy Tarreau95a34602020-10-08 15:32:21 +0200226 BUG_ON(l->rx.fd == -1);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200227 _HA_ATOMIC_ADD(&px->li_bound, 1);
228 break;
229 case LI_READY:
230 case LI_FULL:
231 case LI_LIMITED:
Willy Tarreau95a34602020-10-08 15:32:21 +0200232 BUG_ON(l->rx.fd == -1);
Willy Tarreauefc0eec2020-09-24 07:27:06 +0200233 _HA_ATOMIC_ADD(&px->li_ready, 1);
234 break;
235 }
236 }
Willy Tarreaua37b2442020-09-24 07:23:45 +0200237 l->state = st;
238}
239
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100240/* This function adds the specified listener's file descriptor to the polling
241 * lists if it is in the LI_LISTEN state. The listener enters LI_READY or
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500242 * LI_FULL state depending on its number of connections. In daemon mode, we
Willy Tarreauae302532014-05-07 19:22:24 +0200243 * also support binding only the relevant processes to their respective
244 * listeners. We don't do that in debug mode however.
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100245 */
Willy Tarreau7834a3f2020-09-25 16:40:18 +0200246void enable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100247{
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100248 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaud6afb532020-10-09 10:35:40 +0200249
250 /* If this listener is supposed to be only in the master, close it in
251 * the workers. Conversely, if it's supposed to be only in the workers
252 * close it in the master.
253 */
Willy Tarreau18c20d22020-10-09 16:11:46 +0200254 if (!!master != !!(listener->rx.flags & RX_F_MWORKER))
Willy Tarreau75c98d12020-10-09 15:55:23 +0200255 do_unbind_listener(listener);
Willy Tarreaud6afb532020-10-09 10:35:40 +0200256
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100257 if (listener->state == LI_LISTEN) {
Willy Tarreau95a34602020-10-08 15:32:21 +0200258 BUG_ON(listener->rx.fd == -1);
William Lallemand095ba4c2017-06-01 17:38:50 +0200259 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau38dba272020-11-04 13:54:00 +0100260 (!!master != !!(listener->rx.flags & RX_F_MWORKER) ||
261 !(proc_mask(listener->rx.settings->bind_proc) & pid_bit))) {
Willy Tarreauae302532014-05-07 19:22:24 +0200262 /* we don't want to enable this listener and don't
263 * want any fd event to reach it.
264 */
Willy Tarreau75c98d12020-10-09 15:55:23 +0200265 do_unbind_listener(listener);
Willy Tarreauae302532014-05-07 19:22:24 +0200266 }
Willy Tarreaua8cf66b2019-02-27 16:49:00 +0100267 else if (!listener->maxconn || listener->nbconn < listener->maxconn) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200268 listener->rx.proto->enable(listener);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200269 listener_set_state(listener, LI_READY);
Willy Tarreauae302532014-05-07 19:22:24 +0200270 }
271 else {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200272 listener_set_state(listener, LI_FULL);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100273 }
274 }
Willy Tarreaud6afb532020-10-09 10:35:40 +0200275
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100276 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100277}
278
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200279/*
280 * This function completely stops a listener. It will need to operate under the
281 * proxy's lock, the protocol's lock, and the listener's lock. The caller is
282 * responsible for indicating in lpx, lpr, lli whether the respective locks are
283 * already held (non-zero) or not (zero) so that the function picks the missing
284 * ones, in this order. The proxy's listeners count is updated and the proxy is
285 * disabled and woken up after the last one is gone.
286 */
287void stop_listener(struct listener *l, int lpx, int lpr, int lli)
288{
289 struct proxy *px = l->bind_conf->frontend;
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200290
291 if (l->options & LI_O_NOSTOP) {
292 /* master-worker sockpairs are never closed but don't count as a
293 * job.
294 */
295 return;
296 }
297
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200298 if (!lpx)
Willy Tarreauac66d6b2020-10-20 17:24:27 +0200299 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200300
301 if (!lpr)
302 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
303
304 if (!lli)
305 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
306
307 if (l->state > LI_INIT) {
Willy Tarreau75c98d12020-10-09 15:55:23 +0200308 do_unbind_listener(l);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200309
310 if (l->state >= LI_ASSIGNED)
311 __delete_listener(l);
312
Willy Tarreauacde1522020-10-07 16:31:39 +0200313 proxy_cond_disable(px);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200314 }
315
316 if (!lli)
317 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
318
319 if (!lpr)
320 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
321
322 if (!lpx)
Willy Tarreauac66d6b2020-10-20 17:24:27 +0200323 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaucaa7df12020-10-07 15:58:50 +0200324}
325
Willy Tarreaue03204c2020-10-09 17:02:21 +0200326/* default function called to suspend a listener: it simply passes the call to
327 * the underlying receiver. This is find for most socket-based protocols. This
328 * must be called under the listener's lock. It will return non-zero on success,
329 * 0 on failure. If no receiver-level suspend is provided, the operation is
330 * assumed to succeed.
331 */
332int default_suspend_listener(struct listener *l)
333{
334 int ret = 1;
335
336 if (!l->rx.proto->rx_suspend)
337 return 1;
338
339 ret = l->rx.proto->rx_suspend(&l->rx);
340 return ret > 0 ? ret : 0;
341}
342
343
344/* Tries to resume a suspended listener, and returns non-zero on success or
345 * zero on failure. On certain errors, an alert or a warning might be displayed.
346 * It must be called with the listener's lock held. Depending on the listener's
347 * state and protocol, a listen() call might be used to resume operations, or a
348 * call to the receiver's resume() function might be used as well. This is
349 * suitable as a default function for TCP and UDP. This must be called with the
350 * listener's lock held.
351 */
352int default_resume_listener(struct listener *l)
353{
354 int ret = 1;
355
356 if (l->state == LI_ASSIGNED) {
357 char msg[100];
358 int err;
359
360 err = l->rx.proto->listen(l, msg, sizeof(msg));
361 if (err & ERR_ALERT)
362 ha_alert("Resuming listener: %s\n", msg);
363 else if (err & ERR_WARN)
364 ha_warning("Resuming listener: %s\n", msg);
365
366 if (err & (ERR_FATAL | ERR_ABORT)) {
367 ret = 0;
368 goto end;
369 }
370 }
371
372 if (l->state < LI_PAUSED) {
373 ret = 0;
374 goto end;
375 }
376
377 if (l->state == LI_PAUSED && l->rx.proto->rx_resume &&
378 l->rx.proto->rx_resume(&l->rx) <= 0)
379 ret = 0;
380 end:
381 return ret;
382}
383
384
Willy Tarreaube58c382011-07-24 18:28:10 +0200385/* This function tries to temporarily disable a listener, depending on the OS
386 * capabilities. Linux unbinds the listen socket after a SHUT_RD, and ignores
387 * SHUT_WR. Solaris refuses either shutdown(). OpenBSD ignores SHUT_RD but
388 * closes upon SHUT_WR and refuses to rebind. So a common validation path
389 * involves SHUT_WR && listen && SHUT_RD. In case of success, the FD's polling
390 * is disabled. It normally returns non-zero, unless an error is reported.
391 */
392int pause_listener(struct listener *l)
393{
Willy Tarreau58651b42020-09-24 16:03:29 +0200394 struct proxy *px = l->bind_conf->frontend;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200395 int ret = 1;
396
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100397 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200398
Willy Tarreau02e19752020-09-23 17:17:22 +0200399 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
400 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
401 goto end;
402
Willy Tarreau9b3a9322020-09-24 14:46:34 +0200403 if (l->state <= LI_PAUSED)
404 goto end;
405
Willy Tarreaue03204c2020-10-09 17:02:21 +0200406 if (l->rx.proto->suspend)
407 ret = l->rx.proto->suspend(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200408
Olivier Houchard859dc802019-08-08 15:47:21 +0200409 MT_LIST_DEL(&l->wait_queue);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200410
Willy Tarreaua37b2442020-09-24 07:23:45 +0200411 listener_set_state(l, LI_PAUSED);
Willy Tarreau58651b42020-09-24 16:03:29 +0200412
413 if (px && !px->li_ready) {
414 ha_warning("Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
415 send_log(px, LOG_WARNING, "Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
416 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200417 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100418 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200419 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200420}
421
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200422/* This function tries to resume a temporarily disabled listener. Paused, full,
423 * limited and disabled listeners are handled, which means that this function
424 * may replace enable_listener(). The resulting state will either be LI_READY
425 * or LI_FULL. 0 is returned in case of failure to resume (eg: dead socket).
Willy Tarreauae302532014-05-07 19:22:24 +0200426 * Listeners bound to a different process are not woken up unless we're in
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200427 * foreground mode, and are ignored. If the listener was only in the assigned
428 * state, it's totally rebound. This can happen if a pause() has completely
429 * stopped it. If the resume fails, 0 is returned and an error might be
430 * displayed.
Willy Tarreaube58c382011-07-24 18:28:10 +0200431 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100432int resume_listener(struct listener *l)
Willy Tarreaube58c382011-07-24 18:28:10 +0200433{
Willy Tarreau58651b42020-09-24 16:03:29 +0200434 struct proxy *px = l->bind_conf->frontend;
435 int was_paused = px && px->li_paused;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200436 int ret = 1;
437
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100438 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200439
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200440 /* check that another thread didn't to the job in parallel (e.g. at the
441 * end of listen_accept() while we'd come from dequeue_all_listeners().
442 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200443 if (MT_LIST_ADDED(&l->wait_queue))
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200444 goto end;
445
William Lallemand095ba4c2017-06-01 17:38:50 +0200446 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau818a92e2020-09-03 07:50:19 +0200447 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200448 goto end;
Willy Tarreau3569df32017-03-15 12:47:46 +0100449
Willy Tarreau5d7f9ce2020-09-24 18:54:11 +0200450 if (l->state == LI_READY)
451 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200452
Willy Tarreaue03204c2020-10-09 17:02:21 +0200453 if (l->rx.proto->resume)
454 ret = l->rx.proto->resume(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200455
Willy Tarreaua8cf66b2019-02-27 16:49:00 +0100456 if (l->maxconn && l->nbconn >= l->maxconn) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200457 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200458 listener_set_state(l, LI_FULL);
Willy Tarreau58651b42020-09-24 16:03:29 +0200459 goto done;
Willy Tarreaube58c382011-07-24 18:28:10 +0200460 }
461
Willy Tarreau4b51f422020-09-25 20:32:28 +0200462 l->rx.proto->enable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200463 listener_set_state(l, LI_READY);
Willy Tarreau58651b42020-09-24 16:03:29 +0200464
465 done:
466 if (was_paused && !px->li_paused) {
467 ha_warning("Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
468 send_log(px, LOG_WARNING, "Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
469 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200470 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100471 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200472 return ret;
473}
474
Willy Tarreau87b09662015-04-03 00:22:06 +0200475/* Marks a ready listener as full so that the stream code tries to re-enable
Willy Tarreau62793712011-07-24 19:23:38 +0200476 * it upon next close() using resume_listener().
477 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200478static void listener_full(struct listener *l)
Willy Tarreau62793712011-07-24 19:23:38 +0200479{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100480 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200481 if (l->state >= LI_READY) {
Olivier Houchard859dc802019-08-08 15:47:21 +0200482 MT_LIST_DEL(&l->wait_queue);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100483 if (l->state != LI_FULL) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200484 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200485 listener_set_state(l, LI_FULL);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100486 }
Willy Tarreau62793712011-07-24 19:23:38 +0200487 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100488 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200489}
490
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200491/* Marks a ready listener as limited so that we only try to re-enable it when
492 * resources are free again. It will be queued into the specified queue.
493 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200494static void limit_listener(struct listener *l, struct mt_list *list)
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200495{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100496 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200497 if (l->state == LI_READY) {
Willy Tarreaude4db172020-07-10 08:10:29 +0200498 MT_LIST_TRY_ADDQ(list, &l->wait_queue);
Willy Tarreau4b51f422020-09-25 20:32:28 +0200499 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200500 listener_set_state(l, LI_LIMITED);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200501 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100502 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200503}
504
Willy Tarreau241797a2019-12-10 14:10:52 +0100505/* Dequeues all listeners waiting for a resource the global wait queue */
506void dequeue_all_listeners()
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200507{
Willy Tarreau01abd022019-02-28 10:27:18 +0100508 struct listener *listener;
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200509
Willy Tarreau241797a2019-12-10 14:10:52 +0100510 while ((listener = MT_LIST_POP(&global_listener_queue, struct listener *, wait_queue))) {
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200511 /* This cannot fail because the listeners are by definition in
Willy Tarreau01abd022019-02-28 10:27:18 +0100512 * the LI_LIMITED state.
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200513 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100514 resume_listener(listener);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200515 }
516}
517
Willy Tarreau241797a2019-12-10 14:10:52 +0100518/* Dequeues all listeners waiting for a resource in proxy <px>'s queue */
519void dequeue_proxy_listeners(struct proxy *px)
520{
521 struct listener *listener;
522
523 while ((listener = MT_LIST_POP(&px->listener_queue, struct listener *, wait_queue))) {
524 /* This cannot fail because the listeners are by definition in
525 * the LI_LIMITED state.
526 */
527 resume_listener(listener);
528 }
529}
530
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200531
532/* default function used to unbind a listener. This is for use by standard
533 * protocols working on top of accepted sockets. The receiver's rx_unbind()
534 * will automatically be used after the listener is disabled if the socket is
535 * still bound. This must be used under the listener's lock.
Christopher Faulet510c0d62018-03-16 10:04:47 +0100536 */
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200537void default_unbind_listener(struct listener *listener)
Willy Tarreaub648d632007-10-28 22:13:50 +0100538{
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200539 if (listener->state <= LI_ASSIGNED)
540 goto out_close;
541
542 if (listener->rx.fd == -1) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200543 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200544 goto out_close;
545 }
546
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200547 if (listener->state >= LI_READY) {
548 listener->rx.proto->disable(listener);
549 if (listener->rx.flags & RX_F_BOUND)
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200550 listener_set_state(listener, LI_LISTEN);
Willy Tarreaub6607bf2020-09-23 16:24:23 +0200551 }
552
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200553 out_close:
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200554 if (listener->rx.flags & RX_F_BOUND)
555 listener->rx.proto->rx_unbind(&listener->rx);
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200556}
557
558/* This function closes the listening socket for the specified listener,
559 * provided that it's already in a listening state. The protocol's unbind()
560 * is called to put the listener into LI_ASSIGNED or LI_LISTEN and handle
561 * the unbinding tasks. The listener enters then the LI_ASSIGNED state if
562 * the receiver is unbound. Must be called with the lock held.
563 */
564void do_unbind_listener(struct listener *listener)
565{
566 MT_LIST_DEL(&listener->wait_queue);
567
568 if (listener->rx.proto->unbind)
569 listener->rx.proto->unbind(listener);
Willy Tarreau374e9af2020-10-09 15:47:17 +0200570
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200571 /* we may have to downgrade the listener if the rx was closed */
572 if (!(listener->rx.flags & RX_F_BOUND) && listener->state > LI_ASSIGNED)
Willy Tarreau374e9af2020-10-09 15:47:17 +0200573 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100574}
575
Olivier Houchard1fc05162017-04-06 01:05:05 +0200576/* This function closes the listening socket for the specified listener,
577 * provided that it's already in a listening state. The listener enters the
Willy Tarreau75c98d12020-10-09 15:55:23 +0200578 * LI_ASSIGNED state, except if the FD is not closed, in which case it may
579 * remain in LI_LISTEN. This function is intended to be used as a generic
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100580 * function for standard protocols.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200581 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100582void unbind_listener(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200583{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100584 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau75c98d12020-10-09 15:55:23 +0200585 do_unbind_listener(listener);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100586 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200587}
588
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200589/* creates one or multiple listeners for bind_conf <bc> on sockaddr <ss> on port
590 * range <portl> to <porth>, and possibly attached to fd <fd> (or -1 for auto
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200591 * allocation). The address family is taken from ss->ss_family, and the protocol
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200592 * passed in <proto> must be usable on this family. The protocol's default iocb
593 * is automatically preset as the receivers' iocb. The number of jobs and
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200594 * listeners is automatically increased by the number of listeners created. It
595 * returns non-zero on success, zero on error with the error message set in <err>.
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200596 */
597int create_listeners(struct bind_conf *bc, const struct sockaddr_storage *ss,
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200598 int portl, int porth, int fd, struct protocol *proto, char **err)
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200599{
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200600 struct listener *l;
601 int port;
602
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200603 for (port = portl; port <= porth; port++) {
604 l = calloc(1, sizeof(*l));
605 if (!l) {
606 memprintf(err, "out of memory");
607 return 0;
608 }
609 l->obj_type = OBJ_TYPE_LISTENER;
610 LIST_ADDQ(&bc->frontend->conf.listeners, &l->by_fe);
611 LIST_ADDQ(&bc->listeners, &l->by_bind);
612 l->bind_conf = bc;
Willy Tarreau0fce6bc2020-09-03 07:46:06 +0200613 l->rx.settings = &bc->settings;
Willy Tarreaueef45422020-09-03 10:05:03 +0200614 l->rx.owner = l;
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200615 l->rx.iocb = proto->default_iocb;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200616 l->rx.fd = fd;
Willy Tarreaud7c746e2020-12-04 14:49:11 +0100617
Willy Tarreau37159062020-08-27 07:48:42 +0200618 memcpy(&l->rx.addr, ss, sizeof(*ss));
Willy Tarreaud7c746e2020-12-04 14:49:11 +0100619 if (proto->fam.set_port)
620 proto->fam.set_port(&l->rx.addr, port);
621
Olivier Houchard859dc802019-08-08 15:47:21 +0200622 MT_LIST_INIT(&l->wait_queue);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200623 listener_set_state(l, LI_INIT);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200624
625 proto->add(l, port);
626
Willy Tarreau909c23b2020-09-15 13:50:58 +0200627 if (fd != -1)
Willy Tarreau43046fa2020-09-01 15:41:59 +0200628 l->rx.flags |= RX_F_INHERITED;
William Lallemand75ea0a02017-11-15 19:02:58 +0100629
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100630 HA_SPIN_INIT(&l->lock);
Olivier Houchard64213e92019-03-08 18:52:57 +0100631 _HA_ATOMIC_ADD(&jobs, 1);
632 _HA_ATOMIC_ADD(&listeners, 1);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200633 }
634 return 1;
635}
636
Willy Tarreau1a64d162007-10-28 22:26:05 +0100637/* Delete a listener from its protocol's list of listeners. The listener's
638 * state is automatically updated from LI_ASSIGNED to LI_INIT. The protocol's
Willy Tarreau2cc5bae2017-09-15 08:18:11 +0200639 * number of listeners is updated, as well as the global number of listeners
640 * and jobs. Note that the listener must have previously been unbound. This
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200641 * is a low-level function expected to be called with the proto_lock and the
642 * listener's lock held.
Willy Tarreau1a64d162007-10-28 22:26:05 +0100643 */
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200644void __delete_listener(struct listener *listener)
Willy Tarreau1a64d162007-10-28 22:26:05 +0100645{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100646 if (listener->state == LI_ASSIGNED) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200647 listener_set_state(listener, LI_INIT);
Willy Tarreaub7436612020-08-28 19:51:44 +0200648 LIST_DEL(&listener->rx.proto_list);
Willy Tarreaud7f331c2020-09-25 17:01:43 +0200649 listener->rx.proto->nb_receivers--;
Olivier Houchard64213e92019-03-08 18:52:57 +0100650 _HA_ATOMIC_SUB(&jobs, 1);
651 _HA_ATOMIC_SUB(&listeners, 1);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100652 }
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200653}
654
655/* Delete a listener from its protocol's list of listeners (please check
656 * __delete_listener() above). The proto_lock and the listener's lock will
657 * be grabbed in this order.
658 */
659void delete_listener(struct listener *listener)
660{
661 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
662 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
663 __delete_listener(listener);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100664 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau6ee9f8d2019-08-26 10:55:52 +0200665 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100666}
667
Willy Tarreaue2711c72019-02-27 15:39:41 +0100668/* Returns a suitable value for a listener's backlog. It uses the listener's,
669 * otherwise the frontend's backlog, otherwise the listener's maxconn,
670 * otherwise the frontend's maxconn, otherwise 1024.
671 */
672int listener_backlog(const struct listener *l)
673{
674 if (l->backlog)
675 return l->backlog;
676
677 if (l->bind_conf->frontend->backlog)
678 return l->bind_conf->frontend->backlog;
679
680 if (l->maxconn)
681 return l->maxconn;
682
683 if (l->bind_conf->frontend->maxconn)
684 return l->bind_conf->frontend->maxconn;
685
686 return 1024;
687}
688
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200689/* This function is called on a read event from a listening socket, corresponding
690 * to an accept. It tries to accept as many connections as possible, and for each
691 * calls the listener's accept handler (generally the frontend's accept handler).
692 */
Willy Tarreaua74cb382020-10-15 21:29:49 +0200693void listener_accept(struct listener *l)
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200694{
Willy Tarreau83efc322020-10-14 17:37:17 +0200695 struct connection *cli_conn;
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100696 struct proxy *p;
Christopher Faulet102854c2019-04-30 12:17:13 +0200697 unsigned int max_accept;
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100698 int next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100699 int next_feconn = 0;
700 int next_actconn = 0;
Willy Tarreaubb660302014-05-07 19:47:02 +0200701 int expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200702 int ret;
703
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100704 p = l->bind_conf->frontend;
Christopher Faulet102854c2019-04-30 12:17:13 +0200705
706 /* if l->maxaccept is -1, then max_accept is UINT_MAX. It is not really
707 * illimited, but it is probably enough.
708 */
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100709 max_accept = l->maxaccept ? l->maxaccept : 1;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200710
Willy Tarreau93e7c002013-10-07 18:51:07 +0200711 if (!(l->options & LI_O_UNLIMITED) && global.sps_lim) {
712 int max = freq_ctr_remain(&global.sess_per_sec, global.sps_lim, 0);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200713
714 if (unlikely(!max)) {
715 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200716 expire = tick_add(now_ms, next_event_delay(&global.sess_per_sec, global.sps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100717 goto limit_global;
Willy Tarreau93e7c002013-10-07 18:51:07 +0200718 }
719
720 if (max_accept > max)
721 max_accept = max;
722 }
723
724 if (!(l->options & LI_O_UNLIMITED) && global.cps_lim) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200725 int max = freq_ctr_remain(&global.conn_per_sec, global.cps_lim, 0);
726
727 if (unlikely(!max)) {
728 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200729 expire = tick_add(now_ms, next_event_delay(&global.conn_per_sec, global.cps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100730 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200731 }
732
733 if (max_accept > max)
734 max_accept = max;
735 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200736#ifdef USE_OPENSSL
737 if (!(l->options & LI_O_UNLIMITED) && global.ssl_lim && l->bind_conf && l->bind_conf->is_ssl) {
738 int max = freq_ctr_remain(&global.ssl_per_sec, global.ssl_lim, 0);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200739
Willy Tarreaue43d5322013-10-07 20:01:52 +0200740 if (unlikely(!max)) {
741 /* frontend accept rate limit was reached */
Willy Tarreaue43d5322013-10-07 20:01:52 +0200742 expire = tick_add(now_ms, next_event_delay(&global.ssl_per_sec, global.ssl_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100743 goto limit_global;
Willy Tarreaue43d5322013-10-07 20:01:52 +0200744 }
745
746 if (max_accept > max)
747 max_accept = max;
748 }
749#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200750 if (p && p->fe_sps_lim) {
751 int max = freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0);
752
753 if (unlikely(!max)) {
754 /* frontend accept rate limit was reached */
Willy Tarreau0591bf72019-12-10 12:01:21 +0100755 expire = tick_add(now_ms, next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0));
756 goto limit_proxy;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200757 }
758
759 if (max_accept > max)
760 max_accept = max;
761 }
762
763 /* Note: if we fail to allocate a connection because of configured
764 * limits, we'll schedule a new attempt worst 1 second later in the
765 * worst case. If we fail due to system limits or temporary resource
766 * shortage, we try again 100ms later in the worst case.
767 */
Christopher Faulet102854c2019-04-30 12:17:13 +0200768 for (; max_accept; next_conn = next_feconn = next_actconn = 0, max_accept--) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200769 unsigned int count;
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200770 int status;
Willy Tarreau0aa5a5b2020-10-16 17:43:04 +0200771 __decl_thread(unsigned long mask);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200772
Willy Tarreau82c97892019-02-27 19:32:32 +0100773 /* pre-increase the number of connections without going too far.
774 * We process the listener, then the proxy, then the process.
775 * We know which ones to unroll based on the next_xxx value.
776 */
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100777 do {
778 count = l->nbconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100779 if (unlikely(l->maxconn && count >= l->maxconn)) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100780 /* the listener was marked full or another
781 * thread is going to do it.
782 */
783 next_conn = 0;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100784 listener_full(l);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100785 goto end;
786 }
787 next_conn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000788 } while (!_HA_ATOMIC_CAS(&l->nbconn, (int *)(&count), next_conn));
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100789
Willy Tarreau82c97892019-02-27 19:32:32 +0100790 if (p) {
791 do {
792 count = p->feconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100793 if (unlikely(count >= p->maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100794 /* the frontend was marked full or another
795 * thread is going to do it.
796 */
797 next_feconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100798 expire = TICK_ETERNITY;
799 goto limit_proxy;
Willy Tarreau82c97892019-02-27 19:32:32 +0100800 }
801 next_feconn = count + 1;
Olivier Houchard64213e92019-03-08 18:52:57 +0100802 } while (!_HA_ATOMIC_CAS(&p->feconn, &count, next_feconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200803 }
804
Willy Tarreau82c97892019-02-27 19:32:32 +0100805 if (!(l->options & LI_O_UNLIMITED)) {
806 do {
807 count = actconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100808 if (unlikely(count >= global.maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100809 /* the process was marked full or another
810 * thread is going to do it.
811 */
812 next_actconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100813 expire = tick_add(now_ms, 1000); /* try again in 1 second */
814 goto limit_global;
Willy Tarreau82c97892019-02-27 19:32:32 +0100815 }
816 next_actconn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000817 } while (!_HA_ATOMIC_CAS(&actconn, (int *)(&count), next_actconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200818 }
819
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200820 cli_conn = l->rx.proto->accept_conn(l, &status);
821 if (!cli_conn) {
822 switch (status) {
823 case CO_AC_DONE:
824 goto end;
Willy Tarreau818dca52014-01-31 19:40:19 +0100825
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200826 case CO_AC_RETRY: /* likely a signal */
Olivier Houchard64213e92019-03-08 18:52:57 +0100827 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100828 if (p)
Olivier Houchard64213e92019-03-08 18:52:57 +0100829 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100830 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +0100831 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreaua593ec52014-01-20 21:21:30 +0100832 continue;
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200833
834 case CO_AC_YIELD:
Willy Tarreau92079932019-12-10 09:30:05 +0100835 max_accept = 0;
836 goto end;
William Lallemandd9138002018-11-27 12:02:39 +0100837
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200838 default:
839 goto transient_error;
Willy Tarreau83efc322020-10-14 17:37:17 +0200840 }
841 }
842
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100843 /* The connection was accepted, it must be counted as such */
844 if (l->counters)
845 HA_ATOMIC_UPDATE_MAX(&l->counters->conn_max, next_conn);
846
Willy Tarreau82c97892019-02-27 19:32:32 +0100847 if (p)
848 HA_ATOMIC_UPDATE_MAX(&p->fe_counters.conn_max, next_feconn);
849
850 proxy_inc_fe_conn_ctr(l, p);
851
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100852 if (!(l->options & LI_O_UNLIMITED)) {
853 count = update_freq_ctr(&global.conn_per_sec, 1);
854 HA_ATOMIC_UPDATE_MAX(&global.cps_max, count);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100855 }
856
Willy Tarreau64a9c052019-04-12 15:27:17 +0200857 _HA_ATOMIC_ADD(&activity[tid].accepted, 1);
858
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200859 if (unlikely(cli_conn->handle.fd >= global.maxsock)) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200860 send_log(p, LOG_EMERG,
861 "Proxy %s reached the configured maximum connection limit. Please check the global 'maxconn' value.\n",
862 p->id);
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200863 close(cli_conn->handle.fd);
William Dauchy835712a2020-10-18 18:37:43 +0200864 conn_free(cli_conn);
Willy Tarreau0591bf72019-12-10 12:01:21 +0100865 expire = tick_add(now_ms, 1000); /* try again in 1 second */
866 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200867 }
868
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100869 /* past this point, l->accept() will automatically decrement
Willy Tarreau82c97892019-02-27 19:32:32 +0100870 * l->nbconn, feconn and actconn once done. Setting next_*conn=0
871 * allows the error path not to rollback on nbconn. It's more
872 * convenient than duplicating all exit labels.
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100873 */
874 next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100875 next_feconn = 0;
876 next_actconn = 0;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200877
Willy Tarreau83efc322020-10-14 17:37:17 +0200878
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100879#if defined(USE_THREAD)
Willy Tarreau818a92e2020-09-03 07:50:19 +0200880 mask = thread_mask(l->rx.settings->bind_thread) & all_threads_mask;
Willy Tarreaua7da5e82020-03-12 17:33:29 +0100881 if (atleast2(mask) && (global.tune.options & GTUNE_LISTENER_MQ) && !stopping) {
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100882 struct accept_queue_ring *ring;
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100883 unsigned int t, t0, t1, t2;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100884
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100885 /* The principle is that we have two running indexes,
886 * each visiting in turn all threads bound to this
887 * listener. The connection will be assigned to the one
888 * with the least connections, and the other one will
889 * be updated. This provides a good fairness on short
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100890 * connections (round robin) and on long ones (conn
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100891 * count), without ever missing any idle thread.
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100892 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100893
894 /* keep a copy for the final update. thr_idx is composite
895 * and made of (t2<<16) + t1.
896 */
Willy Tarreau0cf33172019-03-06 15:26:33 +0100897 t0 = l->thr_idx;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100898 do {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100899 unsigned long m1, m2;
900 int q1, q2;
901
902 t2 = t1 = t0;
903 t2 >>= 16;
904 t1 &= 0xFFFF;
905
906 /* t1 walks low to high bits ;
907 * t2 walks high to low.
908 */
909 m1 = mask >> t1;
910 m2 = mask & (t2 ? nbits(t2 + 1) : ~0UL);
911
Willy Tarreau85d04242019-04-16 18:09:13 +0200912 if (unlikely(!(m1 & 1))) {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100913 m1 &= ~1UL;
914 if (!m1) {
915 m1 = mask;
916 t1 = 0;
917 }
918 t1 += my_ffsl(m1) - 1;
919 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100920
Willy Tarreau85d04242019-04-16 18:09:13 +0200921 if (unlikely(!(m2 & (1UL << t2)) || t1 == t2)) {
922 /* highest bit not set */
923 if (!m2)
924 m2 = mask;
925
926 t2 = my_flsl(m2) - 1;
927 }
928
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100929 /* now we have two distinct thread IDs belonging to the mask */
930 q1 = accept_queue_rings[t1].tail - accept_queue_rings[t1].head + ACCEPT_QUEUE_SIZE;
931 if (q1 >= ACCEPT_QUEUE_SIZE)
932 q1 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100933
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100934 q2 = accept_queue_rings[t2].tail - accept_queue_rings[t2].head + ACCEPT_QUEUE_SIZE;
935 if (q2 >= ACCEPT_QUEUE_SIZE)
936 q2 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100937
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100938 /* we have 3 possibilities now :
939 * q1 < q2 : t1 is less loaded than t2, so we pick it
940 * and update t2 (since t1 might still be
941 * lower than another thread)
942 * q1 > q2 : t2 is less loaded than t1, so we pick it
943 * and update t1 (since t2 might still be
944 * lower than another thread)
945 * q1 = q2 : both are equally loaded, thus we pick t1
946 * and update t1 as it will become more loaded
947 * than t2.
948 */
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100949
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100950 q1 += l->thr_conn[t1];
951 q2 += l->thr_conn[t2];
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100952
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100953 if (q1 - q2 < 0) {
954 t = t1;
955 t2 = t2 ? t2 - 1 : LONGBITS - 1;
956 }
957 else if (q1 - q2 > 0) {
958 t = t2;
959 t1++;
960 if (t1 >= LONGBITS)
961 t1 = 0;
962 }
963 else {
964 t = t1;
965 t1++;
966 if (t1 >= LONGBITS)
967 t1 = 0;
968 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100969
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100970 /* new value for thr_idx */
971 t1 += (t2 << 16);
Olivier Houchard64213e92019-03-08 18:52:57 +0100972 } while (unlikely(!_HA_ATOMIC_CAS(&l->thr_idx, &t0, t1)));
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100973
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100974 /* We successfully selected the best thread "t" for this
975 * connection. We use deferred accepts even if it's the
976 * local thread because tests show that it's the best
977 * performing model, likely due to better cache locality
978 * when processing this loop.
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100979 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100980 ring = &accept_queue_rings[t];
Willy Tarreau83efc322020-10-14 17:37:17 +0200981 if (accept_queue_push_mp(ring, cli_conn)) {
Olivier Houchard64213e92019-03-08 18:52:57 +0100982 _HA_ATOMIC_ADD(&activity[t].accq_pushed, 1);
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200983 tasklet_wakeup(ring->tasklet);
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100984 continue;
985 }
986 /* If the ring is full we do a synchronous accept on
987 * the local thread here.
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100988 */
Olivier Houchard64213e92019-03-08 18:52:57 +0100989 _HA_ATOMIC_ADD(&activity[t].accq_full, 1);
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100990 }
991#endif // USE_THREAD
992
Olivier Houchard64213e92019-03-08 18:52:57 +0100993 _HA_ATOMIC_ADD(&l->thr_conn[tid], 1);
Willy Tarreau83efc322020-10-14 17:37:17 +0200994 ret = l->accept(cli_conn);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200995 if (unlikely(ret <= 0)) {
Willy Tarreau87b09662015-04-03 00:22:06 +0200996 /* The connection was closed by stream_accept(). Either
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200997 * we just have to ignore it (ret == 0) or it's a critical
998 * error due to a resource shortage, and we must stop the
999 * listener (ret < 0).
1000 */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001001 if (ret == 0) /* successful termination */
1002 continue;
1003
Willy Tarreaubb660302014-05-07 19:47:02 +02001004 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001005 }
1006
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001007 /* increase the per-process number of cumulated sessions, this
1008 * may only be done once l->accept() has accepted the connection.
1009 */
Willy Tarreau93e7c002013-10-07 18:51:07 +02001010 if (!(l->options & LI_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001011 count = update_freq_ctr(&global.sess_per_sec, 1);
1012 HA_ATOMIC_UPDATE_MAX(&global.sps_max, count);
Willy Tarreau93e7c002013-10-07 18:51:07 +02001013 }
Willy Tarreaue43d5322013-10-07 20:01:52 +02001014#ifdef USE_OPENSSL
1015 if (!(l->options & LI_O_UNLIMITED) && l->bind_conf && l->bind_conf->is_ssl) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001016 count = update_freq_ctr(&global.ssl_per_sec, 1);
1017 HA_ATOMIC_UPDATE_MAX(&global.ssl_max, count);
Willy Tarreaue43d5322013-10-07 20:01:52 +02001018 }
1019#endif
Willy Tarreau93e7c002013-10-07 18:51:07 +02001020
Willy Tarreau8d2c98b2020-05-01 09:51:11 +02001021 ti->flags &= ~TI_FL_STUCK; // this thread is still running
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001022 } /* end of for (max_accept--) */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001023
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001024 end:
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001025 if (next_conn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001026 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau741b4d62019-02-25 15:02:04 +01001027
Willy Tarreau82c97892019-02-27 19:32:32 +01001028 if (p && next_feconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001029 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001030
1031 if (next_actconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001032 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001033
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001034 if ((l->state == LI_FULL && (!l->maxconn || l->nbconn < l->maxconn)) ||
Willy Tarreaucdcba112019-12-11 15:06:30 +01001035 (l->state == LI_LIMITED &&
1036 ((!p || p->feconn < p->maxconn) && (actconn < global.maxconn) &&
1037 (!tick_isset(global_listener_queue_task->expire) ||
1038 tick_is_expired(global_listener_queue_task->expire, now_ms))))) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001039 /* at least one thread has to this when quitting */
1040 resume_listener(l);
1041
1042 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001043 dequeue_all_listeners();
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001044
Olivier Houchard859dc802019-08-08 15:47:21 +02001045 if (p && !MT_LIST_ISEMPTY(&p->listener_queue) &&
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001046 (!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 +01001047 dequeue_proxy_listeners(p);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001048 }
Willy Tarreau0591bf72019-12-10 12:01:21 +01001049 return;
1050
1051 transient_error:
1052 /* pause the listener for up to 100 ms */
1053 expire = tick_add(now_ms, 100);
1054
Willy Tarreau258b3512020-10-13 17:46:05 +02001055 /* This may be a shared socket that was paused by another process.
1056 * Let's put it to pause in this case.
1057 */
1058 if (l->rx.proto && l->rx.proto->rx_listening(&l->rx) == 0) {
1059 pause_listener(l);
1060 goto end;
1061 }
1062
Willy Tarreau0591bf72019-12-10 12:01:21 +01001063 limit_global:
1064 /* (re-)queue the listener to the global queue and set it to expire no
1065 * later than <expire> ahead. The listener turns to LI_LIMITED.
1066 */
1067 limit_listener(l, &global_listener_queue);
1068 task_schedule(global_listener_queue_task, expire);
1069 goto end;
1070
1071 limit_proxy:
1072 /* (re-)queue the listener to the proxy's queue and set it to expire no
1073 * later than <expire> ahead. The listener turns to LI_LIMITED.
1074 */
1075 limit_listener(l, &p->listener_queue);
Willy Tarreaueeea8082020-01-08 19:15:07 +01001076 if (p->task && tick_isset(expire))
1077 task_schedule(p->task, expire);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001078 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001079}
1080
Willy Tarreau05f50472017-09-15 09:19:58 +02001081/* Notify the listener that a connection initiated from it was released. This
1082 * is used to keep the connection count consistent and to possibly re-open
1083 * listening when it was limited.
1084 */
1085void listener_release(struct listener *l)
1086{
1087 struct proxy *fe = l->bind_conf->frontend;
1088
1089 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +01001090 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001091 if (fe)
Olivier Houchard64213e92019-03-08 18:52:57 +01001092 _HA_ATOMIC_SUB(&fe->feconn, 1);
1093 _HA_ATOMIC_SUB(&l->nbconn, 1);
1094 _HA_ATOMIC_SUB(&l->thr_conn[tid], 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001095
1096 if (l->state == LI_FULL || l->state == LI_LIMITED)
Willy Tarreau05f50472017-09-15 09:19:58 +02001097 resume_listener(l);
1098
1099 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001100 dequeue_all_listeners();
Willy Tarreau05f50472017-09-15 09:19:58 +02001101
Olivier Houchard859dc802019-08-08 15:47:21 +02001102 if (!MT_LIST_ISEMPTY(&fe->listener_queue) &&
Willy Tarreau05f50472017-09-15 09:19:58 +02001103 (!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 +01001104 dequeue_proxy_listeners(fe);
Willy Tarreau05f50472017-09-15 09:19:58 +02001105}
1106
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001107/* Initializes the listener queues. Returns 0 on success, otherwise ERR_* flags */
1108static int listener_queue_init()
1109{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001110 global_listener_queue_task = task_new(MAX_THREADS_MASK);
1111 if (!global_listener_queue_task) {
1112 ha_alert("Out of memory when initializing global listener queue\n");
1113 return ERR_FATAL|ERR_ABORT;
1114 }
1115 /* very simple initialization, users will queue the task if needed */
1116 global_listener_queue_task->context = NULL; /* not even a context! */
1117 global_listener_queue_task->process = manage_global_listener_queue;
1118
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001119 return 0;
1120}
1121
1122static void listener_queue_deinit()
1123{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001124 task_destroy(global_listener_queue_task);
1125 global_listener_queue_task = NULL;
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001126}
1127
1128REGISTER_CONFIG_POSTPARSER("multi-threaded listener queue", listener_queue_init);
1129REGISTER_POST_DEINIT(listener_queue_deinit);
1130
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001131
1132/* This is the global management task for listeners. It enables listeners waiting
1133 * for global resources when there are enough free resource, or at least once in
1134 * a while. It is designed to be called as a task.
1135 */
1136static struct task *manage_global_listener_queue(struct task *t, void *context, unsigned short state)
1137{
1138 /* If there are still too many concurrent connections, let's wait for
1139 * some of them to go away. We don't need to re-arm the timer because
1140 * each of them will scan the queue anyway.
1141 */
1142 if (unlikely(actconn >= global.maxconn))
1143 goto out;
1144
1145 /* We should periodically try to enable listeners waiting for a global
1146 * resource here, because it is possible, though very unlikely, that
1147 * they have been blocked by a temporary lack of global resource such
1148 * as a file descriptor or memory and that the temporary condition has
1149 * disappeared.
1150 */
1151 dequeue_all_listeners();
1152
1153 out:
1154 t->expire = TICK_ETERNITY;
1155 task_queue(t);
1156 return t;
1157}
1158
Willy Tarreau26982662012-09-12 23:17:10 +02001159/*
1160 * Registers the bind keyword list <kwl> as a list of valid keywords for next
1161 * parsing sessions.
1162 */
1163void bind_register_keywords(struct bind_kw_list *kwl)
1164{
1165 LIST_ADDQ(&bind_keywords.list, &kwl->list);
1166}
1167
1168/* Return a pointer to the bind keyword <kw>, or NULL if not found. If the
1169 * keyword is found with a NULL ->parse() function, then an attempt is made to
1170 * find one with a valid ->parse() function. This way it is possible to declare
1171 * platform-dependant, known keywords as NULL, then only declare them as valid
1172 * if some options are met. Note that if the requested keyword contains an
1173 * opening parenthesis, everything from this point is ignored.
1174 */
1175struct bind_kw *bind_find_kw(const char *kw)
1176{
1177 int index;
1178 const char *kwend;
1179 struct bind_kw_list *kwl;
1180 struct bind_kw *ret = NULL;
1181
1182 kwend = strchr(kw, '(');
1183 if (!kwend)
1184 kwend = kw + strlen(kw);
1185
1186 list_for_each_entry(kwl, &bind_keywords.list, list) {
1187 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1188 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
1189 kwl->kw[index].kw[kwend-kw] == 0) {
1190 if (kwl->kw[index].parse)
1191 return &kwl->kw[index]; /* found it !*/
1192 else
1193 ret = &kwl->kw[index]; /* may be OK */
1194 }
1195 }
1196 }
1197 return ret;
1198}
1199
Willy Tarreau8638f482012-09-18 18:01:17 +02001200/* Dumps all registered "bind" keywords to the <out> string pointer. The
1201 * unsupported keywords are only dumped if their supported form was not
1202 * found.
1203 */
1204void bind_dump_kws(char **out)
1205{
1206 struct bind_kw_list *kwl;
1207 int index;
1208
Christopher Faulet784063e2020-05-18 12:14:18 +02001209 if (!out)
1210 return;
1211
Willy Tarreau8638f482012-09-18 18:01:17 +02001212 *out = NULL;
1213 list_for_each_entry(kwl, &bind_keywords.list, list) {
1214 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1215 if (kwl->kw[index].parse ||
1216 bind_find_kw(kwl->kw[index].kw) == &kwl->kw[index]) {
Willy Tarreau51fb7652012-09-18 18:24:39 +02001217 memprintf(out, "%s[%4s] %s%s%s\n", *out ? *out : "",
1218 kwl->scope,
Willy Tarreau8638f482012-09-18 18:01:17 +02001219 kwl->kw[index].kw,
Willy Tarreau51fb7652012-09-18 18:24:39 +02001220 kwl->kw[index].skip ? " <arg>" : "",
1221 kwl->kw[index].parse ? "" : " (not supported)");
Willy Tarreau8638f482012-09-18 18:01:17 +02001222 }
1223 }
1224 }
1225}
1226
Willy Tarreau645513a2010-05-24 20:55:15 +02001227/************************************************************************/
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001228/* All supported sample and ACL keywords must be declared here. */
Willy Tarreau645513a2010-05-24 20:55:15 +02001229/************************************************************************/
1230
Willy Tarreaua5e37562011-12-16 17:06:15 +01001231/* set temp integer to the number of connexions to the same listening socket */
Willy Tarreau645513a2010-05-24 20:55:15 +02001232static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001233smp_fetch_dconn(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau645513a2010-05-24 20:55:15 +02001234{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001235 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001236 smp->data.u.sint = smp->sess->listener->nbconn;
Willy Tarreau645513a2010-05-24 20:55:15 +02001237 return 1;
1238}
1239
Willy Tarreaua5e37562011-12-16 17:06:15 +01001240/* set temp integer to the id of the socket (listener) */
Willy Tarreau645513a2010-05-24 20:55:15 +02001241static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001242smp_fetch_so_id(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau37406352012-04-23 16:16:37 +02001243{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001244 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001245 smp->data.u.sint = smp->sess->listener->luid;
Willy Tarreau645513a2010-05-24 20:55:15 +02001246 return 1;
1247}
Jerome Magnineb421b22020-03-27 22:08:40 +01001248static int
1249smp_fetch_so_name(const struct arg *args, struct sample *smp, const char *kw, void *private)
1250{
1251 smp->data.u.str.area = smp->sess->listener->name;
1252 if (!smp->data.u.str.area)
1253 return 0;
1254
1255 smp->data.type = SMP_T_STR;
1256 smp->flags = SMP_F_CONST;
1257 smp->data.u.str.data = strlen(smp->data.u.str.area);
1258 return 1;
1259}
Willy Tarreau645513a2010-05-24 20:55:15 +02001260
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001261/* parse the "accept-proxy" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001262static 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 +02001263{
1264 struct listener *l;
1265
Willy Tarreau4348fad2012-09-20 16:48:07 +02001266 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001267 l->options |= LI_O_ACC_PROXY;
1268
1269 return 0;
1270}
1271
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001272/* parse the "accept-netscaler-cip" bind keyword */
1273static int bind_parse_accept_netscaler_cip(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1274{
1275 struct listener *l;
1276 uint32_t val;
1277
1278 if (!*args[cur_arg + 1]) {
1279 memprintf(err, "'%s' : missing value", args[cur_arg]);
1280 return ERR_ALERT | ERR_FATAL;
1281 }
1282
1283 val = atol(args[cur_arg + 1]);
1284 if (val <= 0) {
Willy Tarreaue2711c72019-02-27 15:39:41 +01001285 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001286 return ERR_ALERT | ERR_FATAL;
1287 }
1288
1289 list_for_each_entry(l, &conf->listeners, by_bind) {
1290 l->options |= LI_O_ACC_CIP;
1291 conf->ns_cip_magic = val;
1292 }
1293
1294 return 0;
1295}
1296
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001297/* parse the "backlog" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001298static 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 +02001299{
1300 struct listener *l;
1301 int val;
1302
1303 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001304 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001305 return ERR_ALERT | ERR_FATAL;
1306 }
1307
1308 val = atol(args[cur_arg + 1]);
Willy Tarreaue2711c72019-02-27 15:39:41 +01001309 if (val < 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001310 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001311 return ERR_ALERT | ERR_FATAL;
1312 }
1313
Willy Tarreau4348fad2012-09-20 16:48:07 +02001314 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001315 l->backlog = val;
1316
1317 return 0;
1318}
1319
1320/* parse the "id" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001321static 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 +02001322{
1323 struct eb32_node *node;
Willy Tarreau4348fad2012-09-20 16:48:07 +02001324 struct listener *l, *new;
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001325 char *error;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001326
Willy Tarreau4348fad2012-09-20 16:48:07 +02001327 if (conf->listeners.n != conf->listeners.p) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001328 memprintf(err, "'%s' can only be used with a single socket", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001329 return ERR_ALERT | ERR_FATAL;
1330 }
1331
1332 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001333 memprintf(err, "'%s' : expects an integer argument", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001334 return ERR_ALERT | ERR_FATAL;
1335 }
1336
Willy Tarreau4348fad2012-09-20 16:48:07 +02001337 new = LIST_NEXT(&conf->listeners, struct listener *, by_bind);
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001338 new->luid = strtol(args[cur_arg + 1], &error, 10);
1339 if (*error != '\0') {
1340 memprintf(err, "'%s' : expects an integer argument, found '%s'", args[cur_arg], args[cur_arg + 1]);
1341 return ERR_ALERT | ERR_FATAL;
1342 }
Willy Tarreau4348fad2012-09-20 16:48:07 +02001343 new->conf.id.key = new->luid;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001344
Willy Tarreau4348fad2012-09-20 16:48:07 +02001345 if (new->luid <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001346 memprintf(err, "'%s' : custom id has to be > 0", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001347 return ERR_ALERT | ERR_FATAL;
1348 }
1349
Willy Tarreau4348fad2012-09-20 16:48:07 +02001350 node = eb32_lookup(&px->conf.used_listener_id, new->luid);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001351 if (node) {
1352 l = container_of(node, struct listener, conf.id);
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001353 memprintf(err, "'%s' : custom id %d already used at %s:%d ('bind %s')",
1354 args[cur_arg], l->luid, l->bind_conf->file, l->bind_conf->line,
1355 l->bind_conf->arg);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001356 return ERR_ALERT | ERR_FATAL;
1357 }
1358
Willy Tarreau4348fad2012-09-20 16:48:07 +02001359 eb32_insert(&px->conf.used_listener_id, &new->conf.id);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001360 return 0;
1361}
1362
1363/* parse the "maxconn" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001364static 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 +02001365{
1366 struct listener *l;
1367 int val;
1368
1369 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001370 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001371 return ERR_ALERT | ERR_FATAL;
1372 }
1373
1374 val = atol(args[cur_arg + 1]);
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001375 if (val < 0) {
1376 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001377 return ERR_ALERT | ERR_FATAL;
1378 }
1379
Willy Tarreau4348fad2012-09-20 16:48:07 +02001380 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001381 l->maxconn = val;
1382
1383 return 0;
1384}
1385
1386/* parse the "name" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001387static 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 +02001388{
1389 struct listener *l;
1390
1391 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001392 memprintf(err, "'%s' : missing name", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001393 return ERR_ALERT | ERR_FATAL;
1394 }
1395
Willy Tarreau4348fad2012-09-20 16:48:07 +02001396 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001397 l->name = strdup(args[cur_arg + 1]);
1398
1399 return 0;
1400}
1401
1402/* parse the "nice" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001403static 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 +02001404{
1405 struct listener *l;
1406 int val;
1407
1408 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001409 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001410 return ERR_ALERT | ERR_FATAL;
1411 }
1412
1413 val = atol(args[cur_arg + 1]);
1414 if (val < -1024 || val > 1024) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001415 memprintf(err, "'%s' : invalid value %d, allowed range is -1024..1024", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001416 return ERR_ALERT | ERR_FATAL;
1417 }
1418
Willy Tarreau4348fad2012-09-20 16:48:07 +02001419 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001420 l->nice = val;
1421
1422 return 0;
1423}
1424
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001425/* parse the "process" bind keyword */
1426static int bind_parse_process(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1427{
Christopher Fauletc644fa92017-11-23 22:44:11 +01001428 char *slash;
1429 unsigned long proc = 0, thread = 0;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001430
Christopher Fauletc644fa92017-11-23 22:44:11 +01001431 if ((slash = strchr(args[cur_arg + 1], '/')) != NULL)
1432 *slash = 0;
1433
Willy Tarreauff9c9142019-02-07 10:39:36 +01001434 if (parse_process_number(args[cur_arg + 1], &proc, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +01001435 memprintf(err, "'%s' : %s", args[cur_arg], *err);
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001436 return ERR_ALERT | ERR_FATAL;
1437 }
1438
Christopher Fauletc644fa92017-11-23 22:44:11 +01001439 if (slash) {
Willy Tarreauc9a82e42019-01-26 13:25:14 +01001440 if (parse_process_number(slash+1, &thread, MAX_THREADS, NULL, err)) {
Christopher Fauletc644fa92017-11-23 22:44:11 +01001441 memprintf(err, "'%s' : %s", args[cur_arg], *err);
1442 return ERR_ALERT | ERR_FATAL;
1443 }
1444 *slash = '/';
1445 }
1446
Willy Tarreaue26993c2020-09-03 07:18:55 +02001447 conf->settings.bind_proc |= proc;
1448 conf->settings.bind_thread |= thread;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001449 return 0;
1450}
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001451
Christopher Fauleta717b992018-04-10 14:43:00 +02001452/* parse the "proto" bind keyword */
1453static int bind_parse_proto(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1454{
1455 struct ist proto;
1456
1457 if (!*args[cur_arg + 1]) {
1458 memprintf(err, "'%s' : missing value", args[cur_arg]);
1459 return ERR_ALERT | ERR_FATAL;
1460 }
1461
1462 proto = ist2(args[cur_arg + 1], strlen(args[cur_arg + 1]));
1463 conf->mux_proto = get_mux_proto(proto);
1464 if (!conf->mux_proto) {
1465 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[cur_arg], args[cur_arg+1]);
1466 return ERR_ALERT | ERR_FATAL;
1467 }
Christopher Fauleta717b992018-04-10 14:43:00 +02001468 return 0;
1469}
1470
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001471/* config parser for global "tune.listener.multi-queue", accepts "on" or "off" */
1472static int cfg_parse_tune_listener_mq(char **args, int section_type, struct proxy *curpx,
1473 struct proxy *defpx, const char *file, int line,
1474 char **err)
1475{
1476 if (too_many_args(1, args, err, NULL))
1477 return -1;
1478
1479 if (strcmp(args[1], "on") == 0)
1480 global.tune.options |= GTUNE_LISTENER_MQ;
1481 else if (strcmp(args[1], "off") == 0)
1482 global.tune.options &= ~GTUNE_LISTENER_MQ;
1483 else {
1484 memprintf(err, "'%s' expects either 'on' or 'off' but got '%s'.", args[0], args[1]);
1485 return -1;
1486 }
1487 return 0;
1488}
1489
Willy Tarreau61612d42012-04-19 18:42:05 +02001490/* Note: must not be declared <const> as its list will be overwritten.
1491 * Please take care of keeping this list alphabetically sorted.
1492 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001493static struct sample_fetch_kw_list smp_kws = {ILH, {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02001494 { "dst_conn", smp_fetch_dconn, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
1495 { "so_id", smp_fetch_so_id, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
Jerome Magnineb421b22020-03-27 22:08:40 +01001496 { "so_name", smp_fetch_so_name, 0, NULL, SMP_T_STR, SMP_USE_FTEND, },
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001497 { /* END */ },
1498}};
1499
Willy Tarreau0108d902018-11-25 19:14:37 +01001500INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
1501
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001502/* Note: must not be declared <const> as its list will be overwritten.
1503 * Please take care of keeping this list alphabetically sorted.
1504 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001505static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001506 { /* END */ },
Willy Tarreau645513a2010-05-24 20:55:15 +02001507}};
1508
Willy Tarreau0108d902018-11-25 19:14:37 +01001509INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
1510
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001511/* Note: must not be declared <const> as its list will be overwritten.
1512 * Please take care of keeping this list alphabetically sorted, doing so helps
1513 * all code contributors.
1514 * Optional keywords are also declared with a NULL ->parse() function so that
1515 * the config parser can report an appropriate error when a known keyword was
1516 * not enabled.
1517 */
Willy Tarreau51fb7652012-09-18 18:24:39 +02001518static struct bind_kw_list bind_kws = { "ALL", { }, {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001519 { "accept-netscaler-cip", bind_parse_accept_netscaler_cip, 1 }, /* enable NetScaler Client IP insertion protocol */
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001520 { "accept-proxy", bind_parse_accept_proxy, 0 }, /* enable PROXY protocol */
1521 { "backlog", bind_parse_backlog, 1 }, /* set backlog of listening socket */
1522 { "id", bind_parse_id, 1 }, /* set id of listening socket */
1523 { "maxconn", bind_parse_maxconn, 1 }, /* set maxconn of listening socket */
1524 { "name", bind_parse_name, 1 }, /* set name of listening socket */
1525 { "nice", bind_parse_nice, 1 }, /* set nice of listening socket */
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001526 { "process", bind_parse_process, 1 }, /* set list of allowed process for this socket */
Christopher Fauleta717b992018-04-10 14:43:00 +02001527 { "proto", bind_parse_proto, 1 }, /* set the proto to use for all incoming connections */
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001528 { /* END */ },
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001529}};
1530
Willy Tarreau0108d902018-11-25 19:14:37 +01001531INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
1532
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001533/* config keyword parsers */
1534static struct cfg_kw_list cfg_kws = {ILH, {
1535 { CFG_GLOBAL, "tune.listener.multi-queue", cfg_parse_tune_listener_mq },
1536 { 0, NULL, NULL }
1537}};
1538
1539INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
1540
Willy Tarreau645513a2010-05-24 20:55:15 +02001541/*
1542 * Local variables:
1543 * c-indent-level: 8
1544 * c-basic-offset: 8
1545 * End:
1546 */