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");
60 case TRANSPORT_PROTO_UDPC:
61 s = format (s, "UDPC");
68 format_transport_proto_short (u8 * s, va_list * args)
70 u32 transport_proto = va_arg (*args, u32);
71 switch (transport_proto)
73 case TRANSPORT_PROTO_TCP:
76 case TRANSPORT_PROTO_UDP:
79 case TRANSPORT_PROTO_SCTP:
82 case TRANSPORT_PROTO_UDPC:
90 unformat_transport_proto (unformat_input_t * input, va_list * args)
92 u32 *proto = va_arg (*args, u32 *);
93 if (unformat (input, "tcp"))
94 *proto = TRANSPORT_PROTO_TCP;
95 else if (unformat (input, "TCP"))
96 *proto = TRANSPORT_PROTO_TCP;
97 else if (unformat (input, "udp"))
98 *proto = TRANSPORT_PROTO_UDP;
99 else if (unformat (input, "UDP"))
100 *proto = TRANSPORT_PROTO_UDP;
101 else if (unformat (input, "sctp"))
102 *proto = TRANSPORT_PROTO_SCTP;
103 else if (unformat (input, "SCTP"))
104 *proto = TRANSPORT_PROTO_SCTP;
105 else if (unformat (input, "tls"))
106 *proto = TRANSPORT_PROTO_TLS;
107 else if (unformat (input, "TLS"))
108 *proto = TRANSPORT_PROTO_TLS;
109 else if (unformat (input, "udpc"))
110 *proto = TRANSPORT_PROTO_UDPC;
111 else if (unformat (input, "UDPC"))
112 *proto = TRANSPORT_PROTO_UDPC;
119 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
120 ip46_address_t * ip, u16 port)
122 clib_bihash_kv_24_8_t kv;
125 kv.key[0] = ip->as_u64[0];
126 kv.key[1] = ip->as_u64[1];
127 kv.key[2] = (u64) port << 8 | (u64) proto;
129 rv = clib_bihash_search_inline_24_8 (ht, &kv);
133 return ENDPOINT_INVALID_INDEX;
137 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
138 transport_endpoint_t * te, u32 value)
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;
147 clib_bihash_add_del_24_8 (ht, &kv, 1);
151 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
152 transport_endpoint_t * te)
154 clib_bihash_kv_24_8_t kv;
156 kv.key[0] = te->ip.as_u64[0];
157 kv.key[1] = te->ip.as_u64[1];
158 kv.key[2] = (u64) te->port << 8 | (u64) proto;
160 clib_bihash_add_del_24_8 (ht, &kv, 0);
164 * Register transport virtual function table.
166 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
167 * @param vft - virtual function table for transport proto
168 * @param fib_proto - network layer protocol
169 * @param output_node - output node index that session layer will hand off
170 * buffers to, for requested fib proto
173 transport_register_protocol (transport_proto_t transport_proto,
174 const transport_proto_vft_t * vft,
175 fib_protocol_t fib_proto, u32 output_node)
177 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
179 vec_validate (tp_vfts, transport_proto);
180 tp_vfts[transport_proto] = *vft;
182 session_register_transport (transport_proto, vft, is_ip4, output_node);
186 * Get transport virtual function table
188 * @param type - session type (not protocol type)
190 transport_proto_vft_t *
191 transport_protocol_get_vft (transport_proto_t transport_proto)
193 if (transport_proto >= vec_len (tp_vfts))
195 return &tp_vfts[transport_proto];
198 transport_service_type_t
199 transport_protocol_service_type (transport_proto_t tp)
201 return tp_vfts[tp].service_type;
204 transport_tx_fn_type_t
205 transport_protocol_tx_fn_type (transport_proto_t tp)
207 return tp_vfts[tp].tx_type;
210 #define PORT_MASK ((1 << 16)- 1)
213 transport_endpoint_del (u32 tepi)
215 clib_spinlock_lock_if_init (&local_endpoints_lock);
216 pool_put_index (local_endpoints, tepi);
217 clib_spinlock_unlock_if_init (&local_endpoints_lock);
220 always_inline transport_endpoint_t *
221 transport_endpoint_new (void)
223 transport_endpoint_t *tep;
224 pool_get (local_endpoints, tep);
229 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
232 transport_endpoint_t *tep;
234 /* Cleanup local endpoint if this was an active connect */
235 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
236 clib_net_to_host_u16 (port));
237 if (tepi != ENDPOINT_INVALID_INDEX)
239 tep = pool_elt_at_index (local_endpoints, tepi);
240 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
241 transport_endpoint_del (tepi);
246 * Allocate local port and add if successful add entry to local endpoint
247 * table to mark the pair as used.
250 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
252 transport_endpoint_t *tep;
254 u16 min = 1024, max = 65535; /* XXX configurable ? */
259 /* Only support active opens from thread 0 */
260 ASSERT (vlib_get_thread_index () == 0);
262 /* Search for first free slot */
263 for (tries = 0; tries < limit; tries++)
267 /* Find a port in the specified range */
270 port = random_u32 (&port_allocator_seed) & PORT_MASK;
271 if (PREDICT_TRUE (port >= min && port < max))
275 /* Look it up. If not found, we're done */
276 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
278 if (tei == ENDPOINT_INVALID_INDEX)
280 clib_spinlock_lock_if_init (&local_endpoints_lock);
281 tep = transport_endpoint_new ();
282 clib_memcpy (&tep->ip, ip, sizeof (*ip));
284 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
285 tep - local_endpoints);
286 clib_spinlock_unlock_if_init (&local_endpoints_lock);
295 transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
296 ip46_address_t * lcl_addr, u16 * lcl_port)
299 fib_node_index_t fei;
304 * Find the local address and allocate port
307 /* Find a FIB path to the destination */
308 clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
309 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
310 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
312 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
313 fei = fib_table_lookup (rmt->fib_index, &prefix);
315 /* Couldn't find route to destination. Bail out. */
316 if (fei == FIB_NODE_INDEX_INVALID)
318 clib_warning ("no route to destination");
322 sw_if_index = rmt->sw_if_index;
323 if (sw_if_index == ENDPOINT_INVALID_INDEX)
324 sw_if_index = fib_entry_get_resolving_interface (fei);
326 if (sw_if_index == ENDPOINT_INVALID_INDEX)
328 clib_warning ("no resolving interface for %U", format_ip46_address,
329 &rmt->ip, (rmt->is_ip4 == 0) + 1);
333 memset (lcl_addr, 0, sizeof (*lcl_addr));
338 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
341 clib_warning ("no routable ip4 address on %U",
342 format_vnet_sw_if_index_name, vnet_get_main (),
346 lcl_addr->ip4.as_u32 = ip4->as_u32;
351 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
354 clib_warning ("no routable ip6 addresses on %U",
355 format_vnet_sw_if_index_name, vnet_get_main (),
359 clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
362 /* Allocate source port */
363 port = transport_alloc_local_port (proto, lcl_addr);
366 clib_warning ("Failed to allocate src port");
374 transport_update_time (f64 time_now, u8 thread_index)
376 transport_proto_vft_t *vft;
377 vec_foreach (vft, tp_vfts)
379 if (vft->update_time)
380 (vft->update_time) (time_now, thread_index);
385 transport_enable_disable (vlib_main_t * vm, u8 is_en)
387 transport_proto_vft_t *vft;
388 vec_foreach (vft, tp_vfts)
391 (vft->enable) (vm, is_en);
396 transport_init (void)
398 vlib_thread_main_t *vtm = vlib_get_thread_main ();
399 session_manager_main_t *smm = vnet_get_session_manager_main ();
402 if (smm->local_endpoints_table_buckets == 0)
403 smm->local_endpoints_table_buckets = 250000;
404 if (smm->local_endpoints_table_memory == 0)
405 smm->local_endpoints_table_memory = 512 << 20;
407 /* Initialize [port-allocator] random number seed */
408 port_allocator_seed = (u32) clib_cpu_time_now ();
410 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
411 smm->local_endpoints_table_buckets,
412 smm->local_endpoints_table_memory);
413 num_threads = 1 /* main thread */ + vtm->n_threads;
415 clib_spinlock_init (&local_endpoints_lock);
419 * fd.io coding-style-patch-verification: ON
422 * eval: (c-set-style "gnu")