blob: 8eea0f5e9c17367ffae3a02717dd664eb78a1baf [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 Tarreau2dd0d472006-06-29 17:53:05 +020090#include <common/compat.h>
91#include <common/config.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020092
Willy Tarreau7be79a42012-11-11 15:02:54 +010093#include <types/global.h>
94
Willy Tarreau2a429502006-10-15 14:52:29 +020095#include <proto/fd.h>
Christopher Fauletd4604ad2017-05-29 10:40:41 +020096#include <proto/log.h>
Willy Tarreauc6f4ce82009-06-10 11:09:37 +020097#include <proto/port_range.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020098
99struct fdtab *fdtab = NULL; /* array of all the file descriptors */
Olivier Houchard53055052019-07-25 14:00:18 +0000100struct polled_mask *polled_mask = NULL; /* Array for the polled_mask of each fd */
Willy Tarreau8d5d77e2009-10-18 07:25:52 +0200101struct fdinfo *fdinfo = NULL; /* less-often used infos for file descriptors */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200102int totalconn; /* total # of terminated sessions */
103int actconn; /* # of active sessions */
104
Willy Tarreau4f60f162007-04-08 16:39:58 +0200105struct poller pollers[MAX_POLLERS];
106struct poller cur_poller;
107int nbpollers = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200108
Olivier Houchard6b96f722018-04-25 16:58:25 +0200109volatile struct fdlist update_list; // Global update list
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100110
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200111THREAD_LOCAL int *fd_updt = NULL; // FD updates list
112THREAD_LOCAL int fd_nbupdt = 0; // number of updates in the list
Olivier Houchard79321b92018-07-26 17:55:11 +0200113THREAD_LOCAL int poller_rd_pipe = -1; // Pipe to wake the thread
114int poller_wr_pipe[MAX_THREADS]; // Pipe to wake the threads
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200115
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200116volatile int ha_used_fds = 0; // Number of FD we're currently using
117
Willy Tarreau337fb712019-12-20 07:20:00 +0100118#define _GET_NEXT(fd, off) ((volatile struct fdlist_entry *)(void *)((char *)(&fdtab[fd]) + off))->next
119#define _GET_PREV(fd, off) ((volatile struct fdlist_entry *)(void *)((char *)(&fdtab[fd]) + off))->prev
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100120/* adds fd <fd> to fd list <list> if it was not yet in it */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200121void fd_add_to_fd_list(volatile struct fdlist *list, int fd, int off)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100122{
123 int next;
124 int new;
125 int old;
126 int last;
127
128redo_next:
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200129 next = _GET_NEXT(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100130 /* Check that we're not already in the cache, and if not, lock us. */
Olivier Houchardfc51f0f52019-12-19 18:33:08 +0100131 if (next > -2)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100132 goto done;
Olivier Houchardfc51f0f52019-12-19 18:33:08 +0100133 if (next == -2)
134 goto redo_next;
Olivier Houchardd3608792019-03-08 18:47:42 +0100135 if (!_HA_ATOMIC_CAS(&_GET_NEXT(fd, off), &next, -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100136 goto redo_next;
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100137 __ha_barrier_atomic_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100138
139 new = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100140redo_last:
141 /* First, insert in the linked list */
142 last = list->last;
143 old = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100144
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200145 _GET_PREV(fd, off) = -2;
Willy Tarreau11559a72018-02-05 17:52:24 +0100146 /* Make sure the "prev" store is visible before we update the last entry */
147 __ha_barrier_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100148
Willy Tarreau11559a72018-02-05 17:52:24 +0100149 if (unlikely(last == -1)) {
150 /* list is empty, try to add ourselves alone so that list->last=fd */
Olivier Houchardd3608792019-03-08 18:47:42 +0100151 if (unlikely(!_HA_ATOMIC_CAS(&list->last, &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100152 goto redo_last;
153
154 /* list->first was necessary -1, we're guaranteed to be alone here */
155 list->first = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100156 } else {
Willy Tarreau11559a72018-02-05 17:52:24 +0100157 /* adding ourselves past the last element
158 * The CAS will only succeed if its next is -1,
159 * which means it's in the cache, and the last element.
160 */
Olivier Houchardd3608792019-03-08 18:47:42 +0100161 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(last, off), &old, new)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100162 goto redo_last;
Willy Tarreau11559a72018-02-05 17:52:24 +0100163
164 /* Then, update the last entry */
165 list->last = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100166 }
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100167 __ha_barrier_store();
Willy Tarreau11559a72018-02-05 17:52:24 +0100168 /* since we're alone at the end of the list and still locked(-2),
169 * we know noone tried to add past us. Mark the end of list.
170 */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200171 _GET_PREV(fd, off) = last;
172 _GET_NEXT(fd, off) = -1;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100173 __ha_barrier_store();
174done:
175 return;
176}
177
178/* removes fd <fd> from fd list <list> */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200179void fd_rm_from_fd_list(volatile struct fdlist *list, int fd, int off)
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100180{
181#if defined(HA_HAVE_CAS_DW) || defined(HA_CAS_IS_8B)
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100182 volatile union {
183 struct fdlist_entry ent;
184 uint64_t u64;
185 uint32_t u32[2];
186 } cur_list, next_list;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100187#endif
188 int old;
189 int new = -2;
190 int prev;
191 int next;
192 int last;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100193lock_self:
194#if (defined(HA_CAS_IS_8B) || defined(HA_HAVE_CAS_DW))
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100195 next_list.ent.next = next_list.ent.prev = -2;
196 cur_list.ent = *(volatile struct fdlist_entry *)(((char *)&fdtab[fd]) + off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100197 /* First, attempt to lock our own entries */
198 do {
199 /* The FD is not in the FD cache, give up */
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100200 if (unlikely(cur_list.ent.next <= -3))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100201 return;
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100202 if (unlikely(cur_list.ent.prev == -2 || cur_list.ent.next == -2))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100203 goto lock_self;
204 } while (
205#ifdef HA_CAS_IS_8B
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100206 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 +0100207#else
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100208 unlikely(!_HA_ATOMIC_DWCAS(((long *)&_GET_NEXT(fd, off)), (uint32_t *)&cur_list.u32, &next_list.u32))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100209#endif
Willy Tarreau2b9f0662020-02-25 09:25:53 +0100210 );
211 next = cur_list.ent.next;
212 prev = cur_list.ent.prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100213
214#else
215lock_self_next:
Willy Tarreau337fb712019-12-20 07:20:00 +0100216 next = _GET_NEXT(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100217 if (next == -2)
218 goto lock_self_next;
219 if (next <= -3)
220 goto done;
Olivier Houchardd3608792019-03-08 18:47:42 +0100221 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(fd, off), &next, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100222 goto lock_self_next;
223lock_self_prev:
Willy Tarreau337fb712019-12-20 07:20:00 +0100224 prev = _GET_PREV(fd, off);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100225 if (prev == -2)
226 goto lock_self_prev;
Olivier Houchardd3608792019-03-08 18:47:42 +0100227 if (unlikely(!_HA_ATOMIC_CAS(&_GET_PREV(fd, off), &prev, -2)))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100228 goto lock_self_prev;
229#endif
Olivier Houchardd2b5d162019-03-08 13:47:21 +0100230 __ha_barrier_atomic_store();
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100231
232 /* Now, lock the entries of our neighbours */
233 if (likely(prev != -1)) {
234redo_prev:
235 old = fd;
236
Olivier Houchardd3608792019-03-08 18:47:42 +0100237 if (unlikely(!_HA_ATOMIC_CAS(&_GET_NEXT(prev, off), &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100238 if (unlikely(old == -2)) {
239 /* Neighbour already locked, give up and
240 * retry again once he's done
241 */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200242 _GET_PREV(fd, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100243 __ha_barrier_store();
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200244 _GET_NEXT(fd, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100245 __ha_barrier_store();
246 goto lock_self;
247 }
248 goto redo_prev;
249 }
250 }
251 if (likely(next != -1)) {
252redo_next:
253 old = fd;
Olivier Houchardd3608792019-03-08 18:47:42 +0100254 if (unlikely(!_HA_ATOMIC_CAS(&_GET_PREV(next, off), &old, new))) {
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100255 if (unlikely(old == -2)) {
256 /* Neighbour already locked, give up and
257 * retry again once he's done
258 */
259 if (prev != -1) {
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200260 _GET_NEXT(prev, off) = fd;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100261 __ha_barrier_store();
262 }
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200263 _GET_PREV(fd, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100264 __ha_barrier_store();
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200265 _GET_NEXT(fd, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100266 __ha_barrier_store();
267 goto lock_self;
268 }
269 goto redo_next;
270 }
271 }
272 if (list->first == fd)
273 list->first = next;
274 __ha_barrier_store();
275 last = list->last;
Olivier Houchardd3608792019-03-08 18:47:42 +0100276 while (unlikely(last == fd && (!_HA_ATOMIC_CAS(&list->last, &last, prev))))
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100277 __ha_compiler_barrier();
278 /* Make sure we let other threads know we're no longer in cache,
279 * before releasing our neighbours.
280 */
281 __ha_barrier_store();
282 if (likely(prev != -1))
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200283 _GET_NEXT(prev, off) = next;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100284 __ha_barrier_store();
285 if (likely(next != -1))
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200286 _GET_PREV(next, off) = prev;
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100287 __ha_barrier_store();
288 /* Ok, now we're out of the fd cache */
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200289 _GET_NEXT(fd, off) = -(next + 4);
Willy Tarreau4cc67a22018-02-05 17:14:55 +0100290 __ha_barrier_store();
291done:
292 return;
293}
294
Olivier Houchard6a2cf872018-04-25 15:10:30 +0200295#undef _GET_NEXT
296#undef _GET_PREV
297
Willy Tarreau173d9952018-01-26 21:48:23 +0100298/* Deletes an FD from the fdsets.
Willy Tarreau4f60f162007-04-08 16:39:58 +0200299 * The file descriptor is also closed.
300 */
Olivier Houchard1fc05162017-04-06 01:05:05 +0200301static void fd_dodelete(int fd, int do_close)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200302{
Willy Tarreau87d54a92018-10-15 09:44:46 +0200303 unsigned long locked = atleast2(fdtab[fd].thread_mask);
304
305 if (locked)
306 HA_SPIN_LOCK(FD_LOCK, &fdtab[fd].lock);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100307 if (fdtab[fd].linger_risk) {
308 /* this is generally set when connecting to servers */
309 setsockopt(fd, SOL_SOCKET, SO_LINGER,
310 (struct linger *) &nolinger, sizeof(struct linger));
311 }
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100312 if (cur_poller.clo)
313 cur_poller.clo(fd);
Olivier Houchardc22580c2019-08-05 18:51:52 +0200314 polled_mask[fd].poll_recv = polled_mask[fd].poll_send = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100315
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100316 fdtab[fd].state = 0;
Willy Tarreau6ea20b12012-11-11 16:05:19 +0100317
Willy Tarreau8d5d77e2009-10-18 07:25:52 +0200318 port_range_release_port(fdinfo[fd].port_range, fdinfo[fd].local_port);
319 fdinfo[fd].port_range = NULL;
Willy Tarreaudb3b3262012-07-05 23:19:22 +0200320 fdtab[fd].owner = NULL;
Willy Tarreauf65610a2017-10-31 16:06:06 +0100321 fdtab[fd].thread_mask = 0;
Willy Tarreauc9c83782018-01-17 18:44:46 +0100322 if (do_close) {
Christopher Fauletd531f882017-06-01 16:55:03 +0200323 close(fd);
Olivier Houchard7c49d2e2019-04-16 18:37:05 +0200324 _HA_ATOMIC_SUB(&ha_used_fds, 1);
Willy Tarreauc9c83782018-01-17 18:44:46 +0100325 }
Willy Tarreau87d54a92018-10-15 09:44:46 +0200326 if (locked)
327 HA_SPIN_UNLOCK(FD_LOCK, &fdtab[fd].lock);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200328}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200329
Willy Tarreau173d9952018-01-26 21:48:23 +0100330/* Deletes an FD from the fdsets.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200331 * The file descriptor is also closed.
332 */
333void fd_delete(int fd)
334{
335 fd_dodelete(fd, 1);
336}
337
Willy Tarreau173d9952018-01-26 21:48:23 +0100338/* Deletes an FD from the fdsets.
Olivier Houchard1fc05162017-04-06 01:05:05 +0200339 * The file descriptor is kept open.
340 */
341void fd_remove(int fd)
342{
343 fd_dodelete(fd, 0);
344}
345
Willy Tarreaudbe30602019-09-04 13:25:41 +0200346void updt_fd_polling(const int fd)
347{
348 if ((fdtab[fd].thread_mask & all_threads_mask) == tid_bit) {
349
350 /* note: we don't have a test-and-set yet in hathreads */
351
352 if (HA_ATOMIC_BTS(&fdtab[fd].update_mask, tid))
353 return;
354
355 fd_updt[fd_nbupdt++] = fd;
356 } else {
357 unsigned long update_mask = fdtab[fd].update_mask;
358 do {
359 if (update_mask == fdtab[fd].thread_mask)
360 return;
361 } while (!_HA_ATOMIC_CAS(&fdtab[fd].update_mask, &update_mask,
362 fdtab[fd].thread_mask));
363 fd_add_to_fd_list(&update_list, fd, offsetof(struct fdtab, update));
364 }
365}
366
Willy Tarreau931d8b72019-08-27 11:08:17 +0200367/* Tries to send <npfx> parts from <prefix> followed by <nmsg> parts from <msg>
368 * optionally followed by a newline if <nl> is non-null, to file descriptor
369 * <fd>. The message is sent atomically using writev(). It may be truncated to
370 * <maxlen> bytes if <maxlen> is non-null. There is no distinction between the
371 * two lists, it's just a convenience to help the caller prepend some prefixes
372 * when necessary. It takes the fd's lock to make sure no other thread will
373 * write to the same fd in parallel. Returns the number of bytes sent, or <=0
374 * on failure. A limit to 31 total non-empty segments is enforced. The caller
375 * is responsible for taking care of making the fd non-blocking.
376 */
377ssize_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)
378{
379 struct iovec iovec[32];
380 size_t totlen = 0;
381 size_t sent = 0;
382 int vec = 0;
383
384 if (!maxlen)
385 maxlen = ~0;
386
387 /* keep one char for a possible trailing '\n' in any case */
388 maxlen--;
389
390 /* make an iovec from the concatenation of all parts of the original
391 * message. Skip empty fields and truncate the whole message to maxlen,
392 * leaving one spare iovec for the '\n'.
393 */
394 while (vec < (sizeof(iovec) / sizeof(iovec[0]) - 1)) {
395 if (!npfx) {
396 pfx = msg;
397 npfx = nmsg;
398 nmsg = 0;
399 if (!npfx)
400 break;
401 }
402
403 iovec[vec].iov_base = pfx->ptr;
404 iovec[vec].iov_len = MIN(maxlen, pfx->len);
405 maxlen -= iovec[vec].iov_len;
406 totlen += iovec[vec].iov_len;
407 if (iovec[vec].iov_len)
408 vec++;
409 pfx++; npfx--;
410 };
411
412 if (nl) {
413 iovec[vec].iov_base = "\n";
414 iovec[vec].iov_len = 1;
415 vec++;
416 }
417
Willy Tarreau7e9776a2019-08-30 14:41:47 +0200418 if (unlikely(!fdtab[fd].initialized)) {
419 fdtab[fd].initialized = 1;
420 if (!isatty(fd))
421 fcntl(fd, F_SETFL, O_NONBLOCK);
422 }
423
Willy Tarreau931d8b72019-08-27 11:08:17 +0200424 HA_SPIN_LOCK(FD_LOCK, &fdtab[fd].lock);
425 sent = writev(fd, iovec, vec);
426 HA_SPIN_UNLOCK(FD_LOCK, &fdtab[fd].lock);
427
428 /* sent > 0 if the message was delivered */
429 return sent;
430}
431
Olivier Houchard2292edf2019-02-25 14:26:54 +0100432#if defined(USE_CLOSEFROM)
433void my_closefrom(int start)
434{
435 closefrom(start);
436}
437
Willy Tarreaue5733232019-05-22 19:24:06 +0200438#elif defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100439/* This is a portable implementation of closefrom(). It closes all open file
440 * descriptors starting at <start> and above. It relies on the fact that poll()
441 * will return POLLNVAL for each invalid (hence close) file descriptor passed
442 * in argument in order to skip them. It acts with batches of FDs and will
443 * typically perform one poll() call per 1024 FDs so the overhead is low in
444 * case all FDs have to be closed.
445 */
446void my_closefrom(int start)
447{
448 struct pollfd poll_events[1024];
449 struct rlimit limit;
450 int nbfds, fd, ret, idx;
451 int step, next;
452
453 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
454 step = nbfds = limit.rlim_cur;
455 else
456 step = nbfds = 0;
457
458 if (nbfds <= 0) {
459 /* set safe limit */
460 nbfds = 1024;
461 step = 256;
462 }
463
464 if (step > sizeof(poll_events) / sizeof(poll_events[0]))
465 step = sizeof(poll_events) / sizeof(poll_events[0]);
466
467 while (start < nbfds) {
468 next = (start / step + 1) * step;
469
470 for (fd = start; fd < next && fd < nbfds; fd++) {
471 poll_events[fd - start].fd = fd;
472 poll_events[fd - start].events = 0;
473 }
474
475 do {
476 ret = poll(poll_events, fd - start, 0);
477 if (ret >= 0)
478 break;
479 } while (errno == EAGAIN || errno == EINTR || errno == ENOMEM);
480
Willy Tarreaub8e602c2019-02-22 09:07:42 +0100481 if (ret)
482 ret = fd - start;
483
Willy Tarreau9188ac62019-02-21 22:12:47 +0100484 for (idx = 0; idx < ret; idx++) {
485 if (poll_events[idx].revents & POLLNVAL)
486 continue; /* already closed */
487
488 fd = poll_events[idx].fd;
489 close(fd);
490 }
491 start = next;
492 }
493}
494
Willy Tarreaue5733232019-05-22 19:24:06 +0200495#else // defined(USE_POLL)
Willy Tarreau9188ac62019-02-21 22:12:47 +0100496
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100497/* This is a portable implementation of closefrom(). It closes all open file
498 * descriptors starting at <start> and above. This is a naive version for use
499 * when the operating system provides no alternative.
500 */
501void my_closefrom(int start)
502{
503 struct rlimit limit;
504 int nbfds;
505
506 if (getrlimit(RLIMIT_NOFILE, &limit) == 0)
507 nbfds = limit.rlim_cur;
508 else
509 nbfds = 0;
510
511 if (nbfds <= 0)
512 nbfds = 1024; /* safe limit */
513
514 while (start < nbfds)
515 close(start++);
516}
Willy Tarreaue5733232019-05-22 19:24:06 +0200517#endif // defined(USE_POLL)
Willy Tarreau2d7f81b2019-02-21 22:19:17 +0100518
Willy Tarreau4f60f162007-04-08 16:39:58 +0200519/* disable the specified poller */
520void disable_poller(const char *poller_name)
521{
522 int p;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200523
Willy Tarreau4f60f162007-04-08 16:39:58 +0200524 for (p = 0; p < nbpollers; p++)
525 if (strcmp(pollers[p].name, poller_name) == 0)
526 pollers[p].pref = 0;
527}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200528
Olivier Houchard79321b92018-07-26 17:55:11 +0200529void poller_pipe_io_handler(int fd)
530{
531 char buf[1024];
532 /* Flush the pipe */
533 while (read(fd, buf, sizeof(buf)) > 0);
534 fd_cant_recv(fd);
535}
536
Willy Tarreau082b6282019-05-22 14:42:12 +0200537/* allocate the per-thread fd_updt thus needs to be called early after
538 * thread creation.
539 */
540static int alloc_pollers_per_thread()
541{
542 fd_updt = calloc(global.maxsock, sizeof(*fd_updt));
543 return fd_updt != NULL;
544}
545
546/* Initialize the pollers per thread.*/
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200547static int init_pollers_per_thread()
548{
Olivier Houchard79321b92018-07-26 17:55:11 +0200549 int mypipe[2];
Willy Tarreau082b6282019-05-22 14:42:12 +0200550
551 if (pipe(mypipe) < 0)
Olivier Houchard79321b92018-07-26 17:55:11 +0200552 return 0;
Willy Tarreau082b6282019-05-22 14:42:12 +0200553
Olivier Houchard79321b92018-07-26 17:55:11 +0200554 poller_rd_pipe = mypipe[0];
555 poller_wr_pipe[tid] = mypipe[1];
556 fcntl(poller_rd_pipe, F_SETFL, O_NONBLOCK);
557 fd_insert(poller_rd_pipe, poller_pipe_io_handler, poller_pipe_io_handler,
558 tid_bit);
559 fd_want_recv(poller_rd_pipe);
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200560 return 1;
561}
562
563/* Deinitialize the pollers per thread */
564static void deinit_pollers_per_thread()
565{
William Lallemand808e1b72018-12-15 22:34:31 +0100566 /* rd and wr are init at the same place, but only rd is init to -1, so
567 we rely to rd to close. */
568 if (poller_rd_pipe > -1) {
569 close(poller_rd_pipe);
570 poller_rd_pipe = -1;
571 close(poller_wr_pipe[tid]);
572 poller_wr_pipe[tid] = -1;
573 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200574}
575
Willy Tarreau082b6282019-05-22 14:42:12 +0200576/* Release the pollers per thread, to be called late */
577static void free_pollers_per_thread()
578{
579 free(fd_updt);
580 fd_updt = NULL;
581}
582
Willy Tarreaubaaee002006-06-26 02:48:02 +0200583/*
Willy Tarreau4f60f162007-04-08 16:39:58 +0200584 * Initialize the pollers till the best one is found.
585 * If none works, returns 0, otherwise 1.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200586 */
Willy Tarreau4f60f162007-04-08 16:39:58 +0200587int init_pollers()
Willy Tarreaubaaee002006-06-26 02:48:02 +0200588{
Willy Tarreau4f60f162007-04-08 16:39:58 +0200589 int p;
590 struct poller *bp;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200591
Christopher Faulet63fe6522017-08-31 17:52:09 +0200592 if ((fdtab = calloc(global.maxsock, sizeof(struct fdtab))) == NULL)
593 goto fail_tab;
594
Olivier Houchard53055052019-07-25 14:00:18 +0000595 if ((polled_mask = calloc(global.maxsock, sizeof(*polled_mask))) == NULL)
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200596 goto fail_polledmask;
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000597
Christopher Faulet63fe6522017-08-31 17:52:09 +0200598 if ((fdinfo = calloc(global.maxsock, sizeof(struct fdinfo))) == NULL)
599 goto fail_info;
600
Olivier Houchard6b96f722018-04-25 16:58:25 +0200601 update_list.first = update_list.last = -1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200602
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100603 for (p = 0; p < global.maxsock; p++) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100604 HA_SPIN_INIT(&fdtab[p].lock);
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100605 /* Mark the fd as out of the fd cache */
Olivier Houchard6b96f722018-04-25 16:58:25 +0200606 fdtab[p].update.next = -3;
Olivier Houchard4815c8c2018-01-24 18:17:56 +0100607 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200608
Willy Tarreau4f60f162007-04-08 16:39:58 +0200609 do {
610 bp = NULL;
611 for (p = 0; p < nbpollers; p++)
612 if (!bp || (pollers[p].pref > bp->pref))
613 bp = &pollers[p];
Willy Tarreaubaaee002006-06-26 02:48:02 +0200614
Willy Tarreau4f60f162007-04-08 16:39:58 +0200615 if (!bp || bp->pref == 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200616 break;
617
Willy Tarreau4f60f162007-04-08 16:39:58 +0200618 if (bp->init(bp)) {
619 memcpy(&cur_poller, bp, sizeof(*bp));
620 return 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200621 }
Willy Tarreau4f60f162007-04-08 16:39:58 +0200622 } while (!bp || bp->pref == 0);
Willy Tarreau7be79a42012-11-11 15:02:54 +0100623
Christopher Faulet63fe6522017-08-31 17:52:09 +0200624 free(fdinfo);
625 fail_info:
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200626 free(polled_mask);
627 fail_polledmask:
Uman Shahzadda7eeed2019-01-17 08:21:39 +0000628 free(fdtab);
629 fail_tab:
Willy Tarreau7be79a42012-11-11 15:02:54 +0100630 return 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200631}
632
Willy Tarreaubaaee002006-06-26 02:48:02 +0200633/*
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200634 * Deinitialize the pollers.
635 */
636void deinit_pollers() {
637
638 struct poller *bp;
639 int p;
640
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200641 for (p = 0; p < global.maxsock; p++)
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100642 HA_SPIN_DESTROY(&fdtab[p].lock);
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200643
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200644 for (p = 0; p < nbpollers; p++) {
645 bp = &pollers[p];
646
647 if (bp && bp->pref)
648 bp->term(bp);
649 }
Christopher Fauletd4604ad2017-05-29 10:40:41 +0200650
Christopher Faulet63fe6522017-08-31 17:52:09 +0200651 free(fdinfo); fdinfo = NULL;
652 free(fdtab); fdtab = NULL;
Olivier Houchardcb92f5c2018-04-26 14:23:07 +0200653 free(polled_mask); polled_mask = NULL;
Krzysztof Piotr Oledzkia643baf2008-05-29 23:53:44 +0200654}
655
656/*
Willy Tarreau2ff76222007-04-09 19:29:56 +0200657 * Lists the known pollers on <out>.
658 * Should be performed only before initialization.
659 */
660int list_pollers(FILE *out)
661{
662 int p;
663 int last, next;
664 int usable;
665 struct poller *bp;
666
667 fprintf(out, "Available polling systems :\n");
668
669 usable = 0;
670 bp = NULL;
671 last = next = -1;
672 while (1) {
673 for (p = 0; p < nbpollers; p++) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200674 if ((next < 0 || pollers[p].pref > next)
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100675 && (last < 0 || pollers[p].pref < last)) {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200676 next = pollers[p].pref;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100677 if (!bp || (pollers[p].pref > bp->pref))
678 bp = &pollers[p];
679 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200680 }
681
682 if (next == -1)
683 break;
684
685 for (p = 0; p < nbpollers; p++) {
686 if (pollers[p].pref == next) {
687 fprintf(out, " %10s : ", pollers[p].name);
688 if (pollers[p].pref == 0)
689 fprintf(out, "disabled, ");
690 else
691 fprintf(out, "pref=%3d, ", pollers[p].pref);
692 if (pollers[p].test(&pollers[p])) {
693 fprintf(out, " test result OK");
694 if (next > 0)
695 usable++;
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100696 } else {
Willy Tarreau2ff76222007-04-09 19:29:56 +0200697 fprintf(out, " test result FAILED");
Willy Tarreaue79c3b22010-11-19 10:20:36 +0100698 if (bp == &pollers[p])
699 bp = NULL;
700 }
Willy Tarreau2ff76222007-04-09 19:29:56 +0200701 fprintf(out, "\n");
702 }
703 }
704 last = next;
705 next = -1;
706 };
707 fprintf(out, "Total: %d (%d usable), will use %s.\n", nbpollers, usable, bp ? bp->name : "none");
708 return 0;
709}
710
711/*
712 * Some pollers may lose their connection after a fork(). It may be necessary
713 * to create initialize part of them again. Returns 0 in case of failure,
714 * otherwise 1. The fork() function may be NULL if unused. In case of error,
715 * the the current poller is destroyed and the caller is responsible for trying
716 * another one by calling init_pollers() again.
717 */
718int fork_poller()
719{
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200720 int fd;
Willy Tarreauce036bc2018-01-29 14:58:02 +0100721 for (fd = 0; fd < global.maxsock; fd++) {
Conrad Hoffmann041751c2014-05-20 14:28:24 +0200722 if (fdtab[fd].owner) {
723 fdtab[fd].cloned = 1;
724 }
725 }
726
Willy Tarreau2ff76222007-04-09 19:29:56 +0200727 if (cur_poller.fork) {
728 if (cur_poller.fork(&cur_poller))
729 return 1;
730 cur_poller.term(&cur_poller);
731 return 0;
732 }
733 return 1;
734}
735
Willy Tarreau082b6282019-05-22 14:42:12 +0200736REGISTER_PER_THREAD_ALLOC(alloc_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +0100737REGISTER_PER_THREAD_INIT(init_pollers_per_thread);
738REGISTER_PER_THREAD_DEINIT(deinit_pollers_per_thread);
Willy Tarreau082b6282019-05-22 14:42:12 +0200739REGISTER_PER_THREAD_FREE(free_pollers_per_thread);
Willy Tarreau172f5ce2018-11-26 11:21:50 +0100740
Willy Tarreau2ff76222007-04-09 19:29:56 +0200741/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200742 * Local variables:
743 * c-indent-level: 8
744 * c-basic-offset: 8
745 * End:
746 */