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:
76 case TRANSPORT_PROTO_SCTP:
84 unformat_transport_proto (unformat_input_t * input, va_list * args)
86 u32 *proto = va_arg (*args, u32 *);
87 if (unformat (input, "tcp"))
88 *proto = TRANSPORT_PROTO_TCP;
89 else if (unformat (input, "TCP"))
90 *proto = TRANSPORT_PROTO_TCP;
91 else if (unformat (input, "udp"))
92 *proto = TRANSPORT_PROTO_UDP;
93 else if (unformat (input, "UDP"))
94 *proto = TRANSPORT_PROTO_UDP;
95 else if (unformat (input, "sctp"))
96 *proto = TRANSPORT_PROTO_SCTP;
97 else if (unformat (input, "SCTP"))
98 *proto = TRANSPORT_PROTO_SCTP;
105 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
106 ip46_address_t * ip, u16 port)
108 clib_bihash_kv_24_8_t kv;
111 kv.key[0] = ip->as_u64[0];
112 kv.key[1] = ip->as_u64[1];
113 kv.key[2] = (u64) port << 8 | (u64) proto;
115 rv = clib_bihash_search_inline_24_8 (ht, &kv);
119 return ENDPOINT_INVALID_INDEX;
123 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
124 transport_endpoint_t * te, u32 value)
126 clib_bihash_kv_24_8_t kv;
128 kv.key[0] = te->ip.as_u64[0];
129 kv.key[1] = te->ip.as_u64[1];
130 kv.key[2] = (u64) te->port << 8 | (u64) proto;
133 clib_bihash_add_del_24_8 (ht, &kv, 1);
137 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
138 transport_endpoint_t * te)
140 clib_bihash_kv_24_8_t kv;
142 kv.key[0] = te->ip.as_u64[0];
143 kv.key[1] = te->ip.as_u64[1];
144 kv.key[2] = (u64) te->port << 8 | (u64) proto;
146 clib_bihash_add_del_24_8 (ht, &kv, 0);
150 * Register transport virtual function table.
152 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
153 * @param vft - virtual function table for transport proto
154 * @param fib_proto - network layer protocol
155 * @param output_node - output node index that session layer will hand off
156 * buffers to, for requested fib proto
159 transport_register_protocol (transport_proto_t transport_proto,
160 const transport_proto_vft_t * vft,
161 fib_protocol_t fib_proto, u32 output_node)
163 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
165 vec_validate (tp_vfts, transport_proto);
166 tp_vfts[transport_proto] = *vft;
168 session_register_transport (transport_proto, vft, is_ip4, output_node);
172 * Get transport virtual function table
174 * @param type - session type (not protocol type)
176 transport_proto_vft_t *
177 transport_protocol_get_vft (transport_proto_t transport_proto)
179 if (transport_proto >= vec_len (tp_vfts))
181 return &tp_vfts[transport_proto];
184 #define PORT_MASK ((1 << 16)- 1)
187 transport_endpoint_del (u32 tepi)
189 clib_spinlock_lock_if_init (&local_endpoints_lock);
190 pool_put_index (local_endpoints, tepi);
191 clib_spinlock_unlock_if_init (&local_endpoints_lock);
194 always_inline transport_endpoint_t *
195 transport_endpoint_new (void)
197 transport_endpoint_t *tep;
198 pool_get (local_endpoints, tep);
203 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
206 transport_endpoint_t *tep;
208 /* Cleanup local endpoint if this was an active connect */
209 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
210 clib_net_to_host_u16 (port));
211 if (tepi != ENDPOINT_INVALID_INDEX)
213 tep = pool_elt_at_index (local_endpoints, tepi);
214 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
215 transport_endpoint_del (tepi);
220 * Allocate local port and add if successful add entry to local endpoint
221 * table to mark the pair as used.
224 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
226 transport_endpoint_t *tep;
228 u16 min = 1024, max = 65535; /* XXX configurable ? */
233 /* Only support active opens from thread 0 */
234 ASSERT (vlib_get_thread_index () == 0);
236 /* Search for first free slot */
237 for (tries = 0; tries < limit; tries++)
241 /* Find a port in the specified range */
244 port = random_u32 (&port_allocator_seed) & PORT_MASK;
245 if (PREDICT_TRUE (port >= min && port < max))
249 /* Look it up. If not found, we're done */
250 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
252 if (tei == ENDPOINT_INVALID_INDEX)
254 clib_spinlock_lock_if_init (&local_endpoints_lock);
255 tep = transport_endpoint_new ();
256 clib_memcpy (&tep->ip, ip, sizeof (*ip));
258 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
259 tep - local_endpoints);
260 clib_spinlock_unlock_if_init (&local_endpoints_lock);
269 transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
270 ip46_address_t * lcl_addr, u16 * lcl_port)
273 fib_node_index_t fei;
278 * Find the local address and allocate port
281 /* Find a FIB path to the destination */
282 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
283 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
284 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
286 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
287 fei = fib_table_lookup (rmt->fib_index, &prefix);
289 /* Couldn't find route to destination. Bail out. */
290 if (fei == FIB_NODE_INDEX_INVALID)
292 clib_warning ("no route to destination");
296 sw_if_index = rmt->sw_if_index;
297 if (sw_if_index == ENDPOINT_INVALID_INDEX)
298 sw_if_index = fib_entry_get_resolving_interface (fei);
300 if (sw_if_index == ENDPOINT_INVALID_INDEX)
302 clib_warning ("no resolving interface for %U", format_ip46_address,
303 &rmt->ip, (rmt->is_ip4 == 0) + 1);
307 memset (lcl_addr, 0, sizeof (*lcl_addr));
312 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
313 lcl_addr->ip4.as_u32 = ip4->as_u32;
318 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
321 clib_warning ("no routable ip6 addresses on %U",
322 format_vnet_sw_if_index_name, vnet_get_main (),
326 clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
329 /* Allocate source port */
330 port = transport_alloc_local_port (proto, lcl_addr);
333 clib_warning ("Failed to allocate src port");
341 transport_update_time (f64 time_now, u8 thread_index)
343 transport_proto_vft_t *vft;
344 vec_foreach (vft, tp_vfts)
346 if (vft->update_time)
347 (vft->update_time) (time_now, thread_index);
352 transport_enable_disable (vlib_main_t * vm, u8 is_en)
354 transport_proto_vft_t *vft;
355 vec_foreach (vft, tp_vfts)
358 (vft->enable) (vm, is_en);
363 transport_init (void)
365 vlib_thread_main_t *vtm = vlib_get_thread_main ();
366 session_manager_main_t *smm = vnet_get_session_manager_main ();
369 if (smm->local_endpoints_table_buckets == 0)
370 smm->local_endpoints_table_buckets = 250000;
371 if (smm->local_endpoints_table_memory == 0)
372 smm->local_endpoints_table_memory = 512 << 20;
374 /* Initialize [port-allocator] random number seed */
375 port_allocator_seed = (u32) clib_cpu_time_now ();
377 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
378 smm->local_endpoints_table_buckets,
379 smm->local_endpoints_table_memory);
380 num_threads = 1 /* main thread */ + vtm->n_threads;
382 clib_spinlock_init (&local_endpoints_lock);
386 * fd.io coding-style-patch-verification: ON
389 * eval: (c-set-style "gnu")