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. */
76 /* MPLS label - L2VNI */
79 /* MPLS label - L3-VNI */
86 void *rfapi_handle
; /* export: NVE advertising this
88 struct list
*local_nexthops
; /* optional, for static
94 void *hme
; /* encap monitor, if this is a VPN route */
96 rd
; /* import: route's route-distinguisher */
97 u_char un_family
; /* family of cached un address, 0 if
100 struct in_addr addr4
;
101 struct in6_addr addr6
;
102 } un
; /* cached un address */
106 aux_prefix
; /* AFI_L2VPN: the IP addr,
113 /* For imported routes into a VNI (or VRF), this points to the parent.
119 /* For linked list. */
120 struct bgp_info
*next
;
121 struct bgp_info
*prev
;
123 /* For nexthop linked list */
124 LIST_ENTRY(bgp_info
) nh_thread
;
126 /* Back pointer to the prefix node */
127 struct bgp_node
*net
;
129 /* Back pointer to the nexthop structure */
130 struct bgp_nexthop_cache
*nexthop
;
132 /* Peer structure. */
135 /* Attribute structure. */
138 /* Extra information */
139 struct bgp_info_extra
*extra
;
142 /* Multipath information */
143 struct bgp_info_mpath
*mpath
;
148 /* reference count */
151 /* BGP information status. */
153 #define BGP_INFO_IGP_CHANGED (1 << 0)
154 #define BGP_INFO_DAMPED (1 << 1)
155 #define BGP_INFO_HISTORY (1 << 2)
156 #define BGP_INFO_SELECTED (1 << 3)
157 #define BGP_INFO_VALID (1 << 4)
158 #define BGP_INFO_ATTR_CHANGED (1 << 5)
159 #define BGP_INFO_DMED_CHECK (1 << 6)
160 #define BGP_INFO_DMED_SELECTED (1 << 7)
161 #define BGP_INFO_STALE (1 << 8)
162 #define BGP_INFO_REMOVED (1 << 9)
163 #define BGP_INFO_COUNTED (1 << 10)
164 #define BGP_INFO_MULTIPATH (1 << 11)
165 #define BGP_INFO_MULTIPATH_CHG (1 << 12)
166 #define BGP_INFO_RIB_ATTR_CHG (1 << 13)
168 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
171 /* When above type is BGP. This sub type specify BGP sub type
174 #define BGP_ROUTE_NORMAL 0
175 #define BGP_ROUTE_STATIC 1
176 #define BGP_ROUTE_AGGREGATE 2
177 #define BGP_ROUTE_REDISTRIBUTE 3
178 #ifdef ENABLE_BGP_VNC
179 # define BGP_ROUTE_RFP 4
184 /* Addpath identifiers */
185 u_int32_t addpath_rx_id
;
186 u_int32_t addpath_tx_id
;
189 /* Structure used in BGP path selection */
190 struct bgp_info_pair
{
191 struct bgp_info
*old
;
192 struct bgp_info
*new;
195 /* BGP static route configuration. */
197 /* Backdoor configuration. */
200 /* Label index configuration; applies to LU prefixes. */
201 u_int32_t label_index
;
202 #define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
204 /* Import check status. */
211 struct in_addr igpnexthop
;
213 /* Atomic set reference count (ie cause of pathlimit) */
216 /* BGP redistribute route-map. */
219 struct route_map
*map
;
222 /* Route Distinguisher */
223 struct prefix_rd prd
;
229 struct eth_segment_id
*eth_s_id
;
230 struct ethaddr
*router_mac
;
231 uint16_t encap_tunneltype
;
232 struct prefix gatewayIp
;
235 #define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
236 ((nhlen) < IPV4_MAX_BYTELEN \
238 : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
240 #define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
241 (!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
242 && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
243 #define BGP_INFO_COUNTABLE(BI) \
244 (!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY) \
245 && !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))
247 /* Flags which indicate a route is unuseable in some form */
248 #define BGP_INFO_UNUSEABLE \
249 (BGP_INFO_HISTORY | BGP_INFO_DAMPED | BGP_INFO_REMOVED)
250 /* Macro to check BGP information is alive or not. Sadly,
251 * not equivalent to just checking previous, because of the
252 * sense of the additional VALID flag.
254 #define BGP_INFO_HOLDDOWN(BI) \
255 (!CHECK_FLAG((BI)->flags, BGP_INFO_VALID) \
256 || CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))
258 #define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
259 #define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
260 #define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
261 #define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
263 #define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
264 #define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
265 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
266 #define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
268 #define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
269 #define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
270 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
271 #define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
273 #define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
274 #define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
275 #define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
276 #define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
278 #define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
279 #define UNSUPPRESS_MAP(F) ((F)->usmap.map)
281 /* path PREFIX (addpath rxid NUMBER) */
282 #define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
284 enum bgp_path_type
{ BGP_PATH_ALL
, BGP_PATH_BESTPATH
, BGP_PATH_MULTIPATH
};
286 static inline void bgp_bump_version(struct bgp_node
*node
)
288 node
->version
= bgp_table_next_version(bgp_node_table(node
));
291 static inline int bgp_fibupd_safi(safi_t safi
)
293 if (safi
== SAFI_UNICAST
|| safi
== SAFI_MULTICAST
294 || safi
== SAFI_LABELED_UNICAST
)
300 extern void bgp_rib_remove(struct bgp_node
*rn
, struct bgp_info
*ri
,
301 struct peer
*peer
, afi_t afi
, safi_t safi
);
302 extern void bgp_process_queue_init(void);
303 extern void bgp_route_init(void);
304 extern void bgp_route_finish(void);
305 extern void bgp_cleanup_routes(struct bgp
*);
306 extern void bgp_announce_route(struct peer
*, afi_t
, safi_t
);
307 extern void bgp_stop_announce_route_timer(struct peer_af
*paf
);
308 extern void bgp_announce_route_all(struct peer
*);
309 extern void bgp_default_originate(struct peer
*, afi_t
, safi_t
, int);
310 extern void bgp_soft_reconfig_in(struct peer
*, afi_t
, safi_t
);
311 extern void bgp_clear_route(struct peer
*, afi_t
, safi_t
);
312 extern void bgp_clear_route_all(struct peer
*);
313 extern void bgp_clear_adj_in(struct peer
*, afi_t
, safi_t
);
314 extern void bgp_clear_stale_route(struct peer
*, afi_t
, safi_t
);
316 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*table
, afi_t afi
,
317 safi_t safi
, struct prefix
*p
,
318 struct prefix_rd
*prd
);
319 extern struct bgp_info
*bgp_info_lock(struct bgp_info
*);
320 extern struct bgp_info
*bgp_info_unlock(struct bgp_info
*);
321 extern void bgp_info_add(struct bgp_node
*rn
, struct bgp_info
*ri
);
322 extern void bgp_info_reap(struct bgp_node
*rn
, struct bgp_info
*ri
);
323 extern void bgp_info_delete(struct bgp_node
*rn
, struct bgp_info
*ri
);
324 extern struct bgp_info_extra
*bgp_info_extra_get(struct bgp_info
*);
325 extern void bgp_info_set_flag(struct bgp_node
*, struct bgp_info
*, u_int32_t
);
326 extern void bgp_info_unset_flag(struct bgp_node
*, struct bgp_info
*,
328 extern void bgp_info_path_with_addpath_rx_str(struct bgp_info
*ri
, char *buf
);
330 extern int bgp_nlri_parse_ip(struct peer
*, struct attr
*, struct bgp_nlri
*);
332 extern int bgp_maximum_prefix_overflow(struct peer
*, afi_t
, safi_t
, int);
334 extern void bgp_redistribute_add(struct bgp
*bgp
, struct prefix
*p
,
335 const union g_addr
*nexthop
, ifindex_t ifindex
,
336 enum nexthop_types_t nhtype
, uint32_t metric
,
337 u_char type
, u_short instance
,
339 extern void bgp_redistribute_delete(struct bgp
*, struct prefix
*, u_char
,
341 extern void bgp_redistribute_withdraw(struct bgp
*, afi_t
, int, u_short
);
343 extern void bgp_static_add(struct bgp
*);
344 extern void bgp_static_delete(struct bgp
*);
345 extern void bgp_static_redo_import_check(struct bgp
*);
346 extern void bgp_purge_static_redist_routes(struct bgp
*bgp
);
347 extern void bgp_static_update(struct bgp
*, struct prefix
*,
348 struct bgp_static
*, afi_t
, safi_t
);
349 extern void bgp_static_withdraw(struct bgp
*, struct prefix
*, afi_t
, safi_t
);
351 extern int bgp_static_set_safi(afi_t afi
, safi_t safi
, struct vty
*vty
,
352 const char *, const char *, const char *,
353 const char *, int, const char *, const char *,
354 const char *, const char *);
356 extern int bgp_static_unset_safi(afi_t afi
, safi_t safi
, struct vty
*,
357 const char *, const char *, const char *, int,
358 const char *, const char *, const char *);
360 /* this is primarily for MPLS-VPN */
361 extern int bgp_update(struct peer
*, struct prefix
*, u_int32_t
, struct attr
*,
362 afi_t
, safi_t
, int, int, struct prefix_rd
*,
363 mpls_label_t
*, int, struct bgp_route_evpn
*);
364 extern int bgp_withdraw(struct peer
*, struct prefix
*, u_int32_t
,
365 struct attr
*, afi_t
, safi_t
, int, int,
366 struct prefix_rd
*, mpls_label_t
*,
367 struct bgp_route_evpn
*);
369 /* for bgp_nexthop and bgp_damp */
370 extern void bgp_process(struct bgp
*, struct bgp_node
*, afi_t
, safi_t
);
373 * Add an end-of-initial-update marker to the process queue. This is just a
374 * queue element with NULL bgp node.
376 extern void bgp_add_eoiu_mark(struct bgp
*);
377 extern void bgp_config_write_table_map(struct vty
*, struct bgp
*, afi_t
,
379 extern void bgp_config_write_network(struct vty
*, struct bgp
*, afi_t
, safi_t
);
380 extern void bgp_config_write_distance(struct vty
*, struct bgp
*, afi_t
,
383 extern void bgp_aggregate_increment(struct bgp
*, struct prefix
*,
384 struct bgp_info
*, afi_t
, safi_t
);
385 extern void bgp_aggregate_decrement(struct bgp
*, struct prefix
*,
386 struct bgp_info
*, afi_t
, safi_t
);
388 extern u_char
bgp_distance_apply(struct prefix
*, struct bgp_info
*, afi_t
,
389 safi_t
, struct bgp
*);
391 extern afi_t
bgp_node_afi(struct vty
*);
392 extern safi_t
bgp_node_safi(struct vty
*);
394 extern struct bgp_info
*info_make(int type
, int sub_type
, u_short instance
,
395 struct peer
*peer
, struct attr
*attr
,
396 struct bgp_node
*rn
);
398 extern void route_vty_out(struct vty
*, struct prefix
*, struct bgp_info
*, int,
399 safi_t
, json_object
*);
400 extern void route_vty_out_tag(struct vty
*, struct prefix
*, struct bgp_info
*,
401 int, safi_t
, json_object
*);
402 extern void route_vty_out_tmp(struct vty
*, struct prefix
*, struct attr
*,
403 safi_t
, u_char
, json_object
*);
404 extern void route_vty_out_overlay(struct vty
*vty
, struct prefix
*p
,
405 struct bgp_info
*binfo
, int display
,
408 extern int subgroup_process_announce_selected(struct update_subgroup
*subgrp
,
409 struct bgp_info
*selected
,
411 u_int32_t addpath_tx_id
);
413 extern int subgroup_announce_check(struct bgp_node
*rn
, struct bgp_info
*ri
,
414 struct update_subgroup
*subgrp
,
415 struct prefix
*p
, struct attr
*attr
);
417 extern void bgp_peer_clear_node_queue_drain_immediate(struct peer
*peer
);
418 extern void bgp_process_queues_drain_immediate(void);
421 extern struct bgp_node
*bgp_afi_node_get(struct bgp_table
*, afi_t
, safi_t
,
422 struct prefix
*, struct prefix_rd
*);
423 extern struct bgp_node
*bgp_afi_node_lookup(struct bgp_table
*table
, afi_t afi
,
424 safi_t safi
, struct prefix
*p
,
425 struct prefix_rd
*prd
);
426 extern struct bgp_info
*bgp_info_new(void);
427 extern void bgp_info_restore(struct bgp_node
*, struct bgp_info
*);
429 extern int bgp_info_cmp_compatible(struct bgp
*, struct bgp_info
*,
430 struct bgp_info
*, char *pfx_buf
, afi_t afi
,
432 extern void bgp_attr_add_gshut_community(struct attr
*attr
);
434 extern void bgp_best_selection(struct bgp
*bgp
, struct bgp_node
*rn
,
435 struct bgp_maxpaths_cfg
*mpath_cfg
,
436 struct bgp_info_pair
*result
, afi_t afi
,
438 extern void bgp_zebra_clear_route_change_flags(struct bgp_node
*rn
);
439 extern int bgp_zebra_has_route_changed(struct bgp_node
*rn
,
440 struct bgp_info
*selected
);
442 extern void route_vty_out_detail_header(struct vty
*vty
, struct bgp
*bgp
,
444 struct prefix_rd
*prd
, afi_t afi
,
445 safi_t safi
, json_object
*json
);
446 extern void route_vty_out_detail(struct vty
*vty
, struct bgp
*bgp
,
447 struct prefix
*p
, struct bgp_info
*binfo
,
448 afi_t afi
, safi_t safi
,
449 json_object
*json_paths
);
450 extern int bgp_show_table_rd(struct vty
*vty
, struct bgp
*bgp
, safi_t safi
,
451 struct bgp_table
*table
, struct prefix_rd
*prd
,
452 enum bgp_show_type type
, void *output_arg
,
454 #endif /* _QUAGGA_BGP_ROUTE_H */