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 |
| 3 | * File descriptors states. |
| 4 | * |
| 5 | * Copyright (C) 2000-2009 Willy Tarreau - w@1wt.eu |
| 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 | e94ebd0 | 2007-10-09 17:14:37 +0200 | [diff] [blame] | 25 | #include <sys/socket.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 26 | #include <sys/time.h> |
| 27 | #include <sys/types.h> |
| 28 | #include <unistd.h> |
| 29 | |
Willy Tarreau | 2dd0d47 | 2006-06-29 17:53:05 +0200 | [diff] [blame] | 30 | #include <common/config.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 31 | #include <types/task.h> |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 32 | #include <types/protocols.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 33 | |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 34 | enum { |
| 35 | DIR_RD=0, |
| 36 | DIR_WR=1, |
| 37 | DIR_SIZE |
| 38 | }; |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 39 | |
Willy Tarreau | d6f087e | 2008-01-18 17:20:13 +0100 | [diff] [blame] | 40 | /* |
| 41 | * FD_POLL_IN remains set as long as some data is pending for read. |
| 42 | * FD_POLL_OUT remains set as long as the fd accepts to write data. |
| 43 | * FD_POLL_ERR and FD_POLL_ERR remain set forever (until processed). |
| 44 | */ |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 45 | #define FD_POLL_IN 0x01 |
| 46 | #define FD_POLL_PRI 0x02 |
| 47 | #define FD_POLL_OUT 0x04 |
| 48 | #define FD_POLL_ERR 0x08 |
| 49 | #define FD_POLL_HUP 0x10 |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 50 | |
Willy Tarreau | d6f087e | 2008-01-18 17:20:13 +0100 | [diff] [blame] | 51 | #define FD_POLL_DATA (FD_POLL_IN | FD_POLL_OUT) |
| 52 | #define FD_POLL_STICKY (FD_POLL_ERR | FD_POLL_HUP) |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 53 | |
Willy Tarreau | 4e6049e | 2012-07-06 10:53:51 +0200 | [diff] [blame] | 54 | /* flags that an I/O callback may return */ |
| 55 | #define FD_WAIT_READ 0x01 |
| 56 | #define FD_WAIT_WRITE 0x02 |
| 57 | #define FD_WAIT_BOTH (FD_WAIT_READ|FD_WAIT_WRITE) |
| 58 | |
Willy Tarreau | fb14edc | 2009-06-14 15:24:37 +0200 | [diff] [blame] | 59 | /* bit values for fdtab[fd]->flags. Most of them are used to hold a value |
| 60 | * consecutive to a behaviour change. |
| 61 | */ |
| 62 | #define FD_FL_TCP 0x0001 /* socket is TCP */ |
| 63 | #define FD_FL_TCP_NODELAY 0x0002 |
Willy Tarreau | 6db06d3 | 2009-08-19 11:14:11 +0200 | [diff] [blame] | 64 | #define FD_FL_TCP_NOLING 0x0004 /* lingering disabled */ |
Willy Tarreau | fb14edc | 2009-06-14 15:24:37 +0200 | [diff] [blame] | 65 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 66 | /* info about one given fd */ |
| 67 | struct fdtab { |
Willy Tarreau | 4e6049e | 2012-07-06 10:53:51 +0200 | [diff] [blame] | 68 | int (*iocb)(int fd); /* I/O handler, returns FD_WAIT_* */ |
Willy Tarreau | 8018471 | 2012-07-06 14:54:49 +0200 | [diff] [blame] | 69 | void *owner; /* the connection or listener associated with this fd, NULL if closed */ |
Willy Tarreau | b48b323 | 2009-10-17 22:54:17 +0200 | [diff] [blame] | 70 | struct { /* used by pollers which support speculative polling */ |
| 71 | unsigned char e; /* read and write events status. 4 bits, may be merged into flags' lower bits */ |
| 72 | unsigned int s1; /* Position in spec list+1. 0=not in list. */ |
| 73 | } spec; |
Willy Tarreau | fb14edc | 2009-06-14 15:24:37 +0200 | [diff] [blame] | 74 | unsigned short flags; /* various flags precising the exact status of this fd */ |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 75 | unsigned char ev; /* event seen in return of poll() : FD_POLL_* */ |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 76 | }; |
| 77 | |
| 78 | /* less often used information */ |
| 79 | struct fdinfo { |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 80 | struct port_range *port_range; /* optional port range to bind to */ |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 81 | int local_port; /* optional local port */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 82 | }; |
| 83 | |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 84 | /* |
| 85 | * Poller descriptors. |
| 86 | * - <name> is initialized by the poller's register() function, and should not |
| 87 | * be allocated, just linked to. |
| 88 | * - <pref> is initialized by the poller's register() function. It is set to 0 |
| 89 | * by default, meaning the poller is disabled. init() should set it to 0 in |
| 90 | * case of failure. term() must set it to 0. A generic unoptimized select() |
| 91 | * poller should set it to 100. |
| 92 | * - <private> is initialized by the poller's init() function, and cleaned by |
| 93 | * the term() function. |
Willy Tarreau | 97129b5 | 2007-04-09 00:54:46 +0200 | [diff] [blame] | 94 | * - cond_s() checks if fd was not set then sets it and returns 1. Otherwise |
| 95 | * it returns 0. It may be the same as set(). |
| 96 | * - cond_c() checks if fd was set then clears it and returns 1. Otherwise |
| 97 | * it returns 0. It may be the same as clr(). |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 98 | * - clo() should be used to do indicate the poller that fd will be closed. It |
| 99 | * may be the same as rem() on some pollers. |
Willy Tarreau | d825eef | 2007-05-12 22:35:00 +0200 | [diff] [blame] | 100 | * - poll() calls the poller, expiring at <exp> |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 101 | */ |
| 102 | struct poller { |
| 103 | void *private; /* any private data for the poller */ |
Willy Tarreau | 5b70242 | 2007-04-16 01:33:26 +0200 | [diff] [blame] | 104 | int REGPRM2 (*is_set)(const int fd, int dir); /* check if <fd> is being polled for dir <dir> */ |
| 105 | int REGPRM2 (*set)(const int fd, int dir); /* set polling on <fd> for <dir> */ |
| 106 | int REGPRM2 (*clr)(const int fd, int dir); /* clear polling on <fd> for <dir> */ |
| 107 | int REGPRM2 (*cond_s)(const int fd, int dir); /* set polling on <fd> for <dir> if unset */ |
| 108 | int REGPRM2 (*cond_c)(const int fd, int dir); /* clear polling on <fd> for <dir> if set */ |
| 109 | void REGPRM1 (*rem)(const int fd); /* remove any polling on <fd> */ |
| 110 | void REGPRM1 (*clo)(const int fd); /* mark <fd> as closed */ |
Willy Tarreau | 0c303ee | 2008-07-07 00:09:58 +0200 | [diff] [blame] | 111 | void REGPRM2 (*poll)(struct poller *p, int exp); /* the poller itself */ |
Willy Tarreau | 5b70242 | 2007-04-16 01:33:26 +0200 | [diff] [blame] | 112 | int REGPRM1 (*init)(struct poller *p); /* poller initialization */ |
| 113 | void REGPRM1 (*term)(struct poller *p); /* termination of this poller */ |
| 114 | int REGPRM1 (*test)(struct poller *p); /* pre-init check of the poller */ |
| 115 | int REGPRM1 (*fork)(struct poller *p); /* post-fork re-opening */ |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 116 | const char *name; /* poller name */ |
| 117 | int pref; /* try pollers with higher preference first */ |
| 118 | }; |
| 119 | |
| 120 | extern struct poller cur_poller; /* the current poller */ |
| 121 | extern int nbpollers; |
| 122 | #define MAX_POLLERS 10 |
| 123 | extern struct poller pollers[MAX_POLLERS]; /* all registered pollers */ |
| 124 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 125 | extern struct fdtab *fdtab; /* array of all the file descriptors */ |
Willy Tarreau | 8d5d77e | 2009-10-18 07:25:52 +0200 | [diff] [blame] | 126 | extern struct fdinfo *fdinfo; /* less-often used infos for file descriptors */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 127 | extern int maxfd; /* # of the highest fd + 1 */ |
| 128 | extern int totalconn; /* total # of terminated sessions */ |
| 129 | extern int actconn; /* # of active sessions */ |
| 130 | |
| 131 | #endif /* _TYPES_FD_H */ |
| 132 | |
| 133 | /* |
| 134 | * Local variables: |
| 135 | * c-indent-level: 8 |
| 136 | * c-basic-offset: 8 |
| 137 | * End: |
| 138 | */ |