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 format_transport_proto (u8 * s, va_list * args)
48 u32 transport_proto = va_arg (*args, u32);
50 if (tp_vfts[transport_proto].transport_options.name)
51 s = format (s, "%s", tp_vfts[transport_proto].transport_options.name);
53 s = format (s, "n/a");
59 format_transport_proto_short (u8 * s, va_list * args)
61 u32 transport_proto = va_arg (*args, u32);
64 short_name = tp_vfts[transport_proto].transport_options.short_name;
66 s = format (s, "%s", short_name);
74 format_transport_connection (u8 * s, va_list * args)
76 u32 transport_proto = va_arg (*args, u32);
77 u32 conn_index = va_arg (*args, u32);
78 u32 thread_index = va_arg (*args, u32);
79 u32 verbose = va_arg (*args, u32);
80 transport_proto_vft_t *tp_vft;
81 transport_connection_t *tc;
84 tp_vft = transport_protocol_get_vft (transport_proto);
88 s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
90 tc = tp_vft->get_connection (conn_index, thread_index);
91 if (tc && transport_connection_is_tx_paced (tc) && verbose > 1)
93 indent = format_get_indent (s) + 1;
94 s = format (s, "%Upacer: %U\n", format_white_space, indent,
95 format_transport_pacer, &tc->pacer, tc->thread_index);
96 s = format (s, "%Utransport: flags 0x%x\n", format_white_space, indent,
103 format_transport_listen_connection (u8 * s, va_list * args)
105 u32 transport_proto = va_arg (*args, u32);
106 transport_proto_vft_t *tp_vft;
108 tp_vft = transport_protocol_get_vft (transport_proto);
112 s = (tp_vft->format_listener) (s, args);
117 format_transport_half_open_connection (u8 * s, va_list * args)
119 u32 transport_proto = va_arg (*args, u32);
120 u32 listen_index = va_arg (*args, u32);
121 transport_proto_vft_t *tp_vft;
123 tp_vft = transport_protocol_get_vft (transport_proto);
127 s = format (s, "%U", tp_vft->format_half_open, listen_index);
132 unformat_transport_str_match (unformat_input_t * input, const char *str)
136 if (strlen (str) > vec_len (input->buffer) - input->index)
139 for (i = 0; i < strlen (str); i++)
141 if (input->buffer[i + input->index] != str[i])
148 unformat_transport_proto (unformat_input_t * input, va_list * args)
150 u32 *proto = va_arg (*args, u32 *);
151 transport_proto_vft_t *tp_vft;
152 u8 longest_match = 0, match;
153 char *str, *str_match = 0;
154 transport_proto_t tp;
156 for (tp = 0; tp < vec_len (tp_vfts); tp++)
158 tp_vft = &tp_vfts[tp];
159 str = tp_vft->transport_options.name;
162 if (unformat_transport_str_match (input, str))
164 match = strlen (str);
165 if (match > longest_match)
168 longest_match = match;
175 (void) unformat (input, str_match);
183 format_transport_protos (u8 * s, va_list * args)
185 transport_proto_vft_t *tp_vft;
187 vec_foreach (tp_vft, tp_vfts)
188 s = format (s, "%s\n", tp_vft->transport_options.name);
194 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
195 ip46_address_t * ip, u16 port)
197 clib_bihash_kv_24_8_t kv;
200 kv.key[0] = ip->as_u64[0];
201 kv.key[1] = ip->as_u64[1];
202 kv.key[2] = (u64) port << 8 | (u64) proto;
204 rv = clib_bihash_search_inline_24_8 (ht, &kv);
208 return ENDPOINT_INVALID_INDEX;
212 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
213 transport_endpoint_t * te, u32 value)
215 clib_bihash_kv_24_8_t kv;
217 kv.key[0] = te->ip.as_u64[0];
218 kv.key[1] = te->ip.as_u64[1];
219 kv.key[2] = (u64) te->port << 8 | (u64) proto;
222 clib_bihash_add_del_24_8 (ht, &kv, 1);
226 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
227 transport_endpoint_t * te)
229 clib_bihash_kv_24_8_t kv;
231 kv.key[0] = te->ip.as_u64[0];
232 kv.key[1] = te->ip.as_u64[1];
233 kv.key[2] = (u64) te->port << 8 | (u64) proto;
235 clib_bihash_add_del_24_8 (ht, &kv, 0);
239 transport_register_protocol (transport_proto_t transport_proto,
240 const transport_proto_vft_t * vft,
241 fib_protocol_t fib_proto, u32 output_node)
243 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
245 vec_validate (tp_vfts, transport_proto);
246 tp_vfts[transport_proto] = *vft;
248 session_register_transport (transport_proto, vft, is_ip4, output_node);
252 transport_register_new_protocol (const transport_proto_vft_t * vft,
253 fib_protocol_t fib_proto, u32 output_node)
255 transport_proto_t transport_proto;
258 transport_proto = session_add_transport_proto ();
259 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
261 vec_validate (tp_vfts, transport_proto);
262 tp_vfts[transport_proto] = *vft;
264 session_register_transport (transport_proto, vft, is_ip4, output_node);
266 return transport_proto;
270 * Get transport virtual function table
272 * @param type - session type (not protocol type)
274 transport_proto_vft_t *
275 transport_protocol_get_vft (transport_proto_t transport_proto)
277 if (transport_proto >= vec_len (tp_vfts))
279 return &tp_vfts[transport_proto];
283 transport_half_open_has_fifos (transport_proto_t tp)
285 return tp_vfts[tp].transport_options.half_open_has_fifos;
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_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
309 return tp_vfts[tp].connect (tep);
313 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
315 tp_vfts[tp].close (conn_index, thread_index);
319 transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
321 if (tp_vfts[tp].reset)
322 tp_vfts[tp].reset (conn_index, thread_index);
324 tp_vfts[tp].close (conn_index, thread_index);
328 transport_start_listen (transport_proto_t tp, u32 session_index,
329 transport_endpoint_t * tep)
331 return tp_vfts[tp].start_listen (session_index, tep);
335 transport_stop_listen (transport_proto_t tp, u32 conn_index)
337 return tp_vfts[tp].stop_listen (conn_index);
341 transport_protocol_is_cl (transport_proto_t tp)
343 return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
347 default_get_transport_endpoint (transport_connection_t * tc,
348 transport_endpoint_t * tep, u8 is_lcl)
352 tep->port = tc->lcl_port;
353 tep->is_ip4 = tc->is_ip4;
354 clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
358 tep->port = tc->rmt_port;
359 tep->is_ip4 = tc->is_ip4;
360 clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
365 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
366 u32 thread_index, transport_endpoint_t * tep,
369 if (tp_vfts[tp].get_transport_endpoint)
370 tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
374 transport_connection_t *tc;
375 tc = transport_get_connection (tp, conn_index, thread_index);
376 default_get_transport_endpoint (tc, tep, is_lcl);
381 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
382 transport_endpoint_t * tep, u8 is_lcl)
384 if (tp_vfts[tp].get_transport_listener_endpoint)
385 tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
388 transport_connection_t *tc;
389 tc = transport_get_listener (tp, conn_index);
390 default_get_transport_endpoint (tc, tep, is_lcl);
394 #define PORT_MASK ((1 << 16)- 1)
397 transport_endpoint_del (u32 tepi)
399 clib_spinlock_lock_if_init (&local_endpoints_lock);
400 pool_put_index (local_endpoints, tepi);
401 clib_spinlock_unlock_if_init (&local_endpoints_lock);
404 always_inline transport_endpoint_t *
405 transport_endpoint_new (void)
407 transport_endpoint_t *tep;
408 pool_get_zero (local_endpoints, tep);
413 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
416 transport_endpoint_t *tep;
418 /* Cleanup local endpoint if this was an active connect */
419 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
420 clib_net_to_host_u16 (port));
421 if (tepi != ENDPOINT_INVALID_INDEX)
423 tep = pool_elt_at_index (local_endpoints, tepi);
424 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
425 transport_endpoint_del (tepi);
430 transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
432 transport_endpoint_t *tep;
433 clib_spinlock_lock_if_init (&local_endpoints_lock);
434 tep = transport_endpoint_new ();
435 clib_memcpy_fast (&tep->ip, ip, sizeof (*ip));
437 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
438 tep - local_endpoints);
439 clib_spinlock_unlock_if_init (&local_endpoints_lock);
443 * Allocate local port and add if successful add entry to local endpoint
444 * table to mark the pair as used.
447 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
449 u16 min = 1024, max = 65535; /* XXX configurable ? */
455 /* Only support active opens from thread 0 */
456 ASSERT (vlib_get_thread_index () == 0);
458 /* Search for first free slot */
459 for (tries = 0; tries < limit; tries++)
463 /* Find a port in the specified range */
466 port = random_u32 (&port_allocator_seed) & PORT_MASK;
467 if (PREDICT_TRUE (port >= min && port < max))
471 /* Look it up. If not found, we're done */
472 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
474 if (tei == ENDPOINT_INVALID_INDEX)
476 transport_endpoint_mark_used (proto, ip, port);
483 static session_error_t
484 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
489 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
491 return SESSION_E_NOIP;
492 addr->ip4.as_u32 = ip4->as_u32;
497 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
499 return SESSION_E_NOIP;
500 clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
505 static session_error_t
506 transport_find_local_ip_for_remote (u32 sw_if_index,
507 transport_endpoint_t * rmt,
508 ip46_address_t * lcl_addr)
510 fib_node_index_t fei;
513 if (sw_if_index == ENDPOINT_INVALID_INDEX)
515 /* Find a FIB path to the destination */
516 clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
517 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
518 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
520 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
521 fei = fib_table_lookup (rmt->fib_index, &prefix);
523 /* Couldn't find route to destination. Bail out. */
524 if (fei == FIB_NODE_INDEX_INVALID)
525 return SESSION_E_NOROUTE;
527 sw_if_index = fib_entry_get_resolving_interface (fei);
528 if (sw_if_index == ENDPOINT_INVALID_INDEX)
529 return SESSION_E_NOINTF;
532 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
533 return transport_get_interface_ip (sw_if_index, rmt->is_ip4, lcl_addr);
537 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
538 ip46_address_t * lcl_addr, u16 * lcl_port)
540 transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
541 session_error_t error;
546 * Find the local address
548 if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
550 error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
557 /* Assume session layer vetted this address */
558 clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
559 sizeof (rmt_cfg->peer.ip));
563 * Allocate source port
565 if (rmt_cfg->peer.port == 0)
567 port = transport_alloc_local_port (proto, lcl_addr);
569 return SESSION_E_NOPORT;
574 port = clib_net_to_host_u16 (rmt_cfg->peer.port);
575 tei = transport_endpoint_lookup (&local_endpoints_table, proto,
577 if (tei != ENDPOINT_INVALID_INDEX)
578 return SESSION_E_PORTINUSE;
580 transport_endpoint_mark_used (proto, lcl_addr, port);
588 format_clib_us_time (u8 * s, va_list * args)
590 clib_us_time_t t = va_arg (*args, clib_us_time_t);
592 s = format (s, "%u us", t);
594 s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
599 format_transport_pacer (u8 * s, va_list * args)
601 spacer_t *pacer = va_arg (*args, spacer_t *);
602 u32 thread_index = va_arg (*args, int);
603 clib_us_time_t now, diff;
605 now = transport_us_time_now (thread_index);
606 diff = now - pacer->last_update;
607 s = format (s, "rate %lu bucket %lu t/p %.3f last_update %U idle %u",
608 pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
609 format_clib_us_time, diff, pacer->idle_timeout_us);
614 spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
616 u64 n_periods = (time_now - pacer->last_update);
619 if (PREDICT_FALSE (n_periods > pacer->idle_timeout_us))
621 pacer->last_update = time_now;
622 pacer->bucket = TRANSPORT_PACER_MIN_BURST;
623 return TRANSPORT_PACER_MIN_BURST;
626 if ((inc = (f32) n_periods * pacer->tokens_per_period) > 10)
628 pacer->last_update = time_now;
629 pacer->bucket = clib_min (pacer->bucket + inc, pacer->bytes_per_sec);
632 return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
636 spacer_update_bucket (spacer_t * pacer, u32 bytes)
638 ASSERT (pacer->bucket >= bytes);
639 pacer->bucket -= bytes;
643 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
646 ASSERT (rate_bytes_per_sec != 0);
647 pacer->bytes_per_sec = rate_bytes_per_sec;
648 pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
649 pacer->idle_timeout_us = clib_max (rtt * TRANSPORT_PACER_IDLE_FACTOR,
650 TRANSPORT_PACER_MIN_IDLE);
654 spacer_pace_rate (spacer_t * pacer)
656 return pacer->bytes_per_sec;
660 spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
662 pacer->last_update = time_now;
663 pacer->bucket = bucket;
667 transport_connection_tx_pacer_reset (transport_connection_t * tc,
668 u64 rate_bytes_per_sec, u32 start_bucket,
671 spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt);
672 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
677 transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
680 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), bucket);
684 transport_connection_tx_pacer_init (transport_connection_t * tc,
685 u64 rate_bytes_per_sec,
688 tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
689 transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
690 initial_bucket, 1e6);
694 transport_connection_tx_pacer_update (transport_connection_t * tc,
695 u64 bytes_per_sec, clib_us_time_t rtt)
697 spacer_set_pace_rate (&tc->pacer, bytes_per_sec, rtt);
701 transport_connection_tx_pacer_burst (transport_connection_t * tc)
703 return spacer_max_burst (&tc->pacer,
704 transport_us_time_now (tc->thread_index));
708 transport_connection_tx_pacer_rate (transport_connection_t * tc)
710 return spacer_pace_rate (&tc->pacer);
714 transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
716 if (transport_connection_is_tx_paced (tc))
717 spacer_update_bucket (&tc->pacer, bytes);
721 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
724 spacer_update_bucket (&tc->pacer, bytes);
728 transport_connection_reschedule (transport_connection_t * tc)
730 tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
731 transport_connection_tx_pacer_reset_bucket (tc, TRANSPORT_PACER_MIN_BURST);
732 if (transport_max_tx_dequeue (tc))
733 sesssion_reschedule_tx (tc);
736 session_t *s = session_get (tc->s_index, tc->thread_index);
737 svm_fifo_unset_event (s->tx_fifo);
738 if (svm_fifo_max_dequeue_cons (s->tx_fifo))
739 if (svm_fifo_set_event (s->tx_fifo))
740 sesssion_reschedule_tx (tc);
745 transport_update_time (clib_time_type_t time_now, u8 thread_index)
747 transport_proto_vft_t *vft;
748 vec_foreach (vft, tp_vfts)
750 if (vft->update_time)
751 (vft->update_time) (time_now, thread_index);
756 transport_enable_disable (vlib_main_t * vm, u8 is_en)
758 transport_proto_vft_t *vft;
759 vec_foreach (vft, tp_vfts)
762 (vft->enable) (vm, is_en);
767 transport_init (void)
769 vlib_thread_main_t *vtm = vlib_get_thread_main ();
770 session_main_t *smm = vnet_get_session_main ();
773 if (smm->local_endpoints_table_buckets == 0)
774 smm->local_endpoints_table_buckets = 250000;
775 if (smm->local_endpoints_table_memory == 0)
776 smm->local_endpoints_table_memory = 512 << 20;
778 /* Initialize [port-allocator] random number seed */
779 port_allocator_seed = (u32) clib_cpu_time_now ();
781 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
782 smm->local_endpoints_table_buckets,
783 smm->local_endpoints_table_memory);
784 num_threads = 1 /* main thread */ + vtm->n_threads;
786 clib_spinlock_init (&local_endpoints_lock);
790 * fd.io coding-style-patch-verification: ON
793 * eval: (c-set-style "gnu")