bgpd/bgp_nht.h

   1 /* BGP Nexthop tracking
   2  * Copyright (C) 2013 Cumulus Networks, Inc.
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _BGP_NHT_H
  22 #define _BGP_NHT_H
  23
  24 /**
  25  * bgp_parse_nexthop_update() - parse a nexthop update message from Zebra.
  26  */
  27 extern void bgp_parse_nexthop_update(int command, vrf_id_t vrf_id);
  28
  29 /**
  30  * bgp_find_or_add_nexthop() - lookup the nexthop cache table for the bnc
  31  *  object. If not found, create a new object and register with ZEBRA for
  32  *  nexthop notification.
  33  * ARGUMENTS:
  34  *   bgp_route - BGP instance of route
  35  *   bgp_nexthop - BGP instance of nexthop
  36  *   a - afi: AFI_IP or AF_IP6
  37  *   safi - safi: to check which table nhs are being imported to
  38  *   p - path for which the nexthop object is being looked up
  39  *   peer - The BGP peer associated with this NHT
  40  *   connected - True if NH MUST be a connected route
  41  */
  42 extern int bgp_find_or_add_nexthop(struct bgp *bgp_route,
  43                                    struct bgp *bgp_nexthop, afi_t a,
  44                                    safi_t safi, struct bgp_path_info *p,
  45                                    struct peer *peer, int connected,
  46                                    const struct prefix *orig_prefix);
  47
  48 /**
  49  * bgp_unlink_nexthop() - Unlink the nexthop object from the path structure.
  50  * ARGUMENTS:
  51  *   p - path structure.
  52  */
  53 extern void bgp_unlink_nexthop(struct bgp_path_info *p);
  54 void bgp_unlink_nexthop_by_peer(struct peer *peer);
  55 void bgp_replace_nexthop_by_peer(struct peer *from, struct peer *to);
  56 /**
  57  * bgp_delete_connected_nexthop() - Reset the 'peer' pointer for a connected
  58  * nexthop entry. If no paths reference the nexthop, it will be unregistered
  59  * and freed.
  60  * ARGUMENTS:
  61  *   afi - afi: AFI_IP or AF_IP6
  62  *   peer - Ptr to peer
  63  */
  64 extern void bgp_delete_connected_nexthop(afi_t afi, struct peer *peer);
  65
  66 /*
  67  * Cleanup nexthop registration and status information for BGP nexthops
  68  * pertaining to this VRF. This is invoked upon VRF deletion.
  69  */
  70 extern void bgp_cleanup_nexthops(struct bgp *bgp);
  71
  72 /*
  73  * Add or remove the tracking of the bgp_path_info that
  74  * uses this nexthop
  75  */
  76 extern void path_nh_map(struct bgp_path_info *path,
  77                         struct bgp_nexthop_cache *bnc, bool make);
  78 /*
  79  * When we actually have the connection to
  80  * the zebra daemon, we need to reregister
  81  * any nexthops we may have sitting around
  82  */
  83 extern void bgp_nht_register_nexthops(struct bgp *bgp);
  84
  85 /*
  86  * When we have the the PEER_FLAG_CAPABILITY_ENHE flag
  87  * set on a peer *after* it has been brought up we need
  88  * to notice and setup the interface based RA,
  89  * this code can walk the registered nexthops and
  90  * register the important ones with zebra for RA.
  91  */
  92 extern void bgp_nht_reg_enhe_cap_intfs(struct peer *peer);
  93 extern void bgp_nht_dereg_enhe_cap_intfs(struct peer *peer);
  94 extern void evaluate_paths(struct bgp_nexthop_cache *bnc);
  95
  96 /* APIs for setting up and allocating L3 nexthop group ids */
  97 extern uint32_t bgp_l3nhg_id_alloc(void);
  98 extern void bgp_l3nhg_id_free(uint32_t nhg_id);
  99 extern void bgp_l3nhg_init(void);
 100 void bgp_l3nhg_finish(void);
 101
 102 extern void bgp_nht_ifp_up(struct interface *ifp);
 103 extern void bgp_nht_ifp_down(struct interface *ifp);
 104
 105 extern void bgp_nht_interface_events(struct peer *peer);
 106 #endif /* _BGP_NHT_H */