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 enum bgp_show_adj_route_type
{
56 bgp_show_adj_route_advertised
,
57 bgp_show_adj_route_received
,
58 bgp_show_adj_route_filtered
,
62 #define BGP_SHOW_SCODE_HEADER \
63 "Status codes: s suppressed, d damped, " \
64 "h history, * valid, > best, = multipath,\n" \
65 " i internal, r RIB-failure, S Stale, R Removed\n"
66 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
67 #define BGP_SHOW_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
68 #define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path\n"
70 /* Maximum number of labels we can process or send with a prefix. We
71 * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
73 #define BGP_MAX_LABELS 2
75 /* Ancillary information to struct bgp_path_info,
76 * used for uncommonly used data (aggregation, MPLS, etc.)
77 * and lazily allocated to save memory.
79 struct bgp_path_info_extra
{
80 /* Pointer to dampening structure. */
81 struct bgp_damp_info
*damp_info
;
83 /* This route is suppressed with aggregation. */
86 /* Nexthop reachability check. */
89 /* MPLS label(s) - VNI(s) for EVPN-VxLAN */
90 mpls_label_t label
[BGP_MAX_LABELS
];
97 void *rfapi_handle
; /* export: NVE advertising this
99 struct list
*local_nexthops
; /* optional, for static
104 struct thread
*timer
;
105 void *hme
; /* encap monitor, if this is a VPN route */
107 rd
; /* import: route's route-distinguisher */
108 uint8_t un_family
; /* family of cached un address, 0 if
111 struct in_addr addr4
;
112 struct in6_addr addr6
;
113 } un
; /* cached un address */
115 struct prefix aux_prefix
; /* AFI_L2VPN: the IP addr,
122 /* For imported routes into a VNI (or VRF), this points to the parent.
127 * Some tunnelish parameters follow. Maybe consolidate into an
128 * internal tunnel structure?
132 * Original bgp instance for imported routes. Needed for:
133 * 1. Find all routes from a specific vrf for deletion
134 * 2. vrf context of original nexthop
136 * Store pointer to bgp instance rather than bgp->vrf_id because
137 * bgp->vrf_id is not always valid (or may change?).
139 * Set to NULL if route is not imported from another bgp instance.
141 struct bgp
*bgp_orig
;
144 * Nexthop in context of original bgp instance. Needed
145 * for label resolution of core mpls routes exported to a vrf.
146 * Set nexthop_orig.family to 0 if not valid.
148 struct prefix nexthop_orig
;
149 /* presence of FS pbr entry */
150 struct list
*bgp_fs_pbr
;
153 struct bgp_path_info
{
154 /* For linked list. */
155 struct bgp_path_info
*next
;
156 struct bgp_path_info
*prev
;
158 /* For nexthop linked list */
159 LIST_ENTRY(bgp_path_info
) nh_thread
;
161 /* Back pointer to the prefix node */
162 struct bgp_node
*net
;
164 /* Back pointer to the nexthop structure */
165 struct bgp_nexthop_cache
*nexthop
;
167 /* Peer structure. */
170 /* Attribute structure. */
173 /* Extra information */
174 struct bgp_path_info_extra
*extra
;
177 /* Multipath information */
178 struct bgp_path_info_mpath
*mpath
;
183 /* reference count */
186 /* BGP information status. */
188 #define BGP_PATH_IGP_CHANGED (1 << 0)
189 #define BGP_PATH_DAMPED (1 << 1)
190 #define BGP_PATH_HISTORY (1 << 2)
191 #define BGP_PATH_SELECTED (1 << 3)
192 #define BGP_PATH_VALID (1 << 4)
193 #define BGP_PATH_ATTR_CHANGED (1 << 5)
194 #define BGP_PATH_DMED_CHECK (1 << 6)
195 #define BGP_PATH_DMED_SELECTED (1 << 7)
196 #define BGP_PATH_STALE (1 << 8)
197 #define BGP_PATH_REMOVED (1 << 9)
198 #define BGP_PATH_COUNTED (1 << 10)
199 #define BGP_PATH_MULTIPATH (1 << 11)
200 #define BGP_PATH_MULTIPATH_CHG (1 << 12)
201 #define BGP_PATH_RIB_ATTR_CHG (1 << 13)
202 #define BGP_PATH_ANNC_NH_SELF (1 << 14)
204 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
207 /* When above type is BGP. This sub type specify BGP sub type
210 #define BGP_ROUTE_NORMAL 0
211 #define BGP_ROUTE_STATIC 1
212 #define BGP_ROUTE_AGGREGATE 2
213 #define BGP_ROUTE_REDISTRIBUTE 3
214 #ifdef ENABLE_BGP_VNC
215 # define BGP_ROUTE_RFP 4
217 #define BGP_ROUTE_IMPORTED 5 /* from another bgp instance/safi */
219 unsigned short instance
;
221 /* Addpath identifiers */
222 uint32_t addpath_rx_id
;
223 uint32_t addpath_tx_id
;
226 /* Structure used in BGP path selection */
227 struct bgp_path_info_pair
{
228 struct bgp_path_info
*old
;
229 struct bgp_path_info
*new;
232 /* BGP static route configuration. */
234 /* Backdoor configuration. */
237 /* Label index configuration; applies to LU prefixes. */
238 uint32_t label_index
;
239 #define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
241 /* Import check status. */
248 struct in_addr igpnexthop
;
250 /* Atomic set reference count (ie cause of pathlimit) */
253 /* BGP redistribute route-map. */
256 struct route_map
*map
;
259 /* Route Distinguisher */
260 struct prefix_rd prd
;
266 struct eth_segment_id
*eth_s_id
;
267 struct ethaddr
*router_mac
;
268 uint16_t encap_tunneltype
;
269 struct prefix gatewayIp
;
272 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
273 ((nhlen) < IPV4_MAX_BYTELEN \
275 : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
277 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
278 (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
279 && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
280 #define BGP_PATH_COUNTABLE(BI) \
281 (!CHECK_FLAG((BI)->flags, BGP_PATH_HISTORY) \
282 && !CHECK_FLAG((BI)->flags, BGP_PATH_REMOVED))
284 /* Flags which indicate a route is unuseable in some form */
285 #define BGP_PATH_UNUSEABLE \
286 (BGP_PATH_HISTORY | BGP_PATH_DAMPED | BGP_PATH_REMOVED)
287 /* Macro to check BGP information is alive or not. Sadly,
288 * not equivalent to just checking previous, because of the
289 * sense of the additional VALID flag.
291 #define BGP_PATH_HOLDDOWN(BI) \
292 (!CHECK_FLAG((BI)->flags, BGP_PATH_VALID) \
293 || CHECK_FLAG((BI)->flags, BGP_PATH_UNUSEABLE))
295 #define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
296 #define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
297 #define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
298 #define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
300 #define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
301 #define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
302 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
303 #define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
305 #define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
306 #define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
307 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
308 #define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
310 #define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
311 #define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
312 #define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
313 #define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
315 #define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
316 #define UNSUPPRESS_MAP(F) ((F)->usmap.map)
318 /* path PREFIX (addpath rxid NUMBER) */
319 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
323 BGP_PATH_SHOW_BESTPATH
,
324 BGP_PATH_SHOW_MULTIPATH
327 static inline void bgp_bump_version(struct bgp_node
*node
)
329 node
->version
= bgp_table_next_version(bgp_node_table(node
));
332 static inline int bgp_fibupd_safi(safi_t safi
)
334 if (safi
== SAFI_UNICAST
|| safi
== SAFI_MULTICAST
335 || safi
== SAFI_LABELED_UNICAST
336 || safi
== SAFI_FLOWSPEC
)
342 extern void bgp_rib_remove(struct bgp_node
*rn
, struct bgp_path_info
*ri
,
343 struct peer
*peer
, afi_t afi
, safi_t safi
);
344 extern void bgp_process_queue_init(void);
345 extern void bgp_route_init(void);
346 extern void bgp_route_finish(void);
347 extern void bgp_cleanup_routes(struct bgp
*);
348 extern void bgp_announce_route(struct peer
*, afi_t
, safi_t
);
349 extern void bgp_stop_announce_route_timer(struct peer_af
*paf
);
350 extern void bgp_announce_route_all(struct peer
*);
351 extern void bgp_default_originate(struct peer
*, afi_t
, safi_t
, int);
352 extern void bgp_soft_reconfig_in(struct peer
*, afi_t
, safi_t
);
353 extern void bgp_clear_route(struct peer
*, afi_t
, safi_t
);
354 extern void bgp_clear_route_all(struct peer
*);
355 extern void bgp_clear_adj_in(struct peer
*, afi_t
, safi_t
);
356 extern void bgp_clear_stale_route(struct peer
*, afi_t
, safi_t
);
358 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*table
, afi_t afi
,
359 safi_t safi
, struct prefix
*p
,
360 struct prefix_rd
*prd
);
361 extern struct bgp_path_info
*bgp_info_lock(struct bgp_path_info
*path
);
362 extern struct bgp_path_info
*bgp_info_unlock(struct bgp_path_info
*path
);
363 extern void bgp_info_add(struct bgp_node
*rn
, struct bgp_path_info
*ri
);
364 extern void bgp_info_reap(struct bgp_node
*rn
, struct bgp_path_info
*ri
);
365 extern void bgp_info_delete(struct bgp_node
*rn
, struct bgp_path_info
*ri
);
366 extern struct bgp_path_info_extra
*
367 bgp_info_extra_get(struct bgp_path_info
*path
);
368 extern void bgp_info_set_flag(struct bgp_node
*rn
, struct bgp_path_info
*path
,
370 extern void bgp_info_unset_flag(struct bgp_node
*rn
, struct bgp_path_info
*path
,
372 extern void bgp_info_path_with_addpath_rx_str(struct bgp_path_info
*ri
,
375 extern int bgp_nlri_parse_ip(struct peer
*, struct attr
*, struct bgp_nlri
*);
377 extern int bgp_maximum_prefix_overflow(struct peer
*, afi_t
, safi_t
, int);
379 extern void bgp_redistribute_add(struct bgp
*bgp
, struct prefix
*p
,
380 const union g_addr
*nexthop
, ifindex_t ifindex
,
381 enum nexthop_types_t nhtype
, uint32_t metric
,
382 uint8_t type
, unsigned short instance
,
384 extern void bgp_redistribute_delete(struct bgp
*, struct prefix
*, uint8_t,
386 extern void bgp_redistribute_withdraw(struct bgp
*, afi_t
, int, unsigned short);
388 extern void bgp_static_add(struct bgp
*);
389 extern void bgp_static_delete(struct bgp
*);
390 extern void bgp_static_redo_import_check(struct bgp
*);
391 extern void bgp_purge_static_redist_routes(struct bgp
*bgp
);
392 extern void bgp_static_update(struct bgp
*, struct prefix
*,
393 struct bgp_static
*, afi_t
, safi_t
);
394 extern void bgp_static_withdraw(struct bgp
*, struct prefix
*, afi_t
, safi_t
);
396 extern int bgp_static_set_safi(afi_t afi
, safi_t safi
, struct vty
*vty
,
397 const char *, const char *, const char *,
398 const char *, int, const char *, const char *,
399 const char *, const char *);
401 extern int bgp_static_unset_safi(afi_t afi
, safi_t safi
, struct vty
*,
402 const char *, const char *, const char *, int,
403 const char *, const char *, const char *);
405 /* this is primarily for MPLS-VPN */
406 extern int bgp_update(struct peer
*, struct prefix
*, uint32_t, struct attr
*,
407 afi_t
, safi_t
, int, int, struct prefix_rd
*,
408 mpls_label_t
*, uint32_t, int, struct bgp_route_evpn
*);
409 extern int bgp_withdraw(struct peer
*, struct prefix
*, uint32_t, struct attr
*,
410 afi_t
, safi_t
, int, int, struct prefix_rd
*,
411 mpls_label_t
*, uint32_t, struct bgp_route_evpn
*);
413 /* for bgp_nexthop and bgp_damp */
414 extern void bgp_process(struct bgp
*, struct bgp_node
*, afi_t
, safi_t
);
417 * Add an end-of-initial-update marker to the process queue. This is just a
418 * queue element with NULL bgp node.
420 extern void bgp_add_eoiu_mark(struct bgp
*);
421 extern void bgp_config_write_table_map(struct vty
*, struct bgp
*, afi_t
,
423 extern void bgp_config_write_network(struct vty
*, struct bgp
*, afi_t
, safi_t
);
424 extern void bgp_config_write_distance(struct vty
*, struct bgp
*, afi_t
,
427 extern void bgp_aggregate_increment(struct bgp
*bgp
, struct prefix
*p
,
428 struct bgp_path_info
*path
, afi_t afi
,
430 extern void bgp_aggregate_decrement(struct bgp
*bgp
, struct prefix
*p
,
431 struct bgp_path_info
*path
, afi_t afi
,
434 extern uint8_t bgp_distance_apply(struct prefix
*p
, struct bgp_path_info
*path
,
435 afi_t afi
, safi_t safi
, struct bgp
*bgp
);
437 extern afi_t
bgp_node_afi(struct vty
*);
438 extern safi_t
bgp_node_safi(struct vty
*);
440 extern struct bgp_path_info
*info_make(int type
, int sub_type
,
441 unsigned short instance
,
442 struct peer
*peer
, struct attr
*attr
,
443 struct bgp_node
*rn
);
445 extern void route_vty_out(struct vty
*vty
, struct prefix
*p
,
446 struct bgp_path_info
*path
, int display
, safi_t safi
,
447 json_object
*json_paths
);
448 extern void route_vty_out_tag(struct vty
*vty
, struct prefix
*p
,
449 struct bgp_path_info
*path
, int display
,
450 safi_t safi
, json_object
*json
);
451 extern void route_vty_out_tmp(struct vty
*vty
, struct prefix
*p
,
452 struct attr
*attr
, safi_t safi
, bool use_json
,
453 json_object
*json_ar
);
454 extern void route_vty_out_overlay(struct vty
*vty
, struct prefix
*p
,
455 struct bgp_path_info
*binfo
, int display
,
458 extern int subgroup_process_announce_selected(struct update_subgroup
*subgrp
,
459 struct bgp_path_info
*selected
,
461 uint32_t addpath_tx_id
);
463 extern int subgroup_announce_check(struct bgp_node
*rn
,
464 struct bgp_path_info
*ri
,
465 struct update_subgroup
*subgrp
,
466 struct prefix
*p
, struct attr
*attr
);
468 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer
*peer
);
469 extern void bgp_process_queues_drain_immediate(void);
472 extern struct bgp_node
*bgp_afi_node_lookup(struct bgp_table
*table
, afi_t afi
,
473 safi_t safi
, struct prefix
*p
,
474 struct prefix_rd
*prd
);
475 extern struct bgp_path_info
*bgp_info_new(void);
476 extern void bgp_info_restore(struct bgp_node
*rn
, struct bgp_path_info
*path
);
478 extern int bgp_info_cmp_compatible(struct bgp
*bgp
, struct bgp_path_info
*new,
479 struct bgp_path_info
*exist
, char *pfx_buf
,
480 afi_t afi
, safi_t safi
);
481 extern void bgp_attr_add_gshut_community(struct attr
*attr
);
483 extern void bgp_best_selection(struct bgp
*bgp
, struct bgp_node
*rn
,
484 struct bgp_maxpaths_cfg
*mpath_cfg
,
485 struct bgp_path_info_pair
*result
, afi_t afi
,
487 extern void bgp_zebra_clear_route_change_flags(struct bgp_node
*rn
);
488 extern int bgp_zebra_has_route_changed(struct bgp_node
*rn
,
489 struct bgp_path_info
*selected
);
491 extern void route_vty_out_detail_header(struct vty
*vty
, struct bgp
*bgp
,
493 struct prefix_rd
*prd
, afi_t afi
,
494 safi_t safi
, json_object
*json
);
495 extern void route_vty_out_detail(struct vty
*vty
, struct bgp
*bgp
,
496 struct prefix
*p
, struct bgp_path_info
*binfo
,
497 afi_t afi
, safi_t safi
,
498 json_object
*json_paths
);
499 extern int bgp_show_table_rd(struct vty
*vty
, struct bgp
*bgp
, safi_t safi
,
500 struct bgp_table
*table
, struct prefix_rd
*prd
,
501 enum bgp_show_type type
, void *output_arg
,
503 #endif /* _QUAGGA_BGP_ROUTE_H */