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),
52 fib_entry_contribute_ip_forwarding (ue->ue_fib_entry_index));
56 udp_encap_add_and_lock (fib_protocol_t proto,
58 const ip46_address_t * src_ip,
59 const ip46_address_t * dst_ip,
61 u16 dst_port, udp_encap_fixup_flags_t flags)
67 pool_get_aligned (udp_encap_pool, ue, CLIB_CACHE_LINE_BYTES);
68 uei = ue - udp_encap_pool;
70 vlib_validate_combined_counter (&(udp_encap_counters), uei);
71 vlib_zero_combined_counter (&(udp_encap_counters), uei);
73 fib_node_init (&ue->ue_fib_node, FIB_NODE_TYPE_UDP_ENCAP);
74 fib_node_lock (&ue->ue_fib_node);
75 ue->ue_fib_index = fib_index;
77 ue->ue_ip_proto = proto;
81 case FIB_PROTOCOL_IP4:
83 ue->ue_hdrs.ip4.ue_ip4.ip_version_and_header_length = 0x45;
84 ue->ue_hdrs.ip4.ue_ip4.ttl = 254;
85 ue->ue_hdrs.ip4.ue_ip4.protocol = IP_PROTOCOL_UDP;
86 ue->ue_hdrs.ip4.ue_ip4.src_address.as_u32 = src_ip->ip4.as_u32;
87 ue->ue_hdrs.ip4.ue_ip4.dst_address.as_u32 = dst_ip->ip4.as_u32;
88 ue->ue_hdrs.ip4.ue_ip4.checksum =
89 ip4_header_checksum (&ue->ue_hdrs.ip4.ue_ip4);
90 ue->ue_hdrs.ip4.ue_udp.src_port = clib_host_to_net_u16 (src_port);
91 ue->ue_hdrs.ip4.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
94 case FIB_PROTOCOL_IP6:
96 ue->ue_hdrs.ip6.ue_ip6.ip_version_traffic_class_and_flow_label =
97 clib_host_to_net_u32 (6 << 28);
98 ue->ue_hdrs.ip6.ue_ip6.hop_limit = 255;
99 ue->ue_hdrs.ip6.ue_ip6.protocol = IP_PROTOCOL_UDP;
100 ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[0] = src_ip->ip6.as_u64[0];
101 ue->ue_hdrs.ip6.ue_ip6.src_address.as_u64[1] = src_ip->ip6.as_u64[1];
102 ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[0] = dst_ip->ip6.as_u64[0];
103 ue->ue_hdrs.ip6.ue_ip6.dst_address.as_u64[1] = dst_ip->ip6.as_u64[1];
104 ue->ue_hdrs.ip6.ue_udp.src_port = clib_host_to_net_u16 (src_port);
105 ue->ue_hdrs.ip6.ue_udp.dst_port = clib_host_to_net_u16 (dst_port);
113 * track the destination address
115 fib_prefix_t dst_pfx = {
121 ue->ue_fib_entry_index = fib_entry_track (fib_index,
123 FIB_NODE_TYPE_UDP_ENCAP,
124 uei, &ue->ue_fib_sibling);
125 udp_encap_restack (ue);
131 udp_encap_contribute_forwarding (index_t uei, dpo_proto_t proto,
134 if (INDEX_INVALID == uei)
136 dpo_copy (dpo, drop_dpo_get (proto));
142 ue = udp_encap_get (uei);
144 dpo_set (dpo, udp_encap_dpo_types[ue->ue_ip_proto], proto, uei);
149 udp_encap_lock (index_t uei)
153 ue = udp_encap_get (uei);
157 fib_node_lock (&ue->ue_fib_node);
162 udp_encap_unlock (index_t uei)
166 if (INDEX_INVALID == uei)
171 ue = udp_encap_get (uei);
175 fib_node_unlock (&ue->ue_fib_node);
180 udp_encap_dpo_lock (dpo_id_t * dpo)
184 ue = udp_encap_get (dpo->dpoi_index);
186 fib_node_lock (&ue->ue_fib_node);
190 udp_encap_dpo_unlock (dpo_id_t * dpo)
194 ue = udp_encap_get (dpo->dpoi_index);
196 fib_node_unlock (&ue->ue_fib_node);
200 format_udp_encap_i (u8 * s, va_list * args)
202 index_t uei = va_arg (*args, index_t);
203 u32 indent = va_arg (*args, u32);
204 u32 details = va_arg (*args, u32);
208 ue = udp_encap_get (uei);
211 s = format (s, "udp-encap:[%d]: ip-fib-index:%d ", uei, ue->ue_fib_index);
212 if (FIB_PROTOCOL_IP4 == ue->ue_ip_proto)
214 s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d, dst:%d]",
216 &ue->ue_hdrs.ip4.ue_ip4.src_address,
218 &ue->ue_hdrs.ip4.ue_ip4.dst_address,
219 clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.src_port),
220 clib_net_to_host_u16 (ue->ue_hdrs.ip4.ue_udp.dst_port));
224 s = format (s, "ip:[src:%U, dst:%U] udp:[src:%d dst:%d]",
226 &ue->ue_hdrs.ip6.ue_ip6.src_address,
228 &ue->ue_hdrs.ip6.ue_ip6.dst_address,
229 clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.src_port),
230 clib_net_to_host_u16 (ue->ue_hdrs.ip6.ue_udp.dst_port));
232 vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
233 s = format (s, " to:[%Ld:%Ld]]", to.packets, to.bytes);
237 s = format (s, " locks:%d", ue->ue_fib_node.fn_locks);
238 s = format (s, "\n%UStacked on:", format_white_space, indent + 1);
239 s = format (s, "\n%U%U",
240 format_white_space, indent + 2,
241 format_dpo_id, &ue->ue_dpo, indent + 3);
247 udp_encap_get_stats (index_t uei, u64 * packets, u64 * bytes)
251 vlib_get_combined_counter (&(udp_encap_counters), uei, &to);
253 *packets = to.packets;
258 format_udp_encap_dpo (u8 * s, va_list * args)
260 index_t uei = va_arg (*args, index_t);
261 u32 indent = va_arg (*args, u32);
263 return (format (s, "%U", format_udp_encap_i, uei, indent, 1));
267 format_udp_encap (u8 * s, va_list * args)
269 index_t uei = va_arg (*args, u32);
270 u32 details = va_arg (*args, u32);
272 return (format (s, "%U", format_udp_encap_i, uei, 0, details));
276 udp_encap_from_fib_node (fib_node_t * node)
278 ASSERT (FIB_NODE_TYPE_UDP_ENCAP == node->fn_type);
279 return ((udp_encap_t *) (((char *) node) -
280 STRUCT_OFFSET_OF (udp_encap_t, ue_fib_node)));
284 * Function definition to backwalk a FIB node
286 static fib_node_back_walk_rc_t
287 udp_encap_fib_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
289 udp_encap_restack (udp_encap_from_fib_node (node));
291 return (FIB_NODE_BACK_WALK_CONTINUE);
295 * Function definition to get a FIB node from its index
298 udp_encap_fib_node_get (fib_node_index_t index)
302 ue = pool_elt_at_index (udp_encap_pool, index);
304 return (&ue->ue_fib_node);
308 * Function definition to inform the FIB node that its last lock has gone.
311 udp_encap_fib_last_lock_gone (fib_node_t * node)
315 ue = udp_encap_from_fib_node (node);
318 * reset the stacked DPO to unlock it
320 dpo_reset (&ue->ue_dpo);
322 fib_entry_untrack (ue->ue_fib_entry_index, ue->ue_fib_sibling);
324 pool_put (udp_encap_pool, ue);
327 const static char *const udp4_encap_ip4_nodes[] = {
332 const static char *const udp4_encap_ip6_nodes[] = {
337 const static char *const udp4_encap_mpls_nodes[] = {
342 const static char *const udp4_encap_bier_nodes[] = {
347 const static char *const udp6_encap_ip4_nodes[] = {
352 const static char *const udp6_encap_ip6_nodes[] = {
357 const static char *const udp6_encap_mpls_nodes[] = {
362 const static char *const udp6_encap_bier_nodes[] = {
367 const static char *const *const udp4_encap_nodes[DPO_PROTO_NUM] = {
368 [DPO_PROTO_IP4] = udp4_encap_ip4_nodes,
369 [DPO_PROTO_IP6] = udp4_encap_ip6_nodes,
370 [DPO_PROTO_MPLS] = udp4_encap_mpls_nodes,
371 [DPO_PROTO_BIER] = udp4_encap_bier_nodes,
374 const static char *const *const udp6_encap_nodes[DPO_PROTO_NUM] = {
375 [DPO_PROTO_IP4] = udp6_encap_ip4_nodes,
376 [DPO_PROTO_IP6] = udp6_encap_ip6_nodes,
377 [DPO_PROTO_MPLS] = udp6_encap_mpls_nodes,
378 [DPO_PROTO_BIER] = udp6_encap_bier_nodes,
382 * Virtual function table registered by UDP encaps
383 * for participation in the FIB object graph.
385 const static fib_node_vft_t udp_encap_fib_vft = {
386 .fnv_get = udp_encap_fib_node_get,
387 .fnv_last_lock = udp_encap_fib_last_lock_gone,
388 .fnv_back_walk = udp_encap_fib_back_walk,
391 const static dpo_vft_t udp_encap_dpo_vft = {
392 .dv_lock = udp_encap_dpo_lock,
393 .dv_unlock = udp_encap_dpo_unlock,
394 .dv_format = format_udp_encap_dpo,
398 udp_encap_init (vlib_main_t * vm)
400 fib_node_register_type (FIB_NODE_TYPE_UDP_ENCAP, &udp_encap_fib_vft);
402 udp_encap_dpo_types[FIB_PROTOCOL_IP4] =
403 dpo_register_new_type (&udp_encap_dpo_vft, udp4_encap_nodes);
404 udp_encap_dpo_types[FIB_PROTOCOL_IP6] =
405 dpo_register_new_type (&udp_encap_dpo_vft, udp6_encap_nodes);
410 VLIB_INIT_FUNCTION (udp_encap_init);
413 udp_encap_cli (vlib_main_t * vm,
414 unformat_input_t * main_input, vlib_cli_command_t * cmd)
416 unformat_input_t _line_input, *line_input = &_line_input;
417 clib_error_t *error = NULL;
418 ip46_address_t src_ip, dst_ip;
419 u32 table_id, src_port, dst_port;
420 udp_encap_fixup_flags_t flags;
421 fib_protocol_t fproto;
427 flags = UDP_ENCAP_FIXUP_NONE;
428 fproto = FIB_PROTOCOL_MAX;
432 /* Get a line of input. */
433 if (!unformat_user (main_input, unformat_line_input, line_input))
436 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
438 if (unformat (line_input, "index %d", &uei))
440 else if (unformat (line_input, "add"))
442 else if (unformat (line_input, "del"))
444 else if (unformat (line_input, "%U %U",
445 unformat_ip4_address,
446 &src_ip.ip4, unformat_ip4_address, &dst_ip.ip4))
447 fproto = FIB_PROTOCOL_IP4;
448 else if (unformat (line_input, "%U %U",
449 unformat_ip6_address,
450 &src_ip.ip6, unformat_ip6_address, &dst_ip.ip6))
451 fproto = FIB_PROTOCOL_IP6;
452 else if (unformat (line_input, "%d %d", &src_port, &dst_port))
454 else if (unformat (line_input, "%d", &dst_port))
456 else if (unformat (line_input, "table-id %d", &table_id))
458 else if (unformat (line_input, "src-port-is-entropy"))
459 flags |= UDP_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY;
462 error = unformat_parse_error (line_input);
467 if (!is_del && fproto != FIB_PROTOCOL_MAX)
472 fib_index = fib_table_find (fproto, table_id);
476 error = clib_error_return (0, "Nonexistent table id %d", table_id);
480 uei = udp_encap_add_and_lock (fproto, fib_index,
482 src_port, dst_port, flags);
484 vlib_cli_output (vm, "udp-encap: %d\n", uei);
488 if (INDEX_INVALID == uei)
490 error = clib_error_return (0, "specify udp-encap object index");
493 udp_encap_unlock (uei);
497 error = clib_error_return (0, "specify some IP addresses");
501 unformat_free (line_input);
506 udp_encap_walk (udp_encap_walk_cb_t cb, void *ctx)
511 pool_foreach_index(uei, udp_encap_pool,
513 if (WALK_STOP == cb(uei, ctx))
520 udp_encap_show (vlib_main_t * vm,
521 unformat_input_t * input, vlib_cli_command_t * cmd)
527 /* Get a line of input. */
528 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
530 if (unformat (input, "%d", &uei))
533 return clib_error_return (0, "unknown input `%U'",
534 format_unformat_error, input);
537 if (INDEX_INVALID == uei)
540 pool_foreach_index(uei, udp_encap_pool,
542 vlib_cli_output(vm, "%U", format_udp_encap, uei, 0);
548 vlib_cli_output (vm, "%U", format_udp_encap, uei, 1);
555 VLIB_CLI_COMMAND (udp_encap_add_command, static) = {
557 .short_help = "udp encap [add|del] <id ID> <src-ip> <dst-ip> [<src-port>] <dst-port> [src-port-is-entropy] [table-id <table>]",
558 .function = udp_encap_cli,
561 VLIB_CLI_COMMAND (udp_encap_show_command, static) = {
562 .path = "show udp encap",
563 .short_help = "show udp encap [ID]",
564 .function = udp_encap_show,
570 * fd.io coding-style-patch-verification: ON
573 * eval: (c-set-style "gnu")