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"
34 /* For union sockunion. */
36 #include "sockunion.h"
40 #include "bgp_memory.h"
43 #include "bgp_labelpool.h"
44 #include "bgp_addpath_types.h"
45 #include "bgp_nexthop.h"
47 #define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
48 #define BGP_PEER_MAX_HASH_SIZE 16384
50 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
51 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
53 struct update_subgroup
;
55 struct bgp_pbr_config
;
58 * Allow the neighbor XXXX remote-as to take internal or external
59 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
63 enum { AS_UNSPECIFIED
= 0,
69 /* Zebra Gracaful Restart states */
75 /* Typedef BGP specific types. */
76 typedef uint32_t as_t
;
77 typedef uint16_t as16_t
; /* we may still encounter 16 Bit asnums */
78 typedef uint16_t bgp_size_t
;
82 __typeof__(a) _a = (a); \
83 __typeof__(b) _b = (b); \
89 BGP_AF_IPV4_UNICAST
= BGP_AF_START
,
90 BGP_AF_IPV4_MULTICAST
,
93 BGP_AF_IPV6_MULTICAST
,
98 BGP_AF_IPV4_LBL_UNICAST
,
99 BGP_AF_IPV6_LBL_UNICAST
,
100 BGP_AF_IPV4_FLOWSPEC
,
101 BGP_AF_IPV6_FLOWSPEC
,
105 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
107 #define FOREACH_SAFI(safi) \
108 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
110 extern struct frr_pthread
*bgp_pth_io
;
111 extern struct frr_pthread
*bgp_pth_ka
;
113 /* BGP master for system wide configurations and variables. */
115 /* BGP instance list. */
118 /* BGP thread master. */
119 struct thread_master
*master
;
121 /* Listening sockets */
122 struct list
*listen_sockets
;
124 /* BGP port number. */
127 /* Listener address */
131 struct hash
*self_mac_hash
;
133 /* BGP start time. */
136 /* Various BGP global configuration. */
138 #define BGP_OPT_NO_FIB (1 << 0)
139 #define BGP_OPT_NO_LISTEN (1 << 1)
140 #define BGP_OPT_NO_ZEBRA (1 << 2)
142 uint64_t updgrp_idspace
;
143 uint64_t subgrp_idspace
;
145 /* timer to dampen route map changes */
146 struct thread
*t_rmap_update
; /* Handle route map updates */
147 uint32_t rmap_update_timer
; /* Route map update timer */
148 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
150 /* Id space for automatic RD derivation for an EVI/VRF */
151 bitfield_t rd_idspace
;
153 /* dynamic mpls label allocation pool */
154 struct labelpool labelpool
;
156 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
157 struct bgp
* bgp_evpn
;
159 /* How big should we set the socket buffer size */
160 uint32_t socket_buffer
;
162 /* EVPN multihoming */
163 struct bgp_evpn_mh_info
*mh_info
;
165 /* global update-delay timer values */
166 uint16_t v_update_delay
;
167 uint16_t v_establish_wait
;
170 #define BM_FLAG_GRACEFUL_SHUTDOWN (1 << 0)
172 bool terminating
; /* global flag that sigint terminate seen */
175 DECLARE_QOBJ_TYPE(bgp_master
)
177 /* BGP route-map structure. */
180 struct route_map
*map
;
184 unsigned short instance
;
186 /* BGP redistribute metric configuration. */
187 uint8_t redist_metric_flag
;
188 uint32_t redist_metric
;
190 /* BGP redistribute route-map. */
191 struct bgp_rmap rmap
;
195 BGP_VPN_POLICY_DIR_FROMVPN
= 0,
196 BGP_VPN_POLICY_DIR_TOVPN
= 1,
197 BGP_VPN_POLICY_DIR_MAX
= 2
198 } vpn_policy_direction_t
;
201 struct bgp
*bgp
; /* parent */
203 struct ecommunity
*rtlist
[BGP_VPN_POLICY_DIR_MAX
];
204 struct ecommunity
*import_redirect_rtlist
;
205 char *rmap_name
[BGP_VPN_POLICY_DIR_MAX
];
206 struct route_map
*rmap
[BGP_VPN_POLICY_DIR_MAX
];
208 /* should be mpls_label_t? */
209 uint32_t tovpn_label
; /* may be MPLS_LABEL_NONE */
210 uint32_t tovpn_zebra_vrf_label_last_sent
;
211 struct prefix_rd tovpn_rd
;
212 struct prefix tovpn_nexthop
; /* unset => set to 0 */
214 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
215 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
216 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
219 * If we are importing another vrf into us keep a list of
220 * vrf names that are being imported into us.
222 struct list
*import_vrf
;
225 * if we are being exported to another vrf keep a list of
226 * vrf names that we are being exported to.
228 struct list
*export_vrf
;
232 * Type of 'struct bgp'.
233 * - Default: The default instance
234 * - VRF: A specific (non-default) VRF
235 * - View: An instance used for route exchange
236 * The "default" instance is treated separately to simplify the code. Note
237 * that if deployed in a Multi-VRF environment, it may not exist.
239 enum bgp_instance_type
{
240 BGP_INSTANCE_TYPE_DEFAULT
,
241 BGP_INSTANCE_TYPE_VRF
,
242 BGP_INSTANCE_TYPE_VIEW
245 #define BGP_SEND_EOR(bgp, afi, safi) \
246 (!CHECK_FLAG(bgp->flags, BGP_FLAG_GR_DISABLE_EOR) \
247 && ((bgp->gr_info[afi][safi].t_select_deferral == NULL) \
248 || (bgp->gr_info[afi][safi].eor_required \
249 == bgp->gr_info[afi][safi].eor_received)))
251 /* BGP GR Global ds */
253 #define BGP_GLOBAL_GR_MODE 4
254 #define BGP_GLOBAL_GR_EVENT_CMD 4
256 /* Graceful restart selection deferral timer info */
257 struct graceful_restart_info
{
258 /* Count of EOR message expected */
259 uint32_t eor_required
;
260 /* Count of EOR received */
261 uint32_t eor_received
;
263 struct thread
*t_select_deferral
;
264 /* Routes Deferred */
265 uint32_t gr_deferred
;
266 /* Best route select */
267 struct thread
*t_route_select
;
268 /* AFI, SAFI enabled */
269 bool af_enabled
[AFI_MAX
][SAFI_MAX
];
270 /* Route update completed */
271 bool route_sync
[AFI_MAX
][SAFI_MAX
];
275 GLOBAL_HELPER
= 0, /* This is the default mode */
281 enum global_gr_command
{
285 NO_GLOBAL_DISABLE_CMD
288 #define BGP_GR_SUCCESS 0
289 #define BGP_GR_FAILURE 1
291 /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
292 * do weighted ECMP. Note: This applies after multipath computation.
294 enum bgp_link_bw_handling
{
295 /* Do ECMP if some paths don't have LB - default */
297 /* Completely ignore LB, just do regular ECMP */
298 BGP_LINK_BW_IGNORE_BW
,
299 /* Skip paths without LB, do wECMP on others */
300 BGP_LINK_BW_SKIP_MISSING
,
301 /* Do wECMP with default weight for paths not having LB */
302 BGP_LINK_BW_DEFWT_4_MISSING
305 /* BGP instance structure. */
307 /* AS number of this BGP instance. */
310 /* Name of this BGP instance. */
312 char *name_pretty
; /* printable "VRF|VIEW name|default" */
314 /* Type of instance and VRF id. */
315 enum bgp_instance_type inst_type
;
318 /* Reference count to allow peer_delete to finish after bgp_delete */
322 struct peer
*peer_self
;
326 struct hash
*peerhash
;
328 /* BGP peer group. */
331 /* The maximum number of BGP dynamic neighbors that can be created */
332 int dynamic_neighbors_limit
;
334 /* The current number of BGP dynamic neighbors */
335 int dynamic_neighbors_count
;
337 struct hash
*update_groups
[BGP_AF_MAX
];
340 * Global statistics for update groups.
343 uint32_t join_events
;
344 uint32_t prune_events
;
345 uint32_t merge_events
;
346 uint32_t split_events
;
347 uint32_t updgrp_switch_events
;
348 uint32_t peer_refreshes_combined
;
350 uint32_t merge_checks_triggered
;
352 uint32_t updgrps_created
;
353 uint32_t updgrps_deleted
;
354 uint32_t subgrps_created
;
355 uint32_t subgrps_deleted
;
356 } update_group_stats
;
358 /* BGP configuration. */
360 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
361 #define BGP_CONFIG_CONFEDERATION (1 << 1)
363 /* BGP router identifier. */
364 struct in_addr router_id
;
365 struct in_addr router_id_static
;
366 struct in_addr router_id_zebra
;
368 /* BGP route reflector cluster ID. */
369 struct in_addr cluster_id
;
371 /* BGP confederation information. */
374 int confed_peers_cnt
;
377 *t_startup
; /* start-up timer on only once at the beginning */
379 uint32_t v_maxmed_onstartup
; /* Duration of max-med on start-up */
380 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
381 uint32_t maxmed_onstartup_value
; /* Max-med value when active on
384 *t_maxmed_onstartup
; /* non-null when max-med onstartup is on */
385 uint8_t maxmed_onstartup_over
; /* Flag to make it effective only once */
387 bool v_maxmed_admin
; /* true/false if max-med administrative is on/off
389 #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
390 uint32_t maxmed_admin_value
; /* Max-med value when administrative in on
392 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
394 uint8_t maxmed_active
; /* 1/0 if max-med is active or not */
395 uint32_t maxmed_value
; /* Max-med value when its active */
397 /* BGP update delay on startup */
398 struct thread
*t_update_delay
;
399 struct thread
*t_establish_wait
;
400 uint8_t update_delay_over
;
401 uint8_t main_zebra_update_hold
;
402 uint8_t main_peers_update_hold
;
403 uint16_t v_update_delay
;
404 uint16_t v_establish_wait
;
405 char update_delay_begin_time
[64];
406 char update_delay_end_time
[64];
407 char update_delay_zebra_resume_time
[64];
408 char update_delay_peers_resume_time
[64];
409 uint32_t established
;
410 uint32_t restarted_peers
;
411 uint32_t implicit_eors
;
412 uint32_t explicit_eors
;
413 #define BGP_UPDATE_DELAY_DEF 0
414 #define BGP_UPDATE_DELAY_MIN 0
415 #define BGP_UPDATE_DELAY_MAX 3600
417 /* Reference bandwidth for BGP link-bandwidth. Used when
418 * the LB value has to be computed based on some other
419 * factor (e.g., number of multipaths for the prefix)
423 #define BGP_LINK_BW_REF_BW 1
427 #define BGP_FLAG_ALWAYS_COMPARE_MED (1 << 0)
428 #define BGP_FLAG_DETERMINISTIC_MED (1 << 1)
429 #define BGP_FLAG_MED_MISSING_AS_WORST (1 << 2)
430 #define BGP_FLAG_MED_CONFED (1 << 3)
431 #define BGP_FLAG_NO_DEFAULT_IPV4 (1 << 4)
432 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1 << 5)
433 #define BGP_FLAG_COMPARE_ROUTER_ID (1 << 7)
434 #define BGP_FLAG_ASPATH_IGNORE (1 << 8)
435 #define BGP_FLAG_IMPORT_CHECK (1 << 9)
436 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1 << 10)
437 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1 << 11)
439 /* This flag is set when we have full BGP Graceful-Restart mode enable */
440 #define BGP_FLAG_GRACEFUL_RESTART (1 << 12)
442 #define BGP_FLAG_ASPATH_CONFED (1 << 13)
443 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1 << 14)
444 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 15)
445 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 16)
446 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1 << 17)
447 #define BGP_FLAG_FORCE_STATIC_PROCESS (1 << 18)
448 #define BGP_FLAG_SHOW_HOSTNAME (1 << 19)
449 #define BGP_FLAG_GR_PRESERVE_FWD (1 << 20)
450 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1 << 21)
451 #define BGP_FLAG_DELETE_IN_PROGRESS (1 << 22)
452 #define BGP_FLAG_SELECT_DEFER_DISABLE (1 << 23)
453 #define BGP_FLAG_GR_DISABLE_EOR (1 << 24)
454 #define BGP_FLAG_EBGP_REQUIRES_POLICY (1 << 25)
455 #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1 << 26)
457 /* This flag is set if the instance is in administrative shutdown */
458 #define BGP_FLAG_SHUTDOWN (1 << 27)
459 #define BGP_FLAG_SUPPRESS_FIB_PENDING (1 << 28)
461 enum global_mode GLOBAL_GR_FSM
[BGP_GLOBAL_GR_MODE
]
462 [BGP_GLOBAL_GR_EVENT_CMD
];
463 enum global_mode global_gr_present_state
;
465 /* This variable stores the current Graceful Restart state of Zebra
466 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
468 enum zebra_gr_mode present_zebra_gr_state
;
470 /* BGP Per AF flags */
471 uint16_t af_flags
[AFI_MAX
][SAFI_MAX
];
472 #define BGP_CONFIG_DAMPENING (1 << 0)
473 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
474 #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 1)
475 #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 2)
476 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 3)
477 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 4)
478 /* import/export between address families */
479 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 5)
480 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 6)
481 /* vrf-route leaking flags */
482 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 7)
483 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 8)
485 /* BGP per AF peer count */
486 uint32_t af_peer_count
[AFI_MAX
][SAFI_MAX
];
488 /* Tree for next-hop lookup cache. */
489 struct bgp_nexthop_cache_head nexthop_cache_table
[AFI_MAX
];
491 /* Tree for import-check */
492 struct bgp_nexthop_cache_head import_check_table
[AFI_MAX
];
494 struct bgp_table
*connected_table
[AFI_MAX
];
496 struct hash
*address_hash
;
498 /* DB for all local tunnel-ips - used mainly for martian checks
499 Currently it only has all VxLan tunnel IPs*/
500 struct hash
*tip_hash
;
502 /* Static route configuration. */
503 struct bgp_table
*route
[AFI_MAX
][SAFI_MAX
];
505 /* Aggregate address configuration. */
506 struct bgp_table
*aggregate
[AFI_MAX
][SAFI_MAX
];
508 /* BGP routing information base. */
509 struct bgp_table
*rib
[AFI_MAX
][SAFI_MAX
];
511 /* BGP table route-map. */
512 struct bgp_rmap table_map
[AFI_MAX
][SAFI_MAX
];
514 /* BGP redistribute configuration. */
515 struct list
*redist
[AFI_MAX
][ZEBRA_ROUTE_MAX
];
517 /* Allocate MPLS labels */
518 uint8_t allocate_mpls_labels
[AFI_MAX
][SAFI_MAX
];
520 /* Allocate hash entries to store policy routing information
521 * The hash are used to host pbr rules somewhere.
522 * Actually, pbr will only be used by flowspec
523 * those hash elements will have relationship together as
524 * illustrated in below diagram:
526 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
527 * <----- pbr_match j <--- pbr_match_entry 1..m
530 * - here in BGP structure, the list of match and actions will
531 * stand for the list of ipset sets, and table_ids in the kernel
532 * - the arrow above between pbr_match and pbr_action indicate
533 * that a backpointer permits match to find the action
534 * - the arrow betwen match_entry and match is a hash list
535 * contained in match, that lists the whole set of entries
537 struct hash
*pbr_match_hash
;
538 struct hash
*pbr_rule_hash
;
539 struct hash
*pbr_action_hash
;
541 /* timer to re-evaluate neighbor default-originate route-maps */
542 struct thread
*t_rmap_def_originate_eval
;
543 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
545 /* BGP distance configuration. */
546 uint8_t distance_ebgp
[AFI_MAX
][SAFI_MAX
];
547 uint8_t distance_ibgp
[AFI_MAX
][SAFI_MAX
];
548 uint8_t distance_local
[AFI_MAX
][SAFI_MAX
];
550 /* BGP default local-preference. */
551 uint32_t default_local_pref
;
553 /* BGP default subgroup pkt queue max */
554 uint32_t default_subgroup_pkt_queue_max
;
556 /* BGP default timer. */
557 uint32_t default_holdtime
;
558 uint32_t default_keepalive
;
559 uint32_t default_connect_retry
;
561 /* BGP graceful restart */
562 uint32_t restart_time
;
563 uint32_t stalepath_time
;
564 uint32_t select_defer_time
;
565 struct graceful_restart_info gr_info
[AFI_MAX
][SAFI_MAX
];
566 uint32_t rib_stale_time
;
568 #define BGP_ROUTE_SELECT_DELAY 1
569 #define BGP_MAX_BEST_ROUTE_SELECT 10000
570 /* Maximum-paths configuration */
571 struct bgp_maxpaths_cfg
{
572 uint16_t maxpaths_ebgp
;
573 uint16_t maxpaths_ibgp
;
575 #define BGP_FLAG_IBGP_MULTIPATH_SAME_CLUSTERLEN (1 << 0)
576 } maxpaths
[AFI_MAX
][SAFI_MAX
];
578 _Atomic
uint32_t wpkt_quanta
; // max # packets to write per i/o cycle
579 _Atomic
uint32_t rpkt_quanta
; // max # packets to read per i/o cycle
581 /* Automatic coalesce adjust on/off */
582 bool heuristic_coalesce
;
583 /* Actual coalesce time */
584 uint32_t coalesce_time
;
586 /* Auto-shutdown new peers */
589 struct bgp_addpath_bgp_data tx_addpath
;
591 #ifdef ENABLE_BGP_VNC
592 struct rfapi_cfg
*rfapi_cfg
;
596 /* EVPN related information */
599 struct hash
*vnihash
;
601 /* EVPN enable - advertise gateway macip routes */
602 int advertise_gw_macip
;
604 /* EVPN enable - advertise local VNIs and their MACs etc. */
605 int advertise_all_vni
;
607 /* draft-ietf-idr-deprecate-as-set-confed-set
608 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
612 struct bgp_evpn_info
*evpn_info
;
614 /* EVPN - use RFC 8365 to auto-derive RT */
615 int advertise_autort_rfc8365
;
618 * Flooding mechanism for BUM packets for VxLAN-EVPN.
620 enum vxlan_flood_control vxlan_flood_ctrl
;
622 /* Hash table of Import RTs to EVIs */
623 struct hash
*import_rt_hash
;
625 /* Hash table of VRF import RTs to VRFs */
626 struct hash
*vrf_import_rt_hash
;
628 /* L3-VNI corresponding to this vrf */
631 /* router-mac to be used in mac-ip routes for this vrf */
634 /* originator ip - to be used as NH for type-5 routes */
635 struct in_addr originator_ip
;
637 /* SVI associated with the L3-VNI corresponding to this vrf */
638 ifindex_t l3vni_svi_ifindex
;
642 #define BGP_VRF_AUTO (1 << 0)
643 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
644 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
645 #define BGP_VRF_RD_CFGD (1 << 3)
646 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 4)
648 /* unique ID for auto derivation of RD for this vrf */
651 /* Automatically derived RD for this VRF */
652 struct prefix_rd vrf_prd_auto
;
654 /* RD for this VRF */
655 struct prefix_rd vrf_prd
;
657 /* import rt list for the vrf instance */
658 struct list
*vrf_import_rtl
;
660 /* export rt list for the vrf instance */
661 struct list
*vrf_export_rtl
;
663 /* list of corresponding l2vnis (struct bgpevpn) */
666 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
667 struct bgp_rmap adv_cmd_rmap
[AFI_MAX
][SAFI_MAX
];
669 struct vpn_policy vpn_policy
[AFI_MAX
];
671 struct bgp_pbr_config
*bgp_pbr_cfg
;
673 /* Count of peers in established state */
674 uint32_t established_peers
;
676 /* Weighted ECMP related config. */
677 enum bgp_link_bw_handling lb_handling
;
679 /* Process Queue for handling routes */
680 struct work_queue
*process_queue
;
682 /* BGP Conditional advertisement */
683 uint32_t condition_filter_count
;
684 struct thread
*t_condition_check
;
688 DECLARE_QOBJ_TYPE(bgp
)
690 DECLARE_HOOK(bgp_inst_delete
, (struct bgp
*bgp
), (bgp
))
691 DECLARE_HOOK(bgp_inst_config_write
,
692 (struct bgp
*bgp
, struct vty
*vty
),
695 /* Thread callback information */
696 struct afi_safi_info
{
702 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
704 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
705 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
706 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
707 && bgp->vrf_id != VRF_UNKNOWN))
709 #define BGP_SELECT_DEFER_DISABLE(bgp) \
710 (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
712 #define BGP_SUPPRESS_FIB_ENABLED(bgp) \
713 (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING))
715 /* BGP peer-group support. */
717 /* Name of the peer-group. */
720 /* Pointer to BGP. */
723 /* Peer-group client list. */
726 /** Dynamic neighbor listening ranges */
727 struct list
*listen_range
[AFI_MAX
];
729 /* Peer-group config */
733 /* BGP Notify message format. */
742 /* Next hop self address. */
744 struct interface
*ifp
;
746 struct in6_addr v6_global
;
747 struct in6_addr v6_local
;
750 /* BGP addpath values */
751 #define BGP_ADDPATH_RX 1
752 #define BGP_ADDPATH_TX 2
753 #define BGP_ADDPATH_ID_LEN 4
755 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
757 /* Route map direction */
762 #define BGP_DEFAULT_TTL 1
763 #define BGP_GTSM_HOPS_DISABLED 0
764 #define BGP_GTSM_HOPS_CONNECTED 1
767 #define CONDITION_NON_EXIST false
768 #define CONDITION_EXIST true
770 enum update_type
{ WITHDRAW
, ADVERTISE
};
774 /* BGP filter structure. */
776 /* Distribute-list. */
779 struct access_list
*alist
;
785 struct prefix_list
*plist
;
791 struct as_list
*aslist
;
792 } aslist
[FILTER_MAX
];
797 struct route_map
*map
;
800 /* Unsuppress-map. */
803 struct route_map
*map
;
809 struct route_map
*amap
;
814 struct route_map
*cmap
;
816 enum update_type update_type
;
820 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
821 a peer who's AS is part of our Confederation. */
823 BGP_PEER_UNSPECIFIED
,
830 /* BGP message header and packet size. */
831 #define BGP_MARKER_SIZE 16
832 #define BGP_HEADER_SIZE 19
833 #define BGP_MAX_PACKET_SIZE 4096
834 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
837 * Trigger delay for bgp_announce_route().
839 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
840 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
843 /* back pointer to the peer */
846 /* which subgroup the peer_af belongs to */
847 struct update_subgroup
*subgroup
;
849 /* for being part of an update subgroup's peer list */
850 LIST_ENTRY(peer_af
) subgrp_train
;
852 /* for being part of a packet's peer list */
853 LIST_ENTRY(peer_af
) pkt_train
;
855 struct bpacket
*next_pkt_to_send
;
858 * Trigger timer for bgp_announce_route().
860 struct thread
*t_announce_route
;
866 /* BGP GR per peer ds */
868 #define BGP_PEER_GR_MODE 5
869 #define BGP_PEER_GR_EVENT_CMD 6
876 PEER_GLOBAL_INHERIT
/* This is the default mode */
880 enum peer_gr_command
{
889 typedef unsigned int (*bgp_peer_gr_action_ptr
)(struct peer
*, int, int);
892 enum peer_mode next_state
;
893 bgp_peer_gr_action_ptr action_fun
;
896 /* BGP finite state machine events. */
897 enum bgp_fsm_events
{
901 TCP_connection_closed
,
902 TCP_connection_open_failed
,
904 ConnectRetry_timer_expired
,
906 KeepAlive_timer_expired
,
907 Receive_OPEN_message
,
908 Receive_KEEPALIVE_message
,
909 Receive_UPDATE_message
,
910 Receive_NOTIFICATION_message
,
915 /* BGP finite state machine status. */
916 enum bgp_fsm_status
{
928 /* BGP neighbor structure. */
933 /* reference count, primarily to allow bgp_process'ing of route_node's
934 * to be done after a struct peer is deleted.
936 * named 'lock' for hysterical reasons within Quagga.
940 /* BGP peer group. */
941 struct peer_group
*group
;
942 uint64_t version
[AFI_MAX
][SAFI_MAX
];
944 /* BGP peer_af structures, per configured AF on this peer */
945 struct peer_af
*peer_af_array
[BGP_AF_MAX
];
947 /* Peer's remote AS number. */
951 /* Peer's local AS number. */
954 bgp_peer_sort_t sort
;
956 /* Peer's Change local AS number. */
957 as_t change_local_as
;
959 /* Remote router ID. */
960 struct in_addr remote_id
;
962 /* Local router ID. */
963 struct in_addr local_id
;
965 /* Packet receive and send buffer. */
966 pthread_mutex_t io_mtx
; // guards ibuf, obuf
967 struct stream_fifo
*ibuf
; // packets waiting to be processed
968 struct stream_fifo
*obuf
; // packets waiting to be written
970 struct ringbuf
*ibuf_work
; // WiP buffer used by bgp_read() only
971 struct stream
*obuf_work
; // WiP buffer used to construct packets
973 struct stream
*curr
; // the current packet being parsed
975 /* We use a separate stream to encode MP_REACH_NLRI for efficient
976 * NLRI packing. peer->obuf_work stores all the other attributes. The
977 * actual packet is then constructed by concatenating the two.
979 struct stream
*scratch
;
981 /* the doppelganger peer structure, due to dual TCP conn setup */
982 struct peer
*doppelganger
;
984 /* Status of the peer. */
985 enum bgp_fsm_status status
;
986 enum bgp_fsm_status ostatus
;
988 /* FSM events, stored for debug purposes.
989 * Note: uchar used for reduced memory usage.
991 enum bgp_fsm_events cur_event
;
992 enum bgp_fsm_events last_event
;
993 enum bgp_fsm_events last_major_event
;
995 /* Peer index, used for dumping TABLE_DUMP_V2 format */
996 uint16_t table_dump_index
;
998 /* Peer information */
999 int fd
; /* File descriptor */
1000 int ttl
; /* TTL of TCP connection to the peer. */
1001 int rtt
; /* Estimated round-trip-time from TCP_INFO */
1002 int rtt_expected
; /* Expected round-trip-time for a peer */
1003 uint8_t rtt_keepalive_rcv
; /* Received count for RTT shutdown */
1004 uint8_t rtt_keepalive_conf
; /* Configured count for RTT shutdown */
1005 int gtsm_hops
; /* minimum hopcount to peer */
1006 char *desc
; /* Description of the peer. */
1007 unsigned short port
; /* Destination port for peer */
1008 char *host
; /* Printable address of the peer. */
1009 union sockunion su
; /* Sockunion address of the peer. */
1010 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
1011 time_t uptime
; /* Last Up/Down time */
1012 time_t readtime
; /* Last read time */
1013 time_t resettime
; /* Last reset time */
1015 char *conf_if
; /* neighbor interface config name. */
1016 struct interface
*ifp
; /* corresponding interface */
1017 char *ifname
; /* bind interface name. */
1019 union sockunion
*update_source
;
1021 union sockunion
*su_local
; /* Sockunion of local address. */
1022 union sockunion
*su_remote
; /* Sockunion of remote address. */
1023 int shared_network
; /* Is this peer shared same network. */
1024 struct bgp_nexthop nexthop
; /* Nexthop */
1026 /* Peer address family configuration. */
1027 uint8_t afc
[AFI_MAX
][SAFI_MAX
];
1028 uint8_t afc_nego
[AFI_MAX
][SAFI_MAX
];
1029 uint8_t afc_adv
[AFI_MAX
][SAFI_MAX
];
1030 uint8_t afc_recv
[AFI_MAX
][SAFI_MAX
];
1032 /* Capability flags (reset in bgp_stop) */
1034 #define PEER_CAP_REFRESH_ADV (1U << 0) /* refresh advertised */
1035 #define PEER_CAP_REFRESH_OLD_RCV (1U << 1) /* refresh old received */
1036 #define PEER_CAP_REFRESH_NEW_RCV (1U << 2) /* refresh rfc received */
1037 #define PEER_CAP_DYNAMIC_ADV (1U << 3) /* dynamic advertised */
1038 #define PEER_CAP_DYNAMIC_RCV (1U << 4) /* dynamic received */
1039 #define PEER_CAP_RESTART_ADV (1U << 5) /* restart advertised */
1040 #define PEER_CAP_RESTART_RCV (1U << 6) /* restart received */
1041 #define PEER_CAP_AS4_ADV (1U << 7) /* as4 advertised */
1042 #define PEER_CAP_AS4_RCV (1U << 8) /* as4 received */
1043 #define PEER_CAP_RESTART_BIT_ADV (1U << 9) /* sent restart state */
1044 #define PEER_CAP_RESTART_BIT_RCV (1U << 10) /* peer restart state */
1045 #define PEER_CAP_ADDPATH_ADV (1U << 11) /* addpath advertised */
1046 #define PEER_CAP_ADDPATH_RCV (1U << 12) /* addpath received */
1047 #define PEER_CAP_ENHE_ADV (1U << 13) /* Extended nexthop advertised */
1048 #define PEER_CAP_ENHE_RCV (1U << 14) /* Extended nexthop received */
1049 #define PEER_CAP_HOSTNAME_ADV (1U << 15) /* hostname advertised */
1050 #define PEER_CAP_HOSTNAME_RCV (1U << 16) /* hostname received */
1052 /* Capability flags (reset in bgp_stop) */
1053 uint32_t af_cap
[AFI_MAX
][SAFI_MAX
];
1054 #define PEER_CAP_ORF_PREFIX_SM_ADV (1U << 0) /* send-mode advertised */
1055 #define PEER_CAP_ORF_PREFIX_RM_ADV (1U << 1) /* receive-mode advertised */
1056 #define PEER_CAP_ORF_PREFIX_SM_RCV (1U << 2) /* send-mode received */
1057 #define PEER_CAP_ORF_PREFIX_RM_RCV (1U << 3) /* receive-mode received */
1058 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1U << 4) /* send-mode received */
1059 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1U << 5) /* receive-mode received */
1060 #define PEER_CAP_RESTART_AF_RCV (1U << 6) /* graceful restart afi/safi received */
1061 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1U << 7) /* graceful restart afi/safi F-bit received */
1062 #define PEER_CAP_ADDPATH_AF_TX_ADV (1U << 8) /* addpath tx advertised */
1063 #define PEER_CAP_ADDPATH_AF_TX_RCV (1U << 9) /* addpath tx received */
1064 #define PEER_CAP_ADDPATH_AF_RX_ADV (1U << 10) /* addpath rx advertised */
1065 #define PEER_CAP_ADDPATH_AF_RX_RCV (1U << 11) /* addpath rx received */
1066 #define PEER_CAP_ENHE_AF_ADV (1U << 12) /* Extended nexthopi afi/safi advertised */
1067 #define PEER_CAP_ENHE_AF_RCV (1U << 13) /* Extended nexthop afi/safi received */
1068 #define PEER_CAP_ENHE_AF_NEGO (1U << 14) /* Extended nexthop afi/safi negotiated */
1070 /* Global configuration flags. */
1072 * Parallel array to flags that indicates whether each flag originates
1073 * from a peer-group or if it is config that is specific to this
1074 * individual peer. If a flag is set independent of the peer-group, the
1075 * same bit should be set here. If this peer is a peer-group, this
1076 * memory region should be all zeros.
1078 * The assumption is that the default state for all flags is unset,
1079 * so if a flag is unset, the corresponding override flag is unset too.
1080 * However if a flag is set, the corresponding override flag is set.
1082 uint32_t flags_override
;
1084 * Parallel array to flags that indicates whether the default behavior
1085 * of *flags_override* should be inverted. If a flag is unset and the
1086 * corresponding invert flag is set, the corresponding override flag
1087 * would be set. However if a flag is set and the corresponding invert
1088 * flag is unset, the corresponding override flag would be unset.
1090 * This can be used for attributes like *send-community*, which are
1091 * implicitely enabled and have to be disabled explicitely, compared to
1092 * 'normal' attributes like *next-hop-self* which are implicitely set.
1094 * All operations dealing with flags should apply the following boolean
1095 * logic to keep the internal flag system in a sane state:
1097 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1098 * value=0 invert=1 Unset flag unconditionally
1099 * value=1 invert=0 Set flag unconditionally
1100 * value=1 invert=1 Inherit flag if member, otherwise set flag
1102 * Contrary to the implementation of *flags_override*, the flag
1103 * inversion state can be set either on the peer OR the peer *and* the
1104 * peer-group. This was done on purpose, as the inversion state of a
1105 * flag can be determined on either the peer or the peer-group.
1107 * Example: Enabling the cisco configuration mode inverts all flags
1108 * related to *send-community* unconditionally for both peer-groups and
1111 * This behavior is different for interface peers though, which enable
1112 * the *extended-nexthop* flag by default, which regular peers do not.
1113 * As the peer-group can contain both regular and interface peers, the
1114 * flag inversion state must be set on the peer only.
1116 * When a peer inherits the configuration from a peer-group and the
1117 * inversion state of the flag differs between peer and peer-group, the
1118 * newly set value must equal to the inverted state of the peer-group.
1120 uint32_t flags_invert
;
1122 * Effective array for storing the peer/peer-group flags. In case of a
1123 * peer-group, the peer-specific overrides (see flags_override and
1124 * flags_invert) must be respected.
1127 #define PEER_FLAG_PASSIVE (1U << 0) /* passive mode */
1128 #define PEER_FLAG_SHUTDOWN (1U << 1) /* shutdown */
1129 #define PEER_FLAG_DONT_CAPABILITY (1U << 2) /* dont-capability */
1130 #define PEER_FLAG_OVERRIDE_CAPABILITY (1U << 3) /* override-capability */
1131 #define PEER_FLAG_STRICT_CAP_MATCH (1U << 4) /* strict-match */
1132 #define PEER_FLAG_DYNAMIC_CAPABILITY (1U << 5) /* dynamic capability */
1133 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1U << 6) /* disable-connected-check */
1134 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1U << 7) /* local-as no-prepend */
1135 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1U << 8) /* local-as no-prepend replace-as */
1136 #define PEER_FLAG_DELETE (1U << 9) /* mark the peer for deleting */
1137 #define PEER_FLAG_CONFIG_NODE (1U << 10) /* the node to update configs on */
1138 #define PEER_FLAG_LONESOUL (1U << 11)
1139 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1U << 12) /* dynamic neighbor */
1140 #define PEER_FLAG_CAPABILITY_ENHE (1U << 13) /* Extended next-hop (rfc 5549)*/
1141 #define PEER_FLAG_IFPEER_V6ONLY (1U << 14) /* if-based peer is v6 only */
1142 #define PEER_FLAG_IS_RFAPI_HD (1U << 15) /* attached to rfapi HD */
1143 #define PEER_FLAG_ENFORCE_FIRST_AS (1U << 16) /* enforce-first-as */
1144 #define PEER_FLAG_ROUTEADV (1U << 17) /* route advertise */
1145 #define PEER_FLAG_TIMER (1U << 18) /* keepalive & holdtime */
1146 #define PEER_FLAG_TIMER_CONNECT (1U << 19) /* connect timer */
1147 #define PEER_FLAG_PASSWORD (1U << 20) /* password */
1148 #define PEER_FLAG_LOCAL_AS (1U << 21) /* local-as */
1149 #define PEER_FLAG_UPDATE_SOURCE (1U << 22) /* update-source */
1151 /* BGP-GR Peer related flags */
1152 #define PEER_FLAG_GRACEFUL_RESTART_HELPER (1U << 23) /* Helper */
1153 #define PEER_FLAG_GRACEFUL_RESTART (1U << 24) /* Graceful Restart */
1154 #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1U << 25) /* Global-Inherit */
1155 #define PEER_FLAG_RTT_SHUTDOWN (1U << 26) /* shutdown rtt */
1158 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1159 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1160 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1163 struct bgp_peer_gr PEER_GR_FSM
[BGP_PEER_GR_MODE
][BGP_PEER_GR_EVENT_CMD
];
1164 enum peer_mode peer_gr_present_state
;
1165 /* Non stop forwarding afi-safi count for BGP gr feature*/
1166 uint8_t nsf_af_count
;
1168 uint8_t peer_gr_new_status_flag
;
1169 #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1U << 0)
1170 #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1U << 1)
1171 #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1U << 2)
1173 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1174 char *tx_shutdown_message
;
1176 /* NSF mode (graceful restart) */
1177 uint8_t nsf
[AFI_MAX
][SAFI_MAX
];
1179 time_t eor_stime
[AFI_MAX
][SAFI_MAX
];
1180 /* Last update packet sent time */
1181 time_t pkt_stime
[AFI_MAX
][SAFI_MAX
];
1183 /* Peer Per AF flags */
1185 * Please consult the comments for *flags_override*, *flags_invert* and
1186 * *flags* to understand what these three arrays do. The address-family
1187 * specific attributes are being treated the exact same way as global
1190 uint32_t af_flags_override
[AFI_MAX
][SAFI_MAX
];
1191 uint32_t af_flags_invert
[AFI_MAX
][SAFI_MAX
];
1192 uint32_t af_flags
[AFI_MAX
][SAFI_MAX
];
1193 #define PEER_FLAG_SEND_COMMUNITY (1U << 0) /* send-community */
1194 #define PEER_FLAG_SEND_EXT_COMMUNITY (1U << 1) /* send-community ext. */
1195 #define PEER_FLAG_NEXTHOP_SELF (1U << 2) /* next-hop-self */
1196 #define PEER_FLAG_REFLECTOR_CLIENT (1U << 3) /* reflector-client */
1197 #define PEER_FLAG_RSERVER_CLIENT (1U << 4) /* route-server-client */
1198 #define PEER_FLAG_SOFT_RECONFIG (1U << 5) /* soft-reconfiguration */
1199 #define PEER_FLAG_AS_PATH_UNCHANGED (1U << 6) /* transparent-as */
1200 #define PEER_FLAG_NEXTHOP_UNCHANGED (1U << 7) /* transparent-next-hop */
1201 #define PEER_FLAG_MED_UNCHANGED (1U << 8) /* transparent-next-hop */
1202 #define PEER_FLAG_DEFAULT_ORIGINATE (1U << 9) /* default-originate */
1203 #define PEER_FLAG_REMOVE_PRIVATE_AS (1U << 10) /* remove-private-as */
1204 #define PEER_FLAG_ALLOWAS_IN (1U << 11) /* set allowas-in */
1205 #define PEER_FLAG_ORF_PREFIX_SM (1U << 12) /* orf capability send-mode */
1206 #define PEER_FLAG_ORF_PREFIX_RM (1U << 13) /* orf capability receive-mode */
1207 #define PEER_FLAG_MAX_PREFIX (1U << 14) /* maximum prefix */
1208 #define PEER_FLAG_MAX_PREFIX_WARNING (1U << 15) /* maximum prefix warning-only */
1209 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1U << 16) /* leave link-local nexthop unchanged */
1210 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1U << 17) /* next-hop-self force */
1211 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1U << 18) /* remove-private-as all */
1212 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1U << 19) /* remove-private-as replace-as */
1213 #define PEER_FLAG_AS_OVERRIDE (1U << 20) /* as-override */
1214 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1U << 21) /* remove-private-as all replace-as */
1215 #define PEER_FLAG_WEIGHT (1U << 24) /* weight */
1216 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1U << 25) /* allowas-in origin */
1217 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1U << 26) /* Send large Communities */
1218 #define PEER_FLAG_MAX_PREFIX_OUT (1U << 27) /* outgoing maximum prefix */
1219 #define PEER_FLAG_MAX_PREFIX_FORCE (1U << 28) /* maximum-prefix <num> force */
1221 enum bgp_addpath_strat addpath_type
[AFI_MAX
][SAFI_MAX
];
1226 /* default-originate route-map. */
1229 struct route_map
*map
;
1230 } default_rmap
[AFI_MAX
][SAFI_MAX
];
1232 /* Peer status flags. */
1234 #define PEER_STATUS_ACCEPT_PEER (1U << 0) /* accept peer */
1235 #define PEER_STATUS_PREFIX_OVERFLOW (1U << 1) /* prefix-overflow */
1236 #define PEER_STATUS_CAPABILITY_OPEN (1U << 2) /* capability open send */
1237 #define PEER_STATUS_HAVE_ACCEPT (1U << 3) /* accept peer's parent */
1238 #define PEER_STATUS_GROUP (1U << 4) /* peer-group conf */
1239 #define PEER_STATUS_NSF_MODE (1U << 5) /* NSF aware peer */
1240 #define PEER_STATUS_NSF_WAIT (1U << 6) /* wait comeback peer */
1242 /* Peer status af flags (reset in bgp_stop) */
1243 uint16_t af_sflags
[AFI_MAX
][SAFI_MAX
];
1244 #define PEER_STATUS_ORF_PREFIX_SEND (1U << 0) /* prefix-list send peer */
1245 #define PEER_STATUS_ORF_WAIT_REFRESH (1U << 1) /* wait refresh received peer */
1246 #define PEER_STATUS_PREFIX_THRESHOLD (1U << 2) /* exceed prefix-threshold */
1247 #define PEER_STATUS_PREFIX_LIMIT (1U << 3) /* exceed prefix-limit */
1248 #define PEER_STATUS_EOR_SEND (1U << 4) /* end-of-rib send to peer */
1249 #define PEER_STATUS_EOR_RECEIVED (1U << 5) /* end-of-rib received from peer */
1251 /* Configured timer values. */
1252 _Atomic
uint32_t holdtime
;
1253 _Atomic
uint32_t keepalive
;
1254 _Atomic
uint32_t connect
;
1255 _Atomic
uint32_t routeadv
;
1258 _Atomic
uint32_t v_start
;
1259 _Atomic
uint32_t v_connect
;
1260 _Atomic
uint32_t v_holdtime
;
1261 _Atomic
uint32_t v_keepalive
;
1262 _Atomic
uint32_t v_routeadv
;
1263 _Atomic
uint32_t v_pmax_restart
;
1264 _Atomic
uint32_t v_gr_restart
;
1267 struct thread
*t_read
;
1268 struct thread
*t_write
;
1269 struct thread
*t_start
;
1270 struct thread
*t_connect_check_r
;
1271 struct thread
*t_connect_check_w
;
1272 struct thread
*t_connect
;
1273 struct thread
*t_holdtime
;
1274 struct thread
*t_routeadv
;
1275 struct thread
*t_pmax_restart
;
1276 struct thread
*t_gr_restart
;
1277 struct thread
*t_gr_stale
;
1278 struct thread
*t_generate_updgrp_packets
;
1279 struct thread
*t_process_packet
;
1282 _Atomic
uint32_t thread_flags
;
1283 #define PEER_THREAD_WRITES_ON (1U << 0)
1284 #define PEER_THREAD_READS_ON (1U << 1)
1285 #define PEER_THREAD_KEEPALIVES_ON (1U << 2)
1286 #define PEER_THREAD_SUBGRP_ADV_DELAY (1U << 3)
1289 struct work_queue
*clear_node_queue
;
1291 #define PEER_TOTAL_RX(peer) \
1292 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1293 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1294 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1295 + atomic_load_explicit(&peer->refresh_in, \
1296 memory_order_relaxed) \
1297 + atomic_load_explicit(&peer->keepalive_in, \
1298 memory_order_relaxed) \
1299 + atomic_load_explicit(&peer->dynamic_cap_in, \
1300 memory_order_relaxed)
1302 #define PEER_TOTAL_TX(peer) \
1303 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1304 + atomic_load_explicit(&peer->update_out, \
1305 memory_order_relaxed) \
1306 + atomic_load_explicit(&peer->notify_out, \
1307 memory_order_relaxed) \
1308 + atomic_load_explicit(&peer->refresh_out, \
1309 memory_order_relaxed) \
1310 + atomic_load_explicit(&peer->keepalive_out, \
1311 memory_order_relaxed) \
1312 + atomic_load_explicit(&peer->dynamic_cap_out, \
1313 memory_order_relaxed)
1315 /* Statistics field */
1316 _Atomic
uint32_t open_in
; /* Open message input count */
1317 _Atomic
uint32_t open_out
; /* Open message output count */
1318 _Atomic
uint32_t update_in
; /* Update message input count */
1319 _Atomic
uint32_t update_out
; /* Update message ouput count */
1320 _Atomic
time_t update_time
; /* Update message received time. */
1321 _Atomic
uint32_t keepalive_in
; /* Keepalive input count */
1322 _Atomic
uint32_t keepalive_out
; /* Keepalive output count */
1323 _Atomic
uint32_t notify_in
; /* Notify input count */
1324 _Atomic
uint32_t notify_out
; /* Notify output count */
1325 _Atomic
uint32_t refresh_in
; /* Route Refresh input count */
1326 _Atomic
uint32_t refresh_out
; /* Route Refresh output count */
1327 _Atomic
uint32_t dynamic_cap_in
; /* Dynamic Capability input count. */
1328 _Atomic
uint32_t dynamic_cap_out
; /* Dynamic Capability output count. */
1330 uint32_t stat_pfx_filter
;
1331 uint32_t stat_pfx_aspath_loop
;
1332 uint32_t stat_pfx_originator_loop
;
1333 uint32_t stat_pfx_cluster_loop
;
1334 uint32_t stat_pfx_nh_invalid
;
1335 uint32_t stat_pfx_dup_withdraw
;
1336 uint32_t stat_upd_7606
; /* RFC7606: treat-as-withdraw */
1338 /* BGP state count */
1339 uint32_t established
; /* Established */
1340 uint32_t dropped
; /* Dropped */
1342 /* Update delay related fields */
1343 uint8_t update_delay_over
; /* When this is set, BGP is no more waiting
1346 /* Syncronization list and time. */
1347 struct bgp_synchronize
*sync
[AFI_MAX
][SAFI_MAX
];
1349 /* timestamp when the last UPDATE msg was written */
1350 _Atomic
time_t last_write
;
1351 /* timestamp when the last msg was written */
1352 _Atomic
time_t last_update
;
1355 struct bgp_notify notify
;
1357 /* Filter structure. */
1358 struct bgp_filter filter
[AFI_MAX
][SAFI_MAX
];
1361 * Parallel array to filter that indicates whether each filter
1362 * originates from a peer-group or if it is config that is specific to
1363 * this individual peer. If a filter is set independent of the
1364 * peer-group the appropriate bit should be set here. If this peer is a
1365 * peer-group, this memory region should be all zeros. The assumption
1366 * is that the default state for all flags is unset. Due to filters
1367 * having a direction (e.g. in/out/...), this array has a third
1368 * dimension for storing the overrides independently per direction.
1371 * - if a filter for an individual peer is unset, the corresponding
1372 * override flag is unset and the peer is considered to be back in
1373 * sync with the peer-group.
1374 * - This does *not* contain the filter values, rather it contains
1375 * whether the filter in filter (struct bgp_filter) is peer-specific.
1377 uint8_t filter_override
[AFI_MAX
][SAFI_MAX
][FILTER_MAX
];
1378 #define PEER_FT_DISTRIBUTE_LIST (1U << 0) /* distribute-list */
1379 #define PEER_FT_FILTER_LIST (1U << 1) /* filter-list */
1380 #define PEER_FT_PREFIX_LIST (1U << 2) /* prefix-list */
1381 #define PEER_FT_ROUTE_MAP (1U << 3) /* route-map */
1382 #define PEER_FT_UNSUPPRESS_MAP (1U << 4) /* unsuppress-map */
1383 #define PEER_FT_ADVERTISE_MAP (1U << 5) /* advertise-map */
1385 /* ORF Prefix-list */
1386 struct prefix_list
*orf_plist
[AFI_MAX
][SAFI_MAX
];
1388 /* Text description of last attribute rcvd */
1389 char rcvd_attr_str
[BUFSIZ
];
1391 /* Track if we printed the attribute in debugs */
1392 int rcvd_attr_printed
;
1394 /* Accepted prefix count */
1395 uint32_t pcount
[AFI_MAX
][SAFI_MAX
];
1397 /* Max prefix count. */
1398 uint32_t pmax
[AFI_MAX
][SAFI_MAX
];
1399 uint8_t pmax_threshold
[AFI_MAX
][SAFI_MAX
];
1400 uint16_t pmax_restart
[AFI_MAX
][SAFI_MAX
];
1401 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1403 /* Send prefix count. */
1404 uint32_t pmax_out
[AFI_MAX
][SAFI_MAX
];
1407 char allowas_in
[AFI_MAX
][SAFI_MAX
];
1410 unsigned long weight
[AFI_MAX
][SAFI_MAX
];
1412 /* peer reset cause */
1414 #define PEER_DOWN_RID_CHANGE 1U /* bgp router-id command */
1415 #define PEER_DOWN_REMOTE_AS_CHANGE 2U /* neighbor remote-as command */
1416 #define PEER_DOWN_LOCAL_AS_CHANGE 3U /* neighbor local-as command */
1417 #define PEER_DOWN_CLID_CHANGE 4U /* bgp cluster-id command */
1418 #define PEER_DOWN_CONFED_ID_CHANGE 5U /* bgp confederation id command */
1419 #define PEER_DOWN_CONFED_PEER_CHANGE 6U /* bgp confederation peer command */
1420 #define PEER_DOWN_RR_CLIENT_CHANGE 7U /* neighbor rr-client command */
1421 #define PEER_DOWN_RS_CLIENT_CHANGE 8U /* neighbor rs-client command */
1422 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9U /* neighbor update-source command */
1423 #define PEER_DOWN_AF_ACTIVATE 10U /* neighbor activate command */
1424 #define PEER_DOWN_USER_SHUTDOWN 11U /* neighbor shutdown command */
1425 #define PEER_DOWN_USER_RESET 12U /* clear ip bgp command */
1426 #define PEER_DOWN_NOTIFY_RECEIVED 13U /* notification received */
1427 #define PEER_DOWN_NOTIFY_SEND 14U /* notification send */
1428 #define PEER_DOWN_CLOSE_SESSION 15U /* tcp session close */
1429 #define PEER_DOWN_NEIGHBOR_DELETE 16U /* neghbor delete */
1430 #define PEER_DOWN_RMAP_BIND 17U /* neghbor peer-group command */
1431 #define PEER_DOWN_RMAP_UNBIND 18U /* no neighbor peer-group command */
1432 #define PEER_DOWN_CAPABILITY_CHANGE 19U /* neighbor capability command */
1433 #define PEER_DOWN_PASSIVE_CHANGE 20U /* neighbor passive command */
1434 #define PEER_DOWN_MULTIHOP_CHANGE 21U /* neighbor multihop command */
1435 #define PEER_DOWN_NSF_CLOSE_SESSION 22U /* NSF tcp session close */
1436 #define PEER_DOWN_V6ONLY_CHANGE 23U /* if-based peering v6only toggled */
1437 #define PEER_DOWN_BFD_DOWN 24U /* BFD down */
1438 #define PEER_DOWN_IF_DOWN 25U /* Interface down */
1439 #define PEER_DOWN_NBR_ADDR_DEL 26U /* Peer address lost */
1440 #define PEER_DOWN_WAITING_NHT 27U /* Waiting for NHT to resolve */
1441 #define PEER_DOWN_NBR_ADDR 28U /* Waiting for peer IPv6 IP Addr */
1442 #define PEER_DOWN_VRF_UNINIT 29U /* Associated VRF is not init yet */
1443 #define PEER_DOWN_NOAFI_ACTIVATED 30U /* No AFI/SAFI activated for peer */
1444 #define PEER_DOWN_AS_SETS_REJECT 31U /* Reject routes with AS_SET */
1445 #define PEER_DOWN_WAITING_OPEN 32U /* Waiting for open to succeed */
1446 #define PEER_DOWN_PFX_COUNT 33U /* Reached received prefix count */
1448 * Remember to update peer_down_str in bgp_fsm.c when you add
1449 * a new value to the last_reset reason
1452 size_t last_reset_cause_size
;
1453 uint8_t last_reset_cause
[BGP_MAX_PACKET_SIZE
];
1455 /* The kind of route-map Flags.*/
1457 #define PEER_RMAP_TYPE_IN (1U << 0) /* neighbor route-map in */
1458 #define PEER_RMAP_TYPE_OUT (1U << 1) /* neighbor route-map out */
1459 #define PEER_RMAP_TYPE_NETWORK (1U << 2) /* network route-map */
1460 #define PEER_RMAP_TYPE_REDISTRIBUTE (1U << 3) /* redistribute route-map */
1461 #define PEER_RMAP_TYPE_DEFAULT (1U << 4) /* default-originate route-map */
1462 #define PEER_RMAP_TYPE_NOSET (1U << 5) /* not allow to set commands */
1463 #define PEER_RMAP_TYPE_IMPORT (1U << 6) /* neighbor route-map import */
1464 #define PEER_RMAP_TYPE_EXPORT (1U << 7) /* neighbor route-map export */
1465 #define PEER_RMAP_TYPE_AGGREGATE (1U << 8) /* aggregate-address route-map */
1467 /* peer specific BFD information */
1468 struct bfd_info
*bfd_info
;
1470 /* hostname and domainname advertised by host */
1474 /* Sender side AS path loop detection. */
1475 bool as_path_loop_detection
;
1477 /* Conditional advertisement */
1478 bool advmap_config_change
[AFI_MAX
][SAFI_MAX
];
1479 bool advmap_table_change
;
1483 DECLARE_QOBJ_TYPE(peer
)
1485 /* Inherit peer attribute from peer-group. */
1486 #define PEER_ATTR_INHERIT(peer, group, attr) \
1487 ((peer)->attr = (group)->conf->attr)
1488 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1490 XFREE(mt, (peer)->attr); \
1491 if ((group)->conf->attr) \
1492 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1494 (peer)->attr = NULL; \
1496 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1499 sockunion_free((peer)->attr); \
1500 if ((group)->conf->attr) \
1501 (peer)->attr = sockunion_dup((group)->conf->attr); \
1503 (peer)->attr = NULL; \
1506 /* Check if suppress start/restart of sessions to peer. */
1507 #define BGP_PEER_START_SUPPRESSED(P) \
1508 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) \
1509 || CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) \
1510 || CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN))
1512 #define PEER_ROUTE_ADV_DELAY(peer) \
1513 (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
1515 #define PEER_PASSWORD_MINLEN (1)
1516 #define PEER_PASSWORD_MAXLEN (80)
1518 /* This structure's member directly points incoming packet data
1522 uint16_t afi
; /* iana_afi_t */
1525 uint8_t safi
; /* iana_safi_t */
1527 /* Pointer to NLRI byte stream. */
1530 /* Length of whole NLRI. */
1535 #define BGP_VERSION_4 4
1537 /* Default BGP port number. */
1538 #define BGP_PORT_DEFAULT 179
1540 /* BGP minimum message size. */
1541 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1542 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1543 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1544 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1545 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1546 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1548 /* BGP message types. */
1549 #define BGP_MSG_OPEN 1
1550 #define BGP_MSG_UPDATE 2
1551 #define BGP_MSG_NOTIFY 3
1552 #define BGP_MSG_KEEPALIVE 4
1553 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1554 #define BGP_MSG_CAPABILITY 6
1555 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1557 /* BGP open optional parameter. */
1558 #define BGP_OPEN_OPT_AUTH 1
1559 #define BGP_OPEN_OPT_CAP 2
1561 /* BGP4 attribute type codes. */
1562 #define BGP_ATTR_ORIGIN 1
1563 #define BGP_ATTR_AS_PATH 2
1564 #define BGP_ATTR_NEXT_HOP 3
1565 #define BGP_ATTR_MULTI_EXIT_DISC 4
1566 #define BGP_ATTR_LOCAL_PREF 5
1567 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1568 #define BGP_ATTR_AGGREGATOR 7
1569 #define BGP_ATTR_COMMUNITIES 8
1570 #define BGP_ATTR_ORIGINATOR_ID 9
1571 #define BGP_ATTR_CLUSTER_LIST 10
1572 #define BGP_ATTR_DPA 11
1573 #define BGP_ATTR_ADVERTISER 12
1574 #define BGP_ATTR_RCID_PATH 13
1575 #define BGP_ATTR_MP_REACH_NLRI 14
1576 #define BGP_ATTR_MP_UNREACH_NLRI 15
1577 #define BGP_ATTR_EXT_COMMUNITIES 16
1578 #define BGP_ATTR_AS4_PATH 17
1579 #define BGP_ATTR_AS4_AGGREGATOR 18
1580 #define BGP_ATTR_AS_PATHLIMIT 21
1581 #define BGP_ATTR_PMSI_TUNNEL 22
1582 #define BGP_ATTR_ENCAP 23
1583 #define BGP_ATTR_IPV6_EXT_COMMUNITIES 25
1584 #define BGP_ATTR_LARGE_COMMUNITIES 32
1585 #define BGP_ATTR_PREFIX_SID 40
1586 #define BGP_ATTR_SRTE_COLOR 51
1587 #ifdef ENABLE_BGP_VNC_ATTR
1588 #define BGP_ATTR_VNC 255
1591 /* BGP update origin. */
1592 #define BGP_ORIGIN_IGP 0
1593 #define BGP_ORIGIN_EGP 1
1594 #define BGP_ORIGIN_INCOMPLETE 2
1595 #define BGP_ORIGIN_UNSPECIFIED 255
1597 /* BGP notify message codes. */
1598 #define BGP_NOTIFY_HEADER_ERR 1
1599 #define BGP_NOTIFY_OPEN_ERR 2
1600 #define BGP_NOTIFY_UPDATE_ERR 3
1601 #define BGP_NOTIFY_HOLD_ERR 4
1602 #define BGP_NOTIFY_FSM_ERR 5
1603 #define BGP_NOTIFY_CEASE 6
1604 #define BGP_NOTIFY_CAPABILITY_ERR 7
1606 /* Subcodes for BGP Finite State Machine Error */
1607 #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC 0
1608 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT 1
1609 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
1610 #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
1612 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1614 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1615 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1616 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1617 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1619 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1620 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1621 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1622 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1623 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1624 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1625 #define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1626 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1627 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1629 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1630 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1631 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1632 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1633 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1634 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1635 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1636 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1637 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1638 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1639 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1640 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1642 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1643 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1644 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1645 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1646 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1647 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1648 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1649 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1650 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1652 /* BGP_NOTIFY_CAPABILITY_ERR sub codes (draft-ietf-idr-dynamic-cap-02). */
1653 #define BGP_NOTIFY_CAPABILITY_INVALID_ACTION 1
1654 #define BGP_NOTIFY_CAPABILITY_INVALID_LENGTH 2
1655 #define BGP_NOTIFY_CAPABILITY_MALFORMED_CODE 3
1657 /* BGP timers default value. */
1658 #define BGP_INIT_START_TIMER 1
1659 /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1660 * version-/profile-specific values. The values here do not matter, they only
1661 * exist to provide a clear layering separation between core and CLI.
1663 #define BGP_DEFAULT_HOLDTIME 180
1664 #define BGP_DEFAULT_KEEPALIVE 60
1665 #define BGP_DEFAULT_CONNECT_RETRY 120
1667 #define BGP_DEFAULT_EBGP_ROUTEADV 0
1668 #define BGP_DEFAULT_IBGP_ROUTEADV 0
1670 /* BGP default local preference. */
1671 #define BGP_DEFAULT_LOCAL_PREF 100
1673 /* BGP local-preference to send when 'bgp graceful-shutdown'
1675 #define BGP_GSHUT_LOCAL_PREF 0
1677 /* BGP default subgroup packet queue max . */
1678 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1680 /* BGP graceful restart */
1681 #define BGP_DEFAULT_RESTART_TIME 120
1682 #define BGP_DEFAULT_STALEPATH_TIME 360
1683 #define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
1684 #define BGP_DEFAULT_RIB_STALE_TIME 500
1685 #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME 1
1687 /* BGP uptime string length. */
1688 #define BGP_UPTIME_LEN 25
1690 /* Default configuration settings for bgpd. */
1691 #define BGP_VTY_PORT 2605
1692 #define BGP_DEFAULT_CONFIG "bgpd.conf"
1694 /* BGP Dynamic Neighbors feature */
1695 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1696 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1697 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 5000
1699 /* Flag for peer_clear_soft(). */
1700 enum bgp_clear_type
{
1701 BGP_CLEAR_SOFT_NONE
,
1704 BGP_CLEAR_SOFT_BOTH
,
1705 BGP_CLEAR_SOFT_IN_ORF_PREFIX
1709 #define BGP_INPUT(P) ((P)->curr)
1710 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
1711 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
1712 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
1714 /* BGP error codes. */
1715 #define BGP_SUCCESS 0
1716 #define BGP_CREATED 1
1717 #define BGP_ERR_INVALID_VALUE -1
1718 #define BGP_ERR_INVALID_FLAG -2
1719 #define BGP_ERR_INVALID_AS -3
1720 #define BGP_ERR_INVALID_BGP -4
1721 #define BGP_ERR_PEER_GROUP_MEMBER -5
1722 #define BGP_ERR_PEER_GROUP_NO_REMOTE_AS -7
1723 #define BGP_ERR_PEER_GROUP_CANT_CHANGE -8
1724 #define BGP_ERR_PEER_GROUP_MISMATCH -9
1725 #define BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT -10
1726 #define BGP_ERR_AS_MISMATCH -12
1727 #define BGP_ERR_PEER_FLAG_CONFLICT -13
1728 #define BGP_ERR_PEER_GROUP_SHUTDOWN -14
1729 #define BGP_ERR_PEER_FILTER_CONFLICT -15
1730 #define BGP_ERR_NOT_INTERNAL_PEER -16
1731 #define BGP_ERR_REMOVE_PRIVATE_AS -17
1732 #define BGP_ERR_AF_UNCONFIGURED -18
1733 #define BGP_ERR_SOFT_RECONFIG_UNCONFIGURED -19
1734 #define BGP_ERR_INSTANCE_MISMATCH -20
1735 #define BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP -21
1736 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS -22
1737 #define BGP_ERR_TCPSIG_FAILED -23
1738 #define BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK -24
1739 #define BGP_ERR_NO_IBGP_WITH_TTLHACK -25
1740 #define BGP_ERR_NO_INTERFACE_CONFIG -26
1741 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS -27
1742 #define BGP_ERR_AS_OVERRIDE -28
1743 #define BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT -29
1744 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS -30
1745 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND -31
1746 #define BGP_ERR_INVALID_FOR_DYNAMIC_PEER -32
1747 #define BGP_ERR_MAX -33
1748 #define BGP_ERR_INVALID_FOR_DIRECT_PEER -34
1749 #define BGP_ERR_PEER_SAFI_CONFLICT -35
1752 #define BGP_ERR_GR_INVALID_CMD -36
1753 #define BGP_ERR_GR_OPERATION_FAILED -37
1754 #define BGP_GR_NO_OPERATION -38
1757 * Enumeration of different policy kinds a peer can be configured with.
1760 BGP_POLICY_ROUTE_MAP
,
1761 BGP_POLICY_FILTER_LIST
,
1762 BGP_POLICY_PREFIX_LIST
,
1763 BGP_POLICY_DISTRIBUTE_LIST
,
1764 } bgp_policy_type_e
;
1766 /* peer_flag_change_type. */
1767 enum peer_change_type
{
1770 peer_change_reset_in
,
1771 peer_change_reset_out
,
1774 extern struct bgp_master
*bm
;
1775 extern unsigned int multipath_num
;
1778 extern void bgp_terminate(void);
1779 extern void bgp_reset(void);
1780 extern time_t bgp_clock(void);
1781 extern void bgp_zclient_reset(void);
1782 extern struct bgp
*bgp_get_default(void);
1783 extern struct bgp
*bgp_lookup(as_t
, const char *);
1784 extern struct bgp
*bgp_lookup_by_name(const char *);
1785 extern struct bgp
*bgp_lookup_by_vrf_id(vrf_id_t
);
1786 extern struct bgp
*bgp_get_evpn(void);
1787 extern void bgp_set_evpn(struct bgp
*bgp
);
1788 extern struct peer
*peer_lookup(struct bgp
*, union sockunion
*);
1789 extern struct peer
*peer_lookup_by_conf_if(struct bgp
*, const char *);
1790 extern struct peer
*peer_lookup_by_hostname(struct bgp
*, const char *);
1791 extern void bgp_peer_conf_if_to_su_update(struct peer
*);
1792 extern int peer_group_listen_range_del(struct peer_group
*, struct prefix
*);
1793 extern struct peer_group
*peer_group_lookup(struct bgp
*, const char *);
1794 extern struct peer_group
*peer_group_get(struct bgp
*, const char *);
1795 extern struct peer
*peer_create_bind_dynamic_neighbor(struct bgp
*,
1797 struct peer_group
*);
1798 extern struct prefix
*
1799 peer_group_lookup_dynamic_neighbor_range(struct peer_group
*, struct prefix
*);
1800 extern struct peer_group
*peer_group_lookup_dynamic_neighbor(struct bgp
*,
1803 extern struct peer
*peer_lookup_dynamic_neighbor(struct bgp
*,
1807 * Peers are incredibly easy to memory leak
1808 * due to the various ways that they are actually used
1809 * Provide some functionality to debug locks and unlocks
1811 extern struct peer
*peer_lock_with_caller(const char *, struct peer
*);
1812 extern struct peer
*peer_unlock_with_caller(const char *, struct peer
*);
1813 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
1814 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
1816 extern bgp_peer_sort_t
peer_sort(struct peer
*peer
);
1817 extern bgp_peer_sort_t
peer_sort_lookup(struct peer
*peer
);
1819 extern bool peer_active(struct peer
*);
1820 extern bool peer_active_nego(struct peer
*);
1821 extern void bgp_recalculate_all_bestpaths(struct bgp
*bgp
);
1822 extern struct peer
*peer_create(union sockunion
*, const char *, struct bgp
*,
1823 as_t
, as_t
, int, afi_t
, safi_t
,
1824 struct peer_group
*);
1825 extern struct peer
*peer_create_accept(struct bgp
*);
1826 extern void peer_xfer_config(struct peer
*dst
, struct peer
*src
);
1827 extern char *peer_uptime(time_t uptime2
, char *buf
, size_t len
, bool use_json
,
1830 extern int bgp_config_write(struct vty
*);
1832 extern void bgp_master_init(struct thread_master
*master
,
1833 const int buffer_size
);
1835 extern void bgp_init(unsigned short instance
);
1836 extern void bgp_pthreads_run(void);
1837 extern void bgp_pthreads_finish(void);
1838 extern void bgp_route_map_init(void);
1839 extern void bgp_session_reset(struct peer
*);
1841 extern int bgp_option_set(int);
1842 extern int bgp_option_unset(int);
1843 extern int bgp_option_check(int);
1845 /* set the bgp no-rib option during runtime and remove installed routes */
1846 extern void bgp_option_norib_set_runtime(void);
1848 /* unset the bgp no-rib option during runtime and reset all peers */
1849 extern void bgp_option_norib_unset_runtime(void);
1851 extern int bgp_get(struct bgp
**, as_t
*, const char *, enum bgp_instance_type
);
1852 extern void bgp_instance_up(struct bgp
*);
1853 extern void bgp_instance_down(struct bgp
*);
1854 extern int bgp_delete(struct bgp
*);
1856 extern int bgp_handle_socket(struct bgp
*bgp
, struct vrf
*vrf
,
1857 vrf_id_t old_vrf_id
, bool create
);
1859 extern void bgp_router_id_zebra_bump(vrf_id_t
, const struct prefix
*);
1860 extern void bgp_router_id_static_set(struct bgp
*, struct in_addr
);
1862 extern void bgp_suppress_fib_pending_set(struct bgp
*bgp
, bool set
);
1863 extern int bgp_cluster_id_set(struct bgp
*, struct in_addr
*);
1864 extern int bgp_cluster_id_unset(struct bgp
*);
1866 extern void bgp_confederation_id_set(struct bgp
*, as_t
);
1867 extern int bgp_confederation_id_unset(struct bgp
*);
1868 extern bool bgp_confederation_peers_check(struct bgp
*, as_t
);
1870 extern int bgp_confederation_peers_add(struct bgp
*, as_t
);
1871 extern int bgp_confederation_peers_remove(struct bgp
*, as_t
);
1873 extern void bgp_timers_set(struct bgp
*, uint32_t keepalive
, uint32_t holdtime
,
1874 uint32_t connect_retry
);
1875 extern void bgp_timers_unset(struct bgp
*);
1877 extern int bgp_default_local_preference_set(struct bgp
*, uint32_t);
1878 extern int bgp_default_local_preference_unset(struct bgp
*);
1880 extern int bgp_default_subgroup_pkt_queue_max_set(struct bgp
*bgp
, uint32_t);
1881 extern int bgp_default_subgroup_pkt_queue_max_unset(struct bgp
*bgp
);
1883 extern int bgp_listen_limit_set(struct bgp
*, int);
1884 extern int bgp_listen_limit_unset(struct bgp
*);
1886 extern bool bgp_update_delay_active(struct bgp
*);
1887 extern bool bgp_update_delay_configured(struct bgp
*);
1888 extern int bgp_afi_safi_peer_exists(struct bgp
*bgp
, afi_t afi
, safi_t safi
);
1889 extern void peer_as_change(struct peer
*, as_t
, int);
1890 extern int peer_remote_as(struct bgp
*, union sockunion
*, const char *, as_t
*,
1891 int, afi_t
, safi_t
);
1892 extern int peer_group_remote_as(struct bgp
*, const char *, as_t
*, int);
1893 extern int peer_delete(struct peer
*peer
);
1894 extern void peer_notify_unconfig(struct peer
*peer
);
1895 extern int peer_group_delete(struct peer_group
*);
1896 extern int peer_group_remote_as_delete(struct peer_group
*);
1897 extern int peer_group_listen_range_add(struct peer_group
*, struct prefix
*);
1898 extern void peer_group_notify_unconfig(struct peer_group
*group
);
1900 extern int peer_activate(struct peer
*, afi_t
, safi_t
);
1901 extern int peer_deactivate(struct peer
*, afi_t
, safi_t
);
1903 extern int peer_group_bind(struct bgp
*, union sockunion
*, struct peer
*,
1904 struct peer_group
*, as_t
*);
1906 extern int peer_flag_set(struct peer
*, uint32_t);
1907 extern int peer_flag_unset(struct peer
*, uint32_t);
1908 extern void peer_flag_inherit(struct peer
*peer
, uint32_t flag
);
1910 extern int peer_af_flag_set(struct peer
*, afi_t
, safi_t
, uint32_t);
1911 extern int peer_af_flag_unset(struct peer
*, afi_t
, safi_t
, uint32_t);
1912 extern int peer_af_flag_check(struct peer
*, afi_t
, safi_t
, uint32_t);
1913 extern void peer_af_flag_inherit(struct peer
*peer
, afi_t afi
, safi_t safi
,
1915 extern void peer_change_action(struct peer
*peer
, afi_t afi
, safi_t safi
,
1916 enum peer_change_type type
);
1918 extern int peer_ebgp_multihop_set(struct peer
*, int);
1919 extern int peer_ebgp_multihop_unset(struct peer
*);
1920 extern int is_ebgp_multihop_configured(struct peer
*peer
);
1922 extern void peer_description_set(struct peer
*, const char *);
1923 extern void peer_description_unset(struct peer
*);
1925 extern int peer_update_source_if_set(struct peer
*, const char *);
1926 extern int peer_update_source_addr_set(struct peer
*, const union sockunion
*);
1927 extern int peer_update_source_unset(struct peer
*);
1929 extern int peer_default_originate_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
1931 struct route_map
*route_map
);
1932 extern int peer_default_originate_unset(struct peer
*, afi_t
, safi_t
);
1934 extern void peer_port_set(struct peer
*, uint16_t);
1935 extern void peer_port_unset(struct peer
*);
1937 extern int peer_weight_set(struct peer
*, afi_t
, safi_t
, uint16_t);
1938 extern int peer_weight_unset(struct peer
*, afi_t
, safi_t
);
1940 extern int peer_timers_set(struct peer
*, uint32_t keepalive
,
1942 extern int peer_timers_unset(struct peer
*);
1944 extern int peer_timers_connect_set(struct peer
*, uint32_t);
1945 extern int peer_timers_connect_unset(struct peer
*);
1947 extern int peer_advertise_interval_set(struct peer
*, uint32_t);
1948 extern int peer_advertise_interval_unset(struct peer
*);
1950 extern void peer_interface_set(struct peer
*, const char *);
1951 extern void peer_interface_unset(struct peer
*);
1953 extern int peer_distribute_set(struct peer
*, afi_t
, safi_t
, int, const char *);
1954 extern int peer_distribute_unset(struct peer
*, afi_t
, safi_t
, int);
1956 extern int peer_allowas_in_set(struct peer
*, afi_t
, safi_t
, int, int);
1957 extern int peer_allowas_in_unset(struct peer
*, afi_t
, safi_t
);
1959 extern int peer_local_as_set(struct peer
*, as_t
, bool no_prepend
,
1961 extern int peer_local_as_unset(struct peer
*);
1963 extern int peer_prefix_list_set(struct peer
*, afi_t
, safi_t
, int,
1965 extern int peer_prefix_list_unset(struct peer
*, afi_t
, safi_t
, int);
1967 extern int peer_aslist_set(struct peer
*, afi_t
, safi_t
, int, const char *);
1968 extern int peer_aslist_unset(struct peer
*, afi_t
, safi_t
, int);
1970 extern int peer_route_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
, int,
1971 const char *name
, struct route_map
*route_map
);
1972 extern int peer_route_map_unset(struct peer
*, afi_t
, safi_t
, int);
1974 extern int peer_unsuppress_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
1976 struct route_map
*route_map
);
1978 extern int peer_advertise_map_set(struct peer
*peer
, afi_t afi
, safi_t safi
,
1979 const char *advertise_name
,
1980 struct route_map
*advertise_map
,
1981 const char *condition_name
,
1982 struct route_map
*condition_map
,
1985 extern int peer_password_set(struct peer
*, const char *);
1986 extern int peer_password_unset(struct peer
*);
1988 extern int peer_unsuppress_map_unset(struct peer
*, afi_t
, safi_t
);
1990 extern int peer_advertise_map_unset(struct peer
*peer
, afi_t afi
, safi_t safi
,
1991 const char *advertise_name
,
1992 struct route_map
*advertise_map
,
1993 const char *condition_name
,
1994 struct route_map
*condition_map
,
1997 extern int peer_maximum_prefix_set(struct peer
*, afi_t
, safi_t
, uint32_t,
1998 uint8_t, int, uint16_t, bool force
);
1999 extern int peer_maximum_prefix_unset(struct peer
*, afi_t
, safi_t
);
2001 extern int peer_clear(struct peer
*, struct listnode
**);
2002 extern int peer_clear_soft(struct peer
*, afi_t
, safi_t
, enum bgp_clear_type
);
2004 extern int peer_ttl_security_hops_set(struct peer
*, int);
2005 extern int peer_ttl_security_hops_unset(struct peer
*);
2007 extern void peer_tx_shutdown_message_set(struct peer
*, const char *msg
);
2008 extern void peer_tx_shutdown_message_unset(struct peer
*);
2010 extern int bgp_route_map_update_timer(struct thread
*thread
);
2011 extern void bgp_route_map_terminate(void);
2013 extern int peer_cmp(struct peer
*p1
, struct peer
*p2
);
2015 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi
, iana_safi_t pkt_safi
,
2016 afi_t
*afi
, safi_t
*safi
);
2017 extern int bgp_map_afi_safi_int2iana(afi_t afi
, safi_t safi
,
2018 iana_afi_t
*pkt_afi
,
2019 iana_safi_t
*pkt_safi
);
2021 extern struct peer_af
*peer_af_create(struct peer
*, afi_t
, safi_t
);
2022 extern struct peer_af
*peer_af_find(struct peer
*, afi_t
, safi_t
);
2023 extern int peer_af_delete(struct peer
*, afi_t
, safi_t
);
2025 extern void bgp_shutdown_enable(struct bgp
*bgp
, const char *msg
);
2026 extern void bgp_shutdown_disable(struct bgp
*bgp
);
2028 extern void bgp_close(void);
2029 extern void bgp_free(struct bgp
*);
2030 void bgp_gr_apply_running_config(void);
2033 int bgp_global_gr_init(struct bgp
*bgp
);
2034 int bgp_peer_gr_init(struct peer
*peer
);
2037 #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list) \
2039 struct peer *peer_loop; \
2040 bool gr_router_detected = false; \
2041 struct listnode *node = {0}; \
2042 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) { \
2043 if (CHECK_FLAG(peer_loop->flags, \
2044 PEER_FLAG_GRACEFUL_RESTART)) \
2045 gr_router_detected = true; \
2047 if (gr_router_detected \
2048 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
2049 bgp_zebra_send_capabilities(_bgp, false); \
2050 } else if (!gr_router_detected \
2051 && _bgp->present_zebra_gr_state \
2052 == ZEBRA_GR_ENABLE) { \
2053 bgp_zebra_send_capabilities(_bgp, true); \
2057 static inline struct bgp
*bgp_lock(struct bgp
*bgp
)
2063 static inline void bgp_unlock(struct bgp
*bgp
)
2065 assert(bgp
->lock
> 0);
2066 if (--bgp
->lock
== 0)
2070 static inline int afindex(afi_t afi
, safi_t safi
)
2076 return BGP_AF_IPV4_UNICAST
;
2077 case SAFI_MULTICAST
:
2078 return BGP_AF_IPV4_MULTICAST
;
2079 case SAFI_LABELED_UNICAST
:
2080 return BGP_AF_IPV4_LBL_UNICAST
;
2082 return BGP_AF_IPV4_VPN
;
2084 return BGP_AF_IPV4_ENCAP
;
2086 return BGP_AF_IPV4_FLOWSPEC
;
2094 return BGP_AF_IPV6_UNICAST
;
2095 case SAFI_MULTICAST
:
2096 return BGP_AF_IPV6_MULTICAST
;
2097 case SAFI_LABELED_UNICAST
:
2098 return BGP_AF_IPV6_LBL_UNICAST
;
2100 return BGP_AF_IPV6_VPN
;
2102 return BGP_AF_IPV6_ENCAP
;
2104 return BGP_AF_IPV6_FLOWSPEC
;
2112 return BGP_AF_L2VPN_EVPN
;
2121 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
2122 static inline int peer_group_active(struct peer
*peer
)
2124 if (!CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
) && peer
->group
)
2129 /* If peer is negotiated at least one address family return 1. */
2130 static inline int peer_afi_active_nego(const struct peer
*peer
, afi_t afi
)
2132 if (peer
->afc_nego
[afi
][SAFI_UNICAST
]
2133 || peer
->afc_nego
[afi
][SAFI_MULTICAST
]
2134 || peer
->afc_nego
[afi
][SAFI_LABELED_UNICAST
]
2135 || peer
->afc_nego
[afi
][SAFI_MPLS_VPN
]
2136 || peer
->afc_nego
[afi
][SAFI_ENCAP
]
2137 || peer
->afc_nego
[afi
][SAFI_FLOWSPEC
]
2138 || peer
->afc_nego
[afi
][SAFI_EVPN
])
2143 /* If at least one address family activated for group, return 1. */
2144 static inline int peer_group_af_configured(struct peer_group
*group
)
2146 struct peer
*peer
= group
->conf
;
2148 if (peer
->afc
[AFI_IP
][SAFI_UNICAST
] || peer
->afc
[AFI_IP
][SAFI_MULTICAST
]
2149 || peer
->afc
[AFI_IP
][SAFI_LABELED_UNICAST
]
2150 || peer
->afc
[AFI_IP
][SAFI_FLOWSPEC
]
2151 || peer
->afc
[AFI_IP
][SAFI_MPLS_VPN
] || peer
->afc
[AFI_IP
][SAFI_ENCAP
]
2152 || peer
->afc
[AFI_IP6
][SAFI_UNICAST
]
2153 || peer
->afc
[AFI_IP6
][SAFI_MULTICAST
]
2154 || peer
->afc
[AFI_IP6
][SAFI_LABELED_UNICAST
]
2155 || peer
->afc
[AFI_IP6
][SAFI_MPLS_VPN
]
2156 || peer
->afc
[AFI_IP6
][SAFI_ENCAP
]
2157 || peer
->afc
[AFI_IP6
][SAFI_FLOWSPEC
]
2158 || peer
->afc
[AFI_L2VPN
][SAFI_EVPN
])
2163 static inline char *timestamp_string(time_t ts
)
2166 tbuf
= time(NULL
) - (bgp_clock() - ts
);
2167 return ctime(&tbuf
);
2170 static inline int peer_established(struct peer
*peer
)
2172 if (peer
->status
== Established
)
2177 static inline int peer_dynamic_neighbor(struct peer
*peer
)
2179 return (CHECK_FLAG(peer
->flags
, PEER_FLAG_DYNAMIC_NEIGHBOR
)) ? 1 : 0;
2182 static inline int peer_cap_enhe(struct peer
*peer
, afi_t afi
, safi_t safi
)
2184 return (CHECK_FLAG(peer
->af_cap
[afi
][safi
], PEER_CAP_ENHE_AF_NEGO
));
2187 /* Lookup VRF for BGP instance based on its type. */
2188 static inline struct vrf
*bgp_vrf_lookup_by_instance_type(struct bgp
*bgp
)
2192 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_DEFAULT
)
2193 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
2194 else if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
)
2195 vrf
= vrf_lookup_by_name(bgp
->name
);
2202 /* Link BGP instance to VRF. */
2203 static inline void bgp_vrf_link(struct bgp
*bgp
, struct vrf
*vrf
)
2205 bgp
->vrf_id
= vrf
->vrf_id
;
2206 if (vrf
->info
!= (void *)bgp
)
2207 vrf
->info
= (void *)bgp_lock(bgp
);
2210 /* Unlink BGP instance from VRF. */
2211 static inline void bgp_vrf_unlink(struct bgp
*bgp
, struct vrf
*vrf
)
2213 if (vrf
->info
== (void *)bgp
) {
2217 bgp
->vrf_id
= VRF_UNKNOWN
;
2220 static inline bool bgp_in_graceful_shutdown(struct bgp
*bgp
)
2222 /* True if either set for this instance or globally */
2223 return (!!CHECK_FLAG(bgp
->flags
, BGP_FLAG_GRACEFUL_SHUTDOWN
) ||
2224 !!CHECK_FLAG(bm
->flags
, BM_FLAG_GRACEFUL_SHUTDOWN
));
2227 extern void bgp_unset_redist_vrf_bitmaps(struct bgp
*, vrf_id_t
);
2229 /* For benefit of rfapi */
2230 extern struct peer
*peer_new(struct bgp
*bgp
);
2232 extern struct peer
*peer_lookup_in_view(struct vty
*vty
, struct bgp
*bgp
,
2233 const char *ip_str
, bool use_json
);
2234 extern int bgp_lookup_by_as_name_type(struct bgp
**bgp_val
, as_t
*as
,
2236 enum bgp_instance_type inst_type
);
2239 DECLARE_HOOK(peer_status_changed
, (struct peer
* peer
), (peer
))
2240 void peer_nsf_stop(struct peer
*peer
);
2242 #endif /* _QUAGGA_BGPD_H */