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/udp/udp_encap.h>
17 #include <vnet/fib/fib_entry.h>
18 #include <vnet/fib/fib_entry_track.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/dpo/drop_dpo.h>
23 * Registered DPO types for the IP header encapsulated, v4 or v6.
25 dpo_type_t udp_encap_dpo_types[FIB_PROTOCOL_MAX];
30 udp_encap_t *udp_encap_pool;
33 * Stats for each UDP encap object
35 vlib_combined_counter_main_t udp_encap_counters = {
37 * The counter collection's name.
41 * Name in stat segment directory
43 .stat_segment_name = "/net/udp-encap",
47 udp_encap_restack (udp_encap_t * ue)
49 dpo_stack (udp_encap_dpo_types[ue->ue_ip_proto],
50 fib_proto_to_dpo (ue->ue_ip_proto), &ue->ue_dpo,
51 fib_entry_contribute_ip_forwarding (ue->ue_fib_entry_index));
55 udp_encap_add_and_lock (fib_protocol_t proto,
57 const ip46_address_t * src_ip,
58 const ip46_address_t * dst_ip,
60 u16 dst_port, udp_encap_fixup_flags_t flags)
66 pool_get_aligned_zero (udp_encap_pool, ue, CLIB_CACHE_LINE_BYTES);
67 uei = ue - udp_encap_pool;
69 vlib_validate_combined_counter (&(udp_encap_counters), uei);
70 vlib_zero_combined_counter (&(udp_encap_counters), uei);
72 fib_node_init (&ue->ue_fib_node, FIB_NODE_TYPE_UDP_ENCAP);
73 fib_node_lock (&ue->ue_fib_node);
74 ue->ue_fib_index = fib_index;
76 ue->ue_ip_proto = proto;
80 case FIB_PROTOCOL_IP4:
82 ue->ue_hdrs.ip4.ue_ip4.ip_version_and_header_length = 0x45;
83 ue->ue_hdrs.ip4.ue_ip4.ttl = 254;
84 ue->ue_hdrs.ip4.ue_ip4.protocol = IP_PROTOCOL_UDP;
85 ue->ue_hdrs.ip4.ue_ip4.src_address.as_u32 = src_ip->ip4.as_u32;
86 ue->ue_hdrs.ip4.ue_ip4.dst_address.as_u32 = dst_ip->ip4.as_u32;
87 ue->ue_hdrs.ip4.ue_ip4.checksum =
88 ip4_header_checksum (&ue->ue_hdrs.ip4.ue_ip4);
89 ue->ue_hdrs.ip4.ue_udp.src_port = clib_host_to_net_u16 (src_port);
90 ue->ue_hdrs.ip4.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
93 case FIB_PROTOCOL_IP6:
95 ue->ue_hdrs.ip6.ue_ip6.ip_version_traffic_class_and_flow_label =
96 clib_host_to_net_u32 (6 << 28);
97 ue->ue_hdrs.ip6.ue_ip6.hop_limit = 255;
98 ue->ue_hdrs.ip6.ue_ip6.protocol = IP_PROTOCOL_UDP;
99 ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[0] = src_ip->ip6.as_u64[0];
100 ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[1] = src_ip->ip6.as_u64[1];
101 ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[0] = dst_ip->ip6.as_u64[0];
102 ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[1] = dst_ip->ip6.as_u64[1];
103 ue->ue_hdrs.ip6.ue_udp.src_port = clib_host_to_net_u16 (src_port);
104 ue->ue_hdrs.ip6.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
112 * track the destination address
114 fib_prefix_t dst_pfx = {
120 ue->ue_fib_entry_index = fib_entry_track (fib_index,
122 FIB_NODE_TYPE_UDP_ENCAP,
123 uei, &ue->ue_fib_sibling);
124 udp_encap_restack (ue);
130 udp_encap_contribute_forwarding (index_t uei, dpo_proto_t proto,
133 if (INDEX_INVALID == uei)
135 dpo_copy (dpo, drop_dpo_get (proto));
141 ue = udp_encap_get (uei);
143 dpo_set (dpo, udp_encap_dpo_types[ue->ue_ip_proto], proto, uei);
148 udp_encap_lock (index_t uei)
152 ue = udp_encap_get (uei);
156 fib_node_lock (&ue->ue_fib_node);
161 udp_encap_unlock (index_t uei)
165 if (INDEX_INVALID == uei)
170 ue = udp_encap_get (uei);
174 fib_node_unlock (&ue->ue_fib_node);
179 udp_encap_dpo_lock (dpo_id_t * dpo)
183 ue = udp_encap_get (dpo->dpoi_index);
185 fib_node_lock (&ue->ue_fib_node);
189 udp_encap_dpo_unlock (dpo_id_t * dpo)
193 ue = udp_encap_get (dpo->dpoi_index);
195 fib_node_unlock (&ue->ue_fib_node);
199 format_udp_encap_fixup_flags (u8 *s, va_list *args)
201 udp_encap_fixup_flags_t flags = va_arg (*args, udp_encap_fixup_flags_t);
203 if (flags == UDP_ENCAP_FIXUP_NONE)
204 return format (s, "none");
206 if (flags & UDP_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY)
207 s = format (s, "%s", "src-port-is-entropy");
213 format_udp_encap_i (u8 * s, va_list * args)
215 index_t uei = va_arg (*args, index_t);
216 u32 indent = va_arg (*args, u32);
217 u32 details = va_arg (*args, u32);
221 ue = udp_encap_get (uei);
224 s = format (s, "udp-encap:[%d]: ip-fib-index:%d ", uei, ue->ue_fib_index);
225 if (FIB_PROTOCOL_IP4 == ue->ue_ip_proto)
227 s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d, dst:%d] flags:%U",
228 format_ip4_address, &ue->ue_hdrs.ip4.ue_ip4.src_address,
229 format_ip4_address, &ue->ue_hdrs.ip4.ue_ip4.dst_address,
230 clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.src_port),
231 clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.dst_port),
232 format_udp_encap_fixup_flags, ue->ue_flags);
236 s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d dst:%d] flags:%U",
237 format_ip6_address, &ue->ue_hdrs.ip6.ue_ip6.src_address,
238 format_ip6_address, &ue->ue_hdrs.ip6.ue_ip6.dst_address,
239 clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.src_port),
240 clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.dst_port),
241 format_udp_encap_fixup_flags, ue->ue_flags);
243 vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
244 s = format (s, " to:[%Ld:%Ld]]", to.packets, to.bytes);
248 s = format (s, " locks:%d", ue->ue_fib_node.fn_locks);
249 s = format (s, "\n%UStacked on:", format_white_space, indent + 1);
250 s = format (s, "\n%U%U",
251 format_white_space, indent + 2,
252 format_dpo_id, &ue->ue_dpo, indent + 3);
258 udp_encap_get_stats (index_t uei, u64 * packets, u64 * bytes)
262 vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
264 *packets = to.packets;
269 format_udp_encap_dpo (u8 * s, va_list * args)
271 index_t uei = va_arg (*args, index_t);
272 u32 indent = va_arg (*args, u32);
274 return (format (s, "%U", format_udp_encap_i, uei, indent, 1));
278 format_udp_encap (u8 * s, va_list * args)
280 index_t uei = va_arg (*args, u32);
281 u32 details = va_arg (*args, u32);
283 return (format (s, "%U", format_udp_encap_i, uei, 0, details));
287 udp_encap_from_fib_node (fib_node_t * node)
289 ASSERT (FIB_NODE_TYPE_UDP_ENCAP == node->fn_type);
290 return ((udp_encap_t *) (((char *) node) -
291 STRUCT_OFFSET_OF (udp_encap_t, ue_fib_node)));
295 * Function definition to backwalk a FIB node
297 static fib_node_back_walk_rc_t
298 udp_encap_fib_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
300 udp_encap_restack (udp_encap_from_fib_node (node));
302 return (FIB_NODE_BACK_WALK_CONTINUE);
306 * Function definition to get a FIB node from its index
309 udp_encap_fib_node_get (fib_node_index_t index)
313 ue = pool_elt_at_index (udp_encap_pool, index);
315 return (&ue->ue_fib_node);
319 * Function definition to inform the FIB node that its last lock has gone.
322 udp_encap_fib_last_lock_gone (fib_node_t * node)
326 ue = udp_encap_from_fib_node (node);
329 * reset the stacked DPO to unlock it
331 dpo_reset (&ue->ue_dpo);
333 fib_entry_untrack (ue->ue_fib_entry_index, ue->ue_fib_sibling);
335 pool_put (udp_encap_pool, ue);
338 const static char *const udp4_encap_ip4_nodes[] = {
343 const static char *const udp4_encap_ip6_nodes[] = {
348 const static char *const udp4_encap_mpls_nodes[] = {
353 const static char *const udp4_encap_bier_nodes[] = {
358 const static char *const udp6_encap_ip4_nodes[] = {
363 const static char *const udp6_encap_ip6_nodes[] = {
368 const static char *const udp6_encap_mpls_nodes[] = {
373 const static char *const udp6_encap_bier_nodes[] = {
378 const static char *const *const udp4_encap_nodes[DPO_PROTO_NUM] = {
379 [DPO_PROTO_IP4] = udp4_encap_ip4_nodes,
380 [DPO_PROTO_IP6] = udp4_encap_ip6_nodes,
381 [DPO_PROTO_MPLS] = udp4_encap_mpls_nodes,
382 [DPO_PROTO_BIER] = udp4_encap_bier_nodes,
385 const static char *const *const udp6_encap_nodes[DPO_PROTO_NUM] = {
386 [DPO_PROTO_IP4] = udp6_encap_ip4_nodes,
387 [DPO_PROTO_IP6] = udp6_encap_ip6_nodes,
388 [DPO_PROTO_MPLS] = udp6_encap_mpls_nodes,
389 [DPO_PROTO_BIER] = udp6_encap_bier_nodes,
393 * Virtual function table registered by UDP encaps
394 * for participation in the FIB object graph.
396 const static fib_node_vft_t udp_encap_fib_vft = {
397 .fnv_get = udp_encap_fib_node_get,
398 .fnv_last_lock = udp_encap_fib_last_lock_gone,
399 .fnv_back_walk = udp_encap_fib_back_walk,
402 const static dpo_vft_t udp_encap_dpo_vft = {
403 .dv_lock = udp_encap_dpo_lock,
404 .dv_unlock = udp_encap_dpo_unlock,
405 .dv_format = format_udp_encap_dpo,
409 udp_encap_init (vlib_main_t * vm)
411 fib_node_register_type (FIB_NODE_TYPE_UDP_ENCAP, &udp_encap_fib_vft);
413 udp_encap_dpo_types[FIB_PROTOCOL_IP4] =
414 dpo_register_new_type (&udp_encap_dpo_vft, udp4_encap_nodes);
415 udp_encap_dpo_types[FIB_PROTOCOL_IP6] =
416 dpo_register_new_type (&udp_encap_dpo_vft, udp6_encap_nodes);
421 VLIB_INIT_FUNCTION (udp_encap_init);
424 udp_encap_cli (vlib_main_t * vm,
425 unformat_input_t * main_input, vlib_cli_command_t * cmd)
427 unformat_input_t _line_input, *line_input = &_line_input;
428 clib_error_t *error = NULL;
429 ip46_address_t src_ip, dst_ip;
430 u32 table_id, src_port, dst_port;
431 udp_encap_fixup_flags_t flags;
432 fib_protocol_t fproto;
438 flags = UDP_ENCAP_FIXUP_NONE;
439 fproto = FIB_PROTOCOL_MAX;
443 /* Get a line of input. */
444 if (!unformat_user (main_input, unformat_line_input, line_input))
447 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
449 if (unformat (line_input, "index %d", &uei))
451 else if (unformat (line_input, "add"))
453 else if (unformat (line_input, "del"))
455 else if (unformat (line_input, "%U %U",
456 unformat_ip4_address,
457 &src_ip.ip4, unformat_ip4_address, &dst_ip.ip4))
458 fproto = FIB_PROTOCOL_IP4;
459 else if (unformat (line_input, "%U %U",
460 unformat_ip6_address,
461 &src_ip.ip6, unformat_ip6_address, &dst_ip.ip6))
462 fproto = FIB_PROTOCOL_IP6;
463 else if (unformat (line_input, "%d %d", &src_port, &dst_port))
465 else if (unformat (line_input, "%d", &dst_port))
467 else if (unformat (line_input, "table-id %d", &table_id))
469 else if (unformat (line_input, "src-port-is-entropy"))
470 flags |= UDP_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY;
473 error = unformat_parse_error (line_input);
478 if (!is_del && fproto != FIB_PROTOCOL_MAX)
483 fib_index = fib_table_find (fproto, table_id);
487 error = clib_error_return (0, "Nonexistent table id %d", table_id);
491 uei = udp_encap_add_and_lock (fproto, fib_index,
493 src_port, dst_port, flags);
495 vlib_cli_output (vm, "udp-encap: %d\n", uei);
499 if (INDEX_INVALID == uei)
501 error = clib_error_return (0, "specify udp-encap object index");
504 udp_encap_unlock (uei);
508 error = clib_error_return (0, "specify some IP addresses");
512 unformat_free (line_input);
517 udp_encap_walk (udp_encap_walk_cb_t cb, void *ctx)
522 pool_foreach_index (uei, udp_encap_pool)
524 if (WALK_STOP == cb(uei, ctx))
531 udp_encap_show (vlib_main_t * vm,
532 unformat_input_t * input, vlib_cli_command_t * cmd)
538 /* Get a line of input. */
539 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
541 if (unformat (input, "%d", &uei))
544 return clib_error_return (0, "unknown input `%U'",
545 format_unformat_error, input);
548 if (INDEX_INVALID == uei)
551 pool_foreach_index (uei, udp_encap_pool)
553 vlib_cli_output(vm, "%U", format_udp_encap, uei, 0);
559 vlib_cli_output (vm, "%U", format_udp_encap, uei, 1);
566 VLIB_CLI_COMMAND (udp_encap_add_command, static) = {
568 .short_help = "udp encap [add|del] <id ID> <src-ip> <dst-ip> [<src-port>] "
569 "<dst-port> [src-port-is-entropy] [table-id <table>]",
570 .function = udp_encap_cli,
574 VLIB_CLI_COMMAND (udp_encap_show_command, static) = {
575 .path = "show udp encap",
576 .short_help = "show udp encap [ID]",
577 .function = udp_encap_show,
583 * fd.io coding-style-patch-verification: ON
586 * eval: (c-set-style "gnu")