2 * Copyright (c) 2017-2019 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.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 * Period used by transport pacers. Initialized by session layer
48 static double transport_pacer_period;
50 #define TRANSPORT_PACER_MIN_MSS 1460
51 #define TRANSPORT_PACER_MIN_BURST TRANSPORT_PACER_MIN_MSS
52 #define TRANSPORT_PACER_MAX_BURST (32 * TRANSPORT_PACER_MIN_MSS)
55 format_transport_proto (u8 * s, va_list * args)
57 u32 transport_proto = va_arg (*args, u32);
58 switch (transport_proto)
60 case TRANSPORT_PROTO_TCP:
61 s = format (s, "TCP");
63 case TRANSPORT_PROTO_UDP:
64 s = format (s, "UDP");
66 case TRANSPORT_PROTO_SCTP:
67 s = format (s, "SCTP");
69 case TRANSPORT_PROTO_NONE:
70 s = format (s, "NONE");
72 case TRANSPORT_PROTO_TLS:
73 s = format (s, "TLS");
75 case TRANSPORT_PROTO_UDPC:
76 s = format (s, "UDPC");
78 case TRANSPORT_PROTO_QUIC:
79 s = format (s, "QUIC");
82 s = format (s, "UNKNOWN");
89 format_transport_proto_short (u8 * s, va_list * args)
91 u32 transport_proto = va_arg (*args, u32);
92 switch (transport_proto)
94 case TRANSPORT_PROTO_TCP:
97 case TRANSPORT_PROTO_UDP:
100 case TRANSPORT_PROTO_SCTP:
103 case TRANSPORT_PROTO_NONE:
106 case TRANSPORT_PROTO_TLS:
109 case TRANSPORT_PROTO_UDPC:
112 case TRANSPORT_PROTO_QUIC:
123 format_transport_connection (u8 * s, va_list * args)
125 u32 transport_proto = va_arg (*args, u32);
126 u32 conn_index = va_arg (*args, u32);
127 u32 thread_index = va_arg (*args, u32);
128 u32 verbose = va_arg (*args, u32);
129 transport_proto_vft_t *tp_vft;
130 transport_connection_t *tc;
133 tp_vft = transport_protocol_get_vft (transport_proto);
137 s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
139 tc = tp_vft->get_connection (conn_index, thread_index);
140 if (tc && transport_connection_is_tx_paced (tc) && verbose > 1)
142 indent = format_get_indent (s) + 1;
143 s = format (s, "%Upacer: %U\n", format_white_space, indent,
144 format_transport_pacer, &tc->pacer);
150 format_transport_listen_connection (u8 * s, va_list * args)
152 u32 transport_proto = va_arg (*args, u32);
153 transport_proto_vft_t *tp_vft;
155 tp_vft = transport_protocol_get_vft (transport_proto);
159 s = (tp_vft->format_listener) (s, args);
164 format_transport_half_open_connection (u8 * s, va_list * args)
166 u32 transport_proto = va_arg (*args, u32);
167 u32 listen_index = va_arg (*args, u32);
168 transport_proto_vft_t *tp_vft;
170 tp_vft = transport_protocol_get_vft (transport_proto);
174 s = format (s, "%U", tp_vft->format_half_open, listen_index);
179 unformat_transport_proto (unformat_input_t * input, va_list * args)
181 u32 *proto = va_arg (*args, u32 *);
182 if (unformat (input, "tcp"))
183 *proto = TRANSPORT_PROTO_TCP;
184 else if (unformat (input, "TCP"))
185 *proto = TRANSPORT_PROTO_TCP;
186 else if (unformat (input, "udpc"))
187 *proto = TRANSPORT_PROTO_UDPC;
188 else if (unformat (input, "UDPC"))
189 *proto = TRANSPORT_PROTO_UDPC;
190 else if (unformat (input, "udp"))
191 *proto = TRANSPORT_PROTO_UDP;
192 else if (unformat (input, "UDP"))
193 *proto = TRANSPORT_PROTO_UDP;
194 else if (unformat (input, "sctp"))
195 *proto = TRANSPORT_PROTO_SCTP;
196 else if (unformat (input, "SCTP"))
197 *proto = TRANSPORT_PROTO_SCTP;
198 else if (unformat (input, "tls"))
199 *proto = TRANSPORT_PROTO_TLS;
200 else if (unformat (input, "TLS"))
201 *proto = TRANSPORT_PROTO_TLS;
202 else if (unformat (input, "quic"))
203 *proto = TRANSPORT_PROTO_QUIC;
204 else if (unformat (input, "QUIC"))
205 *proto = TRANSPORT_PROTO_QUIC;
212 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
213 ip46_address_t * ip, u16 port)
215 clib_bihash_kv_24_8_t kv;
218 kv.key[0] = ip->as_u64[0];
219 kv.key[1] = ip->as_u64[1];
220 kv.key[2] = (u64) port << 8 | (u64) proto;
222 rv = clib_bihash_search_inline_24_8 (ht, &kv);
226 return ENDPOINT_INVALID_INDEX;
230 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
231 transport_endpoint_t * te, u32 value)
233 clib_bihash_kv_24_8_t kv;
235 kv.key[0] = te->ip.as_u64[0];
236 kv.key[1] = te->ip.as_u64[1];
237 kv.key[2] = (u64) te->port << 8 | (u64) proto;
240 clib_bihash_add_del_24_8 (ht, &kv, 1);
244 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
245 transport_endpoint_t * te)
247 clib_bihash_kv_24_8_t kv;
249 kv.key[0] = te->ip.as_u64[0];
250 kv.key[1] = te->ip.as_u64[1];
251 kv.key[2] = (u64) te->port << 8 | (u64) proto;
253 clib_bihash_add_del_24_8 (ht, &kv, 0);
257 * Register transport virtual function table.
259 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
260 * @param vft - virtual function table for transport proto
261 * @param fib_proto - network layer protocol
262 * @param output_node - output node index that session layer will hand off
263 * buffers to, for requested fib proto
266 transport_register_protocol (transport_proto_t transport_proto,
267 const transport_proto_vft_t * vft,
268 fib_protocol_t fib_proto, u32 output_node)
270 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
272 vec_validate (tp_vfts, transport_proto);
273 tp_vfts[transport_proto] = *vft;
275 session_register_transport (transport_proto, vft, is_ip4, output_node);
279 * Get transport virtual function table
281 * @param type - session type (not protocol type)
283 transport_proto_vft_t *
284 transport_protocol_get_vft (transport_proto_t transport_proto)
286 if (transport_proto >= vec_len (tp_vfts))
288 return &tp_vfts[transport_proto];
291 transport_service_type_t
292 transport_protocol_service_type (transport_proto_t tp)
294 return tp_vfts[tp].service_type;
297 transport_tx_fn_type_t
298 transport_protocol_tx_fn_type (transport_proto_t tp)
300 return tp_vfts[tp].tx_type;
304 transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index)
306 tp_vfts[tp].cleanup (conn_index, thread_index);
310 transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
312 return tp_vfts[tp].connect (tep);
316 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
318 tp_vfts[tp].close (conn_index, thread_index);
322 transport_start_listen (transport_proto_t tp, u32 session_index,
323 transport_endpoint_t * tep)
325 return tp_vfts[tp].start_listen (session_index, tep);
329 transport_stop_listen (transport_proto_t tp, u32 conn_index)
331 return tp_vfts[tp].stop_listen (conn_index);
335 transport_protocol_is_cl (transport_proto_t tp)
337 return (tp_vfts[tp].service_type == TRANSPORT_SERVICE_CL);
341 default_get_transport_endpoint (transport_connection_t * tc,
342 transport_endpoint_t * tep, u8 is_lcl)
346 tep->port = tc->lcl_port;
347 tep->is_ip4 = tc->is_ip4;
348 clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
352 tep->port = tc->rmt_port;
353 tep->is_ip4 = tc->is_ip4;
354 clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
359 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
360 u32 thread_index, transport_endpoint_t * tep,
363 if (tp_vfts[tp].get_transport_endpoint)
364 tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
368 transport_connection_t *tc;
369 tc = transport_get_connection (tp, conn_index, thread_index);
370 default_get_transport_endpoint (tc, tep, is_lcl);
375 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
376 transport_endpoint_t * tep, u8 is_lcl)
378 if (tp_vfts[tp].get_transport_listener_endpoint)
379 tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
382 transport_connection_t *tc;
383 tc = transport_get_listener (tp, conn_index);
384 default_get_transport_endpoint (tc, tep, is_lcl);
388 #define PORT_MASK ((1 << 16)- 1)
391 transport_endpoint_del (u32 tepi)
393 clib_spinlock_lock_if_init (&local_endpoints_lock);
394 pool_put_index (local_endpoints, tepi);
395 clib_spinlock_unlock_if_init (&local_endpoints_lock);
398 always_inline transport_endpoint_t *
399 transport_endpoint_new (void)
401 transport_endpoint_t *tep;
402 pool_get_zero (local_endpoints, tep);
407 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
410 transport_endpoint_t *tep;
412 /* Cleanup local endpoint if this was an active connect */
413 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
414 clib_net_to_host_u16 (port));
415 if (tepi != ENDPOINT_INVALID_INDEX)
417 tep = pool_elt_at_index (local_endpoints, tepi);
418 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
419 transport_endpoint_del (tepi);
424 transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
426 transport_endpoint_t *tep;
427 clib_spinlock_lock_if_init (&local_endpoints_lock);
428 tep = transport_endpoint_new ();
429 clib_memcpy_fast (&tep->ip, ip, sizeof (*ip));
431 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
432 tep - local_endpoints);
433 clib_spinlock_unlock_if_init (&local_endpoints_lock);
437 * Allocate local port and add if successful add entry to local endpoint
438 * table to mark the pair as used.
441 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
443 u16 min = 1024, max = 65535; /* XXX configurable ? */
449 /* Only support active opens from thread 0 */
450 ASSERT (vlib_get_thread_index () == 0);
452 /* Search for first free slot */
453 for (tries = 0; tries < limit; tries++)
457 /* Find a port in the specified range */
460 port = random_u32 (&port_allocator_seed) & PORT_MASK;
461 if (PREDICT_TRUE (port >= min && port < max))
465 /* Look it up. If not found, we're done */
466 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
468 if (tei == ENDPOINT_INVALID_INDEX)
470 transport_endpoint_mark_used (proto, ip, port);
477 static clib_error_t *
478 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
483 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
485 return clib_error_return (0, "no routable ip4 address on %U",
486 format_vnet_sw_if_index_name,
487 vnet_get_main (), sw_if_index);
488 addr->ip4.as_u32 = ip4->as_u32;
493 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
495 return clib_error_return (0, "no routable ip6 addresses on %U",
496 format_vnet_sw_if_index_name,
497 vnet_get_main (), sw_if_index);
498 clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
503 static clib_error_t *
504 transport_find_local_ip_for_remote (u32 sw_if_index,
505 transport_endpoint_t * rmt,
506 ip46_address_t * lcl_addr)
508 fib_node_index_t fei;
511 if (sw_if_index == ENDPOINT_INVALID_INDEX)
513 /* Find a FIB path to the destination */
514 clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
515 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
516 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
518 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
519 fei = fib_table_lookup (rmt->fib_index, &prefix);
521 /* Couldn't find route to destination. Bail out. */
522 if (fei == FIB_NODE_INDEX_INVALID)
523 return clib_error_return (0, "no route to %U", format_ip46_address,
524 &rmt->ip, (rmt->is_ip4 == 0) + 1);
526 sw_if_index = fib_entry_get_resolving_interface (fei);
527 if (sw_if_index == ENDPOINT_INVALID_INDEX)
528 return clib_error_return (0, "no resolving interface for %U",
529 format_ip46_address, &rmt->ip,
530 (rmt->is_ip4 == 0) + 1);
533 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
534 return transport_get_interface_ip (sw_if_index, rmt->is_ip4, lcl_addr);
538 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
539 ip46_address_t * lcl_addr, u16 * lcl_port)
541 transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
547 * Find the local address
549 if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
551 error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
555 clib_error_report (error);
561 /* Assume session layer vetted this address */
562 clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
563 sizeof (rmt_cfg->peer.ip));
567 * Allocate source port
569 if (rmt_cfg->peer.port == 0)
571 port = transport_alloc_local_port (proto, lcl_addr);
574 clib_warning ("Failed to allocate src port");
581 port = clib_net_to_host_u16 (rmt_cfg->peer.port);
582 tei = transport_endpoint_lookup (&local_endpoints_table, proto,
584 if (tei != ENDPOINT_INVALID_INDEX)
587 transport_endpoint_mark_used (proto, lcl_addr, port);
594 #define SPACER_CPU_TICKS_PER_PERIOD_SHIFT 10
595 #define SPACER_CPU_TICKS_PER_PERIOD (1 << SPACER_CPU_TICKS_PER_PERIOD_SHIFT)
598 format_transport_pacer (u8 * s, va_list * args)
600 spacer_t *pacer = va_arg (*args, spacer_t *);
602 s = format (s, "bucket %u max_burst %u tokens/period %.3f last_update %x",
603 pacer->bucket, pacer->max_burst_size, pacer->tokens_per_period,
609 spacer_max_burst (spacer_t * pacer, u64 norm_time_now)
611 u64 n_periods = norm_time_now - pacer->last_update;
614 if (n_periods > 0 && (inc = n_periods * pacer->tokens_per_period) > 10)
616 pacer->last_update = norm_time_now;
617 pacer->bucket += inc;
620 return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
624 spacer_update_bucket (spacer_t * pacer, u32 bytes)
626 ASSERT (pacer->bucket >= bytes);
627 pacer->bucket -= bytes;
631 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec)
633 ASSERT (rate_bytes_per_sec != 0);
634 pacer->tokens_per_period = rate_bytes_per_sec / transport_pacer_period;
638 transport_connection_tx_pacer_reset (transport_connection_t * tc,
639 u32 rate_bytes_per_sec,
640 u32 start_bucket, u64 time_now)
642 spacer_t *pacer = &tc->pacer;
643 spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec);
644 pacer->last_update = time_now >> SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
645 pacer->bucket = start_bucket;
649 transport_connection_tx_pacer_init (transport_connection_t * tc,
650 u32 rate_bytes_per_sec,
653 vlib_main_t *vm = vlib_get_main ();
654 tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
655 transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
657 vm->clib_time.last_cpu_time);
661 transport_connection_tx_pacer_update (transport_connection_t * tc,
664 spacer_set_pace_rate (&tc->pacer, bytes_per_sec);
668 transport_connection_tx_pacer_burst (transport_connection_t * tc,
671 time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
672 return spacer_max_burst (&tc->pacer, time_now);
676 transport_connection_snd_space (transport_connection_t * tc, u64 time_now,
679 u32 snd_space, max_paced_burst;
681 snd_space = tp_vfts[tc->proto].send_space (tc);
682 if (transport_connection_is_tx_paced (tc))
684 time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
685 max_paced_burst = spacer_max_burst (&tc->pacer, time_now);
686 max_paced_burst = (max_paced_burst < mss) ? 0 : max_paced_burst;
687 snd_space = clib_min (snd_space, max_paced_burst);
688 snd_space = snd_space - snd_space % mss;
694 transport_connection_update_tx_stats (transport_connection_t * tc, u32 bytes)
696 tc->stats.tx_bytes += bytes;
697 if (transport_connection_is_tx_paced (tc))
698 spacer_update_bucket (&tc->pacer, bytes);
702 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
705 spacer_update_bucket (&tc->pacer, bytes);
709 transport_init_tx_pacers_period (void)
711 f64 cpu_freq = os_cpu_clock_frequency ();
712 transport_pacer_period = cpu_freq / SPACER_CPU_TICKS_PER_PERIOD;
716 transport_update_time (f64 time_now, u8 thread_index)
718 transport_proto_vft_t *vft;
719 vec_foreach (vft, tp_vfts)
721 if (vft->update_time)
722 (vft->update_time) (time_now, thread_index);
727 transport_enable_disable (vlib_main_t * vm, u8 is_en)
729 transport_proto_vft_t *vft;
730 vec_foreach (vft, tp_vfts)
733 (vft->enable) (vm, is_en);
738 transport_init (void)
740 vlib_thread_main_t *vtm = vlib_get_thread_main ();
741 session_main_t *smm = vnet_get_session_main ();
744 if (smm->local_endpoints_table_buckets == 0)
745 smm->local_endpoints_table_buckets = 250000;
746 if (smm->local_endpoints_table_memory == 0)
747 smm->local_endpoints_table_memory = 512 << 20;
749 /* Initialize [port-allocator] random number seed */
750 port_allocator_seed = (u32) clib_cpu_time_now ();
752 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
753 smm->local_endpoints_table_buckets,
754 smm->local_endpoints_table_memory);
755 num_threads = 1 /* main thread */ + vtm->n_threads;
757 clib_spinlock_init (&local_endpoints_lock);
761 * fd.io coding-style-patch-verification: ON
764 * eval: (c-set-style "gnu")