blob: d3940bb12ad1e2f56014d8506afd0c447fd53a03 [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 | |
65 * | v | EAGAIN (cant)
66 * | +--------+
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 Tarreaubaaee002006-06-26 02:48:02 +020090
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020091#include <haproxy/api.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020092#include <haproxy/global.h>
Willy Tarreau7be79a42012-11-11 15:02:54 +010093
Willy Tarreau0f6ffd62020-06-03 19:33:00 +020094#include <haproxy/fd.h>
Willy Tarreaufc8f6a82020-06-03 19:20:59 +020095#include <haproxy/port_range.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020096
97struct fdtab *fdtab = NULL; /* array of all the file descriptors */
Olivier Houchard53055052019-07-25 14:00:18 +000098struct polled_mask *polled_mask = NULL; /* Array for the polled_mask of each fd */
Willy Tarreau8d5d77e2009-10-18 07:25:52 +020099struct fdinfo *fdinfo = NULL; /* less-often used infos for file descriptors */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200100int totalconn; /* total # of terminated sessions */
101int actconn; /* # of active sessions */
102
Willy Tarreau4f60f162007-04-08 16:39:58 +0200103struct poller pollers[MAX_POLLERS];
104struct poller cur_poller;
105int nbpollers = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200106
Olivier Houchard6b96f722018-04-25 16:58:25 +0200107volatile struct fdlist update_list; // Global update list
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100108
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200109THREAD_LOCAL int *fd_updt = NULL; // FD updates list
110THREAD_LOCAL int fd_nbupdt = 0; // number of updates in the list
Olivier Houchard79321b92018-07-26 17:55:11 +0200111THREAD_LOCAL int poller_rd_pipe = -1; // Pipe to wake the thread
112int poller_wr_pipe[MAX_THREADS]; // Pipe to wake the threads
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200113
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200114volatile int ha_used_fds = 0; // Number of FD we're currently using
115
Willy Tarreau337fb712019-12-20 07:20:00 +0100116#define _GET_NEXT(fd, off) ((volatile struct fdlist_entry *)(void *)((char *)(&fdtab[fd]) + off))->next
117#define _GET_PREV(fd, off) ((volatile struct fdlist_entry *)(void *)((char *)(&fdtab[fd]) + off))->prev
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100118/* adds fd <fd> to fd list <list> if it was not yet in it */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200119void fd_add_to_fd_list(volatile struct fdlist *list, int fd, int off)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100120{
121 int next;
122 int new;
123 int old;
124 int last;
125
126redo_next:
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200127 next = _GET_NEXT(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100128 /* Check that we're not already in the cache, and if not, lock us. */
Olivier Houchardfc51f0f2019-12-19 18:33:08 +0100129 if (next > -2)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100130 goto done;
Olivier Houchardfc51f0f2019-12-19 18:33:08 +0100131 if (next == -2)
132 goto redo_next;
Olivier Houchardd3608792019-03-08 18:47:42 +0100133 if (!_HA_ATOMIC_CAS(&_GET_NEXT(fd, off), &next, -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100134 goto redo_next;
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100135 __ha_barrier_atomic_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100136
137 new = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100138redo_last:
139 /* First, insert in the linked list */
140 last = list->last;
141 old = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100142
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200143 _GET_PREV(fd, off) = -2;
Willy Tarreau11559a72018-02-05 17:52:24 +0100144 /* Make sure the "prev" store is visible before we update the last entry */
145 __ha_barrier_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100146
Willy Tarreau11559a72018-02-05 17:52:24 +0100147 if (unlikely(last == -1)) {
148 /* list is empty, try to add ourselves alone so that list->last=fd */
Olivier Houchardd3608792019-03-08 18:47:42 +0100149 if (unlikely(!_HA_ATOMIC_CAS(&list->last, &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100150 goto redo_last;
151
152 /* list->first was necessary -1, we're guaranteed to be alone here */
153 list->first = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100154 } else {
Willy Tarreau11559a72018-02-05 17:52:24 +0100155 /* adding ourselves past the last element
156 * The CAS will only succeed if its next is -1,
157 * which means it's in the cache, and the last element.
158 */
Olivier Houchardd3608792019-03-08 18:47:42 +0100159 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(last, off), &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100160 goto redo_last;
Willy Tarreau11559a72018-02-05 17:52:24 +0100161
162 /* Then, update the last entry */
163 list->last = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100164 }
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100165 __ha_barrier_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100166 /* since we're alone at the end of the list and still locked(-2),
167 * we know noone tried to add past us. Mark the end of list.
168 */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200169 _GET_PREV(fd, off) = last;
170 _GET_NEXT(fd, off) = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100171 __ha_barrier_store();
172done:
173 return;
174}
175
176/* removes fd <fd> from fd list <list> */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200177void fd_rm_from_fd_list(volatile struct fdlist *list, int fd, int off)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100178{
179#if defined(HA_HAVE_CAS_DW) || defined(HA_CAS_IS_8B)
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100180 volatile union {
181 struct fdlist_entry ent;
182 uint64_t u64;
183 uint32_t u32[2];
184 } cur_list, next_list;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100185#endif
186 int old;
187 int new = -2;
188 int prev;
189 int next;
190 int last;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100191lock_self:
192#if (defined(HA_CAS_IS_8B) || defined(HA_HAVE_CAS_DW))
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100193 next_list.ent.next = next_list.ent.prev = -2;
194 cur_list.ent = *(volatile struct fdlist_entry *)(((char *)&fdtab[fd]) + off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100195 /* First, attempt to lock our own entries */
196 do {
197 /* The FD is not in the FD cache, give up */
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100198 if (unlikely(cur_list.ent.next <= -3))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100199 return;
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100200 if (unlikely(cur_list.ent.prev == -2 || cur_list.ent.next == -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100201 goto lock_self;
202 } while (
203#ifdef HA_CAS_IS_8B
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100204 unlikely(!_HA_ATOMIC_CAS(((uint64_t *)&_GET_NEXT(fd, off)), (uint64_t *)&cur_list.u64, next_list.u64))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100205#else
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100206 unlikely(!_HA_ATOMIC_DWCAS(((long *)&_GET_NEXT(fd, off)), (uint32_t *)&cur_list.u32, &next_list.u32))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100207#endif
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100208 );
209 next = cur_list.ent.next;
210 prev = cur_list.ent.prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100211
212#else
213lock_self_next:
Willy Tarreau337fb712019-12-20 07:20:00 +0100214 next = _GET_NEXT(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100215 if (next == -2)
216 goto lock_self_next;
217 if (next <= -3)
218 goto done;
Olivier Houchardd3608792019-03-08 18:47:42 +0100219 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(fd, off), &next, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100220 goto lock_self_next;
221lock_self_prev:
Willy Tarreau337fb712019-12-20 07:20:00 +0100222 prev = _GET_PREV(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100223 if (prev == -2)
224 goto lock_self_prev;
Olivier Houchardd3608792019-03-08 18:47:42 +0100225 if (unlikely(!_HA_ATOMIC_CAS(&_GET_PREV(fd, off), &prev, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100226 goto lock_self_prev;
227#endif
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100228 __ha_barrier_atomic_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100229
230 /* Now, lock the entries of our neighbours */
231 if (likely(prev != -1)) {
232redo_prev:
233 old = fd;
234
Olivier Houchardd3608792019-03-08 18:47:42 +0100235 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(prev, off), &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100236 if (unlikely(old == -2)) {
237 /* Neighbour already locked, give up and
238 * retry again once he's done
239 */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200240 _GET_PREV(fd, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100241 __ha_barrier_store();
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200242 _GET_NEXT(fd, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100243 __ha_barrier_store();
244 goto lock_self;
245 }
246 goto redo_prev;
247 }
248 }
249 if (likely(next != -1)) {
250redo_next:
251 old = fd;
Olivier Houchardd3608792019-03-08 18:47:42 +0100252 if (unlikely(!_HA_ATOMIC_CAS(&_GET_PREV(next, off), &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100253 if (unlikely(old == -2)) {
254 /* Neighbour already locked, give up and
255 * retry again once he's done
256 */
257 if (prev != -1) {
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200258 _GET_NEXT(prev, off) = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100259 __ha_barrier_store();
260 }
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200261 _GET_PREV(fd, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100262 __ha_barrier_store();
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200263 _GET_NEXT(fd, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100264 __ha_barrier_store();
265 goto lock_self;
266 }
267 goto redo_next;
268 }
269 }
270 if (list->first == fd)
271 list->first = next;
272 __ha_barrier_store();
273 last = list->last;
Olivier Houchardd3608792019-03-08 18:47:42 +0100274 while (unlikely(last == fd && (!_HA_ATOMIC_CAS(&list->last, &last, prev))))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100275 __ha_compiler_barrier();
276 /* Make sure we let other threads know we're no longer in cache,
277 * before releasing our neighbours.
278 */
279 __ha_barrier_store();
280 if (likely(prev != -1))
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200281 _GET_NEXT(prev, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100282 __ha_barrier_store();
283 if (likely(next != -1))
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200284 _GET_PREV(next, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100285 __ha_barrier_store();
286 /* Ok, now we're out of the fd cache */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200287 _GET_NEXT(fd, off) = -(next + 4);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100288 __ha_barrier_store();
289done:
290 return;
291}
292
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200293#undef _GET_NEXT
294#undef _GET_PREV
295
Willy Tarreau173d9952018-01-26 21:48:23 +0100296/* Deletes an FD from the fdsets.
Willy Tarreau4f60f162007-04-08 16:39:58 +0200297 * The file descriptor is also closed.
298 */
Olivier Houchard1fc05162017-04-06 01:05:05 +0200299static void fd_dodelete(int fd, int do_close)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200300{
Olivier Houcharda7bf5732020-02-27 17:26:13 +0100301 int locked = fdtab[fd].running_mask != tid_bit;
Willy Tarreau87d54a92018-10-15 09:44:46 +0200302
Olivier Houchard88516642020-03-05 18:10:51 +0100303 /* We're just trying to protect against a concurrent fd_insert()
304 * here, not against fd_takeother(), because either we're called
305 * directly from the iocb(), and we're already locked, or we're
306 * called from the mux tasklet, but then the mux is responsible for
307 * making sure the tasklet does nothing, and the connection is never
308 * destroyed.
309 */
Willy Tarreau87d54a92018-10-15 09:44:46 +0200310 if (locked)
Olivier Houcharda7bf5732020-02-27 17:26:13 +0100311 fd_set_running_excl(fd);
312
Willy Tarreauad38ace2013-12-15 14:19:38 +0100313 if (fdtab[fd].linger_risk) {
314 /* this is generally set when connecting to servers */
Ilya Shipitsinb7e43f02020-04-02 15:02:08 +0500315 DISGUISE(setsockopt(fd, SOL_SOCKET, SO_LINGER,
316 (struct linger *) &nolinger, sizeof(struct linger)));
Willy Tarreauad38ace2013-12-15 14:19:38 +0100317 }
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100318 if (cur_poller.clo)
319 cur_poller.clo(fd);
Olivier Houchardc22580c2019-08-05 18:51:52 +0200320 polled_mask[fd].poll_recv = polled_mask[fd].poll_send = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100321
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100322 fdtab[fd].state = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100323
Willy Tarreau8d5d77e2009-10-18 07:25:52 +0200324 port_range_release_port(fdinfo[fd].port_range, fdinfo[fd].local_port);
325 fdinfo[fd].port_range = NULL;
Willy Tarreaudb3b3262012-07-05 23:19:22 +0200326 fdtab[fd].owner = NULL;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100327 fdtab[fd].thread_mask = 0;
Willy Tarreauc9c83782018-01-17 18:44:46 +0100328 if (do_close) {
Christopher Fauletd531f882017-06-01 16:55:03 +0200329 close(fd);
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200330 _HA_ATOMIC_SUB(&ha_used_fds, 1);
Willy Tarreauc9c83782018-01-17 18:44:46 +0100331 }
Willy Tarreau87d54a92018-10-15 09:44:46 +0200332 if (locked)
Olivier Houcharda7bf5732020-02-27 17:26:13 +0100333 fd_clr_running(fd);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200334}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200335
Olivier Houchard88516642020-03-05 18:10:51 +0100336#ifndef HA_HAVE_CAS_DW
Willy Tarreauaf613e82020-06-05 08:40:51 +0200337__decl_thread(__decl_rwlock(fd_mig_lock));
Olivier Houchard88516642020-03-05 18:10:51 +0100338#endif
339
340/*
341 * Take over a FD belonging to another thread.
342 * unexpected_conn is the expected owner of the fd.
343 * Returns 0 on success, and -1 on failure.
344 */
345int fd_takeover(int fd, void *expected_owner)
346{
347#ifndef HA_HAVE_CAS_DW
348 int ret;
349
350 HA_RWLOCK_WRLOCK(OTHER_LOCK, &fd_mig_lock);
351 _HA_ATOMIC_OR(&fdtab[fd].running_mask, tid_bit);
352 if (fdtab[fd].running_mask != tid_bit || fdtab[fd].owner != expected_owner) {
353 ret = -1;
354 _HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
355 goto end;
356 }
357 fdtab[fd].thread_mask = tid_bit;
358 _HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
359 ret = 0;
360end:
361 HA_RWLOCK_WRUNLOCK(OTHER_LOCK, &fd_mig_lock);
362 /* Make sure the FD doesn't have the active bit. It is possible that
363 * the fd is polled by the thread that used to own it, the new thread
364 * is supposed to call subscribe() later, to activate polling.
365 */
366 fd_stop_recv(fd);
367 return ret;
368#else
369 unsigned long old_masks[2];
370 unsigned long new_masks[2];
371
372 old_masks[0] = tid_bit;
373 old_masks[1] = fdtab[fd].thread_mask;
374 new_masks[0] = new_masks[1] = tid_bit;
375 /* protect ourself against a delete then an insert for the same fd,
376 * if it happens, then the owner will no longer be the expected
377 * connection.
378 */
379 _HA_ATOMIC_OR(&fdtab[fd].running_mask, tid_bit);
380 if (fdtab[fd].owner != expected_owner) {
381 _HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
382 return -1;
383 }
384 do {
385 if (old_masks[0] != tid_bit || !old_masks[1]) {
386 _HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
387 return -1;
388 }
389 } while (!(_HA_ATOMIC_DWCAS(&fdtab[fd].running_mask, &old_masks,
390 &new_masks)));
391 _HA_ATOMIC_AND(&fdtab[fd].running_mask, ~tid_bit);
392 return 0;
393#endif /* HW_HAVE_CAS_DW */
394}
395
Willy Tarreau173d9952018-01-26 21:48:23 +0100396/* Deletes an FD from the fdsets.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200397 * The file descriptor is also closed.
398 */
399void fd_delete(int fd)
400{
401 fd_dodelete(fd, 1);
402}
403
Willy Tarreau173d9952018-01-26 21:48:23 +0100404/* Deletes an FD from the fdsets.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200405 * The file descriptor is kept open.
406 */
407void fd_remove(int fd)
408{
409 fd_dodelete(fd, 0);
410}
411
Willy Tarreaudbe30602019-09-04 13:25:41 +0200412void updt_fd_polling(const int fd)
413{
414 if ((fdtab[fd].thread_mask & all_threads_mask) == tid_bit) {
415
416 /* note: we don't have a test-and-set yet in hathreads */
417
418 if (HA_ATOMIC_BTS(&fdtab[fd].update_mask, tid))
419 return;
420
421 fd_updt[fd_nbupdt++] = fd;
422 } else {
423 unsigned long update_mask = fdtab[fd].update_mask;
424 do {
425 if (update_mask == fdtab[fd].thread_mask)
426 return;
427 } while (!_HA_ATOMIC_CAS(&fdtab[fd].update_mask, &update_mask,
428 fdtab[fd].thread_mask));
429 fd_add_to_fd_list(&update_list, fd, offsetof(struct fdtab, update));
430 }
431}
432
Olivier Houchard7fa55622020-02-27 17:25:43 +0100433__decl_spinlock(log_lock);
Willy Tarreau931d8b72019-08-27 11:08:17 +0200434/* Tries to send <npfx> parts from <prefix> followed by <nmsg> parts from <msg>
435 * optionally followed by a newline if <nl> is non-null, to file descriptor
436 * <fd>. The message is sent atomically using writev(). It may be truncated to
437 * <maxlen> bytes if <maxlen> is non-null. There is no distinction between the
438 * two lists, it's just a convenience to help the caller prepend some prefixes
439 * when necessary. It takes the fd's lock to make sure no other thread will
440 * write to the same fd in parallel. Returns the number of bytes sent, or <=0
441 * on failure. A limit to 31 total non-empty segments is enforced. The caller
442 * is responsible for taking care of making the fd non-blocking.
443 */
444ssize_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)
445{
446 struct iovec iovec[32];
447 size_t totlen = 0;
448 size_t sent = 0;
449 int vec = 0;
450
451 if (!maxlen)
452 maxlen = ~0;
453
454 /* keep one char for a possible trailing '\n' in any case */
455 maxlen--;
456
457 /* make an iovec from the concatenation of all parts of the original
458 * message. Skip empty fields and truncate the whole message to maxlen,
459 * leaving one spare iovec for the '\n'.
460 */
461 while (vec < (sizeof(iovec) / sizeof(iovec[0]) - 1)) {
462 if (!npfx) {
463 pfx = msg;
464 npfx = nmsg;
465 nmsg = 0;
466 if (!npfx)
467 break;
468 }
469
470 iovec[vec].iov_base = pfx->ptr;
471 iovec[vec].iov_len = MIN(maxlen, pfx->len);
472 maxlen -= iovec[vec].iov_len;
473 totlen += iovec[vec].iov_len;
474 if (iovec[vec].iov_len)
475 vec++;
476 pfx++; npfx--;
477 };
478
479 if (nl) {
480 iovec[vec].iov_base = "\n";
481 iovec[vec].iov_len = 1;
482 vec++;
483 }
484
Willy Tarreau7e9776a2019-08-30 14:41:47 +0200485 if (unlikely(!fdtab[fd].initialized)) {
486 fdtab[fd].initialized = 1;
487 if (!isatty(fd))
488 fcntl(fd, F_SETFL, O_NONBLOCK);
489 }
490
Olivier Houchard7fa55622020-02-27 17:25:43 +0100491 HA_SPIN_LOCK(OTHER_LOCK, &log_lock);
Willy Tarreau931d8b72019-08-27 11:08:17 +0200492 sent = writev(fd, iovec, vec);
Olivier Houchard7fa55622020-02-27 17:25:43 +0100493 HA_SPIN_UNLOCK(OTHER_LOCK, &log_lock);
Willy Tarreau931d8b72019-08-27 11:08:17 +0200494
495 /* sent > 0 if the message was delivered */
496 return sent;
497}
498
Olivier Houchard2292edf2019-02-25 14:26:54 +0100499#if defined(USE_CLOSEFROM)
500void my_closefrom(int start)
501{
502 closefrom(start);
503}
504
Willy Tarreaue5733232019-05-22 19:24:06 +0200505#elif defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100506/* This is a portable implementation of closefrom(). It closes all open file
507 * descriptors starting at <start> and above. It relies on the fact that poll()
508 * will return POLLNVAL for each invalid (hence close) file descriptor passed
509 * in argument in order to skip them. It acts with batches of FDs and will
510 * typically perform one poll() call per 1024 FDs so the overhead is low in
511 * case all FDs have to be closed.
512 */
513void my_closefrom(int start)
514{
515 struct pollfd poll_events[1024];
516 struct rlimit limit;
517 int nbfds, fd, ret, idx;
518 int step, next;
519
520 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
521 step = nbfds = limit.rlim_cur;
522 else
523 step = nbfds = 0;
524
525 if (nbfds <= 0) {
526 /* set safe limit */
527 nbfds = 1024;
528 step = 256;
529 }
530
531 if (step > sizeof(poll_events) / sizeof(poll_events[0]))
532 step = sizeof(poll_events) / sizeof(poll_events[0]);
533
534 while (start < nbfds) {
535 next = (start / step + 1) * step;
536
537 for (fd = start; fd < next && fd < nbfds; fd++) {
538 poll_events[fd - start].fd = fd;
539 poll_events[fd - start].events = 0;
540 }
541
542 do {
543 ret = poll(poll_events, fd - start, 0);
544 if (ret >= 0)
545 break;
546 } while (errno == EAGAIN || errno == EINTR || errno == ENOMEM);
547
Willy Tarreaub8e602c2019-02-22 09:07:42 +0100548 if (ret)
549 ret = fd - start;
550
Willy Tarreau9188ac62019-02-21 22:12:47 +0100551 for (idx = 0; idx < ret; idx++) {
552 if (poll_events[idx].revents & POLLNVAL)
553 continue; /* already closed */
554
555 fd = poll_events[idx].fd;
556 close(fd);
557 }
558 start = next;
559 }
560}
561
Willy Tarreaue5733232019-05-22 19:24:06 +0200562#else // defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100563
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100564/* This is a portable implementation of closefrom(). It closes all open file
565 * descriptors starting at <start> and above. This is a naive version for use
566 * when the operating system provides no alternative.
567 */
568void my_closefrom(int start)
569{
570 struct rlimit limit;
571 int nbfds;
572
573 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
574 nbfds = limit.rlim_cur;
575 else
576 nbfds = 0;
577
578 if (nbfds <= 0)
579 nbfds = 1024; /* safe limit */
580
581 while (start < nbfds)
582 close(start++);
583}
Willy Tarreaue5733232019-05-22 19:24:06 +0200584#endif // defined(USE_POLL)
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100585
Willy Tarreau4f60f162007-04-08 16:39:58 +0200586/* disable the specified poller */
587void disable_poller(const char *poller_name)
588{
589 int p;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200590
Willy Tarreau4f60f162007-04-08 16:39:58 +0200591 for (p = 0; p < nbpollers; p++)
592 if (strcmp(pollers[p].name, poller_name) == 0)
593 pollers[p].pref = 0;
594}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200595
Olivier Houchard79321b92018-07-26 17:55:11 +0200596void poller_pipe_io_handler(int fd)
597{
598 char buf[1024];
599 /* Flush the pipe */
600 while (read(fd, buf, sizeof(buf)) > 0);
601 fd_cant_recv(fd);
602}
603
Willy Tarreau082b6282019-05-22 14:42:12 +0200604/* allocate the per-thread fd_updt thus needs to be called early after
605 * thread creation.
606 */
607static int alloc_pollers_per_thread()
608{
609 fd_updt = calloc(global.maxsock, sizeof(*fd_updt));
610 return fd_updt != NULL;
611}
612
613/* Initialize the pollers per thread.*/
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200614static int init_pollers_per_thread()
615{
Olivier Houchard79321b92018-07-26 17:55:11 +0200616 int mypipe[2];
Willy Tarreau082b6282019-05-22 14:42:12 +0200617
618 if (pipe(mypipe) < 0)
Olivier Houchard79321b92018-07-26 17:55:11 +0200619 return 0;
Willy Tarreau082b6282019-05-22 14:42:12 +0200620
Olivier Houchard79321b92018-07-26 17:55:11 +0200621 poller_rd_pipe = mypipe[0];
622 poller_wr_pipe[tid] = mypipe[1];
623 fcntl(poller_rd_pipe, F_SETFL, O_NONBLOCK);
624 fd_insert(poller_rd_pipe, poller_pipe_io_handler, poller_pipe_io_handler,
625 tid_bit);
626 fd_want_recv(poller_rd_pipe);
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200627 return 1;
628}
629
630/* Deinitialize the pollers per thread */
631static void deinit_pollers_per_thread()
632{
William Lallemand808e1b72018-12-15 22:34:31 +0100633 /* rd and wr are init at the same place, but only rd is init to -1, so
634 we rely to rd to close. */
635 if (poller_rd_pipe > -1) {
636 close(poller_rd_pipe);
637 poller_rd_pipe = -1;
638 close(poller_wr_pipe[tid]);
639 poller_wr_pipe[tid] = -1;
640 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200641}
642
Willy Tarreau082b6282019-05-22 14:42:12 +0200643/* Release the pollers per thread, to be called late */
644static void free_pollers_per_thread()
645{
646 free(fd_updt);
647 fd_updt = NULL;
648}
649
Willy Tarreaubaaee002006-06-26 02:48:02 +0200650/*
Willy Tarreau4f60f162007-04-08 16:39:58 +0200651 * Initialize the pollers till the best one is found.
652 * If none works, returns 0, otherwise 1.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200653 */
Willy Tarreau4f60f162007-04-08 16:39:58 +0200654int init_pollers()
Willy Tarreaubaaee002006-06-26 02:48:02 +0200655{
Willy Tarreau4f60f162007-04-08 16:39:58 +0200656 int p;
657 struct poller *bp;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200658
Christopher Faulet63fe6522017-08-31 17:52:09 +0200659 if ((fdtab = calloc(global.maxsock, sizeof(struct fdtab))) == NULL)
660 goto fail_tab;
661
Olivier Houchard53055052019-07-25 14:00:18 +0000662 if ((polled_mask = calloc(global.maxsock, sizeof(*polled_mask))) == NULL)
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200663 goto fail_polledmask;
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000664
Christopher Faulet63fe6522017-08-31 17:52:09 +0200665 if ((fdinfo = calloc(global.maxsock, sizeof(struct fdinfo))) == NULL)
666 goto fail_info;
667
Olivier Houchard6b96f722018-04-25 16:58:25 +0200668 update_list.first = update_list.last = -1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200669
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100670 for (p = 0; p < global.maxsock; p++) {
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100671 /* Mark the fd as out of the fd cache */
Olivier Houchard6b96f722018-04-25 16:58:25 +0200672 fdtab[p].update.next = -3;
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100673 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200674
Willy Tarreau4f60f162007-04-08 16:39:58 +0200675 do {
676 bp = NULL;
677 for (p = 0; p < nbpollers; p++)
678 if (!bp || (pollers[p].pref > bp->pref))
679 bp = &pollers[p];
Willy Tarreaubaaee002006-06-26 02:48:02 +0200680
Willy Tarreau4f60f162007-04-08 16:39:58 +0200681 if (!bp || bp->pref == 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200682 break;
683
Willy Tarreau4f60f162007-04-08 16:39:58 +0200684 if (bp->init(bp)) {
685 memcpy(&cur_poller, bp, sizeof(*bp));
686 return 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200687 }
Willy Tarreau4f60f162007-04-08 16:39:58 +0200688 } while (!bp || bp->pref == 0);
Willy Tarreau7be79a42012-11-11 15:02:54 +0100689
Christopher Faulet63fe6522017-08-31 17:52:09 +0200690 free(fdinfo);
691 fail_info:
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200692 free(polled_mask);
693 fail_polledmask:
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000694 free(fdtab);
695 fail_tab:
Willy Tarreau7be79a42012-11-11 15:02:54 +0100696 return 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200697}
698
Willy Tarreaubaaee002006-06-26 02:48:02 +0200699/*
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200700 * Deinitialize the pollers.
701 */
702void deinit_pollers() {
703
704 struct poller *bp;
705 int p;
706
707 for (p = 0; p < nbpollers; p++) {
708 bp = &pollers[p];
709
710 if (bp && bp->pref)
711 bp->term(bp);
712 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200713
Christopher Faulet63fe6522017-08-31 17:52:09 +0200714 free(fdinfo); fdinfo = NULL;
715 free(fdtab); fdtab = NULL;
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200716 free(polled_mask); polled_mask = NULL;
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200717}
718
719/*
Willy Tarreau2ff76222007-04-09 19:29:56 +0200720 * Lists the known pollers on <out>.
721 * Should be performed only before initialization.
722 */
723int list_pollers(FILE *out)
724{
725 int p;
726 int last, next;
727 int usable;
728 struct poller *bp;
729
730 fprintf(out, "Available polling systems :\n");
731
732 usable = 0;
733 bp = NULL;
734 last = next = -1;
735 while (1) {
736 for (p = 0; p < nbpollers; p++) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200737 if ((next < 0 || pollers[p].pref > next)
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100738 && (last < 0 || pollers[p].pref < last)) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200739 next = pollers[p].pref;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100740 if (!bp || (pollers[p].pref > bp->pref))
741 bp = &pollers[p];
742 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200743 }
744
745 if (next == -1)
746 break;
747
748 for (p = 0; p < nbpollers; p++) {
749 if (pollers[p].pref == next) {
750 fprintf(out, " %10s : ", pollers[p].name);
751 if (pollers[p].pref == 0)
752 fprintf(out, "disabled, ");
753 else
754 fprintf(out, "pref=%3d, ", pollers[p].pref);
755 if (pollers[p].test(&pollers[p])) {
756 fprintf(out, " test result OK");
757 if (next > 0)
758 usable++;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100759 } else {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200760 fprintf(out, " test result FAILED");
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100761 if (bp == &pollers[p])
762 bp = NULL;
763 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200764 fprintf(out, "\n");
765 }
766 }
767 last = next;
768 next = -1;
769 };
770 fprintf(out, "Total: %d (%d usable), will use %s.\n", nbpollers, usable, bp ? bp->name : "none");
771 return 0;
772}
773
774/*
775 * Some pollers may lose their connection after a fork(). It may be necessary
776 * to create initialize part of them again. Returns 0 in case of failure,
777 * otherwise 1. The fork() function may be NULL if unused. In case of error,
778 * the the current poller is destroyed and the caller is responsible for trying
779 * another one by calling init_pollers() again.
780 */
781int fork_poller()
782{
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200783 int fd;
Willy Tarreauce036bc2018-01-29 14:58:02 +0100784 for (fd = 0; fd < global.maxsock; fd++) {
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200785 if (fdtab[fd].owner) {
786 fdtab[fd].cloned = 1;
787 }
788 }
789
Willy Tarreau2ff76222007-04-09 19:29:56 +0200790 if (cur_poller.fork) {
791 if (cur_poller.fork(&cur_poller))
792 return 1;
793 cur_poller.term(&cur_poller);
794 return 0;
795 }
796 return 1;
797}
798
Willy Tarreau082b6282019-05-22 14:42:12 +0200799REGISTER_PER_THREAD_ALLOC(alloc_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +0100800REGISTER_PER_THREAD_INIT(init_pollers_per_thread);
801REGISTER_PER_THREAD_DEINIT(deinit_pollers_per_thread);
Willy Tarreau082b6282019-05-22 14:42:12 +0200802REGISTER_PER_THREAD_FREE(free_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +0100803
Willy Tarreau2ff76222007-04-09 19:29:56 +0200804/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200805 * Local variables:
806 * c-indent-level: 8
807 * c-basic-offset: 8
808 * End:
809 */