[mirror_frr.git] / bgpd / bgp_zebra.c

/* zebra client
 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <zebra.h>

#include "command.h"
#include "stream.h"
#include "network.h"
#include "prefix.h"
#include "log.h"
#include "sockunion.h"
#include "zclient.h"
#include "routemap.h"
#include "thread.h"
#include "queue.h"
#include "memory.h"
#include "lib/json.h"
#include "lib/bfd.h"
#include "filter.h"
#include "mpls.h"
#include "vxlan.h"

#include "bgpd/bgpd.h"
#include "bgpd/bgp_route.h"
#include "bgpd/bgp_attr.h"
#include "bgpd/bgp_nexthop.h"
#include "bgpd/bgp_zebra.h"
#include "bgpd/bgp_fsm.h"
#include "bgpd/bgp_debug.h"
#include "bgpd/bgp_errors.h"
#include "bgpd/bgp_mpath.h"
#include "bgpd/bgp_nexthop.h"
#include "bgpd/bgp_nht.h"
#include "bgpd/bgp_bfd.h"
#include "bgpd/bgp_label.h"
#if ENABLE_BGP_VNC
#include "bgpd/rfapi/rfapi_backend.h"
#include "bgpd/rfapi/vnc_export_bgp.h"
#endif
#include "bgpd/bgp_evpn.h"
#include "bgpd/bgp_mplsvpn.h"
#include "bgpd/bgp_labelpool.h"
#include "bgpd/bgp_pbr.h"

/* All information about zebra. */
struct zclient *zclient = NULL;

/* Can we install into zebra? */
static inline int bgp_install_info_to_zebra(struct bgp *bgp)
{
        if (zclient->sock <= 0)
                return 0;

        if (!IS_BGP_INST_KNOWN_TO_ZEBRA(bgp))
                return 0;

        return 1;
}

int zclient_num_connects;

/* Router-id update message from zebra. */
static int bgp_router_id_update(int command, struct zclient *zclient,
                                zebra_size_t length, vrf_id_t vrf_id)
{
        struct prefix router_id;

        zebra_router_id_update_read(zclient->ibuf, &router_id);

        if (BGP_DEBUG(zebra, ZEBRA)) {
                char buf[PREFIX2STR_BUFFER];
                prefix2str(&router_id, buf, sizeof(buf));
                zlog_debug("Rx Router Id update VRF %u Id %s", vrf_id, buf);
        }

        bgp_router_id_zebra_bump(vrf_id, &router_id);
        return 0;
}

/* Nexthop update message from zebra. */
static int bgp_read_nexthop_update(int command, struct zclient *zclient,
                                   zebra_size_t length, vrf_id_t vrf_id)
{
        bgp_parse_nexthop_update(command, vrf_id);
        return 0;
}

static int bgp_read_import_check_update(int command, struct zclient *zclient,
                                        zebra_size_t length, vrf_id_t vrf_id)
{
        bgp_parse_nexthop_update(command, vrf_id);
        return 0;
}

/* Set or clear interface on which unnumbered neighbor is configured. This
 * would in turn cause BGP to initiate or turn off IPv6 RAs on this
 * interface.
 */
static void bgp_update_interface_nbrs(struct bgp *bgp, struct interface *ifp,
                                      struct interface *upd_ifp)
{
        struct listnode *node, *nnode;
        struct peer *peer;

        for (ALL_LIST_ELEMENTS(bgp->peer, node, nnode, peer)) {
                if (peer->conf_if && (strcmp(peer->conf_if, ifp->name) == 0)) {
                        if (upd_ifp) {
                                peer->ifp = upd_ifp;
                                bgp_zebra_initiate_radv(bgp, peer);
                        } else {
                                bgp_zebra_terminate_radv(bgp, peer);
                                peer->ifp = upd_ifp;
                        }
                }
        }
}

static int bgp_read_fec_update(int command, struct zclient *zclient,
                               zebra_size_t length)
{
        bgp_parse_fec_update();
        return 0;
}

static void bgp_start_interface_nbrs(struct bgp *bgp, struct interface *ifp)
{
        struct listnode *node, *nnode;
        struct peer *peer;

        for (ALL_LIST_ELEMENTS(bgp->peer, node, nnode, peer)) {
                if (peer->conf_if && (strcmp(peer->conf_if, ifp->name) == 0)
                    && peer->status != Established) {
                        if (peer_active(peer))
                                BGP_EVENT_ADD(peer, BGP_Stop);
                        BGP_EVENT_ADD(peer, BGP_Start);
                }
        }
}

static void bgp_nbr_connected_add(struct bgp *bgp, struct nbr_connected *ifc)
{
        struct listnode *node;
        struct connected *connected;
        struct interface *ifp;
        struct prefix *p;

        /* Kick-off the FSM for any relevant peers only if there is a
         * valid local address on the interface.
         */
        ifp = ifc->ifp;
        for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected)) {
                p = connected->address;
                if (p->family == AF_INET6
                    && IN6_IS_ADDR_LINKLOCAL(&p->u.prefix6))
                        break;
        }
        if (!connected)
                return;

        bgp_start_interface_nbrs(bgp, ifp);
}

static void bgp_nbr_connected_delete(struct bgp *bgp, struct nbr_connected *ifc,
                                     int del)
{
        struct listnode *node, *nnode;
        struct peer *peer;
        struct interface *ifp;

        for (ALL_LIST_ELEMENTS(bgp->peer, node, nnode, peer)) {
                if (peer->conf_if
                    && (strcmp(peer->conf_if, ifc->ifp->name) == 0)) {
                        peer->last_reset = PEER_DOWN_NBR_ADDR_DEL;
                        BGP_EVENT_ADD(peer, BGP_Stop);
                }
        }
        /* Free neighbor also, if we're asked to. */
        if (del) {
                ifp = ifc->ifp;
                listnode_delete(ifp->nbr_connected, ifc);
                nbr_connected_free(ifc);
        }
}

/* Inteface addition message from zebra. */
static int bgp_interface_add(int command, struct zclient *zclient,
                             zebra_size_t length, vrf_id_t vrf_id)
{
        struct interface *ifp;
        struct bgp *bgp;

        ifp = zebra_interface_add_read(zclient->ibuf, vrf_id);
        if (!ifp) // unexpected
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA) && ifp)
                zlog_debug("Rx Intf add VRF %u IF %s", vrf_id, ifp->name);

        bgp = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp)
                return 0;

        bgp_update_interface_nbrs(bgp, ifp, ifp);
        return 0;
}

static int bgp_interface_delete(int command, struct zclient *zclient,
                                zebra_size_t length, vrf_id_t vrf_id)
{
        struct stream *s;
        struct interface *ifp;
        struct bgp *bgp;

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        s = zclient->ibuf;
        ifp = zebra_interface_state_read(s, vrf_id);
        if (!ifp) /* This may happen if we've just unregistered for a VRF. */
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx Intf del VRF %u IF %s", vrf_id, ifp->name);

        if (bgp)
                bgp_update_interface_nbrs(bgp, ifp, NULL);

        if_set_index(ifp, IFINDEX_INTERNAL);
        return 0;
}

static int bgp_interface_up(int command, struct zclient *zclient,
                            zebra_size_t length, vrf_id_t vrf_id)
{
        struct stream *s;
        struct interface *ifp;
        struct connected *c;
        struct nbr_connected *nc;
        struct listnode *node, *nnode;
        struct bgp *bgp;

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        s = zclient->ibuf;
        ifp = zebra_interface_state_read(s, vrf_id);

        if (!ifp)
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx Intf up VRF %u IF %s", vrf_id, ifp->name);

        if (!bgp)
                return 0;

        for (ALL_LIST_ELEMENTS(ifp->connected, node, nnode, c))
                bgp_connected_add(bgp, c);

        for (ALL_LIST_ELEMENTS(ifp->nbr_connected, node, nnode, nc))
                bgp_nbr_connected_add(bgp, nc);

        return 0;
}

static int bgp_interface_down(int command, struct zclient *zclient,
                              zebra_size_t length, vrf_id_t vrf_id)
{
        struct stream *s;
        struct interface *ifp;
        struct connected *c;
        struct nbr_connected *nc;
        struct listnode *node, *nnode;
        struct bgp *bgp;
        struct peer *peer;

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        s = zclient->ibuf;
        ifp = zebra_interface_state_read(s, vrf_id);
        if (!ifp)
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx Intf down VRF %u IF %s", vrf_id, ifp->name);

        if (!bgp)
                return 0;

        for (ALL_LIST_ELEMENTS(ifp->connected, node, nnode, c))
                bgp_connected_delete(bgp, c);

        for (ALL_LIST_ELEMENTS(ifp->nbr_connected, node, nnode, nc))
                bgp_nbr_connected_delete(bgp, nc, 1);

        /* Fast external-failover */
        if (!CHECK_FLAG(bgp->flags, BGP_FLAG_NO_FAST_EXT_FAILOVER)) {

                for (ALL_LIST_ELEMENTS(bgp->peer, node, nnode, peer)) {
#if defined(HAVE_CUMULUS)
                        /* Take down directly connected EBGP peers as well as
                         * 1-hop BFD
                         * tracked (directly connected) IBGP peers.
                         */
                        if ((peer->ttl != 1) && (peer->gtsm_hops != 1)
                            && (!peer->bfd_info
                                || bgp_bfd_is_peer_multihop(peer)))
#else
                        /* Take down directly connected EBGP peers */
                        if ((peer->ttl != 1) && (peer->gtsm_hops != 1))
#endif
                                continue;

                        if (ifp == peer->nexthop.ifp) {
                                BGP_EVENT_ADD(peer, BGP_Stop);
                                peer->last_reset = PEER_DOWN_IF_DOWN;
                        }
                }
        }

        return 0;
}

static int bgp_interface_address_add(int command, struct zclient *zclient,
                                     zebra_size_t length, vrf_id_t vrf_id)
{
        struct connected *ifc;
        struct bgp *bgp;

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        ifc = zebra_interface_address_read(command, zclient->ibuf, vrf_id);

        if (ifc == NULL)
                return 0;

        if (bgp_debug_zebra(ifc->address)) {
                char buf[PREFIX2STR_BUFFER];
                prefix2str(ifc->address, buf, sizeof(buf));
                zlog_debug("Rx Intf address add VRF %u IF %s addr %s", vrf_id,
                           ifc->ifp->name, buf);
        }

        if (!bgp)
                return 0;

        if (if_is_operative(ifc->ifp)) {
                bgp_connected_add(bgp, ifc);

                /* If we have learnt of any neighbors on this interface,
                 * check to kick off any BGP interface-based neighbors,
                 * but only if this is a link-local address.
                 */
                if (IN6_IS_ADDR_LINKLOCAL(&ifc->address->u.prefix6)
                    && !list_isempty(ifc->ifp->nbr_connected))
                        bgp_start_interface_nbrs(bgp, ifc->ifp);
        }

        return 0;
}

static int bgp_interface_address_delete(int command, struct zclient *zclient,
                                        zebra_size_t length, vrf_id_t vrf_id)
{
        struct connected *ifc;
        struct bgp *bgp;

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        ifc = zebra_interface_address_read(command, zclient->ibuf, vrf_id);

        if (ifc == NULL)
                return 0;

        if (bgp_debug_zebra(ifc->address)) {
                char buf[PREFIX2STR_BUFFER];
                prefix2str(ifc->address, buf, sizeof(buf));
                zlog_debug("Rx Intf address del VRF %u IF %s addr %s", vrf_id,
                           ifc->ifp->name, buf);
        }

        if (bgp && if_is_operative(ifc->ifp)) {
                bgp_connected_delete(bgp, ifc);
        }

        connected_free(ifc);

        return 0;
}

