blob: 29a14135f01320646d6d15e5929d15100b8354e3 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * File descriptors management functions.
3 *
Willy Tarreauf817e9f2014-01-10 16:58:45 +01004 * Copyright 2000-2014 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +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 *
Willy Tarreau7be79a42012-11-11 15:02:54 +010011 * There is no direct link between the FD and the updates list. There is only a
12 * bit in the fdtab[] to indicate than a file descriptor is already present in
13 * the updates list. Once an fd is present in the updates list, it will have to
14 * be considered even if its changes are reverted in the middle or if the fd is
15 * replaced.
16 *
Willy Tarreauf817e9f2014-01-10 16:58:45 +010017 * The event state for an FD, as found in fdtab[].state, is maintained for each
18 * direction. The state field is built this way, with R bits in the low nibble
19 * and W bits in the high nibble for ease of access and debugging :
Willy Tarreau7be79a42012-11-11 15:02:54 +010020 *
Willy Tarreauf817e9f2014-01-10 16:58:45 +010021 * 7 6 5 4 3 2 1 0
Willy Tarreau5bee3e22019-09-04 09:52:57 +020022 * [ 0 | 0 | RW | AW | 0 | 0 | RR | AR ]
Willy Tarreauf817e9f2014-01-10 16:58:45 +010023 *
24 * A* = active *R = read
Willy Tarreau5bee3e22019-09-04 09:52:57 +020025 * R* = ready *W = write
Willy Tarreauf817e9f2014-01-10 16:58:45 +010026 *
27 * An FD is marked "active" when there is a desire to use it.
Willy Tarreauf817e9f2014-01-10 16:58:45 +010028 * An FD is marked "ready" when it has not faced a new EAGAIN since last wake-up
Willy Tarreau5bee3e22019-09-04 09:52:57 +020029 * (it is a cache of the last EAGAIN regardless of polling changes). Each poller
30 * has its own "polled" state for the same fd, as stored in the polled_mask.
Willy Tarreau7be79a42012-11-11 15:02:54 +010031 *
Willy Tarreau5bee3e22019-09-04 09:52:57 +020032 * We have 4 possible states for each direction based on these 2 flags :
Willy Tarreau7be79a42012-11-11 15:02:54 +010033 *
Willy Tarreau5bee3e22019-09-04 09:52:57 +020034 * +---+---+----------+---------------------------------------------+
35 * | R | A | State | Description |
36 * +---+---+----------+---------------------------------------------+
37 * | 0 | 0 | DISABLED | No activity desired, not ready. |
38 * | 0 | 1 | ACTIVE | Activity desired. |
39 * | 1 | 0 | STOPPED | End of activity. |
40 * | 1 | 1 | READY | Activity desired and reported. |
41 * +---+---+----------+---------------------------------------------+
Willy Tarreau7be79a42012-11-11 15:02:54 +010042 *
Willy Tarreauf817e9f2014-01-10 16:58:45 +010043 * The transitions are pretty simple :
44 * - fd_want_*() : set flag A
45 * - fd_stop_*() : clear flag A
46 * - fd_cant_*() : clear flag R (when facing EAGAIN)
47 * - fd_may_*() : set flag R (upon return from poll())
Willy Tarreauf817e9f2014-01-10 16:58:45 +010048 *
Willy Tarreau5bee3e22019-09-04 09:52:57 +020049 * Each poller then computes its own polled state :
50 * if (A) { if (!R) P := 1 } else { P := 0 }
Willy Tarreauf817e9f2014-01-10 16:58:45 +010051 *
Willy Tarreau5bee3e22019-09-04 09:52:57 +020052 * The state transitions look like the diagram below.
Willy Tarreauf817e9f2014-01-10 16:58:45 +010053 *
Willy Tarreau5bee3e22019-09-04 09:52:57 +020054 * may +----------+
55 * ,----| DISABLED | (READY=0, ACTIVE=0)
56 * | +----------+
57 * | want | ^
58 * | | |
59 * | v | stop
60 * | +----------+
61 * | | ACTIVE | (READY=0, ACTIVE=1)
62 * | +----------+
63 * | | ^
64 * | may | |
Thayne McCombs8f0cc5c2021-01-07 21:35:52 -070065 * | v | EAGAIN (can't)
Willy Tarreau5bee3e22019-09-04 09:52:57 +020066 * | +--------+
67 * | | READY | (READY=1, ACTIVE=1)
68 * | +--------+
69 * | stop | ^
70 * | | |
71 * | v | want
72 * | +---------+
73 * `--->| STOPPED | (READY=1, ACTIVE=0)
74 * +---------+
Willy Tarreaubaaee002006-06-26 02:48:02 +020075 */
76
Willy Tarreau2ff76222007-04-09 19:29:56 +020077#include <stdio.h>
Willy Tarreau4f60f162007-04-08 16:39:58 +020078#include <string.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020079#include <unistd.h>
Olivier Houchard79321b92018-07-26 17:55:11 +020080#include <fcntl.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020081#include <sys/types.h>
Willy Tarreau2d7f81b2019-02-21 22:19:17 +010082#include <sys/resource.h>
Willy Tarreau931d8b72019-08-27 11:08:17 +020083#include <sys/uio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020084
Willy Tarreaue5733232019-05-22 19:24:06 +020085#if defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +010086#include <poll.h>
87#include <errno.h>
88#endif
89
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020090#include <haproxy/api.h>
Willy Tarreau5d9ddc52021-10-06 19:54:09 +020091#include <haproxy/activity.h>
Willy Tarreaubc52bec2020-06-18 08:58:47 +020092#include <haproxy/cfgparse.h>
Willy Tarreau0f6ffd62020-06-03 19:33:00 +020093#include <haproxy/fd.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020094#include <haproxy/global.h>
Willy Tarreauc28aab02021-05-08 20:35:03 +020095#include <haproxy/log.h>
Willy Tarreaufc8f6a82020-06-03 19:20:59 +020096#include <haproxy/port_range.h>
Willy Tarreaub63888c2021-10-06 19:55:29 +020097#include <haproxy/ticks.h>
Willy Tarreaubc52bec2020-06-18 08:58:47 +020098#include <haproxy/tools.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020099
Willy Tarreaub2551052020-06-09 09:07:15 +0200100
Willy Tarreaua1090a52021-04-10 16:58:13 +0200101struct fdtab *fdtab __read_mostly = NULL; /* array of all the file descriptors */
102struct polled_mask *polled_mask __read_mostly = NULL; /* Array for the polled_mask of each fd */
103struct fdinfo *fdinfo __read_mostly = NULL; /* less-often used infos for file descriptors */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200104int totalconn; /* total # of terminated sessions */
105int actconn; /* # of active sessions */
106
Willy Tarreaua1090a52021-04-10 16:58:13 +0200107struct poller pollers[MAX_POLLERS] __read_mostly;
108struct poller cur_poller __read_mostly;
Willy Tarreau4f60f162007-04-08 16:39:58 +0200109int nbpollers = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200110
Olivier Houchard6b96f722018-04-25 16:58:25 +0200111volatile struct fdlist update_list; // Global update list
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100112
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200113THREAD_LOCAL int *fd_updt = NULL; // FD updates list
114THREAD_LOCAL int fd_nbupdt = 0; // number of updates in the list
Olivier Houchard79321b92018-07-26 17:55:11 +0200115THREAD_LOCAL int poller_rd_pipe = -1; // Pipe to wake the thread
Willy Tarreaua1090a52021-04-10 16:58:13 +0200116int poller_wr_pipe[MAX_THREADS] __read_mostly; // Pipe to wake the threads
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200117
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200118volatile int ha_used_fds = 0; // Number of FD we're currently using
Willy Tarreau97ea9c42022-01-27 16:10:48 +0100119static struct fdtab *fdtab_addr; /* address of the allocated area containing fdtab */
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200120
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100121/* adds fd <fd> to fd list <list> if it was not yet in it */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200122void fd_add_to_fd_list(volatile struct fdlist *list, int fd)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100123{
124 int next;
125 int new;
126 int old;
127 int last;
128
129redo_next:
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200130 next = fdtab[fd].update.next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100131 /* Check that we're not already in the cache, and if not, lock us. */
Olivier Houchardfc51f0f52019-12-19 18:33:08 +0100132 if (next > -2)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100133 goto done;
Olivier Houchardfc51f0f52019-12-19 18:33:08 +0100134 if (next == -2)
135 goto redo_next;
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200136 if (!_HA_ATOMIC_CAS(&fdtab[fd].update.next, &next, -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100137 goto redo_next;
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100138 __ha_barrier_atomic_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100139
140 new = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100141redo_last:
142 /* First, insert in the linked list */
143 last = list->last;
144 old = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100145
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200146 fdtab[fd].update.prev = -2;
Willy Tarreau11559a72018-02-05 17:52:24 +0100147 /* Make sure the "prev" store is visible before we update the last entry */
148 __ha_barrier_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100149
Willy Tarreau11559a72018-02-05 17:52:24 +0100150 if (unlikely(last == -1)) {
151 /* list is empty, try to add ourselves alone so that list->last=fd */
Olivier Houchardd3608792019-03-08 18:47:42 +0100152 if (unlikely(!_HA_ATOMIC_CAS(&list->last, &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100153 goto redo_last;
154
155 /* list->first was necessary -1, we're guaranteed to be alone here */
156 list->first = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100157 } else {
Willy Tarreau11559a72018-02-05 17:52:24 +0100158 /* adding ourselves past the last element
159 * The CAS will only succeed if its next is -1,
160 * which means it's in the cache, and the last element.
161 */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200162 if (unlikely(!_HA_ATOMIC_CAS(&fdtab[last].update.next, &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100163 goto redo_last;
Willy Tarreau11559a72018-02-05 17:52:24 +0100164
165 /* Then, update the last entry */
166 list->last = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100167 }
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100168 __ha_barrier_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100169 /* since we're alone at the end of the list and still locked(-2),
Ilya Shipitsinb8888ab2021-01-06 21:20:16 +0500170 * we know no one tried to add past us. Mark the end of list.
Willy Tarreau11559a72018-02-05 17:52:24 +0100171 */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200172 fdtab[fd].update.prev = last;
173 fdtab[fd].update.next = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100174 __ha_barrier_store();
175done:
176 return;
177}
178
179/* removes fd <fd> from fd list <list> */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200180void fd_rm_from_fd_list(volatile struct fdlist *list, int fd)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100181{
182#if defined(HA_HAVE_CAS_DW) || defined(HA_CAS_IS_8B)
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100183 volatile union {
184 struct fdlist_entry ent;
185 uint64_t u64;
186 uint32_t u32[2];
187 } cur_list, next_list;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100188#endif
189 int old;
190 int new = -2;
191 int prev;
192 int next;
193 int last;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100194lock_self:
195#if (defined(HA_CAS_IS_8B) || defined(HA_HAVE_CAS_DW))
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100196 next_list.ent.next = next_list.ent.prev = -2;
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200197 cur_list.ent = fdtab[fd].update;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100198 /* First, attempt to lock our own entries */
199 do {
200 /* The FD is not in the FD cache, give up */
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100201 if (unlikely(cur_list.ent.next <= -3))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100202 return;
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100203 if (unlikely(cur_list.ent.prev == -2 || cur_list.ent.next == -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100204 goto lock_self;
205 } while (
206#ifdef HA_CAS_IS_8B
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200207 unlikely(!_HA_ATOMIC_CAS(((uint64_t *)&fdtab[fd].update), (uint64_t *)&cur_list.u64, next_list.u64))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100208#else
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200209 unlikely(!_HA_ATOMIC_DWCAS(((long *)&fdtab[fd].update), (uint32_t *)&cur_list.u32, &next_list.u32))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100210#endif
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100211 );
212 next = cur_list.ent.next;
213 prev = cur_list.ent.prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100214
215#else
216lock_self_next:
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200217 next = fdtab[fd].update.next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100218 if (next == -2)
219 goto lock_self_next;
220 if (next <= -3)
221 goto done;
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200222 if (unlikely(!_HA_ATOMIC_CAS(&fdtab[fd].update.next, &next, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100223 goto lock_self_next;
224lock_self_prev:
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200225 prev = fdtab[fd].update.prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100226 if (prev == -2)
227 goto lock_self_prev;
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200228 if (unlikely(!_HA_ATOMIC_CAS(&fdtab[fd].update.prev, &prev, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100229 goto lock_self_prev;
230#endif
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100231 __ha_barrier_atomic_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100232
233 /* Now, lock the entries of our neighbours */
234 if (likely(prev != -1)) {
235redo_prev:
236 old = fd;
237
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200238 if (unlikely(!_HA_ATOMIC_CAS(&fdtab[prev].update.next, &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100239 if (unlikely(old == -2)) {
240 /* Neighbour already locked, give up and
241 * retry again once he's done
242 */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200243 fdtab[fd].update.prev = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100244 __ha_barrier_store();
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200245 fdtab[fd].update.next = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100246 __ha_barrier_store();
247 goto lock_self;
248 }
249 goto redo_prev;
250 }
251 }
252 if (likely(next != -1)) {
253redo_next:
254 old = fd;
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200255 if (unlikely(!_HA_ATOMIC_CAS(&fdtab[next].update.prev, &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100256 if (unlikely(old == -2)) {
257 /* Neighbour already locked, give up and
258 * retry again once he's done
259 */
260 if (prev != -1) {
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200261 fdtab[prev].update.next = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100262 __ha_barrier_store();
263 }
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200264 fdtab[fd].update.prev = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100265 __ha_barrier_store();
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200266 fdtab[fd].update.next = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100267 __ha_barrier_store();
268 goto lock_self;
269 }
270 goto redo_next;
271 }
272 }
273 if (list->first == fd)
274 list->first = next;
275 __ha_barrier_store();
276 last = list->last;
Olivier Houchardd3608792019-03-08 18:47:42 +0100277 while (unlikely(last == fd && (!_HA_ATOMIC_CAS(&list->last, &last, prev))))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100278 __ha_compiler_barrier();
279 /* Make sure we let other threads know we're no longer in cache,
280 * before releasing our neighbours.
281 */
282 __ha_barrier_store();
283 if (likely(prev != -1))
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200284 fdtab[prev].update.next = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100285 __ha_barrier_store();
286 if (likely(next != -1))
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200287 fdtab[next].update.prev = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100288 __ha_barrier_store();
289 /* Ok, now we're out of the fd cache */
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200290 fdtab[fd].update.next = -(next + 4);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100291 __ha_barrier_store();
292done:
293 return;
294}
295
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100296/* deletes the FD once nobody uses it anymore, as detected by the caller by its
297 * thread_mask being zero and its running mask turning to zero. There is no
298 * protection against concurrent accesses, it's up to the caller to make sure
299 * only the last thread will call it. This is only for internal use, please use
300 * fd_delete() instead.
Willy Tarreau4f60f162007-04-08 16:39:58 +0200301 */
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100302void _fd_delete_orphan(int fd)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200303{
Emeric Brunf41a3f62022-07-01 17:31:25 +0200304 uint fd_disown;
305
306 fd_disown = fdtab[fd].state & FD_DISOWN;
Willy Tarreaub41a6e92021-04-06 17:49:19 +0200307 if (fdtab[fd].state & FD_LINGER_RISK) {
Willy Tarreauad38ace2013-12-15 14:19:38 +0100308 /* this is generally set when connecting to servers */
Ilya Shipitsinb7e43f02020-04-02 15:02:08 +0500309 DISGUISE(setsockopt(fd, SOL_SOCKET, SO_LINGER,
310 (struct linger *) &nolinger, sizeof(struct linger)));
Willy Tarreauad38ace2013-12-15 14:19:38 +0100311 }
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100312 if (cur_poller.clo)
313 cur_poller.clo(fd);
Willy Tarreau2d423292021-03-24 15:34:25 +0100314
315 port_range_release_port(fdinfo[fd].port_range, fdinfo[fd].local_port);
Olivier Houchardc22580c2019-08-05 18:51:52 +0200316 polled_mask[fd].poll_recv = polled_mask[fd].poll_send = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100317
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100318 fdtab[fd].state = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100319
Willy Tarreau38e8a1c2020-06-23 10:04:54 +0200320#ifdef DEBUG_FD
321 fdtab[fd].event_count = 0;
322#endif
Willy Tarreau8d5d77e2009-10-18 07:25:52 +0200323 fdinfo[fd].port_range = NULL;
Willy Tarreaudb3b3262012-07-05 23:19:22 +0200324 fdtab[fd].owner = NULL;
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100325 /* perform the close() call last as it's what unlocks the instant reuse
326 * of this FD by any other thread.
327 */
Emeric Brunf41a3f62022-07-01 17:31:25 +0200328 if (!fd_disown)
329 close(fd);
Willy Tarreau4781b152021-04-06 13:53:36 +0200330 _HA_ATOMIC_DEC(&ha_used_fds);
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100331}
332
333/* Deletes an FD from the fdsets. The file descriptor is also closed, possibly
334 * asynchronously. Only the owning thread may do this.
335 */
336void fd_delete(int fd)
337{
Willy Tarreau9aa324d2022-01-31 20:05:02 +0100338 /* This must never happen and would definitely indicate a bug, in
339 * addition to overwriting some unexpected memory areas.
340 */
341 BUG_ON(fd < 0 || fd >= global.maxsock);
342
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100343 /* we must postpone removal of an FD that may currently be in use
Ilya Shipitsinb2be9a12021-04-24 13:25:42 +0500344 * by another thread. This can happen in the following two situations:
Willy Tarreau2c3f9812021-03-24 10:51:32 +0100345 * - after a takeover, the owning thread closes the connection but
346 * the previous one just woke up from the poller and entered
347 * the FD handler iocb. That thread holds an entry in running_mask
348 * and requires removal protection.
349 * - multiple threads are accepting connections on a listener, and
350 * one of them (or even an separate one) decides to unbind the
351 * listener under the listener's lock while other ones still hold
352 * the running bit.
353 * In both situations the FD is marked as unused (thread_mask = 0) and
354 * will not take new bits in its running_mask so we have the guarantee
355 * that the last thread eliminating running_mask is the one allowed to
356 * safely delete the FD. Most of the time it will be the current thread.
357 */
358
359 HA_ATOMIC_OR(&fdtab[fd].running_mask, tid_bit);
360 HA_ATOMIC_STORE(&fdtab[fd].thread_mask, 0);
361 if (fd_clr_running(fd) == 0)
362 _fd_delete_orphan(fd);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200363}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200364
Willy Tarreau97435892022-04-27 10:50:00 +0200365/* makes the new fd non-blocking and clears all other O_* flags; this is meant
366 * to be used on new FDs. Returns -1 on failure. The result is disguised at the
367 * end because some callers need to be able to ignore it regardless of the libc
368 * attributes.
Willy Tarreaua80e4a32022-04-26 10:18:07 +0200369 */
370int fd_set_nonblock(int fd)
371{
372 int ret = fcntl(fd, F_SETFL, O_NONBLOCK);
373
Willy Tarreau97435892022-04-27 10:50:00 +0200374 return DISGUISE(ret);
Willy Tarreaua80e4a32022-04-26 10:18:07 +0200375}
376
Willy Tarreau97435892022-04-27 10:50:00 +0200377/* sets the close-on-exec flag on fd; returns -1 on failure. The result is
378 * disguised at the end because some callers need to be able to ignore it
379 * regardless of the libc attributes.
380 */
Willy Tarreaua80e4a32022-04-26 10:18:07 +0200381int fd_set_cloexec(int fd)
382{
383 int flags, ret;
384
385 flags = fcntl(fd, F_GETFD);
386 flags |= FD_CLOEXEC;
387 ret = fcntl(fd, F_SETFD, flags);
Willy Tarreau97435892022-04-27 10:50:00 +0200388 return DISGUISE(ret);
Willy Tarreaua80e4a32022-04-26 10:18:07 +0200389}
390
Olivier Houchard88516642020-03-05 18:10:51 +0100391/*
392 * Take over a FD belonging to another thread.
393 * unexpected_conn is the expected owner of the fd.
394 * Returns 0 on success, and -1 on failure.
395 */
396int fd_takeover(int fd, void *expected_owner)
397{
Willy Tarreauf69fea62021-08-03 09:04:32 +0200398 unsigned long old;
Willy Tarreau42973632020-06-18 08:05:15 +0200399
Olivier Houchard88516642020-03-05 18:10:51 +0100400 /* protect ourself against a delete then an insert for the same fd,
401 * if it happens, then the owner will no longer be the expected
402 * connection.
403 */
Willy Tarreauf69fea62021-08-03 09:04:32 +0200404 if (fdtab[fd].owner != expected_owner)
405 return -1;
Willy Tarreauf1cad382020-06-18 08:14:59 +0200406
Willy Tarreauf69fea62021-08-03 09:04:32 +0200407 /* we must be alone to work on this idle FD. If not, it means that its
408 * poller is currently waking up and is about to use it, likely to
409 * close it on shut/error, but maybe also to process any unexpectedly
410 * pending data.
411 */
412 old = 0;
413 if (!HA_ATOMIC_CAS(&fdtab[fd].running_mask, &old, tid_bit))
414 return -1;
415
416 /* success, from now on it's ours */
417 HA_ATOMIC_STORE(&fdtab[fd].thread_mask, tid_bit);
Willy Tarreauf1cad382020-06-18 08:14:59 +0200418
Olivier Houchardddc874c2020-06-17 20:34:05 +0200419 /* Make sure the FD doesn't have the active bit. It is possible that
420 * the fd is polled by the thread that used to own it, the new thread
421 * is supposed to call subscribe() later, to activate polling.
422 */
Willy Tarreauf69fea62021-08-03 09:04:32 +0200423 fd_stop_recv(fd);
424
425 /* we're done with it */
426 HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
427 return 0;
Olivier Houchard88516642020-03-05 18:10:51 +0100428}
429
Willy Tarreaudbe30602019-09-04 13:25:41 +0200430void updt_fd_polling(const int fd)
431{
Willy Tarreau5a7d6eb2020-11-26 22:25:10 +0100432 if (all_threads_mask == 1UL || (fdtab[fd].thread_mask & all_threads_mask) == tid_bit) {
Willy Tarreaudbe30602019-09-04 13:25:41 +0200433 if (HA_ATOMIC_BTS(&fdtab[fd].update_mask, tid))
434 return;
435
436 fd_updt[fd_nbupdt++] = fd;
437 } else {
438 unsigned long update_mask = fdtab[fd].update_mask;
439 do {
440 if (update_mask == fdtab[fd].thread_mask)
441 return;
Willy Tarreauf0158872020-09-25 12:18:53 +0200442 } while (!_HA_ATOMIC_CAS(&fdtab[fd].update_mask, &update_mask, fdtab[fd].thread_mask));
443
Willy Tarreau4d9888c2022-07-06 14:43:51 +0200444 fd_add_to_fd_list(&update_list, fd);
Willy Tarreauf0158872020-09-25 12:18:53 +0200445
Willy Tarreau962e5ba2022-06-23 18:38:06 +0200446 if (fd_active(fd) && !(fdtab[fd].thread_mask & tid_bit)) {
Willy Tarreau555c1922022-06-23 18:31:08 +0200447 /* we need to wake up another thread to handle it immediately, any will fit,
448 * so let's pick a random one so that it doesn't always end up on the same.
449 */
450 int thr = one_among_mask(fdtab[fd].thread_mask & all_threads_mask,
451 statistical_prng_range(MAX_THREADS));
Willy Tarreauf0158872020-09-25 12:18:53 +0200452 wake_thread(thr);
453 }
Willy Tarreaudbe30602019-09-04 13:25:41 +0200454 }
455}
456
Willy Tarreau84c79222021-07-29 16:53:46 +0200457/* Update events seen for FD <fd> and its state if needed. This should be
458 * called by the poller, passing FD_EV_*_{R,W,RW} in <evts>. FD_EV_ERR_*
459 * doesn't need to also pass FD_EV_SHUT_*, it's implied. ERR and SHUT are
Willy Tarreau200bd502021-07-29 16:57:19 +0200460 * allowed to be reported regardless of R/W readiness. Returns one of
461 * FD_UPDT_*.
Willy Tarreau84c79222021-07-29 16:53:46 +0200462 */
Willy Tarreau200bd502021-07-29 16:57:19 +0200463int fd_update_events(int fd, uint evts)
Willy Tarreau84c79222021-07-29 16:53:46 +0200464{
465 unsigned long locked;
466 uint old, new;
467 uint new_flags, must_stop;
Willy Tarreauf69fea62021-08-03 09:04:32 +0200468 ulong rmask, tmask;
Willy Tarreau84c79222021-07-29 16:53:46 +0200469
Willy Tarreaubdcd3252022-06-22 09:19:46 +0200470 _HA_ATOMIC_AND(&th_ctx->flags, ~TH_FL_STUCK); // this thread is still running
Willy Tarreau84c79222021-07-29 16:53:46 +0200471
472 /* do nothing if the FD was taken over under us */
Willy Tarreauf69fea62021-08-03 09:04:32 +0200473 do {
474 /* make sure we read a synchronous copy of rmask and tmask
475 * (tmask is only up to date if it reflects all of rmask's
476 * bits).
477 */
478 do {
479 rmask = _HA_ATOMIC_LOAD(&fdtab[fd].running_mask);
480 tmask = _HA_ATOMIC_LOAD(&fdtab[fd].thread_mask);
481 } while (rmask & ~tmask);
482
483 if (!(tmask & tid_bit)) {
484 /* a takeover has started */
485 activity[tid].poll_skip_fd++;
486 return FD_UPDT_MIGRATED;
487 }
488 } while (!HA_ATOMIC_CAS(&fdtab[fd].running_mask, &rmask, rmask | tid_bit));
Willy Tarreau84c79222021-07-29 16:53:46 +0200489
Willy Tarreauf69fea62021-08-03 09:04:32 +0200490 locked = (tmask != tid_bit);
Willy Tarreau84c79222021-07-29 16:53:46 +0200491
492 /* OK now we are guaranteed that our thread_mask was present and
493 * that we're allowed to update the FD.
494 */
495
496 new_flags =
497 ((evts & FD_EV_READY_R) ? FD_POLL_IN : 0) |
498 ((evts & FD_EV_READY_W) ? FD_POLL_OUT : 0) |
499 ((evts & FD_EV_SHUT_R) ? FD_POLL_HUP : 0) |
500 ((evts & FD_EV_ERR_RW) ? FD_POLL_ERR : 0);
501
502 /* SHUTW reported while FD was active for writes is an error */
503 if ((fdtab[fd].state & FD_EV_ACTIVE_W) && (evts & FD_EV_SHUT_W))
504 new_flags |= FD_POLL_ERR;
505
506 /* compute the inactive events reported late that must be stopped */
507 must_stop = 0;
508 if (unlikely(!fd_active(fd))) {
509 /* both sides stopped */
510 must_stop = FD_POLL_IN | FD_POLL_OUT;
511 }
512 else if (unlikely(!fd_recv_active(fd) && (evts & (FD_EV_READY_R | FD_EV_SHUT_R | FD_EV_ERR_RW)))) {
513 /* only send remains */
514 must_stop = FD_POLL_IN;
515 }
516 else if (unlikely(!fd_send_active(fd) && (evts & (FD_EV_READY_W | FD_EV_SHUT_W | FD_EV_ERR_RW)))) {
517 /* only recv remains */
518 must_stop = FD_POLL_OUT;
519 }
520
521 if (new_flags & (FD_POLL_IN | FD_POLL_HUP | FD_POLL_ERR))
522 new_flags |= FD_EV_READY_R;
523
524 if (new_flags & (FD_POLL_OUT | FD_POLL_ERR))
525 new_flags |= FD_EV_READY_W;
526
527 old = fdtab[fd].state;
528 new = (old & ~FD_POLL_UPDT_MASK) | new_flags;
529
530 if (unlikely(locked)) {
531 /* Locked FDs (those with more than 2 threads) are atomically updated */
532 while (unlikely(new != old && !_HA_ATOMIC_CAS(&fdtab[fd].state, &old, new)))
533 new = (old & ~FD_POLL_UPDT_MASK) | new_flags;
534 } else {
535 if (new != old)
536 fdtab[fd].state = new;
537 }
538
539 if (fdtab[fd].iocb && fd_active(fd)) {
540 fdtab[fd].iocb(fd);
541 }
542
543 /* another thread might have attempted to close this FD in the mean
544 * time (e.g. timeout task) striking on a previous thread and closing.
545 * This is detected by both thread_mask and running_mask being 0 after
546 * we remove ourselves last.
547 */
548 if ((fdtab[fd].running_mask & tid_bit) &&
549 fd_clr_running(fd) == 0 && !fdtab[fd].thread_mask) {
550 _fd_delete_orphan(fd);
Willy Tarreau200bd502021-07-29 16:57:19 +0200551 return FD_UPDT_CLOSED;
Willy Tarreau84c79222021-07-29 16:53:46 +0200552 }
553
554 /* we had to stop this FD and it still must be stopped after the I/O
555 * cb's changes, so let's program an update for this.
556 */
557 if (must_stop && !(fdtab[fd].update_mask & tid_bit)) {
558 if (((must_stop & FD_POLL_IN) && !fd_recv_active(fd)) ||
559 ((must_stop & FD_POLL_OUT) && !fd_send_active(fd)))
560 if (!HA_ATOMIC_BTS(&fdtab[fd].update_mask, tid))
561 fd_updt[fd_nbupdt++] = fd;
562 }
Willy Tarreau200bd502021-07-29 16:57:19 +0200563
564 return FD_UPDT_DONE;
Willy Tarreau84c79222021-07-29 16:53:46 +0200565}
566
Willy Tarreau931d8b72019-08-27 11:08:17 +0200567/* Tries to send <npfx> parts from <prefix> followed by <nmsg> parts from <msg>
568 * optionally followed by a newline if <nl> is non-null, to file descriptor
569 * <fd>. The message is sent atomically using writev(). It may be truncated to
570 * <maxlen> bytes if <maxlen> is non-null. There is no distinction between the
571 * two lists, it's just a convenience to help the caller prepend some prefixes
572 * when necessary. It takes the fd's lock to make sure no other thread will
573 * write to the same fd in parallel. Returns the number of bytes sent, or <=0
574 * on failure. A limit to 31 total non-empty segments is enforced. The caller
575 * is responsible for taking care of making the fd non-blocking.
576 */
577ssize_t fd_write_frag_line(int fd, size_t maxlen, const struct ist pfx[], size_t npfx, const struct ist msg[], size_t nmsg, int nl)
578{
579 struct iovec iovec[32];
Willy Tarreau931d8b72019-08-27 11:08:17 +0200580 size_t sent = 0;
581 int vec = 0;
Willy Tarreaudf187872020-06-11 14:25:47 +0200582 int attempts = 0;
Willy Tarreau931d8b72019-08-27 11:08:17 +0200583
584 if (!maxlen)
585 maxlen = ~0;
586
587 /* keep one char for a possible trailing '\n' in any case */
588 maxlen--;
589
590 /* make an iovec from the concatenation of all parts of the original
591 * message. Skip empty fields and truncate the whole message to maxlen,
592 * leaving one spare iovec for the '\n'.
593 */
594 while (vec < (sizeof(iovec) / sizeof(iovec[0]) - 1)) {
595 if (!npfx) {
596 pfx = msg;
597 npfx = nmsg;
598 nmsg = 0;
599 if (!npfx)
600 break;
601 }
602
603 iovec[vec].iov_base = pfx->ptr;
604 iovec[vec].iov_len = MIN(maxlen, pfx->len);
605 maxlen -= iovec[vec].iov_len;
Willy Tarreau931d8b72019-08-27 11:08:17 +0200606 if (iovec[vec].iov_len)
607 vec++;
608 pfx++; npfx--;
609 };
610
611 if (nl) {
612 iovec[vec].iov_base = "\n";
613 iovec[vec].iov_len = 1;
614 vec++;
615 }
616
Willy Tarreaudf187872020-06-11 14:25:47 +0200617 /* make sure we never interleave writes and we never block. This means
618 * we prefer to fail on collision than to block. But we don't want to
619 * lose too many logs so we just perform a few lock attempts then give
620 * up.
621 */
622
Willy Tarreau1673c4a2021-04-07 17:36:57 +0200623 while (HA_ATOMIC_BTS(&fdtab[fd].state, FD_EXCL_SYSCALL_BIT)) {
Willy Tarreaudf187872020-06-11 14:25:47 +0200624 if (++attempts >= 200) {
625 /* so that the caller knows the message couldn't be delivered */
626 sent = -1;
627 errno = EAGAIN;
628 goto leave;
629 }
630 ha_thread_relax();
631 }
632
Willy Tarreau0cc61282021-04-06 17:57:12 +0200633 if (unlikely(!(fdtab[fd].state & FD_INITIALIZED))) {
634 HA_ATOMIC_OR(&fdtab[fd].state, FD_INITIALIZED);
Willy Tarreau7e9776a2019-08-30 14:41:47 +0200635 if (!isatty(fd))
Willy Tarreau38247432022-04-26 10:24:14 +0200636 fd_set_nonblock(fd);
Willy Tarreau7e9776a2019-08-30 14:41:47 +0200637 }
Willy Tarreau931d8b72019-08-27 11:08:17 +0200638 sent = writev(fd, iovec, vec);
Willy Tarreau1673c4a2021-04-07 17:36:57 +0200639 HA_ATOMIC_BTR(&fdtab[fd].state, FD_EXCL_SYSCALL_BIT);
Willy Tarreau931d8b72019-08-27 11:08:17 +0200640
Willy Tarreaudf187872020-06-11 14:25:47 +0200641 leave:
Willy Tarreau931d8b72019-08-27 11:08:17 +0200642 /* sent > 0 if the message was delivered */
643 return sent;
644}
645
Olivier Houchard2292edf2019-02-25 14:26:54 +0100646#if defined(USE_CLOSEFROM)
647void my_closefrom(int start)
648{
649 closefrom(start);
650}
651
Willy Tarreaue5733232019-05-22 19:24:06 +0200652#elif defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100653/* This is a portable implementation of closefrom(). It closes all open file
654 * descriptors starting at <start> and above. It relies on the fact that poll()
655 * will return POLLNVAL for each invalid (hence close) file descriptor passed
656 * in argument in order to skip them. It acts with batches of FDs and will
657 * typically perform one poll() call per 1024 FDs so the overhead is low in
658 * case all FDs have to be closed.
659 */
660void my_closefrom(int start)
661{
662 struct pollfd poll_events[1024];
663 struct rlimit limit;
664 int nbfds, fd, ret, idx;
665 int step, next;
666
667 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
668 step = nbfds = limit.rlim_cur;
669 else
670 step = nbfds = 0;
671
672 if (nbfds <= 0) {
673 /* set safe limit */
674 nbfds = 1024;
675 step = 256;
676 }
677
678 if (step > sizeof(poll_events) / sizeof(poll_events[0]))
679 step = sizeof(poll_events) / sizeof(poll_events[0]);
680
681 while (start < nbfds) {
682 next = (start / step + 1) * step;
683
684 for (fd = start; fd < next && fd < nbfds; fd++) {
685 poll_events[fd - start].fd = fd;
686 poll_events[fd - start].events = 0;
687 }
688
689 do {
690 ret = poll(poll_events, fd - start, 0);
691 if (ret >= 0)
692 break;
Willy Tarreauacef5e22022-04-25 20:32:15 +0200693 } while (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR || errno == ENOMEM);
Willy Tarreau9188ac62019-02-21 22:12:47 +0100694
Willy Tarreaub8e602c2019-02-22 09:07:42 +0100695 if (ret)
696 ret = fd - start;
697
Willy Tarreau9188ac62019-02-21 22:12:47 +0100698 for (idx = 0; idx < ret; idx++) {
699 if (poll_events[idx].revents & POLLNVAL)
700 continue; /* already closed */
701
702 fd = poll_events[idx].fd;
703 close(fd);
704 }
705 start = next;
706 }
707}
708
Willy Tarreaue5733232019-05-22 19:24:06 +0200709#else // defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100710
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100711/* This is a portable implementation of closefrom(). It closes all open file
712 * descriptors starting at <start> and above. This is a naive version for use
713 * when the operating system provides no alternative.
714 */
715void my_closefrom(int start)
716{
717 struct rlimit limit;
718 int nbfds;
719
720 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
721 nbfds = limit.rlim_cur;
722 else
723 nbfds = 0;
724
725 if (nbfds <= 0)
726 nbfds = 1024; /* safe limit */
727
728 while (start < nbfds)
729 close(start++);
730}
Willy Tarreaue5733232019-05-22 19:24:06 +0200731#endif // defined(USE_POLL)
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100732
Willy Tarreaub63888c2021-10-06 19:55:29 +0200733/* Computes the bounded poll() timeout based on the next expiration timer <next>
734 * by bounding it to MAX_DELAY_MS. <next> may equal TICK_ETERNITY. The pollers
735 * just needs to call this function right before polling to get their timeout
736 * value. Timeouts that are already expired (possibly due to a pending event)
737 * are accounted for in activity.poll_exp.
738 */
739int compute_poll_timeout(int next)
740{
741 int wait_time;
742
743 if (!tick_isset(next))
744 wait_time = MAX_DELAY_MS;
745 else if (tick_is_expired(next, now_ms)) {
746 activity[tid].poll_exp++;
747 wait_time = 0;
748 }
749 else {
750 wait_time = TICKS_TO_MS(tick_remain(now_ms, next)) + 1;
751 if (wait_time > MAX_DELAY_MS)
752 wait_time = MAX_DELAY_MS;
753 }
754 return wait_time;
755}
756
Willy Tarreau058b2c12022-06-22 15:21:34 +0200757/* Handle the return of the poller, which consists in calculating the idle
758 * time, saving a few clocks, marking the thread harmful again etc. All that
759 * is some boring stuff that all pollers have to do anyway.
760 */
761void fd_leaving_poll(int wait_time, int status)
762{
763 clock_leaving_poll(wait_time, status);
764
765 thread_harmless_end();
766 thread_idle_end();
767
Willy Tarreaue7475c82022-06-20 09:23:24 +0200768 _HA_ATOMIC_AND(&th_ctx->flags, ~TH_FL_SLEEPING);
Willy Tarreau058b2c12022-06-22 15:21:34 +0200769}
770
Willy Tarreau4f60f162007-04-08 16:39:58 +0200771/* disable the specified poller */
772void disable_poller(const char *poller_name)
773{
774 int p;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200775
Willy Tarreau4f60f162007-04-08 16:39:58 +0200776 for (p = 0; p < nbpollers; p++)
777 if (strcmp(pollers[p].name, poller_name) == 0)
778 pollers[p].pref = 0;
779}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200780
Olivier Houchard79321b92018-07-26 17:55:11 +0200781void poller_pipe_io_handler(int fd)
782{
783 char buf[1024];
784 /* Flush the pipe */
785 while (read(fd, buf, sizeof(buf)) > 0);
786 fd_cant_recv(fd);
787}
788
Willy Tarreau082b6282019-05-22 14:42:12 +0200789/* allocate the per-thread fd_updt thus needs to be called early after
790 * thread creation.
791 */
792static int alloc_pollers_per_thread()
793{
794 fd_updt = calloc(global.maxsock, sizeof(*fd_updt));
795 return fd_updt != NULL;
796}
797
798/* Initialize the pollers per thread.*/
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200799static int init_pollers_per_thread()
800{
Olivier Houchard79321b92018-07-26 17:55:11 +0200801 int mypipe[2];
Willy Tarreau082b6282019-05-22 14:42:12 +0200802
803 if (pipe(mypipe) < 0)
Olivier Houchard79321b92018-07-26 17:55:11 +0200804 return 0;
Willy Tarreau082b6282019-05-22 14:42:12 +0200805
Olivier Houchard79321b92018-07-26 17:55:11 +0200806 poller_rd_pipe = mypipe[0];
807 poller_wr_pipe[tid] = mypipe[1];
Willy Tarreau38247432022-04-26 10:24:14 +0200808 fd_set_nonblock(poller_rd_pipe);
Willy Tarreau3a6af1e2022-01-24 20:33:09 +0100809 fd_insert(poller_rd_pipe, poller_pipe_io_handler, poller_pipe_io_handler, tid_bit);
810 fd_insert(poller_wr_pipe[tid], poller_pipe_io_handler, poller_pipe_io_handler, tid_bit);
Olivier Houchard79321b92018-07-26 17:55:11 +0200811 fd_want_recv(poller_rd_pipe);
Willy Tarreau3a6af1e2022-01-24 20:33:09 +0100812 fd_stop_both(poller_wr_pipe[tid]);
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200813 return 1;
814}
815
816/* Deinitialize the pollers per thread */
817static void deinit_pollers_per_thread()
818{
William Lallemand808e1b72018-12-15 22:34:31 +0100819 /* rd and wr are init at the same place, but only rd is init to -1, so
820 we rely to rd to close. */
821 if (poller_rd_pipe > -1) {
822 close(poller_rd_pipe);
823 poller_rd_pipe = -1;
824 close(poller_wr_pipe[tid]);
825 poller_wr_pipe[tid] = -1;
826 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200827}
828
Willy Tarreau082b6282019-05-22 14:42:12 +0200829/* Release the pollers per thread, to be called late */
830static void free_pollers_per_thread()
831{
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100832 ha_free(&fd_updt);
Willy Tarreau082b6282019-05-22 14:42:12 +0200833}
834
Willy Tarreaubaaee002006-06-26 02:48:02 +0200835/*
Willy Tarreau4f60f162007-04-08 16:39:58 +0200836 * Initialize the pollers till the best one is found.
837 * If none works, returns 0, otherwise 1.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200838 */
Willy Tarreau4f60f162007-04-08 16:39:58 +0200839int init_pollers()
Willy Tarreaubaaee002006-06-26 02:48:02 +0200840{
Willy Tarreau4f60f162007-04-08 16:39:58 +0200841 int p;
842 struct poller *bp;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200843
Willy Tarreau97ea9c42022-01-27 16:10:48 +0100844 if ((fdtab_addr = calloc(global.maxsock, sizeof(*fdtab) + 64)) == NULL) {
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200845 ha_alert("Not enough memory to allocate %d entries for fdtab!\n", global.maxsock);
Christopher Faulet63fe6522017-08-31 17:52:09 +0200846 goto fail_tab;
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200847 }
Christopher Faulet63fe6522017-08-31 17:52:09 +0200848
Willy Tarreau97ea9c42022-01-27 16:10:48 +0100849 /* always provide an aligned fdtab */
850 fdtab = (struct fdtab*)((((size_t)fdtab_addr) + 63) & -(size_t)64);
851
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200852 if ((polled_mask = calloc(global.maxsock, sizeof(*polled_mask))) == NULL) {
853 ha_alert("Not enough memory to allocate %d entries for polled_mask!\n", global.maxsock);
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200854 goto fail_polledmask;
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200855 }
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000856
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200857 if ((fdinfo = calloc(global.maxsock, sizeof(*fdinfo))) == NULL) {
858 ha_alert("Not enough memory to allocate %d entries for fdinfo!\n", global.maxsock);
Christopher Faulet63fe6522017-08-31 17:52:09 +0200859 goto fail_info;
Willy Tarreau7c9f7562020-10-13 15:45:07 +0200860 }
Christopher Faulet63fe6522017-08-31 17:52:09 +0200861
Olivier Houchard6b96f722018-04-25 16:58:25 +0200862 update_list.first = update_list.last = -1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200863
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100864 for (p = 0; p < global.maxsock; p++) {
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100865 /* Mark the fd as out of the fd cache */
Olivier Houchard6b96f722018-04-25 16:58:25 +0200866 fdtab[p].update.next = -3;
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100867 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200868
Willy Tarreau4f60f162007-04-08 16:39:58 +0200869 do {
870 bp = NULL;
871 for (p = 0; p < nbpollers; p++)
872 if (!bp || (pollers[p].pref > bp->pref))
873 bp = &pollers[p];
Willy Tarreaubaaee002006-06-26 02:48:02 +0200874
Willy Tarreau4f60f162007-04-08 16:39:58 +0200875 if (!bp || bp->pref == 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200876 break;
877
Willy Tarreau4f60f162007-04-08 16:39:58 +0200878 if (bp->init(bp)) {
879 memcpy(&cur_poller, bp, sizeof(*bp));
880 return 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200881 }
Willy Tarreau4f60f162007-04-08 16:39:58 +0200882 } while (!bp || bp->pref == 0);
Willy Tarreau7be79a42012-11-11 15:02:54 +0100883
Christopher Faulet63fe6522017-08-31 17:52:09 +0200884 free(fdinfo);
885 fail_info:
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200886 free(polled_mask);
887 fail_polledmask:
Willy Tarreau97ea9c42022-01-27 16:10:48 +0100888 free(fdtab_addr);
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000889 fail_tab:
Willy Tarreau7be79a42012-11-11 15:02:54 +0100890 return 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200891}
892
Willy Tarreaubaaee002006-06-26 02:48:02 +0200893/*
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200894 * Deinitialize the pollers.
895 */
896void deinit_pollers() {
897
898 struct poller *bp;
899 int p;
900
901 for (p = 0; p < nbpollers; p++) {
902 bp = &pollers[p];
903
904 if (bp && bp->pref)
905 bp->term(bp);
906 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200907
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100908 ha_free(&fdinfo);
Willy Tarreau97ea9c42022-01-27 16:10:48 +0100909 ha_free(&fdtab_addr);
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100910 ha_free(&polled_mask);
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200911}
912
913/*
Willy Tarreau2ff76222007-04-09 19:29:56 +0200914 * Lists the known pollers on <out>.
915 * Should be performed only before initialization.
916 */
917int list_pollers(FILE *out)
918{
919 int p;
920 int last, next;
921 int usable;
922 struct poller *bp;
923
924 fprintf(out, "Available polling systems :\n");
925
926 usable = 0;
927 bp = NULL;
928 last = next = -1;
929 while (1) {
930 for (p = 0; p < nbpollers; p++) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200931 if ((next < 0 || pollers[p].pref > next)
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100932 && (last < 0 || pollers[p].pref < last)) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200933 next = pollers[p].pref;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100934 if (!bp || (pollers[p].pref > bp->pref))
935 bp = &pollers[p];
936 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200937 }
938
939 if (next == -1)
940 break;
941
942 for (p = 0; p < nbpollers; p++) {
943 if (pollers[p].pref == next) {
944 fprintf(out, " %10s : ", pollers[p].name);
945 if (pollers[p].pref == 0)
946 fprintf(out, "disabled, ");
947 else
948 fprintf(out, "pref=%3d, ", pollers[p].pref);
949 if (pollers[p].test(&pollers[p])) {
950 fprintf(out, " test result OK");
951 if (next > 0)
952 usable++;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100953 } else {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200954 fprintf(out, " test result FAILED");
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100955 if (bp == &pollers[p])
956 bp = NULL;
957 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200958 fprintf(out, "\n");
959 }
960 }
961 last = next;
962 next = -1;
963 };
964 fprintf(out, "Total: %d (%d usable), will use %s.\n", nbpollers, usable, bp ? bp->name : "none");
965 return 0;
966}
967
968/*
969 * Some pollers may lose their connection after a fork(). It may be necessary
970 * to create initialize part of them again. Returns 0 in case of failure,
971 * otherwise 1. The fork() function may be NULL if unused. In case of error,
972 * the the current poller is destroyed and the caller is responsible for trying
973 * another one by calling init_pollers() again.
974 */
975int fork_poller()
976{
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200977 int fd;
Willy Tarreauce036bc2018-01-29 14:58:02 +0100978 for (fd = 0; fd < global.maxsock; fd++) {
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200979 if (fdtab[fd].owner) {
Willy Tarreau030dae12021-04-06 17:53:33 +0200980 HA_ATOMIC_OR(&fdtab[fd].state, FD_CLONED);
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200981 }
982 }
983
Willy Tarreau2ff76222007-04-09 19:29:56 +0200984 if (cur_poller.fork) {
985 if (cur_poller.fork(&cur_poller))
986 return 1;
987 cur_poller.term(&cur_poller);
988 return 0;
989 }
990 return 1;
991}
992
Willy Tarreaubc52bec2020-06-18 08:58:47 +0200993/* config parser for global "tune.fd.edge-triggered", accepts "on" or "off" */
994static int cfg_parse_tune_fd_edge_triggered(char **args, int section_type, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100995 const struct proxy *defpx, const char *file, int line,
Willy Tarreaubc52bec2020-06-18 08:58:47 +0200996 char **err)
997{
998 if (too_many_args(1, args, err, NULL))
999 return -1;
1000
1001 if (strcmp(args[1], "on") == 0)
1002 global.tune.options |= GTUNE_FD_ET;
1003 else if (strcmp(args[1], "off") == 0)
1004 global.tune.options &= ~GTUNE_FD_ET;
1005 else {
1006 memprintf(err, "'%s' expects either 'on' or 'off' but got '%s'.", args[0], args[1]);
1007 return -1;
1008 }
1009 return 0;
1010}
1011
1012/* config keyword parsers */
1013static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau9eec7e22021-05-08 11:06:32 +02001014 { CFG_GLOBAL, "tune.fd.edge-triggered", cfg_parse_tune_fd_edge_triggered, KWF_EXPERIMENTAL },
Willy Tarreaubc52bec2020-06-18 08:58:47 +02001015 { 0, NULL, NULL }
1016}};
1017
1018INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
1019
Willy Tarreau082b6282019-05-22 14:42:12 +02001020REGISTER_PER_THREAD_ALLOC(alloc_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +01001021REGISTER_PER_THREAD_INIT(init_pollers_per_thread);
1022REGISTER_PER_THREAD_DEINIT(deinit_pollers_per_thread);
Willy Tarreau082b6282019-05-22 14:42:12 +02001023REGISTER_PER_THREAD_FREE(free_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +01001024
Willy Tarreau2ff76222007-04-09 19:29:56 +02001025/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02001026 * Local variables:
1027 * c-indent-level: 8
1028 * c-basic-offset: 8
1029 * End:
1030 */