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
35 #include "nexthop_group.h"
39 #include "pbr_memory.h"
40 #include "pbr_zebra.h"
41 #include "pbr_debug.h"
44 DEFINE_MTYPE_STATIC(PBRD
, PBR_INTERFACE
, "PBR Interface")
46 /* Zebra structure to hold current status. */
47 struct zclient
*zclient
;
49 struct pbr_interface
*pbr_if_new(struct interface
*ifp
)
51 struct pbr_interface
*pbr_ifp
;
56 pbr_ifp
= XCALLOC(MTYPE_PBR_INTERFACE
, sizeof(*pbr_ifp
));
62 /* Inteface addition message from zebra. */
63 int pbr_ifp_create(struct interface
*ifp
)
65 DEBUGD(&pbr_dbg_zebra
,
66 "%s: %s", __PRETTY_FUNCTION__
, ifp
->name
);
71 /* Update nexthops tracked from a `set nexthop` command */
72 pbr_nht_nexthop_interface_update(ifp
);
74 pbr_map_policy_interface_update(ifp
, true);
79 int pbr_ifp_destroy(struct interface
*ifp
)
81 DEBUGD(&pbr_dbg_zebra
,
82 "%s: %s", __PRETTY_FUNCTION__
, ifp
->name
);
84 pbr_map_policy_interface_update(ifp
, false);
89 static int interface_address_add(ZAPI_CALLBACK_ARGS
)
92 char buf
[PREFIX_STRLEN
];
94 c
= zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
96 DEBUGD(&pbr_dbg_zebra
,
97 "%s: %s added %s", __PRETTY_FUNCTION__
,
98 c
? c
->ifp
->name
: "Unknown",
99 c
? prefix2str(c
->address
, buf
, sizeof(buf
)) : "Unknown");
104 static int interface_address_delete(ZAPI_CALLBACK_ARGS
)
107 char buf
[PREFIX_STRLEN
];
109 c
= zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
114 DEBUGD(&pbr_dbg_zebra
,
115 "%s: %s deleted %s", __PRETTY_FUNCTION__
, c
->ifp
->name
,
116 prefix2str(c
->address
, buf
, sizeof(buf
)));
122 int pbr_ifp_up(struct interface
*ifp
)
124 DEBUGD(&pbr_dbg_zebra
,
125 "%s: %s is up", __PRETTY_FUNCTION__
, ifp
->name
);
127 pbr_nht_nexthop_interface_update(ifp
);
132 int pbr_ifp_down(struct interface
*ifp
)
134 DEBUGD(&pbr_dbg_zebra
,
135 "%s: %s is down", __PRETTY_FUNCTION__
, ifp
->name
);
137 pbr_nht_nexthop_interface_update(ifp
);
142 static int interface_vrf_update(ZAPI_CALLBACK_ARGS
)
144 struct interface
*ifp
;
147 ifp
= zebra_interface_vrf_update_read(zclient
->ibuf
, vrf_id
,
151 DEBUGD(&pbr_dbg_zebra
, "%s: VRF change interface not found",
157 DEBUGD(&pbr_dbg_zebra
, "%s: %s VRF change %u -> %u", __func__
,
158 ifp
->name
, vrf_id
, new_vrf_id
);
160 if_update_to_new_vrf(ifp
, new_vrf_id
);
165 static int route_notify_owner(ZAPI_CALLBACK_ARGS
)
168 enum zapi_route_notify_owner note
;
170 char buf
[PREFIX_STRLEN
];
172 if (!zapi_route_notify_decode(zclient
->ibuf
, &p
, &table_id
, ¬e
))
175 prefix2str(&p
, buf
, sizeof(buf
));
178 case ZAPI_ROUTE_FAIL_INSTALL
:
179 DEBUGD(&pbr_dbg_zebra
,
180 "%s: [%s] Route install failure for table: %u",
181 __PRETTY_FUNCTION__
, buf
, table_id
);
183 case ZAPI_ROUTE_BETTER_ADMIN_WON
:
184 DEBUGD(&pbr_dbg_zebra
,
185 "%s: [%s] Route better admin distance won for table: %u",
186 __PRETTY_FUNCTION__
, buf
, table_id
);
188 case ZAPI_ROUTE_INSTALLED
:
189 DEBUGD(&pbr_dbg_zebra
,
190 "%s: [%s] Route installed succeeded for table: %u",
191 __PRETTY_FUNCTION__
, buf
, table_id
);
192 pbr_nht_route_installed_for_table(table_id
);
194 case ZAPI_ROUTE_REMOVED
:
195 DEBUGD(&pbr_dbg_zebra
,
196 "%s: [%s] Route Removed succeeded for table: %u",
197 __PRETTY_FUNCTION__
, buf
, table_id
);
198 pbr_nht_route_removed_for_table(table_id
);
200 case ZAPI_ROUTE_REMOVE_FAIL
:
201 DEBUGD(&pbr_dbg_zebra
,
202 "%s: [%s] Route remove fail for table: %u",
203 __PRETTY_FUNCTION__
, buf
, table_id
);
210 static int rule_notify_owner(ZAPI_CALLBACK_ARGS
)
212 uint32_t seqno
, priority
, unique
;
213 enum zapi_rule_notify_owner note
;
214 struct pbr_map_sequence
*pbrms
;
215 struct pbr_map_interface
*pmi
;
219 if (!zapi_rule_notify_decode(zclient
->ibuf
, &seqno
, &priority
, &unique
,
224 pbrms
= pbrms_lookup_unique(unique
, ifi
, &pmi
);
226 DEBUGD(&pbr_dbg_zebra
,
227 "%s: Failure to lookup pbrms based upon %u",
228 __PRETTY_FUNCTION__
, unique
);
232 installed
= 1 << pmi
->install_bit
;
235 case ZAPI_RULE_FAIL_INSTALL
:
236 pbrms
->installed
&= ~installed
;
237 DEBUGD(&pbr_dbg_zebra
,
238 "%s: Received RULE_FAIL_INSTALL: %" PRIu64
,
239 __PRETTY_FUNCTION__
, pbrms
->installed
);
241 case ZAPI_RULE_INSTALLED
:
242 pbrms
->installed
|= installed
;
243 DEBUGD(&pbr_dbg_zebra
, "%s: Received RULE_INSTALLED: %" PRIu64
,
244 __PRETTY_FUNCTION__
, pbrms
->installed
);
246 case ZAPI_RULE_FAIL_REMOVE
:
247 case ZAPI_RULE_REMOVED
:
248 pbrms
->installed
&= ~installed
;
249 DEBUGD(&pbr_dbg_zebra
, "%s: Received RULE REMOVED: %" PRIu64
,
250 __PRETTY_FUNCTION__
, pbrms
->installed
);
254 pbr_map_final_interface_deletion(pbrms
->parent
, pmi
);
259 static void zebra_connected(struct zclient
*zclient
)
261 DEBUGD(&pbr_dbg_zebra
, "%s: Registering for fun and profit",
262 __PRETTY_FUNCTION__
);
263 zclient_send_reg_requests(zclient
, VRF_DEFAULT
);
266 static void route_add_helper(struct zapi_route
*api
, struct nexthop_group nhg
,
269 struct zapi_nexthop
*api_nh
;
270 char buf
[PREFIX_STRLEN
];
271 struct nexthop
*nhop
;
274 api
->prefix
.family
= install_afi
;
276 DEBUGD(&pbr_dbg_zebra
, "\tEncoding %s",
277 prefix2str(&api
->prefix
, buf
, sizeof(buf
)));
280 for (ALL_NEXTHOPS(nhg
, nhop
)) {
281 api_nh
= &api
->nexthops
[i
];
282 api_nh
->vrf_id
= nhop
->vrf_id
;
283 api_nh
->type
= nhop
->type
;
284 switch (nhop
->type
) {
285 case NEXTHOP_TYPE_IPV4
:
286 api_nh
->gate
.ipv4
= nhop
->gate
.ipv4
;
288 case NEXTHOP_TYPE_IPV4_IFINDEX
:
289 api_nh
->gate
.ipv4
= nhop
->gate
.ipv4
;
290 api_nh
->ifindex
= nhop
->ifindex
;
292 case NEXTHOP_TYPE_IFINDEX
:
293 api_nh
->ifindex
= nhop
->ifindex
;
295 case NEXTHOP_TYPE_IPV6
:
296 memcpy(&api_nh
->gate
.ipv6
, &nhop
->gate
.ipv6
, 16);
298 case NEXTHOP_TYPE_IPV6_IFINDEX
:
299 api_nh
->ifindex
= nhop
->ifindex
;
300 memcpy(&api_nh
->gate
.ipv6
, &nhop
->gate
.ipv6
, 16);
302 case NEXTHOP_TYPE_BLACKHOLE
:
303 api_nh
->bh_type
= nhop
->bh_type
;
308 api
->nexthop_num
= i
;
310 zclient_route_send(ZEBRA_ROUTE_ADD
, zclient
, api
);
314 * This function assumes a default route is being
315 * installed into the appropriate tableid
317 void route_add(struct pbr_nexthop_group_cache
*pnhgc
, struct nexthop_group nhg
,
320 struct zapi_route api
;
322 DEBUGD(&pbr_dbg_zebra
, "%s for Table: %d", __PRETTY_FUNCTION__
,
325 memset(&api
, 0, sizeof(api
));
327 api
.vrf_id
= VRF_DEFAULT
;
328 api
.type
= ZEBRA_ROUTE_PBR
;
329 api
.safi
= SAFI_UNICAST
;
331 * Sending a default route
333 api
.tableid
= pnhgc
->table_id
;
334 SET_FLAG(api
.flags
, ZEBRA_FLAG_ALLOW_RECURSION
);
335 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
336 SET_FLAG(api
.message
, ZAPI_MESSAGE_NEXTHOP
);
337 switch (install_afi
) {
339 route_add_helper(&api
, nhg
, AF_INET
);
340 route_add_helper(&api
, nhg
, AF_INET6
);
343 route_add_helper(&api
, nhg
, AF_INET
);
346 route_add_helper(&api
, nhg
, AF_INET6
);
349 DEBUGD(&pbr_dbg_zebra
,
350 "%s: Asked to install unsupported route type: L2VPN",
351 __PRETTY_FUNCTION__
);
354 DEBUGD(&pbr_dbg_zebra
,
355 "%s: Asked to install unspecified route type",
356 __PRETTY_FUNCTION__
);
362 * This function assumes a default route is being
363 * removed from the appropriate tableid
365 void route_delete(struct pbr_nexthop_group_cache
*pnhgc
, afi_t afi
)
367 struct zapi_route api
;
369 DEBUGD(&pbr_dbg_zebra
, "%s for Table: %d", __PRETTY_FUNCTION__
,
372 memset(&api
, 0, sizeof(api
));
373 api
.vrf_id
= VRF_DEFAULT
;
374 api
.type
= ZEBRA_ROUTE_PBR
;
375 api
.safi
= SAFI_UNICAST
;
377 api
.tableid
= pnhgc
->table_id
;
378 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
382 api
.prefix
.family
= AF_INET
;
383 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
386 api
.prefix
.family
= AF_INET6
;
387 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
390 api
.prefix
.family
= AF_INET
;
391 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
392 api
.prefix
.family
= AF_INET6
;
393 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
396 DEBUGD(&pbr_dbg_zebra
,
397 "%s: Asked to delete unsupported route type: L2VPN",
398 __PRETTY_FUNCTION__
);
401 DEBUGD(&pbr_dbg_zebra
,
402 "%s: Asked to delete unspecified route type",
403 __PRETTY_FUNCTION__
);
408 static int pbr_zebra_nexthop_update(ZAPI_CALLBACK_ARGS
)
410 struct zapi_route nhr
;
411 char buf
[PREFIX2STR_BUFFER
];
414 if (!zapi_nexthop_update_decode(zclient
->ibuf
, &nhr
)) {
415 zlog_warn("Failure to decode Nexthop update message");
419 if (DEBUG_MODE_CHECK(&pbr_dbg_zebra
, DEBUG_MODE_ALL
)) {
421 DEBUGD(&pbr_dbg_zebra
, "%s: Received Nexthop update: %s",
423 prefix2str(&nhr
.prefix
, buf
, sizeof(buf
)));
425 DEBUGD(&pbr_dbg_zebra
, "%s: (\tNexthops(%u)",
426 __PRETTY_FUNCTION__
, nhr
.nexthop_num
);
428 for (i
= 0; i
< nhr
.nexthop_num
; i
++) {
429 DEBUGD(&pbr_dbg_zebra
,
430 "%s: \tType: %d: vrf: %d, ifindex: %d gate: %s",
431 __PRETTY_FUNCTION__
, nhr
.nexthops
[i
].type
,
432 nhr
.nexthops
[i
].vrf_id
, nhr
.nexthops
[i
].ifindex
,
433 inet_ntoa(nhr
.nexthops
[i
].gate
.ipv4
));
437 pbr_nht_nexthop_update(&nhr
);
441 extern struct zebra_privs_t pbr_privs
;
443 void pbr_zebra_init(void)
445 struct zclient_options opt
= { .receive_notify
= true };
447 zclient
= zclient_new(master
, &opt
);
449 zclient_init(zclient
, ZEBRA_ROUTE_PBR
, 0, &pbr_privs
);
450 zclient
->zebra_connected
= zebra_connected
;
451 zclient
->interface_address_add
= interface_address_add
;
452 zclient
->interface_address_delete
= interface_address_delete
;
453 zclient
->interface_vrf_update
= interface_vrf_update
;
454 zclient
->route_notify_owner
= route_notify_owner
;
455 zclient
->rule_notify_owner
= rule_notify_owner
;
456 zclient
->nexthop_update
= pbr_zebra_nexthop_update
;
459 void pbr_send_rnh(struct nexthop
*nhop
, bool reg
)
465 ZEBRA_NEXTHOP_REGISTER
: ZEBRA_NEXTHOP_UNREGISTER
;
467 memset(&p
, 0, sizeof(p
));
468 switch (nhop
->type
) {
469 case NEXTHOP_TYPE_IFINDEX
:
470 case NEXTHOP_TYPE_BLACKHOLE
:
472 case NEXTHOP_TYPE_IPV4
:
473 case NEXTHOP_TYPE_IPV4_IFINDEX
:
475 p
.u
.prefix4
.s_addr
= nhop
->gate
.ipv4
.s_addr
;
478 case NEXTHOP_TYPE_IPV6
:
479 case NEXTHOP_TYPE_IPV6_IFINDEX
:
481 memcpy(&p
.u
.prefix6
, &nhop
->gate
.ipv6
, 16);
483 if (IN6_IS_ADDR_LINKLOCAL(&nhop
->gate
.ipv6
))
485 * Don't bother tracking link locals, just track their
492 if (zclient_send_rnh(zclient
, command
, &p
,
493 false, nhop
->vrf_id
) < 0) {
494 zlog_warn("%s: Failure to send nexthop to zebra",
495 __PRETTY_FUNCTION__
);
499 static void pbr_encode_pbr_map_sequence_prefix(struct stream
*s
,
501 unsigned char family
)
506 memset(&any
, 0, sizeof(any
));
511 stream_putc(s
, p
->family
);
512 stream_putc(s
, p
->prefixlen
);
513 stream_put(s
, &p
->u
.prefix
, prefix_blen(p
));
517 pbr_encode_pbr_map_sequence_vrf(struct stream
*s
,
518 const struct pbr_map_sequence
*pbrms
,
519 const struct interface
*ifp
)
521 struct pbr_vrf
*pbr_vrf
;
523 if (pbrms
->vrf_unchanged
)
524 pbr_vrf
= pbr_vrf_lookup_by_id(ifp
->vrf_id
);
526 pbr_vrf
= pbr_vrf_lookup_by_name(pbrms
->vrf_name
);
529 DEBUGD(&pbr_dbg_zebra
, "%s: VRF not found", __func__
);
533 stream_putl(s
, pbr_vrf
->vrf
->data
.l
.table_id
);
536 static void pbr_encode_pbr_map_sequence(struct stream
*s
,
537 struct pbr_map_sequence
*pbrms
,
538 struct interface
*ifp
)
540 unsigned char family
;
544 family
= pbrms
->family
;
546 stream_putl(s
, pbrms
->seqno
);
547 stream_putl(s
, pbrms
->ruleno
);
548 stream_putl(s
, pbrms
->unique
);
549 pbr_encode_pbr_map_sequence_prefix(s
, pbrms
->src
, family
);
550 stream_putw(s
, 0); /* src port */
551 pbr_encode_pbr_map_sequence_prefix(s
, pbrms
->dst
, family
);
552 stream_putw(s
, 0); /* dst port */
553 stream_putl(s
, pbrms
->mark
);
555 if (pbrms
->vrf_unchanged
|| pbrms
->vrf_lookup
)
556 pbr_encode_pbr_map_sequence_vrf(s
, pbrms
, ifp
);
557 else if (pbrms
->nhgrp_name
)
558 stream_putl(s
, pbr_nht_get_table(pbrms
->nhgrp_name
));
560 stream_putl(s
, pbr_nht_get_table(pbrms
->internal_nhg_name
));
561 stream_putl(s
, ifp
->ifindex
);
564 void pbr_send_pbr_map(struct pbr_map_sequence
*pbrms
,
565 struct pbr_map_interface
*pmi
, bool install
)
567 struct pbr_map
*pbrm
= pbrms
->parent
;
569 uint64_t is_installed
= (uint64_t)1 << pmi
->install_bit
;
571 is_installed
&= pbrms
->installed
;
573 DEBUGD(&pbr_dbg_zebra
, "%s: for %s %d(%" PRIu64
")",
574 __PRETTY_FUNCTION__
, pbrm
->name
, install
, is_installed
);
577 * If we are installed and asked to do so again
578 * just return. If we are not installed and asked
579 * and asked to delete just return;
581 if (install
&& is_installed
)
584 if (!install
&& !is_installed
)
590 zclient_create_header(s
,
591 install
? ZEBRA_RULE_ADD
: ZEBRA_RULE_DELETE
,
595 * We are sending one item at a time at the moment
599 DEBUGD(&pbr_dbg_zebra
, "%s: \t%s %s %d %s %u",
600 __PRETTY_FUNCTION__
, install
? "Installing" : "Deleting",
601 pbrm
->name
, install
, pmi
->ifp
->name
, pmi
->delete);
603 pbr_encode_pbr_map_sequence(s
, pbrms
, pmi
->ifp
);
605 stream_putw_at(s
, 0, stream_get_endp(s
));
607 zclient_send_message(zclient
);