]> git.proxmox.com Git - mirror_frr.git/blob - pbrd/pbr_vty.c
Merge pull request #2072 from donaldsharp/blackhole_this
[mirror_frr.git] / pbrd / pbr_vty.c
1 /*
2 * PBR - vty code
3 * Copyright (C) 2018 Cumulus Networks, Inc.
4 * Donald Sharp
5 *
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
9 * later version.
10 *
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.
15 *
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
19 */
20 #include <zebra.h>
21
22 #include "vty.h"
23 #include "command.h"
24 #include "prefix.h"
25 #include "vrf.h"
26 #include "nexthop.h"
27 #include "nexthop_group.h"
28 #include "log.h"
29 #include "json.h"
30 #include "debug.h"
31
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"
39 #endif
40
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"
45 "Sequence number\n")
46 {
47 const char *pbrm_name = argv[1]->arg;
48 uint32_t seqno = atoi(argv[3]->arg);
49 struct pbr_map_sequence *pbrms;
50
51 pbrms = pbrms_get(pbrm_name, seqno);
52 VTY_PUSH_CONTEXT(PBRMAP_NODE, pbrms);
53
54 return CMD_SUCCESS;
55 }
56
57 DEFUN_NOSH(no_pbr_map, no_pbr_map_cmd, "no pbr-map WORD [seq (1-65535)]",
58 NO_STR
59 "Delete pbr-map\n"
60 "The name of the PBR MAP\n"
61 "Sequence to delete from existing pbr-map entry\n"
62 "Sequence number\n")
63 {
64 const char *pbrm_name = argv[2]->arg;
65 uint32_t seqno = 0;
66 struct pbr_map *pbrm = pbrm_find(pbrm_name);
67 struct pbr_map_sequence *pbrms;
68 struct listnode *node, *next_node;
69
70 if (argc > 3)
71 seqno = atoi(argv[4]->arg);
72
73 if (!pbrm) {
74 vty_out(vty, "pbr-map %s not found\n", pbrm_name);
75 return CMD_SUCCESS;
76 }
77
78 for (ALL_LIST_ELEMENTS(pbrm->seqnumbers, node, next_node, pbrms)) {
79 if (seqno && pbrms->seqno != seqno)
80 continue;
81
82 pbr_map_delete(pbrms);
83 }
84
85 return CMD_SUCCESS;
86 }
87
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",
90 NO_STR
91 "Match the rest of the command\n"
92 "Choose the src ip or ipv6 prefix to use\n"
93 "v4 Prefix\n"
94 "v6 Prefix\n")
95 {
96 struct pbr_map_sequence *pbrms = VTY_GET_CONTEXT(pbr_map_sequence);
97
98 pbrms->family = prefix->family;
99
100 if (!no) {
101 if (prefix_same(pbrms->src, prefix))
102 return CMD_SUCCESS;
103
104 if (!pbrms->src)
105 pbrms->src = prefix_new();
106 prefix_copy(pbrms->src, prefix);
107 } else {
108 prefix_free(pbrms->src);
109 pbrms->src = 0;
110 }
111
112 pbr_map_check(pbrms);
113
114 return CMD_SUCCESS;
115 }
116
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",
119 NO_STR
120 "Match the rest of the command\n"
121 "Choose the src ip or ipv6 prefix to use\n"
122 "v4 Prefix\n"
123 "v6 Prefix\n")
124 {
125 struct pbr_map_sequence *pbrms = VTY_GET_CONTEXT(pbr_map_sequence);
126
127 pbrms->family = prefix->family;
128
129 if (!no) {
130 if (prefix_same(pbrms->dst, prefix))
131 return CMD_SUCCESS;
132
133 if (!pbrms->dst)
134 pbrms->dst = prefix_new();
135 prefix_copy(pbrms->dst, prefix);
136 } else {
137 prefix_free(pbrms->dst);
138 pbrms->dst = NULL;
139 }
140
141 pbr_map_check(pbrms);
142
143 return CMD_SUCCESS;
144 }
145
146 DEFPY(pbr_map_nexthop_group, pbr_map_nexthop_group_cmd,
147 "[no] set nexthop-group NAME$name",
148 NO_STR
149 "Set for the PBR-MAP\n"
150 "nexthop-group to use\n"
151 "The name of the nexthop-group\n")
152 {
153 struct pbr_map_sequence *pbrms = VTY_GET_CONTEXT(pbr_map_sequence);
154 struct nexthop_group_cmd *nhgc;
155
156 if (pbrms->nhg) {
157 vty_out(vty,
158 "A `set nexthop XX` command already exists, please remove that first\n");
159 return CMD_WARNING_CONFIG_FAILED;
160 }
161
162 nhgc = nhgc_find(name);
163 if (!nhgc) {
164 vty_out(vty, "Specified nexthop-group %s does not exist\n",
165 name);
166 vty_out(vty, "PBR-MAP will not be applied until it is created\n");
167 }
168
169 if (no) {
170 if (pbrms->nhgrp_name && strcmp(name, pbrms->nhgrp_name) == 0)
171 pbr_map_delete_nexthop_group(pbrms);
172 else {
173 vty_out(vty,
174 "Nexthop Group specified: %s does not exist to remove",
175 name);
176 return CMD_WARNING_CONFIG_FAILED;
177 }
178 } else {
179 if (pbrms->nhgrp_name) {
180 if (strcmp(name, pbrms->nhgrp_name) != 0) {
181 vty_out(vty,
182 "Please delete current nexthop group before modifying current one");
183 return CMD_WARNING_CONFIG_FAILED;
184 }
185
186 return CMD_SUCCESS;
187 }
188 pbrms->nhgrp_name = XSTRDUP(MTYPE_TMP, name);
189 pbr_map_check(pbrms);
190 }
191
192 return CMD_SUCCESS;
193 }
194
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]",
197 NO_STR
198 "Set for the PBR-MAP\n"
199 "Specify one of the nexthops in this map\n"
200 "v4 Address\n"
201 "v6 Address\n"
202 "Interface to use\n"
203 "If the nexthop is in a different vrf tell us\n"
204 "The nexthop-vrf Name\n")
205 {
206 struct pbr_map_sequence *pbrms = VTY_GET_CONTEXT(pbr_map_sequence);
207 struct vrf *vrf;
208 struct nexthop nhop;
209 struct nexthop *nh;
210
211 if (pbrms->nhgrp_name) {
212 vty_out(vty,
213 "Please unconfigure the nexthop group before adding an individual nexthop");
214 return CMD_WARNING_CONFIG_FAILED;
215 }
216
217 if (name)
218 vrf = vrf_lookup_by_name(name);
219 else
220 vrf = vrf_lookup_by_id(VRF_DEFAULT);
221
222 if (!vrf) {
223 vty_out(vty, "Specified: %s is non-existent\n", name);
224 return CMD_WARNING_CONFIG_FAILED;
225 }
226
227 memset(&nhop, 0, sizeof(nhop));
228 nhop.vrf_id = vrf->vrf_id;
229
230 if (addr->sa.sa_family == AF_INET) {
231 nhop.gate.ipv4.s_addr = addr->sin.sin_addr.s_addr;
232 if (intf) {
233 nhop.type = NEXTHOP_TYPE_IPV4_IFINDEX;
234 nhop.ifindex = ifname2ifindex(intf, vrf->vrf_id);
235 if (nhop.ifindex == IFINDEX_INTERNAL) {
236 vty_out(vty,
237 "Specified Intf %s does not exist in vrf: %s\n",
238 intf, vrf->name);
239 return CMD_WARNING_CONFIG_FAILED;
240 }
241 } else
242 nhop.type = NEXTHOP_TYPE_IPV4;
243 } else {
244 memcpy(&nhop.gate.ipv6, &addr->sin6.sin6_addr, 16);
245 if (intf) {
246 nhop.type = NEXTHOP_TYPE_IPV6_IFINDEX;
247 nhop.ifindex = ifname2ifindex(intf, vrf->vrf_id);
248 if (nhop.ifindex == IFINDEX_INTERNAL) {
249 vty_out(vty,
250 "Specified Intf %s does not exist in vrf: %s\n",
251 intf, vrf->name);
252 return CMD_WARNING_CONFIG_FAILED;
253 }
254 } else {
255 if (IN6_IS_ADDR_LINKLOCAL(&nhop.gate.ipv6)) {
256 vty_out(vty,
257 "Specified a v6 LL with no interface, rejecting\n");
258 return CMD_WARNING_CONFIG_FAILED;
259 }
260 nhop.type = NEXTHOP_TYPE_IPV6;
261 }
262 }
263
264 if (pbrms->nhg)
265 nh = nexthop_exists(pbrms->nhg, &nhop);
266 else {
267 char buf[100];
268
269 if (no) {
270 vty_out(vty, "No nexthops to delete");
271 return CMD_WARNING_CONFIG_FAILED;
272 }
273
274 pbrms->nhg = nexthop_group_new();
275 pbrms->internal_nhg_name =
276 XSTRDUP(MTYPE_TMP,
277 pbr_nht_nexthop_make_name(pbrms->parent->name,
278 PBR_MAP_NAMELEN,
279 pbrms->seqno,
280 buf));
281 nh = NULL;
282 }
283
284 if (no) {
285 if (nh)
286 pbr_nht_delete_individual_nexthop(pbrms);
287 } else if (!nh) {
288
289 if (pbrms->nhg->nexthop) {
290 vty_out(vty,
291 "If you would like more than one nexthop please use nexthop-groups");
292 return CMD_WARNING_CONFIG_FAILED;
293 }
294
295 /* must be adding new nexthop since !no and !nexthop_exists */
296 nh = nexthop_new();
297
298 memcpy(nh, &nhop, sizeof(nhop));
299 nexthop_add(&pbrms->nhg->nexthop, nh);
300
301 pbr_nht_add_individual_nexthop(pbrms);
302 pbr_map_check(pbrms);
303 }
304
305 return CMD_SUCCESS;
306 }
307
308 DEFPY (pbr_policy,
309 pbr_policy_cmd,
310 "[no] pbr-policy NAME$mapname",
311 NO_STR
312 "Policy to use\n"
313 "Name of the pbr-map to apply\n")
314 {
315 VTY_DECLVAR_CONTEXT(interface, ifp);
316 struct pbr_map *pbrm, *old_pbrm;
317 struct pbr_interface *pbr_ifp = ifp->info;
318
319 pbrm = pbrm_find(mapname);
320
321 if (!pbr_ifp) {
322 /* we don't want one and we don't have one, so... */
323 if (no)
324 return CMD_SUCCESS;
325
326 /* Some one could have fat fingered the interface name */
327 pbr_ifp = pbr_if_new(ifp);
328 }
329
330 if (no) {
331 if (strcmp(pbr_ifp->mapname, mapname) == 0) {
332 pbr_ifp->mapname[0] = '\0';
333 if (pbrm)
334 pbr_map_interface_delete(pbrm, ifp);
335 }
336 } else {
337 if (strcmp(pbr_ifp->mapname, "") != 0) {
338 old_pbrm = pbrm_find(pbr_ifp->mapname);
339 if (old_pbrm)
340 pbr_map_interface_delete(old_pbrm, ifp);
341 }
342 snprintf(pbr_ifp->mapname, sizeof(pbr_ifp->mapname),
343 "%s", mapname);
344 if (pbrm)
345 pbr_map_add_interface(pbrm, ifp);
346 }
347
348 return CMD_SUCCESS;
349 }
350
351 DEFPY (show_pbr,
352 show_pbr_cmd,
353 "show pbr [json$json]",
354 SHOW_STR
355 "Policy Based Routing\n"
356 JSON_STR)
357 {
358 pbr_nht_write_table_range(vty);
359 pbr_nht_write_rule_range(vty);
360
361 return CMD_SUCCESS;
362 }
363
364 DEFPY (show_pbr_map,
365 show_pbr_map_cmd,
366 "show pbr map [NAME$name] [detail$detail] [json$json]",
367 SHOW_STR
368 "Policy Based Routing\n"
369 "PBR Map\n"
370 "PBR Map Name\n"
371 "Detailed information\n"
372 JSON_STR)
373 {
374 struct pbr_map_sequence *pbrms;
375 struct pbr_map *pbrm;
376 struct listnode *node;
377 char buf[PREFIX_STRLEN];
378 char rbuf[64];
379
380 RB_FOREACH (pbrm, pbr_map_entry_head, &pbr_maps) {
381 if (name && strcmp(name, pbrm->name) != 0)
382 continue;
383
384 vty_out(vty, " pbr-map %s valid: %d\n", pbrm->name,
385 pbrm->valid);
386
387 for (ALL_LIST_ELEMENTS_RO(pbrm->seqnumbers, node, pbrms)) {
388 if (pbrms->reason)
389 pbr_map_reason_string(pbrms->reason, rbuf,
390 sizeof(rbuf));
391 vty_out(vty,
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");
395
396 if (pbrms->src)
397 vty_out(vty, "\tSRC Match: %s\n",
398 prefix2str(pbrms->src, buf,
399 sizeof(buf)));
400 if (pbrms->dst)
401 vty_out(vty, "\tDST Match: %s\n",
402 prefix2str(pbrms->dst, buf,
403 sizeof(buf)));
404
405 if (pbrms->nhgrp_name) {
406 vty_out(vty,
407 "\tNexthop-Group: %s(%u) Installed: %u(%d)\n",
408 pbrms->nhgrp_name,
409 pbr_nht_get_table(pbrms->nhgrp_name),
410 pbrms->nhs_installed,
411 pbr_nht_get_installed(
412 pbrms->nhgrp_name));
413 } else if (pbrms->nhg) {
414 vty_out(vty, " ");
415 nexthop_group_write_nexthop(
416 vty, pbrms->nhg->nexthop);
417 vty_out(vty,
418 "\tInstalled: %u(%d) Tableid: %d\n",
419 pbrms->nhs_installed,
420 pbr_nht_get_installed(
421 pbrms->internal_nhg_name),
422 pbr_nht_get_table(
423 pbrms->internal_nhg_name));
424 } else {
425 vty_out(vty,
426 "\tNexthop-Group: Unknown Installed: 0(0)\n");
427 }
428 }
429 }
430 return CMD_SUCCESS;
431 }
432
433 DEFPY(show_pbr_nexthop_group,
434 show_pbr_nexthop_group_cmd,
435 "show pbr nexthop-groups [WORD$word]",
436 SHOW_STR
437 "Policy Based Routing\n"
438 "Nexthop Groups\n"
439 "Optional Name of the nexthop group\n")
440 {
441 pbr_nht_show_nexthop_group(vty, word);
442
443 return CMD_SUCCESS;
444 }
445
446 DEFPY (show_pbr_interface,
447 show_pbr_interface_cmd,
448 "show pbr interface [NAME$name] [json$json]",
449 SHOW_STR
450 "Policy Based Routing\n"
451 "PBR Interface\n"
452 "PBR Interface Name\n"
453 JSON_STR)
454 {
455 struct interface *ifp;
456 struct vrf *vrf;
457 struct pbr_interface *pbr_ifp;
458
459 RB_FOREACH(vrf, vrf_name_head, &vrfs_by_name) {
460 FOR_ALL_INTERFACES(vrf, ifp) {
461 struct pbr_map *pbrm;
462
463 if (!ifp->info)
464 continue;
465
466 if (name && strcmp(ifp->name, name) != 0)
467 continue;
468
469 pbr_ifp = ifp->info;
470
471 if (strcmp(pbr_ifp->mapname, "") == 0)
472 continue;
473
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);
477 if (!pbrm)
478 vty_out(vty, " (map doesn't exist)");
479 vty_out(vty, "\n");
480 }
481 }
482
483 return CMD_SUCCESS;
484 }
485
486 /* PBR debugging CLI ------------------------------------------------------- */
487 /* clang-format off */
488
489 static struct cmd_node debug_node = {DEBUG_NODE, "", 1};
490
491 DEFPY(debug_pbr,
492 debug_pbr_cmd,
493 "[no] debug pbr [{map$map|zebra$zebra|nht$nht|events$events}]",
494 NO_STR
495 DEBUG_STR
496 "Policy Based Routing\n"
497 "Policy maps\n"
498 "PBRD <-> Zebra communications\n"
499 "Nexthop tracking\n"
500 "Events\n")
501 {
502 uint32_t mode = DEBUG_NODE2MODE(vty->node);
503
504 if (map)
505 DEBUG_MODE_SET(&pbr_dbg_map, mode, !no);
506 if (zebra)
507 DEBUG_MODE_SET(&pbr_dbg_zebra, mode, !no);
508 if (nht)
509 DEBUG_MODE_SET(&pbr_dbg_nht, mode, !no);
510 if (events)
511 DEBUG_MODE_SET(&pbr_dbg_event, mode, !no);
512
513 /* no specific debug --> act on all of them */
514 if (strmatch(argv[argc - 1]->text, "pbr"))
515 pbr_debug_set_all(mode, !no);
516
517 return CMD_SUCCESS;
518 }
519
520 DEFUN_NOSH(show_debugging_pbr,
521 show_debugging_pbr_cmd,
522 "show debugging [pbr]",
523 SHOW_STR
524 DEBUG_STR
525 "Policy Based Routing\n")
526 {
527 vty_out(vty, "PBR debugging status:\n");
528
529 pbr_debug_config_write_helper(vty, false);
530
531 return CMD_SUCCESS;
532 }
533
534 /* clang-format on */
535 /* ------------------------------------------------------------------------- */
536
537
538 static struct cmd_node interface_node = {
539 INTERFACE_NODE, "%s(config-if)# ", 1 /* vtysh ? yes */
540 };
541
542 static int pbr_interface_config_write(struct vty *vty)
543 {
544 struct interface *ifp;
545 struct vrf *vrf;
546
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);
551 else
552 vty_frame(vty, "interface %s vrf %s\n",
553 ifp->name, vrf->name);
554
555 pbr_map_write_interfaces(vty, ifp);
556
557 vty_endframe(vty, "!\n");
558 }
559 }
560
561 return 1;
562 }
563
564 /* PBR map node structure. */
565 static struct cmd_node pbr_map_node = {PBRMAP_NODE, "%s(config-pbr-map)# ", 1};
566
567 static int pbr_vty_map_config_write_sequence(struct vty *vty,
568 struct pbr_map *pbrm,
569 struct pbr_map_sequence *pbrms)
570 {
571 char buff[PREFIX_STRLEN];
572
573 vty_out(vty, "pbr-map %s seq %u\n", pbrm->name, pbrms->seqno);
574
575 if (pbrms->src)
576 vty_out(vty, " match src-ip %s\n",
577 prefix2str(pbrms->src, buff, sizeof(buff)));
578
579 if (pbrms->dst)
580 vty_out(vty, " match dst-ip %s\n",
581 prefix2str(pbrms->dst, buff, sizeof(buff)));
582
583 if (pbrms->nhgrp_name)
584 vty_out(vty, " set nexthop-group %s\n", pbrms->nhgrp_name);
585
586 if (pbrms->nhg) {
587 vty_out(vty, " set ");
588 nexthop_group_write_nexthop(vty, pbrms->nhg->nexthop);
589 }
590
591 vty_out(vty, "!\n");
592 return 1;
593 }
594
595 static int pbr_vty_map_config_write(struct vty *vty)
596 {
597 struct pbr_map *pbrm;
598
599 pbr_nht_write_table_range(vty);
600 pbr_nht_write_rule_range(vty);
601
602 RB_FOREACH(pbrm, pbr_map_entry_head, &pbr_maps) {
603 struct pbr_map_sequence *pbrms;
604 struct listnode *node;
605
606 for (ALL_LIST_ELEMENTS_RO(pbrm->seqnumbers, node, pbrms))
607 pbr_vty_map_config_write_sequence(vty, pbrm, pbrms);
608 }
609
610 return 1;
611 }
612
613 void pbr_vty_init(void)
614 {
615 install_node(&interface_node,
616 pbr_interface_config_write);
617 if_cmd_init();
618
619 install_node(&pbr_map_node,
620 pbr_vty_map_config_write);
621
622 /* debug */
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);
627
628 install_default(PBRMAP_NODE);
629
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);
641 }