static int bgp_interface_nbr_address_add(int command, struct zclient *zclient,
                                         zebra_size_t length, vrf_id_t vrf_id)
{
        struct nbr_connected *ifc = NULL;
        struct bgp *bgp;

        ifc = zebra_interface_nbr_address_read(command, zclient->ibuf, vrf_id);

        if (ifc == NULL)
                return 0;

        if (bgp_debug_zebra(ifc->address)) {
                char buf[PREFIX2STR_BUFFER];
                prefix2str(ifc->address, buf, sizeof(buf));
                zlog_debug("Rx Intf neighbor add VRF %u IF %s addr %s", vrf_id,
                           ifc->ifp->name, buf);
        }

        if (if_is_operative(ifc->ifp)) {
                bgp = bgp_lookup_by_vrf_id(vrf_id);
                if (bgp)
                        bgp_nbr_connected_add(bgp, ifc);
        }

        return 0;
}

static int bgp_interface_nbr_address_delete(int command,
                                            struct zclient *zclient,
                                            zebra_size_t length,
                                            vrf_id_t vrf_id)
{
        struct nbr_connected *ifc = NULL;
        struct bgp *bgp;

        ifc = zebra_interface_nbr_address_read(command, zclient->ibuf, vrf_id);

        if (ifc == NULL)
                return 0;

        if (bgp_debug_zebra(ifc->address)) {
                char buf[PREFIX2STR_BUFFER];
                prefix2str(ifc->address, buf, sizeof(buf));
                zlog_debug("Rx Intf neighbor del VRF %u IF %s addr %s", vrf_id,
                           ifc->ifp->name, buf);
        }

        if (if_is_operative(ifc->ifp)) {
                bgp = bgp_lookup_by_vrf_id(vrf_id);
                if (bgp)
                        bgp_nbr_connected_delete(bgp, ifc, 0);
        }

        nbr_connected_free(ifc);

        return 0;
}

/* VRF update for an interface. */
static int bgp_interface_vrf_update(int command, struct zclient *zclient,
                                    zebra_size_t length, vrf_id_t vrf_id)
{
        struct interface *ifp;
        vrf_id_t new_vrf_id;
        struct connected *c;
        struct nbr_connected *nc;
        struct listnode *node, *nnode;
        struct bgp *bgp;
        struct peer *peer;

        ifp = zebra_interface_vrf_update_read(zclient->ibuf, vrf_id,
                                              &new_vrf_id);
        if (!ifp)
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA) && ifp)
                zlog_debug("Rx Intf VRF change VRF %u IF %s NewVRF %u", vrf_id,
                           ifp->name, new_vrf_id);

        bgp = bgp_lookup_by_vrf_id(vrf_id);

        if (bgp) {
                for (ALL_LIST_ELEMENTS(ifp->connected, node, nnode, c))
                        bgp_connected_delete(bgp, c);

                for (ALL_LIST_ELEMENTS(ifp->nbr_connected, node, nnode, nc))
                        bgp_nbr_connected_delete(bgp, nc, 1);

                /* Fast external-failover */
                if (!CHECK_FLAG(bgp->flags, BGP_FLAG_NO_FAST_EXT_FAILOVER)) {
                        for (ALL_LIST_ELEMENTS(bgp->peer, node, nnode, peer)) {
                                if ((peer->ttl != 1) && (peer->gtsm_hops != 1))
                                        continue;

                                if (ifp == peer->nexthop.ifp)
                                        BGP_EVENT_ADD(peer, BGP_Stop);
                        }
                }
        }

        if_update_to_new_vrf(ifp, new_vrf_id);

        bgp = bgp_lookup_by_vrf_id(new_vrf_id);
        if (!bgp)
                return 0;

        for (ALL_LIST_ELEMENTS(ifp->connected, node, nnode, c))
                bgp_connected_add(bgp, c);

        for (ALL_LIST_ELEMENTS(ifp->nbr_connected, node, nnode, nc))
                bgp_nbr_connected_add(bgp, nc);
        return 0;
}

/* Zebra route add and delete treatment. */
static int zebra_read_route(int command, struct zclient *zclient,
                            zebra_size_t length, vrf_id_t vrf_id)
{
        enum nexthop_types_t nhtype;
        struct zapi_route api;
        union g_addr nexthop;
        ifindex_t ifindex;
        int add, i;
        struct bgp *bgp;

        bgp = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp)
                return 0;

        if (zapi_route_decode(zclient->ibuf, &api) < 0)
                return -1;

        /* we completely ignore srcdest routes for now. */
        if (CHECK_FLAG(api.message, ZAPI_MESSAGE_SRCPFX))
                return 0;

        /* ignore link-local address. */
        if (api.prefix.family == AF_INET6
            && IN6_IS_ADDR_LINKLOCAL(&api.prefix.u.prefix6))
                return 0;

        nexthop = api.nexthops[0].gate;
        ifindex = api.nexthops[0].ifindex;
        nhtype = api.nexthops[0].type;

        add = (command == ZEBRA_REDISTRIBUTE_ROUTE_ADD);
        if (add) {
                /*
                 * The ADD message is actually an UPDATE and there is no
                 * explicit DEL
                 * for a prior redistributed route, if any. So, perform an
                 * implicit
                 * DEL processing for the same redistributed route from any
                 * other
                 * source type.
                 */
                for (i = 0; i < ZEBRA_ROUTE_MAX; i++) {
                        if (i != api.type)
                                bgp_redistribute_delete(bgp, &api.prefix, i,
                                                        api.instance);
                }

                /* Now perform the add/update. */
                bgp_redistribute_add(bgp, &api.prefix, &nexthop, ifindex,
                                     nhtype, api.metric, api.type, api.instance,
                                     api.tag);
        } else {
                bgp_redistribute_delete(bgp, &api.prefix, api.type,
                                        api.instance);
        }

        if (bgp_debug_zebra(&api.prefix)) {
                char buf[2][PREFIX_STRLEN];

                prefix2str(&api.prefix, buf[0], sizeof(buf[0]));
                if (add) {
                        inet_ntop(api.prefix.family, &nexthop, buf[1],
                                  sizeof(buf[1]));
                        zlog_debug(
                                "Rx route ADD VRF %u %s[%d] %s nexthop %s (type %d if %u) metric %u tag %" ROUTE_TAG_PRI,
                                vrf_id, zebra_route_string(api.type),
                                api.instance, buf[0], buf[1], nhtype,
                                ifindex, api.metric, api.tag);
                } else {
                        zlog_debug(
                                "Rx route DEL VRF %u %s[%d] %s",
                                vrf_id, zebra_route_string(api.type),
                                api.instance, buf[0]);
                }
        }

        return 0;
}

struct interface *if_lookup_by_ipv4(struct in_addr *addr, vrf_id_t vrf_id)
{
        struct vrf *vrf;
        struct listnode *cnode;
        struct interface *ifp;
        struct connected *connected;
        struct prefix_ipv4 p;
        struct prefix *cp;

        vrf = vrf_lookup_by_id(vrf_id);
        if (!vrf)
                return NULL;

        p.family = AF_INET;
        p.prefix = *addr;
        p.prefixlen = IPV4_MAX_BITLEN;

        FOR_ALL_INTERFACES (vrf, ifp) {
                for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                        cp = connected->address;

                        if (cp->family == AF_INET)
                                if (prefix_match(cp, (struct prefix *)&p))
                                        return ifp;
                }
        }
        return NULL;
}

struct interface *if_lookup_by_ipv4_exact(struct in_addr *addr, vrf_id_t vrf_id)
{
        struct vrf *vrf;
        struct listnode *cnode;
        struct interface *ifp;
        struct connected *connected;
        struct prefix *cp;

        vrf = vrf_lookup_by_id(vrf_id);
        if (!vrf)
                return NULL;

        FOR_ALL_INTERFACES (vrf, ifp) {
                for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                        cp = connected->address;

                        if (cp->family == AF_INET)
                                if (IPV4_ADDR_SAME(&cp->u.prefix4, addr))
                                        return ifp;
                }
        }
        return NULL;
}

struct interface *if_lookup_by_ipv6(struct in6_addr *addr, ifindex_t ifindex,
                                    vrf_id_t vrf_id)
{
        struct vrf *vrf;
        struct listnode *cnode;
        struct interface *ifp;
        struct connected *connected;
        struct prefix_ipv6 p;
        struct prefix *cp;

        vrf = vrf_lookup_by_id(vrf_id);
        if (!vrf)
                return NULL;

        p.family = AF_INET6;
        p.prefix = *addr;
        p.prefixlen = IPV6_MAX_BITLEN;

        FOR_ALL_INTERFACES (vrf, ifp) {
                for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                        cp = connected->address;

                        if (cp->family == AF_INET6)
                                if (prefix_match(cp, (struct prefix *)&p)) {
                                        if (IN6_IS_ADDR_LINKLOCAL(
                                                    &cp->u.prefix6)) {
                                                if (ifindex == ifp->ifindex)
                                                        return ifp;
                                        } else
                                                return ifp;
                                }
                }
        }
        return NULL;
}

struct interface *if_lookup_by_ipv6_exact(struct in6_addr *addr,
                                          ifindex_t ifindex, vrf_id_t vrf_id)
{
        struct vrf *vrf;
        struct listnode *cnode;
        struct interface *ifp;
        struct connected *connected;
        struct prefix *cp;

        vrf = vrf_lookup_by_id(vrf_id);
        if (!vrf)
                return NULL;

        FOR_ALL_INTERFACES (vrf, ifp) {
                for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                        cp = connected->address;

                        if (cp->family == AF_INET6)
                                if (IPV6_ADDR_SAME(&cp->u.prefix6, addr)) {
                                        if (IN6_IS_ADDR_LINKLOCAL(
                                                    &cp->u.prefix6)) {
                                                if (ifindex == ifp->ifindex)
                                                        return ifp;
                                        } else
                                                return ifp;
                                }
                }
        }
        return NULL;
}

static int if_get_ipv6_global(struct interface *ifp, struct in6_addr *addr)
{
        struct listnode *cnode;
        struct connected *connected;
        struct prefix *cp;

        for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                cp = connected->address;

                if (cp->family == AF_INET6)
                        if (!IN6_IS_ADDR_LINKLOCAL(&cp->u.prefix6)) {
                                memcpy(addr, &cp->u.prefix6, IPV6_MAX_BYTELEN);
                                return 1;
                        }
        }
        return 0;
}

static int if_get_ipv6_local(struct interface *ifp, struct in6_addr *addr)
{
        struct listnode *cnode;
        struct connected *connected;
        struct prefix *cp;

        for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                cp = connected->address;

                if (cp->family == AF_INET6)
                        if (IN6_IS_ADDR_LINKLOCAL(&cp->u.prefix6)) {
                                memcpy(addr, &cp->u.prefix6, IPV6_MAX_BYTELEN);
                                return 1;
                        }
        }
        return 0;
}

static int if_get_ipv4_address(struct interface *ifp, struct in_addr *addr)
{
        struct listnode *cnode;
        struct connected *connected;
        struct prefix *cp;

        for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected)) {
                cp = connected->address;
                if ((cp->family == AF_INET)
                    && !ipv4_martian(&(cp->u.prefix4))) {
                        *addr = cp->u.prefix4;
                        return 1;
                }
        }
        return 0;
}


bool bgp_zebra_nexthop_set(union sockunion *local, union sockunion *remote,
                           struct bgp_nexthop *nexthop, struct peer *peer)
{
        int ret = 0;
        struct interface *ifp = NULL;

        memset(nexthop, 0, sizeof(struct bgp_nexthop));

        if (!local)
                return false;
        if (!remote)
                return false;

