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"
27 #include "bgp_addpath_types.h"
29 struct bgp_nexthop_cache
;
30 struct bgp_route_evpn
;
35 bgp_show_type_prefix_list
,
36 bgp_show_type_filter_list
,
37 bgp_show_type_route_map
,
38 bgp_show_type_neighbor
,
39 bgp_show_type_cidr_only
,
40 bgp_show_type_prefix_longer
,
41 bgp_show_type_community_all
,
42 bgp_show_type_community
,
43 bgp_show_type_community_exact
,
44 bgp_show_type_community_list
,
45 bgp_show_type_community_list_exact
,
46 bgp_show_type_lcommunity_all
,
47 bgp_show_type_lcommunity
,
48 bgp_show_type_lcommunity_list
,
49 bgp_show_type_flap_statistics
,
50 bgp_show_type_flap_neighbor
,
51 bgp_show_type_dampend_paths
,
52 bgp_show_type_damp_neighbor
,
56 enum bgp_show_adj_route_type
{
57 bgp_show_adj_route_advertised
,
58 bgp_show_adj_route_received
,
59 bgp_show_adj_route_filtered
,
63 #define BGP_SHOW_SCODE_HEADER \
64 "Status codes: s suppressed, d damped, " \
65 "h history, * valid, > best, = multipath,\n" \
66 " i internal, r RIB-failure, S Stale, R Removed\n"
67 #define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
68 #define BGP_SHOW_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
69 #define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path\n"
71 /* Maximum number of labels we can process or send with a prefix. We
72 * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
74 #define BGP_MAX_LABELS 2
76 /* Ancillary information to struct bgp_path_info,
77 * used for uncommonly used data (aggregation, MPLS, etc.)
78 * and lazily allocated to save memory.
80 struct bgp_path_info_extra
{
81 /* Pointer to dampening structure. */
82 struct bgp_damp_info
*damp_info
;
84 /* This route is suppressed with aggregation. */
87 /* Nexthop reachability check. */
90 /* MPLS label(s) - VNI(s) for EVPN-VxLAN */
91 mpls_label_t label
[BGP_MAX_LABELS
];
98 void *rfapi_handle
; /* export: NVE advertising this
100 struct list
*local_nexthops
; /* optional, for static
105 struct thread
*timer
;
106 void *hme
; /* encap monitor, if this is a VPN route */
108 rd
; /* import: route's route-distinguisher */
109 uint8_t un_family
; /* family of cached un address, 0 if
112 struct in_addr addr4
;
113 struct in6_addr addr6
;
114 } un
; /* cached un address */
116 struct prefix aux_prefix
; /* AFI_L2VPN: the IP addr,
123 /* For imported routes into a VNI (or VRF), this points to the parent.
128 * Some tunnelish parameters follow. Maybe consolidate into an
129 * internal tunnel structure?
133 * Original bgp instance for imported routes. Needed for:
134 * 1. Find all routes from a specific vrf for deletion
135 * 2. vrf context of original nexthop
137 * Store pointer to bgp instance rather than bgp->vrf_id because
138 * bgp->vrf_id is not always valid (or may change?).
140 * Set to NULL if route is not imported from another bgp instance.
142 struct bgp
*bgp_orig
;
145 * Nexthop in context of original bgp instance. Needed
146 * for label resolution of core mpls routes exported to a vrf.
147 * Set nexthop_orig.family to 0 if not valid.
149 struct prefix nexthop_orig
;
150 /* presence of FS pbr entry */
151 struct list
*bgp_fs_pbr
;
154 struct bgp_path_info
{
155 /* For linked list. */
156 struct bgp_path_info
*next
;
157 struct bgp_path_info
*prev
;
159 /* For nexthop linked list */
160 LIST_ENTRY(bgp_path_info
) nh_thread
;
162 /* Back pointer to the prefix node */
163 struct bgp_node
*net
;
165 /* Back pointer to the nexthop structure */
166 struct bgp_nexthop_cache
*nexthop
;
168 /* Peer structure. */
171 /* Attribute structure. */
174 /* Extra information */
175 struct bgp_path_info_extra
*extra
;
178 /* Multipath information */
179 struct bgp_path_info_mpath
*mpath
;
184 /* reference count */
187 /* BGP information status. */
189 #define BGP_PATH_IGP_CHANGED (1 << 0)
190 #define BGP_PATH_DAMPED (1 << 1)
191 #define BGP_PATH_HISTORY (1 << 2)
192 #define BGP_PATH_SELECTED (1 << 3)
193 #define BGP_PATH_VALID (1 << 4)
194 #define BGP_PATH_ATTR_CHANGED (1 << 5)
195 #define BGP_PATH_DMED_CHECK (1 << 6)
196 #define BGP_PATH_DMED_SELECTED (1 << 7)
197 #define BGP_PATH_STALE (1 << 8)
198 #define BGP_PATH_REMOVED (1 << 9)
199 #define BGP_PATH_COUNTED (1 << 10)
200 #define BGP_PATH_MULTIPATH (1 << 11)
201 #define BGP_PATH_MULTIPATH_CHG (1 << 12)
202 #define BGP_PATH_RIB_ATTR_CHG (1 << 13)
203 #define BGP_PATH_ANNC_NH_SELF (1 << 14)
205 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
208 /* When above type is BGP. This sub type specify BGP sub type
211 #define BGP_ROUTE_NORMAL 0
212 #define BGP_ROUTE_STATIC 1
213 #define BGP_ROUTE_AGGREGATE 2
214 #define BGP_ROUTE_REDISTRIBUTE 3
215 #ifdef ENABLE_BGP_VNC
216 # define BGP_ROUTE_RFP 4
218 #define BGP_ROUTE_IMPORTED 5 /* from another bgp instance/safi */
220 unsigned short instance
;
222 /* Addpath identifiers */
223 uint32_t addpath_rx_id
;
224 struct bgp_addpath_info_data tx_addpath
;
227 /* Structure used in BGP path selection */
228 struct bgp_path_info_pair
{
229 struct bgp_path_info
*old
;
230 struct bgp_path_info
*new;
233 /* BGP static route configuration. */
235 /* Backdoor configuration. */
238 /* Label index configuration; applies to LU prefixes. */
239 uint32_t label_index
;
240 #define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
242 /* Import check status. */
249 struct in_addr igpnexthop
;
251 /* Atomic set reference count (ie cause of pathlimit) */
254 /* BGP redistribute route-map. */
257 struct route_map
*map
;
260 /* Route Distinguisher */
261 struct prefix_rd prd
;
267 struct eth_segment_id
*eth_s_id
;
268 struct ethaddr
*router_mac
;
269 uint16_t encap_tunneltype
;
270 struct prefix gatewayIp
;
273 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
274 ((nhlen) < IPV4_MAX_BYTELEN \
276 : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
278 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
279 (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
280 && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
281 #define BGP_PATH_COUNTABLE(BI) \
282 (!CHECK_FLAG((BI)->flags, BGP_PATH_HISTORY) \
283 && !CHECK_FLAG((BI)->flags, BGP_PATH_REMOVED))
285 /* Flags which indicate a route is unuseable in some form */
286 #define BGP_PATH_UNUSEABLE \
287 (BGP_PATH_HISTORY | BGP_PATH_DAMPED | BGP_PATH_REMOVED)
288 /* Macro to check BGP information is alive or not. Sadly,
289 * not equivalent to just checking previous, because of the
290 * sense of the additional VALID flag.
292 #define BGP_PATH_HOLDDOWN(BI) \
293 (!CHECK_FLAG((BI)->flags, BGP_PATH_VALID) \
294 || CHECK_FLAG((BI)->flags, BGP_PATH_UNUSEABLE))
296 #define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
297 #define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
298 #define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
299 #define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
301 #define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
302 #define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
303 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
304 #define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
306 #define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
307 #define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
308 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
309 #define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
311 #define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
312 #define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
313 #define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
314 #define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
316 #define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
317 #define UNSUPPRESS_MAP(F) ((F)->usmap.map)
319 /* path PREFIX (addpath rxid NUMBER) */
320 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
324 BGP_PATH_SHOW_BESTPATH
,
325 BGP_PATH_SHOW_MULTIPATH
328 static inline void bgp_bump_version(struct bgp_node
*node
)
330 node
->version
= bgp_table_next_version(bgp_node_table(node
));
333 static inline int bgp_fibupd_safi(safi_t safi
)
335 if (safi
== SAFI_UNICAST
|| safi
== SAFI_MULTICAST
336 || safi
== SAFI_LABELED_UNICAST
337 || safi
== SAFI_FLOWSPEC
)
343 extern void bgp_rib_remove(struct bgp_node
*rn
, struct bgp_path_info
*pi
,
344 struct peer
*peer
, afi_t afi
, safi_t safi
);
345 extern void bgp_process_queue_init(void);
346 extern void bgp_route_init(void);
347 extern void bgp_route_finish(void);
348 extern void bgp_cleanup_routes(struct bgp
*);
349 extern void bgp_announce_route(struct peer
*, afi_t
, safi_t
);
350 extern void bgp_stop_announce_route_timer(struct peer_af
*paf
);
351 extern void bgp_announce_route_all(struct peer
*);
352 extern void bgp_default_originate(struct peer
*, afi_t
, safi_t
, int);
353 extern void bgp_soft_reconfig_in(struct peer
*, afi_t
, safi_t
);
354 extern void bgp_clear_route(struct peer
*, afi_t
, safi_t
);
355 extern void bgp_clear_route_all(struct peer
*);
356 extern void bgp_clear_adj_in(struct peer
*, afi_t
, safi_t
);
357 extern void bgp_clear_stale_route(struct peer
*, afi_t
, safi_t
);
359 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*table
, afi_t afi
,
360 safi_t safi
, struct prefix
*p
,
361 struct prefix_rd
*prd
);
362 extern struct bgp_path_info
*bgp_path_info_lock(struct bgp_path_info
*path
);
363 extern struct bgp_path_info
*bgp_path_info_unlock(struct bgp_path_info
*path
);
364 extern void bgp_path_info_add(struct bgp_node
*rn
, struct bgp_path_info
*pi
);
365 extern void bgp_path_info_reap(struct bgp_node
*rn
, struct bgp_path_info
*pi
);
366 extern void bgp_path_info_delete(struct bgp_node
*rn
, struct bgp_path_info
*pi
);
367 extern struct bgp_path_info_extra
*
368 bgp_path_info_extra_get(struct bgp_path_info
*path
);
369 extern void bgp_path_info_set_flag(struct bgp_node
*rn
,
370 struct bgp_path_info
*path
, uint32_t flag
);
371 extern void bgp_path_info_unset_flag(struct bgp_node
*rn
,
372 struct bgp_path_info
*path
, uint32_t flag
);
373 extern void bgp_path_info_path_with_addpath_rx_str(struct bgp_path_info
*pi
,
376 extern int bgp_nlri_parse_ip(struct peer
*, struct attr
*, struct bgp_nlri
*);
378 extern int bgp_maximum_prefix_overflow(struct peer
*, afi_t
, safi_t
, int);
380 extern void bgp_redistribute_add(struct bgp
*bgp
, struct prefix
*p
,
381 const union g_addr
*nexthop
, ifindex_t ifindex
,
382 enum nexthop_types_t nhtype
, uint32_t metric
,
383 uint8_t type
, unsigned short instance
,
385 extern void bgp_redistribute_delete(struct bgp
*, struct prefix
*, uint8_t,
387 extern void bgp_redistribute_withdraw(struct bgp
*, afi_t
, int, unsigned short);
389 extern void bgp_static_add(struct bgp
*);
390 extern void bgp_static_delete(struct bgp
*);
391 extern void bgp_static_redo_import_check(struct bgp
*);
392 extern void bgp_purge_static_redist_routes(struct bgp
*bgp
);
393 extern void bgp_static_update(struct bgp
*, struct prefix
*,
394 struct bgp_static
*, afi_t
, safi_t
);
395 extern void bgp_static_withdraw(struct bgp
*, struct prefix
*, afi_t
, safi_t
);
397 extern int bgp_static_set_safi(afi_t afi
, safi_t safi
, struct vty
*vty
,
398 const char *, const char *, const char *,
399 const char *, int, const char *, const char *,
400 const char *, const char *);
402 extern int bgp_static_unset_safi(afi_t afi
, safi_t safi
, struct vty
*,
403 const char *, const char *, const char *, int,
404 const char *, const char *, const char *);
406 /* this is primarily for MPLS-VPN */
407 extern int bgp_update(struct peer
*, struct prefix
*, uint32_t, struct attr
*,
408 afi_t
, safi_t
, int, int, struct prefix_rd
*,
409 mpls_label_t
*, uint32_t, int, struct bgp_route_evpn
*);
410 extern int bgp_withdraw(struct peer
*, struct prefix
*, uint32_t, struct attr
*,
411 afi_t
, safi_t
, int, int, struct prefix_rd
*,
412 mpls_label_t
*, uint32_t, struct bgp_route_evpn
*);
414 /* for bgp_nexthop and bgp_damp */
415 extern void bgp_process(struct bgp
*, struct bgp_node
*, afi_t
, safi_t
);
418 * Add an end-of-initial-update marker to the process queue. This is just a
419 * queue element with NULL bgp node.
421 extern void bgp_add_eoiu_mark(struct bgp
*);
422 extern void bgp_config_write_table_map(struct vty
*, struct bgp
*, afi_t
,
424 extern void bgp_config_write_network(struct vty
*, struct bgp
*, afi_t
, safi_t
);
425 extern void bgp_config_write_distance(struct vty
*, struct bgp
*, afi_t
,
428 extern void bgp_aggregate_increment(struct bgp
*bgp
, struct prefix
*p
,
429 struct bgp_path_info
*path
, afi_t afi
,
431 extern void bgp_aggregate_decrement(struct bgp
*bgp
, struct prefix
*p
,
432 struct bgp_path_info
*path
, afi_t afi
,
435 extern uint8_t bgp_distance_apply(struct prefix
*p
, struct bgp_path_info
*path
,
436 afi_t afi
, safi_t safi
, struct bgp
*bgp
);
438 extern afi_t
bgp_node_afi(struct vty
*);
439 extern safi_t
bgp_node_safi(struct vty
*);
441 extern struct bgp_path_info
*info_make(int type
, int sub_type
,
442 unsigned short instance
,
443 struct peer
*peer
, struct attr
*attr
,
444 struct bgp_node
*rn
);
446 extern void route_vty_out(struct vty
*vty
, struct prefix
*p
,
447 struct bgp_path_info
*path
, int display
, safi_t safi
,
448 json_object
*json_paths
);
449 extern void route_vty_out_tag(struct vty
*vty
, struct prefix
*p
,
450 struct bgp_path_info
*path
, int display
,
451 safi_t safi
, json_object
*json
);
452 extern void route_vty_out_tmp(struct vty
*vty
, struct prefix
*p
,
453 struct attr
*attr
, safi_t safi
, bool use_json
,
454 json_object
*json_ar
);
455 extern void route_vty_out_overlay(struct vty
*vty
, struct prefix
*p
,
456 struct bgp_path_info
*path
, int display
,
459 extern int subgroup_process_announce_selected(struct update_subgroup
*subgrp
,
460 struct bgp_path_info
*selected
,
462 uint32_t addpath_tx_id
);
464 extern int subgroup_announce_check(struct bgp_node
*rn
,
465 struct bgp_path_info
*pi
,
466 struct update_subgroup
*subgrp
,
467 struct prefix
*p
, struct attr
*attr
);
469 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer
*peer
);
470 extern void bgp_process_queues_drain_immediate(void);
473 extern struct bgp_node
*bgp_afi_node_lookup(struct bgp_table
*table
, afi_t afi
,
474 safi_t safi
, struct prefix
*p
,
475 struct prefix_rd
*prd
);
476 extern struct bgp_path_info
*bgp_path_info_new(void);
477 extern void bgp_path_info_restore(struct bgp_node
*rn
,
478 struct bgp_path_info
*path
);
480 extern int bgp_path_info_cmp_compatible(struct bgp
*bgp
,
481 struct bgp_path_info
*new,
482 struct bgp_path_info
*exist
,
483 char *pfx_buf
, afi_t afi
, safi_t safi
);
484 extern void bgp_attr_add_gshut_community(struct attr
*attr
);
486 extern void bgp_best_selection(struct bgp
*bgp
, struct bgp_node
*rn
,
487 struct bgp_maxpaths_cfg
*mpath_cfg
,
488 struct bgp_path_info_pair
*result
, afi_t afi
,
490 extern void bgp_zebra_clear_route_change_flags(struct bgp_node
*rn
);
491 extern int bgp_zebra_has_route_changed(struct bgp_node
*rn
,
492 struct bgp_path_info
*selected
);
494 extern void route_vty_out_detail_header(struct vty
*vty
, struct bgp
*bgp
,
496 struct prefix_rd
*prd
, afi_t afi
,
497 safi_t safi
, json_object
*json
);
498 extern void route_vty_out_detail(struct vty
*vty
, struct bgp
*bgp
,
499 struct prefix
*p
, struct bgp_path_info
*path
,
500 afi_t afi
, safi_t safi
,
501 json_object
*json_paths
);
502 extern int bgp_show_table_rd(struct vty
*vty
, struct bgp
*bgp
, safi_t safi
,
503 struct bgp_table
*table
, struct prefix_rd
*prd
,
504 enum bgp_show_type type
, void *output_arg
,
506 #endif /* _QUAGGA_BGP_ROUTE_H */