blob: 87b2bd294d6e273015841d301dc1db8091ca06d4 [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 Tarreauefcf1382020-12-04 15:03:36 +0100326/* This function adds the specified <listener> to the protocol <proto>. It
327 * does nothing if the protocol was already added. The listener's state is
328 * automatically updated from LI_INIT to LI_ASSIGNED. The number of listeners
329 * for the protocol is updated. This must be called with the proto lock held.
330 */
331void default_add_listener(struct protocol *proto, struct listener *listener)
332{
333 if (listener->state != LI_INIT)
334 return;
335 listener_set_state(listener, LI_ASSIGNED);
336 listener->rx.proto = proto;
337 LIST_ADDQ(&proto->receivers, &listener->rx.proto_list);
338 proto->nb_receivers++;
339}
340
Willy Tarreaue03204c2020-10-09 17:02:21 +0200341/* default function called to suspend a listener: it simply passes the call to
342 * the underlying receiver. This is find for most socket-based protocols. This
343 * must be called under the listener's lock. It will return non-zero on success,
344 * 0 on failure. If no receiver-level suspend is provided, the operation is
345 * assumed to succeed.
346 */
347int default_suspend_listener(struct listener *l)
348{
349 int ret = 1;
350
351 if (!l->rx.proto->rx_suspend)
352 return 1;
353
354 ret = l->rx.proto->rx_suspend(&l->rx);
355 return ret > 0 ? ret : 0;
356}
357
358
359/* Tries to resume a suspended listener, and returns non-zero on success or
360 * zero on failure. On certain errors, an alert or a warning might be displayed.
361 * It must be called with the listener's lock held. Depending on the listener's
362 * state and protocol, a listen() call might be used to resume operations, or a
363 * call to the receiver's resume() function might be used as well. This is
364 * suitable as a default function for TCP and UDP. This must be called with the
365 * listener's lock held.
366 */
367int default_resume_listener(struct listener *l)
368{
369 int ret = 1;
370
371 if (l->state == LI_ASSIGNED) {
372 char msg[100];
373 int err;
374
375 err = l->rx.proto->listen(l, msg, sizeof(msg));
376 if (err & ERR_ALERT)
377 ha_alert("Resuming listener: %s\n", msg);
378 else if (err & ERR_WARN)
379 ha_warning("Resuming listener: %s\n", msg);
380
381 if (err & (ERR_FATAL | ERR_ABORT)) {
382 ret = 0;
383 goto end;
384 }
385 }
386
387 if (l->state < LI_PAUSED) {
388 ret = 0;
389 goto end;
390 }
391
392 if (l->state == LI_PAUSED && l->rx.proto->rx_resume &&
393 l->rx.proto->rx_resume(&l->rx) <= 0)
394 ret = 0;
395 end:
396 return ret;
397}
398
399
Willy Tarreaube58c382011-07-24 18:28:10 +0200400/* This function tries to temporarily disable a listener, depending on the OS
401 * capabilities. Linux unbinds the listen socket after a SHUT_RD, and ignores
402 * SHUT_WR. Solaris refuses either shutdown(). OpenBSD ignores SHUT_RD but
403 * closes upon SHUT_WR and refuses to rebind. So a common validation path
404 * involves SHUT_WR && listen && SHUT_RD. In case of success, the FD's polling
405 * is disabled. It normally returns non-zero, unless an error is reported.
406 */
407int pause_listener(struct listener *l)
408{
Willy Tarreau58651b42020-09-24 16:03:29 +0200409 struct proxy *px = l->bind_conf->frontend;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200410 int ret = 1;
411
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100412 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200413
Willy Tarreau02e19752020-09-23 17:17:22 +0200414 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
415 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
416 goto end;
417
Willy Tarreau9b3a9322020-09-24 14:46:34 +0200418 if (l->state <= LI_PAUSED)
419 goto end;
420
Willy Tarreaue03204c2020-10-09 17:02:21 +0200421 if (l->rx.proto->suspend)
422 ret = l->rx.proto->suspend(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200423
Olivier Houchard859dc802019-08-08 15:47:21 +0200424 MT_LIST_DEL(&l->wait_queue);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200425
Willy Tarreaua37b2442020-09-24 07:23:45 +0200426 listener_set_state(l, LI_PAUSED);
Willy Tarreau58651b42020-09-24 16:03:29 +0200427
428 if (px && !px->li_ready) {
429 ha_warning("Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
430 send_log(px, LOG_WARNING, "Paused %s %s.\n", proxy_cap_str(px->cap), px->id);
431 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200432 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100433 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200434 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200435}
436
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200437/* This function tries to resume a temporarily disabled listener. Paused, full,
438 * limited and disabled listeners are handled, which means that this function
439 * may replace enable_listener(). The resulting state will either be LI_READY
440 * or LI_FULL. 0 is returned in case of failure to resume (eg: dead socket).
Willy Tarreauae302532014-05-07 19:22:24 +0200441 * Listeners bound to a different process are not woken up unless we're in
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200442 * foreground mode, and are ignored. If the listener was only in the assigned
443 * state, it's totally rebound. This can happen if a pause() has completely
444 * stopped it. If the resume fails, 0 is returned and an error might be
445 * displayed.
Willy Tarreaube58c382011-07-24 18:28:10 +0200446 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100447int resume_listener(struct listener *l)
Willy Tarreaube58c382011-07-24 18:28:10 +0200448{
Willy Tarreau58651b42020-09-24 16:03:29 +0200449 struct proxy *px = l->bind_conf->frontend;
450 int was_paused = px && px->li_paused;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200451 int ret = 1;
452
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100453 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200454
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200455 /* check that another thread didn't to the job in parallel (e.g. at the
456 * end of listen_accept() while we'd come from dequeue_all_listeners().
457 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200458 if (MT_LIST_ADDED(&l->wait_queue))
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200459 goto end;
460
William Lallemand095ba4c2017-06-01 17:38:50 +0200461 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau818a92e2020-09-03 07:50:19 +0200462 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200463 goto end;
Willy Tarreau3569df32017-03-15 12:47:46 +0100464
Willy Tarreau5d7f9ce2020-09-24 18:54:11 +0200465 if (l->state == LI_READY)
466 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200467
Willy Tarreaue03204c2020-10-09 17:02:21 +0200468 if (l->rx.proto->resume)
469 ret = l->rx.proto->resume(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200470
Willy Tarreaua8cf66b2019-02-27 16:49:00 +0100471 if (l->maxconn && l->nbconn >= l->maxconn) {
Willy Tarreau4b51f422020-09-25 20:32:28 +0200472 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200473 listener_set_state(l, LI_FULL);
Willy Tarreau58651b42020-09-24 16:03:29 +0200474 goto done;
Willy Tarreaube58c382011-07-24 18:28:10 +0200475 }
476
Willy Tarreau4b51f422020-09-25 20:32:28 +0200477 l->rx.proto->enable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200478 listener_set_state(l, LI_READY);
Willy Tarreau58651b42020-09-24 16:03:29 +0200479
480 done:
481 if (was_paused && !px->li_paused) {
482 ha_warning("Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
483 send_log(px, LOG_WARNING, "Resumed %s %s.\n", proxy_cap_str(px->cap), px->id);
484 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200485 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100486 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200487 return ret;
488}
489
Willy Tarreau87b09662015-04-03 00:22:06 +0200490/* Marks a ready listener as full so that the stream code tries to re-enable
Willy Tarreau62793712011-07-24 19:23:38 +0200491 * it upon next close() using resume_listener().
492 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200493static void listener_full(struct listener *l)
Willy Tarreau62793712011-07-24 19:23:38 +0200494{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100495 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200496 if (l->state >= LI_READY) {
Olivier Houchard859dc802019-08-08 15:47:21 +0200497 MT_LIST_DEL(&l->wait_queue);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100498 if (l->state != LI_FULL) {
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_FULL);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100501 }
Willy Tarreau62793712011-07-24 19:23:38 +0200502 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100503 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200504}
505
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200506/* Marks a ready listener as limited so that we only try to re-enable it when
507 * resources are free again. It will be queued into the specified queue.
508 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200509static void limit_listener(struct listener *l, struct mt_list *list)
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200510{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100511 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200512 if (l->state == LI_READY) {
Willy Tarreaude4db172020-07-10 08:10:29 +0200513 MT_LIST_TRY_ADDQ(list, &l->wait_queue);
Willy Tarreau4b51f422020-09-25 20:32:28 +0200514 l->rx.proto->disable(l);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200515 listener_set_state(l, LI_LIMITED);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200516 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100517 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200518}
519
Willy Tarreau241797a2019-12-10 14:10:52 +0100520/* Dequeues all listeners waiting for a resource the global wait queue */
521void dequeue_all_listeners()
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200522{
Willy Tarreau01abd022019-02-28 10:27:18 +0100523 struct listener *listener;
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200524
Willy Tarreau241797a2019-12-10 14:10:52 +0100525 while ((listener = MT_LIST_POP(&global_listener_queue, struct listener *, wait_queue))) {
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200526 /* This cannot fail because the listeners are by definition in
Willy Tarreau01abd022019-02-28 10:27:18 +0100527 * the LI_LIMITED state.
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200528 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100529 resume_listener(listener);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200530 }
531}
532
Willy Tarreau241797a2019-12-10 14:10:52 +0100533/* Dequeues all listeners waiting for a resource in proxy <px>'s queue */
534void dequeue_proxy_listeners(struct proxy *px)
535{
536 struct listener *listener;
537
538 while ((listener = MT_LIST_POP(&px->listener_queue, struct listener *, wait_queue))) {
539 /* This cannot fail because the listeners are by definition in
540 * the LI_LIMITED state.
541 */
542 resume_listener(listener);
543 }
544}
545
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200546
547/* default function used to unbind a listener. This is for use by standard
548 * protocols working on top of accepted sockets. The receiver's rx_unbind()
549 * will automatically be used after the listener is disabled if the socket is
550 * still bound. This must be used under the listener's lock.
Christopher Faulet510c0d62018-03-16 10:04:47 +0100551 */
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200552void default_unbind_listener(struct listener *listener)
Willy Tarreaub648d632007-10-28 22:13:50 +0100553{
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200554 if (listener->state <= LI_ASSIGNED)
555 goto out_close;
556
557 if (listener->rx.fd == -1) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200558 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200559 goto out_close;
560 }
561
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200562 if (listener->state >= LI_READY) {
563 listener->rx.proto->disable(listener);
564 if (listener->rx.flags & RX_F_BOUND)
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200565 listener_set_state(listener, LI_LISTEN);
Willy Tarreaub6607bf2020-09-23 16:24:23 +0200566 }
567
Willy Tarreau87acd4e2020-10-08 15:36:46 +0200568 out_close:
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200569 if (listener->rx.flags & RX_F_BOUND)
570 listener->rx.proto->rx_unbind(&listener->rx);
Willy Tarreau7b2febd2020-10-09 17:18:29 +0200571}
572
573/* This function closes the listening socket for the specified listener,
574 * provided that it's already in a listening state. The protocol's unbind()
575 * is called to put the listener into LI_ASSIGNED or LI_LISTEN and handle
576 * the unbinding tasks. The listener enters then the LI_ASSIGNED state if
577 * the receiver is unbound. Must be called with the lock held.
578 */
579void do_unbind_listener(struct listener *listener)
580{
581 MT_LIST_DEL(&listener->wait_queue);
582
583 if (listener->rx.proto->unbind)
584 listener->rx.proto->unbind(listener);
Willy Tarreau374e9af2020-10-09 15:47:17 +0200585
Willy Tarreauf58b8db2020-10-09 16:32:08 +0200586 /* we may have to downgrade the listener if the rx was closed */
587 if (!(listener->rx.flags & RX_F_BOUND) && listener->state > LI_ASSIGNED)
Willy Tarreau374e9af2020-10-09 15:47:17 +0200588 listener_set_state(listener, LI_ASSIGNED);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100589}
590
Olivier Houchard1fc05162017-04-06 01:05:05 +0200591/* This function closes the listening socket for the specified listener,
592 * provided that it's already in a listening state. The listener enters the
Willy Tarreau75c98d12020-10-09 15:55:23 +0200593 * LI_ASSIGNED state, except if the FD is not closed, in which case it may
594 * remain in LI_LISTEN. This function is intended to be used as a generic
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100595 * function for standard protocols.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200596 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100597void unbind_listener(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200598{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100599 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau75c98d12020-10-09 15:55:23 +0200600 do_unbind_listener(listener);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100601 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200602}
603
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200604/* creates one or multiple listeners for bind_conf <bc> on sockaddr <ss> on port
605 * range <portl> to <porth>, and possibly attached to fd <fd> (or -1 for auto
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200606 * allocation). The address family is taken from ss->ss_family, and the protocol
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200607 * passed in <proto> must be usable on this family. The protocol's default iocb
608 * is automatically preset as the receivers' iocb. The number of jobs and
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200609 * listeners is automatically increased by the number of listeners created. It
610 * returns non-zero on success, zero on error with the error message set in <err>.
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200611 */
612int create_listeners(struct bind_conf *bc, const struct sockaddr_storage *ss,
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200613 int portl, int porth, int fd, struct protocol *proto, char **err)
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200614{
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200615 struct listener *l;
616 int port;
617
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200618 for (port = portl; port <= porth; port++) {
619 l = calloc(1, sizeof(*l));
620 if (!l) {
621 memprintf(err, "out of memory");
622 return 0;
623 }
624 l->obj_type = OBJ_TYPE_LISTENER;
625 LIST_ADDQ(&bc->frontend->conf.listeners, &l->by_fe);
626 LIST_ADDQ(&bc->listeners, &l->by_bind);
627 l->bind_conf = bc;
Willy Tarreau0fce6bc2020-09-03 07:46:06 +0200628 l->rx.settings = &bc->settings;
Willy Tarreaueef45422020-09-03 10:05:03 +0200629 l->rx.owner = l;
Willy Tarreaud2fb99f2020-10-15 21:22:29 +0200630 l->rx.iocb = proto->default_iocb;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200631 l->rx.fd = fd;
Willy Tarreaud7c746e2020-12-04 14:49:11 +0100632
Willy Tarreau37159062020-08-27 07:48:42 +0200633 memcpy(&l->rx.addr, ss, sizeof(*ss));
Willy Tarreauefcf1382020-12-04 15:03:36 +0100634 if (proto->fam->set_port)
635 proto->fam->set_port(&l->rx.addr, port);
Willy Tarreaud7c746e2020-12-04 14:49:11 +0100636
Olivier Houchard859dc802019-08-08 15:47:21 +0200637 MT_LIST_INIT(&l->wait_queue);
Willy Tarreaua37b2442020-09-24 07:23:45 +0200638 listener_set_state(l, LI_INIT);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200639
Willy Tarreauefcf1382020-12-04 15:03:36 +0100640 proto->add(proto, l);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200641
Willy Tarreau909c23b2020-09-15 13:50:58 +0200642 if (fd != -1)
Willy Tarreau43046fa2020-09-01 15:41:59 +0200643 l->rx.flags |= RX_F_INHERITED;
William Lallemand75ea0a02017-11-15 19:02:58 +0100644
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100645 HA_SPIN_INIT(&l->lock);
Olivier Houchard64213e92019-03-08 18:52:57 +0100646 _HA_ATOMIC_ADD(&jobs, 1);
647 _HA_ATOMIC_ADD(&listeners, 1);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200648 }
649 return 1;
650}
651
Willy Tarreau1a64d162007-10-28 22:26:05 +0100652/* Delete a listener from its protocol's list of listeners. The listener's
653 * state is automatically updated from LI_ASSIGNED to LI_INIT. The protocol's
Willy Tarreau2cc5bae2017-09-15 08:18:11 +0200654 * number of listeners is updated, as well as the global number of listeners
655 * and jobs. Note that the listener must have previously been unbound. This
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200656 * is a low-level function expected to be called with the proto_lock and the
657 * listener's lock held.
Willy Tarreau1a64d162007-10-28 22:26:05 +0100658 */
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200659void __delete_listener(struct listener *listener)
Willy Tarreau1a64d162007-10-28 22:26:05 +0100660{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100661 if (listener->state == LI_ASSIGNED) {
Willy Tarreaua37b2442020-09-24 07:23:45 +0200662 listener_set_state(listener, LI_INIT);
Willy Tarreaub7436612020-08-28 19:51:44 +0200663 LIST_DEL(&listener->rx.proto_list);
Willy Tarreaud7f331c2020-09-25 17:01:43 +0200664 listener->rx.proto->nb_receivers--;
Olivier Houchard64213e92019-03-08 18:52:57 +0100665 _HA_ATOMIC_SUB(&jobs, 1);
666 _HA_ATOMIC_SUB(&listeners, 1);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100667 }
Willy Tarreaub4c083f2020-10-07 15:36:16 +0200668}
669
670/* Delete a listener from its protocol's list of listeners (please check
671 * __delete_listener() above). The proto_lock and the listener's lock will
672 * be grabbed in this order.
673 */
674void delete_listener(struct listener *listener)
675{
676 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
677 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
678 __delete_listener(listener);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100679 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau6ee9f8d2019-08-26 10:55:52 +0200680 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100681}
682
Willy Tarreaue2711c72019-02-27 15:39:41 +0100683/* Returns a suitable value for a listener's backlog. It uses the listener's,
684 * otherwise the frontend's backlog, otherwise the listener's maxconn,
685 * otherwise the frontend's maxconn, otherwise 1024.
686 */
687int listener_backlog(const struct listener *l)
688{
689 if (l->backlog)
690 return l->backlog;
691
692 if (l->bind_conf->frontend->backlog)
693 return l->bind_conf->frontend->backlog;
694
695 if (l->maxconn)
696 return l->maxconn;
697
698 if (l->bind_conf->frontend->maxconn)
699 return l->bind_conf->frontend->maxconn;
700
701 return 1024;
702}
703
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200704/* This function is called on a read event from a listening socket, corresponding
705 * to an accept. It tries to accept as many connections as possible, and for each
706 * calls the listener's accept handler (generally the frontend's accept handler).
707 */
Willy Tarreaua74cb382020-10-15 21:29:49 +0200708void listener_accept(struct listener *l)
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200709{
Willy Tarreau83efc322020-10-14 17:37:17 +0200710 struct connection *cli_conn;
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100711 struct proxy *p;
Christopher Faulet102854c2019-04-30 12:17:13 +0200712 unsigned int max_accept;
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100713 int next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100714 int next_feconn = 0;
715 int next_actconn = 0;
Willy Tarreaubb660302014-05-07 19:47:02 +0200716 int expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200717 int ret;
718
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100719 p = l->bind_conf->frontend;
Christopher Faulet102854c2019-04-30 12:17:13 +0200720
721 /* if l->maxaccept is -1, then max_accept is UINT_MAX. It is not really
722 * illimited, but it is probably enough.
723 */
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100724 max_accept = l->maxaccept ? l->maxaccept : 1;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200725
Willy Tarreau93e7c002013-10-07 18:51:07 +0200726 if (!(l->options & LI_O_UNLIMITED) && global.sps_lim) {
727 int max = freq_ctr_remain(&global.sess_per_sec, global.sps_lim, 0);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200728
729 if (unlikely(!max)) {
730 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200731 expire = tick_add(now_ms, next_event_delay(&global.sess_per_sec, global.sps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100732 goto limit_global;
Willy Tarreau93e7c002013-10-07 18:51:07 +0200733 }
734
735 if (max_accept > max)
736 max_accept = max;
737 }
738
739 if (!(l->options & LI_O_UNLIMITED) && global.cps_lim) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200740 int max = freq_ctr_remain(&global.conn_per_sec, global.cps_lim, 0);
741
742 if (unlikely(!max)) {
743 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200744 expire = tick_add(now_ms, next_event_delay(&global.conn_per_sec, global.cps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100745 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200746 }
747
748 if (max_accept > max)
749 max_accept = max;
750 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200751#ifdef USE_OPENSSL
752 if (!(l->options & LI_O_UNLIMITED) && global.ssl_lim && l->bind_conf && l->bind_conf->is_ssl) {
753 int max = freq_ctr_remain(&global.ssl_per_sec, global.ssl_lim, 0);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200754
Willy Tarreaue43d5322013-10-07 20:01:52 +0200755 if (unlikely(!max)) {
756 /* frontend accept rate limit was reached */
Willy Tarreaue43d5322013-10-07 20:01:52 +0200757 expire = tick_add(now_ms, next_event_delay(&global.ssl_per_sec, global.ssl_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100758 goto limit_global;
Willy Tarreaue43d5322013-10-07 20:01:52 +0200759 }
760
761 if (max_accept > max)
762 max_accept = max;
763 }
764#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200765 if (p && p->fe_sps_lim) {
766 int max = freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0);
767
768 if (unlikely(!max)) {
769 /* frontend accept rate limit was reached */
Willy Tarreau0591bf72019-12-10 12:01:21 +0100770 expire = tick_add(now_ms, next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0));
771 goto limit_proxy;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200772 }
773
774 if (max_accept > max)
775 max_accept = max;
776 }
777
778 /* Note: if we fail to allocate a connection because of configured
779 * limits, we'll schedule a new attempt worst 1 second later in the
780 * worst case. If we fail due to system limits or temporary resource
781 * shortage, we try again 100ms later in the worst case.
782 */
Christopher Faulet102854c2019-04-30 12:17:13 +0200783 for (; max_accept; next_conn = next_feconn = next_actconn = 0, max_accept--) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200784 unsigned int count;
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200785 int status;
Willy Tarreau0aa5a5b2020-10-16 17:43:04 +0200786 __decl_thread(unsigned long mask);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200787
Willy Tarreau82c97892019-02-27 19:32:32 +0100788 /* pre-increase the number of connections without going too far.
789 * We process the listener, then the proxy, then the process.
790 * We know which ones to unroll based on the next_xxx value.
791 */
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100792 do {
793 count = l->nbconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100794 if (unlikely(l->maxconn && count >= l->maxconn)) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100795 /* the listener was marked full or another
796 * thread is going to do it.
797 */
798 next_conn = 0;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100799 listener_full(l);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100800 goto end;
801 }
802 next_conn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000803 } while (!_HA_ATOMIC_CAS(&l->nbconn, (int *)(&count), next_conn));
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100804
Willy Tarreau82c97892019-02-27 19:32:32 +0100805 if (p) {
806 do {
807 count = p->feconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100808 if (unlikely(count >= p->maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100809 /* the frontend was marked full or another
810 * thread is going to do it.
811 */
812 next_feconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100813 expire = TICK_ETERNITY;
814 goto limit_proxy;
Willy Tarreau82c97892019-02-27 19:32:32 +0100815 }
816 next_feconn = count + 1;
Olivier Houchard64213e92019-03-08 18:52:57 +0100817 } while (!_HA_ATOMIC_CAS(&p->feconn, &count, next_feconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200818 }
819
Willy Tarreau82c97892019-02-27 19:32:32 +0100820 if (!(l->options & LI_O_UNLIMITED)) {
821 do {
822 count = actconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100823 if (unlikely(count >= global.maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100824 /* the process was marked full or another
825 * thread is going to do it.
826 */
827 next_actconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100828 expire = tick_add(now_ms, 1000); /* try again in 1 second */
829 goto limit_global;
Willy Tarreau82c97892019-02-27 19:32:32 +0100830 }
831 next_actconn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000832 } while (!_HA_ATOMIC_CAS(&actconn, (int *)(&count), next_actconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200833 }
834
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200835 cli_conn = l->rx.proto->accept_conn(l, &status);
836 if (!cli_conn) {
837 switch (status) {
838 case CO_AC_DONE:
839 goto end;
Willy Tarreau818dca52014-01-31 19:40:19 +0100840
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200841 case CO_AC_RETRY: /* likely a signal */
Olivier Houchard64213e92019-03-08 18:52:57 +0100842 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100843 if (p)
Olivier Houchard64213e92019-03-08 18:52:57 +0100844 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100845 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +0100846 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreaua593ec52014-01-20 21:21:30 +0100847 continue;
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200848
849 case CO_AC_YIELD:
Willy Tarreau92079932019-12-10 09:30:05 +0100850 max_accept = 0;
851 goto end;
William Lallemandd9138002018-11-27 12:02:39 +0100852
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200853 default:
854 goto transient_error;
Willy Tarreau83efc322020-10-14 17:37:17 +0200855 }
856 }
857
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100858 /* The connection was accepted, it must be counted as such */
859 if (l->counters)
860 HA_ATOMIC_UPDATE_MAX(&l->counters->conn_max, next_conn);
861
Willy Tarreau82c97892019-02-27 19:32:32 +0100862 if (p)
863 HA_ATOMIC_UPDATE_MAX(&p->fe_counters.conn_max, next_feconn);
864
865 proxy_inc_fe_conn_ctr(l, p);
866
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100867 if (!(l->options & LI_O_UNLIMITED)) {
868 count = update_freq_ctr(&global.conn_per_sec, 1);
869 HA_ATOMIC_UPDATE_MAX(&global.cps_max, count);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100870 }
871
Willy Tarreau64a9c052019-04-12 15:27:17 +0200872 _HA_ATOMIC_ADD(&activity[tid].accepted, 1);
873
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200874 if (unlikely(cli_conn->handle.fd >= global.maxsock)) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200875 send_log(p, LOG_EMERG,
876 "Proxy %s reached the configured maximum connection limit. Please check the global 'maxconn' value.\n",
877 p->id);
Willy Tarreau9378bbe2020-10-15 10:09:31 +0200878 close(cli_conn->handle.fd);
William Dauchy835712a2020-10-18 18:37:43 +0200879 conn_free(cli_conn);
Willy Tarreau0591bf72019-12-10 12:01:21 +0100880 expire = tick_add(now_ms, 1000); /* try again in 1 second */
881 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200882 }
883
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100884 /* past this point, l->accept() will automatically decrement
Willy Tarreau82c97892019-02-27 19:32:32 +0100885 * l->nbconn, feconn and actconn once done. Setting next_*conn=0
886 * allows the error path not to rollback on nbconn. It's more
887 * convenient than duplicating all exit labels.
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100888 */
889 next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100890 next_feconn = 0;
891 next_actconn = 0;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200892
Willy Tarreau83efc322020-10-14 17:37:17 +0200893
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100894#if defined(USE_THREAD)
Willy Tarreau818a92e2020-09-03 07:50:19 +0200895 mask = thread_mask(l->rx.settings->bind_thread) & all_threads_mask;
Willy Tarreaua7da5e82020-03-12 17:33:29 +0100896 if (atleast2(mask) && (global.tune.options & GTUNE_LISTENER_MQ) && !stopping) {
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100897 struct accept_queue_ring *ring;
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100898 unsigned int t, t0, t1, t2;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100899
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100900 /* The principle is that we have two running indexes,
901 * each visiting in turn all threads bound to this
902 * listener. The connection will be assigned to the one
903 * with the least connections, and the other one will
904 * be updated. This provides a good fairness on short
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100905 * connections (round robin) and on long ones (conn
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100906 * count), without ever missing any idle thread.
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100907 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100908
909 /* keep a copy for the final update. thr_idx is composite
910 * and made of (t2<<16) + t1.
911 */
Willy Tarreau0cf33172019-03-06 15:26:33 +0100912 t0 = l->thr_idx;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100913 do {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100914 unsigned long m1, m2;
915 int q1, q2;
916
917 t2 = t1 = t0;
918 t2 >>= 16;
919 t1 &= 0xFFFF;
920
921 /* t1 walks low to high bits ;
922 * t2 walks high to low.
923 */
924 m1 = mask >> t1;
925 m2 = mask & (t2 ? nbits(t2 + 1) : ~0UL);
926
Willy Tarreau85d04242019-04-16 18:09:13 +0200927 if (unlikely(!(m1 & 1))) {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100928 m1 &= ~1UL;
929 if (!m1) {
930 m1 = mask;
931 t1 = 0;
932 }
933 t1 += my_ffsl(m1) - 1;
934 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100935
Willy Tarreau85d04242019-04-16 18:09:13 +0200936 if (unlikely(!(m2 & (1UL << t2)) || t1 == t2)) {
937 /* highest bit not set */
938 if (!m2)
939 m2 = mask;
940
941 t2 = my_flsl(m2) - 1;
942 }
943
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100944 /* now we have two distinct thread IDs belonging to the mask */
945 q1 = accept_queue_rings[t1].tail - accept_queue_rings[t1].head + ACCEPT_QUEUE_SIZE;
946 if (q1 >= ACCEPT_QUEUE_SIZE)
947 q1 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100948
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100949 q2 = accept_queue_rings[t2].tail - accept_queue_rings[t2].head + ACCEPT_QUEUE_SIZE;
950 if (q2 >= ACCEPT_QUEUE_SIZE)
951 q2 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100952
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100953 /* we have 3 possibilities now :
954 * q1 < q2 : t1 is less loaded than t2, so we pick it
955 * and update t2 (since t1 might still be
956 * lower than another thread)
957 * q1 > q2 : t2 is less loaded than t1, so we pick it
958 * and update t1 (since t2 might still be
959 * lower than another thread)
960 * q1 = q2 : both are equally loaded, thus we pick t1
961 * and update t1 as it will become more loaded
962 * than t2.
963 */
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100964
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100965 q1 += l->thr_conn[t1];
966 q2 += l->thr_conn[t2];
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100967
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100968 if (q1 - q2 < 0) {
969 t = t1;
970 t2 = t2 ? t2 - 1 : LONGBITS - 1;
971 }
972 else if (q1 - q2 > 0) {
973 t = t2;
974 t1++;
975 if (t1 >= LONGBITS)
976 t1 = 0;
977 }
978 else {
979 t = t1;
980 t1++;
981 if (t1 >= LONGBITS)
982 t1 = 0;
983 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100984
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100985 /* new value for thr_idx */
986 t1 += (t2 << 16);
Olivier Houchard64213e92019-03-08 18:52:57 +0100987 } while (unlikely(!_HA_ATOMIC_CAS(&l->thr_idx, &t0, t1)));
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100988
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100989 /* We successfully selected the best thread "t" for this
990 * connection. We use deferred accepts even if it's the
991 * local thread because tests show that it's the best
992 * performing model, likely due to better cache locality
993 * when processing this loop.
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100994 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100995 ring = &accept_queue_rings[t];
Willy Tarreau83efc322020-10-14 17:37:17 +0200996 if (accept_queue_push_mp(ring, cli_conn)) {
Olivier Houchard64213e92019-03-08 18:52:57 +0100997 _HA_ATOMIC_ADD(&activity[t].accq_pushed, 1);
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200998 tasklet_wakeup(ring->tasklet);
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100999 continue;
1000 }
1001 /* If the ring is full we do a synchronous accept on
1002 * the local thread here.
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001003 */
Olivier Houchard64213e92019-03-08 18:52:57 +01001004 _HA_ATOMIC_ADD(&activity[t].accq_full, 1);
Willy Tarreaue0e9c482019-01-27 15:37:19 +01001005 }
1006#endif // USE_THREAD
1007
Olivier Houchard64213e92019-03-08 18:52:57 +01001008 _HA_ATOMIC_ADD(&l->thr_conn[tid], 1);
Willy Tarreau83efc322020-10-14 17:37:17 +02001009 ret = l->accept(cli_conn);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001010 if (unlikely(ret <= 0)) {
Willy Tarreau87b09662015-04-03 00:22:06 +02001011 /* The connection was closed by stream_accept(). Either
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001012 * we just have to ignore it (ret == 0) or it's a critical
1013 * error due to a resource shortage, and we must stop the
1014 * listener (ret < 0).
1015 */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001016 if (ret == 0) /* successful termination */
1017 continue;
1018
Willy Tarreaubb660302014-05-07 19:47:02 +02001019 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001020 }
1021
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001022 /* increase the per-process number of cumulated sessions, this
1023 * may only be done once l->accept() has accepted the connection.
1024 */
Willy Tarreau93e7c002013-10-07 18:51:07 +02001025 if (!(l->options & LI_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001026 count = update_freq_ctr(&global.sess_per_sec, 1);
1027 HA_ATOMIC_UPDATE_MAX(&global.sps_max, count);
Willy Tarreau93e7c002013-10-07 18:51:07 +02001028 }
Willy Tarreaue43d5322013-10-07 20:01:52 +02001029#ifdef USE_OPENSSL
1030 if (!(l->options & LI_O_UNLIMITED) && l->bind_conf && l->bind_conf->is_ssl) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001031 count = update_freq_ctr(&global.ssl_per_sec, 1);
1032 HA_ATOMIC_UPDATE_MAX(&global.ssl_max, count);
Willy Tarreaue43d5322013-10-07 20:01:52 +02001033 }
1034#endif
Willy Tarreau93e7c002013-10-07 18:51:07 +02001035
Willy Tarreau8d2c98b2020-05-01 09:51:11 +02001036 ti->flags &= ~TI_FL_STUCK; // this thread is still running
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001037 } /* end of for (max_accept--) */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001038
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001039 end:
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001040 if (next_conn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001041 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau741b4d62019-02-25 15:02:04 +01001042
Willy Tarreau82c97892019-02-27 19:32:32 +01001043 if (p && next_feconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001044 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001045
1046 if (next_actconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001047 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001048
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001049 if ((l->state == LI_FULL && (!l->maxconn || l->nbconn < l->maxconn)) ||
Willy Tarreaucdcba112019-12-11 15:06:30 +01001050 (l->state == LI_LIMITED &&
1051 ((!p || p->feconn < p->maxconn) && (actconn < global.maxconn) &&
1052 (!tick_isset(global_listener_queue_task->expire) ||
1053 tick_is_expired(global_listener_queue_task->expire, now_ms))))) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001054 /* at least one thread has to this when quitting */
1055 resume_listener(l);
1056
1057 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001058 dequeue_all_listeners();
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001059
Olivier Houchard859dc802019-08-08 15:47:21 +02001060 if (p && !MT_LIST_ISEMPTY(&p->listener_queue) &&
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001061 (!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 +01001062 dequeue_proxy_listeners(p);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001063 }
Willy Tarreau0591bf72019-12-10 12:01:21 +01001064 return;
1065
1066 transient_error:
1067 /* pause the listener for up to 100 ms */
1068 expire = tick_add(now_ms, 100);
1069
Willy Tarreau258b3512020-10-13 17:46:05 +02001070 /* This may be a shared socket that was paused by another process.
1071 * Let's put it to pause in this case.
1072 */
1073 if (l->rx.proto && l->rx.proto->rx_listening(&l->rx) == 0) {
1074 pause_listener(l);
1075 goto end;
1076 }
1077
Willy Tarreau0591bf72019-12-10 12:01:21 +01001078 limit_global:
1079 /* (re-)queue the listener to the global queue and set it to expire no
1080 * later than <expire> ahead. The listener turns to LI_LIMITED.
1081 */
1082 limit_listener(l, &global_listener_queue);
1083 task_schedule(global_listener_queue_task, expire);
1084 goto end;
1085
1086 limit_proxy:
1087 /* (re-)queue the listener to the proxy's queue and set it to expire no
1088 * later than <expire> ahead. The listener turns to LI_LIMITED.
1089 */
1090 limit_listener(l, &p->listener_queue);
Willy Tarreaueeea8082020-01-08 19:15:07 +01001091 if (p->task && tick_isset(expire))
1092 task_schedule(p->task, expire);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001093 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001094}
1095
Willy Tarreau05f50472017-09-15 09:19:58 +02001096/* Notify the listener that a connection initiated from it was released. This
1097 * is used to keep the connection count consistent and to possibly re-open
1098 * listening when it was limited.
1099 */
1100void listener_release(struct listener *l)
1101{
1102 struct proxy *fe = l->bind_conf->frontend;
1103
1104 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +01001105 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001106 if (fe)
Olivier Houchard64213e92019-03-08 18:52:57 +01001107 _HA_ATOMIC_SUB(&fe->feconn, 1);
1108 _HA_ATOMIC_SUB(&l->nbconn, 1);
1109 _HA_ATOMIC_SUB(&l->thr_conn[tid], 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001110
1111 if (l->state == LI_FULL || l->state == LI_LIMITED)
Willy Tarreau05f50472017-09-15 09:19:58 +02001112 resume_listener(l);
1113
1114 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001115 dequeue_all_listeners();
Willy Tarreau05f50472017-09-15 09:19:58 +02001116
Olivier Houchard859dc802019-08-08 15:47:21 +02001117 if (!MT_LIST_ISEMPTY(&fe->listener_queue) &&
Willy Tarreau05f50472017-09-15 09:19:58 +02001118 (!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 +01001119 dequeue_proxy_listeners(fe);
Willy Tarreau05f50472017-09-15 09:19:58 +02001120}
1121
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001122/* Initializes the listener queues. Returns 0 on success, otherwise ERR_* flags */
1123static int listener_queue_init()
1124{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001125 global_listener_queue_task = task_new(MAX_THREADS_MASK);
1126 if (!global_listener_queue_task) {
1127 ha_alert("Out of memory when initializing global listener queue\n");
1128 return ERR_FATAL|ERR_ABORT;
1129 }
1130 /* very simple initialization, users will queue the task if needed */
1131 global_listener_queue_task->context = NULL; /* not even a context! */
1132 global_listener_queue_task->process = manage_global_listener_queue;
1133
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001134 return 0;
1135}
1136
1137static void listener_queue_deinit()
1138{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001139 task_destroy(global_listener_queue_task);
1140 global_listener_queue_task = NULL;
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001141}
1142
1143REGISTER_CONFIG_POSTPARSER("multi-threaded listener queue", listener_queue_init);
1144REGISTER_POST_DEINIT(listener_queue_deinit);
1145
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001146
1147/* This is the global management task for listeners. It enables listeners waiting
1148 * for global resources when there are enough free resource, or at least once in
1149 * a while. It is designed to be called as a task.
1150 */
1151static struct task *manage_global_listener_queue(struct task *t, void *context, unsigned short state)
1152{
1153 /* If there are still too many concurrent connections, let's wait for
1154 * some of them to go away. We don't need to re-arm the timer because
1155 * each of them will scan the queue anyway.
1156 */
1157 if (unlikely(actconn >= global.maxconn))
1158 goto out;
1159
1160 /* We should periodically try to enable listeners waiting for a global
1161 * resource here, because it is possible, though very unlikely, that
1162 * they have been blocked by a temporary lack of global resource such
1163 * as a file descriptor or memory and that the temporary condition has
1164 * disappeared.
1165 */
1166 dequeue_all_listeners();
1167
1168 out:
1169 t->expire = TICK_ETERNITY;
1170 task_queue(t);
1171 return t;
1172}
1173
Willy Tarreau26982662012-09-12 23:17:10 +02001174/*
1175 * Registers the bind keyword list <kwl> as a list of valid keywords for next
1176 * parsing sessions.
1177 */
1178void bind_register_keywords(struct bind_kw_list *kwl)
1179{
1180 LIST_ADDQ(&bind_keywords.list, &kwl->list);
1181}
1182
1183/* Return a pointer to the bind keyword <kw>, or NULL if not found. If the
1184 * keyword is found with a NULL ->parse() function, then an attempt is made to
1185 * find one with a valid ->parse() function. This way it is possible to declare
1186 * platform-dependant, known keywords as NULL, then only declare them as valid
1187 * if some options are met. Note that if the requested keyword contains an
1188 * opening parenthesis, everything from this point is ignored.
1189 */
1190struct bind_kw *bind_find_kw(const char *kw)
1191{
1192 int index;
1193 const char *kwend;
1194 struct bind_kw_list *kwl;
1195 struct bind_kw *ret = NULL;
1196
1197 kwend = strchr(kw, '(');
1198 if (!kwend)
1199 kwend = kw + strlen(kw);
1200
1201 list_for_each_entry(kwl, &bind_keywords.list, list) {
1202 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1203 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
1204 kwl->kw[index].kw[kwend-kw] == 0) {
1205 if (kwl->kw[index].parse)
1206 return &kwl->kw[index]; /* found it !*/
1207 else
1208 ret = &kwl->kw[index]; /* may be OK */
1209 }
1210 }
1211 }
1212 return ret;
1213}
1214
Willy Tarreau8638f482012-09-18 18:01:17 +02001215/* Dumps all registered "bind" keywords to the <out> string pointer. The
1216 * unsupported keywords are only dumped if their supported form was not
1217 * found.
1218 */
1219void bind_dump_kws(char **out)
1220{
1221 struct bind_kw_list *kwl;
1222 int index;
1223
Christopher Faulet784063e2020-05-18 12:14:18 +02001224 if (!out)
1225 return;
1226
Willy Tarreau8638f482012-09-18 18:01:17 +02001227 *out = NULL;
1228 list_for_each_entry(kwl, &bind_keywords.list, list) {
1229 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1230 if (kwl->kw[index].parse ||
1231 bind_find_kw(kwl->kw[index].kw) == &kwl->kw[index]) {
Willy Tarreau51fb7652012-09-18 18:24:39 +02001232 memprintf(out, "%s[%4s] %s%s%s\n", *out ? *out : "",
1233 kwl->scope,
Willy Tarreau8638f482012-09-18 18:01:17 +02001234 kwl->kw[index].kw,
Willy Tarreau51fb7652012-09-18 18:24:39 +02001235 kwl->kw[index].skip ? " <arg>" : "",
1236 kwl->kw[index].parse ? "" : " (not supported)");
Willy Tarreau8638f482012-09-18 18:01:17 +02001237 }
1238 }
1239 }
1240}
1241
Willy Tarreau645513a2010-05-24 20:55:15 +02001242/************************************************************************/
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001243/* All supported sample and ACL keywords must be declared here. */
Willy Tarreau645513a2010-05-24 20:55:15 +02001244/************************************************************************/
1245
Willy Tarreaua5e37562011-12-16 17:06:15 +01001246/* set temp integer to the number of connexions to the same listening socket */
Willy Tarreau645513a2010-05-24 20:55:15 +02001247static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001248smp_fetch_dconn(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau645513a2010-05-24 20:55:15 +02001249{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001250 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001251 smp->data.u.sint = smp->sess->listener->nbconn;
Willy Tarreau645513a2010-05-24 20:55:15 +02001252 return 1;
1253}
1254
Willy Tarreaua5e37562011-12-16 17:06:15 +01001255/* set temp integer to the id of the socket (listener) */
Willy Tarreau645513a2010-05-24 20:55:15 +02001256static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001257smp_fetch_so_id(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau37406352012-04-23 16:16:37 +02001258{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001259 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001260 smp->data.u.sint = smp->sess->listener->luid;
Willy Tarreau645513a2010-05-24 20:55:15 +02001261 return 1;
1262}
Jerome Magnineb421b22020-03-27 22:08:40 +01001263static int
1264smp_fetch_so_name(const struct arg *args, struct sample *smp, const char *kw, void *private)
1265{
1266 smp->data.u.str.area = smp->sess->listener->name;
1267 if (!smp->data.u.str.area)
1268 return 0;
1269
1270 smp->data.type = SMP_T_STR;
1271 smp->flags = SMP_F_CONST;
1272 smp->data.u.str.data = strlen(smp->data.u.str.area);
1273 return 1;
1274}
Willy Tarreau645513a2010-05-24 20:55:15 +02001275
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001276/* parse the "accept-proxy" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001277static 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 +02001278{
1279 struct listener *l;
1280
Willy Tarreau4348fad2012-09-20 16:48:07 +02001281 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001282 l->options |= LI_O_ACC_PROXY;
1283
1284 return 0;
1285}
1286
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001287/* parse the "accept-netscaler-cip" bind keyword */
1288static int bind_parse_accept_netscaler_cip(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1289{
1290 struct listener *l;
1291 uint32_t val;
1292
1293 if (!*args[cur_arg + 1]) {
1294 memprintf(err, "'%s' : missing value", args[cur_arg]);
1295 return ERR_ALERT | ERR_FATAL;
1296 }
1297
1298 val = atol(args[cur_arg + 1]);
1299 if (val <= 0) {
Willy Tarreaue2711c72019-02-27 15:39:41 +01001300 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001301 return ERR_ALERT | ERR_FATAL;
1302 }
1303
1304 list_for_each_entry(l, &conf->listeners, by_bind) {
1305 l->options |= LI_O_ACC_CIP;
1306 conf->ns_cip_magic = val;
1307 }
1308
1309 return 0;
1310}
1311
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001312/* parse the "backlog" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001313static 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 +02001314{
1315 struct listener *l;
1316 int val;
1317
1318 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001319 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001320 return ERR_ALERT | ERR_FATAL;
1321 }
1322
1323 val = atol(args[cur_arg + 1]);
Willy Tarreaue2711c72019-02-27 15:39:41 +01001324 if (val < 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001325 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001326 return ERR_ALERT | ERR_FATAL;
1327 }
1328
Willy Tarreau4348fad2012-09-20 16:48:07 +02001329 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001330 l->backlog = val;
1331
1332 return 0;
1333}
1334
1335/* parse the "id" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001336static 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 +02001337{
1338 struct eb32_node *node;
Willy Tarreau4348fad2012-09-20 16:48:07 +02001339 struct listener *l, *new;
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001340 char *error;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001341
Willy Tarreau4348fad2012-09-20 16:48:07 +02001342 if (conf->listeners.n != conf->listeners.p) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001343 memprintf(err, "'%s' can only be used with a single socket", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001344 return ERR_ALERT | ERR_FATAL;
1345 }
1346
1347 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001348 memprintf(err, "'%s' : expects an integer argument", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001349 return ERR_ALERT | ERR_FATAL;
1350 }
1351
Willy Tarreau4348fad2012-09-20 16:48:07 +02001352 new = LIST_NEXT(&conf->listeners, struct listener *, by_bind);
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001353 new->luid = strtol(args[cur_arg + 1], &error, 10);
1354 if (*error != '\0') {
1355 memprintf(err, "'%s' : expects an integer argument, found '%s'", args[cur_arg], args[cur_arg + 1]);
1356 return ERR_ALERT | ERR_FATAL;
1357 }
Willy Tarreau4348fad2012-09-20 16:48:07 +02001358 new->conf.id.key = new->luid;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001359
Willy Tarreau4348fad2012-09-20 16:48:07 +02001360 if (new->luid <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001361 memprintf(err, "'%s' : custom id has to be > 0", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001362 return ERR_ALERT | ERR_FATAL;
1363 }
1364
Willy Tarreau4348fad2012-09-20 16:48:07 +02001365 node = eb32_lookup(&px->conf.used_listener_id, new->luid);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001366 if (node) {
1367 l = container_of(node, struct listener, conf.id);
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001368 memprintf(err, "'%s' : custom id %d already used at %s:%d ('bind %s')",
1369 args[cur_arg], l->luid, l->bind_conf->file, l->bind_conf->line,
1370 l->bind_conf->arg);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001371 return ERR_ALERT | ERR_FATAL;
1372 }
1373
Willy Tarreau4348fad2012-09-20 16:48:07 +02001374 eb32_insert(&px->conf.used_listener_id, &new->conf.id);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001375 return 0;
1376}
1377
1378/* parse the "maxconn" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001379static 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 +02001380{
1381 struct listener *l;
1382 int val;
1383
1384 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001385 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001386 return ERR_ALERT | ERR_FATAL;
1387 }
1388
1389 val = atol(args[cur_arg + 1]);
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001390 if (val < 0) {
1391 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001392 return ERR_ALERT | ERR_FATAL;
1393 }
1394
Willy Tarreau4348fad2012-09-20 16:48:07 +02001395 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001396 l->maxconn = val;
1397
1398 return 0;
1399}
1400
1401/* parse the "name" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001402static 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 +02001403{
1404 struct listener *l;
1405
1406 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001407 memprintf(err, "'%s' : missing name", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001408 return ERR_ALERT | ERR_FATAL;
1409 }
1410
Willy Tarreau4348fad2012-09-20 16:48:07 +02001411 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001412 l->name = strdup(args[cur_arg + 1]);
1413
1414 return 0;
1415}
1416
1417/* parse the "nice" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001418static 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 +02001419{
1420 struct listener *l;
1421 int val;
1422
1423 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001424 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001425 return ERR_ALERT | ERR_FATAL;
1426 }
1427
1428 val = atol(args[cur_arg + 1]);
1429 if (val < -1024 || val > 1024) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001430 memprintf(err, "'%s' : invalid value %d, allowed range is -1024..1024", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001431 return ERR_ALERT | ERR_FATAL;
1432 }
1433
Willy Tarreau4348fad2012-09-20 16:48:07 +02001434 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001435 l->nice = val;
1436
1437 return 0;
1438}
1439
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001440/* parse the "process" bind keyword */
1441static int bind_parse_process(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1442{
Christopher Fauletc644fa92017-11-23 22:44:11 +01001443 char *slash;
1444 unsigned long proc = 0, thread = 0;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001445
Christopher Fauletc644fa92017-11-23 22:44:11 +01001446 if ((slash = strchr(args[cur_arg + 1], '/')) != NULL)
1447 *slash = 0;
1448
Willy Tarreauff9c9142019-02-07 10:39:36 +01001449 if (parse_process_number(args[cur_arg + 1], &proc, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +01001450 memprintf(err, "'%s' : %s", args[cur_arg], *err);
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001451 return ERR_ALERT | ERR_FATAL;
1452 }
1453
Christopher Fauletc644fa92017-11-23 22:44:11 +01001454 if (slash) {
Willy Tarreauc9a82e42019-01-26 13:25:14 +01001455 if (parse_process_number(slash+1, &thread, MAX_THREADS, NULL, err)) {
Christopher Fauletc644fa92017-11-23 22:44:11 +01001456 memprintf(err, "'%s' : %s", args[cur_arg], *err);
1457 return ERR_ALERT | ERR_FATAL;
1458 }
1459 *slash = '/';
1460 }
1461
Willy Tarreaue26993c2020-09-03 07:18:55 +02001462 conf->settings.bind_proc |= proc;
1463 conf->settings.bind_thread |= thread;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001464 return 0;
1465}
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001466
Christopher Fauleta717b992018-04-10 14:43:00 +02001467/* parse the "proto" bind keyword */
1468static int bind_parse_proto(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1469{
1470 struct ist proto;
1471
1472 if (!*args[cur_arg + 1]) {
1473 memprintf(err, "'%s' : missing value", args[cur_arg]);
1474 return ERR_ALERT | ERR_FATAL;
1475 }
1476
1477 proto = ist2(args[cur_arg + 1], strlen(args[cur_arg + 1]));
1478 conf->mux_proto = get_mux_proto(proto);
1479 if (!conf->mux_proto) {
1480 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[cur_arg], args[cur_arg+1]);
1481 return ERR_ALERT | ERR_FATAL;
1482 }
Christopher Fauleta717b992018-04-10 14:43:00 +02001483 return 0;
1484}
1485
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001486/* config parser for global "tune.listener.multi-queue", accepts "on" or "off" */
1487static int cfg_parse_tune_listener_mq(char **args, int section_type, struct proxy *curpx,
1488 struct proxy *defpx, const char *file, int line,
1489 char **err)
1490{
1491 if (too_many_args(1, args, err, NULL))
1492 return -1;
1493
1494 if (strcmp(args[1], "on") == 0)
1495 global.tune.options |= GTUNE_LISTENER_MQ;
1496 else if (strcmp(args[1], "off") == 0)
1497 global.tune.options &= ~GTUNE_LISTENER_MQ;
1498 else {
1499 memprintf(err, "'%s' expects either 'on' or 'off' but got '%s'.", args[0], args[1]);
1500 return -1;
1501 }
1502 return 0;
1503}
1504
Willy Tarreau61612d42012-04-19 18:42:05 +02001505/* Note: must not be declared <const> as its list will be overwritten.
1506 * Please take care of keeping this list alphabetically sorted.
1507 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001508static struct sample_fetch_kw_list smp_kws = {ILH, {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02001509 { "dst_conn", smp_fetch_dconn, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
1510 { "so_id", smp_fetch_so_id, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
Jerome Magnineb421b22020-03-27 22:08:40 +01001511 { "so_name", smp_fetch_so_name, 0, NULL, SMP_T_STR, SMP_USE_FTEND, },
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001512 { /* END */ },
1513}};
1514
Willy Tarreau0108d902018-11-25 19:14:37 +01001515INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
1516
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001517/* Note: must not be declared <const> as its list will be overwritten.
1518 * Please take care of keeping this list alphabetically sorted.
1519 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001520static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001521 { /* END */ },
Willy Tarreau645513a2010-05-24 20:55:15 +02001522}};
1523
Willy Tarreau0108d902018-11-25 19:14:37 +01001524INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
1525
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001526/* Note: must not be declared <const> as its list will be overwritten.
1527 * Please take care of keeping this list alphabetically sorted, doing so helps
1528 * all code contributors.
1529 * Optional keywords are also declared with a NULL ->parse() function so that
1530 * the config parser can report an appropriate error when a known keyword was
1531 * not enabled.
1532 */
Willy Tarreau51fb7652012-09-18 18:24:39 +02001533static struct bind_kw_list bind_kws = { "ALL", { }, {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001534 { "accept-netscaler-cip", bind_parse_accept_netscaler_cip, 1 }, /* enable NetScaler Client IP insertion protocol */
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001535 { "accept-proxy", bind_parse_accept_proxy, 0 }, /* enable PROXY protocol */
1536 { "backlog", bind_parse_backlog, 1 }, /* set backlog of listening socket */
1537 { "id", bind_parse_id, 1 }, /* set id of listening socket */
1538 { "maxconn", bind_parse_maxconn, 1 }, /* set maxconn of listening socket */
1539 { "name", bind_parse_name, 1 }, /* set name of listening socket */
1540 { "nice", bind_parse_nice, 1 }, /* set nice of listening socket */
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001541 { "process", bind_parse_process, 1 }, /* set list of allowed process for this socket */
Christopher Fauleta717b992018-04-10 14:43:00 +02001542 { "proto", bind_parse_proto, 1 }, /* set the proto to use for all incoming connections */
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001543 { /* END */ },
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001544}};
1545
Willy Tarreau0108d902018-11-25 19:14:37 +01001546INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
1547
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001548/* config keyword parsers */
1549static struct cfg_kw_list cfg_kws = {ILH, {
1550 { CFG_GLOBAL, "tune.listener.multi-queue", cfg_parse_tune_listener_mq },
1551 { 0, NULL, NULL }
1552}};
1553
1554INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
1555
Willy Tarreau645513a2010-05-24 20:55:15 +02001556/*
1557 * Local variables:
1558 * c-indent-level: 8
1559 * c-basic-offset: 8
1560 * End:
1561 */