Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 1 | /* |
| 2 | include/types/protocols.h |
| 3 | This file defines the structures used by generic network protocols. |
| 4 | |
Willy Tarreau | 2c9f5b1 | 2009-08-16 19:12:36 +0200 | [diff] [blame] | 5 | Copyright (C) 2000-2009 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 55a8d0e | 2008-11-30 18:47:21 +0100 | [diff] [blame] | 6 | |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 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_PROTOCOLS_H |
| 23 | #define _TYPES_PROTOCOLS_H |
| 24 | |
| 25 | #include <sys/types.h> |
| 26 | #include <sys/socket.h> |
Willy Tarreau | e6ad2b1 | 2007-10-18 12:45:54 +0200 | [diff] [blame] | 27 | #include <sys/stat.h> |
| 28 | #include <sys/un.h> |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 29 | |
| 30 | #include <common/config.h> |
| 31 | #include <common/mini-clist.h> |
| 32 | |
Willy Tarreau | 55a8d0e | 2008-11-30 18:47:21 +0100 | [diff] [blame] | 33 | #include <types/task.h> |
| 34 | |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 35 | /* max length of a protcol name, including trailing zero */ |
| 36 | #define PROTO_NAME_LEN 16 |
| 37 | |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 38 | /* listener state */ |
| 39 | #define LI_NEW 0 /* not initialized yet */ |
Willy Tarreau | dabf2e2 | 2007-10-28 21:59:24 +0100 | [diff] [blame] | 40 | #define LI_INIT 1 /* all parameters filled in, but not assigned yet */ |
| 41 | #define LI_ASSIGNED 2 /* assigned to the protocol, but not listening yet */ |
| 42 | #define LI_LISTEN 3 /* started, listening but not enabled */ |
| 43 | #define LI_READY 4 /* started, listening and enabled */ |
| 44 | #define LI_FULL 5 /* reached its connection limit */ |
| 45 | |
| 46 | /* Listener transitions |
| 47 | * calloc() set() add_listener() bind() |
| 48 | * -------> NEW ----> INIT ----------> ASSIGNED -----> LISTEN |
| 49 | * <------- <---- <---------- <----- |
| 50 | * free() bzero() del_listener() unbind() |
| 51 | * |
| 52 | * The file descriptor is valid only during these three states : |
| 53 | * |
| 54 | * disable() |
| 55 | * LISTEN <------------ READY |
| 56 | * A| ------------> |A |
| 57 | * || !max & enable() || |
| 58 | * || || |
| 59 | * || max || |
| 60 | * || max & enable() V| !max |
| 61 | * |+---------------> FULL |
| 62 | * +----------------- |
| 63 | * disable() |
| 64 | * |
| 65 | */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 66 | |
Willy Tarreau | 6fb42e0 | 2007-10-28 17:02:33 +0100 | [diff] [blame] | 67 | /* listener socket options */ |
| 68 | #define LI_O_NONE 0x0000 |
| 69 | #define LI_O_NOLINGER 0x0001 /* disable linger on this socket */ |
Willy Tarreau | b1e52e8 | 2008-01-13 14:49:51 +0100 | [diff] [blame] | 70 | #define LI_O_FOREIGN 0x0002 /* permit listening on foreing addresses */ |
Willy Tarreau | 9ea05a7 | 2009-06-14 12:07:01 +0200 | [diff] [blame] | 71 | #define LI_O_NOQUICKACK 0x0004 /* disable quick ack of immediate data (linux) */ |
Willy Tarreau | 6fb42e0 | 2007-10-28 17:02:33 +0100 | [diff] [blame] | 72 | |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 73 | /* The listener will be directly referenced by the fdtab[] which holds its |
| 74 | * socket. The listener provides the protocol-specific accept() function to |
| 75 | * the fdtab. |
| 76 | */ |
| 77 | struct listener { |
| 78 | int fd; /* the listen socket */ |
Willy Tarreau | dabf2e2 | 2007-10-28 21:59:24 +0100 | [diff] [blame] | 79 | int state; /* state: NEW, INIT, ASSIGNED, LISTEN, READY, FULL */ |
Willy Tarreau | 6fb42e0 | 2007-10-28 17:02:33 +0100 | [diff] [blame] | 80 | int options; /* socket options : LI_O_* */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 81 | struct sockaddr_storage addr; /* the address we listen to */ |
| 82 | struct protocol *proto; /* protocol this listener belongs to */ |
| 83 | int nbconn; /* current number of connections on this listener */ |
| 84 | int maxconn; /* maximum connections allowed on this listener */ |
Willy Tarreau | c73ce2b | 2008-01-06 10:55:10 +0100 | [diff] [blame] | 85 | unsigned int backlog; /* if set, listen backlog */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 86 | struct listener *next; /* next address for the same proxy, or NULL */ |
| 87 | struct list proto_list; /* list in the protocol header */ |
| 88 | int (*accept)(int fd); /* accept() function passed to fdtab[] */ |
Willy Tarreau | 26c2506 | 2009-03-08 09:38:41 +0100 | [diff] [blame] | 89 | struct task * (*handler)(struct task *t); /* protocol handler. It is a task */ |
Willy Tarreau | 0c303ee | 2008-07-07 00:09:58 +0200 | [diff] [blame] | 90 | int *timeout; /* pointer to client-side timeout */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 91 | void *private; /* any private data which may be used by accept() */ |
Willy Tarreau | 3bc1377 | 2008-12-07 11:50:35 +0100 | [diff] [blame] | 92 | unsigned int analysers; /* bitmap of required protocol analysers */ |
Willy Tarreau | 2c9f5b1 | 2009-08-16 19:12:36 +0200 | [diff] [blame] | 93 | int nice; /* nice value to assign to the instanciated tasks */ |
Willy Tarreau | e6ad2b1 | 2007-10-18 12:45:54 +0200 | [diff] [blame] | 94 | union { /* protocol-dependant access restrictions */ |
| 95 | struct { /* UNIX socket permissions */ |
| 96 | uid_t uid; /* -1 to leave unchanged */ |
| 97 | gid_t gid; /* -1 to leave unchanged */ |
| 98 | mode_t mode; /* 0 to leave unchanged */ |
| 99 | } ux; |
| 100 | } perm; |
Willy Tarreau | 5e6e204 | 2009-02-04 17:19:29 +0100 | [diff] [blame] | 101 | char *interface; /* interface name or NULL */ |
Willy Tarreau | be1b918 | 2009-06-14 18:48:19 +0200 | [diff] [blame] | 102 | int maxseg; /* for TCP, advertised MSS */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 103 | }; |
| 104 | |
| 105 | /* This structure contains all information needed to easily handle a protocol. |
| 106 | * Its primary goal is to ease listeners maintenance. Specifically, the |
| 107 | * bind_all() primitive must be used before any fork(), and the enable_all() |
| 108 | * primitive must be called after the fork() to enable all fds. Last, the |
| 109 | * unbind_all() primitive closes all listeners. |
| 110 | */ |
| 111 | struct protocol { |
| 112 | char name[PROTO_NAME_LEN]; /* protocol name, zero-terminated */ |
| 113 | int sock_domain; /* socket domain, as passed to socket() */ |
| 114 | int sock_type; /* socket type, as passed to socket() */ |
| 115 | int sock_prot; /* socket protocol, as passed to socket() */ |
| 116 | sa_family_t sock_family; /* socket family, for sockaddr */ |
Willy Tarreau | 106bf27 | 2007-10-28 12:09:45 +0100 | [diff] [blame] | 117 | socklen_t sock_addrlen; /* socket address length, used by bind() */ |
| 118 | int l3_addrlen; /* layer3 address length, used by hashes */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 119 | int (*read)(int fd); /* generic read function */ |
| 120 | int (*write)(int fd); /* generic write function */ |
| 121 | int (*bind_all)(struct protocol *proto); /* bind all unbound listeners */ |
| 122 | int (*unbind_all)(struct protocol *proto); /* unbind all bound listeners */ |
| 123 | int (*enable_all)(struct protocol *proto); /* enable all bound listeners */ |
Willy Tarreau | dabf2e2 | 2007-10-28 21:59:24 +0100 | [diff] [blame] | 124 | int (*disable_all)(struct protocol *proto); /* disable all bound listeners */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 125 | struct list listeners; /* list of listeners using this protocol */ |
| 126 | int nb_listeners; /* number of listeners */ |
| 127 | struct list list; /* list of registered protocols */ |
| 128 | }; |
| 129 | |
| 130 | #endif /* _TYPES_PROTOCOLS_H */ |
| 131 | |
| 132 | /* |
| 133 | * Local variables: |
| 134 | * c-indent-level: 8 |
| 135 | * c-basic-offset: 8 |
| 136 | * End: |
| 137 | */ |