        if (local->sa.sa_family == AF_INET) {
                nexthop->v4 = local->sin.sin_addr;
                if (peer->update_if)
                        ifp = if_lookup_by_name(peer->update_if,
                                                peer->bgp->vrf_id);
                else
                        ifp = if_lookup_by_ipv4_exact(&local->sin.sin_addr,
                                                      peer->bgp->vrf_id);
        }
        if (local->sa.sa_family == AF_INET6) {
                if (IN6_IS_ADDR_LINKLOCAL(&local->sin6.sin6_addr)) {
                        if (peer->conf_if || peer->ifname)
                                ifp = if_lookup_by_name(peer->conf_if
                                                                ? peer->conf_if
                                                                : peer->ifname,
                                                        peer->bgp->vrf_id);
                } else if (peer->update_if)
                        ifp = if_lookup_by_name(peer->update_if,
                                                peer->bgp->vrf_id);
                else
                        ifp = if_lookup_by_ipv6_exact(&local->sin6.sin6_addr,
                                                      local->sin6.sin6_scope_id,
                                                      peer->bgp->vrf_id);
        }

        if (!ifp) {
                /*
                 * BGP views do not currently get proper data
                 * from zebra( when attached ) to be able to
                 * properly resolve nexthops, so give this
                 * instance type a pass.
                 */
                if (peer->bgp->inst_type == BGP_INSTANCE_TYPE_VIEW)
                        return true;
                /*
                 * If we have no interface data but we have established
                 * some connection w/ zebra than something has gone
                 * terribly terribly wrong here, so say this failed
                 * If we do not any zebra connection then not
                 * having a ifp pointer is ok.
                 */
                return zclient_num_connects ? false : true;
        }

        nexthop->ifp = ifp;

        /* IPv4 connection, fetch and store IPv6 local address(es) if any. */
        if (local->sa.sa_family == AF_INET) {
                /* IPv6 nexthop*/
                ret = if_get_ipv6_global(ifp, &nexthop->v6_global);

                if (!ret) {
                        /* There is no global nexthop. Use link-local address as
                         * both the
                         * global and link-local nexthop. In this scenario, the
                         * expectation
                         * for interop is that the network admin would use a
                         * route-map to
                         * specify the global IPv6 nexthop.
                         */
                        if_get_ipv6_local(ifp, &nexthop->v6_global);
                        memcpy(&nexthop->v6_local, &nexthop->v6_global,
                               IPV6_MAX_BYTELEN);
                } else
                        if_get_ipv6_local(ifp, &nexthop->v6_local);

                if (if_lookup_by_ipv4(&remote->sin.sin_addr, peer->bgp->vrf_id))
                        peer->shared_network = 1;
                else
                        peer->shared_network = 0;
        }

        /* IPv6 connection, fetch and store IPv4 local address if any. */
        if (local->sa.sa_family == AF_INET6) {
                struct interface *direct = NULL;

                /* IPv4 nexthop. */
                ret = if_get_ipv4_address(ifp, &nexthop->v4);
                if (!ret && peer->local_id.s_addr)
                        nexthop->v4 = peer->local_id;

                /* Global address*/
                if (!IN6_IS_ADDR_LINKLOCAL(&local->sin6.sin6_addr)) {
                        memcpy(&nexthop->v6_global, &local->sin6.sin6_addr,
                               IPV6_MAX_BYTELEN);

                        /* If directory connected set link-local address. */
                        direct = if_lookup_by_ipv6(&remote->sin6.sin6_addr,
                                                   remote->sin6.sin6_scope_id,
                                                   peer->bgp->vrf_id);
                        if (direct)
                                if_get_ipv6_local(ifp, &nexthop->v6_local);
                } else
                /* Link-local address. */
                {
                        ret = if_get_ipv6_global(ifp, &nexthop->v6_global);

                        /* If there is no global address.  Set link-local
                           address as
                           global.  I know this break RFC specification... */
                        /* In this scenario, the expectation for interop is that
                         * the
                         * network admin would use a route-map to specify the
                         * global
                         * IPv6 nexthop.
                         */
                        if (!ret)
                                memcpy(&nexthop->v6_global,
                                       &local->sin6.sin6_addr,
                                       IPV6_MAX_BYTELEN);
                        /* Always set the link-local address */
                        memcpy(&nexthop->v6_local, &local->sin6.sin6_addr,
                               IPV6_MAX_BYTELEN);
                }

                if (IN6_IS_ADDR_LINKLOCAL(&local->sin6.sin6_addr)
                    || if_lookup_by_ipv6(&remote->sin6.sin6_addr,
                                         remote->sin6.sin6_scope_id,
                                         peer->bgp->vrf_id))
                        peer->shared_network = 1;
                else
                        peer->shared_network = 0;
        }

/* KAME stack specific treatment.  */
#ifdef KAME
        if (IN6_IS_ADDR_LINKLOCAL(&nexthop->v6_global)
            && IN6_LINKLOCAL_IFINDEX(nexthop->v6_global)) {
                SET_IN6_LINKLOCAL_IFINDEX(nexthop->v6_global, 0);
        }
        if (IN6_IS_ADDR_LINKLOCAL(&nexthop->v6_local)
            && IN6_LINKLOCAL_IFINDEX(nexthop->v6_local)) {
                SET_IN6_LINKLOCAL_IFINDEX(nexthop->v6_local, 0);
        }
#endif /* KAME */

        /* If we have identified the local interface, there is no error for now.
         */
        return true;
}

static struct in6_addr *
bgp_path_info_to_ipv6_nexthop(struct bgp_path_info *info, ifindex_t *ifindex)
{
        struct in6_addr *nexthop = NULL;

        /* Only global address nexthop exists. */
        if (info->attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV6_GLOBAL) {
                nexthop = &info->attr->mp_nexthop_global;
                if (IN6_IS_ADDR_LINKLOCAL(nexthop))
                        *ifindex = info->attr->nh_ifindex;

        }

        /* If both global and link-local address present. */
        if (info->attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL) {
                /* Check if route-map is set to prefer global over link-local */
                if (info->attr->mp_nexthop_prefer_global) {
                        nexthop = &info->attr->mp_nexthop_global;
                        if (IN6_IS_ADDR_LINKLOCAL(nexthop))
                                *ifindex = info->attr->nh_ifindex;
                } else {
                        /* Workaround for Cisco's nexthop bug.  */
                        if (IN6_IS_ADDR_UNSPECIFIED(
                                    &info->attr->mp_nexthop_global)
                            && info->peer->su_remote->sa.sa_family
                                       == AF_INET6) {
                                nexthop =
                                        &info->peer->su_remote->sin6.sin6_addr;
                                if (IN6_IS_ADDR_LINKLOCAL(nexthop))
                                        *ifindex = info->peer->nexthop.ifp
                                                           ->ifindex;
                        } else {
                                nexthop = &info->attr->mp_nexthop_local;
                                if (IN6_IS_ADDR_LINKLOCAL(nexthop))
                                        *ifindex = info->attr->nh_lla_ifindex;
                        }
                }
        }

        return nexthop;
}

static int bgp_table_map_apply(struct route_map *map, struct prefix *p,
                               struct bgp_path_info *info)
{
        route_map_result_t ret;

        ret = route_map_apply(map, p, RMAP_BGP, info);
        bgp_attr_flush(info->attr);

        if (ret != RMAP_DENYMATCH)
                return 1;

        if (bgp_debug_zebra(p)) {
                if (p->family == AF_INET) {
                        char buf[2][INET_ADDRSTRLEN];
                        zlog_debug(
                                "Zebra rmap deny: IPv4 route %s/%d nexthop %s",
                                inet_ntop(AF_INET, &p->u.prefix4, buf[0],
                                          sizeof(buf[0])),
                                p->prefixlen,
                                inet_ntop(AF_INET, &info->attr->nexthop, buf[1],
                                          sizeof(buf[1])));
                }
                if (p->family == AF_INET6) {
                        char buf[2][INET6_ADDRSTRLEN];
                        ifindex_t ifindex;
                        struct in6_addr *nexthop;

                        nexthop = bgp_path_info_to_ipv6_nexthop(info, &ifindex);
                        zlog_debug(
                                "Zebra rmap deny: IPv6 route %s/%d nexthop %s",
                                inet_ntop(AF_INET6, &p->u.prefix6, buf[0],
                                          sizeof(buf[0])),
                                p->prefixlen,
                                inet_ntop(AF_INET6, nexthop,
                                          buf[1], sizeof(buf[1])));
                }
        }
        return 0;
}

static struct thread *bgp_tm_thread_connect;
static bool bgp_tm_status_connected;
static bool bgp_tm_chunk_obtained;
#define BGP_FLOWSPEC_TABLE_CHUNK 100000
static uint32_t bgp_tm_min, bgp_tm_max, bgp_tm_chunk_size;
struct bgp *bgp_tm_bgp;

static int bgp_zebra_tm_connect(struct thread *t)
{
        struct zclient *zclient;
        int delay = 10, ret = 0;

        zclient = THREAD_ARG(t);
        if (bgp_tm_status_connected && zclient->sock > 0)
                delay = 60;
        else {
                bgp_tm_status_connected = false;
                ret = tm_table_manager_connect(zclient);
        }
        if (ret < 0) {
                zlog_info("Error connecting to table manager!");
                bgp_tm_status_connected = false;
        } else {
                if (!bgp_tm_status_connected)
                        zlog_debug("Connecting to table manager. Success");
                bgp_tm_status_connected = true;
                if (!bgp_tm_chunk_obtained) {
                        if (bgp_zebra_get_table_range(bgp_tm_chunk_size,
                                                      &bgp_tm_min,
                                                      &bgp_tm_max) >= 0) {
                                bgp_tm_chunk_obtained = true;
                                /* parse non installed entries */
                                bgp_zebra_announce_table(bgp_tm_bgp, AFI_IP, SAFI_FLOWSPEC);
                        }
                }
        }
        thread_add_timer(bm->master, bgp_zebra_tm_connect, zclient, delay,
                         &bgp_tm_thread_connect);
        return 0;
}

bool bgp_zebra_tm_chunk_obtained(void)
{
        return bgp_tm_chunk_obtained;
}

uint32_t bgp_zebra_tm_get_id(void)
{
        static int table_id;

        if (!bgp_tm_chunk_obtained)
                return ++table_id;
        return bgp_tm_min++;
}

void bgp_zebra_init_tm_connect(struct bgp *bgp)
{
        int delay = 1;

        /* if already set, do nothing
         */
        if (bgp_tm_thread_connect != NULL)
                return;
        bgp_tm_status_connected = false;
        bgp_tm_chunk_obtained = false;
        bgp_tm_min = bgp_tm_max = 0;
        bgp_tm_chunk_size = BGP_FLOWSPEC_TABLE_CHUNK;
        bgp_tm_bgp = bgp;
        thread_add_timer(bm->master, bgp_zebra_tm_connect, zclient, delay,
                         &bgp_tm_thread_connect);
}

int bgp_zebra_get_table_range(uint32_t chunk_size,
                              uint32_t *start, uint32_t *end)
{
        int ret;

        if (!bgp_tm_status_connected)
                return -1;
        ret = tm_get_table_chunk(zclient, chunk_size, start, end);
        if (ret < 0) {
                flog_err(EC_BGP_TABLE_CHUNK,
                         "BGP: Error getting table chunk %u", chunk_size);
                return -1;
        }
        zlog_info("BGP: Table Manager returns range from chunk %u is [%u %u]",
                 chunk_size, *start, *end);
        return 0;
}

static int update_ipv4nh_for_route_install(int nh_othervrf,
                                           struct in_addr *nexthop,
                                           struct attr *attr,
                                           bool is_evpn,
                                           struct zapi_nexthop *api_nh)
{
        api_nh->gate.ipv4 = *nexthop;

