]> git.proxmox.com Git - mirror_frr.git/blame - pbrd/pbr_zebra.c
Merge pull request #2156 from donaldsharp/zebra_doc
[mirror_frr.git] / pbrd / pbr_zebra.c
CommitLineData
e5c83d9b
DS
1/*
2 * Zebra connect 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 "thread.h"
23#include "command.h"
24#include "network.h"
25#include "prefix.h"
26#include "routemap.h"
27#include "table.h"
28#include "stream.h"
29#include "memory.h"
30#include "zclient.h"
31#include "filter.h"
32#include "plist.h"
33#include "log.h"
34#include "nexthop.h"
35#include "nexthop_group.h"
36
37#include "pbr_nht.h"
38#include "pbr_map.h"
39#include "pbr_memory.h"
40#include "pbr_zebra.h"
41#include "pbr_debug.h"
42
43DEFINE_MTYPE_STATIC(PBRD, PBR_INTERFACE, "PBR Interface")
44
45/* Zebra structure to hold current status. */
d3765386 46struct zclient *zclient;
e5c83d9b 47
b13e5ad6 48struct pbr_interface *pbr_if_new(struct interface *ifp)
e5c83d9b
DS
49{
50 struct pbr_interface *pbr_ifp;
51
52 zassert(ifp);
53 zassert(!ifp->info);
54
55 pbr_ifp = XCALLOC(MTYPE_PBR_INTERFACE, sizeof(*pbr_ifp));
56
57 if (!pbr_ifp) {
58 zlog_err("%s: PBR XCALLOC(%zu) failure", __PRETTY_FUNCTION__,
59 sizeof(*pbr_ifp));
60 return 0;
61 }
62
10a00758
DS
63 ifp->info = pbr_ifp;
64 return pbr_ifp;
e5c83d9b
DS
65}
66
67/* Inteface addition message from zebra. */
68static int interface_add(int command, struct zclient *zclient,
69 zebra_size_t length, vrf_id_t vrf_id)
70{
71 struct interface *ifp;
72
73 ifp = zebra_interface_add_read(zclient->ibuf, vrf_id);
74
75 if (!ifp)
76 return 0;
77
10a00758
DS
78 if (!ifp->info)
79 pbr_if_new(ifp);
e5c83d9b
DS
80
81 return 0;
82}
83
84static int interface_delete(int command, struct zclient *zclient,
85 zebra_size_t length, vrf_id_t vrf_id)
86{
87 struct interface *ifp;
88 struct stream *s;
89
90 s = zclient->ibuf;
91 /* zebra_interface_state_read () updates interface structure in iflist
92 */
93 ifp = zebra_interface_state_read(s, vrf_id);
94
95 if (ifp == NULL)
96 return 0;
97
98 if_set_index(ifp, IFINDEX_INTERNAL);
99
100 return 0;
101}
102
103static int interface_address_add(int command, struct zclient *zclient,
104 zebra_size_t length, vrf_id_t vrf_id)
105{
106 zebra_interface_address_read(command, zclient->ibuf, vrf_id);
107
108 return 0;
109}
110
111static int interface_address_delete(int command, struct zclient *zclient,
112 zebra_size_t length, vrf_id_t vrf_id)
113{
114 struct connected *c;
115
116 c = zebra_interface_address_read(command, zclient->ibuf, vrf_id);
117
118 if (!c)
119 return 0;
120
121 connected_free(c);
122 return 0;
123}
124
125static int interface_state_up(int command, struct zclient *zclient,
126 zebra_size_t length, vrf_id_t vrf_id)
127{
128
d7b3ad40 129 zebra_interface_state_read(zclient->ibuf, vrf_id);
e5c83d9b
DS
130
131 return 0;
132}
133
134static int interface_state_down(int command, struct zclient *zclient,
135 zebra_size_t length, vrf_id_t vrf_id)
136{
137
138 zebra_interface_state_read(zclient->ibuf, vrf_id);
139
140 return 0;
141}
142
143static int route_notify_owner(int command, struct zclient *zclient,
144 zebra_size_t length, vrf_id_t vrf_id)
145{
146 struct prefix p;
147 enum zapi_route_notify_owner note;
148 uint32_t table_id;
149 char buf[PREFIX_STRLEN];
150
151 prefix2str(&p, buf, sizeof(buf));
152
153 if (!zapi_route_notify_decode(zclient->ibuf, &p, &table_id, &note))
154 return -1;
155
156 switch (note) {
157 case ZAPI_ROUTE_FAIL_INSTALL:
158 DEBUGD(&pbr_dbg_zebra,
159 "%s: [%s] Route install failure for table: %u",
160 __PRETTY_FUNCTION__, buf, table_id);
161 break;
162 case ZAPI_ROUTE_BETTER_ADMIN_WON:
163 DEBUGD(&pbr_dbg_zebra,
164 "%s: [%s] Route better admin distance won for table: %u",
165 __PRETTY_FUNCTION__, buf, table_id);
166 break;
167 case ZAPI_ROUTE_INSTALLED:
168 DEBUGD(&pbr_dbg_zebra,
169 "%s: [%s] Route installed succeeded for table: %u",
170 __PRETTY_FUNCTION__, buf, table_id);
171 pbr_nht_route_installed_for_table(table_id);
172 break;
173 case ZAPI_ROUTE_REMOVED:
174 DEBUGD(&pbr_dbg_zebra,
175 "%s: [%s] Route Removed succeeded for table: %u",
176 __PRETTY_FUNCTION__, buf, table_id);
177 pbr_nht_route_removed_for_table(table_id);
178 break;
179 case ZAPI_ROUTE_REMOVE_FAIL:
180 DEBUGD(&pbr_dbg_zebra,
181 "%s: [%s] Route remove fail for table: %u",
182 __PRETTY_FUNCTION__, buf, table_id);
183 break;
184 }
185
186 return 0;
187}
188
189static int rule_notify_owner(int command, struct zclient *zclient,
190 zebra_size_t length, vrf_id_t vrf_id)
191{
192 uint32_t seqno, priority, unique;
193 enum zapi_rule_notify_owner note;
194 struct pbr_map_sequence *pbrms;
37c606ff 195 struct pbr_map_interface *pmi;
e5c83d9b 196 ifindex_t ifi;
37c606ff 197 uint64_t installed;
e5c83d9b
DS
198
199 if (!zapi_rule_notify_decode(zclient->ibuf, &seqno, &priority, &unique,
200 &ifi, &note))
201 return -1;
202
37c606ff
DS
203 pmi = NULL;
204 pbrms = pbrms_lookup_unique(unique, ifi, &pmi);
e5c83d9b
DS
205 if (!pbrms) {
206 DEBUGD(&pbr_dbg_zebra,
207 "%s: Failure to lookup pbrms based upon %u",
208 __PRETTY_FUNCTION__, unique);
209 return 0;
210 }
211
37c606ff
DS
212 installed = 1 << pmi->install_bit;
213
e5c83d9b
DS
214 switch (note) {
215 case ZAPI_RULE_FAIL_INSTALL:
216 DEBUGD(&pbr_dbg_zebra, "%s: Recieved RULE_FAIL_INSTALL",
217 __PRETTY_FUNCTION__);
37c606ff 218 pbrms->installed &= ~installed;
e5c83d9b
DS
219 break;
220 case ZAPI_RULE_INSTALLED:
37c606ff 221 pbrms->installed |= installed;
e5c83d9b
DS
222 DEBUGD(&pbr_dbg_zebra, "%s: Recived RULE_INSTALLED",
223 __PRETTY_FUNCTION__);
224 break;
225 case ZAPI_RULE_REMOVED:
0f03639d 226 pbrms->installed &= ~installed;
e5c83d9b
DS
227 DEBUGD(&pbr_dbg_zebra, "%s: Received RULE REMOVED",
228 __PRETTY_FUNCTION__);
229 break;
230 }
231
232 return 0;
233}
234
235static void zebra_connected(struct zclient *zclient)
236{
237 zclient_send_reg_requests(zclient, VRF_DEFAULT);
238}
239
240static void route_add_helper(struct zapi_route *api, struct nexthop_group nhg,
241 uint8_t install_afi)
242{
243 struct zapi_nexthop *api_nh;
244 struct nexthop *nhop;
245 int i;
246
247 api->prefix.family = install_afi;
248
249 i = 0;
250 for (ALL_NEXTHOPS(nhg, nhop)) {
251 api_nh = &api->nexthops[i];
252 api_nh->vrf_id = nhop->vrf_id;
253 api_nh->type = nhop->type;
254 switch (nhop->type) {
255 case NEXTHOP_TYPE_IPV4:
256 api_nh->gate.ipv4 = nhop->gate.ipv4;
257 break;
258 case NEXTHOP_TYPE_IPV4_IFINDEX:
259 api_nh->gate.ipv4 = nhop->gate.ipv4;
260 api_nh->ifindex = nhop->ifindex;
261 break;
262 case NEXTHOP_TYPE_IFINDEX:
263 api_nh->ifindex = nhop->ifindex;
264 break;
265 case NEXTHOP_TYPE_IPV6:
266 memcpy(&api_nh->gate.ipv6, &nhop->gate.ipv6, 16);
267 break;
268 case NEXTHOP_TYPE_IPV6_IFINDEX:
269 api_nh->ifindex = nhop->ifindex;
270 memcpy(&api_nh->gate.ipv6, &nhop->gate.ipv6, 16);
271 break;
272 case NEXTHOP_TYPE_BLACKHOLE:
273 api_nh->bh_type = nhop->bh_type;
274 break;
275 }
276 i++;
277 }
278 api->nexthop_num = i;
279
280 zclient_route_send(ZEBRA_ROUTE_ADD, zclient, api);
281}
282
283/*
284 * This function assumes a default route is being
285 * installed into the appropriate tableid
286 */
287void route_add(struct pbr_nexthop_group_cache *pnhgc, struct nexthop_group nhg,
288 afi_t install_afi)
289{
290 struct zapi_route api;
291
292 memset(&api, 0, sizeof(api));
293
294 api.vrf_id = VRF_DEFAULT;
295 api.type = ZEBRA_ROUTE_PBR;
296 api.safi = SAFI_UNICAST;
297 /*
298 * Sending a default route
299 */
300 api.tableid = pnhgc->table_id;
301 SET_FLAG(api.flags, ZEBRA_FLAG_ALLOW_RECURSION);
302 SET_FLAG(api.message, ZAPI_MESSAGE_TABLEID);
303 SET_FLAG(api.message, ZAPI_MESSAGE_NEXTHOP);
304 switch (install_afi) {
305 case AFI_MAX:
306 route_add_helper(&api, nhg, AF_INET);
307 route_add_helper(&api, nhg, AF_INET6);
308 break;
309 case AFI_IP:
310 route_add_helper(&api, nhg, AF_INET);
311 break;
312 case AFI_IP6:
313 route_add_helper(&api, nhg, AF_INET6);
314 break;
315 case AFI_L2VPN:
316 DEBUGD(&pbr_dbg_zebra,
317 "%s: Asked to install unsupported route type: L2VPN",
318 __PRETTY_FUNCTION__);
319 break;
320 }
321}
322
323/*
324 * This function assumes a default route is being
325 * removed from the appropriate tableid
326 */
327void route_delete(struct pbr_nexthop_group_cache *pnhgc, afi_t afi)
328{
329 struct zapi_route api;
330
331 memset(&api, 0, sizeof(api));
332 api.vrf_id = VRF_DEFAULT;
333 api.type = ZEBRA_ROUTE_PBR;
334 api.safi = SAFI_UNICAST;
335
336 api.tableid = pnhgc->table_id;
337 SET_FLAG(api.message, ZAPI_MESSAGE_TABLEID);
338
339 switch (afi) {
340 case AFI_IP:
341 api.prefix.family = AF_INET;
342 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
343 break;
344 case AFI_IP6:
345 api.prefix.family = AF_INET6;
346 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
347 break;
348 case AFI_MAX:
349 api.prefix.family = AF_INET;
350 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
351 api.prefix.family = AF_INET6;
352 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
353 break;
354 case AFI_L2VPN:
355 DEBUGD(&pbr_dbg_zebra,
356 "%s: Asked to delete unsupported route type: L2VPN",
357 __PRETTY_FUNCTION__);
358 break;
359 }
e5c83d9b
DS
360}
361
362static int pbr_zebra_nexthop_update(int command, struct zclient *zclient,
363 zebra_size_t length, vrf_id_t vrf_id)
364{
365 struct zapi_route nhr;
366 char buf[PREFIX2STR_BUFFER];
367 uint32_t i;
368
369 zapi_nexthop_update_decode(zclient->ibuf, &nhr);
370
371 if (DEBUG_MODE_CHECK(&pbr_dbg_zebra, DEBUG_MODE_ALL)) {
372
373 DEBUGD(&pbr_dbg_zebra, "%s: Received Nexthop update: %s",
374 __PRETTY_FUNCTION__,
375 prefix2str(&nhr.prefix, buf, sizeof(buf)));
376
377 DEBUGD(&pbr_dbg_zebra, "%s: (\tNexthops(%u)",
378 __PRETTY_FUNCTION__, nhr.nexthop_num);
379
380 for (i = 0; i < nhr.nexthop_num; i++) {
381 DEBUGD(&pbr_dbg_zebra,
382 "%s: \tType: %d: vrf: %d, ifindex: %d gate: %s",
383 __PRETTY_FUNCTION__, nhr.nexthops[i].type,
384 nhr.nexthops[i].vrf_id, nhr.nexthops[i].ifindex,
385 inet_ntoa(nhr.nexthops[i].gate.ipv4));
386 }
387 }
388
389 pbr_nht_nexthop_update(&nhr);
390 return 1;
391}
392
393extern struct zebra_privs_t pbr_privs;
394
395void pbr_zebra_init(void)
396{
397 struct zclient_options opt = { .receive_notify = true };
398
399 zclient = zclient_new_notify(master, &opt);
400
401 zclient_init(zclient, ZEBRA_ROUTE_PBR, 0, &pbr_privs);
402 zclient->zebra_connected = zebra_connected;
403 zclient->interface_add = interface_add;
404 zclient->interface_delete = interface_delete;
405 zclient->interface_up = interface_state_up;
406 zclient->interface_down = interface_state_down;
407 zclient->interface_address_add = interface_address_add;
408 zclient->interface_address_delete = interface_address_delete;
409 zclient->route_notify_owner = route_notify_owner;
410 zclient->rule_notify_owner = rule_notify_owner;
411 zclient->nexthop_update = pbr_zebra_nexthop_update;
412}
413
414void pbr_send_rnh(struct nexthop *nhop, bool reg)
415{
416 uint32_t command;
417 struct prefix p;
418
419 command = (reg) ?
420 ZEBRA_NEXTHOP_REGISTER : ZEBRA_NEXTHOP_UNREGISTER;
421
422 memset(&p, 0, sizeof(p));
d3765386 423 switch (nhop->type) {
e5c83d9b
DS
424 case NEXTHOP_TYPE_IFINDEX:
425 case NEXTHOP_TYPE_BLACKHOLE:
426 return;
427 case NEXTHOP_TYPE_IPV4:
428 case NEXTHOP_TYPE_IPV4_IFINDEX:
429 p.family = AF_INET;
430 p.u.prefix4.s_addr = nhop->gate.ipv4.s_addr;
431 p.prefixlen = 32;
432 break;
433 case NEXTHOP_TYPE_IPV6:
434 case NEXTHOP_TYPE_IPV6_IFINDEX:
435 p.family = AF_INET6;
436 memcpy(&p.u.prefix6, &nhop->gate.ipv6, 16);
437 p.prefixlen = 128;
438 break;
439 }
440
441 if (zclient_send_rnh(zclient, command, &p,
442 false, nhop->vrf_id) < 0) {
443 zlog_warn("%s: Failure to send nexthop to zebra",
444 __PRETTY_FUNCTION__);
445 }
446}
447
448static void pbr_encode_pbr_map_sequence_prefix(struct stream *s,
449 struct prefix *p,
49027ce8 450 unsigned char family)
e5c83d9b
DS
451{
452 struct prefix any;
453
454 if (!p) {
455 memset(&any, 0, sizeof(any));
456 any.family = family;
457 p = &any;
458 }
459
460 stream_putc(s, p->family);
461 stream_putc(s, p->prefixlen);
462 stream_put(s, &p->u.prefix, prefix_blen(p));
463}
464
465static void pbr_encode_pbr_map_sequence(struct stream *s,
466 struct pbr_map_sequence *pbrms,
467 struct interface *ifp)
468{
49027ce8 469 unsigned char family;
e5c83d9b
DS
470
471 family = AF_INET;
49027ce8
DS
472 if (pbrms->family)
473 family = pbrms->family;
e5c83d9b
DS
474
475 stream_putl(s, pbrms->seqno);
476 stream_putl(s, pbrms->ruleno);
477 stream_putl(s, pbrms->unique);
478 pbr_encode_pbr_map_sequence_prefix(s, pbrms->src, family);
479 stream_putw(s, 0); /* src port */
480 pbr_encode_pbr_map_sequence_prefix(s, pbrms->dst, family);
481 stream_putw(s, 0); /* dst port */
482 if (pbrms->nhgrp_name)
483 stream_putl(s, pbr_nht_get_table(pbrms->nhgrp_name));
484 else if (pbrms->nhg)
485 stream_putl(s, pbr_nht_get_table(pbrms->internal_nhg_name));
486 stream_putl(s, ifp->ifindex);
487}
488
b13e5ad6
DS
489void pbr_send_pbr_map(struct pbr_map_sequence *pbrms,
490 struct pbr_map_interface *pmi, bool install)
e5c83d9b 491{
b13e5ad6 492 struct pbr_map *pbrm = pbrms->parent;
e5c83d9b 493 struct stream *s;
10a00758 494 uint64_t is_installed = (uint64_t)1 << pmi->install_bit;
37c606ff
DS
495
496 is_installed &= pbrms->installed;
e5c83d9b 497
37c606ff
DS
498 DEBUGD(&pbr_dbg_zebra, "%s: for %s %d(%" PRIu64 ")",
499 __PRETTY_FUNCTION__, pbrm->name, install, is_installed);
9b71ea4b
DS
500
501 /*
502 * If we are installed and asked to do so again
503 * just return. If we are not installed and asked
504 * and asked to delete just return;
505 */
37c606ff 506 if (install && is_installed)
9b71ea4b
DS
507 return;
508
37c606ff 509 if (!install && !is_installed)
9b71ea4b 510 return;
e5c83d9b
DS
511
512 s = zclient->obuf;
513 stream_reset(s);
514
515 zclient_create_header(s,
516 install ? ZEBRA_RULE_ADD : ZEBRA_RULE_DELETE,
517 VRF_DEFAULT);
518
b13e5ad6
DS
519 /*
520 * We are sending one item at a time at the moment
521 */
522 stream_putl(s, 1);
e5c83d9b 523
b13e5ad6
DS
524 DEBUGD(&pbr_dbg_zebra, "%s: \t%s %s %d %s %u",
525 __PRETTY_FUNCTION__, install ? "Installing" : "Deleting",
526 pbrm->name, install, pmi->ifp->name, pmi->delete);
e5c83d9b 527
b13e5ad6 528 pbr_encode_pbr_map_sequence(s, pbrms, pmi->ifp);
e5c83d9b 529
e5c83d9b
DS
530 stream_putw_at(s, 0, stream_get_endp(s));
531
e5c83d9b
DS
532 zclient_send_message(zclient);
533}