Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 2 | * include/types/fd.h |
Willy Tarreau | f817e9f | 2014-01-10 16:58:45 +0100 | [diff] [blame] | 3 | * File descriptors states - check src/fd.c for explanations. |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 4 | * |
Willy Tarreau | f817e9f | 2014-01-10 16:58:45 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 21 | |
| 22 | #ifndef _TYPES_FD_H |
| 23 | #define _TYPES_FD_H |
| 24 | |
Willy Tarreau | 2dd0d47 | 2006-06-29 17:53:05 +0200 | [diff] [blame] | 25 | #include <common/config.h> |
Christopher Faulet | d4604ad | 2017-05-29 10:40:41 +0200 | [diff] [blame] | 26 | #include <common/hathreads.h> |
Willy Tarreau | 931d8b7 | 2019-08-27 11:08:17 +0200 | [diff] [blame] | 27 | #include <common/ist.h> |
Willy Tarreau | dd2f85e | 2012-09-02 22:34:23 +0200 | [diff] [blame] | 28 | #include <types/port_range.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 29 | |
Willy Tarreau | 7be79a4 | 2012-11-11 15:02:54 +0100 | [diff] [blame] | 30 | /* Direction for each FD event update */ |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 31 | enum { |
| 32 | DIR_RD=0, |
| 33 | DIR_WR=1, |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 34 | }; |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 35 | |
Willy Tarreau | 7be79a4 | 2012-11-11 15:02:54 +0100 | [diff] [blame] | 36 | /* Polling status flags returned in fdtab[].ev : |
Willy Tarreau | d6f087e | 2008-01-18 17:20:13 +0100 | [diff] [blame] | 37 | * FD_POLL_IN remains set as long as some data is pending for read. |
| 38 | * FD_POLL_OUT remains set as long as the fd accepts to write data. |
| 39 | * FD_POLL_ERR and FD_POLL_ERR remain set forever (until processed). |
| 40 | */ |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 41 | #define FD_POLL_IN 0x01 |
| 42 | #define FD_POLL_PRI 0x02 |
| 43 | #define FD_POLL_OUT 0x04 |
| 44 | #define FD_POLL_ERR 0x08 |
| 45 | #define FD_POLL_HUP 0x10 |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 46 | |
Willy Tarreau | d6f087e | 2008-01-18 17:20:13 +0100 | [diff] [blame] | 47 | #define FD_POLL_DATA (FD_POLL_IN | FD_POLL_OUT) |
| 48 | #define FD_POLL_STICKY (FD_POLL_ERR | FD_POLL_HUP) |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 49 | |
Willy Tarreau | a135ea6 | 2020-02-21 16:26:19 +0100 | [diff] [blame] | 50 | /* FD_EV_* are the values used in fdtab[].state to define the polling states in |
| 51 | * each direction. Most of them are manipulated using test-and-set operations |
| 52 | * which require the bit position in the mask, which is given in the _BIT |
| 53 | * variant. |
| 54 | */ |
Willy Tarreau | f817e9f | 2014-01-10 16:58:45 +0100 | [diff] [blame] | 55 | |
Willy Tarreau | 1dad384 | 2019-07-08 23:09:03 +0200 | [diff] [blame] | 56 | /* bits positions for a few flags */ |
Willy Tarreau | f8ecc7f | 2019-09-04 13:22:50 +0200 | [diff] [blame] | 57 | #define FD_EV_ACTIVE_R_BIT 0 |
Willy Tarreau | 77abb43 | 2019-09-06 18:27:02 +0200 | [diff] [blame] | 58 | #define FD_EV_READY_R_BIT 1 |
| 59 | #define FD_EV_SHUT_R_BIT 2 |
Willy Tarreau | 1ed3781 | 2020-02-26 16:12:45 +0100 | [diff] [blame] | 60 | /* unused: 3 */ |
Willy Tarreau | f8ecc7f | 2019-09-04 13:22:50 +0200 | [diff] [blame] | 61 | |
| 62 | #define FD_EV_ACTIVE_W_BIT 4 |
Willy Tarreau | 77abb43 | 2019-09-06 18:27:02 +0200 | [diff] [blame] | 63 | #define FD_EV_READY_W_BIT 5 |
| 64 | #define FD_EV_SHUT_W_BIT 6 |
Willy Tarreau | 1ed3781 | 2020-02-26 16:12:45 +0100 | [diff] [blame] | 65 | #define FD_EV_ERR_RW_BIT 7 |
Willy Tarreau | 1dad384 | 2019-07-08 23:09:03 +0200 | [diff] [blame] | 66 | |
Willy Tarreau | a135ea6 | 2020-02-21 16:26:19 +0100 | [diff] [blame] | 67 | /* and flag values */ |
| 68 | #define FD_EV_ACTIVE_R (1U << FD_EV_ACTIVE_R_BIT) |
| 69 | #define FD_EV_ACTIVE_W (1U << FD_EV_ACTIVE_W_BIT) |
Willy Tarreau | 7be79a4 | 2012-11-11 15:02:54 +0100 | [diff] [blame] | 70 | #define FD_EV_ACTIVE_RW (FD_EV_ACTIVE_R | FD_EV_ACTIVE_W) |
| 71 | |
Willy Tarreau | a135ea6 | 2020-02-21 16:26:19 +0100 | [diff] [blame] | 72 | #define FD_EV_READY_R (1U << FD_EV_READY_R_BIT) |
| 73 | #define FD_EV_READY_W (1U << FD_EV_READY_W_BIT) |
Willy Tarreau | f817e9f | 2014-01-10 16:58:45 +0100 | [diff] [blame] | 74 | #define FD_EV_READY_RW (FD_EV_READY_R | FD_EV_READY_W) |
| 75 | |
Willy Tarreau | 77abb43 | 2019-09-06 18:27:02 +0200 | [diff] [blame] | 76 | /* note that when FD_EV_SHUT is set, ACTIVE and READY are cleared */ |
Willy Tarreau | a135ea6 | 2020-02-21 16:26:19 +0100 | [diff] [blame] | 77 | #define FD_EV_SHUT_R (1U << FD_EV_SHUT_R_BIT) |
| 78 | #define FD_EV_SHUT_W (1U << FD_EV_SHUT_W_BIT) |
Willy Tarreau | 77abb43 | 2019-09-06 18:27:02 +0200 | [diff] [blame] | 79 | #define FD_EV_SHUT_RW (FD_EV_SHUT_R | FD_EV_SHUT_W) |
| 80 | |
Willy Tarreau | 1ed3781 | 2020-02-26 16:12:45 +0100 | [diff] [blame] | 81 | /* note that when FD_EV_ERR is set, SHUT is also set. Also, ERR is for both |
| 82 | * directions at once (write error, socket dead, etc). |
| 83 | */ |
| 84 | #define FD_EV_ERR_RW (1U << FD_EV_ERR_RW_BIT) |
Willy Tarreau | 77abb43 | 2019-09-06 18:27:02 +0200 | [diff] [blame] | 85 | |
Willy Tarreau | 733b132 | 2016-11-17 14:22:52 +0100 | [diff] [blame] | 86 | |
| 87 | /* This is the value used to mark a file descriptor as dead. This value is |
| 88 | * negative, this is important so that tests on fd < 0 properly match. It |
Joseph Herlant | f69b807 | 2018-11-25 13:34:43 -0800 | [diff] [blame] | 89 | * also has the nice property of being highly negative but neither overflowing |
| 90 | * nor changing sign on 32-bit machines when multiplied by sizeof(fdtab). |
Willy Tarreau | 733b132 | 2016-11-17 14:22:52 +0100 | [diff] [blame] | 91 | * This ensures that any unexpected dereference of such an uninitialized |
| 92 | * file descriptor will lead to so large a dereference that it will crash |
| 93 | * the process at the exact location of the bug with a clean stack trace |
| 94 | * instead of causing silent manipulation of other FDs. And it's readable |
| 95 | * when found in a dump. |
| 96 | */ |
| 97 | #define DEAD_FD_MAGIC 0xFDDEADFD |
| 98 | |
Olivier Houchard | 1256836 | 2018-01-31 18:07:29 +0100 | [diff] [blame] | 99 | /* fdlist_entry: entry used by the fd cache. |
| 100 | * >= 0 means we're in the cache and gives the FD of the next in the cache, |
| 101 | * -1 means we're in the cache and the last element, |
| 102 | * -2 means the entry is locked, |
| 103 | * <= -3 means not in the cache, and next element is -4-fd |
| 104 | * |
| 105 | * It must remain 8-aligned so that aligned CAS operations may be done on both |
| 106 | * entries at once. |
| 107 | */ |
Olivier Houchard | 4815c8c | 2018-01-24 18:17:56 +0100 | [diff] [blame] | 108 | struct fdlist_entry { |
Olivier Houchard | 1256836 | 2018-01-31 18:07:29 +0100 | [diff] [blame] | 109 | int next; |
| 110 | int prev; |
Olivier Houchard | 4815c8c | 2018-01-24 18:17:56 +0100 | [diff] [blame] | 111 | } __attribute__ ((aligned(8))); |
| 112 | |
Olivier Houchard | 1256836 | 2018-01-31 18:07:29 +0100 | [diff] [blame] | 113 | /* head of the fd cache */ |
Olivier Houchard | 4815c8c | 2018-01-24 18:17:56 +0100 | [diff] [blame] | 114 | struct fdlist { |
Olivier Houchard | 1256836 | 2018-01-31 18:07:29 +0100 | [diff] [blame] | 115 | int first; |
| 116 | int last; |
Olivier Houchard | 4815c8c | 2018-01-24 18:17:56 +0100 | [diff] [blame] | 117 | } __attribute__ ((aligned(8))); |
| 118 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 119 | /* info about one given fd */ |
| 120 | struct fdtab { |
Ilya Shipitsin | 856aabc | 2020-04-16 23:51:34 +0500 | [diff] [blame] | 121 | unsigned long running_mask; /* mask of thread IDs currently using the fd */ |
Olivier Houchard | a7bf573 | 2020-02-27 17:26:13 +0100 | [diff] [blame] | 122 | unsigned long thread_mask; /* mask of thread IDs authorized to process the fd */ |
Willy Tarreau | ebc78d7 | 2018-01-20 23:53:50 +0100 | [diff] [blame] | 123 | unsigned long update_mask; /* mask of thread IDs having an update for fd */ |
Olivier Houchard | 6b96f72 | 2018-04-25 16:58:25 +0200 | [diff] [blame] | 124 | struct fdlist_entry update; /* Entry in the global update list */ |
Willy Tarreau | 7a798e5 | 2016-04-14 11:13:20 +0200 | [diff] [blame] | 125 | void (*iocb)(int fd); /* I/O handler */ |
Willy Tarreau | 8018471 | 2012-07-06 14:54:49 +0200 | [diff] [blame] | 126 | void *owner; /* the connection or listener associated with this fd, NULL if closed */ |
Willy Tarreau | a135ea6 | 2020-02-21 16:26:19 +0100 | [diff] [blame] | 127 | unsigned char state; /* FD state for read and write directions (FD_EV_*) */ |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 128 | unsigned char ev; /* event seen in return of poll() : FD_POLL_* */ |
Willy Tarreau | ad38ace | 2013-12-15 14:19:38 +0100 | [diff] [blame] | 129 | unsigned char linger_risk:1; /* 1 if we must kill lingering before closing */ |
Conrad Hoffmann | 041751c | 2014-05-20 14:28:24 +0200 | [diff] [blame] | 130 | unsigned char cloned:1; /* 1 if a cloned socket, requires EPOLL_CTL_DEL on close */ |
Willy Tarreau | d660990 | 2019-08-30 14:36:10 +0200 | [diff] [blame] | 131 | unsigned char initialized:1; /* 1 if init phase was done on this fd (e.g. set non-blocking) */ |
Willy Tarreau | 76913d3 | 2019-08-30 14:33:11 +0200 | [diff] [blame] | 132 | } |
| 133 | #ifdef USE_THREAD |
| 134 | /* only align on cache lines when using threads; 32-bit small archs |
| 135 | * can put everything in 32-bytes when threads are disabled. |
| 136 | */ |
| 137 | __attribute__((aligned(64))) |
| 138 | #endif |
| 139 | ; |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 140 | |
| 141 | /* less often used information */ |
| 142 | struct fdinfo { |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 143 | struct port_range *port_range; /* optional port range to bind to */ |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 144 | int local_port; /* optional local port */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 145 | }; |
| 146 | |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 147 | /* |
| 148 | * Poller descriptors. |
| 149 | * - <name> is initialized by the poller's register() function, and should not |
| 150 | * be allocated, just linked to. |
| 151 | * - <pref> is initialized by the poller's register() function. It is set to 0 |
| 152 | * by default, meaning the poller is disabled. init() should set it to 0 in |
| 153 | * case of failure. term() must set it to 0. A generic unoptimized select() |
| 154 | * poller should set it to 100. |
| 155 | * - <private> is initialized by the poller's init() function, and cleaned by |
| 156 | * the term() function. |
Willy Tarreau | 70c6fd8 | 2012-11-11 21:02:34 +0100 | [diff] [blame] | 157 | * - clo() should be used to do indicate the poller that fd will be closed. |
Willy Tarreau | 2ae84e4 | 2019-05-28 16:44:05 +0200 | [diff] [blame] | 158 | * - poll() calls the poller, expiring at <exp>, or immediately if <wake> is set |
Willy Tarreau | 5a76769 | 2017-03-13 11:38:28 +0100 | [diff] [blame] | 159 | * - flags indicate what the poller supports (HAP_POLL_F_*) |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 160 | */ |
Willy Tarreau | 5a76769 | 2017-03-13 11:38:28 +0100 | [diff] [blame] | 161 | |
Willy Tarreau | 11ef083 | 2019-11-28 18:17:33 +0100 | [diff] [blame] | 162 | #define HAP_POLL_F_RDHUP 0x00000001 /* the poller notifies of HUP with reads */ |
| 163 | #define HAP_POLL_F_ERRHUP 0x00000002 /* the poller reports ERR and HUP */ |
Willy Tarreau | 5a76769 | 2017-03-13 11:38:28 +0100 | [diff] [blame] | 164 | |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 165 | struct poller { |
| 166 | void *private; /* any private data for the poller */ |
Willy Tarreau | 03e7853 | 2020-02-25 07:38:05 +0100 | [diff] [blame] | 167 | void (*clo)(const int fd); /* mark <fd> as closed */ |
| 168 | void (*poll)(struct poller *p, int exp, int wake); /* the poller itself */ |
| 169 | int (*init)(struct poller *p); /* poller initialization */ |
| 170 | void (*term)(struct poller *p); /* termination of this poller */ |
| 171 | int (*test)(struct poller *p); /* pre-init check of the poller */ |
| 172 | int (*fork)(struct poller *p); /* post-fork re-opening */ |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 173 | const char *name; /* poller name */ |
Willy Tarreau | 5a76769 | 2017-03-13 11:38:28 +0100 | [diff] [blame] | 174 | unsigned int flags; /* HAP_POLL_F_* */ |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 175 | int pref; /* try pollers with higher preference first */ |
| 176 | }; |
| 177 | |
| 178 | extern struct poller cur_poller; /* the current poller */ |
| 179 | extern int nbpollers; |
| 180 | #define MAX_POLLERS 10 |
| 181 | extern struct poller pollers[MAX_POLLERS]; /* all registered pollers */ |
| 182 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 183 | extern struct fdtab *fdtab; /* array of all the file descriptors */ |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 184 | extern struct fdinfo *fdinfo; /* less-often used infos for file descriptors */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 185 | extern int totalconn; /* total # of terminated sessions */ |
| 186 | extern int actconn; /* # of active sessions */ |
| 187 | |
| 188 | #endif /* _TYPES_FD_H */ |
| 189 | |
| 190 | /* |
| 191 | * Local variables: |
| 192 | * c-indent-level: 8 |
| 193 | * c-basic-offset: 8 |
| 194 | * End: |
| 195 | */ |