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 * 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
54 format_transport_proto (u8 * s, va_list * args)
56 u32 transport_proto = va_arg (*args, u32);
57 switch (transport_proto)
59 case TRANSPORT_PROTO_TCP:
60 s = format (s, "TCP");
62 case TRANSPORT_PROTO_UDP:
63 s = format (s, "UDP");
65 case TRANSPORT_PROTO_SCTP:
66 s = format (s, "SCTP");
68 case TRANSPORT_PROTO_UDPC:
69 s = format (s, "UDPC");
76 format_transport_proto_short (u8 * s, va_list * args)
78 u32 transport_proto = va_arg (*args, u32);
79 switch (transport_proto)
81 case TRANSPORT_PROTO_TCP:
84 case TRANSPORT_PROTO_UDP:
87 case TRANSPORT_PROTO_SCTP:
90 case TRANSPORT_PROTO_UDPC:
98 format_transport_connection (u8 * s, va_list * args)
100 u32 transport_proto = va_arg (*args, u32);
101 u32 conn_index = va_arg (*args, u32);
102 u32 thread_index = va_arg (*args, u32);
103 u32 verbose = va_arg (*args, u32);
104 transport_proto_vft_t *tp_vft;
105 transport_connection_t *tc;
108 tp_vft = transport_protocol_get_vft (transport_proto);
112 s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
114 tc = tp_vft->get_connection (conn_index, thread_index);
115 if (tc && transport_connection_is_tx_paced (tc) && verbose > 1)
117 indent = format_get_indent (s) + 1;
118 s = format (s, "%Upacer: %U\n", format_white_space, indent,
119 format_transport_pacer, &tc->pacer);
125 format_transport_listen_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_listener, listen_index);
140 format_transport_half_open_connection (u8 * s, va_list * args)
142 u32 transport_proto = va_arg (*args, u32);
143 u32 listen_index = va_arg (*args, u32);
144 transport_proto_vft_t *tp_vft;
146 tp_vft = transport_protocol_get_vft (transport_proto);
150 s = format (s, "%U", tp_vft->format_half_open, listen_index);
155 unformat_transport_proto (unformat_input_t * input, va_list * args)
157 u32 *proto = va_arg (*args, u32 *);
158 if (unformat (input, "tcp"))
159 *proto = TRANSPORT_PROTO_TCP;
160 else if (unformat (input, "TCP"))
161 *proto = TRANSPORT_PROTO_TCP;
162 else if (unformat (input, "udp"))
163 *proto = TRANSPORT_PROTO_UDP;
164 else if (unformat (input, "UDP"))
165 *proto = TRANSPORT_PROTO_UDP;
166 else if (unformat (input, "sctp"))
167 *proto = TRANSPORT_PROTO_SCTP;
168 else if (unformat (input, "SCTP"))
169 *proto = TRANSPORT_PROTO_SCTP;
170 else if (unformat (input, "tls"))
171 *proto = TRANSPORT_PROTO_TLS;
172 else if (unformat (input, "TLS"))
173 *proto = TRANSPORT_PROTO_TLS;
174 else if (unformat (input, "udpc"))
175 *proto = TRANSPORT_PROTO_UDPC;
176 else if (unformat (input, "UDPC"))
177 *proto = TRANSPORT_PROTO_UDPC;
184 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
185 ip46_address_t * ip, u16 port)
187 clib_bihash_kv_24_8_t kv;
190 kv.key[0] = ip->as_u64[0];
191 kv.key[1] = ip->as_u64[1];
192 kv.key[2] = (u64) port << 8 | (u64) proto;
194 rv = clib_bihash_search_inline_24_8 (ht, &kv);
198 return ENDPOINT_INVALID_INDEX;
202 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
203 transport_endpoint_t * te, u32 value)
205 clib_bihash_kv_24_8_t kv;
207 kv.key[0] = te->ip.as_u64[0];
208 kv.key[1] = te->ip.as_u64[1];
209 kv.key[2] = (u64) te->port << 8 | (u64) proto;
212 clib_bihash_add_del_24_8 (ht, &kv, 1);
216 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
217 transport_endpoint_t * te)
219 clib_bihash_kv_24_8_t kv;
221 kv.key[0] = te->ip.as_u64[0];
222 kv.key[1] = te->ip.as_u64[1];
223 kv.key[2] = (u64) te->port << 8 | (u64) proto;
225 clib_bihash_add_del_24_8 (ht, &kv, 0);
229 * Register transport virtual function table.
231 * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
232 * @param vft - virtual function table for transport proto
233 * @param fib_proto - network layer protocol
234 * @param output_node - output node index that session layer will hand off
235 * buffers to, for requested fib proto
238 transport_register_protocol (transport_proto_t transport_proto,
239 const transport_proto_vft_t * vft,
240 fib_protocol_t fib_proto, u32 output_node)
242 u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
244 vec_validate (tp_vfts, transport_proto);
245 tp_vfts[transport_proto] = *vft;
247 session_register_transport (transport_proto, vft, is_ip4, output_node);
251 * Get transport virtual function table
253 * @param type - session type (not protocol type)
255 transport_proto_vft_t *
256 transport_protocol_get_vft (transport_proto_t transport_proto)
258 if (transport_proto >= vec_len (tp_vfts))
260 return &tp_vfts[transport_proto];
263 transport_service_type_t
264 transport_protocol_service_type (transport_proto_t tp)
266 return tp_vfts[tp].service_type;
269 transport_tx_fn_type_t
270 transport_protocol_tx_fn_type (transport_proto_t tp)
272 return tp_vfts[tp].tx_type;
276 transport_protocol_is_cl (transport_proto_t tp)
278 return (tp_vfts[tp].service_type == TRANSPORT_SERVICE_CL);
281 #define PORT_MASK ((1 << 16)- 1)
284 transport_endpoint_del (u32 tepi)
286 clib_spinlock_lock_if_init (&local_endpoints_lock);
287 pool_put_index (local_endpoints, tepi);
288 clib_spinlock_unlock_if_init (&local_endpoints_lock);
291 always_inline transport_endpoint_t *
292 transport_endpoint_new (void)
294 transport_endpoint_t *tep;
295 pool_get_zero (local_endpoints, tep);
300 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
303 transport_endpoint_t *tep;
305 /* Cleanup local endpoint if this was an active connect */
306 tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
307 clib_net_to_host_u16 (port));
308 if (tepi != ENDPOINT_INVALID_INDEX)
310 tep = pool_elt_at_index (local_endpoints, tepi);
311 transport_endpoint_table_del (&local_endpoints_table, proto, tep);
312 transport_endpoint_del (tepi);
317 transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
319 transport_endpoint_t *tep;
320 clib_spinlock_lock_if_init (&local_endpoints_lock);
321 tep = transport_endpoint_new ();
322 clib_memcpy_fast (&tep->ip, ip, sizeof (*ip));
324 transport_endpoint_table_add (&local_endpoints_table, proto, tep,
325 tep - local_endpoints);
326 clib_spinlock_unlock_if_init (&local_endpoints_lock);
330 * Allocate local port and add if successful add entry to local endpoint
331 * table to mark the pair as used.
334 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
336 u16 min = 1024, max = 65535; /* XXX configurable ? */
342 /* Only support active opens from thread 0 */
343 ASSERT (vlib_get_thread_index () == 0);
345 /* Search for first free slot */
346 for (tries = 0; tries < limit; tries++)
350 /* Find a port in the specified range */
353 port = random_u32 (&port_allocator_seed) & PORT_MASK;
354 if (PREDICT_TRUE (port >= min && port < max))
358 /* Look it up. If not found, we're done */
359 tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
361 if (tei == ENDPOINT_INVALID_INDEX)
363 transport_endpoint_mark_used (proto, ip, port);
370 static clib_error_t *
371 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
376 ip4 = ip_interface_get_first_ip (sw_if_index, 1);
378 return clib_error_return (0, "no routable ip4 address on %U",
379 format_vnet_sw_if_index_name,
380 vnet_get_main (), sw_if_index);
381 addr->ip4.as_u32 = ip4->as_u32;
386 ip6 = ip_interface_get_first_ip (sw_if_index, 0);
388 return clib_error_return (0, "no routable ip6 addresses on %U",
389 format_vnet_sw_if_index_name,
390 vnet_get_main (), sw_if_index);
391 clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
396 static clib_error_t *
397 transport_find_local_ip_for_remote (u32 sw_if_index,
398 transport_endpoint_t * rmt,
399 ip46_address_t * lcl_addr)
401 fib_node_index_t fei;
404 if (sw_if_index == ENDPOINT_INVALID_INDEX)
406 /* Find a FIB path to the destination */
407 clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
408 prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
409 prefix.fp_len = rmt->is_ip4 ? 32 : 128;
411 ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
412 fei = fib_table_lookup (rmt->fib_index, &prefix);
414 /* Couldn't find route to destination. Bail out. */
415 if (fei == FIB_NODE_INDEX_INVALID)
416 return clib_error_return (0, "no route to %U", format_ip46_address,
417 &rmt->ip, (rmt->is_ip4 == 0) + 1);
419 sw_if_index = fib_entry_get_resolving_interface (fei);
420 if (sw_if_index == ENDPOINT_INVALID_INDEX)
421 return clib_error_return (0, "no resolving interface for %U",
422 format_ip46_address, &rmt->ip,
423 (rmt->is_ip4 == 0) + 1);
426 clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
427 return transport_get_interface_ip (sw_if_index, rmt->is_ip4, lcl_addr);
431 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
432 ip46_address_t * lcl_addr, u16 * lcl_port)
434 transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
440 * Find the local address
442 if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
444 error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
448 clib_error_report (error);
454 /* Assume session layer vetted this address */
455 clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
456 sizeof (rmt_cfg->peer.ip));
460 * Allocate source port
462 if (rmt_cfg->peer.port == 0)
464 port = transport_alloc_local_port (proto, lcl_addr);
467 clib_warning ("Failed to allocate src port");
474 port = clib_net_to_host_u16 (rmt_cfg->peer.port);
475 tei = transport_endpoint_lookup (&local_endpoints_table, proto,
477 if (tei != ENDPOINT_INVALID_INDEX)
480 transport_endpoint_mark_used (proto, lcl_addr, port);
487 #define SPACER_CPU_TICKS_PER_PERIOD_SHIFT 10
488 #define SPACER_CPU_TICKS_PER_PERIOD (1 << SPACER_CPU_TICKS_PER_PERIOD_SHIFT)
491 format_transport_pacer (u8 * s, va_list * args)
493 spacer_t *pacer = va_arg (*args, spacer_t *);
495 s = format (s, "bucket %u max_burst %u tokens/period %.3f last_update %x",
496 pacer->bucket, pacer->max_burst_size, pacer->tokens_per_period,
502 spacer_max_burst (spacer_t * pacer, u64 norm_time_now)
504 u64 n_periods = norm_time_now - pacer->last_update;
507 if (n_periods > 0 && (inc = n_periods * pacer->tokens_per_period) > 10)
509 pacer->last_update = norm_time_now;
510 pacer->bucket += inc;
513 return clib_min (pacer->bucket, pacer->max_burst_size);
517 spacer_update_bucket (spacer_t * pacer, u32 bytes)
519 ASSERT (pacer->bucket >= bytes);
520 pacer->bucket -= bytes;
524 spacer_update_max_burst_size (spacer_t * pacer, u32 max_burst_bytes)
526 pacer->max_burst_size = clib_max (max_burst_bytes,
527 TRANSPORT_PACER_MIN_BURST);
531 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec)
533 ASSERT (rate_bytes_per_sec != 0);
534 pacer->tokens_per_period = rate_bytes_per_sec / transport_pacer_period;
538 transport_connection_tx_pacer_reset (transport_connection_t * tc,
539 u32 rate_bytes_per_sec,
540 u32 start_bucket, u64 time_now)
542 spacer_t *pacer = &tc->pacer;
546 dispatch_period = transport_dispatch_period (tc->thread_index);
547 burst_size = rate_bytes_per_sec * dispatch_period;
548 spacer_update_max_burst_size (&tc->pacer, burst_size);
549 spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec);
550 pacer->last_update = time_now >> SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
551 pacer->bucket = start_bucket;
555 transport_connection_tx_pacer_init (transport_connection_t * tc,
556 u32 rate_bytes_per_sec,
559 vlib_main_t *vm = vlib_get_main ();
560 tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
561 transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
563 vm->clib_time.last_cpu_time);
567 transport_connection_tx_pacer_update (transport_connection_t * tc,
570 f64 dispatch_period = transport_dispatch_period (tc->thread_index);
571 u32 burst_size = 1.1 * bytes_per_sec * dispatch_period;
572 spacer_set_pace_rate (&tc->pacer, bytes_per_sec);
573 spacer_update_max_burst_size (&tc->pacer, burst_size);
577 transport_connection_tx_pacer_burst (transport_connection_t * tc,
580 time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
581 return spacer_max_burst (&tc->pacer, time_now);
585 transport_connection_snd_space (transport_connection_t * tc, u64 time_now,
588 u32 snd_space, max_paced_burst;
590 snd_space = tp_vfts[tc->proto].send_space (tc);
591 if (transport_connection_is_tx_paced (tc))
593 time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
594 max_paced_burst = spacer_max_burst (&tc->pacer, time_now);
595 max_paced_burst = (max_paced_burst < mss) ? 0 : max_paced_burst;
596 snd_space = clib_min (snd_space, max_paced_burst);
597 snd_space = snd_space - snd_space % mss;
603 transport_connection_update_tx_stats (transport_connection_t * tc, u32 bytes)
605 tc->stats.tx_bytes += bytes;
606 if (transport_connection_is_tx_paced (tc))
607 spacer_update_bucket (&tc->pacer, bytes);
611 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
614 spacer_update_bucket (&tc->pacer, bytes);
618 transport_init_tx_pacers_period (void)
620 f64 cpu_freq = os_cpu_clock_frequency ();
621 transport_pacer_period = cpu_freq / SPACER_CPU_TICKS_PER_PERIOD;
625 transport_update_time (f64 time_now, u8 thread_index)
627 transport_proto_vft_t *vft;
628 vec_foreach (vft, tp_vfts)
630 if (vft->update_time)
631 (vft->update_time) (time_now, thread_index);
636 transport_enable_disable (vlib_main_t * vm, u8 is_en)
638 transport_proto_vft_t *vft;
639 vec_foreach (vft, tp_vfts)
642 (vft->enable) (vm, is_en);
647 transport_init (void)
649 vlib_thread_main_t *vtm = vlib_get_thread_main ();
650 session_manager_main_t *smm = vnet_get_session_manager_main ();
653 if (smm->local_endpoints_table_buckets == 0)
654 smm->local_endpoints_table_buckets = 250000;
655 if (smm->local_endpoints_table_memory == 0)
656 smm->local_endpoints_table_memory = 512 << 20;
658 /* Initialize [port-allocator] random number seed */
659 port_allocator_seed = (u32) clib_cpu_time_now ();
661 clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
662 smm->local_endpoints_table_buckets,
663 smm->local_endpoints_table_memory);
664 num_threads = 1 /* main thread */ + vtm->n_threads;
666 clib_spinlock_init (&local_endpoints_lock);
670 * fd.io coding-style-patch-verification: ON
673 * eval: (c-set-style "gnu")