Import Upstream version 1.2.2
[quagga-debian.git] / 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
17  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
18  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19  * 02111-1307, USA.
20  */
21
22 #ifndef _BGP_NHT_H
23 #define _BGP_NHT_H
24
25 /**
26  * bgp_parse_nexthop_update() - parse a nexthop update message from Zebra.
27  */
28 void bgp_parse_nexthop_update (void);
29
30 /**
31  * bgp_nexthop_check() - check if the bnc object is valid.
32  * ARGUMENTS:
33  *   p - path for which the nexthop object is being looked up
34  *   connected - True if NH MUST be a connected route
35  */
36 int bgp_nexthop_check (struct bgp_info *, int connected);
37
38 /**
39  * bgp_ensure_nexthop() - Ensure a bgp_nexthop_cache object exists for 
40  *  the given prefix or peer.  If an existing one is not found,
41  *  create a new object and register with ZEBRA for nexthop
42  *  notification.
43  * ARGUMENTS:
44  *   afi: AFI_IP or AF_IP6
45  *     struct bgp_info *: path for which the nexthop object is 
46  *                        being looked up
47  *   OR
48  *     struct peer The BGP peer associated with this NHT
49  *   connected - True if NH MUST be a connected route
50  */
51 int bgp_ensure_nexthop (struct bgp_info *, struct peer *, int connected);
52
53 /**
54  * bgp_unlink_nexthop() - Unlink the nexthop object from the path structure.
55  * ARGUMENTS:
56  *   struct bgp_info *: path structure.
57  */
58 void bgp_unlink_nexthop (struct bgp_info *);
59
60 /**
61  * bgp_unlink_nexthop() - Unlink the nexthop object for the given peer.
62  */
63 extern void bgp_unlink_nexthop(struct bgp_info *p);
64 void bgp_unlink_nexthop_by_peer (struct peer *);
65
66 #endif /* _BGP_NHT_H */