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");
57 case TRANSPORT_PROTO_SCTP:
58 s = format (s, "SCTP");
65 format_transport_proto_short (u8 * s, va_list * args)
67 u32 transport_proto = va_arg (*args, u32);
68 switch (transport_proto)
70 case TRANSPORT_PROTO_TCP:
73 case TRANSPORT_PROTO_UDP:
81 unformat_transport_proto (unformat_input_t * input, va_list * args)
83 u32 *proto = va_arg (*args, u32 *);
84 if (unformat (input, "tcp"))
85 *proto = TRANSPORT_PROTO_TCP;
86 else if (unformat (input, "TCP"))
87 *proto = TRANSPORT_PROTO_TCP;
88 else if (unformat (input, "udp"))
89 *proto = TRANSPORT_PROTO_UDP;
90 else if (unformat (input, "UDP"))
91 *proto = TRANSPORT_PROTO_UDP;
92 if (unformat (input, "sctp"))
93 *proto = TRANSPORT_PROTO_SCTP;
94 else if (unformat (input, "SCTP"))
95 *proto = TRANSPORT_PROTO_SCTP;
102 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
103 ip46_address_t * ip, u16 port)
105 clib_bihash_kv_24_8_t kv;
108 kv.key[0] = ip->as_u64[0];
109 kv.key[1] = ip->as_u64[1];
110 kv.key[2] = (u64) port << 8 | (u64) proto;
112 rv = clib_bihash_search_inline_24_8 (ht, &kv);
116 return ENDPOINT_INVALID_INDEX;
120 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
121 transport_endpoint_t * te, u32 value)
123 clib_bihash_kv_24_8_t kv;
125 kv.key[0] = te->ip.as_u64[0];
126 kv.key[1] = te->ip.as_u64[1];
127 kv.key[2] = (u64) te->port << 8 | (u64) proto;
130 clib_bihash_add_del_24_8 (ht, &kv, 1);
134 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
135 transport_endpoint_t * te)
137 clib_bihash_kv_24_8_t kv;
139 kv.key[0] = te->ip.as_u64[0];
140 kv.key[1] = te->ip.as_u64[1];
141 kv.key[2] = (u64) te->port << 8 | (u64) proto;
143 clib_bihash_add_del_24_8 (ht, &kv, 0);
147 * Register transport virtual function table.
149 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
150 * @param vft - virtual function table for transport proto
151 * @param fib_proto - network layer protocol
152 * @param output_node - output node index that session layer will hand off
153 * buffers to, for requested fib proto
156 transport_register_protocol (transport_proto_t transport_proto,
157 const transport_proto_vft_t * vft,
158 fib_protocol_t fib_proto, u32 output_node)
160 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
162 vec_validate (tp_vfts, transport_proto);
163 tp_vfts[transport_proto] = *vft;
165 session_register_transport (transport_proto, vft, is_ip4, output_node);
169 * Get transport virtual function table
171 * @param type - session type (not protocol type)
173 transport_proto_vft_t *
174 transport_protocol_get_vft (transport_proto_t transport_proto)
176 if (transport_proto >= vec_len (tp_vfts))
178 return &tp_vfts[transport_proto];
181 #define PORT_MASK ((1 << 16)- 1)
184 transport_endpoint_del (u32 tepi)
186 clib_spinlock_lock_if_init (&local_endpoints_lock);
187 pool_put_index (local_endpoints, tepi);
188 clib_spinlock_unlock_if_init (&local_endpoints_lock);
191 always_inline transport_endpoint_t *
192 transport_endpoint_new (void)
194 transport_endpoint_t *tep;
195 pool_get (local_endpoints, tep);
200 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
203 transport_endpoint_t *tep;
205 /* Cleanup local endpoint if this was an active connect */
206 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
207 clib_net_to_host_u16 (port));
208 if (tepi != ENDPOINT_INVALID_INDEX)
210 tep = pool_elt_at_index (local_endpoints, tepi);
211 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
212 transport_endpoint_del (tepi);
217 * Allocate local port and add if successful add entry to local endpoint
218 * table to mark the pair as used.
221 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
223 transport_endpoint_t *tep;
225 u16 min = 1024, max = 65535; /* XXX configurable ? */
230 /* Only support active opens from thread 0 */
231 ASSERT (vlib_get_thread_index () == 0);
233 /* Search for first free slot */
234 for (tries = 0; tries < limit; tries++)
238 /* Find a port in the specified range */
241 port = random_u32 (&port_allocator_seed) & PORT_MASK;
242 if (PREDICT_TRUE (port >= min && port < max))
246 /* Look it up. If not found, we're done */
247 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
249 if (tei == ENDPOINT_INVALID_INDEX)
251 clib_spinlock_lock_if_init (&local_endpoints_lock);
252 tep = transport_endpoint_new ();
253 clib_memcpy (&tep->ip, ip, sizeof (*ip));
255 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
256 tep - local_endpoints);
257 clib_spinlock_unlock_if_init (&local_endpoints_lock);
266 transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
267 ip46_address_t * lcl_addr, u16 * lcl_port)
270 fib_node_index_t fei;
275 * Find the local address and allocate port
278 /* Find a FIB path to the destination */
279 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
280 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
281 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
283 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
284 fei = fib_table_lookup (rmt->fib_index, &prefix);
286 /* Couldn't find route to destination. Bail out. */
287 if (fei == FIB_NODE_INDEX_INVALID)
289 clib_warning ("no route to destination");
293 sw_if_index = rmt->sw_if_index;
294 if (sw_if_index == ENDPOINT_INVALID_INDEX)
295 sw_if_index = fib_entry_get_resolving_interface (fei);
297 if (sw_if_index == ENDPOINT_INVALID_INDEX)
299 clib_warning ("no resolving interface for %U", format_ip46_address,
300 &rmt->ip, (rmt->is_ip4 == 0) + 1);
304 memset (lcl_addr, 0, sizeof (*lcl_addr));
309 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
310 lcl_addr->ip4.as_u32 = ip4->as_u32;
315 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
318 clib_warning ("no routable ip6 addresses on %U",
319 format_vnet_sw_if_index_name, vnet_get_main (),
323 clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
326 /* Allocate source port */
327 port = transport_alloc_local_port (proto, lcl_addr);
330 clib_warning ("Failed to allocate src port");
338 transport_update_time (f64 time_now, u8 thread_index)
340 transport_proto_vft_t *vft;
341 vec_foreach (vft, tp_vfts)
343 if (vft->update_time)
344 (vft->update_time) (time_now, thread_index);
349 transport_enable_disable (vlib_main_t * vm, u8 is_en)
351 transport_proto_vft_t *vft;
352 vec_foreach (vft, tp_vfts)
355 (vft->enable) (vm, is_en);
360 transport_init (void)
362 vlib_thread_main_t *vtm = vlib_get_thread_main ();
363 session_manager_main_t *smm = vnet_get_session_manager_main ();
366 if (smm->local_endpoints_table_buckets == 0)
367 smm->local_endpoints_table_buckets = 250000;
368 if (smm->local_endpoints_table_memory == 0)
369 smm->local_endpoints_table_memory = 512 << 20;
371 /* Initialize [port-allocator] random number seed */
372 port_allocator_seed = (u32) clib_cpu_time_now ();
374 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
375 smm->local_endpoints_table_buckets,
376 smm->local_endpoints_table_memory);
377 num_threads = 1 /* main thread */ + vtm->n_threads;
379 clib_spinlock_init (&local_endpoints_lock);
383 * fd.io coding-style-patch-verification: ON
386 * eval: (c-set-style "gnu")