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 | |
| 5 | Copyright (C) 2000-2007 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 | */ |
| 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 | |
| 33 | /* max length of a protcol name, including trailing zero */ |
| 34 | #define PROTO_NAME_LEN 16 |
| 35 | |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 36 | /* listener state */ |
| 37 | #define LI_NEW 0 /* not initialized yet */ |
Willy Tarreau | 92fb983 | 2007-10-16 17:34:28 +0200 | [diff] [blame] | 38 | #define LI_INIT 1 /* attached to the protocol, but not listening yet */ |
| 39 | #define LI_LISTEN 2 /* started, listening but not enabled */ |
| 40 | #define LI_READY 3 /* started, listening and enabled */ |
| 41 | #define LI_FULL 4 /* reached its connection limit */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 42 | |
| 43 | /* The listener will be directly referenced by the fdtab[] which holds its |
| 44 | * socket. The listener provides the protocol-specific accept() function to |
| 45 | * the fdtab. |
| 46 | */ |
| 47 | struct listener { |
| 48 | int fd; /* the listen socket */ |
Willy Tarreau | 92fb983 | 2007-10-16 17:34:28 +0200 | [diff] [blame] | 49 | int state; /* state: NEW, INIT, LISTEN, READY, FULL */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 50 | struct sockaddr_storage addr; /* the address we listen to */ |
| 51 | struct protocol *proto; /* protocol this listener belongs to */ |
| 52 | int nbconn; /* current number of connections on this listener */ |
| 53 | int maxconn; /* maximum connections allowed on this listener */ |
| 54 | struct listener *next; /* next address for the same proxy, or NULL */ |
| 55 | struct list proto_list; /* list in the protocol header */ |
| 56 | int (*accept)(int fd); /* accept() function passed to fdtab[] */ |
| 57 | void (*handler)(struct task *t, struct timeval *next); /* protocol handler */ |
| 58 | struct timeval *timeout; /* pointer to client-side timeout */ |
| 59 | void *private; /* any private data which may be used by accept() */ |
Willy Tarreau | e6ad2b1 | 2007-10-18 12:45:54 +0200 | [diff] [blame] | 60 | union { /* protocol-dependant access restrictions */ |
| 61 | struct { /* UNIX socket permissions */ |
| 62 | uid_t uid; /* -1 to leave unchanged */ |
| 63 | gid_t gid; /* -1 to leave unchanged */ |
| 64 | mode_t mode; /* 0 to leave unchanged */ |
| 65 | } ux; |
| 66 | } perm; |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | /* This structure contains all information needed to easily handle a protocol. |
| 70 | * Its primary goal is to ease listeners maintenance. Specifically, the |
| 71 | * bind_all() primitive must be used before any fork(), and the enable_all() |
| 72 | * primitive must be called after the fork() to enable all fds. Last, the |
| 73 | * unbind_all() primitive closes all listeners. |
| 74 | */ |
| 75 | struct protocol { |
| 76 | char name[PROTO_NAME_LEN]; /* protocol name, zero-terminated */ |
| 77 | int sock_domain; /* socket domain, as passed to socket() */ |
| 78 | int sock_type; /* socket type, as passed to socket() */ |
| 79 | int sock_prot; /* socket protocol, as passed to socket() */ |
| 80 | sa_family_t sock_family; /* socket family, for sockaddr */ |
Willy Tarreau | 106bf27 | 2007-10-28 12:09:45 +0100 | [diff] [blame] | 81 | socklen_t sock_addrlen; /* socket address length, used by bind() */ |
| 82 | int l3_addrlen; /* layer3 address length, used by hashes */ |
Willy Tarreau | dd81598 | 2007-10-16 12:25:14 +0200 | [diff] [blame] | 83 | int (*read)(int fd); /* generic read function */ |
| 84 | int (*write)(int fd); /* generic write function */ |
| 85 | int (*bind_all)(struct protocol *proto); /* bind all unbound listeners */ |
| 86 | int (*unbind_all)(struct protocol *proto); /* unbind all bound listeners */ |
| 87 | int (*enable_all)(struct protocol *proto); /* enable all bound listeners */ |
| 88 | struct list listeners; /* list of listeners using this protocol */ |
| 89 | int nb_listeners; /* number of listeners */ |
| 90 | struct list list; /* list of registered protocols */ |
| 91 | }; |
| 92 | |
| 93 | #endif /* _TYPES_PROTOCOLS_H */ |
| 94 | |
| 95 | /* |
| 96 | * Local variables: |
| 97 | * c-indent-level: 8 |
| 98 | * c-basic-offset: 8 |
| 99 | * End: |
| 100 | */ |