        /* Need to set fields appropriately for EVPN routes imported into
         * a VRF (which are programmed as onlink on l3-vni SVI) as well as
         * connected routes leaked into a VRF.
         */
        if (is_evpn)
                api_nh->type = NEXTHOP_TYPE_IPV4_IFINDEX;
        else if (nh_othervrf &&
                 api_nh->gate.ipv4.s_addr == INADDR_ANY) {
                api_nh->type = NEXTHOP_TYPE_IFINDEX;
                api_nh->ifindex = attr->nh_ifindex;
        } else
                api_nh->type = NEXTHOP_TYPE_IPV4;

        return 1;
}

static int
update_ipv6nh_for_route_install(int nh_othervrf, struct in6_addr *nexthop,
                                ifindex_t ifindex, struct bgp_path_info *ri,
                                struct bgp_path_info *best_ri, bool is_evpn,
                                struct zapi_nexthop *api_nh)
{
        struct attr *attr;

        attr = ri->attr;

        if (is_evpn)
                api_nh->type = NEXTHOP_TYPE_IPV6_IFINDEX;
        else if (nh_othervrf) {
                if (IN6_IS_ADDR_UNSPECIFIED(nexthop)) {
                        api_nh->type = NEXTHOP_TYPE_IFINDEX;
                        api_nh->ifindex = attr->nh_ifindex;
                } else if (IN6_IS_ADDR_LINKLOCAL(nexthop)) {
                        if (ifindex == 0)
                                return 0;
                        api_nh->type = NEXTHOP_TYPE_IPV6_IFINDEX;
                        api_nh->ifindex = ifindex;
                } else {
                        api_nh->type = NEXTHOP_TYPE_IPV6;
                        api_nh->ifindex = 0;
                }
        } else {
                if (IN6_IS_ADDR_LINKLOCAL(nexthop)) {
                        if (ri == best_ri &&
                            attr->mp_nexthop_len
                                == BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL)
                                if (ri->peer->nexthop.ifp)
                                        ifindex = ri->peer->nexthop.ifp
                                                                ->ifindex;
                        if (!ifindex) {
                                if (ri->peer->conf_if)
                                        ifindex = ri->peer->ifp->ifindex;
                                else if (ri->peer->ifname)
                                        ifindex = ifname2ifindex(
                                                        ri->peer->ifname,
                                                        ri->peer->bgp->vrf_id);
                                else if (ri->peer->nexthop.ifp)
                                        ifindex = ri->peer->nexthop.ifp
                                                                ->ifindex;
                        }

                        if (ifindex == 0)
                                return 0;
                        api_nh->type = NEXTHOP_TYPE_IPV6_IFINDEX;
                        api_nh->ifindex = ifindex;
                } else {
                        api_nh->type = NEXTHOP_TYPE_IPV6;
                        api_nh->ifindex = 0;
                }
        }
        api_nh->gate.ipv6 = *nexthop;

        return 1;
}

void bgp_zebra_announce(struct bgp_node *rn, struct prefix *p,
                        struct bgp_path_info *info, struct bgp *bgp, afi_t afi,
                        safi_t safi)
{
        struct zapi_route api;
        struct zapi_nexthop *api_nh;
        int nh_family;
        unsigned int valid_nh_count = 0;
        int has_valid_label = 0;
        uint8_t distance;
        struct peer *peer;
        struct bgp_path_info *mpinfo;
        uint32_t metric;
        struct attr local_attr;
        struct bgp_path_info local_info;
        struct bgp_path_info *mpinfo_cp = &local_info;
        route_tag_t tag;
        mpls_label_t label;
        int nh_othervrf = 0;
        char buf_prefix[PREFIX_STRLEN]; /* filled in if we are debugging */
        bool is_evpn;
        int nh_updated;

        /* Don't try to install if we're not connected to Zebra or Zebra doesn't
         * know of this instance.
         */
        if (!bgp_install_info_to_zebra(bgp))
                return;

        if (bgp->main_zebra_update_hold)
                return;

        if (bgp_debug_zebra(p))
                prefix2str(p, buf_prefix, sizeof(buf_prefix));

        if (safi == SAFI_FLOWSPEC)
                return bgp_pbr_update_entry(bgp, &rn->p,
                                            info, afi, safi, true);

        /*
         * vrf leaking support (will have only one nexthop)
         */
        if (info->extra && info->extra->bgp_orig)
                nh_othervrf = 1;

        /* Make Zebra API structure. */
        memset(&api, 0, sizeof(api));
        api.vrf_id = bgp->vrf_id;
        api.type = ZEBRA_ROUTE_BGP;
        api.safi = safi;
        api.prefix = *p;
        SET_FLAG(api.message, ZAPI_MESSAGE_NEXTHOP);

        peer = info->peer;

        if (info->type == ZEBRA_ROUTE_BGP
            && info->sub_type == BGP_ROUTE_IMPORTED) {

                /* Obtain peer from parent */
                if (info->extra && info->extra->parent)
                        peer = ((struct bgp_path_info *)(info->extra->parent))
                                       ->peer;
        }

        tag = info->attr->tag;

        /* If the route's source is EVPN, flag as such. */
        is_evpn = is_route_parent_evpn(info);
        if (is_evpn)
                SET_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE);

        if (peer->sort == BGP_PEER_IBGP || peer->sort == BGP_PEER_CONFED
            || info->sub_type == BGP_ROUTE_AGGREGATE) {
                SET_FLAG(api.flags, ZEBRA_FLAG_IBGP);
                SET_FLAG(api.flags, ZEBRA_FLAG_ALLOW_RECURSION);
        }

        if ((peer->sort == BGP_PEER_EBGP && peer->ttl != 1)
            || CHECK_FLAG(peer->flags, PEER_FLAG_DISABLE_CONNECTED_CHECK)
            || bgp_flag_check(bgp, BGP_FLAG_DISABLE_NH_CONNECTED_CHK))

                SET_FLAG(api.flags, ZEBRA_FLAG_ALLOW_RECURSION);

        /* Metric is currently based on the best-path only */
        metric = info->attr->med;
        for (mpinfo = info; mpinfo; mpinfo = bgp_path_info_mpath_next(mpinfo)) {
                if (valid_nh_count >= multipath_num)
                        break;

                *mpinfo_cp = *mpinfo;

                /* Get nexthop address-family */
                if (p->family == AF_INET
                    && !BGP_ATTR_NEXTHOP_AFI_IP6(mpinfo_cp->attr))
                        nh_family = AF_INET;
                else if (p->family == AF_INET6
                         || (p->family == AF_INET
                             && BGP_ATTR_NEXTHOP_AFI_IP6(mpinfo_cp->attr)))
                        nh_family = AF_INET6;
                else
                        continue;

                api_nh = &api.nexthops[valid_nh_count];
                api_nh->vrf_id = nh_othervrf ? info->extra->bgp_orig->vrf_id
                                             : bgp->vrf_id;
                if (nh_family == AF_INET) {
                        if (bgp_debug_zebra(&api.prefix)) {
                                if (mpinfo->extra) {
                                        zlog_debug(
                                                "%s: p=%s, bgp_is_valid_label: %d",
                                                __func__, buf_prefix,
                                                bgp_is_valid_label(
                                                        &mpinfo->extra
                                                                 ->label[0]));
                                } else {
                                        zlog_debug(
                                                "%s: p=%s, extra is NULL, no label",
                                                __func__, buf_prefix);
                                }
                        }

                        if (bgp->table_map[afi][safi].name) {
                                /* Copy info and attributes, so the route-map
                                   apply doesn't modify the BGP route info. */
                                local_attr = *mpinfo->attr;
                                mpinfo_cp->attr = &local_attr;
                        }

                        if (bgp->table_map[afi][safi].name) {
                                if (!bgp_table_map_apply(
                                            bgp->table_map[afi][safi].map, p,
                                            mpinfo_cp))
                                        continue;

                                /* metric/tag is only allowed to be
                                 * overridden on 1st nexthop */
                                if (mpinfo == info) {
                                        metric = mpinfo_cp->attr->med;
                                        tag = mpinfo_cp->attr->tag;
                                }
                        }

                        nh_updated = update_ipv4nh_for_route_install(
                                        nh_othervrf,
                                        &mpinfo_cp->attr->nexthop,
                                        mpinfo_cp->attr, is_evpn, api_nh);
                } else {
                        ifindex_t ifindex = IFINDEX_INTERNAL;
                        struct in6_addr *nexthop;

                        if (bgp->table_map[afi][safi].name) {
                                /* Copy info and attributes, so the route-map
                                   apply doesn't modify the BGP route info. */
                                local_attr = *mpinfo->attr;
                                mpinfo_cp->attr = &local_attr;
                        }

                        if (bgp->table_map[afi][safi].name) {
                                /* Copy info and attributes, so the route-map
                                   apply doesn't modify the BGP route info. */
                                local_attr = *mpinfo->attr;
                                mpinfo_cp->attr = &local_attr;

                                if (!bgp_table_map_apply(
                                            bgp->table_map[afi][safi].map, p,
                                            mpinfo_cp))
                                        continue;

                                /* metric/tag is only allowed to be
                                 * overridden on 1st nexthop */
                                if (mpinfo == info) {
                                        metric = mpinfo_cp->attr->med;
                                        tag = mpinfo_cp->attr->tag;
                                }
                        }
                        nexthop = bgp_path_info_to_ipv6_nexthop(mpinfo_cp,
                                                                &ifindex);
                        nh_updated = update_ipv6nh_for_route_install(
                                        nh_othervrf, nexthop, ifindex,
                                        mpinfo, info, is_evpn, api_nh);
                }

                /* Did we get proper nexthop info to update zebra? */
                if (!nh_updated)
                        continue;

                if (mpinfo->extra
                    && bgp_is_valid_label(&mpinfo->extra->label[0])
                    && !CHECK_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE)) {
                        has_valid_label = 1;
                        label = label_pton(&mpinfo->extra->label[0]);

                        api_nh->label_num = 1;
                        api_nh->labels[0] = label;
                }
                memcpy(&api_nh->rmac, &(mpinfo->attr->rmac),
                       sizeof(struct ethaddr));
                valid_nh_count++;
        }


        /* if this is a evpn route we don't have to include the label */
        if (has_valid_label && !(CHECK_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE)))
                SET_FLAG(api.message, ZAPI_MESSAGE_LABEL);

        /*
         * When we create an aggregate route we must also
         * install a Null0 route in the RIB, so overwrite
         * what was written into api with a blackhole route
         */
        if (info->sub_type == BGP_ROUTE_AGGREGATE)
                zapi_route_set_blackhole(&api, BLACKHOLE_NULL);
        else
                api.nexthop_num = valid_nh_count;

        SET_FLAG(api.message, ZAPI_MESSAGE_METRIC);
        api.metric = metric;

        if (tag) {
                SET_FLAG(api.message, ZAPI_MESSAGE_TAG);
                api.tag = tag;
        }

        distance = bgp_distance_apply(p, info, afi, safi, bgp);
        if (distance) {
                SET_FLAG(api.message, ZAPI_MESSAGE_DISTANCE);
                api.distance = distance;
        }

        if (bgp_debug_zebra(p)) {
                char prefix_buf[PREFIX_STRLEN];
                char nh_buf[INET6_ADDRSTRLEN];
                char label_buf[20];
                int i;

                prefix2str(&api.prefix, prefix_buf, sizeof(prefix_buf));
                zlog_debug("Tx route %s VRF %u %s metric %u tag %" ROUTE_TAG_PRI
                           " count %d",
                           valid_nh_count ? "add" : "delete", bgp->vrf_id,
                           prefix_buf, api.metric, api.tag, api.nexthop_num);
                for (i = 0; i < api.nexthop_num; i++) {
                        api_nh = &api.nexthops[i];

                        if (api_nh->type == NEXTHOP_TYPE_IFINDEX)
                                nh_buf[0] = '\0';
                        else {
                                if (api_nh->type == NEXTHOP_TYPE_IPV4)
                                        nh_family = AF_INET;
                                else
                                        nh_family = AF_INET6;
                                inet_ntop(nh_family, &api_nh->gate, nh_buf,
                                          sizeof(nh_buf));
                        }

                        label_buf[0] = '\0';
                        if (has_valid_label
                            && !CHECK_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE))
                                sprintf(label_buf, "label %u",
                                        api_nh->labels[0]);
                        zlog_debug("  nhop [%d]: %s if %u VRF %u %s",
                                   i + 1, nh_buf, api_nh->ifindex,
                                   api_nh->vrf_id, label_buf);
                }
        }

        if (bgp_debug_zebra(p)) {
                int recursion_flag = 0;

                if (CHECK_FLAG(api.flags, ZEBRA_FLAG_ALLOW_RECURSION))
                        recursion_flag = 1;

                zlog_debug("%s: %s: announcing to zebra (recursion %sset)",
                        __func__, buf_prefix,
                        (recursion_flag ? "" : "NOT "));
        }
        zclient_route_send(valid_nh_count ? ZEBRA_ROUTE_ADD
                                          : ZEBRA_ROUTE_DELETE,
                           zclient, &api);
}

