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);
49 switch (transport_proto)
51 #define _(sym, str, sstr) \
52 case TRANSPORT_PROTO_ ## sym: \
53 s = format (s, str); \
55 foreach_transport_proto
58 s = format (s, "UNKNOWN");
65 format_transport_proto_short (u8 * s, va_list * args)
67 u32 transport_proto = va_arg (*args, u32);
68 switch (transport_proto)
70 #define _(sym, str, sstr) \
71 case TRANSPORT_PROTO_ ## sym: \
72 s = format (s, sstr); \
74 foreach_transport_proto
84 format_transport_connection (u8 * s, va_list * args)
86 u32 transport_proto = va_arg (*args, u32);
87 u32 conn_index = va_arg (*args, u32);
88 u32 thread_index = va_arg (*args, u32);
89 u32 verbose = va_arg (*args, u32);
90 transport_proto_vft_t *tp_vft;
91 transport_connection_t *tc;
94 tp_vft = transport_protocol_get_vft (transport_proto);
98 s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
100 tc = tp_vft->get_connection (conn_index, thread_index);
101 if (tc && transport_connection_is_tx_paced (tc) && verbose > 1)
103 indent = format_get_indent (s) + 1;
104 s = format (s, "%Upacer: %U\n", format_white_space, indent,
105 format_transport_pacer, &tc->pacer, tc->thread_index);
111 format_transport_listen_connection (u8 * s, va_list * args)
113 u32 transport_proto = va_arg (*args, u32);
114 transport_proto_vft_t *tp_vft;
116 tp_vft = transport_protocol_get_vft (transport_proto);
120 s = (tp_vft->format_listener) (s, args);
125 format_transport_half_open_connection (u8 * s, va_list * args)
127 u32 transport_proto = va_arg (*args, u32);
128 u32 listen_index = va_arg (*args, u32);
129 transport_proto_vft_t *tp_vft;
131 tp_vft = transport_protocol_get_vft (transport_proto);
135 s = format (s, "%U", tp_vft->format_half_open, listen_index);
140 unformat_transport_proto (unformat_input_t * input, va_list * args)
142 u32 *proto = va_arg (*args, u32 *);
144 #define _(sym, str, sstr) \
145 if (unformat (input, str)) \
147 *proto = TRANSPORT_PROTO_ ## sym; \
150 foreach_transport_proto
156 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
157 ip46_address_t * ip, u16 port)
159 clib_bihash_kv_24_8_t kv;
162 kv.key[0] = ip->as_u64[0];
163 kv.key[1] = ip->as_u64[1];
164 kv.key[2] = (u64) port << 8 | (u64) proto;
166 rv = clib_bihash_search_inline_24_8 (ht, &kv);
170 return ENDPOINT_INVALID_INDEX;
174 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
175 transport_endpoint_t * te, u32 value)
177 clib_bihash_kv_24_8_t kv;
179 kv.key[0] = te->ip.as_u64[0];
180 kv.key[1] = te->ip.as_u64[1];
181 kv.key[2] = (u64) te->port << 8 | (u64) proto;
184 clib_bihash_add_del_24_8 (ht, &kv, 1);
188 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
189 transport_endpoint_t * te)
191 clib_bihash_kv_24_8_t kv;
193 kv.key[0] = te->ip.as_u64[0];
194 kv.key[1] = te->ip.as_u64[1];
195 kv.key[2] = (u64) te->port << 8 | (u64) proto;
197 clib_bihash_add_del_24_8 (ht, &kv, 0);
201 * Register transport virtual function table.
203 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
204 * @param vft - virtual function table for transport proto
205 * @param fib_proto - network layer protocol
206 * @param output_node - output node index that session layer will hand off
207 * buffers to, for requested fib proto
210 transport_register_protocol (transport_proto_t transport_proto,
211 const transport_proto_vft_t * vft,
212 fib_protocol_t fib_proto, u32 output_node)
214 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
216 vec_validate (tp_vfts, transport_proto);
217 tp_vfts[transport_proto] = *vft;
219 session_register_transport (transport_proto, vft, is_ip4, output_node);
223 * Get transport virtual function table
225 * @param type - session type (not protocol type)
227 transport_proto_vft_t *
228 transport_protocol_get_vft (transport_proto_t transport_proto)
230 if (transport_proto >= vec_len (tp_vfts))
232 return &tp_vfts[transport_proto];
236 transport_half_open_has_fifos (transport_proto_t tp)
238 return tp_vfts[tp].transport_options.half_open_has_fifos;
241 transport_service_type_t
242 transport_protocol_service_type (transport_proto_t tp)
244 return tp_vfts[tp].transport_options.service_type;
247 transport_tx_fn_type_t
248 transport_protocol_tx_fn_type (transport_proto_t tp)
250 return tp_vfts[tp].transport_options.tx_type;
254 transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index)
256 tp_vfts[tp].cleanup (conn_index, thread_index);
260 transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
262 return tp_vfts[tp].connect (tep);
266 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
268 tp_vfts[tp].close (conn_index, thread_index);
272 transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
274 if (tp_vfts[tp].reset)
275 tp_vfts[tp].reset (conn_index, thread_index);
277 tp_vfts[tp].close (conn_index, thread_index);
281 transport_start_listen (transport_proto_t tp, u32 session_index,
282 transport_endpoint_t * tep)
284 return tp_vfts[tp].start_listen (session_index, tep);
288 transport_stop_listen (transport_proto_t tp, u32 conn_index)
290 return tp_vfts[tp].stop_listen (conn_index);
294 transport_protocol_is_cl (transport_proto_t tp)
296 return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
300 default_get_transport_endpoint (transport_connection_t * tc,
301 transport_endpoint_t * tep, u8 is_lcl)
305 tep->port = tc->lcl_port;
306 tep->is_ip4 = tc->is_ip4;
307 clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
311 tep->port = tc->rmt_port;
312 tep->is_ip4 = tc->is_ip4;
313 clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
318 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
319 u32 thread_index, transport_endpoint_t * tep,
322 if (tp_vfts[tp].get_transport_endpoint)
323 tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
327 transport_connection_t *tc;
328 tc = transport_get_connection (tp, conn_index, thread_index);
329 default_get_transport_endpoint (tc, tep, is_lcl);
334 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
335 transport_endpoint_t * tep, u8 is_lcl)
337 if (tp_vfts[tp].get_transport_listener_endpoint)
338 tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
341 transport_connection_t *tc;
342 tc = transport_get_listener (tp, conn_index);
343 default_get_transport_endpoint (tc, tep, is_lcl);
347 #define PORT_MASK ((1 << 16)- 1)
350 transport_endpoint_del (u32 tepi)
352 clib_spinlock_lock_if_init (&local_endpoints_lock);
353 pool_put_index (local_endpoints, tepi);
354 clib_spinlock_unlock_if_init (&local_endpoints_lock);
357 always_inline transport_endpoint_t *
358 transport_endpoint_new (void)
360 transport_endpoint_t *tep;
361 pool_get_zero (local_endpoints, tep);
366 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
369 transport_endpoint_t *tep;
371 /* Cleanup local endpoint if this was an active connect */
372 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
373 clib_net_to_host_u16 (port));
374 if (tepi != ENDPOINT_INVALID_INDEX)
376 tep = pool_elt_at_index (local_endpoints, tepi);
377 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
378 transport_endpoint_del (tepi);
383 transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
385 transport_endpoint_t *tep;
386 clib_spinlock_lock_if_init (&local_endpoints_lock);
387 tep = transport_endpoint_new ();
388 clib_memcpy_fast (&tep->ip, ip, sizeof (*ip));
390 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
391 tep - local_endpoints);
392 clib_spinlock_unlock_if_init (&local_endpoints_lock);
396 * Allocate local port and add if successful add entry to local endpoint
397 * table to mark the pair as used.
400 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
402 u16 min = 1024, max = 65535; /* XXX configurable ? */
408 /* Only support active opens from thread 0 */
409 ASSERT (vlib_get_thread_index () == 0);
411 /* Search for first free slot */
412 for (tries = 0; tries < limit; tries++)
416 /* Find a port in the specified range */
419 port = random_u32 (&port_allocator_seed) & PORT_MASK;
420 if (PREDICT_TRUE (port >= min && port < max))
424 /* Look it up. If not found, we're done */
425 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
427 if (tei == ENDPOINT_INVALID_INDEX)
429 transport_endpoint_mark_used (proto, ip, port);
436 static clib_error_t *
437 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
442 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
444 return clib_error_return (0, "no routable ip4 address on %U",
445 format_vnet_sw_if_index_name,
446 vnet_get_main (), sw_if_index);
447 addr->ip4.as_u32 = ip4->as_u32;
452 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
454 return clib_error_return (0, "no routable ip6 addresses on %U",
455 format_vnet_sw_if_index_name,
456 vnet_get_main (), sw_if_index);
457 clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
462 static clib_error_t *
463 transport_find_local_ip_for_remote (u32 sw_if_index,
464 transport_endpoint_t * rmt,
465 ip46_address_t * lcl_addr)
467 fib_node_index_t fei;
470 if (sw_if_index == ENDPOINT_INVALID_INDEX)
472 /* Find a FIB path to the destination */
473 clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
474 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
475 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
477 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
478 fei = fib_table_lookup (rmt->fib_index, &prefix);
480 /* Couldn't find route to destination. Bail out. */
481 if (fei == FIB_NODE_INDEX_INVALID)
482 return clib_error_return (0, "no route to %U", format_ip46_address,
483 &rmt->ip, (rmt->is_ip4 == 0) + 1);
485 sw_if_index = fib_entry_get_resolving_interface (fei);
486 if (sw_if_index == ENDPOINT_INVALID_INDEX)
487 return clib_error_return (0, "no resolving interface for %U",
488 format_ip46_address, &rmt->ip,
489 (rmt->is_ip4 == 0) + 1);
492 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
493 return transport_get_interface_ip (sw_if_index, rmt->is_ip4, lcl_addr);
497 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
498 ip46_address_t * lcl_addr, u16 * lcl_port)
500 transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
506 * Find the local address
508 if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
510 error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
514 clib_error_report (error);
520 /* Assume session layer vetted this address */
521 clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
522 sizeof (rmt_cfg->peer.ip));
526 * Allocate source port
528 if (rmt_cfg->peer.port == 0)
530 port = transport_alloc_local_port (proto, lcl_addr);
533 clib_warning ("Failed to allocate src port");
540 port = clib_net_to_host_u16 (rmt_cfg->peer.port);
541 tei = transport_endpoint_lookup (&local_endpoints_table, proto,
543 if (tei != ENDPOINT_INVALID_INDEX)
546 transport_endpoint_mark_used (proto, lcl_addr, port);
554 format_clib_us_time (u8 * s, va_list * args)
556 clib_us_time_t t = va_arg (*args, clib_us_time_t);
558 s = format (s, "%u us", t);
560 s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
565 format_transport_pacer (u8 * s, va_list * args)
567 spacer_t *pacer = va_arg (*args, spacer_t *);
568 u32 thread_index = va_arg (*args, int);
569 clib_us_time_t now, diff;
571 now = transport_us_time_now (thread_index);
572 diff = now - pacer->last_update;
573 s = format (s, "rate %lu bucket %lu t/p %.3f last_update %U",
574 pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
575 format_clib_us_time, diff);
580 spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
582 u64 n_periods = (time_now - pacer->last_update);
585 if (PREDICT_FALSE (n_periods > 5e4))
587 pacer->last_update = time_now;
588 pacer->bucket = TRANSPORT_PACER_MIN_BURST;
589 return TRANSPORT_PACER_MIN_BURST;
593 && (inc = (f32) n_periods * pacer->tokens_per_period) > 10)
595 pacer->last_update = time_now;
596 pacer->bucket = clib_min (pacer->bucket + inc, pacer->bytes_per_sec);
599 return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
603 spacer_update_bucket (spacer_t * pacer, u32 bytes)
605 ASSERT (pacer->bucket >= bytes);
606 pacer->bucket -= bytes;
610 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec)
612 ASSERT (rate_bytes_per_sec != 0);
613 pacer->bytes_per_sec = rate_bytes_per_sec;
614 pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
618 spacer_pace_rate (spacer_t * pacer)
620 return pacer->bytes_per_sec;
624 spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
626 pacer->last_update = time_now;
627 pacer->bucket = bucket;
631 transport_connection_tx_pacer_reset (transport_connection_t * tc,
632 u64 rate_bytes_per_sec, u32 start_bucket)
634 spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec);
635 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
640 transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc)
642 spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), 0);
646 transport_connection_tx_pacer_init (transport_connection_t * tc,
647 u64 rate_bytes_per_sec,
650 tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
651 transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
656 transport_connection_tx_pacer_update (transport_connection_t * tc,
659 spacer_set_pace_rate (&tc->pacer, bytes_per_sec);
663 transport_connection_tx_pacer_burst (transport_connection_t * tc)
665 return spacer_max_burst (&tc->pacer,
666 transport_us_time_now (tc->thread_index));
670 transport_connection_snd_space (transport_connection_t * tc, u16 mss)
672 u32 snd_space, max_paced_burst;
674 snd_space = tp_vfts[tc->proto].send_space (tc);
675 if (snd_space && transport_connection_is_tx_paced (tc))
677 clib_us_time_t now = transport_us_time_now (tc->thread_index);
678 max_paced_burst = spacer_max_burst (&tc->pacer, now);
680 (max_paced_burst < TRANSPORT_PACER_MIN_BURST) ? 0 : max_paced_burst;
681 snd_space = clib_min (snd_space, max_paced_burst);
682 return snd_space >= mss ? snd_space - snd_space % mss : snd_space;
688 transport_connection_tx_pacer_rate (transport_connection_t * tc)
690 return spacer_pace_rate (&tc->pacer);
694 transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
696 if (transport_connection_is_tx_paced (tc))
697 spacer_update_bucket (&tc->pacer, bytes);
701 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
704 spacer_update_bucket (&tc->pacer, bytes);
708 transport_update_time (clib_time_type_t time_now, u8 thread_index)
710 transport_proto_vft_t *vft;
711 vec_foreach (vft, tp_vfts)
713 if (vft->update_time)
714 (vft->update_time) (time_now, thread_index);
719 transport_enable_disable (vlib_main_t * vm, u8 is_en)
721 transport_proto_vft_t *vft;
722 vec_foreach (vft, tp_vfts)
725 (vft->enable) (vm, is_en);
730 transport_init (void)
732 vlib_thread_main_t *vtm = vlib_get_thread_main ();
733 session_main_t *smm = vnet_get_session_main ();
736 if (smm->local_endpoints_table_buckets == 0)
737 smm->local_endpoints_table_buckets = 250000;
738 if (smm->local_endpoints_table_memory == 0)
739 smm->local_endpoints_table_memory = 512 << 20;
741 /* Initialize [port-allocator] random number seed */
742 port_allocator_seed = (u32) clib_cpu_time_now ();
744 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
745 smm->local_endpoints_table_buckets,
746 smm->local_endpoints_table_memory);
747 num_threads = 1 /* main thread */ + vtm->n_threads;
749 clib_spinlock_init (&local_endpoints_lock);
753 * fd.io coding-style-patch-verification: ON
756 * eval: (c-set-style "gnu")