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"
43 DEFINE_MTYPE_STATIC(PBRD
, PBR_INTERFACE
, "PBR Interface")
45 /* Zebra structure to hold current status. */
46 struct zclient
*zclient
;
48 struct pbr_interface
*pbr_if_new(struct interface
*ifp
)
50 struct pbr_interface
*pbr_ifp
;
55 pbr_ifp
= XCALLOC(MTYPE_PBR_INTERFACE
, sizeof(*pbr_ifp
));
61 /* Inteface addition message from zebra. */
62 static int interface_add(ZAPI_CALLBACK_ARGS
)
64 struct interface
*ifp
;
66 ifp
= zebra_interface_add_read(zclient
->ibuf
, vrf_id
);
71 DEBUGD(&pbr_dbg_zebra
,
72 "%s: %s", __PRETTY_FUNCTION__
, ifp
->name
);
77 pbr_nht_nexthop_interface_update(ifp
);
82 static int interface_delete(ZAPI_CALLBACK_ARGS
)
84 struct interface
*ifp
;
88 /* zebra_interface_state_read () updates interface structure in iflist
90 ifp
= zebra_interface_state_read(s
, vrf_id
);
95 DEBUGD(&pbr_dbg_zebra
,
96 "%s: %s", __PRETTY_FUNCTION__
, ifp
->name
);
98 if_set_index(ifp
, IFINDEX_INTERNAL
);
103 static int interface_address_add(ZAPI_CALLBACK_ARGS
)
106 char buf
[PREFIX_STRLEN
];
108 c
= zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
110 DEBUGD(&pbr_dbg_zebra
,
111 "%s: %s added %s", __PRETTY_FUNCTION__
,
112 c
? c
->ifp
->name
: "Unknown",
113 c
? prefix2str(c
->address
, buf
, sizeof(buf
)) : "Unknown");
118 static int interface_address_delete(ZAPI_CALLBACK_ARGS
)
121 char buf
[PREFIX_STRLEN
];
123 c
= zebra_interface_address_read(cmd
, zclient
->ibuf
, vrf_id
);
128 DEBUGD(&pbr_dbg_zebra
,
129 "%s: %s deleted %s", __PRETTY_FUNCTION__
, c
->ifp
->name
,
130 prefix2str(c
->address
, buf
, sizeof(buf
)));
136 static int interface_state_up(ZAPI_CALLBACK_ARGS
)
138 struct interface
*ifp
;
140 ifp
= zebra_interface_state_read(zclient
->ibuf
, vrf_id
);
142 DEBUGD(&pbr_dbg_zebra
,
143 "%s: %s is up", __PRETTY_FUNCTION__
, ifp
->name
);
145 pbr_nht_nexthop_interface_update(ifp
);
150 static int interface_state_down(ZAPI_CALLBACK_ARGS
)
152 struct interface
*ifp
;
154 ifp
= zebra_interface_state_read(zclient
->ibuf
, vrf_id
);
156 DEBUGD(&pbr_dbg_zebra
,
157 "%s: %s is down", __PRETTY_FUNCTION__
, ifp
->name
);
159 pbr_nht_nexthop_interface_update(ifp
);
164 static int route_notify_owner(ZAPI_CALLBACK_ARGS
)
167 enum zapi_route_notify_owner note
;
169 char buf
[PREFIX_STRLEN
];
171 if (!zapi_route_notify_decode(zclient
->ibuf
, &p
, &table_id
, ¬e
))
174 prefix2str(&p
, buf
, sizeof(buf
));
177 case ZAPI_ROUTE_FAIL_INSTALL
:
178 DEBUGD(&pbr_dbg_zebra
,
179 "%s: [%s] Route install failure for table: %u",
180 __PRETTY_FUNCTION__
, buf
, table_id
);
182 case ZAPI_ROUTE_BETTER_ADMIN_WON
:
183 DEBUGD(&pbr_dbg_zebra
,
184 "%s: [%s] Route better admin distance won for table: %u",
185 __PRETTY_FUNCTION__
, buf
, table_id
);
187 case ZAPI_ROUTE_INSTALLED
:
188 DEBUGD(&pbr_dbg_zebra
,
189 "%s: [%s] Route installed succeeded for table: %u",
190 __PRETTY_FUNCTION__
, buf
, table_id
);
191 pbr_nht_route_installed_for_table(table_id
);
193 case ZAPI_ROUTE_REMOVED
:
194 DEBUGD(&pbr_dbg_zebra
,
195 "%s: [%s] Route Removed succeeded for table: %u",
196 __PRETTY_FUNCTION__
, buf
, table_id
);
197 pbr_nht_route_removed_for_table(table_id
);
199 case ZAPI_ROUTE_REMOVE_FAIL
:
200 DEBUGD(&pbr_dbg_zebra
,
201 "%s: [%s] Route remove fail for table: %u",
202 __PRETTY_FUNCTION__
, buf
, table_id
);
209 static int rule_notify_owner(ZAPI_CALLBACK_ARGS
)
211 uint32_t seqno
, priority
, unique
;
212 enum zapi_rule_notify_owner note
;
213 struct pbr_map_sequence
*pbrms
;
214 struct pbr_map_interface
*pmi
;
218 if (!zapi_rule_notify_decode(zclient
->ibuf
, &seqno
, &priority
, &unique
,
223 pbrms
= pbrms_lookup_unique(unique
, ifi
, &pmi
);
225 DEBUGD(&pbr_dbg_zebra
,
226 "%s: Failure to lookup pbrms based upon %u",
227 __PRETTY_FUNCTION__
, unique
);
231 installed
= 1 << pmi
->install_bit
;
234 case ZAPI_RULE_FAIL_INSTALL
:
235 pbrms
->installed
&= ~installed
;
236 DEBUGD(&pbr_dbg_zebra
,
237 "%s: Received RULE_FAIL_INSTALL: %" PRIu64
,
238 __PRETTY_FUNCTION__
, pbrms
->installed
);
240 case ZAPI_RULE_INSTALLED
:
241 pbrms
->installed
|= installed
;
242 DEBUGD(&pbr_dbg_zebra
, "%s: Received RULE_INSTALLED: %" PRIu64
,
243 __PRETTY_FUNCTION__
, pbrms
->installed
);
245 case ZAPI_RULE_FAIL_REMOVE
:
246 case ZAPI_RULE_REMOVED
:
247 pbrms
->installed
&= ~installed
;
248 DEBUGD(&pbr_dbg_zebra
, "%s: Received RULE REMOVED: %" PRIu64
,
249 __PRETTY_FUNCTION__
, pbrms
->installed
);
253 pbr_map_final_interface_deletion(pbrms
->parent
, pmi
);
258 static void zebra_connected(struct zclient
*zclient
)
260 DEBUGD(&pbr_dbg_zebra
, "%s: Registering for fun and profit",
261 __PRETTY_FUNCTION__
);
262 zclient_send_reg_requests(zclient
, VRF_DEFAULT
);
265 static void route_add_helper(struct zapi_route
*api
, struct nexthop_group nhg
,
268 struct zapi_nexthop
*api_nh
;
269 char buf
[PREFIX_STRLEN
];
270 struct nexthop
*nhop
;
273 api
->prefix
.family
= install_afi
;
275 DEBUGD(&pbr_dbg_zebra
, "\tEncoding %s",
276 prefix2str(&api
->prefix
, buf
, sizeof(buf
)));
279 for (ALL_NEXTHOPS(nhg
, nhop
)) {
280 api_nh
= &api
->nexthops
[i
];
281 api_nh
->vrf_id
= nhop
->vrf_id
;
282 api_nh
->type
= nhop
->type
;
283 switch (nhop
->type
) {
284 case NEXTHOP_TYPE_IPV4
:
285 api_nh
->gate
.ipv4
= nhop
->gate
.ipv4
;
287 case NEXTHOP_TYPE_IPV4_IFINDEX
:
288 api_nh
->gate
.ipv4
= nhop
->gate
.ipv4
;
289 api_nh
->ifindex
= nhop
->ifindex
;
291 case NEXTHOP_TYPE_IFINDEX
:
292 api_nh
->ifindex
= nhop
->ifindex
;
294 case NEXTHOP_TYPE_IPV6
:
295 memcpy(&api_nh
->gate
.ipv6
, &nhop
->gate
.ipv6
, 16);
297 case NEXTHOP_TYPE_IPV6_IFINDEX
:
298 api_nh
->ifindex
= nhop
->ifindex
;
299 memcpy(&api_nh
->gate
.ipv6
, &nhop
->gate
.ipv6
, 16);
301 case NEXTHOP_TYPE_BLACKHOLE
:
302 api_nh
->bh_type
= nhop
->bh_type
;
307 api
->nexthop_num
= i
;
309 zclient_route_send(ZEBRA_ROUTE_ADD
, zclient
, api
);
313 * This function assumes a default route is being
314 * installed into the appropriate tableid
316 void route_add(struct pbr_nexthop_group_cache
*pnhgc
, struct nexthop_group nhg
,
319 struct zapi_route api
;
321 DEBUGD(&pbr_dbg_zebra
, "%s for Table: %d", __PRETTY_FUNCTION__
,
324 memset(&api
, 0, sizeof(api
));
326 api
.vrf_id
= VRF_DEFAULT
;
327 api
.type
= ZEBRA_ROUTE_PBR
;
328 api
.safi
= SAFI_UNICAST
;
330 * Sending a default route
332 api
.tableid
= pnhgc
->table_id
;
333 SET_FLAG(api
.flags
, ZEBRA_FLAG_ALLOW_RECURSION
);
334 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
335 SET_FLAG(api
.message
, ZAPI_MESSAGE_NEXTHOP
);
336 switch (install_afi
) {
338 route_add_helper(&api
, nhg
, AF_INET
);
339 route_add_helper(&api
, nhg
, AF_INET6
);
342 route_add_helper(&api
, nhg
, AF_INET
);
345 route_add_helper(&api
, nhg
, AF_INET6
);
348 DEBUGD(&pbr_dbg_zebra
,
349 "%s: Asked to install unsupported route type: L2VPN",
350 __PRETTY_FUNCTION__
);
353 DEBUGD(&pbr_dbg_zebra
,
354 "%s: Asked to install unspecified route type",
355 __PRETTY_FUNCTION__
);
361 * This function assumes a default route is being
362 * removed from the appropriate tableid
364 void route_delete(struct pbr_nexthop_group_cache
*pnhgc
, afi_t afi
)
366 struct zapi_route api
;
368 DEBUGD(&pbr_dbg_zebra
, "%s for Table: %d", __PRETTY_FUNCTION__
,
371 memset(&api
, 0, sizeof(api
));
372 api
.vrf_id
= VRF_DEFAULT
;
373 api
.type
= ZEBRA_ROUTE_PBR
;
374 api
.safi
= SAFI_UNICAST
;
376 api
.tableid
= pnhgc
->table_id
;
377 SET_FLAG(api
.message
, ZAPI_MESSAGE_TABLEID
);
381 api
.prefix
.family
= AF_INET
;
382 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
385 api
.prefix
.family
= AF_INET6
;
386 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
389 api
.prefix
.family
= AF_INET
;
390 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
391 api
.prefix
.family
= AF_INET6
;
392 zclient_route_send(ZEBRA_ROUTE_DELETE
, zclient
, &api
);
395 DEBUGD(&pbr_dbg_zebra
,
396 "%s: Asked to delete unsupported route type: L2VPN",
397 __PRETTY_FUNCTION__
);
400 DEBUGD(&pbr_dbg_zebra
,
401 "%s: Asked to delete unspecified route type",
402 __PRETTY_FUNCTION__
);
407 static int pbr_zebra_nexthop_update(ZAPI_CALLBACK_ARGS
)
409 struct zapi_route nhr
;
410 char buf
[PREFIX2STR_BUFFER
];
413 if (!zapi_nexthop_update_decode(zclient
->ibuf
, &nhr
)) {
414 zlog_warn("Failure to decode Nexthop update message");
418 if (DEBUG_MODE_CHECK(&pbr_dbg_zebra
, DEBUG_MODE_ALL
)) {
420 DEBUGD(&pbr_dbg_zebra
, "%s: Received Nexthop update: %s",
422 prefix2str(&nhr
.prefix
, buf
, sizeof(buf
)));
424 DEBUGD(&pbr_dbg_zebra
, "%s: (\tNexthops(%u)",
425 __PRETTY_FUNCTION__
, nhr
.nexthop_num
);
427 for (i
= 0; i
< nhr
.nexthop_num
; i
++) {
428 DEBUGD(&pbr_dbg_zebra
,
429 "%s: \tType: %d: vrf: %d, ifindex: %d gate: %s",
430 __PRETTY_FUNCTION__
, nhr
.nexthops
[i
].type
,
431 nhr
.nexthops
[i
].vrf_id
, nhr
.nexthops
[i
].ifindex
,
432 inet_ntoa(nhr
.nexthops
[i
].gate
.ipv4
));
436 pbr_nht_nexthop_update(&nhr
);
440 extern struct zebra_privs_t pbr_privs
;
442 void pbr_zebra_init(void)
444 struct zclient_options opt
= { .receive_notify
= true };
446 zclient
= zclient_new(master
, &opt
);
448 zclient_init(zclient
, ZEBRA_ROUTE_PBR
, 0, &pbr_privs
);
449 zclient
->zebra_connected
= zebra_connected
;
450 zclient
->interface_add
= interface_add
;
451 zclient
->interface_delete
= interface_delete
;
452 zclient
->interface_up
= interface_state_up
;
453 zclient
->interface_down
= interface_state_down
;
454 zclient
->interface_address_add
= interface_address_add
;
455 zclient
->interface_address_delete
= interface_address_delete
;
456 zclient
->route_notify_owner
= route_notify_owner
;
457 zclient
->rule_notify_owner
= rule_notify_owner
;
458 zclient
->nexthop_update
= pbr_zebra_nexthop_update
;
461 void pbr_send_rnh(struct nexthop
*nhop
, bool reg
)
467 ZEBRA_NEXTHOP_REGISTER
: ZEBRA_NEXTHOP_UNREGISTER
;
469 memset(&p
, 0, sizeof(p
));
470 switch (nhop
->type
) {
471 case NEXTHOP_TYPE_IFINDEX
:
472 case NEXTHOP_TYPE_BLACKHOLE
:
474 case NEXTHOP_TYPE_IPV4
:
475 case NEXTHOP_TYPE_IPV4_IFINDEX
:
477 p
.u
.prefix4
.s_addr
= nhop
->gate
.ipv4
.s_addr
;
480 case NEXTHOP_TYPE_IPV6
:
481 case NEXTHOP_TYPE_IPV6_IFINDEX
:
483 memcpy(&p
.u
.prefix6
, &nhop
->gate
.ipv6
, 16);
488 if (zclient_send_rnh(zclient
, command
, &p
,
489 false, nhop
->vrf_id
) < 0) {
490 zlog_warn("%s: Failure to send nexthop to zebra",
491 __PRETTY_FUNCTION__
);
495 static void pbr_encode_pbr_map_sequence_prefix(struct stream
*s
,
497 unsigned char family
)
502 memset(&any
, 0, sizeof(any
));
507 stream_putc(s
, p
->family
);
508 stream_putc(s
, p
->prefixlen
);
509 stream_put(s
, &p
->u
.prefix
, prefix_blen(p
));
512 static void pbr_encode_pbr_map_sequence(struct stream
*s
,
513 struct pbr_map_sequence
*pbrms
,
514 struct interface
*ifp
)
516 unsigned char family
;
520 family
= pbrms
->family
;
522 stream_putl(s
, pbrms
->seqno
);
523 stream_putl(s
, pbrms
->ruleno
);
524 stream_putl(s
, pbrms
->unique
);
525 pbr_encode_pbr_map_sequence_prefix(s
, pbrms
->src
, family
);
526 stream_putw(s
, 0); /* src port */
527 pbr_encode_pbr_map_sequence_prefix(s
, pbrms
->dst
, family
);
528 stream_putw(s
, 0); /* dst port */
529 stream_putl(s
, pbrms
->mark
);
530 if (pbrms
->nhgrp_name
)
531 stream_putl(s
, pbr_nht_get_table(pbrms
->nhgrp_name
));
533 stream_putl(s
, pbr_nht_get_table(pbrms
->internal_nhg_name
));
534 stream_putl(s
, ifp
->ifindex
);
537 void pbr_send_pbr_map(struct pbr_map_sequence
*pbrms
,
538 struct pbr_map_interface
*pmi
, bool install
)
540 struct pbr_map
*pbrm
= pbrms
->parent
;
542 uint64_t is_installed
= (uint64_t)1 << pmi
->install_bit
;
544 is_installed
&= pbrms
->installed
;
546 DEBUGD(&pbr_dbg_zebra
, "%s: for %s %d(%" PRIu64
")",
547 __PRETTY_FUNCTION__
, pbrm
->name
, install
, is_installed
);
550 * If we are installed and asked to do so again
551 * just return. If we are not installed and asked
552 * and asked to delete just return;
554 if (install
&& is_installed
)
557 if (!install
&& !is_installed
)
563 zclient_create_header(s
,
564 install
? ZEBRA_RULE_ADD
: ZEBRA_RULE_DELETE
,
568 * We are sending one item at a time at the moment
572 DEBUGD(&pbr_dbg_zebra
, "%s: \t%s %s %d %s %u",
573 __PRETTY_FUNCTION__
, install
? "Installing" : "Deleting",
574 pbrm
->name
, install
, pmi
->ifp
->name
, pmi
->delete);
576 pbr_encode_pbr_map_sequence(s
, pbrms
, pmi
->ifp
);
578 stream_putw_at(s
, 0, stream_get_endp(s
));
580 zclient_send_message(zclient
);