/* Announce all routes of a table to zebra */
void bgp_zebra_announce_table(struct bgp *bgp, afi_t afi, safi_t safi)
{
        struct bgp_node *rn;
        struct bgp_table *table;
        struct bgp_path_info *ri;

        /* Don't try to install if we're not connected to Zebra or Zebra doesn't
         * know of this instance.
         */
        if (!bgp_install_info_to_zebra(bgp))
                return;

        table = bgp->rib[afi][safi];
        if (!table)
                return;

        for (rn = bgp_table_top(table); rn; rn = bgp_route_next(rn))
                for (ri = rn->info; ri; ri = ri->next)
                        if (CHECK_FLAG(ri->flags, BGP_PATH_SELECTED) &&

                            (ri->type == ZEBRA_ROUTE_BGP
                             && (ri->sub_type == BGP_ROUTE_NORMAL
                                 || ri->sub_type == BGP_ROUTE_IMPORTED)))

                                bgp_zebra_announce(rn, &rn->p, ri, bgp, afi,
                                                   safi);
}

void bgp_zebra_withdraw(struct prefix *p, struct bgp_path_info *info,
                        struct bgp *bgp, safi_t safi)
{
        struct zapi_route api;
        struct peer *peer;

        /* Don't try to install if we're not connected to Zebra or Zebra doesn't
         * know of this instance.
         */
        if (!bgp_install_info_to_zebra(bgp))
                return;

        if (safi == SAFI_FLOWSPEC) {
                peer = info->peer;
                return bgp_pbr_update_entry(peer->bgp, p,
                                            info, AFI_IP, safi, false);
        }

        memset(&api, 0, sizeof(api));
        api.vrf_id = bgp->vrf_id;
        api.type = ZEBRA_ROUTE_BGP;
        api.safi = safi;
        api.prefix = *p;

        /* If the route's source is EVPN, flag as such. */
        if (is_route_parent_evpn(info))
                SET_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE);

        if (bgp_debug_zebra(p)) {
                char buf[PREFIX_STRLEN];

                prefix2str(&api.prefix, buf, sizeof(buf));
                zlog_debug("Tx route delete VRF %u %s", bgp->vrf_id, buf);
        }

        zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
}

struct bgp_redist *bgp_redist_lookup(struct bgp *bgp, afi_t afi, uint8_t type,
                                     unsigned short instance)
{
        struct list *red_list;
        struct listnode *node;
        struct bgp_redist *red;

        red_list = bgp->redist[afi][type];
        if (!red_list)
                return (NULL);

        for (ALL_LIST_ELEMENTS_RO(red_list, node, red))
                if (red->instance == instance)
                        return red;

        return NULL;
}

struct bgp_redist *bgp_redist_add(struct bgp *bgp, afi_t afi, uint8_t type,
                                  unsigned short instance)
{
        struct list *red_list;
        struct bgp_redist *red;

        red = bgp_redist_lookup(bgp, afi, type, instance);
        if (red)
                return red;

        if (!bgp->redist[afi][type])
                bgp->redist[afi][type] = list_new();

        red_list = bgp->redist[afi][type];
        red = (struct bgp_redist *)XCALLOC(MTYPE_BGP_REDIST,
                                           sizeof(struct bgp_redist));
        red->instance = instance;

        listnode_add(red_list, red);

        return red;
}

static void bgp_redist_del(struct bgp *bgp, afi_t afi, uint8_t type,
                           unsigned short instance)
{
        struct bgp_redist *red;

        red = bgp_redist_lookup(bgp, afi, type, instance);

        if (red) {
                listnode_delete(bgp->redist[afi][type], red);
                XFREE(MTYPE_BGP_REDIST, red);
                if (!bgp->redist[afi][type]->count)
                        list_delete(&bgp->redist[afi][type]);
        }
}

/* Other routes redistribution into BGP. */
int bgp_redistribute_set(struct bgp *bgp, afi_t afi, int type,
                         unsigned short instance, bool changed)
{
        /* If redistribute options are changed call
         * bgp_redistribute_unreg() to reset the option and withdraw
         * the routes
         */
        if (changed)
                bgp_redistribute_unreg(bgp, afi, type, instance);

        /* Return if already redistribute flag is set. */
        if (instance) {
                if (redist_check_instance(&zclient->mi_redist[afi][type],
                                          instance))
                        return CMD_WARNING;

                redist_add_instance(&zclient->mi_redist[afi][type], instance);
        } else {
                if (vrf_bitmap_check(zclient->redist[afi][type], bgp->vrf_id))
                        return CMD_WARNING;

#if ENABLE_BGP_VNC
                if (bgp->vrf_id == VRF_DEFAULT
                    && type == ZEBRA_ROUTE_VNC_DIRECT) {
                        vnc_export_bgp_enable(
                                bgp, afi); /* only enables if mode bits cfg'd */
                }
#endif

                vrf_bitmap_set(zclient->redist[afi][type], bgp->vrf_id);
        }

        /*
         * Don't try to register if we're not connected to Zebra or Zebra
         * doesn't know of this instance.
         *
         * When we come up later well resend if needed.
         */
        if (!bgp_install_info_to_zebra(bgp))
                return CMD_SUCCESS;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Tx redistribute add VRF %u afi %d %s %d",
                           bgp->vrf_id, afi, zebra_route_string(type),
                           instance);

        /* Send distribute add message to zebra. */
        zebra_redistribute_send(ZEBRA_REDISTRIBUTE_ADD, zclient, afi, type,
                                instance, bgp->vrf_id);

        return CMD_SUCCESS;
}

int bgp_redistribute_resend(struct bgp *bgp, afi_t afi, int type,
                            unsigned short instance)
{
        /* Don't try to send if we're not connected to Zebra or Zebra doesn't
         * know of this instance.
         */
        if (!bgp_install_info_to_zebra(bgp))
                return -1;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Tx redistribute del/add VRF %u afi %d %s %d",
                           bgp->vrf_id, afi, zebra_route_string(type),
                           instance);

        /* Send distribute add message to zebra. */
        zebra_redistribute_send(ZEBRA_REDISTRIBUTE_DELETE, zclient, afi, type,
                                instance, bgp->vrf_id);
        zebra_redistribute_send(ZEBRA_REDISTRIBUTE_ADD, zclient, afi, type,
                                instance, bgp->vrf_id);

        return 0;
}

/* Redistribute with route-map specification.  */
int bgp_redistribute_rmap_set(struct bgp_redist *red, const char *name)
{
        if (red->rmap.name && (strcmp(red->rmap.name, name) == 0))
                return 0;

        if (red->rmap.name)
                XFREE(MTYPE_ROUTE_MAP_NAME, red->rmap.name);
        red->rmap.name = XSTRDUP(MTYPE_ROUTE_MAP_NAME, name);
        red->rmap.map = route_map_lookup_by_name(name);

        return 1;
}

/* Redistribute with metric specification.  */
int bgp_redistribute_metric_set(struct bgp *bgp, struct bgp_redist *red,
                                afi_t afi, int type, uint32_t metric)
{
        struct bgp_node *rn;
        struct bgp_path_info *ri;

        if (red->redist_metric_flag && red->redist_metric == metric)
                return 0;

        red->redist_metric_flag = 1;
        red->redist_metric = metric;

        for (rn = bgp_table_top(bgp->rib[afi][SAFI_UNICAST]); rn;
             rn = bgp_route_next(rn)) {
                for (ri = rn->info; ri; ri = ri->next) {
                        if (ri->sub_type == BGP_ROUTE_REDISTRIBUTE
                            && ri->type == type
                            && ri->instance == red->instance) {
                                struct attr *old_attr;
                                struct attr new_attr;

                                bgp_attr_dup(&new_attr, ri->attr);
                                new_attr.med = red->redist_metric;
                                old_attr = ri->attr;
                                ri->attr = bgp_attr_intern(&new_attr);
                                bgp_attr_unintern(&old_attr);

                                bgp_path_info_set_flag(rn, ri,
                                                       BGP_PATH_ATTR_CHANGED);
                                bgp_process(bgp, rn, afi, SAFI_UNICAST);
                        }
                }
        }

        return 1;
}

/* Unset redistribution.  */
int bgp_redistribute_unreg(struct bgp *bgp, afi_t afi, int type,
                           unsigned short instance)
{
        struct bgp_redist *red;

        red = bgp_redist_lookup(bgp, afi, type, instance);
        if (!red)
                return CMD_SUCCESS;

        /* Return if zebra connection is disabled. */
        if (instance) {
                if (!redist_check_instance(&zclient->mi_redist[afi][type],
                                           instance))
                        return CMD_WARNING;
                redist_del_instance(&zclient->mi_redist[afi][type], instance);
        } else {
                if (!vrf_bitmap_check(zclient->redist[afi][type], bgp->vrf_id))
                        return CMD_WARNING;
                vrf_bitmap_unset(zclient->redist[afi][type], bgp->vrf_id);
        }


        if (bgp_install_info_to_zebra(bgp)) {
                /* Send distribute delete message to zebra. */
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("Tx redistribute del VRF %u afi %d %s %d",
                                   bgp->vrf_id, afi, zebra_route_string(type),
                                   instance);
                zebra_redistribute_send(ZEBRA_REDISTRIBUTE_DELETE, zclient, afi,
                                        type, instance, bgp->vrf_id);
        }

        /* Withdraw redistributed routes from current BGP's routing table. */
        bgp_redistribute_withdraw(bgp, afi, type, instance);

        return CMD_SUCCESS;
}

/* Unset redistribution.  */
int bgp_redistribute_unset(struct bgp *bgp, afi_t afi, int type,
                           unsigned short instance)
{
        struct bgp_redist *red;

/*
 * vnc and vpn->vrf checks must be before red check because
 * they operate within bgpd irrespective of zebra connection
 * status. red lookup fails if there is no zebra connection.
 */
#if ENABLE_BGP_VNC
        if (bgp->vrf_id == VRF_DEFAULT && type == ZEBRA_ROUTE_VNC_DIRECT) {
                vnc_export_bgp_disable(bgp, afi);
        }
#endif

        red = bgp_redist_lookup(bgp, afi, type, instance);
        if (!red)
                return CMD_SUCCESS;

        bgp_redistribute_unreg(bgp, afi, type, instance);

        /* Unset route-map. */
        if (red->rmap.name)
                XFREE(MTYPE_ROUTE_MAP_NAME, red->rmap.name);
        red->rmap.name = NULL;
        red->rmap.map = NULL;

        /* Unset metric. */
        red->redist_metric_flag = 0;
        red->redist_metric = 0;

        bgp_redist_del(bgp, afi, type, instance);

        return CMD_SUCCESS;
}

