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>
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 */
40 /** Macros for 'derived classes' where base is named "connection" */
41 #define c_lcl_ip connection.lcl_ip
42 #define c_rmt_ip connection.rmt_ip
43 #define c_lcl_ip4 connection.lcl_ip.ip4
44 #define c_rmt_ip4 connection.rmt_ip.ip4
45 #define c_lcl_ip6 connection.lcl_ip.ip6
46 #define c_rmt_ip6 connection.rmt_ip.ip6
47 #define c_lcl_port connection.lcl_port
48 #define c_rmt_port connection.rmt_port
49 #define c_proto connection.proto
50 #define c_state connection.state
51 #define c_s_index connection.s_index
52 #define c_c_index connection.c_index
53 #define c_is_ip4 connection.is_ip4
54 #define c_thread_index connection.thread_index
55 } transport_connection_t;
58 * Transport protocol virtual function table
60 typedef struct _transport_proto_vft
65 u32 (*bind) (vlib_main_t *, u32, ip46_address_t *, u16);
66 u32 (*unbind) (vlib_main_t *, u32);
67 int (*open) (ip46_address_t * addr, u16 port_host_byte_order);
68 void (*close) (u32 conn_index, u32 thread_index);
69 void (*cleanup) (u32 conn_index, u32 thread_index);
74 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
75 u16 (*send_mss) (transport_connection_t * tc);
76 u32 (*send_space) (transport_connection_t * tc);
77 u32 (*tx_fifo_offset) (transport_connection_t * tc);
80 * Connection retrieval
82 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
83 transport_connection_t *(*get_listener) (u32 conn_index);
84 transport_connection_t *(*get_half_open) (u32 conn_index);
89 u8 *(*format_connection) (u8 * s, va_list * args);
90 u8 *(*format_listener) (u8 * s, va_list * args);
91 u8 *(*format_half_open) (u8 * s, va_list * args);
93 } transport_proto_vft_t;
97 typedef CLIB_PACKED (struct {
102 ip4_address_t src; ip4_address_t dst;
105 /* align by making this 4 octets even though its a 1-bit field
106 * NOTE: avoid key overlap with other transports that use 5 tuples for
107 * session identification.
113 }) v4_connection_key_t;
115 typedef CLIB_PACKED (struct {
121 ip6_address_t src; ip6_address_t dst;
123 u16 dst_port; u32 proto; u8 unused_for_now[8];
126 }) v6_connection_key_t;
129 typedef clib_bihash_kv_16_8_t session_kv4_t;
130 typedef clib_bihash_kv_48_8_t session_kv6_t;
133 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
134 u16 lcl_port, u16 rmt_port, u8 proto)
136 v4_connection_key_t key;
137 memset (&key, 0, sizeof (v4_connection_key_t));
139 key.src.as_u32 = lcl->as_u32;
140 key.dst.as_u32 = rmt->as_u32;
141 key.src_port = lcl_port;
142 key.dst_port = rmt_port;
145 kv->key[0] = key.as_u64[0];
146 kv->key[1] = key.as_u64[1];
151 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
154 v4_connection_key_t key;
155 memset (&key, 0, sizeof (v4_connection_key_t));
157 key.src.as_u32 = lcl->as_u32;
159 key.src_port = lcl_port;
163 kv->key[0] = key.as_u64[0];
164 kv->key[1] = key.as_u64[1];
169 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
171 return make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port,
172 t->rmt_port, t->proto);
176 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
177 u16 lcl_port, u16 rmt_port, u8 proto)
179 v6_connection_key_t key;
180 memset (&key, 0, sizeof (v6_connection_key_t));
182 key.src.as_u64[0] = lcl->as_u64[0];
183 key.src.as_u64[1] = lcl->as_u64[1];
184 key.dst.as_u64[0] = rmt->as_u64[0];
185 key.dst.as_u64[1] = rmt->as_u64[1];
186 key.src_port = lcl_port;
187 key.dst_port = rmt_port;
190 kv->key[0] = key.as_u64[0];
191 kv->key[1] = key.as_u64[1];
200 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
203 v6_connection_key_t key;
204 memset (&key, 0, sizeof (v6_connection_key_t));
206 key.src.as_u64[0] = lcl->as_u64[0];
207 key.src.as_u64[1] = lcl->as_u64[1];
208 key.dst.as_u64[0] = 0;
209 key.dst.as_u64[1] = 0;
210 key.src_port = lcl_port;
214 kv->key[0] = key.as_u64[0];
215 kv->key[1] = key.as_u64[1];
224 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
226 make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port,
227 t->rmt_port, t->proto);
230 typedef struct _transport_endpoint
236 } transport_endpoint_t;
238 typedef clib_bihash_24_8_t transport_endpoint_table_t;
240 #define TRANSPORT_ENDPOINT_INVALID_INDEX ((u32)~0)
243 transport_endpoint_lookup (transport_endpoint_table_t * ht,
244 ip46_address_t * ip, u16 port);
245 void transport_endpoint_table_add (transport_endpoint_table_t * ht,
246 transport_endpoint_t * te, u32 value);
247 void transport_endpoint_table_del (transport_endpoint_table_t * ht,
248 transport_endpoint_t * te);
250 #endif /* VNET_VNET_URI_TRANSPORT_H_ */
253 * fd.io coding-style-patch-verification: ON
256 * eval: (c-set-style "gnu")