1 /* BGP message definition header.
2 * Copyright (C) 1996, 97, 98, 99, 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_BGPD_H
22 #define _QUAGGA_BGPD_H
28 #include "frr_pthread.h"
35 /* For union sockunion. */
37 #include "sockunion.h"
41 #include "bgp_memory.h"
44 #include "bgp_labelpool.h"
45 #include "bgp_addpath_types.h"
46 #include "bgp_nexthop.h"
51 #define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
52 #define BGP_PEER_MAX_HASH_SIZE 16384
54 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
55 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
57 struct update_subgroup
;
59 struct bgp_pbr_config
;
62 * Allow the neighbor XXXX remote-as to take internal or external
63 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
67 enum { AS_UNSPECIFIED
= 0,
73 /* Zebra Gracaful Restart states */
79 /* Typedef BGP specific types. */
80 typedef uint32_t as_t
;
81 typedef uint16_t as16_t
; /* we may still encounter 16 Bit asnums */
82 typedef uint16_t bgp_size_t
;
86 BGP_AF_IPV4_UNICAST
= BGP_AF_START
,
87 BGP_AF_IPV4_MULTICAST
,
90 BGP_AF_IPV6_MULTICAST
,
95 BGP_AF_IPV4_LBL_UNICAST
,
96 BGP_AF_IPV6_LBL_UNICAST
,
102 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
104 #define FOREACH_SAFI(safi) \
105 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
107 extern struct frr_pthread
*bgp_pth_io
;
108 extern struct frr_pthread
*bgp_pth_ka
;
110 /* BGP master for system wide configurations and variables. */
112 /* BGP instance list. */
115 /* BGP thread master. */
116 struct thread_master
*master
;
118 /* Listening sockets */
119 struct list
*listen_sockets
;
121 /* BGP port number. */
124 /* Listener addresses */
125 struct list
*addresses
;
128 struct hash
*self_mac_hash
;
130 /* BGP start time. */
133 /* Various BGP global configuration. */
135 #define BGP_OPT_NO_FIB (1 << 0)
136 #define BGP_OPT_NO_LISTEN (1 << 1)
137 #define BGP_OPT_NO_ZEBRA (1 << 2)
139 uint64_t updgrp_idspace
;
140 uint64_t subgrp_idspace
;
142 /* timer to dampen route map changes */
143 struct thread
*t_rmap_update
; /* Handle route map updates */
144 uint32_t rmap_update_timer
; /* Route map update timer */
145 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
147 /* Id space for automatic RD derivation for an EVI/VRF */
148 bitfield_t rd_idspace
;
150 /* dynamic mpls label allocation pool */
151 struct labelpool labelpool
;
153 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
154 struct bgp
* bgp_evpn
;
156 /* How big should we set the socket buffer size */
157 uint32_t socket_buffer
;
159 /* Should we do wait for fib install globally? */
162 /* EVPN multihoming */
163 struct bgp_evpn_mh_info
*mh_info
;
165 /* global update-delay timer values */
166 uint16_t v_update_delay
;
167 uint16_t v_establish_wait
;
170 #define BM_FLAG_GRACEFUL_SHUTDOWN (1 << 0)
171 #define BM_FLAG_SEND_EXTRA_DATA_TO_ZEBRA (1 << 1)
173 bool terminating
; /* global flag that sigint terminate seen */
175 /* DSCP value for TCP sessions */
180 DECLARE_QOBJ_TYPE(bgp_master
);
182 /* BGP route-map structure. */
185 struct route_map
*map
;
189 unsigned short instance
;
191 /* BGP redistribute metric configuration. */
192 uint8_t redist_metric_flag
;
193 uint32_t redist_metric
;
195 /* BGP redistribute route-map. */
196 struct bgp_rmap rmap
;
199 enum vpn_policy_direction
{
200 BGP_VPN_POLICY_DIR_FROMVPN
= 0,
201 BGP_VPN_POLICY_DIR_TOVPN
= 1,
202 BGP_VPN_POLICY_DIR_MAX
= 2
206 struct bgp
*bgp
; /* parent */
208 struct ecommunity
*rtlist
[BGP_VPN_POLICY_DIR_MAX
];
209 struct ecommunity
*import_redirect_rtlist
;
210 char *rmap_name
[BGP_VPN_POLICY_DIR_MAX
];
211 struct route_map
*rmap
[BGP_VPN_POLICY_DIR_MAX
];
213 /* should be mpls_label_t? */
214 uint32_t tovpn_label
; /* may be MPLS_LABEL_NONE */
215 uint32_t tovpn_zebra_vrf_label_last_sent
;
216 struct prefix_rd tovpn_rd
;
217 struct prefix tovpn_nexthop
; /* unset => set to 0 */
219 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
220 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
221 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
222 #define BGP_VPN_POLICY_TOVPN_SID_AUTO (1 << 3)
225 * If we are importing another vrf into us keep a list of
226 * vrf names that are being imported into us.
228 struct list
*import_vrf
;
231 * if we are being exported to another vrf keep a list of
232 * vrf names that we are being exported to.
234 struct list
*export_vrf
;
237 * Segment-Routing SRv6 Mode
239 uint32_t tovpn_sid_index
; /* unset => set to 0 */
240 struct in6_addr
*tovpn_sid
;
241 struct in6_addr
*tovpn_sid_locator
;
242 uint32_t tovpn_sid_transpose_label
;
243 struct in6_addr
*tovpn_zebra_vrf_sid_last_sent
;
247 * Type of 'struct bgp'.
248 * - Default: The default instance
249 * - VRF: A specific (non-default) VRF
250 * - View: An instance used for route exchange
251 * The "default" instance is treated separately to simplify the code. Note
252 * that if deployed in a Multi-VRF environment, it may not exist.
254 enum bgp_instance_type
{
255 BGP_INSTANCE_TYPE_DEFAULT
,
256 BGP_INSTANCE_TYPE_VRF
,
257 BGP_INSTANCE_TYPE_VIEW
260 #define BGP_SEND_EOR(bgp, afi, safi) \
261 (!CHECK_FLAG(bgp->flags, BGP_FLAG_GR_DISABLE_EOR) \
262 && ((bgp->gr_info[afi][safi].t_select_deferral == NULL) \
263 || (bgp->gr_info[afi][safi].eor_required \
264 == bgp->gr_info[afi][safi].eor_received)))
266 /* BGP GR Global ds */
268 #define BGP_GLOBAL_GR_MODE 4
269 #define BGP_GLOBAL_GR_EVENT_CMD 4
271 /* Graceful restart selection deferral timer info */
272 struct graceful_restart_info
{
273 /* Count of EOR message expected */
274 uint32_t eor_required
;
275 /* Count of EOR received */
276 uint32_t eor_received
;
278 struct thread
*t_select_deferral
;
279 /* Routes Deferred */
280 uint32_t gr_deferred
;
281 /* Best route select */
282 struct thread
*t_route_select
;
283 /* AFI, SAFI enabled */
284 bool af_enabled
[AFI_MAX
][SAFI_MAX
];
285 /* Route update completed */
286 bool route_sync
[AFI_MAX
][SAFI_MAX
];
290 GLOBAL_HELPER
= 0, /* This is the default mode */
296 enum global_gr_command
{
300 NO_GLOBAL_DISABLE_CMD
303 #define BGP_GR_SUCCESS 0
304 #define BGP_GR_FAILURE 1
306 /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
307 * do weighted ECMP. Note: This applies after multipath computation.
309 enum bgp_link_bw_handling
{
310 /* Do ECMP if some paths don't have LB - default */
312 /* Completely ignore LB, just do regular ECMP */
313 BGP_LINK_BW_IGNORE_BW
,
314 /* Skip paths without LB, do wECMP on others */
315 BGP_LINK_BW_SKIP_MISSING
,
316 /* Do wECMP with default weight for paths not having LB */
317 BGP_LINK_BW_DEFWT_4_MISSING
320 RB_HEAD(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
);
321 RB_PROTOTYPE(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
, rb_node
, bgp_es_vrf_rb_cmp
);
323 struct bgp_snmp_stats
{
324 /* SNMP variables for mplsL3Vpn*/
325 time_t creation_time
;
328 uint32_t routes_added
;
329 uint32_t routes_deleted
;
332 struct bgp_srv6_function
{
334 char locator_name
[SRV6_LOCNAME_SIZE
];
337 /* BGP instance structure. */
339 /* AS number of this BGP instance. */
342 /* Name of this BGP instance. */
344 char *name_pretty
; /* printable "VRF|VIEW name|default" */
346 /* Type of instance and VRF id. */
347 enum bgp_instance_type inst_type
;
350 /* Reference count to allow peer_delete to finish after bgp_delete */
354 struct peer
*peer_self
;
358 struct hash
*peerhash
;
360 /* BGP peer group. */
363 /* The maximum number of BGP dynamic neighbors that can be created */
364 int dynamic_neighbors_limit
;
366 /* The current number of BGP dynamic neighbors */
367 int dynamic_neighbors_count
;
369 struct hash
*update_groups
[BGP_AF_MAX
];
372 * Global statistics for update groups.
375 uint32_t join_events
;
376 uint32_t prune_events
;
377 uint32_t merge_events
;
378 uint32_t split_events
;
379 uint32_t updgrp_switch_events
;
380 uint32_t peer_refreshes_combined
;
382 uint32_t merge_checks_triggered
;
384 uint32_t updgrps_created
;
385 uint32_t updgrps_deleted
;
386 uint32_t subgrps_created
;
387 uint32_t subgrps_deleted
;
388 } update_group_stats
;
390 struct bgp_snmp_stats
*snmp_stats
;
392 /* BGP configuration. */
394 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
395 #define BGP_CONFIG_CONFEDERATION (1 << 1)
397 /* BGP router identifier. */
398 struct in_addr router_id
;
399 struct in_addr router_id_static
;
400 struct in_addr router_id_zebra
;
402 /* BGP route reflector cluster ID. */
403 struct in_addr cluster_id
;
405 /* BGP confederation information. */
408 int confed_peers_cnt
;
411 *t_startup
; /* start-up timer on only once at the beginning */
413 uint32_t v_maxmed_onstartup
; /* Duration of max-med on start-up */
414 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
415 uint32_t maxmed_onstartup_value
; /* Max-med value when active on
418 *t_maxmed_onstartup
; /* non-null when max-med onstartup is on */
419 uint8_t maxmed_onstartup_over
; /* Flag to make it effective only once */
421 bool v_maxmed_admin
; /* true/false if max-med administrative is on/off
423 #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
424 uint32_t maxmed_admin_value
; /* Max-med value when administrative in on
426 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
428 uint8_t maxmed_active
; /* 1/0 if max-med is active or not */
429 uint32_t maxmed_value
; /* Max-med value when its active */
431 /* BGP update delay on startup */
432 struct thread
*t_update_delay
;
433 struct thread
*t_establish_wait
;
434 uint8_t update_delay_over
;
435 uint8_t main_zebra_update_hold
;
436 uint8_t main_peers_update_hold
;
437 uint16_t v_update_delay
;
438 uint16_t v_establish_wait
;
439 char update_delay_begin_time
[64];
440 char update_delay_end_time
[64];
441 char update_delay_zebra_resume_time
[64];
442 char update_delay_peers_resume_time
[64];
443 uint32_t established
;
444 uint32_t restarted_peers
;
445 uint32_t implicit_eors
;
446 uint32_t explicit_eors
;
447 #define BGP_UPDATE_DELAY_DEF 0
448 #define BGP_UPDATE_DELAY_MIN 0
449 #define BGP_UPDATE_DELAY_MAX 3600
451 /* Reference bandwidth for BGP link-bandwidth. Used when
452 * the LB value has to be computed based on some other
453 * factor (e.g., number of multipaths for the prefix)
457 #define BGP_LINK_BW_REF_BW 1
461 #define BGP_FLAG_ALWAYS_COMPARE_MED (1 << 0)
462 #define BGP_FLAG_DETERMINISTIC_MED (1 << 1)
463 #define BGP_FLAG_MED_MISSING_AS_WORST (1 << 2)
464 #define BGP_FLAG_MED_CONFED (1 << 3)
465 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1 << 4)
466 #define BGP_FLAG_COMPARE_ROUTER_ID (1 << 5)
467 #define BGP_FLAG_ASPATH_IGNORE (1 << 6)
468 #define BGP_FLAG_IMPORT_CHECK (1 << 7)
469 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1 << 8)
470 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1 << 9)
472 /* This flag is set when we have full BGP Graceful-Restart mode enable */
473 #define BGP_FLAG_GRACEFUL_RESTART (1 << 10)
475 #define BGP_FLAG_ASPATH_CONFED (1 << 11)
476 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1 << 12)
477 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 13)
478 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 14)
479 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1 << 15)
480 #define BGP_FLAG_FORCE_STATIC_PROCESS (1 << 16)
481 #define BGP_FLAG_SHOW_HOSTNAME (1 << 17)
482 #define BGP_FLAG_GR_PRESERVE_FWD (1 << 18)
483 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1 << 19)
484 #define BGP_FLAG_DELETE_IN_PROGRESS (1 << 20)
485 #define BGP_FLAG_SELECT_DEFER_DISABLE (1 << 21)
486 #define BGP_FLAG_GR_DISABLE_EOR (1 << 22)
487 #define BGP_FLAG_EBGP_REQUIRES_POLICY (1 << 23)
488 #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1 << 24)
490 /* This flag is set if the instance is in administrative shutdown */
491 #define BGP_FLAG_SHUTDOWN (1 << 25)
492 #define BGP_FLAG_SUPPRESS_FIB_PENDING (1 << 26)
493 #define BGP_FLAG_SUPPRESS_DUPLICATES (1 << 27)
494 #define BGP_FLAG_PEERTYPE_MULTIPATH_RELAX (1 << 29)
495 /* Indicate Graceful Restart support for BGP NOTIFICATION messages */
496 #define BGP_FLAG_GRACEFUL_NOTIFICATION (1 << 30)
497 /* Send Hard Reset CEASE Notification for 'Administrative Reset' */
498 #define BGP_FLAG_HARD_ADMIN_RESET (1 << 31)
500 /* BGP default address-families.
501 * New peers inherit enabled afi/safis from bgp instance.
503 uint16_t default_af
[AFI_MAX
][SAFI_MAX
];
505 enum global_mode GLOBAL_GR_FSM
[BGP_GLOBAL_GR_MODE
]
506 [BGP_GLOBAL_GR_EVENT_CMD
];
507 enum global_mode global_gr_present_state
;
509 /* This variable stores the current Graceful Restart state of Zebra
510 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
512 enum zebra_gr_mode present_zebra_gr_state
;
514 /* BGP Per AF flags */
515 uint16_t af_flags
[AFI_MAX
][SAFI_MAX
];
516 #define BGP_CONFIG_DAMPENING (1 << 0)
517 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
518 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST (1 << 1)
519 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST_GW_IP (1 << 2)
520 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST (1 << 3)
521 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST_GW_IP (1 << 4)
522 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 5)
523 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 6)
524 /* import/export between address families */
525 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 7)
526 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 8)
527 /* vrf-route leaking flags */
528 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 9)
529 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 10)
530 /* vpnvx retain flag */
531 #define BGP_VPNVX_RETAIN_ROUTE_TARGET_ALL (1 << 11)
533 /* BGP per AF peer count */
534 uint32_t af_peer_count
[AFI_MAX
][SAFI_MAX
];
536 /* Tree for next-hop lookup cache. */
537 struct bgp_nexthop_cache_head nexthop_cache_table
[AFI_MAX
];
539 /* Tree for import-check */
540 struct bgp_nexthop_cache_head import_check_table
[AFI_MAX
];
542 struct bgp_table
*connected_table
[AFI_MAX
];
544 struct hash
*address_hash
;
546 /* DB for all local tunnel-ips - used mainly for martian checks
547 Currently it only has all VxLan tunnel IPs*/
548 struct hash
*tip_hash
;
550 /* Static route configuration. */
551 struct bgp_table
*route
[AFI_MAX
][SAFI_MAX
];
553 /* Aggregate address configuration. */
554 struct bgp_table
*aggregate
[AFI_MAX
][SAFI_MAX
];
556 /* BGP routing information base. */
557 struct bgp_table
*rib
[AFI_MAX
][SAFI_MAX
];
559 /* BGP table route-map. */
560 struct bgp_rmap table_map
[AFI_MAX
][SAFI_MAX
];
562 /* BGP redistribute configuration. */
563 struct list
*redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
565 /* Allocate MPLS labels */
566 uint8_t allocate_mpls_labels
[AFI_MAX
][SAFI_MAX
];
568 /* Allocate hash entries to store policy routing information
569 * The hash are used to host pbr rules somewhere.
570 * Actually, pbr will only be used by flowspec
571 * those hash elements will have relationship together as
572 * illustrated in below diagram:
574 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
575 * <----- pbr_match j <--- pbr_match_entry 1..m
578 * - here in BGP structure, the list of match and actions will
579 * stand for the list of ipset sets, and table_ids in the kernel
580 * - the arrow above between pbr_match and pbr_action indicate
581 * that a backpointer permits match to find the action
582 * - the arrow betwen match_entry and match is a hash list
583 * contained in match, that lists the whole set of entries
585 struct hash
*pbr_match_hash
;
586 struct hash
*pbr_rule_hash
;
587 struct hash
*pbr_action_hash
;
589 /* timer to re-evaluate neighbor default-originate route-maps */
590 struct thread
*t_rmap_def_originate_eval
;
591 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
593 /* BGP distance configuration. */
594 uint8_t distance_ebgp
[AFI_MAX
][SAFI_MAX
];
595 uint8_t distance_ibgp
[AFI_MAX
][SAFI_MAX
];
596 uint8_t distance_local
[AFI_MAX
][SAFI_MAX
];
598 /* BGP default local-preference. */
599 uint32_t default_local_pref
;
601 /* BGP default subgroup pkt queue max */
602 uint32_t default_subgroup_pkt_queue_max
;
604 /* BGP default timer. */
605 uint32_t default_holdtime
;
606 uint32_t default_keepalive
;
607 uint32_t default_connect_retry
;
608 uint32_t default_delayopen
;
610 /* BGP minimum holdtime. */
611 uint16_t default_min_holdtime
;
613 /* BGP graceful restart */
614 uint32_t restart_time
;
615 uint32_t stalepath_time
;
616 uint32_t select_defer_time
;
617 struct graceful_restart_info gr_info
[AFI_MAX
][SAFI_MAX
];
618 uint32_t rib_stale_time
;
620 /* BGP Long-lived Graceful Restart */
621 uint32_t llgr_stale_time
;
623 #define BGP_ROUTE_SELECT_DELAY 1
624 #define BGP_MAX_BEST_ROUTE_SELECT 10000
625 /* Maximum-paths configuration */
626 struct bgp_maxpaths_cfg
{
627 uint16_t maxpaths_ebgp
;
628 uint16_t maxpaths_ibgp
;
629 bool same_clusterlen
;
630 } maxpaths
[AFI_MAX
][SAFI_MAX
];
632 _Atomic
uint32_t wpkt_quanta
; // max # packets to write per i/o cycle
633 _Atomic
uint32_t rpkt_quanta
; // max # packets to read per i/o cycle
635 /* Automatic coalesce adjust on/off */
636 bool heuristic_coalesce
;
637 /* Actual coalesce time */
638 uint32_t coalesce_time
;
640 /* Auto-shutdown new peers */
643 struct bgp_addpath_bgp_data tx_addpath
;
645 #ifdef ENABLE_BGP_VNC
646 struct rfapi_cfg
*rfapi_cfg
;
650 /* EVPN related information */
653 struct hash
*vnihash
;
656 * VNI hash table based on SVI ifindex as its key.
657 * We use SVI ifindex as key to lookup a VNI table for gateway IP
658 * overlay index recursive lookup.
659 * For this purpose, a hashtable is added which optimizes this lookup.
661 struct hash
*vni_svi_hash
;
663 /* EVPN enable - advertise gateway macip routes */
664 int advertise_gw_macip
;
666 /* EVPN enable - advertise local VNIs and their MACs etc. */
667 int advertise_all_vni
;
669 /* draft-ietf-idr-deprecate-as-set-confed-set
670 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
674 struct bgp_evpn_info
*evpn_info
;
676 /* EVPN - use RFC 8365 to auto-derive RT */
677 int advertise_autort_rfc8365
;
680 * Flooding mechanism for BUM packets for VxLAN-EVPN.
682 enum vxlan_flood_control vxlan_flood_ctrl
;
684 /* Hash table of Import RTs to EVIs */
685 struct hash
*import_rt_hash
;
687 /* Hash table of VRF import RTs to VRFs */
688 struct hash
*vrf_import_rt_hash
;
690 /* L3-VNI corresponding to this vrf */
693 /* router-mac to be used in mac-ip routes for this vrf */
696 /* originator ip - to be used as NH for type-5 routes */
697 struct in_addr originator_ip
;
699 /* SVI associated with the L3-VNI corresponding to this vrf */
700 ifindex_t l3vni_svi_ifindex
;
702 /* RB tree of ES-VRFs */
703 struct bgp_es_vrf_rb_head es_vrf_rb_tree
;
705 /* Hash table of EVPN nexthops maintained per-tenant-VRF */
706 struct hash
*evpn_nh_table
;
709 * Flag resolve_overlay_index is used for recursive resolution
710 * procedures for EVPN type-5 route's gateway IP overlay index.
711 * When this flag is set, we build remote-ip-hash for
712 * all L2VNIs and resolve overlay index nexthops using this hash.
713 * Overlay index nexthops remain unresolved if this flag is not set.
715 bool resolve_overlay_index
;
719 #define BGP_VRF_AUTO (1 << 0)
720 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
721 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
722 #define BGP_VRF_RD_CFGD (1 << 3)
723 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 4)
725 /* unique ID for auto derivation of RD for this vrf */
728 /* Automatically derived RD for this VRF */
729 struct prefix_rd vrf_prd_auto
;
731 /* RD for this VRF */
732 struct prefix_rd vrf_prd
;
734 /* import rt list for the vrf instance */
735 struct list
*vrf_import_rtl
;
737 /* export rt list for the vrf instance */
738 struct list
*vrf_export_rtl
;
740 /* list of corresponding l2vnis (struct bgpevpn) */
743 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
744 struct bgp_rmap adv_cmd_rmap
[AFI_MAX
][SAFI_MAX
];
746 struct vpn_policy vpn_policy
[AFI_MAX
];
748 struct bgp_pbr_config
*bgp_pbr_cfg
;
750 /* Count of peers in established state */
751 uint32_t established_peers
;
753 /* Weighted ECMP related config. */
754 enum bgp_link_bw_handling lb_handling
;
756 /* Process Queue for handling routes */
757 struct work_queue
*process_queue
;
759 bool fast_convergence
;
761 /* BGP Conditional advertisement */
762 uint32_t condition_check_period
;
763 uint32_t condition_filter_count
;
764 struct thread
*t_condition_check
;
766 /* BGP VPN SRv6 backend */
768 char srv6_locator_name
[SRV6_LOCNAME_SIZE
];
769 struct list
*srv6_locator_chunks
;
770 struct list
*srv6_functions
;
772 struct timeval ebgprequirespolicywarning
;
773 #define FIFTEENMINUTE2USEC (int64_t)15 * 60 * 1000000
779 DECLARE_QOBJ_TYPE(bgp
);
781 DECLARE_HOOK(bgp_inst_delete
, (struct bgp
*bgp
), (bgp
));
782 DECLARE_HOOK(bgp_inst_config_write
,
783 (struct bgp
*bgp
, struct vty
*vty
),
785 DECLARE_HOOK(bgp_config_end
, (struct bgp
*bgp
), (bgp
));
787 /* Thread callback information */
788 struct afi_safi_info
{
794 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
796 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
797 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
798 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
799 && bgp->vrf_id != VRF_UNKNOWN))
801 #define BGP_SELECT_DEFER_DISABLE(bgp) \
802 (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
804 #define BGP_SUPPRESS_FIB_ENABLED(bgp) \
805 (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING) \
808 /* BGP peer-group support. */
810 /* Name of the peer-group. */
813 /* Pointer to BGP. */
816 /* Peer-group client list. */
819 /** Dynamic neighbor listening ranges */
820 struct list
*listen_range
[AFI_MAX
];
822 /* Peer-group config */
826 /* BGP Notify message format. */
836 /* Next hop self address. */
838 struct interface
*ifp
;
840 struct in6_addr v6_global
;
841 struct in6_addr v6_local
;
844 /* BGP addpath values */
845 #define BGP_ADDPATH_RX 1
846 #define BGP_ADDPATH_TX 2
847 #define BGP_ADDPATH_ID_LEN 4
849 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
851 /* Route map direction */
856 #define BGP_DEFAULT_TTL 1
857 #define BGP_GTSM_HOPS_DISABLED 0
858 #define BGP_GTSM_HOPS_CONNECTED 1
861 #define CONDITION_NON_EXIST false
862 #define CONDITION_EXIST true
864 enum update_type
{ UPDATE_TYPE_WITHDRAW
, UPDATE_TYPE_ADVERTISE
};
868 /* BGP filter structure. */
870 /* Distribute-list. */
873 struct access_list
*alist
;
879 struct prefix_list
*plist
;
885 struct as_list
*aslist
;
886 } aslist
[FILTER_MAX
];
891 struct route_map
*map
;
894 /* Unsuppress-map. */
897 struct route_map
*map
;
903 struct route_map
*amap
;
908 struct route_map
*cmap
;
910 enum update_type update_type
;
914 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
915 a peer who's AS is part of our Confederation. */
917 BGP_PEER_UNSPECIFIED
,
924 /* BGP message header and packet size. */
925 #define BGP_MARKER_SIZE 16
926 #define BGP_HEADER_SIZE 19
927 #define BGP_STANDARD_MESSAGE_MAX_PACKET_SIZE 4096
928 #define BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE 65535
929 #define BGP_MAX_PACKET_SIZE BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
930 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
933 * Trigger delay for bgp_announce_route().
935 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
936 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
939 /* back pointer to the peer */
942 /* which subgroup the peer_af belongs to */
943 struct update_subgroup
*subgroup
;
945 /* for being part of an update subgroup's peer list */
946 LIST_ENTRY(peer_af
) subgrp_train
;
948 /* for being part of a packet's peer list */
949 LIST_ENTRY(peer_af
) pkt_train
;
951 struct bpacket
*next_pkt_to_send
;
954 * Trigger timer for bgp_announce_route().
956 struct thread
*t_announce_route
;
962 /* BGP GR per peer ds */
964 #define BGP_PEER_GR_MODE 5
965 #define BGP_PEER_GR_EVENT_CMD 6
972 PEER_GLOBAL_INHERIT
/* This is the default mode */
976 enum peer_gr_command
{
985 typedef unsigned int (*bgp_peer_gr_action_ptr
)(struct peer
*, int, int);
988 enum peer_mode next_state
;
989 bgp_peer_gr_action_ptr action_fun
;
993 * BGP FSM event codes, per RFC 4271 ss. 8.1
995 enum bgp_fsm_rfc_codes
{
996 BGP_FSM_ManualStart
= 1,
997 BGP_FSM_ManualStop
= 2,
998 BGP_FSM_AutomaticStart
= 3,
999 BGP_FSM_ManualStart_with_PassiveTcpEstablishment
= 4,
1000 BGP_FSM_AutomaticStart_with_PassiveTcpEstablishment
= 5,
1001 BGP_FSM_AutomaticStart_with_DampPeerOscillations
= 6,
1002 BGP_FSM_AutomaticStart_with_DampPeerOscillations_and_PassiveTcpEstablishment
=
1004 BGP_FSM_AutomaticStop
= 8,
1005 BGP_FSM_ConnectRetryTimer_Expires
= 9,
1006 BGP_FSM_HoldTimer_Expires
= 10,
1007 BGP_FSM_KeepaliveTimer_Expires
= 11,
1008 BGP_FSM_DelayOpenTimer_Expires
= 12,
1009 BGP_FSM_IdleHoldTimer_Expires
= 13,
1010 BGP_FSM_TcpConnection_Valid
= 14,
1011 BGP_FSM_Tcp_CR_Invalid
= 15,
1012 BGP_FSM_Tcp_CR_Acked
= 16,
1013 BGP_FSM_TcpConnectionConfirmed
= 17,
1014 BGP_FSM_TcpConnectionFails
= 18,
1015 BGP_FSM_BGPOpen
= 19,
1016 BGP_FSM_BGPOpen_with_DelayOpenTimer_running
= 20,
1017 BGP_FSM_BGPHeaderErr
= 21,
1018 BGP_FSM_BGPOpenMsgErr
= 22,
1019 BGP_FSM_OpenCollisionDump
= 23,
1020 BGP_FSM_NotifMsgVerErr
= 24,
1021 BGP_FSM_NotifMsg
= 25,
1022 BGP_FSM_KeepAliveMsg
= 26,
1023 BGP_FSM_UpdateMsg
= 27,
1024 BGP_FSM_UpdateMsgErr
= 28
1028 * BGP finite state machine events
1030 * Note: these do not correspond to RFC-defined event codes. Those are
1031 * defined elsewhere.
1033 enum bgp_fsm_events
{
1036 TCP_connection_open
,
1037 TCP_connection_open_w_delay
,
1038 TCP_connection_closed
,
1039 TCP_connection_open_failed
,
1041 ConnectRetry_timer_expired
,
1043 KeepAlive_timer_expired
,
1044 DelayOpen_timer_expired
,
1045 Receive_OPEN_message
,
1046 Receive_KEEPALIVE_message
,
1047 Receive_UPDATE_message
,
1048 Receive_NOTIFICATION_message
,
1053 /* BGP finite state machine status. */
1054 enum bgp_fsm_status
{
1066 #define PEER_HOSTNAME(peer) ((peer)->host ? (peer)->host : "(unknown peer)")
1069 uint32_t stale_time
;
1073 /* BGP neighbor structure. */
1075 /* BGP structure. */
1078 /* reference count, primarily to allow bgp_process'ing of route_node's
1079 * to be done after a struct peer is deleted.
1081 * named 'lock' for hysterical reasons within Quagga.
1085 /* BGP peer group. */
1086 struct peer_group
*group
;
1087 uint64_t version
[AFI_MAX
][SAFI_MAX
];
1089 /* BGP peer_af structures, per configured AF on this peer */
1090 struct peer_af
*peer_af_array
[BGP_AF_MAX
];
1092 /* Peer's remote AS number. */
1096 /* Peer's local AS number. */
1099 enum bgp_peer_sort sort
;
1101 /* Peer's Change local AS number. */
1102 as_t change_local_as
;
1104 /* Remote router ID. */
1105 struct in_addr remote_id
;
1107 /* Local router ID. */
1108 struct in_addr local_id
;
1110 /* Packet receive and send buffer. */
1111 pthread_mutex_t io_mtx
; // guards ibuf, obuf
1112 struct stream_fifo
*ibuf
; // packets waiting to be processed
1113 struct stream_fifo
*obuf
; // packets waiting to be written
1115 /* used as a block to deposit raw wire data to */
1116 uint8_t ibuf_scratch
[BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
1117 * BGP_READ_PACKET_MAX
];
1118 struct ringbuf
*ibuf_work
; // WiP buffer used by bgp_read() only
1119 struct stream
*obuf_work
; // WiP buffer used to construct packets
1121 struct stream
*curr
; // the current packet being parsed
1123 /* We use a separate stream to encode MP_REACH_NLRI for efficient
1124 * NLRI packing. peer->obuf_work stores all the other attributes. The
1125 * actual packet is then constructed by concatenating the two.
1127 struct stream
*scratch
;
1129 /* the doppelganger peer structure, due to dual TCP conn setup */
1130 struct peer
*doppelganger
;
1132 /* Status of the peer. */
1133 enum bgp_fsm_status status
;
1134 enum bgp_fsm_status ostatus
;
1136 /* FSM events, stored for debug purposes.
1137 * Note: uchar used for reduced memory usage.
1139 enum bgp_fsm_events cur_event
;
1140 enum bgp_fsm_events last_event
;
1141 enum bgp_fsm_events last_major_event
;
1143 /* Peer index, used for dumping TABLE_DUMP_V2 format */
1144 uint16_t table_dump_index
;
1146 /* Peer information */
1147 int fd
; /* File descriptor */
1148 int ttl
; /* TTL of TCP connection to the peer. */
1149 int rtt
; /* Estimated round-trip-time from TCP_INFO */
1150 int rtt_expected
; /* Expected round-trip-time for a peer */
1151 uint8_t rtt_keepalive_rcv
; /* Received count for RTT shutdown */
1152 uint8_t rtt_keepalive_conf
; /* Configured count for RTT shutdown */
1153 int gtsm_hops
; /* minimum hopcount to peer */
1154 char *desc
; /* Description of the peer. */
1155 unsigned short port
; /* Destination port for peer */
1156 char *host
; /* Printable address of the peer. */
1157 union sockunion su
; /* Sockunion address of the peer. */
1158 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
1159 time_t uptime
; /* Last Up/Down time */
1160 time_t readtime
; /* Last read time */
1161 time_t resettime
; /* Last reset time */
1163 char *conf_if
; /* neighbor interface config name. */
1164 struct interface
*ifp
; /* corresponding interface */
1165 char *ifname
; /* bind interface name. */
1167 union sockunion
*update_source
;
1169 union sockunion
*su_local
; /* Sockunion of local address. */
1170 union sockunion
*su_remote
; /* Sockunion of remote address. */
1171 int shared_network
; /* Is this peer shared same network. */
1172 struct bgp_nexthop nexthop
; /* Nexthop */
1174 /* Roles in bgp session */
1176 uint8_t remote_role
;
1177 #define ROLE_PROVIDER 0
1178 #define ROLE_RS_SERVER 1
1179 #define ROLE_RS_CLIENT 2
1180 #define ROLE_CUSTOMER 3
1182 #define ROLE_UNDEFINED 255
1184 #define ROLE_NAME_MAX_LEN 20
1186 /* Peer address family configuration. */
1187 uint8_t afc
[AFI_MAX
][SAFI_MAX
];
1188 uint8_t afc_nego
[AFI_MAX
][SAFI_MAX
];
1189 uint8_t afc_adv
[AFI_MAX
][SAFI_MAX
];
1190 uint8_t afc_recv
[AFI_MAX
][SAFI_MAX
];
1192 /* Capability flags (reset in bgp_stop) */
1194 #define PEER_CAP_REFRESH_ADV (1U << 0) /* refresh advertised */
1195 #define PEER_CAP_REFRESH_OLD_RCV (1U << 1) /* refresh old received */
1196 #define PEER_CAP_REFRESH_NEW_RCV (1U << 2) /* refresh rfc received */
1197 #define PEER_CAP_DYNAMIC_ADV (1U << 3) /* dynamic advertised */
1198 #define PEER_CAP_DYNAMIC_RCV (1U << 4) /* dynamic received */
1199 #define PEER_CAP_RESTART_ADV (1U << 5) /* restart advertised */
1200 #define PEER_CAP_RESTART_RCV (1U << 6) /* restart received */
1201 #define PEER_CAP_AS4_ADV (1U << 7) /* as4 advertised */
1202 #define PEER_CAP_AS4_RCV (1U << 8) /* as4 received */
1203 /* sent graceful-restart restart (R) bit */
1204 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_ADV (1U << 9)
1205 /* received graceful-restart restart (R) bit */
1206 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_RCV (1U << 10)
1207 #define PEER_CAP_ADDPATH_ADV (1U << 11) /* addpath advertised */
1208 #define PEER_CAP_ADDPATH_RCV (1U << 12) /* addpath received */
1209 #define PEER_CAP_ENHE_ADV (1U << 13) /* Extended nexthop advertised */
1210 #define PEER_CAP_ENHE_RCV (1U << 14) /* Extended nexthop received */
1211 #define PEER_CAP_HOSTNAME_ADV (1U << 15) /* hostname advertised */
1212 #define PEER_CAP_HOSTNAME_RCV (1U << 16) /* hostname received */
1213 #define PEER_CAP_ENHANCED_RR_ADV (1U << 17) /* enhanced rr advertised */
1214 #define PEER_CAP_ENHANCED_RR_RCV (1U << 18) /* enhanced rr received */
1215 #define PEER_CAP_EXTENDED_MESSAGE_ADV (1U << 19)
1216 #define PEER_CAP_EXTENDED_MESSAGE_RCV (1U << 20)
1217 #define PEER_CAP_LLGR_ADV (1U << 21)
1218 #define PEER_CAP_LLGR_RCV (1U << 22)
1219 /* sent graceful-restart notification (N) bit */
1220 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_ADV (1U << 23)
1221 /* received graceful-restart notification (N) bit */
1222 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_RCV (1U << 24)
1223 #define PEER_CAP_ROLE_ADV (1U << 25) /* role advertised */
1224 #define PEER_CAP_ROLE_RCV (1U << 26) /* role received */
1226 /* Capability flags (reset in bgp_stop) */
1227 uint32_t af_cap
[AFI_MAX
][SAFI_MAX
];
1228 #define PEER_CAP_ORF_PREFIX_SM_ADV (1U << 0) /* send-mode advertised */
1229 #define PEER_CAP_ORF_PREFIX_RM_ADV (1U << 1) /* receive-mode advertised */
1230 #define PEER_CAP_ORF_PREFIX_SM_RCV (1U << 2) /* send-mode received */
1231 #define PEER_CAP_ORF_PREFIX_RM_RCV (1U << 3) /* receive-mode received */
1232 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1U << 4) /* send-mode received */
1233 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1U << 5) /* receive-mode received */
1234 #define PEER_CAP_RESTART_AF_RCV (1U << 6) /* graceful restart afi/safi received */
1235 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1U << 7) /* graceful restart afi/safi F-bit received */
1236 #define PEER_CAP_ADDPATH_AF_TX_ADV (1U << 8) /* addpath tx advertised */
1237 #define PEER_CAP_ADDPATH_AF_TX_RCV (1U << 9) /* addpath tx received */
1238 #define PEER_CAP_ADDPATH_AF_RX_ADV (1U << 10) /* addpath rx advertised */
1239 #define PEER_CAP_ADDPATH_AF_RX_RCV (1U << 11) /* addpath rx received */
1240 #define PEER_CAP_ENHE_AF_ADV (1U << 12) /* Extended nexthopi afi/safi advertised */
1241 #define PEER_CAP_ENHE_AF_RCV (1U << 13) /* Extended nexthop afi/safi received */
1242 #define PEER_CAP_ENHE_AF_NEGO (1U << 14) /* Extended nexthop afi/safi negotiated */
1243 #define PEER_CAP_LLGR_AF_ADV (1U << 15)
1244 #define PEER_CAP_LLGR_AF_RCV (1U << 16)
1246 /* Global configuration flags. */
1248 * Parallel array to flags that indicates whether each flag originates
1249 * from a peer-group or if it is config that is specific to this
1250 * individual peer. If a flag is set independent of the peer-group, the
1251 * same bit should be set here. If this peer is a peer-group, this
1252 * memory region should be all zeros.
1254 * The assumption is that the default state for all flags is unset,
1255 * so if a flag is unset, the corresponding override flag is unset too.
1256 * However if a flag is set, the corresponding override flag is set.
1258 uint32_t flags_override
;
1260 * Parallel array to flags that indicates whether the default behavior
1261 * of *flags_override* should be inverted. If a flag is unset and the
1262 * corresponding invert flag is set, the corresponding override flag
1263 * would be set. However if a flag is set and the corresponding invert
1264 * flag is unset, the corresponding override flag would be unset.
1266 * This can be used for attributes like *send-community*, which are
1267 * implicitely enabled and have to be disabled explicitely, compared to
1268 * 'normal' attributes like *next-hop-self* which are implicitely set.
1270 * All operations dealing with flags should apply the following boolean
1271 * logic to keep the internal flag system in a sane state:
1273 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1274 * value=0 invert=1 Unset flag unconditionally
1275 * value=1 invert=0 Set flag unconditionally
1276 * value=1 invert=1 Inherit flag if member, otherwise set flag
1278 * Contrary to the implementation of *flags_override*, the flag
1279 * inversion state can be set either on the peer OR the peer *and* the
1280 * peer-group. This was done on purpose, as the inversion state of a
1281 * flag can be determined on either the peer or the peer-group.
1283 * Example: Enabling the cisco configuration mode inverts all flags
1284 * related to *send-community* unconditionally for both peer-groups and
1287 * This behavior is different for interface peers though, which enable
1288 * the *extended-nexthop* flag by default, which regular peers do not.
1289 * As the peer-group can contain both regular and interface peers, the
1290 * flag inversion state must be set on the peer only.
1292 * When a peer inherits the configuration from a peer-group and the
1293 * inversion state of the flag differs between peer and peer-group, the
1294 * newly set value must equal to the inverted state of the peer-group.
1296 uint32_t flags_invert
;
1298 * Effective array for storing the peer/peer-group flags. In case of a
1299 * peer-group, the peer-specific overrides (see flags_override and
1300 * flags_invert) must be respected.
1303 #define PEER_FLAG_PASSIVE (1ULL << 0) /* passive mode */
1304 #define PEER_FLAG_SHUTDOWN (1ULL << 1) /* shutdown */
1305 #define PEER_FLAG_DONT_CAPABILITY (1ULL << 2) /* dont-capability */
1306 #define PEER_FLAG_OVERRIDE_CAPABILITY (1ULL << 3) /* override-capability */
1307 #define PEER_FLAG_STRICT_CAP_MATCH (1ULL << 4) /* strict-match */
1308 #define PEER_FLAG_DYNAMIC_CAPABILITY (1ULL << 5) /* dynamic capability */
1309 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1ULL << 6) /* disable-connected-check */
1310 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1ULL << 7) /* local-as no-prepend */
1311 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1ULL << 8) /* local-as no-prepend replace-as */
1312 #define PEER_FLAG_DELETE (1ULL << 9) /* mark the peer for deleting */
1313 #define PEER_FLAG_CONFIG_NODE (1ULL << 10) /* the node to update configs on */
1314 #define PEER_FLAG_LONESOUL (1ULL << 11)
1315 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1ULL << 12) /* dynamic neighbor */
1316 #define PEER_FLAG_CAPABILITY_ENHE (1ULL << 13) /* Extended next-hop (rfc 5549)*/
1317 #define PEER_FLAG_IFPEER_V6ONLY (1ULL << 14) /* if-based peer is v6 only */
1318 #define PEER_FLAG_IS_RFAPI_HD (1ULL << 15) /* attached to rfapi HD */
1319 #define PEER_FLAG_ENFORCE_FIRST_AS (1ULL << 16) /* enforce-first-as */
1320 #define PEER_FLAG_ROUTEADV (1ULL << 17) /* route advertise */
1321 #define PEER_FLAG_TIMER (1ULL << 18) /* keepalive & holdtime */
1322 #define PEER_FLAG_TIMER_CONNECT (1ULL << 19) /* connect timer */
1323 #define PEER_FLAG_PASSWORD (1ULL << 20) /* password */
1324 #define PEER_FLAG_LOCAL_AS (1ULL << 21) /* local-as */
1325 #define PEER_FLAG_UPDATE_SOURCE (1ULL << 22) /* update-source */
1327 /* BGP-GR Peer related flags */
1328 #define PEER_FLAG_GRACEFUL_RESTART_HELPER (1ULL << 23) /* Helper */
1329 #define PEER_FLAG_GRACEFUL_RESTART (1ULL << 24) /* Graceful Restart */
1330 #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1ULL << 25) /* Global-Inherit */
1331 #define PEER_FLAG_RTT_SHUTDOWN (1ULL << 26) /* shutdown rtt */
1332 #define PEER_FLAG_TIMER_DELAYOPEN (1ULL << 27) /* delayopen timer */
1333 #define PEER_FLAG_TCP_MSS (1ULL << 28) /* tcp-mss */
1334 /* Disable IEEE floating-point link bandwidth encoding in
1335 * extended communities.
1337 #define PEER_FLAG_DISABLE_LINK_BW_ENCODING_IEEE (1ULL << 29)
1338 /* force the extended format for Optional Parameters in OPEN message */
1339 #define PEER_FLAG_EXTENDED_OPT_PARAMS (1ULL << 30)
1341 /* BGP Open Policy flags.
1342 * Enforce using roles on both sides:
1343 * `local-role ROLE strict-mode` configured.
1345 #define PEER_FLAG_ROLE_STRICT_MODE (1ULL << 31)
1346 /* `local-role` configured */
1347 #define PEER_FLAG_ROLE (1ULL << 32)
1348 #define PEER_FLAG_PORT (1ULL << 33)
1351 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1352 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1353 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1356 struct bgp_peer_gr PEER_GR_FSM
[BGP_PEER_GR_MODE
][BGP_PEER_GR_EVENT_CMD
];
1357 enum peer_mode peer_gr_present_state
;
1358 /* Non stop forwarding afi-safi count for BGP gr feature*/
1359 uint8_t nsf_af_count
;
1361 uint8_t peer_gr_new_status_flag
;
1362 #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1U << 0)
1363 #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1U << 1)
1364 #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1U << 2)
1366 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1367 char *tx_shutdown_message
;
1369 /* NSF mode (graceful restart) */
1370 uint8_t nsf
[AFI_MAX
][SAFI_MAX
];
1372 time_t eor_stime
[AFI_MAX
][SAFI_MAX
];
1373 /* Last update packet sent time */
1374 time_t pkt_stime
[AFI_MAX
][SAFI_MAX
];
1376 /* Peer Per AF flags */
1378 * Please consult the comments for *flags_override*, *flags_invert* and
1379 * *flags* to understand what these three arrays do. The address-family
1380 * specific attributes are being treated the exact same way as global
1383 uint32_t af_flags_override
[AFI_MAX
][SAFI_MAX
];
1384 uint32_t af_flags_invert
[AFI_MAX
][SAFI_MAX
];
1385 uint32_t af_flags
[AFI_MAX
][SAFI_MAX
];
1386 #define PEER_FLAG_SEND_COMMUNITY (1U << 0) /* send-community */
1387 #define PEER_FLAG_SEND_EXT_COMMUNITY (1U << 1) /* send-community ext. */
1388 #define PEER_FLAG_NEXTHOP_SELF (1U << 2) /* next-hop-self */
1389 #define PEER_FLAG_REFLECTOR_CLIENT (1U << 3) /* reflector-client */
1390 #define PEER_FLAG_RSERVER_CLIENT (1U << 4) /* route-server-client */
1391 #define PEER_FLAG_SOFT_RECONFIG (1U << 5) /* soft-reconfiguration */
1392 #define PEER_FLAG_AS_PATH_UNCHANGED (1U << 6) /* transparent-as */
1393 #define PEER_FLAG_NEXTHOP_UNCHANGED (1U << 7) /* transparent-next-hop */
1394 #define PEER_FLAG_MED_UNCHANGED (1U << 8) /* transparent-next-hop */
1395 #define PEER_FLAG_DEFAULT_ORIGINATE (1U << 9) /* default-originate */
1396 #define PEER_FLAG_REMOVE_PRIVATE_AS (1U << 10) /* remove-private-as */
1397 #define PEER_FLAG_ALLOWAS_IN (1U << 11) /* set allowas-in */
1398 #define PEER_FLAG_ORF_PREFIX_SM (1U << 12) /* orf capability send-mode */
1399 #define PEER_FLAG_ORF_PREFIX_RM (1U << 13) /* orf capability receive-mode */
1400 #define PEER_FLAG_MAX_PREFIX (1U << 14) /* maximum prefix */
1401 #define PEER_FLAG_MAX_PREFIX_WARNING (1U << 15) /* maximum prefix warning-only */
1402 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1U << 16) /* leave link-local nexthop unchanged */
1403 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1U << 17) /* next-hop-self force */
1404 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1U << 18) /* remove-private-as all */
1405 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1U << 19) /* remove-private-as replace-as */
1406 #define PEER_FLAG_AS_OVERRIDE (1U << 20) /* as-override */
1407 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1U << 21) /* remove-private-as all replace-as */
1408 #define PEER_FLAG_WEIGHT (1U << 24) /* weight */
1409 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1U << 25) /* allowas-in origin */
1410 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1U << 26) /* Send large Communities */
1411 #define PEER_FLAG_MAX_PREFIX_OUT (1U << 27) /* outgoing maximum prefix */
1412 #define PEER_FLAG_MAX_PREFIX_FORCE (1U << 28) /* maximum-prefix <num> force */
1413 #define PEER_FLAG_DISABLE_ADDPATH_RX (1U << 29) /* disable-addpath-rx */
1414 #define PEER_FLAG_SOO (1U << 30) /* soo */
1416 enum bgp_addpath_strat addpath_type
[AFI_MAX
][SAFI_MAX
];
1421 /* default-originate route-map. */
1424 struct route_map
*map
;
1425 } default_rmap
[AFI_MAX
][SAFI_MAX
];
1427 /* Peer status flags. */
1429 #define PEER_STATUS_ACCEPT_PEER (1U << 0) /* accept peer */
1430 #define PEER_STATUS_PREFIX_OVERFLOW (1U << 1) /* prefix-overflow */
1431 #define PEER_STATUS_CAPABILITY_OPEN (1U << 2) /* capability open send */
1432 #define PEER_STATUS_HAVE_ACCEPT (1U << 3) /* accept peer's parent */
1433 #define PEER_STATUS_GROUP (1U << 4) /* peer-group conf */
1434 #define PEER_STATUS_NSF_MODE (1U << 5) /* NSF aware peer */
1435 #define PEER_STATUS_NSF_WAIT (1U << 6) /* wait comeback peer */
1436 /* received extended format encoding for OPEN message */
1437 #define PEER_STATUS_EXT_OPT_PARAMS_LENGTH (1U << 7)
1439 /* Peer status af flags (reset in bgp_stop) */
1440 uint16_t af_sflags
[AFI_MAX
][SAFI_MAX
];
1441 #define PEER_STATUS_ORF_PREFIX_SEND (1U << 0) /* prefix-list send peer */
1442 #define PEER_STATUS_ORF_WAIT_REFRESH (1U << 1) /* wait refresh received peer */
1443 #define PEER_STATUS_PREFIX_THRESHOLD (1U << 2) /* exceed prefix-threshold */
1444 #define PEER_STATUS_PREFIX_LIMIT (1U << 3) /* exceed prefix-limit */
1445 #define PEER_STATUS_EOR_SEND (1U << 4) /* end-of-rib send to peer */
1446 #define PEER_STATUS_EOR_RECEIVED (1U << 5) /* end-of-rib received from peer */
1447 #define PEER_STATUS_ENHANCED_REFRESH (1U << 6) /* Enhanced Route Refresh */
1448 #define PEER_STATUS_BORR_SEND (1U << 7) /* BoRR send to peer */
1449 #define PEER_STATUS_BORR_RECEIVED (1U << 8) /* BoRR received from peer */
1450 #define PEER_STATUS_EORR_SEND (1U << 9) /* EoRR send to peer */
1451 #define PEER_STATUS_EORR_RECEIVED (1U << 10) /* EoRR received from peer */
1452 /* LLGR aware peer */
1453 #define PEER_STATUS_LLGR_WAIT (1U << 11)
1455 /* Configured timer values. */
1456 _Atomic
uint32_t holdtime
;
1457 _Atomic
uint32_t keepalive
;
1458 _Atomic
uint32_t connect
;
1459 _Atomic
uint32_t routeadv
;
1460 _Atomic
uint32_t delayopen
;
1463 _Atomic
uint32_t v_start
;
1464 _Atomic
uint32_t v_connect
;
1465 _Atomic
uint32_t v_holdtime
;
1466 _Atomic
uint32_t v_keepalive
;
1467 _Atomic
uint32_t v_routeadv
;
1468 _Atomic
uint32_t v_delayopen
;
1469 _Atomic
uint32_t v_pmax_restart
;
1470 _Atomic
uint32_t v_gr_restart
;
1473 struct thread
*t_read
;
1474 struct thread
*t_write
;
1475 struct thread
*t_start
;
1476 struct thread
*t_connect_check_r
;
1477 struct thread
*t_connect_check_w
;
1478 struct thread
*t_connect
;
1479 struct thread
*t_holdtime
;
1480 struct thread
*t_routeadv
;
1481 struct thread
*t_delayopen
;
1482 struct thread
*t_pmax_restart
;
1483 struct thread
*t_gr_restart
;
1484 struct thread
*t_gr_stale
;
1485 struct thread
*t_llgr_stale
[AFI_MAX
][SAFI_MAX
];
1486 struct thread
*t_generate_updgrp_packets
;
1487 struct thread
*t_process_packet
;
1488 struct thread
*t_process_packet_error
;
1489 struct thread
*t_refresh_stalepath
;
1492 _Atomic
uint32_t thread_flags
;
1493 #define PEER_THREAD_WRITES_ON (1U << 0)
1494 #define PEER_THREAD_READS_ON (1U << 1)
1495 #define PEER_THREAD_KEEPALIVES_ON (1U << 2)
1496 #define PEER_THREAD_SUBGRP_ADV_DELAY (1U << 3)
1499 struct work_queue
*clear_node_queue
;
1501 #define PEER_TOTAL_RX(peer) \
1502 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1503 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1504 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1505 + atomic_load_explicit(&peer->refresh_in, \
1506 memory_order_relaxed) \
1507 + atomic_load_explicit(&peer->keepalive_in, \
1508 memory_order_relaxed) \
1509 + atomic_load_explicit(&peer->dynamic_cap_in, \
1510 memory_order_relaxed)
1512 #define PEER_TOTAL_TX(peer) \
1513 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1514 + atomic_load_explicit(&peer->update_out, \
1515 memory_order_relaxed) \
1516 + atomic_load_explicit(&peer->notify_out, \
1517 memory_order_relaxed) \
1518 + atomic_load_explicit(&peer->refresh_out, \
1519 memory_order_relaxed) \
1520 + atomic_load_explicit(&peer->keepalive_out, \
1521 memory_order_relaxed) \
1522 + atomic_load_explicit(&peer->dynamic_cap_out, \
1523 memory_order_relaxed)
1525 /* Statistics field */
1526 _Atomic
uint32_t open_in
; /* Open message input count */
1527 _Atomic
uint32_t open_out
; /* Open message output count */
1528 _Atomic
uint32_t update_in
; /* Update message input count */
1529 _Atomic
uint32_t update_out
; /* Update message ouput count */
1530 _Atomic
time_t update_time
; /* Update message received time. */
1531 _Atomic
uint32_t keepalive_in
; /* Keepalive input count */
1532 _Atomic
uint32_t keepalive_out
; /* Keepalive output count */
1533 _Atomic
uint32_t notify_in
; /* Notify input count */
1534 _Atomic
uint32_t notify_out
; /* Notify output count */
1535 _Atomic
uint32_t refresh_in
; /* Route Refresh input count */
1536 _Atomic
uint32_t refresh_out
; /* Route Refresh output count */
1537 _Atomic
uint32_t dynamic_cap_in
; /* Dynamic Capability input count. */
1538 _Atomic
uint32_t dynamic_cap_out
; /* Dynamic Capability output count. */
1540 uint32_t stat_pfx_filter
;
1541 uint32_t stat_pfx_aspath_loop
;
1542 uint32_t stat_pfx_originator_loop
;
1543 uint32_t stat_pfx_cluster_loop
;
1544 uint32_t stat_pfx_nh_invalid
;
1545 uint32_t stat_pfx_dup_withdraw
;
1546 uint32_t stat_upd_7606
; /* RFC7606: treat-as-withdraw */
1548 /* BGP state count */
1549 uint32_t established
; /* Established */
1550 uint32_t dropped
; /* Dropped */
1552 /* Update delay related fields */
1553 uint8_t update_delay_over
; /* When this is set, BGP is no more waiting
1556 /* Syncronization list and time. */
1557 struct bgp_synchronize
*sync
[AFI_MAX
][SAFI_MAX
];
1559 /* timestamp when the last UPDATE msg was written */
1560 _Atomic
time_t last_write
;
1561 /* timestamp when the last msg was written */
1562 _Atomic
time_t last_update
;
1564 /* only updated under io_mtx.
1565 * last_sendq_warn is only for ratelimiting log warning messages.
1567 time_t last_sendq_ok
, last_sendq_warn
;
1570 struct bgp_notify notify
;
1572 /* Filter structure. */
1573 struct bgp_filter filter
[AFI_MAX
][SAFI_MAX
];
1576 * Parallel array to filter that indicates whether each filter
1577 * originates from a peer-group or if it is config that is specific to
1578 * this individual peer. If a filter is set independent of the
1579 * peer-group the appropriate bit should be set here. If this peer is a
1580 * peer-group, this memory region should be all zeros. The assumption
1581 * is that the default state for all flags is unset. Due to filters
1582 * having a direction (e.g. in/out/...), this array has a third
1583 * dimension for storing the overrides independently per direction.
1586 * - if a filter for an individual peer is unset, the corresponding
1587 * override flag is unset and the peer is considered to be back in
1588 * sync with the peer-group.
1589 * - This does *not* contain the filter values, rather it contains
1590 * whether the filter in filter (struct bgp_filter) is peer-specific.
1592 uint8_t filter_override
[AFI_MAX
][SAFI_MAX
][FILTER_MAX
];
1593 #define PEER_FT_DISTRIBUTE_LIST (1U << 0) /* distribute-list */
1594 #define PEER_FT_FILTER_LIST (1U << 1) /* filter-list */
1595 #define PEER_FT_PREFIX_LIST (1U << 2) /* prefix-list */
1596 #define PEER_FT_ROUTE_MAP (1U << 3) /* route-map */
1597 #define PEER_FT_UNSUPPRESS_MAP (1U << 4) /* unsuppress-map */
1598 #define PEER_FT_ADVERTISE_MAP (1U << 5) /* advertise-map */
1600 /* ORF Prefix-list */
1601 struct prefix_list
*orf_plist
[AFI_MAX
][SAFI_MAX
];
1603 /* Text description of last attribute rcvd */
1604 char rcvd_attr_str
[BUFSIZ
];
1606 /* Track if we printed the attribute in debugs */
1607 int rcvd_attr_printed
;
1609 /* Accepted prefix count */
1610 uint32_t pcount
[AFI_MAX
][SAFI_MAX
];
1612 /* Max prefix count. */
1613 uint32_t pmax
[AFI_MAX
][SAFI_MAX
];
1614 uint8_t pmax_threshold
[AFI_MAX
][SAFI_MAX
];
1615 uint16_t pmax_restart
[AFI_MAX
][SAFI_MAX
];
1616 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1618 /* Send prefix count. */
1619 uint32_t pmax_out
[AFI_MAX
][SAFI_MAX
];
1622 char allowas_in
[AFI_MAX
][SAFI_MAX
];
1625 struct ecommunity
*soo
[AFI_MAX
][SAFI_MAX
];
1628 unsigned long weight
[AFI_MAX
][SAFI_MAX
];
1630 /* peer reset cause */
1632 #define PEER_DOWN_RID_CHANGE 1U /* bgp router-id command */
1633 #define PEER_DOWN_REMOTE_AS_CHANGE 2U /* neighbor remote-as command */
1634 #define PEER_DOWN_LOCAL_AS_CHANGE 3U /* neighbor local-as command */
1635 #define PEER_DOWN_CLID_CHANGE 4U /* bgp cluster-id command */
1636 #define PEER_DOWN_CONFED_ID_CHANGE 5U /* bgp confederation id command */
1637 #define PEER_DOWN_CONFED_PEER_CHANGE 6U /* bgp confederation peer command */
1638 #define PEER_DOWN_RR_CLIENT_CHANGE 7U /* neighbor rr-client command */
1639 #define PEER_DOWN_RS_CLIENT_CHANGE 8U /* neighbor rs-client command */
1640 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9U /* neighbor update-source command */
1641 #define PEER_DOWN_AF_ACTIVATE 10U /* neighbor activate command */
1642 #define PEER_DOWN_USER_SHUTDOWN 11U /* neighbor shutdown command */
1643 #define PEER_DOWN_USER_RESET 12U /* clear ip bgp command */
1644 #define PEER_DOWN_NOTIFY_RECEIVED 13U /* notification received */
1645 #define PEER_DOWN_NOTIFY_SEND 14U /* notification send */
1646 #define PEER_DOWN_CLOSE_SESSION 15U /* tcp session close */
1647 #define PEER_DOWN_NEIGHBOR_DELETE 16U /* neghbor delete */
1648 #define PEER_DOWN_RMAP_BIND 17U /* neghbor peer-group command */
1649 #define PEER_DOWN_RMAP_UNBIND 18U /* no neighbor peer-group command */
1650 #define PEER_DOWN_CAPABILITY_CHANGE 19U /* neighbor capability command */
1651 #define PEER_DOWN_PASSIVE_CHANGE 20U /* neighbor passive command */
1652 #define PEER_DOWN_MULTIHOP_CHANGE 21U /* neighbor multihop command */
1653 #define PEER_DOWN_NSF_CLOSE_SESSION 22U /* NSF tcp session close */
1654 #define PEER_DOWN_V6ONLY_CHANGE 23U /* if-based peering v6only toggled */
1655 #define PEER_DOWN_BFD_DOWN 24U /* BFD down */
1656 #define PEER_DOWN_IF_DOWN 25U /* Interface down */
1657 #define PEER_DOWN_NBR_ADDR_DEL 26U /* Peer address lost */
1658 #define PEER_DOWN_WAITING_NHT 27U /* Waiting for NHT to resolve */
1659 #define PEER_DOWN_NBR_ADDR 28U /* Waiting for peer IPv6 IP Addr */
1660 #define PEER_DOWN_VRF_UNINIT 29U /* Associated VRF is not init yet */
1661 #define PEER_DOWN_NOAFI_ACTIVATED 30U /* No AFI/SAFI activated for peer */
1662 #define PEER_DOWN_AS_SETS_REJECT 31U /* Reject routes with AS_SET */
1663 #define PEER_DOWN_WAITING_OPEN 32U /* Waiting for open to succeed */
1664 #define PEER_DOWN_PFX_COUNT 33U /* Reached received prefix count */
1665 #define PEER_DOWN_SOCKET_ERROR 34U /* Some socket error happened */
1667 * Remember to update peer_down_str in bgp_fsm.c when you add
1668 * a new value to the last_reset reason
1671 uint16_t last_reset_cause_size
;
1672 uint8_t last_reset_cause
[BGP_MAX_PACKET_SIZE
];
1674 /* The kind of route-map Flags.*/
1676 #define PEER_RMAP_TYPE_IN (1U << 0) /* neighbor route-map in */
1677 #define PEER_RMAP_TYPE_OUT (1U << 1) /* neighbor route-map out */
1678 #define PEER_RMAP_TYPE_NETWORK (1U << 2) /* network route-map */
1679 #define PEER_RMAP_TYPE_REDISTRIBUTE (1U << 3) /* redistribute route-map */
1680 #define PEER_RMAP_TYPE_DEFAULT (1U << 4) /* default-originate route-map */
1681 #define PEER_RMAP_TYPE_NOSET (1U << 5) /* not allow to set commands */
1682 #define PEER_RMAP_TYPE_IMPORT (1U << 6) /* neighbor route-map import */
1683 #define PEER_RMAP_TYPE_EXPORT (1U << 7) /* neighbor route-map export */
1684 #define PEER_RMAP_TYPE_AGGREGATE (1U << 8) /* aggregate-address route-map */
1686 /** Peer overwrite configuration. */
1687 struct bfd_session_config
{
1689 * Manual configuration bit.
1691 * This flag only makes sense for real peers (and not groups),
1692 * it keeps track if the user explicitly configured BFD for a
1696 /** Control Plane Independent. */
1698 /** Detection multiplier. */
1699 uint8_t detection_multiplier
;
1700 /** Minimum required RX interval. */
1702 /** Minimum required TX interval. */
1704 /** Profile name. */
1705 char profile
[BFD_PROFILE_NAME_LEN
];
1706 /** Peer BFD session */
1707 struct bfd_session_params
*session
;
1710 /* hostname and domainname advertised by host */
1714 /* Sender side AS path loop detection. */
1715 bool as_path_loop_detection
;
1717 /* Extended Message Support */
1718 uint16_t max_packet_size
;
1720 /* Conditional advertisement */
1721 bool advmap_config_change
[AFI_MAX
][SAFI_MAX
];
1722 bool advmap_table_change
;
1724 /* set TCP max segment size */
1727 /* Long-lived Graceful Restart */
1728 struct llgr_info llgr
[AFI_MAX
][SAFI_MAX
];
1730 bool shut_during_cfg
;
1734 DECLARE_QOBJ_TYPE(peer
);
1736 /* Inherit peer attribute from peer-group. */
1737 #define PEER_ATTR_INHERIT(peer, group, attr) \
1738 ((peer)->attr = (group)->conf->attr)
1739 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1741 XFREE(mt, (peer)->attr); \
1742 if ((group)->conf->attr) \
1743 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1745 (peer)->attr = NULL; \
1747 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1750 sockunion_free((peer)->attr); \
1751 if ((group)->conf->attr) \
1752 (peer)->attr = sockunion_dup((group)->conf->attr); \
1754 (peer)->attr = NULL; \
1757 /* Check if suppress start/restart of sessions to peer. */
1758 #define BGP_PEER_START_SUPPRESSED(P) \
1759 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) || \
1760 CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) || \
1761 CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN) || \
1762 (P)->shut_during_cfg)
1764 #define PEER_ROUTE_ADV_DELAY(peer) \
1765 (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
1767 #define PEER_PASSWORD_MINLEN (1)
1768 #define PEER_PASSWORD_MAXLEN (80)
1770 /* This structure's member directly points incoming packet data
1774 uint16_t afi
; /* iana_afi_t */
1777 uint8_t safi
; /* iana_safi_t */
1779 /* Pointer to NLRI byte stream. */
1782 /* Length of whole NLRI. */
1787 #define BGP_VERSION_4 4
1789 /* Default BGP port number. */
1790 #define BGP_PORT_DEFAULT 179
1792 /* Extended BGP Administrative Shutdown Communication */
1793 #define BGP_ADMIN_SHUTDOWN_MSG_LEN 255
1795 /* BGP minimum message size. */
1796 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1797 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1798 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1799 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1800 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1801 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1803 /* BGP message types. */
1804 #define BGP_MSG_OPEN 1
1805 #define BGP_MSG_UPDATE 2
1806 #define BGP_MSG_NOTIFY 3
1807 #define BGP_MSG_KEEPALIVE 4
1808 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1809 #define BGP_MSG_CAPABILITY 6
1810 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1812 /* BGP open optional parameter. */
1813 #define BGP_OPEN_OPT_AUTH 1
1814 #define BGP_OPEN_OPT_CAP 2
1816 /* BGP4 attribute type codes. */
1817 #define BGP_ATTR_ORIGIN 1
1818 #define BGP_ATTR_AS_PATH 2
1819 #define BGP_ATTR_NEXT_HOP 3
1820 #define BGP_ATTR_MULTI_EXIT_DISC 4
1821 #define BGP_ATTR_LOCAL_PREF 5
1822 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1823 #define BGP_ATTR_AGGREGATOR 7
1824 #define BGP_ATTR_COMMUNITIES 8
1825 #define BGP_ATTR_ORIGINATOR_ID 9
1826 #define BGP_ATTR_CLUSTER_LIST 10
1827 #define BGP_ATTR_MP_REACH_NLRI 14
1828 #define BGP_ATTR_MP_UNREACH_NLRI 15
1829 #define BGP_ATTR_EXT_COMMUNITIES 16
1830 #define BGP_ATTR_AS4_PATH 17
1831 #define BGP_ATTR_AS4_AGGREGATOR 18
1832 #define BGP_ATTR_AS_PATHLIMIT 21
1833 #define BGP_ATTR_PMSI_TUNNEL 22
1834 #define BGP_ATTR_ENCAP 23
1835 #define BGP_ATTR_IPV6_EXT_COMMUNITIES 25
1836 #define BGP_ATTR_LARGE_COMMUNITIES 32
1837 #define BGP_ATTR_OTC 35
1838 #define BGP_ATTR_PREFIX_SID 40
1839 #define BGP_ATTR_SRTE_COLOR 51
1840 #ifdef ENABLE_BGP_VNC_ATTR
1841 #define BGP_ATTR_VNC 255
1844 /* BGP update origin. */
1845 #define BGP_ORIGIN_IGP 0
1846 #define BGP_ORIGIN_EGP 1
1847 #define BGP_ORIGIN_INCOMPLETE 2
1848 #define BGP_ORIGIN_UNSPECIFIED 255
1850 /* BGP notify message codes. */
1851 #define BGP_NOTIFY_HEADER_ERR 1
1852 #define BGP_NOTIFY_OPEN_ERR 2
1853 #define BGP_NOTIFY_UPDATE_ERR 3
1854 #define BGP_NOTIFY_HOLD_ERR 4
1855 #define BGP_NOTIFY_FSM_ERR 5
1856 #define BGP_NOTIFY_CEASE 6
1857 #define BGP_NOTIFY_ROUTE_REFRESH_ERR 7
1859 /* Subcodes for BGP Finite State Machine Error */
1860 #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC 0
1861 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT 1
1862 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
1863 #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
1865 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1867 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1868 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1869 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1870 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1872 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1873 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1874 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1875 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1876 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1877 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1878 #define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1879 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1880 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1881 #define BGP_NOTIFY_OPEN_ROLE_MISMATCH 11
1883 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1884 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1885 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1886 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1887 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1888 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1889 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1890 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1891 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1892 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1893 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1894 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1896 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1897 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1898 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1899 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1900 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1901 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1902 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1903 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1904 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1905 #define BGP_NOTIFY_CEASE_HARD_RESET 9
1906 #define BGP_NOTIFY_CEASE_BFD_DOWN 10
1908 /* BGP_NOTIFY_ROUTE_REFRESH_ERR sub codes (RFC 7313). */
1909 #define BGP_NOTIFY_ROUTE_REFRESH_INVALID_MSG_LEN 1
1911 /* BGP route refresh optional subtypes. */
1912 #define BGP_ROUTE_REFRESH_NORMAL 0
1913 #define BGP_ROUTE_REFRESH_BORR 1
1914 #define BGP_ROUTE_REFRESH_EORR 2
1916 /* BGP timers default value. */
1917 #define BGP_INIT_START_TIMER 1
1918 /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1919 * version-/profile-specific values. The values here do not matter, they only
1920 * exist to provide a clear layering separation between core and CLI.
1922 #define BGP_DEFAULT_HOLDTIME 180
1923 #define BGP_DEFAULT_KEEPALIVE 60
1924 #define BGP_DEFAULT_CONNECT_RETRY 120
1926 #define BGP_DEFAULT_EBGP_ROUTEADV 0
1927 #define BGP_DEFAULT_IBGP_ROUTEADV 0
1929 /* BGP RFC 4271 DelayOpenTime default value */
1930 #define BGP_DEFAULT_DELAYOPEN 120
1932 /* BGP default local preference. */
1933 #define BGP_DEFAULT_LOCAL_PREF 100
1935 /* BGP local-preference to send when 'bgp graceful-shutdown'
1937 #define BGP_GSHUT_LOCAL_PREF 0
1939 /* BGP default subgroup packet queue max . */
1940 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1942 /* BGP graceful restart */
1943 #define BGP_DEFAULT_RESTART_TIME 120
1944 #define BGP_DEFAULT_STALEPATH_TIME 360
1945 #define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
1946 #define BGP_DEFAULT_RIB_STALE_TIME 500
1947 #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME 1
1949 /* BGP Long-lived Graceful Restart */
1950 #define BGP_DEFAULT_LLGR_STALE_TIME 0
1952 /* BGP uptime string length. */
1953 #define BGP_UPTIME_LEN 25
1955 /* Default configuration settings for bgpd. */
1956 #define BGP_VTY_PORT 2605
1957 #define BGP_DEFAULT_CONFIG "bgpd.conf"
1959 /* BGP Dynamic Neighbors feature */
1960 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1961 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1962 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 65535
1964 /* Flag for peer_clear_soft(). */
1965 enum bgp_clear_type
{
1966 BGP_CLEAR_SOFT_NONE
,
1969 BGP_CLEAR_SOFT_BOTH
,
1970 BGP_CLEAR_SOFT_IN_ORF_PREFIX
,
1971 BGP_CLEAR_MESSAGE_STATS
1975 #define BGP_INPUT(P) ((P)->curr)
1976 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
1977 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
1978 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
1980 /* BGP error codes. */
1981 enum bgp_create_error_code
{
1984 BGP_ERR_INVALID_VALUE
= -1,
1985 BGP_ERR_INVALID_FLAG
= -2,
1986 BGP_ERR_INVALID_AS
= -3,
1987 BGP_ERR_PEER_GROUP_MEMBER
= -4,
1988 BGP_ERR_PEER_GROUP_NO_REMOTE_AS
= -5,
1989 BGP_ERR_PEER_GROUP_CANT_CHANGE
= -6,
1990 BGP_ERR_PEER_GROUP_MISMATCH
= -7,
1991 BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT
= -8,
1992 BGP_ERR_AS_MISMATCH
= -9,
1993 BGP_ERR_PEER_FLAG_CONFLICT
= -10,
1994 BGP_ERR_PEER_GROUP_SHUTDOWN
= -11,
1995 BGP_ERR_PEER_FILTER_CONFLICT
= -12,
1996 BGP_ERR_NOT_INTERNAL_PEER
= -13,
1997 BGP_ERR_REMOVE_PRIVATE_AS
= -14,
1998 BGP_ERR_AF_UNCONFIGURED
= -15,
1999 BGP_ERR_SOFT_RECONFIG_UNCONFIGURED
= -16,
2000 BGP_ERR_INSTANCE_MISMATCH
= -17,
2001 BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP
= -18,
2002 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS
= -19,
2003 BGP_ERR_TCPSIG_FAILED
= -20,
2004 BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK
= -21,
2005 BGP_ERR_NO_IBGP_WITH_TTLHACK
= -22,
2006 BGP_ERR_NO_INTERFACE_CONFIG
= -23,
2007 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS
= -24,
2008 BGP_ERR_AS_OVERRIDE
= -25,
2009 BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT
= -26,
2010 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS
= -27,
2011 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND
= -28,
2012 BGP_ERR_INVALID_FOR_DYNAMIC_PEER
= -29,
2013 BGP_ERR_INVALID_FOR_DIRECT_PEER
= -30,
2014 BGP_ERR_PEER_SAFI_CONFLICT
= -31,
2017 BGP_ERR_GR_INVALID_CMD
= -32,
2018 BGP_ERR_GR_OPERATION_FAILED
= -33,
2019 BGP_GR_NO_OPERATION
= -34,
2021 /*BGP Open Policy ERRORS */
2022 BGP_ERR_INVALID_ROLE_NAME
= -35,
2023 BGP_ERR_INVALID_INTERNAL_ROLE
= -36
2027 * Enumeration of different policy kinds a peer can be configured with.
2029 enum bgp_policy_type
{
2030 BGP_POLICY_ROUTE_MAP
,
2031 BGP_POLICY_FILTER_LIST
,
2032 BGP_POLICY_PREFIX_LIST
,
2033 BGP_POLICY_DISTRIBUTE_LIST
,
2036 /* peer_flag_change_type. */
2037 enum peer_change_type
{
2040 peer_change_reset_in
,
2041 peer_change_reset_out
,
2044 extern struct bgp_master
*bm
;
2045 extern unsigned int multipath_num
;
2048 extern void bgp_terminate(void);
2049 extern void bgp_reset(void);
2050 extern void bgp_zclient_reset(void);
2051 extern struct bgp
*bgp_get_default(void);
2052 extern struct bgp
*bgp_lookup(as_t
, const char *);
2053 extern struct bgp
*bgp_lookup_by_name(const char *);
2054 extern struct bgp
*bgp_lookup_by_vrf_id(vrf_id_t
);
2055 extern struct bgp
*bgp_get_evpn(void);
2056 extern void bgp_set_evpn(struct bgp
*bgp
);
2057 extern struct peer
*peer_lookup(struct bgp
*, union sockunion
*);
2058 extern struct peer
*peer_lookup_by_conf_if(struct bgp
*, const char *);
2059 extern struct peer
*peer_lookup_by_hostname(struct bgp
*, const char *);
2060 extern void bgp_peer_conf_if_to_su_update(struct peer
*);
2061 extern int peer_group_listen_range_del(struct peer_group
*, struct prefix
*);
2062 extern struct peer_group
*peer_group_lookup(struct bgp
*, const char *);
2063 extern struct peer_group
*peer_group_get(struct bgp
*, const char *);
2064 extern struct peer
*peer_create_bind_dynamic_neighbor(struct bgp
*,
2066 struct peer_group
*);
2067 extern struct prefix
*
2068 peer_group_lookup_dynamic_neighbor_range(struct peer_group
*, struct prefix
*);
2069 extern struct peer_group
*peer_group_lookup_dynamic_neighbor(struct bgp
*,
2072 extern struct peer
*peer_lookup_dynamic_neighbor(struct bgp
*,
2076 * Peers are incredibly easy to memory leak
2077 * due to the various ways that they are actually used
2078 * Provide some functionality to debug locks and unlocks
2080 extern struct peer
*peer_lock_with_caller(const char *, struct peer
*);
2081 extern struct peer
*peer_unlock_with_caller(const char *, struct peer
*);
2082 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
2083 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
2085 extern enum bgp_peer_sort
peer_sort(struct peer
*peer
);
2086 extern enum bgp_peer_sort
peer_sort_lookup(struct peer
*peer
);
2088 extern bool peer_active(struct peer
*);
2089 extern bool peer_active_nego(struct peer
*);
2090 extern bool peer_afc_received(struct peer
*peer
);
2091 extern bool peer_afc_advertised(struct peer
*peer
);
2092 extern void bgp_recalculate_all_bestpaths(struct bgp
*bgp
);
2093 extern struct peer
*peer_create(union sockunion
*, const char *, struct bgp
*,
2094 as_t
, as_t
, int, struct peer_group
*);
2095 extern struct peer
*peer_create_accept(struct bgp
*);
2096 extern void peer_xfer_config(struct peer
*dst
, struct peer
*src
);
2097 extern char *peer_uptime(time_t uptime2
, char *buf
, size_t len
, bool use_json
,
2100 extern int bgp_config_write(struct vty
*);
2102 extern void bgp_master_init(struct thread_master
*master
, const int buffer_size
,
2103 struct list
*addresses
);
2105 extern void bgp_init(unsigned short instance
);
2106 extern void bgp_pthreads_run(void);
2107 extern void bgp_pthreads_finish(void);
2108 extern void bgp_route_map_init(void);
2109 extern void bgp_session_reset(struct peer
*);
2111 extern int bgp_option_set(int);
2112 extern int bgp_option_unset(int);
2113 extern int bgp_option_check(int);
2115 /* set the bgp no-rib option during runtime and remove installed routes */
2116 extern void bgp_option_norib_set_runtime(void);
2118 /* unset the bgp no-rib option during runtime and reset all peers */
2119 extern void bgp_option_norib_unset_runtime(void);
2121 extern int bgp_get(struct bgp
**, as_t
*, const char *, enum bgp_instance_type
);
2122 extern void bgp_instance_up(struct bgp
*);
2123 extern void bgp_instance_down(struct bgp
*);
2124 extern int bgp_delete(struct bgp
*);
2126 extern int bgp_handle_socket(struct bgp
*bgp
, struct vrf
*vrf
,
2127 vrf_id_t old_vrf_id
, bool create
);
2129 extern void bgp_router_id_zebra_bump(vrf_id_t
, const struct prefix
*);
2130 extern void bgp_router_id_static_set(struct bgp
*, struct in_addr
);
2132 extern void bm_wait_for_fib_set(bool set
);
2133 extern void bgp_suppress_fib_pending_set(struct bgp
*bgp
, bool set
);
2134 extern void bgp_cluster_id_set(struct bgp
*bgp
, struct in_addr
*cluster_id
);
2135 extern void bgp_cluster_id_unset(struct bgp
*bgp
);
2137 extern void bgp_confederation_id_set(struct bgp
*bgp
, as_t as
);
2138 extern void bgp_confederation_id_unset(struct bgp
*bgp
);
2139 extern bool bgp_confederation_peers_check(struct bgp
*, as_t
);
2141 extern void bgp_confederation_peers_add(struct bgp
*bgp
, as_t as
);
2142 extern void bgp_confederation_peers_remove(struct bgp
*bgp
, as_t as
);
2144 extern void bgp_timers_set(struct bgp
*, uint32_t keepalive
, uint32_t holdtime
,
2145 uint32_t connect_retry
, uint32_t delayopen
);
2146 extern void bgp_timers_unset(struct bgp
*);
2148 extern void bgp_default_local_preference_set(struct bgp
*bgp
,
2149 uint32_t local_pref
);
2150 extern void bgp_default_local_preference_unset(struct bgp
*bgp
);
2152 extern void bgp_default_subgroup_pkt_queue_max_set(struct bgp
*bgp
,
2153 uint32_t queue_size
);
2154 extern void bgp_default_subgroup_pkt_queue_max_unset(struct bgp
*bgp
);
2156 extern void bgp_listen_limit_set(struct bgp
*bgp
, int listen_limit
);
2157 extern void bgp_listen_limit_unset(struct bgp
*bgp
);
2159 extern bool bgp_update_delay_active(struct bgp
*);
2160 extern bool bgp_update_delay_configured(struct bgp
*);
2161 extern bool bgp_afi_safi_peer_exists(struct bgp
*bgp
, afi_t afi
, safi_t safi
);
2162 extern void peer_as_change(struct peer
*, as_t
, int);
2163 extern int peer_remote_as(struct bgp
*, union sockunion
*, const char *, as_t
*,
2165 extern int peer_group_remote_as(struct bgp
*, const char *, as_t
*, int);
2166 extern int peer_delete(struct peer
*peer
);
2167 extern void peer_notify_unconfig(struct peer
*peer
);
2168 extern int peer_group_delete(struct peer_group
*);
2169 extern int peer_group_remote_as_delete(struct peer_group
*);
2170 extern int peer_group_listen_range_add(struct peer_group
*, struct prefix
*);
2171 extern void peer_group_notify_unconfig(struct peer_group
*group
);
2173 extern int peer_activate(struct peer
*, afi_t
, safi_t
);
2174 extern int peer_deactivate(struct peer
*, afi_t
, safi_t
);
2176 extern int peer_group_bind(struct bgp
*, union sockunion
*, struct peer
*,
2177 struct peer_group
*, as_t
*);
2179 extern int peer_flag_set(struct peer
*peer
, uint64_t flag
);
2180 extern int peer_flag_unset(struct peer
*peer
, uint64_t flag
);
2181 extern void peer_flag_inherit(struct peer
*peer
, uint64_t flag
);
2183 extern int peer_af_flag_set(struct peer
*, afi_t
, safi_t
, uint32_t);
2184 extern int peer_af_flag_unset(struct peer
*, afi_t
, safi_t
, uint32_t);
2185 extern int peer_af_flag_check(struct peer
*, afi_t
, safi_t
, uint32_t);
2186 extern void peer_af_flag_inherit(struct peer
*peer
, afi_t afi
, safi_t safi
,
2188 extern void peer_change_action(struct peer
*peer
, afi_t afi
, safi_t safi
,
2189 enum peer_change_type type
);
2191 extern int peer_ebgp_multihop_set(struct peer
*, int);
2192 extern int peer_ebgp_multihop_unset(struct peer
*);
2193 extern int is_ebgp_multihop_configured(struct peer
*peer
);
2195 extern int peer_role_set(struct peer
*peer
, uint8_t role
, bool strict_mode
);
2196 extern int peer_role_unset(struct peer
*peer
);
2198 extern void peer_description_set(struct peer
*, const char *);
2199 extern void peer_description_unset(struct peer
*);
2201 extern int peer_update_source_if_set(struct peer
*, const char *);
2202 extern void peer_update_source_addr_set(struct peer
*peer
,
2203 const union sockunion
*su
);
2204 extern void peer_update_source_unset(struct peer
*peer
);
2206 extern int peer_default_originate_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2208 struct route_map
*route_map
);
2209 extern int peer_default_originate_unset(struct peer
*, afi_t
, safi_t
);
2211 extern void peer_port_set(struct peer
*, uint16_t);
2212 extern void peer_port_unset(struct peer
*);
2214 extern int peer_weight_set(struct peer
*, afi_t
, safi_t
, uint16_t);
2215 extern int peer_weight_unset(struct peer
*, afi_t
, safi_t
);
2217 extern int peer_timers_set(struct peer
*, uint32_t keepalive
,
2219 extern int peer_timers_unset(struct peer
*);
2221 extern int peer_timers_connect_set(struct peer
*, uint32_t);
2222 extern int peer_timers_connect_unset(struct peer
*);
2224 extern int peer_advertise_interval_set(struct peer
*, uint32_t);
2225 extern int peer_advertise_interval_unset(struct peer
*);
2227 extern int peer_timers_delayopen_set(struct peer
*peer
, uint32_t delayopen
);
2228 extern int peer_timers_delayopen_unset(struct peer
*peer
);
2230 extern void peer_interface_set(struct peer
*, const char *);
2231 extern void peer_interface_unset(struct peer
*);
2233 extern int peer_distribute_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2234 extern int peer_distribute_unset(struct peer
*, afi_t
, safi_t
, int);
2236 extern int peer_allowas_in_set(struct peer
*, afi_t
, safi_t
, int, int);
2237 extern int peer_allowas_in_unset(struct peer
*, afi_t
, safi_t
);
2239 extern int peer_local_as_set(struct peer
*, as_t
, bool no_prepend
,
2241 extern int peer_local_as_unset(struct peer
*);
2243 extern int peer_prefix_list_set(struct peer
*, afi_t
, safi_t
, int,
2245 extern int peer_prefix_list_unset(struct peer
*, afi_t
, safi_t
, int);
2247 extern int peer_aslist_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2248 extern int peer_aslist_unset(struct peer
*, afi_t
, safi_t
, int);
2250 extern int peer_route_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
, int,
2251 const char *name
, struct route_map
*route_map
);
2252 extern int peer_route_map_unset(struct peer
*, afi_t
, safi_t
, int);
2254 extern int peer_unsuppress_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2256 struct route_map
*route_map
);
2258 extern int peer_advertise_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2259 const char *advertise_name
,
2260 struct route_map
*advertise_map
,
2261 const char *condition_name
,
2262 struct route_map
*condition_map
,
2265 extern int peer_password_set(struct peer
*, const char *);
2266 extern int peer_password_unset(struct peer
*);
2268 extern int peer_unsuppress_map_unset(struct peer
*, afi_t
, safi_t
);
2270 extern int peer_advertise_map_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
2271 const char *advertise_name
,
2272 struct route_map
*advertise_map
,
2273 const char *condition_name
,
2274 struct route_map
*condition_map
,
2277 extern int peer_maximum_prefix_set(struct peer
*, afi_t
, safi_t
, uint32_t,
2278 uint8_t, int, uint16_t, bool force
);
2279 extern int peer_maximum_prefix_unset(struct peer
*, afi_t
, safi_t
);
2281 extern void peer_maximum_prefix_out_refresh_routes(struct peer
*peer
, afi_t afi
,
2283 extern int peer_maximum_prefix_out_set(struct peer
*peer
, afi_t afi
,
2284 safi_t safi
, uint32_t max
);
2285 extern int peer_maximum_prefix_out_unset(struct peer
*peer
, afi_t afi
,
2288 extern int peer_clear(struct peer
*, struct listnode
**);
2289 extern int peer_clear_soft(struct peer
*, afi_t
, safi_t
, enum bgp_clear_type
);
2291 extern int peer_ttl_security_hops_set(struct peer
*, int);
2292 extern int peer_ttl_security_hops_unset(struct peer
*);
2294 extern void peer_tx_shutdown_message_set(struct peer
*, const char *msg
);
2295 extern void peer_tx_shutdown_message_unset(struct peer
*);
2297 extern void bgp_route_map_update_timer(struct thread
*thread
);
2298 extern const char *bgp_get_name_by_role(uint8_t role
);
2300 extern void bgp_route_map_terminate(void);
2302 extern int peer_cmp(struct peer
*p1
, struct peer
*p2
);
2304 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi
, iana_safi_t pkt_safi
,
2305 afi_t
*afi
, safi_t
*safi
);
2306 extern int bgp_map_afi_safi_int2iana(afi_t afi
, safi_t safi
,
2307 iana_afi_t
*pkt_afi
,
2308 iana_safi_t
*pkt_safi
);
2310 extern struct peer_af
*peer_af_create(struct peer
*, afi_t
, safi_t
);
2311 extern struct peer_af
*peer_af_find(struct peer
*, afi_t
, safi_t
);
2312 extern int peer_af_delete(struct peer
*, afi_t
, safi_t
);
2314 extern void bgp_shutdown_enable(struct bgp
*bgp
, const char *msg
);
2315 extern void bgp_shutdown_disable(struct bgp
*bgp
);
2317 extern void bgp_close(void);
2318 extern void bgp_free(struct bgp
*);
2319 void bgp_gr_apply_running_config(void);
2322 int bgp_global_gr_init(struct bgp
*bgp
);
2323 int bgp_peer_gr_init(struct peer
*peer
);
2326 #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list) \
2328 struct peer *peer_loop; \
2329 bool gr_router_detected = false; \
2330 struct listnode *node = {0}; \
2331 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) { \
2332 if (CHECK_FLAG(peer_loop->flags, \
2333 PEER_FLAG_GRACEFUL_RESTART)) \
2334 gr_router_detected = true; \
2336 if (gr_router_detected \
2337 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
2338 bgp_zebra_send_capabilities(_bgp, false); \
2339 } else if (!gr_router_detected \
2340 && _bgp->present_zebra_gr_state \
2341 == ZEBRA_GR_ENABLE) { \
2342 bgp_zebra_send_capabilities(_bgp, true); \
2346 static inline struct bgp
*bgp_lock(struct bgp
*bgp
)
2352 static inline void bgp_unlock(struct bgp
*bgp
)
2354 assert(bgp
->lock
> 0);
2355 if (--bgp
->lock
== 0)
2359 static inline int afindex(afi_t afi
, safi_t safi
)
2365 return BGP_AF_IPV4_UNICAST
;
2366 case SAFI_MULTICAST
:
2367 return BGP_AF_IPV4_MULTICAST
;
2368 case SAFI_LABELED_UNICAST
:
2369 return BGP_AF_IPV4_LBL_UNICAST
;
2371 return BGP_AF_IPV4_VPN
;
2373 return BGP_AF_IPV4_ENCAP
;
2375 return BGP_AF_IPV4_FLOWSPEC
;
2383 return BGP_AF_IPV6_UNICAST
;
2384 case SAFI_MULTICAST
:
2385 return BGP_AF_IPV6_MULTICAST
;
2386 case SAFI_LABELED_UNICAST
:
2387 return BGP_AF_IPV6_LBL_UNICAST
;
2389 return BGP_AF_IPV6_VPN
;
2391 return BGP_AF_IPV6_ENCAP
;
2393 return BGP_AF_IPV6_FLOWSPEC
;
2401 return BGP_AF_L2VPN_EVPN
;
2410 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
2411 static inline int peer_group_active(struct peer
*peer
)
2413 if (!CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
) && peer
->group
)
2418 /* If peer is negotiated at least one address family return 1. */
2419 static inline int peer_afi_active_nego(const struct peer
*peer
, afi_t afi
)
2421 if (peer
->afc_nego
[afi
][SAFI_UNICAST
]
2422 || peer
->afc_nego
[afi
][SAFI_MULTICAST
]
2423 || peer
->afc_nego
[afi
][SAFI_LABELED_UNICAST
]
2424 || peer
->afc_nego
[afi
][SAFI_MPLS_VPN
]
2425 || peer
->afc_nego
[afi
][SAFI_ENCAP
]
2426 || peer
->afc_nego
[afi
][SAFI_FLOWSPEC
]
2427 || peer
->afc_nego
[afi
][SAFI_EVPN
])
2432 /* If at least one address family activated for group, return 1. */
2433 static inline int peer_group_af_configured(struct peer_group
*group
)
2435 struct peer
*peer
= group
->conf
;
2437 if (peer
->afc
[AFI_IP
][SAFI_UNICAST
] || peer
->afc
[AFI_IP
][SAFI_MULTICAST
]
2438 || peer
->afc
[AFI_IP
][SAFI_LABELED_UNICAST
]
2439 || peer
->afc
[AFI_IP
][SAFI_FLOWSPEC
]
2440 || peer
->afc
[AFI_IP
][SAFI_MPLS_VPN
] || peer
->afc
[AFI_IP
][SAFI_ENCAP
]
2441 || peer
->afc
[AFI_IP6
][SAFI_UNICAST
]
2442 || peer
->afc
[AFI_IP6
][SAFI_MULTICAST
]
2443 || peer
->afc
[AFI_IP6
][SAFI_LABELED_UNICAST
]
2444 || peer
->afc
[AFI_IP6
][SAFI_MPLS_VPN
]
2445 || peer
->afc
[AFI_IP6
][SAFI_ENCAP
]
2446 || peer
->afc
[AFI_IP6
][SAFI_FLOWSPEC
]
2447 || peer
->afc
[AFI_L2VPN
][SAFI_EVPN
])
2452 static inline char *timestamp_string(time_t ts
)
2455 tbuf
= time(NULL
) - (monotime(NULL
) - ts
);
2456 return ctime(&tbuf
);
2459 static inline bool peer_established(struct peer
*peer
)
2461 return peer
->status
== Established
;
2464 static inline bool peer_dynamic_neighbor(struct peer
*peer
)
2466 return CHECK_FLAG(peer
->flags
, PEER_FLAG_DYNAMIC_NEIGHBOR
);
2469 static inline bool peer_dynamic_neighbor_no_nsf(struct peer
*peer
)
2471 return (peer_dynamic_neighbor(peer
) &&
2472 !CHECK_FLAG(peer
->sflags
, PEER_STATUS_NSF_WAIT
));
2475 static inline int peer_cap_enhe(struct peer
*peer
, afi_t afi
, safi_t safi
)
2477 return (CHECK_FLAG(peer
->af_cap
[afi
][safi
], PEER_CAP_ENHE_AF_NEGO
));
2480 /* Lookup VRF for BGP instance based on its type. */
2481 static inline struct vrf
*bgp_vrf_lookup_by_instance_type(struct bgp
*bgp
)
2485 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_DEFAULT
)
2486 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
2487 else if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
)
2488 vrf
= vrf_lookup_by_name(bgp
->name
);
2495 static inline uint32_t bgp_vrf_interfaces(struct bgp
*bgp
, bool active
)
2498 struct interface
*ifp
;
2501 /* if there is one interface in the vrf which is up then it is deemed
2504 vrf
= bgp_vrf_lookup_by_instance_type(bgp
);
2507 RB_FOREACH (ifp
, if_name_head
, &vrf
->ifaces_by_name
) {
2508 if (strcmp(ifp
->name
, bgp
->name
) == 0)
2510 if (!active
|| if_is_up(ifp
))
2516 /* Link BGP instance to VRF. */
2517 static inline void bgp_vrf_link(struct bgp
*bgp
, struct vrf
*vrf
)
2519 bgp
->vrf_id
= vrf
->vrf_id
;
2520 if (vrf
->info
!= (void *)bgp
)
2521 vrf
->info
= (void *)bgp_lock(bgp
);
2524 /* Unlink BGP instance from VRF. */
2525 static inline void bgp_vrf_unlink(struct bgp
*bgp
, struct vrf
*vrf
)
2527 if (vrf
->info
== (void *)bgp
) {
2531 bgp
->vrf_id
= VRF_UNKNOWN
;
2534 static inline bool bgp_in_graceful_shutdown(struct bgp
*bgp
)
2536 /* True if either set for this instance or globally */
2537 return (!!CHECK_FLAG(bgp
->flags
, BGP_FLAG_GRACEFUL_SHUTDOWN
) ||
2538 !!CHECK_FLAG(bm
->flags
, BM_FLAG_GRACEFUL_SHUTDOWN
));
2541 /* For benefit of rfapi */
2542 extern struct peer
*peer_new(struct bgp
*bgp
);
2544 extern struct peer
*peer_lookup_in_view(struct vty
*vty
, struct bgp
*bgp
,
2545 const char *ip_str
, bool use_json
);
2546 extern int bgp_lookup_by_as_name_type(struct bgp
**bgp_val
, as_t
*as
,
2548 enum bgp_instance_type inst_type
);
2551 DECLARE_HOOK(bgp_vrf_status_changed
, (struct bgp
*bgp
, struct interface
*ifp
),
2553 DECLARE_HOOK(peer_status_changed
, (struct peer
*peer
), (peer
));
2554 DECLARE_HOOK(bgp_snmp_init_stats
, (struct bgp
*bgp
), (bgp
));
2555 DECLARE_HOOK(bgp_snmp_update_last_changed
, (struct bgp
*bgp
), (bgp
));
2556 DECLARE_HOOK(bgp_snmp_update_stats
,
2557 (struct bgp_node
*rn
, struct bgp_path_info
*pi
, bool added
),
2559 DECLARE_HOOK(bgp_rpki_prefix_status
,
2560 (struct peer
* peer
, struct attr
*attr
,
2561 const struct prefix
*prefix
),
2562 (peer
, attr
, prefix
));
2564 void peer_nsf_stop(struct peer
*peer
);
2566 void peer_tcp_mss_set(struct peer
*peer
, uint32_t tcp_mss
);
2567 void peer_tcp_mss_unset(struct peer
*peer
);
2569 extern void bgp_recalculate_afi_safi_bestpaths(struct bgp
*bgp
, afi_t afi
,
2572 #ifdef _FRR_ATTRIBUTE_PRINTFRR
2573 /* clang-format off */
2574 #pragma FRR printfrr_ext "%pBP" (struct peer *)
2575 /* clang-format on */
2578 #endif /* _QUAGGA_BGPD_H */