blob: d38a81582eeedfc11d6e589dcce8f656d85b0b5f [file] [log] [blame]
Willy Tarreaue6b98942007-10-29 01:09:36 +01001/*
Willy Tarreaub1d67742010-03-29 19:36:59 +02002 * include/proto/proto_tcp.h
3 * This file contains TCP socket protocol definitions.
4 *
Willy Tarreaud4c33c82013-01-07 21:59:07 +01005 * Copyright (C) 2000-2013 Willy Tarreau - w@1wt.eu
Willy Tarreaub1d67742010-03-29 19:36:59 +02006 *
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 Tarreaue6b98942007-10-29 01:09:36 +010021
22#ifndef _PROTO_PROTO_TCP_H
23#define _PROTO_PROTO_TCP_H
24
25#include <common/config.h>
Willy Tarreaub6866442008-07-14 23:54:42 +020026#include <types/proto_tcp.h>
Willy Tarreaue6b98942007-10-29 01:09:36 +010027#include <types/task.h>
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020028#include <proto/stick_table.h>
Willy Tarreaue6b98942007-10-29 01:09:36 +010029
David du Colombier6f5ccb12011-03-10 22:26:24 +010030int tcp_bind_socket(int fd, int flags, struct sockaddr_storage *local, struct sockaddr_storage *remote);
Willy Tarreaue6b98942007-10-29 01:09:36 +010031void tcpv4_add_listener(struct listener *listener);
32void tcpv6_add_listener(struct listener *listener);
Willy Tarreau092d8652014-07-07 20:22:12 +020033int tcp_pause_listener(struct listener *l);
Willy Tarreauf0837b22012-11-24 10:24:27 +010034int tcp_connect_server(struct connection *conn, int data, int delack);
Willy Tarreau239d7182012-07-23 18:53:03 +020035int tcp_connect_probe(struct connection *conn);
Willy Tarreau59b94792012-05-11 16:16:40 +020036int tcp_get_src(int fd, struct sockaddr *sa, socklen_t salen, int dir);
37int tcp_get_dst(int fd, struct sockaddr *sa, socklen_t salen, int dir);
Willy Tarreau2b57cb82013-06-10 19:56:38 +020038int tcp_drain(int fd);
Willy Tarreau87b09662015-04-03 00:22:06 +020039int tcp_inspect_request(struct stream *s, struct channel *req, int an_bit);
40int tcp_inspect_response(struct stream *s, struct channel *rep, int an_bit);
Willy Tarreaue73ef852015-04-04 16:41:45 +020041int tcp_exec_req_rules(struct session *sess);
Willy Tarreaue6b98942007-10-29 01:09:36 +010042
Thierry FOURNIERcc87a112014-12-12 19:41:33 +010043/* TCP keywords. */
44void tcp_req_conn_keywords_register(struct tcp_action_kw_list *kw_list);
45void tcp_req_cont_keywords_register(struct tcp_action_kw_list *kw_list);
46void tcp_res_cont_keywords_register(struct tcp_action_kw_list *kw_list);
47
Thierry FOURNIERa123ad82015-07-24 09:12:15 +020048/* Export some samples. */
49int smp_fetch_src(const struct arg *args, struct sample *smp, const char *kw, void *private);
50
Willy Tarreau64ee4912012-08-30 22:59:48 +020051/* Converts the INET/INET6 source address to a stick_table key usable for table
Thierry FOURNIER74c219d2014-04-14 14:35:40 +020052 * lookups. <type> can be STKTABLE_TYPE_IP or STKTABLE_TYPE_IPV6. The function
53 * try to convert the incoming IP to the type expected by the sticktable.
54 * Returns either NULL if the source cannot be converted (eg: not IPv4) or a
55 * pointer to the converted result in static_table_key in the appropriate format
56 * (IP).
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020057 */
Thierry FOURNIER74c219d2014-04-14 14:35:40 +020058static inline struct stktable_key *addr_to_stktable_key(struct sockaddr_storage *addr, long type)
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020059{
Willy Tarreau64ee4912012-08-30 22:59:48 +020060 switch (addr->ss_family) {
David du Colombier4f92d322011-03-24 11:09:31 +010061 case AF_INET:
Thierry FOURNIER74c219d2014-04-14 14:35:40 +020062 /* Convert IPv4 to IPv4 key. */
63 if (type == STKTABLE_TYPE_IP) {
64 static_table_key->key = (void *)&((struct sockaddr_in *)addr)->sin_addr;
65 break;
66 }
67 /* Convert IPv4 to IPv6 key. */
68 if (type == STKTABLE_TYPE_IPV6) {
69 v4tov6(&static_table_key->data.ipv6, &((struct sockaddr_in *)addr)->sin_addr);
70 static_table_key->key = &static_table_key->data.ipv6;
71 break;
72 }
73 return NULL;
74
David du Colombier4f92d322011-03-24 11:09:31 +010075 case AF_INET6:
Thierry FOURNIER74c219d2014-04-14 14:35:40 +020076 /* Convert IPv6 to IPv4 key. This conversion can be failed. */
77 if (type == STKTABLE_TYPE_IP) {
78 if (!v6tov4(&static_table_key->data.ip, &((struct sockaddr_in6 *)addr)->sin6_addr))
79 return NULL;
80 static_table_key->key = &static_table_key->data.ip;
81 break;
82 }
83 /* Convert IPv6 to IPv6 key. */
84 if (type == STKTABLE_TYPE_IPV6) {
85 static_table_key->key = (void *)&((struct sockaddr_in6 *)addr)->sin6_addr;
86 break;
87 }
88 return NULL;
Willy Tarreauc3a08a12012-08-30 22:52:28 +020089 default:
90 return NULL;
David du Colombier4f92d322011-03-24 11:09:31 +010091 }
Willy Tarreau07115412012-10-29 21:56:59 +010092 return static_table_key;
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020093}
94
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +020095/* for a tcp-request action TCP_ACT_TRK_*, return a tracking index starting at
Willy Tarreau34c2fb62013-12-02 23:29:05 +010096 * zero for SC0. Unknown actions also return zero.
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +020097 */
98static inline int tcp_trk_idx(int trk_action)
99{
Willy Tarreaube4a3ef2013-06-17 15:04:07 +0200100 return trk_action - TCP_ACT_TRK_SC0;
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +0200101}
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +0200102
Willy Tarreaue6b98942007-10-29 01:09:36 +0100103#endif /* _PROTO_PROTO_TCP_H */
104
105/*
106 * Local variables:
107 * c-indent-level: 8
108 * c-basic-offset: 8
109 * End:
110 */