3 * Copyright (C) 2018 Cumulus Networks, Inc.
6 * FRR is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * FRR is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
27 #include "nexthop_group.h"
32 #include "pbrd/pbr_nht.h"
33 #include "pbrd/pbr_map.h"
34 #include "pbrd/pbr_zebra.h"
35 #include "pbrd/pbr_vty.h"
36 #include "pbrd/pbr_debug.h"
37 #ifndef VTYSH_EXTRACT_PL
38 #include "pbrd/pbr_vty_clippy.c"
41 DEFUN_NOSH(pbr_map
, pbr_map_cmd
, "pbr-map WORD seq (1-1000)",
42 "Create pbr-map or enter pbr-map command mode\n"
43 "The name of the PBR MAP\n"
44 "Sequence to insert in existing pbr-map entry\n"
47 const char *pbrm_name
= argv
[1]->arg
;
48 uint32_t seqno
= atoi(argv
[3]->arg
);
49 struct pbr_map_sequence
*pbrms
;
51 pbrms
= pbrms_get(pbrm_name
, seqno
);
52 VTY_PUSH_CONTEXT(PBRMAP_NODE
, pbrms
);
57 DEFUN_NOSH(no_pbr_map
, no_pbr_map_cmd
, "no pbr-map WORD [seq (1-65535)]",
60 "The name of the PBR MAP\n"
61 "Sequence to delete from existing pbr-map entry\n"
64 const char *pbrm_name
= argv
[2]->arg
;
66 struct pbr_map
*pbrm
= pbrm_find(pbrm_name
);
67 struct pbr_map_sequence
*pbrms
;
68 struct listnode
*node
, *next_node
;
71 seqno
= atoi(argv
[4]->arg
);
74 vty_out(vty
, "pbr-map %s not found\n", pbrm_name
);
78 for (ALL_LIST_ELEMENTS(pbrm
->seqnumbers
, node
, next_node
, pbrms
)) {
79 if (seqno
&& pbrms
->seqno
!= seqno
)
82 pbr_map_delete(pbrms
);
88 DEFPY(pbr_map_match_src
, pbr_map_match_src_cmd
,
89 "[no] match src-ip <A.B.C.D/M|X:X::X:X/M>$prefix",
91 "Match the rest of the command\n"
92 "Choose the src ip or ipv6 prefix to use\n"
96 struct pbr_map_sequence
*pbrms
= VTY_GET_CONTEXT(pbr_map_sequence
);
98 pbrms
->family
= prefix
->family
;
101 if (prefix_same(pbrms
->src
, prefix
))
105 pbrms
->src
= prefix_new();
106 prefix_copy(pbrms
->src
, prefix
);
108 prefix_free(pbrms
->src
);
112 pbr_map_check(pbrms
);
117 DEFPY(pbr_map_match_dst
, pbr_map_match_dst_cmd
,
118 "[no] match dst-ip <A.B.C.D/M|X:X::X:X/M>$prefix",
120 "Match the rest of the command\n"
121 "Choose the src ip or ipv6 prefix to use\n"
125 struct pbr_map_sequence
*pbrms
= VTY_GET_CONTEXT(pbr_map_sequence
);
127 pbrms
->family
= prefix
->family
;
130 if (prefix_same(pbrms
->dst
, prefix
))
134 pbrms
->dst
= prefix_new();
135 prefix_copy(pbrms
->dst
, prefix
);
137 prefix_free(pbrms
->dst
);
141 pbr_map_check(pbrms
);
146 DEFPY(pbr_map_nexthop_group
, pbr_map_nexthop_group_cmd
,
147 "[no] set nexthop-group NAME$name",
149 "Set for the PBR-MAP\n"
150 "nexthop-group to use\n"
151 "The name of the nexthop-group\n")
153 struct pbr_map_sequence
*pbrms
= VTY_GET_CONTEXT(pbr_map_sequence
);
154 struct nexthop_group_cmd
*nhgc
;
158 "A `set nexthop XX` command already exists, please remove that first\n");
159 return CMD_WARNING_CONFIG_FAILED
;
162 nhgc
= nhgc_find(name
);
164 vty_out(vty
, "Specified nexthop-group %s does not exist\n",
166 vty_out(vty
, "PBR-MAP will not be applied until it is created\n");
170 if (pbrms
->nhgrp_name
&& strcmp(name
, pbrms
->nhgrp_name
) == 0)
171 pbr_map_delete_nexthop_group(pbrms
);
174 "Nexthop Group specified: %s does not exist to remove",
176 return CMD_WARNING_CONFIG_FAILED
;
179 if (pbrms
->nhgrp_name
) {
180 if (strcmp(name
, pbrms
->nhgrp_name
) != 0) {
182 "Please delete current nexthop group before modifying current one");
183 return CMD_WARNING_CONFIG_FAILED
;
188 pbrms
->nhgrp_name
= XSTRDUP(MTYPE_TMP
, name
);
189 pbr_map_check(pbrms
);
195 DEFPY(pbr_map_nexthop
, pbr_map_nexthop_cmd
,
196 "[no] set nexthop <A.B.C.D|X:X::X:X>$addr [INTERFACE]$intf [nexthop-vrf NAME$name]",
198 "Set for the PBR-MAP\n"
199 "Specify one of the nexthops in this map\n"
203 "If the nexthop is in a different vrf tell us\n"
204 "The nexthop-vrf Name\n")
206 struct pbr_map_sequence
*pbrms
= VTY_GET_CONTEXT(pbr_map_sequence
);
211 if (pbrms
->nhgrp_name
) {
213 "Please unconfigure the nexthop group before adding an individual nexthop");
214 return CMD_WARNING_CONFIG_FAILED
;
218 vrf
= vrf_lookup_by_name(name
);
220 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
223 vty_out(vty
, "Specified: %s is non-existent\n", name
);
224 return CMD_WARNING_CONFIG_FAILED
;
227 memset(&nhop
, 0, sizeof(nhop
));
228 nhop
.vrf_id
= vrf
->vrf_id
;
230 if (addr
->sa
.sa_family
== AF_INET
) {
231 nhop
.gate
.ipv4
.s_addr
= addr
->sin
.sin_addr
.s_addr
;
233 nhop
.type
= NEXTHOP_TYPE_IPV4_IFINDEX
;
234 nhop
.ifindex
= ifname2ifindex(intf
, vrf
->vrf_id
);
235 if (nhop
.ifindex
== IFINDEX_INTERNAL
) {
237 "Specified Intf %s does not exist in vrf: %s\n",
239 return CMD_WARNING_CONFIG_FAILED
;
242 nhop
.type
= NEXTHOP_TYPE_IPV4
;
244 memcpy(&nhop
.gate
.ipv6
, &addr
->sin6
.sin6_addr
, 16);
246 nhop
.type
= NEXTHOP_TYPE_IPV6_IFINDEX
;
247 nhop
.ifindex
= ifname2ifindex(intf
, vrf
->vrf_id
);
248 if (nhop
.ifindex
== IFINDEX_INTERNAL
) {
250 "Specified Intf %s does not exist in vrf: %s\n",
252 return CMD_WARNING_CONFIG_FAILED
;
255 if (IN6_IS_ADDR_LINKLOCAL(&nhop
.gate
.ipv6
)) {
257 "Specified a v6 LL with no interface, rejecting\n");
258 return CMD_WARNING_CONFIG_FAILED
;
260 nhop
.type
= NEXTHOP_TYPE_IPV6
;
265 nh
= nexthop_exists(pbrms
->nhg
, &nhop
);
270 vty_out(vty
, "No nexthops to delete");
271 return CMD_WARNING_CONFIG_FAILED
;
274 pbrms
->nhg
= nexthop_group_new();
275 pbrms
->internal_nhg_name
=
277 pbr_nht_nexthop_make_name(pbrms
->parent
->name
,
286 pbr_nht_delete_individual_nexthop(pbrms
);
289 if (pbrms
->nhg
->nexthop
) {
291 "If you would like more than one nexthop please use nexthop-groups");
292 return CMD_WARNING_CONFIG_FAILED
;
295 /* must be adding new nexthop since !no and !nexthop_exists */
298 memcpy(nh
, &nhop
, sizeof(nhop
));
299 nexthop_add(&pbrms
->nhg
->nexthop
, nh
);
301 pbr_nht_add_individual_nexthop(pbrms
);
302 pbr_map_check(pbrms
);
310 "[no] pbr-policy NAME$mapname",
313 "Name of the pbr-map to apply\n")
315 VTY_DECLVAR_CONTEXT(interface
, ifp
);
316 struct pbr_map
*pbrm
, *old_pbrm
;
317 struct pbr_interface
*pbr_ifp
= ifp
->info
;
319 pbrm
= pbrm_find(mapname
);
322 /* we don't want one and we don't have one, so... */
326 /* Some one could have fat fingered the interface name */
327 pbr_ifp
= pbr_if_new(ifp
);
331 if (strcmp(pbr_ifp
->mapname
, mapname
) == 0) {
332 pbr_ifp
->mapname
[0] = '\0';
334 pbr_map_interface_delete(pbrm
, ifp
);
337 if (strcmp(pbr_ifp
->mapname
, "") != 0) {
338 old_pbrm
= pbrm_find(pbr_ifp
->mapname
);
340 pbr_map_interface_delete(old_pbrm
, ifp
);
342 snprintf(pbr_ifp
->mapname
, sizeof(pbr_ifp
->mapname
),
345 pbr_map_add_interface(pbrm
, ifp
);
353 "show pbr [json$json]",
355 "Policy Based Routing\n"
358 pbr_nht_write_table_range(vty
);
359 pbr_nht_write_rule_range(vty
);
366 "show pbr map [NAME$name] [detail$detail] [json$json]",
368 "Policy Based Routing\n"
371 "Detailed information\n"
374 struct pbr_map_sequence
*pbrms
;
375 struct pbr_map
*pbrm
;
376 struct listnode
*node
;
377 char buf
[PREFIX_STRLEN
];
380 RB_FOREACH (pbrm
, pbr_map_entry_head
, &pbr_maps
) {
381 if (name
&& strcmp(name
, pbrm
->name
) != 0)
384 vty_out(vty
, " pbr-map %s valid: %d\n", pbrm
->name
,
387 for (ALL_LIST_ELEMENTS_RO(pbrm
->seqnumbers
, node
, pbrms
)) {
389 pbr_map_reason_string(pbrms
->reason
, rbuf
,
392 " Seq: %u rule: %u Installed: %" PRIu64
"(%u) Reason: %s\n",
393 pbrms
->seqno
, pbrms
->ruleno
, pbrms
->installed
,
394 pbrms
->unique
, pbrms
->reason
? rbuf
: "Valid");
397 vty_out(vty
, "\tSRC Match: %s\n",
398 prefix2str(pbrms
->src
, buf
,
401 vty_out(vty
, "\tDST Match: %s\n",
402 prefix2str(pbrms
->dst
, buf
,
405 if (pbrms
->nhgrp_name
) {
407 "\tNexthop-Group: %s(%u) Installed: %u(%d)\n",
409 pbr_nht_get_table(pbrms
->nhgrp_name
),
410 pbrms
->nhs_installed
,
411 pbr_nht_get_installed(
413 } else if (pbrms
->nhg
) {
415 nexthop_group_write_nexthop(
416 vty
, pbrms
->nhg
->nexthop
);
418 "\tInstalled: %u(%d) Tableid: %d\n",
419 pbrms
->nhs_installed
,
420 pbr_nht_get_installed(
421 pbrms
->internal_nhg_name
),
423 pbrms
->internal_nhg_name
));
426 "\tNexthop-Group: Unknown Installed: 0(0)\n");
433 DEFPY(show_pbr_nexthop_group
,
434 show_pbr_nexthop_group_cmd
,
435 "show pbr nexthop-groups [WORD$word]",
437 "Policy Based Routing\n"
439 "Optional Name of the nexthop group\n")
441 pbr_nht_show_nexthop_group(vty
, word
);
446 DEFPY (show_pbr_interface
,
447 show_pbr_interface_cmd
,
448 "show pbr interface [NAME$name] [json$json]",
450 "Policy Based Routing\n"
452 "PBR Interface Name\n"
455 struct interface
*ifp
;
457 struct pbr_interface
*pbr_ifp
;
459 RB_FOREACH(vrf
, vrf_name_head
, &vrfs_by_name
) {
460 FOR_ALL_INTERFACES(vrf
, ifp
) {
461 struct pbr_map
*pbrm
;
466 if (name
&& strcmp(ifp
->name
, name
) != 0)
471 if (strcmp(pbr_ifp
->mapname
, "") == 0)
474 pbrm
= pbrm_find(pbr_ifp
->mapname
);
475 vty_out(vty
, " %s(%d) with pbr-policy %s", ifp
->name
,
476 ifp
->ifindex
, pbr_ifp
->mapname
);
478 vty_out(vty
, " (map doesn't exist)");
486 /* PBR debugging CLI ------------------------------------------------------- */
487 /* clang-format off */
489 static struct cmd_node debug_node
= {DEBUG_NODE
, "", 1};
493 "[no] debug pbr [{map$map|zebra$zebra|nht$nht|events$events}]",
496 "Policy Based Routing\n"
498 "PBRD <-> Zebra communications\n"
502 uint32_t mode
= DEBUG_NODE2MODE(vty
->node
);
505 DEBUG_MODE_SET(&pbr_dbg_map
, mode
, !no
);
507 DEBUG_MODE_SET(&pbr_dbg_zebra
, mode
, !no
);
509 DEBUG_MODE_SET(&pbr_dbg_nht
, mode
, !no
);
511 DEBUG_MODE_SET(&pbr_dbg_event
, mode
, !no
);
513 /* no specific debug --> act on all of them */
514 if (strmatch(argv
[argc
- 1]->text
, "pbr"))
515 pbr_debug_set_all(mode
, !no
);
520 DEFUN_NOSH(show_debugging_pbr
,
521 show_debugging_pbr_cmd
,
522 "show debugging [pbr]",
525 "Policy Based Routing\n")
527 vty_out(vty
, "PBR debugging status:\n");
529 pbr_debug_config_write_helper(vty
, false);
534 /* clang-format on */
535 /* ------------------------------------------------------------------------- */
538 static struct cmd_node interface_node
= {
539 INTERFACE_NODE
, "%s(config-if)# ", 1 /* vtysh ? yes */
542 static int pbr_interface_config_write(struct vty
*vty
)
544 struct interface
*ifp
;
547 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
548 FOR_ALL_INTERFACES (vrf
, ifp
) {
549 if (vrf
->vrf_id
== VRF_DEFAULT
)
550 vty_frame(vty
, "interface %s\n", ifp
->name
);
552 vty_frame(vty
, "interface %s vrf %s\n",
553 ifp
->name
, vrf
->name
);
555 pbr_map_write_interfaces(vty
, ifp
);
557 vty_endframe(vty
, "!\n");
564 /* PBR map node structure. */
565 static struct cmd_node pbr_map_node
= {PBRMAP_NODE
, "%s(config-pbr-map)# ", 1};
567 static int pbr_vty_map_config_write_sequence(struct vty
*vty
,
568 struct pbr_map
*pbrm
,
569 struct pbr_map_sequence
*pbrms
)
571 char buff
[PREFIX_STRLEN
];
573 vty_out(vty
, "pbr-map %s seq %u\n", pbrm
->name
, pbrms
->seqno
);
576 vty_out(vty
, " match src-ip %s\n",
577 prefix2str(pbrms
->src
, buff
, sizeof(buff
)));
580 vty_out(vty
, " match dst-ip %s\n",
581 prefix2str(pbrms
->dst
, buff
, sizeof(buff
)));
583 if (pbrms
->nhgrp_name
)
584 vty_out(vty
, " set nexthop-group %s\n", pbrms
->nhgrp_name
);
587 vty_out(vty
, " set ");
588 nexthop_group_write_nexthop(vty
, pbrms
->nhg
->nexthop
);
595 static int pbr_vty_map_config_write(struct vty
*vty
)
597 struct pbr_map
*pbrm
;
599 pbr_nht_write_table_range(vty
);
600 pbr_nht_write_rule_range(vty
);
602 RB_FOREACH(pbrm
, pbr_map_entry_head
, &pbr_maps
) {
603 struct pbr_map_sequence
*pbrms
;
604 struct listnode
*node
;
606 for (ALL_LIST_ELEMENTS_RO(pbrm
->seqnumbers
, node
, pbrms
))
607 pbr_vty_map_config_write_sequence(vty
, pbrm
, pbrms
);
613 void pbr_vty_init(void)
615 install_node(&interface_node
,
616 pbr_interface_config_write
);
619 install_node(&pbr_map_node
,
620 pbr_vty_map_config_write
);
623 install_node(&debug_node
, pbr_debug_config_write
);
624 install_element(VIEW_NODE
, &debug_pbr_cmd
);
625 install_element(CONFIG_NODE
, &debug_pbr_cmd
);
626 install_element(VIEW_NODE
, &show_debugging_pbr_cmd
);
628 install_default(PBRMAP_NODE
);
630 install_element(CONFIG_NODE
, &pbr_map_cmd
);
631 install_element(CONFIG_NODE
, &no_pbr_map_cmd
);
632 install_element(INTERFACE_NODE
, &pbr_policy_cmd
);
633 install_element(PBRMAP_NODE
, &pbr_map_match_src_cmd
);
634 install_element(PBRMAP_NODE
, &pbr_map_match_dst_cmd
);
635 install_element(PBRMAP_NODE
, &pbr_map_nexthop_group_cmd
);
636 install_element(PBRMAP_NODE
, &pbr_map_nexthop_cmd
);
637 install_element(VIEW_NODE
, &show_pbr_cmd
);
638 install_element(VIEW_NODE
, &show_pbr_map_cmd
);
639 install_element(VIEW_NODE
, &show_pbr_interface_cmd
);
640 install_element(VIEW_NODE
, &show_pbr_nexthop_group_cmd
);