blob: fb230692772a3f75e6a0534a7a315a0d9a94cf25 [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 Tarreau1bc4aab2012-10-08 20:11:03 +020021#include <common/accept4.h>
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +010022#include <common/cfgparse.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020023#include <common/config.h>
Willy Tarreaudabf2e22007-10-28 21:59:24 +010024#include <common/errors.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020025#include <common/mini-clist.h>
26#include <common/standard.h>
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020027#include <common/time.h>
28
29#include <types/global.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020030#include <types/protocol.h>
Willy Tarreaudd815982007-10-16 12:25:14 +020031
Willy Tarreau645513a2010-05-24 20:55:15 +020032#include <proto/acl.h>
Christopher Fauleta717b992018-04-10 14:43:00 +020033#include <proto/connection.h>
Willy Tarreaub648d632007-10-28 22:13:50 +010034#include <proto/fd.h>
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020035#include <proto/freq_ctr.h>
36#include <proto/log.h>
Willy Tarreau7a798e52016-04-14 11:13:20 +020037#include <proto/listener.h>
Willy Tarreau0de59fd2017-09-15 08:10:44 +020038#include <proto/protocol.h>
William Lallemand2fe7dd02018-09-11 16:51:29 +020039#include <proto/proto_sockpair.h>
Willy Tarreau0ccb7442013-01-07 22:54:17 +010040#include <proto/sample.h>
Willy Tarreaufb0afa72015-04-03 14:46:27 +020041#include <proto/stream.h>
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020042#include <proto/task.h>
Willy Tarreaub648d632007-10-28 22:13:50 +010043
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +020044 /* listner_queue lock (same for global and per proxy queues) */
Christopher Faulet9dcf9b62017-11-13 10:34:01 +010045__decl_hathreads(static HA_SPINLOCK_T lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +020046
Willy Tarreau26982662012-09-12 23:17:10 +020047/* List head of all known bind keywords */
48static struct bind_kw_list bind_keywords = {
49 .list = LIST_HEAD_INIT(bind_keywords.list)
50};
51
William Lallemande22f11f2018-09-11 10:06:27 +020052extern int master;
53
Olivier Houchardf73629d2017-04-05 22:33:04 +020054struct xfer_sock_list *xfer_sock_list = NULL;
55
Willy Tarreaudabf2e22007-10-28 21:59:24 +010056/* This function adds the specified listener's file descriptor to the polling
57 * lists if it is in the LI_LISTEN state. The listener enters LI_READY or
Willy Tarreauae302532014-05-07 19:22:24 +020058 * LI_FULL state depending on its number of connections. In deamon mode, we
59 * also support binding only the relevant processes to their respective
60 * listeners. We don't do that in debug mode however.
Willy Tarreaudabf2e22007-10-28 21:59:24 +010061 */
Christopher Fauletf5b8adc2017-06-02 10:00:35 +020062static void enable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +010063{
Christopher Faulet2a944ee2017-11-07 10:42:54 +010064 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010065 if (listener->state == LI_LISTEN) {
William Lallemand095ba4c2017-06-01 17:38:50 +020066 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreauae302532014-05-07 19:22:24 +020067 listener->bind_conf->bind_proc &&
Willy Tarreau387bd4f2017-11-10 19:08:14 +010068 !(listener->bind_conf->bind_proc & pid_bit)) {
Willy Tarreauae302532014-05-07 19:22:24 +020069 /* we don't want to enable this listener and don't
70 * want any fd event to reach it.
71 */
Olivier Houchard1fc05162017-04-06 01:05:05 +020072 if (!(global.tune.options & GTUNE_SOCKET_TRANSFER))
Christopher Faulet510c0d62018-03-16 10:04:47 +010073 do_unbind_listener(listener, 1);
Olivier Houchard1fc05162017-04-06 01:05:05 +020074 else {
Christopher Faulet510c0d62018-03-16 10:04:47 +010075 do_unbind_listener(listener, 0);
Olivier Houchard1fc05162017-04-06 01:05:05 +020076 listener->state = LI_LISTEN;
77 }
Willy Tarreauae302532014-05-07 19:22:24 +020078 }
79 else if (listener->nbconn < listener->maxconn) {
Willy Tarreau49b046d2012-08-09 12:11:58 +020080 fd_want_recv(listener->fd);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010081 listener->state = LI_READY;
Willy Tarreauae302532014-05-07 19:22:24 +020082 }
83 else {
Willy Tarreaudabf2e22007-10-28 21:59:24 +010084 listener->state = LI_FULL;
85 }
86 }
William Lallemande22f11f2018-09-11 10:06:27 +020087 /* if this listener is supposed to be only in the master, close it in the workers */
88 if ((global.mode & MODE_MWORKER) &&
89 (listener->options & LI_O_MWORKER) &&
90 master == 0) {
91 do_unbind_listener(listener, 1);
92 }
Christopher Faulet2a944ee2017-11-07 10:42:54 +010093 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010094}
95
96/* This function removes the specified listener's file descriptor from the
97 * polling lists if it is in the LI_READY or in the LI_FULL state. The listener
98 * enters LI_LISTEN.
99 */
Christopher Fauletf5b8adc2017-06-02 10:00:35 +0200100static void disable_listener(struct listener *listener)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100101{
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100102 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100103 if (listener->state < LI_READY)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200104 goto end;
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100105 if (listener->state == LI_READY)
Willy Tarreau49b046d2012-08-09 12:11:58 +0200106 fd_stop_recv(listener->fd);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200107 if (listener->state == LI_LIMITED) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100108 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200109 LIST_DEL(&listener->wait_queue);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100110 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200111 }
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100112 listener->state = LI_LISTEN;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200113 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100114 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100115}
116
Willy Tarreaube58c382011-07-24 18:28:10 +0200117/* This function tries to temporarily disable a listener, depending on the OS
118 * capabilities. Linux unbinds the listen socket after a SHUT_RD, and ignores
119 * SHUT_WR. Solaris refuses either shutdown(). OpenBSD ignores SHUT_RD but
120 * closes upon SHUT_WR and refuses to rebind. So a common validation path
121 * involves SHUT_WR && listen && SHUT_RD. In case of success, the FD's polling
122 * is disabled. It normally returns non-zero, unless an error is reported.
123 */
124int pause_listener(struct listener *l)
125{
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200126 int ret = 1;
127
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100128 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200129
Olivier Houchard1fc05162017-04-06 01:05:05 +0200130 if (l->state <= LI_ZOMBIE)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200131 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200132
Willy Tarreau092d8652014-07-07 20:22:12 +0200133 if (l->proto->pause) {
134 /* Returns < 0 in case of failure, 0 if the listener
135 * was totally stopped, or > 0 if correctly paused.
136 */
137 int ret = l->proto->pause(l);
Willy Tarreaube58c382011-07-24 18:28:10 +0200138
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200139 if (ret < 0) {
140 ret = 0;
141 goto end;
142 }
Willy Tarreau092d8652014-07-07 20:22:12 +0200143 else if (ret == 0)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200144 goto end;
Willy Tarreaub3fb60b2012-10-04 08:56:31 +0200145 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200146
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200147 if (l->state == LI_LIMITED) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100148 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200149 LIST_DEL(&l->wait_queue);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100150 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200151 }
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200152
Willy Tarreau49b046d2012-08-09 12:11:58 +0200153 fd_stop_recv(l->fd);
Willy Tarreaube58c382011-07-24 18:28:10 +0200154 l->state = LI_PAUSED;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200155 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100156 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200157 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200158}
159
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200160/* This function tries to resume a temporarily disabled listener. Paused, full,
161 * limited and disabled listeners are handled, which means that this function
162 * may replace enable_listener(). The resulting state will either be LI_READY
163 * or LI_FULL. 0 is returned in case of failure to resume (eg: dead socket).
Willy Tarreauae302532014-05-07 19:22:24 +0200164 * Listeners bound to a different process are not woken up unless we're in
Willy Tarreauaf2fd582015-04-14 12:07:16 +0200165 * foreground mode, and are ignored. If the listener was only in the assigned
166 * state, it's totally rebound. This can happen if a pause() has completely
167 * stopped it. If the resume fails, 0 is returned and an error might be
168 * displayed.
Willy Tarreaube58c382011-07-24 18:28:10 +0200169 */
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200170static int __resume_listener(struct listener *l)
Willy Tarreaube58c382011-07-24 18:28:10 +0200171{
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200172 int ret = 1;
173
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100174 HA_SPIN_LOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200175
William Lallemand095ba4c2017-06-01 17:38:50 +0200176 if ((global.mode & (MODE_DAEMON | MODE_MWORKER)) &&
Willy Tarreau3569df32017-03-15 12:47:46 +0100177 l->bind_conf->bind_proc &&
Willy Tarreau387bd4f2017-11-10 19:08:14 +0100178 !(l->bind_conf->bind_proc & pid_bit))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200179 goto end;
Willy Tarreau3569df32017-03-15 12:47:46 +0100180
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200181 if (l->state == LI_ASSIGNED) {
182 char msg[100];
183 int err;
184
185 err = l->proto->bind(l, msg, sizeof(msg));
186 if (err & ERR_ALERT)
Christopher Faulet767a84b2017-11-24 16:50:31 +0100187 ha_alert("Resuming listener: %s\n", msg);
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200188 else if (err & ERR_WARN)
Christopher Faulet767a84b2017-11-24 16:50:31 +0100189 ha_warning("Resuming listener: %s\n", msg);
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200190
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200191 if (err & (ERR_FATAL | ERR_ABORT)) {
192 ret = 0;
193 goto end;
194 }
Willy Tarreau1c4b8142014-07-07 21:06:24 +0200195 }
196
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200197 if (l->state < LI_PAUSED || l->state == LI_ZOMBIE) {
198 ret = 0;
199 goto end;
200 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200201
Willy Tarreaub3fb60b2012-10-04 08:56:31 +0200202 if (l->proto->sock_prot == IPPROTO_TCP &&
203 l->state == LI_PAUSED &&
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200204 listen(l->fd, l->backlog ? l->backlog : l->maxconn) != 0) {
205 ret = 0;
206 goto end;
207 }
Willy Tarreaube58c382011-07-24 18:28:10 +0200208
209 if (l->state == LI_READY)
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200210 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200211
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200212 if (l->state == LI_LIMITED)
213 LIST_DEL(&l->wait_queue);
214
Willy Tarreaube58c382011-07-24 18:28:10 +0200215 if (l->nbconn >= l->maxconn) {
216 l->state = LI_FULL;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200217 goto end;
Willy Tarreaube58c382011-07-24 18:28:10 +0200218 }
219
Willy Tarreau49b046d2012-08-09 12:11:58 +0200220 fd_want_recv(l->fd);
Willy Tarreaube58c382011-07-24 18:28:10 +0200221 l->state = LI_READY;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200222 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100223 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200224 return ret;
225}
226
227int resume_listener(struct listener *l)
228{
229 int ret;
230
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100231 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200232 ret = __resume_listener(l);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100233 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200234 return ret;
Willy Tarreaube58c382011-07-24 18:28:10 +0200235}
236
Willy Tarreau87b09662015-04-03 00:22:06 +0200237/* Marks a ready listener as full so that the stream code tries to re-enable
Willy Tarreau62793712011-07-24 19:23:38 +0200238 * it upon next close() using resume_listener().
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200239 *
240 * Note: this function is only called from listener_accept so <l> is already
241 * locked.
Willy Tarreau62793712011-07-24 19:23:38 +0200242 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200243static void listener_full(struct listener *l)
Willy Tarreau62793712011-07-24 19:23:38 +0200244{
245 if (l->state >= LI_READY) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200246 if (l->state == LI_LIMITED) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100247 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200248 LIST_DEL(&l->wait_queue);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100249 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200250 }
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200251
Willy Tarreau49b046d2012-08-09 12:11:58 +0200252 fd_stop_recv(l->fd);
Willy Tarreau62793712011-07-24 19:23:38 +0200253 l->state = LI_FULL;
254 }
255}
256
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200257/* Marks a ready listener as limited so that we only try to re-enable it when
258 * resources are free again. It will be queued into the specified queue.
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200259 *
260 * Note: this function is only called from listener_accept so <l> is already
261 * locked.
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200262 */
Christopher Faulet5580ba22017-08-28 15:29:20 +0200263static void limit_listener(struct listener *l, struct list *list)
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200264{
265 if (l->state == LI_READY) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100266 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200267 LIST_ADDQ(list, &l->wait_queue);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100268 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreau49b046d2012-08-09 12:11:58 +0200269 fd_stop_recv(l->fd);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200270 l->state = LI_LIMITED;
271 }
272}
273
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100274/* This function adds all of the protocol's listener's file descriptors to the
275 * polling lists when they are in the LI_LISTEN state. It is intended to be
276 * used as a protocol's generic enable_all() primitive, for use after the
277 * fork(). It puts the listeners into LI_READY or LI_FULL states depending on
278 * their number of connections. It always returns ERR_NONE.
279 */
280int enable_all_listeners(struct protocol *proto)
281{
282 struct listener *listener;
283
284 list_for_each_entry(listener, &proto->listeners, proto_list)
285 enable_listener(listener);
286 return ERR_NONE;
287}
288
289/* This function removes all of the protocol's listener's file descriptors from
290 * the polling lists when they are in the LI_READY or LI_FULL states. It is
291 * intended to be used as a protocol's generic disable_all() primitive. It puts
292 * the listeners into LI_LISTEN, and always returns ERR_NONE.
293 */
294int disable_all_listeners(struct protocol *proto)
295{
296 struct listener *listener;
297
298 list_for_each_entry(listener, &proto->listeners, proto_list)
299 disable_listener(listener);
300 return ERR_NONE;
301}
302
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200303/* Dequeues all of the listeners waiting for a resource in wait queue <queue>. */
304void dequeue_all_listeners(struct list *list)
305{
306 struct listener *listener, *l_back;
307
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100308 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200309 list_for_each_entry_safe(listener, l_back, list, wait_queue) {
310 /* This cannot fail because the listeners are by definition in
311 * the LI_LIMITED state. The function also removes the entry
312 * from the queue.
313 */
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200314 __resume_listener(listener);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200315 }
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100316 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200317}
318
Christopher Faulet510c0d62018-03-16 10:04:47 +0100319/* Must be called with the lock held. Depending on <do_close> value, it does
320 * what unbind_listener or unbind_listener_no_close should do.
321 */
322void do_unbind_listener(struct listener *listener, int do_close)
Willy Tarreaub648d632007-10-28 22:13:50 +0100323{
324 if (listener->state == LI_READY)
Willy Tarreau49b046d2012-08-09 12:11:58 +0200325 fd_stop_recv(listener->fd);
Willy Tarreaub648d632007-10-28 22:13:50 +0100326
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200327 if (listener->state == LI_LIMITED) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100328 HA_SPIN_LOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200329 LIST_DEL(&listener->wait_queue);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100330 HA_SPIN_UNLOCK(LISTENER_QUEUE_LOCK, &lq_lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200331 }
Willy Tarreaue6ca1fc2011-07-24 22:03:52 +0200332
Willy Tarreaube58c382011-07-24 18:28:10 +0200333 if (listener->state >= LI_PAUSED) {
Olivier Houchard1fc05162017-04-06 01:05:05 +0200334 if (do_close) {
335 fd_delete(listener->fd);
336 listener->fd = -1;
337 }
338 else
339 fd_remove(listener->fd);
Willy Tarreaub648d632007-10-28 22:13:50 +0100340 listener->state = LI_ASSIGNED;
341 }
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100342}
343
Olivier Houchard1fc05162017-04-06 01:05:05 +0200344/* This function closes the listening socket for the specified listener,
345 * provided that it's already in a listening state. The listener enters the
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100346 * LI_ASSIGNED state. This function is intended to be used as a generic
347 * function for standard protocols.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200348 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100349void unbind_listener(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200350{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100351 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100352 do_unbind_listener(listener, 1);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100353 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200354}
355
356/* This function pretends the listener is dead, but keeps the FD opened, so
357 * that we can provide it, for conf reloading.
358 */
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100359void unbind_listener_no_close(struct listener *listener)
Olivier Houchard1fc05162017-04-06 01:05:05 +0200360{
Christopher Faulet510c0d62018-03-16 10:04:47 +0100361 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreaubbd09b92017-11-05 11:38:44 +0100362 do_unbind_listener(listener, 0);
Christopher Faulet510c0d62018-03-16 10:04:47 +0100363 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Olivier Houchard1fc05162017-04-06 01:05:05 +0200364}
365
Willy Tarreau3acf8c32007-10-28 22:35:41 +0100366/* This function closes all listening sockets bound to the protocol <proto>,
367 * and the listeners end in LI_ASSIGNED state if they were higher. It does not
368 * detach them from the protocol. It always returns ERR_NONE.
369 */
370int unbind_all_listeners(struct protocol *proto)
371{
372 struct listener *listener;
373
374 list_for_each_entry(listener, &proto->listeners, proto_list)
375 unbind_listener(listener);
376 return ERR_NONE;
377}
378
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200379/* creates one or multiple listeners for bind_conf <bc> on sockaddr <ss> on port
380 * range <portl> to <porth>, and possibly attached to fd <fd> (or -1 for auto
381 * allocation). The address family is taken from ss->ss_family. The number of
382 * jobs and listeners is automatically increased by the number of listeners
William Lallemand75ea0a02017-11-15 19:02:58 +0100383 * created. If the <inherited> argument is set to 1, it specifies that the FD
384 * was obtained from a parent process.
385 * It returns non-zero on success, zero on error with the error message
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200386 * set in <err>.
387 */
388int create_listeners(struct bind_conf *bc, const struct sockaddr_storage *ss,
William Lallemand75ea0a02017-11-15 19:02:58 +0100389 int portl, int porth, int fd, int inherited, char **err)
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200390{
391 struct protocol *proto = protocol_by_family(ss->ss_family);
392 struct listener *l;
393 int port;
394
395 if (!proto) {
396 memprintf(err, "unsupported protocol family %d", ss->ss_family);
397 return 0;
398 }
399
400 for (port = portl; port <= porth; port++) {
401 l = calloc(1, sizeof(*l));
402 if (!l) {
403 memprintf(err, "out of memory");
404 return 0;
405 }
406 l->obj_type = OBJ_TYPE_LISTENER;
407 LIST_ADDQ(&bc->frontend->conf.listeners, &l->by_fe);
408 LIST_ADDQ(&bc->listeners, &l->by_bind);
409 l->bind_conf = bc;
410
411 l->fd = fd;
412 memcpy(&l->addr, ss, sizeof(*ss));
413 l->state = LI_INIT;
414
415 proto->add(l, port);
416
William Lallemand75ea0a02017-11-15 19:02:58 +0100417 if (inherited)
418 l->options |= LI_O_INHERITED;
419
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100420 HA_SPIN_INIT(&l->lock);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200421 HA_ATOMIC_ADD(&jobs, 1);
422 HA_ATOMIC_ADD(&listeners, 1);
Willy Tarreau0de59fd2017-09-15 08:10:44 +0200423 }
424 return 1;
425}
426
Willy Tarreau1a64d162007-10-28 22:26:05 +0100427/* Delete a listener from its protocol's list of listeners. The listener's
428 * state is automatically updated from LI_ASSIGNED to LI_INIT. The protocol's
Willy Tarreau2cc5bae2017-09-15 08:18:11 +0200429 * number of listeners is updated, as well as the global number of listeners
430 * and jobs. Note that the listener must have previously been unbound. This
431 * is the generic function to use to remove a listener.
Willy Tarreau1a64d162007-10-28 22:26:05 +0100432 */
433void delete_listener(struct listener *listener)
434{
435 if (listener->state != LI_ASSIGNED)
436 return;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200437
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100438 HA_SPIN_LOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100439 listener->state = LI_INIT;
440 LIST_DEL(&listener->proto_list);
441 listener->proto->nb_listeners--;
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200442 HA_ATOMIC_SUB(&jobs, 1);
443 HA_ATOMIC_SUB(&listeners, 1);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100444 HA_SPIN_UNLOCK(LISTENER_LOCK, &listener->lock);
Willy Tarreau1a64d162007-10-28 22:26:05 +0100445}
446
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200447/* This function is called on a read event from a listening socket, corresponding
448 * to an accept. It tries to accept as many connections as possible, and for each
449 * calls the listener's accept handler (generally the frontend's accept handler).
450 */
Willy Tarreauafad0e02012-08-09 14:45:22 +0200451void listener_accept(int fd)
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200452{
453 struct listener *l = fdtab[fd].owner;
Willy Tarreauc95bad52016-12-22 00:13:31 +0100454 struct proxy *p = l->bind_conf->frontend;
Willy Tarreau50de90a2012-11-23 20:11:45 +0100455 int max_accept = l->maxaccept ? l->maxaccept : 1;
Willy Tarreaubb660302014-05-07 19:47:02 +0200456 int expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200457 int cfd;
458 int ret;
Willy Tarreau818dca52014-01-31 19:40:19 +0100459#ifdef USE_ACCEPT4
460 static int accept4_broken;
461#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200462
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100463 if (HA_SPIN_TRYLOCK(LISTENER_LOCK, &l->lock))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200464 return;
465
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200466 if (unlikely(l->nbconn >= l->maxconn)) {
467 listener_full(l);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200468 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200469 }
470
Willy Tarreau93e7c002013-10-07 18:51:07 +0200471 if (!(l->options & LI_O_UNLIMITED) && global.sps_lim) {
472 int max = freq_ctr_remain(&global.sess_per_sec, global.sps_lim, 0);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200473
474 if (unlikely(!max)) {
475 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200476 expire = tick_add(now_ms, next_event_delay(&global.sess_per_sec, global.sps_lim, 0));
Willy Tarreaubb660302014-05-07 19:47:02 +0200477 goto wait_expire;
Willy Tarreau93e7c002013-10-07 18:51:07 +0200478 }
479
480 if (max_accept > max)
481 max_accept = max;
482 }
483
484 if (!(l->options & LI_O_UNLIMITED) && global.cps_lim) {
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200485 int max = freq_ctr_remain(&global.conn_per_sec, global.cps_lim, 0);
486
487 if (unlikely(!max)) {
488 /* frontend accept rate limit was reached */
Willy Tarreau93e7c002013-10-07 18:51:07 +0200489 expire = tick_add(now_ms, next_event_delay(&global.conn_per_sec, global.cps_lim, 0));
Willy Tarreaubb660302014-05-07 19:47:02 +0200490 goto wait_expire;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200491 }
492
493 if (max_accept > max)
494 max_accept = max;
495 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200496#ifdef USE_OPENSSL
497 if (!(l->options & LI_O_UNLIMITED) && global.ssl_lim && l->bind_conf && l->bind_conf->is_ssl) {
498 int max = freq_ctr_remain(&global.ssl_per_sec, global.ssl_lim, 0);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200499
Willy Tarreaue43d5322013-10-07 20:01:52 +0200500 if (unlikely(!max)) {
501 /* frontend accept rate limit was reached */
Willy Tarreaue43d5322013-10-07 20:01:52 +0200502 expire = tick_add(now_ms, next_event_delay(&global.ssl_per_sec, global.ssl_lim, 0));
Willy Tarreaubb660302014-05-07 19:47:02 +0200503 goto wait_expire;
Willy Tarreaue43d5322013-10-07 20:01:52 +0200504 }
505
506 if (max_accept > max)
507 max_accept = max;
508 }
509#endif
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200510 if (p && p->fe_sps_lim) {
511 int max = freq_ctr_remain(&p->fe_sess_per_sec, p->fe_sps_lim, 0);
512
513 if (unlikely(!max)) {
514 /* frontend accept rate limit was reached */
515 limit_listener(l, &p->listener_queue);
516 task_schedule(p->task, tick_add(now_ms, next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0)));
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200517 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200518 }
519
520 if (max_accept > max)
521 max_accept = max;
522 }
523
524 /* Note: if we fail to allocate a connection because of configured
525 * limits, we'll schedule a new attempt worst 1 second later in the
526 * worst case. If we fail due to system limits or temporary resource
527 * shortage, we try again 100ms later in the worst case.
528 */
529 while (max_accept--) {
530 struct sockaddr_storage addr;
531 socklen_t laddr = sizeof(addr);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200532 unsigned int count;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200533
534 if (unlikely(actconn >= global.maxconn) && !(l->options & LI_O_UNLIMITED)) {
535 limit_listener(l, &global_listener_queue);
536 task_schedule(global_listener_queue_task, tick_add(now_ms, 1000)); /* try again in 1 second */
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200537 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200538 }
539
540 if (unlikely(p && p->feconn >= p->maxconn)) {
541 limit_listener(l, &p->listener_queue);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200542 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200543 }
544
William Lallemand2fe7dd02018-09-11 16:51:29 +0200545 /* with sockpair@ we don't want to do an accept */
546 if (unlikely(l->addr.ss_family == AF_CUST_SOCKPAIR)) {
547 if ((cfd = recv_fd_uxst(fd)) != -1)
548 fcntl(cfd, F_SETFL, O_NONBLOCK);
549 } else
550
Willy Tarreau1bc4aab2012-10-08 20:11:03 +0200551#ifdef USE_ACCEPT4
Willy Tarreau818dca52014-01-31 19:40:19 +0100552 /* only call accept4() if it's known to be safe, otherwise
553 * fallback to the legacy accept() + fcntl().
554 */
555 if (unlikely(accept4_broken ||
556 ((cfd = accept4(fd, (struct sockaddr *)&addr, &laddr, SOCK_NONBLOCK)) == -1 &&
557 (errno == ENOSYS || errno == EINVAL || errno == EBADF) &&
558 (accept4_broken = 1))))
559#endif
Willy Tarreau6b3b0d42012-10-22 19:32:55 +0200560 if ((cfd = accept(fd, (struct sockaddr *)&addr, &laddr)) != -1)
561 fcntl(cfd, F_SETFL, O_NONBLOCK);
Willy Tarreau818dca52014-01-31 19:40:19 +0100562
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200563 if (unlikely(cfd == -1)) {
564 switch (errno) {
565 case EAGAIN:
Willy Tarreaubb660302014-05-07 19:47:02 +0200566 if (fdtab[fd].ev & FD_POLL_HUP) {
567 /* the listening socket might have been disabled in a shared
568 * process and we're a collateral victim. We'll just pause for
569 * a while in case it comes back. In the mean time, we need to
570 * clear this sticky flag.
571 */
572 fdtab[fd].ev &= ~FD_POLL_HUP;
573 goto transient_error;
574 }
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100575 fd_cant_recv(fd);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200576 goto end; /* nothing more to accept */
Willy Tarreaubb660302014-05-07 19:47:02 +0200577 case EINVAL:
578 /* might be trying to accept on a shut fd (eg: soft stop) */
579 goto transient_error;
Willy Tarreaua593ec52014-01-20 21:21:30 +0100580 case EINTR:
581 case ECONNABORTED:
582 continue;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200583 case ENFILE:
584 if (p)
585 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100586 "Proxy %s reached system FD limit (maxsock=%d). Please check system tunables.\n",
587 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200588 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200589 case EMFILE:
590 if (p)
591 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100592 "Proxy %s reached process FD limit (maxsock=%d). Please check 'ulimit-n' and restart.\n",
593 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200594 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200595 case ENOBUFS:
596 case ENOMEM:
597 if (p)
598 send_log(p, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100599 "Proxy %s reached system memory limit (maxsock=%d). Please check system tunables.\n",
600 p->id, global.maxsock);
Willy Tarreaubb660302014-05-07 19:47:02 +0200601 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200602 default:
Willy Tarreaua593ec52014-01-20 21:21:30 +0100603 /* unexpected result, let's give up and let other tasks run */
Willy Tarreau6c11bd22014-01-24 00:54:27 +0100604 goto stop;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200605 }
606 }
607
608 if (unlikely(cfd >= global.maxsock)) {
609 send_log(p, LOG_EMERG,
610 "Proxy %s reached the configured maximum connection limit. Please check the global 'maxconn' value.\n",
611 p->id);
612 close(cfd);
613 limit_listener(l, &global_listener_queue);
614 task_schedule(global_listener_queue_task, tick_add(now_ms, 1000)); /* try again in 1 second */
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200615 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200616 }
617
618 /* increase the per-process number of cumulated connections */
619 if (!(l->options & LI_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200620 count = update_freq_ctr(&global.conn_per_sec, 1);
621 HA_ATOMIC_UPDATE_MAX(&global.cps_max, count);
622 HA_ATOMIC_ADD(&actconn, 1);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200623 }
624
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200625 count = HA_ATOMIC_ADD(&l->nbconn, 1);
626 if (l->counters)
627 HA_ATOMIC_UPDATE_MAX(&l->counters->conn_max, count);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200628
629 ret = l->accept(l, cfd, &addr);
630 if (unlikely(ret <= 0)) {
Willy Tarreau87b09662015-04-03 00:22:06 +0200631 /* The connection was closed by stream_accept(). Either
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200632 * we just have to ignore it (ret == 0) or it's a critical
633 * error due to a resource shortage, and we must stop the
634 * listener (ret < 0).
635 */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200636 if (ret == 0) /* successful termination */
637 continue;
638
Willy Tarreaubb660302014-05-07 19:47:02 +0200639 goto transient_error;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200640 }
641
642 if (l->nbconn >= l->maxconn) {
643 listener_full(l);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200644 goto end;
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200645 }
646
Willy Tarreau93e7c002013-10-07 18:51:07 +0200647 /* increase the per-process number of cumulated connections */
648 if (!(l->options & LI_O_UNLIMITED)) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200649 count = update_freq_ctr(&global.sess_per_sec, 1);
650 HA_ATOMIC_UPDATE_MAX(&global.sps_max, count);
Willy Tarreau93e7c002013-10-07 18:51:07 +0200651 }
Willy Tarreaue43d5322013-10-07 20:01:52 +0200652#ifdef USE_OPENSSL
653 if (!(l->options & LI_O_UNLIMITED) && l->bind_conf && l->bind_conf->is_ssl) {
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200654 count = update_freq_ctr(&global.ssl_per_sec, 1);
655 HA_ATOMIC_UPDATE_MAX(&global.ssl_max, count);
Willy Tarreaue43d5322013-10-07 20:01:52 +0200656 }
657#endif
Willy Tarreau93e7c002013-10-07 18:51:07 +0200658
Willy Tarreauaece46a2012-07-06 12:25:58 +0200659 } /* end of while (max_accept--) */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200660
Willy Tarreauaece46a2012-07-06 12:25:58 +0200661 /* we've exhausted max_accept, so there is no need to poll again */
Willy Tarreau6c11bd22014-01-24 00:54:27 +0100662 stop:
663 fd_done_recv(fd);
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200664 goto end;
Willy Tarreaubb660302014-05-07 19:47:02 +0200665
666 transient_error:
667 /* pause the listener and try again in 100 ms */
668 expire = tick_add(now_ms, 100);
669
670 wait_expire:
671 limit_listener(l, &global_listener_queue);
672 task_schedule(global_listener_queue_task, tick_first(expire, global_listener_queue_task->expire));
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200673 end:
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100674 HA_SPIN_UNLOCK(LISTENER_LOCK, &l->lock);
Willy Tarreaubbebbbf2012-05-07 21:22:09 +0200675}
676
Willy Tarreau05f50472017-09-15 09:19:58 +0200677/* Notify the listener that a connection initiated from it was released. This
678 * is used to keep the connection count consistent and to possibly re-open
679 * listening when it was limited.
680 */
681void listener_release(struct listener *l)
682{
683 struct proxy *fe = l->bind_conf->frontend;
684
685 if (!(l->options & LI_O_UNLIMITED))
Christopher Faulet8d8aa0d2017-05-30 15:36:50 +0200686 HA_ATOMIC_SUB(&actconn, 1);
687 HA_ATOMIC_SUB(&l->nbconn, 1);
Willy Tarreau05f50472017-09-15 09:19:58 +0200688 if (l->state == LI_FULL)
689 resume_listener(l);
690
691 /* Dequeues all of the listeners waiting for a resource */
692 if (!LIST_ISEMPTY(&global_listener_queue))
693 dequeue_all_listeners(&global_listener_queue);
694
695 if (!LIST_ISEMPTY(&fe->listener_queue) &&
696 (!fe->fe_sps_lim || freq_ctr_remain(&fe->fe_sess_per_sec, fe->fe_sps_lim, 0) > 0))
697 dequeue_all_listeners(&fe->listener_queue);
698}
699
Willy Tarreau26982662012-09-12 23:17:10 +0200700/*
701 * Registers the bind keyword list <kwl> as a list of valid keywords for next
702 * parsing sessions.
703 */
704void bind_register_keywords(struct bind_kw_list *kwl)
705{
706 LIST_ADDQ(&bind_keywords.list, &kwl->list);
707}
708
709/* Return a pointer to the bind keyword <kw>, or NULL if not found. If the
710 * keyword is found with a NULL ->parse() function, then an attempt is made to
711 * find one with a valid ->parse() function. This way it is possible to declare
712 * platform-dependant, known keywords as NULL, then only declare them as valid
713 * if some options are met. Note that if the requested keyword contains an
714 * opening parenthesis, everything from this point is ignored.
715 */
716struct bind_kw *bind_find_kw(const char *kw)
717{
718 int index;
719 const char *kwend;
720 struct bind_kw_list *kwl;
721 struct bind_kw *ret = NULL;
722
723 kwend = strchr(kw, '(');
724 if (!kwend)
725 kwend = kw + strlen(kw);
726
727 list_for_each_entry(kwl, &bind_keywords.list, list) {
728 for (index = 0; kwl->kw[index].kw != NULL; index++) {
729 if ((strncmp(kwl->kw[index].kw, kw, kwend - kw) == 0) &&
730 kwl->kw[index].kw[kwend-kw] == 0) {
731 if (kwl->kw[index].parse)
732 return &kwl->kw[index]; /* found it !*/
733 else
734 ret = &kwl->kw[index]; /* may be OK */
735 }
736 }
737 }
738 return ret;
739}
740
Willy Tarreau8638f482012-09-18 18:01:17 +0200741/* Dumps all registered "bind" keywords to the <out> string pointer. The
742 * unsupported keywords are only dumped if their supported form was not
743 * found.
744 */
745void bind_dump_kws(char **out)
746{
747 struct bind_kw_list *kwl;
748 int index;
749
750 *out = NULL;
751 list_for_each_entry(kwl, &bind_keywords.list, list) {
752 for (index = 0; kwl->kw[index].kw != NULL; index++) {
753 if (kwl->kw[index].parse ||
754 bind_find_kw(kwl->kw[index].kw) == &kwl->kw[index]) {
Willy Tarreau51fb7652012-09-18 18:24:39 +0200755 memprintf(out, "%s[%4s] %s%s%s\n", *out ? *out : "",
756 kwl->scope,
Willy Tarreau8638f482012-09-18 18:01:17 +0200757 kwl->kw[index].kw,
Willy Tarreau51fb7652012-09-18 18:24:39 +0200758 kwl->kw[index].skip ? " <arg>" : "",
759 kwl->kw[index].parse ? "" : " (not supported)");
Willy Tarreau8638f482012-09-18 18:01:17 +0200760 }
761 }
762 }
763}
764
Willy Tarreau645513a2010-05-24 20:55:15 +0200765/************************************************************************/
Willy Tarreau0ccb7442013-01-07 22:54:17 +0100766/* All supported sample and ACL keywords must be declared here. */
Willy Tarreau645513a2010-05-24 20:55:15 +0200767/************************************************************************/
768
Willy Tarreaua5e37562011-12-16 17:06:15 +0100769/* set temp integer to the number of connexions to the same listening socket */
Willy Tarreau645513a2010-05-24 20:55:15 +0200770static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200771smp_fetch_dconn(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau645513a2010-05-24 20:55:15 +0200772{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200773 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200774 smp->data.u.sint = smp->sess->listener->nbconn;
Willy Tarreau645513a2010-05-24 20:55:15 +0200775 return 1;
776}
777
Willy Tarreaua5e37562011-12-16 17:06:15 +0100778/* set temp integer to the id of the socket (listener) */
Willy Tarreau645513a2010-05-24 20:55:15 +0200779static int
Thierry FOURNIER0786d052015-05-11 15:42:45 +0200780smp_fetch_so_id(const struct arg *args, struct sample *smp, const char *kw, void *private)
Willy Tarreau37406352012-04-23 16:16:37 +0200781{
Thierry FOURNIER8c542ca2015-08-19 09:00:18 +0200782 smp->data.type = SMP_T_SINT;
Thierry FOURNIER136f9d32015-08-19 09:07:19 +0200783 smp->data.u.sint = smp->sess->listener->luid;
Willy Tarreau645513a2010-05-24 20:55:15 +0200784 return 1;
785}
786
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200787/* parse the "accept-proxy" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200788static 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 +0200789{
790 struct listener *l;
791
Willy Tarreau4348fad2012-09-20 16:48:07 +0200792 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200793 l->options |= LI_O_ACC_PROXY;
794
795 return 0;
796}
797
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100798/* parse the "accept-netscaler-cip" bind keyword */
799static int bind_parse_accept_netscaler_cip(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
800{
801 struct listener *l;
802 uint32_t val;
803
804 if (!*args[cur_arg + 1]) {
805 memprintf(err, "'%s' : missing value", args[cur_arg]);
806 return ERR_ALERT | ERR_FATAL;
807 }
808
809 val = atol(args[cur_arg + 1]);
810 if (val <= 0) {
811 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
812 return ERR_ALERT | ERR_FATAL;
813 }
814
815 list_for_each_entry(l, &conf->listeners, by_bind) {
816 l->options |= LI_O_ACC_CIP;
817 conf->ns_cip_magic = val;
818 }
819
820 return 0;
821}
822
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200823/* parse the "backlog" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200824static 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 +0200825{
826 struct listener *l;
827 int val;
828
829 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200830 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200831 return ERR_ALERT | ERR_FATAL;
832 }
833
834 val = atol(args[cur_arg + 1]);
835 if (val <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200836 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200837 return ERR_ALERT | ERR_FATAL;
838 }
839
Willy Tarreau4348fad2012-09-20 16:48:07 +0200840 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200841 l->backlog = val;
842
843 return 0;
844}
845
846/* parse the "id" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200847static 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 +0200848{
849 struct eb32_node *node;
Willy Tarreau4348fad2012-09-20 16:48:07 +0200850 struct listener *l, *new;
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +0100851 char *error;
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200852
Willy Tarreau4348fad2012-09-20 16:48:07 +0200853 if (conf->listeners.n != conf->listeners.p) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200854 memprintf(err, "'%s' can only be used with a single socket", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200855 return ERR_ALERT | ERR_FATAL;
856 }
857
858 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200859 memprintf(err, "'%s' : expects an integer argument", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200860 return ERR_ALERT | ERR_FATAL;
861 }
862
Willy Tarreau4348fad2012-09-20 16:48:07 +0200863 new = LIST_NEXT(&conf->listeners, struct listener *, by_bind);
Thierry Fourniere7fe8eb2016-02-26 08:45:58 +0100864 new->luid = strtol(args[cur_arg + 1], &error, 10);
865 if (*error != '\0') {
866 memprintf(err, "'%s' : expects an integer argument, found '%s'", args[cur_arg], args[cur_arg + 1]);
867 return ERR_ALERT | ERR_FATAL;
868 }
Willy Tarreau4348fad2012-09-20 16:48:07 +0200869 new->conf.id.key = new->luid;
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200870
Willy Tarreau4348fad2012-09-20 16:48:07 +0200871 if (new->luid <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200872 memprintf(err, "'%s' : custom id has to be > 0", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200873 return ERR_ALERT | ERR_FATAL;
874 }
875
Willy Tarreau4348fad2012-09-20 16:48:07 +0200876 node = eb32_lookup(&px->conf.used_listener_id, new->luid);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200877 if (node) {
878 l = container_of(node, struct listener, conf.id);
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200879 memprintf(err, "'%s' : custom id %d already used at %s:%d ('bind %s')",
880 args[cur_arg], l->luid, l->bind_conf->file, l->bind_conf->line,
881 l->bind_conf->arg);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200882 return ERR_ALERT | ERR_FATAL;
883 }
884
Willy Tarreau4348fad2012-09-20 16:48:07 +0200885 eb32_insert(&px->conf.used_listener_id, &new->conf.id);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200886 return 0;
887}
888
889/* parse the "maxconn" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200890static 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 +0200891{
892 struct listener *l;
893 int val;
894
895 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200896 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200897 return ERR_ALERT | ERR_FATAL;
898 }
899
900 val = atol(args[cur_arg + 1]);
901 if (val <= 0) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200902 memprintf(err, "'%s' : invalid value %d, must be > 0", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200903 return ERR_ALERT | ERR_FATAL;
904 }
905
Willy Tarreau4348fad2012-09-20 16:48:07 +0200906 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200907 l->maxconn = val;
908
909 return 0;
910}
911
912/* parse the "name" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200913static 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 +0200914{
915 struct listener *l;
916
917 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200918 memprintf(err, "'%s' : missing name", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200919 return ERR_ALERT | ERR_FATAL;
920 }
921
Willy Tarreau4348fad2012-09-20 16:48:07 +0200922 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200923 l->name = strdup(args[cur_arg + 1]);
924
925 return 0;
926}
927
928/* parse the "nice" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200929static 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 +0200930{
931 struct listener *l;
932 int val;
933
934 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200935 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200936 return ERR_ALERT | ERR_FATAL;
937 }
938
939 val = atol(args[cur_arg + 1]);
940 if (val < -1024 || val > 1024) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200941 memprintf(err, "'%s' : invalid value %d, allowed range is -1024..1024", args[cur_arg], val);
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200942 return ERR_ALERT | ERR_FATAL;
943 }
944
Willy Tarreau4348fad2012-09-20 16:48:07 +0200945 list_for_each_entry(l, &conf->listeners, by_bind)
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200946 l->nice = val;
947
948 return 0;
949}
950
Willy Tarreau6ae1ba62014-05-07 19:01:58 +0200951/* parse the "process" bind keyword */
952static int bind_parse_process(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
953{
Christopher Fauletc644fa92017-11-23 22:44:11 +0100954 char *slash;
955 unsigned long proc = 0, thread = 0;
956 int i;
Willy Tarreau6ae1ba62014-05-07 19:01:58 +0200957
Christopher Fauletc644fa92017-11-23 22:44:11 +0100958 if ((slash = strchr(args[cur_arg + 1], '/')) != NULL)
959 *slash = 0;
960
961 if (parse_process_number(args[cur_arg + 1], &proc, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100962 memprintf(err, "'%s' : %s", args[cur_arg], *err);
Willy Tarreau6ae1ba62014-05-07 19:01:58 +0200963 return ERR_ALERT | ERR_FATAL;
964 }
965
Christopher Fauletc644fa92017-11-23 22:44:11 +0100966 if (slash) {
967 if (parse_process_number(slash+1, &thread, NULL, err)) {
968 memprintf(err, "'%s' : %s", args[cur_arg], *err);
969 return ERR_ALERT | ERR_FATAL;
970 }
971 *slash = '/';
972 }
973
974 conf->bind_proc |= proc;
975 if (thread) {
Willy Tarreau421f02e2018-01-20 18:19:22 +0100976 for (i = 0; i < MAX_THREADS; i++)
Christopher Fauletc644fa92017-11-23 22:44:11 +0100977 if (!proc || (proc & (1UL << i)))
978 conf->bind_thread[i] |= thread;
979 }
Willy Tarreau6ae1ba62014-05-07 19:01:58 +0200980 return 0;
981}
Willy Tarreau3dcc3412012-09-18 17:17:28 +0200982
Christopher Fauleta717b992018-04-10 14:43:00 +0200983/* parse the "proto" bind keyword */
984static int bind_parse_proto(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
985{
986 struct ist proto;
987
988 if (!*args[cur_arg + 1]) {
989 memprintf(err, "'%s' : missing value", args[cur_arg]);
990 return ERR_ALERT | ERR_FATAL;
991 }
992
993 proto = ist2(args[cur_arg + 1], strlen(args[cur_arg + 1]));
994 conf->mux_proto = get_mux_proto(proto);
995 if (!conf->mux_proto) {
996 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[cur_arg], args[cur_arg+1]);
997 return ERR_ALERT | ERR_FATAL;
998 }
999 else if (!(conf->mux_proto->side & PROTO_SIDE_FE)) {
1000 memprintf(err, "'%s' : MUX protocol '%s' cannot be used for incoming connections",
1001 args[cur_arg], args[cur_arg+1]);
1002 return ERR_ALERT | ERR_FATAL;
1003 }
1004 return 0;
1005}
1006
Willy Tarreau61612d42012-04-19 18:42:05 +02001007/* Note: must not be declared <const> as its list will be overwritten.
1008 * Please take care of keeping this list alphabetically sorted.
1009 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001010static struct sample_fetch_kw_list smp_kws = {ILH, {
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +02001011 { "dst_conn", smp_fetch_dconn, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
1012 { "so_id", smp_fetch_so_id, 0, NULL, SMP_T_SINT, SMP_USE_FTEND, },
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001013 { /* END */ },
1014}};
1015
1016/* Note: must not be declared <const> as its list will be overwritten.
1017 * Please take care of keeping this list alphabetically sorted.
1018 */
Willy Tarreaudc13c112013-06-21 23:16:39 +02001019static struct acl_kw_list acl_kws = {ILH, {
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001020 { /* END */ },
Willy Tarreau645513a2010-05-24 20:55:15 +02001021}};
1022
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001023/* Note: must not be declared <const> as its list will be overwritten.
1024 * Please take care of keeping this list alphabetically sorted, doing so helps
1025 * all code contributors.
1026 * Optional keywords are also declared with a NULL ->parse() function so that
1027 * the config parser can report an appropriate error when a known keyword was
1028 * not enabled.
1029 */
Willy Tarreau51fb7652012-09-18 18:24:39 +02001030static struct bind_kw_list bind_kws = { "ALL", { }, {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001031 { "accept-netscaler-cip", bind_parse_accept_netscaler_cip, 1 }, /* enable NetScaler Client IP insertion protocol */
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001032 { "accept-proxy", bind_parse_accept_proxy, 0 }, /* enable PROXY protocol */
1033 { "backlog", bind_parse_backlog, 1 }, /* set backlog of listening socket */
1034 { "id", bind_parse_id, 1 }, /* set id of listening socket */
1035 { "maxconn", bind_parse_maxconn, 1 }, /* set maxconn of listening socket */
1036 { "name", bind_parse_name, 1 }, /* set name of listening socket */
1037 { "nice", bind_parse_nice, 1 }, /* set nice of listening socket */
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02001038 { "process", bind_parse_process, 1 }, /* set list of allowed process for this socket */
Christopher Fauleta717b992018-04-10 14:43:00 +02001039 { "proto", bind_parse_proto, 1 }, /* set the proto to use for all incoming connections */
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001040 { /* END */ },
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001041}};
1042
Willy Tarreau645513a2010-05-24 20:55:15 +02001043__attribute__((constructor))
Willy Tarreaud1d54542012-09-12 22:58:11 +02001044static void __listener_init(void)
Willy Tarreau645513a2010-05-24 20:55:15 +02001045{
Willy Tarreau0ccb7442013-01-07 22:54:17 +01001046 sample_register_fetches(&smp_kws);
Willy Tarreau645513a2010-05-24 20:55:15 +02001047 acl_register_keywords(&acl_kws);
Willy Tarreau3dcc3412012-09-18 17:17:28 +02001048 bind_register_keywords(&bind_kws);
Christopher Faulet2a944ee2017-11-07 10:42:54 +01001049 HA_SPIN_INIT(&lq_lock);
Willy Tarreau645513a2010-05-24 20:55:15 +02001050}
1051
1052/*
1053 * Local variables:
1054 * c-indent-level: 8
1055 * c-basic-offset: 8
1056 * End:
1057 */