1 /* BGP routing information base
2 * Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
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
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.
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
21 #ifndef _QUAGGA_BGP_ROUTE_H
22 #define _QUAGGA_BGP_ROUTE_H
26 #include "bgp_table.h"
28 struct bgp_nexthop_cache
;
29 struct bgp_route_evpn
;
34 bgp_show_type_prefix_list
,
35 bgp_show_type_filter_list
,
36 bgp_show_type_route_map
,
37 bgp_show_type_neighbor
,
38 bgp_show_type_cidr_only
,
39 bgp_show_type_prefix_longer
,
40 bgp_show_type_community_all
,
41 bgp_show_type_community
,
42 bgp_show_type_community_exact
,
43 bgp_show_type_community_list
,
44 bgp_show_type_community_list_exact
,
45 bgp_show_type_lcommunity_all
,
46 bgp_show_type_lcommunity
,
47 bgp_show_type_lcommunity_list
,
48 bgp_show_type_flap_statistics
,
49 bgp_show_type_flap_neighbor
,
50 bgp_show_type_dampend_paths
,
51 bgp_show_type_damp_neighbor
55 #define BGP_SHOW_SCODE_HEADER \
56 "Status codes: s suppressed, d damped, " \
57 "h history, * valid, > best, = multipath,\n" \
58 " i internal, r RIB-failure, S Stale, R Removed\n"
59 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
60 #define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path\n"
62 /* Ancillary information to struct bgp_info,
63 * used for uncommonly used data (aggregation, MPLS, etc.)
64 * and lazily allocated to save memory.
66 struct bgp_info_extra
{
67 /* Pointer to dampening structure. */
68 struct bgp_damp_info
*damp_info
;
70 /* This route is suppressed with aggregation. */
73 /* Nexthop reachability check. */
83 void *rfapi_handle
; /* export: NVE advertising this
85 struct list
*local_nexthops
; /* optional, for static
91 void *hme
; /* encap monitor, if this is a VPN route */
93 rd
; /* import: route's route-distinguisher */
94 u_char un_family
; /* family of cached un address, 0 if
98 struct in6_addr addr6
;
99 } un
; /* cached un address */
103 aux_prefix
; /* AFI_L2VPN: the IP addr,
110 /* For imported routes into a VNI (or VRF), this points to the parent.
116 /* For linked list. */
117 struct bgp_info
*next
;
118 struct bgp_info
*prev
;
120 /* For nexthop linked list */
121 LIST_ENTRY(bgp_info
) nh_thread
;
123 /* Back pointer to the prefix node */
124 struct bgp_node
*net
;
126 /* Back pointer to the nexthop structure */
127 struct bgp_nexthop_cache
*nexthop
;
129 /* Peer structure. */
132 /* Attribute structure. */
135 /* Extra information */
136 struct bgp_info_extra
*extra
;
139 /* Multipath information */
140 struct bgp_info_mpath
*mpath
;
145 /* reference count */
148 /* BGP information status. */
150 #define BGP_INFO_IGP_CHANGED (1 << 0)
151 #define BGP_INFO_DAMPED (1 << 1)
152 #define BGP_INFO_HISTORY (1 << 2)
153 #define BGP_INFO_SELECTED (1 << 3)
154 #define BGP_INFO_VALID (1 << 4)
155 #define BGP_INFO_ATTR_CHANGED (1 << 5)
156 #define BGP_INFO_DMED_CHECK (1 << 6)
157 #define BGP_INFO_DMED_SELECTED (1 << 7)
158 #define BGP_INFO_STALE (1 << 8)
159 #define BGP_INFO_REMOVED (1 << 9)
160 #define BGP_INFO_COUNTED (1 << 10)
161 #define BGP_INFO_MULTIPATH (1 << 11)
162 #define BGP_INFO_MULTIPATH_CHG (1 << 12)
163 #define BGP_INFO_RIB_ATTR_CHG (1 << 13)
165 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
168 /* When above type is BGP. This sub type specify BGP sub type
171 #define BGP_ROUTE_NORMAL 0
172 #define BGP_ROUTE_STATIC 1
173 #define BGP_ROUTE_AGGREGATE 2
174 #define BGP_ROUTE_REDISTRIBUTE 3
175 #ifdef ENABLE_BGP_VNC
176 # define BGP_ROUTE_RFP 4
181 /* Addpath identifiers */
182 u_int32_t addpath_rx_id
;
183 u_int32_t addpath_tx_id
;
186 /* Structure used in BGP path selection */
187 struct bgp_info_pair
{
188 struct bgp_info
*old
;
189 struct bgp_info
*new;
192 /* BGP static route configuration. */
194 /* Backdoor configuration. */
197 /* Label index configuration; applies to LU prefixes. */
198 u_int32_t label_index
;
199 #define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
201 /* Import check status. */
208 struct in_addr igpnexthop
;
210 /* Atomic set reference count (ie cause of pathlimit) */
213 /* BGP redistribute route-map. */
216 struct route_map
*map
;
219 /* Route Distinguisher */
220 struct prefix_rd prd
;
226 struct eth_segment_id
*eth_s_id
;
227 struct ethaddr
*router_mac
;
228 uint16_t encap_tunneltype
;
229 struct prefix gatewayIp
;
232 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
233 ((nhlen) < IPV4_MAX_BYTELEN \
235 : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
237 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
238 (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
239 && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
240 #define BGP_INFO_COUNTABLE(BI) \
241 (!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY) \
242 && !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))
244 /* Flags which indicate a route is unuseable in some form */
245 #define BGP_INFO_UNUSEABLE \
246 (BGP_INFO_HISTORY | BGP_INFO_DAMPED | BGP_INFO_REMOVED)
247 /* Macro to check BGP information is alive or not. Sadly,
248 * not equivalent to just checking previous, because of the
249 * sense of the additional VALID flag.
251 #define BGP_INFO_HOLDDOWN(BI) \
252 (!CHECK_FLAG((BI)->flags, BGP_INFO_VALID) \
253 || CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))
255 #define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
256 #define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
257 #define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
258 #define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
260 #define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
261 #define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
262 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
263 #define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
265 #define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
266 #define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
267 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
268 #define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
270 #define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
271 #define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
272 #define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
273 #define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
275 #define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
276 #define UNSUPPRESS_MAP(F) ((F)->usmap.map)
278 /* path PREFIX (addpath rxid NUMBER) */
279 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
281 enum bgp_path_type
{ BGP_PATH_ALL
, BGP_PATH_BESTPATH
, BGP_PATH_MULTIPATH
};
283 static inline void bgp_bump_version(struct bgp_node
*node
)
285 node
->version
= bgp_table_next_version(bgp_node_table(node
));
288 static inline int bgp_fibupd_safi(safi_t safi
)
290 if (safi
== SAFI_UNICAST
|| safi
== SAFI_MULTICAST
291 || safi
== SAFI_LABELED_UNICAST
)
297 extern void bgp_rib_remove(struct bgp_node
*rn
, struct bgp_info
*ri
,
298 struct peer
*peer
, afi_t afi
, safi_t safi
);
299 extern void bgp_process_queue_init(void);
300 extern void bgp_route_init(void);
301 extern void bgp_route_finish(void);
302 extern void bgp_cleanup_routes(struct bgp
*);
303 extern void bgp_announce_route(struct peer
*, afi_t
, safi_t
);
304 extern void bgp_stop_announce_route_timer(struct peer_af
*paf
);
305 extern void bgp_announce_route_all(struct peer
*);
306 extern void bgp_default_originate(struct peer
*, afi_t
, safi_t
, int);
307 extern void bgp_soft_reconfig_in(struct peer
*, afi_t
, safi_t
);
308 extern void bgp_clear_route(struct peer
*, afi_t
, safi_t
);
309 extern void bgp_clear_route_all(struct peer
*);
310 extern void bgp_clear_adj_in(struct peer
*, afi_t
, safi_t
);
311 extern void bgp_clear_stale_route(struct peer
*, afi_t
, safi_t
);
313 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*table
, afi_t afi
,
314 safi_t safi
, struct prefix
*p
,
315 struct prefix_rd
*prd
);
316 extern struct bgp_info
*bgp_info_lock(struct bgp_info
*);
317 extern struct bgp_info
*bgp_info_unlock(struct bgp_info
*);
318 extern void bgp_info_add(struct bgp_node
*rn
, struct bgp_info
*ri
);
319 extern void bgp_info_reap(struct bgp_node
*rn
, struct bgp_info
*ri
);
320 extern void bgp_info_delete(struct bgp_node
*rn
, struct bgp_info
*ri
);
321 extern struct bgp_info_extra
*bgp_info_extra_get(struct bgp_info
*);
322 extern void bgp_info_set_flag(struct bgp_node
*, struct bgp_info
*, u_int32_t
);
323 extern void bgp_info_unset_flag(struct bgp_node
*, struct bgp_info
*,
325 extern void bgp_info_path_with_addpath_rx_str(struct bgp_info
*ri
, char *buf
);
327 extern int bgp_nlri_parse_ip(struct peer
*, struct attr
*, struct bgp_nlri
*);
329 extern int bgp_maximum_prefix_overflow(struct peer
*, afi_t
, safi_t
, int);
331 extern void bgp_redistribute_add(struct bgp
*, struct prefix
*,
332 const union g_addr
*, unsigned int ifindex
,
333 u_int32_t
, u_char
, u_short
, route_tag_t
);
334 extern void bgp_redistribute_delete(struct bgp
*, struct prefix
*, u_char
,
336 extern void bgp_redistribute_withdraw(struct bgp
*, afi_t
, int, u_short
);
338 extern void bgp_static_add(struct bgp
*);
339 extern void bgp_static_delete(struct bgp
*);
340 extern void bgp_static_redo_import_check(struct bgp
*);
341 extern void bgp_purge_static_redist_routes(struct bgp
*bgp
);
342 extern void bgp_static_update(struct bgp
*, struct prefix
*,
343 struct bgp_static
*, afi_t
, safi_t
);
344 extern void bgp_static_withdraw(struct bgp
*, struct prefix
*, afi_t
, safi_t
);
346 extern int bgp_static_set_safi(afi_t afi
, safi_t safi
, struct vty
*vty
,
347 const char *, const char *, const char *,
348 const char *, int, const char *, const char *,
349 const char *, const char *);
351 extern int bgp_static_unset_safi(afi_t afi
, safi_t safi
, struct vty
*,
352 const char *, const char *, const char *, int,
353 const char *, const char *, const char *);
355 /* this is primarily for MPLS-VPN */
356 extern int bgp_update(struct peer
*, struct prefix
*, u_int32_t
, struct attr
*,
357 afi_t
, safi_t
, int, int, struct prefix_rd
*,
358 mpls_label_t
*, int, struct bgp_route_evpn
*);
359 extern int bgp_withdraw(struct peer
*, struct prefix
*, u_int32_t
,
360 struct attr
*, afi_t
, safi_t
, int, int,
361 struct prefix_rd
*, mpls_label_t
*,
362 struct bgp_route_evpn
*);
364 /* for bgp_nexthop and bgp_damp */
365 extern void bgp_process(struct bgp
*, struct bgp_node
*, afi_t
, safi_t
);
368 * Add an end-of-initial-update marker to the process queue. This is just a
369 * queue element with NULL bgp node.
371 extern void bgp_add_eoiu_mark(struct bgp
*);
372 extern int bgp_config_write_table_map(struct vty
*, struct bgp
*, afi_t
, safi_t
,
374 extern int bgp_config_write_network(struct vty
*, struct bgp
*, afi_t
, safi_t
,
376 extern int bgp_config_write_distance(struct vty
*, struct bgp
*, afi_t
, safi_t
,
379 extern void bgp_aggregate_increment(struct bgp
*, struct prefix
*,
380 struct bgp_info
*, afi_t
, safi_t
);
381 extern void bgp_aggregate_decrement(struct bgp
*, struct prefix
*,
382 struct bgp_info
*, afi_t
, safi_t
);
384 extern u_char
bgp_distance_apply(struct prefix
*, struct bgp_info
*, afi_t
,
385 safi_t
, struct bgp
*);
387 extern afi_t
bgp_node_afi(struct vty
*);
388 extern safi_t
bgp_node_safi(struct vty
*);
390 extern struct bgp_info
*info_make(int type
, int sub_type
, u_short instance
,
391 struct peer
*peer
, struct attr
*attr
,
392 struct bgp_node
*rn
);
394 extern void route_vty_out(struct vty
*, struct prefix
*, struct bgp_info
*, int,
395 safi_t
, json_object
*);
396 extern void route_vty_out_tag(struct vty
*, struct prefix
*, struct bgp_info
*,
397 int, safi_t
, json_object
*);
398 extern void route_vty_out_tmp(struct vty
*, struct prefix
*, struct attr
*,
399 safi_t
, u_char
, json_object
*);
400 extern void route_vty_out_overlay(struct vty
*vty
, struct prefix
*p
,
401 struct bgp_info
*binfo
, int display
,
404 extern int subgroup_process_announce_selected(struct update_subgroup
*subgrp
,
405 struct bgp_info
*selected
,
407 u_int32_t addpath_tx_id
);
409 extern int subgroup_announce_check(struct bgp_node
*rn
, struct bgp_info
*ri
,
410 struct update_subgroup
*subgrp
,
411 struct prefix
*p
, struct attr
*attr
);
413 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer
*peer
);
414 extern void bgp_process_queues_drain_immediate(void);
417 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*, afi_t
, safi_t
,
418 struct prefix
*, struct prefix_rd
*);
419 extern struct bgp_node
*bgp_afi_node_lookup(struct bgp_table
*table
, afi_t afi
,
420 safi_t safi
, struct prefix
*p
,
421 struct prefix_rd
*prd
);
422 extern struct bgp_info
*bgp_info_new(void);
423 extern void bgp_info_restore(struct bgp_node
*, struct bgp_info
*);
425 extern int bgp_info_cmp_compatible(struct bgp
*, struct bgp_info
*,
426 struct bgp_info
*, char *pfx_buf
, afi_t afi
,
429 extern void bgp_best_selection(struct bgp
*bgp
, struct bgp_node
*rn
,
430 struct bgp_maxpaths_cfg
*mpath_cfg
,
431 struct bgp_info_pair
*result
, afi_t afi
,
433 extern void bgp_zebra_clear_route_change_flags(struct bgp_node
*rn
);
434 extern int bgp_zebra_has_route_changed(struct bgp_node
*rn
,
435 struct bgp_info
*selected
);
437 extern void route_vty_out_detail_header(struct vty
*vty
, struct bgp
*bgp
,
439 struct prefix_rd
*prd
, afi_t afi
,
440 safi_t safi
, json_object
*json
);
441 extern void route_vty_out_detail(struct vty
*vty
, struct bgp
*bgp
,
442 struct prefix
*p
, struct bgp_info
*binfo
,
443 afi_t afi
, safi_t safi
,
444 json_object
*json_paths
);
445 #endif /* _QUAGGA_BGP_ROUTE_H */