back to topotato report
topotato coverage report
Current view: top level - bgpd - bgpd.h (source / functions) Hit Total Coverage
Test: aggregated run ( view descriptions ) Lines: 73 93 78.5 %
Date: 2023-02-24 19:38:44 Functions: 4 6 66.7 %

          Line data    Source code
       1             : /* BGP message definition header.
       2             :  * Copyright (C) 1996, 97, 98, 99, 2000 Kunihiro Ishiguro
       3             :  *
       4             :  * This file is part of GNU Zebra.
       5             :  *
       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
       9             :  * later version.
      10             :  *
      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.
      15             :  *
      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
      19             :  */
      20             : 
      21             : #ifndef _QUAGGA_BGPD_H
      22             : #define _QUAGGA_BGPD_H
      23             : 
      24             : #include "qobj.h"
      25             : #include <pthread.h>
      26             : 
      27             : #include "hook.h"
      28             : #include "frr_pthread.h"
      29             : #include "lib/json.h"
      30             : #include "vrf.h"
      31             : #include "vty.h"
      32             : #include "srv6.h"
      33             : #include "iana_afi.h"
      34             : 
      35             : /* For union sockunion.  */
      36             : #include "queue.h"
      37             : #include "sockunion.h"
      38             : #include "routemap.h"
      39             : #include "linklist.h"
      40             : #include "defaults.h"
      41             : #include "bgp_memory.h"
      42             : #include "bitfield.h"
      43             : #include "vxlan.h"
      44             : #include "bgp_labelpool.h"
      45             : #include "bgp_addpath_types.h"
      46             : #include "bgp_nexthop.h"
      47             : #include "bgp_io.h"
      48             : 
      49             : #include "lib/bfd.h"
      50             : 
      51             : #define BGP_MAX_HOSTNAME 64     /* Linux max, is larger than most other sys */
      52             : #define BGP_PEER_MAX_HASH_SIZE 16384
      53             : 
      54             : /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
      55             : #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
      56             : 
      57             : struct update_subgroup;
      58             : struct bpacket;
      59             : struct bgp_pbr_config;
      60             : 
      61             : /*
      62             :  * Allow the neighbor XXXX remote-as to take internal or external
      63             :  * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
      64             :  * behavior
      65             :  * in the system.
      66             :  */
      67             : enum { AS_UNSPECIFIED = 0,
      68             :        AS_SPECIFIED,
      69             :        AS_INTERNAL,
      70             :        AS_EXTERNAL,
      71             : };
      72             : 
      73             : /* Zebra Gracaful Restart states */
      74             : enum zebra_gr_mode {
      75             :         ZEBRA_GR_DISABLE = 0,
      76             :         ZEBRA_GR_ENABLE
      77             : };
      78             : 
      79             : /* Typedef BGP specific types.  */
      80             : typedef uint32_t as_t;
      81             : typedef uint16_t as16_t; /* we may still encounter 16 Bit asnums */
      82             : typedef uint16_t bgp_size_t;
      83             : 
      84             : enum bgp_af_index {
      85             :         BGP_AF_START,
      86             :         BGP_AF_IPV4_UNICAST = BGP_AF_START,
      87             :         BGP_AF_IPV4_MULTICAST,
      88             :         BGP_AF_IPV4_VPN,
      89             :         BGP_AF_IPV6_UNICAST,
      90             :         BGP_AF_IPV6_MULTICAST,
      91             :         BGP_AF_IPV6_VPN,
      92             :         BGP_AF_IPV4_ENCAP,
      93             :         BGP_AF_IPV6_ENCAP,
      94             :         BGP_AF_L2VPN_EVPN,
      95             :         BGP_AF_IPV4_LBL_UNICAST,
      96             :         BGP_AF_IPV6_LBL_UNICAST,
      97             :         BGP_AF_IPV4_FLOWSPEC,
      98             :         BGP_AF_IPV6_FLOWSPEC,
      99             :         BGP_AF_MAX
     100             : };
     101             : 
     102             : #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
     103             : 
     104             : #define FOREACH_SAFI(safi)                                            \
     105             :         for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
     106             : 
     107             : extern struct frr_pthread *bgp_pth_io;
     108             : extern struct frr_pthread *bgp_pth_ka;
     109             : 
     110             : /* BGP master for system wide configurations and variables.  */
     111             : struct bgp_master {
     112             :         /* BGP instance list.  */
     113             :         struct list *bgp;
     114             : 
     115             :         /* BGP thread master.  */
     116             :         struct thread_master *master;
     117             : 
     118             :         /* Listening sockets */
     119             :         struct list *listen_sockets;
     120             : 
     121             :         /* BGP port number.  */
     122             :         uint16_t port;
     123             : 
     124             :         /* Listener addresses */
     125             :         struct list *addresses;
     126             : 
     127             :         /* The Mac table */
     128             :         struct hash *self_mac_hash;
     129             : 
     130             :         /* BGP start time.  */
     131             :         time_t start_time;
     132             : 
     133             :         /* Various BGP global configuration.  */
     134             :         uint8_t options;
     135             : 
     136             : #define BGP_OPT_NO_FIB                   (1 << 0)
     137             : #define BGP_OPT_NO_LISTEN                (1 << 1)
     138             : #define BGP_OPT_NO_ZEBRA                 (1 << 2)
     139             : 
     140             :         uint64_t updgrp_idspace;
     141             :         uint64_t subgrp_idspace;
     142             : 
     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 */
     147             : 
     148             :         /* Id space for automatic RD derivation for an EVI/VRF */
     149             :         bitfield_t rd_idspace;
     150             : 
     151             :         /* dynamic mpls label allocation pool */
     152             :         struct labelpool labelpool;
     153             : 
     154             :         /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
     155             :         struct bgp* bgp_evpn;
     156             : 
     157             :         /* How big should we set the socket buffer size */
     158             :         uint32_t socket_buffer;
     159             : 
     160             :         /* Should we do wait for fib install globally? */
     161             :         bool wait_for_fib;
     162             : 
     163             :         /* EVPN multihoming */
     164             :         struct bgp_evpn_mh_info *mh_info;
     165             : 
     166             :         /* global update-delay timer values */
     167             :         uint16_t v_update_delay;
     168             :         uint16_t v_establish_wait;
     169             : 
     170             :         uint32_t flags;
     171             : #define BM_FLAG_GRACEFUL_SHUTDOWN        (1 << 0)
     172             : #define BM_FLAG_SEND_EXTRA_DATA_TO_ZEBRA (1 << 1)
     173             : 
     174             :         bool terminating;       /* global flag that sigint terminate seen */
     175             : 
     176             :         /* DSCP value for TCP sessions */
     177             :         uint8_t tcp_dscp;
     178             : 
     179             : #define BM_DEFAULT_Q_LIMIT 10000
     180             :         uint32_t inq_limit;
     181             :         uint32_t outq_limit;
     182             : 
     183             :         QOBJ_FIELDS;
     184             : };
     185             : DECLARE_QOBJ_TYPE(bgp_master);
     186             : 
     187             : /* BGP route-map structure.  */
     188             : struct bgp_rmap {
     189             :         char *name;
     190             :         struct route_map *map;
     191             : };
     192             : 
     193             : struct bgp_redist {
     194             :         unsigned short instance;
     195             : 
     196             :         /* BGP redistribute metric configuration. */
     197             :         uint8_t redist_metric_flag;
     198             :         uint32_t redist_metric;
     199             : 
     200             :         /* BGP redistribute route-map.  */
     201             :         struct bgp_rmap rmap;
     202             : };
     203             : 
     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
     208             : };
     209             : 
     210             : struct vpn_policy {
     211             :         struct bgp *bgp; /* parent */
     212             :         afi_t afi;
     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];
     217             : 
     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 */
     223             :         uint32_t flags;
     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)
     228             : 
     229             :         /*
     230             :          * If we are importing another vrf into us keep a list of
     231             :          * vrf names that are being imported into us.
     232             :          */
     233             :         struct list *import_vrf;
     234             : 
     235             :         /*
     236             :          * if we are being exported to another vrf keep a list of
     237             :          * vrf names that we are being exported to.
     238             :          */
     239             :         struct list *export_vrf;
     240             : 
     241             :         /*
     242             :          * Segment-Routing SRv6 Mode
     243             :          */
     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;
     249             : };
     250             : 
     251             : /*
     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.
     258             :  */
     259             : enum bgp_instance_type {
     260             :         BGP_INSTANCE_TYPE_DEFAULT,
     261             :         BGP_INSTANCE_TYPE_VRF,
     262             :         BGP_INSTANCE_TYPE_VIEW
     263             : };
     264             : 
     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)))
     270             : 
     271             : /* BGP GR Global ds */
     272             : 
     273             : #define BGP_GLOBAL_GR_MODE 4
     274             : #define BGP_GLOBAL_GR_EVENT_CMD 4
     275             : 
     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;
     282             :         /* Deferral Timer */
     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];
     292             : };
     293             : 
     294             : enum global_mode {
     295             :         GLOBAL_HELPER = 0, /* This is the default mode */
     296             :         GLOBAL_GR,
     297             :         GLOBAL_DISABLE,
     298             :         GLOBAL_INVALID
     299             : };
     300             : 
     301             : enum global_gr_command {
     302             :         GLOBAL_GR_CMD = 0,
     303             :         NO_GLOBAL_GR_CMD,
     304             :         GLOBAL_DISABLE_CMD,
     305             :         NO_GLOBAL_DISABLE_CMD
     306             : };
     307             : 
     308             : #define BGP_GR_SUCCESS 0
     309             : #define BGP_GR_FAILURE 1
     310             : 
     311             : /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
     312             :  * do weighted ECMP. Note: This applies after multipath computation.
     313             :  */
     314             : enum bgp_link_bw_handling {
     315             :         /* Do ECMP if some paths don't have LB - default */
     316             :         BGP_LINK_BW_ECMP,
     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
     323             : };
     324             : 
     325             : RB_HEAD(bgp_es_vrf_rb_head, bgp_evpn_es_vrf);
     326           0 : RB_PROTOTYPE(bgp_es_vrf_rb_head, bgp_evpn_es_vrf, rb_node, bgp_es_vrf_rb_cmp);
     327             : 
     328             : struct bgp_snmp_stats {
     329             :         /* SNMP variables for mplsL3Vpn*/
     330             :         time_t creation_time;
     331             :         time_t modify_time;
     332             :         bool active;
     333             :         uint32_t routes_added;
     334             :         uint32_t routes_deleted;
     335             : };
     336             : 
     337             : struct bgp_srv6_function {
     338             :         struct in6_addr sid;
     339             :         char locator_name[SRV6_LOCNAME_SIZE];
     340             : };
     341             : 
     342             : /* BGP instance structure.  */
     343             : struct bgp {
     344             :         /* AS number of this BGP instance.  */
     345             :         as_t as;
     346             : 
     347             :         /* Name of this BGP instance.  */
     348             :         char *name;
     349             :         char *name_pretty;      /* printable "VRF|VIEW name|default" */
     350             : 
     351             :         /* Type of instance and VRF id. */
     352             :         enum bgp_instance_type inst_type;
     353             :         vrf_id_t vrf_id;
     354             : 
     355             :         /* Reference count to allow peer_delete to finish after bgp_delete */
     356             :         int lock;
     357             : 
     358             :         /* Self peer.  */
     359             :         struct peer *peer_self;
     360             : 
     361             :         /* BGP peer. */
     362             :         struct list *peer;
     363             :         struct hash *peerhash;
     364             : 
     365             :         /* BGP peer group.  */
     366             :         struct list *group;
     367             : 
     368             :         /* The maximum number of BGP dynamic neighbors that can be created */
     369             :         int dynamic_neighbors_limit;
     370             : 
     371             :         /* The current number of BGP dynamic neighbors */
     372             :         int dynamic_neighbors_count;
     373             : 
     374             :         struct hash *update_groups[BGP_AF_MAX];
     375             : 
     376             :         /*
     377             :          * Global statistics for update groups.
     378             :          */
     379             :         struct {
     380             :                 uint32_t join_events;
     381             :                 uint32_t prune_events;
     382             :                 uint32_t merge_events;
     383             :                 uint32_t split_events;
     384             :                 uint32_t updgrp_switch_events;
     385             :                 uint32_t peer_refreshes_combined;
     386             :                 uint32_t adj_count;
     387             :                 uint32_t merge_checks_triggered;
     388             : 
     389             :                 uint32_t updgrps_created;
     390             :                 uint32_t updgrps_deleted;
     391             :                 uint32_t subgrps_created;
     392             :                 uint32_t subgrps_deleted;
     393             :         } update_group_stats;
     394             : 
     395             :         struct bgp_snmp_stats *snmp_stats;
     396             : 
     397             :         /* BGP configuration.  */
     398             :         uint16_t config;
     399             : #define BGP_CONFIG_CLUSTER_ID             (1 << 0)
     400             : #define BGP_CONFIG_CONFEDERATION          (1 << 1)
     401             : 
     402             :         /* BGP router identifier.  */
     403             :         struct in_addr router_id;
     404             :         struct in_addr router_id_static;
     405             :         struct in_addr router_id_zebra;
     406             : 
     407             :         /* BGP route reflector cluster ID.  */
     408             :         struct in_addr cluster_id;
     409             : 
     410             :         /* BGP confederation information.  */
     411             :         as_t confed_id;
     412             :         as_t *confed_peers;
     413             :         int confed_peers_cnt;
     414             : 
     415             :         struct thread
     416             :                 *t_startup; /* start-up timer on only once at the beginning */
     417             : 
     418             :         uint32_t v_maxmed_onstartup; /* Duration of max-med on start-up */
     419             : #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED  0 /* 0 means off, its the default */
     420             :         uint32_t maxmed_onstartup_value;     /* Max-med value when active on
     421             :                                                  start-up */
     422             :         struct thread
     423             :                 *t_maxmed_onstartup; /* non-null when max-med onstartup is on */
     424             :         uint8_t maxmed_onstartup_over; /* Flag to make it effective only once */
     425             : 
     426             :         bool v_maxmed_admin; /* true/false if max-med administrative is on/off
     427             :                               */
     428             : #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
     429             :         uint32_t maxmed_admin_value; /* Max-med value when administrative in on
     430             :                                       */
     431             : #define BGP_MAXMED_VALUE_DEFAULT  4294967294 /* Maximum by default */
     432             : 
     433             :         uint8_t maxmed_active; /* 1/0 if max-med is active or not */
     434             :         uint32_t maxmed_value; /* Max-med value when its active */
     435             : 
     436             :         /* BGP update delay on startup */
     437             :         struct thread *t_update_delay;
     438             :         struct thread *t_establish_wait;
     439             :         struct thread *t_revalidate[AFI_MAX][SAFI_MAX];
     440             : 
     441             :         uint8_t update_delay_over;
     442             :         uint8_t main_zebra_update_hold;
     443             :         uint8_t main_peers_update_hold;
     444             :         uint16_t v_update_delay;
     445             :         uint16_t v_establish_wait;
     446             :         char update_delay_begin_time[64];
     447             :         char update_delay_end_time[64];
     448             :         char update_delay_zebra_resume_time[64];
     449             :         char update_delay_peers_resume_time[64];
     450             :         uint32_t established;
     451             :         uint32_t restarted_peers;
     452             :         uint32_t implicit_eors;
     453             :         uint32_t explicit_eors;
     454             : #define BGP_UPDATE_DELAY_DEF              0
     455             : #define BGP_UPDATE_DELAY_MIN              0
     456             : #define BGP_UPDATE_DELAY_MAX              3600
     457             : 
     458             :         /* Reference bandwidth for BGP link-bandwidth. Used when
     459             :          * the LB value has to be computed based on some other
     460             :          * factor (e.g., number of multipaths for the prefix)
     461             :          * Value is in Mbps
     462             :          */
     463             :         uint32_t lb_ref_bw;
     464             : #define BGP_LINK_BW_REF_BW                1
     465             : 
     466             :         /* BGP flags. */
     467             :         uint64_t flags;
     468             : #define BGP_FLAG_ALWAYS_COMPARE_MED (1ULL << 0)
     469             : #define BGP_FLAG_DETERMINISTIC_MED (1ULL << 1)
     470             : #define BGP_FLAG_MED_MISSING_AS_WORST (1ULL << 2)
     471             : #define BGP_FLAG_MED_CONFED (1ULL << 3)
     472             : #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1ULL << 4)
     473             : #define BGP_FLAG_COMPARE_ROUTER_ID (1ULL << 5)
     474             : #define BGP_FLAG_ASPATH_IGNORE (1ULL << 6)
     475             : #define BGP_FLAG_IMPORT_CHECK (1ULL << 7)
     476             : #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1ULL << 8)
     477             : #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1ULL << 9)
     478             : 
     479             : /* This flag is set when we have full BGP Graceful-Restart mode enable */
     480             : #define BGP_FLAG_GRACEFUL_RESTART (1ULL << 10)
     481             : 
     482             : #define BGP_FLAG_ASPATH_CONFED (1ULL << 11)
     483             : #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1ULL << 12)
     484             : #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1ULL << 13)
     485             : #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1ULL << 14)
     486             : #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1ULL << 15)
     487             : #define BGP_FLAG_FORCE_STATIC_PROCESS (1ULL << 16)
     488             : #define BGP_FLAG_SHOW_HOSTNAME (1ULL << 17)
     489             : #define BGP_FLAG_GR_PRESERVE_FWD (1ULL << 18)
     490             : #define BGP_FLAG_GRACEFUL_SHUTDOWN (1ULL << 19)
     491             : #define BGP_FLAG_DELETE_IN_PROGRESS (1ULL << 20)
     492             : #define BGP_FLAG_SELECT_DEFER_DISABLE (1ULL << 21)
     493             : #define BGP_FLAG_GR_DISABLE_EOR (1ULL << 22)
     494             : #define BGP_FLAG_EBGP_REQUIRES_POLICY (1ULL << 23)
     495             : #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1ULL << 24)
     496             : 
     497             : /* This flag is set if the instance is in administrative shutdown */
     498             : #define BGP_FLAG_SHUTDOWN (1ULL << 25)
     499             : #define BGP_FLAG_SUPPRESS_FIB_PENDING (1ULL << 26)
     500             : #define BGP_FLAG_SUPPRESS_DUPLICATES (1ULL << 27)
     501             : #define BGP_FLAG_PEERTYPE_MULTIPATH_RELAX (1ULL << 29)
     502             : /* Indicate Graceful Restart support for BGP NOTIFICATION messages */
     503             : #define BGP_FLAG_GRACEFUL_NOTIFICATION (1ULL << 30)
     504             : /* Send Hard Reset CEASE Notification for 'Administrative Reset' */
     505             : #define BGP_FLAG_HARD_ADMIN_RESET (1ULL << 31)
     506             : /* Evaluate the AIGP attribute during the best path selection process */
     507             : #define BGP_FLAG_COMPARE_AIGP (1ULL << 32)
     508             : 
     509             :         /* BGP default address-families.
     510             :          * New peers inherit enabled afi/safis from bgp instance.
     511             :          */
     512             :         uint16_t default_af[AFI_MAX][SAFI_MAX];
     513             : 
     514             :         enum global_mode GLOBAL_GR_FSM[BGP_GLOBAL_GR_MODE]
     515             :                                       [BGP_GLOBAL_GR_EVENT_CMD];
     516             :         enum global_mode global_gr_present_state;
     517             : 
     518             :         /* This variable stores the current Graceful Restart state of Zebra
     519             :          * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
     520             :          */
     521             :         enum zebra_gr_mode present_zebra_gr_state;
     522             : 
     523             :         /* BGP Per AF flags */
     524             :         uint16_t af_flags[AFI_MAX][SAFI_MAX];
     525             : #define BGP_CONFIG_DAMPENING                            (1 << 0)
     526             : /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
     527             : #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST (1 << 1)
     528             : #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST_GW_IP (1 << 2)
     529             : #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST (1 << 3)
     530             : #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST_GW_IP (1 << 4)
     531             : #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 5)
     532             : #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 6)
     533             : /* import/export between address families */
     534             : #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 7)
     535             : #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 8)
     536             : /* vrf-route leaking flags */
     537             : #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 9)
     538             : #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 10)
     539             : /* vpnvx retain flag */
     540             : #define BGP_VPNVX_RETAIN_ROUTE_TARGET_ALL (1 << 11)
     541             : 
     542             :         /* BGP per AF peer count */
     543             :         uint32_t af_peer_count[AFI_MAX][SAFI_MAX];
     544             : 
     545             :         /* Tree for next-hop lookup cache. */
     546             :         struct bgp_nexthop_cache_head nexthop_cache_table[AFI_MAX];
     547             : 
     548             :         /* Tree for import-check */
     549             :         struct bgp_nexthop_cache_head import_check_table[AFI_MAX];
     550             : 
     551             :         struct bgp_table *connected_table[AFI_MAX];
     552             : 
     553             :         struct hash *address_hash;
     554             : 
     555             :         /* DB for all local tunnel-ips - used mainly for martian checks
     556             :            Currently it only has all VxLan tunnel IPs*/
     557             :         struct hash *tip_hash;
     558             : 
     559             :         /* Static route configuration.  */
     560             :         struct bgp_table *route[AFI_MAX][SAFI_MAX];
     561             : 
     562             :         /* Aggregate address configuration.  */
     563             :         struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
     564             : 
     565             :         /* BGP routing information base.  */
     566             :         struct bgp_table *rib[AFI_MAX][SAFI_MAX];
     567             : 
     568             :         /* BGP table route-map.  */
     569             :         struct bgp_rmap table_map[AFI_MAX][SAFI_MAX];
     570             : 
     571             :         /* BGP redistribute configuration. */
     572             :         struct list *redist[AFI_MAX][ZEBRA_ROUTE_MAX];
     573             : 
     574             :         /* Allocate MPLS labels */
     575             :         uint8_t allocate_mpls_labels[AFI_MAX][SAFI_MAX];
     576             : 
     577             :         /* Allocate hash entries to store policy routing information
     578             :          * The hash are used to host pbr rules somewhere.
     579             :          * Actually, pbr will only be used by flowspec
     580             :          * those hash elements will have relationship together as
     581             :          * illustrated in below diagram:
     582             :          *
     583             :          *  pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
     584             :          *              <----- pbr_match j <--- pbr_match_entry 1..m
     585             :          *              <----- pbr_rule k
     586             :          *
     587             :          * - here in BGP structure, the list of match and actions will
     588             :          * stand for the list of ipset sets, and table_ids in the kernel
     589             :          * - the arrow above between pbr_match and pbr_action indicate
     590             :          * that a backpointer permits match to find the action
     591             :          * - the arrow betwen match_entry and match is a hash list
     592             :          * contained in match, that lists the whole set of entries
     593             :          */
     594             :         struct hash *pbr_match_hash;
     595             :         struct hash *pbr_rule_hash;
     596             :         struct hash *pbr_action_hash;
     597             : 
     598             :         /* timer to re-evaluate neighbor default-originate route-maps */
     599             :         struct thread *t_rmap_def_originate_eval;
     600             : #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
     601             : 
     602             :         /* BGP distance configuration.  */
     603             :         uint8_t distance_ebgp[AFI_MAX][SAFI_MAX];
     604             :         uint8_t distance_ibgp[AFI_MAX][SAFI_MAX];
     605             :         uint8_t distance_local[AFI_MAX][SAFI_MAX];
     606             : 
     607             :         /* BGP default local-preference.  */
     608             :         uint32_t default_local_pref;
     609             : 
     610             :         /* BGP default subgroup pkt queue max  */
     611             :         uint32_t default_subgroup_pkt_queue_max;
     612             : 
     613             :         /* BGP default timer.  */
     614             :         uint32_t default_holdtime;
     615             :         uint32_t default_keepalive;
     616             :         uint32_t default_connect_retry;
     617             :         uint32_t default_delayopen;
     618             : 
     619             :         /* BGP minimum holdtime.  */
     620             :         uint16_t default_min_holdtime;
     621             : 
     622             :         /* BGP graceful restart */
     623             :         uint32_t restart_time;
     624             :         uint32_t stalepath_time;
     625             :         uint32_t select_defer_time;
     626             :         struct graceful_restart_info gr_info[AFI_MAX][SAFI_MAX];
     627             :         uint32_t rib_stale_time;
     628             : 
     629             :         /* BGP Long-lived Graceful Restart */
     630             :         uint32_t llgr_stale_time;
     631             : 
     632             : #define BGP_ROUTE_SELECT_DELAY 1
     633             : #define BGP_MAX_BEST_ROUTE_SELECT 10000
     634             :         /* Maximum-paths configuration */
     635             :         struct bgp_maxpaths_cfg {
     636             :                 uint16_t maxpaths_ebgp;
     637             :                 uint16_t maxpaths_ibgp;
     638             :                 bool same_clusterlen;
     639             :         } maxpaths[AFI_MAX][SAFI_MAX];
     640             : 
     641             :         _Atomic uint32_t wpkt_quanta; // max # packets to write per i/o cycle
     642             :         _Atomic uint32_t rpkt_quanta; // max # packets to read per i/o cycle
     643             : 
     644             :         /* Automatic coalesce adjust on/off */
     645             :         bool heuristic_coalesce;
     646             :         /* Actual coalesce time */
     647             :         uint32_t coalesce_time;
     648             : 
     649             :         /* Auto-shutdown new peers */
     650             :         bool autoshutdown;
     651             : 
     652             :         struct bgp_addpath_bgp_data tx_addpath;
     653             : 
     654             : #ifdef ENABLE_BGP_VNC
     655             :         struct rfapi_cfg *rfapi_cfg;
     656             :         struct rfapi *rfapi;
     657             : #endif
     658             : 
     659             :         /* EVPN related information */
     660             : 
     661             :         /* EVI hash table */
     662             :         struct hash *vnihash;
     663             : 
     664             :         /*
     665             :          * VNI hash table based on SVI ifindex as its key.
     666             :          * We use SVI ifindex as key to lookup a VNI table for gateway IP
     667             :          * overlay index recursive lookup.
     668             :          * For this purpose, a hashtable is added which optimizes this lookup.
     669             :          */
     670             :         struct hash *vni_svi_hash;
     671             : 
     672             :         /* EVPN enable - advertise gateway macip routes */
     673             :         int advertise_gw_macip;
     674             : 
     675             :         /* EVPN enable - advertise local VNIs and their MACs etc. */
     676             :         int advertise_all_vni;
     677             : 
     678             :         /* draft-ietf-idr-deprecate-as-set-confed-set
     679             :          * Reject aspaths with AS_SET and/or AS_CONFED_SET.
     680             :          */
     681             :         bool reject_as_sets;
     682             : 
     683             :         struct bgp_evpn_info *evpn_info;
     684             : 
     685             :         /* EVPN - use RFC 8365 to auto-derive RT */
     686             :         int advertise_autort_rfc8365;
     687             : 
     688             :         /*
     689             :          * Flooding mechanism for BUM packets for VxLAN-EVPN.
     690             :          */
     691             :         enum vxlan_flood_control vxlan_flood_ctrl;
     692             : 
     693             :         /* Hash table of Import RTs to EVIs */
     694             :         struct hash *import_rt_hash;
     695             : 
     696             :         /* Hash table of VRF import RTs to VRFs */
     697             :         struct hash *vrf_import_rt_hash;
     698             : 
     699             :         /* L3-VNI corresponding to this vrf */
     700             :         vni_t l3vni;
     701             : 
     702             :         /* router-mac to be used in mac-ip routes for this vrf */
     703             :         struct ethaddr rmac;
     704             : 
     705             :         /* originator ip - to be used as NH for type-5 routes */
     706             :         struct in_addr originator_ip;
     707             : 
     708             :         /* SVI associated with the L3-VNI corresponding to this vrf */
     709             :         ifindex_t l3vni_svi_ifindex;
     710             : 
     711             :         /* RB tree of ES-VRFs */
     712             :         struct bgp_es_vrf_rb_head es_vrf_rb_tree;
     713             : 
     714             :         /* Hash table of EVPN nexthops maintained per-tenant-VRF */
     715             :         struct hash *evpn_nh_table;
     716             : 
     717             :         /*
     718             :          * Flag resolve_overlay_index is used for recursive resolution
     719             :          * procedures for EVPN type-5 route's gateway IP overlay index.
     720             :          * When this flag is set, we build remote-ip-hash for
     721             :          * all L2VNIs and resolve overlay index nexthops using this hash.
     722             :          * Overlay index nexthops remain unresolved if this flag is not set.
     723             :          */
     724             :         bool resolve_overlay_index;
     725             : 
     726             :         /* vrf flags */
     727             :         uint32_t vrf_flags;
     728             : #define BGP_VRF_AUTO                        (1 << 0)
     729             : #define BGP_VRF_IMPORT_RT_CFGD              (1 << 1)
     730             : #define BGP_VRF_EXPORT_RT_CFGD              (1 << 2)
     731             : #define BGP_VRF_IMPORT_AUTO_RT_CFGD         (1 << 3) /* retain auto when cfgd */
     732             : #define BGP_VRF_EXPORT_AUTO_RT_CFGD         (1 << 4) /* retain auto when cfgd */
     733             : #define BGP_VRF_RD_CFGD                     (1 << 5)
     734             : #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY    (1 << 6)
     735             : /* per-VRF toVPN SID */
     736             : #define BGP_VRF_TOVPN_SID_AUTO              (1 << 7)
     737             : 
     738             :         /* unique ID for auto derivation of RD for this vrf */
     739             :         uint16_t vrf_rd_id;
     740             : 
     741             :         /* Automatically derived RD for this VRF */
     742             :         struct prefix_rd vrf_prd_auto;
     743             : 
     744             :         /* RD for this VRF */
     745             :         struct prefix_rd vrf_prd;
     746             : 
     747             :         /* import rt list for the vrf instance */
     748             :         struct list *vrf_import_rtl;
     749             : 
     750             :         /* export rt list for the vrf instance */
     751             :         struct list *vrf_export_rtl;
     752             : 
     753             :         /* list of corresponding l2vnis (struct bgpevpn) */
     754             :         struct list *l2vnis;
     755             : 
     756             :         /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
     757             :         struct bgp_rmap adv_cmd_rmap[AFI_MAX][SAFI_MAX];
     758             : 
     759             :         struct vpn_policy vpn_policy[AFI_MAX];
     760             : 
     761             :         struct bgp_pbr_config *bgp_pbr_cfg;
     762             : 
     763             :         /* Count of peers in established state */
     764             :         uint32_t established_peers;
     765             : 
     766             :         /* Weighted ECMP related config. */
     767             :         enum bgp_link_bw_handling lb_handling;
     768             : 
     769             :         /* Process Queue for handling routes */
     770             :         struct work_queue *process_queue;
     771             : 
     772             :         bool fast_convergence;
     773             : 
     774             :         /* BGP Conditional advertisement */
     775             :         uint32_t condition_check_period;
     776             :         uint32_t condition_filter_count;
     777             :         struct thread *t_condition_check;
     778             : 
     779             :         /* BGP VPN SRv6 backend */
     780             :         bool srv6_enabled;
     781             :         char srv6_locator_name[SRV6_LOCNAME_SIZE];
     782             :         struct list *srv6_locator_chunks;
     783             :         struct list *srv6_functions;
     784             :         uint32_t tovpn_sid_index; /* unset => set to 0 */
     785             :         struct in6_addr *tovpn_sid;
     786             :         struct srv6_locator_chunk *tovpn_sid_locator;
     787             :         uint32_t tovpn_sid_transpose_label;
     788             :         struct in6_addr *tovpn_zebra_vrf_sid_last_sent;
     789             : 
     790             :         /* TCP keepalive parameters for BGP connection */
     791             :         uint16_t tcp_keepalive_idle;
     792             :         uint16_t tcp_keepalive_intvl;
     793             :         uint16_t tcp_keepalive_probes;
     794             : 
     795             :         struct timeval ebgprequirespolicywarning;
     796             : #define FIFTEENMINUTE2USEC (int64_t)15 * 60 * 1000000
     797             : 
     798             :         bool allow_martian;
     799             : 
     800             :         QOBJ_FIELDS;
     801             : };
     802             : DECLARE_QOBJ_TYPE(bgp);
     803             : 
     804             : struct bgp_interface {
     805             : #define BGP_INTERFACE_MPLS_BGP_FORWARDING (1 << 0)
     806             :         uint32_t flags;
     807             : };
     808             : 
     809             : DECLARE_HOOK(bgp_inst_delete, (struct bgp *bgp), (bgp));
     810             : DECLARE_HOOK(bgp_inst_config_write,
     811             :                 (struct bgp *bgp, struct vty *vty),
     812             :                 (bgp, vty));
     813             : DECLARE_HOOK(bgp_config_end, (struct bgp *bgp), (bgp));
     814             : 
     815             : /* Thread callback information */
     816             : struct afi_safi_info {
     817             :         afi_t afi;
     818             :         safi_t safi;
     819             :         struct bgp *bgp;
     820             : };
     821             : 
     822             : #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
     823             : 
     824             : #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp)                                        \
     825             :         (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT                           \
     826             :          || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF                           \
     827             :              && bgp->vrf_id != VRF_UNKNOWN))
     828             : 
     829             : #define BGP_SELECT_DEFER_DISABLE(bgp)                                          \
     830             :         (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
     831             : 
     832             : #define BGP_SUPPRESS_FIB_ENABLED(bgp)                                          \
     833             :         (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING)                 \
     834             :          || bm->wait_for_fib)
     835             : 
     836             : /* BGP peer-group support. */
     837             : struct peer_group {
     838             :         /* Name of the peer-group. */
     839             :         char *name;
     840             : 
     841             :         /* Pointer to BGP.  */
     842             :         struct bgp *bgp;
     843             : 
     844             :         /* Peer-group client list. */
     845             :         struct list *peer;
     846             : 
     847             :         /** Dynamic neighbor listening ranges */
     848             :         struct list *listen_range[AFI_MAX];
     849             : 
     850             :         /* Peer-group config */
     851             :         struct peer *conf;
     852             : };
     853             : 
     854             : /* BGP Notify message format. */
     855             : struct bgp_notify {
     856             :         uint8_t code;
     857             :         uint8_t subcode;
     858             :         char *data;
     859             :         bgp_size_t length;
     860             :         uint8_t *raw_data;
     861             :         bool hard_reset;
     862             : };
     863             : 
     864             : /* Next hop self address. */
     865             : struct bgp_nexthop {
     866             :         struct interface *ifp;
     867             :         struct in_addr v4;
     868             :         struct in6_addr v6_global;
     869             :         struct in6_addr v6_local;
     870             : };
     871             : 
     872             : /* BGP addpath values */
     873             : #define BGP_ADDPATH_RX     1
     874             : #define BGP_ADDPATH_TX     2
     875             : #define BGP_ADDPATH_ID_LEN 4
     876             : 
     877             : #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
     878             : 
     879             : /* Route map direction */
     880             : #define RMAP_IN  0
     881             : #define RMAP_OUT 1
     882             : #define RMAP_MAX 2
     883             : 
     884             : #define BGP_DEFAULT_TTL         1
     885             : #define BGP_GTSM_HOPS_DISABLED  0
     886             : #define BGP_GTSM_HOPS_CONNECTED 1
     887             : 
     888             : /* Advertise map */
     889             : #define CONDITION_NON_EXIST     false
     890             : #define CONDITION_EXIST         true
     891             : 
     892             : enum update_type { UPDATE_TYPE_WITHDRAW, UPDATE_TYPE_ADVERTISE };
     893             : 
     894             : #include "filter.h"
     895             : 
     896             : /* BGP filter structure. */
     897             : struct bgp_filter {
     898             :         /* Distribute-list.  */
     899             :         struct {
     900             :                 char *name;
     901             :                 struct access_list *alist;
     902             :         } dlist[FILTER_MAX];
     903             : 
     904             :         /* Prefix-list.  */
     905             :         struct {
     906             :                 char *name;
     907             :                 struct prefix_list *plist;
     908             :         } plist[FILTER_MAX];
     909             : 
     910             :         /* Filter-list.  */
     911             :         struct {
     912             :                 char *name;
     913             :                 struct as_list *aslist;
     914             :         } aslist[FILTER_MAX];
     915             : 
     916             :         /* Route-map.  */
     917             :         struct {
     918             :                 char *name;
     919             :                 struct route_map *map;
     920             :         } map[RMAP_MAX];
     921             : 
     922             :         /* Unsuppress-map.  */
     923             :         struct {
     924             :                 char *name;
     925             :                 struct route_map *map;
     926             :         } usmap;
     927             : 
     928             :         /* Advertise-map */
     929             :         struct {
     930             :                 char *aname;
     931             :                 struct route_map *amap;
     932             : 
     933             :                 bool condition;
     934             : 
     935             :                 char *cname;
     936             :                 struct route_map *cmap;
     937             : 
     938             :                 enum update_type update_type;
     939             :         } advmap;
     940             : };
     941             : 
     942             : /* IBGP/EBGP identifier.  We also have a CONFED peer, which is to say,
     943             :    a peer who's AS is part of our Confederation.  */
     944             : enum bgp_peer_sort {
     945             :         BGP_PEER_UNSPECIFIED,
     946             :         BGP_PEER_IBGP,
     947             :         BGP_PEER_EBGP,
     948             :         BGP_PEER_INTERNAL,
     949             :         BGP_PEER_CONFED,
     950             : };
     951             : 
     952             : /* BGP message header and packet size.  */
     953             : #define BGP_MARKER_SIZE                         16
     954             : #define BGP_HEADER_SIZE                         19
     955             : #define BGP_STANDARD_MESSAGE_MAX_PACKET_SIZE 4096
     956             : #define BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE 65535
     957             : #define BGP_MAX_PACKET_SIZE BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
     958             : #define BGP_MAX_PACKET_SIZE_OVERFLOW          1024
     959             : 
     960             : /*
     961             :  * Trigger delay for bgp_announce_route().
     962             :  */
     963             : #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS  100
     964             : #define BGP_ANNOUNCE_ROUTE_DELAY_MS        500
     965             : 
     966             : struct peer_af {
     967             :         /* back pointer to the peer */
     968             :         struct peer *peer;
     969             : 
     970             :         /* which subgroup the peer_af belongs to */
     971             :         struct update_subgroup *subgroup;
     972             : 
     973             :         /* for being part of an update subgroup's peer list */
     974             :         LIST_ENTRY(peer_af) subgrp_train;
     975             : 
     976             :         /* for being part of a packet's peer list */
     977             :         LIST_ENTRY(peer_af) pkt_train;
     978             : 
     979             :         struct bpacket *next_pkt_to_send;
     980             : 
     981             :         /*
     982             :          * Trigger timer for bgp_announce_route().
     983             :          */
     984             :         struct thread *t_announce_route;
     985             : 
     986             :         afi_t afi;
     987             :         safi_t safi;
     988             :         int afid;
     989             : };
     990             : /* BGP GR per peer ds */
     991             : 
     992             : #define BGP_PEER_GR_MODE 5
     993             : #define BGP_PEER_GR_EVENT_CMD 6
     994             : 
     995             : enum peer_mode {
     996             :         PEER_HELPER = 0,
     997             :         PEER_GR,
     998             :         PEER_DISABLE,
     999             :         PEER_INVALID,
    1000             :         PEER_GLOBAL_INHERIT /* This is the default mode */
    1001             : 
    1002             : };
    1003             : 
    1004             : enum peer_gr_command {
    1005             :         PEER_GR_CMD = 0,
    1006             :         NO_PEER_GR_CMD,
    1007             :         PEER_DISABLE_CMD,
    1008             :         NO_PEER_DISABLE_CMD,
    1009             :         PEER_HELPER_CMD,
    1010             :         NO_PEER_HELPER_CMD
    1011             : };
    1012             : 
    1013             : typedef unsigned int  (*bgp_peer_gr_action_ptr)(struct peer *, int, int);
    1014             : 
    1015             : struct bgp_peer_gr {
    1016             :         enum peer_mode next_state;
    1017             :         bgp_peer_gr_action_ptr action_fun;
    1018             : };
    1019             : 
    1020             : /*
    1021             :  * BGP FSM event codes, per RFC 4271 ss. 8.1
    1022             :  */
    1023             : enum bgp_fsm_rfc_codes {
    1024             :         BGP_FSM_ManualStart = 1,
    1025             :         BGP_FSM_ManualStop = 2,
    1026             :         BGP_FSM_AutomaticStart = 3,
    1027             :         BGP_FSM_ManualStart_with_PassiveTcpEstablishment = 4,
    1028             :         BGP_FSM_AutomaticStart_with_PassiveTcpEstablishment = 5,
    1029             :         BGP_FSM_AutomaticStart_with_DampPeerOscillations = 6,
    1030             :         BGP_FSM_AutomaticStart_with_DampPeerOscillations_and_PassiveTcpEstablishment =
    1031             :                 7,
    1032             :         BGP_FSM_AutomaticStop = 8,
    1033             :         BGP_FSM_ConnectRetryTimer_Expires = 9,
    1034             :         BGP_FSM_HoldTimer_Expires = 10,
    1035             :         BGP_FSM_KeepaliveTimer_Expires = 11,
    1036             :         BGP_FSM_DelayOpenTimer_Expires = 12,
    1037             :         BGP_FSM_IdleHoldTimer_Expires = 13,
    1038             :         BGP_FSM_TcpConnection_Valid = 14,
    1039             :         BGP_FSM_Tcp_CR_Invalid = 15,
    1040             :         BGP_FSM_Tcp_CR_Acked = 16,
    1041             :         BGP_FSM_TcpConnectionConfirmed = 17,
    1042             :         BGP_FSM_TcpConnectionFails = 18,
    1043             :         BGP_FSM_BGPOpen = 19,
    1044             :         BGP_FSM_BGPOpen_with_DelayOpenTimer_running = 20,
    1045             :         BGP_FSM_BGPHeaderErr = 21,
    1046             :         BGP_FSM_BGPOpenMsgErr = 22,
    1047             :         BGP_FSM_OpenCollisionDump = 23,
    1048             :         BGP_FSM_NotifMsgVerErr = 24,
    1049             :         BGP_FSM_NotifMsg = 25,
    1050             :         BGP_FSM_KeepAliveMsg = 26,
    1051             :         BGP_FSM_UpdateMsg = 27,
    1052             :         BGP_FSM_UpdateMsgErr = 28
    1053             : };
    1054             : 
    1055             : /*
    1056             :  * BGP finite state machine events
    1057             :  *
    1058             :  * Note: these do not correspond to RFC-defined event codes. Those are
    1059             :  * defined elsewhere.
    1060             :  */
    1061             : enum bgp_fsm_events {
    1062             :         BGP_Start = 1,
    1063             :         BGP_Stop,
    1064             :         TCP_connection_open,
    1065             :         TCP_connection_open_w_delay,
    1066             :         TCP_connection_closed,
    1067             :         TCP_connection_open_failed,
    1068             :         TCP_fatal_error,
    1069             :         ConnectRetry_timer_expired,
    1070             :         Hold_Timer_expired,
    1071             :         KeepAlive_timer_expired,
    1072             :         DelayOpen_timer_expired,
    1073             :         Receive_OPEN_message,
    1074             :         Receive_KEEPALIVE_message,
    1075             :         Receive_UPDATE_message,
    1076             :         Receive_NOTIFICATION_message,
    1077             :         Clearing_Completed,
    1078             :         BGP_EVENTS_MAX,
    1079             : };
    1080             : 
    1081             : /* BGP finite state machine status.  */
    1082             : enum bgp_fsm_status {
    1083             :         Idle = 1,
    1084             :         Connect,
    1085             :         Active,
    1086             :         OpenSent,
    1087             :         OpenConfirm,
    1088             :         Established,
    1089             :         Clearing,
    1090             :         Deleted,
    1091             :         BGP_STATUS_MAX,
    1092             : };
    1093             : 
    1094             : #define PEER_HOSTNAME(peer) ((peer)->host ? (peer)->host : "(unknown peer)")
    1095             : 
    1096             : struct llgr_info {
    1097             :         uint32_t stale_time;
    1098             :         uint8_t flags;
    1099             : };
    1100             : 
    1101             : /* BGP neighbor structure. */
    1102             : struct peer {
    1103             :         /* BGP structure.  */
    1104             :         struct bgp *bgp;
    1105             : 
    1106             :         /* reference count, primarily to allow bgp_process'ing of route_node's
    1107             :          * to be done after a struct peer is deleted.
    1108             :          *
    1109             :          * named 'lock' for hysterical reasons within Quagga.
    1110             :          */
    1111             :         int lock;
    1112             : 
    1113             :         /* BGP peer group.  */
    1114             :         struct peer_group *group;
    1115             :         uint64_t version[AFI_MAX][SAFI_MAX];
    1116             : 
    1117             :         /* BGP peer_af structures, per configured AF on this peer */
    1118             :         struct peer_af *peer_af_array[BGP_AF_MAX];
    1119             : 
    1120             :         /* Peer's remote AS number. */
    1121             :         int as_type;
    1122             :         as_t as;
    1123             : 
    1124             :         /* Peer's local AS number. */
    1125             :         as_t local_as;
    1126             : 
    1127             :         enum bgp_peer_sort sort;
    1128             : 
    1129             :         /* Peer's Change local AS number. */
    1130             :         as_t change_local_as;
    1131             : 
    1132             :         /* Remote router ID. */
    1133             :         struct in_addr remote_id;
    1134             : 
    1135             :         /* Local router ID. */
    1136             :         struct in_addr local_id;
    1137             : 
    1138             :         /* Packet receive and send buffer. */
    1139             :         pthread_mutex_t io_mtx;   // guards ibuf, obuf
    1140             :         struct stream_fifo *ibuf; // packets waiting to be processed
    1141             :         struct stream_fifo *obuf; // packets waiting to be written
    1142             : 
    1143             :         /* used as a block to deposit raw wire data to */
    1144             :         uint8_t ibuf_scratch[BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
    1145             :                              * BGP_READ_PACKET_MAX];
    1146             :         struct ringbuf *ibuf_work; // WiP buffer used by bgp_read() only
    1147             :         struct stream *obuf_work;  // WiP buffer used to construct packets
    1148             : 
    1149             :         struct stream *curr; // the current packet being parsed
    1150             : 
    1151             :         /* We use a separate stream to encode MP_REACH_NLRI for efficient
    1152             :          * NLRI packing. peer->obuf_work stores all the other attributes. The
    1153             :          * actual packet is then constructed by concatenating the two.
    1154             :          */
    1155             :         struct stream *scratch;
    1156             : 
    1157             :         /* the doppelganger peer structure, due to dual TCP conn setup */
    1158             :         struct peer *doppelganger;
    1159             : 
    1160             :         /* Status of the peer. */
    1161             :         enum bgp_fsm_status status;
    1162             :         enum bgp_fsm_status ostatus;
    1163             : 
    1164             :         /* FSM events, stored for debug purposes.
    1165             :          * Note: uchar used for reduced memory usage.
    1166             :          */
    1167             :         enum bgp_fsm_events cur_event;
    1168             :         enum bgp_fsm_events last_event;
    1169             :         enum bgp_fsm_events last_major_event;
    1170             : 
    1171             :         /* Peer index, used for dumping TABLE_DUMP_V2 format */
    1172             :         uint16_t table_dump_index;
    1173             : 
    1174             :         /* Peer information */
    1175             :         int fd;              /* File descriptor */
    1176             :         int ttl;             /* TTL of TCP connection to the peer. */
    1177             :         int rtt;             /* Estimated round-trip-time from TCP_INFO */
    1178             :         int rtt_expected; /* Expected round-trip-time for a peer */
    1179             :         uint8_t rtt_keepalive_rcv; /* Received count for RTT shutdown */
    1180             :         uint8_t rtt_keepalive_conf; /* Configured count for RTT shutdown */
    1181             :         int gtsm_hops;       /* minimum hopcount to peer */
    1182             :         char *desc;       /* Description of the peer. */
    1183             :         unsigned short port; /* Destination port for peer */
    1184             :         char *host;       /* Printable address of the peer. */
    1185             :         union sockunion su;  /* Sockunion address of the peer. */
    1186             : #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
    1187             :         time_t uptime;       /* Last Up/Down time */
    1188             :         time_t readtime;     /* Last read time */
    1189             :         time_t resettime;    /* Last reset time */
    1190             : 
    1191             :         char *conf_if;   /* neighbor interface config name. */
    1192             :         struct interface *ifp; /* corresponding interface */
    1193             :         char *ifname;     /* bind interface name. */
    1194             :         char *update_if;
    1195             :         union sockunion *update_source;
    1196             : 
    1197             :         union sockunion *su_local;  /* Sockunion of local address.  */
    1198             :         union sockunion *su_remote; /* Sockunion of remote address.  */
    1199             :         int shared_network;      /* Is this peer shared same network. */
    1200             :         struct bgp_nexthop nexthop; /* Nexthop */
    1201             : 
    1202             :         /* Roles in bgp session */
    1203             :         uint8_t local_role;
    1204             :         uint8_t remote_role;
    1205             : #define ROLE_PROVIDER                       0
    1206             : #define ROLE_RS_SERVER                      1
    1207             : #define ROLE_RS_CLIENT                      2
    1208             : #define ROLE_CUSTOMER                       3
    1209             : #define ROLE_PEER                           4
    1210             : #define ROLE_UNDEFINED                    255
    1211             : 
    1212             : #define ROLE_NAME_MAX_LEN                  20
    1213             : 
    1214             :         /* Peer address family configuration. */
    1215             :         uint8_t afc[AFI_MAX][SAFI_MAX];
    1216             :         uint8_t afc_nego[AFI_MAX][SAFI_MAX];
    1217             :         uint8_t afc_adv[AFI_MAX][SAFI_MAX];
    1218             :         uint8_t afc_recv[AFI_MAX][SAFI_MAX];
    1219             : 
    1220             :         /* Capability flags (reset in bgp_stop) */
    1221             :         uint32_t cap;
    1222             : #define PEER_CAP_REFRESH_ADV                (1U << 0) /* refresh advertised */
    1223             : #define PEER_CAP_REFRESH_OLD_RCV            (1U << 1) /* refresh old received */
    1224             : #define PEER_CAP_REFRESH_NEW_RCV            (1U << 2) /* refresh rfc received */
    1225             : #define PEER_CAP_DYNAMIC_ADV                (1U << 3) /* dynamic advertised */
    1226             : #define PEER_CAP_DYNAMIC_RCV                (1U << 4) /* dynamic received */
    1227             : #define PEER_CAP_RESTART_ADV                (1U << 5) /* restart advertised */
    1228             : #define PEER_CAP_RESTART_RCV                (1U << 6) /* restart received */
    1229             : #define PEER_CAP_AS4_ADV                    (1U << 7) /* as4 advertised */
    1230             : #define PEER_CAP_AS4_RCV                    (1U << 8) /* as4 received */
    1231             : /* sent graceful-restart restart (R) bit */
    1232             : #define PEER_CAP_GRACEFUL_RESTART_R_BIT_ADV (1U << 9)
    1233             : /* received graceful-restart restart (R) bit */
    1234             : #define PEER_CAP_GRACEFUL_RESTART_R_BIT_RCV (1U << 10)
    1235             : #define PEER_CAP_ADDPATH_ADV                (1U << 11) /* addpath advertised */
    1236             : #define PEER_CAP_ADDPATH_RCV                (1U << 12) /* addpath received */
    1237             : #define PEER_CAP_ENHE_ADV                   (1U << 13) /* Extended nexthop advertised */
    1238             : #define PEER_CAP_ENHE_RCV                   (1U << 14) /* Extended nexthop received */
    1239             : #define PEER_CAP_HOSTNAME_ADV               (1U << 15) /* hostname advertised */
    1240             : #define PEER_CAP_HOSTNAME_RCV               (1U << 16) /* hostname received */
    1241             : #define PEER_CAP_ENHANCED_RR_ADV (1U << 17) /* enhanced rr advertised */
    1242             : #define PEER_CAP_ENHANCED_RR_RCV (1U << 18) /* enhanced rr received */
    1243             : #define PEER_CAP_EXTENDED_MESSAGE_ADV (1U << 19)
    1244             : #define PEER_CAP_EXTENDED_MESSAGE_RCV (1U << 20)
    1245             : #define PEER_CAP_LLGR_ADV (1U << 21)
    1246             : #define PEER_CAP_LLGR_RCV (1U << 22)
    1247             : /* sent graceful-restart notification (N) bit */
    1248             : #define PEER_CAP_GRACEFUL_RESTART_N_BIT_ADV (1U << 23)
    1249             : /* received graceful-restart notification (N) bit */
    1250             : #define PEER_CAP_GRACEFUL_RESTART_N_BIT_RCV (1U << 24)
    1251             : #define PEER_CAP_ROLE_ADV                   (1U << 25) /* role advertised */
    1252             : #define PEER_CAP_ROLE_RCV                   (1U << 26) /* role received */
    1253             : 
    1254             :         /* Capability flags (reset in bgp_stop) */
    1255             :         uint32_t af_cap[AFI_MAX][SAFI_MAX];
    1256             : #define PEER_CAP_ORF_PREFIX_SM_ADV          (1U << 0) /* send-mode advertised */
    1257             : #define PEER_CAP_ORF_PREFIX_RM_ADV          (1U << 1) /* receive-mode advertised */
    1258             : #define PEER_CAP_ORF_PREFIX_SM_RCV          (1U << 2) /* send-mode received */
    1259             : #define PEER_CAP_ORF_PREFIX_RM_RCV          (1U << 3) /* receive-mode received */
    1260             : #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV      (1U << 4) /* send-mode received */
    1261             : #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV      (1U << 5) /* receive-mode received */
    1262             : #define PEER_CAP_RESTART_AF_RCV             (1U << 6) /* graceful restart afi/safi received */
    1263             : #define PEER_CAP_RESTART_AF_PRESERVE_RCV    (1U << 7) /* graceful restart afi/safi F-bit received */
    1264             : #define PEER_CAP_ADDPATH_AF_TX_ADV          (1U << 8) /* addpath tx advertised */
    1265             : #define PEER_CAP_ADDPATH_AF_TX_RCV          (1U << 9) /* addpath tx received */
    1266             : #define PEER_CAP_ADDPATH_AF_RX_ADV          (1U << 10) /* addpath rx advertised */
    1267             : #define PEER_CAP_ADDPATH_AF_RX_RCV          (1U << 11) /* addpath rx received */
    1268             : #define PEER_CAP_ENHE_AF_ADV                (1U << 12) /* Extended nexthopi afi/safi advertised */
    1269             : #define PEER_CAP_ENHE_AF_RCV                (1U << 13) /* Extended nexthop afi/safi received */
    1270             : #define PEER_CAP_ENHE_AF_NEGO               (1U << 14) /* Extended nexthop afi/safi negotiated */
    1271             : #define PEER_CAP_LLGR_AF_ADV                (1U << 15)
    1272             : #define PEER_CAP_LLGR_AF_RCV                (1U << 16)
    1273             : 
    1274             :         /* Global configuration flags. */
    1275             :         /*
    1276             :          * Parallel array to flags that indicates whether each flag originates
    1277             :          * from a peer-group or if it is config that is specific to this
    1278             :          * individual peer. If a flag is set independent of the peer-group, the
    1279             :          * same bit should be set here. If this peer is a peer-group, this
    1280             :          * memory region should be all zeros.
    1281             :          *
    1282             :          * The assumption is that the default state for all flags is unset,
    1283             :          * so if a flag is unset, the corresponding override flag is unset too.
    1284             :          * However if a flag is set, the corresponding override flag is set.
    1285             :          */
    1286             :         uint32_t flags_override;
    1287             :         /*
    1288             :          * Parallel array to flags that indicates whether the default behavior
    1289             :          * of *flags_override* should be inverted. If a flag is unset and the
    1290             :          * corresponding invert flag is set, the corresponding override flag
    1291             :          * would be set. However if a flag is set and the corresponding invert
    1292             :          * flag is unset, the corresponding override flag would be unset.
    1293             :          *
    1294             :          * This can be used for attributes like *send-community*, which are
    1295             :          * implicitely enabled and have to be disabled explicitely, compared to
    1296             :          * 'normal' attributes like *next-hop-self* which are implicitely set.
    1297             :          *
    1298             :          * All operations dealing with flags should apply the following boolean
    1299             :          * logic to keep the internal flag system in a sane state:
    1300             :          *
    1301             :          * value=0 invert=0     Inherit flag if member, otherwise unset flag
    1302             :          * value=0 invert=1     Unset flag unconditionally
    1303             :          * value=1 invert=0     Set flag unconditionally
    1304             :          * value=1 invert=1     Inherit flag if member, otherwise set flag
    1305             :          *
    1306             :          * Contrary to the implementation of *flags_override*, the flag
    1307             :          * inversion state can be set either on the peer OR the peer *and* the
    1308             :          * peer-group. This was done on purpose, as the inversion state of a
    1309             :          * flag can be determined on either the peer or the peer-group.
    1310             :          *
    1311             :          * Example: Enabling the cisco configuration mode inverts all flags
    1312             :          * related to *send-community* unconditionally for both peer-groups and
    1313             :          * peers.
    1314             :          *
    1315             :          * This behavior is different for interface peers though, which enable
    1316             :          * the *extended-nexthop* flag by default, which regular peers do not.
    1317             :          * As the peer-group can contain both regular and interface peers, the
    1318             :          * flag inversion state must be set on the peer only.
    1319             :          *
    1320             :          * When a peer inherits the configuration from a peer-group and the
    1321             :          * inversion state of the flag differs between peer and peer-group, the
    1322             :          * newly set value must equal to the inverted state of the peer-group.
    1323             :          */
    1324             :         uint32_t flags_invert;
    1325             :         /*
    1326             :          * Effective array for storing the peer/peer-group flags. In case of a
    1327             :          * peer-group, the peer-specific overrides (see flags_override and
    1328             :          * flags_invert) must be respected.
    1329             :          */
    1330             :         uint64_t flags;
    1331             : #define PEER_FLAG_PASSIVE                   (1ULL << 0) /* passive mode */
    1332             : #define PEER_FLAG_SHUTDOWN                  (1ULL << 1) /* shutdown */
    1333             : #define PEER_FLAG_DONT_CAPABILITY           (1ULL << 2) /* dont-capability */
    1334             : #define PEER_FLAG_OVERRIDE_CAPABILITY       (1ULL << 3) /* override-capability */
    1335             : #define PEER_FLAG_STRICT_CAP_MATCH          (1ULL << 4) /* strict-match */
    1336             : #define PEER_FLAG_DYNAMIC_CAPABILITY        (1ULL << 5) /* dynamic capability */
    1337             : #define PEER_FLAG_DISABLE_CONNECTED_CHECK   (1ULL << 6) /* disable-connected-check */
    1338             : #define PEER_FLAG_LOCAL_AS_NO_PREPEND       (1ULL << 7) /* local-as no-prepend */
    1339             : #define PEER_FLAG_LOCAL_AS_REPLACE_AS       (1ULL << 8) /* local-as no-prepend replace-as */
    1340             : #define PEER_FLAG_DELETE                    (1ULL << 9) /* mark the peer for deleting */
    1341             : #define PEER_FLAG_CONFIG_NODE               (1ULL << 10) /* the node to update configs on */
    1342             : #define PEER_FLAG_LONESOUL                  (1ULL << 11)
    1343             : #define PEER_FLAG_DYNAMIC_NEIGHBOR          (1ULL << 12) /* dynamic neighbor */
    1344             : #define PEER_FLAG_CAPABILITY_ENHE           (1ULL << 13) /* Extended next-hop (rfc 5549)*/
    1345             : #define PEER_FLAG_IFPEER_V6ONLY             (1ULL << 14) /* if-based peer is v6 only */
    1346             : #define PEER_FLAG_IS_RFAPI_HD               (1ULL << 15) /* attached to rfapi HD */
    1347             : #define PEER_FLAG_ENFORCE_FIRST_AS          (1ULL << 16) /* enforce-first-as */
    1348             : #define PEER_FLAG_ROUTEADV                  (1ULL << 17) /* route advertise */
    1349             : #define PEER_FLAG_TIMER                     (1ULL << 18) /* keepalive & holdtime */
    1350             : #define PEER_FLAG_TIMER_CONNECT             (1ULL << 19) /* connect timer */
    1351             : #define PEER_FLAG_PASSWORD                  (1ULL << 20) /* password */
    1352             : #define PEER_FLAG_LOCAL_AS                  (1ULL << 21) /* local-as */
    1353             : #define PEER_FLAG_UPDATE_SOURCE             (1ULL << 22) /* update-source */
    1354             : 
    1355             :         /* BGP-GR Peer related  flags */
    1356             : #define PEER_FLAG_GRACEFUL_RESTART_HELPER   (1ULL << 23) /* Helper */
    1357             : #define PEER_FLAG_GRACEFUL_RESTART          (1ULL << 24) /* Graceful Restart */
    1358             : #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1ULL << 25) /* Global-Inherit */
    1359             : #define PEER_FLAG_RTT_SHUTDOWN (1ULL << 26) /* shutdown rtt */
    1360             : #define PEER_FLAG_TIMER_DELAYOPEN (1ULL << 27) /* delayopen timer */
    1361             : #define PEER_FLAG_TCP_MSS (1ULL << 28)     /* tcp-mss */
    1362             : /* Disable IEEE floating-point link bandwidth encoding in
    1363             :  * extended communities.
    1364             :  */
    1365             : #define PEER_FLAG_DISABLE_LINK_BW_ENCODING_IEEE (1ULL << 29)
    1366             : /* force the extended format for Optional Parameters in OPEN message */
    1367             : #define PEER_FLAG_EXTENDED_OPT_PARAMS (1ULL << 30)
    1368             : 
    1369             :         /* BGP Open Policy flags.
    1370             :          * Enforce using roles on both sides:
    1371             :          * `local-role ROLE strict-mode` configured.
    1372             :          */
    1373             : #define PEER_FLAG_ROLE_STRICT_MODE (1ULL << 31)
    1374             :         /* `local-role` configured */
    1375             : #define PEER_FLAG_ROLE (1ULL << 32)
    1376             : #define PEER_FLAG_PORT (1ULL << 33)
    1377             : #define PEER_FLAG_AIGP (1ULL << 34)
    1378             : #define PEER_FLAG_GRACEFUL_SHUTDOWN (1ULL << 35)
    1379             : 
    1380             :         /*
    1381             :          *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
    1382             :          *& PEER_FLAG_GRACEFUL_RESTART_HELPER
    1383             :          *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
    1384             :          */
    1385             : 
    1386             :         struct bgp_peer_gr PEER_GR_FSM[BGP_PEER_GR_MODE][BGP_PEER_GR_EVENT_CMD];
    1387             :         enum peer_mode peer_gr_present_state;
    1388             :         /* Non stop forwarding afi-safi count for BGP gr feature*/
    1389             :         uint8_t nsf_af_count;
    1390             : 
    1391             :         uint8_t peer_gr_new_status_flag;
    1392             : #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER   (1U << 0)
    1393             : #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART  (1U << 1)
    1394             : #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT  (1U << 2)
    1395             : 
    1396             :         /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
    1397             :         char *tx_shutdown_message;
    1398             : 
    1399             :         /* NSF mode (graceful restart) */
    1400             :         uint8_t nsf[AFI_MAX][SAFI_MAX];
    1401             :         /* EOR Send time */
    1402             :         time_t eor_stime[AFI_MAX][SAFI_MAX];
    1403             :         /* Last update packet sent time */
    1404             :         time_t pkt_stime[AFI_MAX][SAFI_MAX];
    1405             : 
    1406             :         /* Peer Per AF flags */
    1407             :         /*
    1408             :          * Please consult the comments for *flags_override*, *flags_invert* and
    1409             :          * *flags* to understand what these three arrays do. The address-family
    1410             :          * specific attributes are being treated the exact same way as global
    1411             :          * peer attributes.
    1412             :          */
    1413             :         uint64_t af_flags_override[AFI_MAX][SAFI_MAX];
    1414             :         uint64_t af_flags_invert[AFI_MAX][SAFI_MAX];
    1415             :         uint64_t af_flags[AFI_MAX][SAFI_MAX];
    1416             : #define PEER_FLAG_SEND_COMMUNITY (1ULL << 0)
    1417             : #define PEER_FLAG_SEND_EXT_COMMUNITY (1ULL << 1)
    1418             : #define PEER_FLAG_NEXTHOP_SELF (1ULL << 2)
    1419             : #define PEER_FLAG_REFLECTOR_CLIENT (1ULL << 3)
    1420             : #define PEER_FLAG_RSERVER_CLIENT (1ULL << 4)
    1421             : #define PEER_FLAG_SOFT_RECONFIG (1ULL << 5)
    1422             : #define PEER_FLAG_AS_PATH_UNCHANGED (1ULL << 6)
    1423             : #define PEER_FLAG_NEXTHOP_UNCHANGED (1ULL << 7)
    1424             : #define PEER_FLAG_MED_UNCHANGED (1ULL << 8)
    1425             : #define PEER_FLAG_DEFAULT_ORIGINATE (1ULL << 9)
    1426             : #define PEER_FLAG_REMOVE_PRIVATE_AS (1ULL << 10)
    1427             : #define PEER_FLAG_ALLOWAS_IN (1ULL << 11)
    1428             : #define PEER_FLAG_ORF_PREFIX_SM (1ULL << 12)
    1429             : #define PEER_FLAG_ORF_PREFIX_RM (1ULL << 13)
    1430             : #define PEER_FLAG_MAX_PREFIX (1ULL << 14)
    1431             : #define PEER_FLAG_MAX_PREFIX_WARNING (1ULL << 15)
    1432             : #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1ULL << 16)
    1433             : #define PEER_FLAG_FORCE_NEXTHOP_SELF (1ULL << 17)
    1434             : #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1ULL << 18)
    1435             : #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1ULL << 19)
    1436             : #define PEER_FLAG_AS_OVERRIDE (1ULL << 20)
    1437             : #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1ULL << 21)
    1438             : #define PEER_FLAG_WEIGHT (1ULL << 24)
    1439             : #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1ULL << 25)
    1440             : #define PEER_FLAG_SEND_LARGE_COMMUNITY (1ULL << 26)
    1441             : #define PEER_FLAG_MAX_PREFIX_OUT (1ULL << 27)
    1442             : #define PEER_FLAG_MAX_PREFIX_FORCE (1ULL << 28)
    1443             : #define PEER_FLAG_DISABLE_ADDPATH_RX (1ULL << 29)
    1444             : #define PEER_FLAG_SOO (1ULL << 30)
    1445             : #define PEER_FLAG_ACCEPT_OWN (1ULL << 31)
    1446             : 
    1447             :         enum bgp_addpath_strat addpath_type[AFI_MAX][SAFI_MAX];
    1448             : 
    1449             :         /* MD5 password */
    1450             :         char *password;
    1451             : 
    1452             :         /* default-originate route-map.  */
    1453             :         struct {
    1454             :                 char *name;
    1455             :                 struct route_map *map;
    1456             :         } default_rmap[AFI_MAX][SAFI_MAX];
    1457             : 
    1458             :         /* Peer status flags. */
    1459             :         uint16_t sflags;
    1460             : #define PEER_STATUS_ACCEPT_PEER       (1U << 0) /* accept peer */
    1461             : #define PEER_STATUS_PREFIX_OVERFLOW   (1U << 1) /* prefix-overflow */
    1462             : #define PEER_STATUS_CAPABILITY_OPEN   (1U << 2) /* capability open send */
    1463             : #define PEER_STATUS_HAVE_ACCEPT       (1U << 3) /* accept peer's parent */
    1464             : #define PEER_STATUS_GROUP             (1U << 4) /* peer-group conf */
    1465             : #define PEER_STATUS_NSF_MODE          (1U << 5) /* NSF aware peer */
    1466             : #define PEER_STATUS_NSF_WAIT          (1U << 6) /* wait comeback peer */
    1467             : /* received extended format encoding for OPEN message */
    1468             : #define PEER_STATUS_EXT_OPT_PARAMS_LENGTH (1U << 7)
    1469             : 
    1470             :         /* Peer status af flags (reset in bgp_stop) */
    1471             :         uint16_t af_sflags[AFI_MAX][SAFI_MAX];
    1472             : #define PEER_STATUS_ORF_PREFIX_SEND   (1U << 0) /* prefix-list send peer */
    1473             : #define PEER_STATUS_ORF_WAIT_REFRESH  (1U << 1) /* wait refresh received peer */
    1474             : #define PEER_STATUS_PREFIX_THRESHOLD  (1U << 2) /* exceed prefix-threshold */
    1475             : #define PEER_STATUS_PREFIX_LIMIT      (1U << 3) /* exceed prefix-limit */
    1476             : #define PEER_STATUS_EOR_SEND          (1U << 4) /* end-of-rib send to peer */
    1477             : #define PEER_STATUS_EOR_RECEIVED      (1U << 5) /* end-of-rib received from peer */
    1478             : #define PEER_STATUS_ENHANCED_REFRESH (1U << 6) /* Enhanced Route Refresh */
    1479             : #define PEER_STATUS_BORR_SEND (1U << 7) /* BoRR send to peer */
    1480             : #define PEER_STATUS_BORR_RECEIVED (1U << 8) /* BoRR received from peer */
    1481             : #define PEER_STATUS_EORR_SEND (1U << 9) /* EoRR send to peer */
    1482             : #define PEER_STATUS_EORR_RECEIVED (1U << 10) /* EoRR received from peer */
    1483             : /* LLGR aware peer */
    1484             : #define PEER_STATUS_LLGR_WAIT (1U << 11)
    1485             : #define PEER_STATUS_REFRESH_PENDING (1U << 12) /* refresh request from peer */
    1486             : #define PEER_STATUS_RTT_SHUTDOWN (1U << 13) /* In shutdown state due to RTT */
    1487             : 
    1488             :         /* Configured timer values. */
    1489             :         _Atomic uint32_t holdtime;
    1490             :         _Atomic uint32_t keepalive;
    1491             :         _Atomic uint32_t connect;
    1492             :         _Atomic uint32_t routeadv;
    1493             :         _Atomic uint32_t delayopen;
    1494             : 
    1495             :         /* Timer values. */
    1496             :         _Atomic uint32_t v_start;
    1497             :         _Atomic uint32_t v_connect;
    1498             :         _Atomic uint32_t v_holdtime;
    1499             :         _Atomic uint32_t v_keepalive;
    1500             :         _Atomic uint32_t v_routeadv;
    1501             :         _Atomic uint32_t v_delayopen;
    1502             :         _Atomic uint32_t v_pmax_restart;
    1503             :         _Atomic uint32_t v_gr_restart;
    1504             : 
    1505             :         /* Threads. */
    1506             :         struct thread *t_read;
    1507             :         struct thread *t_write;
    1508             :         struct thread *t_start;
    1509             :         struct thread *t_connect_check_r;
    1510             :         struct thread *t_connect_check_w;
    1511             :         struct thread *t_connect;
    1512             :         struct thread *t_holdtime;
    1513             :         struct thread *t_routeadv;
    1514             :         struct thread *t_delayopen;
    1515             :         struct thread *t_pmax_restart;
    1516             :         struct thread *t_gr_restart;
    1517             :         struct thread *t_gr_stale;
    1518             :         struct thread *t_llgr_stale[AFI_MAX][SAFI_MAX];
    1519             :         struct thread *t_revalidate_all[AFI_MAX][SAFI_MAX];
    1520             :         struct thread *t_generate_updgrp_packets;
    1521             :         struct thread *t_process_packet;
    1522             :         struct thread *t_process_packet_error;
    1523             :         struct thread *t_refresh_stalepath;
    1524             : 
    1525             :         /* Thread flags. */
    1526             :         _Atomic uint32_t thread_flags;
    1527             : #define PEER_THREAD_WRITES_ON         (1U << 0)
    1528             : #define PEER_THREAD_READS_ON          (1U << 1)
    1529             : #define PEER_THREAD_KEEPALIVES_ON     (1U << 2)
    1530             : #define PEER_THREAD_SUBGRP_ADV_DELAY  (1U << 3)
    1531             : 
    1532             :         /* workqueues */
    1533             :         struct work_queue *clear_node_queue;
    1534             : 
    1535             : #define PEER_TOTAL_RX(peer)                                                    \
    1536             :         atomic_load_explicit(&peer->open_in, memory_order_relaxed)             \
    1537             :                 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
    1538             :                 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
    1539             :                 + atomic_load_explicit(&peer->refresh_in,                      \
    1540             :                                        memory_order_relaxed)                   \
    1541             :                 + atomic_load_explicit(&peer->keepalive_in,                    \
    1542             :                                        memory_order_relaxed)                   \
    1543             :                 + atomic_load_explicit(&peer->dynamic_cap_in,                  \
    1544             :                                        memory_order_relaxed)
    1545             : 
    1546             : #define PEER_TOTAL_TX(peer)                                                    \
    1547             :         atomic_load_explicit(&peer->open_out, memory_order_relaxed)            \
    1548             :                 + atomic_load_explicit(&peer->update_out,                      \
    1549             :                                        memory_order_relaxed)                   \
    1550             :                 + atomic_load_explicit(&peer->notify_out,                      \
    1551             :                                        memory_order_relaxed)                   \
    1552             :                 + atomic_load_explicit(&peer->refresh_out,                     \
    1553             :                                        memory_order_relaxed)                   \
    1554             :                 + atomic_load_explicit(&peer->keepalive_out,                   \
    1555             :                                        memory_order_relaxed)                   \
    1556             :                 + atomic_load_explicit(&peer->dynamic_cap_out,                 \
    1557             :                                        memory_order_relaxed)
    1558             : 
    1559             :         /* Statistics field */
    1560             :         _Atomic uint32_t open_in;        /* Open message input count */
    1561             :         _Atomic uint32_t open_out;      /* Open message output count */
    1562             :         _Atomic uint32_t update_in;       /* Update message input count */
    1563             :         _Atomic uint32_t update_out;      /* Update message ouput count */
    1564             :         _Atomic time_t update_time;       /* Update message received time. */
    1565             :         _Atomic uint32_t keepalive_in;    /* Keepalive input count */
    1566             :         _Atomic uint32_t keepalive_out;   /* Keepalive output count */
    1567             :         _Atomic uint32_t notify_in;       /* Notify input count */
    1568             :         _Atomic uint32_t notify_out;      /* Notify output count */
    1569             :         _Atomic uint32_t refresh_in;      /* Route Refresh input count */
    1570             :         _Atomic uint32_t refresh_out;     /* Route Refresh output count */
    1571             :         _Atomic uint32_t dynamic_cap_in;  /* Dynamic Capability input count.  */
    1572             :         _Atomic uint32_t dynamic_cap_out; /* Dynamic Capability output count. */
    1573             : 
    1574             :         uint32_t stat_pfx_filter;
    1575             :         uint32_t stat_pfx_aspath_loop;
    1576             :         uint32_t stat_pfx_originator_loop;
    1577             :         uint32_t stat_pfx_cluster_loop;
    1578             :         uint32_t stat_pfx_nh_invalid;
    1579             :         uint32_t stat_pfx_dup_withdraw;
    1580             :         uint32_t stat_upd_7606;  /* RFC7606: treat-as-withdraw */
    1581             : 
    1582             :         /* BGP state count */
    1583             :         uint32_t established; /* Established */
    1584             :         uint32_t dropped;     /* Dropped */
    1585             : 
    1586             :         /* Update delay related fields */
    1587             :         uint8_t update_delay_over; /* When this is set, BGP is no more waiting
    1588             :                                      for EOR */
    1589             : 
    1590             :         /* Syncronization list and time.  */
    1591             :         struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
    1592             :         time_t synctime;
    1593             :         /* timestamp when the last UPDATE msg was written */
    1594             :         _Atomic time_t last_write;
    1595             :         /* timestamp when the last msg was written */
    1596             :         _Atomic time_t last_update;
    1597             : 
    1598             :         /* only updated under io_mtx.
    1599             :          * last_sendq_warn is only for ratelimiting log warning messages.
    1600             :          */
    1601             :         time_t last_sendq_ok, last_sendq_warn;
    1602             : 
    1603             :         /* Notify data. */
    1604             :         struct bgp_notify notify;
    1605             : 
    1606             :         /* Filter structure. */
    1607             :         struct bgp_filter filter[AFI_MAX][SAFI_MAX];
    1608             : 
    1609             :         /*
    1610             :          * Parallel array to filter that indicates whether each filter
    1611             :          * originates from a peer-group or if it is config that is specific to
    1612             :          * this individual peer. If a filter is set independent of the
    1613             :          * peer-group the appropriate bit should be set here. If this peer is a
    1614             :          * peer-group, this memory region should be all zeros. The assumption
    1615             :          * is that the default state for all flags is unset. Due to filters
    1616             :          * having a direction (e.g. in/out/...), this array has a third
    1617             :          * dimension for storing the overrides independently per direction.
    1618             :          *
    1619             :          * Notes:
    1620             :          * - if a filter for an individual peer is unset, the corresponding
    1621             :          *   override flag is unset and the peer is considered to be back in
    1622             :          *   sync with the peer-group.
    1623             :          * - This does *not* contain the filter values, rather it contains
    1624             :          *   whether the filter in filter (struct bgp_filter) is peer-specific.
    1625             :          */
    1626             :         uint8_t filter_override[AFI_MAX][SAFI_MAX][FILTER_MAX];
    1627             : #define PEER_FT_DISTRIBUTE_LIST       (1U << 0) /* distribute-list */
    1628             : #define PEER_FT_FILTER_LIST           (1U << 1) /* filter-list */
    1629             : #define PEER_FT_PREFIX_LIST           (1U << 2) /* prefix-list */
    1630             : #define PEER_FT_ROUTE_MAP             (1U << 3) /* route-map */
    1631             : #define PEER_FT_UNSUPPRESS_MAP        (1U << 4) /* unsuppress-map */
    1632             : #define PEER_FT_ADVERTISE_MAP         (1U << 5) /* advertise-map */
    1633             : 
    1634             :         /* ORF Prefix-list */
    1635             :         struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
    1636             : 
    1637             :         /* Text description of last attribute rcvd */
    1638             :         char rcvd_attr_str[BUFSIZ];
    1639             : 
    1640             :         /* Track if we printed the attribute in debugs */
    1641             :         int rcvd_attr_printed;
    1642             : 
    1643             :         /* Accepted prefix count */
    1644             :         uint32_t pcount[AFI_MAX][SAFI_MAX];
    1645             : 
    1646             :         /* Max prefix count. */
    1647             :         uint32_t pmax[AFI_MAX][SAFI_MAX];
    1648             :         uint8_t pmax_threshold[AFI_MAX][SAFI_MAX];
    1649             :         uint16_t pmax_restart[AFI_MAX][SAFI_MAX];
    1650             : #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
    1651             : 
    1652             :         /* Send prefix count. */
    1653             :         uint32_t pmax_out[AFI_MAX][SAFI_MAX];
    1654             : 
    1655             :         /* allowas-in. */
    1656             :         char allowas_in[AFI_MAX][SAFI_MAX];
    1657             : 
    1658             :         /* soo */
    1659             :         struct ecommunity *soo[AFI_MAX][SAFI_MAX];
    1660             : 
    1661             :         /* weight */
    1662             :         unsigned long weight[AFI_MAX][SAFI_MAX];
    1663             : 
    1664             :         /* peer reset cause */
    1665             :         uint8_t last_reset;
    1666             : #define PEER_DOWN_RID_CHANGE             1U /* bgp router-id command */
    1667             : #define PEER_DOWN_REMOTE_AS_CHANGE       2U /* neighbor remote-as command */
    1668             : #define PEER_DOWN_LOCAL_AS_CHANGE        3U /* neighbor local-as command */
    1669             : #define PEER_DOWN_CLID_CHANGE            4U /* bgp cluster-id command */
    1670             : #define PEER_DOWN_CONFED_ID_CHANGE       5U /* bgp confederation id command */
    1671             : #define PEER_DOWN_CONFED_PEER_CHANGE     6U /* bgp confederation peer command */
    1672             : #define PEER_DOWN_RR_CLIENT_CHANGE       7U /* neighbor rr-client command */
    1673             : #define PEER_DOWN_RS_CLIENT_CHANGE       8U /* neighbor rs-client command */
    1674             : #define PEER_DOWN_UPDATE_SOURCE_CHANGE   9U /* neighbor update-source command */
    1675             : #define PEER_DOWN_AF_ACTIVATE           10U /* neighbor activate command */
    1676             : #define PEER_DOWN_USER_SHUTDOWN         11U /* neighbor shutdown command */
    1677             : #define PEER_DOWN_USER_RESET            12U /* clear ip bgp command */
    1678             : #define PEER_DOWN_NOTIFY_RECEIVED       13U /* notification received */
    1679             : #define PEER_DOWN_NOTIFY_SEND           14U /* notification send */
    1680             : #define PEER_DOWN_CLOSE_SESSION         15U /* tcp session close */
    1681             : #define PEER_DOWN_NEIGHBOR_DELETE       16U /* neghbor delete */
    1682             : #define PEER_DOWN_RMAP_BIND             17U /* neghbor peer-group command */
    1683             : #define PEER_DOWN_RMAP_UNBIND           18U /* no neighbor peer-group command */
    1684             : #define PEER_DOWN_CAPABILITY_CHANGE     19U /* neighbor capability command */
    1685             : #define PEER_DOWN_PASSIVE_CHANGE        20U /* neighbor passive command */
    1686             : #define PEER_DOWN_MULTIHOP_CHANGE       21U /* neighbor multihop command */
    1687             : #define PEER_DOWN_NSF_CLOSE_SESSION     22U /* NSF tcp session close */
    1688             : #define PEER_DOWN_V6ONLY_CHANGE         23U /* if-based peering v6only toggled */
    1689             : #define PEER_DOWN_BFD_DOWN              24U /* BFD down */
    1690             : #define PEER_DOWN_IF_DOWN               25U /* Interface down */
    1691             : #define PEER_DOWN_NBR_ADDR_DEL          26U /* Peer address lost */
    1692             : #define PEER_DOWN_WAITING_NHT           27U /* Waiting for NHT to resolve */
    1693             : #define PEER_DOWN_NBR_ADDR              28U /* Waiting for peer IPv6 IP Addr */
    1694             : #define PEER_DOWN_VRF_UNINIT            29U /* Associated VRF is not init yet */
    1695             : #define PEER_DOWN_NOAFI_ACTIVATED       30U /* No AFI/SAFI activated for peer */
    1696             : #define PEER_DOWN_AS_SETS_REJECT        31U /* Reject routes with AS_SET */
    1697             : #define PEER_DOWN_WAITING_OPEN          32U /* Waiting for open to succeed */
    1698             : #define PEER_DOWN_PFX_COUNT             33U /* Reached received prefix count */
    1699             : #define PEER_DOWN_SOCKET_ERROR          34U /* Some socket error happened */
    1700             : #define PEER_DOWN_RTT_SHUTDOWN          35U /* Automatically shutdown due to RTT */
    1701             :         /*
    1702             :          * Remember to update peer_down_str in bgp_fsm.c when you add
    1703             :          * a new value to the last_reset reason
    1704             :          */
    1705             : 
    1706             :         uint16_t last_reset_cause_size;
    1707             :         uint8_t last_reset_cause[BGP_MAX_PACKET_SIZE];
    1708             : 
    1709             :         /* The kind of route-map Flags.*/
    1710             :         uint16_t rmap_type;
    1711             : #define PEER_RMAP_TYPE_IN             (1U << 0) /* neighbor route-map in */
    1712             : #define PEER_RMAP_TYPE_OUT            (1U << 1) /* neighbor route-map out */
    1713             : #define PEER_RMAP_TYPE_NETWORK        (1U << 2) /* network route-map */
    1714             : #define PEER_RMAP_TYPE_REDISTRIBUTE   (1U << 3) /* redistribute route-map */
    1715             : #define PEER_RMAP_TYPE_DEFAULT        (1U << 4) /* default-originate route-map */
    1716             : #define PEER_RMAP_TYPE_NOSET          (1U << 5) /* not allow to set commands */
    1717             : #define PEER_RMAP_TYPE_IMPORT         (1U << 6) /* neighbor route-map import */
    1718             : #define PEER_RMAP_TYPE_EXPORT         (1U << 7) /* neighbor route-map export */
    1719             : #define PEER_RMAP_TYPE_AGGREGATE      (1U << 8) /* aggregate-address route-map */
    1720             : 
    1721             :         /** Peer overwrite configuration. */
    1722             :         struct bfd_session_config {
    1723             :                 /**
    1724             :                  * Manual configuration bit.
    1725             :                  *
    1726             :                  * This flag only makes sense for real peers (and not groups),
    1727             :                  * it keeps track if the user explicitly configured BFD for a
    1728             :                  * peer.
    1729             :                  */
    1730             :                 bool manual;
    1731             :                 /** Control Plane Independent. */
    1732             :                 bool cbit;
    1733             :                 /** Detection multiplier. */
    1734             :                 uint8_t detection_multiplier;
    1735             :                 /** Minimum required RX interval. */
    1736             :                 uint32_t min_rx;
    1737             :                 /** Minimum required TX interval. */
    1738             :                 uint32_t min_tx;
    1739             :                 /** Profile name. */
    1740             :                 char profile[BFD_PROFILE_NAME_LEN];
    1741             :                 /** Peer BFD session */
    1742             :                 struct bfd_session_params *session;
    1743             :         } * bfd_config;
    1744             : 
    1745             :         /* hostname and domainname advertised by host */
    1746             :         char *hostname;
    1747             :         char *domainname;
    1748             : 
    1749             :         /* Sender side AS path loop detection. */
    1750             :         bool as_path_loop_detection;
    1751             : 
    1752             :         /* Extended Message Support */
    1753             :         uint16_t max_packet_size;
    1754             : 
    1755             :         /* Conditional advertisement */
    1756             :         bool advmap_config_change[AFI_MAX][SAFI_MAX];
    1757             :         bool advmap_table_change;
    1758             : 
    1759             :         /* set TCP max segment size */
    1760             :         uint32_t tcp_mss;
    1761             : 
    1762             :         /* Long-lived Graceful Restart */
    1763             :         struct llgr_info llgr[AFI_MAX][SAFI_MAX];
    1764             : 
    1765             :         bool shut_during_cfg;
    1766             : 
    1767             : #define BGP_ATTR_MAX 255
    1768             :         /* Path attributes discard */
    1769             :         bool discard_attrs[BGP_ATTR_MAX];
    1770             : 
    1771             :         QOBJ_FIELDS;
    1772             : };
    1773             : DECLARE_QOBJ_TYPE(peer);
    1774             : 
    1775             : /* Inherit peer attribute from peer-group. */
    1776             : #define PEER_ATTR_INHERIT(peer, group, attr)                                   \
    1777             :         ((peer)->attr = (group)->conf->attr)
    1778             : #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt)                           \
    1779             :         do {                                                                   \
    1780             :                 XFREE(mt, (peer)->attr);                                       \
    1781             :                 if ((group)->conf->attr)                                       \
    1782             :                         (peer)->attr = XSTRDUP(mt, (group)->conf->attr);       \
    1783             :                 else                                                           \
    1784             :                         (peer)->attr = NULL;                                   \
    1785             :         } while (0)
    1786             : #define PEER_SU_ATTR_INHERIT(peer, group, attr)                                \
    1787             :         do {                                                                   \
    1788             :                 if ((peer)->attr)                                              \
    1789             :                         sockunion_free((peer)->attr);                          \
    1790             :                 if ((group)->conf->attr)                                       \
    1791             :                         (peer)->attr = sockunion_dup((group)->conf->attr);     \
    1792             :                 else                                                           \
    1793             :                         (peer)->attr = NULL;                                   \
    1794             :         } while (0)
    1795             : 
    1796             : /* Check if suppress start/restart of sessions to peer. */
    1797             : #define BGP_PEER_START_SUPPRESSED(P)                                           \
    1798             :         (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) ||                         \
    1799             :          CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) ||               \
    1800             :          CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN) ||                     \
    1801             :          (P)->shut_during_cfg)
    1802             : 
    1803             : #define PEER_ROUTE_ADV_DELAY(peer)                                             \
    1804             :         (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
    1805             : 
    1806             : #define PEER_PASSWORD_MINLEN    (1)
    1807             : #define PEER_PASSWORD_MAXLEN    (80)
    1808             : 
    1809             : /* This structure's member directly points incoming packet data
    1810             :    stream. */
    1811             : struct bgp_nlri {
    1812             :         /* AFI.  */
    1813             :         uint16_t afi; /* iana_afi_t */
    1814             : 
    1815             :         /* SAFI.  */
    1816             :         uint8_t safi; /* iana_safi_t */
    1817             : 
    1818             :         /* Pointer to NLRI byte stream.  */
    1819             :         uint8_t *nlri;
    1820             : 
    1821             :         /* Length of whole NLRI.  */
    1822             :         bgp_size_t length;
    1823             : };
    1824             : 
    1825             : /* BGP versions.  */
    1826             : #define BGP_VERSION_4                            4
    1827             : 
    1828             : /* Default BGP port number.  */
    1829             : #define BGP_PORT_DEFAULT                       179
    1830             : 
    1831             : /* Extended BGP Administrative Shutdown Communication */
    1832             : #define BGP_ADMIN_SHUTDOWN_MSG_LEN 255
    1833             : 
    1834             : /* BGP minimum message size.  */
    1835             : #define BGP_MSG_OPEN_MIN_SIZE                   (BGP_HEADER_SIZE + 10)
    1836             : #define BGP_MSG_UPDATE_MIN_SIZE                 (BGP_HEADER_SIZE + 4)
    1837             : #define BGP_MSG_NOTIFY_MIN_SIZE                 (BGP_HEADER_SIZE + 2)
    1838             : #define BGP_MSG_KEEPALIVE_MIN_SIZE              (BGP_HEADER_SIZE + 0)
    1839             : #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE          (BGP_HEADER_SIZE + 4)
    1840             : #define BGP_MSG_CAPABILITY_MIN_SIZE             (BGP_HEADER_SIZE + 3)
    1841             : 
    1842             : /* BGP message types.  */
    1843             : #define BGP_MSG_OPEN                             1
    1844             : #define BGP_MSG_UPDATE                           2
    1845             : #define BGP_MSG_NOTIFY                           3
    1846             : #define BGP_MSG_KEEPALIVE                        4
    1847             : #define BGP_MSG_ROUTE_REFRESH_NEW                5
    1848             : #define BGP_MSG_CAPABILITY                       6
    1849             : #define BGP_MSG_ROUTE_REFRESH_OLD              128
    1850             : 
    1851             : /* BGP open optional parameter.  */
    1852             : #define BGP_OPEN_OPT_CAP                         2
    1853             : 
    1854             : /* BGP4 attribute type codes.  */
    1855             : #define BGP_ATTR_ORIGIN                          1
    1856             : #define BGP_ATTR_AS_PATH                         2
    1857             : #define BGP_ATTR_NEXT_HOP                        3
    1858             : #define BGP_ATTR_MULTI_EXIT_DISC                 4
    1859             : #define BGP_ATTR_LOCAL_PREF                      5
    1860             : #define BGP_ATTR_ATOMIC_AGGREGATE                6
    1861             : #define BGP_ATTR_AGGREGATOR                      7
    1862             : #define BGP_ATTR_COMMUNITIES                     8
    1863             : #define BGP_ATTR_ORIGINATOR_ID                   9
    1864             : #define BGP_ATTR_CLUSTER_LIST                   10
    1865             : #define BGP_ATTR_MP_REACH_NLRI                  14
    1866             : #define BGP_ATTR_MP_UNREACH_NLRI                15
    1867             : #define BGP_ATTR_EXT_COMMUNITIES                16
    1868             : #define BGP_ATTR_AS4_PATH                       17
    1869             : #define BGP_ATTR_AS4_AGGREGATOR                 18
    1870             : #define BGP_ATTR_PMSI_TUNNEL                    22
    1871             : #define BGP_ATTR_ENCAP                          23
    1872             : #define BGP_ATTR_IPV6_EXT_COMMUNITIES           25
    1873             : #define BGP_ATTR_AIGP                           26
    1874             : #define BGP_ATTR_LARGE_COMMUNITIES              32
    1875             : #define BGP_ATTR_OTC                            35
    1876             : #define BGP_ATTR_PREFIX_SID                     40
    1877             : #define BGP_ATTR_SRTE_COLOR                     51
    1878             : #ifdef ENABLE_BGP_VNC_ATTR
    1879             : #define BGP_ATTR_VNC                           255
    1880             : #endif
    1881             : 
    1882             : /* BGP update origin.  */
    1883             : #define BGP_ORIGIN_IGP                           0
    1884             : #define BGP_ORIGIN_EGP                           1
    1885             : #define BGP_ORIGIN_INCOMPLETE                    2
    1886             : #define BGP_ORIGIN_UNSPECIFIED                 255
    1887             : 
    1888             : /* BGP notify message codes.  */
    1889             : #define BGP_NOTIFY_HEADER_ERR                    1
    1890             : #define BGP_NOTIFY_OPEN_ERR                      2
    1891             : #define BGP_NOTIFY_UPDATE_ERR                    3
    1892             : #define BGP_NOTIFY_HOLD_ERR                      4
    1893             : #define BGP_NOTIFY_FSM_ERR                       5
    1894             : #define BGP_NOTIFY_CEASE                         6
    1895             : #define BGP_NOTIFY_ROUTE_REFRESH_ERR             7
    1896             : 
    1897             : /* Subcodes for BGP Finite State Machine Error */
    1898             : #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC  0
    1899             : #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT    1
    1900             : #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
    1901             : #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
    1902             : 
    1903             : #define BGP_NOTIFY_SUBCODE_UNSPECIFIC            0
    1904             : 
    1905             : /* BGP_NOTIFY_HEADER_ERR sub codes.  */
    1906             : #define BGP_NOTIFY_HEADER_NOT_SYNC               1
    1907             : #define BGP_NOTIFY_HEADER_BAD_MESLEN             2
    1908             : #define BGP_NOTIFY_HEADER_BAD_MESTYPE            3
    1909             : 
    1910             : /* BGP_NOTIFY_OPEN_ERR sub codes.  */
    1911             : #define BGP_NOTIFY_OPEN_MALFORMED_ATTR           0
    1912             : #define BGP_NOTIFY_OPEN_UNSUP_VERSION            1
    1913             : #define BGP_NOTIFY_OPEN_BAD_PEER_AS              2
    1914             : #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT            3
    1915             : #define BGP_NOTIFY_OPEN_UNSUP_PARAM              4
    1916             : #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME          6
    1917             : #define BGP_NOTIFY_OPEN_UNSUP_CAPBL              7
    1918             : #define BGP_NOTIFY_OPEN_ROLE_MISMATCH           11
    1919             : 
    1920             : /* BGP_NOTIFY_UPDATE_ERR sub codes.  */
    1921             : #define BGP_NOTIFY_UPDATE_MAL_ATTR               1
    1922             : #define BGP_NOTIFY_UPDATE_UNREC_ATTR             2
    1923             : #define BGP_NOTIFY_UPDATE_MISS_ATTR              3
    1924             : #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR          4
    1925             : #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR          5
    1926             : #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN           6
    1927             : #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP         8
    1928             : #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR           9
    1929             : #define BGP_NOTIFY_UPDATE_INVAL_NETWORK         10
    1930             : #define BGP_NOTIFY_UPDATE_MAL_AS_PATH           11
    1931             : 
    1932             : /* BGP_NOTIFY_CEASE sub codes (RFC 4486).  */
    1933             : #define BGP_NOTIFY_CEASE_MAX_PREFIX              1
    1934             : #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN          2
    1935             : #define BGP_NOTIFY_CEASE_PEER_UNCONFIG           3
    1936             : #define BGP_NOTIFY_CEASE_ADMIN_RESET             4
    1937             : #define BGP_NOTIFY_CEASE_CONNECT_REJECT          5
    1938             : #define BGP_NOTIFY_CEASE_CONFIG_CHANGE           6
    1939             : #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION    7
    1940             : #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE         8
    1941             : #define BGP_NOTIFY_CEASE_HARD_RESET 9
    1942             : #define BGP_NOTIFY_CEASE_BFD_DOWN 10
    1943             : 
    1944             : /* BGP_NOTIFY_ROUTE_REFRESH_ERR sub codes (RFC 7313). */
    1945             : #define BGP_NOTIFY_ROUTE_REFRESH_INVALID_MSG_LEN 1
    1946             : 
    1947             : /* BGP route refresh optional subtypes. */
    1948             : #define BGP_ROUTE_REFRESH_NORMAL 0
    1949             : #define BGP_ROUTE_REFRESH_BORR 1
    1950             : #define BGP_ROUTE_REFRESH_EORR 2
    1951             : 
    1952             : /* BGP timers default value.  */
    1953             : #define BGP_INIT_START_TIMER                     1
    1954             : /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
    1955             :  * version-/profile-specific values.  The values here do not matter, they only
    1956             :  * exist to provide a clear layering separation between core and CLI.
    1957             :  */
    1958             : #define BGP_DEFAULT_HOLDTIME                   180
    1959             : #define BGP_DEFAULT_KEEPALIVE                   60
    1960             : #define BGP_DEFAULT_CONNECT_RETRY              120
    1961             : 
    1962             : #define BGP_DEFAULT_EBGP_ROUTEADV                0
    1963             : #define BGP_DEFAULT_IBGP_ROUTEADV                0
    1964             : 
    1965             : /* BGP RFC 4271 DelayOpenTime default value */
    1966             : #define BGP_DEFAULT_DELAYOPEN 120
    1967             : 
    1968             : /* BGP default local preference.  */
    1969             : #define BGP_DEFAULT_LOCAL_PREF                 100
    1970             : 
    1971             : /* BGP local-preference to send when 'bgp graceful-shutdown'
    1972             :  * is configured */
    1973             : #define BGP_GSHUT_LOCAL_PREF                     0
    1974             : 
    1975             : /* BGP default subgroup packet queue max .  */
    1976             : #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX      40
    1977             : 
    1978             : /* BGP graceful restart  */
    1979             : #define BGP_DEFAULT_RESTART_TIME               120
    1980             : #define BGP_DEFAULT_STALEPATH_TIME             360
    1981             : #define BGP_DEFAULT_SELECT_DEFERRAL_TIME       360
    1982             : #define BGP_DEFAULT_RIB_STALE_TIME             500
    1983             : #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME  1
    1984             : 
    1985             : /* BGP Long-lived Graceful Restart */
    1986             : #define BGP_DEFAULT_LLGR_STALE_TIME 0
    1987             : 
    1988             : /* BGP uptime string length.  */
    1989             : #define BGP_UPTIME_LEN 25
    1990             : 
    1991             : /* Default configuration settings for bgpd.  */
    1992             : #define BGP_VTY_PORT                          2605
    1993             : #define BGP_DEFAULT_CONFIG             "bgpd.conf"
    1994             : 
    1995             : /* BGP Dynamic Neighbors feature */
    1996             : #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT    100
    1997             : #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN          1
    1998             : #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX      65535
    1999             : 
    2000             : /* BGP AIGP */
    2001             : #define BGP_AIGP_TLV_RESERVED 0 /* AIGP Reserved */
    2002             : #define BGP_AIGP_TLV_METRIC 1   /* AIGP Metric */
    2003             : #define BGP_AIGP_TLV_METRIC_LEN 11
    2004             : #define BGP_AIGP_TLV_METRIC_MAX 0xffffffffffffffffULL
    2005             : #define BGP_AIGP_TLV_METRIC_DESC "Accumulated IGP Metric"
    2006             : 
    2007             : /* Flag for peer_clear_soft().  */
    2008             : enum bgp_clear_type {
    2009             :         BGP_CLEAR_SOFT_NONE,
    2010             :         BGP_CLEAR_SOFT_OUT,
    2011             :         BGP_CLEAR_SOFT_IN,
    2012             :         BGP_CLEAR_SOFT_BOTH,
    2013             :         BGP_CLEAR_SOFT_IN_ORF_PREFIX,
    2014             :         BGP_CLEAR_MESSAGE_STATS
    2015             : };
    2016             : 
    2017             : /* Macros. */
    2018             : #define BGP_INPUT(P)         ((P)->curr)
    2019             : #define BGP_INPUT_PNT(P)     (stream_pnt(BGP_INPUT(P)))
    2020             : #define BGP_IS_VALID_STATE_FOR_NOTIF(S)                                        \
    2021             :         (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
    2022             : 
    2023             : /* BGP error codes.  */
    2024             : enum bgp_create_error_code {
    2025             :         BGP_SUCCESS = 0,
    2026             :         BGP_CREATED = 1,
    2027             :         BGP_ERR_INVALID_VALUE = -1,
    2028             :         BGP_ERR_INVALID_FLAG = -2,
    2029             :         BGP_ERR_INVALID_AS = -3,
    2030             :         BGP_ERR_PEER_GROUP_MEMBER = -4,
    2031             :         BGP_ERR_PEER_GROUP_NO_REMOTE_AS = -5,
    2032             :         BGP_ERR_PEER_GROUP_CANT_CHANGE = -6,
    2033             :         BGP_ERR_PEER_GROUP_MISMATCH = -7,
    2034             :         BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT = -8,
    2035             :         BGP_ERR_AS_MISMATCH = -9,
    2036             :         BGP_ERR_PEER_FLAG_CONFLICT = -10,
    2037             :         BGP_ERR_PEER_GROUP_SHUTDOWN = -11,
    2038             :         BGP_ERR_PEER_FILTER_CONFLICT = -12,
    2039             :         BGP_ERR_NOT_INTERNAL_PEER = -13,
    2040             :         BGP_ERR_REMOVE_PRIVATE_AS = -14,
    2041             :         BGP_ERR_AF_UNCONFIGURED = -15,
    2042             :         BGP_ERR_SOFT_RECONFIG_UNCONFIGURED = -16,
    2043             :         BGP_ERR_INSTANCE_MISMATCH = -17,
    2044             :         BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS = -19,
    2045             :         BGP_ERR_TCPSIG_FAILED = -20,
    2046             :         BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK = -21,
    2047             :         BGP_ERR_NO_IBGP_WITH_TTLHACK = -22,
    2048             :         BGP_ERR_NO_INTERFACE_CONFIG = -23,
    2049             :         BGP_ERR_AS_OVERRIDE = -25,
    2050             :         BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT = -26,
    2051             :         BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS = -27,
    2052             :         BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND = -28,
    2053             :         BGP_ERR_INVALID_FOR_DYNAMIC_PEER = -29,
    2054             :         BGP_ERR_INVALID_FOR_DIRECT_PEER = -30,
    2055             :         BGP_ERR_PEER_SAFI_CONFLICT = -31,
    2056             : 
    2057             :         /* BGP GR ERRORS */
    2058             :         BGP_ERR_GR_INVALID_CMD = -32,
    2059             :         BGP_ERR_GR_OPERATION_FAILED = -33,
    2060             :         BGP_GR_NO_OPERATION = -34,
    2061             : 
    2062             :         /*BGP Open Policy ERRORS */
    2063             :         BGP_ERR_INVALID_ROLE_NAME = -35,
    2064             :         BGP_ERR_INVALID_INTERNAL_ROLE = -36
    2065             : };
    2066             : 
    2067             : /*
    2068             :  * Enumeration of different policy kinds a peer can be configured with.
    2069             :  */
    2070             : enum bgp_policy_type {
    2071             :         BGP_POLICY_ROUTE_MAP,
    2072             :         BGP_POLICY_FILTER_LIST,
    2073             :         BGP_POLICY_PREFIX_LIST,
    2074             :         BGP_POLICY_DISTRIBUTE_LIST,
    2075             : };
    2076             : 
    2077             : /* peer_flag_change_type. */
    2078             : enum peer_change_type {
    2079             :         peer_change_none,
    2080             :         peer_change_reset,
    2081             :         peer_change_reset_in,
    2082             :         peer_change_reset_out,
    2083             : };
    2084             : 
    2085             : extern struct bgp_master *bm;
    2086             : extern unsigned int multipath_num;
    2087             : 
    2088             : /* Prototypes. */
    2089             : extern void bgp_terminate(void);
    2090             : extern void bgp_reset(void);
    2091             : extern void bgp_zclient_reset(void);
    2092             : extern struct bgp *bgp_get_default(void);
    2093             : extern struct bgp *bgp_lookup(as_t, const char *);
    2094             : extern struct bgp *bgp_lookup_by_name(const char *);
    2095             : extern struct bgp *bgp_lookup_by_vrf_id(vrf_id_t);
    2096             : extern struct bgp *bgp_get_evpn(void);
    2097             : extern void bgp_set_evpn(struct bgp *bgp);
    2098             : extern struct peer *peer_lookup(struct bgp *, union sockunion *);
    2099             : extern struct peer *peer_lookup_by_conf_if(struct bgp *, const char *);
    2100             : extern struct peer *peer_lookup_by_hostname(struct bgp *, const char *);
    2101             : extern void bgp_peer_conf_if_to_su_update(struct peer *);
    2102             : extern int peer_group_listen_range_del(struct peer_group *, struct prefix *);
    2103             : extern struct peer_group *peer_group_lookup(struct bgp *, const char *);
    2104             : extern struct peer_group *peer_group_get(struct bgp *, const char *);
    2105             : extern struct peer *peer_create_bind_dynamic_neighbor(struct bgp *,
    2106             :                                                       union sockunion *,
    2107             :                                                       struct peer_group *);
    2108             : extern struct prefix *
    2109             : peer_group_lookup_dynamic_neighbor_range(struct peer_group *, struct prefix *);
    2110             : extern struct peer_group *peer_group_lookup_dynamic_neighbor(struct bgp *,
    2111             :                                                              struct prefix *,
    2112             :                                                              struct prefix **);
    2113             : extern struct peer *peer_lookup_dynamic_neighbor(struct bgp *,
    2114             :                                                  union sockunion *);
    2115             : 
    2116             : /*
    2117             :  * Peers are incredibly easy to memory leak
    2118             :  * due to the various ways that they are actually used
    2119             :  * Provide some functionality to debug locks and unlocks
    2120             :  */
    2121             : extern struct peer *peer_lock_with_caller(const char *, struct peer *);
    2122             : extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
    2123             : #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
    2124             : #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
    2125             : 
    2126             : extern enum bgp_peer_sort peer_sort(struct peer *peer);
    2127             : extern enum bgp_peer_sort peer_sort_lookup(struct peer *peer);
    2128             : 
    2129             : extern bool peer_active(struct peer *);
    2130             : extern bool peer_active_nego(struct peer *);
    2131             : extern bool peer_afc_received(struct peer *peer);
    2132             : extern bool peer_afc_advertised(struct peer *peer);
    2133             : extern void bgp_recalculate_all_bestpaths(struct bgp *bgp);
    2134             : extern struct peer *peer_create(union sockunion *su, const char *conf_if,
    2135             :                                 struct bgp *bgp, as_t local_as, as_t remote_as,
    2136             :                                 int as_type, struct peer_group *group,
    2137             :                                 bool config_node);
    2138             : extern struct peer *peer_create_accept(struct bgp *);
    2139             : extern void peer_xfer_config(struct peer *dst, struct peer *src);
    2140             : extern char *peer_uptime(time_t uptime2, char *buf, size_t len, bool use_json,
    2141             :                          json_object *json);
    2142             : 
    2143             : extern int bgp_config_write(struct vty *);
    2144             : 
    2145             : extern void bgp_master_init(struct thread_master *master, const int buffer_size,
    2146             :                             struct list *addresses);
    2147             : 
    2148             : extern void bgp_init(unsigned short instance);
    2149             : extern void bgp_pthreads_run(void);
    2150             : extern void bgp_pthreads_finish(void);
    2151             : extern void bgp_route_map_init(void);
    2152             : extern void bgp_session_reset(struct peer *);
    2153             : 
    2154             : extern int bgp_option_set(int);
    2155             : extern int bgp_option_unset(int);
    2156             : extern int bgp_option_check(int);
    2157             : 
    2158             : /* set the bgp no-rib option during runtime and remove installed routes */
    2159             : extern void bgp_option_norib_set_runtime(void);
    2160             : 
    2161             : /* unset the bgp no-rib option during runtime and reset all peers */
    2162             : extern void bgp_option_norib_unset_runtime(void);
    2163             : 
    2164             : extern int bgp_get(struct bgp **, as_t *, const char *, enum bgp_instance_type);
    2165             : extern void bgp_instance_up(struct bgp *);
    2166             : extern void bgp_instance_down(struct bgp *);
    2167             : extern int bgp_delete(struct bgp *);
    2168             : 
    2169             : extern int bgp_handle_socket(struct bgp *bgp, struct vrf *vrf,
    2170             :                              vrf_id_t old_vrf_id, bool create);
    2171             : 
    2172             : extern void bgp_router_id_zebra_bump(vrf_id_t, const struct prefix *);
    2173             : extern void bgp_router_id_static_set(struct bgp *, struct in_addr);
    2174             : 
    2175             : extern void bm_wait_for_fib_set(bool set);
    2176             : extern void bgp_suppress_fib_pending_set(struct bgp *bgp, bool set);
    2177             : extern void bgp_cluster_id_set(struct bgp *bgp, struct in_addr *cluster_id);
    2178             : extern void bgp_cluster_id_unset(struct bgp *bgp);
    2179             : 
    2180             : extern void bgp_confederation_id_set(struct bgp *bgp, as_t as);
    2181             : extern void bgp_confederation_id_unset(struct bgp *bgp);
    2182             : extern bool bgp_confederation_peers_check(struct bgp *, as_t);
    2183             : 
    2184             : extern void bgp_confederation_peers_add(struct bgp *bgp, as_t as);
    2185             : extern void bgp_confederation_peers_remove(struct bgp *bgp, as_t as);
    2186             : 
    2187             : extern void bgp_timers_set(struct bgp *, uint32_t keepalive, uint32_t holdtime,
    2188             :                            uint32_t connect_retry, uint32_t delayopen);
    2189             : extern void bgp_timers_unset(struct bgp *);
    2190             : 
    2191             : extern void bgp_default_local_preference_set(struct bgp *bgp,
    2192             :                                              uint32_t local_pref);
    2193             : extern void bgp_default_local_preference_unset(struct bgp *bgp);
    2194             : 
    2195             : extern void bgp_default_subgroup_pkt_queue_max_set(struct bgp *bgp,
    2196             :                                                    uint32_t queue_size);
    2197             : extern void bgp_default_subgroup_pkt_queue_max_unset(struct bgp *bgp);
    2198             : 
    2199             : extern void bgp_listen_limit_set(struct bgp *bgp, int listen_limit);
    2200             : extern void bgp_listen_limit_unset(struct bgp *bgp);
    2201             : 
    2202             : extern bool bgp_update_delay_active(struct bgp *);
    2203             : extern bool bgp_update_delay_configured(struct bgp *);
    2204             : extern bool bgp_afi_safi_peer_exists(struct bgp *bgp, afi_t afi, safi_t safi);
    2205             : extern void peer_as_change(struct peer *, as_t, int);
    2206             : extern int peer_remote_as(struct bgp *, union sockunion *, const char *, as_t *,
    2207             :                           int);
    2208             : extern int peer_group_remote_as(struct bgp *, const char *, as_t *, int);
    2209             : extern int peer_delete(struct peer *peer);
    2210             : extern void peer_notify_unconfig(struct peer *peer);
    2211             : extern int peer_group_delete(struct peer_group *);
    2212             : extern int peer_group_remote_as_delete(struct peer_group *);
    2213             : extern int peer_group_listen_range_add(struct peer_group *, struct prefix *);
    2214             : extern void peer_group_notify_unconfig(struct peer_group *group);
    2215             : 
    2216             : extern int peer_activate(struct peer *, afi_t, safi_t);
    2217             : extern int peer_deactivate(struct peer *, afi_t, safi_t);
    2218             : 
    2219             : extern int peer_group_bind(struct bgp *, union sockunion *, struct peer *,
    2220             :                            struct peer_group *, as_t *);
    2221             : 
    2222             : extern int peer_flag_set(struct peer *peer, uint64_t flag);
    2223             : extern int peer_flag_unset(struct peer *peer, uint64_t flag);
    2224             : extern void peer_flag_inherit(struct peer *peer, uint64_t flag);
    2225             : 
    2226             : extern int peer_af_flag_set(struct peer *peer, afi_t afi, safi_t safi,
    2227             :                             uint64_t flag);
    2228             : extern int peer_af_flag_unset(struct peer *peer, afi_t afi, safi_t safi,
    2229             :                               uint64_t flag);
    2230             : extern int peer_af_flag_check(struct peer *, afi_t, safi_t, uint32_t);
    2231             : extern void peer_af_flag_inherit(struct peer *peer, afi_t afi, safi_t safi,
    2232             :                                  uint64_t flag);
    2233             : extern void peer_change_action(struct peer *peer, afi_t afi, safi_t safi,
    2234             :                                enum peer_change_type type);
    2235             : 
    2236             : extern int peer_ebgp_multihop_set(struct peer *, int);
    2237             : extern int peer_ebgp_multihop_unset(struct peer *);
    2238             : extern int is_ebgp_multihop_configured(struct peer *peer);
    2239             : 
    2240             : extern int peer_role_set(struct peer *peer, uint8_t role, bool strict_mode);
    2241             : extern int peer_role_unset(struct peer *peer);
    2242             : 
    2243             : extern void peer_description_set(struct peer *, const char *);
    2244             : extern void peer_description_unset(struct peer *);
    2245             : 
    2246             : extern int peer_update_source_if_set(struct peer *, const char *);
    2247             : extern void peer_update_source_addr_set(struct peer *peer,
    2248             :                                         const union sockunion *su);
    2249             : extern void peer_update_source_unset(struct peer *peer);
    2250             : 
    2251             : extern int peer_default_originate_set(struct peer *peer, afi_t afi, safi_t safi,
    2252             :                                       const char *rmap,
    2253             :                                       struct route_map *route_map);
    2254             : extern int peer_default_originate_unset(struct peer *, afi_t, safi_t);
    2255             : extern void bgp_tcp_keepalive_set(struct bgp *bgp, uint16_t idle,
    2256             :                                   uint16_t interval, uint16_t probes);
    2257             : extern void bgp_tcp_keepalive_unset(struct bgp *bgp);
    2258             : 
    2259             : extern void peer_port_set(struct peer *, uint16_t);
    2260             : extern void peer_port_unset(struct peer *);
    2261             : 
    2262             : extern int peer_weight_set(struct peer *, afi_t, safi_t, uint16_t);
    2263             : extern int peer_weight_unset(struct peer *, afi_t, safi_t);
    2264             : 
    2265             : extern int peer_timers_set(struct peer *, uint32_t keepalive,
    2266             :                            uint32_t holdtime);
    2267             : extern int peer_timers_unset(struct peer *);
    2268             : 
    2269             : extern int peer_timers_connect_set(struct peer *, uint32_t);
    2270             : extern int peer_timers_connect_unset(struct peer *);
    2271             : 
    2272             : extern int peer_advertise_interval_set(struct peer *, uint32_t);
    2273             : extern int peer_advertise_interval_unset(struct peer *);
    2274             : 
    2275             : extern int peer_timers_delayopen_set(struct peer *peer, uint32_t delayopen);
    2276             : extern int peer_timers_delayopen_unset(struct peer *peer);
    2277             : 
    2278             : extern void peer_interface_set(struct peer *, const char *);
    2279             : extern void peer_interface_unset(struct peer *);
    2280             : 
    2281             : extern int peer_distribute_set(struct peer *, afi_t, safi_t, int, const char *);
    2282             : extern int peer_distribute_unset(struct peer *, afi_t, safi_t, int);
    2283             : 
    2284             : extern int peer_allowas_in_set(struct peer *, afi_t, safi_t, int, int);
    2285             : extern int peer_allowas_in_unset(struct peer *, afi_t, safi_t);
    2286             : 
    2287             : extern int peer_local_as_set(struct peer *, as_t, bool no_prepend,
    2288             :                              bool replace_as);
    2289             : extern int peer_local_as_unset(struct peer *);
    2290             : 
    2291             : extern int peer_prefix_list_set(struct peer *, afi_t, safi_t, int,
    2292             :                                 const char *);
    2293             : extern int peer_prefix_list_unset(struct peer *, afi_t, safi_t, int);
    2294             : 
    2295             : extern int peer_aslist_set(struct peer *, afi_t, safi_t, int, const char *);
    2296             : extern int peer_aslist_unset(struct peer *, afi_t, safi_t, int);
    2297             : 
    2298             : extern int peer_route_map_set(struct peer *peer, afi_t afi, safi_t safi, int,
    2299             :                               const char *name, struct route_map *route_map);
    2300             : extern int peer_route_map_unset(struct peer *, afi_t, safi_t, int);
    2301             : 
    2302             : extern int peer_unsuppress_map_set(struct peer *peer, afi_t afi, safi_t safi,
    2303             :                                    const char *name,
    2304             :                                    struct route_map *route_map);
    2305             : 
    2306             : extern int peer_advertise_map_set(struct peer *peer, afi_t afi, safi_t safi,
    2307             :                                   const char *advertise_name,
    2308             :                                   struct route_map *advertise_map,
    2309             :                                   const char *condition_name,
    2310             :                                   struct route_map *condition_map,
    2311             :                                   bool condition);
    2312             : 
    2313             : extern int peer_password_set(struct peer *, const char *);
    2314             : extern int peer_password_unset(struct peer *);
    2315             : 
    2316             : extern int peer_unsuppress_map_unset(struct peer *, afi_t, safi_t);
    2317             : 
    2318             : extern int peer_advertise_map_unset(struct peer *peer, afi_t afi, safi_t safi,
    2319             :                                     const char *advertise_name,
    2320             :                                     struct route_map *advertise_map,
    2321             :                                     const char *condition_name,
    2322             :                                     struct route_map *condition_map,
    2323             :                                     bool condition);
    2324             : 
    2325             : extern int peer_maximum_prefix_set(struct peer *, afi_t, safi_t, uint32_t,
    2326             :                                    uint8_t, int, uint16_t, bool force);
    2327             : extern int peer_maximum_prefix_unset(struct peer *, afi_t, safi_t);
    2328             : 
    2329             : extern void peer_maximum_prefix_out_refresh_routes(struct peer *peer, afi_t afi,
    2330             :                                                    safi_t safi);
    2331             : extern int peer_maximum_prefix_out_set(struct peer *peer, afi_t afi,
    2332             :                                        safi_t safi, uint32_t max);
    2333             : extern int peer_maximum_prefix_out_unset(struct peer *peer, afi_t afi,
    2334             :                                          safi_t safi);
    2335             : 
    2336             : extern int peer_clear(struct peer *, struct listnode **);
    2337             : extern int peer_clear_soft(struct peer *, afi_t, safi_t, enum bgp_clear_type);
    2338             : 
    2339             : extern int peer_ttl_security_hops_set(struct peer *, int);
    2340             : extern int peer_ttl_security_hops_unset(struct peer *);
    2341             : 
    2342             : extern void peer_tx_shutdown_message_set(struct peer *, const char *msg);
    2343             : extern void peer_tx_shutdown_message_unset(struct peer *);
    2344             : 
    2345             : extern void bgp_route_map_update_timer(struct thread *thread);
    2346             : extern const char *bgp_get_name_by_role(uint8_t role);
    2347             : 
    2348             : extern void bgp_route_map_terminate(void);
    2349             : 
    2350             : extern int peer_cmp(struct peer *p1, struct peer *p2);
    2351             : 
    2352             : extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi, iana_safi_t pkt_safi,
    2353             :                                      afi_t *afi, safi_t *safi);
    2354             : extern int bgp_map_afi_safi_int2iana(afi_t afi, safi_t safi,
    2355             :                                      iana_afi_t *pkt_afi,
    2356             :                                      iana_safi_t *pkt_safi);
    2357             : 
    2358             : extern struct peer_af *peer_af_create(struct peer *, afi_t, safi_t);
    2359             : extern struct peer_af *peer_af_find(struct peer *, afi_t, safi_t);
    2360             : extern int peer_af_delete(struct peer *, afi_t, safi_t);
    2361             : 
    2362             : extern void bgp_shutdown_enable(struct bgp *bgp, const char *msg);
    2363             : extern void bgp_shutdown_disable(struct bgp *bgp);
    2364             : 
    2365             : extern void bgp_close(void);
    2366             : extern void bgp_free(struct bgp *);
    2367             : void bgp_gr_apply_running_config(void);
    2368             : 
    2369             : /* BGP GR */
    2370             : int bgp_global_gr_init(struct bgp *bgp);
    2371             : int bgp_peer_gr_init(struct peer *peer);
    2372             : 
    2373             : 
    2374             : #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list)    \
    2375             :         do {                                                                   \
    2376             :                 struct peer *peer_loop;                                        \
    2377             :                 bool gr_router_detected = false;                               \
    2378             :                 struct listnode *node = {0};                                   \
    2379             :                 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) {      \
    2380             :                         if (CHECK_FLAG(peer_loop->flags,                       \
    2381             :                                        PEER_FLAG_GRACEFUL_RESTART))            \
    2382             :                                 gr_router_detected = true;                     \
    2383             :                 }                                                              \
    2384             :                 if (gr_router_detected                                         \
    2385             :                     && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) {     \
    2386             :                         bgp_zebra_send_capabilities(_bgp, false);              \
    2387             :                 } else if (!gr_router_detected                                 \
    2388             :                            && _bgp->present_zebra_gr_state                     \
    2389             :                                       == ZEBRA_GR_ENABLE) {                    \
    2390             :                         bgp_zebra_send_capabilities(_bgp, true);               \
    2391             :                 }                                                              \
    2392             :         } while (0)
    2393             : 
    2394         384 : static inline struct bgp *bgp_lock(struct bgp *bgp)
    2395             : {
    2396         384 :         bgp->lock++;
    2397         214 :         return bgp;
    2398             : }
    2399             : 
    2400         354 : static inline void bgp_unlock(struct bgp *bgp)
    2401             : {
    2402         354 :         assert(bgp->lock > 0);
    2403         354 :         if (--bgp->lock == 0)
    2404          18 :                 bgp_free(bgp);
    2405         354 : }
    2406             : 
    2407        6056 : static inline int afindex(afi_t afi, safi_t safi)
    2408             : {
    2409        6056 :         switch (afi) {
    2410        2507 :         case AFI_IP:
    2411        2507 :                 switch (safi) {
    2412             :                 case SAFI_UNICAST:
    2413             :                         return BGP_AF_IPV4_UNICAST;
    2414         251 :                 case SAFI_MULTICAST:
    2415         251 :                         return BGP_AF_IPV4_MULTICAST;
    2416         366 :                 case SAFI_LABELED_UNICAST:
    2417         366 :                         return BGP_AF_IPV4_LBL_UNICAST;
    2418         251 :                 case SAFI_MPLS_VPN:
    2419         251 :                         return BGP_AF_IPV4_VPN;
    2420         251 :                 case SAFI_ENCAP:
    2421         251 :                         return BGP_AF_IPV4_ENCAP;
    2422         251 :                 case SAFI_FLOWSPEC:
    2423         251 :                         return BGP_AF_IPV4_FLOWSPEC;
    2424             :                 case SAFI_EVPN:
    2425             :                 case SAFI_UNSPEC:
    2426             :                 case SAFI_MAX:
    2427             :                         return BGP_AF_MAX;
    2428             :                 }
    2429             :                 break;
    2430        1792 :         case AFI_IP6:
    2431        1792 :                 switch (safi) {
    2432             :                 case SAFI_UNICAST:
    2433             :                         return BGP_AF_IPV6_UNICAST;
    2434         251 :                 case SAFI_MULTICAST:
    2435         251 :                         return BGP_AF_IPV6_MULTICAST;
    2436         263 :                 case SAFI_LABELED_UNICAST:
    2437         263 :                         return BGP_AF_IPV6_LBL_UNICAST;
    2438         251 :                 case SAFI_MPLS_VPN:
    2439         251 :                         return BGP_AF_IPV6_VPN;
    2440         251 :                 case SAFI_ENCAP:
    2441         251 :                         return BGP_AF_IPV6_ENCAP;
    2442         251 :                 case SAFI_FLOWSPEC:
    2443         251 :                         return BGP_AF_IPV6_FLOWSPEC;
    2444             :                 case SAFI_EVPN:
    2445             :                 case SAFI_UNSPEC:
    2446             :                 case SAFI_MAX:
    2447             :                         return BGP_AF_MAX;
    2448             :                 }
    2449             :                 break;
    2450        1757 :         case AFI_L2VPN:
    2451        1757 :                 switch (safi) {
    2452             :                 case SAFI_EVPN:
    2453             :                         return BGP_AF_L2VPN_EVPN;
    2454             :                 case SAFI_UNICAST:
    2455             :                 case SAFI_MULTICAST:
    2456             :                 case SAFI_LABELED_UNICAST:
    2457             :                 case SAFI_MPLS_VPN:
    2458             :                 case SAFI_ENCAP:
    2459             :                 case SAFI_FLOWSPEC:
    2460             :                 case SAFI_UNSPEC:
    2461             :                 case SAFI_MAX:
    2462             :                         return BGP_AF_MAX;
    2463             :                 }
    2464             :                 break;
    2465             :         case AFI_UNSPEC:
    2466             :         case AFI_MAX:
    2467             :                 return BGP_AF_MAX;
    2468             :         }
    2469             : 
    2470           0 :         assert(!"Reached end of function we should never hit");
    2471             : }
    2472             : 
    2473             : /* If the peer is not a peer-group but is bound to a peer-group return 1 */
    2474         307 : static inline int peer_group_active(struct peer *peer)
    2475             : {
    2476         307 :         if (!CHECK_FLAG(peer->sflags, PEER_STATUS_GROUP) && peer->group)
    2477           0 :                 return 1;
    2478             :         return 0;
    2479             : }
    2480             : 
    2481             : /* If peer is negotiated at least one address family return 1. */
    2482          94 : static inline int peer_afi_active_nego(const struct peer *peer, afi_t afi)
    2483             : {
    2484          94 :         if (peer->afc_nego[afi][SAFI_UNICAST]
    2485          90 :             || peer->afc_nego[afi][SAFI_MULTICAST]
    2486          90 :             || peer->afc_nego[afi][SAFI_LABELED_UNICAST]
    2487          90 :             || peer->afc_nego[afi][SAFI_MPLS_VPN]
    2488          90 :             || peer->afc_nego[afi][SAFI_ENCAP]
    2489          90 :             || peer->afc_nego[afi][SAFI_FLOWSPEC]
    2490          90 :             || peer->afc_nego[afi][SAFI_EVPN])
    2491           4 :                 return 1;
    2492             :         return 0;
    2493             : }
    2494             : 
    2495             : /* If at least one address family activated for group, return 1. */
    2496           0 : static inline int peer_group_af_configured(struct peer_group *group)
    2497             : {
    2498           0 :         struct peer *peer = group->conf;
    2499             : 
    2500           0 :         if (peer->afc[AFI_IP][SAFI_UNICAST] || peer->afc[AFI_IP][SAFI_MULTICAST]
    2501             :             || peer->afc[AFI_IP][SAFI_LABELED_UNICAST]
    2502           0 :             || peer->afc[AFI_IP][SAFI_FLOWSPEC]
    2503           0 :             || peer->afc[AFI_IP][SAFI_MPLS_VPN] || peer->afc[AFI_IP][SAFI_ENCAP]
    2504             :             || peer->afc[AFI_IP6][SAFI_UNICAST]
    2505           0 :             || peer->afc[AFI_IP6][SAFI_MULTICAST]
    2506           0 :             || peer->afc[AFI_IP6][SAFI_LABELED_UNICAST]
    2507             :             || peer->afc[AFI_IP6][SAFI_MPLS_VPN]
    2508           0 :             || peer->afc[AFI_IP6][SAFI_ENCAP]
    2509             :             || peer->afc[AFI_IP6][SAFI_FLOWSPEC]
    2510           0 :             || peer->afc[AFI_L2VPN][SAFI_EVPN])
    2511           0 :                 return 1;
    2512             :         return 0;
    2513             : }
    2514             : 
    2515           0 : static inline char *timestamp_string(time_t ts)
    2516             : {
    2517           0 :         time_t tbuf;
    2518           0 :         tbuf = time(NULL) - (monotime(NULL) - ts);
    2519           0 :         return ctime(&tbuf);
    2520             : }
    2521             : 
    2522        3318 : static inline bool peer_established(struct peer *peer)
    2523             : {
    2524        3318 :         return peer->status == Established;
    2525             : }
    2526             : 
    2527        1432 : static inline bool peer_dynamic_neighbor(struct peer *peer)
    2528             : {
    2529        1143 :         return CHECK_FLAG(peer->flags, PEER_FLAG_DYNAMIC_NEIGHBOR);
    2530             : }
    2531             : 
    2532         289 : static inline bool peer_dynamic_neighbor_no_nsf(struct peer *peer)
    2533             : {
    2534         289 :         return (peer_dynamic_neighbor(peer) &&
    2535           0 :                 !CHECK_FLAG(peer->sflags, PEER_STATUS_NSF_WAIT));
    2536             : }
    2537             : 
    2538         585 : static inline int peer_cap_enhe(struct peer *peer, afi_t afi, safi_t safi)
    2539             : {
    2540         585 :         return (CHECK_FLAG(peer->af_cap[afi][safi], PEER_CAP_ENHE_AF_NEGO));
    2541             : }
    2542             : 
    2543             : /* Lookup VRF for BGP instance based on its type. */
    2544         135 : static inline struct vrf *bgp_vrf_lookup_by_instance_type(struct bgp *bgp)
    2545             : {
    2546         135 :         struct vrf *vrf;
    2547             : 
    2548         135 :         if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT)
    2549         135 :                 vrf = vrf_lookup_by_id(VRF_DEFAULT);
    2550           0 :         else if (bgp->inst_type == BGP_INSTANCE_TYPE_VRF)
    2551           0 :                 vrf = vrf_lookup_by_name(bgp->name);
    2552             :         else
    2553             :                 vrf = NULL;
    2554             : 
    2555         135 :         return vrf;
    2556             : }
    2557             : 
    2558             : static inline uint32_t bgp_vrf_interfaces(struct bgp *bgp, bool active)
    2559             : {
    2560             :         struct vrf *vrf;
    2561             :         struct interface *ifp;
    2562             :         uint32_t count = 0;
    2563             : 
    2564             :         /* if there is one interface in the vrf which is up then it is deemed
    2565             :          *  active
    2566             :          */
    2567             :         vrf = bgp_vrf_lookup_by_instance_type(bgp);
    2568             :         if (vrf == NULL)
    2569             :                 return 0;
    2570             :         RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name) {
    2571             :                 if (strcmp(ifp->name, bgp->name) == 0)
    2572             :                         continue;
    2573             :                 if (!active || if_is_up(ifp))
    2574             :                         count++;
    2575             :         }
    2576             :         return count;
    2577             : }
    2578             : 
    2579             : /* Link BGP instance to VRF. */
    2580          45 : static inline void bgp_vrf_link(struct bgp *bgp, struct vrf *vrf)
    2581             : {
    2582          45 :         bgp->vrf_id = vrf->vrf_id;
    2583          45 :         if (vrf->info != (void *)bgp)
    2584          45 :                 vrf->info = (void *)bgp_lock(bgp);
    2585             : }
    2586             : 
    2587             : /* Unlink BGP instance from VRF. */
    2588          45 : static inline void bgp_vrf_unlink(struct bgp *bgp, struct vrf *vrf)
    2589             : {
    2590          45 :         if (vrf->info == (void *)bgp) {
    2591          45 :                 vrf->info = NULL;
    2592          45 :                 bgp_unlock(bgp);
    2593             :         }
    2594          45 :         bgp->vrf_id = VRF_UNKNOWN;
    2595          45 : }
    2596             : 
    2597         256 : static inline bool bgp_in_graceful_shutdown(struct bgp *bgp)
    2598             : {
    2599             :         /* True if either set for this instance or globally */
    2600         256 :         return (!!CHECK_FLAG(bgp->flags, BGP_FLAG_GRACEFUL_SHUTDOWN) ||
    2601         256 :                 !!CHECK_FLAG(bm->flags, BM_FLAG_GRACEFUL_SHUTDOWN));
    2602             : }
    2603             : 
    2604             : /* For benefit of rfapi */
    2605             : extern struct peer *peer_new(struct bgp *bgp);
    2606             : 
    2607             : extern struct peer *peer_lookup_in_view(struct vty *vty, struct bgp *bgp,
    2608             :                                         const char *ip_str, bool use_json);
    2609             : extern int bgp_lookup_by_as_name_type(struct bgp **bgp_val, as_t *as,
    2610             :                                       const char *name,
    2611             :                                       enum bgp_instance_type inst_type);
    2612             : 
    2613             : /* Hooks */
    2614             : DECLARE_HOOK(bgp_vrf_status_changed, (struct bgp *bgp, struct interface *ifp),
    2615             :              (bgp, ifp));
    2616             : DECLARE_HOOK(peer_status_changed, (struct peer *peer), (peer));
    2617             : DECLARE_HOOK(bgp_snmp_init_stats, (struct bgp *bgp), (bgp));
    2618             : DECLARE_HOOK(bgp_snmp_update_last_changed, (struct bgp *bgp), (bgp));
    2619             : DECLARE_HOOK(bgp_snmp_update_stats,
    2620             :              (struct bgp_node *rn, struct bgp_path_info *pi, bool added),
    2621             :              (rn, pi, added));
    2622             : DECLARE_HOOK(bgp_rpki_prefix_status,
    2623             :              (struct peer * peer, struct attr *attr,
    2624             :               const struct prefix *prefix),
    2625             :              (peer, attr, prefix));
    2626             : 
    2627             : void peer_nsf_stop(struct peer *peer);
    2628             : 
    2629             : void peer_tcp_mss_set(struct peer *peer, uint32_t tcp_mss);
    2630             : void peer_tcp_mss_unset(struct peer *peer);
    2631             : 
    2632             : extern void bgp_recalculate_afi_safi_bestpaths(struct bgp *bgp, afi_t afi,
    2633             :                                                safi_t safi);
    2634             : extern void peer_on_policy_change(struct peer *peer, afi_t afi, safi_t safi,
    2635             :                                   int outbound);
    2636             : extern bool bgp_path_attribute_discard(struct peer *peer, char *buf,
    2637             :                                        size_t size);
    2638             : #ifdef _FRR_ATTRIBUTE_PRINTFRR
    2639             : /* clang-format off */
    2640             : #pragma FRR printfrr_ext "%pBP" (struct peer *)
    2641             : /* clang-format on */
    2642             : #endif
    2643             : 
    2644             : #endif /* _QUAGGA_BGPD_H */

Generated by: LCOV version v1.16-topotato