Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 2 | include/types/fd.h |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 3 | File descriptors states. |
| 4 | |
Willy Tarreau | 63455a9 | 2007-04-09 15:34:49 +0200 | [diff] [blame] | 5 | Copyright (C) 2000-2007 Willy Tarreau - w@1wt.eu |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +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 | */ |
| 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 | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 32 | #include <types/buffers.h> |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 33 | #include <types/protocols.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 34 | |
| 35 | /* different possible states for the fd */ |
| 36 | #define FD_STCLOSE 0 |
| 37 | #define FD_STLISTEN 1 |
| 38 | #define FD_STCONN 2 |
| 39 | #define FD_STREADY 3 |
| 40 | #define FD_STERROR 4 |
| 41 | |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 42 | enum { |
| 43 | DIR_RD=0, |
| 44 | DIR_WR=1, |
| 45 | DIR_SIZE |
| 46 | }; |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 47 | |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 48 | |
| 49 | #define FD_POLL_IN 0x01 |
| 50 | #define FD_POLL_PRI 0x02 |
| 51 | #define FD_POLL_OUT 0x04 |
| 52 | #define FD_POLL_ERR 0x08 |
| 53 | #define FD_POLL_HUP 0x10 |
| 54 | #define FD_POLL_ANY 0x1F |
| 55 | |
| 56 | #define FD_POLL_RD (FD_POLL_IN | FD_POLL_ERR | FD_POLL_HUP) |
| 57 | #define FD_POLL_WR (FD_POLL_OUT | FD_POLL_ERR | FD_POLL_HUP) |
| 58 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 59 | /* info about one given fd */ |
| 60 | struct fdtab { |
Willy Tarreau | 5446940 | 2006-07-29 16:59:06 +0200 | [diff] [blame] | 61 | struct { |
| 62 | int (*f)(int fd); /* read/write function */ |
| 63 | struct buffer *b; /* read/write buffer */ |
| 64 | } cb[DIR_SIZE]; |
Willy Tarreau | 3d32d3a | 2007-04-15 11:31:05 +0200 | [diff] [blame] | 65 | struct task *owner; /* the session (or proxy) associated with this fd */ |
| 66 | unsigned char state; /* the state of this fd */ |
| 67 | unsigned char ev; /* event seen in return of poll() : FD_POLL_* */ |
Willy Tarreau | e94ebd0 | 2007-10-09 17:14:37 +0200 | [diff] [blame] | 68 | struct sockaddr *peeraddr; /* pointer to peer's network address, or NULL if unset */ |
| 69 | socklen_t peerlen; /* peer's address length, or 0 if unset */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 70 | struct listener *listener; /* the listener which created this fd, or NULL if unset */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 71 | }; |
| 72 | |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 73 | /* |
| 74 | * Poller descriptors. |
| 75 | * - <name> is initialized by the poller's register() function, and should not |
| 76 | * be allocated, just linked to. |
| 77 | * - <pref> is initialized by the poller's register() function. It is set to 0 |
| 78 | * by default, meaning the poller is disabled. init() should set it to 0 in |
| 79 | * case of failure. term() must set it to 0. A generic unoptimized select() |
| 80 | * poller should set it to 100. |
| 81 | * - <private> is initialized by the poller's init() function, and cleaned by |
| 82 | * the term() function. |
Willy Tarreau | 97129b5 | 2007-04-09 00:54:46 +0200 | [diff] [blame] | 83 | * - cond_s() checks if fd was not set then sets it and returns 1. Otherwise |
| 84 | * it returns 0. It may be the same as set(). |
| 85 | * - cond_c() checks if fd was set then clears it and returns 1. Otherwise |
| 86 | * it returns 0. It may be the same as clr(). |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 87 | * - clo() should be used to do indicate the poller that fd will be closed. It |
| 88 | * may be the same as rem() on some pollers. |
Willy Tarreau | d825eef | 2007-05-12 22:35:00 +0200 | [diff] [blame] | 89 | * - poll() calls the poller, expiring at <exp> |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 90 | */ |
| 91 | struct poller { |
| 92 | void *private; /* any private data for the poller */ |
Willy Tarreau | 5b70242 | 2007-04-16 01:33:26 +0200 | [diff] [blame] | 93 | int REGPRM2 (*is_set)(const int fd, int dir); /* check if <fd> is being polled for dir <dir> */ |
| 94 | int REGPRM2 (*set)(const int fd, int dir); /* set polling on <fd> for <dir> */ |
| 95 | int REGPRM2 (*clr)(const int fd, int dir); /* clear polling on <fd> for <dir> */ |
| 96 | int REGPRM2 (*cond_s)(const int fd, int dir); /* set polling on <fd> for <dir> if unset */ |
| 97 | int REGPRM2 (*cond_c)(const int fd, int dir); /* clear polling on <fd> for <dir> if set */ |
| 98 | void REGPRM1 (*rem)(const int fd); /* remove any polling on <fd> */ |
| 99 | void REGPRM1 (*clo)(const int fd); /* mark <fd> as closed */ |
Willy Tarreau | d825eef | 2007-05-12 22:35:00 +0200 | [diff] [blame] | 100 | void REGPRM2 (*poll)(struct poller *p, struct timeval *exp); /* the poller itself */ |
Willy Tarreau | 5b70242 | 2007-04-16 01:33:26 +0200 | [diff] [blame] | 101 | int REGPRM1 (*init)(struct poller *p); /* poller initialization */ |
| 102 | void REGPRM1 (*term)(struct poller *p); /* termination of this poller */ |
| 103 | int REGPRM1 (*test)(struct poller *p); /* pre-init check of the poller */ |
| 104 | int REGPRM1 (*fork)(struct poller *p); /* post-fork re-opening */ |
Willy Tarreau | 4f60f16 | 2007-04-08 16:39:58 +0200 | [diff] [blame] | 105 | const char *name; /* poller name */ |
| 106 | int pref; /* try pollers with higher preference first */ |
| 107 | }; |
| 108 | |
| 109 | extern struct poller cur_poller; /* the current poller */ |
| 110 | extern int nbpollers; |
| 111 | #define MAX_POLLERS 10 |
| 112 | extern struct poller pollers[MAX_POLLERS]; /* all registered pollers */ |
| 113 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 114 | extern struct fdtab *fdtab; /* array of all the file descriptors */ |
| 115 | extern int maxfd; /* # of the highest fd + 1 */ |
| 116 | extern int totalconn; /* total # of terminated sessions */ |
| 117 | extern int actconn; /* # of active sessions */ |
| 118 | |
| 119 | #endif /* _TYPES_FD_H */ |
| 120 | |
| 121 | /* |
| 122 | * Local variables: |
| 123 | * c-indent-level: 8 |
| 124 | * c-basic-offset: 8 |
| 125 | * End: |
| 126 | */ |