blob: 4b21f67a40872a989db853df8a1b13c6bd9f8120 [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 Tarreau44489252014-01-14 17:52:01 +010013#define _GNU_SOURCE
Willy Tarreau6ae1ba62014-05-07 19:01:58 +020014#include <ctype.h>
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020015#include <errno.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020016#include <stdio.h>
17#include <string.h>
Willy Tarreau95ccdde2014-02-01 09:28:36 +010018#include <unistd.h>
19#include <fcntl.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020020
Willy Tarreaudcc048a2020-06-04 19:11:43 +020021#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020022#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020023#include <haproxy/cfgparse.h>
Willy Tarreau7ea393d2020-06-04 18:02:10 +020024#include <haproxy/connection.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020025#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020026#include <haproxy/fd.h>
27#include <haproxy/freq_ctr.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020028#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020029#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020030#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020031#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#include <haproxy/proto_sockpair.h>
33#include <haproxy/protocol-t.h>
34#include <haproxy/protocol.h>
35#include <haproxy/sample.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020036#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020037#include <haproxy/task.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020038#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/tools.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020040
Willy Tarreaub648d632007-10-28 22:13:50 +010041
Willy Tarreau26982662012-09-12 23:17:10 +020042/* List head of all known bind keywords */
43static struct bind_kw_list bind_keywords = {
44 .list = LIST_HEAD_INIT(bind_keywords.list)
45};
46
Willy Tarreaua1d97f82019-12-10 11:18:41 +010047/* list of the temporarily limited listeners because of lack of resource */
48static struct mt_list global_listener_queue = MT_LIST_HEAD_INIT(global_listener_queue);
49static struct task *global_listener_queue_task;
50static struct task *manage_global_listener_queue(struct task *t, void *context, unsigned short state);
51
52
Willy Tarreau1efafce2019-01-27 15:37:19 +010053#if defined(USE_THREAD)
54
55struct accept_queue_ring accept_queue_rings[MAX_THREADS] __attribute__((aligned(64))) = { };
56
57/* dequeue and process a pending connection from the local accept queue (single
58 * consumer). Returns the accepted fd or -1 if none was found. The listener is
59 * placed into *li. The address is copied into *addr for no more than *addr_len
60 * bytes, and the address length is returned into *addr_len.
61 */
62int accept_queue_pop_sc(struct accept_queue_ring *ring, struct listener **li, void *addr, int *addr_len)
63{
64 struct accept_queue_entry *e;
65 unsigned int pos, next;
66 struct listener *ptr;
67 int len;
68 int fd;
69
70 pos = ring->head;
71
72 if (pos == ring->tail)
73 return -1;
74
75 next = pos + 1;
76 if (next >= ACCEPT_QUEUE_SIZE)
77 next = 0;
78
79 e = &ring->entry[pos];
80
81 /* wait for the producer to update the listener's pointer */
82 while (1) {
83 ptr = e->listener;
84 __ha_barrier_load();
85 if (ptr)
86 break;
87 pl_cpu_relax();
88 }
89
90 fd = e->fd;
91 len = e->addr_len;
92 if (len > *addr_len)
93 len = *addr_len;
94
95 if (likely(len > 0))
96 memcpy(addr, &e->addr, len);
97
98 /* release the entry */
99 e->listener = NULL;
100
101 __ha_barrier_store();
102 ring->head = next;
103
104 *addr_len = len;
105 *li = ptr;
106
107 return fd;
108}
109
110
111/* tries to push a new accepted connection <fd> into ring <ring> for listener
112 * <li>, from address <addr> whose length is <addr_len>. Returns non-zero if it
113 * succeeds, or zero if the ring is full. Supports multiple producers.
114 */
115int accept_queue_push_mp(struct accept_queue_ring *ring, int fd,
116 struct listener *li, const void *addr, int addr_len)
117{
118 struct accept_queue_entry *e;
119 unsigned int pos, next;
120
121 pos = ring->tail;
122 do {
123 next = pos + 1;
124 if (next >= ACCEPT_QUEUE_SIZE)
125 next = 0;
126 if (next == ring->head)
127 return 0; // ring full
Olivier Houchard64213e92019-03-08 18:52:57 +0100128 } while (unlikely(!_HA_ATOMIC_CAS(&ring->tail, &pos, next)));
Willy Tarreau1efafce2019-01-27 15:37:19 +0100129
130
131 e = &ring->entry[pos];
132
133 if (addr_len > sizeof(e->addr))
134 addr_len = sizeof(e->addr);
135
136 if (addr_len)
137 memcpy(&e->addr, addr, addr_len);
138
139 e->addr_len = addr_len;
140 e->fd = fd;
141
142 __ha_barrier_store();
143 /* now commit the change */
144
145 e->listener = li;
146 return 1;
147}
148
149/* proceed with accepting new connections */
150static struct task *accept_queue_process(struct task *t, void *context, unsigned short state)
151{
152 struct accept_queue_ring *ring = context;
153 struct listener *li;
154 struct sockaddr_storage addr;
Christopher Faulet102854c2019-04-30 12:17:13 +0200155 unsigned int max_accept;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100156 int addr_len;
157 int ret;
158 int fd;
159
Christopher Faulet102854c2019-04-30 12:17:13 +0200160 /* if global.tune.maxaccept is -1, then max_accept is UINT_MAX. It
161 * is not really illimited, but it is probably enough.
162 */
163 max_accept = global.tune.maxaccept ? global.tune.maxaccept : 64;
164 for (; max_accept; max_accept--) {
Willy Tarreau1efafce2019-01-27 15:37:19 +0100165 addr_len = sizeof(addr);
166 fd = accept_queue_pop_sc(ring, &li, &addr, &addr_len);
167 if (fd < 0)
168 break;
169
Olivier Houchard64213e92019-03-08 18:52:57 +0100170 _HA_ATOMIC_ADD(&li->thr_conn[tid], 1);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100171 ret = li->accept(li, fd, &addr);
172 if (ret <= 0) {
173 /* connection was terminated by the application */
174 continue;
175 }
176
177 /* increase the per-process number of cumulated sessions, this
178 * may only be done once l->accept() has accepted the connection.
179 */
180 if (!(li->options & LI_O_UNLIMITED)) {
181 HA_ATOMIC_UPDATE_MAX(&global.sps_max,
182 update_freq_ctr(&global.sess_per_sec, 1));
183 if (li->bind_conf && li->bind_conf->is_ssl) {
184 HA_ATOMIC_UPDATE_MAX(&global.ssl_max,
185 update_freq_ctr(&global.ssl_per_sec, 1));
186 }
187 }
188 }
189
190 /* ran out of budget ? Let's come here ASAP */
Christopher Faulet102854c2019-04-30 12:17:13 +0200191 if (!max_accept)
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200192 tasklet_wakeup(ring->tasklet);
Willy Tarreau1efafce2019-01-27 15:37:19 +0100193
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200194 return NULL;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100195}
196
197/* Initializes the accept-queues. Returns 0 on success, otherwise ERR_* flags */
198static int accept_queue_init()
199{
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200200 struct tasklet *t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100201 int i;
202
203 for (i = 0; i < global.nbthread; i++) {
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200204 t = tasklet_new();
Willy Tarreau1efafce2019-01-27 15:37:19 +0100205 if (!t) {
206 ha_alert("Out of memory while initializing accept queue for thread %d\n", i);
207 return ERR_FATAL|ERR_ABORT;
208 }
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200209 t->tid = i;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100210 t->process = accept_queue_process;
211 t->context = &accept_queue_rings[i];
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200212 accept_queue_rings[i].tasklet = t;
Willy Tarreau1efafce2019-01-27 15:37:19 +0100213 }
214 return 0;
215}
216
217REGISTER_CONFIG_POSTPARSER("multi-threaded accept queue", accept_queue_init);
218
219#endif // USE_THREAD
220
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100221/* This function adds the specified listener's file descriptor to the polling
222 * lists if it is in the LI_LISTEN state. The listener enters LI_READY or
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500223 * LI_FULL state depending on its number of connections. In daemon mode, we
Willy Tarreauae302532014-05-07 19:22:24 +0200224 * also support binding only the relevant processes to their respective
225 * listeners. We don't do that in debug mode however.
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100226 */
Christopher Fauletf5b8adc2017-06-02 10:00:35 +0200227static void enable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100228{
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100229 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100230 if (listener->state == LI_LISTEN) {
William Lallemand095ba4c2017-06-01 17:38:50 +0200231 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau818a92e2020-09-03 07:50:19 +0200232 !(proc_mask(listener->rx.settings->bind_proc) & pid_bit)) {
Willy Tarreauae302532014-05-07 19:22:24 +0200233 /* we don't want to enable this listener and don't
234 * want any fd event to reach it.
235 */
Olivier Houchard1fc05162017-04-06 01:05:05 +0200236 if (!(global.tune.options & GTUNE_SOCKET_TRANSFER))
Christopher Faulet510c0d62018-03-16 10:04:47 +0100237 do_unbind_listener(listener, 1);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200238 else {
Christopher Faulet510c0d62018-03-16 10:04:47 +0100239 do_unbind_listener(listener, 0);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200240 listener->state = LI_LISTEN;
241 }
Willy Tarreauae302532014-05-07 19:22:24 +0200242 }
Willy Tarreaua8cf66b2019-02-27 16:49:00 +0100243 else if (!listener->maxconn || listener->nbconn < listener->maxconn) {
Willy Tarreau38ba6472020-08-27 08:16:52 +0200244 fd_want_recv(listener->rx.fd);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100245 listener->state = LI_READY;
Willy Tarreauae302532014-05-07 19:22:24 +0200246 }
247 else {
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100248 listener->state = LI_FULL;
249 }
250 }
William Lallemande22f11f2018-09-11 10:06:27 +0200251 /* if this listener is supposed to be only in the master, close it in the workers */
252 if ((global.mode & MODE_MWORKER) &&
253 (listener->options & LI_O_MWORKER) &&
254 master == 0) {
255 do_unbind_listener(listener, 1);
256 }
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100257 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100258}
259
260/* This function removes the specified listener's file descriptor from the
261 * polling lists if it is in the LI_READY or in the LI_FULL state. The listener
262 * enters LI_LISTEN.
263 */
Christopher Fauletf5b8adc2017-06-02 10:00:35 +0200264static void disable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100265{
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100266 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100267 if (listener->state < LI_READY)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200268 goto end;
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100269 if (listener->state == LI_READY)
Willy Tarreau38ba6472020-08-27 08:16:52 +0200270 fd_stop_recv(listener->rx.fd);
Olivier Houchard859dc802019-08-08 15:47:21 +0200271 MT_LIST_DEL(&listener->wait_queue);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100272 listener->state = LI_LISTEN;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200273 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100274 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100275}
276
Willy Tarreaube58c382011-07-24 18:28:10 +0200277/* This function tries to temporarily disable a listener, depending on the OS
278 * capabilities. Linux unbinds the listen socket after a SHUT_RD, and ignores
279 * SHUT_WR. Solaris refuses either shutdown(). OpenBSD ignores SHUT_RD but
280 * closes upon SHUT_WR and refuses to rebind. So a common validation path
281 * involves SHUT_WR && listen && SHUT_RD. In case of success, the FD's polling
282 * is disabled. It normally returns non-zero, unless an error is reported.
283 */
284int pause_listener(struct listener *l)
285{
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200286 int ret = 1;
287
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100288 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200289
Olivier Houchard1fc05162017-04-06 01:05:05 +0200290 if (l->state <= LI_ZOMBIE)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200291 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200292
Willy Tarreau02e19752020-09-23 17:17:22 +0200293 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
294 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
295 goto end;
296
Willy Tarreaub7436612020-08-28 19:51:44 +0200297 if (l->rx.proto->pause) {
Willy Tarreau092d8652014-07-07 20:22:12 +0200298 /* Returns < 0 in case of failure, 0 if the listener
299 * was totally stopped, or > 0 if correctly paused.
300 */
Willy Tarreaub7436612020-08-28 19:51:44 +0200301 int ret = l->rx.proto->pause(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200302
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200303 if (ret < 0) {
304 ret = 0;
305 goto end;
306 }
Willy Tarreau092d8652014-07-07 20:22:12 +0200307 else if (ret == 0)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200308 goto end;
Willy Tarreaub3fb60b2012-10-04 08:56:31 +0200309 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200310
Olivier Houchard859dc802019-08-08 15:47:21 +0200311 MT_LIST_DEL(&l->wait_queue);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200312
Willy Tarreau38ba6472020-08-27 08:16:52 +0200313 fd_stop_recv(l->rx.fd);
Willy Tarreaube58c382011-07-24 18:28:10 +0200314 l->state = LI_PAUSED;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200315 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100316 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200317 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200318}
319
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200320/* This function tries to resume a temporarily disabled listener. Paused, full,
321 * limited and disabled listeners are handled, which means that this function
322 * may replace enable_listener(). The resulting state will either be LI_READY
323 * or LI_FULL. 0 is returned in case of failure to resume (eg: dead socket).
Willy Tarreauae302532014-05-07 19:22:24 +0200324 * Listeners bound to a different process are not woken up unless we're in
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200325 * foreground mode, and are ignored. If the listener was only in the assigned
326 * state, it's totally rebound. This can happen if a pause() has completely
327 * stopped it. If the resume fails, 0 is returned and an error might be
328 * displayed.
Willy Tarreaube58c382011-07-24 18:28:10 +0200329 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100330int resume_listener(struct listener *l)
Willy Tarreaube58c382011-07-24 18:28:10 +0200331{
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200332 int ret = 1;
333
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100334 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200335
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200336 /* check that another thread didn't to the job in parallel (e.g. at the
337 * end of listen_accept() while we'd come from dequeue_all_listeners().
338 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200339 if (MT_LIST_ADDED(&l->wait_queue))
Willy Tarreauf2cb1692019-07-11 10:08:31 +0200340 goto end;
341
William Lallemand095ba4c2017-06-01 17:38:50 +0200342 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau818a92e2020-09-03 07:50:19 +0200343 !(proc_mask(l->rx.settings->bind_proc) & pid_bit))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200344 goto end;
Willy Tarreau3569df32017-03-15 12:47:46 +0100345
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200346 if (l->state == LI_ASSIGNED) {
347 char msg[100];
348 int err;
349
Willy Tarreaub3580b12020-09-01 10:26:22 +0200350 err = l->rx.proto->listen(l, msg, sizeof(msg));
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200351 if (err & ERR_ALERT)
Christopher Faulet767a84b2017-11-24 16:50:31 +0100352 ha_alert("Resuming listener: %s\n", msg);
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200353 else if (err & ERR_WARN)
Christopher Faulet767a84b2017-11-24 16:50:31 +0100354 ha_warning("Resuming listener: %s\n", msg);
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200355
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200356 if (err & (ERR_FATAL | ERR_ABORT)) {
357 ret = 0;
358 goto end;
359 }
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200360 }
361
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200362 if (l->state < LI_PAUSED || l->state == LI_ZOMBIE) {
363 ret = 0;
364 goto end;
365 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200366
Willy Tarreaub7436612020-08-28 19:51:44 +0200367 if (l->rx.proto->sock_prot == IPPROTO_TCP &&
Willy Tarreaub3fb60b2012-10-04 08:56:31 +0200368 l->state == LI_PAUSED &&
Willy Tarreau38ba6472020-08-27 08:16:52 +0200369 listen(l->rx.fd, listener_backlog(l)) != 0) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200370 ret = 0;
371 goto end;
372 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200373
374 if (l->state == LI_READY)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200375 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200376
Willy Tarreaua8cf66b2019-02-27 16:49:00 +0100377 if (l->maxconn && l->nbconn >= l->maxconn) {
Willy Tarreaube58c382011-07-24 18:28:10 +0200378 l->state = LI_FULL;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200379 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200380 }
381
Willy Tarreau38ba6472020-08-27 08:16:52 +0200382 fd_want_recv(l->rx.fd);
Willy Tarreaube58c382011-07-24 18:28:10 +0200383 l->state = LI_READY;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200384 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100385 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200386 return ret;
387}
388
Willy Tarreau87b09662015-04-03 00:22:06 +0200389/* Marks a ready listener as full so that the stream code tries to re-enable
Willy Tarreau62793712011-07-24 19:23:38 +0200390 * it upon next close() using resume_listener().
391 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200392static void listener_full(struct listener *l)
Willy Tarreau62793712011-07-24 19:23:38 +0200393{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100394 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200395 if (l->state >= LI_READY) {
Olivier Houchard859dc802019-08-08 15:47:21 +0200396 MT_LIST_DEL(&l->wait_queue);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100397 if (l->state != LI_FULL) {
Willy Tarreau38ba6472020-08-27 08:16:52 +0200398 fd_stop_recv(l->rx.fd);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100399 l->state = LI_FULL;
400 }
Willy Tarreau62793712011-07-24 19:23:38 +0200401 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100402 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau62793712011-07-24 19:23:38 +0200403}
404
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200405/* Marks a ready listener as limited so that we only try to re-enable it when
406 * resources are free again. It will be queued into the specified queue.
407 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200408static void limit_listener(struct listener *l, struct mt_list *list)
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200409{
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100410 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200411 if (l->state == LI_READY) {
Willy Tarreaude4db172020-07-10 08:10:29 +0200412 MT_LIST_TRY_ADDQ(list, &l->wait_queue);
Willy Tarreau38ba6472020-08-27 08:16:52 +0200413 fd_stop_recv(l->rx.fd);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200414 l->state = LI_LIMITED;
415 }
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100416 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200417}
418
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100419/* This function adds all of the protocol's listener's file descriptors to the
420 * polling lists when they are in the LI_LISTEN state. It is intended to be
421 * used as a protocol's generic enable_all() primitive, for use after the
422 * fork(). It puts the listeners into LI_READY or LI_FULL states depending on
423 * their number of connections. It always returns ERR_NONE.
Willy Tarreaudaacf362019-07-24 16:45:02 +0200424 *
425 * Must be called with proto_lock held.
426 *
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100427 */
428int enable_all_listeners(struct protocol *proto)
429{
430 struct listener *listener;
431
Willy Tarreaub7436612020-08-28 19:51:44 +0200432 list_for_each_entry(listener, &proto->listeners, rx.proto_list)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100433 enable_listener(listener);
434 return ERR_NONE;
435}
436
437/* This function removes all of the protocol's listener's file descriptors from
438 * the polling lists when they are in the LI_READY or LI_FULL states. It is
439 * intended to be used as a protocol's generic disable_all() primitive. It puts
440 * the listeners into LI_LISTEN, and always returns ERR_NONE.
Willy Tarreaudaacf362019-07-24 16:45:02 +0200441 *
442 * Must be called with proto_lock held.
443 *
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100444 */
445int disable_all_listeners(struct protocol *proto)
446{
447 struct listener *listener;
448
Willy Tarreaub7436612020-08-28 19:51:44 +0200449 list_for_each_entry(listener, &proto->listeners, rx.proto_list)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100450 disable_listener(listener);
451 return ERR_NONE;
452}
453
Willy Tarreau241797a2019-12-10 14:10:52 +0100454/* Dequeues all listeners waiting for a resource the global wait queue */
455void dequeue_all_listeners()
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200456{
Willy Tarreau01abd022019-02-28 10:27:18 +0100457 struct listener *listener;
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200458
Willy Tarreau241797a2019-12-10 14:10:52 +0100459 while ((listener = MT_LIST_POP(&global_listener_queue, struct listener *, wait_queue))) {
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200460 /* This cannot fail because the listeners are by definition in
Willy Tarreau01abd022019-02-28 10:27:18 +0100461 * the LI_LIMITED state.
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200462 */
Willy Tarreau01abd022019-02-28 10:27:18 +0100463 resume_listener(listener);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200464 }
465}
466
Willy Tarreau241797a2019-12-10 14:10:52 +0100467/* Dequeues all listeners waiting for a resource in proxy <px>'s queue */
468void dequeue_proxy_listeners(struct proxy *px)
469{
470 struct listener *listener;
471
472 while ((listener = MT_LIST_POP(&px->listener_queue, struct listener *, wait_queue))) {
473 /* This cannot fail because the listeners are by definition in
474 * the LI_LIMITED state.
475 */
476 resume_listener(listener);
477 }
478}
479
Christopher Faulet510c0d62018-03-16 10:04:47 +0100480/* Must be called with the lock held. Depending on <do_close> value, it does
481 * what unbind_listener or unbind_listener_no_close should do.
482 */
483void do_unbind_listener(struct listener *listener, int do_close)
Willy Tarreaub648d632007-10-28 22:13:50 +0100484{
Olivier Houcharda5188562019-03-08 15:35:42 +0100485 if (listener->state == LI_READY && fd_updt)
Willy Tarreau38ba6472020-08-27 08:16:52 +0200486 fd_stop_recv(listener->rx.fd);
Willy Tarreaub648d632007-10-28 22:13:50 +0100487
Olivier Houchard859dc802019-08-08 15:47:21 +0200488 MT_LIST_DEL(&listener->wait_queue);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200489
Willy Tarreaube58c382011-07-24 18:28:10 +0200490 if (listener->state >= LI_PAUSED) {
Willy Tarreau67672452020-08-26 11:44:17 +0200491 listener->state = LI_ASSIGNED;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200492 fd_stop_both(listener->rx.fd);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200493 if (do_close) {
Willy Tarreau38ba6472020-08-27 08:16:52 +0200494 fd_delete(listener->rx.fd);
Willy Tarreau0b915012020-09-01 10:47:07 +0200495 listener->rx.flags &= ~RX_F_BOUND;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200496 listener->rx.fd = -1;
Olivier Houchard1fc05162017-04-06 01:05:05 +0200497 }
Willy Tarreaub648d632007-10-28 22:13:50 +0100498 }
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100499}
500
Olivier Houchard1fc05162017-04-06 01:05:05 +0200501/* This function closes the listening socket for the specified listener,
502 * provided that it's already in a listening state. The listener enters the
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100503 * LI_ASSIGNED state. This function is intended to be used as a generic
504 * function for standard protocols.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200505 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100506void unbind_listener(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200507{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100508 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100509 do_unbind_listener(listener, 1);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100510 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200511}
512
513/* This function pretends the listener is dead, but keeps the FD opened, so
514 * that we can provide it, for conf reloading.
515 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100516void unbind_listener_no_close(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200517{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100518 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100519 do_unbind_listener(listener, 0);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100520 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200521}
522
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200523/* creates one or multiple listeners for bind_conf <bc> on sockaddr <ss> on port
524 * range <portl> to <porth>, and possibly attached to fd <fd> (or -1 for auto
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200525 * allocation). The address family is taken from ss->ss_family, and the protocol
526 * passed in <proto> must be usable on this family. The number of jobs and
527 * listeners is automatically increased by the number of listeners created. It
528 * returns non-zero on success, zero on error with the error message set in <err>.
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200529 */
530int create_listeners(struct bind_conf *bc, const struct sockaddr_storage *ss,
Willy Tarreau9b3178d2020-09-16 17:58:55 +0200531 int portl, int porth, int fd, struct protocol *proto, char **err)
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200532{
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200533 struct listener *l;
534 int port;
535
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200536 for (port = portl; port <= porth; port++) {
537 l = calloc(1, sizeof(*l));
538 if (!l) {
539 memprintf(err, "out of memory");
540 return 0;
541 }
542 l->obj_type = OBJ_TYPE_LISTENER;
543 LIST_ADDQ(&bc->frontend->conf.listeners, &l->by_fe);
544 LIST_ADDQ(&bc->listeners, &l->by_bind);
545 l->bind_conf = bc;
Willy Tarreau0fce6bc2020-09-03 07:46:06 +0200546 l->rx.settings = &bc->settings;
Willy Tarreaueef45422020-09-03 10:05:03 +0200547 l->rx.owner = l;
Willy Tarreau38ba6472020-08-27 08:16:52 +0200548 l->rx.fd = fd;
Willy Tarreau37159062020-08-27 07:48:42 +0200549 memcpy(&l->rx.addr, ss, sizeof(*ss));
Olivier Houchard859dc802019-08-08 15:47:21 +0200550 MT_LIST_INIT(&l->wait_queue);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200551 l->state = LI_INIT;
552
553 proto->add(l, port);
554
Willy Tarreau909c23b2020-09-15 13:50:58 +0200555 if (fd != -1)
Willy Tarreau43046fa2020-09-01 15:41:59 +0200556 l->rx.flags |= RX_F_INHERITED;
William Lallemand75ea0a02017-11-15 19:02:58 +0100557
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100558 HA_SPIN_INIT(&l->lock);
Olivier Houchard64213e92019-03-08 18:52:57 +0100559 _HA_ATOMIC_ADD(&jobs, 1);
560 _HA_ATOMIC_ADD(&listeners, 1);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200561 }
562 return 1;
563}
564
Willy Tarreau1a64d162007-10-28 22:26:05 +0100565/* Delete a listener from its protocol's list of listeners. The listener's
566 * state is automatically updated from LI_ASSIGNED to LI_INIT. The protocol's
Willy Tarreau2cc5bae2017-09-15 08:18:11 +0200567 * number of listeners is updated, as well as the global number of listeners
568 * and jobs. Note that the listener must have previously been unbound. This
569 * is the generic function to use to remove a listener.
Willy Tarreaudaacf362019-07-24 16:45:02 +0200570 *
571 * Will grab the proto_lock.
572 *
Willy Tarreau1a64d162007-10-28 22:26:05 +0100573 */
574void delete_listener(struct listener *listener)
575{
Willy Tarreau6ee9f8d2019-08-26 10:55:52 +0200576 HA_SPIN_LOCK(PROTO_LOCK, &proto_lock);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100577 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100578 if (listener->state == LI_ASSIGNED) {
579 listener->state = LI_INIT;
Willy Tarreaub7436612020-08-28 19:51:44 +0200580 LIST_DEL(&listener->rx.proto_list);
581 listener->rx.proto->nb_listeners--;
Olivier Houchard64213e92019-03-08 18:52:57 +0100582 _HA_ATOMIC_SUB(&jobs, 1);
583 _HA_ATOMIC_SUB(&listeners, 1);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100584 }
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100585 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau6ee9f8d2019-08-26 10:55:52 +0200586 HA_SPIN_UNLOCK(PROTO_LOCK, &proto_lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100587}
588
Willy Tarreaue2711c72019-02-27 15:39:41 +0100589/* Returns a suitable value for a listener's backlog. It uses the listener's,
590 * otherwise the frontend's backlog, otherwise the listener's maxconn,
591 * otherwise the frontend's maxconn, otherwise 1024.
592 */
593int listener_backlog(const struct listener *l)
594{
595 if (l->backlog)
596 return l->backlog;
597
598 if (l->bind_conf->frontend->backlog)
599 return l->bind_conf->frontend->backlog;
600
601 if (l->maxconn)
602 return l->maxconn;
603
604 if (l->bind_conf->frontend->maxconn)
605 return l->bind_conf->frontend->maxconn;
606
607 return 1024;
608}
609
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200610/* This function is called on a read event from a listening socket, corresponding
611 * to an accept. It tries to accept as many connections as possible, and for each
612 * calls the listener's accept handler (generally the frontend's accept handler).
613 */
Willy Tarreauafad0e02012-08-09 14:45:22 +0200614void listener_accept(int fd)
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200615{
616 struct listener *l = fdtab[fd].owner;
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100617 struct proxy *p;
Christopher Faulet102854c2019-04-30 12:17:13 +0200618 unsigned int max_accept;
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100619 int next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100620 int next_feconn = 0;
621 int next_actconn = 0;
Willy Tarreaubb660302014-05-07 19:47:02 +0200622 int expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200623 int cfd;
624 int ret;
Willy Tarreau818dca52014-01-31 19:40:19 +0100625#ifdef USE_ACCEPT4
626 static int accept4_broken;
627#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200628
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100629 if (!l)
630 return;
631 p = l->bind_conf->frontend;
Christopher Faulet102854c2019-04-30 12:17:13 +0200632
633 /* if l->maxaccept is -1, then max_accept is UINT_MAX. It is not really
634 * illimited, but it is probably enough.
635 */
Olivier Houchardd16a9df2019-02-25 16:18:16 +0100636 max_accept = l->maxaccept ? l->maxaccept : 1;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200637
Willy Tarreau93e7c002013-10-07 18:51:07 +0200638 if (!(l->options & LI_O_UNLIMITED) && global.sps_lim) {
639 int max = freq_ctr_remain(&global.sess_per_sec, global.sps_lim, 0);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200640
641 if (unlikely(!max)) {
642 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200643 expire = tick_add(now_ms, next_event_delay(&global.sess_per_sec, global.sps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100644 goto limit_global;
Willy Tarreau93e7c002013-10-07 18:51:07 +0200645 }
646
647 if (max_accept > max)
648 max_accept = max;
649 }
650
651 if (!(l->options & LI_O_UNLIMITED) && global.cps_lim) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200652 int max = freq_ctr_remain(&global.conn_per_sec, global.cps_lim, 0);
653
654 if (unlikely(!max)) {
655 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200656 expire = tick_add(now_ms, next_event_delay(&global.conn_per_sec, global.cps_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100657 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200658 }
659
660 if (max_accept > max)
661 max_accept = max;
662 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200663#ifdef USE_OPENSSL
664 if (!(l->options & LI_O_UNLIMITED) && global.ssl_lim && l->bind_conf && l->bind_conf->is_ssl) {
665 int max = freq_ctr_remain(&global.ssl_per_sec, global.ssl_lim, 0);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200666
Willy Tarreaue43d5322013-10-07 20:01:52 +0200667 if (unlikely(!max)) {
668 /* frontend accept rate limit was reached */
Willy Tarreaue43d5322013-10-07 20:01:52 +0200669 expire = tick_add(now_ms, next_event_delay(&global.ssl_per_sec, global.ssl_lim, 0));
Willy Tarreau0591bf72019-12-10 12:01:21 +0100670 goto limit_global;
Willy Tarreaue43d5322013-10-07 20:01:52 +0200671 }
672
673 if (max_accept > max)
674 max_accept = max;
675 }
676#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200677 if (p && p->fe_sps_lim) {
678 int max = freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0);
679
680 if (unlikely(!max)) {
681 /* frontend accept rate limit was reached */
Willy Tarreau0591bf72019-12-10 12:01:21 +0100682 expire = tick_add(now_ms, next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0));
683 goto limit_proxy;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200684 }
685
686 if (max_accept > max)
687 max_accept = max;
688 }
689
690 /* Note: if we fail to allocate a connection because of configured
691 * limits, we'll schedule a new attempt worst 1 second later in the
692 * worst case. If we fail due to system limits or temporary resource
693 * shortage, we try again 100ms later in the worst case.
694 */
Christopher Faulet102854c2019-04-30 12:17:13 +0200695 for (; max_accept; next_conn = next_feconn = next_actconn = 0, max_accept--) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200696 struct sockaddr_storage addr;
697 socklen_t laddr = sizeof(addr);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200698 unsigned int count;
Willy Tarreauaf613e82020-06-05 08:40:51 +0200699 __decl_thread(unsigned long mask);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200700
Willy Tarreau82c97892019-02-27 19:32:32 +0100701 /* pre-increase the number of connections without going too far.
702 * We process the listener, then the proxy, then the process.
703 * We know which ones to unroll based on the next_xxx value.
704 */
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100705 do {
706 count = l->nbconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100707 if (unlikely(l->maxconn && count >= l->maxconn)) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100708 /* the listener was marked full or another
709 * thread is going to do it.
710 */
711 next_conn = 0;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100712 listener_full(l);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100713 goto end;
714 }
715 next_conn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000716 } while (!_HA_ATOMIC_CAS(&l->nbconn, (int *)(&count), next_conn));
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100717
Willy Tarreau82c97892019-02-27 19:32:32 +0100718 if (p) {
719 do {
720 count = p->feconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100721 if (unlikely(count >= p->maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100722 /* the frontend was marked full or another
723 * thread is going to do it.
724 */
725 next_feconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100726 expire = TICK_ETERNITY;
727 goto limit_proxy;
Willy Tarreau82c97892019-02-27 19:32:32 +0100728 }
729 next_feconn = count + 1;
Olivier Houchard64213e92019-03-08 18:52:57 +0100730 } while (!_HA_ATOMIC_CAS(&p->feconn, &count, next_feconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200731 }
732
Willy Tarreau82c97892019-02-27 19:32:32 +0100733 if (!(l->options & LI_O_UNLIMITED)) {
734 do {
735 count = actconn;
Willy Tarreau93604ed2019-11-15 10:20:07 +0100736 if (unlikely(count >= global.maxconn)) {
Willy Tarreau82c97892019-02-27 19:32:32 +0100737 /* the process was marked full or another
738 * thread is going to do it.
739 */
740 next_actconn = 0;
Willy Tarreau0591bf72019-12-10 12:01:21 +0100741 expire = tick_add(now_ms, 1000); /* try again in 1 second */
742 goto limit_global;
Willy Tarreau82c97892019-02-27 19:32:32 +0100743 }
744 next_actconn = count + 1;
David Carlier56716622019-03-27 16:08:42 +0000745 } while (!_HA_ATOMIC_CAS(&actconn, (int *)(&count), next_actconn));
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200746 }
747
William Lallemand2fe7dd02018-09-11 16:51:29 +0200748 /* with sockpair@ we don't want to do an accept */
Willy Tarreau37159062020-08-27 07:48:42 +0200749 if (unlikely(l->rx.addr.ss_family == AF_CUST_SOCKPAIR)) {
William Lallemand2fe7dd02018-09-11 16:51:29 +0200750 if ((cfd = recv_fd_uxst(fd)) != -1)
William Lallemandd9138002018-11-27 12:02:39 +0100751 fcntl(cfd, F_SETFL, O_NONBLOCK);
Willy Tarreau888d5672019-01-27 18:34:12 +0100752 /* just like with UNIX sockets, only the family is filled */
753 addr.ss_family = AF_UNIX;
754 laddr = sizeof(addr.ss_family);
William Lallemand2fe7dd02018-09-11 16:51:29 +0200755 } else
756
Willy Tarreau1bc4aab2012-10-08 20:11:03 +0200757#ifdef USE_ACCEPT4
Willy Tarreau818dca52014-01-31 19:40:19 +0100758 /* only call accept4() if it's known to be safe, otherwise
759 * fallback to the legacy accept() + fcntl().
760 */
761 if (unlikely(accept4_broken ||
William Lallemandd9138002018-11-27 12:02:39 +0100762 ((cfd = accept4(fd, (struct sockaddr *)&addr, &laddr, SOCK_NONBLOCK)) == -1 &&
Willy Tarreau818dca52014-01-31 19:40:19 +0100763 (errno == ENOSYS || errno == EINVAL || errno == EBADF) &&
764 (accept4_broken = 1))))
765#endif
Willy Tarreau6b3b0d42012-10-22 19:32:55 +0200766 if ((cfd = accept(fd, (struct sockaddr *)&addr, &laddr)) != -1)
William Lallemandd9138002018-11-27 12:02:39 +0100767 fcntl(cfd, F_SETFL, O_NONBLOCK);
Willy Tarreau818dca52014-01-31 19:40:19 +0100768
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200769 if (unlikely(cfd == -1)) {
770 switch (errno) {
771 case EAGAIN:
Willy Tarreau20aeb1c2019-12-10 08:42:21 +0100772 if (fdtab[fd].ev & (FD_POLL_HUP|FD_POLL_ERR)) {
Willy Tarreaubb660302014-05-07 19:47:02 +0200773 /* the listening socket might have been disabled in a shared
774 * process and we're a collateral victim. We'll just pause for
775 * a while in case it comes back. In the mean time, we need to
776 * clear this sticky flag.
777 */
Willy Tarreau20aeb1c2019-12-10 08:42:21 +0100778 _HA_ATOMIC_AND(&fdtab[fd].ev, ~(FD_POLL_HUP|FD_POLL_ERR));
Willy Tarreaubb660302014-05-07 19:47:02 +0200779 goto transient_error;
780 }
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200781 goto end; /* nothing more to accept */
Willy Tarreaubb660302014-05-07 19:47:02 +0200782 case EINVAL:
783 /* might be trying to accept on a shut fd (eg: soft stop) */
784 goto transient_error;
Willy Tarreaua593ec52014-01-20 21:21:30 +0100785 case EINTR:
786 case ECONNABORTED:
Olivier Houchard64213e92019-03-08 18:52:57 +0100787 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100788 if (p)
Olivier Houchard64213e92019-03-08 18:52:57 +0100789 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +0100790 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +0100791 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreaua593ec52014-01-20 21:21:30 +0100792 continue;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200793 case ENFILE:
794 if (p)
795 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100796 "Proxy %s reached system FD limit (maxsock=%d). Please check system tunables.\n",
797 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200798 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200799 case EMFILE:
800 if (p)
801 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100802 "Proxy %s reached process FD limit (maxsock=%d). Please check 'ulimit-n' and restart.\n",
803 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200804 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200805 case ENOBUFS:
806 case ENOMEM:
807 if (p)
808 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100809 "Proxy %s reached system memory limit (maxsock=%d). Please check system tunables.\n",
810 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200811 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200812 default:
Willy Tarreaua593ec52014-01-20 21:21:30 +0100813 /* unexpected result, let's give up and let other tasks run */
Willy Tarreau92079932019-12-10 09:30:05 +0100814 max_accept = 0;
815 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200816 }
817 }
818
William Lallemandd9138002018-11-27 12:02:39 +0100819 /* we don't want to leak the FD upon reload if it's in the master */
820 if (unlikely(master == 1))
821 fcntl(cfd, F_SETFD, FD_CLOEXEC);
822
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100823 /* The connection was accepted, it must be counted as such */
824 if (l->counters)
825 HA_ATOMIC_UPDATE_MAX(&l->counters->conn_max, next_conn);
826
Willy Tarreau82c97892019-02-27 19:32:32 +0100827 if (p)
828 HA_ATOMIC_UPDATE_MAX(&p->fe_counters.conn_max, next_feconn);
829
830 proxy_inc_fe_conn_ctr(l, p);
831
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100832 if (!(l->options & LI_O_UNLIMITED)) {
833 count = update_freq_ctr(&global.conn_per_sec, 1);
834 HA_ATOMIC_UPDATE_MAX(&global.cps_max, count);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100835 }
836
Willy Tarreau64a9c052019-04-12 15:27:17 +0200837 _HA_ATOMIC_ADD(&activity[tid].accepted, 1);
838
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200839 if (unlikely(cfd >= global.maxsock)) {
840 send_log(p, LOG_EMERG,
841 "Proxy %s reached the configured maximum connection limit. Please check the global 'maxconn' value.\n",
842 p->id);
843 close(cfd);
Willy Tarreau0591bf72019-12-10 12:01:21 +0100844 expire = tick_add(now_ms, 1000); /* try again in 1 second */
845 goto limit_global;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200846 }
847
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100848 /* past this point, l->accept() will automatically decrement
Willy Tarreau82c97892019-02-27 19:32:32 +0100849 * l->nbconn, feconn and actconn once done. Setting next_*conn=0
850 * allows the error path not to rollback on nbconn. It's more
851 * convenient than duplicating all exit labels.
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100852 */
853 next_conn = 0;
Willy Tarreau82c97892019-02-27 19:32:32 +0100854 next_feconn = 0;
855 next_actconn = 0;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200856
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100857#if defined(USE_THREAD)
Willy Tarreau818a92e2020-09-03 07:50:19 +0200858 mask = thread_mask(l->rx.settings->bind_thread) & all_threads_mask;
Willy Tarreaua7da5e82020-03-12 17:33:29 +0100859 if (atleast2(mask) && (global.tune.options & GTUNE_LISTENER_MQ) && !stopping) {
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100860 struct accept_queue_ring *ring;
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100861 unsigned int t, t0, t1, t2;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100862
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100863 /* The principle is that we have two running indexes,
864 * each visiting in turn all threads bound to this
865 * listener. The connection will be assigned to the one
866 * with the least connections, and the other one will
867 * be updated. This provides a good fairness on short
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100868 * connections (round robin) and on long ones (conn
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100869 * count), without ever missing any idle thread.
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100870 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100871
872 /* keep a copy for the final update. thr_idx is composite
873 * and made of (t2<<16) + t1.
874 */
Willy Tarreau0cf33172019-03-06 15:26:33 +0100875 t0 = l->thr_idx;
Willy Tarreaufc630bd2019-03-04 19:57:34 +0100876 do {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100877 unsigned long m1, m2;
878 int q1, q2;
879
880 t2 = t1 = t0;
881 t2 >>= 16;
882 t1 &= 0xFFFF;
883
884 /* t1 walks low to high bits ;
885 * t2 walks high to low.
886 */
887 m1 = mask >> t1;
888 m2 = mask & (t2 ? nbits(t2 + 1) : ~0UL);
889
Willy Tarreau85d04242019-04-16 18:09:13 +0200890 if (unlikely(!(m1 & 1))) {
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100891 m1 &= ~1UL;
892 if (!m1) {
893 m1 = mask;
894 t1 = 0;
895 }
896 t1 += my_ffsl(m1) - 1;
897 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100898
Willy Tarreau85d04242019-04-16 18:09:13 +0200899 if (unlikely(!(m2 & (1UL << t2)) || t1 == t2)) {
900 /* highest bit not set */
901 if (!m2)
902 m2 = mask;
903
904 t2 = my_flsl(m2) - 1;
905 }
906
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100907 /* now we have two distinct thread IDs belonging to the mask */
908 q1 = accept_queue_rings[t1].tail - accept_queue_rings[t1].head + ACCEPT_QUEUE_SIZE;
909 if (q1 >= ACCEPT_QUEUE_SIZE)
910 q1 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100911
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100912 q2 = accept_queue_rings[t2].tail - accept_queue_rings[t2].head + ACCEPT_QUEUE_SIZE;
913 if (q2 >= ACCEPT_QUEUE_SIZE)
914 q2 -= ACCEPT_QUEUE_SIZE;
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100915
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100916 /* we have 3 possibilities now :
917 * q1 < q2 : t1 is less loaded than t2, so we pick it
918 * and update t2 (since t1 might still be
919 * lower than another thread)
920 * q1 > q2 : t2 is less loaded than t1, so we pick it
921 * and update t1 (since t2 might still be
922 * lower than another thread)
923 * q1 = q2 : both are equally loaded, thus we pick t1
924 * and update t1 as it will become more loaded
925 * than t2.
926 */
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100927
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100928 q1 += l->thr_conn[t1];
929 q2 += l->thr_conn[t2];
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100930
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100931 if (q1 - q2 < 0) {
932 t = t1;
933 t2 = t2 ? t2 - 1 : LONGBITS - 1;
934 }
935 else if (q1 - q2 > 0) {
936 t = t2;
937 t1++;
938 if (t1 >= LONGBITS)
939 t1 = 0;
940 }
941 else {
942 t = t1;
943 t1++;
944 if (t1 >= LONGBITS)
945 t1 = 0;
946 }
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100947
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100948 /* new value for thr_idx */
949 t1 += (t2 << 16);
Olivier Houchard64213e92019-03-08 18:52:57 +0100950 } while (unlikely(!_HA_ATOMIC_CAS(&l->thr_idx, &t0, t1)));
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100951
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100952 /* We successfully selected the best thread "t" for this
953 * connection. We use deferred accepts even if it's the
954 * local thread because tests show that it's the best
955 * performing model, likely due to better cache locality
956 * when processing this loop.
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100957 */
Willy Tarreau0fe703b2019-03-05 08:46:28 +0100958 ring = &accept_queue_rings[t];
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100959 if (accept_queue_push_mp(ring, cfd, l, &addr, laddr)) {
Olivier Houchard64213e92019-03-08 18:52:57 +0100960 _HA_ATOMIC_ADD(&activity[t].accq_pushed, 1);
Willy Tarreau2bd65a72019-09-24 06:55:18 +0200961 tasklet_wakeup(ring->tasklet);
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100962 continue;
963 }
964 /* If the ring is full we do a synchronous accept on
965 * the local thread here.
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100966 */
Olivier Houchard64213e92019-03-08 18:52:57 +0100967 _HA_ATOMIC_ADD(&activity[t].accq_full, 1);
Willy Tarreaue0e9c482019-01-27 15:37:19 +0100968 }
969#endif // USE_THREAD
970
Olivier Houchard64213e92019-03-08 18:52:57 +0100971 _HA_ATOMIC_ADD(&l->thr_conn[tid], 1);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200972 ret = l->accept(l, cfd, &addr);
973 if (unlikely(ret <= 0)) {
Willy Tarreau87b09662015-04-03 00:22:06 +0200974 /* The connection was closed by stream_accept(). Either
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200975 * we just have to ignore it (ret == 0) or it's a critical
976 * error due to a resource shortage, and we must stop the
977 * listener (ret < 0).
978 */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200979 if (ret == 0) /* successful termination */
980 continue;
981
Willy Tarreaubb660302014-05-07 19:47:02 +0200982 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200983 }
984
Willy Tarreau3f0d02b2019-02-25 19:23:37 +0100985 /* increase the per-process number of cumulated sessions, this
986 * may only be done once l->accept() has accepted the connection.
987 */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200988 if (!(l->options & LI_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200989 count = update_freq_ctr(&global.sess_per_sec, 1);
990 HA_ATOMIC_UPDATE_MAX(&global.sps_max, count);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200991 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200992#ifdef USE_OPENSSL
993 if (!(l->options & LI_O_UNLIMITED) && l->bind_conf && l->bind_conf->is_ssl) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200994 count = update_freq_ctr(&global.ssl_per_sec, 1);
995 HA_ATOMIC_UPDATE_MAX(&global.ssl_max, count);
Willy Tarreaue43d5322013-10-07 20:01:52 +0200996 }
997#endif
Willy Tarreau93e7c002013-10-07 18:51:07 +0200998
Willy Tarreau8d2c98b2020-05-01 09:51:11 +0200999 ti->flags &= ~TI_FL_STUCK; // this thread is still running
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001000 } /* end of for (max_accept--) */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001001
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +02001002 end:
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001003 if (next_conn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001004 _HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau741b4d62019-02-25 15:02:04 +01001005
Willy Tarreau82c97892019-02-27 19:32:32 +01001006 if (p && next_feconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001007 _HA_ATOMIC_SUB(&p->feconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001008
1009 if (next_actconn)
Olivier Houchard64213e92019-03-08 18:52:57 +01001010 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001011
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001012 if ((l->state == LI_FULL && (!l->maxconn || l->nbconn < l->maxconn)) ||
Willy Tarreaucdcba112019-12-11 15:06:30 +01001013 (l->state == LI_LIMITED &&
1014 ((!p || p->feconn < p->maxconn) && (actconn < global.maxconn) &&
1015 (!tick_isset(global_listener_queue_task->expire) ||
1016 tick_is_expired(global_listener_queue_task->expire, now_ms))))) {
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001017 /* at least one thread has to this when quitting */
1018 resume_listener(l);
1019
1020 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001021 dequeue_all_listeners();
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001022
Olivier Houchard859dc802019-08-08 15:47:21 +02001023 if (p && !MT_LIST_ISEMPTY(&p->listener_queue) &&
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001024 (!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 +01001025 dequeue_proxy_listeners(p);
Willy Tarreau3f0d02b2019-02-25 19:23:37 +01001026 }
Willy Tarreau4c044e22019-12-05 07:40:32 +01001027
Willy Tarreau92079932019-12-10 09:30:05 +01001028 /* Now it's getting tricky. The listener was supposed to be in LI_READY
1029 * state but in the mean time we might have changed it to LI_FULL or
1030 * LI_LIMITED, and another thread might also have turned it to
1031 * LI_PAUSED, LI_LISTEN or even LI_INI when stopping a proxy. We must
1032 * be certain to keep the FD enabled when in the READY state but we
1033 * must also stop it for other states that we might have switched to
1034 * while others re-enabled polling.
1035 */
1036 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
1037 if (l->state == LI_READY) {
1038 if (max_accept > 0)
1039 fd_cant_recv(fd);
1040 else
1041 fd_done_recv(fd);
1042 } else if (l->state > LI_ASSIGNED) {
Willy Tarreau38ba6472020-08-27 08:16:52 +02001043 fd_stop_recv(l->rx.fd);
Willy Tarreau92079932019-12-10 09:30:05 +01001044 }
1045 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001046 return;
1047
1048 transient_error:
1049 /* pause the listener for up to 100 ms */
1050 expire = tick_add(now_ms, 100);
1051
1052 limit_global:
1053 /* (re-)queue the listener to the global queue and set it to expire no
1054 * later than <expire> ahead. The listener turns to LI_LIMITED.
1055 */
1056 limit_listener(l, &global_listener_queue);
1057 task_schedule(global_listener_queue_task, expire);
1058 goto end;
1059
1060 limit_proxy:
1061 /* (re-)queue the listener to the proxy's queue and set it to expire no
1062 * later than <expire> ahead. The listener turns to LI_LIMITED.
1063 */
1064 limit_listener(l, &p->listener_queue);
Willy Tarreaueeea8082020-01-08 19:15:07 +01001065 if (p->task && tick_isset(expire))
1066 task_schedule(p->task, expire);
Willy Tarreau0591bf72019-12-10 12:01:21 +01001067 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +02001068}
1069
Willy Tarreau05f50472017-09-15 09:19:58 +02001070/* Notify the listener that a connection initiated from it was released. This
1071 * is used to keep the connection count consistent and to possibly re-open
1072 * listening when it was limited.
1073 */
1074void listener_release(struct listener *l)
1075{
1076 struct proxy *fe = l->bind_conf->frontend;
1077
1078 if (!(l->options & LI_O_UNLIMITED))
Olivier Houchard64213e92019-03-08 18:52:57 +01001079 _HA_ATOMIC_SUB(&actconn, 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001080 if (fe)
Olivier Houchard64213e92019-03-08 18:52:57 +01001081 _HA_ATOMIC_SUB(&fe->feconn, 1);
1082 _HA_ATOMIC_SUB(&l->nbconn, 1);
1083 _HA_ATOMIC_SUB(&l->thr_conn[tid], 1);
Willy Tarreau82c97892019-02-27 19:32:32 +01001084
1085 if (l->state == LI_FULL || l->state == LI_LIMITED)
Willy Tarreau05f50472017-09-15 09:19:58 +02001086 resume_listener(l);
1087
1088 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001089 dequeue_all_listeners();
Willy Tarreau05f50472017-09-15 09:19:58 +02001090
Olivier Houchard859dc802019-08-08 15:47:21 +02001091 if (!MT_LIST_ISEMPTY(&fe->listener_queue) &&
Willy Tarreau05f50472017-09-15 09:19:58 +02001092 (!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 +01001093 dequeue_proxy_listeners(fe);
Willy Tarreau05f50472017-09-15 09:19:58 +02001094}
1095
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001096/* Initializes the listener queues. Returns 0 on success, otherwise ERR_* flags */
1097static int listener_queue_init()
1098{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001099 global_listener_queue_task = task_new(MAX_THREADS_MASK);
1100 if (!global_listener_queue_task) {
1101 ha_alert("Out of memory when initializing global listener queue\n");
1102 return ERR_FATAL|ERR_ABORT;
1103 }
1104 /* very simple initialization, users will queue the task if needed */
1105 global_listener_queue_task->context = NULL; /* not even a context! */
1106 global_listener_queue_task->process = manage_global_listener_queue;
1107
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001108 return 0;
1109}
1110
1111static void listener_queue_deinit()
1112{
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001113 task_destroy(global_listener_queue_task);
1114 global_listener_queue_task = NULL;
Willy Tarreauf2cb1692019-07-11 10:08:31 +02001115}
1116
1117REGISTER_CONFIG_POSTPARSER("multi-threaded listener queue", listener_queue_init);
1118REGISTER_POST_DEINIT(listener_queue_deinit);
1119
Willy Tarreaua1d97f82019-12-10 11:18:41 +01001120
1121/* This is the global management task for listeners. It enables listeners waiting
1122 * for global resources when there are enough free resource, or at least once in
1123 * a while. It is designed to be called as a task.
1124 */
1125static struct task *manage_global_listener_queue(struct task *t, void *context, unsigned short state)
1126{
1127 /* If there are still too many concurrent connections, let's wait for
1128 * some of them to go away. We don't need to re-arm the timer because
1129 * each of them will scan the queue anyway.
1130 */
1131 if (unlikely(actconn >= global.maxconn))
1132 goto out;
1133
1134 /* We should periodically try to enable listeners waiting for a global
1135 * resource here, because it is possible, though very unlikely, that
1136 * they have been blocked by a temporary lack of global resource such
1137 * as a file descriptor or memory and that the temporary condition has
1138 * disappeared.
1139 */
1140 dequeue_all_listeners();
1141
1142 out:
1143 t->expire = TICK_ETERNITY;
1144 task_queue(t);
1145 return t;
1146}
1147
Willy Tarreau26982662012-09-12 23:17:10 +02001148/*
1149 * Registers the bind keyword list <kwl> as a list of valid keywords for next
1150 * parsing sessions.
1151 */
1152void bind_register_keywords(struct bind_kw_list *kwl)
1153{
1154 LIST_ADDQ(&bind_keywords.list, &kwl->list);
1155}
1156
1157/* Return a pointer to the bind keyword <kw>, or NULL if not found. If the
1158 * keyword is found with a NULL ->parse() function, then an attempt is made to
1159 * find one with a valid ->parse() function. This way it is possible to declare
1160 * platform-dependant, known keywords as NULL, then only declare them as valid
1161 * if some options are met. Note that if the requested keyword contains an
1162 * opening parenthesis, everything from this point is ignored.
1163 */
1164struct bind_kw *bind_find_kw(const char *kw)
1165{
1166 int index;
1167 const char *kwend;
1168 struct bind_kw_list *kwl;
1169 struct bind_kw *ret = NULL;
1170
1171 kwend = strchr(kw, '(');
1172 if (!kwend)
1173 kwend = kw + strlen(kw);
1174
1175 list_for_each_entry(kwl, &bind_keywords.list, list) {
1176 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1177 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
1178 kwl->kw[index].kw[kwend-kw] == 0) {
1179 if (kwl->kw[index].parse)
1180 return &kwl->kw[index]; /* found it !*/
1181 else
1182 ret = &kwl->kw[index]; /* may be OK */
1183 }
1184 }
1185 }
1186 return ret;
1187}
1188
Willy Tarreau8638f482012-09-18 18:01:17 +02001189/* Dumps all registered "bind" keywords to the <out> string pointer. The
1190 * unsupported keywords are only dumped if their supported form was not
1191 * found.
1192 */
1193void bind_dump_kws(char **out)
1194{
1195 struct bind_kw_list *kwl;
1196 int index;
1197
Christopher Faulet784063e2020-05-18 12:14:18 +02001198 if (!out)
1199 return;
1200
Willy Tarreau8638f482012-09-18 18:01:17 +02001201 *out = NULL;
1202 list_for_each_entry(kwl, &bind_keywords.list, list) {
1203 for (index = 0; kwl->kw[index].kw != NULL; index++) {
1204 if (kwl->kw[index].parse ||
1205 bind_find_kw(kwl->kw[index].kw) == &kwl->kw[index]) {
Willy Tarreau51fb7652012-09-18 18:24:39 +02001206 memprintf(out, "%s[%4s] %s%s%s\n", *out ? *out : "",
1207 kwl->scope,
Willy Tarreau8638f482012-09-18 18:01:17 +02001208 kwl->kw[index].kw,
Willy Tarreau51fb7652012-09-18 18:24:39 +02001209 kwl->kw[index].skip ? " <arg>" : "",
1210 kwl->kw[index].parse ? "" : " (not supported)");
Willy Tarreau8638f482012-09-18 18:01:17 +02001211 }
1212 }
1213 }
1214}
1215
Willy Tarreau645513a2010-05-24 20:55:15 +02001216/************************************************************************/
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001217/* All supported sample and ACL keywords must be declared here. */
Willy Tarreau645513a2010-05-24 20:55:15 +02001218/************************************************************************/
1219
Willy Tarreaua5e37562011-12-16 17:06:15 +01001220/* set temp integer to the number of connexions to the same listening socket */
Willy Tarreau645513a2010-05-24 20:55:15 +02001221static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001222smp_fetch_dconn(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau645513a2010-05-24 20:55:15 +02001223{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001224 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001225 smp->data.u.sint = smp->sess->listener->nbconn;
Willy Tarreau645513a2010-05-24 20:55:15 +02001226 return 1;
1227}
1228
Willy Tarreaua5e37562011-12-16 17:06:15 +01001229/* set temp integer to the id of the socket (listener) */
Willy Tarreau645513a2010-05-24 20:55:15 +02001230static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +02001231smp_fetch_so_id(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau37406352012-04-23 16:16:37 +02001232{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +02001233 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +02001234 smp->data.u.sint = smp->sess->listener->luid;
Willy Tarreau645513a2010-05-24 20:55:15 +02001235 return 1;
1236}
Jerome Magnineb421b22020-03-27 22:08:40 +01001237static int
1238smp_fetch_so_name(const struct arg *args, struct sample *smp, const char *kw, void *private)
1239{
1240 smp->data.u.str.area = smp->sess->listener->name;
1241 if (!smp->data.u.str.area)
1242 return 0;
1243
1244 smp->data.type = SMP_T_STR;
1245 smp->flags = SMP_F_CONST;
1246 smp->data.u.str.data = strlen(smp->data.u.str.area);
1247 return 1;
1248}
Willy Tarreau645513a2010-05-24 20:55:15 +02001249
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001250/* parse the "accept-proxy" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001251static 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 +02001252{
1253 struct listener *l;
1254
Willy Tarreau4348fad2012-09-20 16:48:07 +02001255 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001256 l->options |= LI_O_ACC_PROXY;
1257
1258 return 0;
1259}
1260
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001261/* parse the "accept-netscaler-cip" bind keyword */
1262static int bind_parse_accept_netscaler_cip(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1263{
1264 struct listener *l;
1265 uint32_t val;
1266
1267 if (!*args[cur_arg + 1]) {
1268 memprintf(err, "'%s' : missing value", args[cur_arg]);
1269 return ERR_ALERT | ERR_FATAL;
1270 }
1271
1272 val = atol(args[cur_arg + 1]);
1273 if (val <= 0) {
Willy Tarreaue2711c72019-02-27 15:39:41 +01001274 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001275 return ERR_ALERT | ERR_FATAL;
1276 }
1277
1278 list_for_each_entry(l, &conf->listeners, by_bind) {
1279 l->options |= LI_O_ACC_CIP;
1280 conf->ns_cip_magic = val;
1281 }
1282
1283 return 0;
1284}
1285
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001286/* parse the "backlog" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001287static 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 +02001288{
1289 struct listener *l;
1290 int val;
1291
1292 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001293 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001294 return ERR_ALERT | ERR_FATAL;
1295 }
1296
1297 val = atol(args[cur_arg + 1]);
Willy Tarreaue2711c72019-02-27 15:39:41 +01001298 if (val < 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001299 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001300 return ERR_ALERT | ERR_FATAL;
1301 }
1302
Willy Tarreau4348fad2012-09-20 16:48:07 +02001303 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001304 l->backlog = val;
1305
1306 return 0;
1307}
1308
1309/* parse the "id" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001310static 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 +02001311{
1312 struct eb32_node *node;
Willy Tarreau4348fad2012-09-20 16:48:07 +02001313 struct listener *l, *new;
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001314 char *error;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001315
Willy Tarreau4348fad2012-09-20 16:48:07 +02001316 if (conf->listeners.n != conf->listeners.p) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001317 memprintf(err, "'%s' can only be used with a single socket", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001318 return ERR_ALERT | ERR_FATAL;
1319 }
1320
1321 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001322 memprintf(err, "'%s' : expects an integer argument", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001323 return ERR_ALERT | ERR_FATAL;
1324 }
1325
Willy Tarreau4348fad2012-09-20 16:48:07 +02001326 new = LIST_NEXT(&conf->listeners, struct listener *, by_bind);
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +01001327 new->luid = strtol(args[cur_arg + 1], &error, 10);
1328 if (*error != '\0') {
1329 memprintf(err, "'%s' : expects an integer argument, found '%s'", args[cur_arg], args[cur_arg + 1]);
1330 return ERR_ALERT | ERR_FATAL;
1331 }
Willy Tarreau4348fad2012-09-20 16:48:07 +02001332 new->conf.id.key = new->luid;
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001333
Willy Tarreau4348fad2012-09-20 16:48:07 +02001334 if (new->luid <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001335 memprintf(err, "'%s' : custom id has to be > 0", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001336 return ERR_ALERT | ERR_FATAL;
1337 }
1338
Willy Tarreau4348fad2012-09-20 16:48:07 +02001339 node = eb32_lookup(&px->conf.used_listener_id, new->luid);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001340 if (node) {
1341 l = container_of(node, struct listener, conf.id);
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001342 memprintf(err, "'%s' : custom id %d already used at %s:%d ('bind %s')",
1343 args[cur_arg], l->luid, l->bind_conf->file, l->bind_conf->line,
1344 l->bind_conf->arg);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001345 return ERR_ALERT | ERR_FATAL;
1346 }
1347
Willy Tarreau4348fad2012-09-20 16:48:07 +02001348 eb32_insert(&px->conf.used_listener_id, &new->conf.id);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001349 return 0;
1350}
1351
1352/* parse the "maxconn" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001353static 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 +02001354{
1355 struct listener *l;
1356 int val;
1357
1358 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001359 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001360 return ERR_ALERT | ERR_FATAL;
1361 }
1362
1363 val = atol(args[cur_arg + 1]);
Willy Tarreaua8cf66b2019-02-27 16:49:00 +01001364 if (val < 0) {
1365 memprintf(err, "'%s' : invalid value %d, must be >= 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001366 return ERR_ALERT | ERR_FATAL;
1367 }
1368
Willy Tarreau4348fad2012-09-20 16:48:07 +02001369 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001370 l->maxconn = val;
1371
1372 return 0;
1373}
1374
1375/* parse the "name" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001376static 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 +02001377{
1378 struct listener *l;
1379
1380 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001381 memprintf(err, "'%s' : missing name", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001382 return ERR_ALERT | ERR_FATAL;
1383 }
1384
Willy Tarreau4348fad2012-09-20 16:48:07 +02001385 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001386 l->name = strdup(args[cur_arg + 1]);
1387
1388 return 0;
1389}
1390
1391/* parse the "nice" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +02001392static 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 +02001393{
1394 struct listener *l;
1395 int val;
1396
1397 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001398 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001399 return ERR_ALERT | ERR_FATAL;
1400 }
1401
1402 val = atol(args[cur_arg + 1]);
1403 if (val < -1024 || val > 1024) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001404 memprintf(err, "'%s' : invalid value %d, allowed range is -1024..1024", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001405 return ERR_ALERT | ERR_FATAL;
1406 }
1407
Willy Tarreau4348fad2012-09-20 16:48:07 +02001408 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001409 l->nice = val;
1410
1411 return 0;
1412}
1413
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001414/* parse the "process" bind keyword */
1415static int bind_parse_process(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1416{
Christopher Fauletc644fa92017-11-23 22:44:11 +01001417 char *slash;
1418 unsigned long proc = 0, thread = 0;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001419
Christopher Fauletc644fa92017-11-23 22:44:11 +01001420 if ((slash = strchr(args[cur_arg + 1], '/')) != NULL)
1421 *slash = 0;
1422
Willy Tarreauff9c9142019-02-07 10:39:36 +01001423 if (parse_process_number(args[cur_arg + 1], &proc, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +01001424 memprintf(err, "'%s' : %s", args[cur_arg], *err);
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001425 return ERR_ALERT | ERR_FATAL;
1426 }
1427
Christopher Fauletc644fa92017-11-23 22:44:11 +01001428 if (slash) {
Willy Tarreauc9a82e42019-01-26 13:25:14 +01001429 if (parse_process_number(slash+1, &thread, MAX_THREADS, NULL, err)) {
Christopher Fauletc644fa92017-11-23 22:44:11 +01001430 memprintf(err, "'%s' : %s", args[cur_arg], *err);
1431 return ERR_ALERT | ERR_FATAL;
1432 }
1433 *slash = '/';
1434 }
1435
Willy Tarreaue26993c2020-09-03 07:18:55 +02001436 conf->settings.bind_proc |= proc;
1437 conf->settings.bind_thread |= thread;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001438 return 0;
1439}
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001440
Christopher Fauleta717b992018-04-10 14:43:00 +02001441/* parse the "proto" bind keyword */
1442static int bind_parse_proto(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1443{
1444 struct ist proto;
1445
1446 if (!*args[cur_arg + 1]) {
1447 memprintf(err, "'%s' : missing value", args[cur_arg]);
1448 return ERR_ALERT | ERR_FATAL;
1449 }
1450
1451 proto = ist2(args[cur_arg + 1], strlen(args[cur_arg + 1]));
1452 conf->mux_proto = get_mux_proto(proto);
1453 if (!conf->mux_proto) {
1454 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[cur_arg], args[cur_arg+1]);
1455 return ERR_ALERT | ERR_FATAL;
1456 }
Christopher Fauleta717b992018-04-10 14:43:00 +02001457 return 0;
1458}
1459
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001460/* config parser for global "tune.listener.multi-queue", accepts "on" or "off" */
1461static int cfg_parse_tune_listener_mq(char **args, int section_type, struct proxy *curpx,
1462 struct proxy *defpx, const char *file, int line,
1463 char **err)
1464{
1465 if (too_many_args(1, args, err, NULL))
1466 return -1;
1467
1468 if (strcmp(args[1], "on") == 0)
1469 global.tune.options |= GTUNE_LISTENER_MQ;
1470 else if (strcmp(args[1], "off") == 0)
1471 global.tune.options &= ~GTUNE_LISTENER_MQ;
1472 else {
1473 memprintf(err, "'%s' expects either 'on' or 'off' but got '%s'.", args[0], args[1]);
1474 return -1;
1475 }
1476 return 0;
1477}
1478
Willy Tarreau61612d42012-04-19 18:42:05 +02001479/* Note: must not be declared <const> as its list will be overwritten.
1480 * Please take care of keeping this list alphabetically sorted.
1481 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001482static struct sample_fetch_kw_list smp_kws = {ILH, {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02001483 { "dst_conn", smp_fetch_dconn, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
1484 { "so_id", smp_fetch_so_id, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
Jerome Magnineb421b22020-03-27 22:08:40 +01001485 { "so_name", smp_fetch_so_name, 0, NULL, SMP_T_STR, SMP_USE_FTEND, },
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001486 { /* END */ },
1487}};
1488
Willy Tarreau0108d902018-11-25 19:14:37 +01001489INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
1490
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001491/* Note: must not be declared <const> as its list will be overwritten.
1492 * Please take care of keeping this list alphabetically sorted.
1493 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001494static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001495 { /* END */ },
Willy Tarreau645513a2010-05-24 20:55:15 +02001496}};
1497
Willy Tarreau0108d902018-11-25 19:14:37 +01001498INITCALL1(STG_REGISTER, acl_register_keywords, &acl_kws);
1499
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001500/* Note: must not be declared <const> as its list will be overwritten.
1501 * Please take care of keeping this list alphabetically sorted, doing so helps
1502 * all code contributors.
1503 * Optional keywords are also declared with a NULL ->parse() function so that
1504 * the config parser can report an appropriate error when a known keyword was
1505 * not enabled.
1506 */
Willy Tarreau51fb7652012-09-18 18:24:39 +02001507static struct bind_kw_list bind_kws = { "ALL", { }, {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001508 { "accept-netscaler-cip", bind_parse_accept_netscaler_cip, 1 }, /* enable NetScaler Client IP insertion protocol */
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001509 { "accept-proxy", bind_parse_accept_proxy, 0 }, /* enable PROXY protocol */
1510 { "backlog", bind_parse_backlog, 1 }, /* set backlog of listening socket */
1511 { "id", bind_parse_id, 1 }, /* set id of listening socket */
1512 { "maxconn", bind_parse_maxconn, 1 }, /* set maxconn of listening socket */
1513 { "name", bind_parse_name, 1 }, /* set name of listening socket */
1514 { "nice", bind_parse_nice, 1 }, /* set nice of listening socket */
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001515 { "process", bind_parse_process, 1 }, /* set list of allowed process for this socket */
Christopher Fauleta717b992018-04-10 14:43:00 +02001516 { "proto", bind_parse_proto, 1 }, /* set the proto to use for all incoming connections */
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001517 { /* END */ },
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001518}};
1519
Willy Tarreau0108d902018-11-25 19:14:37 +01001520INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
1521
Willy Tarreau7ac908b2019-02-27 12:02:18 +01001522/* config keyword parsers */
1523static struct cfg_kw_list cfg_kws = {ILH, {
1524 { CFG_GLOBAL, "tune.listener.multi-queue", cfg_parse_tune_listener_mq },
1525 { 0, NULL, NULL }
1526}};
1527
1528INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
1529
Willy Tarreau645513a2010-05-24 20:55:15 +02001530/*
1531 * Local variables:
1532 * c-indent-level: 8
1533 * c-basic-offset: 8
1534 * End:
1535 */