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"
36 /* For union sockunion. */
38 #include "sockunion.h"
42 #include "bgp_memory.h"
45 #include "bgp_labelpool.h"
46 #include "bgp_addpath_types.h"
47 #include "bgp_nexthop.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 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. */
136 #define BGP_OPT_NO_FIB (1 << 0)
137 #define BGP_OPT_NO_LISTEN (1 << 1)
138 #define BGP_OPT_NO_ZEBRA (1 << 2)
140 uint64_t updgrp_idspace
;
141 uint64_t subgrp_idspace
;
143 /* timer to dampen route map changes */
144 struct thread
*t_rmap_update
; /* Handle route map updates */
145 uint32_t rmap_update_timer
; /* Route map update timer */
146 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
148 /* Id space for automatic RD derivation for an EVI/VRF */
149 bitfield_t rd_idspace
;
151 /* dynamic mpls label allocation pool */
152 struct labelpool labelpool
;
154 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
155 struct bgp
* bgp_evpn
;
157 /* How big should we set the socket buffer size */
158 uint32_t socket_buffer
;
160 /* Should we do wait for fib install globally? */
163 /* EVPN multihoming */
164 struct bgp_evpn_mh_info
*mh_info
;
166 /* global update-delay timer values */
167 uint16_t v_update_delay
;
168 uint16_t v_establish_wait
;
171 #define BM_FLAG_GRACEFUL_SHUTDOWN (1 << 0)
172 #define BM_FLAG_SEND_EXTRA_DATA_TO_ZEBRA (1 << 1)
174 bool terminating
; /* global flag that sigint terminate seen */
176 /* DSCP value for TCP sessions */
179 #define BM_DEFAULT_Q_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 enum vpn_policy_direction
{
205 BGP_VPN_POLICY_DIR_FROMVPN
= 0,
206 BGP_VPN_POLICY_DIR_TOVPN
= 1,
207 BGP_VPN_POLICY_DIR_MAX
= 2
211 struct bgp
*bgp
; /* parent */
213 struct ecommunity
*rtlist
[BGP_VPN_POLICY_DIR_MAX
];
214 struct ecommunity
*import_redirect_rtlist
;
215 char *rmap_name
[BGP_VPN_POLICY_DIR_MAX
];
216 struct route_map
*rmap
[BGP_VPN_POLICY_DIR_MAX
];
218 /* should be mpls_label_t? */
219 uint32_t tovpn_label
; /* may be MPLS_LABEL_NONE */
220 uint32_t tovpn_zebra_vrf_label_last_sent
;
221 struct prefix_rd tovpn_rd
;
222 struct prefix tovpn_nexthop
; /* unset => set to 0 */
224 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
225 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
226 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
227 #define BGP_VPN_POLICY_TOVPN_SID_AUTO (1 << 3)
230 * If we are importing another vrf into us keep a list of
231 * vrf names that are being imported into us.
233 struct list
*import_vrf
;
236 * if we are being exported to another vrf keep a list of
237 * vrf names that we are being exported to.
239 struct list
*export_vrf
;
242 * Segment-Routing SRv6 Mode
244 uint32_t tovpn_sid_index
; /* unset => set to 0 */
245 struct in6_addr
*tovpn_sid
;
246 struct srv6_locator_chunk
*tovpn_sid_locator
;
247 uint32_t tovpn_sid_transpose_label
;
248 struct in6_addr
*tovpn_zebra_vrf_sid_last_sent
;
252 * Type of 'struct bgp'.
253 * - Default: The default instance
254 * - VRF: A specific (non-default) VRF
255 * - View: An instance used for route exchange
256 * The "default" instance is treated separately to simplify the code. Note
257 * that if deployed in a Multi-VRF environment, it may not exist.
259 enum bgp_instance_type
{
260 BGP_INSTANCE_TYPE_DEFAULT
,
261 BGP_INSTANCE_TYPE_VRF
,
262 BGP_INSTANCE_TYPE_VIEW
265 #define BGP_SEND_EOR(bgp, afi, safi) \
266 (!CHECK_FLAG(bgp->flags, BGP_FLAG_GR_DISABLE_EOR) \
267 && ((bgp->gr_info[afi][safi].t_select_deferral == NULL) \
268 || (bgp->gr_info[afi][safi].eor_required \
269 == bgp->gr_info[afi][safi].eor_received)))
271 /* BGP GR Global ds */
273 #define BGP_GLOBAL_GR_MODE 4
274 #define BGP_GLOBAL_GR_EVENT_CMD 4
276 /* Graceful restart selection deferral timer info */
277 struct graceful_restart_info
{
278 /* Count of EOR message expected */
279 uint32_t eor_required
;
280 /* Count of EOR received */
281 uint32_t eor_received
;
283 struct thread
*t_select_deferral
;
284 /* Routes Deferred */
285 uint32_t gr_deferred
;
286 /* Best route select */
287 struct thread
*t_route_select
;
288 /* AFI, SAFI enabled */
289 bool af_enabled
[AFI_MAX
][SAFI_MAX
];
290 /* Route update completed */
291 bool route_sync
[AFI_MAX
][SAFI_MAX
];
295 GLOBAL_HELPER
= 0, /* This is the default mode */
301 enum global_gr_command
{
305 NO_GLOBAL_DISABLE_CMD
308 #define BGP_GR_SUCCESS 0
309 #define BGP_GR_FAILURE 1
311 /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
312 * do weighted ECMP. Note: This applies after multipath computation.
314 enum bgp_link_bw_handling
{
315 /* Do ECMP if some paths don't have LB - default */
317 /* Completely ignore LB, just do regular ECMP */
318 BGP_LINK_BW_IGNORE_BW
,
319 /* Skip paths without LB, do wECMP on others */
320 BGP_LINK_BW_SKIP_MISSING
,
321 /* Do wECMP with default weight for paths not having LB */
322 BGP_LINK_BW_DEFWT_4_MISSING
325 RB_HEAD(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
);
326 RB_PROTOTYPE(bgp_es_vrf_rb_head
, bgp_evpn_es_vrf
, rb_node
, bgp_es_vrf_rb_cmp
);
328 struct bgp_snmp_stats
{
329 /* SNMP variables for mplsL3Vpn*/
330 time_t creation_time
;
333 uint32_t routes_added
;
334 uint32_t routes_deleted
;
337 struct bgp_srv6_function
{
339 char locator_name
[SRV6_LOCNAME_SIZE
];
342 /* BGP instance structure. */
344 /* AS number of this BGP instance. */
348 /* Name of this BGP instance. */
350 char *name_pretty
; /* printable "VRF|VIEW name|default" */
352 /* Type of instance and VRF id. */
353 enum bgp_instance_type inst_type
;
356 /* Reference count to allow peer_delete to finish after bgp_delete */
360 struct peer
*peer_self
;
364 struct hash
*peerhash
;
366 /* BGP peer group. */
369 /* The maximum number of BGP dynamic neighbors that can be created */
370 int dynamic_neighbors_limit
;
372 /* The current number of BGP dynamic neighbors */
373 int dynamic_neighbors_count
;
375 struct hash
*update_groups
[BGP_AF_MAX
];
378 * Global statistics for update groups.
381 uint32_t join_events
;
382 uint32_t prune_events
;
383 uint32_t merge_events
;
384 uint32_t split_events
;
385 uint32_t updgrp_switch_events
;
386 uint32_t peer_refreshes_combined
;
388 uint32_t merge_checks_triggered
;
390 uint32_t updgrps_created
;
391 uint32_t updgrps_deleted
;
392 uint32_t subgrps_created
;
393 uint32_t subgrps_deleted
;
394 } update_group_stats
;
396 struct bgp_snmp_stats
*snmp_stats
;
398 /* BGP configuration. */
400 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
401 #define BGP_CONFIG_CONFEDERATION (1 << 1)
403 /* BGP router identifier. */
404 struct in_addr router_id
;
405 struct in_addr router_id_static
;
406 struct in_addr router_id_zebra
;
408 /* BGP route reflector cluster ID. */
409 struct in_addr cluster_id
;
411 /* BGP confederation information. */
414 int confed_peers_cnt
;
417 *t_startup
; /* start-up timer on only once at the beginning */
419 uint32_t v_maxmed_onstartup
; /* Duration of max-med on start-up */
420 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
421 uint32_t maxmed_onstartup_value
; /* Max-med value when active on
424 *t_maxmed_onstartup
; /* non-null when max-med onstartup is on */
425 uint8_t maxmed_onstartup_over
; /* Flag to make it effective only once */
427 bool v_maxmed_admin
; /* true/false if max-med administrative is on/off
429 #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
430 uint32_t maxmed_admin_value
; /* Max-med value when administrative in on
432 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
434 uint8_t maxmed_active
; /* 1/0 if max-med is active or not */
435 uint32_t maxmed_value
; /* Max-med value when its active */
437 /* BGP update delay on startup */
438 struct thread
*t_update_delay
;
439 struct thread
*t_establish_wait
;
440 struct thread
*t_revalidate
[AFI_MAX
][SAFI_MAX
];
442 uint8_t update_delay_over
;
443 uint8_t main_zebra_update_hold
;
444 uint8_t main_peers_update_hold
;
445 uint16_t v_update_delay
;
446 uint16_t v_establish_wait
;
447 char update_delay_begin_time
[64];
448 char update_delay_end_time
[64];
449 char update_delay_zebra_resume_time
[64];
450 char update_delay_peers_resume_time
[64];
451 uint32_t established
;
452 uint32_t restarted_peers
;
453 uint32_t implicit_eors
;
454 uint32_t explicit_eors
;
455 #define BGP_UPDATE_DELAY_DEF 0
456 #define BGP_UPDATE_DELAY_MIN 0
457 #define BGP_UPDATE_DELAY_MAX 3600
459 /* Reference bandwidth for BGP link-bandwidth. Used when
460 * the LB value has to be computed based on some other
461 * factor (e.g., number of multipaths for the prefix)
465 #define BGP_LINK_BW_REF_BW 1
469 #define BGP_FLAG_ALWAYS_COMPARE_MED (1ULL << 0)
470 #define BGP_FLAG_DETERMINISTIC_MED (1ULL << 1)
471 #define BGP_FLAG_MED_MISSING_AS_WORST (1ULL << 2)
472 #define BGP_FLAG_MED_CONFED (1ULL << 3)
473 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1ULL << 4)
474 #define BGP_FLAG_COMPARE_ROUTER_ID (1ULL << 5)
475 #define BGP_FLAG_ASPATH_IGNORE (1ULL << 6)
476 #define BGP_FLAG_IMPORT_CHECK (1ULL << 7)
477 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1ULL << 8)
478 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1ULL << 9)
480 /* This flag is set when we have full BGP Graceful-Restart mode enable */
481 #define BGP_FLAG_GRACEFUL_RESTART (1ULL << 10)
483 #define BGP_FLAG_ASPATH_CONFED (1ULL << 11)
484 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1ULL << 12)
485 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1ULL << 13)
486 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1ULL << 14)
487 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1ULL << 15)
488 #define BGP_FLAG_FORCE_STATIC_PROCESS (1ULL << 16)
489 #define BGP_FLAG_SHOW_HOSTNAME (1ULL << 17)
490 #define BGP_FLAG_GR_PRESERVE_FWD (1ULL << 18)
491 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1ULL << 19)
492 #define BGP_FLAG_DELETE_IN_PROGRESS (1ULL << 20)
493 #define BGP_FLAG_SELECT_DEFER_DISABLE (1ULL << 21)
494 #define BGP_FLAG_GR_DISABLE_EOR (1ULL << 22)
495 #define BGP_FLAG_EBGP_REQUIRES_POLICY (1ULL << 23)
496 #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1ULL << 24)
498 /* This flag is set if the instance is in administrative shutdown */
499 #define BGP_FLAG_SHUTDOWN (1ULL << 25)
500 #define BGP_FLAG_SUPPRESS_FIB_PENDING (1ULL << 26)
501 #define BGP_FLAG_SUPPRESS_DUPLICATES (1ULL << 27)
502 #define BGP_FLAG_PEERTYPE_MULTIPATH_RELAX (1ULL << 29)
503 /* Indicate Graceful Restart support for BGP NOTIFICATION messages */
504 #define BGP_FLAG_GRACEFUL_NOTIFICATION (1ULL << 30)
505 /* Send Hard Reset CEASE Notification for 'Administrative Reset' */
506 #define BGP_FLAG_HARD_ADMIN_RESET (1ULL << 31)
507 /* Evaluate the AIGP attribute during the best path selection process */
508 #define BGP_FLAG_COMPARE_AIGP (1ULL << 32)
510 /* BGP default address-families.
511 * New peers inherit enabled afi/safis from bgp instance.
513 uint16_t default_af
[AFI_MAX
][SAFI_MAX
];
515 enum global_mode GLOBAL_GR_FSM
[BGP_GLOBAL_GR_MODE
]
516 [BGP_GLOBAL_GR_EVENT_CMD
];
517 enum global_mode global_gr_present_state
;
519 /* This variable stores the current Graceful Restart state of Zebra
520 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
522 enum zebra_gr_mode present_zebra_gr_state
;
524 /* BGP Per AF flags */
525 uint16_t af_flags
[AFI_MAX
][SAFI_MAX
];
526 #define BGP_CONFIG_DAMPENING (1 << 0)
527 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
528 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST (1 << 1)
529 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST_GW_IP (1 << 2)
530 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST (1 << 3)
531 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST_GW_IP (1 << 4)
532 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 5)
533 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 6)
534 /* import/export between address families */
535 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 7)
536 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 8)
537 /* vrf-route leaking flags */
538 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 9)
539 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 10)
540 /* vpnvx retain flag */
541 #define BGP_VPNVX_RETAIN_ROUTE_TARGET_ALL (1 << 11)
543 /* BGP per AF peer count */
544 uint32_t af_peer_count
[AFI_MAX
][SAFI_MAX
];
546 /* Tree for next-hop lookup cache. */
547 struct bgp_nexthop_cache_head nexthop_cache_table
[AFI_MAX
];
549 /* Tree for import-check */
550 struct bgp_nexthop_cache_head import_check_table
[AFI_MAX
];
552 struct bgp_table
*connected_table
[AFI_MAX
];
554 struct hash
*address_hash
;
556 /* DB for all local tunnel-ips - used mainly for martian checks
557 Currently it only has all VxLan tunnel IPs*/
558 struct hash
*tip_hash
;
560 /* Static route configuration. */
561 struct bgp_table
*route
[AFI_MAX
][SAFI_MAX
];
563 /* Aggregate address configuration. */
564 struct bgp_table
*aggregate
[AFI_MAX
][SAFI_MAX
];
566 /* BGP routing information base. */
567 struct bgp_table
*rib
[AFI_MAX
][SAFI_MAX
];
569 /* BGP table route-map. */
570 struct bgp_rmap table_map
[AFI_MAX
][SAFI_MAX
];
572 /* BGP redistribute configuration. */
573 struct list
*redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
575 /* Allocate MPLS labels */
576 uint8_t allocate_mpls_labels
[AFI_MAX
][SAFI_MAX
];
578 /* Allocate hash entries to store policy routing information
579 * The hash are used to host pbr rules somewhere.
580 * Actually, pbr will only be used by flowspec
581 * those hash elements will have relationship together as
582 * illustrated in below diagram:
584 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
585 * <----- pbr_match j <--- pbr_match_entry 1..m
588 * - here in BGP structure, the list of match and actions will
589 * stand for the list of ipset sets, and table_ids in the kernel
590 * - the arrow above between pbr_match and pbr_action indicate
591 * that a backpointer permits match to find the action
592 * - the arrow betwen match_entry and match is a hash list
593 * contained in match, that lists the whole set of entries
595 struct hash
*pbr_match_hash
;
596 struct hash
*pbr_rule_hash
;
597 struct hash
*pbr_action_hash
;
599 /* timer to re-evaluate neighbor default-originate route-maps */
600 struct thread
*t_rmap_def_originate_eval
;
601 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
603 /* BGP distance configuration. */
604 uint8_t distance_ebgp
[AFI_MAX
][SAFI_MAX
];
605 uint8_t distance_ibgp
[AFI_MAX
][SAFI_MAX
];
606 uint8_t distance_local
[AFI_MAX
][SAFI_MAX
];
608 /* BGP default local-preference. */
609 uint32_t default_local_pref
;
611 /* BGP default subgroup pkt queue max */
612 uint32_t default_subgroup_pkt_queue_max
;
614 /* BGP default timer. */
615 uint32_t default_holdtime
;
616 uint32_t default_keepalive
;
617 uint32_t default_connect_retry
;
618 uint32_t default_delayopen
;
620 /* BGP minimum holdtime. */
621 uint16_t default_min_holdtime
;
623 /* BGP graceful restart */
624 uint32_t restart_time
;
625 uint32_t stalepath_time
;
626 uint32_t select_defer_time
;
627 struct graceful_restart_info gr_info
[AFI_MAX
][SAFI_MAX
];
628 uint32_t rib_stale_time
;
630 /* BGP Long-lived Graceful Restart */
631 uint32_t llgr_stale_time
;
633 #define BGP_ROUTE_SELECT_DELAY 1
634 #define BGP_MAX_BEST_ROUTE_SELECT 10000
635 /* Maximum-paths configuration */
636 struct bgp_maxpaths_cfg
{
637 uint16_t maxpaths_ebgp
;
638 uint16_t maxpaths_ibgp
;
639 bool same_clusterlen
;
640 } maxpaths
[AFI_MAX
][SAFI_MAX
];
642 _Atomic
uint32_t wpkt_quanta
; // max # packets to write per i/o cycle
643 _Atomic
uint32_t rpkt_quanta
; // max # packets to read per i/o cycle
645 /* Automatic coalesce adjust on/off */
646 bool heuristic_coalesce
;
647 /* Actual coalesce time */
648 uint32_t coalesce_time
;
650 /* Auto-shutdown new peers */
653 struct bgp_addpath_bgp_data tx_addpath
;
655 #ifdef ENABLE_BGP_VNC
656 struct rfapi_cfg
*rfapi_cfg
;
660 /* EVPN related information */
663 struct hash
*vnihash
;
666 * VNI hash table based on SVI ifindex as its key.
667 * We use SVI ifindex as key to lookup a VNI table for gateway IP
668 * overlay index recursive lookup.
669 * For this purpose, a hashtable is added which optimizes this lookup.
671 struct hash
*vni_svi_hash
;
673 /* EVPN enable - advertise gateway macip routes */
674 int advertise_gw_macip
;
676 /* EVPN enable - advertise local VNIs and their MACs etc. */
677 int advertise_all_vni
;
679 /* draft-ietf-idr-deprecate-as-set-confed-set
680 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
684 struct bgp_evpn_info
*evpn_info
;
686 /* EVPN - use RFC 8365 to auto-derive RT */
687 int advertise_autort_rfc8365
;
690 * Flooding mechanism for BUM packets for VxLAN-EVPN.
692 enum vxlan_flood_control vxlan_flood_ctrl
;
694 /* Hash table of Import RTs to EVIs */
695 struct hash
*import_rt_hash
;
697 /* Hash table of VRF import RTs to VRFs */
698 struct hash
*vrf_import_rt_hash
;
700 /* L3-VNI corresponding to this vrf */
703 /* router-mac to be used in mac-ip routes for this vrf */
706 /* originator ip - to be used as NH for type-5 routes */
707 struct in_addr originator_ip
;
709 /* SVI associated with the L3-VNI corresponding to this vrf */
710 ifindex_t l3vni_svi_ifindex
;
712 /* RB tree of ES-VRFs */
713 struct bgp_es_vrf_rb_head es_vrf_rb_tree
;
715 /* Hash table of EVPN nexthops maintained per-tenant-VRF */
716 struct hash
*evpn_nh_table
;
719 * Flag resolve_overlay_index is used for recursive resolution
720 * procedures for EVPN type-5 route's gateway IP overlay index.
721 * When this flag is set, we build remote-ip-hash for
722 * all L2VNIs and resolve overlay index nexthops using this hash.
723 * Overlay index nexthops remain unresolved if this flag is not set.
725 bool resolve_overlay_index
;
729 #define BGP_VRF_AUTO (1 << 0)
730 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
731 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
732 #define BGP_VRF_IMPORT_AUTO_RT_CFGD (1 << 3) /* retain auto when cfgd */
733 #define BGP_VRF_EXPORT_AUTO_RT_CFGD (1 << 4) /* retain auto when cfgd */
734 #define BGP_VRF_RD_CFGD (1 << 5)
735 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 6)
736 /* per-VRF toVPN SID */
737 #define BGP_VRF_TOVPN_SID_AUTO (1 << 7)
739 /* unique ID for auto derivation of RD for this vrf */
742 /* Automatically derived RD for this VRF */
743 struct prefix_rd vrf_prd_auto
;
745 /* RD for this VRF */
746 struct prefix_rd vrf_prd
;
748 /* import rt list for the vrf instance */
749 struct list
*vrf_import_rtl
;
751 /* export rt list for the vrf instance */
752 struct list
*vrf_export_rtl
;
754 /* list of corresponding l2vnis (struct bgpevpn) */
757 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
758 struct bgp_rmap adv_cmd_rmap
[AFI_MAX
][SAFI_MAX
];
760 struct vpn_policy vpn_policy
[AFI_MAX
];
762 struct bgp_pbr_config
*bgp_pbr_cfg
;
764 /* Count of peers in established state */
765 uint32_t established_peers
;
767 /* Weighted ECMP related config. */
768 enum bgp_link_bw_handling lb_handling
;
770 /* Process Queue for handling routes */
771 struct work_queue
*process_queue
;
773 bool fast_convergence
;
775 /* BGP Conditional advertisement */
776 uint32_t condition_check_period
;
777 uint32_t condition_filter_count
;
778 struct thread
*t_condition_check
;
780 /* BGP VPN SRv6 backend */
782 char srv6_locator_name
[SRV6_LOCNAME_SIZE
];
783 struct list
*srv6_locator_chunks
;
784 struct list
*srv6_functions
;
785 uint32_t tovpn_sid_index
; /* unset => set to 0 */
786 struct in6_addr
*tovpn_sid
;
787 struct srv6_locator_chunk
*tovpn_sid_locator
;
788 uint32_t tovpn_sid_transpose_label
;
789 struct in6_addr
*tovpn_zebra_vrf_sid_last_sent
;
791 /* TCP keepalive parameters for BGP connection */
792 uint16_t tcp_keepalive_idle
;
793 uint16_t tcp_keepalive_intvl
;
794 uint16_t tcp_keepalive_probes
;
796 struct timeval ebgprequirespolicywarning
;
797 #define FIFTEENMINUTE2USEC (int64_t)15 * 60 * 1000000
803 DECLARE_QOBJ_TYPE(bgp
);
805 struct bgp_interface
{
806 #define BGP_INTERFACE_MPLS_BGP_FORWARDING (1 << 0)
810 DECLARE_HOOK(bgp_inst_delete
, (struct bgp
*bgp
), (bgp
));
811 DECLARE_HOOK(bgp_inst_config_write
,
812 (struct bgp
*bgp
, struct vty
*vty
),
814 DECLARE_HOOK(bgp_config_end
, (struct bgp
*bgp
), (bgp
));
816 /* Thread callback information */
817 struct afi_safi_info
{
823 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
825 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
826 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
827 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
828 && bgp->vrf_id != VRF_UNKNOWN))
830 #define BGP_SELECT_DEFER_DISABLE(bgp) \
831 (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
833 #define BGP_SUPPRESS_FIB_ENABLED(bgp) \
834 (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING) \
837 /* BGP peer-group support. */
839 /* Name of the peer-group. */
842 /* Pointer to BGP. */
845 /* Peer-group client list. */
848 /** Dynamic neighbor listening ranges */
849 struct list
*listen_range
[AFI_MAX
];
851 /* Peer-group config */
855 /* BGP Notify message format. */
865 /* Next hop self address. */
867 struct interface
*ifp
;
869 struct in6_addr v6_global
;
870 struct in6_addr v6_local
;
873 /* BGP addpath values */
874 #define BGP_ADDPATH_RX 1
875 #define BGP_ADDPATH_TX 2
876 #define BGP_ADDPATH_ID_LEN 4
878 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
880 /* Route map direction */
885 #define BGP_DEFAULT_TTL 1
886 #define BGP_GTSM_HOPS_DISABLED 0
887 #define BGP_GTSM_HOPS_CONNECTED 1
890 #define CONDITION_NON_EXIST false
891 #define CONDITION_EXIST true
893 enum update_type
{ UPDATE_TYPE_WITHDRAW
, UPDATE_TYPE_ADVERTISE
};
897 /* BGP filter structure. */
899 /* Distribute-list. */
902 struct access_list
*alist
;
908 struct prefix_list
*plist
;
914 struct as_list
*aslist
;
915 } aslist
[FILTER_MAX
];
920 struct route_map
*map
;
923 /* Unsuppress-map. */
926 struct route_map
*map
;
932 struct route_map
*amap
;
937 struct route_map
*cmap
;
939 enum update_type update_type
;
943 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
944 a peer who's AS is part of our Confederation. */
946 BGP_PEER_UNSPECIFIED
,
953 /* BGP message header and packet size. */
954 #define BGP_MARKER_SIZE 16
955 #define BGP_HEADER_SIZE 19
956 #define BGP_STANDARD_MESSAGE_MAX_PACKET_SIZE 4096
957 #define BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE 65535
958 #define BGP_MAX_PACKET_SIZE BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
959 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
962 * Trigger delay for bgp_announce_route().
964 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
965 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
968 /* back pointer to the peer */
971 /* which subgroup the peer_af belongs to */
972 struct update_subgroup
*subgroup
;
974 /* for being part of an update subgroup's peer list */
975 LIST_ENTRY(peer_af
) subgrp_train
;
977 /* for being part of a packet's peer list */
978 LIST_ENTRY(peer_af
) pkt_train
;
980 struct bpacket
*next_pkt_to_send
;
983 * Trigger timer for bgp_announce_route().
985 struct thread
*t_announce_route
;
991 /* BGP GR per peer ds */
993 #define BGP_PEER_GR_MODE 5
994 #define BGP_PEER_GR_EVENT_CMD 6
1001 PEER_GLOBAL_INHERIT
/* This is the default mode */
1005 enum peer_gr_command
{
1009 NO_PEER_DISABLE_CMD
,
1014 typedef unsigned int (*bgp_peer_gr_action_ptr
)(struct peer
*, int, int);
1016 struct bgp_peer_gr
{
1017 enum peer_mode next_state
;
1018 bgp_peer_gr_action_ptr action_fun
;
1022 * BGP FSM event codes, per RFC 4271 ss. 8.1
1024 enum bgp_fsm_rfc_codes
{
1025 BGP_FSM_ManualStart
= 1,
1026 BGP_FSM_ManualStop
= 2,
1027 BGP_FSM_AutomaticStart
= 3,
1028 BGP_FSM_ManualStart_with_PassiveTcpEstablishment
= 4,
1029 BGP_FSM_AutomaticStart_with_PassiveTcpEstablishment
= 5,
1030 BGP_FSM_AutomaticStart_with_DampPeerOscillations
= 6,
1031 BGP_FSM_AutomaticStart_with_DampPeerOscillations_and_PassiveTcpEstablishment
=
1033 BGP_FSM_AutomaticStop
= 8,
1034 BGP_FSM_ConnectRetryTimer_Expires
= 9,
1035 BGP_FSM_HoldTimer_Expires
= 10,
1036 BGP_FSM_KeepaliveTimer_Expires
= 11,
1037 BGP_FSM_DelayOpenTimer_Expires
= 12,
1038 BGP_FSM_IdleHoldTimer_Expires
= 13,
1039 BGP_FSM_TcpConnection_Valid
= 14,
1040 BGP_FSM_Tcp_CR_Invalid
= 15,
1041 BGP_FSM_Tcp_CR_Acked
= 16,
1042 BGP_FSM_TcpConnectionConfirmed
= 17,
1043 BGP_FSM_TcpConnectionFails
= 18,
1044 BGP_FSM_BGPOpen
= 19,
1045 BGP_FSM_BGPOpen_with_DelayOpenTimer_running
= 20,
1046 BGP_FSM_BGPHeaderErr
= 21,
1047 BGP_FSM_BGPOpenMsgErr
= 22,
1048 BGP_FSM_OpenCollisionDump
= 23,
1049 BGP_FSM_NotifMsgVerErr
= 24,
1050 BGP_FSM_NotifMsg
= 25,
1051 BGP_FSM_KeepAliveMsg
= 26,
1052 BGP_FSM_UpdateMsg
= 27,
1053 BGP_FSM_UpdateMsgErr
= 28
1057 * BGP finite state machine events
1059 * Note: these do not correspond to RFC-defined event codes. Those are
1060 * defined elsewhere.
1062 enum bgp_fsm_events
{
1065 TCP_connection_open
,
1066 TCP_connection_open_w_delay
,
1067 TCP_connection_closed
,
1068 TCP_connection_open_failed
,
1070 ConnectRetry_timer_expired
,
1072 KeepAlive_timer_expired
,
1073 DelayOpen_timer_expired
,
1074 Receive_OPEN_message
,
1075 Receive_KEEPALIVE_message
,
1076 Receive_UPDATE_message
,
1077 Receive_NOTIFICATION_message
,
1082 /* BGP finite state machine status. */
1083 enum bgp_fsm_status
{
1095 #define PEER_HOSTNAME(peer) ((peer)->host ? (peer)->host : "(unknown peer)")
1098 uint32_t stale_time
;
1102 /* BGP neighbor structure. */
1104 /* BGP structure. */
1107 /* reference count, primarily to allow bgp_process'ing of route_node's
1108 * to be done after a struct peer is deleted.
1110 * named 'lock' for hysterical reasons within Quagga.
1114 /* BGP peer group. */
1115 struct peer_group
*group
;
1116 uint64_t version
[AFI_MAX
][SAFI_MAX
];
1118 /* BGP peer_af structures, per configured AF on this peer */
1119 struct peer_af
*peer_af_array
[BGP_AF_MAX
];
1121 /* Peer's remote AS number. */
1125 /* Peer's local AS number. */
1128 enum bgp_peer_sort sort
;
1130 /* Peer's Change local AS number. */
1131 as_t change_local_as
;
1133 /* Remote router ID. */
1134 struct in_addr remote_id
;
1136 /* Local router ID. */
1137 struct in_addr local_id
;
1139 /* Packet receive and send buffer. */
1140 pthread_mutex_t io_mtx
; // guards ibuf, obuf
1141 struct stream_fifo
*ibuf
; // packets waiting to be processed
1142 struct stream_fifo
*obuf
; // packets waiting to be written
1144 /* used as a block to deposit raw wire data to */
1145 uint8_t ibuf_scratch
[BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
1146 * BGP_READ_PACKET_MAX
];
1147 struct ringbuf
*ibuf_work
; // WiP buffer used by bgp_read() only
1148 struct stream
*obuf_work
; // WiP buffer used to construct packets
1150 struct stream
*curr
; // the current packet being parsed
1152 /* We use a separate stream to encode MP_REACH_NLRI for efficient
1153 * NLRI packing. peer->obuf_work stores all the other attributes. The
1154 * actual packet is then constructed by concatenating the two.
1156 struct stream
*scratch
;
1158 /* the doppelganger peer structure, due to dual TCP conn setup */
1159 struct peer
*doppelganger
;
1161 /* Status of the peer. */
1162 enum bgp_fsm_status status
;
1163 enum bgp_fsm_status ostatus
;
1165 /* FSM events, stored for debug purposes.
1166 * Note: uchar used for reduced memory usage.
1168 enum bgp_fsm_events cur_event
;
1169 enum bgp_fsm_events last_event
;
1170 enum bgp_fsm_events last_major_event
;
1172 /* Peer index, used for dumping TABLE_DUMP_V2 format */
1173 uint16_t table_dump_index
;
1175 /* Peer information */
1176 int fd
; /* File descriptor */
1177 int ttl
; /* TTL of TCP connection to the peer. */
1178 int rtt
; /* Estimated round-trip-time from TCP_INFO */
1179 int rtt_expected
; /* Expected round-trip-time for a peer */
1180 uint8_t rtt_keepalive_rcv
; /* Received count for RTT shutdown */
1181 uint8_t rtt_keepalive_conf
; /* Configured count for RTT shutdown */
1182 int gtsm_hops
; /* minimum hopcount to peer */
1183 char *desc
; /* Description of the peer. */
1184 unsigned short port
; /* Destination port for peer */
1185 char *host
; /* Printable address of the peer. */
1186 union sockunion su
; /* Sockunion address of the peer. */
1187 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
1188 time_t uptime
; /* Last Up/Down time */
1189 time_t readtime
; /* Last read time */
1190 time_t resettime
; /* Last reset time */
1192 char *conf_if
; /* neighbor interface config name. */
1193 struct interface
*ifp
; /* corresponding interface */
1194 char *ifname
; /* bind interface name. */
1196 union sockunion
*update_source
;
1198 union sockunion
*su_local
; /* Sockunion of local address. */
1199 union sockunion
*su_remote
; /* Sockunion of remote address. */
1200 int shared_network
; /* Is this peer shared same network. */
1201 struct bgp_nexthop nexthop
; /* Nexthop */
1203 /* Roles in bgp session */
1205 uint8_t remote_role
;
1206 #define ROLE_PROVIDER 0
1207 #define ROLE_RS_SERVER 1
1208 #define ROLE_RS_CLIENT 2
1209 #define ROLE_CUSTOMER 3
1211 #define ROLE_UNDEFINED 255
1213 #define ROLE_NAME_MAX_LEN 20
1215 /* Peer address family configuration. */
1216 uint8_t afc
[AFI_MAX
][SAFI_MAX
];
1217 uint8_t afc_nego
[AFI_MAX
][SAFI_MAX
];
1218 uint8_t afc_adv
[AFI_MAX
][SAFI_MAX
];
1219 uint8_t afc_recv
[AFI_MAX
][SAFI_MAX
];
1221 /* Capability flags (reset in bgp_stop) */
1223 #define PEER_CAP_REFRESH_ADV (1U << 0) /* refresh advertised */
1224 #define PEER_CAP_REFRESH_OLD_RCV (1U << 1) /* refresh old received */
1225 #define PEER_CAP_REFRESH_NEW_RCV (1U << 2) /* refresh rfc received */
1226 #define PEER_CAP_DYNAMIC_ADV (1U << 3) /* dynamic advertised */
1227 #define PEER_CAP_DYNAMIC_RCV (1U << 4) /* dynamic received */
1228 #define PEER_CAP_RESTART_ADV (1U << 5) /* restart advertised */
1229 #define PEER_CAP_RESTART_RCV (1U << 6) /* restart received */
1230 #define PEER_CAP_AS4_ADV (1U << 7) /* as4 advertised */
1231 #define PEER_CAP_AS4_RCV (1U << 8) /* as4 received */
1232 /* sent graceful-restart restart (R) bit */
1233 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_ADV (1U << 9)
1234 /* received graceful-restart restart (R) bit */
1235 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_RCV (1U << 10)
1236 #define PEER_CAP_ADDPATH_ADV (1U << 11) /* addpath advertised */
1237 #define PEER_CAP_ADDPATH_RCV (1U << 12) /* addpath received */
1238 #define PEER_CAP_ENHE_ADV (1U << 13) /* Extended nexthop advertised */
1239 #define PEER_CAP_ENHE_RCV (1U << 14) /* Extended nexthop received */
1240 #define PEER_CAP_HOSTNAME_ADV (1U << 15) /* hostname advertised */
1241 #define PEER_CAP_HOSTNAME_RCV (1U << 16) /* hostname received */
1242 #define PEER_CAP_ENHANCED_RR_ADV (1U << 17) /* enhanced rr advertised */
1243 #define PEER_CAP_ENHANCED_RR_RCV (1U << 18) /* enhanced rr received */
1244 #define PEER_CAP_EXTENDED_MESSAGE_ADV (1U << 19)
1245 #define PEER_CAP_EXTENDED_MESSAGE_RCV (1U << 20)
1246 #define PEER_CAP_LLGR_ADV (1U << 21)
1247 #define PEER_CAP_LLGR_RCV (1U << 22)
1248 /* sent graceful-restart notification (N) bit */
1249 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_ADV (1U << 23)
1250 /* received graceful-restart notification (N) bit */
1251 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_RCV (1U << 24)
1252 #define PEER_CAP_ROLE_ADV (1U << 25) /* role advertised */
1253 #define PEER_CAP_ROLE_RCV (1U << 26) /* role received */
1255 /* Capability flags (reset in bgp_stop) */
1256 uint32_t af_cap
[AFI_MAX
][SAFI_MAX
];
1257 #define PEER_CAP_ORF_PREFIX_SM_ADV (1U << 0) /* send-mode advertised */
1258 #define PEER_CAP_ORF_PREFIX_RM_ADV (1U << 1) /* receive-mode advertised */
1259 #define PEER_CAP_ORF_PREFIX_SM_RCV (1U << 2) /* send-mode received */
1260 #define PEER_CAP_ORF_PREFIX_RM_RCV (1U << 3) /* receive-mode received */
1261 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1U << 4) /* send-mode received */
1262 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1U << 5) /* receive-mode received */
1263 #define PEER_CAP_RESTART_AF_RCV (1U << 6) /* graceful restart afi/safi received */
1264 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1U << 7) /* graceful restart afi/safi F-bit received */
1265 #define PEER_CAP_ADDPATH_AF_TX_ADV (1U << 8) /* addpath tx advertised */
1266 #define PEER_CAP_ADDPATH_AF_TX_RCV (1U << 9) /* addpath tx received */
1267 #define PEER_CAP_ADDPATH_AF_RX_ADV (1U << 10) /* addpath rx advertised */
1268 #define PEER_CAP_ADDPATH_AF_RX_RCV (1U << 11) /* addpath rx received */
1269 #define PEER_CAP_ENHE_AF_ADV (1U << 12) /* Extended nexthopi afi/safi advertised */
1270 #define PEER_CAP_ENHE_AF_RCV (1U << 13) /* Extended nexthop afi/safi received */
1271 #define PEER_CAP_ENHE_AF_NEGO (1U << 14) /* Extended nexthop afi/safi negotiated */
1272 #define PEER_CAP_LLGR_AF_ADV (1U << 15)
1273 #define PEER_CAP_LLGR_AF_RCV (1U << 16)
1275 /* Global configuration flags. */
1277 * Parallel array to flags that indicates whether each flag originates
1278 * from a peer-group or if it is config that is specific to this
1279 * individual peer. If a flag is set independent of the peer-group, the
1280 * same bit should be set here. If this peer is a peer-group, this
1281 * memory region should be all zeros.
1283 * The assumption is that the default state for all flags is unset,
1284 * so if a flag is unset, the corresponding override flag is unset too.
1285 * However if a flag is set, the corresponding override flag is set.
1287 uint32_t flags_override
;
1289 * Parallel array to flags that indicates whether the default behavior
1290 * of *flags_override* should be inverted. If a flag is unset and the
1291 * corresponding invert flag is set, the corresponding override flag
1292 * would be set. However if a flag is set and the corresponding invert
1293 * flag is unset, the corresponding override flag would be unset.
1295 * This can be used for attributes like *send-community*, which are
1296 * implicitely enabled and have to be disabled explicitely, compared to
1297 * 'normal' attributes like *next-hop-self* which are implicitely set.
1299 * All operations dealing with flags should apply the following boolean
1300 * logic to keep the internal flag system in a sane state:
1302 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1303 * value=0 invert=1 Unset flag unconditionally
1304 * value=1 invert=0 Set flag unconditionally
1305 * value=1 invert=1 Inherit flag if member, otherwise set flag
1307 * Contrary to the implementation of *flags_override*, the flag
1308 * inversion state can be set either on the peer OR the peer *and* the
1309 * peer-group. This was done on purpose, as the inversion state of a
1310 * flag can be determined on either the peer or the peer-group.
1312 * Example: Enabling the cisco configuration mode inverts all flags
1313 * related to *send-community* unconditionally for both peer-groups and
1316 * This behavior is different for interface peers though, which enable
1317 * the *extended-nexthop* flag by default, which regular peers do not.
1318 * As the peer-group can contain both regular and interface peers, the
1319 * flag inversion state must be set on the peer only.
1321 * When a peer inherits the configuration from a peer-group and the
1322 * inversion state of the flag differs between peer and peer-group, the
1323 * newly set value must equal to the inverted state of the peer-group.
1325 uint32_t flags_invert
;
1327 * Effective array for storing the peer/peer-group flags. In case of a
1328 * peer-group, the peer-specific overrides (see flags_override and
1329 * flags_invert) must be respected.
1332 #define PEER_FLAG_PASSIVE (1ULL << 0) /* passive mode */
1333 #define PEER_FLAG_SHUTDOWN (1ULL << 1) /* shutdown */
1334 #define PEER_FLAG_DONT_CAPABILITY (1ULL << 2) /* dont-capability */
1335 #define PEER_FLAG_OVERRIDE_CAPABILITY (1ULL << 3) /* override-capability */
1336 #define PEER_FLAG_STRICT_CAP_MATCH (1ULL << 4) /* strict-match */
1337 #define PEER_FLAG_DYNAMIC_CAPABILITY (1ULL << 5) /* dynamic capability */
1338 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1ULL << 6) /* disable-connected-check */
1339 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1ULL << 7) /* local-as no-prepend */
1340 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1ULL << 8) /* local-as no-prepend replace-as */
1341 #define PEER_FLAG_DELETE (1ULL << 9) /* mark the peer for deleting */
1342 #define PEER_FLAG_CONFIG_NODE (1ULL << 10) /* the node to update configs on */
1343 #define PEER_FLAG_LONESOUL (1ULL << 11)
1344 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1ULL << 12) /* dynamic neighbor */
1345 #define PEER_FLAG_CAPABILITY_ENHE (1ULL << 13) /* Extended next-hop (rfc 5549)*/
1346 #define PEER_FLAG_IFPEER_V6ONLY (1ULL << 14) /* if-based peer is v6 only */
1347 #define PEER_FLAG_IS_RFAPI_HD (1ULL << 15) /* attached to rfapi HD */
1348 #define PEER_FLAG_ENFORCE_FIRST_AS (1ULL << 16) /* enforce-first-as */
1349 #define PEER_FLAG_ROUTEADV (1ULL << 17) /* route advertise */
1350 #define PEER_FLAG_TIMER (1ULL << 18) /* keepalive & holdtime */
1351 #define PEER_FLAG_TIMER_CONNECT (1ULL << 19) /* connect timer */
1352 #define PEER_FLAG_PASSWORD (1ULL << 20) /* password */
1353 #define PEER_FLAG_LOCAL_AS (1ULL << 21) /* local-as */
1354 #define PEER_FLAG_UPDATE_SOURCE (1ULL << 22) /* update-source */
1356 /* BGP-GR Peer related flags */
1357 #define PEER_FLAG_GRACEFUL_RESTART_HELPER (1ULL << 23) /* Helper */
1358 #define PEER_FLAG_GRACEFUL_RESTART (1ULL << 24) /* Graceful Restart */
1359 #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1ULL << 25) /* Global-Inherit */
1360 #define PEER_FLAG_RTT_SHUTDOWN (1ULL << 26) /* shutdown rtt */
1361 #define PEER_FLAG_TIMER_DELAYOPEN (1ULL << 27) /* delayopen timer */
1362 #define PEER_FLAG_TCP_MSS (1ULL << 28) /* tcp-mss */
1363 /* Disable IEEE floating-point link bandwidth encoding in
1364 * extended communities.
1366 #define PEER_FLAG_DISABLE_LINK_BW_ENCODING_IEEE (1ULL << 29)
1367 /* force the extended format for Optional Parameters in OPEN message */
1368 #define PEER_FLAG_EXTENDED_OPT_PARAMS (1ULL << 30)
1370 /* BGP Open Policy flags.
1371 * Enforce using roles on both sides:
1372 * `local-role ROLE strict-mode` configured.
1374 #define PEER_FLAG_ROLE_STRICT_MODE (1ULL << 31)
1375 /* `local-role` configured */
1376 #define PEER_FLAG_ROLE (1ULL << 32)
1377 #define PEER_FLAG_PORT (1ULL << 33)
1378 #define PEER_FLAG_AIGP (1ULL << 34)
1379 #define PEER_FLAG_GRACEFUL_SHUTDOWN (1ULL << 35)
1382 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1383 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1384 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1387 struct bgp_peer_gr PEER_GR_FSM
[BGP_PEER_GR_MODE
][BGP_PEER_GR_EVENT_CMD
];
1388 enum peer_mode peer_gr_present_state
;
1389 /* Non stop forwarding afi-safi count for BGP gr feature*/
1390 uint8_t nsf_af_count
;
1392 uint8_t peer_gr_new_status_flag
;
1393 #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1U << 0)
1394 #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1U << 1)
1395 #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1U << 2)
1397 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1398 char *tx_shutdown_message
;
1400 /* NSF mode (graceful restart) */
1401 uint8_t nsf
[AFI_MAX
][SAFI_MAX
];
1403 time_t eor_stime
[AFI_MAX
][SAFI_MAX
];
1404 /* Last update packet sent time */
1405 time_t pkt_stime
[AFI_MAX
][SAFI_MAX
];
1407 /* Peer Per AF flags */
1409 * Please consult the comments for *flags_override*, *flags_invert* and
1410 * *flags* to understand what these three arrays do. The address-family
1411 * specific attributes are being treated the exact same way as global
1414 uint64_t af_flags_override
[AFI_MAX
][SAFI_MAX
];
1415 uint64_t af_flags_invert
[AFI_MAX
][SAFI_MAX
];
1416 uint64_t af_flags
[AFI_MAX
][SAFI_MAX
];
1417 #define PEER_FLAG_SEND_COMMUNITY (1ULL << 0)
1418 #define PEER_FLAG_SEND_EXT_COMMUNITY (1ULL << 1)
1419 #define PEER_FLAG_NEXTHOP_SELF (1ULL << 2)
1420 #define PEER_FLAG_REFLECTOR_CLIENT (1ULL << 3)
1421 #define PEER_FLAG_RSERVER_CLIENT (1ULL << 4)
1422 #define PEER_FLAG_SOFT_RECONFIG (1ULL << 5)
1423 #define PEER_FLAG_AS_PATH_UNCHANGED (1ULL << 6)
1424 #define PEER_FLAG_NEXTHOP_UNCHANGED (1ULL << 7)
1425 #define PEER_FLAG_MED_UNCHANGED (1ULL << 8)
1426 #define PEER_FLAG_DEFAULT_ORIGINATE (1ULL << 9)
1427 #define PEER_FLAG_REMOVE_PRIVATE_AS (1ULL << 10)
1428 #define PEER_FLAG_ALLOWAS_IN (1ULL << 11)
1429 #define PEER_FLAG_ORF_PREFIX_SM (1ULL << 12)
1430 #define PEER_FLAG_ORF_PREFIX_RM (1ULL << 13)
1431 #define PEER_FLAG_MAX_PREFIX (1ULL << 14)
1432 #define PEER_FLAG_MAX_PREFIX_WARNING (1ULL << 15)
1433 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1ULL << 16)
1434 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1ULL << 17)
1435 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1ULL << 18)
1436 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1ULL << 19)
1437 #define PEER_FLAG_AS_OVERRIDE (1ULL << 20)
1438 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1ULL << 21)
1439 #define PEER_FLAG_WEIGHT (1ULL << 24)
1440 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1ULL << 25)
1441 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1ULL << 26)
1442 #define PEER_FLAG_MAX_PREFIX_OUT (1ULL << 27)
1443 #define PEER_FLAG_MAX_PREFIX_FORCE (1ULL << 28)
1444 #define PEER_FLAG_DISABLE_ADDPATH_RX (1ULL << 29)
1445 #define PEER_FLAG_SOO (1ULL << 30)
1446 #define PEER_FLAG_ACCEPT_OWN (1ULL << 31)
1448 enum bgp_addpath_strat addpath_type
[AFI_MAX
][SAFI_MAX
];
1453 /* default-originate route-map. */
1456 struct route_map
*map
;
1457 } default_rmap
[AFI_MAX
][SAFI_MAX
];
1459 /* Peer status flags. */
1461 #define PEER_STATUS_ACCEPT_PEER (1U << 0) /* accept peer */
1462 #define PEER_STATUS_PREFIX_OVERFLOW (1U << 1) /* prefix-overflow */
1463 #define PEER_STATUS_CAPABILITY_OPEN (1U << 2) /* capability open send */
1464 #define PEER_STATUS_HAVE_ACCEPT (1U << 3) /* accept peer's parent */
1465 #define PEER_STATUS_GROUP (1U << 4) /* peer-group conf */
1466 #define PEER_STATUS_NSF_MODE (1U << 5) /* NSF aware peer */
1467 #define PEER_STATUS_NSF_WAIT (1U << 6) /* wait comeback peer */
1468 /* received extended format encoding for OPEN message */
1469 #define PEER_STATUS_EXT_OPT_PARAMS_LENGTH (1U << 7)
1471 /* Peer status af flags (reset in bgp_stop) */
1472 uint16_t af_sflags
[AFI_MAX
][SAFI_MAX
];
1473 #define PEER_STATUS_ORF_PREFIX_SEND (1U << 0) /* prefix-list send peer */
1474 #define PEER_STATUS_ORF_WAIT_REFRESH (1U << 1) /* wait refresh received peer */
1475 #define PEER_STATUS_PREFIX_THRESHOLD (1U << 2) /* exceed prefix-threshold */
1476 #define PEER_STATUS_PREFIX_LIMIT (1U << 3) /* exceed prefix-limit */
1477 #define PEER_STATUS_EOR_SEND (1U << 4) /* end-of-rib send to peer */
1478 #define PEER_STATUS_EOR_RECEIVED (1U << 5) /* end-of-rib received from peer */
1479 #define PEER_STATUS_ENHANCED_REFRESH (1U << 6) /* Enhanced Route Refresh */
1480 #define PEER_STATUS_BORR_SEND (1U << 7) /* BoRR send to peer */
1481 #define PEER_STATUS_BORR_RECEIVED (1U << 8) /* BoRR received from peer */
1482 #define PEER_STATUS_EORR_SEND (1U << 9) /* EoRR send to peer */
1483 #define PEER_STATUS_EORR_RECEIVED (1U << 10) /* EoRR received from peer */
1484 /* LLGR aware peer */
1485 #define PEER_STATUS_LLGR_WAIT (1U << 11)
1486 #define PEER_STATUS_REFRESH_PENDING (1U << 12) /* refresh request from peer */
1487 #define PEER_STATUS_RTT_SHUTDOWN (1U << 13) /* In shutdown state due to RTT */
1489 /* Configured timer values. */
1490 _Atomic
uint32_t holdtime
;
1491 _Atomic
uint32_t keepalive
;
1492 _Atomic
uint32_t connect
;
1493 _Atomic
uint32_t routeadv
;
1494 _Atomic
uint32_t delayopen
;
1497 _Atomic
uint32_t v_start
;
1498 _Atomic
uint32_t v_connect
;
1499 _Atomic
uint32_t v_holdtime
;
1500 _Atomic
uint32_t v_keepalive
;
1501 _Atomic
uint32_t v_routeadv
;
1502 _Atomic
uint32_t v_delayopen
;
1503 _Atomic
uint32_t v_pmax_restart
;
1504 _Atomic
uint32_t v_gr_restart
;
1507 struct thread
*t_read
;
1508 struct thread
*t_write
;
1509 struct thread
*t_start
;
1510 struct thread
*t_connect_check_r
;
1511 struct thread
*t_connect_check_w
;
1512 struct thread
*t_connect
;
1513 struct thread
*t_holdtime
;
1514 struct thread
*t_routeadv
;
1515 struct thread
*t_delayopen
;
1516 struct thread
*t_pmax_restart
;
1517 struct thread
*t_gr_restart
;
1518 struct thread
*t_gr_stale
;
1519 struct thread
*t_llgr_stale
[AFI_MAX
][SAFI_MAX
];
1520 struct thread
*t_revalidate_all
[AFI_MAX
][SAFI_MAX
];
1521 struct thread
*t_generate_updgrp_packets
;
1522 struct thread
*t_process_packet
;
1523 struct thread
*t_process_packet_error
;
1524 struct thread
*t_refresh_stalepath
;
1527 _Atomic
uint32_t thread_flags
;
1528 #define PEER_THREAD_WRITES_ON (1U << 0)
1529 #define PEER_THREAD_READS_ON (1U << 1)
1530 #define PEER_THREAD_KEEPALIVES_ON (1U << 2)
1531 #define PEER_THREAD_SUBGRP_ADV_DELAY (1U << 3)
1534 struct work_queue
*clear_node_queue
;
1536 #define PEER_TOTAL_RX(peer) \
1537 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1538 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1539 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1540 + atomic_load_explicit(&peer->refresh_in, \
1541 memory_order_relaxed) \
1542 + atomic_load_explicit(&peer->keepalive_in, \
1543 memory_order_relaxed) \
1544 + atomic_load_explicit(&peer->dynamic_cap_in, \
1545 memory_order_relaxed)
1547 #define PEER_TOTAL_TX(peer) \
1548 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1549 + atomic_load_explicit(&peer->update_out, \
1550 memory_order_relaxed) \
1551 + atomic_load_explicit(&peer->notify_out, \
1552 memory_order_relaxed) \
1553 + atomic_load_explicit(&peer->refresh_out, \
1554 memory_order_relaxed) \
1555 + atomic_load_explicit(&peer->keepalive_out, \
1556 memory_order_relaxed) \
1557 + atomic_load_explicit(&peer->dynamic_cap_out, \
1558 memory_order_relaxed)
1560 /* Statistics field */
1561 _Atomic
uint32_t open_in
; /* Open message input count */
1562 _Atomic
uint32_t open_out
; /* Open message output count */
1563 _Atomic
uint32_t update_in
; /* Update message input count */
1564 _Atomic
uint32_t update_out
; /* Update message ouput count */
1565 _Atomic
time_t update_time
; /* Update message received time. */
1566 _Atomic
uint32_t keepalive_in
; /* Keepalive input count */
1567 _Atomic
uint32_t keepalive_out
; /* Keepalive output count */
1568 _Atomic
uint32_t notify_in
; /* Notify input count */
1569 _Atomic
uint32_t notify_out
; /* Notify output count */
1570 _Atomic
uint32_t refresh_in
; /* Route Refresh input count */
1571 _Atomic
uint32_t refresh_out
; /* Route Refresh output count */
1572 _Atomic
uint32_t dynamic_cap_in
; /* Dynamic Capability input count. */
1573 _Atomic
uint32_t dynamic_cap_out
; /* Dynamic Capability output count. */
1575 uint32_t stat_pfx_filter
;
1576 uint32_t stat_pfx_aspath_loop
;
1577 uint32_t stat_pfx_originator_loop
;
1578 uint32_t stat_pfx_cluster_loop
;
1579 uint32_t stat_pfx_nh_invalid
;
1580 uint32_t stat_pfx_dup_withdraw
;
1581 uint32_t stat_upd_7606
; /* RFC7606: treat-as-withdraw */
1583 /* BGP state count */
1584 uint32_t established
; /* Established */
1585 uint32_t dropped
; /* Dropped */
1587 /* Update delay related fields */
1588 uint8_t update_delay_over
; /* When this is set, BGP is no more waiting
1591 /* Syncronization list and time. */
1592 struct bgp_synchronize
*sync
[AFI_MAX
][SAFI_MAX
];
1594 /* timestamp when the last UPDATE msg was written */
1595 _Atomic
time_t last_write
;
1596 /* timestamp when the last msg was written */
1597 _Atomic
time_t last_update
;
1599 /* only updated under io_mtx.
1600 * last_sendq_warn is only for ratelimiting log warning messages.
1602 time_t last_sendq_ok
, last_sendq_warn
;
1605 struct bgp_notify notify
;
1607 /* Filter structure. */
1608 struct bgp_filter filter
[AFI_MAX
][SAFI_MAX
];
1611 * Parallel array to filter that indicates whether each filter
1612 * originates from a peer-group or if it is config that is specific to
1613 * this individual peer. If a filter is set independent of the
1614 * peer-group the appropriate bit should be set here. If this peer is a
1615 * peer-group, this memory region should be all zeros. The assumption
1616 * is that the default state for all flags is unset. Due to filters
1617 * having a direction (e.g. in/out/...), this array has a third
1618 * dimension for storing the overrides independently per direction.
1621 * - if a filter for an individual peer is unset, the corresponding
1622 * override flag is unset and the peer is considered to be back in
1623 * sync with the peer-group.
1624 * - This does *not* contain the filter values, rather it contains
1625 * whether the filter in filter (struct bgp_filter) is peer-specific.
1627 uint8_t filter_override
[AFI_MAX
][SAFI_MAX
][FILTER_MAX
];
1628 #define PEER_FT_DISTRIBUTE_LIST (1U << 0) /* distribute-list */
1629 #define PEER_FT_FILTER_LIST (1U << 1) /* filter-list */
1630 #define PEER_FT_PREFIX_LIST (1U << 2) /* prefix-list */
1631 #define PEER_FT_ROUTE_MAP (1U << 3) /* route-map */
1632 #define PEER_FT_UNSUPPRESS_MAP (1U << 4) /* unsuppress-map */
1633 #define PEER_FT_ADVERTISE_MAP (1U << 5) /* advertise-map */
1635 /* ORF Prefix-list */
1636 struct prefix_list
*orf_plist
[AFI_MAX
][SAFI_MAX
];
1638 /* Text description of last attribute rcvd */
1639 char rcvd_attr_str
[BUFSIZ
];
1641 /* Track if we printed the attribute in debugs */
1642 int rcvd_attr_printed
;
1644 /* Accepted prefix count */
1645 uint32_t pcount
[AFI_MAX
][SAFI_MAX
];
1647 /* Max prefix count. */
1648 uint32_t pmax
[AFI_MAX
][SAFI_MAX
];
1649 uint8_t pmax_threshold
[AFI_MAX
][SAFI_MAX
];
1650 uint16_t pmax_restart
[AFI_MAX
][SAFI_MAX
];
1651 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1653 /* Send prefix count. */
1654 uint32_t pmax_out
[AFI_MAX
][SAFI_MAX
];
1657 char allowas_in
[AFI_MAX
][SAFI_MAX
];
1660 struct ecommunity
*soo
[AFI_MAX
][SAFI_MAX
];
1663 unsigned long weight
[AFI_MAX
][SAFI_MAX
];
1665 /* peer reset cause */
1667 #define PEER_DOWN_RID_CHANGE 1U /* bgp router-id command */
1668 #define PEER_DOWN_REMOTE_AS_CHANGE 2U /* neighbor remote-as command */
1669 #define PEER_DOWN_LOCAL_AS_CHANGE 3U /* neighbor local-as command */
1670 #define PEER_DOWN_CLID_CHANGE 4U /* bgp cluster-id command */
1671 #define PEER_DOWN_CONFED_ID_CHANGE 5U /* bgp confederation id command */
1672 #define PEER_DOWN_CONFED_PEER_CHANGE 6U /* bgp confederation peer command */
1673 #define PEER_DOWN_RR_CLIENT_CHANGE 7U /* neighbor rr-client command */
1674 #define PEER_DOWN_RS_CLIENT_CHANGE 8U /* neighbor rs-client command */
1675 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9U /* neighbor update-source command */
1676 #define PEER_DOWN_AF_ACTIVATE 10U /* neighbor activate command */
1677 #define PEER_DOWN_USER_SHUTDOWN 11U /* neighbor shutdown command */
1678 #define PEER_DOWN_USER_RESET 12U /* clear ip bgp command */
1679 #define PEER_DOWN_NOTIFY_RECEIVED 13U /* notification received */
1680 #define PEER_DOWN_NOTIFY_SEND 14U /* notification send */
1681 #define PEER_DOWN_CLOSE_SESSION 15U /* tcp session close */
1682 #define PEER_DOWN_NEIGHBOR_DELETE 16U /* neghbor delete */
1683 #define PEER_DOWN_RMAP_BIND 17U /* neghbor peer-group command */
1684 #define PEER_DOWN_RMAP_UNBIND 18U /* no neighbor peer-group command */
1685 #define PEER_DOWN_CAPABILITY_CHANGE 19U /* neighbor capability command */
1686 #define PEER_DOWN_PASSIVE_CHANGE 20U /* neighbor passive command */
1687 #define PEER_DOWN_MULTIHOP_CHANGE 21U /* neighbor multihop command */
1688 #define PEER_DOWN_NSF_CLOSE_SESSION 22U /* NSF tcp session close */
1689 #define PEER_DOWN_V6ONLY_CHANGE 23U /* if-based peering v6only toggled */
1690 #define PEER_DOWN_BFD_DOWN 24U /* BFD down */
1691 #define PEER_DOWN_IF_DOWN 25U /* Interface down */
1692 #define PEER_DOWN_NBR_ADDR_DEL 26U /* Peer address lost */
1693 #define PEER_DOWN_WAITING_NHT 27U /* Waiting for NHT to resolve */
1694 #define PEER_DOWN_NBR_ADDR 28U /* Waiting for peer IPv6 IP Addr */
1695 #define PEER_DOWN_VRF_UNINIT 29U /* Associated VRF is not init yet */
1696 #define PEER_DOWN_NOAFI_ACTIVATED 30U /* No AFI/SAFI activated for peer */
1697 #define PEER_DOWN_AS_SETS_REJECT 31U /* Reject routes with AS_SET */
1698 #define PEER_DOWN_WAITING_OPEN 32U /* Waiting for open to succeed */
1699 #define PEER_DOWN_PFX_COUNT 33U /* Reached received prefix count */
1700 #define PEER_DOWN_SOCKET_ERROR 34U /* Some socket error happened */
1701 #define PEER_DOWN_RTT_SHUTDOWN 35U /* Automatically shutdown due to RTT */
1703 * Remember to update peer_down_str in bgp_fsm.c when you add
1704 * a new value to the last_reset reason
1707 uint16_t last_reset_cause_size
;
1708 uint8_t last_reset_cause
[BGP_MAX_PACKET_SIZE
];
1710 /* The kind of route-map Flags.*/
1712 #define PEER_RMAP_TYPE_IN (1U << 0) /* neighbor route-map in */
1713 #define PEER_RMAP_TYPE_OUT (1U << 1) /* neighbor route-map out */
1714 #define PEER_RMAP_TYPE_NETWORK (1U << 2) /* network route-map */
1715 #define PEER_RMAP_TYPE_REDISTRIBUTE (1U << 3) /* redistribute route-map */
1716 #define PEER_RMAP_TYPE_DEFAULT (1U << 4) /* default-originate route-map */
1717 #define PEER_RMAP_TYPE_NOSET (1U << 5) /* not allow to set commands */
1718 #define PEER_RMAP_TYPE_IMPORT (1U << 6) /* neighbor route-map import */
1719 #define PEER_RMAP_TYPE_EXPORT (1U << 7) /* neighbor route-map export */
1720 #define PEER_RMAP_TYPE_AGGREGATE (1U << 8) /* aggregate-address route-map */
1722 /** Peer overwrite configuration. */
1723 struct bfd_session_config
{
1725 * Manual configuration bit.
1727 * This flag only makes sense for real peers (and not groups),
1728 * it keeps track if the user explicitly configured BFD for a
1732 /** Control Plane Independent. */
1734 /** Detection multiplier. */
1735 uint8_t detection_multiplier
;
1736 /** Minimum required RX interval. */
1738 /** Minimum required TX interval. */
1740 /** Profile name. */
1741 char profile
[BFD_PROFILE_NAME_LEN
];
1742 /** Peer BFD session */
1743 struct bfd_session_params
*session
;
1746 /* hostname and domainname advertised by host */
1750 /* Sender side AS path loop detection. */
1751 bool as_path_loop_detection
;
1753 /* Extended Message Support */
1754 uint16_t max_packet_size
;
1756 /* Conditional advertisement */
1757 bool advmap_config_change
[AFI_MAX
][SAFI_MAX
];
1758 bool advmap_table_change
;
1760 /* set TCP max segment size */
1763 /* Long-lived Graceful Restart */
1764 struct llgr_info llgr
[AFI_MAX
][SAFI_MAX
];
1766 bool shut_during_cfg
;
1768 #define BGP_ATTR_MAX 255
1769 /* Path attributes discard */
1770 bool discard_attrs
[BGP_ATTR_MAX
];
1774 DECLARE_QOBJ_TYPE(peer
);
1776 /* Inherit peer attribute from peer-group. */
1777 #define PEER_ATTR_INHERIT(peer, group, attr) \
1778 ((peer)->attr = (group)->conf->attr)
1779 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1781 XFREE(mt, (peer)->attr); \
1782 if ((group)->conf->attr) \
1783 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1785 (peer)->attr = NULL; \
1787 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1790 sockunion_free((peer)->attr); \
1791 if ((group)->conf->attr) \
1792 (peer)->attr = sockunion_dup((group)->conf->attr); \
1794 (peer)->attr = NULL; \
1797 /* Check if suppress start/restart of sessions to peer. */
1798 #define BGP_PEER_START_SUPPRESSED(P) \
1799 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) || \
1800 CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) || \
1801 CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN) || \
1802 (P)->shut_during_cfg)
1804 #define PEER_ROUTE_ADV_DELAY(peer) \
1805 (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
1807 #define PEER_PASSWORD_MINLEN (1)
1808 #define PEER_PASSWORD_MAXLEN (80)
1810 /* This structure's member directly points incoming packet data
1814 uint16_t afi
; /* iana_afi_t */
1817 uint8_t safi
; /* iana_safi_t */
1819 /* Pointer to NLRI byte stream. */
1822 /* Length of whole NLRI. */
1827 #define BGP_VERSION_4 4
1829 /* Default BGP port number. */
1830 #define BGP_PORT_DEFAULT 179
1832 /* Extended BGP Administrative Shutdown Communication */
1833 #define BGP_ADMIN_SHUTDOWN_MSG_LEN 255
1835 /* BGP minimum message size. */
1836 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1837 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1838 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1839 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1840 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1841 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1843 /* BGP message types. */
1844 #define BGP_MSG_OPEN 1
1845 #define BGP_MSG_UPDATE 2
1846 #define BGP_MSG_NOTIFY 3
1847 #define BGP_MSG_KEEPALIVE 4
1848 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1849 #define BGP_MSG_CAPABILITY 6
1850 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1852 /* BGP open optional parameter. */
1853 #define BGP_OPEN_OPT_CAP 2
1855 /* BGP4 attribute type codes. */
1856 #define BGP_ATTR_ORIGIN 1
1857 #define BGP_ATTR_AS_PATH 2
1858 #define BGP_ATTR_NEXT_HOP 3
1859 #define BGP_ATTR_MULTI_EXIT_DISC 4
1860 #define BGP_ATTR_LOCAL_PREF 5
1861 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1862 #define BGP_ATTR_AGGREGATOR 7
1863 #define BGP_ATTR_COMMUNITIES 8
1864 #define BGP_ATTR_ORIGINATOR_ID 9
1865 #define BGP_ATTR_CLUSTER_LIST 10
1866 #define BGP_ATTR_MP_REACH_NLRI 14
1867 #define BGP_ATTR_MP_UNREACH_NLRI 15
1868 #define BGP_ATTR_EXT_COMMUNITIES 16
1869 #define BGP_ATTR_AS4_PATH 17
1870 #define BGP_ATTR_AS4_AGGREGATOR 18
1871 #define BGP_ATTR_PMSI_TUNNEL 22
1872 #define BGP_ATTR_ENCAP 23
1873 #define BGP_ATTR_IPV6_EXT_COMMUNITIES 25
1874 #define BGP_ATTR_AIGP 26
1875 #define BGP_ATTR_LARGE_COMMUNITIES 32
1876 #define BGP_ATTR_OTC 35
1877 #define BGP_ATTR_PREFIX_SID 40
1878 #define BGP_ATTR_SRTE_COLOR 51
1879 #ifdef ENABLE_BGP_VNC_ATTR
1880 #define BGP_ATTR_VNC 255
1883 /* BGP update origin. */
1884 #define BGP_ORIGIN_IGP 0
1885 #define BGP_ORIGIN_EGP 1
1886 #define BGP_ORIGIN_INCOMPLETE 2
1887 #define BGP_ORIGIN_UNSPECIFIED 255
1889 /* BGP notify message codes. */
1890 #define BGP_NOTIFY_HEADER_ERR 1
1891 #define BGP_NOTIFY_OPEN_ERR 2
1892 #define BGP_NOTIFY_UPDATE_ERR 3
1893 #define BGP_NOTIFY_HOLD_ERR 4
1894 #define BGP_NOTIFY_FSM_ERR 5
1895 #define BGP_NOTIFY_CEASE 6
1896 #define BGP_NOTIFY_ROUTE_REFRESH_ERR 7
1898 /* Subcodes for BGP Finite State Machine Error */
1899 #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC 0
1900 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT 1
1901 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
1902 #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
1904 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1906 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1907 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1908 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1909 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1911 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1912 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1913 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1914 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1915 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1916 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1917 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1918 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1919 #define BGP_NOTIFY_OPEN_ROLE_MISMATCH 11
1921 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1922 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1923 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1924 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1925 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1926 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1927 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1928 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1929 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1930 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1931 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1933 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1934 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1935 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1936 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1937 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1938 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1939 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1940 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1941 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1942 #define BGP_NOTIFY_CEASE_HARD_RESET 9
1943 #define BGP_NOTIFY_CEASE_BFD_DOWN 10
1945 /* BGP_NOTIFY_ROUTE_REFRESH_ERR sub codes (RFC 7313). */
1946 #define BGP_NOTIFY_ROUTE_REFRESH_INVALID_MSG_LEN 1
1948 /* BGP route refresh optional subtypes. */
1949 #define BGP_ROUTE_REFRESH_NORMAL 0
1950 #define BGP_ROUTE_REFRESH_BORR 1
1951 #define BGP_ROUTE_REFRESH_EORR 2
1953 /* BGP timers default value. */
1954 #define BGP_INIT_START_TIMER 1
1955 /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1956 * version-/profile-specific values. The values here do not matter, they only
1957 * exist to provide a clear layering separation between core and CLI.
1959 #define BGP_DEFAULT_HOLDTIME 180
1960 #define BGP_DEFAULT_KEEPALIVE 60
1961 #define BGP_DEFAULT_CONNECT_RETRY 120
1963 #define BGP_DEFAULT_EBGP_ROUTEADV 0
1964 #define BGP_DEFAULT_IBGP_ROUTEADV 0
1966 /* BGP RFC 4271 DelayOpenTime default value */
1967 #define BGP_DEFAULT_DELAYOPEN 120
1969 /* BGP default local preference. */
1970 #define BGP_DEFAULT_LOCAL_PREF 100
1972 /* BGP local-preference to send when 'bgp graceful-shutdown'
1974 #define BGP_GSHUT_LOCAL_PREF 0
1976 /* BGP default subgroup packet queue max . */
1977 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1979 /* BGP graceful restart */
1980 #define BGP_DEFAULT_RESTART_TIME 120
1981 #define BGP_DEFAULT_STALEPATH_TIME 360
1982 #define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
1983 #define BGP_DEFAULT_RIB_STALE_TIME 500
1984 #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME 1
1986 /* BGP Long-lived Graceful Restart */
1987 #define BGP_DEFAULT_LLGR_STALE_TIME 0
1989 /* BGP uptime string length. */
1990 #define BGP_UPTIME_LEN 25
1992 /* Default configuration settings for bgpd. */
1993 #define BGP_VTY_PORT 2605
1994 #define BGP_DEFAULT_CONFIG "bgpd.conf"
1996 /* BGP Dynamic Neighbors feature */
1997 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1998 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1999 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 65535
2002 #define BGP_AIGP_TLV_RESERVED 0 /* AIGP Reserved */
2003 #define BGP_AIGP_TLV_METRIC 1 /* AIGP Metric */
2004 #define BGP_AIGP_TLV_METRIC_LEN 11
2005 #define BGP_AIGP_TLV_METRIC_MAX 0xffffffffffffffffULL
2006 #define BGP_AIGP_TLV_METRIC_DESC "Accumulated IGP Metric"
2008 /* Flag for peer_clear_soft(). */
2009 enum bgp_clear_type
{
2010 BGP_CLEAR_SOFT_NONE
,
2013 BGP_CLEAR_SOFT_BOTH
,
2014 BGP_CLEAR_SOFT_IN_ORF_PREFIX
,
2015 BGP_CLEAR_MESSAGE_STATS
2019 #define BGP_INPUT(P) ((P)->curr)
2020 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
2021 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
2022 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
2024 /* BGP error codes. */
2025 enum bgp_create_error_code
{
2028 BGP_ERR_INVALID_VALUE
= -1,
2029 BGP_ERR_INVALID_FLAG
= -2,
2030 BGP_ERR_INVALID_AS
= -3,
2031 BGP_ERR_PEER_GROUP_MEMBER
= -4,
2032 BGP_ERR_PEER_GROUP_NO_REMOTE_AS
= -5,
2033 BGP_ERR_PEER_GROUP_CANT_CHANGE
= -6,
2034 BGP_ERR_PEER_GROUP_MISMATCH
= -7,
2035 BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT
= -8,
2036 BGP_ERR_AS_MISMATCH
= -9,
2037 BGP_ERR_PEER_FLAG_CONFLICT
= -10,
2038 BGP_ERR_PEER_GROUP_SHUTDOWN
= -11,
2039 BGP_ERR_PEER_FILTER_CONFLICT
= -12,
2040 BGP_ERR_NOT_INTERNAL_PEER
= -13,
2041 BGP_ERR_REMOVE_PRIVATE_AS
= -14,
2042 BGP_ERR_AF_UNCONFIGURED
= -15,
2043 BGP_ERR_SOFT_RECONFIG_UNCONFIGURED
= -16,
2044 BGP_ERR_INSTANCE_MISMATCH
= -17,
2045 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS
= -19,
2046 BGP_ERR_TCPSIG_FAILED
= -20,
2047 BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK
= -21,
2048 BGP_ERR_NO_IBGP_WITH_TTLHACK
= -22,
2049 BGP_ERR_NO_INTERFACE_CONFIG
= -23,
2050 BGP_ERR_AS_OVERRIDE
= -25,
2051 BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT
= -26,
2052 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS
= -27,
2053 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND
= -28,
2054 BGP_ERR_INVALID_FOR_DYNAMIC_PEER
= -29,
2055 BGP_ERR_INVALID_FOR_DIRECT_PEER
= -30,
2056 BGP_ERR_PEER_SAFI_CONFLICT
= -31,
2059 BGP_ERR_GR_INVALID_CMD
= -32,
2060 BGP_ERR_GR_OPERATION_FAILED
= -33,
2061 BGP_GR_NO_OPERATION
= -34,
2063 /*BGP Open Policy ERRORS */
2064 BGP_ERR_INVALID_ROLE_NAME
= -35,
2065 BGP_ERR_INVALID_INTERNAL_ROLE
= -36
2069 * Enumeration of different policy kinds a peer can be configured with.
2071 enum bgp_policy_type
{
2072 BGP_POLICY_ROUTE_MAP
,
2073 BGP_POLICY_FILTER_LIST
,
2074 BGP_POLICY_PREFIX_LIST
,
2075 BGP_POLICY_DISTRIBUTE_LIST
,
2078 /* peer_flag_change_type. */
2079 enum peer_change_type
{
2082 peer_change_reset_in
,
2083 peer_change_reset_out
,
2086 extern struct bgp_master
*bm
;
2087 extern unsigned int multipath_num
;
2090 extern void bgp_terminate(void);
2091 extern void bgp_reset(void);
2092 extern void bgp_zclient_reset(void);
2093 extern struct bgp
*bgp_get_default(void);
2094 extern struct bgp
*bgp_lookup(as_t
, const char *);
2095 extern struct bgp
*bgp_lookup_by_name(const char *);
2096 extern struct bgp
*bgp_lookup_by_vrf_id(vrf_id_t
);
2097 extern struct bgp
*bgp_get_evpn(void);
2098 extern void bgp_set_evpn(struct bgp
*bgp
);
2099 extern struct peer
*peer_lookup(struct bgp
*, union sockunion
*);
2100 extern struct peer
*peer_lookup_by_conf_if(struct bgp
*, const char *);
2101 extern struct peer
*peer_lookup_by_hostname(struct bgp
*, const char *);
2102 extern void bgp_peer_conf_if_to_su_update(struct peer
*);
2103 extern int peer_group_listen_range_del(struct peer_group
*, struct prefix
*);
2104 extern struct peer_group
*peer_group_lookup(struct bgp
*, const char *);
2105 extern struct peer_group
*peer_group_get(struct bgp
*, const char *);
2106 extern struct peer
*peer_create_bind_dynamic_neighbor(struct bgp
*,
2108 struct peer_group
*);
2109 extern struct prefix
*
2110 peer_group_lookup_dynamic_neighbor_range(struct peer_group
*, struct prefix
*);
2111 extern struct peer_group
*peer_group_lookup_dynamic_neighbor(struct bgp
*,
2114 extern struct peer
*peer_lookup_dynamic_neighbor(struct bgp
*,
2118 * Peers are incredibly easy to memory leak
2119 * due to the various ways that they are actually used
2120 * Provide some functionality to debug locks and unlocks
2122 extern struct peer
*peer_lock_with_caller(const char *, struct peer
*);
2123 extern struct peer
*peer_unlock_with_caller(const char *, struct peer
*);
2124 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
2125 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
2127 extern enum bgp_peer_sort
peer_sort(struct peer
*peer
);
2128 extern enum bgp_peer_sort
peer_sort_lookup(struct peer
*peer
);
2130 extern bool peer_active(struct peer
*);
2131 extern bool peer_active_nego(struct peer
*);
2132 extern bool peer_afc_received(struct peer
*peer
);
2133 extern bool peer_afc_advertised(struct peer
*peer
);
2134 extern void bgp_recalculate_all_bestpaths(struct bgp
*bgp
);
2135 extern struct peer
*peer_create(union sockunion
*su
, const char *conf_if
,
2136 struct bgp
*bgp
, as_t local_as
, as_t remote_as
,
2137 int as_type
, struct peer_group
*group
,
2139 extern struct peer
*peer_create_accept(struct bgp
*);
2140 extern void peer_xfer_config(struct peer
*dst
, struct peer
*src
);
2141 extern char *peer_uptime(time_t uptime2
, char *buf
, size_t len
, bool use_json
,
2144 extern int bgp_config_write(struct vty
*);
2146 extern void bgp_master_init(struct thread_master
*master
, const int buffer_size
,
2147 struct list
*addresses
);
2149 extern void bgp_init(unsigned short instance
);
2150 extern void bgp_pthreads_run(void);
2151 extern void bgp_pthreads_finish(void);
2152 extern void bgp_route_map_init(void);
2153 extern void bgp_session_reset(struct peer
*);
2155 extern int bgp_option_set(int);
2156 extern int bgp_option_unset(int);
2157 extern int bgp_option_check(int);
2159 /* set the bgp no-rib option during runtime and remove installed routes */
2160 extern void bgp_option_norib_set_runtime(void);
2162 /* unset the bgp no-rib option during runtime and reset all peers */
2163 extern void bgp_option_norib_unset_runtime(void);
2165 extern int bgp_get(struct bgp
**bgp
, as_t
*as
, const char *name
,
2166 enum bgp_instance_type kind
, const char *as_pretty
);
2167 extern void bgp_instance_up(struct bgp
*);
2168 extern void bgp_instance_down(struct bgp
*);
2169 extern int bgp_delete(struct bgp
*);
2171 extern int bgp_handle_socket(struct bgp
*bgp
, struct vrf
*vrf
,
2172 vrf_id_t old_vrf_id
, bool create
);
2174 extern void bgp_router_id_zebra_bump(vrf_id_t
, const struct prefix
*);
2175 extern void bgp_router_id_static_set(struct bgp
*, struct in_addr
);
2177 extern void bm_wait_for_fib_set(bool set
);
2178 extern void bgp_suppress_fib_pending_set(struct bgp
*bgp
, bool set
);
2179 extern void bgp_cluster_id_set(struct bgp
*bgp
, struct in_addr
*cluster_id
);
2180 extern void bgp_cluster_id_unset(struct bgp
*bgp
);
2182 extern void bgp_confederation_id_set(struct bgp
*bgp
, as_t as
);
2183 extern void bgp_confederation_id_unset(struct bgp
*bgp
);
2184 extern bool bgp_confederation_peers_check(struct bgp
*, as_t
);
2186 extern void bgp_confederation_peers_add(struct bgp
*bgp
, as_t as
);
2187 extern void bgp_confederation_peers_remove(struct bgp
*bgp
, as_t as
);
2189 extern void bgp_timers_set(struct bgp
*, uint32_t keepalive
, uint32_t holdtime
,
2190 uint32_t connect_retry
, uint32_t delayopen
);
2191 extern void bgp_timers_unset(struct bgp
*);
2193 extern void bgp_default_local_preference_set(struct bgp
*bgp
,
2194 uint32_t local_pref
);
2195 extern void bgp_default_local_preference_unset(struct bgp
*bgp
);
2197 extern void bgp_default_subgroup_pkt_queue_max_set(struct bgp
*bgp
,
2198 uint32_t queue_size
);
2199 extern void bgp_default_subgroup_pkt_queue_max_unset(struct bgp
*bgp
);
2201 extern void bgp_listen_limit_set(struct bgp
*bgp
, int listen_limit
);
2202 extern void bgp_listen_limit_unset(struct bgp
*bgp
);
2204 extern bool bgp_update_delay_active(struct bgp
*);
2205 extern bool bgp_update_delay_configured(struct bgp
*);
2206 extern bool bgp_afi_safi_peer_exists(struct bgp
*bgp
, afi_t afi
, safi_t safi
);
2207 extern void peer_as_change(struct peer
*, as_t
, int);
2208 extern int peer_remote_as(struct bgp
*, union sockunion
*, const char *, as_t
*,
2210 extern int peer_group_remote_as(struct bgp
*, const char *, as_t
*, int);
2211 extern int peer_delete(struct peer
*peer
);
2212 extern void peer_notify_unconfig(struct peer
*peer
);
2213 extern int peer_group_delete(struct peer_group
*);
2214 extern int peer_group_remote_as_delete(struct peer_group
*);
2215 extern int peer_group_listen_range_add(struct peer_group
*, struct prefix
*);
2216 extern void peer_group_notify_unconfig(struct peer_group
*group
);
2218 extern int peer_activate(struct peer
*, afi_t
, safi_t
);
2219 extern int peer_deactivate(struct peer
*, afi_t
, safi_t
);
2221 extern int peer_group_bind(struct bgp
*, union sockunion
*, struct peer
*,
2222 struct peer_group
*, as_t
*);
2224 extern int peer_flag_set(struct peer
*peer
, uint64_t flag
);
2225 extern int peer_flag_unset(struct peer
*peer
, uint64_t flag
);
2226 extern void peer_flag_inherit(struct peer
*peer
, uint64_t flag
);
2228 extern int peer_af_flag_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2230 extern int peer_af_flag_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
2232 extern int peer_af_flag_check(struct peer
*, afi_t
, safi_t
, uint32_t);
2233 extern void peer_af_flag_inherit(struct peer
*peer
, afi_t afi
, safi_t safi
,
2235 extern void peer_change_action(struct peer
*peer
, afi_t afi
, safi_t safi
,
2236 enum peer_change_type type
);
2238 extern int peer_ebgp_multihop_set(struct peer
*, int);
2239 extern int peer_ebgp_multihop_unset(struct peer
*);
2240 extern int is_ebgp_multihop_configured(struct peer
*peer
);
2242 extern int peer_role_set(struct peer
*peer
, uint8_t role
, bool strict_mode
);
2243 extern int peer_role_unset(struct peer
*peer
);
2245 extern void peer_description_set(struct peer
*, const char *);
2246 extern void peer_description_unset(struct peer
*);
2248 extern int peer_update_source_if_set(struct peer
*, const char *);
2249 extern void peer_update_source_addr_set(struct peer
*peer
,
2250 const union sockunion
*su
);
2251 extern void peer_update_source_unset(struct peer
*peer
);
2253 extern int peer_default_originate_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2255 struct route_map
*route_map
);
2256 extern int peer_default_originate_unset(struct peer
*, afi_t
, safi_t
);
2257 extern void bgp_tcp_keepalive_set(struct bgp
*bgp
, uint16_t idle
,
2258 uint16_t interval
, uint16_t probes
);
2259 extern void bgp_tcp_keepalive_unset(struct bgp
*bgp
);
2261 extern void peer_port_set(struct peer
*, uint16_t);
2262 extern void peer_port_unset(struct peer
*);
2264 extern int peer_weight_set(struct peer
*, afi_t
, safi_t
, uint16_t);
2265 extern int peer_weight_unset(struct peer
*, afi_t
, safi_t
);
2267 extern int peer_timers_set(struct peer
*, uint32_t keepalive
,
2269 extern int peer_timers_unset(struct peer
*);
2271 extern int peer_timers_connect_set(struct peer
*, uint32_t);
2272 extern int peer_timers_connect_unset(struct peer
*);
2274 extern int peer_advertise_interval_set(struct peer
*, uint32_t);
2275 extern int peer_advertise_interval_unset(struct peer
*);
2277 extern int peer_timers_delayopen_set(struct peer
*peer
, uint32_t delayopen
);
2278 extern int peer_timers_delayopen_unset(struct peer
*peer
);
2280 extern void peer_interface_set(struct peer
*, const char *);
2281 extern void peer_interface_unset(struct peer
*);
2283 extern int peer_distribute_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2284 extern int peer_distribute_unset(struct peer
*, afi_t
, safi_t
, int);
2286 extern int peer_allowas_in_set(struct peer
*, afi_t
, safi_t
, int, int);
2287 extern int peer_allowas_in_unset(struct peer
*, afi_t
, safi_t
);
2289 extern int peer_local_as_set(struct peer
*, as_t
, bool no_prepend
,
2291 extern int peer_local_as_unset(struct peer
*);
2293 extern int peer_prefix_list_set(struct peer
*, afi_t
, safi_t
, int,
2295 extern int peer_prefix_list_unset(struct peer
*, afi_t
, safi_t
, int);
2297 extern int peer_aslist_set(struct peer
*, afi_t
, safi_t
, int, const char *);
2298 extern int peer_aslist_unset(struct peer
*, afi_t
, safi_t
, int);
2300 extern int peer_route_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
, int,
2301 const char *name
, struct route_map
*route_map
);
2302 extern int peer_route_map_unset(struct peer
*, afi_t
, safi_t
, int);
2304 extern int peer_unsuppress_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2306 struct route_map
*route_map
);
2308 extern int peer_advertise_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
2309 const char *advertise_name
,
2310 struct route_map
*advertise_map
,
2311 const char *condition_name
,
2312 struct route_map
*condition_map
,
2315 extern int peer_password_set(struct peer
*, const char *);
2316 extern int peer_password_unset(struct peer
*);
2318 extern int peer_unsuppress_map_unset(struct peer
*, afi_t
, safi_t
);
2320 extern int peer_advertise_map_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
2321 const char *advertise_name
,
2322 struct route_map
*advertise_map
,
2323 const char *condition_name
,
2324 struct route_map
*condition_map
,
2327 extern int peer_maximum_prefix_set(struct peer
*, afi_t
, safi_t
, uint32_t,
2328 uint8_t, int, uint16_t, bool force
);
2329 extern int peer_maximum_prefix_unset(struct peer
*, afi_t
, safi_t
);
2331 extern void peer_maximum_prefix_out_refresh_routes(struct peer
*peer
, afi_t afi
,
2333 extern int peer_maximum_prefix_out_set(struct peer
*peer
, afi_t afi
,
2334 safi_t safi
, uint32_t max
);
2335 extern int peer_maximum_prefix_out_unset(struct peer
*peer
, afi_t afi
,
2338 extern int peer_clear(struct peer
*, struct listnode
**);
2339 extern int peer_clear_soft(struct peer
*, afi_t
, safi_t
, enum bgp_clear_type
);
2341 extern int peer_ttl_security_hops_set(struct peer
*, int);
2342 extern int peer_ttl_security_hops_unset(struct peer
*);
2344 extern void peer_tx_shutdown_message_set(struct peer
*, const char *msg
);
2345 extern void peer_tx_shutdown_message_unset(struct peer
*);
2347 extern void bgp_route_map_update_timer(struct thread
*thread
);
2348 extern const char *bgp_get_name_by_role(uint8_t role
);
2350 extern void bgp_route_map_terminate(void);
2352 extern int peer_cmp(struct peer
*p1
, struct peer
*p2
);
2354 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi
, iana_safi_t pkt_safi
,
2355 afi_t
*afi
, safi_t
*safi
);
2356 extern int bgp_map_afi_safi_int2iana(afi_t afi
, safi_t safi
,
2357 iana_afi_t
*pkt_afi
,
2358 iana_safi_t
*pkt_safi
);
2360 extern struct peer_af
*peer_af_create(struct peer
*, afi_t
, safi_t
);
2361 extern struct peer_af
*peer_af_find(struct peer
*, afi_t
, safi_t
);
2362 extern int peer_af_delete(struct peer
*, afi_t
, safi_t
);
2364 extern void bgp_shutdown_enable(struct bgp
*bgp
, const char *msg
);
2365 extern void bgp_shutdown_disable(struct bgp
*bgp
);
2367 extern void bgp_close(void);
2368 extern void bgp_free(struct bgp
*);
2369 void bgp_gr_apply_running_config(void);
2372 int bgp_global_gr_init(struct bgp
*bgp
);
2373 int bgp_peer_gr_init(struct peer
*peer
);
2376 #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list) \
2378 struct peer *peer_loop; \
2379 bool gr_router_detected = false; \
2380 struct listnode *node = {0}; \
2381 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) { \
2382 if (CHECK_FLAG(peer_loop->flags, \
2383 PEER_FLAG_GRACEFUL_RESTART)) \
2384 gr_router_detected = true; \
2386 if (gr_router_detected \
2387 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
2388 bgp_zebra_send_capabilities(_bgp, false); \
2389 } else if (!gr_router_detected \
2390 && _bgp->present_zebra_gr_state \
2391 == ZEBRA_GR_ENABLE) { \
2392 bgp_zebra_send_capabilities(_bgp, true); \
2396 static inline struct bgp
*bgp_lock(struct bgp
*bgp
)
2402 static inline void bgp_unlock(struct bgp
*bgp
)
2404 assert(bgp
->lock
> 0);
2405 if (--bgp
->lock
== 0)
2409 static inline int afindex(afi_t afi
, safi_t safi
)
2415 return BGP_AF_IPV4_UNICAST
;
2416 case SAFI_MULTICAST
:
2417 return BGP_AF_IPV4_MULTICAST
;
2418 case SAFI_LABELED_UNICAST
:
2419 return BGP_AF_IPV4_LBL_UNICAST
;
2421 return BGP_AF_IPV4_VPN
;
2423 return BGP_AF_IPV4_ENCAP
;
2425 return BGP_AF_IPV4_FLOWSPEC
;
2435 return BGP_AF_IPV6_UNICAST
;
2436 case SAFI_MULTICAST
:
2437 return BGP_AF_IPV6_MULTICAST
;
2438 case SAFI_LABELED_UNICAST
:
2439 return BGP_AF_IPV6_LBL_UNICAST
;
2441 return BGP_AF_IPV6_VPN
;
2443 return BGP_AF_IPV6_ENCAP
;
2445 return BGP_AF_IPV6_FLOWSPEC
;
2455 return BGP_AF_L2VPN_EVPN
;
2457 case SAFI_MULTICAST
:
2458 case SAFI_LABELED_UNICAST
:
2472 assert(!"Reached end of function we should never hit");
2475 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
2476 static inline int peer_group_active(struct peer
*peer
)
2478 if (!CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
) && peer
->group
)
2483 /* If peer is negotiated at least one address family return 1. */
2484 static inline int peer_afi_active_nego(const struct peer
*peer
, afi_t afi
)
2486 if (peer
->afc_nego
[afi
][SAFI_UNICAST
]
2487 || peer
->afc_nego
[afi
][SAFI_MULTICAST
]
2488 || peer
->afc_nego
[afi
][SAFI_LABELED_UNICAST
]
2489 || peer
->afc_nego
[afi
][SAFI_MPLS_VPN
]
2490 || peer
->afc_nego
[afi
][SAFI_ENCAP
]
2491 || peer
->afc_nego
[afi
][SAFI_FLOWSPEC
]
2492 || peer
->afc_nego
[afi
][SAFI_EVPN
])
2497 /* If at least one address family activated for group, return 1. */
2498 static inline int peer_group_af_configured(struct peer_group
*group
)
2500 struct peer
*peer
= group
->conf
;
2502 if (peer
->afc
[AFI_IP
][SAFI_UNICAST
] || peer
->afc
[AFI_IP
][SAFI_MULTICAST
]
2503 || peer
->afc
[AFI_IP
][SAFI_LABELED_UNICAST
]
2504 || peer
->afc
[AFI_IP
][SAFI_FLOWSPEC
]
2505 || peer
->afc
[AFI_IP
][SAFI_MPLS_VPN
] || peer
->afc
[AFI_IP
][SAFI_ENCAP
]
2506 || peer
->afc
[AFI_IP6
][SAFI_UNICAST
]
2507 || peer
->afc
[AFI_IP6
][SAFI_MULTICAST
]
2508 || peer
->afc
[AFI_IP6
][SAFI_LABELED_UNICAST
]
2509 || peer
->afc
[AFI_IP6
][SAFI_MPLS_VPN
]
2510 || peer
->afc
[AFI_IP6
][SAFI_ENCAP
]
2511 || peer
->afc
[AFI_IP6
][SAFI_FLOWSPEC
]
2512 || peer
->afc
[AFI_L2VPN
][SAFI_EVPN
])
2517 static inline char *timestamp_string(time_t ts
)
2520 tbuf
= time(NULL
) - (monotime(NULL
) - ts
);
2521 return ctime(&tbuf
);
2524 static inline bool peer_established(struct peer
*peer
)
2526 return peer
->status
== Established
;
2529 static inline bool peer_dynamic_neighbor(struct peer
*peer
)
2531 return CHECK_FLAG(peer
->flags
, PEER_FLAG_DYNAMIC_NEIGHBOR
);
2534 static inline bool peer_dynamic_neighbor_no_nsf(struct peer
*peer
)
2536 return (peer_dynamic_neighbor(peer
) &&
2537 !CHECK_FLAG(peer
->sflags
, PEER_STATUS_NSF_WAIT
));
2540 static inline int peer_cap_enhe(struct peer
*peer
, afi_t afi
, safi_t safi
)
2542 return (CHECK_FLAG(peer
->af_cap
[afi
][safi
], PEER_CAP_ENHE_AF_NEGO
));
2545 /* Lookup VRF for BGP instance based on its type. */
2546 static inline struct vrf
*bgp_vrf_lookup_by_instance_type(struct bgp
*bgp
)
2550 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_DEFAULT
)
2551 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
2552 else if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
)
2553 vrf
= vrf_lookup_by_name(bgp
->name
);
2560 static inline uint32_t bgp_vrf_interfaces(struct bgp
*bgp
, bool active
)
2563 struct interface
*ifp
;
2566 /* if there is one interface in the vrf which is up then it is deemed
2569 vrf
= bgp_vrf_lookup_by_instance_type(bgp
);
2572 RB_FOREACH (ifp
, if_name_head
, &vrf
->ifaces_by_name
) {
2573 if (strcmp(ifp
->name
, bgp
->name
) == 0)
2575 if (!active
|| if_is_up(ifp
))
2581 /* Link BGP instance to VRF. */
2582 static inline void bgp_vrf_link(struct bgp
*bgp
, struct vrf
*vrf
)
2584 bgp
->vrf_id
= vrf
->vrf_id
;
2585 if (vrf
->info
!= (void *)bgp
)
2586 vrf
->info
= (void *)bgp_lock(bgp
);
2589 /* Unlink BGP instance from VRF. */
2590 static inline void bgp_vrf_unlink(struct bgp
*bgp
, struct vrf
*vrf
)
2592 if (vrf
->info
== (void *)bgp
) {
2596 bgp
->vrf_id
= VRF_UNKNOWN
;
2599 static inline bool bgp_in_graceful_shutdown(struct bgp
*bgp
)
2601 /* True if either set for this instance or globally */
2602 return (!!CHECK_FLAG(bgp
->flags
, BGP_FLAG_GRACEFUL_SHUTDOWN
) ||
2603 !!CHECK_FLAG(bm
->flags
, BM_FLAG_GRACEFUL_SHUTDOWN
));
2606 /* For benefit of rfapi */
2607 extern struct peer
*peer_new(struct bgp
*bgp
);
2609 extern struct peer
*peer_lookup_in_view(struct vty
*vty
, struct bgp
*bgp
,
2610 const char *ip_str
, bool use_json
);
2611 extern int bgp_lookup_by_as_name_type(struct bgp
**bgp_val
, as_t
*as
,
2613 enum bgp_instance_type inst_type
);
2616 DECLARE_HOOK(bgp_vrf_status_changed
, (struct bgp
*bgp
, struct interface
*ifp
),
2618 DECLARE_HOOK(peer_status_changed
, (struct peer
*peer
), (peer
));
2619 DECLARE_HOOK(bgp_snmp_init_stats
, (struct bgp
*bgp
), (bgp
));
2620 DECLARE_HOOK(bgp_snmp_update_last_changed
, (struct bgp
*bgp
), (bgp
));
2621 DECLARE_HOOK(bgp_snmp_update_stats
,
2622 (struct bgp_node
*rn
, struct bgp_path_info
*pi
, bool added
),
2624 DECLARE_HOOK(bgp_rpki_prefix_status
,
2625 (struct peer
* peer
, struct attr
*attr
,
2626 const struct prefix
*prefix
),
2627 (peer
, attr
, prefix
));
2629 void peer_nsf_stop(struct peer
*peer
);
2631 void peer_tcp_mss_set(struct peer
*peer
, uint32_t tcp_mss
);
2632 void peer_tcp_mss_unset(struct peer
*peer
);
2634 extern void bgp_recalculate_afi_safi_bestpaths(struct bgp
*bgp
, afi_t afi
,
2636 extern void peer_on_policy_change(struct peer
*peer
, afi_t afi
, safi_t safi
,
2638 extern bool bgp_path_attribute_discard(struct peer
*peer
, char *buf
,
2640 #ifdef _FRR_ATTRIBUTE_PRINTFRR
2641 /* clang-format off */
2642 #pragma FRR printfrr_ext "%pBP" (struct peer *)
2643 /* clang-format on */
2646 #endif /* _QUAGGA_BGPD_H */