/* Update redistribute vrf bitmap during triggers like
   restart networking or delete/add VRFs */
void bgp_update_redist_vrf_bitmaps(struct bgp *bgp, vrf_id_t old_vrf_id)
{
        int i;
        afi_t afi;

        for (afi = AFI_IP; afi < AFI_MAX; afi++)
                for (i = 0; i < ZEBRA_ROUTE_MAX; i++)
                        if ((old_vrf_id == VRF_UNKNOWN)
                            || vrf_bitmap_check(zclient->redist[afi][i],
                                                old_vrf_id)) {
                                vrf_bitmap_unset(zclient->redist[afi][i],
                                                 old_vrf_id);
                                vrf_bitmap_set(zclient->redist[afi][i],
                                               bgp->vrf_id);
                        }
        return;
}

void bgp_zclient_reset(void)
{
        zclient_reset(zclient);
}

/* Register this instance with Zebra. Invoked upon connect (for
 * default instance) and when other VRFs are learnt (or created and
 * already learnt).
 */
void bgp_zebra_instance_register(struct bgp *bgp)
{
        /* Don't try to register if we're not connected to Zebra */
        if (!zclient || zclient->sock < 0)
                return;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Registering VRF %u", bgp->vrf_id);

        /* Register for router-id, interfaces, redistributed routes. */
        zclient_send_reg_requests(zclient, bgp->vrf_id);

        /* For default instance, register to learn about VNIs, if appropriate.
         */
        if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT && is_evpn_enabled())
                bgp_zebra_advertise_all_vni(bgp, 1);
}

/* Deregister this instance with Zebra. Invoked upon the instance
 * being deleted (default or VRF) and it is already registered.
 */
void bgp_zebra_instance_deregister(struct bgp *bgp)
{
        /* Don't try to deregister if we're not connected to Zebra */
        if (zclient->sock < 0)
                return;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Deregistering VRF %u", bgp->vrf_id);

        /* For default instance, unregister learning about VNIs, if appropriate.
         */
        if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT && is_evpn_enabled())
                bgp_zebra_advertise_all_vni(bgp, 0);

        /* Deregister for router-id, interfaces, redistributed routes. */
        zclient_send_dereg_requests(zclient, bgp->vrf_id);
}

void bgp_zebra_initiate_radv(struct bgp *bgp, struct peer *peer)
{
        int ra_interval = BGP_UNNUM_DEFAULT_RA_INTERVAL;

        /* Don't try to initiate if we're not connected to Zebra */
        if (zclient->sock < 0)
                return;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%u: Initiating RA for peer %s", bgp->vrf_id,
                           peer->host);

        zclient_send_interface_radv_req(zclient, bgp->vrf_id, peer->ifp, 1,
                                        ra_interval);
}

void bgp_zebra_terminate_radv(struct bgp *bgp, struct peer *peer)
{
        /* Don't try to terminate if we're not connected to Zebra */
        if (zclient->sock < 0)
                return;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%u: Terminating RA for peer %s", bgp->vrf_id,
                           peer->host);

        zclient_send_interface_radv_req(zclient, bgp->vrf_id, peer->ifp, 0, 0);
}

int bgp_zebra_advertise_subnet(struct bgp *bgp, int advertise, vni_t vni)
{
        struct stream *s = NULL;

        /* Check socket. */
        if (!zclient || zclient->sock < 0)
                return 0;

        /* Don't try to register if Zebra doesn't know of this instance. */
        if (!IS_BGP_INST_KNOWN_TO_ZEBRA(bgp))
                return 0;

        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s, ZEBRA_ADVERTISE_SUBNET, bgp->vrf_id);
        stream_putc(s, advertise);
        stream_put3(s, vni);
        stream_putw_at(s, 0, stream_get_endp(s));

        return zclient_send_message(zclient);
}

int bgp_zebra_advertise_gw_macip(struct bgp *bgp, int advertise, vni_t vni)
{
        struct stream *s = NULL;

        /* Check socket. */
        if (!zclient || zclient->sock < 0)
                return 0;

        /* Don't try to register if Zebra doesn't know of this instance. */
        if (!IS_BGP_INST_KNOWN_TO_ZEBRA(bgp))
                return 0;

        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s, ZEBRA_ADVERTISE_DEFAULT_GW, bgp->vrf_id);
        stream_putc(s, advertise);
        stream_putl(s, vni);
        stream_putw_at(s, 0, stream_get_endp(s));

        return zclient_send_message(zclient);
}

int bgp_zebra_advertise_all_vni(struct bgp *bgp, int advertise)
{
        struct stream *s;

        /* Check socket. */
        if (!zclient || zclient->sock < 0)
                return 0;

        /* Don't try to register if Zebra doesn't know of this instance. */
        if (!IS_BGP_INST_KNOWN_TO_ZEBRA(bgp))
                return 0;

        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s, ZEBRA_ADVERTISE_ALL_VNI, bgp->vrf_id);
        stream_putc(s, advertise);
        stream_putw_at(s, 0, stream_get_endp(s));

        return zclient_send_message(zclient);
}

static int rule_notify_owner(int command, struct zclient *zclient,
                             zebra_size_t length, vrf_id_t vrf_id)
{
        uint32_t seqno, priority, unique;
        enum zapi_rule_notify_owner note;
        struct bgp_pbr_action *bgp_pbra;
        ifindex_t ifi;

        if (!zapi_rule_notify_decode(zclient->ibuf, &seqno, &priority, &unique,
                                     &ifi, &note))
                return -1;

        bgp_pbra = bgp_pbr_action_rule_lookup(vrf_id, unique);
        if (!bgp_pbra) {
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Fail to look BGP rule (%u)",
                                   __PRETTY_FUNCTION__, unique);
                return 0;
        }

        switch (note) {
        case ZAPI_RULE_FAIL_INSTALL:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received RULE_FAIL_INSTALL",
                                   __PRETTY_FUNCTION__);
                bgp_pbra->installed = false;
                bgp_pbra->install_in_progress = false;
                break;
        case ZAPI_RULE_INSTALLED:
                bgp_pbra->installed = true;
                bgp_pbra->install_in_progress = false;
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received RULE_INSTALLED",
                                   __PRETTY_FUNCTION__);
                break;
        case ZAPI_RULE_FAIL_REMOVE:
        case ZAPI_RULE_REMOVED:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received RULE REMOVED",
                                   __PRETTY_FUNCTION__);
                break;
        }

        return 0;
}

static int ipset_notify_owner(int command, struct zclient *zclient,
                             zebra_size_t length, vrf_id_t vrf_id)
{
        uint32_t unique;
        enum zapi_ipset_notify_owner note;
        struct bgp_pbr_match *bgp_pbim;

        if (!zapi_ipset_notify_decode(zclient->ibuf,
                                      &unique,
                                      &note))
                return -1;

        bgp_pbim = bgp_pbr_match_ipset_lookup(vrf_id, unique);
        if (!bgp_pbim) {
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Fail to look BGP match ( %u, ID %u)",
                                   __PRETTY_FUNCTION__, note, unique);
                return 0;
        }

        switch (note) {
        case ZAPI_IPSET_FAIL_INSTALL:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET_FAIL_INSTALL",
                                   __PRETTY_FUNCTION__);
                bgp_pbim->installed = false;
                bgp_pbim->install_in_progress = false;
                break;
        case ZAPI_IPSET_INSTALLED:
                bgp_pbim->installed = true;
                bgp_pbim->install_in_progress = false;
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET_INSTALLED",
                                   __PRETTY_FUNCTION__);
                break;
        case ZAPI_IPSET_FAIL_REMOVE:
        case ZAPI_IPSET_REMOVED:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET REMOVED",
                                   __PRETTY_FUNCTION__);
                break;
        }

        return 0;
}

static int ipset_entry_notify_owner(int command, struct zclient *zclient,
                                    zebra_size_t length, vrf_id_t vrf_id)
{
        uint32_t unique;
        char ipset_name[ZEBRA_IPSET_NAME_SIZE];
        enum zapi_ipset_entry_notify_owner note;
        struct bgp_pbr_match_entry *bgp_pbime;

        if (!zapi_ipset_entry_notify_decode(
                                zclient->ibuf,
                                &unique,
                                ipset_name,
                                &note))
                return -1;
        bgp_pbime = bgp_pbr_match_ipset_entry_lookup(vrf_id,
                                                     ipset_name,
                                                     unique);
        if (!bgp_pbime) {
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Fail to look BGP match entry (%u, ID %u)",
                                   __PRETTY_FUNCTION__, note, unique);
                return 0;
        }

        switch (note) {
        case ZAPI_IPSET_ENTRY_FAIL_INSTALL:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET_ENTRY_FAIL_INSTALL",
                                   __PRETTY_FUNCTION__);
                bgp_pbime->installed = false;
                bgp_pbime->install_in_progress = false;
                break;
        case ZAPI_IPSET_ENTRY_INSTALLED:
                {
                struct bgp_path_info *path;
                struct bgp_path_info_extra *extra;

                bgp_pbime->installed = true;
                bgp_pbime->install_in_progress = false;
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET_ENTRY_INSTALLED",
                                   __PRETTY_FUNCTION__);
                /* link bgp_path_info to bpme */
                path = (struct bgp_path_info *)bgp_pbime->path;
                extra = bgp_path_info_extra_get(path);
                if (extra->bgp_fs_pbr == NULL)
                        extra->bgp_fs_pbr = list_new();
                listnode_add(extra->bgp_fs_pbr, bgp_pbime);
                }
                break;
        case ZAPI_IPSET_ENTRY_FAIL_REMOVE:
        case ZAPI_IPSET_ENTRY_REMOVED:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPSET_ENTRY_REMOVED",
                                   __PRETTY_FUNCTION__);
                break;
        }
        return 0;
}

static int iptable_notify_owner(int command, struct zclient *zclient,
                                zebra_size_t length, vrf_id_t vrf_id)
{
        uint32_t unique;
        enum zapi_iptable_notify_owner note;
        struct bgp_pbr_match *bgpm;

        if (!zapi_iptable_notify_decode(
                                        zclient->ibuf,
                                        &unique,
                                        &note))
                return -1;
        bgpm = bgp_pbr_match_iptable_lookup(vrf_id, unique);
        if (!bgpm) {
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Fail to look BGP iptable (%u %u)",
                                   __PRETTY_FUNCTION__, note, unique);
                return 0;
        }
        switch (note) {
        case ZAPI_IPTABLE_FAIL_INSTALL:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPTABLE_FAIL_INSTALL",
                                   __PRETTY_FUNCTION__);
                bgpm->installed_in_iptable = false;
                bgpm->install_iptable_in_progress = false;
                break;
        case ZAPI_IPTABLE_INSTALLED:
                bgpm->installed_in_iptable = true;
                bgpm->install_iptable_in_progress = false;
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPTABLE_INSTALLED",
                                   __PRETTY_FUNCTION__);
                bgpm->action->refcnt++;
                break;
        case ZAPI_IPTABLE_FAIL_REMOVE:
        case ZAPI_IPTABLE_REMOVED:
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_debug("%s: Received IPTABLE REMOVED",
                                   __PRETTY_FUNCTION__);
                break;
        }
        return 0;
}

