2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef VNET_VNET_URI_TRANSPORT_H_
17 #define VNET_VNET_URI_TRANSPORT_H_
19 #include <vnet/vnet.h>
20 #include <vnet/ip/ip.h>
21 #include <vppinfra/bihash_16_8.h>
22 #include <vppinfra/bihash_48_8.h>
23 #include <vnet/tcp/tcp_debug.h>
25 * Protocol independent transport properties associated to a session
27 typedef struct _transport_connection
29 ip46_address_t rmt_ip; /**< Remote IP */
30 ip46_address_t lcl_ip; /**< Local IP */
31 u16 lcl_port; /**< Local port */
32 u16 rmt_port; /**< Remote port */
33 u8 proto; /**< Transport protocol id */
35 u32 s_index; /**< Parent session index */
36 u32 c_index; /**< Connection index in transport pool */
37 u8 is_ip4; /**< Flag if IP4 connection */
38 u32 thread_index; /**< Worker-thread index */
41 elog_track_t elog_track; /**< Event logging */
44 /** Macros for 'derived classes' where base is named "connection" */
45 #define c_lcl_ip connection.lcl_ip
46 #define c_rmt_ip connection.rmt_ip
47 #define c_lcl_ip4 connection.lcl_ip.ip4
48 #define c_rmt_ip4 connection.rmt_ip.ip4
49 #define c_lcl_ip6 connection.lcl_ip.ip6
50 #define c_rmt_ip6 connection.rmt_ip.ip6
51 #define c_lcl_port connection.lcl_port
52 #define c_rmt_port connection.rmt_port
53 #define c_proto connection.proto
54 #define c_state connection.state
55 #define c_s_index connection.s_index
56 #define c_c_index connection.c_index
57 #define c_is_ip4 connection.is_ip4
58 #define c_thread_index connection.thread_index
59 #define c_elog_track connection.elog_track
60 } transport_connection_t;
63 * Transport protocol virtual function table
65 typedef struct _transport_proto_vft
70 u32 (*bind) (u32, ip46_address_t *, u16);
72 int (*open) (ip46_address_t * addr, u16 port_host_byte_order);
73 void (*close) (u32 conn_index, u32 thread_index);
74 void (*cleanup) (u32 conn_index, u32 thread_index);
79 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
80 u16 (*send_mss) (transport_connection_t * tc);
81 u32 (*send_space) (transport_connection_t * tc);
82 u32 (*tx_fifo_offset) (transport_connection_t * tc);
85 * Connection retrieval
87 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
88 transport_connection_t *(*get_listener) (u32 conn_index);
89 transport_connection_t *(*get_half_open) (u32 conn_index);
94 u8 *(*format_connection) (u8 * s, va_list * args);
95 u8 *(*format_listener) (u8 * s, va_list * args);
96 u8 *(*format_half_open) (u8 * s, va_list * args);
97 } transport_proto_vft_t;
101 typedef CLIB_PACKED (struct {
106 ip4_address_t src; ip4_address_t dst;
109 /* align by making this 4 octets even though its a 1-bit field
110 * NOTE: avoid key overlap with other transports that use 5 tuples for
111 * session identification.
117 }) v4_connection_key_t;
119 typedef CLIB_PACKED (struct {
125 ip6_address_t src; ip6_address_t dst;
127 u16 dst_port; u32 proto; u8 unused_for_now[8];
130 }) v6_connection_key_t;
133 typedef clib_bihash_kv_16_8_t session_kv4_t;
134 typedef clib_bihash_kv_48_8_t session_kv6_t;
137 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
138 u16 lcl_port, u16 rmt_port, u8 proto)
140 v4_connection_key_t key;
141 memset (&key, 0, sizeof (v4_connection_key_t));
143 key.src.as_u32 = lcl->as_u32;
144 key.dst.as_u32 = rmt->as_u32;
145 key.src_port = lcl_port;
146 key.dst_port = rmt_port;
149 kv->key[0] = key.as_u64[0];
150 kv->key[1] = key.as_u64[1];
155 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
158 v4_connection_key_t key;
159 memset (&key, 0, sizeof (v4_connection_key_t));
161 key.src.as_u32 = lcl->as_u32;
163 key.src_port = lcl_port;
167 kv->key[0] = key.as_u64[0];
168 kv->key[1] = key.as_u64[1];
173 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
175 return make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port,
176 t->rmt_port, t->proto);
180 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
181 u16 lcl_port, u16 rmt_port, u8 proto)
183 v6_connection_key_t key;
184 memset (&key, 0, sizeof (v6_connection_key_t));
186 key.src.as_u64[0] = lcl->as_u64[0];
187 key.src.as_u64[1] = lcl->as_u64[1];
188 key.dst.as_u64[0] = rmt->as_u64[0];
189 key.dst.as_u64[1] = rmt->as_u64[1];
190 key.src_port = lcl_port;
191 key.dst_port = rmt_port;
194 kv->key[0] = key.as_u64[0];
195 kv->key[1] = key.as_u64[1];
204 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
207 v6_connection_key_t key;
208 memset (&key, 0, sizeof (v6_connection_key_t));
210 key.src.as_u64[0] = lcl->as_u64[0];
211 key.src.as_u64[1] = lcl->as_u64[1];
212 key.dst.as_u64[0] = 0;
213 key.dst.as_u64[1] = 0;
214 key.src_port = lcl_port;
218 kv->key[0] = key.as_u64[0];
219 kv->key[1] = key.as_u64[1];
228 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
230 make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port,
231 t->rmt_port, t->proto);
234 typedef struct _transport_endpoint
240 } transport_endpoint_t;
242 typedef clib_bihash_24_8_t transport_endpoint_table_t;
244 #define TRANSPORT_ENDPOINT_INVALID_INDEX ((u32)~0)
247 transport_endpoint_lookup (transport_endpoint_table_t * ht,
248 ip46_address_t * ip, u16 port);
249 void transport_endpoint_table_add (transport_endpoint_table_t * ht,
250 transport_endpoint_t * te, u32 value);
251 void transport_endpoint_table_del (transport_endpoint_table_t * ht,
252 transport_endpoint_t * te);
254 #endif /* VNET_VNET_URI_TRANSPORT_H_ */
257 * fd.io coding-style-patch-verification: ON
260 * eval: (c-set-style "gnu")