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>
20 typedef struct local_endpoint_
22 transport_endpoint_t ep;
27 * Per-type vector of transport protocol virtual function tables
29 transport_proto_vft_t *tp_vfts;
34 static u32 port_allocator_seed;
37 * Local endpoints table
39 static transport_endpoint_table_t local_endpoints_table;
42 * Pool of local endpoints
44 static local_endpoint_t *local_endpoints;
47 * Local endpoints pool lock
49 static clib_spinlock_t local_endpoints_lock;
52 format_transport_proto (u8 * s, va_list * args)
54 u32 transport_proto = va_arg (*args, u32);
56 if (tp_vfts[transport_proto].transport_options.name)
57 s = format (s, "%s", tp_vfts[transport_proto].transport_options.name);
59 s = format (s, "n/a");
65 format_transport_proto_short (u8 * s, va_list * args)
67 u32 transport_proto = va_arg (*args, u32);
70 short_name = tp_vfts[transport_proto].transport_options.short_name;
72 s = format (s, "%s", short_name);
80 format_transport_connection (u8 * s, va_list * args)
82 u32 transport_proto = va_arg (*args, u32);
83 u32 conn_index = va_arg (*args, u32);
84 u32 thread_index = va_arg (*args, u32);
85 u32 verbose = va_arg (*args, u32);
86 transport_proto_vft_t *tp_vft;
87 transport_connection_t *tc;
90 tp_vft = transport_protocol_get_vft (transport_proto);
94 s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
96 tc = tp_vft->get_connection (conn_index, thread_index);
97 if (tc && transport_connection_is_tx_paced (tc) && verbose > 1)
99 indent = format_get_indent (s) + 1;
100 s = format (s, "%Upacer: %U\n", format_white_space, indent,
101 format_transport_pacer, &tc->pacer, tc->thread_index);
102 s = format (s, "%Utransport: flags 0x%x\n", format_white_space, indent,
109 format_transport_listen_connection (u8 * s, va_list * args)
111 u32 transport_proto = va_arg (*args, u32);
112 transport_proto_vft_t *tp_vft;
114 tp_vft = transport_protocol_get_vft (transport_proto);
118 s = (tp_vft->format_listener) (s, args);
123 format_transport_half_open_connection (u8 * s, va_list * args)
125 u32 transport_proto = va_arg (*args, u32);
126 u32 listen_index = va_arg (*args, u32);
127 transport_proto_vft_t *tp_vft;
129 tp_vft = transport_protocol_get_vft (transport_proto);
133 s = format (s, "%U", tp_vft->format_half_open, listen_index);
138 unformat_transport_str_match (unformat_input_t * input, const char *str)
142 if (strlen (str) > vec_len (input->buffer) - input->index)
145 for (i = 0; i < strlen (str); i++)
147 if (input->buffer[i + input->index] != str[i])
154 unformat_transport_proto (unformat_input_t * input, va_list * args)
156 u32 *proto = va_arg (*args, u32 *);
157 transport_proto_vft_t *tp_vft;
158 u8 longest_match = 0, match;
159 char *str, *str_match = 0;
160 transport_proto_t tp;
162 for (tp = 0; tp < vec_len (tp_vfts); tp++)
164 tp_vft = &tp_vfts[tp];
165 str = tp_vft->transport_options.name;
168 if (unformat_transport_str_match (input, str))
170 match = strlen (str);
171 if (match > longest_match)
174 longest_match = match;
181 (void) unformat (input, str_match);
189 format_transport_protos (u8 * s, va_list * args)
191 transport_proto_vft_t *tp_vft;
193 vec_foreach (tp_vft, tp_vfts)
194 s = format (s, "%s\n", tp_vft->transport_options.name);
200 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
201 ip46_address_t * ip, u16 port)
203 clib_bihash_kv_24_8_t kv;
206 kv.key[0] = ip->as_u64[0];
207 kv.key[1] = ip->as_u64[1];
208 kv.key[2] = (u64) port << 8 | (u64) proto;
210 rv = clib_bihash_search_inline_24_8 (ht, &kv);
214 return ENDPOINT_INVALID_INDEX;
218 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
219 transport_endpoint_t * te, u32 value)
221 clib_bihash_kv_24_8_t kv;
223 kv.key[0] = te->ip.as_u64[0];
224 kv.key[1] = te->ip.as_u64[1];
225 kv.key[2] = (u64) te->port << 8 | (u64) proto;
228 clib_bihash_add_del_24_8 (ht, &kv, 1);
232 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
233 transport_endpoint_t * te)
235 clib_bihash_kv_24_8_t kv;
237 kv.key[0] = te->ip.as_u64[0];
238 kv.key[1] = te->ip.as_u64[1];
239 kv.key[2] = (u64) te->port << 8 | (u64) proto;
241 clib_bihash_add_del_24_8 (ht, &kv, 0);
245 transport_register_protocol (transport_proto_t transport_proto,
246 const transport_proto_vft_t * vft,
247 fib_protocol_t fib_proto, u32 output_node)
249 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
251 vec_validate (tp_vfts, transport_proto);
252 tp_vfts[transport_proto] = *vft;
254 session_register_transport (transport_proto, vft, is_ip4, output_node);
258 transport_register_new_protocol (const transport_proto_vft_t * vft,
259 fib_protocol_t fib_proto, u32 output_node)
261 transport_proto_t transport_proto;
264 transport_proto = session_add_transport_proto ();
265 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
267 vec_validate (tp_vfts, transport_proto);
268 tp_vfts[transport_proto] = *vft;
270 session_register_transport (transport_proto, vft, is_ip4, output_node);
272 return transport_proto;
276 * Get transport virtual function table
278 * @param type - session type (not protocol type)
280 transport_proto_vft_t *
281 transport_protocol_get_vft (transport_proto_t transport_proto)
283 if (transport_proto >= vec_len (tp_vfts))
285 return &tp_vfts[transport_proto];
288 transport_service_type_t
289 transport_protocol_service_type (transport_proto_t tp)
291 return tp_vfts[tp].transport_options.service_type;
294 transport_tx_fn_type_t
295 transport_protocol_tx_fn_type (transport_proto_t tp)
297 return tp_vfts[tp].transport_options.tx_type;
301 transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index)
303 tp_vfts[tp].cleanup (conn_index, thread_index);
307 transport_cleanup_half_open (transport_proto_t tp, u32 conn_index)
309 if (tp_vfts[tp].cleanup)
310 tp_vfts[tp].cleanup_ho (conn_index);
314 transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
316 return tp_vfts[tp].connect (tep);
320 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
322 tp_vfts[tp].close (conn_index, thread_index);
326 transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
328 if (tp_vfts[tp].reset)
329 tp_vfts[tp].reset (conn_index, thread_index);
331 tp_vfts[tp].close (conn_index, thread_index);
335 transport_start_listen (transport_proto_t tp, u32 session_index,
336 transport_endpoint_t * tep)
338 return tp_vfts[tp].start_listen (session_index, tep);
342 transport_stop_listen (transport_proto_t tp, u32 conn_index)
344 return tp_vfts[tp].stop_listen (conn_index);
348 transport_protocol_is_cl (transport_proto_t tp)
350 return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
354 default_get_transport_endpoint (transport_connection_t * tc,
355 transport_endpoint_t * tep, u8 is_lcl)
359 tep->port = tc->lcl_port;
360 tep->is_ip4 = tc->is_ip4;
361 clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
365 tep->port = tc->rmt_port;
366 tep->is_ip4 = tc->is_ip4;
367 clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
372 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
373 u32 thread_index, transport_endpoint_t * tep,
376 if (tp_vfts[tp].get_transport_endpoint)
377 tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
381 transport_connection_t *tc;
382 tc = transport_get_connection (tp, conn_index, thread_index);
383 default_get_transport_endpoint (tc, tep, is_lcl);
388 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
389 transport_endpoint_t * tep, u8 is_lcl)
391 if (tp_vfts[tp].get_transport_listener_endpoint)
392 tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
395 transport_connection_t *tc;
396 tc = transport_get_listener (tp, conn_index);
397 default_get_transport_endpoint (tc, tep, is_lcl);
401 #define PORT_MASK ((1 << 16)- 1)
404 transport_endpoint_del (u32 tepi)
406 clib_spinlock_lock_if_init (&local_endpoints_lock);
407 pool_put_index (local_endpoints, tepi);
408 clib_spinlock_unlock_if_init (&local_endpoints_lock);
411 always_inline local_endpoint_t *
412 transport_endpoint_new (void)
414 local_endpoint_t *lep;
415 pool_get_zero (local_endpoints, lep);
420 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
422 local_endpoint_t *lep;
425 /* Cleanup local endpoint if this was an active connect */
426 lepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
427 clib_net_to_host_u16 (port));
428 if (lepi != ENDPOINT_INVALID_INDEX)
430 lep = pool_elt_at_index (local_endpoints, lepi);
431 if (!clib_atomic_sub_fetch (&lep->refcnt, 1))
433 transport_endpoint_table_del (&local_endpoints_table, proto,
435 transport_endpoint_del (lepi);
441 transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
443 local_endpoint_t *lep;
444 clib_spinlock_lock_if_init (&local_endpoints_lock);
445 lep = transport_endpoint_new ();
446 clib_memcpy_fast (&lep->ep.ip, ip, sizeof (*ip));
449 transport_endpoint_table_add (&local_endpoints_table, proto, &lep->ep,
450 lep - local_endpoints);
451 clib_spinlock_unlock_if_init (&local_endpoints_lock);
455 transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip, u16 port)
457 local_endpoint_t *lep;
460 lepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
461 clib_net_to_host_u16 (port));
462 if (lepi != ENDPOINT_INVALID_INDEX)
464 lep = pool_elt_at_index (local_endpoints, lepi);
465 clib_atomic_add_fetch (&lep->refcnt, 1);
470 * Allocate local port and add if successful add entry to local endpoint
471 * table to mark the pair as used.
474 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
476 u16 min = 1024, max = 65535; /* XXX configurable ? */
482 /* Only support active opens from thread 0 */
483 ASSERT (vlib_get_thread_index () == 0);
485 /* Search for first free slot */
486 for (tries = 0; tries < limit; tries++)
490 /* Find a port in the specified range */
493 port = random_u32 (&port_allocator_seed) & PORT_MASK;
494 if (PREDICT_TRUE (port >= min && port < max))
498 /* Look it up. If not found, we're done */
499 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
501 if (tei == ENDPOINT_INVALID_INDEX)
503 transport_endpoint_mark_used (proto, ip, port);
510 static session_error_t
511 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
516 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
518 return SESSION_E_NOIP;
519 addr->ip4.as_u32 = ip4->as_u32;
524 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
526 return SESSION_E_NOIP;
527 clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
532 static session_error_t
533 transport_find_local_ip_for_remote (u32 sw_if_index,
534 transport_endpoint_t * rmt,
535 ip46_address_t * lcl_addr)
537 fib_node_index_t fei;
540 if (sw_if_index == ENDPOINT_INVALID_INDEX)
542 /* Find a FIB path to the destination */
543 clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
544 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
545 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
547 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
548 fei = fib_table_lookup (rmt->fib_index, &prefix);
550 /* Couldn't find route to destination. Bail out. */
551 if (fei == FIB_NODE_INDEX_INVALID)
552 return SESSION_E_NOROUTE;
554 sw_if_index = fib_entry_get_resolving_interface (fei);
555 if (sw_if_index == ENDPOINT_INVALID_INDEX)
556 return SESSION_E_NOINTF;
559 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
560 return transport_get_interface_ip (sw_if_index, rmt->is_ip4, lcl_addr);
564 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
565 ip46_address_t * lcl_addr, u16 * lcl_port)
567 transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
568 session_error_t error;
573 * Find the local address
575 if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
577 error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
584 /* Assume session layer vetted this address */
585 clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
586 sizeof (rmt_cfg->peer.ip));
590 * Allocate source port
592 if (rmt_cfg->peer.port == 0)
594 port = transport_alloc_local_port (proto, lcl_addr);
596 return SESSION_E_NOPORT;
601 port = clib_net_to_host_u16 (rmt_cfg->peer.port);
603 tei = transport_endpoint_lookup (&local_endpoints_table, proto,
605 if (tei != ENDPOINT_INVALID_INDEX)
606 return SESSION_E_PORTINUSE;
608 transport_endpoint_mark_used (proto, lcl_addr, port);
615 format_clib_us_time (u8 * s, va_list * args)
617 clib_us_time_t t = va_arg (*args, clib_us_time_t);
619 s = format (s, "%u us", t);
621 s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
626 format_transport_pacer (u8 * s, va_list * args)
628 spacer_t *pacer = va_arg (*args, spacer_t *);
629 u32 thread_index = va_arg (*args, int);
630 clib_us_time_t now, diff;
632 now = transport_us_time_now (thread_index);
633 diff = now - pacer->last_update;
634 s = format (s, "rate %lu bucket %lu t/p %.3f last_update %U idle %u",
635 pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
636 format_clib_us_time, diff, pacer->idle_timeout_us);
641 spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
643 u64 n_periods = (time_now - pacer->last_update);
646 if (PREDICT_FALSE (n_periods > pacer->idle_timeout_us))
648 pacer->last_update = time_now;
649 pacer->bucket = TRANSPORT_PACER_MIN_BURST;
650 return TRANSPORT_PACER_MIN_BURST;
653 if ((inc = (f32) n_periods * pacer->tokens_per_period) > 10)
655 pacer->last_update = time_now;
656 pacer->bucket = clib_min (pacer->bucket + inc, pacer->bytes_per_sec);
659 return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
663 spacer_update_bucket (spacer_t * pacer, u32 bytes)
665 ASSERT (pacer->bucket >= bytes);
666 pacer->bucket -= bytes;
670 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
673 ASSERT (rate_bytes_per_sec != 0);
674 pacer->bytes_per_sec = rate_bytes_per_sec;
675 pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
676 pacer->idle_timeout_us = clib_max (rtt * TRANSPORT_PACER_IDLE_FACTOR,
677 TRANSPORT_PACER_MIN_IDLE);
681 spacer_pace_rate (spacer_t * pacer)
683 return pacer->bytes_per_sec;
687 spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
689 pacer->last_update = time_now;
690 pacer->bucket = bucket;
694 transport_connection_tx_pacer_reset (transport_connection_t * tc,
695 u64 rate_bytes_per_sec, u32 start_bucket,
698 spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt);
699 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
704 transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
707 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), bucket);
711 transport_connection_tx_pacer_init (transport_connection_t * tc,
712 u64 rate_bytes_per_sec,
715 tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
716 transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
717 initial_bucket, 1e6);
721 transport_connection_tx_pacer_update (transport_connection_t * tc,
722 u64 bytes_per_sec, clib_us_time_t rtt)
724 spacer_set_pace_rate (&tc->pacer, bytes_per_sec, rtt);
728 transport_connection_tx_pacer_burst (transport_connection_t * tc)
730 return spacer_max_burst (&tc->pacer,
731 transport_us_time_now (tc->thread_index));
735 transport_connection_tx_pacer_rate (transport_connection_t * tc)
737 return spacer_pace_rate (&tc->pacer);
741 transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
743 if (transport_connection_is_tx_paced (tc))
744 spacer_update_bucket (&tc->pacer, bytes);
748 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
751 spacer_update_bucket (&tc->pacer, bytes);
755 transport_connection_reschedule (transport_connection_t * tc)
757 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
758 transport_connection_tx_pacer_reset_bucket (tc, TRANSPORT_PACER_MIN_BURST);
759 if (transport_max_tx_dequeue (tc))
760 sesssion_reschedule_tx (tc);
763 session_t *s = session_get (tc->s_index, tc->thread_index);
764 svm_fifo_unset_event (s->tx_fifo);
765 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
766 if (svm_fifo_set_event (s->tx_fifo))
767 sesssion_reschedule_tx (tc);
772 transport_update_time (clib_time_type_t time_now, u8 thread_index)
774 transport_proto_vft_t *vft;
775 vec_foreach (vft, tp_vfts)
777 if (vft->update_time)
778 (vft->update_time) (time_now, thread_index);
783 transport_enable_disable (vlib_main_t * vm, u8 is_en)
785 transport_proto_vft_t *vft;
786 vec_foreach (vft, tp_vfts)
789 (vft->enable) (vm, is_en);
794 transport_init (void)
796 vlib_thread_main_t *vtm = vlib_get_thread_main ();
797 session_main_t *smm = vnet_get_session_main ();
800 if (smm->local_endpoints_table_buckets == 0)
801 smm->local_endpoints_table_buckets = 250000;
802 if (smm->local_endpoints_table_memory == 0)
803 smm->local_endpoints_table_memory = 512 << 20;
805 /* Initialize [port-allocator] random number seed */
806 port_allocator_seed = (u32) clib_cpu_time_now ();
808 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
809 smm->local_endpoints_table_buckets,
810 smm->local_endpoints_table_memory);
811 num_threads = 1 /* main thread */ + vtm->n_threads;
813 clib_spinlock_init (&local_endpoints_lock);
817 * fd.io coding-style-patch-verification: ON
820 * eval: (c-set-style "gnu")