static void bgp_encode_pbr_rule_action(struct stream *s,
                                  struct bgp_pbr_action *pbra)
{
        struct prefix any;

        stream_putl(s, 0); /* seqno unused */
        stream_putl(s, 0); /* ruleno unused */

        stream_putl(s, pbra->unique);

        memset(&any, 0, sizeof(any));
        any.family = AF_INET;
        stream_putc(s, any.family);
        stream_putc(s, any.prefixlen);
        stream_put(s, &any.u.prefix, prefix_blen(&any));

        stream_putw(s, 0);  /* src port */

        stream_putc(s, any.family);
        stream_putc(s, any.prefixlen);
        stream_put(s, &any.u.prefix, prefix_blen(&any));

        stream_putw(s, 0);  /* dst port */

        stream_putl(s, pbra->fwmark);  /* fwmark */

        stream_putl(s, pbra->table_id);

        stream_putl(s, 0); /* ifindex unused */
}

static void bgp_encode_pbr_ipset_match(struct stream *s,
                                  struct bgp_pbr_match *pbim)
{
        stream_putl(s, pbim->unique);
        stream_putl(s, pbim->type);

        stream_put(s, pbim->ipset_name,
                   ZEBRA_IPSET_NAME_SIZE);
}

static void bgp_encode_pbr_ipset_entry_match(struct stream *s,
                                  struct bgp_pbr_match_entry *pbime)
{
        stream_putl(s, pbime->unique);
        /* check that back pointer is not null */
        stream_put(s, pbime->backpointer->ipset_name,
                   ZEBRA_IPSET_NAME_SIZE);

        stream_putc(s, pbime->src.family);
        stream_putc(s, pbime->src.prefixlen);
        stream_put(s, &pbime->src.u.prefix, prefix_blen(&pbime->src));

        stream_putc(s, pbime->dst.family);
        stream_putc(s, pbime->dst.prefixlen);
        stream_put(s, &pbime->dst.u.prefix, prefix_blen(&pbime->dst));

        stream_putw(s, pbime->src_port_min);
        stream_putw(s, pbime->src_port_max);
        stream_putw(s, pbime->dst_port_min);
        stream_putw(s, pbime->dst_port_max);
        stream_putc(s, pbime->proto);
}

static void bgp_encode_pbr_iptable_match(struct stream *s,
                                         struct bgp_pbr_action *bpa,
                                         struct bgp_pbr_match *pbm)
{
        stream_putl(s, pbm->unique2);

        stream_putl(s, pbm->type);

        stream_putl(s, pbm->flags);

        /* TODO: correlate with what is contained
         * into bgp_pbr_action.
         * currently only forward supported
         */
        if (bpa->nh.type == NEXTHOP_TYPE_BLACKHOLE)
                stream_putl(s, ZEBRA_IPTABLES_DROP);
        else
                stream_putl(s, ZEBRA_IPTABLES_FORWARD);
        stream_putl(s, bpa->fwmark);
        stream_put(s, pbm->ipset_name,
                   ZEBRA_IPSET_NAME_SIZE);
        stream_putw(s, pbm->pkt_len_min);
        stream_putw(s, pbm->pkt_len_max);
        stream_putw(s, pbm->tcp_flags);
        stream_putw(s, pbm->tcp_mask_flags);
        stream_putc(s, pbm->dscp_value);
        stream_putc(s, pbm->fragment);
}

/* BGP has established connection with Zebra. */
static void bgp_zebra_connected(struct zclient *zclient)
{
        struct bgp *bgp;

        zclient_num_connects++; /* increment even if not responding */

        /* At this point, we may or may not have BGP instances configured, but
         * we're only interested in the default VRF (others wouldn't have learnt
         * the VRF from Zebra yet.)
         */
        bgp = bgp_get_default();
        if (!bgp)
                return;

        bgp_zebra_instance_register(bgp);

        /* Send the client registration */
        bfd_client_sendmsg(zclient, ZEBRA_BFD_CLIENT_REGISTER);

        /* tell label pool that zebra is connected */
        bgp_lp_event_zebra_up();

        /* TODO - What if we have peers and networks configured, do we have to
         * kick-start them?
         */
}

static int bgp_zebra_process_local_es(int cmd, struct zclient *zclient,
                                      zebra_size_t length, vrf_id_t vrf_id)
{
        esi_t esi;
        struct bgp *bgp = NULL;
        struct stream *s = NULL;
        char buf[ESI_STR_LEN];
        char buf1[INET6_ADDRSTRLEN];
        struct ipaddr originator_ip;

        memset(&esi, 0, sizeof(esi_t));
        memset(&originator_ip, 0, sizeof(struct ipaddr));

        bgp = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp)
                return 0;

        s = zclient->ibuf;
        stream_get(&esi, s, sizeof(esi_t));
        stream_get(&originator_ip, s, sizeof(struct ipaddr));

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx %s ESI %s originator-ip %s",
                           (cmd == ZEBRA_LOCAL_ES_ADD) ? "add" : "del",
                           esi_to_str(&esi, buf, sizeof(buf)),
                           ipaddr2str(&originator_ip, buf1, sizeof(buf1)));

        if (cmd == ZEBRA_LOCAL_ES_ADD)
                bgp_evpn_local_es_add(bgp, &esi, &originator_ip);
        else
                bgp_evpn_local_es_del(bgp, &esi, &originator_ip);
        return 0;
}

static int bgp_zebra_process_local_l3vni(int cmd, struct zclient *zclient,
                                         zebra_size_t length, vrf_id_t vrf_id)
{
        int filter = 0;
        char buf[ETHER_ADDR_STRLEN];
        vni_t l3vni = 0;
        struct ethaddr rmac;
        struct in_addr originator_ip;
        struct stream *s;

        memset(&rmac, 0, sizeof(struct ethaddr));
        memset(&originator_ip, 0, sizeof(struct in_addr));
        s = zclient->ibuf;
        l3vni = stream_getl(s);
        if (cmd == ZEBRA_L3VNI_ADD) {
                stream_get(&rmac, s, sizeof(struct ethaddr));
                originator_ip.s_addr = stream_get_ipv4(s);
                stream_get(&filter, s, sizeof(int));
        }

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx L3-VNI %s VRF %s VNI %u RMAC %s filter %s",
                           (cmd == ZEBRA_L3VNI_ADD) ? "add" : "del",
                           vrf_id_to_name(vrf_id), l3vni,
                           prefix_mac2str(&rmac, buf, sizeof(buf)),
                           filter ? "prefix-routes-only" : "none");

        if (cmd == ZEBRA_L3VNI_ADD)
                bgp_evpn_local_l3vni_add(l3vni, vrf_id, &rmac, originator_ip,
                                         filter);
        else
                bgp_evpn_local_l3vni_del(l3vni, vrf_id);

        return 0;
}

static int bgp_zebra_process_local_vni(int command, struct zclient *zclient,
                                       zebra_size_t length, vrf_id_t vrf_id)
{
        struct stream *s;
        vni_t vni;
        struct bgp *bgp;
        struct in_addr vtep_ip = {INADDR_ANY};
        vrf_id_t tenant_vrf_id = VRF_DEFAULT;

        s = zclient->ibuf;
        vni = stream_getl(s);
        if (command == ZEBRA_VNI_ADD) {
                vtep_ip.s_addr = stream_get_ipv4(s);
                stream_get(&tenant_vrf_id, s, sizeof(vrf_id_t));
        }

        bgp = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp)
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Rx VNI %s VRF %s VNI %u tenant-vrf %s",
                           (command == ZEBRA_VNI_ADD) ? "add" : "del",
                           vrf_id_to_name(vrf_id), vni,
                           vrf_id_to_name(tenant_vrf_id));

        if (command == ZEBRA_VNI_ADD)
                return bgp_evpn_local_vni_add(
                        bgp, vni, vtep_ip.s_addr ? vtep_ip : bgp->router_id,
                        tenant_vrf_id);
        else
                return bgp_evpn_local_vni_del(bgp, vni);
}

static int bgp_zebra_process_local_macip(int command, struct zclient *zclient,
                                         zebra_size_t length, vrf_id_t vrf_id)
{
        struct stream *s;
        vni_t vni;
        struct bgp *bgp;
        struct ethaddr mac;
        struct ipaddr ip;
        int ipa_len;
        char buf[ETHER_ADDR_STRLEN];
        char buf1[INET6_ADDRSTRLEN];
        uint8_t flags = 0;
        uint32_t seqnum = 0;

        memset(&ip, 0, sizeof(ip));
        s = zclient->ibuf;
        vni = stream_getl(s);
        stream_get(&mac.octet, s, ETH_ALEN);
        ipa_len = stream_getl(s);
        if (ipa_len != 0 && ipa_len != IPV4_MAX_BYTELEN
            && ipa_len != IPV6_MAX_BYTELEN) {
                flog_err(EC_BGP_MACIP_LEN,
                         "%u:Recv MACIP %s with invalid IP addr length %d",
                         vrf_id, (command == ZEBRA_MACIP_ADD) ? "Add" : "Del",
                         ipa_len);
                return -1;
        }

        if (ipa_len) {
                ip.ipa_type =
                        (ipa_len == IPV4_MAX_BYTELEN) ? IPADDR_V4 : IPADDR_V6;
                stream_get(&ip.ip.addr, s, ipa_len);
        }
        if (command == ZEBRA_MACIP_ADD) {
                flags = stream_getc(s);
                seqnum = stream_getl(s);
        }

        bgp = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp)
                return 0;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%u:Recv MACIP %s flags 0x%x MAC %s IP %s VNI %u seq %u",
                           vrf_id, (command == ZEBRA_MACIP_ADD) ? "Add" : "Del",
                           flags, prefix_mac2str(&mac, buf, sizeof(buf)),
                           ipaddr2str(&ip, buf1, sizeof(buf1)), vni, seqnum);

        if (command == ZEBRA_MACIP_ADD)
                return bgp_evpn_local_macip_add(bgp, vni, &mac, &ip,
                                                flags, seqnum);
        else
                return bgp_evpn_local_macip_del(bgp, vni, &mac, &ip);
}

static void bgp_zebra_process_local_ip_prefix(int cmd, struct zclient *zclient,
                                              zebra_size_t length,
                                              vrf_id_t vrf_id)
{
        struct stream *s = NULL;
        struct bgp *bgp_vrf = NULL;
        struct prefix p;
        char buf[PREFIX_STRLEN];

        memset(&p, 0, sizeof(struct prefix));
        s = zclient->ibuf;
        stream_get(&p, s, sizeof(struct prefix));

        bgp_vrf = bgp_lookup_by_vrf_id(vrf_id);
        if (!bgp_vrf)
                return;

        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("Recv prefix %s %s on vrf %s",
                           prefix2str(&p, buf, sizeof(buf)),
                           (cmd == ZEBRA_IP_PREFIX_ROUTE_ADD) ? "ADD" : "DEL",
                           vrf_id_to_name(vrf_id));

        if (cmd == ZEBRA_IP_PREFIX_ROUTE_ADD) {

                if (p.family == AF_INET)
                        return bgp_evpn_advertise_type5_route(
                                bgp_vrf, &p, NULL, AFI_IP, SAFI_UNICAST);
                else
                        return bgp_evpn_advertise_type5_route(
                                bgp_vrf, &p, NULL, AFI_IP6, SAFI_UNICAST);

        } else {
                if (p.family == AF_INET)
                        return bgp_evpn_withdraw_type5_route(
                                bgp_vrf, &p, AFI_IP, SAFI_UNICAST);
                else
                        return bgp_evpn_withdraw_type5_route(
                                bgp_vrf, &p, AFI_IP6, SAFI_UNICAST);
        }
}

