2 * Copyright (c) 2017 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 #include <vnet/session/transport_interface.h>
17 #include <vnet/session/session.h>
18 #include <vnet/fib/fib.h>
21 * Per-type vector of transport protocol virtual function tables
23 transport_proto_vft_t *tp_vfts;
28 static u32 port_allocator_seed;
31 * Local endpoints table
33 static transport_endpoint_table_t local_endpoints_table;
36 * Pool of local endpoints
38 static transport_endpoint_t *local_endpoints;
41 * Local endpoints pool lock
43 static clib_spinlock_t local_endpoints_lock;
46 format_transport_proto (u8 * s, va_list * args)
48 u32 transport_proto = va_arg (*args, u32);
49 switch (transport_proto)
51 case TRANSPORT_PROTO_TCP:
52 s = format (s, "TCP");
54 case TRANSPORT_PROTO_UDP:
55 s = format (s, "UDP");
62 unformat_transport_proto (unformat_input_t * input, va_list * args)
64 u32 *proto = va_arg (*args, u32 *);
65 if (unformat (input, "tcp"))
66 *proto = TRANSPORT_PROTO_TCP;
67 else if (unformat (input, "TCP"))
68 *proto = TRANSPORT_PROTO_TCP;
69 else if (unformat (input, "udp"))
70 *proto = TRANSPORT_PROTO_UDP;
71 else if (unformat (input, "UDP"))
72 *proto = TRANSPORT_PROTO_UDP;
79 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
80 ip46_address_t * ip, u16 port)
82 clib_bihash_kv_24_8_t kv;
85 kv.key[0] = ip->as_u64[0];
86 kv.key[1] = ip->as_u64[1];
87 kv.key[2] = (u64) port << 8 | (u64) proto;
89 rv = clib_bihash_search_inline_24_8 (ht, &kv);
93 return ENDPOINT_INVALID_INDEX;
97 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
98 transport_endpoint_t * te, u32 value)
100 clib_bihash_kv_24_8_t kv;
102 kv.key[0] = te->ip.as_u64[0];
103 kv.key[1] = te->ip.as_u64[1];
104 kv.key[2] = (u64) te->port << 8 | (u64) proto;
107 clib_bihash_add_del_24_8 (ht, &kv, 1);
111 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
112 transport_endpoint_t * te)
114 clib_bihash_kv_24_8_t kv;
116 kv.key[0] = te->ip.as_u64[0];
117 kv.key[1] = te->ip.as_u64[1];
118 kv.key[2] = (u64) te->port << 8 | (u64) proto;
120 clib_bihash_add_del_24_8 (ht, &kv, 0);
124 * Register transport virtual function table.
126 * @param type - session type (not protocol type)
127 * @param vft - virtual function table
130 transport_register_protocol (transport_proto_t transport_proto, u8 is_ip4,
131 const transport_proto_vft_t * vft)
134 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
136 vec_validate (tp_vfts, session_type);
137 tp_vfts[session_type] = *vft;
139 /* If an offset function is provided, then peek instead of dequeue */
140 session_manager_set_transport_rx_fn (session_type,
141 vft->tx_fifo_offset != 0);
145 * Get transport virtual function table
147 * @param type - session type (not protocol type)
149 transport_proto_vft_t *
150 transport_protocol_get_vft (u8 session_type)
152 if (session_type >= vec_len (tp_vfts))
154 return &tp_vfts[session_type];
157 #define PORT_MASK ((1 << 16)- 1)
160 transport_endpoint_del (u32 tepi)
162 clib_spinlock_lock_if_init (&local_endpoints_lock);
163 pool_put_index (local_endpoints, tepi);
164 clib_spinlock_unlock_if_init (&local_endpoints_lock);
167 always_inline transport_endpoint_t *
168 transport_endpoint_new (void)
170 transport_endpoint_t *tep;
171 pool_get (local_endpoints, tep);
176 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
179 transport_endpoint_t *tep;
181 /* Cleanup local endpoint if this was an active connect */
182 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
183 clib_net_to_host_u16 (port));
184 if (tepi != ENDPOINT_INVALID_INDEX)
186 tep = pool_elt_at_index (local_endpoints, tepi);
187 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
188 transport_endpoint_del (tepi);
193 * Allocate local port and add if successful add entry to local endpoint
194 * table to mark the pair as used.
197 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
199 transport_endpoint_t *tep;
201 u16 min = 1024, max = 65535; /* XXX configurable ? */
206 /* Only support active opens from thread 0 */
207 ASSERT (vlib_get_thread_index () == 0);
209 /* Search for first free slot */
210 for (tries = 0; tries < limit; tries++)
214 /* Find a port in the specified range */
217 port = random_u32 (&port_allocator_seed) & PORT_MASK;
218 if (PREDICT_TRUE (port >= min && port < max))
222 /* Look it up. If not found, we're done */
223 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
225 if (tei == ENDPOINT_INVALID_INDEX)
227 clib_spinlock_lock_if_init (&local_endpoints_lock);
228 tep = transport_endpoint_new ();
229 clib_memcpy (&tep->ip, ip, sizeof (*ip));
231 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
232 tep - local_endpoints);
233 clib_spinlock_unlock_if_init (&local_endpoints_lock);
242 transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
243 ip46_address_t * lcl_addr, u16 * lcl_port)
246 fib_node_index_t fei;
251 * Find the local address and allocate port
254 /* Find a FIB path to the destination */
255 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
256 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
257 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
259 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
260 fei = fib_table_lookup (rmt->fib_index, &prefix);
262 /* Couldn't find route to destination. Bail out. */
263 if (fei == FIB_NODE_INDEX_INVALID)
265 clib_warning ("no route to destination");
269 sw_if_index = rmt->sw_if_index;
270 if (sw_if_index == ENDPOINT_INVALID_INDEX)
271 sw_if_index = fib_entry_get_resolving_interface (fei);
273 if (sw_if_index == ENDPOINT_INVALID_INDEX)
275 clib_warning ("no resolving interface for %U", format_ip46_address,
276 &rmt->ip, (rmt->is_ip4 == 0) + 1);
280 memset (lcl_addr, 0, sizeof (*lcl_addr));
285 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
286 lcl_addr->ip4.as_u32 = ip4->as_u32;
291 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
294 clib_warning ("no routable ip6 addresses on %U",
295 format_vnet_sw_if_index_name, vnet_get_main (),
299 clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
302 /* Allocate source port */
303 port = transport_alloc_local_port (proto, lcl_addr);
306 clib_warning ("Failed to allocate src port");
314 transport_init (void)
316 vlib_thread_main_t *vtm = vlib_get_thread_main ();
317 u32 local_endpoints_table_buckets = 250000;
318 u32 local_endpoints_table_memory = 512 << 20;
321 /* Initialize [port-allocator] random number seed */
322 port_allocator_seed = (u32) clib_cpu_time_now ();
324 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
325 local_endpoints_table_buckets,
326 local_endpoints_table_memory);
327 num_threads = 1 /* main thread */ + vtm->n_threads;
329 clib_spinlock_init (&local_endpoints_lock);
333 * fd.io coding-style-patch-verification: ON
336 * eval: (c-set-style "gnu")