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"
50 #include "lib/orr_msg.h"
52 #define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
53 #define BGP_PEER_MAX_HASH_SIZE 16384
55 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
56 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
58 struct update_subgroup
;
60 struct bgp_pbr_config
;
63 * Allow the neighbor XXXX remote-as to take internal or external
64 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
68 enum { AS_UNSPECIFIED
= 0,
74 /* Zebra Gracaful Restart states */
80 /* Typedef BGP specific types. */
81 typedef uint32_t as_t
;
82 typedef uint16_t as16_t
; /* we may still encounter 16 Bit asnums */
83 typedef uint16_t bgp_size_t
;
87 BGP_AF_IPV4_UNICAST
= BGP_AF_START
,
88 BGP_AF_IPV4_MULTICAST
,
91 BGP_AF_IPV6_MULTICAST
,
96 BGP_AF_IPV4_LBL_UNICAST
,
97 BGP_AF_IPV6_LBL_UNICAST
,
103 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
105 #define FOREACH_SAFI(safi) \
106 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
108 extern struct frr_pthread
*bgp_pth_io
;
109 extern struct frr_pthread
*bgp_pth_ka
;
111 /* BGP master for system wide configurations and variables. */
113 /* BGP instance list. */
116 /* BGP thread master. */
117 struct thread_master
*master
;
119 /* Listening sockets */
120 struct list
*listen_sockets
;
122 /* BGP port number. */
125 /* Listener addresses */
126 struct list
*addresses
;
129 struct hash
*self_mac_hash
;
131 /* BGP start time. */
134 /* Various BGP global configuration. */
137 #define BGP_OPT_NO_FIB (1 << 0)
138 #define BGP_OPT_NO_LISTEN (1 << 1)
139 #define BGP_OPT_NO_ZEBRA (1 << 2)
141 uint64_t updgrp_idspace
;
142 uint64_t subgrp_idspace
;
144 /* timer to dampen route map changes */
145 struct thread
*t_rmap_update
; /* Handle route map updates */
146 uint32_t rmap_update_timer
; /* Route map update timer */
147 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
149 /* Id space for automatic RD derivation for an EVI/VRF */
150 bitfield_t rd_idspace
;
152 /* dynamic mpls label allocation pool */
153 struct labelpool labelpool
;
155 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
156 struct bgp
* bgp_evpn
;
158 /* How big should we set the socket buffer size */
159 uint32_t socket_buffer
;
161 /* Should we do wait for fib install globally? */
164 /* EVPN multihoming */
165 struct bgp_evpn_mh_info
*mh_info
;
167 /* global update-delay timer values */
168 uint16_t v_update_delay
;
169 uint16_t v_establish_wait
;
172 #define BM_FLAG_GRACEFUL_SHUTDOWN (1 << 0)
173 #define BM_FLAG_SEND_EXTRA_DATA_TO_ZEBRA (1 << 1)
175 bool terminating
; /* global flag that sigint terminate seen */
177 /* DSCP value for TCP sessions */
180 #define BM_DEFAULT_INQ_LIMIT 10000
185 DECLARE_QOBJ_TYPE(bgp_master
);
187 /* BGP route-map structure. */
190 struct route_map
*map
;
194 unsigned short instance
;
196 /* BGP redistribute metric configuration. */
197 uint8_t redist_metric_flag
;
198 uint32_t redist_metric
;
200 /* BGP redistribute route-map. */
201 struct bgp_rmap rmap
;
204 struct bgp_orr_igp_metric
{
205 struct prefix prefix
;
209 struct bgp_orr_group
{
210 /* Name of this ORR group */
213 /* Address Family Identifiers */
220 /* Root Routers of the group */
221 struct peer
*primary
;
222 struct peer
*secondary
;
223 struct peer
*tertiary
;
225 /* Active Root Router of the group */
228 /* RR clients belong to this group */
229 struct list
*rr_client_list
;
231 /* IGP metric data from active root */
232 struct list
*igp_metric_info
;
234 /* Route table calculated from active root for this group */
235 struct bgp_table
*route_table
;
238 enum vpn_policy_direction
{
239 BGP_VPN_POLICY_DIR_FROMVPN
= 0,
240 BGP_VPN_POLICY_DIR_TOVPN
= 1,
241 BGP_VPN_POLICY_DIR_MAX
= 2
245 struct bgp
*bgp
; /* parent */
247 struct ecommunity
*rtlist
[BGP_VPN_POLICY_DIR_MAX
];
248 struct ecommunity
*import_redirect_rtlist
;
249 char *rmap_name
[BGP_VPN_POLICY_DIR_MAX
];
250 struct route_map
*rmap
[BGP_VPN_POLICY_DIR_MAX
];
252 /* should be mpls_label_t? */
253 uint32_t tovpn_label
; /* may be MPLS_LABEL_NONE */
254 uint32_t tovpn_zebra_vrf_label_last_sent
;
255 struct prefix_rd tovpn_rd
;
256 struct prefix tovpn_nexthop
; /* unset => set to 0 */
258 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
259 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
260 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
261 #define BGP_VPN_POLICY_TOVPN_SID_AUTO (1 << 3)
264 * If we are importing another vrf into us keep a list of
265 * vrf names that are being imported into us.
267 struct list
*import_vrf
;
270 * if we are being exported to another vrf keep a list of
271 * vrf names that we are being exported to.
273 struct list
*export_vrf
;
276 * Segment-Routing SRv6 Mode
278 uint32_t tovpn_sid_index
; /* unset => set to 0 */
279 struct in6_addr
*tovpn_sid
;
280 struct srv6_locator_chunk
*tovpn_sid_locator
;
281 uint32_t tovpn_sid_transpose_label
;
282 struct in6_addr
*tovpn_zebra_vrf_sid_last_sent
;
286 * Type of 'struct bgp'.
287 * - Default: The default instance
288 * - VRF: A specific (non-default) VRF
289 * - View: An instance used for route exchange
290 * The "default" instance is treated separately to simplify the code. Note
291 * that if deployed in a Multi-VRF environment, it may not exist.
293 enum bgp_instance_type
{
294 BGP_INSTANCE_TYPE_DEFAULT
,
295 BGP_INSTANCE_TYPE_VRF
,
296 BGP_INSTANCE_TYPE_VIEW
299 #define BGP_SEND_EOR(bgp, afi, safi) \
300 (!CHECK_FLAG(bgp->flags, BGP_FLAG_GR_DISABLE_EOR) \
301 && ((bgp->gr_info[afi][safi].t_select_deferral == NULL) \
302 || (bgp->gr_info[afi][safi].eor_required \
303 == bgp->gr_info[afi][safi].eor_received)))
305 /* BGP GR Global ds */
307 #define BGP_GLOBAL_GR_MODE 4
308 #define BGP_GLOBAL_GR_EVENT_CMD 4
310 /* Graceful restart selection deferral timer info */
311 struct graceful_restart_info
{
312 /* Count of EOR message expected */
313 uint32_t eor_required
;
314 /* Count of EOR received */
315 uint32_t eor_received
;
317 struct thread
*t_select_deferral
;
318 /* Routes Deferred */
319 uint32_t gr_deferred
;
320 /* Best route select */
321 struct thread
*t_route_select
;
322 /* AFI, SAFI enabled */
323 bool af_enabled
[AFI_MAX
][SAFI_MAX
];
324 /* Route update completed */
325 bool route_sync
[AFI_MAX
][SAFI_MAX
];
329 GLOBAL_HELPER
= 0, /* This is the default mode */
335 enum global_gr_command
{
339 NO_GLOBAL_DISABLE_CMD
342 #define BGP_GR_SUCCESS 0
343 #define BGP_GR_FAILURE 1
345 /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
346 * do weighted ECMP. Note: This applies after multipath computation.
348 enum bgp_link_bw_handling
{
349 /* Do ECMP if some paths don't have LB - default */
351 /* Completely ignore LB, just do regular ECMP */
352 BGP_LINK_BW_IGNORE_BW
,
353 /* Skip paths without LB, do wECMP on others */
354 BGP_LINK_BW_SKIP_MISSING
,
355 /* Do wECMP with default weight for paths not having LB */
356 BGP_LINK_BW_DEFWT_4_MISSING
359 RB_HEAD(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
);
360 RB_PROTOTYPE(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
, rb_node
, bgp_es_vrf_rb_cmp
);
362 struct bgp_snmp_stats
{
363 /* SNMP variables for mplsL3Vpn*/
364 time_t creation_time
;
367 uint32_t routes_added
;
368 uint32_t routes_deleted
;
371 struct bgp_srv6_function
{
373 char locator_name
[SRV6_LOCNAME_SIZE
];
376 /* BGP instance structure. */
378 /* AS number of this BGP instance. */
381 /* Name of this BGP instance. */
383 char *name_pretty
; /* printable "VRF|VIEW name|default" */
385 /* Type of instance and VRF id. */
386 enum bgp_instance_type inst_type
;
389 /* Reference count to allow peer_delete to finish after bgp_delete */
393 struct peer
*peer_self
;
397 struct hash
*peerhash
;
399 /* BGP peer group. */
402 /* The maximum number of BGP dynamic neighbors that can be created */
403 int dynamic_neighbors_limit
;
405 /* The current number of BGP dynamic neighbors */
406 int dynamic_neighbors_count
;
408 struct hash
*update_groups
[BGP_AF_MAX
];
411 * Global statistics for update groups.
414 uint32_t join_events
;
415 uint32_t prune_events
;
416 uint32_t merge_events
;
417 uint32_t split_events
;
418 uint32_t updgrp_switch_events
;
419 uint32_t peer_refreshes_combined
;
421 uint32_t merge_checks_triggered
;
423 uint32_t updgrps_created
;
424 uint32_t updgrps_deleted
;
425 uint32_t subgrps_created
;
426 uint32_t subgrps_deleted
;
427 } update_group_stats
;
429 struct bgp_snmp_stats
*snmp_stats
;
431 /* BGP configuration. */
433 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
434 #define BGP_CONFIG_CONFEDERATION (1 << 1)
436 /* BGP router identifier. */
437 struct in_addr router_id
;
438 struct in_addr router_id_static
;
439 struct in_addr router_id_zebra
;
441 /* BGP route reflector cluster ID. */
442 struct in_addr cluster_id
;
444 /* BGP confederation information. */
447 int confed_peers_cnt
;
450 *t_startup
; /* start-up timer on only once at the beginning */
452 uint32_t v_maxmed_onstartup
; /* Duration of max-med on start-up */
453 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
454 uint32_t maxmed_onstartup_value
; /* Max-med value when active on
457 *t_maxmed_onstartup
; /* non-null when max-med onstartup is on */
458 uint8_t maxmed_onstartup_over
; /* Flag to make it effective only once */
460 bool v_maxmed_admin
; /* true/false if max-med administrative is on/off
462 #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
463 uint32_t maxmed_admin_value
; /* Max-med value when administrative in on
465 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
467 uint8_t maxmed_active
; /* 1/0 if max-med is active or not */
468 uint32_t maxmed_value
; /* Max-med value when its active */
470 /* BGP update delay on startup */
471 struct thread
*t_update_delay
;
472 struct thread
*t_establish_wait
;
473 struct thread
*t_revalidate
[AFI_MAX
][SAFI_MAX
];
475 uint8_t update_delay_over
;
476 uint8_t main_zebra_update_hold
;
477 uint8_t main_peers_update_hold
;
478 uint16_t v_update_delay
;
479 uint16_t v_establish_wait
;
480 char update_delay_begin_time
[64];
481 char update_delay_end_time
[64];
482 char update_delay_zebra_resume_time
[64];
483 char update_delay_peers_resume_time
[64];
484 uint32_t established
;
485 uint32_t restarted_peers
;
486 uint32_t implicit_eors
;
487 uint32_t explicit_eors
;
488 #define BGP_UPDATE_DELAY_DEF 0
489 #define BGP_UPDATE_DELAY_MIN 0
490 #define BGP_UPDATE_DELAY_MAX 3600
492 /* Reference bandwidth for BGP link-bandwidth. Used when
493 * the LB value has to be computed based on some other
494 * factor (e.g., number of multipaths for the prefix)
498 #define BGP_LINK_BW_REF_BW 1
502 #define BGP_FLAG_ALWAYS_COMPARE_MED (1ULL << 0)
503 #define BGP_FLAG_DETERMINISTIC_MED (1ULL << 1)
504 #define BGP_FLAG_MED_MISSING_AS_WORST (1ULL << 2)
505 #define BGP_FLAG_MED_CONFED (1ULL << 3)
506 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1ULL << 4)
507 #define BGP_FLAG_COMPARE_ROUTER_ID (1ULL << 5)
508 #define BGP_FLAG_ASPATH_IGNORE (1ULL << 6)
509 #define BGP_FLAG_IMPORT_CHECK (1ULL << 7)
510 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1ULL << 8)
511 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1ULL << 9)
513 /* This flag is set when we have full BGP Graceful-Restart mode enable */
514 #define BGP_FLAG_GRACEFUL_RESTART (1ULL << 10)
516 #define BGP_FLAG_ASPATH_CONFED (1ULL << 11)
517 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1ULL << 12)
518 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1ULL << 13)
519 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1ULL << 14)
520 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1ULL << 15)
521 #define BGP_FLAG_FORCE_STATIC_PROCESS (1ULL << 16)
522 #define BGP_FLAG_SHOW_HOSTNAME (1ULL << 17)
523 #define BGP_FLAG_GR_PRESERVE_FWD (1ULL << 18)
524 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1ULL << 19)
525 #define BGP_FLAG_DELETE_IN_PROGRESS (1ULL << 20)
526 #define BGP_FLAG_SELECT_DEFER_DISABLE (1ULL << 21)
527 #define BGP_FLAG_GR_DISABLE_EOR (1ULL << 22)
528 #define BGP_FLAG_EBGP_REQUIRES_POLICY (1ULL << 23)
529 #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1ULL << 24)
531 /* This flag is set if the instance is in administrative shutdown */
532 #define BGP_FLAG_SHUTDOWN (1ULL << 25)
533 #define BGP_FLAG_SUPPRESS_FIB_PENDING (1ULL << 26)
534 #define BGP_FLAG_SUPPRESS_DUPLICATES (1ULL << 27)
535 #define BGP_FLAG_PEERTYPE_MULTIPATH_RELAX (1ULL << 29)
536 /* Indicate Graceful Restart support for BGP NOTIFICATION messages */
537 #define BGP_FLAG_GRACEFUL_NOTIFICATION (1ULL << 30)
538 /* Send Hard Reset CEASE Notification for 'Administrative Reset' */
539 #define BGP_FLAG_HARD_ADMIN_RESET (1ULL << 31)
540 /* Evaluate the AIGP attribute during the best path selection process */
541 #define BGP_FLAG_COMPARE_AIGP (1ULL << 32)
543 /* BGP default address-families.
544 * New peers inherit enabled afi/safis from bgp instance.
546 uint16_t default_af
[AFI_MAX
][SAFI_MAX
];
548 enum global_mode GLOBAL_GR_FSM
[BGP_GLOBAL_GR_MODE
]
549 [BGP_GLOBAL_GR_EVENT_CMD
];
550 enum global_mode global_gr_present_state
;
552 /* This variable stores the current Graceful Restart state of Zebra
553 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
555 enum zebra_gr_mode present_zebra_gr_state
;
557 /* BGP Per AF flags */
558 uint16_t af_flags
[AFI_MAX
][SAFI_MAX
];
559 #define BGP_CONFIG_DAMPENING (1 << 0)
560 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
561 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST (1 << 1)
562 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST_GW_IP (1 << 2)
563 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST (1 << 3)
564 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST_GW_IP (1 << 4)
565 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 5)
566 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 6)
567 /* import/export between address families */
568 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 7)
569 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 8)
570 /* vrf-route leaking flags */
571 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 9)
572 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 10)
573 /* vpnvx retain flag */
574 #define BGP_VPNVX_RETAIN_ROUTE_TARGET_ALL (1 << 11)
576 /* BGP per AF peer count */
577 uint32_t af_peer_count
[AFI_MAX
][SAFI_MAX
];
579 /* Tree for next-hop lookup cache. */
580 struct bgp_nexthop_cache_head nexthop_cache_table
[AFI_MAX
];
582 /* Tree for import-check */
583 struct bgp_nexthop_cache_head import_check_table
[AFI_MAX
];
585 struct bgp_table
*connected_table
[AFI_MAX
];
587 struct hash
*address_hash
;
589 /* DB for all local tunnel-ips - used mainly for martian checks
590 Currently it only has all VxLan tunnel IPs*/
591 struct hash
*tip_hash
;
593 /* Static route configuration. */
594 struct bgp_table
*route
[AFI_MAX
][SAFI_MAX
];
596 /* Aggregate address configuration. */
597 struct bgp_table
*aggregate
[AFI_MAX
][SAFI_MAX
];
599 /* BGP routing information base. */
600 struct bgp_table
*rib
[AFI_MAX
][SAFI_MAX
];
602 /* BGP table route-map. */
603 struct bgp_rmap table_map
[AFI_MAX
][SAFI_MAX
];
605 /* BGP redistribute configuration. */
606 struct list
*redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
608 /* Allocate MPLS labels */
609 uint8_t allocate_mpls_labels
[AFI_MAX
][SAFI_MAX
];
611 /* Allocate hash entries to store policy routing information
612 * The hash are used to host pbr rules somewhere.
613 * Actually, pbr will only be used by flowspec
614 * those hash elements will have relationship together as
615 * illustrated in below diagram:
617 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
618 * <----- pbr_match j <--- pbr_match_entry 1..m
621 * - here in BGP structure, the list of match and actions will
622 * stand for the list of ipset sets, and table_ids in the kernel
623 * - the arrow above between pbr_match and pbr_action indicate
624 * that a backpointer permits match to find the action
625 * - the arrow betwen match_entry and match is a hash list
626 * contained in match, that lists the whole set of entries
628 struct hash
*pbr_match_hash
;
629 struct hash
*pbr_rule_hash
;
630 struct hash
*pbr_action_hash
;
632 /* timer to re-evaluate neighbor default-originate route-maps */
633 struct thread
*t_rmap_def_originate_eval
;
634 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
636 /* BGP distance configuration. */
637 uint8_t distance_ebgp
[AFI_MAX
][SAFI_MAX
];
638 uint8_t distance_ibgp
[AFI_MAX
][SAFI_MAX
];
639 uint8_t distance_local
[AFI_MAX
][SAFI_MAX
];
641 /* BGP default local-preference. */
642 uint32_t default_local_pref
;
644 /* BGP default subgroup pkt queue max */
645 uint32_t default_subgroup_pkt_queue_max
;
647 /* BGP default timer. */
648 uint32_t default_holdtime
;
649 uint32_t default_keepalive
;
650 uint32_t default_connect_retry
;
651 uint32_t default_delayopen
;
653 /* BGP minimum holdtime. */
654 uint16_t default_min_holdtime
;
656 /* BGP graceful restart */
657 uint32_t restart_time
;
658 uint32_t stalepath_time
;
659 uint32_t select_defer_time
;
660 struct graceful_restart_info gr_info
[AFI_MAX
][SAFI_MAX
];
661 uint32_t rib_stale_time
;
663 /* BGP Long-lived Graceful Restart */
664 uint32_t llgr_stale_time
;
666 #define BGP_ROUTE_SELECT_DELAY 1
667 #define BGP_MAX_BEST_ROUTE_SELECT 10000
668 /* Maximum-paths configuration */
669 struct bgp_maxpaths_cfg
{
670 uint16_t maxpaths_ebgp
;
671 uint16_t maxpaths_ibgp
;
672 bool same_clusterlen
;
673 } maxpaths
[AFI_MAX
][SAFI_MAX
];
675 _Atomic
uint32_t wpkt_quanta
; // max # packets to write per i/o cycle
676 _Atomic
uint32_t rpkt_quanta
; // max # packets to read per i/o cycle
678 /* Automatic coalesce adjust on/off */
679 bool heuristic_coalesce
;
680 /* Actual coalesce time */
681 uint32_t coalesce_time
;
683 /* Auto-shutdown new peers */
686 struct bgp_addpath_bgp_data tx_addpath
;
688 #ifdef ENABLE_BGP_VNC
689 struct rfapi_cfg
*rfapi_cfg
;
693 /* EVPN related information */
696 struct hash
*vnihash
;
699 * VNI hash table based on SVI ifindex as its key.
700 * We use SVI ifindex as key to lookup a VNI table for gateway IP
701 * overlay index recursive lookup.
702 * For this purpose, a hashtable is added which optimizes this lookup.
704 struct hash
*vni_svi_hash
;
706 /* EVPN enable - advertise gateway macip routes */
707 int advertise_gw_macip
;
709 /* EVPN enable - advertise local VNIs and their MACs etc. */
710 int advertise_all_vni
;
712 /* draft-ietf-idr-deprecate-as-set-confed-set
713 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
717 struct bgp_evpn_info
*evpn_info
;
719 /* EVPN - use RFC 8365 to auto-derive RT */
720 int advertise_autort_rfc8365
;
723 * Flooding mechanism for BUM packets for VxLAN-EVPN.
725 enum vxlan_flood_control vxlan_flood_ctrl
;
727 /* Hash table of Import RTs to EVIs */
728 struct hash
*import_rt_hash
;
730 /* Hash table of VRF import RTs to VRFs */
731 struct hash
*vrf_import_rt_hash
;
733 /* L3-VNI corresponding to this vrf */
736 /* router-mac to be used in mac-ip routes for this vrf */
739 /* originator ip - to be used as NH for type-5 routes */
740 struct in_addr originator_ip
;
742 /* SVI associated with the L3-VNI corresponding to this vrf */
743 ifindex_t l3vni_svi_ifindex
;
745 /* RB tree of ES-VRFs */
746 struct bgp_es_vrf_rb_head es_vrf_rb_tree
;
748 /* Hash table of EVPN nexthops maintained per-tenant-VRF */
749 struct hash
*evpn_nh_table
;
752 * Flag resolve_overlay_index is used for recursive resolution
753 * procedures for EVPN type-5 route's gateway IP overlay index.
754 * When this flag is set, we build remote-ip-hash for
755 * all L2VNIs and resolve overlay index nexthops using this hash.
756 * Overlay index nexthops remain unresolved if this flag is not set.
758 bool resolve_overlay_index
;
762 #define BGP_VRF_AUTO (1 << 0)
763 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
764 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
765 #define BGP_VRF_IMPORT_AUTO_RT_CFGD (1 << 3) /* retain auto when cfgd */
766 #define BGP_VRF_EXPORT_AUTO_RT_CFGD (1 << 4) /* retain auto when cfgd */
767 #define BGP_VRF_RD_CFGD (1 << 5)
768 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 6)
769 /* per-VRF toVPN SID */
770 #define BGP_VRF_TOVPN_SID_AUTO (1 << 7)
772 /* unique ID for auto derivation of RD for this vrf */
775 /* Automatically derived RD for this VRF */
776 struct prefix_rd vrf_prd_auto
;
778 /* RD for this VRF */
779 struct prefix_rd vrf_prd
;
781 /* import rt list for the vrf instance */
782 struct list
*vrf_import_rtl
;
784 /* export rt list for the vrf instance */
785 struct list
*vrf_export_rtl
;
787 /* list of corresponding l2vnis (struct bgpevpn) */
790 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
791 struct bgp_rmap adv_cmd_rmap
[AFI_MAX
][SAFI_MAX
];
793 struct vpn_policy vpn_policy
[AFI_MAX
];
795 struct bgp_pbr_config
*bgp_pbr_cfg
;
797 /* Count of peers in established state */
798 uint32_t established_peers
;
800 /* Weighted ECMP related config. */
801 enum bgp_link_bw_handling lb_handling
;
803 /* Process Queue for handling routes */
804 struct work_queue
*process_queue
;
806 bool fast_convergence
;
808 /* BGP Conditional advertisement */
809 uint32_t condition_check_period
;
810 uint32_t condition_filter_count
;
811 struct thread
*t_condition_check
;
813 /* BGP VPN SRv6 backend */
815 char srv6_locator_name
[SRV6_LOCNAME_SIZE
];
816 struct list
*srv6_locator_chunks
;
817 struct list
*srv6_functions
;
818 uint32_t tovpn_sid_index
; /* unset => set to 0 */
819 struct in6_addr
*tovpn_sid
;
820 struct srv6_locator_chunk
*tovpn_sid_locator
;
821 uint32_t tovpn_sid_transpose_label
;
822 struct in6_addr
*tovpn_zebra_vrf_sid_last_sent
;
824 /* TCP keepalive parameters for BGP connection */
825 uint16_t tcp_keepalive_idle
;
826 uint16_t tcp_keepalive_intvl
;
827 uint16_t tcp_keepalive_probes
;
829 struct timeval ebgprequirespolicywarning
;
830 #define FIFTEENMINUTE2USEC (int64_t)15 * 60 * 1000000
834 /* BGP optimal route reflection group and Root Router configuration */
835 uint32_t orr_group_count
;
836 struct list
*orr_group
[AFI_MAX
][SAFI_MAX
];
840 DECLARE_QOBJ_TYPE(bgp
);
842 struct bgp_interface
{
843 #define BGP_INTERFACE_MPLS_BGP_FORWARDING (1 << 0)
847 DECLARE_HOOK(bgp_inst_delete
, (struct bgp
*bgp
), (bgp
));
848 DECLARE_HOOK(bgp_inst_config_write
,
849 (struct bgp
*bgp
, struct vty
*vty
),
851 DECLARE_HOOK(bgp_config_end
, (struct bgp
*bgp
), (bgp
));
853 /* Thread callback information */
854 struct afi_safi_info
{
860 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
862 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
863 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
864 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
865 && bgp->vrf_id != VRF_UNKNOWN))
867 #define BGP_SELECT_DEFER_DISABLE(bgp) \
868 (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
870 #define BGP_SUPPRESS_FIB_ENABLED(bgp) \
871 (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING) \
874 /* BGP peer-group support. */
876 /* Name of the peer-group. */
879 /* Pointer to BGP. */
882 /* Peer-group client list. */
885 /** Dynamic neighbor listening ranges */
886 struct list
*listen_range
[AFI_MAX
];
888 /* Peer-group config */
892 /* BGP Notify message format. */
902 /* Next hop self address. */
904 struct interface
*ifp
;
906 struct in6_addr v6_global
;
907 struct in6_addr v6_local
;
910 /* BGP addpath values */
911 #define BGP_ADDPATH_RX 1
912 #define BGP_ADDPATH_TX 2
913 #define BGP_ADDPATH_ID_LEN 4
915 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
917 /* Route map direction */
922 #define BGP_DEFAULT_TTL 1
923 #define BGP_GTSM_HOPS_DISABLED 0
924 #define BGP_GTSM_HOPS_CONNECTED 1
927 #define CONDITION_NON_EXIST false
928 #define CONDITION_EXIST true
930 enum update_type
{ UPDATE_TYPE_WITHDRAW
, UPDATE_TYPE_ADVERTISE
};
934 /* BGP filter structure. */
936 /* Distribute-list. */
939 struct access_list
*alist
;
945 struct prefix_list
*plist
;
951 struct as_list
*aslist
;
952 } aslist
[FILTER_MAX
];
957 struct route_map
*map
;
960 /* Unsuppress-map. */
963 struct route_map
*map
;
969 struct route_map
*amap
;
974 struct route_map
*cmap
;
976 enum update_type update_type
;
980 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
981 a peer who's AS is part of our Confederation. */
983 BGP_PEER_UNSPECIFIED
,
990 /* BGP message header and packet size. */
991 #define BGP_MARKER_SIZE 16
992 #define BGP_HEADER_SIZE 19
993 #define BGP_STANDARD_MESSAGE_MAX_PACKET_SIZE 4096
994 #define BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE 65535
995 #define BGP_MAX_PACKET_SIZE BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
996 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
999 * Trigger delay for bgp_announce_route().
1001 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
1002 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
1005 /* back pointer to the peer */
1008 /* which subgroup the peer_af belongs to */
1009 struct update_subgroup
*subgroup
;
1011 /* for being part of an update subgroup's peer list */
1012 LIST_ENTRY(peer_af
) subgrp_train
;
1014 /* for being part of a packet's peer list */
1015 LIST_ENTRY(peer_af
) pkt_train
;
1017 struct bpacket
*next_pkt_to_send
;
1020 * Trigger timer for bgp_announce_route().
1022 struct thread
*t_announce_route
;
1028 /* BGP GR per peer ds */
1030 #define BGP_PEER_GR_MODE 5
1031 #define BGP_PEER_GR_EVENT_CMD 6
1038 PEER_GLOBAL_INHERIT
/* This is the default mode */
1042 enum peer_gr_command
{
1046 NO_PEER_DISABLE_CMD
,
1051 typedef unsigned int (*bgp_peer_gr_action_ptr
)(struct peer
*, int, int);
1053 struct bgp_peer_gr
{
1054 enum peer_mode next_state
;
1055 bgp_peer_gr_action_ptr action_fun
;
1059 * BGP FSM event codes, per RFC 4271 ss. 8.1
1061 enum bgp_fsm_rfc_codes
{
1062 BGP_FSM_ManualStart
= 1,
1063 BGP_FSM_ManualStop
= 2,
1064 BGP_FSM_AutomaticStart
= 3,
1065 BGP_FSM_ManualStart_with_PassiveTcpEstablishment
= 4,
1066 BGP_FSM_AutomaticStart_with_PassiveTcpEstablishment
= 5,
1067 BGP_FSM_AutomaticStart_with_DampPeerOscillations
= 6,
1068 BGP_FSM_AutomaticStart_with_DampPeerOscillations_and_PassiveTcpEstablishment
=
1070 BGP_FSM_AutomaticStop
= 8,
1071 BGP_FSM_ConnectRetryTimer_Expires
= 9,
1072 BGP_FSM_HoldTimer_Expires
= 10,
1073 BGP_FSM_KeepaliveTimer_Expires
= 11,
1074 BGP_FSM_DelayOpenTimer_Expires
= 12,
1075 BGP_FSM_IdleHoldTimer_Expires
= 13,
1076 BGP_FSM_TcpConnection_Valid
= 14,
1077 BGP_FSM_Tcp_CR_Invalid
= 15,
1078 BGP_FSM_Tcp_CR_Acked
= 16,
1079 BGP_FSM_TcpConnectionConfirmed
= 17,
1080 BGP_FSM_TcpConnectionFails
= 18,
1081 BGP_FSM_BGPOpen
= 19,
1082 BGP_FSM_BGPOpen_with_DelayOpenTimer_running
= 20,
1083 BGP_FSM_BGPHeaderErr
= 21,
1084 BGP_FSM_BGPOpenMsgErr
= 22,
1085 BGP_FSM_OpenCollisionDump
= 23,
1086 BGP_FSM_NotifMsgVerErr
= 24,
1087 BGP_FSM_NotifMsg
= 25,
1088 BGP_FSM_KeepAliveMsg
= 26,
1089 BGP_FSM_UpdateMsg
= 27,
1090 BGP_FSM_UpdateMsgErr
= 28
1094 * BGP finite state machine events
1096 * Note: these do not correspond to RFC-defined event codes. Those are
1097 * defined elsewhere.
1099 enum bgp_fsm_events
{
1102 TCP_connection_open
,
1103 TCP_connection_open_w_delay
,
1104 TCP_connection_closed
,
1105 TCP_connection_open_failed
,
1107 ConnectRetry_timer_expired
,
1109 KeepAlive_timer_expired
,
1110 DelayOpen_timer_expired
,
1111 Receive_OPEN_message
,
1112 Receive_KEEPALIVE_message
,
1113 Receive_UPDATE_message
,
1114 Receive_NOTIFICATION_message
,
1119 /* BGP finite state machine status. */
1120 enum bgp_fsm_status
{
1132 #define PEER_HOSTNAME(peer) ((peer)->host ? (peer)->host : "(unknown peer)")
1135 uint32_t stale_time
;
1139 /* BGP neighbor structure. */
1141 /* BGP structure. */
1144 /* reference count, primarily to allow bgp_process'ing of route_node's
1145 * to be done after a struct peer is deleted.
1147 * named 'lock' for hysterical reasons within Quagga.
1151 /* BGP peer group. */
1152 struct peer_group
*group
;
1153 uint64_t version
[AFI_MAX
][SAFI_MAX
];
1155 /* BGP peer_af structures, per configured AF on this peer */
1156 struct peer_af
*peer_af_array
[BGP_AF_MAX
];
1158 /* Peer's remote AS number. */
1162 /* Peer's local AS number. */
1165 enum bgp_peer_sort sort
;
1167 /* Peer's Change local AS number. */
1168 as_t change_local_as
;
1170 /* Remote router ID. */
1171 struct in_addr remote_id
;
1173 /* Local router ID. */
1174 struct in_addr local_id
;
1176 /* Packet receive and send buffer. */
1177 pthread_mutex_t io_mtx
; // guards ibuf, obuf
1178 struct stream_fifo
*ibuf
; // packets waiting to be processed
1179 struct stream_fifo
*obuf
; // packets waiting to be written
1181 /* used as a block to deposit raw wire data to */
1182 uint8_t ibuf_scratch
[BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
1183 * BGP_READ_PACKET_MAX
];
1184 struct ringbuf
*ibuf_work
; // WiP buffer used by bgp_read() only
1185 struct stream
*obuf_work
; // WiP buffer used to construct packets
1187 struct stream
*curr
; // the current packet being parsed
1189 /* We use a separate stream to encode MP_REACH_NLRI for efficient
1190 * NLRI packing. peer->obuf_work stores all the other attributes. The
1191 * actual packet is then constructed by concatenating the two.
1193 struct stream
*scratch
;
1195 /* the doppelganger peer structure, due to dual TCP conn setup */
1196 struct peer
*doppelganger
;
1198 /* Status of the peer. */
1199 enum bgp_fsm_status status
;
1200 enum bgp_fsm_status ostatus
;
1202 /* FSM events, stored for debug purposes.
1203 * Note: uchar used for reduced memory usage.
1205 enum bgp_fsm_events cur_event
;
1206 enum bgp_fsm_events last_event
;
1207 enum bgp_fsm_events last_major_event
;
1209 /* Peer index, used for dumping TABLE_DUMP_V2 format */
1210 uint16_t table_dump_index
;
1212 /* Peer information */
1213 int fd
; /* File descriptor */
1214 int ttl
; /* TTL of TCP connection to the peer. */
1215 int rtt
; /* Estimated round-trip-time from TCP_INFO */
1216 int rtt_expected
; /* Expected round-trip-time for a peer */
1217 uint8_t rtt_keepalive_rcv
; /* Received count for RTT shutdown */
1218 uint8_t rtt_keepalive_conf
; /* Configured count for RTT shutdown */
1219 int gtsm_hops
; /* minimum hopcount to peer */
1220 char *desc
; /* Description of the peer. */
1221 unsigned short port
; /* Destination port for peer */
1222 char *host
; /* Printable address of the peer. */
1223 union sockunion su
; /* Sockunion address of the peer. */
1224 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
1225 time_t uptime
; /* Last Up/Down time */
1226 time_t readtime
; /* Last read time */
1227 time_t resettime
; /* Last reset time */
1229 char *conf_if
; /* neighbor interface config name. */
1230 struct interface
*ifp
; /* corresponding interface */
1231 char *ifname
; /* bind interface name. */
1233 union sockunion
*update_source
;
1235 union sockunion
*su_local
; /* Sockunion of local address. */
1236 union sockunion
*su_remote
; /* Sockunion of remote address. */
1237 int shared_network
; /* Is this peer shared same network. */
1238 struct bgp_nexthop nexthop
; /* Nexthop */
1240 /* Roles in bgp session */
1242 uint8_t remote_role
;
1243 #define ROLE_PROVIDER 0
1244 #define ROLE_RS_SERVER 1
1245 #define ROLE_RS_CLIENT 2
1246 #define ROLE_CUSTOMER 3
1248 #define ROLE_UNDEFINED 255
1250 #define ROLE_NAME_MAX_LEN 20
1252 /* Peer address family configuration. */
1253 uint8_t afc
[AFI_MAX
][SAFI_MAX
];
1254 uint8_t afc_nego
[AFI_MAX
][SAFI_MAX
];
1255 uint8_t afc_adv
[AFI_MAX
][SAFI_MAX
];
1256 uint8_t afc_recv
[AFI_MAX
][SAFI_MAX
];
1258 /* Capability flags (reset in bgp_stop) */
1260 #define PEER_CAP_REFRESH_ADV (1U << 0) /* refresh advertised */
1261 #define PEER_CAP_REFRESH_OLD_RCV (1U << 1) /* refresh old received */
1262 #define PEER_CAP_REFRESH_NEW_RCV (1U << 2) /* refresh rfc received */
1263 #define PEER_CAP_DYNAMIC_ADV (1U << 3) /* dynamic advertised */
1264 #define PEER_CAP_DYNAMIC_RCV (1U << 4) /* dynamic received */
1265 #define PEER_CAP_RESTART_ADV (1U << 5) /* restart advertised */
1266 #define PEER_CAP_RESTART_RCV (1U << 6) /* restart received */
1267 #define PEER_CAP_AS4_ADV (1U << 7) /* as4 advertised */
1268 #define PEER_CAP_AS4_RCV (1U << 8) /* as4 received */
1269 /* sent graceful-restart restart (R) bit */
1270 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_ADV (1U << 9)
1271 /* received graceful-restart restart (R) bit */
1272 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_RCV (1U << 10)
1273 #define PEER_CAP_ADDPATH_ADV (1U << 11) /* addpath advertised */
1274 #define PEER_CAP_ADDPATH_RCV (1U << 12) /* addpath received */
1275 #define PEER_CAP_ENHE_ADV (1U << 13) /* Extended nexthop advertised */
1276 #define PEER_CAP_ENHE_RCV (1U << 14) /* Extended nexthop received */
1277 #define PEER_CAP_HOSTNAME_ADV (1U << 15) /* hostname advertised */
1278 #define PEER_CAP_HOSTNAME_RCV (1U << 16) /* hostname received */
1279 #define PEER_CAP_ENHANCED_RR_ADV (1U << 17) /* enhanced rr advertised */
1280 #define PEER_CAP_ENHANCED_RR_RCV (1U << 18) /* enhanced rr received */
1281 #define PEER_CAP_EXTENDED_MESSAGE_ADV (1U << 19)
1282 #define PEER_CAP_EXTENDED_MESSAGE_RCV (1U << 20)
1283 #define PEER_CAP_LLGR_ADV (1U << 21)
1284 #define PEER_CAP_LLGR_RCV (1U << 22)
1285 /* sent graceful-restart notification (N) bit */
1286 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_ADV (1U << 23)
1287 /* received graceful-restart notification (N) bit */
1288 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_RCV (1U << 24)
1289 #define PEER_CAP_ROLE_ADV (1U << 25) /* role advertised */
1290 #define PEER_CAP_ROLE_RCV (1U << 26) /* role received */
1292 /* Capability flags (reset in bgp_stop) */
1293 uint32_t af_cap
[AFI_MAX
][SAFI_MAX
];
1294 #define PEER_CAP_ORF_PREFIX_SM_ADV (1U << 0) /* send-mode advertised */
1295 #define PEER_CAP_ORF_PREFIX_RM_ADV (1U << 1) /* receive-mode advertised */
1296 #define PEER_CAP_ORF_PREFIX_SM_RCV (1U << 2) /* send-mode received */
1297 #define PEER_CAP_ORF_PREFIX_RM_RCV (1U << 3) /* receive-mode received */
1298 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1U << 4) /* send-mode received */
1299 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1U << 5) /* receive-mode received */
1300 #define PEER_CAP_RESTART_AF_RCV (1U << 6) /* graceful restart afi/safi received */
1301 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1U << 7) /* graceful restart afi/safi F-bit received */
1302 #define PEER_CAP_ADDPATH_AF_TX_ADV (1U << 8) /* addpath tx advertised */
1303 #define PEER_CAP_ADDPATH_AF_TX_RCV (1U << 9) /* addpath tx received */
1304 #define PEER_CAP_ADDPATH_AF_RX_ADV (1U << 10) /* addpath rx advertised */
1305 #define PEER_CAP_ADDPATH_AF_RX_RCV (1U << 11) /* addpath rx received */
1306 #define PEER_CAP_ENHE_AF_ADV (1U << 12) /* Extended nexthopi afi/safi advertised */
1307 #define PEER_CAP_ENHE_AF_RCV (1U << 13) /* Extended nexthop afi/safi received */
1308 #define PEER_CAP_ENHE_AF_NEGO (1U << 14) /* Extended nexthop afi/safi negotiated */
1309 #define PEER_CAP_LLGR_AF_ADV (1U << 15)
1310 #define PEER_CAP_LLGR_AF_RCV (1U << 16)
1312 /* Global configuration flags. */
1314 * Parallel array to flags that indicates whether each flag originates
1315 * from a peer-group or if it is config that is specific to this
1316 * individual peer. If a flag is set independent of the peer-group, the
1317 * same bit should be set here. If this peer is a peer-group, this
1318 * memory region should be all zeros.
1320 * The assumption is that the default state for all flags is unset,
1321 * so if a flag is unset, the corresponding override flag is unset too.
1322 * However if a flag is set, the corresponding override flag is set.
1324 uint32_t flags_override
;
1326 * Parallel array to flags that indicates whether the default behavior
1327 * of *flags_override* should be inverted. If a flag is unset and the
1328 * corresponding invert flag is set, the corresponding override flag
1329 * would be set. However if a flag is set and the corresponding invert
1330 * flag is unset, the corresponding override flag would be unset.
1332 * This can be used for attributes like *send-community*, which are
1333 * implicitely enabled and have to be disabled explicitely, compared to
1334 * 'normal' attributes like *next-hop-self* which are implicitely set.
1336 * All operations dealing with flags should apply the following boolean
1337 * logic to keep the internal flag system in a sane state:
1339 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1340 * value=0 invert=1 Unset flag unconditionally
1341 * value=1 invert=0 Set flag unconditionally
1342 * value=1 invert=1 Inherit flag if member, otherwise set flag
1344 * Contrary to the implementation of *flags_override*, the flag
1345 * inversion state can be set either on the peer OR the peer *and* the
1346 * peer-group. This was done on purpose, as the inversion state of a
1347 * flag can be determined on either the peer or the peer-group.
1349 * Example: Enabling the cisco configuration mode inverts all flags
1350 * related to *send-community* unconditionally for both peer-groups and
1353 * This behavior is different for interface peers though, which enable
1354 * the *extended-nexthop* flag by default, which regular peers do not.
1355 * As the peer-group can contain both regular and interface peers, the
1356 * flag inversion state must be set on the peer only.
1358 * When a peer inherits the configuration from a peer-group and the
1359 * inversion state of the flag differs between peer and peer-group, the
1360 * newly set value must equal to the inverted state of the peer-group.
1362 uint32_t flags_invert
;
1364 * Effective array for storing the peer/peer-group flags. In case of a
1365 * peer-group, the peer-specific overrides (see flags_override and
1366 * flags_invert) must be respected.
1369 #define PEER_FLAG_PASSIVE (1ULL << 0) /* passive mode */
1370 #define PEER_FLAG_SHUTDOWN (1ULL << 1) /* shutdown */
1371 #define PEER_FLAG_DONT_CAPABILITY (1ULL << 2) /* dont-capability */
1372 #define PEER_FLAG_OVERRIDE_CAPABILITY (1ULL << 3) /* override-capability */
1373 #define PEER_FLAG_STRICT_CAP_MATCH (1ULL << 4) /* strict-match */
1374 #define PEER_FLAG_DYNAMIC_CAPABILITY (1ULL << 5) /* dynamic capability */
1375 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1ULL << 6) /* disable-connected-check */
1376 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1ULL << 7) /* local-as no-prepend */
1377 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1ULL << 8) /* local-as no-prepend replace-as */
1378 #define PEER_FLAG_DELETE (1ULL << 9) /* mark the peer for deleting */
1379 #define PEER_FLAG_CONFIG_NODE (1ULL << 10) /* the node to update configs on */
1380 #define PEER_FLAG_LONESOUL (1ULL << 11)
1381 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1ULL << 12) /* dynamic neighbor */
1382 #define PEER_FLAG_CAPABILITY_ENHE (1ULL << 13) /* Extended next-hop (rfc 5549)*/
1383 #define PEER_FLAG_IFPEER_V6ONLY (1ULL << 14) /* if-based peer is v6 only */
1384 #define PEER_FLAG_IS_RFAPI_HD (1ULL << 15) /* attached to rfapi HD */
1385 #define PEER_FLAG_ENFORCE_FIRST_AS (1ULL << 16) /* enforce-first-as */
1386 #define PEER_FLAG_ROUTEADV (1ULL << 17) /* route advertise */
1387 #define PEER_FLAG_TIMER (1ULL << 18) /* keepalive & holdtime */
1388 #define PEER_FLAG_TIMER_CONNECT (1ULL << 19) /* connect timer */
1389 #define PEER_FLAG_PASSWORD (1ULL << 20) /* password */
1390 #define PEER_FLAG_LOCAL_AS (1ULL << 21) /* local-as */
1391 #define PEER_FLAG_UPDATE_SOURCE (1ULL << 22) /* update-source */
1393 /* BGP-GR Peer related flags */
1394 #define PEER_FLAG_GRACEFUL_RESTART_HELPER (1ULL << 23) /* Helper */
1395 #define PEER_FLAG_GRACEFUL_RESTART (1ULL << 24) /* Graceful Restart */
1396 #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1ULL << 25) /* Global-Inherit */
1397 #define PEER_FLAG_RTT_SHUTDOWN (1ULL << 26) /* shutdown rtt */
1398 #define PEER_FLAG_TIMER_DELAYOPEN (1ULL << 27) /* delayopen timer */
1399 #define PEER_FLAG_TCP_MSS (1ULL << 28) /* tcp-mss */
1400 /* Disable IEEE floating-point link bandwidth encoding in
1401 * extended communities.
1403 #define PEER_FLAG_DISABLE_LINK_BW_ENCODING_IEEE (1ULL << 29)
1404 /* force the extended format for Optional Parameters in OPEN message */
1405 #define PEER_FLAG_EXTENDED_OPT_PARAMS (1ULL << 30)
1407 /* BGP Open Policy flags.
1408 * Enforce using roles on both sides:
1409 * `local-role ROLE strict-mode` configured.
1411 #define PEER_FLAG_ROLE_STRICT_MODE (1ULL << 31)
1412 /* `local-role` configured */
1413 #define PEER_FLAG_ROLE (1ULL << 32)
1414 #define PEER_FLAG_PORT (1ULL << 33)
1415 #define PEER_FLAG_AIGP (1ULL << 34)
1416 #define PEER_FLAG_GRACEFUL_SHUTDOWN (1ULL << 35)
1419 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1420 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1421 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1424 struct bgp_peer_gr PEER_GR_FSM
[BGP_PEER_GR_MODE
][BGP_PEER_GR_EVENT_CMD
];
1425 enum peer_mode peer_gr_present_state
;
1426 /* Non stop forwarding afi-safi count for BGP gr feature*/
1427 uint8_t nsf_af_count
;
1429 uint8_t peer_gr_new_status_flag
;
1430 #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1U << 0)
1431 #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1U << 1)
1432 #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1U << 2)
1434 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1435 char *tx_shutdown_message
;
1437 /* NSF mode (graceful restart) */
1438 uint8_t nsf
[AFI_MAX
][SAFI_MAX
];
1440 time_t eor_stime
[AFI_MAX
][SAFI_MAX
];
1441 /* Last update packet sent time */
1442 time_t pkt_stime
[AFI_MAX
][SAFI_MAX
];
1444 /* Peer Per AF flags */
1446 * Please consult the comments for *flags_override*, *flags_invert* and
1447 * *flags* to understand what these three arrays do. The address-family
1448 * specific attributes are being treated the exact same way as global
1451 uint64_t af_flags_override
[AFI_MAX
][SAFI_MAX
];
1452 uint64_t af_flags_invert
[AFI_MAX
][SAFI_MAX
];
1453 uint64_t af_flags
[AFI_MAX
][SAFI_MAX
];
1454 #define PEER_FLAG_SEND_COMMUNITY (1ULL << 0)
1455 #define PEER_FLAG_SEND_EXT_COMMUNITY (1ULL << 1)
1456 #define PEER_FLAG_NEXTHOP_SELF (1ULL << 2)
1457 #define PEER_FLAG_REFLECTOR_CLIENT (1ULL << 3)
1458 #define PEER_FLAG_RSERVER_CLIENT (1ULL << 4)
1459 #define PEER_FLAG_SOFT_RECONFIG (1ULL << 5)
1460 #define PEER_FLAG_AS_PATH_UNCHANGED (1ULL << 6)
1461 #define PEER_FLAG_NEXTHOP_UNCHANGED (1ULL << 7)
1462 #define PEER_FLAG_MED_UNCHANGED (1ULL << 8)
1463 #define PEER_FLAG_DEFAULT_ORIGINATE (1ULL << 9)
1464 #define PEER_FLAG_REMOVE_PRIVATE_AS (1ULL << 10)
1465 #define PEER_FLAG_ALLOWAS_IN (1ULL << 11)
1466 #define PEER_FLAG_ORF_PREFIX_SM (1ULL << 12)
1467 #define PEER_FLAG_ORF_PREFIX_RM (1ULL << 13)
1468 #define PEER_FLAG_MAX_PREFIX (1ULL << 14)
1469 #define PEER_FLAG_MAX_PREFIX_WARNING (1ULL << 15)
1470 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1ULL << 16)
1471 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1ULL << 17)
1472 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1ULL << 18)
1473 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1ULL << 19)
1474 #define PEER_FLAG_AS_OVERRIDE (1ULL << 20)
1475 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1ULL << 21)
1476 #define PEER_FLAG_WEIGHT (1ULL << 24)
1477 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1ULL << 25)
1478 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1ULL << 26)
1479 #define PEER_FLAG_MAX_PREFIX_OUT (1ULL << 27)
1480 #define PEER_FLAG_MAX_PREFIX_FORCE (1ULL << 28)
1481 #define PEER_FLAG_DISABLE_ADDPATH_RX (1ULL << 29)
1482 #define PEER_FLAG_SOO (1ULL << 30)
1483 #define PEER_FLAG_ORR_GROUP (1ULL << 31) /* Optimal-Route-Reflection */
1484 #define PEER_FLAG_ACCEPT_OWN (1ULL << 32)
1486 /* BGP Optimal Route Reflection Group name */
1487 char *orr_group_name
[AFI_MAX
][SAFI_MAX
];
1489 enum bgp_addpath_strat addpath_type
[AFI_MAX
][SAFI_MAX
];
1494 /* default-originate route-map. */
1497 struct route_map
*map
;
1498 } default_rmap
[AFI_MAX
][SAFI_MAX
];
1500 /* Peer status flags. */
1502 #define PEER_STATUS_ACCEPT_PEER (1U << 0) /* accept peer */
1503 #define PEER_STATUS_PREFIX_OVERFLOW (1U << 1) /* prefix-overflow */
1504 #define PEER_STATUS_CAPABILITY_OPEN (1U << 2) /* capability open send */
1505 #define PEER_STATUS_HAVE_ACCEPT (1U << 3) /* accept peer's parent */
1506 #define PEER_STATUS_GROUP (1U << 4) /* peer-group conf */
1507 #define PEER_STATUS_NSF_MODE (1U << 5) /* NSF aware peer */
1508 #define PEER_STATUS_NSF_WAIT (1U << 6) /* wait comeback peer */
1509 /* received extended format encoding for OPEN message */
1510 #define PEER_STATUS_EXT_OPT_PARAMS_LENGTH (1U << 7)
1512 /* Peer status af flags (reset in bgp_stop) */
1513 uint16_t af_sflags
[AFI_MAX
][SAFI_MAX
];
1514 #define PEER_STATUS_ORF_PREFIX_SEND (1U << 0) /* prefix-list send peer */
1515 #define PEER_STATUS_ORF_WAIT_REFRESH (1U << 1) /* wait refresh received peer */
1516 #define PEER_STATUS_PREFIX_THRESHOLD (1U << 2) /* exceed prefix-threshold */
1517 #define PEER_STATUS_PREFIX_LIMIT (1U << 3) /* exceed prefix-limit */
1518 #define PEER_STATUS_EOR_SEND (1U << 4) /* end-of-rib send to peer */
1519 #define PEER_STATUS_EOR_RECEIVED (1U << 5) /* end-of-rib received from peer */
1520 #define PEER_STATUS_ENHANCED_REFRESH (1U << 6) /* Enhanced Route Refresh */
1521 #define PEER_STATUS_BORR_SEND (1U << 7) /* BoRR send to peer */
1522 #define PEER_STATUS_BORR_RECEIVED (1U << 8) /* BoRR received from peer */
1523 #define PEER_STATUS_EORR_SEND (1U << 9) /* EoRR send to peer */
1524 #define PEER_STATUS_EORR_RECEIVED (1U << 10) /* EoRR received from peer */
1525 /* LLGR aware peer */
1526 #define PEER_STATUS_LLGR_WAIT (1U << 11)
1527 #define PEER_STATUS_REFRESH_PENDING (1U << 12) /* refresh request from peer */
1528 #define PEER_STATUS_RTT_SHUTDOWN (1U << 13) /* In shutdown state due to RTT */
1530 /* Configured timer values. */
1531 _Atomic
uint32_t holdtime
;
1532 _Atomic
uint32_t keepalive
;
1533 _Atomic
uint32_t connect
;
1534 _Atomic
uint32_t routeadv
;
1535 _Atomic
uint32_t delayopen
;
1538 _Atomic
uint32_t v_start
;
1539 _Atomic
uint32_t v_connect
;
1540 _Atomic
uint32_t v_holdtime
;
1541 _Atomic
uint32_t v_keepalive
;
1542 _Atomic
uint32_t v_routeadv
;
1543 _Atomic
uint32_t v_delayopen
;
1544 _Atomic
uint32_t v_pmax_restart
;
1545 _Atomic
uint32_t v_gr_restart
;
1548 struct thread
*t_read
;
1549 struct thread
*t_write
;
1550 struct thread
*t_start
;
1551 struct thread
*t_connect_check_r
;
1552 struct thread
*t_connect_check_w
;
1553 struct thread
*t_connect
;
1554 struct thread
*t_holdtime
;
1555 struct thread
*t_routeadv
;
1556 struct thread
*t_delayopen
;
1557 struct thread
*t_pmax_restart
;
1558 struct thread
*t_gr_restart
;
1559 struct thread
*t_gr_stale
;
1560 struct thread
*t_llgr_stale
[AFI_MAX
][SAFI_MAX
];
1561 struct thread
*t_revalidate_all
[AFI_MAX
][SAFI_MAX
];
1562 struct thread
*t_generate_updgrp_packets
;
1563 struct thread
*t_process_packet
;
1564 struct thread
*t_process_packet_error
;
1565 struct thread
*t_refresh_stalepath
;
1568 _Atomic
uint32_t thread_flags
;
1569 #define PEER_THREAD_WRITES_ON (1U << 0)
1570 #define PEER_THREAD_READS_ON (1U << 1)
1571 #define PEER_THREAD_KEEPALIVES_ON (1U << 2)
1572 #define PEER_THREAD_SUBGRP_ADV_DELAY (1U << 3)
1575 struct work_queue
*clear_node_queue
;
1577 #define PEER_TOTAL_RX(peer) \
1578 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1579 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1580 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1581 + atomic_load_explicit(&peer->refresh_in, \
1582 memory_order_relaxed) \
1583 + atomic_load_explicit(&peer->keepalive_in, \
1584 memory_order_relaxed) \
1585 + atomic_load_explicit(&peer->dynamic_cap_in, \
1586 memory_order_relaxed)
1588 #define PEER_TOTAL_TX(peer) \
1589 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1590 + atomic_load_explicit(&peer->update_out, \
1591 memory_order_relaxed) \
1592 + atomic_load_explicit(&peer->notify_out, \
1593 memory_order_relaxed) \
1594 + atomic_load_explicit(&peer->refresh_out, \
1595 memory_order_relaxed) \
1596 + atomic_load_explicit(&peer->keepalive_out, \
1597 memory_order_relaxed) \
1598 + atomic_load_explicit(&peer->dynamic_cap_out, \
1599 memory_order_relaxed)
1601 /* Statistics field */
1602 _Atomic
uint32_t open_in
; /* Open message input count */
1603 _Atomic
uint32_t open_out
; /* Open message output count */
1604 _Atomic
uint32_t update_in
; /* Update message input count */
1605 _Atomic
uint32_t update_out
; /* Update message ouput count */
1606 _Atomic
time_t update_time
; /* Update message received time. */
1607 _Atomic
uint32_t keepalive_in
; /* Keepalive input count */
1608 _Atomic
uint32_t keepalive_out
; /* Keepalive output count */
1609 _Atomic
uint32_t notify_in
; /* Notify input count */
1610 _Atomic
uint32_t notify_out
; /* Notify output count */
1611 _Atomic
uint32_t refresh_in
; /* Route Refresh input count */
1612 _Atomic
uint32_t refresh_out
; /* Route Refresh output count */
1613 _Atomic
uint32_t dynamic_cap_in
; /* Dynamic Capability input count. */
1614 _Atomic
uint32_t dynamic_cap_out
; /* Dynamic Capability output count. */
1616 uint32_t stat_pfx_filter
;
1617 uint32_t stat_pfx_aspath_loop
;
1618 uint32_t stat_pfx_originator_loop
;
1619 uint32_t stat_pfx_cluster_loop
;
1620 uint32_t stat_pfx_nh_invalid
;
1621 uint32_t stat_pfx_dup_withdraw
;
1622 uint32_t stat_upd_7606
; /* RFC7606: treat-as-withdraw */
1624 /* BGP state count */
1625 uint32_t established
; /* Established */
1626 uint32_t dropped
; /* Dropped */
1628 /* Update delay related fields */
1629 uint8_t update_delay_over
; /* When this is set, BGP is no more waiting
1632 /* Syncronization list and time. */
1633 struct bgp_synchronize
*sync
[AFI_MAX
][SAFI_MAX
];
1635 /* timestamp when the last UPDATE msg was written */
1636 _Atomic
time_t last_write
;
1637 /* timestamp when the last msg was written */
1638 _Atomic
time_t last_update
;
1640 /* only updated under io_mtx.
1641 * last_sendq_warn is only for ratelimiting log warning messages.
1643 time_t last_sendq_ok
, last_sendq_warn
;
1646 struct bgp_notify notify
;
1648 /* Filter structure. */
1649 struct bgp_filter filter
[AFI_MAX
][SAFI_MAX
];
1652 * Parallel array to filter that indicates whether each filter
1653 * originates from a peer-group or if it is config that is specific to
1654 * this individual peer. If a filter is set independent of the
1655 * peer-group the appropriate bit should be set here. If this peer is a
1656 * peer-group, this memory region should be all zeros. The assumption
1657 * is that the default state for all flags is unset. Due to filters
1658 * having a direction (e.g. in/out/...), this array has a third
1659 * dimension for storing the overrides independently per direction.
1662 * - if a filter for an individual peer is unset, the corresponding
1663 * override flag is unset and the peer is considered to be back in
1664 * sync with the peer-group.
1665 * - This does *not* contain the filter values, rather it contains
1666 * whether the filter in filter (struct bgp_filter) is peer-specific.
1668 uint8_t filter_override
[AFI_MAX
][SAFI_MAX
][FILTER_MAX
];
1669 #define PEER_FT_DISTRIBUTE_LIST (1U << 0) /* distribute-list */
1670 #define PEER_FT_FILTER_LIST (1U << 1) /* filter-list */
1671 #define PEER_FT_PREFIX_LIST (1U << 2) /* prefix-list */
1672 #define PEER_FT_ROUTE_MAP (1U << 3) /* route-map */
1673 #define PEER_FT_UNSUPPRESS_MAP (1U << 4) /* unsuppress-map */
1674 #define PEER_FT_ADVERTISE_MAP (1U << 5) /* advertise-map */
1676 /* ORF Prefix-list */
1677 struct prefix_list
*orf_plist
[AFI_MAX
][SAFI_MAX
];
1679 /* Text description of last attribute rcvd */
1680 char rcvd_attr_str
[BUFSIZ
];
1682 /* Track if we printed the attribute in debugs */
1683 int rcvd_attr_printed
;
1685 /* Accepted prefix count */
1686 uint32_t pcount
[AFI_MAX
][SAFI_MAX
];
1688 /* Max prefix count. */
1689 uint32_t pmax
[AFI_MAX
][SAFI_MAX
];
1690 uint8_t pmax_threshold
[AFI_MAX
][SAFI_MAX
];
1691 uint16_t pmax_restart
[AFI_MAX
][SAFI_MAX
];
1692 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1694 /* Send prefix count. */
1695 uint32_t pmax_out
[AFI_MAX
][SAFI_MAX
];
1698 char allowas_in
[AFI_MAX
][SAFI_MAX
];
1701 struct ecommunity
*soo
[AFI_MAX
][SAFI_MAX
];
1704 unsigned long weight
[AFI_MAX
][SAFI_MAX
];
1706 /* peer reset cause */
1708 #define PEER_DOWN_RID_CHANGE 1U /* bgp router-id command */
1709 #define PEER_DOWN_REMOTE_AS_CHANGE 2U /* neighbor remote-as command */
1710 #define PEER_DOWN_LOCAL_AS_CHANGE 3U /* neighbor local-as command */
1711 #define PEER_DOWN_CLID_CHANGE 4U /* bgp cluster-id command */
1712 #define PEER_DOWN_CONFED_ID_CHANGE 5U /* bgp confederation id command */
1713 #define PEER_DOWN_CONFED_PEER_CHANGE 6U /* bgp confederation peer command */
1714 #define PEER_DOWN_RR_CLIENT_CHANGE 7U /* neighbor rr-client command */
1715 #define PEER_DOWN_RS_CLIENT_CHANGE 8U /* neighbor rs-client command */
1716 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9U /* neighbor update-source command */
1717 #define PEER_DOWN_AF_ACTIVATE 10U /* neighbor activate command */
1718 #define PEER_DOWN_USER_SHUTDOWN 11U /* neighbor shutdown command */
1719 #define PEER_DOWN_USER_RESET 12U /* clear ip bgp command */
1720 #define PEER_DOWN_NOTIFY_RECEIVED 13U /* notification received */
1721 #define PEER_DOWN_NOTIFY_SEND 14U /* notification send */
1722 #define PEER_DOWN_CLOSE_SESSION 15U /* tcp session close */
1723 #define PEER_DOWN_NEIGHBOR_DELETE 16U /* neghbor delete */
1724 #define PEER_DOWN_RMAP_BIND 17U /* neghbor peer-group command */
1725 #define PEER_DOWN_RMAP_UNBIND 18U /* no neighbor peer-group command */
1726 #define PEER_DOWN_CAPABILITY_CHANGE 19U /* neighbor capability command */
1727 #define PEER_DOWN_PASSIVE_CHANGE 20U /* neighbor passive command */
1728 #define PEER_DOWN_MULTIHOP_CHANGE 21U /* neighbor multihop command */
1729 #define PEER_DOWN_NSF_CLOSE_SESSION 22U /* NSF tcp session close */
1730 #define PEER_DOWN_V6ONLY_CHANGE 23U /* if-based peering v6only toggled */
1731 #define PEER_DOWN_BFD_DOWN 24U /* BFD down */
1732 #define PEER_DOWN_IF_DOWN 25U /* Interface down */
1733 #define PEER_DOWN_NBR_ADDR_DEL 26U /* Peer address lost */
1734 #define PEER_DOWN_WAITING_NHT 27U /* Waiting for NHT to resolve */
1735 #define PEER_DOWN_NBR_ADDR 28U /* Waiting for peer IPv6 IP Addr */
1736 #define PEER_DOWN_VRF_UNINIT 29U /* Associated VRF is not init yet */
1737 #define PEER_DOWN_NOAFI_ACTIVATED 30U /* No AFI/SAFI activated for peer */
1738 #define PEER_DOWN_AS_SETS_REJECT 31U /* Reject routes with AS_SET */
1739 #define PEER_DOWN_WAITING_OPEN 32U /* Waiting for open to succeed */
1740 #define PEER_DOWN_PFX_COUNT 33U /* Reached received prefix count */
1741 #define PEER_DOWN_SOCKET_ERROR 34U /* Some socket error happened */
1742 #define PEER_DOWN_RTT_SHUTDOWN 35U /* Automatically shutdown due to RTT */
1744 * Remember to update peer_down_str in bgp_fsm.c when you add
1745 * a new value to the last_reset reason
1748 uint16_t last_reset_cause_size
;
1749 uint8_t last_reset_cause
[BGP_MAX_PACKET_SIZE
];
1751 /* The kind of route-map Flags.*/
1753 #define PEER_RMAP_TYPE_IN (1U << 0) /* neighbor route-map in */
1754 #define PEER_RMAP_TYPE_OUT (1U << 1) /* neighbor route-map out */
1755 #define PEER_RMAP_TYPE_NETWORK (1U << 2) /* network route-map */
1756 #define PEER_RMAP_TYPE_REDISTRIBUTE (1U << 3) /* redistribute route-map */
1757 #define PEER_RMAP_TYPE_DEFAULT (1U << 4) /* default-originate route-map */
1758 #define PEER_RMAP_TYPE_NOSET (1U << 5) /* not allow to set commands */
1759 #define PEER_RMAP_TYPE_IMPORT (1U << 6) /* neighbor route-map import */
1760 #define PEER_RMAP_TYPE_EXPORT (1U << 7) /* neighbor route-map export */
1761 #define PEER_RMAP_TYPE_AGGREGATE (1U << 8) /* aggregate-address route-map */
1763 /** Peer overwrite configuration. */
1764 struct bfd_session_config
{
1766 * Manual configuration bit.
1768 * This flag only makes sense for real peers (and not groups),
1769 * it keeps track if the user explicitly configured BFD for a
1773 /** Control Plane Independent. */
1775 /** Detection multiplier. */
1776 uint8_t detection_multiplier
;
1777 /** Minimum required RX interval. */
1779 /** Minimum required TX interval. */
1781 /** Profile name. */
1782 char profile
[BFD_PROFILE_NAME_LEN
];
1783 /** Peer BFD session */
1784 struct bfd_session_params
*session
;
1787 /* hostname and domainname advertised by host */
1791 /* Sender side AS path loop detection. */
1792 bool as_path_loop_detection
;
1794 /* Extended Message Support */
1795 uint16_t max_packet_size
;
1797 /* Conditional advertisement */
1798 bool advmap_config_change
[AFI_MAX
][SAFI_MAX
];
1799 bool advmap_table_change
;
1801 /* set TCP max segment size */
1804 /* Long-lived Graceful Restart */
1805 struct llgr_info llgr
[AFI_MAX
][SAFI_MAX
];
1807 bool shut_during_cfg
;
1811 DECLARE_QOBJ_TYPE(peer
);
1813 /* Inherit peer attribute from peer-group. */
1814 #define PEER_ATTR_INHERIT(peer, group, attr) \
1815 ((peer)->attr = (group)->conf->attr)
1816 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1818 XFREE(mt, (peer)->attr); \
1819 if ((group)->conf->attr) \
1820 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1822 (peer)->attr = NULL; \
1824 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1827 sockunion_free((peer)->attr); \
1828 if ((group)->conf->attr) \
1829 (peer)->attr = sockunion_dup((group)->conf->attr); \
1831 (peer)->attr = NULL; \
1834 /* Check if suppress start/restart of sessions to peer. */
1835 #define BGP_PEER_START_SUPPRESSED(P) \
1836 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) || \
1837 CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) || \
1838 CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN) || \
1839 (P)->shut_during_cfg)
1841 #define PEER_ROUTE_ADV_DELAY(peer) \
1842 (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
1844 #define PEER_PASSWORD_MINLEN (1)
1845 #define PEER_PASSWORD_MAXLEN (80)
1847 /* This structure's member directly points incoming packet data
1851 uint16_t afi
; /* iana_afi_t */
1854 uint8_t safi
; /* iana_safi_t */
1856 /* Pointer to NLRI byte stream. */
1859 /* Length of whole NLRI. */
1864 #define BGP_VERSION_4 4
1866 /* Default BGP port number. */
1867 #define BGP_PORT_DEFAULT 179
1869 /* Extended BGP Administrative Shutdown Communication */
1870 #define BGP_ADMIN_SHUTDOWN_MSG_LEN 255
1872 /* BGP minimum message size. */
1873 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1874 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1875 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1876 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1877 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1878 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1880 /* BGP message types. */
1881 #define BGP_MSG_OPEN 1
1882 #define BGP_MSG_UPDATE 2
1883 #define BGP_MSG_NOTIFY 3
1884 #define BGP_MSG_KEEPALIVE 4
1885 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1886 #define BGP_MSG_CAPABILITY 6
1887 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1889 /* BGP open optional parameter. */
1890 #define BGP_OPEN_OPT_AUTH 1
1891 #define BGP_OPEN_OPT_CAP 2
1893 /* BGP4 attribute type codes. */
1894 #define BGP_ATTR_ORIGIN 1
1895 #define BGP_ATTR_AS_PATH 2
1896 #define BGP_ATTR_NEXT_HOP 3
1897 #define BGP_ATTR_MULTI_EXIT_DISC 4
1898 #define BGP_ATTR_LOCAL_PREF 5
1899 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1900 #define BGP_ATTR_AGGREGATOR 7
1901 #define BGP_ATTR_COMMUNITIES 8
1902 #define BGP_ATTR_ORIGINATOR_ID 9
1903 #define BGP_ATTR_CLUSTER_LIST 10
1904 #define BGP_ATTR_MP_REACH_NLRI 14
1905 #define BGP_ATTR_MP_UNREACH_NLRI 15
1906 #define BGP_ATTR_EXT_COMMUNITIES 16
1907 #define BGP_ATTR_AS4_PATH 17
1908 #define BGP_ATTR_AS4_AGGREGATOR 18
1909 #define BGP_ATTR_PMSI_TUNNEL 22
1910 #define BGP_ATTR_ENCAP 23
1911 #define BGP_ATTR_IPV6_EXT_COMMUNITIES 25
1912 #define BGP_ATTR_AIGP 26
1913 #define BGP_ATTR_LARGE_COMMUNITIES 32
1914 #define BGP_ATTR_OTC 35
1915 #define BGP_ATTR_PREFIX_SID 40
1916 #define BGP_ATTR_SRTE_COLOR 51
1917 #ifdef ENABLE_BGP_VNC_ATTR
1918 #define BGP_ATTR_VNC 255
1921 /* BGP update origin. */
1922 #define BGP_ORIGIN_IGP 0
1923 #define BGP_ORIGIN_EGP 1
1924 #define BGP_ORIGIN_INCOMPLETE 2
1925 #define BGP_ORIGIN_UNSPECIFIED 255
1927 /* BGP notify message codes. */
1928 #define BGP_NOTIFY_HEADER_ERR 1
1929 #define BGP_NOTIFY_OPEN_ERR 2
1930 #define BGP_NOTIFY_UPDATE_ERR 3
1931 #define BGP_NOTIFY_HOLD_ERR 4
1932 #define BGP_NOTIFY_FSM_ERR 5
1933 #define BGP_NOTIFY_CEASE 6
1934 #define BGP_NOTIFY_ROUTE_REFRESH_ERR 7
1936 /* Subcodes for BGP Finite State Machine Error */
1937 #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC 0
1938 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT 1
1939 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
1940 #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
1942 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1944 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1945 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1946 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1947 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1949 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1950 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1951 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1952 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1953 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1954 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1955 #define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1956 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1957 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1958 #define BGP_NOTIFY_OPEN_ROLE_MISMATCH 11
1960 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1961 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1962 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1963 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1964 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1965 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1966 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1967 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1968 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1969 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1970 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1971 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1973 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1974 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1975 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1976 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1977 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1978 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1979 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1980 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1981 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1982 #define BGP_NOTIFY_CEASE_HARD_RESET 9
1983 #define BGP_NOTIFY_CEASE_BFD_DOWN 10
1985 /* BGP_NOTIFY_ROUTE_REFRESH_ERR sub codes (RFC 7313). */
1986 #define BGP_NOTIFY_ROUTE_REFRESH_INVALID_MSG_LEN 1
1988 /* BGP route refresh optional subtypes. */
1989 #define BGP_ROUTE_REFRESH_NORMAL 0
1990 #define BGP_ROUTE_REFRESH_BORR 1
1991 #define BGP_ROUTE_REFRESH_EORR 2
1993 /* BGP timers default value. */
1994 #define BGP_INIT_START_TIMER 1
1995 /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1996 * version-/profile-specific values. The values here do not matter, they only
1997 * exist to provide a clear layering separation between core and CLI.
1999 #define BGP_DEFAULT_HOLDTIME 180
2000 #define BGP_DEFAULT_KEEPALIVE 60
2001 #define BGP_DEFAULT_CONNECT_RETRY 120
2003 #define BGP_DEFAULT_EBGP_ROUTEADV 0
2004 #define BGP_DEFAULT_IBGP_ROUTEADV 0
2006 /* BGP RFC 4271 DelayOpenTime default value */
2007 #define BGP_DEFAULT_DELAYOPEN 120
2009 /* BGP default local preference. */
2010 #define BGP_DEFAULT_LOCAL_PREF 100
2012 /* BGP local-preference to send when 'bgp graceful-shutdown'
2014 #define BGP_GSHUT_LOCAL_PREF 0
2016 /* BGP default subgroup packet queue max . */
2017 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
2019 /* BGP graceful restart */
2020 #define BGP_DEFAULT_RESTART_TIME 120
2021 #define BGP_DEFAULT_STALEPATH_TIME 360
2022 #define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
2023 #define BGP_DEFAULT_RIB_STALE_TIME 500
2024 #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME 1
2026 /* BGP Long-lived Graceful Restart */
2027 #define BGP_DEFAULT_LLGR_STALE_TIME 0
2029 /* BGP uptime string length. */
2030 #define BGP_UPTIME_LEN 25
2032 /* Default configuration settings for bgpd. */
2033 #define BGP_VTY_PORT 2605
2034 #define BGP_DEFAULT_CONFIG "bgpd.conf"
2036 /* BGP Dynamic Neighbors feature */
2037 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
2038 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
2039 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 65535
2042 #define BGP_AIGP_TLV_RESERVED 0 /* AIGP Reserved */
2043 #define BGP_AIGP_TLV_METRIC 1 /* AIGP Metric */
2044 #define BGP_AIGP_TLV_METRIC_LEN 11
2045 #define BGP_AIGP_TLV_METRIC_MAX 0xffffffffffffffffULL
2046 #define BGP_AIGP_TLV_METRIC_DESC "Accumulated IGP Metric"
2048 /* Flag for peer_clear_soft(). */
2049 enum bgp_clear_type
{
2050 BGP_CLEAR_SOFT_NONE
,
2053 BGP_CLEAR_SOFT_BOTH
,
2054 BGP_CLEAR_SOFT_IN_ORF_PREFIX
,
2055 BGP_CLEAR_MESSAGE_STATS
2059 #define BGP_INPUT(P) ((P)->curr)
2060 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
2061 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
2062 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
2064 /* BGP error codes. */
2065 enum bgp_create_error_code
{
2068 BGP_ERR_INVALID_VALUE
= -1,
2069 BGP_ERR_INVALID_FLAG
= -2,
2070 BGP_ERR_INVALID_AS
= -3,
2071 BGP_ERR_PEER_GROUP_MEMBER
= -4,
2072 BGP_ERR_PEER_GROUP_NO_REMOTE_AS
= -5,
2073 BGP_ERR_PEER_GROUP_CANT_CHANGE
= -6,
2074 BGP_ERR_PEER_GROUP_MISMATCH
= -7,
2075 BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT
= -8,
2076 BGP_ERR_AS_MISMATCH
= -9,
2077 BGP_ERR_PEER_FLAG_CONFLICT
= -10,
2078 BGP_ERR_PEER_GROUP_SHUTDOWN
= -11,
2079 BGP_ERR_PEER_FILTER_CONFLICT
= -12,
2080 BGP_ERR_NOT_INTERNAL_PEER
= -13,
2081 BGP_ERR_REMOVE_PRIVATE_AS
= -14,
2082 BGP_ERR_AF_UNCONFIGURED
= -15,
2083 BGP_ERR_SOFT_RECONFIG_UNCONFIGURED
= -16,
2084 BGP_ERR_INSTANCE_MISMATCH
= -17,
2085 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS
= -19,
2086 BGP_ERR_TCPSIG_FAILED
= -20,
2087 BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK
= -21,
2088 BGP_ERR_NO_IBGP_WITH_TTLHACK
= -22,
2089 BGP_ERR_NO_INTERFACE_CONFIG
= -23,
2090 BGP_ERR_AS_OVERRIDE
= -25,
2091 BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT
= -26,
2092 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS
= -27,
2093 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND
= -28,
2094 BGP_ERR_INVALID_FOR_DYNAMIC_PEER
= -29,
2095 BGP_ERR_INVALID_FOR_DIRECT_PEER
= -30,
2096 BGP_ERR_PEER_SAFI_CONFLICT
= -31,
2099 BGP_ERR_GR_INVALID_CMD
= -32,
2100 BGP_ERR_GR_OPERATION_FAILED
= -33,
2101 BGP_GR_NO_OPERATION
= -34,
2103 /*BGP Open Policy ERRORS */
2104 BGP_ERR_INVALID_ROLE_NAME
= -35,
2105 BGP_ERR_INVALID_INTERNAL_ROLE
= -36,
2107 /* BGP ORR ERRORS */
2108 BGP_ERR_PEER_ORR_CONFIGURED
= -37,
2112 * Enumeration of different policy kinds a peer can be configured with.
2114 enum bgp_policy_type
{
2115 BGP_POLICY_ROUTE_MAP
,
2116 BGP_POLICY_FILTER_LIST
,
2117 BGP_POLICY_PREFIX_LIST
,
2118 BGP_POLICY_DISTRIBUTE_LIST
,
2121 /* peer_flag_change_type. */
2122 enum peer_change_type
{
2125 peer_change_reset_in
,
2126 peer_change_reset_out
,
2129 extern struct bgp_master
*bm
;
2130 extern unsigned int multipath_num
;
2133 extern void bgp_terminate(void);
2134 extern void bgp_reset(void);
2135 extern void bgp_zclient_reset(void);
2136 extern struct bgp
*bgp_get_default(void);
2137 extern struct bgp
*bgp_lookup(as_t
, const char *);
2138 extern struct bgp
*bgp_lookup_by_name(const char *);
2139 extern struct bgp
*bgp_lookup_by_vrf_id(vrf_id_t
);
2140 extern struct bgp
*bgp_get_evpn(void);
2141 extern void bgp_set_evpn(struct bgp
*bgp
);
2142 extern struct peer
*peer_lookup(struct bgp
*, union sockunion
*);
2143 extern struct peer
*peer_lookup_by_conf_if(struct bgp
*, const char *);
2144 extern struct peer
*peer_lookup_by_hostname(struct bgp
*, const char *);
2145 extern void bgp_peer_conf_if_to_su_update(struct peer
*);
2146 extern int peer_group_listen_range_del(struct peer_group
*, struct prefix
*);
2147 extern struct peer_group
*peer_group_lookup(struct bgp
*, const char *);
2148 extern struct peer_group
*peer_group_get(struct bgp
*, const char *);
2149 extern struct peer
*peer_create_bind_dynamic_neighbor(struct bgp
*,
2151 struct peer_group
*);
2152 extern struct prefix
*
2153 peer_group_lookup_dynamic_neighbor_range(struct peer_group
*, struct prefix
*);
2154 extern struct peer_group
*peer_group_lookup_dynamic_neighbor(struct bgp
*,
2157 extern struct peer
*peer_lookup_dynamic_neighbor(struct bgp
*,
2160 extern bool peer_orr_rrclient_check(struct peer
*peer
, afi_t afi
, safi_t safi
);
2162 * Peers are incredibly easy to memory leak
2163 * due to the various ways that they are actually used
2164 * Provide some functionality to debug locks and unlocks
2166 extern struct peer
*peer_lock_with_caller(const char *, struct peer
*);
2167 extern struct peer
*peer_unlock_with_caller(const char *, struct peer
*);
2168 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
2169 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
2171 extern enum bgp_peer_sort
peer_sort(struct peer
*peer
);
2172 extern enum bgp_peer_sort
peer_sort_lookup(struct peer
*peer
);
2174 extern bool peer_active(struct peer
*);
2175 extern bool peer_active_nego(struct peer
*);
2176 extern bool peer_afc_received(struct peer
*peer
);
2177 extern bool peer_afc_advertised(struct peer
*peer
);
2178 extern void bgp_recalculate_all_bestpaths(struct bgp
*bgp
);
2179 extern struct peer
*peer_create(union sockunion
*su
, const char *conf_if
,
2180 struct bgp
*bgp
, as_t local_as
, as_t remote_as
,
2181 int as_type
, struct peer_group
*group
,
2183 extern struct peer
*peer_create_accept(struct bgp
*);
2184 extern void peer_xfer_config(struct peer
*dst
, struct peer
*src
);
2185 extern char *peer_uptime(time_t uptime2
, char *buf
, size_t len
, bool use_json
,
2188 extern int bgp_config_write(struct vty
*);
2190 extern void bgp_master_init(struct thread_master
*master
, const int buffer_size
,
2191 struct list
*addresses
);
2193 extern void bgp_init(unsigned short instance
);
2194 extern void bgp_pthreads_run(void);
2195 extern void bgp_pthreads_finish(void);
2196 extern void bgp_route_map_init(void);
2197 extern void bgp_session_reset(struct peer
*);
2199 extern int bgp_option_set(int);
2200 extern int bgp_option_unset(int);
2201 extern int bgp_option_check(int);
2203 /* set the bgp no-rib option during runtime and remove installed routes */
2204 extern void bgp_option_norib_set_runtime(void);
2206 /* unset the bgp no-rib option during runtime and reset all peers */
2207 extern void bgp_option_norib_unset_runtime(void);
2209 extern int bgp_get(struct bgp
**, as_t
*, const char *, enum bgp_instance_type
);
2210 extern void bgp_instance_up(struct bgp
*);
2211 extern void bgp_instance_down(struct bgp
*);
2212 extern int bgp_delete(struct bgp
*);
2214 extern int bgp_handle_socket(struct bgp
*bgp
, struct vrf
*vrf
,
2215 vrf_id_t old_vrf_id
, bool create
);
2217 extern void bgp_router_id_zebra_bump(vrf_id_t
, const struct prefix
*);
2218 extern void bgp_router_id_static_set(struct bgp
*, struct in_addr
);
2220 extern void bm_wait_for_fib_set(bool set
);
2221 extern void bgp_suppress_fib_pending_set(struct bgp
*bgp
, bool set
);
2222 extern void bgp_cluster_id_set(struct bgp
*bgp
, struct in_addr
*cluster_id
);
2223 extern void bgp_cluster_id_unset(struct bgp
*bgp
);
2225 extern void bgp_confederation_id_set(struct bgp
*bgp
, as_t as
);
2226 extern void bgp_confederation_id_unset(struct bgp
*bgp
);
2227 extern bool bgp_confederation_peers_check(struct bgp
*, as_t
);
2229 extern void bgp_confederation_peers_add(struct bgp
*bgp
, as_t as
);
2230 extern void bgp_confederation_peers_remove(struct bgp
*bgp
, as_t as
);
2232 extern void bgp_timers_set(struct bgp
*, uint32_t keepalive
, uint32_t holdtime
,
2233 uint32_t connect_retry
, uint32_t delayopen
);
2234 extern void bgp_timers_unset(struct bgp
*);
2236 extern void bgp_default_local_preference_set(struct bgp
*bgp
,
2237 uint32_t local_pref
);
2238 extern void bgp_default_local_preference_unset(struct bgp
*bgp
);
2240 extern void bgp_default_subgroup_pkt_queue_max_set(struct bgp
*bgp
,
2241 uint32_t queue_size
);
2242 extern void bgp_default_subgroup_pkt_queue_max_unset(struct bgp
*bgp
);
2244 extern void bgp_listen_limit_set(struct bgp
*bgp
, int listen_limit
);
2245 extern void bgp_listen_limit_unset(struct bgp
*bgp
);
2247 extern bool bgp_update_delay_active(struct bgp
*);
2248 extern bool bgp_update_delay_configured(struct bgp
*);
2249 extern bool bgp_afi_safi_peer_exists(struct bgp
*bgp
, afi_t afi
, safi_t safi
);
2250 extern void peer_as_change(struct peer
*, as_t
, int);
2251 extern int peer_remote_as(struct bgp
*, union sockunion
*, const char *, as_t
*,
2253 extern int peer_group_remote_as(struct bgp
*, const char *, as_t
*, int);
2254 extern int peer_delete(struct peer
*peer
);
2255 extern void peer_notify_unconfig(struct peer
*peer
);
2256 extern int peer_group_delete(struct peer_group
*);
2257 extern int peer_group_remote_as_delete(struct peer_group
*);
2258 extern int peer_group_listen_range_add(struct peer_group
*, struct prefix
*);
2259 extern void peer_group_notify_unconfig(struct peer_group
*group
);
2261 extern int peer_activate(struct peer
*, afi_t
, safi_t
);
2262 extern int peer_deactivate(struct peer
*, afi_t
, safi_t
);
2264 extern int peer_group_bind(struct bgp
*, union sockunion
*, struct peer
*,
2265 struct peer_group
*, as_t
*);
2267 extern int peer_flag_set(struct peer
*peer
, uint64_t flag
);
2268 extern int peer_flag_unset(struct peer
*peer
, uint64_t flag
);
2269 extern void peer_flag_inherit(struct peer
*peer
, uint64_t flag
);
2271 extern int peer_af_flag_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2273 extern int peer_af_flag_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
2275 extern int peer_af_flag_check(struct peer
*, afi_t
, safi_t
, uint32_t);
2276 extern void peer_af_flag_inherit(struct peer
*peer
, afi_t afi
, safi_t safi
,
2278 extern void peer_change_action(struct peer
*peer
, afi_t afi
, safi_t safi
,
2279 enum peer_change_type type
);
2281 extern int peer_ebgp_multihop_set(struct peer
*, int);
2282 extern int peer_ebgp_multihop_unset(struct peer
*);
2283 extern int is_ebgp_multihop_configured(struct peer
*peer
);
2285 extern int peer_role_set(struct peer
*peer
, uint8_t role
, bool strict_mode
);
2286 extern int peer_role_unset(struct peer
*peer
);
2288 extern void peer_description_set(struct peer
*, const char *);
2289 extern void peer_description_unset(struct peer
*);
2291 extern int peer_update_source_if_set(struct peer
*, const char *);
2292 extern void peer_update_source_addr_set(struct peer
*peer
,
2293 const union sockunion
*su
);
2294 extern void peer_update_source_unset(struct peer
*peer
);
2296 extern int peer_default_originate_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2298 struct route_map
*route_map
);
2299 extern int peer_default_originate_unset(struct peer
*, afi_t
, safi_t
);
2300 extern void bgp_tcp_keepalive_set(struct bgp
*bgp
, uint16_t idle
,
2301 uint16_t interval
, uint16_t probes
);
2302 extern void bgp_tcp_keepalive_unset(struct bgp
*bgp
);
2304 extern void peer_port_set(struct peer
*, uint16_t);
2305 extern void peer_port_unset(struct peer
*);
2307 extern int peer_weight_set(struct peer
*, afi_t
, safi_t
, uint16_t);
2308 extern int peer_weight_unset(struct peer
*, afi_t
, safi_t
);
2310 extern int peer_timers_set(struct peer
*, uint32_t keepalive
,
2312 extern int peer_timers_unset(struct peer
*);
2314 extern int peer_timers_connect_set(struct peer
*, uint32_t);
2315 extern int peer_timers_connect_unset(struct peer
*);
2317 extern int peer_advertise_interval_set(struct peer
*, uint32_t);
2318 extern int peer_advertise_interval_unset(struct peer
*);
2320 extern int peer_timers_delayopen_set(struct peer
*peer
, uint32_t delayopen
);
2321 extern int peer_timers_delayopen_unset(struct peer
*peer
);
2323 extern void peer_interface_set(struct peer
*, const char *);
2324 extern void peer_interface_unset(struct peer
*);
2326 extern int peer_distribute_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2327 extern int peer_distribute_unset(struct peer
*, afi_t
, safi_t
, int);
2329 extern int peer_allowas_in_set(struct peer
*, afi_t
, safi_t
, int, int);
2330 extern int peer_allowas_in_unset(struct peer
*, afi_t
, safi_t
);
2332 extern int peer_local_as_set(struct peer
*, as_t
, bool no_prepend
,
2334 extern int peer_local_as_unset(struct peer
*);
2336 extern int peer_prefix_list_set(struct peer
*, afi_t
, safi_t
, int,
2338 extern int peer_prefix_list_unset(struct peer
*, afi_t
, safi_t
, int);
2340 extern int peer_aslist_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2341 extern int peer_aslist_unset(struct peer
*, afi_t
, safi_t
, int);
2343 extern int peer_route_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
, int,
2344 const char *name
, struct route_map
*route_map
);
2345 extern int peer_route_map_unset(struct peer
*, afi_t
, safi_t
, int);
2347 extern int peer_unsuppress_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2349 struct route_map
*route_map
);
2351 extern int peer_advertise_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2352 const char *advertise_name
,
2353 struct route_map
*advertise_map
,
2354 const char *condition_name
,
2355 struct route_map
*condition_map
,
2358 extern int peer_password_set(struct peer
*, const char *);
2359 extern int peer_password_unset(struct peer
*);
2361 extern int peer_unsuppress_map_unset(struct peer
*, afi_t
, safi_t
);
2363 extern int peer_advertise_map_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
2364 const char *advertise_name
,
2365 struct route_map
*advertise_map
,
2366 const char *condition_name
,
2367 struct route_map
*condition_map
,
2370 extern int peer_maximum_prefix_set(struct peer
*, afi_t
, safi_t
, uint32_t,
2371 uint8_t, int, uint16_t, bool force
);
2372 extern int peer_maximum_prefix_unset(struct peer
*, afi_t
, safi_t
);
2374 extern void peer_maximum_prefix_out_refresh_routes(struct peer
*peer
, afi_t afi
,
2376 extern int peer_maximum_prefix_out_set(struct peer
*peer
, afi_t afi
,
2377 safi_t safi
, uint32_t max
);
2378 extern int peer_maximum_prefix_out_unset(struct peer
*peer
, afi_t afi
,
2381 extern int peer_clear(struct peer
*, struct listnode
**);
2382 extern int peer_clear_soft(struct peer
*, afi_t
, safi_t
, enum bgp_clear_type
);
2384 extern int peer_ttl_security_hops_set(struct peer
*, int);
2385 extern int peer_ttl_security_hops_unset(struct peer
*);
2387 extern void peer_tx_shutdown_message_set(struct peer
*, const char *msg
);
2388 extern void peer_tx_shutdown_message_unset(struct peer
*);
2390 extern void bgp_route_map_update_timer(struct thread
*thread
);
2391 extern const char *bgp_get_name_by_role(uint8_t role
);
2393 extern void bgp_route_map_terminate(void);
2395 extern int peer_cmp(struct peer
*p1
, struct peer
*p2
);
2397 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi
, iana_safi_t pkt_safi
,
2398 afi_t
*afi
, safi_t
*safi
);
2399 extern int bgp_map_afi_safi_int2iana(afi_t afi
, safi_t safi
,
2400 iana_afi_t
*pkt_afi
,
2401 iana_safi_t
*pkt_safi
);
2403 extern struct peer_af
*peer_af_create(struct peer
*, afi_t
, safi_t
);
2404 extern struct peer_af
*peer_af_find(struct peer
*, afi_t
, safi_t
);
2405 extern int peer_af_delete(struct peer
*, afi_t
, safi_t
);
2407 extern void bgp_shutdown_enable(struct bgp
*bgp
, const char *msg
);
2408 extern void bgp_shutdown_disable(struct bgp
*bgp
);
2410 extern void bgp_close(void);
2411 extern void bgp_free(struct bgp
*);
2412 void bgp_gr_apply_running_config(void);
2413 extern int bgp_afi_safi_orr_group_set(struct bgp
*bgp
, afi_t afi
, safi_t safi
,
2414 const char *name
, struct peer
*primary
,
2415 struct peer
*secondary
,
2416 struct peer
*tertiary
);
2417 extern int bgp_afi_safi_orr_group_unset(struct bgp
*bgp
, afi_t afi
, safi_t safi
,
2421 int bgp_global_gr_init(struct bgp
*bgp
);
2422 int bgp_peer_gr_init(struct peer
*peer
);
2425 #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list) \
2427 struct peer *peer_loop; \
2428 bool gr_router_detected = false; \
2429 struct listnode *node = {0}; \
2430 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) { \
2431 if (CHECK_FLAG(peer_loop->flags, \
2432 PEER_FLAG_GRACEFUL_RESTART)) \
2433 gr_router_detected = true; \
2435 if (gr_router_detected \
2436 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
2437 bgp_zebra_send_capabilities(_bgp, false); \
2438 } else if (!gr_router_detected \
2439 && _bgp->present_zebra_gr_state \
2440 == ZEBRA_GR_ENABLE) { \
2441 bgp_zebra_send_capabilities(_bgp, true); \
2445 static inline struct bgp
*bgp_lock(struct bgp
*bgp
)
2451 static inline void bgp_unlock(struct bgp
*bgp
)
2453 assert(bgp
->lock
> 0);
2454 if (--bgp
->lock
== 0)
2458 static inline int afindex(afi_t afi
, safi_t safi
)
2464 return BGP_AF_IPV4_UNICAST
;
2465 case SAFI_MULTICAST
:
2466 return BGP_AF_IPV4_MULTICAST
;
2467 case SAFI_LABELED_UNICAST
:
2468 return BGP_AF_IPV4_LBL_UNICAST
;
2470 return BGP_AF_IPV4_VPN
;
2472 return BGP_AF_IPV4_ENCAP
;
2474 return BGP_AF_IPV4_FLOWSPEC
;
2482 return BGP_AF_IPV6_UNICAST
;
2483 case SAFI_MULTICAST
:
2484 return BGP_AF_IPV6_MULTICAST
;
2485 case SAFI_LABELED_UNICAST
:
2486 return BGP_AF_IPV6_LBL_UNICAST
;
2488 return BGP_AF_IPV6_VPN
;
2490 return BGP_AF_IPV6_ENCAP
;
2492 return BGP_AF_IPV6_FLOWSPEC
;
2500 return BGP_AF_L2VPN_EVPN
;
2509 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
2510 static inline int peer_group_active(struct peer
*peer
)
2512 if (!CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
) && peer
->group
)
2517 /* If peer is negotiated at least one address family return 1. */
2518 static inline int peer_afi_active_nego(const struct peer
*peer
, afi_t afi
)
2520 if (peer
->afc_nego
[afi
][SAFI_UNICAST
]
2521 || peer
->afc_nego
[afi
][SAFI_MULTICAST
]
2522 || peer
->afc_nego
[afi
][SAFI_LABELED_UNICAST
]
2523 || peer
->afc_nego
[afi
][SAFI_MPLS_VPN
]
2524 || peer
->afc_nego
[afi
][SAFI_ENCAP
]
2525 || peer
->afc_nego
[afi
][SAFI_FLOWSPEC
]
2526 || peer
->afc_nego
[afi
][SAFI_EVPN
])
2531 /* If at least one address family activated for group, return 1. */
2532 static inline int peer_group_af_configured(struct peer_group
*group
)
2534 struct peer
*peer
= group
->conf
;
2536 if (peer
->afc
[AFI_IP
][SAFI_UNICAST
] || peer
->afc
[AFI_IP
][SAFI_MULTICAST
]
2537 || peer
->afc
[AFI_IP
][SAFI_LABELED_UNICAST
]
2538 || peer
->afc
[AFI_IP
][SAFI_FLOWSPEC
]
2539 || peer
->afc
[AFI_IP
][SAFI_MPLS_VPN
] || peer
->afc
[AFI_IP
][SAFI_ENCAP
]
2540 || peer
->afc
[AFI_IP6
][SAFI_UNICAST
]
2541 || peer
->afc
[AFI_IP6
][SAFI_MULTICAST
]
2542 || peer
->afc
[AFI_IP6
][SAFI_LABELED_UNICAST
]
2543 || peer
->afc
[AFI_IP6
][SAFI_MPLS_VPN
]
2544 || peer
->afc
[AFI_IP6
][SAFI_ENCAP
]
2545 || peer
->afc
[AFI_IP6
][SAFI_FLOWSPEC
]
2546 || peer
->afc
[AFI_L2VPN
][SAFI_EVPN
])
2551 static inline char *timestamp_string(time_t ts
)
2554 tbuf
= time(NULL
) - (monotime(NULL
) - ts
);
2555 return ctime(&tbuf
);
2558 static inline bool peer_established(struct peer
*peer
)
2560 return peer
->status
== Established
;
2563 static inline bool peer_dynamic_neighbor(struct peer
*peer
)
2565 return CHECK_FLAG(peer
->flags
, PEER_FLAG_DYNAMIC_NEIGHBOR
);
2568 static inline bool peer_dynamic_neighbor_no_nsf(struct peer
*peer
)
2570 return (peer_dynamic_neighbor(peer
) &&
2571 !CHECK_FLAG(peer
->sflags
, PEER_STATUS_NSF_WAIT
));
2574 static inline int peer_cap_enhe(struct peer
*peer
, afi_t afi
, safi_t safi
)
2576 return (CHECK_FLAG(peer
->af_cap
[afi
][safi
], PEER_CAP_ENHE_AF_NEGO
));
2579 /* Lookup VRF for BGP instance based on its type. */
2580 static inline struct vrf
*bgp_vrf_lookup_by_instance_type(struct bgp
*bgp
)
2584 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_DEFAULT
)
2585 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
2586 else if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
)
2587 vrf
= vrf_lookup_by_name(bgp
->name
);
2594 static inline uint32_t bgp_vrf_interfaces(struct bgp
*bgp
, bool active
)
2597 struct interface
*ifp
;
2600 /* if there is one interface in the vrf which is up then it is deemed
2603 vrf
= bgp_vrf_lookup_by_instance_type(bgp
);
2606 RB_FOREACH (ifp
, if_name_head
, &vrf
->ifaces_by_name
) {
2607 if (strcmp(ifp
->name
, bgp
->name
) == 0)
2609 if (!active
|| if_is_up(ifp
))
2615 /* Link BGP instance to VRF. */
2616 static inline void bgp_vrf_link(struct bgp
*bgp
, struct vrf
*vrf
)
2618 bgp
->vrf_id
= vrf
->vrf_id
;
2619 if (vrf
->info
!= (void *)bgp
)
2620 vrf
->info
= (void *)bgp_lock(bgp
);
2623 /* Unlink BGP instance from VRF. */
2624 static inline void bgp_vrf_unlink(struct bgp
*bgp
, struct vrf
*vrf
)
2626 if (vrf
->info
== (void *)bgp
) {
2630 bgp
->vrf_id
= VRF_UNKNOWN
;
2633 static inline bool bgp_in_graceful_shutdown(struct bgp
*bgp
)
2635 /* True if either set for this instance or globally */
2636 return (!!CHECK_FLAG(bgp
->flags
, BGP_FLAG_GRACEFUL_SHUTDOWN
) ||
2637 !!CHECK_FLAG(bm
->flags
, BM_FLAG_GRACEFUL_SHUTDOWN
));
2640 /* For benefit of rfapi */
2641 extern struct peer
*peer_new(struct bgp
*bgp
);
2643 extern struct peer
*peer_lookup_in_view(struct vty
*vty
, struct bgp
*bgp
,
2644 const char *ip_str
, bool use_json
);
2645 extern int bgp_lookup_by_as_name_type(struct bgp
**bgp_val
, as_t
*as
,
2647 enum bgp_instance_type inst_type
);
2650 DECLARE_HOOK(bgp_vrf_status_changed
, (struct bgp
*bgp
, struct interface
*ifp
),
2652 DECLARE_HOOK(peer_status_changed
, (struct peer
*peer
), (peer
));
2653 DECLARE_HOOK(bgp_snmp_init_stats
, (struct bgp
*bgp
), (bgp
));
2654 DECLARE_HOOK(bgp_snmp_update_last_changed
, (struct bgp
*bgp
), (bgp
));
2655 DECLARE_HOOK(bgp_snmp_update_stats
,
2656 (struct bgp_node
*rn
, struct bgp_path_info
*pi
, bool added
),
2658 DECLARE_HOOK(bgp_rpki_prefix_status
,
2659 (struct peer
* peer
, struct attr
*attr
,
2660 const struct prefix
*prefix
),
2661 (peer
, attr
, prefix
));
2663 void peer_nsf_stop(struct peer
*peer
);
2665 void peer_tcp_mss_set(struct peer
*peer
, uint32_t tcp_mss
);
2666 void peer_tcp_mss_unset(struct peer
*peer
);
2668 extern void bgp_recalculate_afi_safi_bestpaths(struct bgp
*bgp
, afi_t afi
,
2670 extern void peer_on_policy_change(struct peer
*peer
, afi_t afi
, safi_t safi
,
2672 #ifdef _FRR_ATTRIBUTE_PRINTFRR
2673 /* clang-format off */
2674 #pragma FRR printfrr_ext "%pBP" (struct peer *)
2675 /* clang-format on */
2678 #endif /* _QUAGGA_BGPD_H */