]> git.proxmox.com Git - mirror_frr.git/blame - bgpd/bgp_route.h
bgpd, zebra: rfc-5549-generic.patch
[mirror_frr.git] / bgpd / bgp_route.h
CommitLineData
718e3744 1/* BGP routing information base
2 Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
3
4This file is part of GNU Zebra.
5
6GNU Zebra is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 2, or (at your option) any
9later version.
10
11GNU Zebra is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Zebra; see the file COPYING. If not, write to the Free
18Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
1902111-1307, USA. */
20
00d252cb 21#ifndef _QUAGGA_BGP_ROUTE_H
22#define _QUAGGA_BGP_ROUTE_H
23
b05a1c8b 24#include <json/json.h>
fb018d25 25#include "queue.h"
200df115 26#include "bgp_table.h"
27
fb018d25
DS
28struct bgp_nexthop_cache;
29
3f9c7369
DS
30#define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
31 "h history, * valid, > best, = multipath,%s"\
32 " i internal, r RIB-failure, S Stale, R Removed%s"
33#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete%s%s"
34#define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path%s"
35
fb982c25
PJ
36/* Ancillary information to struct bgp_info,
37 * used for uncommonly used data (aggregation, MPLS, etc.)
38 * and lazily allocated to save memory.
39 */
40struct bgp_info_extra
41{
42 /* Pointer to dampening structure. */
43 struct bgp_damp_info *damp_info;
44
45 /* This route is suppressed with aggregation. */
46 int suppress;
47
48 /* Nexthop reachability check. */
49 u_int32_t igpmetric;
50
51 /* MPLS label. */
52 u_char tag[3];
53};
54
718e3744 55struct bgp_info
56{
57 /* For linked list. */
58 struct bgp_info *next;
59 struct bgp_info *prev;
fb018d25
DS
60
61 /* For nexthop linked list */
62 LIST_ENTRY(bgp_info) nh_thread;
63
64 /* Back pointer to the prefix node */
65 struct bgp_node *net;
66
67 /* Back pointer to the nexthop structure */
68 struct bgp_nexthop_cache *nexthop;
69
cbdfbaa5
PJ
70 /* Peer structure. */
71 struct peer *peer;
72
73 /* Attribute structure. */
74 struct attr *attr;
fb982c25
PJ
75
76 /* Extra information */
77 struct bgp_info_extra *extra;
78
de8d5dff
JB
79
80 /* Multipath information */
81 struct bgp_info_mpath *mpath;
82
cbdfbaa5
PJ
83 /* Uptime. */
84 time_t uptime;
85
200df115 86 /* reference count */
228da428 87 int lock;
200df115 88
718e3744 89 /* BGP information status. */
93406d87 90 u_int16_t flags;
718e3744 91#define BGP_INFO_IGP_CHANGED (1 << 0)
92#define BGP_INFO_DAMPED (1 << 1)
93#define BGP_INFO_HISTORY (1 << 2)
94#define BGP_INFO_SELECTED (1 << 3)
95#define BGP_INFO_VALID (1 << 4)
96#define BGP_INFO_ATTR_CHANGED (1 << 5)
97#define BGP_INFO_DMED_CHECK (1 << 6)
98#define BGP_INFO_DMED_SELECTED (1 << 7)
93406d87 99#define BGP_INFO_STALE (1 << 8)
b40d939b 100#define BGP_INFO_REMOVED (1 << 9)
902212c3 101#define BGP_INFO_COUNTED (1 << 10)
de8d5dff
JB
102#define BGP_INFO_MULTIPATH (1 << 11)
103#define BGP_INFO_MULTIPATH_CHG (1 << 12)
718e3744 104
cbdfbaa5
PJ
105 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
106 u_char type;
107
108 /* When above type is BGP. This sub type specify BGP sub type
109 information. */
110 u_char sub_type;
111#define BGP_ROUTE_NORMAL 0
112#define BGP_ROUTE_STATIC 1
113#define BGP_ROUTE_AGGREGATE 2
114#define BGP_ROUTE_REDISTRIBUTE 3
7c8ff89e
DS
115
116 u_short instance;
117
a82478b9
DS
118 /* Addpath identifiers */
119 u_int32_t addpath_rx_id;
120 u_int32_t addpath_tx_id;
121
718e3744 122};
123
124/* BGP static route configuration. */
125struct bgp_static
126{
127 /* Backdoor configuration. */
128 int backdoor;
129
130 /* Import check status. */
131 u_char valid;
132
133 /* IGP metric. */
134 u_int32_t igpmetric;
135
136 /* IGP nexthop. */
137 struct in_addr igpnexthop;
138
41367172
PJ
139 /* Atomic set reference count (ie cause of pathlimit) */
140 u_int32_t atomic;
141
718e3744 142 /* BGP redistribute route-map. */
143 struct
144 {
145 char *name;
146 struct route_map *map;
147 } rmap;
148
149 /* MPLS label. */
150 u_char tag[3];
151};
152
8a92a8a0
DS
153#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
154 (! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
155 (attr)->extra && ((attr)->extra->mp_nexthop_len == 16 || \
156 (attr)->extra->mp_nexthop_len == 32))
80e0ad24
DS
157#define BGP_INFO_COUNTABLE(BI) \
158 (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
159 && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
160
1a392d46
PJ
161/* Flags which indicate a route is unuseable in some form */
162#define BGP_INFO_UNUSEABLE \
163 (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
164/* Macro to check BGP information is alive or not. Sadly,
165 * not equivalent to just checking previous, because of the
166 * sense of the additional VALID flag.
167 */
168#define BGP_INFO_HOLDDOWN(BI) \
169 (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
170 || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
171
718e3744 172#define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
173#define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
174#define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
175#define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
176
177#define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
178#define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
179#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
180#define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
181
182#define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
183#define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
184#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
185#define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
186
fee0f4c6 187#define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
188#define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
189#define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
190#define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
191
192#define ROUTE_MAP_IMPORT_NAME(F) ((F)->map[RMAP_IMPORT].name)
193#define ROUTE_MAP_IMPORT(F) ((F)->map[RMAP_IMPORT].map)
194#define ROUTE_MAP_EXPORT_NAME(F) ((F)->map[RMAP_EXPORT].name)
195#define ROUTE_MAP_EXPORT(F) ((F)->map[RMAP_EXPORT].map)
718e3744 196
197#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
198#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
199
228da428
CC
200enum bgp_clear_route_type
201{
202 BGP_CLEAR_ROUTE_NORMAL,
203 BGP_CLEAR_ROUTE_MY_RSCLIENT
204};
205
4092b06c
DS
206enum bgp_path_type
207{
208 BGP_PATH_ALL,
209 BGP_PATH_BESTPATH,
210 BGP_PATH_MULTIPATH
211};
212
3f9c7369
DS
213static inline void
214bgp_bump_version (struct bgp_node *node)
215{
216 node->version = bgp_table_next_version(bgp_node_table(node));
217}
218
718e3744 219/* Prototypes. */
f188f2c4 220extern void bgp_process_queue_init (void);
94f2b392 221extern void bgp_route_init (void);
228da428 222extern void bgp_route_finish (void);
94f2b392 223extern void bgp_cleanup_routes (void);
224extern void bgp_announce_route (struct peer *, afi_t, safi_t);
3f9c7369 225extern void bgp_stop_announce_route_timer(struct peer_af *paf);
94f2b392 226extern void bgp_announce_route_all (struct peer *);
227extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
228extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
229extern void bgp_soft_reconfig_rsclient (struct peer *, afi_t, safi_t);
230extern void bgp_check_local_routes_rsclient (struct peer *rsclient, afi_t afi, safi_t safi);
228da428
CC
231extern void bgp_clear_route (struct peer *, afi_t, safi_t,
232 enum bgp_clear_route_type);
94f2b392 233extern void bgp_clear_route_all (struct peer *);
234extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
235extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
718e3744 236
4125bb67
DS
237extern struct bgp_node *bgp_afi_node_get (struct bgp_table *table, afi_t afi,
238 safi_t safi, struct prefix *p,
239 struct prefix_rd *prd);
200df115 240extern struct bgp_info *bgp_info_lock (struct bgp_info *);
241extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
242extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
243extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
fb982c25 244extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
1a392d46
PJ
245extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
246extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
200df115 247
a82478b9 248extern int bgp_nlri_sanity_check (struct peer *, int, safi_t, u_char *, bgp_size_t, int *);
94f2b392 249extern int bgp_nlri_parse (struct peer *, struct attr *, struct bgp_nlri *);
718e3744 250
94f2b392 251extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
718e3744 252
f04a80a5 253extern void bgp_redistribute_add (struct prefix *, const struct in_addr *,
bc413143 254 const struct in6_addr *, unsigned int ifindex,
7c8ff89e
DS
255 u_int32_t, u_char, u_short, u_short);
256extern void bgp_redistribute_delete (struct prefix *, u_char, u_short);
257extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);
718e3744 258
94f2b392 259extern void bgp_static_delete (struct bgp *);
078430f6 260extern void bgp_static_redo_import_check (struct bgp *);
94f2b392 261extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
718e3744 262 afi_t, safi_t);
94f2b392 263extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
718e3744 264
94f2b392 265extern int bgp_static_set_vpnv4 (struct vty *vty, const char *,
fd79ac91 266 const char *, const char *);
718e3744 267
94f2b392 268extern int bgp_static_unset_vpnv4 (struct vty *, const char *,
fd79ac91 269 const char *, const char *);
718e3744 270
94f2b392 271/* this is primarily for MPLS-VPN */
a82478b9 272extern int bgp_update (struct peer *, struct prefix *, u_int32_t, struct attr *,
94f2b392 273 afi_t, safi_t, int, int, struct prefix_rd *,
274 u_char *, int);
a82478b9 275extern int bgp_withdraw (struct peer *, struct prefix *, u_int32_t, struct attr *,
94f2b392 276 afi_t, safi_t, int, int, struct prefix_rd *, u_char *);
718e3744 277
94f2b392 278/* for bgp_nexthop and bgp_damp */
279extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
cb1faec9
DS
280
281/*
282 * Add an end-of-initial-update marker to the process queue. This is just a
283 * queue element with NULL bgp node.
284 */
285extern void bgp_add_eoiu_mark (struct bgp *, bgp_table_t);
73ac8160
DS
286extern int bgp_config_write_table_map (struct vty *, struct bgp *, afi_t, safi_t,
287 int *);
94f2b392 288extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
289extern int bgp_config_write_distance (struct vty *, struct bgp *);
290
291extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
718e3744 292 afi_t, safi_t);
94f2b392 293extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
718e3744 294 afi_t, safi_t);
295
94f2b392 296extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, struct bgp *);
718e3744 297
94f2b392 298extern afi_t bgp_node_afi (struct vty *);
299extern safi_t bgp_node_safi (struct vty *);
5a646650 300
b05a1c8b 301extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
94f2b392 302extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t);
b05a1c8b 303extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t);
00d252cb 304
3f9c7369
DS
305extern int
306subgroup_process_announce_selected (struct update_subgroup *subgrp,
307 struct bgp_info *selected,
308 struct bgp_node *rn);
309
310extern int subgroup_announce_check(struct bgp_info *ri,
311 struct update_subgroup *subgrp,
312 struct prefix *p, struct attr *attr);
313
00d252cb 314#endif /* _QUAGGA_BGP_ROUTE_H */