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; /**< Protocol id (also session type) */
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 fib_node_index_t rmt_fei; /**< FIB entry index for rmt */
41 dpo_id_t rmt_dpo; /**< Forwarding DPO for rmt */
44 elog_track_t elog_track; /**< Event logging */
45 u32 cc_stat_tstamp; /**< CC stats timestamp */
48 /** Macros for 'derived classes' where base is named "connection" */
49 #define c_lcl_ip connection.lcl_ip
50 #define c_rmt_ip connection.rmt_ip
51 #define c_lcl_ip4 connection.lcl_ip.ip4
52 #define c_rmt_ip4 connection.rmt_ip.ip4
53 #define c_lcl_ip6 connection.lcl_ip.ip6
54 #define c_rmt_ip6 connection.rmt_ip.ip6
55 #define c_lcl_port connection.lcl_port
56 #define c_rmt_port connection.rmt_port
57 #define c_proto connection.proto
58 #define c_state connection.state
59 #define c_s_index connection.s_index
60 #define c_c_index connection.c_index
61 #define c_is_ip4 connection.is_ip4
62 #define c_thread_index connection.thread_index
63 #define c_elog_track connection.elog_track
64 #define c_cc_stat_tstamp connection.cc_stat_tstamp
65 #define c_rmt_fei connection.rmt_fei
66 #define c_rmt_dpo connection.rmt_dpo
67 } transport_connection_t;
70 * Transport protocol virtual function table
72 typedef struct _transport_proto_vft
77 u32 (*bind) (u32, ip46_address_t *, u16);
79 int (*open) (ip46_address_t * addr, u16 port_host_byte_order);
80 void (*close) (u32 conn_index, u32 thread_index);
81 void (*cleanup) (u32 conn_index, u32 thread_index);
86 u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
87 u16 (*send_mss) (transport_connection_t * tc);
88 u32 (*send_space) (transport_connection_t * tc);
89 u32 (*tx_fifo_offset) (transport_connection_t * tc);
92 * Connection retrieval
94 transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
95 transport_connection_t *(*get_listener) (u32 conn_index);
96 transport_connection_t *(*get_half_open) (u32 conn_index);
101 u8 *(*format_connection) (u8 * s, va_list * args);
102 u8 *(*format_listener) (u8 * s, va_list * args);
103 u8 *(*format_half_open) (u8 * s, va_list * args);
104 } transport_proto_vft_t;
108 typedef CLIB_PACKED (struct {
117 /* align by making this 4 octets even though its a 1-bit field
118 * NOTE: avoid key overlap with other transports that use 5 tuples for
119 * session identification.
125 }) v4_connection_key_t;
127 typedef CLIB_PACKED (struct {
142 }) v6_connection_key_t;
145 typedef clib_bihash_kv_16_8_t session_kv4_t;
146 typedef clib_bihash_kv_48_8_t session_kv6_t;
149 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
150 u16 lcl_port, u16 rmt_port, u8 proto)
152 v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
154 key->src.as_u32 = lcl->as_u32;
155 key->dst.as_u32 = rmt->as_u32;
156 key->src_port = lcl_port;
157 key->dst_port = rmt_port;
164 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
167 v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
169 key->src.as_u32 = lcl->as_u32;
171 key->src_port = lcl_port;
179 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
181 return make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port,
182 t->rmt_port, t->proto);
186 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
187 u16 lcl_port, u16 rmt_port, u8 proto)
189 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
191 key->src.as_u64[0] = lcl->as_u64[0];
192 key->src.as_u64[1] = lcl->as_u64[1];
193 key->dst.as_u64[0] = rmt->as_u64[0];
194 key->dst.as_u64[1] = rmt->as_u64[1];
195 key->src_port = lcl_port;
196 key->dst_port = rmt_port;
204 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
207 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
209 key->src.as_u64[0] = lcl->as_u64[0];
210 key->src.as_u64[1] = lcl->as_u64[1];
211 key->dst.as_u64[0] = 0;
212 key->dst.as_u64[1] = 0;
213 key->src_port = lcl_port;
222 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
224 make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port,
225 t->rmt_port, t->proto);
228 typedef enum _transport_proto
234 typedef struct _transport_endpoint
236 ip46_address_t ip; /** ip address */
237 u16 port; /** port in host order */
238 u8 is_ip4; /** 1 if ip4 */
239 u32 vrf; /** fib table the endpoint is associated with */
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")