2 * Copyright (c) 2016 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.
17 * @brief Common utility functions for IPv4, IPv6 and L2 LISP-GPE tunnels.
21 #include <vnet/lisp-gpe/lisp_gpe.h>
22 #include <vnet/lisp-gpe/lisp_gpe_fwd_entry.h>
23 #include <vnet/lisp-gpe/lisp_gpe_adjacency.h>
24 #include <vnet/lisp-gpe/lisp_gpe_tenant.h>
25 #include <vnet/fib/fib_path_list.h>
26 #include <vnet/fib/fib_table.h>
27 #include <vnet/fib/fib_internal.h>
29 /** LISP-GPE global state */
30 lisp_gpe_main_t lisp_gpe_main;
33 /** CLI command to add/del forwarding entry. */
35 lisp_gpe_add_del_fwd_entry_command_fn (vlib_main_t * vm,
36 unformat_input_t * input,
37 vlib_cli_command_t * cmd)
39 unformat_input_t _line_input, *line_input = &_line_input;
41 ip_address_t lloc, rloc;
42 clib_error_t *error = 0;
43 gid_address_t _reid, *reid = &_reid, _leid, *leid = &_leid;
44 u8 reid_set = 0, leid_set = 0, is_negative = 0, dp_table_set = 0,
46 u32 vni = 0, dp_table = 0, action = ~0, w;
47 locator_pair_t pair, *pairs = 0;
50 clib_memset (leid, 0, sizeof (*leid));
51 clib_memset (reid, 0, sizeof (*reid));
53 /* Get a line of input. */
54 if (!unformat_user (input, unformat_line_input, line_input))
57 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
59 if (unformat (line_input, "del"))
61 else if (unformat (line_input, "add"))
63 else if (unformat (line_input, "leid %U", unformat_gid_address, leid))
67 else if (unformat (line_input, "reid %U", unformat_gid_address, reid))
71 else if (unformat (line_input, "vni %u", &vni))
73 gid_address_vni (leid) = vni;
74 gid_address_vni (reid) = vni;
77 else if (unformat (line_input, "vrf %u", &dp_table))
81 else if (unformat (line_input, "bd %u", &dp_table))
85 else if (unformat (line_input, "negative action %U",
86 unformat_negative_mapping_action, &action))
90 else if (unformat (line_input, "loc-pair %U %U w %d",
91 unformat_ip_address, &lloc,
92 unformat_ip_address, &rloc, &w))
94 ip_address_copy (&pair.lcl_loc, &lloc);
95 ip_address_copy (&pair.rmt_loc, &rloc);
98 vec_add1 (pairs, pair);
102 error = unformat_parse_error (line_input);
103 vlib_cli_output (vm, "parse error: '%U'",
104 format_unformat_error, line_input);
111 vlib_cli_output (vm, "remote eid must be set!");
115 if (gid_address_type (reid) != GID_ADDR_NSH && (!vni_set || !dp_table_set))
117 vlib_cli_output (vm, "vni and vrf/bd must be set!");
125 vlib_cli_output (vm, "no action set for negative tunnel!");
131 if (vec_len (pairs) == 0)
133 vlib_cli_output (vm, "expected ip4/ip6 locators");
140 /* if leid not set, make sure it's the same AFI like reid */
141 gid_address_type (leid) = gid_address_type (reid);
142 if (GID_ADDR_IP_PREFIX == gid_address_type (reid))
143 gid_address_ip_version (leid) = gid_address_ip_version (reid);
147 vnet_lisp_gpe_add_del_fwd_entry_args_t _a, *a = &_a;
148 clib_memset (a, 0, sizeof (a[0]));
151 a->is_negative = is_negative;
153 a->table_id = dp_table;
154 gid_address_copy (&a->lcl_eid, leid);
155 gid_address_copy (&a->rmt_eid, reid);
156 a->locator_pairs = pairs;
159 rv = vnet_lisp_gpe_add_del_fwd_entry (a, 0);
162 vlib_cli_output (vm, "failed to %s gpe tunnel!",
163 is_add ? "add" : "delete");
167 unformat_free (line_input);
173 VLIB_CLI_COMMAND (lisp_gpe_add_del_fwd_entry_command, static) = {
175 .short_help = "gpe entry add/del vni <vni> vrf/bd <id> [leid <leid>]"
176 "reid <reid> [loc-pair <lloc> <rloc> w <weight>] "
177 "[negative action <action>]",
178 .function = lisp_gpe_add_del_fwd_entry_command_fn,
182 /** Check if LISP-GPE is enabled. */
184 vnet_lisp_gpe_enable_disable_status (void)
186 lisp_gpe_main_t *lgm = &lisp_gpe_main;
191 /** Enable/disable LISP-GPE. */
193 vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t * a)
195 lisp_gpe_main_t *lgm = &lisp_gpe_main;
196 vlib_main_t *vm = vlib_get_main ();
201 udp_register_dst_port (vm, UDP_DST_PORT_lisp_gpe,
202 lisp_gpe_ip4_input_node.index, 1 /* is_ip4 */ );
203 udp_register_dst_port (vm, UDP_DST_PORT_lisp_gpe6,
204 lisp_gpe_ip6_input_node.index, 0 /* is_ip4 */ );
208 /* remove all entries */
209 vnet_lisp_gpe_fwd_entry_flush ();
211 /* disable all l3 ifaces */
212 lisp_gpe_tenant_flush ();
214 udp_unregister_dst_port (vm, UDP_DST_PORT_lisp_gpe, 0 /* is_ip4 */ );
215 udp_unregister_dst_port (vm, UDP_DST_PORT_lisp_gpe6, 1 /* is_ip4 */ );
222 /** Set GPE encapsulation mode. */
224 vnet_gpe_set_encap_mode (gpe_encap_mode_t mode)
226 lisp_gpe_main_t *lgm = &lisp_gpe_main;
228 if (mode >= GPE_ENCAP_COUNT)
229 return VNET_API_ERROR_INVALID_GPE_MODE;
231 if (pool_elts (lgm->lisp_fwd_entry_pool) != 0)
232 return VNET_API_ERROR_LISP_GPE_ENTRIES_PRESENT;
234 lgm->encap_mode = mode;
238 /** CLI command to set GPE encap */
239 static clib_error_t *
240 gpe_set_encap_mode_command_fn (vlib_main_t * vm,
241 unformat_input_t * input,
242 vlib_cli_command_t * cmd)
244 unformat_input_t _line_input, *line_input = &_line_input;
245 gpe_encap_mode_t mode = GPE_ENCAP_COUNT;
248 /* Get a line of input. */
249 if (!unformat_user (input, unformat_line_input, line_input))
252 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
254 if (unformat (line_input, "lisp"))
255 mode = GPE_ENCAP_LISP;
256 else if (unformat (line_input, "vxlan"))
257 mode = GPE_ENCAP_VXLAN;
260 return clib_error_return (0, "parse error: '%U'",
261 format_unformat_error, line_input);
264 rv = vnet_gpe_set_encap_mode (mode);
267 return clib_error_return (0,
268 "Error: invalid mode or GPE entries are present!");
275 VLIB_CLI_COMMAND (gpe_set_encap_mode_command, static) = {
277 .short_help = "gpe encap [lisp|vxlan]",
278 .function = gpe_set_encap_mode_command_fn,
282 /** Format GPE encap mode. */
284 format_vnet_gpe_encap_mode (u8 * s, va_list * args)
286 lisp_gpe_main_t *lgm = &lisp_gpe_main;
288 switch (lgm->encap_mode)
291 return format (s, "lisp");
292 case GPE_ENCAP_VXLAN:
293 return format (s, "vxlan");
300 /** CLI command to show GPE encap */
301 static clib_error_t *
302 gpe_show_encap_mode_command_fn (vlib_main_t * vm,
303 unformat_input_t * input,
304 vlib_cli_command_t * cmd)
306 vlib_cli_output (vm, "encap mode: %U", format_vnet_gpe_encap_mode);
311 VLIB_CLI_COMMAND (gpe_show_encap_mode_command, static) = {
312 .path = "show gpe encap",
313 .short_help = "show GPE encapulation mode",
314 .function = gpe_show_encap_mode_command_fn,
318 /** CLI command to enable/disable LISP-GPE. */
319 static clib_error_t *
320 lisp_gpe_enable_disable_command_fn (vlib_main_t * vm,
321 unformat_input_t * input,
322 vlib_cli_command_t * cmd)
324 unformat_input_t _line_input, *line_input = &_line_input;
326 vnet_lisp_gpe_enable_disable_args_t _a, *a = &_a;
327 clib_error_t *error = NULL;
329 /* Get a line of input. */
330 if (!unformat_user (input, unformat_line_input, line_input))
331 return clib_error_return (0, "expected enable | disable");
333 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
335 if (unformat (line_input, "enable"))
337 else if (unformat (line_input, "disable"))
341 error = clib_error_return (0, "parse error: '%U'",
342 format_unformat_error, line_input);
347 error = vnet_lisp_gpe_enable_disable (a);
350 unformat_free (line_input);
356 VLIB_CLI_COMMAND (enable_disable_lisp_gpe_command, static) = {
358 .short_help = "gpe [enable|disable]",
359 .function = lisp_gpe_enable_disable_command_fn,
363 /** CLI command to show LISP-GPE interfaces. */
364 static clib_error_t *
365 lisp_show_iface_command_fn (vlib_main_t * vm,
366 unformat_input_t * input,
367 vlib_cli_command_t * cmd)
369 lisp_gpe_main_t *lgm = &lisp_gpe_main;
372 vlib_cli_output (vm, "%=10s%=12s", "vrf", "hw_if_index");
375 hash_foreach_pair (p, lgm->l3_ifaces.hw_if_index_by_dp_table, ({
376 vlib_cli_output (vm, "%=10d%=10d", p->key, p->value[0]);
380 if (0 != lgm->l2_ifaces.hw_if_index_by_dp_table)
382 vlib_cli_output (vm, "%=10s%=12s", "bd_id", "hw_if_index");
384 hash_foreach_pair (p, lgm->l2_ifaces.hw_if_index_by_dp_table, ({
385 vlib_cli_output (vm, "%=10d%=10d", p->key, p->value[0]);
393 VLIB_CLI_COMMAND (lisp_show_iface_command) = {
394 .path = "show gpe interface",
395 .short_help = "show gpe interface",
396 .function = lisp_show_iface_command_fn,
400 /** CLI command to show GPE fwd native route path. */
401 static clib_error_t *
402 gpe_show_native_fwd_rpath_command_fn (vlib_main_t * vm,
403 unformat_input_t * input,
404 vlib_cli_command_t * cmd)
406 lisp_gpe_main_t *lgm = &lisp_gpe_main;
407 fib_route_path_t *rpath;
409 if (vec_len (lgm->native_fwd_rpath[IP4]))
411 vec_foreach (rpath, lgm->native_fwd_rpath[IP4])
413 vlib_cli_output (vm, "nh: %U fib_index %u sw_if_index %u",
414 format_ip46_address, &rpath->frp_addr,
415 IP46_TYPE_IP4, rpath->frp_fib_index,
416 rpath->frp_sw_if_index);
419 if (vec_len (lgm->native_fwd_rpath[IP6]))
421 vec_foreach (rpath, lgm->native_fwd_rpath[IP6])
423 vlib_cli_output (vm, "nh: %U fib_index %u sw_if_index %u",
424 format_ip46_address, &rpath->frp_addr, IP46_TYPE_IP6,
425 rpath->frp_fib_index, rpath->frp_sw_if_index);
432 VLIB_CLI_COMMAND (gpe_show_native_fwd_rpath_command) = {
433 .path = "show gpe native-forward",
434 .short_help = "show gpe native-forward",
435 .function = gpe_show_native_fwd_rpath_command_fn,
440 gpe_update_native_fwd_path (u8 ip_version)
442 lisp_gpe_main_t *lgm = vnet_lisp_gpe_get_main ();
443 lisp_gpe_fwd_entry_t *lfe;
444 fib_prefix_t fib_prefix;
447 vec_foreach (lfei, lgm->native_fwd_lfes[ip_version])
449 lfe = pool_elt_at_index (lgm->lisp_fwd_entry_pool, lfei[0]);
450 ip_prefix_to_fib_prefix (&lfe->key->rmt.ippref, &fib_prefix);
451 fib_table_entry_update (lfe->eid_fib_index, &fib_prefix, FIB_SOURCE_LISP,
453 lgm->native_fwd_rpath[ip_version]);
458 vnet_gpe_add_del_native_fwd_rpath (vnet_gpe_native_fwd_rpath_args_t * a)
460 lisp_gpe_main_t *lgm = vnet_lisp_gpe_get_main ();
461 fib_route_path_t *rpath;
464 ip_version = a->rpath.frp_proto == DPO_PROTO_IP4 ? IP4 : IP6;
468 vec_add1 (lgm->native_fwd_rpath[ip_version], a->rpath);
472 vec_foreach (rpath, lgm->native_fwd_rpath[ip_version])
474 if (!fib_route_path_cmp (rpath, &a->rpath))
476 vec_del1 (lgm->native_fwd_rpath[ip_version],
477 rpath - lgm->native_fwd_rpath[ip_version]);
482 gpe_update_native_fwd_path (ip_version);
487 * CLI command to add action for native forward.
489 static clib_error_t *
490 gpe_native_forward_command_fn (vlib_main_t * vm, unformat_input_t * input,
491 vlib_cli_command_t * cmd)
493 vnet_main_t *vnm = vnet_get_main ();
494 unformat_input_t _line_input, *line_input = &_line_input;
496 fib_route_path_t rpath;
498 vnet_gpe_native_fwd_rpath_args_t _a, *a = &_a;
500 clib_error_t *error = 0;
502 /* Get a line of input. */
503 if (!unformat_user (input, unformat_line_input, line_input))
506 clib_memset (&rpath, 0, sizeof (rpath));
508 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
510 if (unformat (line_input, "table %d", &table_id))
512 else if (unformat (line_input, "del"))
514 else if (unformat (line_input, "via %U %U",
515 unformat_ip4_address,
517 unformat_vnet_sw_interface, vnm,
518 &rpath.frp_sw_if_index))
520 rpath.frp_weight = 1;
521 rpath.frp_proto = DPO_PROTO_IP4;
523 else if (unformat (line_input, "via %U %U",
524 unformat_ip6_address,
526 unformat_vnet_sw_interface, vnm,
527 &rpath.frp_sw_if_index))
529 rpath.frp_weight = 1;
530 rpath.frp_proto = DPO_PROTO_IP6;
532 else if (unformat (line_input, "via %U",
533 unformat_ip4_address, &rpath.frp_addr.ip4))
535 rpath.frp_weight = 1;
536 rpath.frp_sw_if_index = ~0;
537 rpath.frp_proto = DPO_PROTO_IP4;
539 else if (unformat (line_input, "via %U",
540 unformat_ip6_address, &rpath.frp_addr.ip6))
542 rpath.frp_weight = 1;
543 rpath.frp_sw_if_index = ~0;
544 rpath.frp_proto = DPO_PROTO_IP6;
548 return clib_error_return (0, "parse error: '%U'",
549 format_unformat_error, line_input);
553 if ((u32) ~ 0 == table_id)
555 rpath.frp_fib_index = 0;
559 rpath.frp_fib_index =
560 fib_table_find (dpo_proto_to_fib (rpath.frp_proto), table_id);
561 if ((u32) ~ 0 == rpath.frp_fib_index)
563 error = clib_error_return (0, "Nonexistent table id %d", table_id);
571 rv = vnet_gpe_add_del_native_fwd_rpath (a);
574 return clib_error_return (0, "Error: couldn't add path!");
582 VLIB_CLI_COMMAND (gpe_native_forward_command) = {
583 .path = "gpe native-forward",
584 .short_help = "gpe native-forward [del] via <nh-ip-addr> [iface] "
586 .function = gpe_native_forward_command_fn,
590 /** Format LISP-GPE status. */
592 format_vnet_lisp_gpe_status (u8 * s, va_list * args)
594 lisp_gpe_main_t *lgm = &lisp_gpe_main;
595 return format (s, "%s", lgm->is_en ? "enabled" : "disabled");
598 /** LISP-GPE init function. */
600 lisp_gpe_init (vlib_main_t * vm)
602 lisp_gpe_main_t *lgm = &lisp_gpe_main;
603 clib_error_t *error = 0;
605 if ((error = vlib_call_init_function (vm, ip_main_init)))
608 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
611 lgm->vnet_main = vnet_get_main ();
613 lgm->im4 = &ip4_main;
614 lgm->im6 = &ip6_main;
615 lgm->lm4 = &ip4_main.lookup_main;
616 lgm->lm6 = &ip6_main.lookup_main;
617 lgm->encap_mode = GPE_ENCAP_LISP;
619 lgm->lisp_gpe_fwd_entries =
620 hash_create_mem (0, sizeof (lisp_gpe_fwd_entry_key_t), sizeof (uword));
622 lgm->lisp_stats_index_by_key =
623 hash_create_mem (0, sizeof (lisp_stats_key_t), sizeof (uword));
624 clib_memset (&lgm->counters, 0, sizeof (lgm->counters));
625 lgm->counters.name = "LISP counters";
631 vnet_gpe_get_encap_mode (void)
633 lisp_gpe_main_t *lgm = &lisp_gpe_main;
634 return lgm->encap_mode;
637 static clib_error_t *
638 lisp_gpe_test_send_nsh_packet (u8 * file_name)
642 lisp_gpe_main_t *lgm = vnet_lisp_gpe_get_main ();
644 clib_error_t *error = 0;
647 return clib_error_create ("no pcap file specified!");
649 clib_memset (&pm, 0, sizeof (pm));
650 pm.file_name = (char *) file_name;
651 error = pcap_read (&pm);
656 if (vlib_buffer_alloc (lgm->vlib_main, &bi, 1) != 1)
657 return clib_error_create ("cannot allocate memory!");
659 b = vlib_get_buffer (lgm->vlib_main, bi);
660 tunnel_lookup_t *nsh_ifaces = &lgm->nsh_ifaces;
662 vnet_hw_interface_t *hi;
664 hip = hash_get (nsh_ifaces->hw_if_index_by_dp_table, 0);
666 return clib_error_create ("The NSH 0 interface doesn't exist");
668 hi = vnet_get_hw_interface (lgm->vnet_main, hip[0]);
670 vnet_buffer (b)->sw_if_index[VLIB_TX] = hi->sw_if_index;
671 u8 *p = vlib_buffer_put_uninit (b, vec_len (pm.packets_read[0]));
672 clib_memcpy_fast (p, pm.packets_read[0], vec_len (pm.packets_read[0]));
673 vlib_buffer_pull (b, sizeof (ethernet_header_t));
675 vlib_node_t *n = vlib_get_node_by_name (lgm->vlib_main,
676 (u8 *) "interface-tx");
677 f = vlib_get_frame_to_node (lgm->vlib_main, n->index);
678 u32 *to_next = vlib_frame_vector_args (f);
681 vlib_put_frame_to_node (lgm->vlib_main, n->index, f);
686 static clib_error_t *
687 lisp_test_nsh_command_fn (vlib_main_t * vm, unformat_input_t * input,
688 vlib_cli_command_t * cmd)
690 clib_error_t *error = 0;
693 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
695 if (unformat (input, "pcap %v", &file_name))
697 error = lisp_gpe_test_send_nsh_packet (file_name);
702 error = clib_error_create ("unknown input `%U'",
703 format_unformat_error, input);
713 VLIB_CLI_COMMAND (lisp_test_nsh_command, static) = {
714 .path = "test one nsh",
715 .short_help = "test gpe nsh pcap <path-to-pcap-file>",
716 .function = lisp_test_nsh_command_fn,
720 VLIB_INIT_FUNCTION (lisp_gpe_init);
723 * fd.io coding-style-patch-verification: ON
726 * eval: (c-set-style "gnu")