static void bgp_zebra_process_label_chunk(
        int cmd,
        struct zclient *zclient,
        zebra_size_t length,
        vrf_id_t vrf_id)
{
        struct stream *s = NULL;
        uint8_t response_keep;
        uint32_t first;
        uint32_t last;
        uint8_t proto;
        unsigned short instance;

        s = zclient->ibuf;
        STREAM_GETC(s, proto);
        STREAM_GETW(s, instance);
        STREAM_GETC(s, response_keep);
        STREAM_GETL(s, first);
        STREAM_GETL(s, last);

        if (zclient->redist_default != proto) {
                flog_err(EC_BGP_LM_ERROR, "Got LM msg with wrong proto %u",
                         proto);
                return;
        }
        if (zclient->instance != instance) {
                flog_err(EC_BGP_LM_ERROR, "Got LM msg with wrong instance %u",
                         proto);
                return;
        }

        if (first > last ||
                first < MPLS_LABEL_UNRESERVED_MIN ||
                last > MPLS_LABEL_UNRESERVED_MAX) {

                flog_err(EC_BGP_LM_ERROR, "%s: Invalid Label chunk: %u - %u",
                         __func__, first, last);
                return;
        }
        if (BGP_DEBUG(zebra, ZEBRA)) {
                zlog_debug("Label Chunk assign: %u - %u (%u) ",
                        first, last, response_keep);
        }

        bgp_lp_event_chunk(response_keep, first, last);

stream_failure:         /* for STREAM_GETX */
        return;
}

extern struct zebra_privs_t bgpd_privs;

void bgp_zebra_init(struct thread_master *master, unsigned short instance)
{
        zclient_num_connects = 0;

        /* Set default values. */
        zclient = zclient_new_notify(master, &zclient_options_default);
        zclient_init(zclient, ZEBRA_ROUTE_BGP, 0, &bgpd_privs);
        zclient->zebra_connected = bgp_zebra_connected;
        zclient->router_id_update = bgp_router_id_update;
        zclient->interface_add = bgp_interface_add;
        zclient->interface_delete = bgp_interface_delete;
        zclient->interface_address_add = bgp_interface_address_add;
        zclient->interface_address_delete = bgp_interface_address_delete;
        zclient->interface_nbr_address_add = bgp_interface_nbr_address_add;
        zclient->interface_nbr_address_delete =
                bgp_interface_nbr_address_delete;
        zclient->interface_vrf_update = bgp_interface_vrf_update;
        zclient->redistribute_route_add = zebra_read_route;
        zclient->redistribute_route_del = zebra_read_route;
        zclient->interface_up = bgp_interface_up;
        zclient->interface_down = bgp_interface_down;
        zclient->nexthop_update = bgp_read_nexthop_update;
        zclient->import_check_update = bgp_read_import_check_update;
        zclient->fec_update = bgp_read_fec_update;
        zclient->local_es_add = bgp_zebra_process_local_es;
        zclient->local_es_del = bgp_zebra_process_local_es;
        zclient->local_vni_add = bgp_zebra_process_local_vni;
        zclient->local_vni_del = bgp_zebra_process_local_vni;
        zclient->local_macip_add = bgp_zebra_process_local_macip;
        zclient->local_macip_del = bgp_zebra_process_local_macip;
        zclient->local_l3vni_add = bgp_zebra_process_local_l3vni;
        zclient->local_l3vni_del = bgp_zebra_process_local_l3vni;
        zclient->local_ip_prefix_add = bgp_zebra_process_local_ip_prefix;
        zclient->local_ip_prefix_del = bgp_zebra_process_local_ip_prefix;
        zclient->label_chunk = bgp_zebra_process_label_chunk;
        zclient->rule_notify_owner = rule_notify_owner;
        zclient->ipset_notify_owner = ipset_notify_owner;
        zclient->ipset_entry_notify_owner = ipset_entry_notify_owner;
        zclient->iptable_notify_owner = iptable_notify_owner;
        zclient->instance = instance;
}

void bgp_zebra_destroy(void)
{
        if (zclient == NULL)
                return;
        zclient_stop(zclient);
        zclient_free(zclient);
        zclient = NULL;
}

int bgp_zebra_num_connects(void)
{
        return zclient_num_connects;
}

void bgp_send_pbr_rule_action(struct bgp_pbr_action *pbra, bool install)
{
        struct stream *s;

        if (pbra->install_in_progress)
                return;
        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%s: table %d fwmark %d %d",
                           __PRETTY_FUNCTION__,
                           pbra->table_id, pbra->fwmark, install);
        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s,
                              install ? ZEBRA_RULE_ADD : ZEBRA_RULE_DELETE,
                              VRF_DEFAULT);
        stream_putl(s, 1); /* send one pbr action */

        bgp_encode_pbr_rule_action(s, pbra);

        stream_putw_at(s, 0, stream_get_endp(s));
        if (!zclient_send_message(zclient) && install)
                pbra->install_in_progress = true;
}

void bgp_send_pbr_ipset_match(struct bgp_pbr_match *pbrim, bool install)
{
        struct stream *s;

        if (pbrim->install_in_progress)
                return;
        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%s: name %s type %d %d, ID %u",
                           __PRETTY_FUNCTION__,
                           pbrim->ipset_name, pbrim->type,
                           install, pbrim->unique);
        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s,
                              install ? ZEBRA_IPSET_CREATE :
                              ZEBRA_IPSET_DESTROY,
                              VRF_DEFAULT);

        stream_putl(s, 1); /* send one pbr action */

        bgp_encode_pbr_ipset_match(s, pbrim);

        stream_putw_at(s, 0, stream_get_endp(s));
        if (!zclient_send_message(zclient) && install)
                pbrim->install_in_progress = true;
}

void bgp_send_pbr_ipset_entry_match(struct bgp_pbr_match_entry *pbrime,
                                    bool install)
{
        struct stream *s;

        if (pbrime->install_in_progress)
                return;
        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%s: name %s %d %d, ID %u", __PRETTY_FUNCTION__,
                           pbrime->backpointer->ipset_name,
                           pbrime->unique, install, pbrime->unique);
        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s,
                              install ? ZEBRA_IPSET_ENTRY_ADD :
                              ZEBRA_IPSET_ENTRY_DELETE,
                              VRF_DEFAULT);

        stream_putl(s, 1); /* send one pbr action */

        bgp_encode_pbr_ipset_entry_match(s, pbrime);

        stream_putw_at(s, 0, stream_get_endp(s));
        if (!zclient_send_message(zclient) && install)
                pbrime->install_in_progress = true;
}

static void bgp_encode_pbr_interface_list(struct bgp *bgp, struct stream *s)
{
        struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
        struct bgp_pbr_interface_head *head;
        struct bgp_pbr_interface *pbr_if;
        struct interface *ifp;

        if (!bgp_pbr_cfg)
                return;
        head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);

        RB_FOREACH (pbr_if, bgp_pbr_interface_head, head) {
                ifp = if_lookup_by_name(pbr_if->name, bgp->vrf_id);
                if (ifp)
                        stream_putl(s, ifp->ifindex);
        }
}

static int bgp_pbr_get_ifnumber(struct bgp *bgp)
{
        struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
        struct bgp_pbr_interface_head *head;
        struct bgp_pbr_interface *pbr_if;
        int cnt = 0;

        if (!bgp_pbr_cfg)
                return 0;
        head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);

        RB_FOREACH (pbr_if, bgp_pbr_interface_head, head) {
                if (if_lookup_by_name(pbr_if->name, bgp->vrf_id))
                        cnt++;
        }
        return cnt;
}

void bgp_send_pbr_iptable(struct bgp_pbr_action *pba,
                          struct bgp_pbr_match *pbm,
                          bool install)
{
        struct stream *s;
        int ret = 0;
        int nb_interface;

        if (pbm->install_iptable_in_progress)
                return;
        if (BGP_DEBUG(zebra, ZEBRA))
                zlog_debug("%s: name %s type %d mark %d %d, ID %u",
                           __PRETTY_FUNCTION__, pbm->ipset_name,
                           pbm->type, pba->fwmark, install,
                           pbm->unique2);
        s = zclient->obuf;
        stream_reset(s);

        zclient_create_header(s,
                              install ? ZEBRA_IPTABLE_ADD :
                              ZEBRA_IPTABLE_DELETE,
                              VRF_DEFAULT);

        bgp_encode_pbr_iptable_match(s, pba, pbm);
        nb_interface = bgp_pbr_get_ifnumber(pba->bgp);
        stream_putl(s, nb_interface);
        if (nb_interface)
                bgp_encode_pbr_interface_list(pba->bgp, s);
        stream_putw_at(s, 0, stream_get_endp(s));
        ret = zclient_send_message(zclient);
        if (install) {
                if (ret)
                        pba->refcnt++;
                else
                        pbm->install_iptable_in_progress = true;
        }
}

/* inject in table <table_id> a default route to:
 * - if nexthop IP is present : to this nexthop
 * - if vrf is different from local : to the matching VRF
 */
void bgp_zebra_announce_default(struct bgp *bgp, struct nexthop *nh,
                                afi_t afi, uint32_t table_id, bool announce)
{
        struct zapi_nexthop *api_nh;
        struct zapi_route api;
        struct prefix p;

        if (!nh || nh->type != NEXTHOP_TYPE_IPV4
            || nh->vrf_id == VRF_UNKNOWN)
                return;
        memset(&p, 0, sizeof(struct prefix));
        /* default route */
        if (afi != AFI_IP)
                return;
        p.family = AF_INET;
        memset(&api, 0, sizeof(api));
        api.vrf_id = bgp->vrf_id;
        api.type = ZEBRA_ROUTE_BGP;
        api.safi = SAFI_UNICAST;
        api.prefix = p;
        api.tableid = table_id;
        api.nexthop_num = 1;
        SET_FLAG(api.message, ZAPI_MESSAGE_TABLEID);
        SET_FLAG(api.message, ZAPI_MESSAGE_NEXTHOP);
        api_nh = &api.nexthops[0];

        /* redirect IP */
        if (nh->gate.ipv4.s_addr) {
                char buff[PREFIX_STRLEN];

                api_nh->vrf_id = nh->vrf_id;
                api_nh->gate.ipv4 = nh->gate.ipv4;
                api_nh->type = NEXTHOP_TYPE_IPV4;

                inet_ntop(AF_INET, &(nh->gate.ipv4), buff, INET_ADDRSTRLEN);
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_info("BGP: %s default route to %s table %d (redirect IP)",
                                  announce ? "adding" : "withdrawing",
                                  buff, table_id);
                zclient_route_send(announce ? ZEBRA_ROUTE_ADD
                                   : ZEBRA_ROUTE_DELETE,
                                   zclient, &api);
        } else if (nh->vrf_id != bgp->vrf_id) {
                struct vrf *vrf;
                struct interface *ifp;

                vrf = vrf_lookup_by_id(nh->vrf_id);
                if (!vrf)
                        return;
                /* create default route with interface <VRF>
                 * with nexthop-vrf <VRF>
                 */
                ifp = if_lookup_by_name_all_vrf(vrf->name);
                if (!ifp)
                        return;
                api_nh->vrf_id = nh->vrf_id;
                api_nh->type = NEXTHOP_TYPE_IFINDEX;
                api_nh->ifindex = ifp->ifindex;
                if (BGP_DEBUG(zebra, ZEBRA))
                        zlog_info("BGP: %s default route to %s table %d (redirect VRF)",
                                  announce ? "adding" : "withdrawing",
                                  vrf->name, table_id);
                zclient_route_send(announce ? ZEBRA_ROUTE_ADD
                                   : ZEBRA_ROUTE_DELETE,
                                   zclient, &api);
                return;
        }
}